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_PORT_GROUP_SET      _IOR('O', 11, struct odp_port_group)
  83 #define ODP_PORT_GROUP_GET      _IOWR('O', 12, struct odp_port_group)
  84
  85 #define ODP_FLOW_GET            _IOWR('O', 13, struct odp_flow)
  86 #define ODP_FLOW_PUT            _IOWR('O', 14, struct odp_flow)
  87 #define ODP_FLOW_LIST           _IOWR('O', 15, struct odp_flowvec)
  88 #define ODP_FLOW_FLUSH          _IO('O', 16)
  89 #define ODP_FLOW_DEL            _IOWR('O', 17, struct odp_flow)
  90
  91 #define ODP_EXECUTE             _IOR('O', 18, struct odp_execute)
  92
  93 #define ODP_SET_SFLOW_PROBABILITY _IOR('O', 19, int)
  94 #define ODP_GET_SFLOW_PROBABILITY _IOW('O', 20, int)
  95
  96 #define ODP_VPORT_ADD           _IOR('O', 21, struct odp_vport_add)
  97 #define ODP_VPORT_MOD           _IOR('O', 22, struct odp_vport_mod)
  98 #define ODP_VPORT_DEL           _IO('O', 23)
  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     uint16_t max_groups;        /* Maximum number of port groups. */
 116     uint16_t reserved;
 117
 118     /* Lookups. */
 119     uint64_t n_frags;           /* Number of dropped IP fragments. */
 120     uint64_t n_hit;             /* Number of flow table matches. */
 121     uint64_t n_missed;          /* Number of flow table misses. */
 122     uint64_t n_lost;            /* Number of misses not sent to userspace. */
 123
 124     /* Queues. */
 125     uint16_t max_miss_queue;    /* Max length of ODPL_MISS queue. */
 126     uint16_t max_action_queue;  /* Max length of ODPL_ACTION queue. */
 127     uint16_t max_sflow_queue;   /* Max length of ODPL_SFLOW queue. */
 128 };
 129
 130 /* Logical ports. */
 131 #define ODPP_LOCAL      ((uint16_t)0)
 132 #define ODPP_NONE       ((uint16_t)-1)
 133 #define ODPP_NORMAL     ((uint16_t)-2)
 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  * @type: One of the %_ODPL_* constants.
 147  * @length: Total length of message, including this header.
 148  * @port: Port that received the packet embedded in this message.
 149  * @reserved: Not currently used.  Should be set to 0.
 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 &struct odp_action_controller that caused
 158  * the &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 an array of &union odp_action (the number
 162  * of which is specified in &struct odp_sflow_sample_header), then by packet
 163  * data.
 164  */
 165 struct odp_msg {
 166     uint32_t type;
 167     uint32_t length;
 168     uint16_t port;
 169     uint16_t reserved;
 170     uint32_t arg;
 171 };
 172
 173 /**
 174  * struct odp_sflow_sample_header - header added to sFlow sampled packet.
 175  * @sample_pool: Number of packets that were candidates for sFlow sampling,
 176  * regardless of whether they were actually chosen and sent down to userspace.
 177  * @n_actions: Number of "union odp_action"s immediately following this header.
 178  *
 179  * This header follows &struct odp_msg when that structure's @type is
 180  * %_ODPL_SFLOW_NR, and it is itself followed by an array of &union odp_action
 181  * (the number of which is specified in @n_actions) and then by packet data.
 182  */
 183 struct odp_sflow_sample_header {
 184     uint32_t sample_pool;
 185     uint32_t n_actions;
 186 };
 187
 188 #define ODP_PORT_INTERNAL (1 << 0) /* This port is simulated. */
 189 struct odp_port {
 190     char devname[16];           /* IFNAMSIZ */
 191     uint16_t port;
 192     uint16_t flags;
 193     uint32_t reserved2;
 194 };
 195
 196 struct odp_portvec {
 197     struct odp_port *ports;
 198     uint32_t n_ports;
 199 };
 200
 201 struct odp_port_group {
 202     uint16_t *ports;
 203     uint16_t n_ports;           /* Number of ports. */
 204     uint16_t group;             /* Group number. */
 205 };
 206
 207 struct odp_flow_stats {
 208     uint64_t n_packets;         /* Number of matched packets. */
 209     uint64_t n_bytes;           /* Number of matched bytes. */
 210     uint64_t used_sec;          /* Time last used, in system monotonic time. */
 211     uint32_t used_nsec;
 212     uint8_t  tcp_flags;
 213     uint8_t  reserved;
 214     uint16_t error;             /* Used by ODP_FLOW_GET. */
 215 };
 216
 217 struct odp_flow_key {
 218     ovs_be32 tun_id;            /* Encapsulating tunnel ID. */
 219     ovs_be32 nw_src;            /* IP source address. */
 220     ovs_be32 nw_dst;            /* IP destination address. */
 221     uint16_t in_port;           /* Input switch port. */
 222     ovs_be16 dl_vlan;           /* Input VLAN. */
 223     ovs_be16 dl_type;           /* Ethernet frame type. */
 224     ovs_be16 tp_src;            /* TCP/UDP source port. */
 225     ovs_be16 tp_dst;            /* TCP/UDP destination port. */
 226     uint8_t  dl_src[6];         /* Ethernet source address. */
 227     uint8_t  dl_dst[6];         /* Ethernet destination address. */
 228     uint8_t  nw_proto;          /* IP protocol or lower 8 bits of
 229                                    ARP opcode. */
 230     uint8_t  dl_vlan_pcp;       /* Input VLAN priority. */
 231     uint8_t  nw_tos;            /* IP ToS (DSCP field, 6 bits). */
 232     uint8_t  reserved[3];       /* Align to 32-bits...must be zeroed. */
 233 };
 234
 235 /* Flags for ODP_FLOW. */
 236 #define ODPFF_ZERO_TCP_FLAGS (1 << 0) /* Zero the TCP flags. */
 237
 238 struct odp_flow {
 239     struct odp_flow_stats stats;
 240     struct odp_flow_key key;
 241     union odp_action *actions;
 242     uint32_t n_actions;
 243     uint32_t flags;
 244 };
 245
 246 /* Flags for ODP_FLOW_PUT. */
 247 #define ODPPF_CREATE        (1 << 0) /* Allow creating a new flow. */
 248 #define ODPPF_MODIFY        (1 << 1) /* Allow modifying an existing flow. */
 249 #define ODPPF_ZERO_STATS    (1 << 2) /* Zero the stats of an existing flow. */
 250
 251 /* ODP_FLOW_PUT argument. */
 252 struct odp_flow_put {
 253     struct odp_flow flow;
 254     uint32_t flags;
 255 };
 256
 257 struct odp_flowvec {
 258     struct odp_flow *flows;
 259     uint32_t n_flows;
 260 };
 261
 262 /* The VLAN id is 12 bits, so we can use the entire 16 bits to indicate
 263  * special conditions.  All ones is used to match that no VLAN id was
 264  * set. */
 265 #define ODP_VLAN_NONE      0xffff
 266
 267 /* Action types. */
 268 #define ODPAT_OUTPUT            0    /* Output to switch port. */
 269 #define ODPAT_OUTPUT_GROUP      1    /* Output to all ports in group. */
 270 #define ODPAT_CONTROLLER        2    /* Send copy to controller. */
 271 #define ODPAT_SET_VLAN_VID      3    /* Set the 802.1q VLAN id. */
 272 #define ODPAT_SET_VLAN_PCP      4    /* Set the 802.1q priority. */
 273 #define ODPAT_STRIP_VLAN        5    /* Strip the 802.1q header. */
 274 #define ODPAT_SET_DL_SRC        6    /* Ethernet source address. */
 275 #define ODPAT_SET_DL_DST        7    /* Ethernet destination address. */
 276 #define ODPAT_SET_NW_SRC        8    /* IP source address. */
 277 #define ODPAT_SET_NW_DST        9    /* IP destination address. */
 278 #define ODPAT_SET_NW_TOS        10   /* IP ToS/DSCP field (6 bits). */
 279 #define ODPAT_SET_TP_SRC        11   /* TCP/UDP source port. */
 280 #define ODPAT_SET_TP_DST        12   /* TCP/UDP destination port. */
 281 #define ODPAT_SET_TUNNEL        13   /* Set the encapsulating tunnel ID. */
 282 #define ODPAT_SET_PRIORITY      14   /* Set skb->priority. */
 283 #define ODPAT_POP_PRIORITY      15   /* Restore original skb->priority. */
 284 #define ODPAT_N_ACTIONS         16
 285
 286 struct odp_action_output {
 287     uint16_t type;              /* ODPAT_OUTPUT. */
 288     uint16_t port;              /* Output port. */
 289     uint16_t reserved1;
 290     uint16_t reserved2;
 291 };
 292
 293 struct odp_action_output_group {
 294     uint16_t type;              /* ODPAT_OUTPUT_GROUP. */
 295     uint16_t group;             /* Group number. */
 296     uint16_t reserved1;
 297     uint16_t reserved2;
 298 };
 299
 300 struct odp_action_controller {
 301     uint16_t type;              /* ODPAT_OUTPUT_CONTROLLER. */
 302     uint16_t reserved;
 303     uint32_t arg;               /* Copied to struct odp_msg 'arg' member. */
 304 };
 305
 306 struct odp_action_tunnel {
 307     uint16_t type;              /* ODPAT_SET_TUNNEL. */
 308     uint16_t reserved;
 309     ovs_be32 tun_id;            /* Tunnel ID. */
 310 };
 311
 312 /* Action structure for ODPAT_SET_VLAN_VID. */
 313 struct odp_action_vlan_vid {
 314     uint16_t type;              /* ODPAT_SET_VLAN_VID. */
 315     ovs_be16 vlan_vid;          /* VLAN id. */
 316     uint16_t reserved1;
 317     uint16_t reserved2;
 318 };
 319
 320 /* Action structure for ODPAT_SET_VLAN_PCP. */
 321 struct odp_action_vlan_pcp {
 322     uint16_t type;              /* ODPAT_SET_VLAN_PCP. */
 323     uint8_t vlan_pcp;           /* VLAN priority. */
 324     uint8_t reserved1;
 325     uint16_t reserved2;
 326     uint16_t reserved3;
 327 };
 328
 329 /* Action structure for ODPAT_SET_DL_SRC/DST. */
 330 struct odp_action_dl_addr {
 331     uint16_t type;              /* ODPAT_SET_DL_SRC/DST. */
 332     uint8_t dl_addr[6];         /* Ethernet address. */
 333 };
 334
 335 /* Action structure for ODPAT_SET_NW_SRC/DST. */
 336 struct odp_action_nw_addr {
 337     uint16_t type;              /* ODPAT_SET_TW_SRC/DST. */
 338     uint16_t reserved;
 339     ovs_be32 nw_addr;           /* IP address. */
 340 };
 341
 342 struct odp_action_nw_tos {
 343     uint16_t type;              /* ODPAT_SET_NW_TOS. */
 344     uint8_t nw_tos;             /* IP ToS/DSCP field (6 bits). */
 345     uint8_t reserved1;
 346     uint16_t reserved2;
 347     uint16_t reserved3;
 348 };
 349
 350 /* Action structure for ODPAT_SET_TP_SRC/DST. */
 351 struct odp_action_tp_port {
 352     uint16_t type;              /* ODPAT_SET_TP_SRC/DST. */
 353     ovs_be16 tp_port;           /* TCP/UDP port. */
 354     uint16_t reserved1;
 355     uint16_t reserved2;
 356 };
 357
 358 /* Action structure for ODPAT_SET_PRIORITY. */
 359 struct odp_action_priority {
 360     uint16_t type;              /* ODPAT_SET_PRIORITY. */
 361     uint16_t reserved;
 362     uint32_t priority;          /* skb->priority value. */
 363 };
 364
 365 union odp_action {
 366     uint16_t type;
 367     struct odp_action_output output;
 368     struct odp_action_output_group output_group;
 369     struct odp_action_controller controller;
 370     struct odp_action_tunnel tunnel;
 371     struct odp_action_vlan_vid vlan_vid;
 372     struct odp_action_vlan_pcp vlan_pcp;
 373     struct odp_action_dl_addr dl_addr;
 374     struct odp_action_nw_addr nw_addr;
 375     struct odp_action_nw_tos nw_tos;
 376     struct odp_action_tp_port tp_port;
 377     struct odp_action_priority priority;
 378 };
 379
 380 struct odp_execute {
 381     uint16_t in_port;
 382     uint16_t reserved1;
 383     uint32_t reserved2;
 384
 385     union odp_action *actions;
 386     uint32_t n_actions;
 387
 388     const void *data;
 389     uint32_t length;
 390 };
 391
 392 #define VPORT_TYPE_SIZE     16
 393 struct odp_vport_add {
 394     char port_type[VPORT_TYPE_SIZE];
 395     char devname[16];           /* IFNAMSIZ */
 396     void *config;
 397 };
 398
 399 struct odp_vport_mod {
 400     char devname[16];           /* IFNAMSIZ */
 401     void *config;
 402 };
 403
 404 struct odp_vport_stats {
 405     uint64_t rx_packets;
 406     uint64_t tx_packets;
 407     uint64_t rx_bytes;
 408     uint64_t tx_bytes;
 409     uint64_t rx_dropped;
 410     uint64_t tx_dropped;
 411     uint64_t rx_errors;
 412     uint64_t tx_errors;
 413     uint64_t rx_frame_err;
 414     uint64_t rx_over_err;
 415     uint64_t rx_crc_err;
 416     uint64_t collisions;
 417 };
 418
 419 struct odp_vport_stats_req {
 420     char devname[16];           /* IFNAMSIZ */
 421     struct odp_vport_stats stats;
 422 };
 423
 424 struct odp_vport_ether {
 425     char devname[16];           /* IFNAMSIZ */
 426     unsigned char ether_addr[6];
 427 };
 428
 429 struct odp_vport_mtu {
 430     char devname[16];           /* IFNAMSIZ */
 431     uint16_t mtu;
 432 };
 433
 434 /* Values below this cutoff are 802.3 packets and the two bytes
 435  * following MAC addresses are used as a frame length.  Otherwise, the
 436  * two bytes are used as the Ethernet type.
 437  */
 438 #define ODP_DL_TYPE_ETH2_CUTOFF   0x0600
 439
 440 /* Value of dl_type to indicate that the frame does not include an
 441  * Ethernet type.
 442  */
 443 #define ODP_DL_TYPE_NOT_ETH_TYPE  0x05ff
 444
 445 /* The VLAN id is 12-bits, so we can use the entire 16 bits to indicate
 446  * special conditions.  All ones indicates that no VLAN id was set.
 447  */
 448 #define ODP_VLAN_NONE      0xffff
 449
 450 #endif  /* openvswitch/datapath-protocol.h */