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/if_tunnel.h>
23 #include <linux/list.h>
24 #include <linux/netlink.h>
25 #include <linux/openvswitch.h>
26 #include <linux/skbuff.h>
27 #include <linux/spinlock.h>
28 #include <linux/u64_stats_sync.h>
33 /* The following definitions are for users of the vport subsytem: */
35 struct vport __rcu *gre_vport;
36 struct vport __rcu *gre64_vport;
39 int ovs_vport_init(void);
40 void ovs_vport_exit(void);
42 struct vport *ovs_vport_add(const struct vport_parms *);
43 void ovs_vport_del(struct vport *);
45 struct vport *ovs_vport_locate(struct net *net, const char *name);
47 void ovs_vport_set_stats(struct vport *, struct ovs_vport_stats *);
48 void ovs_vport_get_stats(struct vport *, struct ovs_vport_stats *);
50 int ovs_vport_set_options(struct vport *, struct nlattr *options);
51 int ovs_vport_get_options(const struct vport *, struct sk_buff *);
53 int ovs_vport_send(struct vport *, struct sk_buff *);
55 /* The following definitions are for implementers of vport devices: */
57 struct vport_err_stats {
65 * struct vport - one port within a datapath
66 * @rcu: RCU callback head for deferred destruction.
67 * @dp: Datapath to which this port belongs.
68 * @upcall_portid: The Netlink port to use for packets received on this port that
69 * miss the flow table.
70 * @port_no: Index into @dp's @ports array.
71 * @hash_node: Element in @dev_table hash table in vport.c.
72 * @dp_hash_node: Element in @datapath->ports hash table in datapath.c.
73 * @ops: Class structure.
74 * @percpu_stats: Points to per-CPU statistics used and maintained by vport
75 * @stats_lock: Protects @err_stats and @offset_stats.
76 * @err_stats: Points to error statistics used and maintained by vport
77 * @offset_stats: Added to actual statistics as a sop to compatibility with
78 * XAPI for Citrix XenServer. Deprecated.
86 struct hlist_node hash_node;
87 struct hlist_node dp_hash_node;
88 const struct vport_ops *ops;
90 struct pcpu_tstats __percpu *percpu_stats;
92 spinlock_t stats_lock;
93 struct vport_err_stats err_stats;
94 struct ovs_vport_stats offset_stats;
97 #define VPORT_F_REQUIRED (1 << 0) /* If init fails, module loading fails. */
98 #define VPORT_F_TUN_ID (1 << 1) /* Sets OVS_CB(skb)->tun_id. */
101 * struct vport_parms - parameters for creating a new vport
103 * @name: New vport's name.
104 * @type: New vport's type.
105 * @options: %OVS_VPORT_ATTR_OPTIONS attribute from Netlink message, %NULL if
107 * @dp: New vport's datapath.
108 * @port_no: New vport's port number.
112 enum ovs_vport_type type;
113 struct nlattr *options;
115 /* For ovs_vport_alloc(). */
122 * struct vport_ops - definition of a type of virtual port
124 * @type: %OVS_VPORT_TYPE_* value for this type of virtual port.
125 * @flags: Flags of type VPORT_F_* that influence how the generic vport layer
126 * handles this vport.
127 * @init: Called at module initialization. If VPORT_F_REQUIRED is set then the
128 * failure of this function will cause the module to not load. If the flag is
129 * not set and initialzation fails then no vports of this type can be created.
130 * @exit: Called at module unload.
131 * @create: Create a new vport configured as specified. On success returns
132 * a new vport allocated with ovs_vport_alloc(), otherwise an ERR_PTR() value.
133 * @destroy: Destroys a vport. Must call vport_free() on the vport but not
134 * before an RCU grace period has elapsed.
135 * @set_options: Modify the configuration of an existing vport. May be %NULL
136 * if modification is not supported.
137 * @get_options: Appends vport-specific attributes for the configuration of an
138 * existing vport to a &struct sk_buff. May be %NULL for a vport that does not
139 * have any configuration.
140 * @get_name: Get the device's name.
141 * @get_config: Get the device's configuration.
142 * @get_ifindex: Get the system interface index associated with the device.
143 * May be null if the device does not have an ifindex.
144 * @send: Send a packet on the device. Returns the length of the packet sent.
147 enum ovs_vport_type type;
150 /* Called at module init and exit respectively. */
154 /* Called with ovs_mutex. */
155 struct vport *(*create)(const struct vport_parms *);
156 void (*destroy)(struct vport *);
158 int (*set_options)(struct vport *, struct nlattr *);
159 int (*get_options)(const struct vport *, struct sk_buff *);
161 /* Called with rcu_read_lock or ovs_mutex. */
162 const char *(*get_name)(const struct vport *);
163 void (*get_config)(const struct vport *, void *);
164 int (*get_ifindex)(const struct vport *);
165 int (*send)(struct vport *, struct sk_buff *);
168 enum vport_err_type {
175 struct vport *ovs_vport_alloc(int priv_size, const struct vport_ops *,
176 const struct vport_parms *);
177 void ovs_vport_free(struct vport *);
179 #define VPORT_ALIGN 8
182 * vport_priv - access private data area of vport
184 * @vport: vport to access
186 * If a nonzero size was passed in priv_size of vport_alloc() a private data
187 * area was allocated on creation. This allows that area to be accessed and
188 * used for any purpose needed by the vport implementer.
190 static inline void *vport_priv(const struct vport *vport)
192 return (u8 *)vport + ALIGN(sizeof(struct vport), VPORT_ALIGN);
196 * vport_from_priv - lookup vport from private data pointer
198 * @priv: Start of private data area.
200 * It is sometimes useful to translate from a pointer to the private data
201 * area to the vport, such as in the case where the private data pointer is
202 * the result of a hash table lookup. @priv must point to the start of the
205 static inline struct vport *vport_from_priv(const void *priv)
207 return (struct vport *)(priv - ALIGN(sizeof(struct vport), VPORT_ALIGN));
210 void ovs_vport_receive(struct vport *, struct sk_buff *);
211 void ovs_vport_record_error(struct vport *, enum vport_err_type err_type);
213 /* List of statically compiled vport implementations. Don't forget to also
214 * add yours to the list at the top of vport.c. */
215 extern const struct vport_ops ovs_netdev_vport_ops;
216 extern const struct vport_ops ovs_internal_vport_ops;
217 extern const struct vport_ops ovs_gre_vport_ops;
218 extern const struct vport_ops ovs_gre64_vport_ops;
219 extern const struct vport_ops ovs_vxlan_vport_ops;
220 extern const struct vport_ops ovs_lisp_vport_ops;