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"
25 /* The following definitions are for users of the vport subsytem: */
27 int vport_user_add(const struct odp_vport_add __user *);
28 int vport_user_mod(const struct odp_vport_mod __user *);
29 int vport_user_del(const char __user *udevname);
32 int compat_vport_user_add(struct compat_odp_vport_add __user *);
33 int compat_vport_user_mod(struct compat_odp_vport_mod __user *);
36 int vport_user_stats_get(struct odp_vport_stats_req __user *);
37 int vport_user_stats_set(struct odp_vport_stats_req __user *);
38 int vport_user_ether_get(struct odp_vport_ether __user *);
39 int vport_user_ether_set(struct odp_vport_ether __user *);
40 int vport_user_mtu_get(struct odp_vport_mtu __user *);
41 int vport_user_mtu_set(struct odp_vport_mtu __user *);
43 void vport_lock(void);
44 void vport_unlock(void);
47 void vport_exit(void);
49 struct vport *vport_add(const struct vport_parms *);
50 int vport_mod(struct vport *, const void __user *config);
51 int vport_del(struct vport *);
53 struct vport *vport_locate(const char *name);
55 int vport_attach(struct vport *, struct dp_port *);
56 int vport_detach(struct vport *);
58 int vport_set_mtu(struct vport *, int mtu);
59 int vport_set_addr(struct vport *, const unsigned char *);
60 int vport_set_stats(struct vport *, struct rtnl_link_stats64 *);
62 const char *vport_get_name(const struct vport *);
63 const char *vport_get_type(const struct vport *);
64 const unsigned char *vport_get_addr(const struct vport *);
66 struct dp_port *vport_get_dp_port(const struct vport *);
67 struct kobject *vport_get_kobj(const struct vport *);
68 int vport_get_stats(struct vport *, struct rtnl_link_stats64 *);
70 unsigned vport_get_flags(const struct vport *);
71 int vport_is_running(const struct vport *);
72 unsigned char vport_get_operstate(const struct vport *);
74 int vport_get_ifindex(const struct vport *);
75 int vport_get_iflink(const struct vport *);
77 int vport_get_mtu(const struct vport *);
79 int vport_send(struct vport *, struct sk_buff *);
81 /* The following definitions are for implementers of vport devices: */
83 struct vport_percpu_stats {
91 struct vport_err_stats {
99 struct hlist_node hash_node;
100 const struct vport_ops *ops;
101 struct dp_port *dp_port;
103 struct vport_percpu_stats *percpu_stats;
105 spinlock_t stats_lock;
106 struct vport_err_stats err_stats;
107 struct rtnl_link_stats64 offset_stats;
110 #define VPORT_F_REQUIRED (1 << 0) /* If init fails, module loading fails. */
111 #define VPORT_F_GEN_STATS (1 << 1) /* Track stats at the generic layer. */
112 #define VPORT_F_FLOW (1 << 2) /* Sets OVS_CB(skb)->flow. */
113 #define VPORT_F_TUN_ID (1 << 3) /* Sets OVS_CB(skb)->tun_id. */
116 * struct vport_parms - parameters for creating a new vport
118 * @name: New vport's name.
119 * @type: New vport's type.
120 * @config: New vport's configuration, as %NULL or a userspace pointer to an
121 * arbitrary type-specific structure.
126 const void __user *config;
130 * struct vport_ops - definition of a type of virtual port
132 * @type: Name of port type, such as "netdev" or "internal" to be matched
133 * against the device type when a new port needs to be created.
134 * @flags: Flags of type VPORT_F_* that influence how the generic vport layer
135 * handles this vport.
136 * @init: Called at module initialization. If VPORT_F_REQUIRED is set then the
137 * failure of this function will cause the module to not load. If the flag is
138 * not set and initialzation fails then no vports of this type can be created.
139 * @exit: Called at module unload.
140 * @create: Create a new vport configured as specified. On success returns
141 * a new vport allocated with vport_alloc(), otherwise an ERR_PTR() value.
142 * @modify: Modify the configuration of an existing vport. May be null if
143 * modification is not supported.
144 * @destroy: Destroy and free a vport using vport_free(). Prior to destruction
145 * @detach will be called followed by synchronize_rcu().
146 * @attach: Attach a previously created vport to a datapath. After attachment
147 * packets may be sent and received. Prior to attachment any packets may be
148 * silently discarded. May be null if not needed.
149 * @detach: Detach a vport from a datapath. May be null if not needed.
150 * @set_mtu: Set the device's MTU. May be null if not supported.
151 * @set_addr: Set the device's MAC address. May be null if not supported.
152 * @set_stats: Provides stats as an offset to be added to the device stats.
153 * May be null if not supported.
154 * @get_name: Get the device's name.
155 * @get_addr: Get the device's MAC address.
156 * @get_kobj: Get the kobj associated with the device (may return null).
157 * @get_stats: Fill in the transmit/receive stats. May be null if stats are
158 * not supported or if generic stats are in use. If defined and
159 * VPORT_F_GEN_STATS is also set, the error stats are added to those already
161 * @get_dev_flags: Get the device's flags.
162 * @is_running: Checks whether the device is running.
163 * @get_operstate: Get the device's operating state.
164 * @get_ifindex: Get the system interface index associated with the device.
165 * May be null if the device does not have an ifindex.
166 * @get_iflink: Get the system interface index associated with the device that
167 * will be used to send packets (may be different than ifindex for tunnels).
168 * May be null if the device does not have an iflink.
169 * @get_mtu: Get the device's MTU.
170 * @send: Send a packet on the device. Returns the length of the packet sent.
176 /* Called at module init and exit respectively. */
180 /* Called with RTNL lock. */
181 struct vport *(*create)(const struct vport_parms *);
182 int (*modify)(struct vport *, const void __user *config);
183 int (*destroy)(struct vport *);
185 int (*attach)(struct vport *);
186 int (*detach)(struct vport *);
188 int (*set_mtu)(struct vport *, int mtu);
189 int (*set_addr)(struct vport *, const unsigned char *);
190 int (*set_stats)(const struct vport *, struct rtnl_link_stats64 *);
192 /* Called with rcu_read_lock or RTNL lock. */
193 const char *(*get_name)(const struct vport *);
194 const unsigned char *(*get_addr)(const struct vport *);
195 struct kobject *(*get_kobj)(const struct vport *);
196 int (*get_stats)(const struct vport *, struct rtnl_link_stats64 *);
198 unsigned (*get_dev_flags)(const struct vport *);
199 int (*is_running)(const struct vport *);
200 unsigned char (*get_operstate)(const struct vport *);
202 int (*get_ifindex)(const struct vport *);
203 int (*get_iflink)(const struct vport *);
205 int (*get_mtu)(const struct vport *);
207 int (*send)(struct vport *, struct sk_buff *);
210 enum vport_err_type {
217 struct vport *vport_alloc(int priv_size, const struct vport_ops *);
218 void vport_free(struct vport *);
220 #define VPORT_ALIGN 8
223 * vport_priv - access private data area of vport
225 * @vport: vport to access
227 * If a nonzero size was passed in priv_size of vport_alloc() a private data
228 * area was allocated on creation. This allows that area to be accessed and
229 * used for any purpose needed by the vport implementer.
231 static inline void *vport_priv(const struct vport *vport)
233 return (u8 *)vport + ALIGN(sizeof(struct vport), VPORT_ALIGN);
237 * vport_from_priv - lookup vport from private data pointer
239 * @priv: Start of private data area.
241 * It is sometimes useful to translate from a pointer to the private data
242 * area to the vport, such as in the case where the private data pointer is
243 * the result of a hash table lookup. @priv must point to the start of the
246 static inline struct vport *vport_from_priv(const void *priv)
248 return (struct vport *)(priv - ALIGN(sizeof(struct vport), VPORT_ALIGN));
251 void vport_receive(struct vport *, struct sk_buff *);
252 void vport_record_error(struct vport *, enum vport_err_type err_type);
254 /* List of statically compiled vport implementations. Don't forget to also
255 * add yours to the list at the top of vport.c. */
256 extern const struct vport_ops netdev_vport_ops;
257 extern const struct vport_ops internal_vport_ops;
258 extern const struct vport_ops patch_vport_ops;
259 extern const struct vport_ops gre_vport_ops;
260 extern const struct vport_ops capwap_vport_ops;