-/* Copyright (c) 2009, 2010, 2011, 2012, 2013 Nicira, Inc.
+/* Copyright (c) 2009, 2010, 2011, 2012, 2013, 2014, 2015 Nicira, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* See the License for the specific language governing permissions and
* limitations under the License. */
-#ifndef OFPROT_DPIF_XLATE_H
-#define OFPROT_DPIF_XLATE_H 1
+#ifndef OFPROTO_DPIF_XLATE_H
+#define OFPROTO_DPIF_XLATE_H 1
+#include "dp-packet.h"
#include "flow.h"
#include "meta-flow.h"
#include "odp-util.h"
#include "ofpbuf.h"
+#include "ofproto-dpif-mirror.h"
+#include "ofproto-dpif-rid.h"
#include "ofproto-dpif.h"
-#include "tag.h"
+#include "ofproto.h"
+#include "stp.h"
+#include "ovs-lldp.h"
-/* Maximum depth of flow table recursion (due to resubmit actions) in a
- * flow translation. */
-#define MAX_RESUBMIT_RECURSION 64
-
-struct xlate_ctx;
+struct bfd;
+struct bond;
+struct dpif;
+struct lacp;
+struct dpif_ipfix;
+struct dpif_sflow;
+struct mac_learning;
+struct mcast_snooping;
+struct xlate_cache;
struct xlate_out {
- /* Wildcards relevant in translation. Any fields that were used to
- * calculate the action must be set for caching and kernel
- * wildcarding to work. For example, if the flow lookup involved
- * performing the "normal" action on IPv4 and ARP packets, 'wc'
- * would have the 'in_port' (always set), 'dl_type' (flow match),
- * 'vlan_tci' (normal action), and 'dl_dst' (normal action) fields
- * set. */
- struct flow_wildcards wc;
-
- tag_type tags; /* Tags associated with actions. */
enum slow_path_reason slow; /* 0 if fast path may be used. */
- bool has_learn; /* Actions include NXAST_LEARN? */
- bool has_normal; /* Actions output to OFPP_NORMAL? */
- bool has_fin_timeout; /* Actions include NXAST_FIN_TIMEOUT? */
- uint16_t nf_output_iface; /* Output interface index for NetFlow. */
- mirror_mask_t mirrors; /* Bitmap of associated mirrors. */
-
- uint64_t odp_actions_stub[256 / 8];
- struct ofpbuf odp_actions;
+ bool fail_open; /* Initial rule is fail open? */
+
+ /* Recirculation IDs on which references are held. */
+ unsigned n_recircs;
+ union {
+ uint32_t recirc[2]; /* When n_recircs == 1 or 2 */
+ uint32_t *recircs; /* When 'n_recircs' > 2 */
+ };
};
+/* Helpers to abstract the recirculation union away. */
+static inline void
+xlate_out_add_recirc(struct xlate_out *xout, uint32_t id)
+{
+ if (OVS_LIKELY(xout->n_recircs < ARRAY_SIZE(xout->recirc))) {
+ xout->recirc[xout->n_recircs++] = id;
+ } else {
+ if (xout->n_recircs == ARRAY_SIZE(xout->recirc)) {
+ uint32_t *recircs = xmalloc(sizeof xout->recirc + sizeof id);
+
+ memcpy(recircs, xout->recirc, sizeof xout->recirc);
+ xout->recircs = recircs;
+ } else {
+ xout->recircs = xrealloc(xout->recircs,
+ (xout->n_recircs + 1) * sizeof id);
+ }
+ xout->recircs[xout->n_recircs++] = id;
+ }
+}
+
+static inline const uint32_t *
+xlate_out_get_recircs(const struct xlate_out *xout)
+{
+ if (OVS_LIKELY(xout->n_recircs <= ARRAY_SIZE(xout->recirc))) {
+ return xout->recirc;
+ } else {
+ return xout->recircs;
+ }
+}
+
+static inline void
+xlate_out_take_recircs(struct xlate_out *xout)
+{
+ if (OVS_UNLIKELY(xout->n_recircs > ARRAY_SIZE(xout->recirc))) {
+ free(xout->recircs);
+ }
+ xout->n_recircs = 0;
+}
+
+static inline void
+xlate_out_free_recircs(struct xlate_out *xout)
+{
+ if (OVS_LIKELY(xout->n_recircs <= ARRAY_SIZE(xout->recirc))) {
+ for (int i = 0; i < xout->n_recircs; i++) {
+ recirc_free_id(xout->recirc[i]);
+ }
+ } else {
+ for (int i = 0; i < xout->n_recircs; i++) {
+ recirc_free_id(xout->recircs[i]);
+ }
+ free(xout->recircs);
+ }
+}
+
struct xlate_in {
struct ofproto_dpif *ofproto;
/* The packet corresponding to 'flow', or a null pointer if we are
* revalidating without a packet to refer to. */
- const struct ofpbuf *packet;
+ const struct dp_packet *packet;
/* Should OFPP_NORMAL update the MAC learning table? Should "learn"
* actions update the flow table?
* not if we are just revalidating. */
bool may_learn;
- /* The rule initiating translation or NULL. */
+ /* The rule initiating translation or NULL. If both 'rule' and 'ofpacts'
+ * are NULL, xlate_actions() will do the initial rule lookup itself. */
struct rule_dpif *rule;
/* The actions to translate. If 'rule' is not NULL, these may be NULL. */
/* Union of the set of TCP flags seen so far in this flow. (Used only by
* NXAST_FIN_TIMEOUT. Set to zero to avoid updating updating rules'
* timeouts.) */
- uint8_t tcp_flags;
+ uint16_t tcp_flags;
/* If nonnull, flow translation calls this function just before executing a
* resubmit or OFPP_TABLE action. In addition, disables logging of traces
* 'rule' is the rule being submitted into. It will be null if the
* resubmit or OFPP_TABLE action didn't find a matching rule.
*
+ * 'recurse' is the resubmit recursion depth at time of invocation.
+ *
* This is normally null so the client has to set it manually after
* calling xlate_in_init(). */
- void (*resubmit_hook)(struct xlate_ctx *, struct rule_dpif *rule);
+ void (*resubmit_hook)(struct xlate_in *, struct rule_dpif *rule,
+ int recurse);
/* If nonnull, flow translation calls this function to report some
* significant decision, e.g. to explain why OFPP_NORMAL translation
- * dropped a packet. */
- void (*report_hook)(struct xlate_ctx *, const char *s);
+ * dropped a packet. 'recurse' is the resubmit recursion depth at time of
+ * invocation. */
+ void (*report_hook)(struct xlate_in *, int recurse,
+ const char *format, va_list args);
/* If nonnull, flow translation credits the specified statistics to each
* rule reached through a resubmit or OFPP_TABLE action.
* This is normally null so the client has to set it manually after
* calling xlate_in_init(). */
const struct dpif_flow_stats *resubmit_stats;
-};
-/* Context used by xlate_actions() and its callees. */
-struct xlate_ctx {
- struct xlate_in *xin;
- struct xlate_out *xout;
+ /* Recursion and resubmission levels carried over from a pre-existing
+ * translation of a related flow. An example of when this can occur is
+ * the translation of an ARP packet that was generated as the result of
+ * outputting to a tunnel port. In this case, the original flow going to
+ * the tunnel is the related flow. Since the two flows are different, they
+ * should not use the same xlate_ctx structure. However, we still need
+ * limit the maximum recursion across the entire translation.
+ *
+ * These fields are normally set to zero, so the client has to set them
+ * manually after calling xlate_in_init(). In that case, they should be
+ * copied from the same-named fields in the related flow's xlate_ctx. */
+ int recurse;
+ int resubmits;
- struct ofproto_dpif *ofproto;
+ /* If nonnull, flow translation populates this cache with references to all
+ * modules that are affected by translation. This 'xlate_cache' may be
+ * passed to xlate_push_stats() to perform the same function as
+ * xlate_actions() without the full cost of translation.
+ *
+ * This is normally null so the client has to set it manually after
+ * calling xlate_in_init(). */
+ struct xlate_cache *xcache;
- /* Flow at the last commit. */
- struct flow base_flow;
+ /* If nonnull, flow translation puts the resulting datapath actions in this
+ * buffer. If null, flow translation will not produce datapath actions. */
+ struct ofpbuf *odp_actions;
- /* Tunnel IP destination address as received. This is stored separately
- * as the base_flow.tunnel is cleared on init to reflect the datapath
- * behavior. Used to make sure not to send tunneled output to ourselves,
- * which might lead to an infinite loop. This could happen easily
- * if a tunnel is marked as 'ip_remote=flow', and the flow does not
- * actually set the tun_dst field. */
- ovs_be32 orig_tunnel_ip_dst;
+ /* If nonnull, flow translation populates this with wildcards relevant in
+ * translation. Any fields that were used to calculate the action are set,
+ * to allow caching and kernel wildcarding to work. For example, if the
+ * flow lookup involved performing the "normal" action on IPv4 and ARP
+ * packets, 'wc' would have the 'in_port' (always set), 'dl_type' (flow
+ * match), 'vlan_tci' (normal action), and 'dl_dst' (normal action) fields
+ * set. */
+ struct flow_wildcards *wc;
- /* Stack for the push and pop actions. Each stack element is of type
- * "union mf_subvalue". */
- union mf_subvalue init_stack[1024 / sizeof(union mf_subvalue)];
- struct ofpbuf stack;
+ /* The recirculation context related to this translation, as returned by
+ * xlate_lookup. */
+ const struct recirc_id_node *recirc;
+};
- /* The rule that we are currently translating, or NULL. */
- struct rule_dpif *rule;
+void xlate_ofproto_set(struct ofproto_dpif *, const char *name, struct dpif *,
+ const struct mac_learning *, struct stp *,
+ struct rstp *, const struct mcast_snooping *,
+ const struct mbridge *, const struct dpif_sflow *,
+ const struct dpif_ipfix *, const struct netflow *,
+ bool forward_bpdu, bool has_in_band,
+ const struct dpif_backer_support *support);
+void xlate_remove_ofproto(struct ofproto_dpif *);
- int recurse; /* Recursion level, via xlate_table_action. */
- bool max_resubmit_trigger; /* Recursed too deeply during translation. */
- uint32_t orig_skb_priority; /* Priority when packet arrived. */
- uint8_t table_id; /* OpenFlow table ID where flow was found. */
- uint32_t sflow_n_outputs; /* Number of output ports. */
- uint32_t sflow_odp_port; /* Output port for composing sFlow action. */
- uint16_t user_cookie_offset;/* Used for user_action_cookie fixup. */
- bool exit; /* No further actions should be processed. */
-};
+void xlate_bundle_set(struct ofproto_dpif *, struct ofbundle *,
+ const char *name, enum port_vlan_mode, int vlan,
+ unsigned long *trunks, bool use_priority_tags,
+ const struct bond *, const struct lacp *,
+ bool floodable);
+void xlate_bundle_remove(struct ofbundle *);
+
+void xlate_ofport_set(struct ofproto_dpif *, struct ofbundle *,
+ struct ofport_dpif *, ofp_port_t, odp_port_t,
+ const struct netdev *, const struct cfm *, const struct bfd *,
+ const struct lldp *, struct ofport_dpif *peer,
+ int stp_port_no, const struct rstp_port *rstp_port,
+ const struct ofproto_port_queue *qdscp,
+ size_t n_qdscp, enum ofputil_port_config,
+ enum ofputil_port_state, bool is_tunnel,
+ bool may_enable);
+void xlate_ofport_remove(struct ofport_dpif *);
+
+struct ofproto_dpif * xlate_lookup_ofproto(const struct dpif_backer *,
+ const struct flow *,
+ ofp_port_t *ofp_in_port);
+int xlate_lookup(const struct dpif_backer *, const struct flow *,
+ struct ofproto_dpif **, struct dpif_ipfix **,
+ struct dpif_sflow **, struct netflow **,
+ ofp_port_t *ofp_in_port);
void xlate_actions(struct xlate_in *, struct xlate_out *);
void xlate_in_init(struct xlate_in *, struct ofproto_dpif *,
- const struct flow *, struct rule_dpif *,
- uint8_t tcp_flags, const struct ofpbuf *packet);
+ const struct flow *, ofp_port_t in_port, struct rule_dpif *,
+ uint16_t tcp_flags, const struct dp_packet *packet,
+ struct flow_wildcards *, struct ofpbuf *odp_actions);
void xlate_out_uninit(struct xlate_out *);
void xlate_actions_for_side_effects(struct xlate_in *);
-void xlate_out_copy(struct xlate_out *dst, const struct xlate_out *src);
+
+int xlate_send_packet(const struct ofport_dpif *, struct dp_packet *);
+
+struct xlate_cache *xlate_cache_new(void);
+void xlate_push_stats(struct xlate_cache *, const struct dpif_flow_stats *);
+void xlate_cache_clear(struct xlate_cache *);
+void xlate_cache_delete(struct xlate_cache *);
+
+void xlate_txn_start(void);
+void xlate_txn_commit(void);
#endif /* ofproto-dpif-xlate.h */