cpp-d1064d
[cross.git] / i686-linux-gnu-4.7 / usr / include / linux / openvswitch.h
1 /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
2
3 /*
4  * Copyright (c) 2007-2017 Nicira, Inc.
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of version 2 of the GNU General Public
8  * License as published by the Free Software Foundation.
9  *
10  * This program is distributed in the hope that it will be useful, but
11  * WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13  * General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software
17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
18  * 02110-1301, USA
19  */
20
21 #ifndef __LINUX_OPENVSWITCH_H
22 #define __LINUX_OPENVSWITCH_H 1
23
24 #include <linux/types.h>
25 #include <linux/if_ether.h>
26
27 /**
28  * struct ovs_header - header for OVS Generic Netlink messages.
29  * @dp_ifindex: ifindex of local port for datapath (0 to make a request not
30  * specific to a datapath).
31  *
32  * Attributes following the header are specific to a particular OVS Generic
33  * Netlink family, but all of the OVS families use this header.
34  */
35
36 struct ovs_header {
37         int dp_ifindex;
38 };
39
40 /* Datapaths. */
41
42 #define OVS_DATAPATH_FAMILY  "ovs_datapath"
43 #define OVS_DATAPATH_MCGROUP "ovs_datapath"
44
45 /* V2:
46  *   - API users are expected to provide OVS_DP_ATTR_USER_FEATURES
47  *     when creating the datapath.
48  */
49 #define OVS_DATAPATH_VERSION 2
50
51 /* First OVS datapath version to support features */
52 #define OVS_DP_VER_FEATURES 2
53
54 enum ovs_datapath_cmd {
55         OVS_DP_CMD_UNSPEC,
56         OVS_DP_CMD_NEW,
57         OVS_DP_CMD_DEL,
58         OVS_DP_CMD_GET,
59         OVS_DP_CMD_SET
60 };
61
62 /**
63  * enum ovs_datapath_attr - attributes for %OVS_DP_* commands.
64  * @OVS_DP_ATTR_NAME: Name of the network device that serves as the "local
65  * port".  This is the name of the network device whose dp_ifindex is given in
66  * the &struct ovs_header.  Always present in notifications.  Required in
67  * %OVS_DP_NEW requests.  May be used as an alternative to specifying
68  * dp_ifindex in other requests (with a dp_ifindex of 0).
69  * @OVS_DP_ATTR_UPCALL_PID: The Netlink socket in userspace that is initially
70  * set on the datapath port (for OVS_ACTION_ATTR_MISS).  Only valid on
71  * %OVS_DP_CMD_NEW requests. A value of zero indicates that upcalls should
72  * not be sent.
73  * @OVS_DP_ATTR_STATS: Statistics about packets that have passed through the
74  * datapath.  Always present in notifications.
75  * @OVS_DP_ATTR_MEGAFLOW_STATS: Statistics about mega flow masks usage for the
76  * datapath. Always present in notifications.
77  *
78  * These attributes follow the &struct ovs_header within the Generic Netlink
79  * payload for %OVS_DP_* commands.
80  */
81 enum ovs_datapath_attr {
82         OVS_DP_ATTR_UNSPEC,
83         OVS_DP_ATTR_NAME,               /* name of dp_ifindex netdev */
84         OVS_DP_ATTR_UPCALL_PID,         /* Netlink PID to receive upcalls */
85         OVS_DP_ATTR_STATS,              /* struct ovs_dp_stats */
86         OVS_DP_ATTR_MEGAFLOW_STATS,     /* struct ovs_dp_megaflow_stats */
87         OVS_DP_ATTR_USER_FEATURES,      /* OVS_DP_F_*  */
88         OVS_DP_ATTR_PAD,
89         __OVS_DP_ATTR_MAX
90 };
91
92 #define OVS_DP_ATTR_MAX (__OVS_DP_ATTR_MAX - 1)
93
94 struct ovs_dp_stats {
95         __u64 n_hit;             /* Number of flow table matches. */
96         __u64 n_missed;          /* Number of flow table misses. */
97         __u64 n_lost;            /* Number of misses not sent to userspace. */
98         __u64 n_flows;           /* Number of flows present */
99 };
100
101 struct ovs_dp_megaflow_stats {
102         __u64 n_mask_hit;        /* Number of masks used for flow lookups. */
103         __u32 n_masks;           /* Number of masks for the datapath. */
104         __u32 pad0;              /* Pad for future expension. */
105         __u64 pad1;              /* Pad for future expension. */
106         __u64 pad2;              /* Pad for future expension. */
107 };
108
109 struct ovs_vport_stats {
110         __u64   rx_packets;             /* total packets received       */
111         __u64   tx_packets;             /* total packets transmitted    */
112         __u64   rx_bytes;               /* total bytes received         */
113         __u64   tx_bytes;               /* total bytes transmitted      */
114         __u64   rx_errors;              /* bad packets received         */
115         __u64   tx_errors;              /* packet transmit problems     */
116         __u64   rx_dropped;             /* no space in linux buffers    */
117         __u64   tx_dropped;             /* no space available in linux  */
118 };
119
120 /* Allow last Netlink attribute to be unaligned */
121 #define OVS_DP_F_UNALIGNED      (1 << 0)
122
123 /* Allow datapath to associate multiple Netlink PIDs to each vport */
124 #define OVS_DP_F_VPORT_PIDS     (1 << 1)
125
126 /* Fixed logical ports. */
127 #define OVSP_LOCAL      ((__u32)0)
128
129 /* Packet transfer. */
130
131 #define OVS_PACKET_FAMILY "ovs_packet"
132 #define OVS_PACKET_VERSION 0x1
133
134 enum ovs_packet_cmd {
135         OVS_PACKET_CMD_UNSPEC,
136
137         /* Kernel-to-user notifications. */
138         OVS_PACKET_CMD_MISS,    /* Flow table miss. */
139         OVS_PACKET_CMD_ACTION,  /* OVS_ACTION_ATTR_USERSPACE action. */
140
141         /* Userspace commands. */
142         OVS_PACKET_CMD_EXECUTE  /* Apply actions to a packet. */
143 };
144
145 /**
146  * enum ovs_packet_attr - attributes for %OVS_PACKET_* commands.
147  * @OVS_PACKET_ATTR_PACKET: Present for all notifications.  Contains the entire
148  * packet as received, from the start of the Ethernet header onward.  For
149  * %OVS_PACKET_CMD_ACTION, %OVS_PACKET_ATTR_PACKET reflects changes made by
150  * actions preceding %OVS_ACTION_ATTR_USERSPACE, but %OVS_PACKET_ATTR_KEY is
151  * the flow key extracted from the packet as originally received.
152  * @OVS_PACKET_ATTR_KEY: Present for all notifications.  Contains the flow key
153  * extracted from the packet as nested %OVS_KEY_ATTR_* attributes.  This allows
154  * userspace to adapt its flow setup strategy by comparing its notion of the
155  * flow key against the kernel's.
156  * @OVS_PACKET_ATTR_ACTIONS: Contains actions for the packet.  Used
157  * for %OVS_PACKET_CMD_EXECUTE.  It has nested %OVS_ACTION_ATTR_* attributes.
158  * Also used in upcall when %OVS_ACTION_ATTR_USERSPACE has optional
159  * %OVS_USERSPACE_ATTR_ACTIONS attribute.
160  * @OVS_PACKET_ATTR_USERDATA: Present for an %OVS_PACKET_CMD_ACTION
161  * notification if the %OVS_ACTION_ATTR_USERSPACE action specified an
162  * %OVS_USERSPACE_ATTR_USERDATA attribute, with the same length and content
163  * specified there.
164  * @OVS_PACKET_ATTR_EGRESS_TUN_KEY: Present for an %OVS_PACKET_CMD_ACTION
165  * notification if the %OVS_ACTION_ATTR_USERSPACE action specified an
166  * %OVS_USERSPACE_ATTR_EGRESS_TUN_PORT attribute, which is sent only if the
167  * output port is actually a tunnel port. Contains the output tunnel key
168  * extracted from the packet as nested %OVS_TUNNEL_KEY_ATTR_* attributes.
169  * @OVS_PACKET_ATTR_MRU: Present for an %OVS_PACKET_CMD_ACTION and
170  * @OVS_PACKET_ATTR_LEN: Packet size before truncation.
171  * %OVS_PACKET_ATTR_USERSPACE action specify the Maximum received fragment
172  * size.
173  *
174  * These attributes follow the &struct ovs_header within the Generic Netlink
175  * payload for %OVS_PACKET_* commands.
176  */
177 enum ovs_packet_attr {
178         OVS_PACKET_ATTR_UNSPEC,
179         OVS_PACKET_ATTR_PACKET,      /* Packet data. */
180         OVS_PACKET_ATTR_KEY,         /* Nested OVS_KEY_ATTR_* attributes. */
181         OVS_PACKET_ATTR_ACTIONS,     /* Nested OVS_ACTION_ATTR_* attributes. */
182         OVS_PACKET_ATTR_USERDATA,    /* OVS_ACTION_ATTR_USERSPACE arg. */
183         OVS_PACKET_ATTR_EGRESS_TUN_KEY,  /* Nested OVS_TUNNEL_KEY_ATTR_*
184                                             attributes. */
185         OVS_PACKET_ATTR_UNUSED1,
186         OVS_PACKET_ATTR_UNUSED2,
187         OVS_PACKET_ATTR_PROBE,      /* Packet operation is a feature probe,
188                                        error logging should be suppressed. */
189         OVS_PACKET_ATTR_MRU,        /* Maximum received IP fragment size. */
190         OVS_PACKET_ATTR_LEN,            /* Packet size before truncation. */
191         __OVS_PACKET_ATTR_MAX
192 };
193
194 #define OVS_PACKET_ATTR_MAX (__OVS_PACKET_ATTR_MAX - 1)
195
196 /* Virtual ports. */
197
198 #define OVS_VPORT_FAMILY  "ovs_vport"
199 #define OVS_VPORT_MCGROUP "ovs_vport"
200 #define OVS_VPORT_VERSION 0x1
201
202 enum ovs_vport_cmd {
203         OVS_VPORT_CMD_UNSPEC,
204         OVS_VPORT_CMD_NEW,
205         OVS_VPORT_CMD_DEL,
206         OVS_VPORT_CMD_GET,
207         OVS_VPORT_CMD_SET
208 };
209
210 enum ovs_vport_type {
211         OVS_VPORT_TYPE_UNSPEC,
212         OVS_VPORT_TYPE_NETDEV,   /* network device */
213         OVS_VPORT_TYPE_INTERNAL, /* network device implemented by datapath */
214         OVS_VPORT_TYPE_GRE,      /* GRE tunnel. */
215         OVS_VPORT_TYPE_VXLAN,    /* VXLAN tunnel. */
216         OVS_VPORT_TYPE_GENEVE,   /* Geneve tunnel. */
217         __OVS_VPORT_TYPE_MAX
218 };
219
220 #define OVS_VPORT_TYPE_MAX (__OVS_VPORT_TYPE_MAX - 1)
221
222 /**
223  * enum ovs_vport_attr - attributes for %OVS_VPORT_* commands.
224  * @OVS_VPORT_ATTR_PORT_NO: 32-bit port number within datapath.
225  * @OVS_VPORT_ATTR_TYPE: 32-bit %OVS_VPORT_TYPE_* constant describing the type
226  * of vport.
227  * @OVS_VPORT_ATTR_NAME: Name of vport.  For a vport based on a network device
228  * this is the name of the network device.  Maximum length %IFNAMSIZ-1 bytes
229  * plus a null terminator.
230  * @OVS_VPORT_ATTR_OPTIONS: Vport-specific configuration information.
231  * @OVS_VPORT_ATTR_UPCALL_PID: The array of Netlink socket pids in userspace
232  * among which OVS_PACKET_CMD_MISS upcalls will be distributed for packets
233  * received on this port.  If this is a single-element array of value 0,
234  * upcalls should not be sent.
235  * @OVS_VPORT_ATTR_STATS: A &struct ovs_vport_stats giving statistics for
236  * packets sent or received through the vport.
237  *
238  * These attributes follow the &struct ovs_header within the Generic Netlink
239  * payload for %OVS_VPORT_* commands.
240  *
241  * For %OVS_VPORT_CMD_NEW requests, the %OVS_VPORT_ATTR_TYPE and
242  * %OVS_VPORT_ATTR_NAME attributes are required.  %OVS_VPORT_ATTR_PORT_NO is
243  * optional; if not specified a free port number is automatically selected.
244  * Whether %OVS_VPORT_ATTR_OPTIONS is required or optional depends on the type
245  * of vport.
246  *
247  * For other requests, if %OVS_VPORT_ATTR_NAME is specified then it is used to
248  * look up the vport to operate on; otherwise dp_idx from the &struct
249  * ovs_header plus %OVS_VPORT_ATTR_PORT_NO determine the vport.
250  */
251 enum ovs_vport_attr {
252         OVS_VPORT_ATTR_UNSPEC,
253         OVS_VPORT_ATTR_PORT_NO, /* u32 port number within datapath */
254         OVS_VPORT_ATTR_TYPE,    /* u32 OVS_VPORT_TYPE_* constant. */
255         OVS_VPORT_ATTR_NAME,    /* string name, up to IFNAMSIZ bytes long */
256         OVS_VPORT_ATTR_OPTIONS, /* nested attributes, varies by vport type */
257         OVS_VPORT_ATTR_UPCALL_PID, /* array of u32 Netlink socket PIDs for */
258                                 /* receiving upcalls */
259         OVS_VPORT_ATTR_STATS,   /* struct ovs_vport_stats */
260         OVS_VPORT_ATTR_PAD,
261         OVS_VPORT_ATTR_IFINDEX,
262         OVS_VPORT_ATTR_NETNSID,
263         __OVS_VPORT_ATTR_MAX
264 };
265
266 #define OVS_VPORT_ATTR_MAX (__OVS_VPORT_ATTR_MAX - 1)
267
268 enum {
269         OVS_VXLAN_EXT_UNSPEC,
270         OVS_VXLAN_EXT_GBP,      /* Flag or __u32 */
271         __OVS_VXLAN_EXT_MAX,
272 };
273
274 #define OVS_VXLAN_EXT_MAX (__OVS_VXLAN_EXT_MAX - 1)
275
276
277 /* OVS_VPORT_ATTR_OPTIONS attributes for tunnels.
278  */
279 enum {
280         OVS_TUNNEL_ATTR_UNSPEC,
281         OVS_TUNNEL_ATTR_DST_PORT, /* 16-bit UDP port, used by L4 tunnels. */
282         OVS_TUNNEL_ATTR_EXTENSION,
283         __OVS_TUNNEL_ATTR_MAX
284 };
285
286 #define OVS_TUNNEL_ATTR_MAX (__OVS_TUNNEL_ATTR_MAX - 1)
287
288 /* Flows. */
289
290 #define OVS_FLOW_FAMILY  "ovs_flow"
291 #define OVS_FLOW_MCGROUP "ovs_flow"
292 #define OVS_FLOW_VERSION 0x1
293
294 enum ovs_flow_cmd {
295         OVS_FLOW_CMD_UNSPEC,
296         OVS_FLOW_CMD_NEW,
297         OVS_FLOW_CMD_DEL,
298         OVS_FLOW_CMD_GET,
299         OVS_FLOW_CMD_SET
300 };
301
302 struct ovs_flow_stats {
303         __u64 n_packets;         /* Number of matched packets. */
304         __u64 n_bytes;           /* Number of matched bytes. */
305 };
306
307 enum ovs_key_attr {
308         OVS_KEY_ATTR_UNSPEC,
309         OVS_KEY_ATTR_ENCAP,     /* Nested set of encapsulated attributes. */
310         OVS_KEY_ATTR_PRIORITY,  /* u32 skb->priority */
311         OVS_KEY_ATTR_IN_PORT,   /* u32 OVS dp port number */
312         OVS_KEY_ATTR_ETHERNET,  /* struct ovs_key_ethernet */
313         OVS_KEY_ATTR_VLAN,      /* be16 VLAN TCI */
314         OVS_KEY_ATTR_ETHERTYPE, /* be16 Ethernet type */
315         OVS_KEY_ATTR_IPV4,      /* struct ovs_key_ipv4 */
316         OVS_KEY_ATTR_IPV6,      /* struct ovs_key_ipv6 */
317         OVS_KEY_ATTR_TCP,       /* struct ovs_key_tcp */
318         OVS_KEY_ATTR_UDP,       /* struct ovs_key_udp */
319         OVS_KEY_ATTR_ICMP,      /* struct ovs_key_icmp */
320         OVS_KEY_ATTR_ICMPV6,    /* struct ovs_key_icmpv6 */
321         OVS_KEY_ATTR_ARP,       /* struct ovs_key_arp */
322         OVS_KEY_ATTR_ND,        /* struct ovs_key_nd */
323         OVS_KEY_ATTR_SKB_MARK,  /* u32 skb mark */
324         OVS_KEY_ATTR_TUNNEL,    /* Nested set of ovs_tunnel attributes */
325         OVS_KEY_ATTR_SCTP,      /* struct ovs_key_sctp */
326         OVS_KEY_ATTR_TCP_FLAGS, /* be16 TCP flags. */
327         OVS_KEY_ATTR_DP_HASH,      /* u32 hash value. Value 0 indicates the hash
328                                    is not computed by the datapath. */
329         OVS_KEY_ATTR_RECIRC_ID, /* u32 recirc id */
330         OVS_KEY_ATTR_MPLS,      /* array of struct ovs_key_mpls.
331                                  * The implementation may restrict
332                                  * the accepted length of the array. */
333         OVS_KEY_ATTR_CT_STATE,  /* u32 bitmask of OVS_CS_F_* */
334         OVS_KEY_ATTR_CT_ZONE,   /* u16 connection tracking zone. */
335         OVS_KEY_ATTR_CT_MARK,   /* u32 connection tracking mark */
336         OVS_KEY_ATTR_CT_LABELS, /* 16-octet connection tracking label */
337         OVS_KEY_ATTR_CT_ORIG_TUPLE_IPV4,   /* struct ovs_key_ct_tuple_ipv4 */
338         OVS_KEY_ATTR_CT_ORIG_TUPLE_IPV6,   /* struct ovs_key_ct_tuple_ipv6 */
339         OVS_KEY_ATTR_NSH,       /* Nested set of ovs_nsh_key_* */
340
341         __OVS_KEY_ATTR_MAX
342 };
343
344 #define OVS_KEY_ATTR_MAX (__OVS_KEY_ATTR_MAX - 1)
345
346 enum ovs_tunnel_key_attr {
347         /* OVS_TUNNEL_KEY_ATTR_NONE, standard nl API requires this attribute! */
348         OVS_TUNNEL_KEY_ATTR_ID,                 /* be64 Tunnel ID */
349         OVS_TUNNEL_KEY_ATTR_IPV4_SRC,           /* be32 src IP address. */
350         OVS_TUNNEL_KEY_ATTR_IPV4_DST,           /* be32 dst IP address. */
351         OVS_TUNNEL_KEY_ATTR_TOS,                /* u8 Tunnel IP ToS. */
352         OVS_TUNNEL_KEY_ATTR_TTL,                /* u8 Tunnel IP TTL. */
353         OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT,      /* No argument, set DF. */
354         OVS_TUNNEL_KEY_ATTR_CSUM,               /* No argument. CSUM packet. */
355         OVS_TUNNEL_KEY_ATTR_OAM,                /* No argument. OAM frame.  */
356         OVS_TUNNEL_KEY_ATTR_GENEVE_OPTS,        /* Array of Geneve options. */
357         OVS_TUNNEL_KEY_ATTR_TP_SRC,             /* be16 src Transport Port. */
358         OVS_TUNNEL_KEY_ATTR_TP_DST,             /* be16 dst Transport Port. */
359         OVS_TUNNEL_KEY_ATTR_VXLAN_OPTS,         /* Nested OVS_VXLAN_EXT_* */
360         OVS_TUNNEL_KEY_ATTR_IPV6_SRC,           /* struct in6_addr src IPv6 address. */
361         OVS_TUNNEL_KEY_ATTR_IPV6_DST,           /* struct in6_addr dst IPv6 address. */
362         OVS_TUNNEL_KEY_ATTR_PAD,
363         OVS_TUNNEL_KEY_ATTR_ERSPAN_OPTS,        /* struct erspan_metadata */
364         __OVS_TUNNEL_KEY_ATTR_MAX
365 };
366
367 #define OVS_TUNNEL_KEY_ATTR_MAX (__OVS_TUNNEL_KEY_ATTR_MAX - 1)
368
369 /**
370  * enum ovs_frag_type - IPv4 and IPv6 fragment type
371  * @OVS_FRAG_TYPE_NONE: Packet is not a fragment.
372  * @OVS_FRAG_TYPE_FIRST: Packet is a fragment with offset 0.
373  * @OVS_FRAG_TYPE_LATER: Packet is a fragment with nonzero offset.
374  *
375  * Used as the @ipv4_frag in &struct ovs_key_ipv4 and as @ipv6_frag &struct
376  * ovs_key_ipv6.
377  */
378 enum ovs_frag_type {
379         OVS_FRAG_TYPE_NONE,
380         OVS_FRAG_TYPE_FIRST,
381         OVS_FRAG_TYPE_LATER,
382         __OVS_FRAG_TYPE_MAX
383 };
384
385 #define OVS_FRAG_TYPE_MAX (__OVS_FRAG_TYPE_MAX - 1)
386
387 struct ovs_key_ethernet {
388         __u8     eth_src[ETH_ALEN];
389         __u8     eth_dst[ETH_ALEN];
390 };
391
392 struct ovs_key_mpls {
393         __be32 mpls_lse;
394 };
395
396 struct ovs_key_ipv4 {
397         __be32 ipv4_src;
398         __be32 ipv4_dst;
399         __u8   ipv4_proto;
400         __u8   ipv4_tos;
401         __u8   ipv4_ttl;
402         __u8   ipv4_frag;       /* One of OVS_FRAG_TYPE_*. */
403 };
404
405 struct ovs_key_ipv6 {
406         __be32 ipv6_src[4];
407         __be32 ipv6_dst[4];
408         __be32 ipv6_label;      /* 20-bits in least-significant bits. */
409         __u8   ipv6_proto;
410         __u8   ipv6_tclass;
411         __u8   ipv6_hlimit;
412         __u8   ipv6_frag;       /* One of OVS_FRAG_TYPE_*. */
413 };
414
415 struct ovs_key_tcp {
416         __be16 tcp_src;
417         __be16 tcp_dst;
418 };
419
420 struct ovs_key_udp {
421         __be16 udp_src;
422         __be16 udp_dst;
423 };
424
425 struct ovs_key_sctp {
426         __be16 sctp_src;
427         __be16 sctp_dst;
428 };
429
430 struct ovs_key_icmp {
431         __u8 icmp_type;
432         __u8 icmp_code;
433 };
434
435 struct ovs_key_icmpv6 {
436         __u8 icmpv6_type;
437         __u8 icmpv6_code;
438 };
439
440 struct ovs_key_arp {
441         __be32 arp_sip;
442         __be32 arp_tip;
443         __be16 arp_op;
444         __u8   arp_sha[ETH_ALEN];
445         __u8   arp_tha[ETH_ALEN];
446 };
447
448 struct ovs_key_nd {
449         __be32  nd_target[4];
450         __u8    nd_sll[ETH_ALEN];
451         __u8    nd_tll[ETH_ALEN];
452 };
453
454 #define OVS_CT_LABELS_LEN_32    4
455 #define OVS_CT_LABELS_LEN       (OVS_CT_LABELS_LEN_32 * sizeof(__u32))
456 struct ovs_key_ct_labels {
457         union {
458                 __u8    ct_labels[OVS_CT_LABELS_LEN];
459                 __u32   ct_labels_32[OVS_CT_LABELS_LEN_32];
460         };
461 };
462
463 /* OVS_KEY_ATTR_CT_STATE flags */
464 #define OVS_CS_F_NEW               0x01 /* Beginning of a new connection. */
465 #define OVS_CS_F_ESTABLISHED       0x02 /* Part of an existing connection. */
466 #define OVS_CS_F_RELATED           0x04 /* Related to an established
467                                          * connection. */
468 #define OVS_CS_F_REPLY_DIR         0x08 /* Flow is in the reply direction. */
469 #define OVS_CS_F_INVALID           0x10 /* Could not track connection. */
470 #define OVS_CS_F_TRACKED           0x20 /* Conntrack has occurred. */
471 #define OVS_CS_F_SRC_NAT           0x40 /* Packet's source address/port was
472                                          * mangled by NAT.
473                                          */
474 #define OVS_CS_F_DST_NAT           0x80 /* Packet's destination address/port
475                                          * was mangled by NAT.
476                                          */
477
478 #define OVS_CS_F_NAT_MASK (OVS_CS_F_SRC_NAT | OVS_CS_F_DST_NAT)
479
480 struct ovs_key_ct_tuple_ipv4 {
481         __be32 ipv4_src;
482         __be32 ipv4_dst;
483         __be16 src_port;
484         __be16 dst_port;
485         __u8   ipv4_proto;
486 };
487
488 struct ovs_key_ct_tuple_ipv6 {
489         __be32 ipv6_src[4];
490         __be32 ipv6_dst[4];
491         __be16 src_port;
492         __be16 dst_port;
493         __u8   ipv6_proto;
494 };
495
496 enum ovs_nsh_key_attr {
497         OVS_NSH_KEY_ATTR_UNSPEC,
498         OVS_NSH_KEY_ATTR_BASE,  /* struct ovs_nsh_key_base. */
499         OVS_NSH_KEY_ATTR_MD1,   /* struct ovs_nsh_key_md1. */
500         OVS_NSH_KEY_ATTR_MD2,   /* variable-length octets for MD type 2. */
501         __OVS_NSH_KEY_ATTR_MAX
502 };
503
504 #define OVS_NSH_KEY_ATTR_MAX (__OVS_NSH_KEY_ATTR_MAX - 1)
505
506 struct ovs_nsh_key_base {
507         __u8 flags;
508         __u8 ttl;
509         __u8 mdtype;
510         __u8 np;
511         __be32 path_hdr;
512 };
513
514 #define NSH_MD1_CONTEXT_SIZE 4
515
516 struct ovs_nsh_key_md1 {
517         __be32 context[NSH_MD1_CONTEXT_SIZE];
518 };
519
520 /**
521  * enum ovs_flow_attr - attributes for %OVS_FLOW_* commands.
522  * @OVS_FLOW_ATTR_KEY: Nested %OVS_KEY_ATTR_* attributes specifying the flow
523  * key.  Always present in notifications.  Required for all requests (except
524  * dumps).
525  * @OVS_FLOW_ATTR_ACTIONS: Nested %OVS_ACTION_ATTR_* attributes specifying
526  * the actions to take for packets that match the key.  Always present in
527  * notifications.  Required for %OVS_FLOW_CMD_NEW requests, optional for
528  * %OVS_FLOW_CMD_SET requests.  An %OVS_FLOW_CMD_SET without
529  * %OVS_FLOW_ATTR_ACTIONS will not modify the actions.  To clear the actions,
530  * an %OVS_FLOW_ATTR_ACTIONS without any nested attributes must be given.
531  * @OVS_FLOW_ATTR_STATS: &struct ovs_flow_stats giving statistics for this
532  * flow.  Present in notifications if the stats would be nonzero.  Ignored in
533  * requests.
534  * @OVS_FLOW_ATTR_TCP_FLAGS: An 8-bit value giving the OR'd value of all of the
535  * TCP flags seen on packets in this flow.  Only present in notifications for
536  * TCP flows, and only if it would be nonzero.  Ignored in requests.
537  * @OVS_FLOW_ATTR_USED: A 64-bit integer giving the time, in milliseconds on
538  * the system monotonic clock, at which a packet was last processed for this
539  * flow.  Only present in notifications if a packet has been processed for this
540  * flow.  Ignored in requests.
541  * @OVS_FLOW_ATTR_CLEAR: If present in a %OVS_FLOW_CMD_SET request, clears the
542  * last-used time, accumulated TCP flags, and statistics for this flow.
543  * Otherwise ignored in requests.  Never present in notifications.
544  * @OVS_FLOW_ATTR_MASK: Nested %OVS_KEY_ATTR_* attributes specifying the
545  * mask bits for wildcarded flow match. Mask bit value '1' specifies exact
546  * match with corresponding flow key bit, while mask bit value '0' specifies
547  * a wildcarded match. Omitting attribute is treated as wildcarding all
548  * corresponding fields. Optional for all requests. If not present,
549  * all flow key bits are exact match bits.
550  * @OVS_FLOW_ATTR_UFID: A value between 1-16 octets specifying a unique
551  * identifier for the flow. Causes the flow to be indexed by this value rather
552  * than the value of the %OVS_FLOW_ATTR_KEY attribute. Optional for all
553  * requests. Present in notifications if the flow was created with this
554  * attribute.
555  * @OVS_FLOW_ATTR_UFID_FLAGS: A 32-bit value of OR'd %OVS_UFID_F_*
556  * flags that provide alternative semantics for flow installation and
557  * retrieval. Optional for all requests.
558  *
559  * These attributes follow the &struct ovs_header within the Generic Netlink
560  * payload for %OVS_FLOW_* commands.
561  */
562 enum ovs_flow_attr {
563         OVS_FLOW_ATTR_UNSPEC,
564         OVS_FLOW_ATTR_KEY,       /* Sequence of OVS_KEY_ATTR_* attributes. */
565         OVS_FLOW_ATTR_ACTIONS,   /* Nested OVS_ACTION_ATTR_* attributes. */
566         OVS_FLOW_ATTR_STATS,     /* struct ovs_flow_stats. */
567         OVS_FLOW_ATTR_TCP_FLAGS, /* 8-bit OR'd TCP flags. */
568         OVS_FLOW_ATTR_USED,      /* u64 msecs last used in monotonic time. */
569         OVS_FLOW_ATTR_CLEAR,     /* Flag to clear stats, tcp_flags, used. */
570         OVS_FLOW_ATTR_MASK,      /* Sequence of OVS_KEY_ATTR_* attributes. */
571         OVS_FLOW_ATTR_PROBE,     /* Flow operation is a feature probe, error
572                                   * logging should be suppressed. */
573         OVS_FLOW_ATTR_UFID,      /* Variable length unique flow identifier. */
574         OVS_FLOW_ATTR_UFID_FLAGS,/* u32 of OVS_UFID_F_*. */
575         OVS_FLOW_ATTR_PAD,
576         __OVS_FLOW_ATTR_MAX
577 };
578
579 #define OVS_FLOW_ATTR_MAX (__OVS_FLOW_ATTR_MAX - 1)
580
581 /**
582  * Omit attributes for notifications.
583  *
584  * If a datapath request contains an %OVS_UFID_F_OMIT_* flag, then the datapath
585  * may omit the corresponding %OVS_FLOW_ATTR_* from the response.
586  */
587 #define OVS_UFID_F_OMIT_KEY      (1 << 0)
588 #define OVS_UFID_F_OMIT_MASK     (1 << 1)
589 #define OVS_UFID_F_OMIT_ACTIONS  (1 << 2)
590
591 /**
592  * enum ovs_sample_attr - Attributes for %OVS_ACTION_ATTR_SAMPLE action.
593  * @OVS_SAMPLE_ATTR_PROBABILITY: 32-bit fraction of packets to sample with
594  * @OVS_ACTION_ATTR_SAMPLE.  A value of 0 samples no packets, a value of
595  * %UINT32_MAX samples all packets and intermediate values sample intermediate
596  * fractions of packets.
597  * @OVS_SAMPLE_ATTR_ACTIONS: Set of actions to execute in sampling event.
598  * Actions are passed as nested attributes.
599  *
600  * Executes the specified actions with the given probability on a per-packet
601  * basis.
602  */
603 enum ovs_sample_attr {
604         OVS_SAMPLE_ATTR_UNSPEC,
605         OVS_SAMPLE_ATTR_PROBABILITY, /* u32 number */
606         OVS_SAMPLE_ATTR_ACTIONS,     /* Nested OVS_ACTION_ATTR_* attributes. */
607         __OVS_SAMPLE_ATTR_MAX,
608
609 };
610
611 #define OVS_SAMPLE_ATTR_MAX (__OVS_SAMPLE_ATTR_MAX - 1)
612
613
614 /**
615  * enum ovs_userspace_attr - Attributes for %OVS_ACTION_ATTR_USERSPACE action.
616  * @OVS_USERSPACE_ATTR_PID: u32 Netlink PID to which the %OVS_PACKET_CMD_ACTION
617  * message should be sent.  Required.
618  * @OVS_USERSPACE_ATTR_USERDATA: If present, its variable-length argument is
619  * copied to the %OVS_PACKET_CMD_ACTION message as %OVS_PACKET_ATTR_USERDATA.
620  * @OVS_USERSPACE_ATTR_EGRESS_TUN_PORT: If present, u32 output port to get
621  * tunnel info.
622  * @OVS_USERSPACE_ATTR_ACTIONS: If present, send actions with upcall.
623  */
624 enum ovs_userspace_attr {
625         OVS_USERSPACE_ATTR_UNSPEC,
626         OVS_USERSPACE_ATTR_PID,       /* u32 Netlink PID to receive upcalls. */
627         OVS_USERSPACE_ATTR_USERDATA,  /* Optional user-specified cookie. */
628         OVS_USERSPACE_ATTR_EGRESS_TUN_PORT,  /* Optional, u32 output port
629                                               * to get tunnel info. */
630         OVS_USERSPACE_ATTR_ACTIONS,   /* Optional flag to get actions. */
631         __OVS_USERSPACE_ATTR_MAX
632 };
633
634 #define OVS_USERSPACE_ATTR_MAX (__OVS_USERSPACE_ATTR_MAX - 1)
635
636 struct ovs_action_trunc {
637         __u32 max_len; /* Max packet size in bytes. */
638 };
639
640 /**
641  * struct ovs_action_push_mpls - %OVS_ACTION_ATTR_PUSH_MPLS action argument.
642  * @mpls_lse: MPLS label stack entry to push.
643  * @mpls_ethertype: Ethertype to set in the encapsulating ethernet frame.
644  *
645  * The only values @mpls_ethertype should ever be given are %ETH_P_MPLS_UC and
646  * %ETH_P_MPLS_MC, indicating MPLS unicast or multicast. Other are rejected.
647  */
648 struct ovs_action_push_mpls {
649         __be32 mpls_lse;
650         __be16 mpls_ethertype; /* Either %ETH_P_MPLS_UC or %ETH_P_MPLS_MC */
651 };
652
653 /**
654  * struct ovs_action_push_vlan - %OVS_ACTION_ATTR_PUSH_VLAN action argument.
655  * @vlan_tpid: Tag protocol identifier (TPID) to push.
656  * @vlan_tci: Tag control identifier (TCI) to push.  The CFI bit must be set
657  * (but it will not be set in the 802.1Q header that is pushed).
658  *
659  * The @vlan_tpid value is typically %ETH_P_8021Q or %ETH_P_8021AD.
660  * The only acceptable TPID values are those that the kernel module also parses
661  * as 802.1Q or 802.1AD headers, to prevent %OVS_ACTION_ATTR_PUSH_VLAN followed
662  * by %OVS_ACTION_ATTR_POP_VLAN from having surprising results.
663  */
664 struct ovs_action_push_vlan {
665         __be16 vlan_tpid;       /* 802.1Q or 802.1ad TPID. */
666         __be16 vlan_tci;        /* 802.1Q TCI (VLAN ID and priority). */
667 };
668
669 /* Data path hash algorithm for computing Datapath hash.
670  *
671  * The algorithm type only specifies the fields in a flow
672  * will be used as part of the hash. Each datapath is free
673  * to use its own hash algorithm. The hash value will be
674  * opaque to the user space daemon.
675  */
676 enum ovs_hash_alg {
677         OVS_HASH_ALG_L4,
678 };
679
680 /*
681  * struct ovs_action_hash - %OVS_ACTION_ATTR_HASH action argument.
682  * @hash_alg: Algorithm used to compute hash prior to recirculation.
683  * @hash_basis: basis used for computing hash.
684  */
685 struct ovs_action_hash {
686         __u32  hash_alg;     /* One of ovs_hash_alg. */
687         __u32  hash_basis;
688 };
689
690 /**
691  * enum ovs_ct_attr - Attributes for %OVS_ACTION_ATTR_CT action.
692  * @OVS_CT_ATTR_COMMIT: If present, commits the connection to the conntrack
693  * table. This allows future packets for the same connection to be identified
694  * as 'established' or 'related'. The flow key for the current packet will
695  * retain the pre-commit connection state.
696  * @OVS_CT_ATTR_ZONE: u16 connection tracking zone.
697  * @OVS_CT_ATTR_MARK: u32 value followed by u32 mask. For each bit set in the
698  * mask, the corresponding bit in the value is copied to the connection
699  * tracking mark field in the connection.
700  * @OVS_CT_ATTR_LABELS: %OVS_CT_LABELS_LEN value followed by %OVS_CT_LABELS_LEN
701  * mask. For each bit set in the mask, the corresponding bit in the value is
702  * copied to the connection tracking label field in the connection.
703  * @OVS_CT_ATTR_HELPER: variable length string defining conntrack ALG.
704  * @OVS_CT_ATTR_NAT: Nested OVS_NAT_ATTR_* for performing L3 network address
705  * translation (NAT) on the packet.
706  * @OVS_CT_ATTR_FORCE_COMMIT: Like %OVS_CT_ATTR_COMMIT, but instead of doing
707  * nothing if the connection is already committed will check that the current
708  * packet is in conntrack entry's original direction.  If directionality does
709  * not match, will delete the existing conntrack entry and commit a new one.
710  * @OVS_CT_ATTR_EVENTMASK: Mask of bits indicating which conntrack event types
711  * (enum ip_conntrack_events IPCT_*) should be reported.  For any bit set to
712  * zero, the corresponding event type is not generated.  Default behavior
713  * depends on system configuration, but typically all event types are
714  * generated, hence listening on NFNLGRP_CONNTRACK_UPDATE events may get a lot
715  * of events.  Explicitly passing this attribute allows limiting the updates
716  * received to the events of interest.  The bit 1 << IPCT_NEW, 1 <<
717  * IPCT_RELATED, and 1 << IPCT_DESTROY must be set to ones for those events to
718  * be received on NFNLGRP_CONNTRACK_NEW and NFNLGRP_CONNTRACK_DESTROY groups,
719  * respectively.  Remaining bits control the changes for which an event is
720  * delivered on the NFNLGRP_CONNTRACK_UPDATE group.
721  */
722 enum ovs_ct_attr {
723         OVS_CT_ATTR_UNSPEC,
724         OVS_CT_ATTR_COMMIT,     /* No argument, commits connection. */
725         OVS_CT_ATTR_ZONE,       /* u16 zone id. */
726         OVS_CT_ATTR_MARK,       /* mark to associate with this connection. */
727         OVS_CT_ATTR_LABELS,     /* labels to associate with this connection. */
728         OVS_CT_ATTR_HELPER,     /* netlink helper to assist detection of
729                                    related connections. */
730         OVS_CT_ATTR_NAT,        /* Nested OVS_NAT_ATTR_* */
731         OVS_CT_ATTR_FORCE_COMMIT,  /* No argument */
732         OVS_CT_ATTR_EVENTMASK,  /* u32 mask of IPCT_* events. */
733         __OVS_CT_ATTR_MAX
734 };
735
736 #define OVS_CT_ATTR_MAX (__OVS_CT_ATTR_MAX - 1)
737
738 /**
739  * enum ovs_nat_attr - Attributes for %OVS_CT_ATTR_NAT.
740  *
741  * @OVS_NAT_ATTR_SRC: Flag for Source NAT (mangle source address/port).
742  * @OVS_NAT_ATTR_DST: Flag for Destination NAT (mangle destination
743  * address/port).  Only one of (@OVS_NAT_ATTR_SRC, @OVS_NAT_ATTR_DST) may be
744  * specified.  Effective only for packets for ct_state NEW connections.
745  * Packets of committed connections are mangled by the NAT action according to
746  * the committed NAT type regardless of the flags specified.  As a corollary, a
747  * NAT action without a NAT type flag will only mangle packets of committed
748  * connections.  The following NAT attributes only apply for NEW
749  * (non-committed) connections, and they may be included only when the CT
750  * action has the @OVS_CT_ATTR_COMMIT flag and either @OVS_NAT_ATTR_SRC or
751  * @OVS_NAT_ATTR_DST is also included.
752  * @OVS_NAT_ATTR_IP_MIN: struct in_addr or struct in6_addr
753  * @OVS_NAT_ATTR_IP_MAX: struct in_addr or struct in6_addr
754  * @OVS_NAT_ATTR_PROTO_MIN: u16 L4 protocol specific lower boundary (port)
755  * @OVS_NAT_ATTR_PROTO_MAX: u16 L4 protocol specific upper boundary (port)
756  * @OVS_NAT_ATTR_PERSISTENT: Flag for persistent IP mapping across reboots
757  * @OVS_NAT_ATTR_PROTO_HASH: Flag for pseudo random L4 port mapping (MD5)
758  * @OVS_NAT_ATTR_PROTO_RANDOM: Flag for fully randomized L4 port mapping
759  */
760 enum ovs_nat_attr {
761         OVS_NAT_ATTR_UNSPEC,
762         OVS_NAT_ATTR_SRC,
763         OVS_NAT_ATTR_DST,
764         OVS_NAT_ATTR_IP_MIN,
765         OVS_NAT_ATTR_IP_MAX,
766         OVS_NAT_ATTR_PROTO_MIN,
767         OVS_NAT_ATTR_PROTO_MAX,
768         OVS_NAT_ATTR_PERSISTENT,
769         OVS_NAT_ATTR_PROTO_HASH,
770         OVS_NAT_ATTR_PROTO_RANDOM,
771         __OVS_NAT_ATTR_MAX,
772 };
773
774 #define OVS_NAT_ATTR_MAX (__OVS_NAT_ATTR_MAX - 1)
775
776 /*
777  * struct ovs_action_push_eth - %OVS_ACTION_ATTR_PUSH_ETH action argument.
778  * @addresses: Source and destination MAC addresses.
779  * @eth_type: Ethernet type
780  */
781 struct ovs_action_push_eth {
782         struct ovs_key_ethernet addresses;
783 };
784
785 /**
786  * enum ovs_action_attr - Action types.
787  *
788  * @OVS_ACTION_ATTR_OUTPUT: Output packet to port.
789  * @OVS_ACTION_ATTR_TRUNC: Output packet to port with truncated packet size.
790  * @OVS_ACTION_ATTR_USERSPACE: Send packet to userspace according to nested
791  * %OVS_USERSPACE_ATTR_* attributes.
792  * @OVS_ACTION_ATTR_SET: Replaces the contents of an existing header.  The
793  * single nested %OVS_KEY_ATTR_* attribute specifies a header to modify and its
794  * value.
795  * @OVS_ACTION_ATTR_SET_MASKED: Replaces the contents of an existing header.  A
796  * nested %OVS_KEY_ATTR_* attribute specifies a header to modify, its value,
797  * and a mask.  For every bit set in the mask, the corresponding bit value
798  * is copied from the value to the packet header field, rest of the bits are
799  * left unchanged.  The non-masked value bits must be passed in as zeroes.
800  * Masking is not supported for the %OVS_KEY_ATTR_TUNNEL attribute.
801  * @OVS_ACTION_ATTR_PUSH_VLAN: Push a new outermost 802.1Q or 802.1ad header
802  * onto the packet.
803  * @OVS_ACTION_ATTR_POP_VLAN: Pop the outermost 802.1Q or 802.1ad header
804  * from the packet.
805  * @OVS_ACTION_ATTR_SAMPLE: Probabilitically executes actions, as specified in
806  * the nested %OVS_SAMPLE_ATTR_* attributes.
807  * @OVS_ACTION_ATTR_PUSH_MPLS: Push a new MPLS label stack entry onto the
808  * top of the packets MPLS label stack.  Set the ethertype of the
809  * encapsulating frame to either %ETH_P_MPLS_UC or %ETH_P_MPLS_MC to
810  * indicate the new packet contents.
811  * @OVS_ACTION_ATTR_POP_MPLS: Pop an MPLS label stack entry off of the
812  * packet's MPLS label stack.  Set the encapsulating frame's ethertype to
813  * indicate the new packet contents. This could potentially still be
814  * %ETH_P_MPLS if the resulting MPLS label stack is not empty.  If there
815  * is no MPLS label stack, as determined by ethertype, no action is taken.
816  * @OVS_ACTION_ATTR_CT: Track the connection. Populate the conntrack-related
817  * entries in the flow key.
818  * @OVS_ACTION_ATTR_PUSH_ETH: Push a new outermost Ethernet header onto the
819  * packet.
820  * @OVS_ACTION_ATTR_POP_ETH: Pop the outermost Ethernet header off the
821  * packet.
822  * @OVS_ACTION_ATTR_CT_CLEAR: Clear conntrack state from the packet.
823  * @OVS_ACTION_ATTR_PUSH_NSH: push NSH header to the packet.
824  * @OVS_ACTION_ATTR_POP_NSH: pop the outermost NSH header off the packet.
825  * @OVS_ACTION_ATTR_METER: Run packet through a meter, which may drop the
826  * packet, or modify the packet (e.g., change the DSCP field).
827  * @OVS_ACTION_ATTR_CLONE: make a copy of the packet and execute a list of
828  * actions without affecting the original packet and key.
829  *
830  * Only a single header can be set with a single %OVS_ACTION_ATTR_SET.  Not all
831  * fields within a header are modifiable, e.g. the IPv4 protocol and fragment
832  * type may not be changed.
833  *
834  * @OVS_ACTION_ATTR_SET_TO_MASKED: Kernel internal masked set action translated
835  * from the @OVS_ACTION_ATTR_SET.
836  */
837
838 enum ovs_action_attr {
839         OVS_ACTION_ATTR_UNSPEC,
840         OVS_ACTION_ATTR_OUTPUT,       /* u32 port number. */
841         OVS_ACTION_ATTR_USERSPACE,    /* Nested OVS_USERSPACE_ATTR_*. */
842         OVS_ACTION_ATTR_SET,          /* One nested OVS_KEY_ATTR_*. */
843         OVS_ACTION_ATTR_PUSH_VLAN,    /* struct ovs_action_push_vlan. */
844         OVS_ACTION_ATTR_POP_VLAN,     /* No argument. */
845         OVS_ACTION_ATTR_SAMPLE,       /* Nested OVS_SAMPLE_ATTR_*. */
846         OVS_ACTION_ATTR_RECIRC,       /* u32 recirc_id. */
847         OVS_ACTION_ATTR_HASH,         /* struct ovs_action_hash. */
848         OVS_ACTION_ATTR_PUSH_MPLS,    /* struct ovs_action_push_mpls. */
849         OVS_ACTION_ATTR_POP_MPLS,     /* __be16 ethertype. */
850         OVS_ACTION_ATTR_SET_MASKED,   /* One nested OVS_KEY_ATTR_* including
851                                        * data immediately followed by a mask.
852                                        * The data must be zero for the unmasked
853                                        * bits. */
854         OVS_ACTION_ATTR_CT,           /* Nested OVS_CT_ATTR_* . */
855         OVS_ACTION_ATTR_TRUNC,        /* u32 struct ovs_action_trunc. */
856         OVS_ACTION_ATTR_PUSH_ETH,     /* struct ovs_action_push_eth. */
857         OVS_ACTION_ATTR_POP_ETH,      /* No argument. */
858         OVS_ACTION_ATTR_CT_CLEAR,     /* No argument. */
859         OVS_ACTION_ATTR_PUSH_NSH,     /* Nested OVS_NSH_KEY_ATTR_*. */
860         OVS_ACTION_ATTR_POP_NSH,      /* No argument. */
861         OVS_ACTION_ATTR_METER,        /* u32 meter ID. */
862         OVS_ACTION_ATTR_CLONE,        /* Nested OVS_CLONE_ATTR_*.  */
863
864         __OVS_ACTION_ATTR_MAX,        /* Nothing past this will be accepted
865                                        * from userspace. */
866
867 };
868
869 #define OVS_ACTION_ATTR_MAX (__OVS_ACTION_ATTR_MAX - 1)
870
871 /* Meters. */
872 #define OVS_METER_FAMILY  "ovs_meter"
873 #define OVS_METER_MCGROUP "ovs_meter"
874 #define OVS_METER_VERSION 0x1
875
876 enum ovs_meter_cmd {
877         OVS_METER_CMD_UNSPEC,
878         OVS_METER_CMD_FEATURES, /* Get features supported by the datapath. */
879         OVS_METER_CMD_SET,      /* Add or modify a meter. */
880         OVS_METER_CMD_DEL,      /* Delete a meter. */
881         OVS_METER_CMD_GET       /* Get meter stats. */
882 };
883
884 enum ovs_meter_attr {
885         OVS_METER_ATTR_UNSPEC,
886         OVS_METER_ATTR_ID,      /* u32 meter ID within datapath. */
887         OVS_METER_ATTR_KBPS,    /* No argument. If set, units in kilobits
888                                  * per second. Otherwise, units in
889                                  * packets per second.
890                                  */
891         OVS_METER_ATTR_STATS,   /* struct ovs_flow_stats for the meter. */
892         OVS_METER_ATTR_BANDS,   /* Nested attributes for meter bands. */
893         OVS_METER_ATTR_USED,    /* u64 msecs last used in monotonic time. */
894         OVS_METER_ATTR_CLEAR,   /* Flag to clear stats, used. */
895         OVS_METER_ATTR_MAX_METERS, /* u32 number of meters supported. */
896         OVS_METER_ATTR_MAX_BANDS,  /* u32 max number of bands per meter. */
897         OVS_METER_ATTR_PAD,
898         __OVS_METER_ATTR_MAX
899 };
900
901 #define OVS_METER_ATTR_MAX (__OVS_METER_ATTR_MAX - 1)
902
903 enum ovs_band_attr {
904         OVS_BAND_ATTR_UNSPEC,
905         OVS_BAND_ATTR_TYPE,     /* u32 OVS_METER_BAND_TYPE_* constant. */
906         OVS_BAND_ATTR_RATE,     /* u32 band rate in meter units (see above). */
907         OVS_BAND_ATTR_BURST,    /* u32 burst size in meter units. */
908         OVS_BAND_ATTR_STATS,    /* struct ovs_flow_stats for the band. */
909         __OVS_BAND_ATTR_MAX
910 };
911
912 #define OVS_BAND_ATTR_MAX (__OVS_BAND_ATTR_MAX - 1)
913
914 enum ovs_meter_band_type {
915         OVS_METER_BAND_TYPE_UNSPEC,
916         OVS_METER_BAND_TYPE_DROP,   /* Drop exceeding packets. */
917         __OVS_METER_BAND_TYPE_MAX
918 };
919
920 #define OVS_METER_BAND_TYPE_MAX (__OVS_METER_BAND_TYPE_MAX - 1)
921
922 /* Conntrack limit */
923 #define OVS_CT_LIMIT_FAMILY  "ovs_ct_limit"
924 #define OVS_CT_LIMIT_MCGROUP "ovs_ct_limit"
925 #define OVS_CT_LIMIT_VERSION 0x1
926
927 enum ovs_ct_limit_cmd {
928         OVS_CT_LIMIT_CMD_UNSPEC,
929         OVS_CT_LIMIT_CMD_SET,           /* Add or modify ct limit. */
930         OVS_CT_LIMIT_CMD_DEL,           /* Delete ct limit. */
931         OVS_CT_LIMIT_CMD_GET            /* Get ct limit. */
932 };
933
934 enum ovs_ct_limit_attr {
935         OVS_CT_LIMIT_ATTR_UNSPEC,
936         OVS_CT_LIMIT_ATTR_ZONE_LIMIT,   /* Nested struct ovs_zone_limit. */
937         __OVS_CT_LIMIT_ATTR_MAX
938 };
939
940 #define OVS_CT_LIMIT_ATTR_MAX (__OVS_CT_LIMIT_ATTR_MAX - 1)
941
942 #define OVS_ZONE_LIMIT_DEFAULT_ZONE -1
943
944 struct ovs_zone_limit {
945         int zone_id;
946         __u32 limit;
947         __u32 count;
948 };
949
950 #endif /* _LINUX_OPENVSWITCH_H */