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