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/openvswitch.h>
14 #include <linux/seqlock.h>
15 #include <linux/skbuff.h>
16 #include <linux/spinlock.h>
23 /* The following definitions are for users of the vport subsytem: */
26 void vport_exit(void);
28 struct vport *vport_add(const struct vport_parms *);
29 void vport_del(struct vport *);
31 struct vport *vport_locate(const char *name);
33 int vport_set_addr(struct vport *, const unsigned char *);
34 void vport_set_stats(struct vport *, struct ovs_vport_stats *);
35 void vport_get_stats(struct vport *, struct ovs_vport_stats *);
37 int vport_set_options(struct vport *, struct nlattr *options);
38 int vport_get_options(const struct vport *, struct sk_buff *);
40 int vport_send(struct vport *, struct sk_buff *);
42 /* The following definitions are for implementers of vport devices: */
44 struct vport_percpu_stats {
52 struct vport_err_stats {
60 * struct vport - one port within a datapath
61 * @rcu: RCU callback head for deferred destruction.
62 * @port_no: Index into @dp's @ports array.
63 * @dp: Datapath to which this port belongs.
64 * @kobj: Represents /sys/class/net/<devname>/brport.
65 * @linkname: The name of the link from /sys/class/net/<datapath>/brif to this
66 * &struct vport. (We keep this around so that we can delete it if the
67 * device gets renamed.) Set to the null string when no link exists.
68 * @node: Element in @dp's @port_list.
69 * @upcall_pid: The Netlink port to use for packets received on this port that
70 * miss the flow table.
71 * @hash_node: Element in @dev_table hash table in vport.c.
72 * @ops: Class structure.
73 * @percpu_stats: Points to per-CPU statistics used and maintained by vport
74 * @stats_lock: Protects @err_stats and @offset_stats.
75 * @err_stats: Points to error statistics used and maintained by vport
76 * @offset_stats: Added to actual statistics as a sop to compatibility with
77 * XAPI for Citrix XenServer. Deprecated.
84 char linkname[IFNAMSIZ];
85 struct list_head node;
88 struct hlist_node hash_node;
89 const struct vport_ops *ops;
91 struct vport_percpu_stats __percpu *percpu_stats;
93 spinlock_t stats_lock;
94 struct vport_err_stats err_stats;
95 struct ovs_vport_stats offset_stats;
98 #define VPORT_F_REQUIRED (1 << 0) /* If init fails, module loading fails. */
99 #define VPORT_F_FLOW (1 << 1) /* Sets OVS_CB(skb)->flow. */
100 #define VPORT_F_TUN_ID (1 << 2) /* Sets OVS_CB(skb)->tun_id. */
103 * struct vport_parms - parameters for creating a new vport
105 * @name: New vport's name.
106 * @type: New vport's type.
107 * @options: %OVS_VPORT_ATTR_OPTIONS attribute from Netlink message, %NULL if
109 * @dp: New vport's datapath.
110 * @port_no: New vport's port number.
114 enum ovs_vport_type type;
115 struct nlattr *options;
117 /* For vport_alloc(). */
124 * struct vport_ops - definition of a type of virtual port
126 * @type: %OVS_VPORT_TYPE_* value for this type of virtual port.
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 * @destroy: Destroys a vport. Must call vport_free() on the vport but not
136 * before an RCU grace period has elapsed.
137 * @set_options: Modify the configuration of an existing vport. May be %NULL
138 * if modification is not supported.
139 * @get_options: Appends vport-specific attributes for the configuration of an
140 * existing vport to a &struct sk_buff. May be %NULL for a vport that does not
141 * have any configuration.
142 * @set_addr: Set the device's MAC address. May be null if not supported.
143 * @get_name: Get the device's name.
144 * @get_addr: Get the device's MAC address.
145 * @get_config: Get the device's configuration.
146 * @get_kobj: Get the kobj associated with the device (may return null).
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_mtu: Get the device's MTU. May be %NULL if the device does not have an
153 * MTU (as e.g. some tunnels do not). Must be implemented if @get_ifindex is
155 * @send: Send a packet on the device. Returns the length of the packet sent.
158 enum ovs_vport_type type;
161 /* Called at module init and exit respectively. */
165 /* Called with RTNL lock. */
166 struct vport *(*create)(const struct vport_parms *);
167 void (*destroy)(struct vport *);
169 int (*set_options)(struct vport *, struct nlattr *);
170 int (*get_options)(const struct vport *, struct sk_buff *);
172 int (*set_addr)(struct vport *, const unsigned char *);
174 /* Called with rcu_read_lock or RTNL lock. */
175 const char *(*get_name)(const struct vport *);
176 const unsigned char *(*get_addr)(const struct vport *);
177 void (*get_config)(const struct vport *, void *);
178 struct kobject *(*get_kobj)(const struct vport *);
180 unsigned (*get_dev_flags)(const struct vport *);
181 int (*is_running)(const struct vport *);
182 unsigned char (*get_operstate)(const struct vport *);
184 int (*get_ifindex)(const struct vport *);
186 int (*get_mtu)(const struct vport *);
188 int (*send)(struct vport *, struct sk_buff *);
191 enum vport_err_type {
198 struct vport *vport_alloc(int priv_size, const struct vport_ops *,
199 const struct vport_parms *);
200 void vport_free(struct vport *);
202 #define VPORT_ALIGN 8
205 * vport_priv - access private data area of vport
207 * @vport: vport to access
209 * If a nonzero size was passed in priv_size of vport_alloc() a private data
210 * area was allocated on creation. This allows that area to be accessed and
211 * used for any purpose needed by the vport implementer.
213 static inline void *vport_priv(const struct vport *vport)
215 return (u8 *)vport + ALIGN(sizeof(struct vport), VPORT_ALIGN);
219 * vport_from_priv - lookup vport from private data pointer
221 * @priv: Start of private data area.
223 * It is sometimes useful to translate from a pointer to the private data
224 * area to the vport, such as in the case where the private data pointer is
225 * the result of a hash table lookup. @priv must point to the start of the
228 static inline struct vport *vport_from_priv(const void *priv)
230 return (struct vport *)(priv - ALIGN(sizeof(struct vport), VPORT_ALIGN));
233 void vport_receive(struct vport *, struct sk_buff *);
234 void vport_record_error(struct vport *, enum vport_err_type err_type);
236 /* List of statically compiled vport implementations. Don't forget to also
237 * add yours to the list at the top of vport.c. */
238 extern const struct vport_ops netdev_vport_ops;
239 extern const struct vport_ops internal_vport_ops;
240 extern const struct vport_ops patch_vport_ops;
241 extern const struct vport_ops gre_vport_ops;
242 extern const struct vport_ops capwap_vport_ops;