include/uapi/linux/openvswitch.h

   1 /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
   2
   3 /*
   4  * Copyright (c) 2007-2017 Nicira, Inc.
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of version 2 of the GNU General Public
   8  * License as published by the Free Software Foundation.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  13  * General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  18  * 02110-1301, USA
  19  */
  20
  21 #ifndef _UAPI__LINUX_OPENVSWITCH_H
  22 #define _UAPI__LINUX_OPENVSWITCH_H 1
  23
  24 #include <linux/types.h>
  25 #include <linux/if_ether.h>
  26
  27 /**
  28  * struct ovs_header - header for OVS Generic Netlink messages.
  29  * @dp_ifindex: ifindex of local port for datapath (0 to make a request not
  30  * specific to a datapath).
  31  *
  32  * Attributes following the header are specific to a particular OVS Generic
  33  * Netlink family, but all of the OVS families use this header.
  34  */
  35
  36 struct ovs_header {
  37         int dp_ifindex;
  38 };
  39
  40 /* Datapaths. */
  41
  42 #define OVS_DATAPATH_FAMILY  "ovs_datapath"
  43 #define OVS_DATAPATH_MCGROUP "ovs_datapath"
  44
  45 /* V2:
  46  *   - API users are expected to provide OVS_DP_ATTR_USER_FEATURES
  47  *     when creating the datapath.
  48  */
  49 #define OVS_DATAPATH_VERSION 2
  50
  51 /* First OVS datapath version to support features */
  52 #define OVS_DP_VER_FEATURES 2
  53
  54 enum ovs_datapath_cmd {
  55         OVS_DP_CMD_UNSPEC,
  56         OVS_DP_CMD_NEW,
  57         OVS_DP_CMD_DEL,
  58         OVS_DP_CMD_GET,
  59         OVS_DP_CMD_SET
  60 };
  61
  62 /**
  63  * enum ovs_datapath_attr - attributes for %OVS_DP_* commands.
  64  * @OVS_DP_ATTR_NAME: Name of the network device that serves as the "local
  65  * port".  This is the name of the network device whose dp_ifindex is given in
  66  * the &struct ovs_header.  Always present in notifications.  Required in
  67  * %OVS_DP_NEW requests.  May be used as an alternative to specifying
  68  * dp_ifindex in other requests (with a dp_ifindex of 0).
  69  * @OVS_DP_ATTR_UPCALL_PID: The Netlink socket in userspace that is initially
  70  * set on the datapath port (for OVS_ACTION_ATTR_MISS).  Only valid on
  71  * %OVS_DP_CMD_NEW requests. A value of zero indicates that upcalls should
  72  * not be sent.
  73  * @OVS_DP_ATTR_PER_CPU_PIDS: Per-cpu array of PIDs for upcalls when
  74  * OVS_DP_F_DISPATCH_UPCALL_PER_CPU feature is set.
  75  * @OVS_DP_ATTR_STATS: Statistics about packets that have passed through the
  76  * datapath.  Always present in notifications.
  77  * @OVS_DP_ATTR_MEGAFLOW_STATS: Statistics about mega flow masks usage for the
  78  * datapath. Always present in notifications.
  79  *
  80  * These attributes follow the &struct ovs_header within the Generic Netlink
  81  * payload for %OVS_DP_* commands.
  82  */
  83 enum ovs_datapath_attr {
  84         OVS_DP_ATTR_UNSPEC,
  85         OVS_DP_ATTR_NAME,               /* name of dp_ifindex netdev */
  86         OVS_DP_ATTR_UPCALL_PID,         /* Netlink PID to receive upcalls */
  87         OVS_DP_ATTR_STATS,              /* struct ovs_dp_stats */
  88         OVS_DP_ATTR_MEGAFLOW_STATS,     /* struct ovs_dp_megaflow_stats */
  89         OVS_DP_ATTR_USER_FEATURES,      /* OVS_DP_F_*  */
  90         OVS_DP_ATTR_PAD,
  91         OVS_DP_ATTR_MASKS_CACHE_SIZE,
  92         OVS_DP_ATTR_PER_CPU_PIDS,   /* Netlink PIDS to receive upcalls in
  93                                      * per-cpu dispatch mode
  94                                      */
  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_dp_megaflow_stats {
 108         __u64 n_mask_hit;        /* Number of masks used for flow lookups. */
 109         __u32 n_masks;           /* Number of masks for the datapath. */
 110         __u32 pad0;              /* Pad for future expension. */
 111         __u64 n_cache_hit;       /* Number of cache matches for flow lookups. */
 112         __u64 pad1;              /* Pad for future expension. */
 113 };
 114
 115 struct ovs_vport_stats {
 116         __u64   rx_packets;             /* total packets received       */
 117         __u64   tx_packets;             /* total packets transmitted    */
 118         __u64   rx_bytes;               /* total bytes received         */
 119         __u64   tx_bytes;               /* total bytes transmitted      */
 120         __u64   rx_errors;              /* bad packets received         */
 121         __u64   tx_errors;              /* packet transmit problems     */
 122         __u64   rx_dropped;             /* no space in linux buffers    */
 123         __u64   tx_dropped;             /* no space available in linux  */
 124 };
 125
 126 /* Allow last Netlink attribute to be unaligned */
 127 #define OVS_DP_F_UNALIGNED      (1 << 0)
 128
 129 /* Allow datapath to associate multiple Netlink PIDs to each vport */
 130 #define OVS_DP_F_VPORT_PIDS     (1 << 1)
 131
 132 /* Allow tc offload recirc sharing */
 133 #define OVS_DP_F_TC_RECIRC_SHARING      (1 << 2)
 134
 135 /* Allow per-cpu dispatch of upcalls */
 136 #define OVS_DP_F_DISPATCH_UPCALL_PER_CPU        (1 << 3)
 137
 138 /* Fixed logical ports. */
 139 #define OVSP_LOCAL      ((__u32)0)
 140
 141 /* Packet transfer. */
 142
 143 #define OVS_PACKET_FAMILY "ovs_packet"
 144 #define OVS_PACKET_VERSION 0x1
 145
 146 enum ovs_packet_cmd {
 147         OVS_PACKET_CMD_UNSPEC,
 148
 149         /* Kernel-to-user notifications. */
 150         OVS_PACKET_CMD_MISS,    /* Flow table miss. */
 151         OVS_PACKET_CMD_ACTION,  /* OVS_ACTION_ATTR_USERSPACE action. */
 152
 153         /* Userspace commands. */
 154         OVS_PACKET_CMD_EXECUTE  /* Apply actions to a packet. */
 155 };
 156
 157 /**
 158  * enum ovs_packet_attr - attributes for %OVS_PACKET_* commands.
 159  * @OVS_PACKET_ATTR_PACKET: Present for all notifications.  Contains the entire
 160  * packet as received, from the start of the Ethernet header onward.  For
 161  * %OVS_PACKET_CMD_ACTION, %OVS_PACKET_ATTR_PACKET reflects changes made by
 162  * actions preceding %OVS_ACTION_ATTR_USERSPACE, but %OVS_PACKET_ATTR_KEY is
 163  * the flow key extracted from the packet as originally received.
 164  * @OVS_PACKET_ATTR_KEY: Present for all notifications.  Contains the flow key
 165  * extracted from the packet as nested %OVS_KEY_ATTR_* attributes.  This allows
 166  * userspace to adapt its flow setup strategy by comparing its notion of the
 167  * flow key against the kernel's.
 168  * @OVS_PACKET_ATTR_ACTIONS: Contains actions for the packet.  Used
 169  * for %OVS_PACKET_CMD_EXECUTE.  It has nested %OVS_ACTION_ATTR_* attributes.
 170  * Also used in upcall when %OVS_ACTION_ATTR_USERSPACE has optional
 171  * %OVS_USERSPACE_ATTR_ACTIONS attribute.
 172  * @OVS_PACKET_ATTR_USERDATA: Present for an %OVS_PACKET_CMD_ACTION
 173  * notification if the %OVS_ACTION_ATTR_USERSPACE action specified an
 174  * %OVS_USERSPACE_ATTR_USERDATA attribute, with the same length and content
 175  * specified there.
 176  * @OVS_PACKET_ATTR_EGRESS_TUN_KEY: Present for an %OVS_PACKET_CMD_ACTION
 177  * notification if the %OVS_ACTION_ATTR_USERSPACE action specified an
 178  * %OVS_USERSPACE_ATTR_EGRESS_TUN_PORT attribute, which is sent only if the
 179  * output port is actually a tunnel port. Contains the output tunnel key
 180  * extracted from the packet as nested %OVS_TUNNEL_KEY_ATTR_* attributes.
 181  * @OVS_PACKET_ATTR_MRU: Present for an %OVS_PACKET_CMD_ACTION and
 182  * @OVS_PACKET_ATTR_LEN: Packet size before truncation.
 183  * %OVS_PACKET_ATTR_USERSPACE action specify the Maximum received fragment
 184  * size.
 185  * @OVS_PACKET_ATTR_HASH: Packet hash info (e.g. hash, sw_hash and l4_hash in skb).
 186  *
 187  * These attributes follow the &struct ovs_header within the Generic Netlink
 188  * payload for %OVS_PACKET_* commands.
 189  */
 190 enum ovs_packet_attr {
 191         OVS_PACKET_ATTR_UNSPEC,
 192         OVS_PACKET_ATTR_PACKET,      /* Packet data. */
 193         OVS_PACKET_ATTR_KEY,         /* Nested OVS_KEY_ATTR_* attributes. */
 194         OVS_PACKET_ATTR_ACTIONS,     /* Nested OVS_ACTION_ATTR_* attributes. */
 195         OVS_PACKET_ATTR_USERDATA,    /* OVS_ACTION_ATTR_USERSPACE arg. */
 196         OVS_PACKET_ATTR_EGRESS_TUN_KEY,  /* Nested OVS_TUNNEL_KEY_ATTR_*
 197                                             attributes. */
 198         OVS_PACKET_ATTR_UNUSED1,
 199         OVS_PACKET_ATTR_UNUSED2,
 200         OVS_PACKET_ATTR_PROBE,      /* Packet operation is a feature probe,
 201                                        error logging should be suppressed. */
 202         OVS_PACKET_ATTR_MRU,        /* Maximum received IP fragment size. */
 203         OVS_PACKET_ATTR_LEN,        /* Packet size before truncation. */
 204         OVS_PACKET_ATTR_HASH,       /* Packet hash. */
 205         __OVS_PACKET_ATTR_MAX
 206 };
 207
 208 #define OVS_PACKET_ATTR_MAX (__OVS_PACKET_ATTR_MAX - 1)
 209
 210 /* Virtual ports. */
 211
 212 #define OVS_VPORT_FAMILY  "ovs_vport"
 213 #define OVS_VPORT_MCGROUP "ovs_vport"
 214 #define OVS_VPORT_VERSION 0x1
 215
 216 enum ovs_vport_cmd {
 217         OVS_VPORT_CMD_UNSPEC,
 218         OVS_VPORT_CMD_NEW,
 219         OVS_VPORT_CMD_DEL,
 220         OVS_VPORT_CMD_GET,
 221         OVS_VPORT_CMD_SET
 222 };
 223
 224 enum ovs_vport_type {
 225         OVS_VPORT_TYPE_UNSPEC,
 226         OVS_VPORT_TYPE_NETDEV,   /* network device */
 227         OVS_VPORT_TYPE_INTERNAL, /* network device implemented by datapath */
 228         OVS_VPORT_TYPE_GRE,      /* GRE tunnel. */
 229         OVS_VPORT_TYPE_VXLAN,    /* VXLAN tunnel. */
 230         OVS_VPORT_TYPE_GENEVE,   /* Geneve tunnel. */
 231         __OVS_VPORT_TYPE_MAX
 232 };
 233
 234 #define OVS_VPORT_TYPE_MAX (__OVS_VPORT_TYPE_MAX - 1)
 235
 236 /**
 237  * enum ovs_vport_attr - attributes for %OVS_VPORT_* commands.
 238  * @OVS_VPORT_ATTR_PORT_NO: 32-bit port number within datapath.
 239  * @OVS_VPORT_ATTR_TYPE: 32-bit %OVS_VPORT_TYPE_* constant describing the type
 240  * of vport.
 241  * @OVS_VPORT_ATTR_NAME: Name of vport.  For a vport based on a network device
 242  * this is the name of the network device.  Maximum length %IFNAMSIZ-1 bytes
 243  * plus a null terminator.
 244  * @OVS_VPORT_ATTR_OPTIONS: Vport-specific configuration information.
 245  * @OVS_VPORT_ATTR_UPCALL_PID: The array of Netlink socket pids in userspace
 246  * among which OVS_PACKET_CMD_MISS upcalls will be distributed for packets
 247  * received on this port.  If this is a single-element array of value 0,
 248  * upcalls should not be sent.
 249  * @OVS_VPORT_ATTR_STATS: A &struct ovs_vport_stats giving statistics for
 250  * packets sent or received through the vport.
 251  *
 252  * These attributes follow the &struct ovs_header within the Generic Netlink
 253  * payload for %OVS_VPORT_* commands.
 254  *
 255  * For %OVS_VPORT_CMD_NEW requests, the %OVS_VPORT_ATTR_TYPE and
 256  * %OVS_VPORT_ATTR_NAME attributes are required.  %OVS_VPORT_ATTR_PORT_NO is
 257  * optional; if not specified a free port number is automatically selected.
 258  * Whether %OVS_VPORT_ATTR_OPTIONS is required or optional depends on the type
 259  * of vport.
 260  *
 261  * For other requests, if %OVS_VPORT_ATTR_NAME is specified then it is used to
 262  * look up the vport to operate on; otherwise dp_idx from the &struct
 263  * ovs_header plus %OVS_VPORT_ATTR_PORT_NO determine the vport.
 264  */
 265 enum ovs_vport_attr {
 266         OVS_VPORT_ATTR_UNSPEC,
 267         OVS_VPORT_ATTR_PORT_NO, /* u32 port number within datapath */
 268         OVS_VPORT_ATTR_TYPE,    /* u32 OVS_VPORT_TYPE_* constant. */
 269         OVS_VPORT_ATTR_NAME,    /* string name, up to IFNAMSIZ bytes long */
 270         OVS_VPORT_ATTR_OPTIONS, /* nested attributes, varies by vport type */
 271         OVS_VPORT_ATTR_UPCALL_PID, /* array of u32 Netlink socket PIDs for */
 272                                 /* receiving upcalls */
 273         OVS_VPORT_ATTR_STATS,   /* struct ovs_vport_stats */
 274         OVS_VPORT_ATTR_PAD,
 275         OVS_VPORT_ATTR_IFINDEX,
 276         OVS_VPORT_ATTR_NETNSID,
 277         __OVS_VPORT_ATTR_MAX
 278 };
 279
 280 #define OVS_VPORT_ATTR_MAX (__OVS_VPORT_ATTR_MAX - 1)
 281
 282 enum {
 283         OVS_VXLAN_EXT_UNSPEC,
 284         OVS_VXLAN_EXT_GBP,      /* Flag or __u32 */
 285         __OVS_VXLAN_EXT_MAX,
 286 };
 287
 288 #define OVS_VXLAN_EXT_MAX (__OVS_VXLAN_EXT_MAX - 1)
 289
 290
 291 /* OVS_VPORT_ATTR_OPTIONS attributes for tunnels.
 292  */
 293 enum {
 294         OVS_TUNNEL_ATTR_UNSPEC,
 295         OVS_TUNNEL_ATTR_DST_PORT, /* 16-bit UDP port, used by L4 tunnels. */
 296         OVS_TUNNEL_ATTR_EXTENSION,
 297         __OVS_TUNNEL_ATTR_MAX
 298 };
 299
 300 #define OVS_TUNNEL_ATTR_MAX (__OVS_TUNNEL_ATTR_MAX - 1)
 301
 302 /* Flows. */
 303
 304 #define OVS_FLOW_FAMILY  "ovs_flow"
 305 #define OVS_FLOW_MCGROUP "ovs_flow"
 306 #define OVS_FLOW_VERSION 0x1
 307
 308 enum ovs_flow_cmd {
 309         OVS_FLOW_CMD_UNSPEC,
 310         OVS_FLOW_CMD_NEW,
 311         OVS_FLOW_CMD_DEL,
 312         OVS_FLOW_CMD_GET,
 313         OVS_FLOW_CMD_SET
 314 };
 315
 316 struct ovs_flow_stats {
 317         __u64 n_packets;         /* Number of matched packets. */
 318         __u64 n_bytes;           /* Number of matched bytes. */
 319 };
 320
 321 enum ovs_key_attr {
 322         OVS_KEY_ATTR_UNSPEC,
 323         OVS_KEY_ATTR_ENCAP,     /* Nested set of encapsulated attributes. */
 324         OVS_KEY_ATTR_PRIORITY,  /* u32 skb->priority */
 325         OVS_KEY_ATTR_IN_PORT,   /* u32 OVS dp port number */
 326         OVS_KEY_ATTR_ETHERNET,  /* struct ovs_key_ethernet */
 327         OVS_KEY_ATTR_VLAN,      /* be16 VLAN TCI */
 328         OVS_KEY_ATTR_ETHERTYPE, /* be16 Ethernet type */
 329         OVS_KEY_ATTR_IPV4,      /* struct ovs_key_ipv4 */
 330         OVS_KEY_ATTR_IPV6,      /* struct ovs_key_ipv6 */
 331         OVS_KEY_ATTR_TCP,       /* struct ovs_key_tcp */
 332         OVS_KEY_ATTR_UDP,       /* struct ovs_key_udp */
 333         OVS_KEY_ATTR_ICMP,      /* struct ovs_key_icmp */
 334         OVS_KEY_ATTR_ICMPV6,    /* struct ovs_key_icmpv6 */
 335         OVS_KEY_ATTR_ARP,       /* struct ovs_key_arp */
 336         OVS_KEY_ATTR_ND,        /* struct ovs_key_nd */
 337         OVS_KEY_ATTR_SKB_MARK,  /* u32 skb mark */
 338         OVS_KEY_ATTR_TUNNEL,    /* Nested set of ovs_tunnel attributes */
 339         OVS_KEY_ATTR_SCTP,      /* struct ovs_key_sctp */
 340         OVS_KEY_ATTR_TCP_FLAGS, /* be16 TCP flags. */
 341         OVS_KEY_ATTR_DP_HASH,      /* u32 hash value. Value 0 indicates the hash
 342                                    is not computed by the datapath. */
 343         OVS_KEY_ATTR_RECIRC_ID, /* u32 recirc id */
 344         OVS_KEY_ATTR_MPLS,      /* array of struct ovs_key_mpls.
 345                                  * The implementation may restrict
 346                                  * the accepted length of the array. */
 347         OVS_KEY_ATTR_CT_STATE,  /* u32 bitmask of OVS_CS_F_* */
 348         OVS_KEY_ATTR_CT_ZONE,   /* u16 connection tracking zone. */
 349         OVS_KEY_ATTR_CT_MARK,   /* u32 connection tracking mark */
 350         OVS_KEY_ATTR_CT_LABELS, /* 16-octet connection tracking label */
 351         OVS_KEY_ATTR_CT_ORIG_TUPLE_IPV4,   /* struct ovs_key_ct_tuple_ipv4 */
 352         OVS_KEY_ATTR_CT_ORIG_TUPLE_IPV6,   /* struct ovs_key_ct_tuple_ipv6 */
 353         OVS_KEY_ATTR_NSH,       /* Nested set of ovs_nsh_key_* */
 354
 355         /* User space decided to squat on types 29 and 30.  They are defined
 356          * below, but should not be sent to the kernel.
 357          *
 358          * WARNING: No new types should be added unless they are defined
 359          *          for both kernel and user space (no 'ifdef's).  It's hard
 360          *          to keep compatibility otherwise.
 361          */
 362         OVS_KEY_ATTR_PACKET_TYPE,   /* be32 packet type */
 363         OVS_KEY_ATTR_ND_EXTENSIONS, /* IPv6 Neighbor Discovery extensions */
 364
 365         OVS_KEY_ATTR_TUNNEL_INFO,   /* struct ip_tunnel_info.
 366                                      * For in-kernel use only.
 367                                      */
 368         OVS_KEY_ATTR_IPV6_EXTHDRS,  /* struct ovs_key_ipv6_exthdr */
 369         __OVS_KEY_ATTR_MAX
 370 };
 371
 372 #define OVS_KEY_ATTR_MAX (__OVS_KEY_ATTR_MAX - 1)
 373
 374 enum ovs_tunnel_key_attr {
 375         /* OVS_TUNNEL_KEY_ATTR_NONE, standard nl API requires this attribute! */
 376         OVS_TUNNEL_KEY_ATTR_ID,                 /* be64 Tunnel ID */
 377         OVS_TUNNEL_KEY_ATTR_IPV4_SRC,           /* be32 src IP address. */
 378         OVS_TUNNEL_KEY_ATTR_IPV4_DST,           /* be32 dst IP address. */
 379         OVS_TUNNEL_KEY_ATTR_TOS,                /* u8 Tunnel IP ToS. */
 380         OVS_TUNNEL_KEY_ATTR_TTL,                /* u8 Tunnel IP TTL. */
 381         OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT,      /* No argument, set DF. */
 382         OVS_TUNNEL_KEY_ATTR_CSUM,               /* No argument. CSUM packet. */
 383         OVS_TUNNEL_KEY_ATTR_OAM,                /* No argument. OAM frame.  */
 384         OVS_TUNNEL_KEY_ATTR_GENEVE_OPTS,        /* Array of Geneve options. */
 385         OVS_TUNNEL_KEY_ATTR_TP_SRC,             /* be16 src Transport Port. */
 386         OVS_TUNNEL_KEY_ATTR_TP_DST,             /* be16 dst Transport Port. */
 387         OVS_TUNNEL_KEY_ATTR_VXLAN_OPTS,         /* Nested OVS_VXLAN_EXT_* */
 388         OVS_TUNNEL_KEY_ATTR_IPV6_SRC,           /* struct in6_addr src IPv6 address. */
 389         OVS_TUNNEL_KEY_ATTR_IPV6_DST,           /* struct in6_addr dst IPv6 address. */
 390         OVS_TUNNEL_KEY_ATTR_PAD,
 391         OVS_TUNNEL_KEY_ATTR_ERSPAN_OPTS,        /* struct erspan_metadata */
 392         OVS_TUNNEL_KEY_ATTR_IPV4_INFO_BRIDGE,   /* No argument. IPV4_INFO_BRIDGE mode.*/
 393         __OVS_TUNNEL_KEY_ATTR_MAX
 394 };
 395
 396 #define OVS_TUNNEL_KEY_ATTR_MAX (__OVS_TUNNEL_KEY_ATTR_MAX - 1)
 397
 398 /**
 399  * enum ovs_frag_type - IPv4 and IPv6 fragment type
 400  * @OVS_FRAG_TYPE_NONE: Packet is not a fragment.
 401  * @OVS_FRAG_TYPE_FIRST: Packet is a fragment with offset 0.
 402  * @OVS_FRAG_TYPE_LATER: Packet is a fragment with nonzero offset.
 403  *
 404  * Used as the @ipv4_frag in &struct ovs_key_ipv4 and as @ipv6_frag &struct
 405  * ovs_key_ipv6.
 406  */
 407 enum ovs_frag_type {
 408         OVS_FRAG_TYPE_NONE,
 409         OVS_FRAG_TYPE_FIRST,
 410         OVS_FRAG_TYPE_LATER,
 411         __OVS_FRAG_TYPE_MAX
 412 };
 413
 414 #define OVS_FRAG_TYPE_MAX (__OVS_FRAG_TYPE_MAX - 1)
 415
 416 struct ovs_key_ethernet {
 417         __u8     eth_src[ETH_ALEN];
 418         __u8     eth_dst[ETH_ALEN];
 419 };
 420
 421 struct ovs_key_mpls {
 422         __be32 mpls_lse;
 423 };
 424
 425 struct ovs_key_ipv4 {
 426         __be32 ipv4_src;
 427         __be32 ipv4_dst;
 428         __u8   ipv4_proto;
 429         __u8   ipv4_tos;
 430         __u8   ipv4_ttl;
 431         __u8   ipv4_frag;       /* One of OVS_FRAG_TYPE_*. */
 432 };
 433
 434 struct ovs_key_ipv6 {
 435         __be32 ipv6_src[4];
 436         __be32 ipv6_dst[4];
 437         __be32 ipv6_label;      /* 20-bits in least-significant bits. */
 438         __u8   ipv6_proto;
 439         __u8   ipv6_tclass;
 440         __u8   ipv6_hlimit;
 441         __u8   ipv6_frag;       /* One of OVS_FRAG_TYPE_*. */
 442 };
 443
 444 /* separate structure to support backward compatibility with older user space */
 445 struct ovs_key_ipv6_exthdrs {
 446         __u16  hdrs;
 447 };
 448
 449 struct ovs_key_tcp {
 450         __be16 tcp_src;
 451         __be16 tcp_dst;
 452 };
 453
 454 struct ovs_key_udp {
 455         __be16 udp_src;
 456         __be16 udp_dst;
 457 };
 458
 459 struct ovs_key_sctp {
 460         __be16 sctp_src;
 461         __be16 sctp_dst;
 462 };
 463
 464 struct ovs_key_icmp {
 465         __u8 icmp_type;
 466         __u8 icmp_code;
 467 };
 468
 469 struct ovs_key_icmpv6 {
 470         __u8 icmpv6_type;
 471         __u8 icmpv6_code;
 472 };
 473
 474 struct ovs_key_arp {
 475         __be32 arp_sip;
 476         __be32 arp_tip;
 477         __be16 arp_op;
 478         __u8   arp_sha[ETH_ALEN];
 479         __u8   arp_tha[ETH_ALEN];
 480 };
 481
 482 struct ovs_key_nd {
 483         __be32  nd_target[4];
 484         __u8    nd_sll[ETH_ALEN];
 485         __u8    nd_tll[ETH_ALEN];
 486 };
 487
 488 #define OVS_CT_LABELS_LEN_32    4
 489 #define OVS_CT_LABELS_LEN       (OVS_CT_LABELS_LEN_32 * sizeof(__u32))
 490 struct ovs_key_ct_labels {
 491         union {
 492                 __u8    ct_labels[OVS_CT_LABELS_LEN];
 493                 __u32   ct_labels_32[OVS_CT_LABELS_LEN_32];
 494         };
 495 };
 496
 497 /* OVS_KEY_ATTR_CT_STATE flags */
 498 #define OVS_CS_F_NEW               0x01 /* Beginning of a new connection. */
 499 #define OVS_CS_F_ESTABLISHED       0x02 /* Part of an existing connection. */
 500 #define OVS_CS_F_RELATED           0x04 /* Related to an established
 501                                          * connection. */
 502 #define OVS_CS_F_REPLY_DIR         0x08 /* Flow is in the reply direction. */
 503 #define OVS_CS_F_INVALID           0x10 /* Could not track connection. */
 504 #define OVS_CS_F_TRACKED           0x20 /* Conntrack has occurred. */
 505 #define OVS_CS_F_SRC_NAT           0x40 /* Packet's source address/port was
 506                                          * mangled by NAT.
 507                                          */
 508 #define OVS_CS_F_DST_NAT           0x80 /* Packet's destination address/port
 509                                          * was mangled by NAT.
 510                                          */
 511
 512 #define OVS_CS_F_NAT_MASK (OVS_CS_F_SRC_NAT | OVS_CS_F_DST_NAT)
 513
 514 struct ovs_key_ct_tuple_ipv4 {
 515         __be32 ipv4_src;
 516         __be32 ipv4_dst;
 517         __be16 src_port;
 518         __be16 dst_port;
 519         __u8   ipv4_proto;
 520 };
 521
 522 struct ovs_key_ct_tuple_ipv6 {
 523         __be32 ipv6_src[4];
 524         __be32 ipv6_dst[4];
 525         __be16 src_port;
 526         __be16 dst_port;
 527         __u8   ipv6_proto;
 528 };
 529
 530 enum ovs_nsh_key_attr {
 531         OVS_NSH_KEY_ATTR_UNSPEC,
 532         OVS_NSH_KEY_ATTR_BASE,  /* struct ovs_nsh_key_base. */
 533         OVS_NSH_KEY_ATTR_MD1,   /* struct ovs_nsh_key_md1. */
 534         OVS_NSH_KEY_ATTR_MD2,   /* variable-length octets for MD type 2. */
 535         __OVS_NSH_KEY_ATTR_MAX
 536 };
 537
 538 #define OVS_NSH_KEY_ATTR_MAX (__OVS_NSH_KEY_ATTR_MAX - 1)
 539
 540 struct ovs_nsh_key_base {
 541         __u8 flags;
 542         __u8 ttl;
 543         __u8 mdtype;
 544         __u8 np;
 545         __be32 path_hdr;
 546 };
 547
 548 #define NSH_MD1_CONTEXT_SIZE 4
 549
 550 struct ovs_nsh_key_md1 {
 551         __be32 context[NSH_MD1_CONTEXT_SIZE];
 552 };
 553
 554 /**
 555  * enum ovs_flow_attr - attributes for %OVS_FLOW_* commands.
 556  * @OVS_FLOW_ATTR_KEY: Nested %OVS_KEY_ATTR_* attributes specifying the flow
 557  * key.  Always present in notifications.  Required for all requests (except
 558  * dumps).
 559  * @OVS_FLOW_ATTR_ACTIONS: Nested %OVS_ACTION_ATTR_* attributes specifying
 560  * the actions to take for packets that match the key.  Always present in
 561  * notifications.  Required for %OVS_FLOW_CMD_NEW requests, optional for
 562  * %OVS_FLOW_CMD_SET requests.  An %OVS_FLOW_CMD_SET without
 563  * %OVS_FLOW_ATTR_ACTIONS will not modify the actions.  To clear the actions,
 564  * an %OVS_FLOW_ATTR_ACTIONS without any nested attributes must be given.
 565  * @OVS_FLOW_ATTR_STATS: &struct ovs_flow_stats giving statistics for this
 566  * flow.  Present in notifications if the stats would be nonzero.  Ignored in
 567  * requests.
 568  * @OVS_FLOW_ATTR_TCP_FLAGS: An 8-bit value giving the OR'd value of all of the
 569  * TCP flags seen on packets in this flow.  Only present in notifications for
 570  * TCP flows, and only if it would be nonzero.  Ignored in requests.
 571  * @OVS_FLOW_ATTR_USED: A 64-bit integer giving the time, in milliseconds on
 572  * the system monotonic clock, at which a packet was last processed for this
 573  * flow.  Only present in notifications if a packet has been processed for this
 574  * flow.  Ignored in requests.
 575  * @OVS_FLOW_ATTR_CLEAR: If present in a %OVS_FLOW_CMD_SET request, clears the
 576  * last-used time, accumulated TCP flags, and statistics for this flow.
 577  * Otherwise ignored in requests.  Never present in notifications.
 578  * @OVS_FLOW_ATTR_MASK: Nested %OVS_KEY_ATTR_* attributes specifying the
 579  * mask bits for wildcarded flow match. Mask bit value '1' specifies exact
 580  * match with corresponding flow key bit, while mask bit value '0' specifies
 581  * a wildcarded match. Omitting attribute is treated as wildcarding all
 582  * corresponding fields. Optional for all requests. If not present,
 583  * all flow key bits are exact match bits.
 584  * @OVS_FLOW_ATTR_UFID: A value between 1-16 octets specifying a unique
 585  * identifier for the flow. Causes the flow to be indexed by this value rather
 586  * than the value of the %OVS_FLOW_ATTR_KEY attribute. Optional for all
 587  * requests. Present in notifications if the flow was created with this
 588  * attribute.
 589  * @OVS_FLOW_ATTR_UFID_FLAGS: A 32-bit value of OR'd %OVS_UFID_F_*
 590  * flags that provide alternative semantics for flow installation and
 591  * retrieval. Optional for all requests.
 592  *
 593  * These attributes follow the &struct ovs_header within the Generic Netlink
 594  * payload for %OVS_FLOW_* commands.
 595  */
 596 enum ovs_flow_attr {
 597         OVS_FLOW_ATTR_UNSPEC,
 598         OVS_FLOW_ATTR_KEY,       /* Sequence of OVS_KEY_ATTR_* attributes. */
 599         OVS_FLOW_ATTR_ACTIONS,   /* Nested OVS_ACTION_ATTR_* attributes. */
 600         OVS_FLOW_ATTR_STATS,     /* struct ovs_flow_stats. */
 601         OVS_FLOW_ATTR_TCP_FLAGS, /* 8-bit OR'd TCP flags. */
 602         OVS_FLOW_ATTR_USED,      /* u64 msecs last used in monotonic time. */
 603         OVS_FLOW_ATTR_CLEAR,     /* Flag to clear stats, tcp_flags, used. */
 604         OVS_FLOW_ATTR_MASK,      /* Sequence of OVS_KEY_ATTR_* attributes. */
 605         OVS_FLOW_ATTR_PROBE,     /* Flow operation is a feature probe, error
 606                                   * logging should be suppressed. */
 607         OVS_FLOW_ATTR_UFID,      /* Variable length unique flow identifier. */
 608         OVS_FLOW_ATTR_UFID_FLAGS,/* u32 of OVS_UFID_F_*. */
 609         OVS_FLOW_ATTR_PAD,
 610         __OVS_FLOW_ATTR_MAX
 611 };
 612
 613 #define OVS_FLOW_ATTR_MAX (__OVS_FLOW_ATTR_MAX - 1)
 614
 615 /**
 616  * Omit attributes for notifications.
 617  *
 618  * If a datapath request contains an %OVS_UFID_F_OMIT_* flag, then the datapath
 619  * may omit the corresponding %OVS_FLOW_ATTR_* from the response.
 620  */
 621 #define OVS_UFID_F_OMIT_KEY      (1 << 0)
 622 #define OVS_UFID_F_OMIT_MASK     (1 << 1)
 623 #define OVS_UFID_F_OMIT_ACTIONS  (1 << 2)
 624
 625 /**
 626  * enum ovs_sample_attr - Attributes for %OVS_ACTION_ATTR_SAMPLE action.
 627  * @OVS_SAMPLE_ATTR_PROBABILITY: 32-bit fraction of packets to sample with
 628  * @OVS_ACTION_ATTR_SAMPLE.  A value of 0 samples no packets, a value of
 629  * %UINT32_MAX samples all packets and intermediate values sample intermediate
 630  * fractions of packets.
 631  * @OVS_SAMPLE_ATTR_ACTIONS: Set of actions to execute in sampling event.
 632  * Actions are passed as nested attributes.
 633  *
 634  * Executes the specified actions with the given probability on a per-packet
 635  * basis.
 636  */
 637 enum ovs_sample_attr {
 638         OVS_SAMPLE_ATTR_UNSPEC,
 639         OVS_SAMPLE_ATTR_PROBABILITY, /* u32 number */
 640         OVS_SAMPLE_ATTR_ACTIONS,     /* Nested OVS_ACTION_ATTR_* attributes. */
 641         __OVS_SAMPLE_ATTR_MAX,
 642
 643 #ifdef __KERNEL__
 644         OVS_SAMPLE_ATTR_ARG          /* struct sample_arg  */
 645 #endif
 646 };
 647
 648 #define OVS_SAMPLE_ATTR_MAX (__OVS_SAMPLE_ATTR_MAX - 1)
 649
 650 #ifdef __KERNEL__
 651 struct sample_arg {
 652         bool exec;                   /* When true, actions in sample will not
 653                                       * change flow keys. False otherwise.
 654                                       */
 655         u32  probability;            /* Same value as
 656                                       * 'OVS_SAMPLE_ATTR_PROBABILITY'.
 657                                       */
 658 };
 659 #endif
 660
 661 /**
 662  * enum ovs_userspace_attr - Attributes for %OVS_ACTION_ATTR_USERSPACE action.
 663  * @OVS_USERSPACE_ATTR_PID: u32 Netlink PID to which the %OVS_PACKET_CMD_ACTION
 664  * message should be sent.  Required.
 665  * @OVS_USERSPACE_ATTR_USERDATA: If present, its variable-length argument is
 666  * copied to the %OVS_PACKET_CMD_ACTION message as %OVS_PACKET_ATTR_USERDATA.
 667  * @OVS_USERSPACE_ATTR_EGRESS_TUN_PORT: If present, u32 output port to get
 668  * tunnel info.
 669  * @OVS_USERSPACE_ATTR_ACTIONS: If present, send actions with upcall.
 670  */
 671 enum ovs_userspace_attr {
 672         OVS_USERSPACE_ATTR_UNSPEC,
 673         OVS_USERSPACE_ATTR_PID,       /* u32 Netlink PID to receive upcalls. */
 674         OVS_USERSPACE_ATTR_USERDATA,  /* Optional user-specified cookie. */
 675         OVS_USERSPACE_ATTR_EGRESS_TUN_PORT,  /* Optional, u32 output port
 676                                               * to get tunnel info. */
 677         OVS_USERSPACE_ATTR_ACTIONS,   /* Optional flag to get actions. */
 678         __OVS_USERSPACE_ATTR_MAX
 679 };
 680
 681 #define OVS_USERSPACE_ATTR_MAX (__OVS_USERSPACE_ATTR_MAX - 1)
 682
 683 struct ovs_action_trunc {
 684         __u32 max_len; /* Max packet size in bytes. */
 685 };
 686
 687 /**
 688  * struct ovs_action_push_mpls - %OVS_ACTION_ATTR_PUSH_MPLS action argument.
 689  * @mpls_lse: MPLS label stack entry to push.
 690  * @mpls_ethertype: Ethertype to set in the encapsulating ethernet frame.
 691  *
 692  * The only values @mpls_ethertype should ever be given are %ETH_P_MPLS_UC and
 693  * %ETH_P_MPLS_MC, indicating MPLS unicast or multicast. Other are rejected.
 694  */
 695 struct ovs_action_push_mpls {
 696         __be32 mpls_lse;
 697         __be16 mpls_ethertype; /* Either %ETH_P_MPLS_UC or %ETH_P_MPLS_MC */
 698 };
 699
 700 /**
 701  * struct ovs_action_add_mpls - %OVS_ACTION_ATTR_ADD_MPLS action
 702  * argument.
 703  * @mpls_lse: MPLS label stack entry to push.
 704  * @mpls_ethertype: Ethertype to set in the encapsulating ethernet frame.
 705  * @tun_flags: MPLS tunnel attributes.
 706  *
 707  * The only values @mpls_ethertype should ever be given are %ETH_P_MPLS_UC and
 708  * %ETH_P_MPLS_MC, indicating MPLS unicast or multicast. Other are rejected.
 709  */
 710 struct ovs_action_add_mpls {
 711         __be32 mpls_lse;
 712         __be16 mpls_ethertype; /* Either %ETH_P_MPLS_UC or %ETH_P_MPLS_MC */
 713         __u16 tun_flags;
 714 };
 715
 716 #define OVS_MPLS_L3_TUNNEL_FLAG_MASK  (1 << 0) /* Flag to specify the place of
 717                                                 * insertion of MPLS header.
 718                                                 * When false, the MPLS header
 719                                                 * will be inserted at the start
 720                                                 * of the packet.
 721                                                 * When true, the MPLS header
 722                                                 * will be inserted at the start
 723                                                 * of the l3 header.
 724                                                 */
 725
 726 /**
 727  * struct ovs_action_push_vlan - %OVS_ACTION_ATTR_PUSH_VLAN action argument.
 728  * @vlan_tpid: Tag protocol identifier (TPID) to push.
 729  * @vlan_tci: Tag control identifier (TCI) to push.  The CFI bit must be set
 730  * (but it will not be set in the 802.1Q header that is pushed).
 731  *
 732  * The @vlan_tpid value is typically %ETH_P_8021Q or %ETH_P_8021AD.
 733  * The only acceptable TPID values are those that the kernel module also parses
 734  * as 802.1Q or 802.1AD headers, to prevent %OVS_ACTION_ATTR_PUSH_VLAN followed
 735  * by %OVS_ACTION_ATTR_POP_VLAN from having surprising results.
 736  */
 737 struct ovs_action_push_vlan {
 738         __be16 vlan_tpid;       /* 802.1Q or 802.1ad TPID. */
 739         __be16 vlan_tci;        /* 802.1Q TCI (VLAN ID and priority). */
 740 };
 741
 742 /* Data path hash algorithm for computing Datapath hash.
 743  *
 744  * The algorithm type only specifies the fields in a flow
 745  * will be used as part of the hash. Each datapath is free
 746  * to use its own hash algorithm. The hash value will be
 747  * opaque to the user space daemon.
 748  */
 749 enum ovs_hash_alg {
 750         OVS_HASH_ALG_L4,
 751 };
 752
 753 /*
 754  * struct ovs_action_hash - %OVS_ACTION_ATTR_HASH action argument.
 755  * @hash_alg: Algorithm used to compute hash prior to recirculation.
 756  * @hash_basis: basis used for computing hash.
 757  */
 758 struct ovs_action_hash {
 759         __u32  hash_alg;     /* One of ovs_hash_alg. */
 760         __u32  hash_basis;
 761 };
 762
 763 /**
 764  * enum ovs_ct_attr - Attributes for %OVS_ACTION_ATTR_CT action.
 765  * @OVS_CT_ATTR_COMMIT: If present, commits the connection to the conntrack
 766  * table. This allows future packets for the same connection to be identified
 767  * as 'established' or 'related'. The flow key for the current packet will
 768  * retain the pre-commit connection state.
 769  * @OVS_CT_ATTR_ZONE: u16 connection tracking zone.
 770  * @OVS_CT_ATTR_MARK: u32 value followed by u32 mask. For each bit set in the
 771  * mask, the corresponding bit in the value is copied to the connection
 772  * tracking mark field in the connection.
 773  * @OVS_CT_ATTR_LABELS: %OVS_CT_LABELS_LEN value followed by %OVS_CT_LABELS_LEN
 774  * mask. For each bit set in the mask, the corresponding bit in the value is
 775  * copied to the connection tracking label field in the connection.
 776  * @OVS_CT_ATTR_HELPER: variable length string defining conntrack ALG.
 777  * @OVS_CT_ATTR_NAT: Nested OVS_NAT_ATTR_* for performing L3 network address
 778  * translation (NAT) on the packet.
 779  * @OVS_CT_ATTR_FORCE_COMMIT: Like %OVS_CT_ATTR_COMMIT, but instead of doing
 780  * nothing if the connection is already committed will check that the current
 781  * packet is in conntrack entry's original direction.  If directionality does
 782  * not match, will delete the existing conntrack entry and commit a new one.
 783  * @OVS_CT_ATTR_EVENTMASK: Mask of bits indicating which conntrack event types
 784  * (enum ip_conntrack_events IPCT_*) should be reported.  For any bit set to
 785  * zero, the corresponding event type is not generated.  Default behavior
 786  * depends on system configuration, but typically all event types are
 787  * generated, hence listening on NFNLGRP_CONNTRACK_UPDATE events may get a lot
 788  * of events.  Explicitly passing this attribute allows limiting the updates
 789  * received to the events of interest.  The bit 1 << IPCT_NEW, 1 <<
 790  * IPCT_RELATED, and 1 << IPCT_DESTROY must be set to ones for those events to
 791  * be received on NFNLGRP_CONNTRACK_NEW and NFNLGRP_CONNTRACK_DESTROY groups,
 792  * respectively.  Remaining bits control the changes for which an event is
 793  * delivered on the NFNLGRP_CONNTRACK_UPDATE group.
 794  * @OVS_CT_ATTR_TIMEOUT: Variable length string defining conntrack timeout.
 795  */
 796 enum ovs_ct_attr {
 797         OVS_CT_ATTR_UNSPEC,
 798         OVS_CT_ATTR_COMMIT,     /* No argument, commits connection. */
 799         OVS_CT_ATTR_ZONE,       /* u16 zone id. */
 800         OVS_CT_ATTR_MARK,       /* mark to associate with this connection. */
 801         OVS_CT_ATTR_LABELS,     /* labels to associate with this connection. */
 802         OVS_CT_ATTR_HELPER,     /* netlink helper to assist detection of
 803                                    related connections. */
 804         OVS_CT_ATTR_NAT,        /* Nested OVS_NAT_ATTR_* */
 805         OVS_CT_ATTR_FORCE_COMMIT,  /* No argument */
 806         OVS_CT_ATTR_EVENTMASK,  /* u32 mask of IPCT_* events. */
 807         OVS_CT_ATTR_TIMEOUT,    /* Associate timeout with this connection for
 808                                  * fine-grain timeout tuning. */
 809         __OVS_CT_ATTR_MAX
 810 };
 811
 812 #define OVS_CT_ATTR_MAX (__OVS_CT_ATTR_MAX - 1)
 813
 814 /**
 815  * enum ovs_nat_attr - Attributes for %OVS_CT_ATTR_NAT.
 816  *
 817  * @OVS_NAT_ATTR_SRC: Flag for Source NAT (mangle source address/port).
 818  * @OVS_NAT_ATTR_DST: Flag for Destination NAT (mangle destination
 819  * address/port).  Only one of (@OVS_NAT_ATTR_SRC, @OVS_NAT_ATTR_DST) may be
 820  * specified.  Effective only for packets for ct_state NEW connections.
 821  * Packets of committed connections are mangled by the NAT action according to
 822  * the committed NAT type regardless of the flags specified.  As a corollary, a
 823  * NAT action without a NAT type flag will only mangle packets of committed
 824  * connections.  The following NAT attributes only apply for NEW
 825  * (non-committed) connections, and they may be included only when the CT
 826  * action has the @OVS_CT_ATTR_COMMIT flag and either @OVS_NAT_ATTR_SRC or
 827  * @OVS_NAT_ATTR_DST is also included.
 828  * @OVS_NAT_ATTR_IP_MIN: struct in_addr or struct in6_addr
 829  * @OVS_NAT_ATTR_IP_MAX: struct in_addr or struct in6_addr
 830  * @OVS_NAT_ATTR_PROTO_MIN: u16 L4 protocol specific lower boundary (port)
 831  * @OVS_NAT_ATTR_PROTO_MAX: u16 L4 protocol specific upper boundary (port)
 832  * @OVS_NAT_ATTR_PERSISTENT: Flag for persistent IP mapping across reboots
 833  * @OVS_NAT_ATTR_PROTO_HASH: Flag for pseudo random L4 port mapping (MD5)
 834  * @OVS_NAT_ATTR_PROTO_RANDOM: Flag for fully randomized L4 port mapping
 835  */
 836 enum ovs_nat_attr {
 837         OVS_NAT_ATTR_UNSPEC,
 838         OVS_NAT_ATTR_SRC,
 839         OVS_NAT_ATTR_DST,
 840         OVS_NAT_ATTR_IP_MIN,
 841         OVS_NAT_ATTR_IP_MAX,
 842         OVS_NAT_ATTR_PROTO_MIN,
 843         OVS_NAT_ATTR_PROTO_MAX,
 844         OVS_NAT_ATTR_PERSISTENT,
 845         OVS_NAT_ATTR_PROTO_HASH,
 846         OVS_NAT_ATTR_PROTO_RANDOM,
 847         __OVS_NAT_ATTR_MAX,
 848 };
 849
 850 #define OVS_NAT_ATTR_MAX (__OVS_NAT_ATTR_MAX - 1)
 851
 852 /*
 853  * struct ovs_action_push_eth - %OVS_ACTION_ATTR_PUSH_ETH action argument.
 854  * @addresses: Source and destination MAC addresses.
 855  * @eth_type: Ethernet type
 856  */
 857 struct ovs_action_push_eth {
 858         struct ovs_key_ethernet addresses;
 859 };
 860
 861 /*
 862  * enum ovs_check_pkt_len_attr - Attributes for %OVS_ACTION_ATTR_CHECK_PKT_LEN.
 863  *
 864  * @OVS_CHECK_PKT_LEN_ATTR_PKT_LEN: u16 Packet length to check for.
 865  * @OVS_CHECK_PKT_LEN_ATTR_ACTIONS_IF_GREATER: Nested OVS_ACTION_ATTR_*
 866  * actions to apply if the packer length is greater than the specified
 867  * length in the attr - OVS_CHECK_PKT_LEN_ATTR_PKT_LEN.
 868  * @OVS_CHECK_PKT_LEN_ATTR_ACTIONS_IF_LESS_EQUAL - Nested OVS_ACTION_ATTR_*
 869  * actions to apply if the packer length is lesser or equal to the specified
 870  * length in the attr - OVS_CHECK_PKT_LEN_ATTR_PKT_LEN.
 871  */
 872 enum ovs_check_pkt_len_attr {
 873         OVS_CHECK_PKT_LEN_ATTR_UNSPEC,
 874         OVS_CHECK_PKT_LEN_ATTR_PKT_LEN,
 875         OVS_CHECK_PKT_LEN_ATTR_ACTIONS_IF_GREATER,
 876         OVS_CHECK_PKT_LEN_ATTR_ACTIONS_IF_LESS_EQUAL,
 877         __OVS_CHECK_PKT_LEN_ATTR_MAX,
 878
 879 #ifdef __KERNEL__
 880         OVS_CHECK_PKT_LEN_ATTR_ARG          /* struct check_pkt_len_arg  */
 881 #endif
 882 };
 883
 884 #define OVS_CHECK_PKT_LEN_ATTR_MAX (__OVS_CHECK_PKT_LEN_ATTR_MAX - 1)
 885
 886 #ifdef __KERNEL__
 887 struct check_pkt_len_arg {
 888         u16 pkt_len;    /* Same value as OVS_CHECK_PKT_LEN_ATTR_PKT_LEN'. */
 889         bool exec_for_greater;  /* When true, actions in IF_GREATER will
 890                                  * not change flow keys. False otherwise.
 891                                  */
 892         bool exec_for_lesser_equal; /* When true, actions in IF_LESS_EQUAL
 893                                      * will not change flow keys. False
 894                                      * otherwise.
 895                                      */
 896 };
 897 #endif
 898
 899 /**
 900  * enum ovs_action_attr - Action types.
 901  *
 902  * @OVS_ACTION_ATTR_OUTPUT: Output packet to port.
 903  * @OVS_ACTION_ATTR_TRUNC: Output packet to port with truncated packet size.
 904  * @OVS_ACTION_ATTR_USERSPACE: Send packet to userspace according to nested
 905  * %OVS_USERSPACE_ATTR_* attributes.
 906  * @OVS_ACTION_ATTR_SET: Replaces the contents of an existing header.  The
 907  * single nested %OVS_KEY_ATTR_* attribute specifies a header to modify and its
 908  * value.
 909  * @OVS_ACTION_ATTR_SET_MASKED: Replaces the contents of an existing header.  A
 910  * nested %OVS_KEY_ATTR_* attribute specifies a header to modify, its value,
 911  * and a mask.  For every bit set in the mask, the corresponding bit value
 912  * is copied from the value to the packet header field, rest of the bits are
 913  * left unchanged.  The non-masked value bits must be passed in as zeroes.
 914  * Masking is not supported for the %OVS_KEY_ATTR_TUNNEL attribute.
 915  * @OVS_ACTION_ATTR_PUSH_VLAN: Push a new outermost 802.1Q or 802.1ad header
 916  * onto the packet.
 917  * @OVS_ACTION_ATTR_POP_VLAN: Pop the outermost 802.1Q or 802.1ad header
 918  * from the packet.
 919  * @OVS_ACTION_ATTR_SAMPLE: Probabilitically executes actions, as specified in
 920  * the nested %OVS_SAMPLE_ATTR_* attributes.
 921  * @OVS_ACTION_ATTR_PUSH_MPLS: Push a new MPLS label stack entry onto the
 922  * top of the packets MPLS label stack.  Set the ethertype of the
 923  * encapsulating frame to either %ETH_P_MPLS_UC or %ETH_P_MPLS_MC to
 924  * indicate the new packet contents.
 925  * @OVS_ACTION_ATTR_POP_MPLS: Pop an MPLS label stack entry off of the
 926  * packet's MPLS label stack.  Set the encapsulating frame's ethertype to
 927  * indicate the new packet contents. This could potentially still be
 928  * %ETH_P_MPLS if the resulting MPLS label stack is not empty.  If there
 929  * is no MPLS label stack, as determined by ethertype, no action is taken.
 930  * @OVS_ACTION_ATTR_CT: Track the connection. Populate the conntrack-related
 931  * entries in the flow key.
 932  * @OVS_ACTION_ATTR_PUSH_ETH: Push a new outermost Ethernet header onto the
 933  * packet.
 934  * @OVS_ACTION_ATTR_POP_ETH: Pop the outermost Ethernet header off the
 935  * packet.
 936  * @OVS_ACTION_ATTR_CT_CLEAR: Clear conntrack state from the packet.
 937  * @OVS_ACTION_ATTR_PUSH_NSH: push NSH header to the packet.
 938  * @OVS_ACTION_ATTR_POP_NSH: pop the outermost NSH header off the packet.
 939  * @OVS_ACTION_ATTR_METER: Run packet through a meter, which may drop the
 940  * packet, or modify the packet (e.g., change the DSCP field).
 941  * @OVS_ACTION_ATTR_CLONE: make a copy of the packet and execute a list of
 942  * actions without affecting the original packet and key.
 943  * @OVS_ACTION_ATTR_CHECK_PKT_LEN: Check the packet length and execute a set
 944  * of actions if greater than the specified packet length, else execute
 945  * another set of actions.
 946  * @OVS_ACTION_ATTR_ADD_MPLS: Push a new MPLS label stack entry at the
 947  * start of the packet or at the start of the l3 header depending on the value
 948  * of l3 tunnel flag in the tun_flags field of OVS_ACTION_ATTR_ADD_MPLS
 949  * argument.
 950  *
 951  * Only a single header can be set with a single %OVS_ACTION_ATTR_SET.  Not all
 952  * fields within a header are modifiable, e.g. the IPv4 protocol and fragment
 953  * type may not be changed.
 954  *
 955  * @OVS_ACTION_ATTR_SET_TO_MASKED: Kernel internal masked set action translated
 956  * from the @OVS_ACTION_ATTR_SET.
 957  */
 958
 959 enum ovs_action_attr {
 960         OVS_ACTION_ATTR_UNSPEC,
 961         OVS_ACTION_ATTR_OUTPUT,       /* u32 port number. */
 962         OVS_ACTION_ATTR_USERSPACE,    /* Nested OVS_USERSPACE_ATTR_*. */
 963         OVS_ACTION_ATTR_SET,          /* One nested OVS_KEY_ATTR_*. */
 964         OVS_ACTION_ATTR_PUSH_VLAN,    /* struct ovs_action_push_vlan. */
 965         OVS_ACTION_ATTR_POP_VLAN,     /* No argument. */
 966         OVS_ACTION_ATTR_SAMPLE,       /* Nested OVS_SAMPLE_ATTR_*. */
 967         OVS_ACTION_ATTR_RECIRC,       /* u32 recirc_id. */
 968         OVS_ACTION_ATTR_HASH,         /* struct ovs_action_hash. */
 969         OVS_ACTION_ATTR_PUSH_MPLS,    /* struct ovs_action_push_mpls. */
 970         OVS_ACTION_ATTR_POP_MPLS,     /* __be16 ethertype. */
 971         OVS_ACTION_ATTR_SET_MASKED,   /* One nested OVS_KEY_ATTR_* including
 972                                        * data immediately followed by a mask.
 973                                        * The data must be zero for the unmasked
 974                                        * bits. */
 975         OVS_ACTION_ATTR_CT,           /* Nested OVS_CT_ATTR_* . */
 976         OVS_ACTION_ATTR_TRUNC,        /* u32 struct ovs_action_trunc. */
 977         OVS_ACTION_ATTR_PUSH_ETH,     /* struct ovs_action_push_eth. */
 978         OVS_ACTION_ATTR_POP_ETH,      /* No argument. */
 979         OVS_ACTION_ATTR_CT_CLEAR,     /* No argument. */
 980         OVS_ACTION_ATTR_PUSH_NSH,     /* Nested OVS_NSH_KEY_ATTR_*. */
 981         OVS_ACTION_ATTR_POP_NSH,      /* No argument. */
 982         OVS_ACTION_ATTR_METER,        /* u32 meter ID. */
 983         OVS_ACTION_ATTR_CLONE,        /* Nested OVS_CLONE_ATTR_*.  */
 984         OVS_ACTION_ATTR_CHECK_PKT_LEN, /* Nested OVS_CHECK_PKT_LEN_ATTR_*. */
 985         OVS_ACTION_ATTR_ADD_MPLS,     /* struct ovs_action_add_mpls. */
 986         OVS_ACTION_ATTR_DEC_TTL,      /* Nested OVS_DEC_TTL_ATTR_*. */
 987
 988         __OVS_ACTION_ATTR_MAX,        /* Nothing past this will be accepted
 989                                        * from userspace. */
 990
 991 #ifdef __KERNEL__
 992         OVS_ACTION_ATTR_SET_TO_MASKED, /* Kernel module internal masked
 993                                         * set action converted from
 994                                         * OVS_ACTION_ATTR_SET. */
 995 #endif
 996 };
 997
 998 #define OVS_ACTION_ATTR_MAX (__OVS_ACTION_ATTR_MAX - 1)
 999
1000 /* Meters. */
1001 #define OVS_METER_FAMILY  "ovs_meter"
1002 #define OVS_METER_MCGROUP "ovs_meter"
1003 #define OVS_METER_VERSION 0x1
1004
1005 enum ovs_meter_cmd {
1006         OVS_METER_CMD_UNSPEC,
1007         OVS_METER_CMD_FEATURES, /* Get features supported by the datapath. */
1008         OVS_METER_CMD_SET,      /* Add or modify a meter. */
1009         OVS_METER_CMD_DEL,      /* Delete a meter. */
1010         OVS_METER_CMD_GET       /* Get meter stats. */
1011 };
1012
1013 enum ovs_meter_attr {
1014         OVS_METER_ATTR_UNSPEC,
1015         OVS_METER_ATTR_ID,      /* u32 meter ID within datapath. */
1016         OVS_METER_ATTR_KBPS,    /* No argument. If set, units in kilobits
1017                                  * per second. Otherwise, units in
1018                                  * packets per second.
1019                                  */
1020         OVS_METER_ATTR_STATS,   /* struct ovs_flow_stats for the meter. */
1021         OVS_METER_ATTR_BANDS,   /* Nested attributes for meter bands. */
1022         OVS_METER_ATTR_USED,    /* u64 msecs last used in monotonic time. */
1023         OVS_METER_ATTR_CLEAR,   /* Flag to clear stats, used. */
1024         OVS_METER_ATTR_MAX_METERS, /* u32 number of meters supported. */
1025         OVS_METER_ATTR_MAX_BANDS,  /* u32 max number of bands per meter. */
1026         OVS_METER_ATTR_PAD,
1027         __OVS_METER_ATTR_MAX
1028 };
1029
1030 #define OVS_METER_ATTR_MAX (__OVS_METER_ATTR_MAX - 1)
1031
1032 enum ovs_band_attr {
1033         OVS_BAND_ATTR_UNSPEC,
1034         OVS_BAND_ATTR_TYPE,     /* u32 OVS_METER_BAND_TYPE_* constant. */
1035         OVS_BAND_ATTR_RATE,     /* u32 band rate in meter units (see above). */
1036         OVS_BAND_ATTR_BURST,    /* u32 burst size in meter units. */
1037         OVS_BAND_ATTR_STATS,    /* struct ovs_flow_stats for the band. */
1038         __OVS_BAND_ATTR_MAX
1039 };
1040
1041 #define OVS_BAND_ATTR_MAX (__OVS_BAND_ATTR_MAX - 1)
1042
1043 enum ovs_meter_band_type {
1044         OVS_METER_BAND_TYPE_UNSPEC,
1045         OVS_METER_BAND_TYPE_DROP,   /* Drop exceeding packets. */
1046         __OVS_METER_BAND_TYPE_MAX
1047 };
1048
1049 #define OVS_METER_BAND_TYPE_MAX (__OVS_METER_BAND_TYPE_MAX - 1)
1050
1051 /* Conntrack limit */
1052 #define OVS_CT_LIMIT_FAMILY  "ovs_ct_limit"
1053 #define OVS_CT_LIMIT_MCGROUP "ovs_ct_limit"
1054 #define OVS_CT_LIMIT_VERSION 0x1
1055
1056 enum ovs_ct_limit_cmd {
1057         OVS_CT_LIMIT_CMD_UNSPEC,
1058         OVS_CT_LIMIT_CMD_SET,           /* Add or modify ct limit. */
1059         OVS_CT_LIMIT_CMD_DEL,           /* Delete ct limit. */
1060         OVS_CT_LIMIT_CMD_GET            /* Get ct limit. */
1061 };
1062
1063 enum ovs_ct_limit_attr {
1064         OVS_CT_LIMIT_ATTR_UNSPEC,
1065         OVS_CT_LIMIT_ATTR_ZONE_LIMIT,   /* Nested struct ovs_zone_limit. */
1066         __OVS_CT_LIMIT_ATTR_MAX
1067 };
1068
1069 #define OVS_CT_LIMIT_ATTR_MAX (__OVS_CT_LIMIT_ATTR_MAX - 1)
1070
1071 #define OVS_ZONE_LIMIT_DEFAULT_ZONE -1
1072
1073 struct ovs_zone_limit {
1074         int zone_id;
1075         __u32 limit;
1076         __u32 count;
1077 };
1078
1079 enum ovs_dec_ttl_attr {
1080         OVS_DEC_TTL_ATTR_UNSPEC,
1081         OVS_DEC_TTL_ATTR_ACTION,        /* Nested struct nlattr */
1082         __OVS_DEC_TTL_ATTR_MAX
1083 };
1084
1085 #define OVS_DEC_TTL_ATTR_MAX (__OVS_DEC_TTL_ATTR_MAX - 1)
1086
1087 #endif /* _LINUX_OPENVSWITCH_H */