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 bool ofproto_dpif_get_enable_ufid(struct dpif_backer *backer);
  79
  80 struct rule_dpif *rule_dpif_lookup_from_table(struct ofproto_dpif *,
  81                                               struct flow *,
  82                                               struct flow_wildcards *,
  83                                               bool take_ref,
  84                                               const struct dpif_flow_stats *,
  85                                               uint8_t *table_id,
  86                                               ofp_port_t in_port,
  87                                               bool may_packet_in,
  88                                               bool honor_table_miss);
  89
  90 static inline void rule_dpif_ref(struct rule_dpif *);
  91 static inline void rule_dpif_unref(struct rule_dpif *);
  92
  93 void rule_dpif_credit_stats(struct rule_dpif *rule ,
  94                             const struct dpif_flow_stats *);
  95
  96 static inline bool rule_dpif_is_fail_open(const struct rule_dpif *);
  97 static inline bool rule_dpif_is_table_miss(const struct rule_dpif *);
  98 static inline bool rule_dpif_is_internal(const struct rule_dpif *);
  99
 100 uint8_t rule_dpif_get_table(const struct rule_dpif *);
 101
 102 bool table_is_internal(uint8_t table_id);
 103
 104 const struct rule_actions *rule_dpif_get_actions(const struct rule_dpif *);
 105 void rule_set_recirc_id(struct rule *, uint32_t id);
 106
 107 ovs_be64 rule_dpif_get_flow_cookie(const struct rule_dpif *rule);
 108
 109 void rule_dpif_reduce_timeouts(struct rule_dpif *rule, uint16_t idle_timeout,
 110                                uint16_t hard_timeout);
 111
 112 void choose_miss_rule(enum ofputil_port_config,
 113                       struct rule_dpif *miss_rule,
 114                       struct rule_dpif *no_packet_in_rule,
 115                       struct rule_dpif **rule, bool take_ref);
 116
 117 void group_dpif_credit_stats(struct group_dpif *,
 118                              struct ofputil_bucket *,
 119                              const struct dpif_flow_stats *);
 120 bool group_dpif_lookup(struct ofproto_dpif *ofproto, uint32_t group_id,
 121                        struct group_dpif **group);
 122
 123 void group_dpif_get_buckets(const struct group_dpif *group,
 124                             const struct ovs_list **buckets);
 125 enum ofp11_group_type group_dpif_get_type(const struct group_dpif *group);
 126 const char *group_dpif_get_selection_method(const struct group_dpif *group);
 127 uint64_t group_dpif_get_selection_method_param(const struct group_dpif *group);
 128 const struct field_array *group_dpif_get_fields(const struct group_dpif *group);
 129
 130 bool ofproto_has_vlan_splinters(const struct ofproto_dpif *);
 131 ofp_port_t vsp_realdev_to_vlandev(const struct ofproto_dpif *,
 132                                   ofp_port_t realdev_ofp_port,
 133                                   ovs_be16 vlan_tci);
 134 bool vsp_adjust_flow(const struct ofproto_dpif *, struct flow *,
 135                      struct dp_packet *packet);
 136
 137 int ofproto_dpif_execute_actions(struct ofproto_dpif *, const struct flow *,
 138                                  struct rule_dpif *, const struct ofpact *,
 139                                  size_t ofpacts_len, struct dp_packet *);
 140 void ofproto_dpif_send_packet_in(struct ofproto_dpif *,
 141                                  struct ofproto_packet_in *);
 142 bool ofproto_dpif_wants_packet_in_on_miss(struct ofproto_dpif *);
 143 int ofproto_dpif_send_packet(const struct ofport_dpif *, struct dp_packet *);
 144 void ofproto_dpif_flow_mod(struct ofproto_dpif *, struct ofputil_flow_mod *);
 145 struct rule_dpif *ofproto_dpif_refresh_rule(struct rule_dpif *);
 146
 147 struct ofport_dpif *odp_port_to_ofport(const struct dpif_backer *, odp_port_t);
 148 struct ofport_dpif *ofp_port_to_ofport(const struct ofproto_dpif *,
 149                                        ofp_port_t);
 150
 151 int ofproto_dpif_add_internal_flow(struct ofproto_dpif *,
 152                                    const struct match *, int priority,
 153                                    uint16_t idle_timeout,
 154                                    const struct ofpbuf *ofpacts,
 155                                    struct rule **rulep);
 156 int ofproto_dpif_delete_internal_flow(struct ofproto_dpif *, struct match *,
 157                                       int priority);
 158 \f
 159 /* struct rule_dpif has struct rule as it's first member. */
 160 #define RULE_CAST(RULE) ((struct rule *)RULE)
 161 #define GROUP_CAST(GROUP) ((struct ofgroup *)GROUP)
 162
 163 static inline struct group_dpif* group_dpif_ref(struct group_dpif *group)
 164 {
 165     if (group) {
 166         ofproto_group_ref(GROUP_CAST(group));
 167     }
 168     return group;
 169 }
 170
 171 static inline void group_dpif_unref(struct group_dpif *group)
 172 {
 173     if (group) {
 174         ofproto_group_unref(GROUP_CAST(group));
 175     }
 176 }
 177
 178 static inline void rule_dpif_ref(struct rule_dpif *rule)
 179 {
 180     if (rule) {
 181         ofproto_rule_ref(RULE_CAST(rule));
 182     }
 183 }
 184
 185 static inline bool rule_dpif_try_ref(struct rule_dpif *rule)
 186 {
 187     if (rule) {
 188         return ofproto_rule_try_ref(RULE_CAST(rule));
 189     }
 190     return false;
 191 }
 192
 193
 194 static inline void rule_dpif_unref(struct rule_dpif *rule)
 195 {
 196     if (rule) {
 197         ofproto_rule_unref(RULE_CAST(rule));
 198     }
 199 }
 200
 201 static inline bool rule_dpif_is_fail_open(const struct rule_dpif *rule)
 202 {
 203     return is_fail_open_rule(RULE_CAST(rule));
 204 }
 205
 206 static inline bool rule_dpif_is_table_miss(const struct rule_dpif *rule)
 207 {
 208     return rule_is_table_miss(RULE_CAST(rule));
 209 }
 210
 211 /* Returns true if 'rule' is an internal rule, false otherwise. */
 212 static inline bool rule_dpif_is_internal(const struct rule_dpif *rule)
 213 {
 214     return RULE_CAST(rule)->table_id == TBL_INTERNAL;
 215 }
 216
 217 #undef RULE_CAST
 218
 219 bool ovs_native_tunneling_is_on(struct ofproto_dpif *ofproto);
 220 #endif /* ofproto-dpif.h */