1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /*
3 * Copyright (c) 2007-2012 Nicira, Inc.
4 */
5
6 #ifndef VPORT_H
7 #define VPORT_H 1
8
9 #include <linux/if_tunnel.h>
10 #include <linux/list.h>
11 #include <linux/netlink.h>
12 #include <linux/openvswitch.h>
13 #include <linux/reciprocal_div.h>
14 #include <linux/skbuff.h>
15 #include <linux/spinlock.h>
16 #include <linux/u64_stats_sync.h>
17
18 #include "datapath.h"
19
20 struct vport;
21 struct vport_parms;
22
23 /* The following definitions are for users of the vport subsystem: */
24
25 int ovs_vport_init(void);
26 void ovs_vport_exit(void);
27
28 struct vport *ovs_vport_add(const struct vport_parms *);
29 void ovs_vport_del(struct vport *);
30
31 struct vport *ovs_vport_locate(const struct net *net, const char *name);
32
33 void ovs_vport_get_stats(struct vport *, struct ovs_vport_stats *);
34
35 int ovs_vport_set_options(struct vport *, struct nlattr *options);
36 int ovs_vport_get_options(const struct vport *, struct sk_buff *);
37
38 int ovs_vport_set_upcall_portids(struct vport *, const struct nlattr *pids);
39 int ovs_vport_get_upcall_portids(const struct vport *, struct sk_buff *);
40 u32 ovs_vport_find_upcall_portid(const struct vport *, struct sk_buff *);
41
42 /**
43 * struct vport_portids - array of netlink portids of a vport.
44 * must be protected by rcu.
45 * @rn_ids: The reciprocal value of @n_ids.
46 * @rcu: RCU callback head for deferred destruction.
47 * @n_ids: Size of @ids array.
48 * @ids: Array storing the Netlink socket pids to be used for packets received
49 * on this port that miss the flow table.
50 */
51 struct vport_portids {
52 struct reciprocal_value rn_ids;
53 struct rcu_head rcu;
54 u32 n_ids;
55 u32 ids[];
56 };
57
58 /**
59 * struct vport - one port within a datapath
60 * @dev: Pointer to net_device.
61 * @dev_tracker: refcount tracker for @dev reference
62 * @dp: Datapath to which this port belongs.
63 * @upcall_portids: RCU protected 'struct vport_portids'.
64 * @port_no: Index into @dp's @ports array.
65 * @hash_node: Element in @dev_table hash table in vport.c.
66 * @dp_hash_node: Element in @datapath->ports hash table in datapath.c.
67 * @ops: Class structure.
68 * @detach_list: list used for detaching vport in net-exit call.
69 * @rcu: RCU callback head for deferred destruction.
70 */
71 struct vport {
72 struct net_device *dev;
73 netdevice_tracker dev_tracker;
74 struct datapath *dp;
75 struct vport_portids __rcu *upcall_portids;
76 u16 port_no;
77
78 struct hlist_node hash_node;
79 struct hlist_node dp_hash_node;
80 const struct vport_ops *ops;
81
82 struct list_head detach_list;
83 struct rcu_head rcu;
84 };
85
86 /**
87 * struct vport_parms - parameters for creating a new vport
88 *
89 * @name: New vport's name.
90 * @type: New vport's type.
91 * @options: %OVS_VPORT_ATTR_OPTIONS attribute from Netlink message, %NULL if
92 * none was supplied.
93 * @desired_ifindex: New vport's ifindex.
94 * @dp: New vport's datapath.
95 * @port_no: New vport's port number.
96 */
97 struct vport_parms {
98 const char *name;
99 enum ovs_vport_type type;
100 int desired_ifindex;
101 struct nlattr *options;
102
103 /* For ovs_vport_alloc(). */
104 struct datapath *dp;
105 u16 port_no;
106 struct nlattr *upcall_portids;
107 };
108
109 /**
110 * struct vport_ops - definition of a type of virtual port
111 *
112 * @type: %OVS_VPORT_TYPE_* value for this type of virtual port.
113 * @create: Create a new vport configured as specified. On success returns
114 * a new vport allocated with ovs_vport_alloc(), otherwise an ERR_PTR() value.
115 * @destroy: Destroys a vport. Must call vport_free() on the vport but not
116 * before an RCU grace period has elapsed.
117 * @set_options: Modify the configuration of an existing vport. May be %NULL
118 * if modification is not supported.
119 * @get_options: Appends vport-specific attributes for the configuration of an
120 * existing vport to a &struct sk_buff. May be %NULL for a vport that does not
121 * have any configuration.
122 * @send: Send a packet on the device.
123 * zero for dropped packets or negative for error.
124 */
125 struct vport_ops {
126 enum ovs_vport_type type;
127
128 /* Called with ovs_mutex. */
129 struct vport *(*create)(const struct vport_parms *);
130 void (*destroy)(struct vport *);
131
132 int (*set_options)(struct vport *, struct nlattr *);
133 int (*get_options)(const struct vport *, struct sk_buff *);
134
135 int (*send)(struct sk_buff *skb);
136 struct module *owner;
137 struct list_head list;
138 };
139
140 struct vport *ovs_vport_alloc(int priv_size, const struct vport_ops *,
141 const struct vport_parms *);
142 void ovs_vport_free(struct vport *);
143
144 #define VPORT_ALIGN 8
145
146 /**
147 * vport_priv - access private data area of vport
148 *
149 * @vport: vport to access
150 *
151 * If a nonzero size was passed in priv_size of vport_alloc() a private data
152 * area was allocated on creation. This allows that area to be accessed and
153 * used for any purpose needed by the vport implementer.
154 */
vport_priv(const struct vport * vport)155 static inline void *vport_priv(const struct vport *vport)
156 {
157 return (u8 *)(uintptr_t)vport + ALIGN(sizeof(struct vport), VPORT_ALIGN);
158 }
159
160 /**
161 * vport_from_priv - lookup vport from private data pointer
162 *
163 * @priv: Start of private data area.
164 *
165 * It is sometimes useful to translate from a pointer to the private data
166 * area to the vport, such as in the case where the private data pointer is
167 * the result of a hash table lookup. @priv must point to the start of the
168 * private data area.
169 */
vport_from_priv(void * priv)170 static inline struct vport *vport_from_priv(void *priv)
171 {
172 return (struct vport *)((u8 *)priv - ALIGN(sizeof(struct vport), VPORT_ALIGN));
173 }
174
175 int ovs_vport_receive(struct vport *, struct sk_buff *,
176 const struct ip_tunnel_info *);
177
ovs_vport_name(struct vport * vport)178 static inline const char *ovs_vport_name(struct vport *vport)
179 {
180 return vport->dev->name;
181 }
182
183 int __ovs_vport_ops_register(struct vport_ops *ops);
184 #define ovs_vport_ops_register(ops) \
185 ({ \
186 (ops)->owner = THIS_MODULE; \
187 __ovs_vport_ops_register(ops); \
188 })
189
190 void ovs_vport_ops_unregister(struct vport_ops *ops);
191 void ovs_vport_send(struct vport *vport, struct sk_buff *skb, u8 mac_proto);
192
193 #endif /* vport.h */
194