lib/odp-util.h

   1 /*
   2  * Copyright (c) 2009, 2010, 2011, 2012, 2013, 2014 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_CONTROLLER, "controller",                                  \
  44         "Sends \"packet-in\" messages to the OpenFlow controller")      \
  45     SPR(SLOW_ACTION,     "action",                                      \
  46         "Uses action(s) not supported by datapath")
  47
  48 /* Indexes for slow-path reasons.  Client code uses "enum slow_path_reason"
  49  * values instead of these, these are just a way to construct those. */
  50 enum {
  51 #define SPR(ENUM, STRING, EXPLANATION) ENUM##_INDEX,
  52     SLOW_PATH_REASONS
  53 #undef SPR
  54 };
  55
  56 /* Reasons why a subfacet might not be fast-pathable.
  57  *
  58  * Each reason is a separate bit to allow reasons to be combined. */
  59 enum slow_path_reason {
  60 #define SPR(ENUM, STRING, EXPLANATION) ENUM = 1 << ENUM##_INDEX,
  61     SLOW_PATH_REASONS
  62 #undef SPR
  63 };
  64
  65 /* Mask of all slow_path_reasons. */
  66 enum {
  67     SLOW_PATH_REASON_MASK = 0
  68 #define SPR(ENUM, STRING, EXPLANATION) | 1 << ENUM##_INDEX
  69     SLOW_PATH_REASONS
  70 #undef SPR
  71 };
  72
  73 const char *slow_path_reason_to_explanation(enum slow_path_reason);
  74
  75 #define ODPP_LOCAL ODP_PORT_C(OVSP_LOCAL)
  76 #define ODPP_NONE  ODP_PORT_C(UINT32_MAX)
  77
  78 void format_odp_actions(struct ds *, const struct nlattr *odp_actions,
  79                         size_t actions_len);
  80 int odp_actions_from_string(const char *, const struct simap *port_names,
  81                             struct ofpbuf *odp_actions);
  82
  83 /* A map from odp port number to its name. */
  84 struct odp_portno_names {
  85     struct hmap_node hmap_node; /* A node in a port number to name hmap. */
  86     odp_port_t port_no;         /* Port number in the datapath. */
  87     char *name;                 /* Name associated with the above 'port_no'. */
  88 };
  89
  90 void odp_portno_names_set(struct hmap *portno_names, odp_port_t port_no,
  91                           char *port_name);
  92 void odp_portno_names_destroy(struct hmap *portno_names);
  93 /* The maximum number of bytes that odp_flow_key_from_flow() appends to a
  94  * buffer.  This is the upper bound on the length of a nlattr-formatted flow
  95  * key that ovs-vswitchd fully understands.
  96  *
  97  * OVS doesn't insist that ovs-vswitchd and the datapath have exactly the same
  98  * idea of a flow, so therefore this value isn't necessarily an upper bound on
  99  * the length of a flow key that the datapath can pass to ovs-vswitchd.
 100  *
 101  * The longest nlattr-formatted flow key appended by odp_flow_key_from_flow()
 102  * would be:
 103  *
 104  *                                     struct  pad  nl hdr  total
 105  *                                     ------  ---  ------  -----
 106  *  OVS_KEY_ATTR_PRIORITY                4    --     4      8
 107  *  OVS_KEY_ATTR_TUNNEL                  0    --     4      4
 108  *  - OVS_TUNNEL_KEY_ATTR_ID             8    --     4     12
 109  *  - OVS_TUNNEL_KEY_ATTR_IPV4_SRC       4    --     4      8
 110  *  - OVS_TUNNEL_KEY_ATTR_IPV4_DST       4    --     4      8
 111  *  - OVS_TUNNEL_KEY_ATTR_TOS            1    3      4      8
 112  *  - OVS_TUNNEL_KEY_ATTR_TTL            1    3      4      8
 113  *  - OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT  0    --     4      4
 114  *  - OVS_TUNNEL_KEY_ATTR_CSUM           0    --     4      4
 115  *  - OVS_TUNNEL_KEY_ATTR_OAM            0    --     4      4
 116  *  - OVS_TUNNEL_KEY_ATTR_GENEVE_OPTS    256  --     4      260
 117  *  OVS_KEY_ATTR_IN_PORT                 4    --     4      8
 118  *  OVS_KEY_ATTR_SKB_MARK                4    --     4      8
 119  *  OVS_KEY_ATTR_DP_HASH                 4    --     4      8
 120  *  OVS_KEY_ATTR_RECIRC_ID               4    --     4      8
 121  *  OVS_KEY_ATTR_ETHERNET               12    --     4     16
 122  *  OVS_KEY_ATTR_ETHERTYPE               2     2     4      8  (outer VLAN ethertype)
 123  *  OVS_KEY_ATTR_VLAN                    2     2     4      8
 124  *  OVS_KEY_ATTR_ENCAP                   0    --     4      4  (VLAN encapsulation)
 125  *  OVS_KEY_ATTR_ETHERTYPE               2     2     4      8  (inner VLAN ethertype)
 126  *  OVS_KEY_ATTR_IPV6                   40    --     4     44
 127  *  OVS_KEY_ATTR_ICMPV6                  2     2     4      8
 128  *  OVS_KEY_ATTR_ND                     28    --     4     32
 129  *  ----------------------------------------------------------
 130  *  total                                                 488
 131  *
 132  * We include some slack space in case the calculation isn't quite right or we
 133  * add another field and forget to adjust this value.
 134  */
 135 #define ODPUTIL_FLOW_KEY_BYTES 512
 136 BUILD_ASSERT_DECL(FLOW_WC_SEQ == 29);
 137
 138 /* A buffer with sufficient size and alignment to hold an nlattr-formatted flow
 139  * key.  An array of "struct nlattr" might not, in theory, be sufficiently
 140  * aligned because it only contains 16-bit types. */
 141 struct odputil_keybuf {
 142     uint32_t keybuf[DIV_ROUND_UP(ODPUTIL_FLOW_KEY_BYTES, 4)];
 143 };
 144
 145 enum odp_key_fitness odp_tun_key_from_attr(const struct nlattr *,
 146                                            struct flow_tnl *);
 147
 148 int odp_ufid_from_string(const char *s_, ovs_u128 *ufid);
 149 void odp_format_ufid(const ovs_u128 *ufid, struct ds *);
 150 void odp_flow_format(const struct nlattr *key, size_t key_len,
 151                      const struct nlattr *mask, size_t mask_len,
 152                      const struct hmap *portno_names, struct ds *,
 153                      bool verbose);
 154 void odp_flow_key_format(const struct nlattr *, size_t, struct ds *);
 155 int odp_flow_from_string(const char *s,
 156                          const struct simap *port_names,
 157                          struct ofpbuf *, struct ofpbuf *);
 158
 159 void odp_flow_key_from_flow(struct ofpbuf *, const struct flow * flow,
 160                             const struct flow *mask, odp_port_t odp_in_port,
 161                             bool recirc);
 162 void odp_flow_key_from_mask(struct ofpbuf *, const struct flow *mask,
 163                             const struct flow *flow, uint32_t odp_in_port,
 164                             size_t max_mpls_depth, bool recirc);
 165
 166 uint32_t odp_flow_key_hash(const struct nlattr *, size_t);
 167
 168 /* Estimated space needed for metadata. */
 169 enum { ODP_KEY_METADATA_SIZE = 9 * 8 };
 170 void odp_key_from_pkt_metadata(struct ofpbuf *, const struct pkt_metadata *);
 171 void odp_key_to_pkt_metadata(const struct nlattr *key, size_t key_len,
 172                               struct pkt_metadata *md);
 173
 174 /* How well a kernel-provided flow key (a sequence of OVS_KEY_ATTR_*
 175  * attributes) matches OVS userspace expectations.
 176  *
 177  * These values are arranged so that greater values are "more important" than
 178  * lesser ones.  In particular, a single flow key can fit the descriptions for
 179  * both ODP_FIT_TOO_LITTLE and ODP_FIT_TOO_MUCH.  Such a key is treated as
 180  * ODP_FIT_TOO_LITTLE. */
 181 enum odp_key_fitness {
 182     ODP_FIT_PERFECT,            /* The key had exactly the fields we expect. */
 183     ODP_FIT_TOO_MUCH,           /* The key had fields we don't understand. */
 184     ODP_FIT_TOO_LITTLE,         /* The key lacked fields we expected to see. */
 185     ODP_FIT_ERROR,              /* The key was invalid. */
 186 };
 187 enum odp_key_fitness odp_flow_key_to_flow(const struct nlattr *, size_t,
 188                                           struct flow *);
 189 enum odp_key_fitness odp_flow_key_to_mask(const struct nlattr *key, size_t len,
 190                                           struct flow *mask,
 191                                           const struct flow *flow);
 192 const char *odp_key_fitness_to_string(enum odp_key_fitness);
 193
 194 void commit_odp_tunnel_action(const struct flow *, struct flow *base,
 195                               struct ofpbuf *odp_actions);
 196 void commit_masked_set_action(struct ofpbuf *odp_actions,
 197                               enum ovs_key_attr key_type, const void *key,
 198                               const void *mask, size_t key_size);
 199 enum slow_path_reason commit_odp_actions(const struct flow *,
 200                                          struct flow *base,
 201                                          struct ofpbuf *odp_actions,
 202                                          struct flow_wildcards *wc,
 203                                          bool use_masked);
 204 \f
 205 /* ofproto-dpif interface.
 206  *
 207  * The following types and functions are logically part of ofproto-dpif.
 208  * ofproto-dpif puts values of these types into the flows that it installs in
 209  * the kernel datapath, though, so ovs-dpctl needs to interpret them so that
 210  * it can print flows in a more human-readable manner. */
 211
 212 enum user_action_cookie_type {
 213     USER_ACTION_COOKIE_UNSPEC,
 214     USER_ACTION_COOKIE_SFLOW,        /* Packet for per-bridge sFlow sampling. */
 215     USER_ACTION_COOKIE_SLOW_PATH,    /* Userspace must process this flow. */
 216     USER_ACTION_COOKIE_FLOW_SAMPLE,  /* Packet for per-flow sampling. */
 217     USER_ACTION_COOKIE_IPFIX,        /* Packet for per-bridge IPFIX sampling. */
 218 };
 219
 220 /* user_action_cookie is passed as argument to OVS_ACTION_ATTR_USERSPACE.
 221  * Since it is passed to kernel as u64, its size has to be 8 bytes. */
 222 union user_action_cookie {
 223     uint16_t type;              /* enum user_action_cookie_type. */
 224
 225     struct {
 226         uint16_t type;          /* USER_ACTION_COOKIE_SFLOW. */
 227         ovs_be16 vlan_tci;      /* Destination VLAN TCI. */
 228         uint32_t output;        /* SFL_FLOW_SAMPLE_TYPE 'output' value. */
 229     } sflow;
 230
 231     struct {
 232         uint16_t type;          /* USER_ACTION_COOKIE_SLOW_PATH. */
 233         uint16_t unused;
 234         uint32_t reason;        /* enum slow_path_reason. */
 235     } slow_path;
 236
 237     struct {
 238         uint16_t type;          /* USER_ACTION_COOKIE_FLOW_SAMPLE. */
 239         uint16_t probability;   /* Sampling probability. */
 240         uint32_t collector_set_id; /* ID of IPFIX collector set. */
 241         uint32_t obs_domain_id; /* Observation Domain ID. */
 242         uint32_t obs_point_id;  /* Observation Point ID. */
 243     } flow_sample;
 244
 245     struct {
 246         uint16_t   type;            /* USER_ACTION_COOKIE_IPFIX. */
 247         odp_port_t output_odp_port; /* The output odp port. */
 248     } ipfix;
 249 };
 250 BUILD_ASSERT_DECL(sizeof(union user_action_cookie) == 16);
 251
 252 size_t odp_put_userspace_action(uint32_t pid,
 253                                 const void *userdata, size_t userdata_size,
 254                                 odp_port_t tunnel_out_port,
 255                                 struct ofpbuf *odp_actions);
 256 void odp_put_tunnel_action(const struct flow_tnl *tunnel,
 257                            struct ofpbuf *odp_actions);
 258
 259 void odp_put_tnl_push_action(struct ofpbuf *odp_actions,
 260                              struct ovs_action_push_tnl *data);
 261 #endif /* odp-util.h */