openvswitch.h revision 224b54f69543a5c0ec18f99bd717d2b724582eb6
1 2/* 3 * Copyright (c) 2007-2011 Nicira Networks. 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 35struct 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#define OVS_DATAPATH_VERSION 0x1 44 45enum ovs_datapath_cmd { 46 OVS_DP_CMD_UNSPEC, 47 OVS_DP_CMD_NEW, 48 OVS_DP_CMD_DEL, 49 OVS_DP_CMD_GET, 50 OVS_DP_CMD_SET 51}; 52 53/** 54 * enum ovs_datapath_attr - attributes for %OVS_DP_* commands. 55 * @OVS_DP_ATTR_NAME: Name of the network device that serves as the "local 56 * port". This is the name of the network device whose dp_ifindex is given in 57 * the &struct ovs_header. Always present in notifications. Required in 58 * %OVS_DP_NEW requests. May be used as an alternative to specifying 59 * dp_ifindex in other requests (with a dp_ifindex of 0). 60 * @OVS_DP_ATTR_UPCALL_PID: The Netlink socket in userspace that is initially 61 * set on the datapath port (for OVS_ACTION_ATTR_MISS). Only valid on 62 * %OVS_DP_CMD_NEW requests. A value of zero indicates that upcalls should 63 * not be sent. 64 * @OVS_DP_ATTR_STATS: Statistics about packets that have passed through the 65 * datapath. Always present in notifications. 66 * 67 * These attributes follow the &struct ovs_header within the Generic Netlink 68 * payload for %OVS_DP_* commands. 69 */ 70enum ovs_datapath_attr { 71 OVS_DP_ATTR_UNSPEC, 72 OVS_DP_ATTR_NAME, /* name of dp_ifindex netdev */ 73 OVS_DP_ATTR_UPCALL_PID, /* Netlink PID to receive upcalls */ 74 OVS_DP_ATTR_STATS, /* struct ovs_dp_stats */ 75 __OVS_DP_ATTR_MAX 76}; 77 78#define OVS_DP_ATTR_MAX (__OVS_DP_ATTR_MAX - 1) 79 80struct ovs_dp_stats { 81 __u64 n_hit; /* Number of flow table matches. */ 82 __u64 n_missed; /* Number of flow table misses. */ 83 __u64 n_lost; /* Number of misses not sent to userspace. */ 84 __u64 n_flows; /* Number of flows present */ 85}; 86 87struct ovs_vport_stats { 88 __u64 rx_packets; /* total packets received */ 89 __u64 tx_packets; /* total packets transmitted */ 90 __u64 rx_bytes; /* total bytes received */ 91 __u64 tx_bytes; /* total bytes transmitted */ 92 __u64 rx_errors; /* bad packets received */ 93 __u64 tx_errors; /* packet transmit problems */ 94 __u64 rx_dropped; /* no space in linux buffers */ 95 __u64 tx_dropped; /* no space available in linux */ 96}; 97 98/* Fixed logical ports. */ 99#define OVSP_LOCAL ((__u32)0) 100 101/* Packet transfer. */ 102 103#define OVS_PACKET_FAMILY "ovs_packet" 104#define OVS_PACKET_VERSION 0x1 105 106enum ovs_packet_cmd { 107 OVS_PACKET_CMD_UNSPEC, 108 109 /* Kernel-to-user notifications. */ 110 OVS_PACKET_CMD_MISS, /* Flow table miss. */ 111 OVS_PACKET_CMD_ACTION, /* OVS_ACTION_ATTR_USERSPACE action. */ 112 113 /* Userspace commands. */ 114 OVS_PACKET_CMD_EXECUTE /* Apply actions to a packet. */ 115}; 116 117/** 118 * enum ovs_packet_attr - attributes for %OVS_PACKET_* commands. 119 * @OVS_PACKET_ATTR_PACKET: Present for all notifications. Contains the entire 120 * packet as received, from the start of the Ethernet header onward. For 121 * %OVS_PACKET_CMD_ACTION, %OVS_PACKET_ATTR_PACKET reflects changes made by 122 * actions preceding %OVS_ACTION_ATTR_USERSPACE, but %OVS_PACKET_ATTR_KEY is 123 * the flow key extracted from the packet as originally received. 124 * @OVS_PACKET_ATTR_KEY: Present for all notifications. Contains the flow key 125 * extracted from the packet as nested %OVS_KEY_ATTR_* attributes. This allows 126 * userspace to adapt its flow setup strategy by comparing its notion of the 127 * flow key against the kernel's. 128 * @OVS_PACKET_ATTR_ACTIONS: Contains actions for the packet. Used 129 * for %OVS_PACKET_CMD_EXECUTE. It has nested %OVS_ACTION_ATTR_* attributes. 130 * @OVS_PACKET_ATTR_USERDATA: Present for an %OVS_PACKET_CMD_ACTION 131 * notification if the %OVS_ACTION_ATTR_USERSPACE action specified an 132 * %OVS_USERSPACE_ATTR_USERDATA attribute, with the same length and content 133 * specified there. 134 * 135 * These attributes follow the &struct ovs_header within the Generic Netlink 136 * payload for %OVS_PACKET_* commands. 137 */ 138enum ovs_packet_attr { 139 OVS_PACKET_ATTR_UNSPEC, 140 OVS_PACKET_ATTR_PACKET, /* Packet data. */ 141 OVS_PACKET_ATTR_KEY, /* Nested OVS_KEY_ATTR_* attributes. */ 142 OVS_PACKET_ATTR_ACTIONS, /* Nested OVS_ACTION_ATTR_* attributes. */ 143 OVS_PACKET_ATTR_USERDATA, /* OVS_ACTION_ATTR_USERSPACE arg. */ 144 __OVS_PACKET_ATTR_MAX 145}; 146 147#define OVS_PACKET_ATTR_MAX (__OVS_PACKET_ATTR_MAX - 1) 148 149/* Virtual ports. */ 150 151#define OVS_VPORT_FAMILY "ovs_vport" 152#define OVS_VPORT_MCGROUP "ovs_vport" 153#define OVS_VPORT_VERSION 0x1 154 155enum ovs_vport_cmd { 156 OVS_VPORT_CMD_UNSPEC, 157 OVS_VPORT_CMD_NEW, 158 OVS_VPORT_CMD_DEL, 159 OVS_VPORT_CMD_GET, 160 OVS_VPORT_CMD_SET 161}; 162 163enum ovs_vport_type { 164 OVS_VPORT_TYPE_UNSPEC, 165 OVS_VPORT_TYPE_NETDEV, /* network device */ 166 OVS_VPORT_TYPE_INTERNAL, /* network device implemented by datapath */ 167 OVS_VPORT_TYPE_GRE, /* GRE tunnel. */ 168 __OVS_VPORT_TYPE_MAX 169}; 170 171#define OVS_VPORT_TYPE_MAX (__OVS_VPORT_TYPE_MAX - 1) 172 173/** 174 * enum ovs_vport_attr - attributes for %OVS_VPORT_* commands. 175 * @OVS_VPORT_ATTR_PORT_NO: 32-bit port number within datapath. 176 * @OVS_VPORT_ATTR_TYPE: 32-bit %OVS_VPORT_TYPE_* constant describing the type 177 * of vport. 178 * @OVS_VPORT_ATTR_NAME: Name of vport. For a vport based on a network device 179 * this is the name of the network device. Maximum length %IFNAMSIZ-1 bytes 180 * plus a null terminator. 181 * @OVS_VPORT_ATTR_OPTIONS: Vport-specific configuration information. 182 * @OVS_VPORT_ATTR_UPCALL_PID: The Netlink socket in userspace that 183 * OVS_PACKET_CMD_MISS upcalls will be directed to for packets received on 184 * this port. A value of zero indicates that upcalls should not be sent. 185 * @OVS_VPORT_ATTR_STATS: A &struct ovs_vport_stats giving statistics for 186 * packets sent or received through the vport. 187 * 188 * These attributes follow the &struct ovs_header within the Generic Netlink 189 * payload for %OVS_VPORT_* commands. 190 * 191 * For %OVS_VPORT_CMD_NEW requests, the %OVS_VPORT_ATTR_TYPE and 192 * %OVS_VPORT_ATTR_NAME attributes are required. %OVS_VPORT_ATTR_PORT_NO is 193 * optional; if not specified a free port number is automatically selected. 194 * Whether %OVS_VPORT_ATTR_OPTIONS is required or optional depends on the type 195 * of vport. 196 * 197 * For other requests, if %OVS_VPORT_ATTR_NAME is specified then it is used to 198 * look up the vport to operate on; otherwise dp_idx from the &struct 199 * ovs_header plus %OVS_VPORT_ATTR_PORT_NO determine the vport. 200 */ 201enum ovs_vport_attr { 202 OVS_VPORT_ATTR_UNSPEC, 203 OVS_VPORT_ATTR_PORT_NO, /* u32 port number within datapath */ 204 OVS_VPORT_ATTR_TYPE, /* u32 OVS_VPORT_TYPE_* constant. */ 205 OVS_VPORT_ATTR_NAME, /* string name, up to IFNAMSIZ bytes long */ 206 OVS_VPORT_ATTR_OPTIONS, /* nested attributes, varies by vport type */ 207 OVS_VPORT_ATTR_UPCALL_PID, /* u32 Netlink PID to receive upcalls */ 208 OVS_VPORT_ATTR_STATS, /* struct ovs_vport_stats */ 209 __OVS_VPORT_ATTR_MAX 210}; 211 212#define OVS_VPORT_ATTR_MAX (__OVS_VPORT_ATTR_MAX - 1) 213 214/* Flows. */ 215 216#define OVS_FLOW_FAMILY "ovs_flow" 217#define OVS_FLOW_MCGROUP "ovs_flow" 218#define OVS_FLOW_VERSION 0x1 219 220enum ovs_flow_cmd { 221 OVS_FLOW_CMD_UNSPEC, 222 OVS_FLOW_CMD_NEW, 223 OVS_FLOW_CMD_DEL, 224 OVS_FLOW_CMD_GET, 225 OVS_FLOW_CMD_SET 226}; 227 228struct ovs_flow_stats { 229 __u64 n_packets; /* Number of matched packets. */ 230 __u64 n_bytes; /* Number of matched bytes. */ 231}; 232 233enum ovs_key_attr { 234 OVS_KEY_ATTR_UNSPEC, 235 OVS_KEY_ATTR_ENCAP, /* Nested set of encapsulated attributes. */ 236 OVS_KEY_ATTR_PRIORITY, /* u32 skb->priority */ 237 OVS_KEY_ATTR_IN_PORT, /* u32 OVS dp port number */ 238 OVS_KEY_ATTR_ETHERNET, /* struct ovs_key_ethernet */ 239 OVS_KEY_ATTR_VLAN, /* be16 VLAN TCI */ 240 OVS_KEY_ATTR_ETHERTYPE, /* be16 Ethernet type */ 241 OVS_KEY_ATTR_IPV4, /* struct ovs_key_ipv4 */ 242 OVS_KEY_ATTR_IPV6, /* struct ovs_key_ipv6 */ 243 OVS_KEY_ATTR_TCP, /* struct ovs_key_tcp */ 244 OVS_KEY_ATTR_UDP, /* struct ovs_key_udp */ 245 OVS_KEY_ATTR_ICMP, /* struct ovs_key_icmp */ 246 OVS_KEY_ATTR_ICMPV6, /* struct ovs_key_icmpv6 */ 247 OVS_KEY_ATTR_ARP, /* struct ovs_key_arp */ 248 OVS_KEY_ATTR_ND, /* struct ovs_key_nd */ 249 OVS_KEY_ATTR_SKB_MARK, /* u32 skb mark */ 250 OVS_KEY_ATTR_TUNNEL, /* Nested set of ovs_tunnel attributes */ 251 252#ifdef __KERNEL__ 253 OVS_KEY_ATTR_IPV4_TUNNEL, /* struct ovs_key_ipv4_tunnel */ 254#endif 255 __OVS_KEY_ATTR_MAX 256}; 257 258#define OVS_KEY_ATTR_MAX (__OVS_KEY_ATTR_MAX - 1) 259 260enum ovs_tunnel_key_attr { 261 OVS_TUNNEL_KEY_ATTR_ID, /* be64 Tunnel ID */ 262 OVS_TUNNEL_KEY_ATTR_IPV4_SRC, /* be32 src IP address. */ 263 OVS_TUNNEL_KEY_ATTR_IPV4_DST, /* be32 dst IP address. */ 264 OVS_TUNNEL_KEY_ATTR_TOS, /* u8 Tunnel IP ToS. */ 265 OVS_TUNNEL_KEY_ATTR_TTL, /* u8 Tunnel IP TTL. */ 266 OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT, /* No argument, set DF. */ 267 OVS_TUNNEL_KEY_ATTR_CSUM, /* No argument. CSUM packet. */ 268 __OVS_TUNNEL_KEY_ATTR_MAX 269}; 270 271#define OVS_TUNNEL_KEY_ATTR_MAX (__OVS_TUNNEL_KEY_ATTR_MAX - 1) 272 273/** 274 * enum ovs_frag_type - IPv4 and IPv6 fragment type 275 * @OVS_FRAG_TYPE_NONE: Packet is not a fragment. 276 * @OVS_FRAG_TYPE_FIRST: Packet is a fragment with offset 0. 277 * @OVS_FRAG_TYPE_LATER: Packet is a fragment with nonzero offset. 278 * 279 * Used as the @ipv4_frag in &struct ovs_key_ipv4 and as @ipv6_frag &struct 280 * ovs_key_ipv6. 281 */ 282enum ovs_frag_type { 283 OVS_FRAG_TYPE_NONE, 284 OVS_FRAG_TYPE_FIRST, 285 OVS_FRAG_TYPE_LATER, 286 __OVS_FRAG_TYPE_MAX 287}; 288 289#define OVS_FRAG_TYPE_MAX (__OVS_FRAG_TYPE_MAX - 1) 290 291struct ovs_key_ethernet { 292 __u8 eth_src[ETH_ALEN]; 293 __u8 eth_dst[ETH_ALEN]; 294}; 295 296struct ovs_key_ipv4 { 297 __be32 ipv4_src; 298 __be32 ipv4_dst; 299 __u8 ipv4_proto; 300 __u8 ipv4_tos; 301 __u8 ipv4_ttl; 302 __u8 ipv4_frag; /* One of OVS_FRAG_TYPE_*. */ 303}; 304 305struct ovs_key_ipv6 { 306 __be32 ipv6_src[4]; 307 __be32 ipv6_dst[4]; 308 __be32 ipv6_label; /* 20-bits in least-significant bits. */ 309 __u8 ipv6_proto; 310 __u8 ipv6_tclass; 311 __u8 ipv6_hlimit; 312 __u8 ipv6_frag; /* One of OVS_FRAG_TYPE_*. */ 313}; 314 315struct ovs_key_tcp { 316 __be16 tcp_src; 317 __be16 tcp_dst; 318}; 319 320struct ovs_key_udp { 321 __be16 udp_src; 322 __be16 udp_dst; 323}; 324 325struct ovs_key_icmp { 326 __u8 icmp_type; 327 __u8 icmp_code; 328}; 329 330struct ovs_key_icmpv6 { 331 __u8 icmpv6_type; 332 __u8 icmpv6_code; 333}; 334 335struct ovs_key_arp { 336 __be32 arp_sip; 337 __be32 arp_tip; 338 __be16 arp_op; 339 __u8 arp_sha[ETH_ALEN]; 340 __u8 arp_tha[ETH_ALEN]; 341}; 342 343struct ovs_key_nd { 344 __u32 nd_target[4]; 345 __u8 nd_sll[ETH_ALEN]; 346 __u8 nd_tll[ETH_ALEN]; 347}; 348 349/** 350 * enum ovs_flow_attr - attributes for %OVS_FLOW_* commands. 351 * @OVS_FLOW_ATTR_KEY: Nested %OVS_KEY_ATTR_* attributes specifying the flow 352 * key. Always present in notifications. Required for all requests (except 353 * dumps). 354 * @OVS_FLOW_ATTR_ACTIONS: Nested %OVS_ACTION_ATTR_* attributes specifying 355 * the actions to take for packets that match the key. Always present in 356 * notifications. Required for %OVS_FLOW_CMD_NEW requests, optional for 357 * %OVS_FLOW_CMD_SET requests. 358 * @OVS_FLOW_ATTR_STATS: &struct ovs_flow_stats giving statistics for this 359 * flow. Present in notifications if the stats would be nonzero. Ignored in 360 * requests. 361 * @OVS_FLOW_ATTR_TCP_FLAGS: An 8-bit value giving the OR'd value of all of the 362 * TCP flags seen on packets in this flow. Only present in notifications for 363 * TCP flows, and only if it would be nonzero. Ignored in requests. 364 * @OVS_FLOW_ATTR_USED: A 64-bit integer giving the time, in milliseconds on 365 * the system monotonic clock, at which a packet was last processed for this 366 * flow. Only present in notifications if a packet has been processed for this 367 * flow. Ignored in requests. 368 * @OVS_FLOW_ATTR_CLEAR: If present in a %OVS_FLOW_CMD_SET request, clears the 369 * last-used time, accumulated TCP flags, and statistics for this flow. 370 * Otherwise ignored in requests. Never present in notifications. 371 * 372 * These attributes follow the &struct ovs_header within the Generic Netlink 373 * payload for %OVS_FLOW_* commands. 374 */ 375enum ovs_flow_attr { 376 OVS_FLOW_ATTR_UNSPEC, 377 OVS_FLOW_ATTR_KEY, /* Sequence of OVS_KEY_ATTR_* attributes. */ 378 OVS_FLOW_ATTR_ACTIONS, /* Nested OVS_ACTION_ATTR_* attributes. */ 379 OVS_FLOW_ATTR_STATS, /* struct ovs_flow_stats. */ 380 OVS_FLOW_ATTR_TCP_FLAGS, /* 8-bit OR'd TCP flags. */ 381 OVS_FLOW_ATTR_USED, /* u64 msecs last used in monotonic time. */ 382 OVS_FLOW_ATTR_CLEAR, /* Flag to clear stats, tcp_flags, used. */ 383 __OVS_FLOW_ATTR_MAX 384}; 385 386#define OVS_FLOW_ATTR_MAX (__OVS_FLOW_ATTR_MAX - 1) 387 388/** 389 * enum ovs_sample_attr - Attributes for %OVS_ACTION_ATTR_SAMPLE action. 390 * @OVS_SAMPLE_ATTR_PROBABILITY: 32-bit fraction of packets to sample with 391 * @OVS_ACTION_ATTR_SAMPLE. A value of 0 samples no packets, a value of 392 * %UINT32_MAX samples all packets and intermediate values sample intermediate 393 * fractions of packets. 394 * @OVS_SAMPLE_ATTR_ACTIONS: Set of actions to execute in sampling event. 395 * Actions are passed as nested attributes. 396 * 397 * Executes the specified actions with the given probability on a per-packet 398 * basis. 399 */ 400enum ovs_sample_attr { 401 OVS_SAMPLE_ATTR_UNSPEC, 402 OVS_SAMPLE_ATTR_PROBABILITY, /* u32 number */ 403 OVS_SAMPLE_ATTR_ACTIONS, /* Nested OVS_ACTION_ATTR_* attributes. */ 404 __OVS_SAMPLE_ATTR_MAX, 405}; 406 407#define OVS_SAMPLE_ATTR_MAX (__OVS_SAMPLE_ATTR_MAX - 1) 408 409/** 410 * enum ovs_userspace_attr - Attributes for %OVS_ACTION_ATTR_USERSPACE action. 411 * @OVS_USERSPACE_ATTR_PID: u32 Netlink PID to which the %OVS_PACKET_CMD_ACTION 412 * message should be sent. Required. 413 * @OVS_USERSPACE_ATTR_USERDATA: If present, its variable-length argument is 414 * copied to the %OVS_PACKET_CMD_ACTION message as %OVS_PACKET_ATTR_USERDATA. 415 */ 416enum ovs_userspace_attr { 417 OVS_USERSPACE_ATTR_UNSPEC, 418 OVS_USERSPACE_ATTR_PID, /* u32 Netlink PID to receive upcalls. */ 419 OVS_USERSPACE_ATTR_USERDATA, /* Optional user-specified cookie. */ 420 __OVS_USERSPACE_ATTR_MAX 421}; 422 423#define OVS_USERSPACE_ATTR_MAX (__OVS_USERSPACE_ATTR_MAX - 1) 424 425/** 426 * struct ovs_action_push_vlan - %OVS_ACTION_ATTR_PUSH_VLAN action argument. 427 * @vlan_tpid: Tag protocol identifier (TPID) to push. 428 * @vlan_tci: Tag control identifier (TCI) to push. The CFI bit must be set 429 * (but it will not be set in the 802.1Q header that is pushed). 430 * 431 * The @vlan_tpid value is typically %ETH_P_8021Q. The only acceptable TPID 432 * values are those that the kernel module also parses as 802.1Q headers, to 433 * prevent %OVS_ACTION_ATTR_PUSH_VLAN followed by %OVS_ACTION_ATTR_POP_VLAN 434 * from having surprising results. 435 */ 436struct ovs_action_push_vlan { 437 __be16 vlan_tpid; /* 802.1Q TPID. */ 438 __be16 vlan_tci; /* 802.1Q TCI (VLAN ID and priority). */ 439}; 440 441/** 442 * enum ovs_action_attr - Action types. 443 * 444 * @OVS_ACTION_ATTR_OUTPUT: Output packet to port. 445 * @OVS_ACTION_ATTR_USERSPACE: Send packet to userspace according to nested 446 * %OVS_USERSPACE_ATTR_* attributes. 447 * @OVS_ACTION_ATTR_SET: Replaces the contents of an existing header. The 448 * single nested %OVS_KEY_ATTR_* attribute specifies a header to modify and its 449 * value. 450 * @OVS_ACTION_ATTR_PUSH_VLAN: Push a new outermost 802.1Q header onto the 451 * packet. 452 * @OVS_ACTION_ATTR_POP_VLAN: Pop the outermost 802.1Q header off the packet. 453 * @OVS_ACTION_ATTR_SAMPLE: Probabilitically executes actions, as specified in 454 * the nested %OVS_SAMPLE_ATTR_* attributes. 455 * 456 * Only a single header can be set with a single %OVS_ACTION_ATTR_SET. Not all 457 * fields within a header are modifiable, e.g. the IPv4 protocol and fragment 458 * type may not be changed. 459 */ 460 461enum ovs_action_attr { 462 OVS_ACTION_ATTR_UNSPEC, 463 OVS_ACTION_ATTR_OUTPUT, /* u32 port number. */ 464 OVS_ACTION_ATTR_USERSPACE, /* Nested OVS_USERSPACE_ATTR_*. */ 465 OVS_ACTION_ATTR_SET, /* One nested OVS_KEY_ATTR_*. */ 466 OVS_ACTION_ATTR_PUSH_VLAN, /* struct ovs_action_push_vlan. */ 467 OVS_ACTION_ATTR_POP_VLAN, /* No argument. */ 468 OVS_ACTION_ATTR_SAMPLE, /* Nested OVS_SAMPLE_ATTR_*. */ 469 __OVS_ACTION_ATTR_MAX 470}; 471 472#define OVS_ACTION_ATTR_MAX (__OVS_ACTION_ATTR_MAX - 1) 473 474#endif /* _LINUX_OPENVSWITCH_H */ 475