tunneling: Rely on protocol handles to parse ToS.
[sliver-openvswitch.git] / datapath / vport.h
1 /*
2  * Copyright (c) 2010, 2011 Nicira Networks.
3  * Distributed under the terms of the GNU GPL version 2.
4  *
5  * Significant portions of this file may be copied from parts of the Linux
6  * kernel, by Linus Torvalds and others.
7  */
8
9 #ifndef VPORT_H
10 #define VPORT_H 1
11
12 #include <linux/list.h>
13 #include <linux/seqlock.h>
14 #include <linux/skbuff.h>
15 #include <linux/spinlock.h>
16
17 #include "datapath.h"
18 #include "openvswitch/datapath-protocol.h"
19
20 struct vport;
21 struct vport_parms;
22
23 /* The following definitions are for users of the vport subsytem: */
24
25 int vport_init(void);
26 void vport_exit(void);
27
28 struct vport *vport_add(const struct vport_parms *);
29 int vport_del(struct vport *);
30
31 struct vport *vport_locate(const char *name);
32
33 int vport_set_mtu(struct vport *, int mtu);
34 int vport_set_addr(struct vport *, const unsigned char *);
35 int vport_set_stats(struct vport *, struct rtnl_link_stats64 *);
36
37 const char *vport_get_name(const struct vport *);
38 enum odp_vport_type vport_get_type(const struct vport *);
39 const unsigned char *vport_get_addr(const struct vport *);
40
41 struct kobject *vport_get_kobj(const struct vport *);
42 int vport_get_stats(struct vport *, struct rtnl_link_stats64 *);
43
44 unsigned vport_get_flags(const struct vport *);
45 int vport_is_running(const struct vport *);
46 unsigned char vport_get_operstate(const struct vport *);
47
48 int vport_get_ifindex(const struct vport *);
49 int vport_get_iflink(const struct vport *);
50
51 int vport_get_mtu(const struct vport *);
52
53 int vport_set_options(struct vport *, struct nlattr *options);
54 int vport_get_options(const struct vport *, struct sk_buff *);
55
56 int vport_send(struct vport *, struct sk_buff *);
57
58 /* The following definitions are for implementers of vport devices: */
59
60 struct vport_percpu_stats {
61         u64 rx_bytes;
62         u64 rx_packets;
63         u64 tx_bytes;
64         u64 tx_packets;
65         seqcount_t seqlock;
66 };
67
68 struct vport_err_stats {
69         u64 rx_dropped;
70         u64 rx_errors;
71         u64 tx_dropped;
72         u64 tx_errors;
73 };
74
75 /**
76  * struct vport - one port within a datapath
77  * @rcu: RCU callback head for deferred destruction.
78  * @port_no: Index into @dp's @ports array.
79  * @dp: Datapath to which this port belongs.
80  * @kobj: Represents /sys/class/net/<devname>/brport.
81  * @linkname: The name of the link from /sys/class/net/<datapath>/brif to this
82  * &struct vport.  (We keep this around so that we can delete it if the
83  * device gets renamed.)  Set to the null string when no link exists.
84  * @node: Element in @dp's @port_list.
85  * @sflow_pool: Number of packets that were candidates for sFlow sampling,
86  * regardless of whether they were actually chosen and sent down to userspace.
87  * @hash_node: Element in @dev_table hash table in vport.c.
88  * @ops: Class structure.
89  * @percpu_stats: Points to per-CPU statistics used and maintained by the vport
90  * code if %VPORT_F_GEN_STATS is set to 1 in @ops flags, otherwise unused.
91  * @stats_lock: Protects @err_stats and @offset_stats.
92  * @err_stats: Points to error statistics used and maintained by the vport code
93  * if %VPORT_F_GEN_STATS is set to 1 in @ops flags, otherwise unused.
94  * @offset_stats: Added to actual statistics as a sop to compatibility with
95  * XAPI for Citrix XenServer.  Deprecated.
96  */
97 struct vport {
98         struct rcu_head rcu;
99         u16 port_no;
100         struct datapath *dp;
101         struct kobject kobj;
102         char linkname[IFNAMSIZ];
103         struct list_head node;
104         atomic_t sflow_pool;
105
106         struct hlist_node hash_node;
107         const struct vport_ops *ops;
108
109         struct vport_percpu_stats __percpu *percpu_stats;
110
111         spinlock_t stats_lock;
112         struct vport_err_stats err_stats;
113         struct rtnl_link_stats64 offset_stats;
114 };
115
116 #define VPORT_F_REQUIRED        (1 << 0) /* If init fails, module loading fails. */
117 #define VPORT_F_GEN_STATS       (1 << 1) /* Track stats at the generic layer. */
118 #define VPORT_F_FLOW            (1 << 2) /* Sets OVS_CB(skb)->flow. */
119 #define VPORT_F_TUN_ID          (1 << 3) /* Sets OVS_CB(skb)->tun_id. */
120
121 /**
122  * struct vport_parms - parameters for creating a new vport
123  *
124  * @name: New vport's name.
125  * @type: New vport's type.
126  * @options: %ODP_VPORT_ATTR_OPTIONS attribute from Netlink message, %NULL if
127  * none was supplied.
128  * @dp: New vport's datapath.
129  * @port_no: New vport's port number.
130  */
131 struct vport_parms {
132         const char *name;
133         enum odp_vport_type type;
134         struct nlattr *options;
135
136         /* For vport_alloc(). */
137         struct datapath *dp;
138         u16 port_no;
139 };
140
141 /**
142  * struct vport_ops - definition of a type of virtual port
143  *
144  * @type: %ODP_VPORT_TYPE_* value for this type of virtual port.
145  * @flags: Flags of type VPORT_F_* that influence how the generic vport layer
146  * handles this vport.
147  * @init: Called at module initialization.  If VPORT_F_REQUIRED is set then the
148  * failure of this function will cause the module to not load.  If the flag is
149  * not set and initialzation fails then no vports of this type can be created.
150  * @exit: Called at module unload.
151  * @create: Create a new vport configured as specified.  On success returns
152  * a new vport allocated with vport_alloc(), otherwise an ERR_PTR() value.
153  * @destroy: Destroys a vport.  Must call vport_free() on the vport but not
154  * before an RCU grace period has elapsed.
155  * @set_options: Modify the configuration of an existing vport.  May be %NULL
156  * if modification is not supported.
157  * @get_options: Appends vport-specific attributes for the configuration of an
158  * existing vport to a &struct sk_buff.  May be %NULL for a vport that does not
159  * have any configuration.
160  * @set_mtu: Set the device's MTU.  May be null if not supported.
161  * @set_addr: Set the device's MAC address.  May be null if not supported.
162  * @get_name: Get the device's name.
163  * @get_addr: Get the device's MAC address.
164  * @get_config: Get the device's configuration.
165  * @get_kobj: Get the kobj associated with the device (may return null).
166  * @get_stats: Fill in the transmit/receive stats.  May be null if stats are
167  * not supported or if generic stats are in use.  If defined and
168  * VPORT_F_GEN_STATS is also set, the error stats are added to those already
169  * collected.
170  * @get_dev_flags: Get the device's flags.
171  * @is_running: Checks whether the device is running.
172  * @get_operstate: Get the device's operating state.
173  * @get_ifindex: Get the system interface index associated with the device.
174  * May be null if the device does not have an ifindex.
175  * @get_iflink: Get the system interface index associated with the device that
176  * will be used to send packets (may be different than ifindex for tunnels).
177  * May be null if the device does not have an iflink.
178  * @get_mtu: Get the device's MTU.  May be %NULL if the device does not have an
179  * MTU (as e.g. some tunnels do not).
180  * @send: Send a packet on the device.  Returns the length of the packet sent.
181  */
182 struct vport_ops {
183         enum odp_vport_type type;
184         u32 flags;
185
186         /* Called at module init and exit respectively. */
187         int (*init)(void);
188         void (*exit)(void);
189
190         /* Called with RTNL lock. */
191         struct vport *(*create)(const struct vport_parms *);
192         int (*destroy)(struct vport *);
193
194         int (*set_options)(struct vport *, struct nlattr *);
195         int (*get_options)(const struct vport *, struct sk_buff *);
196
197         int (*set_mtu)(struct vport *, int mtu);
198         int (*set_addr)(struct vport *, const unsigned char *);
199
200         /* Called with rcu_read_lock or RTNL lock. */
201         const char *(*get_name)(const struct vport *);
202         const unsigned char *(*get_addr)(const struct vport *);
203         void (*get_config)(const struct vport *, void *);
204         struct kobject *(*get_kobj)(const struct vport *);
205         int (*get_stats)(const struct vport *, struct rtnl_link_stats64 *);
206
207         unsigned (*get_dev_flags)(const struct vport *);
208         int (*is_running)(const struct vport *);
209         unsigned char (*get_operstate)(const struct vport *);
210
211         int (*get_ifindex)(const struct vport *);
212         int (*get_iflink)(const struct vport *);
213
214         int (*get_mtu)(const struct vport *);
215
216         int (*send)(struct vport *, struct sk_buff *);
217 };
218
219 enum vport_err_type {
220         VPORT_E_RX_DROPPED,
221         VPORT_E_RX_ERROR,
222         VPORT_E_TX_DROPPED,
223         VPORT_E_TX_ERROR,
224 };
225
226 struct vport *vport_alloc(int priv_size, const struct vport_ops *, const struct vport_parms *);
227 void vport_free(struct vport *);
228
229 #define VPORT_ALIGN 8
230
231 /**
232  *      vport_priv - access private data area of vport
233  *
234  * @vport: vport to access
235  *
236  * If a nonzero size was passed in priv_size of vport_alloc() a private data
237  * area was allocated on creation.  This allows that area to be accessed and
238  * used for any purpose needed by the vport implementer.
239  */
240 static inline void *vport_priv(const struct vport *vport)
241 {
242         return (u8 *)vport + ALIGN(sizeof(struct vport), VPORT_ALIGN);
243 }
244
245 /**
246  *      vport_from_priv - lookup vport from private data pointer
247  *
248  * @priv: Start of private data area.
249  *
250  * It is sometimes useful to translate from a pointer to the private data
251  * area to the vport, such as in the case where the private data pointer is
252  * the result of a hash table lookup.  @priv must point to the start of the
253  * private data area.
254  */
255 static inline struct vport *vport_from_priv(const void *priv)
256 {
257         return (struct vport *)(priv - ALIGN(sizeof(struct vport), VPORT_ALIGN));
258 }
259
260 void vport_receive(struct vport *, struct sk_buff *);
261 void vport_record_error(struct vport *, enum vport_err_type err_type);
262
263 /* List of statically compiled vport implementations.  Don't forget to also
264  * add yours to the list at the top of vport.c. */
265 extern const struct vport_ops netdev_vport_ops;
266 extern const struct vport_ops internal_vport_ops;
267 extern const struct vport_ops patch_vport_ops;
268 extern const struct vport_ops gre_vport_ops;
269 extern const struct vport_ops capwap_vport_ops;
270
271 #endif /* vport.h */