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 OFPROTO_DPIF_XLATE_H
16 #define OFPROTO_DPIF_XLATE_H 1
19 #include "meta-flow.h"
22 #include "ofproto-dpif-mirror.h"
23 #include "ofproto-dpif.h"
34 /* Wildcards relevant in translation. Any fields that were used to
35 * calculate the action must be set for caching and kernel
36 * wildcarding to work. For example, if the flow lookup involved
37 * performing the "normal" action on IPv4 and ARP packets, 'wc'
38 * would have the 'in_port' (always set), 'dl_type' (flow match),
39 * 'vlan_tci' (normal action), and 'dl_dst' (normal action) fields
41 struct flow_wildcards wc;
43 enum slow_path_reason slow; /* 0 if fast path may be used. */
44 bool has_learn; /* Actions include NXAST_LEARN? */
45 bool has_normal; /* Actions output to OFPP_NORMAL? */
46 bool has_fin_timeout; /* Actions include NXAST_FIN_TIMEOUT? */
47 ofp_port_t nf_output_iface; /* Output interface index for NetFlow. */
48 mirror_mask_t mirrors; /* Bitmap of associated mirrors. */
50 uint64_t odp_actions_stub[256 / 8];
51 struct ofpbuf odp_actions;
55 struct ofproto_dpif *ofproto;
57 /* Flow to which the OpenFlow actions apply. xlate_actions() will modify
58 * this flow when actions change header fields. */
61 /* The packet corresponding to 'flow', or a null pointer if we are
62 * revalidating without a packet to refer to. */
63 const struct ofpbuf *packet;
65 /* Should OFPP_NORMAL update the MAC learning table? Should "learn"
66 * actions update the flow table?
68 * We want to update these tables if we are actually processing a packet,
69 * or if we are accounting for packets that the datapath has processed, but
70 * not if we are just revalidating. */
73 /* The rule initiating translation or NULL. */
74 struct rule_dpif *rule;
76 /* The actions to translate. If 'rule' is not NULL, these may be NULL. */
77 const struct ofpact *ofpacts;
80 /* Union of the set of TCP flags seen so far in this flow. (Used only by
81 * NXAST_FIN_TIMEOUT. Set to zero to avoid updating updating rules'
85 /* If nonnull, flow translation calls this function just before executing a
86 * resubmit or OFPP_TABLE action. In addition, disables logging of traces
87 * when the recursion depth is exceeded.
89 * 'rule' is the rule being submitted into. It will be null if the
90 * resubmit or OFPP_TABLE action didn't find a matching rule.
92 * 'recurse' is the resubmit recursion depth at time of invocation.
94 * This is normally null so the client has to set it manually after
95 * calling xlate_in_init(). */
96 void (*resubmit_hook)(struct xlate_in *, struct rule_dpif *rule,
99 /* If nonnull, flow translation calls this function to report some
100 * significant decision, e.g. to explain why OFPP_NORMAL translation
101 * dropped a packet. 'recurse' is the resubmit recursion depth at time of
103 void (*report_hook)(struct xlate_in *, const char *s, int recurse);
105 /* If nonnull, flow translation credits the specified statistics to each
106 * rule reached through a resubmit or OFPP_TABLE action.
108 * This is normally null so the client has to set it manually after
109 * calling xlate_in_init(). */
110 const struct dpif_flow_stats *resubmit_stats;
113 extern struct ovs_rwlock xlate_rwlock;
115 void xlate_ofproto_set(struct ofproto_dpif *, const char *name,
116 struct dpif *, struct rule_dpif *miss_rule,
117 struct rule_dpif *no_packet_in_rule,
118 const struct mac_learning *, struct stp *,
119 const struct mbridge *, const struct dpif_sflow *,
120 const struct dpif_ipfix *, enum ofp_config_flags,
121 bool forward_bpdu, bool has_in_band, bool has_netflow)
122 OVS_REQ_WRLOCK(xlate_rwlock);
123 void xlate_remove_ofproto(struct ofproto_dpif *) OVS_REQ_WRLOCK(xlate_rwlock);
125 void xlate_bundle_set(struct ofproto_dpif *, struct ofbundle *,
126 const char *name, enum port_vlan_mode, int vlan,
127 unsigned long *trunks, bool use_priority_tags,
128 const struct bond *, const struct lacp *,
129 bool floodable) OVS_REQ_WRLOCK(xlate_rwlock);
130 void xlate_bundle_remove(struct ofbundle *) OVS_REQ_WRLOCK(xlate_rwlock);
132 void xlate_ofport_set(struct ofproto_dpif *, struct ofbundle *,
133 struct ofport_dpif *, ofp_port_t, odp_port_t,
134 const struct netdev *, const struct cfm *,
135 const struct bfd *, struct ofport_dpif *peer,
136 int stp_port_no, const struct ofproto_port_queue *qdscp,
137 size_t n_qdscp, enum ofputil_port_config, bool is_tunnel,
138 bool may_enable) OVS_REQ_WRLOCK(xlate_rwlock);
139 void xlate_ofport_remove(struct ofport_dpif *) OVS_REQ_WRLOCK(xlate_rwlock);
141 int xlate_receive(const struct dpif_backer *, struct ofpbuf *packet,
142 const struct nlattr *key, size_t key_len,
143 struct flow *, enum odp_key_fitness *,
144 struct ofproto_dpif **, odp_port_t *odp_in_port)
145 OVS_EXCLUDED(xlate_rwlock);
147 void xlate_actions(struct xlate_in *, struct xlate_out *)
148 OVS_EXCLUDED(xlate_rwlock);
149 void xlate_in_init(struct xlate_in *, struct ofproto_dpif *,
150 const struct flow *, struct rule_dpif *,
151 uint8_t tcp_flags, const struct ofpbuf *packet);
152 void xlate_out_uninit(struct xlate_out *);
153 void xlate_actions_for_side_effects(struct xlate_in *);
154 void xlate_out_copy(struct xlate_out *dst, const struct xlate_out *src);
155 #endif /* ofproto-dpif-xlate.h */