include/linux/openvswitch.h

   1 /*
   2  * Copyright (c) 2007-2011 Nicira, Inc.
   3  *
   4  * This file is offered under your choice of two licenses: Apache 2.0 or GNU
   5  * GPL 2.0 or later.  The permission statements for each of these licenses is
   6  * given below.  You may license your modifications to this file under either
   7  * of these licenses or both.  If you wish to license your modifications under
   8  * only one of these licenses, delete the permission text for the other
   9  * license.
  10  *
  11  * ----------------------------------------------------------------------
  12  * Licensed under the Apache License, Version 2.0 (the "License");
  13  * you may not use this file except in compliance with the License.
  14  * You may obtain a copy of the License at:
  15  *
  16  *     http://www.apache.org/licenses/LICENSE-2.0
  17  *
  18  * Unless required by applicable law or agreed to in writing, software
  19  * distributed under the License is distributed on an "AS IS" BASIS,
  20  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  21  * See the License for the specific language governing permissions and
  22  * limitations under the License.
  23  * ----------------------------------------------------------------------
  24  * This program is free software; you can redistribute it and/or
  25  * modify it under the terms of version 2 of the GNU General Public
  26  * License as published by the Free Software Foundation.
  27  *
  28  * This program is distributed in the hope that it will be useful, but
  29  * WITHOUT ANY WARRANTY; without even the implied warranty of
  30  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  31  * General Public License for more details.
  32  *
  33  * You should have received a copy of the GNU General Public License
  34  * along with this program; if not, write to the Free Software
  35  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  36  * 02110-1301, USA
  37  * ----------------------------------------------------------------------
  38  */
  39
  40 #ifndef _LINUX_OPENVSWITCH_H
  41 #define _LINUX_OPENVSWITCH_H 1
  42
  43 #include <linux/types.h>
  44
  45 /**
  46  * struct ovs_header - header for OVS Generic Netlink messages.
  47  * @dp_ifindex: ifindex of local port for datapath (0 to make a request not
  48  * specific to a datapath).
  49  *
  50  * Attributes following the header are specific to a particular OVS Generic
  51  * Netlink family, but all of the OVS families use this header.
  52  */
  53
  54 struct ovs_header {
  55         int dp_ifindex;
  56 };
  57
  58 /* Datapaths. */
  59
  60 #define OVS_DATAPATH_FAMILY  "ovs_datapath"
  61 #define OVS_DATAPATH_MCGROUP "ovs_datapath"
  62 #define OVS_DATAPATH_VERSION 0x1
  63
  64 enum ovs_datapath_cmd {
  65         OVS_DP_CMD_UNSPEC,
  66         OVS_DP_CMD_NEW,
  67         OVS_DP_CMD_DEL,
  68         OVS_DP_CMD_GET,
  69         OVS_DP_CMD_SET
  70 };
  71
  72 /**
  73  * enum ovs_datapath_attr - attributes for %OVS_DP_* commands.
  74  * @OVS_DP_ATTR_NAME: Name of the network device that serves as the "local
  75  * port".  This is the name of the network device whose dp_ifindex is given in
  76  * the &struct ovs_header.  Always present in notifications.  Required in
  77  * %OVS_DP_NEW requests.  May be used as an alternative to specifying
  78  * dp_ifindex in other requests (with a dp_ifindex of 0).
  79  * @OVS_DP_ATTR_UPCALL_PID: The Netlink socket in userspace that is initially
  80  * set on the datapath port (for OVS_ACTION_ATTR_MISS).  Only valid on
  81  * %OVS_DP_CMD_NEW requests. A value of zero indicates that upcalls should
  82  * not be sent.
  83  * @OVS_DP_ATTR_STATS: Statistics about packets that have passed through the
  84  * datapath.  Always present in notifications.
  85  *
  86  * These attributes follow the &struct ovs_header within the Generic Netlink
  87  * payload for %OVS_DP_* commands.
  88  */
  89 enum ovs_datapath_attr {
  90         OVS_DP_ATTR_UNSPEC,
  91         OVS_DP_ATTR_NAME,       /* name of dp_ifindex netdev */
  92         OVS_DP_ATTR_UPCALL_PID, /* Netlink PID to receive upcalls */
  93         OVS_DP_ATTR_STATS,      /* struct ovs_dp_stats */
  94         __OVS_DP_ATTR_MAX
  95 };
  96
  97 #define OVS_DP_ATTR_MAX (__OVS_DP_ATTR_MAX - 1)
  98
  99 struct ovs_dp_stats {
 100         __u64 n_hit;             /* Number of flow table matches. */
 101         __u64 n_missed;          /* Number of flow table misses. */
 102         __u64 n_lost;            /* Number of misses not sent to userspace. */
 103         __u64 n_flows;           /* Number of flows present */
 104 };
 105
 106 struct ovs_vport_stats {
 107         __u64   rx_packets;             /* total packets received       */
 108         __u64   tx_packets;             /* total packets transmitted    */
 109         __u64   rx_bytes;               /* total bytes received         */
 110         __u64   tx_bytes;               /* total bytes transmitted      */
 111         __u64   rx_errors;              /* bad packets received         */
 112         __u64   tx_errors;              /* packet transmit problems     */
 113         __u64   rx_dropped;             /* no space in linux buffers    */
 114         __u64   tx_dropped;             /* no space available in linux  */
 115 };
 116
 117 /* Fixed logical ports. */
 118 #define OVSP_LOCAL      ((__u32)0)
 119
 120 /* Packet transfer. */
 121
 122 #define OVS_PACKET_FAMILY "ovs_packet"
 123 #define OVS_PACKET_VERSION 0x1
 124
 125 enum ovs_packet_cmd {
 126         OVS_PACKET_CMD_UNSPEC,
 127
 128         /* Kernel-to-user notifications. */
 129         OVS_PACKET_CMD_MISS,    /* Flow table miss. */
 130         OVS_PACKET_CMD_ACTION,  /* OVS_ACTION_ATTR_USERSPACE action. */
 131
 132         /* Userspace commands. */
 133         OVS_PACKET_CMD_EXECUTE  /* Apply actions to a packet. */
 134 };
 135
 136 /**
 137  * enum ovs_packet_attr - attributes for %OVS_PACKET_* commands.
 138  * @OVS_PACKET_ATTR_PACKET: Present for all notifications.  Contains the entire
 139  * packet as received, from the start of the Ethernet header onward.  For
 140  * %OVS_PACKET_CMD_ACTION, %OVS_PACKET_ATTR_PACKET reflects changes made by
 141  * actions preceding %OVS_ACTION_ATTR_USERSPACE, but %OVS_PACKET_ATTR_KEY is
 142  * the flow key extracted from the packet as originally received.
 143  * @OVS_PACKET_ATTR_KEY: Present for all notifications.  Contains the flow key
 144  * extracted from the packet as nested %OVS_KEY_ATTR_* attributes.  This allows
 145  * userspace to adapt its flow setup strategy by comparing its notion of the
 146  * flow key against the kernel's.
 147  * @OVS_PACKET_ATTR_ACTIONS: Contains actions for the packet.  Used
 148  * for %OVS_PACKET_CMD_EXECUTE.  It has nested %OVS_ACTION_ATTR_* attributes.
 149  * @OVS_PACKET_ATTR_USERDATA: Present for an %OVS_PACKET_CMD_ACTION
 150  * notification if the %OVS_ACTION_ATTR_USERSPACE action specified an
 151  * %OVS_USERSPACE_ATTR_USERDATA attribute, with the same length and content
 152  * specified there.
 153  *
 154  * These attributes follow the &struct ovs_header within the Generic Netlink
 155  * payload for %OVS_PACKET_* commands.
 156  */
 157 enum ovs_packet_attr {
 158         OVS_PACKET_ATTR_UNSPEC,
 159         OVS_PACKET_ATTR_PACKET,      /* Packet data. */
 160         OVS_PACKET_ATTR_KEY,         /* Nested OVS_KEY_ATTR_* attributes. */
 161         OVS_PACKET_ATTR_ACTIONS,     /* Nested OVS_ACTION_ATTR_* attributes. */
 162         OVS_PACKET_ATTR_USERDATA,    /* OVS_ACTION_ATTR_USERSPACE arg. */
 163         __OVS_PACKET_ATTR_MAX
 164 };
 165
 166 #define OVS_PACKET_ATTR_MAX (__OVS_PACKET_ATTR_MAX - 1)
 167
 168 /* Virtual ports. */
 169
 170 #define OVS_VPORT_FAMILY  "ovs_vport"
 171 #define OVS_VPORT_MCGROUP "ovs_vport"
 172 #define OVS_VPORT_VERSION 0x1
 173
 174 enum ovs_vport_cmd {
 175         OVS_VPORT_CMD_UNSPEC,
 176         OVS_VPORT_CMD_NEW,
 177         OVS_VPORT_CMD_DEL,
 178         OVS_VPORT_CMD_GET,
 179         OVS_VPORT_CMD_SET
 180 };
 181
 182 enum ovs_vport_type {
 183         OVS_VPORT_TYPE_UNSPEC,
 184         OVS_VPORT_TYPE_NETDEV,   /* network device */
 185         OVS_VPORT_TYPE_INTERNAL, /* network device implemented by datapath */
 186         OVS_VPORT_TYPE_GRE,      /* GRE tunnel. */
 187         OVS_VPORT_TYPE_VXLAN,    /* VXLAN tunnel */
 188         OVS_VPORT_TYPE_GRE64 = 104, /* GRE tunnel with 64-bit keys */
 189         __OVS_VPORT_TYPE_MAX
 190 };
 191
 192 #define OVS_VPORT_TYPE_MAX (__OVS_VPORT_TYPE_MAX - 1)
 193
 194 /**
 195  * enum ovs_vport_attr - attributes for %OVS_VPORT_* commands.
 196  * @OVS_VPORT_ATTR_PORT_NO: 32-bit port number within datapath.
 197  * @OVS_VPORT_ATTR_TYPE: 32-bit %OVS_VPORT_TYPE_* constant describing the type
 198  * of vport.
 199  * @OVS_VPORT_ATTR_NAME: Name of vport.  For a vport based on a network device
 200  * this is the name of the network device.  Maximum length %IFNAMSIZ-1 bytes
 201  * plus a null terminator.
 202  * @OVS_VPORT_ATTR_OPTIONS: Vport-specific configuration information.
 203  * @OVS_VPORT_ATTR_UPCALL_PID: The Netlink socket in userspace that
 204  * OVS_PACKET_CMD_MISS upcalls will be directed to for packets received on
 205  * this port.  A value of zero indicates that upcalls should not be sent.
 206  * @OVS_VPORT_ATTR_STATS: A &struct ovs_vport_stats giving statistics for
 207  * packets sent or received through the vport.
 208  *
 209  * These attributes follow the &struct ovs_header within the Generic Netlink
 210  * payload for %OVS_VPORT_* commands.
 211  *
 212  * For %OVS_VPORT_CMD_NEW requests, the %OVS_VPORT_ATTR_TYPE and
 213  * %OVS_VPORT_ATTR_NAME attributes are required.  %OVS_VPORT_ATTR_PORT_NO is
 214  * optional; if not specified a free port number is automatically selected.
 215  * Whether %OVS_VPORT_ATTR_OPTIONS is required or optional depends on the type
 216  * of vport.  %OVS_VPORT_ATTR_STATS is optional and other attributes are
 217  * ignored.
 218  *
 219  * For other requests, if %OVS_VPORT_ATTR_NAME is specified then it is used to
 220  * look up the vport to operate on; otherwise dp_idx from the &struct
 221  * ovs_header plus %OVS_VPORT_ATTR_PORT_NO determine the vport.
 222  */
 223 enum ovs_vport_attr {
 224         OVS_VPORT_ATTR_UNSPEC,
 225         OVS_VPORT_ATTR_PORT_NO, /* u32 port number within datapath */
 226         OVS_VPORT_ATTR_TYPE,    /* u32 OVS_VPORT_TYPE_* constant. */
 227         OVS_VPORT_ATTR_NAME,    /* string name, up to IFNAMSIZ bytes long */
 228         OVS_VPORT_ATTR_OPTIONS, /* nested attributes, varies by vport type */
 229         OVS_VPORT_ATTR_UPCALL_PID, /* u32 Netlink PID to receive upcalls */
 230         OVS_VPORT_ATTR_STATS,   /* struct ovs_vport_stats */
 231         __OVS_VPORT_ATTR_MAX
 232 };
 233
 234 #define OVS_VPORT_ATTR_MAX (__OVS_VPORT_ATTR_MAX - 1)
 235
 236 /* OVS_VPORT_ATTR_OPTIONS attributes for patch vports. */
 237 enum {
 238         OVS_PATCH_ATTR_UNSPEC,
 239         OVS_PATCH_ATTR_PEER,    /* name of peer vport, as a string */
 240         __OVS_PATCH_ATTR_MAX
 241 };
 242
 243 #define OVS_PATCH_ATTR_MAX (__OVS_PATCH_ATTR_MAX - 1)
 244
 245 /* Flows. */
 246
 247 #define OVS_FLOW_FAMILY  "ovs_flow"
 248 #define OVS_FLOW_MCGROUP "ovs_flow"
 249 #define OVS_FLOW_VERSION 0x1
 250
 251 enum ovs_flow_cmd {
 252         OVS_FLOW_CMD_UNSPEC,
 253         OVS_FLOW_CMD_NEW,
 254         OVS_FLOW_CMD_DEL,
 255         OVS_FLOW_CMD_GET,
 256         OVS_FLOW_CMD_SET
 257 };
 258
 259 struct ovs_flow_stats {
 260         __u64 n_packets;         /* Number of matched packets. */
 261         __u64 n_bytes;           /* Number of matched bytes. */
 262 };
 263
 264 enum ovs_key_attr {
 265         OVS_KEY_ATTR_UNSPEC,
 266         OVS_KEY_ATTR_ENCAP,     /* Nested set of encapsulated attributes. */
 267         OVS_KEY_ATTR_PRIORITY,  /* u32 skb->priority */
 268         OVS_KEY_ATTR_IN_PORT,   /* u32 OVS dp port number */
 269         OVS_KEY_ATTR_ETHERNET,  /* struct ovs_key_ethernet */
 270         OVS_KEY_ATTR_VLAN,      /* be16 VLAN TCI */
 271         OVS_KEY_ATTR_ETHERTYPE, /* be16 Ethernet type */
 272         OVS_KEY_ATTR_IPV4,      /* struct ovs_key_ipv4 */
 273         OVS_KEY_ATTR_IPV6,      /* struct ovs_key_ipv6 */
 274         OVS_KEY_ATTR_TCP,       /* struct ovs_key_tcp */
 275         OVS_KEY_ATTR_UDP,       /* struct ovs_key_udp */
 276         OVS_KEY_ATTR_ICMP,      /* struct ovs_key_icmp */
 277         OVS_KEY_ATTR_ICMPV6,    /* struct ovs_key_icmpv6 */
 278         OVS_KEY_ATTR_ARP,       /* struct ovs_key_arp */
 279         OVS_KEY_ATTR_ND,        /* struct ovs_key_nd */
 280         OVS_KEY_ATTR_SKB_MARK,  /* u32 skb mark */
 281         OVS_KEY_ATTR_TUNNEL,    /* Nested set of ovs_tunnel attributes */
 282
 283 #ifdef __KERNEL__
 284         OVS_KEY_ATTR_IPV4_TUNNEL,  /* struct ovs_key_ipv4_tunnel */
 285 #endif
 286
 287         OVS_KEY_ATTR_MPLS = 62, /* struct ovs_key_mpls */
 288         OVS_KEY_ATTR_TUN_ID = 63,  /* be64 tunnel ID */
 289         __OVS_KEY_ATTR_MAX
 290 };
 291
 292 #define OVS_KEY_ATTR_MAX (__OVS_KEY_ATTR_MAX - 1)
 293
 294 enum ovs_tunnel_key_attr {
 295         OVS_TUNNEL_KEY_ATTR_ID,                 /* be64 Tunnel ID */
 296         OVS_TUNNEL_KEY_ATTR_IPV4_SRC,           /* be32 src IP address. */
 297         OVS_TUNNEL_KEY_ATTR_IPV4_DST,           /* be32 dst IP address. */
 298         OVS_TUNNEL_KEY_ATTR_TOS,                /* u8 Tunnel IP ToS. */
 299         OVS_TUNNEL_KEY_ATTR_TTL,                /* u8 Tunnel IP TTL. */
 300         OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT,      /* No argument, set DF. */
 301         OVS_TUNNEL_KEY_ATTR_CSUM,               /* No argument. CSUM packet. */
 302         __OVS_TUNNEL_KEY_ATTR_MAX
 303 };
 304
 305 #define OVS_TUNNEL_KEY_ATTR_MAX (__OVS_TUNNEL_KEY_ATTR_MAX - 1)
 306
 307 /**
 308  * enum ovs_frag_type - IPv4 and IPv6 fragment type
 309  * @OVS_FRAG_TYPE_NONE: Packet is not a fragment.
 310  * @OVS_FRAG_TYPE_FIRST: Packet is a fragment with offset 0.
 311  * @OVS_FRAG_TYPE_LATER: Packet is a fragment with nonzero offset.
 312  *
 313  * Used as the @ipv4_frag in &struct ovs_key_ipv4 and as @ipv6_frag &struct
 314  * ovs_key_ipv6.
 315  */
 316 enum ovs_frag_type {
 317         OVS_FRAG_TYPE_NONE,
 318         OVS_FRAG_TYPE_FIRST,
 319         OVS_FRAG_TYPE_LATER,
 320         __OVS_FRAG_TYPE_MAX
 321 };
 322
 323 #define OVS_FRAG_TYPE_MAX (__OVS_FRAG_TYPE_MAX - 1)
 324
 325 struct ovs_key_ethernet {
 326         __u8     eth_src[6];
 327         __u8     eth_dst[6];
 328 };
 329
 330 struct ovs_key_mpls {
 331         __be32 mpls_top_lse;
 332 };
 333
 334 struct ovs_key_ipv4 {
 335         __be32 ipv4_src;
 336         __be32 ipv4_dst;
 337         __u8   ipv4_proto;
 338         __u8   ipv4_tos;
 339         __u8   ipv4_ttl;
 340         __u8   ipv4_frag;       /* One of OVS_FRAG_TYPE_*. */
 341 };
 342
 343 struct ovs_key_ipv6 {
 344         __be32 ipv6_src[4];
 345         __be32 ipv6_dst[4];
 346         __be32 ipv6_label;      /* 20-bits in least-significant bits. */
 347         __u8   ipv6_proto;
 348         __u8   ipv6_tclass;
 349         __u8   ipv6_hlimit;
 350         __u8   ipv6_frag;       /* One of OVS_FRAG_TYPE_*. */
 351 };
 352
 353 struct ovs_key_tcp {
 354         __be16 tcp_src;
 355         __be16 tcp_dst;
 356 };
 357
 358 struct ovs_key_udp {
 359         __be16 udp_src;
 360         __be16 udp_dst;
 361 };
 362
 363 struct ovs_key_icmp {
 364         __u8 icmp_type;
 365         __u8 icmp_code;
 366 };
 367
 368 struct ovs_key_icmpv6 {
 369         __u8 icmpv6_type;
 370         __u8 icmpv6_code;
 371 };
 372
 373 struct ovs_key_arp {
 374         __be32 arp_sip;
 375         __be32 arp_tip;
 376         __be16 arp_op;
 377         __u8   arp_sha[6];
 378         __u8   arp_tha[6];
 379 };
 380
 381 struct ovs_key_nd {
 382         __u32 nd_target[4];
 383         __u8  nd_sll[6];
 384         __u8  nd_tll[6];
 385 };
 386
 387 /**
 388  * enum ovs_flow_attr - attributes for %OVS_FLOW_* commands.
 389  * @OVS_FLOW_ATTR_KEY: Nested %OVS_KEY_ATTR_* attributes specifying the flow
 390  * key.  Always present in notifications.  Required for all requests (except
 391  * dumps).
 392  * @OVS_FLOW_ATTR_ACTIONS: Nested %OVS_ACTION_ATTR_* attributes specifying
 393  * the actions to take for packets that match the key.  Always present in
 394  * notifications.  Required for %OVS_FLOW_CMD_NEW requests, optional for
 395  * %OVS_FLOW_CMD_SET requests.
 396  * @OVS_FLOW_ATTR_STATS: &struct ovs_flow_stats giving statistics for this
 397  * flow.  Present in notifications if the stats would be nonzero.  Ignored in
 398  * requests.
 399  * @OVS_FLOW_ATTR_TCP_FLAGS: An 8-bit value giving the OR'd value of all of the
 400  * TCP flags seen on packets in this flow.  Only present in notifications for
 401  * TCP flows, and only if it would be nonzero.  Ignored in requests.
 402  * @OVS_FLOW_ATTR_USED: A 64-bit integer giving the time, in milliseconds on
 403  * the system monotonic clock, at which a packet was last processed for this
 404  * flow.  Only present in notifications if a packet has been processed for this
 405  * flow.  Ignored in requests.
 406  * @OVS_FLOW_ATTR_CLEAR: If present in a %OVS_FLOW_CMD_SET request, clears the
 407  * last-used time, accumulated TCP flags, and statistics for this flow.
 408  * Otherwise ignored in requests.  Never present in notifications.
 409  *
 410  * These attributes follow the &struct ovs_header within the Generic Netlink
 411  * payload for %OVS_FLOW_* commands.
 412  */
 413 enum ovs_flow_attr {
 414         OVS_FLOW_ATTR_UNSPEC,
 415         OVS_FLOW_ATTR_KEY,       /* Sequence of OVS_KEY_ATTR_* attributes. */
 416         OVS_FLOW_ATTR_ACTIONS,   /* Nested OVS_ACTION_ATTR_* attributes. */
 417         OVS_FLOW_ATTR_STATS,     /* struct ovs_flow_stats. */
 418         OVS_FLOW_ATTR_TCP_FLAGS, /* 8-bit OR'd TCP flags. */
 419         OVS_FLOW_ATTR_USED,      /* u64 msecs last used in monotonic time. */
 420         OVS_FLOW_ATTR_CLEAR,     /* Flag to clear stats, tcp_flags, used. */
 421         __OVS_FLOW_ATTR_MAX
 422 };
 423
 424 #define OVS_FLOW_ATTR_MAX (__OVS_FLOW_ATTR_MAX - 1)
 425
 426 /**
 427  * enum ovs_sample_attr - Attributes for %OVS_ACTION_ATTR_SAMPLE action.
 428  * @OVS_SAMPLE_ATTR_PROBABILITY: 32-bit fraction of packets to sample with
 429  * @OVS_ACTION_ATTR_SAMPLE.  A value of 0 samples no packets, a value of
 430  * %UINT32_MAX samples all packets and intermediate values sample intermediate
 431  * fractions of packets.
 432  * @OVS_SAMPLE_ATTR_ACTIONS: Set of actions to execute in sampling event.
 433  * Actions are passed as nested attributes.
 434  *
 435  * Executes the specified actions with the given probability on a per-packet
 436  * basis.
 437  */
 438 enum ovs_sample_attr {
 439         OVS_SAMPLE_ATTR_UNSPEC,
 440         OVS_SAMPLE_ATTR_PROBABILITY, /* u32 number */
 441         OVS_SAMPLE_ATTR_ACTIONS,     /* Nested OVS_ACTION_ATTR_* attributes. */
 442         __OVS_SAMPLE_ATTR_MAX,
 443 };
 444
 445 #define OVS_SAMPLE_ATTR_MAX (__OVS_SAMPLE_ATTR_MAX - 1)
 446
 447 /**
 448  * enum ovs_userspace_attr - Attributes for %OVS_ACTION_ATTR_USERSPACE action.
 449  * @OVS_USERSPACE_ATTR_PID: u32 Netlink PID to which the %OVS_PACKET_CMD_ACTION
 450  * message should be sent.  Required.
 451  * @OVS_USERSPACE_ATTR_USERDATA: If present, its variable-length argument is
 452  * copied to the %OVS_PACKET_CMD_ACTION message as %OVS_PACKET_ATTR_USERDATA.
 453  */
 454 enum ovs_userspace_attr {
 455         OVS_USERSPACE_ATTR_UNSPEC,
 456         OVS_USERSPACE_ATTR_PID,       /* u32 Netlink PID to receive upcalls. */
 457         OVS_USERSPACE_ATTR_USERDATA,  /* Optional user-specified cookie. */
 458         __OVS_USERSPACE_ATTR_MAX
 459 };
 460
 461 #define OVS_USERSPACE_ATTR_MAX (__OVS_USERSPACE_ATTR_MAX - 1)
 462
 463 /**
 464  * struct ovs_action_push_mpls - %OVS_ACTION_ATTR_PUSH_MPLS action argument.
 465  * @mpls_lse: MPLS label stack entry to push.
 466  * @mpls_ethertype: Ethertype to set in the encapsulating ethernet frame.
 467  *
 468  * The only values @mpls_ethertype should ever be given are %ETH_P_MPLS_UC and
 469  * %ETH_P_MPLS_MC, indicating MPLS unicast or multicast. Other are rejected.
 470  */
 471 struct ovs_action_push_mpls {
 472         __be32 mpls_lse;
 473         __be16 mpls_ethertype; /* Either %ETH_P_MPLS_UC or %ETH_P_MPLS_MC */
 474 };
 475
 476 /**
 477  * struct ovs_action_push_vlan - %OVS_ACTION_ATTR_PUSH_VLAN action argument.
 478  * @vlan_tpid: Tag protocol identifier (TPID) to push.
 479  * @vlan_tci: Tag control identifier (TCI) to push.  The CFI bit must be set
 480  * (but it will not be set in the 802.1Q header that is pushed).
 481  *
 482  * The @vlan_tpid value is typically %ETH_P_8021Q.  The only acceptable TPID
 483  * values are those that the kernel module also parses as 802.1Q headers, to
 484  * prevent %OVS_ACTION_ATTR_PUSH_VLAN followed by %OVS_ACTION_ATTR_POP_VLAN
 485  * from having surprising results.
 486  */
 487 struct ovs_action_push_vlan {
 488         __be16 vlan_tpid;       /* 802.1Q TPID. */
 489         __be16 vlan_tci;        /* 802.1Q TCI (VLAN ID and priority). */
 490 };
 491
 492 /**
 493  * enum ovs_action_attr - Action types.
 494  *
 495  * @OVS_ACTION_ATTR_OUTPUT: Output packet to port.
 496  * @OVS_ACTION_ATTR_USERSPACE: Send packet to userspace according to nested
 497  * %OVS_USERSPACE_ATTR_* attributes.
 498  * @OVS_ACTION_ATTR_PUSH_VLAN: Push a new outermost 802.1Q header onto the
 499  * packet.
 500  * @OVS_ACTION_ATTR_POP_VLAN: Pop the outermost 802.1Q header off the packet.
 501  * @OVS_ACTION_ATTR_SAMPLE: Probabilitically executes actions, as specified in
 502  * the nested %OVS_SAMPLE_ATTR_* attributes.
 503  * @OVS_ACTION_ATTR_SET: Replaces the contents of an existing header.  The
 504  * single nested %OVS_KEY_ATTR_* attribute specifies a header to modify and its
 505  * value.
 506  * @OVS_ACTION_ATTR_PUSH_MPLS: Push a new MPLS label stack entry onto the
 507  * top of the packets MPLS label stack. Set the ethertype of the
 508  * encapsulating frame to either %ETH_P_MPLS_UC or %ETH_P_MPLS_MC to
 509  * indicate the new packet contents.
 510  * @OVS_ACTION_ATTR_POP_MPLS: Pop an MPLS label stack entry off of the
 511  * packet's MPLS label stack.  Set the encapsulating frame's ethertype to
 512  * indicate the new packet contents This could potentially still be
 513  * %ETH_P_MPLS_* if the resulting MPLS label stack is not empty.  If there
 514  * is no MPLS label stack, as determined by ethertype, no action is taken.
 515  *
 516  * Only a single header can be set with a single %OVS_ACTION_ATTR_SET.  Not all
 517  * fields within a header are modifiable, e.g. the IPv4 protocol and fragment
 518  * type may not be changed.
 519  */
 520
 521 enum ovs_action_attr {
 522         OVS_ACTION_ATTR_UNSPEC,
 523         OVS_ACTION_ATTR_OUTPUT,       /* u32 port number. */
 524         OVS_ACTION_ATTR_USERSPACE,    /* Nested OVS_USERSPACE_ATTR_*. */
 525         OVS_ACTION_ATTR_SET,          /* One nested OVS_KEY_ATTR_*. */
 526         OVS_ACTION_ATTR_PUSH_VLAN,    /* struct ovs_action_push_vlan. */
 527         OVS_ACTION_ATTR_POP_VLAN,     /* No argument. */
 528         OVS_ACTION_ATTR_SAMPLE,       /* Nested OVS_SAMPLE_ATTR_*. */
 529         OVS_ACTION_ATTR_PUSH_MPLS,    /* struct ovs_action_push_mpls. */
 530         OVS_ACTION_ATTR_POP_MPLS,     /* __be16 ethertype. */
 531         __OVS_ACTION_ATTR_MAX
 532 };
 533
 534 #define OVS_ACTION_ATTR_MAX (__OVS_ACTION_ATTR_MAX - 1)
 535
 536 #endif /* _LINUX_OPENVSWITCH_H */