include/uapi/linux/openvswitch.h

   1
   2 /*
   3  * Copyright (c) 2007-2013 Nicira, Inc.
   4  *
   5  * This program is free software; you can redistribute it and/or
   6  * modify it under the terms of version 2 of the GNU General Public
   7  * License as published by the Free Software Foundation.
   8  *
   9  * This program is distributed in the hope that it will be useful, but
  10  * WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  12  * General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the Free Software
  16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  17  * 02110-1301, USA
  18  */
  19
  20 #ifndef _UAPI__LINUX_OPENVSWITCH_H
  21 #define _UAPI__LINUX_OPENVSWITCH_H 1
  22
  23 #include <linux/types.h>
  24 #include <linux/if_ether.h>
  25
  26 /**
  27  * struct ovs_header - header for OVS Generic Netlink messages.
  28  * @dp_ifindex: ifindex of local port for datapath (0 to make a request not
  29  * specific to a datapath).
  30  *
  31  * Attributes following the header are specific to a particular OVS Generic
  32  * Netlink family, but all of the OVS families use this header.
  33  */
  34
  35 struct ovs_header {
  36         int dp_ifindex;
  37 };
  38
  39 /* Datapaths. */
  40
  41 #define OVS_DATAPATH_FAMILY  "ovs_datapath"
  42 #define OVS_DATAPATH_MCGROUP "ovs_datapath"
  43
  44 /* V2:
  45  *   - API users are expected to provide OVS_DP_ATTR_USER_FEATURES
  46  *     when creating the datapath.
  47  */
  48 #define OVS_DATAPATH_VERSION 2
  49
  50 /* First OVS datapath version to support features */
  51 #define OVS_DP_VER_FEATURES 2
  52
  53 enum ovs_datapath_cmd {
  54         OVS_DP_CMD_UNSPEC,
  55         OVS_DP_CMD_NEW,
  56         OVS_DP_CMD_DEL,
  57         OVS_DP_CMD_GET,
  58         OVS_DP_CMD_SET
  59 };
  60
  61 /**
  62  * enum ovs_datapath_attr - attributes for %OVS_DP_* commands.
  63  * @OVS_DP_ATTR_NAME: Name of the network device that serves as the "local
  64  * port".  This is the name of the network device whose dp_ifindex is given in
  65  * the &struct ovs_header.  Always present in notifications.  Required in
  66  * %OVS_DP_NEW requests.  May be used as an alternative to specifying
  67  * dp_ifindex in other requests (with a dp_ifindex of 0).
  68  * @OVS_DP_ATTR_UPCALL_PID: The Netlink socket in userspace that is initially
  69  * set on the datapath port (for OVS_ACTION_ATTR_MISS).  Only valid on
  70  * %OVS_DP_CMD_NEW requests. A value of zero indicates that upcalls should
  71  * not be sent.
  72  * @OVS_DP_ATTR_STATS: Statistics about packets that have passed through the
  73  * datapath.  Always present in notifications.
  74  * @OVS_DP_ATTR_MEGAFLOW_STATS: Statistics about mega flow masks usage for the
  75  * datapath. Always present in notifications.
  76  *
  77  * These attributes follow the &struct ovs_header within the Generic Netlink
  78  * payload for %OVS_DP_* commands.
  79  */
  80 enum ovs_datapath_attr {
  81         OVS_DP_ATTR_UNSPEC,
  82         OVS_DP_ATTR_NAME,               /* name of dp_ifindex netdev */
  83         OVS_DP_ATTR_UPCALL_PID,         /* Netlink PID to receive upcalls */
  84         OVS_DP_ATTR_STATS,              /* struct ovs_dp_stats */
  85         OVS_DP_ATTR_MEGAFLOW_STATS,     /* struct ovs_dp_megaflow_stats */
  86         OVS_DP_ATTR_USER_FEATURES,      /* OVS_DP_F_*  */
  87         __OVS_DP_ATTR_MAX
  88 };
  89
  90 #define OVS_DP_ATTR_MAX (__OVS_DP_ATTR_MAX - 1)
  91
  92 struct ovs_dp_stats {
  93         __u64 n_hit;             /* Number of flow table matches. */
  94         __u64 n_missed;          /* Number of flow table misses. */
  95         __u64 n_lost;            /* Number of misses not sent to userspace. */
  96         __u64 n_flows;           /* Number of flows present */
  97 };
  98
  99 struct ovs_dp_megaflow_stats {
 100         __u64 n_mask_hit;        /* Number of masks used for flow lookups. */
 101         __u32 n_masks;           /* Number of masks for the datapath. */
 102         __u32 pad0;              /* Pad for future expension. */
 103         __u64 pad1;              /* Pad for future expension. */
 104         __u64 pad2;              /* Pad for future expension. */
 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 /* Allow last Netlink attribute to be unaligned */
 119 #define OVS_DP_F_UNALIGNED      (1 << 0)
 120
 121 /* Allow datapath to associate multiple Netlink PIDs to each vport */
 122 #define OVS_DP_F_VPORT_PIDS     (1 << 1)
 123
 124 /* Fixed logical ports. */
 125 #define OVSP_LOCAL      ((__u32)0)
 126
 127 /* Packet transfer. */
 128
 129 #define OVS_PACKET_FAMILY "ovs_packet"
 130 #define OVS_PACKET_VERSION 0x1
 131
 132 enum ovs_packet_cmd {
 133         OVS_PACKET_CMD_UNSPEC,
 134
 135         /* Kernel-to-user notifications. */
 136         OVS_PACKET_CMD_MISS,    /* Flow table miss. */
 137         OVS_PACKET_CMD_ACTION,  /* OVS_ACTION_ATTR_USERSPACE action. */
 138
 139         /* Userspace commands. */
 140         OVS_PACKET_CMD_EXECUTE  /* Apply actions to a packet. */
 141 };
 142
 143 /**
 144  * enum ovs_packet_attr - attributes for %OVS_PACKET_* commands.
 145  * @OVS_PACKET_ATTR_PACKET: Present for all notifications.  Contains the entire
 146  * packet as received, from the start of the Ethernet header onward.  For
 147  * %OVS_PACKET_CMD_ACTION, %OVS_PACKET_ATTR_PACKET reflects changes made by
 148  * actions preceding %OVS_ACTION_ATTR_USERSPACE, but %OVS_PACKET_ATTR_KEY is
 149  * the flow key extracted from the packet as originally received.
 150  * @OVS_PACKET_ATTR_KEY: Present for all notifications.  Contains the flow key
 151  * extracted from the packet as nested %OVS_KEY_ATTR_* attributes.  This allows
 152  * userspace to adapt its flow setup strategy by comparing its notion of the
 153  * flow key against the kernel's.
 154  * @OVS_PACKET_ATTR_ACTIONS: Contains actions for the packet.  Used
 155  * for %OVS_PACKET_CMD_EXECUTE.  It has nested %OVS_ACTION_ATTR_* attributes.
 156  * Also used in upcall when %OVS_ACTION_ATTR_USERSPACE has optional
 157  * %OVS_USERSPACE_ATTR_ACTIONS attribute.
 158  * @OVS_PACKET_ATTR_USERDATA: Present for an %OVS_PACKET_CMD_ACTION
 159  * notification if the %OVS_ACTION_ATTR_USERSPACE action specified an
 160  * %OVS_USERSPACE_ATTR_USERDATA attribute, with the same length and content
 161  * specified there.
 162  * @OVS_PACKET_ATTR_EGRESS_TUN_KEY: Present for an %OVS_PACKET_CMD_ACTION
 163  * notification if the %OVS_ACTION_ATTR_USERSPACE action specified an
 164  * %OVS_USERSPACE_ATTR_EGRESS_TUN_PORT attribute, which is sent only if the
 165  * output port is actually a tunnel port. Contains the output tunnel key
 166  * extracted from the packet as nested %OVS_TUNNEL_KEY_ATTR_* attributes.
 167  * @OVS_PACKET_ATTR_MRU: Present for an %OVS_PACKET_CMD_ACTION and
 168  * %OVS_PACKET_ATTR_USERSPACE action specify the Maximum received fragment
 169  * size.
 170  *
 171  * These attributes follow the &struct ovs_header within the Generic Netlink
 172  * payload for %OVS_PACKET_* commands.
 173  */
 174 enum ovs_packet_attr {
 175         OVS_PACKET_ATTR_UNSPEC,
 176         OVS_PACKET_ATTR_PACKET,      /* Packet data. */
 177         OVS_PACKET_ATTR_KEY,         /* Nested OVS_KEY_ATTR_* attributes. */
 178         OVS_PACKET_ATTR_ACTIONS,     /* Nested OVS_ACTION_ATTR_* attributes. */
 179         OVS_PACKET_ATTR_USERDATA,    /* OVS_ACTION_ATTR_USERSPACE arg. */
 180         OVS_PACKET_ATTR_EGRESS_TUN_KEY,  /* Nested OVS_TUNNEL_KEY_ATTR_*
 181                                             attributes. */
 182         OVS_PACKET_ATTR_UNUSED1,
 183         OVS_PACKET_ATTR_UNUSED2,
 184         OVS_PACKET_ATTR_PROBE,      /* Packet operation is a feature probe,
 185                                        error logging should be suppressed. */
 186         OVS_PACKET_ATTR_MRU,        /* Maximum received IP fragment size. */
 187         __OVS_PACKET_ATTR_MAX
 188 };
 189
 190 #define OVS_PACKET_ATTR_MAX (__OVS_PACKET_ATTR_MAX - 1)
 191
 192 /* Virtual ports. */
 193
 194 #define OVS_VPORT_FAMILY  "ovs_vport"
 195 #define OVS_VPORT_MCGROUP "ovs_vport"
 196 #define OVS_VPORT_VERSION 0x1
 197
 198 enum ovs_vport_cmd {
 199         OVS_VPORT_CMD_UNSPEC,
 200         OVS_VPORT_CMD_NEW,
 201         OVS_VPORT_CMD_DEL,
 202         OVS_VPORT_CMD_GET,
 203         OVS_VPORT_CMD_SET
 204 };
 205
 206 enum ovs_vport_type {
 207         OVS_VPORT_TYPE_UNSPEC,
 208         OVS_VPORT_TYPE_NETDEV,   /* network device */
 209         OVS_VPORT_TYPE_INTERNAL, /* network device implemented by datapath */
 210         OVS_VPORT_TYPE_GRE,      /* GRE tunnel. */
 211         OVS_VPORT_TYPE_VXLAN,    /* VXLAN tunnel. */
 212         OVS_VPORT_TYPE_GENEVE,   /* Geneve tunnel. */
 213         __OVS_VPORT_TYPE_MAX
 214 };
 215
 216 #define OVS_VPORT_TYPE_MAX (__OVS_VPORT_TYPE_MAX - 1)
 217
 218 /**
 219  * enum ovs_vport_attr - attributes for %OVS_VPORT_* commands.
 220  * @OVS_VPORT_ATTR_PORT_NO: 32-bit port number within datapath.
 221  * @OVS_VPORT_ATTR_TYPE: 32-bit %OVS_VPORT_TYPE_* constant describing the type
 222  * of vport.
 223  * @OVS_VPORT_ATTR_NAME: Name of vport.  For a vport based on a network device
 224  * this is the name of the network device.  Maximum length %IFNAMSIZ-1 bytes
 225  * plus a null terminator.
 226  * @OVS_VPORT_ATTR_OPTIONS: Vport-specific configuration information.
 227  * @OVS_VPORT_ATTR_UPCALL_PID: The array of Netlink socket pids in userspace
 228  * among which OVS_PACKET_CMD_MISS upcalls will be distributed for packets
 229  * received on this port.  If this is a single-element array of value 0,
 230  * upcalls should not be sent.
 231  * @OVS_VPORT_ATTR_STATS: A &struct ovs_vport_stats giving statistics for
 232  * packets sent or received through the vport.
 233  *
 234  * These attributes follow the &struct ovs_header within the Generic Netlink
 235  * payload for %OVS_VPORT_* commands.
 236  *
 237  * For %OVS_VPORT_CMD_NEW requests, the %OVS_VPORT_ATTR_TYPE and
 238  * %OVS_VPORT_ATTR_NAME attributes are required.  %OVS_VPORT_ATTR_PORT_NO is
 239  * optional; if not specified a free port number is automatically selected.
 240  * Whether %OVS_VPORT_ATTR_OPTIONS is required or optional depends on the type
 241  * of vport.
 242  *
 243  * For other requests, if %OVS_VPORT_ATTR_NAME is specified then it is used to
 244  * look up the vport to operate on; otherwise dp_idx from the &struct
 245  * ovs_header plus %OVS_VPORT_ATTR_PORT_NO determine the vport.
 246  */
 247 enum ovs_vport_attr {
 248         OVS_VPORT_ATTR_UNSPEC,
 249         OVS_VPORT_ATTR_PORT_NO, /* u32 port number within datapath */
 250         OVS_VPORT_ATTR_TYPE,    /* u32 OVS_VPORT_TYPE_* constant. */
 251         OVS_VPORT_ATTR_NAME,    /* string name, up to IFNAMSIZ bytes long */
 252         OVS_VPORT_ATTR_OPTIONS, /* nested attributes, varies by vport type */
 253         OVS_VPORT_ATTR_UPCALL_PID, /* array of u32 Netlink socket PIDs for */
 254                                 /* receiving upcalls */
 255         OVS_VPORT_ATTR_STATS,   /* struct ovs_vport_stats */
 256         __OVS_VPORT_ATTR_MAX
 257 };
 258
 259 #define OVS_VPORT_ATTR_MAX (__OVS_VPORT_ATTR_MAX - 1)
 260
 261 enum {
 262         OVS_VXLAN_EXT_UNSPEC,
 263         OVS_VXLAN_EXT_GBP,      /* Flag or __u32 */
 264         __OVS_VXLAN_EXT_MAX,
 265 };
 266
 267 #define OVS_VXLAN_EXT_MAX (__OVS_VXLAN_EXT_MAX - 1)
 268
 269
 270 /* OVS_VPORT_ATTR_OPTIONS attributes for tunnels.
 271  */
 272 enum {
 273         OVS_TUNNEL_ATTR_UNSPEC,
 274         OVS_TUNNEL_ATTR_DST_PORT, /* 16-bit UDP port, used by L4 tunnels. */
 275         OVS_TUNNEL_ATTR_EXTENSION,
 276         __OVS_TUNNEL_ATTR_MAX
 277 };
 278
 279 #define OVS_TUNNEL_ATTR_MAX (__OVS_TUNNEL_ATTR_MAX - 1)
 280
 281 /* Flows. */
 282
 283 #define OVS_FLOW_FAMILY  "ovs_flow"
 284 #define OVS_FLOW_MCGROUP "ovs_flow"
 285 #define OVS_FLOW_VERSION 0x1
 286
 287 enum ovs_flow_cmd {
 288         OVS_FLOW_CMD_UNSPEC,
 289         OVS_FLOW_CMD_NEW,
 290         OVS_FLOW_CMD_DEL,
 291         OVS_FLOW_CMD_GET,
 292         OVS_FLOW_CMD_SET
 293 };
 294
 295 struct ovs_flow_stats {
 296         __u64 n_packets;         /* Number of matched packets. */
 297         __u64 n_bytes;           /* Number of matched bytes. */
 298 };
 299
 300 enum ovs_key_attr {
 301         OVS_KEY_ATTR_UNSPEC,
 302         OVS_KEY_ATTR_ENCAP,     /* Nested set of encapsulated attributes. */
 303         OVS_KEY_ATTR_PRIORITY,  /* u32 skb->priority */
 304         OVS_KEY_ATTR_IN_PORT,   /* u32 OVS dp port number */
 305         OVS_KEY_ATTR_ETHERNET,  /* struct ovs_key_ethernet */
 306         OVS_KEY_ATTR_VLAN,      /* be16 VLAN TCI */
 307         OVS_KEY_ATTR_ETHERTYPE, /* be16 Ethernet type */
 308         OVS_KEY_ATTR_IPV4,      /* struct ovs_key_ipv4 */
 309         OVS_KEY_ATTR_IPV6,      /* struct ovs_key_ipv6 */
 310         OVS_KEY_ATTR_TCP,       /* struct ovs_key_tcp */
 311         OVS_KEY_ATTR_UDP,       /* struct ovs_key_udp */
 312         OVS_KEY_ATTR_ICMP,      /* struct ovs_key_icmp */
 313         OVS_KEY_ATTR_ICMPV6,    /* struct ovs_key_icmpv6 */
 314         OVS_KEY_ATTR_ARP,       /* struct ovs_key_arp */
 315         OVS_KEY_ATTR_ND,        /* struct ovs_key_nd */
 316         OVS_KEY_ATTR_SKB_MARK,  /* u32 skb mark */
 317         OVS_KEY_ATTR_TUNNEL,    /* Nested set of ovs_tunnel attributes */
 318         OVS_KEY_ATTR_SCTP,      /* struct ovs_key_sctp */
 319         OVS_KEY_ATTR_TCP_FLAGS, /* be16 TCP flags. */
 320         OVS_KEY_ATTR_DP_HASH,      /* u32 hash value. Value 0 indicates the hash
 321                                    is not computed by the datapath. */
 322         OVS_KEY_ATTR_RECIRC_ID, /* u32 recirc id */
 323         OVS_KEY_ATTR_MPLS,      /* array of struct ovs_key_mpls.
 324                                  * The implementation may restrict
 325                                  * the accepted length of the array. */
 326         OVS_KEY_ATTR_CT_STATE,  /* u32 bitmask of OVS_CS_F_* */
 327         OVS_KEY_ATTR_CT_ZONE,   /* u16 connection tracking zone. */
 328         OVS_KEY_ATTR_CT_MARK,   /* u32 connection tracking mark */
 329         OVS_KEY_ATTR_CT_LABELS, /* 16-octet connection tracking label */
 330
 331 #ifdef __KERNEL__
 332         OVS_KEY_ATTR_TUNNEL_INFO,  /* struct ip_tunnel_info */
 333 #endif
 334         __OVS_KEY_ATTR_MAX
 335 };
 336
 337 #define OVS_KEY_ATTR_MAX (__OVS_KEY_ATTR_MAX - 1)
 338
 339 enum ovs_tunnel_key_attr {
 340         OVS_TUNNEL_KEY_ATTR_ID,                 /* be64 Tunnel ID */
 341         OVS_TUNNEL_KEY_ATTR_IPV4_SRC,           /* be32 src IP address. */
 342         OVS_TUNNEL_KEY_ATTR_IPV4_DST,           /* be32 dst IP address. */
 343         OVS_TUNNEL_KEY_ATTR_TOS,                /* u8 Tunnel IP ToS. */
 344         OVS_TUNNEL_KEY_ATTR_TTL,                /* u8 Tunnel IP TTL. */
 345         OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT,      /* No argument, set DF. */
 346         OVS_TUNNEL_KEY_ATTR_CSUM,               /* No argument. CSUM packet. */
 347         OVS_TUNNEL_KEY_ATTR_OAM,                /* No argument. OAM frame.  */
 348         OVS_TUNNEL_KEY_ATTR_GENEVE_OPTS,        /* Array of Geneve options. */
 349         OVS_TUNNEL_KEY_ATTR_TP_SRC,             /* be16 src Transport Port. */
 350         OVS_TUNNEL_KEY_ATTR_TP_DST,             /* be16 dst Transport Port. */
 351         OVS_TUNNEL_KEY_ATTR_VXLAN_OPTS,         /* Nested OVS_VXLAN_EXT_* */
 352         __OVS_TUNNEL_KEY_ATTR_MAX
 353 };
 354
 355 #define OVS_TUNNEL_KEY_ATTR_MAX (__OVS_TUNNEL_KEY_ATTR_MAX - 1)
 356
 357 /**
 358  * enum ovs_frag_type - IPv4 and IPv6 fragment type
 359  * @OVS_FRAG_TYPE_NONE: Packet is not a fragment.
 360  * @OVS_FRAG_TYPE_FIRST: Packet is a fragment with offset 0.
 361  * @OVS_FRAG_TYPE_LATER: Packet is a fragment with nonzero offset.
 362  *
 363  * Used as the @ipv4_frag in &struct ovs_key_ipv4 and as @ipv6_frag &struct
 364  * ovs_key_ipv6.
 365  */
 366 enum ovs_frag_type {
 367         OVS_FRAG_TYPE_NONE,
 368         OVS_FRAG_TYPE_FIRST,
 369         OVS_FRAG_TYPE_LATER,
 370         __OVS_FRAG_TYPE_MAX
 371 };
 372
 373 #define OVS_FRAG_TYPE_MAX (__OVS_FRAG_TYPE_MAX - 1)
 374
 375 struct ovs_key_ethernet {
 376         __u8     eth_src[ETH_ALEN];
 377         __u8     eth_dst[ETH_ALEN];
 378 };
 379
 380 struct ovs_key_mpls {
 381         __be32 mpls_lse;
 382 };
 383
 384 struct ovs_key_ipv4 {
 385         __be32 ipv4_src;
 386         __be32 ipv4_dst;
 387         __u8   ipv4_proto;
 388         __u8   ipv4_tos;
 389         __u8   ipv4_ttl;
 390         __u8   ipv4_frag;       /* One of OVS_FRAG_TYPE_*. */
 391 };
 392
 393 struct ovs_key_ipv6 {
 394         __be32 ipv6_src[4];
 395         __be32 ipv6_dst[4];
 396         __be32 ipv6_label;      /* 20-bits in least-significant bits. */
 397         __u8   ipv6_proto;
 398         __u8   ipv6_tclass;
 399         __u8   ipv6_hlimit;
 400         __u8   ipv6_frag;       /* One of OVS_FRAG_TYPE_*. */
 401 };
 402
 403 struct ovs_key_tcp {
 404         __be16 tcp_src;
 405         __be16 tcp_dst;
 406 };
 407
 408 struct ovs_key_udp {
 409         __be16 udp_src;
 410         __be16 udp_dst;
 411 };
 412
 413 struct ovs_key_sctp {
 414         __be16 sctp_src;
 415         __be16 sctp_dst;
 416 };
 417
 418 struct ovs_key_icmp {
 419         __u8 icmp_type;
 420         __u8 icmp_code;
 421 };
 422
 423 struct ovs_key_icmpv6 {
 424         __u8 icmpv6_type;
 425         __u8 icmpv6_code;
 426 };
 427
 428 struct ovs_key_arp {
 429         __be32 arp_sip;
 430         __be32 arp_tip;
 431         __be16 arp_op;
 432         __u8   arp_sha[ETH_ALEN];
 433         __u8   arp_tha[ETH_ALEN];
 434 };
 435
 436 struct ovs_key_nd {
 437         __be32  nd_target[4];
 438         __u8    nd_sll[ETH_ALEN];
 439         __u8    nd_tll[ETH_ALEN];
 440 };
 441
 442 #define OVS_CT_LABELS_LEN       16
 443 struct ovs_key_ct_labels {
 444         __u8    ct_labels[OVS_CT_LABELS_LEN];
 445 };
 446
 447 /* OVS_KEY_ATTR_CT_STATE flags */
 448 #define OVS_CS_F_NEW               0x01 /* Beginning of a new connection. */
 449 #define OVS_CS_F_ESTABLISHED       0x02 /* Part of an existing connection. */
 450 #define OVS_CS_F_RELATED           0x04 /* Related to an established
 451                                          * connection. */
 452 #define OVS_CS_F_REPLY_DIR         0x08 /* Flow is in the reply direction. */
 453 #define OVS_CS_F_INVALID           0x10 /* Could not track connection. */
 454 #define OVS_CS_F_TRACKED           0x20 /* Conntrack has occurred. */
 455
 456 /**
 457  * enum ovs_flow_attr - attributes for %OVS_FLOW_* commands.
 458  * @OVS_FLOW_ATTR_KEY: Nested %OVS_KEY_ATTR_* attributes specifying the flow
 459  * key.  Always present in notifications.  Required for all requests (except
 460  * dumps).
 461  * @OVS_FLOW_ATTR_ACTIONS: Nested %OVS_ACTION_ATTR_* attributes specifying
 462  * the actions to take for packets that match the key.  Always present in
 463  * notifications.  Required for %OVS_FLOW_CMD_NEW requests, optional for
 464  * %OVS_FLOW_CMD_SET requests.  An %OVS_FLOW_CMD_SET without
 465  * %OVS_FLOW_ATTR_ACTIONS will not modify the actions.  To clear the actions,
 466  * an %OVS_FLOW_ATTR_ACTIONS without any nested attributes must be given.
 467  * @OVS_FLOW_ATTR_STATS: &struct ovs_flow_stats giving statistics for this
 468  * flow.  Present in notifications if the stats would be nonzero.  Ignored in
 469  * requests.
 470  * @OVS_FLOW_ATTR_TCP_FLAGS: An 8-bit value giving the OR'd value of all of the
 471  * TCP flags seen on packets in this flow.  Only present in notifications for
 472  * TCP flows, and only if it would be nonzero.  Ignored in requests.
 473  * @OVS_FLOW_ATTR_USED: A 64-bit integer giving the time, in milliseconds on
 474  * the system monotonic clock, at which a packet was last processed for this
 475  * flow.  Only present in notifications if a packet has been processed for this
 476  * flow.  Ignored in requests.
 477  * @OVS_FLOW_ATTR_CLEAR: If present in a %OVS_FLOW_CMD_SET request, clears the
 478  * last-used time, accumulated TCP flags, and statistics for this flow.
 479  * Otherwise ignored in requests.  Never present in notifications.
 480  * @OVS_FLOW_ATTR_MASK: Nested %OVS_KEY_ATTR_* attributes specifying the
 481  * mask bits for wildcarded flow match. Mask bit value '1' specifies exact
 482  * match with corresponding flow key bit, while mask bit value '0' specifies
 483  * a wildcarded match. Omitting attribute is treated as wildcarding all
 484  * corresponding fields. Optional for all requests. If not present,
 485  * all flow key bits are exact match bits.
 486  * @OVS_FLOW_ATTR_UFID: A value between 1-16 octets specifying a unique
 487  * identifier for the flow. Causes the flow to be indexed by this value rather
 488  * than the value of the %OVS_FLOW_ATTR_KEY attribute. Optional for all
 489  * requests. Present in notifications if the flow was created with this
 490  * attribute.
 491  * @OVS_FLOW_ATTR_UFID_FLAGS: A 32-bit value of OR'd %OVS_UFID_F_*
 492  * flags that provide alternative semantics for flow installation and
 493  * retrieval. Optional for all requests.
 494  *
 495  * These attributes follow the &struct ovs_header within the Generic Netlink
 496  * payload for %OVS_FLOW_* commands.
 497  */
 498 enum ovs_flow_attr {
 499         OVS_FLOW_ATTR_UNSPEC,
 500         OVS_FLOW_ATTR_KEY,       /* Sequence of OVS_KEY_ATTR_* attributes. */
 501         OVS_FLOW_ATTR_ACTIONS,   /* Nested OVS_ACTION_ATTR_* attributes. */
 502         OVS_FLOW_ATTR_STATS,     /* struct ovs_flow_stats. */
 503         OVS_FLOW_ATTR_TCP_FLAGS, /* 8-bit OR'd TCP flags. */
 504         OVS_FLOW_ATTR_USED,      /* u64 msecs last used in monotonic time. */
 505         OVS_FLOW_ATTR_CLEAR,     /* Flag to clear stats, tcp_flags, used. */
 506         OVS_FLOW_ATTR_MASK,      /* Sequence of OVS_KEY_ATTR_* attributes. */
 507         OVS_FLOW_ATTR_PROBE,     /* Flow operation is a feature probe, error
 508                                   * logging should be suppressed. */
 509         OVS_FLOW_ATTR_UFID,      /* Variable length unique flow identifier. */
 510         OVS_FLOW_ATTR_UFID_FLAGS,/* u32 of OVS_UFID_F_*. */
 511         __OVS_FLOW_ATTR_MAX
 512 };
 513
 514 #define OVS_FLOW_ATTR_MAX (__OVS_FLOW_ATTR_MAX - 1)
 515
 516 /**
 517  * Omit attributes for notifications.
 518  *
 519  * If a datapath request contains an %OVS_UFID_F_OMIT_* flag, then the datapath
 520  * may omit the corresponding %OVS_FLOW_ATTR_* from the response.
 521  */
 522 #define OVS_UFID_F_OMIT_KEY      (1 << 0)
 523 #define OVS_UFID_F_OMIT_MASK     (1 << 1)
 524 #define OVS_UFID_F_OMIT_ACTIONS  (1 << 2)
 525
 526 /**
 527  * enum ovs_sample_attr - Attributes for %OVS_ACTION_ATTR_SAMPLE action.
 528  * @OVS_SAMPLE_ATTR_PROBABILITY: 32-bit fraction of packets to sample with
 529  * @OVS_ACTION_ATTR_SAMPLE.  A value of 0 samples no packets, a value of
 530  * %UINT32_MAX samples all packets and intermediate values sample intermediate
 531  * fractions of packets.
 532  * @OVS_SAMPLE_ATTR_ACTIONS: Set of actions to execute in sampling event.
 533  * Actions are passed as nested attributes.
 534  *
 535  * Executes the specified actions with the given probability on a per-packet
 536  * basis.
 537  */
 538 enum ovs_sample_attr {
 539         OVS_SAMPLE_ATTR_UNSPEC,
 540         OVS_SAMPLE_ATTR_PROBABILITY, /* u32 number */
 541         OVS_SAMPLE_ATTR_ACTIONS,     /* Nested OVS_ACTION_ATTR_* attributes. */
 542         __OVS_SAMPLE_ATTR_MAX,
 543 };
 544
 545 #define OVS_SAMPLE_ATTR_MAX (__OVS_SAMPLE_ATTR_MAX - 1)
 546
 547 /**
 548  * enum ovs_userspace_attr - Attributes for %OVS_ACTION_ATTR_USERSPACE action.
 549  * @OVS_USERSPACE_ATTR_PID: u32 Netlink PID to which the %OVS_PACKET_CMD_ACTION
 550  * message should be sent.  Required.
 551  * @OVS_USERSPACE_ATTR_USERDATA: If present, its variable-length argument is
 552  * copied to the %OVS_PACKET_CMD_ACTION message as %OVS_PACKET_ATTR_USERDATA.
 553  * @OVS_USERSPACE_ATTR_EGRESS_TUN_PORT: If present, u32 output port to get
 554  * tunnel info.
 555  * @OVS_USERSPACE_ATTR_ACTIONS: If present, send actions with upcall.
 556  */
 557 enum ovs_userspace_attr {
 558         OVS_USERSPACE_ATTR_UNSPEC,
 559         OVS_USERSPACE_ATTR_PID,       /* u32 Netlink PID to receive upcalls. */
 560         OVS_USERSPACE_ATTR_USERDATA,  /* Optional user-specified cookie. */
 561         OVS_USERSPACE_ATTR_EGRESS_TUN_PORT,  /* Optional, u32 output port
 562                                               * to get tunnel info. */
 563         OVS_USERSPACE_ATTR_ACTIONS,   /* Optional flag to get actions. */
 564         __OVS_USERSPACE_ATTR_MAX
 565 };
 566
 567 #define OVS_USERSPACE_ATTR_MAX (__OVS_USERSPACE_ATTR_MAX - 1)
 568
 569 /**
 570  * struct ovs_action_push_mpls - %OVS_ACTION_ATTR_PUSH_MPLS action argument.
 571  * @mpls_lse: MPLS label stack entry to push.
 572  * @mpls_ethertype: Ethertype to set in the encapsulating ethernet frame.
 573  *
 574  * The only values @mpls_ethertype should ever be given are %ETH_P_MPLS_UC and
 575  * %ETH_P_MPLS_MC, indicating MPLS unicast or multicast. Other are rejected.
 576  */
 577 struct ovs_action_push_mpls {
 578         __be32 mpls_lse;
 579         __be16 mpls_ethertype; /* Either %ETH_P_MPLS_UC or %ETH_P_MPLS_MC */
 580 };
 581
 582 /**
 583  * struct ovs_action_push_vlan - %OVS_ACTION_ATTR_PUSH_VLAN action argument.
 584  * @vlan_tpid: Tag protocol identifier (TPID) to push.
 585  * @vlan_tci: Tag control identifier (TCI) to push.  The CFI bit must be set
 586  * (but it will not be set in the 802.1Q header that is pushed).
 587  *
 588  * The @vlan_tpid value is typically %ETH_P_8021Q.  The only acceptable TPID
 589  * values are those that the kernel module also parses as 802.1Q headers, to
 590  * prevent %OVS_ACTION_ATTR_PUSH_VLAN followed by %OVS_ACTION_ATTR_POP_VLAN
 591  * from having surprising results.
 592  */
 593 struct ovs_action_push_vlan {
 594         __be16 vlan_tpid;       /* 802.1Q TPID. */
 595         __be16 vlan_tci;        /* 802.1Q TCI (VLAN ID and priority). */
 596 };
 597
 598 /* Data path hash algorithm for computing Datapath hash.
 599  *
 600  * The algorithm type only specifies the fields in a flow
 601  * will be used as part of the hash. Each datapath is free
 602  * to use its own hash algorithm. The hash value will be
 603  * opaque to the user space daemon.
 604  */
 605 enum ovs_hash_alg {
 606         OVS_HASH_ALG_L4,
 607 };
 608
 609 /*
 610  * struct ovs_action_hash - %OVS_ACTION_ATTR_HASH action argument.
 611  * @hash_alg: Algorithm used to compute hash prior to recirculation.
 612  * @hash_basis: basis used for computing hash.
 613  */
 614 struct ovs_action_hash {
 615         uint32_t  hash_alg;     /* One of ovs_hash_alg. */
 616         uint32_t  hash_basis;
 617 };
 618
 619 /**
 620  * enum ovs_ct_attr - Attributes for %OVS_ACTION_ATTR_CT action.
 621  * @OVS_CT_ATTR_COMMIT: If present, commits the connection to the conntrack
 622  * table. This allows future packets for the same connection to be identified
 623  * as 'established' or 'related'. The flow key for the current packet will
 624  * retain the pre-commit connection state.
 625  * @OVS_CT_ATTR_ZONE: u16 connection tracking zone.
 626  * @OVS_CT_ATTR_MARK: u32 value followed by u32 mask. For each bit set in the
 627  * mask, the corresponding bit in the value is copied to the connection
 628  * tracking mark field in the connection.
 629  * @OVS_CT_ATTR_LABEL: %OVS_CT_LABELS_LEN value followed by %OVS_CT_LABELS_LEN
 630  * mask. For each bit set in the mask, the corresponding bit in the value is
 631  * copied to the connection tracking label field in the connection.
 632  * @OVS_CT_ATTR_HELPER: variable length string defining conntrack ALG.
 633  */
 634 enum ovs_ct_attr {
 635         OVS_CT_ATTR_UNSPEC,
 636         OVS_CT_ATTR_COMMIT,     /* No argument, commits connection. */
 637         OVS_CT_ATTR_ZONE,       /* u16 zone id. */
 638         OVS_CT_ATTR_MARK,       /* mark to associate with this connection. */
 639         OVS_CT_ATTR_LABELS,     /* labels to associate with this connection. */
 640         OVS_CT_ATTR_HELPER,     /* netlink helper to assist detection of
 641                                    related connections. */
 642         __OVS_CT_ATTR_MAX
 643 };
 644
 645 #define OVS_CT_ATTR_MAX (__OVS_CT_ATTR_MAX - 1)
 646
 647 /**
 648  * enum ovs_action_attr - Action types.
 649  *
 650  * @OVS_ACTION_ATTR_OUTPUT: Output packet to port.
 651  * @OVS_ACTION_ATTR_USERSPACE: Send packet to userspace according to nested
 652  * %OVS_USERSPACE_ATTR_* attributes.
 653  * @OVS_ACTION_ATTR_SET: Replaces the contents of an existing header.  The
 654  * single nested %OVS_KEY_ATTR_* attribute specifies a header to modify and its
 655  * value.
 656  * @OVS_ACTION_ATTR_SET_MASKED: Replaces the contents of an existing header.  A
 657  * nested %OVS_KEY_ATTR_* attribute specifies a header to modify, its value,
 658  * and a mask.  For every bit set in the mask, the corresponding bit value
 659  * is copied from the value to the packet header field, rest of the bits are
 660  * left unchanged.  The non-masked value bits must be passed in as zeroes.
 661  * Masking is not supported for the %OVS_KEY_ATTR_TUNNEL attribute.
 662  * @OVS_ACTION_ATTR_PUSH_VLAN: Push a new outermost 802.1Q header onto the
 663  * packet.
 664  * @OVS_ACTION_ATTR_POP_VLAN: Pop the outermost 802.1Q header off the packet.
 665  * @OVS_ACTION_ATTR_SAMPLE: Probabilitically executes actions, as specified in
 666  * the nested %OVS_SAMPLE_ATTR_* attributes.
 667  * @OVS_ACTION_ATTR_PUSH_MPLS: Push a new MPLS label stack entry onto the
 668  * top of the packets MPLS label stack.  Set the ethertype of the
 669  * encapsulating frame to either %ETH_P_MPLS_UC or %ETH_P_MPLS_MC to
 670  * indicate the new packet contents.
 671  * @OVS_ACTION_ATTR_POP_MPLS: Pop an MPLS label stack entry off of the
 672  * packet's MPLS label stack.  Set the encapsulating frame's ethertype to
 673  * indicate the new packet contents. This could potentially still be
 674  * %ETH_P_MPLS if the resulting MPLS label stack is not empty.  If there
 675  * is no MPLS label stack, as determined by ethertype, no action is taken.
 676  * @OVS_ACTION_ATTR_CT: Track the connection. Populate the conntrack-related
 677  * entries in the flow key.
 678  *
 679  * Only a single header can be set with a single %OVS_ACTION_ATTR_SET.  Not all
 680  * fields within a header are modifiable, e.g. the IPv4 protocol and fragment
 681  * type may not be changed.
 682  *
 683  * @OVS_ACTION_ATTR_SET_TO_MASKED: Kernel internal masked set action translated
 684  * from the @OVS_ACTION_ATTR_SET.
 685  */
 686
 687 enum ovs_action_attr {
 688         OVS_ACTION_ATTR_UNSPEC,
 689         OVS_ACTION_ATTR_OUTPUT,       /* u32 port number. */
 690         OVS_ACTION_ATTR_USERSPACE,    /* Nested OVS_USERSPACE_ATTR_*. */
 691         OVS_ACTION_ATTR_SET,          /* One nested OVS_KEY_ATTR_*. */
 692         OVS_ACTION_ATTR_PUSH_VLAN,    /* struct ovs_action_push_vlan. */
 693         OVS_ACTION_ATTR_POP_VLAN,     /* No argument. */
 694         OVS_ACTION_ATTR_SAMPLE,       /* Nested OVS_SAMPLE_ATTR_*. */
 695         OVS_ACTION_ATTR_RECIRC,       /* u32 recirc_id. */
 696         OVS_ACTION_ATTR_HASH,         /* struct ovs_action_hash. */
 697         OVS_ACTION_ATTR_PUSH_MPLS,    /* struct ovs_action_push_mpls. */
 698         OVS_ACTION_ATTR_POP_MPLS,     /* __be16 ethertype. */
 699         OVS_ACTION_ATTR_SET_MASKED,   /* One nested OVS_KEY_ATTR_* including
 700                                        * data immediately followed by a mask.
 701                                        * The data must be zero for the unmasked
 702                                        * bits. */
 703         OVS_ACTION_ATTR_CT,           /* Nested OVS_CT_ATTR_* . */
 704
 705         __OVS_ACTION_ATTR_MAX,        /* Nothing past this will be accepted
 706                                        * from userspace. */
 707
 708 #ifdef __KERNEL__
 709         OVS_ACTION_ATTR_SET_TO_MASKED, /* Kernel module internal masked
 710                                         * set action converted from
 711                                         * OVS_ACTION_ATTR_SET. */
 712 #endif
 713 };
 714
 715 #define OVS_ACTION_ATTR_MAX (__OVS_ACTION_ATTR_MAX - 1)
 716
 717 #endif /* _LINUX_OPENVSWITCH_H */