include/openvswitch/datapath-protocol.h

   1 /*
   2  * Copyright (c) 2009, 2010, 2011 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_DP_NEW              _IOWR('O', 0, struct odp_datapath)
  74 #define ODP_DP_DEL              _IOR('O', 1, struct odp_datapath)
  75 #define ODP_DP_GET              _IOWR('O', 2, struct odp_datapath)
  76 #define ODP_DP_SET              _IOWR('O', 3, struct odp_datapath)
  77 #define ODP_DP_DUMP             _IOWR('O', 4, struct odp_datapath)
  78
  79 #define ODP_VPORT_NEW           _IOR('O', 7, struct odp_vport)
  80 #define ODP_VPORT_DEL           _IOR('O', 8, struct odp_vport)
  81 #define ODP_VPORT_GET           _IOWR('O', 9, struct odp_vport)
  82 #define ODP_VPORT_SET           _IOR('O', 22, struct odp_vport)
  83 #define ODP_VPORT_DUMP          _IOWR('O', 10, struct odp_vport)
  84
  85 #define ODP_FLOW_NEW            _IOWR('O', 13, struct odp_flow)
  86 #define ODP_FLOW_DEL            _IOWR('O', 14, struct odp_flow)
  87 #define ODP_FLOW_GET            _IOWR('O', 15, struct odp_flow)
  88 #define ODP_FLOW_SET            _IOWR('O', 16, struct odp_flow)
  89 #define ODP_FLOW_DUMP           _IOWR('O', 17, struct odp_flow)
  90 #define ODP_FLOW_FLUSH          _IO('O', 19)
  91
  92 /**
  93  * struct odp_header - header for ODP Generic Netlink messages.
  94  * @dp_idx: Number of datapath to which the packet belongs.
  95  *
  96  * Attributes following the header are specific to a particular ODP Generic
  97  * Netlink family, but all of the ODP families use this header.
  98  */
  99 struct odp_header {
 100         uint32_t dp_idx;
 101 };
 102 \f
 103 /**
 104  * struct odp_datapath - header with basic information about a datapath.
 105  * @dp_idx: Datapath index (-1 to make a request not specific to a datapath).
 106  * @len: Length of this structure plus the Netlink attributes following it.
 107  * @total_len: Total space available for kernel reply to request.
 108  *
 109  * Followed by &struct nlattr attributes, whose types are drawn from
 110  * %ODP_DP_ATTR_*, up to a length of @len bytes including the &struct
 111  * odp_datapath header.
 112  */
 113 struct odp_datapath {
 114         int32_t dp_idx;
 115         uint32_t len;
 116         uint32_t total_len;
 117 };
 118
 119 enum odp_datapath_type {
 120         ODP_DP_ATTR_UNSPEC,
 121         ODP_DP_ATTR_NAME,       /* name of dp_ifidx netdev */
 122         ODP_DP_ATTR_STATS,      /* struct odp_stats */
 123         ODP_DP_ATTR_IPV4_FRAGS, /* 32-bit enum odp_frag_handling */
 124         ODP_DP_ATTR_SAMPLING,   /* 32-bit fraction of packets to sample. */
 125         ODP_DP_ATTR_MCGROUPS,   /* Nested attributes with multicast groups. */
 126         __ODP_DP_ATTR_MAX
 127 };
 128
 129 #define ODP_DP_ATTR_MAX (__ODP_DP_ATTR_MAX - 1)
 130
 131 /* Values for ODP_DP_ATTR_IPV4_FRAGS. */
 132 enum odp_frag_handling {
 133         ODP_DP_FRAG_UNSPEC,
 134         ODP_DP_FRAG_ZERO,       /* Treat IP fragments as transport port 0. */
 135         ODP_DP_FRAG_DROP        /* Drop IP fragments. */
 136 };
 137
 138 struct odp_stats {
 139     uint64_t n_frags;           /* Number of dropped IP fragments. */
 140     uint64_t n_hit;             /* Number of flow table matches. */
 141     uint64_t n_missed;          /* Number of flow table misses. */
 142     uint64_t n_lost;            /* Number of misses not sent to userspace. */
 143 };
 144
 145 /* Logical ports. */
 146 #define ODPP_LOCAL      ((uint16_t)0)
 147 \f
 148 #define ODP_PACKET_FAMILY "odp_packet"
 149
 150 enum odp_packet_cmd {
 151         ODP_PACKET_CMD_UNSPEC,
 152
 153         /* Kernel-to-user notifications. */
 154         ODP_PACKET_CMD_MISS,    /* Flow table miss. */
 155         ODP_PACKET_CMD_ACTION,  /* ODPAT_CONTROLLER action. */
 156         ODP_PACKET_CMD_SAMPLE,  /* Sampled packet. */
 157
 158         /* User commands. */
 159         ODP_PACKET_CMD_EXECUTE  /* Apply actions to a packet. */
 160 };
 161
 162 /**
 163  * enum odp_packet_attr - attributes for %ODP_PACKET_* commands.
 164  * @ODP_PACKET_ATTR_PACKET: Present for all notifications.  Contains the entire
 165  * packet as received, from the start of the Ethernet header onward.  For
 166  * %ODP_PACKET_CMD_ACTION, %ODP_PACKET_ATTR_PACKET reflects changes made by
 167  * actions preceding %ODPAT_CONTROLLER, but %ODP_PACKET_ATTR_KEY is the flow
 168  * key extracted from the packet as originally received.
 169  * @ODP_PACKET_ATTR_KEY: Present for all notifications.  Contains the flow key
 170  * extracted from the packet as nested %ODP_KEY_ATTR_* attributes.  This allows
 171  * userspace to adapt its flow setup strategy by comparing its notion of the
 172  * flow key against the kernel's.
 173  * @ODP_PACKET_ATTR_USERDATA: Present for an %ODP_PACKET_CMD_ACTION
 174  * notification if the %ODPAT_CONTROLLER action's argument was nonzero.
 175  * @ODP_PACKET_ATTR_SAMPLE_POOL: Present for %ODP_PACKET_CMD_SAMPLE.  Contains
 176  * the number of packets processed so far that were candidates for sampling.
 177  * @ODP_PACKET_ATTR_ACTIONS: Present for %ODP_PACKET_CMD_SAMPLE.  Contains a
 178  * copy of the actions applied to the packet, as nested %ODPAT_* attributes.
 179  *
 180  * These attributes follow the &struct odp_header within the Generic Netlink
 181  * payload for %ODP_PACKET_* commands.
 182  *
 183  * The %ODP_PACKET_ATTR_TYPE, %ODP_PACKET_ATTR_PACKET and %ODP_PACKET_ATTR_KEY
 184  * attributes are present for all notifications.  For %ODP_PACKET_CMD_ACTION,
 185  * the %ODP_PACKET_ATTR_USERDATA attribute is included if it would be nonzero.
 186  * For %ODP_PACKET_CMD_SAMPLE, the %ODP_PACKET_ATTR_SAMPLE_POOL and
 187  * %ODP_PACKET_ATTR_ACTIONS attributes are included.
 188  */
 189 enum odp_packet_attr {
 190         ODP_PACKET_ATTR_UNSPEC,
 191         ODP_PACKET_ATTR_PACKET,      /* Packet data. */
 192         ODP_PACKET_ATTR_KEY,         /* Nested ODP_KEY_ATTR_* attributes. */
 193         ODP_PACKET_ATTR_USERDATA,    /* 64-bit data from ODPAT_CONTROLLER. */
 194         ODP_PACKET_ATTR_SAMPLE_POOL, /* # sampling candidate packets so far. */
 195         ODP_PACKET_ATTR_ACTIONS,     /* Nested ODPAT_* attributes. */
 196         __ODP_PACKET_ATTR_MAX
 197 };
 198
 199 #define ODP_PACKET_ATTR_MAX (__ODP_PACKET_ATTR_MAX - 1)
 200 \f
 201 enum odp_vport_type {
 202         ODP_VPORT_TYPE_UNSPEC,
 203         ODP_VPORT_TYPE_NETDEV,   /* network device */
 204         ODP_VPORT_TYPE_INTERNAL, /* network device implemented by datapath */
 205         ODP_VPORT_TYPE_PATCH,    /* virtual tunnel connecting two vports */
 206         ODP_VPORT_TYPE_GRE,      /* GRE tunnel */
 207         ODP_VPORT_TYPE_CAPWAP,   /* CAPWAP tunnel */
 208         __ODP_VPORT_TYPE_MAX
 209 };
 210
 211 #define ODP_VPORT_TYPE_MAX (__ODP_VPORT_TYPE_MAX - 1)
 212
 213 /**
 214  * struct odp_vport - header with basic information about a virtual port.
 215  * @dp_idx: Number of datapath to which the vport belongs.
 216  * @len: Length of this structure plus the Netlink attributes following it.
 217  * @total_len: Total space available for kernel reply to request.
 218  *
 219  * Followed by &struct nlattr attributes, whose types are drawn from
 220  * %ODP_VPORT_ATTR_*, up to a length of @len bytes including the &struct
 221  * odp_vport header.
 222  */
 223 struct odp_vport {
 224         uint32_t dp_idx;
 225         uint32_t len;
 226         uint32_t total_len;
 227 };
 228
 229 enum {
 230         ODP_VPORT_ATTR_UNSPEC,
 231         ODP_VPORT_ATTR_PORT_NO, /* port number within datapath */
 232         ODP_VPORT_ATTR_TYPE,    /* 32-bit ODP_VPORT_TYPE_* constant. */
 233         ODP_VPORT_ATTR_NAME,    /* string name, up to IFNAMSIZ bytes long */
 234         ODP_VPORT_ATTR_STATS,   /* struct rtnl_link_stats64 */
 235         ODP_VPORT_ATTR_ADDRESS, /* hardware address */
 236         ODP_VPORT_ATTR_MTU,     /* 32-bit maximum transmission unit */
 237         ODP_VPORT_ATTR_OPTIONS, /* nested attributes, varies by vport type */
 238         ODP_VPORT_ATTR_IFINDEX, /* 32-bit ifindex of backing netdev */
 239         ODP_VPORT_ATTR_IFLINK,  /* 32-bit ifindex on which packets are sent */
 240         __ODP_VPORT_ATTR_MAX
 241 };
 242
 243 #define ODP_VPORT_ATTR_MAX (__ODP_VPORT_ATTR_MAX - 1)
 244
 245 /* ODP_VPORT_ATTR_OPTIONS attributes for patch vports. */
 246 enum {
 247         ODP_PATCH_ATTR_UNSPEC,
 248         ODP_PATCH_ATTR_PEER,    /* name of peer vport, as a string */
 249         __ODP_PATCH_ATTR_MAX
 250 };
 251
 252 #define ODP_PATCH_ATTR_MAX (__ODP_PATCH_ATTR_MAX - 1)
 253
 254 struct odp_flow_stats {
 255     uint64_t n_packets;         /* Number of matched packets. */
 256     uint64_t n_bytes;           /* Number of matched bytes. */
 257 };
 258
 259 enum odp_key_type {
 260         ODP_KEY_ATTR_UNSPEC,
 261         ODP_KEY_ATTR_TUN_ID,    /* 64-bit tunnel ID */
 262         ODP_KEY_ATTR_IN_PORT,   /* 32-bit ODP port number */
 263         ODP_KEY_ATTR_ETHERNET,  /* struct odp_key_ethernet */
 264         ODP_KEY_ATTR_8021Q,     /* struct odp_key_8021q */
 265         ODP_KEY_ATTR_ETHERTYPE, /* 16-bit Ethernet type */
 266         ODP_KEY_ATTR_IPV4,      /* struct odp_key_ipv4 */
 267         ODP_KEY_ATTR_TCP,       /* struct odp_key_tcp */
 268         ODP_KEY_ATTR_UDP,       /* struct odp_key_udp */
 269         ODP_KEY_ATTR_ICMP,      /* struct odp_key_icmp */
 270         ODP_KEY_ATTR_ARP,       /* struct odp_key_arp */
 271         __ODP_KEY_ATTR_MAX
 272 };
 273
 274 #define ODP_KEY_ATTR_MAX (__ODP_KEY_ATTR_MAX - 1)
 275
 276 struct odp_key_ethernet {
 277         uint8_t  eth_src[6];
 278         uint8_t  eth_dst[6];
 279 };
 280
 281 struct odp_key_8021q {
 282         ovs_be16 q_tpid;
 283         ovs_be16 q_tci;
 284 };
 285
 286 struct odp_key_ipv4 {
 287         ovs_be32 ipv4_src;
 288         ovs_be32 ipv4_dst;
 289         uint8_t  ipv4_proto;
 290         uint8_t  ipv4_tos;
 291 };
 292
 293 struct odp_key_tcp {
 294         ovs_be16 tcp_src;
 295         ovs_be16 tcp_dst;
 296 };
 297
 298 struct odp_key_udp {
 299         ovs_be16 udp_src;
 300         ovs_be16 udp_dst;
 301 };
 302
 303 struct odp_key_icmp {
 304         uint8_t icmp_type;
 305         uint8_t icmp_code;
 306 };
 307
 308 struct odp_key_arp {
 309         ovs_be32 arp_sip;
 310         ovs_be32 arp_tip;
 311         ovs_be16 arp_op;
 312 };
 313
 314 /**
 315  * struct odp_flow - header with basic information about a flow.
 316  * @dp_idx: Datapath index.
 317  * @len: Length of this structure plus the Netlink attributes following it.
 318  * @total_len: Total space available for kernel reply to request.
 319  *
 320  * Followed by &struct nlattr attributes, whose types are drawn from
 321  * %ODP_FLOW_ATTR_*, up to a length of @len bytes including the &struct
 322  * odp_flow header.
 323  */
 324 struct odp_flow {
 325         uint32_t nlmsg_flags;
 326         uint32_t dp_idx;
 327         uint32_t len;
 328         uint32_t total_len;
 329 };
 330
 331 enum odp_flow_type {
 332         ODP_FLOW_ATTR_UNSPEC,
 333         ODP_FLOW_ATTR_KEY,       /* Sequence of ODP_KEY_ATTR_* attributes. */
 334         ODP_FLOW_ATTR_ACTIONS,   /* Sequence of nested ODPAT_* attributes. */
 335         ODP_FLOW_ATTR_STATS,     /* struct odp_flow_stats. */
 336         ODP_FLOW_ATTR_TCP_FLAGS, /* 8-bit OR'd TCP flags. */
 337         ODP_FLOW_ATTR_USED,      /* u64 msecs last used in monotonic time. */
 338         ODP_FLOW_ATTR_CLEAR,     /* Flag to clear stats, tcp_flags, used. */
 339         ODP_FLOW_ATTR_STATE,     /* u64 state for ODP_FLOW_DUMP. */
 340         __ODP_FLOW_ATTR_MAX
 341 };
 342
 343 #define ODP_FLOW_ATTR_MAX (__ODP_FLOW_ATTR_MAX - 1)
 344
 345 /* Action types. */
 346 enum odp_action_type {
 347     ODPAT_UNSPEC,
 348     ODPAT_OUTPUT,               /* Output to switch port. */
 349     ODPAT_CONTROLLER,           /* Send copy to controller. */
 350     ODPAT_SET_DL_TCI,           /* Set the 802.1q TCI value. */
 351     ODPAT_STRIP_VLAN,           /* Strip the 802.1q header. */
 352     ODPAT_SET_DL_SRC,           /* Ethernet source address. */
 353     ODPAT_SET_DL_DST,           /* Ethernet destination address. */
 354     ODPAT_SET_NW_SRC,           /* IPv4 source address. */
 355     ODPAT_SET_NW_DST,           /* IPv4 destination address. */
 356     ODPAT_SET_NW_TOS,           /* IP ToS/DSCP field (6 bits). */
 357     ODPAT_SET_TP_SRC,           /* TCP/UDP source port. */
 358     ODPAT_SET_TP_DST,           /* TCP/UDP destination port. */
 359     ODPAT_SET_TUNNEL,           /* Set the encapsulating tunnel ID. */
 360     ODPAT_SET_PRIORITY,         /* Set skb->priority. */
 361     ODPAT_POP_PRIORITY,         /* Restore original skb->priority. */
 362     ODPAT_DROP_SPOOFED_ARP,     /* Drop ARPs with spoofed source MAC. */
 363     __ODPAT_MAX
 364 };
 365
 366 #define ODPAT_MAX (__ODPAT_MAX - 1)
 367
 368 #endif  /* openvswitch/datapath-protocol.h */