ofproto/ofproto-dpif.h

   1 /* Copyright (c) 2009, 2010, 2011, 2012, 2013, 2014, 2015 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 /* Stores the various features which the corresponding backer supports. */
  77 struct dpif_backer_support {
  78     /* True if the datapath supports variable-length
  79      * OVS_USERSPACE_ATTR_USERDATA in OVS_ACTION_ATTR_USERSPACE actions.
  80      * False if the datapath supports only 8-byte (or shorter) userdata. */
  81     bool variable_length_userdata;
  82
  83     /* Maximum number of MPLS label stack entries that the datapath supports
  84      * in a match */
  85     size_t max_mpls_depth;
  86
  87     /* True if the datapath supports masked data in OVS_ACTION_ATTR_SET
  88      * actions. */
  89     bool masked_set_action;
  90
  91     /* True if the datapath supports recirculation. */
  92     bool recirc;
  93
  94     /* True if the datapath supports tnl_push and pop actions. */
  95     bool tnl_push_pop;
  96
  97     /* True if the datapath supports OVS_FLOW_ATTR_UFID. */
  98     bool ufid;
  99 };
 100
 101 size_t ofproto_dpif_get_max_mpls_depth(const struct ofproto_dpif *);
 102 bool ofproto_dpif_get_enable_recirc(const struct ofproto_dpif *);
 103 bool ofproto_dpif_get_enable_ufid(struct dpif_backer *backer);
 104
 105 cls_version_t ofproto_dpif_get_tables_version(struct ofproto_dpif *);
 106
 107 struct rule_dpif *rule_dpif_lookup_from_table(struct ofproto_dpif *,
 108                                               cls_version_t, struct flow *,
 109                                               struct flow_wildcards *,
 110                                               bool take_ref,
 111                                               const struct dpif_flow_stats *,
 112                                               uint8_t *table_id,
 113                                               ofp_port_t in_port,
 114                                               bool may_packet_in,
 115                                               bool honor_table_miss);
 116
 117 static inline void rule_dpif_ref(struct rule_dpif *);
 118 static inline void rule_dpif_unref(struct rule_dpif *);
 119
 120 void rule_dpif_credit_stats(struct rule_dpif *rule ,
 121                             const struct dpif_flow_stats *);
 122
 123 static inline bool rule_dpif_is_fail_open(const struct rule_dpif *);
 124 static inline bool rule_dpif_is_table_miss(const struct rule_dpif *);
 125 static inline bool rule_dpif_is_internal(const struct rule_dpif *);
 126
 127 uint8_t rule_dpif_get_table(const struct rule_dpif *);
 128
 129 bool table_is_internal(uint8_t table_id);
 130
 131 const struct rule_actions *rule_dpif_get_actions(const struct rule_dpif *);
 132 void rule_set_recirc_id(struct rule *, uint32_t id);
 133
 134 ovs_be64 rule_dpif_get_flow_cookie(const struct rule_dpif *rule);
 135
 136 void rule_dpif_reduce_timeouts(struct rule_dpif *rule, uint16_t idle_timeout,
 137                                uint16_t hard_timeout);
 138
 139 void choose_miss_rule(enum ofputil_port_config,
 140                       struct rule_dpif *miss_rule,
 141                       struct rule_dpif *no_packet_in_rule,
 142                       struct rule_dpif **rule, bool take_ref);
 143
 144 void group_dpif_credit_stats(struct group_dpif *,
 145                              struct ofputil_bucket *,
 146                              const struct dpif_flow_stats *);
 147 bool group_dpif_lookup(struct ofproto_dpif *ofproto, uint32_t group_id,
 148                        struct group_dpif **group);
 149
 150 void group_dpif_get_buckets(const struct group_dpif *group,
 151                             const struct ovs_list **buckets);
 152 enum ofp11_group_type group_dpif_get_type(const struct group_dpif *group);
 153 const char *group_dpif_get_selection_method(const struct group_dpif *group);
 154 uint64_t group_dpif_get_selection_method_param(const struct group_dpif *group);
 155 const struct field_array *group_dpif_get_fields(const struct group_dpif *group);
 156
 157 bool ofproto_has_vlan_splinters(const struct ofproto_dpif *);
 158 ofp_port_t vsp_realdev_to_vlandev(const struct ofproto_dpif *,
 159                                   ofp_port_t realdev_ofp_port,
 160                                   ovs_be16 vlan_tci);
 161 bool vsp_adjust_flow(const struct ofproto_dpif *, struct flow *,
 162                      struct dp_packet *packet);
 163
 164 int ofproto_dpif_execute_actions(struct ofproto_dpif *, const struct flow *,
 165                                  struct rule_dpif *, const struct ofpact *,
 166                                  size_t ofpacts_len, struct dp_packet *);
 167 void ofproto_dpif_send_packet_in(struct ofproto_dpif *,
 168                                  struct ofproto_packet_in *);
 169 bool ofproto_dpif_wants_packet_in_on_miss(struct ofproto_dpif *);
 170 int ofproto_dpif_send_packet(const struct ofport_dpif *, struct dp_packet *);
 171 void ofproto_dpif_flow_mod(struct ofproto_dpif *, struct ofputil_flow_mod *);
 172 struct rule_dpif *ofproto_dpif_refresh_rule(struct rule_dpif *);
 173
 174 struct ofport_dpif *odp_port_to_ofport(const struct dpif_backer *, odp_port_t);
 175 struct ofport_dpif *ofp_port_to_ofport(const struct ofproto_dpif *,
 176                                        ofp_port_t);
 177
 178 int ofproto_dpif_add_internal_flow(struct ofproto_dpif *,
 179                                    const struct match *, int priority,
 180                                    uint16_t idle_timeout,
 181                                    const struct ofpbuf *ofpacts,
 182                                    struct rule **rulep);
 183 int ofproto_dpif_delete_internal_flow(struct ofproto_dpif *, struct match *,
 184                                       int priority);
 185 \f
 186 /* struct rule_dpif has struct rule as it's first member. */
 187 #define RULE_CAST(RULE) ((struct rule *)RULE)
 188 #define GROUP_CAST(GROUP) ((struct ofgroup *)GROUP)
 189
 190 static inline struct group_dpif* group_dpif_ref(struct group_dpif *group)
 191 {
 192     if (group) {
 193         ofproto_group_ref(GROUP_CAST(group));
 194     }
 195     return group;
 196 }
 197
 198 static inline void group_dpif_unref(struct group_dpif *group)
 199 {
 200     if (group) {
 201         ofproto_group_unref(GROUP_CAST(group));
 202     }
 203 }
 204
 205 static inline void rule_dpif_ref(struct rule_dpif *rule)
 206 {
 207     if (rule) {
 208         ofproto_rule_ref(RULE_CAST(rule));
 209     }
 210 }
 211
 212 static inline bool rule_dpif_try_ref(struct rule_dpif *rule)
 213 {
 214     if (rule) {
 215         return ofproto_rule_try_ref(RULE_CAST(rule));
 216     }
 217     return false;
 218 }
 219
 220
 221 static inline void rule_dpif_unref(struct rule_dpif *rule)
 222 {
 223     if (rule) {
 224         ofproto_rule_unref(RULE_CAST(rule));
 225     }
 226 }
 227
 228 static inline bool rule_dpif_is_fail_open(const struct rule_dpif *rule)
 229 {
 230     return is_fail_open_rule(RULE_CAST(rule));
 231 }
 232
 233 static inline bool rule_dpif_is_table_miss(const struct rule_dpif *rule)
 234 {
 235     return rule_is_table_miss(RULE_CAST(rule));
 236 }
 237
 238 /* Returns true if 'rule' is an internal rule, false otherwise. */
 239 static inline bool rule_dpif_is_internal(const struct rule_dpif *rule)
 240 {
 241     return RULE_CAST(rule)->table_id == TBL_INTERNAL;
 242 }
 243
 244 #undef RULE_CAST
 245
 246 bool ovs_native_tunneling_is_on(struct ofproto_dpif *ofproto);
 247 #endif /* ofproto-dpif.h */