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