2 * Copyright (c) 2007-2011 Nicira Networks.
4 * This program is free software; you can redistribute it and/or
5 * modify it under the terms of version 2 of the GNU General Public
6 * License as published by the Free Software Foundation.
8 * This program is distributed in the hope that it will be useful, but
9 * WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 * General Public License for more details.
13 * You should have received a copy of the GNU General Public License
14 * along with this program; if not, write to the Free Software
15 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
22 #include <linux/list.h>
23 #include <linux/openvswitch.h>
24 #include <linux/skbuff.h>
25 #include <linux/spinlock.h>
26 #include <linux/u64_stats_sync.h>
33 /* The following definitions are for users of the vport subsytem: */
35 int ovs_vport_init(void);
36 void ovs_vport_exit(void);
38 struct vport *ovs_vport_add(const struct vport_parms *);
39 void ovs_vport_del(struct vport *);
41 struct vport *ovs_vport_locate(const char *name);
43 int ovs_vport_set_addr(struct vport *, const unsigned char *);
44 void ovs_vport_set_stats(struct vport *, struct ovs_vport_stats *);
45 void ovs_vport_get_stats(struct vport *, struct ovs_vport_stats *);
47 int ovs_vport_set_options(struct vport *, struct nlattr *options);
48 int ovs_vport_get_options(const struct vport *, struct sk_buff *);
50 int ovs_vport_send(struct vport *, struct sk_buff *);
52 /* The following definitions are for implementers of vport devices: */
54 struct vport_percpu_stats {
59 struct u64_stats_sync sync;
62 struct vport_err_stats {
70 * struct vport - one port within a datapath
71 * @rcu: RCU callback head for deferred destruction.
72 * @port_no: Index into @dp's @ports array.
73 * @dp: Datapath to which this port belongs.
74 * @kobj: Represents /sys/class/net/<devname>/brport.
75 * @linkname: The name of the link from /sys/class/net/<datapath>/brif to this
76 * &struct vport. (We keep this around so that we can delete it if the
77 * device gets renamed.) Set to the null string when no link exists.
78 * @node: Element in @dp's @port_list.
79 * @upcall_pid: The Netlink port to use for packets received on this port that
80 * miss the flow table.
81 * @hash_node: Element in @dev_table hash table in vport.c.
82 * @ops: Class structure.
83 * @percpu_stats: Points to per-CPU statistics used and maintained by vport
84 * @stats_lock: Protects @err_stats and @offset_stats.
85 * @err_stats: Points to error statistics used and maintained by vport
86 * @offset_stats: Added to actual statistics as a sop to compatibility with
87 * XAPI for Citrix XenServer. Deprecated.
94 char linkname[IFNAMSIZ];
95 struct list_head node;
98 struct hlist_node hash_node;
99 const struct vport_ops *ops;
101 struct vport_percpu_stats __percpu *percpu_stats;
103 spinlock_t stats_lock;
104 struct vport_err_stats err_stats;
105 struct ovs_vport_stats offset_stats;
108 #define VPORT_F_REQUIRED (1 << 0) /* If init fails, module loading fails. */
109 #define VPORT_F_FLOW (1 << 1) /* Sets OVS_CB(skb)->flow. */
110 #define VPORT_F_TUN_ID (1 << 2) /* Sets OVS_CB(skb)->tun_id. */
113 * struct vport_parms - parameters for creating a new vport
115 * @name: New vport's name.
116 * @type: New vport's type.
117 * @options: %OVS_VPORT_ATTR_OPTIONS attribute from Netlink message, %NULL if
119 * @dp: New vport's datapath.
120 * @port_no: New vport's port number.
124 enum ovs_vport_type type;
125 struct nlattr *options;
127 /* For ovs_vport_alloc(). */
134 * struct vport_ops - definition of a type of virtual port
136 * @type: %OVS_VPORT_TYPE_* value for this type of virtual port.
137 * @flags: Flags of type VPORT_F_* that influence how the generic vport layer
138 * handles this vport.
139 * @init: Called at module initialization. If VPORT_F_REQUIRED is set then the
140 * failure of this function will cause the module to not load. If the flag is
141 * not set and initialzation fails then no vports of this type can be created.
142 * @exit: Called at module unload.
143 * @create: Create a new vport configured as specified. On success returns
144 * a new vport allocated with ovs_vport_alloc(), otherwise an ERR_PTR() value.
145 * @destroy: Destroys a vport. Must call vport_free() on the vport but not
146 * before an RCU grace period has elapsed.
147 * @set_options: Modify the configuration of an existing vport. May be %NULL
148 * if modification is not supported.
149 * @get_options: Appends vport-specific attributes for the configuration of an
150 * existing vport to a &struct sk_buff. May be %NULL for a vport that does not
151 * have any configuration.
152 * @set_addr: Set the device's MAC address. May be null if not supported.
153 * @get_name: Get the device's name.
154 * @get_addr: Get the device's MAC address.
155 * @get_config: Get the device's configuration.
156 * @get_kobj: Get the kobj associated with the device (may return null).
157 * @get_dev_flags: Get the device's flags.
158 * @is_running: Checks whether the device is running.
159 * @get_operstate: Get the device's operating state.
160 * @get_ifindex: Get the system interface index associated with the device.
161 * May be null if the device does not have an ifindex.
162 * @get_mtu: Get the device's MTU. May be %NULL if the device does not have an
163 * MTU (as e.g. some tunnels do not). Must be implemented if @get_ifindex is
165 * @send: Send a packet on the device. Returns the length of the packet sent.
168 enum ovs_vport_type type;
171 /* Called at module init and exit respectively. */
175 /* Called with RTNL lock. */
176 struct vport *(*create)(const struct vport_parms *);
177 void (*destroy)(struct vport *);
179 int (*set_options)(struct vport *, struct nlattr *);
180 int (*get_options)(const struct vport *, struct sk_buff *);
182 int (*set_addr)(struct vport *, const unsigned char *);
184 /* Called with rcu_read_lock or RTNL lock. */
185 const char *(*get_name)(const struct vport *);
186 const unsigned char *(*get_addr)(const struct vport *);
187 void (*get_config)(const struct vport *, void *);
188 struct kobject *(*get_kobj)(const struct vport *);
190 unsigned (*get_dev_flags)(const struct vport *);
191 int (*is_running)(const struct vport *);
192 unsigned char (*get_operstate)(const struct vport *);
194 int (*get_ifindex)(const struct vport *);
196 int (*get_mtu)(const struct vport *);
198 int (*send)(struct vport *, struct sk_buff *);
201 enum vport_err_type {
208 struct vport *ovs_vport_alloc(int priv_size, const struct vport_ops *,
209 const struct vport_parms *);
210 void ovs_vport_free(struct vport *);
212 #define VPORT_ALIGN 8
215 * vport_priv - access private data area of vport
217 * @vport: vport to access
219 * If a nonzero size was passed in priv_size of vport_alloc() a private data
220 * area was allocated on creation. This allows that area to be accessed and
221 * used for any purpose needed by the vport implementer.
223 static inline void *vport_priv(const struct vport *vport)
225 return (u8 *)vport + ALIGN(sizeof(struct vport), VPORT_ALIGN);
229 * vport_from_priv - lookup vport from private data pointer
231 * @priv: Start of private data area.
233 * It is sometimes useful to translate from a pointer to the private data
234 * area to the vport, such as in the case where the private data pointer is
235 * the result of a hash table lookup. @priv must point to the start of the
238 static inline struct vport *vport_from_priv(const void *priv)
240 return (struct vport *)(priv - ALIGN(sizeof(struct vport), VPORT_ALIGN));
243 void ovs_vport_receive(struct vport *, struct sk_buff *);
244 void ovs_vport_record_error(struct vport *, enum vport_err_type err_type);
246 /* List of statically compiled vport implementations. Don't forget to also
247 * add yours to the list at the top of vport.c. */
248 extern const struct vport_ops ovs_netdev_vport_ops;
249 extern const struct vport_ops ovs_internal_vport_ops;
250 extern const struct vport_ops ovs_patch_vport_ops;
251 extern const struct vport_ops ovs_gre_vport_ops;
252 extern const struct vport_ops ovs_capwap_vport_ops;