3 * Copyright (c) 2007-2017 Nicira, Inc.
5 * This program is free software; you can redistribute it and/or
6 * modify it under the terms of version 2 of the GNU General Public
7 * License as published by the Free Software Foundation.
9 * This program is distributed in the hope that it will be useful, but
10 * WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
20 #ifndef _UAPI__LINUX_OPENVSWITCH_H
21 #define _UAPI__LINUX_OPENVSWITCH_H 1
23 #include <linux/types.h>
24 #include <linux/if_ether.h>
27 * struct ovs_header - header for OVS Generic Netlink messages.
28 * @dp_ifindex: ifindex of local port for datapath (0 to make a request not
29 * specific to a datapath).
31 * Attributes following the header are specific to a particular OVS Generic
32 * Netlink family, but all of the OVS families use this header.
41 #define OVS_DATAPATH_FAMILY "ovs_datapath"
42 #define OVS_DATAPATH_MCGROUP "ovs_datapath"
45 * - API users are expected to provide OVS_DP_ATTR_USER_FEATURES
46 * when creating the datapath.
48 #define OVS_DATAPATH_VERSION 2
50 /* First OVS datapath version to support features */
51 #define OVS_DP_VER_FEATURES 2
53 enum ovs_datapath_cmd {
62 * enum ovs_datapath_attr - attributes for %OVS_DP_* commands.
63 * @OVS_DP_ATTR_NAME: Name of the network device that serves as the "local
64 * port". This is the name of the network device whose dp_ifindex is given in
65 * the &struct ovs_header. Always present in notifications. Required in
66 * %OVS_DP_NEW requests. May be used as an alternative to specifying
67 * dp_ifindex in other requests (with a dp_ifindex of 0).
68 * @OVS_DP_ATTR_UPCALL_PID: The Netlink socket in userspace that is initially
69 * set on the datapath port (for OVS_ACTION_ATTR_MISS). Only valid on
70 * %OVS_DP_CMD_NEW requests. A value of zero indicates that upcalls should
72 * @OVS_DP_ATTR_STATS: Statistics about packets that have passed through the
73 * datapath. Always present in notifications.
74 * @OVS_DP_ATTR_MEGAFLOW_STATS: Statistics about mega flow masks usage for the
75 * datapath. Always present in notifications.
77 * These attributes follow the &struct ovs_header within the Generic Netlink
78 * payload for %OVS_DP_* commands.
80 enum ovs_datapath_attr {
82 OVS_DP_ATTR_NAME, /* name of dp_ifindex netdev */
83 OVS_DP_ATTR_UPCALL_PID, /* Netlink PID to receive upcalls */
84 OVS_DP_ATTR_STATS, /* struct ovs_dp_stats */
85 OVS_DP_ATTR_MEGAFLOW_STATS, /* struct ovs_dp_megaflow_stats */
86 OVS_DP_ATTR_USER_FEATURES, /* OVS_DP_F_* */
91 #define OVS_DP_ATTR_MAX (__OVS_DP_ATTR_MAX - 1)
94 __u64 n_hit; /* Number of flow table matches. */
95 __u64 n_missed; /* Number of flow table misses. */
96 __u64 n_lost; /* Number of misses not sent to userspace. */
97 __u64 n_flows; /* Number of flows present */
100 struct ovs_dp_megaflow_stats {
101 __u64 n_mask_hit; /* Number of masks used for flow lookups. */
102 __u32 n_masks; /* Number of masks for the datapath. */
103 __u32 pad0; /* Pad for future expension. */
104 __u64 pad1; /* Pad for future expension. */
105 __u64 pad2; /* Pad for future expension. */
108 struct ovs_vport_stats {
109 __u64 rx_packets; /* total packets received */
110 __u64 tx_packets; /* total packets transmitted */
111 __u64 rx_bytes; /* total bytes received */
112 __u64 tx_bytes; /* total bytes transmitted */
113 __u64 rx_errors; /* bad packets received */
114 __u64 tx_errors; /* packet transmit problems */
115 __u64 rx_dropped; /* no space in linux buffers */
116 __u64 tx_dropped; /* no space available in linux */
119 /* Allow last Netlink attribute to be unaligned */
120 #define OVS_DP_F_UNALIGNED (1 << 0)
122 /* Allow datapath to associate multiple Netlink PIDs to each vport */
123 #define OVS_DP_F_VPORT_PIDS (1 << 1)
125 /* Fixed logical ports. */
126 #define OVSP_LOCAL ((__u32)0)
128 /* Packet transfer. */
130 #define OVS_PACKET_FAMILY "ovs_packet"
131 #define OVS_PACKET_VERSION 0x1
133 enum ovs_packet_cmd {
134 OVS_PACKET_CMD_UNSPEC,
136 /* Kernel-to-user notifications. */
137 OVS_PACKET_CMD_MISS, /* Flow table miss. */
138 OVS_PACKET_CMD_ACTION, /* OVS_ACTION_ATTR_USERSPACE action. */
140 /* Userspace commands. */
141 OVS_PACKET_CMD_EXECUTE /* Apply actions to a packet. */
145 * enum ovs_packet_attr - attributes for %OVS_PACKET_* commands.
146 * @OVS_PACKET_ATTR_PACKET: Present for all notifications. Contains the entire
147 * packet as received, from the start of the Ethernet header onward. For
148 * %OVS_PACKET_CMD_ACTION, %OVS_PACKET_ATTR_PACKET reflects changes made by
149 * actions preceding %OVS_ACTION_ATTR_USERSPACE, but %OVS_PACKET_ATTR_KEY is
150 * the flow key extracted from the packet as originally received.
151 * @OVS_PACKET_ATTR_KEY: Present for all notifications. Contains the flow key
152 * extracted from the packet as nested %OVS_KEY_ATTR_* attributes. This allows
153 * userspace to adapt its flow setup strategy by comparing its notion of the
154 * flow key against the kernel's.
155 * @OVS_PACKET_ATTR_ACTIONS: Contains actions for the packet. Used
156 * for %OVS_PACKET_CMD_EXECUTE. It has nested %OVS_ACTION_ATTR_* attributes.
157 * Also used in upcall when %OVS_ACTION_ATTR_USERSPACE has optional
158 * %OVS_USERSPACE_ATTR_ACTIONS attribute.
159 * @OVS_PACKET_ATTR_USERDATA: Present for an %OVS_PACKET_CMD_ACTION
160 * notification if the %OVS_ACTION_ATTR_USERSPACE action specified an
161 * %OVS_USERSPACE_ATTR_USERDATA attribute, with the same length and content
163 * @OVS_PACKET_ATTR_EGRESS_TUN_KEY: Present for an %OVS_PACKET_CMD_ACTION
164 * notification if the %OVS_ACTION_ATTR_USERSPACE action specified an
165 * %OVS_USERSPACE_ATTR_EGRESS_TUN_PORT attribute, which is sent only if the
166 * output port is actually a tunnel port. Contains the output tunnel key
167 * extracted from the packet as nested %OVS_TUNNEL_KEY_ATTR_* attributes.
168 * @OVS_PACKET_ATTR_MRU: Present for an %OVS_PACKET_CMD_ACTION and
169 * @OVS_PACKET_ATTR_LEN: Packet size before truncation.
170 * %OVS_PACKET_ATTR_USERSPACE action specify the Maximum received fragment
173 * These attributes follow the &struct ovs_header within the Generic Netlink
174 * payload for %OVS_PACKET_* commands.
176 enum ovs_packet_attr {
177 OVS_PACKET_ATTR_UNSPEC,
178 OVS_PACKET_ATTR_PACKET, /* Packet data. */
179 OVS_PACKET_ATTR_KEY, /* Nested OVS_KEY_ATTR_* attributes. */
180 OVS_PACKET_ATTR_ACTIONS, /* Nested OVS_ACTION_ATTR_* attributes. */
181 OVS_PACKET_ATTR_USERDATA, /* OVS_ACTION_ATTR_USERSPACE arg. */
182 OVS_PACKET_ATTR_EGRESS_TUN_KEY, /* Nested OVS_TUNNEL_KEY_ATTR_*
184 OVS_PACKET_ATTR_UNUSED1,
185 OVS_PACKET_ATTR_UNUSED2,
186 OVS_PACKET_ATTR_PROBE, /* Packet operation is a feature probe,
187 error logging should be suppressed. */
188 OVS_PACKET_ATTR_MRU, /* Maximum received IP fragment size. */
189 OVS_PACKET_ATTR_LEN, /* Packet size before truncation. */
190 __OVS_PACKET_ATTR_MAX
193 #define OVS_PACKET_ATTR_MAX (__OVS_PACKET_ATTR_MAX - 1)
197 #define OVS_VPORT_FAMILY "ovs_vport"
198 #define OVS_VPORT_MCGROUP "ovs_vport"
199 #define OVS_VPORT_VERSION 0x1
202 OVS_VPORT_CMD_UNSPEC,
209 enum ovs_vport_type {
210 OVS_VPORT_TYPE_UNSPEC,
211 OVS_VPORT_TYPE_NETDEV, /* network device */
212 OVS_VPORT_TYPE_INTERNAL, /* network device implemented by datapath */
213 OVS_VPORT_TYPE_GRE, /* GRE tunnel. */
214 OVS_VPORT_TYPE_VXLAN, /* VXLAN tunnel. */
215 OVS_VPORT_TYPE_GENEVE, /* Geneve tunnel. */
219 #define OVS_VPORT_TYPE_MAX (__OVS_VPORT_TYPE_MAX - 1)
222 * enum ovs_vport_attr - attributes for %OVS_VPORT_* commands.
223 * @OVS_VPORT_ATTR_PORT_NO: 32-bit port number within datapath.
224 * @OVS_VPORT_ATTR_TYPE: 32-bit %OVS_VPORT_TYPE_* constant describing the type
226 * @OVS_VPORT_ATTR_NAME: Name of vport. For a vport based on a network device
227 * this is the name of the network device. Maximum length %IFNAMSIZ-1 bytes
228 * plus a null terminator.
229 * @OVS_VPORT_ATTR_OPTIONS: Vport-specific configuration information.
230 * @OVS_VPORT_ATTR_UPCALL_PID: The array of Netlink socket pids in userspace
231 * among which OVS_PACKET_CMD_MISS upcalls will be distributed for packets
232 * received on this port. If this is a single-element array of value 0,
233 * upcalls should not be sent.
234 * @OVS_VPORT_ATTR_STATS: A &struct ovs_vport_stats giving statistics for
235 * packets sent or received through the vport.
237 * These attributes follow the &struct ovs_header within the Generic Netlink
238 * payload for %OVS_VPORT_* commands.
240 * For %OVS_VPORT_CMD_NEW requests, the %OVS_VPORT_ATTR_TYPE and
241 * %OVS_VPORT_ATTR_NAME attributes are required. %OVS_VPORT_ATTR_PORT_NO is
242 * optional; if not specified a free port number is automatically selected.
243 * Whether %OVS_VPORT_ATTR_OPTIONS is required or optional depends on the type
246 * For other requests, if %OVS_VPORT_ATTR_NAME is specified then it is used to
247 * look up the vport to operate on; otherwise dp_idx from the &struct
248 * ovs_header plus %OVS_VPORT_ATTR_PORT_NO determine the vport.
250 enum ovs_vport_attr {
251 OVS_VPORT_ATTR_UNSPEC,
252 OVS_VPORT_ATTR_PORT_NO, /* u32 port number within datapath */
253 OVS_VPORT_ATTR_TYPE, /* u32 OVS_VPORT_TYPE_* constant. */
254 OVS_VPORT_ATTR_NAME, /* string name, up to IFNAMSIZ bytes long */
255 OVS_VPORT_ATTR_OPTIONS, /* nested attributes, varies by vport type */
256 OVS_VPORT_ATTR_UPCALL_PID, /* array of u32 Netlink socket PIDs for */
257 /* receiving upcalls */
258 OVS_VPORT_ATTR_STATS, /* struct ovs_vport_stats */
263 #define OVS_VPORT_ATTR_MAX (__OVS_VPORT_ATTR_MAX - 1)
266 OVS_VXLAN_EXT_UNSPEC,
267 OVS_VXLAN_EXT_GBP, /* Flag or __u32 */
271 #define OVS_VXLAN_EXT_MAX (__OVS_VXLAN_EXT_MAX - 1)
274 /* OVS_VPORT_ATTR_OPTIONS attributes for tunnels.
277 OVS_TUNNEL_ATTR_UNSPEC,
278 OVS_TUNNEL_ATTR_DST_PORT, /* 16-bit UDP port, used by L4 tunnels. */
279 OVS_TUNNEL_ATTR_EXTENSION,
280 __OVS_TUNNEL_ATTR_MAX
283 #define OVS_TUNNEL_ATTR_MAX (__OVS_TUNNEL_ATTR_MAX - 1)
287 #define OVS_FLOW_FAMILY "ovs_flow"
288 #define OVS_FLOW_MCGROUP "ovs_flow"
289 #define OVS_FLOW_VERSION 0x1
299 struct ovs_flow_stats {
300 __u64 n_packets; /* Number of matched packets. */
301 __u64 n_bytes; /* Number of matched bytes. */
306 OVS_KEY_ATTR_ENCAP, /* Nested set of encapsulated attributes. */
307 OVS_KEY_ATTR_PRIORITY, /* u32 skb->priority */
308 OVS_KEY_ATTR_IN_PORT, /* u32 OVS dp port number */
309 OVS_KEY_ATTR_ETHERNET, /* struct ovs_key_ethernet */
310 OVS_KEY_ATTR_VLAN, /* be16 VLAN TCI */
311 OVS_KEY_ATTR_ETHERTYPE, /* be16 Ethernet type */
312 OVS_KEY_ATTR_IPV4, /* struct ovs_key_ipv4 */
313 OVS_KEY_ATTR_IPV6, /* struct ovs_key_ipv6 */
314 OVS_KEY_ATTR_TCP, /* struct ovs_key_tcp */
315 OVS_KEY_ATTR_UDP, /* struct ovs_key_udp */
316 OVS_KEY_ATTR_ICMP, /* struct ovs_key_icmp */
317 OVS_KEY_ATTR_ICMPV6, /* struct ovs_key_icmpv6 */
318 OVS_KEY_ATTR_ARP, /* struct ovs_key_arp */
319 OVS_KEY_ATTR_ND, /* struct ovs_key_nd */
320 OVS_KEY_ATTR_SKB_MARK, /* u32 skb mark */
321 OVS_KEY_ATTR_TUNNEL, /* Nested set of ovs_tunnel attributes */
322 OVS_KEY_ATTR_SCTP, /* struct ovs_key_sctp */
323 OVS_KEY_ATTR_TCP_FLAGS, /* be16 TCP flags. */
324 OVS_KEY_ATTR_DP_HASH, /* u32 hash value. Value 0 indicates the hash
325 is not computed by the datapath. */
326 OVS_KEY_ATTR_RECIRC_ID, /* u32 recirc id */
327 OVS_KEY_ATTR_MPLS, /* array of struct ovs_key_mpls.
328 * The implementation may restrict
329 * the accepted length of the array. */
330 OVS_KEY_ATTR_CT_STATE, /* u32 bitmask of OVS_CS_F_* */
331 OVS_KEY_ATTR_CT_ZONE, /* u16 connection tracking zone. */
332 OVS_KEY_ATTR_CT_MARK, /* u32 connection tracking mark */
333 OVS_KEY_ATTR_CT_LABELS, /* 16-octet connection tracking label */
334 OVS_KEY_ATTR_CT_ORIG_TUPLE_IPV4, /* struct ovs_key_ct_tuple_ipv4 */
335 OVS_KEY_ATTR_CT_ORIG_TUPLE_IPV6, /* struct ovs_key_ct_tuple_ipv6 */
338 OVS_KEY_ATTR_TUNNEL_INFO, /* struct ip_tunnel_info */
343 #define OVS_KEY_ATTR_MAX (__OVS_KEY_ATTR_MAX - 1)
345 enum ovs_tunnel_key_attr {
346 OVS_TUNNEL_KEY_ATTR_ID, /* be64 Tunnel ID */
347 OVS_TUNNEL_KEY_ATTR_IPV4_SRC, /* be32 src IP address. */
348 OVS_TUNNEL_KEY_ATTR_IPV4_DST, /* be32 dst IP address. */
349 OVS_TUNNEL_KEY_ATTR_TOS, /* u8 Tunnel IP ToS. */
350 OVS_TUNNEL_KEY_ATTR_TTL, /* u8 Tunnel IP TTL. */
351 OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT, /* No argument, set DF. */
352 OVS_TUNNEL_KEY_ATTR_CSUM, /* No argument. CSUM packet. */
353 OVS_TUNNEL_KEY_ATTR_OAM, /* No argument. OAM frame. */
354 OVS_TUNNEL_KEY_ATTR_GENEVE_OPTS, /* Array of Geneve options. */
355 OVS_TUNNEL_KEY_ATTR_TP_SRC, /* be16 src Transport Port. */
356 OVS_TUNNEL_KEY_ATTR_TP_DST, /* be16 dst Transport Port. */
357 OVS_TUNNEL_KEY_ATTR_VXLAN_OPTS, /* Nested OVS_VXLAN_EXT_* */
358 OVS_TUNNEL_KEY_ATTR_IPV6_SRC, /* struct in6_addr src IPv6 address. */
359 OVS_TUNNEL_KEY_ATTR_IPV6_DST, /* struct in6_addr dst IPv6 address. */
360 OVS_TUNNEL_KEY_ATTR_PAD,
361 __OVS_TUNNEL_KEY_ATTR_MAX
364 #define OVS_TUNNEL_KEY_ATTR_MAX (__OVS_TUNNEL_KEY_ATTR_MAX - 1)
367 * enum ovs_frag_type - IPv4 and IPv6 fragment type
368 * @OVS_FRAG_TYPE_NONE: Packet is not a fragment.
369 * @OVS_FRAG_TYPE_FIRST: Packet is a fragment with offset 0.
370 * @OVS_FRAG_TYPE_LATER: Packet is a fragment with nonzero offset.
372 * Used as the @ipv4_frag in &struct ovs_key_ipv4 and as @ipv6_frag &struct
382 #define OVS_FRAG_TYPE_MAX (__OVS_FRAG_TYPE_MAX - 1)
384 struct ovs_key_ethernet {
385 __u8 eth_src[ETH_ALEN];
386 __u8 eth_dst[ETH_ALEN];
389 struct ovs_key_mpls {
393 struct ovs_key_ipv4 {
399 __u8 ipv4_frag; /* One of OVS_FRAG_TYPE_*. */
402 struct ovs_key_ipv6 {
405 __be32 ipv6_label; /* 20-bits in least-significant bits. */
409 __u8 ipv6_frag; /* One of OVS_FRAG_TYPE_*. */
422 struct ovs_key_sctp {
427 struct ovs_key_icmp {
432 struct ovs_key_icmpv6 {
441 __u8 arp_sha[ETH_ALEN];
442 __u8 arp_tha[ETH_ALEN];
447 __u8 nd_sll[ETH_ALEN];
448 __u8 nd_tll[ETH_ALEN];
451 #define OVS_CT_LABELS_LEN_32 4
452 #define OVS_CT_LABELS_LEN (OVS_CT_LABELS_LEN_32 * sizeof(__u32))
453 struct ovs_key_ct_labels {
455 __u8 ct_labels[OVS_CT_LABELS_LEN];
456 __u32 ct_labels_32[OVS_CT_LABELS_LEN_32];
460 /* OVS_KEY_ATTR_CT_STATE flags */
461 #define OVS_CS_F_NEW 0x01 /* Beginning of a new connection. */
462 #define OVS_CS_F_ESTABLISHED 0x02 /* Part of an existing connection. */
463 #define OVS_CS_F_RELATED 0x04 /* Related to an established
465 #define OVS_CS_F_REPLY_DIR 0x08 /* Flow is in the reply direction. */
466 #define OVS_CS_F_INVALID 0x10 /* Could not track connection. */
467 #define OVS_CS_F_TRACKED 0x20 /* Conntrack has occurred. */
468 #define OVS_CS_F_SRC_NAT 0x40 /* Packet's source address/port was
471 #define OVS_CS_F_DST_NAT 0x80 /* Packet's destination address/port
472 * was mangled by NAT.
475 #define OVS_CS_F_NAT_MASK (OVS_CS_F_SRC_NAT | OVS_CS_F_DST_NAT)
477 struct ovs_key_ct_tuple_ipv4 {
485 struct ovs_key_ct_tuple_ipv6 {
494 * enum ovs_flow_attr - attributes for %OVS_FLOW_* commands.
495 * @OVS_FLOW_ATTR_KEY: Nested %OVS_KEY_ATTR_* attributes specifying the flow
496 * key. Always present in notifications. Required for all requests (except
498 * @OVS_FLOW_ATTR_ACTIONS: Nested %OVS_ACTION_ATTR_* attributes specifying
499 * the actions to take for packets that match the key. Always present in
500 * notifications. Required for %OVS_FLOW_CMD_NEW requests, optional for
501 * %OVS_FLOW_CMD_SET requests. An %OVS_FLOW_CMD_SET without
502 * %OVS_FLOW_ATTR_ACTIONS will not modify the actions. To clear the actions,
503 * an %OVS_FLOW_ATTR_ACTIONS without any nested attributes must be given.
504 * @OVS_FLOW_ATTR_STATS: &struct ovs_flow_stats giving statistics for this
505 * flow. Present in notifications if the stats would be nonzero. Ignored in
507 * @OVS_FLOW_ATTR_TCP_FLAGS: An 8-bit value giving the OR'd value of all of the
508 * TCP flags seen on packets in this flow. Only present in notifications for
509 * TCP flows, and only if it would be nonzero. Ignored in requests.
510 * @OVS_FLOW_ATTR_USED: A 64-bit integer giving the time, in milliseconds on
511 * the system monotonic clock, at which a packet was last processed for this
512 * flow. Only present in notifications if a packet has been processed for this
513 * flow. Ignored in requests.
514 * @OVS_FLOW_ATTR_CLEAR: If present in a %OVS_FLOW_CMD_SET request, clears the
515 * last-used time, accumulated TCP flags, and statistics for this flow.
516 * Otherwise ignored in requests. Never present in notifications.
517 * @OVS_FLOW_ATTR_MASK: Nested %OVS_KEY_ATTR_* attributes specifying the
518 * mask bits for wildcarded flow match. Mask bit value '1' specifies exact
519 * match with corresponding flow key bit, while mask bit value '0' specifies
520 * a wildcarded match. Omitting attribute is treated as wildcarding all
521 * corresponding fields. Optional for all requests. If not present,
522 * all flow key bits are exact match bits.
523 * @OVS_FLOW_ATTR_UFID: A value between 1-16 octets specifying a unique
524 * identifier for the flow. Causes the flow to be indexed by this value rather
525 * than the value of the %OVS_FLOW_ATTR_KEY attribute. Optional for all
526 * requests. Present in notifications if the flow was created with this
528 * @OVS_FLOW_ATTR_UFID_FLAGS: A 32-bit value of OR'd %OVS_UFID_F_*
529 * flags that provide alternative semantics for flow installation and
530 * retrieval. Optional for all requests.
532 * These attributes follow the &struct ovs_header within the Generic Netlink
533 * payload for %OVS_FLOW_* commands.
536 OVS_FLOW_ATTR_UNSPEC,
537 OVS_FLOW_ATTR_KEY, /* Sequence of OVS_KEY_ATTR_* attributes. */
538 OVS_FLOW_ATTR_ACTIONS, /* Nested OVS_ACTION_ATTR_* attributes. */
539 OVS_FLOW_ATTR_STATS, /* struct ovs_flow_stats. */
540 OVS_FLOW_ATTR_TCP_FLAGS, /* 8-bit OR'd TCP flags. */
541 OVS_FLOW_ATTR_USED, /* u64 msecs last used in monotonic time. */
542 OVS_FLOW_ATTR_CLEAR, /* Flag to clear stats, tcp_flags, used. */
543 OVS_FLOW_ATTR_MASK, /* Sequence of OVS_KEY_ATTR_* attributes. */
544 OVS_FLOW_ATTR_PROBE, /* Flow operation is a feature probe, error
545 * logging should be suppressed. */
546 OVS_FLOW_ATTR_UFID, /* Variable length unique flow identifier. */
547 OVS_FLOW_ATTR_UFID_FLAGS,/* u32 of OVS_UFID_F_*. */
552 #define OVS_FLOW_ATTR_MAX (__OVS_FLOW_ATTR_MAX - 1)
555 * Omit attributes for notifications.
557 * If a datapath request contains an %OVS_UFID_F_OMIT_* flag, then the datapath
558 * may omit the corresponding %OVS_FLOW_ATTR_* from the response.
560 #define OVS_UFID_F_OMIT_KEY (1 << 0)
561 #define OVS_UFID_F_OMIT_MASK (1 << 1)
562 #define OVS_UFID_F_OMIT_ACTIONS (1 << 2)
565 * enum ovs_sample_attr - Attributes for %OVS_ACTION_ATTR_SAMPLE action.
566 * @OVS_SAMPLE_ATTR_PROBABILITY: 32-bit fraction of packets to sample with
567 * @OVS_ACTION_ATTR_SAMPLE. A value of 0 samples no packets, a value of
568 * %UINT32_MAX samples all packets and intermediate values sample intermediate
569 * fractions of packets.
570 * @OVS_SAMPLE_ATTR_ACTIONS: Set of actions to execute in sampling event.
571 * Actions are passed as nested attributes.
573 * Executes the specified actions with the given probability on a per-packet
576 enum ovs_sample_attr {
577 OVS_SAMPLE_ATTR_UNSPEC,
578 OVS_SAMPLE_ATTR_PROBABILITY, /* u32 number */
579 OVS_SAMPLE_ATTR_ACTIONS, /* Nested OVS_ACTION_ATTR_* attributes. */
580 __OVS_SAMPLE_ATTR_MAX,
583 OVS_SAMPLE_ATTR_ARG /* struct sample_arg */
587 #define OVS_SAMPLE_ATTR_MAX (__OVS_SAMPLE_ATTR_MAX - 1)
591 bool exec; /* When true, actions in sample will not
592 * change flow keys. False otherwise.
594 u32 probability; /* Same value as
595 * 'OVS_SAMPLE_ATTR_PROBABILITY'.
601 * enum ovs_userspace_attr - Attributes for %OVS_ACTION_ATTR_USERSPACE action.
602 * @OVS_USERSPACE_ATTR_PID: u32 Netlink PID to which the %OVS_PACKET_CMD_ACTION
603 * message should be sent. Required.
604 * @OVS_USERSPACE_ATTR_USERDATA: If present, its variable-length argument is
605 * copied to the %OVS_PACKET_CMD_ACTION message as %OVS_PACKET_ATTR_USERDATA.
606 * @OVS_USERSPACE_ATTR_EGRESS_TUN_PORT: If present, u32 output port to get
608 * @OVS_USERSPACE_ATTR_ACTIONS: If present, send actions with upcall.
610 enum ovs_userspace_attr {
611 OVS_USERSPACE_ATTR_UNSPEC,
612 OVS_USERSPACE_ATTR_PID, /* u32 Netlink PID to receive upcalls. */
613 OVS_USERSPACE_ATTR_USERDATA, /* Optional user-specified cookie. */
614 OVS_USERSPACE_ATTR_EGRESS_TUN_PORT, /* Optional, u32 output port
615 * to get tunnel info. */
616 OVS_USERSPACE_ATTR_ACTIONS, /* Optional flag to get actions. */
617 __OVS_USERSPACE_ATTR_MAX
620 #define OVS_USERSPACE_ATTR_MAX (__OVS_USERSPACE_ATTR_MAX - 1)
622 struct ovs_action_trunc {
623 __u32 max_len; /* Max packet size in bytes. */
627 * struct ovs_action_push_mpls - %OVS_ACTION_ATTR_PUSH_MPLS action argument.
628 * @mpls_lse: MPLS label stack entry to push.
629 * @mpls_ethertype: Ethertype to set in the encapsulating ethernet frame.
631 * The only values @mpls_ethertype should ever be given are %ETH_P_MPLS_UC and
632 * %ETH_P_MPLS_MC, indicating MPLS unicast or multicast. Other are rejected.
634 struct ovs_action_push_mpls {
636 __be16 mpls_ethertype; /* Either %ETH_P_MPLS_UC or %ETH_P_MPLS_MC */
640 * struct ovs_action_push_vlan - %OVS_ACTION_ATTR_PUSH_VLAN action argument.
641 * @vlan_tpid: Tag protocol identifier (TPID) to push.
642 * @vlan_tci: Tag control identifier (TCI) to push. The CFI bit must be set
643 * (but it will not be set in the 802.1Q header that is pushed).
645 * The @vlan_tpid value is typically %ETH_P_8021Q or %ETH_P_8021AD.
646 * The only acceptable TPID values are those that the kernel module also parses
647 * as 802.1Q or 802.1AD headers, to prevent %OVS_ACTION_ATTR_PUSH_VLAN followed
648 * by %OVS_ACTION_ATTR_POP_VLAN from having surprising results.
650 struct ovs_action_push_vlan {
651 __be16 vlan_tpid; /* 802.1Q or 802.1ad TPID. */
652 __be16 vlan_tci; /* 802.1Q TCI (VLAN ID and priority). */
655 /* Data path hash algorithm for computing Datapath hash.
657 * The algorithm type only specifies the fields in a flow
658 * will be used as part of the hash. Each datapath is free
659 * to use its own hash algorithm. The hash value will be
660 * opaque to the user space daemon.
667 * struct ovs_action_hash - %OVS_ACTION_ATTR_HASH action argument.
668 * @hash_alg: Algorithm used to compute hash prior to recirculation.
669 * @hash_basis: basis used for computing hash.
671 struct ovs_action_hash {
672 __u32 hash_alg; /* One of ovs_hash_alg. */
677 * enum ovs_ct_attr - Attributes for %OVS_ACTION_ATTR_CT action.
678 * @OVS_CT_ATTR_COMMIT: If present, commits the connection to the conntrack
679 * table. This allows future packets for the same connection to be identified
680 * as 'established' or 'related'. The flow key for the current packet will
681 * retain the pre-commit connection state.
682 * @OVS_CT_ATTR_ZONE: u16 connection tracking zone.
683 * @OVS_CT_ATTR_MARK: u32 value followed by u32 mask. For each bit set in the
684 * mask, the corresponding bit in the value is copied to the connection
685 * tracking mark field in the connection.
686 * @OVS_CT_ATTR_LABELS: %OVS_CT_LABELS_LEN value followed by %OVS_CT_LABELS_LEN
687 * mask. For each bit set in the mask, the corresponding bit in the value is
688 * copied to the connection tracking label field in the connection.
689 * @OVS_CT_ATTR_HELPER: variable length string defining conntrack ALG.
690 * @OVS_CT_ATTR_NAT: Nested OVS_NAT_ATTR_* for performing L3 network address
691 * translation (NAT) on the packet.
692 * @OVS_CT_ATTR_FORCE_COMMIT: Like %OVS_CT_ATTR_COMMIT, but instead of doing
693 * nothing if the connection is already committed will check that the current
694 * packet is in conntrack entry's original direction. If directionality does
695 * not match, will delete the existing conntrack entry and commit a new one.
696 * @OVS_CT_ATTR_EVENTMASK: Mask of bits indicating which conntrack event types
697 * (enum ip_conntrack_events IPCT_*) should be reported. For any bit set to
698 * zero, the corresponding event type is not generated. Default behavior
699 * depends on system configuration, but typically all event types are
700 * generated, hence listening on NFNLGRP_CONNTRACK_UPDATE events may get a lot
701 * of events. Explicitly passing this attribute allows limiting the updates
702 * received to the events of interest. The bit 1 << IPCT_NEW, 1 <<
703 * IPCT_RELATED, and 1 << IPCT_DESTROY must be set to ones for those events to
704 * be received on NFNLGRP_CONNTRACK_NEW and NFNLGRP_CONNTRACK_DESTROY groups,
705 * respectively. Remaining bits control the changes for which an event is
706 * delivered on the NFNLGRP_CONNTRACK_UPDATE group.
710 OVS_CT_ATTR_COMMIT, /* No argument, commits connection. */
711 OVS_CT_ATTR_ZONE, /* u16 zone id. */
712 OVS_CT_ATTR_MARK, /* mark to associate with this connection. */
713 OVS_CT_ATTR_LABELS, /* labels to associate with this connection. */
714 OVS_CT_ATTR_HELPER, /* netlink helper to assist detection of
715 related connections. */
716 OVS_CT_ATTR_NAT, /* Nested OVS_NAT_ATTR_* */
717 OVS_CT_ATTR_FORCE_COMMIT, /* No argument */
718 OVS_CT_ATTR_EVENTMASK, /* u32 mask of IPCT_* events. */
722 #define OVS_CT_ATTR_MAX (__OVS_CT_ATTR_MAX - 1)
725 * enum ovs_nat_attr - Attributes for %OVS_CT_ATTR_NAT.
727 * @OVS_NAT_ATTR_SRC: Flag for Source NAT (mangle source address/port).
728 * @OVS_NAT_ATTR_DST: Flag for Destination NAT (mangle destination
729 * address/port). Only one of (@OVS_NAT_ATTR_SRC, @OVS_NAT_ATTR_DST) may be
730 * specified. Effective only for packets for ct_state NEW connections.
731 * Packets of committed connections are mangled by the NAT action according to
732 * the committed NAT type regardless of the flags specified. As a corollary, a
733 * NAT action without a NAT type flag will only mangle packets of committed
734 * connections. The following NAT attributes only apply for NEW
735 * (non-committed) connections, and they may be included only when the CT
736 * action has the @OVS_CT_ATTR_COMMIT flag and either @OVS_NAT_ATTR_SRC or
737 * @OVS_NAT_ATTR_DST is also included.
738 * @OVS_NAT_ATTR_IP_MIN: struct in_addr or struct in6_addr
739 * @OVS_NAT_ATTR_IP_MAX: struct in_addr or struct in6_addr
740 * @OVS_NAT_ATTR_PROTO_MIN: u16 L4 protocol specific lower boundary (port)
741 * @OVS_NAT_ATTR_PROTO_MAX: u16 L4 protocol specific upper boundary (port)
742 * @OVS_NAT_ATTR_PERSISTENT: Flag for persistent IP mapping across reboots
743 * @OVS_NAT_ATTR_PROTO_HASH: Flag for pseudo random L4 port mapping (MD5)
744 * @OVS_NAT_ATTR_PROTO_RANDOM: Flag for fully randomized L4 port mapping
752 OVS_NAT_ATTR_PROTO_MIN,
753 OVS_NAT_ATTR_PROTO_MAX,
754 OVS_NAT_ATTR_PERSISTENT,
755 OVS_NAT_ATTR_PROTO_HASH,
756 OVS_NAT_ATTR_PROTO_RANDOM,
760 #define OVS_NAT_ATTR_MAX (__OVS_NAT_ATTR_MAX - 1)
763 * struct ovs_action_push_eth - %OVS_ACTION_ATTR_PUSH_ETH action argument.
764 * @addresses: Source and destination MAC addresses.
765 * @eth_type: Ethernet type
767 struct ovs_action_push_eth {
768 struct ovs_key_ethernet addresses;
772 * enum ovs_action_attr - Action types.
774 * @OVS_ACTION_ATTR_OUTPUT: Output packet to port.
775 * @OVS_ACTION_ATTR_TRUNC: Output packet to port with truncated packet size.
776 * @OVS_ACTION_ATTR_USERSPACE: Send packet to userspace according to nested
777 * %OVS_USERSPACE_ATTR_* attributes.
778 * @OVS_ACTION_ATTR_SET: Replaces the contents of an existing header. The
779 * single nested %OVS_KEY_ATTR_* attribute specifies a header to modify and its
781 * @OVS_ACTION_ATTR_SET_MASKED: Replaces the contents of an existing header. A
782 * nested %OVS_KEY_ATTR_* attribute specifies a header to modify, its value,
783 * and a mask. For every bit set in the mask, the corresponding bit value
784 * is copied from the value to the packet header field, rest of the bits are
785 * left unchanged. The non-masked value bits must be passed in as zeroes.
786 * Masking is not supported for the %OVS_KEY_ATTR_TUNNEL attribute.
787 * @OVS_ACTION_ATTR_PUSH_VLAN: Push a new outermost 802.1Q or 802.1ad header
789 * @OVS_ACTION_ATTR_POP_VLAN: Pop the outermost 802.1Q or 802.1ad header
791 * @OVS_ACTION_ATTR_SAMPLE: Probabilitically executes actions, as specified in
792 * the nested %OVS_SAMPLE_ATTR_* attributes.
793 * @OVS_ACTION_ATTR_PUSH_MPLS: Push a new MPLS label stack entry onto the
794 * top of the packets MPLS label stack. Set the ethertype of the
795 * encapsulating frame to either %ETH_P_MPLS_UC or %ETH_P_MPLS_MC to
796 * indicate the new packet contents.
797 * @OVS_ACTION_ATTR_POP_MPLS: Pop an MPLS label stack entry off of the
798 * packet's MPLS label stack. Set the encapsulating frame's ethertype to
799 * indicate the new packet contents. This could potentially still be
800 * %ETH_P_MPLS if the resulting MPLS label stack is not empty. If there
801 * is no MPLS label stack, as determined by ethertype, no action is taken.
802 * @OVS_ACTION_ATTR_CT: Track the connection. Populate the conntrack-related
803 * entries in the flow key.
804 * @OVS_ACTION_ATTR_PUSH_ETH: Push a new outermost Ethernet header onto the
806 * @OVS_ACTION_ATTR_POP_ETH: Pop the outermost Ethernet header off the
809 * Only a single header can be set with a single %OVS_ACTION_ATTR_SET. Not all
810 * fields within a header are modifiable, e.g. the IPv4 protocol and fragment
811 * type may not be changed.
813 * @OVS_ACTION_ATTR_SET_TO_MASKED: Kernel internal masked set action translated
814 * from the @OVS_ACTION_ATTR_SET.
817 enum ovs_action_attr {
818 OVS_ACTION_ATTR_UNSPEC,
819 OVS_ACTION_ATTR_OUTPUT, /* u32 port number. */
820 OVS_ACTION_ATTR_USERSPACE, /* Nested OVS_USERSPACE_ATTR_*. */
821 OVS_ACTION_ATTR_SET, /* One nested OVS_KEY_ATTR_*. */
822 OVS_ACTION_ATTR_PUSH_VLAN, /* struct ovs_action_push_vlan. */
823 OVS_ACTION_ATTR_POP_VLAN, /* No argument. */
824 OVS_ACTION_ATTR_SAMPLE, /* Nested OVS_SAMPLE_ATTR_*. */
825 OVS_ACTION_ATTR_RECIRC, /* u32 recirc_id. */
826 OVS_ACTION_ATTR_HASH, /* struct ovs_action_hash. */
827 OVS_ACTION_ATTR_PUSH_MPLS, /* struct ovs_action_push_mpls. */
828 OVS_ACTION_ATTR_POP_MPLS, /* __be16 ethertype. */
829 OVS_ACTION_ATTR_SET_MASKED, /* One nested OVS_KEY_ATTR_* including
830 * data immediately followed by a mask.
831 * The data must be zero for the unmasked
833 OVS_ACTION_ATTR_CT, /* Nested OVS_CT_ATTR_* . */
834 OVS_ACTION_ATTR_TRUNC, /* u32 struct ovs_action_trunc. */
835 OVS_ACTION_ATTR_PUSH_ETH, /* struct ovs_action_push_eth. */
836 OVS_ACTION_ATTR_POP_ETH, /* No argument. */
838 __OVS_ACTION_ATTR_MAX, /* Nothing past this will be accepted
842 OVS_ACTION_ATTR_SET_TO_MASKED, /* Kernel module internal masked
843 * set action converted from
844 * OVS_ACTION_ATTR_SET. */
848 #define OVS_ACTION_ATTR_MAX (__OVS_ACTION_ATTR_MAX - 1)
850 #endif /* _LINUX_OPENVSWITCH_H */