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