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