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