include/openvswitch/datapath-protocol.h

   1 /*
   2  * Copyright (c) 2009, 2010 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_LIST          _IOWR('O', 10, struct odp_portvec)
  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 /**
 145  * struct odp_msg - format of messages read from datapath fd.
 146  * @length: Total length of message, including this header.
 147  * @type: One of the %_ODPL_* constants.
 148  * @port: Port that received the packet embedded in this message.
 149  * @arg: Argument value whose meaning depends on @type.
 150  *
 151  * For @type == %_ODPL_MISS_NR, the header is followed by packet data.  The
 152  * @arg member is the ID (in network byte order) of the tunnel that
 153  * encapsulated this packet. It is 0 if the packet was not received on a tunnel.
 154  *
 155  * For @type == %_ODPL_ACTION_NR, the header is followed by packet data.  The
 156  * @arg member is copied from the %ODPAT_CONTROLLER action that caused the
 157  * &struct odp_msg to be composed.
 158  *
 159  * For @type == %_ODPL_SFLOW_NR, the header is followed by &struct
 160  * odp_sflow_sample_header, then by a series of Netlink attributes (whose
 161  * length is specified in &struct odp_sflow_sample_header), then by packet
 162  * data.
 163  */
 164 struct odp_msg {
 165     uint32_t length;
 166     uint16_t type;
 167     uint16_t port;
 168     __aligned_u64 arg;
 169 };
 170
 171 /**
 172  * struct odp_sflow_sample_header - header added to sFlow sampled packet.
 173  * @sample_pool: Number of packets that were candidates for sFlow sampling,
 174  * regardless of whether they were actually chosen and sent down to userspace.
 175  * @actions_len: Number of bytes of actions immediately following this header.
 176  *
 177  * This header follows &struct odp_msg when that structure's @type is
 178  * %_ODPL_SFLOW_NR, and it is itself followed by a series of Netlink attributes
 179  * (the number of bytes of which is specified in @actions_len) and then by
 180  * packet data.
 181  */
 182 struct odp_sflow_sample_header {
 183     uint32_t sample_pool;
 184     uint32_t actions_len;
 185 };
 186
 187 #define VPORT_TYPE_SIZE     16
 188 #define VPORT_CONFIG_SIZE     32
 189 struct odp_port {
 190     char devname[16];           /* IFNAMSIZ */
 191     char type[VPORT_TYPE_SIZE];
 192     uint16_t port;
 193     uint16_t reserved1;
 194     uint32_t reserved2;
 195     __aligned_u64 config[VPORT_CONFIG_SIZE / 8]; /* type-specific */
 196 };
 197
 198 struct odp_portvec {
 199     struct odp_port *ports;
 200     uint32_t n_ports;
 201 };
 202
 203 struct odp_flow_stats {
 204     uint64_t n_packets;         /* Number of matched packets. */
 205     uint64_t n_bytes;           /* Number of matched bytes. */
 206     uint64_t used_sec;          /* Time last used, in system monotonic time. */
 207     uint32_t used_nsec;
 208     uint8_t  tcp_flags;
 209     uint8_t  reserved;
 210     uint16_t error;             /* Used by ODP_FLOW_GET. */
 211 };
 212
 213 enum odp_key_type {
 214         ODP_KEY_ATTR_UNSPEC,
 215         ODP_KEY_ATTR_TUN_ID,    /* 64-bit tunnel ID */
 216         ODP_KEY_ATTR_IN_PORT,   /* 32-bit ODP port number */
 217         ODP_KEY_ATTR_ETHERNET,  /* struct odp_key_ethernet */
 218         ODP_KEY_ATTR_8021Q,     /* struct odp_key_8021q */
 219         ODP_KEY_ATTR_ETHERTYPE, /* 16-bit Ethernet type */
 220         ODP_KEY_ATTR_IPV4,      /* struct odp_key_ipv4 */
 221         ODP_KEY_ATTR_TCP,       /* struct odp_key_tcp */
 222         ODP_KEY_ATTR_UDP,       /* struct odp_key_udp */
 223         ODP_KEY_ATTR_ICMP,      /* struct odp_key_icmp */
 224         ODP_KEY_ATTR_ARP,       /* struct odp_key_arp */
 225         __ODP_KEY_ATTR_MAX
 226 };
 227
 228 #define ODP_KEY_ATTR_MAX (__ODP_KEY_ATTR_MAX - 1)
 229
 230 struct odp_key_ethernet {
 231         uint8_t  eth_src[6];
 232         uint8_t  eth_dst[6];
 233 };
 234
 235 struct odp_key_8021q {
 236         ovs_be16 q_tpid;
 237         ovs_be16 q_tci;
 238 };
 239
 240 struct odp_key_ipv4 {
 241         ovs_be32 ipv4_src;
 242         ovs_be32 ipv4_dst;
 243         uint8_t  ipv4_proto;
 244         uint8_t  ipv4_tos;
 245 };
 246
 247 struct odp_key_tcp {
 248         ovs_be16 tcp_src;
 249         ovs_be16 tcp_dst;
 250 };
 251
 252 struct odp_key_udp {
 253         ovs_be16 udp_src;
 254         ovs_be16 udp_dst;
 255 };
 256
 257 struct odp_key_icmp {
 258         uint8_t icmp_type;
 259         uint8_t icmp_code;
 260 };
 261
 262 struct odp_key_arp {
 263         ovs_be32 arp_sip;
 264         ovs_be32 arp_tip;
 265         ovs_be16 arp_op;
 266 };
 267
 268 /* Flags for ODP_FLOW. */
 269 #define ODPFF_ZERO_TCP_FLAGS (1 << 0) /* Zero the TCP flags. */
 270 #define ODPFF_EOF            (1 << 1) /* ODP_FLOW_DUMP: end of flow table. */
 271
 272 struct odp_flow {
 273     struct odp_flow_stats stats;
 274     struct nlattr *key;
 275     uint32_t key_len;
 276     struct nlattr *actions;
 277     uint32_t actions_len;
 278     uint32_t flags;
 279 };
 280
 281 /* Flags for ODP_FLOW_PUT. */
 282 #define ODPPF_CREATE        (1 << 0) /* Allow creating a new flow. */
 283 #define ODPPF_MODIFY        (1 << 1) /* Allow modifying an existing flow. */
 284 #define ODPPF_ZERO_STATS    (1 << 2) /* Zero the stats of an existing flow. */
 285
 286 /* ODP_FLOW_PUT argument. */
 287 struct odp_flow_put {
 288     struct odp_flow flow;
 289     uint32_t flags;
 290 };
 291
 292 struct odp_flowvec {
 293     struct odp_flow *flows;
 294     uint32_t n_flows;
 295 };
 296
 297 /* ODP_FLOW_DUMP argument.
 298  *
 299  * This is used to iterate through the flow table flow-by-flow.  Each
 300  * ODP_FLOW_DUMP call either stores a new odp_flow into 'flow' or stores
 301  * ODPFF_EOF into flow->flags to indicate that the end of the table has been
 302  * reaches, and updates 'state' in-place.
 303  *
 304  * Before the first call, zero 'state'.  The format of 'state' is otherwise
 305  * unspecified.
 306  */
 307 struct odp_flow_dump {
 308         struct odp_flow *flow;
 309         uint32_t state[2];
 310 };
 311
 312 /* Action types. */
 313 enum odp_action_type {
 314     ODPAT_UNSPEC,
 315     ODPAT_OUTPUT,               /* Output to switch port. */
 316     ODPAT_CONTROLLER,           /* Send copy to controller. */
 317     ODPAT_SET_DL_TCI,           /* Set the 802.1q TCI value. */
 318     ODPAT_STRIP_VLAN,           /* Strip the 802.1q header. */
 319     ODPAT_SET_DL_SRC,           /* Ethernet source address. */
 320     ODPAT_SET_DL_DST,           /* Ethernet destination address. */
 321     ODPAT_SET_NW_SRC,           /* IPv4 source address. */
 322     ODPAT_SET_NW_DST,           /* IPv4 destination address. */
 323     ODPAT_SET_NW_TOS,           /* IP ToS/DSCP field (6 bits). */
 324     ODPAT_SET_TP_SRC,           /* TCP/UDP source port. */
 325     ODPAT_SET_TP_DST,           /* TCP/UDP destination port. */
 326     ODPAT_SET_TUNNEL,           /* Set the encapsulating tunnel ID. */
 327     ODPAT_SET_PRIORITY,         /* Set skb->priority. */
 328     ODPAT_POP_PRIORITY,         /* Restore original skb->priority. */
 329     ODPAT_DROP_SPOOFED_ARP,     /* Drop ARPs with spoofed source MAC. */
 330     __ODPAT_MAX
 331 };
 332
 333 #define ODPAT_MAX (__ODPAT_MAX - 1)
 334
 335 struct odp_execute {
 336     struct nlattr *actions;
 337     uint32_t actions_len;
 338
 339     const void *data;
 340     uint32_t length;
 341 };
 342
 343 #define VPORT_TYPE_SIZE     16
 344 struct odp_vport_add {
 345     char port_type[VPORT_TYPE_SIZE];
 346     char devname[16];           /* IFNAMSIZ */
 347     void *config;
 348 };
 349
 350 struct odp_vport_mod {
 351     char devname[16];           /* IFNAMSIZ */
 352     void *config;
 353 };
 354
 355 struct odp_vport_stats_req {
 356     char devname[16];           /* IFNAMSIZ */
 357     struct rtnl_link_stats64 stats;
 358 };
 359
 360 struct odp_vport_ether {
 361     char devname[16];           /* IFNAMSIZ */
 362     unsigned char ether_addr[6];
 363 };
 364
 365 struct odp_vport_mtu {
 366     char devname[16];           /* IFNAMSIZ */
 367     uint16_t mtu;
 368 };
 369
 370 #endif  /* openvswitch/datapath-protocol.h */