ofproto/ofproto-dpif-xlate.c

   1 /* Copyright (c) 2009, 2010, 2011, 2012, 2013 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 "bfd.h"
  20 #include "bitmap.h"
  21 #include "bond.h"
  22 #include "bundle.h"
  23 #include "byte-order.h"
  24 #include "cfm.h"
  25 #include "connmgr.h"
  26 #include "coverage.h"
  27 #include "dpif.h"
  28 #include "dynamic-string.h"
  29 #include "in-band.h"
  30 #include "lacp.h"
  31 #include "learn.h"
  32 #include "list.h"
  33 #include "mac-learning.h"
  34 #include "meta-flow.h"
  35 #include "multipath.h"
  36 #include "netdev-vport.h"
  37 #include "netlink.h"
  38 #include "nx-match.h"
  39 #include "odp-execute.h"
  40 #include "ofp-actions.h"
  41 #include "ofproto/ofproto-dpif-ipfix.h"
  42 #include "ofproto/ofproto-dpif-mirror.h"
  43 #include "ofproto/ofproto-dpif-sflow.h"
  44 #include "ofproto/ofproto-dpif.h"
  45 #include "tunnel.h"
  46 #include "vlog.h"
  47
  48 COVERAGE_DEFINE(xlate_actions);
  49
  50 VLOG_DEFINE_THIS_MODULE(ofproto_dpif_xlate);
  51
  52 /* Maximum depth of flow table recursion (due to resubmit actions) in a
  53  * flow translation. */
  54 #define MAX_RESUBMIT_RECURSION 64
  55
  56 struct xbridge {
  57     struct hmap_node hmap_node;   /* Node in global 'xbridges' map. */
  58     struct ofproto_dpif *ofproto; /* Key in global 'xbridges' map. */
  59
  60     struct list xbundles;         /* Owned xbundles. */
  61     struct hmap xports;           /* Indexed by ofp_port. */
  62
  63     char *name;                   /* Name used in log messages. */
  64     struct mac_learning *ml;      /* Mac learning handle. */
  65     struct mbridge *mbridge;      /* Mirroring. */
  66     struct dpif_sflow *sflow;     /* SFlow handle, or null. */
  67     struct dpif_ipfix *ipfix;     /* Ipfix handle, or null. */
  68
  69     enum ofp_config_flags frag;   /* Fragmentation handling. */
  70     bool has_stp;                 /* Bridge runs stp? */
  71     bool has_netflow;             /* Bridge runs netflow? */
  72     bool has_in_band;             /* Bridge has in band control? */
  73     bool forward_bpdu;            /* Bridge forwards STP BPDUs? */
  74 };
  75
  76 struct xbundle {
  77     struct hmap_node hmap_node;    /* In global 'xbundles' map. */
  78     struct ofbundle *ofbundle;     /* Key in global 'xbundles' map. */
  79
  80     struct list list_node;         /* In parent 'xbridges' list. */
  81     struct xbridge *xbridge;       /* Parent xbridge. */
  82
  83     struct list xports;            /* Contains "struct xport"s. */
  84
  85     char *name;                    /* Name used in log messages. */
  86     struct bond *bond;             /* Nonnull iff more than one port. */
  87     struct lacp *lacp;             /* LACP handle or null. */
  88
  89     enum port_vlan_mode vlan_mode; /* VLAN mode. */
  90     int vlan;                      /* -1=trunk port, else a 12-bit VLAN ID. */
  91     unsigned long *trunks;         /* Bitmap of trunked VLANs, if 'vlan' == -1.
  92                                     * NULL if all VLANs are trunked. */
  93     bool use_priority_tags;        /* Use 802.1p tag for frames in VLAN 0? */
  94     bool floodable;                /* No port has OFPUTIL_PC_NO_FLOOD set? */
  95 };
  96
  97 struct xport {
  98     struct hmap_node hmap_node;      /* Node in global 'xports' map. */
  99     struct ofport_dpif *ofport;      /* Key in global 'xports map. */
 100
 101     struct hmap_node ofp_node;       /* Node in parent xbridge 'xports' map. */
 102     ofp_port_t ofp_port;             /* Key in parent xbridge 'xports' map. */
 103
 104     odp_port_t odp_port;             /* Datapath port number or ODPP_NONE. */
 105
 106     struct list bundle_node;         /* In parent xbundle (if it exists). */
 107     struct xbundle *xbundle;         /* Parent xbundle or null. */
 108
 109     struct netdev *netdev;           /* 'ofport''s netdev. */
 110
 111     struct xbridge *xbridge;         /* Parent bridge. */
 112     struct xport *peer;              /* Patch port peer or null. */
 113
 114     enum ofputil_port_config config; /* OpenFlow port configuration. */
 115     enum stp_state stp_state;        /* STP_DISABLED if STP not in use. */
 116
 117     bool may_enable;                 /* May be enabled in bonds. */
 118     bool is_tunnel;                  /* Is a tunnel port. */
 119
 120     struct cfm *cfm;                 /* CFM handle or null. */
 121     struct bfd *bfd;                 /* BFD handle or null. */
 122 };
 123
 124 struct xlate_ctx {
 125     struct xlate_in *xin;
 126     struct xlate_out *xout;
 127
 128     const struct xbridge *xbridge;
 129
 130     /* Flow at the last commit. */
 131     struct flow base_flow;
 132
 133     /* Tunnel IP destination address as received.  This is stored separately
 134      * as the base_flow.tunnel is cleared on init to reflect the datapath
 135      * behavior.  Used to make sure not to send tunneled output to ourselves,
 136      * which might lead to an infinite loop.  This could happen easily
 137      * if a tunnel is marked as 'ip_remote=flow', and the flow does not
 138      * actually set the tun_dst field. */
 139     ovs_be32 orig_tunnel_ip_dst;
 140
 141     /* Stack for the push and pop actions.  Each stack element is of type
 142      * "union mf_subvalue". */
 143     union mf_subvalue init_stack[1024 / sizeof(union mf_subvalue)];
 144     struct ofpbuf stack;
 145
 146     /* The rule that we are currently translating, or NULL. */
 147     struct rule_dpif *rule;
 148
 149     int recurse;                /* Recursion level, via xlate_table_action. */
 150     bool max_resubmit_trigger;  /* Recursed too deeply during translation. */
 151     uint32_t orig_skb_priority; /* Priority when packet arrived. */
 152     uint8_t table_id;           /* OpenFlow table ID where flow was found. */
 153     uint32_t sflow_n_outputs;   /* Number of output ports. */
 154     odp_port_t sflow_odp_port;  /* Output port for composing sFlow action. */
 155     uint16_t user_cookie_offset;/* Used for user_action_cookie fixup. */
 156     bool exit;                  /* No further actions should be processed. */
 157 };
 158
 159 /* A controller may use OFPP_NONE as the ingress port to indicate that
 160  * it did not arrive on a "real" port.  'ofpp_none_bundle' exists for
 161  * when an input bundle is needed for validation (e.g., mirroring or
 162  * OFPP_NORMAL processing).  It is not connected to an 'ofproto' or have
 163  * any 'port' structs, so care must be taken when dealing with it.
 164  * The bundle's name and vlan mode are initialized in lookup_input_bundle() */
 165 static struct xbundle ofpp_none_bundle;
 166
 167 static struct hmap xbridges = HMAP_INITIALIZER(&xbridges);
 168 static struct hmap xbundles = HMAP_INITIALIZER(&xbundles);
 169 static struct hmap xports = HMAP_INITIALIZER(&xports);
 170
 171 static bool may_receive(const struct xport *, struct xlate_ctx *);
 172 static void do_xlate_actions(const struct ofpact *, size_t ofpacts_len,
 173                              struct xlate_ctx *);
 174 static void xlate_normal(struct xlate_ctx *);
 175 static void xlate_report(struct xlate_ctx *, const char *);
 176 static void xlate_table_action(struct xlate_ctx *, ofp_port_t in_port,
 177                                uint8_t table_id, bool may_packet_in);
 178 static bool input_vid_is_valid(uint16_t vid, struct xbundle *, bool warn);
 179 static uint16_t input_vid_to_vlan(const struct xbundle *, uint16_t vid);
 180 static void output_normal(struct xlate_ctx *, const struct xbundle *,
 181                           uint16_t vlan);
 182 static void compose_output_action(struct xlate_ctx *, ofp_port_t ofp_port);
 183
 184 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
 185
 186 static struct xbridge *xbridge_lookup(const struct ofproto_dpif *);
 187 static struct xbundle *xbundle_lookup(const struct ofbundle *);
 188 static struct xport *xport_lookup(struct ofport_dpif *);
 189 static struct xport *get_ofp_port(const struct xbridge *, ofp_port_t ofp_port);
 190
 191 void
 192 xlate_ofproto_set(struct ofproto_dpif *ofproto, const char *name,
 193                   const struct mac_learning *ml, const struct mbridge *mbridge,
 194                   const struct dpif_sflow *sflow,
 195                   const struct dpif_ipfix *ipfix, enum ofp_config_flags frag,
 196                   bool forward_bpdu, bool has_in_band, bool has_netflow,
 197                   bool has_stp)
 198 {
 199     struct xbridge *xbridge = xbridge_lookup(ofproto);
 200
 201     if (!xbridge) {
 202         xbridge = xzalloc(sizeof *xbridge);
 203         xbridge->ofproto = ofproto;
 204
 205         hmap_insert(&xbridges, &xbridge->hmap_node, hash_pointer(ofproto, 0));
 206         hmap_init(&xbridge->xports);
 207         list_init(&xbridge->xbundles);
 208     }
 209
 210     if (xbridge->ml != ml) {
 211         mac_learning_unref(xbridge->ml);
 212         xbridge->ml = mac_learning_ref(ml);
 213     }
 214
 215     if (xbridge->mbridge != mbridge) {
 216         mbridge_unref(xbridge->mbridge);
 217         xbridge->mbridge = mbridge_ref(mbridge);
 218     }
 219
 220     if (xbridge->sflow != sflow) {
 221         dpif_sflow_unref(xbridge->sflow);
 222         xbridge->sflow = dpif_sflow_ref(sflow);
 223     }
 224
 225     if (xbridge->ipfix != ipfix) {
 226         dpif_ipfix_unref(xbridge->ipfix);
 227         xbridge->ipfix = dpif_ipfix_ref(ipfix);
 228     }
 229
 230     free(xbridge->name);
 231     xbridge->name = xstrdup(name);
 232
 233     xbridge->forward_bpdu = forward_bpdu;
 234     xbridge->has_in_band = has_in_band;
 235     xbridge->has_netflow = has_netflow;
 236     xbridge->has_stp = has_stp;
 237     xbridge->frag = frag;
 238 }
 239
 240 void
 241 xlate_remove_ofproto(struct ofproto_dpif *ofproto)
 242 {
 243     struct xbridge *xbridge = xbridge_lookup(ofproto);
 244     struct xbundle *xbundle, *next_xbundle;
 245     struct xport *xport, *next_xport;
 246
 247     if (!xbridge) {
 248         return;
 249     }
 250
 251     HMAP_FOR_EACH_SAFE (xport, next_xport, ofp_node, &xbridge->xports) {
 252         xlate_ofport_remove(xport->ofport);
 253     }
 254
 255     LIST_FOR_EACH_SAFE (xbundle, next_xbundle, list_node, &xbridge->xbundles) {
 256         xlate_bundle_remove(xbundle->ofbundle);
 257     }
 258
 259     hmap_remove(&xbridges, &xbridge->hmap_node);
 260     free(xbridge->name);
 261     free(xbridge);
 262 }
 263
 264 void
 265 xlate_bundle_set(struct ofproto_dpif *ofproto, struct ofbundle *ofbundle,
 266                  const char *name, enum port_vlan_mode vlan_mode, int vlan,
 267                  unsigned long *trunks, bool use_priority_tags,
 268                  const struct bond *bond, const struct lacp *lacp,
 269                  bool floodable)
 270 {
 271     struct xbundle *xbundle = xbundle_lookup(ofbundle);
 272
 273     if (!xbundle) {
 274         xbundle = xzalloc(sizeof *xbundle);
 275         xbundle->ofbundle = ofbundle;
 276         xbundle->xbridge = xbridge_lookup(ofproto);
 277
 278         hmap_insert(&xbundles, &xbundle->hmap_node, hash_pointer(ofbundle, 0));
 279         list_insert(&xbundle->xbridge->xbundles, &xbundle->list_node);
 280         list_init(&xbundle->xports);
 281     }
 282
 283     ovs_assert(xbundle->xbridge);
 284
 285     free(xbundle->name);
 286     xbundle->name = xstrdup(name);
 287
 288     xbundle->vlan_mode = vlan_mode;
 289     xbundle->vlan = vlan;
 290     xbundle->trunks = trunks;
 291     xbundle->use_priority_tags = use_priority_tags;
 292     xbundle->floodable = floodable;
 293
 294     if (xbundle->bond != bond) {
 295         bond_unref(xbundle->bond);
 296         xbundle->bond = bond_ref(bond);
 297     }
 298
 299     if (xbundle->lacp != lacp) {
 300         lacp_unref(xbundle->lacp);
 301         xbundle->lacp = lacp_ref(lacp);
 302     }
 303 }
 304
 305 void
 306 xlate_bundle_remove(struct ofbundle *ofbundle)
 307 {
 308     struct xbundle *xbundle = xbundle_lookup(ofbundle);
 309     struct xport *xport, *next;
 310
 311     if (!xbundle) {
 312         return;
 313     }
 314
 315     LIST_FOR_EACH_SAFE (xport, next, bundle_node, &xbundle->xports) {
 316         list_remove(&xport->bundle_node);
 317         xport->xbundle = NULL;
 318     }
 319
 320     hmap_remove(&xbundles, &xbundle->hmap_node);
 321     list_remove(&xbundle->list_node);
 322     bond_unref(xbundle->bond);
 323     lacp_unref(xbundle->lacp);
 324     free(xbundle->name);
 325     free(xbundle);
 326 }
 327
 328 void
 329 xlate_ofport_set(struct ofproto_dpif *ofproto, struct ofbundle *ofbundle,
 330                  struct ofport_dpif *ofport, ofp_port_t ofp_port,
 331                  odp_port_t odp_port, const struct netdev *netdev,
 332                  const struct cfm *cfm, const struct bfd *bfd,
 333                  struct ofport_dpif *peer, enum ofputil_port_config config,
 334                  enum stp_state stp_state, bool is_tunnel, bool may_enable)
 335 {
 336     struct xport *xport = xport_lookup(ofport);
 337
 338     if (!xport) {
 339         xport = xzalloc(sizeof *xport);
 340         xport->ofport = ofport;
 341         xport->xbridge = xbridge_lookup(ofproto);
 342         xport->ofp_port = ofp_port;
 343
 344         hmap_insert(&xports, &xport->hmap_node, hash_pointer(ofport, 0));
 345         hmap_insert(&xport->xbridge->xports, &xport->ofp_node,
 346                     hash_ofp_port(xport->ofp_port));
 347     }
 348
 349     ovs_assert(xport->ofp_port == ofp_port);
 350
 351     xport->config = config;
 352     xport->stp_state = stp_state;
 353     xport->is_tunnel = is_tunnel;
 354     xport->may_enable = may_enable;
 355     xport->odp_port = odp_port;
 356
 357     if (xport->netdev != netdev) {
 358         netdev_close(xport->netdev);
 359         xport->netdev = netdev_ref(netdev);
 360     }
 361
 362     if (xport->cfm != cfm) {
 363         cfm_unref(xport->cfm);
 364         xport->cfm = cfm_ref(cfm);
 365     }
 366
 367     if (xport->bfd != bfd) {
 368         bfd_unref(xport->bfd);
 369         xport->bfd = bfd_ref(bfd);
 370     }
 371
 372     if (xport->peer) {
 373         xport->peer->peer = NULL;
 374     }
 375     xport->peer = peer ? xport_lookup(peer) : NULL;
 376     if (xport->peer) {
 377         xport->peer->peer = xport;
 378     }
 379
 380     if (xport->xbundle) {
 381         list_remove(&xport->bundle_node);
 382     }
 383     xport->xbundle = ofbundle ? xbundle_lookup(ofbundle) : NULL;
 384     if (xport->xbundle) {
 385         list_insert(&xport->xbundle->xports, &xport->bundle_node);
 386     }
 387 }
 388
 389 void
 390 xlate_ofport_remove(struct ofport_dpif *ofport)
 391 {
 392     struct xport *xport = xport_lookup(ofport);
 393
 394     if (!xport) {
 395         return;
 396     }
 397
 398     if (xport->peer) {
 399         xport->peer->peer = NULL;
 400         xport->peer = NULL;
 401     }
 402
 403     if (xport->xbundle) {
 404         list_remove(&xport->bundle_node);
 405     }
 406
 407     hmap_remove(&xports, &xport->hmap_node);
 408     hmap_remove(&xport->xbridge->xports, &xport->ofp_node);
 409
 410     netdev_close(xport->netdev);
 411     cfm_unref(xport->cfm);
 412     bfd_unref(xport->bfd);
 413     free(xport);
 414 }
 415
 416 static struct xbridge *
 417 xbridge_lookup(const struct ofproto_dpif *ofproto)
 418 {
 419     struct xbridge *xbridge;
 420
 421     HMAP_FOR_EACH_IN_BUCKET (xbridge, hmap_node, hash_pointer(ofproto, 0),
 422                              &xbridges) {
 423         if (xbridge->ofproto == ofproto) {
 424             return xbridge;
 425         }
 426     }
 427     return NULL;
 428 }
 429
 430 static struct xbundle *
 431 xbundle_lookup(const struct ofbundle *ofbundle)
 432 {
 433     struct xbundle *xbundle;
 434
 435     HMAP_FOR_EACH_IN_BUCKET (xbundle, hmap_node, hash_pointer(ofbundle, 0),
 436                              &xbundles) {
 437         if (xbundle->ofbundle == ofbundle) {
 438             return xbundle;
 439         }
 440     }
 441     return NULL;
 442 }
 443
 444 static struct xport *
 445 xport_lookup(struct ofport_dpif *ofport)
 446 {
 447     struct xport *xport;
 448
 449     HMAP_FOR_EACH_IN_BUCKET (xport, hmap_node, hash_pointer(ofport, 0),
 450                              &xports) {
 451         if (xport->ofport == ofport) {
 452             return xport;
 453         }
 454     }
 455     return NULL;
 456 }
 457
 458 static struct xport *
 459 get_ofp_port(const struct xbridge *xbridge, ofp_port_t ofp_port)
 460 {
 461     struct xport *xport;
 462
 463     HMAP_FOR_EACH_IN_BUCKET (xport, ofp_node, hash_ofp_port(ofp_port),
 464                              &xbridge->xports) {
 465         if (xport->ofp_port == ofp_port) {
 466             return xport;
 467         }
 468     }
 469     return NULL;
 470 }
 471
 472 static odp_port_t
 473 ofp_port_to_odp_port(const struct xbridge *xbridge, ofp_port_t ofp_port)
 474 {
 475     const struct xport *xport = get_ofp_port(xbridge, ofp_port);
 476     return xport ? xport->odp_port : ODPP_NONE;
 477 }
 478
 479 static bool
 480 xbundle_trunks_vlan(const struct xbundle *bundle, uint16_t vlan)
 481 {
 482     return (bundle->vlan_mode != PORT_VLAN_ACCESS
 483             && (!bundle->trunks || bitmap_is_set(bundle->trunks, vlan)));
 484 }
 485
 486 static bool
 487 xbundle_includes_vlan(const struct xbundle *xbundle, uint16_t vlan)
 488 {
 489     return vlan == xbundle->vlan || xbundle_trunks_vlan(xbundle, vlan);
 490 }
 491
 492 static mirror_mask_t
 493 xbundle_mirror_out(const struct xbridge *xbridge, struct xbundle *xbundle)
 494 {
 495     return xbundle != &ofpp_none_bundle
 496         ? mirror_bundle_out(xbridge->mbridge, xbundle->ofbundle)
 497         : 0;
 498 }
 499
 500 static mirror_mask_t
 501 xbundle_mirror_src(const struct xbridge *xbridge, struct xbundle *xbundle)
 502 {
 503     return xbundle != &ofpp_none_bundle
 504         ? mirror_bundle_src(xbridge->mbridge, xbundle->ofbundle)
 505         : 0;
 506 }
 507
 508 static mirror_mask_t
 509 xbundle_mirror_dst(const struct xbridge *xbridge, struct xbundle *xbundle)
 510 {
 511     return xbundle != &ofpp_none_bundle
 512         ? mirror_bundle_dst(xbridge->mbridge, xbundle->ofbundle)
 513         : 0;
 514 }
 515
 516 static struct xbundle *
 517 lookup_input_bundle(const struct xbridge *xbridge, ofp_port_t in_port,
 518                     bool warn, struct xport **in_xportp)
 519 {
 520     struct xport *xport;
 521
 522     /* Find the port and bundle for the received packet. */
 523     xport = get_ofp_port(xbridge, in_port);
 524     if (in_xportp) {
 525         *in_xportp = xport;
 526     }
 527     if (xport && xport->xbundle) {
 528         return xport->xbundle;
 529     }
 530
 531     /* Special-case OFPP_NONE, which a controller may use as the ingress
 532      * port for traffic that it is sourcing. */
 533     if (in_port == OFPP_NONE) {
 534         ofpp_none_bundle.name = "OFPP_NONE";
 535         ofpp_none_bundle.vlan_mode = PORT_VLAN_TRUNK;
 536         return &ofpp_none_bundle;
 537     }
 538
 539     /* Odd.  A few possible reasons here:
 540      *
 541      * - We deleted a port but there are still a few packets queued up
 542      *   from it.
 543      *
 544      * - Someone externally added a port (e.g. "ovs-dpctl add-if") that
 545      *   we don't know about.
 546      *
 547      * - The ofproto client didn't configure the port as part of a bundle.
 548      *   This is particularly likely to happen if a packet was received on the
 549      *   port after it was created, but before the client had a chance to
 550      *   configure its bundle.
 551      */
 552     if (warn) {
 553         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
 554
 555         VLOG_WARN_RL(&rl, "bridge %s: received packet on unknown "
 556                      "port %"PRIu16, xbridge->name, in_port);
 557     }
 558     return NULL;
 559 }
 560
 561 static void
 562 add_mirror_actions(struct xlate_ctx *ctx, const struct flow *orig_flow)
 563 {
 564     const struct xbridge *xbridge = ctx->xbridge;
 565     mirror_mask_t mirrors;
 566     struct xbundle *in_xbundle;
 567     uint16_t vlan;
 568     uint16_t vid;
 569
 570     mirrors = ctx->xout->mirrors;
 571     ctx->xout->mirrors = 0;
 572
 573     in_xbundle = lookup_input_bundle(xbridge, orig_flow->in_port.ofp_port,
 574                                      ctx->xin->packet != NULL, NULL);
 575     if (!in_xbundle) {
 576         return;
 577     }
 578     mirrors |= xbundle_mirror_src(xbridge, in_xbundle);
 579
 580     /* Drop frames on bundles reserved for mirroring. */
 581     if (xbundle_mirror_out(xbridge, in_xbundle)) {
 582         if (ctx->xin->packet != NULL) {
 583             static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
 584             VLOG_WARN_RL(&rl, "bridge %s: dropping packet received on port "
 585                          "%s, which is reserved exclusively for mirroring",
 586                          ctx->xbridge->name, in_xbundle->name);
 587         }
 588         ofpbuf_clear(&ctx->xout->odp_actions);
 589         return;
 590     }
 591
 592     /* Check VLAN. */
 593     vid = vlan_tci_to_vid(orig_flow->vlan_tci);
 594     if (!input_vid_is_valid(vid, in_xbundle, ctx->xin->packet != NULL)) {
 595         return;
 596     }
 597     vlan = input_vid_to_vlan(in_xbundle, vid);
 598
 599     if (!mirrors) {
 600         return;
 601     }
 602
 603     /* Restore the original packet before adding the mirror actions. */
 604     ctx->xin->flow = *orig_flow;
 605
 606     while (mirrors) {
 607         mirror_mask_t dup_mirrors;
 608         struct ofbundle *out;
 609         unsigned long *vlans;
 610         bool vlan_mirrored;
 611         bool has_mirror;
 612         int out_vlan;
 613
 614         has_mirror = mirror_get(xbridge->mbridge, mirror_mask_ffs(mirrors) - 1,
 615                                 &vlans, &dup_mirrors, &out, &out_vlan);
 616         ovs_assert(has_mirror);
 617
 618         if (vlans) {
 619             ctx->xout->wc.masks.vlan_tci |= htons(VLAN_CFI | VLAN_VID_MASK);
 620         }
 621         vlan_mirrored = !vlans || bitmap_is_set(vlans, vlan);
 622         free(vlans);
 623
 624         if (!vlan_mirrored) {
 625             mirrors = zero_rightmost_1bit(mirrors);
 626             continue;
 627         }
 628
 629         mirrors &= ~dup_mirrors;
 630         ctx->xout->mirrors |= dup_mirrors;
 631         if (out) {
 632             struct xbundle *out_xbundle = xbundle_lookup(out);
 633             if (out_xbundle) {
 634                 output_normal(ctx, out_xbundle, vlan);
 635             }
 636         } else if (vlan != out_vlan
 637                    && !eth_addr_is_reserved(orig_flow->dl_dst)) {
 638             struct xbundle *xbundle;
 639
 640             LIST_FOR_EACH (xbundle, list_node, &xbridge->xbundles) {
 641                 if (xbundle_includes_vlan(xbundle, out_vlan)
 642                     && !xbundle_mirror_out(xbridge, xbundle)) {
 643                     output_normal(ctx, xbundle, out_vlan);
 644                 }
 645             }
 646         }
 647     }
 648 }
 649
 650 /* Given 'vid', the VID obtained from the 802.1Q header that was received as
 651  * part of a packet (specify 0 if there was no 802.1Q header), and 'in_xbundle',
 652  * the bundle on which the packet was received, returns the VLAN to which the
 653  * packet belongs.
 654  *
 655  * Both 'vid' and the return value are in the range 0...4095. */
 656 static uint16_t
 657 input_vid_to_vlan(const struct xbundle *in_xbundle, uint16_t vid)
 658 {
 659     switch (in_xbundle->vlan_mode) {
 660     case PORT_VLAN_ACCESS:
 661         return in_xbundle->vlan;
 662         break;
 663
 664     case PORT_VLAN_TRUNK:
 665         return vid;
 666
 667     case PORT_VLAN_NATIVE_UNTAGGED:
 668     case PORT_VLAN_NATIVE_TAGGED:
 669         return vid ? vid : in_xbundle->vlan;
 670
 671     default:
 672         NOT_REACHED();
 673     }
 674 }
 675
 676 /* Checks whether a packet with the given 'vid' may ingress on 'in_xbundle'.
 677  * If so, returns true.  Otherwise, returns false and, if 'warn' is true, logs
 678  * a warning.
 679  *
 680  * 'vid' should be the VID obtained from the 802.1Q header that was received as
 681  * part of a packet (specify 0 if there was no 802.1Q header), in the range
 682  * 0...4095. */
 683 static bool
 684 input_vid_is_valid(uint16_t vid, struct xbundle *in_xbundle, bool warn)
 685 {
 686     /* Allow any VID on the OFPP_NONE port. */
 687     if (in_xbundle == &ofpp_none_bundle) {
 688         return true;
 689     }
 690
 691     switch (in_xbundle->vlan_mode) {
 692     case PORT_VLAN_ACCESS:
 693         if (vid) {
 694             if (warn) {
 695                 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
 696                 VLOG_WARN_RL(&rl, "dropping VLAN %"PRIu16" tagged "
 697                              "packet received on port %s configured as VLAN "
 698                              "%"PRIu16" access port", vid, in_xbundle->name,
 699                              in_xbundle->vlan);
 700             }
 701             return false;
 702         }
 703         return true;
 704
 705     case PORT_VLAN_NATIVE_UNTAGGED:
 706     case PORT_VLAN_NATIVE_TAGGED:
 707         if (!vid) {
 708             /* Port must always carry its native VLAN. */
 709             return true;
 710         }
 711         /* Fall through. */
 712     case PORT_VLAN_TRUNK:
 713         if (!xbundle_includes_vlan(in_xbundle, vid)) {
 714             if (warn) {
 715                 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
 716                 VLOG_WARN_RL(&rl, "dropping VLAN %"PRIu16" packet "
 717                              "received on port %s not configured for trunking "
 718                              "VLAN %"PRIu16, vid, in_xbundle->name, vid);
 719             }
 720             return false;
 721         }
 722         return true;
 723
 724     default:
 725         NOT_REACHED();
 726     }
 727
 728 }
 729
 730 /* Given 'vlan', the VLAN that a packet belongs to, and
 731  * 'out_xbundle', a bundle on which the packet is to be output, returns the VID
 732  * that should be included in the 802.1Q header.  (If the return value is 0,
 733  * then the 802.1Q header should only be included in the packet if there is a
 734  * nonzero PCP.)
 735  *
 736  * Both 'vlan' and the return value are in the range 0...4095. */
 737 static uint16_t
 738 output_vlan_to_vid(const struct xbundle *out_xbundle, uint16_t vlan)
 739 {
 740     switch (out_xbundle->vlan_mode) {
 741     case PORT_VLAN_ACCESS:
 742         return 0;
 743
 744     case PORT_VLAN_TRUNK:
 745     case PORT_VLAN_NATIVE_TAGGED:
 746         return vlan;
 747
 748     case PORT_VLAN_NATIVE_UNTAGGED:
 749         return vlan == out_xbundle->vlan ? 0 : vlan;
 750
 751     default:
 752         NOT_REACHED();
 753     }
 754 }
 755
 756 static void
 757 output_normal(struct xlate_ctx *ctx, const struct xbundle *out_xbundle,
 758               uint16_t vlan)
 759 {
 760     ovs_be16 *flow_tci = &ctx->xin->flow.vlan_tci;
 761     uint16_t vid;
 762     ovs_be16 tci, old_tci;
 763     struct xport *xport;
 764
 765     vid = output_vlan_to_vid(out_xbundle, vlan);
 766     if (list_is_empty(&out_xbundle->xports)) {
 767         /* Partially configured bundle with no slaves.  Drop the packet. */
 768         return;
 769     } else if (!out_xbundle->bond) {
 770         xport = CONTAINER_OF(list_front(&out_xbundle->xports), struct xport,
 771                              bundle_node);
 772     } else {
 773         struct ofport_dpif *ofport;
 774
 775         ofport = bond_choose_output_slave(out_xbundle->bond, &ctx->xin->flow,
 776                                           &ctx->xout->wc, vid,
 777                                           &ctx->xout->tags);
 778         xport = ofport ? xport_lookup(ofport) : NULL;
 779
 780         if (!xport) {
 781             /* No slaves enabled, so drop packet. */
 782             return;
 783         }
 784     }
 785
 786     old_tci = *flow_tci;
 787     tci = htons(vid);
 788     if (tci || out_xbundle->use_priority_tags) {
 789         tci |= *flow_tci & htons(VLAN_PCP_MASK);
 790         if (tci) {
 791             tci |= htons(VLAN_CFI);
 792         }
 793     }
 794     *flow_tci = tci;
 795
 796     compose_output_action(ctx, xport->ofp_port);
 797     *flow_tci = old_tci;
 798 }
 799
 800 /* A VM broadcasts a gratuitous ARP to indicate that it has resumed after
 801  * migration.  Older Citrix-patched Linux DomU used gratuitous ARP replies to
 802  * indicate this; newer upstream kernels use gratuitous ARP requests. */
 803 static bool
 804 is_gratuitous_arp(const struct flow *flow, struct flow_wildcards *wc)
 805 {
 806     if (flow->dl_type != htons(ETH_TYPE_ARP)) {
 807         return false;
 808     }
 809
 810     memset(&wc->masks.dl_dst, 0xff, sizeof wc->masks.dl_dst);
 811     if (!eth_addr_is_broadcast(flow->dl_dst)) {
 812         return false;
 813     }
 814
 815     memset(&wc->masks.nw_proto, 0xff, sizeof wc->masks.nw_proto);
 816     if (flow->nw_proto == ARP_OP_REPLY) {
 817         return true;
 818     } else if (flow->nw_proto == ARP_OP_REQUEST) {
 819         memset(&wc->masks.nw_src, 0xff, sizeof wc->masks.nw_src);
 820         memset(&wc->masks.nw_dst, 0xff, sizeof wc->masks.nw_dst);
 821
 822         return flow->nw_src == flow->nw_dst;
 823     } else {
 824         return false;
 825     }
 826 }
 827
 828 static void
 829 update_learning_table(const struct xbridge *xbridge,
 830                       const struct flow *flow, struct flow_wildcards *wc,
 831                       int vlan, struct xbundle *in_xbundle)
 832 {
 833     struct mac_entry *mac;
 834
 835     /* Don't learn the OFPP_NONE port. */
 836     if (in_xbundle == &ofpp_none_bundle) {
 837         return;
 838     }
 839
 840     if (!mac_learning_may_learn(xbridge->ml, flow->dl_src, vlan)) {
 841         return;
 842     }
 843
 844     mac = mac_learning_insert(xbridge->ml, flow->dl_src, vlan);
 845     if (is_gratuitous_arp(flow, wc)) {
 846         /* We don't want to learn from gratuitous ARP packets that are
 847          * reflected back over bond slaves so we lock the learning table. */
 848         if (!in_xbundle->bond) {
 849             mac_entry_set_grat_arp_lock(mac);
 850         } else if (mac_entry_is_grat_arp_locked(mac)) {
 851             return;
 852         }
 853     }
 854
 855     if (mac_entry_is_new(mac) || mac->port.p != in_xbundle->ofbundle) {
 856         /* The log messages here could actually be useful in debugging,
 857          * so keep the rate limit relatively high. */
 858         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(30, 300);
 859         VLOG_DBG_RL(&rl, "bridge %s: learned that "ETH_ADDR_FMT" is "
 860                     "on port %s in VLAN %d",
 861                     xbridge->name, ETH_ADDR_ARGS(flow->dl_src),
 862                     in_xbundle->name, vlan);
 863
 864         mac->port.p = in_xbundle->ofbundle;
 865         mac_learning_changed(xbridge->ml, mac);
 866     }
 867 }
 868
 869 /* Determines whether packets in 'flow' within 'xbridge' should be forwarded or
 870  * dropped.  Returns true if they may be forwarded, false if they should be
 871  * dropped.
 872  *
 873  * 'in_port' must be the xport that corresponds to flow->in_port.
 874  * 'in_port' must be part of a bundle (e.g. in_port->bundle must be nonnull).
 875  *
 876  * 'vlan' must be the VLAN that corresponds to flow->vlan_tci on 'in_port', as
 877  * returned by input_vid_to_vlan().  It must be a valid VLAN for 'in_port', as
 878  * checked by input_vid_is_valid().
 879  *
 880  * May also add tags to '*tags', although the current implementation only does
 881  * so in one special case.
 882  */
 883 static bool
 884 is_admissible(struct xlate_ctx *ctx, struct xport *in_port,
 885               uint16_t vlan)
 886 {
 887     struct xbundle *in_xbundle = in_port->xbundle;
 888     const struct xbridge *xbridge = ctx->xbridge;
 889     struct flow *flow = &ctx->xin->flow;
 890
 891     /* Drop frames for reserved multicast addresses
 892      * only if forward_bpdu option is absent. */
 893     if (!xbridge->forward_bpdu && eth_addr_is_reserved(flow->dl_dst)) {
 894         xlate_report(ctx, "packet has reserved destination MAC, dropping");
 895         return false;
 896     }
 897
 898     if (in_xbundle->bond) {
 899         struct mac_entry *mac;
 900
 901         switch (bond_check_admissibility(in_xbundle->bond, in_port->ofport,
 902                                          flow->dl_dst, &ctx->xout->tags)) {
 903         case BV_ACCEPT:
 904             break;
 905
 906         case BV_DROP:
 907             xlate_report(ctx, "bonding refused admissibility, dropping");
 908             return false;
 909
 910         case BV_DROP_IF_MOVED:
 911             mac = mac_learning_lookup(xbridge->ml, flow->dl_src, vlan, NULL);
 912             if (mac && mac->port.p != in_xbundle->ofbundle &&
 913                 (!is_gratuitous_arp(flow, &ctx->xout->wc)
 914                  || mac_entry_is_grat_arp_locked(mac))) {
 915                 xlate_report(ctx, "SLB bond thinks this packet looped back, "
 916                             "dropping");
 917                 return false;
 918             }
 919             break;
 920         }
 921     }
 922
 923     return true;
 924 }
 925
 926 static void
 927 xlate_normal(struct xlate_ctx *ctx)
 928 {
 929     struct flow_wildcards *wc = &ctx->xout->wc;
 930     struct flow *flow = &ctx->xin->flow;
 931     struct xbundle *in_xbundle;
 932     struct xport *in_port;
 933     struct mac_entry *mac;
 934     uint16_t vlan;
 935     uint16_t vid;
 936
 937     ctx->xout->has_normal = true;
 938
 939     memset(&wc->masks.dl_src, 0xff, sizeof wc->masks.dl_src);
 940     memset(&wc->masks.dl_dst, 0xff, sizeof wc->masks.dl_dst);
 941     wc->masks.vlan_tci |= htons(VLAN_VID_MASK | VLAN_CFI);
 942
 943     in_xbundle = lookup_input_bundle(ctx->xbridge, flow->in_port.ofp_port,
 944                                      ctx->xin->packet != NULL, &in_port);
 945     if (!in_xbundle) {
 946         xlate_report(ctx, "no input bundle, dropping");
 947         return;
 948     }
 949
 950     /* Drop malformed frames. */
 951     if (flow->dl_type == htons(ETH_TYPE_VLAN) &&
 952         !(flow->vlan_tci & htons(VLAN_CFI))) {
 953         if (ctx->xin->packet != NULL) {
 954             static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
 955             VLOG_WARN_RL(&rl, "bridge %s: dropping packet with partial "
 956                          "VLAN tag received on port %s",
 957                          ctx->xbridge->name, in_xbundle->name);
 958         }
 959         xlate_report(ctx, "partial VLAN tag, dropping");
 960         return;
 961     }
 962
 963     /* Drop frames on bundles reserved for mirroring. */
 964     if (xbundle_mirror_out(ctx->xbridge, in_xbundle)) {
 965         if (ctx->xin->packet != NULL) {
 966             static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
 967             VLOG_WARN_RL(&rl, "bridge %s: dropping packet received on port "
 968                          "%s, which is reserved exclusively for mirroring",
 969                          ctx->xbridge->name, in_xbundle->name);
 970         }
 971         xlate_report(ctx, "input port is mirror output port, dropping");
 972         return;
 973     }
 974
 975     /* Check VLAN. */
 976     vid = vlan_tci_to_vid(flow->vlan_tci);
 977     if (!input_vid_is_valid(vid, in_xbundle, ctx->xin->packet != NULL)) {
 978         xlate_report(ctx, "disallowed VLAN VID for this input port, dropping");
 979         return;
 980     }
 981     vlan = input_vid_to_vlan(in_xbundle, vid);
 982
 983     /* Check other admissibility requirements. */
 984     if (in_port && !is_admissible(ctx, in_port, vlan)) {
 985         return;
 986     }
 987
 988     /* Learn source MAC. */
 989     if (ctx->xin->may_learn) {
 990         update_learning_table(ctx->xbridge, flow, wc, vlan, in_xbundle);
 991     }
 992
 993     /* Determine output bundle. */
 994     mac = mac_learning_lookup(ctx->xbridge->ml, flow->dl_dst, vlan,
 995                               &ctx->xout->tags);
 996     if (mac) {
 997         struct xbundle *mac_xbundle = xbundle_lookup(mac->port.p);
 998         if (mac_xbundle && mac_xbundle != in_xbundle) {
 999             xlate_report(ctx, "forwarding to learned port");
1000             output_normal(ctx, mac_xbundle, vlan);
1001         } else if (!mac_xbundle) {
1002             xlate_report(ctx, "learned port is unknown, dropping");
1003         } else {
1004             xlate_report(ctx, "learned port is input port, dropping");
1005         }
1006     } else {
1007         struct xbundle *xbundle;
1008
1009         xlate_report(ctx, "no learned MAC for destination, flooding");
1010         LIST_FOR_EACH (xbundle, list_node, &ctx->xbridge->xbundles) {
1011             if (xbundle != in_xbundle
1012                 && xbundle_includes_vlan(xbundle, vlan)
1013                 && xbundle->floodable
1014                 && !xbundle_mirror_out(ctx->xbridge, xbundle)) {
1015                 output_normal(ctx, xbundle, vlan);
1016             }
1017         }
1018         ctx->xout->nf_output_iface = NF_OUT_FLOOD;
1019     }
1020 }
1021
1022 /* Compose SAMPLE action for sFlow or IPFIX.  The given probability is
1023  * the number of packets out of UINT32_MAX to sample.  The given
1024  * cookie is passed back in the callback for each sampled packet.
1025  */
1026 static size_t
1027 compose_sample_action(const struct xbridge *xbridge,
1028                       struct ofpbuf *odp_actions,
1029                       const struct flow *flow,
1030                       const uint32_t probability,
1031                       const union user_action_cookie *cookie,
1032                       const size_t cookie_size)
1033 {
1034     size_t sample_offset, actions_offset;
1035     int cookie_offset;
1036
1037     sample_offset = nl_msg_start_nested(odp_actions, OVS_ACTION_ATTR_SAMPLE);
1038
1039     nl_msg_put_u32(odp_actions, OVS_SAMPLE_ATTR_PROBABILITY, probability);
1040
1041     actions_offset = nl_msg_start_nested(odp_actions, OVS_SAMPLE_ATTR_ACTIONS);
1042     cookie_offset = put_userspace_action(xbridge->ofproto, odp_actions, flow,
1043                                          cookie, cookie_size);
1044
1045     nl_msg_end_nested(odp_actions, actions_offset);
1046     nl_msg_end_nested(odp_actions, sample_offset);
1047     return cookie_offset;
1048 }
1049
1050 static void
1051 compose_sflow_cookie(const struct xbridge *xbridge, ovs_be16 vlan_tci,
1052                      odp_port_t odp_port, unsigned int n_outputs,
1053                      union user_action_cookie *cookie)
1054 {
1055     int ifindex;
1056
1057     cookie->type = USER_ACTION_COOKIE_SFLOW;
1058     cookie->sflow.vlan_tci = vlan_tci;
1059
1060     /* See http://www.sflow.org/sflow_version_5.txt (search for "Input/output
1061      * port information") for the interpretation of cookie->output. */
1062     switch (n_outputs) {
1063     case 0:
1064         /* 0x40000000 | 256 means "packet dropped for unknown reason". */
1065         cookie->sflow.output = 0x40000000 | 256;
1066         break;
1067
1068     case 1:
1069         ifindex = dpif_sflow_odp_port_to_ifindex(xbridge->sflow, odp_port);
1070         if (ifindex) {
1071             cookie->sflow.output = ifindex;
1072             break;
1073         }
1074         /* Fall through. */
1075     default:
1076         /* 0x80000000 means "multiple output ports. */
1077         cookie->sflow.output = 0x80000000 | n_outputs;
1078         break;
1079     }
1080 }
1081
1082 /* Compose SAMPLE action for sFlow bridge sampling. */
1083 static size_t
1084 compose_sflow_action(const struct xbridge *xbridge,
1085                      struct ofpbuf *odp_actions,
1086                      const struct flow *flow,
1087                      odp_port_t odp_port)
1088 {
1089     uint32_t probability;
1090     union user_action_cookie cookie;
1091
1092     if (!xbridge->sflow || flow->in_port.ofp_port == OFPP_NONE) {
1093         return 0;
1094     }
1095
1096     probability = dpif_sflow_get_probability(xbridge->sflow);
1097     compose_sflow_cookie(xbridge, htons(0), odp_port,
1098                          odp_port == ODPP_NONE ? 0 : 1, &cookie);
1099
1100     return compose_sample_action(xbridge, odp_actions, flow,  probability,
1101                                  &cookie, sizeof cookie.sflow);
1102 }
1103
1104 static void
1105 compose_flow_sample_cookie(uint16_t probability, uint32_t collector_set_id,
1106                            uint32_t obs_domain_id, uint32_t obs_point_id,
1107                            union user_action_cookie *cookie)
1108 {
1109     cookie->type = USER_ACTION_COOKIE_FLOW_SAMPLE;
1110     cookie->flow_sample.probability = probability;
1111     cookie->flow_sample.collector_set_id = collector_set_id;
1112     cookie->flow_sample.obs_domain_id = obs_domain_id;
1113     cookie->flow_sample.obs_point_id = obs_point_id;
1114 }
1115
1116 static void
1117 compose_ipfix_cookie(union user_action_cookie *cookie)
1118 {
1119     cookie->type = USER_ACTION_COOKIE_IPFIX;
1120 }
1121
1122 /* Compose SAMPLE action for IPFIX bridge sampling. */
1123 static void
1124 compose_ipfix_action(const struct xbridge *xbridge,
1125                      struct ofpbuf *odp_actions,
1126                      const struct flow *flow)
1127 {
1128     uint32_t probability;
1129     union user_action_cookie cookie;
1130
1131     if (!xbridge->ipfix || flow->in_port.ofp_port == OFPP_NONE) {
1132         return;
1133     }
1134
1135     probability = dpif_ipfix_get_bridge_exporter_probability(xbridge->ipfix);
1136     compose_ipfix_cookie(&cookie);
1137
1138     compose_sample_action(xbridge, odp_actions, flow,  probability,
1139                           &cookie, sizeof cookie.ipfix);
1140 }
1141
1142 /* SAMPLE action for sFlow must be first action in any given list of
1143  * actions.  At this point we do not have all information required to
1144  * build it. So try to build sample action as complete as possible. */
1145 static void
1146 add_sflow_action(struct xlate_ctx *ctx)
1147 {
1148     ctx->user_cookie_offset = compose_sflow_action(ctx->xbridge,
1149                                                    &ctx->xout->odp_actions,
1150                                                    &ctx->xin->flow, ODPP_NONE);
1151     ctx->sflow_odp_port = 0;
1152     ctx->sflow_n_outputs = 0;
1153 }
1154
1155 /* SAMPLE action for IPFIX must be 1st or 2nd action in any given list
1156  * of actions, eventually after the SAMPLE action for sFlow. */
1157 static void
1158 add_ipfix_action(struct xlate_ctx *ctx)
1159 {
1160     compose_ipfix_action(ctx->xbridge, &ctx->xout->odp_actions,
1161                          &ctx->xin->flow);
1162 }
1163
1164 /* Fix SAMPLE action according to data collected while composing ODP actions.
1165  * We need to fix SAMPLE actions OVS_SAMPLE_ATTR_ACTIONS attribute, i.e. nested
1166  * USERSPACE action's user-cookie which is required for sflow. */
1167 static void
1168 fix_sflow_action(struct xlate_ctx *ctx)
1169 {
1170     const struct flow *base = &ctx->base_flow;
1171     union user_action_cookie *cookie;
1172
1173     if (!ctx->user_cookie_offset) {
1174         return;
1175     }
1176
1177     cookie = ofpbuf_at(&ctx->xout->odp_actions, ctx->user_cookie_offset,
1178                        sizeof cookie->sflow);
1179     ovs_assert(cookie->type == USER_ACTION_COOKIE_SFLOW);
1180
1181     compose_sflow_cookie(ctx->xbridge, base->vlan_tci,
1182                          ctx->sflow_odp_port, ctx->sflow_n_outputs, cookie);
1183 }
1184
1185 static enum slow_path_reason
1186 process_special(struct xlate_ctx *ctx, const struct flow *flow,
1187                 const struct xport *xport, const struct ofpbuf *packet)
1188 {
1189     struct flow_wildcards *wc = &ctx->xout->wc;
1190     const struct xbridge *xbridge = ctx->xbridge;
1191
1192     if (!xport) {
1193         return 0;
1194     } else if (xport->cfm && cfm_should_process_flow(xport->cfm, flow, wc)) {
1195         if (packet) {
1196             cfm_process_heartbeat(xport->cfm, packet);
1197         }
1198         return SLOW_CFM;
1199     } else if (xport->bfd && bfd_should_process_flow(xport->bfd, flow, wc)) {
1200         if (packet) {
1201             bfd_process_packet(xport->bfd, flow, packet);
1202         }
1203         return SLOW_BFD;
1204     } else if (xport->xbundle && xport->xbundle->lacp
1205                && flow->dl_type == htons(ETH_TYPE_LACP)) {
1206         if (packet) {
1207             lacp_process_packet(xport->xbundle->lacp, xport->ofport, packet);
1208         }
1209         return SLOW_LACP;
1210     } else if (xbridge->has_stp && stp_should_process_flow(flow, wc)) {
1211         if (packet) {
1212             stp_process_packet(xport->ofport, packet);
1213         }
1214         return SLOW_STP;
1215     } else {
1216         return 0;
1217     }
1218 }
1219
1220 static void
1221 compose_output_action__(struct xlate_ctx *ctx, ofp_port_t ofp_port,
1222                         bool check_stp)
1223 {
1224     const struct xport *xport = get_ofp_port(ctx->xbridge, ofp_port);
1225     struct flow_wildcards *wc = &ctx->xout->wc;
1226     struct flow *flow = &ctx->xin->flow;
1227     ovs_be16 flow_vlan_tci;
1228     uint32_t flow_skb_mark;
1229     uint8_t flow_nw_tos;
1230     odp_port_t out_port, odp_port;
1231     uint8_t dscp;
1232
1233     /* If 'struct flow' gets additional metadata, we'll need to zero it out
1234      * before traversing a patch port. */
1235     BUILD_ASSERT_DECL(FLOW_WC_SEQ == 20);
1236
1237     if (!xport) {
1238         xlate_report(ctx, "Nonexistent output port");
1239         return;
1240     } else if (xport->config & OFPUTIL_PC_NO_FWD) {
1241         xlate_report(ctx, "OFPPC_NO_FWD set, skipping output");
1242         return;
1243     } else if (check_stp && !stp_forward_in_state(xport->stp_state)) {
1244         xlate_report(ctx, "STP not in forwarding state, skipping output");
1245         return;
1246     }
1247
1248     if (mbridge_has_mirrors(ctx->xbridge->mbridge) && xport->xbundle) {
1249         ctx->xout->mirrors |= xbundle_mirror_dst(xport->xbundle->xbridge,
1250                                                  xport->xbundle);
1251     }
1252
1253     if (xport->peer) {
1254         const struct xport *peer = xport->peer;
1255         struct flow old_flow = ctx->xin->flow;
1256         enum slow_path_reason special;
1257
1258         ctx->xbridge = peer->xbridge;
1259         flow->in_port.ofp_port = peer->ofp_port;
1260         flow->metadata = htonll(0);
1261         memset(&flow->tunnel, 0, sizeof flow->tunnel);
1262         memset(flow->regs, 0, sizeof flow->regs);
1263
1264         special = process_special(ctx, &ctx->xin->flow, peer,
1265                                   ctx->xin->packet);
1266         if (special) {
1267             ctx->xout->slow = special;
1268         } else if (may_receive(peer, ctx)) {
1269             if (stp_forward_in_state(peer->stp_state)) {
1270                 xlate_table_action(ctx, flow->in_port.ofp_port, 0, true);
1271             } else {
1272                 /* Forwarding is disabled by STP.  Let OFPP_NORMAL and the
1273                  * learning action look at the packet, then drop it. */
1274                 struct flow old_base_flow = ctx->base_flow;
1275                 size_t old_size = ctx->xout->odp_actions.size;
1276                 mirror_mask_t old_mirrors = ctx->xout->mirrors;
1277                 xlate_table_action(ctx, flow->in_port.ofp_port, 0, true);
1278                 ctx->xout->mirrors = old_mirrors;
1279                 ctx->base_flow = old_base_flow;
1280                 ctx->xout->odp_actions.size = old_size;
1281             }
1282         }
1283
1284         ctx->xin->flow = old_flow;
1285         ctx->xbridge = xport->xbundle->xbridge;
1286
1287         if (ctx->xin->resubmit_stats) {
1288             netdev_vport_inc_tx(xport->netdev, ctx->xin->resubmit_stats);
1289             netdev_vport_inc_rx(peer->netdev, ctx->xin->resubmit_stats);
1290         }
1291
1292         return;
1293     }
1294
1295     flow_vlan_tci = flow->vlan_tci;
1296     flow_skb_mark = flow->skb_mark;
1297     flow_nw_tos = flow->nw_tos;
1298
1299     if (ofproto_dpif_dscp_from_priority(xport->ofport, flow->skb_priority,
1300                                         &dscp)) {
1301         wc->masks.nw_tos |= IP_ECN_MASK;
1302         flow->nw_tos &= ~IP_DSCP_MASK;
1303         flow->nw_tos |= dscp;
1304     }
1305
1306     if (xport->is_tunnel) {
1307          /* Save tunnel metadata so that changes made due to
1308           * the Logical (tunnel) Port are not visible for any further
1309           * matches, while explicit set actions on tunnel metadata are.
1310           */
1311         struct flow_tnl flow_tnl = flow->tunnel;
1312         odp_port = tnl_port_send(xport->ofport, flow, &ctx->xout->wc);
1313         if (odp_port == ODPP_NONE) {
1314             xlate_report(ctx, "Tunneling decided against output");
1315             goto out; /* restore flow_nw_tos */
1316         }
1317         if (flow->tunnel.ip_dst == ctx->orig_tunnel_ip_dst) {
1318             xlate_report(ctx, "Not tunneling to our own address");
1319             goto out; /* restore flow_nw_tos */
1320         }
1321         if (ctx->xin->resubmit_stats) {
1322             netdev_vport_inc_tx(xport->netdev, ctx->xin->resubmit_stats);
1323         }
1324         out_port = odp_port;
1325         commit_odp_tunnel_action(flow, &ctx->base_flow,
1326                                  &ctx->xout->odp_actions);
1327         flow->tunnel = flow_tnl; /* Restore tunnel metadata */
1328     } else {
1329         ofp_port_t vlandev_port;
1330
1331         odp_port = xport->odp_port;
1332         if (ofproto_has_vlan_splinters(ctx->xbridge->ofproto)) {
1333             wc->masks.vlan_tci |= htons(VLAN_VID_MASK | VLAN_CFI);
1334         }
1335         vlandev_port = vsp_realdev_to_vlandev(ctx->xbridge->ofproto, ofp_port,
1336                                               flow->vlan_tci);
1337         if (vlandev_port == ofp_port) {
1338             out_port = odp_port;
1339         } else {
1340             out_port = ofp_port_to_odp_port(ctx->xbridge, vlandev_port);
1341             flow->vlan_tci = htons(0);
1342         }
1343         flow->skb_mark &= ~IPSEC_MARK;
1344     }
1345
1346     if (out_port != ODPP_NONE) {
1347         commit_odp_actions(flow, &ctx->base_flow,
1348                            &ctx->xout->odp_actions, &ctx->xout->wc);
1349         nl_msg_put_odp_port(&ctx->xout->odp_actions, OVS_ACTION_ATTR_OUTPUT,
1350                             out_port);
1351
1352         ctx->sflow_odp_port = odp_port;
1353         ctx->sflow_n_outputs++;
1354         ctx->xout->nf_output_iface = ofp_port;
1355     }
1356
1357  out:
1358     /* Restore flow */
1359     flow->vlan_tci = flow_vlan_tci;
1360     flow->skb_mark = flow_skb_mark;
1361     flow->nw_tos = flow_nw_tos;
1362 }
1363
1364 static void
1365 compose_output_action(struct xlate_ctx *ctx, ofp_port_t ofp_port)
1366 {
1367     compose_output_action__(ctx, ofp_port, true);
1368 }
1369
1370 /* Common rule processing in one place to avoid duplicating code. */
1371 static struct rule_dpif *
1372 ctx_rule_hooks(struct xlate_ctx *ctx, struct rule_dpif *rule,
1373                bool may_packet_in)
1374 {
1375     if (ctx->xin->resubmit_hook) {
1376         ctx->xin->resubmit_hook(ctx->xin, rule, ctx->recurse);
1377     }
1378     if (rule == NULL && may_packet_in) {
1379         /* XXX
1380          * check if table configuration flags
1381          * OFPTC_TABLE_MISS_CONTROLLER, default.
1382          * OFPTC_TABLE_MISS_CONTINUE,
1383          * OFPTC_TABLE_MISS_DROP
1384          * When OF1.0, OFPTC_TABLE_MISS_CONTINUE is used. What to do?
1385          */
1386         rule = rule_dpif_miss_rule(ctx->xbridge->ofproto, &ctx->xin->flow);
1387     }
1388     if (rule && ctx->xin->resubmit_stats) {
1389         rule_credit_stats(rule, ctx->xin->resubmit_stats);
1390     }
1391     return rule;
1392 }
1393
1394 static void
1395 xlate_table_action(struct xlate_ctx *ctx,
1396                    ofp_port_t in_port, uint8_t table_id, bool may_packet_in)
1397 {
1398     if (ctx->recurse < MAX_RESUBMIT_RECURSION) {
1399         struct rule_dpif *rule;
1400         ofp_port_t old_in_port = ctx->xin->flow.in_port.ofp_port;
1401         uint8_t old_table_id = ctx->table_id;
1402
1403         ctx->table_id = table_id;
1404
1405         /* Look up a flow with 'in_port' as the input port. */
1406         ctx->xin->flow.in_port.ofp_port = in_port;
1407         rule = rule_dpif_lookup_in_table(ctx->xbridge->ofproto,
1408                                          &ctx->xin->flow, &ctx->xout->wc,
1409                                          table_id);
1410
1411         ctx->xout->tags |= calculate_flow_tag(ctx->xbridge->ofproto,
1412                                               &ctx->xin->flow, ctx->table_id,
1413                                               rule);
1414
1415         /* Restore the original input port.  Otherwise OFPP_NORMAL and
1416          * OFPP_IN_PORT will have surprising behavior. */
1417         ctx->xin->flow.in_port.ofp_port = old_in_port;
1418
1419         rule = ctx_rule_hooks(ctx, rule, may_packet_in);
1420
1421         if (rule) {
1422             struct rule_dpif *old_rule = ctx->rule;
1423
1424             ctx->recurse++;
1425             ctx->rule = rule;
1426             do_xlate_actions(rule->up.ofpacts, rule->up.ofpacts_len, ctx);
1427             ctx->rule = old_rule;
1428             ctx->recurse--;
1429         }
1430
1431         ctx->table_id = old_table_id;
1432     } else {
1433         static struct vlog_rate_limit recurse_rl = VLOG_RATE_LIMIT_INIT(1, 1);
1434
1435         VLOG_ERR_RL(&recurse_rl, "resubmit actions recursed over %d times",
1436                     MAX_RESUBMIT_RECURSION);
1437         ctx->max_resubmit_trigger = true;
1438     }
1439 }
1440
1441 static void
1442 xlate_ofpact_resubmit(struct xlate_ctx *ctx,
1443                       const struct ofpact_resubmit *resubmit)
1444 {
1445     ofp_port_t in_port;
1446     uint8_t table_id;
1447
1448     in_port = resubmit->in_port;
1449     if (in_port == OFPP_IN_PORT) {
1450         in_port = ctx->xin->flow.in_port.ofp_port;
1451     }
1452
1453     table_id = resubmit->table_id;
1454     if (table_id == 255) {
1455         table_id = ctx->table_id;
1456     }
1457
1458     xlate_table_action(ctx, in_port, table_id, false);
1459 }
1460
1461 static void
1462 flood_packets(struct xlate_ctx *ctx, bool all)
1463 {
1464     const struct xport *xport;
1465
1466     HMAP_FOR_EACH (xport, ofp_node, &ctx->xbridge->xports) {
1467         if (xport->ofp_port == ctx->xin->flow.in_port.ofp_port) {
1468             continue;
1469         }
1470
1471         if (all) {
1472             compose_output_action__(ctx, xport->ofp_port, false);
1473         } else if (!(xport->config & OFPUTIL_PC_NO_FLOOD)) {
1474             compose_output_action(ctx, xport->ofp_port);
1475         }
1476     }
1477
1478     ctx->xout->nf_output_iface = NF_OUT_FLOOD;
1479 }
1480
1481 static void
1482 execute_controller_action(struct xlate_ctx *ctx, int len,
1483                           enum ofp_packet_in_reason reason,
1484                           uint16_t controller_id)
1485 {
1486     struct ofputil_packet_in pin;
1487     struct ofpbuf *packet;
1488     struct flow key;
1489
1490     ovs_assert(!ctx->xout->slow || ctx->xout->slow == SLOW_CONTROLLER);
1491     ctx->xout->slow = SLOW_CONTROLLER;
1492     if (!ctx->xin->packet) {
1493         return;
1494     }
1495
1496     packet = ofpbuf_clone(ctx->xin->packet);
1497
1498     key.skb_priority = 0;
1499     key.skb_mark = 0;
1500     memset(&key.tunnel, 0, sizeof key.tunnel);
1501
1502     commit_odp_actions(&ctx->xin->flow, &ctx->base_flow,
1503                        &ctx->xout->odp_actions, &ctx->xout->wc);
1504
1505     odp_execute_actions(NULL, packet, &key, ctx->xout->odp_actions.data,
1506                         ctx->xout->odp_actions.size, NULL, NULL);
1507
1508     pin.packet = packet->data;
1509     pin.packet_len = packet->size;
1510     pin.reason = reason;
1511     pin.controller_id = controller_id;
1512     pin.table_id = ctx->table_id;
1513     pin.cookie = ctx->rule ? ctx->rule->up.flow_cookie : 0;
1514
1515     pin.send_len = len;
1516     flow_get_metadata(&ctx->xin->flow, &pin.fmd);
1517
1518     ofproto_dpif_send_packet_in(ctx->xbridge->ofproto, &pin);
1519     ofpbuf_delete(packet);
1520 }
1521
1522 static void
1523 compose_mpls_push_action(struct xlate_ctx *ctx, ovs_be16 eth_type)
1524 {
1525     struct flow_wildcards *wc = &ctx->xout->wc;
1526     struct flow *flow = &ctx->xin->flow;
1527
1528     ovs_assert(eth_type_mpls(eth_type));
1529
1530     memset(&wc->masks.mpls_lse, 0xff, sizeof wc->masks.mpls_lse);
1531     memset(&wc->masks.mpls_depth, 0xff, sizeof wc->masks.mpls_depth);
1532
1533     if (flow->mpls_depth) {
1534         flow->mpls_lse &= ~htonl(MPLS_BOS_MASK);
1535         flow->mpls_depth++;
1536     } else {
1537         ovs_be32 label;
1538         uint8_t tc, ttl;
1539
1540         if (flow->dl_type == htons(ETH_TYPE_IPV6)) {
1541             label = htonl(0x2); /* IPV6 Explicit Null. */
1542         } else {
1543             label = htonl(0x0); /* IPV4 Explicit Null. */
1544         }
1545         wc->masks.nw_tos |= IP_DSCP_MASK;
1546         wc->masks.nw_ttl = 0xff;
1547         tc = (flow->nw_tos & IP_DSCP_MASK) >> 2;
1548         ttl = flow->nw_ttl ? flow->nw_ttl : 0x40;
1549         flow->mpls_lse = set_mpls_lse_values(ttl, tc, 1, label);
1550         flow->mpls_depth = 1;
1551     }
1552     flow->dl_type = eth_type;
1553 }
1554
1555 static void
1556 compose_mpls_pop_action(struct xlate_ctx *ctx, ovs_be16 eth_type)
1557 {
1558     struct flow_wildcards *wc = &ctx->xout->wc;
1559     struct flow *flow = &ctx->xin->flow;
1560
1561     ovs_assert(eth_type_mpls(ctx->xin->flow.dl_type));
1562     ovs_assert(!eth_type_mpls(eth_type));
1563
1564     memset(&wc->masks.mpls_lse, 0xff, sizeof wc->masks.mpls_lse);
1565     memset(&wc->masks.mpls_depth, 0xff, sizeof wc->masks.mpls_depth);
1566
1567     if (flow->mpls_depth) {
1568         flow->mpls_depth--;
1569         flow->mpls_lse = htonl(0);
1570         if (!flow->mpls_depth) {
1571             flow->dl_type = eth_type;
1572         }
1573     }
1574 }
1575
1576 static bool
1577 compose_dec_ttl(struct xlate_ctx *ctx, struct ofpact_cnt_ids *ids)
1578 {
1579     struct flow *flow = &ctx->xin->flow;
1580
1581     if (!is_ip_any(flow)) {
1582         return false;
1583     }
1584
1585     ctx->xout->wc.masks.nw_ttl = 0xff;
1586     if (flow->nw_ttl > 1) {
1587         flow->nw_ttl--;
1588         return false;
1589     } else {
1590         size_t i;
1591
1592         for (i = 0; i < ids->n_controllers; i++) {
1593             execute_controller_action(ctx, UINT16_MAX, OFPR_INVALID_TTL,
1594                                       ids->cnt_ids[i]);
1595         }
1596
1597         /* Stop processing for current table. */
1598         return true;
1599     }
1600 }
1601
1602 static bool
1603 compose_set_mpls_ttl_action(struct xlate_ctx *ctx, uint8_t ttl)
1604 {
1605     if (!eth_type_mpls(ctx->xin->flow.dl_type)) {
1606         return true;
1607     }
1608
1609     set_mpls_lse_ttl(&ctx->xin->flow.mpls_lse, ttl);
1610     return false;
1611 }
1612
1613 static bool
1614 compose_dec_mpls_ttl_action(struct xlate_ctx *ctx)
1615 {
1616     struct flow *flow = &ctx->xin->flow;
1617     uint8_t ttl = mpls_lse_to_ttl(flow->mpls_lse);
1618     struct flow_wildcards *wc = &ctx->xout->wc;
1619
1620     memset(&wc->masks.mpls_lse, 0xff, sizeof wc->masks.mpls_lse);
1621
1622     if (!eth_type_mpls(flow->dl_type)) {
1623         return false;
1624     }
1625
1626     if (ttl > 1) {
1627         ttl--;
1628         set_mpls_lse_ttl(&flow->mpls_lse, ttl);
1629         return false;
1630     } else {
1631         execute_controller_action(ctx, UINT16_MAX, OFPR_INVALID_TTL, 0);
1632
1633         /* Stop processing for current table. */
1634         return true;
1635     }
1636 }
1637
1638 static void
1639 xlate_output_action(struct xlate_ctx *ctx,
1640                     ofp_port_t port, uint16_t max_len, bool may_packet_in)
1641 {
1642     ofp_port_t prev_nf_output_iface = ctx->xout->nf_output_iface;
1643
1644     ctx->xout->nf_output_iface = NF_OUT_DROP;
1645
1646     switch (port) {
1647     case OFPP_IN_PORT:
1648         compose_output_action(ctx, ctx->xin->flow.in_port.ofp_port);
1649         break;
1650     case OFPP_TABLE:
1651         xlate_table_action(ctx, ctx->xin->flow.in_port.ofp_port,
1652                            0, may_packet_in);
1653         break;
1654     case OFPP_NORMAL:
1655         xlate_normal(ctx);
1656         break;
1657     case OFPP_FLOOD:
1658         flood_packets(ctx,  false);
1659         break;
1660     case OFPP_ALL:
1661         flood_packets(ctx, true);
1662         break;
1663     case OFPP_CONTROLLER:
1664         execute_controller_action(ctx, max_len, OFPR_ACTION, 0);
1665         break;
1666     case OFPP_NONE:
1667         break;
1668     case OFPP_LOCAL:
1669     default:
1670         if (port != ctx->xin->flow.in_port.ofp_port) {
1671             compose_output_action(ctx, port);
1672         } else {
1673             xlate_report(ctx, "skipping output to input port");
1674         }
1675         break;
1676     }
1677
1678     if (prev_nf_output_iface == NF_OUT_FLOOD) {
1679         ctx->xout->nf_output_iface = NF_OUT_FLOOD;
1680     } else if (ctx->xout->nf_output_iface == NF_OUT_DROP) {
1681         ctx->xout->nf_output_iface = prev_nf_output_iface;
1682     } else if (prev_nf_output_iface != NF_OUT_DROP &&
1683                ctx->xout->nf_output_iface != NF_OUT_FLOOD) {
1684         ctx->xout->nf_output_iface = NF_OUT_MULTI;
1685     }
1686 }
1687
1688 static void
1689 xlate_output_reg_action(struct xlate_ctx *ctx,
1690                         const struct ofpact_output_reg *or)
1691 {
1692     uint64_t port = mf_get_subfield(&or->src, &ctx->xin->flow);
1693     if (port <= UINT16_MAX) {
1694         union mf_subvalue value;
1695
1696         memset(&value, 0xff, sizeof value);
1697         mf_write_subfield_flow(&or->src, &value, &ctx->xout->wc.masks);
1698         xlate_output_action(ctx, u16_to_ofp(port),
1699                             or->max_len, false);
1700     }
1701 }
1702
1703 static void
1704 xlate_enqueue_action(struct xlate_ctx *ctx,
1705                      const struct ofpact_enqueue *enqueue)
1706 {
1707     ofp_port_t ofp_port = enqueue->port;
1708     uint32_t queue_id = enqueue->queue;
1709     uint32_t flow_priority, priority;
1710     int error;
1711
1712     /* Translate queue to priority. */
1713     error = ofproto_dpif_queue_to_priority(ctx->xbridge->ofproto, queue_id,
1714                                            &priority);
1715     if (error) {
1716         /* Fall back to ordinary output action. */
1717         xlate_output_action(ctx, enqueue->port, 0, false);
1718         return;
1719     }
1720
1721     /* Check output port. */
1722     if (ofp_port == OFPP_IN_PORT) {
1723         ofp_port = ctx->xin->flow.in_port.ofp_port;
1724     } else if (ofp_port == ctx->xin->flow.in_port.ofp_port) {
1725         return;
1726     }
1727
1728     /* Add datapath actions. */
1729     flow_priority = ctx->xin->flow.skb_priority;
1730     ctx->xin->flow.skb_priority = priority;
1731     compose_output_action(ctx, ofp_port);
1732     ctx->xin->flow.skb_priority = flow_priority;
1733
1734     /* Update NetFlow output port. */
1735     if (ctx->xout->nf_output_iface == NF_OUT_DROP) {
1736         ctx->xout->nf_output_iface = ofp_port;
1737     } else if (ctx->xout->nf_output_iface != NF_OUT_FLOOD) {
1738         ctx->xout->nf_output_iface = NF_OUT_MULTI;
1739     }
1740 }
1741
1742 static void
1743 xlate_set_queue_action(struct xlate_ctx *ctx, uint32_t queue_id)
1744 {
1745     uint32_t skb_priority;
1746
1747     if (!ofproto_dpif_queue_to_priority(ctx->xbridge->ofproto, queue_id,
1748                                         &skb_priority)) {
1749         ctx->xin->flow.skb_priority = skb_priority;
1750     } else {
1751         /* Couldn't translate queue to a priority.  Nothing to do.  A warning
1752          * has already been logged. */
1753     }
1754 }
1755
1756 static bool
1757 slave_enabled_cb(ofp_port_t ofp_port, void *xbridge_)
1758 {
1759     const struct xbridge *xbridge = xbridge_;
1760     struct xport *port;
1761
1762     switch (ofp_port) {
1763     case OFPP_IN_PORT:
1764     case OFPP_TABLE:
1765     case OFPP_NORMAL:
1766     case OFPP_FLOOD:
1767     case OFPP_ALL:
1768     case OFPP_NONE:
1769         return true;
1770     case OFPP_CONTROLLER: /* Not supported by the bundle action. */
1771         return false;
1772     default:
1773         port = get_ofp_port(xbridge, ofp_port);
1774         return port ? port->may_enable : false;
1775     }
1776 }
1777
1778 static void
1779 xlate_bundle_action(struct xlate_ctx *ctx,
1780                     const struct ofpact_bundle *bundle)
1781 {
1782     ofp_port_t port;
1783
1784     port = bundle_execute(bundle, &ctx->xin->flow, &ctx->xout->wc,
1785                           slave_enabled_cb,
1786                           CONST_CAST(struct xbridge *, ctx->xbridge));
1787     if (bundle->dst.field) {
1788         nxm_reg_load(&bundle->dst, ofp_to_u16(port), &ctx->xin->flow);
1789     } else {
1790         xlate_output_action(ctx, port, 0, false);
1791     }
1792 }
1793
1794 static void
1795 xlate_learn_action(struct xlate_ctx *ctx,
1796                    const struct ofpact_learn *learn)
1797 {
1798     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 1);
1799     struct ofputil_flow_mod fm;
1800     uint64_t ofpacts_stub[1024 / 8];
1801     struct ofpbuf ofpacts;
1802     int error;
1803
1804     ctx->xout->has_learn = true;
1805
1806     learn_mask(learn, &ctx->xout->wc);
1807
1808     if (!ctx->xin->may_learn) {
1809         return;
1810     }
1811
1812     ofpbuf_use_stack(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
1813     learn_execute(learn, &ctx->xin->flow, &fm, &ofpacts);
1814
1815     error = ofproto_dpif_flow_mod(ctx->xbridge->ofproto, &fm);
1816     if (error && !VLOG_DROP_WARN(&rl)) {
1817         VLOG_WARN("learning action failed to modify flow table (%s)",
1818                   ofperr_get_name(error));
1819     }
1820
1821     ofpbuf_uninit(&ofpacts);
1822 }
1823
1824 /* Reduces '*timeout' to no more than 'max'.  A value of zero in either case
1825  * means "infinite". */
1826 static void
1827 reduce_timeout(uint16_t max, uint16_t *timeout)
1828 {
1829     if (max && (!*timeout || *timeout > max)) {
1830         *timeout = max;
1831     }
1832 }
1833
1834 static void
1835 xlate_fin_timeout(struct xlate_ctx *ctx,
1836                   const struct ofpact_fin_timeout *oft)
1837 {
1838     if (ctx->xin->tcp_flags & (TCP_FIN | TCP_RST) && ctx->rule) {
1839         struct rule_dpif *rule = ctx->rule;
1840
1841          if (list_is_empty(&rule->up.expirable)) {
1842              list_insert(&rule->up.ofproto->expirable, &rule->up.expirable);
1843          }
1844
1845         reduce_timeout(oft->fin_idle_timeout, &rule->up.idle_timeout);
1846         reduce_timeout(oft->fin_hard_timeout, &rule->up.hard_timeout);
1847     }
1848 }
1849
1850 static void
1851 xlate_sample_action(struct xlate_ctx *ctx,
1852                     const struct ofpact_sample *os)
1853 {
1854   union user_action_cookie cookie;
1855   /* Scale the probability from 16-bit to 32-bit while representing
1856    * the same percentage. */
1857   uint32_t probability = (os->probability << 16) | os->probability;
1858
1859   commit_odp_actions(&ctx->xin->flow, &ctx->base_flow,
1860                      &ctx->xout->odp_actions, &ctx->xout->wc);
1861
1862   compose_flow_sample_cookie(os->probability, os->collector_set_id,
1863                              os->obs_domain_id, os->obs_point_id, &cookie);
1864   compose_sample_action(ctx->xbridge, &ctx->xout->odp_actions, &ctx->xin->flow,
1865                         probability, &cookie, sizeof cookie.flow_sample);
1866 }
1867
1868 static bool
1869 may_receive(const struct xport *xport, struct xlate_ctx *ctx)
1870 {
1871     if (xport->config & (eth_addr_equals(ctx->xin->flow.dl_dst, eth_addr_stp)
1872                          ? OFPUTIL_PC_NO_RECV_STP
1873                          : OFPUTIL_PC_NO_RECV)) {
1874         return false;
1875     }
1876
1877     /* Only drop packets here if both forwarding and learning are
1878      * disabled.  If just learning is enabled, we need to have
1879      * OFPP_NORMAL and the learning action have a look at the packet
1880      * before we can drop it. */
1881     if (!stp_forward_in_state(xport->stp_state)
1882         && !stp_learn_in_state(xport->stp_state)) {
1883         return false;
1884     }
1885
1886     return true;
1887 }
1888
1889 static bool
1890 tunnel_ecn_ok(struct xlate_ctx *ctx)
1891 {
1892     if (is_ip_any(&ctx->base_flow)
1893         && (ctx->xin->flow.tunnel.ip_tos & IP_ECN_MASK) == IP_ECN_CE) {
1894         if ((ctx->base_flow.nw_tos & IP_ECN_MASK) == IP_ECN_NOT_ECT) {
1895             VLOG_WARN_RL(&rl, "dropping tunnel packet marked ECN CE"
1896                          " but is not ECN capable");
1897             return false;
1898         } else {
1899             /* Set the ECN CE value in the tunneled packet. */
1900             ctx->xin->flow.nw_tos |= IP_ECN_CE;
1901         }
1902     }
1903
1904     return true;
1905 }
1906
1907 static void
1908 do_xlate_actions(const struct ofpact *ofpacts, size_t ofpacts_len,
1909                  struct xlate_ctx *ctx)
1910 {
1911     struct flow_wildcards *wc = &ctx->xout->wc;
1912     struct flow *flow = &ctx->xin->flow;
1913     bool was_evictable = true;
1914     const struct ofpact *a;
1915
1916     if (ctx->rule) {
1917         /* Don't let the rule we're working on get evicted underneath us. */
1918         was_evictable = ctx->rule->up.evictable;
1919         ctx->rule->up.evictable = false;
1920     }
1921
1922  do_xlate_actions_again:
1923     OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
1924         struct ofpact_controller *controller;
1925         const struct ofpact_metadata *metadata;
1926
1927         if (ctx->exit) {
1928             break;
1929         }
1930
1931         switch (a->type) {
1932         case OFPACT_OUTPUT:
1933             xlate_output_action(ctx, ofpact_get_OUTPUT(a)->port,
1934                                 ofpact_get_OUTPUT(a)->max_len, true);
1935             break;
1936
1937         case OFPACT_CONTROLLER:
1938             controller = ofpact_get_CONTROLLER(a);
1939             execute_controller_action(ctx, controller->max_len,
1940                                       controller->reason,
1941                                       controller->controller_id);
1942             break;
1943
1944         case OFPACT_ENQUEUE:
1945             xlate_enqueue_action(ctx, ofpact_get_ENQUEUE(a));
1946             break;
1947
1948         case OFPACT_SET_VLAN_VID:
1949             flow->vlan_tci &= ~htons(VLAN_VID_MASK);
1950             flow->vlan_tci |= (htons(ofpact_get_SET_VLAN_VID(a)->vlan_vid)
1951                                | htons(VLAN_CFI));
1952             break;
1953
1954         case OFPACT_SET_VLAN_PCP:
1955             flow->vlan_tci &= ~htons(VLAN_PCP_MASK);
1956             flow->vlan_tci |=
1957                 htons((ofpact_get_SET_VLAN_PCP(a)->vlan_pcp << VLAN_PCP_SHIFT)
1958                       | VLAN_CFI);
1959             break;
1960
1961         case OFPACT_STRIP_VLAN:
1962             flow->vlan_tci = htons(0);
1963             break;
1964
1965         case OFPACT_PUSH_VLAN:
1966             /* XXX 802.1AD(QinQ) */
1967             flow->vlan_tci = htons(VLAN_CFI);
1968             break;
1969
1970         case OFPACT_SET_ETH_SRC:
1971             memcpy(flow->dl_src, ofpact_get_SET_ETH_SRC(a)->mac, ETH_ADDR_LEN);
1972             break;
1973
1974         case OFPACT_SET_ETH_DST:
1975             memcpy(flow->dl_dst, ofpact_get_SET_ETH_DST(a)->mac, ETH_ADDR_LEN);
1976             break;
1977
1978         case OFPACT_SET_IPV4_SRC:
1979             if (flow->dl_type == htons(ETH_TYPE_IP)) {
1980                 flow->nw_src = ofpact_get_SET_IPV4_SRC(a)->ipv4;
1981             }
1982             break;
1983
1984         case OFPACT_SET_IPV4_DST:
1985             if (flow->dl_type == htons(ETH_TYPE_IP)) {
1986                 flow->nw_dst = ofpact_get_SET_IPV4_DST(a)->ipv4;
1987             }
1988             break;
1989
1990         case OFPACT_SET_IPV4_DSCP:
1991             /* OpenFlow 1.0 only supports IPv4. */
1992             if (flow->dl_type == htons(ETH_TYPE_IP)) {
1993                 flow->nw_tos &= ~IP_DSCP_MASK;
1994                 flow->nw_tos |= ofpact_get_SET_IPV4_DSCP(a)->dscp;
1995             }
1996             break;
1997
1998         case OFPACT_SET_L4_SRC_PORT:
1999             memset(&wc->masks.nw_proto, 0xff, sizeof wc->masks.nw_proto);
2000             if (is_ip_any(flow)) {
2001                 flow->tp_src = htons(ofpact_get_SET_L4_SRC_PORT(a)->port);
2002             }
2003             break;
2004
2005         case OFPACT_SET_L4_DST_PORT:
2006             memset(&wc->masks.nw_proto, 0xff, sizeof wc->masks.nw_proto);
2007             if (is_ip_any(flow)) {
2008                 flow->tp_dst = htons(ofpact_get_SET_L4_DST_PORT(a)->port);
2009             }
2010             break;
2011
2012         case OFPACT_RESUBMIT:
2013             xlate_ofpact_resubmit(ctx, ofpact_get_RESUBMIT(a));
2014             break;
2015
2016         case OFPACT_SET_TUNNEL:
2017             flow->tunnel.tun_id = htonll(ofpact_get_SET_TUNNEL(a)->tun_id);
2018             break;
2019
2020         case OFPACT_SET_QUEUE:
2021             xlate_set_queue_action(ctx, ofpact_get_SET_QUEUE(a)->queue_id);
2022             break;
2023
2024         case OFPACT_POP_QUEUE:
2025             flow->skb_priority = ctx->orig_skb_priority;
2026             break;
2027
2028         case OFPACT_REG_MOVE:
2029             nxm_execute_reg_move(ofpact_get_REG_MOVE(a), flow, wc);
2030             break;
2031
2032         case OFPACT_REG_LOAD:
2033             nxm_execute_reg_load(ofpact_get_REG_LOAD(a), flow);
2034             break;
2035
2036         case OFPACT_STACK_PUSH:
2037             nxm_execute_stack_push(ofpact_get_STACK_PUSH(a), flow, wc,
2038                                    &ctx->stack);
2039             break;
2040
2041         case OFPACT_STACK_POP:
2042             nxm_execute_stack_pop(ofpact_get_STACK_POP(a), flow, &ctx->stack);
2043             break;
2044
2045         case OFPACT_PUSH_MPLS:
2046             compose_mpls_push_action(ctx, ofpact_get_PUSH_MPLS(a)->ethertype);
2047             break;
2048
2049         case OFPACT_POP_MPLS:
2050             compose_mpls_pop_action(ctx, ofpact_get_POP_MPLS(a)->ethertype);
2051             break;
2052
2053         case OFPACT_SET_MPLS_TTL:
2054             if (compose_set_mpls_ttl_action(ctx,
2055                                             ofpact_get_SET_MPLS_TTL(a)->ttl)) {
2056                 goto out;
2057             }
2058             break;
2059
2060         case OFPACT_DEC_MPLS_TTL:
2061             if (compose_dec_mpls_ttl_action(ctx)) {
2062                 goto out;
2063             }
2064             break;
2065
2066         case OFPACT_DEC_TTL:
2067             if (compose_dec_ttl(ctx, ofpact_get_DEC_TTL(a))) {
2068                 goto out;
2069             }
2070             break;
2071
2072         case OFPACT_NOTE:
2073             /* Nothing to do. */
2074             break;
2075
2076         case OFPACT_MULTIPATH:
2077             multipath_execute(ofpact_get_MULTIPATH(a), flow, wc);
2078             break;
2079
2080         case OFPACT_BUNDLE:
2081             xlate_bundle_action(ctx, ofpact_get_BUNDLE(a));
2082             break;
2083
2084         case OFPACT_OUTPUT_REG:
2085             xlate_output_reg_action(ctx, ofpact_get_OUTPUT_REG(a));
2086             break;
2087
2088         case OFPACT_LEARN:
2089             xlate_learn_action(ctx, ofpact_get_LEARN(a));
2090             break;
2091
2092         case OFPACT_EXIT:
2093             ctx->exit = true;
2094             break;
2095
2096         case OFPACT_FIN_TIMEOUT:
2097             memset(&wc->masks.nw_proto, 0xff, sizeof wc->masks.nw_proto);
2098             ctx->xout->has_fin_timeout = true;
2099             xlate_fin_timeout(ctx, ofpact_get_FIN_TIMEOUT(a));
2100             break;
2101
2102         case OFPACT_CLEAR_ACTIONS:
2103             /* XXX
2104              * Nothing to do because writa-actions is not supported for now.
2105              * When writa-actions is supported, clear-actions also must
2106              * be supported at the same time.
2107              */
2108             break;
2109
2110         case OFPACT_WRITE_METADATA:
2111             metadata = ofpact_get_WRITE_METADATA(a);
2112             flow->metadata &= ~metadata->mask;
2113             flow->metadata |= metadata->metadata & metadata->mask;
2114             break;
2115
2116         case OFPACT_METER:
2117             /* Not implemented yet. */
2118             break;
2119
2120         case OFPACT_GOTO_TABLE: {
2121             /* It is assumed that goto-table is the last action. */
2122             struct ofpact_goto_table *ogt = ofpact_get_GOTO_TABLE(a);
2123             struct rule_dpif *rule;
2124
2125             ovs_assert(ctx->table_id < ogt->table_id);
2126
2127             ctx->table_id = ogt->table_id;
2128
2129             /* Look up a flow from the new table. */
2130             rule = rule_dpif_lookup_in_table(ctx->xbridge->ofproto, flow, wc,
2131                                              ctx->table_id);
2132
2133             ctx->xout->tags |= calculate_flow_tag(ctx->xbridge->ofproto,
2134                                                   &ctx->xin->flow,
2135                                                   ctx->table_id, rule);
2136
2137             rule = ctx_rule_hooks(ctx, rule, true);
2138
2139             if (rule) {
2140                 if (ctx->rule) {
2141                     ctx->rule->up.evictable = was_evictable;
2142                 }
2143                 ctx->rule = rule;
2144                 was_evictable = rule->up.evictable;
2145                 rule->up.evictable = false;
2146
2147                 /* Tail recursion removal. */
2148                 ofpacts = rule->up.ofpacts;
2149                 ofpacts_len = rule->up.ofpacts_len;
2150                 goto do_xlate_actions_again;
2151             }
2152             break;
2153         }
2154
2155         case OFPACT_SAMPLE:
2156             xlate_sample_action(ctx, ofpact_get_SAMPLE(a));
2157             break;
2158         }
2159     }
2160
2161 out:
2162     if (ctx->rule) {
2163         ctx->rule->up.evictable = was_evictable;
2164     }
2165 }
2166
2167 void
2168 xlate_in_init(struct xlate_in *xin, struct ofproto_dpif *ofproto,
2169               const struct flow *flow, struct rule_dpif *rule,
2170               uint8_t tcp_flags, const struct ofpbuf *packet)
2171 {
2172     xin->ofproto = ofproto;
2173     xin->flow = *flow;
2174     xin->packet = packet;
2175     xin->may_learn = packet != NULL;
2176     xin->rule = rule;
2177     xin->ofpacts = NULL;
2178     xin->ofpacts_len = 0;
2179     xin->tcp_flags = tcp_flags;
2180     xin->resubmit_hook = NULL;
2181     xin->report_hook = NULL;
2182     xin->resubmit_stats = NULL;
2183 }
2184
2185 void
2186 xlate_out_uninit(struct xlate_out *xout)
2187 {
2188     if (xout) {
2189         ofpbuf_uninit(&xout->odp_actions);
2190     }
2191 }
2192
2193 /* Translates the 'ofpacts_len' bytes of "struct ofpact"s starting at 'ofpacts'
2194  * into datapath actions, using 'ctx', and discards the datapath actions. */
2195 void
2196 xlate_actions_for_side_effects(struct xlate_in *xin)
2197 {
2198     struct xlate_out xout;
2199
2200     xlate_actions(xin, &xout);
2201     xlate_out_uninit(&xout);
2202 }
2203
2204 static void
2205 xlate_report(struct xlate_ctx *ctx, const char *s)
2206 {
2207     if (ctx->xin->report_hook) {
2208         ctx->xin->report_hook(ctx->xin, s, ctx->recurse);
2209     }
2210 }
2211
2212 void
2213 xlate_out_copy(struct xlate_out *dst, const struct xlate_out *src)
2214 {
2215     dst->wc = src->wc;
2216     dst->tags = src->tags;
2217     dst->slow = src->slow;
2218     dst->has_learn = src->has_learn;
2219     dst->has_normal = src->has_normal;
2220     dst->has_fin_timeout = src->has_fin_timeout;
2221     dst->nf_output_iface = src->nf_output_iface;
2222     dst->mirrors = src->mirrors;
2223
2224     ofpbuf_use_stub(&dst->odp_actions, dst->odp_actions_stub,
2225                     sizeof dst->odp_actions_stub);
2226     ofpbuf_put(&dst->odp_actions, src->odp_actions.data,
2227                src->odp_actions.size);
2228 }
2229 \f
2230 static bool
2231 actions_output_to_local_port(const struct xlate_ctx *ctx)
2232 {
2233     odp_port_t local_odp_port = ofp_port_to_odp_port(ctx->xbridge, OFPP_LOCAL);
2234     const struct nlattr *a;
2235     unsigned int left;
2236
2237     NL_ATTR_FOR_EACH_UNSAFE (a, left, ctx->xout->odp_actions.data,
2238                              ctx->xout->odp_actions.size) {
2239         if (nl_attr_type(a) == OVS_ACTION_ATTR_OUTPUT
2240             && nl_attr_get_odp_port(a) == local_odp_port) {
2241             return true;
2242         }
2243     }
2244     return false;
2245 }
2246
2247 /* Translates the 'ofpacts_len' bytes of "struct ofpacts" starting at 'ofpacts'
2248  * into datapath actions in 'odp_actions', using 'ctx'. */
2249 void
2250 xlate_actions(struct xlate_in *xin, struct xlate_out *xout)
2251 {
2252     /* Normally false.  Set to true if we ever hit MAX_RESUBMIT_RECURSION, so
2253      * that in the future we always keep a copy of the original flow for
2254      * tracing purposes. */
2255     static bool hit_resubmit_limit;
2256
2257     struct flow_wildcards *wc = &xout->wc;
2258     struct flow *flow = &xin->flow;
2259
2260     enum slow_path_reason special;
2261     const struct ofpact *ofpacts;
2262     struct xport *in_port;
2263     struct flow orig_flow;
2264     struct xlate_ctx ctx;
2265     size_t ofpacts_len;
2266
2267     COVERAGE_INC(xlate_actions);
2268
2269     /* Flow initialization rules:
2270      * - 'base_flow' must match the kernel's view of the packet at the
2271      *   time that action processing starts.  'flow' represents any
2272      *   transformations we wish to make through actions.
2273      * - By default 'base_flow' and 'flow' are the same since the input
2274      *   packet matches the output before any actions are applied.
2275      * - When using VLAN splinters, 'base_flow''s VLAN is set to the value
2276      *   of the received packet as seen by the kernel.  If we later output
2277      *   to another device without any modifications this will cause us to
2278      *   insert a new tag since the original one was stripped off by the
2279      *   VLAN device.
2280      * - Tunnel metadata as received is retained in 'flow'. This allows
2281      *   tunnel metadata matching also in later tables.
2282      *   Since a kernel action for setting the tunnel metadata will only be
2283      *   generated with actual tunnel output, changing the tunnel metadata
2284      *   values in 'flow' (such as tun_id) will only have effect with a later
2285      *   tunnel output action.
2286      * - Tunnel 'base_flow' is completely cleared since that is what the
2287      *   kernel does.  If we wish to maintain the original values an action
2288      *   needs to be generated. */
2289
2290     ctx.xin = xin;
2291     ctx.xout = xout;
2292     ctx.xout->tags = 0;
2293     ctx.xout->slow = 0;
2294     ctx.xout->has_learn = false;
2295     ctx.xout->has_normal = false;
2296     ctx.xout->has_fin_timeout = false;
2297     ctx.xout->nf_output_iface = NF_OUT_DROP;
2298     ctx.xout->mirrors = 0;
2299     ofpbuf_use_stub(&ctx.xout->odp_actions, ctx.xout->odp_actions_stub,
2300                     sizeof ctx.xout->odp_actions_stub);
2301     ofpbuf_reserve(&ctx.xout->odp_actions, NL_A_U32_SIZE);
2302
2303     ctx.xbridge = xbridge_lookup(xin->ofproto);
2304     if (!ctx.xbridge) {
2305         return;
2306     }
2307
2308     ctx.rule = xin->rule;
2309
2310     ctx.base_flow = *flow;
2311     memset(&ctx.base_flow.tunnel, 0, sizeof ctx.base_flow.tunnel);
2312     ctx.orig_tunnel_ip_dst = flow->tunnel.ip_dst;
2313
2314     flow_wildcards_init_catchall(wc);
2315     memset(&wc->masks.in_port, 0xff, sizeof wc->masks.in_port);
2316     memset(&wc->masks.skb_priority, 0xff, sizeof wc->masks.skb_priority);
2317     memset(&wc->masks.dl_type, 0xff, sizeof wc->masks.dl_type);
2318     wc->masks.nw_frag |= FLOW_NW_FRAG_MASK;
2319
2320     if (tnl_port_should_receive(&ctx.xin->flow)) {
2321         memset(&wc->masks.tunnel, 0xff, sizeof wc->masks.tunnel);
2322     }
2323     if (ctx.xbridge->has_netflow) {
2324         netflow_mask_wc(flow, wc);
2325     }
2326
2327     ctx.recurse = 0;
2328     ctx.max_resubmit_trigger = false;
2329     ctx.orig_skb_priority = flow->skb_priority;
2330     ctx.table_id = 0;
2331     ctx.exit = false;
2332
2333     if (xin->ofpacts) {
2334         ofpacts = xin->ofpacts;
2335         ofpacts_len = xin->ofpacts_len;
2336     } else if (xin->rule) {
2337         ofpacts = xin->rule->up.ofpacts;
2338         ofpacts_len = xin->rule->up.ofpacts_len;
2339     } else {
2340         NOT_REACHED();
2341     }
2342
2343     ofpbuf_use_stub(&ctx.stack, ctx.init_stack, sizeof ctx.init_stack);
2344
2345     if (mbridge_has_mirrors(ctx.xbridge->mbridge) || hit_resubmit_limit) {
2346         /* Do this conditionally because the copy is expensive enough that it
2347          * shows up in profiles. */
2348         orig_flow = *flow;
2349     }
2350
2351     if (flow->nw_frag & FLOW_NW_FRAG_ANY) {
2352         switch (ctx.xbridge->frag) {
2353         case OFPC_FRAG_NORMAL:
2354             /* We must pretend that transport ports are unavailable. */
2355             flow->tp_src = ctx.base_flow.tp_src = htons(0);
2356             flow->tp_dst = ctx.base_flow.tp_dst = htons(0);
2357             break;
2358
2359         case OFPC_FRAG_DROP:
2360             return;
2361
2362         case OFPC_FRAG_REASM:
2363             NOT_REACHED();
2364
2365         case OFPC_FRAG_NX_MATCH:
2366             /* Nothing to do. */
2367             break;
2368
2369         case OFPC_INVALID_TTL_TO_CONTROLLER:
2370             NOT_REACHED();
2371         }
2372     }
2373
2374     in_port = get_ofp_port(ctx.xbridge, flow->in_port.ofp_port);
2375     special = process_special(&ctx, flow, in_port, ctx.xin->packet);
2376     if (special) {
2377         ctx.xout->slow = special;
2378     } else {
2379         static struct vlog_rate_limit trace_rl = VLOG_RATE_LIMIT_INIT(1, 1);
2380         size_t sample_actions_len;
2381
2382         if (flow->in_port.ofp_port
2383             != vsp_realdev_to_vlandev(ctx.xbridge->ofproto,
2384                                       flow->in_port.ofp_port,
2385                                       flow->vlan_tci)) {
2386             ctx.base_flow.vlan_tci = 0;
2387         }
2388
2389         add_sflow_action(&ctx);
2390         add_ipfix_action(&ctx);
2391         sample_actions_len = ctx.xout->odp_actions.size;
2392
2393         if (tunnel_ecn_ok(&ctx) && (!in_port || may_receive(in_port, &ctx))) {
2394             do_xlate_actions(ofpacts, ofpacts_len, &ctx);
2395
2396             /* We've let OFPP_NORMAL and the learning action look at the
2397              * packet, so drop it now if forwarding is disabled. */
2398             if (in_port && !stp_forward_in_state(in_port->stp_state)) {
2399                 ctx.xout->odp_actions.size = sample_actions_len;
2400             }
2401         }
2402
2403         if (ctx.max_resubmit_trigger && !ctx.xin->resubmit_hook) {
2404             if (!hit_resubmit_limit) {
2405                 /* We didn't record the original flow.  Make sure we do from
2406                  * now on. */
2407                 hit_resubmit_limit = true;
2408             } else if (!VLOG_DROP_ERR(&trace_rl)) {
2409                 struct ds ds = DS_EMPTY_INITIALIZER;
2410
2411                 ofproto_trace(ctx.xbridge->ofproto, &orig_flow,
2412                               ctx.xin->packet, &ds);
2413                 VLOG_ERR("Trace triggered by excessive resubmit "
2414                          "recursion:\n%s", ds_cstr(&ds));
2415                 ds_destroy(&ds);
2416             }
2417         }
2418
2419         if (ctx.xbridge->has_in_band
2420             && in_band_must_output_to_local_port(flow)
2421             && !actions_output_to_local_port(&ctx)) {
2422             compose_output_action(&ctx, OFPP_LOCAL);
2423         }
2424
2425         fix_sflow_action(&ctx);
2426
2427         if (mbridge_has_mirrors(ctx.xbridge->mbridge)) {
2428             add_mirror_actions(&ctx, &orig_flow);
2429         }
2430     }
2431
2432     ofpbuf_uninit(&ctx.stack);
2433
2434     /* Clear the metadata and register wildcard masks, because we won't
2435      * use non-header fields as part of the cache. */
2436     memset(&wc->masks.metadata, 0, sizeof wc->masks.metadata);
2437     memset(&wc->masks.regs, 0, sizeof wc->masks.regs);
2438 }