ofproto/ofproto-dpif.h

   1 /* Copyright (c) 2009, 2010, 2011, 2012, 2013, 2014 Nicira, Inc.
   2  *
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License. */
  14
  15 #ifndef OFPROTO_DPIF_H
  16 #define OFPROTO_DPIF_H 1
  17
  18 #include <stdint.h>
  19
  20 #include "fail-open.h"
  21 #include "hmapx.h"
  22 #include "odp-util.h"
  23 #include "ofp-util.h"
  24 #include "ovs-thread.h"
  25 #include "ofproto-provider.h"
  26 #include "timer.h"
  27 #include "util.h"
  28 #include "ovs-thread.h"
  29
  30 /* Priority for internal rules created to handle recirculation */
  31 #define RECIRC_RULE_PRIORITY 20
  32
  33 union user_action_cookie;
  34 struct dpif_flow_stats;
  35 struct ofproto;
  36 struct ofproto_dpif;
  37 struct ofproto_packet_in;
  38 struct ofport_dpif;
  39 struct dpif_backer;
  40 struct OVS_LOCKABLE rule_dpif;
  41 struct OVS_LOCKABLE group_dpif;
  42
  43 /* Number of implemented OpenFlow tables. */
  44 enum { N_TABLES = 255 };
  45 enum { TBL_INTERNAL = N_TABLES - 1 };    /* Used for internal hidden rules. */
  46 BUILD_ASSERT_DECL(N_TABLES >= 2 && N_TABLES <= 255);
  47
  48 /* Ofproto-dpif -- DPIF based ofproto implementation.
  49  *
  50  * Ofproto-dpif provides an ofproto implementation for those platforms which
  51  * implement the netdev and dpif interface defined in netdev.h and dpif.h.  The
  52  * most important of which is the Linux Kernel Module (dpif-linux), but
  53  * alternatives are supported such as a userspace only implementation
  54  * (dpif-netdev), and a dummy implementation used for unit testing.
  55  *
  56  * Ofproto-dpif is divided into three major chunks.
  57  *
  58  * - ofproto-dpif.c
  59  *   The main ofproto-dpif module is responsible for implementing the
  60  *   provider interface, installing and removing datapath flows, maintaining
  61  *   packet statistics, running protocols (BFD, LACP, STP, etc), and
  62  *   configuring relevant submodules.
  63  *
  64  * - ofproto-dpif-upcall.c
  65  *   Ofproto-dpif-upcall is responsible for retrieving upcalls from the kernel,
  66  *   processing miss upcalls, and handing more complex ones up to the main
  67  *   ofproto-dpif module.  Miss upcall processing boils down to figuring out
  68  *   what each packet's actions are, executing them (i.e. asking the kernel to
  69  *   forward it), and handing it up to ofproto-dpif to decided whether or not
  70  *   to install a kernel flow.
  71  *
  72  * - ofproto-dpif-xlate.c
  73  *   Ofproto-dpif-xlate is responsible for translating OpenFlow actions into
  74  *   datapath actions. */
  75
  76 size_t ofproto_dpif_get_max_mpls_depth(const struct ofproto_dpif *);
  77 bool ofproto_dpif_get_enable_recirc(const struct ofproto_dpif *);
  78
  79 struct rule_dpif *rule_dpif_lookup(struct ofproto_dpif *, struct flow *,
  80                                    struct flow_wildcards *, bool take_ref,
  81                                    const struct dpif_flow_stats *,
  82                                    uint8_t *table_id);
  83
  84 struct rule_dpif *rule_dpif_lookup_from_table(struct ofproto_dpif *,
  85                                               struct flow *,
  86                                               struct flow_wildcards *,
  87                                               bool take_ref,
  88                                               const struct dpif_flow_stats *,
  89                                               uint8_t *table_id,
  90                                               ofp_port_t in_port,
  91                                               bool may_packet_in,
  92                                               bool honor_table_miss);
  93
  94 /* If 'recirc_id' is set, starts looking up from internal table for
  95  * post recirculation flows or packets.  Otherwise, starts from table 0. */
  96 static inline uint8_t
  97 rule_dpif_lookup_get_init_table_id(const struct flow *flow)
  98 {
  99     return flow->recirc_id ? TBL_INTERNAL : 0;
 100 }
 101
 102 static inline void rule_dpif_ref(struct rule_dpif *);
 103 static inline void rule_dpif_unref(struct rule_dpif *);
 104
 105 void rule_dpif_credit_stats(struct rule_dpif *rule ,
 106                             const struct dpif_flow_stats *);
 107
 108 static inline bool rule_dpif_is_fail_open(const struct rule_dpif *);
 109 static inline bool rule_dpif_is_table_miss(const struct rule_dpif *);
 110 static inline bool rule_dpif_is_internal(const struct rule_dpif *);
 111
 112 uint8_t rule_dpif_get_table(const struct rule_dpif *);
 113
 114 bool table_is_internal(uint8_t table_id);
 115
 116 const struct rule_actions *rule_dpif_get_actions(const struct rule_dpif *);
 117 uint32_t rule_dpif_get_recirc_id(struct rule_dpif *);
 118 void rule_set_recirc_id(struct rule *, uint32_t id);
 119
 120 ovs_be64 rule_dpif_get_flow_cookie(const struct rule_dpif *rule);
 121
 122 void rule_dpif_reduce_timeouts(struct rule_dpif *rule, uint16_t idle_timeout,
 123                                uint16_t hard_timeout);
 124
 125 void choose_miss_rule(enum ofputil_port_config,
 126                       struct rule_dpif *miss_rule,
 127                       struct rule_dpif *no_packet_in_rule,
 128                       struct rule_dpif **rule, bool take_ref);
 129
 130 void group_dpif_credit_stats(struct group_dpif *,
 131                              struct ofputil_bucket *,
 132                              const struct dpif_flow_stats *);
 133 bool group_dpif_lookup(struct ofproto_dpif *ofproto, uint32_t group_id,
 134                        struct group_dpif **group);
 135
 136 void group_dpif_get_buckets(const struct group_dpif *group,
 137                             const struct list **buckets);
 138 enum ofp11_group_type group_dpif_get_type(const struct group_dpif *group);
 139
 140 bool ofproto_has_vlan_splinters(const struct ofproto_dpif *);
 141 ofp_port_t vsp_realdev_to_vlandev(const struct ofproto_dpif *,
 142                                   ofp_port_t realdev_ofp_port,
 143                                   ovs_be16 vlan_tci);
 144 bool vsp_adjust_flow(const struct ofproto_dpif *, struct flow *,
 145                      struct ofpbuf *packet);
 146
 147 int ofproto_dpif_execute_actions(struct ofproto_dpif *, const struct flow *,
 148                                  struct rule_dpif *, const struct ofpact *,
 149                                  size_t ofpacts_len, struct ofpbuf *);
 150 void ofproto_dpif_send_packet_in(struct ofproto_dpif *,
 151                                  struct ofproto_packet_in *);
 152 bool ofproto_dpif_wants_packet_in_on_miss(struct ofproto_dpif *);
 153 int ofproto_dpif_send_packet(const struct ofport_dpif *, struct ofpbuf *);
 154 void ofproto_dpif_flow_mod(struct ofproto_dpif *, struct ofputil_flow_mod *);
 155 struct rule_dpif *ofproto_dpif_refresh_rule(struct rule_dpif *);
 156
 157 struct ofport_dpif *odp_port_to_ofport(const struct dpif_backer *, odp_port_t);
 158
 159 /*
 160  * Recirculation
 161  * =============
 162  *
 163  * Recirculation is a technique to allow a frame to re-enter the packet
 164  * processing path for one or multiple times to achieve more flexible packet
 165  * processing in the data path. MPLS handling and selecting bond slave port
 166  * of a bond ports.
 167  *
 168  * Data path and user space interface
 169  * -----------------------------------
 170  *
 171  * Two new fields, recirc_id and dp_hash, are added to the current flow data
 172  * structure. They are both of type uint32_t. In addition, a new action,
 173  * RECIRC, are added.
 174  *
 175  * The value recirc_id is used to distinguish a packet from multiple
 176  * iterations of recirculation. A packet initially received is considered of
 177  * having recirc_id of 0. Recirc_id is managed by the user space, opaque to
 178  * the data path.
 179  *
 180  * On the other hand, dp_hash can only be computed by the data path, opaque to
 181  * the user space. In fact, user space may not able to recompute the hash
 182  * value. The dp_hash value should be wildcarded when for a newly received
 183  * packet. RECIRC action specifies whether the hash is computed. If computed,
 184  * how many fields to be included in the hash computation. The computed hash
 185  * value is stored into the dp_hash field prior to recirculation.
 186  *
 187  * The RECIRC action computes and set the dp_hash field, set the recirc_id
 188  * field and then reprocess the packet as if it was received on the same input
 189  * port. RECIRC action works like a function call; actions listed behind the
 190  * RECIRC action will be executed after its execution.  RECIRC action can be
 191  * nested, data path implementation limits the number of recirculation executed
 192  * to prevent unreasonable nesting depth or infinite loop.
 193  *
 194  * Both flow fields and the RECIRC action are exposed as OpenFlow fields via
 195  * Nicira extensions.
 196  *
 197  * Post recirculation flow
 198  * ------------------------
 199  *
 200  * At the OpenFlow level, post recirculation rules are always hidden from the
 201  * controller.  They are installed in table 254 which is set up as a hidden
 202  * table during boot time. Those rules are managed by the local user space
 203  * program only.
 204  *
 205  * To speed up the classifier look up process, recirc_id is always reflected
 206  * into the metadata field, since recirc_id is required to be exactly matched.
 207  *
 208  * Classifier look up always starts with table 254. A post recirculation flow
 209  * lookup should find its hidden rule within this table. On the other hand, A
 210  * newly received packet should miss all post recirculation rules because its
 211  * recirc_id is zero, then hit a pre-installed lower priority rule to redirect
 212  * classifier to look up starting from table 0:
 213  *
 214  *       * , actions=resubmit(,0)
 215  *
 216  * Post recirculation data path flows are managed like other data path flows.
 217  * They are created on demand. Miss handling, stats collection and revalidation
 218  * work the same way as regular flows.
 219  */
 220
 221 uint32_t ofproto_dpif_alloc_recirc_id(struct ofproto_dpif *ofproto);
 222 void ofproto_dpif_free_recirc_id(struct ofproto_dpif *ofproto, uint32_t recirc_id);
 223 int ofproto_dpif_add_internal_flow(struct ofproto_dpif *,
 224                                    const struct match *, int priority,
 225                                    uint16_t idle_timeout,
 226                                    const struct ofpbuf *ofpacts,
 227                                    struct rule **rulep);
 228 int ofproto_dpif_delete_internal_flow(struct ofproto_dpif *, struct match *,
 229                                       int priority);
 230 \f
 231 /* struct rule_dpif has struct rule as it's first member. */
 232 #define RULE_CAST(RULE) ((struct rule *)RULE)
 233 #define GROUP_CAST(GROUP) ((struct ofgroup *)GROUP)
 234
 235 static inline struct group_dpif* group_dpif_ref(struct group_dpif *group)
 236 {
 237     if (group) {
 238         ofproto_group_ref(GROUP_CAST(group));
 239     }
 240     return group;
 241 }
 242
 243 static inline void group_dpif_unref(struct group_dpif *group)
 244 {
 245     if (group) {
 246         ofproto_group_unref(GROUP_CAST(group));
 247     }
 248 }
 249
 250 static inline void rule_dpif_ref(struct rule_dpif *rule)
 251 {
 252     if (rule) {
 253         ofproto_rule_ref(RULE_CAST(rule));
 254     }
 255 }
 256
 257 static inline bool rule_dpif_try_ref(struct rule_dpif *rule)
 258 {
 259     if (rule) {
 260         return ofproto_rule_try_ref(RULE_CAST(rule));
 261     }
 262     return false;
 263 }
 264
 265
 266 static inline void rule_dpif_unref(struct rule_dpif *rule)
 267 {
 268     if (rule) {
 269         ofproto_rule_unref(RULE_CAST(rule));
 270     }
 271 }
 272
 273 static inline bool rule_dpif_is_fail_open(const struct rule_dpif *rule)
 274 {
 275     return is_fail_open_rule(RULE_CAST(rule));
 276 }
 277
 278 static inline bool rule_dpif_is_table_miss(const struct rule_dpif *rule)
 279 {
 280     return rule_is_table_miss(RULE_CAST(rule));
 281 }
 282
 283 /* Returns true if 'rule' is an internal rule, false otherwise. */
 284 static inline bool rule_dpif_is_internal(const struct rule_dpif *rule)
 285 {
 286     return RULE_CAST(rule)->table_id == TBL_INTERNAL;
 287 }
 288
 289 #undef RULE_CAST
 290
 291 bool ovs_native_tunneling_is_on(struct ofproto_dpif *ofproto);
 292 #endif /* ofproto-dpif.h */