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