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