lib/odp-util.h

   1 /*
   2  * Copyright (c) 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016 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 "openvswitch/hmap.h"
  27 #include "openvswitch/ofp-actions.h"
  28 #include "odp-netlink.h"
  29 #include "openflow/openflow.h"
  30 #include "util.h"
  31
  32 struct ds;
  33 struct nlattr;
  34 struct ofpbuf;
  35 struct simap;
  36 struct pkt_metadata;
  37
  38 #define SLOW_PATH_REASONS                                               \
  39     /* These reasons are mutually exclusive. */                         \
  40     SPR(SLOW_CFM,        "cfm",        "Consists of CFM packets")       \
  41     SPR(SLOW_BFD,        "bfd",        "Consists of BFD packets")       \
  42     SPR(SLOW_LACP,       "lacp",       "Consists of LACP packets")      \
  43     SPR(SLOW_STP,        "stp",        "Consists of STP packets")       \
  44     SPR(SLOW_LLDP,       "lldp",       "Consists of LLDP packets")    \
  45     SPR(SLOW_CONTROLLER, "controller",                                  \
  46         "Sends \"packet-in\" messages to the OpenFlow controller")      \
  47     SPR(SLOW_ACTION,     "action",                                      \
  48         "Uses action(s) not supported by datapath")
  49
  50 /* Indexes for slow-path reasons.  Client code uses "enum slow_path_reason"
  51  * values instead of these, these are just a way to construct those. */
  52 enum {
  53 #define SPR(ENUM, STRING, EXPLANATION) ENUM##_INDEX,
  54     SLOW_PATH_REASONS
  55 #undef SPR
  56 };
  57
  58 /* Reasons why a subfacet might not be fast-pathable.
  59  *
  60  * Each reason is a separate bit to allow reasons to be combined. */
  61 enum slow_path_reason {
  62 #define SPR(ENUM, STRING, EXPLANATION) ENUM = 1 << ENUM##_INDEX,
  63     SLOW_PATH_REASONS
  64 #undef SPR
  65 };
  66
  67 /* Mask of all slow_path_reasons. */
  68 enum {
  69     SLOW_PATH_REASON_MASK = 0
  70 #define SPR(ENUM, STRING, EXPLANATION) | 1 << ENUM##_INDEX
  71     SLOW_PATH_REASONS
  72 #undef SPR
  73 };
  74
  75 const char *slow_path_reason_to_explanation(enum slow_path_reason);
  76
  77 #define ODPP_LOCAL ODP_PORT_C(OVSP_LOCAL)
  78 #define ODPP_NONE  ODP_PORT_C(UINT32_MAX)
  79
  80 void format_odp_actions(struct ds *, const struct nlattr *odp_actions,
  81                         size_t actions_len, const struct hmap *portno_names);
  82 int odp_actions_from_string(const char *, const struct simap *port_names,
  83                             struct ofpbuf *odp_actions);
  84
  85 /* A map from odp port number to its name. */
  86 struct odp_portno_names {
  87     struct hmap_node hmap_node; /* A node in a port number to name hmap. */
  88     odp_port_t port_no;         /* Port number in the datapath. */
  89     char *name;                 /* Name associated with the above 'port_no'. */
  90 };
  91
  92 void odp_portno_names_set(struct hmap *portno_names, odp_port_t port_no,
  93                           char *port_name);
  94 void odp_portno_names_destroy(struct hmap *portno_names);
  95 void odp_portno_name_format(const struct hmap *portno_names,
  96                             odp_port_t, struct ds *);
  97
  98 /* The maximum number of bytes that odp_flow_key_from_flow() appends to a
  99  * buffer.  This is the upper bound on the length of a nlattr-formatted flow
 100  * key that ovs-vswitchd fully understands.
 101  *
 102  * OVS doesn't insist that ovs-vswitchd and the datapath have exactly the same
 103  * idea of a flow, so therefore this value isn't necessarily an upper bound on
 104  * the length of a flow key that the datapath can pass to ovs-vswitchd.
 105  *
 106  * The longest nlattr-formatted flow key appended by odp_flow_key_from_flow()
 107  * would be:
 108  *
 109  *                                     struct  pad  nl hdr  total
 110  *                                     ------  ---  ------  -----
 111  *  OVS_KEY_ATTR_PRIORITY                4    --     4      8
 112  *  OVS_KEY_ATTR_TUNNEL                  0    --     4      4
 113  *  - OVS_TUNNEL_KEY_ATTR_ID             8    --     4     12
 114  *  - OVS_TUNNEL_KEY_ATTR_IPV4_SRC       4    --     4      8
 115  *  - OVS_TUNNEL_KEY_ATTR_IPV4_DST       4    --     4      8
 116  *  - OVS_TUNNEL_KEY_ATTR_IPV6_SRC       16   --     4     20
 117  *  - OVS_TUNNEL_KEY_ATTR_IPV6_DST       16   --     4     20
 118  *  - OVS_TUNNEL_KEY_ATTR_TOS            1    3      4      8
 119  *  - OVS_TUNNEL_KEY_ATTR_TTL            1    3      4      8
 120  *  - OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT  0    --     4      4
 121  *  - OVS_TUNNEL_KEY_ATTR_CSUM           0    --     4      4
 122  *  - OVS_TUNNEL_KEY_ATTR_OAM            0    --     4      4
 123  *  - OVS_TUNNEL_KEY_ATTR_GENEVE_OPTS    256  --     4      260
 124  *  - OVS_TUNNEL_KEY_ATTR_VXLAN_OPTS     -    --     -      - (shared with _GENEVE_OPTS)
 125  *  OVS_KEY_ATTR_IN_PORT                 4    --     4      8
 126  *  OVS_KEY_ATTR_SKB_MARK                4    --     4      8
 127  *  OVS_KEY_ATTR_DP_HASH                 4    --     4      8
 128  *  OVS_KEY_ATTR_RECIRC_ID               4    --     4      8
 129  *  OVS_KEY_ATTR_CT_STATE                4    --     4      8
 130  *  OVS_KEY_ATTR_CT_ZONE                 2     2     4      8
 131  *  OVS_KEY_ATTR_CT_MARK                 4    --     4      8
 132  *  OVS_KEY_ATTR_CT_LABEL               16    --     4     20
 133  *  OVS_KEY_ATTR_CT_ORIG_TUPLE_IPV6     40    --     4     44
 134  *  OVS_KEY_ATTR_CT_ORIG_TUPLE_IPV4      -    --     -      - (exclusive of_CT_ORIG_TUPLE_IPV6)
 135  *  OVS_KEY_ATTR_ETHERNET               12    --     4     16
 136  *  OVS_KEY_ATTR_ETHERTYPE               2     2     4      8  (outer VLAN ethertype)
 137  *  OVS_KEY_ATTR_VLAN                    2     2     4      8
 138  *  OVS_KEY_ATTR_ENCAP                   0    --     4      4  (VLAN encapsulation)
 139  *  OVS_KEY_ATTR_ETHERTYPE               2     2     4      8  (inner VLAN ethertype)
 140  *  OVS_KEY_ATTR_IPV6                   40    --     4     44
 141  *  OVS_KEY_ATTR_ICMPV6                  2     2     4      8
 142  *  OVS_KEY_ATTR_ND                     28    --     4     32
 143  *  ----------------------------------------------------------
 144  *  total                                                 616
 145  *
 146  * We include some slack space in case the calculation isn't quite right or we
 147  * add another field and forget to adjust this value.
 148  */
 149 #define ODPUTIL_FLOW_KEY_BYTES 640
 150 BUILD_ASSERT_DECL(FLOW_WC_SEQ == 40);
 151
 152 /* A buffer with sufficient size and alignment to hold an nlattr-formatted flow
 153  * key.  An array of "struct nlattr" might not, in theory, be sufficiently
 154  * aligned because it only contains 16-bit types. */
 155 struct odputil_keybuf {
 156     uint32_t keybuf[DIV_ROUND_UP(ODPUTIL_FLOW_KEY_BYTES, 4)];
 157 };
 158
 159 enum odp_key_fitness odp_tun_key_from_attr(const struct nlattr *,
 160                                            struct flow_tnl *);
 161 enum odp_key_fitness odp_nsh_key_from_attr(const struct nlattr *,
 162                                            struct flow_nsh *);
 163 enum odp_key_fitness odp_nsh_hdr_from_attr(const struct nlattr *,
 164                                            struct nsh_hdr *, size_t size);
 165
 166 int odp_ufid_from_string(const char *s_, ovs_u128 *ufid);
 167 void odp_format_ufid(const ovs_u128 *ufid, struct ds *);
 168
 169 void odp_flow_format(const struct nlattr *key, size_t key_len,
 170                      const struct nlattr *mask, size_t mask_len,
 171                      const struct hmap *portno_names, struct ds *,
 172                      bool verbose);
 173 void odp_flow_key_format(const struct nlattr *, size_t, struct ds *);
 174 int odp_flow_from_string(const char *s,
 175                          const struct simap *port_names,
 176                          struct ofpbuf *, struct ofpbuf *);
 177
 178 /* ODP_SUPPORT_FIELD(TYPE, FIELD_NAME, FIELD_DESCRIPTION)
 179  *
 180  * Each 'ODP_SUPPORT_FIELD' defines a member in 'struct odp_support',
 181  * and represents support for related OVS_KEY_ATTR_* fields.
 182  * They are defined as macros to keep 'dpif_show_support()' in sync
 183  * as new fields are added.   */
 184 #define ODP_SUPPORT_FIELDS                                                   \
 185     /* Maximum number of 802.1q VLAN headers to serialize in a mask. */      \
 186     ODP_SUPPORT_FIELD(size_t, max_vlan_headers, "Max VLAN headers")          \
 187     /* Maximum number of MPLS label stack entries to serialise in a mask. */ \
 188     ODP_SUPPORT_FIELD(size_t, max_mpls_depth, "Max MPLS depth")              \
 189     /* If this is true, then recirculation fields will always be             \
 190      * serialised. */                                                        \
 191     ODP_SUPPORT_FIELD(bool, recirc, "Recirc")                                \
 192     /* If true, serialise the corresponding OVS_KEY_ATTR_CONN_* field. */    \
 193     ODP_SUPPORT_FIELD(bool, ct_state, "CT state")                            \
 194     ODP_SUPPORT_FIELD(bool, ct_zone, "CT zone")                              \
 195     ODP_SUPPORT_FIELD(bool, ct_mark, "CT mark")                              \
 196     ODP_SUPPORT_FIELD(bool, ct_label, "CT label")                            \
 197                                                                              \
 198     /* If true, it means that the datapath supports the NAT bits in          \
 199      * 'ct_state'.  The above 'ct_state' member must be true for this        \
 200      * to make sense */                                                      \
 201     ODP_SUPPORT_FIELD(bool, ct_state_nat, "CT state NAT")                    \
 202                                                                              \
 203     /* Conntrack original direction tuple matching * supported. */           \
 204     ODP_SUPPORT_FIELD(bool, ct_orig_tuple, "CT orig tuple")                  \
 205     ODP_SUPPORT_FIELD(bool, ct_orig_tuple6, "CT orig tuple for IPv6")
 206
 207 /* Indicates support for various fields. This defines how flows will be
 208  * serialised. */
 209 struct odp_support {
 210 #define ODP_SUPPORT_FIELD(TYPE, NAME, TITLE) TYPE NAME;
 211     ODP_SUPPORT_FIELDS
 212 #undef ODP_SUPPORT_FIELD
 213 };
 214
 215 struct odp_flow_key_parms {
 216     /* The flow and mask to be serialized. In the case of masks, 'flow'
 217      * is used as a template to determine how to interpret 'mask'.  For
 218      * example, the 'dl_type' of 'mask' describes the mask, but it doesn't
 219      * indicate whether the other fields should be interpreted as ARP, IPv4,
 220      * IPv6, etc. */
 221     const struct flow *flow;
 222     const struct flow *mask;
 223
 224     /* Indicates support for various fields. If the datapath supports a field,
 225      * then it will always be serialised. */
 226     struct odp_support support;
 227
 228     /* Indicates if we are probing datapath capability. If true, ignore the
 229      * configured flow limits. */
 230     bool probe;
 231
 232     /* The netlink formatted version of the flow. It is used in cases where
 233      * the mask cannot be constructed from the OVS internal representation
 234      * and needs to see the original form. */
 235     const struct ofpbuf *key_buf;
 236 };
 237
 238 void odp_flow_key_from_flow(const struct odp_flow_key_parms *, struct ofpbuf *);
 239 void odp_flow_key_from_mask(const struct odp_flow_key_parms *, struct ofpbuf *);
 240
 241 uint32_t odp_flow_key_hash(const struct nlattr *, size_t);
 242
 243 /* Estimated space needed for metadata. */
 244 enum { ODP_KEY_METADATA_SIZE = 9 * 8 };
 245 void odp_key_from_dp_packet(struct ofpbuf *, const struct dp_packet *);
 246 void odp_key_to_dp_packet(const struct nlattr *key, size_t key_len,
 247                           struct dp_packet *md);
 248
 249 /* How well a kernel-provided flow key (a sequence of OVS_KEY_ATTR_*
 250  * attributes) matches OVS userspace expectations.
 251  *
 252  * These values are arranged so that greater values are "more important" than
 253  * lesser ones.  In particular, a single flow key can fit the descriptions for
 254  * both ODP_FIT_TOO_LITTLE and ODP_FIT_TOO_MUCH.  Such a key is treated as
 255  * ODP_FIT_TOO_LITTLE. */
 256 enum odp_key_fitness {
 257     ODP_FIT_PERFECT,            /* The key had exactly the fields we expect. */
 258     ODP_FIT_TOO_MUCH,           /* The key had fields we don't understand. */
 259     ODP_FIT_TOO_LITTLE,         /* The key lacked fields we expected to see. */
 260     ODP_FIT_ERROR,              /* The key was invalid. */
 261 };
 262 enum odp_key_fitness odp_flow_key_to_flow(const struct nlattr *, size_t,
 263                                           struct flow *);
 264 enum odp_key_fitness odp_flow_key_to_mask(const struct nlattr *mask_key,
 265                                           size_t mask_key_len,
 266                                           struct flow_wildcards *mask,
 267                                           const struct flow *flow);
 268 int parse_key_and_mask_to_match(const struct nlattr *key, size_t key_len,
 269                                 const struct nlattr *mask, size_t mask_len,
 270                                 struct match *match);
 271
 272 const char *odp_key_fitness_to_string(enum odp_key_fitness);
 273
 274 void commit_odp_tunnel_action(const struct flow *, struct flow *base,
 275                               struct ofpbuf *odp_actions);
 276 void commit_masked_set_action(struct ofpbuf *odp_actions,
 277                               enum ovs_key_attr key_type, const void *key,
 278                               const void *mask, size_t key_size);
 279 enum slow_path_reason commit_odp_actions(const struct flow *,
 280                                          struct flow *base,
 281                                          struct ofpbuf *odp_actions,
 282                                          struct flow_wildcards *wc,
 283                                          bool use_masked,
 284                                          bool pending_encap,
 285                                          struct ofpbuf *encap_data);
 286 \f
 287 /* ofproto-dpif interface.
 288  *
 289  * The following types and functions are logically part of ofproto-dpif.
 290  * ofproto-dpif puts values of these types into the flows that it installs in
 291  * the kernel datapath, though, so ovs-dpctl needs to interpret them so that
 292  * it can print flows in a more human-readable manner. */
 293
 294 enum user_action_cookie_type {
 295     USER_ACTION_COOKIE_UNSPEC,
 296     USER_ACTION_COOKIE_SFLOW,        /* Packet for per-bridge sFlow sampling. */
 297     USER_ACTION_COOKIE_SLOW_PATH,    /* Userspace must process this flow. */
 298     USER_ACTION_COOKIE_FLOW_SAMPLE,  /* Packet for per-flow sampling. */
 299     USER_ACTION_COOKIE_IPFIX,        /* Packet for per-bridge IPFIX sampling. */
 300 };
 301
 302 /* user_action_cookie is passed as argument to OVS_ACTION_ATTR_USERSPACE. */
 303 union user_action_cookie {
 304     uint16_t type;              /* enum user_action_cookie_type. */
 305
 306     struct {
 307         uint16_t type;          /* USER_ACTION_COOKIE_SFLOW. */
 308         ovs_be16 vlan_tci;      /* Destination VLAN TCI. */
 309         uint32_t output;        /* SFL_FLOW_SAMPLE_TYPE 'output' value. */
 310     } sflow;
 311
 312     struct {
 313         uint16_t type;          /* USER_ACTION_COOKIE_SLOW_PATH. */
 314         uint16_t unused;
 315         uint32_t reason;        /* enum slow_path_reason. */
 316     } slow_path;
 317
 318     struct {
 319         uint16_t type;          /* USER_ACTION_COOKIE_FLOW_SAMPLE. */
 320         uint16_t probability;   /* Sampling probability. */
 321         uint32_t collector_set_id; /* ID of IPFIX collector set. */
 322         uint32_t obs_domain_id; /* Observation Domain ID. */
 323         uint32_t obs_point_id;  /* Observation Point ID. */
 324         odp_port_t output_odp_port; /* The output odp port. */
 325         enum nx_action_sample_direction direction;
 326     } flow_sample;
 327
 328     struct {
 329         uint16_t   type;            /* USER_ACTION_COOKIE_IPFIX. */
 330         odp_port_t output_odp_port; /* The output odp port. */
 331     } ipfix;
 332 };
 333 BUILD_ASSERT_DECL(sizeof(union user_action_cookie) == 24);
 334
 335 size_t odp_put_userspace_action(uint32_t pid,
 336                                 const void *userdata, size_t userdata_size,
 337                                 odp_port_t tunnel_out_port,
 338                                 bool include_actions,
 339                                 struct ofpbuf *odp_actions);
 340 void odp_put_tunnel_action(const struct flow_tnl *tunnel,
 341                            struct ofpbuf *odp_actions);
 342
 343 void odp_put_tnl_push_action(struct ofpbuf *odp_actions,
 344                              struct ovs_action_push_tnl *data);
 345
 346 void odp_put_pop_eth_action(struct ofpbuf *odp_actions);
 347 void odp_put_push_eth_action(struct ofpbuf *odp_actions,
 348                              const struct eth_addr *eth_src,
 349                              const struct eth_addr *eth_dst);
 350
 351 struct attr_len_tbl {
 352     int len;
 353     const struct attr_len_tbl *next;
 354     int next_max;
 355 };
 356
 357 #define ATTR_LEN_INVALID  -1
 358 #define ATTR_LEN_VARIABLE -2
 359 #define ATTR_LEN_NESTED   -3
 360
 361 extern const struct attr_len_tbl ovs_flow_key_attr_lens[OVS_KEY_ATTR_MAX + 1];
 362 #endif /* odp-util.h */