1 /* Copyright (c) 2009, 2010, 2011, 2012, 2013 Nicira, Inc.
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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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. */
15 #ifndef OFPROT_DPIF_XLATE_H
16 #define OFPROT_DPIF_XLATE_H 1
19 #include "meta-flow.h"
22 #include "ofproto-dpif-mirror.h"
23 #include "ofproto-dpif.h"
33 /* Wildcards relevant in translation. Any fields that were used to
34 * calculate the action must be set for caching and kernel
35 * wildcarding to work. For example, if the flow lookup involved
36 * performing the "normal" action on IPv4 and ARP packets, 'wc'
37 * would have the 'in_port' (always set), 'dl_type' (flow match),
38 * 'vlan_tci' (normal action), and 'dl_dst' (normal action) fields
40 struct flow_wildcards wc;
42 enum slow_path_reason slow; /* 0 if fast path may be used. */
43 bool has_learn; /* Actions include NXAST_LEARN? */
44 bool has_normal; /* Actions output to OFPP_NORMAL? */
45 bool has_fin_timeout; /* Actions include NXAST_FIN_TIMEOUT? */
46 ofp_port_t nf_output_iface; /* Output interface index for NetFlow. */
47 mirror_mask_t mirrors; /* Bitmap of associated mirrors. */
49 uint64_t odp_actions_stub[256 / 8];
50 struct ofpbuf odp_actions;
54 struct ofproto_dpif *ofproto;
56 /* Flow to which the OpenFlow actions apply. xlate_actions() will modify
57 * this flow when actions change header fields. */
60 /* The packet corresponding to 'flow', or a null pointer if we are
61 * revalidating without a packet to refer to. */
62 const struct ofpbuf *packet;
64 /* Should OFPP_NORMAL update the MAC learning table? Should "learn"
65 * actions update the flow table?
67 * We want to update these tables if we are actually processing a packet,
68 * or if we are accounting for packets that the datapath has processed, but
69 * not if we are just revalidating. */
72 /* The rule initiating translation or NULL. */
73 struct rule_dpif *rule;
75 /* The actions to translate. If 'rule' is not NULL, these may be NULL. */
76 const struct ofpact *ofpacts;
79 /* Union of the set of TCP flags seen so far in this flow. (Used only by
80 * NXAST_FIN_TIMEOUT. Set to zero to avoid updating updating rules'
84 /* If nonnull, flow translation calls this function just before executing a
85 * resubmit or OFPP_TABLE action. In addition, disables logging of traces
86 * when the recursion depth is exceeded.
88 * 'rule' is the rule being submitted into. It will be null if the
89 * resubmit or OFPP_TABLE action didn't find a matching rule.
91 * 'recurse' is the resubmit recursion depth at time of invocation.
93 * This is normally null so the client has to set it manually after
94 * calling xlate_in_init(). */
95 void (*resubmit_hook)(struct xlate_in *, struct rule_dpif *rule,
98 /* If nonnull, flow translation calls this function to report some
99 * significant decision, e.g. to explain why OFPP_NORMAL translation
100 * dropped a packet. 'recurse' is the resubmit recursion depth at time of
102 void (*report_hook)(struct xlate_in *, const char *s, int recurse);
104 /* If nonnull, flow translation credits the specified statistics to each
105 * rule reached through a resubmit or OFPP_TABLE action.
107 * This is normally null so the client has to set it manually after
108 * calling xlate_in_init(). */
109 const struct dpif_flow_stats *resubmit_stats;
112 void xlate_ofproto_set(struct ofproto_dpif *, const char *name,
113 const struct mac_learning *, struct stp *,
114 const struct mbridge *, const struct dpif_sflow *,
115 const struct dpif_ipfix *, enum ofp_config_flags,
116 bool forward_bpdu, bool has_in_band, bool has_netflow);
117 void xlate_remove_ofproto(struct ofproto_dpif *);
119 void xlate_bundle_set(struct ofproto_dpif *, struct ofbundle *,
120 const char *name, enum port_vlan_mode, int vlan,
121 unsigned long *trunks, bool use_priority_tags,
122 const struct bond *, const struct lacp *,
124 void xlate_bundle_remove(struct ofbundle *);
126 void xlate_ofport_set(struct ofproto_dpif *, struct ofbundle *,
127 struct ofport_dpif *, ofp_port_t, odp_port_t,
128 const struct netdev *, const struct cfm *,
129 const struct bfd *, struct ofport_dpif *peer,
130 int stp_port_no, const struct ofproto_port_queue *qdscp,
131 size_t n_qdscp, enum ofputil_port_config, bool is_tunnel,
133 void xlate_ofport_remove(struct ofport_dpif *);
135 void xlate_actions(struct xlate_in *, struct xlate_out *);
136 void xlate_in_init(struct xlate_in *, struct ofproto_dpif *,
137 const struct flow *, struct rule_dpif *,
138 uint8_t tcp_flags, const struct ofpbuf *packet);
139 void xlate_out_uninit(struct xlate_out *);
140 void xlate_actions_for_side_effects(struct xlate_in *);
141 void xlate_out_copy(struct xlate_out *dst, const struct xlate_out *src);
143 #endif /* ofproto-dpif-xlate.h */