include/linux/openvswitch.h

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