2 * Copyright (c) 2010, 2011 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"
23 /* The following definitions are for users of the vport subsytem: */
25 void vport_lock(void);
26 void vport_unlock(void);
29 void vport_exit(void);
31 struct vport *vport_add(const struct vport_parms *);
32 int vport_del(struct vport *);
34 struct vport *vport_locate(const char *name);
36 int vport_set_mtu(struct vport *, int mtu);
37 int vport_set_addr(struct vport *, const unsigned char *);
38 int vport_set_stats(struct vport *, struct rtnl_link_stats64 *);
40 const char *vport_get_name(const struct vport *);
41 enum odp_vport_type vport_get_type(const struct vport *);
42 const unsigned char *vport_get_addr(const struct vport *);
44 struct kobject *vport_get_kobj(const struct vport *);
45 int vport_get_stats(struct vport *, struct rtnl_link_stats64 *);
47 unsigned vport_get_flags(const struct vport *);
48 int vport_is_running(const struct vport *);
49 unsigned char vport_get_operstate(const struct vport *);
51 int vport_get_ifindex(const struct vport *);
52 int vport_get_iflink(const struct vport *);
54 int vport_get_mtu(const struct vport *);
56 int vport_set_options(struct vport *, struct nlattr *options);
57 int vport_get_options(const struct vport *, struct sk_buff *);
59 int vport_send(struct vport *, struct sk_buff *);
61 /* The following definitions are for implementers of vport devices: */
63 struct vport_percpu_stats {
71 struct vport_err_stats {
79 * struct vport - one port within a datapath
80 * @port_no: Index into @dp's @ports array.
81 * @dp: Datapath to which this port belongs.
82 * @kobj: Represents /sys/class/net/<devname>/brport.
83 * @linkname: The name of the link from /sys/class/net/<datapath>/brif to this
84 * &struct vport. (We keep this around so that we can delete it if the
85 * device gets renamed.) Set to the null string when no link exists.
86 * @node: Element in @dp's @port_list.
87 * @sflow_pool: Number of packets that were candidates for sFlow sampling,
88 * regardless of whether they were actually chosen and sent down to userspace.
89 * @hash_node: Element in @dev_table hash table in vport.c.
90 * @ops: Class structure.
91 * @percpu_stats: Points to per-CPU statistics used and maintained by the vport
92 * code if %VPORT_F_GEN_STATS is set to 1 in @ops flags, otherwise unused.
93 * @stats_lock: Protects @err_stats and @offset_stats.
94 * @err_stats: Points to error statistics used and maintained by the vport code
95 * if %VPORT_F_GEN_STATS is set to 1 in @ops flags, otherwise unused.
96 * @offset_stats: Added to actual statistics as a sop to compatibility with
97 * XAPI for Citrix XenServer. Deprecated.
103 char linkname[IFNAMSIZ];
104 struct list_head node;
107 struct hlist_node hash_node;
108 const struct vport_ops *ops;
110 struct vport_percpu_stats __percpu *percpu_stats;
112 spinlock_t stats_lock;
113 struct vport_err_stats err_stats;
114 struct rtnl_link_stats64 offset_stats;
117 #define VPORT_F_REQUIRED (1 << 0) /* If init fails, module loading fails. */
118 #define VPORT_F_GEN_STATS (1 << 1) /* Track stats at the generic layer. */
119 #define VPORT_F_FLOW (1 << 2) /* Sets OVS_CB(skb)->flow. */
120 #define VPORT_F_TUN_ID (1 << 3) /* Sets OVS_CB(skb)->tun_id. */
123 * struct vport_parms - parameters for creating a new vport
125 * @name: New vport's name.
126 * @type: New vport's type.
127 * @options: %ODP_VPORT_ATTR_OPTIONS attribute from Netlink message, %NULL if
129 * @dp: New vport's datapath.
130 * @port_no: New vport's port number.
134 enum odp_vport_type type;
135 struct nlattr *options;
137 /* For vport_alloc(). */
143 * struct vport_ops - definition of a type of virtual port
145 * @type: %ODP_VPORT_TYPE_* value for this type of virtual port.
146 * @flags: Flags of type VPORT_F_* that influence how the generic vport layer
147 * handles this vport.
148 * @init: Called at module initialization. If VPORT_F_REQUIRED is set then the
149 * failure of this function will cause the module to not load. If the flag is
150 * not set and initialzation fails then no vports of this type can be created.
151 * @exit: Called at module unload.
152 * @create: Create a new vport configured as specified. On success returns
153 * a new vport allocated with vport_alloc(), otherwise an ERR_PTR() value.
154 * @destroy: Detach and destroy a vport.
155 * @set_options: Modify the configuration of an existing vport. May be %NULL
156 * if modification is not supported.
157 * @get_options: Appends vport-specific attributes for the configuration of an
158 * existing vport to a &struct sk_buff. May be %NULL for a vport that does not
159 * have any configuration.
160 * @set_mtu: Set the device's MTU. May be null if not supported.
161 * @set_addr: Set the device's MAC address. May be null if not supported.
162 * @get_name: Get the device's name.
163 * @get_addr: Get the device's MAC address.
164 * @get_config: Get the device's configuration.
165 * @get_kobj: Get the kobj associated with the device (may return null).
166 * @get_stats: Fill in the transmit/receive stats. May be null if stats are
167 * not supported or if generic stats are in use. If defined and
168 * VPORT_F_GEN_STATS is also set, the error stats are added to those already
170 * @get_dev_flags: Get the device's flags.
171 * @is_running: Checks whether the device is running.
172 * @get_operstate: Get the device's operating state.
173 * @get_ifindex: Get the system interface index associated with the device.
174 * May be null if the device does not have an ifindex.
175 * @get_iflink: Get the system interface index associated with the device that
176 * will be used to send packets (may be different than ifindex for tunnels).
177 * May be null if the device does not have an iflink.
178 * @get_mtu: Get the device's MTU.
179 * @send: Send a packet on the device. Returns the length of the packet sent.
182 enum odp_vport_type type;
185 /* Called at module init and exit respectively. */
189 /* Called with RTNL lock. */
190 struct vport *(*create)(const struct vport_parms *);
191 int (*destroy)(struct vport *);
193 int (*set_options)(struct vport *, struct nlattr *);
194 int (*get_options)(const struct vport *, struct sk_buff *);
196 int (*set_mtu)(struct vport *, int mtu);
197 int (*set_addr)(struct vport *, const unsigned char *);
199 /* Called with rcu_read_lock or RTNL lock. */
200 const char *(*get_name)(const struct vport *);
201 const unsigned char *(*get_addr)(const struct vport *);
202 void (*get_config)(const struct vport *, void *);
203 struct kobject *(*get_kobj)(const struct vport *);
204 int (*get_stats)(const struct vport *, struct rtnl_link_stats64 *);
206 unsigned (*get_dev_flags)(const struct vport *);
207 int (*is_running)(const struct vport *);
208 unsigned char (*get_operstate)(const struct vport *);
210 int (*get_ifindex)(const struct vport *);
211 int (*get_iflink)(const struct vport *);
213 int (*get_mtu)(const struct vport *);
215 int (*send)(struct vport *, struct sk_buff *);
218 enum vport_err_type {
225 struct vport *vport_alloc(int priv_size, const struct vport_ops *, const struct vport_parms *);
226 void vport_free(struct vport *);
228 #define VPORT_ALIGN 8
231 * vport_priv - access private data area of vport
233 * @vport: vport to access
235 * If a nonzero size was passed in priv_size of vport_alloc() a private data
236 * area was allocated on creation. This allows that area to be accessed and
237 * used for any purpose needed by the vport implementer.
239 static inline void *vport_priv(const struct vport *vport)
241 return (u8 *)vport + ALIGN(sizeof(struct vport), VPORT_ALIGN);
245 * vport_from_priv - lookup vport from private data pointer
247 * @priv: Start of private data area.
249 * It is sometimes useful to translate from a pointer to the private data
250 * area to the vport, such as in the case where the private data pointer is
251 * the result of a hash table lookup. @priv must point to the start of the
254 static inline struct vport *vport_from_priv(const void *priv)
256 return (struct vport *)(priv - ALIGN(sizeof(struct vport), VPORT_ALIGN));
259 void vport_receive(struct vport *, struct sk_buff *);
260 void vport_record_error(struct vport *, enum vport_err_type err_type);
262 /* List of statically compiled vport implementations. Don't forget to also
263 * add yours to the list at the top of vport.c. */
264 extern const struct vport_ops netdev_vport_ops;
265 extern const struct vport_ops internal_vport_ops;
266 extern const struct vport_ops patch_vport_ops;
267 extern const struct vport_ops gre_vport_ops;
268 extern const struct vport_ops capwap_vport_ops;