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