debian: Synchronize debian/changelog with downstream Debian changelog.
[openvswitch] / 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  * @port_no: Index into @dp's @ports array.
78  * @dp: Datapath to which this port belongs.
79  * @kobj: Represents /sys/class/net/<devname>/brport.
80  * @linkname: The name of the link from /sys/class/net/<datapath>/brif to this
81  * &struct vport.  (We keep this around so that we can delete it if the
82  * device gets renamed.)  Set to the null string when no link exists.
83  * @node: Element in @dp's @port_list.
84  * @upcall_pid: The Netlink port to use for packets received on this port that
85  * miss the flow table.
86  * @hash_node: Element in @dev_table hash table in vport.c.
87  * @dp_hash_node: Element in @datapath->ports hash table in datapath.c.
88  * @ops: Class structure.
89  * @percpu_stats: Points to per-CPU statistics used and maintained by vport
90  * @stats_lock: Protects @err_stats and @offset_stats.
91  * @err_stats: Points to error statistics used and maintained by vport
92  * @offset_stats: Added to actual statistics as a sop to compatibility with
93  * XAPI for Citrix XenServer.  Deprecated.
94  */
95 struct vport {
96         struct rcu_head rcu;
97         u16 port_no;
98         struct datapath *dp;
99         struct kobject kobj;
100         char linkname[IFNAMSIZ];
101         struct list_head node;
102         u32 upcall_pid;
103
104         struct hlist_node hash_node;
105         struct hlist_node dp_hash_node;
106         const struct vport_ops *ops;
107
108         struct vport_percpu_stats __percpu *percpu_stats;
109
110         spinlock_t stats_lock;
111         struct vport_err_stats err_stats;
112         struct ovs_vport_stats offset_stats;
113 };
114
115 #define VPORT_F_REQUIRED        (1 << 0) /* If init fails, module loading fails. */
116 #define VPORT_F_FLOW            (1 << 1) /* Sets OVS_CB(skb)->flow. */
117 #define VPORT_F_TUN_ID          (1 << 2) /* Sets OVS_CB(skb)->tun_id. */
118
119 /**
120  * struct vport_parms - parameters for creating a new vport
121  *
122  * @name: New vport's name.
123  * @type: New vport's type.
124  * @options: %OVS_VPORT_ATTR_OPTIONS attribute from Netlink message, %NULL if
125  * none was supplied.
126  * @dp: New vport's datapath.
127  * @port_no: New vport's port number.
128  */
129 struct vport_parms {
130         const char *name;
131         enum ovs_vport_type type;
132         struct nlattr *options;
133
134         /* For ovs_vport_alloc(). */
135         struct datapath *dp;
136         u16 port_no;
137         u32 upcall_pid;
138 };
139
140 /**
141  * struct vport_ops - definition of a type of virtual port
142  *
143  * @type: %OVS_VPORT_TYPE_* value for this type of virtual port.
144  * @flags: Flags of type VPORT_F_* that influence how the generic vport layer
145  * handles this vport.
146  * @init: Called at module initialization.  If VPORT_F_REQUIRED is set then the
147  * failure of this function will cause the module to not load.  If the flag is
148  * not set and initialzation fails then no vports of this type can be created.
149  * @exit: Called at module unload.
150  * @create: Create a new vport configured as specified.  On success returns
151  * a new vport allocated with ovs_vport_alloc(), otherwise an ERR_PTR() value.
152  * @destroy: Destroys a vport.  Must call vport_free() on the vport but not
153  * before an RCU grace period has elapsed.
154  * @set_options: Modify the configuration of an existing vport.  May be %NULL
155  * if modification is not supported.
156  * @get_options: Appends vport-specific attributes for the configuration of an
157  * existing vport to a &struct sk_buff.  May be %NULL for a vport that does not
158  * have any configuration.
159  * @set_addr: Set the device's MAC address.  May be null if not supported.
160  * @get_name: Get the device's name.
161  * @get_addr: Get the device's MAC address.
162  * @get_config: Get the device's configuration.
163  * @get_kobj: Get the kobj associated with the device (may return null).
164  * @get_dev_flags: Get the device's flags.
165  * @is_running: Checks whether the device is running.
166  * @get_operstate: Get the device's operating state.
167  * @get_ifindex: Get the system interface index associated with the device.
168  * May be null if the device does not have an ifindex.
169  * @get_mtu: Get the device's MTU.  May be %NULL if the device does not have an
170  * MTU (as e.g. some tunnels do not).  Must be implemented if @get_ifindex is
171  * implemented.
172  * @send: Send a packet on the device.  Returns the length of the packet sent.
173  */
174 struct vport_ops {
175         enum ovs_vport_type type;
176         u32 flags;
177
178         /* Called at module init and exit respectively. */
179         int (*init)(void);
180         void (*exit)(void);
181
182         /* Called with RTNL lock. */
183         struct vport *(*create)(const struct vport_parms *);
184         void (*destroy)(struct vport *);
185
186         int (*set_options)(struct vport *, struct nlattr *);
187         int (*get_options)(const struct vport *, struct sk_buff *);
188
189         int (*set_addr)(struct vport *, const unsigned char *);
190
191         /* Called with rcu_read_lock or RTNL lock. */
192         const char *(*get_name)(const struct vport *);
193         const unsigned char *(*get_addr)(const struct vport *);
194         void (*get_config)(const struct vport *, void *);
195         struct kobject *(*get_kobj)(const struct vport *);
196
197         unsigned (*get_dev_flags)(const struct vport *);
198         int (*is_running)(const struct vport *);
199         unsigned char (*get_operstate)(const struct vport *);
200
201         int (*get_ifindex)(const struct vport *);
202
203         int (*get_mtu)(const struct vport *);
204
205         int (*send)(struct vport *, struct sk_buff *);
206 };
207
208 enum vport_err_type {
209         VPORT_E_RX_DROPPED,
210         VPORT_E_RX_ERROR,
211         VPORT_E_TX_DROPPED,
212         VPORT_E_TX_ERROR,
213 };
214
215 struct vport *ovs_vport_alloc(int priv_size, const struct vport_ops *,
216                               const struct vport_parms *);
217 void ovs_vport_free(struct vport *);
218
219 #define VPORT_ALIGN 8
220
221 /**
222  *      vport_priv - access private data area of vport
223  *
224  * @vport: vport to access
225  *
226  * If a nonzero size was passed in priv_size of vport_alloc() a private data
227  * area was allocated on creation.  This allows that area to be accessed and
228  * used for any purpose needed by the vport implementer.
229  */
230 static inline void *vport_priv(const struct vport *vport)
231 {
232         return (u8 *)vport + ALIGN(sizeof(struct vport), VPORT_ALIGN);
233 }
234
235 /**
236  *      vport_from_priv - lookup vport from private data pointer
237  *
238  * @priv: Start of private data area.
239  *
240  * It is sometimes useful to translate from a pointer to the private data
241  * area to the vport, such as in the case where the private data pointer is
242  * the result of a hash table lookup.  @priv must point to the start of the
243  * private data area.
244  */
245 static inline struct vport *vport_from_priv(const void *priv)
246 {
247         return (struct vport *)(priv - ALIGN(sizeof(struct vport), VPORT_ALIGN));
248 }
249
250 void ovs_vport_receive(struct vport *, struct sk_buff *);
251 void ovs_vport_record_error(struct vport *, enum vport_err_type err_type);
252
253 /* List of statically compiled vport implementations.  Don't forget to also
254  * add yours to the list at the top of vport.c. */
255 extern const struct vport_ops ovs_netdev_vport_ops;
256 extern const struct vport_ops ovs_internal_vport_ops;
257 extern const struct vport_ops ovs_patch_vport_ops;
258 extern const struct vport_ops ovs_gre_vport_ops;
259 extern const struct vport_ops ovs_capwap_vport_ops;
260
261 #endif /* vport.h */