ofproto/ofproto-dpif-xlate.c

   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 #include <config.h>
  16
  17 #include "ofproto/ofproto-dpif-xlate.h"
  18
  19 #include <errno.h>
  20 #include <arpa/inet.h>
  21 #include <net/if.h>
  22 #include <sys/socket.h>
  23 #include <netinet/in.h>
  24
  25 #include "tnl-arp-cache.h"
  26 #include "bfd.h"
  27 #include "bitmap.h"
  28 #include "bond.h"
  29 #include "bundle.h"
  30 #include "byte-order.h"
  31 #include "cfm.h"
  32 #include "connmgr.h"
  33 #include "coverage.h"
  34 #include "dp-packet.h"
  35 #include "dpif.h"
  36 #include "dynamic-string.h"
  37 #include "in-band.h"
  38 #include "lacp.h"
  39 #include "learn.h"
  40 #include "list.h"
  41 #include "ovs-lldp.h"
  42 #include "mac-learning.h"
  43 #include "mcast-snooping.h"
  44 #include "meta-flow.h"
  45 #include "multipath.h"
  46 #include "netdev-vport.h"
  47 #include "netlink.h"
  48 #include "nx-match.h"
  49 #include "odp-execute.h"
  50 #include "ofp-actions.h"
  51 #include "ofproto/ofproto-dpif-ipfix.h"
  52 #include "ofproto/ofproto-dpif-mirror.h"
  53 #include "ofproto/ofproto-dpif-monitor.h"
  54 #include "ofproto/ofproto-dpif-sflow.h"
  55 #include "ofproto/ofproto-dpif.h"
  56 #include "ofproto/ofproto-provider.h"
  57 #include "ovs-router.h"
  58 #include "tnl-ports.h"
  59 #include "tunnel.h"
  60 #include "openvswitch/vlog.h"
  61
  62 COVERAGE_DEFINE(xlate_actions);
  63 COVERAGE_DEFINE(xlate_actions_oversize);
  64 COVERAGE_DEFINE(xlate_actions_too_many_output);
  65
  66 VLOG_DEFINE_THIS_MODULE(ofproto_dpif_xlate);
  67
  68 /* Maximum depth of flow table recursion (due to resubmit actions) in a
  69  * flow translation. */
  70 #define MAX_RESUBMIT_RECURSION 64
  71 #define MAX_INTERNAL_RESUBMITS 1   /* Max resbmits allowed using rules in
  72                                       internal table. */
  73
  74 /* Maximum number of resubmit actions in a flow translation, whether they are
  75  * recursive or not. */
  76 #define MAX_RESUBMITS (MAX_RESUBMIT_RECURSION * MAX_RESUBMIT_RECURSION)
  77
  78 struct xbridge {
  79     struct hmap_node hmap_node;   /* Node in global 'xbridges' map. */
  80     struct ofproto_dpif *ofproto; /* Key in global 'xbridges' map. */
  81
  82     struct ovs_list xbundles;     /* Owned xbundles. */
  83     struct hmap xports;           /* Indexed by ofp_port. */
  84
  85     char *name;                   /* Name used in log messages. */
  86     struct dpif *dpif;            /* Datapath interface. */
  87     struct mac_learning *ml;      /* Mac learning handle. */
  88     struct mcast_snooping *ms;    /* Multicast Snooping handle. */
  89     struct mbridge *mbridge;      /* Mirroring. */
  90     struct dpif_sflow *sflow;     /* SFlow handle, or null. */
  91     struct dpif_ipfix *ipfix;     /* Ipfix handle, or null. */
  92     struct netflow *netflow;      /* Netflow handle, or null. */
  93     struct stp *stp;              /* STP or null if disabled. */
  94     struct rstp *rstp;            /* RSTP or null if disabled. */
  95
  96     bool has_in_band;             /* Bridge has in band control? */
  97     bool forward_bpdu;            /* Bridge forwards STP BPDUs? */
  98
  99     /* Datapath feature support. */
 100     struct dpif_backer_support support;
 101 };
 102
 103 struct xbundle {
 104     struct hmap_node hmap_node;    /* In global 'xbundles' map. */
 105     struct ofbundle *ofbundle;     /* Key in global 'xbundles' map. */
 106
 107     struct ovs_list list_node;     /* In parent 'xbridges' list. */
 108     struct xbridge *xbridge;       /* Parent xbridge. */
 109
 110     struct ovs_list xports;        /* Contains "struct xport"s. */
 111
 112     char *name;                    /* Name used in log messages. */
 113     struct bond *bond;             /* Nonnull iff more than one port. */
 114     struct lacp *lacp;             /* LACP handle or null. */
 115
 116     enum port_vlan_mode vlan_mode; /* VLAN mode. */
 117     int vlan;                      /* -1=trunk port, else a 12-bit VLAN ID. */
 118     unsigned long *trunks;         /* Bitmap of trunked VLANs, if 'vlan' == -1.
 119                                     * NULL if all VLANs are trunked. */
 120     bool use_priority_tags;        /* Use 802.1p tag for frames in VLAN 0? */
 121     bool floodable;                /* No port has OFPUTIL_PC_NO_FLOOD set? */
 122 };
 123
 124 struct xport {
 125     struct hmap_node hmap_node;      /* Node in global 'xports' map. */
 126     struct ofport_dpif *ofport;      /* Key in global 'xports map. */
 127
 128     struct hmap_node ofp_node;       /* Node in parent xbridge 'xports' map. */
 129     ofp_port_t ofp_port;             /* Key in parent xbridge 'xports' map. */
 130
 131     odp_port_t odp_port;             /* Datapath port number or ODPP_NONE. */
 132
 133     struct ovs_list bundle_node;     /* In parent xbundle (if it exists). */
 134     struct xbundle *xbundle;         /* Parent xbundle or null. */
 135
 136     struct netdev *netdev;           /* 'ofport''s netdev. */
 137
 138     struct xbridge *xbridge;         /* Parent bridge. */
 139     struct xport *peer;              /* Patch port peer or null. */
 140
 141     enum ofputil_port_config config; /* OpenFlow port configuration. */
 142     enum ofputil_port_state state;   /* OpenFlow port state. */
 143     int stp_port_no;                 /* STP port number or -1 if not in use. */
 144     struct rstp_port *rstp_port;     /* RSTP port or null. */
 145
 146     struct hmap skb_priorities;      /* Map of 'skb_priority_to_dscp's. */
 147
 148     bool may_enable;                 /* May be enabled in bonds. */
 149     bool is_tunnel;                  /* Is a tunnel port. */
 150
 151     struct cfm *cfm;                 /* CFM handle or null. */
 152     struct bfd *bfd;                 /* BFD handle or null. */
 153     struct lldp *lldp;               /* LLDP handle or null. */
 154 };
 155
 156 struct xlate_ctx {
 157     struct xlate_in *xin;
 158     struct xlate_out *xout;
 159
 160     const struct xbridge *xbridge;
 161
 162     /* Flow tables version at the beginning of the translation. */
 163     cls_version_t tables_version;
 164
 165     /* Flow at the last commit. */
 166     struct flow base_flow;
 167
 168     /* Tunnel IP destination address as received.  This is stored separately
 169      * as the base_flow.tunnel is cleared on init to reflect the datapath
 170      * behavior.  Used to make sure not to send tunneled output to ourselves,
 171      * which might lead to an infinite loop.  This could happen easily
 172      * if a tunnel is marked as 'ip_remote=flow', and the flow does not
 173      * actually set the tun_dst field. */
 174     ovs_be32 orig_tunnel_ip_dst;
 175
 176     /* Stack for the push and pop actions.  Each stack element is of type
 177      * "union mf_subvalue". */
 178     union mf_subvalue init_stack[1024 / sizeof(union mf_subvalue)];
 179     struct ofpbuf stack;
 180
 181     /* The rule that we are currently translating, or NULL. */
 182     struct rule_dpif *rule;
 183
 184     /* Resubmit statistics, via xlate_table_action(). */
 185     int recurse;                /* Current resubmit nesting depth. */
 186     int resubmits;              /* Total number of resubmits. */
 187     bool in_group;              /* Currently translating ofgroup, if true. */
 188     bool in_action_set;         /* Currently translating action_set, if true. */
 189
 190     uint8_t table_id;           /* OpenFlow table ID where flow was found. */
 191     ovs_be64 rule_cookie;       /* Cookie of the rule being translated. */
 192     uint32_t orig_skb_priority; /* Priority when packet arrived. */
 193     uint32_t sflow_n_outputs;   /* Number of output ports. */
 194     odp_port_t sflow_odp_port;  /* Output port for composing sFlow action. */
 195     uint16_t user_cookie_offset;/* Used for user_action_cookie fixup. */
 196     bool exit;                  /* No further actions should be processed. */
 197
 198    /* These are used for non-bond recirculation.  The recirculation IDs are
 199     * stored in xout and must be associated with a datapath flow (ukey),
 200     * otherwise they will be freed when the xout is uninitialized.
 201     *
 202     *
 203     * Steps in Recirculation Translation
 204     * ==================================
 205     *
 206     * At some point during translation, the code recognizes the need for
 207     * recirculation.  For example, recirculation is necessary when, after
 208     * popping the last MPLS label, an action or a match tries to examine or
 209     * modify a field that has been newly revealed following the MPLS label.
 210     *
 211     * The simplest part of the work to be done is to commit existing changes to
 212     * the packet, which produces datapath actions corresponding to the changes,
 213     * and after this, add an OVS_ACTION_ATTR_RECIRC datapath action.
 214     *
 215     * The main problem here is preserving state.  When the datapath executes
 216     * OVS_ACTION_ATTR_RECIRC, it will upcall to userspace to get a translation
 217     * for the post-recirculation actions.  At this point userspace has to
 218     * resume the translation where it left off, which means that it has to
 219     * execute the following:
 220     *
 221     *     - The action that prompted recirculation, and any actions following
 222     *       it within the same flow.
 223     *
 224     *     - If the action that prompted recirculation was invoked within a
 225     *       NXAST_RESUBMIT, then any actions following the resubmit.  These
 226     *       "resubmit"s can be nested, so this has to go all the way up the
 227     *       control stack.
 228     *
 229     *     - The OpenFlow 1.1+ action set.
 230     *
 231     * State that actions and flow table lookups can depend on, such as the
 232     * following, must also be preserved:
 233     *
 234     *     - Metadata fields (input port, registers, OF1.1+ metadata, ...).
 235     *
 236     *     - Action set, stack
 237     *
 238     *     - The table ID and cookie of the flow being translated at each level
 239     *       of the control stack (since OFPAT_CONTROLLER actions send these to
 240     *       the controller).
 241     *
 242     * Translation allows for the control of this state preservation via these
 243     * members.  When a need for recirculation is identified, the translation
 244     * process:
 245     *
 246     * 1. Sets 'recirc_action_offset' to the current size of 'action_set'.  The
 247     *    action set is part of what needs to be preserved, so this allows the
 248     *    action set and the additional state to share the 'action_set' buffer.
 249     *    Later steps can tell that setup for recirculation is in progress from
 250     *    the nonnegative value of 'recirc_action_offset'.
 251     *
 252     * 2. Sets 'exit' to true to tell later steps that we're exiting from the
 253     *    translation process.
 254     *
 255     * 3. Adds an OFPACT_UNROLL_XLATE action to 'action_set'.  This action
 256     *    holds the current table ID and cookie so that they can be restored
 257     *    during a post-recirculation upcall translation.
 258     *
 259     * 4. Adds the action that prompted recirculation and any actions following
 260     *    it within the same flow to 'action_set', so that they can be executed
 261     *    during a post-recirculation upcall translation.
 262     *
 263     * 5. Returns.
 264     *
 265     * 6. The action that prompted recirculation might be nested in a stack of
 266     *    nested "resubmit"s that have actions remaining.  Each of these notices
 267     *    that we're exiting (from 'exit') and that recirculation setup is in
 268     *    progress (from 'recirc_action_offset') and responds by adding more
 269     *    OFPACT_UNROLL_XLATE actions to 'action_set', as necessary, and any
 270     *    actions that were yet unprocessed.
 271     *
 272     * The caller stores all the state produced by this process associated with
 273     * the recirculation ID.  For post-recirculation upcall translation, the
 274     * caller passes it back in for the new translation to execute.  The
 275     * process yielded a set of ofpacts that can be translated directly, so it
 276     * is not much of a special case at that point.
 277     */
 278     int recirc_action_offset;   /* Offset in 'action_set' to actions to be
 279                                  * executed after recirculation, or -1. */
 280     int last_unroll_offset;     /* Offset in 'action_set' to the latest unroll
 281                                  * action, or -1. */
 282
 283     /* True if a packet was but is no longer MPLS (due to an MPLS pop action).
 284      * This is a trigger for recirculation in cases where translating an action
 285      * or looking up a flow requires access to the fields of the packet after
 286      * the MPLS label stack that was originally present. */
 287     bool was_mpls;
 288
 289     /* OpenFlow 1.1+ action set.
 290      *
 291      * 'action_set' accumulates "struct ofpact"s added by OFPACT_WRITE_ACTIONS.
 292      * When translation is otherwise complete, ofpacts_execute_action_set()
 293      * converts it to a set of "struct ofpact"s that can be translated into
 294      * datapath actions. */
 295     bool action_set_has_group;  /* Action set contains OFPACT_GROUP? */
 296     struct ofpbuf action_set;   /* Action set. */
 297     uint64_t action_set_stub[1024 / 8];
 298 };
 299
 300 static void xlate_action_set(struct xlate_ctx *ctx);
 301
 302 static void
 303 ctx_trigger_recirculation(struct xlate_ctx *ctx)
 304 {
 305     ctx->exit = true;
 306     ctx->recirc_action_offset = ctx->action_set.size;
 307 }
 308
 309 static bool
 310 ctx_first_recirculation_action(const struct xlate_ctx *ctx)
 311 {
 312     return ctx->recirc_action_offset == ctx->action_set.size;
 313 }
 314
 315 static inline bool
 316 exit_recirculates(const struct xlate_ctx *ctx)
 317 {
 318     /* When recirculating the 'recirc_action_offset' has a non-negative value.
 319      */
 320     return ctx->recirc_action_offset >= 0;
 321 }
 322
 323 static void compose_recirculate_action(struct xlate_ctx *ctx);
 324
 325 /* A controller may use OFPP_NONE as the ingress port to indicate that
 326  * it did not arrive on a "real" port.  'ofpp_none_bundle' exists for
 327  * when an input bundle is needed for validation (e.g., mirroring or
 328  * OFPP_NORMAL processing).  It is not connected to an 'ofproto' or have
 329  * any 'port' structs, so care must be taken when dealing with it. */
 330 static struct xbundle ofpp_none_bundle = {
 331     .name      = "OFPP_NONE",
 332     .vlan_mode = PORT_VLAN_TRUNK
 333 };
 334
 335 /* Node in 'xport''s 'skb_priorities' map.  Used to maintain a map from
 336  * 'priority' (the datapath's term for QoS queue) to the dscp bits which all
 337  * traffic egressing the 'ofport' with that priority should be marked with. */
 338 struct skb_priority_to_dscp {
 339     struct hmap_node hmap_node; /* Node in 'ofport_dpif''s 'skb_priorities'. */
 340     uint32_t skb_priority;      /* Priority of this queue (see struct flow). */
 341
 342     uint8_t dscp;               /* DSCP bits to mark outgoing traffic with. */
 343 };
 344
 345 enum xc_type {
 346     XC_RULE,
 347     XC_BOND,
 348     XC_NETDEV,
 349     XC_NETFLOW,
 350     XC_MIRROR,
 351     XC_LEARN,
 352     XC_NORMAL,
 353     XC_FIN_TIMEOUT,
 354     XC_GROUP,
 355     XC_TNL_ARP,
 356 };
 357
 358 /* xlate_cache entries hold enough information to perform the side effects of
 359  * xlate_actions() for a rule, without needing to perform rule translation
 360  * from scratch. The primary usage of these is to submit statistics to objects
 361  * that a flow relates to, although they may be used for other effects as well
 362  * (for instance, refreshing hard timeouts for learned flows). */
 363 struct xc_entry {
 364     enum xc_type type;
 365     union {
 366         struct rule_dpif *rule;
 367         struct {
 368             struct netdev *tx;
 369             struct netdev *rx;
 370             struct bfd *bfd;
 371         } dev;
 372         struct {
 373             struct netflow *netflow;
 374             struct flow *flow;
 375             ofp_port_t iface;
 376         } nf;
 377         struct {
 378             struct mbridge *mbridge;
 379             mirror_mask_t mirrors;
 380         } mirror;
 381         struct {
 382             struct bond *bond;
 383             struct flow *flow;
 384             uint16_t vid;
 385         } bond;
 386         struct {
 387             struct ofproto_dpif *ofproto;
 388             struct ofputil_flow_mod *fm;
 389             struct ofpbuf *ofpacts;
 390         } learn;
 391         struct {
 392             struct ofproto_dpif *ofproto;
 393             struct flow *flow;
 394             int vlan;
 395         } normal;
 396         struct {
 397             struct rule_dpif *rule;
 398             uint16_t idle;
 399             uint16_t hard;
 400         } fin;
 401         struct {
 402             struct group_dpif *group;
 403             struct ofputil_bucket *bucket;
 404         } group;
 405         struct {
 406             char br_name[IFNAMSIZ];
 407             ovs_be32 d_ip;
 408         } tnl_arp_cache;
 409     } u;
 410 };
 411
 412 #define XC_ENTRY_FOR_EACH(entry, entries, xcache)               \
 413     entries = xcache->entries;                                  \
 414     for (entry = ofpbuf_try_pull(&entries, sizeof *entry);      \
 415          entry;                                                 \
 416          entry = ofpbuf_try_pull(&entries, sizeof *entry))
 417
 418 struct xlate_cache {
 419     struct ofpbuf entries;
 420 };
 421
 422 /* Xlate config contains hash maps of all bridges, bundles and ports.
 423  * Xcfgp contains the pointer to the current xlate configuration.
 424  * When the main thread needs to change the configuration, it copies xcfgp to
 425  * new_xcfg and edits new_xcfg. This enables the use of RCU locking which
 426  * does not block handler and revalidator threads. */
 427 struct xlate_cfg {
 428     struct hmap xbridges;
 429     struct hmap xbundles;
 430     struct hmap xports;
 431 };
 432 static OVSRCU_TYPE(struct xlate_cfg *) xcfgp = OVSRCU_INITIALIZER(NULL);
 433 static struct xlate_cfg *new_xcfg = NULL;
 434
 435 static bool may_receive(const struct xport *, struct xlate_ctx *);
 436 static void do_xlate_actions(const struct ofpact *, size_t ofpacts_len,
 437                              struct xlate_ctx *);
 438 static void xlate_normal(struct xlate_ctx *);
 439 static inline void xlate_report(struct xlate_ctx *, const char *);
 440 static void xlate_table_action(struct xlate_ctx *, ofp_port_t in_port,
 441                                uint8_t table_id, bool may_packet_in,
 442                                bool honor_table_miss);
 443 static bool input_vid_is_valid(uint16_t vid, struct xbundle *, bool warn);
 444 static uint16_t input_vid_to_vlan(const struct xbundle *, uint16_t vid);
 445 static void output_normal(struct xlate_ctx *, const struct xbundle *,
 446                           uint16_t vlan);
 447
 448 /* Optional bond recirculation parameter to compose_output_action(). */
 449 struct xlate_bond_recirc {
 450     uint32_t recirc_id;  /* !0 Use recirculation instead of output. */
 451     uint8_t  hash_alg;   /* !0 Compute hash for recirc before. */
 452     uint32_t hash_basis;  /* Compute hash for recirc before. */
 453 };
 454
 455 static void compose_output_action(struct xlate_ctx *, ofp_port_t ofp_port,
 456                                   const struct xlate_bond_recirc *xr);
 457
 458 static struct xbridge *xbridge_lookup(struct xlate_cfg *,
 459                                       const struct ofproto_dpif *);
 460 static struct xbundle *xbundle_lookup(struct xlate_cfg *,
 461                                       const struct ofbundle *);
 462 static struct xport *xport_lookup(struct xlate_cfg *,
 463                                   const struct ofport_dpif *);
 464 static struct xport *get_ofp_port(const struct xbridge *, ofp_port_t ofp_port);
 465 static struct skb_priority_to_dscp *get_skb_priority(const struct xport *,
 466                                                      uint32_t skb_priority);
 467 static void clear_skb_priorities(struct xport *);
 468 static size_t count_skb_priorities(const struct xport *);
 469 static bool dscp_from_skb_priority(const struct xport *, uint32_t skb_priority,
 470                                    uint8_t *dscp);
 471
 472 static struct xc_entry *xlate_cache_add_entry(struct xlate_cache *xc,
 473                                               enum xc_type type);
 474 static void xlate_xbridge_init(struct xlate_cfg *, struct xbridge *);
 475 static void xlate_xbundle_init(struct xlate_cfg *, struct xbundle *);
 476 static void xlate_xport_init(struct xlate_cfg *, struct xport *);
 477 static void xlate_xbridge_set(struct xbridge *, struct dpif *,
 478                               const struct mac_learning *, struct stp *,
 479                               struct rstp *, const struct mcast_snooping *,
 480                               const struct mbridge *,
 481                               const struct dpif_sflow *,
 482                               const struct dpif_ipfix *,
 483                               const struct netflow *,
 484                               bool forward_bpdu, bool has_in_band,
 485                               const struct dpif_backer_support *);
 486 static void xlate_xbundle_set(struct xbundle *xbundle,
 487                               enum port_vlan_mode vlan_mode, int vlan,
 488                               unsigned long *trunks, bool use_priority_tags,
 489                               const struct bond *bond, const struct lacp *lacp,
 490                               bool floodable);
 491 static void xlate_xport_set(struct xport *xport, odp_port_t odp_port,
 492                             const struct netdev *netdev, const struct cfm *cfm,
 493                             const struct bfd *bfd, const struct lldp *lldp,
 494                             int stp_port_no, const struct rstp_port *rstp_port,
 495                             enum ofputil_port_config config,
 496                             enum ofputil_port_state state, bool is_tunnel,
 497                             bool may_enable);
 498 static void xlate_xbridge_remove(struct xlate_cfg *, struct xbridge *);
 499 static void xlate_xbundle_remove(struct xlate_cfg *, struct xbundle *);
 500 static void xlate_xport_remove(struct xlate_cfg *, struct xport *);
 501 static void xlate_xbridge_copy(struct xbridge *);
 502 static void xlate_xbundle_copy(struct xbridge *, struct xbundle *);
 503 static void xlate_xport_copy(struct xbridge *, struct xbundle *,
 504                              struct xport *);
 505 static void xlate_xcfg_free(struct xlate_cfg *);
 506
 507 static inline void
 508 xlate_report(struct xlate_ctx *ctx, const char *s)
 509 {
 510     if (OVS_UNLIKELY(ctx->xin->report_hook)) {
 511         ctx->xin->report_hook(ctx->xin, s, ctx->recurse);
 512     }
 513 }
 514
 515 static void
 516 xlate_xbridge_init(struct xlate_cfg *xcfg, struct xbridge *xbridge)
 517 {
 518     list_init(&xbridge->xbundles);
 519     hmap_init(&xbridge->xports);
 520     hmap_insert(&xcfg->xbridges, &xbridge->hmap_node,
 521                 hash_pointer(xbridge->ofproto, 0));
 522 }
 523
 524 static void
 525 xlate_xbundle_init(struct xlate_cfg *xcfg, struct xbundle *xbundle)
 526 {
 527     list_init(&xbundle->xports);
 528     list_insert(&xbundle->xbridge->xbundles, &xbundle->list_node);
 529     hmap_insert(&xcfg->xbundles, &xbundle->hmap_node,
 530                 hash_pointer(xbundle->ofbundle, 0));
 531 }
 532
 533 static void
 534 xlate_xport_init(struct xlate_cfg *xcfg, struct xport *xport)
 535 {
 536     hmap_init(&xport->skb_priorities);
 537     hmap_insert(&xcfg->xports, &xport->hmap_node,
 538                 hash_pointer(xport->ofport, 0));
 539     hmap_insert(&xport->xbridge->xports, &xport->ofp_node,
 540                 hash_ofp_port(xport->ofp_port));
 541 }
 542
 543 static void
 544 xlate_xbridge_set(struct xbridge *xbridge,
 545                   struct dpif *dpif,
 546                   const struct mac_learning *ml, struct stp *stp,
 547                   struct rstp *rstp, const struct mcast_snooping *ms,
 548                   const struct mbridge *mbridge,
 549                   const struct dpif_sflow *sflow,
 550                   const struct dpif_ipfix *ipfix,
 551                   const struct netflow *netflow,
 552                   bool forward_bpdu, bool has_in_band,
 553                   const struct dpif_backer_support *support)
 554 {
 555     if (xbridge->ml != ml) {
 556         mac_learning_unref(xbridge->ml);
 557         xbridge->ml = mac_learning_ref(ml);
 558     }
 559
 560     if (xbridge->ms != ms) {
 561         mcast_snooping_unref(xbridge->ms);
 562         xbridge->ms = mcast_snooping_ref(ms);
 563     }
 564
 565     if (xbridge->mbridge != mbridge) {
 566         mbridge_unref(xbridge->mbridge);
 567         xbridge->mbridge = mbridge_ref(mbridge);
 568     }
 569
 570     if (xbridge->sflow != sflow) {
 571         dpif_sflow_unref(xbridge->sflow);
 572         xbridge->sflow = dpif_sflow_ref(sflow);
 573     }
 574
 575     if (xbridge->ipfix != ipfix) {
 576         dpif_ipfix_unref(xbridge->ipfix);
 577         xbridge->ipfix = dpif_ipfix_ref(ipfix);
 578     }
 579
 580     if (xbridge->stp != stp) {
 581         stp_unref(xbridge->stp);
 582         xbridge->stp = stp_ref(stp);
 583     }
 584
 585     if (xbridge->rstp != rstp) {
 586         rstp_unref(xbridge->rstp);
 587         xbridge->rstp = rstp_ref(rstp);
 588     }
 589
 590     if (xbridge->netflow != netflow) {
 591         netflow_unref(xbridge->netflow);
 592         xbridge->netflow = netflow_ref(netflow);
 593     }
 594
 595     xbridge->dpif = dpif;
 596     xbridge->forward_bpdu = forward_bpdu;
 597     xbridge->has_in_band = has_in_band;
 598     xbridge->support = *support;
 599 }
 600
 601 static void
 602 xlate_xbundle_set(struct xbundle *xbundle,
 603                   enum port_vlan_mode vlan_mode, int vlan,
 604                   unsigned long *trunks, bool use_priority_tags,
 605                   const struct bond *bond, const struct lacp *lacp,
 606                   bool floodable)
 607 {
 608     ovs_assert(xbundle->xbridge);
 609
 610     xbundle->vlan_mode = vlan_mode;
 611     xbundle->vlan = vlan;
 612     xbundle->trunks = trunks;
 613     xbundle->use_priority_tags = use_priority_tags;
 614     xbundle->floodable = floodable;
 615
 616     if (xbundle->bond != bond) {
 617         bond_unref(xbundle->bond);
 618         xbundle->bond = bond_ref(bond);
 619     }
 620
 621     if (xbundle->lacp != lacp) {
 622         lacp_unref(xbundle->lacp);
 623         xbundle->lacp = lacp_ref(lacp);
 624     }
 625 }
 626
 627 static void
 628 xlate_xport_set(struct xport *xport, odp_port_t odp_port,
 629                 const struct netdev *netdev, const struct cfm *cfm,
 630                 const struct bfd *bfd, const struct lldp *lldp, int stp_port_no,
 631                 const struct rstp_port* rstp_port,
 632                 enum ofputil_port_config config, enum ofputil_port_state state,
 633                 bool is_tunnel, bool may_enable)
 634 {
 635     xport->config = config;
 636     xport->state = state;
 637     xport->stp_port_no = stp_port_no;
 638     xport->is_tunnel = is_tunnel;
 639     xport->may_enable = may_enable;
 640     xport->odp_port = odp_port;
 641
 642     if (xport->rstp_port != rstp_port) {
 643         rstp_port_unref(xport->rstp_port);
 644         xport->rstp_port = rstp_port_ref(rstp_port);
 645     }
 646
 647     if (xport->cfm != cfm) {
 648         cfm_unref(xport->cfm);
 649         xport->cfm = cfm_ref(cfm);
 650     }
 651
 652     if (xport->bfd != bfd) {
 653         bfd_unref(xport->bfd);
 654         xport->bfd = bfd_ref(bfd);
 655     }
 656
 657     if (xport->lldp != lldp) {
 658         lldp_unref(xport->lldp);
 659         xport->lldp = lldp_ref(lldp);
 660     }
 661
 662     if (xport->netdev != netdev) {
 663         netdev_close(xport->netdev);
 664         xport->netdev = netdev_ref(netdev);
 665     }
 666 }
 667
 668 static void
 669 xlate_xbridge_copy(struct xbridge *xbridge)
 670 {
 671     struct xbundle *xbundle;
 672     struct xport *xport;
 673     struct xbridge *new_xbridge = xzalloc(sizeof *xbridge);
 674     new_xbridge->ofproto = xbridge->ofproto;
 675     new_xbridge->name = xstrdup(xbridge->name);
 676     xlate_xbridge_init(new_xcfg, new_xbridge);
 677
 678     xlate_xbridge_set(new_xbridge,
 679                       xbridge->dpif, xbridge->ml, xbridge->stp,
 680                       xbridge->rstp, xbridge->ms, xbridge->mbridge,
 681                       xbridge->sflow, xbridge->ipfix, xbridge->netflow,
 682                       xbridge->forward_bpdu, xbridge->has_in_band,
 683                       &xbridge->support);
 684     LIST_FOR_EACH (xbundle, list_node, &xbridge->xbundles) {
 685         xlate_xbundle_copy(new_xbridge, xbundle);
 686     }
 687
 688     /* Copy xports which are not part of a xbundle */
 689     HMAP_FOR_EACH (xport, ofp_node, &xbridge->xports) {
 690         if (!xport->xbundle) {
 691             xlate_xport_copy(new_xbridge, NULL, xport);
 692         }
 693     }
 694 }
 695
 696 static void
 697 xlate_xbundle_copy(struct xbridge *xbridge, struct xbundle *xbundle)
 698 {
 699     struct xport *xport;
 700     struct xbundle *new_xbundle = xzalloc(sizeof *xbundle);
 701     new_xbundle->ofbundle = xbundle->ofbundle;
 702     new_xbundle->xbridge = xbridge;
 703     new_xbundle->name = xstrdup(xbundle->name);
 704     xlate_xbundle_init(new_xcfg, new_xbundle);
 705
 706     xlate_xbundle_set(new_xbundle, xbundle->vlan_mode,
 707                       xbundle->vlan, xbundle->trunks,
 708                       xbundle->use_priority_tags, xbundle->bond, xbundle->lacp,
 709                       xbundle->floodable);
 710     LIST_FOR_EACH (xport, bundle_node, &xbundle->xports) {
 711         xlate_xport_copy(xbridge, new_xbundle, xport);
 712     }
 713 }
 714
 715 static void
 716 xlate_xport_copy(struct xbridge *xbridge, struct xbundle *xbundle,
 717                  struct xport *xport)
 718 {
 719     struct skb_priority_to_dscp *pdscp, *new_pdscp;
 720     struct xport *new_xport = xzalloc(sizeof *xport);
 721     new_xport->ofport = xport->ofport;
 722     new_xport->ofp_port = xport->ofp_port;
 723     new_xport->xbridge = xbridge;
 724     xlate_xport_init(new_xcfg, new_xport);
 725
 726     xlate_xport_set(new_xport, xport->odp_port, xport->netdev, xport->cfm,
 727                     xport->bfd, xport->lldp, xport->stp_port_no,
 728                     xport->rstp_port, xport->config, xport->state,
 729                     xport->is_tunnel, xport->may_enable);
 730
 731     if (xport->peer) {
 732         struct xport *peer = xport_lookup(new_xcfg, xport->peer->ofport);
 733         if (peer) {
 734             new_xport->peer = peer;
 735             new_xport->peer->peer = new_xport;
 736         }
 737     }
 738
 739     if (xbundle) {
 740         new_xport->xbundle = xbundle;
 741         list_insert(&new_xport->xbundle->xports, &new_xport->bundle_node);
 742     }
 743
 744     HMAP_FOR_EACH (pdscp, hmap_node, &xport->skb_priorities) {
 745         new_pdscp = xmalloc(sizeof *pdscp);
 746         new_pdscp->skb_priority = pdscp->skb_priority;
 747         new_pdscp->dscp = pdscp->dscp;
 748         hmap_insert(&new_xport->skb_priorities, &new_pdscp->hmap_node,
 749                     hash_int(new_pdscp->skb_priority, 0));
 750     }
 751 }
 752
 753 /* Sets the current xlate configuration to new_xcfg and frees the old xlate
 754  * configuration in xcfgp.
 755  *
 756  * This needs to be called after editing the xlate configuration.
 757  *
 758  * Functions that edit the new xlate configuration are
 759  * xlate_<ofport/bundle/ofport>_set and xlate_<ofport/bundle/ofport>_remove.
 760  *
 761  * A sample workflow:
 762  *
 763  * xlate_txn_start();
 764  * ...
 765  * edit_xlate_configuration();
 766  * ...
 767  * xlate_txn_commit(); */
 768 void
 769 xlate_txn_commit(void)
 770 {
 771     struct xlate_cfg *xcfg = ovsrcu_get(struct xlate_cfg *, &xcfgp);
 772
 773     ovsrcu_set(&xcfgp, new_xcfg);
 774     ovsrcu_synchronize();
 775     xlate_xcfg_free(xcfg);
 776     new_xcfg = NULL;
 777 }
 778
 779 /* Copies the current xlate configuration in xcfgp to new_xcfg.
 780  *
 781  * This needs to be called prior to editing the xlate configuration. */
 782 void
 783 xlate_txn_start(void)
 784 {
 785     struct xbridge *xbridge;
 786     struct xlate_cfg *xcfg;
 787
 788     ovs_assert(!new_xcfg);
 789
 790     new_xcfg = xmalloc(sizeof *new_xcfg);
 791     hmap_init(&new_xcfg->xbridges);
 792     hmap_init(&new_xcfg->xbundles);
 793     hmap_init(&new_xcfg->xports);
 794
 795     xcfg = ovsrcu_get(struct xlate_cfg *, &xcfgp);
 796     if (!xcfg) {
 797         return;
 798     }
 799
 800     HMAP_FOR_EACH (xbridge, hmap_node, &xcfg->xbridges) {
 801         xlate_xbridge_copy(xbridge);
 802     }
 803 }
 804
 805
 806 static void
 807 xlate_xcfg_free(struct xlate_cfg *xcfg)
 808 {
 809     struct xbridge *xbridge, *next_xbridge;
 810
 811     if (!xcfg) {
 812         return;
 813     }
 814
 815     HMAP_FOR_EACH_SAFE (xbridge, next_xbridge, hmap_node, &xcfg->xbridges) {
 816         xlate_xbridge_remove(xcfg, xbridge);
 817     }
 818
 819     hmap_destroy(&xcfg->xbridges);
 820     hmap_destroy(&xcfg->xbundles);
 821     hmap_destroy(&xcfg->xports);
 822     free(xcfg);
 823 }
 824
 825 void
 826 xlate_ofproto_set(struct ofproto_dpif *ofproto, const char *name,
 827                   struct dpif *dpif,
 828                   const struct mac_learning *ml, struct stp *stp,
 829                   struct rstp *rstp, const struct mcast_snooping *ms,
 830                   const struct mbridge *mbridge,
 831                   const struct dpif_sflow *sflow,
 832                   const struct dpif_ipfix *ipfix,
 833                   const struct netflow *netflow,
 834                   bool forward_bpdu, bool has_in_band,
 835                   const struct dpif_backer_support *support)
 836 {
 837     struct xbridge *xbridge;
 838
 839     ovs_assert(new_xcfg);
 840
 841     xbridge = xbridge_lookup(new_xcfg, ofproto);
 842     if (!xbridge) {
 843         xbridge = xzalloc(sizeof *xbridge);
 844         xbridge->ofproto = ofproto;
 845
 846         xlate_xbridge_init(new_xcfg, xbridge);
 847     }
 848
 849     free(xbridge->name);
 850     xbridge->name = xstrdup(name);
 851
 852     xlate_xbridge_set(xbridge, dpif, ml, stp, rstp, ms, mbridge, sflow, ipfix,
 853                       netflow, forward_bpdu, has_in_band, support);
 854 }
 855
 856 static void
 857 xlate_xbridge_remove(struct xlate_cfg *xcfg, struct xbridge *xbridge)
 858 {
 859     struct xbundle *xbundle, *next_xbundle;
 860     struct xport *xport, *next_xport;
 861
 862     if (!xbridge) {
 863         return;
 864     }
 865
 866     HMAP_FOR_EACH_SAFE (xport, next_xport, ofp_node, &xbridge->xports) {
 867         xlate_xport_remove(xcfg, xport);
 868     }
 869
 870     LIST_FOR_EACH_SAFE (xbundle, next_xbundle, list_node, &xbridge->xbundles) {
 871         xlate_xbundle_remove(xcfg, xbundle);
 872     }
 873
 874     hmap_remove(&xcfg->xbridges, &xbridge->hmap_node);
 875     mac_learning_unref(xbridge->ml);
 876     mcast_snooping_unref(xbridge->ms);
 877     mbridge_unref(xbridge->mbridge);
 878     dpif_sflow_unref(xbridge->sflow);
 879     dpif_ipfix_unref(xbridge->ipfix);
 880     stp_unref(xbridge->stp);
 881     rstp_unref(xbridge->rstp);
 882     hmap_destroy(&xbridge->xports);
 883     free(xbridge->name);
 884     free(xbridge);
 885 }
 886
 887 void
 888 xlate_remove_ofproto(struct ofproto_dpif *ofproto)
 889 {
 890     struct xbridge *xbridge;
 891
 892     ovs_assert(new_xcfg);
 893
 894     xbridge = xbridge_lookup(new_xcfg, ofproto);
 895     xlate_xbridge_remove(new_xcfg, xbridge);
 896 }
 897
 898 void
 899 xlate_bundle_set(struct ofproto_dpif *ofproto, struct ofbundle *ofbundle,
 900                  const char *name, enum port_vlan_mode vlan_mode, int vlan,
 901                  unsigned long *trunks, bool use_priority_tags,
 902                  const struct bond *bond, const struct lacp *lacp,
 903                  bool floodable)
 904 {
 905     struct xbundle *xbundle;
 906
 907     ovs_assert(new_xcfg);
 908
 909     xbundle = xbundle_lookup(new_xcfg, ofbundle);
 910     if (!xbundle) {
 911         xbundle = xzalloc(sizeof *xbundle);
 912         xbundle->ofbundle = ofbundle;
 913         xbundle->xbridge = xbridge_lookup(new_xcfg, ofproto);
 914
 915         xlate_xbundle_init(new_xcfg, xbundle);
 916     }
 917
 918     free(xbundle->name);
 919     xbundle->name = xstrdup(name);
 920
 921     xlate_xbundle_set(xbundle, vlan_mode, vlan, trunks,
 922                       use_priority_tags, bond, lacp, floodable);
 923 }
 924
 925 static void
 926 xlate_xbundle_remove(struct xlate_cfg *xcfg, struct xbundle *xbundle)
 927 {
 928     struct xport *xport;
 929
 930     if (!xbundle) {
 931         return;
 932     }
 933
 934     LIST_FOR_EACH_POP (xport, bundle_node, &xbundle->xports) {
 935         xport->xbundle = NULL;
 936     }
 937
 938     hmap_remove(&xcfg->xbundles, &xbundle->hmap_node);
 939     list_remove(&xbundle->list_node);
 940     bond_unref(xbundle->bond);
 941     lacp_unref(xbundle->lacp);
 942     free(xbundle->name);
 943     free(xbundle);
 944 }
 945
 946 void
 947 xlate_bundle_remove(struct ofbundle *ofbundle)
 948 {
 949     struct xbundle *xbundle;
 950
 951     ovs_assert(new_xcfg);
 952
 953     xbundle = xbundle_lookup(new_xcfg, ofbundle);
 954     xlate_xbundle_remove(new_xcfg, xbundle);
 955 }
 956
 957 void
 958 xlate_ofport_set(struct ofproto_dpif *ofproto, struct ofbundle *ofbundle,
 959                  struct ofport_dpif *ofport, ofp_port_t ofp_port,
 960                  odp_port_t odp_port, const struct netdev *netdev,
 961                  const struct cfm *cfm, const struct bfd *bfd,
 962                  const struct lldp *lldp, struct ofport_dpif *peer,
 963                  int stp_port_no, const struct rstp_port *rstp_port,
 964                  const struct ofproto_port_queue *qdscp_list, size_t n_qdscp,
 965                  enum ofputil_port_config config,
 966                  enum ofputil_port_state state, bool is_tunnel,
 967                  bool may_enable)
 968 {
 969     size_t i;
 970     struct xport *xport;
 971
 972     ovs_assert(new_xcfg);
 973
 974     xport = xport_lookup(new_xcfg, ofport);
 975     if (!xport) {
 976         xport = xzalloc(sizeof *xport);
 977         xport->ofport = ofport;
 978         xport->xbridge = xbridge_lookup(new_xcfg, ofproto);
 979         xport->ofp_port = ofp_port;
 980
 981         xlate_xport_init(new_xcfg, xport);
 982     }
 983
 984     ovs_assert(xport->ofp_port == ofp_port);
 985
 986     xlate_xport_set(xport, odp_port, netdev, cfm, bfd, lldp,
 987                     stp_port_no, rstp_port, config, state, is_tunnel,
 988                     may_enable);
 989
 990     if (xport->peer) {
 991         xport->peer->peer = NULL;
 992     }
 993     xport->peer = xport_lookup(new_xcfg, peer);
 994     if (xport->peer) {
 995         xport->peer->peer = xport;
 996     }
 997
 998     if (xport->xbundle) {
 999         list_remove(&xport->bundle_node);
1000     }
1001     xport->xbundle = xbundle_lookup(new_xcfg, ofbundle);
1002     if (xport->xbundle) {
1003         list_insert(&xport->xbundle->xports, &xport->bundle_node);
1004     }
1005
1006     clear_skb_priorities(xport);
1007     for (i = 0; i < n_qdscp; i++) {
1008         struct skb_priority_to_dscp *pdscp;
1009         uint32_t skb_priority;
1010
1011         if (dpif_queue_to_priority(xport->xbridge->dpif, qdscp_list[i].queue,
1012                                    &skb_priority)) {
1013             continue;
1014         }
1015
1016         pdscp = xmalloc(sizeof *pdscp);
1017         pdscp->skb_priority = skb_priority;
1018         pdscp->dscp = (qdscp_list[i].dscp << 2) & IP_DSCP_MASK;
1019         hmap_insert(&xport->skb_priorities, &pdscp->hmap_node,
1020                     hash_int(pdscp->skb_priority, 0));
1021     }
1022 }
1023
1024 static void
1025 xlate_xport_remove(struct xlate_cfg *xcfg, struct xport *xport)
1026 {
1027     if (!xport) {
1028         return;
1029     }
1030
1031     if (xport->peer) {
1032         xport->peer->peer = NULL;
1033         xport->peer = NULL;
1034     }
1035
1036     if (xport->xbundle) {
1037         list_remove(&xport->bundle_node);
1038     }
1039
1040     clear_skb_priorities(xport);
1041     hmap_destroy(&xport->skb_priorities);
1042
1043     hmap_remove(&xcfg->xports, &xport->hmap_node);
1044     hmap_remove(&xport->xbridge->xports, &xport->ofp_node);
1045
1046     netdev_close(xport->netdev);
1047     rstp_port_unref(xport->rstp_port);
1048     cfm_unref(xport->cfm);
1049     bfd_unref(xport->bfd);
1050     lldp_unref(xport->lldp);
1051     free(xport);
1052 }
1053
1054 void
1055 xlate_ofport_remove(struct ofport_dpif *ofport)
1056 {
1057     struct xport *xport;
1058
1059     ovs_assert(new_xcfg);
1060
1061     xport = xport_lookup(new_xcfg, ofport);
1062     xlate_xport_remove(new_xcfg, xport);
1063 }
1064
1065 static struct ofproto_dpif *
1066 xlate_lookup_ofproto_(const struct dpif_backer *backer, const struct flow *flow,
1067                       ofp_port_t *ofp_in_port, const struct xport **xportp)
1068 {
1069     struct xlate_cfg *xcfg = ovsrcu_get(struct xlate_cfg *, &xcfgp);
1070     const struct xport *xport;
1071
1072     xport = xport_lookup(xcfg, tnl_port_should_receive(flow)
1073                          ? tnl_port_receive(flow)
1074                          : odp_port_to_ofport(backer, flow->in_port.odp_port));
1075     if (OVS_UNLIKELY(!xport)) {
1076         return NULL;
1077     }
1078     *xportp = xport;
1079     if (ofp_in_port) {
1080         *ofp_in_port = xport->ofp_port;
1081     }
1082     return xport->xbridge->ofproto;
1083 }
1084
1085 /* Given a datapath and flow metadata ('backer', and 'flow' respectively)
1086  * returns the corresponding struct ofproto_dpif and OpenFlow port number. */
1087 struct ofproto_dpif *
1088 xlate_lookup_ofproto(const struct dpif_backer *backer, const struct flow *flow,
1089                      ofp_port_t *ofp_in_port)
1090 {
1091     const struct xport *xport;
1092
1093     return xlate_lookup_ofproto_(backer, flow, ofp_in_port, &xport);
1094 }
1095
1096 /* Given a datapath and flow metadata ('backer', and 'flow' respectively),
1097  * optionally populates 'ofproto' with the ofproto_dpif, 'ofp_in_port' with the
1098  * openflow in_port, and 'ipfix', 'sflow', and 'netflow' with the appropriate
1099  * handles for those protocols if they're enabled.  Caller may use the returned
1100  * pointers until quiescing, for longer term use additional references must
1101  * be taken.
1102  *
1103  * Returns 0 if successful, ENODEV if the parsed flow has no associated ofproto.
1104  */
1105 int
1106 xlate_lookup(const struct dpif_backer *backer, const struct flow *flow,
1107              struct ofproto_dpif **ofprotop, struct dpif_ipfix **ipfix,
1108              struct dpif_sflow **sflow, struct netflow **netflow,
1109              ofp_port_t *ofp_in_port)
1110 {
1111     struct ofproto_dpif *ofproto;
1112     const struct xport *xport;
1113
1114     ofproto = xlate_lookup_ofproto_(backer, flow, ofp_in_port, &xport);
1115
1116     if (!ofproto) {
1117         return ENODEV;
1118     }
1119
1120     if (ofprotop) {
1121         *ofprotop = ofproto;
1122     }
1123
1124     if (ipfix) {
1125         *ipfix = xport ? xport->xbridge->ipfix : NULL;
1126     }
1127
1128     if (sflow) {
1129         *sflow = xport ? xport->xbridge->sflow : NULL;
1130     }
1131
1132     if (netflow) {
1133         *netflow = xport ? xport->xbridge->netflow : NULL;
1134     }
1135
1136     return 0;
1137 }
1138
1139 static struct xbridge *
1140 xbridge_lookup(struct xlate_cfg *xcfg, const struct ofproto_dpif *ofproto)
1141 {
1142     struct hmap *xbridges;
1143     struct xbridge *xbridge;
1144
1145     if (!ofproto || !xcfg) {
1146         return NULL;
1147     }
1148
1149     xbridges = &xcfg->xbridges;
1150
1151     HMAP_FOR_EACH_IN_BUCKET (xbridge, hmap_node, hash_pointer(ofproto, 0),
1152                              xbridges) {
1153         if (xbridge->ofproto == ofproto) {
1154             return xbridge;
1155         }
1156     }
1157     return NULL;
1158 }
1159
1160 static struct xbundle *
1161 xbundle_lookup(struct xlate_cfg *xcfg, const struct ofbundle *ofbundle)
1162 {
1163     struct hmap *xbundles;
1164     struct xbundle *xbundle;
1165
1166     if (!ofbundle || !xcfg) {
1167         return NULL;
1168     }
1169
1170     xbundles = &xcfg->xbundles;
1171
1172     HMAP_FOR_EACH_IN_BUCKET (xbundle, hmap_node, hash_pointer(ofbundle, 0),
1173                              xbundles) {
1174         if (xbundle->ofbundle == ofbundle) {
1175             return xbundle;
1176         }
1177     }
1178     return NULL;
1179 }
1180
1181 static struct xport *
1182 xport_lookup(struct xlate_cfg *xcfg, const struct ofport_dpif *ofport)
1183 {
1184     struct hmap *xports;
1185     struct xport *xport;
1186
1187     if (!ofport || !xcfg) {
1188         return NULL;
1189     }
1190
1191     xports = &xcfg->xports;
1192
1193     HMAP_FOR_EACH_IN_BUCKET (xport, hmap_node, hash_pointer(ofport, 0),
1194                              xports) {
1195         if (xport->ofport == ofport) {
1196             return xport;
1197         }
1198     }
1199     return NULL;
1200 }
1201
1202 static struct stp_port *
1203 xport_get_stp_port(const struct xport *xport)
1204 {
1205     return xport->xbridge->stp && xport->stp_port_no != -1
1206         ? stp_get_port(xport->xbridge->stp, xport->stp_port_no)
1207         : NULL;
1208 }
1209
1210 static bool
1211 xport_stp_learn_state(const struct xport *xport)
1212 {
1213     struct stp_port *sp = xport_get_stp_port(xport);
1214     return sp
1215         ? stp_learn_in_state(stp_port_get_state(sp))
1216         : true;
1217 }
1218
1219 static bool
1220 xport_stp_forward_state(const struct xport *xport)
1221 {
1222     struct stp_port *sp = xport_get_stp_port(xport);
1223     return sp
1224         ? stp_forward_in_state(stp_port_get_state(sp))
1225         : true;
1226 }
1227
1228 static bool
1229 xport_stp_should_forward_bpdu(const struct xport *xport)
1230 {
1231     struct stp_port *sp = xport_get_stp_port(xport);
1232     return stp_should_forward_bpdu(sp ? stp_port_get_state(sp) : STP_DISABLED);
1233 }
1234
1235 /* Returns true if STP should process 'flow'.  Sets fields in 'wc' that
1236  * were used to make the determination.*/
1237 static bool
1238 stp_should_process_flow(const struct flow *flow, struct flow_wildcards *wc)
1239 {
1240     /* is_stp() also checks dl_type, but dl_type is always set in 'wc'. */
1241     memset(&wc->masks.dl_dst, 0xff, sizeof wc->masks.dl_dst);
1242     return is_stp(flow);
1243 }
1244
1245 static void
1246 stp_process_packet(const struct xport *xport, const struct dp_packet *packet)
1247 {
1248     struct stp_port *sp = xport_get_stp_port(xport);
1249     struct dp_packet payload = *packet;
1250     struct eth_header *eth = dp_packet_data(&payload);
1251
1252     /* Sink packets on ports that have STP disabled when the bridge has
1253      * STP enabled. */
1254     if (!sp || stp_port_get_state(sp) == STP_DISABLED) {
1255         return;
1256     }
1257
1258     /* Trim off padding on payload. */
1259     if (dp_packet_size(&payload) > ntohs(eth->eth_type) + ETH_HEADER_LEN) {
1260         dp_packet_set_size(&payload, ntohs(eth->eth_type) + ETH_HEADER_LEN);
1261     }
1262
1263     if (dp_packet_try_pull(&payload, ETH_HEADER_LEN + LLC_HEADER_LEN)) {
1264         stp_received_bpdu(sp, dp_packet_data(&payload), dp_packet_size(&payload));
1265     }
1266 }
1267
1268 static enum rstp_state
1269 xport_get_rstp_port_state(const struct xport *xport)
1270 {
1271     return xport->rstp_port
1272         ? rstp_port_get_state(xport->rstp_port)
1273         : RSTP_DISABLED;
1274 }
1275
1276 static bool
1277 xport_rstp_learn_state(const struct xport *xport)
1278 {
1279     return xport->xbridge->rstp && xport->rstp_port
1280         ? rstp_learn_in_state(xport_get_rstp_port_state(xport))
1281         : true;
1282 }
1283
1284 static bool
1285 xport_rstp_forward_state(const struct xport *xport)
1286 {
1287     return xport->xbridge->rstp && xport->rstp_port
1288         ? rstp_forward_in_state(xport_get_rstp_port_state(xport))
1289         : true;
1290 }
1291
1292 static bool
1293 xport_rstp_should_manage_bpdu(const struct xport *xport)
1294 {
1295     return rstp_should_manage_bpdu(xport_get_rstp_port_state(xport));
1296 }
1297
1298 static void
1299 rstp_process_packet(const struct xport *xport, const struct dp_packet *packet)
1300 {
1301     struct dp_packet payload = *packet;
1302     struct eth_header *eth = dp_packet_data(&payload);
1303
1304     /* Sink packets on ports that have no RSTP. */
1305     if (!xport->rstp_port) {
1306         return;
1307     }
1308
1309     /* Trim off padding on payload. */
1310     if (dp_packet_size(&payload) > ntohs(eth->eth_type) + ETH_HEADER_LEN) {
1311         dp_packet_set_size(&payload, ntohs(eth->eth_type) + ETH_HEADER_LEN);
1312     }
1313
1314     if (dp_packet_try_pull(&payload, ETH_HEADER_LEN + LLC_HEADER_LEN)) {
1315         rstp_port_received_bpdu(xport->rstp_port, dp_packet_data(&payload),
1316                                 dp_packet_size(&payload));
1317     }
1318 }
1319
1320 static struct xport *
1321 get_ofp_port(const struct xbridge *xbridge, ofp_port_t ofp_port)
1322 {
1323     struct xport *xport;
1324
1325     HMAP_FOR_EACH_IN_BUCKET (xport, ofp_node, hash_ofp_port(ofp_port),
1326                              &xbridge->xports) {
1327         if (xport->ofp_port == ofp_port) {
1328             return xport;
1329         }
1330     }
1331     return NULL;
1332 }
1333
1334 static odp_port_t
1335 ofp_port_to_odp_port(const struct xbridge *xbridge, ofp_port_t ofp_port)
1336 {
1337     const struct xport *xport = get_ofp_port(xbridge, ofp_port);
1338     return xport ? xport->odp_port : ODPP_NONE;
1339 }
1340
1341 static bool
1342 odp_port_is_alive(const struct xlate_ctx *ctx, ofp_port_t ofp_port)
1343 {
1344     struct xport *xport = get_ofp_port(ctx->xbridge, ofp_port);
1345     return xport && xport->may_enable;
1346 }
1347
1348 static struct ofputil_bucket *
1349 group_first_live_bucket(const struct xlate_ctx *, const struct group_dpif *,
1350                         int depth);
1351
1352 static bool
1353 group_is_alive(const struct xlate_ctx *ctx, uint32_t group_id, int depth)
1354 {
1355     struct group_dpif *group;
1356
1357     if (group_dpif_lookup(ctx->xbridge->ofproto, group_id, &group)) {
1358         struct ofputil_bucket *bucket;
1359
1360         bucket = group_first_live_bucket(ctx, group, depth);
1361         group_dpif_unref(group);
1362         return bucket == NULL;
1363     }
1364
1365     return false;
1366 }
1367
1368 #define MAX_LIVENESS_RECURSION 128 /* Arbitrary limit */
1369
1370 static bool
1371 bucket_is_alive(const struct xlate_ctx *ctx,
1372                 struct ofputil_bucket *bucket, int depth)
1373 {
1374     if (depth >= MAX_LIVENESS_RECURSION) {
1375         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 1);
1376
1377         VLOG_WARN_RL(&rl, "bucket chaining exceeded %d links",
1378                      MAX_LIVENESS_RECURSION);
1379         return false;
1380     }
1381
1382     return (!ofputil_bucket_has_liveness(bucket)
1383             || (bucket->watch_port != OFPP_ANY
1384                && odp_port_is_alive(ctx, bucket->watch_port))
1385             || (bucket->watch_group != OFPG_ANY
1386                && group_is_alive(ctx, bucket->watch_group, depth + 1)));
1387 }
1388
1389 static struct ofputil_bucket *
1390 group_first_live_bucket(const struct xlate_ctx *ctx,
1391                         const struct group_dpif *group, int depth)
1392 {
1393     struct ofputil_bucket *bucket;
1394     const struct ovs_list *buckets;
1395
1396     group_dpif_get_buckets(group, &buckets);
1397     LIST_FOR_EACH (bucket, list_node, buckets) {
1398         if (bucket_is_alive(ctx, bucket, depth)) {
1399             return bucket;
1400         }
1401     }
1402
1403     return NULL;
1404 }
1405
1406 static struct ofputil_bucket *
1407 group_best_live_bucket(const struct xlate_ctx *ctx,
1408                        const struct group_dpif *group,
1409                        uint32_t basis)
1410 {
1411     struct ofputil_bucket *best_bucket = NULL;
1412     uint32_t best_score = 0;
1413     int i = 0;
1414
1415     struct ofputil_bucket *bucket;
1416     const struct ovs_list *buckets;
1417
1418     group_dpif_get_buckets(group, &buckets);
1419     LIST_FOR_EACH (bucket, list_node, buckets) {
1420         if (bucket_is_alive(ctx, bucket, 0)) {
1421             uint32_t score = (hash_int(i, basis) & 0xffff) * bucket->weight;
1422             if (score >= best_score) {
1423                 best_bucket = bucket;
1424                 best_score = score;
1425             }
1426         }
1427         i++;
1428     }
1429
1430     return best_bucket;
1431 }
1432
1433 static bool
1434 xbundle_trunks_vlan(const struct xbundle *bundle, uint16_t vlan)
1435 {
1436     return (bundle->vlan_mode != PORT_VLAN_ACCESS
1437             && (!bundle->trunks || bitmap_is_set(bundle->trunks, vlan)));
1438 }
1439
1440 static bool
1441 xbundle_includes_vlan(const struct xbundle *xbundle, uint16_t vlan)
1442 {
1443     return vlan == xbundle->vlan || xbundle_trunks_vlan(xbundle, vlan);
1444 }
1445
1446 static mirror_mask_t
1447 xbundle_mirror_out(const struct xbridge *xbridge, struct xbundle *xbundle)
1448 {
1449     return xbundle != &ofpp_none_bundle
1450         ? mirror_bundle_out(xbridge->mbridge, xbundle->ofbundle)
1451         : 0;
1452 }
1453
1454 static mirror_mask_t
1455 xbundle_mirror_src(const struct xbridge *xbridge, struct xbundle *xbundle)
1456 {
1457     return xbundle != &ofpp_none_bundle
1458         ? mirror_bundle_src(xbridge->mbridge, xbundle->ofbundle)
1459         : 0;
1460 }
1461
1462 static mirror_mask_t
1463 xbundle_mirror_dst(const struct xbridge *xbridge, struct xbundle *xbundle)
1464 {
1465     return xbundle != &ofpp_none_bundle
1466         ? mirror_bundle_dst(xbridge->mbridge, xbundle->ofbundle)
1467         : 0;
1468 }
1469
1470 static struct xbundle *
1471 lookup_input_bundle(const struct xbridge *xbridge, ofp_port_t in_port,
1472                     bool warn, struct xport **in_xportp)
1473 {
1474     struct xport *xport;
1475
1476     /* Find the port and bundle for the received packet. */
1477     xport = get_ofp_port(xbridge, in_port);
1478     if (in_xportp) {
1479         *in_xportp = xport;
1480     }
1481     if (xport && xport->xbundle) {
1482         return xport->xbundle;
1483     }
1484
1485     /* Special-case OFPP_NONE (OF1.0) and OFPP_CONTROLLER (OF1.1+),
1486      * which a controller may use as the ingress port for traffic that
1487      * it is sourcing. */
1488     if (in_port == OFPP_CONTROLLER || in_port == OFPP_NONE) {
1489         return &ofpp_none_bundle;
1490     }
1491
1492     /* Odd.  A few possible reasons here:
1493      *
1494      * - We deleted a port but there are still a few packets queued up
1495      *   from it.
1496      *
1497      * - Someone externally added a port (e.g. "ovs-dpctl add-if") that
1498      *   we don't know about.
1499      *
1500      * - The ofproto client didn't configure the port as part of a bundle.
1501      *   This is particularly likely to happen if a packet was received on the
1502      *   port after it was created, but before the client had a chance to
1503      *   configure its bundle.
1504      */
1505     if (warn) {
1506         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
1507
1508         VLOG_WARN_RL(&rl, "bridge %s: received packet on unknown "
1509                      "port %"PRIu16, xbridge->name, in_port);
1510     }
1511     return NULL;
1512 }
1513
1514 static void
1515 add_mirror_actions(struct xlate_ctx *ctx, const struct flow *orig_flow)
1516 {
1517     const struct xbridge *xbridge = ctx->xbridge;
1518     mirror_mask_t mirrors;
1519     struct xbundle *in_xbundle;
1520     uint16_t vlan;
1521     uint16_t vid;
1522
1523     mirrors = ctx->xout->mirrors;
1524     ctx->xout->mirrors = 0;
1525
1526     in_xbundle = lookup_input_bundle(xbridge, orig_flow->in_port.ofp_port,
1527                                      ctx->xin->packet != NULL, NULL);
1528     if (!in_xbundle) {
1529         return;
1530     }
1531     mirrors |= xbundle_mirror_src(xbridge, in_xbundle);
1532
1533     /* Drop frames on bundles reserved for mirroring. */
1534     if (xbundle_mirror_out(xbridge, in_xbundle)) {
1535         if (ctx->xin->packet != NULL) {
1536             static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
1537             VLOG_WARN_RL(&rl, "bridge %s: dropping packet received on port "
1538                          "%s, which is reserved exclusively for mirroring",
1539                          ctx->xbridge->name, in_xbundle->name);
1540         }
1541         ofpbuf_clear(ctx->xout->odp_actions);
1542         return;
1543     }
1544
1545     /* Check VLAN. */
1546     vid = vlan_tci_to_vid(orig_flow->vlan_tci);
1547     if (!input_vid_is_valid(vid, in_xbundle, ctx->xin->packet != NULL)) {
1548         return;
1549     }
1550     vlan = input_vid_to_vlan(in_xbundle, vid);
1551
1552     if (!mirrors) {
1553         return;
1554     }
1555
1556     /* Restore the original packet before adding the mirror actions. */
1557     ctx->xin->flow = *orig_flow;
1558
1559     while (mirrors) {
1560         mirror_mask_t dup_mirrors;
1561         struct ofbundle *out;
1562         unsigned long *vlans;
1563         bool vlan_mirrored;
1564         bool has_mirror;
1565         int out_vlan;
1566
1567         has_mirror = mirror_get(xbridge->mbridge, raw_ctz(mirrors),
1568                                 &vlans, &dup_mirrors, &out, &out_vlan);
1569         ovs_assert(has_mirror);
1570
1571         if (vlans) {
1572             ctx->xout->wc.masks.vlan_tci |= htons(VLAN_CFI | VLAN_VID_MASK);
1573         }
1574         vlan_mirrored = !vlans || bitmap_is_set(vlans, vlan);
1575         free(vlans);
1576
1577         if (!vlan_mirrored) {
1578             mirrors = zero_rightmost_1bit(mirrors);
1579             continue;
1580         }
1581
1582         mirrors &= ~dup_mirrors;
1583         ctx->xout->mirrors |= dup_mirrors;
1584         if (out) {
1585             struct xlate_cfg *xcfg = ovsrcu_get(struct xlate_cfg *, &xcfgp);
1586             struct xbundle *out_xbundle = xbundle_lookup(xcfg, out);
1587             if (out_xbundle) {
1588                 output_normal(ctx, out_xbundle, vlan);
1589             }
1590         } else if (vlan != out_vlan
1591                    && !eth_addr_is_reserved(orig_flow->dl_dst)) {
1592             struct xbundle *xbundle;
1593
1594             LIST_FOR_EACH (xbundle, list_node, &xbridge->xbundles) {
1595                 if (xbundle_includes_vlan(xbundle, out_vlan)
1596                     && !xbundle_mirror_out(xbridge, xbundle)) {
1597                     output_normal(ctx, xbundle, out_vlan);
1598                 }
1599             }
1600         }
1601     }
1602 }
1603
1604 /* Given 'vid', the VID obtained from the 802.1Q header that was received as
1605  * part of a packet (specify 0 if there was no 802.1Q header), and 'in_xbundle',
1606  * the bundle on which the packet was received, returns the VLAN to which the
1607  * packet belongs.
1608  *
1609  * Both 'vid' and the return value are in the range 0...4095. */
1610 static uint16_t
1611 input_vid_to_vlan(const struct xbundle *in_xbundle, uint16_t vid)
1612 {
1613     switch (in_xbundle->vlan_mode) {
1614     case PORT_VLAN_ACCESS:
1615         return in_xbundle->vlan;
1616         break;
1617
1618     case PORT_VLAN_TRUNK:
1619         return vid;
1620
1621     case PORT_VLAN_NATIVE_UNTAGGED:
1622     case PORT_VLAN_NATIVE_TAGGED:
1623         return vid ? vid : in_xbundle->vlan;
1624
1625     default:
1626         OVS_NOT_REACHED();
1627     }
1628 }
1629
1630 /* Checks whether a packet with the given 'vid' may ingress on 'in_xbundle'.
1631  * If so, returns true.  Otherwise, returns false and, if 'warn' is true, logs
1632  * a warning.
1633  *
1634  * 'vid' should be the VID obtained from the 802.1Q header that was received as
1635  * part of a packet (specify 0 if there was no 802.1Q header), in the range
1636  * 0...4095. */
1637 static bool
1638 input_vid_is_valid(uint16_t vid, struct xbundle *in_xbundle, bool warn)
1639 {
1640     /* Allow any VID on the OFPP_NONE port. */
1641     if (in_xbundle == &ofpp_none_bundle) {
1642         return true;
1643     }
1644
1645     switch (in_xbundle->vlan_mode) {
1646     case PORT_VLAN_ACCESS:
1647         if (vid) {
1648             if (warn) {
1649                 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
1650                 VLOG_WARN_RL(&rl, "dropping VLAN %"PRIu16" tagged "
1651                              "packet received on port %s configured as VLAN "
1652                              "%"PRIu16" access port", vid, in_xbundle->name,
1653                              in_xbundle->vlan);
1654             }
1655             return false;
1656         }
1657         return true;
1658
1659     case PORT_VLAN_NATIVE_UNTAGGED:
1660     case PORT_VLAN_NATIVE_TAGGED:
1661         if (!vid) {
1662             /* Port must always carry its native VLAN. */
1663             return true;
1664         }
1665         /* Fall through. */
1666     case PORT_VLAN_TRUNK:
1667         if (!xbundle_includes_vlan(in_xbundle, vid)) {
1668             if (warn) {
1669                 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
1670                 VLOG_WARN_RL(&rl, "dropping VLAN %"PRIu16" packet "
1671                              "received on port %s not configured for trunking "
1672                              "VLAN %"PRIu16, vid, in_xbundle->name, vid);
1673             }
1674             return false;
1675         }
1676         return true;
1677
1678     default:
1679         OVS_NOT_REACHED();
1680     }
1681
1682 }
1683
1684 /* Given 'vlan', the VLAN that a packet belongs to, and
1685  * 'out_xbundle', a bundle on which the packet is to be output, returns the VID
1686  * that should be included in the 802.1Q header.  (If the return value is 0,
1687  * then the 802.1Q header should only be included in the packet if there is a
1688  * nonzero PCP.)
1689  *
1690  * Both 'vlan' and the return value are in the range 0...4095. */
1691 static uint16_t
1692 output_vlan_to_vid(const struct xbundle *out_xbundle, uint16_t vlan)
1693 {
1694     switch (out_xbundle->vlan_mode) {
1695     case PORT_VLAN_ACCESS:
1696         return 0;
1697
1698     case PORT_VLAN_TRUNK:
1699     case PORT_VLAN_NATIVE_TAGGED:
1700         return vlan;
1701
1702     case PORT_VLAN_NATIVE_UNTAGGED:
1703         return vlan == out_xbundle->vlan ? 0 : vlan;
1704
1705     default:
1706         OVS_NOT_REACHED();
1707     }
1708 }
1709
1710 static void
1711 output_normal(struct xlate_ctx *ctx, const struct xbundle *out_xbundle,
1712               uint16_t vlan)
1713 {
1714     ovs_be16 *flow_tci = &ctx->xin->flow.vlan_tci;
1715     uint16_t vid;
1716     ovs_be16 tci, old_tci;
1717     struct xport *xport;
1718     struct xlate_bond_recirc xr;
1719     bool use_recirc = false;
1720
1721     vid = output_vlan_to_vid(out_xbundle, vlan);
1722     if (list_is_empty(&out_xbundle->xports)) {
1723         /* Partially configured bundle with no slaves.  Drop the packet. */
1724         return;
1725     } else if (!out_xbundle->bond) {
1726         xport = CONTAINER_OF(list_front(&out_xbundle->xports), struct xport,
1727                              bundle_node);
1728     } else {
1729         struct xlate_cfg *xcfg = ovsrcu_get(struct xlate_cfg *, &xcfgp);
1730         struct flow_wildcards *wc = &ctx->xout->wc;
1731         struct ofport_dpif *ofport;
1732
1733         if (ctx->xbridge->support.recirc) {
1734             use_recirc = bond_may_recirc(
1735                 out_xbundle->bond, &xr.recirc_id, &xr.hash_basis);
1736
1737             if (use_recirc) {
1738                 /* Only TCP mode uses recirculation. */
1739                 xr.hash_alg = OVS_HASH_ALG_L4;
1740                 bond_update_post_recirc_rules(out_xbundle->bond, false);
1741
1742                 /* Recirculation does not require unmasking hash fields. */
1743                 wc = NULL;
1744             }
1745         }
1746
1747         ofport = bond_choose_output_slave(out_xbundle->bond,
1748                                           &ctx->xin->flow, wc, vid);
1749         xport = xport_lookup(xcfg, ofport);
1750
1751         if (!xport) {
1752             /* No slaves enabled, so drop packet. */
1753             return;
1754         }
1755
1756         /* If use_recirc is set, the main thread will handle stats
1757          * accounting for this bond. */
1758         if (!use_recirc) {
1759             if (ctx->xin->resubmit_stats) {
1760                 bond_account(out_xbundle->bond, &ctx->xin->flow, vid,
1761                              ctx->xin->resubmit_stats->n_bytes);
1762             }
1763             if (ctx->xin->xcache) {
1764                 struct xc_entry *entry;
1765                 struct flow *flow;
1766
1767                 flow = &ctx->xin->flow;
1768                 entry = xlate_cache_add_entry(ctx->xin->xcache, XC_BOND);
1769                 entry->u.bond.bond = bond_ref(out_xbundle->bond);
1770                 entry->u.bond.flow = xmemdup(flow, sizeof *flow);
1771                 entry->u.bond.vid = vid;
1772             }
1773         }
1774     }
1775
1776     old_tci = *flow_tci;
1777     tci = htons(vid);
1778     if (tci || out_xbundle->use_priority_tags) {
1779         tci |= *flow_tci & htons(VLAN_PCP_MASK);
1780         if (tci) {
1781             tci |= htons(VLAN_CFI);
1782         }
1783     }
1784     *flow_tci = tci;
1785
1786     compose_output_action(ctx, xport->ofp_port, use_recirc ? &xr : NULL);
1787     *flow_tci = old_tci;
1788 }
1789
1790 /* A VM broadcasts a gratuitous ARP to indicate that it has resumed after
1791  * migration.  Older Citrix-patched Linux DomU used gratuitous ARP replies to
1792  * indicate this; newer upstream kernels use gratuitous ARP requests. */
1793 static bool
1794 is_gratuitous_arp(const struct flow *flow, struct flow_wildcards *wc)
1795 {
1796     if (flow->dl_type != htons(ETH_TYPE_ARP)) {
1797         return false;
1798     }
1799
1800     memset(&wc->masks.dl_dst, 0xff, sizeof wc->masks.dl_dst);
1801     if (!eth_addr_is_broadcast(flow->dl_dst)) {
1802         return false;
1803     }
1804
1805     memset(&wc->masks.nw_proto, 0xff, sizeof wc->masks.nw_proto);
1806     if (flow->nw_proto == ARP_OP_REPLY) {
1807         return true;
1808     } else if (flow->nw_proto == ARP_OP_REQUEST) {
1809         memset(&wc->masks.nw_src, 0xff, sizeof wc->masks.nw_src);
1810         memset(&wc->masks.nw_dst, 0xff, sizeof wc->masks.nw_dst);
1811
1812         return flow->nw_src == flow->nw_dst;
1813     } else {
1814         return false;
1815     }
1816 }
1817
1818 /* Determines whether packets in 'flow' within 'xbridge' should be forwarded or
1819  * dropped.  Returns true if they may be forwarded, false if they should be
1820  * dropped.
1821  *
1822  * 'in_port' must be the xport that corresponds to flow->in_port.
1823  * 'in_port' must be part of a bundle (e.g. in_port->bundle must be nonnull).
1824  *
1825  * 'vlan' must be the VLAN that corresponds to flow->vlan_tci on 'in_port', as
1826  * returned by input_vid_to_vlan().  It must be a valid VLAN for 'in_port', as
1827  * checked by input_vid_is_valid().
1828  *
1829  * May also add tags to '*tags', although the current implementation only does
1830  * so in one special case.
1831  */
1832 static bool
1833 is_admissible(struct xlate_ctx *ctx, struct xport *in_port,
1834               uint16_t vlan)
1835 {
1836     struct xbundle *in_xbundle = in_port->xbundle;
1837     const struct xbridge *xbridge = ctx->xbridge;
1838     struct flow *flow = &ctx->xin->flow;
1839
1840     /* Drop frames for reserved multicast addresses
1841      * only if forward_bpdu option is absent. */
1842     if (!xbridge->forward_bpdu && eth_addr_is_reserved(flow->dl_dst)) {
1843         xlate_report(ctx, "packet has reserved destination MAC, dropping");
1844         return false;
1845     }
1846
1847     if (in_xbundle->bond) {
1848         struct mac_entry *mac;
1849
1850         switch (bond_check_admissibility(in_xbundle->bond, in_port->ofport,
1851                                          flow->dl_dst)) {
1852         case BV_ACCEPT:
1853             break;
1854
1855         case BV_DROP:
1856             xlate_report(ctx, "bonding refused admissibility, dropping");
1857             return false;
1858
1859         case BV_DROP_IF_MOVED:
1860             ovs_rwlock_rdlock(&xbridge->ml->rwlock);
1861             mac = mac_learning_lookup(xbridge->ml, flow->dl_src, vlan);
1862             if (mac
1863                 && mac_entry_get_port(xbridge->ml, mac) != in_xbundle->ofbundle
1864                 && (!is_gratuitous_arp(flow, &ctx->xout->wc)
1865                     || mac_entry_is_grat_arp_locked(mac))) {
1866                 ovs_rwlock_unlock(&xbridge->ml->rwlock);
1867                 xlate_report(ctx, "SLB bond thinks this packet looped back, "
1868                              "dropping");
1869                 return false;
1870             }
1871             ovs_rwlock_unlock(&xbridge->ml->rwlock);
1872             break;
1873         }
1874     }
1875
1876     return true;
1877 }
1878
1879 /* Checks whether a MAC learning update is necessary for MAC learning table
1880  * 'ml' given that a packet matching 'flow' was received  on 'in_xbundle' in
1881  * 'vlan'.
1882  *
1883  * Most packets processed through the MAC learning table do not actually
1884  * change it in any way.  This function requires only a read lock on the MAC
1885  * learning table, so it is much cheaper in this common case.
1886  *
1887  * Keep the code here synchronized with that in update_learning_table__()
1888  * below. */
1889 static bool
1890 is_mac_learning_update_needed(const struct mac_learning *ml,
1891                               const struct flow *flow,
1892                               struct flow_wildcards *wc,
1893                               int vlan, struct xbundle *in_xbundle)
1894 OVS_REQ_RDLOCK(ml->rwlock)
1895 {
1896     struct mac_entry *mac;
1897
1898     if (!mac_learning_may_learn(ml, flow->dl_src, vlan)) {
1899         return false;
1900     }
1901
1902     mac = mac_learning_lookup(ml, flow->dl_src, vlan);
1903     if (!mac || mac_entry_age(ml, mac)) {
1904         return true;
1905     }
1906
1907     if (is_gratuitous_arp(flow, wc)) {
1908         /* We don't want to learn from gratuitous ARP packets that are
1909          * reflected back over bond slaves so we lock the learning table. */
1910         if (!in_xbundle->bond) {
1911             return true;
1912         } else if (mac_entry_is_grat_arp_locked(mac)) {
1913             return false;
1914         }
1915     }
1916
1917     return mac_entry_get_port(ml, mac) != in_xbundle->ofbundle;
1918 }
1919
1920
1921 /* Updates MAC learning table 'ml' given that a packet matching 'flow' was
1922  * received on 'in_xbundle' in 'vlan'.
1923  *
1924  * This code repeats all the checks in is_mac_learning_update_needed() because
1925  * the lock was released between there and here and thus the MAC learning state
1926  * could have changed.
1927  *
1928  * Keep the code here synchronized with that in is_mac_learning_update_needed()
1929  * above. */
1930 static void
1931 update_learning_table__(const struct xbridge *xbridge,
1932                         const struct flow *flow, struct flow_wildcards *wc,
1933                         int vlan, struct xbundle *in_xbundle)
1934 OVS_REQ_WRLOCK(xbridge->ml->rwlock)
1935 {
1936     struct mac_entry *mac;
1937
1938     if (!mac_learning_may_learn(xbridge->ml, flow->dl_src, vlan)) {
1939         return;
1940     }
1941
1942     mac = mac_learning_insert(xbridge->ml, flow->dl_src, vlan);
1943     if (is_gratuitous_arp(flow, wc)) {
1944         /* We don't want to learn from gratuitous ARP packets that are
1945          * reflected back over bond slaves so we lock the learning table. */
1946         if (!in_xbundle->bond) {
1947             mac_entry_set_grat_arp_lock(mac);
1948         } else if (mac_entry_is_grat_arp_locked(mac)) {
1949             return;
1950         }
1951     }
1952
1953     if (mac_entry_get_port(xbridge->ml, mac) != in_xbundle->ofbundle) {
1954         /* The log messages here could actually be useful in debugging,
1955          * so keep the rate limit relatively high. */
1956         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(30, 300);
1957
1958         VLOG_DBG_RL(&rl, "bridge %s: learned that "ETH_ADDR_FMT" is "
1959                     "on port %s in VLAN %d",
1960                     xbridge->name, ETH_ADDR_ARGS(flow->dl_src),
1961                     in_xbundle->name, vlan);
1962
1963         mac_entry_set_port(xbridge->ml, mac, in_xbundle->ofbundle);
1964     }
1965 }
1966
1967 static void
1968 update_learning_table(const struct xbridge *xbridge,
1969                       const struct flow *flow, struct flow_wildcards *wc,
1970                       int vlan, struct xbundle *in_xbundle)
1971 {
1972     bool need_update;
1973
1974     /* Don't learn the OFPP_NONE port. */
1975     if (in_xbundle == &ofpp_none_bundle) {
1976         return;
1977     }
1978
1979     /* First try the common case: no change to MAC learning table. */
1980     ovs_rwlock_rdlock(&xbridge->ml->rwlock);
1981     need_update = is_mac_learning_update_needed(xbridge->ml, flow, wc, vlan,
1982                                                 in_xbundle);
1983     ovs_rwlock_unlock(&xbridge->ml->rwlock);
1984
1985     if (need_update) {
1986         /* Slow path: MAC learning table might need an update. */
1987         ovs_rwlock_wrlock(&xbridge->ml->rwlock);
1988         update_learning_table__(xbridge, flow, wc, vlan, in_xbundle);
1989         ovs_rwlock_unlock(&xbridge->ml->rwlock);
1990     }
1991 }
1992
1993 /* Updates multicast snooping table 'ms' given that a packet matching 'flow'
1994  * was received on 'in_xbundle' in 'vlan' and is either Report or Query. */
1995 static void
1996 update_mcast_snooping_table__(const struct xbridge *xbridge,
1997                               const struct flow *flow,
1998                               struct mcast_snooping *ms,
1999                               ovs_be32 ip4, int vlan,
2000                               struct xbundle *in_xbundle,
2001                               const struct dp_packet *packet)
2002     OVS_REQ_WRLOCK(ms->rwlock)
2003 {
2004     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(60, 30);
2005     int count;
2006
2007     switch (ntohs(flow->tp_src)) {
2008     case IGMP_HOST_MEMBERSHIP_REPORT:
2009     case IGMPV2_HOST_MEMBERSHIP_REPORT:
2010         if (mcast_snooping_add_group(ms, ip4, vlan, in_xbundle->ofbundle)) {
2011             VLOG_DBG_RL(&rl, "bridge %s: multicast snooping learned that "
2012                         IP_FMT" is on port %s in VLAN %d",
2013                         xbridge->name, IP_ARGS(ip4), in_xbundle->name, vlan);
2014         }
2015         break;
2016     case IGMP_HOST_LEAVE_MESSAGE:
2017         if (mcast_snooping_leave_group(ms, ip4, vlan, in_xbundle->ofbundle)) {
2018             VLOG_DBG_RL(&rl, "bridge %s: multicast snooping leaving "
2019                         IP_FMT" is on port %s in VLAN %d",
2020                         xbridge->name, IP_ARGS(ip4), in_xbundle->name, vlan);
2021         }
2022         break;
2023     case IGMP_HOST_MEMBERSHIP_QUERY:
2024         if (flow->nw_src && mcast_snooping_add_mrouter(ms, vlan,
2025             in_xbundle->ofbundle)) {
2026             VLOG_DBG_RL(&rl, "bridge %s: multicast snooping query from "
2027                         IP_FMT" is on port %s in VLAN %d",
2028                         xbridge->name, IP_ARGS(flow->nw_src),
2029                         in_xbundle->name, vlan);
2030         }
2031         break;
2032     case IGMPV3_HOST_MEMBERSHIP_REPORT:
2033         if ((count = mcast_snooping_add_report(ms, packet, vlan,
2034                                                in_xbundle->ofbundle))) {
2035             VLOG_DBG_RL(&rl, "bridge %s: multicast snooping processed %d "
2036                         "addresses on port %s in VLAN %d",
2037                         xbridge->name, count, in_xbundle->name, vlan);
2038         }
2039         break;
2040     }
2041 }
2042
2043 /* Updates multicast snooping table 'ms' given that a packet matching 'flow'
2044  * was received on 'in_xbundle' in 'vlan'. */
2045 static void
2046 update_mcast_snooping_table(const struct xbridge *xbridge,
2047                             const struct flow *flow, int vlan,
2048                             struct xbundle *in_xbundle,
2049                             const struct dp_packet *packet)
2050 {
2051     struct mcast_snooping *ms = xbridge->ms;
2052     struct xlate_cfg *xcfg;
2053     struct xbundle *mcast_xbundle;
2054     struct mcast_port_bundle *fport;
2055
2056     /* Don't learn the OFPP_NONE port. */
2057     if (in_xbundle == &ofpp_none_bundle) {
2058         return;
2059     }
2060
2061     /* Don't learn from flood ports */
2062     mcast_xbundle = NULL;
2063     ovs_rwlock_wrlock(&ms->rwlock);
2064     xcfg = ovsrcu_get(struct xlate_cfg *, &xcfgp);
2065     LIST_FOR_EACH(fport, node, &ms->fport_list) {
2066         mcast_xbundle = xbundle_lookup(xcfg, fport->port);
2067         if (mcast_xbundle == in_xbundle) {
2068             break;
2069         }
2070     }
2071
2072     if (!mcast_xbundle || mcast_xbundle != in_xbundle) {
2073         update_mcast_snooping_table__(xbridge, flow, ms, flow->igmp_group_ip4,
2074                                       vlan, in_xbundle, packet);
2075     }
2076     ovs_rwlock_unlock(&ms->rwlock);
2077 }
2078
2079 /* send the packet to ports having the multicast group learned */
2080 static void
2081 xlate_normal_mcast_send_group(struct xlate_ctx *ctx,
2082                               struct mcast_snooping *ms OVS_UNUSED,
2083                               struct mcast_group *grp,
2084                               struct xbundle *in_xbundle, uint16_t vlan)
2085     OVS_REQ_RDLOCK(ms->rwlock)
2086 {
2087     struct xlate_cfg *xcfg;
2088     struct mcast_group_bundle *b;
2089     struct xbundle *mcast_xbundle;
2090
2091     xcfg = ovsrcu_get(struct xlate_cfg *, &xcfgp);
2092     LIST_FOR_EACH(b, bundle_node, &grp->bundle_lru) {
2093         mcast_xbundle = xbundle_lookup(xcfg, b->port);
2094         if (mcast_xbundle && mcast_xbundle != in_xbundle) {
2095             xlate_report(ctx, "forwarding to mcast group port");
2096             output_normal(ctx, mcast_xbundle, vlan);
2097         } else if (!mcast_xbundle) {
2098             xlate_report(ctx, "mcast group port is unknown, dropping");
2099         } else {
2100             xlate_report(ctx, "mcast group port is input port, dropping");
2101         }
2102     }
2103 }
2104
2105 /* send the packet to ports connected to multicast routers */
2106 static void
2107 xlate_normal_mcast_send_mrouters(struct xlate_ctx *ctx,
2108                                  struct mcast_snooping *ms,
2109                                  struct xbundle *in_xbundle, uint16_t vlan)
2110     OVS_REQ_RDLOCK(ms->rwlock)
2111 {
2112     struct xlate_cfg *xcfg;
2113     struct mcast_mrouter_bundle *mrouter;
2114     struct xbundle *mcast_xbundle;
2115
2116     xcfg = ovsrcu_get(struct xlate_cfg *, &xcfgp);
2117     LIST_FOR_EACH(mrouter, mrouter_node, &ms->mrouter_lru) {
2118         mcast_xbundle = xbundle_lookup(xcfg, mrouter->port);
2119         if (mcast_xbundle && mcast_xbundle != in_xbundle) {
2120             xlate_report(ctx, "forwarding to mcast router port");
2121             output_normal(ctx, mcast_xbundle, vlan);
2122         } else if (!mcast_xbundle) {
2123             xlate_report(ctx, "mcast router port is unknown, dropping");
2124         } else {
2125             xlate_report(ctx, "mcast router port is input port, dropping");
2126         }
2127     }
2128 }
2129
2130 /* send the packet to ports flagged to be flooded */
2131 static void
2132 xlate_normal_mcast_send_fports(struct xlate_ctx *ctx,
2133                                struct mcast_snooping *ms,
2134                                struct xbundle *in_xbundle, uint16_t vlan)
2135     OVS_REQ_RDLOCK(ms->rwlock)
2136 {
2137     struct xlate_cfg *xcfg;
2138     struct mcast_port_bundle *fport;
2139     struct xbundle *mcast_xbundle;
2140
2141     xcfg = ovsrcu_get(struct xlate_cfg *, &xcfgp);
2142     LIST_FOR_EACH(fport, node, &ms->fport_list) {
2143         mcast_xbundle = xbundle_lookup(xcfg, fport->port);
2144         if (mcast_xbundle && mcast_xbundle != in_xbundle) {
2145             xlate_report(ctx, "forwarding to mcast flood port");
2146             output_normal(ctx, mcast_xbundle, vlan);
2147         } else if (!mcast_xbundle) {
2148             xlate_report(ctx, "mcast flood port is unknown, dropping");
2149         } else {
2150             xlate_report(ctx, "mcast flood port is input port, dropping");
2151         }
2152     }
2153 }
2154
2155 /* forward the Reports to configured ports */
2156 static void
2157 xlate_normal_mcast_send_rports(struct xlate_ctx *ctx,
2158                                struct mcast_snooping *ms,
2159                                struct xbundle *in_xbundle, uint16_t vlan)
2160     OVS_REQ_RDLOCK(ms->rwlock)
2161 {
2162     struct xlate_cfg *xcfg;
2163     struct mcast_port_bundle *rport;
2164     struct xbundle *mcast_xbundle;
2165
2166     xcfg = ovsrcu_get(struct xlate_cfg *, &xcfgp);
2167     LIST_FOR_EACH(rport, node, &ms->rport_list) {
2168         mcast_xbundle = xbundle_lookup(xcfg, rport->port);
2169         if (mcast_xbundle && mcast_xbundle != in_xbundle) {
2170             xlate_report(ctx, "forwarding Report to mcast flagged port");
2171             output_normal(ctx, mcast_xbundle, vlan);
2172         } else if (!mcast_xbundle) {
2173             xlate_report(ctx, "mcast port is unknown, dropping the Report");
2174         } else {
2175             xlate_report(ctx, "mcast port is input port, dropping the Report");
2176         }
2177     }
2178 }
2179
2180 static void
2181 xlate_normal_flood(struct xlate_ctx *ctx, struct xbundle *in_xbundle,
2182                    uint16_t vlan)
2183 {
2184     struct xbundle *xbundle;
2185
2186     LIST_FOR_EACH (xbundle, list_node, &ctx->xbridge->xbundles) {
2187         if (xbundle != in_xbundle
2188             && xbundle_includes_vlan(xbundle, vlan)
2189             && xbundle->floodable
2190             && !xbundle_mirror_out(ctx->xbridge, xbundle)) {
2191             output_normal(ctx, xbundle, vlan);
2192         }
2193     }
2194     ctx->xout->nf_output_iface = NF_OUT_FLOOD;
2195 }
2196
2197 static void
2198 xlate_normal(struct xlate_ctx *ctx)
2199 {
2200     struct flow_wildcards *wc = &ctx->xout->wc;
2201     struct flow *flow = &ctx->xin->flow;
2202     struct xbundle *in_xbundle;
2203     struct xport *in_port;
2204     struct mac_entry *mac;
2205     void *mac_port;
2206     uint16_t vlan;
2207     uint16_t vid;
2208
2209     ctx->xout->has_normal = true;
2210
2211     memset(&wc->masks.dl_src, 0xff, sizeof wc->masks.dl_src);
2212     memset(&wc->masks.dl_dst, 0xff, sizeof wc->masks.dl_dst);
2213     wc->masks.vlan_tci |= htons(VLAN_VID_MASK | VLAN_CFI);
2214
2215     in_xbundle = lookup_input_bundle(ctx->xbridge, flow->in_port.ofp_port,
2216                                      ctx->xin->packet != NULL, &in_port);
2217     if (!in_xbundle) {
2218         xlate_report(ctx, "no input bundle, dropping");
2219         return;
2220     }
2221
2222     /* Drop malformed frames. */
2223     if (flow->dl_type == htons(ETH_TYPE_VLAN) &&
2224         !(flow->vlan_tci & htons(VLAN_CFI))) {
2225         if (ctx->xin->packet != NULL) {
2226             static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
2227             VLOG_WARN_RL(&rl, "bridge %s: dropping packet with partial "
2228                          "VLAN tag received on port %s",
2229                          ctx->xbridge->name, in_xbundle->name);
2230         }
2231         xlate_report(ctx, "partial VLAN tag, dropping");
2232         return;
2233     }
2234
2235     /* Drop frames on bundles reserved for mirroring. */
2236     if (xbundle_mirror_out(ctx->xbridge, in_xbundle)) {
2237         if (ctx->xin->packet != NULL) {
2238             static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
2239             VLOG_WARN_RL(&rl, "bridge %s: dropping packet received on port "
2240                          "%s, which is reserved exclusively for mirroring",
2241                          ctx->xbridge->name, in_xbundle->name);
2242         }
2243         xlate_report(ctx, "input port is mirror output port, dropping");
2244         return;
2245     }
2246
2247     /* Check VLAN. */
2248     vid = vlan_tci_to_vid(flow->vlan_tci);
2249     if (!input_vid_is_valid(vid, in_xbundle, ctx->xin->packet != NULL)) {
2250         xlate_report(ctx, "disallowed VLAN VID for this input port, dropping");
2251         return;
2252     }
2253     vlan = input_vid_to_vlan(in_xbundle, vid);
2254
2255     /* Check other admissibility requirements. */
2256     if (in_port && !is_admissible(ctx, in_port, vlan)) {
2257         return;
2258     }
2259
2260     /* Learn source MAC. */
2261     if (ctx->xin->may_learn) {
2262         update_learning_table(ctx->xbridge, flow, wc, vlan, in_xbundle);
2263     }
2264     if (ctx->xin->xcache) {
2265         struct xc_entry *entry;
2266
2267         /* Save enough info to update mac learning table later. */
2268         entry = xlate_cache_add_entry(ctx->xin->xcache, XC_NORMAL);
2269         entry->u.normal.ofproto = ctx->xbridge->ofproto;
2270         entry->u.normal.flow = xmemdup(flow, sizeof *flow);
2271         entry->u.normal.vlan = vlan;
2272     }
2273
2274     /* Determine output bundle. */
2275     if (mcast_snooping_enabled(ctx->xbridge->ms)
2276         && !eth_addr_is_broadcast(flow->dl_dst)
2277         && eth_addr_is_multicast(flow->dl_dst)
2278         && flow->dl_type == htons(ETH_TYPE_IP)) {
2279         struct mcast_snooping *ms = ctx->xbridge->ms;
2280         struct mcast_group *grp;
2281
2282         if (flow->nw_proto == IPPROTO_IGMP) {
2283             if (mcast_snooping_is_membership(flow->tp_src) ||
2284                 mcast_snooping_is_query(flow->tp_src)) {
2285                 if (ctx->xin->may_learn) {
2286                     update_mcast_snooping_table(ctx->xbridge, flow, vlan,
2287                                                 in_xbundle, ctx->xin->packet);
2288                 }
2289                 /*
2290                  * IGMP packets need to take the slow path, in order to be
2291                  * processed for mdb updates. That will prevent expires
2292                  * firing off even after hosts have sent reports.
2293                  */
2294                 ctx->xout->slow |= SLOW_ACTION;
2295             }
2296
2297             if (mcast_snooping_is_membership(flow->tp_src)) {
2298                 ovs_rwlock_rdlock(&ms->rwlock);
2299                 xlate_normal_mcast_send_mrouters(ctx, ms, in_xbundle, vlan);
2300                 /* RFC4541: section 2.1.1, item 1: A snooping switch should
2301                  * forward IGMP Membership Reports only to those ports where
2302                  * multicast routers are attached.  Alternatively stated: a
2303                  * snooping switch should not forward IGMP Membership Reports
2304                  * to ports on which only hosts are attached.
2305                  * An administrative control may be provided to override this
2306                  * restriction, allowing the report messages to be flooded to
2307                  * other ports. */
2308                 xlate_normal_mcast_send_rports(ctx, ms, in_xbundle, vlan);
2309                 ovs_rwlock_unlock(&ms->rwlock);
2310             } else {
2311                 xlate_report(ctx, "multicast traffic, flooding");
2312                 xlate_normal_flood(ctx, in_xbundle, vlan);
2313             }
2314             return;
2315         } else {
2316             if (ip_is_local_multicast(flow->nw_dst)) {
2317                 /* RFC4541: section 2.1.2, item 2: Packets with a dst IP
2318                  * address in the 224.0.0.x range which are not IGMP must
2319                  * be forwarded on all ports */
2320                 xlate_report(ctx, "RFC4541: section 2.1.2, item 2, flooding");
2321                 xlate_normal_flood(ctx, in_xbundle, vlan);
2322                 return;
2323             }
2324         }
2325
2326         /* forwarding to group base ports */
2327         ovs_rwlock_rdlock(&ms->rwlock);
2328         grp = mcast_snooping_lookup(ms, flow->nw_dst, vlan);
2329         if (grp) {
2330             xlate_normal_mcast_send_group(ctx, ms, grp, in_xbundle, vlan);
2331             xlate_normal_mcast_send_fports(ctx, ms, in_xbundle, vlan);
2332             xlate_normal_mcast_send_mrouters(ctx, ms, in_xbundle, vlan);
2333         } else {
2334             if (mcast_snooping_flood_unreg(ms)) {
2335                 xlate_report(ctx, "unregistered multicast, flooding");
2336                 xlate_normal_flood(ctx, in_xbundle, vlan);
2337             } else {
2338                 xlate_normal_mcast_send_mrouters(ctx, ms, in_xbundle, vlan);
2339                 xlate_normal_mcast_send_fports(ctx, ms, in_xbundle, vlan);
2340             }
2341         }
2342         ovs_rwlock_unlock(&ms->rwlock);
2343     } else {
2344         ovs_rwlock_rdlock(&ctx->xbridge->ml->rwlock);
2345         mac = mac_learning_lookup(ctx->xbridge->ml, flow->dl_dst, vlan);
2346         mac_port = mac ? mac_entry_get_port(ctx->xbridge->ml, mac) : NULL;
2347         ovs_rwlock_unlock(&ctx->xbridge->ml->rwlock);
2348
2349         if (mac_port) {
2350             struct xlate_cfg *xcfg = ovsrcu_get(struct xlate_cfg *, &xcfgp);
2351             struct xbundle *mac_xbundle = xbundle_lookup(xcfg, mac_port);
2352             if (mac_xbundle && mac_xbundle != in_xbundle) {
2353                 xlate_report(ctx, "forwarding to learned port");
2354                 output_normal(ctx, mac_xbundle, vlan);
2355             } else if (!mac_xbundle) {
2356                 xlate_report(ctx, "learned port is unknown, dropping");
2357             } else {
2358                 xlate_report(ctx, "learned port is input port, dropping");
2359             }
2360         } else {
2361             xlate_report(ctx, "no learned MAC for destination, flooding");
2362             xlate_normal_flood(ctx, in_xbundle, vlan);
2363         }
2364     }
2365 }
2366
2367 /* Compose SAMPLE action for sFlow or IPFIX.  The given probability is
2368  * the number of packets out of UINT32_MAX to sample.  The given
2369  * cookie is passed back in the callback for each sampled packet.
2370  */
2371 static size_t
2372 compose_sample_action(const struct xbridge *xbridge,
2373                       struct ofpbuf *odp_actions,
2374                       const struct flow *flow,
2375                       const uint32_t probability,
2376                       const union user_action_cookie *cookie,
2377                       const size_t cookie_size,
2378                       const odp_port_t tunnel_out_port)
2379 {
2380     size_t sample_offset, actions_offset;
2381     odp_port_t odp_port;
2382     int cookie_offset;
2383     uint32_t pid;
2384
2385     sample_offset = nl_msg_start_nested(odp_actions, OVS_ACTION_ATTR_SAMPLE);
2386
2387     nl_msg_put_u32(odp_actions, OVS_SAMPLE_ATTR_PROBABILITY, probability);
2388
2389     actions_offset = nl_msg_start_nested(odp_actions, OVS_SAMPLE_ATTR_ACTIONS);
2390
2391     odp_port = ofp_port_to_odp_port(xbridge, flow->in_port.ofp_port);
2392     pid = dpif_port_get_pid(xbridge->dpif, odp_port,
2393                             flow_hash_5tuple(flow, 0));
2394     cookie_offset = odp_put_userspace_action(pid, cookie, cookie_size,
2395                                              tunnel_out_port, odp_actions);
2396
2397     nl_msg_end_nested(odp_actions, actions_offset);
2398     nl_msg_end_nested(odp_actions, sample_offset);
2399     return cookie_offset;
2400 }
2401
2402 static void
2403 compose_sflow_cookie(const struct xbridge *xbridge, ovs_be16 vlan_tci,
2404                      odp_port_t odp_port, unsigned int n_outputs,
2405                      union user_action_cookie *cookie)
2406 {
2407     int ifindex;
2408
2409     cookie->type = USER_ACTION_COOKIE_SFLOW;
2410     cookie->sflow.vlan_tci = vlan_tci;
2411
2412     /* See http://www.sflow.org/sflow_version_5.txt (search for "Input/output
2413      * port information") for the interpretation of cookie->output. */
2414     switch (n_outputs) {
2415     case 0:
2416         /* 0x40000000 | 256 means "packet dropped for unknown reason". */
2417         cookie->sflow.output = 0x40000000 | 256;
2418         break;
2419
2420     case 1:
2421         ifindex = dpif_sflow_odp_port_to_ifindex(xbridge->sflow, odp_port);
2422         if (ifindex) {
2423             cookie->sflow.output = ifindex;
2424             break;
2425         }
2426         /* Fall through. */
2427     default:
2428         /* 0x80000000 means "multiple output ports. */
2429         cookie->sflow.output = 0x80000000 | n_outputs;
2430         break;
2431     }
2432 }
2433
2434 /* Compose SAMPLE action for sFlow bridge sampling. */
2435 static size_t
2436 compose_sflow_action(const struct xbridge *xbridge,
2437                      struct ofpbuf *odp_actions,
2438                      const struct flow *flow,
2439                      odp_port_t odp_port)
2440 {
2441     uint32_t probability;
2442     union user_action_cookie cookie;
2443
2444     if (!xbridge->sflow || flow->in_port.ofp_port == OFPP_NONE) {
2445         return 0;
2446     }
2447
2448     probability = dpif_sflow_get_probability(xbridge->sflow);
2449     compose_sflow_cookie(xbridge, htons(0), odp_port,
2450                          odp_port == ODPP_NONE ? 0 : 1, &cookie);
2451
2452     return compose_sample_action(xbridge, odp_actions, flow,  probability,
2453                                  &cookie, sizeof cookie.sflow, ODPP_NONE);
2454 }
2455
2456 static void
2457 compose_flow_sample_cookie(uint16_t probability, uint32_t collector_set_id,
2458                            uint32_t obs_domain_id, uint32_t obs_point_id,
2459                            union user_action_cookie *cookie)
2460 {
2461     cookie->type = USER_ACTION_COOKIE_FLOW_SAMPLE;
2462     cookie->flow_sample.probability = probability;
2463     cookie->flow_sample.collector_set_id = collector_set_id;
2464     cookie->flow_sample.obs_domain_id = obs_domain_id;
2465     cookie->flow_sample.obs_point_id = obs_point_id;
2466 }
2467
2468 static void
2469 compose_ipfix_cookie(union user_action_cookie *cookie,
2470                      odp_port_t output_odp_port)
2471 {
2472     cookie->type = USER_ACTION_COOKIE_IPFIX;
2473     cookie->ipfix.output_odp_port = output_odp_port;
2474 }
2475
2476 /* Compose SAMPLE action for IPFIX bridge sampling. */
2477 static void
2478 compose_ipfix_action(const struct xbridge *xbridge,
2479                      struct ofpbuf *odp_actions,
2480                      const struct flow *flow,
2481                      odp_port_t output_odp_port)
2482 {
2483     uint32_t probability;
2484     union user_action_cookie cookie;
2485     odp_port_t tunnel_out_port = ODPP_NONE;
2486
2487     if (!xbridge->ipfix || flow->in_port.ofp_port == OFPP_NONE) {
2488         return;
2489     }
2490
2491     /* For input case, output_odp_port is ODPP_NONE, which is an invalid port
2492      * number. */
2493     if (output_odp_port == ODPP_NONE &&
2494         !dpif_ipfix_get_bridge_exporter_input_sampling(xbridge->ipfix)) {
2495         return;
2496     }
2497
2498     /* For output case, output_odp_port is valid*/
2499     if (output_odp_port != ODPP_NONE) {
2500         if (!dpif_ipfix_get_bridge_exporter_output_sampling(xbridge->ipfix)) {
2501             return;
2502         }
2503         /* If tunnel sampling is enabled, put an additional option attribute:
2504          * OVS_USERSPACE_ATTR_TUNNEL_OUT_PORT
2505          */
2506         if (dpif_ipfix_get_bridge_exporter_tunnel_sampling(xbridge->ipfix) &&
2507             dpif_ipfix_get_tunnel_port(xbridge->ipfix, output_odp_port) ) {
2508            tunnel_out_port = output_odp_port;
2509         }
2510     }
2511
2512     probability = dpif_ipfix_get_bridge_exporter_probability(xbridge->ipfix);
2513     compose_ipfix_cookie(&cookie, output_odp_port);
2514
2515     compose_sample_action(xbridge, odp_actions, flow,  probability,
2516                           &cookie, sizeof cookie.ipfix, tunnel_out_port);
2517 }
2518
2519 /* SAMPLE action for sFlow must be first action in any given list of
2520  * actions.  At this point we do not have all information required to
2521  * build it. So try to build sample action as complete as possible. */
2522 static void
2523 add_sflow_action(struct xlate_ctx *ctx)
2524 {
2525     ctx->user_cookie_offset = compose_sflow_action(ctx->xbridge,
2526                                                    ctx->xout->odp_actions,
2527                                                    &ctx->xin->flow, ODPP_NONE);
2528     ctx->sflow_odp_port = 0;
2529     ctx->sflow_n_outputs = 0;
2530 }
2531
2532 /* SAMPLE action for IPFIX must be 1st or 2nd action in any given list
2533  * of actions, eventually after the SAMPLE action for sFlow. */
2534 static void
2535 add_ipfix_action(struct xlate_ctx *ctx)
2536 {
2537     compose_ipfix_action(ctx->xbridge, ctx->xout->odp_actions,
2538                          &ctx->xin->flow, ODPP_NONE);
2539 }
2540
2541 static void
2542 add_ipfix_output_action(struct xlate_ctx *ctx, odp_port_t port)
2543 {
2544     compose_ipfix_action(ctx->xbridge, ctx->xout->odp_actions,
2545                          &ctx->xin->flow, port);
2546 }
2547
2548 /* Fix SAMPLE action according to data collected while composing ODP actions.
2549  * We need to fix SAMPLE actions OVS_SAMPLE_ATTR_ACTIONS attribute, i.e. nested
2550  * USERSPACE action's user-cookie which is required for sflow. */
2551 static void
2552 fix_sflow_action(struct xlate_ctx *ctx)
2553 {
2554     const struct flow *base = &ctx->base_flow;
2555     union user_action_cookie *cookie;
2556
2557     if (!ctx->user_cookie_offset) {
2558         return;
2559     }
2560
2561     cookie = ofpbuf_at(ctx->xout->odp_actions, ctx->user_cookie_offset,
2562                        sizeof cookie->sflow);
2563     ovs_assert(cookie->type == USER_ACTION_COOKIE_SFLOW);
2564
2565     compose_sflow_cookie(ctx->xbridge, base->vlan_tci,
2566                          ctx->sflow_odp_port, ctx->sflow_n_outputs, cookie);
2567 }
2568
2569 static enum slow_path_reason
2570 process_special(struct xlate_ctx *ctx, const struct flow *flow,
2571                 const struct xport *xport, const struct dp_packet *packet)
2572 {
2573     struct flow_wildcards *wc = &ctx->xout->wc;
2574     const struct xbridge *xbridge = ctx->xbridge;
2575
2576     if (!xport) {
2577         return 0;
2578     } else if (xport->cfm && cfm_should_process_flow(xport->cfm, flow, wc)) {
2579         if (packet) {
2580             cfm_process_heartbeat(xport->cfm, packet);
2581         }
2582         return SLOW_CFM;
2583     } else if (xport->bfd && bfd_should_process_flow(xport->bfd, flow, wc)) {
2584         if (packet) {
2585             bfd_process_packet(xport->bfd, flow, packet);
2586             /* If POLL received, immediately sends FINAL back. */
2587             if (bfd_should_send_packet(xport->bfd)) {
2588                 ofproto_dpif_monitor_port_send_soon(xport->ofport);
2589             }
2590         }
2591         return SLOW_BFD;
2592     } else if (xport->xbundle && xport->xbundle->lacp
2593                && flow->dl_type == htons(ETH_TYPE_LACP)) {
2594         if (packet) {
2595             lacp_process_packet(xport->xbundle->lacp, xport->ofport, packet);
2596         }
2597         return SLOW_LACP;
2598     } else if ((xbridge->stp || xbridge->rstp) &&
2599                stp_should_process_flow(flow, wc)) {
2600         if (packet) {
2601             xbridge->stp
2602                 ? stp_process_packet(xport, packet)
2603                 : rstp_process_packet(xport, packet);
2604         }
2605         return SLOW_STP;
2606     } else if (xport->lldp && lldp_should_process_flow(xport->lldp, flow)) {
2607         if (packet) {
2608             lldp_process_packet(xport->lldp, packet);
2609         }
2610         return SLOW_LLDP;
2611     } else {
2612         return 0;
2613     }
2614 }
2615
2616 static int
2617 tnl_route_lookup_flow(const struct flow *oflow,
2618                       ovs_be32 *ip, struct xport **out_port)
2619 {
2620     char out_dev[IFNAMSIZ];
2621     struct xbridge *xbridge;
2622     struct xlate_cfg *xcfg;
2623     ovs_be32 gw;
2624
2625     if (!ovs_router_lookup(oflow->tunnel.ip_dst, out_dev, &gw)) {
2626         return -ENOENT;
2627     }
2628
2629     if (gw) {
2630         *ip = gw;
2631     } else {
2632         *ip = oflow->tunnel.ip_dst;
2633     }
2634
2635     xcfg = ovsrcu_get(struct xlate_cfg *, &xcfgp);
2636     ovs_assert(xcfg);
2637
2638     HMAP_FOR_EACH (xbridge, hmap_node, &xcfg->xbridges) {
2639         if (!strncmp(xbridge->name, out_dev, IFNAMSIZ)) {
2640             struct xport *port;
2641
2642             HMAP_FOR_EACH (port, ofp_node, &xbridge->xports) {
2643                 if (!strncmp(netdev_get_name(port->netdev), out_dev, IFNAMSIZ)) {
2644                     *out_port = port;
2645                     return 0;
2646                 }
2647             }
2648         }
2649     }
2650     return -ENOENT;
2651 }
2652
2653 static int
2654 xlate_flood_packet(struct xbridge *xbridge, struct dp_packet *packet)
2655 {
2656     struct ofpact_output output;
2657     struct flow flow;
2658
2659     ofpact_init(&output.ofpact, OFPACT_OUTPUT, sizeof output);
2660     /* Use OFPP_NONE as the in_port to avoid special packet processing. */
2661     flow_extract(packet, &flow);
2662     flow.in_port.ofp_port = OFPP_NONE;
2663     output.port = OFPP_FLOOD;
2664     output.max_len = 0;
2665
2666     return ofproto_dpif_execute_actions(xbridge->ofproto, &flow, NULL,
2667                                         &output.ofpact, sizeof output,
2668                                         packet);
2669 }
2670
2671 static void
2672 tnl_send_arp_request(const struct xport *out_dev, const uint8_t eth_src[ETH_ADDR_LEN],
2673                      ovs_be32 ip_src, ovs_be32 ip_dst)
2674 {
2675     struct xbridge *xbridge = out_dev->xbridge;
2676     struct dp_packet packet;
2677
2678     dp_packet_init(&packet, 0);
2679     compose_arp(&packet, eth_src, ip_src, ip_dst);
2680
2681     xlate_flood_packet(xbridge, &packet);
2682     dp_packet_uninit(&packet);
2683 }
2684
2685 static int
2686 build_tunnel_send(const struct xlate_ctx *ctx, const struct xport *xport,
2687                   const struct flow *flow, odp_port_t tunnel_odp_port)
2688 {
2689     struct ovs_action_push_tnl tnl_push_data;
2690     struct xport *out_dev = NULL;
2691     ovs_be32 s_ip, d_ip = 0;
2692     uint8_t smac[ETH_ADDR_LEN];
2693     uint8_t dmac[ETH_ADDR_LEN];
2694     int err;
2695
2696     err = tnl_route_lookup_flow(flow, &d_ip, &out_dev);
2697     if (err) {
2698         return err;
2699     }
2700
2701     /* Use mac addr of bridge port of the peer. */
2702     err = netdev_get_etheraddr(out_dev->netdev, smac);
2703     if (err) {
2704         return err;
2705     }
2706
2707     err = netdev_get_in4(out_dev->netdev, (struct in_addr *) &s_ip, NULL);
2708     if (err) {
2709         return err;
2710     }
2711
2712     err = tnl_arp_lookup(out_dev->xbridge->name, d_ip, dmac);
2713     if (err) {
2714         tnl_send_arp_request(out_dev, smac, s_ip, d_ip);
2715         return err;
2716     }
2717     if (ctx->xin->xcache) {
2718         struct xc_entry *entry;
2719
2720         entry = xlate_cache_add_entry(ctx->xin->xcache, XC_TNL_ARP);
2721         ovs_strlcpy(entry->u.tnl_arp_cache.br_name, out_dev->xbridge->name,
2722                     sizeof entry->u.tnl_arp_cache.br_name);
2723         entry->u.tnl_arp_cache.d_ip = d_ip;
2724     }
2725     err = tnl_port_build_header(xport->ofport, flow,
2726                                 dmac, smac, s_ip, &tnl_push_data);
2727     if (err) {
2728         return err;
2729     }
2730     tnl_push_data.tnl_port = odp_to_u32(tunnel_odp_port);
2731     tnl_push_data.out_port = odp_to_u32(out_dev->odp_port);
2732     odp_put_tnl_push_action(ctx->xout->odp_actions, &tnl_push_data);
2733     return 0;
2734 }
2735
2736 static void
2737 compose_output_action__(struct xlate_ctx *ctx, ofp_port_t ofp_port,
2738                         const struct xlate_bond_recirc *xr, bool check_stp)
2739 {
2740     const struct xport *xport = get_ofp_port(ctx->xbridge, ofp_port);
2741     struct flow_wildcards *wc = &ctx->xout->wc;
2742     struct flow *flow = &ctx->xin->flow;
2743     struct flow_tnl flow_tnl;
2744     ovs_be16 flow_vlan_tci;
2745     uint32_t flow_pkt_mark;
2746     uint8_t flow_nw_tos;
2747     odp_port_t out_port, odp_port;
2748     bool tnl_push_pop_send = false;
2749     uint8_t dscp;
2750
2751     /* If 'struct flow' gets additional metadata, we'll need to zero it out
2752      * before traversing a patch port. */
2753     BUILD_ASSERT_DECL(FLOW_WC_SEQ == 31);
2754     memset(&flow_tnl, 0, sizeof flow_tnl);
2755
2756     if (!xport) {
2757         xlate_report(ctx, "Nonexistent output port");
2758         return;
2759     } else if (xport->config & OFPUTIL_PC_NO_FWD) {
2760         xlate_report(ctx, "OFPPC_NO_FWD set, skipping output");
2761         return;
2762     } else if (check_stp) {
2763         if (is_stp(&ctx->base_flow)) {
2764             if (!xport_stp_should_forward_bpdu(xport) &&
2765                 !xport_rstp_should_manage_bpdu(xport)) {
2766                 if (ctx->xbridge->stp != NULL) {
2767                     xlate_report(ctx, "STP not in listening state, "
2768                             "skipping bpdu output");
2769                 } else if (ctx->xbridge->rstp != NULL) {
2770                     xlate_report(ctx, "RSTP not managing BPDU in this state, "
2771                             "skipping bpdu output");
2772                 }
2773                 return;
2774             }
2775         } else if (!xport_stp_forward_state(xport) ||
2776                    !xport_rstp_forward_state(xport)) {
2777             if (ctx->xbridge->stp != NULL) {
2778                 xlate_report(ctx, "STP not in forwarding state, "
2779                         "skipping output");
2780             } else if (ctx->xbridge->rstp != NULL) {
2781                 xlate_report(ctx, "RSTP not in forwarding state, "
2782                         "skipping output");
2783             }
2784             return;
2785         }
2786     }
2787
2788     if (mbridge_has_mirrors(ctx->xbridge->mbridge) && xport->xbundle) {
2789         ctx->xout->mirrors |= xbundle_mirror_dst(xport->xbundle->xbridge,
2790                                                  xport->xbundle);
2791     }
2792
2793     if (xport->peer) {
2794         const struct xport *peer = xport->peer;
2795         struct flow old_flow = ctx->xin->flow;
2796         bool old_was_mpls = ctx->was_mpls;
2797         cls_version_t old_version = ctx->tables_version;
2798         enum slow_path_reason special;
2799         struct ofpbuf old_stack = ctx->stack;
2800         union mf_subvalue new_stack[1024 / sizeof(union mf_subvalue)];
2801         struct ofpbuf old_action_set = ctx->action_set;
2802         uint64_t actset_stub[1024 / 8];
2803
2804         ofpbuf_use_stub(&ctx->stack, new_stack, sizeof new_stack);
2805         ofpbuf_use_stub(&ctx->action_set, actset_stub, sizeof actset_stub);
2806         ctx->xbridge = peer->xbridge;
2807         flow->in_port.ofp_port = peer->ofp_port;
2808         flow->metadata = htonll(0);
2809         memset(&flow->tunnel, 0, sizeof flow->tunnel);
2810         memset(flow->regs, 0, sizeof flow->regs);
2811         flow->actset_output = OFPP_UNSET;
2812
2813         /* The bridge is now known so obtain its table version. */
2814         ctx->tables_version
2815             = ofproto_dpif_get_tables_version(ctx->xbridge->ofproto);
2816
2817         special = process_special(ctx, &ctx->xin->flow, peer,
2818                                   ctx->xin->packet);
2819         if (special) {
2820             ctx->xout->slow |= special;
2821         } else if (may_receive(peer, ctx)) {
2822             if (xport_stp_forward_state(peer) && xport_rstp_forward_state(peer)) {
2823                 xlate_table_action(ctx, flow->in_port.ofp_port, 0, true, true);
2824                 if (ctx->action_set.size) {
2825                     /* Translate action set only if not dropping the packet and
2826                      * not recirculating. */
2827                     if (!exit_recirculates(ctx)) {
2828                         xlate_action_set(ctx);
2829                     }
2830                 }
2831                 /* Check if need to recirculate. */
2832                 if (exit_recirculates(ctx)) {
2833                     compose_recirculate_action(ctx);
2834                 }
2835             } else {
2836                 /* Forwarding is disabled by STP and RSTP.  Let OFPP_NORMAL and
2837                  * the learning action look at the packet, then drop it. */
2838                 struct flow old_base_flow = ctx->base_flow;
2839                 size_t old_size = ctx->xout->odp_actions->size;
2840                 mirror_mask_t old_mirrors = ctx->xout->mirrors;
2841
2842                 xlate_table_action(ctx, flow->in_port.ofp_port, 0, true, true);
2843                 ctx->xout->mirrors = old_mirrors;
2844                 ctx->base_flow = old_base_flow;
2845                 ctx->xout->odp_actions->size = old_size;
2846
2847                 /* Undo changes that may have been done for recirculation. */
2848                 if (exit_recirculates(ctx)) {
2849                     ctx->action_set.size = ctx->recirc_action_offset;
2850                     ctx->recirc_action_offset = -1;
2851                     ctx->last_unroll_offset = -1;
2852                 }
2853             }
2854         }
2855
2856         ctx->xin->flow = old_flow;
2857         ctx->xbridge = xport->xbridge;
2858         ofpbuf_uninit(&ctx->action_set);
2859         ctx->action_set = old_action_set;
2860         ofpbuf_uninit(&ctx->stack);
2861         ctx->stack = old_stack;
2862
2863         /* Restore calling bridge's lookup version. */
2864         ctx->tables_version = old_version;
2865
2866         /* The peer bridge popping MPLS should have no effect on the original
2867          * bridge. */
2868         ctx->was_mpls = old_was_mpls;
2869
2870         /* The fact that the peer bridge exits (for any reason) does not mean
2871          * that the original bridge should exit.  Specifically, if the peer
2872          * bridge recirculates (which typically modifies the packet), the
2873          * original bridge must continue processing with the original, not the
2874          * recirculated packet! */
2875         ctx->exit = false;
2876
2877         if (ctx->xin->resubmit_stats) {
2878             netdev_vport_inc_tx(xport->netdev, ctx->xin->resubmit_stats);
2879             netdev_vport_inc_rx(peer->netdev, ctx->xin->resubmit_stats);
2880             if (peer->bfd) {
2881                 bfd_account_rx(peer->bfd, ctx->xin->resubmit_stats);
2882             }
2883         }
2884         if (ctx->xin->xcache) {
2885             struct xc_entry *entry;
2886
2887             entry = xlate_cache_add_entry(ctx->xin->xcache, XC_NETDEV);
2888             entry->u.dev.tx = netdev_ref(xport->netdev);
2889             entry->u.dev.rx = netdev_ref(peer->netdev);
2890             entry->u.dev.bfd = bfd_ref(peer->bfd);
2891         }
2892         return;
2893     }
2894
2895     flow_vlan_tci = flow->vlan_tci;
2896     flow_pkt_mark = flow->pkt_mark;
2897     flow_nw_tos = flow->nw_tos;
2898
2899     if (count_skb_priorities(xport)) {
2900         memset(&wc->masks.skb_priority, 0xff, sizeof wc->masks.skb_priority);
2901         if (dscp_from_skb_priority(xport, flow->skb_priority, &dscp)) {
2902             wc->masks.nw_tos |= IP_DSCP_MASK;
2903             flow->nw_tos &= ~IP_DSCP_MASK;
2904             flow->nw_tos |= dscp;
2905         }
2906     }
2907
2908     if (xport->is_tunnel) {
2909          /* Save tunnel metadata so that changes made due to
2910           * the Logical (tunnel) Port are not visible for any further
2911           * matches, while explicit set actions on tunnel metadata are.
2912           */
2913         flow_tnl = flow->tunnel;
2914         odp_port = tnl_port_send(xport->ofport, flow, &ctx->xout->wc);
2915         if (odp_port == ODPP_NONE) {
2916             xlate_report(ctx, "Tunneling decided against output");
2917             goto out; /* restore flow_nw_tos */
2918         }
2919         if (flow->tunnel.ip_dst == ctx->orig_tunnel_ip_dst) {
2920             xlate_report(ctx, "Not tunneling to our own address");
2921             goto out; /* restore flow_nw_tos */
2922         }
2923         if (ctx->xin->resubmit_stats) {
2924             netdev_vport_inc_tx(xport->netdev, ctx->xin->resubmit_stats);
2925         }
2926         if (ctx->xin->xcache) {
2927             struct xc_entry *entry;
2928
2929             entry = xlate_cache_add_entry(ctx->xin->xcache, XC_NETDEV);
2930             entry->u.dev.tx = netdev_ref(xport->netdev);
2931         }
2932         out_port = odp_port;
2933         if (ovs_native_tunneling_is_on(ctx->xbridge->ofproto)) {
2934             tnl_push_pop_send = true;
2935         } else {
2936             commit_odp_tunnel_action(flow, &ctx->base_flow,
2937                                      ctx->xout->odp_actions);
2938             flow->tunnel = flow_tnl; /* Restore tunnel metadata */
2939         }
2940     } else {
2941         odp_port = xport->odp_port;
2942         out_port = odp_port;
2943         if (ofproto_has_vlan_splinters(ctx->xbridge->ofproto)) {
2944             ofp_port_t vlandev_port;
2945
2946             wc->masks.vlan_tci |= htons(VLAN_VID_MASK | VLAN_CFI);
2947             vlandev_port = vsp_realdev_to_vlandev(ctx->xbridge->ofproto,
2948                                                   ofp_port, flow->vlan_tci);
2949             if (vlandev_port != ofp_port) {
2950                 out_port = ofp_port_to_odp_port(ctx->xbridge, vlandev_port);
2951                 flow->vlan_tci = htons(0);
2952             }
2953         }
2954     }
2955
2956     if (out_port != ODPP_NONE) {
2957         bool use_masked = ctx->xbridge->support.masked_set_action;
2958
2959         ctx->xout->slow |= commit_odp_actions(flow, &ctx->base_flow,
2960                                               ctx->xout->odp_actions,
2961                                               wc, use_masked);
2962
2963         if (xr) {
2964             struct ovs_action_hash *act_hash;
2965
2966             /* Hash action. */
2967             act_hash = nl_msg_put_unspec_uninit(ctx->xout->odp_actions,
2968                                                 OVS_ACTION_ATTR_HASH,
2969                                                 sizeof *act_hash);
2970             act_hash->hash_alg = xr->hash_alg;
2971             act_hash->hash_basis = xr->hash_basis;
2972
2973             /* Recirc action. */
2974             nl_msg_put_u32(ctx->xout->odp_actions, OVS_ACTION_ATTR_RECIRC,
2975                            xr->recirc_id);
2976         } else {
2977
2978             if (tnl_push_pop_send) {
2979                 build_tunnel_send(ctx, xport, flow, odp_port);
2980                 flow->tunnel = flow_tnl; /* Restore tunnel metadata */
2981             } else {
2982                 odp_port_t odp_tnl_port = ODPP_NONE;
2983
2984                 /* XXX: Write better Filter for tunnel port. We can use inport
2985                 * int tunnel-port flow to avoid these checks completely. */
2986                 if (ofp_port == OFPP_LOCAL &&
2987                     ovs_native_tunneling_is_on(ctx->xbridge->ofproto)) {
2988
2989                     odp_tnl_port = tnl_port_map_lookup(flow, wc);
2990                 }
2991
2992                 if (odp_tnl_port != ODPP_NONE) {
2993                     nl_msg_put_odp_port(ctx->xout->odp_actions,
2994                                         OVS_ACTION_ATTR_TUNNEL_POP,
2995                                         odp_tnl_port);
2996                 } else {
2997                     /* Tunnel push-pop action is not compatible with
2998                      * IPFIX action. */
2999                     add_ipfix_output_action(ctx, out_port);
3000                     nl_msg_put_odp_port(ctx->xout->odp_actions,
3001                                         OVS_ACTION_ATTR_OUTPUT,
3002                                         out_port);
3003                }
3004            }
3005         }
3006
3007         ctx->sflow_odp_port = odp_port;
3008         ctx->sflow_n_outputs++;
3009         ctx->xout->nf_output_iface = ofp_port;
3010     }
3011
3012  out:
3013     /* Restore flow */
3014     flow->vlan_tci = flow_vlan_tci;
3015     flow->pkt_mark = flow_pkt_mark;
3016     flow->nw_tos = flow_nw_tos;
3017 }
3018
3019 static void
3020 compose_output_action(struct xlate_ctx *ctx, ofp_port_t ofp_port,
3021                       const struct xlate_bond_recirc *xr)
3022 {
3023     compose_output_action__(ctx, ofp_port, xr, true);
3024 }
3025
3026 static void
3027 xlate_recursively(struct xlate_ctx *ctx, struct rule_dpif *rule)
3028 {
3029     struct rule_dpif *old_rule = ctx->rule;
3030     ovs_be64 old_cookie = ctx->rule_cookie;
3031     const struct rule_actions *actions;
3032
3033     if (ctx->xin->resubmit_stats) {
3034         rule_dpif_credit_stats(rule, ctx->xin->resubmit_stats);
3035     }
3036
3037     ctx->resubmits++;
3038     ctx->recurse++;
3039     ctx->rule = rule;
3040     ctx->rule_cookie = rule_dpif_get_flow_cookie(rule);
3041     actions = rule_dpif_get_actions(rule);
3042     do_xlate_actions(actions->ofpacts, actions->ofpacts_len, ctx);
3043     ctx->rule_cookie = old_cookie;
3044     ctx->rule = old_rule;
3045     ctx->recurse--;
3046 }
3047
3048 static bool
3049 xlate_resubmit_resource_check(struct xlate_ctx *ctx)
3050 {
3051     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 1);
3052
3053     if (ctx->recurse >= MAX_RESUBMIT_RECURSION + MAX_INTERNAL_RESUBMITS) {
3054         VLOG_ERR_RL(&rl, "resubmit actions recursed over %d times",
3055                     MAX_RESUBMIT_RECURSION);
3056     } else if (ctx->resubmits >= MAX_RESUBMITS + MAX_INTERNAL_RESUBMITS) {
3057         VLOG_ERR_RL(&rl, "over %d resubmit actions", MAX_RESUBMITS);
3058     } else if (ctx->xout->odp_actions->size > UINT16_MAX) {
3059         VLOG_ERR_RL(&rl, "resubmits yielded over 64 kB of actions");
3060     } else if (ctx->stack.size >= 65536) {
3061         VLOG_ERR_RL(&rl, "resubmits yielded over 64 kB of stack");
3062     } else {
3063         return true;
3064     }
3065
3066     return false;
3067 }
3068
3069 static void
3070 xlate_table_action(struct xlate_ctx *ctx, ofp_port_t in_port, uint8_t table_id,
3071                    bool may_packet_in, bool honor_table_miss)
3072 {
3073     /* Check if we need to recirculate before matching in a table. */
3074     if (ctx->was_mpls) {
3075         ctx_trigger_recirculation(ctx);
3076         return;
3077     }
3078     if (xlate_resubmit_resource_check(ctx)) {
3079         struct flow_wildcards *wc;
3080         uint8_t old_table_id = ctx->table_id;
3081         struct rule_dpif *rule;
3082
3083         ctx->table_id = table_id;
3084         wc = (ctx->xin->skip_wildcards) ? NULL : &ctx->xout->wc;
3085
3086         rule = rule_dpif_lookup_from_table(ctx->xbridge->ofproto,
3087                                            ctx->tables_version,
3088                                            &ctx->xin->flow, wc,
3089                                            ctx->xin->xcache != NULL,
3090                                            ctx->xin->resubmit_stats,
3091                                            &ctx->table_id, in_port,
3092                                            may_packet_in, honor_table_miss);
3093
3094         if (OVS_UNLIKELY(ctx->xin->resubmit_hook)) {
3095             ctx->xin->resubmit_hook(ctx->xin, rule, ctx->recurse + 1);
3096         }
3097
3098         if (rule) {
3099             /* Fill in the cache entry here instead of xlate_recursively
3100              * to make the reference counting more explicit.  We take a
3101              * reference in the lookups above if we are going to cache the
3102              * rule. */
3103             if (ctx->xin->xcache) {
3104                 struct xc_entry *entry;
3105
3106                 entry = xlate_cache_add_entry(ctx->xin->xcache, XC_RULE);
3107                 entry->u.rule = rule;
3108             }
3109             xlate_recursively(ctx, rule);
3110         }
3111
3112         ctx->table_id = old_table_id;
3113         return;
3114     }
3115
3116     ctx->exit = true;
3117 }
3118
3119 static void
3120 xlate_group_stats(struct xlate_ctx *ctx, struct group_dpif *group,
3121                   struct ofputil_bucket *bucket)
3122 {
3123     if (ctx->xin->resubmit_stats) {
3124         group_dpif_credit_stats(group, bucket, ctx->xin->resubmit_stats);
3125     }
3126     if (ctx->xin->xcache) {
3127         struct xc_entry *entry;
3128
3129         entry = xlate_cache_add_entry(ctx->xin->xcache, XC_GROUP);
3130         entry->u.group.group = group_dpif_ref(group);
3131         entry->u.group.bucket = bucket;
3132     }
3133 }
3134
3135 static void
3136 xlate_group_bucket(struct xlate_ctx *ctx, struct ofputil_bucket *bucket)
3137 {
3138     uint64_t action_list_stub[1024 / 8];
3139     struct ofpbuf action_list, action_set;
3140     struct flow old_flow = ctx->xin->flow;
3141     bool old_was_mpls = ctx->was_mpls;
3142
3143     ofpbuf_use_const(&action_set, bucket->ofpacts, bucket->ofpacts_len);
3144     ofpbuf_use_stub(&action_list, action_list_stub, sizeof action_list_stub);
3145
3146     ofpacts_execute_action_set(&action_list, &action_set);
3147     ctx->recurse++;
3148     do_xlate_actions(action_list.data, action_list.size, ctx);
3149     ctx->recurse--;
3150
3151     ofpbuf_uninit(&action_set);
3152     ofpbuf_uninit(&action_list);
3153
3154     /* Check if need to recirculate. */
3155     if (exit_recirculates(ctx)) {
3156         compose_recirculate_action(ctx);
3157     }
3158
3159     /* Roll back flow to previous state.
3160      * This is equivalent to cloning the packet for each bucket.
3161      *
3162      * As a side effect any subsequently applied actions will
3163      * also effectively be applied to a clone of the packet taken
3164      * just before applying the all or indirect group.
3165      *
3166      * Note that group buckets are action sets, hence they cannot modify the
3167      * main action set.  Also any stack actions are ignored when executing an
3168      * action set, so group buckets cannot change the stack either.
3169      * However, we do allow resubmit actions in group buckets, which could
3170      * break the above assumptions.  It is up to the controller to not mess up
3171      * with the action_set and stack in the tables resubmitted to from
3172      * group buckets. */
3173     ctx->xin->flow = old_flow;
3174
3175     /* The group bucket popping MPLS should have no effect after bucket
3176      * execution. */
3177     ctx->was_mpls = old_was_mpls;
3178
3179     /* The fact that the group bucket exits (for any reason) does not mean that
3180      * the translation after the group action should exit.  Specifically, if
3181      * the group bucket recirculates (which typically modifies the packet), the
3182      * actions after the group action must continue processing with the
3183      * original, not the recirculated packet! */
3184     ctx->exit = false;
3185 }
3186
3187 static void
3188 xlate_all_group(struct xlate_ctx *ctx, struct group_dpif *group)
3189 {
3190     struct ofputil_bucket *bucket;
3191     const struct ovs_list *buckets;
3192
3193     group_dpif_get_buckets(group, &buckets);
3194
3195     LIST_FOR_EACH (bucket, list_node, buckets) {
3196         xlate_group_bucket(ctx, bucket);
3197     }
3198     xlate_group_stats(ctx, group, NULL);
3199 }
3200
3201 static void
3202 xlate_ff_group(struct xlate_ctx *ctx, struct group_dpif *group)
3203 {
3204     struct ofputil_bucket *bucket;
3205
3206     bucket = group_first_live_bucket(ctx, group, 0);
3207     if (bucket) {
3208         xlate_group_bucket(ctx, bucket);
3209         xlate_group_stats(ctx, group, bucket);
3210     }
3211 }
3212
3213 static void
3214 xlate_default_select_group(struct xlate_ctx *ctx, struct group_dpif *group)
3215 {
3216     struct flow_wildcards *wc = &ctx->xout->wc;
3217     struct ofputil_bucket *bucket;
3218     uint32_t basis;
3219
3220     basis = flow_hash_symmetric_l4(&ctx->xin->flow, 0);
3221     flow_mask_hash_fields(&ctx->xin->flow, wc, NX_HASH_FIELDS_SYMMETRIC_L4);
3222     bucket = group_best_live_bucket(ctx, group, basis);
3223     if (bucket) {
3224         xlate_group_bucket(ctx, bucket);
3225         xlate_group_stats(ctx, group, bucket);
3226     }
3227 }
3228
3229 static void
3230 xlate_hash_fields_select_group(struct xlate_ctx *ctx, struct group_dpif *group)
3231 {
3232     struct mf_bitmap hash_fields = MF_BITMAP_INITIALIZER;
3233     struct flow_wildcards *wc = &ctx->xout->wc;
3234     const struct field_array *fields;
3235     struct ofputil_bucket *bucket;
3236     uint32_t basis;
3237     int i;
3238
3239     fields = group_dpif_get_fields(group);
3240     basis = hash_uint64(group_dpif_get_selection_method_param(group));
3241
3242     /* Determine which fields to hash */
3243     for (i = 0; i < MFF_N_IDS; i++) {
3244         if (bitmap_is_set(fields->used.bm, i)) {
3245             const struct mf_field *mf;
3246
3247             /* If the field is already present in 'hash_fields' then
3248              * this loop has already checked that it and its pre-requisites
3249              * are present in the flow and its pre-requisites have
3250              * already been added to 'hash_fields'. There is nothing more
3251              * to do here and as an optimisation the loop can continue. */
3252             if (bitmap_is_set(hash_fields.bm, i)) {
3253                 continue;
3254             }
3255
3256             mf = mf_from_id(i);
3257
3258             /* Only hash a field if it and its pre-requisites are present
3259              * in the flow. */
3260             if (!mf_are_prereqs_ok(mf, &ctx->xin->flow)) {
3261                 continue;
3262             }
3263
3264             /* Hash both the field and its pre-requisites */
3265             mf_bitmap_set_field_and_prereqs(mf, &hash_fields);
3266         }
3267     }
3268
3269     /* Hash the fields */
3270     for (i = 0; i < MFF_N_IDS; i++) {
3271         if (bitmap_is_set(hash_fields.bm, i)) {
3272             const struct mf_field *mf = mf_from_id(i);
3273             union mf_value value;
3274             int j;
3275
3276             mf_get_value(mf, &ctx->xin->flow, &value);
3277             /* This seems inefficient but so does apply_mask() */
3278             for (j = 0; j < mf->n_bytes; j++) {
3279                 ((uint8_t *) &value)[j] &= ((uint8_t *) &fields->value[i])[j];
3280             }
3281             basis = hash_bytes(&value, mf->n_bytes, basis);
3282
3283             mf_mask_field(mf, &wc->masks);
3284         }
3285     }
3286
3287     bucket = group_best_live_bucket(ctx, group, basis);
3288     if (bucket) {
3289         xlate_group_bucket(ctx, bucket);
3290         xlate_group_stats(ctx, group, bucket);
3291     }
3292 }
3293
3294 static void
3295 xlate_select_group(struct xlate_ctx *ctx, struct group_dpif *group)
3296 {
3297     const char *selection_method = group_dpif_get_selection_method(group);
3298
3299     if (selection_method[0] == '\0') {
3300         xlate_default_select_group(ctx, group);
3301     } else if (!strcasecmp("hash", selection_method)) {
3302         xlate_hash_fields_select_group(ctx, group);
3303     } else {
3304         /* Parsing of groups should ensure this never happens */
3305         OVS_NOT_REACHED();
3306     }
3307 }
3308
3309 static void
3310 xlate_group_action__(struct xlate_ctx *ctx, struct group_dpif *group)
3311 {
3312     ctx->in_group = true;
3313
3314     switch (group_dpif_get_type(group)) {
3315     case OFPGT11_ALL:
3316     case OFPGT11_INDIRECT:
3317         xlate_all_group(ctx, group);
3318         break;
3319     case OFPGT11_SELECT:
3320         xlate_select_group(ctx, group);
3321         break;
3322     case OFPGT11_FF:
3323         xlate_ff_group(ctx, group);
3324         break;
3325     default:
3326         OVS_NOT_REACHED();
3327     }
3328     group_dpif_unref(group);
3329
3330     ctx->in_group = false;
3331 }
3332
3333 static bool
3334 xlate_group_resource_check(struct xlate_ctx *ctx)
3335 {
3336     if (!xlate_resubmit_resource_check(ctx)) {
3337         return false;
3338     } else if (ctx->in_group) {
3339         /* Prevent nested translation of OpenFlow groups.
3340          *
3341          * OpenFlow allows this restriction.  We enforce this restriction only
3342          * because, with the current architecture, we would otherwise have to
3343          * take a possibly recursive read lock on the ofgroup rwlock, which is
3344          * unsafe given that POSIX allows taking a read lock to block if there
3345          * is a thread blocked on taking the write lock.  Other solutions
3346          * without this restriction are also possible, but seem unwarranted
3347          * given the current limited use of groups. */
3348         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 1);
3349
3350         VLOG_ERR_RL(&rl, "cannot recursively translate OpenFlow group");
3351         return false;
3352     } else {
3353         return true;
3354     }
3355 }
3356
3357 static bool
3358 xlate_group_action(struct xlate_ctx *ctx, uint32_t group_id)
3359 {
3360     if (xlate_group_resource_check(ctx)) {
3361         struct group_dpif *group;
3362         bool got_group;
3363
3364         got_group = group_dpif_lookup(ctx->xbridge->ofproto, group_id, &group);
3365         if (got_group) {
3366             xlate_group_action__(ctx, group);
3367         } else {
3368             return true;
3369         }
3370     }
3371
3372     return false;
3373 }
3374
3375 static void
3376 xlate_ofpact_resubmit(struct xlate_ctx *ctx,
3377                       const struct ofpact_resubmit *resubmit)
3378 {
3379     ofp_port_t in_port;
3380     uint8_t table_id;
3381     bool may_packet_in = false;
3382     bool honor_table_miss = false;
3383
3384     if (ctx->rule && rule_dpif_is_internal(ctx->rule)) {
3385         /* Still allow missed packets to be sent to the controller
3386          * if resubmitting from an internal table. */
3387         may_packet_in = true;
3388         honor_table_miss = true;
3389     }
3390
3391     in_port = resubmit->in_port;
3392     if (in_port == OFPP_IN_PORT) {
3393         in_port = ctx->xin->flow.in_port.ofp_port;
3394     }
3395
3396     table_id = resubmit->table_id;
3397     if (table_id == 255) {
3398         table_id = ctx->table_id;
3399     }
3400
3401     xlate_table_action(ctx, in_port, table_id, may_packet_in,
3402                        honor_table_miss);
3403 }
3404
3405 static void
3406 flood_packets(struct xlate_ctx *ctx, bool all)
3407 {
3408     const struct xport *xport;
3409
3410     HMAP_FOR_EACH (xport, ofp_node, &ctx->xbridge->xports) {
3411         if (xport->ofp_port == ctx->xin->flow.in_port.ofp_port) {
3412             continue;
3413         }
3414
3415         if (all) {
3416             compose_output_action__(ctx, xport->ofp_port, NULL, false);
3417         } else if (!(xport->config & OFPUTIL_PC_NO_FLOOD)) {
3418             compose_output_action(ctx, xport->ofp_port, NULL);
3419         }
3420     }
3421
3422     ctx->xout->nf_output_iface = NF_OUT_FLOOD;
3423 }
3424
3425 static void
3426 execute_controller_action(struct xlate_ctx *ctx, int len,
3427                           enum ofp_packet_in_reason reason,
3428                           uint16_t controller_id)
3429 {
3430     struct ofproto_packet_in *pin;
3431     struct dp_packet *packet;
3432     bool use_masked;
3433
3434     ctx->xout->slow |= SLOW_CONTROLLER;
3435     if (!ctx->xin->packet) {
3436         return;
3437     }
3438
3439     packet = dp_packet_clone(ctx->xin->packet);
3440
3441     use_masked = ctx->xbridge->support.masked_set_action;
3442     ctx->xout->slow |= commit_odp_actions(&ctx->xin->flow, &ctx->base_flow,
3443                                           ctx->xout->odp_actions,
3444                                           &ctx->xout->wc, use_masked);
3445
3446     odp_execute_actions(NULL, &packet, 1, false,
3447                         ctx->xout->odp_actions->data,
3448                         ctx->xout->odp_actions->size, NULL);
3449
3450     pin = xmalloc(sizeof *pin);
3451     pin->up.packet_len = dp_packet_size(packet);
3452     pin->up.packet = dp_packet_steal_data(packet);
3453     pin->up.reason = reason;
3454     pin->up.table_id = ctx->table_id;
3455     pin->up.cookie = ctx->rule_cookie;
3456
3457     flow_get_metadata(&ctx->xin->flow, &pin->up.flow_metadata);
3458
3459     pin->controller_id = controller_id;
3460     pin->send_len = len;
3461     /* If a rule is a table-miss rule then this is
3462      * a table-miss handled by a table-miss rule.
3463      *
3464      * Else, if rule is internal and has a controller action,
3465      * the later being implied by the rule being processed here,
3466      * then this is a table-miss handled without a table-miss rule.
3467      *
3468      * Otherwise this is not a table-miss. */
3469     pin->miss_type = OFPROTO_PACKET_IN_NO_MISS;
3470     if (ctx->rule) {
3471         if (rule_dpif_is_table_miss(ctx->rule)) {
3472             pin->miss_type = OFPROTO_PACKET_IN_MISS_FLOW;
3473         } else if (rule_dpif_is_internal(ctx->rule)) {
3474             pin->miss_type = OFPROTO_PACKET_IN_MISS_WITHOUT_FLOW;
3475         }
3476     }
3477     ofproto_dpif_send_packet_in(ctx->xbridge->ofproto, pin);
3478     dp_packet_delete(packet);
3479 }
3480
3481 /* Called only when ctx->recirc_action_offset is set. */
3482 static void
3483 compose_recirculate_action(struct xlate_ctx *ctx)
3484 {
3485     struct recirc_metadata md;
3486     bool use_masked;
3487     uint32_t id;
3488
3489     use_masked = ctx->xbridge->support.masked_set_action;
3490     ctx->xout->slow |= commit_odp_actions(&ctx->xin->flow, &ctx->base_flow,
3491                                           ctx->xout->odp_actions,
3492                                           &ctx->xout->wc, use_masked);
3493
3494     recirc_metadata_from_flow(&md, &ctx->xin->flow);
3495
3496     ovs_assert(ctx->recirc_action_offset >= 0);
3497
3498     /* Only allocate recirculation ID if we have a packet. */
3499     if (ctx->xin->packet) {
3500         /* Allocate a unique recirc id for the given metadata state in the
3501          * flow.  The life-cycle of this recirc id is managed by associating it
3502          * with the udpif key ('ukey') created for each new datapath flow. */
3503         id = recirc_alloc_id_ctx(ctx->xbridge->ofproto, 0, &md, &ctx->stack,
3504                                  ctx->recirc_action_offset,
3505                                  ctx->action_set.size, ctx->action_set.data);
3506         if (!id) {
3507             static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
3508             VLOG_ERR_RL(&rl, "Failed to allocate recirculation id");
3509             return;
3510         }
3511         xlate_out_add_recirc(ctx->xout, id);
3512     } else {
3513         /* Look up an existing recirc id for the given metadata state in the
3514          * flow.  No new reference is taken, as the ID is RCU protected and is
3515          * only required temporarily for verification. */
3516         id = recirc_find_id(ctx->xbridge->ofproto, 0, &md, &ctx->stack,
3517                             ctx->recirc_action_offset,
3518                             ctx->action_set.size, ctx->action_set.data);
3519         /* We let zero 'id' to be used in the RECIRC action below, which will
3520          * fail all revalidations as zero is not a valid recirculation ID. */
3521     }
3522
3523     nl_msg_put_u32(ctx->xout->odp_actions, OVS_ACTION_ATTR_RECIRC, id);
3524
3525     /* Undo changes done by recirculation. */
3526     ctx->action_set.size = ctx->recirc_action_offset;
3527     ctx->recirc_action_offset = -1;
3528     ctx->last_unroll_offset = -1;
3529 }
3530
3531 static void
3532 compose_mpls_push_action(struct xlate_ctx *ctx, struct ofpact_push_mpls *mpls)
3533 {
3534     struct flow_wildcards *wc = &ctx->xout->wc;
3535     struct flow *flow = &ctx->xin->flow;
3536     int n;
3537
3538     ovs_assert(eth_type_mpls(mpls->ethertype));
3539
3540     n = flow_count_mpls_labels(flow, wc);
3541     if (!n) {
3542         bool use_masked = ctx->xbridge->support.masked_set_action;
3543
3544         ctx->xout->slow |= commit_odp_actions(flow, &ctx->base_flow,
3545                                               ctx->xout->odp_actions,
3546                                               &ctx->xout->wc, use_masked);
3547     } else if (n >= FLOW_MAX_MPLS_LABELS) {
3548         if (ctx->xin->packet != NULL) {
3549             static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
3550             VLOG_WARN_RL(&rl, "bridge %s: dropping packet on which an "
3551                          "MPLS push action can't be performed as it would "
3552                          "have more MPLS LSEs than the %d supported.",
3553                          ctx->xbridge->name, FLOW_MAX_MPLS_LABELS);
3554         }
3555         ctx->exit = true;
3556         return;
3557     }
3558
3559     flow_push_mpls(flow, n, mpls->ethertype, wc);
3560 }
3561
3562 static void
3563 compose_mpls_pop_action(struct xlate_ctx *ctx, ovs_be16 eth_type)
3564 {
3565     struct flow_wildcards *wc = &ctx->xout->wc;
3566     struct flow *flow = &ctx->xin->flow;
3567     int n = flow_count_mpls_labels(flow, wc);
3568
3569     if (flow_pop_mpls(flow, n, eth_type, wc)) {
3570         if (ctx->xbridge->support.recirc) {
3571             ctx->was_mpls = true;
3572         }
3573     } else if (n >= FLOW_MAX_MPLS_LABELS) {
3574         if (ctx->xin->packet != NULL) {
3575             static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
3576             VLOG_WARN_RL(&rl, "bridge %s: dropping packet on which an "
3577                          "MPLS pop action can't be performed as it has "
3578                          "more MPLS LSEs than the %d supported.",
3579                          ctx->xbridge->name, FLOW_MAX_MPLS_LABELS);
3580         }
3581         ctx->exit = true;
3582         ofpbuf_clear(ctx->xout->odp_actions);
3583     }
3584 }
3585
3586 static bool
3587 compose_dec_ttl(struct xlate_ctx *ctx, struct ofpact_cnt_ids *ids)
3588 {
3589     struct flow *flow = &ctx->xin->flow;
3590
3591     if (!is_ip_any(flow)) {
3592         return false;
3593     }
3594
3595     ctx->xout->wc.masks.nw_ttl = 0xff;
3596     if (flow->nw_ttl > 1) {
3597         flow->nw_ttl--;
3598         return false;
3599     } else {
3600         size_t i;
3601
3602         for (i = 0; i < ids->n_controllers; i++) {
3603             execute_controller_action(ctx, UINT16_MAX, OFPR_INVALID_TTL,
3604                                       ids->cnt_ids[i]);
3605         }
3606
3607         /* Stop processing for current table. */
3608         return true;
3609     }
3610 }
3611
3612 static void
3613 compose_set_mpls_label_action(struct xlate_ctx *ctx, ovs_be32 label)
3614 {
3615     if (eth_type_mpls(ctx->xin->flow.dl_type)) {
3616         ctx->xout->wc.masks.mpls_lse[0] |= htonl(MPLS_LABEL_MASK);
3617         set_mpls_lse_label(&ctx->xin->flow.mpls_lse[0], label);
3618     }
3619 }
3620
3621 static void
3622 compose_set_mpls_tc_action(struct xlate_ctx *ctx, uint8_t tc)
3623 {
3624     if (eth_type_mpls(ctx->xin->flow.dl_type)) {
3625         ctx->xout->wc.masks.mpls_lse[0] |= htonl(MPLS_TC_MASK);
3626         set_mpls_lse_tc(&ctx->xin->flow.mpls_lse[0], tc);
3627     }
3628 }
3629
3630 static void
3631 compose_set_mpls_ttl_action(struct xlate_ctx *ctx, uint8_t ttl)
3632 {
3633     if (eth_type_mpls(ctx->xin->flow.dl_type)) {
3634         ctx->xout->wc.masks.mpls_lse[0] |= htonl(MPLS_TTL_MASK);
3635         set_mpls_lse_ttl(&ctx->xin->flow.mpls_lse[0], ttl);
3636     }
3637 }
3638
3639 static bool
3640 compose_dec_mpls_ttl_action(struct xlate_ctx *ctx)
3641 {
3642     struct flow *flow = &ctx->xin->flow;
3643     struct flow_wildcards *wc = &ctx->xout->wc;
3644
3645     if (eth_type_mpls(flow->dl_type)) {
3646         uint8_t ttl = mpls_lse_to_ttl(flow->mpls_lse[0]);
3647
3648         wc->masks.mpls_lse[0] |= htonl(MPLS_TTL_MASK);
3649         if (ttl > 1) {
3650             ttl--;
3651             set_mpls_lse_ttl(&flow->mpls_lse[0], ttl);
3652             return false;
3653         } else {
3654             execute_controller_action(ctx, UINT16_MAX, OFPR_INVALID_TTL, 0);
3655         }
3656     }
3657
3658     /* Stop processing for current table. */
3659     return true;
3660 }
3661
3662 static void
3663 xlate_output_action(struct xlate_ctx *ctx,
3664                     ofp_port_t port, uint16_t max_len, bool may_packet_in)
3665 {
3666     ofp_port_t prev_nf_output_iface = ctx->xout->nf_output_iface;
3667
3668     ctx->xout->nf_output_iface = NF_OUT_DROP;
3669
3670     switch (port) {
3671     case OFPP_IN_PORT:
3672         compose_output_action(ctx, ctx->xin->flow.in_port.ofp_port, NULL);
3673         break;
3674     case OFPP_TABLE:
3675         xlate_table_action(ctx, ctx->xin->flow.in_port.ofp_port,
3676                            0, may_packet_in, true);
3677         break;
3678     case OFPP_NORMAL:
3679         xlate_normal(ctx);
3680         break;
3681     case OFPP_FLOOD:
3682         flood_packets(ctx,  false);
3683         break;
3684     case OFPP_ALL:
3685         flood_packets(ctx, true);
3686         break;
3687     case OFPP_CONTROLLER:
3688         execute_controller_action(ctx, max_len,
3689                                   (ctx->in_group ? OFPR_GROUP
3690                                    : ctx->in_action_set ? OFPR_ACTION_SET
3691                                    : OFPR_ACTION),
3692                                   0);
3693         break;
3694     case OFPP_NONE:
3695         break;
3696     case OFPP_LOCAL:
3697     default:
3698         if (port != ctx->xin->flow.in_port.ofp_port) {
3699             compose_output_action(ctx, port, NULL);
3700         } else {
3701             xlate_report(ctx, "skipping output to input port");
3702         }
3703         break;
3704     }
3705
3706     if (prev_nf_output_iface == NF_OUT_FLOOD) {
3707         ctx->xout->nf_output_iface = NF_OUT_FLOOD;
3708     } else if (ctx->xout->nf_output_iface == NF_OUT_DROP) {
3709         ctx->xout->nf_output_iface = prev_nf_output_iface;
3710     } else if (prev_nf_output_iface != NF_OUT_DROP &&
3711                ctx->xout->nf_output_iface != NF_OUT_FLOOD) {
3712         ctx->xout->nf_output_iface = NF_OUT_MULTI;
3713     }
3714 }
3715
3716 static void
3717 xlate_output_reg_action(struct xlate_ctx *ctx,
3718                         const struct ofpact_output_reg *or)
3719 {
3720     uint64_t port = mf_get_subfield(&or->src, &ctx->xin->flow);
3721     if (port <= UINT16_MAX) {
3722         union mf_subvalue value;
3723
3724         memset(&value, 0xff, sizeof value);
3725         mf_write_subfield_flow(&or->src, &value, &ctx->xout->wc.masks);
3726         xlate_output_action(ctx, u16_to_ofp(port),
3727                             or->max_len, false);
3728     }
3729 }
3730
3731 static void
3732 xlate_enqueue_action(struct xlate_ctx *ctx,
3733                      const struct ofpact_enqueue *enqueue)
3734 {
3735     ofp_port_t ofp_port = enqueue->port;
3736     uint32_t queue_id = enqueue->queue;
3737     uint32_t flow_priority, priority;
3738     int error;
3739
3740     /* Translate queue to priority. */
3741     error = dpif_queue_to_priority(ctx->xbridge->dpif, queue_id, &priority);
3742     if (error) {
3743         /* Fall back to ordinary output action. */
3744         xlate_output_action(ctx, enqueue->port, 0, false);
3745         return;
3746     }
3747
3748     /* Check output port. */
3749     if (ofp_port == OFPP_IN_PORT) {
3750         ofp_port = ctx->xin->flow.in_port.ofp_port;
3751     } else if (ofp_port == ctx->xin->flow.in_port.ofp_port) {
3752         return;
3753     }
3754
3755     /* Add datapath actions. */
3756     flow_priority = ctx->xin->flow.skb_priority;
3757     ctx->xin->flow.skb_priority = priority;
3758     compose_output_action(ctx, ofp_port, NULL);
3759     ctx->xin->flow.skb_priority = flow_priority;
3760
3761     /* Update NetFlow output port. */
3762     if (ctx->xout->nf_output_iface == NF_OUT_DROP) {
3763         ctx->xout->nf_output_iface = ofp_port;
3764     } else if (ctx->xout->nf_output_iface != NF_OUT_FLOOD) {
3765         ctx->xout->nf_output_iface = NF_OUT_MULTI;
3766     }
3767 }
3768
3769 static void
3770 xlate_set_queue_action(struct xlate_ctx *ctx, uint32_t queue_id)
3771 {
3772     uint32_t skb_priority;
3773
3774     if (!dpif_queue_to_priority(ctx->xbridge->dpif, queue_id, &skb_priority)) {
3775         ctx->xin->flow.skb_priority = skb_priority;
3776     } else {
3777         /* Couldn't translate queue to a priority.  Nothing to do.  A warning
3778          * has already been logged. */
3779     }
3780 }
3781
3782 static bool
3783 slave_enabled_cb(ofp_port_t ofp_port, void *xbridge_)
3784 {
3785     const struct xbridge *xbridge = xbridge_;
3786     struct xport *port;
3787
3788     switch (ofp_port) {
3789     case OFPP_IN_PORT:
3790     case OFPP_TABLE:
3791     case OFPP_NORMAL:
3792     case OFPP_FLOOD:
3793     case OFPP_ALL:
3794     case OFPP_NONE:
3795         return true;
3796     case OFPP_CONTROLLER: /* Not supported by the bundle action. */
3797         return false;
3798     default:
3799         port = get_ofp_port(xbridge, ofp_port);
3800         return port ? port->may_enable : false;
3801     }
3802 }
3803
3804 static void
3805 xlate_bundle_action(struct xlate_ctx *ctx,
3806                     const struct ofpact_bundle *bundle)
3807 {
3808     ofp_port_t port;
3809
3810     port = bundle_execute(bundle, &ctx->xin->flow, &ctx->xout->wc,
3811                           slave_enabled_cb,
3812                           CONST_CAST(struct xbridge *, ctx->xbridge));
3813     if (bundle->dst.field) {
3814         nxm_reg_load(&bundle->dst, ofp_to_u16(port), &ctx->xin->flow,
3815                      &ctx->xout->wc);
3816     } else {
3817         xlate_output_action(ctx, port, 0, false);
3818     }
3819 }
3820
3821 static void
3822 xlate_learn_action__(struct xlate_ctx *ctx, const struct ofpact_learn *learn,
3823                      struct ofputil_flow_mod *fm, struct ofpbuf *ofpacts)
3824 {
3825     learn_execute(learn, &ctx->xin->flow, fm, ofpacts);
3826     if (ctx->xin->may_learn) {
3827         ofproto_dpif_flow_mod(ctx->xbridge->ofproto, fm);
3828     }
3829 }
3830
3831 static void
3832 xlate_learn_action(struct xlate_ctx *ctx, const struct ofpact_learn *learn)
3833 {
3834     ctx->xout->has_learn = true;
3835     learn_mask(learn, &ctx->xout->wc);
3836
3837     if (ctx->xin->xcache) {
3838         struct xc_entry *entry;
3839
3840         entry = xlate_cache_add_entry(ctx->xin->xcache, XC_LEARN);
3841         entry->u.learn.ofproto = ctx->xbridge->ofproto;
3842         entry->u.learn.fm = xmalloc(sizeof *entry->u.learn.fm);
3843         entry->u.learn.ofpacts = ofpbuf_new(64);
3844         xlate_learn_action__(ctx, learn, entry->u.learn.fm,
3845                              entry->u.learn.ofpacts);
3846     } else if (ctx->xin->may_learn) {
3847         uint64_t ofpacts_stub[1024 / 8];
3848         struct ofputil_flow_mod fm;
3849         struct ofpbuf ofpacts;
3850
3851         ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
3852         xlate_learn_action__(ctx, learn, &fm, &ofpacts);
3853         ofpbuf_uninit(&ofpacts);
3854     }
3855 }
3856
3857 static void
3858 xlate_fin_timeout__(struct rule_dpif *rule, uint16_t tcp_flags,
3859                     uint16_t idle_timeout, uint16_t hard_timeout)
3860 {
3861     if (tcp_flags & (TCP_FIN | TCP_RST)) {
3862         rule_dpif_reduce_timeouts(rule, idle_timeout, hard_timeout);
3863     }
3864 }
3865
3866 static void
3867 xlate_fin_timeout(struct xlate_ctx *ctx,
3868                   const struct ofpact_fin_timeout *oft)
3869 {
3870     if (ctx->rule) {
3871         xlate_fin_timeout__(ctx->rule, ctx->xin->tcp_flags,
3872                             oft->fin_idle_timeout, oft->fin_hard_timeout);
3873         if (ctx->xin->xcache) {
3874             struct xc_entry *entry;
3875
3876             entry = xlate_cache_add_entry(ctx->xin->xcache, XC_FIN_TIMEOUT);
3877             /* XC_RULE already holds a reference on the rule, none is taken
3878              * here. */
3879             entry->u.fin.rule = ctx->rule;
3880             entry->u.fin.idle = oft->fin_idle_timeout;
3881             entry->u.fin.hard = oft->fin_hard_timeout;
3882         }
3883     }
3884 }
3885
3886 static void
3887 xlate_sample_action(struct xlate_ctx *ctx,
3888                     const struct ofpact_sample *os)
3889 {
3890     union user_action_cookie cookie;
3891     /* Scale the probability from 16-bit to 32-bit while representing
3892      * the same percentage. */
3893     uint32_t probability = (os->probability << 16) | os->probability;
3894     bool use_masked;
3895
3896     if (!ctx->xbridge->support.variable_length_userdata) {
3897         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 1);
3898
3899         VLOG_ERR_RL(&rl, "ignoring NXAST_SAMPLE action because datapath "
3900                     "lacks support (needs Linux 3.10+ or kernel module from "
3901                     "OVS 1.11+)");
3902         return;
3903     }
3904
3905     use_masked = ctx->xbridge->support.masked_set_action;
3906     ctx->xout->slow |= commit_odp_actions(&ctx->xin->flow, &ctx->base_flow,
3907                                           ctx->xout->odp_actions,
3908                                           &ctx->xout->wc, use_masked);
3909
3910     compose_flow_sample_cookie(os->probability, os->collector_set_id,
3911                                os->obs_domain_id, os->obs_point_id, &cookie);
3912     compose_sample_action(ctx->xbridge, ctx->xout->odp_actions,
3913                           &ctx->xin->flow, probability, &cookie,
3914                           sizeof cookie.flow_sample, ODPP_NONE);
3915 }
3916
3917 static bool
3918 may_receive(const struct xport *xport, struct xlate_ctx *ctx)
3919 {
3920     if (xport->config & (is_stp(&ctx->xin->flow)
3921                          ? OFPUTIL_PC_NO_RECV_STP
3922                          : OFPUTIL_PC_NO_RECV)) {
3923         return false;
3924     }
3925
3926     /* Only drop packets here if both forwarding and learning are
3927      * disabled.  If just learning is enabled, we need to have
3928      * OFPP_NORMAL and the learning action have a look at the packet
3929      * before we can drop it. */
3930     if ((!xport_stp_forward_state(xport) && !xport_stp_learn_state(xport)) ||
3931         (!xport_rstp_forward_state(xport) && !xport_rstp_learn_state(xport))) {
3932         return false;
3933     }
3934
3935     return true;
3936 }
3937
3938 static void
3939 xlate_write_actions(struct xlate_ctx *ctx, const struct ofpact *a)
3940 {
3941     const struct ofpact_nest *on = ofpact_get_WRITE_ACTIONS(a);
3942     size_t on_len = ofpact_nest_get_action_len(on);
3943     const struct ofpact *inner;
3944
3945     /* Maintain actset_output depending on the contents of the action set:
3946      *
3947      *   - OFPP_UNSET, if there is no "output" action.
3948      *
3949      *   - The output port, if there is an "output" action and no "group"
3950      *     action.
3951      *
3952      *   - OFPP_UNSET, if there is a "group" action.
3953      */
3954     if (!ctx->action_set_has_group) {
3955         OFPACT_FOR_EACH (inner, on->actions, on_len) {
3956             if (inner->type == OFPACT_OUTPUT) {
3957                 ctx->xin->flow.actset_output = ofpact_get_OUTPUT(inner)->port;
3958             } else if (inner->type == OFPACT_GROUP) {
3959                 ctx->xin->flow.actset_output = OFPP_UNSET;
3960                 ctx->action_set_has_group = true;
3961                 break;
3962             }
3963         }
3964     }
3965
3966     ofpbuf_put(&ctx->action_set, on->actions, on_len);
3967     ofpact_pad(&ctx->action_set);
3968 }
3969
3970 static void
3971 xlate_action_set(struct xlate_ctx *ctx)
3972 {
3973     uint64_t action_list_stub[1024 / 64];
3974     struct ofpbuf action_list;
3975
3976     ctx->in_action_set = true;
3977     ofpbuf_use_stub(&action_list, action_list_stub, sizeof action_list_stub);
3978     ofpacts_execute_action_set(&action_list, &ctx->action_set);
3979     /* Clear the action set, as it is not needed any more. */
3980     ofpbuf_clear(&ctx->action_set);
3981     do_xlate_actions(action_list.data, action_list.size, ctx);
3982     ctx->in_action_set = false;
3983     ofpbuf_uninit(&action_list);
3984 }
3985
3986 static void
3987 recirc_put_unroll_xlate(struct xlate_ctx *ctx)
3988 {
3989     struct ofpact_unroll_xlate *unroll;
3990
3991     unroll = ctx->last_unroll_offset < 0
3992         ? NULL
3993         : ALIGNED_CAST(struct ofpact_unroll_xlate *,
3994                        (char *)ctx->action_set.data + ctx->last_unroll_offset);
3995
3996     /* Restore the table_id and rule cookie for a potential PACKET
3997      * IN if needed. */
3998     if (!unroll ||
3999         (ctx->table_id != unroll->rule_table_id
4000          || ctx->rule_cookie != unroll->rule_cookie)) {
4001
4002         ctx->last_unroll_offset = ctx->action_set.size;
4003         unroll = ofpact_put_UNROLL_XLATE(&ctx->action_set);
4004         unroll->rule_table_id = ctx->table_id;
4005         unroll->rule_cookie = ctx->rule_cookie;
4006     }
4007 }
4008
4009
4010 /* Copy remaining actions to the action_set to be executed after recirculation.
4011  * UNROLL_XLATE action is inserted, if not already done so, before actions that
4012  * may generate PACKET_INs from the current table and without matching another
4013  * rule. */
4014 static void
4015 recirc_unroll_actions(const struct ofpact *ofpacts, size_t ofpacts_len,
4016                       struct xlate_ctx *ctx)
4017 {
4018     const struct ofpact *a;
4019
4020     OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
4021         switch (a->type) {
4022             /* May generate PACKET INs. */
4023         case OFPACT_OUTPUT_REG:
4024         case OFPACT_GROUP:
4025         case OFPACT_OUTPUT:
4026         case OFPACT_CONTROLLER:
4027         case OFPACT_DEC_MPLS_TTL:
4028         case OFPACT_DEC_TTL:
4029             recirc_put_unroll_xlate(ctx);
4030             break;
4031
4032             /* These may not generate PACKET INs. */
4033         case OFPACT_SET_TUNNEL:
4034         case OFPACT_REG_MOVE:
4035         case OFPACT_SET_FIELD:
4036         case OFPACT_STACK_PUSH:
4037         case OFPACT_STACK_POP:
4038         case OFPACT_LEARN:
4039         case OFPACT_WRITE_METADATA:
4040         case OFPACT_RESUBMIT:        /* May indirectly generate PACKET INs, */
4041         case OFPACT_GOTO_TABLE:      /* but from a different table and rule. */
4042         case OFPACT_ENQUEUE:
4043         case OFPACT_SET_VLAN_VID:
4044         case OFPACT_SET_VLAN_PCP:
4045         case OFPACT_STRIP_VLAN:
4046         case OFPACT_PUSH_VLAN:
4047         case OFPACT_SET_ETH_SRC:
4048         case OFPACT_SET_ETH_DST:
4049         case OFPACT_SET_IPV4_SRC:
4050         case OFPACT_SET_IPV4_DST:
4051         case OFPACT_SET_IP_DSCP:
4052         case OFPACT_SET_IP_ECN:
4053         case OFPACT_SET_IP_TTL:
4054         case OFPACT_SET_L4_SRC_PORT:
4055         case OFPACT_SET_L4_DST_PORT:
4056         case OFPACT_SET_QUEUE:
4057         case OFPACT_POP_QUEUE:
4058         case OFPACT_PUSH_MPLS:
4059         case OFPACT_POP_MPLS:
4060         case OFPACT_SET_MPLS_LABEL:
4061         case OFPACT_SET_MPLS_TC:
4062         case OFPACT_SET_MPLS_TTL:
4063         case OFPACT_MULTIPATH:
4064         case OFPACT_BUNDLE:
4065         case OFPACT_EXIT:
4066         case OFPACT_UNROLL_XLATE:
4067         case OFPACT_FIN_TIMEOUT:
4068         case OFPACT_CLEAR_ACTIONS:
4069         case OFPACT_WRITE_ACTIONS:
4070         case OFPACT_METER:
4071         case OFPACT_SAMPLE:
4072             break;
4073
4074             /* These need not be copied for restoration. */
4075         case OFPACT_NOTE:
4076         case OFPACT_CONJUNCTION:
4077             continue;
4078         }
4079         /* Copy the action over. */
4080         ofpbuf_put(&ctx->action_set, a, OFPACT_ALIGN(a->len));
4081     }
4082 }
4083
4084 #define CHECK_MPLS_RECIRCULATION()      \
4085     if (ctx->was_mpls) {                \
4086         ctx_trigger_recirculation(ctx); \
4087         break;                          \
4088     }
4089 #define CHECK_MPLS_RECIRCULATION_IF(COND) \
4090     if (COND) {                           \
4091         CHECK_MPLS_RECIRCULATION();       \
4092     }
4093
4094 static void
4095 do_xlate_actions(const struct ofpact *ofpacts, size_t ofpacts_len,
4096                  struct xlate_ctx *ctx)
4097 {
4098     struct flow_wildcards *wc = &ctx->xout->wc;
4099     struct flow *flow = &ctx->xin->flow;
4100     const struct ofpact *a;
4101
4102     if (ovs_native_tunneling_is_on(ctx->xbridge->ofproto)) {
4103         tnl_arp_snoop(flow, wc, ctx->xbridge->name);
4104     }
4105     /* dl_type already in the mask, not set below. */
4106
4107     OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
4108         struct ofpact_controller *controller;
4109         const struct ofpact_metadata *metadata;
4110         const struct ofpact_set_field *set_field;
4111         const struct mf_field *mf;
4112
4113         if (ctx->exit) {
4114             /* Check if need to store the remaining actions for later
4115              * execution. */
4116             if (exit_recirculates(ctx)) {
4117                 recirc_unroll_actions(a, OFPACT_ALIGN(ofpacts_len -
4118                                                       ((uint8_t *)a -
4119                                                        (uint8_t *)ofpacts)),
4120                                       ctx);
4121             }
4122             break;
4123         }
4124
4125         switch (a->type) {
4126         case OFPACT_OUTPUT:
4127             xlate_output_action(ctx, ofpact_get_OUTPUT(a)->port,
4128                                 ofpact_get_OUTPUT(a)->max_len, true);
4129             break;
4130
4131         case OFPACT_GROUP:
4132             if (xlate_group_action(ctx, ofpact_get_GROUP(a)->group_id)) {
4133                 /* Group could not be found. */
4134                 return;
4135             }
4136             break;
4137
4138         case OFPACT_CONTROLLER:
4139             controller = ofpact_get_CONTROLLER(a);
4140             execute_controller_action(ctx, controller->max_len,
4141                                       controller->reason,
4142                                       controller->controller_id);
4143             break;
4144
4145         case OFPACT_ENQUEUE:
4146             memset(&wc->masks.skb_priority, 0xff,
4147                    sizeof wc->masks.skb_priority);
4148             xlate_enqueue_action(ctx, ofpact_get_ENQUEUE(a));
4149             break;
4150
4151         case OFPACT_SET_VLAN_VID:
4152             wc->masks.vlan_tci |= htons(VLAN_VID_MASK | VLAN_CFI);
4153             if (flow->vlan_tci & htons(VLAN_CFI) ||
4154                 ofpact_get_SET_VLAN_VID(a)->push_vlan_if_needed) {
4155                 flow->vlan_tci &= ~htons(VLAN_VID_MASK);
4156                 flow->vlan_tci |= (htons(ofpact_get_SET_VLAN_VID(a)->vlan_vid)
4157                                    | htons(VLAN_CFI));
4158             }
4159             break;
4160
4161         case OFPACT_SET_VLAN_PCP:
4162             wc->masks.vlan_tci |= htons(VLAN_PCP_MASK | VLAN_CFI);
4163             if (flow->vlan_tci & htons(VLAN_CFI) ||
4164                 ofpact_get_SET_VLAN_PCP(a)->push_vlan_if_needed) {
4165                 flow->vlan_tci &= ~htons(VLAN_PCP_MASK);
4166                 flow->vlan_tci |= htons((ofpact_get_SET_VLAN_PCP(a)->vlan_pcp
4167                                          << VLAN_PCP_SHIFT) | VLAN_CFI);
4168             }
4169             break;
4170
4171         case OFPACT_STRIP_VLAN:
4172             memset(&wc->masks.vlan_tci, 0xff, sizeof wc->masks.vlan_tci);
4173             flow->vlan_tci = htons(0);
4174             break;
4175
4176         case OFPACT_PUSH_VLAN:
4177             /* XXX 802.1AD(QinQ) */
4178             memset(&wc->masks.vlan_tci, 0xff, sizeof wc->masks.vlan_tci);
4179             flow->vlan_tci = htons(VLAN_CFI);
4180             break;
4181
4182         case OFPACT_SET_ETH_SRC:
4183             memset(&wc->masks.dl_src, 0xff, sizeof wc->masks.dl_src);
4184             memcpy(flow->dl_src, ofpact_get_SET_ETH_SRC(a)->mac, ETH_ADDR_LEN);
4185             break;
4186
4187         case OFPACT_SET_ETH_DST:
4188             memset(&wc->masks.dl_dst, 0xff, sizeof wc->masks.dl_dst);
4189             memcpy(flow->dl_dst, ofpact_get_SET_ETH_DST(a)->mac, ETH_ADDR_LEN);
4190             break;
4191
4192         case OFPACT_SET_IPV4_SRC:
4193             CHECK_MPLS_RECIRCULATION();
4194             if (flow->dl_type == htons(ETH_TYPE_IP)) {
4195                 memset(&wc->masks.nw_src, 0xff, sizeof wc->masks.nw_src);
4196                 flow->nw_src = ofpact_get_SET_IPV4_SRC(a)->ipv4;
4197             }
4198             break;
4199
4200         case OFPACT_SET_IPV4_DST:
4201             CHECK_MPLS_RECIRCULATION();
4202             if (flow->dl_type == htons(ETH_TYPE_IP)) {
4203                 memset(&wc->masks.nw_dst, 0xff, sizeof wc->masks.nw_dst);
4204                 flow->nw_dst = ofpact_get_SET_IPV4_DST(a)->ipv4;
4205             }
4206             break;
4207
4208         case OFPACT_SET_IP_DSCP:
4209             CHECK_MPLS_RECIRCULATION();
4210             if (is_ip_any(flow)) {
4211                 wc->masks.nw_tos |= IP_DSCP_MASK;
4212                 flow->nw_tos &= ~IP_DSCP_MASK;
4213                 flow->nw_tos |= ofpact_get_SET_IP_DSCP(a)->dscp;
4214             }
4215             break;
4216
4217         case OFPACT_SET_IP_ECN:
4218             CHECK_MPLS_RECIRCULATION();
4219             if (is_ip_any(flow)) {
4220                 wc->masks.nw_tos |= IP_ECN_MASK;
4221                 flow->nw_tos &= ~IP_ECN_MASK;
4222                 flow->nw_tos |= ofpact_get_SET_IP_ECN(a)->ecn;
4223             }
4224             break;
4225
4226         case OFPACT_SET_IP_TTL:
4227             CHECK_MPLS_RECIRCULATION();
4228             if (is_ip_any(flow)) {
4229                 wc->masks.nw_ttl = 0xff;
4230                 flow->nw_ttl = ofpact_get_SET_IP_TTL(a)->ttl;
4231             }
4232             break;
4233
4234         case OFPACT_SET_L4_SRC_PORT:
4235             CHECK_MPLS_RECIRCULATION();
4236             if (is_ip_any(flow) && !(flow->nw_frag & FLOW_NW_FRAG_LATER)) {
4237                 memset(&wc->masks.nw_proto, 0xff, sizeof wc->masks.nw_proto);
4238                 memset(&wc->masks.tp_src, 0xff, sizeof wc->masks.tp_src);
4239                 flow->tp_src = htons(ofpact_get_SET_L4_SRC_PORT(a)->port);
4240             }
4241             break;
4242
4243         case OFPACT_SET_L4_DST_PORT:
4244             CHECK_MPLS_RECIRCULATION();
4245             if (is_ip_any(flow) && !(flow->nw_frag & FLOW_NW_FRAG_LATER)) {
4246                 memset(&wc->masks.nw_proto, 0xff, sizeof wc->masks.nw_proto);
4247                 memset(&wc->masks.tp_dst, 0xff, sizeof wc->masks.tp_dst);
4248                 flow->tp_dst = htons(ofpact_get_SET_L4_DST_PORT(a)->port);
4249             }
4250             break;
4251
4252         case OFPACT_RESUBMIT:
4253             xlate_ofpact_resubmit(ctx, ofpact_get_RESUBMIT(a));
4254             break;
4255
4256         case OFPACT_SET_TUNNEL:
4257             flow->tunnel.tun_id = htonll(ofpact_get_SET_TUNNEL(a)->tun_id);
4258             break;
4259
4260         case OFPACT_SET_QUEUE:
4261             memset(&wc->masks.skb_priority, 0xff,
4262                    sizeof wc->masks.skb_priority);
4263             xlate_set_queue_action(ctx, ofpact_get_SET_QUEUE(a)->queue_id);
4264             break;
4265
4266         case OFPACT_POP_QUEUE:
4267             memset(&wc->masks.skb_priority, 0xff,
4268                    sizeof wc->masks.skb_priority);
4269             flow->skb_priority = ctx->orig_skb_priority;
4270             break;
4271
4272         case OFPACT_REG_MOVE:
4273             CHECK_MPLS_RECIRCULATION_IF(
4274                 mf_is_l3_or_higher(ofpact_get_REG_MOVE(a)->dst.field) ||
4275                 mf_is_l3_or_higher(ofpact_get_REG_MOVE(a)->src.field));
4276             nxm_execute_reg_move(ofpact_get_REG_MOVE(a), flow, wc);
4277             break;
4278
4279         case OFPACT_SET_FIELD:
4280             CHECK_MPLS_RECIRCULATION_IF(
4281                 mf_is_l3_or_higher(ofpact_get_SET_FIELD(a)->field));
4282             set_field = ofpact_get_SET_FIELD(a);
4283             mf = set_field->field;
4284
4285             /* Set field action only ever overwrites packet's outermost
4286              * applicable header fields.  Do nothing if no header exists. */
4287             if (mf->id == MFF_VLAN_VID) {
4288                 wc->masks.vlan_tci |= htons(VLAN_CFI);
4289                 if (!(flow->vlan_tci & htons(VLAN_CFI))) {
4290                     break;
4291                 }
4292             } else if ((mf->id == MFF_MPLS_LABEL || mf->id == MFF_MPLS_TC)
4293                        /* 'dl_type' is already unwildcarded. */
4294                        && !eth_type_mpls(flow->dl_type)) {
4295                 break;
4296             }
4297             /* A flow may wildcard nw_frag.  Do nothing if setting a trasport
4298              * header field on a packet that does not have them. */
4299             mf_mask_field_and_prereqs(mf, &wc->masks);
4300             if (mf_are_prereqs_ok(mf, flow)) {
4301                 mf_set_flow_value_masked(mf, &set_field->value,
4302                                          &set_field->mask, flow);
4303             }
4304             break;
4305
4306         case OFPACT_STACK_PUSH:
4307             CHECK_MPLS_RECIRCULATION_IF(
4308                 mf_is_l3_or_higher(ofpact_get_STACK_PUSH(a)->subfield.field));
4309             nxm_execute_stack_push(ofpact_get_STACK_PUSH(a), flow, wc,
4310                                    &ctx->stack);
4311             break;
4312
4313         case OFPACT_STACK_POP:
4314             CHECK_MPLS_RECIRCULATION_IF(
4315                 mf_is_l3_or_higher(ofpact_get_STACK_POP(a)->subfield.field));
4316             nxm_execute_stack_pop(ofpact_get_STACK_POP(a), flow, wc,
4317                                   &ctx->stack);
4318             break;
4319
4320         case OFPACT_PUSH_MPLS:
4321             /* Recirculate if it is an IP packet with a zero ttl.  This may
4322              * indicate that the packet was previously MPLS and an MPLS pop
4323              * action converted it to IP. In this case recirculating should
4324              * reveal the IP TTL which is used as the basis for a new MPLS
4325              * LSE. */
4326             CHECK_MPLS_RECIRCULATION_IF(
4327                 !flow_count_mpls_labels(flow, wc)
4328                 && flow->nw_ttl == 0
4329                 && is_ip_any(flow));
4330             compose_mpls_push_action(ctx, ofpact_get_PUSH_MPLS(a));
4331             break;
4332
4333         case OFPACT_POP_MPLS:
4334             CHECK_MPLS_RECIRCULATION();
4335             compose_mpls_pop_action(ctx, ofpact_get_POP_MPLS(a)->ethertype);
4336             break;
4337
4338         case OFPACT_SET_MPLS_LABEL:
4339             CHECK_MPLS_RECIRCULATION();
4340             compose_set_mpls_label_action(
4341                 ctx, ofpact_get_SET_MPLS_LABEL(a)->label);
4342             break;
4343
4344         case OFPACT_SET_MPLS_TC:
4345             CHECK_MPLS_RECIRCULATION();
4346             compose_set_mpls_tc_action(ctx, ofpact_get_SET_MPLS_TC(a)->tc);
4347             break;
4348
4349         case OFPACT_SET_MPLS_TTL:
4350             CHECK_MPLS_RECIRCULATION();
4351             compose_set_mpls_ttl_action(ctx, ofpact_get_SET_MPLS_TTL(a)->ttl);
4352             break;
4353
4354         case OFPACT_DEC_MPLS_TTL:
4355             CHECK_MPLS_RECIRCULATION();
4356             if (compose_dec_mpls_ttl_action(ctx)) {
4357                 return;
4358             }
4359             break;
4360
4361         case OFPACT_DEC_TTL:
4362             CHECK_MPLS_RECIRCULATION();
4363             wc->masks.nw_ttl = 0xff;
4364             if (compose_dec_ttl(ctx, ofpact_get_DEC_TTL(a))) {
4365                 return;
4366             }
4367             break;
4368
4369         case OFPACT_NOTE:
4370             /* Nothing to do. */
4371             break;
4372
4373         case OFPACT_MULTIPATH:
4374             CHECK_MPLS_RECIRCULATION();
4375             multipath_execute(ofpact_get_MULTIPATH(a), flow, wc);
4376             break;
4377
4378         case OFPACT_BUNDLE:
4379             CHECK_MPLS_RECIRCULATION();
4380             xlate_bundle_action(ctx, ofpact_get_BUNDLE(a));
4381             break;
4382
4383         case OFPACT_OUTPUT_REG:
4384             xlate_output_reg_action(ctx, ofpact_get_OUTPUT_REG(a));
4385             break;
4386
4387         case OFPACT_LEARN:
4388             CHECK_MPLS_RECIRCULATION();
4389             xlate_learn_action(ctx, ofpact_get_LEARN(a));
4390             break;
4391
4392         case OFPACT_CONJUNCTION: {
4393             /* A flow with a "conjunction" action represents part of a special
4394              * kind of "set membership match".  Such a flow should not actually
4395              * get executed, but it could via, say, a "packet-out", even though
4396              * that wouldn't be useful.  Log it to help debugging. */
4397             static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 1);
4398             VLOG_INFO_RL(&rl, "executing no-op conjunction action");
4399             break;
4400         }
4401
4402         case OFPACT_EXIT:
4403             ctx->exit = true;
4404             break;
4405
4406         case OFPACT_UNROLL_XLATE: {
4407             struct ofpact_unroll_xlate *unroll = ofpact_get_UNROLL_XLATE(a);
4408
4409             /* Restore translation context data that was stored earlier. */
4410             ctx->table_id = unroll->rule_table_id;
4411             ctx->rule_cookie = unroll->rule_cookie;
4412             break;
4413         }
4414         case OFPACT_FIN_TIMEOUT:
4415             CHECK_MPLS_RECIRCULATION();
4416             memset(&wc->masks.nw_proto, 0xff, sizeof wc->masks.nw_proto);
4417             ctx->xout->has_fin_timeout = true;
4418             xlate_fin_timeout(ctx, ofpact_get_FIN_TIMEOUT(a));
4419             break;
4420
4421         case OFPACT_CLEAR_ACTIONS:
4422             ofpbuf_clear(&ctx->action_set);
4423             ctx->xin->flow.actset_output = OFPP_UNSET;
4424             ctx->action_set_has_group = false;
4425             break;
4426
4427         case OFPACT_WRITE_ACTIONS:
4428             xlate_write_actions(ctx, a);
4429             break;
4430
4431         case OFPACT_WRITE_METADATA:
4432             metadata = ofpact_get_WRITE_METADATA(a);
4433             flow->metadata &= ~metadata->mask;
4434             flow->metadata |= metadata->metadata & metadata->mask;
4435             break;
4436
4437         case OFPACT_METER:
4438             /* Not implemented yet. */
4439             break;
4440
4441         case OFPACT_GOTO_TABLE: {
4442             struct ofpact_goto_table *ogt = ofpact_get_GOTO_TABLE(a);
4443
4444             /* Allow ctx->table_id == TBL_INTERNAL, which will be greater
4445              * than ogt->table_id. This is to allow goto_table actions that
4446              * triggered recirculation: ctx->table_id will be TBL_INTERNAL
4447              * after recirculation. */
4448             ovs_assert(ctx->table_id == TBL_INTERNAL
4449                        || ctx->table_id < ogt->table_id);
4450             xlate_table_action(ctx, ctx->xin->flow.in_port.ofp_port,
4451                                ogt->table_id, true, true);
4452             break;
4453         }
4454
4455         case OFPACT_SAMPLE:
4456             xlate_sample_action(ctx, ofpact_get_SAMPLE(a));
4457             break;
4458         }
4459
4460         /* Check if need to store this and the remaining actions for later
4461          * execution. */
4462         if (ctx->exit && ctx_first_recirculation_action(ctx)) {
4463             recirc_unroll_actions(a, OFPACT_ALIGN(ofpacts_len -
4464                                                   ((uint8_t *)a -
4465                                                    (uint8_t *)ofpacts)),
4466                                   ctx);
4467             break;
4468         }
4469     }
4470 }
4471
4472 void
4473 xlate_in_init(struct xlate_in *xin, struct ofproto_dpif *ofproto,
4474               const struct flow *flow, ofp_port_t in_port,
4475               struct rule_dpif *rule, uint16_t tcp_flags,
4476               const struct dp_packet *packet)
4477 {
4478     xin->ofproto = ofproto;
4479     xin->flow = *flow;
4480     xin->flow.in_port.ofp_port = in_port;
4481     xin->flow.actset_output = OFPP_UNSET;
4482     xin->packet = packet;
4483     xin->may_learn = packet != NULL;
4484     xin->rule = rule;
4485     xin->xcache = NULL;
4486     xin->ofpacts = NULL;
4487     xin->ofpacts_len = 0;
4488     xin->tcp_flags = tcp_flags;
4489     xin->resubmit_hook = NULL;
4490     xin->report_hook = NULL;
4491     xin->resubmit_stats = NULL;
4492     xin->skip_wildcards = false;
4493     xin->odp_actions = NULL;
4494
4495     /* Do recirc lookup. */
4496     xin->recirc = flow->recirc_id
4497         ? recirc_id_node_find(flow->recirc_id)
4498         : NULL;
4499 }
4500
4501 void
4502 xlate_out_uninit(struct xlate_out *xout)
4503 {
4504     if (xout) {
4505         if (xout->odp_actions == &xout->odp_actions_buf) {
4506             ofpbuf_uninit(xout->odp_actions);
4507         }
4508         xlate_out_free_recircs(xout);
4509     }
4510 }
4511
4512 /* Translates the 'ofpacts_len' bytes of "struct ofpact"s starting at 'ofpacts'
4513  * into datapath actions, using 'ctx', and discards the datapath actions. */
4514 void
4515 xlate_actions_for_side_effects(struct xlate_in *xin)
4516 {
4517     struct xlate_out xout;
4518
4519     xlate_actions(xin, &xout);
4520     xlate_out_uninit(&xout);
4521 }
4522
4523 void
4524 xlate_out_copy(struct xlate_out *dst, const struct xlate_out *src)
4525 {
4526     dst->wc = src->wc;
4527     dst->slow = src->slow;
4528     dst->has_learn = src->has_learn;
4529     dst->has_normal = src->has_normal;
4530     dst->has_fin_timeout = src->has_fin_timeout;
4531     dst->nf_output_iface = src->nf_output_iface;
4532     dst->mirrors = src->mirrors;
4533
4534     dst->odp_actions = &dst->odp_actions_buf;
4535     ofpbuf_use_stub(dst->odp_actions, dst->odp_actions_stub,
4536                     sizeof dst->odp_actions_stub);
4537     ofpbuf_put(dst->odp_actions, src->odp_actions->data, src->odp_actions->size);
4538 }
4539 \f
4540 static struct skb_priority_to_dscp *
4541 get_skb_priority(const struct xport *xport, uint32_t skb_priority)
4542 {
4543     struct skb_priority_to_dscp *pdscp;
4544     uint32_t hash;
4545
4546     hash = hash_int(skb_priority, 0);
4547     HMAP_FOR_EACH_IN_BUCKET (pdscp, hmap_node, hash, &xport->skb_priorities) {
4548         if (pdscp->skb_priority == skb_priority) {
4549             return pdscp;
4550         }
4551     }
4552     return NULL;
4553 }
4554
4555 static bool
4556 dscp_from_skb_priority(const struct xport *xport, uint32_t skb_priority,
4557                        uint8_t *dscp)
4558 {
4559     struct skb_priority_to_dscp *pdscp = get_skb_priority(xport, skb_priority);
4560     *dscp = pdscp ? pdscp->dscp : 0;
4561     return pdscp != NULL;
4562 }
4563
4564 static size_t
4565 count_skb_priorities(const struct xport *xport)
4566 {
4567     return hmap_count(&xport->skb_priorities);
4568 }
4569
4570 static void
4571 clear_skb_priorities(struct xport *xport)
4572 {
4573     struct skb_priority_to_dscp *pdscp, *next;
4574
4575     HMAP_FOR_EACH_SAFE (pdscp, next, hmap_node, &xport->skb_priorities) {
4576         hmap_remove(&xport->skb_priorities, &pdscp->hmap_node);
4577         free(pdscp);
4578     }
4579 }
4580
4581 static bool
4582 actions_output_to_local_port(const struct xlate_ctx *ctx)
4583 {
4584     odp_port_t local_odp_port = ofp_port_to_odp_port(ctx->xbridge, OFPP_LOCAL);
4585     const struct nlattr *a;
4586     unsigned int left;
4587
4588     NL_ATTR_FOR_EACH_UNSAFE (a, left, ctx->xout->odp_actions->data,
4589                              ctx->xout->odp_actions->size) {
4590         if (nl_attr_type(a) == OVS_ACTION_ATTR_OUTPUT
4591             && nl_attr_get_odp_port(a) == local_odp_port) {
4592             return true;
4593         }
4594     }
4595     return false;
4596 }
4597
4598 #if defined(__linux__)
4599 /* Returns the maximum number of packets that the Linux kernel is willing to
4600  * queue up internally to certain kinds of software-implemented ports, or the
4601  * default (and rarely modified) value if it cannot be determined. */
4602 static int
4603 netdev_max_backlog(void)
4604 {
4605     static struct ovsthread_once once = OVSTHREAD_ONCE_INITIALIZER;
4606     static int max_backlog = 1000; /* The normal default value. */
4607
4608     if (ovsthread_once_start(&once)) {
4609         static const char filename[] = "/proc/sys/net/core/netdev_max_backlog";
4610         FILE *stream;
4611         int n;
4612
4613         stream = fopen(filename, "r");
4614         if (!stream) {
4615             VLOG_WARN("%s: open failed (%s)", filename, ovs_strerror(errno));
4616         } else {
4617             if (fscanf(stream, "%d", &n) != 1) {
4618                 VLOG_WARN("%s: read error", filename);
4619             } else if (n <= 100) {
4620                 VLOG_WARN("%s: unexpectedly small value %d", filename, n);
4621             } else {
4622                 max_backlog = n;
4623             }
4624             fclose(stream);
4625         }
4626         ovsthread_once_done(&once);
4627
4628         VLOG_DBG("%s: using %d max_backlog", filename, max_backlog);
4629     }
4630
4631     return max_backlog;
4632 }
4633
4634 /* Counts and returns the number of OVS_ACTION_ATTR_OUTPUT actions in
4635  * 'odp_actions'. */
4636 static int
4637 count_output_actions(const struct ofpbuf *odp_actions)
4638 {
4639     const struct nlattr *a;
4640     size_t left;
4641     int n = 0;
4642
4643     NL_ATTR_FOR_EACH_UNSAFE (a, left, odp_actions->data, odp_actions->size) {
4644         if (a->nla_type == OVS_ACTION_ATTR_OUTPUT) {
4645             n++;
4646         }
4647     }
4648     return n;
4649 }
4650 #endif /* defined(__linux__) */
4651
4652 /* Returns true if 'odp_actions' contains more output actions than the datapath
4653  * can reliably handle in one go.  On Linux, this is the value of the
4654  * net.core.netdev_max_backlog sysctl, which limits the maximum number of
4655  * packets that the kernel is willing to queue up for processing while the
4656  * datapath is processing a set of actions. */
4657 static bool
4658 too_many_output_actions(const struct ofpbuf *odp_actions OVS_UNUSED)
4659 {
4660 #ifdef __linux__
4661     return (odp_actions->size / NL_A_U32_SIZE > netdev_max_backlog()
4662             && count_output_actions(odp_actions) > netdev_max_backlog());
4663 #else
4664     /* OSes other than Linux might have similar limits, but we don't know how
4665      * to determine them.*/
4666     return false;
4667 #endif
4668 }
4669
4670 /* Translates the flow, actions, or rule in 'xin' into datapath actions in
4671  * 'xout'.
4672  * The caller must take responsibility for eventually freeing 'xout', with
4673  * xlate_out_uninit(). */
4674 void
4675 xlate_actions(struct xlate_in *xin, struct xlate_out *xout)
4676 {
4677     struct xlate_cfg *xcfg = ovsrcu_get(struct xlate_cfg *, &xcfgp);
4678     struct flow_wildcards *wc = NULL;
4679     struct flow *flow = &xin->flow;
4680     struct rule_dpif *rule = NULL;
4681
4682     enum slow_path_reason special;
4683     const struct ofpact *ofpacts;
4684     struct xbridge *xbridge;
4685     struct xport *in_port;
4686     struct flow orig_flow;
4687     struct xlate_ctx ctx;
4688     size_t ofpacts_len;
4689     bool tnl_may_send;
4690     bool is_icmp;
4691
4692     COVERAGE_INC(xlate_actions);
4693
4694     /* Flow initialization rules:
4695      * - 'base_flow' must match the kernel's view of the packet at the
4696      *   time that action processing starts.  'flow' represents any
4697      *   transformations we wish to make through actions.
4698      * - By default 'base_flow' and 'flow' are the same since the input
4699      *   packet matches the output before any actions are applied.
4700      * - When using VLAN splinters, 'base_flow''s VLAN is set to the value
4701      *   of the received packet as seen by the kernel.  If we later output
4702      *   to another device without any modifications this will cause us to
4703      *   insert a new tag since the original one was stripped off by the
4704      *   VLAN device.
4705      * - Tunnel metadata as received is retained in 'flow'. This allows
4706      *   tunnel metadata matching also in later tables.
4707      *   Since a kernel action for setting the tunnel metadata will only be
4708      *   generated with actual tunnel output, changing the tunnel metadata
4709      *   values in 'flow' (such as tun_id) will only have effect with a later
4710      *   tunnel output action.
4711      * - Tunnel 'base_flow' is completely cleared since that is what the
4712      *   kernel does.  If we wish to maintain the original values an action
4713      *   needs to be generated. */
4714
4715     ctx.xin = xin;
4716     ctx.xout = xout;
4717     ctx.xout->slow = 0;
4718     ctx.xout->has_learn = false;
4719     ctx.xout->has_normal = false;
4720     ctx.xout->has_fin_timeout = false;
4721     ctx.xout->nf_output_iface = NF_OUT_DROP;
4722     ctx.xout->mirrors = 0;
4723     ctx.xout->n_recircs = 0;
4724
4725     xout->odp_actions = xin->odp_actions;
4726     if (!xout->odp_actions) {
4727         xout->odp_actions = &xout->odp_actions_buf;
4728         ofpbuf_use_stub(xout->odp_actions, xout->odp_actions_stub,
4729                         sizeof xout->odp_actions_stub);
4730     }
4731     ofpbuf_reserve(xout->odp_actions, NL_A_U32_SIZE);
4732
4733     xbridge = xbridge_lookup(xcfg, xin->ofproto);
4734     if (!xbridge) {
4735         return;
4736     }
4737     /* 'ctx.xbridge' may be changed by action processing, whereas 'xbridge'
4738      * will remain set on the original input bridge. */
4739     ctx.xbridge = xbridge;
4740     ctx.rule = xin->rule;
4741
4742     ctx.base_flow = *flow;
4743     memset(&ctx.base_flow.tunnel, 0, sizeof ctx.base_flow.tunnel);
4744     ctx.orig_tunnel_ip_dst = flow->tunnel.ip_dst;
4745
4746     if (!xin->skip_wildcards) {
4747         wc = &xout->wc;
4748         flow_wildcards_init_catchall(wc);
4749         memset(&wc->masks.in_port, 0xff, sizeof wc->masks.in_port);
4750         memset(&wc->masks.dl_type, 0xff, sizeof wc->masks.dl_type);
4751         if (is_ip_any(flow)) {
4752             wc->masks.nw_frag |= FLOW_NW_FRAG_MASK;
4753         }
4754         if (xbridge->support.recirc) {
4755             /* Always exactly match recirc_id when datapath supports
4756              * recirculation.  */
4757             wc->masks.recirc_id = UINT32_MAX;
4758         }
4759         if (xbridge->netflow) {
4760             netflow_mask_wc(flow, wc);
4761         }
4762     }
4763     is_icmp = is_icmpv4(flow) || is_icmpv6(flow);
4764
4765     tnl_may_send = tnl_xlate_init(&ctx.base_flow, flow, wc);
4766
4767     ctx.recurse = 0;
4768     ctx.resubmits = 0;
4769     ctx.in_group = false;
4770     ctx.in_action_set = false;
4771     ctx.orig_skb_priority = flow->skb_priority;
4772     ctx.table_id = 0;
4773     ctx.rule_cookie = OVS_BE64_MAX;
4774     ctx.exit = false;
4775     ctx.was_mpls = false;
4776     ctx.recirc_action_offset = -1;
4777     ctx.last_unroll_offset = -1;
4778
4779     ctx.action_set_has_group = false;
4780     ofpbuf_use_stub(&ctx.action_set,
4781                     ctx.action_set_stub, sizeof ctx.action_set_stub);
4782
4783     ofpbuf_use_stub(&ctx.stack, ctx.init_stack, sizeof ctx.init_stack);
4784
4785     /* The in_port of the original packet before recirculation. */
4786     in_port = get_ofp_port(xbridge, flow->in_port.ofp_port);
4787
4788     if (xin->recirc) {
4789         const struct recirc_id_node *recirc = xin->recirc;
4790
4791         if (xin->ofpacts_len > 0 || ctx.rule) {
4792             static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 1);
4793
4794             VLOG_WARN_RL(&rl, "Recirculation conflict (%s)!",
4795                          xin->ofpacts_len > 0
4796                          ? "actions"
4797                          : "rule");
4798             return;
4799         }
4800
4801         /* Set the bridge for post-recirculation processing if needed. */
4802         if (ctx.xbridge->ofproto != recirc->ofproto) {
4803             struct xlate_cfg *xcfg = ovsrcu_get(struct xlate_cfg *, &xcfgp);
4804             const struct xbridge *new_bridge = xbridge_lookup(xcfg,
4805                                                               recirc->ofproto);
4806
4807             if (OVS_UNLIKELY(!new_bridge)) {
4808                 /* Drop the packet if the bridge cannot be found. */
4809                 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 1);
4810                 VLOG_WARN_RL(&rl, "Recirculation bridge no longer exists.");
4811                 return;
4812             }
4813             ctx.xbridge = new_bridge;
4814         }
4815
4816         /* Set the post-recirculation table id.  Note: A table lookup is done
4817          * only if there are no post-recirculation actions. */
4818         ctx.table_id = recirc->table_id;
4819
4820         /* Restore pipeline metadata. May change flow's in_port and other
4821          * metadata to the values that existed when recirculation was
4822          * triggered. */
4823         recirc_metadata_to_flow(&recirc->metadata, flow);
4824
4825         /* Restore stack, if any. */
4826         if (recirc->stack) {
4827             ofpbuf_put(&ctx.stack, recirc->stack->data, recirc->stack->size);
4828         }
4829
4830         /* Restore action set, if any. */
4831         if (recirc->action_set_len) {
4832             const struct ofpact *a;
4833
4834             ofpbuf_put(&ctx.action_set, recirc->ofpacts,
4835                        recirc->action_set_len);
4836
4837             OFPACT_FOR_EACH(a, recirc->ofpacts, recirc->action_set_len) {
4838                 if (a->type == OFPACT_GROUP) {
4839                     ctx.action_set_has_group = true;
4840                     break;
4841                 }
4842             }
4843         }
4844
4845         /* Restore recirculation actions.  If there are no actions, processing
4846          * will start with a lookup in the table set above. */
4847         if (recirc->ofpacts_len > recirc->action_set_len) {
4848             xin->ofpacts_len = recirc->ofpacts_len - recirc->action_set_len;
4849             xin->ofpacts = recirc->ofpacts +
4850                 recirc->action_set_len / sizeof *recirc->ofpacts;
4851         }
4852     } else if (OVS_UNLIKELY(flow->recirc_id)) {
4853         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 1);
4854
4855         VLOG_WARN_RL(&rl, "Recirculation context not found for ID %"PRIx32,
4856                      flow->recirc_id);
4857         return;
4858     }
4859     /* The bridge is now known so obtain its table version. */
4860     ctx.tables_version = ofproto_dpif_get_tables_version(ctx.xbridge->ofproto);
4861
4862     if (!xin->ofpacts && !ctx.rule) {
4863         rule = rule_dpif_lookup_from_table(ctx.xbridge->ofproto,
4864                                            ctx.tables_version, flow, wc,
4865                                            ctx.xin->xcache != NULL,
4866                                            ctx.xin->resubmit_stats,
4867                                            &ctx.table_id,
4868                                            flow->in_port.ofp_port, true, true);
4869         if (ctx.xin->resubmit_stats) {
4870             rule_dpif_credit_stats(rule, ctx.xin->resubmit_stats);
4871         }
4872         if (ctx.xin->xcache) {
4873             struct xc_entry *entry;
4874
4875             entry = xlate_cache_add_entry(ctx.xin->xcache, XC_RULE);
4876             entry->u.rule = rule;
4877         }
4878         ctx.rule = rule;
4879
4880         if (OVS_UNLIKELY(ctx.xin->resubmit_hook)) {
4881             ctx.xin->resubmit_hook(ctx.xin, rule, 0);
4882         }
4883     }
4884     xout->fail_open = ctx.rule && rule_dpif_is_fail_open(ctx.rule);
4885
4886     if (xin->ofpacts) {
4887         ofpacts = xin->ofpacts;
4888         ofpacts_len = xin->ofpacts_len;
4889     } else if (ctx.rule) {
4890         const struct rule_actions *actions = rule_dpif_get_actions(ctx.rule);
4891
4892         ofpacts = actions->ofpacts;
4893         ofpacts_len = actions->ofpacts_len;
4894
4895         ctx.rule_cookie = rule_dpif_get_flow_cookie(ctx.rule);
4896     } else {
4897         OVS_NOT_REACHED();
4898     }
4899
4900     if (mbridge_has_mirrors(xbridge->mbridge)) {
4901         /* Do this conditionally because the copy is expensive enough that it
4902          * shows up in profiles. */
4903         orig_flow = *flow;
4904     }
4905
4906     /* Tunnel stats only for non-recirculated packets. */
4907     if (!xin->recirc && in_port && in_port->is_tunnel) {
4908         if (ctx.xin->resubmit_stats) {
4909             netdev_vport_inc_rx(in_port->netdev, ctx.xin->resubmit_stats);
4910             if (in_port->bfd) {
4911                 bfd_account_rx(in_port->bfd, ctx.xin->resubmit_stats);
4912             }
4913         }
4914         if (ctx.xin->xcache) {
4915             struct xc_entry *entry;
4916
4917             entry = xlate_cache_add_entry(ctx.xin->xcache, XC_NETDEV);
4918             entry->u.dev.rx = netdev_ref(in_port->netdev);
4919             entry->u.dev.bfd = bfd_ref(in_port->bfd);
4920         }
4921     }
4922
4923     /* Do not perform special processing on recirculated packets,
4924      * as recirculated packets are not really received by the bridge. */
4925     if (!xin->recirc &&
4926         (special = process_special(&ctx, flow, in_port, ctx.xin->packet))) {
4927         ctx.xout->slow |= special;
4928     } else {
4929         size_t sample_actions_len;
4930
4931         if (flow->in_port.ofp_port
4932             != vsp_realdev_to_vlandev(xbridge->ofproto,
4933                                       flow->in_port.ofp_port,
4934                                       flow->vlan_tci)) {
4935             ctx.base_flow.vlan_tci = 0;
4936         }
4937
4938         /* Sampling is done only for packets really received by the bridge. */
4939         if (!xin->recirc) {
4940             add_sflow_action(&ctx);
4941             add_ipfix_action(&ctx);
4942             sample_actions_len = ctx.xout->odp_actions->size;
4943         } else {
4944             sample_actions_len = 0;
4945         }
4946
4947         if (tnl_may_send && (!in_port || may_receive(in_port, &ctx))) {
4948             do_xlate_actions(ofpacts, ofpacts_len, &ctx);
4949
4950             /* We've let OFPP_NORMAL and the learning action look at the
4951              * packet, so drop it now if forwarding is disabled. */
4952             if (in_port && (!xport_stp_forward_state(in_port) ||
4953                             !xport_rstp_forward_state(in_port))) {
4954                 /* Drop all actions added by do_xlate_actions() above. */
4955                 ctx.xout->odp_actions->size = sample_actions_len;
4956
4957                 /* Undo changes that may have been done for recirculation. */
4958                 if (exit_recirculates(&ctx)) {
4959                     ctx.action_set.size = ctx.recirc_action_offset;
4960                     ctx.recirc_action_offset = -1;
4961                     ctx.last_unroll_offset = -1;
4962                 }
4963             } else if (ctx.action_set.size) {
4964                 /* Translate action set only if not dropping the packet and
4965                  * not recirculating. */
4966                 if (!exit_recirculates(&ctx)) {
4967                     xlate_action_set(&ctx);
4968                 }
4969             }
4970             /* Check if need to recirculate. */
4971             if (exit_recirculates(&ctx)) {
4972                 compose_recirculate_action(&ctx);
4973             }
4974         }
4975
4976         /* Output only fully processed packets. */
4977         if (!exit_recirculates(&ctx)
4978             && xbridge->has_in_band
4979             && in_band_must_output_to_local_port(flow)
4980             && !actions_output_to_local_port(&ctx)) {
4981             compose_output_action(&ctx, OFPP_LOCAL, NULL);
4982         }
4983
4984         if (!xin->recirc) {
4985             fix_sflow_action(&ctx);
4986         }
4987         /* Only mirror fully processed packets. */
4988         if (!exit_recirculates(&ctx)
4989             && mbridge_has_mirrors(xbridge->mbridge)) {
4990             add_mirror_actions(&ctx, &orig_flow);
4991         }
4992     }
4993
4994     if (nl_attr_oversized(ctx.xout->odp_actions->size)) {
4995         /* These datapath actions are too big for a Netlink attribute, so we
4996          * can't hand them to the kernel directly.  dpif_execute() can execute
4997          * them one by one with help, so just mark the result as SLOW_ACTION to
4998          * prevent the flow from being installed. */
4999         COVERAGE_INC(xlate_actions_oversize);
5000         ctx.xout->slow |= SLOW_ACTION;
5001     } else if (too_many_output_actions(ctx.xout->odp_actions)) {
5002         COVERAGE_INC(xlate_actions_too_many_output);
5003         ctx.xout->slow |= SLOW_ACTION;
5004     }
5005
5006     /* Update mirror stats only for packets really received by the bridge. */
5007     if (!xin->recirc && mbridge_has_mirrors(xbridge->mbridge)) {
5008         if (ctx.xin->resubmit_stats) {
5009             mirror_update_stats(xbridge->mbridge, xout->mirrors,
5010                                 ctx.xin->resubmit_stats->n_packets,
5011                                 ctx.xin->resubmit_stats->n_bytes);
5012         }
5013         if (ctx.xin->xcache) {
5014             struct xc_entry *entry;
5015
5016             entry = xlate_cache_add_entry(ctx.xin->xcache, XC_MIRROR);
5017             entry->u.mirror.mbridge = mbridge_ref(xbridge->mbridge);
5018             entry->u.mirror.mirrors = xout->mirrors;
5019         }
5020     }
5021
5022     /* Do netflow only for packets really received by the bridge. */
5023     if (!xin->recirc && xbridge->netflow) {
5024         /* Only update netflow if we don't have controller flow.  We don't
5025          * report NetFlow expiration messages for such facets because they
5026          * are just part of the control logic for the network, not real
5027          * traffic. */
5028         if (ofpacts_len == 0
5029             || ofpacts->type != OFPACT_CONTROLLER
5030             || ofpact_next(ofpacts) < ofpact_end(ofpacts, ofpacts_len)) {
5031             if (ctx.xin->resubmit_stats) {
5032                 netflow_flow_update(xbridge->netflow, flow,
5033                                     xout->nf_output_iface,
5034                                     ctx.xin->resubmit_stats);
5035             }
5036             if (ctx.xin->xcache) {
5037                 struct xc_entry *entry;
5038
5039                 entry = xlate_cache_add_entry(ctx.xin->xcache, XC_NETFLOW);
5040                 entry->u.nf.netflow = netflow_ref(xbridge->netflow);
5041                 entry->u.nf.flow = xmemdup(flow, sizeof *flow);
5042                 entry->u.nf.iface = xout->nf_output_iface;
5043             }
5044         }
5045     }
5046
5047     ofpbuf_uninit(&ctx.stack);
5048     ofpbuf_uninit(&ctx.action_set);
5049
5050     if (wc) {
5051         /* Clear the metadata and register wildcard masks, because we won't
5052          * use non-header fields as part of the cache. */
5053         flow_wildcards_clear_non_packet_fields(wc);
5054
5055         /* ICMPv4 and ICMPv6 have 8-bit "type" and "code" fields.  struct flow
5056          * uses the low 8 bits of the 16-bit tp_src and tp_dst members to
5057          * represent these fields.  The datapath interface, on the other hand,
5058          * represents them with just 8 bits each.  This means that if the high
5059          * 8 bits of the masks for these fields somehow become set, then they
5060          * will get chopped off by a round trip through the datapath, and
5061          * revalidation will spot that as an inconsistency and delete the flow.
5062          * Avoid the problem here by making sure that only the low 8 bits of
5063          * either field can be unwildcarded for ICMP.
5064          */
5065         if (is_icmp) {
5066             wc->masks.tp_src &= htons(UINT8_MAX);
5067             wc->masks.tp_dst &= htons(UINT8_MAX);
5068         }
5069         /* VLAN_TCI CFI bit must be matched if any of the TCI is matched. */
5070         if (wc->masks.vlan_tci) {
5071             wc->masks.vlan_tci |= htons(VLAN_CFI);
5072         }
5073     }
5074 }
5075
5076 /* Sends 'packet' out 'ofport'.
5077  * May modify 'packet'.
5078  * Returns 0 if successful, otherwise a positive errno value. */
5079 int
5080 xlate_send_packet(const struct ofport_dpif *ofport, struct dp_packet *packet)
5081 {
5082     struct xlate_cfg *xcfg = ovsrcu_get(struct xlate_cfg *, &xcfgp);
5083     struct xport *xport;
5084     struct ofpact_output output;
5085     struct flow flow;
5086
5087     ofpact_init(&output.ofpact, OFPACT_OUTPUT, sizeof output);
5088     /* Use OFPP_NONE as the in_port to avoid special packet processing. */
5089     flow_extract(packet, &flow);
5090     flow.in_port.ofp_port = OFPP_NONE;
5091
5092     xport = xport_lookup(xcfg, ofport);
5093     if (!xport) {
5094         return EINVAL;
5095     }
5096     output.port = xport->ofp_port;
5097     output.max_len = 0;
5098
5099     return ofproto_dpif_execute_actions(xport->xbridge->ofproto, &flow, NULL,
5100                                         &output.ofpact, sizeof output,
5101                                         packet);
5102 }
5103
5104 struct xlate_cache *
5105 xlate_cache_new(void)
5106 {
5107     struct xlate_cache *xcache = xmalloc(sizeof *xcache);
5108
5109     ofpbuf_init(&xcache->entries, 512);
5110     return xcache;
5111 }
5112
5113 static struct xc_entry *
5114 xlate_cache_add_entry(struct xlate_cache *xcache, enum xc_type type)
5115 {
5116     struct xc_entry *entry;
5117
5118     entry = ofpbuf_put_zeros(&xcache->entries, sizeof *entry);
5119     entry->type = type;
5120
5121     return entry;
5122 }
5123
5124 static void
5125 xlate_cache_netdev(struct xc_entry *entry, const struct dpif_flow_stats *stats)
5126 {
5127     if (entry->u.dev.tx) {
5128         netdev_vport_inc_tx(entry->u.dev.tx, stats);
5129     }
5130     if (entry->u.dev.rx) {
5131         netdev_vport_inc_rx(entry->u.dev.rx, stats);
5132     }
5133     if (entry->u.dev.bfd) {
5134         bfd_account_rx(entry->u.dev.bfd, stats);
5135     }
5136 }
5137
5138 static void
5139 xlate_cache_normal(struct ofproto_dpif *ofproto, struct flow *flow, int vlan)
5140 {
5141     struct xlate_cfg *xcfg = ovsrcu_get(struct xlate_cfg *, &xcfgp);
5142     struct xbridge *xbridge;
5143     struct xbundle *xbundle;
5144     struct flow_wildcards wc;
5145
5146     xbridge = xbridge_lookup(xcfg, ofproto);
5147     if (!xbridge) {
5148         return;
5149     }
5150
5151     xbundle = lookup_input_bundle(xbridge, flow->in_port.ofp_port, false,
5152                                   NULL);
5153     if (!xbundle) {
5154         return;
5155     }
5156
5157     update_learning_table(xbridge, flow, &wc, vlan, xbundle);
5158 }
5159
5160 /* Push stats and perform side effects of flow translation. */
5161 void
5162 xlate_push_stats(struct xlate_cache *xcache,
5163                  const struct dpif_flow_stats *stats)
5164 {
5165     struct xc_entry *entry;
5166     struct ofpbuf entries = xcache->entries;
5167     uint8_t dmac[ETH_ADDR_LEN];
5168
5169     if (!stats->n_packets) {
5170         return;
5171     }
5172
5173     XC_ENTRY_FOR_EACH (entry, entries, xcache) {
5174         switch (entry->type) {
5175         case XC_RULE:
5176             rule_dpif_credit_stats(entry->u.rule, stats);
5177             break;
5178         case XC_BOND:
5179             bond_account(entry->u.bond.bond, entry->u.bond.flow,
5180                          entry->u.bond.vid, stats->n_bytes);
5181             break;
5182         case XC_NETDEV:
5183             xlate_cache_netdev(entry, stats);
5184             break;
5185         case XC_NETFLOW:
5186             netflow_flow_update(entry->u.nf.netflow, entry->u.nf.flow,
5187                                 entry->u.nf.iface, stats);
5188             break;
5189         case XC_MIRROR:
5190             mirror_update_stats(entry->u.mirror.mbridge,
5191                                 entry->u.mirror.mirrors,
5192                                 stats->n_packets, stats->n_bytes);
5193             break;
5194         case XC_LEARN:
5195             ofproto_dpif_flow_mod(entry->u.learn.ofproto, entry->u.learn.fm);
5196             break;
5197         case XC_NORMAL:
5198             xlate_cache_normal(entry->u.normal.ofproto, entry->u.normal.flow,
5199                                entry->u.normal.vlan);
5200             break;
5201         case XC_FIN_TIMEOUT:
5202             xlate_fin_timeout__(entry->u.fin.rule, stats->tcp_flags,
5203                                 entry->u.fin.idle, entry->u.fin.hard);
5204             break;
5205         case XC_GROUP:
5206             group_dpif_credit_stats(entry->u.group.group, entry->u.group.bucket,
5207                                     stats);
5208             break;
5209         case XC_TNL_ARP:
5210             /* Lookup arp to avoid arp timeout. */
5211             tnl_arp_lookup(entry->u.tnl_arp_cache.br_name, entry->u.tnl_arp_cache.d_ip, dmac);
5212             break;
5213         default:
5214             OVS_NOT_REACHED();
5215         }
5216     }
5217 }
5218
5219 static void
5220 xlate_dev_unref(struct xc_entry *entry)
5221 {
5222     if (entry->u.dev.tx) {
5223         netdev_close(entry->u.dev.tx);
5224     }
5225     if (entry->u.dev.rx) {
5226         netdev_close(entry->u.dev.rx);
5227     }
5228     if (entry->u.dev.bfd) {
5229         bfd_unref(entry->u.dev.bfd);
5230     }
5231 }
5232
5233 static void
5234 xlate_cache_clear_netflow(struct netflow *netflow, struct flow *flow)
5235 {
5236     netflow_flow_clear(netflow, flow);
5237     netflow_unref(netflow);
5238     free(flow);
5239 }
5240
5241 void
5242 xlate_cache_clear(struct xlate_cache *xcache)
5243 {
5244     struct xc_entry *entry;
5245     struct ofpbuf entries;
5246
5247     if (!xcache) {
5248         return;
5249     }
5250
5251     XC_ENTRY_FOR_EACH (entry, entries, xcache) {
5252         switch (entry->type) {
5253         case XC_RULE:
5254             rule_dpif_unref(entry->u.rule);
5255             break;
5256         case XC_BOND:
5257             free(entry->u.bond.flow);
5258             bond_unref(entry->u.bond.bond);
5259             break;
5260         case XC_NETDEV:
5261             xlate_dev_unref(entry);
5262             break;
5263         case XC_NETFLOW:
5264             xlate_cache_clear_netflow(entry->u.nf.netflow, entry->u.nf.flow);
5265             break;
5266         case XC_MIRROR:
5267             mbridge_unref(entry->u.mirror.mbridge);
5268             break;
5269         case XC_LEARN:
5270             free(entry->u.learn.fm);
5271             ofpbuf_delete(entry->u.learn.ofpacts);
5272             break;
5273         case XC_NORMAL:
5274             free(entry->u.normal.flow);
5275             break;
5276         case XC_FIN_TIMEOUT:
5277             /* 'u.fin.rule' is always already held as a XC_RULE, which
5278              * has already released it's reference above. */
5279             break;
5280         case XC_GROUP:
5281             group_dpif_unref(entry->u.group.group);
5282             break;
5283         case XC_TNL_ARP:
5284             break;
5285         default:
5286             OVS_NOT_REACHED();
5287         }
5288     }
5289
5290     ofpbuf_clear(&xcache->entries);
5291 }
5292
5293 void
5294 xlate_cache_delete(struct xlate_cache *xcache)
5295 {
5296     xlate_cache_clear(xcache);
5297     ofpbuf_uninit(&xcache->entries);
5298     free(xcache);
5299 }