ofproto/ofproto-dpif-xlate.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_XLATE_H
  16 #define OFPROTO_DPIF_XLATE_H 1
  17
  18 #include "dp-packet.h"
  19 #include "flow.h"
  20 #include "meta-flow.h"
  21 #include "odp-util.h"
  22 #include "ofpbuf.h"
  23 #include "ofproto-dpif-mirror.h"
  24 #include "ofproto-dpif-rid.h"
  25 #include "ofproto-dpif.h"
  26 #include "ofproto.h"
  27 #include "stp.h"
  28 #include "ovs-lldp.h"
  29
  30 struct bfd;
  31 struct bond;
  32 struct dpif;
  33 struct lacp;
  34 struct dpif_ipfix;
  35 struct dpif_sflow;
  36 struct mac_learning;
  37 struct mcast_snooping;
  38 struct xlate_cache;
  39
  40 struct xlate_out {
  41     enum slow_path_reason slow; /* 0 if fast path may be used. */
  42     bool fail_open;             /* Initial rule is fail open? */
  43
  44     /* Recirculation IDs on which references are held. */
  45     unsigned n_recircs;
  46     union {
  47         uint32_t recirc[2];   /* When n_recircs == 1 or 2 */
  48         uint32_t *recircs;    /* When 'n_recircs' > 2 */
  49     };
  50 };
  51
  52 /* Helpers to abstract the recirculation union away. */
  53 static inline void
  54 xlate_out_add_recirc(struct xlate_out *xout, uint32_t id)
  55 {
  56     if (OVS_LIKELY(xout->n_recircs < ARRAY_SIZE(xout->recirc))) {
  57         xout->recirc[xout->n_recircs++] = id;
  58     } else {
  59         if (xout->n_recircs == ARRAY_SIZE(xout->recirc)) {
  60             uint32_t *recircs = xmalloc(sizeof xout->recirc + sizeof id);
  61
  62             memcpy(recircs, xout->recirc, sizeof xout->recirc);
  63             xout->recircs = recircs;
  64         } else {
  65             xout->recircs = xrealloc(xout->recircs,
  66                                      (xout->n_recircs + 1) * sizeof id);
  67         }
  68         xout->recircs[xout->n_recircs++] = id;
  69     }
  70 }
  71
  72 static inline const uint32_t *
  73 xlate_out_get_recircs(const struct xlate_out *xout)
  74 {
  75     if (OVS_LIKELY(xout->n_recircs <= ARRAY_SIZE(xout->recirc))) {
  76         return xout->recirc;
  77     } else {
  78         return xout->recircs;
  79     }
  80 }
  81
  82 static inline void
  83 xlate_out_take_recircs(struct xlate_out *xout)
  84 {
  85     if (OVS_UNLIKELY(xout->n_recircs > ARRAY_SIZE(xout->recirc))) {
  86         free(xout->recircs);
  87     }
  88     xout->n_recircs = 0;
  89 }
  90
  91 static inline void
  92 xlate_out_free_recircs(struct xlate_out *xout)
  93 {
  94     if (OVS_LIKELY(xout->n_recircs <= ARRAY_SIZE(xout->recirc))) {
  95         for (int i = 0; i < xout->n_recircs; i++) {
  96             recirc_free_id(xout->recirc[i]);
  97         }
  98     } else {
  99         for (int i = 0; i < xout->n_recircs; i++) {
 100             recirc_free_id(xout->recircs[i]);
 101         }
 102         free(xout->recircs);
 103     }
 104 }
 105
 106 struct xlate_in {
 107     struct ofproto_dpif *ofproto;
 108
 109     /* Flow to which the OpenFlow actions apply.  xlate_actions() will modify
 110      * this flow when actions change header fields. */
 111     struct flow flow;
 112
 113     /* The packet corresponding to 'flow', or a null pointer if we are
 114      * revalidating without a packet to refer to. */
 115     const struct dp_packet *packet;
 116
 117     /* Should OFPP_NORMAL update the MAC learning table?  Should "learn"
 118      * actions update the flow table?
 119      *
 120      * We want to update these tables if we are actually processing a packet,
 121      * or if we are accounting for packets that the datapath has processed, but
 122      * not if we are just revalidating. */
 123     bool may_learn;
 124
 125     /* The rule initiating translation or NULL. If both 'rule' and 'ofpacts'
 126      * are NULL, xlate_actions() will do the initial rule lookup itself. */
 127     struct rule_dpif *rule;
 128
 129     /* The actions to translate.  If 'rule' is not NULL, these may be NULL. */
 130     const struct ofpact *ofpacts;
 131     size_t ofpacts_len;
 132
 133     /* Union of the set of TCP flags seen so far in this flow.  (Used only by
 134      * NXAST_FIN_TIMEOUT.  Set to zero to avoid updating updating rules'
 135      * timeouts.) */
 136     uint16_t tcp_flags;
 137
 138     /* If nonnull, flow translation calls this function just before executing a
 139      * resubmit or OFPP_TABLE action.  In addition, disables logging of traces
 140      * when the recursion depth is exceeded.
 141      *
 142      * 'rule' is the rule being submitted into.  It will be null if the
 143      * resubmit or OFPP_TABLE action didn't find a matching rule.
 144      *
 145      * 'recurse' is the resubmit recursion depth at time of invocation.
 146      *
 147      * This is normally null so the client has to set it manually after
 148      * calling xlate_in_init(). */
 149     void (*resubmit_hook)(struct xlate_in *, struct rule_dpif *rule,
 150                           int recurse);
 151
 152     /* If nonnull, flow translation calls this function to report some
 153      * significant decision, e.g. to explain why OFPP_NORMAL translation
 154      * dropped a packet.  'recurse' is the resubmit recursion depth at time of
 155      * invocation. */
 156     void (*report_hook)(struct xlate_in *, int recurse,
 157                         const char *format, va_list args);
 158
 159     /* If nonnull, flow translation credits the specified statistics to each
 160      * rule reached through a resubmit or OFPP_TABLE action.
 161      *
 162      * This is normally null so the client has to set it manually after
 163      * calling xlate_in_init(). */
 164     const struct dpif_flow_stats *resubmit_stats;
 165
 166     /* Recursion and resubmission levels carried over from a pre-existing
 167      * translation of a related flow. An example of when this can occur is
 168      * the translation of an ARP packet that was generated as the result of
 169      * outputting to a tunnel port. In this case, the original flow going to
 170      * the tunnel is the related flow. Since the two flows are different, they
 171      * should not use the same xlate_ctx structure. However, we still need
 172      * limit the maximum recursion across the entire translation.
 173      *
 174      * These fields are normally set to zero, so the client has to set them
 175      * manually after calling xlate_in_init(). In that case, they should be
 176      * copied from the same-named fields in the related flow's xlate_ctx. */
 177     int recurse;
 178     int resubmits;
 179
 180     /* If nonnull, flow translation populates this cache with references to all
 181      * modules that are affected by translation. This 'xlate_cache' may be
 182      * passed to xlate_push_stats() to perform the same function as
 183      * xlate_actions() without the full cost of translation.
 184      *
 185      * This is normally null so the client has to set it manually after
 186      * calling xlate_in_init(). */
 187     struct xlate_cache *xcache;
 188
 189     /* If nonnull, flow translation puts the resulting datapath actions in this
 190      * buffer.  If null, flow translation will not produce datapath actions. */
 191     struct ofpbuf *odp_actions;
 192
 193     /* If nonnull, flow translation populates this with wildcards relevant in
 194      * translation.  Any fields that were used to calculate the action are set,
 195      * to allow caching and kernel wildcarding to work.  For example, if the
 196      * flow lookup involved performing the "normal" action on IPv4 and ARP
 197      * packets, 'wc' would have the 'in_port' (always set), 'dl_type' (flow
 198      * match), 'vlan_tci' (normal action), and 'dl_dst' (normal action) fields
 199      * set. */
 200     struct flow_wildcards *wc;
 201
 202     /* The recirculation context related to this translation, as returned by
 203      * xlate_lookup. */
 204     const struct recirc_id_node *recirc;
 205 };
 206
 207 void xlate_ofproto_set(struct ofproto_dpif *, const char *name, struct dpif *,
 208                        const struct mac_learning *, struct stp *,
 209                        struct rstp *, const struct mcast_snooping *,
 210                        const struct mbridge *, const struct dpif_sflow *,
 211                        const struct dpif_ipfix *, const struct netflow *,
 212                        bool forward_bpdu, bool has_in_band,
 213                        const struct dpif_backer_support *support);
 214 void xlate_remove_ofproto(struct ofproto_dpif *);
 215
 216 void xlate_bundle_set(struct ofproto_dpif *, struct ofbundle *,
 217                       const char *name, enum port_vlan_mode, int vlan,
 218                       unsigned long *trunks, bool use_priority_tags,
 219                       const struct bond *, const struct lacp *,
 220                       bool floodable);
 221 void xlate_bundle_remove(struct ofbundle *);
 222
 223 void xlate_ofport_set(struct ofproto_dpif *, struct ofbundle *,
 224                       struct ofport_dpif *, ofp_port_t, odp_port_t,
 225                       const struct netdev *, const struct cfm *, const struct bfd *,
 226                       const struct lldp *, struct ofport_dpif *peer,
 227                       int stp_port_no, const struct rstp_port *rstp_port,
 228                       const struct ofproto_port_queue *qdscp,
 229                       size_t n_qdscp, enum ofputil_port_config,
 230                       enum ofputil_port_state, bool is_tunnel,
 231                       bool may_enable);
 232 void xlate_ofport_remove(struct ofport_dpif *);
 233
 234 struct ofproto_dpif * xlate_lookup_ofproto(const struct dpif_backer *,
 235                                            const struct flow *,
 236                                            ofp_port_t *ofp_in_port);
 237 int xlate_lookup(const struct dpif_backer *, const struct flow *,
 238                  struct ofproto_dpif **, struct dpif_ipfix **,
 239                  struct dpif_sflow **, struct netflow **,
 240                  ofp_port_t *ofp_in_port);
 241
 242 void xlate_actions(struct xlate_in *, struct xlate_out *);
 243 void xlate_in_init(struct xlate_in *, struct ofproto_dpif *,
 244                    const struct flow *, ofp_port_t in_port, struct rule_dpif *,
 245                    uint16_t tcp_flags, const struct dp_packet *packet,
 246                    struct flow_wildcards *, struct ofpbuf *odp_actions);
 247 void xlate_out_uninit(struct xlate_out *);
 248 void xlate_actions_for_side_effects(struct xlate_in *);
 249
 250 int xlate_send_packet(const struct ofport_dpif *, struct dp_packet *);
 251
 252 struct xlate_cache *xlate_cache_new(void);
 253 void xlate_push_stats(struct xlate_cache *, const struct dpif_flow_stats *);
 254 void xlate_cache_clear(struct xlate_cache *);
 255 void xlate_cache_delete(struct xlate_cache *);
 256
 257 void xlate_txn_start(void);
 258 void xlate_txn_commit(void);
 259
 260 #endif /* ofproto-dpif-xlate.h */