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 union user_action_cookie;
  31 struct dpif_flow_stats;
  32 struct ofproto;
  33 struct ofproto_dpif;
  34 struct ofproto_packet_in;
  35 struct ofport_dpif;
  36 struct dpif_backer;
  37 struct OVS_LOCKABLE rule_dpif;
  38 struct OVS_LOCKABLE group_dpif;
  39
  40 enum rule_dpif_lookup_verdict {
  41     RULE_DPIF_LOOKUP_VERDICT_MATCH,         /* A match occurred. */
  42     RULE_DPIF_LOOKUP_VERDICT_CONTROLLER,    /* A miss occurred and the packet
  43                                              * should be passed to
  44                                              * the controller. */
  45     RULE_DPIF_LOOKUP_VERDICT_DROP,          /* A miss occurred and the packet
  46                                              * should be dropped. */
  47     RULE_DPIF_LOOKUP_VERDICT_DEFAULT,       /* A miss occurred and the packet
  48                                              * should handled by the default
  49                                              * miss behaviour.
  50                                              * For pre-OF1.3 it should be
  51                                              * forwarded to the controller.
  52                                              * For OF1.3+ it should be
  53                                              * dropped. */
  54 };
  55
  56 /* Number of implemented OpenFlow tables. */
  57 enum { N_TABLES = 255 };
  58 enum { TBL_INTERNAL = N_TABLES - 1 };    /* Used for internal hidden rules. */
  59 BUILD_ASSERT_DECL(N_TABLES >= 2 && N_TABLES <= 255);
  60
  61 /* For lock annotation below only. */
  62 extern struct fat_rwlock xlate_rwlock;
  63
  64 /* Ofproto-dpif -- DPIF based ofproto implementation.
  65  *
  66  * Ofproto-dpif provides an ofproto implementation for those platforms which
  67  * implement the netdev and dpif interface defined in netdev.h and dpif.h.  The
  68  * most important of which is the Linux Kernel Module (dpif-linux), but
  69  * alternatives are supported such as a userspace only implementation
  70  * (dpif-netdev), and a dummy implementation used for unit testing.
  71  *
  72  * Ofproto-dpif is divided into three major chunks.
  73  *
  74  * - ofproto-dpif.c
  75  *   The main ofproto-dpif module is responsible for implementing the
  76  *   provider interface, installing and removing datapath flows, maintaining
  77  *   packet statistics, running protocols (BFD, LACP, STP, etc), and
  78  *   configuring relevant submodules.
  79  *
  80  * - ofproto-dpif-upcall.c
  81  *   Ofproto-dpif-upcall is responsible for retrieving upcalls from the kernel,
  82  *   processing miss upcalls, and handing more complex ones up to the main
  83  *   ofproto-dpif module.  Miss upcall processing boils down to figuring out
  84  *   what each packet's actions are, executing them (i.e. asking the kernel to
  85  *   forward it), and handing it up to ofproto-dpif to decided whether or not
  86  *   to install a kernel flow.
  87  *
  88  * - ofproto-dpif-xlate.c
  89  *   Ofproto-dpif-xlate is responsible for translating OpenFlow actions into
  90  *   datapath actions. */
  91
  92 size_t ofproto_dpif_get_max_mpls_depth(const struct ofproto_dpif *);
  93 bool ofproto_dpif_get_enable_recirc(const struct ofproto_dpif *);
  94
  95 uint8_t rule_dpif_lookup(struct ofproto_dpif *, struct flow *,
  96                          struct flow_wildcards *, struct rule_dpif **rule,
  97                          bool take_ref);
  98
  99 /* If 'recirc_id' is set, starts looking up from internal table for
 100  * post recirculation flows or packets.  Otherwise, starts from table 0. */
 101 static inline uint8_t
 102 rule_dpif_lookup_get_init_table_id(const struct flow *flow)
 103 {
 104     return flow->recirc_id ? TBL_INTERNAL : 0;
 105 }
 106
 107 enum rule_dpif_lookup_verdict rule_dpif_lookup_from_table(struct ofproto_dpif *,
 108                                                           const struct flow *,
 109                                                           struct flow_wildcards *,
 110                                                           bool force_controller_on_miss,
 111                                                           uint8_t *table_id,
 112                                                           struct rule_dpif **rule,
 113                                                           bool take_ref);
 114
 115 static inline void rule_dpif_ref(struct rule_dpif *);
 116 static inline void rule_dpif_unref(struct rule_dpif *);
 117
 118 void rule_dpif_credit_stats(struct rule_dpif *rule ,
 119                             const struct dpif_flow_stats *);
 120
 121 static inline bool rule_dpif_is_fail_open(const struct rule_dpif *);
 122 static inline bool rule_dpif_is_table_miss(const struct rule_dpif *);
 123 static inline bool rule_dpif_is_internal(const struct rule_dpif *);
 124
 125 uint8_t rule_dpif_get_table(const struct rule_dpif *);
 126
 127 bool table_is_internal(uint8_t table_id);
 128
 129 const struct rule_actions *rule_dpif_get_actions(const struct rule_dpif *);
 130
 131 ovs_be64 rule_dpif_get_flow_cookie(const struct rule_dpif *rule);
 132
 133 void rule_dpif_reduce_timeouts(struct rule_dpif *rule, uint16_t idle_timeout,
 134                                uint16_t hard_timeout);
 135
 136 void choose_miss_rule(enum ofputil_port_config,
 137                       struct rule_dpif *miss_rule,
 138                       struct rule_dpif *no_packet_in_rule,
 139                       struct rule_dpif **rule, bool take_ref);
 140
 141 bool group_dpif_lookup(struct ofproto_dpif *ofproto, uint32_t group_id,
 142                        struct group_dpif **group);
 143
 144 void group_dpif_release(struct group_dpif *group);
 145
 146 void group_dpif_get_buckets(const struct group_dpif *group,
 147                             const struct list **buckets);
 148 enum ofp11_group_type group_dpif_get_type(const struct group_dpif *group);
 149
 150 bool ofproto_has_vlan_splinters(const struct ofproto_dpif *);
 151 ofp_port_t vsp_realdev_to_vlandev(const struct ofproto_dpif *,
 152                                   ofp_port_t realdev_ofp_port,
 153                                   ovs_be16 vlan_tci);
 154 bool vsp_adjust_flow(const struct ofproto_dpif *, struct flow *);
 155
 156 int ofproto_dpif_execute_actions(struct ofproto_dpif *, const struct flow *,
 157                                  struct rule_dpif *, const struct ofpact *,
 158                                  size_t ofpacts_len, struct ofpbuf *)
 159     OVS_EXCLUDED(xlate_rwlock);
 160 void ofproto_dpif_send_packet_in(struct ofproto_dpif *,
 161                                  struct ofproto_packet_in *);
 162 bool ofproto_dpif_wants_packet_in_on_miss(struct ofproto_dpif *);
 163 int ofproto_dpif_send_packet(const struct ofport_dpif *, struct ofpbuf *);
 164 void ofproto_dpif_flow_mod(struct ofproto_dpif *, struct ofputil_flow_mod *);
 165 struct rule_dpif *ofproto_dpif_refresh_rule(struct rule_dpif *);
 166
 167 struct ofport_dpif *odp_port_to_ofport(const struct dpif_backer *, odp_port_t);
 168
 169 /*
 170  * Recirculation
 171  * =============
 172  *
 173  * Recirculation is a technique to allow a frame to re-enter the packet
 174  * processing path for one or multiple times to achieve more flexible packet
 175  * processing in the data path. MPLS handling and selecting bond slave port
 176  * of a bond ports.
 177  *
 178  * Data path and user space interface
 179  * -----------------------------------
 180  *
 181  * Two new fields, recirc_id and dp_hash, are added to the current flow data
 182  * structure. They are both of type uint32_t. In addition, a new action,
 183  * RECIRC, are added.
 184  *
 185  * The value recirc_id is used to distinguish a packet from multiple
 186  * iterations of recirculation. A packet initially received is considered of
 187  * having recirc_id of 0. Recirc_id is managed by the user space, opaque to
 188  * the data path.
 189  *
 190  * On the other hand, dp_hash can only be computed by the data path, opaque to
 191  * the user space. In fact, user space may not able to recompute the hash
 192  * value. The dp_hash value should be wildcarded when for a newly received
 193  * packet. RECIRC action specifies whether the hash is computed. If computed,
 194  * how many fields to be included in the hash computation. The computed hash
 195  * value is stored into the dp_hash field prior to recirculation.
 196  *
 197  * The RECIRC action computes and set the dp_hash field, set the recirc_id
 198  * field and then reprocess the packet as if it was received on the same input
 199  * port. RECIRC action works like a function call; actions listed behind the
 200  * RECIRC action will be executed after its execution.  RECIRC action can be
 201  * nested, data path implementation limits the number of recirculation executed
 202  * to prevent unreasonable nesting depth or infinite loop.
 203  *
 204  * Both flow fields and the RECIRC action are exposed as open flow fields via
 205  * Nicira extensions.
 206  *
 207  * Post recirculation flow
 208  * ------------------------
 209  *
 210  * At the open flow level, post recirculation rules are always hidden from the
 211  * controller.  They are installed in table 254 which is set up as a hidden
 212  * table during boot time. Those rules are managed by the local user space
 213  * program only.
 214  *
 215  * To speed up the classifier look up process, recirc_id is always reflected
 216  * into the metadata field, since recirc_id is required to be exactly matched.
 217  *
 218  * Classifier look up always starts with table 254. A post recirculation flow
 219  * lookup should find its hidden rule within this table. On the other hand, A
 220  * newly received packet should miss all post recirculation rules because its
 221  * recirc_id is zero, then hit a pre-installed lower priority rule to redirect
 222  * classifier to look up starting from table 0:
 223  *
 224  *       * , actions=resubmit(,0)
 225  *
 226  * Post recirculation data path flows are managed like other data path flows.
 227  * They are created on demand. Miss handling, stats collection and revalidation
 228  * work the same way as regular flows.
 229  *
 230  * If the bridge which originates the recirculation is different from the bridge
 231  * that receives the post recirculation packet (e.g. when patch port is used),
 232  * the packet will be processed directly by the recirculation bridge with
 233  * in_port set to OFPP_NONE.  Admittedly, doing this limits the recirculation
 234  * bridge from matching on in_port of post recirculation packets, and will be
 235  * fixed in the near future.
 236  *
 237  * TODO: Always restore the correct in_port.
 238  *
 239  */
 240
 241 struct ofproto_dpif *ofproto_dpif_recirc_get_ofproto(const struct dpif_backer *ofproto,
 242                                                      uint32_t recirc_id);
 243 uint32_t ofproto_dpif_alloc_recirc_id(struct ofproto_dpif *ofproto);
 244 void ofproto_dpif_free_recirc_id(struct ofproto_dpif *ofproto, uint32_t recirc_id);
 245 int ofproto_dpif_add_internal_flow(struct ofproto_dpif *,
 246                                    const struct match *, int priority,
 247                                    const struct ofpbuf *ofpacts,
 248                                    struct rule **rulep);
 249 int ofproto_dpif_delete_internal_flow(struct ofproto_dpif *, struct match *,
 250                                       int priority);
 251 \f
 252 /* struct rule_dpif has struct rule as it's first member. */
 253 #define RULE_CAST(RULE) ((struct rule *)RULE)
 254
 255 static inline void rule_dpif_ref(struct rule_dpif *rule)
 256 {
 257     if (rule) {
 258         ofproto_rule_ref(RULE_CAST(rule));
 259     }
 260 }
 261
 262 static inline void rule_dpif_unref(struct rule_dpif *rule)
 263 {
 264     if (rule) {
 265         ofproto_rule_unref(RULE_CAST(rule));
 266     }
 267 }
 268
 269 static inline bool rule_dpif_is_fail_open(const struct rule_dpif *rule)
 270 {
 271     return is_fail_open_rule(RULE_CAST(rule));
 272 }
 273
 274 static inline bool rule_dpif_is_table_miss(const struct rule_dpif *rule)
 275 {
 276     return rule_is_table_miss(RULE_CAST(rule));
 277 }
 278
 279 /* Returns true if 'rule' is an internal rule, false otherwise. */
 280 static inline bool rule_dpif_is_internal(const struct rule_dpif *rule)
 281 {
 282     return RULE_CAST(rule)->table_id == TBL_INTERNAL;
 283 }
 284
 285 #undef RULE_CAST
 286
 287 #endif /* ofproto-dpif.h */