blob: cda66c26ad0889a0d7ef99b5e14b2f83e4e2ff11 [file] [log] [blame]
Jesse Grossccb13522011-10-25 19:26:31 -07001/*
Raju Subramaniancaf2ee12012-05-03 18:55:23 -07002 * Copyright (c) 2007-2012 Nicira, Inc.
Jesse Grossccb13522011-10-25 19:26:31 -07003 *
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.
7 *
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.
12 *
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
16 * 02110-1301, USA
17 */
18
19#ifndef VPORT_H
20#define VPORT_H 1
21
Pravin B Shelare0f0ecf2013-04-15 13:30:37 -070022#include <linux/if_tunnel.h>
Jesse Grossccb13522011-10-25 19:26:31 -070023#include <linux/list.h>
Pravin B Shelar46df7b82012-02-22 19:58:59 -080024#include <linux/netlink.h>
Jesse Grossccb13522011-10-25 19:26:31 -070025#include <linux/openvswitch.h>
Alex Wang5cd667b2014-07-17 15:14:13 -070026#include <linux/reciprocal_div.h>
Jesse Grossccb13522011-10-25 19:26:31 -070027#include <linux/skbuff.h>
28#include <linux/spinlock.h>
29#include <linux/u64_stats_sync.h>
30
31#include "datapath.h"
32
33struct vport;
34struct vport_parms;
35
36/* The following definitions are for users of the vport subsytem: */
37
38int ovs_vport_init(void);
39void ovs_vport_exit(void);
40
41struct vport *ovs_vport_add(const struct vport_parms *);
42void ovs_vport_del(struct vport *);
43
Thomas Graf12eb18f2014-11-06 06:58:52 -080044struct vport *ovs_vport_locate(const struct net *net, const char *name);
Jesse Grossccb13522011-10-25 19:26:31 -070045
46void ovs_vport_get_stats(struct vport *, struct ovs_vport_stats *);
47
48int ovs_vport_set_options(struct vport *, struct nlattr *options);
49int ovs_vport_get_options(const struct vport *, struct sk_buff *);
50
Thomas Graf12eb18f2014-11-06 06:58:52 -080051int ovs_vport_set_upcall_portids(struct vport *, const struct nlattr *pids);
Alex Wang5cd667b2014-07-17 15:14:13 -070052int ovs_vport_get_upcall_portids(const struct vport *, struct sk_buff *);
53u32 ovs_vport_find_upcall_portid(const struct vport *, struct sk_buff *);
54
Alex Wang5cd667b2014-07-17 15:14:13 -070055/**
56 * struct vport_portids - array of netlink portids of a vport.
57 * must be protected by rcu.
58 * @rn_ids: The reciprocal value of @n_ids.
59 * @rcu: RCU callback head for deferred destruction.
60 * @n_ids: Size of @ids array.
61 * @ids: Array storing the Netlink socket pids to be used for packets received
62 * on this port that miss the flow table.
63 */
64struct vport_portids {
65 struct reciprocal_value rn_ids;
66 struct rcu_head rcu;
67 u32 n_ids;
68 u32 ids[];
69};
Jesse Grossccb13522011-10-25 19:26:31 -070070
71/**
72 * struct vport - one port within a datapath
Jean Sacrenc5420eb12016-01-09 16:07:11 -070073 * @dev: Pointer to net_device.
Jesse Grossccb13522011-10-25 19:26:31 -070074 * @dp: Datapath to which this port belongs.
Alex Wang5cd667b2014-07-17 15:14:13 -070075 * @upcall_portids: RCU protected 'struct vport_portids'.
Thomas Graf03599c92012-12-03 22:24:32 +000076 * @port_no: Index into @dp's @ports array.
Jesse Grossccb13522011-10-25 19:26:31 -070077 * @hash_node: Element in @dev_table hash table in vport.c.
Pravin B Shelar15eac2a2012-08-23 12:40:54 -070078 * @dp_hash_node: Element in @datapath->ports hash table in datapath.c.
Jesse Grossccb13522011-10-25 19:26:31 -070079 * @ops: Class structure.
Pravin B Shelar7b4577a2015-02-17 11:23:10 -080080 * @detach_list: list used for detaching vport in net-exit call.
Jean Sacrenc5420eb12016-01-09 16:07:11 -070081 * @rcu: RCU callback head for deferred destruction.
Jesse Grossccb13522011-10-25 19:26:31 -070082 */
83struct vport {
Thomas Grafbe4ace62015-07-21 10:44:04 +020084 struct net_device *dev;
Jesse Grossccb13522011-10-25 19:26:31 -070085 struct datapath *dp;
Alex Wang5cd667b2014-07-17 15:14:13 -070086 struct vport_portids __rcu *upcall_portids;
Thomas Graf03599c92012-12-03 22:24:32 +000087 u16 port_no;
Jesse Grossccb13522011-10-25 19:26:31 -070088
89 struct hlist_node hash_node;
Pravin B Shelar15eac2a2012-08-23 12:40:54 -070090 struct hlist_node dp_hash_node;
Jesse Grossccb13522011-10-25 19:26:31 -070091 const struct vport_ops *ops;
92
Pravin B Shelar7b4577a2015-02-17 11:23:10 -080093 struct list_head detach_list;
Thomas Grafbe4ace62015-07-21 10:44:04 +020094 struct rcu_head rcu;
Jesse Grossccb13522011-10-25 19:26:31 -070095};
96
97/**
98 * struct vport_parms - parameters for creating a new vport
99 *
100 * @name: New vport's name.
101 * @type: New vport's type.
102 * @options: %OVS_VPORT_ATTR_OPTIONS attribute from Netlink message, %NULL if
103 * none was supplied.
104 * @dp: New vport's datapath.
105 * @port_no: New vport's port number.
106 */
107struct vport_parms {
108 const char *name;
109 enum ovs_vport_type type;
110 struct nlattr *options;
111
112 /* For ovs_vport_alloc(). */
113 struct datapath *dp;
114 u16 port_no;
Alex Wang5cd667b2014-07-17 15:14:13 -0700115 struct nlattr *upcall_portids;
Jesse Grossccb13522011-10-25 19:26:31 -0700116};
117
118/**
119 * struct vport_ops - definition of a type of virtual port
120 *
121 * @type: %OVS_VPORT_TYPE_* value for this type of virtual port.
122 * @create: Create a new vport configured as specified. On success returns
123 * a new vport allocated with ovs_vport_alloc(), otherwise an ERR_PTR() value.
124 * @destroy: Destroys a vport. Must call vport_free() on the vport but not
125 * before an RCU grace period has elapsed.
126 * @set_options: Modify the configuration of an existing vport. May be %NULL
127 * if modification is not supported.
128 * @get_options: Appends vport-specific attributes for the configuration of an
129 * existing vport to a &struct sk_buff. May be %NULL for a vport that does not
130 * have any configuration.
Pravin B Shelar8c876632015-08-29 17:44:07 -0700131 * @send: Send a packet on the device.
Pravin B Shelar91b75142013-05-13 08:22:34 -0700132 * zero for dropped packets or negative for error.
Jesse Grossccb13522011-10-25 19:26:31 -0700133 */
134struct vport_ops {
135 enum ovs_vport_type type;
136
Pravin B Shelar8e4e1712013-04-15 13:23:03 -0700137 /* Called with ovs_mutex. */
Jesse Grossccb13522011-10-25 19:26:31 -0700138 struct vport *(*create)(const struct vport_parms *);
139 void (*destroy)(struct vport *);
140
141 int (*set_options)(struct vport *, struct nlattr *);
142 int (*get_options)(const struct vport *, struct sk_buff *);
143
Pravin B Shelaraec15922015-10-20 23:00:10 -0700144 netdev_tx_t (*send) (struct sk_buff *skb);
Thomas Graf62b9c8d2014-10-22 17:29:06 +0200145 struct module *owner;
146 struct list_head list;
Jesse Grossccb13522011-10-25 19:26:31 -0700147};
148
Jesse Grossccb13522011-10-25 19:26:31 -0700149struct vport *ovs_vport_alloc(int priv_size, const struct vport_ops *,
150 const struct vport_parms *);
151void ovs_vport_free(struct vport *);
152
153#define VPORT_ALIGN 8
154
155/**
156 * vport_priv - access private data area of vport
157 *
158 * @vport: vport to access
159 *
160 * If a nonzero size was passed in priv_size of vport_alloc() a private data
161 * area was allocated on creation. This allows that area to be accessed and
162 * used for any purpose needed by the vport implementer.
163 */
164static inline void *vport_priv(const struct vport *vport)
165{
Daniele Di Proietto07dc0602014-02-03 14:08:29 -0800166 return (u8 *)(uintptr_t)vport + ALIGN(sizeof(struct vport), VPORT_ALIGN);
Jesse Grossccb13522011-10-25 19:26:31 -0700167}
168
169/**
170 * vport_from_priv - lookup vport from private data pointer
171 *
172 * @priv: Start of private data area.
173 *
174 * It is sometimes useful to translate from a pointer to the private data
175 * area to the vport, such as in the case where the private data pointer is
176 * the result of a hash table lookup. @priv must point to the start of the
177 * private data area.
178 */
Daniele Di Proiettod0b4da12014-02-03 14:07:43 -0800179static inline struct vport *vport_from_priv(void *priv)
Jesse Grossccb13522011-10-25 19:26:31 -0700180{
Daniele Di Proiettod0b4da12014-02-03 14:07:43 -0800181 return (struct vport *)((u8 *)priv - ALIGN(sizeof(struct vport), VPORT_ALIGN));
Jesse Grossccb13522011-10-25 19:26:31 -0700182}
183
Pravin B Shelar8c876632015-08-29 17:44:07 -0700184int ovs_vport_receive(struct vport *, struct sk_buff *,
185 const struct ip_tunnel_info *);
Jesse Grossccb13522011-10-25 19:26:31 -0700186
Thomas Grafc9db9652015-07-21 10:44:05 +0200187static inline const char *ovs_vport_name(struct vport *vport)
188{
Pravin B Shelar24d43f32015-08-29 17:44:05 -0700189 return vport->dev->name;
Thomas Grafc9db9652015-07-21 10:44:05 +0200190}
191
Paolo Abeni83e4bf72015-11-30 12:31:43 +0100192int __ovs_vport_ops_register(struct vport_ops *ops);
193#define ovs_vport_ops_register(ops) \
194 ({ \
195 (ops)->owner = THIS_MODULE; \
196 __ovs_vport_ops_register(ops); \
197 })
198
Thomas Graf62b9c8d2014-10-22 17:29:06 +0200199void ovs_vport_ops_unregister(struct vport_ops *ops);
Jiri Bence2d9d832016-11-10 16:28:19 +0100200void ovs_vport_send(struct vport *vport, struct sk_buff *skb, u8 mac_proto);
Pravin B Shelar8c876632015-08-29 17:44:07 -0700201
Jesse Grossccb13522011-10-25 19:26:31 -0700202#endif /* vport.h */