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