ofproto/ofproto-dpif-xlate.c

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