ofproto/ofproto-dpif-xlate.c

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