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 /* OVS_VPORT_ATTR_OPTIONS attributes for tunnels. 256 */ 257 enum { 258 OVS_TUNNEL_ATTR_UNSPEC, 259 OVS_TUNNEL_ATTR_DST_PORT, /* 16-bit UDP port, used by L4 tunnels. */ 260 __OVS_TUNNEL_ATTR_MAX 261 }; 262 263 #define OVS_TUNNEL_ATTR_MAX (__OVS_TUNNEL_ATTR_MAX - 1) 264 265 /* Flows. */ 266 267 #define OVS_FLOW_FAMILY "ovs_flow" 268 #define OVS_FLOW_MCGROUP "ovs_flow" 269 #define OVS_FLOW_VERSION 0x1 270 271 enum ovs_flow_cmd { 272 OVS_FLOW_CMD_UNSPEC, 273 OVS_FLOW_CMD_NEW, 274 OVS_FLOW_CMD_DEL, 275 OVS_FLOW_CMD_GET, 276 OVS_FLOW_CMD_SET 277 }; 278 279 struct ovs_flow_stats { 280 __u64 n_packets; /* Number of matched packets. */ 281 __u64 n_bytes; /* Number of matched bytes. */ 282 }; 283 284 enum ovs_key_attr { 285 OVS_KEY_ATTR_UNSPEC, 286 OVS_KEY_ATTR_ENCAP, /* Nested set of encapsulated attributes. */ 287 OVS_KEY_ATTR_PRIORITY, /* u32 skb->priority */ 288 OVS_KEY_ATTR_IN_PORT, /* u32 OVS dp port number */ 289 OVS_KEY_ATTR_ETHERNET, /* struct ovs_key_ethernet */ 290 OVS_KEY_ATTR_VLAN, /* be16 VLAN TCI */ 291 OVS_KEY_ATTR_ETHERTYPE, /* be16 Ethernet type */ 292 OVS_KEY_ATTR_IPV4, /* struct ovs_key_ipv4 */ 293 OVS_KEY_ATTR_IPV6, /* struct ovs_key_ipv6 */ 294 OVS_KEY_ATTR_TCP, /* struct ovs_key_tcp */ 295 OVS_KEY_ATTR_UDP, /* struct ovs_key_udp */ 296 OVS_KEY_ATTR_ICMP, /* struct ovs_key_icmp */ 297 OVS_KEY_ATTR_ICMPV6, /* struct ovs_key_icmpv6 */ 298 OVS_KEY_ATTR_ARP, /* struct ovs_key_arp */ 299 OVS_KEY_ATTR_ND, /* struct ovs_key_nd */ 300 OVS_KEY_ATTR_SKB_MARK, /* u32 skb mark */ 301 OVS_KEY_ATTR_TUNNEL, /* Nested set of ovs_tunnel attributes */ 302 OVS_KEY_ATTR_SCTP, /* struct ovs_key_sctp */ 303 OVS_KEY_ATTR_TCP_FLAGS, /* be16 TCP flags. */ 304 OVS_KEY_ATTR_DP_HASH, /* u32 hash value. Value 0 indicates the hash 305 is not computed by the datapath. */ 306 OVS_KEY_ATTR_RECIRC_ID, /* u32 recirc id */ 307 OVS_KEY_ATTR_MPLS, /* array of struct ovs_key_mpls. 308 * The implementation may restrict 309 * the accepted length of the array. */ 310 311 #ifdef __KERNEL__ 312 OVS_KEY_ATTR_TUNNEL_INFO, /* struct ovs_tunnel_info */ 313 #endif 314 __OVS_KEY_ATTR_MAX 315 }; 316 317 #define OVS_KEY_ATTR_MAX (__OVS_KEY_ATTR_MAX - 1) 318 319 enum ovs_tunnel_key_attr { 320 OVS_TUNNEL_KEY_ATTR_ID, /* be64 Tunnel ID */ 321 OVS_TUNNEL_KEY_ATTR_IPV4_SRC, /* be32 src IP address. */ 322 OVS_TUNNEL_KEY_ATTR_IPV4_DST, /* be32 dst IP address. */ 323 OVS_TUNNEL_KEY_ATTR_TOS, /* u8 Tunnel IP ToS. */ 324 OVS_TUNNEL_KEY_ATTR_TTL, /* u8 Tunnel IP TTL. */ 325 OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT, /* No argument, set DF. */ 326 OVS_TUNNEL_KEY_ATTR_CSUM, /* No argument. CSUM packet. */ 327 OVS_TUNNEL_KEY_ATTR_OAM, /* No argument. OAM frame. */ 328 OVS_TUNNEL_KEY_ATTR_GENEVE_OPTS, /* Array of Geneve options. */ 329 OVS_TUNNEL_KEY_ATTR_TP_SRC, /* be16 src Transport Port. */ 330 OVS_TUNNEL_KEY_ATTR_TP_DST, /* be16 dst Transport Port. */ 331 __OVS_TUNNEL_KEY_ATTR_MAX 332 }; 333 334 #define OVS_TUNNEL_KEY_ATTR_MAX (__OVS_TUNNEL_KEY_ATTR_MAX - 1) 335 336 /** 337 * enum ovs_frag_type - IPv4 and IPv6 fragment type 338 * @OVS_FRAG_TYPE_NONE: Packet is not a fragment. 339 * @OVS_FRAG_TYPE_FIRST: Packet is a fragment with offset 0. 340 * @OVS_FRAG_TYPE_LATER: Packet is a fragment with nonzero offset. 341 * 342 * Used as the @ipv4_frag in &struct ovs_key_ipv4 and as @ipv6_frag &struct 343 * ovs_key_ipv6. 344 */ 345 enum ovs_frag_type { 346 OVS_FRAG_TYPE_NONE, 347 OVS_FRAG_TYPE_FIRST, 348 OVS_FRAG_TYPE_LATER, 349 __OVS_FRAG_TYPE_MAX 350 }; 351 352 #define OVS_FRAG_TYPE_MAX (__OVS_FRAG_TYPE_MAX - 1) 353 354 struct ovs_key_ethernet { 355 __u8 eth_src[ETH_ALEN]; 356 __u8 eth_dst[ETH_ALEN]; 357 }; 358 359 struct ovs_key_mpls { 360 __be32 mpls_lse; 361 }; 362 363 struct ovs_key_ipv4 { 364 __be32 ipv4_src; 365 __be32 ipv4_dst; 366 __u8 ipv4_proto; 367 __u8 ipv4_tos; 368 __u8 ipv4_ttl; 369 __u8 ipv4_frag; /* One of OVS_FRAG_TYPE_*. */ 370 }; 371 372 struct ovs_key_ipv6 { 373 __be32 ipv6_src[4]; 374 __be32 ipv6_dst[4]; 375 __be32 ipv6_label; /* 20-bits in least-significant bits. */ 376 __u8 ipv6_proto; 377 __u8 ipv6_tclass; 378 __u8 ipv6_hlimit; 379 __u8 ipv6_frag; /* One of OVS_FRAG_TYPE_*. */ 380 }; 381 382 struct ovs_key_tcp { 383 __be16 tcp_src; 384 __be16 tcp_dst; 385 }; 386 387 struct ovs_key_udp { 388 __be16 udp_src; 389 __be16 udp_dst; 390 }; 391 392 struct ovs_key_sctp { 393 __be16 sctp_src; 394 __be16 sctp_dst; 395 }; 396 397 struct ovs_key_icmp { 398 __u8 icmp_type; 399 __u8 icmp_code; 400 }; 401 402 struct ovs_key_icmpv6 { 403 __u8 icmpv6_type; 404 __u8 icmpv6_code; 405 }; 406 407 struct ovs_key_arp { 408 __be32 arp_sip; 409 __be32 arp_tip; 410 __be16 arp_op; 411 __u8 arp_sha[ETH_ALEN]; 412 __u8 arp_tha[ETH_ALEN]; 413 }; 414 415 struct ovs_key_nd { 416 __be32 nd_target[4]; 417 __u8 nd_sll[ETH_ALEN]; 418 __u8 nd_tll[ETH_ALEN]; 419 }; 420 421 /** 422 * enum ovs_flow_attr - attributes for %OVS_FLOW_* commands. 423 * @OVS_FLOW_ATTR_KEY: Nested %OVS_KEY_ATTR_* attributes specifying the flow 424 * key. Always present in notifications. Required for all requests (except 425 * dumps). 426 * @OVS_FLOW_ATTR_ACTIONS: Nested %OVS_ACTION_ATTR_* attributes specifying 427 * the actions to take for packets that match the key. Always present in 428 * notifications. Required for %OVS_FLOW_CMD_NEW requests, optional for 429 * %OVS_FLOW_CMD_SET requests. An %OVS_FLOW_CMD_SET without 430 * %OVS_FLOW_ATTR_ACTIONS will not modify the actions. To clear the actions, 431 * an %OVS_FLOW_ATTR_ACTIONS without any nested attributes must be given. 432 * @OVS_FLOW_ATTR_STATS: &struct ovs_flow_stats giving statistics for this 433 * flow. Present in notifications if the stats would be nonzero. Ignored in 434 * requests. 435 * @OVS_FLOW_ATTR_TCP_FLAGS: An 8-bit value giving the OR'd value of all of the 436 * TCP flags seen on packets in this flow. Only present in notifications for 437 * TCP flows, and only if it would be nonzero. Ignored in requests. 438 * @OVS_FLOW_ATTR_USED: A 64-bit integer giving the time, in milliseconds on 439 * the system monotonic clock, at which a packet was last processed for this 440 * flow. Only present in notifications if a packet has been processed for this 441 * flow. Ignored in requests. 442 * @OVS_FLOW_ATTR_CLEAR: If present in a %OVS_FLOW_CMD_SET request, clears the 443 * last-used time, accumulated TCP flags, and statistics for this flow. 444 * Otherwise ignored in requests. Never present in notifications. 445 * @OVS_FLOW_ATTR_MASK: Nested %OVS_KEY_ATTR_* attributes specifying the 446 * mask bits for wildcarded flow match. Mask bit value '1' specifies exact 447 * match with corresponding flow key bit, while mask bit value '0' specifies 448 * a wildcarded match. Omitting attribute is treated as wildcarding all 449 * corresponding fields. Optional for all requests. If not present, 450 * all flow key bits are exact match bits. 451 * 452 * These attributes follow the &struct ovs_header within the Generic Netlink 453 * payload for %OVS_FLOW_* commands. 454 */ 455 enum ovs_flow_attr { 456 OVS_FLOW_ATTR_UNSPEC, 457 OVS_FLOW_ATTR_KEY, /* Sequence of OVS_KEY_ATTR_* attributes. */ 458 OVS_FLOW_ATTR_ACTIONS, /* Nested OVS_ACTION_ATTR_* attributes. */ 459 OVS_FLOW_ATTR_STATS, /* struct ovs_flow_stats. */ 460 OVS_FLOW_ATTR_TCP_FLAGS, /* 8-bit OR'd TCP flags. */ 461 OVS_FLOW_ATTR_USED, /* u64 msecs last used in monotonic time. */ 462 OVS_FLOW_ATTR_CLEAR, /* Flag to clear stats, tcp_flags, used. */ 463 OVS_FLOW_ATTR_MASK, /* Sequence of OVS_KEY_ATTR_* attributes. */ 464 OVS_FLOW_ATTR_PROBE, /* Flow operation is a feature probe, error 465 * logging should be suppressed. */ 466 __OVS_FLOW_ATTR_MAX 467 }; 468 469 #define OVS_FLOW_ATTR_MAX (__OVS_FLOW_ATTR_MAX - 1) 470 471 /** 472 * enum ovs_sample_attr - Attributes for %OVS_ACTION_ATTR_SAMPLE action. 473 * @OVS_SAMPLE_ATTR_PROBABILITY: 32-bit fraction of packets to sample with 474 * @OVS_ACTION_ATTR_SAMPLE. A value of 0 samples no packets, a value of 475 * %UINT32_MAX samples all packets and intermediate values sample intermediate 476 * fractions of packets. 477 * @OVS_SAMPLE_ATTR_ACTIONS: Set of actions to execute in sampling event. 478 * Actions are passed as nested attributes. 479 * 480 * Executes the specified actions with the given probability on a per-packet 481 * basis. 482 */ 483 enum ovs_sample_attr { 484 OVS_SAMPLE_ATTR_UNSPEC, 485 OVS_SAMPLE_ATTR_PROBABILITY, /* u32 number */ 486 OVS_SAMPLE_ATTR_ACTIONS, /* Nested OVS_ACTION_ATTR_* attributes. */ 487 __OVS_SAMPLE_ATTR_MAX, 488 }; 489 490 #define OVS_SAMPLE_ATTR_MAX (__OVS_SAMPLE_ATTR_MAX - 1) 491 492 /** 493 * enum ovs_userspace_attr - Attributes for %OVS_ACTION_ATTR_USERSPACE action. 494 * @OVS_USERSPACE_ATTR_PID: u32 Netlink PID to which the %OVS_PACKET_CMD_ACTION 495 * message should be sent. Required. 496 * @OVS_USERSPACE_ATTR_USERDATA: If present, its variable-length argument is 497 * copied to the %OVS_PACKET_CMD_ACTION message as %OVS_PACKET_ATTR_USERDATA. 498 * @OVS_USERSPACE_ATTR_EGRESS_TUN_PORT: If present, u32 output port to get 499 * tunnel info. 500 */ 501 enum ovs_userspace_attr { 502 OVS_USERSPACE_ATTR_UNSPEC, 503 OVS_USERSPACE_ATTR_PID, /* u32 Netlink PID to receive upcalls. */ 504 OVS_USERSPACE_ATTR_USERDATA, /* Optional user-specified cookie. */ 505 OVS_USERSPACE_ATTR_EGRESS_TUN_PORT, /* Optional, u32 output port 506 * to get tunnel info. */ 507 __OVS_USERSPACE_ATTR_MAX 508 }; 509 510 #define OVS_USERSPACE_ATTR_MAX (__OVS_USERSPACE_ATTR_MAX - 1) 511 512 /** 513 * struct ovs_action_push_mpls - %OVS_ACTION_ATTR_PUSH_MPLS action argument. 514 * @mpls_lse: MPLS label stack entry to push. 515 * @mpls_ethertype: Ethertype to set in the encapsulating ethernet frame. 516 * 517 * The only values @mpls_ethertype should ever be given are %ETH_P_MPLS_UC and 518 * %ETH_P_MPLS_MC, indicating MPLS unicast or multicast. Other are rejected. 519 */ 520 struct ovs_action_push_mpls { 521 __be32 mpls_lse; 522 __be16 mpls_ethertype; /* Either %ETH_P_MPLS_UC or %ETH_P_MPLS_MC */ 523 }; 524 525 /** 526 * struct ovs_action_push_vlan - %OVS_ACTION_ATTR_PUSH_VLAN action argument. 527 * @vlan_tpid: Tag protocol identifier (TPID) to push. 528 * @vlan_tci: Tag control identifier (TCI) to push. The CFI bit must be set 529 * (but it will not be set in the 802.1Q header that is pushed). 530 * 531 * The @vlan_tpid value is typically %ETH_P_8021Q. The only acceptable TPID 532 * values are those that the kernel module also parses as 802.1Q headers, to 533 * prevent %OVS_ACTION_ATTR_PUSH_VLAN followed by %OVS_ACTION_ATTR_POP_VLAN 534 * from having surprising results. 535 */ 536 struct ovs_action_push_vlan { 537 __be16 vlan_tpid; /* 802.1Q TPID. */ 538 __be16 vlan_tci; /* 802.1Q TCI (VLAN ID and priority). */ 539 }; 540 541 /* Data path hash algorithm for computing Datapath hash. 542 * 543 * The algorithm type only specifies the fields in a flow 544 * will be used as part of the hash. Each datapath is free 545 * to use its own hash algorithm. The hash value will be 546 * opaque to the user space daemon. 547 */ 548 enum ovs_hash_alg { 549 OVS_HASH_ALG_L4, 550 }; 551 552 /* 553 * struct ovs_action_hash - %OVS_ACTION_ATTR_HASH action argument. 554 * @hash_alg: Algorithm used to compute hash prior to recirculation. 555 * @hash_basis: basis used for computing hash. 556 */ 557 struct ovs_action_hash { 558 uint32_t hash_alg; /* One of ovs_hash_alg. */ 559 uint32_t hash_basis; 560 }; 561 562 /** 563 * enum ovs_action_attr - Action types. 564 * 565 * @OVS_ACTION_ATTR_OUTPUT: Output packet to port. 566 * @OVS_ACTION_ATTR_USERSPACE: Send packet to userspace according to nested 567 * %OVS_USERSPACE_ATTR_* attributes. 568 * @OVS_ACTION_ATTR_SET: Replaces the contents of an existing header. The 569 * single nested %OVS_KEY_ATTR_* attribute specifies a header to modify and its 570 * value. 571 * @OVS_ACTION_ATTR_PUSH_VLAN: Push a new outermost 802.1Q header onto the 572 * packet. 573 * @OVS_ACTION_ATTR_POP_VLAN: Pop the outermost 802.1Q header off the packet. 574 * @OVS_ACTION_ATTR_SAMPLE: Probabilitically executes actions, as specified in 575 * the nested %OVS_SAMPLE_ATTR_* attributes. 576 * @OVS_ACTION_ATTR_PUSH_MPLS: Push a new MPLS label stack entry onto the 577 * top of the packets MPLS label stack. Set the ethertype of the 578 * encapsulating frame to either %ETH_P_MPLS_UC or %ETH_P_MPLS_MC to 579 * indicate the new packet contents. 580 * @OVS_ACTION_ATTR_POP_MPLS: Pop an MPLS label stack entry off of the 581 * packet's MPLS label stack. Set the encapsulating frame's ethertype to 582 * indicate the new packet contents. This could potentially still be 583 * %ETH_P_MPLS if the resulting MPLS label stack is not empty. If there 584 * is no MPLS label stack, as determined by ethertype, no action is taken. 585 * 586 * Only a single header can be set with a single %OVS_ACTION_ATTR_SET. Not all 587 * fields within a header are modifiable, e.g. the IPv4 protocol and fragment 588 * type may not be changed. 589 */ 590 591 enum ovs_action_attr { 592 OVS_ACTION_ATTR_UNSPEC, 593 OVS_ACTION_ATTR_OUTPUT, /* u32 port number. */ 594 OVS_ACTION_ATTR_USERSPACE, /* Nested OVS_USERSPACE_ATTR_*. */ 595 OVS_ACTION_ATTR_SET, /* One nested OVS_KEY_ATTR_*. */ 596 OVS_ACTION_ATTR_PUSH_VLAN, /* struct ovs_action_push_vlan. */ 597 OVS_ACTION_ATTR_POP_VLAN, /* No argument. */ 598 OVS_ACTION_ATTR_SAMPLE, /* Nested OVS_SAMPLE_ATTR_*. */ 599 OVS_ACTION_ATTR_RECIRC, /* u32 recirc_id. */ 600 OVS_ACTION_ATTR_HASH, /* struct ovs_action_hash. */ 601 OVS_ACTION_ATTR_PUSH_MPLS, /* struct ovs_action_push_mpls. */ 602 OVS_ACTION_ATTR_POP_MPLS, /* __be16 ethertype. */ 603 604 __OVS_ACTION_ATTR_MAX 605 }; 606 607 #define OVS_ACTION_ATTR_MAX (__OVS_ACTION_ATTR_MAX - 1) 608 609 #endif /* _LINUX_OPENVSWITCH_H */ 610