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