cda66c26ad0889a0d7ef99b5e14b2f83e4e2ff11
[muen/linux.git] / net / openvswitch / vport.h
1 /*
2  * Copyright (c) 2007-2012 Nicira, Inc.
3  *
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
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>
30
31 #include "datapath.h"
32
33 struct vport;
34 struct vport_parms;
35
36 /* The following definitions are for users of the vport subsytem: */
37
38 int ovs_vport_init(void);
39 void ovs_vport_exit(void);
40
41 struct vport *ovs_vport_add(const struct vport_parms *);
42 void ovs_vport_del(struct vport *);
43
44 struct vport *ovs_vport_locate(const struct net *net, const char *name);
45
46 void ovs_vport_get_stats(struct vport *, struct ovs_vport_stats *);
47
48 int ovs_vport_set_options(struct vport *, struct nlattr *options);
49 int ovs_vport_get_options(const struct vport *, struct sk_buff *);
50
51 int ovs_vport_set_upcall_portids(struct vport *, const struct nlattr *pids);
52 int ovs_vport_get_upcall_portids(const struct vport *, struct sk_buff *);
53 u32 ovs_vport_find_upcall_portid(const struct vport *, struct sk_buff *);
54
55 /**
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  */
64 struct vport_portids {
65         struct reciprocal_value rn_ids;
66         struct rcu_head rcu;
67         u32 n_ids;
68         u32 ids[];
69 };
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.
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         const struct vport_ops *ops;
92
93         struct list_head detach_list;
94         struct rcu_head rcu;
95 };
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  */
107 struct 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;
115         struct nlattr *upcall_portids;
116 };
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.
131  * @send: Send a packet on the device.
132  * zero for dropped packets or negative for error.
133  */
134 struct vport_ops {
135         enum ovs_vport_type type;
136
137         /* Called with ovs_mutex. */
138         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
144         netdev_tx_t (*send) (struct sk_buff *skb);
145         struct module *owner;
146         struct list_head list;
147 };
148
149 struct vport *ovs_vport_alloc(int priv_size, const struct vport_ops *,
150                               const struct vport_parms *);
151 void 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  */
164 static inline void *vport_priv(const struct vport *vport)
165 {
166         return (u8 *)(uintptr_t)vport + ALIGN(sizeof(struct vport), VPORT_ALIGN);
167 }
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  */
179 static inline struct vport *vport_from_priv(void *priv)
180 {
181         return (struct vport *)((u8 *)priv - ALIGN(sizeof(struct vport), VPORT_ALIGN));
182 }
183
184 int ovs_vport_receive(struct vport *, struct sk_buff *,
185                       const struct ip_tunnel_info *);
186
187 static inline const char *ovs_vport_name(struct vport *vport)
188 {
189         return vport->dev->name;
190 }
191
192 int __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
199 void ovs_vport_ops_unregister(struct vport_ops *ops);
200 void ovs_vport_send(struct vport *vport, struct sk_buff *skb, u8 mac_proto);
201
202 #endif /* vport.h */