2 * Copyright (c) 2007-2012 Nicira, Inc.
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/netlink.h>
24 #include <linux/openvswitch.h>
25 #include <linux/skbuff.h>
26 #include <linux/spinlock.h>
27 #include <linux/u64_stats_sync.h>
32 /* The following definitions are for users of the vport subsytem: */
34 struct vport __rcu *gre_vport;
35 struct vport __rcu *gre64_vport;
38 int ovs_vport_init(void);
39 void ovs_vport_exit(void);
41 struct vport *ovs_vport_add(const struct vport_parms *);
42 void ovs_vport_del(struct vport *);
44 struct vport *ovs_vport_locate(struct net *net, const char *name);
46 void ovs_vport_set_stats(struct vport *, struct ovs_vport_stats *);
47 void ovs_vport_get_stats(struct vport *, struct ovs_vport_stats *);
49 int ovs_vport_set_options(struct vport *, struct nlattr *options);
50 int ovs_vport_get_options(const struct vport *, struct sk_buff *);
52 int ovs_vport_send(struct vport *, struct sk_buff *);
54 /* The following definitions are for implementers of vport devices: */
56 struct vport_percpu_stats {
61 struct u64_stats_sync sync;
64 struct vport_err_stats {
72 * struct vport - one port within a datapath
73 * @rcu: RCU callback head for deferred destruction.
74 * @dp: Datapath to which this port belongs.
75 * @upcall_portid: The Netlink port to use for packets received on this port that
76 * miss the flow table.
77 * @port_no: Index into @dp's @ports array.
78 * @hash_node: Element in @dev_table hash table in vport.c.
79 * @dp_hash_node: Element in @datapath->ports hash table in datapath.c.
80 * @ops: Class structure.
81 * @percpu_stats: Points to per-CPU statistics used and maintained by vport
82 * @stats_lock: Protects @err_stats and @offset_stats.
83 * @err_stats: Points to error statistics used and maintained by vport
84 * @offset_stats: Added to actual statistics as a sop to compatibility with
85 * XAPI for Citrix XenServer. Deprecated.
93 struct hlist_node hash_node;
94 struct hlist_node dp_hash_node;
95 const struct vport_ops *ops;
97 struct vport_percpu_stats __percpu *percpu_stats;
99 spinlock_t stats_lock;
100 struct vport_err_stats err_stats;
101 struct ovs_vport_stats offset_stats;
104 #define VPORT_F_REQUIRED (1 << 0) /* If init fails, module loading fails. */
105 #define VPORT_F_TUN_ID (1 << 1) /* Sets OVS_CB(skb)->tun_id. */
108 * struct vport_parms - parameters for creating a new vport
110 * @name: New vport's name.
111 * @type: New vport's type.
112 * @options: %OVS_VPORT_ATTR_OPTIONS attribute from Netlink message, %NULL if
114 * @dp: New vport's datapath.
115 * @port_no: New vport's port number.
119 enum ovs_vport_type type;
120 struct nlattr *options;
122 /* For ovs_vport_alloc(). */
129 * struct vport_ops - definition of a type of virtual port
131 * @type: %OVS_VPORT_TYPE_* value for this type of virtual port.
132 * @flags: Flags of type VPORT_F_* that influence how the generic vport layer
133 * handles this vport.
134 * @init: Called at module initialization. If VPORT_F_REQUIRED is set then the
135 * failure of this function will cause the module to not load. If the flag is
136 * not set and initialzation fails then no vports of this type can be created.
137 * @exit: Called at module unload.
138 * @create: Create a new vport configured as specified. On success returns
139 * a new vport allocated with ovs_vport_alloc(), otherwise an ERR_PTR() value.
140 * @destroy: Destroys a vport. Must call vport_free() on the vport but not
141 * before an RCU grace period has elapsed.
142 * @set_options: Modify the configuration of an existing vport. May be %NULL
143 * if modification is not supported.
144 * @get_options: Appends vport-specific attributes for the configuration of an
145 * existing vport to a &struct sk_buff. May be %NULL for a vport that does not
146 * have any configuration.
147 * @get_name: Get the device's name.
148 * @get_config: Get the device's configuration.
149 * @get_ifindex: Get the system interface index associated with the device.
150 * May be null if the device does not have an ifindex.
151 * @send: Send a packet on the device. Returns the length of the packet sent.
154 enum ovs_vport_type type;
157 /* Called at module init and exit respectively. */
161 /* Called with ovs_mutex. */
162 struct vport *(*create)(const struct vport_parms *);
163 void (*destroy)(struct vport *);
165 int (*set_options)(struct vport *, struct nlattr *);
166 int (*get_options)(const struct vport *, struct sk_buff *);
168 /* Called with rcu_read_lock or ovs_mutex. */
169 const char *(*get_name)(const struct vport *);
170 void (*get_config)(const struct vport *, void *);
171 int (*get_ifindex)(const struct vport *);
172 int (*send)(struct vport *, struct sk_buff *);
175 enum vport_err_type {
182 struct vport *ovs_vport_alloc(int priv_size, const struct vport_ops *,
183 const struct vport_parms *);
184 void ovs_vport_free(struct vport *);
186 #define VPORT_ALIGN 8
189 * vport_priv - access private data area of vport
191 * @vport: vport to access
193 * If a nonzero size was passed in priv_size of vport_alloc() a private data
194 * area was allocated on creation. This allows that area to be accessed and
195 * used for any purpose needed by the vport implementer.
197 static inline void *vport_priv(const struct vport *vport)
199 return (u8 *)vport + ALIGN(sizeof(struct vport), VPORT_ALIGN);
203 * vport_from_priv - lookup vport from private data pointer
205 * @priv: Start of private data area.
207 * It is sometimes useful to translate from a pointer to the private data
208 * area to the vport, such as in the case where the private data pointer is
209 * the result of a hash table lookup. @priv must point to the start of the
212 static inline struct vport *vport_from_priv(const void *priv)
214 return (struct vport *)(priv - ALIGN(sizeof(struct vport), VPORT_ALIGN));
217 void ovs_vport_receive(struct vport *, struct sk_buff *);
218 void ovs_vport_record_error(struct vport *, enum vport_err_type err_type);
220 /* List of statically compiled vport implementations. Don't forget to also
221 * add yours to the list at the top of vport.c. */
222 extern const struct vport_ops ovs_netdev_vport_ops;
223 extern const struct vport_ops ovs_internal_vport_ops;
224 extern const struct vport_ops ovs_gre_vport_ops;
225 extern const struct vport_ops ovs_gre64_vport_ops;
226 extern const struct vport_ops ovs_vxlan_vport_ops;
227 extern const struct vport_ops ovs_lisp_vport_ops;