datapath/linux/compat/include/linux/openvswitch.h

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