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 OFPROTO_DPIF_XLATE_H
  16 #define OFPROTO_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-mirror.h"
  23 #include "ofproto-dpif.h"
  24 #include "ofproto.h"
  25 #include "stp.h"
  26
  27 struct bfd;
  28 struct bond;
  29 struct dpif;
  30 struct lacp;
  31 struct dpif_ipfix;
  32 struct dpif_sflow;
  33 struct mac_learning;
  34
  35 struct xlate_out {
  36     /* Wildcards relevant in translation.  Any fields that were used to
  37      * calculate the action must be set for caching and kernel
  38      * wildcarding to work.  For example, if the flow lookup involved
  39      * performing the "normal" action on IPv4 and ARP packets, 'wc'
  40      * would have the 'in_port' (always set), 'dl_type' (flow match),
  41      * 'vlan_tci' (normal action), and 'dl_dst' (normal action) fields
  42      * set. */
  43     struct flow_wildcards wc;
  44
  45     enum slow_path_reason slow; /* 0 if fast path may be used. */
  46     bool fail_open;             /* Initial rule is fail open? */
  47     bool has_learn;             /* Actions include NXAST_LEARN? */
  48     bool has_normal;            /* Actions output to OFPP_NORMAL? */
  49     bool has_fin_timeout;       /* Actions include NXAST_FIN_TIMEOUT? */
  50     ofp_port_t nf_output_iface; /* Output interface index for NetFlow. */
  51     mirror_mask_t mirrors;      /* Bitmap of associated mirrors. */
  52
  53     uint64_t odp_actions_stub[256 / 8];
  54     struct ofpbuf odp_actions;
  55 };
  56
  57 struct xlate_in {
  58     struct ofproto_dpif *ofproto;
  59
  60     /* Flow to which the OpenFlow actions apply.  xlate_actions() will modify
  61      * this flow when actions change header fields. */
  62     struct flow flow;
  63
  64     /* The packet corresponding to 'flow', or a null pointer if we are
  65      * revalidating without a packet to refer to. */
  66     const struct ofpbuf *packet;
  67
  68     /* Should OFPP_NORMAL update the MAC learning table?  Should "learn"
  69      * actions update the flow table?
  70      *
  71      * We want to update these tables if we are actually processing a packet,
  72      * or if we are accounting for packets that the datapath has processed, but
  73      * not if we are just revalidating. */
  74     bool may_learn;
  75
  76     /* If the caller of xlate_actions() doesn't need the flow_wildcards
  77      * contained in struct xlate_out.  'skip_wildcards' can be set to true
  78      * disabling the expensive wildcard computation.  When true, 'wc' in struct
  79      * xlate_out is undefined and should not be read. */
  80     bool skip_wildcards;
  81
  82     /* The rule initiating translation or NULL. If both 'rule' and 'ofpacts'
  83      * are NULL, xlate_actions() will do the initial rule lookup itself. */
  84     struct rule_dpif *rule;
  85
  86     /* The actions to translate.  If 'rule' is not NULL, these may be NULL. */
  87     const struct ofpact *ofpacts;
  88     size_t ofpacts_len;
  89
  90     /* Union of the set of TCP flags seen so far in this flow.  (Used only by
  91      * NXAST_FIN_TIMEOUT.  Set to zero to avoid updating updating rules'
  92      * timeouts.) */
  93     uint16_t tcp_flags;
  94
  95     /* If nonnull, flow translation calls this function just before executing a
  96      * resubmit or OFPP_TABLE action.  In addition, disables logging of traces
  97      * when the recursion depth is exceeded.
  98      *
  99      * 'rule' is the rule being submitted into.  It will be null if the
 100      * resubmit or OFPP_TABLE action didn't find a matching rule.
 101      *
 102      * 'recurse' is the resubmit recursion depth at time of invocation.
 103      *
 104      * This is normally null so the client has to set it manually after
 105      * calling xlate_in_init(). */
 106     void (*resubmit_hook)(struct xlate_in *, struct rule_dpif *rule,
 107                           int recurse);
 108
 109     /* If nonnull, flow translation calls this function to report some
 110      * significant decision, e.g. to explain why OFPP_NORMAL translation
 111      * dropped a packet.  'recurse' is the resubmit recursion depth at time of
 112      * invocation. */
 113     void (*report_hook)(struct xlate_in *, const char *s, int recurse);
 114
 115     /* If nonnull, flow translation credits the specified statistics to each
 116      * rule reached through a resubmit or OFPP_TABLE action.
 117      *
 118      * This is normally null so the client has to set it manually after
 119      * calling xlate_in_init(). */
 120     const struct dpif_flow_stats *resubmit_stats;
 121 };
 122
 123 extern struct ovs_rwlock xlate_rwlock;
 124
 125 void xlate_ofproto_set(struct ofproto_dpif *, const char *name,
 126                        struct dpif *, struct rule_dpif *miss_rule,
 127                        struct rule_dpif *no_packet_in_rule,
 128                        const struct mac_learning *, struct stp *,
 129                        const struct mbridge *, const struct dpif_sflow *,
 130                        const struct dpif_ipfix *, const struct netflow *,
 131                        enum ofp_config_flags, bool forward_bpdu,
 132                        bool has_in_band, bool variable_length_userdata)
 133     OVS_REQ_WRLOCK(xlate_rwlock);
 134 void xlate_remove_ofproto(struct ofproto_dpif *) OVS_REQ_WRLOCK(xlate_rwlock);
 135
 136 void xlate_bundle_set(struct ofproto_dpif *, struct ofbundle *,
 137                       const char *name, enum port_vlan_mode, int vlan,
 138                       unsigned long *trunks, bool use_priority_tags,
 139                       const struct bond *, const struct lacp *,
 140                       bool floodable) OVS_REQ_WRLOCK(xlate_rwlock);
 141 void xlate_bundle_remove(struct ofbundle *) OVS_REQ_WRLOCK(xlate_rwlock);
 142
 143 void xlate_ofport_set(struct ofproto_dpif *, struct ofbundle *,
 144                       struct ofport_dpif *, ofp_port_t, odp_port_t,
 145                       const struct netdev *, const struct cfm *,
 146                       const struct bfd *, struct ofport_dpif *peer,
 147                       int stp_port_no, const struct ofproto_port_queue *qdscp,
 148                       size_t n_qdscp, enum ofputil_port_config,
 149                       enum ofputil_port_state, bool is_tunnel,
 150                       bool may_enable) OVS_REQ_WRLOCK(xlate_rwlock);
 151 void xlate_ofport_remove(struct ofport_dpif *) OVS_REQ_WRLOCK(xlate_rwlock);
 152
 153 int xlate_receive(const struct dpif_backer *, struct ofpbuf *packet,
 154                   const struct nlattr *key, size_t key_len,
 155                   struct flow *, enum odp_key_fitness *,
 156                   struct ofproto_dpif **, struct dpif_ipfix **,
 157                   struct dpif_sflow **, struct netflow **,
 158                   odp_port_t *odp_in_port)
 159     OVS_EXCLUDED(xlate_rwlock);
 160
 161 void xlate_actions(struct xlate_in *, struct xlate_out *)
 162     OVS_EXCLUDED(xlate_rwlock);
 163 void xlate_in_init(struct xlate_in *, struct ofproto_dpif *,
 164                    const struct flow *, struct rule_dpif *, uint16_t tcp_flags,
 165                    const struct ofpbuf *packet);
 166 void xlate_out_uninit(struct xlate_out *);
 167 void xlate_actions_for_side_effects(struct xlate_in *);
 168 void xlate_out_copy(struct xlate_out *dst, const struct xlate_out *src);
 169
 170 int xlate_send_packet(const struct ofport_dpif *, struct ofpbuf *);
 171
 172 #endif /* ofproto-dpif-xlate.h */