include/openvswitch/datapath-protocol.h

   1 /*
   2  * Copyright (c) 2009 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 #ifndef OPENVSWITCH_DATAPATH_PROTOCOL_H
  43 #define OPENVSWITCH_DATAPATH_PROTOCOL_H 1
  44
  45 #ifdef __KERNEL__
  46 #include <linux/types.h>
  47 #else
  48 #include <sys/types.h>
  49 #endif
  50 #include <linux/if_ether.h>
  51
  52 #define ODP_MAX 256             /* Maximum number of datapaths. */
  53
  54 #define ODP_DP_CREATE           _IO('O', 0)
  55 #define ODP_DP_DESTROY          _IO('O', 1)
  56 #define ODP_DP_STATS            _IOW('O', 2, struct odp_stats)
  57
  58 #define ODP_GET_DROP_FRAGS      _IOW('O', 3, int)
  59 #define ODP_SET_DROP_FRAGS      _IOR('O', 4, int)
  60
  61 #define ODP_GET_LISTEN_MASK     _IOW('O', 5, int)
  62 #define ODP_SET_LISTEN_MASK     _IOR('O', 6, int)
  63
  64 #define ODP_PORT_ADD            _IOR('O', 7, struct odp_port)
  65 #define ODP_PORT_DEL            _IOR('O', 8, int)
  66 #define ODP_PORT_QUERY          _IOWR('O', 9, struct odp_port)
  67 #define ODP_PORT_LIST           _IOWR('O', 10, struct odp_portvec)
  68
  69 #define ODP_PORT_GROUP_SET      _IOR('O', 11, struct odp_port_group)
  70 #define ODP_PORT_GROUP_GET      _IOWR('O', 12, struct odp_port_group)
  71
  72 #define ODP_FLOW_GET            _IOWR('O', 13, struct odp_flow)
  73 #define ODP_FLOW_PUT            _IOWR('O', 14, struct odp_flow)
  74 #define ODP_FLOW_LIST           _IOWR('O', 15, struct odp_flowvec)
  75 #define ODP_FLOW_FLUSH          _IO('O', 16)
  76 #define ODP_FLOW_DEL            _IOWR('O', 17, struct odp_flow)
  77
  78 #define ODP_EXECUTE             _IOR('O', 18, struct odp_execute)
  79
  80 #define ODP_SET_SFLOW_PROBABILITY _IOR('O', 20, int)
  81 #define ODP_GET_SFLOW_PROBABILITY _IOW('O', 21, int)
  82
  83 struct odp_stats {
  84     /* Flows. */
  85     __u32 n_flows;              /* Number of flows in flow table. */
  86     __u32 cur_capacity;         /* Current flow table capacity. */
  87     __u32 max_capacity;         /* Maximum expansion of flow table capacity. */
  88
  89     /* Ports. */
  90     __u32 n_ports;              /* Current number of ports. */
  91     __u32 max_ports;            /* Maximum supported number of ports. */
  92     __u16 max_groups;           /* Maximum number of port groups. */
  93     __u16 reserved;
  94
  95     /* Lookups. */
  96     __u64 n_frags;               /* Number of dropped IP fragments. */
  97     __u64 n_hit;                 /* Number of flow table matches. */
  98     __u64 n_missed;              /* Number of flow table misses. */
  99     __u64 n_lost;                /* Number of misses not sent to userspace. */
 100
 101     /* Queues. */
 102     __u16 max_miss_queue;       /* Max length of ODPL_MISS queue. */
 103     __u16 max_action_queue;     /* Max length of ODPL_ACTION queue. */
 104     __u16 max_sflow_queue;      /* Max length of ODPL_SFLOW queue. */
 105 };
 106
 107 /* Logical ports. */
 108 #define ODPP_LOCAL      ((__u16)0)
 109 #define ODPP_NONE       ((__u16)-1)
 110
 111 /* Listening channels. */
 112 #define _ODPL_MISS_NR   0       /* Packet missed in flow table. */
 113 #define ODPL_MISS       (1 << _ODPL_MISS_NR)
 114 #define _ODPL_ACTION_NR 1       /* Packet output to ODPP_CONTROLLER. */
 115 #define ODPL_ACTION     (1 << _ODPL_ACTION_NR)
 116 #define _ODPL_SFLOW_NR  2       /* sFlow samples. */
 117 #define ODPL_SFLOW      (1 << _ODPL_SFLOW_NR)
 118 #define ODPL_ALL        (ODPL_MISS | ODPL_ACTION | ODPL_SFLOW)
 119
 120 /* Format of messages read from datapath fd. */
 121 struct odp_msg {
 122     __u32 type;                 /* _ODPL_MISS_NR or _ODPL_ACTION_NR. */
 123     __u32 length;               /* Message length, including header. */
 124     __u16 port;                 /* Port on which frame was received. */
 125     __u16 reserved;
 126     __u32 arg;                  /* Argument value specified in action. */
 127
 128     /*
 129      * Followed by:
 130      *
 131      * ODPL_MISS, ODPL_ACTION: packet data.
 132      *
 133      * ODPL_SFLOW: "struct odp_sflow_sample_header", followed by
 134      *   an array of "union odp_action"s, followed by packet data.
 135      */
 136 };
 137
 138 /* Header added to sFlow sampled packet. */
 139 struct odp_sflow_sample_header {
 140     __u64 sample_pool;          /* Number of potentially sampled packets. */
 141     __u32 n_actions;            /* Number of following "union odp_action"s. */
 142     __u32 reserved;             /* Pad up to 64-bit boundary. */
 143     /* Followed by n_action "union odp_action"s. */
 144 };
 145
 146 #define ODP_PORT_INTERNAL (1 << 0) /* This port is simulated. */
 147 struct odp_port {
 148     char devname[16];           /* IFNAMSIZ */
 149     __u16 port;
 150     __u16 flags;
 151     __u32 reserved2;
 152 };
 153
 154 struct odp_portvec {
 155     struct odp_port *ports;
 156     int n_ports;
 157 };
 158
 159 struct odp_port_group {
 160     __u16 *ports;
 161     __u16 n_ports;                /* Number of ports. */
 162     __u16 group;                  /* Group number. */
 163 };
 164
 165 struct odp_flow_stats {
 166     __u64 n_packets;            /* Number of matched packets. */
 167     __u64 n_bytes;              /* Number of matched bytes. */
 168     __u64 used_sec;             /* Time last used. */
 169     __u32 used_nsec;
 170     __u8 tcp_flags;
 171     __u8 ip_tos;
 172     __u16 error;                /* Used by ODP_FLOW_GET. */
 173 };
 174
 175 struct odp_flow_key {
 176     __be32 nw_src;               /* IP source address. */
 177     __be32 nw_dst;               /* IP destination address. */
 178     __u16  in_port;              /* Input switch port. */
 179     __be16 dl_vlan;              /* Input VLAN. */
 180     __be16 dl_type;              /* Ethernet frame type. */
 181     __be16 tp_src;               /* TCP/UDP source port. */
 182     __be16 tp_dst;               /* TCP/UDP destination port. */
 183     __u8   dl_src[ETH_ALEN];     /* Ethernet source address. */
 184     __u8   dl_dst[ETH_ALEN];     /* Ethernet destination address. */
 185     __u8   nw_proto;             /* IP protocol or lower 8 bits of
 186                                     ARP opcode. */
 187     __u8   reserved;             /* Pad to 64 bits. */
 188 };
 189
 190 /* Flags for ODP_FLOW. */
 191 #define ODPFF_ZERO_TCP_FLAGS (1 << 0) /* Zero the TCP flags. */
 192
 193 struct odp_flow {
 194     struct odp_flow_stats stats;
 195     struct odp_flow_key key;
 196     union odp_action *actions;
 197     __u32 n_actions;
 198     __u32 flags;
 199 };
 200
 201 /* Flags for ODP_FLOW_PUT. */
 202 #define ODPPF_CREATE        (1 << 0) /* Allow creating a new flow. */
 203 #define ODPPF_MODIFY        (1 << 1) /* Allow modifying an existing flow. */
 204 #define ODPPF_ZERO_STATS    (1 << 2) /* Zero the stats of an existing flow. */
 205
 206 /* ODP_FLOW_PUT argument. */
 207 struct odp_flow_put {
 208     struct odp_flow flow;
 209     __u32 flags;
 210 };
 211
 212 struct odp_flowvec {
 213     struct odp_flow *flows;
 214     int n_flows;
 215 };
 216
 217 /* The VLAN id is 12 bits, so we can use the entire 16 bits to indicate
 218  * special conditions.  All ones is used to match that no VLAN id was
 219  * set. */
 220 #define ODP_VLAN_NONE      0xffff
 221
 222 /* Action types. */
 223 #define ODPAT_OUTPUT            0    /* Output to switch port. */
 224 #define ODPAT_OUTPUT_GROUP      1    /* Output to all ports in group. */
 225 #define ODPAT_CONTROLLER        2    /* Send copy to controller. */
 226 #define ODPAT_SET_VLAN_VID      3    /* Set the 802.1q VLAN id. */
 227 #define ODPAT_SET_VLAN_PCP      4    /* Set the 802.1q priority. */
 228 #define ODPAT_STRIP_VLAN        5    /* Strip the 802.1q header. */
 229 #define ODPAT_SET_DL_SRC        6    /* Ethernet source address. */
 230 #define ODPAT_SET_DL_DST        7    /* Ethernet destination address. */
 231 #define ODPAT_SET_NW_SRC        8    /* IP source address. */
 232 #define ODPAT_SET_NW_DST        9    /* IP destination address. */
 233 #define ODPAT_SET_TP_SRC        10   /* TCP/UDP source port. */
 234 #define ODPAT_SET_TP_DST        11   /* TCP/UDP destination port. */
 235 #define ODPAT_N_ACTIONS         12
 236
 237 struct odp_action_output {
 238     __u16 type;                  /* ODPAT_OUTPUT. */
 239     __u16 port;                  /* Output port. */
 240     __u16 reserved1;
 241     __u16 reserved2;
 242 };
 243
 244 struct odp_action_output_group {
 245     __u16 type;                 /* ODPAT_OUTPUT_GROUP. */
 246     __u16 group;                /* Group number. */
 247     __u16 reserved1;
 248     __u16 reserved2;
 249 };
 250
 251 struct odp_action_controller {
 252     __u16 type;                 /* ODPAT_OUTPUT_CONTROLLER. */
 253     __u16 reserved;
 254     __u32 arg;                  /* Copied to struct odp_msg 'arg' member. */
 255 };
 256
 257 /* Action structure for ODPAT_SET_VLAN_VID. */
 258 struct odp_action_vlan_vid {
 259     __u16 type;                  /* ODPAT_SET_VLAN_VID. */
 260     __be16 vlan_vid;             /* VLAN id. */
 261     __u16 reserved1;
 262     __u16 reserved2;
 263 };
 264
 265 /* Action structure for ODPAT_SET_VLAN_PCP. */
 266 struct odp_action_vlan_pcp {
 267     __u16 type;                  /* ODPAT_SET_VLAN_PCP. */
 268     __u8 vlan_pcp;               /* VLAN priority. */
 269     __u8 reserved1;
 270     __u16 reserved2;
 271     __u16 reserved3;
 272 };
 273
 274 /* Action structure for ODPAT_SET_DL_SRC/DST. */
 275 struct odp_action_dl_addr {
 276     __u16 type;                  /* ODPAT_SET_DL_SRC/DST. */
 277     __u8 dl_addr[ETH_ALEN];      /* Ethernet address. */
 278 };
 279
 280 /* Action structure for ODPAT_SET_NW_SRC/DST. */
 281 struct odp_action_nw_addr {
 282     __u16 type;                 /* ODPAT_SET_TW_SRC/DST. */
 283     __u16 reserved;
 284     __be32 nw_addr;             /* IP address. */
 285 };
 286
 287 /* Action structure for ODPAT_SET_TP_SRC/DST. */
 288 struct odp_action_tp_port {
 289     __u16 type;                  /* ODPAT_SET_TP_SRC/DST. */
 290     __be16 tp_port;              /* TCP/UDP port. */
 291     __u16 reserved1;
 292     __u16 reserved2;
 293 };
 294
 295 union odp_action {
 296     __u16 type;
 297     struct odp_action_output output;
 298     struct odp_action_output_group output_group;
 299     struct odp_action_controller controller;
 300     struct odp_action_vlan_vid vlan_vid;
 301     struct odp_action_vlan_pcp vlan_pcp;
 302     struct odp_action_dl_addr dl_addr;
 303     struct odp_action_nw_addr nw_addr;
 304     struct odp_action_tp_port tp_port;
 305 };
 306
 307 struct odp_execute {
 308     __u16 in_port;
 309     __u16 reserved1;
 310     __u32 reserved2;
 311
 312     union odp_action *actions;
 313     __u32 n_actions;
 314
 315     const void *data;
 316     __u32 length;
 317 };
 318
 319 /* Values below this cutoff are 802.3 packets and the two bytes
 320  * following MAC addresses are used as a frame length.  Otherwise, the
 321  * two bytes are used as the Ethernet type.
 322  */
 323 #define ODP_DL_TYPE_ETH2_CUTOFF   0x0600
 324
 325 /* Value of dl_type to indicate that the frame does not include an
 326  * Ethernet type.
 327  */
 328 #define ODP_DL_TYPE_NOT_ETH_TYPE  0x05ff
 329
 330 /* The VLAN id is 12-bits, so we can use the entire 16 bits to indicate
 331  * special conditions.  All ones indicates that no VLAN id was set.
 332  */
 333 #define ODP_VLAN_NONE      0xffff
 334
 335 #endif /* openvswitch/datapath-protocol.h */