lib/odp-util.h

   1 /*
   2  * Copyright (c) 2009, 2010, 2011, 2012 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 nlattr;
  32 struct ofpbuf;
  33 struct simap;
  34
  35 #define OVSP_NONE UINT32_MAX
  36
  37 void format_odp_actions(struct ds *, const struct nlattr *odp_actions,
  38                         size_t actions_len);
  39 int odp_actions_from_string(const char *, const struct simap *port_names,
  40                             struct ofpbuf *odp_actions);
  41
  42 /* The maximum number of bytes that odp_flow_key_from_flow() appends to a
  43  * buffer.  This is the upper bound on the length of a nlattr-formatted flow
  44  * key that ovs-vswitchd fully understands.
  45  *
  46  * OVS doesn't insist that ovs-vswitchd and the datapath have exactly the same
  47  * idea of a flow, so therefore this value isn't necessarily an upper bound on
  48  * the length of a flow key that the datapath can pass to ovs-vswitchd.
  49  *
  50  * The longest nlattr-formatted flow key appended by odp_flow_key_from_flow()
  51  * would be:
  52  *
  53  *                         struct  pad  nl hdr  total
  54  *                         ------  ---  ------  -----
  55  *  OVS_KEY_ATTR_PRIORITY      4    --     4      8
  56  *  OVS_KEY_ATTR_TUN_ID        8    --     4     12
  57  *  OVS_KEY_ATTR_IPV4_TUNNEL  24    --     4     28
  58  *  OVS_KEY_ATTR_IN_PORT       4    --     4      8
  59  *  OVS_KEY_ATTR_SKB_MARK      4    --     4      8
  60  *  OVS_KEY_ATTR_ETHERNET     12    --     4     16
  61  *  OVS_KEY_ATTR_ETHERTYPE     2     2     4      8  (outer VLAN ethertype)
  62  *  OVS_KEY_ATTR_8021Q         4    --     4      8
  63  *  OVS_KEY_ATTR_ENCAP         0    --     4      4  (VLAN encapsulation)
  64  *  OVS_KEY_ATTR_ETHERTYPE     2     2     4      8  (inner VLAN ethertype)
  65  *  OVS_KEY_ATTR_IPV6         40    --     4     44
  66  *  OVS_KEY_ATTR_ICMPV6        2     2     4      8
  67  *  OVS_KEY_ATTR_ND           28    --     4     32
  68  *  -------------------------------------------------
  69  *  total                                       192
  70  *
  71  * We include some slack space in case the calculation isn't quite right or we
  72  * add another field and forget to adjust this value.
  73  */
  74 #define ODPUTIL_FLOW_KEY_BYTES 256
  75
  76 /* A buffer with sufficient size and alignment to hold an nlattr-formatted flow
  77  * key.  An array of "struct nlattr" might not, in theory, be sufficiently
  78  * aligned because it only contains 16-bit types. */
  79 struct odputil_keybuf {
  80     uint32_t keybuf[DIV_ROUND_UP(ODPUTIL_FLOW_KEY_BYTES, 4)];
  81 };
  82
  83 void odp_flow_key_format(const struct nlattr *, size_t, struct ds *);
  84 int odp_flow_key_from_string(const char *s, const struct simap *port_names,
  85                              struct ofpbuf *);
  86
  87 void odp_flow_key_from_flow(struct ofpbuf *, const struct flow *,
  88                             uint32_t odp_in_port);
  89
  90 uint32_t odp_flow_key_hash(const struct nlattr *, size_t);
  91
  92 /* How well a kernel-provided flow key (a sequence of OVS_KEY_ATTR_*
  93  * attributes) matches OVS userspace expectations.
  94  *
  95  * These values are arranged so that greater values are "more important" than
  96  * lesser ones.  In particular, a single flow key can fit the descriptions for
  97  * both ODP_FIT_TOO_LITTLE and ODP_FIT_TOO_MUCH.  Such a key is treated as
  98  * ODP_FIT_TOO_LITTLE. */
  99 enum odp_key_fitness {
 100     ODP_FIT_PERFECT,            /* The key had exactly the fields we expect. */
 101     ODP_FIT_TOO_MUCH,           /* The key had fields we don't understand. */
 102     ODP_FIT_TOO_LITTLE,         /* The key lacked fields we expected to see. */
 103     ODP_FIT_ERROR,              /* The key was invalid. */
 104 };
 105 enum odp_key_fitness odp_flow_key_to_flow(const struct nlattr *, size_t,
 106                                           struct flow *);
 107 const char *odp_key_fitness_to_string(enum odp_key_fitness);
 108
 109 void commit_odp_actions(const struct flow *, struct flow *base,
 110                         struct ofpbuf *odp_actions);
 111 \f
 112 /* ofproto-dpif interface.
 113  *
 114  * The following types and functions are logically part of ofproto-dpif.
 115  * ofproto-dpif puts values of these types into the flows that it installs in
 116  * the kernel datapath, though, so ovs-dpctl needs to interpret them so that
 117  * it can print flows in a more human-readable manner. */
 118
 119 enum user_action_cookie_type {
 120     USER_ACTION_COOKIE_UNSPEC,
 121     USER_ACTION_COOKIE_SFLOW,        /* Packet for sFlow sampling. */
 122     USER_ACTION_COOKIE_SLOW_PATH     /* Userspace must process this flow. */
 123 };
 124
 125 /* user_action_cookie is passed as argument to OVS_ACTION_ATTR_USERSPACE.
 126  * Since it is passed to kernel as u64, its size has to be 8 bytes. */
 127 union user_action_cookie {
 128     uint16_t type;              /* enum user_action_cookie_type. */
 129
 130     struct {
 131         uint16_t type;          /* USER_ACTION_COOKIE_SFLOW. */
 132         ovs_be16 vlan_tci;      /* Destination VLAN TCI. */
 133         uint32_t output;        /* SFL_FLOW_SAMPLE_TYPE 'output' value. */
 134     } sflow;
 135
 136     struct {
 137         uint16_t type;          /* USER_ACTION_COOKIE_SLOW_PATH. */
 138         uint16_t unused;
 139         uint32_t reason;        /* enum slow_path_reason. */
 140     } slow_path;
 141 };
 142 BUILD_ASSERT_DECL(sizeof(union user_action_cookie) == 8);
 143
 144 size_t odp_put_userspace_action(uint32_t pid,
 145                                 const union user_action_cookie *,
 146                                 struct ofpbuf *odp_actions);
 147
 148 /* Reasons why a subfacet might not be fast-pathable. */
 149 enum slow_path_reason {
 150     /* These reasons are mutually exclusive. */
 151     SLOW_CFM = 1 << 0,          /* CFM packets need per-packet processing. */
 152     SLOW_LACP = 1 << 1,         /* LACP packets need per-packet processing. */
 153     SLOW_STP = 1 << 2,          /* STP packets need per-packet processing. */
 154     SLOW_IN_BAND = 1 << 3,      /* In-band control needs every packet. */
 155
 156     /* Mutually exclusive with SLOW_CFM, SLOW_LACP, SLOW_STP.
 157      * Could possibly appear with SLOW_IN_BAND. */
 158     SLOW_CONTROLLER = 1 << 4,   /* Packets must go to OpenFlow controller. */
 159
 160     /* This can appear on its own, or, theoretically at least, along with any
 161      * other combination of reasons. */
 162     SLOW_MATCH = 1 << 5,        /* Datapath can't match specifically enough. */
 163 };
 164
 165 #endif /* odp-util.h */