include/uapi/linux/openvswitch.h

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