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