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 * &struct vport. (We keep this around so that we can delete it if the
76 * device gets renamed.) Set to the null string when no link exists.
77 * @upcall_portid: The Netlink port to use for packets received on this port that
78 * miss the flow table.
79 * @port_no: Index into @dp's @ports array.
80 * @hash_node: Element in @dev_table hash table in vport.c.
81 * @dp_hash_node: Element in @datapath->ports hash table in datapath.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.
95 struct hlist_node hash_node;
96 struct hlist_node dp_hash_node;
97 const struct vport_ops *ops;
99 struct vport_percpu_stats __percpu *percpu_stats;
101 spinlock_t stats_lock;
102 struct vport_err_stats err_stats;
103 struct ovs_vport_stats offset_stats;
106 #define VPORT_F_REQUIRED (1 << 0) /* If init fails, module loading fails. */
107 #define VPORT_F_TUN_ID (1 << 1) /* Sets OVS_CB(skb)->tun_id. */
110 * struct vport_parms - parameters for creating a new vport
112 * @name: New vport's name.
113 * @type: New vport's type.
114 * @options: %OVS_VPORT_ATTR_OPTIONS attribute from Netlink message, %NULL if
116 * @dp: New vport's datapath.
117 * @port_no: New vport's port number.
121 enum ovs_vport_type type;
122 struct nlattr *options;
124 /* For ovs_vport_alloc(). */
131 * struct vport_ops - definition of a type of virtual port
133 * @type: %OVS_VPORT_TYPE_* value for this type of virtual port.
134 * @flags: Flags of type VPORT_F_* that influence how the generic vport layer
135 * handles this vport.
136 * @init: Called at module initialization. If VPORT_F_REQUIRED is set then the
137 * failure of this function will cause the module to not load. If the flag is
138 * not set and initialzation fails then no vports of this type can be created.
139 * @exit: Called at module unload.
140 * @create: Create a new vport configured as specified. On success returns
141 * a new vport allocated with ovs_vport_alloc(), otherwise an ERR_PTR() value.
142 * @destroy: Destroys a vport. Must call vport_free() on the vport but not
143 * before an RCU grace period has elapsed.
144 * @set_options: Modify the configuration of an existing vport. May be %NULL
145 * if modification is not supported.
146 * @get_options: Appends vport-specific attributes for the configuration of an
147 * existing vport to a &struct sk_buff. May be %NULL for a vport that does not
148 * have any configuration.
149 * @get_name: Get the device's name.
150 * @get_config: Get the device's configuration.
151 * @get_ifindex: Get the system interface index associated with the device.
152 * May be null if the device does not have an ifindex.
153 * @send: Send a packet on the device. Returns the length of the packet sent.
156 enum ovs_vport_type type;
159 /* Called at module init and exit respectively. */
163 /* Called with ovs_mutex. */
164 struct vport *(*create)(const struct vport_parms *);
165 void (*destroy)(struct vport *);
167 int (*set_options)(struct vport *, struct nlattr *);
168 int (*get_options)(const struct vport *, struct sk_buff *);
170 /* Called with rcu_read_lock or ovs_mutex. */
171 const char *(*get_name)(const struct vport *);
172 void (*get_config)(const struct vport *, void *);
173 int (*get_ifindex)(const struct vport *);
174 int (*send)(struct vport *, struct sk_buff *);
177 enum vport_err_type {
184 struct vport *ovs_vport_alloc(int priv_size, const struct vport_ops *,
185 const struct vport_parms *);
186 void ovs_vport_free(struct vport *);
188 #define VPORT_ALIGN 8
191 * vport_priv - access private data area of vport
193 * @vport: vport to access
195 * If a nonzero size was passed in priv_size of vport_alloc() a private data
196 * area was allocated on creation. This allows that area to be accessed and
197 * used for any purpose needed by the vport implementer.
199 static inline void *vport_priv(const struct vport *vport)
201 return (u8 *)vport + ALIGN(sizeof(struct vport), VPORT_ALIGN);
205 * vport_from_priv - lookup vport from private data pointer
207 * @priv: Start of private data area.
209 * It is sometimes useful to translate from a pointer to the private data
210 * area to the vport, such as in the case where the private data pointer is
211 * the result of a hash table lookup. @priv must point to the start of the
214 static inline struct vport *vport_from_priv(const void *priv)
216 return (struct vport *)(priv - ALIGN(sizeof(struct vport), VPORT_ALIGN));
219 void ovs_vport_receive(struct vport *, struct sk_buff *);
220 void ovs_vport_record_error(struct vport *, enum vport_err_type err_type);
222 /* List of statically compiled vport implementations. Don't forget to also
223 * add yours to the list at the top of vport.c. */
224 extern const struct vport_ops ovs_netdev_vport_ops;
225 extern const struct vport_ops ovs_internal_vport_ops;
226 extern const struct vport_ops ovs_gre_vport_ops;
227 extern const struct vport_ops ovs_gre64_vport_ops;
228 extern const struct vport_ops ovs_vxlan_vport_ops;
229 extern const struct vport_ops ovs_lisp_vport_ops;