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_NEW           _IOR('O', 7, struct odp_vport)
  86 #define ODP_VPORT_DEL           _IOR('O', 8, struct odp_vport)
  87 #define ODP_VPORT_GET           _IOWR('O', 9, struct odp_vport)
  88 #define ODP_VPORT_SET           _IOR('O', 22, struct odp_vport)
  89 #define ODP_VPORT_DUMP          _IOWR('O', 10, struct odp_vport)
  90
  91 #define ODP_FLOW_GET            _IOWR('O', 13, struct odp_flowvec)
  92 #define ODP_FLOW_PUT            _IOWR('O', 14, struct odp_flow)
  93 #define ODP_FLOW_DUMP           _IOWR('O', 15, struct odp_flow_dump)
  94 #define ODP_FLOW_FLUSH          _IO('O', 16)
  95 #define ODP_FLOW_DEL            _IOWR('O', 17, struct odp_flow)
  96
  97 #define ODP_EXECUTE             _IOR('O', 18, struct odp_execute)
  98
  99 #define ODP_SET_SFLOW_PROBABILITY _IOR('O', 19, int)
 100 #define ODP_GET_SFLOW_PROBABILITY _IOW('O', 20, int)
 101
 102 struct odp_stats {
 103     /* Ports. */
 104     uint32_t n_ports;           /* Current number of ports. */
 105     uint32_t max_ports;         /* Maximum supported number of ports. */
 106
 107     /* Lookups. */
 108     uint64_t n_frags;           /* Number of dropped IP fragments. */
 109     uint64_t n_hit;             /* Number of flow table matches. */
 110     uint64_t n_missed;          /* Number of flow table misses. */
 111     uint64_t n_lost;            /* Number of misses not sent to userspace. */
 112
 113     /* Queues. */
 114     uint16_t max_miss_queue;    /* Max length of ODPL_MISS queue. */
 115     uint16_t max_action_queue;  /* Max length of ODPL_ACTION queue. */
 116     uint16_t max_sflow_queue;   /* Max length of ODPL_SFLOW queue. */
 117 };
 118
 119 /* Logical ports. */
 120 #define ODPP_LOCAL      ((uint16_t)0)
 121 #define ODPP_NONE       ((uint16_t)-1)
 122
 123 /* Listening channels. */
 124 #define _ODPL_MISS_NR   0       /* Packet missed in flow table. */
 125 #define ODPL_MISS       (1 << _ODPL_MISS_NR)
 126 #define _ODPL_ACTION_NR 1       /* Packet output to ODPP_CONTROLLER. */
 127 #define ODPL_ACTION     (1 << _ODPL_ACTION_NR)
 128 #define _ODPL_SFLOW_NR  2       /* sFlow samples. */
 129 #define ODPL_SFLOW      (1 << _ODPL_SFLOW_NR)
 130 #define ODPL_ALL        (ODPL_MISS | ODPL_ACTION | ODPL_SFLOW)
 131
 132 enum odp_packet_type {
 133         ODP_PACKET_ATTR_UNSPEC,
 134         ODP_PACKET_ATTR_TYPE,        /* 32-bit enum, one of _ODP_*_NR. */
 135         ODP_PACKET_ATTR_PACKET,      /* Packet data. */
 136         ODP_PACKET_ATTR_KEY,         /* Nested ODP_KEY_ATTR_* attributes. */
 137         ODP_PACKET_ATTR_USERDATA,    /* 64-bit data from ODPAT_CONTROLLER. */
 138         ODP_PACKET_ATTR_SAMPLE_POOL, /* # sampling candidate packets so far. */
 139         ODP_PACKET_ATTR_ACTIONS,     /* Nested ODPAT_* attributes. */
 140         __ODP_PACKET_ATTR_MAX
 141 };
 142
 143 #define ODP_PACKET_ATTR_MAX (__ODP_PACKET_ATTR_MAX - 1)
 144
 145 /**
 146  * struct odp_packet - header for packets passed up between kernel and
 147  * userspace.
 148  * @dp_idx: Number of datapath to which the packet belongs.
 149  * @len: Length of complete message, including this header.
 150  *
 151  * The header is followed by a sequence of Netlink attributes.  The
 152  * %ODP_PACKET_ATTR_TYPE, %ODP_PACKET_ATTR_PACKET, and %ODP_PACKET_ATTR_KEY
 153  * attributes are always present.  When @type == %_ODPL_ACTION_NR, the
 154  * %ODP_PACKET_ATTR_USERDATA attribute is included if it would be nonzero.
 155  * When @type == %_ODPL_SFLOW_NR, the %ODP_PACKET_ATTR_SAMPLE_POOL and
 156  * %ODP_PACKET_ATTR_ACTIONS attributes are included.
 157  *
 158  * For @type of %_ODPL_ACTION_NR, %ODP_PACKET_ATTR_PACKET reflects changes made
 159  * by actions preceding %ODPAT_CONTROLLER, but %ODP_PACKET_ATTR_KEY is the flow
 160  * key extracted from the packet as originally received.
 161  */
 162 struct odp_packet {
 163         uint32_t dp_idx;
 164         uint32_t len;
 165 };
 166
 167 enum odp_vport_type {
 168         ODP_VPORT_TYPE_UNSPEC,
 169         ODP_VPORT_TYPE_NETDEV,   /* network device */
 170         ODP_VPORT_TYPE_INTERNAL, /* network device implemented by datapath */
 171         ODP_VPORT_TYPE_PATCH,    /* virtual tunnel connecting two vports */
 172         ODP_VPORT_TYPE_GRE,      /* GRE tunnel */
 173         ODP_VPORT_TYPE_CAPWAP,   /* CAPWAP tunnel */
 174         __ODP_VPORT_TYPE_MAX
 175 };
 176
 177 #define ODP_VPORT_TYPE_MAX (__ODP_VPORT_TYPE_MAX - 1)
 178
 179 /**
 180  * struct odp_vport - header with basic information about a virtual port.
 181  * @dp_idx: Number of datapath to which the vport belongs.
 182  * @len: Length of this structure plus the Netlink attributes following it.
 183  * @total_len: Total space available for kernel reply to request.
 184  *
 185  * Followed by &struct nlattr attributes, whose types are drawn from
 186  * %ODP_VPORT_ATTR_*, up to a length of @len bytes including the &struct
 187  * odp_vport header.
 188  */
 189 struct odp_vport {
 190         uint32_t dp_idx;
 191         uint32_t len;
 192         uint32_t total_len;
 193 };
 194
 195 enum {
 196         ODP_VPORT_ATTR_UNSPEC,
 197         ODP_VPORT_ATTR_PORT_NO, /* port number within datapath */
 198         ODP_VPORT_ATTR_TYPE,    /* 32-bit ODP_VPORT_TYPE_* constant. */
 199         ODP_VPORT_ATTR_NAME,    /* string name, up to IFNAMSIZ bytes long */
 200         ODP_VPORT_ATTR_STATS,   /* struct rtnl_link_stats64 */
 201         ODP_VPORT_ATTR_ADDRESS, /* hardware address */
 202         ODP_VPORT_ATTR_MTU,     /* 32-bit maximum transmission unit */
 203         ODP_VPORT_ATTR_OPTIONS, /* nested attributes, varies by vport type */
 204         ODP_VPORT_ATTR_IFINDEX, /* 32-bit ifindex of backing netdev */
 205         ODP_VPORT_ATTR_IFLINK,  /* 32-bit ifindex on which packets are sent */
 206         __ODP_VPORT_ATTR_MAX
 207 };
 208
 209 #define ODP_VPORT_ATTR_MAX (__ODP_VPORT_ATTR_MAX - 1)
 210
 211 /* ODP_VPORT_ATTR_OPTIONS attributes for patch vports. */
 212 enum {
 213         ODP_PATCH_ATTR_UNSPEC,
 214         ODP_PATCH_ATTR_PEER,    /* name of peer vport, as a string */
 215         __ODP_PATCH_ATTR_MAX
 216 };
 217
 218 #define ODP_PATCH_ATTR_MAX (__ODP_PATCH_ATTR_MAX - 1)
 219
 220 struct odp_flow_stats {
 221     uint64_t n_packets;         /* Number of matched packets. */
 222     uint64_t n_bytes;           /* Number of matched bytes. */
 223     uint64_t used_sec;          /* Time last used, in system monotonic time. */
 224     uint32_t used_nsec;
 225     uint8_t  tcp_flags;
 226     uint8_t  reserved;
 227     uint16_t error;             /* Used by ODP_FLOW_GET. */
 228 };
 229
 230 enum odp_key_type {
 231         ODP_KEY_ATTR_UNSPEC,
 232         ODP_KEY_ATTR_TUN_ID,    /* 64-bit tunnel ID */
 233         ODP_KEY_ATTR_IN_PORT,   /* 32-bit ODP port number */
 234         ODP_KEY_ATTR_ETHERNET,  /* struct odp_key_ethernet */
 235         ODP_KEY_ATTR_8021Q,     /* struct odp_key_8021q */
 236         ODP_KEY_ATTR_ETHERTYPE, /* 16-bit Ethernet type */
 237         ODP_KEY_ATTR_IPV4,      /* struct odp_key_ipv4 */
 238         ODP_KEY_ATTR_TCP,       /* struct odp_key_tcp */
 239         ODP_KEY_ATTR_UDP,       /* struct odp_key_udp */
 240         ODP_KEY_ATTR_ICMP,      /* struct odp_key_icmp */
 241         ODP_KEY_ATTR_ARP,       /* struct odp_key_arp */
 242         __ODP_KEY_ATTR_MAX
 243 };
 244
 245 #define ODP_KEY_ATTR_MAX (__ODP_KEY_ATTR_MAX - 1)
 246
 247 struct odp_key_ethernet {
 248         uint8_t  eth_src[6];
 249         uint8_t  eth_dst[6];
 250 };
 251
 252 struct odp_key_8021q {
 253         ovs_be16 q_tpid;
 254         ovs_be16 q_tci;
 255 };
 256
 257 struct odp_key_ipv4 {
 258         ovs_be32 ipv4_src;
 259         ovs_be32 ipv4_dst;
 260         uint8_t  ipv4_proto;
 261         uint8_t  ipv4_tos;
 262 };
 263
 264 struct odp_key_tcp {
 265         ovs_be16 tcp_src;
 266         ovs_be16 tcp_dst;
 267 };
 268
 269 struct odp_key_udp {
 270         ovs_be16 udp_src;
 271         ovs_be16 udp_dst;
 272 };
 273
 274 struct odp_key_icmp {
 275         uint8_t icmp_type;
 276         uint8_t icmp_code;
 277 };
 278
 279 struct odp_key_arp {
 280         ovs_be32 arp_sip;
 281         ovs_be32 arp_tip;
 282         ovs_be16 arp_op;
 283 };
 284
 285 /* Flags for ODP_FLOW. */
 286 #define ODPFF_ZERO_TCP_FLAGS (1 << 0) /* Zero the TCP flags. */
 287 #define ODPFF_EOF            (1 << 1) /* ODP_FLOW_DUMP: end of flow table. */
 288
 289 struct odp_flow {
 290     struct odp_flow_stats stats;
 291     struct nlattr *key;
 292     uint32_t key_len;
 293     struct nlattr *actions;
 294     uint32_t actions_len;
 295     uint32_t flags;
 296 };
 297
 298 /* Flags for ODP_FLOW_PUT. */
 299 #define ODPPF_CREATE        (1 << 0) /* Allow creating a new flow. */
 300 #define ODPPF_MODIFY        (1 << 1) /* Allow modifying an existing flow. */
 301 #define ODPPF_ZERO_STATS    (1 << 2) /* Zero the stats of an existing flow. */
 302
 303 /* ODP_FLOW_PUT argument. */
 304 struct odp_flow_put {
 305     struct odp_flow flow;
 306     uint32_t flags;
 307 };
 308
 309 struct odp_flowvec {
 310     struct odp_flow *flows;
 311     uint32_t n_flows;
 312 };
 313
 314 /* ODP_FLOW_DUMP argument.
 315  *
 316  * This is used to iterate through the flow table flow-by-flow.  Each
 317  * ODP_FLOW_DUMP call either stores a new odp_flow into 'flow' or stores
 318  * ODPFF_EOF into flow->flags to indicate that the end of the table has been
 319  * reaches, and updates 'state' in-place.
 320  *
 321  * Before the first call, zero 'state'.  The format of 'state' is otherwise
 322  * unspecified.
 323  */
 324 struct odp_flow_dump {
 325         struct odp_flow *flow;
 326         uint32_t state[2];
 327 };
 328
 329 /* Action types. */
 330 enum odp_action_type {
 331     ODPAT_UNSPEC,
 332     ODPAT_OUTPUT,               /* Output to switch port. */
 333     ODPAT_CONTROLLER,           /* Send copy to controller. */
 334     ODPAT_SET_DL_TCI,           /* Set the 802.1q TCI value. */
 335     ODPAT_STRIP_VLAN,           /* Strip the 802.1q header. */
 336     ODPAT_SET_DL_SRC,           /* Ethernet source address. */
 337     ODPAT_SET_DL_DST,           /* Ethernet destination address. */
 338     ODPAT_SET_NW_SRC,           /* IPv4 source address. */
 339     ODPAT_SET_NW_DST,           /* IPv4 destination address. */
 340     ODPAT_SET_NW_TOS,           /* IP ToS/DSCP field (6 bits). */
 341     ODPAT_SET_TP_SRC,           /* TCP/UDP source port. */
 342     ODPAT_SET_TP_DST,           /* TCP/UDP destination port. */
 343     ODPAT_SET_TUNNEL,           /* Set the encapsulating tunnel ID. */
 344     ODPAT_SET_PRIORITY,         /* Set skb->priority. */
 345     ODPAT_POP_PRIORITY,         /* Restore original skb->priority. */
 346     ODPAT_DROP_SPOOFED_ARP,     /* Drop ARPs with spoofed source MAC. */
 347     __ODPAT_MAX
 348 };
 349
 350 #define ODPAT_MAX (__ODPAT_MAX - 1)
 351
 352 struct odp_execute {
 353     struct nlattr *actions;
 354     uint32_t actions_len;
 355
 356     const void *data;
 357     uint32_t length;
 358 };
 359
 360 #endif  /* openvswitch/datapath-protocol.h */