ofproto/ofproto-dpif-xlate.h

   1 /* Copyright (c) 2009, 2010, 2011, 2012, 2013 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 OFPROT_DPIF_XLATE_H
  16 #define OFPROT_DPIF_XLATE_H 1
  17
  18 #include "flow.h"
  19 #include "meta-flow.h"
  20 #include "odp-util.h"
  21 #include "ofpbuf.h"
  22 #include "ofproto-dpif.h"
  23 #include "tag.h"
  24
  25 struct xlate_out {
  26     /* Wildcards relevant in translation.  Any fields that were used to
  27      * calculate the action must be set for caching and kernel
  28      * wildcarding to work.  For example, if the flow lookup involved
  29      * performing the "normal" action on IPv4 and ARP packets, 'wc'
  30      * would have the 'in_port' (always set), 'dl_type' (flow match),
  31      * 'vlan_tci' (normal action), and 'dl_dst' (normal action) fields
  32      * set. */
  33     struct flow_wildcards wc;
  34
  35     tag_type tags;              /* Tags associated with actions. */
  36     enum slow_path_reason slow; /* 0 if fast path may be used. */
  37     bool has_learn;             /* Actions include NXAST_LEARN? */
  38     bool has_normal;            /* Actions output to OFPP_NORMAL? */
  39     bool has_fin_timeout;       /* Actions include NXAST_FIN_TIMEOUT? */
  40     uint16_t nf_output_iface;   /* Output interface index for NetFlow. */
  41     mirror_mask_t mirrors;      /* Bitmap of associated mirrors. */
  42
  43     uint64_t odp_actions_stub[256 / 8];
  44     struct ofpbuf odp_actions;
  45 };
  46
  47 struct xlate_in {
  48     struct ofproto_dpif *ofproto;
  49
  50     /* Flow to which the OpenFlow actions apply.  xlate_actions() will modify
  51      * this flow when actions change header fields. */
  52     struct flow flow;
  53
  54     /* The packet corresponding to 'flow', or a null pointer if we are
  55      * revalidating without a packet to refer to. */
  56     const struct ofpbuf *packet;
  57
  58     /* Should OFPP_NORMAL update the MAC learning table?  Should "learn"
  59      * actions update the flow table?
  60      *
  61      * We want to update these tables if we are actually processing a packet,
  62      * or if we are accounting for packets that the datapath has processed, but
  63      * not if we are just revalidating. */
  64     bool may_learn;
  65
  66     /* The rule initiating translation or NULL. */
  67     struct rule_dpif *rule;
  68
  69     /* The actions to translate.  If 'rule' is not NULL, these may be NULL. */
  70     const struct ofpact *ofpacts;
  71     size_t ofpacts_len;
  72
  73     /* Union of the set of TCP flags seen so far in this flow.  (Used only by
  74      * NXAST_FIN_TIMEOUT.  Set to zero to avoid updating updating rules'
  75      * timeouts.) */
  76     uint8_t tcp_flags;
  77
  78     /* If nonnull, flow translation calls this function just before executing a
  79      * resubmit or OFPP_TABLE action.  In addition, disables logging of traces
  80      * when the recursion depth is exceeded.
  81      *
  82      * 'rule' is the rule being submitted into.  It will be null if the
  83      * resubmit or OFPP_TABLE action didn't find a matching rule.
  84      *
  85      * 'recurse' is the resubmit recursion depth at time of invocation.
  86      *
  87      * This is normally null so the client has to set it manually after
  88      * calling xlate_in_init(). */
  89     void (*resubmit_hook)(struct xlate_in *, struct rule_dpif *rule,
  90                           int recurse);
  91
  92     /* If nonnull, flow translation calls this function to report some
  93      * significant decision, e.g. to explain why OFPP_NORMAL translation
  94      * dropped a packet.  'recurse' is the resubmit recursion depth at time of
  95      * invocation. */
  96     void (*report_hook)(struct xlate_in *, const char *s, int recurse);
  97
  98     /* If nonnull, flow translation credits the specified statistics to each
  99      * rule reached through a resubmit or OFPP_TABLE action.
 100      *
 101      * This is normally null so the client has to set it manually after
 102      * calling xlate_in_init(). */
 103     const struct dpif_flow_stats *resubmit_stats;
 104 };
 105
 106 void xlate_actions(struct xlate_in *, struct xlate_out *);
 107 void xlate_in_init(struct xlate_in *, struct ofproto_dpif *,
 108                    const struct flow *, struct rule_dpif *,
 109                    uint8_t tcp_flags, const struct ofpbuf *packet);
 110 void xlate_out_uninit(struct xlate_out *);
 111 void xlate_actions_for_side_effects(struct xlate_in *);
 112 void xlate_out_copy(struct xlate_out *dst, const struct xlate_out *src);
 113
 114 #endif /* ofproto-dpif-xlate.h */