1 2 /* 3 * Copyright (c) 2007-2013 Nicira, Inc. 4 * 5 * This program is free software; you can redistribute it and/or 6 * modify it under the terms of version 2 of the GNU General Public 7 * License as published by the Free Software Foundation. 8 * 9 * This program is distributed in the hope that it will be useful, but 10 * WITHOUT ANY WARRANTY; without even the implied warranty of 11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 12 * General Public License for more details. 13 * 14 * You should have received a copy of the GNU General Public License 15 * along with this program; if not, write to the Free Software 16 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 17 * 02110-1301, USA 18 */ 19 20 #ifndef _UAPI__LINUX_OPENVSWITCH_H 21 #define _UAPI__LINUX_OPENVSWITCH_H 1 22 23 #include <linux/types.h> 24 #include <linux/if_ether.h> 25 26 /** 27 * struct ovs_header - header for OVS Generic Netlink messages. 28 * @dp_ifindex: ifindex of local port for datapath (0 to make a request not 29 * specific to a datapath). 30 * 31 * Attributes following the header are specific to a particular OVS Generic 32 * Netlink family, but all of the OVS families use this header. 33 */ 34 35 struct ovs_header { 36 int dp_ifindex; 37 }; 38 39 /* Datapaths. */ 40 41 #define OVS_DATAPATH_FAMILY "ovs_datapath" 42 #define OVS_DATAPATH_MCGROUP "ovs_datapath" 43 44 /* V2: 45 * - API users are expected to provide OVS_DP_ATTR_USER_FEATURES 46 * when creating the datapath. 47 */ 48 #define OVS_DATAPATH_VERSION 2 49 50 /* First OVS datapath version to support features */ 51 #define OVS_DP_VER_FEATURES 2 52 53 enum ovs_datapath_cmd { 54 OVS_DP_CMD_UNSPEC, 55 OVS_DP_CMD_NEW, 56 OVS_DP_CMD_DEL, 57 OVS_DP_CMD_GET, 58 OVS_DP_CMD_SET 59 }; 60 61 /** 62 * enum ovs_datapath_attr - attributes for %OVS_DP_* commands. 63 * @OVS_DP_ATTR_NAME: Name of the network device that serves as the "local 64 * port". This is the name of the network device whose dp_ifindex is given in 65 * the &struct ovs_header. Always present in notifications. Required in 66 * %OVS_DP_NEW requests. May be used as an alternative to specifying 67 * dp_ifindex in other requests (with a dp_ifindex of 0). 68 * @OVS_DP_ATTR_UPCALL_PID: The Netlink socket in userspace that is initially 69 * set on the datapath port (for OVS_ACTION_ATTR_MISS). Only valid on 70 * %OVS_DP_CMD_NEW requests. A value of zero indicates that upcalls should 71 * not be sent. 72 * @OVS_DP_ATTR_STATS: Statistics about packets that have passed through the 73 * datapath. Always present in notifications. 74 * @OVS_DP_ATTR_MEGAFLOW_STATS: Statistics about mega flow masks usage for the 75 * datapath. Always present in notifications. 76 * 77 * These attributes follow the &struct ovs_header within the Generic Netlink 78 * payload for %OVS_DP_* commands. 79 */ 80 enum ovs_datapath_attr { 81 OVS_DP_ATTR_UNSPEC, 82 OVS_DP_ATTR_NAME, /* name of dp_ifindex netdev */ 83 OVS_DP_ATTR_UPCALL_PID, /* Netlink PID to receive upcalls */ 84 OVS_DP_ATTR_STATS, /* struct ovs_dp_stats */ 85 OVS_DP_ATTR_MEGAFLOW_STATS, /* struct ovs_dp_megaflow_stats */ 86 OVS_DP_ATTR_USER_FEATURES, /* OVS_DP_F_* */ 87 __OVS_DP_ATTR_MAX 88 }; 89 90 #define OVS_DP_ATTR_MAX (__OVS_DP_ATTR_MAX - 1) 91 92 struct ovs_dp_stats { 93 __u64 n_hit; /* Number of flow table matches. */ 94 __u64 n_missed; /* Number of flow table misses. */ 95 __u64 n_lost; /* Number of misses not sent to userspace. */ 96 __u64 n_flows; /* Number of flows present */ 97 }; 98 99 struct ovs_dp_megaflow_stats { 100 __u64 n_mask_hit; /* Number of masks used for flow lookups. */ 101 __u32 n_masks; /* Number of masks for the datapath. */ 102 __u32 pad0; /* Pad for future expension. */ 103 __u64 pad1; /* Pad for future expension. */ 104 __u64 pad2; /* Pad for future expension. */ 105 }; 106 107 struct ovs_vport_stats { 108 __u64 rx_packets; /* total packets received */ 109 __u64 tx_packets; /* total packets transmitted */ 110 __u64 rx_bytes; /* total bytes received */ 111 __u64 tx_bytes; /* total bytes transmitted */ 112 __u64 rx_errors; /* bad packets received */ 113 __u64 tx_errors; /* packet transmit problems */ 114 __u64 rx_dropped; /* no space in linux buffers */ 115 __u64 tx_dropped; /* no space available in linux */ 116 }; 117 118 /* Allow last Netlink attribute to be unaligned */ 119 #define OVS_DP_F_UNALIGNED (1 << 0) 120 121 /* Allow datapath to associate multiple Netlink PIDs to each vport */ 122 #define OVS_DP_F_VPORT_PIDS (1 << 1) 123 124 /* Fixed logical ports. */ 125 #define OVSP_LOCAL ((__u32)0) 126 127 /* Packet transfer. */ 128 129 #define OVS_PACKET_FAMILY "ovs_packet" 130 #define OVS_PACKET_VERSION 0x1 131 132 enum ovs_packet_cmd { 133 OVS_PACKET_CMD_UNSPEC, 134 135 /* Kernel-to-user notifications. */ 136 OVS_PACKET_CMD_MISS, /* Flow table miss. */ 137 OVS_PACKET_CMD_ACTION, /* OVS_ACTION_ATTR_USERSPACE action. */ 138 139 /* Userspace commands. */ 140 OVS_PACKET_CMD_EXECUTE /* Apply actions to a packet. */ 141 }; 142 143 /** 144 * enum ovs_packet_attr - attributes for %OVS_PACKET_* commands. 145 * @OVS_PACKET_ATTR_PACKET: Present for all notifications. Contains the entire 146 * packet as received, from the start of the Ethernet header onward. For 147 * %OVS_PACKET_CMD_ACTION, %OVS_PACKET_ATTR_PACKET reflects changes made by 148 * actions preceding %OVS_ACTION_ATTR_USERSPACE, but %OVS_PACKET_ATTR_KEY is 149 * the flow key extracted from the packet as originally received. 150 * @OVS_PACKET_ATTR_KEY: Present for all notifications. Contains the flow key 151 * extracted from the packet as nested %OVS_KEY_ATTR_* attributes. This allows 152 * userspace to adapt its flow setup strategy by comparing its notion of the 153 * flow key against the kernel's. 154 * @OVS_PACKET_ATTR_ACTIONS: Contains actions for the packet. Used 155 * for %OVS_PACKET_CMD_EXECUTE. It has nested %OVS_ACTION_ATTR_* attributes. 156 * @OVS_PACKET_ATTR_USERDATA: Present for an %OVS_PACKET_CMD_ACTION 157 * notification if the %OVS_ACTION_ATTR_USERSPACE action specified an 158 * %OVS_USERSPACE_ATTR_USERDATA attribute, with the same length and content 159 * specified there. 160 * @OVS_PACKET_ATTR_EGRESS_TUN_KEY: Present for an %OVS_PACKET_CMD_ACTION 161 * notification if the %OVS_ACTION_ATTR_USERSPACE action specified an 162 * %OVS_USERSPACE_ATTR_EGRESS_TUN_PORT attribute, which is sent only if the 163 * output port is actually a tunnel port. Contains the output tunnel key 164 * extracted from the packet as nested %OVS_TUNNEL_KEY_ATTR_* attributes. 165 * 166 * These attributes follow the &struct ovs_header within the Generic Netlink 167 * payload for %OVS_PACKET_* commands. 168 */ 169 enum ovs_packet_attr { 170 OVS_PACKET_ATTR_UNSPEC, 171 OVS_PACKET_ATTR_PACKET, /* Packet data. */ 172 OVS_PACKET_ATTR_KEY, /* Nested OVS_KEY_ATTR_* attributes. */ 173 OVS_PACKET_ATTR_ACTIONS, /* Nested OVS_ACTION_ATTR_* attributes. */ 174 OVS_PACKET_ATTR_USERDATA, /* OVS_ACTION_ATTR_USERSPACE arg. */ 175 OVS_PACKET_ATTR_EGRESS_TUN_KEY, /* Nested OVS_TUNNEL_KEY_ATTR_* 176 attributes. */ 177 OVS_PACKET_ATTR_UNUSED1, 178 OVS_PACKET_ATTR_UNUSED2, 179 OVS_PACKET_ATTR_PROBE, /* Packet operation is a feature probe, 180 error logging should be suppressed. */ 181 __OVS_PACKET_ATTR_MAX 182 }; 183 184 #define OVS_PACKET_ATTR_MAX (__OVS_PACKET_ATTR_MAX - 1) 185 186 /* Virtual ports. */ 187 188 #define OVS_VPORT_FAMILY "ovs_vport" 189 #define OVS_VPORT_MCGROUP "ovs_vport" 190 #define OVS_VPORT_VERSION 0x1 191 192 enum ovs_vport_cmd { 193 OVS_VPORT_CMD_UNSPEC, 194 OVS_VPORT_CMD_NEW, 195 OVS_VPORT_CMD_DEL, 196 OVS_VPORT_CMD_GET, 197 OVS_VPORT_CMD_SET 198 }; 199 200 enum ovs_vport_type { 201 OVS_VPORT_TYPE_UNSPEC, 202 OVS_VPORT_TYPE_NETDEV, /* network device */ 203 OVS_VPORT_TYPE_INTERNAL, /* network device implemented by datapath */ 204 OVS_VPORT_TYPE_GRE, /* GRE tunnel. */ 205 OVS_VPORT_TYPE_VXLAN, /* VXLAN tunnel. */ 206 OVS_VPORT_TYPE_GENEVE, /* Geneve tunnel. */ 207 __OVS_VPORT_TYPE_MAX 208 }; 209 210 #define OVS_VPORT_TYPE_MAX (__OVS_VPORT_TYPE_MAX - 1) 211 212 /** 213 * enum ovs_vport_attr - attributes for %OVS_VPORT_* commands. 214 * @OVS_VPORT_ATTR_PORT_NO: 32-bit port number within datapath. 215 * @OVS_VPORT_ATTR_TYPE: 32-bit %OVS_VPORT_TYPE_* constant describing the type 216 * of vport. 217 * @OVS_VPORT_ATTR_NAME: Name of vport. For a vport based on a network device 218 * this is the name of the network device. Maximum length %IFNAMSIZ-1 bytes 219 * plus a null terminator. 220 * @OVS_VPORT_ATTR_OPTIONS: Vport-specific configuration information. 221 * @OVS_VPORT_ATTR_UPCALL_PID: The array of Netlink socket pids in userspace 222 * among which OVS_PACKET_CMD_MISS upcalls will be distributed for packets 223 * received on this port. If this is a single-element array of value 0, 224 * upcalls should not be sent. 225 * @OVS_VPORT_ATTR_STATS: A &struct ovs_vport_stats giving statistics for 226 * packets sent or received through the vport. 227 * 228 * These attributes follow the &struct ovs_header within the Generic Netlink 229 * payload for %OVS_VPORT_* commands. 230 * 231 * For %OVS_VPORT_CMD_NEW requests, the %OVS_VPORT_ATTR_TYPE and 232 * %OVS_VPORT_ATTR_NAME attributes are required. %OVS_VPORT_ATTR_PORT_NO is 233 * optional; if not specified a free port number is automatically selected. 234 * Whether %OVS_VPORT_ATTR_OPTIONS is required or optional depends on the type 235 * of vport. 236 * 237 * For other requests, if %OVS_VPORT_ATTR_NAME is specified then it is used to 238 * look up the vport to operate on; otherwise dp_idx from the &struct 239 * ovs_header plus %OVS_VPORT_ATTR_PORT_NO determine the vport. 240 */ 241 enum ovs_vport_attr { 242 OVS_VPORT_ATTR_UNSPEC, 243 OVS_VPORT_ATTR_PORT_NO, /* u32 port number within datapath */ 244 OVS_VPORT_ATTR_TYPE, /* u32 OVS_VPORT_TYPE_* constant. */ 245 OVS_VPORT_ATTR_NAME, /* string name, up to IFNAMSIZ bytes long */ 246 OVS_VPORT_ATTR_OPTIONS, /* nested attributes, varies by vport type */ 247 OVS_VPORT_ATTR_UPCALL_PID, /* array of u32 Netlink socket PIDs for */ 248 /* receiving upcalls */ 249 OVS_VPORT_ATTR_STATS, /* struct ovs_vport_stats */ 250 __OVS_VPORT_ATTR_MAX 251 }; 252 253 #define OVS_VPORT_ATTR_MAX (__OVS_VPORT_ATTR_MAX - 1) 254 255 enum { 256 OVS_VXLAN_EXT_UNSPEC, 257 OVS_VXLAN_EXT_GBP, /* Flag or __u32 */ 258 __OVS_VXLAN_EXT_MAX, 259 }; 260 261 #define OVS_VXLAN_EXT_MAX (__OVS_VXLAN_EXT_MAX - 1) 262 263 264 /* OVS_VPORT_ATTR_OPTIONS attributes for tunnels. 265 */ 266 enum { 267 OVS_TUNNEL_ATTR_UNSPEC, 268 OVS_TUNNEL_ATTR_DST_PORT, /* 16-bit UDP port, used by L4 tunnels. */ 269 OVS_TUNNEL_ATTR_EXTENSION, 270 __OVS_TUNNEL_ATTR_MAX 271 }; 272 273 #define OVS_TUNNEL_ATTR_MAX (__OVS_TUNNEL_ATTR_MAX - 1) 274 275 /* Flows. */ 276 277 #define OVS_FLOW_FAMILY "ovs_flow" 278 #define OVS_FLOW_MCGROUP "ovs_flow" 279 #define OVS_FLOW_VERSION 0x1 280 281 enum ovs_flow_cmd { 282 OVS_FLOW_CMD_UNSPEC, 283 OVS_FLOW_CMD_NEW, 284 OVS_FLOW_CMD_DEL, 285 OVS_FLOW_CMD_GET, 286 OVS_FLOW_CMD_SET 287 }; 288 289 struct ovs_flow_stats { 290 __u64 n_packets; /* Number of matched packets. */ 291 __u64 n_bytes; /* Number of matched bytes. */ 292 }; 293 294 enum ovs_key_attr { 295 OVS_KEY_ATTR_UNSPEC, 296 OVS_KEY_ATTR_ENCAP, /* Nested set of encapsulated attributes. */ 297 OVS_KEY_ATTR_PRIORITY, /* u32 skb->priority */ 298 OVS_KEY_ATTR_IN_PORT, /* u32 OVS dp port number */ 299 OVS_KEY_ATTR_ETHERNET, /* struct ovs_key_ethernet */ 300 OVS_KEY_ATTR_VLAN, /* be16 VLAN TCI */ 301 OVS_KEY_ATTR_ETHERTYPE, /* be16 Ethernet type */ 302 OVS_KEY_ATTR_IPV4, /* struct ovs_key_ipv4 */ 303 OVS_KEY_ATTR_IPV6, /* struct ovs_key_ipv6 */ 304 OVS_KEY_ATTR_TCP, /* struct ovs_key_tcp */ 305 OVS_KEY_ATTR_UDP, /* struct ovs_key_udp */ 306 OVS_KEY_ATTR_ICMP, /* struct ovs_key_icmp */ 307 OVS_KEY_ATTR_ICMPV6, /* struct ovs_key_icmpv6 */ 308 OVS_KEY_ATTR_ARP, /* struct ovs_key_arp */ 309 OVS_KEY_ATTR_ND, /* struct ovs_key_nd */ 310 OVS_KEY_ATTR_SKB_MARK, /* u32 skb mark */ 311 OVS_KEY_ATTR_TUNNEL, /* Nested set of ovs_tunnel attributes */ 312 OVS_KEY_ATTR_SCTP, /* struct ovs_key_sctp */ 313 OVS_KEY_ATTR_TCP_FLAGS, /* be16 TCP flags. */ 314 OVS_KEY_ATTR_DP_HASH, /* u32 hash value. Value 0 indicates the hash 315 is not computed by the datapath. */ 316 OVS_KEY_ATTR_RECIRC_ID, /* u32 recirc id */ 317 OVS_KEY_ATTR_MPLS, /* array of struct ovs_key_mpls. 318 * The implementation may restrict 319 * the accepted length of the array. */ 320 321 #ifdef __KERNEL__ 322 OVS_KEY_ATTR_TUNNEL_INFO, /* struct ovs_tunnel_info */ 323 #endif 324 __OVS_KEY_ATTR_MAX 325 }; 326 327 #define OVS_KEY_ATTR_MAX (__OVS_KEY_ATTR_MAX - 1) 328 329 enum ovs_tunnel_key_attr { 330 OVS_TUNNEL_KEY_ATTR_ID, /* be64 Tunnel ID */ 331 OVS_TUNNEL_KEY_ATTR_IPV4_SRC, /* be32 src IP address. */ 332 OVS_TUNNEL_KEY_ATTR_IPV4_DST, /* be32 dst IP address. */ 333 OVS_TUNNEL_KEY_ATTR_TOS, /* u8 Tunnel IP ToS. */ 334 OVS_TUNNEL_KEY_ATTR_TTL, /* u8 Tunnel IP TTL. */ 335 OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT, /* No argument, set DF. */ 336 OVS_TUNNEL_KEY_ATTR_CSUM, /* No argument. CSUM packet. */ 337 OVS_TUNNEL_KEY_ATTR_OAM, /* No argument. OAM frame. */ 338 OVS_TUNNEL_KEY_ATTR_GENEVE_OPTS, /* Array of Geneve options. */ 339 OVS_TUNNEL_KEY_ATTR_TP_SRC, /* be16 src Transport Port. */ 340 OVS_TUNNEL_KEY_ATTR_TP_DST, /* be16 dst Transport Port. */ 341 OVS_TUNNEL_KEY_ATTR_VXLAN_OPTS, /* Nested OVS_VXLAN_EXT_* */ 342 __OVS_TUNNEL_KEY_ATTR_MAX 343 }; 344 345 #define OVS_TUNNEL_KEY_ATTR_MAX (__OVS_TUNNEL_KEY_ATTR_MAX - 1) 346 347 /** 348 * enum ovs_frag_type - IPv4 and IPv6 fragment type 349 * @OVS_FRAG_TYPE_NONE: Packet is not a fragment. 350 * @OVS_FRAG_TYPE_FIRST: Packet is a fragment with offset 0. 351 * @OVS_FRAG_TYPE_LATER: Packet is a fragment with nonzero offset. 352 * 353 * Used as the @ipv4_frag in &struct ovs_key_ipv4 and as @ipv6_frag &struct 354 * ovs_key_ipv6. 355 */ 356 enum ovs_frag_type { 357 OVS_FRAG_TYPE_NONE, 358 OVS_FRAG_TYPE_FIRST, 359 OVS_FRAG_TYPE_LATER, 360 __OVS_FRAG_TYPE_MAX 361 }; 362 363 #define OVS_FRAG_TYPE_MAX (__OVS_FRAG_TYPE_MAX - 1) 364 365 struct ovs_key_ethernet { 366 __u8 eth_src[ETH_ALEN]; 367 __u8 eth_dst[ETH_ALEN]; 368 }; 369 370 struct ovs_key_mpls { 371 __be32 mpls_lse; 372 }; 373 374 struct ovs_key_ipv4 { 375 __be32 ipv4_src; 376 __be32 ipv4_dst; 377 __u8 ipv4_proto; 378 __u8 ipv4_tos; 379 __u8 ipv4_ttl; 380 __u8 ipv4_frag; /* One of OVS_FRAG_TYPE_*. */ 381 }; 382 383 struct ovs_key_ipv6 { 384 __be32 ipv6_src[4]; 385 __be32 ipv6_dst[4]; 386 __be32 ipv6_label; /* 20-bits in least-significant bits. */ 387 __u8 ipv6_proto; 388 __u8 ipv6_tclass; 389 __u8 ipv6_hlimit; 390 __u8 ipv6_frag; /* One of OVS_FRAG_TYPE_*. */ 391 }; 392 393 struct ovs_key_tcp { 394 __be16 tcp_src; 395 __be16 tcp_dst; 396 }; 397 398 struct ovs_key_udp { 399 __be16 udp_src; 400 __be16 udp_dst; 401 }; 402 403 struct ovs_key_sctp { 404 __be16 sctp_src; 405 __be16 sctp_dst; 406 }; 407 408 struct ovs_key_icmp { 409 __u8 icmp_type; 410 __u8 icmp_code; 411 }; 412 413 struct ovs_key_icmpv6 { 414 __u8 icmpv6_type; 415 __u8 icmpv6_code; 416 }; 417 418 struct ovs_key_arp { 419 __be32 arp_sip; 420 __be32 arp_tip; 421 __be16 arp_op; 422 __u8 arp_sha[ETH_ALEN]; 423 __u8 arp_tha[ETH_ALEN]; 424 }; 425 426 struct ovs_key_nd { 427 __be32 nd_target[4]; 428 __u8 nd_sll[ETH_ALEN]; 429 __u8 nd_tll[ETH_ALEN]; 430 }; 431 432 /** 433 * enum ovs_flow_attr - attributes for %OVS_FLOW_* commands. 434 * @OVS_FLOW_ATTR_KEY: Nested %OVS_KEY_ATTR_* attributes specifying the flow 435 * key. Always present in notifications. Required for all requests (except 436 * dumps). 437 * @OVS_FLOW_ATTR_ACTIONS: Nested %OVS_ACTION_ATTR_* attributes specifying 438 * the actions to take for packets that match the key. Always present in 439 * notifications. Required for %OVS_FLOW_CMD_NEW requests, optional for 440 * %OVS_FLOW_CMD_SET requests. An %OVS_FLOW_CMD_SET without 441 * %OVS_FLOW_ATTR_ACTIONS will not modify the actions. To clear the actions, 442 * an %OVS_FLOW_ATTR_ACTIONS without any nested attributes must be given. 443 * @OVS_FLOW_ATTR_STATS: &struct ovs_flow_stats giving statistics for this 444 * flow. Present in notifications if the stats would be nonzero. Ignored in 445 * requests. 446 * @OVS_FLOW_ATTR_TCP_FLAGS: An 8-bit value giving the OR'd value of all of the 447 * TCP flags seen on packets in this flow. Only present in notifications for 448 * TCP flows, and only if it would be nonzero. Ignored in requests. 449 * @OVS_FLOW_ATTR_USED: A 64-bit integer giving the time, in milliseconds on 450 * the system monotonic clock, at which a packet was last processed for this 451 * flow. Only present in notifications if a packet has been processed for this 452 * flow. Ignored in requests. 453 * @OVS_FLOW_ATTR_CLEAR: If present in a %OVS_FLOW_CMD_SET request, clears the 454 * last-used time, accumulated TCP flags, and statistics for this flow. 455 * Otherwise ignored in requests. Never present in notifications. 456 * @OVS_FLOW_ATTR_MASK: Nested %OVS_KEY_ATTR_* attributes specifying the 457 * mask bits for wildcarded flow match. Mask bit value '1' specifies exact 458 * match with corresponding flow key bit, while mask bit value '0' specifies 459 * a wildcarded match. Omitting attribute is treated as wildcarding all 460 * corresponding fields. Optional for all requests. If not present, 461 * all flow key bits are exact match bits. 462 * @OVS_FLOW_ATTR_UFID: A value between 1-16 octets specifying a unique 463 * identifier for the flow. Causes the flow to be indexed by this value rather 464 * than the value of the %OVS_FLOW_ATTR_KEY attribute. Optional for all 465 * requests. Present in notifications if the flow was created with this 466 * attribute. 467 * @OVS_FLOW_ATTR_UFID_FLAGS: A 32-bit value of OR'd %OVS_UFID_F_* 468 * flags that provide alternative semantics for flow installation and 469 * retrieval. Optional for all requests. 470 * 471 * These attributes follow the &struct ovs_header within the Generic Netlink 472 * payload for %OVS_FLOW_* commands. 473 */ 474 enum ovs_flow_attr { 475 OVS_FLOW_ATTR_UNSPEC, 476 OVS_FLOW_ATTR_KEY, /* Sequence of OVS_KEY_ATTR_* attributes. */ 477 OVS_FLOW_ATTR_ACTIONS, /* Nested OVS_ACTION_ATTR_* attributes. */ 478 OVS_FLOW_ATTR_STATS, /* struct ovs_flow_stats. */ 479 OVS_FLOW_ATTR_TCP_FLAGS, /* 8-bit OR'd TCP flags. */ 480 OVS_FLOW_ATTR_USED, /* u64 msecs last used in monotonic time. */ 481 OVS_FLOW_ATTR_CLEAR, /* Flag to clear stats, tcp_flags, used. */ 482 OVS_FLOW_ATTR_MASK, /* Sequence of OVS_KEY_ATTR_* attributes. */ 483 OVS_FLOW_ATTR_PROBE, /* Flow operation is a feature probe, error 484 * logging should be suppressed. */ 485 OVS_FLOW_ATTR_UFID, /* Variable length unique flow identifier. */ 486 OVS_FLOW_ATTR_UFID_FLAGS,/* u32 of OVS_UFID_F_*. */ 487 __OVS_FLOW_ATTR_MAX 488 }; 489 490 #define OVS_FLOW_ATTR_MAX (__OVS_FLOW_ATTR_MAX - 1) 491 492 /** 493 * Omit attributes for notifications. 494 * 495 * If a datapath request contains an %OVS_UFID_F_OMIT_* flag, then the datapath 496 * may omit the corresponding %OVS_FLOW_ATTR_* from the response. 497 */ 498 #define OVS_UFID_F_OMIT_KEY (1 << 0) 499 #define OVS_UFID_F_OMIT_MASK (1 << 1) 500 #define OVS_UFID_F_OMIT_ACTIONS (1 << 2) 501 502 /** 503 * enum ovs_sample_attr - Attributes for %OVS_ACTION_ATTR_SAMPLE action. 504 * @OVS_SAMPLE_ATTR_PROBABILITY: 32-bit fraction of packets to sample with 505 * @OVS_ACTION_ATTR_SAMPLE. A value of 0 samples no packets, a value of 506 * %UINT32_MAX samples all packets and intermediate values sample intermediate 507 * fractions of packets. 508 * @OVS_SAMPLE_ATTR_ACTIONS: Set of actions to execute in sampling event. 509 * Actions are passed as nested attributes. 510 * 511 * Executes the specified actions with the given probability on a per-packet 512 * basis. 513 */ 514 enum ovs_sample_attr { 515 OVS_SAMPLE_ATTR_UNSPEC, 516 OVS_SAMPLE_ATTR_PROBABILITY, /* u32 number */ 517 OVS_SAMPLE_ATTR_ACTIONS, /* Nested OVS_ACTION_ATTR_* attributes. */ 518 __OVS_SAMPLE_ATTR_MAX, 519 }; 520 521 #define OVS_SAMPLE_ATTR_MAX (__OVS_SAMPLE_ATTR_MAX - 1) 522 523 /** 524 * enum ovs_userspace_attr - Attributes for %OVS_ACTION_ATTR_USERSPACE action. 525 * @OVS_USERSPACE_ATTR_PID: u32 Netlink PID to which the %OVS_PACKET_CMD_ACTION 526 * message should be sent. Required. 527 * @OVS_USERSPACE_ATTR_USERDATA: If present, its variable-length argument is 528 * copied to the %OVS_PACKET_CMD_ACTION message as %OVS_PACKET_ATTR_USERDATA. 529 * @OVS_USERSPACE_ATTR_EGRESS_TUN_PORT: If present, u32 output port to get 530 * tunnel info. 531 */ 532 enum ovs_userspace_attr { 533 OVS_USERSPACE_ATTR_UNSPEC, 534 OVS_USERSPACE_ATTR_PID, /* u32 Netlink PID to receive upcalls. */ 535 OVS_USERSPACE_ATTR_USERDATA, /* Optional user-specified cookie. */ 536 OVS_USERSPACE_ATTR_EGRESS_TUN_PORT, /* Optional, u32 output port 537 * to get tunnel info. */ 538 __OVS_USERSPACE_ATTR_MAX 539 }; 540 541 #define OVS_USERSPACE_ATTR_MAX (__OVS_USERSPACE_ATTR_MAX - 1) 542 543 /** 544 * struct ovs_action_push_mpls - %OVS_ACTION_ATTR_PUSH_MPLS action argument. 545 * @mpls_lse: MPLS label stack entry to push. 546 * @mpls_ethertype: Ethertype to set in the encapsulating ethernet frame. 547 * 548 * The only values @mpls_ethertype should ever be given are %ETH_P_MPLS_UC and 549 * %ETH_P_MPLS_MC, indicating MPLS unicast or multicast. Other are rejected. 550 */ 551 struct ovs_action_push_mpls { 552 __be32 mpls_lse; 553 __be16 mpls_ethertype; /* Either %ETH_P_MPLS_UC or %ETH_P_MPLS_MC */ 554 }; 555 556 /** 557 * struct ovs_action_push_vlan - %OVS_ACTION_ATTR_PUSH_VLAN action argument. 558 * @vlan_tpid: Tag protocol identifier (TPID) to push. 559 * @vlan_tci: Tag control identifier (TCI) to push. The CFI bit must be set 560 * (but it will not be set in the 802.1Q header that is pushed). 561 * 562 * The @vlan_tpid value is typically %ETH_P_8021Q. The only acceptable TPID 563 * values are those that the kernel module also parses as 802.1Q headers, to 564 * prevent %OVS_ACTION_ATTR_PUSH_VLAN followed by %OVS_ACTION_ATTR_POP_VLAN 565 * from having surprising results. 566 */ 567 struct ovs_action_push_vlan { 568 __be16 vlan_tpid; /* 802.1Q TPID. */ 569 __be16 vlan_tci; /* 802.1Q TCI (VLAN ID and priority). */ 570 }; 571 572 /* Data path hash algorithm for computing Datapath hash. 573 * 574 * The algorithm type only specifies the fields in a flow 575 * will be used as part of the hash. Each datapath is free 576 * to use its own hash algorithm. The hash value will be 577 * opaque to the user space daemon. 578 */ 579 enum ovs_hash_alg { 580 OVS_HASH_ALG_L4, 581 }; 582 583 /* 584 * struct ovs_action_hash - %OVS_ACTION_ATTR_HASH action argument. 585 * @hash_alg: Algorithm used to compute hash prior to recirculation. 586 * @hash_basis: basis used for computing hash. 587 */ 588 struct ovs_action_hash { 589 uint32_t hash_alg; /* One of ovs_hash_alg. */ 590 uint32_t hash_basis; 591 }; 592 593 /** 594 * enum ovs_action_attr - Action types. 595 * 596 * @OVS_ACTION_ATTR_OUTPUT: Output packet to port. 597 * @OVS_ACTION_ATTR_USERSPACE: Send packet to userspace according to nested 598 * %OVS_USERSPACE_ATTR_* attributes. 599 * @OVS_ACTION_ATTR_SET: Replaces the contents of an existing header. The 600 * single nested %OVS_KEY_ATTR_* attribute specifies a header to modify and its 601 * value. 602 * @OVS_ACTION_ATTR_SET_MASKED: Replaces the contents of an existing header. A 603 * nested %OVS_KEY_ATTR_* attribute specifies a header to modify, its value, 604 * and a mask. For every bit set in the mask, the corresponding bit value 605 * is copied from the value to the packet header field, rest of the bits are 606 * left unchanged. The non-masked value bits must be passed in as zeroes. 607 * Masking is not supported for the %OVS_KEY_ATTR_TUNNEL attribute. 608 * @OVS_ACTION_ATTR_PUSH_VLAN: Push a new outermost 802.1Q header onto the 609 * packet. 610 * @OVS_ACTION_ATTR_POP_VLAN: Pop the outermost 802.1Q header off the packet. 611 * @OVS_ACTION_ATTR_SAMPLE: Probabilitically executes actions, as specified in 612 * the nested %OVS_SAMPLE_ATTR_* attributes. 613 * @OVS_ACTION_ATTR_PUSH_MPLS: Push a new MPLS label stack entry onto the 614 * top of the packets MPLS label stack. Set the ethertype of the 615 * encapsulating frame to either %ETH_P_MPLS_UC or %ETH_P_MPLS_MC to 616 * indicate the new packet contents. 617 * @OVS_ACTION_ATTR_POP_MPLS: Pop an MPLS label stack entry off of the 618 * packet's MPLS label stack. Set the encapsulating frame's ethertype to 619 * indicate the new packet contents. This could potentially still be 620 * %ETH_P_MPLS if the resulting MPLS label stack is not empty. If there 621 * is no MPLS label stack, as determined by ethertype, no action is taken. 622 * 623 * Only a single header can be set with a single %OVS_ACTION_ATTR_SET. Not all 624 * fields within a header are modifiable, e.g. the IPv4 protocol and fragment 625 * type may not be changed. 626 * 627 * @OVS_ACTION_ATTR_SET_TO_MASKED: Kernel internal masked set action translated 628 * from the @OVS_ACTION_ATTR_SET. 629 */ 630 631 enum ovs_action_attr { 632 OVS_ACTION_ATTR_UNSPEC, 633 OVS_ACTION_ATTR_OUTPUT, /* u32 port number. */ 634 OVS_ACTION_ATTR_USERSPACE, /* Nested OVS_USERSPACE_ATTR_*. */ 635 OVS_ACTION_ATTR_SET, /* One nested OVS_KEY_ATTR_*. */ 636 OVS_ACTION_ATTR_PUSH_VLAN, /* struct ovs_action_push_vlan. */ 637 OVS_ACTION_ATTR_POP_VLAN, /* No argument. */ 638 OVS_ACTION_ATTR_SAMPLE, /* Nested OVS_SAMPLE_ATTR_*. */ 639 OVS_ACTION_ATTR_RECIRC, /* u32 recirc_id. */ 640 OVS_ACTION_ATTR_HASH, /* struct ovs_action_hash. */ 641 OVS_ACTION_ATTR_PUSH_MPLS, /* struct ovs_action_push_mpls. */ 642 OVS_ACTION_ATTR_POP_MPLS, /* __be16 ethertype. */ 643 OVS_ACTION_ATTR_SET_MASKED, /* One nested OVS_KEY_ATTR_* including 644 * data immediately followed by a mask. 645 * The data must be zero for the unmasked 646 * bits. */ 647 648 __OVS_ACTION_ATTR_MAX, /* Nothing past this will be accepted 649 * from userspace. */ 650 651 #ifdef __KERNEL__ 652 OVS_ACTION_ATTR_SET_TO_MASKED, /* Kernel module internal masked 653 * set action converted from 654 * OVS_ACTION_ATTR_SET. */ 655 #endif 656 }; 657 658 #define OVS_ACTION_ATTR_MAX (__OVS_ACTION_ATTR_MAX - 1) 659 660 #endif /* _LINUX_OPENVSWITCH_H */ 661