openvswitch.h: Add missing words in comment.
[sliver-openvswitch.git] / include / linux / openvswitch.h
1 /*
2  * Copyright (c) 2009, 2010, 2011 Nicira Networks.
3  *
4  * This file is offered under your choice of two licenses: Apache 2.0 or GNU
5  * GPL 2.0 or later.  The permission statements for each of these licenses is
6  * given below.  You may license your modifications to this file under either
7  * of these licenses or both.  If you wish to license your modifications under
8  * only one of these licenses, delete the permission text for the other
9  * license.
10  *
11  * ----------------------------------------------------------------------
12  * Licensed under the Apache License, Version 2.0 (the "License");
13  * you may not use this file except in compliance with the License.
14  * You may obtain a copy of the License at:
15  *
16  *     http://www.apache.org/licenses/LICENSE-2.0
17  *
18  * Unless required by applicable law or agreed to in writing, software
19  * distributed under the License is distributed on an "AS IS" BASIS,
20  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
21  * See the License for the specific language governing permissions and
22  * limitations under the License.
23  * ----------------------------------------------------------------------
24  * This program is free software; you can redistribute it and/or modify
25  * it under the terms of the GNU General Public License as published by
26  * the Free Software Foundation; either version 2 of the License, or
27  * (at your option) any later version.
28  *
29  * This program is distributed in the hope that it will be useful,
30  * but WITHOUT ANY WARRANTY; without even the implied warranty of
31  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
32  * GNU General Public License for more details.
33  *
34  * You should have received a copy of the GNU General Public License along
35  * with this program; if not, write to the Free Software Foundation, Inc.,
36  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
37  * ----------------------------------------------------------------------
38  */
39
40 #ifndef _LINUX_OPENVSWITCH_H
41 #define _LINUX_OPENVSWITCH_H 1
42
43 #include <linux/types.h>
44
45 /**
46  * struct ovs_header - header for OVS Generic Netlink messages.
47  * @dp_ifindex: ifindex of local port for datapath (0 to make a request not
48  * specific to a datapath).
49  *
50  * Attributes following the header are specific to a particular OVS Generic
51  * Netlink family, but all of the OVS families use this header.
52  */
53
54 struct ovs_header {
55         int dp_ifindex;
56 };
57
58 /* Datapaths. */
59
60 #define OVS_DATAPATH_FAMILY  "ovs_datapath"
61 #define OVS_DATAPATH_MCGROUP "ovs_datapath"
62 #define OVS_DATAPATH_VERSION 0x1
63
64 enum ovs_datapath_cmd {
65         OVS_DP_CMD_UNSPEC,
66         OVS_DP_CMD_NEW,
67         OVS_DP_CMD_DEL,
68         OVS_DP_CMD_GET,
69         OVS_DP_CMD_SET
70 };
71
72 /**
73  * enum ovs_datapath_attr - attributes for %OVS_DP_* commands.
74  * @OVS_DP_ATTR_NAME: Name of the network device that serves as the "local
75  * port".  This is the name of the network device whose dp_ifindex is given in
76  * the &struct ovs_header.  Always present in notifications.  Required in
77  * %OVS_DP_NEW requests.  May be used as an alternative to specifying
78  * dp_ifindex in other requests (with a dp_ifindex of 0).
79  * @OVS_DP_ATTR_UPCALL_PID: The Netlink socket in userspace that is initially
80  * set on the datapath port (for OVS_ACTION_ATTR_MISS).  Only valid on
81  * %OVS_DP_CMD_NEW requests. A value of zero indicates that upcalls should
82  * not be sent.
83  * @OVS_DP_ATTR_STATS: Statistics about packets that have passed through the
84  * datapath.  Always present in notifications.
85  *
86  * These attributes follow the &struct ovs_header within the Generic Netlink
87  * payload for %OVS_DP_* commands.
88  */
89 enum ovs_datapath_attr {
90         OVS_DP_ATTR_UNSPEC,
91         OVS_DP_ATTR_NAME,       /* name of dp_ifindex netdev */
92         OVS_DP_ATTR_UPCALL_PID, /* Netlink PID to receive upcalls */
93         OVS_DP_ATTR_STATS,      /* struct ovs_dp_stats */
94         __OVS_DP_ATTR_MAX
95 };
96
97 #define OVS_DP_ATTR_MAX (__OVS_DP_ATTR_MAX - 1)
98
99 struct ovs_dp_stats {
100         __u64 n_hit;             /* Number of flow table matches. */
101         __u64 n_missed;          /* Number of flow table misses. */
102         __u64 n_lost;            /* Number of misses not sent to userspace. */
103         __u64 n_flows;           /* Number of flows present */
104 };
105
106 struct ovs_vport_stats {
107         __u64   rx_packets;             /* total packets received       */
108         __u64   tx_packets;             /* total packets transmitted    */
109         __u64   rx_bytes;               /* total bytes received         */
110         __u64   tx_bytes;               /* total bytes transmitted      */
111         __u64   rx_errors;              /* bad packets received         */
112         __u64   tx_errors;              /* packet transmit problems     */
113         __u64   rx_dropped;             /* no space in linux buffers    */
114         __u64   tx_dropped;             /* no space available in linux  */
115 };
116
117 /* Fixed logical ports. */
118 #define OVSP_LOCAL      ((__u16)0)
119
120 /* Packet transfer. */
121
122 #define OVS_PACKET_FAMILY "ovs_packet"
123 #define OVS_PACKET_VERSION 0x1
124
125 enum ovs_packet_cmd {
126         OVS_PACKET_CMD_UNSPEC,
127
128         /* Kernel-to-user notifications. */
129         OVS_PACKET_CMD_MISS,    /* Flow table miss. */
130         OVS_PACKET_CMD_ACTION,  /* OVS_ACTION_ATTR_USERSPACE action. */
131
132         /* Userspace commands. */
133         OVS_PACKET_CMD_EXECUTE  /* Apply actions to a packet. */
134 };
135
136 /**
137  * enum ovs_packet_attr - attributes for %OVS_PACKET_* commands.
138  * @OVS_PACKET_ATTR_PACKET: Present for all notifications.  Contains the entire
139  * packet as received, from the start of the Ethernet header onward.  For
140  * %OVS_PACKET_CMD_ACTION, %OVS_PACKET_ATTR_PACKET reflects changes made by
141  * actions preceding %OVS_ACTION_ATTR_USERSPACE, but %OVS_PACKET_ATTR_KEY is
142  * the flow key extracted from the packet as originally received.
143  * @OVS_PACKET_ATTR_KEY: Present for all notifications.  Contains the flow key
144  * extracted from the packet as nested %OVS_KEY_ATTR_* attributes.  This allows
145  * userspace to adapt its flow setup strategy by comparing its notion of the
146  * flow key against the kernel's.
147  * @OVS_PACKET_ATTR_ACTIONS: Contains actions for the packet.  Used
148  * for %OVS_PACKET_CMD_EXECUTE.  It has nested %OVS_ACTION_ATTR_* attributes.
149  * @OVS_PACKET_ATTR_USERDATA: Present for an %OVS_PACKET_CMD_ACTION
150  * notification if the %OVS_ACTION_ATTR_USERSPACE action specified an
151  * %OVS_USERSPACE_ATTR_USERDATA attribute.
152  *
153  * These attributes follow the &struct ovs_header within the Generic Netlink
154  * payload for %OVS_PACKET_* commands.
155  */
156 enum ovs_packet_attr {
157         OVS_PACKET_ATTR_UNSPEC,
158         OVS_PACKET_ATTR_PACKET,      /* Packet data. */
159         OVS_PACKET_ATTR_KEY,         /* Nested OVS_KEY_ATTR_* attributes. */
160         OVS_PACKET_ATTR_ACTIONS,     /* Nested OVS_ACTION_ATTR_* attributes. */
161         OVS_PACKET_ATTR_USERDATA,    /* u64 OVS_ACTION_ATTR_USERSPACE arg. */
162         __OVS_PACKET_ATTR_MAX
163 };
164
165 #define OVS_PACKET_ATTR_MAX (__OVS_PACKET_ATTR_MAX - 1)
166
167 /* Virtual ports. */
168
169 #define OVS_VPORT_FAMILY  "ovs_vport"
170 #define OVS_VPORT_MCGROUP "ovs_vport"
171 #define OVS_VPORT_VERSION 0x1
172
173 enum ovs_vport_cmd {
174         OVS_VPORT_CMD_UNSPEC,
175         OVS_VPORT_CMD_NEW,
176         OVS_VPORT_CMD_DEL,
177         OVS_VPORT_CMD_GET,
178         OVS_VPORT_CMD_SET
179 };
180
181 enum ovs_vport_type {
182         OVS_VPORT_TYPE_UNSPEC,
183         OVS_VPORT_TYPE_NETDEV,   /* network device */
184         OVS_VPORT_TYPE_INTERNAL, /* network device implemented by datapath */
185         OVS_VPORT_TYPE_PATCH,    /* virtual tunnel connecting two vports */
186         OVS_VPORT_TYPE_GRE,      /* GRE tunnel */
187         OVS_VPORT_TYPE_CAPWAP,   /* CAPWAP tunnel */
188         __OVS_VPORT_TYPE_MAX
189 };
190
191 #define OVS_VPORT_TYPE_MAX (__OVS_VPORT_TYPE_MAX - 1)
192
193 /**
194  * enum ovs_vport_attr - attributes for %OVS_VPORT_* commands.
195  * @OVS_VPORT_ATTR_PORT_NO: 32-bit port number within datapath.
196  * @OVS_VPORT_ATTR_TYPE: 32-bit %OVS_VPORT_TYPE_* constant describing the type
197  * of vport.
198  * @OVS_VPORT_ATTR_NAME: Name of vport.  For a vport based on a network device
199  * this is the name of the network device.  Maximum length %IFNAMSIZ-1 bytes
200  * plus a null terminator.
201  * @OVS_VPORT_ATTR_UPCALL_PID: The Netlink socket in userspace that
202  * OVS_PACKET_CMD_MISS upcalls will be directed to for packets received on
203  * this port.  A value of zero indicates that upcalls should not be sent.
204  * @OVS_VPORT_ATTR_STATS: A &struct ovs_vport_stats giving statistics for
205  * packets sent or received through the vport.
206  * @OVS_VPORT_ATTR_ADDRESS: A 6-byte Ethernet address for the vport.
207  *
208  * These attributes follow the &struct ovs_header within the Generic Netlink
209  * payload for %OVS_VPORT_* commands.
210  *
211  * For %OVS_VPORT_CMD_NEW requests, the %OVS_VPORT_ATTR_TYPE and
212  * %OVS_VPORT_ATTR_NAME attributes are required.  %OVS_VPORT_ATTR_PORT_NO is
213  * optional; if not specified a free port number is automatically selected.
214  * Whether %OVS_VPORT_ATTR_OPTIONS is required or optional depends on the type
215  * of vport.  %OVS_VPORT_ATTR_STATS and %OVS_VPORT_ATTR_ADDRESS are optional,
216  * and other attributes are ignored.
217  *
218  * For other requests, if %OVS_VPORT_ATTR_NAME is specified then it is used to
219  * look up the vport to operate on; otherwise dp_idx from the &struct
220  * ovs_header plus %OVS_VPORT_ATTR_PORT_NO determine the vport.
221  */
222 enum ovs_vport_attr {
223         OVS_VPORT_ATTR_UNSPEC,
224         OVS_VPORT_ATTR_PORT_NO, /* u32 port number within datapath */
225         OVS_VPORT_ATTR_TYPE,    /* u32 OVS_VPORT_TYPE_* constant. */
226         OVS_VPORT_ATTR_NAME,    /* string name, up to IFNAMSIZ bytes long */
227         OVS_VPORT_ATTR_UPCALL_PID, /* u32 Netlink PID to receive upcalls */
228         OVS_VPORT_ATTR_STATS,   /* struct ovs_vport_stats */
229         OVS_VPORT_ATTR_ADDRESS, /* hardware address */
230         OVS_VPORT_ATTR_OPTIONS, /* nested attributes, varies by vport type */
231         __OVS_VPORT_ATTR_MAX
232 };
233
234 #define OVS_VPORT_ATTR_MAX (__OVS_VPORT_ATTR_MAX - 1)
235
236 /* OVS_VPORT_ATTR_OPTIONS attributes for patch vports. */
237 enum {
238         OVS_PATCH_ATTR_UNSPEC,
239         OVS_PATCH_ATTR_PEER,    /* name of peer vport, as a string */
240         __OVS_PATCH_ATTR_MAX
241 };
242
243 #define OVS_PATCH_ATTR_MAX (__OVS_PATCH_ATTR_MAX - 1)
244
245 /* Flows. */
246
247 #define OVS_FLOW_FAMILY  "ovs_flow"
248 #define OVS_FLOW_MCGROUP "ovs_flow"
249 #define OVS_FLOW_VERSION 0x1
250
251 enum ovs_flow_cmd {
252         OVS_FLOW_CMD_UNSPEC,
253         OVS_FLOW_CMD_NEW,
254         OVS_FLOW_CMD_DEL,
255         OVS_FLOW_CMD_GET,
256         OVS_FLOW_CMD_SET
257 };
258
259 struct ovs_flow_stats {
260         __u64 n_packets;         /* Number of matched packets. */
261         __u64 n_bytes;           /* Number of matched bytes. */
262 };
263
264 enum ovs_key_attr {
265         OVS_KEY_ATTR_UNSPEC,
266         OVS_KEY_ATTR_PRIORITY,  /* 32-bit skb->priority */
267         OVS_KEY_ATTR_TUN_ID,    /* 64-bit tunnel ID */
268         OVS_KEY_ATTR_IN_PORT,   /* 32-bit OVS dp port number */
269         OVS_KEY_ATTR_ETHERNET,  /* struct ovs_key_ethernet */
270         OVS_KEY_ATTR_8021Q,     /* struct ovs_key_8021q */
271         OVS_KEY_ATTR_ETHERTYPE, /* 16-bit Ethernet type */
272         OVS_KEY_ATTR_IPV4,      /* struct ovs_key_ipv4 */
273         OVS_KEY_ATTR_IPV6,      /* struct ovs_key_ipv6 */
274         OVS_KEY_ATTR_TCP,       /* struct ovs_key_tcp */
275         OVS_KEY_ATTR_UDP,       /* struct ovs_key_udp */
276         OVS_KEY_ATTR_ICMP,      /* struct ovs_key_icmp */
277         OVS_KEY_ATTR_ICMPV6,    /* struct ovs_key_icmpv6 */
278         OVS_KEY_ATTR_ARP,       /* struct ovs_key_arp */
279         OVS_KEY_ATTR_ND,        /* struct ovs_key_nd */
280         __OVS_KEY_ATTR_MAX
281 };
282
283 #define OVS_KEY_ATTR_MAX (__OVS_KEY_ATTR_MAX - 1)
284
285 /**
286  * enum ovs_frag_type - IPv4 and IPv6 fragment type
287  * @OVS_FRAG_TYPE_NONE: Packet is not a fragment.
288  * @OVS_FRAG_TYPE_FIRST: Packet is a fragment with offset 0.
289  * @OVS_FRAG_TYPE_LATER: Packet is a fragment with nonzero offset.
290  *
291  * Used as the @ipv4_frag in &struct ovs_key_ipv4 and as @ipv6_frag &struct
292  * ovs_key_ipv6.
293  */
294 enum ovs_frag_type {
295         OVS_FRAG_TYPE_NONE,
296         OVS_FRAG_TYPE_FIRST,
297         OVS_FRAG_TYPE_LATER,
298         __OVS_FRAG_TYPE_MAX
299 };
300
301 #define OVS_FRAG_TYPE_MAX (__OVS_FRAG_TYPE_MAX - 1)
302
303 struct ovs_key_ethernet {
304         __u8     eth_src[6];
305         __u8     eth_dst[6];
306 };
307
308 struct ovs_key_8021q {
309         __be16 q_tpid;
310         __be16 q_tci;
311 };
312
313 struct ovs_key_ipv4 {
314         __be32 ipv4_src;
315         __be32 ipv4_dst;
316         __u8   ipv4_proto;
317         __u8   ipv4_tos;
318         __u8   ipv4_frag;       /* One of OVS_FRAG_TYPE_*. */
319 };
320
321 struct ovs_key_ipv6 {
322         __be32 ipv6_src[4];
323         __be32 ipv6_dst[4];
324         __u8   ipv6_proto;
325         __u8   ipv6_tos;
326         __u8   ipv6_frag;       /* One of OVS_FRAG_TYPE_*. */
327 };
328
329 struct ovs_key_tcp {
330         __be16 tcp_src;
331         __be16 tcp_dst;
332 };
333
334 struct ovs_key_udp {
335         __be16 udp_src;
336         __be16 udp_dst;
337 };
338
339 struct ovs_key_icmp {
340         __u8 icmp_type;
341         __u8 icmp_code;
342 };
343
344 struct ovs_key_icmpv6 {
345         __u8 icmpv6_type;
346         __u8 icmpv6_code;
347 };
348
349 struct ovs_key_arp {
350         __be32 arp_sip;
351         __be32 arp_tip;
352         __be16 arp_op;
353         __u8   arp_sha[6];
354         __u8   arp_tha[6];
355 };
356
357 struct ovs_key_nd {
358         __u32 nd_target[4];
359         __u8  nd_sll[6];
360         __u8  nd_tll[6];
361 };
362
363 /**
364  * enum ovs_flow_attr - attributes for %OVS_FLOW_* commands.
365  * @OVS_FLOW_ATTR_KEY: Nested %OVS_KEY_ATTR_* attributes specifying the flow
366  * key.  Always present in notifications.  Required for all requests (except
367  * dumps).
368  * @OVS_FLOW_ATTR_ACTIONS: Nested %OVS_ACTION_ATTR_* attributes specifying
369  * the actions to take for packets that match the key.  Always present in
370  * notifications.  Required for %OVS_FLOW_CMD_NEW requests, optional for
371  * %OVS_FLOW_CMD_SET requests.
372  * @OVS_FLOW_ATTR_STATS: &struct ovs_flow_stats giving statistics for this
373  * flow.  Present in notifications if the stats would be nonzero.  Ignored in
374  * requests.
375  * @OVS_FLOW_ATTR_TCP_FLAGS: An 8-bit value giving the OR'd value of all of the
376  * TCP flags seen on packets in this flow.  Only present in notifications for
377  * TCP flows, and only if it would be nonzero.  Ignored in requests.
378  * @OVS_FLOW_ATTR_USED: A 64-bit integer giving the time, in milliseconds on
379  * the system monotonic clock, at which a packet was last processed for this
380  * flow.  Only present in notifications if a packet has been processed for this
381  * flow.  Ignored in requests.
382  * @OVS_FLOW_ATTR_CLEAR: If present in a %OVS_FLOW_CMD_SET request, clears the
383  * last-used time, accumulated TCP flags, and statistics for this flow.
384  * Otherwise ignored in requests.  Never present in notifications.
385  *
386  * These attributes follow the &struct ovs_header within the Generic Netlink
387  * payload for %OVS_FLOW_* commands.
388  */
389 enum ovs_flow_attr {
390         OVS_FLOW_ATTR_UNSPEC,
391         OVS_FLOW_ATTR_KEY,       /* Sequence of OVS_KEY_ATTR_* attributes. */
392         OVS_FLOW_ATTR_ACTIONS,   /* Nested OVS_ACTION_ATTR_* attributes. */
393         OVS_FLOW_ATTR_STATS,     /* struct ovs_flow_stats. */
394         OVS_FLOW_ATTR_TCP_FLAGS, /* 8-bit OR'd TCP flags. */
395         OVS_FLOW_ATTR_USED,      /* u64 msecs last used in monotonic time. */
396         OVS_FLOW_ATTR_CLEAR,     /* Flag to clear stats, tcp_flags, used. */
397         __OVS_FLOW_ATTR_MAX
398 };
399
400 #define OVS_FLOW_ATTR_MAX (__OVS_FLOW_ATTR_MAX - 1)
401
402 /**
403  * enum ovs_sample_attr - Attributes for %OVS_ACTION_ATTR_SAMPLE action.
404  * @OVS_SAMPLE_ATTR_PROBABILITY: 32-bit fraction of packets to sample with
405  * @OVS_ACTION_ATTR_SAMPLE.  A value of 0 samples no packets, a value of
406  * %UINT32_MAX samples all packets and intermediate values sample intermediate
407  * fractions of packets.
408  * @OVS_SAMPLE_ATTR_ACTIONS: Set of actions to execute in sampling event.
409  * Actions are passed as nested attributes.
410  *
411  * Executes the specified actions with the given probability on a per-packet
412  * basis.
413  */
414 enum ovs_sample_attr {
415         OVS_SAMPLE_ATTR_UNSPEC,
416         OVS_SAMPLE_ATTR_PROBABILITY, /* u32 number */
417         OVS_SAMPLE_ATTR_ACTIONS,     /* Nested OVS_ACTION_ATTR_* attributes. */
418         __OVS_SAMPLE_ATTR_MAX,
419 };
420
421 #define OVS_SAMPLE_ATTR_MAX (__OVS_SAMPLE_ATTR_MAX - 1)
422
423 /**
424  * enum ovs_userspace_attr - Attributes for %OVS_ACTION_ATTR_USERSPACE action.
425  * @OVS_USERSPACE_ATTR_PID: u32 Netlink PID to which the %OVS_PACKET_CMD_ACTION
426  * message should be sent.  Required.
427  * @OVS_USERSPACE_ATTR_USERDATA: If present, its u64 argument is copied to the
428  * %OVS_PACKET_CMD_ACTION message as %OVS_PACKET_ATTR_USERDATA,
429  */
430 enum ovs_userspace_attr {
431         OVS_USERSPACE_ATTR_UNSPEC,
432         OVS_USERSPACE_ATTR_PID,       /* u32 Netlink PID to receive upcalls. */
433         OVS_USERSPACE_ATTR_USERDATA,  /* u64 optional user-specified cookie. */
434         __OVS_USERSPACE_ATTR_MAX
435 };
436
437 #define OVS_USERSPACE_ATTR_MAX (__OVS_USERSPACE_ATTR_MAX - 1)
438
439 /**
440  * enum ovs_action_attr - Action types.
441  *
442  * @OVS_ACTION_ATTR_OUTPUT: Output packet to port.
443  * @OVS_ACTION_ATTR_USERSPACE: Send packet to userspace according to nested
444  * %OVS_USERSPACE_ATTR_* attributes.
445  * @OVS_ACTION_ATTR_PUSH: Push header onto head of packet.  The single nested
446  * %OVS_KEY_ATTR_* attribute specifies a header to push and its value, e.g.  a
447  * nested attribute of type %OVS_KEY_ATTR_8021Q, with struct ovs_key_8021q as
448  * argument, would push a VLAN header on the front of the packet.
449  * @OVS_ACTION_ATTR_POP: Pop header according to %OVS_KEY_ATTR_ sent as
450  * attribute data, e.g. %OVS_KEY_ATTR_8021Q as argument pops an outer VLAN
451  * header.
452  * @OVS_ACTION_ATTR_SET: Replaces the contents of an existing header.
453  * The argument takes the same form as %OVS_ACTION_ATTR_PUSH.
454  * @OVS_ACTION_ATTR_SAMPLE: Probabilitically executes actions, as specified in
455  * the nested %OVS_SAMPLE_ATTR_* attributes.
456  *
457  * Only a single field can be set with a single %OVS_ACTION_ATTR_{SET,PUSH}.
458  * Not all fields are modifiable.
459  */
460
461 enum ovs_action_attr {
462         OVS_ACTION_ATTR_UNSPEC,
463         OVS_ACTION_ATTR_OUTPUT,       /* u32 port number. */
464         OVS_ACTION_ATTR_USERSPACE,    /* Nested OVS_USERSPACE_ATTR_*. */
465         OVS_ACTION_ATTR_PUSH,         /* One nested OVS_KEY_ATTR_*. */
466         OVS_ACTION_ATTR_POP,          /* u16 OVS_KEY_ATTR_*. */
467         OVS_ACTION_ATTR_SET,          /* One nested OVS_KEY_ATTR_*. */
468         OVS_ACTION_ATTR_SAMPLE,       /* Nested OVS_SAMPLE_ATTR_*. */
469         __OVS_ACTION_ATTR_MAX
470 };
471
472 #define OVS_ACTION_ATTR_MAX (__OVS_ACTION_ATTR_MAX - 1)
473
474 #endif /* _LINUX_OPENVSWITCH_H */