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_mod(const struct odp_port __user *);
29 int vport_user_stats_get(struct odp_vport_stats_req __user *);
30 int vport_user_stats_set(struct odp_vport_stats_req __user *);
31 int vport_user_ether_get(struct odp_vport_ether __user *);
32 int vport_user_ether_set(struct odp_vport_ether __user *);
33 int vport_user_mtu_get(struct odp_vport_mtu __user *);
34 int vport_user_mtu_set(struct odp_vport_mtu __user *);
36 void vport_lock(void);
37 void vport_unlock(void);
40 void vport_exit(void);
42 struct vport *vport_add(const struct vport_parms *);
43 int vport_mod(struct vport *, struct odp_port *);
44 int vport_del(struct vport *);
46 struct vport *vport_locate(const char *name);
48 int vport_attach(struct vport *, struct dp_port *);
49 int vport_detach(struct vport *);
51 int vport_set_mtu(struct vport *, int mtu);
52 int vport_set_addr(struct vport *, const unsigned char *);
53 int vport_set_stats(struct vport *, struct rtnl_link_stats64 *);
55 const char *vport_get_name(const struct vport *);
56 const char *vport_get_type(const struct vport *);
57 const unsigned char *vport_get_addr(const struct vport *);
59 struct dp_port *vport_get_dp_port(const struct vport *);
60 struct kobject *vport_get_kobj(const struct vport *);
61 int vport_get_stats(struct vport *, struct rtnl_link_stats64 *);
63 unsigned vport_get_flags(const struct vport *);
64 int vport_is_running(const struct vport *);
65 unsigned char vport_get_operstate(const struct vport *);
67 int vport_get_ifindex(const struct vport *);
68 int vport_get_iflink(const struct vport *);
70 int vport_get_mtu(const struct vport *);
72 int vport_send(struct vport *, struct sk_buff *);
74 /* The following definitions are for implementers of vport devices: */
76 struct vport_percpu_stats {
84 struct vport_err_stats {
92 struct hlist_node hash_node;
93 const struct vport_ops *ops;
94 struct dp_port *dp_port;
96 struct vport_percpu_stats *percpu_stats;
98 spinlock_t stats_lock;
99 struct vport_err_stats err_stats;
100 struct rtnl_link_stats64 offset_stats;
103 #define VPORT_F_REQUIRED (1 << 0) /* If init fails, module loading fails. */
104 #define VPORT_F_GEN_STATS (1 << 1) /* Track stats at the generic layer. */
105 #define VPORT_F_FLOW (1 << 2) /* Sets OVS_CB(skb)->flow. */
106 #define VPORT_F_TUN_ID (1 << 3) /* Sets OVS_CB(skb)->tun_id. */
109 * struct vport_parms - parameters for creating a new vport
111 * @name: New vport's name.
112 * @type: New vport's type.
113 * @config: Kernel copy of 'config' member of &struct odp_port describing
114 * configuration for new port. Exactly %VPORT_CONFIG_SIZE bytes.
123 * struct vport_ops - definition of a type of virtual port
125 * @type: Name of port type, such as "netdev" or "internal" to be matched
126 * against the device type when a new port needs to be created.
127 * @flags: Flags of type VPORT_F_* that influence how the generic vport layer
128 * handles this vport.
129 * @init: Called at module initialization. If VPORT_F_REQUIRED is set then the
130 * failure of this function will cause the module to not load. If the flag is
131 * not set and initialzation fails then no vports of this type can be created.
132 * @exit: Called at module unload.
133 * @create: Create a new vport configured as specified. On success returns
134 * a new vport allocated with vport_alloc(), otherwise an ERR_PTR() value.
135 * @modify: Modify the configuration of an existing vport. May be null if
136 * modification is not supported.
137 * @destroy: Destroy and free a vport using vport_free(). Prior to destruction
138 * @detach will be called followed by synchronize_rcu().
139 * @attach: Attach a previously created vport to a datapath. After attachment
140 * packets may be sent and received. Prior to attachment any packets may be
141 * silently discarded. May be null if not needed.
142 * @detach: Detach a vport from a datapath. May be null if not needed.
143 * @set_mtu: Set the device's MTU. May be null if not supported.
144 * @set_addr: Set the device's MAC address. May be null if not supported.
145 * @set_stats: Provides stats as an offset to be added to the device stats.
146 * May be null if not supported.
147 * @get_name: Get the device's name.
148 * @get_addr: Get the device's MAC address.
149 * @get_kobj: Get the kobj associated with the device (may return null).
150 * @get_stats: Fill in the transmit/receive stats. May be null if stats are
151 * not supported or if generic stats are in use. If defined and
152 * VPORT_F_GEN_STATS is also set, the error stats are added to those already
154 * @get_dev_flags: Get the device's flags.
155 * @is_running: Checks whether the device is running.
156 * @get_operstate: Get the device's operating state.
157 * @get_ifindex: Get the system interface index associated with the device.
158 * May be null if the device does not have an ifindex.
159 * @get_iflink: Get the system interface index associated with the device that
160 * will be used to send packets (may be different than ifindex for tunnels).
161 * May be null if the device does not have an iflink.
162 * @get_mtu: Get the device's MTU.
163 * @send: Send a packet on the device. Returns the length of the packet sent.
169 /* Called at module init and exit respectively. */
173 /* Called with RTNL lock. */
174 struct vport *(*create)(const struct vport_parms *);
175 int (*modify)(struct vport *, struct odp_port *);
176 int (*destroy)(struct vport *);
178 int (*attach)(struct vport *);
179 int (*detach)(struct vport *);
181 int (*set_mtu)(struct vport *, int mtu);
182 int (*set_addr)(struct vport *, const unsigned char *);
183 int (*set_stats)(const struct vport *, struct rtnl_link_stats64 *);
185 /* Called with rcu_read_lock or RTNL lock. */
186 const char *(*get_name)(const struct vport *);
187 const unsigned char *(*get_addr)(const struct vport *);
188 struct kobject *(*get_kobj)(const struct vport *);
189 int (*get_stats)(const struct vport *, struct rtnl_link_stats64 *);
191 unsigned (*get_dev_flags)(const struct vport *);
192 int (*is_running)(const struct vport *);
193 unsigned char (*get_operstate)(const struct vport *);
195 int (*get_ifindex)(const struct vport *);
196 int (*get_iflink)(const struct vport *);
198 int (*get_mtu)(const struct vport *);
200 int (*send)(struct vport *, struct sk_buff *);
203 enum vport_err_type {
210 struct vport *vport_alloc(int priv_size, const struct vport_ops *);
211 void vport_free(struct vport *);
213 #define VPORT_ALIGN 8
216 * vport_priv - access private data area of vport
218 * @vport: vport to access
220 * If a nonzero size was passed in priv_size of vport_alloc() a private data
221 * area was allocated on creation. This allows that area to be accessed and
222 * used for any purpose needed by the vport implementer.
224 static inline void *vport_priv(const struct vport *vport)
226 return (u8 *)vport + ALIGN(sizeof(struct vport), VPORT_ALIGN);
230 * vport_from_priv - lookup vport from private data pointer
232 * @priv: Start of private data area.
234 * It is sometimes useful to translate from a pointer to the private data
235 * area to the vport, such as in the case where the private data pointer is
236 * the result of a hash table lookup. @priv must point to the start of the
239 static inline struct vport *vport_from_priv(const void *priv)
241 return (struct vport *)(priv - ALIGN(sizeof(struct vport), VPORT_ALIGN));
244 void vport_receive(struct vport *, struct sk_buff *);
245 void vport_record_error(struct vport *, enum vport_err_type err_type);
247 /* List of statically compiled vport implementations. Don't forget to also
248 * add yours to the list at the top of vport.c. */
249 extern const struct vport_ops netdev_vport_ops;
250 extern const struct vport_ops internal_vport_ops;
251 extern const struct vport_ops patch_vport_ops;
252 extern const struct vport_ops gre_vport_ops;
253 extern const struct vport_ops capwap_vport_ops;