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 * 161 * These attributes follow the &struct ovs_header within the Generic Netlink 162 * payload for %OVS_PACKET_* commands. 163 */ 164 enum ovs_packet_attr { 165 OVS_PACKET_ATTR_UNSPEC, 166 OVS_PACKET_ATTR_PACKET, /* Packet data. */ 167 OVS_PACKET_ATTR_KEY, /* Nested OVS_KEY_ATTR_* attributes. */ 168 OVS_PACKET_ATTR_ACTIONS, /* Nested OVS_ACTION_ATTR_* attributes. */ 169 OVS_PACKET_ATTR_USERDATA, /* OVS_ACTION_ATTR_USERSPACE arg. */ 170 __OVS_PACKET_ATTR_MAX 171 }; 172 173 #define OVS_PACKET_ATTR_MAX (__OVS_PACKET_ATTR_MAX - 1) 174 175 /* Virtual ports. */ 176 177 #define OVS_VPORT_FAMILY "ovs_vport" 178 #define OVS_VPORT_MCGROUP "ovs_vport" 179 #define OVS_VPORT_VERSION 0x1 180 181 enum ovs_vport_cmd { 182 OVS_VPORT_CMD_UNSPEC, 183 OVS_VPORT_CMD_NEW, 184 OVS_VPORT_CMD_DEL, 185 OVS_VPORT_CMD_GET, 186 OVS_VPORT_CMD_SET 187 }; 188 189 enum ovs_vport_type { 190 OVS_VPORT_TYPE_UNSPEC, 191 OVS_VPORT_TYPE_NETDEV, /* network device */ 192 OVS_VPORT_TYPE_INTERNAL, /* network device implemented by datapath */ 193 OVS_VPORT_TYPE_GRE, /* GRE tunnel. */ 194 OVS_VPORT_TYPE_VXLAN, /* VXLAN tunnel. */ 195 OVS_VPORT_TYPE_GENEVE, /* Geneve tunnel. */ 196 __OVS_VPORT_TYPE_MAX 197 }; 198 199 #define OVS_VPORT_TYPE_MAX (__OVS_VPORT_TYPE_MAX - 1) 200 201 /** 202 * enum ovs_vport_attr - attributes for %OVS_VPORT_* commands. 203 * @OVS_VPORT_ATTR_PORT_NO: 32-bit port number within datapath. 204 * @OVS_VPORT_ATTR_TYPE: 32-bit %OVS_VPORT_TYPE_* constant describing the type 205 * of vport. 206 * @OVS_VPORT_ATTR_NAME: Name of vport. For a vport based on a network device 207 * this is the name of the network device. Maximum length %IFNAMSIZ-1 bytes 208 * plus a null terminator. 209 * @OVS_VPORT_ATTR_OPTIONS: Vport-specific configuration information. 210 * @OVS_VPORT_ATTR_UPCALL_PID: The array of Netlink socket pids in userspace 211 * among which OVS_PACKET_CMD_MISS upcalls will be distributed for packets 212 * received on this port. If this is a single-element array of value 0, 213 * upcalls should not be sent. 214 * @OVS_VPORT_ATTR_STATS: A &struct ovs_vport_stats giving statistics for 215 * packets sent or received through the vport. 216 * 217 * These attributes follow the &struct ovs_header within the Generic Netlink 218 * payload for %OVS_VPORT_* commands. 219 * 220 * For %OVS_VPORT_CMD_NEW requests, the %OVS_VPORT_ATTR_TYPE and 221 * %OVS_VPORT_ATTR_NAME attributes are required. %OVS_VPORT_ATTR_PORT_NO is 222 * optional; if not specified a free port number is automatically selected. 223 * Whether %OVS_VPORT_ATTR_OPTIONS is required or optional depends on the type 224 * of vport. 225 * 226 * For other requests, if %OVS_VPORT_ATTR_NAME is specified then it is used to 227 * look up the vport to operate on; otherwise dp_idx from the &struct 228 * ovs_header plus %OVS_VPORT_ATTR_PORT_NO determine the vport. 229 */ 230 enum ovs_vport_attr { 231 OVS_VPORT_ATTR_UNSPEC, 232 OVS_VPORT_ATTR_PORT_NO, /* u32 port number within datapath */ 233 OVS_VPORT_ATTR_TYPE, /* u32 OVS_VPORT_TYPE_* constant. */ 234 OVS_VPORT_ATTR_NAME, /* string name, up to IFNAMSIZ bytes long */ 235 OVS_VPORT_ATTR_OPTIONS, /* nested attributes, varies by vport type */ 236 OVS_VPORT_ATTR_UPCALL_PID, /* array of u32 Netlink socket PIDs for */ 237 /* receiving upcalls */ 238 OVS_VPORT_ATTR_STATS, /* struct ovs_vport_stats */ 239 __OVS_VPORT_ATTR_MAX 240 }; 241 242 #define OVS_VPORT_ATTR_MAX (__OVS_VPORT_ATTR_MAX - 1) 243 244 /* OVS_VPORT_ATTR_OPTIONS attributes for tunnels. 245 */ 246 enum { 247 OVS_TUNNEL_ATTR_UNSPEC, 248 OVS_TUNNEL_ATTR_DST_PORT, /* 16-bit UDP port, used by L4 tunnels. */ 249 __OVS_TUNNEL_ATTR_MAX 250 }; 251 252 #define OVS_TUNNEL_ATTR_MAX (__OVS_TUNNEL_ATTR_MAX - 1) 253 254 /* Flows. */ 255 256 #define OVS_FLOW_FAMILY "ovs_flow" 257 #define OVS_FLOW_MCGROUP "ovs_flow" 258 #define OVS_FLOW_VERSION 0x1 259 260 enum ovs_flow_cmd { 261 OVS_FLOW_CMD_UNSPEC, 262 OVS_FLOW_CMD_NEW, 263 OVS_FLOW_CMD_DEL, 264 OVS_FLOW_CMD_GET, 265 OVS_FLOW_CMD_SET 266 }; 267 268 struct ovs_flow_stats { 269 __u64 n_packets; /* Number of matched packets. */ 270 __u64 n_bytes; /* Number of matched bytes. */ 271 }; 272 273 enum ovs_key_attr { 274 OVS_KEY_ATTR_UNSPEC, 275 OVS_KEY_ATTR_ENCAP, /* Nested set of encapsulated attributes. */ 276 OVS_KEY_ATTR_PRIORITY, /* u32 skb->priority */ 277 OVS_KEY_ATTR_IN_PORT, /* u32 OVS dp port number */ 278 OVS_KEY_ATTR_ETHERNET, /* struct ovs_key_ethernet */ 279 OVS_KEY_ATTR_VLAN, /* be16 VLAN TCI */ 280 OVS_KEY_ATTR_ETHERTYPE, /* be16 Ethernet type */ 281 OVS_KEY_ATTR_IPV4, /* struct ovs_key_ipv4 */ 282 OVS_KEY_ATTR_IPV6, /* struct ovs_key_ipv6 */ 283 OVS_KEY_ATTR_TCP, /* struct ovs_key_tcp */ 284 OVS_KEY_ATTR_UDP, /* struct ovs_key_udp */ 285 OVS_KEY_ATTR_ICMP, /* struct ovs_key_icmp */ 286 OVS_KEY_ATTR_ICMPV6, /* struct ovs_key_icmpv6 */ 287 OVS_KEY_ATTR_ARP, /* struct ovs_key_arp */ 288 OVS_KEY_ATTR_ND, /* struct ovs_key_nd */ 289 OVS_KEY_ATTR_SKB_MARK, /* u32 skb mark */ 290 OVS_KEY_ATTR_TUNNEL, /* Nested set of ovs_tunnel attributes */ 291 OVS_KEY_ATTR_SCTP, /* struct ovs_key_sctp */ 292 OVS_KEY_ATTR_TCP_FLAGS, /* be16 TCP flags. */ 293 OVS_KEY_ATTR_DP_HASH, /* u32 hash value. Value 0 indicates the hash 294 is not computed by the datapath. */ 295 OVS_KEY_ATTR_RECIRC_ID, /* u32 recirc id */ 296 297 #ifdef __KERNEL__ 298 OVS_KEY_ATTR_TUNNEL_INFO, /* struct ovs_tunnel_info */ 299 #endif 300 __OVS_KEY_ATTR_MAX 301 }; 302 303 #define OVS_KEY_ATTR_MAX (__OVS_KEY_ATTR_MAX - 1) 304 305 enum ovs_tunnel_key_attr { 306 OVS_TUNNEL_KEY_ATTR_ID, /* be64 Tunnel ID */ 307 OVS_TUNNEL_KEY_ATTR_IPV4_SRC, /* be32 src IP address. */ 308 OVS_TUNNEL_KEY_ATTR_IPV4_DST, /* be32 dst IP address. */ 309 OVS_TUNNEL_KEY_ATTR_TOS, /* u8 Tunnel IP ToS. */ 310 OVS_TUNNEL_KEY_ATTR_TTL, /* u8 Tunnel IP TTL. */ 311 OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT, /* No argument, set DF. */ 312 OVS_TUNNEL_KEY_ATTR_CSUM, /* No argument. CSUM packet. */ 313 OVS_TUNNEL_KEY_ATTR_OAM, /* No argument. OAM frame. */ 314 OVS_TUNNEL_KEY_ATTR_GENEVE_OPTS, /* Array of Geneve options. */ 315 __OVS_TUNNEL_KEY_ATTR_MAX 316 }; 317 318 #define OVS_TUNNEL_KEY_ATTR_MAX (__OVS_TUNNEL_KEY_ATTR_MAX - 1) 319 320 /** 321 * enum ovs_frag_type - IPv4 and IPv6 fragment type 322 * @OVS_FRAG_TYPE_NONE: Packet is not a fragment. 323 * @OVS_FRAG_TYPE_FIRST: Packet is a fragment with offset 0. 324 * @OVS_FRAG_TYPE_LATER: Packet is a fragment with nonzero offset. 325 * 326 * Used as the @ipv4_frag in &struct ovs_key_ipv4 and as @ipv6_frag &struct 327 * ovs_key_ipv6. 328 */ 329 enum ovs_frag_type { 330 OVS_FRAG_TYPE_NONE, 331 OVS_FRAG_TYPE_FIRST, 332 OVS_FRAG_TYPE_LATER, 333 __OVS_FRAG_TYPE_MAX 334 }; 335 336 #define OVS_FRAG_TYPE_MAX (__OVS_FRAG_TYPE_MAX - 1) 337 338 struct ovs_key_ethernet { 339 __u8 eth_src[ETH_ALEN]; 340 __u8 eth_dst[ETH_ALEN]; 341 }; 342 343 struct ovs_key_ipv4 { 344 __be32 ipv4_src; 345 __be32 ipv4_dst; 346 __u8 ipv4_proto; 347 __u8 ipv4_tos; 348 __u8 ipv4_ttl; 349 __u8 ipv4_frag; /* One of OVS_FRAG_TYPE_*. */ 350 }; 351 352 struct ovs_key_ipv6 { 353 __be32 ipv6_src[4]; 354 __be32 ipv6_dst[4]; 355 __be32 ipv6_label; /* 20-bits in least-significant bits. */ 356 __u8 ipv6_proto; 357 __u8 ipv6_tclass; 358 __u8 ipv6_hlimit; 359 __u8 ipv6_frag; /* One of OVS_FRAG_TYPE_*. */ 360 }; 361 362 struct ovs_key_tcp { 363 __be16 tcp_src; 364 __be16 tcp_dst; 365 }; 366 367 struct ovs_key_udp { 368 __be16 udp_src; 369 __be16 udp_dst; 370 }; 371 372 struct ovs_key_sctp { 373 __be16 sctp_src; 374 __be16 sctp_dst; 375 }; 376 377 struct ovs_key_icmp { 378 __u8 icmp_type; 379 __u8 icmp_code; 380 }; 381 382 struct ovs_key_icmpv6 { 383 __u8 icmpv6_type; 384 __u8 icmpv6_code; 385 }; 386 387 struct ovs_key_arp { 388 __be32 arp_sip; 389 __be32 arp_tip; 390 __be16 arp_op; 391 __u8 arp_sha[ETH_ALEN]; 392 __u8 arp_tha[ETH_ALEN]; 393 }; 394 395 struct ovs_key_nd { 396 __u32 nd_target[4]; 397 __u8 nd_sll[ETH_ALEN]; 398 __u8 nd_tll[ETH_ALEN]; 399 }; 400 401 /** 402 * enum ovs_flow_attr - attributes for %OVS_FLOW_* commands. 403 * @OVS_FLOW_ATTR_KEY: Nested %OVS_KEY_ATTR_* attributes specifying the flow 404 * key. Always present in notifications. Required for all requests (except 405 * dumps). 406 * @OVS_FLOW_ATTR_ACTIONS: Nested %OVS_ACTION_ATTR_* attributes specifying 407 * the actions to take for packets that match the key. Always present in 408 * notifications. Required for %OVS_FLOW_CMD_NEW requests, optional for 409 * %OVS_FLOW_CMD_SET requests. An %OVS_FLOW_CMD_SET without 410 * %OVS_FLOW_ATTR_ACTIONS will not modify the actions. To clear the actions, 411 * an %OVS_FLOW_ATTR_ACTIONS without any nested attributes must be given. 412 * @OVS_FLOW_ATTR_STATS: &struct ovs_flow_stats giving statistics for this 413 * flow. Present in notifications if the stats would be nonzero. Ignored in 414 * requests. 415 * @OVS_FLOW_ATTR_TCP_FLAGS: An 8-bit value giving the OR'd value of all of the 416 * TCP flags seen on packets in this flow. Only present in notifications for 417 * TCP flows, and only if it would be nonzero. Ignored in requests. 418 * @OVS_FLOW_ATTR_USED: A 64-bit integer giving the time, in milliseconds on 419 * the system monotonic clock, at which a packet was last processed for this 420 * flow. Only present in notifications if a packet has been processed for this 421 * flow. Ignored in requests. 422 * @OVS_FLOW_ATTR_CLEAR: If present in a %OVS_FLOW_CMD_SET request, clears the 423 * last-used time, accumulated TCP flags, and statistics for this flow. 424 * Otherwise ignored in requests. Never present in notifications. 425 * @OVS_FLOW_ATTR_MASK: Nested %OVS_KEY_ATTR_* attributes specifying the 426 * mask bits for wildcarded flow match. Mask bit value '1' specifies exact 427 * match with corresponding flow key bit, while mask bit value '0' specifies 428 * a wildcarded match. Omitting attribute is treated as wildcarding all 429 * corresponding fields. Optional for all requests. If not present, 430 * all flow key bits are exact match bits. 431 * 432 * These attributes follow the &struct ovs_header within the Generic Netlink 433 * payload for %OVS_FLOW_* commands. 434 */ 435 enum ovs_flow_attr { 436 OVS_FLOW_ATTR_UNSPEC, 437 OVS_FLOW_ATTR_KEY, /* Sequence of OVS_KEY_ATTR_* attributes. */ 438 OVS_FLOW_ATTR_ACTIONS, /* Nested OVS_ACTION_ATTR_* attributes. */ 439 OVS_FLOW_ATTR_STATS, /* struct ovs_flow_stats. */ 440 OVS_FLOW_ATTR_TCP_FLAGS, /* 8-bit OR'd TCP flags. */ 441 OVS_FLOW_ATTR_USED, /* u64 msecs last used in monotonic time. */ 442 OVS_FLOW_ATTR_CLEAR, /* Flag to clear stats, tcp_flags, used. */ 443 OVS_FLOW_ATTR_MASK, /* Sequence of OVS_KEY_ATTR_* attributes. */ 444 __OVS_FLOW_ATTR_MAX 445 }; 446 447 #define OVS_FLOW_ATTR_MAX (__OVS_FLOW_ATTR_MAX - 1) 448 449 /** 450 * enum ovs_sample_attr - Attributes for %OVS_ACTION_ATTR_SAMPLE action. 451 * @OVS_SAMPLE_ATTR_PROBABILITY: 32-bit fraction of packets to sample with 452 * @OVS_ACTION_ATTR_SAMPLE. A value of 0 samples no packets, a value of 453 * %UINT32_MAX samples all packets and intermediate values sample intermediate 454 * fractions of packets. 455 * @OVS_SAMPLE_ATTR_ACTIONS: Set of actions to execute in sampling event. 456 * Actions are passed as nested attributes. 457 * 458 * Executes the specified actions with the given probability on a per-packet 459 * basis. 460 */ 461 enum ovs_sample_attr { 462 OVS_SAMPLE_ATTR_UNSPEC, 463 OVS_SAMPLE_ATTR_PROBABILITY, /* u32 number */ 464 OVS_SAMPLE_ATTR_ACTIONS, /* Nested OVS_ACTION_ATTR_* attributes. */ 465 __OVS_SAMPLE_ATTR_MAX, 466 }; 467 468 #define OVS_SAMPLE_ATTR_MAX (__OVS_SAMPLE_ATTR_MAX - 1) 469 470 /** 471 * enum ovs_userspace_attr - Attributes for %OVS_ACTION_ATTR_USERSPACE action. 472 * @OVS_USERSPACE_ATTR_PID: u32 Netlink PID to which the %OVS_PACKET_CMD_ACTION 473 * message should be sent. Required. 474 * @OVS_USERSPACE_ATTR_USERDATA: If present, its variable-length argument is 475 * copied to the %OVS_PACKET_CMD_ACTION message as %OVS_PACKET_ATTR_USERDATA. 476 */ 477 enum ovs_userspace_attr { 478 OVS_USERSPACE_ATTR_UNSPEC, 479 OVS_USERSPACE_ATTR_PID, /* u32 Netlink PID to receive upcalls. */ 480 OVS_USERSPACE_ATTR_USERDATA, /* Optional user-specified cookie. */ 481 __OVS_USERSPACE_ATTR_MAX 482 }; 483 484 #define OVS_USERSPACE_ATTR_MAX (__OVS_USERSPACE_ATTR_MAX - 1) 485 486 /** 487 * struct ovs_action_push_vlan - %OVS_ACTION_ATTR_PUSH_VLAN action argument. 488 * @vlan_tpid: Tag protocol identifier (TPID) to push. 489 * @vlan_tci: Tag control identifier (TCI) to push. The CFI bit must be set 490 * (but it will not be set in the 802.1Q header that is pushed). 491 * 492 * The @vlan_tpid value is typically %ETH_P_8021Q. The only acceptable TPID 493 * values are those that the kernel module also parses as 802.1Q headers, to 494 * prevent %OVS_ACTION_ATTR_PUSH_VLAN followed by %OVS_ACTION_ATTR_POP_VLAN 495 * from having surprising results. 496 */ 497 struct ovs_action_push_vlan { 498 __be16 vlan_tpid; /* 802.1Q TPID. */ 499 __be16 vlan_tci; /* 802.1Q TCI (VLAN ID and priority). */ 500 }; 501 502 /* Data path hash algorithm for computing Datapath hash. 503 * 504 * The algorithm type only specifies the fields in a flow 505 * will be used as part of the hash. Each datapath is free 506 * to use its own hash algorithm. The hash value will be 507 * opaque to the user space daemon. 508 */ 509 enum ovs_hash_alg { 510 OVS_HASH_ALG_L4, 511 }; 512 513 /* 514 * struct ovs_action_hash - %OVS_ACTION_ATTR_HASH action argument. 515 * @hash_alg: Algorithm used to compute hash prior to recirculation. 516 * @hash_basis: basis used for computing hash. 517 */ 518 struct ovs_action_hash { 519 uint32_t hash_alg; /* One of ovs_hash_alg. */ 520 uint32_t hash_basis; 521 }; 522 523 /** 524 * enum ovs_action_attr - Action types. 525 * 526 * @OVS_ACTION_ATTR_OUTPUT: Output packet to port. 527 * @OVS_ACTION_ATTR_USERSPACE: Send packet to userspace according to nested 528 * %OVS_USERSPACE_ATTR_* attributes. 529 * @OVS_ACTION_ATTR_SET: Replaces the contents of an existing header. The 530 * single nested %OVS_KEY_ATTR_* attribute specifies a header to modify and its 531 * value. 532 * @OVS_ACTION_ATTR_PUSH_VLAN: Push a new outermost 802.1Q header onto the 533 * packet. 534 * @OVS_ACTION_ATTR_POP_VLAN: Pop the outermost 802.1Q header off the packet. 535 * @OVS_ACTION_ATTR_SAMPLE: Probabilitically executes actions, as specified in 536 * the nested %OVS_SAMPLE_ATTR_* attributes. 537 * 538 * Only a single header can be set with a single %OVS_ACTION_ATTR_SET. Not all 539 * fields within a header are modifiable, e.g. the IPv4 protocol and fragment 540 * type may not be changed. 541 */ 542 543 enum ovs_action_attr { 544 OVS_ACTION_ATTR_UNSPEC, 545 OVS_ACTION_ATTR_OUTPUT, /* u32 port number. */ 546 OVS_ACTION_ATTR_USERSPACE, /* Nested OVS_USERSPACE_ATTR_*. */ 547 OVS_ACTION_ATTR_SET, /* One nested OVS_KEY_ATTR_*. */ 548 OVS_ACTION_ATTR_PUSH_VLAN, /* struct ovs_action_push_vlan. */ 549 OVS_ACTION_ATTR_POP_VLAN, /* No argument. */ 550 OVS_ACTION_ATTR_SAMPLE, /* Nested OVS_SAMPLE_ATTR_*. */ 551 OVS_ACTION_ATTR_RECIRC, /* u32 recirc_id. */ 552 OVS_ACTION_ATTR_HASH, /* struct ovs_action_hash. */ 553 __OVS_ACTION_ATTR_MAX 554 }; 555 556 #define OVS_ACTION_ATTR_MAX (__OVS_ACTION_ATTR_MAX - 1) 557 558 #endif /* _LINUX_OPENVSWITCH_H */ 559