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