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_add(const struct odp_vport_add __user *);
27 int vport_user_mod(const struct odp_vport_mod __user *);
28 int vport_user_del(const char __user *udevname);
31 int compat_vport_user_add(struct compat_odp_vport_add __user *);
32 int compat_vport_user_mod(struct compat_odp_vport_mod __user *);
35 int vport_user_stats_get(struct odp_vport_stats_req __user *);
36 int vport_user_stats_set(struct odp_vport_stats_req __user *);
37 int vport_user_ether_get(struct odp_vport_ether __user *);
38 int vport_user_ether_set(struct odp_vport_ether __user *);
39 int vport_user_mtu_get(struct odp_vport_mtu __user *);
40 int vport_user_mtu_set(struct odp_vport_mtu __user *);
42 void vport_lock(void);
43 void vport_unlock(void);
46 void vport_exit(void);
48 struct vport *vport_add(const char *name, const char *type, const void __user *config);
49 int vport_mod(struct vport *, const void __user *config);
50 int vport_del(struct vport *);
52 struct vport *vport_locate(const char *name);
54 int vport_attach(struct vport *, struct dp_port *);
55 int vport_detach(struct vport *);
57 int vport_set_mtu(struct vport *, int mtu);
58 int vport_set_addr(struct vport *, const unsigned char *);
59 int vport_set_stats(struct vport *, struct rtnl_link_stats64 *);
61 const char *vport_get_name(const struct vport *);
62 const char *vport_get_type(const struct vport *);
63 const unsigned char *vport_get_addr(const struct vport *);
65 struct dp_port *vport_get_dp_port(const struct vport *);
66 struct kobject *vport_get_kobj(const struct vport *);
67 int vport_get_stats(struct vport *, struct rtnl_link_stats64 *);
69 unsigned vport_get_flags(const struct vport *);
70 int vport_is_running(const struct vport *);
71 unsigned char vport_get_operstate(const struct vport *);
73 int vport_get_ifindex(const struct vport *);
74 int vport_get_iflink(const struct vport *);
76 int vport_get_mtu(const struct vport *);
78 int vport_send(struct vport *, struct sk_buff *);
80 /* The following definitions are for implementers of vport devices: */
82 struct vport_percpu_stats {
90 struct vport_err_stats {
98 struct hlist_node hash_node;
99 const struct vport_ops *ops;
100 struct dp_port *dp_port;
102 struct vport_percpu_stats *percpu_stats;
104 spinlock_t stats_lock;
105 struct vport_err_stats err_stats;
106 struct rtnl_link_stats64 offset_stats;
109 #define VPORT_F_REQUIRED (1 << 0) /* If init fails, module loading fails. */
110 #define VPORT_F_GEN_STATS (1 << 1) /* Track stats at the generic layer. */
111 #define VPORT_F_FLOW (1 << 2) /* Sets OVS_CB(skb)->flow. */
112 #define VPORT_F_TUN_ID (1 << 3) /* Sets OVS_CB(skb)->tun_id. */
115 * struct vport_ops - definition of a type of virtual port
117 * @type: Name of port type, such as "netdev" or "internal" to be matched
118 * against the device type when a new port needs to be created.
119 * @flags: Flags of type VPORT_F_* that influence how the generic vport layer
120 * handles this vport.
121 * @init: Called at module initialization. If VPORT_F_REQUIRED is set then the
122 * failure of this function will cause the module to not load. If the flag is
123 * not set and initialzation fails then no vports of this type can be created.
124 * @exit: Called at module unload.
125 * @create: Create a new vport called 'name' with vport type specific
126 * configuration 'config' (which must be copied from userspace before use). On
127 * success must allocate a new vport using vport_alloc().
128 * @modify: Modify the configuration of an existing vport. May be null if
129 * modification is not supported.
130 * @destroy: Destroy and free a vport using vport_free(). Prior to destruction
131 * @detach will be called followed by synchronize_rcu().
132 * @attach: Attach a previously created vport to a datapath. After attachment
133 * packets may be sent and received. Prior to attachment any packets may be
134 * silently discarded. May be null if not needed.
135 * @detach: Detach a vport from a datapath. May be null if not needed.
136 * @set_mtu: Set the device's MTU. May be null if not supported.
137 * @set_addr: Set the device's MAC address. May be null if not supported.
138 * @set_stats: Provides stats as an offset to be added to the device stats.
139 * May be null if not supported.
140 * @get_name: Get the device's name.
141 * @get_addr: Get the device's MAC address.
142 * @get_kobj: Get the kobj associated with the device (may return null).
143 * @get_stats: Fill in the transmit/receive stats. May be null if stats are
144 * not supported or if generic stats are in use. If defined and
145 * VPORT_F_GEN_STATS is also set, the error stats are added to those already
147 * @get_dev_flags: Get the device's flags.
148 * @is_running: Checks whether the device is running.
149 * @get_operstate: Get the device's operating state.
150 * @get_ifindex: Get the system interface index associated with the device.
151 * May be null if the device does not have an ifindex.
152 * @get_iflink: Get the system interface index associated with the device that
153 * will be used to send packets (may be different than ifindex for tunnels).
154 * May be null if the device does not have an iflink.
155 * @get_mtu: Get the device's MTU.
156 * @send: Send a packet on the device. Returns the length of the packet sent.
162 /* Called at module init and exit respectively. */
166 /* Called with RTNL lock. */
167 struct vport *(*create)(const char *name, const void __user *config);
168 int (*modify)(struct vport *, const void __user *config);
169 int (*destroy)(struct vport *);
171 int (*attach)(struct vport *);
172 int (*detach)(struct vport *);
174 int (*set_mtu)(struct vport *, int mtu);
175 int (*set_addr)(struct vport *, const unsigned char *);
176 int (*set_stats)(const struct vport *, struct rtnl_link_stats64 *);
178 /* Called with rcu_read_lock or RTNL lock. */
179 const char *(*get_name)(const struct vport *);
180 const unsigned char *(*get_addr)(const struct vport *);
181 struct kobject *(*get_kobj)(const struct vport *);
182 int (*get_stats)(const struct vport *, struct rtnl_link_stats64 *);
184 unsigned (*get_dev_flags)(const struct vport *);
185 int (*is_running)(const struct vport *);
186 unsigned char (*get_operstate)(const struct vport *);
188 int (*get_ifindex)(const struct vport *);
189 int (*get_iflink)(const struct vport *);
191 int (*get_mtu)(const struct vport *);
193 int (*send)(struct vport *, struct sk_buff *);
196 enum vport_err_type {
203 struct vport *vport_alloc(int priv_size, const struct vport_ops *);
204 void vport_free(struct vport *);
206 #define VPORT_ALIGN 8
209 * vport_priv - access private data area of vport
211 * @vport: vport to access
213 * If a nonzero size was passed in priv_size of vport_alloc() a private data
214 * area was allocated on creation. This allows that area to be accessed and
215 * used for any purpose needed by the vport implementer.
217 static inline void *vport_priv(const struct vport *vport)
219 return (u8 *)vport + ALIGN(sizeof(struct vport), VPORT_ALIGN);
223 * vport_from_priv - lookup vport from private data pointer
225 * @priv: Start of private data area.
227 * It is sometimes useful to translate from a pointer to the private data
228 * area to the vport, such as in the case where the private data pointer is
229 * the result of a hash table lookup. @priv must point to the start of the
232 static inline struct vport *vport_from_priv(const void *priv)
234 return (struct vport *)(priv - ALIGN(sizeof(struct vport), VPORT_ALIGN));
237 void vport_receive(struct vport *, struct sk_buff *);
238 void vport_record_error(struct vport *, enum vport_err_type err_type);
240 /* List of statically compiled vport implementations. Don't forget to also
241 * add yours to the list at the top of vport.c. */
242 extern struct vport_ops netdev_vport_ops;
243 extern struct vport_ops internal_vport_ops;
244 extern struct vport_ops patch_vport_ops;
245 extern struct vport_ops gre_vport_ops;
246 extern struct vport_ops capwap_vport_ops;