vport.h 6.42 KB
Newer Older
1
/*
2
 * Copyright (c) 2007-2012 Nicira, Inc.
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of version 2 of the GNU General Public
 * License as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 * 02110-1301, USA
 */

#ifndef VPORT_H
#define VPORT_H 1

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
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
#include <linux/skbuff.h>
#include <linux/spinlock.h>
#include <linux/u64_stats_sync.h>

#include "datapath.h"

struct vport;
struct vport_parms;

/* The following definitions are for users of the vport subsytem: */

int ovs_vport_init(void);
void ovs_vport_exit(void);

struct vport *ovs_vport_add(const struct vport_parms *);
void ovs_vport_del(struct vport *);

44
struct vport *ovs_vport_locate(const struct net *net, const char *name);
45
46
47
48
49
50

void ovs_vport_get_stats(struct vport *, struct ovs_vport_stats *);

int ovs_vport_set_options(struct vport *, struct nlattr *options);
int ovs_vport_get_options(const struct vport *, struct sk_buff *);

51
int ovs_vport_set_upcall_portids(struct vport *, const struct nlattr *pids);
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
int ovs_vport_get_upcall_portids(const struct vport *, struct sk_buff *);
u32 ovs_vport_find_upcall_portid(const struct vport *, struct sk_buff *);

/**
 * struct vport_portids - array of netlink portids of a vport.
 *                        must be protected by rcu.
 * @rn_ids: The reciprocal value of @n_ids.
 * @rcu: RCU callback head for deferred destruction.
 * @n_ids: Size of @ids array.
 * @ids: Array storing the Netlink socket pids to be used for packets received
 * on this port that miss the flow table.
 */
struct vport_portids {
	struct reciprocal_value rn_ids;
	struct rcu_head rcu;
	u32 n_ids;
	u32 ids[];
};
70
71
72

/**
 * struct vport - one port within a datapath
73
 * @dev: Pointer to net_device.
74
 * @dp: Datapath to which this port belongs.
75
 * @upcall_portids: RCU protected 'struct vport_portids'.
76
 * @port_no: Index into @dp's @ports array.
77
 * @hash_node: Element in @dev_table hash table in vport.c.
78
 * @dp_hash_node: Element in @datapath->ports hash table in datapath.c.
79
 * @ops: Class structure.
Pravin B Shelar's avatar
Pravin B Shelar committed
80
 * @detach_list: list used for detaching vport in net-exit call.
81
 * @rcu: RCU callback head for deferred destruction.
82
83
 */
struct vport {
84
	struct net_device *dev;
85
	struct datapath	*dp;
86
	struct vport_portids __rcu *upcall_portids;
87
	u16 port_no;
88
89

	struct hlist_node hash_node;
90
	struct hlist_node dp_hash_node;
91
92
	const struct vport_ops *ops;

Pravin B Shelar's avatar
Pravin B Shelar committed
93
	struct list_head detach_list;
94
	struct rcu_head rcu;
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
};

/**
 * struct vport_parms - parameters for creating a new vport
 *
 * @name: New vport's name.
 * @type: New vport's type.
 * @options: %OVS_VPORT_ATTR_OPTIONS attribute from Netlink message, %NULL if
 * none was supplied.
 * @dp: New vport's datapath.
 * @port_no: New vport's port number.
 */
struct vport_parms {
	const char *name;
	enum ovs_vport_type type;
	struct nlattr *options;

	/* For ovs_vport_alloc(). */
	struct datapath *dp;
	u16 port_no;
115
	struct nlattr *upcall_portids;
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
};

/**
 * struct vport_ops - definition of a type of virtual port
 *
 * @type: %OVS_VPORT_TYPE_* value for this type of virtual port.
 * @create: Create a new vport configured as specified.  On success returns
 * a new vport allocated with ovs_vport_alloc(), otherwise an ERR_PTR() value.
 * @destroy: Destroys a vport.  Must call vport_free() on the vport but not
 * before an RCU grace period has elapsed.
 * @set_options: Modify the configuration of an existing vport.  May be %NULL
 * if modification is not supported.
 * @get_options: Appends vport-specific attributes for the configuration of an
 * existing vport to a &struct sk_buff.  May be %NULL for a vport that does not
 * have any configuration.
131
 * @send: Send a packet on the device.
132
 * zero for dropped packets or negative for error.
133
134
135
136
 */
struct vport_ops {
	enum ovs_vport_type type;

137
	/* Called with ovs_mutex. */
138
139
140
141
142
143
	struct vport *(*create)(const struct vport_parms *);
	void (*destroy)(struct vport *);

	int (*set_options)(struct vport *, struct nlattr *);
	int (*get_options)(const struct vport *, struct sk_buff *);

144
	netdev_tx_t (*send) (struct sk_buff *skb);
145
146
	struct module *owner;
	struct list_head list;
147
148
149
150
151
};

struct vport *ovs_vport_alloc(int priv_size, const struct vport_ops *,
			      const struct vport_parms *);
void ovs_vport_free(struct vport *);
152
void ovs_vport_deferred_free(struct vport *vport);
153
154
155
156
157
158
159
160
161
162
163
164
165
166

#define VPORT_ALIGN 8

/**
 *	vport_priv - access private data area of vport
 *
 * @vport: vport to access
 *
 * If a nonzero size was passed in priv_size of vport_alloc() a private data
 * area was allocated on creation.  This allows that area to be accessed and
 * used for any purpose needed by the vport implementer.
 */
static inline void *vport_priv(const struct vport *vport)
{
167
	return (u8 *)(uintptr_t)vport + ALIGN(sizeof(struct vport), VPORT_ALIGN);
168
169
170
171
172
173
174
175
176
177
178
179
}

/**
 *	vport_from_priv - lookup vport from private data pointer
 *
 * @priv: Start of private data area.
 *
 * It is sometimes useful to translate from a pointer to the private data
 * area to the vport, such as in the case where the private data pointer is
 * the result of a hash table lookup.  @priv must point to the start of the
 * private data area.
 */
180
static inline struct vport *vport_from_priv(void *priv)
181
{
182
	return (struct vport *)((u8 *)priv - ALIGN(sizeof(struct vport), VPORT_ALIGN));
183
184
}

185
186
int ovs_vport_receive(struct vport *, struct sk_buff *,
		      const struct ip_tunnel_info *);
187

188
189
190
191
192
193
194
static inline void ovs_skb_postpush_rcsum(struct sk_buff *skb,
				      const void *start, unsigned int len)
{
	if (skb->ip_summed == CHECKSUM_COMPLETE)
		skb->csum = csum_add(skb->csum, csum_partial(start, len, 0));
}

195
196
static inline const char *ovs_vport_name(struct vport *vport)
{
197
	return vport->dev->name;
198
199
}

200
201
202
203
204
205
206
int __ovs_vport_ops_register(struct vport_ops *ops);
#define ovs_vport_ops_register(ops)		\
	({					\
		(ops)->owner = THIS_MODULE;	\
		__ovs_vport_ops_register(ops);	\
	})

207
void ovs_vport_ops_unregister(struct vport_ops *ops);
208
void ovs_vport_send(struct vport *vport, struct sk_buff *skb);
209

210
#endif /* vport.h */