include/openvswitch/datapath-protocol.h

   1 /*
   2  * Copyright (c) 2009, 2010, 2011 Nicira Networks.
   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 modify
  25  * it under the terms of the GNU General Public License as published by
  26  * the Free Software Foundation; either version 2 of the License, or
  27  * (at your option) any later version.
  28  *
  29  * This program is distributed in the hope that it will be useful,
  30  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  31  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  32  * GNU General Public License for more details.
  33  *
  34  * You should have received a copy of the GNU General Public License along
  35  * with this program; if not, write to the Free Software Foundation, Inc.,
  36  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  37  * ----------------------------------------------------------------------
  38  */
  39
  40 /* Protocol between userspace and kernel datapath.
  41  *
  42  * Be sure to update datapath/odp-compat.h if you change any of the structures
  43  * in here. */
  44
  45 #ifndef OPENVSWITCH_DATAPATH_PROTOCOL_H
  46 #define OPENVSWITCH_DATAPATH_PROTOCOL_H 1
  47
  48 /* The ovs_be<N> types indicate that an object is in big-endian, not
  49  * native-endian, byte order.  They are otherwise equivalent to uint<N>_t.
  50  * The Linux kernel already has __be<N> types for this, which take on
  51  * additional semantics when the "sparse" static checker is used, so we use
  52  * those types when compiling the kernel. */
  53 #ifdef __KERNEL__
  54 #include <linux/types.h>
  55 #include <linux/socket.h>
  56 #define ovs_be16 __be16
  57 #define ovs_be32 __be32
  58 #define ovs_be64 __be64
  59 #else
  60 #include "openvswitch/types.h"
  61 #include <sys/socket.h>
  62 #endif
  63
  64 #ifndef __aligned_u64
  65 #define __aligned_u64 __u64 __attribute__((aligned(8)))
  66 #define __aligned_be64 __be64 __attribute__((aligned(8)))
  67 #define __aligned_le64 __le64 __attribute__((aligned(8)))
  68 #endif
  69
  70 #include <linux/if_link.h>
  71 #include <linux/netlink.h>
  72
  73 #define ODP_MAX 256             /* Maximum number of datapaths. */
  74
  75 #define ODP_DP_CREATE           _IO('O', 0)
  76 #define ODP_DP_DESTROY          _IO('O', 1)
  77 #define ODP_DP_STATS            _IOW('O', 2, struct odp_stats)
  78
  79 #define ODP_GET_DROP_FRAGS      _IOW('O', 3, int)
  80 #define ODP_SET_DROP_FRAGS      _IOR('O', 4, int)
  81
  82 #define ODP_GET_LISTEN_MASK     _IOW('O', 5, int)
  83 #define ODP_SET_LISTEN_MASK     _IOR('O', 6, int)
  84
  85 #define ODP_VPORT_ATTACH        _IOR('O', 7, struct odp_port)
  86 #define ODP_VPORT_DETACH        _IOR('O', 8, int)
  87 #define ODP_VPORT_QUERY         _IOWR('O', 9, struct odp_port)
  88 #define ODP_VPORT_DUMP          _IOWR('O', 10, struct odp_vport_dump)
  89
  90 #define ODP_FLOW_GET            _IOWR('O', 13, struct odp_flowvec)
  91 #define ODP_FLOW_PUT            _IOWR('O', 14, struct odp_flow)
  92 #define ODP_FLOW_DUMP           _IOWR('O', 15, struct odp_flow_dump)
  93 #define ODP_FLOW_FLUSH          _IO('O', 16)
  94 #define ODP_FLOW_DEL            _IOWR('O', 17, struct odp_flow)
  95
  96 #define ODP_EXECUTE             _IOR('O', 18, struct odp_execute)
  97
  98 #define ODP_SET_SFLOW_PROBABILITY _IOR('O', 19, int)
  99 #define ODP_GET_SFLOW_PROBABILITY _IOW('O', 20, int)
 100
 101 #define ODP_VPORT_MOD           _IOR('O', 22, struct odp_port)
 102 #define ODP_VPORT_STATS_GET     _IOWR('O', 24, struct odp_vport_stats_req)
 103 #define ODP_VPORT_ETHER_GET     _IOWR('O', 25, struct odp_vport_ether)
 104 #define ODP_VPORT_ETHER_SET     _IOW('O', 26, struct odp_vport_ether)
 105 #define ODP_VPORT_MTU_GET       _IOWR('O', 27, struct odp_vport_mtu)
 106 #define ODP_VPORT_MTU_SET       _IOW('O', 28, struct odp_vport_mtu)
 107 #define ODP_VPORT_STATS_SET     _IOWR('O', 29, struct odp_vport_stats_req)
 108
 109 struct odp_stats {
 110     /* Flows. */
 111     uint32_t n_flows;           /* Number of flows in flow table. */
 112     uint32_t cur_capacity;      /* Current flow table capacity. */
 113     uint32_t max_capacity;      /* Maximum expansion of flow table capacity. */
 114
 115     /* Ports. */
 116     uint32_t n_ports;           /* Current number of ports. */
 117     uint32_t max_ports;         /* Maximum supported number of ports. */
 118
 119     /* Lookups. */
 120     uint64_t n_frags;           /* Number of dropped IP fragments. */
 121     uint64_t n_hit;             /* Number of flow table matches. */
 122     uint64_t n_missed;          /* Number of flow table misses. */
 123     uint64_t n_lost;            /* Number of misses not sent to userspace. */
 124
 125     /* Queues. */
 126     uint16_t max_miss_queue;    /* Max length of ODPL_MISS queue. */
 127     uint16_t max_action_queue;  /* Max length of ODPL_ACTION queue. */
 128     uint16_t max_sflow_queue;   /* Max length of ODPL_SFLOW queue. */
 129 };
 130
 131 /* Logical ports. */
 132 #define ODPP_LOCAL      ((uint16_t)0)
 133 #define ODPP_NONE       ((uint16_t)-1)
 134
 135 /* Listening channels. */
 136 #define _ODPL_MISS_NR   0       /* Packet missed in flow table. */
 137 #define ODPL_MISS       (1 << _ODPL_MISS_NR)
 138 #define _ODPL_ACTION_NR 1       /* Packet output to ODPP_CONTROLLER. */
 139 #define ODPL_ACTION     (1 << _ODPL_ACTION_NR)
 140 #define _ODPL_SFLOW_NR  2       /* sFlow samples. */
 141 #define ODPL_SFLOW      (1 << _ODPL_SFLOW_NR)
 142 #define ODPL_ALL        (ODPL_MISS | ODPL_ACTION | ODPL_SFLOW)
 143
 144 enum odp_packet_type {
 145         ODP_PACKET_ATTR_UNSPEC,
 146         ODP_PACKET_ATTR_TYPE,        /* 32-bit enum, one of _ODP_*_NR. */
 147         ODP_PACKET_ATTR_PACKET,      /* Packet data. */
 148         ODP_PACKET_ATTR_KEY,         /* Nested ODP_KEY_ATTR_* attributes. */
 149         ODP_PACKET_ATTR_USERDATA,    /* 64-bit data from ODPAT_CONTROLLER. */
 150         ODP_PACKET_ATTR_SAMPLE_POOL, /* # sampling candidate packets so far. */
 151         ODP_PACKET_ATTR_ACTIONS,     /* Nested ODPAT_* attributes. */
 152         __ODP_PACKET_ATTR_MAX
 153 };
 154
 155 #define ODP_PACKET_ATTR_MAX (__ODP_PACKET_ATTR_MAX - 1)
 156
 157 /**
 158  * struct odp_packet - header for packets passed up between kernel and
 159  * userspace.
 160  * @dp_idx: Number of datapath to which the packet belongs.
 161  * @len: Length of complete message, including this header.
 162  *
 163  * The header is followed by a sequence of Netlink attributes.  The
 164  * %ODP_PACKET_ATTR_TYPE, %ODP_PACKET_ATTR_PACKET, and %ODP_PACKET_ATTR_KEY
 165  * attributes are always present.  When @type == %_ODPL_ACTION_NR, the
 166  * %ODP_PACKET_ATTR_USERDATA attribute is included if it would be nonzero.
 167  * When @type == %_ODPL_SFLOW_NR, the %ODP_PACKET_ATTR_SAMPLE_POOL and
 168  * %ODP_PACKET_ATTR_ACTIONS attributes are included.
 169  *
 170  * For @type of %_ODPL_ACTION_NR, %ODP_PACKET_ATTR_PACKET reflects changes made
 171  * by actions preceding %ODPAT_CONTROLLER, but %ODP_PACKET_ATTR_KEY is the flow
 172  * key extracted from the packet as originally received.
 173  */
 174 struct odp_packet {
 175         uint32_t dp_idx;
 176         uint32_t len;
 177 };
 178
 179 #define VPORT_TYPE_SIZE     16
 180 #define VPORT_CONFIG_SIZE     32
 181 struct odp_port {
 182     char devname[16];           /* IFNAMSIZ */
 183     char type[VPORT_TYPE_SIZE];
 184     uint16_t port;
 185     uint16_t reserved1;
 186     uint32_t reserved2;
 187     __aligned_u64 config[VPORT_CONFIG_SIZE / 8]; /* type-specific */
 188 };
 189
 190 /**
 191  * struct odp_vport_dump - ODP_VPORT_DUMP argument.
 192  * @port: Points to port structure to fill in.
 193  * @port_no: Minimum port number of interest.
 194  *
 195  * Used to iterate through vports one at a time.  The kernel fills in @port
 196  * with the information for the configured port with the smallest port number
 197  * greater than or equal to @port_no.  If there is no such port, it sets
 198  * @port->devname to the empty string.
 199  */
 200 struct odp_vport_dump {
 201     struct odp_port *port;
 202     uint32_t port_no;
 203 };
 204
 205 struct odp_flow_stats {
 206     uint64_t n_packets;         /* Number of matched packets. */
 207     uint64_t n_bytes;           /* Number of matched bytes. */
 208     uint64_t used_sec;          /* Time last used, in system monotonic time. */
 209     uint32_t used_nsec;
 210     uint8_t  tcp_flags;
 211     uint8_t  reserved;
 212     uint16_t error;             /* Used by ODP_FLOW_GET. */
 213 };
 214
 215 enum odp_key_type {
 216         ODP_KEY_ATTR_UNSPEC,
 217         ODP_KEY_ATTR_TUN_ID,    /* 64-bit tunnel ID */
 218         ODP_KEY_ATTR_IN_PORT,   /* 32-bit ODP port number */
 219         ODP_KEY_ATTR_ETHERNET,  /* struct odp_key_ethernet */
 220         ODP_KEY_ATTR_8021Q,     /* struct odp_key_8021q */
 221         ODP_KEY_ATTR_ETHERTYPE, /* 16-bit Ethernet type */
 222         ODP_KEY_ATTR_IPV4,      /* struct odp_key_ipv4 */
 223         ODP_KEY_ATTR_TCP,       /* struct odp_key_tcp */
 224         ODP_KEY_ATTR_UDP,       /* struct odp_key_udp */
 225         ODP_KEY_ATTR_ICMP,      /* struct odp_key_icmp */
 226         ODP_KEY_ATTR_ARP,       /* struct odp_key_arp */
 227         __ODP_KEY_ATTR_MAX
 228 };
 229
 230 #define ODP_KEY_ATTR_MAX (__ODP_KEY_ATTR_MAX - 1)
 231
 232 struct odp_key_ethernet {
 233         uint8_t  eth_src[6];
 234         uint8_t  eth_dst[6];
 235 };
 236
 237 struct odp_key_8021q {
 238         ovs_be16 q_tpid;
 239         ovs_be16 q_tci;
 240 };
 241
 242 struct odp_key_ipv4 {
 243         ovs_be32 ipv4_src;
 244         ovs_be32 ipv4_dst;
 245         uint8_t  ipv4_proto;
 246         uint8_t  ipv4_tos;
 247 };
 248
 249 struct odp_key_tcp {
 250         ovs_be16 tcp_src;
 251         ovs_be16 tcp_dst;
 252 };
 253
 254 struct odp_key_udp {
 255         ovs_be16 udp_src;
 256         ovs_be16 udp_dst;
 257 };
 258
 259 struct odp_key_icmp {
 260         uint8_t icmp_type;
 261         uint8_t icmp_code;
 262 };
 263
 264 struct odp_key_arp {
 265         ovs_be32 arp_sip;
 266         ovs_be32 arp_tip;
 267         ovs_be16 arp_op;
 268 };
 269
 270 /* Flags for ODP_FLOW. */
 271 #define ODPFF_ZERO_TCP_FLAGS (1 << 0) /* Zero the TCP flags. */
 272 #define ODPFF_EOF            (1 << 1) /* ODP_FLOW_DUMP: end of flow table. */
 273
 274 struct odp_flow {
 275     struct odp_flow_stats stats;
 276     struct nlattr *key;
 277     uint32_t key_len;
 278     struct nlattr *actions;
 279     uint32_t actions_len;
 280     uint32_t flags;
 281 };
 282
 283 /* Flags for ODP_FLOW_PUT. */
 284 #define ODPPF_CREATE        (1 << 0) /* Allow creating a new flow. */
 285 #define ODPPF_MODIFY        (1 << 1) /* Allow modifying an existing flow. */
 286 #define ODPPF_ZERO_STATS    (1 << 2) /* Zero the stats of an existing flow. */
 287
 288 /* ODP_FLOW_PUT argument. */
 289 struct odp_flow_put {
 290     struct odp_flow flow;
 291     uint32_t flags;
 292 };
 293
 294 struct odp_flowvec {
 295     struct odp_flow *flows;
 296     uint32_t n_flows;
 297 };
 298
 299 /* ODP_FLOW_DUMP argument.
 300  *
 301  * This is used to iterate through the flow table flow-by-flow.  Each
 302  * ODP_FLOW_DUMP call either stores a new odp_flow into 'flow' or stores
 303  * ODPFF_EOF into flow->flags to indicate that the end of the table has been
 304  * reaches, and updates 'state' in-place.
 305  *
 306  * Before the first call, zero 'state'.  The format of 'state' is otherwise
 307  * unspecified.
 308  */
 309 struct odp_flow_dump {
 310         struct odp_flow *flow;
 311         uint32_t state[2];
 312 };
 313
 314 /* Action types. */
 315 enum odp_action_type {
 316     ODPAT_UNSPEC,
 317     ODPAT_OUTPUT,               /* Output to switch port. */
 318     ODPAT_CONTROLLER,           /* Send copy to controller. */
 319     ODPAT_SET_DL_TCI,           /* Set the 802.1q TCI value. */
 320     ODPAT_STRIP_VLAN,           /* Strip the 802.1q header. */
 321     ODPAT_SET_DL_SRC,           /* Ethernet source address. */
 322     ODPAT_SET_DL_DST,           /* Ethernet destination address. */
 323     ODPAT_SET_NW_SRC,           /* IPv4 source address. */
 324     ODPAT_SET_NW_DST,           /* IPv4 destination address. */
 325     ODPAT_SET_NW_TOS,           /* IP ToS/DSCP field (6 bits). */
 326     ODPAT_SET_TP_SRC,           /* TCP/UDP source port. */
 327     ODPAT_SET_TP_DST,           /* TCP/UDP destination port. */
 328     ODPAT_SET_TUNNEL,           /* Set the encapsulating tunnel ID. */
 329     ODPAT_SET_PRIORITY,         /* Set skb->priority. */
 330     ODPAT_POP_PRIORITY,         /* Restore original skb->priority. */
 331     ODPAT_DROP_SPOOFED_ARP,     /* Drop ARPs with spoofed source MAC. */
 332     __ODPAT_MAX
 333 };
 334
 335 #define ODPAT_MAX (__ODPAT_MAX - 1)
 336
 337 struct odp_execute {
 338     struct nlattr *actions;
 339     uint32_t actions_len;
 340
 341     const void *data;
 342     uint32_t length;
 343 };
 344
 345 #define VPORT_TYPE_SIZE     16
 346 struct odp_vport_add {
 347     char port_type[VPORT_TYPE_SIZE];
 348     char devname[16];           /* IFNAMSIZ */
 349     void *config;
 350 };
 351
 352 struct odp_vport_mod {
 353     char devname[16];           /* IFNAMSIZ */
 354     void *config;
 355 };
 356
 357 struct odp_vport_stats_req {
 358     char devname[16];           /* IFNAMSIZ */
 359     struct rtnl_link_stats64 stats;
 360 };
 361
 362 struct odp_vport_ether {
 363     char devname[16];           /* IFNAMSIZ */
 364     unsigned char ether_addr[6];
 365 };
 366
 367 struct odp_vport_mtu {
 368     char devname[16];           /* IFNAMSIZ */
 369     uint16_t mtu;
 370 };
 371
 372 #endif  /* openvswitch/datapath-protocol.h */