2 * Copyright (c) 2010 Nicira Networks.
3 * Distributed under the terms of the GNU GPL version 2.
5 * Significant portions of this file may be copied from parts of the Linux
6 * kernel, by Linus Torvalds and others.
12 #include <linux/list.h>
13 #include <linux/seqlock.h>
14 #include <linux/skbuff.h>
15 #include <linux/spinlock.h>
18 #include "openvswitch/datapath-protocol.h"
19 #include "odp-compat.h"
24 /* The following definitions are for users of the vport subsytem: */
26 int vport_user_mod(const struct odp_port __user *);
28 int vport_user_stats_get(struct odp_vport_stats_req __user *);
29 int vport_user_stats_set(struct odp_vport_stats_req __user *);
30 int vport_user_ether_get(struct odp_vport_ether __user *);
31 int vport_user_ether_set(struct odp_vport_ether __user *);
32 int vport_user_mtu_get(struct odp_vport_mtu __user *);
33 int vport_user_mtu_set(struct odp_vport_mtu __user *);
35 void vport_lock(void);
36 void vport_unlock(void);
39 void vport_exit(void);
41 struct vport *vport_add(const struct vport_parms *);
42 int vport_mod(struct vport *, struct odp_port *);
43 int vport_del(struct vport *);
45 struct vport *vport_locate(const char *name);
47 int vport_attach(struct vport *);
48 int vport_detach(struct vport *);
50 int vport_set_mtu(struct vport *, int mtu);
51 int vport_set_addr(struct vport *, const unsigned char *);
52 int vport_set_stats(struct vport *, struct rtnl_link_stats64 *);
54 const char *vport_get_name(const struct vport *);
55 const char *vport_get_type(const struct vport *);
56 const unsigned char *vport_get_addr(const struct vport *);
58 struct kobject *vport_get_kobj(const struct vport *);
59 int vport_get_stats(struct vport *, struct rtnl_link_stats64 *);
61 unsigned vport_get_flags(const struct vport *);
62 int vport_is_running(const struct vport *);
63 unsigned char vport_get_operstate(const struct vport *);
65 int vport_get_ifindex(const struct vport *);
66 int vport_get_iflink(const struct vport *);
68 int vport_get_mtu(const struct vport *);
70 int vport_send(struct vport *, struct sk_buff *);
72 /* The following definitions are for implementers of vport devices: */
74 struct vport_percpu_stats {
82 struct vport_err_stats {
90 * struct vport - one port within a datapath
91 * @port_no: Index into @dp's @ports array.
92 * @dp: Datapath to which this port belongs.
93 * @kobj: Represents /sys/class/net/<devname>/brport.
94 * @linkname: The name of the link from /sys/class/net/<datapath>/brif to this
95 * &struct vport. (We keep this around so that we can delete it if the
96 * device gets renamed.) Set to the null string when no link exists.
97 * @node: Element in @dp's @port_list.
98 * @sflow_pool: Number of packets that were candidates for sFlow sampling,
99 * regardless of whether they were actually chosen and sent down to userspace.
100 * @hash_node: Element in @dev_table hash table in vport.c.
101 * @ops: Class structure.
102 * @percpu_stats: Points to per-CPU statistics used and maintained by the vport
103 * code if %VPORT_F_GEN_STATS is set to 1 in @ops flags, otherwise unused.
104 * @stats_lock: Protects @err_stats and @offset_stats.
105 * @err_stats: Points to error statistics used and maintained by the vport code
106 * if %VPORT_F_GEN_STATS is set to 1 in @ops flags, otherwise unused.
107 * @offset_stats: Added to actual statistics as a sop to compatibility with
108 * XAPI for Citrix XenServer. Deprecated.
114 char linkname[IFNAMSIZ];
115 struct list_head node;
118 struct hlist_node hash_node;
119 const struct vport_ops *ops;
121 struct vport_percpu_stats *percpu_stats;
123 spinlock_t stats_lock;
124 struct vport_err_stats err_stats;
125 struct rtnl_link_stats64 offset_stats;
128 #define VPORT_F_REQUIRED (1 << 0) /* If init fails, module loading fails. */
129 #define VPORT_F_GEN_STATS (1 << 1) /* Track stats at the generic layer. */
130 #define VPORT_F_FLOW (1 << 2) /* Sets OVS_CB(skb)->flow. */
131 #define VPORT_F_TUN_ID (1 << 3) /* Sets OVS_CB(skb)->tun_id. */
134 * struct vport_parms - parameters for creating a new vport
136 * @name: New vport's name.
137 * @type: New vport's type.
138 * @config: Kernel copy of 'config' member of &struct odp_port describing
139 * configuration for new port. Exactly %VPORT_CONFIG_SIZE bytes.
140 * @dp: New vport's datapath.
141 * @port_no: New vport's port number.
148 /* For vport_alloc(). */
154 * struct vport_ops - definition of a type of virtual port
156 * @type: Name of port type, such as "netdev" or "internal" to be matched
157 * against the device type when a new port needs to be created.
158 * @flags: Flags of type VPORT_F_* that influence how the generic vport layer
159 * handles this vport.
160 * @init: Called at module initialization. If VPORT_F_REQUIRED is set then the
161 * failure of this function will cause the module to not load. If the flag is
162 * not set and initialzation fails then no vports of this type can be created.
163 * @exit: Called at module unload.
164 * @create: Create a new vport configured as specified. On success returns
165 * a new vport allocated with vport_alloc(), otherwise an ERR_PTR() value.
166 * @modify: Modify the configuration of an existing vport. May be null if
167 * modification is not supported.
168 * @destroy: Destroy and free a vport using vport_free(). Prior to destruction
169 * @detach will be called followed by synchronize_rcu().
170 * @attach: Attach a previously created vport to a datapath. After attachment
171 * packets may be sent and received. Prior to attachment any packets may be
172 * silently discarded. May be null if not needed.
173 * @detach: Detach a vport from a datapath. May be null if not needed.
174 * @set_mtu: Set the device's MTU. May be null if not supported.
175 * @set_addr: Set the device's MAC address. May be null if not supported.
176 * @set_stats: Provides stats as an offset to be added to the device stats.
177 * May be null if not supported.
178 * @get_name: Get the device's name.
179 * @get_addr: Get the device's MAC address.
180 * @get_kobj: Get the kobj associated with the device (may return null).
181 * @get_stats: Fill in the transmit/receive stats. May be null if stats are
182 * not supported or if generic stats are in use. If defined and
183 * VPORT_F_GEN_STATS is also set, the error stats are added to those already
185 * @get_dev_flags: Get the device's flags.
186 * @is_running: Checks whether the device is running.
187 * @get_operstate: Get the device's operating state.
188 * @get_ifindex: Get the system interface index associated with the device.
189 * May be null if the device does not have an ifindex.
190 * @get_iflink: Get the system interface index associated with the device that
191 * will be used to send packets (may be different than ifindex for tunnels).
192 * May be null if the device does not have an iflink.
193 * @get_mtu: Get the device's MTU.
194 * @send: Send a packet on the device. Returns the length of the packet sent.
200 /* Called at module init and exit respectively. */
204 /* Called with RTNL lock. */
205 struct vport *(*create)(const struct vport_parms *);
206 int (*modify)(struct vport *, struct odp_port *);
207 int (*destroy)(struct vport *);
209 int (*attach)(struct vport *);
210 int (*detach)(struct vport *);
212 int (*set_mtu)(struct vport *, int mtu);
213 int (*set_addr)(struct vport *, const unsigned char *);
214 int (*set_stats)(const struct vport *, struct rtnl_link_stats64 *);
216 /* Called with rcu_read_lock or RTNL lock. */
217 const char *(*get_name)(const struct vport *);
218 const unsigned char *(*get_addr)(const struct vport *);
219 struct kobject *(*get_kobj)(const struct vport *);
220 int (*get_stats)(const struct vport *, struct rtnl_link_stats64 *);
222 unsigned (*get_dev_flags)(const struct vport *);
223 int (*is_running)(const struct vport *);
224 unsigned char (*get_operstate)(const struct vport *);
226 int (*get_ifindex)(const struct vport *);
227 int (*get_iflink)(const struct vport *);
229 int (*get_mtu)(const struct vport *);
231 int (*send)(struct vport *, struct sk_buff *);
234 enum vport_err_type {
241 struct vport *vport_alloc(int priv_size, const struct vport_ops *, const struct vport_parms *);
242 void vport_free(struct vport *);
244 #define VPORT_ALIGN 8
247 * vport_priv - access private data area of vport
249 * @vport: vport to access
251 * If a nonzero size was passed in priv_size of vport_alloc() a private data
252 * area was allocated on creation. This allows that area to be accessed and
253 * used for any purpose needed by the vport implementer.
255 static inline void *vport_priv(const struct vport *vport)
257 return (u8 *)vport + ALIGN(sizeof(struct vport), VPORT_ALIGN);
261 * vport_from_priv - lookup vport from private data pointer
263 * @priv: Start of private data area.
265 * It is sometimes useful to translate from a pointer to the private data
266 * area to the vport, such as in the case where the private data pointer is
267 * the result of a hash table lookup. @priv must point to the start of the
270 static inline struct vport *vport_from_priv(const void *priv)
272 return (struct vport *)(priv - ALIGN(sizeof(struct vport), VPORT_ALIGN));
275 void vport_receive(struct vport *, struct sk_buff *);
276 void vport_record_error(struct vport *, enum vport_err_type err_type);
278 /* List of statically compiled vport implementations. Don't forget to also
279 * add yours to the list at the top of vport.c. */
280 extern const struct vport_ops netdev_vport_ops;
281 extern const struct vport_ops internal_vport_ops;
282 extern const struct vport_ops patch_vport_ops;
283 extern const struct vport_ops gre_vport_ops;
284 extern const struct vport_ops capwap_vport_ops;