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