+
+/* Metadata for restoring pipeline context after recirculation. Helpers
+ * are inlined below to keep them together with the definition for easier
+ * updates. */
+BUILD_ASSERT_DECL(FLOW_WC_SEQ == 35);
+
+struct recirc_metadata {
+ /* Metadata in struct flow. */
+ const struct flow_tnl *tunnel; /* Encapsulating tunnel parameters. */
+ ovs_be64 metadata; /* OpenFlow Metadata. */
+ uint64_t regs[FLOW_N_XREGS]; /* Registers. */
+ ofp_port_t in_port; /* Incoming port. */
+ ofp_port_t actset_output; /* Output port in action set. */
+};
+
+static inline void
+recirc_metadata_from_flow(struct recirc_metadata *md,
+ const struct flow *flow)
+{
+ memset(md, 0, sizeof *md);
+ md->tunnel = &flow->tunnel;
+ md->metadata = flow->metadata;
+ memcpy(md->regs, flow->regs, sizeof md->regs);
+ md->in_port = flow->in_port.ofp_port;
+ md->actset_output = flow->actset_output;
+}
+
+static inline void
+recirc_metadata_to_flow(const struct recirc_metadata *md,
+ struct flow *flow)
+{
+ if (md->tunnel && flow_tnl_dst_is_set(md->tunnel)) {
+ flow->tunnel = *md->tunnel;
+ } else {
+ memset(&flow->tunnel, 0, sizeof flow->tunnel);
+ }
+ flow->metadata = md->metadata;
+ memcpy(flow->regs, md->regs, sizeof flow->regs);
+ flow->in_port.ofp_port = md->in_port;
+ flow->actset_output = md->actset_output;
+}
+
+/* State that flow translation can save, to restore when recirculation
+ * occurs. */
+struct recirc_state {
+ /* Initial table for post-recirculation processing. */
+ uint8_t table_id;
+
+ /* Pipeline context for post-recirculation processing. */
+ struct ofproto_dpif *ofproto; /* Post-recirculation bridge. */
+ struct recirc_metadata metadata; /* Flow metadata. */
+ struct ofpbuf *stack; /* Stack if any. */
+ mirror_mask_t mirrors; /* Mirrors already output. */
+ bool conntracked; /* Conntrack occurred prior to recirc. */
+
+ /* Actions to be translated on recirculation. */
+ uint32_t action_set_len; /* How much of 'ofpacts' consists of an
+ * action set? */
+ uint32_t ofpacts_len; /* Size of 'ofpacts', in bytes. */
+ struct ofpact *ofpacts; /* Sequence of "struct ofpacts". */
+};
+
+/* This maps a recirculation ID to saved state that flow translation can
+ * restore when recirculation occurs. */
+struct recirc_id_node {
+ /* Index data. */
+ struct ovs_list exp_node OVS_GUARDED;
+ struct cmap_node id_node;
+ struct cmap_node metadata_node;
+ uint32_t id;
+ uint32_t hash;
+ struct ovs_refcount refcount;
+
+ /* Saved state.
+ *
+ * This state should not be modified after inserting a node in the pool,
+ * hence the 'const' to emphasize that. */
+ const struct recirc_state state;
+
+ /* Storage for tunnel metadata. */
+ struct flow_tnl state_metadata_tunnel;
+};
+
+void recirc_init(void);
+
+/* This is only used for bonds and will go away when bonds implementation is
+ * updated to use this mechanism instead of internal rules. */
+uint32_t recirc_alloc_id(struct ofproto_dpif *);
+
+uint32_t recirc_alloc_id_ctx(const struct recirc_state *);
+uint32_t recirc_find_id(const struct recirc_state *);
+void recirc_free_id(uint32_t recirc_id);
+void recirc_free_ofproto(struct ofproto_dpif *, const char *ofproto_name);
+
+const struct recirc_id_node *recirc_id_node_find(uint32_t recirc_id);
+
+static inline bool recirc_id_node_try_ref_rcu(const struct recirc_id_node *n_)
+{
+ struct recirc_id_node *node = CONST_CAST(struct recirc_id_node *, n_);
+
+ return node ? ovs_refcount_try_ref_rcu(&node->refcount) : false;
+}
+
+void recirc_id_node_unref(const struct recirc_id_node *);
+
+void recirc_run(void);
+
+/* Recirculation IDs on which references are held. */
+struct recirc_refs {
+ unsigned n_recircs;
+ union {
+ uint32_t recirc[2]; /* When n_recircs == 1 or 2 */
+ uint32_t *recircs; /* When 'n_recircs' > 2 */
+ };
+};
+
+#define RECIRC_REFS_EMPTY_INITIALIZER ((struct recirc_refs) \
+ { 0, { { 0, 0 } } })
+/* Helpers to abstract the recirculation union away. */
+static inline void
+recirc_refs_init(struct recirc_refs *rr)
+{
+ *rr = RECIRC_REFS_EMPTY_INITIALIZER;
+}
+
+static inline void
+recirc_refs_add(struct recirc_refs *rr, uint32_t id)
+{
+ if (OVS_LIKELY(rr->n_recircs < ARRAY_SIZE(rr->recirc))) {
+ rr->recirc[rr->n_recircs++] = id;
+ } else {
+ if (rr->n_recircs == ARRAY_SIZE(rr->recirc)) {
+ uint32_t *recircs = xmalloc(sizeof rr->recirc + sizeof id);
+
+ memcpy(recircs, rr->recirc, sizeof rr->recirc);
+ rr->recircs = recircs;
+ } else {
+ rr->recircs = xrealloc(rr->recircs,
+ (rr->n_recircs + 1) * sizeof id);
+ }
+ rr->recircs[rr->n_recircs++] = id;
+ }
+}
+
+static inline void
+recirc_refs_swap(struct recirc_refs *a, struct recirc_refs *b)
+{
+ struct recirc_refs tmp;
+
+ tmp = *a;
+ *a = *b;
+ *b = tmp;
+}
+
+static inline void
+recirc_refs_unref(struct recirc_refs *rr)
+{
+ if (OVS_LIKELY(rr->n_recircs <= ARRAY_SIZE(rr->recirc))) {
+ for (int i = 0; i < rr->n_recircs; i++) {
+ recirc_free_id(rr->recirc[i]);
+ }
+ } else {
+ for (int i = 0; i < rr->n_recircs; i++) {
+ recirc_free_id(rr->recircs[i]);
+ }
+ free(rr->recircs);
+ }
+ rr->n_recircs = 0;
+}
+