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