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