ofproto/ofproto-dpif-xlate.c

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