bond: Use correct type for slave's change_seq.
[cascardo/ovs.git] / 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     struct recirc_refs recircs; /* Recirc action IDs on which references are
45                                  * held. */
46 };
47
48 struct xlate_in {
49     struct ofproto_dpif *ofproto;
50
51     /* Flow to which the OpenFlow actions apply.  xlate_actions() will modify
52      * this flow when actions change header fields. */
53     struct flow flow;
54
55     /* The packet corresponding to 'flow', or a null pointer if we are
56      * revalidating without a packet to refer to. */
57     const struct dp_packet *packet;
58
59     /* Should OFPP_NORMAL update the MAC learning table?  Should "learn"
60      * actions update the flow table?
61      *
62      * We want to update these tables if we are actually processing a packet,
63      * or if we are accounting for packets that the datapath has processed, but
64      * not if we are just revalidating. */
65     bool may_learn;
66
67     /* The rule initiating translation or NULL. If both 'rule' and 'ofpacts'
68      * are NULL, xlate_actions() will do the initial rule lookup itself. */
69     struct rule_dpif *rule;
70
71     /* The actions to translate.  If 'rule' is not NULL, these may be NULL. */
72     const struct ofpact *ofpacts;
73     size_t ofpacts_len;
74
75     /* Union of the set of TCP flags seen so far in this flow.  (Used only by
76      * NXAST_FIN_TIMEOUT.  Set to zero to avoid updating updating rules'
77      * timeouts.) */
78     uint16_t tcp_flags;
79
80     /* If nonnull, flow translation calls this function just before executing a
81      * resubmit or OFPP_TABLE action.  In addition, disables logging of traces
82      * when the recursion depth is exceeded.
83      *
84      * 'rule' is the rule being submitted into.  It will be null if the
85      * resubmit or OFPP_TABLE action didn't find a matching rule.
86      *
87      * 'recurse' is the resubmit recursion depth at time of invocation.
88      *
89      * This is normally null so the client has to set it manually after
90      * calling xlate_in_init(). */
91     void (*resubmit_hook)(struct xlate_in *, struct rule_dpif *rule,
92                           int recurse);
93
94     /* If nonnull, flow translation calls this function to report some
95      * significant decision, e.g. to explain why OFPP_NORMAL translation
96      * dropped a packet.  'recurse' is the resubmit recursion depth at time of
97      * invocation. */
98     void (*report_hook)(struct xlate_in *, int recurse,
99                         const char *format, va_list args);
100
101     /* If nonnull, flow translation credits the specified statistics to each
102      * rule reached through a resubmit or OFPP_TABLE action.
103      *
104      * This is normally null so the client has to set it manually after
105      * calling xlate_in_init(). */
106     const struct dpif_flow_stats *resubmit_stats;
107
108     /* Recursion and resubmission levels carried over from a pre-existing
109      * translation of a related flow. An example of when this can occur is
110      * the translation of an ARP packet that was generated as the result of
111      * outputting to a tunnel port. In this case, the original flow going to
112      * the tunnel is the related flow. Since the two flows are different, they
113      * should not use the same xlate_ctx structure. However, we still need
114      * limit the maximum recursion across the entire translation.
115      *
116      * These fields are normally set to zero, so the client has to set them
117      * manually after calling xlate_in_init(). In that case, they should be
118      * copied from the same-named fields in the related flow's xlate_ctx. */
119     int recurse;
120     int resubmits;
121
122     /* If nonnull, flow translation populates this cache with references to all
123      * modules that are affected by translation. This 'xlate_cache' may be
124      * passed to xlate_push_stats() to perform the same function as
125      * xlate_actions() without the full cost of translation.
126      *
127      * This is normally null so the client has to set it manually after
128      * calling xlate_in_init(). */
129     struct xlate_cache *xcache;
130
131     /* If nonnull, flow translation puts the resulting datapath actions in this
132      * buffer.  If null, flow translation will not produce datapath actions. */
133     struct ofpbuf *odp_actions;
134
135     /* If nonnull, flow translation populates this with wildcards relevant in
136      * translation.  Any fields that were used to calculate the action are set,
137      * to allow caching and kernel wildcarding to work.  For example, if the
138      * flow lookup involved performing the "normal" action on IPv4 and ARP
139      * packets, 'wc' would have the 'in_port' (always set), 'dl_type' (flow
140      * match), 'vlan_tci' (normal action), and 'dl_dst' (normal action) fields
141      * set. */
142     struct flow_wildcards *wc;
143
144     /* The recirculation context related to this translation, as returned by
145      * xlate_lookup. */
146     const struct recirc_id_node *recirc;
147 };
148
149 void xlate_ofproto_set(struct ofproto_dpif *, const char *name, struct dpif *,
150                        const struct mac_learning *, struct stp *,
151                        struct rstp *, const struct mcast_snooping *,
152                        const struct mbridge *, const struct dpif_sflow *,
153                        const struct dpif_ipfix *, const struct netflow *,
154                        bool forward_bpdu, bool has_in_band,
155                        const struct dpif_backer_support *support);
156 void xlate_remove_ofproto(struct ofproto_dpif *);
157
158 void xlate_bundle_set(struct ofproto_dpif *, struct ofbundle *,
159                       const char *name, enum port_vlan_mode, int vlan,
160                       unsigned long *trunks, bool use_priority_tags,
161                       const struct bond *, const struct lacp *,
162                       bool floodable);
163 void xlate_bundle_remove(struct ofbundle *);
164
165 void xlate_ofport_set(struct ofproto_dpif *, struct ofbundle *,
166                       struct ofport_dpif *, ofp_port_t, odp_port_t,
167                       const struct netdev *, const struct cfm *, const struct bfd *,
168                       const struct lldp *, struct ofport_dpif *peer,
169                       int stp_port_no, const struct rstp_port *rstp_port,
170                       const struct ofproto_port_queue *qdscp,
171                       size_t n_qdscp, enum ofputil_port_config,
172                       enum ofputil_port_state, bool is_tunnel,
173                       bool may_enable);
174 void xlate_ofport_remove(struct ofport_dpif *);
175
176 struct ofproto_dpif * xlate_lookup_ofproto(const struct dpif_backer *,
177                                            const struct flow *,
178                                            ofp_port_t *ofp_in_port);
179 int xlate_lookup(const struct dpif_backer *, const struct flow *,
180                  struct ofproto_dpif **, struct dpif_ipfix **,
181                  struct dpif_sflow **, struct netflow **,
182                  ofp_port_t *ofp_in_port);
183
184 enum xlate_error {
185     XLATE_OK = 0,
186     XLATE_BRIDGE_NOT_FOUND,
187     XLATE_RECURSION_TOO_DEEP,
188     XLATE_TOO_MANY_RESUBMITS,
189     XLATE_STACK_TOO_DEEP,
190     XLATE_NO_RECIRCULATION_CONTEXT,
191     XLATE_RECIRCULATION_CONFLICT,
192     XLATE_TOO_MANY_MPLS_LABELS,
193 };
194
195 const char *xlate_strerror(enum xlate_error error);
196
197 enum xlate_error xlate_actions(struct xlate_in *, struct xlate_out *);
198
199 void xlate_in_init(struct xlate_in *, struct ofproto_dpif *,
200                    const struct flow *, ofp_port_t in_port, struct rule_dpif *,
201                    uint16_t tcp_flags, const struct dp_packet *packet,
202                    struct flow_wildcards *, struct ofpbuf *odp_actions);
203 void xlate_out_uninit(struct xlate_out *);
204 void xlate_actions_for_side_effects(struct xlate_in *);
205
206 int xlate_send_packet(const struct ofport_dpif *, struct dp_packet *);
207
208 struct xlate_cache *xlate_cache_new(void);
209 void xlate_push_stats(struct xlate_cache *, const struct dpif_flow_stats *);
210 void xlate_cache_clear(struct xlate_cache *);
211 void xlate_cache_delete(struct xlate_cache *);
212
213 void xlate_txn_start(void);
214 void xlate_txn_commit(void);
215
216 #endif /* ofproto-dpif-xlate.h */