ofproto/ofproto-dpif.c

   1 /*
   2  * Copyright (c) 2009, 2010, 2011, 2012 Nicira Networks.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #include <config.h>
  18
  19 #include "ofproto/ofproto-provider.h"
  20
  21 #include <errno.h>
  22
  23 #include "autopath.h"
  24 #include "bond.h"
  25 #include "bundle.h"
  26 #include "byte-order.h"
  27 #include "connmgr.h"
  28 #include "coverage.h"
  29 #include "cfm.h"
  30 #include "dpif.h"
  31 #include "dynamic-string.h"
  32 #include "fail-open.h"
  33 #include "hmapx.h"
  34 #include "lacp.h"
  35 #include "learn.h"
  36 #include "mac-learning.h"
  37 #include "multipath.h"
  38 #include "netdev.h"
  39 #include "netlink.h"
  40 #include "nx-match.h"
  41 #include "odp-util.h"
  42 #include "ofp-util.h"
  43 #include "ofpbuf.h"
  44 #include "ofp-print.h"
  45 #include "ofproto-dpif-sflow.h"
  46 #include "poll-loop.h"
  47 #include "timer.h"
  48 #include "unaligned.h"
  49 #include "unixctl.h"
  50 #include "vlan-bitmap.h"
  51 #include "vlog.h"
  52
  53 VLOG_DEFINE_THIS_MODULE(ofproto_dpif);
  54
  55 COVERAGE_DEFINE(ofproto_dpif_ctlr_action);
  56 COVERAGE_DEFINE(ofproto_dpif_expired);
  57 COVERAGE_DEFINE(ofproto_dpif_no_packet_in);
  58 COVERAGE_DEFINE(ofproto_dpif_xlate);
  59 COVERAGE_DEFINE(facet_changed_rule);
  60 COVERAGE_DEFINE(facet_invalidated);
  61 COVERAGE_DEFINE(facet_revalidate);
  62 COVERAGE_DEFINE(facet_unexpected);
  63
  64 /* Maximum depth of flow table recursion (due to resubmit actions) in a
  65  * flow translation. */
  66 #define MAX_RESUBMIT_RECURSION 32
  67
  68 /* Number of implemented OpenFlow tables. */
  69 enum { N_TABLES = 255 };
  70 BUILD_ASSERT_DECL(N_TABLES >= 1 && N_TABLES <= 255);
  71
  72 struct ofport_dpif;
  73 struct ofproto_dpif;
  74
  75 struct rule_dpif {
  76     struct rule up;
  77
  78     long long int used;         /* Time last used; time created if not used. */
  79
  80     /* These statistics:
  81      *
  82      *   - Do include packets and bytes from facets that have been deleted or
  83      *     whose own statistics have been folded into the rule.
  84      *
  85      *   - Do include packets and bytes sent "by hand" that were accounted to
  86      *     the rule without any facet being involved (this is a rare corner
  87      *     case in rule_execute()).
  88      *
  89      *   - Do not include packet or bytes that can be obtained from any facet's
  90      *     packet_count or byte_count member or that can be obtained from the
  91      *     datapath by, e.g., dpif_flow_get() for any subfacet.
  92      */
  93     uint64_t packet_count;       /* Number of packets received. */
  94     uint64_t byte_count;         /* Number of bytes received. */
  95
  96     tag_type tag;                /* Caches rule_calculate_tag() result. */
  97
  98     struct list facets;          /* List of "struct facet"s. */
  99 };
 100
 101 static struct rule_dpif *rule_dpif_cast(const struct rule *rule)
 102 {
 103     return rule ? CONTAINER_OF(rule, struct rule_dpif, up) : NULL;
 104 }
 105
 106 static struct rule_dpif *rule_dpif_lookup(struct ofproto_dpif *,
 107                                           const struct flow *, uint8_t table);
 108
 109 static void flow_push_stats(const struct rule_dpif *, const struct flow *,
 110                             uint64_t packets, uint64_t bytes,
 111                             long long int used);
 112
 113 static uint32_t rule_calculate_tag(const struct flow *,
 114                                    const struct flow_wildcards *,
 115                                    uint32_t basis);
 116 static void rule_invalidate(const struct rule_dpif *);
 117
 118 #define MAX_MIRRORS 32
 119 typedef uint32_t mirror_mask_t;
 120 #define MIRROR_MASK_C(X) UINT32_C(X)
 121 BUILD_ASSERT_DECL(sizeof(mirror_mask_t) * CHAR_BIT >= MAX_MIRRORS);
 122 struct ofmirror {
 123     struct ofproto_dpif *ofproto; /* Owning ofproto. */
 124     size_t idx;                 /* In ofproto's "mirrors" array. */
 125     void *aux;                  /* Key supplied by ofproto's client. */
 126     char *name;                 /* Identifier for log messages. */
 127
 128     /* Selection criteria. */
 129     struct hmapx srcs;          /* Contains "struct ofbundle *"s. */
 130     struct hmapx dsts;          /* Contains "struct ofbundle *"s. */
 131     unsigned long *vlans;       /* Bitmap of chosen VLANs, NULL selects all. */
 132
 133     /* Output (exactly one of out == NULL and out_vlan == -1 is true). */
 134     struct ofbundle *out;       /* Output port or NULL. */
 135     int out_vlan;               /* Output VLAN or -1. */
 136     mirror_mask_t dup_mirrors;  /* Bitmap of mirrors with the same output. */
 137
 138     /* Counters. */
 139     int64_t packet_count;       /* Number of packets sent. */
 140     int64_t byte_count;         /* Number of bytes sent. */
 141 };
 142
 143 static void mirror_destroy(struct ofmirror *);
 144 static void update_mirror_stats(struct ofproto_dpif *ofproto,
 145                                 mirror_mask_t mirrors,
 146                                 uint64_t packets, uint64_t bytes);
 147
 148 struct ofbundle {
 149     struct ofproto_dpif *ofproto; /* Owning ofproto. */
 150     struct hmap_node hmap_node; /* In struct ofproto's "bundles" hmap. */
 151     void *aux;                  /* Key supplied by ofproto's client. */
 152     char *name;                 /* Identifier for log messages. */
 153
 154     /* Configuration. */
 155     struct list ports;          /* Contains "struct ofport"s. */
 156     enum port_vlan_mode vlan_mode; /* VLAN mode */
 157     int vlan;                   /* -1=trunk port, else a 12-bit VLAN ID. */
 158     unsigned long *trunks;      /* Bitmap of trunked VLANs, if 'vlan' == -1.
 159                                  * NULL if all VLANs are trunked. */
 160     struct lacp *lacp;          /* LACP if LACP is enabled, otherwise NULL. */
 161     struct bond *bond;          /* Nonnull iff more than one port. */
 162     bool use_priority_tags;     /* Use 802.1p tag for frames in VLAN 0? */
 163
 164     /* Status. */
 165     bool floodable;             /* True if no port has OFPPC_NO_FLOOD set. */
 166
 167     /* Port mirroring info. */
 168     mirror_mask_t src_mirrors;  /* Mirrors triggered when packet received. */
 169     mirror_mask_t dst_mirrors;  /* Mirrors triggered when packet sent. */
 170     mirror_mask_t mirror_out;   /* Mirrors that output to this bundle. */
 171 };
 172
 173 static void bundle_remove(struct ofport *);
 174 static void bundle_update(struct ofbundle *);
 175 static void bundle_destroy(struct ofbundle *);
 176 static void bundle_del_port(struct ofport_dpif *);
 177 static void bundle_run(struct ofbundle *);
 178 static void bundle_wait(struct ofbundle *);
 179 static struct ofbundle *lookup_input_bundle(struct ofproto_dpif *,
 180                                             uint16_t in_port, bool warn);
 181
 182 /* A controller may use OFPP_NONE as the ingress port to indicate that
 183  * it did not arrive on a "real" port.  'ofpp_none_bundle' exists for
 184  * when an input bundle is needed for validation (e.g., mirroring or
 185  * OFPP_NORMAL processing).  It is not connected to an 'ofproto' or have
 186  * any 'port' structs, so care must be taken when dealing with it. */
 187 static struct ofbundle ofpp_none_bundle = {
 188     .name      = "OFPP_NONE",
 189     .vlan_mode = PORT_VLAN_TRUNK
 190 };
 191
 192 static void stp_run(struct ofproto_dpif *ofproto);
 193 static void stp_wait(struct ofproto_dpif *ofproto);
 194
 195 static bool ofbundle_includes_vlan(const struct ofbundle *, uint16_t vlan);
 196
 197 struct action_xlate_ctx {
 198 /* action_xlate_ctx_init() initializes these members. */
 199
 200     /* The ofproto. */
 201     struct ofproto_dpif *ofproto;
 202
 203     /* Flow to which the OpenFlow actions apply.  xlate_actions() will modify
 204      * this flow when actions change header fields. */
 205     struct flow flow;
 206
 207     /* The packet corresponding to 'flow', or a null pointer if we are
 208      * revalidating without a packet to refer to. */
 209     const struct ofpbuf *packet;
 210
 211     /* Should OFPP_NORMAL MAC learning and NXAST_LEARN actions execute?  We
 212      * want to execute them if we are actually processing a packet, or if we
 213      * are accounting for packets that the datapath has processed, but not if
 214      * we are just revalidating. */
 215     bool may_learn;
 216
 217     /* Cookie of the currently matching rule, or 0. */
 218     ovs_be64 cookie;
 219
 220     /* If nonnull, called just before executing a resubmit action.
 221      *
 222      * This is normally null so the client has to set it manually after
 223      * calling action_xlate_ctx_init(). */
 224     void (*resubmit_hook)(struct action_xlate_ctx *, struct rule_dpif *);
 225
 226 /* xlate_actions() initializes and uses these members.  The client might want
 227  * to look at them after it returns. */
 228
 229     struct ofpbuf *odp_actions; /* Datapath actions. */
 230     tag_type tags;              /* Tags associated with actions. */
 231     bool may_set_up_flow;       /* True ordinarily; false if the actions must
 232                                  * be reassessed for every packet. */
 233     bool has_learn;             /* Actions include NXAST_LEARN? */
 234     bool has_normal;            /* Actions output to OFPP_NORMAL? */
 235     uint16_t nf_output_iface;   /* Output interface index for NetFlow. */
 236     mirror_mask_t mirrors;      /* Bitmap of associated mirrors. */
 237
 238 /* xlate_actions() initializes and uses these members, but the client has no
 239  * reason to look at them. */
 240
 241     int recurse;                /* Recursion level, via xlate_table_action. */
 242     struct flow base_flow;      /* Flow at the last commit. */
 243     uint32_t orig_skb_priority; /* Priority when packet arrived. */
 244     uint8_t table_id;           /* OpenFlow table ID where flow was found. */
 245     uint32_t sflow_n_outputs;   /* Number of output ports. */
 246     uint16_t sflow_odp_port;    /* Output port for composing sFlow action. */
 247     uint16_t user_cookie_offset;/* Used for user_action_cookie fixup. */
 248     bool exit;                  /* No further actions should be processed. */
 249 };
 250
 251 static void action_xlate_ctx_init(struct action_xlate_ctx *,
 252                                   struct ofproto_dpif *, const struct flow *,
 253                                   ovs_be16 initial_tci, ovs_be64 cookie,
 254                                   const struct ofpbuf *);
 255 static struct ofpbuf *xlate_actions(struct action_xlate_ctx *,
 256                                     const union ofp_action *in, size_t n_in);
 257
 258 /* An exact-match instantiation of an OpenFlow flow.
 259  *
 260  * A facet associates a "struct flow", which represents the Open vSwitch
 261  * userspace idea of an exact-match flow, with one or more subfacets.  Each
 262  * subfacet tracks the datapath's idea of the exact-match flow equivalent to
 263  * the facet.  When the kernel module (or other dpif implementation) and Open
 264  * vSwitch userspace agree on the definition of a flow key, there is exactly
 265  * one subfacet per facet.  If the dpif implementation supports more-specific
 266  * flow matching than userspace, however, a facet can have more than one
 267  * subfacet, each of which corresponds to some distinction in flow that
 268  * userspace simply doesn't understand.
 269  *
 270  * Flow expiration works in terms of subfacets, so a facet must have at least
 271  * one subfacet or it will never expire, leaking memory. */
 272 struct facet {
 273     /* Owners. */
 274     struct hmap_node hmap_node;  /* In owning ofproto's 'facets' hmap. */
 275     struct list list_node;       /* In owning rule's 'facets' list. */
 276     struct rule_dpif *rule;      /* Owning rule. */
 277
 278     /* Owned data. */
 279     struct list subfacets;
 280     long long int used;         /* Time last used; time created if not used. */
 281
 282     /* Key. */
 283     struct flow flow;
 284
 285     /* These statistics:
 286      *
 287      *   - Do include packets and bytes sent "by hand", e.g. with
 288      *     dpif_execute().
 289      *
 290      *   - Do include packets and bytes that were obtained from the datapath
 291      *     when a subfacet's statistics were reset (e.g. dpif_flow_put() with
 292      *     DPIF_FP_ZERO_STATS).
 293      *
 294      *   - Do not include packets or bytes that can be obtained from the
 295      *     datapath for any existing subfacet.
 296      */
 297     uint64_t packet_count;       /* Number of packets received. */
 298     uint64_t byte_count;         /* Number of bytes received. */
 299
 300     /* Resubmit statistics. */
 301     uint64_t prev_packet_count;  /* Number of packets from last stats push. */
 302     uint64_t prev_byte_count;    /* Number of bytes from last stats push. */
 303     long long int prev_used;     /* Used time from last stats push. */
 304
 305     /* Accounting. */
 306     uint64_t accounted_bytes;    /* Bytes processed by facet_account(). */
 307     struct netflow_flow nf_flow; /* Per-flow NetFlow tracking data. */
 308
 309     /* Properties of datapath actions.
 310      *
 311      * Every subfacet has its own actions because actions can differ slightly
 312      * between splintered and non-splintered subfacets due to the VLAN tag
 313      * being initially different (present vs. absent).  All of them have these
 314      * properties in common so we just store one copy of them here. */
 315     bool may_install;            /* Reassess actions for every packet? */
 316     bool has_learn;              /* Actions include NXAST_LEARN? */
 317     bool has_normal;             /* Actions output to OFPP_NORMAL? */
 318     tag_type tags;               /* Tags that would require revalidation. */
 319     mirror_mask_t mirrors;       /* Bitmap of dependent mirrors. */
 320 };
 321
 322 static struct facet *facet_create(struct rule_dpif *, const struct flow *);
 323 static void facet_remove(struct ofproto_dpif *, struct facet *);
 324 static void facet_free(struct facet *);
 325
 326 static struct facet *facet_find(struct ofproto_dpif *, const struct flow *);
 327 static struct facet *facet_lookup_valid(struct ofproto_dpif *,
 328                                         const struct flow *);
 329 static bool facet_revalidate(struct ofproto_dpif *, struct facet *);
 330
 331 static void facet_flush_stats(struct ofproto_dpif *, struct facet *);
 332
 333 static void facet_update_time(struct ofproto_dpif *, struct facet *,
 334                               long long int used);
 335 static void facet_reset_counters(struct facet *);
 336 static void facet_push_stats(struct facet *);
 337 static void facet_account(struct ofproto_dpif *, struct facet *);
 338
 339 static bool facet_is_controller_flow(struct facet *);
 340
 341 /* A dpif flow and actions associated with a facet.
 342  *
 343  * See also the large comment on struct facet. */
 344 struct subfacet {
 345     /* Owners. */
 346     struct hmap_node hmap_node; /* In struct ofproto_dpif 'subfacets' list. */
 347     struct list list_node;      /* In struct facet's 'facets' list. */
 348     struct facet *facet;        /* Owning facet. */
 349
 350     /* Key.
 351      *
 352      * To save memory in the common case, 'key' is NULL if 'key_fitness' is
 353      * ODP_FIT_PERFECT, that is, odp_flow_key_from_flow() can accurately
 354      * regenerate the ODP flow key from ->facet->flow. */
 355     enum odp_key_fitness key_fitness;
 356     struct nlattr *key;
 357     int key_len;
 358
 359     long long int used;         /* Time last used; time created if not used. */
 360
 361     uint64_t dp_packet_count;   /* Last known packet count in the datapath. */
 362     uint64_t dp_byte_count;     /* Last known byte count in the datapath. */
 363
 364     /* Datapath actions.
 365      *
 366      * These should be essentially identical for every subfacet in a facet, but
 367      * may differ in trivial ways due to VLAN splinters. */
 368     size_t actions_len;         /* Number of bytes in actions[]. */
 369     struct nlattr *actions;     /* Datapath actions. */
 370
 371     bool installed;             /* Installed in datapath? */
 372
 373     /* This value is normally the same as ->facet->flow.vlan_tci.  Only VLAN
 374      * splinters can cause it to differ.  This value should be removed when
 375      * the VLAN splinters feature is no longer needed.  */
 376     ovs_be16 initial_tci;       /* Initial VLAN TCI value. */
 377 };
 378
 379 static struct subfacet *subfacet_create(struct ofproto_dpif *, struct facet *,
 380                                         enum odp_key_fitness,
 381                                         const struct nlattr *key,
 382                                         size_t key_len, ovs_be16 initial_tci);
 383 static struct subfacet *subfacet_find(struct ofproto_dpif *,
 384                                       const struct nlattr *key, size_t key_len);
 385 static void subfacet_destroy(struct ofproto_dpif *, struct subfacet *);
 386 static void subfacet_destroy__(struct ofproto_dpif *, struct subfacet *);
 387 static void subfacet_reset_dp_stats(struct subfacet *,
 388                                     struct dpif_flow_stats *);
 389 static void subfacet_update_time(struct ofproto_dpif *, struct subfacet *,
 390                                  long long int used);
 391 static void subfacet_update_stats(struct ofproto_dpif *, struct subfacet *,
 392                                   const struct dpif_flow_stats *);
 393 static void subfacet_make_actions(struct ofproto_dpif *, struct subfacet *,
 394                                   const struct ofpbuf *packet);
 395 static int subfacet_install(struct ofproto_dpif *, struct subfacet *,
 396                             const struct nlattr *actions, size_t actions_len,
 397                             struct dpif_flow_stats *);
 398 static void subfacet_uninstall(struct ofproto_dpif *, struct subfacet *);
 399
 400 struct ofport_dpif {
 401     struct ofport up;
 402
 403     uint32_t odp_port;
 404     struct ofbundle *bundle;    /* Bundle that contains this port, if any. */
 405     struct list bundle_node;    /* In struct ofbundle's "ports" list. */
 406     struct cfm *cfm;            /* Connectivity Fault Management, if any. */
 407     tag_type tag;               /* Tag associated with this port. */
 408     uint32_t bond_stable_id;    /* stable_id to use as bond slave, or 0. */
 409     bool may_enable;            /* May be enabled in bonds. */
 410
 411     /* Spanning tree. */
 412     struct stp_port *stp_port;  /* Spanning Tree Protocol, if any. */
 413     enum stp_state stp_state;   /* Always STP_DISABLED if STP not in use. */
 414     long long int stp_state_entered;
 415
 416     struct hmap priorities;     /* Map of attached 'priority_to_dscp's. */
 417
 418     /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
 419      *
 420      * This is deprecated.  It is only for compatibility with broken device
 421      * drivers in old versions of Linux that do not properly support VLANs when
 422      * VLAN devices are not used.  When broken device drivers are no longer in
 423      * widespread use, we will delete these interfaces. */
 424     uint16_t realdev_ofp_port;
 425     int vlandev_vid;
 426 };
 427
 428 /* Node in 'ofport_dpif''s 'priorities' map.  Used to maintain a map from
 429  * 'priority' (the datapath's term for QoS queue) to the dscp bits which all
 430  * traffic egressing the 'ofport' with that priority should be marked with. */
 431 struct priority_to_dscp {
 432     struct hmap_node hmap_node; /* Node in 'ofport_dpif''s 'priorities' map. */
 433     uint32_t priority;          /* Priority of this queue (see struct flow). */
 434
 435     uint8_t dscp;               /* DSCP bits to mark outgoing traffic with. */
 436 };
 437
 438 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
 439  *
 440  * This is deprecated.  It is only for compatibility with broken device drivers
 441  * in old versions of Linux that do not properly support VLANs when VLAN
 442  * devices are not used.  When broken device drivers are no longer in
 443  * widespread use, we will delete these interfaces. */
 444 struct vlan_splinter {
 445     struct hmap_node realdev_vid_node;
 446     struct hmap_node vlandev_node;
 447     uint16_t realdev_ofp_port;
 448     uint16_t vlandev_ofp_port;
 449     int vid;
 450 };
 451
 452 static uint32_t vsp_realdev_to_vlandev(const struct ofproto_dpif *,
 453                                        uint32_t realdev, ovs_be16 vlan_tci);
 454 static uint16_t vsp_vlandev_to_realdev(const struct ofproto_dpif *,
 455                                        uint16_t vlandev, int *vid);
 456 static void vsp_remove(struct ofport_dpif *);
 457 static void vsp_add(struct ofport_dpif *, uint16_t realdev_ofp_port, int vid);
 458
 459 static struct ofport_dpif *
 460 ofport_dpif_cast(const struct ofport *ofport)
 461 {
 462     assert(ofport->ofproto->ofproto_class == &ofproto_dpif_class);
 463     return ofport ? CONTAINER_OF(ofport, struct ofport_dpif, up) : NULL;
 464 }
 465
 466 static void port_run(struct ofport_dpif *);
 467 static void port_wait(struct ofport_dpif *);
 468 static int set_cfm(struct ofport *, const struct cfm_settings *);
 469 static void ofport_clear_priorities(struct ofport_dpif *);
 470
 471 struct dpif_completion {
 472     struct list list_node;
 473     struct ofoperation *op;
 474 };
 475
 476 /* Extra information about a classifier table.
 477  * Currently used just for optimized flow revalidation. */
 478 struct table_dpif {
 479     /* If either of these is nonnull, then this table has a form that allows
 480      * flows to be tagged to avoid revalidating most flows for the most common
 481      * kinds of flow table changes. */
 482     struct cls_table *catchall_table; /* Table that wildcards all fields. */
 483     struct cls_table *other_table;    /* Table with any other wildcard set. */
 484     uint32_t basis;                   /* Keeps each table's tags separate. */
 485 };
 486
 487 struct ofproto_dpif {
 488     struct hmap_node all_ofproto_dpifs_node; /* In 'all_ofproto_dpifs'. */
 489     struct ofproto up;
 490     struct dpif *dpif;
 491     int max_ports;
 492
 493     /* Statistics. */
 494     uint64_t n_matches;
 495
 496     /* Bridging. */
 497     struct netflow *netflow;
 498     struct dpif_sflow *sflow;
 499     struct hmap bundles;        /* Contains "struct ofbundle"s. */
 500     struct mac_learning *ml;
 501     struct ofmirror *mirrors[MAX_MIRRORS];
 502     bool has_bonded_bundles;
 503
 504     /* Expiration. */
 505     struct timer next_expiration;
 506
 507     /* Facets. */
 508     struct hmap facets;
 509     struct hmap subfacets;
 510
 511     /* Revalidation. */
 512     struct table_dpif tables[N_TABLES];
 513     bool need_revalidate;
 514     struct tag_set revalidate_set;
 515
 516     /* Support for debugging async flow mods. */
 517     struct list completions;
 518
 519     bool has_bundle_action; /* True when the first bundle action appears. */
 520     struct netdev_stats stats; /* To account packets generated and consumed in
 521                                 * userspace. */
 522
 523     /* Spanning tree. */
 524     struct stp *stp;
 525     long long int stp_last_tick;
 526
 527     /* VLAN splinters. */
 528     struct hmap realdev_vid_map; /* (realdev,vid) -> vlandev. */
 529     struct hmap vlandev_map;     /* vlandev -> (realdev,vid). */
 530 };
 531
 532 /* Defer flow mod completion until "ovs-appctl ofproto/unclog"?  (Useful only
 533  * for debugging the asynchronous flow_mod implementation.) */
 534 static bool clogged;
 535
 536 /* All existing ofproto_dpif instances, indexed by ->up.name. */
 537 static struct hmap all_ofproto_dpifs = HMAP_INITIALIZER(&all_ofproto_dpifs);
 538
 539 static void ofproto_dpif_unixctl_init(void);
 540
 541 static struct ofproto_dpif *
 542 ofproto_dpif_cast(const struct ofproto *ofproto)
 543 {
 544     assert(ofproto->ofproto_class == &ofproto_dpif_class);
 545     return CONTAINER_OF(ofproto, struct ofproto_dpif, up);
 546 }
 547
 548 static struct ofport_dpif *get_ofp_port(struct ofproto_dpif *,
 549                                         uint16_t ofp_port);
 550 static struct ofport_dpif *get_odp_port(struct ofproto_dpif *,
 551                                         uint32_t odp_port);
 552
 553 /* Packet processing. */
 554 static void update_learning_table(struct ofproto_dpif *,
 555                                   const struct flow *, int vlan,
 556                                   struct ofbundle *);
 557 /* Upcalls. */
 558 #define FLOW_MISS_MAX_BATCH 50
 559 static int handle_upcalls(struct ofproto_dpif *, unsigned int max_batch);
 560
 561 /* Flow expiration. */
 562 static int expire(struct ofproto_dpif *);
 563
 564 /* NetFlow. */
 565 static void send_netflow_active_timeouts(struct ofproto_dpif *);
 566
 567 /* Utilities. */
 568 static int send_packet(const struct ofport_dpif *, struct ofpbuf *packet);
 569 static size_t
 570 compose_sflow_action(const struct ofproto_dpif *, struct ofpbuf *odp_actions,
 571                      const struct flow *, uint32_t odp_port);
 572 static void add_mirror_actions(struct action_xlate_ctx *ctx,
 573                                const struct flow *flow);
 574 /* Global variables. */
 575 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
 576 \f
 577 /* Factory functions. */
 578
 579 static void
 580 enumerate_types(struct sset *types)
 581 {
 582     dp_enumerate_types(types);
 583 }
 584
 585 static int
 586 enumerate_names(const char *type, struct sset *names)
 587 {
 588     return dp_enumerate_names(type, names);
 589 }
 590
 591 static int
 592 del(const char *type, const char *name)
 593 {
 594     struct dpif *dpif;
 595     int error;
 596
 597     error = dpif_open(name, type, &dpif);
 598     if (!error) {
 599         error = dpif_delete(dpif);
 600         dpif_close(dpif);
 601     }
 602     return error;
 603 }
 604 \f
 605 /* Basic life-cycle. */
 606
 607 static struct ofproto *
 608 alloc(void)
 609 {
 610     struct ofproto_dpif *ofproto = xmalloc(sizeof *ofproto);
 611     return &ofproto->up;
 612 }
 613
 614 static void
 615 dealloc(struct ofproto *ofproto_)
 616 {
 617     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
 618     free(ofproto);
 619 }
 620
 621 static int
 622 construct(struct ofproto *ofproto_, int *n_tablesp)
 623 {
 624     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
 625     const char *name = ofproto->up.name;
 626     int error;
 627     int i;
 628
 629     error = dpif_create_and_open(name, ofproto->up.type, &ofproto->dpif);
 630     if (error) {
 631         VLOG_ERR("failed to open datapath %s: %s", name, strerror(error));
 632         return error;
 633     }
 634
 635     ofproto->max_ports = dpif_get_max_ports(ofproto->dpif);
 636     ofproto->n_matches = 0;
 637
 638     dpif_flow_flush(ofproto->dpif);
 639     dpif_recv_purge(ofproto->dpif);
 640
 641     error = dpif_recv_set(ofproto->dpif, true);
 642     if (error) {
 643         VLOG_ERR("failed to listen on datapath %s: %s", name, strerror(error));
 644         dpif_close(ofproto->dpif);
 645         return error;
 646     }
 647
 648     ofproto->netflow = NULL;
 649     ofproto->sflow = NULL;
 650     ofproto->stp = NULL;
 651     hmap_init(&ofproto->bundles);
 652     ofproto->ml = mac_learning_create();
 653     for (i = 0; i < MAX_MIRRORS; i++) {
 654         ofproto->mirrors[i] = NULL;
 655     }
 656     ofproto->has_bonded_bundles = false;
 657
 658     timer_set_duration(&ofproto->next_expiration, 1000);
 659
 660     hmap_init(&ofproto->facets);
 661     hmap_init(&ofproto->subfacets);
 662
 663     for (i = 0; i < N_TABLES; i++) {
 664         struct table_dpif *table = &ofproto->tables[i];
 665
 666         table->catchall_table = NULL;
 667         table->other_table = NULL;
 668         table->basis = random_uint32();
 669     }
 670     ofproto->need_revalidate = false;
 671     tag_set_init(&ofproto->revalidate_set);
 672
 673     list_init(&ofproto->completions);
 674
 675     ofproto_dpif_unixctl_init();
 676
 677     ofproto->has_bundle_action = false;
 678
 679     hmap_init(&ofproto->vlandev_map);
 680     hmap_init(&ofproto->realdev_vid_map);
 681
 682     hmap_insert(&all_ofproto_dpifs, &ofproto->all_ofproto_dpifs_node,
 683                 hash_string(ofproto->up.name, 0));
 684
 685     *n_tablesp = N_TABLES;
 686     memset(&ofproto->stats, 0, sizeof ofproto->stats);
 687     return 0;
 688 }
 689
 690 static void
 691 complete_operations(struct ofproto_dpif *ofproto)
 692 {
 693     struct dpif_completion *c, *next;
 694
 695     LIST_FOR_EACH_SAFE (c, next, list_node, &ofproto->completions) {
 696         ofoperation_complete(c->op, 0);
 697         list_remove(&c->list_node);
 698         free(c);
 699     }
 700 }
 701
 702 static void
 703 destruct(struct ofproto *ofproto_)
 704 {
 705     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
 706     struct rule_dpif *rule, *next_rule;
 707     struct classifier *table;
 708     int i;
 709
 710     hmap_remove(&all_ofproto_dpifs, &ofproto->all_ofproto_dpifs_node);
 711     complete_operations(ofproto);
 712
 713     OFPROTO_FOR_EACH_TABLE (table, &ofproto->up) {
 714         struct cls_cursor cursor;
 715
 716         cls_cursor_init(&cursor, table, NULL);
 717         CLS_CURSOR_FOR_EACH_SAFE (rule, next_rule, up.cr, &cursor) {
 718             ofproto_rule_destroy(&rule->up);
 719         }
 720     }
 721
 722     for (i = 0; i < MAX_MIRRORS; i++) {
 723         mirror_destroy(ofproto->mirrors[i]);
 724     }
 725
 726     netflow_destroy(ofproto->netflow);
 727     dpif_sflow_destroy(ofproto->sflow);
 728     hmap_destroy(&ofproto->bundles);
 729     mac_learning_destroy(ofproto->ml);
 730
 731     hmap_destroy(&ofproto->facets);
 732     hmap_destroy(&ofproto->subfacets);
 733
 734     hmap_destroy(&ofproto->vlandev_map);
 735     hmap_destroy(&ofproto->realdev_vid_map);
 736
 737     dpif_close(ofproto->dpif);
 738 }
 739
 740 static int
 741 run_fast(struct ofproto *ofproto_)
 742 {
 743     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
 744     unsigned int work;
 745
 746     /* Handle one or more batches of upcalls, until there's nothing left to do
 747      * or until we do a fixed total amount of work.
 748      *
 749      * We do work in batches because it can be much cheaper to set up a number
 750      * of flows and fire off their patches all at once.  We do multiple batches
 751      * because in some cases handling a packet can cause another packet to be
 752      * queued almost immediately as part of the return flow.  Both
 753      * optimizations can make major improvements on some benchmarks and
 754      * presumably for real traffic as well. */
 755     work = 0;
 756     while (work < FLOW_MISS_MAX_BATCH) {
 757         int retval = handle_upcalls(ofproto, FLOW_MISS_MAX_BATCH - work);
 758         if (retval <= 0) {
 759             return -retval;
 760         }
 761         work += retval;
 762     }
 763     return 0;
 764 }
 765
 766 static int
 767 run(struct ofproto *ofproto_)
 768 {
 769     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
 770     struct ofport_dpif *ofport;
 771     struct ofbundle *bundle;
 772     int error;
 773
 774     if (!clogged) {
 775         complete_operations(ofproto);
 776     }
 777     dpif_run(ofproto->dpif);
 778
 779     error = run_fast(ofproto_);
 780     if (error) {
 781         return error;
 782     }
 783
 784     if (timer_expired(&ofproto->next_expiration)) {
 785         int delay = expire(ofproto);
 786         timer_set_duration(&ofproto->next_expiration, delay);
 787     }
 788
 789     if (ofproto->netflow) {
 790         if (netflow_run(ofproto->netflow)) {
 791             send_netflow_active_timeouts(ofproto);
 792         }
 793     }
 794     if (ofproto->sflow) {
 795         dpif_sflow_run(ofproto->sflow);
 796     }
 797
 798     HMAP_FOR_EACH (ofport, up.hmap_node, &ofproto->up.ports) {
 799         port_run(ofport);
 800     }
 801     HMAP_FOR_EACH (bundle, hmap_node, &ofproto->bundles) {
 802         bundle_run(bundle);
 803     }
 804
 805     stp_run(ofproto);
 806     mac_learning_run(ofproto->ml, &ofproto->revalidate_set);
 807
 808     /* Now revalidate if there's anything to do. */
 809     if (ofproto->need_revalidate
 810         || !tag_set_is_empty(&ofproto->revalidate_set)) {
 811         struct tag_set revalidate_set = ofproto->revalidate_set;
 812         bool revalidate_all = ofproto->need_revalidate;
 813         struct facet *facet, *next;
 814
 815         /* Clear the revalidation flags. */
 816         tag_set_init(&ofproto->revalidate_set);
 817         ofproto->need_revalidate = false;
 818
 819         HMAP_FOR_EACH_SAFE (facet, next, hmap_node, &ofproto->facets) {
 820             if (revalidate_all
 821                 || tag_set_intersects(&revalidate_set, facet->tags)) {
 822                 facet_revalidate(ofproto, facet);
 823             }
 824         }
 825     }
 826
 827     return 0;
 828 }
 829
 830 static void
 831 wait(struct ofproto *ofproto_)
 832 {
 833     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
 834     struct ofport_dpif *ofport;
 835     struct ofbundle *bundle;
 836
 837     if (!clogged && !list_is_empty(&ofproto->completions)) {
 838         poll_immediate_wake();
 839     }
 840
 841     dpif_wait(ofproto->dpif);
 842     dpif_recv_wait(ofproto->dpif);
 843     if (ofproto->sflow) {
 844         dpif_sflow_wait(ofproto->sflow);
 845     }
 846     if (!tag_set_is_empty(&ofproto->revalidate_set)) {
 847         poll_immediate_wake();
 848     }
 849     HMAP_FOR_EACH (ofport, up.hmap_node, &ofproto->up.ports) {
 850         port_wait(ofport);
 851     }
 852     HMAP_FOR_EACH (bundle, hmap_node, &ofproto->bundles) {
 853         bundle_wait(bundle);
 854     }
 855     if (ofproto->netflow) {
 856         netflow_wait(ofproto->netflow);
 857     }
 858     mac_learning_wait(ofproto->ml);
 859     stp_wait(ofproto);
 860     if (ofproto->need_revalidate) {
 861         /* Shouldn't happen, but if it does just go around again. */
 862         VLOG_DBG_RL(&rl, "need revalidate in ofproto_wait_cb()");
 863         poll_immediate_wake();
 864     } else {
 865         timer_wait(&ofproto->next_expiration);
 866     }
 867 }
 868
 869 static void
 870 flush(struct ofproto *ofproto_)
 871 {
 872     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
 873     struct facet *facet, *next_facet;
 874
 875     HMAP_FOR_EACH_SAFE (facet, next_facet, hmap_node, &ofproto->facets) {
 876         /* Mark the facet as not installed so that facet_remove() doesn't
 877          * bother trying to uninstall it.  There is no point in uninstalling it
 878          * individually since we are about to blow away all the facets with
 879          * dpif_flow_flush(). */
 880         struct subfacet *subfacet;
 881
 882         LIST_FOR_EACH (subfacet, list_node, &facet->subfacets) {
 883             subfacet->installed = false;
 884             subfacet->dp_packet_count = 0;
 885             subfacet->dp_byte_count = 0;
 886         }
 887         facet_remove(ofproto, facet);
 888     }
 889     dpif_flow_flush(ofproto->dpif);
 890 }
 891
 892 static void
 893 get_features(struct ofproto *ofproto_ OVS_UNUSED,
 894              bool *arp_match_ip, uint32_t *actions)
 895 {
 896     *arp_match_ip = true;
 897     *actions = ((1u << OFPAT_OUTPUT) |
 898                 (1u << OFPAT_SET_VLAN_VID) |
 899                 (1u << OFPAT_SET_VLAN_PCP) |
 900                 (1u << OFPAT_STRIP_VLAN) |
 901                 (1u << OFPAT_SET_DL_SRC) |
 902                 (1u << OFPAT_SET_DL_DST) |
 903                 (1u << OFPAT_SET_NW_SRC) |
 904                 (1u << OFPAT_SET_NW_DST) |
 905                 (1u << OFPAT_SET_NW_TOS) |
 906                 (1u << OFPAT_SET_TP_SRC) |
 907                 (1u << OFPAT_SET_TP_DST) |
 908                 (1u << OFPAT_ENQUEUE));
 909 }
 910
 911 static void
 912 get_tables(struct ofproto *ofproto_, struct ofp_table_stats *ots)
 913 {
 914     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
 915     struct dpif_dp_stats s;
 916
 917     strcpy(ots->name, "classifier");
 918
 919     dpif_get_dp_stats(ofproto->dpif, &s);
 920     put_32aligned_be64(&ots->lookup_count, htonll(s.n_hit + s.n_missed));
 921     put_32aligned_be64(&ots->matched_count,
 922                        htonll(s.n_hit + ofproto->n_matches));
 923 }
 924
 925 static struct ofport *
 926 port_alloc(void)
 927 {
 928     struct ofport_dpif *port = xmalloc(sizeof *port);
 929     return &port->up;
 930 }
 931
 932 static void
 933 port_dealloc(struct ofport *port_)
 934 {
 935     struct ofport_dpif *port = ofport_dpif_cast(port_);
 936     free(port);
 937 }
 938
 939 static int
 940 port_construct(struct ofport *port_)
 941 {
 942     struct ofport_dpif *port = ofport_dpif_cast(port_);
 943     struct ofproto_dpif *ofproto = ofproto_dpif_cast(port->up.ofproto);
 944
 945     ofproto->need_revalidate = true;
 946     port->odp_port = ofp_port_to_odp_port(port->up.ofp_port);
 947     port->bundle = NULL;
 948     port->cfm = NULL;
 949     port->tag = tag_create_random();
 950     port->may_enable = true;
 951     port->stp_port = NULL;
 952     port->stp_state = STP_DISABLED;
 953     hmap_init(&port->priorities);
 954     port->realdev_ofp_port = 0;
 955     port->vlandev_vid = 0;
 956
 957     if (ofproto->sflow) {
 958         dpif_sflow_add_port(ofproto->sflow, port_);
 959     }
 960
 961     return 0;
 962 }
 963
 964 static void
 965 port_destruct(struct ofport *port_)
 966 {
 967     struct ofport_dpif *port = ofport_dpif_cast(port_);
 968     struct ofproto_dpif *ofproto = ofproto_dpif_cast(port->up.ofproto);
 969
 970     ofproto->need_revalidate = true;
 971     bundle_remove(port_);
 972     set_cfm(port_, NULL);
 973     if (ofproto->sflow) {
 974         dpif_sflow_del_port(ofproto->sflow, port->odp_port);
 975     }
 976
 977     ofport_clear_priorities(port);
 978     hmap_destroy(&port->priorities);
 979 }
 980
 981 static void
 982 port_modified(struct ofport *port_)
 983 {
 984     struct ofport_dpif *port = ofport_dpif_cast(port_);
 985
 986     if (port->bundle && port->bundle->bond) {
 987         bond_slave_set_netdev(port->bundle->bond, port, port->up.netdev);
 988     }
 989 }
 990
 991 static void
 992 port_reconfigured(struct ofport *port_, ovs_be32 old_config)
 993 {
 994     struct ofport_dpif *port = ofport_dpif_cast(port_);
 995     struct ofproto_dpif *ofproto = ofproto_dpif_cast(port->up.ofproto);
 996     ovs_be32 changed = old_config ^ port->up.opp.config;
 997
 998     if (changed & htonl(OFPPC_NO_RECV | OFPPC_NO_RECV_STP |
 999                         OFPPC_NO_FWD | OFPPC_NO_FLOOD)) {
1000         ofproto->need_revalidate = true;
1001
1002         if (changed & htonl(OFPPC_NO_FLOOD) && port->bundle) {
1003             bundle_update(port->bundle);
1004         }
1005     }
1006 }
1007
1008 static int
1009 set_sflow(struct ofproto *ofproto_,
1010           const struct ofproto_sflow_options *sflow_options)
1011 {
1012     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
1013     struct dpif_sflow *ds = ofproto->sflow;
1014
1015     if (sflow_options) {
1016         if (!ds) {
1017             struct ofport_dpif *ofport;
1018
1019             ds = ofproto->sflow = dpif_sflow_create(ofproto->dpif);
1020             HMAP_FOR_EACH (ofport, up.hmap_node, &ofproto->up.ports) {
1021                 dpif_sflow_add_port(ds, &ofport->up);
1022             }
1023             ofproto->need_revalidate = true;
1024         }
1025         dpif_sflow_set_options(ds, sflow_options);
1026     } else {
1027         if (ds) {
1028             dpif_sflow_destroy(ds);
1029             ofproto->need_revalidate = true;
1030             ofproto->sflow = NULL;
1031         }
1032     }
1033     return 0;
1034 }
1035
1036 static int
1037 set_cfm(struct ofport *ofport_, const struct cfm_settings *s)
1038 {
1039     struct ofport_dpif *ofport = ofport_dpif_cast(ofport_);
1040     int error;
1041
1042     if (!s) {
1043         error = 0;
1044     } else {
1045         if (!ofport->cfm) {
1046             struct ofproto_dpif *ofproto;
1047
1048             ofproto = ofproto_dpif_cast(ofport->up.ofproto);
1049             ofproto->need_revalidate = true;
1050             ofport->cfm = cfm_create(netdev_get_name(ofport->up.netdev));
1051         }
1052
1053         if (cfm_configure(ofport->cfm, s)) {
1054             return 0;
1055         }
1056
1057         error = EINVAL;
1058     }
1059     cfm_destroy(ofport->cfm);
1060     ofport->cfm = NULL;
1061     return error;
1062 }
1063
1064 static int
1065 get_cfm_fault(const struct ofport *ofport_)
1066 {
1067     struct ofport_dpif *ofport = ofport_dpif_cast(ofport_);
1068
1069     return ofport->cfm ? cfm_get_fault(ofport->cfm) : -1;
1070 }
1071
1072 static int
1073 get_cfm_remote_mpids(const struct ofport *ofport_, const uint64_t **rmps,
1074                      size_t *n_rmps)
1075 {
1076     struct ofport_dpif *ofport = ofport_dpif_cast(ofport_);
1077
1078     if (ofport->cfm) {
1079         cfm_get_remote_mpids(ofport->cfm, rmps, n_rmps);
1080         return 0;
1081     } else {
1082         return -1;
1083     }
1084 }
1085 \f
1086 /* Spanning Tree. */
1087
1088 static void
1089 send_bpdu_cb(struct ofpbuf *pkt, int port_num, void *ofproto_)
1090 {
1091     struct ofproto_dpif *ofproto = ofproto_;
1092     struct stp_port *sp = stp_get_port(ofproto->stp, port_num);
1093     struct ofport_dpif *ofport;
1094
1095     ofport = stp_port_get_aux(sp);
1096     if (!ofport) {
1097         VLOG_WARN_RL(&rl, "%s: cannot send BPDU on unknown port %d",
1098                      ofproto->up.name, port_num);
1099     } else {
1100         struct eth_header *eth = pkt->l2;
1101
1102         netdev_get_etheraddr(ofport->up.netdev, eth->eth_src);
1103         if (eth_addr_is_zero(eth->eth_src)) {
1104             VLOG_WARN_RL(&rl, "%s: cannot send BPDU on port %d "
1105                          "with unknown MAC", ofproto->up.name, port_num);
1106         } else {
1107             send_packet(ofport, pkt);
1108         }
1109     }
1110     ofpbuf_delete(pkt);
1111 }
1112
1113 /* Configures STP on 'ofproto_' using the settings defined in 's'. */
1114 static int
1115 set_stp(struct ofproto *ofproto_, const struct ofproto_stp_settings *s)
1116 {
1117     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
1118
1119     /* Only revalidate flows if the configuration changed. */
1120     if (!s != !ofproto->stp) {
1121         ofproto->need_revalidate = true;
1122     }
1123
1124     if (s) {
1125         if (!ofproto->stp) {
1126             ofproto->stp = stp_create(ofproto_->name, s->system_id,
1127                                       send_bpdu_cb, ofproto);
1128             ofproto->stp_last_tick = time_msec();
1129         }
1130
1131         stp_set_bridge_id(ofproto->stp, s->system_id);
1132         stp_set_bridge_priority(ofproto->stp, s->priority);
1133         stp_set_hello_time(ofproto->stp, s->hello_time);
1134         stp_set_max_age(ofproto->stp, s->max_age);
1135         stp_set_forward_delay(ofproto->stp, s->fwd_delay);
1136     }  else {
1137         stp_destroy(ofproto->stp);
1138         ofproto->stp = NULL;
1139     }
1140
1141     return 0;
1142 }
1143
1144 static int
1145 get_stp_status(struct ofproto *ofproto_, struct ofproto_stp_status *s)
1146 {
1147     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
1148
1149     if (ofproto->stp) {
1150         s->enabled = true;
1151         s->bridge_id = stp_get_bridge_id(ofproto->stp);
1152         s->designated_root = stp_get_designated_root(ofproto->stp);
1153         s->root_path_cost = stp_get_root_path_cost(ofproto->stp);
1154     } else {
1155         s->enabled = false;
1156     }
1157
1158     return 0;
1159 }
1160
1161 static void
1162 update_stp_port_state(struct ofport_dpif *ofport)
1163 {
1164     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofport->up.ofproto);
1165     enum stp_state state;
1166
1167     /* Figure out new state. */
1168     state = ofport->stp_port ? stp_port_get_state(ofport->stp_port)
1169                              : STP_DISABLED;
1170
1171     /* Update state. */
1172     if (ofport->stp_state != state) {
1173         ovs_be32 of_state;
1174         bool fwd_change;
1175
1176         VLOG_DBG_RL(&rl, "port %s: STP state changed from %s to %s",
1177                     netdev_get_name(ofport->up.netdev),
1178                     stp_state_name(ofport->stp_state),
1179                     stp_state_name(state));
1180         if (stp_learn_in_state(ofport->stp_state)
1181                 != stp_learn_in_state(state)) {
1182             /* xxx Learning action flows should also be flushed. */
1183             mac_learning_flush(ofproto->ml);
1184         }
1185         fwd_change = stp_forward_in_state(ofport->stp_state)
1186                         != stp_forward_in_state(state);
1187
1188         ofproto->need_revalidate = true;
1189         ofport->stp_state = state;
1190         ofport->stp_state_entered = time_msec();
1191
1192         if (fwd_change && ofport->bundle) {
1193             bundle_update(ofport->bundle);
1194         }
1195
1196         /* Update the STP state bits in the OpenFlow port description. */
1197         of_state = (ofport->up.opp.state & htonl(~OFPPS_STP_MASK))
1198                          | htonl(state == STP_LISTENING ? OFPPS_STP_LISTEN
1199                                : state == STP_LEARNING ? OFPPS_STP_LEARN
1200                                : state == STP_FORWARDING ? OFPPS_STP_FORWARD
1201                                : state == STP_BLOCKING ?  OFPPS_STP_BLOCK
1202                                : 0);
1203         ofproto_port_set_state(&ofport->up, of_state);
1204     }
1205 }
1206
1207 /* Configures STP on 'ofport_' using the settings defined in 's'.  The
1208  * caller is responsible for assigning STP port numbers and ensuring
1209  * there are no duplicates. */
1210 static int
1211 set_stp_port(struct ofport *ofport_,
1212              const struct ofproto_port_stp_settings *s)
1213 {
1214     struct ofport_dpif *ofport = ofport_dpif_cast(ofport_);
1215     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofport->up.ofproto);
1216     struct stp_port *sp = ofport->stp_port;
1217
1218     if (!s || !s->enable) {
1219         if (sp) {
1220             ofport->stp_port = NULL;
1221             stp_port_disable(sp);
1222             update_stp_port_state(ofport);
1223         }
1224         return 0;
1225     } else if (sp && stp_port_no(sp) != s->port_num
1226             && ofport == stp_port_get_aux(sp)) {
1227         /* The port-id changed, so disable the old one if it's not
1228          * already in use by another port. */
1229         stp_port_disable(sp);
1230     }
1231
1232     sp = ofport->stp_port = stp_get_port(ofproto->stp, s->port_num);
1233     stp_port_enable(sp);
1234
1235     stp_port_set_aux(sp, ofport);
1236     stp_port_set_priority(sp, s->priority);
1237     stp_port_set_path_cost(sp, s->path_cost);
1238
1239     update_stp_port_state(ofport);
1240
1241     return 0;
1242 }
1243
1244 static int
1245 get_stp_port_status(struct ofport *ofport_,
1246                     struct ofproto_port_stp_status *s)
1247 {
1248     struct ofport_dpif *ofport = ofport_dpif_cast(ofport_);
1249     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofport->up.ofproto);
1250     struct stp_port *sp = ofport->stp_port;
1251
1252     if (!ofproto->stp || !sp) {
1253         s->enabled = false;
1254         return 0;
1255     }
1256
1257     s->enabled = true;
1258     s->port_id = stp_port_get_id(sp);
1259     s->state = stp_port_get_state(sp);
1260     s->sec_in_state = (time_msec() - ofport->stp_state_entered) / 1000;
1261     s->role = stp_port_get_role(sp);
1262     stp_port_get_counts(sp, &s->tx_count, &s->rx_count, &s->error_count);
1263
1264     return 0;
1265 }
1266
1267 static void
1268 stp_run(struct ofproto_dpif *ofproto)
1269 {
1270     if (ofproto->stp) {
1271         long long int now = time_msec();
1272         long long int elapsed = now - ofproto->stp_last_tick;
1273         struct stp_port *sp;
1274
1275         if (elapsed > 0) {
1276             stp_tick(ofproto->stp, MIN(INT_MAX, elapsed));
1277             ofproto->stp_last_tick = now;
1278         }
1279         while (stp_get_changed_port(ofproto->stp, &sp)) {
1280             struct ofport_dpif *ofport = stp_port_get_aux(sp);
1281
1282             if (ofport) {
1283                 update_stp_port_state(ofport);
1284             }
1285         }
1286     }
1287 }
1288
1289 static void
1290 stp_wait(struct ofproto_dpif *ofproto)
1291 {
1292     if (ofproto->stp) {
1293         poll_timer_wait(1000);
1294     }
1295 }
1296
1297 /* Returns true if STP should process 'flow'. */
1298 static bool
1299 stp_should_process_flow(const struct flow *flow)
1300 {
1301     return eth_addr_equals(flow->dl_dst, eth_addr_stp);
1302 }
1303
1304 static void
1305 stp_process_packet(const struct ofport_dpif *ofport,
1306                    const struct ofpbuf *packet)
1307 {
1308     struct ofpbuf payload = *packet;
1309     struct eth_header *eth = payload.data;
1310     struct stp_port *sp = ofport->stp_port;
1311
1312     /* Sink packets on ports that have STP disabled when the bridge has
1313      * STP enabled. */
1314     if (!sp || stp_port_get_state(sp) == STP_DISABLED) {
1315         return;
1316     }
1317
1318     /* Trim off padding on payload. */
1319     if (payload.size > ntohs(eth->eth_type) + ETH_HEADER_LEN) {
1320         payload.size = ntohs(eth->eth_type) + ETH_HEADER_LEN;
1321     }
1322
1323     if (ofpbuf_try_pull(&payload, ETH_HEADER_LEN + LLC_HEADER_LEN)) {
1324         stp_received_bpdu(sp, payload.data, payload.size);
1325     }
1326 }
1327 \f
1328 static struct priority_to_dscp *
1329 get_priority(const struct ofport_dpif *ofport, uint32_t priority)
1330 {
1331     struct priority_to_dscp *pdscp;
1332     uint32_t hash;
1333
1334     hash = hash_int(priority, 0);
1335     HMAP_FOR_EACH_IN_BUCKET (pdscp, hmap_node, hash, &ofport->priorities) {
1336         if (pdscp->priority == priority) {
1337             return pdscp;
1338         }
1339     }
1340     return NULL;
1341 }
1342
1343 static void
1344 ofport_clear_priorities(struct ofport_dpif *ofport)
1345 {
1346     struct priority_to_dscp *pdscp, *next;
1347
1348     HMAP_FOR_EACH_SAFE (pdscp, next, hmap_node, &ofport->priorities) {
1349         hmap_remove(&ofport->priorities, &pdscp->hmap_node);
1350         free(pdscp);
1351     }
1352 }
1353
1354 static int
1355 set_queues(struct ofport *ofport_,
1356            const struct ofproto_port_queue *qdscp_list,
1357            size_t n_qdscp)
1358 {
1359     struct ofport_dpif *ofport = ofport_dpif_cast(ofport_);
1360     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofport->up.ofproto);
1361     struct hmap new = HMAP_INITIALIZER(&new);
1362     size_t i;
1363
1364     for (i = 0; i < n_qdscp; i++) {
1365         struct priority_to_dscp *pdscp;
1366         uint32_t priority;
1367         uint8_t dscp;
1368
1369         dscp = (qdscp_list[i].dscp << 2) & IP_DSCP_MASK;
1370         if (dpif_queue_to_priority(ofproto->dpif, qdscp_list[i].queue,
1371                                    &priority)) {
1372             continue;
1373         }
1374
1375         pdscp = get_priority(ofport, priority);
1376         if (pdscp) {
1377             hmap_remove(&ofport->priorities, &pdscp->hmap_node);
1378         } else {
1379             pdscp = xmalloc(sizeof *pdscp);
1380             pdscp->priority = priority;
1381             pdscp->dscp = dscp;
1382             ofproto->need_revalidate = true;
1383         }
1384
1385         if (pdscp->dscp != dscp) {
1386             pdscp->dscp = dscp;
1387             ofproto->need_revalidate = true;
1388         }
1389
1390         hmap_insert(&new, &pdscp->hmap_node, hash_int(pdscp->priority, 0));
1391     }
1392
1393     if (!hmap_is_empty(&ofport->priorities)) {
1394         ofport_clear_priorities(ofport);
1395         ofproto->need_revalidate = true;
1396     }
1397
1398     hmap_swap(&new, &ofport->priorities);
1399     hmap_destroy(&new);
1400
1401     return 0;
1402 }
1403 \f
1404 /* Bundles. */
1405
1406 /* Expires all MAC learning entries associated with 'bundle' and forces its
1407  * ofproto to revalidate every flow.
1408  *
1409  * Normally MAC learning entries are removed only from the ofproto associated
1410  * with 'bundle', but if 'all_ofprotos' is true, then the MAC learning entries
1411  * are removed from every ofproto.  When patch ports and SLB bonds are in use
1412  * and a VM migration happens and the gratuitous ARPs are somehow lost, this
1413  * avoids a MAC_ENTRY_IDLE_TIME delay before the migrated VM can communicate
1414  * with the host from which it migrated. */
1415 static void
1416 bundle_flush_macs(struct ofbundle *bundle, bool all_ofprotos)
1417 {
1418     struct ofproto_dpif *ofproto = bundle->ofproto;
1419     struct mac_learning *ml = ofproto->ml;
1420     struct mac_entry *mac, *next_mac;
1421
1422     ofproto->need_revalidate = true;
1423     LIST_FOR_EACH_SAFE (mac, next_mac, lru_node, &ml->lrus) {
1424         if (mac->port.p == bundle) {
1425             if (all_ofprotos) {
1426                 struct ofproto_dpif *o;
1427
1428                 HMAP_FOR_EACH (o, all_ofproto_dpifs_node, &all_ofproto_dpifs) {
1429                     if (o != ofproto) {
1430                         struct mac_entry *e;
1431
1432                         e = mac_learning_lookup(o->ml, mac->mac, mac->vlan,
1433                                                 NULL);
1434                         if (e) {
1435                             tag_set_add(&o->revalidate_set, e->tag);
1436                             mac_learning_expire(o->ml, e);
1437                         }
1438                     }
1439                 }
1440             }
1441
1442             mac_learning_expire(ml, mac);
1443         }
1444     }
1445 }
1446
1447 static struct ofbundle *
1448 bundle_lookup(const struct ofproto_dpif *ofproto, void *aux)
1449 {
1450     struct ofbundle *bundle;
1451
1452     HMAP_FOR_EACH_IN_BUCKET (bundle, hmap_node, hash_pointer(aux, 0),
1453                              &ofproto->bundles) {
1454         if (bundle->aux == aux) {
1455             return bundle;
1456         }
1457     }
1458     return NULL;
1459 }
1460
1461 /* Looks up each of the 'n_auxes' pointers in 'auxes' as bundles and adds the
1462  * ones that are found to 'bundles'. */
1463 static void
1464 bundle_lookup_multiple(struct ofproto_dpif *ofproto,
1465                        void **auxes, size_t n_auxes,
1466                        struct hmapx *bundles)
1467 {
1468     size_t i;
1469
1470     hmapx_init(bundles);
1471     for (i = 0; i < n_auxes; i++) {
1472         struct ofbundle *bundle = bundle_lookup(ofproto, auxes[i]);
1473         if (bundle) {
1474             hmapx_add(bundles, bundle);
1475         }
1476     }
1477 }
1478
1479 static void
1480 bundle_update(struct ofbundle *bundle)
1481 {
1482     struct ofport_dpif *port;
1483
1484     bundle->floodable = true;
1485     LIST_FOR_EACH (port, bundle_node, &bundle->ports) {
1486         if (port->up.opp.config & htonl(OFPPC_NO_FLOOD)) {
1487             bundle->floodable = false;
1488             break;
1489         }
1490     }
1491 }
1492
1493 static void
1494 bundle_del_port(struct ofport_dpif *port)
1495 {
1496     struct ofbundle *bundle = port->bundle;
1497
1498     bundle->ofproto->need_revalidate = true;
1499
1500     list_remove(&port->bundle_node);
1501     port->bundle = NULL;
1502
1503     if (bundle->lacp) {
1504         lacp_slave_unregister(bundle->lacp, port);
1505     }
1506     if (bundle->bond) {
1507         bond_slave_unregister(bundle->bond, port);
1508     }
1509
1510     bundle_update(bundle);
1511 }
1512
1513 static bool
1514 bundle_add_port(struct ofbundle *bundle, uint32_t ofp_port,
1515                 struct lacp_slave_settings *lacp,
1516                 uint32_t bond_stable_id)
1517 {
1518     struct ofport_dpif *port;
1519
1520     port = get_ofp_port(bundle->ofproto, ofp_port);
1521     if (!port) {
1522         return false;
1523     }
1524
1525     if (port->bundle != bundle) {
1526         bundle->ofproto->need_revalidate = true;
1527         if (port->bundle) {
1528             bundle_del_port(port);
1529         }
1530
1531         port->bundle = bundle;
1532         list_push_back(&bundle->ports, &port->bundle_node);
1533         if (port->up.opp.config & htonl(OFPPC_NO_FLOOD)) {
1534             bundle->floodable = false;
1535         }
1536     }
1537     if (lacp) {
1538         port->bundle->ofproto->need_revalidate = true;
1539         lacp_slave_register(bundle->lacp, port, lacp);
1540     }
1541
1542     port->bond_stable_id = bond_stable_id;
1543
1544     return true;
1545 }
1546
1547 static void
1548 bundle_destroy(struct ofbundle *bundle)
1549 {
1550     struct ofproto_dpif *ofproto;
1551     struct ofport_dpif *port, *next_port;
1552     int i;
1553
1554     if (!bundle) {
1555         return;
1556     }
1557
1558     ofproto = bundle->ofproto;
1559     for (i = 0; i < MAX_MIRRORS; i++) {
1560         struct ofmirror *m = ofproto->mirrors[i];
1561         if (m) {
1562             if (m->out == bundle) {
1563                 mirror_destroy(m);
1564             } else if (hmapx_find_and_delete(&m->srcs, bundle)
1565                        || hmapx_find_and_delete(&m->dsts, bundle)) {
1566                 ofproto->need_revalidate = true;
1567             }
1568         }
1569     }
1570
1571     LIST_FOR_EACH_SAFE (port, next_port, bundle_node, &bundle->ports) {
1572         bundle_del_port(port);
1573     }
1574
1575     bundle_flush_macs(bundle, true);
1576     hmap_remove(&ofproto->bundles, &bundle->hmap_node);
1577     free(bundle->name);
1578     free(bundle->trunks);
1579     lacp_destroy(bundle->lacp);
1580     bond_destroy(bundle->bond);
1581     free(bundle);
1582 }
1583
1584 static int
1585 bundle_set(struct ofproto *ofproto_, void *aux,
1586            const struct ofproto_bundle_settings *s)
1587 {
1588     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
1589     bool need_flush = false;
1590     struct ofport_dpif *port;
1591     struct ofbundle *bundle;
1592     unsigned long *trunks;
1593     int vlan;
1594     size_t i;
1595     bool ok;
1596
1597     if (!s) {
1598         bundle_destroy(bundle_lookup(ofproto, aux));
1599         return 0;
1600     }
1601
1602     assert(s->n_slaves == 1 || s->bond != NULL);
1603     assert((s->lacp != NULL) == (s->lacp_slaves != NULL));
1604
1605     bundle = bundle_lookup(ofproto, aux);
1606     if (!bundle) {
1607         bundle = xmalloc(sizeof *bundle);
1608
1609         bundle->ofproto = ofproto;
1610         hmap_insert(&ofproto->bundles, &bundle->hmap_node,
1611                     hash_pointer(aux, 0));
1612         bundle->aux = aux;
1613         bundle->name = NULL;
1614
1615         list_init(&bundle->ports);
1616         bundle->vlan_mode = PORT_VLAN_TRUNK;
1617         bundle->vlan = -1;
1618         bundle->trunks = NULL;
1619         bundle->use_priority_tags = s->use_priority_tags;
1620         bundle->lacp = NULL;
1621         bundle->bond = NULL;
1622
1623         bundle->floodable = true;
1624
1625         bundle->src_mirrors = 0;
1626         bundle->dst_mirrors = 0;
1627         bundle->mirror_out = 0;
1628     }
1629
1630     if (!bundle->name || strcmp(s->name, bundle->name)) {
1631         free(bundle->name);
1632         bundle->name = xstrdup(s->name);
1633     }
1634
1635     /* LACP. */
1636     if (s->lacp) {
1637         if (!bundle->lacp) {
1638             ofproto->need_revalidate = true;
1639             bundle->lacp = lacp_create();
1640         }
1641         lacp_configure(bundle->lacp, s->lacp);
1642     } else {
1643         lacp_destroy(bundle->lacp);
1644         bundle->lacp = NULL;
1645     }
1646
1647     /* Update set of ports. */
1648     ok = true;
1649     for (i = 0; i < s->n_slaves; i++) {
1650         if (!bundle_add_port(bundle, s->slaves[i],
1651                              s->lacp ? &s->lacp_slaves[i] : NULL,
1652                              s->bond_stable_ids ? s->bond_stable_ids[i] : 0)) {
1653             ok = false;
1654         }
1655     }
1656     if (!ok || list_size(&bundle->ports) != s->n_slaves) {
1657         struct ofport_dpif *next_port;
1658
1659         LIST_FOR_EACH_SAFE (port, next_port, bundle_node, &bundle->ports) {
1660             for (i = 0; i < s->n_slaves; i++) {
1661                 if (s->slaves[i] == port->up.ofp_port) {
1662                     goto found;
1663                 }
1664             }
1665
1666             bundle_del_port(port);
1667         found: ;
1668         }
1669     }
1670     assert(list_size(&bundle->ports) <= s->n_slaves);
1671
1672     if (list_is_empty(&bundle->ports)) {
1673         bundle_destroy(bundle);
1674         return EINVAL;
1675     }
1676
1677     /* Set VLAN tagging mode */
1678     if (s->vlan_mode != bundle->vlan_mode
1679         || s->use_priority_tags != bundle->use_priority_tags) {
1680         bundle->vlan_mode = s->vlan_mode;
1681         bundle->use_priority_tags = s->use_priority_tags;
1682         need_flush = true;
1683     }
1684
1685     /* Set VLAN tag. */
1686     vlan = (s->vlan_mode == PORT_VLAN_TRUNK ? -1
1687             : s->vlan >= 0 && s->vlan <= 4095 ? s->vlan
1688             : 0);
1689     if (vlan != bundle->vlan) {
1690         bundle->vlan = vlan;
1691         need_flush = true;
1692     }
1693
1694     /* Get trunked VLANs. */
1695     switch (s->vlan_mode) {
1696     case PORT_VLAN_ACCESS:
1697         trunks = NULL;
1698         break;
1699
1700     case PORT_VLAN_TRUNK:
1701         trunks = (unsigned long *) s->trunks;
1702         break;
1703
1704     case PORT_VLAN_NATIVE_UNTAGGED:
1705     case PORT_VLAN_NATIVE_TAGGED:
1706         if (vlan != 0 && (!s->trunks
1707                           || !bitmap_is_set(s->trunks, vlan)
1708                           || bitmap_is_set(s->trunks, 0))) {
1709             /* Force trunking the native VLAN and prohibit trunking VLAN 0. */
1710             if (s->trunks) {
1711                 trunks = bitmap_clone(s->trunks, 4096);
1712             } else {
1713                 trunks = bitmap_allocate1(4096);
1714             }
1715             bitmap_set1(trunks, vlan);
1716             bitmap_set0(trunks, 0);
1717         } else {
1718             trunks = (unsigned long *) s->trunks;
1719         }
1720         break;
1721
1722     default:
1723         NOT_REACHED();
1724     }
1725     if (!vlan_bitmap_equal(trunks, bundle->trunks)) {
1726         free(bundle->trunks);
1727         if (trunks == s->trunks) {
1728             bundle->trunks = vlan_bitmap_clone(trunks);
1729         } else {
1730             bundle->trunks = trunks;
1731             trunks = NULL;
1732         }
1733         need_flush = true;
1734     }
1735     if (trunks != s->trunks) {
1736         free(trunks);
1737     }
1738
1739     /* Bonding. */
1740     if (!list_is_short(&bundle->ports)) {
1741         bundle->ofproto->has_bonded_bundles = true;
1742         if (bundle->bond) {
1743             if (bond_reconfigure(bundle->bond, s->bond)) {
1744                 ofproto->need_revalidate = true;
1745             }
1746         } else {
1747             bundle->bond = bond_create(s->bond);
1748             ofproto->need_revalidate = true;
1749         }
1750
1751         LIST_FOR_EACH (port, bundle_node, &bundle->ports) {
1752             bond_slave_register(bundle->bond, port, port->bond_stable_id,
1753                                 port->up.netdev);
1754         }
1755     } else {
1756         bond_destroy(bundle->bond);
1757         bundle->bond = NULL;
1758     }
1759
1760     /* If we changed something that would affect MAC learning, un-learn
1761      * everything on this port and force flow revalidation. */
1762     if (need_flush) {
1763         bundle_flush_macs(bundle, false);
1764     }
1765
1766     return 0;
1767 }
1768
1769 static void
1770 bundle_remove(struct ofport *port_)
1771 {
1772     struct ofport_dpif *port = ofport_dpif_cast(port_);
1773     struct ofbundle *bundle = port->bundle;
1774
1775     if (bundle) {
1776         bundle_del_port(port);
1777         if (list_is_empty(&bundle->ports)) {
1778             bundle_destroy(bundle);
1779         } else if (list_is_short(&bundle->ports)) {
1780             bond_destroy(bundle->bond);
1781             bundle->bond = NULL;
1782         }
1783     }
1784 }
1785
1786 static void
1787 send_pdu_cb(void *port_, const void *pdu, size_t pdu_size)
1788 {
1789     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 10);
1790     struct ofport_dpif *port = port_;
1791     uint8_t ea[ETH_ADDR_LEN];
1792     int error;
1793
1794     error = netdev_get_etheraddr(port->up.netdev, ea);
1795     if (!error) {
1796         struct ofpbuf packet;
1797         void *packet_pdu;
1798
1799         ofpbuf_init(&packet, 0);
1800         packet_pdu = eth_compose(&packet, eth_addr_lacp, ea, ETH_TYPE_LACP,
1801                                  pdu_size);
1802         memcpy(packet_pdu, pdu, pdu_size);
1803
1804         send_packet(port, &packet);
1805         ofpbuf_uninit(&packet);
1806     } else {
1807         VLOG_ERR_RL(&rl, "port %s: cannot obtain Ethernet address of iface "
1808                     "%s (%s)", port->bundle->name,
1809                     netdev_get_name(port->up.netdev), strerror(error));
1810     }
1811 }
1812
1813 static void
1814 bundle_send_learning_packets(struct ofbundle *bundle)
1815 {
1816     struct ofproto_dpif *ofproto = bundle->ofproto;
1817     int error, n_packets, n_errors;
1818     struct mac_entry *e;
1819
1820     error = n_packets = n_errors = 0;
1821     LIST_FOR_EACH (e, lru_node, &ofproto->ml->lrus) {
1822         if (e->port.p != bundle) {
1823             struct ofpbuf *learning_packet;
1824             struct ofport_dpif *port;
1825             void *port_void;
1826             int ret;
1827
1828             /* The assignment to "port" is unnecessary but makes "grep"ing for
1829              * struct ofport_dpif more effective. */
1830             learning_packet = bond_compose_learning_packet(bundle->bond,
1831                                                            e->mac, e->vlan,
1832                                                            &port_void);
1833             port = port_void;
1834             ret = send_packet(port, learning_packet);
1835             ofpbuf_delete(learning_packet);
1836             if (ret) {
1837                 error = ret;
1838                 n_errors++;
1839             }
1840             n_packets++;
1841         }
1842     }
1843
1844     if (n_errors) {
1845         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
1846         VLOG_WARN_RL(&rl, "bond %s: %d errors sending %d gratuitous learning "
1847                      "packets, last error was: %s",
1848                      bundle->name, n_errors, n_packets, strerror(error));
1849     } else {
1850         VLOG_DBG("bond %s: sent %d gratuitous learning packets",
1851                  bundle->name, n_packets);
1852     }
1853 }
1854
1855 static void
1856 bundle_run(struct ofbundle *bundle)
1857 {
1858     if (bundle->lacp) {
1859         lacp_run(bundle->lacp, send_pdu_cb);
1860     }
1861     if (bundle->bond) {
1862         struct ofport_dpif *port;
1863
1864         LIST_FOR_EACH (port, bundle_node, &bundle->ports) {
1865             bond_slave_set_may_enable(bundle->bond, port, port->may_enable);
1866         }
1867
1868         bond_run(bundle->bond, &bundle->ofproto->revalidate_set,
1869                  lacp_negotiated(bundle->lacp));
1870         if (bond_should_send_learning_packets(bundle->bond)) {
1871             bundle_send_learning_packets(bundle);
1872         }
1873     }
1874 }
1875
1876 static void
1877 bundle_wait(struct ofbundle *bundle)
1878 {
1879     if (bundle->lacp) {
1880         lacp_wait(bundle->lacp);
1881     }
1882     if (bundle->bond) {
1883         bond_wait(bundle->bond);
1884     }
1885 }
1886 \f
1887 /* Mirrors. */
1888
1889 static int
1890 mirror_scan(struct ofproto_dpif *ofproto)
1891 {
1892     int idx;
1893
1894     for (idx = 0; idx < MAX_MIRRORS; idx++) {
1895         if (!ofproto->mirrors[idx]) {
1896             return idx;
1897         }
1898     }
1899     return -1;
1900 }
1901
1902 static struct ofmirror *
1903 mirror_lookup(struct ofproto_dpif *ofproto, void *aux)
1904 {
1905     int i;
1906
1907     for (i = 0; i < MAX_MIRRORS; i++) {
1908         struct ofmirror *mirror = ofproto->mirrors[i];
1909         if (mirror && mirror->aux == aux) {
1910             return mirror;
1911         }
1912     }
1913
1914     return NULL;
1915 }
1916
1917 /* Update the 'dup_mirrors' member of each of the ofmirrors in 'ofproto'. */
1918 static void
1919 mirror_update_dups(struct ofproto_dpif *ofproto)
1920 {
1921     int i;
1922
1923     for (i = 0; i < MAX_MIRRORS; i++) {
1924         struct ofmirror *m = ofproto->mirrors[i];
1925
1926         if (m) {
1927             m->dup_mirrors = MIRROR_MASK_C(1) << i;
1928         }
1929     }
1930
1931     for (i = 0; i < MAX_MIRRORS; i++) {
1932         struct ofmirror *m1 = ofproto->mirrors[i];
1933         int j;
1934
1935         if (!m1) {
1936             continue;
1937         }
1938
1939         for (j = i + 1; j < MAX_MIRRORS; j++) {
1940             struct ofmirror *m2 = ofproto->mirrors[j];
1941
1942             if (m2 && m1->out == m2->out && m1->out_vlan == m2->out_vlan) {
1943                 m1->dup_mirrors |= MIRROR_MASK_C(1) << j;
1944                 m2->dup_mirrors |= m1->dup_mirrors;
1945             }
1946         }
1947     }
1948 }
1949
1950 static int
1951 mirror_set(struct ofproto *ofproto_, void *aux,
1952            const struct ofproto_mirror_settings *s)
1953 {
1954     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
1955     mirror_mask_t mirror_bit;
1956     struct ofbundle *bundle;
1957     struct ofmirror *mirror;
1958     struct ofbundle *out;
1959     struct hmapx srcs;          /* Contains "struct ofbundle *"s. */
1960     struct hmapx dsts;          /* Contains "struct ofbundle *"s. */
1961     int out_vlan;
1962
1963     mirror = mirror_lookup(ofproto, aux);
1964     if (!s) {
1965         mirror_destroy(mirror);
1966         return 0;
1967     }
1968     if (!mirror) {
1969         int idx;
1970
1971         idx = mirror_scan(ofproto);
1972         if (idx < 0) {
1973             VLOG_WARN("bridge %s: maximum of %d port mirrors reached, "
1974                       "cannot create %s",
1975                       ofproto->up.name, MAX_MIRRORS, s->name);
1976             return EFBIG;
1977         }
1978
1979         mirror = ofproto->mirrors[idx] = xzalloc(sizeof *mirror);
1980         mirror->ofproto = ofproto;
1981         mirror->idx = idx;
1982         mirror->aux = aux;
1983         mirror->out_vlan = -1;
1984         mirror->name = NULL;
1985     }
1986
1987     if (!mirror->name || strcmp(s->name, mirror->name)) {
1988         free(mirror->name);
1989         mirror->name = xstrdup(s->name);
1990     }
1991
1992     /* Get the new configuration. */
1993     if (s->out_bundle) {
1994         out = bundle_lookup(ofproto, s->out_bundle);
1995         if (!out) {
1996             mirror_destroy(mirror);
1997             return EINVAL;
1998         }
1999         out_vlan = -1;
2000     } else {
2001         out = NULL;
2002         out_vlan = s->out_vlan;
2003     }
2004     bundle_lookup_multiple(ofproto, s->srcs, s->n_srcs, &srcs);
2005     bundle_lookup_multiple(ofproto, s->dsts, s->n_dsts, &dsts);
2006
2007     /* If the configuration has not changed, do nothing. */
2008     if (hmapx_equals(&srcs, &mirror->srcs)
2009         && hmapx_equals(&dsts, &mirror->dsts)
2010         && vlan_bitmap_equal(mirror->vlans, s->src_vlans)
2011         && mirror->out == out
2012         && mirror->out_vlan == out_vlan)
2013     {
2014         hmapx_destroy(&srcs);
2015         hmapx_destroy(&dsts);
2016         return 0;
2017     }
2018
2019     hmapx_swap(&srcs, &mirror->srcs);
2020     hmapx_destroy(&srcs);
2021
2022     hmapx_swap(&dsts, &mirror->dsts);
2023     hmapx_destroy(&dsts);
2024
2025     free(mirror->vlans);
2026     mirror->vlans = vlan_bitmap_clone(s->src_vlans);
2027
2028     mirror->out = out;
2029     mirror->out_vlan = out_vlan;
2030
2031     /* Update bundles. */
2032     mirror_bit = MIRROR_MASK_C(1) << mirror->idx;
2033     HMAP_FOR_EACH (bundle, hmap_node, &mirror->ofproto->bundles) {
2034         if (hmapx_contains(&mirror->srcs, bundle)) {
2035             bundle->src_mirrors |= mirror_bit;
2036         } else {
2037             bundle->src_mirrors &= ~mirror_bit;
2038         }
2039
2040         if (hmapx_contains(&mirror->dsts, bundle)) {
2041             bundle->dst_mirrors |= mirror_bit;
2042         } else {
2043             bundle->dst_mirrors &= ~mirror_bit;
2044         }
2045
2046         if (mirror->out == bundle) {
2047             bundle->mirror_out |= mirror_bit;
2048         } else {
2049             bundle->mirror_out &= ~mirror_bit;
2050         }
2051     }
2052
2053     ofproto->need_revalidate = true;
2054     mac_learning_flush(ofproto->ml);
2055     mirror_update_dups(ofproto);
2056
2057     return 0;
2058 }
2059
2060 static void
2061 mirror_destroy(struct ofmirror *mirror)
2062 {
2063     struct ofproto_dpif *ofproto;
2064     mirror_mask_t mirror_bit;
2065     struct ofbundle *bundle;
2066
2067     if (!mirror) {
2068         return;
2069     }
2070
2071     ofproto = mirror->ofproto;
2072     ofproto->need_revalidate = true;
2073     mac_learning_flush(ofproto->ml);
2074
2075     mirror_bit = MIRROR_MASK_C(1) << mirror->idx;
2076     HMAP_FOR_EACH (bundle, hmap_node, &ofproto->bundles) {
2077         bundle->src_mirrors &= ~mirror_bit;
2078         bundle->dst_mirrors &= ~mirror_bit;
2079         bundle->mirror_out &= ~mirror_bit;
2080     }
2081
2082     hmapx_destroy(&mirror->srcs);
2083     hmapx_destroy(&mirror->dsts);
2084     free(mirror->vlans);
2085
2086     ofproto->mirrors[mirror->idx] = NULL;
2087     free(mirror->name);
2088     free(mirror);
2089
2090     mirror_update_dups(ofproto);
2091 }
2092
2093 static int
2094 mirror_get_stats(struct ofproto *ofproto_, void *aux,
2095                  uint64_t *packets, uint64_t *bytes)
2096 {
2097     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
2098     struct ofmirror *mirror = mirror_lookup(ofproto, aux);
2099
2100     if (!mirror) {
2101         *packets = *bytes = UINT64_MAX;
2102         return 0;
2103     }
2104
2105     *packets = mirror->packet_count;
2106     *bytes = mirror->byte_count;
2107
2108     return 0;
2109 }
2110
2111 static int
2112 set_flood_vlans(struct ofproto *ofproto_, unsigned long *flood_vlans)
2113 {
2114     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
2115     if (mac_learning_set_flood_vlans(ofproto->ml, flood_vlans)) {
2116         ofproto->need_revalidate = true;
2117         mac_learning_flush(ofproto->ml);
2118     }
2119     return 0;
2120 }
2121
2122 static bool
2123 is_mirror_output_bundle(const struct ofproto *ofproto_, void *aux)
2124 {
2125     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
2126     struct ofbundle *bundle = bundle_lookup(ofproto, aux);
2127     return bundle && bundle->mirror_out != 0;
2128 }
2129
2130 static void
2131 forward_bpdu_changed(struct ofproto *ofproto_)
2132 {
2133     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
2134     /* Revalidate cached flows whenever forward_bpdu option changes. */
2135     ofproto->need_revalidate = true;
2136 }
2137 \f
2138 /* Ports. */
2139
2140 static struct ofport_dpif *
2141 get_ofp_port(struct ofproto_dpif *ofproto, uint16_t ofp_port)
2142 {
2143     struct ofport *ofport = ofproto_get_port(&ofproto->up, ofp_port);
2144     return ofport ? ofport_dpif_cast(ofport) : NULL;
2145 }
2146
2147 static struct ofport_dpif *
2148 get_odp_port(struct ofproto_dpif *ofproto, uint32_t odp_port)
2149 {
2150     return get_ofp_port(ofproto, odp_port_to_ofp_port(odp_port));
2151 }
2152
2153 static void
2154 ofproto_port_from_dpif_port(struct ofproto_port *ofproto_port,
2155                             struct dpif_port *dpif_port)
2156 {
2157     ofproto_port->name = dpif_port->name;
2158     ofproto_port->type = dpif_port->type;
2159     ofproto_port->ofp_port = odp_port_to_ofp_port(dpif_port->port_no);
2160 }
2161
2162 static void
2163 port_run(struct ofport_dpif *ofport)
2164 {
2165     bool enable = netdev_get_carrier(ofport->up.netdev);
2166
2167     if (ofport->cfm) {
2168         cfm_run(ofport->cfm);
2169
2170         if (cfm_should_send_ccm(ofport->cfm)) {
2171             struct ofpbuf packet;
2172
2173             ofpbuf_init(&packet, 0);
2174             cfm_compose_ccm(ofport->cfm, &packet, ofport->up.opp.hw_addr);
2175             send_packet(ofport, &packet);
2176             ofpbuf_uninit(&packet);
2177         }
2178
2179         enable = enable && !cfm_get_fault(ofport->cfm)
2180             && cfm_get_opup(ofport->cfm);
2181     }
2182
2183     if (ofport->bundle) {
2184         enable = enable && lacp_slave_may_enable(ofport->bundle->lacp, ofport);
2185     }
2186
2187     if (ofport->may_enable != enable) {
2188         struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofport->up.ofproto);
2189
2190         if (ofproto->has_bundle_action) {
2191             ofproto->need_revalidate = true;
2192         }
2193     }
2194
2195     ofport->may_enable = enable;
2196 }
2197
2198 static void
2199 port_wait(struct ofport_dpif *ofport)
2200 {
2201     if (ofport->cfm) {
2202         cfm_wait(ofport->cfm);
2203     }
2204 }
2205
2206 static int
2207 port_query_by_name(const struct ofproto *ofproto_, const char *devname,
2208                    struct ofproto_port *ofproto_port)
2209 {
2210     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
2211     struct dpif_port dpif_port;
2212     int error;
2213
2214     error = dpif_port_query_by_name(ofproto->dpif, devname, &dpif_port);
2215     if (!error) {
2216         ofproto_port_from_dpif_port(ofproto_port, &dpif_port);
2217     }
2218     return error;
2219 }
2220
2221 static int
2222 port_add(struct ofproto *ofproto_, struct netdev *netdev, uint16_t *ofp_portp)
2223 {
2224     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
2225     uint16_t odp_port;
2226     int error;
2227
2228     error = dpif_port_add(ofproto->dpif, netdev, &odp_port);
2229     if (!error) {
2230         *ofp_portp = odp_port_to_ofp_port(odp_port);
2231     }
2232     return error;
2233 }
2234
2235 static int
2236 port_del(struct ofproto *ofproto_, uint16_t ofp_port)
2237 {
2238     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
2239     int error;
2240
2241     error = dpif_port_del(ofproto->dpif, ofp_port_to_odp_port(ofp_port));
2242     if (!error) {
2243         struct ofport_dpif *ofport = get_ofp_port(ofproto, ofp_port);
2244         if (ofport) {
2245             /* The caller is going to close ofport->up.netdev.  If this is a
2246              * bonded port, then the bond is using that netdev, so remove it
2247              * from the bond.  The client will need to reconfigure everything
2248              * after deleting ports, so then the slave will get re-added. */
2249             bundle_remove(&ofport->up);
2250         }
2251     }
2252     return error;
2253 }
2254
2255 static int
2256 port_get_stats(const struct ofport *ofport_, struct netdev_stats *stats)
2257 {
2258     struct ofport_dpif *ofport = ofport_dpif_cast(ofport_);
2259     int error;
2260
2261     error = netdev_get_stats(ofport->up.netdev, stats);
2262
2263     if (!error && ofport->odp_port == OVSP_LOCAL) {
2264         struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofport->up.ofproto);
2265
2266         /* ofproto->stats.tx_packets represents packets that we created
2267          * internally and sent to some port (e.g. packets sent with
2268          * send_packet()).  Account for them as if they had come from
2269          * OFPP_LOCAL and got forwarded. */
2270
2271         if (stats->rx_packets != UINT64_MAX) {
2272             stats->rx_packets += ofproto->stats.tx_packets;
2273         }
2274
2275         if (stats->rx_bytes != UINT64_MAX) {
2276             stats->rx_bytes += ofproto->stats.tx_bytes;
2277         }
2278
2279         /* ofproto->stats.rx_packets represents packets that were received on
2280          * some port and we processed internally and dropped (e.g. STP).
2281          * Account fro them as if they had been forwarded to OFPP_LOCAL. */
2282
2283         if (stats->tx_packets != UINT64_MAX) {
2284             stats->tx_packets += ofproto->stats.rx_packets;
2285         }
2286
2287         if (stats->tx_bytes != UINT64_MAX) {
2288             stats->tx_bytes += ofproto->stats.rx_bytes;
2289         }
2290     }
2291
2292     return error;
2293 }
2294
2295 /* Account packets for LOCAL port. */
2296 static void
2297 ofproto_update_local_port_stats(const struct ofproto *ofproto_,
2298                                 size_t tx_size, size_t rx_size)
2299 {
2300     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
2301
2302     if (rx_size) {
2303         ofproto->stats.rx_packets++;
2304         ofproto->stats.rx_bytes += rx_size;
2305     }
2306     if (tx_size) {
2307         ofproto->stats.tx_packets++;
2308         ofproto->stats.tx_bytes += tx_size;
2309     }
2310 }
2311
2312 struct port_dump_state {
2313     struct dpif_port_dump dump;
2314     bool done;
2315 };
2316
2317 static int
2318 port_dump_start(const struct ofproto *ofproto_, void **statep)
2319 {
2320     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
2321     struct port_dump_state *state;
2322
2323     *statep = state = xmalloc(sizeof *state);
2324     dpif_port_dump_start(&state->dump, ofproto->dpif);
2325     state->done = false;
2326     return 0;
2327 }
2328
2329 static int
2330 port_dump_next(const struct ofproto *ofproto_ OVS_UNUSED, void *state_,
2331                struct ofproto_port *port)
2332 {
2333     struct port_dump_state *state = state_;
2334     struct dpif_port dpif_port;
2335
2336     if (dpif_port_dump_next(&state->dump, &dpif_port)) {
2337         ofproto_port_from_dpif_port(port, &dpif_port);
2338         return 0;
2339     } else {
2340         int error = dpif_port_dump_done(&state->dump);
2341         state->done = true;
2342         return error ? error : EOF;
2343     }
2344 }
2345
2346 static int
2347 port_dump_done(const struct ofproto *ofproto_ OVS_UNUSED, void *state_)
2348 {
2349     struct port_dump_state *state = state_;
2350
2351     if (!state->done) {
2352         dpif_port_dump_done(&state->dump);
2353     }
2354     free(state);
2355     return 0;
2356 }
2357
2358 static int
2359 port_poll(const struct ofproto *ofproto_, char **devnamep)
2360 {
2361     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
2362     return dpif_port_poll(ofproto->dpif, devnamep);
2363 }
2364
2365 static void
2366 port_poll_wait(const struct ofproto *ofproto_)
2367 {
2368     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
2369     dpif_port_poll_wait(ofproto->dpif);
2370 }
2371
2372 static int
2373 port_is_lacp_current(const struct ofport *ofport_)
2374 {
2375     const struct ofport_dpif *ofport = ofport_dpif_cast(ofport_);
2376     return (ofport->bundle && ofport->bundle->lacp
2377             ? lacp_slave_is_current(ofport->bundle->lacp, ofport)
2378             : -1);
2379 }
2380 \f
2381 /* Upcall handling. */
2382
2383 /* Flow miss batching.
2384  *
2385  * Some dpifs implement operations faster when you hand them off in a batch.
2386  * To allow batching, "struct flow_miss" queues the dpif-related work needed
2387  * for a given flow.  Each "struct flow_miss" corresponds to sending one or
2388  * more packets, plus possibly installing the flow in the dpif.
2389  *
2390  * So far we only batch the operations that affect flow setup time the most.
2391  * It's possible to batch more than that, but the benefit might be minimal. */
2392 struct flow_miss {
2393     struct hmap_node hmap_node;
2394     struct flow flow;
2395     enum odp_key_fitness key_fitness;
2396     const struct nlattr *key;
2397     size_t key_len;
2398     ovs_be16 initial_tci;
2399     struct list packets;
2400 };
2401
2402 struct flow_miss_op {
2403     union dpif_op dpif_op;
2404     struct subfacet *subfacet;
2405 };
2406
2407 /* Sends an OFPT_PACKET_IN message for 'packet' of type OFPR_NO_MATCH to each
2408  * OpenFlow controller as necessary according to their individual
2409  * configurations. */
2410 static void
2411 send_packet_in_miss(struct ofproto_dpif *ofproto, struct ofpbuf *packet,
2412                     const struct flow *flow)
2413 {
2414     struct ofputil_packet_in pin;
2415
2416     pin.packet = packet->data;
2417     pin.packet_len = packet->size;
2418     pin.total_len = packet->size;
2419     pin.reason = OFPR_NO_MATCH;
2420
2421     pin.table_id = 0;
2422     pin.cookie = 0;
2423
2424     pin.buffer_id = 0;          /* not yet known */
2425     pin.send_len = 0;           /* not used for flow table misses */
2426
2427     flow_get_metadata(flow, &pin.fmd);
2428
2429     /* Registers aren't meaningful on a miss. */
2430     memset(pin.fmd.reg_masks, 0, sizeof pin.fmd.reg_masks);
2431
2432     connmgr_send_packet_in(ofproto->up.connmgr, &pin, flow);
2433 }
2434
2435 static bool
2436 process_special(struct ofproto_dpif *ofproto, const struct flow *flow,
2437                 const struct ofpbuf *packet)
2438 {
2439     struct ofport_dpif *ofport = get_ofp_port(ofproto, flow->in_port);
2440
2441     if (!ofport) {
2442         return false;
2443     }
2444
2445     if (ofport->cfm && cfm_should_process_flow(ofport->cfm, flow)) {
2446         if (packet) {
2447             cfm_process_heartbeat(ofport->cfm, packet);
2448         }
2449         return true;
2450     } else if (ofport->bundle && ofport->bundle->lacp
2451                && flow->dl_type == htons(ETH_TYPE_LACP)) {
2452         if (packet) {
2453             lacp_process_packet(ofport->bundle->lacp, ofport, packet);
2454         }
2455         return true;
2456     } else if (ofproto->stp && stp_should_process_flow(flow)) {
2457         if (packet) {
2458             stp_process_packet(ofport, packet);
2459         }
2460         return true;
2461     }
2462     return false;
2463 }
2464
2465 static struct flow_miss *
2466 flow_miss_create(struct hmap *todo, const struct flow *flow,
2467                  enum odp_key_fitness key_fitness,
2468                  const struct nlattr *key, size_t key_len,
2469                  ovs_be16 initial_tci)
2470 {
2471     uint32_t hash = flow_hash(flow, 0);
2472     struct flow_miss *miss;
2473
2474     HMAP_FOR_EACH_WITH_HASH (miss, hmap_node, hash, todo) {
2475         if (flow_equal(&miss->flow, flow)) {
2476             return miss;
2477         }
2478     }
2479
2480     miss = xmalloc(sizeof *miss);
2481     hmap_insert(todo, &miss->hmap_node, hash);
2482     miss->flow = *flow;
2483     miss->key_fitness = key_fitness;
2484     miss->key = key;
2485     miss->key_len = key_len;
2486     miss->initial_tci = initial_tci;
2487     list_init(&miss->packets);
2488     return miss;
2489 }
2490
2491 static void
2492 handle_flow_miss(struct ofproto_dpif *ofproto, struct flow_miss *miss,
2493                  struct flow_miss_op *ops, size_t *n_ops)
2494 {
2495     const struct flow *flow = &miss->flow;
2496     struct ofpbuf *packet, *next_packet;
2497     struct subfacet *subfacet;
2498     struct facet *facet;
2499
2500     facet = facet_lookup_valid(ofproto, flow);
2501     if (!facet) {
2502         struct rule_dpif *rule;
2503
2504         rule = rule_dpif_lookup(ofproto, flow, 0);
2505         if (!rule) {
2506             /* Don't send a packet-in if OFPPC_NO_PACKET_IN asserted. */
2507             struct ofport_dpif *port = get_ofp_port(ofproto, flow->in_port);
2508             if (port) {
2509                 if (port->up.opp.config & htonl(OFPPC_NO_PACKET_IN)) {
2510                     COVERAGE_INC(ofproto_dpif_no_packet_in);
2511                     /* XXX install 'drop' flow entry */
2512                     return;
2513                 }
2514             } else {
2515                 VLOG_WARN_RL(&rl, "packet-in on unknown port %"PRIu16,
2516                              flow->in_port);
2517             }
2518
2519             LIST_FOR_EACH (packet, list_node, &miss->packets) {
2520                 send_packet_in_miss(ofproto, packet, flow);
2521             }
2522
2523             return;
2524         }
2525
2526         facet = facet_create(rule, flow);
2527     }
2528
2529     subfacet = subfacet_create(ofproto, facet,
2530                                miss->key_fitness, miss->key, miss->key_len,
2531                                miss->initial_tci);
2532
2533     LIST_FOR_EACH_SAFE (packet, next_packet, list_node, &miss->packets) {
2534         struct dpif_flow_stats stats;
2535         struct flow_miss_op *op;
2536         struct dpif_execute *execute;
2537
2538         list_remove(&packet->list_node);
2539         ofproto->n_matches++;
2540
2541         if (facet->rule->up.cr.priority == FAIL_OPEN_PRIORITY) {
2542             /*
2543              * Extra-special case for fail-open mode.
2544              *
2545              * We are in fail-open mode and the packet matched the fail-open
2546              * rule, but we are connected to a controller too.  We should send
2547              * the packet up to the controller in the hope that it will try to
2548              * set up a flow and thereby allow us to exit fail-open.
2549              *
2550              * See the top-level comment in fail-open.c for more information.
2551              */
2552             send_packet_in_miss(ofproto, packet, flow);
2553         }
2554
2555         if (!facet->may_install || !subfacet->actions) {
2556             subfacet_make_actions(ofproto, subfacet, packet);
2557         }
2558
2559         dpif_flow_stats_extract(&facet->flow, packet, &stats);
2560         subfacet_update_stats(ofproto, subfacet, &stats);
2561
2562         if (flow->vlan_tci != subfacet->initial_tci) {
2563             /* This packet was received on a VLAN splinter port.  We added
2564              * a VLAN to the packet to make the packet resemble the flow,
2565              * but the actions were composed assuming that the packet
2566              * contained no VLAN.  So, we must remove the VLAN header from
2567              * the packet before trying to execute the actions. */
2568             eth_pop_vlan(packet);
2569         }
2570
2571         op = &ops[(*n_ops)++];
2572         execute = &op->dpif_op.execute;
2573         op->subfacet = subfacet;
2574         execute->type = DPIF_OP_EXECUTE;
2575         execute->key = miss->key;
2576         execute->key_len = miss->key_len;
2577         execute->actions = (facet->may_install
2578                             ? subfacet->actions
2579                             : xmemdup(subfacet->actions,
2580                                       subfacet->actions_len));
2581         execute->actions_len = subfacet->actions_len;
2582         execute->packet = packet;
2583     }
2584
2585     if (facet->may_install && subfacet->key_fitness != ODP_FIT_TOO_LITTLE) {
2586         struct flow_miss_op *op = &ops[(*n_ops)++];
2587         struct dpif_flow_put *put = &op->dpif_op.flow_put;
2588
2589         op->subfacet = subfacet;
2590         put->type = DPIF_OP_FLOW_PUT;
2591         put->flags = DPIF_FP_CREATE | DPIF_FP_MODIFY;
2592         put->key = miss->key;
2593         put->key_len = miss->key_len;
2594         put->actions = subfacet->actions;
2595         put->actions_len = subfacet->actions_len;
2596         put->stats = NULL;
2597     }
2598 }
2599
2600 /* Like odp_flow_key_to_flow(), this function converts the 'key_len' bytes of
2601  * OVS_KEY_ATTR_* attributes in 'key' to a flow structure in 'flow' and returns
2602  * an ODP_FIT_* value that indicates how well 'key' fits our expectations for
2603  * what a flow key should contain.
2604  *
2605  * This function also includes some logic to help make VLAN splinters
2606  * transparent to the rest of the upcall processing logic.  In particular, if
2607  * the extracted in_port is a VLAN splinter port, it replaces flow->in_port by
2608  * the "real" port, sets flow->vlan_tci correctly for the VLAN of the VLAN
2609  * splinter port, and pushes a VLAN header onto 'packet' (if it is nonnull).
2610  *
2611  * Sets '*initial_tci' to the VLAN TCI with which the packet was really
2612  * received, that is, the actual VLAN TCI extracted by odp_flow_key_to_flow().
2613  * (This differs from the value returned in flow->vlan_tci only for packets
2614  * received on VLAN splinters.)
2615  */
2616 static enum odp_key_fitness
2617 ofproto_dpif_extract_flow_key(const struct ofproto_dpif *ofproto,
2618                               const struct nlattr *key, size_t key_len,
2619                               struct flow *flow, ovs_be16 *initial_tci,
2620                               struct ofpbuf *packet)
2621 {
2622     enum odp_key_fitness fitness;
2623     uint16_t realdev;
2624     int vid;
2625
2626     fitness = odp_flow_key_to_flow(key, key_len, flow);
2627     if (fitness == ODP_FIT_ERROR) {
2628         return fitness;
2629     }
2630     *initial_tci = flow->vlan_tci;
2631
2632     realdev = vsp_vlandev_to_realdev(ofproto, flow->in_port, &vid);
2633     if (realdev) {
2634         /* Cause the flow to be processed as if it came in on the real device
2635          * with the VLAN device's VLAN ID. */
2636         flow->in_port = realdev;
2637         flow->vlan_tci = htons((vid & VLAN_VID_MASK) | VLAN_CFI);
2638         if (packet) {
2639             /* Make the packet resemble the flow, so that it gets sent to an
2640              * OpenFlow controller properly, so that it looks correct for
2641              * sFlow, and so that flow_extract() will get the correct vlan_tci
2642              * if it is called on 'packet'.
2643              *
2644              * The allocated space inside 'packet' probably also contains
2645              * 'key', that is, both 'packet' and 'key' are probably part of a
2646              * struct dpif_upcall (see the large comment on that structure
2647              * definition), so pushing data on 'packet' is in general not a
2648              * good idea since it could overwrite 'key' or free it as a side
2649              * effect.  However, it's OK in this special case because we know
2650              * that 'packet' is inside a Netlink attribute: pushing 4 bytes
2651              * will just overwrite the 4-byte "struct nlattr", which is fine
2652              * since we don't need that header anymore. */
2653             eth_push_vlan(packet, flow->vlan_tci);
2654         }
2655
2656         /* Let the caller know that we can't reproduce 'key' from 'flow'. */
2657         if (fitness == ODP_FIT_PERFECT) {
2658             fitness = ODP_FIT_TOO_MUCH;
2659         }
2660     }
2661
2662     return fitness;
2663 }
2664
2665 static void
2666 handle_miss_upcalls(struct ofproto_dpif *ofproto, struct dpif_upcall *upcalls,
2667                     size_t n_upcalls)
2668 {
2669     struct dpif_upcall *upcall;
2670     struct flow_miss *miss, *next_miss;
2671     struct flow_miss_op flow_miss_ops[FLOW_MISS_MAX_BATCH * 2];
2672     union dpif_op *dpif_ops[FLOW_MISS_MAX_BATCH * 2];
2673     struct hmap todo;
2674     size_t n_ops;
2675     size_t i;
2676
2677     if (!n_upcalls) {
2678         return;
2679     }
2680
2681     /* Construct the to-do list.
2682      *
2683      * This just amounts to extracting the flow from each packet and sticking
2684      * the packets that have the same flow in the same "flow_miss" structure so
2685      * that we can process them together. */
2686     hmap_init(&todo);
2687     for (upcall = upcalls; upcall < &upcalls[n_upcalls]; upcall++) {
2688         enum odp_key_fitness fitness;
2689         struct flow_miss *miss;
2690         ovs_be16 initial_tci;
2691         struct flow flow;
2692
2693         /* Obtain metadata and check userspace/kernel agreement on flow match,
2694          * then set 'flow''s header pointers. */
2695         fitness = ofproto_dpif_extract_flow_key(ofproto,
2696                                                 upcall->key, upcall->key_len,
2697                                                 &flow, &initial_tci,
2698                                                 upcall->packet);
2699         if (fitness == ODP_FIT_ERROR) {
2700             ofpbuf_delete(upcall->packet);
2701             continue;
2702         }
2703         flow_extract(upcall->packet, flow.skb_priority, flow.tun_id,
2704                      flow.in_port, &flow);
2705
2706         /* Handle 802.1ag, LACP, and STP specially. */
2707         if (process_special(ofproto, &flow, upcall->packet)) {
2708             ofproto_update_local_port_stats(&ofproto->up,
2709                                             0, upcall->packet->size);
2710             ofpbuf_delete(upcall->packet);
2711             ofproto->n_matches++;
2712             continue;
2713         }
2714
2715         /* Add other packets to a to-do list. */
2716         miss = flow_miss_create(&todo, &flow, fitness,
2717                                 upcall->key, upcall->key_len, initial_tci);
2718         list_push_back(&miss->packets, &upcall->packet->list_node);
2719     }
2720
2721     /* Process each element in the to-do list, constructing the set of
2722      * operations to batch. */
2723     n_ops = 0;
2724     HMAP_FOR_EACH_SAFE (miss, next_miss, hmap_node, &todo) {
2725         handle_flow_miss(ofproto, miss, flow_miss_ops, &n_ops);
2726         ofpbuf_list_delete(&miss->packets);
2727         hmap_remove(&todo, &miss->hmap_node);
2728         free(miss);
2729     }
2730     assert(n_ops <= ARRAY_SIZE(flow_miss_ops));
2731     hmap_destroy(&todo);
2732
2733     /* Execute batch. */
2734     for (i = 0; i < n_ops; i++) {
2735         dpif_ops[i] = &flow_miss_ops[i].dpif_op;
2736     }
2737     dpif_operate(ofproto->dpif, dpif_ops, n_ops);
2738
2739     /* Free memory and update facets. */
2740     for (i = 0; i < n_ops; i++) {
2741         struct flow_miss_op *op = &flow_miss_ops[i];
2742         struct dpif_execute *execute;
2743         struct dpif_flow_put *put;
2744
2745         switch (op->dpif_op.type) {
2746         case DPIF_OP_EXECUTE:
2747             execute = &op->dpif_op.execute;
2748             if (op->subfacet->actions != execute->actions) {
2749                 free((struct nlattr *) execute->actions);
2750             }
2751             ofpbuf_delete((struct ofpbuf *) execute->packet);
2752             break;
2753
2754         case DPIF_OP_FLOW_PUT:
2755             put = &op->dpif_op.flow_put;
2756             if (!put->error) {
2757                 op->subfacet->installed = true;
2758             }
2759             break;
2760         }
2761     }
2762 }
2763
2764 static void
2765 handle_userspace_upcall(struct ofproto_dpif *ofproto,
2766                         struct dpif_upcall *upcall)
2767 {
2768     struct user_action_cookie cookie;
2769     enum odp_key_fitness fitness;
2770     ovs_be16 initial_tci;
2771     struct flow flow;
2772
2773     memcpy(&cookie, &upcall->userdata, sizeof(cookie));
2774
2775     fitness = ofproto_dpif_extract_flow_key(ofproto, upcall->key,
2776                                             upcall->key_len, &flow,
2777                                             &initial_tci, upcall->packet);
2778     if (fitness == ODP_FIT_ERROR) {
2779         ofpbuf_delete(upcall->packet);
2780         return;
2781     }
2782
2783     if (cookie.type == USER_ACTION_COOKIE_SFLOW) {
2784         if (ofproto->sflow) {
2785             dpif_sflow_received(ofproto->sflow, upcall->packet, &flow,
2786                                 &cookie);
2787         }
2788     } else {
2789         VLOG_WARN_RL(&rl, "invalid user cookie : 0x%"PRIx64, upcall->userdata);
2790     }
2791     ofpbuf_delete(upcall->packet);
2792 }
2793
2794 static int
2795 handle_upcalls(struct ofproto_dpif *ofproto, unsigned int max_batch)
2796 {
2797     struct dpif_upcall misses[FLOW_MISS_MAX_BATCH];
2798     int n_misses;
2799     int i;
2800
2801     assert (max_batch <= FLOW_MISS_MAX_BATCH);
2802
2803     n_misses = 0;
2804     for (i = 0; i < max_batch; i++) {
2805         struct dpif_upcall *upcall = &misses[n_misses];
2806         int error;
2807
2808         error = dpif_recv(ofproto->dpif, upcall);
2809         if (error) {
2810             break;
2811         }
2812
2813         switch (upcall->type) {
2814         case DPIF_UC_ACTION:
2815             handle_userspace_upcall(ofproto, upcall);
2816             break;
2817
2818         case DPIF_UC_MISS:
2819             /* Handle it later. */
2820             n_misses++;
2821             break;
2822
2823         case DPIF_N_UC_TYPES:
2824         default:
2825             VLOG_WARN_RL(&rl, "upcall has unexpected type %"PRIu32,
2826                          upcall->type);
2827             break;
2828         }
2829     }
2830
2831     handle_miss_upcalls(ofproto, misses, n_misses);
2832
2833     return i;
2834 }
2835 \f
2836 /* Flow expiration. */
2837
2838 static int subfacet_max_idle(const struct ofproto_dpif *);
2839 static void update_stats(struct ofproto_dpif *);
2840 static void rule_expire(struct rule_dpif *);
2841 static void expire_subfacets(struct ofproto_dpif *, int dp_max_idle);
2842
2843 /* This function is called periodically by run().  Its job is to collect
2844  * updates for the flows that have been installed into the datapath, most
2845  * importantly when they last were used, and then use that information to
2846  * expire flows that have not been used recently.
2847  *
2848  * Returns the number of milliseconds after which it should be called again. */
2849 static int
2850 expire(struct ofproto_dpif *ofproto)
2851 {
2852     struct rule_dpif *rule, *next_rule;
2853     struct classifier *table;
2854     int dp_max_idle;
2855
2856     /* Update stats for each flow in the datapath. */
2857     update_stats(ofproto);
2858
2859     /* Expire subfacets that have been idle too long. */
2860     dp_max_idle = subfacet_max_idle(ofproto);
2861     expire_subfacets(ofproto, dp_max_idle);
2862
2863     /* Expire OpenFlow flows whose idle_timeout or hard_timeout has passed. */
2864     OFPROTO_FOR_EACH_TABLE (table, &ofproto->up) {
2865         struct cls_cursor cursor;
2866
2867         cls_cursor_init(&cursor, table, NULL);
2868         CLS_CURSOR_FOR_EACH_SAFE (rule, next_rule, up.cr, &cursor) {
2869             rule_expire(rule);
2870         }
2871     }
2872
2873     /* All outstanding data in existing flows has been accounted, so it's a
2874      * good time to do bond rebalancing. */
2875     if (ofproto->has_bonded_bundles) {
2876         struct ofbundle *bundle;
2877
2878         HMAP_FOR_EACH (bundle, hmap_node, &ofproto->bundles) {
2879             if (bundle->bond) {
2880                 bond_rebalance(bundle->bond, &ofproto->revalidate_set);
2881             }
2882         }
2883     }
2884
2885     return MIN(dp_max_idle, 1000);
2886 }
2887
2888 /* Update 'packet_count', 'byte_count', and 'used' members of installed facets.
2889  *
2890  * This function also pushes statistics updates to rules which each facet
2891  * resubmits into.  Generally these statistics will be accurate.  However, if a
2892  * facet changes the rule it resubmits into at some time in between
2893  * update_stats() runs, it is possible that statistics accrued to the
2894  * old rule will be incorrectly attributed to the new rule.  This could be
2895  * avoided by calling update_stats() whenever rules are created or
2896  * deleted.  However, the performance impact of making so many calls to the
2897  * datapath do not justify the benefit of having perfectly accurate statistics.
2898  */
2899 static void
2900 update_stats(struct ofproto_dpif *p)
2901 {
2902     const struct dpif_flow_stats *stats;
2903     struct dpif_flow_dump dump;
2904     const struct nlattr *key;
2905     size_t key_len;
2906
2907     dpif_flow_dump_start(&dump, p->dpif);
2908     while (dpif_flow_dump_next(&dump, &key, &key_len, NULL, NULL, &stats)) {
2909         struct subfacet *subfacet;
2910
2911         subfacet = subfacet_find(p, key, key_len);
2912         if (subfacet && subfacet->installed) {
2913             struct facet *facet = subfacet->facet;
2914
2915             if (stats->n_packets >= subfacet->dp_packet_count) {
2916                 uint64_t extra = stats->n_packets - subfacet->dp_packet_count;
2917                 facet->packet_count += extra;
2918             } else {
2919                 VLOG_WARN_RL(&rl, "unexpected packet count from the datapath");
2920             }
2921
2922             if (stats->n_bytes >= subfacet->dp_byte_count) {
2923                 facet->byte_count += stats->n_bytes - subfacet->dp_byte_count;
2924             } else {
2925                 VLOG_WARN_RL(&rl, "unexpected byte count from datapath");
2926             }
2927
2928             subfacet->dp_packet_count = stats->n_packets;
2929             subfacet->dp_byte_count = stats->n_bytes;
2930
2931             subfacet_update_time(p, subfacet, stats->used);
2932             facet_account(p, facet);
2933             facet_push_stats(facet);
2934         } else {
2935             if (!VLOG_DROP_WARN(&rl)) {
2936                 struct ds s;
2937
2938                 ds_init(&s);
2939                 odp_flow_key_format(key, key_len, &s);
2940                 VLOG_WARN("unexpected flow from datapath %s", ds_cstr(&s));
2941                 ds_destroy(&s);
2942             }
2943
2944             COVERAGE_INC(facet_unexpected);
2945             /* There's a flow in the datapath that we know nothing about, or a
2946              * flow that shouldn't be installed but was anyway.  Delete it. */
2947             dpif_flow_del(p->dpif, key, key_len, NULL);
2948         }
2949     }
2950     dpif_flow_dump_done(&dump);
2951 }
2952
2953 /* Calculates and returns the number of milliseconds of idle time after which
2954  * subfacets should expire from the datapath.  When a subfacet expires, we fold
2955  * its statistics into its facet, and when a facet's last subfacet expires, we
2956  * fold its statistic into its rule. */
2957 static int
2958 subfacet_max_idle(const struct ofproto_dpif *ofproto)
2959 {
2960     /*
2961      * Idle time histogram.
2962      *
2963      * Most of the time a switch has a relatively small number of subfacets.
2964      * When this is the case we might as well keep statistics for all of them
2965      * in userspace and to cache them in the kernel datapath for performance as
2966      * well.
2967      *
2968      * As the number of subfacets increases, the memory required to maintain
2969      * statistics about them in userspace and in the kernel becomes
2970      * significant.  However, with a large number of subfacets it is likely
2971      * that only a few of them are "heavy hitters" that consume a large amount
2972      * of bandwidth.  At this point, only heavy hitters are worth caching in
2973      * the kernel and maintaining in userspaces; other subfacets we can
2974      * discard.
2975      *
2976      * The technique used to compute the idle time is to build a histogram with
2977      * N_BUCKETS buckets whose width is BUCKET_WIDTH msecs each.  Each subfacet
2978      * that is installed in the kernel gets dropped in the appropriate bucket.
2979      * After the histogram has been built, we compute the cutoff so that only
2980      * the most-recently-used 1% of subfacets (but at least
2981      * ofproto->up.flow_eviction_threshold flows) are kept cached.  At least
2982      * the most-recently-used bucket of subfacets is kept, so actually an
2983      * arbitrary number of subfacets can be kept in any given expiration run
2984      * (though the next run will delete most of those unless they receive
2985      * additional data).
2986      *
2987      * This requires a second pass through the subfacets, in addition to the
2988      * pass made by update_stats(), because the former function never looks at
2989      * uninstallable subfacets.
2990      */
2991     enum { BUCKET_WIDTH = ROUND_UP(100, TIME_UPDATE_INTERVAL) };
2992     enum { N_BUCKETS = 5000 / BUCKET_WIDTH };
2993     int buckets[N_BUCKETS] = { 0 };
2994     int total, subtotal, bucket;
2995     struct subfacet *subfacet;
2996     long long int now;
2997     int i;
2998
2999     total = hmap_count(&ofproto->subfacets);
3000     if (total <= ofproto->up.flow_eviction_threshold) {
3001         return N_BUCKETS * BUCKET_WIDTH;
3002     }
3003
3004     /* Build histogram. */
3005     now = time_msec();
3006     HMAP_FOR_EACH (subfacet, hmap_node, &ofproto->subfacets) {
3007         long long int idle = now - subfacet->used;
3008         int bucket = (idle <= 0 ? 0
3009                       : idle >= BUCKET_WIDTH * N_BUCKETS ? N_BUCKETS - 1
3010                       : (unsigned int) idle / BUCKET_WIDTH);
3011         buckets[bucket]++;
3012     }
3013
3014     /* Find the first bucket whose flows should be expired. */
3015     subtotal = bucket = 0;
3016     do {
3017         subtotal += buckets[bucket++];
3018     } while (bucket < N_BUCKETS &&
3019              subtotal < MAX(ofproto->up.flow_eviction_threshold, total / 100));
3020
3021     if (VLOG_IS_DBG_ENABLED()) {
3022         struct ds s;
3023
3024         ds_init(&s);
3025         ds_put_cstr(&s, "keep");
3026         for (i = 0; i < N_BUCKETS; i++) {
3027             if (i == bucket) {
3028                 ds_put_cstr(&s, ", drop");
3029             }
3030             if (buckets[i]) {
3031                 ds_put_format(&s, " %d:%d", i * BUCKET_WIDTH, buckets[i]);
3032             }
3033         }
3034         VLOG_INFO("%s: %s (msec:count)", ofproto->up.name, ds_cstr(&s));
3035         ds_destroy(&s);
3036     }
3037
3038     return bucket * BUCKET_WIDTH;
3039 }
3040
3041 static void
3042 expire_subfacets(struct ofproto_dpif *ofproto, int dp_max_idle)
3043 {
3044     long long int cutoff = time_msec() - dp_max_idle;
3045     struct subfacet *subfacet, *next_subfacet;
3046
3047     HMAP_FOR_EACH_SAFE (subfacet, next_subfacet, hmap_node,
3048                         &ofproto->subfacets) {
3049         if (subfacet->used < cutoff) {
3050             subfacet_destroy(ofproto, subfacet);
3051         }
3052     }
3053 }
3054
3055 /* If 'rule' is an OpenFlow rule, that has expired according to OpenFlow rules,
3056  * then delete it entirely. */
3057 static void
3058 rule_expire(struct rule_dpif *rule)
3059 {
3060     struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
3061     struct facet *facet, *next_facet;
3062     long long int now;
3063     uint8_t reason;
3064
3065     /* Has 'rule' expired? */
3066     now = time_msec();
3067     if (rule->up.hard_timeout
3068         && now > rule->up.modified + rule->up.hard_timeout * 1000) {
3069         reason = OFPRR_HARD_TIMEOUT;
3070     } else if (rule->up.idle_timeout && list_is_empty(&rule->facets)
3071                && now > rule->used + rule->up.idle_timeout * 1000) {
3072         reason = OFPRR_IDLE_TIMEOUT;
3073     } else {
3074         return;
3075     }
3076
3077     COVERAGE_INC(ofproto_dpif_expired);
3078
3079     /* Update stats.  (This is a no-op if the rule expired due to an idle
3080      * timeout, because that only happens when the rule has no facets left.) */
3081     LIST_FOR_EACH_SAFE (facet, next_facet, list_node, &rule->facets) {
3082         facet_remove(ofproto, facet);
3083     }
3084
3085     /* Get rid of the rule. */
3086     ofproto_rule_expire(&rule->up, reason);
3087 }
3088 \f
3089 /* Facets. */
3090
3091 /* Creates and returns a new facet owned by 'rule', given a 'flow'.
3092  *
3093  * The caller must already have determined that no facet with an identical
3094  * 'flow' exists in 'ofproto' and that 'flow' is the best match for 'rule' in
3095  * the ofproto's classifier table.
3096  *
3097  * The facet will initially have no subfacets.  The caller should create (at
3098  * least) one subfacet with subfacet_create(). */
3099 static struct facet *
3100 facet_create(struct rule_dpif *rule, const struct flow *flow)
3101 {
3102     struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
3103     struct facet *facet;
3104
3105     facet = xzalloc(sizeof *facet);
3106     facet->used = time_msec();
3107     hmap_insert(&ofproto->facets, &facet->hmap_node, flow_hash(flow, 0));
3108     list_push_back(&rule->facets, &facet->list_node);
3109     facet->rule = rule;
3110     facet->flow = *flow;
3111     list_init(&facet->subfacets);
3112     netflow_flow_init(&facet->nf_flow);
3113     netflow_flow_update_time(ofproto->netflow, &facet->nf_flow, facet->used);
3114
3115     return facet;
3116 }
3117
3118 static void
3119 facet_free(struct facet *facet)
3120 {
3121     free(facet);
3122 }
3123
3124 /* Executes, within 'ofproto', the 'n_actions' actions in 'actions' on
3125  * 'packet', which arrived on 'in_port'.
3126  *
3127  * Takes ownership of 'packet'. */
3128 static bool
3129 execute_odp_actions(struct ofproto_dpif *ofproto, const struct flow *flow,
3130                     const struct nlattr *odp_actions, size_t actions_len,
3131                     struct ofpbuf *packet)
3132 {
3133     struct odputil_keybuf keybuf;
3134     struct ofpbuf key;
3135     int error;
3136
3137     ofpbuf_use_stack(&key, &keybuf, sizeof keybuf);
3138     odp_flow_key_from_flow(&key, flow);
3139
3140     error = dpif_execute(ofproto->dpif, key.data, key.size,
3141                          odp_actions, actions_len, packet);
3142
3143     ofpbuf_delete(packet);
3144     return !error;
3145 }
3146
3147 /* Remove 'facet' from 'ofproto' and free up the associated memory:
3148  *
3149  *   - If 'facet' was installed in the datapath, uninstalls it and updates its
3150  *     rule's statistics, via subfacet_uninstall().
3151  *
3152  *   - Removes 'facet' from its rule and from ofproto->facets.
3153  */
3154 static void
3155 facet_remove(struct ofproto_dpif *ofproto, struct facet *facet)
3156 {
3157     struct subfacet *subfacet, *next_subfacet;
3158
3159     assert(!list_is_empty(&facet->subfacets));
3160
3161     /* First uninstall all of the subfacets to get final statistics. */
3162     LIST_FOR_EACH (subfacet, list_node, &facet->subfacets) {
3163         subfacet_uninstall(ofproto, subfacet);
3164     }
3165
3166     /* Flush the final stats to the rule.
3167      *
3168      * This might require us to have at least one subfacet around so that we
3169      * can use its actions for accounting in facet_account(), which is why we
3170      * have uninstalled but not yet destroyed the subfacets. */
3171     facet_flush_stats(ofproto, facet);
3172
3173     /* Now we're really all done so destroy everything. */
3174     LIST_FOR_EACH_SAFE (subfacet, next_subfacet, list_node,
3175                         &facet->subfacets) {
3176         subfacet_destroy__(ofproto, subfacet);
3177     }
3178     hmap_remove(&ofproto->facets, &facet->hmap_node);
3179     list_remove(&facet->list_node);
3180     facet_free(facet);
3181 }
3182
3183 static void
3184 facet_account(struct ofproto_dpif *ofproto, struct facet *facet)
3185 {
3186     uint64_t n_bytes;
3187     struct subfacet *subfacet;
3188     const struct nlattr *a;
3189     unsigned int left;
3190     ovs_be16 vlan_tci;
3191
3192     if (facet->byte_count <= facet->accounted_bytes) {
3193         return;
3194     }
3195     n_bytes = facet->byte_count - facet->accounted_bytes;
3196     facet->accounted_bytes = facet->byte_count;
3197
3198     /* Feed information from the active flows back into the learning table to
3199      * ensure that table is always in sync with what is actually flowing
3200      * through the datapath. */
3201     if (facet->has_learn || facet->has_normal) {
3202         struct action_xlate_ctx ctx;
3203
3204         action_xlate_ctx_init(&ctx, ofproto, &facet->flow,
3205                               facet->flow.vlan_tci,
3206                               facet->rule->up.flow_cookie, NULL);
3207         ctx.may_learn = true;
3208         ofpbuf_delete(xlate_actions(&ctx, facet->rule->up.actions,
3209                                     facet->rule->up.n_actions));
3210     }
3211
3212     if (!facet->has_normal || !ofproto->has_bonded_bundles) {
3213         return;
3214     }
3215
3216     /* This loop feeds byte counters to bond_account() for rebalancing to use
3217      * as a basis.  We also need to track the actual VLAN on which the packet
3218      * is going to be sent to ensure that it matches the one passed to
3219      * bond_choose_output_slave().  (Otherwise, we will account to the wrong
3220      * hash bucket.)
3221      *
3222      * We use the actions from an arbitrary subfacet because they should all
3223      * be equally valid for our purpose. */
3224     subfacet = CONTAINER_OF(list_front(&facet->subfacets),
3225                             struct subfacet, list_node);
3226     vlan_tci = facet->flow.vlan_tci;
3227     NL_ATTR_FOR_EACH_UNSAFE (a, left,
3228                              subfacet->actions, subfacet->actions_len) {
3229         const struct ovs_action_push_vlan *vlan;
3230         struct ofport_dpif *port;
3231
3232         switch (nl_attr_type(a)) {
3233         case OVS_ACTION_ATTR_OUTPUT:
3234             port = get_odp_port(ofproto, nl_attr_get_u32(a));
3235             if (port && port->bundle && port->bundle->bond) {
3236                 bond_account(port->bundle->bond, &facet->flow,
3237                              vlan_tci_to_vid(vlan_tci), n_bytes);
3238             }
3239             break;
3240
3241         case OVS_ACTION_ATTR_POP_VLAN:
3242             vlan_tci = htons(0);
3243             break;
3244
3245         case OVS_ACTION_ATTR_PUSH_VLAN:
3246             vlan = nl_attr_get(a);
3247             vlan_tci = vlan->vlan_tci;
3248             break;
3249         }
3250     }
3251 }
3252
3253 /* Returns true if the only action for 'facet' is to send to the controller.
3254  * (We don't report NetFlow expiration messages for such facets because they
3255  * are just part of the control logic for the network, not real traffic). */
3256 static bool
3257 facet_is_controller_flow(struct facet *facet)
3258 {
3259     return (facet
3260             && facet->rule->up.n_actions == 1
3261             && action_outputs_to_port(&facet->rule->up.actions[0],
3262                                       htons(OFPP_CONTROLLER)));
3263 }
3264
3265 /* Folds all of 'facet''s statistics into its rule.  Also updates the
3266  * accounting ofhook and emits a NetFlow expiration if appropriate.  All of
3267  * 'facet''s statistics in the datapath should have been zeroed and folded into
3268  * its packet and byte counts before this function is called. */
3269 static void
3270 facet_flush_stats(struct ofproto_dpif *ofproto, struct facet *facet)
3271 {
3272     struct subfacet *subfacet;
3273
3274     LIST_FOR_EACH (subfacet, list_node, &facet->subfacets) {
3275         assert(!subfacet->dp_byte_count);
3276         assert(!subfacet->dp_packet_count);
3277     }
3278
3279     facet_push_stats(facet);
3280     facet_account(ofproto, facet);
3281
3282     if (ofproto->netflow && !facet_is_controller_flow(facet)) {
3283         struct ofexpired expired;
3284         expired.flow = facet->flow;
3285         expired.packet_count = facet->packet_count;
3286         expired.byte_count = facet->byte_count;
3287         expired.used = facet->used;
3288         netflow_expire(ofproto->netflow, &facet->nf_flow, &expired);
3289     }
3290
3291     facet->rule->packet_count += facet->packet_count;
3292     facet->rule->byte_count += facet->byte_count;
3293
3294     /* Reset counters to prevent double counting if 'facet' ever gets
3295      * reinstalled. */
3296     facet_reset_counters(facet);
3297
3298     netflow_flow_clear(&facet->nf_flow);
3299 }
3300
3301 /* Searches 'ofproto''s table of facets for one exactly equal to 'flow'.
3302  * Returns it if found, otherwise a null pointer.
3303  *
3304  * The returned facet might need revalidation; use facet_lookup_valid()
3305  * instead if that is important. */
3306 static struct facet *
3307 facet_find(struct ofproto_dpif *ofproto, const struct flow *flow)
3308 {
3309     struct facet *facet;
3310
3311     HMAP_FOR_EACH_WITH_HASH (facet, hmap_node, flow_hash(flow, 0),
3312                              &ofproto->facets) {
3313         if (flow_equal(flow, &facet->flow)) {
3314             return facet;
3315         }
3316     }
3317
3318     return NULL;
3319 }
3320
3321 /* Searches 'ofproto''s table of facets for one exactly equal to 'flow'.
3322  * Returns it if found, otherwise a null pointer.
3323  *
3324  * The returned facet is guaranteed to be valid. */
3325 static struct facet *
3326 facet_lookup_valid(struct ofproto_dpif *ofproto, const struct flow *flow)
3327 {
3328     struct facet *facet = facet_find(ofproto, flow);
3329
3330     /* The facet we found might not be valid, since we could be in need of
3331      * revalidation.  If it is not valid, don't return it. */
3332     if (facet
3333         && (ofproto->need_revalidate
3334             || tag_set_intersects(&ofproto->revalidate_set, facet->tags))
3335         && !facet_revalidate(ofproto, facet)) {
3336         COVERAGE_INC(facet_invalidated);
3337         return NULL;
3338     }
3339
3340     return facet;
3341 }
3342
3343 /* Re-searches 'ofproto''s classifier for a rule matching 'facet':
3344  *
3345  *   - If the rule found is different from 'facet''s current rule, moves
3346  *     'facet' to the new rule and recompiles its actions.
3347  *
3348  *   - If the rule found is the same as 'facet''s current rule, leaves 'facet'
3349  *     where it is and recompiles its actions anyway.
3350  *
3351  *   - If there is none, destroys 'facet'.
3352  *
3353  * Returns true if 'facet' still exists, false if it has been destroyed. */
3354 static bool
3355 facet_revalidate(struct ofproto_dpif *ofproto, struct facet *facet)
3356 {
3357     struct actions {
3358         struct nlattr *odp_actions;
3359         size_t actions_len;
3360     };
3361     struct actions *new_actions;
3362
3363     struct action_xlate_ctx ctx;
3364     struct rule_dpif *new_rule;
3365     struct subfacet *subfacet;
3366     bool actions_changed;
3367     int i;
3368
3369     COVERAGE_INC(facet_revalidate);
3370
3371     /* Determine the new rule. */
3372     new_rule = rule_dpif_lookup(ofproto, &facet->flow, 0);
3373     if (!new_rule) {
3374         /* No new rule, so delete the facet. */
3375         facet_remove(ofproto, facet);
3376         return false;
3377     }
3378
3379     /* Calculate new datapath actions.
3380      *
3381      * We do not modify any 'facet' state yet, because we might need to, e.g.,
3382      * emit a NetFlow expiration and, if so, we need to have the old state
3383      * around to properly compose it. */
3384
3385     /* If the datapath actions changed or the installability changed,
3386      * then we need to talk to the datapath. */
3387     i = 0;
3388     new_actions = NULL;
3389     memset(&ctx, 0, sizeof ctx);
3390     LIST_FOR_EACH (subfacet, list_node, &facet->subfacets) {
3391         struct ofpbuf *odp_actions;
3392         bool should_install;
3393
3394         action_xlate_ctx_init(&ctx, ofproto, &facet->flow,
3395                               subfacet->initial_tci, new_rule->up.flow_cookie,
3396                               NULL);
3397         odp_actions = xlate_actions(&ctx, new_rule->up.actions,
3398                                     new_rule->up.n_actions);
3399         actions_changed = (subfacet->actions_len != odp_actions->size
3400                            || memcmp(subfacet->actions, odp_actions->data,
3401                                      subfacet->actions_len));
3402
3403         should_install = (ctx.may_set_up_flow
3404                           && subfacet->key_fitness != ODP_FIT_TOO_LITTLE);
3405         if (actions_changed || should_install != subfacet->installed) {
3406             if (should_install) {
3407                 struct dpif_flow_stats stats;
3408
3409                 subfacet_install(ofproto, subfacet,
3410                                  odp_actions->data, odp_actions->size, &stats);
3411                 subfacet_update_stats(ofproto, subfacet, &stats);
3412             } else {
3413                 subfacet_uninstall(ofproto, subfacet);
3414             }
3415
3416             if (!new_actions) {
3417                 new_actions = xcalloc(list_size(&facet->subfacets),
3418                                       sizeof *new_actions);
3419             }
3420             new_actions[i].odp_actions = xmemdup(odp_actions->data,
3421                                                  odp_actions->size);
3422             new_actions[i].actions_len = odp_actions->size;
3423         }
3424
3425         ofpbuf_delete(odp_actions);
3426         i++;
3427     }
3428     if (new_actions) {
3429         facet_flush_stats(ofproto, facet);
3430     }
3431
3432     /* Update 'facet' now that we've taken care of all the old state. */
3433     facet->tags = ctx.tags;
3434     facet->nf_flow.output_iface = ctx.nf_output_iface;
3435     facet->may_install = ctx.may_set_up_flow;
3436     facet->has_learn = ctx.has_learn;
3437     facet->has_normal = ctx.has_normal;
3438     facet->mirrors = ctx.mirrors;
3439     if (new_actions) {
3440         i = 0;
3441         LIST_FOR_EACH (subfacet, list_node, &facet->subfacets) {
3442             if (new_actions[i].odp_actions) {
3443                 free(subfacet->actions);
3444                 subfacet->actions = new_actions[i].odp_actions;
3445                 subfacet->actions_len = new_actions[i].actions_len;
3446             }
3447             i++;
3448         }
3449         free(new_actions);
3450     }
3451     if (facet->rule != new_rule) {
3452         COVERAGE_INC(facet_changed_rule);
3453         list_remove(&facet->list_node);
3454         list_push_back(&new_rule->facets, &facet->list_node);
3455         facet->rule = new_rule;
3456         facet->used = new_rule->up.created;
3457         facet->prev_used = facet->used;
3458     }
3459
3460     return true;
3461 }
3462
3463 /* Updates 'facet''s used time.  Caller is responsible for calling
3464  * facet_push_stats() to update the flows which 'facet' resubmits into. */
3465 static void
3466 facet_update_time(struct ofproto_dpif *ofproto, struct facet *facet,
3467                   long long int used)
3468 {
3469     if (used > facet->used) {
3470         facet->used = used;
3471         if (used > facet->rule->used) {
3472             facet->rule->used = used;
3473         }
3474         netflow_flow_update_time(ofproto->netflow, &facet->nf_flow, used);
3475     }
3476 }
3477
3478 static void
3479 facet_reset_counters(struct facet *facet)
3480 {
3481     facet->packet_count = 0;
3482     facet->byte_count = 0;
3483     facet->prev_packet_count = 0;
3484     facet->prev_byte_count = 0;
3485     facet->accounted_bytes = 0;
3486 }
3487
3488 static void
3489 facet_push_stats(struct facet *facet)
3490 {
3491     uint64_t new_packets, new_bytes;
3492
3493     assert(facet->packet_count >= facet->prev_packet_count);
3494     assert(facet->byte_count >= facet->prev_byte_count);
3495     assert(facet->used >= facet->prev_used);
3496
3497     new_packets = facet->packet_count - facet->prev_packet_count;
3498     new_bytes = facet->byte_count - facet->prev_byte_count;
3499
3500     if (new_packets || new_bytes || facet->used > facet->prev_used) {
3501         facet->prev_packet_count = facet->packet_count;
3502         facet->prev_byte_count = facet->byte_count;
3503         facet->prev_used = facet->used;
3504
3505         flow_push_stats(facet->rule, &facet->flow,
3506                         new_packets, new_bytes, facet->used);
3507
3508         update_mirror_stats(ofproto_dpif_cast(facet->rule->up.ofproto),
3509                             facet->mirrors, new_packets, new_bytes);
3510     }
3511 }
3512
3513 struct ofproto_push {
3514     struct action_xlate_ctx ctx;
3515     uint64_t packets;
3516     uint64_t bytes;
3517     long long int used;
3518 };
3519
3520 static void
3521 push_resubmit(struct action_xlate_ctx *ctx, struct rule_dpif *rule)
3522 {
3523     struct ofproto_push *push = CONTAINER_OF(ctx, struct ofproto_push, ctx);
3524
3525     if (rule) {
3526         rule->packet_count += push->packets;
3527         rule->byte_count += push->bytes;
3528         rule->used = MAX(push->used, rule->used);
3529     }
3530 }
3531
3532 /* Pushes flow statistics to the rules which 'flow' resubmits into given
3533  * 'rule''s actions and mirrors. */
3534 static void
3535 flow_push_stats(const struct rule_dpif *rule,
3536                 const struct flow *flow, uint64_t packets, uint64_t bytes,
3537                 long long int used)
3538 {
3539     struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
3540     struct ofproto_push push;
3541
3542     push.packets = packets;
3543     push.bytes = bytes;
3544     push.used = used;
3545
3546     action_xlate_ctx_init(&push.ctx, ofproto, flow, flow->vlan_tci,
3547                           rule->up.flow_cookie, NULL);
3548     push.ctx.resubmit_hook = push_resubmit;
3549     ofpbuf_delete(xlate_actions(&push.ctx,
3550                                 rule->up.actions, rule->up.n_actions));
3551 }
3552 \f
3553 /* Subfacets. */
3554
3555 static struct subfacet *
3556 subfacet_find__(struct ofproto_dpif *ofproto,
3557                 const struct nlattr *key, size_t key_len, uint32_t key_hash,
3558                 const struct flow *flow)
3559 {
3560     struct subfacet *subfacet;
3561
3562     HMAP_FOR_EACH_WITH_HASH (subfacet, hmap_node, key_hash,
3563                              &ofproto->subfacets) {
3564         if (subfacet->key
3565             ? (subfacet->key_len == key_len
3566                && !memcmp(key, subfacet->key, key_len))
3567             : flow_equal(flow, &subfacet->facet->flow)) {
3568             return subfacet;
3569         }
3570     }
3571
3572     return NULL;
3573 }
3574
3575 /* Searches 'facet' (within 'ofproto') for a subfacet with the specified
3576  * 'key_fitness', 'key', and 'key_len'.  Returns the existing subfacet if
3577  * there is one, otherwise creates and returns a new subfacet.
3578  *
3579  * If the returned subfacet is new, then subfacet->actions will be NULL, in
3580  * which case the caller must populate the actions with
3581  * subfacet_make_actions(). */
3582 static struct subfacet *
3583 subfacet_create(struct ofproto_dpif *ofproto, struct facet *facet,
3584                 enum odp_key_fitness key_fitness,
3585                 const struct nlattr *key, size_t key_len, ovs_be16 initial_tci)
3586 {
3587     uint32_t key_hash = odp_flow_key_hash(key, key_len);
3588     struct subfacet *subfacet;
3589
3590     subfacet = subfacet_find__(ofproto, key, key_len, key_hash, &facet->flow);
3591     if (subfacet) {
3592         if (subfacet->facet == facet) {
3593             return subfacet;
3594         }
3595
3596         /* This shouldn't happen. */
3597         VLOG_ERR_RL(&rl, "subfacet with wrong facet");
3598         subfacet_destroy(ofproto, subfacet);
3599     }
3600
3601     subfacet = xzalloc(sizeof *subfacet);
3602     hmap_insert(&ofproto->subfacets, &subfacet->hmap_node, key_hash);
3603     list_push_back(&facet->subfacets, &subfacet->list_node);
3604     subfacet->facet = facet;
3605     subfacet->used = time_msec();
3606     subfacet->key_fitness = key_fitness;
3607     if (key_fitness != ODP_FIT_PERFECT) {
3608         subfacet->key = xmemdup(key, key_len);
3609         subfacet->key_len = key_len;
3610     }
3611     subfacet->installed = false;
3612     subfacet->initial_tci = initial_tci;
3613
3614     return subfacet;
3615 }
3616
3617 /* Searches 'ofproto' for a subfacet with the given 'key', 'key_len', and
3618  * 'flow'.  Returns the subfacet if one exists, otherwise NULL. */
3619 static struct subfacet *
3620 subfacet_find(struct ofproto_dpif *ofproto,
3621               const struct nlattr *key, size_t key_len)
3622 {
3623     uint32_t key_hash = odp_flow_key_hash(key, key_len);
3624     enum odp_key_fitness fitness;
3625     struct flow flow;
3626
3627     fitness = odp_flow_key_to_flow(key, key_len, &flow);
3628     if (fitness == ODP_FIT_ERROR) {
3629         return NULL;
3630     }
3631
3632     return subfacet_find__(ofproto, key, key_len, key_hash, &flow);
3633 }
3634
3635 /* Uninstalls 'subfacet' from the datapath, if it is installed, removes it from
3636  * its facet within 'ofproto', and frees it. */
3637 static void
3638 subfacet_destroy__(struct ofproto_dpif *ofproto, struct subfacet *subfacet)
3639 {
3640     subfacet_uninstall(ofproto, subfacet);
3641     hmap_remove(&ofproto->subfacets, &subfacet->hmap_node);
3642     list_remove(&subfacet->list_node);
3643     free(subfacet->key);
3644     free(subfacet->actions);
3645     free(subfacet);
3646 }
3647
3648 /* Destroys 'subfacet', as with subfacet_destroy__(), and then if this was the
3649  * last remaining subfacet in its facet destroys the facet too. */
3650 static void
3651 subfacet_destroy(struct ofproto_dpif *ofproto, struct subfacet *subfacet)
3652 {
3653     struct facet *facet = subfacet->facet;
3654
3655     if (list_is_singleton(&facet->subfacets)) {
3656         /* facet_remove() needs at least one subfacet (it will remove it). */
3657         facet_remove(ofproto, facet);
3658     } else {
3659         subfacet_destroy__(ofproto, subfacet);
3660     }
3661 }
3662
3663 /* Initializes 'key' with the sequence of OVS_KEY_ATTR_* Netlink attributes
3664  * that can be used to refer to 'subfacet'.  The caller must provide 'keybuf'
3665  * for use as temporary storage. */
3666 static void
3667 subfacet_get_key(struct subfacet *subfacet, struct odputil_keybuf *keybuf,
3668                  struct ofpbuf *key)
3669 {
3670     if (!subfacet->key) {
3671         ofpbuf_use_stack(key, keybuf, sizeof *keybuf);
3672         odp_flow_key_from_flow(key, &subfacet->facet->flow);
3673     } else {
3674         ofpbuf_use_const(key, subfacet->key, subfacet->key_len);
3675     }
3676 }
3677
3678 /* Composes the datapath actions for 'subfacet' based on its rule's actions. */
3679 static void
3680 subfacet_make_actions(struct ofproto_dpif *p, struct subfacet *subfacet,
3681                       const struct ofpbuf *packet)
3682 {
3683     struct facet *facet = subfacet->facet;
3684     const struct rule_dpif *rule = facet->rule;
3685     struct ofpbuf *odp_actions;
3686     struct action_xlate_ctx ctx;
3687
3688     action_xlate_ctx_init(&ctx, p, &facet->flow, subfacet->initial_tci,
3689                           rule->up.flow_cookie, packet);
3690     odp_actions = xlate_actions(&ctx, rule->up.actions, rule->up.n_actions);
3691     facet->tags = ctx.tags;
3692     facet->may_install = ctx.may_set_up_flow;
3693     facet->has_learn = ctx.has_learn;
3694     facet->has_normal = ctx.has_normal;
3695     facet->nf_flow.output_iface = ctx.nf_output_iface;
3696     facet->mirrors = ctx.mirrors;
3697
3698     if (subfacet->actions_len != odp_actions->size
3699         || memcmp(subfacet->actions, odp_actions->data, odp_actions->size)) {
3700         free(subfacet->actions);
3701         subfacet->actions_len = odp_actions->size;
3702         subfacet->actions = xmemdup(odp_actions->data, odp_actions->size);
3703     }
3704
3705     ofpbuf_delete(odp_actions);
3706 }
3707
3708 /* Updates 'subfacet''s datapath flow, setting its actions to 'actions_len'
3709  * bytes of actions in 'actions'.  If 'stats' is non-null, statistics counters
3710  * in the datapath will be zeroed and 'stats' will be updated with traffic new
3711  * since 'subfacet' was last updated.
3712  *
3713  * Returns 0 if successful, otherwise a positive errno value. */
3714 static int
3715 subfacet_install(struct ofproto_dpif *ofproto, struct subfacet *subfacet,
3716                  const struct nlattr *actions, size_t actions_len,
3717                  struct dpif_flow_stats *stats)
3718 {
3719     struct odputil_keybuf keybuf;
3720     enum dpif_flow_put_flags flags;
3721     struct ofpbuf key;
3722     int ret;
3723
3724     flags = DPIF_FP_CREATE | DPIF_FP_MODIFY;
3725     if (stats) {
3726         flags |= DPIF_FP_ZERO_STATS;
3727     }
3728
3729     subfacet_get_key(subfacet, &keybuf, &key);
3730     ret = dpif_flow_put(ofproto->dpif, flags, key.data, key.size,
3731                         actions, actions_len, stats);
3732
3733     if (stats) {
3734         subfacet_reset_dp_stats(subfacet, stats);
3735     }
3736
3737     return ret;
3738 }
3739
3740 /* If 'subfacet' is installed in the datapath, uninstalls it. */
3741 static void
3742 subfacet_uninstall(struct ofproto_dpif *p, struct subfacet *subfacet)
3743 {
3744     if (subfacet->installed) {
3745         struct odputil_keybuf keybuf;
3746         struct dpif_flow_stats stats;
3747         struct ofpbuf key;
3748         int error;
3749
3750         subfacet_get_key(subfacet, &keybuf, &key);
3751         error = dpif_flow_del(p->dpif, key.data, key.size, &stats);
3752         subfacet_reset_dp_stats(subfacet, &stats);
3753         if (!error) {
3754             subfacet_update_stats(p, subfacet, &stats);
3755         }
3756         subfacet->installed = false;
3757     } else {
3758         assert(subfacet->dp_packet_count == 0);
3759         assert(subfacet->dp_byte_count == 0);
3760     }
3761 }
3762
3763 /* Resets 'subfacet''s datapath statistics counters.  This should be called
3764  * when 'subfacet''s statistics are cleared in the datapath.  If 'stats' is
3765  * non-null, it should contain the statistics returned by dpif when 'subfacet'
3766  * was reset in the datapath.  'stats' will be modified to include only
3767  * statistics new since 'subfacet' was last updated. */
3768 static void
3769 subfacet_reset_dp_stats(struct subfacet *subfacet,
3770                         struct dpif_flow_stats *stats)
3771 {
3772     if (stats
3773         && subfacet->dp_packet_count <= stats->n_packets
3774         && subfacet->dp_byte_count <= stats->n_bytes) {
3775         stats->n_packets -= subfacet->dp_packet_count;
3776         stats->n_bytes -= subfacet->dp_byte_count;
3777     }
3778
3779     subfacet->dp_packet_count = 0;
3780     subfacet->dp_byte_count = 0;
3781 }
3782
3783 /* Updates 'subfacet''s used time.  The caller is responsible for calling
3784  * facet_push_stats() to update the flows which 'subfacet' resubmits into. */
3785 static void
3786 subfacet_update_time(struct ofproto_dpif *ofproto, struct subfacet *subfacet,
3787                      long long int used)
3788 {
3789     if (used > subfacet->used) {
3790         subfacet->used = used;
3791         facet_update_time(ofproto, subfacet->facet, used);
3792     }
3793 }
3794
3795 /* Folds the statistics from 'stats' into the counters in 'subfacet'.
3796  *
3797  * Because of the meaning of a subfacet's counters, it only makes sense to do
3798  * this if 'stats' are not tracked in the datapath, that is, if 'stats'
3799  * represents a packet that was sent by hand or if it represents statistics
3800  * that have been cleared out of the datapath. */
3801 static void
3802 subfacet_update_stats(struct ofproto_dpif *ofproto, struct subfacet *subfacet,
3803                       const struct dpif_flow_stats *stats)
3804 {
3805     if (stats->n_packets || stats->used > subfacet->used) {
3806         struct facet *facet = subfacet->facet;
3807
3808         subfacet_update_time(ofproto, subfacet, stats->used);
3809         facet->packet_count += stats->n_packets;
3810         facet->byte_count += stats->n_bytes;
3811         facet_push_stats(facet);
3812         netflow_flow_update_flags(&facet->nf_flow, stats->tcp_flags);
3813     }
3814 }
3815 \f
3816 /* Rules. */
3817
3818 static struct rule_dpif *
3819 rule_dpif_lookup(struct ofproto_dpif *ofproto, const struct flow *flow,
3820                  uint8_t table_id)
3821 {
3822     struct cls_rule *cls_rule;
3823     struct classifier *cls;
3824
3825     if (table_id >= N_TABLES) {
3826         return NULL;
3827     }
3828
3829     cls = &ofproto->up.tables[table_id];
3830     if (flow->nw_frag & FLOW_NW_FRAG_ANY
3831         && ofproto->up.frag_handling == OFPC_FRAG_NORMAL) {
3832         /* For OFPC_NORMAL frag_handling, we must pretend that transport ports
3833          * are unavailable. */
3834         struct flow ofpc_normal_flow = *flow;
3835         ofpc_normal_flow.tp_src = htons(0);
3836         ofpc_normal_flow.tp_dst = htons(0);
3837         cls_rule = classifier_lookup(cls, &ofpc_normal_flow);
3838     } else {
3839         cls_rule = classifier_lookup(cls, flow);
3840     }
3841     return rule_dpif_cast(rule_from_cls_rule(cls_rule));
3842 }
3843
3844 static void
3845 complete_operation(struct rule_dpif *rule)
3846 {
3847     struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
3848
3849     rule_invalidate(rule);
3850     if (clogged) {
3851         struct dpif_completion *c = xmalloc(sizeof *c);
3852         c->op = rule->up.pending;
3853         list_push_back(&ofproto->completions, &c->list_node);
3854     } else {
3855         ofoperation_complete(rule->up.pending, 0);
3856     }
3857 }
3858
3859 static struct rule *
3860 rule_alloc(void)
3861 {
3862     struct rule_dpif *rule = xmalloc(sizeof *rule);
3863     return &rule->up;
3864 }
3865
3866 static void
3867 rule_dealloc(struct rule *rule_)
3868 {
3869     struct rule_dpif *rule = rule_dpif_cast(rule_);
3870     free(rule);
3871 }
3872
3873 static enum ofperr
3874 rule_construct(struct rule *rule_)
3875 {
3876     struct rule_dpif *rule = rule_dpif_cast(rule_);
3877     struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
3878     struct rule_dpif *victim;
3879     uint8_t table_id;
3880     enum ofperr error;
3881
3882     error = validate_actions(rule->up.actions, rule->up.n_actions,
3883                              &rule->up.cr.flow, ofproto->max_ports);
3884     if (error) {
3885         return error;
3886     }
3887
3888     rule->used = rule->up.created;
3889     rule->packet_count = 0;
3890     rule->byte_count = 0;
3891
3892     victim = rule_dpif_cast(ofoperation_get_victim(rule->up.pending));
3893     if (victim && !list_is_empty(&victim->facets)) {
3894         struct facet *facet;
3895
3896         rule->facets = victim->facets;
3897         list_moved(&rule->facets);
3898         LIST_FOR_EACH (facet, list_node, &rule->facets) {
3899             /* XXX: We're only clearing our local counters here.  It's possible
3900              * that quite a few packets are unaccounted for in the datapath
3901              * statistics.  These will be accounted to the new rule instead of
3902              * cleared as required.  This could be fixed by clearing out the
3903              * datapath statistics for this facet, but currently it doesn't
3904              * seem worth it. */
3905             facet_reset_counters(facet);
3906             facet->rule = rule;
3907         }
3908     } else {
3909         /* Must avoid list_moved() in this case. */
3910         list_init(&rule->facets);
3911     }
3912
3913     table_id = rule->up.table_id;
3914     rule->tag = (victim ? victim->tag
3915                  : table_id == 0 ? 0
3916                  : rule_calculate_tag(&rule->up.cr.flow, &rule->up.cr.wc,
3917                                       ofproto->tables[table_id].basis));
3918
3919     complete_operation(rule);
3920     return 0;
3921 }
3922
3923 static void
3924 rule_destruct(struct rule *rule_)
3925 {
3926     struct rule_dpif *rule = rule_dpif_cast(rule_);
3927     struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
3928     struct facet *facet, *next_facet;
3929
3930     LIST_FOR_EACH_SAFE (facet, next_facet, list_node, &rule->facets) {
3931         facet_revalidate(ofproto, facet);
3932     }
3933
3934     complete_operation(rule);
3935 }
3936
3937 static void
3938 rule_get_stats(struct rule *rule_, uint64_t *packets, uint64_t *bytes)
3939 {
3940     struct rule_dpif *rule = rule_dpif_cast(rule_);
3941     struct facet *facet;
3942
3943     /* Start from historical data for 'rule' itself that are no longer tracked
3944      * in facets.  This counts, for example, facets that have expired. */
3945     *packets = rule->packet_count;
3946     *bytes = rule->byte_count;
3947
3948     /* Add any statistics that are tracked by facets.  This includes
3949      * statistical data recently updated by ofproto_update_stats() as well as
3950      * stats for packets that were executed "by hand" via dpif_execute(). */
3951     LIST_FOR_EACH (facet, list_node, &rule->facets) {
3952         *packets += facet->packet_count;
3953         *bytes += facet->byte_count;
3954     }
3955 }
3956
3957 static enum ofperr
3958 rule_execute(struct rule *rule_, const struct flow *flow,
3959              struct ofpbuf *packet)
3960 {
3961     struct rule_dpif *rule = rule_dpif_cast(rule_);
3962     struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
3963     struct action_xlate_ctx ctx;
3964     struct ofpbuf *odp_actions;
3965     size_t size;
3966
3967     action_xlate_ctx_init(&ctx, ofproto, flow, flow->vlan_tci,
3968                           rule->up.flow_cookie, packet);
3969     odp_actions = xlate_actions(&ctx, rule->up.actions, rule->up.n_actions);
3970     size = packet->size;
3971     if (execute_odp_actions(ofproto, flow, odp_actions->data,
3972                             odp_actions->size, packet)) {
3973         rule->used = time_msec();
3974         rule->packet_count++;
3975         rule->byte_count += size;
3976         flow_push_stats(rule, flow, 1, size, rule->used);
3977     }
3978     ofpbuf_delete(odp_actions);
3979
3980     return 0;
3981 }
3982
3983 static void
3984 rule_modify_actions(struct rule *rule_)
3985 {
3986     struct rule_dpif *rule = rule_dpif_cast(rule_);
3987     struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
3988     enum ofperr error;
3989
3990     error = validate_actions(rule->up.actions, rule->up.n_actions,
3991                              &rule->up.cr.flow, ofproto->max_ports);
3992     if (error) {
3993         ofoperation_complete(rule->up.pending, error);
3994         return;
3995     }
3996
3997     complete_operation(rule);
3998 }
3999 \f
4000 /* Sends 'packet' out 'ofport'.
4001  * May modify 'packet'.
4002  * Returns 0 if successful, otherwise a positive errno value. */
4003 static int
4004 send_packet(const struct ofport_dpif *ofport, struct ofpbuf *packet)
4005 {
4006     const struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofport->up.ofproto);
4007     struct ofpbuf key, odp_actions;
4008     struct odputil_keybuf keybuf;
4009     uint16_t odp_port;
4010     struct flow flow;
4011     int error;
4012
4013     flow_extract((struct ofpbuf *) packet, 0, 0, 0, &flow);
4014     odp_port = vsp_realdev_to_vlandev(ofproto, ofport->odp_port,
4015                                       flow.vlan_tci);
4016     if (odp_port != ofport->odp_port) {
4017         eth_pop_vlan(packet);
4018         flow.vlan_tci = htons(0);
4019     }
4020
4021     ofpbuf_use_stack(&key, &keybuf, sizeof keybuf);
4022     odp_flow_key_from_flow(&key, &flow);
4023
4024     ofpbuf_init(&odp_actions, 32);
4025     compose_sflow_action(ofproto, &odp_actions, &flow, odp_port);
4026
4027     nl_msg_put_u32(&odp_actions, OVS_ACTION_ATTR_OUTPUT, odp_port);
4028     error = dpif_execute(ofproto->dpif,
4029                          key.data, key.size,
4030                          odp_actions.data, odp_actions.size,
4031                          packet);
4032     ofpbuf_uninit(&odp_actions);
4033
4034     if (error) {
4035         VLOG_WARN_RL(&rl, "%s: failed to send packet on port %"PRIu32" (%s)",
4036                      ofproto->up.name, odp_port, strerror(error));
4037     }
4038     ofproto_update_local_port_stats(ofport->up.ofproto, packet->size, 0);
4039     return error;
4040 }
4041 \f
4042 /* OpenFlow to datapath action translation. */
4043
4044 static void do_xlate_actions(const union ofp_action *in, size_t n_in,
4045                              struct action_xlate_ctx *ctx);
4046 static void xlate_normal(struct action_xlate_ctx *);
4047
4048 static size_t
4049 put_userspace_action(const struct ofproto_dpif *ofproto,
4050                      struct ofpbuf *odp_actions,
4051                      const struct flow *flow,
4052                      const struct user_action_cookie *cookie)
4053 {
4054     uint32_t pid;
4055
4056     pid = dpif_port_get_pid(ofproto->dpif,
4057                             ofp_port_to_odp_port(flow->in_port));
4058
4059     return odp_put_userspace_action(pid, cookie, odp_actions);
4060 }
4061
4062 /* Compose SAMPLE action for sFlow. */
4063 static size_t
4064 compose_sflow_action(const struct ofproto_dpif *ofproto,
4065                      struct ofpbuf *odp_actions,
4066                      const struct flow *flow,
4067                      uint32_t odp_port)
4068 {
4069     uint32_t port_ifindex;
4070     uint32_t probability;
4071     struct user_action_cookie cookie;
4072     size_t sample_offset, actions_offset;
4073     int cookie_offset, n_output;
4074
4075     if (!ofproto->sflow || flow->in_port == OFPP_NONE) {
4076         return 0;
4077     }
4078
4079     if (odp_port == OVSP_NONE) {
4080         port_ifindex = 0;
4081         n_output = 0;
4082     } else {
4083         port_ifindex = dpif_sflow_odp_port_to_ifindex(ofproto->sflow, odp_port);
4084         n_output = 1;
4085     }
4086
4087     sample_offset = nl_msg_start_nested(odp_actions, OVS_ACTION_ATTR_SAMPLE);
4088
4089     /* Number of packets out of UINT_MAX to sample. */
4090     probability = dpif_sflow_get_probability(ofproto->sflow);
4091     nl_msg_put_u32(odp_actions, OVS_SAMPLE_ATTR_PROBABILITY, probability);
4092
4093     actions_offset = nl_msg_start_nested(odp_actions, OVS_SAMPLE_ATTR_ACTIONS);
4094
4095     cookie.type = USER_ACTION_COOKIE_SFLOW;
4096     cookie.data = port_ifindex;
4097     cookie.n_output = n_output;
4098     cookie.vlan_tci = 0;
4099     cookie_offset = put_userspace_action(ofproto, odp_actions, flow, &cookie);
4100
4101     nl_msg_end_nested(odp_actions, actions_offset);
4102     nl_msg_end_nested(odp_actions, sample_offset);
4103     return cookie_offset;
4104 }
4105
4106 /* SAMPLE action must be first action in any given list of actions.
4107  * At this point we do not have all information required to build it. So try to
4108  * build sample action as complete as possible. */
4109 static void
4110 add_sflow_action(struct action_xlate_ctx *ctx)
4111 {
4112     ctx->user_cookie_offset = compose_sflow_action(ctx->ofproto,
4113                                                    ctx->odp_actions,
4114                                                    &ctx->flow, OVSP_NONE);
4115     ctx->sflow_odp_port = 0;
4116     ctx->sflow_n_outputs = 0;
4117 }
4118
4119 /* Fix SAMPLE action according to data collected while composing ODP actions.
4120  * We need to fix SAMPLE actions OVS_SAMPLE_ATTR_ACTIONS attribute, i.e. nested
4121  * USERSPACE action's user-cookie which is required for sflow. */
4122 static void
4123 fix_sflow_action(struct action_xlate_ctx *ctx)
4124 {
4125     const struct flow *base = &ctx->base_flow;
4126     struct user_action_cookie *cookie;
4127
4128     if (!ctx->user_cookie_offset) {
4129         return;
4130     }
4131
4132     cookie = ofpbuf_at(ctx->odp_actions, ctx->user_cookie_offset,
4133                      sizeof(*cookie));
4134     assert(cookie != NULL);
4135     assert(cookie->type == USER_ACTION_COOKIE_SFLOW);
4136
4137     if (ctx->sflow_n_outputs) {
4138         cookie->data = dpif_sflow_odp_port_to_ifindex(ctx->ofproto->sflow,
4139                                                     ctx->sflow_odp_port);
4140     }
4141     if (ctx->sflow_n_outputs >= 255) {
4142         cookie->n_output = 255;
4143     } else {
4144         cookie->n_output = ctx->sflow_n_outputs;
4145     }
4146     cookie->vlan_tci = base->vlan_tci;
4147 }
4148
4149 static void
4150 compose_output_action__(struct action_xlate_ctx *ctx, uint16_t ofp_port,
4151                         bool check_stp)
4152 {
4153     const struct ofport_dpif *ofport = get_ofp_port(ctx->ofproto, ofp_port);
4154     uint16_t odp_port = ofp_port_to_odp_port(ofp_port);
4155     ovs_be16 flow_vlan_tci = ctx->flow.vlan_tci;
4156     uint8_t flow_nw_tos = ctx->flow.nw_tos;
4157     uint16_t out_port;
4158
4159     if (ofport) {
4160         struct priority_to_dscp *pdscp;
4161
4162         if (ofport->up.opp.config & htonl(OFPPC_NO_FWD)
4163             || (check_stp && !stp_forward_in_state(ofport->stp_state))) {
4164             return;
4165         }
4166
4167         pdscp = get_priority(ofport, ctx->flow.skb_priority);
4168         if (pdscp) {
4169             ctx->flow.nw_tos &= ~IP_DSCP_MASK;
4170             ctx->flow.nw_tos |= pdscp->dscp;
4171         }
4172     } else {
4173         /* We may not have an ofport record for this port, but it doesn't hurt
4174          * to allow forwarding to it anyhow.  Maybe such a port will appear
4175          * later and we're pre-populating the flow table.  */
4176     }
4177
4178     out_port = vsp_realdev_to_vlandev(ctx->ofproto, odp_port,
4179                                       ctx->flow.vlan_tci);
4180     if (out_port != odp_port) {
4181         ctx->flow.vlan_tci = htons(0);
4182     }
4183     commit_odp_actions(&ctx->flow, &ctx->base_flow, ctx->odp_actions);
4184     nl_msg_put_u32(ctx->odp_actions, OVS_ACTION_ATTR_OUTPUT, out_port);
4185
4186     ctx->sflow_odp_port = odp_port;
4187     ctx->sflow_n_outputs++;
4188     ctx->nf_output_iface = ofp_port;
4189     ctx->flow.vlan_tci = flow_vlan_tci;
4190     ctx->flow.nw_tos = flow_nw_tos;
4191 }
4192
4193 static void
4194 compose_output_action(struct action_xlate_ctx *ctx, uint16_t ofp_port)
4195 {
4196     compose_output_action__(ctx, ofp_port, true);
4197 }
4198
4199 static void
4200 xlate_table_action(struct action_xlate_ctx *ctx,
4201                    uint16_t in_port, uint8_t table_id)
4202 {
4203     if (ctx->recurse < MAX_RESUBMIT_RECURSION) {
4204         struct ofproto_dpif *ofproto = ctx->ofproto;
4205         struct rule_dpif *rule;
4206         uint16_t old_in_port;
4207         uint8_t old_table_id;
4208
4209         old_table_id = ctx->table_id;
4210         ctx->table_id = table_id;
4211
4212         /* Look up a flow with 'in_port' as the input port. */
4213         old_in_port = ctx->flow.in_port;
4214         ctx->flow.in_port = in_port;
4215         rule = rule_dpif_lookup(ofproto, &ctx->flow, table_id);
4216
4217         /* Tag the flow. */
4218         if (table_id > 0 && table_id < N_TABLES) {
4219             struct table_dpif *table = &ofproto->tables[table_id];
4220             if (table->other_table) {
4221                 ctx->tags |= (rule
4222                               ? rule->tag
4223                               : rule_calculate_tag(&ctx->flow,
4224                                                    &table->other_table->wc,
4225                                                    table->basis));
4226             }
4227         }
4228
4229         /* Restore the original input port.  Otherwise OFPP_NORMAL and
4230          * OFPP_IN_PORT will have surprising behavior. */
4231         ctx->flow.in_port = old_in_port;
4232
4233         if (ctx->resubmit_hook) {
4234             ctx->resubmit_hook(ctx, rule);
4235         }
4236
4237         if (rule) {
4238             ovs_be64 old_cookie = ctx->cookie;
4239
4240             ctx->recurse++;
4241             ctx->cookie = rule->up.flow_cookie;
4242             do_xlate_actions(rule->up.actions, rule->up.n_actions, ctx);
4243             ctx->cookie = old_cookie;
4244             ctx->recurse--;
4245         }
4246
4247         ctx->table_id = old_table_id;
4248     } else {
4249         static struct vlog_rate_limit recurse_rl = VLOG_RATE_LIMIT_INIT(1, 1);
4250
4251         VLOG_ERR_RL(&recurse_rl, "resubmit actions recursed over %d times",
4252                     MAX_RESUBMIT_RECURSION);
4253     }
4254 }
4255
4256 static void
4257 xlate_resubmit_table(struct action_xlate_ctx *ctx,
4258                      const struct nx_action_resubmit *nar)
4259 {
4260     uint16_t in_port;
4261     uint8_t table_id;
4262
4263     in_port = (nar->in_port == htons(OFPP_IN_PORT)
4264                ? ctx->flow.in_port
4265                : ntohs(nar->in_port));
4266     table_id = nar->table == 255 ? ctx->table_id : nar->table;
4267
4268     xlate_table_action(ctx, in_port, table_id);
4269 }
4270
4271 static void
4272 flood_packets(struct action_xlate_ctx *ctx, bool all)
4273 {
4274     struct ofport_dpif *ofport;
4275
4276     HMAP_FOR_EACH (ofport, up.hmap_node, &ctx->ofproto->up.ports) {
4277         uint16_t ofp_port = ofport->up.ofp_port;
4278
4279         if (ofp_port == ctx->flow.in_port) {
4280             continue;
4281         }
4282
4283         if (all) {
4284             compose_output_action__(ctx, ofp_port, false);
4285         } else if (!(ofport->up.opp.config & htonl(OFPPC_NO_FLOOD))) {
4286             compose_output_action(ctx, ofp_port);
4287         }
4288     }
4289
4290     ctx->nf_output_iface = NF_OUT_FLOOD;
4291 }
4292
4293 static void
4294 execute_controller_action(struct action_xlate_ctx *ctx, int len)
4295 {
4296     struct ofputil_packet_in pin;
4297     struct ofpbuf *packet;
4298
4299     ctx->may_set_up_flow = false;
4300     if (!ctx->packet) {
4301         return;
4302     }
4303
4304     packet = ofpbuf_clone(ctx->packet);
4305
4306     if (packet->l2 && packet->l3) {
4307         struct eth_header *eh;
4308
4309         eth_pop_vlan(packet);
4310         eh = packet->l2;
4311         assert(eh->eth_type == ctx->flow.dl_type);
4312         memcpy(eh->eth_src, ctx->flow.dl_src, sizeof eh->eth_src);
4313         memcpy(eh->eth_dst, ctx->flow.dl_dst, sizeof eh->eth_dst);
4314
4315         if (ctx->flow.vlan_tci & htons(VLAN_CFI)) {
4316             eth_push_vlan(packet, ctx->flow.vlan_tci);
4317         }
4318
4319         if (packet->l4) {
4320             if (ctx->flow.dl_type == htons(ETH_TYPE_IP)) {
4321                 packet_set_ipv4(packet, ctx->flow.nw_src, ctx->flow.nw_dst,
4322                                 ctx->flow.nw_tos, ctx->flow.nw_ttl);
4323             }
4324
4325             if (packet->l7) {
4326                 if (ctx->flow.nw_proto == IPPROTO_TCP) {
4327                     packet_set_tcp_port(packet, ctx->flow.tp_src,
4328                                         ctx->flow.tp_dst);
4329                 } else if (ctx->flow.nw_proto == IPPROTO_UDP) {
4330                     packet_set_udp_port(packet, ctx->flow.tp_src,
4331                                         ctx->flow.tp_dst);
4332                 }
4333             }
4334         }
4335     }
4336
4337     pin.packet = packet->data;
4338     pin.packet_len = packet->size;
4339     pin.reason = OFPR_ACTION;
4340     pin.table_id = ctx->table_id;
4341     pin.cookie = ctx->cookie;
4342
4343     pin.buffer_id = 0;
4344     pin.send_len = len;
4345     pin.total_len = packet->size;
4346     flow_get_metadata(&ctx->flow, &pin.fmd);
4347
4348     connmgr_send_packet_in(ctx->ofproto->up.connmgr, &pin, &ctx->flow);
4349     ofpbuf_delete(packet);
4350 }
4351
4352 static void
4353 xlate_output_action__(struct action_xlate_ctx *ctx,
4354                       uint16_t port, uint16_t max_len)
4355 {
4356     uint16_t prev_nf_output_iface = ctx->nf_output_iface;
4357
4358     ctx->nf_output_iface = NF_OUT_DROP;
4359
4360     switch (port) {
4361     case OFPP_IN_PORT:
4362         compose_output_action(ctx, ctx->flow.in_port);
4363         break;
4364     case OFPP_TABLE:
4365         xlate_table_action(ctx, ctx->flow.in_port, ctx->table_id);
4366         break;
4367     case OFPP_NORMAL:
4368         xlate_normal(ctx);
4369         break;
4370     case OFPP_FLOOD:
4371         flood_packets(ctx,  false);
4372         break;
4373     case OFPP_ALL:
4374         flood_packets(ctx, true);
4375         break;
4376     case OFPP_CONTROLLER:
4377         execute_controller_action(ctx, max_len);
4378         break;
4379     case OFPP_LOCAL:
4380         compose_output_action(ctx, OFPP_LOCAL);
4381         break;
4382     case OFPP_NONE:
4383         break;
4384     default:
4385         if (port != ctx->flow.in_port) {
4386             compose_output_action(ctx, port);
4387         }
4388         break;
4389     }
4390
4391     if (prev_nf_output_iface == NF_OUT_FLOOD) {
4392         ctx->nf_output_iface = NF_OUT_FLOOD;
4393     } else if (ctx->nf_output_iface == NF_OUT_DROP) {
4394         ctx->nf_output_iface = prev_nf_output_iface;
4395     } else if (prev_nf_output_iface != NF_OUT_DROP &&
4396                ctx->nf_output_iface != NF_OUT_FLOOD) {
4397         ctx->nf_output_iface = NF_OUT_MULTI;
4398     }
4399 }
4400
4401 static void
4402 xlate_output_reg_action(struct action_xlate_ctx *ctx,
4403                         const struct nx_action_output_reg *naor)
4404 {
4405     uint64_t ofp_port;
4406
4407     ofp_port = nxm_read_field_bits(naor->src, naor->ofs_nbits, &ctx->flow);
4408
4409     if (ofp_port <= UINT16_MAX) {
4410         xlate_output_action__(ctx, ofp_port, ntohs(naor->max_len));
4411     }
4412 }
4413
4414 static void
4415 xlate_output_action(struct action_xlate_ctx *ctx,
4416                     const struct ofp_action_output *oao)
4417 {
4418     xlate_output_action__(ctx, ntohs(oao->port), ntohs(oao->max_len));
4419 }
4420
4421 static void
4422 xlate_enqueue_action(struct action_xlate_ctx *ctx,
4423                      const struct ofp_action_enqueue *oae)
4424 {
4425     uint16_t ofp_port;
4426     uint32_t flow_priority, priority;
4427     int error;
4428
4429     error = dpif_queue_to_priority(ctx->ofproto->dpif, ntohl(oae->queue_id),
4430                                    &priority);
4431     if (error) {
4432         /* Fall back to ordinary output action. */
4433         xlate_output_action__(ctx, ntohs(oae->port), 0);
4434         return;
4435     }
4436
4437     /* Figure out datapath output port. */
4438     ofp_port = ntohs(oae->port);
4439     if (ofp_port == OFPP_IN_PORT) {
4440         ofp_port = ctx->flow.in_port;
4441     } else if (ofp_port == ctx->flow.in_port) {
4442         return;
4443     }
4444
4445     /* Add datapath actions. */
4446     flow_priority = ctx->flow.skb_priority;
4447     ctx->flow.skb_priority = priority;
4448     compose_output_action(ctx, ofp_port);
4449     ctx->flow.skb_priority = flow_priority;
4450
4451     /* Update NetFlow output port. */
4452     if (ctx->nf_output_iface == NF_OUT_DROP) {
4453         ctx->nf_output_iface = ofp_port;
4454     } else if (ctx->nf_output_iface != NF_OUT_FLOOD) {
4455         ctx->nf_output_iface = NF_OUT_MULTI;
4456     }
4457 }
4458
4459 static void
4460 xlate_set_queue_action(struct action_xlate_ctx *ctx,
4461                        const struct nx_action_set_queue *nasq)
4462 {
4463     uint32_t priority;
4464     int error;
4465
4466     error = dpif_queue_to_priority(ctx->ofproto->dpif, ntohl(nasq->queue_id),
4467                                    &priority);
4468     if (error) {
4469         /* Couldn't translate queue to a priority, so ignore.  A warning
4470          * has already been logged. */
4471         return;
4472     }
4473
4474     ctx->flow.skb_priority = priority;
4475 }
4476
4477 struct xlate_reg_state {
4478     ovs_be16 vlan_tci;
4479     ovs_be64 tun_id;
4480 };
4481
4482 static void
4483 xlate_autopath(struct action_xlate_ctx *ctx,
4484                const struct nx_action_autopath *naa)
4485 {
4486     uint16_t ofp_port = ntohl(naa->id);
4487     struct ofport_dpif *port = get_ofp_port(ctx->ofproto, ofp_port);
4488
4489     if (!port || !port->bundle) {
4490         ofp_port = OFPP_NONE;
4491     } else if (port->bundle->bond) {
4492         /* Autopath does not support VLAN hashing. */
4493         struct ofport_dpif *slave = bond_choose_output_slave(
4494             port->bundle->bond, &ctx->flow, 0, &ctx->tags);
4495         if (slave) {
4496             ofp_port = slave->up.ofp_port;
4497         }
4498     }
4499     autopath_execute(naa, &ctx->flow, ofp_port);
4500 }
4501
4502 static bool
4503 slave_enabled_cb(uint16_t ofp_port, void *ofproto_)
4504 {
4505     struct ofproto_dpif *ofproto = ofproto_;
4506     struct ofport_dpif *port;
4507
4508     switch (ofp_port) {
4509     case OFPP_IN_PORT:
4510     case OFPP_TABLE:
4511     case OFPP_NORMAL:
4512     case OFPP_FLOOD:
4513     case OFPP_ALL:
4514     case OFPP_NONE:
4515         return true;
4516     case OFPP_CONTROLLER: /* Not supported by the bundle action. */
4517         return false;
4518     default:
4519         port = get_ofp_port(ofproto, ofp_port);
4520         return port ? port->may_enable : false;
4521     }
4522 }
4523
4524 static void
4525 xlate_learn_action(struct action_xlate_ctx *ctx,
4526                    const struct nx_action_learn *learn)
4527 {
4528     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 1);
4529     struct ofputil_flow_mod fm;
4530     int error;
4531
4532     learn_execute(learn, &ctx->flow, &fm);
4533
4534     error = ofproto_flow_mod(&ctx->ofproto->up, &fm);
4535     if (error && !VLOG_DROP_WARN(&rl)) {
4536         VLOG_WARN("learning action failed to modify flow table (%s)",
4537                   ofperr_get_name(error));
4538     }
4539
4540     free(fm.actions);
4541 }
4542
4543 static bool
4544 may_receive(const struct ofport_dpif *port, struct action_xlate_ctx *ctx)
4545 {
4546     if (port->up.opp.config & (eth_addr_equals(ctx->flow.dl_dst, eth_addr_stp)
4547                                ? htonl(OFPPC_NO_RECV_STP)
4548                                : htonl(OFPPC_NO_RECV))) {
4549         return false;
4550     }
4551
4552     /* Only drop packets here if both forwarding and learning are
4553      * disabled.  If just learning is enabled, we need to have
4554      * OFPP_NORMAL and the learning action have a look at the packet
4555      * before we can drop it. */
4556     if (!stp_forward_in_state(port->stp_state)
4557             && !stp_learn_in_state(port->stp_state)) {
4558         return false;
4559     }
4560
4561     return true;
4562 }
4563
4564 static void
4565 do_xlate_actions(const union ofp_action *in, size_t n_in,
4566                  struct action_xlate_ctx *ctx)
4567 {
4568     const struct ofport_dpif *port;
4569     const union ofp_action *ia;
4570     size_t left;
4571
4572     port = get_ofp_port(ctx->ofproto, ctx->flow.in_port);
4573     if (port && !may_receive(port, ctx)) {
4574         /* Drop this flow. */
4575         return;
4576     }
4577
4578     OFPUTIL_ACTION_FOR_EACH_UNSAFE (ia, left, in, n_in) {
4579         const struct ofp_action_dl_addr *oada;
4580         const struct nx_action_resubmit *nar;
4581         const struct nx_action_set_tunnel *nast;
4582         const struct nx_action_set_queue *nasq;
4583         const struct nx_action_multipath *nam;
4584         const struct nx_action_autopath *naa;
4585         const struct nx_action_bundle *nab;
4586         const struct nx_action_output_reg *naor;
4587         enum ofputil_action_code code;
4588         ovs_be64 tun_id;
4589
4590         if (ctx->exit) {
4591             break;
4592         }
4593
4594         code = ofputil_decode_action_unsafe(ia);
4595         switch (code) {
4596         case OFPUTIL_OFPAT_OUTPUT:
4597             xlate_output_action(ctx, &ia->output);
4598             break;
4599
4600         case OFPUTIL_OFPAT_SET_VLAN_VID:
4601             ctx->flow.vlan_tci &= ~htons(VLAN_VID_MASK);
4602             ctx->flow.vlan_tci |= ia->vlan_vid.vlan_vid | htons(VLAN_CFI);
4603             break;
4604
4605         case OFPUTIL_OFPAT_SET_VLAN_PCP:
4606             ctx->flow.vlan_tci &= ~htons(VLAN_PCP_MASK);
4607             ctx->flow.vlan_tci |= htons(
4608                 (ia->vlan_pcp.vlan_pcp << VLAN_PCP_SHIFT) | VLAN_CFI);
4609             break;
4610
4611         case OFPUTIL_OFPAT_STRIP_VLAN:
4612             ctx->flow.vlan_tci = htons(0);
4613             break;
4614
4615         case OFPUTIL_OFPAT_SET_DL_SRC:
4616             oada = ((struct ofp_action_dl_addr *) ia);
4617             memcpy(ctx->flow.dl_src, oada->dl_addr, ETH_ADDR_LEN);
4618             break;
4619
4620         case OFPUTIL_OFPAT_SET_DL_DST:
4621             oada = ((struct ofp_action_dl_addr *) ia);
4622             memcpy(ctx->flow.dl_dst, oada->dl_addr, ETH_ADDR_LEN);
4623             break;
4624
4625         case OFPUTIL_OFPAT_SET_NW_SRC:
4626             ctx->flow.nw_src = ia->nw_addr.nw_addr;
4627             break;
4628
4629         case OFPUTIL_OFPAT_SET_NW_DST:
4630             ctx->flow.nw_dst = ia->nw_addr.nw_addr;
4631             break;
4632
4633         case OFPUTIL_OFPAT_SET_NW_TOS:
4634             /* OpenFlow 1.0 only supports IPv4. */
4635             if (ctx->flow.dl_type == htons(ETH_TYPE_IP)) {
4636                 ctx->flow.nw_tos &= ~IP_DSCP_MASK;
4637                 ctx->flow.nw_tos |= ia->nw_tos.nw_tos & IP_DSCP_MASK;
4638             }
4639             break;
4640
4641         case OFPUTIL_OFPAT_SET_TP_SRC:
4642             ctx->flow.tp_src = ia->tp_port.tp_port;
4643             break;
4644
4645         case OFPUTIL_OFPAT_SET_TP_DST:
4646             ctx->flow.tp_dst = ia->tp_port.tp_port;
4647             break;
4648
4649         case OFPUTIL_OFPAT_ENQUEUE:
4650             xlate_enqueue_action(ctx, (const struct ofp_action_enqueue *) ia);
4651             break;
4652
4653         case OFPUTIL_NXAST_RESUBMIT:
4654             nar = (const struct nx_action_resubmit *) ia;
4655             xlate_table_action(ctx, ntohs(nar->in_port), ctx->table_id);
4656             break;
4657
4658         case OFPUTIL_NXAST_RESUBMIT_TABLE:
4659             xlate_resubmit_table(ctx, (const struct nx_action_resubmit *) ia);
4660             break;
4661
4662         case OFPUTIL_NXAST_SET_TUNNEL:
4663             nast = (const struct nx_action_set_tunnel *) ia;
4664             tun_id = htonll(ntohl(nast->tun_id));
4665             ctx->flow.tun_id = tun_id;
4666             break;
4667
4668         case OFPUTIL_NXAST_SET_QUEUE:
4669             nasq = (const struct nx_action_set_queue *) ia;
4670             xlate_set_queue_action(ctx, nasq);
4671             break;
4672
4673         case OFPUTIL_NXAST_POP_QUEUE:
4674             ctx->flow.skb_priority = ctx->orig_skb_priority;
4675             break;
4676
4677         case OFPUTIL_NXAST_REG_MOVE:
4678             nxm_execute_reg_move((const struct nx_action_reg_move *) ia,
4679                                  &ctx->flow);
4680             break;
4681
4682         case OFPUTIL_NXAST_REG_LOAD:
4683             nxm_execute_reg_load((const struct nx_action_reg_load *) ia,
4684                                  &ctx->flow);
4685             break;
4686
4687         case OFPUTIL_NXAST_NOTE:
4688             /* Nothing to do. */
4689             break;
4690
4691         case OFPUTIL_NXAST_SET_TUNNEL64:
4692             tun_id = ((const struct nx_action_set_tunnel64 *) ia)->tun_id;
4693             ctx->flow.tun_id = tun_id;
4694             break;
4695
4696         case OFPUTIL_NXAST_MULTIPATH:
4697             nam = (const struct nx_action_multipath *) ia;
4698             multipath_execute(nam, &ctx->flow);
4699             break;
4700
4701         case OFPUTIL_NXAST_AUTOPATH:
4702             naa = (const struct nx_action_autopath *) ia;
4703             xlate_autopath(ctx, naa);
4704             break;
4705
4706         case OFPUTIL_NXAST_BUNDLE:
4707             ctx->ofproto->has_bundle_action = true;
4708             nab = (const struct nx_action_bundle *) ia;
4709             xlate_output_action__(ctx, bundle_execute(nab, &ctx->flow,
4710                                                       slave_enabled_cb,
4711                                                       ctx->ofproto), 0);
4712             break;
4713
4714         case OFPUTIL_NXAST_BUNDLE_LOAD:
4715             ctx->ofproto->has_bundle_action = true;
4716             nab = (const struct nx_action_bundle *) ia;
4717             bundle_execute_load(nab, &ctx->flow, slave_enabled_cb,
4718                                 ctx->ofproto);
4719             break;
4720
4721         case OFPUTIL_NXAST_OUTPUT_REG:
4722             naor = (const struct nx_action_output_reg *) ia;
4723             xlate_output_reg_action(ctx, naor);
4724             break;
4725
4726         case OFPUTIL_NXAST_LEARN:
4727             ctx->has_learn = true;
4728             if (ctx->may_learn) {
4729                 xlate_learn_action(ctx, (const struct nx_action_learn *) ia);
4730             }
4731             break;
4732
4733         case OFPUTIL_NXAST_EXIT:
4734             ctx->exit = true;
4735             break;
4736         }
4737     }
4738
4739     /* We've let OFPP_NORMAL and the learning action look at the packet,
4740      * so drop it now if forwarding is disabled. */
4741     if (port && !stp_forward_in_state(port->stp_state)) {
4742         ofpbuf_clear(ctx->odp_actions);
4743         add_sflow_action(ctx);
4744     }
4745 }
4746
4747 static void
4748 action_xlate_ctx_init(struct action_xlate_ctx *ctx,
4749                       struct ofproto_dpif *ofproto, const struct flow *flow,
4750                       ovs_be16 initial_tci, ovs_be64 cookie,
4751                       const struct ofpbuf *packet)
4752 {
4753     ctx->ofproto = ofproto;
4754     ctx->flow = *flow;
4755     ctx->base_flow = ctx->flow;
4756     ctx->base_flow.tun_id = 0;
4757     ctx->base_flow.vlan_tci = initial_tci;
4758     ctx->cookie = cookie;
4759     ctx->packet = packet;
4760     ctx->may_learn = packet != NULL;
4761     ctx->resubmit_hook = NULL;
4762 }
4763
4764 static struct ofpbuf *
4765 xlate_actions(struct action_xlate_ctx *ctx,
4766               const union ofp_action *in, size_t n_in)
4767 {
4768     struct flow orig_flow = ctx->flow;
4769
4770     COVERAGE_INC(ofproto_dpif_xlate);
4771
4772     ctx->odp_actions = ofpbuf_new(512);
4773     ofpbuf_reserve(ctx->odp_actions, NL_A_U32_SIZE);
4774     ctx->tags = 0;
4775     ctx->may_set_up_flow = true;
4776     ctx->has_learn = false;
4777     ctx->has_normal = false;
4778     ctx->nf_output_iface = NF_OUT_DROP;
4779     ctx->mirrors = 0;
4780     ctx->recurse = 0;
4781     ctx->orig_skb_priority = ctx->flow.skb_priority;
4782     ctx->table_id = 0;
4783     ctx->exit = false;
4784
4785     if (ctx->flow.nw_frag & FLOW_NW_FRAG_ANY) {
4786         switch (ctx->ofproto->up.frag_handling) {
4787         case OFPC_FRAG_NORMAL:
4788             /* We must pretend that transport ports are unavailable. */
4789             ctx->flow.tp_src = ctx->base_flow.tp_src = htons(0);
4790             ctx->flow.tp_dst = ctx->base_flow.tp_dst = htons(0);
4791             break;
4792
4793         case OFPC_FRAG_DROP:
4794             return ctx->odp_actions;
4795
4796         case OFPC_FRAG_REASM:
4797             NOT_REACHED();
4798
4799         case OFPC_FRAG_NX_MATCH:
4800             /* Nothing to do. */
4801             break;
4802         }
4803     }
4804
4805     if (process_special(ctx->ofproto, &ctx->flow, ctx->packet)) {
4806         ctx->may_set_up_flow = false;
4807         return ctx->odp_actions;
4808     } else {
4809         add_sflow_action(ctx);
4810         do_xlate_actions(in, n_in, ctx);
4811
4812         if (!connmgr_may_set_up_flow(ctx->ofproto->up.connmgr, &ctx->flow,
4813                                      ctx->odp_actions->data,
4814                                      ctx->odp_actions->size)) {
4815             ctx->may_set_up_flow = false;
4816             if (ctx->packet
4817                 && connmgr_msg_in_hook(ctx->ofproto->up.connmgr, &ctx->flow,
4818                                        ctx->packet)) {
4819                 compose_output_action(ctx, OFPP_LOCAL);
4820             }
4821         }
4822         add_mirror_actions(ctx, &orig_flow);
4823         fix_sflow_action(ctx);
4824     }
4825
4826     return ctx->odp_actions;
4827 }
4828 \f
4829 /* OFPP_NORMAL implementation. */
4830
4831 static struct ofport_dpif *ofbundle_get_a_port(const struct ofbundle *);
4832
4833 /* Given 'vid', the VID obtained from the 802.1Q header that was received as
4834  * part of a packet (specify 0 if there was no 802.1Q header), and 'in_bundle',
4835  * the bundle on which the packet was received, returns the VLAN to which the
4836  * packet belongs.
4837  *
4838  * Both 'vid' and the return value are in the range 0...4095. */
4839 static uint16_t
4840 input_vid_to_vlan(const struct ofbundle *in_bundle, uint16_t vid)
4841 {
4842     switch (in_bundle->vlan_mode) {
4843     case PORT_VLAN_ACCESS:
4844         return in_bundle->vlan;
4845         break;
4846
4847     case PORT_VLAN_TRUNK:
4848         return vid;
4849
4850     case PORT_VLAN_NATIVE_UNTAGGED:
4851     case PORT_VLAN_NATIVE_TAGGED:
4852         return vid ? vid : in_bundle->vlan;
4853
4854     default:
4855         NOT_REACHED();
4856     }
4857 }
4858
4859 /* Checks whether a packet with the given 'vid' may ingress on 'in_bundle'.
4860  * If so, returns true.  Otherwise, returns false and, if 'warn' is true, logs
4861  * a warning.
4862  *
4863  * 'vid' should be the VID obtained from the 802.1Q header that was received as
4864  * part of a packet (specify 0 if there was no 802.1Q header), in the range
4865  * 0...4095. */
4866 static bool
4867 input_vid_is_valid(uint16_t vid, struct ofbundle *in_bundle, bool warn)
4868 {
4869     /* Allow any VID on the OFPP_NONE port. */
4870     if (in_bundle == &ofpp_none_bundle) {
4871         return true;
4872     }
4873
4874     switch (in_bundle->vlan_mode) {
4875     case PORT_VLAN_ACCESS:
4876         if (vid) {
4877             if (warn) {
4878                 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
4879                 VLOG_WARN_RL(&rl, "bridge %s: dropping VLAN %"PRIu16" tagged "
4880                              "packet received on port %s configured as VLAN "
4881                              "%"PRIu16" access port",
4882                              in_bundle->ofproto->up.name, vid,
4883                              in_bundle->name, in_bundle->vlan);
4884             }
4885             return false;
4886         }
4887         return true;
4888
4889     case PORT_VLAN_NATIVE_UNTAGGED:
4890     case PORT_VLAN_NATIVE_TAGGED:
4891         if (!vid) {
4892             /* Port must always carry its native VLAN. */
4893             return true;
4894         }
4895         /* Fall through. */
4896     case PORT_VLAN_TRUNK:
4897         if (!ofbundle_includes_vlan(in_bundle, vid)) {
4898             if (warn) {
4899                 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
4900                 VLOG_WARN_RL(&rl, "bridge %s: dropping VLAN %"PRIu16" packet "
4901                              "received on port %s not configured for trunking "
4902                              "VLAN %"PRIu16,
4903                              in_bundle->ofproto->up.name, vid,
4904                              in_bundle->name, vid);
4905             }
4906             return false;
4907         }
4908         return true;
4909
4910     default:
4911         NOT_REACHED();
4912     }
4913
4914 }
4915
4916 /* Given 'vlan', the VLAN that a packet belongs to, and
4917  * 'out_bundle', a bundle on which the packet is to be output, returns the VID
4918  * that should be included in the 802.1Q header.  (If the return value is 0,
4919  * then the 802.1Q header should only be included in the packet if there is a
4920  * nonzero PCP.)
4921  *
4922  * Both 'vlan' and the return value are in the range 0...4095. */
4923 static uint16_t
4924 output_vlan_to_vid(const struct ofbundle *out_bundle, uint16_t vlan)
4925 {
4926     switch (out_bundle->vlan_mode) {
4927     case PORT_VLAN_ACCESS:
4928         return 0;
4929
4930     case PORT_VLAN_TRUNK:
4931     case PORT_VLAN_NATIVE_TAGGED:
4932         return vlan;
4933
4934     case PORT_VLAN_NATIVE_UNTAGGED:
4935         return vlan == out_bundle->vlan ? 0 : vlan;
4936
4937     default:
4938         NOT_REACHED();
4939     }
4940 }
4941
4942 static void
4943 output_normal(struct action_xlate_ctx *ctx, const struct ofbundle *out_bundle,
4944               uint16_t vlan)
4945 {
4946     struct ofport_dpif *port;
4947     uint16_t vid;
4948     ovs_be16 tci, old_tci;
4949
4950     vid = output_vlan_to_vid(out_bundle, vlan);
4951     if (!out_bundle->bond) {
4952         port = ofbundle_get_a_port(out_bundle);
4953     } else {
4954         port = bond_choose_output_slave(out_bundle->bond, &ctx->flow,
4955                                         vid, &ctx->tags);
4956         if (!port) {
4957             /* No slaves enabled, so drop packet. */
4958             return;
4959         }
4960     }
4961
4962     old_tci = ctx->flow.vlan_tci;
4963     tci = htons(vid);
4964     if (tci || out_bundle->use_priority_tags) {
4965         tci |= ctx->flow.vlan_tci & htons(VLAN_PCP_MASK);
4966         if (tci) {
4967             tci |= htons(VLAN_CFI);
4968         }
4969     }
4970     ctx->flow.vlan_tci = tci;
4971
4972     compose_output_action(ctx, port->up.ofp_port);
4973     ctx->flow.vlan_tci = old_tci;
4974 }
4975
4976 static int
4977 mirror_mask_ffs(mirror_mask_t mask)
4978 {
4979     BUILD_ASSERT_DECL(sizeof(unsigned int) >= sizeof(mask));
4980     return ffs(mask);
4981 }
4982
4983 static bool
4984 ofbundle_trunks_vlan(const struct ofbundle *bundle, uint16_t vlan)
4985 {
4986     return (bundle->vlan_mode != PORT_VLAN_ACCESS
4987             && (!bundle->trunks || bitmap_is_set(bundle->trunks, vlan)));
4988 }
4989
4990 static bool
4991 ofbundle_includes_vlan(const struct ofbundle *bundle, uint16_t vlan)
4992 {
4993     return vlan == bundle->vlan || ofbundle_trunks_vlan(bundle, vlan);
4994 }
4995
4996 /* Returns an arbitrary interface within 'bundle'. */
4997 static struct ofport_dpif *
4998 ofbundle_get_a_port(const struct ofbundle *bundle)
4999 {
5000     return CONTAINER_OF(list_front(&bundle->ports),
5001                         struct ofport_dpif, bundle_node);
5002 }
5003
5004 static bool
5005 vlan_is_mirrored(const struct ofmirror *m, int vlan)
5006 {
5007     return !m->vlans || bitmap_is_set(m->vlans, vlan);
5008 }
5009
5010 /* Returns true if a packet with Ethernet destination MAC 'dst' may be mirrored
5011  * to a VLAN.  In general most packets may be mirrored but we want to drop
5012  * protocols that may confuse switches. */
5013 static bool
5014 eth_dst_may_rspan(const uint8_t dst[ETH_ADDR_LEN])
5015 {
5016     /* If you change this function's behavior, please update corresponding
5017      * documentation in vswitch.xml at the same time. */
5018     if (dst[0] != 0x01) {
5019         /* All the currently banned MACs happen to start with 01 currently, so
5020          * this is a quick way to eliminate most of the good ones. */
5021     } else {
5022         if (eth_addr_is_reserved(dst)) {
5023             /* Drop STP, IEEE pause frames, and other reserved protocols
5024              * (01-80-c2-00-00-0x). */
5025             return false;
5026         }
5027
5028         if (dst[0] == 0x01 && dst[1] == 0x00 && dst[2] == 0x0c) {
5029             /* Cisco OUI. */
5030             if ((dst[3] & 0xfe) == 0xcc &&
5031                 (dst[4] & 0xfe) == 0xcc &&
5032                 (dst[5] & 0xfe) == 0xcc) {
5033                 /* Drop the following protocols plus others following the same
5034                    pattern:
5035
5036                    CDP, VTP, DTP, PAgP  (01-00-0c-cc-cc-cc)
5037                    Spanning Tree PVSTP+ (01-00-0c-cc-cc-cd)
5038                    STP Uplink Fast      (01-00-0c-cd-cd-cd) */
5039                 return false;
5040             }
5041
5042             if (!(dst[3] | dst[4] | dst[5])) {
5043                 /* Drop Inter Switch Link packets (01-00-0c-00-00-00). */
5044                 return false;
5045             }
5046         }
5047     }
5048     return true;
5049 }
5050
5051 static void
5052 add_mirror_actions(struct action_xlate_ctx *ctx, const struct flow *orig_flow)
5053 {
5054     struct ofproto_dpif *ofproto = ctx->ofproto;
5055     mirror_mask_t mirrors;
5056     struct ofbundle *in_bundle;
5057     uint16_t vlan;
5058     uint16_t vid;
5059     const struct nlattr *a;
5060     size_t left;
5061
5062     in_bundle = lookup_input_bundle(ctx->ofproto, orig_flow->in_port,
5063                                     ctx->packet != NULL);
5064     if (!in_bundle) {
5065         return;
5066     }
5067     mirrors = in_bundle->src_mirrors;
5068
5069     /* Drop frames on bundles reserved for mirroring. */
5070     if (in_bundle->mirror_out) {
5071         if (ctx->packet != NULL) {
5072             static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
5073             VLOG_WARN_RL(&rl, "bridge %s: dropping packet received on port "
5074                          "%s, which is reserved exclusively for mirroring",
5075                          ctx->ofproto->up.name, in_bundle->name);
5076         }
5077         return;
5078     }
5079
5080     /* Check VLAN. */
5081     vid = vlan_tci_to_vid(orig_flow->vlan_tci);
5082     if (!input_vid_is_valid(vid, in_bundle, ctx->packet != NULL)) {
5083         return;
5084     }
5085     vlan = input_vid_to_vlan(in_bundle, vid);
5086
5087     /* Look at the output ports to check for destination selections. */
5088
5089     NL_ATTR_FOR_EACH (a, left, ctx->odp_actions->data,
5090                       ctx->odp_actions->size) {
5091         enum ovs_action_attr type = nl_attr_type(a);
5092         struct ofport_dpif *ofport;
5093
5094         if (type != OVS_ACTION_ATTR_OUTPUT) {
5095             continue;
5096         }
5097
5098         ofport = get_odp_port(ofproto, nl_attr_get_u32(a));
5099         if (ofport && ofport->bundle) {
5100             mirrors |= ofport->bundle->dst_mirrors;
5101         }
5102     }
5103
5104     if (!mirrors) {
5105         return;
5106     }
5107
5108     /* Restore the original packet before adding the mirror actions. */
5109     ctx->flow = *orig_flow;
5110
5111     while (mirrors) {
5112         struct ofmirror *m;
5113
5114         m = ofproto->mirrors[mirror_mask_ffs(mirrors) - 1];
5115
5116         if (!vlan_is_mirrored(m, vlan)) {
5117             mirrors &= mirrors - 1;
5118             continue;
5119         }
5120
5121         mirrors &= ~m->dup_mirrors;
5122         ctx->mirrors |= m->dup_mirrors;
5123         if (m->out) {
5124             output_normal(ctx, m->out, vlan);
5125         } else if (eth_dst_may_rspan(orig_flow->dl_dst)
5126                    && vlan != m->out_vlan) {
5127             struct ofbundle *bundle;
5128
5129             HMAP_FOR_EACH (bundle, hmap_node, &ofproto->bundles) {
5130                 if (ofbundle_includes_vlan(bundle, m->out_vlan)
5131                     && !bundle->mirror_out) {
5132                     output_normal(ctx, bundle, m->out_vlan);
5133                 }
5134             }
5135         }
5136     }
5137 }
5138
5139 static void
5140 update_mirror_stats(struct ofproto_dpif *ofproto, mirror_mask_t mirrors,
5141                     uint64_t packets, uint64_t bytes)
5142 {
5143     if (!mirrors) {
5144         return;
5145     }
5146
5147     for (; mirrors; mirrors &= mirrors - 1) {
5148         struct ofmirror *m;
5149
5150         m = ofproto->mirrors[mirror_mask_ffs(mirrors) - 1];
5151
5152         if (!m) {
5153             /* In normal circumstances 'm' will not be NULL.  However,
5154              * if mirrors are reconfigured, we can temporarily get out
5155              * of sync in facet_revalidate().  We could "correct" the
5156              * mirror list before reaching here, but doing that would
5157              * not properly account the traffic stats we've currently
5158              * accumulated for previous mirror configuration. */
5159             continue;
5160         }
5161
5162         m->packet_count += packets;
5163         m->byte_count += bytes;
5164     }
5165 }
5166
5167 /* A VM broadcasts a gratuitous ARP to indicate that it has resumed after
5168  * migration.  Older Citrix-patched Linux DomU used gratuitous ARP replies to
5169  * indicate this; newer upstream kernels use gratuitous ARP requests. */
5170 static bool
5171 is_gratuitous_arp(const struct flow *flow)
5172 {
5173     return (flow->dl_type == htons(ETH_TYPE_ARP)
5174             && eth_addr_is_broadcast(flow->dl_dst)
5175             && (flow->nw_proto == ARP_OP_REPLY
5176                 || (flow->nw_proto == ARP_OP_REQUEST
5177                     && flow->nw_src == flow->nw_dst)));
5178 }
5179
5180 static void
5181 update_learning_table(struct ofproto_dpif *ofproto,
5182                       const struct flow *flow, int vlan,
5183                       struct ofbundle *in_bundle)
5184 {
5185     struct mac_entry *mac;
5186
5187     /* Don't learn the OFPP_NONE port. */
5188     if (in_bundle == &ofpp_none_bundle) {
5189         return;
5190     }
5191
5192     if (!mac_learning_may_learn(ofproto->ml, flow->dl_src, vlan)) {
5193         return;
5194     }
5195
5196     mac = mac_learning_insert(ofproto->ml, flow->dl_src, vlan);
5197     if (is_gratuitous_arp(flow)) {
5198         /* We don't want to learn from gratuitous ARP packets that are
5199          * reflected back over bond slaves so we lock the learning table. */
5200         if (!in_bundle->bond) {
5201             mac_entry_set_grat_arp_lock(mac);
5202         } else if (mac_entry_is_grat_arp_locked(mac)) {
5203             return;
5204         }
5205     }
5206
5207     if (mac_entry_is_new(mac) || mac->port.p != in_bundle) {
5208         /* The log messages here could actually be useful in debugging,
5209          * so keep the rate limit relatively high. */
5210         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(30, 300);
5211         VLOG_DBG_RL(&rl, "bridge %s: learned that "ETH_ADDR_FMT" is "
5212                     "on port %s in VLAN %d",
5213                     ofproto->up.name, ETH_ADDR_ARGS(flow->dl_src),
5214                     in_bundle->name, vlan);
5215
5216         mac->port.p = in_bundle;
5217         tag_set_add(&ofproto->revalidate_set,
5218                     mac_learning_changed(ofproto->ml, mac));
5219     }
5220 }
5221
5222 static struct ofbundle *
5223 lookup_input_bundle(struct ofproto_dpif *ofproto, uint16_t in_port, bool warn)
5224 {
5225     struct ofport_dpif *ofport;
5226
5227     /* Special-case OFPP_NONE, which a controller may use as the ingress
5228      * port for traffic that it is sourcing. */
5229     if (in_port == OFPP_NONE) {
5230         return &ofpp_none_bundle;
5231     }
5232
5233     /* Find the port and bundle for the received packet. */
5234     ofport = get_ofp_port(ofproto, in_port);
5235     if (ofport && ofport->bundle) {
5236         return ofport->bundle;
5237     }
5238
5239     /* Odd.  A few possible reasons here:
5240      *
5241      * - We deleted a port but there are still a few packets queued up
5242      *   from it.
5243      *
5244      * - Someone externally added a port (e.g. "ovs-dpctl add-if") that
5245      *   we don't know about.
5246      *
5247      * - The ofproto client didn't configure the port as part of a bundle.
5248      */
5249     if (warn) {
5250         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
5251
5252         VLOG_WARN_RL(&rl, "bridge %s: received packet on unknown "
5253                      "port %"PRIu16, ofproto->up.name, in_port);
5254     }
5255     return NULL;
5256 }
5257
5258 /* Determines whether packets in 'flow' within 'ofproto' should be forwarded or
5259  * dropped.  Returns true if they may be forwarded, false if they should be
5260  * dropped.
5261  *
5262  * 'in_port' must be the ofport_dpif that corresponds to flow->in_port.
5263  * 'in_port' must be part of a bundle (e.g. in_port->bundle must be nonnull).
5264  *
5265  * 'vlan' must be the VLAN that corresponds to flow->vlan_tci on 'in_port', as
5266  * returned by input_vid_to_vlan().  It must be a valid VLAN for 'in_port', as
5267  * checked by input_vid_is_valid().
5268  *
5269  * May also add tags to '*tags', although the current implementation only does
5270  * so in one special case.
5271  */
5272 static bool
5273 is_admissible(struct ofproto_dpif *ofproto, const struct flow *flow,
5274               struct ofport_dpif *in_port, uint16_t vlan, tag_type *tags)
5275 {
5276     struct ofbundle *in_bundle = in_port->bundle;
5277
5278     /* Drop frames for reserved multicast addresses
5279      * only if forward_bpdu option is absent. */
5280     if (eth_addr_is_reserved(flow->dl_dst) && !ofproto->up.forward_bpdu) {
5281         return false;
5282     }
5283
5284     if (in_bundle->bond) {
5285         struct mac_entry *mac;
5286
5287         switch (bond_check_admissibility(in_bundle->bond, in_port,
5288                                          flow->dl_dst, tags)) {
5289         case BV_ACCEPT:
5290             break;
5291
5292         case BV_DROP:
5293             return false;
5294
5295         case BV_DROP_IF_MOVED:
5296             mac = mac_learning_lookup(ofproto->ml, flow->dl_src, vlan, NULL);
5297             if (mac && mac->port.p != in_bundle &&
5298                 (!is_gratuitous_arp(flow)
5299                  || mac_entry_is_grat_arp_locked(mac))) {
5300                 return false;
5301             }
5302             break;
5303         }
5304     }
5305
5306     return true;
5307 }
5308
5309 static void
5310 xlate_normal(struct action_xlate_ctx *ctx)
5311 {
5312     struct ofport_dpif *in_port;
5313     struct ofbundle *in_bundle;
5314     struct mac_entry *mac;
5315     uint16_t vlan;
5316     uint16_t vid;
5317
5318     ctx->has_normal = true;
5319
5320     in_bundle = lookup_input_bundle(ctx->ofproto, ctx->flow.in_port,
5321                                   ctx->packet != NULL);
5322     if (!in_bundle) {
5323         return;
5324     }
5325
5326     /* We know 'in_port' exists unless it is "ofpp_none_bundle",
5327      * since lookup_input_bundle() succeeded. */
5328     in_port = get_ofp_port(ctx->ofproto, ctx->flow.in_port);
5329
5330     /* Drop malformed frames. */
5331     if (ctx->flow.dl_type == htons(ETH_TYPE_VLAN) &&
5332         !(ctx->flow.vlan_tci & htons(VLAN_CFI))) {
5333         if (ctx->packet != NULL) {
5334             static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
5335             VLOG_WARN_RL(&rl, "bridge %s: dropping packet with partial "
5336                          "VLAN tag received on port %s",
5337                          ctx->ofproto->up.name, in_bundle->name);
5338         }
5339         return;
5340     }
5341
5342     /* Drop frames on bundles reserved for mirroring. */
5343     if (in_bundle->mirror_out) {
5344         if (ctx->packet != NULL) {
5345             static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
5346             VLOG_WARN_RL(&rl, "bridge %s: dropping packet received on port "
5347                          "%s, which is reserved exclusively for mirroring",
5348                          ctx->ofproto->up.name, in_bundle->name);
5349         }
5350         return;
5351     }
5352
5353     /* Check VLAN. */
5354     vid = vlan_tci_to_vid(ctx->flow.vlan_tci);
5355     if (!input_vid_is_valid(vid, in_bundle, ctx->packet != NULL)) {
5356         return;
5357     }
5358     vlan = input_vid_to_vlan(in_bundle, vid);
5359
5360     /* Check other admissibility requirements. */
5361     if (in_port &&
5362          !is_admissible(ctx->ofproto, &ctx->flow, in_port, vlan, &ctx->tags)) {
5363         return;
5364     }
5365
5366     /* Learn source MAC. */
5367     if (ctx->may_learn) {
5368         update_learning_table(ctx->ofproto, &ctx->flow, vlan, in_bundle);
5369     }
5370
5371     /* Determine output bundle. */
5372     mac = mac_learning_lookup(ctx->ofproto->ml, ctx->flow.dl_dst, vlan,
5373                               &ctx->tags);
5374     if (mac) {
5375         if (mac->port.p != in_bundle) {
5376             output_normal(ctx, mac->port.p, vlan);
5377         }
5378     } else {
5379         struct ofbundle *bundle;
5380
5381         HMAP_FOR_EACH (bundle, hmap_node, &ctx->ofproto->bundles) {
5382             if (bundle != in_bundle
5383                 && ofbundle_includes_vlan(bundle, vlan)
5384                 && bundle->floodable
5385                 && !bundle->mirror_out) {
5386                 output_normal(ctx, bundle, vlan);
5387             }
5388         }
5389         ctx->nf_output_iface = NF_OUT_FLOOD;
5390     }
5391 }
5392 \f
5393 /* Optimized flow revalidation.
5394  *
5395  * It's a difficult problem, in general, to tell which facets need to have
5396  * their actions recalculated whenever the OpenFlow flow table changes.  We
5397  * don't try to solve that general problem: for most kinds of OpenFlow flow
5398  * table changes, we recalculate the actions for every facet.  This is
5399  * relatively expensive, but it's good enough if the OpenFlow flow table
5400  * doesn't change very often.
5401  *
5402  * However, we can expect one particular kind of OpenFlow flow table change to
5403  * happen frequently: changes caused by MAC learning.  To avoid wasting a lot
5404  * of CPU on revalidating every facet whenever MAC learning modifies the flow
5405  * table, we add a special case that applies to flow tables in which every rule
5406  * has the same form (that is, the same wildcards), except that the table is
5407  * also allowed to have a single "catch-all" flow that matches all packets.  We
5408  * optimize this case by tagging all of the facets that resubmit into the table
5409  * and invalidating the same tag whenever a flow changes in that table.  The
5410  * end result is that we revalidate just the facets that need it (and sometimes
5411  * a few more, but not all of the facets or even all of the facets that
5412  * resubmit to the table modified by MAC learning). */
5413
5414 /* Calculates the tag to use for 'flow' and wildcards 'wc' when it is inserted
5415  * into an OpenFlow table with the given 'basis'. */
5416 static uint32_t
5417 rule_calculate_tag(const struct flow *flow, const struct flow_wildcards *wc,
5418                    uint32_t secret)
5419 {
5420     if (flow_wildcards_is_catchall(wc)) {
5421         return 0;
5422     } else {
5423         struct flow tag_flow = *flow;
5424         flow_zero_wildcards(&tag_flow, wc);
5425         return tag_create_deterministic(flow_hash(&tag_flow, secret));
5426     }
5427 }
5428
5429 /* Following a change to OpenFlow table 'table_id' in 'ofproto', update the
5430  * taggability of that table.
5431  *
5432  * This function must be called after *each* change to a flow table.  If you
5433  * skip calling it on some changes then the pointer comparisons at the end can
5434  * be invalid if you get unlucky.  For example, if a flow removal causes a
5435  * cls_table to be destroyed and then a flow insertion causes a cls_table with
5436  * different wildcards to be created with the same address, then this function
5437  * will incorrectly skip revalidation. */
5438 static void
5439 table_update_taggable(struct ofproto_dpif *ofproto, uint8_t table_id)
5440 {
5441     struct table_dpif *table = &ofproto->tables[table_id];
5442     const struct classifier *cls = &ofproto->up.tables[table_id];
5443     struct cls_table *catchall, *other;
5444     struct cls_table *t;
5445
5446     catchall = other = NULL;
5447
5448     switch (hmap_count(&cls->tables)) {
5449     case 0:
5450         /* We could tag this OpenFlow table but it would make the logic a
5451          * little harder and it's a corner case that doesn't seem worth it
5452          * yet. */
5453         break;
5454
5455     case 1:
5456     case 2:
5457         HMAP_FOR_EACH (t, hmap_node, &cls->tables) {
5458             if (cls_table_is_catchall(t)) {
5459                 catchall = t;
5460             } else if (!other) {
5461                 other = t;
5462             } else {
5463                 /* Indicate that we can't tag this by setting both tables to
5464                  * NULL.  (We know that 'catchall' is already NULL.) */
5465                 other = NULL;
5466             }
5467         }
5468         break;
5469
5470     default:
5471         /* Can't tag this table. */
5472         break;
5473     }
5474
5475     if (table->catchall_table != catchall || table->other_table != other) {
5476         table->catchall_table = catchall;
5477         table->other_table = other;
5478         ofproto->need_revalidate = true;
5479     }
5480 }
5481
5482 /* Given 'rule' that has changed in some way (either it is a rule being
5483  * inserted, a rule being deleted, or a rule whose actions are being
5484  * modified), marks facets for revalidation to ensure that packets will be
5485  * forwarded correctly according to the new state of the flow table.
5486  *
5487  * This function must be called after *each* change to a flow table.  See
5488  * the comment on table_update_taggable() for more information. */
5489 static void
5490 rule_invalidate(const struct rule_dpif *rule)
5491 {
5492     struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
5493
5494     table_update_taggable(ofproto, rule->up.table_id);
5495
5496     if (!ofproto->need_revalidate) {
5497         struct table_dpif *table = &ofproto->tables[rule->up.table_id];
5498
5499         if (table->other_table && rule->tag) {
5500             tag_set_add(&ofproto->revalidate_set, rule->tag);
5501         } else {
5502             ofproto->need_revalidate = true;
5503         }
5504     }
5505 }
5506 \f
5507 static bool
5508 set_frag_handling(struct ofproto *ofproto_,
5509                   enum ofp_config_flags frag_handling)
5510 {
5511     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
5512
5513     if (frag_handling != OFPC_FRAG_REASM) {
5514         ofproto->need_revalidate = true;
5515         return true;
5516     } else {
5517         return false;
5518     }
5519 }
5520
5521 static enum ofperr
5522 packet_out(struct ofproto *ofproto_, struct ofpbuf *packet,
5523            const struct flow *flow,
5524            const union ofp_action *ofp_actions, size_t n_ofp_actions)
5525 {
5526     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
5527     enum ofperr error;
5528
5529     if (flow->in_port >= ofproto->max_ports && flow->in_port < OFPP_MAX) {
5530         return OFPERR_NXBRC_BAD_IN_PORT;
5531     }
5532
5533     error = validate_actions(ofp_actions, n_ofp_actions, flow,
5534                              ofproto->max_ports);
5535     if (!error) {
5536         struct odputil_keybuf keybuf;
5537         struct ofpbuf *odp_actions;
5538         struct ofproto_push push;
5539         struct ofpbuf key;
5540
5541         ofpbuf_use_stack(&key, &keybuf, sizeof keybuf);
5542         odp_flow_key_from_flow(&key, flow);
5543
5544         action_xlate_ctx_init(&push.ctx, ofproto, flow, flow->vlan_tci, 0,
5545                               packet);
5546
5547         /* Ensure that resubmits in 'ofp_actions' get accounted to their
5548          * matching rules. */
5549         push.packets = 1;
5550         push.bytes = packet->size;
5551         push.used = time_msec();
5552         push.ctx.resubmit_hook = push_resubmit;
5553
5554         odp_actions = xlate_actions(&push.ctx, ofp_actions, n_ofp_actions);
5555         dpif_execute(ofproto->dpif, key.data, key.size,
5556                      odp_actions->data, odp_actions->size, packet);
5557         ofpbuf_delete(odp_actions);
5558     }
5559     return error;
5560 }
5561 \f
5562 /* NetFlow. */
5563
5564 static int
5565 set_netflow(struct ofproto *ofproto_,
5566             const struct netflow_options *netflow_options)
5567 {
5568     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
5569
5570     if (netflow_options) {
5571         if (!ofproto->netflow) {
5572             ofproto->netflow = netflow_create();
5573         }
5574         return netflow_set_options(ofproto->netflow, netflow_options);
5575     } else {
5576         netflow_destroy(ofproto->netflow);
5577         ofproto->netflow = NULL;
5578         return 0;
5579     }
5580 }
5581
5582 static void
5583 get_netflow_ids(const struct ofproto *ofproto_,
5584                 uint8_t *engine_type, uint8_t *engine_id)
5585 {
5586     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
5587
5588     dpif_get_netflow_ids(ofproto->dpif, engine_type, engine_id);
5589 }
5590
5591 static void
5592 send_active_timeout(struct ofproto_dpif *ofproto, struct facet *facet)
5593 {
5594     if (!facet_is_controller_flow(facet) &&
5595         netflow_active_timeout_expired(ofproto->netflow, &facet->nf_flow)) {
5596         struct subfacet *subfacet;
5597         struct ofexpired expired;
5598
5599         LIST_FOR_EACH (subfacet, list_node, &facet->subfacets) {
5600             if (subfacet->installed) {
5601                 struct dpif_flow_stats stats;
5602
5603                 subfacet_install(ofproto, subfacet, subfacet->actions,
5604                                  subfacet->actions_len, &stats);
5605                 subfacet_update_stats(ofproto, subfacet, &stats);
5606             }
5607         }
5608
5609         expired.flow = facet->flow;
5610         expired.packet_count = facet->packet_count;
5611         expired.byte_count = facet->byte_count;
5612         expired.used = facet->used;
5613         netflow_expire(ofproto->netflow, &facet->nf_flow, &expired);
5614     }
5615 }
5616
5617 static void
5618 send_netflow_active_timeouts(struct ofproto_dpif *ofproto)
5619 {
5620     struct facet *facet;
5621
5622     HMAP_FOR_EACH (facet, hmap_node, &ofproto->facets) {
5623         send_active_timeout(ofproto, facet);
5624     }
5625 }
5626 \f
5627 static struct ofproto_dpif *
5628 ofproto_dpif_lookup(const char *name)
5629 {
5630     struct ofproto_dpif *ofproto;
5631
5632     HMAP_FOR_EACH_WITH_HASH (ofproto, all_ofproto_dpifs_node,
5633                              hash_string(name, 0), &all_ofproto_dpifs) {
5634         if (!strcmp(ofproto->up.name, name)) {
5635             return ofproto;
5636         }
5637     }
5638     return NULL;
5639 }
5640
5641 static void
5642 ofproto_unixctl_fdb_flush(struct unixctl_conn *conn, int argc OVS_UNUSED,
5643                           const char *argv[], void *aux OVS_UNUSED)
5644 {
5645     const struct ofproto_dpif *ofproto;
5646
5647     ofproto = ofproto_dpif_lookup(argv[1]);
5648     if (!ofproto) {
5649         unixctl_command_reply(conn, 501, "no such bridge");
5650         return;
5651     }
5652     mac_learning_flush(ofproto->ml);
5653
5654     unixctl_command_reply(conn, 200, "table successfully flushed");
5655 }
5656
5657 static void
5658 ofproto_unixctl_fdb_show(struct unixctl_conn *conn, int argc OVS_UNUSED,
5659                          const char *argv[], void *aux OVS_UNUSED)
5660 {
5661     struct ds ds = DS_EMPTY_INITIALIZER;
5662     const struct ofproto_dpif *ofproto;
5663     const struct mac_entry *e;
5664
5665     ofproto = ofproto_dpif_lookup(argv[1]);
5666     if (!ofproto) {
5667         unixctl_command_reply(conn, 501, "no such bridge");
5668         return;
5669     }
5670
5671     ds_put_cstr(&ds, " port  VLAN  MAC                Age\n");
5672     LIST_FOR_EACH (e, lru_node, &ofproto->ml->lrus) {
5673         struct ofbundle *bundle = e->port.p;
5674         ds_put_format(&ds, "%5d  %4d  "ETH_ADDR_FMT"  %3d\n",
5675                       ofbundle_get_a_port(bundle)->odp_port,
5676                       e->vlan, ETH_ADDR_ARGS(e->mac), mac_entry_age(e));
5677     }
5678     unixctl_command_reply(conn, 200, ds_cstr(&ds));
5679     ds_destroy(&ds);
5680 }
5681
5682 struct ofproto_trace {
5683     struct action_xlate_ctx ctx;
5684     struct flow flow;
5685     struct ds *result;
5686 };
5687
5688 static void
5689 trace_format_rule(struct ds *result, uint8_t table_id, int level,
5690                   const struct rule_dpif *rule)
5691 {
5692     ds_put_char_multiple(result, '\t', level);
5693     if (!rule) {
5694         ds_put_cstr(result, "No match\n");
5695         return;
5696     }
5697
5698     ds_put_format(result, "Rule: table=%"PRIu8" cookie=%#"PRIx64" ",
5699                   table_id, ntohll(rule->up.flow_cookie));
5700     cls_rule_format(&rule->up.cr, result);
5701     ds_put_char(result, '\n');
5702
5703     ds_put_char_multiple(result, '\t', level);
5704     ds_put_cstr(result, "OpenFlow ");
5705     ofp_print_actions(result, rule->up.actions, rule->up.n_actions);
5706     ds_put_char(result, '\n');
5707 }
5708
5709 static void
5710 trace_format_flow(struct ds *result, int level, const char *title,
5711                  struct ofproto_trace *trace)
5712 {
5713     ds_put_char_multiple(result, '\t', level);
5714     ds_put_format(result, "%s: ", title);
5715     if (flow_equal(&trace->ctx.flow, &trace->flow)) {
5716         ds_put_cstr(result, "unchanged");
5717     } else {
5718         flow_format(result, &trace->ctx.flow);
5719         trace->flow = trace->ctx.flow;
5720     }
5721     ds_put_char(result, '\n');
5722 }
5723
5724 static void
5725 trace_format_regs(struct ds *result, int level, const char *title,
5726                   struct ofproto_trace *trace)
5727 {
5728     size_t i;
5729
5730     ds_put_char_multiple(result, '\t', level);
5731     ds_put_format(result, "%s:", title);
5732     for (i = 0; i < FLOW_N_REGS; i++) {
5733         ds_put_format(result, " reg%zu=0x%"PRIx32, i, trace->flow.regs[i]);
5734     }
5735     ds_put_char(result, '\n');
5736 }
5737
5738 static void
5739 trace_resubmit(struct action_xlate_ctx *ctx, struct rule_dpif *rule)
5740 {
5741     struct ofproto_trace *trace = CONTAINER_OF(ctx, struct ofproto_trace, ctx);
5742     struct ds *result = trace->result;
5743
5744     ds_put_char(result, '\n');
5745     trace_format_flow(result, ctx->recurse + 1, "Resubmitted flow", trace);
5746     trace_format_regs(result, ctx->recurse + 1, "Resubmitted regs", trace);
5747     trace_format_rule(result, ctx->table_id, ctx->recurse + 1, rule);
5748 }
5749
5750 static void
5751 ofproto_unixctl_trace(struct unixctl_conn *conn, int argc, const char *argv[],
5752                       void *aux OVS_UNUSED)
5753 {
5754     const char *dpname = argv[1];
5755     struct ofproto_dpif *ofproto;
5756     struct ofpbuf odp_key;
5757     struct ofpbuf *packet;
5758     struct rule_dpif *rule;
5759     ovs_be16 initial_tci;
5760     struct ds result;
5761     struct flow flow;
5762     char *s;
5763
5764     packet = NULL;
5765     ofpbuf_init(&odp_key, 0);
5766     ds_init(&result);
5767
5768     ofproto = ofproto_dpif_lookup(dpname);
5769     if (!ofproto) {
5770         unixctl_command_reply(conn, 501, "Unknown ofproto (use ofproto/list "
5771                               "for help)");
5772         goto exit;
5773     }
5774     if (argc == 3 || (argc == 4 && !strcmp(argv[3], "-generate"))) {
5775         /* ofproto/trace dpname flow [-generate] */
5776         const char *flow_s = argv[2];
5777         const char *generate_s = argv[3];
5778         int error;
5779
5780         /* Convert string to datapath key. */
5781         ofpbuf_init(&odp_key, 0);
5782         error = odp_flow_key_from_string(flow_s, NULL, &odp_key);
5783         if (error) {
5784             unixctl_command_reply(conn, 501, "Bad flow syntax");
5785             goto exit;
5786         }
5787
5788         /* Convert odp_key to flow. */
5789         error = ofproto_dpif_extract_flow_key(ofproto, odp_key.data,
5790                                               odp_key.size, &flow,
5791                                               &initial_tci, NULL);
5792         if (error == ODP_FIT_ERROR) {
5793             unixctl_command_reply(conn, 501, "Invalid flow");
5794             goto exit;
5795         }
5796
5797         /* Generate a packet, if requested. */
5798         if (generate_s) {
5799             packet = ofpbuf_new(0);
5800             flow_compose(packet, &flow);
5801         }
5802     } else if (argc == 6) {
5803         /* ofproto/trace dpname priority tun_id in_port packet */
5804         const char *priority_s = argv[2];
5805         const char *tun_id_s = argv[3];
5806         const char *in_port_s = argv[4];
5807         const char *packet_s = argv[5];
5808         uint16_t in_port = ofp_port_to_odp_port(atoi(in_port_s));
5809         ovs_be64 tun_id = htonll(strtoull(tun_id_s, NULL, 0));
5810         uint32_t priority = atoi(priority_s);
5811         const char *msg;
5812
5813         msg = eth_from_hex(packet_s, &packet);
5814         if (msg) {
5815             unixctl_command_reply(conn, 501, msg);
5816             goto exit;
5817         }
5818
5819         ds_put_cstr(&result, "Packet: ");
5820         s = ofp_packet_to_string(packet->data, packet->size);
5821         ds_put_cstr(&result, s);
5822         free(s);
5823
5824         flow_extract(packet, priority, tun_id, in_port, &flow);
5825         initial_tci = flow.vlan_tci;
5826     } else {
5827         unixctl_command_reply(conn, 501, "Bad command syntax");
5828         goto exit;
5829     }
5830
5831     ds_put_cstr(&result, "Flow: ");
5832     flow_format(&result, &flow);
5833     ds_put_char(&result, '\n');
5834
5835     rule = rule_dpif_lookup(ofproto, &flow, 0);
5836     trace_format_rule(&result, 0, 0, rule);
5837     if (rule) {
5838         struct ofproto_trace trace;
5839         struct ofpbuf *odp_actions;
5840
5841         trace.result = &result;
5842         trace.flow = flow;
5843         action_xlate_ctx_init(&trace.ctx, ofproto, &flow, initial_tci,
5844                               rule->up.flow_cookie, packet);
5845         trace.ctx.resubmit_hook = trace_resubmit;
5846         odp_actions = xlate_actions(&trace.ctx,
5847                                     rule->up.actions, rule->up.n_actions);
5848
5849         ds_put_char(&result, '\n');
5850         trace_format_flow(&result, 0, "Final flow", &trace);
5851         ds_put_cstr(&result, "Datapath actions: ");
5852         format_odp_actions(&result, odp_actions->data, odp_actions->size);
5853         ofpbuf_delete(odp_actions);
5854
5855         if (!trace.ctx.may_set_up_flow) {
5856             if (packet) {
5857                 ds_put_cstr(&result, "\nThis flow is not cachable.");
5858             } else {
5859                 ds_put_cstr(&result, "\nThe datapath actions are incomplete--"
5860                             "for complete actions, please supply a packet.");
5861             }
5862         }
5863     }
5864
5865     unixctl_command_reply(conn, 200, ds_cstr(&result));
5866
5867 exit:
5868     ds_destroy(&result);
5869     ofpbuf_delete(packet);
5870     ofpbuf_uninit(&odp_key);
5871 }
5872
5873 static void
5874 ofproto_dpif_clog(struct unixctl_conn *conn OVS_UNUSED, int argc OVS_UNUSED,
5875                   const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED)
5876 {
5877     clogged = true;
5878     unixctl_command_reply(conn, 200, NULL);
5879 }
5880
5881 static void
5882 ofproto_dpif_unclog(struct unixctl_conn *conn OVS_UNUSED, int argc OVS_UNUSED,
5883                     const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED)
5884 {
5885     clogged = false;
5886     unixctl_command_reply(conn, 200, NULL);
5887 }
5888
5889 static void
5890 ofproto_dpif_unixctl_init(void)
5891 {
5892     static bool registered;
5893     if (registered) {
5894         return;
5895     }
5896     registered = true;
5897
5898     unixctl_command_register(
5899         "ofproto/trace",
5900         "bridge {tun_id in_port packet | odp_flow [-generate]}",
5901         2, 4, ofproto_unixctl_trace, NULL);
5902     unixctl_command_register("fdb/flush", "bridge", 1, 1,
5903                              ofproto_unixctl_fdb_flush, NULL);
5904     unixctl_command_register("fdb/show", "bridge", 1, 1,
5905                              ofproto_unixctl_fdb_show, NULL);
5906     unixctl_command_register("ofproto/clog", "", 0, 0,
5907                              ofproto_dpif_clog, NULL);
5908     unixctl_command_register("ofproto/unclog", "", 0, 0,
5909                              ofproto_dpif_unclog, NULL);
5910 }
5911 \f
5912 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
5913  *
5914  * This is deprecated.  It is only for compatibility with broken device drivers
5915  * in old versions of Linux that do not properly support VLANs when VLAN
5916  * devices are not used.  When broken device drivers are no longer in
5917  * widespread use, we will delete these interfaces. */
5918
5919 static int
5920 set_realdev(struct ofport *ofport_, uint16_t realdev_ofp_port, int vid)
5921 {
5922     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofport_->ofproto);
5923     struct ofport_dpif *ofport = ofport_dpif_cast(ofport_);
5924
5925     if (realdev_ofp_port == ofport->realdev_ofp_port
5926         && vid == ofport->vlandev_vid) {
5927         return 0;
5928     }
5929
5930     ofproto->need_revalidate = true;
5931
5932     if (ofport->realdev_ofp_port) {
5933         vsp_remove(ofport);
5934     }
5935     if (realdev_ofp_port && ofport->bundle) {
5936         /* vlandevs are enslaved to their realdevs, so they are not allowed to
5937          * themselves be part of a bundle. */
5938         bundle_set(ofport->up.ofproto, ofport->bundle, NULL);
5939     }
5940
5941     ofport->realdev_ofp_port = realdev_ofp_port;
5942     ofport->vlandev_vid = vid;
5943
5944     if (realdev_ofp_port) {
5945         vsp_add(ofport, realdev_ofp_port, vid);
5946     }
5947
5948     return 0;
5949 }
5950
5951 static uint32_t
5952 hash_realdev_vid(uint16_t realdev_ofp_port, int vid)
5953 {
5954     return hash_2words(realdev_ofp_port, vid);
5955 }
5956
5957 static uint32_t
5958 vsp_realdev_to_vlandev(const struct ofproto_dpif *ofproto,
5959                        uint32_t realdev_odp_port, ovs_be16 vlan_tci)
5960 {
5961     if (!hmap_is_empty(&ofproto->realdev_vid_map)) {
5962         uint16_t realdev_ofp_port = odp_port_to_ofp_port(realdev_odp_port);
5963         int vid = vlan_tci_to_vid(vlan_tci);
5964         const struct vlan_splinter *vsp;
5965
5966         HMAP_FOR_EACH_WITH_HASH (vsp, realdev_vid_node,
5967                                  hash_realdev_vid(realdev_ofp_port, vid),
5968                                  &ofproto->realdev_vid_map) {
5969             if (vsp->realdev_ofp_port == realdev_ofp_port
5970                 && vsp->vid == vid) {
5971                 return ofp_port_to_odp_port(vsp->vlandev_ofp_port);
5972             }
5973         }
5974     }
5975     return realdev_odp_port;
5976 }
5977
5978 static struct vlan_splinter *
5979 vlandev_find(const struct ofproto_dpif *ofproto, uint16_t vlandev_ofp_port)
5980 {
5981     struct vlan_splinter *vsp;
5982
5983     HMAP_FOR_EACH_WITH_HASH (vsp, vlandev_node, hash_int(vlandev_ofp_port, 0),
5984                              &ofproto->vlandev_map) {
5985         if (vsp->vlandev_ofp_port == vlandev_ofp_port) {
5986             return vsp;
5987         }
5988     }
5989
5990     return NULL;
5991 }
5992
5993 static uint16_t
5994 vsp_vlandev_to_realdev(const struct ofproto_dpif *ofproto,
5995                    uint16_t vlandev_ofp_port, int *vid)
5996 {
5997     if (!hmap_is_empty(&ofproto->vlandev_map)) {
5998         const struct vlan_splinter *vsp;
5999
6000         vsp = vlandev_find(ofproto, vlandev_ofp_port);
6001         if (vsp) {
6002             if (vid) {
6003                 *vid = vsp->vid;
6004             }
6005             return vsp->realdev_ofp_port;
6006         }
6007     }
6008     return 0;
6009 }
6010
6011 static void
6012 vsp_remove(struct ofport_dpif *port)
6013 {
6014     struct ofproto_dpif *ofproto = ofproto_dpif_cast(port->up.ofproto);
6015     struct vlan_splinter *vsp;
6016
6017     vsp = vlandev_find(ofproto, port->up.ofp_port);
6018     if (vsp) {
6019         hmap_remove(&ofproto->vlandev_map, &vsp->vlandev_node);
6020         hmap_remove(&ofproto->realdev_vid_map, &vsp->realdev_vid_node);
6021         free(vsp);
6022
6023         port->realdev_ofp_port = 0;
6024     } else {
6025         VLOG_ERR("missing vlan device record");
6026     }
6027 }
6028
6029 static void
6030 vsp_add(struct ofport_dpif *port, uint16_t realdev_ofp_port, int vid)
6031 {
6032     struct ofproto_dpif *ofproto = ofproto_dpif_cast(port->up.ofproto);
6033
6034     if (!vsp_vlandev_to_realdev(ofproto, port->up.ofp_port, NULL)
6035         && (vsp_realdev_to_vlandev(ofproto, realdev_ofp_port, htons(vid))
6036             == realdev_ofp_port)) {
6037         struct vlan_splinter *vsp;
6038
6039         vsp = xmalloc(sizeof *vsp);
6040         hmap_insert(&ofproto->vlandev_map, &vsp->vlandev_node,
6041                     hash_int(port->up.ofp_port, 0));
6042         hmap_insert(&ofproto->realdev_vid_map, &vsp->realdev_vid_node,
6043                     hash_realdev_vid(realdev_ofp_port, vid));
6044         vsp->realdev_ofp_port = realdev_ofp_port;
6045         vsp->vlandev_ofp_port = port->up.ofp_port;
6046         vsp->vid = vid;
6047
6048         port->realdev_ofp_port = realdev_ofp_port;
6049     } else {
6050         VLOG_ERR("duplicate vlan device record");
6051     }
6052 }
6053 \f
6054 const struct ofproto_class ofproto_dpif_class = {
6055     enumerate_types,
6056     enumerate_names,
6057     del,
6058     alloc,
6059     construct,
6060     destruct,
6061     dealloc,
6062     run,
6063     run_fast,
6064     wait,
6065     flush,
6066     get_features,
6067     get_tables,
6068     port_alloc,
6069     port_construct,
6070     port_destruct,
6071     port_dealloc,
6072     port_modified,
6073     port_reconfigured,
6074     port_query_by_name,
6075     port_add,
6076     port_del,
6077     port_get_stats,
6078     port_dump_start,
6079     port_dump_next,
6080     port_dump_done,
6081     port_poll,
6082     port_poll_wait,
6083     port_is_lacp_current,
6084     NULL,                       /* rule_choose_table */
6085     rule_alloc,
6086     rule_construct,
6087     rule_destruct,
6088     rule_dealloc,
6089     rule_get_stats,
6090     rule_execute,
6091     rule_modify_actions,
6092     set_frag_handling,
6093     packet_out,
6094     set_netflow,
6095     get_netflow_ids,
6096     set_sflow,
6097     set_cfm,
6098     get_cfm_fault,
6099     get_cfm_remote_mpids,
6100     set_stp,
6101     get_stp_status,
6102     set_stp_port,
6103     get_stp_port_status,
6104     set_queues,
6105     bundle_set,
6106     bundle_remove,
6107     mirror_set,
6108     mirror_get_stats,
6109     set_flood_vlans,
6110     is_mirror_output_bundle,
6111     forward_bpdu_changed,
6112     set_realdev,
6113 };