lib/odp-util.h

   1 /*
   2  * Copyright (c) 2009, 2010, 2011, 2012, 2013, 2014, 2015 Nicira, Inc.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #ifndef ODP_UTIL_H
  18 #define ODP_UTIL_H 1
  19
  20 #include <stdbool.h>
  21 #include <stddef.h>
  22 #include <stdint.h>
  23 #include <string.h>
  24 #include "flow.h"
  25 #include "hash.h"
  26 #include "hmap.h"
  27 #include "odp-netlink.h"
  28 #include "openflow/openflow.h"
  29 #include "util.h"
  30
  31 struct ds;
  32 struct nlattr;
  33 struct ofpbuf;
  34 struct simap;
  35 struct pkt_metadata;
  36
  37 #define SLOW_PATH_REASONS                                               \
  38     /* These reasons are mutually exclusive. */                         \
  39     SPR(SLOW_CFM,        "cfm",        "Consists of CFM packets")       \
  40     SPR(SLOW_BFD,        "bfd",        "Consists of BFD packets")       \
  41     SPR(SLOW_LACP,       "lacp",       "Consists of LACP packets")      \
  42     SPR(SLOW_STP,        "stp",        "Consists of STP packets")       \
  43     SPR(SLOW_LLDP,       "lldp",       "Consists of LLDP packets")    \
  44     SPR(SLOW_CONTROLLER, "controller",                                  \
  45         "Sends \"packet-in\" messages to the OpenFlow controller")      \
  46     SPR(SLOW_ACTION,     "action",                                      \
  47         "Uses action(s) not supported by datapath")
  48
  49 /* Indexes for slow-path reasons.  Client code uses "enum slow_path_reason"
  50  * values instead of these, these are just a way to construct those. */
  51 enum {
  52 #define SPR(ENUM, STRING, EXPLANATION) ENUM##_INDEX,
  53     SLOW_PATH_REASONS
  54 #undef SPR
  55 };
  56
  57 /* Reasons why a subfacet might not be fast-pathable.
  58  *
  59  * Each reason is a separate bit to allow reasons to be combined. */
  60 enum slow_path_reason {
  61 #define SPR(ENUM, STRING, EXPLANATION) ENUM = 1 << ENUM##_INDEX,
  62     SLOW_PATH_REASONS
  63 #undef SPR
  64 };
  65
  66 /* Mask of all slow_path_reasons. */
  67 enum {
  68     SLOW_PATH_REASON_MASK = 0
  69 #define SPR(ENUM, STRING, EXPLANATION) | 1 << ENUM##_INDEX
  70     SLOW_PATH_REASONS
  71 #undef SPR
  72 };
  73
  74 const char *slow_path_reason_to_explanation(enum slow_path_reason);
  75
  76 #define ODPP_LOCAL ODP_PORT_C(OVSP_LOCAL)
  77 #define ODPP_NONE  ODP_PORT_C(UINT32_MAX)
  78
  79 void format_odp_actions(struct ds *, const struct nlattr *odp_actions,
  80                         size_t actions_len);
  81 int odp_actions_from_string(const char *, const struct simap *port_names,
  82                             struct ofpbuf *odp_actions);
  83
  84 /* A map from odp port number to its name. */
  85 struct odp_portno_names {
  86     struct hmap_node hmap_node; /* A node in a port number to name hmap. */
  87     odp_port_t port_no;         /* Port number in the datapath. */
  88     char *name;                 /* Name associated with the above 'port_no'. */
  89 };
  90
  91 void odp_portno_names_set(struct hmap *portno_names, odp_port_t port_no,
  92                           char *port_name);
  93 void odp_portno_names_destroy(struct hmap *portno_names);
  94 /* The maximum number of bytes that odp_flow_key_from_flow() appends to a
  95  * buffer.  This is the upper bound on the length of a nlattr-formatted flow
  96  * key that ovs-vswitchd fully understands.
  97  *
  98  * OVS doesn't insist that ovs-vswitchd and the datapath have exactly the same
  99  * idea of a flow, so therefore this value isn't necessarily an upper bound on
 100  * the length of a flow key that the datapath can pass to ovs-vswitchd.
 101  *
 102  * The longest nlattr-formatted flow key appended by odp_flow_key_from_flow()
 103  * would be:
 104  *
 105  *                                     struct  pad  nl hdr  total
 106  *                                     ------  ---  ------  -----
 107  *  OVS_KEY_ATTR_PRIORITY                4    --     4      8
 108  *  OVS_KEY_ATTR_TUNNEL                  0    --     4      4
 109  *  - OVS_TUNNEL_KEY_ATTR_ID             8    --     4     12
 110  *  - OVS_TUNNEL_KEY_ATTR_IPV4_SRC       4    --     4      8
 111  *  - OVS_TUNNEL_KEY_ATTR_IPV4_DST       4    --     4      8
 112  *  - OVS_TUNNEL_KEY_ATTR_IPV6_SRC       16   --     4     20
 113  *  - OVS_TUNNEL_KEY_ATTR_IPV6_DST       16   --     4     20
 114  *  - OVS_TUNNEL_KEY_ATTR_TOS            1    3      4      8
 115  *  - OVS_TUNNEL_KEY_ATTR_TTL            1    3      4      8
 116  *  - OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT  0    --     4      4
 117  *  - OVS_TUNNEL_KEY_ATTR_CSUM           0    --     4      4
 118  *  - OVS_TUNNEL_KEY_ATTR_OAM            0    --     4      4
 119  *  - OVS_TUNNEL_KEY_ATTR_GENEVE_OPTS    256  --     4      260
 120  *  - OVS_TUNNEL_KEY_ATTR_VXLAN_OPTS     -    --     -      - (shared with _GENEVE_OPTS)
 121  *  OVS_KEY_ATTR_IN_PORT                 4    --     4      8
 122  *  OVS_KEY_ATTR_SKB_MARK                4    --     4      8
 123  *  OVS_KEY_ATTR_DP_HASH                 4    --     4      8
 124  *  OVS_KEY_ATTR_RECIRC_ID               4    --     4      8
 125  *  OVS_KEY_ATTR_CT_STATE                4    --     4      8
 126  *  OVS_KEY_ATTR_CT_ZONE                 2     2     4      8
 127  *  OVS_KEY_ATTR_CT_MARK                 4    --     4      8
 128  *  OVS_KEY_ATTR_CT_LABEL               16    --     4     20
 129  *  OVS_KEY_ATTR_ETHERNET               12    --     4     16
 130  *  OVS_KEY_ATTR_ETHERTYPE               2     2     4      8  (outer VLAN ethertype)
 131  *  OVS_KEY_ATTR_VLAN                    2     2     4      8
 132  *  OVS_KEY_ATTR_ENCAP                   0    --     4      4  (VLAN encapsulation)
 133  *  OVS_KEY_ATTR_ETHERTYPE               2     2     4      8  (inner VLAN ethertype)
 134  *  OVS_KEY_ATTR_IPV6                   40    --     4     44
 135  *  OVS_KEY_ATTR_ICMPV6                  2     2     4      8
 136  *  OVS_KEY_ATTR_ND                     28    --     4     32
 137  *  ----------------------------------------------------------
 138  *  total                                                 572
 139  *
 140  * We include some slack space in case the calculation isn't quite right or we
 141  * add another field and forget to adjust this value.
 142  */
 143 #define ODPUTIL_FLOW_KEY_BYTES 640
 144 BUILD_ASSERT_DECL(FLOW_WC_SEQ == 35);
 145
 146 /* A buffer with sufficient size and alignment to hold an nlattr-formatted flow
 147  * key.  An array of "struct nlattr" might not, in theory, be sufficiently
 148  * aligned because it only contains 16-bit types. */
 149 struct odputil_keybuf {
 150     uint32_t keybuf[DIV_ROUND_UP(ODPUTIL_FLOW_KEY_BYTES, 4)];
 151 };
 152
 153 enum odp_key_fitness odp_tun_key_from_attr(const struct nlattr *, bool udpif,
 154                                            struct flow_tnl *);
 155
 156 int odp_ufid_from_string(const char *s_, ovs_u128 *ufid);
 157 void odp_format_ufid(const ovs_u128 *ufid, struct ds *);
 158 void odp_flow_format(const struct nlattr *key, size_t key_len,
 159                      const struct nlattr *mask, size_t mask_len,
 160                      const struct hmap *portno_names, struct ds *,
 161                      bool verbose);
 162 void odp_flow_key_format(const struct nlattr *, size_t, struct ds *);
 163 int odp_flow_from_string(const char *s,
 164                          const struct simap *port_names,
 165                          struct ofpbuf *, struct ofpbuf *);
 166
 167 /* Indicates support for various fields. This defines how flows will be
 168  * serialised. */
 169 struct odp_support {
 170     /* Maximum number of MPLS label stack entries to serialise in a mask. */
 171     size_t max_mpls_depth;
 172
 173     /* If this is true, then recirculation fields will always be serialised. */
 174     bool recirc;
 175
 176     /* If true, serialise the corresponding OVS_KEY_ATTR_CONN_* field. */
 177     bool ct_state;
 178     bool ct_zone;
 179     bool ct_mark;
 180     bool ct_label;
 181 };
 182
 183 struct odp_flow_key_parms {
 184     /* The flow and mask to be serialized. In the case of masks, 'flow'
 185      * is used as a template to determine how to interpret 'mask'.  For
 186      * example, the 'dl_type' of 'mask' describes the mask, but it doesn't
 187      * indicate whether the other fields should be interpreted as ARP, IPv4,
 188      * IPv6, etc. */
 189     const struct flow *flow;
 190     const struct flow *mask;
 191
 192    /* 'flow->in_port' is ignored (since it is likely to be an OpenFlow port
 193     * number rather than a datapath port number).  Instead, if 'odp_in_port'
 194     * is anything other than ODPP_NONE, it is included in 'buf' as the input
 195     * port. */
 196     odp_port_t odp_in_port;
 197
 198     /* Indicates support for various fields. If the datapath supports a field,
 199      * then it will always be serialised. */
 200     struct odp_support support;
 201
 202     /* The netlink formatted version of the flow. It is used in cases where
 203      * the mask cannot be constructed from the OVS internal representation
 204      * and needs to see the original form. */
 205     const struct ofpbuf *key_buf;
 206 };
 207
 208 void odp_flow_key_from_flow(const struct odp_flow_key_parms *, struct ofpbuf *);
 209 void odp_flow_key_from_mask(const struct odp_flow_key_parms *, struct ofpbuf *);
 210
 211 uint32_t odp_flow_key_hash(const struct nlattr *, size_t);
 212
 213 /* Estimated space needed for metadata. */
 214 enum { ODP_KEY_METADATA_SIZE = 9 * 8 };
 215 void odp_key_from_pkt_metadata(struct ofpbuf *, const struct pkt_metadata *);
 216 void odp_key_to_pkt_metadata(const struct nlattr *key, size_t key_len,
 217                               struct pkt_metadata *md);
 218
 219 /* How well a kernel-provided flow key (a sequence of OVS_KEY_ATTR_*
 220  * attributes) matches OVS userspace expectations.
 221  *
 222  * These values are arranged so that greater values are "more important" than
 223  * lesser ones.  In particular, a single flow key can fit the descriptions for
 224  * both ODP_FIT_TOO_LITTLE and ODP_FIT_TOO_MUCH.  Such a key is treated as
 225  * ODP_FIT_TOO_LITTLE. */
 226 enum odp_key_fitness {
 227     ODP_FIT_PERFECT,            /* The key had exactly the fields we expect. */
 228     ODP_FIT_TOO_MUCH,           /* The key had fields we don't understand. */
 229     ODP_FIT_TOO_LITTLE,         /* The key lacked fields we expected to see. */
 230     ODP_FIT_ERROR,              /* The key was invalid. */
 231 };
 232 enum odp_key_fitness odp_flow_key_to_flow(const struct nlattr *, size_t,
 233                                           struct flow *);
 234 enum odp_key_fitness odp_flow_key_to_mask(const struct nlattr *mask_key,
 235                                           size_t mask_key_len,
 236                                           const struct nlattr *flow_key,
 237                                           size_t flow_key_len,
 238                                           struct flow *mask,
 239                                           const struct flow *flow);
 240
 241 enum odp_key_fitness odp_flow_key_to_flow_udpif(const struct nlattr *, size_t,
 242                                                 struct flow *);
 243 enum odp_key_fitness odp_flow_key_to_mask_udpif(const struct nlattr *mask_key,
 244                                                 size_t mask_key_len,
 245                                                 const struct nlattr *flow_key,
 246                                                 size_t flow_key_len,
 247                                                 struct flow *mask,
 248                                                 const struct flow *flow);
 249
 250 const char *odp_key_fitness_to_string(enum odp_key_fitness);
 251
 252 void commit_odp_tunnel_action(const struct flow *, struct flow *base,
 253                               struct ofpbuf *odp_actions);
 254 void commit_masked_set_action(struct ofpbuf *odp_actions,
 255                               enum ovs_key_attr key_type, const void *key,
 256                               const void *mask, size_t key_size);
 257 enum slow_path_reason commit_odp_actions(const struct flow *,
 258                                          struct flow *base,
 259                                          struct ofpbuf *odp_actions,
 260                                          struct flow_wildcards *wc,
 261                                          bool use_masked);
 262 \f
 263 /* ofproto-dpif interface.
 264  *
 265  * The following types and functions are logically part of ofproto-dpif.
 266  * ofproto-dpif puts values of these types into the flows that it installs in
 267  * the kernel datapath, though, so ovs-dpctl needs to interpret them so that
 268  * it can print flows in a more human-readable manner. */
 269
 270 enum user_action_cookie_type {
 271     USER_ACTION_COOKIE_UNSPEC,
 272     USER_ACTION_COOKIE_SFLOW,        /* Packet for per-bridge sFlow sampling. */
 273     USER_ACTION_COOKIE_SLOW_PATH,    /* Userspace must process this flow. */
 274     USER_ACTION_COOKIE_FLOW_SAMPLE,  /* Packet for per-flow sampling. */
 275     USER_ACTION_COOKIE_IPFIX,        /* Packet for per-bridge IPFIX sampling. */
 276 };
 277
 278 /* user_action_cookie is passed as argument to OVS_ACTION_ATTR_USERSPACE.
 279  * Since it is passed to kernel as u64, its size has to be 8 bytes. */
 280 union user_action_cookie {
 281     uint16_t type;              /* enum user_action_cookie_type. */
 282
 283     struct {
 284         uint16_t type;          /* USER_ACTION_COOKIE_SFLOW. */
 285         ovs_be16 vlan_tci;      /* Destination VLAN TCI. */
 286         uint32_t output;        /* SFL_FLOW_SAMPLE_TYPE 'output' value. */
 287     } sflow;
 288
 289     struct {
 290         uint16_t type;          /* USER_ACTION_COOKIE_SLOW_PATH. */
 291         uint16_t unused;
 292         uint32_t reason;        /* enum slow_path_reason. */
 293     } slow_path;
 294
 295     struct {
 296         uint16_t type;          /* USER_ACTION_COOKIE_FLOW_SAMPLE. */
 297         uint16_t probability;   /* Sampling probability. */
 298         uint32_t collector_set_id; /* ID of IPFIX collector set. */
 299         uint32_t obs_domain_id; /* Observation Domain ID. */
 300         uint32_t obs_point_id;  /* Observation Point ID. */
 301     } flow_sample;
 302
 303     struct {
 304         uint16_t   type;            /* USER_ACTION_COOKIE_IPFIX. */
 305         odp_port_t output_odp_port; /* The output odp port. */
 306     } ipfix;
 307 };
 308 BUILD_ASSERT_DECL(sizeof(union user_action_cookie) == 16);
 309
 310 size_t odp_put_userspace_action(uint32_t pid,
 311                                 const void *userdata, size_t userdata_size,
 312                                 odp_port_t tunnel_out_port,
 313                                 bool include_actions,
 314                                 struct ofpbuf *odp_actions);
 315 void odp_put_tunnel_action(const struct flow_tnl *tunnel,
 316                            struct ofpbuf *odp_actions);
 317
 318 void odp_put_tnl_push_action(struct ofpbuf *odp_actions,
 319                              struct ovs_action_push_tnl *data);
 320 #endif /* odp-util.h */