stream, vconn: Fix comments.
[sliver-openvswitch.git] / datapath / vport.h
1 /*
2  * Copyright (c) 2010 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 #include "odp-compat.h"
20
21 struct vport;
22 struct dp_port;
23
24 /* The following definitions are for users of the vport subsytem: */
25
26 int vport_user_add(const struct odp_vport_add __user *);
27 int vport_user_mod(const struct odp_vport_mod __user *);
28 int vport_user_del(const char __user *udevname);
29
30 #ifdef CONFIG_COMPAT
31 int compat_vport_user_add(struct compat_odp_vport_add __user *);
32 int compat_vport_user_mod(struct compat_odp_vport_mod __user *);
33 #endif
34
35 int vport_user_stats_get(struct odp_vport_stats_req __user *);
36 int vport_user_stats_set(struct odp_vport_stats_req __user *);
37 int vport_user_ether_get(struct odp_vport_ether __user *);
38 int vport_user_ether_set(struct odp_vport_ether __user *);
39 int vport_user_mtu_get(struct odp_vport_mtu __user *);
40 int vport_user_mtu_set(struct odp_vport_mtu __user *);
41
42 void vport_lock(void);
43 void vport_unlock(void);
44
45 int vport_init(void);
46 void vport_exit(void);
47
48 struct vport *vport_add(const char *name, const char *type, const void __user *config);
49 int vport_mod(struct vport *, const void __user *config);
50 int vport_del(struct vport *);
51
52 struct vport *vport_locate(const char *name);
53
54 int vport_attach(struct vport *, struct dp_port *);
55 int vport_detach(struct vport *);
56
57 int vport_set_mtu(struct vport *, int mtu);
58 int vport_set_addr(struct vport *, const unsigned char *);
59 int vport_set_stats(struct vport *, struct odp_vport_stats *);
60
61 const char *vport_get_name(const struct vport *);
62 const char *vport_get_type(const struct vport *);
63 const unsigned char *vport_get_addr(const struct vport *);
64
65 struct dp_port *vport_get_dp_port(const struct vport *);
66 struct kobject *vport_get_kobj(const struct vport *);
67 int vport_get_stats(struct vport *, struct odp_vport_stats *);
68
69 unsigned vport_get_flags(const struct vport *);
70 int vport_is_running(const struct vport *);
71 unsigned char vport_get_operstate(const struct vport *);
72
73 int vport_get_ifindex(const struct vport *);
74 int vport_get_iflink(const struct vport *);
75
76 int vport_get_mtu(const struct vport *);
77
78 int vport_send(struct vport *, struct sk_buff *);
79
80 /* The following definitions are for implementers of vport devices: */
81
82 struct vport_percpu_stats {
83         u64 rx_bytes;
84         u64 rx_packets;
85         u64 tx_bytes;
86         u64 tx_packets;
87         seqcount_t seqlock;
88 };
89
90 struct vport_err_stats {
91         u64 rx_dropped;
92         u64 rx_errors;
93         u64 rx_frame_err;
94         u64 rx_over_err;
95         u64 rx_crc_err;
96         u64 tx_dropped;
97         u64 tx_errors;
98         u64 collisions;
99 };
100
101 struct vport {
102         struct hlist_node hash_node;
103         const struct vport_ops *ops;
104         struct dp_port *dp_port;
105
106         struct vport_percpu_stats *percpu_stats;
107
108         spinlock_t stats_lock;
109         struct vport_err_stats err_stats;
110         struct odp_vport_stats offset_stats;
111 };
112
113 #define VPORT_F_REQUIRED        (1 << 0) /* If init fails, module loading fails. */
114 #define VPORT_F_GEN_STATS       (1 << 1) /* Track stats at the generic layer. */
115 #define VPORT_F_TUN_ID          (1 << 2) /* Sets OVS_CB(skb)->tun_id. */
116
117 /**
118  * struct vport_ops - definition of a type of virtual port
119  *
120  * @type: Name of port type, such as "netdev" or "internal" to be matched
121  * against the device type when a new port needs to be created.
122  * @flags: Flags of type VPORT_F_* that influence how the generic vport layer
123  * handles this vport.
124  * @init: Called at module initialization.  If VPORT_F_REQUIRED is set then the
125  * failure of this function will cause the module to not load.  If the flag is
126  * not set and initialzation fails then no vports of this type can be created.
127  * @exit: Called at module unload.
128  * @create: Create a new vport called 'name' with vport type specific
129  * configuration 'config' (which must be copied from userspace before use).  On
130  * success must allocate a new vport using vport_alloc().
131  * @modify: Modify the configuration of an existing vport.  May be null if
132  * modification is not supported.
133  * @destroy: Destroy and free a vport using vport_free().  Prior to destruction
134  * @detach will be called followed by synchronize_rcu().
135  * @attach: Attach a previously created vport to a datapath.  After attachment
136  * packets may be sent and received.  Prior to attachment any packets may be
137  * silently discarded.  May be null if not needed.
138  * @detach: Detach a vport from a datapath.  May be null if not needed.
139  * @set_mtu: Set the device's MTU.  May be null if not supported.
140  * @set_addr: Set the device's MAC address.  May be null if not supported.
141  * @set_stats: Provides stats as an offset to be added to the device stats.
142  * May be null if not supported.
143  * @get_name: Get the device's name.
144  * @get_addr: Get the device's MAC address.
145  * @get_kobj: Get the kobj associated with the device (may return null).
146  * @get_stats: Fill in the transmit/receive stats.  May be null if stats are
147  * not supported or if generic stats are in use.  If defined and
148  * VPORT_F_GEN_STATS is also set, the error stats are added to those already
149  * collected.
150  * @get_dev_flags: Get the device's flags.
151  * @is_running: Checks whether the device is running.
152  * @get_operstate: Get the device's operating state.
153  * @get_ifindex: Get the system interface index associated with the device.
154  * May be null if the device does not have an ifindex.
155  * @get_iflink: Get the system interface index associated with the device that
156  * will be used to send packets (may be different than ifindex for tunnels).
157  * May be null if the device does not have an iflink.
158  * @get_mtu: Get the device's MTU.
159  * @send: Send a packet on the device.  Returns the length of the packet sent.
160  */
161 struct vport_ops {
162         const char *type;
163         u32 flags;
164
165         /* Called at module init and exit respectively. */
166         int (*init)(void);
167         void (*exit)(void);
168
169         /* Called with RTNL lock. */
170         struct vport *(*create)(const char *name, const void __user *config);
171         int (*modify)(struct vport *, const void __user *config);
172         int (*destroy)(struct vport *);
173
174         int (*attach)(struct vport *);
175         int (*detach)(struct vport *);
176
177         int (*set_mtu)(struct vport *, int mtu);
178         int (*set_addr)(struct vport *, const unsigned char *);
179         int (*set_stats)(const struct vport *, struct odp_vport_stats *);
180
181         /* Called with rcu_read_lock or RTNL lock. */
182         const char *(*get_name)(const struct vport *);
183         const unsigned char *(*get_addr)(const struct vport *);
184         struct kobject *(*get_kobj)(const struct vport *);
185         int (*get_stats)(const struct vport *, struct odp_vport_stats *);
186
187         unsigned (*get_dev_flags)(const struct vport *);
188         int (*is_running)(const struct vport *);
189         unsigned char (*get_operstate)(const struct vport *);
190
191         int (*get_ifindex)(const struct vport *);
192         int (*get_iflink)(const struct vport *);
193
194         int (*get_mtu)(const struct vport *);
195
196         int (*send)(struct vport *, struct sk_buff *);
197 };
198
199 enum vport_err_type {
200         VPORT_E_RX_DROPPED,
201         VPORT_E_RX_ERROR,
202         VPORT_E_RX_FRAME,
203         VPORT_E_RX_OVER,
204         VPORT_E_RX_CRC,
205         VPORT_E_TX_DROPPED,
206         VPORT_E_TX_ERROR,
207         VPORT_E_COLLISION,
208 };
209
210 struct vport *vport_alloc(int priv_size, const struct vport_ops *);
211 void vport_free(struct vport *);
212
213 #define VPORT_ALIGN 8
214
215 /**
216  *      vport_priv - access private data area of vport
217  *
218  * @vport: vport to access
219  *
220  * If a nonzero size was passed in priv_size of vport_alloc() a private data
221  * area was allocated on creation.  This allows that area to be accessed and
222  * used for any purpose needed by the vport implementer.
223  */
224 static inline void *vport_priv(const struct vport *vport)
225 {
226         return (u8 *)vport + ALIGN(sizeof(struct vport), VPORT_ALIGN);
227 }
228
229 /**
230  *      vport_from_priv - lookup vport from private data pointer
231  *
232  * @priv: Start of private data area.
233  *
234  * It is sometimes useful to translate from a pointer to the private data
235  * area to the vport, such as in the case where the private data pointer is
236  * the result of a hash table lookup.  @priv must point to the start of the
237  * private data area.
238  */
239 static inline struct vport *vport_from_priv(const void *priv)
240 {
241         return (struct vport *)(priv - ALIGN(sizeof(struct vport), VPORT_ALIGN));
242 }
243
244 void vport_receive(struct vport *, struct sk_buff *);
245 void vport_record_error(struct vport *, enum vport_err_type err_type);
246
247 /* List of statically compiled vport implementations.  Don't forget to also
248  * add yours to the list at the top of vport.c. */
249 extern struct vport_ops netdev_vport_ops;
250 extern struct vport_ops internal_vport_ops;
251 extern struct vport_ops patch_vport_ops;
252 extern struct vport_ops gre_vport_ops;
253 extern struct vport_ops capwap_vport_ops;
254
255 #endif /* vport.h */