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_flow)
  91 #define ODP_FLOW_PUT            _IOWR('O', 14, struct odp_flow)
  92 #define ODP_FLOW_LIST           _IOWR('O', 15, struct odp_flowvec)
  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 #define ODPP_NORMAL     ((uint16_t)-2)
 135
 136 /* Listening channels. */
 137 #define _ODPL_MISS_NR   0       /* Packet missed in flow table. */
 138 #define ODPL_MISS       (1 << _ODPL_MISS_NR)
 139 #define _ODPL_ACTION_NR 1       /* Packet output to ODPP_CONTROLLER. */
 140 #define ODPL_ACTION     (1 << _ODPL_ACTION_NR)
 141 #define _ODPL_SFLOW_NR  2       /* sFlow samples. */
 142 #define ODPL_SFLOW      (1 << _ODPL_SFLOW_NR)
 143 #define ODPL_ALL        (ODPL_MISS | ODPL_ACTION | ODPL_SFLOW)
 144
 145 /**
 146  * struct odp_msg - format of messages read from datapath fd.
 147  * @length: Total length of message, including this header.
 148  * @type: One of the %_ODPL_* constants.
 149  * @port: Port that received the packet embedded in this message.
 150  * @arg: Argument value whose meaning depends on @type.
 151  *
 152  * For @type == %_ODPL_MISS_NR, the header is followed by packet data.  The
 153  * @arg member is the ID (in network byte order) of the tunnel that
 154  * encapsulated this packet. It is 0 if the packet was not received on a tunnel.
 155  *
 156  * For @type == %_ODPL_ACTION_NR, the header is followed by packet data.  The
 157  * @arg member is copied from the %ODPAT_CONTROLLER action that caused the
 158  * &struct odp_msg to be composed.
 159  *
 160  * For @type == %_ODPL_SFLOW_NR, the header is followed by &struct
 161  * odp_sflow_sample_header, then by a series of Netlink attributes (whose
 162  * length is specified in &struct odp_sflow_sample_header), then by packet
 163  * data.
 164  */
 165 struct odp_msg {
 166     uint32_t length;
 167     uint16_t type;
 168     uint16_t port;
 169     __aligned_u64 arg;
 170 };
 171
 172 /**
 173  * struct odp_sflow_sample_header - header added to sFlow sampled packet.
 174  * @sample_pool: Number of packets that were candidates for sFlow sampling,
 175  * regardless of whether they were actually chosen and sent down to userspace.
 176  * @actions_len: Number of bytes of actions immediately following this header.
 177  *
 178  * This header follows &struct odp_msg when that structure's @type is
 179  * %_ODPL_SFLOW_NR, and it is itself followed by a series of Netlink attributes
 180  * (the number of bytes of which is specified in @actions_len) and then by
 181  * packet data.
 182  */
 183 struct odp_sflow_sample_header {
 184     uint32_t sample_pool;
 185     uint32_t actions_len;
 186 };
 187
 188 #define VPORT_TYPE_SIZE     16
 189 #define VPORT_CONFIG_SIZE     32
 190 struct odp_port {
 191     char devname[16];           /* IFNAMSIZ */
 192     char type[VPORT_TYPE_SIZE];
 193     uint16_t port;
 194     uint16_t reserved1;
 195     uint32_t reserved2;
 196     __aligned_u64 config[VPORT_CONFIG_SIZE / 8]; /* type-specific */
 197 };
 198
 199 struct odp_portvec {
 200     struct odp_port *ports;
 201     uint32_t n_ports;
 202 };
 203
 204 struct odp_flow_stats {
 205     uint64_t n_packets;         /* Number of matched packets. */
 206     uint64_t n_bytes;           /* Number of matched bytes. */
 207     uint64_t used_sec;          /* Time last used, in system monotonic time. */
 208     uint32_t used_nsec;
 209     uint8_t  tcp_flags;
 210     uint8_t  reserved;
 211     uint16_t error;             /* Used by ODP_FLOW_GET. */
 212 };
 213
 214 /*
 215  * The datapath protocol adopts the Linux convention for TCI fields: if an
 216  * 802.1Q header is present then its TCI value is used verbatim except that the
 217  * CFI bit (0x1000) is always set to 1, and all-bits-zero indicates no 802.1Q
 218  * header.
 219  */
 220 #define ODP_TCI_PRESENT 0x1000  /* CFI bit */
 221
 222 struct odp_flow_key {
 223     ovs_be64 tun_id;            /* Encapsulating tunnel ID. */
 224     ovs_be32 nw_src;            /* IP source address. */
 225     ovs_be32 nw_dst;            /* IP destination address. */
 226     uint16_t in_port;           /* Input switch port. */
 227     ovs_be16 dl_tci;            /* All zeros if 802.1Q header absent,
 228                                   * ODP_TCI_PRESENT set if present. */
 229     ovs_be16 dl_type;           /* Ethernet frame type. */
 230     ovs_be16 tp_src;            /* TCP/UDP source port. */
 231     ovs_be16 tp_dst;            /* TCP/UDP destination port. */
 232     uint8_t  dl_src[6];         /* Ethernet source address. */
 233     uint8_t  dl_dst[6];         /* Ethernet destination address. */
 234     uint8_t  nw_proto;          /* IP protocol or lower 8 bits of
 235                                    ARP opcode. */
 236     uint8_t  nw_tos;            /* IP ToS (DSCP field, 6 bits). */
 237 };
 238
 239 /* Flags for ODP_FLOW. */
 240 #define ODPFF_ZERO_TCP_FLAGS (1 << 0) /* Zero the TCP flags. */
 241
 242 struct odp_flow {
 243     struct odp_flow_stats stats;
 244     struct odp_flow_key key;
 245     struct nlattr *actions;
 246     uint32_t actions_len;
 247     uint32_t flags;
 248 };
 249
 250 /* Flags for ODP_FLOW_PUT. */
 251 #define ODPPF_CREATE        (1 << 0) /* Allow creating a new flow. */
 252 #define ODPPF_MODIFY        (1 << 1) /* Allow modifying an existing flow. */
 253 #define ODPPF_ZERO_STATS    (1 << 2) /* Zero the stats of an existing flow. */
 254
 255 /* ODP_FLOW_PUT argument. */
 256 struct odp_flow_put {
 257     struct odp_flow flow;
 258     uint32_t flags;
 259 };
 260
 261 struct odp_flowvec {
 262     struct odp_flow *flows;
 263     uint32_t n_flows;
 264 };
 265
 266 /* Action types. */
 267 enum odp_action_type {
 268     ODPAT_UNSPEC,
 269     ODPAT_OUTPUT,               /* Output to switch port. */
 270     ODPAT_CONTROLLER,           /* Send copy to controller. */
 271     ODPAT_SET_DL_TCI,           /* Set the 802.1q TCI value. */
 272     ODPAT_STRIP_VLAN,           /* Strip the 802.1q header. */
 273     ODPAT_SET_DL_SRC,           /* Ethernet source address. */
 274     ODPAT_SET_DL_DST,           /* Ethernet destination address. */
 275     ODPAT_SET_NW_SRC,           /* IP source address. */
 276     ODPAT_SET_NW_DST,           /* IP destination address. */
 277     ODPAT_SET_NW_TOS,           /* IP ToS/DSCP field (6 bits). */
 278     ODPAT_SET_TP_SRC,           /* TCP/UDP source port. */
 279     ODPAT_SET_TP_DST,           /* TCP/UDP destination port. */
 280     ODPAT_SET_TUNNEL,           /* Set the encapsulating tunnel ID. */
 281     ODPAT_SET_PRIORITY,         /* Set skb->priority. */
 282     ODPAT_POP_PRIORITY,         /* Restore original skb->priority. */
 283     ODPAT_DROP_SPOOFED_ARP,     /* Drop ARPs with spoofed source MAC. */
 284     __ODPAT_MAX
 285 };
 286
 287 #define ODPAT_MAX (__ODPAT_MAX - 1)
 288
 289 struct odp_execute {
 290     struct nlattr *actions;
 291     uint32_t actions_len;
 292
 293     const void *data;
 294     uint32_t length;
 295 };
 296
 297 #define VPORT_TYPE_SIZE     16
 298 struct odp_vport_add {
 299     char port_type[VPORT_TYPE_SIZE];
 300     char devname[16];           /* IFNAMSIZ */
 301     void *config;
 302 };
 303
 304 struct odp_vport_mod {
 305     char devname[16];           /* IFNAMSIZ */
 306     void *config;
 307 };
 308
 309 struct odp_vport_stats_req {
 310     char devname[16];           /* IFNAMSIZ */
 311     struct rtnl_link_stats64 stats;
 312 };
 313
 314 struct odp_vport_ether {
 315     char devname[16];           /* IFNAMSIZ */
 316     unsigned char ether_addr[6];
 317 };
 318
 319 struct odp_vport_mtu {
 320     char devname[16];           /* IFNAMSIZ */
 321     uint16_t mtu;
 322 };
 323
 324 /* Values below this cutoff are 802.3 packets and the two bytes
 325  * following MAC addresses are used as a frame length.  Otherwise, the
 326  * two bytes are used as the Ethernet type.
 327  */
 328 #define ODP_DL_TYPE_ETH2_CUTOFF   0x0600
 329
 330 /* Value of dl_type to indicate that the frame does not include an
 331  * Ethernet type.
 332  */
 333 #define ODP_DL_TYPE_NOT_ETH_TYPE  0x05ff
 334
 335 #endif  /* openvswitch/datapath-protocol.h */