1 /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
4 * Copyright (c) 2007-2017 Nicira, Inc.
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.
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.
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
21 #ifndef _UAPI__LINUX_OPENVSWITCH_H
22 #define _UAPI__LINUX_OPENVSWITCH_H 1
24 #include <linux/types.h>
25 #include <linux/if_ether.h>
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).
32 * Attributes following the header are specific to a particular OVS Generic
33 * Netlink family, but all of the OVS families use this header.
42 #define OVS_DATAPATH_FAMILY "ovs_datapath"
43 #define OVS_DATAPATH_MCGROUP "ovs_datapath"
46 * - API users are expected to provide OVS_DP_ATTR_USER_FEATURES
47 * when creating the datapath.
49 #define OVS_DATAPATH_VERSION 2
51 /* First OVS datapath version to support features */
52 #define OVS_DP_VER_FEATURES 2
54 enum ovs_datapath_cmd {
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
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.
78 * These attributes follow the &struct ovs_header within the Generic Netlink
79 * payload for %OVS_DP_* commands.
81 enum ovs_datapath_attr {
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_* */
92 #define OVS_DP_ATTR_MAX (__OVS_DP_ATTR_MAX - 1)
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 */
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. */
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 */
120 /* Allow last Netlink attribute to be unaligned */
121 #define OVS_DP_F_UNALIGNED (1 << 0)
123 /* Allow datapath to associate multiple Netlink PIDs to each vport */
124 #define OVS_DP_F_VPORT_PIDS (1 << 1)
126 /* Fixed logical ports. */
127 #define OVSP_LOCAL ((__u32)0)
129 /* Packet transfer. */
131 #define OVS_PACKET_FAMILY "ovs_packet"
132 #define OVS_PACKET_VERSION 0x1
134 enum ovs_packet_cmd {
135 OVS_PACKET_CMD_UNSPEC,
137 /* Kernel-to-user notifications. */
138 OVS_PACKET_CMD_MISS, /* Flow table miss. */
139 OVS_PACKET_CMD_ACTION, /* OVS_ACTION_ATTR_USERSPACE action. */
141 /* Userspace commands. */
142 OVS_PACKET_CMD_EXECUTE /* Apply actions to a packet. */
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
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
174 * These attributes follow the &struct ovs_header within the Generic Netlink
175 * payload for %OVS_PACKET_* commands.
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_*
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
194 #define OVS_PACKET_ATTR_MAX (__OVS_PACKET_ATTR_MAX - 1)
198 #define OVS_VPORT_FAMILY "ovs_vport"
199 #define OVS_VPORT_MCGROUP "ovs_vport"
200 #define OVS_VPORT_VERSION 0x1
203 OVS_VPORT_CMD_UNSPEC,
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. */
220 #define OVS_VPORT_TYPE_MAX (__OVS_VPORT_TYPE_MAX - 1)
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
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.
238 * These attributes follow the &struct ovs_header within the Generic Netlink
239 * payload for %OVS_VPORT_* commands.
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
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.
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 */
261 OVS_VPORT_ATTR_IFINDEX,
262 OVS_VPORT_ATTR_NETNSID,
266 #define OVS_VPORT_ATTR_MAX (__OVS_VPORT_ATTR_MAX - 1)
269 OVS_VXLAN_EXT_UNSPEC,
270 OVS_VXLAN_EXT_GBP, /* Flag or __u32 */
274 #define OVS_VXLAN_EXT_MAX (__OVS_VXLAN_EXT_MAX - 1)
277 /* OVS_VPORT_ATTR_OPTIONS attributes for tunnels.
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
286 #define OVS_TUNNEL_ATTR_MAX (__OVS_TUNNEL_ATTR_MAX - 1)
290 #define OVS_FLOW_FAMILY "ovs_flow"
291 #define OVS_FLOW_MCGROUP "ovs_flow"
292 #define OVS_FLOW_VERSION 0x1
302 struct ovs_flow_stats {
303 __u64 n_packets; /* Number of matched packets. */
304 __u64 n_bytes; /* Number of matched bytes. */
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_* */
342 OVS_KEY_ATTR_TUNNEL_INFO, /* struct ip_tunnel_info */
347 #define OVS_KEY_ATTR_MAX (__OVS_KEY_ATTR_MAX - 1)
349 enum ovs_tunnel_key_attr {
350 /* OVS_TUNNEL_KEY_ATTR_NONE, standard nl API requires this attribute! */
351 OVS_TUNNEL_KEY_ATTR_ID, /* be64 Tunnel ID */
352 OVS_TUNNEL_KEY_ATTR_IPV4_SRC, /* be32 src IP address. */
353 OVS_TUNNEL_KEY_ATTR_IPV4_DST, /* be32 dst IP address. */
354 OVS_TUNNEL_KEY_ATTR_TOS, /* u8 Tunnel IP ToS. */
355 OVS_TUNNEL_KEY_ATTR_TTL, /* u8 Tunnel IP TTL. */
356 OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT, /* No argument, set DF. */
357 OVS_TUNNEL_KEY_ATTR_CSUM, /* No argument. CSUM packet. */
358 OVS_TUNNEL_KEY_ATTR_OAM, /* No argument. OAM frame. */
359 OVS_TUNNEL_KEY_ATTR_GENEVE_OPTS, /* Array of Geneve options. */
360 OVS_TUNNEL_KEY_ATTR_TP_SRC, /* be16 src Transport Port. */
361 OVS_TUNNEL_KEY_ATTR_TP_DST, /* be16 dst Transport Port. */
362 OVS_TUNNEL_KEY_ATTR_VXLAN_OPTS, /* Nested OVS_VXLAN_EXT_* */
363 OVS_TUNNEL_KEY_ATTR_IPV6_SRC, /* struct in6_addr src IPv6 address. */
364 OVS_TUNNEL_KEY_ATTR_IPV6_DST, /* struct in6_addr dst IPv6 address. */
365 OVS_TUNNEL_KEY_ATTR_PAD,
366 OVS_TUNNEL_KEY_ATTR_ERSPAN_OPTS, /* struct erspan_metadata */
367 OVS_TUNNEL_KEY_ATTR_IPV4_INFO_BRIDGE, /* No argument. IPV4_INFO_BRIDGE mode.*/
368 __OVS_TUNNEL_KEY_ATTR_MAX
371 #define OVS_TUNNEL_KEY_ATTR_MAX (__OVS_TUNNEL_KEY_ATTR_MAX - 1)
374 * enum ovs_frag_type - IPv4 and IPv6 fragment type
375 * @OVS_FRAG_TYPE_NONE: Packet is not a fragment.
376 * @OVS_FRAG_TYPE_FIRST: Packet is a fragment with offset 0.
377 * @OVS_FRAG_TYPE_LATER: Packet is a fragment with nonzero offset.
379 * Used as the @ipv4_frag in &struct ovs_key_ipv4 and as @ipv6_frag &struct
389 #define OVS_FRAG_TYPE_MAX (__OVS_FRAG_TYPE_MAX - 1)
391 struct ovs_key_ethernet {
392 __u8 eth_src[ETH_ALEN];
393 __u8 eth_dst[ETH_ALEN];
396 struct ovs_key_mpls {
400 struct ovs_key_ipv4 {
406 __u8 ipv4_frag; /* One of OVS_FRAG_TYPE_*. */
409 struct ovs_key_ipv6 {
412 __be32 ipv6_label; /* 20-bits in least-significant bits. */
416 __u8 ipv6_frag; /* One of OVS_FRAG_TYPE_*. */
429 struct ovs_key_sctp {
434 struct ovs_key_icmp {
439 struct ovs_key_icmpv6 {
448 __u8 arp_sha[ETH_ALEN];
449 __u8 arp_tha[ETH_ALEN];
454 __u8 nd_sll[ETH_ALEN];
455 __u8 nd_tll[ETH_ALEN];
458 #define OVS_CT_LABELS_LEN_32 4
459 #define OVS_CT_LABELS_LEN (OVS_CT_LABELS_LEN_32 * sizeof(__u32))
460 struct ovs_key_ct_labels {
462 __u8 ct_labels[OVS_CT_LABELS_LEN];
463 __u32 ct_labels_32[OVS_CT_LABELS_LEN_32];
467 /* OVS_KEY_ATTR_CT_STATE flags */
468 #define OVS_CS_F_NEW 0x01 /* Beginning of a new connection. */
469 #define OVS_CS_F_ESTABLISHED 0x02 /* Part of an existing connection. */
470 #define OVS_CS_F_RELATED 0x04 /* Related to an established
472 #define OVS_CS_F_REPLY_DIR 0x08 /* Flow is in the reply direction. */
473 #define OVS_CS_F_INVALID 0x10 /* Could not track connection. */
474 #define OVS_CS_F_TRACKED 0x20 /* Conntrack has occurred. */
475 #define OVS_CS_F_SRC_NAT 0x40 /* Packet's source address/port was
478 #define OVS_CS_F_DST_NAT 0x80 /* Packet's destination address/port
479 * was mangled by NAT.
482 #define OVS_CS_F_NAT_MASK (OVS_CS_F_SRC_NAT | OVS_CS_F_DST_NAT)
484 struct ovs_key_ct_tuple_ipv4 {
492 struct ovs_key_ct_tuple_ipv6 {
500 enum ovs_nsh_key_attr {
501 OVS_NSH_KEY_ATTR_UNSPEC,
502 OVS_NSH_KEY_ATTR_BASE, /* struct ovs_nsh_key_base. */
503 OVS_NSH_KEY_ATTR_MD1, /* struct ovs_nsh_key_md1. */
504 OVS_NSH_KEY_ATTR_MD2, /* variable-length octets for MD type 2. */
505 __OVS_NSH_KEY_ATTR_MAX
508 #define OVS_NSH_KEY_ATTR_MAX (__OVS_NSH_KEY_ATTR_MAX - 1)
510 struct ovs_nsh_key_base {
518 #define NSH_MD1_CONTEXT_SIZE 4
520 struct ovs_nsh_key_md1 {
521 __be32 context[NSH_MD1_CONTEXT_SIZE];
525 * enum ovs_flow_attr - attributes for %OVS_FLOW_* commands.
526 * @OVS_FLOW_ATTR_KEY: Nested %OVS_KEY_ATTR_* attributes specifying the flow
527 * key. Always present in notifications. Required for all requests (except
529 * @OVS_FLOW_ATTR_ACTIONS: Nested %OVS_ACTION_ATTR_* attributes specifying
530 * the actions to take for packets that match the key. Always present in
531 * notifications. Required for %OVS_FLOW_CMD_NEW requests, optional for
532 * %OVS_FLOW_CMD_SET requests. An %OVS_FLOW_CMD_SET without
533 * %OVS_FLOW_ATTR_ACTIONS will not modify the actions. To clear the actions,
534 * an %OVS_FLOW_ATTR_ACTIONS without any nested attributes must be given.
535 * @OVS_FLOW_ATTR_STATS: &struct ovs_flow_stats giving statistics for this
536 * flow. Present in notifications if the stats would be nonzero. Ignored in
538 * @OVS_FLOW_ATTR_TCP_FLAGS: An 8-bit value giving the OR'd value of all of the
539 * TCP flags seen on packets in this flow. Only present in notifications for
540 * TCP flows, and only if it would be nonzero. Ignored in requests.
541 * @OVS_FLOW_ATTR_USED: A 64-bit integer giving the time, in milliseconds on
542 * the system monotonic clock, at which a packet was last processed for this
543 * flow. Only present in notifications if a packet has been processed for this
544 * flow. Ignored in requests.
545 * @OVS_FLOW_ATTR_CLEAR: If present in a %OVS_FLOW_CMD_SET request, clears the
546 * last-used time, accumulated TCP flags, and statistics for this flow.
547 * Otherwise ignored in requests. Never present in notifications.
548 * @OVS_FLOW_ATTR_MASK: Nested %OVS_KEY_ATTR_* attributes specifying the
549 * mask bits for wildcarded flow match. Mask bit value '1' specifies exact
550 * match with corresponding flow key bit, while mask bit value '0' specifies
551 * a wildcarded match. Omitting attribute is treated as wildcarding all
552 * corresponding fields. Optional for all requests. If not present,
553 * all flow key bits are exact match bits.
554 * @OVS_FLOW_ATTR_UFID: A value between 1-16 octets specifying a unique
555 * identifier for the flow. Causes the flow to be indexed by this value rather
556 * than the value of the %OVS_FLOW_ATTR_KEY attribute. Optional for all
557 * requests. Present in notifications if the flow was created with this
559 * @OVS_FLOW_ATTR_UFID_FLAGS: A 32-bit value of OR'd %OVS_UFID_F_*
560 * flags that provide alternative semantics for flow installation and
561 * retrieval. Optional for all requests.
563 * These attributes follow the &struct ovs_header within the Generic Netlink
564 * payload for %OVS_FLOW_* commands.
567 OVS_FLOW_ATTR_UNSPEC,
568 OVS_FLOW_ATTR_KEY, /* Sequence of OVS_KEY_ATTR_* attributes. */
569 OVS_FLOW_ATTR_ACTIONS, /* Nested OVS_ACTION_ATTR_* attributes. */
570 OVS_FLOW_ATTR_STATS, /* struct ovs_flow_stats. */
571 OVS_FLOW_ATTR_TCP_FLAGS, /* 8-bit OR'd TCP flags. */
572 OVS_FLOW_ATTR_USED, /* u64 msecs last used in monotonic time. */
573 OVS_FLOW_ATTR_CLEAR, /* Flag to clear stats, tcp_flags, used. */
574 OVS_FLOW_ATTR_MASK, /* Sequence of OVS_KEY_ATTR_* attributes. */
575 OVS_FLOW_ATTR_PROBE, /* Flow operation is a feature probe, error
576 * logging should be suppressed. */
577 OVS_FLOW_ATTR_UFID, /* Variable length unique flow identifier. */
578 OVS_FLOW_ATTR_UFID_FLAGS,/* u32 of OVS_UFID_F_*. */
583 #define OVS_FLOW_ATTR_MAX (__OVS_FLOW_ATTR_MAX - 1)
586 * Omit attributes for notifications.
588 * If a datapath request contains an %OVS_UFID_F_OMIT_* flag, then the datapath
589 * may omit the corresponding %OVS_FLOW_ATTR_* from the response.
591 #define OVS_UFID_F_OMIT_KEY (1 << 0)
592 #define OVS_UFID_F_OMIT_MASK (1 << 1)
593 #define OVS_UFID_F_OMIT_ACTIONS (1 << 2)
596 * enum ovs_sample_attr - Attributes for %OVS_ACTION_ATTR_SAMPLE action.
597 * @OVS_SAMPLE_ATTR_PROBABILITY: 32-bit fraction of packets to sample with
598 * @OVS_ACTION_ATTR_SAMPLE. A value of 0 samples no packets, a value of
599 * %UINT32_MAX samples all packets and intermediate values sample intermediate
600 * fractions of packets.
601 * @OVS_SAMPLE_ATTR_ACTIONS: Set of actions to execute in sampling event.
602 * Actions are passed as nested attributes.
604 * Executes the specified actions with the given probability on a per-packet
607 enum ovs_sample_attr {
608 OVS_SAMPLE_ATTR_UNSPEC,
609 OVS_SAMPLE_ATTR_PROBABILITY, /* u32 number */
610 OVS_SAMPLE_ATTR_ACTIONS, /* Nested OVS_ACTION_ATTR_* attributes. */
611 __OVS_SAMPLE_ATTR_MAX,
614 OVS_SAMPLE_ATTR_ARG /* struct sample_arg */
618 #define OVS_SAMPLE_ATTR_MAX (__OVS_SAMPLE_ATTR_MAX - 1)
622 bool exec; /* When true, actions in sample will not
623 * change flow keys. False otherwise.
625 u32 probability; /* Same value as
626 * 'OVS_SAMPLE_ATTR_PROBABILITY'.
632 * enum ovs_userspace_attr - Attributes for %OVS_ACTION_ATTR_USERSPACE action.
633 * @OVS_USERSPACE_ATTR_PID: u32 Netlink PID to which the %OVS_PACKET_CMD_ACTION
634 * message should be sent. Required.
635 * @OVS_USERSPACE_ATTR_USERDATA: If present, its variable-length argument is
636 * copied to the %OVS_PACKET_CMD_ACTION message as %OVS_PACKET_ATTR_USERDATA.
637 * @OVS_USERSPACE_ATTR_EGRESS_TUN_PORT: If present, u32 output port to get
639 * @OVS_USERSPACE_ATTR_ACTIONS: If present, send actions with upcall.
641 enum ovs_userspace_attr {
642 OVS_USERSPACE_ATTR_UNSPEC,
643 OVS_USERSPACE_ATTR_PID, /* u32 Netlink PID to receive upcalls. */
644 OVS_USERSPACE_ATTR_USERDATA, /* Optional user-specified cookie. */
645 OVS_USERSPACE_ATTR_EGRESS_TUN_PORT, /* Optional, u32 output port
646 * to get tunnel info. */
647 OVS_USERSPACE_ATTR_ACTIONS, /* Optional flag to get actions. */
648 __OVS_USERSPACE_ATTR_MAX
651 #define OVS_USERSPACE_ATTR_MAX (__OVS_USERSPACE_ATTR_MAX - 1)
653 struct ovs_action_trunc {
654 __u32 max_len; /* Max packet size in bytes. */
658 * struct ovs_action_push_mpls - %OVS_ACTION_ATTR_PUSH_MPLS action argument.
659 * @mpls_lse: MPLS label stack entry to push.
660 * @mpls_ethertype: Ethertype to set in the encapsulating ethernet frame.
662 * The only values @mpls_ethertype should ever be given are %ETH_P_MPLS_UC and
663 * %ETH_P_MPLS_MC, indicating MPLS unicast or multicast. Other are rejected.
665 struct ovs_action_push_mpls {
667 __be16 mpls_ethertype; /* Either %ETH_P_MPLS_UC or %ETH_P_MPLS_MC */
671 * struct ovs_action_push_vlan - %OVS_ACTION_ATTR_PUSH_VLAN action argument.
672 * @vlan_tpid: Tag protocol identifier (TPID) to push.
673 * @vlan_tci: Tag control identifier (TCI) to push. The CFI bit must be set
674 * (but it will not be set in the 802.1Q header that is pushed).
676 * The @vlan_tpid value is typically %ETH_P_8021Q or %ETH_P_8021AD.
677 * The only acceptable TPID values are those that the kernel module also parses
678 * as 802.1Q or 802.1AD headers, to prevent %OVS_ACTION_ATTR_PUSH_VLAN followed
679 * by %OVS_ACTION_ATTR_POP_VLAN from having surprising results.
681 struct ovs_action_push_vlan {
682 __be16 vlan_tpid; /* 802.1Q or 802.1ad TPID. */
683 __be16 vlan_tci; /* 802.1Q TCI (VLAN ID and priority). */
686 /* Data path hash algorithm for computing Datapath hash.
688 * The algorithm type only specifies the fields in a flow
689 * will be used as part of the hash. Each datapath is free
690 * to use its own hash algorithm. The hash value will be
691 * opaque to the user space daemon.
698 * struct ovs_action_hash - %OVS_ACTION_ATTR_HASH action argument.
699 * @hash_alg: Algorithm used to compute hash prior to recirculation.
700 * @hash_basis: basis used for computing hash.
702 struct ovs_action_hash {
703 __u32 hash_alg; /* One of ovs_hash_alg. */
708 * enum ovs_ct_attr - Attributes for %OVS_ACTION_ATTR_CT action.
709 * @OVS_CT_ATTR_COMMIT: If present, commits the connection to the conntrack
710 * table. This allows future packets for the same connection to be identified
711 * as 'established' or 'related'. The flow key for the current packet will
712 * retain the pre-commit connection state.
713 * @OVS_CT_ATTR_ZONE: u16 connection tracking zone.
714 * @OVS_CT_ATTR_MARK: u32 value followed by u32 mask. For each bit set in the
715 * mask, the corresponding bit in the value is copied to the connection
716 * tracking mark field in the connection.
717 * @OVS_CT_ATTR_LABELS: %OVS_CT_LABELS_LEN value followed by %OVS_CT_LABELS_LEN
718 * mask. For each bit set in the mask, the corresponding bit in the value is
719 * copied to the connection tracking label field in the connection.
720 * @OVS_CT_ATTR_HELPER: variable length string defining conntrack ALG.
721 * @OVS_CT_ATTR_NAT: Nested OVS_NAT_ATTR_* for performing L3 network address
722 * translation (NAT) on the packet.
723 * @OVS_CT_ATTR_FORCE_COMMIT: Like %OVS_CT_ATTR_COMMIT, but instead of doing
724 * nothing if the connection is already committed will check that the current
725 * packet is in conntrack entry's original direction. If directionality does
726 * not match, will delete the existing conntrack entry and commit a new one.
727 * @OVS_CT_ATTR_EVENTMASK: Mask of bits indicating which conntrack event types
728 * (enum ip_conntrack_events IPCT_*) should be reported. For any bit set to
729 * zero, the corresponding event type is not generated. Default behavior
730 * depends on system configuration, but typically all event types are
731 * generated, hence listening on NFNLGRP_CONNTRACK_UPDATE events may get a lot
732 * of events. Explicitly passing this attribute allows limiting the updates
733 * received to the events of interest. The bit 1 << IPCT_NEW, 1 <<
734 * IPCT_RELATED, and 1 << IPCT_DESTROY must be set to ones for those events to
735 * be received on NFNLGRP_CONNTRACK_NEW and NFNLGRP_CONNTRACK_DESTROY groups,
736 * respectively. Remaining bits control the changes for which an event is
737 * delivered on the NFNLGRP_CONNTRACK_UPDATE group.
738 * @OVS_CT_ATTR_TIMEOUT: Variable length string defining conntrack timeout.
742 OVS_CT_ATTR_COMMIT, /* No argument, commits connection. */
743 OVS_CT_ATTR_ZONE, /* u16 zone id. */
744 OVS_CT_ATTR_MARK, /* mark to associate with this connection. */
745 OVS_CT_ATTR_LABELS, /* labels to associate with this connection. */
746 OVS_CT_ATTR_HELPER, /* netlink helper to assist detection of
747 related connections. */
748 OVS_CT_ATTR_NAT, /* Nested OVS_NAT_ATTR_* */
749 OVS_CT_ATTR_FORCE_COMMIT, /* No argument */
750 OVS_CT_ATTR_EVENTMASK, /* u32 mask of IPCT_* events. */
751 OVS_CT_ATTR_TIMEOUT, /* Associate timeout with this connection for
752 * fine-grain timeout tuning. */
756 #define OVS_CT_ATTR_MAX (__OVS_CT_ATTR_MAX - 1)
759 * enum ovs_nat_attr - Attributes for %OVS_CT_ATTR_NAT.
761 * @OVS_NAT_ATTR_SRC: Flag for Source NAT (mangle source address/port).
762 * @OVS_NAT_ATTR_DST: Flag for Destination NAT (mangle destination
763 * address/port). Only one of (@OVS_NAT_ATTR_SRC, @OVS_NAT_ATTR_DST) may be
764 * specified. Effective only for packets for ct_state NEW connections.
765 * Packets of committed connections are mangled by the NAT action according to
766 * the committed NAT type regardless of the flags specified. As a corollary, a
767 * NAT action without a NAT type flag will only mangle packets of committed
768 * connections. The following NAT attributes only apply for NEW
769 * (non-committed) connections, and they may be included only when the CT
770 * action has the @OVS_CT_ATTR_COMMIT flag and either @OVS_NAT_ATTR_SRC or
771 * @OVS_NAT_ATTR_DST is also included.
772 * @OVS_NAT_ATTR_IP_MIN: struct in_addr or struct in6_addr
773 * @OVS_NAT_ATTR_IP_MAX: struct in_addr or struct in6_addr
774 * @OVS_NAT_ATTR_PROTO_MIN: u16 L4 protocol specific lower boundary (port)
775 * @OVS_NAT_ATTR_PROTO_MAX: u16 L4 protocol specific upper boundary (port)
776 * @OVS_NAT_ATTR_PERSISTENT: Flag for persistent IP mapping across reboots
777 * @OVS_NAT_ATTR_PROTO_HASH: Flag for pseudo random L4 port mapping (MD5)
778 * @OVS_NAT_ATTR_PROTO_RANDOM: Flag for fully randomized L4 port mapping
786 OVS_NAT_ATTR_PROTO_MIN,
787 OVS_NAT_ATTR_PROTO_MAX,
788 OVS_NAT_ATTR_PERSISTENT,
789 OVS_NAT_ATTR_PROTO_HASH,
790 OVS_NAT_ATTR_PROTO_RANDOM,
794 #define OVS_NAT_ATTR_MAX (__OVS_NAT_ATTR_MAX - 1)
797 * struct ovs_action_push_eth - %OVS_ACTION_ATTR_PUSH_ETH action argument.
798 * @addresses: Source and destination MAC addresses.
799 * @eth_type: Ethernet type
801 struct ovs_action_push_eth {
802 struct ovs_key_ethernet addresses;
806 * enum ovs_check_pkt_len_attr - Attributes for %OVS_ACTION_ATTR_CHECK_PKT_LEN.
808 * @OVS_CHECK_PKT_LEN_ATTR_PKT_LEN: u16 Packet length to check for.
809 * @OVS_CHECK_PKT_LEN_ATTR_ACTIONS_IF_GREATER: Nested OVS_ACTION_ATTR_*
810 * actions to apply if the packer length is greater than the specified
811 * length in the attr - OVS_CHECK_PKT_LEN_ATTR_PKT_LEN.
812 * @OVS_CHECK_PKT_LEN_ATTR_ACTIONS_IF_LESS_EQUAL - Nested OVS_ACTION_ATTR_*
813 * actions to apply if the packer length is lesser or equal to the specified
814 * length in the attr - OVS_CHECK_PKT_LEN_ATTR_PKT_LEN.
816 enum ovs_check_pkt_len_attr {
817 OVS_CHECK_PKT_LEN_ATTR_UNSPEC,
818 OVS_CHECK_PKT_LEN_ATTR_PKT_LEN,
819 OVS_CHECK_PKT_LEN_ATTR_ACTIONS_IF_GREATER,
820 OVS_CHECK_PKT_LEN_ATTR_ACTIONS_IF_LESS_EQUAL,
821 __OVS_CHECK_PKT_LEN_ATTR_MAX,
824 OVS_CHECK_PKT_LEN_ATTR_ARG /* struct check_pkt_len_arg */
828 #define OVS_CHECK_PKT_LEN_ATTR_MAX (__OVS_CHECK_PKT_LEN_ATTR_MAX - 1)
831 struct check_pkt_len_arg {
832 u16 pkt_len; /* Same value as OVS_CHECK_PKT_LEN_ATTR_PKT_LEN'. */
833 bool exec_for_greater; /* When true, actions in IF_GREATER will
834 * not change flow keys. False otherwise.
836 bool exec_for_lesser_equal; /* When true, actions in IF_LESS_EQUAL
837 * will not change flow keys. False
844 * enum ovs_action_attr - Action types.
846 * @OVS_ACTION_ATTR_OUTPUT: Output packet to port.
847 * @OVS_ACTION_ATTR_TRUNC: Output packet to port with truncated packet size.
848 * @OVS_ACTION_ATTR_USERSPACE: Send packet to userspace according to nested
849 * %OVS_USERSPACE_ATTR_* attributes.
850 * @OVS_ACTION_ATTR_SET: Replaces the contents of an existing header. The
851 * single nested %OVS_KEY_ATTR_* attribute specifies a header to modify and its
853 * @OVS_ACTION_ATTR_SET_MASKED: Replaces the contents of an existing header. A
854 * nested %OVS_KEY_ATTR_* attribute specifies a header to modify, its value,
855 * and a mask. For every bit set in the mask, the corresponding bit value
856 * is copied from the value to the packet header field, rest of the bits are
857 * left unchanged. The non-masked value bits must be passed in as zeroes.
858 * Masking is not supported for the %OVS_KEY_ATTR_TUNNEL attribute.
859 * @OVS_ACTION_ATTR_PUSH_VLAN: Push a new outermost 802.1Q or 802.1ad header
861 * @OVS_ACTION_ATTR_POP_VLAN: Pop the outermost 802.1Q or 802.1ad header
863 * @OVS_ACTION_ATTR_SAMPLE: Probabilitically executes actions, as specified in
864 * the nested %OVS_SAMPLE_ATTR_* attributes.
865 * @OVS_ACTION_ATTR_PUSH_MPLS: Push a new MPLS label stack entry onto the
866 * top of the packets MPLS label stack. Set the ethertype of the
867 * encapsulating frame to either %ETH_P_MPLS_UC or %ETH_P_MPLS_MC to
868 * indicate the new packet contents.
869 * @OVS_ACTION_ATTR_POP_MPLS: Pop an MPLS label stack entry off of the
870 * packet's MPLS label stack. Set the encapsulating frame's ethertype to
871 * indicate the new packet contents. This could potentially still be
872 * %ETH_P_MPLS if the resulting MPLS label stack is not empty. If there
873 * is no MPLS label stack, as determined by ethertype, no action is taken.
874 * @OVS_ACTION_ATTR_CT: Track the connection. Populate the conntrack-related
875 * entries in the flow key.
876 * @OVS_ACTION_ATTR_PUSH_ETH: Push a new outermost Ethernet header onto the
878 * @OVS_ACTION_ATTR_POP_ETH: Pop the outermost Ethernet header off the
880 * @OVS_ACTION_ATTR_CT_CLEAR: Clear conntrack state from the packet.
881 * @OVS_ACTION_ATTR_PUSH_NSH: push NSH header to the packet.
882 * @OVS_ACTION_ATTR_POP_NSH: pop the outermost NSH header off the packet.
883 * @OVS_ACTION_ATTR_METER: Run packet through a meter, which may drop the
884 * packet, or modify the packet (e.g., change the DSCP field).
885 * @OVS_ACTION_ATTR_CLONE: make a copy of the packet and execute a list of
886 * actions without affecting the original packet and key.
887 * @OVS_ACTION_ATTR_CHECK_PKT_LEN: Check the packet length and execute a set
888 * of actions if greater than the specified packet length, else execute
889 * another set of actions.
891 * Only a single header can be set with a single %OVS_ACTION_ATTR_SET. Not all
892 * fields within a header are modifiable, e.g. the IPv4 protocol and fragment
893 * type may not be changed.
895 * @OVS_ACTION_ATTR_SET_TO_MASKED: Kernel internal masked set action translated
896 * from the @OVS_ACTION_ATTR_SET.
899 enum ovs_action_attr {
900 OVS_ACTION_ATTR_UNSPEC,
901 OVS_ACTION_ATTR_OUTPUT, /* u32 port number. */
902 OVS_ACTION_ATTR_USERSPACE, /* Nested OVS_USERSPACE_ATTR_*. */
903 OVS_ACTION_ATTR_SET, /* One nested OVS_KEY_ATTR_*. */
904 OVS_ACTION_ATTR_PUSH_VLAN, /* struct ovs_action_push_vlan. */
905 OVS_ACTION_ATTR_POP_VLAN, /* No argument. */
906 OVS_ACTION_ATTR_SAMPLE, /* Nested OVS_SAMPLE_ATTR_*. */
907 OVS_ACTION_ATTR_RECIRC, /* u32 recirc_id. */
908 OVS_ACTION_ATTR_HASH, /* struct ovs_action_hash. */
909 OVS_ACTION_ATTR_PUSH_MPLS, /* struct ovs_action_push_mpls. */
910 OVS_ACTION_ATTR_POP_MPLS, /* __be16 ethertype. */
911 OVS_ACTION_ATTR_SET_MASKED, /* One nested OVS_KEY_ATTR_* including
912 * data immediately followed by a mask.
913 * The data must be zero for the unmasked
915 OVS_ACTION_ATTR_CT, /* Nested OVS_CT_ATTR_* . */
916 OVS_ACTION_ATTR_TRUNC, /* u32 struct ovs_action_trunc. */
917 OVS_ACTION_ATTR_PUSH_ETH, /* struct ovs_action_push_eth. */
918 OVS_ACTION_ATTR_POP_ETH, /* No argument. */
919 OVS_ACTION_ATTR_CT_CLEAR, /* No argument. */
920 OVS_ACTION_ATTR_PUSH_NSH, /* Nested OVS_NSH_KEY_ATTR_*. */
921 OVS_ACTION_ATTR_POP_NSH, /* No argument. */
922 OVS_ACTION_ATTR_METER, /* u32 meter ID. */
923 OVS_ACTION_ATTR_CLONE, /* Nested OVS_CLONE_ATTR_*. */
924 OVS_ACTION_ATTR_CHECK_PKT_LEN, /* Nested OVS_CHECK_PKT_LEN_ATTR_*. */
926 __OVS_ACTION_ATTR_MAX, /* Nothing past this will be accepted
930 OVS_ACTION_ATTR_SET_TO_MASKED, /* Kernel module internal masked
931 * set action converted from
932 * OVS_ACTION_ATTR_SET. */
936 #define OVS_ACTION_ATTR_MAX (__OVS_ACTION_ATTR_MAX - 1)
939 #define OVS_METER_FAMILY "ovs_meter"
940 #define OVS_METER_MCGROUP "ovs_meter"
941 #define OVS_METER_VERSION 0x1
944 OVS_METER_CMD_UNSPEC,
945 OVS_METER_CMD_FEATURES, /* Get features supported by the datapath. */
946 OVS_METER_CMD_SET, /* Add or modify a meter. */
947 OVS_METER_CMD_DEL, /* Delete a meter. */
948 OVS_METER_CMD_GET /* Get meter stats. */
951 enum ovs_meter_attr {
952 OVS_METER_ATTR_UNSPEC,
953 OVS_METER_ATTR_ID, /* u32 meter ID within datapath. */
954 OVS_METER_ATTR_KBPS, /* No argument. If set, units in kilobits
955 * per second. Otherwise, units in
956 * packets per second.
958 OVS_METER_ATTR_STATS, /* struct ovs_flow_stats for the meter. */
959 OVS_METER_ATTR_BANDS, /* Nested attributes for meter bands. */
960 OVS_METER_ATTR_USED, /* u64 msecs last used in monotonic time. */
961 OVS_METER_ATTR_CLEAR, /* Flag to clear stats, used. */
962 OVS_METER_ATTR_MAX_METERS, /* u32 number of meters supported. */
963 OVS_METER_ATTR_MAX_BANDS, /* u32 max number of bands per meter. */
968 #define OVS_METER_ATTR_MAX (__OVS_METER_ATTR_MAX - 1)
971 OVS_BAND_ATTR_UNSPEC,
972 OVS_BAND_ATTR_TYPE, /* u32 OVS_METER_BAND_TYPE_* constant. */
973 OVS_BAND_ATTR_RATE, /* u32 band rate in meter units (see above). */
974 OVS_BAND_ATTR_BURST, /* u32 burst size in meter units. */
975 OVS_BAND_ATTR_STATS, /* struct ovs_flow_stats for the band. */
979 #define OVS_BAND_ATTR_MAX (__OVS_BAND_ATTR_MAX - 1)
981 enum ovs_meter_band_type {
982 OVS_METER_BAND_TYPE_UNSPEC,
983 OVS_METER_BAND_TYPE_DROP, /* Drop exceeding packets. */
984 __OVS_METER_BAND_TYPE_MAX
987 #define OVS_METER_BAND_TYPE_MAX (__OVS_METER_BAND_TYPE_MAX - 1)
989 /* Conntrack limit */
990 #define OVS_CT_LIMIT_FAMILY "ovs_ct_limit"
991 #define OVS_CT_LIMIT_MCGROUP "ovs_ct_limit"
992 #define OVS_CT_LIMIT_VERSION 0x1
994 enum ovs_ct_limit_cmd {
995 OVS_CT_LIMIT_CMD_UNSPEC,
996 OVS_CT_LIMIT_CMD_SET, /* Add or modify ct limit. */
997 OVS_CT_LIMIT_CMD_DEL, /* Delete ct limit. */
998 OVS_CT_LIMIT_CMD_GET /* Get ct limit. */
1001 enum ovs_ct_limit_attr {
1002 OVS_CT_LIMIT_ATTR_UNSPEC,
1003 OVS_CT_LIMIT_ATTR_ZONE_LIMIT, /* Nested struct ovs_zone_limit. */
1004 __OVS_CT_LIMIT_ATTR_MAX
1007 #define OVS_CT_LIMIT_ATTR_MAX (__OVS_CT_LIMIT_ATTR_MAX - 1)
1009 #define OVS_ZONE_LIMIT_DEFAULT_ZONE -1
1011 struct ovs_zone_limit {
1017 #endif /* _LINUX_OPENVSWITCH_H */