lib/odp-util.h

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