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