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/reciprocal_div.h>
27 #include <linux/skbuff.h>
28 #include <linux/spinlock.h>
29 #include <linux/u64_stats_sync.h>
34 /* The following definitions are for users of the vport subsytem: */
36 struct vport __rcu *gre_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(const struct net *net, const char *name);
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_set_upcall_portids(struct vport *, const struct nlattr *pids);
53 int ovs_vport_get_upcall_portids(const struct vport *, struct sk_buff *);
54 u32 ovs_vport_find_upcall_portid(const struct vport *, struct sk_buff *);
56 int ovs_vport_send(struct vport *, struct sk_buff *);
58 int ovs_tunnel_get_egress_info(struct ovs_tunnel_info *egress_tun_info,
60 const struct ovs_tunnel_info *tun_info,
65 int ovs_vport_get_egress_tun_info(struct vport *vport, struct sk_buff *skb,
66 struct ovs_tunnel_info *info);
68 /* The following definitions are for implementers of vport devices: */
69 struct vport_err_stats {
70 atomic_long_t rx_dropped;
71 atomic_long_t rx_errors;
72 atomic_long_t tx_dropped;
73 atomic_long_t tx_errors;
77 * struct vport_portids - array of netlink portids of a vport.
78 * must be protected by rcu.
79 * @rn_ids: The reciprocal value of @n_ids.
80 * @rcu: RCU callback head for deferred destruction.
81 * @n_ids: Size of @ids array.
82 * @ids: Array storing the Netlink socket pids to be used for packets received
83 * on this port that miss the flow table.
85 struct vport_portids {
86 struct reciprocal_value rn_ids;
93 * struct vport - one port within a datapath
94 * @rcu: RCU callback head for deferred destruction.
95 * @dp: Datapath to which this port belongs.
96 * @upcall_portids: RCU protected 'struct vport_portids'.
97 * @port_no: Index into @dp's @ports array.
98 * @hash_node: Element in @dev_table hash table in vport.c.
99 * @dp_hash_node: Element in @datapath->ports hash table in datapath.c.
100 * @ops: Class structure.
101 * @percpu_stats: Points to per-CPU statistics used and maintained by vport
102 * @err_stats: Points to error statistics used and maintained by vport
103 * @detach_list: list used for detaching vport in net-exit call.
108 struct vport_portids __rcu *upcall_portids;
111 struct hlist_node hash_node;
112 struct hlist_node dp_hash_node;
113 const struct vport_ops *ops;
115 struct pcpu_sw_netstats __percpu *percpu_stats;
117 struct vport_err_stats err_stats;
118 struct list_head detach_list;
122 * struct vport_parms - parameters for creating a new vport
124 * @name: New vport's name.
125 * @type: New vport's type.
126 * @options: %OVS_VPORT_ATTR_OPTIONS attribute from Netlink message, %NULL if
128 * @dp: New vport's datapath.
129 * @port_no: New vport's port number.
133 enum ovs_vport_type type;
134 struct nlattr *options;
136 /* For ovs_vport_alloc(). */
139 struct nlattr *upcall_portids;
143 * struct vport_ops - definition of a type of virtual port
145 * @type: %OVS_VPORT_TYPE_* value for this type of virtual port.
146 * @create: Create a new vport configured as specified. On success returns
147 * a new vport allocated with ovs_vport_alloc(), otherwise an ERR_PTR() value.
148 * @destroy: Destroys a vport. Must call vport_free() on the vport but not
149 * before an RCU grace period has elapsed.
150 * @set_options: Modify the configuration of an existing vport. May be %NULL
151 * if modification is not supported.
152 * @get_options: Appends vport-specific attributes for the configuration of an
153 * existing vport to a &struct sk_buff. May be %NULL for a vport that does not
154 * have any configuration.
155 * @get_name: Get the device's name.
156 * @send: Send a packet on the device. Returns the length of the packet sent,
157 * zero for dropped packets or negative for error.
158 * @get_egress_tun_info: Get the egress tunnel 5-tuple and other info for
162 enum ovs_vport_type type;
164 /* Called with ovs_mutex. */
165 struct vport *(*create)(const struct vport_parms *);
166 void (*destroy)(struct vport *);
168 int (*set_options)(struct vport *, struct nlattr *);
169 int (*get_options)(const struct vport *, struct sk_buff *);
171 /* Called with rcu_read_lock or ovs_mutex. */
172 const char *(*get_name)(const struct vport *);
174 int (*send)(struct vport *, struct sk_buff *);
175 int (*get_egress_tun_info)(struct vport *, struct sk_buff *,
176 struct ovs_tunnel_info *);
178 struct module *owner;
179 struct list_head list;
182 enum vport_err_type {
189 struct vport *ovs_vport_alloc(int priv_size, const struct vport_ops *,
190 const struct vport_parms *);
191 void ovs_vport_free(struct vport *);
192 void ovs_vport_deferred_free(struct vport *vport);
194 #define VPORT_ALIGN 8
197 * vport_priv - access private data area of vport
199 * @vport: vport to access
201 * If a nonzero size was passed in priv_size of vport_alloc() a private data
202 * area was allocated on creation. This allows that area to be accessed and
203 * used for any purpose needed by the vport implementer.
205 static inline void *vport_priv(const struct vport *vport)
207 return (u8 *)(uintptr_t)vport + ALIGN(sizeof(struct vport), VPORT_ALIGN);
211 * vport_from_priv - lookup vport from private data pointer
213 * @priv: Start of private data area.
215 * It is sometimes useful to translate from a pointer to the private data
216 * area to the vport, such as in the case where the private data pointer is
217 * the result of a hash table lookup. @priv must point to the start of the
220 static inline struct vport *vport_from_priv(void *priv)
222 return (struct vport *)((u8 *)priv - ALIGN(sizeof(struct vport), VPORT_ALIGN));
225 void ovs_vport_receive(struct vport *, struct sk_buff *,
226 const struct ovs_tunnel_info *);
228 static inline void ovs_skb_postpush_rcsum(struct sk_buff *skb,
229 const void *start, unsigned int len)
231 if (skb->ip_summed == CHECKSUM_COMPLETE)
232 skb->csum = csum_add(skb->csum, csum_partial(start, len, 0));
235 int ovs_vport_ops_register(struct vport_ops *ops);
236 void ovs_vport_ops_unregister(struct vport_ops *ops);