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