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 #endif
  67
  68 #include <linux/if_link.h>
  69
  70 #define ODP_MAX 256             /* Maximum number of datapaths. */
  71
  72 #define ODP_DP_CREATE           _IO('O', 0)
  73 #define ODP_DP_DESTROY          _IO('O', 1)
  74 #define ODP_DP_STATS            _IOW('O', 2, struct odp_stats)
  75
  76 #define ODP_GET_DROP_FRAGS      _IOW('O', 3, int)
  77 #define ODP_SET_DROP_FRAGS      _IOR('O', 4, int)
  78
  79 #define ODP_GET_LISTEN_MASK     _IOW('O', 5, int)
  80 #define ODP_SET_LISTEN_MASK     _IOR('O', 6, int)
  81
  82 #define ODP_VPORT_ATTACH        _IOR('O', 7, struct odp_port)
  83 #define ODP_VPORT_DETACH        _IOR('O', 8, int)
  84 #define ODP_VPORT_QUERY         _IOWR('O', 9, struct odp_port)
  85 #define ODP_VPORT_LIST          _IOWR('O', 10, struct odp_portvec)
  86
  87 #define ODP_FLOW_GET            _IOWR('O', 13, struct odp_flow)
  88 #define ODP_FLOW_PUT            _IOWR('O', 14, struct odp_flow)
  89 #define ODP_FLOW_LIST           _IOWR('O', 15, struct odp_flowvec)
  90 #define ODP_FLOW_FLUSH          _IO('O', 16)
  91 #define ODP_FLOW_DEL            _IOWR('O', 17, struct odp_flow)
  92
  93 #define ODP_EXECUTE             _IOR('O', 18, struct odp_execute)
  94
  95 #define ODP_SET_SFLOW_PROBABILITY _IOR('O', 19, int)
  96 #define ODP_GET_SFLOW_PROBABILITY _IOW('O', 20, int)
  97
  98 #define ODP_VPORT_MOD           _IOR('O', 22, struct odp_port)
  99 #define ODP_VPORT_STATS_GET     _IOWR('O', 24, struct odp_vport_stats_req)
 100 #define ODP_VPORT_ETHER_GET     _IOWR('O', 25, struct odp_vport_ether)
 101 #define ODP_VPORT_ETHER_SET     _IOW('O', 26, struct odp_vport_ether)
 102 #define ODP_VPORT_MTU_GET       _IOWR('O', 27, struct odp_vport_mtu)
 103 #define ODP_VPORT_MTU_SET       _IOW('O', 28, struct odp_vport_mtu)
 104 #define ODP_VPORT_STATS_SET     _IOWR('O', 29, struct odp_vport_stats_req)
 105
 106 struct odp_stats {
 107     /* Flows. */
 108     uint32_t n_flows;           /* Number of flows in flow table. */
 109     uint32_t cur_capacity;      /* Current flow table capacity. */
 110     uint32_t max_capacity;      /* Maximum expansion of flow table capacity. */
 111
 112     /* Ports. */
 113     uint32_t n_ports;           /* Current number of ports. */
 114     uint32_t max_ports;         /* Maximum supported number of ports. */
 115
 116     /* Lookups. */
 117     uint64_t n_frags;           /* Number of dropped IP fragments. */
 118     uint64_t n_hit;             /* Number of flow table matches. */
 119     uint64_t n_missed;          /* Number of flow table misses. */
 120     uint64_t n_lost;            /* Number of misses not sent to userspace. */
 121
 122     /* Queues. */
 123     uint16_t max_miss_queue;    /* Max length of ODPL_MISS queue. */
 124     uint16_t max_action_queue;  /* Max length of ODPL_ACTION queue. */
 125     uint16_t max_sflow_queue;   /* Max length of ODPL_SFLOW queue. */
 126 };
 127
 128 /* Logical ports. */
 129 #define ODPP_LOCAL      ((uint16_t)0)
 130 #define ODPP_NONE       ((uint16_t)-1)
 131 #define ODPP_NORMAL     ((uint16_t)-2)
 132
 133 /* Listening channels. */
 134 #define _ODPL_MISS_NR   0       /* Packet missed in flow table. */
 135 #define ODPL_MISS       (1 << _ODPL_MISS_NR)
 136 #define _ODPL_ACTION_NR 1       /* Packet output to ODPP_CONTROLLER. */
 137 #define ODPL_ACTION     (1 << _ODPL_ACTION_NR)
 138 #define _ODPL_SFLOW_NR  2       /* sFlow samples. */
 139 #define ODPL_SFLOW      (1 << _ODPL_SFLOW_NR)
 140 #define ODPL_ALL        (ODPL_MISS | ODPL_ACTION | ODPL_SFLOW)
 141
 142 /**
 143  * struct odp_msg - format of messages read from datapath fd.
 144  * @type: One of the %_ODPL_* constants.
 145  * @length: Total length of message, including this header.
 146  * @port: Port that received the packet embedded in this message.
 147  * @reserved: Not currently used.  Should be set to 0.
 148  * @arg: Argument value whose meaning depends on @type.
 149  *
 150  * For @type == %_ODPL_MISS_NR, the header is followed by packet data.  The
 151  * @arg member is the ID (in network byte order) of the tunnel that
 152  * encapsulated this packet. It is 0 if the packet was not received on a tunnel.
 153  *
 154  * For @type == %_ODPL_ACTION_NR, the header is followed by packet data.  The
 155  * @arg member is copied from the &struct odp_action_controller that caused
 156  * the &struct odp_msg to be composed.
 157  *
 158  * For @type == %_ODPL_SFLOW_NR, the header is followed by &struct
 159  * odp_sflow_sample_header, then by an array of &union odp_action (the number
 160  * of which is specified in &struct odp_sflow_sample_header), then by packet
 161  * data.
 162  */
 163 struct odp_msg {
 164     uint32_t type;
 165     uint32_t length;
 166     uint16_t port;
 167     uint16_t reserved;
 168     uint32_t 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  * @n_actions: Number of "union odp_action"s 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 an array of &union odp_action
 179  * (the number of which is specified in @n_actions) and then by packet data.
 180  */
 181 struct odp_sflow_sample_header {
 182     uint32_t sample_pool;
 183     uint32_t n_actions;
 184 };
 185
 186 #define VPORT_TYPE_SIZE     16
 187 #define VPORT_CONFIG_SIZE     32
 188 struct odp_port {
 189     char devname[16];           /* IFNAMSIZ */
 190     char type[VPORT_TYPE_SIZE];
 191     uint16_t port;
 192     uint16_t reserved1;
 193     uint32_t reserved2;
 194     __aligned_u64 config[VPORT_CONFIG_SIZE / 8]; /* type-specific */
 195 };
 196
 197 struct odp_portvec {
 198     struct odp_port *ports;
 199     uint32_t n_ports;
 200 };
 201
 202 struct odp_flow_stats {
 203     uint64_t n_packets;         /* Number of matched packets. */
 204     uint64_t n_bytes;           /* Number of matched bytes. */
 205     uint64_t used_sec;          /* Time last used, in system monotonic time. */
 206     uint32_t used_nsec;
 207     uint8_t  tcp_flags;
 208     uint8_t  reserved;
 209     uint16_t error;             /* Used by ODP_FLOW_GET. */
 210 };
 211
 212 /*
 213  * The datapath protocol adopts the Linux convention for TCI fields: if an
 214  * 802.1Q header is present then its TCI value is used verbatim except that the
 215  * CFI bit (0x1000) is always set to 1, and all-bits-zero indicates no 802.1Q
 216  * header.
 217  */
 218 #define ODP_TCI_PRESENT 0x1000  /* CFI bit */
 219
 220 struct odp_flow_key {
 221     ovs_be32 tun_id;            /* Encapsulating tunnel ID. */
 222     ovs_be32 nw_src;            /* IP source address. */
 223     ovs_be32 nw_dst;            /* IP destination address. */
 224     uint16_t in_port;           /* Input switch port. */
 225     ovs_be16 dl_tci;            /* All zeros if 802.1Q header absent,
 226                                   * ODP_TCI_PRESENT set if present. */
 227     ovs_be16 dl_type;           /* Ethernet frame type. */
 228     ovs_be16 tp_src;            /* TCP/UDP source port. */
 229     ovs_be16 tp_dst;            /* TCP/UDP destination port. */
 230     uint8_t  dl_src[6];         /* Ethernet source address. */
 231     uint8_t  dl_dst[6];         /* Ethernet destination address. */
 232     uint8_t  nw_proto;          /* IP protocol or lower 8 bits of
 233                                    ARP opcode. */
 234     uint8_t  nw_tos;            /* IP ToS (DSCP field, 6 bits). */
 235 };
 236
 237 /* Flags for ODP_FLOW. */
 238 #define ODPFF_ZERO_TCP_FLAGS (1 << 0) /* Zero the TCP flags. */
 239
 240 struct odp_flow {
 241     struct odp_flow_stats stats;
 242     struct odp_flow_key key;
 243     union odp_action *actions;
 244     uint32_t n_actions;
 245     uint32_t flags;
 246 };
 247
 248 /* Flags for ODP_FLOW_PUT. */
 249 #define ODPPF_CREATE        (1 << 0) /* Allow creating a new flow. */
 250 #define ODPPF_MODIFY        (1 << 1) /* Allow modifying an existing flow. */
 251 #define ODPPF_ZERO_STATS    (1 << 2) /* Zero the stats of an existing flow. */
 252
 253 /* ODP_FLOW_PUT argument. */
 254 struct odp_flow_put {
 255     struct odp_flow flow;
 256     uint32_t flags;
 257 };
 258
 259 struct odp_flowvec {
 260     struct odp_flow *flows;
 261     uint32_t n_flows;
 262 };
 263
 264 /* Action types. */
 265 #define ODPAT_OUTPUT            0    /* Output to switch port. */
 266 #define ODPAT_CONTROLLER        2    /* Send copy to controller. */
 267 #define ODPAT_SET_DL_TCI        3    /* Set the 802.1q TCI value. */
 268 #define ODPAT_STRIP_VLAN        5    /* Strip the 802.1q header. */
 269 #define ODPAT_SET_DL_SRC        6    /* Ethernet source address. */
 270 #define ODPAT_SET_DL_DST        7    /* Ethernet destination address. */
 271 #define ODPAT_SET_NW_SRC        8    /* IP source address. */
 272 #define ODPAT_SET_NW_DST        9    /* IP destination address. */
 273 #define ODPAT_SET_NW_TOS        10   /* IP ToS/DSCP field (6 bits). */
 274 #define ODPAT_SET_TP_SRC        11   /* TCP/UDP source port. */
 275 #define ODPAT_SET_TP_DST        12   /* TCP/UDP destination port. */
 276 #define ODPAT_SET_TUNNEL        13   /* Set the encapsulating tunnel ID. */
 277 #define ODPAT_SET_PRIORITY      14   /* Set skb->priority. */
 278 #define ODPAT_POP_PRIORITY      15   /* Restore original skb->priority. */
 279 #define ODPAT_DROP_SPOOFED_ARP  16   /* Drop ARPs with spoofed source MAC. */
 280 #define ODPAT_N_ACTIONS         17
 281
 282 struct odp_action_output {
 283     uint16_t type;              /* ODPAT_OUTPUT. */
 284     uint16_t port;              /* Output port. */
 285     uint16_t reserved1;
 286     uint16_t reserved2;
 287 };
 288
 289 struct odp_action_controller {
 290     uint16_t type;              /* ODPAT_OUTPUT_CONTROLLER. */
 291     uint16_t reserved;
 292     uint32_t arg;               /* Copied to struct odp_msg 'arg' member. */
 293 };
 294
 295 struct odp_action_tunnel {
 296     uint16_t type;              /* ODPAT_SET_TUNNEL. */
 297     uint16_t reserved;
 298     ovs_be32 tun_id;            /* Tunnel ID. */
 299 };
 300
 301 /* Action structure for ODPAT_SET_DL_TCI. */
 302 struct odp_action_dl_tci {
 303     uint16_t type;              /* ODPAT_SET_DL_TCI. */
 304     ovs_be16 tci;               /* New TCI.  CFI bit must be zero. */
 305     uint32_t reserved;
 306 };
 307
 308 /* Action structure for ODPAT_SET_DL_SRC/DST. */
 309 struct odp_action_dl_addr {
 310     uint16_t type;              /* ODPAT_SET_DL_SRC/DST. */
 311     uint8_t dl_addr[6];         /* Ethernet address. */
 312 };
 313
 314 /* Action structure for ODPAT_SET_NW_SRC/DST. */
 315 struct odp_action_nw_addr {
 316     uint16_t type;              /* ODPAT_SET_TW_SRC/DST. */
 317     uint16_t reserved;
 318     ovs_be32 nw_addr;           /* IP address. */
 319 };
 320
 321 struct odp_action_nw_tos {
 322     uint16_t type;              /* ODPAT_SET_NW_TOS. */
 323     uint8_t nw_tos;             /* IP ToS/DSCP field (6 bits). */
 324     uint8_t reserved1;
 325     uint16_t reserved2;
 326     uint16_t reserved3;
 327 };
 328
 329 /* Action structure for ODPAT_SET_TP_SRC/DST. */
 330 struct odp_action_tp_port {
 331     uint16_t type;              /* ODPAT_SET_TP_SRC/DST. */
 332     ovs_be16 tp_port;           /* TCP/UDP port. */
 333     uint16_t reserved1;
 334     uint16_t reserved2;
 335 };
 336
 337 /* Action structure for ODPAT_SET_PRIORITY. */
 338 struct odp_action_priority {
 339     uint16_t type;              /* ODPAT_SET_PRIORITY. */
 340     uint16_t reserved;
 341     uint32_t priority;          /* skb->priority value. */
 342 };
 343
 344 union odp_action {
 345     uint16_t type;
 346     struct odp_action_output output;
 347     struct odp_action_controller controller;
 348     struct odp_action_tunnel tunnel;
 349     struct odp_action_dl_tci dl_tci;
 350     struct odp_action_dl_addr dl_addr;
 351     struct odp_action_nw_addr nw_addr;
 352     struct odp_action_nw_tos nw_tos;
 353     struct odp_action_tp_port tp_port;
 354     struct odp_action_priority priority;
 355 };
 356
 357 struct odp_execute {
 358     union odp_action *actions;
 359     uint32_t n_actions;
 360
 361     const void *data;
 362     uint32_t length;
 363 };
 364
 365 #define VPORT_TYPE_SIZE     16
 366 struct odp_vport_add {
 367     char port_type[VPORT_TYPE_SIZE];
 368     char devname[16];           /* IFNAMSIZ */
 369     void *config;
 370 };
 371
 372 struct odp_vport_mod {
 373     char devname[16];           /* IFNAMSIZ */
 374     void *config;
 375 };
 376
 377 struct odp_vport_stats_req {
 378     char devname[16];           /* IFNAMSIZ */
 379     struct rtnl_link_stats64 stats;
 380 };
 381
 382 struct odp_vport_ether {
 383     char devname[16];           /* IFNAMSIZ */
 384     unsigned char ether_addr[6];
 385 };
 386
 387 struct odp_vport_mtu {
 388     char devname[16];           /* IFNAMSIZ */
 389     uint16_t mtu;
 390 };
 391
 392 /* Values below this cutoff are 802.3 packets and the two bytes
 393  * following MAC addresses are used as a frame length.  Otherwise, the
 394  * two bytes are used as the Ethernet type.
 395  */
 396 #define ODP_DL_TYPE_ETH2_CUTOFF   0x0600
 397
 398 /* Value of dl_type to indicate that the frame does not include an
 399  * Ethernet type.
 400  */
 401 #define ODP_DL_TYPE_NOT_ETH_TYPE  0x05ff
 402
 403 #endif  /* openvswitch/datapath-protocol.h */