ovsdb: Fix double-free in ovsdb_jsonrpc_session_close().
[sliver-openvswitch.git] / datapath / 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/list.h>
23 #include <linux/netlink.h>
24 #include <linux/openvswitch.h>
25 #include <linux/skbuff.h>
26 #include <linux/spinlock.h>
27 #include <linux/u64_stats_sync.h>
28
29 #include "vport-capwap.h"
30
31 struct vport;
32 struct vport_parms;
33
34 struct vport_net {
35         struct capwap_net capwap;
36 };
37
38 /* The following definitions are for users of the vport subsytem: */
39
40 int ovs_vport_init(void);
41 void ovs_vport_exit(void);
42
43 struct vport *ovs_vport_add(const struct vport_parms *);
44 void ovs_vport_del(struct vport *);
45
46 struct vport *ovs_vport_locate(struct net *net, const char *name);
47
48 int ovs_vport_set_addr(struct vport *, const unsigned char *);
49 void ovs_vport_set_stats(struct vport *, struct ovs_vport_stats *);
50 void ovs_vport_get_stats(struct vport *, struct ovs_vport_stats *);
51
52 int ovs_vport_set_options(struct vport *, struct nlattr *options);
53 int ovs_vport_get_options(const struct vport *, struct sk_buff *);
54
55 int ovs_vport_send(struct vport *, struct sk_buff *);
56
57 /* The following definitions are for implementers of vport devices: */
58
59 struct vport_percpu_stats {
60         u64 rx_bytes;
61         u64 rx_packets;
62         u64 tx_bytes;
63         u64 tx_packets;
64         struct u64_stats_sync sync;
65 };
66
67 struct vport_err_stats {
68         u64 rx_dropped;
69         u64 rx_errors;
70         u64 tx_dropped;
71         u64 tx_errors;
72 };
73
74 /**
75  * struct vport - one port within a datapath
76  * @rcu: RCU callback head for deferred destruction.
77  * @dp: Datapath to which this port belongs.
78  * @linkname: The name of the link from /sys/class/net/<datapath>/brif to this
79  * &struct vport.  (We keep this around so that we can delete it if the
80  * device gets renamed.)  Set to the null string when no link exists.
81  * @upcall_portid: The Netlink port to use for packets received on this port that
82  * miss the flow table.
83  * @port_no: Index into @dp's @ports array.
84  * @hash_node: Element in @dev_table hash table in vport.c.
85  * @dp_hash_node: Element in @datapath->ports hash table in datapath.c.
86  * @ops: Class structure.
87  * @percpu_stats: Points to per-CPU statistics used and maintained by vport
88  * @stats_lock: Protects @err_stats and @offset_stats.
89  * @err_stats: Points to error statistics used and maintained by vport
90  * @offset_stats: Added to actual statistics as a sop to compatibility with
91  * XAPI for Citrix XenServer.  Deprecated.
92  */
93 struct vport {
94         struct rcu_head rcu;
95         struct datapath *dp;
96         char linkname[IFNAMSIZ];
97         u32 upcall_portid;
98         u16 port_no;
99
100         struct hlist_node hash_node;
101         struct hlist_node dp_hash_node;
102         const struct vport_ops *ops;
103
104         struct vport_percpu_stats __percpu *percpu_stats;
105
106         spinlock_t stats_lock;
107         struct vport_err_stats err_stats;
108         struct ovs_vport_stats offset_stats;
109 };
110
111 #define VPORT_F_REQUIRED        (1 << 0) /* If init fails, module loading fails. */
112 #define VPORT_F_FLOW            (1 << 1) /* Sets OVS_CB(skb)->flow. */
113 #define VPORT_F_TUN_ID          (1 << 2) /* Sets OVS_CB(skb)->tun_id. */
114
115 /**
116  * struct vport_parms - parameters for creating a new vport
117  *
118  * @name: New vport's name.
119  * @type: New vport's type.
120  * @options: %OVS_VPORT_ATTR_OPTIONS attribute from Netlink message, %NULL if
121  * none was supplied.
122  * @dp: New vport's datapath.
123  * @port_no: New vport's port number.
124  */
125 struct vport_parms {
126         const char *name;
127         enum ovs_vport_type type;
128         struct nlattr *options;
129
130         /* For ovs_vport_alloc(). */
131         struct datapath *dp;
132         u16 port_no;
133         u32 upcall_portid;
134 };
135
136 /**
137  * struct vport_ops - definition of a type of virtual port
138  *
139  * @type: %OVS_VPORT_TYPE_* value for this type of virtual port.
140  * @flags: Flags of type VPORT_F_* that influence how the generic vport layer
141  * handles this vport.
142  * @init: Called at module initialization.  If VPORT_F_REQUIRED is set then the
143  * failure of this function will cause the module to not load.  If the flag is
144  * not set and initialzation fails then no vports of this type can be created.
145  * @exit: Called at module unload.
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  * @set_addr: Set the device's MAC address.  May be null if not supported.
156  * @get_name: Get the device's name.
157  * @get_addr: Get the device's MAC address.
158  * @get_config: Get the device's configuration.
159  * @get_ifindex: Get the system interface index associated with the device.
160  * May be null if the device does not have an ifindex.
161  * @send: Send a packet on the device.  Returns the length of the packet sent.
162  */
163 struct vport_ops {
164         enum ovs_vport_type type;
165         u32 flags;
166
167         /* Called at module init and exit respectively. */
168         int (*init)(void);
169         void (*exit)(void);
170
171         /* Called with RTNL lock. */
172         struct vport *(*create)(const struct vport_parms *);
173         void (*destroy)(struct vport *);
174
175         int (*set_options)(struct vport *, struct nlattr *);
176         int (*get_options)(const struct vport *, struct sk_buff *);
177
178         int (*set_addr)(struct vport *, const unsigned char *);
179
180         /* Called with rcu_read_lock or RTNL lock. */
181         const char *(*get_name)(const struct vport *);
182         const unsigned char *(*get_addr)(const struct vport *);
183         void (*get_config)(const struct vport *, void *);
184         int (*get_ifindex)(const struct vport *);
185         int (*send)(struct vport *, struct sk_buff *);
186 };
187
188 enum vport_err_type {
189         VPORT_E_RX_DROPPED,
190         VPORT_E_RX_ERROR,
191         VPORT_E_TX_DROPPED,
192         VPORT_E_TX_ERROR,
193 };
194
195 struct vport *ovs_vport_alloc(int priv_size, const struct vport_ops *,
196                               const struct vport_parms *);
197 void ovs_vport_free(struct vport *);
198
199 #define VPORT_ALIGN 8
200
201 /**
202  *      vport_priv - access private data area of vport
203  *
204  * @vport: vport to access
205  *
206  * If a nonzero size was passed in priv_size of vport_alloc() a private data
207  * area was allocated on creation.  This allows that area to be accessed and
208  * used for any purpose needed by the vport implementer.
209  */
210 static inline void *vport_priv(const struct vport *vport)
211 {
212         return (u8 *)vport + ALIGN(sizeof(struct vport), VPORT_ALIGN);
213 }
214
215 /**
216  *      vport_from_priv - lookup vport from private data pointer
217  *
218  * @priv: Start of private data area.
219  *
220  * It is sometimes useful to translate from a pointer to the private data
221  * area to the vport, such as in the case where the private data pointer is
222  * the result of a hash table lookup.  @priv must point to the start of the
223  * private data area.
224  */
225 static inline struct vport *vport_from_priv(const void *priv)
226 {
227         return (struct vport *)(priv - ALIGN(sizeof(struct vport), VPORT_ALIGN));
228 }
229
230 void ovs_vport_receive(struct vport *, struct sk_buff *);
231 void ovs_vport_record_error(struct vport *, enum vport_err_type err_type);
232
233 /* List of statically compiled vport implementations.  Don't forget to also
234  * add yours to the list at the top of vport.c. */
235 extern const struct vport_ops ovs_netdev_vport_ops;
236 extern const struct vport_ops ovs_internal_vport_ops;
237 extern const struct vport_ops ovs_patch_vport_ops;
238 extern const struct vport_ops ovs_gre_vport_ops;
239 extern const struct vport_ops ovs_gre_ft_vport_ops;
240 extern const struct vport_ops ovs_gre64_vport_ops;
241 extern const struct vport_ops ovs_capwap_vport_ops;
242 extern const struct vport_ops ovs_vxlan_vport_ops;
243
244 #endif /* vport.h */