ofproto/ofproto-dpif.c

   1 /*
   2  * Copyright (c) 2009, 2010, 2011, 2012, 2013 Nicira, Inc.
   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-dpif.h"
  20 #include "ofproto/ofproto-provider.h"
  21
  22 #include <errno.h>
  23
  24 #include "bfd.h"
  25 #include "bond.h"
  26 #include "bundle.h"
  27 #include "byte-order.h"
  28 #include "connmgr.h"
  29 #include "coverage.h"
  30 #include "cfm.h"
  31 #include "dpif.h"
  32 #include "dynamic-string.h"
  33 #include "fail-open.h"
  34 #include "hmapx.h"
  35 #include "lacp.h"
  36 #include "learn.h"
  37 #include "mac-learning.h"
  38 #include "meta-flow.h"
  39 #include "multipath.h"
  40 #include "netdev-vport.h"
  41 #include "netdev.h"
  42 #include "netlink.h"
  43 #include "nx-match.h"
  44 #include "odp-util.h"
  45 #include "odp-execute.h"
  46 #include "ofp-util.h"
  47 #include "ofpbuf.h"
  48 #include "ofp-actions.h"
  49 #include "ofp-parse.h"
  50 #include "ofp-print.h"
  51 #include "ofproto-dpif-governor.h"
  52 #include "ofproto-dpif-ipfix.h"
  53 #include "ofproto-dpif-sflow.h"
  54 #include "ofproto-dpif-xlate.h"
  55 #include "poll-loop.h"
  56 #include "simap.h"
  57 #include "smap.h"
  58 #include "timer.h"
  59 #include "tunnel.h"
  60 #include "unaligned.h"
  61 #include "unixctl.h"
  62 #include "vlan-bitmap.h"
  63 #include "vlog.h"
  64
  65 VLOG_DEFINE_THIS_MODULE(ofproto_dpif);
  66
  67 COVERAGE_DEFINE(ofproto_dpif_expired);
  68 COVERAGE_DEFINE(facet_changed_rule);
  69 COVERAGE_DEFINE(facet_revalidate);
  70 COVERAGE_DEFINE(facet_unexpected);
  71 COVERAGE_DEFINE(facet_suppress);
  72 COVERAGE_DEFINE(subfacet_install_fail);
  73
  74 struct flow_miss;
  75 struct facet;
  76
  77 static struct rule_dpif *rule_dpif_lookup(struct ofproto_dpif *,
  78                                           const struct flow *,
  79                                           struct flow_wildcards *wc);
  80
  81 static void rule_get_stats(struct rule *, uint64_t *packets, uint64_t *bytes);
  82 static void rule_invalidate(const struct rule_dpif *);
  83
  84 static void mirror_destroy(struct ofmirror *);
  85 static void update_mirror_stats(struct ofproto_dpif *ofproto,
  86                                 mirror_mask_t mirrors,
  87                                 uint64_t packets, uint64_t bytes);
  88
  89 static void bundle_remove(struct ofport *);
  90 static void bundle_update(struct ofbundle *);
  91 static void bundle_destroy(struct ofbundle *);
  92 static void bundle_del_port(struct ofport_dpif *);
  93 static void bundle_run(struct ofbundle *);
  94 static void bundle_wait(struct ofbundle *);
  95
  96 static void stp_run(struct ofproto_dpif *ofproto);
  97 static void stp_wait(struct ofproto_dpif *ofproto);
  98 static int set_stp_port(struct ofport *,
  99                         const struct ofproto_port_stp_settings *);
 100
 101 static void compose_slow_path(const struct ofproto_dpif *, const struct flow *,
 102                               enum slow_path_reason,
 103                               uint64_t *stub, size_t stub_size,
 104                               const struct nlattr **actionsp,
 105                               size_t *actions_lenp);
 106
 107 /* A subfacet (see "struct subfacet" below) has three possible installation
 108  * states:
 109  *
 110  *   - SF_NOT_INSTALLED: Not installed in the datapath.  This will only be the
 111  *     case just after the subfacet is created, just before the subfacet is
 112  *     destroyed, or if the datapath returns an error when we try to install a
 113  *     subfacet.
 114  *
 115  *   - SF_FAST_PATH: The subfacet's actions are installed in the datapath.
 116  *
 117  *   - SF_SLOW_PATH: An action that sends every packet for the subfacet through
 118  *     ofproto_dpif is installed in the datapath.
 119  */
 120 enum subfacet_path {
 121     SF_NOT_INSTALLED,           /* No datapath flow for this subfacet. */
 122     SF_FAST_PATH,               /* Full actions are installed. */
 123     SF_SLOW_PATH,               /* Send-to-userspace action is installed. */
 124 };
 125
 126 /* A dpif flow and actions associated with a facet.
 127  *
 128  * See also the large comment on struct facet. */
 129 struct subfacet {
 130     /* Owners. */
 131     struct hmap_node hmap_node; /* In struct ofproto_dpif 'subfacets' list. */
 132     struct list list_node;      /* In struct facet's 'facets' list. */
 133     struct facet *facet;        /* Owning facet. */
 134     struct dpif_backer *backer; /* Owning backer. */
 135
 136     enum odp_key_fitness key_fitness;
 137     struct nlattr *key;
 138     int key_len;
 139
 140     long long int used;         /* Time last used; time created if not used. */
 141     long long int created;      /* Time created. */
 142
 143     uint64_t dp_packet_count;   /* Last known packet count in the datapath. */
 144     uint64_t dp_byte_count;     /* Last known byte count in the datapath. */
 145
 146     enum subfacet_path path;    /* Installed in datapath? */
 147 };
 148
 149 #define SUBFACET_DESTROY_MAX_BATCH 50
 150
 151 static struct subfacet *subfacet_create(struct facet *, struct flow_miss *miss,
 152                                         long long int now);
 153 static struct subfacet *subfacet_find(struct dpif_backer *,
 154                                       const struct nlattr *key, size_t key_len,
 155                                       uint32_t key_hash);
 156 static void subfacet_destroy(struct subfacet *);
 157 static void subfacet_destroy__(struct subfacet *);
 158 static void subfacet_destroy_batch(struct dpif_backer *,
 159                                    struct subfacet **, int n);
 160 static void subfacet_reset_dp_stats(struct subfacet *,
 161                                     struct dpif_flow_stats *);
 162 static void subfacet_update_stats(struct subfacet *,
 163                                   const struct dpif_flow_stats *);
 164 static int subfacet_install(struct subfacet *,
 165                             const struct ofpbuf *odp_actions,
 166                             struct dpif_flow_stats *);
 167 static void subfacet_uninstall(struct subfacet *);
 168
 169 /* A unique, non-overlapping instantiation of an OpenFlow flow.
 170  *
 171  * A facet associates a "struct flow", which represents the Open vSwitch
 172  * userspace idea of an exact-match flow, with one or more subfacets.
 173  * While the facet is created based on an exact-match flow, it is stored
 174  * within the ofproto based on the wildcards that could be expressed
 175  * based on the flow table and other configuration.  (See the 'wc'
 176  * description in "struct xlate_out" for more details.)
 177  *
 178  * Each subfacet tracks the datapath's idea of the flow equivalent to
 179  * the facet.  When the kernel module (or other dpif implementation) and
 180  * Open vSwitch userspace agree on the definition of a flow key, there
 181  * is exactly one subfacet per facet.  If the dpif implementation
 182  * supports more-specific flow matching than userspace, however, a facet
 183  * can have more than one subfacet.  Examples include the dpif
 184  * implementation not supporting the same wildcards as userspace or some
 185  * distinction in flow that userspace simply doesn't understand.
 186  *
 187  * Flow expiration works in terms of subfacets, so a facet must have at
 188  * least one subfacet or it will never expire, leaking memory. */
 189 struct facet {
 190     /* Owners. */
 191     struct hmap_node hmap_node;  /* In owning ofproto's 'facets' hmap. */
 192     struct list list_node;       /* In owning rule's 'facets' list. */
 193     struct rule_dpif *rule;      /* Owning rule. */
 194
 195     /* Owned data. */
 196     struct list subfacets;
 197     long long int used;         /* Time last used; time created if not used. */
 198
 199     /* Key. */
 200     struct flow flow;           /* Flow of the creating subfacet. */
 201     struct cls_rule cr;         /* In 'ofproto_dpif's facets classifier. */
 202
 203     /* These statistics:
 204      *
 205      *   - Do include packets and bytes sent "by hand", e.g. with
 206      *     dpif_execute().
 207      *
 208      *   - Do include packets and bytes that were obtained from the datapath
 209      *     when a subfacet's statistics were reset (e.g. dpif_flow_put() with
 210      *     DPIF_FP_ZERO_STATS).
 211      *
 212      *   - Do not include packets or bytes that can be obtained from the
 213      *     datapath for any existing subfacet.
 214      */
 215     uint64_t packet_count;       /* Number of packets received. */
 216     uint64_t byte_count;         /* Number of bytes received. */
 217
 218     /* Resubmit statistics. */
 219     uint64_t prev_packet_count;  /* Number of packets from last stats push. */
 220     uint64_t prev_byte_count;    /* Number of bytes from last stats push. */
 221     long long int prev_used;     /* Used time from last stats push. */
 222
 223     /* Accounting. */
 224     uint64_t accounted_bytes;    /* Bytes processed by facet_account(). */
 225     struct netflow_flow nf_flow; /* Per-flow NetFlow tracking data. */
 226     uint8_t tcp_flags;           /* TCP flags seen for this 'rule'. */
 227
 228     struct xlate_out xout;
 229
 230     /* Storage for a single subfacet, to reduce malloc() time and space
 231      * overhead.  (A facet always has at least one subfacet and in the common
 232      * case has exactly one subfacet.  However, 'one_subfacet' may not
 233      * always be valid, since it could have been removed after newer
 234      * subfacets were pushed onto the 'subfacets' list.) */
 235     struct subfacet one_subfacet;
 236
 237     long long int learn_rl;      /* Rate limiter for facet_learn(). */
 238 };
 239
 240 static struct facet *facet_create(const struct flow_miss *, struct rule_dpif *,
 241                                   struct xlate_out *,
 242                                   struct dpif_flow_stats *);
 243 static void facet_remove(struct facet *);
 244 static void facet_free(struct facet *);
 245
 246 static struct facet *facet_find(struct ofproto_dpif *, const struct flow *);
 247 static struct facet *facet_lookup_valid(struct ofproto_dpif *,
 248                                         const struct flow *);
 249 static bool facet_revalidate(struct facet *);
 250 static bool facet_check_consistency(struct facet *);
 251
 252 static void facet_flush_stats(struct facet *);
 253
 254 static void facet_reset_counters(struct facet *);
 255 static void facet_push_stats(struct facet *, bool may_learn);
 256 static void facet_learn(struct facet *);
 257 static void facet_account(struct facet *);
 258 static void push_all_stats(void);
 259
 260 static bool facet_is_controller_flow(struct facet *);
 261
 262 /* Node in 'ofport_dpif''s 'priorities' map.  Used to maintain a map from
 263  * 'priority' (the datapath's term for QoS queue) to the dscp bits which all
 264  * traffic egressing the 'ofport' with that priority should be marked with. */
 265 struct priority_to_dscp {
 266     struct hmap_node hmap_node; /* Node in 'ofport_dpif''s 'priorities' map. */
 267     uint32_t priority;          /* Priority of this queue (see struct flow). */
 268
 269     uint8_t dscp;               /* DSCP bits to mark outgoing traffic with. */
 270 };
 271
 272 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
 273  *
 274  * This is deprecated.  It is only for compatibility with broken device drivers
 275  * in old versions of Linux that do not properly support VLANs when VLAN
 276  * devices are not used.  When broken device drivers are no longer in
 277  * widespread use, we will delete these interfaces. */
 278 struct vlan_splinter {
 279     struct hmap_node realdev_vid_node;
 280     struct hmap_node vlandev_node;
 281     ofp_port_t realdev_ofp_port;
 282     ofp_port_t vlandev_ofp_port;
 283     int vid;
 284 };
 285
 286 static bool vsp_adjust_flow(const struct ofproto_dpif *, struct flow *);
 287 static void vsp_remove(struct ofport_dpif *);
 288 static void vsp_add(struct ofport_dpif *, ofp_port_t realdev_ofp_port, int vid);
 289
 290 static ofp_port_t odp_port_to_ofp_port(const struct ofproto_dpif *,
 291                                        odp_port_t odp_port);
 292
 293 static struct ofport_dpif *
 294 ofport_dpif_cast(const struct ofport *ofport)
 295 {
 296     return ofport ? CONTAINER_OF(ofport, struct ofport_dpif, up) : NULL;
 297 }
 298
 299 static void port_run(struct ofport_dpif *);
 300 static void port_run_fast(struct ofport_dpif *);
 301 static void port_wait(struct ofport_dpif *);
 302 static int set_bfd(struct ofport *, const struct smap *);
 303 static int set_cfm(struct ofport *, const struct cfm_settings *);
 304 static void ofport_clear_priorities(struct ofport_dpif *);
 305 static void ofport_update_peer(struct ofport_dpif *);
 306 static void run_fast_rl(void);
 307
 308 struct dpif_completion {
 309     struct list list_node;
 310     struct ofoperation *op;
 311 };
 312
 313 /* Reasons that we might need to revalidate every facet, and corresponding
 314  * coverage counters.
 315  *
 316  * A value of 0 means that there is no need to revalidate.
 317  *
 318  * It would be nice to have some cleaner way to integrate with coverage
 319  * counters, but with only a few reasons I guess this is good enough for
 320  * now. */
 321 enum revalidate_reason {
 322     REV_RECONFIGURE = 1,       /* Switch configuration changed. */
 323     REV_STP,                   /* Spanning tree protocol port status change. */
 324     REV_PORT_TOGGLED,          /* Port enabled or disabled by CFM, LACP, ...*/
 325     REV_FLOW_TABLE,            /* Flow table changed. */
 326     REV_INCONSISTENCY          /* Facet self-check failed. */
 327 };
 328 COVERAGE_DEFINE(rev_reconfigure);
 329 COVERAGE_DEFINE(rev_stp);
 330 COVERAGE_DEFINE(rev_port_toggled);
 331 COVERAGE_DEFINE(rev_flow_table);
 332 COVERAGE_DEFINE(rev_inconsistency);
 333
 334 /* Drop keys are odp flow keys which have drop flows installed in the kernel.
 335  * These are datapath flows which have no associated ofproto, if they did we
 336  * would use facets. */
 337 struct drop_key {
 338     struct hmap_node hmap_node;
 339     struct nlattr *key;
 340     size_t key_len;
 341 };
 342
 343 struct avg_subfacet_rates {
 344     double add_rate;   /* Moving average of new flows created per minute. */
 345     double del_rate;   /* Moving average of flows deleted per minute. */
 346 };
 347
 348 /* All datapaths of a given type share a single dpif backer instance. */
 349 struct dpif_backer {
 350     char *type;
 351     int refcount;
 352     struct dpif *dpif;
 353     struct timer next_expiration;
 354     struct hmap odp_to_ofport_map; /* ODP port to ofport mapping. */
 355
 356     struct simap tnl_backers;      /* Set of dpif ports backing tunnels. */
 357
 358     /* Facet revalidation flags applying to facets which use this backer. */
 359     enum revalidate_reason need_revalidate; /* Revalidate every facet. */
 360     struct tag_set revalidate_set; /* Revalidate only matching facets. */
 361
 362     struct hmap drop_keys; /* Set of dropped odp keys. */
 363     bool recv_set_enable; /* Enables or disables receiving packets. */
 364
 365     struct hmap subfacets;
 366     struct governor *governor;
 367
 368     /* Subfacet statistics.
 369      *
 370      * These keep track of the total number of subfacets added and deleted and
 371      * flow life span.  They are useful for computing the flow rates stats
 372      * exposed via "ovs-appctl dpif/show".  The goal is to learn about
 373      * traffic patterns in ways that we can use later to improve Open vSwitch
 374      * performance in new situations.  */
 375     long long int created;           /* Time when it is created. */
 376     unsigned max_n_subfacet;         /* Maximum number of flows */
 377     unsigned avg_n_subfacet;         /* Average number of flows. */
 378     long long int avg_subfacet_life; /* Average life span of subfacets. */
 379
 380     /* The average number of subfacets... */
 381     struct avg_subfacet_rates hourly;   /* ...over the last hour. */
 382     struct avg_subfacet_rates daily;    /* ...over the last day. */
 383     struct avg_subfacet_rates lifetime; /* ...over the switch lifetime. */
 384     long long int last_minute;          /* Last time 'hourly' was updated. */
 385
 386     /* Number of subfacets added or deleted since 'last_minute'. */
 387     unsigned subfacet_add_count;
 388     unsigned subfacet_del_count;
 389
 390     /* Number of subfacets added or deleted from 'created' to 'last_minute.' */
 391     unsigned long long int total_subfacet_add_count;
 392     unsigned long long int total_subfacet_del_count;
 393 };
 394
 395 /* All existing ofproto_backer instances, indexed by ofproto->up.type. */
 396 static struct shash all_dpif_backers = SHASH_INITIALIZER(&all_dpif_backers);
 397
 398 static void drop_key_clear(struct dpif_backer *);
 399 static struct ofport_dpif *
 400 odp_port_to_ofport(const struct dpif_backer *, odp_port_t odp_port);
 401 static void update_moving_averages(struct dpif_backer *backer);
 402
 403 /* Defer flow mod completion until "ovs-appctl ofproto/unclog"?  (Useful only
 404  * for debugging the asynchronous flow_mod implementation.) */
 405 static bool clogged;
 406
 407 /* All existing ofproto_dpif instances, indexed by ->up.name. */
 408 static struct hmap all_ofproto_dpifs = HMAP_INITIALIZER(&all_ofproto_dpifs);
 409
 410 static void ofproto_dpif_unixctl_init(void);
 411
 412 /* Upcalls. */
 413 #define FLOW_MISS_MAX_BATCH 50
 414 static int handle_upcalls(struct dpif_backer *, unsigned int max_batch);
 415
 416 /* Flow expiration. */
 417 static int expire(struct dpif_backer *);
 418
 419 /* NetFlow. */
 420 static void send_netflow_active_timeouts(struct ofproto_dpif *);
 421
 422 /* Utilities. */
 423 static int send_packet(const struct ofport_dpif *, struct ofpbuf *packet);
 424
 425 /* Global variables. */
 426 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
 427
 428 /* Initial mappings of port to bridge mappings. */
 429 static struct shash init_ofp_ports = SHASH_INITIALIZER(&init_ofp_ports);
 430 \f
 431 /* Factory functions. */
 432
 433 static void
 434 init(const struct shash *iface_hints)
 435 {
 436     struct shash_node *node;
 437
 438     /* Make a local copy, since we don't own 'iface_hints' elements. */
 439     SHASH_FOR_EACH(node, iface_hints) {
 440         const struct iface_hint *orig_hint = node->data;
 441         struct iface_hint *new_hint = xmalloc(sizeof *new_hint);
 442
 443         new_hint->br_name = xstrdup(orig_hint->br_name);
 444         new_hint->br_type = xstrdup(orig_hint->br_type);
 445         new_hint->ofp_port = orig_hint->ofp_port;
 446
 447         shash_add(&init_ofp_ports, node->name, new_hint);
 448     }
 449 }
 450
 451 static void
 452 enumerate_types(struct sset *types)
 453 {
 454     dp_enumerate_types(types);
 455 }
 456
 457 static int
 458 enumerate_names(const char *type, struct sset *names)
 459 {
 460     struct ofproto_dpif *ofproto;
 461
 462     sset_clear(names);
 463     HMAP_FOR_EACH (ofproto, all_ofproto_dpifs_node, &all_ofproto_dpifs) {
 464         if (strcmp(type, ofproto->up.type)) {
 465             continue;
 466         }
 467         sset_add(names, ofproto->up.name);
 468     }
 469
 470     return 0;
 471 }
 472
 473 static int
 474 del(const char *type, const char *name)
 475 {
 476     struct dpif *dpif;
 477     int error;
 478
 479     error = dpif_open(name, type, &dpif);
 480     if (!error) {
 481         error = dpif_delete(dpif);
 482         dpif_close(dpif);
 483     }
 484     return error;
 485 }
 486 \f
 487 static const char *
 488 port_open_type(const char *datapath_type, const char *port_type)
 489 {
 490     return dpif_port_open_type(datapath_type, port_type);
 491 }
 492
 493 /* Type functions. */
 494
 495 static struct ofproto_dpif *
 496 lookup_ofproto_dpif_by_port_name(const char *name)
 497 {
 498     struct ofproto_dpif *ofproto;
 499
 500     HMAP_FOR_EACH (ofproto, all_ofproto_dpifs_node, &all_ofproto_dpifs) {
 501         if (sset_contains(&ofproto->ports, name)) {
 502             return ofproto;
 503         }
 504     }
 505
 506     return NULL;
 507 }
 508
 509 static int
 510 type_run(const char *type)
 511 {
 512     static long long int push_timer = LLONG_MIN;
 513     struct dpif_backer *backer;
 514     char *devname;
 515     int error;
 516
 517     backer = shash_find_data(&all_dpif_backers, type);
 518     if (!backer) {
 519         /* This is not necessarily a problem, since backers are only
 520          * created on demand. */
 521         return 0;
 522     }
 523
 524     dpif_run(backer->dpif);
 525
 526     /* The most natural place to push facet statistics is when they're pulled
 527      * from the datapath.  However, when there are many flows in the datapath,
 528      * this expensive operation can occur so frequently, that it reduces our
 529      * ability to quickly set up flows.  To reduce the cost, we push statistics
 530      * here instead. */
 531     if (time_msec() > push_timer) {
 532         push_timer = time_msec() + 2000;
 533         push_all_stats();
 534     }
 535
 536     /* If vswitchd started with other_config:flow_restore_wait set as "true",
 537      * and the configuration has now changed to "false", enable receiving
 538      * packets from the datapath. */
 539     if (!backer->recv_set_enable && !ofproto_get_flow_restore_wait()) {
 540         backer->recv_set_enable = true;
 541
 542         error = dpif_recv_set(backer->dpif, backer->recv_set_enable);
 543         if (error) {
 544             VLOG_ERR("Failed to enable receiving packets in dpif.");
 545             return error;
 546         }
 547         dpif_flow_flush(backer->dpif);
 548         backer->need_revalidate = REV_RECONFIGURE;
 549     }
 550
 551     if (backer->need_revalidate
 552         || !tag_set_is_empty(&backer->revalidate_set)) {
 553         struct tag_set revalidate_set = backer->revalidate_set;
 554         bool need_revalidate = backer->need_revalidate;
 555         struct ofproto_dpif *ofproto;
 556         struct simap_node *node;
 557         struct simap tmp_backers;
 558
 559         /* Handle tunnel garbage collection. */
 560         simap_init(&tmp_backers);
 561         simap_swap(&backer->tnl_backers, &tmp_backers);
 562
 563         HMAP_FOR_EACH (ofproto, all_ofproto_dpifs_node, &all_ofproto_dpifs) {
 564             struct ofport_dpif *iter;
 565
 566             if (backer != ofproto->backer) {
 567                 continue;
 568             }
 569
 570             HMAP_FOR_EACH (iter, up.hmap_node, &ofproto->up.ports) {
 571                 char namebuf[NETDEV_VPORT_NAME_BUFSIZE];
 572                 const char *dp_port;
 573
 574                 if (!iter->tnl_port) {
 575                     continue;
 576                 }
 577
 578                 dp_port = netdev_vport_get_dpif_port(iter->up.netdev,
 579                                                      namebuf, sizeof namebuf);
 580                 node = simap_find(&tmp_backers, dp_port);
 581                 if (node) {
 582                     simap_put(&backer->tnl_backers, dp_port, node->data);
 583                     simap_delete(&tmp_backers, node);
 584                     node = simap_find(&backer->tnl_backers, dp_port);
 585                 } else {
 586                     node = simap_find(&backer->tnl_backers, dp_port);
 587                     if (!node) {
 588                         odp_port_t odp_port = ODPP_NONE;
 589
 590                         if (!dpif_port_add(backer->dpif, iter->up.netdev,
 591                                            &odp_port)) {
 592                             simap_put(&backer->tnl_backers, dp_port,
 593                                       odp_to_u32(odp_port));
 594                             node = simap_find(&backer->tnl_backers, dp_port);
 595                         }
 596                     }
 597                 }
 598
 599                 iter->odp_port = node ? u32_to_odp(node->data) : ODPP_NONE;
 600                 if (tnl_port_reconfigure(&iter->up, iter->odp_port,
 601                                          &iter->tnl_port)) {
 602                     backer->need_revalidate = REV_RECONFIGURE;
 603                 }
 604             }
 605         }
 606
 607         SIMAP_FOR_EACH (node, &tmp_backers) {
 608             dpif_port_del(backer->dpif, u32_to_odp(node->data));
 609         }
 610         simap_destroy(&tmp_backers);
 611
 612         switch (backer->need_revalidate) {
 613         case REV_RECONFIGURE:   COVERAGE_INC(rev_reconfigure);   break;
 614         case REV_STP:           COVERAGE_INC(rev_stp);           break;
 615         case REV_PORT_TOGGLED:  COVERAGE_INC(rev_port_toggled);  break;
 616         case REV_FLOW_TABLE:    COVERAGE_INC(rev_flow_table);    break;
 617         case REV_INCONSISTENCY: COVERAGE_INC(rev_inconsistency); break;
 618         }
 619
 620         if (backer->need_revalidate) {
 621             /* Clear the drop_keys in case we should now be accepting some
 622              * formerly dropped flows. */
 623             drop_key_clear(backer);
 624         }
 625
 626         /* Clear the revalidation flags. */
 627         tag_set_init(&backer->revalidate_set);
 628         backer->need_revalidate = 0;
 629
 630         HMAP_FOR_EACH (ofproto, all_ofproto_dpifs_node, &all_ofproto_dpifs) {
 631             struct facet *facet, *next;
 632             struct cls_cursor cursor;
 633
 634             if (ofproto->backer != backer) {
 635                 continue;
 636             }
 637
 638             cls_cursor_init(&cursor, &ofproto->facets, NULL);
 639             CLS_CURSOR_FOR_EACH_SAFE (facet, next, cr, &cursor) {
 640                 if (need_revalidate
 641                     || tag_set_intersects(&revalidate_set, facet->xout.tags)) {
 642                     facet_revalidate(facet);
 643                     run_fast_rl();
 644                 }
 645             }
 646         }
 647     }
 648
 649     if (!backer->recv_set_enable) {
 650         /* Wake up before a max of 1000ms. */
 651         timer_set_duration(&backer->next_expiration, 1000);
 652     } else if (timer_expired(&backer->next_expiration)) {
 653         int delay = expire(backer);
 654         timer_set_duration(&backer->next_expiration, delay);
 655     }
 656
 657     /* Check for port changes in the dpif. */
 658     while ((error = dpif_port_poll(backer->dpif, &devname)) == 0) {
 659         struct ofproto_dpif *ofproto;
 660         struct dpif_port port;
 661
 662         /* Don't report on the datapath's device. */
 663         if (!strcmp(devname, dpif_base_name(backer->dpif))) {
 664             goto next;
 665         }
 666
 667         HMAP_FOR_EACH (ofproto, all_ofproto_dpifs_node,
 668                        &all_ofproto_dpifs) {
 669             if (simap_contains(&ofproto->backer->tnl_backers, devname)) {
 670                 goto next;
 671             }
 672         }
 673
 674         ofproto = lookup_ofproto_dpif_by_port_name(devname);
 675         if (dpif_port_query_by_name(backer->dpif, devname, &port)) {
 676             /* The port was removed.  If we know the datapath,
 677              * report it through poll_set().  If we don't, it may be
 678              * notifying us of a removal we initiated, so ignore it.
 679              * If there's a pending ENOBUFS, let it stand, since
 680              * everything will be reevaluated. */
 681             if (ofproto && ofproto->port_poll_errno != ENOBUFS) {
 682                 sset_add(&ofproto->port_poll_set, devname);
 683                 ofproto->port_poll_errno = 0;
 684             }
 685         } else if (!ofproto) {
 686             /* The port was added, but we don't know with which
 687              * ofproto we should associate it.  Delete it. */
 688             dpif_port_del(backer->dpif, port.port_no);
 689         }
 690         dpif_port_destroy(&port);
 691
 692     next:
 693         free(devname);
 694     }
 695
 696     if (error != EAGAIN) {
 697         struct ofproto_dpif *ofproto;
 698
 699         /* There was some sort of error, so propagate it to all
 700          * ofprotos that use this backer. */
 701         HMAP_FOR_EACH (ofproto, all_ofproto_dpifs_node,
 702                        &all_ofproto_dpifs) {
 703             if (ofproto->backer == backer) {
 704                 sset_clear(&ofproto->port_poll_set);
 705                 ofproto->port_poll_errno = error;
 706             }
 707         }
 708     }
 709
 710     if (backer->governor) {
 711         size_t n_subfacets;
 712
 713         governor_run(backer->governor);
 714
 715         /* If the governor has shrunk to its minimum size and the number of
 716          * subfacets has dwindled, then drop the governor entirely.
 717          *
 718          * For hysteresis, the number of subfacets to drop the governor is
 719          * smaller than the number needed to trigger its creation. */
 720         n_subfacets = hmap_count(&backer->subfacets);
 721         if (n_subfacets * 4 < flow_eviction_threshold
 722             && governor_is_idle(backer->governor)) {
 723             governor_destroy(backer->governor);
 724             backer->governor = NULL;
 725         }
 726     }
 727
 728     return 0;
 729 }
 730
 731 static int
 732 dpif_backer_run_fast(struct dpif_backer *backer, int max_batch)
 733 {
 734     unsigned int work;
 735
 736     /* If recv_set_enable is false, we should not handle upcalls. */
 737     if (!backer->recv_set_enable) {
 738         return 0;
 739     }
 740
 741     /* Handle one or more batches of upcalls, until there's nothing left to do
 742      * or until we do a fixed total amount of work.
 743      *
 744      * We do work in batches because it can be much cheaper to set up a number
 745      * of flows and fire off their patches all at once.  We do multiple batches
 746      * because in some cases handling a packet can cause another packet to be
 747      * queued almost immediately as part of the return flow.  Both
 748      * optimizations can make major improvements on some benchmarks and
 749      * presumably for real traffic as well. */
 750     work = 0;
 751     while (work < max_batch) {
 752         int retval = handle_upcalls(backer, max_batch - work);
 753         if (retval <= 0) {
 754             return -retval;
 755         }
 756         work += retval;
 757     }
 758
 759     return 0;
 760 }
 761
 762 static int
 763 type_run_fast(const char *type)
 764 {
 765     struct dpif_backer *backer;
 766
 767     backer = shash_find_data(&all_dpif_backers, type);
 768     if (!backer) {
 769         /* This is not necessarily a problem, since backers are only
 770          * created on demand. */
 771         return 0;
 772     }
 773
 774     return dpif_backer_run_fast(backer, FLOW_MISS_MAX_BATCH);
 775 }
 776
 777 static void
 778 run_fast_rl(void)
 779 {
 780     static long long int port_rl = LLONG_MIN;
 781     static unsigned int backer_rl = 0;
 782
 783     if (time_msec() >= port_rl) {
 784         struct ofproto_dpif *ofproto;
 785         struct ofport_dpif *ofport;
 786
 787         HMAP_FOR_EACH (ofproto, all_ofproto_dpifs_node, &all_ofproto_dpifs) {
 788
 789             HMAP_FOR_EACH (ofport, up.hmap_node, &ofproto->up.ports) {
 790                 port_run_fast(ofport);
 791             }
 792         }
 793         port_rl = time_msec() + 200;
 794     }
 795
 796     /* XXX: We have to be careful not to do too much work in this function.  If
 797      * we call dpif_backer_run_fast() too often, or with too large a batch,
 798      * performance improves signifcantly, but at a cost.  It's possible for the
 799      * number of flows in the datapath to increase without bound, and for poll
 800      * loops to take 10s of seconds.   The correct solution to this problem,
 801      * long term, is to separate flow miss handling into it's own thread so it
 802      * isn't affected by revalidations, and expirations.  Until then, this is
 803      * the best we can do. */
 804     if (++backer_rl >= 10) {
 805         struct shash_node *node;
 806
 807         backer_rl = 0;
 808         SHASH_FOR_EACH (node, &all_dpif_backers) {
 809             dpif_backer_run_fast(node->data, 1);
 810         }
 811     }
 812 }
 813
 814 static void
 815 type_wait(const char *type)
 816 {
 817     struct dpif_backer *backer;
 818
 819     backer = shash_find_data(&all_dpif_backers, type);
 820     if (!backer) {
 821         /* This is not necessarily a problem, since backers are only
 822          * created on demand. */
 823         return;
 824     }
 825
 826     if (backer->governor) {
 827         governor_wait(backer->governor);
 828     }
 829
 830     timer_wait(&backer->next_expiration);
 831 }
 832 \f
 833 /* Basic life-cycle. */
 834
 835 static int add_internal_flows(struct ofproto_dpif *);
 836
 837 static struct ofproto *
 838 alloc(void)
 839 {
 840     struct ofproto_dpif *ofproto = xmalloc(sizeof *ofproto);
 841     return &ofproto->up;
 842 }
 843
 844 static void
 845 dealloc(struct ofproto *ofproto_)
 846 {
 847     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
 848     free(ofproto);
 849 }
 850
 851 static void
 852 close_dpif_backer(struct dpif_backer *backer)
 853 {
 854     struct shash_node *node;
 855
 856     ovs_assert(backer->refcount > 0);
 857
 858     if (--backer->refcount) {
 859         return;
 860     }
 861
 862     drop_key_clear(backer);
 863     hmap_destroy(&backer->drop_keys);
 864
 865     simap_destroy(&backer->tnl_backers);
 866     hmap_destroy(&backer->odp_to_ofport_map);
 867     node = shash_find(&all_dpif_backers, backer->type);
 868     free(backer->type);
 869     shash_delete(&all_dpif_backers, node);
 870     dpif_close(backer->dpif);
 871
 872     ovs_assert(hmap_is_empty(&backer->subfacets));
 873     hmap_destroy(&backer->subfacets);
 874     governor_destroy(backer->governor);
 875
 876     free(backer);
 877 }
 878
 879 /* Datapath port slated for removal from datapath. */
 880 struct odp_garbage {
 881     struct list list_node;
 882     odp_port_t odp_port;
 883 };
 884
 885 static int
 886 open_dpif_backer(const char *type, struct dpif_backer **backerp)
 887 {
 888     struct dpif_backer *backer;
 889     struct dpif_port_dump port_dump;
 890     struct dpif_port port;
 891     struct shash_node *node;
 892     struct list garbage_list;
 893     struct odp_garbage *garbage, *next;
 894     struct sset names;
 895     char *backer_name;
 896     const char *name;
 897     int error;
 898
 899     backer = shash_find_data(&all_dpif_backers, type);
 900     if (backer) {
 901         backer->refcount++;
 902         *backerp = backer;
 903         return 0;
 904     }
 905
 906     backer_name = xasprintf("ovs-%s", type);
 907
 908     /* Remove any existing datapaths, since we assume we're the only
 909      * userspace controlling the datapath. */
 910     sset_init(&names);
 911     dp_enumerate_names(type, &names);
 912     SSET_FOR_EACH(name, &names) {
 913         struct dpif *old_dpif;
 914
 915         /* Don't remove our backer if it exists. */
 916         if (!strcmp(name, backer_name)) {
 917             continue;
 918         }
 919
 920         if (dpif_open(name, type, &old_dpif)) {
 921             VLOG_WARN("couldn't open old datapath %s to remove it", name);
 922         } else {
 923             dpif_delete(old_dpif);
 924             dpif_close(old_dpif);
 925         }
 926     }
 927     sset_destroy(&names);
 928
 929     backer = xmalloc(sizeof *backer);
 930
 931     error = dpif_create_and_open(backer_name, type, &backer->dpif);
 932     free(backer_name);
 933     if (error) {
 934         VLOG_ERR("failed to open datapath of type %s: %s", type,
 935                  strerror(error));
 936         free(backer);
 937         return error;
 938     }
 939
 940     backer->type = xstrdup(type);
 941     backer->governor = NULL;
 942     backer->refcount = 1;
 943     hmap_init(&backer->odp_to_ofport_map);
 944     hmap_init(&backer->drop_keys);
 945     hmap_init(&backer->subfacets);
 946     timer_set_duration(&backer->next_expiration, 1000);
 947     backer->need_revalidate = 0;
 948     simap_init(&backer->tnl_backers);
 949     tag_set_init(&backer->revalidate_set);
 950     backer->recv_set_enable = !ofproto_get_flow_restore_wait();
 951     *backerp = backer;
 952
 953     if (backer->recv_set_enable) {
 954         dpif_flow_flush(backer->dpif);
 955     }
 956
 957     /* Loop through the ports already on the datapath and remove any
 958      * that we don't need anymore. */
 959     list_init(&garbage_list);
 960     dpif_port_dump_start(&port_dump, backer->dpif);
 961     while (dpif_port_dump_next(&port_dump, &port)) {
 962         node = shash_find(&init_ofp_ports, port.name);
 963         if (!node && strcmp(port.name, dpif_base_name(backer->dpif))) {
 964             garbage = xmalloc(sizeof *garbage);
 965             garbage->odp_port = port.port_no;
 966             list_push_front(&garbage_list, &garbage->list_node);
 967         }
 968     }
 969     dpif_port_dump_done(&port_dump);
 970
 971     LIST_FOR_EACH_SAFE (garbage, next, list_node, &garbage_list) {
 972         dpif_port_del(backer->dpif, garbage->odp_port);
 973         list_remove(&garbage->list_node);
 974         free(garbage);
 975     }
 976
 977     shash_add(&all_dpif_backers, type, backer);
 978
 979     error = dpif_recv_set(backer->dpif, backer->recv_set_enable);
 980     if (error) {
 981         VLOG_ERR("failed to listen on datapath of type %s: %s",
 982                  type, strerror(error));
 983         close_dpif_backer(backer);
 984         return error;
 985     }
 986
 987     backer->max_n_subfacet = 0;
 988     backer->created = time_msec();
 989     backer->last_minute = backer->created;
 990     memset(&backer->hourly, 0, sizeof backer->hourly);
 991     memset(&backer->daily, 0, sizeof backer->daily);
 992     memset(&backer->lifetime, 0, sizeof backer->lifetime);
 993     backer->subfacet_add_count = 0;
 994     backer->subfacet_del_count = 0;
 995     backer->total_subfacet_add_count = 0;
 996     backer->total_subfacet_del_count = 0;
 997     backer->avg_n_subfacet = 0;
 998     backer->avg_subfacet_life = 0;
 999
1000     return error;
1001 }
1002
1003 static int
1004 construct(struct ofproto *ofproto_)
1005 {
1006     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
1007     struct shash_node *node, *next;
1008     odp_port_t max_ports;
1009     int error;
1010     int i;
1011
1012     error = open_dpif_backer(ofproto->up.type, &ofproto->backer);
1013     if (error) {
1014         return error;
1015     }
1016
1017     max_ports = dpif_get_max_ports(ofproto->backer->dpif);
1018     ofproto_init_max_ports(ofproto_, u16_to_ofp(MIN(odp_to_u32(max_ports),
1019                                                     ofp_to_u16(OFPP_MAX))));
1020
1021     ofproto->netflow = NULL;
1022     ofproto->sflow = NULL;
1023     ofproto->ipfix = NULL;
1024     ofproto->stp = NULL;
1025     hmap_init(&ofproto->bundles);
1026     ofproto->ml = mac_learning_create(MAC_ENTRY_DEFAULT_IDLE_TIME);
1027     for (i = 0; i < MAX_MIRRORS; i++) {
1028         ofproto->mirrors[i] = NULL;
1029     }
1030     ofproto->has_bonded_bundles = false;
1031
1032     classifier_init(&ofproto->facets);
1033     ofproto->consistency_rl = LLONG_MIN;
1034
1035     for (i = 0; i < N_TABLES; i++) {
1036         struct table_dpif *table = &ofproto->tables[i];
1037
1038         table->catchall_table = NULL;
1039         table->other_table = NULL;
1040         table->basis = random_uint32();
1041     }
1042
1043     list_init(&ofproto->completions);
1044
1045     ofproto_dpif_unixctl_init();
1046
1047     ofproto->has_mirrors = false;
1048     ofproto->has_bundle_action = false;
1049
1050     hmap_init(&ofproto->vlandev_map);
1051     hmap_init(&ofproto->realdev_vid_map);
1052
1053     sset_init(&ofproto->ports);
1054     sset_init(&ofproto->ghost_ports);
1055     sset_init(&ofproto->port_poll_set);
1056     ofproto->port_poll_errno = 0;
1057
1058     SHASH_FOR_EACH_SAFE (node, next, &init_ofp_ports) {
1059         struct iface_hint *iface_hint = node->data;
1060
1061         if (!strcmp(iface_hint->br_name, ofproto->up.name)) {
1062             /* Check if the datapath already has this port. */
1063             if (dpif_port_exists(ofproto->backer->dpif, node->name)) {
1064                 sset_add(&ofproto->ports, node->name);
1065             }
1066
1067             free(iface_hint->br_name);
1068             free(iface_hint->br_type);
1069             free(iface_hint);
1070             shash_delete(&init_ofp_ports, node);
1071         }
1072     }
1073
1074     hmap_insert(&all_ofproto_dpifs, &ofproto->all_ofproto_dpifs_node,
1075                 hash_string(ofproto->up.name, 0));
1076     memset(&ofproto->stats, 0, sizeof ofproto->stats);
1077
1078     ofproto_init_tables(ofproto_, N_TABLES);
1079     error = add_internal_flows(ofproto);
1080     ofproto->up.tables[TBL_INTERNAL].flags = OFTABLE_HIDDEN | OFTABLE_READONLY;
1081
1082     ofproto->n_hit = 0;
1083     ofproto->n_missed = 0;
1084
1085     return error;
1086 }
1087
1088 static int
1089 add_internal_flow(struct ofproto_dpif *ofproto, int id,
1090                   const struct ofpbuf *ofpacts, struct rule_dpif **rulep)
1091 {
1092     struct ofputil_flow_mod fm;
1093     int error;
1094
1095     match_init_catchall(&fm.match);
1096     fm.priority = 0;
1097     match_set_reg(&fm.match, 0, id);
1098     fm.new_cookie = htonll(0);
1099     fm.cookie = htonll(0);
1100     fm.cookie_mask = htonll(0);
1101     fm.table_id = TBL_INTERNAL;
1102     fm.command = OFPFC_ADD;
1103     fm.idle_timeout = 0;
1104     fm.hard_timeout = 0;
1105     fm.buffer_id = 0;
1106     fm.out_port = 0;
1107     fm.flags = 0;
1108     fm.ofpacts = ofpacts->data;
1109     fm.ofpacts_len = ofpacts->size;
1110
1111     error = ofproto_flow_mod(&ofproto->up, &fm);
1112     if (error) {
1113         VLOG_ERR_RL(&rl, "failed to add internal flow %d (%s)",
1114                     id, ofperr_to_string(error));
1115         return error;
1116     }
1117
1118     *rulep = rule_dpif_lookup_in_table(ofproto, &fm.match.flow, NULL,
1119                                        TBL_INTERNAL);
1120     ovs_assert(*rulep != NULL);
1121
1122     return 0;
1123 }
1124
1125 static int
1126 add_internal_flows(struct ofproto_dpif *ofproto)
1127 {
1128     struct ofpact_controller *controller;
1129     uint64_t ofpacts_stub[128 / 8];
1130     struct ofpbuf ofpacts;
1131     int error;
1132     int id;
1133
1134     ofpbuf_use_stack(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
1135     id = 1;
1136
1137     controller = ofpact_put_CONTROLLER(&ofpacts);
1138     controller->max_len = UINT16_MAX;
1139     controller->controller_id = 0;
1140     controller->reason = OFPR_NO_MATCH;
1141     ofpact_pad(&ofpacts);
1142
1143     error = add_internal_flow(ofproto, id++, &ofpacts, &ofproto->miss_rule);
1144     if (error) {
1145         return error;
1146     }
1147
1148     ofpbuf_clear(&ofpacts);
1149     error = add_internal_flow(ofproto, id++, &ofpacts,
1150                               &ofproto->no_packet_in_rule);
1151     if (error) {
1152         return error;
1153     }
1154
1155     error = add_internal_flow(ofproto, id++, &ofpacts,
1156                               &ofproto->drop_frags_rule);
1157     return error;
1158 }
1159
1160 static void
1161 complete_operations(struct ofproto_dpif *ofproto)
1162 {
1163     struct dpif_completion *c, *next;
1164
1165     LIST_FOR_EACH_SAFE (c, next, list_node, &ofproto->completions) {
1166         ofoperation_complete(c->op, 0);
1167         list_remove(&c->list_node);
1168         free(c);
1169     }
1170 }
1171
1172 static void
1173 destruct(struct ofproto *ofproto_)
1174 {
1175     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
1176     struct rule_dpif *rule, *next_rule;
1177     struct oftable *table;
1178     int i;
1179
1180     ofproto->backer->need_revalidate = REV_RECONFIGURE;
1181     hmap_remove(&all_ofproto_dpifs, &ofproto->all_ofproto_dpifs_node);
1182     complete_operations(ofproto);
1183
1184     OFPROTO_FOR_EACH_TABLE (table, &ofproto->up) {
1185         struct cls_cursor cursor;
1186
1187         cls_cursor_init(&cursor, &table->cls, NULL);
1188         CLS_CURSOR_FOR_EACH_SAFE (rule, next_rule, up.cr, &cursor) {
1189             ofproto_rule_destroy(&rule->up);
1190         }
1191     }
1192
1193     for (i = 0; i < MAX_MIRRORS; i++) {
1194         mirror_destroy(ofproto->mirrors[i]);
1195     }
1196
1197     netflow_destroy(ofproto->netflow);
1198     dpif_sflow_destroy(ofproto->sflow);
1199     hmap_destroy(&ofproto->bundles);
1200     mac_learning_destroy(ofproto->ml);
1201
1202     classifier_destroy(&ofproto->facets);
1203
1204     hmap_destroy(&ofproto->vlandev_map);
1205     hmap_destroy(&ofproto->realdev_vid_map);
1206
1207     sset_destroy(&ofproto->ports);
1208     sset_destroy(&ofproto->ghost_ports);
1209     sset_destroy(&ofproto->port_poll_set);
1210
1211     close_dpif_backer(ofproto->backer);
1212 }
1213
1214 static int
1215 run_fast(struct ofproto *ofproto_)
1216 {
1217     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
1218     struct ofport_dpif *ofport;
1219
1220     /* Do not perform any periodic activity required by 'ofproto' while
1221      * waiting for flow restore to complete. */
1222     if (ofproto_get_flow_restore_wait()) {
1223         return 0;
1224     }
1225
1226     HMAP_FOR_EACH (ofport, up.hmap_node, &ofproto->up.ports) {
1227         port_run_fast(ofport);
1228     }
1229
1230     return 0;
1231 }
1232
1233 static int
1234 run(struct ofproto *ofproto_)
1235 {
1236     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
1237     struct ofport_dpif *ofport;
1238     struct ofbundle *bundle;
1239     int error;
1240
1241     if (!clogged) {
1242         complete_operations(ofproto);
1243     }
1244
1245     /* Do not perform any periodic activity below required by 'ofproto' while
1246      * waiting for flow restore to complete. */
1247     if (ofproto_get_flow_restore_wait()) {
1248         return 0;
1249     }
1250
1251     error = run_fast(ofproto_);
1252     if (error) {
1253         return error;
1254     }
1255
1256     if (ofproto->netflow) {
1257         if (netflow_run(ofproto->netflow)) {
1258             send_netflow_active_timeouts(ofproto);
1259         }
1260     }
1261     if (ofproto->sflow) {
1262         dpif_sflow_run(ofproto->sflow);
1263     }
1264
1265     HMAP_FOR_EACH (ofport, up.hmap_node, &ofproto->up.ports) {
1266         port_run(ofport);
1267     }
1268     HMAP_FOR_EACH (bundle, hmap_node, &ofproto->bundles) {
1269         bundle_run(bundle);
1270     }
1271
1272     stp_run(ofproto);
1273     mac_learning_run(ofproto->ml, &ofproto->backer->revalidate_set);
1274
1275     /* Check the consistency of a random facet, to aid debugging. */
1276     if (time_msec() >= ofproto->consistency_rl
1277         && !classifier_is_empty(&ofproto->facets)
1278         && !ofproto->backer->need_revalidate) {
1279         struct cls_table *table;
1280         struct cls_rule *cr;
1281         struct facet *facet;
1282
1283         ofproto->consistency_rl = time_msec() + 250;
1284
1285         table = CONTAINER_OF(hmap_random_node(&ofproto->facets.tables),
1286                              struct cls_table, hmap_node);
1287         cr = CONTAINER_OF(hmap_random_node(&table->rules), struct cls_rule,
1288                           hmap_node);
1289         facet = CONTAINER_OF(cr, struct facet, cr);
1290
1291         if (!tag_set_intersects(&ofproto->backer->revalidate_set,
1292                                 facet->xout.tags)) {
1293             if (!facet_check_consistency(facet)) {
1294                 ofproto->backer->need_revalidate = REV_INCONSISTENCY;
1295             }
1296         }
1297     }
1298
1299     return 0;
1300 }
1301
1302 static void
1303 wait(struct ofproto *ofproto_)
1304 {
1305     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
1306     struct ofport_dpif *ofport;
1307     struct ofbundle *bundle;
1308
1309     if (!clogged && !list_is_empty(&ofproto->completions)) {
1310         poll_immediate_wake();
1311     }
1312
1313     if (ofproto_get_flow_restore_wait()) {
1314         return;
1315     }
1316
1317     dpif_wait(ofproto->backer->dpif);
1318     dpif_recv_wait(ofproto->backer->dpif);
1319     if (ofproto->sflow) {
1320         dpif_sflow_wait(ofproto->sflow);
1321     }
1322     if (!tag_set_is_empty(&ofproto->backer->revalidate_set)) {
1323         poll_immediate_wake();
1324     }
1325     HMAP_FOR_EACH (ofport, up.hmap_node, &ofproto->up.ports) {
1326         port_wait(ofport);
1327     }
1328     HMAP_FOR_EACH (bundle, hmap_node, &ofproto->bundles) {
1329         bundle_wait(bundle);
1330     }
1331     if (ofproto->netflow) {
1332         netflow_wait(ofproto->netflow);
1333     }
1334     mac_learning_wait(ofproto->ml);
1335     stp_wait(ofproto);
1336     if (ofproto->backer->need_revalidate) {
1337         /* Shouldn't happen, but if it does just go around again. */
1338         VLOG_DBG_RL(&rl, "need revalidate in ofproto_wait_cb()");
1339         poll_immediate_wake();
1340     }
1341 }
1342
1343 static void
1344 get_memory_usage(const struct ofproto *ofproto_, struct simap *usage)
1345 {
1346     const struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
1347     struct cls_cursor cursor;
1348     size_t n_subfacets = 0;
1349     struct facet *facet;
1350
1351     simap_increase(usage, "facets", classifier_count(&ofproto->facets));
1352
1353     cls_cursor_init(&cursor, &ofproto->facets, NULL);
1354     CLS_CURSOR_FOR_EACH (facet, cr, &cursor) {
1355         n_subfacets += list_size(&facet->subfacets);
1356     }
1357     simap_increase(usage, "subfacets", n_subfacets);
1358 }
1359
1360 static void
1361 flush(struct ofproto *ofproto_)
1362 {
1363     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
1364     struct subfacet *subfacet, *next_subfacet;
1365     struct subfacet *batch[SUBFACET_DESTROY_MAX_BATCH];
1366     int n_batch;
1367
1368     n_batch = 0;
1369     HMAP_FOR_EACH_SAFE (subfacet, next_subfacet, hmap_node,
1370                         &ofproto->backer->subfacets) {
1371         if (ofproto_dpif_cast(subfacet->facet->rule->up.ofproto) != ofproto) {
1372             continue;
1373         }
1374
1375         if (subfacet->path != SF_NOT_INSTALLED) {
1376             batch[n_batch++] = subfacet;
1377             if (n_batch >= SUBFACET_DESTROY_MAX_BATCH) {
1378                 subfacet_destroy_batch(ofproto->backer, batch, n_batch);
1379                 n_batch = 0;
1380             }
1381         } else {
1382             subfacet_destroy(subfacet);
1383         }
1384     }
1385
1386     if (n_batch > 0) {
1387         subfacet_destroy_batch(ofproto->backer, batch, n_batch);
1388     }
1389 }
1390
1391 static void
1392 get_features(struct ofproto *ofproto_ OVS_UNUSED,
1393              bool *arp_match_ip, enum ofputil_action_bitmap *actions)
1394 {
1395     *arp_match_ip = true;
1396     *actions = (OFPUTIL_A_OUTPUT |
1397                 OFPUTIL_A_SET_VLAN_VID |
1398                 OFPUTIL_A_SET_VLAN_PCP |
1399                 OFPUTIL_A_STRIP_VLAN |
1400                 OFPUTIL_A_SET_DL_SRC |
1401                 OFPUTIL_A_SET_DL_DST |
1402                 OFPUTIL_A_SET_NW_SRC |
1403                 OFPUTIL_A_SET_NW_DST |
1404                 OFPUTIL_A_SET_NW_TOS |
1405                 OFPUTIL_A_SET_TP_SRC |
1406                 OFPUTIL_A_SET_TP_DST |
1407                 OFPUTIL_A_ENQUEUE);
1408 }
1409
1410 static void
1411 get_tables(struct ofproto *ofproto_, struct ofp12_table_stats *ots)
1412 {
1413     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
1414     struct dpif_dp_stats s;
1415     uint64_t n_miss, n_no_pkt_in, n_bytes, n_dropped_frags;
1416     uint64_t n_lookup;
1417
1418     strcpy(ots->name, "classifier");
1419
1420     dpif_get_dp_stats(ofproto->backer->dpif, &s);
1421     rule_get_stats(&ofproto->miss_rule->up, &n_miss, &n_bytes);
1422     rule_get_stats(&ofproto->no_packet_in_rule->up, &n_no_pkt_in, &n_bytes);
1423     rule_get_stats(&ofproto->drop_frags_rule->up, &n_dropped_frags, &n_bytes);
1424
1425     n_lookup = s.n_hit + s.n_missed - n_dropped_frags;
1426     ots->lookup_count = htonll(n_lookup);
1427     ots->matched_count = htonll(n_lookup - n_miss - n_no_pkt_in);
1428 }
1429
1430 static struct ofport *
1431 port_alloc(void)
1432 {
1433     struct ofport_dpif *port = xmalloc(sizeof *port);
1434     return &port->up;
1435 }
1436
1437 static void
1438 port_dealloc(struct ofport *port_)
1439 {
1440     struct ofport_dpif *port = ofport_dpif_cast(port_);
1441     free(port);
1442 }
1443
1444 static int
1445 port_construct(struct ofport *port_)
1446 {
1447     struct ofport_dpif *port = ofport_dpif_cast(port_);
1448     struct ofproto_dpif *ofproto = ofproto_dpif_cast(port->up.ofproto);
1449     const struct netdev *netdev = port->up.netdev;
1450     char namebuf[NETDEV_VPORT_NAME_BUFSIZE];
1451     struct dpif_port dpif_port;
1452     int error;
1453
1454     ofproto->backer->need_revalidate = REV_RECONFIGURE;
1455     port->bundle = NULL;
1456     port->cfm = NULL;
1457     port->bfd = NULL;
1458     port->tag = tag_create_random();
1459     port->may_enable = true;
1460     port->stp_port = NULL;
1461     port->stp_state = STP_DISABLED;
1462     port->tnl_port = NULL;
1463     port->peer = NULL;
1464     hmap_init(&port->priorities);
1465     port->realdev_ofp_port = 0;
1466     port->vlandev_vid = 0;
1467     port->carrier_seq = netdev_get_carrier_resets(netdev);
1468
1469     if (netdev_vport_is_patch(netdev)) {
1470         /* By bailing out here, we don't submit the port to the sFlow module
1471          * to be considered for counter polling export.  This is correct
1472          * because the patch port represents an interface that sFlow considers
1473          * to be "internal" to the switch as a whole, and therefore not an
1474          * candidate for counter polling. */
1475         port->odp_port = ODPP_NONE;
1476         ofport_update_peer(port);
1477         return 0;
1478     }
1479
1480     error = dpif_port_query_by_name(ofproto->backer->dpif,
1481                                     netdev_vport_get_dpif_port(netdev, namebuf,
1482                                                                sizeof namebuf),
1483                                     &dpif_port);
1484     if (error) {
1485         return error;
1486     }
1487
1488     port->odp_port = dpif_port.port_no;
1489
1490     if (netdev_get_tunnel_config(netdev)) {
1491         port->tnl_port = tnl_port_add(&port->up, port->odp_port);
1492     } else {
1493         /* Sanity-check that a mapping doesn't already exist.  This
1494          * shouldn't happen for non-tunnel ports. */
1495         if (odp_port_to_ofp_port(ofproto, port->odp_port) != OFPP_NONE) {
1496             VLOG_ERR("port %s already has an OpenFlow port number",
1497                      dpif_port.name);
1498             dpif_port_destroy(&dpif_port);
1499             return EBUSY;
1500         }
1501
1502         hmap_insert(&ofproto->backer->odp_to_ofport_map, &port->odp_port_node,
1503                     hash_int(odp_to_u32(port->odp_port), 0));
1504     }
1505     dpif_port_destroy(&dpif_port);
1506
1507     if (ofproto->sflow) {
1508         dpif_sflow_add_port(ofproto->sflow, port_, port->odp_port);
1509     }
1510
1511     return 0;
1512 }
1513
1514 static void
1515 port_destruct(struct ofport *port_)
1516 {
1517     struct ofport_dpif *port = ofport_dpif_cast(port_);
1518     struct ofproto_dpif *ofproto = ofproto_dpif_cast(port->up.ofproto);
1519     const char *devname = netdev_get_name(port->up.netdev);
1520     char namebuf[NETDEV_VPORT_NAME_BUFSIZE];
1521     const char *dp_port_name;
1522
1523     dp_port_name = netdev_vport_get_dpif_port(port->up.netdev, namebuf,
1524                                               sizeof namebuf);
1525     if (dpif_port_exists(ofproto->backer->dpif, dp_port_name)) {
1526         /* The underlying device is still there, so delete it.  This
1527          * happens when the ofproto is being destroyed, since the caller
1528          * assumes that removal of attached ports will happen as part of
1529          * destruction. */
1530         if (!port->tnl_port) {
1531             dpif_port_del(ofproto->backer->dpif, port->odp_port);
1532         }
1533         ofproto->backer->need_revalidate = REV_RECONFIGURE;
1534     }
1535
1536     if (port->peer) {
1537         port->peer->peer = NULL;
1538         port->peer = NULL;
1539     }
1540
1541     if (port->odp_port != ODPP_NONE && !port->tnl_port) {
1542         hmap_remove(&ofproto->backer->odp_to_ofport_map, &port->odp_port_node);
1543     }
1544
1545     tnl_port_del(port->tnl_port);
1546     sset_find_and_delete(&ofproto->ports, devname);
1547     sset_find_and_delete(&ofproto->ghost_ports, devname);
1548     ofproto->backer->need_revalidate = REV_RECONFIGURE;
1549     bundle_remove(port_);
1550     set_cfm(port_, NULL);
1551     set_bfd(port_, NULL);
1552     if (ofproto->sflow) {
1553         dpif_sflow_del_port(ofproto->sflow, port->odp_port);
1554     }
1555
1556     ofport_clear_priorities(port);
1557     hmap_destroy(&port->priorities);
1558 }
1559
1560 static void
1561 port_modified(struct ofport *port_)
1562 {
1563     struct ofport_dpif *port = ofport_dpif_cast(port_);
1564
1565     if (port->bundle && port->bundle->bond) {
1566         bond_slave_set_netdev(port->bundle->bond, port, port->up.netdev);
1567     }
1568
1569     if (port->cfm) {
1570         cfm_set_netdev(port->cfm, port->up.netdev);
1571     }
1572
1573     if (port->tnl_port && tnl_port_reconfigure(&port->up, port->odp_port,
1574                                                &port->tnl_port)) {
1575         ofproto_dpif_cast(port->up.ofproto)->backer->need_revalidate = true;
1576     }
1577
1578     ofport_update_peer(port);
1579 }
1580
1581 static void
1582 port_reconfigured(struct ofport *port_, enum ofputil_port_config old_config)
1583 {
1584     struct ofport_dpif *port = ofport_dpif_cast(port_);
1585     struct ofproto_dpif *ofproto = ofproto_dpif_cast(port->up.ofproto);
1586     enum ofputil_port_config changed = old_config ^ port->up.pp.config;
1587
1588     if (changed & (OFPUTIL_PC_NO_RECV | OFPUTIL_PC_NO_RECV_STP |
1589                    OFPUTIL_PC_NO_FWD | OFPUTIL_PC_NO_FLOOD |
1590                    OFPUTIL_PC_NO_PACKET_IN)) {
1591         ofproto->backer->need_revalidate = REV_RECONFIGURE;
1592
1593         if (changed & OFPUTIL_PC_NO_FLOOD && port->bundle) {
1594             bundle_update(port->bundle);
1595         }
1596     }
1597 }
1598
1599 static int
1600 set_sflow(struct ofproto *ofproto_,
1601           const struct ofproto_sflow_options *sflow_options)
1602 {
1603     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
1604     struct dpif_sflow *ds = ofproto->sflow;
1605
1606     if (sflow_options) {
1607         if (!ds) {
1608             struct ofport_dpif *ofport;
1609
1610             ds = ofproto->sflow = dpif_sflow_create();
1611             HMAP_FOR_EACH (ofport, up.hmap_node, &ofproto->up.ports) {
1612                 dpif_sflow_add_port(ds, &ofport->up, ofport->odp_port);
1613             }
1614             ofproto->backer->need_revalidate = REV_RECONFIGURE;
1615         }
1616         dpif_sflow_set_options(ds, sflow_options);
1617     } else {
1618         if (ds) {
1619             dpif_sflow_destroy(ds);
1620             ofproto->backer->need_revalidate = REV_RECONFIGURE;
1621             ofproto->sflow = NULL;
1622         }
1623     }
1624     return 0;
1625 }
1626
1627 static int
1628 set_ipfix(
1629     struct ofproto *ofproto_,
1630     const struct ofproto_ipfix_bridge_exporter_options *bridge_exporter_options,
1631     const struct ofproto_ipfix_flow_exporter_options *flow_exporters_options,
1632     size_t n_flow_exporters_options)
1633 {
1634     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
1635     struct dpif_ipfix *di = ofproto->ipfix;
1636
1637     if (bridge_exporter_options || flow_exporters_options) {
1638         if (!di) {
1639             di = ofproto->ipfix = dpif_ipfix_create();
1640         }
1641         dpif_ipfix_set_options(
1642             di, bridge_exporter_options, flow_exporters_options,
1643             n_flow_exporters_options);
1644     } else {
1645         if (di) {
1646             dpif_ipfix_destroy(di);
1647             ofproto->ipfix = NULL;
1648         }
1649     }
1650     return 0;
1651 }
1652
1653 static int
1654 set_cfm(struct ofport *ofport_, const struct cfm_settings *s)
1655 {
1656     struct ofport_dpif *ofport = ofport_dpif_cast(ofport_);
1657     int error;
1658
1659     if (!s) {
1660         error = 0;
1661     } else {
1662         if (!ofport->cfm) {
1663             struct ofproto_dpif *ofproto;
1664
1665             ofproto = ofproto_dpif_cast(ofport->up.ofproto);
1666             ofproto->backer->need_revalidate = REV_RECONFIGURE;
1667             ofport->cfm = cfm_create(ofport->up.netdev);
1668         }
1669
1670         if (cfm_configure(ofport->cfm, s)) {
1671             return 0;
1672         }
1673
1674         error = EINVAL;
1675     }
1676     cfm_destroy(ofport->cfm);
1677     ofport->cfm = NULL;
1678     return error;
1679 }
1680
1681 static bool
1682 get_cfm_status(const struct ofport *ofport_,
1683                struct ofproto_cfm_status *status)
1684 {
1685     struct ofport_dpif *ofport = ofport_dpif_cast(ofport_);
1686
1687     if (ofport->cfm) {
1688         status->faults = cfm_get_fault(ofport->cfm);
1689         status->remote_opstate = cfm_get_opup(ofport->cfm);
1690         status->health = cfm_get_health(ofport->cfm);
1691         cfm_get_remote_mpids(ofport->cfm, &status->rmps, &status->n_rmps);
1692         return true;
1693     } else {
1694         return false;
1695     }
1696 }
1697
1698 static int
1699 set_bfd(struct ofport *ofport_, const struct smap *cfg)
1700 {
1701     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofport_->ofproto);
1702     struct ofport_dpif *ofport = ofport_dpif_cast(ofport_);
1703     struct bfd *old;
1704
1705     old = ofport->bfd;
1706     ofport->bfd = bfd_configure(old, netdev_get_name(ofport->up.netdev), cfg);
1707     if (ofport->bfd != old) {
1708         ofproto->backer->need_revalidate = REV_RECONFIGURE;
1709     }
1710
1711     return 0;
1712 }
1713
1714 static int
1715 get_bfd_status(struct ofport *ofport_, struct smap *smap)
1716 {
1717     struct ofport_dpif *ofport = ofport_dpif_cast(ofport_);
1718
1719     if (ofport->bfd) {
1720         bfd_get_status(ofport->bfd, smap);
1721         return 0;
1722     } else {
1723         return ENOENT;
1724     }
1725 }
1726 \f
1727 /* Spanning Tree. */
1728
1729 static void
1730 send_bpdu_cb(struct ofpbuf *pkt, int port_num, void *ofproto_)
1731 {
1732     struct ofproto_dpif *ofproto = ofproto_;
1733     struct stp_port *sp = stp_get_port(ofproto->stp, port_num);
1734     struct ofport_dpif *ofport;
1735
1736     ofport = stp_port_get_aux(sp);
1737     if (!ofport) {
1738         VLOG_WARN_RL(&rl, "%s: cannot send BPDU on unknown port %d",
1739                      ofproto->up.name, port_num);
1740     } else {
1741         struct eth_header *eth = pkt->l2;
1742
1743         netdev_get_etheraddr(ofport->up.netdev, eth->eth_src);
1744         if (eth_addr_is_zero(eth->eth_src)) {
1745             VLOG_WARN_RL(&rl, "%s: cannot send BPDU on port %d "
1746                          "with unknown MAC", ofproto->up.name, port_num);
1747         } else {
1748             send_packet(ofport, pkt);
1749         }
1750     }
1751     ofpbuf_delete(pkt);
1752 }
1753
1754 /* Configures STP on 'ofproto_' using the settings defined in 's'. */
1755 static int
1756 set_stp(struct ofproto *ofproto_, const struct ofproto_stp_settings *s)
1757 {
1758     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
1759
1760     /* Only revalidate flows if the configuration changed. */
1761     if (!s != !ofproto->stp) {
1762         ofproto->backer->need_revalidate = REV_RECONFIGURE;
1763     }
1764
1765     if (s) {
1766         if (!ofproto->stp) {
1767             ofproto->stp = stp_create(ofproto_->name, s->system_id,
1768                                       send_bpdu_cb, ofproto);
1769             ofproto->stp_last_tick = time_msec();
1770         }
1771
1772         stp_set_bridge_id(ofproto->stp, s->system_id);
1773         stp_set_bridge_priority(ofproto->stp, s->priority);
1774         stp_set_hello_time(ofproto->stp, s->hello_time);
1775         stp_set_max_age(ofproto->stp, s->max_age);
1776         stp_set_forward_delay(ofproto->stp, s->fwd_delay);
1777     }  else {
1778         struct ofport *ofport;
1779
1780         HMAP_FOR_EACH (ofport, hmap_node, &ofproto->up.ports) {
1781             set_stp_port(ofport, NULL);
1782         }
1783
1784         stp_destroy(ofproto->stp);
1785         ofproto->stp = NULL;
1786     }
1787
1788     return 0;
1789 }
1790
1791 static int
1792 get_stp_status(struct ofproto *ofproto_, struct ofproto_stp_status *s)
1793 {
1794     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
1795
1796     if (ofproto->stp) {
1797         s->enabled = true;
1798         s->bridge_id = stp_get_bridge_id(ofproto->stp);
1799         s->designated_root = stp_get_designated_root(ofproto->stp);
1800         s->root_path_cost = stp_get_root_path_cost(ofproto->stp);
1801     } else {
1802         s->enabled = false;
1803     }
1804
1805     return 0;
1806 }
1807
1808 static void
1809 update_stp_port_state(struct ofport_dpif *ofport)
1810 {
1811     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofport->up.ofproto);
1812     enum stp_state state;
1813
1814     /* Figure out new state. */
1815     state = ofport->stp_port ? stp_port_get_state(ofport->stp_port)
1816                              : STP_DISABLED;
1817
1818     /* Update state. */
1819     if (ofport->stp_state != state) {
1820         enum ofputil_port_state of_state;
1821         bool fwd_change;
1822
1823         VLOG_DBG_RL(&rl, "port %s: STP state changed from %s to %s",
1824                     netdev_get_name(ofport->up.netdev),
1825                     stp_state_name(ofport->stp_state),
1826                     stp_state_name(state));
1827         if (stp_learn_in_state(ofport->stp_state)
1828                 != stp_learn_in_state(state)) {
1829             /* xxx Learning action flows should also be flushed. */
1830             mac_learning_flush(ofproto->ml,
1831                                &ofproto->backer->revalidate_set);
1832         }
1833         fwd_change = stp_forward_in_state(ofport->stp_state)
1834                         != stp_forward_in_state(state);
1835
1836         ofproto->backer->need_revalidate = REV_STP;
1837         ofport->stp_state = state;
1838         ofport->stp_state_entered = time_msec();
1839
1840         if (fwd_change && ofport->bundle) {
1841             bundle_update(ofport->bundle);
1842         }
1843
1844         /* Update the STP state bits in the OpenFlow port description. */
1845         of_state = ofport->up.pp.state & ~OFPUTIL_PS_STP_MASK;
1846         of_state |= (state == STP_LISTENING ? OFPUTIL_PS_STP_LISTEN
1847                      : state == STP_LEARNING ? OFPUTIL_PS_STP_LEARN
1848                      : state == STP_FORWARDING ? OFPUTIL_PS_STP_FORWARD
1849                      : state == STP_BLOCKING ?  OFPUTIL_PS_STP_BLOCK
1850                      : 0);
1851         ofproto_port_set_state(&ofport->up, of_state);
1852     }
1853 }
1854
1855 /* Configures STP on 'ofport_' using the settings defined in 's'.  The
1856  * caller is responsible for assigning STP port numbers and ensuring
1857  * there are no duplicates. */
1858 static int
1859 set_stp_port(struct ofport *ofport_,
1860              const struct ofproto_port_stp_settings *s)
1861 {
1862     struct ofport_dpif *ofport = ofport_dpif_cast(ofport_);
1863     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofport->up.ofproto);
1864     struct stp_port *sp = ofport->stp_port;
1865
1866     if (!s || !s->enable) {
1867         if (sp) {
1868             ofport->stp_port = NULL;
1869             stp_port_disable(sp);
1870             update_stp_port_state(ofport);
1871         }
1872         return 0;
1873     } else if (sp && stp_port_no(sp) != s->port_num
1874             && ofport == stp_port_get_aux(sp)) {
1875         /* The port-id changed, so disable the old one if it's not
1876          * already in use by another port. */
1877         stp_port_disable(sp);
1878     }
1879
1880     sp = ofport->stp_port = stp_get_port(ofproto->stp, s->port_num);
1881     stp_port_enable(sp);
1882
1883     stp_port_set_aux(sp, ofport);
1884     stp_port_set_priority(sp, s->priority);
1885     stp_port_set_path_cost(sp, s->path_cost);
1886
1887     update_stp_port_state(ofport);
1888
1889     return 0;
1890 }
1891
1892 static int
1893 get_stp_port_status(struct ofport *ofport_,
1894                     struct ofproto_port_stp_status *s)
1895 {
1896     struct ofport_dpif *ofport = ofport_dpif_cast(ofport_);
1897     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofport->up.ofproto);
1898     struct stp_port *sp = ofport->stp_port;
1899
1900     if (!ofproto->stp || !sp) {
1901         s->enabled = false;
1902         return 0;
1903     }
1904
1905     s->enabled = true;
1906     s->port_id = stp_port_get_id(sp);
1907     s->state = stp_port_get_state(sp);
1908     s->sec_in_state = (time_msec() - ofport->stp_state_entered) / 1000;
1909     s->role = stp_port_get_role(sp);
1910     stp_port_get_counts(sp, &s->tx_count, &s->rx_count, &s->error_count);
1911
1912     return 0;
1913 }
1914
1915 static void
1916 stp_run(struct ofproto_dpif *ofproto)
1917 {
1918     if (ofproto->stp) {
1919         long long int now = time_msec();
1920         long long int elapsed = now - ofproto->stp_last_tick;
1921         struct stp_port *sp;
1922
1923         if (elapsed > 0) {
1924             stp_tick(ofproto->stp, MIN(INT_MAX, elapsed));
1925             ofproto->stp_last_tick = now;
1926         }
1927         while (stp_get_changed_port(ofproto->stp, &sp)) {
1928             struct ofport_dpif *ofport = stp_port_get_aux(sp);
1929
1930             if (ofport) {
1931                 update_stp_port_state(ofport);
1932             }
1933         }
1934
1935         if (stp_check_and_reset_fdb_flush(ofproto->stp)) {
1936             mac_learning_flush(ofproto->ml, &ofproto->backer->revalidate_set);
1937         }
1938     }
1939 }
1940
1941 static void
1942 stp_wait(struct ofproto_dpif *ofproto)
1943 {
1944     if (ofproto->stp) {
1945         poll_timer_wait(1000);
1946     }
1947 }
1948
1949 /* Returns true if STP should process 'flow'.  Sets fields in 'wc' that
1950  * were used to make the determination.*/
1951 bool
1952 stp_should_process_flow(const struct flow *flow, struct flow_wildcards *wc)
1953 {
1954     memset(&wc->masks.dl_dst, 0xff, sizeof wc->masks.dl_dst);
1955     return eth_addr_equals(flow->dl_dst, eth_addr_stp);
1956 }
1957
1958 void
1959 stp_process_packet(const struct ofport_dpif *ofport,
1960                    const struct ofpbuf *packet)
1961 {
1962     struct ofpbuf payload = *packet;
1963     struct eth_header *eth = payload.data;
1964     struct stp_port *sp = ofport->stp_port;
1965
1966     /* Sink packets on ports that have STP disabled when the bridge has
1967      * STP enabled. */
1968     if (!sp || stp_port_get_state(sp) == STP_DISABLED) {
1969         return;
1970     }
1971
1972     /* Trim off padding on payload. */
1973     if (payload.size > ntohs(eth->eth_type) + ETH_HEADER_LEN) {
1974         payload.size = ntohs(eth->eth_type) + ETH_HEADER_LEN;
1975     }
1976
1977     if (ofpbuf_try_pull(&payload, ETH_HEADER_LEN + LLC_HEADER_LEN)) {
1978         stp_received_bpdu(sp, payload.data, payload.size);
1979     }
1980 }
1981 \f
1982 int
1983 ofproto_dpif_queue_to_priority(const struct ofproto_dpif *ofproto,
1984                                uint32_t queue_id, uint32_t *priority)
1985 {
1986     return dpif_queue_to_priority(ofproto->backer->dpif, queue_id, priority);
1987 }
1988
1989 static struct priority_to_dscp *
1990 get_priority(const struct ofport_dpif *ofport, uint32_t priority)
1991 {
1992     struct priority_to_dscp *pdscp;
1993     uint32_t hash;
1994
1995     hash = hash_int(priority, 0);
1996     HMAP_FOR_EACH_IN_BUCKET (pdscp, hmap_node, hash, &ofport->priorities) {
1997         if (pdscp->priority == priority) {
1998             return pdscp;
1999         }
2000     }
2001     return NULL;
2002 }
2003
2004 bool
2005 ofproto_dpif_dscp_from_priority(const struct ofport_dpif *ofport,
2006                                 uint32_t priority, uint8_t *dscp)
2007 {
2008     struct priority_to_dscp *pdscp = get_priority(ofport, priority);
2009     *dscp = pdscp ? pdscp->dscp : 0;
2010     return pdscp != NULL;
2011 }
2012
2013 static void
2014 ofport_clear_priorities(struct ofport_dpif *ofport)
2015 {
2016     struct priority_to_dscp *pdscp, *next;
2017
2018     HMAP_FOR_EACH_SAFE (pdscp, next, hmap_node, &ofport->priorities) {
2019         hmap_remove(&ofport->priorities, &pdscp->hmap_node);
2020         free(pdscp);
2021     }
2022 }
2023
2024 static int
2025 set_queues(struct ofport *ofport_,
2026            const struct ofproto_port_queue *qdscp_list,
2027            size_t n_qdscp)
2028 {
2029     struct ofport_dpif *ofport = ofport_dpif_cast(ofport_);
2030     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofport->up.ofproto);
2031     struct hmap new = HMAP_INITIALIZER(&new);
2032     size_t i;
2033
2034     for (i = 0; i < n_qdscp; i++) {
2035         struct priority_to_dscp *pdscp;
2036         uint32_t priority;
2037         uint8_t dscp;
2038
2039         dscp = (qdscp_list[i].dscp << 2) & IP_DSCP_MASK;
2040         if (dpif_queue_to_priority(ofproto->backer->dpif, qdscp_list[i].queue,
2041                                    &priority)) {
2042             continue;
2043         }
2044
2045         pdscp = get_priority(ofport, priority);
2046         if (pdscp) {
2047             hmap_remove(&ofport->priorities, &pdscp->hmap_node);
2048         } else {
2049             pdscp = xmalloc(sizeof *pdscp);
2050             pdscp->priority = priority;
2051             pdscp->dscp = dscp;
2052             ofproto->backer->need_revalidate = REV_RECONFIGURE;
2053         }
2054
2055         if (pdscp->dscp != dscp) {
2056             pdscp->dscp = dscp;
2057             ofproto->backer->need_revalidate = REV_RECONFIGURE;
2058         }
2059
2060         hmap_insert(&new, &pdscp->hmap_node, hash_int(pdscp->priority, 0));
2061     }
2062
2063     if (!hmap_is_empty(&ofport->priorities)) {
2064         ofport_clear_priorities(ofport);
2065         ofproto->backer->need_revalidate = REV_RECONFIGURE;
2066     }
2067
2068     hmap_swap(&new, &ofport->priorities);
2069     hmap_destroy(&new);
2070
2071     return 0;
2072 }
2073 \f
2074 /* Bundles. */
2075
2076 /* Expires all MAC learning entries associated with 'bundle' and forces its
2077  * ofproto to revalidate every flow.
2078  *
2079  * Normally MAC learning entries are removed only from the ofproto associated
2080  * with 'bundle', but if 'all_ofprotos' is true, then the MAC learning entries
2081  * are removed from every ofproto.  When patch ports and SLB bonds are in use
2082  * and a VM migration happens and the gratuitous ARPs are somehow lost, this
2083  * avoids a MAC_ENTRY_IDLE_TIME delay before the migrated VM can communicate
2084  * with the host from which it migrated. */
2085 static void
2086 bundle_flush_macs(struct ofbundle *bundle, bool all_ofprotos)
2087 {
2088     struct ofproto_dpif *ofproto = bundle->ofproto;
2089     struct mac_learning *ml = ofproto->ml;
2090     struct mac_entry *mac, *next_mac;
2091
2092     ofproto->backer->need_revalidate = REV_RECONFIGURE;
2093     LIST_FOR_EACH_SAFE (mac, next_mac, lru_node, &ml->lrus) {
2094         if (mac->port.p == bundle) {
2095             if (all_ofprotos) {
2096                 struct ofproto_dpif *o;
2097
2098                 HMAP_FOR_EACH (o, all_ofproto_dpifs_node, &all_ofproto_dpifs) {
2099                     if (o != ofproto) {
2100                         struct mac_entry *e;
2101
2102                         e = mac_learning_lookup(o->ml, mac->mac, mac->vlan,
2103                                                 NULL);
2104                         if (e) {
2105                             mac_learning_expire(o->ml, e);
2106                         }
2107                     }
2108                 }
2109             }
2110
2111             mac_learning_expire(ml, mac);
2112         }
2113     }
2114 }
2115
2116 static struct ofbundle *
2117 bundle_lookup(const struct ofproto_dpif *ofproto, void *aux)
2118 {
2119     struct ofbundle *bundle;
2120
2121     HMAP_FOR_EACH_IN_BUCKET (bundle, hmap_node, hash_pointer(aux, 0),
2122                              &ofproto->bundles) {
2123         if (bundle->aux == aux) {
2124             return bundle;
2125         }
2126     }
2127     return NULL;
2128 }
2129
2130 /* Looks up each of the 'n_auxes' pointers in 'auxes' as bundles and adds the
2131  * ones that are found to 'bundles'. */
2132 static void
2133 bundle_lookup_multiple(struct ofproto_dpif *ofproto,
2134                        void **auxes, size_t n_auxes,
2135                        struct hmapx *bundles)
2136 {
2137     size_t i;
2138
2139     hmapx_init(bundles);
2140     for (i = 0; i < n_auxes; i++) {
2141         struct ofbundle *bundle = bundle_lookup(ofproto, auxes[i]);
2142         if (bundle) {
2143             hmapx_add(bundles, bundle);
2144         }
2145     }
2146 }
2147
2148 static void
2149 bundle_update(struct ofbundle *bundle)
2150 {
2151     struct ofport_dpif *port;
2152
2153     bundle->floodable = true;
2154     LIST_FOR_EACH (port, bundle_node, &bundle->ports) {
2155         if (port->up.pp.config & OFPUTIL_PC_NO_FLOOD
2156             || !stp_forward_in_state(port->stp_state)) {
2157             bundle->floodable = false;
2158             break;
2159         }
2160     }
2161 }
2162
2163 static void
2164 bundle_del_port(struct ofport_dpif *port)
2165 {
2166     struct ofbundle *bundle = port->bundle;
2167
2168     bundle->ofproto->backer->need_revalidate = REV_RECONFIGURE;
2169
2170     list_remove(&port->bundle_node);
2171     port->bundle = NULL;
2172
2173     if (bundle->lacp) {
2174         lacp_slave_unregister(bundle->lacp, port);
2175     }
2176     if (bundle->bond) {
2177         bond_slave_unregister(bundle->bond, port);
2178     }
2179
2180     bundle_update(bundle);
2181 }
2182
2183 static bool
2184 bundle_add_port(struct ofbundle *bundle, ofp_port_t ofp_port,
2185                 struct lacp_slave_settings *lacp)
2186 {
2187     struct ofport_dpif *port;
2188
2189     port = get_ofp_port(bundle->ofproto, ofp_port);
2190     if (!port) {
2191         return false;
2192     }
2193
2194     if (port->bundle != bundle) {
2195         bundle->ofproto->backer->need_revalidate = REV_RECONFIGURE;
2196         if (port->bundle) {
2197             bundle_del_port(port);
2198         }
2199
2200         port->bundle = bundle;
2201         list_push_back(&bundle->ports, &port->bundle_node);
2202         if (port->up.pp.config & OFPUTIL_PC_NO_FLOOD
2203             || !stp_forward_in_state(port->stp_state)) {
2204             bundle->floodable = false;
2205         }
2206     }
2207     if (lacp) {
2208         bundle->ofproto->backer->need_revalidate = REV_RECONFIGURE;
2209         lacp_slave_register(bundle->lacp, port, lacp);
2210     }
2211
2212     return true;
2213 }
2214
2215 static void
2216 bundle_destroy(struct ofbundle *bundle)
2217 {
2218     struct ofproto_dpif *ofproto;
2219     struct ofport_dpif *port, *next_port;
2220     int i;
2221
2222     if (!bundle) {
2223         return;
2224     }
2225
2226     ofproto = bundle->ofproto;
2227     for (i = 0; i < MAX_MIRRORS; i++) {
2228         struct ofmirror *m = ofproto->mirrors[i];
2229         if (m) {
2230             if (m->out == bundle) {
2231                 mirror_destroy(m);
2232             } else if (hmapx_find_and_delete(&m->srcs, bundle)
2233                        || hmapx_find_and_delete(&m->dsts, bundle)) {
2234                 ofproto->backer->need_revalidate = REV_RECONFIGURE;
2235             }
2236         }
2237     }
2238
2239     LIST_FOR_EACH_SAFE (port, next_port, bundle_node, &bundle->ports) {
2240         bundle_del_port(port);
2241     }
2242
2243     bundle_flush_macs(bundle, true);
2244     hmap_remove(&ofproto->bundles, &bundle->hmap_node);
2245     free(bundle->name);
2246     free(bundle->trunks);
2247     lacp_destroy(bundle->lacp);
2248     bond_destroy(bundle->bond);
2249     free(bundle);
2250 }
2251
2252 static int
2253 bundle_set(struct ofproto *ofproto_, void *aux,
2254            const struct ofproto_bundle_settings *s)
2255 {
2256     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
2257     bool need_flush = false;
2258     struct ofport_dpif *port;
2259     struct ofbundle *bundle;
2260     unsigned long *trunks;
2261     int vlan;
2262     size_t i;
2263     bool ok;
2264
2265     if (!s) {
2266         bundle_destroy(bundle_lookup(ofproto, aux));
2267         return 0;
2268     }
2269
2270     ovs_assert(s->n_slaves == 1 || s->bond != NULL);
2271     ovs_assert((s->lacp != NULL) == (s->lacp_slaves != NULL));
2272
2273     bundle = bundle_lookup(ofproto, aux);
2274     if (!bundle) {
2275         bundle = xmalloc(sizeof *bundle);
2276
2277         bundle->ofproto = ofproto;
2278         hmap_insert(&ofproto->bundles, &bundle->hmap_node,
2279                     hash_pointer(aux, 0));
2280         bundle->aux = aux;
2281         bundle->name = NULL;
2282
2283         list_init(&bundle->ports);
2284         bundle->vlan_mode = PORT_VLAN_TRUNK;
2285         bundle->vlan = -1;
2286         bundle->trunks = NULL;
2287         bundle->use_priority_tags = s->use_priority_tags;
2288         bundle->lacp = NULL;
2289         bundle->bond = NULL;
2290
2291         bundle->floodable = true;
2292
2293         bundle->src_mirrors = 0;
2294         bundle->dst_mirrors = 0;
2295         bundle->mirror_out = 0;
2296     }
2297
2298     if (!bundle->name || strcmp(s->name, bundle->name)) {
2299         free(bundle->name);
2300         bundle->name = xstrdup(s->name);
2301     }
2302
2303     /* LACP. */
2304     if (s->lacp) {
2305         if (!bundle->lacp) {
2306             ofproto->backer->need_revalidate = REV_RECONFIGURE;
2307             bundle->lacp = lacp_create();
2308         }
2309         lacp_configure(bundle->lacp, s->lacp);
2310     } else {
2311         lacp_destroy(bundle->lacp);
2312         bundle->lacp = NULL;
2313     }
2314
2315     /* Update set of ports. */
2316     ok = true;
2317     for (i = 0; i < s->n_slaves; i++) {
2318         if (!bundle_add_port(bundle, s->slaves[i],
2319                              s->lacp ? &s->lacp_slaves[i] : NULL)) {
2320             ok = false;
2321         }
2322     }
2323     if (!ok || list_size(&bundle->ports) != s->n_slaves) {
2324         struct ofport_dpif *next_port;
2325
2326         LIST_FOR_EACH_SAFE (port, next_port, bundle_node, &bundle->ports) {
2327             for (i = 0; i < s->n_slaves; i++) {
2328                 if (s->slaves[i] == port->up.ofp_port) {
2329                     goto found;
2330                 }
2331             }
2332
2333             bundle_del_port(port);
2334         found: ;
2335         }
2336     }
2337     ovs_assert(list_size(&bundle->ports) <= s->n_slaves);
2338
2339     if (list_is_empty(&bundle->ports)) {
2340         bundle_destroy(bundle);
2341         return EINVAL;
2342     }
2343
2344     /* Set VLAN tagging mode */
2345     if (s->vlan_mode != bundle->vlan_mode
2346         || s->use_priority_tags != bundle->use_priority_tags) {
2347         bundle->vlan_mode = s->vlan_mode;
2348         bundle->use_priority_tags = s->use_priority_tags;
2349         need_flush = true;
2350     }
2351
2352     /* Set VLAN tag. */
2353     vlan = (s->vlan_mode == PORT_VLAN_TRUNK ? -1
2354             : s->vlan >= 0 && s->vlan <= 4095 ? s->vlan
2355             : 0);
2356     if (vlan != bundle->vlan) {
2357         bundle->vlan = vlan;
2358         need_flush = true;
2359     }
2360
2361     /* Get trunked VLANs. */
2362     switch (s->vlan_mode) {
2363     case PORT_VLAN_ACCESS:
2364         trunks = NULL;
2365         break;
2366
2367     case PORT_VLAN_TRUNK:
2368         trunks = CONST_CAST(unsigned long *, s->trunks);
2369         break;
2370
2371     case PORT_VLAN_NATIVE_UNTAGGED:
2372     case PORT_VLAN_NATIVE_TAGGED:
2373         if (vlan != 0 && (!s->trunks
2374                           || !bitmap_is_set(s->trunks, vlan)
2375                           || bitmap_is_set(s->trunks, 0))) {
2376             /* Force trunking the native VLAN and prohibit trunking VLAN 0. */
2377             if (s->trunks) {
2378                 trunks = bitmap_clone(s->trunks, 4096);
2379             } else {
2380                 trunks = bitmap_allocate1(4096);
2381             }
2382             bitmap_set1(trunks, vlan);
2383             bitmap_set0(trunks, 0);
2384         } else {
2385             trunks = CONST_CAST(unsigned long *, s->trunks);
2386         }
2387         break;
2388
2389     default:
2390         NOT_REACHED();
2391     }
2392     if (!vlan_bitmap_equal(trunks, bundle->trunks)) {
2393         free(bundle->trunks);
2394         if (trunks == s->trunks) {
2395             bundle->trunks = vlan_bitmap_clone(trunks);
2396         } else {
2397             bundle->trunks = trunks;
2398             trunks = NULL;
2399         }
2400         need_flush = true;
2401     }
2402     if (trunks != s->trunks) {
2403         free(trunks);
2404     }
2405
2406     /* Bonding. */
2407     if (!list_is_short(&bundle->ports)) {
2408         bundle->ofproto->has_bonded_bundles = true;
2409         if (bundle->bond) {
2410             if (bond_reconfigure(bundle->bond, s->bond)) {
2411                 ofproto->backer->need_revalidate = REV_RECONFIGURE;
2412             }
2413         } else {
2414             bundle->bond = bond_create(s->bond);
2415             ofproto->backer->need_revalidate = REV_RECONFIGURE;
2416         }
2417
2418         LIST_FOR_EACH (port, bundle_node, &bundle->ports) {
2419             bond_slave_register(bundle->bond, port, port->up.netdev);
2420         }
2421     } else {
2422         bond_destroy(bundle->bond);
2423         bundle->bond = NULL;
2424     }
2425
2426     /* If we changed something that would affect MAC learning, un-learn
2427      * everything on this port and force flow revalidation. */
2428     if (need_flush) {
2429         bundle_flush_macs(bundle, false);
2430     }
2431
2432     return 0;
2433 }
2434
2435 static void
2436 bundle_remove(struct ofport *port_)
2437 {
2438     struct ofport_dpif *port = ofport_dpif_cast(port_);
2439     struct ofbundle *bundle = port->bundle;
2440
2441     if (bundle) {
2442         bundle_del_port(port);
2443         if (list_is_empty(&bundle->ports)) {
2444             bundle_destroy(bundle);
2445         } else if (list_is_short(&bundle->ports)) {
2446             bond_destroy(bundle->bond);
2447             bundle->bond = NULL;
2448         }
2449     }
2450 }
2451
2452 static void
2453 send_pdu_cb(void *port_, const void *pdu, size_t pdu_size)
2454 {
2455     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 10);
2456     struct ofport_dpif *port = port_;
2457     uint8_t ea[ETH_ADDR_LEN];
2458     int error;
2459
2460     error = netdev_get_etheraddr(port->up.netdev, ea);
2461     if (!error) {
2462         struct ofpbuf packet;
2463         void *packet_pdu;
2464
2465         ofpbuf_init(&packet, 0);
2466         packet_pdu = eth_compose(&packet, eth_addr_lacp, ea, ETH_TYPE_LACP,
2467                                  pdu_size);
2468         memcpy(packet_pdu, pdu, pdu_size);
2469
2470         send_packet(port, &packet);
2471         ofpbuf_uninit(&packet);
2472     } else {
2473         VLOG_ERR_RL(&rl, "port %s: cannot obtain Ethernet address of iface "
2474                     "%s (%s)", port->bundle->name,
2475                     netdev_get_name(port->up.netdev), strerror(error));
2476     }
2477 }
2478
2479 static void
2480 bundle_send_learning_packets(struct ofbundle *bundle)
2481 {
2482     struct ofproto_dpif *ofproto = bundle->ofproto;
2483     int error, n_packets, n_errors;
2484     struct mac_entry *e;
2485
2486     error = n_packets = n_errors = 0;
2487     LIST_FOR_EACH (e, lru_node, &ofproto->ml->lrus) {
2488         if (e->port.p != bundle) {
2489             struct ofpbuf *learning_packet;
2490             struct ofport_dpif *port;
2491             void *port_void;
2492             int ret;
2493
2494             /* The assignment to "port" is unnecessary but makes "grep"ing for
2495              * struct ofport_dpif more effective. */
2496             learning_packet = bond_compose_learning_packet(bundle->bond,
2497                                                            e->mac, e->vlan,
2498                                                            &port_void);
2499             port = port_void;
2500             ret = send_packet(port, learning_packet);
2501             ofpbuf_delete(learning_packet);
2502             if (ret) {
2503                 error = ret;
2504                 n_errors++;
2505             }
2506             n_packets++;
2507         }
2508     }
2509
2510     if (n_errors) {
2511         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
2512         VLOG_WARN_RL(&rl, "bond %s: %d errors sending %d gratuitous learning "
2513                      "packets, last error was: %s",
2514                      bundle->name, n_errors, n_packets, strerror(error));
2515     } else {
2516         VLOG_DBG("bond %s: sent %d gratuitous learning packets",
2517                  bundle->name, n_packets);
2518     }
2519 }
2520
2521 static void
2522 bundle_run(struct ofbundle *bundle)
2523 {
2524     if (bundle->lacp) {
2525         lacp_run(bundle->lacp, send_pdu_cb);
2526     }
2527     if (bundle->bond) {
2528         struct ofport_dpif *port;
2529
2530         LIST_FOR_EACH (port, bundle_node, &bundle->ports) {
2531             bond_slave_set_may_enable(bundle->bond, port, port->may_enable);
2532         }
2533
2534         bond_run(bundle->bond, &bundle->ofproto->backer->revalidate_set,
2535                  lacp_status(bundle->lacp));
2536         if (bond_should_send_learning_packets(bundle->bond)) {
2537             bundle_send_learning_packets(bundle);
2538         }
2539     }
2540 }
2541
2542 static void
2543 bundle_wait(struct ofbundle *bundle)
2544 {
2545     if (bundle->lacp) {
2546         lacp_wait(bundle->lacp);
2547     }
2548     if (bundle->bond) {
2549         bond_wait(bundle->bond);
2550     }
2551 }
2552 \f
2553 /* Mirrors. */
2554
2555 static int
2556 mirror_scan(struct ofproto_dpif *ofproto)
2557 {
2558     int idx;
2559
2560     for (idx = 0; idx < MAX_MIRRORS; idx++) {
2561         if (!ofproto->mirrors[idx]) {
2562             return idx;
2563         }
2564     }
2565     return -1;
2566 }
2567
2568 static struct ofmirror *
2569 mirror_lookup(struct ofproto_dpif *ofproto, void *aux)
2570 {
2571     int i;
2572
2573     for (i = 0; i < MAX_MIRRORS; i++) {
2574         struct ofmirror *mirror = ofproto->mirrors[i];
2575         if (mirror && mirror->aux == aux) {
2576             return mirror;
2577         }
2578     }
2579
2580     return NULL;
2581 }
2582
2583 /* Update the 'dup_mirrors' member of each of the ofmirrors in 'ofproto'. */
2584 static void
2585 mirror_update_dups(struct ofproto_dpif *ofproto)
2586 {
2587     int i;
2588
2589     for (i = 0; i < MAX_MIRRORS; i++) {
2590         struct ofmirror *m = ofproto->mirrors[i];
2591
2592         if (m) {
2593             m->dup_mirrors = MIRROR_MASK_C(1) << i;
2594         }
2595     }
2596
2597     for (i = 0; i < MAX_MIRRORS; i++) {
2598         struct ofmirror *m1 = ofproto->mirrors[i];
2599         int j;
2600
2601         if (!m1) {
2602             continue;
2603         }
2604
2605         for (j = i + 1; j < MAX_MIRRORS; j++) {
2606             struct ofmirror *m2 = ofproto->mirrors[j];
2607
2608             if (m2 && m1->out == m2->out && m1->out_vlan == m2->out_vlan) {
2609                 m1->dup_mirrors |= MIRROR_MASK_C(1) << j;
2610                 m2->dup_mirrors |= m1->dup_mirrors;
2611             }
2612         }
2613     }
2614 }
2615
2616 static int
2617 mirror_set(struct ofproto *ofproto_, void *aux,
2618            const struct ofproto_mirror_settings *s)
2619 {
2620     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
2621     mirror_mask_t mirror_bit;
2622     struct ofbundle *bundle;
2623     struct ofmirror *mirror;
2624     struct ofbundle *out;
2625     struct hmapx srcs;          /* Contains "struct ofbundle *"s. */
2626     struct hmapx dsts;          /* Contains "struct ofbundle *"s. */
2627     int out_vlan;
2628
2629     mirror = mirror_lookup(ofproto, aux);
2630     if (!s) {
2631         mirror_destroy(mirror);
2632         return 0;
2633     }
2634     if (!mirror) {
2635         int idx;
2636
2637         idx = mirror_scan(ofproto);
2638         if (idx < 0) {
2639             VLOG_WARN("bridge %s: maximum of %d port mirrors reached, "
2640                       "cannot create %s",
2641                       ofproto->up.name, MAX_MIRRORS, s->name);
2642             return EFBIG;
2643         }
2644
2645         mirror = ofproto->mirrors[idx] = xzalloc(sizeof *mirror);
2646         mirror->ofproto = ofproto;
2647         mirror->idx = idx;
2648         mirror->aux = aux;
2649         mirror->out_vlan = -1;
2650         mirror->name = NULL;
2651     }
2652
2653     if (!mirror->name || strcmp(s->name, mirror->name)) {
2654         free(mirror->name);
2655         mirror->name = xstrdup(s->name);
2656     }
2657
2658     /* Get the new configuration. */
2659     if (s->out_bundle) {
2660         out = bundle_lookup(ofproto, s->out_bundle);
2661         if (!out) {
2662             mirror_destroy(mirror);
2663             return EINVAL;
2664         }
2665         out_vlan = -1;
2666     } else {
2667         out = NULL;
2668         out_vlan = s->out_vlan;
2669     }
2670     bundle_lookup_multiple(ofproto, s->srcs, s->n_srcs, &srcs);
2671     bundle_lookup_multiple(ofproto, s->dsts, s->n_dsts, &dsts);
2672
2673     /* If the configuration has not changed, do nothing. */
2674     if (hmapx_equals(&srcs, &mirror->srcs)
2675         && hmapx_equals(&dsts, &mirror->dsts)
2676         && vlan_bitmap_equal(mirror->vlans, s->src_vlans)
2677         && mirror->out == out
2678         && mirror->out_vlan == out_vlan)
2679     {
2680         hmapx_destroy(&srcs);
2681         hmapx_destroy(&dsts);
2682         return 0;
2683     }
2684
2685     hmapx_swap(&srcs, &mirror->srcs);
2686     hmapx_destroy(&srcs);
2687
2688     hmapx_swap(&dsts, &mirror->dsts);
2689     hmapx_destroy(&dsts);
2690
2691     free(mirror->vlans);
2692     mirror->vlans = vlan_bitmap_clone(s->src_vlans);
2693
2694     mirror->out = out;
2695     mirror->out_vlan = out_vlan;
2696
2697     /* Update bundles. */
2698     mirror_bit = MIRROR_MASK_C(1) << mirror->idx;
2699     HMAP_FOR_EACH (bundle, hmap_node, &mirror->ofproto->bundles) {
2700         if (hmapx_contains(&mirror->srcs, bundle)) {
2701             bundle->src_mirrors |= mirror_bit;
2702         } else {
2703             bundle->src_mirrors &= ~mirror_bit;
2704         }
2705
2706         if (hmapx_contains(&mirror->dsts, bundle)) {
2707             bundle->dst_mirrors |= mirror_bit;
2708         } else {
2709             bundle->dst_mirrors &= ~mirror_bit;
2710         }
2711
2712         if (mirror->out == bundle) {
2713             bundle->mirror_out |= mirror_bit;
2714         } else {
2715             bundle->mirror_out &= ~mirror_bit;
2716         }
2717     }
2718
2719     ofproto->backer->need_revalidate = REV_RECONFIGURE;
2720     ofproto->has_mirrors = true;
2721     mac_learning_flush(ofproto->ml,
2722                        &ofproto->backer->revalidate_set);
2723     mirror_update_dups(ofproto);
2724
2725     return 0;
2726 }
2727
2728 static void
2729 mirror_destroy(struct ofmirror *mirror)
2730 {
2731     struct ofproto_dpif *ofproto;
2732     mirror_mask_t mirror_bit;
2733     struct ofbundle *bundle;
2734     int i;
2735
2736     if (!mirror) {
2737         return;
2738     }
2739
2740     ofproto = mirror->ofproto;
2741     ofproto->backer->need_revalidate = REV_RECONFIGURE;
2742     mac_learning_flush(ofproto->ml, &ofproto->backer->revalidate_set);
2743
2744     mirror_bit = MIRROR_MASK_C(1) << mirror->idx;
2745     HMAP_FOR_EACH (bundle, hmap_node, &ofproto->bundles) {
2746         bundle->src_mirrors &= ~mirror_bit;
2747         bundle->dst_mirrors &= ~mirror_bit;
2748         bundle->mirror_out &= ~mirror_bit;
2749     }
2750
2751     hmapx_destroy(&mirror->srcs);
2752     hmapx_destroy(&mirror->dsts);
2753     free(mirror->vlans);
2754
2755     ofproto->mirrors[mirror->idx] = NULL;
2756     free(mirror->name);
2757     free(mirror);
2758
2759     mirror_update_dups(ofproto);
2760
2761     ofproto->has_mirrors = false;
2762     for (i = 0; i < MAX_MIRRORS; i++) {
2763         if (ofproto->mirrors[i]) {
2764             ofproto->has_mirrors = true;
2765             break;
2766         }
2767     }
2768 }
2769
2770 static int
2771 mirror_get_stats(struct ofproto *ofproto_, void *aux,
2772                  uint64_t *packets, uint64_t *bytes)
2773 {
2774     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
2775     struct ofmirror *mirror = mirror_lookup(ofproto, aux);
2776
2777     if (!mirror) {
2778         *packets = *bytes = UINT64_MAX;
2779         return 0;
2780     }
2781
2782     push_all_stats();
2783
2784     *packets = mirror->packet_count;
2785     *bytes = mirror->byte_count;
2786
2787     return 0;
2788 }
2789
2790 static int
2791 set_flood_vlans(struct ofproto *ofproto_, unsigned long *flood_vlans)
2792 {
2793     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
2794     if (mac_learning_set_flood_vlans(ofproto->ml, flood_vlans)) {
2795         mac_learning_flush(ofproto->ml, &ofproto->backer->revalidate_set);
2796     }
2797     return 0;
2798 }
2799
2800 static bool
2801 is_mirror_output_bundle(const struct ofproto *ofproto_, void *aux)
2802 {
2803     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
2804     struct ofbundle *bundle = bundle_lookup(ofproto, aux);
2805     return bundle && bundle->mirror_out != 0;
2806 }
2807
2808 static void
2809 forward_bpdu_changed(struct ofproto *ofproto_)
2810 {
2811     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
2812     ofproto->backer->need_revalidate = REV_RECONFIGURE;
2813 }
2814
2815 static void
2816 set_mac_table_config(struct ofproto *ofproto_, unsigned int idle_time,
2817                      size_t max_entries)
2818 {
2819     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
2820     mac_learning_set_idle_time(ofproto->ml, idle_time);
2821     mac_learning_set_max_entries(ofproto->ml, max_entries);
2822 }
2823 \f
2824 /* Ports. */
2825
2826 struct ofport_dpif *
2827 get_ofp_port(const struct ofproto_dpif *ofproto, ofp_port_t ofp_port)
2828 {
2829     struct ofport *ofport = ofproto_get_port(&ofproto->up, ofp_port);
2830     return ofport ? ofport_dpif_cast(ofport) : NULL;
2831 }
2832
2833 struct ofport_dpif *
2834 get_odp_port(const struct ofproto_dpif *ofproto, odp_port_t odp_port)
2835 {
2836     struct ofport_dpif *port = odp_port_to_ofport(ofproto->backer, odp_port);
2837     return port && &ofproto->up == port->up.ofproto ? port : NULL;
2838 }
2839
2840 static void
2841 ofproto_port_from_dpif_port(struct ofproto_dpif *ofproto,
2842                             struct ofproto_port *ofproto_port,
2843                             struct dpif_port *dpif_port)
2844 {
2845     ofproto_port->name = dpif_port->name;
2846     ofproto_port->type = dpif_port->type;
2847     ofproto_port->ofp_port = odp_port_to_ofp_port(ofproto, dpif_port->port_no);
2848 }
2849
2850 static void
2851 ofport_update_peer(struct ofport_dpif *ofport)
2852 {
2853     const struct ofproto_dpif *ofproto;
2854     struct dpif_backer *backer;
2855     const char *peer_name;
2856
2857     if (!netdev_vport_is_patch(ofport->up.netdev)) {
2858         return;
2859     }
2860
2861     backer = ofproto_dpif_cast(ofport->up.ofproto)->backer;
2862     backer->need_revalidate = true;
2863
2864     if (ofport->peer) {
2865         ofport->peer->peer = NULL;
2866         ofport->peer = NULL;
2867     }
2868
2869     peer_name = netdev_vport_patch_peer(ofport->up.netdev);
2870     if (!peer_name) {
2871         return;
2872     }
2873
2874     HMAP_FOR_EACH (ofproto, all_ofproto_dpifs_node, &all_ofproto_dpifs) {
2875         struct ofport *peer_ofport;
2876         struct ofport_dpif *peer;
2877         const char *peer_peer;
2878
2879         if (ofproto->backer != backer) {
2880             continue;
2881         }
2882
2883         peer_ofport = shash_find_data(&ofproto->up.port_by_name, peer_name);
2884         if (!peer_ofport) {
2885             continue;
2886         }
2887
2888         peer = ofport_dpif_cast(peer_ofport);
2889         peer_peer = netdev_vport_patch_peer(peer->up.netdev);
2890         if (peer_peer && !strcmp(netdev_get_name(ofport->up.netdev),
2891                                  peer_peer)) {
2892             ofport->peer = peer;
2893             ofport->peer->peer = ofport;
2894         }
2895
2896         return;
2897     }
2898 }
2899
2900 static void
2901 port_run_fast(struct ofport_dpif *ofport)
2902 {
2903     if (ofport->cfm && cfm_should_send_ccm(ofport->cfm)) {
2904         struct ofpbuf packet;
2905
2906         ofpbuf_init(&packet, 0);
2907         cfm_compose_ccm(ofport->cfm, &packet, ofport->up.pp.hw_addr);
2908         send_packet(ofport, &packet);
2909         ofpbuf_uninit(&packet);
2910     }
2911
2912     if (ofport->bfd && bfd_should_send_packet(ofport->bfd)) {
2913         struct ofpbuf packet;
2914
2915         ofpbuf_init(&packet, 0);
2916         bfd_put_packet(ofport->bfd, &packet, ofport->up.pp.hw_addr);
2917         send_packet(ofport, &packet);
2918         ofpbuf_uninit(&packet);
2919     }
2920 }
2921
2922 static void
2923 port_run(struct ofport_dpif *ofport)
2924 {
2925     long long int carrier_seq = netdev_get_carrier_resets(ofport->up.netdev);
2926     bool carrier_changed = carrier_seq != ofport->carrier_seq;
2927     bool enable = netdev_get_carrier(ofport->up.netdev);
2928
2929     ofport->carrier_seq = carrier_seq;
2930
2931     port_run_fast(ofport);
2932
2933     if (ofport->cfm) {
2934         int cfm_opup = cfm_get_opup(ofport->cfm);
2935
2936         cfm_run(ofport->cfm);
2937         enable = enable && !cfm_get_fault(ofport->cfm);
2938
2939         if (cfm_opup >= 0) {
2940             enable = enable && cfm_opup;
2941         }
2942     }
2943
2944     if (ofport->bfd) {
2945         bfd_run(ofport->bfd);
2946         enable = enable && bfd_forwarding(ofport->bfd);
2947     }
2948
2949     if (ofport->bundle) {
2950         enable = enable && lacp_slave_may_enable(ofport->bundle->lacp, ofport);
2951         if (carrier_changed) {
2952             lacp_slave_carrier_changed(ofport->bundle->lacp, ofport);
2953         }
2954     }
2955
2956     if (ofport->may_enable != enable) {
2957         struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofport->up.ofproto);
2958
2959         if (ofproto->has_bundle_action) {
2960             ofproto->backer->need_revalidate = REV_PORT_TOGGLED;
2961         }
2962     }
2963
2964     ofport->may_enable = enable;
2965 }
2966
2967 static void
2968 port_wait(struct ofport_dpif *ofport)
2969 {
2970     if (ofport->cfm) {
2971         cfm_wait(ofport->cfm);
2972     }
2973
2974     if (ofport->bfd) {
2975         bfd_wait(ofport->bfd);
2976     }
2977 }
2978
2979 static int
2980 port_query_by_name(const struct ofproto *ofproto_, const char *devname,
2981                    struct ofproto_port *ofproto_port)
2982 {
2983     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
2984     struct dpif_port dpif_port;
2985     int error;
2986
2987     if (sset_contains(&ofproto->ghost_ports, devname)) {
2988         const char *type = netdev_get_type_from_name(devname);
2989
2990         /* We may be called before ofproto->up.port_by_name is populated with
2991          * the appropriate ofport.  For this reason, we must get the name and
2992          * type from the netdev layer directly. */
2993         if (type) {
2994             const struct ofport *ofport;
2995
2996             ofport = shash_find_data(&ofproto->up.port_by_name, devname);
2997             ofproto_port->ofp_port = ofport ? ofport->ofp_port : OFPP_NONE;
2998             ofproto_port->name = xstrdup(devname);
2999             ofproto_port->type = xstrdup(type);
3000             return 0;
3001         }
3002         return ENODEV;
3003     }
3004
3005     if (!sset_contains(&ofproto->ports, devname)) {
3006         return ENODEV;
3007     }
3008     error = dpif_port_query_by_name(ofproto->backer->dpif,
3009                                     devname, &dpif_port);
3010     if (!error) {
3011         ofproto_port_from_dpif_port(ofproto, ofproto_port, &dpif_port);
3012     }
3013     return error;
3014 }
3015
3016 static int
3017 port_add(struct ofproto *ofproto_, struct netdev *netdev)
3018 {
3019     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
3020     const char *devname = netdev_get_name(netdev);
3021     char namebuf[NETDEV_VPORT_NAME_BUFSIZE];
3022     const char *dp_port_name;
3023
3024     if (netdev_vport_is_patch(netdev)) {
3025         sset_add(&ofproto->ghost_ports, netdev_get_name(netdev));
3026         return 0;
3027     }
3028
3029     dp_port_name = netdev_vport_get_dpif_port(netdev, namebuf, sizeof namebuf);
3030     if (!dpif_port_exists(ofproto->backer->dpif, dp_port_name)) {
3031         odp_port_t port_no = ODPP_NONE;
3032         int error;
3033
3034         error = dpif_port_add(ofproto->backer->dpif, netdev, &port_no);
3035         if (error) {
3036             return error;
3037         }
3038         if (netdev_get_tunnel_config(netdev)) {
3039             simap_put(&ofproto->backer->tnl_backers,
3040                       dp_port_name, odp_to_u32(port_no));
3041         }
3042     }
3043
3044     if (netdev_get_tunnel_config(netdev)) {
3045         sset_add(&ofproto->ghost_ports, devname);
3046     } else {
3047         sset_add(&ofproto->ports, devname);
3048     }
3049     return 0;
3050 }
3051
3052 static int
3053 port_del(struct ofproto *ofproto_, ofp_port_t ofp_port)
3054 {
3055     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
3056     struct ofport_dpif *ofport = get_ofp_port(ofproto, ofp_port);
3057     int error = 0;
3058
3059     if (!ofport) {
3060         return 0;
3061     }
3062
3063     sset_find_and_delete(&ofproto->ghost_ports,
3064                          netdev_get_name(ofport->up.netdev));
3065     ofproto->backer->need_revalidate = REV_RECONFIGURE;
3066     if (!ofport->tnl_port) {
3067         error = dpif_port_del(ofproto->backer->dpif, ofport->odp_port);
3068         if (!error) {
3069             /* The caller is going to close ofport->up.netdev.  If this is a
3070              * bonded port, then the bond is using that netdev, so remove it
3071              * from the bond.  The client will need to reconfigure everything
3072              * after deleting ports, so then the slave will get re-added. */
3073             bundle_remove(&ofport->up);
3074         }
3075     }
3076     return error;
3077 }
3078
3079 static int
3080 port_get_stats(const struct ofport *ofport_, struct netdev_stats *stats)
3081 {
3082     struct ofport_dpif *ofport = ofport_dpif_cast(ofport_);
3083     int error;
3084
3085     push_all_stats();
3086
3087     error = netdev_get_stats(ofport->up.netdev, stats);
3088
3089     if (!error && ofport_->ofp_port == OFPP_LOCAL) {
3090         struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofport->up.ofproto);
3091
3092         /* ofproto->stats.tx_packets represents packets that we created
3093          * internally and sent to some port (e.g. packets sent with
3094          * send_packet()).  Account for them as if they had come from
3095          * OFPP_LOCAL and got forwarded. */
3096
3097         if (stats->rx_packets != UINT64_MAX) {
3098             stats->rx_packets += ofproto->stats.tx_packets;
3099         }
3100
3101         if (stats->rx_bytes != UINT64_MAX) {
3102             stats->rx_bytes += ofproto->stats.tx_bytes;
3103         }
3104
3105         /* ofproto->stats.rx_packets represents packets that were received on
3106          * some port and we processed internally and dropped (e.g. STP).
3107          * Account for them as if they had been forwarded to OFPP_LOCAL. */
3108
3109         if (stats->tx_packets != UINT64_MAX) {
3110             stats->tx_packets += ofproto->stats.rx_packets;
3111         }
3112
3113         if (stats->tx_bytes != UINT64_MAX) {
3114             stats->tx_bytes += ofproto->stats.rx_bytes;
3115         }
3116     }
3117
3118     return error;
3119 }
3120
3121 struct port_dump_state {
3122     uint32_t bucket;
3123     uint32_t offset;
3124     bool ghost;
3125
3126     struct ofproto_port port;
3127     bool has_port;
3128 };
3129
3130 static int
3131 port_dump_start(const struct ofproto *ofproto_ OVS_UNUSED, void **statep)
3132 {
3133     *statep = xzalloc(sizeof(struct port_dump_state));
3134     return 0;
3135 }
3136
3137 static int
3138 port_dump_next(const struct ofproto *ofproto_, void *state_,
3139                struct ofproto_port *port)
3140 {
3141     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
3142     struct port_dump_state *state = state_;
3143     const struct sset *sset;
3144     struct sset_node *node;
3145
3146     if (state->has_port) {
3147         ofproto_port_destroy(&state->port);
3148         state->has_port = false;
3149     }
3150     sset = state->ghost ? &ofproto->ghost_ports : &ofproto->ports;
3151     while ((node = sset_at_position(sset, &state->bucket, &state->offset))) {
3152         int error;
3153
3154         error = port_query_by_name(ofproto_, node->name, &state->port);
3155         if (!error) {
3156             *port = state->port;
3157             state->has_port = true;
3158             return 0;
3159         } else if (error != ENODEV) {
3160             return error;
3161         }
3162     }
3163
3164     if (!state->ghost) {
3165         state->ghost = true;
3166         state->bucket = 0;
3167         state->offset = 0;
3168         return port_dump_next(ofproto_, state_, port);
3169     }
3170
3171     return EOF;
3172 }
3173
3174 static int
3175 port_dump_done(const struct ofproto *ofproto_ OVS_UNUSED, void *state_)
3176 {
3177     struct port_dump_state *state = state_;
3178
3179     if (state->has_port) {
3180         ofproto_port_destroy(&state->port);
3181     }
3182     free(state);
3183     return 0;
3184 }
3185
3186 static int
3187 port_poll(const struct ofproto *ofproto_, char **devnamep)
3188 {
3189     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
3190
3191     if (ofproto->port_poll_errno) {
3192         int error = ofproto->port_poll_errno;
3193         ofproto->port_poll_errno = 0;
3194         return error;
3195     }
3196
3197     if (sset_is_empty(&ofproto->port_poll_set)) {
3198         return EAGAIN;
3199     }
3200
3201     *devnamep = sset_pop(&ofproto->port_poll_set);
3202     return 0;
3203 }
3204
3205 static void
3206 port_poll_wait(const struct ofproto *ofproto_)
3207 {
3208     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
3209     dpif_port_poll_wait(ofproto->backer->dpif);
3210 }
3211
3212 static int
3213 port_is_lacp_current(const struct ofport *ofport_)
3214 {
3215     const struct ofport_dpif *ofport = ofport_dpif_cast(ofport_);
3216     return (ofport->bundle && ofport->bundle->lacp
3217             ? lacp_slave_is_current(ofport->bundle->lacp, ofport)
3218             : -1);
3219 }
3220 \f
3221 /* Upcall handling. */
3222
3223 /* Flow miss batching.
3224  *
3225  * Some dpifs implement operations faster when you hand them off in a batch.
3226  * To allow batching, "struct flow_miss" queues the dpif-related work needed
3227  * for a given flow.  Each "struct flow_miss" corresponds to sending one or
3228  * more packets, plus possibly installing the flow in the dpif.
3229  *
3230  * So far we only batch the operations that affect flow setup time the most.
3231  * It's possible to batch more than that, but the benefit might be minimal. */
3232 struct flow_miss {
3233     struct hmap_node hmap_node;
3234     struct ofproto_dpif *ofproto;
3235     struct flow flow;
3236     enum odp_key_fitness key_fitness;
3237     const struct nlattr *key;
3238     size_t key_len;
3239     struct list packets;
3240     enum dpif_upcall_type upcall_type;
3241 };
3242
3243 struct flow_miss_op {
3244     struct dpif_op dpif_op;
3245
3246     uint64_t slow_stub[128 / 8]; /* Buffer for compose_slow_path() */
3247     struct xlate_out xout;
3248     bool xout_garbage;           /* 'xout' needs to be uninitialized? */
3249
3250     struct ofpbuf mask;          /* Flow mask for "put" ops. */
3251     struct odputil_keybuf maskbuf;
3252
3253     /* If this is a "put" op, then a pointer to the subfacet that should
3254      * be marked as uninstalled if the operation fails. */
3255     struct subfacet *subfacet;
3256 };
3257
3258 /* Sends an OFPT_PACKET_IN message for 'packet' of type OFPR_NO_MATCH to each
3259  * OpenFlow controller as necessary according to their individual
3260  * configurations. */
3261 static void
3262 send_packet_in_miss(struct ofproto_dpif *ofproto, const struct ofpbuf *packet,
3263                     const struct flow *flow)
3264 {
3265     struct ofputil_packet_in pin;
3266
3267     pin.packet = packet->data;
3268     pin.packet_len = packet->size;
3269     pin.reason = OFPR_NO_MATCH;
3270     pin.controller_id = 0;
3271
3272     pin.table_id = 0;
3273     pin.cookie = 0;
3274
3275     pin.send_len = 0;           /* not used for flow table misses */
3276
3277     flow_get_metadata(flow, &pin.fmd);
3278
3279     connmgr_send_packet_in(ofproto->up.connmgr, &pin);
3280 }
3281
3282 static struct flow_miss *
3283 flow_miss_find(struct hmap *todo, const struct ofproto_dpif *ofproto,
3284                const struct flow *flow, uint32_t hash)
3285 {
3286     struct flow_miss *miss;
3287
3288     HMAP_FOR_EACH_WITH_HASH (miss, hmap_node, hash, todo) {
3289         if (miss->ofproto == ofproto && flow_equal(&miss->flow, flow)) {
3290             return miss;
3291         }
3292     }
3293
3294     return NULL;
3295 }
3296
3297 /* Partially Initializes 'op' as an "execute" operation for 'miss' and
3298  * 'packet'.  The caller must initialize op->actions and op->actions_len.  If
3299  * 'miss' is associated with a subfacet the caller must also initialize the
3300  * returned op->subfacet, and if anything needs to be freed after processing
3301  * the op, the caller must initialize op->garbage also. */
3302 static void
3303 init_flow_miss_execute_op(struct flow_miss *miss, struct ofpbuf *packet,
3304                           struct flow_miss_op *op)
3305 {
3306     if (miss->flow.in_port.ofp_port
3307         != vsp_realdev_to_vlandev(miss->ofproto, miss->flow.in_port.ofp_port,
3308                                   miss->flow.vlan_tci)) {
3309         /* This packet was received on a VLAN splinter port.  We
3310          * added a VLAN to the packet to make the packet resemble
3311          * the flow, but the actions were composed assuming that
3312          * the packet contained no VLAN.  So, we must remove the
3313          * VLAN header from the packet before trying to execute the
3314          * actions. */
3315         eth_pop_vlan(packet);
3316     }
3317
3318     op->subfacet = NULL;
3319     op->xout_garbage = false;
3320     op->dpif_op.type = DPIF_OP_EXECUTE;
3321     op->dpif_op.u.execute.key = miss->key;
3322     op->dpif_op.u.execute.key_len = miss->key_len;
3323     op->dpif_op.u.execute.packet = packet;
3324     ofpbuf_use_stack(&op->mask, &op->maskbuf, sizeof op->maskbuf);
3325 }
3326
3327 /* Helper for handle_flow_miss_without_facet() and
3328  * handle_flow_miss_with_facet(). */
3329 static void
3330 handle_flow_miss_common(struct rule_dpif *rule,
3331                         struct ofpbuf *packet, const struct flow *flow)
3332 {
3333     struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
3334
3335     if (rule->up.cr.priority == FAIL_OPEN_PRIORITY) {
3336         /*
3337          * Extra-special case for fail-open mode.
3338          *
3339          * We are in fail-open mode and the packet matched the fail-open
3340          * rule, but we are connected to a controller too.  We should send
3341          * the packet up to the controller in the hope that it will try to
3342          * set up a flow and thereby allow us to exit fail-open.
3343          *
3344          * See the top-level comment in fail-open.c for more information.
3345          */
3346         send_packet_in_miss(ofproto, packet, flow);
3347     }
3348 }
3349
3350 /* Figures out whether a flow that missed in 'ofproto', whose details are in
3351  * 'miss' masked by 'wc', is likely to be worth tracking in detail in userspace
3352  * and (usually) installing a datapath flow.  The answer is usually "yes" (a
3353  * return value of true).  However, for short flows the cost of bookkeeping is
3354  * much higher than the benefits, so when the datapath holds a large number of
3355  * flows we impose some heuristics to decide which flows are likely to be worth
3356  * tracking. */
3357 static bool
3358 flow_miss_should_make_facet(struct flow_miss *miss, struct flow_wildcards *wc)
3359 {
3360     struct dpif_backer *backer = miss->ofproto->backer;
3361     uint32_t hash;
3362
3363     if (!backer->governor) {
3364         size_t n_subfacets;
3365
3366         n_subfacets = hmap_count(&backer->subfacets);
3367         if (n_subfacets * 2 <= flow_eviction_threshold) {
3368             return true;
3369         }
3370
3371         backer->governor = governor_create();
3372     }
3373
3374     hash = flow_hash_in_wildcards(&miss->flow, wc, 0);
3375     return governor_should_install_flow(backer->governor, hash,
3376                                         list_size(&miss->packets));
3377 }
3378
3379 /* Handles 'miss' without creating a facet or subfacet or creating any datapath
3380  * flow.  'miss->flow' must have matched 'rule' and been xlated into 'xout'.
3381  * May add an "execute" operation to 'ops' and increment '*n_ops'. */
3382 static void
3383 handle_flow_miss_without_facet(struct rule_dpif *rule, struct xlate_out *xout,
3384                                struct flow_miss *miss,
3385                                struct flow_miss_op *ops, size_t *n_ops)
3386 {
3387     struct ofpbuf *packet;
3388
3389     LIST_FOR_EACH (packet, list_node, &miss->packets) {
3390
3391         COVERAGE_INC(facet_suppress);
3392
3393         handle_flow_miss_common(rule, packet, &miss->flow);
3394
3395         if (xout->slow) {
3396             struct xlate_in xin;
3397
3398             xlate_in_init(&xin, miss->ofproto, &miss->flow, rule, 0, packet);
3399             xlate_actions_for_side_effects(&xin);
3400         }
3401
3402         if (xout->odp_actions.size) {
3403             struct flow_miss_op *op = &ops[*n_ops];
3404             struct dpif_execute *execute = &op->dpif_op.u.execute;
3405
3406             init_flow_miss_execute_op(miss, packet, op);
3407             xlate_out_copy(&op->xout, xout);
3408             execute->actions = op->xout.odp_actions.data;
3409             execute->actions_len = op->xout.odp_actions.size;
3410             op->xout_garbage = true;
3411
3412             (*n_ops)++;
3413         }
3414     }
3415 }
3416
3417 /* Handles 'miss', which matches 'facet'.  May add any required datapath
3418  * operations to 'ops', incrementing '*n_ops' for each new op.
3419  *
3420  * All of the packets in 'miss' are considered to have arrived at time 'now'.
3421  * This is really important only for new facets: if we just called time_msec()
3422  * here, then the new subfacet or its packets could look (occasionally) as
3423  * though it was used some time after the facet was used.  That can make a
3424  * one-packet flow look like it has a nonzero duration, which looks odd in
3425  * e.g. NetFlow statistics.
3426  *
3427  * If non-null, 'stats' will be folded into 'facet'. */
3428 static void
3429 handle_flow_miss_with_facet(struct flow_miss *miss, struct facet *facet,
3430                             long long int now, struct dpif_flow_stats *stats,
3431                             struct flow_miss_op *ops, size_t *n_ops)
3432 {
3433     struct ofproto_dpif *ofproto = ofproto_dpif_cast(facet->rule->up.ofproto);
3434     enum subfacet_path want_path;
3435     struct subfacet *subfacet;
3436     struct ofpbuf *packet;
3437
3438     subfacet = subfacet_create(facet, miss, now);
3439     want_path = facet->xout.slow ? SF_SLOW_PATH : SF_FAST_PATH;
3440     if (stats) {
3441         subfacet_update_stats(subfacet, stats);
3442     }
3443
3444     LIST_FOR_EACH (packet, list_node, &miss->packets) {
3445         struct flow_miss_op *op = &ops[*n_ops];
3446
3447         handle_flow_miss_common(facet->rule, packet, &miss->flow);
3448
3449         if (want_path != SF_FAST_PATH) {
3450             struct xlate_in xin;
3451
3452             xlate_in_init(&xin, ofproto, &miss->flow, facet->rule, 0, packet);
3453             xlate_actions_for_side_effects(&xin);
3454         }
3455
3456         if (facet->xout.odp_actions.size) {
3457             struct dpif_execute *execute = &op->dpif_op.u.execute;
3458
3459             init_flow_miss_execute_op(miss, packet, op);
3460             execute->actions = facet->xout.odp_actions.data,
3461             execute->actions_len = facet->xout.odp_actions.size;
3462             (*n_ops)++;
3463         }
3464     }
3465
3466     if (miss->upcall_type == DPIF_UC_MISS || subfacet->path != want_path) {
3467         struct flow_miss_op *op = &ops[(*n_ops)++];
3468         struct dpif_flow_put *put = &op->dpif_op.u.flow_put;
3469
3470         subfacet->path = want_path;
3471
3472         ofpbuf_use_stack(&op->mask, &op->maskbuf, sizeof op->maskbuf);
3473         odp_flow_key_from_mask(&op->mask, &facet->xout.wc.masks,
3474                                &miss->flow, UINT32_MAX);
3475
3476         op->xout_garbage = false;
3477         op->dpif_op.type = DPIF_OP_FLOW_PUT;
3478         op->subfacet = subfacet;
3479         put->flags = DPIF_FP_CREATE | DPIF_FP_MODIFY;
3480         put->key = miss->key;
3481         put->key_len = miss->key_len;
3482         put->mask = op->mask.data;
3483         put->mask_len = op->mask.size;
3484
3485         if (want_path == SF_FAST_PATH) {
3486             put->actions = facet->xout.odp_actions.data;
3487             put->actions_len = facet->xout.odp_actions.size;
3488         } else {
3489             compose_slow_path(ofproto, &miss->flow, facet->xout.slow,
3490                               op->slow_stub, sizeof op->slow_stub,
3491                               &put->actions, &put->actions_len);
3492         }
3493         put->stats = NULL;
3494     }
3495 }
3496
3497 /* Handles flow miss 'miss'.  May add any required datapath operations
3498  * to 'ops', incrementing '*n_ops' for each new op. */
3499 static void
3500 handle_flow_miss(struct flow_miss *miss, struct flow_miss_op *ops,
3501                  size_t *n_ops)
3502 {
3503     struct ofproto_dpif *ofproto = miss->ofproto;
3504     struct dpif_flow_stats stats__;
3505     struct dpif_flow_stats *stats = &stats__;
3506     struct ofpbuf *packet;
3507     struct facet *facet;
3508     long long int now;
3509
3510     now = time_msec();
3511     memset(stats, 0, sizeof *stats);
3512     stats->used = now;
3513     LIST_FOR_EACH (packet, list_node, &miss->packets) {
3514         stats->tcp_flags |= packet_get_tcp_flags(packet, &miss->flow);
3515         stats->n_bytes += packet->size;
3516         stats->n_packets++;
3517     }
3518
3519     facet = facet_lookup_valid(ofproto, &miss->flow);
3520     if (!facet) {
3521         struct flow_wildcards wc;
3522         struct rule_dpif *rule;
3523         struct xlate_out xout;
3524         struct xlate_in xin;
3525
3526         flow_wildcards_init_catchall(&wc);
3527         rule = rule_dpif_lookup(ofproto, &miss->flow, &wc);
3528         rule_credit_stats(rule, stats);
3529
3530         xlate_in_init(&xin, ofproto, &miss->flow, rule, stats->tcp_flags,
3531                       NULL);
3532         xin.resubmit_stats = stats;
3533         xin.may_learn = true;
3534         xlate_actions(&xin, &xout);
3535         flow_wildcards_or(&xout.wc, &xout.wc, &wc);
3536
3537         /* There does not exist a bijection between 'struct flow' and datapath
3538          * flow keys with fitness ODP_FIT_TO_LITTLE.  This breaks a fundamental
3539          * assumption used throughout the facet and subfacet handling code.
3540          * Since we have to handle these misses in userspace anyway, we simply
3541          * skip facet creation, avoiding the problem altogether. */
3542         if (miss->key_fitness == ODP_FIT_TOO_LITTLE
3543             || !flow_miss_should_make_facet(miss, &xout.wc)) {
3544             handle_flow_miss_without_facet(rule, &xout, miss, ops, n_ops);
3545             return;
3546         }
3547
3548         facet = facet_create(miss, rule, &xout, stats);
3549         stats = NULL;
3550     }
3551     handle_flow_miss_with_facet(miss, facet, now, stats, ops, n_ops);
3552 }
3553
3554 static struct drop_key *
3555 drop_key_lookup(const struct dpif_backer *backer, const struct nlattr *key,
3556                 size_t key_len)
3557 {
3558     struct drop_key *drop_key;
3559
3560     HMAP_FOR_EACH_WITH_HASH (drop_key, hmap_node, hash_bytes(key, key_len, 0),
3561                              &backer->drop_keys) {
3562         if (drop_key->key_len == key_len
3563             && !memcmp(drop_key->key, key, key_len)) {
3564             return drop_key;
3565         }
3566     }
3567     return NULL;
3568 }
3569
3570 static void
3571 drop_key_clear(struct dpif_backer *backer)
3572 {
3573     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 15);
3574     struct drop_key *drop_key, *next;
3575
3576     HMAP_FOR_EACH_SAFE (drop_key, next, hmap_node, &backer->drop_keys) {
3577         int error;
3578
3579         error = dpif_flow_del(backer->dpif, drop_key->key, drop_key->key_len,
3580                               NULL);
3581         if (error && !VLOG_DROP_WARN(&rl)) {
3582             struct ds ds = DS_EMPTY_INITIALIZER;
3583             odp_flow_key_format(drop_key->key, drop_key->key_len, &ds);
3584             VLOG_WARN("Failed to delete drop key (%s) (%s)", strerror(error),
3585                       ds_cstr(&ds));
3586             ds_destroy(&ds);
3587         }
3588
3589         hmap_remove(&backer->drop_keys, &drop_key->hmap_node);
3590         free(drop_key->key);
3591         free(drop_key);
3592     }
3593 }
3594
3595 /* Given a datpath, packet, and flow metadata ('backer', 'packet', and 'key'
3596  * respectively), populates 'flow' with the result of odp_flow_key_to_flow().
3597  * Optionally, if nonnull, populates 'fitnessp' with the fitness of 'flow' as
3598  * returned by odp_flow_key_to_flow().  Also, optionally populates 'ofproto'
3599  * with the ofproto_dpif, and 'odp_in_port' with the datapath in_port, that
3600  * 'packet' ingressed.
3601  *
3602  * If 'ofproto' is nonnull, requires 'flow''s in_port to exist.  Otherwise sets
3603  * 'flow''s in_port to OFPP_NONE.
3604  *
3605  * This function does post-processing on data returned from
3606  * odp_flow_key_to_flow() to help make VLAN splinters transparent to the rest
3607  * of the upcall processing logic.  In particular, if the extracted in_port is
3608  * a VLAN splinter port, it replaces flow->in_port by the "real" port, sets
3609  * flow->vlan_tci correctly for the VLAN of the VLAN splinter port, and pushes
3610  * a VLAN header onto 'packet' (if it is nonnull).
3611  *
3612  * Similarly, this function also includes some logic to help with tunnels.  It
3613  * may modify 'flow' as necessary to make the tunneling implementation
3614  * transparent to the upcall processing logic.
3615  *
3616  * Returns 0 if successful, ENODEV if the parsed flow has no associated ofport,
3617  * or some other positive errno if there are other problems. */
3618 static int
3619 ofproto_receive(const struct dpif_backer *backer, struct ofpbuf *packet,
3620                 const struct nlattr *key, size_t key_len,
3621                 struct flow *flow, enum odp_key_fitness *fitnessp,
3622                 struct ofproto_dpif **ofproto, odp_port_t *odp_in_port)
3623 {
3624     const struct ofport_dpif *port;
3625     enum odp_key_fitness fitness;
3626     int error = ENODEV;
3627
3628     fitness = odp_flow_key_to_flow(key, key_len, flow);
3629     if (fitness == ODP_FIT_ERROR) {
3630         error = EINVAL;
3631         goto exit;
3632     }
3633
3634     if (odp_in_port) {
3635         *odp_in_port = flow->in_port.odp_port;
3636     }
3637
3638     port = (tnl_port_should_receive(flow)
3639             ? ofport_dpif_cast(tnl_port_receive(flow))
3640             : odp_port_to_ofport(backer, flow->in_port.odp_port));
3641     flow->in_port.ofp_port = port ? port->up.ofp_port : OFPP_NONE;
3642     if (!port) {
3643         goto exit;
3644     }
3645
3646     /* XXX: Since the tunnel module is not scoped per backer, for a tunnel port
3647      * it's theoretically possible that we'll receive an ofport belonging to an
3648      * entirely different datapath.  In practice, this can't happen because no
3649      * platforms has two separate datapaths which each support tunneling. */
3650     ovs_assert(ofproto_dpif_cast(port->up.ofproto)->backer == backer);
3651
3652     if (vsp_adjust_flow(ofproto_dpif_cast(port->up.ofproto), flow)) {
3653         if (packet) {
3654             /* Make the packet resemble the flow, so that it gets sent to
3655              * an OpenFlow controller properly, so that it looks correct
3656              * for sFlow, and so that flow_extract() will get the correct
3657              * vlan_tci if it is called on 'packet'.
3658              *
3659              * The allocated space inside 'packet' probably also contains
3660              * 'key', that is, both 'packet' and 'key' are probably part of
3661              * a struct dpif_upcall (see the large comment on that
3662              * structure definition), so pushing data on 'packet' is in
3663              * general not a good idea since it could overwrite 'key' or
3664              * free it as a side effect.  However, it's OK in this special
3665              * case because we know that 'packet' is inside a Netlink
3666              * attribute: pushing 4 bytes will just overwrite the 4-byte
3667              * "struct nlattr", which is fine since we don't need that
3668              * header anymore. */
3669             eth_push_vlan(packet, flow->vlan_tci);
3670         }
3671         /* We can't reproduce 'key' from 'flow'. */
3672         fitness = fitness == ODP_FIT_PERFECT ? ODP_FIT_TOO_MUCH : fitness;
3673     }
3674     error = 0;
3675
3676     if (ofproto) {
3677         *ofproto = ofproto_dpif_cast(port->up.ofproto);
3678     }
3679
3680 exit:
3681     if (fitnessp) {
3682         *fitnessp = fitness;
3683     }
3684     return error;
3685 }
3686
3687 static void
3688 handle_miss_upcalls(struct dpif_backer *backer, struct dpif_upcall *upcalls,
3689                     size_t n_upcalls)
3690 {
3691     struct dpif_upcall *upcall;
3692     struct flow_miss *miss;
3693     struct flow_miss misses[FLOW_MISS_MAX_BATCH];
3694     struct flow_miss_op flow_miss_ops[FLOW_MISS_MAX_BATCH * 2];
3695     struct dpif_op *dpif_ops[FLOW_MISS_MAX_BATCH * 2];
3696     struct hmap todo;
3697     int n_misses;
3698     size_t n_ops;
3699     size_t i;
3700
3701     if (!n_upcalls) {
3702         return;
3703     }
3704
3705     /* Construct the to-do list.
3706      *
3707      * This just amounts to extracting the flow from each packet and sticking
3708      * the packets that have the same flow in the same "flow_miss" structure so
3709      * that we can process them together. */
3710     hmap_init(&todo);
3711     n_misses = 0;
3712     for (upcall = upcalls; upcall < &upcalls[n_upcalls]; upcall++) {
3713         struct flow_miss *miss = &misses[n_misses];
3714         struct flow_miss *existing_miss;
3715         struct ofproto_dpif *ofproto;
3716         odp_port_t odp_in_port;
3717         struct flow flow;
3718         uint32_t hash;
3719         int error;
3720
3721         error = ofproto_receive(backer, upcall->packet, upcall->key,
3722                                 upcall->key_len, &flow, &miss->key_fitness,
3723                                 &ofproto, &odp_in_port);
3724         if (error == ENODEV) {
3725             struct drop_key *drop_key;
3726
3727             /* Received packet on datapath port for which we couldn't
3728              * associate an ofproto.  This can happen if a port is removed
3729              * while traffic is being received.  Print a rate-limited message
3730              * in case it happens frequently.  Install a drop flow so
3731              * that future packets of the flow are inexpensively dropped
3732              * in the kernel. */
3733             VLOG_INFO_RL(&rl, "received packet on unassociated datapath port "
3734                               "%"PRIu32, odp_in_port);
3735
3736             drop_key = drop_key_lookup(backer, upcall->key, upcall->key_len);
3737             if (!drop_key) {
3738                 drop_key = xmalloc(sizeof *drop_key);
3739                 drop_key->key = xmemdup(upcall->key, upcall->key_len);
3740                 drop_key->key_len = upcall->key_len;
3741
3742                 hmap_insert(&backer->drop_keys, &drop_key->hmap_node,
3743                             hash_bytes(drop_key->key, drop_key->key_len, 0));
3744                 dpif_flow_put(backer->dpif, DPIF_FP_CREATE | DPIF_FP_MODIFY,
3745                               drop_key->key, drop_key->key_len,
3746                               NULL, 0, NULL, 0, NULL);
3747             }
3748             continue;
3749         }
3750         if (error) {
3751             continue;
3752         }
3753
3754         ofproto->n_missed++;
3755         flow_extract(upcall->packet, flow.skb_priority, flow.skb_mark,
3756                      &flow.tunnel, &flow.in_port, &miss->flow);
3757
3758         /* Add other packets to a to-do list. */
3759         hash = flow_hash(&miss->flow, 0);
3760         existing_miss = flow_miss_find(&todo, ofproto, &miss->flow, hash);
3761         if (!existing_miss) {
3762             hmap_insert(&todo, &miss->hmap_node, hash);
3763             miss->ofproto = ofproto;
3764             miss->key = upcall->key;
3765             miss->key_len = upcall->key_len;
3766             miss->upcall_type = upcall->type;
3767             list_init(&miss->packets);
3768
3769             n_misses++;
3770         } else {
3771             miss = existing_miss;
3772         }
3773         list_push_back(&miss->packets, &upcall->packet->list_node);
3774     }
3775
3776     /* Process each element in the to-do list, constructing the set of
3777      * operations to batch. */
3778     n_ops = 0;
3779     HMAP_FOR_EACH (miss, hmap_node, &todo) {
3780         handle_flow_miss(miss, flow_miss_ops, &n_ops);
3781     }
3782     ovs_assert(n_ops <= ARRAY_SIZE(flow_miss_ops));
3783
3784     /* Execute batch. */
3785     for (i = 0; i < n_ops; i++) {
3786         dpif_ops[i] = &flow_miss_ops[i].dpif_op;
3787     }
3788     dpif_operate(backer->dpif, dpif_ops, n_ops);
3789
3790     for (i = 0; i < n_ops; i++) {
3791         if (dpif_ops[i]->error != 0
3792             && flow_miss_ops[i].dpif_op.type == DPIF_OP_FLOW_PUT
3793             && flow_miss_ops[i].subfacet) {
3794             struct subfacet *subfacet = flow_miss_ops[i].subfacet;
3795
3796             COVERAGE_INC(subfacet_install_fail);
3797
3798             subfacet->path = SF_NOT_INSTALLED;
3799         }
3800
3801         /* Free memory. */
3802         if (flow_miss_ops[i].xout_garbage) {
3803             xlate_out_uninit(&flow_miss_ops[i].xout);
3804         }
3805     }
3806     hmap_destroy(&todo);
3807 }
3808
3809 static enum { SFLOW_UPCALL, MISS_UPCALL, BAD_UPCALL, FLOW_SAMPLE_UPCALL,
3810               IPFIX_UPCALL }
3811 classify_upcall(const struct dpif_upcall *upcall)
3812 {
3813     size_t userdata_len;
3814     union user_action_cookie cookie;
3815
3816     /* First look at the upcall type. */
3817     switch (upcall->type) {
3818     case DPIF_UC_ACTION:
3819         break;
3820
3821     case DPIF_UC_MISS:
3822         return MISS_UPCALL;
3823
3824     case DPIF_N_UC_TYPES:
3825     default:
3826         VLOG_WARN_RL(&rl, "upcall has unexpected type %"PRIu32, upcall->type);
3827         return BAD_UPCALL;
3828     }
3829
3830     /* "action" upcalls need a closer look. */
3831     if (!upcall->userdata) {
3832         VLOG_WARN_RL(&rl, "action upcall missing cookie");
3833         return BAD_UPCALL;
3834     }
3835     userdata_len = nl_attr_get_size(upcall->userdata);
3836     if (userdata_len < sizeof cookie.type
3837         || userdata_len > sizeof cookie) {
3838         VLOG_WARN_RL(&rl, "action upcall cookie has unexpected size %zu",
3839                      userdata_len);
3840         return BAD_UPCALL;
3841     }
3842     memset(&cookie, 0, sizeof cookie);
3843     memcpy(&cookie, nl_attr_get(upcall->userdata), userdata_len);
3844     if (userdata_len == sizeof cookie.sflow
3845         && cookie.type == USER_ACTION_COOKIE_SFLOW) {
3846         return SFLOW_UPCALL;
3847     } else if (userdata_len == sizeof cookie.slow_path
3848                && cookie.type == USER_ACTION_COOKIE_SLOW_PATH) {
3849         return MISS_UPCALL;
3850     } else if (userdata_len == sizeof cookie.flow_sample
3851                && cookie.type == USER_ACTION_COOKIE_FLOW_SAMPLE) {
3852         return FLOW_SAMPLE_UPCALL;
3853     } else if (userdata_len == sizeof cookie.ipfix
3854                && cookie.type == USER_ACTION_COOKIE_IPFIX) {
3855         return IPFIX_UPCALL;
3856     } else {
3857         VLOG_WARN_RL(&rl, "invalid user cookie of type %"PRIu16
3858                      " and size %zu", cookie.type, userdata_len);
3859         return BAD_UPCALL;
3860     }
3861 }
3862
3863 static void
3864 handle_sflow_upcall(struct dpif_backer *backer,
3865                     const struct dpif_upcall *upcall)
3866 {
3867     struct ofproto_dpif *ofproto;
3868     union user_action_cookie cookie;
3869     struct flow flow;
3870     odp_port_t odp_in_port;
3871
3872     if (ofproto_receive(backer, upcall->packet, upcall->key, upcall->key_len,
3873                         &flow, NULL, &ofproto, &odp_in_port)
3874         || !ofproto->sflow) {
3875         return;
3876     }
3877
3878     memset(&cookie, 0, sizeof cookie);
3879     memcpy(&cookie, nl_attr_get(upcall->userdata), sizeof cookie.sflow);
3880     dpif_sflow_received(ofproto->sflow, upcall->packet, &flow,
3881                         odp_in_port, &cookie);
3882 }
3883
3884 static void
3885 handle_flow_sample_upcall(struct dpif_backer *backer,
3886                           const struct dpif_upcall *upcall)
3887 {
3888     struct ofproto_dpif *ofproto;
3889     union user_action_cookie cookie;
3890     struct flow flow;
3891
3892     if (ofproto_receive(backer, upcall->packet, upcall->key, upcall->key_len,
3893                         &flow, NULL, &ofproto, NULL)
3894         || !ofproto->ipfix) {
3895         return;
3896     }
3897
3898     memset(&cookie, 0, sizeof cookie);
3899     memcpy(&cookie, nl_attr_get(upcall->userdata), sizeof cookie.flow_sample);
3900
3901     /* The flow reflects exactly the contents of the packet.  Sample
3902      * the packet using it. */
3903     dpif_ipfix_flow_sample(ofproto->ipfix, upcall->packet, &flow,
3904                            cookie.flow_sample.collector_set_id,
3905                            cookie.flow_sample.probability,
3906                            cookie.flow_sample.obs_domain_id,
3907                            cookie.flow_sample.obs_point_id);
3908 }
3909
3910 static void
3911 handle_ipfix_upcall(struct dpif_backer *backer,
3912                     const struct dpif_upcall *upcall)
3913 {
3914     struct ofproto_dpif *ofproto;
3915     struct flow flow;
3916
3917     if (ofproto_receive(backer, upcall->packet, upcall->key, upcall->key_len,
3918                         &flow, NULL, &ofproto, NULL)
3919         || !ofproto->ipfix) {
3920         return;
3921     }
3922
3923     /* The flow reflects exactly the contents of the packet.  Sample
3924      * the packet using it. */
3925     dpif_ipfix_bridge_sample(ofproto->ipfix, upcall->packet, &flow);
3926 }
3927
3928 static int
3929 handle_upcalls(struct dpif_backer *backer, unsigned int max_batch)
3930 {
3931     struct dpif_upcall misses[FLOW_MISS_MAX_BATCH];
3932     struct ofpbuf miss_bufs[FLOW_MISS_MAX_BATCH];
3933     uint64_t miss_buf_stubs[FLOW_MISS_MAX_BATCH][4096 / 8];
3934     int n_processed;
3935     int n_misses;
3936     int i;
3937
3938     ovs_assert(max_batch <= FLOW_MISS_MAX_BATCH);
3939
3940     n_misses = 0;
3941     for (n_processed = 0; n_processed < max_batch; n_processed++) {
3942         struct dpif_upcall *upcall = &misses[n_misses];
3943         struct ofpbuf *buf = &miss_bufs[n_misses];
3944         int error;
3945
3946         ofpbuf_use_stub(buf, miss_buf_stubs[n_misses],
3947                         sizeof miss_buf_stubs[n_misses]);
3948         error = dpif_recv(backer->dpif, upcall, buf);
3949         if (error) {
3950             ofpbuf_uninit(buf);
3951             break;
3952         }
3953
3954         switch (classify_upcall(upcall)) {
3955         case MISS_UPCALL:
3956             /* Handle it later. */
3957             n_misses++;
3958             break;
3959
3960         case SFLOW_UPCALL:
3961             handle_sflow_upcall(backer, upcall);
3962             ofpbuf_uninit(buf);
3963             break;
3964
3965         case FLOW_SAMPLE_UPCALL:
3966             handle_flow_sample_upcall(backer, upcall);
3967             ofpbuf_uninit(buf);
3968             break;
3969
3970         case IPFIX_UPCALL:
3971             handle_ipfix_upcall(backer, upcall);
3972             ofpbuf_uninit(buf);
3973             break;
3974
3975         case BAD_UPCALL:
3976             ofpbuf_uninit(buf);
3977             break;
3978         }
3979     }
3980
3981     /* Handle deferred MISS_UPCALL processing. */
3982     handle_miss_upcalls(backer, misses, n_misses);
3983     for (i = 0; i < n_misses; i++) {
3984         ofpbuf_uninit(&miss_bufs[i]);
3985     }
3986
3987     return n_processed;
3988 }
3989 \f
3990 /* Flow expiration. */
3991
3992 static int subfacet_max_idle(const struct dpif_backer *);
3993 static void update_stats(struct dpif_backer *);
3994 static void rule_expire(struct rule_dpif *);
3995 static void expire_subfacets(struct dpif_backer *, int dp_max_idle);
3996
3997 /* This function is called periodically by run().  Its job is to collect
3998  * updates for the flows that have been installed into the datapath, most
3999  * importantly when they last were used, and then use that information to
4000  * expire flows that have not been used recently.
4001  *
4002  * Returns the number of milliseconds after which it should be called again. */
4003 static int
4004 expire(struct dpif_backer *backer)
4005 {
4006     struct ofproto_dpif *ofproto;
4007     size_t n_subfacets;
4008     int max_idle;
4009
4010     /* Periodically clear out the drop keys in an effort to keep them
4011      * relatively few. */
4012     drop_key_clear(backer);
4013
4014     /* Update stats for each flow in the backer. */
4015     update_stats(backer);
4016
4017     n_subfacets = hmap_count(&backer->subfacets);
4018     if (n_subfacets) {
4019         struct subfacet *subfacet;
4020         long long int total, now;
4021
4022         total = 0;
4023         now = time_msec();
4024         HMAP_FOR_EACH (subfacet, hmap_node, &backer->subfacets) {
4025             total += now - subfacet->created;
4026         }
4027         backer->avg_subfacet_life += total / n_subfacets;
4028     }
4029     backer->avg_subfacet_life /= 2;
4030
4031     backer->avg_n_subfacet += n_subfacets;
4032     backer->avg_n_subfacet /= 2;
4033
4034     backer->max_n_subfacet = MAX(backer->max_n_subfacet, n_subfacets);
4035
4036     max_idle = subfacet_max_idle(backer);
4037     expire_subfacets(backer, max_idle);
4038
4039     HMAP_FOR_EACH (ofproto, all_ofproto_dpifs_node, &all_ofproto_dpifs) {
4040         struct rule *rule, *next_rule;
4041
4042         if (ofproto->backer != backer) {
4043             continue;
4044         }
4045
4046         /* Expire OpenFlow flows whose idle_timeout or hard_timeout
4047          * has passed. */
4048         LIST_FOR_EACH_SAFE (rule, next_rule, expirable,
4049                             &ofproto->up.expirable) {
4050             rule_expire(rule_dpif_cast(rule));
4051         }
4052
4053         /* All outstanding data in existing flows has been accounted, so it's a
4054          * good time to do bond rebalancing. */
4055         if (ofproto->has_bonded_bundles) {
4056             struct ofbundle *bundle;
4057
4058             HMAP_FOR_EACH (bundle, hmap_node, &ofproto->bundles) {
4059                 if (bundle->bond) {
4060                     bond_rebalance(bundle->bond, &backer->revalidate_set);
4061                 }
4062             }
4063         }
4064     }
4065
4066     return MIN(max_idle, 1000);
4067 }
4068
4069 /* Updates flow table statistics given that the datapath just reported 'stats'
4070  * as 'subfacet''s statistics. */
4071 static void
4072 update_subfacet_stats(struct subfacet *subfacet,
4073                       const struct dpif_flow_stats *stats)
4074 {
4075     struct facet *facet = subfacet->facet;
4076     struct ofproto_dpif *ofproto = ofproto_dpif_cast(facet->rule->up.ofproto);
4077     struct dpif_flow_stats diff;
4078
4079     diff.tcp_flags = stats->tcp_flags;
4080     diff.used = stats->used;
4081
4082     if (stats->n_packets >= subfacet->dp_packet_count) {
4083         diff.n_packets = stats->n_packets - subfacet->dp_packet_count;
4084     } else {
4085         VLOG_WARN_RL(&rl, "unexpected packet count from the datapath");
4086         diff.n_packets = 0;
4087     }
4088
4089     if (stats->n_bytes >= subfacet->dp_byte_count) {
4090         diff.n_bytes = stats->n_bytes - subfacet->dp_byte_count;
4091     } else {
4092         VLOG_WARN_RL(&rl, "unexpected byte count from datapath");
4093         diff.n_bytes = 0;
4094     }
4095
4096     ofproto->n_hit += diff.n_packets;
4097     subfacet->dp_packet_count = stats->n_packets;
4098     subfacet->dp_byte_count = stats->n_bytes;
4099     subfacet_update_stats(subfacet, &diff);
4100
4101     if (facet->accounted_bytes < facet->byte_count) {
4102         facet_learn(facet);
4103         facet_account(facet);
4104         facet->accounted_bytes = facet->byte_count;
4105     }
4106 }
4107
4108 /* 'key' with length 'key_len' bytes is a flow in 'dpif' that we know nothing
4109  * about, or a flow that shouldn't be installed but was anyway.  Delete it. */
4110 static void
4111 delete_unexpected_flow(struct dpif_backer *backer,
4112                        const struct nlattr *key, size_t key_len)
4113 {
4114     if (!VLOG_DROP_WARN(&rl)) {
4115         struct ds s;
4116
4117         ds_init(&s);
4118         odp_flow_key_format(key, key_len, &s);
4119         VLOG_WARN("unexpected flow: %s", ds_cstr(&s));
4120         ds_destroy(&s);
4121     }
4122
4123     COVERAGE_INC(facet_unexpected);
4124     dpif_flow_del(backer->dpif, key, key_len, NULL);
4125 }
4126
4127 /* Update 'packet_count', 'byte_count', and 'used' members of installed facets.
4128  *
4129  * This function also pushes statistics updates to rules which each facet
4130  * resubmits into.  Generally these statistics will be accurate.  However, if a
4131  * facet changes the rule it resubmits into at some time in between
4132  * update_stats() runs, it is possible that statistics accrued to the
4133  * old rule will be incorrectly attributed to the new rule.  This could be
4134  * avoided by calling update_stats() whenever rules are created or
4135  * deleted.  However, the performance impact of making so many calls to the
4136  * datapath do not justify the benefit of having perfectly accurate statistics.
4137  *
4138  * In addition, this function maintains per ofproto flow hit counts. The patch
4139  * port is not treated specially. e.g. A packet ingress from br0 patched into
4140  * br1 will increase the hit count of br0 by 1, however, does not affect
4141  * the hit or miss counts of br1.
4142  */
4143 static void
4144 update_stats(struct dpif_backer *backer)
4145 {
4146     const struct dpif_flow_stats *stats;
4147     struct dpif_flow_dump dump;
4148     const struct nlattr *key, *mask;
4149     size_t key_len, mask_len;
4150
4151     dpif_flow_dump_start(&dump, backer->dpif);
4152     while (dpif_flow_dump_next(&dump, &key, &key_len,
4153                                &mask, &mask_len, NULL, NULL, &stats)) {
4154         struct subfacet *subfacet;
4155         uint32_t key_hash;
4156
4157         key_hash = odp_flow_key_hash(key, key_len);
4158         subfacet = subfacet_find(backer, key, key_len, key_hash);
4159         switch (subfacet ? subfacet->path : SF_NOT_INSTALLED) {
4160         case SF_FAST_PATH:
4161             update_subfacet_stats(subfacet, stats);
4162             break;
4163
4164         case SF_SLOW_PATH:
4165             /* Stats are updated per-packet. */
4166             break;
4167
4168         case SF_NOT_INSTALLED:
4169         default:
4170             delete_unexpected_flow(backer, key, key_len);
4171             break;
4172         }
4173         run_fast_rl();
4174     }
4175     dpif_flow_dump_done(&dump);
4176
4177     update_moving_averages(backer);
4178 }
4179
4180 /* Calculates and returns the number of milliseconds of idle time after which
4181  * subfacets should expire from the datapath.  When a subfacet expires, we fold
4182  * its statistics into its facet, and when a facet's last subfacet expires, we
4183  * fold its statistic into its rule. */
4184 static int
4185 subfacet_max_idle(const struct dpif_backer *backer)
4186 {
4187     /*
4188      * Idle time histogram.
4189      *
4190      * Most of the time a switch has a relatively small number of subfacets.
4191      * When this is the case we might as well keep statistics for all of them
4192      * in userspace and to cache them in the kernel datapath for performance as
4193      * well.
4194      *
4195      * As the number of subfacets increases, the memory required to maintain
4196      * statistics about them in userspace and in the kernel becomes
4197      * significant.  However, with a large number of subfacets it is likely
4198      * that only a few of them are "heavy hitters" that consume a large amount
4199      * of bandwidth.  At this point, only heavy hitters are worth caching in
4200      * the kernel and maintaining in userspaces; other subfacets we can
4201      * discard.
4202      *
4203      * The technique used to compute the idle time is to build a histogram with
4204      * N_BUCKETS buckets whose width is BUCKET_WIDTH msecs each.  Each subfacet
4205      * that is installed in the kernel gets dropped in the appropriate bucket.
4206      * After the histogram has been built, we compute the cutoff so that only
4207      * the most-recently-used 1% of subfacets (but at least
4208      * flow_eviction_threshold flows) are kept cached.  At least
4209      * the most-recently-used bucket of subfacets is kept, so actually an
4210      * arbitrary number of subfacets can be kept in any given expiration run
4211      * (though the next run will delete most of those unless they receive
4212      * additional data).
4213      *
4214      * This requires a second pass through the subfacets, in addition to the
4215      * pass made by update_stats(), because the former function never looks at
4216      * uninstallable subfacets.
4217      */
4218     enum { BUCKET_WIDTH = ROUND_UP(100, TIME_UPDATE_INTERVAL) };
4219     enum { N_BUCKETS = 5000 / BUCKET_WIDTH };
4220     int buckets[N_BUCKETS] = { 0 };
4221     int total, subtotal, bucket;
4222     struct subfacet *subfacet;
4223     long long int now;
4224     int i;
4225
4226     total = hmap_count(&backer->subfacets);
4227     if (total <= flow_eviction_threshold) {
4228         return N_BUCKETS * BUCKET_WIDTH;
4229     }
4230
4231     /* Build histogram. */
4232     now = time_msec();
4233     HMAP_FOR_EACH (subfacet, hmap_node, &backer->subfacets) {
4234         long long int idle = now - subfacet->used;
4235         int bucket = (idle <= 0 ? 0
4236                       : idle >= BUCKET_WIDTH * N_BUCKETS ? N_BUCKETS - 1
4237                       : (unsigned int) idle / BUCKET_WIDTH);
4238         buckets[bucket]++;
4239     }
4240
4241     /* Find the first bucket whose flows should be expired. */
4242     subtotal = bucket = 0;
4243     do {
4244         subtotal += buckets[bucket++];
4245     } while (bucket < N_BUCKETS &&
4246              subtotal < MAX(flow_eviction_threshold, total / 100));
4247
4248     if (VLOG_IS_DBG_ENABLED()) {
4249         struct ds s;
4250
4251         ds_init(&s);
4252         ds_put_cstr(&s, "keep");
4253         for (i = 0; i < N_BUCKETS; i++) {
4254             if (i == bucket) {
4255                 ds_put_cstr(&s, ", drop");
4256             }
4257             if (buckets[i]) {
4258                 ds_put_format(&s, " %d:%d", i * BUCKET_WIDTH, buckets[i]);
4259             }
4260         }
4261         VLOG_INFO("%s (msec:count)", ds_cstr(&s));
4262         ds_destroy(&s);
4263     }
4264
4265     return bucket * BUCKET_WIDTH;
4266 }
4267
4268 static void
4269 expire_subfacets(struct dpif_backer *backer, int dp_max_idle)
4270 {
4271     /* Cutoff time for most flows. */
4272     long long int normal_cutoff = time_msec() - dp_max_idle;
4273
4274     /* We really want to keep flows for special protocols around, so use a more
4275      * conservative cutoff. */
4276     long long int special_cutoff = time_msec() - 10000;
4277
4278     struct subfacet *subfacet, *next_subfacet;
4279     struct subfacet *batch[SUBFACET_DESTROY_MAX_BATCH];
4280     int n_batch;
4281
4282     n_batch = 0;
4283     HMAP_FOR_EACH_SAFE (subfacet, next_subfacet, hmap_node,
4284                         &backer->subfacets) {
4285         long long int cutoff;
4286
4287         cutoff = (subfacet->facet->xout.slow & (SLOW_CFM | SLOW_BFD | SLOW_LACP
4288                                                 | SLOW_STP)
4289                   ? special_cutoff
4290                   : normal_cutoff);
4291         if (subfacet->used < cutoff) {
4292             if (subfacet->path != SF_NOT_INSTALLED) {
4293                 batch[n_batch++] = subfacet;
4294                 if (n_batch >= SUBFACET_DESTROY_MAX_BATCH) {
4295                     subfacet_destroy_batch(backer, batch, n_batch);
4296                     n_batch = 0;
4297                 }
4298             } else {
4299                 subfacet_destroy(subfacet);
4300             }
4301         }
4302     }
4303
4304     if (n_batch > 0) {
4305         subfacet_destroy_batch(backer, batch, n_batch);
4306     }
4307 }
4308
4309 /* If 'rule' is an OpenFlow rule, that has expired according to OpenFlow rules,
4310  * then delete it entirely. */
4311 static void
4312 rule_expire(struct rule_dpif *rule)
4313 {
4314     struct facet *facet, *next_facet;
4315     long long int now;
4316     uint8_t reason;
4317
4318     if (rule->up.pending) {
4319         /* We'll have to expire it later. */
4320         return;
4321     }
4322
4323     /* Has 'rule' expired? */
4324     now = time_msec();
4325     if (rule->up.hard_timeout
4326         && now > rule->up.modified + rule->up.hard_timeout * 1000) {
4327         reason = OFPRR_HARD_TIMEOUT;
4328     } else if (rule->up.idle_timeout
4329                && now > rule->up.used + rule->up.idle_timeout * 1000) {
4330         reason = OFPRR_IDLE_TIMEOUT;
4331     } else {
4332         return;
4333     }
4334
4335     COVERAGE_INC(ofproto_dpif_expired);
4336
4337     /* Update stats.  (This is a no-op if the rule expired due to an idle
4338      * timeout, because that only happens when the rule has no facets left.) */
4339     LIST_FOR_EACH_SAFE (facet, next_facet, list_node, &rule->facets) {
4340         facet_remove(facet);
4341     }
4342
4343     /* Get rid of the rule. */
4344     ofproto_rule_expire(&rule->up, reason);
4345 }
4346 \f
4347 /* Facets. */
4348
4349 /* Creates and returns a new facet based on 'miss'.
4350  *
4351  * The caller must already have determined that no facet with an identical
4352  * 'miss->flow' exists in 'miss->ofproto'.
4353  *
4354  * 'rule' and 'xout' must have been created based on 'miss'.
4355  *
4356  * 'facet'' statistics are initialized based on 'stats'.
4357  *
4358  * The facet will initially have no subfacets.  The caller should create (at
4359  * least) one subfacet with subfacet_create(). */
4360 static struct facet *
4361 facet_create(const struct flow_miss *miss, struct rule_dpif *rule,
4362              struct xlate_out *xout, struct dpif_flow_stats *stats)
4363 {
4364     struct ofproto_dpif *ofproto = miss->ofproto;
4365     struct facet *facet;
4366     struct match match;
4367
4368     facet = xzalloc(sizeof *facet);
4369     facet->packet_count = facet->prev_packet_count = stats->n_packets;
4370     facet->byte_count = facet->prev_byte_count = stats->n_bytes;
4371     facet->tcp_flags = stats->tcp_flags;
4372     facet->used = stats->used;
4373     facet->flow = miss->flow;
4374     facet->learn_rl = time_msec() + 500;
4375     facet->rule = rule;
4376
4377     list_push_back(&facet->rule->facets, &facet->list_node);
4378     list_init(&facet->subfacets);
4379     netflow_flow_init(&facet->nf_flow);
4380     netflow_flow_update_time(ofproto->netflow, &facet->nf_flow, facet->used);
4381
4382     xlate_out_copy(&facet->xout, xout);
4383
4384     match_init(&match, &facet->flow, &facet->xout.wc);
4385     cls_rule_init(&facet->cr, &match, OFP_DEFAULT_PRIORITY);
4386     classifier_insert(&ofproto->facets, &facet->cr);
4387
4388     facet->nf_flow.output_iface = facet->xout.nf_output_iface;
4389
4390     return facet;
4391 }
4392
4393 static void
4394 facet_free(struct facet *facet)
4395 {
4396     if (facet) {
4397         xlate_out_uninit(&facet->xout);
4398         free(facet);
4399     }
4400 }
4401
4402 /* Executes, within 'ofproto', the 'n_actions' actions in 'actions' on
4403  * 'packet', which arrived on 'in_port'. */
4404 static bool
4405 execute_odp_actions(struct ofproto_dpif *ofproto, const struct flow *flow,
4406                     const struct nlattr *odp_actions, size_t actions_len,
4407                     struct ofpbuf *packet)
4408 {
4409     struct odputil_keybuf keybuf;
4410     struct ofpbuf key;
4411     int error;
4412
4413     ofpbuf_use_stack(&key, &keybuf, sizeof keybuf);
4414     odp_flow_key_from_flow(&key, flow,
4415                            ofp_port_to_odp_port(ofproto, flow->in_port.ofp_port));
4416
4417     error = dpif_execute(ofproto->backer->dpif, key.data, key.size,
4418                          odp_actions, actions_len, packet);
4419     return !error;
4420 }
4421
4422 /* Remove 'facet' from its ofproto and free up the associated memory:
4423  *
4424  *   - If 'facet' was installed in the datapath, uninstalls it and updates its
4425  *     rule's statistics, via subfacet_uninstall().
4426  *
4427  *   - Removes 'facet' from its rule and from ofproto->facets.
4428  */
4429 static void
4430 facet_remove(struct facet *facet)
4431 {
4432     struct ofproto_dpif *ofproto = ofproto_dpif_cast(facet->rule->up.ofproto);
4433     struct subfacet *subfacet, *next_subfacet;
4434
4435     ovs_assert(!list_is_empty(&facet->subfacets));
4436
4437     /* First uninstall all of the subfacets to get final statistics. */
4438     LIST_FOR_EACH (subfacet, list_node, &facet->subfacets) {
4439         subfacet_uninstall(subfacet);
4440     }
4441
4442     /* Flush the final stats to the rule.
4443      *
4444      * This might require us to have at least one subfacet around so that we
4445      * can use its actions for accounting in facet_account(), which is why we
4446      * have uninstalled but not yet destroyed the subfacets. */
4447     facet_flush_stats(facet);
4448
4449     /* Now we're really all done so destroy everything. */
4450     LIST_FOR_EACH_SAFE (subfacet, next_subfacet, list_node,
4451                         &facet->subfacets) {
4452         subfacet_destroy__(subfacet);
4453     }
4454     classifier_remove(&ofproto->facets, &facet->cr);
4455     cls_rule_destroy(&facet->cr);
4456     list_remove(&facet->list_node);
4457     facet_free(facet);
4458 }
4459
4460 /* Feed information from 'facet' back into the learning table to keep it in
4461  * sync with what is actually flowing through the datapath. */
4462 static void
4463 facet_learn(struct facet *facet)
4464 {
4465     long long int now = time_msec();
4466
4467     if (!facet->xout.has_fin_timeout && now < facet->learn_rl) {
4468         return;
4469     }
4470
4471     facet->learn_rl = now + 500;
4472
4473     if (!facet->xout.has_learn
4474         && !facet->xout.has_normal
4475         && (!facet->xout.has_fin_timeout
4476             || !(facet->tcp_flags & (TCP_FIN | TCP_RST)))) {
4477         return;
4478     }
4479
4480     facet_push_stats(facet, true);
4481 }
4482
4483 static void
4484 facet_account(struct facet *facet)
4485 {
4486     struct ofproto_dpif *ofproto = ofproto_dpif_cast(facet->rule->up.ofproto);
4487     const struct nlattr *a;
4488     unsigned int left;
4489     ovs_be16 vlan_tci;
4490     uint64_t n_bytes;
4491
4492     if (!facet->xout.has_normal || !ofproto->has_bonded_bundles) {
4493         return;
4494     }
4495     n_bytes = facet->byte_count - facet->accounted_bytes;
4496
4497     /* This loop feeds byte counters to bond_account() for rebalancing to use
4498      * as a basis.  We also need to track the actual VLAN on which the packet
4499      * is going to be sent to ensure that it matches the one passed to
4500      * bond_choose_output_slave().  (Otherwise, we will account to the wrong
4501      * hash bucket.)
4502      *
4503      * We use the actions from an arbitrary subfacet because they should all
4504      * be equally valid for our purpose. */
4505     vlan_tci = facet->flow.vlan_tci;
4506     NL_ATTR_FOR_EACH_UNSAFE (a, left, facet->xout.odp_actions.data,
4507                              facet->xout.odp_actions.size) {
4508         const struct ovs_action_push_vlan *vlan;
4509         struct ofport_dpif *port;
4510
4511         switch (nl_attr_type(a)) {
4512         case OVS_ACTION_ATTR_OUTPUT:
4513             port = get_odp_port(ofproto, nl_attr_get_odp_port(a));
4514             if (port && port->bundle && port->bundle->bond) {
4515                 bond_account(port->bundle->bond, &facet->flow,
4516                              vlan_tci_to_vid(vlan_tci), n_bytes);
4517             }
4518             break;
4519
4520         case OVS_ACTION_ATTR_POP_VLAN:
4521             vlan_tci = htons(0);
4522             break;
4523
4524         case OVS_ACTION_ATTR_PUSH_VLAN:
4525             vlan = nl_attr_get(a);
4526             vlan_tci = vlan->vlan_tci;
4527             break;
4528         }
4529     }
4530 }
4531
4532 /* Returns true if the only action for 'facet' is to send to the controller.
4533  * (We don't report NetFlow expiration messages for such facets because they
4534  * are just part of the control logic for the network, not real traffic). */
4535 static bool
4536 facet_is_controller_flow(struct facet *facet)
4537 {
4538     if (facet) {
4539         const struct rule *rule = &facet->rule->up;
4540         const struct ofpact *ofpacts = rule->ofpacts;
4541         size_t ofpacts_len = rule->ofpacts_len;
4542
4543         if (ofpacts_len > 0 &&
4544             ofpacts->type == OFPACT_CONTROLLER &&
4545             ofpact_next(ofpacts) >= ofpact_end(ofpacts, ofpacts_len)) {
4546             return true;
4547         }
4548     }
4549     return false;
4550 }
4551
4552 /* Folds all of 'facet''s statistics into its rule.  Also updates the
4553  * accounting ofhook and emits a NetFlow expiration if appropriate.  All of
4554  * 'facet''s statistics in the datapath should have been zeroed and folded into
4555  * its packet and byte counts before this function is called. */
4556 static void
4557 facet_flush_stats(struct facet *facet)
4558 {
4559     struct ofproto_dpif *ofproto = ofproto_dpif_cast(facet->rule->up.ofproto);
4560     struct subfacet *subfacet;
4561
4562     LIST_FOR_EACH (subfacet, list_node, &facet->subfacets) {
4563         ovs_assert(!subfacet->dp_byte_count);
4564         ovs_assert(!subfacet->dp_packet_count);
4565     }
4566
4567     facet_push_stats(facet, false);
4568     if (facet->accounted_bytes < facet->byte_count) {
4569         facet_account(facet);
4570         facet->accounted_bytes = facet->byte_count;
4571     }
4572
4573     if (ofproto->netflow && !facet_is_controller_flow(facet)) {
4574         struct ofexpired expired;
4575         expired.flow = facet->flow;
4576         expired.packet_count = facet->packet_count;
4577         expired.byte_count = facet->byte_count;
4578         expired.used = facet->used;
4579         netflow_expire(ofproto->netflow, &facet->nf_flow, &expired);
4580     }
4581
4582     /* Reset counters to prevent double counting if 'facet' ever gets
4583      * reinstalled. */
4584     facet_reset_counters(facet);
4585
4586     netflow_flow_clear(&facet->nf_flow);
4587     facet->tcp_flags = 0;
4588 }
4589
4590 /* Searches 'ofproto''s table of facets for one which would be responsible for
4591  * 'flow'.  Returns it if found, otherwise a null pointer.
4592  *
4593  * The returned facet might need revalidation; use facet_lookup_valid()
4594  * instead if that is important. */
4595 static struct facet *
4596 facet_find(struct ofproto_dpif *ofproto, const struct flow *flow)
4597 {
4598     struct cls_rule *cr = classifier_lookup(&ofproto->facets, flow, NULL);
4599     return cr ? CONTAINER_OF(cr, struct facet, cr) : NULL;
4600 }
4601
4602 /* Searches 'ofproto''s table of facets for one capable that covers
4603  * 'flow'.  Returns it if found, otherwise a null pointer.
4604  *
4605  * The returned facet is guaranteed to be valid. */
4606 static struct facet *
4607 facet_lookup_valid(struct ofproto_dpif *ofproto, const struct flow *flow)
4608 {
4609     struct facet *facet;
4610
4611     facet = facet_find(ofproto, flow);
4612     if (facet
4613         && (ofproto->backer->need_revalidate
4614             || tag_set_intersects(&ofproto->backer->revalidate_set,
4615                                   facet->xout.tags))
4616         && !facet_revalidate(facet)) {
4617         return NULL;
4618     }
4619
4620     return facet;
4621 }
4622
4623 static bool
4624 facet_check_consistency(struct facet *facet)
4625 {
4626     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 15);
4627
4628     struct ofproto_dpif *ofproto = ofproto_dpif_cast(facet->rule->up.ofproto);
4629
4630     struct xlate_out xout;
4631     struct xlate_in xin;
4632
4633     struct rule_dpif *rule;
4634     bool ok;
4635
4636     /* Check the rule for consistency. */
4637     rule = rule_dpif_lookup(ofproto, &facet->flow, NULL);
4638     if (rule != facet->rule) {
4639         if (!VLOG_DROP_WARN(&rl)) {
4640             struct ds s = DS_EMPTY_INITIALIZER;
4641
4642             flow_format(&s, &facet->flow);
4643             ds_put_format(&s, ": facet associated with wrong rule (was "
4644                           "table=%"PRIu8",", facet->rule->up.table_id);
4645             cls_rule_format(&facet->rule->up.cr, &s);
4646             ds_put_format(&s, ") (should have been table=%"PRIu8",",
4647                           rule->up.table_id);
4648             cls_rule_format(&rule->up.cr, &s);
4649             ds_put_char(&s, ')');
4650
4651             VLOG_WARN("%s", ds_cstr(&s));
4652             ds_destroy(&s);
4653         }
4654         return false;
4655     }
4656
4657     /* Check the datapath actions for consistency. */
4658     xlate_in_init(&xin, ofproto, &facet->flow, rule, 0, NULL);
4659     xlate_actions(&xin, &xout);
4660
4661     ok = ofpbuf_equal(&facet->xout.odp_actions, &xout.odp_actions)
4662         && facet->xout.slow == xout.slow;
4663     if (!ok && !VLOG_DROP_WARN(&rl)) {
4664         struct ds s = DS_EMPTY_INITIALIZER;
4665
4666         flow_format(&s, &facet->flow);
4667         ds_put_cstr(&s, ": inconsistency in facet");
4668
4669         if (!ofpbuf_equal(&facet->xout.odp_actions, &xout.odp_actions)) {
4670             ds_put_cstr(&s, " (actions were: ");
4671             format_odp_actions(&s, facet->xout.odp_actions.data,
4672                                facet->xout.odp_actions.size);
4673             ds_put_cstr(&s, ") (correct actions: ");
4674             format_odp_actions(&s, xout.odp_actions.data,
4675                                xout.odp_actions.size);
4676             ds_put_char(&s, ')');
4677         }
4678
4679         if (facet->xout.slow != xout.slow) {
4680             ds_put_format(&s, " slow path incorrect. should be %d", xout.slow);
4681         }
4682
4683         VLOG_WARN("%s", ds_cstr(&s));
4684         ds_destroy(&s);
4685     }
4686     xlate_out_uninit(&xout);
4687
4688     return ok;
4689 }
4690
4691 /* Re-searches the classifier for 'facet':
4692  *
4693  *   - If the rule found is different from 'facet''s current rule, moves
4694  *     'facet' to the new rule and recompiles its actions.
4695  *
4696  *   - If the rule found is the same as 'facet''s current rule, leaves 'facet'
4697  *     where it is and recompiles its actions anyway.
4698  *
4699  *   - If any of 'facet''s subfacets correspond to a new flow according to
4700  *     ofproto_receive(), 'facet' is removed.
4701  *
4702  *   Returns true if 'facet' is still valid.  False if 'facet' was removed. */
4703 static bool
4704 facet_revalidate(struct facet *facet)
4705 {
4706     struct ofproto_dpif *ofproto = ofproto_dpif_cast(facet->rule->up.ofproto);
4707     struct rule_dpif *new_rule;
4708     struct subfacet *subfacet;
4709     struct flow_wildcards wc;
4710     struct xlate_out xout;
4711     struct xlate_in xin;
4712
4713     COVERAGE_INC(facet_revalidate);
4714
4715     /* Check that child subfacets still correspond to this facet.  Tunnel
4716      * configuration changes could cause a subfacet's OpenFlow in_port to
4717      * change. */
4718     LIST_FOR_EACH (subfacet, list_node, &facet->subfacets) {
4719         struct ofproto_dpif *recv_ofproto;
4720         struct flow recv_flow;
4721         int error;
4722
4723         error = ofproto_receive(ofproto->backer, NULL, subfacet->key,
4724                                 subfacet->key_len, &recv_flow, NULL,
4725                                 &recv_ofproto, NULL);
4726         if (error
4727             || recv_ofproto != ofproto
4728             || facet != facet_find(ofproto, &recv_flow)) {
4729             facet_remove(facet);
4730             return false;
4731         }
4732     }
4733
4734     flow_wildcards_init_catchall(&wc);
4735     new_rule = rule_dpif_lookup(ofproto, &facet->flow, &wc);
4736
4737     /* Calculate new datapath actions.
4738      *
4739      * We do not modify any 'facet' state yet, because we might need to, e.g.,
4740      * emit a NetFlow expiration and, if so, we need to have the old state
4741      * around to properly compose it. */
4742     xlate_in_init(&xin, ofproto, &facet->flow, new_rule, 0, NULL);
4743     xlate_actions(&xin, &xout);
4744     flow_wildcards_or(&xout.wc, &xout.wc, &wc);
4745
4746     /* A facet's slow path reason should only change under dramatic
4747      * circumstances.  Rather than try to update everything, it's simpler to
4748      * remove the facet and start over.
4749      *
4750      * More importantly, if a facet's wildcards change, it will be relatively
4751      * difficult to figure out if its subfacets still belong to it, and if not
4752      * which facet they may belong to.  Again, to avoid the complexity, we
4753      * simply give up instead. */
4754     if (facet->xout.slow != xout.slow
4755         || memcmp(&facet->xout.wc, &xout.wc, sizeof xout.wc)) {
4756         facet_remove(facet);
4757         xlate_out_uninit(&xout);
4758         return false;
4759     }
4760
4761     if (!ofpbuf_equal(&facet->xout.odp_actions, &xout.odp_actions)) {
4762         LIST_FOR_EACH(subfacet, list_node, &facet->subfacets) {
4763             if (subfacet->path == SF_FAST_PATH) {
4764                 struct dpif_flow_stats stats;
4765
4766                 subfacet_install(subfacet, &xout.odp_actions, &stats);
4767                 subfacet_update_stats(subfacet, &stats);
4768             }
4769         }
4770
4771         facet_flush_stats(facet);
4772
4773         ofpbuf_clear(&facet->xout.odp_actions);
4774         ofpbuf_put(&facet->xout.odp_actions, xout.odp_actions.data,
4775                    xout.odp_actions.size);
4776     }
4777
4778     /* Update 'facet' now that we've taken care of all the old state. */
4779     facet->xout.tags = xout.tags;
4780     facet->xout.slow = xout.slow;
4781     facet->xout.has_learn = xout.has_learn;
4782     facet->xout.has_normal = xout.has_normal;
4783     facet->xout.has_fin_timeout = xout.has_fin_timeout;
4784     facet->xout.nf_output_iface = xout.nf_output_iface;
4785     facet->xout.mirrors = xout.mirrors;
4786     facet->nf_flow.output_iface = facet->xout.nf_output_iface;
4787
4788     if (facet->rule != new_rule) {
4789         COVERAGE_INC(facet_changed_rule);
4790         list_remove(&facet->list_node);
4791         list_push_back(&new_rule->facets, &facet->list_node);
4792         facet->rule = new_rule;
4793         facet->used = new_rule->up.created;
4794         facet->prev_used = facet->used;
4795     }
4796
4797     xlate_out_uninit(&xout);
4798     return true;
4799 }
4800
4801 static void
4802 facet_reset_counters(struct facet *facet)
4803 {
4804     facet->packet_count = 0;
4805     facet->byte_count = 0;
4806     facet->prev_packet_count = 0;
4807     facet->prev_byte_count = 0;
4808     facet->accounted_bytes = 0;
4809 }
4810
4811 static void
4812 facet_push_stats(struct facet *facet, bool may_learn)
4813 {
4814     struct dpif_flow_stats stats;
4815
4816     ovs_assert(facet->packet_count >= facet->prev_packet_count);
4817     ovs_assert(facet->byte_count >= facet->prev_byte_count);
4818     ovs_assert(facet->used >= facet->prev_used);
4819
4820     stats.n_packets = facet->packet_count - facet->prev_packet_count;
4821     stats.n_bytes = facet->byte_count - facet->prev_byte_count;
4822     stats.used = facet->used;
4823     stats.tcp_flags = facet->tcp_flags;
4824
4825     if (may_learn || stats.n_packets || facet->used > facet->prev_used) {
4826         struct ofproto_dpif *ofproto =
4827             ofproto_dpif_cast(facet->rule->up.ofproto);
4828
4829         struct ofport_dpif *in_port;
4830         struct xlate_in xin;
4831
4832         facet->prev_packet_count = facet->packet_count;
4833         facet->prev_byte_count = facet->byte_count;
4834         facet->prev_used = facet->used;
4835
4836         in_port = get_ofp_port(ofproto, facet->flow.in_port.ofp_port);
4837         if (in_port && in_port->tnl_port) {
4838             netdev_vport_inc_rx(in_port->up.netdev, &stats);
4839         }
4840
4841         rule_credit_stats(facet->rule, &stats);
4842         netflow_flow_update_time(ofproto->netflow, &facet->nf_flow,
4843                                  facet->used);
4844         netflow_flow_update_flags(&facet->nf_flow, facet->tcp_flags);
4845         update_mirror_stats(ofproto, facet->xout.mirrors, stats.n_packets,
4846                             stats.n_bytes);
4847
4848         xlate_in_init(&xin, ofproto, &facet->flow, facet->rule,
4849                       stats.tcp_flags, NULL);
4850         xin.resubmit_stats = &stats;
4851         xin.may_learn = may_learn;
4852         xlate_actions_for_side_effects(&xin);
4853     }
4854 }
4855
4856 static void
4857 push_all_stats__(bool run_fast)
4858 {
4859     static long long int rl = LLONG_MIN;
4860     struct ofproto_dpif *ofproto;
4861
4862     if (time_msec() < rl) {
4863         return;
4864     }
4865
4866     HMAP_FOR_EACH (ofproto, all_ofproto_dpifs_node, &all_ofproto_dpifs) {
4867         struct cls_cursor cursor;
4868         struct facet *facet;
4869
4870         cls_cursor_init(&cursor, &ofproto->facets, NULL);
4871         CLS_CURSOR_FOR_EACH (facet, cr, &cursor) {
4872             facet_push_stats(facet, false);
4873             if (run_fast) {
4874                 run_fast_rl();
4875             }
4876         }
4877     }
4878
4879     rl = time_msec() + 100;
4880 }
4881
4882 static void
4883 push_all_stats(void)
4884 {
4885     push_all_stats__(true);
4886 }
4887
4888 void
4889 rule_credit_stats(struct rule_dpif *rule, const struct dpif_flow_stats *stats)
4890 {
4891     rule->packet_count += stats->n_packets;
4892     rule->byte_count += stats->n_bytes;
4893     ofproto_rule_update_used(&rule->up, stats->used);
4894 }
4895 \f
4896 /* Subfacets. */
4897
4898 static struct subfacet *
4899 subfacet_find(struct dpif_backer *backer, const struct nlattr *key,
4900               size_t key_len, uint32_t key_hash)
4901 {
4902     struct subfacet *subfacet;
4903
4904     HMAP_FOR_EACH_WITH_HASH (subfacet, hmap_node, key_hash,
4905                              &backer->subfacets) {
4906         if (subfacet->key_len == key_len
4907             && !memcmp(key, subfacet->key, key_len)) {
4908             return subfacet;
4909         }
4910     }
4911
4912     return NULL;
4913 }
4914
4915 /* Searches 'facet' (within 'ofproto') for a subfacet with the specified
4916  * 'key_fitness', 'key', and 'key_len' members in 'miss'.  Returns the
4917  * existing subfacet if there is one, otherwise creates and returns a
4918  * new subfacet. */
4919 static struct subfacet *
4920 subfacet_create(struct facet *facet, struct flow_miss *miss,
4921                 long long int now)
4922 {
4923     struct dpif_backer *backer = miss->ofproto->backer;
4924     enum odp_key_fitness key_fitness = miss->key_fitness;
4925     const struct nlattr *key = miss->key;
4926     size_t key_len = miss->key_len;
4927     uint32_t key_hash;
4928     struct subfacet *subfacet;
4929
4930     key_hash = odp_flow_key_hash(key, key_len);
4931
4932     if (list_is_empty(&facet->subfacets)) {
4933         subfacet = &facet->one_subfacet;
4934     } else {
4935         subfacet = subfacet_find(backer, key, key_len, key_hash);
4936         if (subfacet) {
4937             if (subfacet->facet == facet) {
4938                 return subfacet;
4939             }
4940
4941             /* This shouldn't happen. */
4942             VLOG_ERR_RL(&rl, "subfacet with wrong facet");
4943             subfacet_destroy(subfacet);
4944         }
4945
4946         subfacet = xmalloc(sizeof *subfacet);
4947     }
4948
4949     hmap_insert(&backer->subfacets, &subfacet->hmap_node, key_hash);
4950     list_push_back(&facet->subfacets, &subfacet->list_node);
4951     subfacet->facet = facet;
4952     subfacet->key_fitness = key_fitness;
4953     subfacet->key = xmemdup(key, key_len);
4954     subfacet->key_len = key_len;
4955     subfacet->used = now;
4956     subfacet->created = now;
4957     subfacet->dp_packet_count = 0;
4958     subfacet->dp_byte_count = 0;
4959     subfacet->path = SF_NOT_INSTALLED;
4960     subfacet->backer = backer;
4961
4962     backer->subfacet_add_count++;
4963     return subfacet;
4964 }
4965
4966 /* Uninstalls 'subfacet' from the datapath, if it is installed, removes it from
4967  * its facet within 'ofproto', and frees it. */
4968 static void
4969 subfacet_destroy__(struct subfacet *subfacet)
4970 {
4971     struct facet *facet = subfacet->facet;
4972     struct ofproto_dpif *ofproto = ofproto_dpif_cast(facet->rule->up.ofproto);
4973
4974     /* Update ofproto stats before uninstall the subfacet. */
4975     ofproto->backer->subfacet_del_count++;
4976
4977     subfacet_uninstall(subfacet);
4978     hmap_remove(&subfacet->backer->subfacets, &subfacet->hmap_node);
4979     list_remove(&subfacet->list_node);
4980     free(subfacet->key);
4981     if (subfacet != &facet->one_subfacet) {
4982         free(subfacet);
4983     }
4984 }
4985
4986 /* Destroys 'subfacet', as with subfacet_destroy__(), and then if this was the
4987  * last remaining subfacet in its facet destroys the facet too. */
4988 static void
4989 subfacet_destroy(struct subfacet *subfacet)
4990 {
4991     struct facet *facet = subfacet->facet;
4992
4993     if (list_is_singleton(&facet->subfacets)) {
4994         /* facet_remove() needs at least one subfacet (it will remove it). */
4995         facet_remove(facet);
4996     } else {
4997         subfacet_destroy__(subfacet);
4998     }
4999 }
5000
5001 static void
5002 subfacet_destroy_batch(struct dpif_backer *backer,
5003                        struct subfacet **subfacets, int n)
5004 {
5005     struct dpif_op ops[SUBFACET_DESTROY_MAX_BATCH];
5006     struct dpif_op *opsp[SUBFACET_DESTROY_MAX_BATCH];
5007     struct dpif_flow_stats stats[SUBFACET_DESTROY_MAX_BATCH];
5008     int i;
5009
5010     for (i = 0; i < n; i++) {
5011         ops[i].type = DPIF_OP_FLOW_DEL;
5012         ops[i].u.flow_del.key = subfacets[i]->key;
5013         ops[i].u.flow_del.key_len = subfacets[i]->key_len;
5014         ops[i].u.flow_del.stats = &stats[i];
5015         opsp[i] = &ops[i];
5016     }
5017
5018     dpif_operate(backer->dpif, opsp, n);
5019     for (i = 0; i < n; i++) {
5020         subfacet_reset_dp_stats(subfacets[i], &stats[i]);
5021         subfacets[i]->path = SF_NOT_INSTALLED;
5022         subfacet_destroy(subfacets[i]);
5023         run_fast_rl();
5024     }
5025 }
5026
5027 /* Updates 'subfacet''s datapath flow, setting its actions to 'actions_len'
5028  * bytes of actions in 'actions'.  If 'stats' is non-null, statistics counters
5029  * in the datapath will be zeroed and 'stats' will be updated with traffic new
5030  * since 'subfacet' was last updated.
5031  *
5032  * Returns 0 if successful, otherwise a positive errno value. */
5033 static int
5034 subfacet_install(struct subfacet *subfacet, const struct ofpbuf *odp_actions,
5035                  struct dpif_flow_stats *stats)
5036 {
5037     struct facet *facet = subfacet->facet;
5038     struct ofproto_dpif *ofproto = ofproto_dpif_cast(facet->rule->up.ofproto);
5039     enum subfacet_path path = facet->xout.slow ? SF_SLOW_PATH : SF_FAST_PATH;
5040     const struct nlattr *actions = odp_actions->data;
5041     size_t actions_len = odp_actions->size;
5042     struct odputil_keybuf maskbuf;
5043     struct ofpbuf mask;
5044
5045     uint64_t slow_path_stub[128 / 8];
5046     enum dpif_flow_put_flags flags;
5047     int ret;
5048
5049     flags = DPIF_FP_CREATE | DPIF_FP_MODIFY;
5050     if (stats) {
5051         flags |= DPIF_FP_ZERO_STATS;
5052     }
5053
5054     if (path == SF_SLOW_PATH) {
5055         compose_slow_path(ofproto, &facet->flow, facet->xout.slow,
5056                           slow_path_stub, sizeof slow_path_stub,
5057                           &actions, &actions_len);
5058     }
5059
5060     ofpbuf_use_stack(&mask, &maskbuf, sizeof maskbuf);
5061     odp_flow_key_from_mask(&mask, &facet->xout.wc.masks,
5062                            &facet->flow, UINT32_MAX);
5063
5064     ret = dpif_flow_put(subfacet->backer->dpif, flags, subfacet->key,
5065                         subfacet->key_len,  mask.data, mask.size,
5066                         actions, actions_len, stats);
5067
5068     if (stats) {
5069         subfacet_reset_dp_stats(subfacet, stats);
5070     }
5071
5072     if (ret) {
5073         COVERAGE_INC(subfacet_install_fail);
5074     } else {
5075         subfacet->path = path;
5076     }
5077     return ret;
5078 }
5079
5080 /* If 'subfacet' is installed in the datapath, uninstalls it. */
5081 static void
5082 subfacet_uninstall(struct subfacet *subfacet)
5083 {
5084     if (subfacet->path != SF_NOT_INSTALLED) {
5085         struct rule_dpif *rule = subfacet->facet->rule;
5086         struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
5087         struct dpif_flow_stats stats;
5088         int error;
5089
5090         error = dpif_flow_del(ofproto->backer->dpif, subfacet->key,
5091                               subfacet->key_len, &stats);
5092         subfacet_reset_dp_stats(subfacet, &stats);
5093         if (!error) {
5094             subfacet_update_stats(subfacet, &stats);
5095         }
5096         subfacet->path = SF_NOT_INSTALLED;
5097     } else {
5098         ovs_assert(subfacet->dp_packet_count == 0);
5099         ovs_assert(subfacet->dp_byte_count == 0);
5100     }
5101 }
5102
5103 /* Resets 'subfacet''s datapath statistics counters.  This should be called
5104  * when 'subfacet''s statistics are cleared in the datapath.  If 'stats' is
5105  * non-null, it should contain the statistics returned by dpif when 'subfacet'
5106  * was reset in the datapath.  'stats' will be modified to include only
5107  * statistics new since 'subfacet' was last updated. */
5108 static void
5109 subfacet_reset_dp_stats(struct subfacet *subfacet,
5110                         struct dpif_flow_stats *stats)
5111 {
5112     if (stats
5113         && subfacet->dp_packet_count <= stats->n_packets
5114         && subfacet->dp_byte_count <= stats->n_bytes) {
5115         stats->n_packets -= subfacet->dp_packet_count;
5116         stats->n_bytes -= subfacet->dp_byte_count;
5117     }
5118
5119     subfacet->dp_packet_count = 0;
5120     subfacet->dp_byte_count = 0;
5121 }
5122
5123 /* Folds the statistics from 'stats' into the counters in 'subfacet'.
5124  *
5125  * Because of the meaning of a subfacet's counters, it only makes sense to do
5126  * this if 'stats' are not tracked in the datapath, that is, if 'stats'
5127  * represents a packet that was sent by hand or if it represents statistics
5128  * that have been cleared out of the datapath. */
5129 static void
5130 subfacet_update_stats(struct subfacet *subfacet,
5131                       const struct dpif_flow_stats *stats)
5132 {
5133     if (stats->n_packets || stats->used > subfacet->used) {
5134         struct facet *facet = subfacet->facet;
5135
5136         subfacet->used = MAX(subfacet->used, stats->used);
5137         facet->used = MAX(facet->used, stats->used);
5138         facet->packet_count += stats->n_packets;
5139         facet->byte_count += stats->n_bytes;
5140         facet->tcp_flags |= stats->tcp_flags;
5141     }
5142 }
5143 \f
5144 /* Rules. */
5145
5146 /* Lookup 'flow' in 'ofproto''s classifier.  If 'wc' is non-null, sets
5147  * the fields that were relevant as part of the lookup. */
5148 static struct rule_dpif *
5149 rule_dpif_lookup(struct ofproto_dpif *ofproto, const struct flow *flow,
5150                  struct flow_wildcards *wc)
5151 {
5152     struct rule_dpif *rule;
5153
5154     rule = rule_dpif_lookup_in_table(ofproto, flow, wc, 0);
5155     if (rule) {
5156         return rule;
5157     }
5158
5159     return rule_dpif_miss_rule(ofproto, flow);
5160 }
5161
5162 struct rule_dpif *
5163 rule_dpif_lookup_in_table(struct ofproto_dpif *ofproto,
5164                           const struct flow *flow, struct flow_wildcards *wc,
5165                           uint8_t table_id)
5166 {
5167     struct cls_rule *cls_rule;
5168     struct classifier *cls;
5169     bool frag;
5170
5171     if (table_id >= N_TABLES) {
5172         return NULL;
5173     }
5174
5175     if (wc) {
5176         wc->masks.nw_frag |= FLOW_NW_FRAG_MASK;
5177     }
5178
5179     cls = &ofproto->up.tables[table_id].cls;
5180     frag = (flow->nw_frag & FLOW_NW_FRAG_ANY) != 0;
5181     if (frag && ofproto->up.frag_handling == OFPC_FRAG_NORMAL) {
5182         /* We must pretend that transport ports are unavailable. */
5183         struct flow ofpc_normal_flow = *flow;
5184         ofpc_normal_flow.tp_src = htons(0);
5185         ofpc_normal_flow.tp_dst = htons(0);
5186         cls_rule = classifier_lookup(cls, &ofpc_normal_flow, wc);
5187     } else if (frag && ofproto->up.frag_handling == OFPC_FRAG_DROP) {
5188         cls_rule = &ofproto->drop_frags_rule->up.cr;
5189         if (wc) {
5190             flow_wildcards_init_exact(wc);
5191         }
5192     } else {
5193         cls_rule = classifier_lookup(cls, flow, wc);
5194     }
5195     return rule_dpif_cast(rule_from_cls_rule(cls_rule));
5196 }
5197
5198 struct rule_dpif *
5199 rule_dpif_miss_rule(struct ofproto_dpif *ofproto, const struct flow *flow)
5200 {
5201     struct ofport_dpif *port;
5202
5203     port = get_ofp_port(ofproto, flow->in_port.ofp_port);
5204     if (!port) {
5205         VLOG_WARN_RL(&rl, "packet-in on unknown OpenFlow port %"PRIu16,
5206                      flow->in_port.ofp_port);
5207         return ofproto->miss_rule;
5208     }
5209
5210     if (port->up.pp.config & OFPUTIL_PC_NO_PACKET_IN) {
5211         return ofproto->no_packet_in_rule;
5212     }
5213     return ofproto->miss_rule;
5214 }
5215
5216 static void
5217 complete_operation(struct rule_dpif *rule)
5218 {
5219     struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
5220
5221     rule_invalidate(rule);
5222     if (clogged) {
5223         struct dpif_completion *c = xmalloc(sizeof *c);
5224         c->op = rule->up.pending;
5225         list_push_back(&ofproto->completions, &c->list_node);
5226     } else {
5227         ofoperation_complete(rule->up.pending, 0);
5228     }
5229 }
5230
5231 static struct rule *
5232 rule_alloc(void)
5233 {
5234     struct rule_dpif *rule = xmalloc(sizeof *rule);
5235     return &rule->up;
5236 }
5237
5238 static void
5239 rule_dealloc(struct rule *rule_)
5240 {
5241     struct rule_dpif *rule = rule_dpif_cast(rule_);
5242     free(rule);
5243 }
5244
5245 static enum ofperr
5246 rule_construct(struct rule *rule_)
5247 {
5248     struct rule_dpif *rule = rule_dpif_cast(rule_);
5249     struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
5250     struct rule_dpif *victim;
5251     uint8_t table_id;
5252
5253     rule->packet_count = 0;
5254     rule->byte_count = 0;
5255
5256     victim = rule_dpif_cast(ofoperation_get_victim(rule->up.pending));
5257     if (victim && !list_is_empty(&victim->facets)) {
5258         struct facet *facet;
5259
5260         rule->facets = victim->facets;
5261         list_moved(&rule->facets);
5262         LIST_FOR_EACH (facet, list_node, &rule->facets) {
5263             /* XXX: We're only clearing our local counters here.  It's possible
5264              * that quite a few packets are unaccounted for in the datapath
5265              * statistics.  These will be accounted to the new rule instead of
5266              * cleared as required.  This could be fixed by clearing out the
5267              * datapath statistics for this facet, but currently it doesn't
5268              * seem worth it. */
5269             facet_reset_counters(facet);
5270             facet->rule = rule;
5271         }
5272     } else {
5273         /* Must avoid list_moved() in this case. */
5274         list_init(&rule->facets);
5275     }
5276
5277     table_id = rule->up.table_id;
5278     if (victim) {
5279         rule->tag = victim->tag;
5280     } else if (table_id == 0) {
5281         rule->tag = 0;
5282     } else {
5283         struct flow flow;
5284
5285         miniflow_expand(&rule->up.cr.match.flow, &flow);
5286         rule->tag = rule_calculate_tag(&flow, &rule->up.cr.match.mask,
5287                                        ofproto->tables[table_id].basis);
5288     }
5289
5290     complete_operation(rule);
5291     return 0;
5292 }
5293
5294 static void
5295 rule_destruct(struct rule *rule_)
5296 {
5297     struct rule_dpif *rule = rule_dpif_cast(rule_);
5298     struct facet *facet, *next_facet;
5299
5300     LIST_FOR_EACH_SAFE (facet, next_facet, list_node, &rule->facets) {
5301         facet_revalidate(facet);
5302     }
5303
5304     complete_operation(rule);
5305 }
5306
5307 static void
5308 rule_get_stats(struct rule *rule_, uint64_t *packets, uint64_t *bytes)
5309 {
5310     struct rule_dpif *rule = rule_dpif_cast(rule_);
5311
5312     /* push_all_stats() can handle flow misses which, when using the learn
5313      * action, can cause rules to be added and deleted.  This can corrupt our
5314      * caller's datastructures which assume that rule_get_stats() doesn't have
5315      * an impact on the flow table. To be safe, we disable miss handling. */
5316     push_all_stats__(false);
5317
5318     /* Start from historical data for 'rule' itself that are no longer tracked
5319      * in facets.  This counts, for example, facets that have expired. */
5320     *packets = rule->packet_count;
5321     *bytes = rule->byte_count;
5322 }
5323
5324 static void
5325 rule_dpif_execute(struct rule_dpif *rule, const struct flow *flow,
5326                   struct ofpbuf *packet)
5327 {
5328     struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
5329     struct dpif_flow_stats stats;
5330     struct xlate_out xout;
5331     struct xlate_in xin;
5332
5333     dpif_flow_stats_extract(flow, packet, time_msec(), &stats);
5334     rule_credit_stats(rule, &stats);
5335
5336     xlate_in_init(&xin, ofproto, flow, rule, stats.tcp_flags, packet);
5337     xin.resubmit_stats = &stats;
5338     xlate_actions(&xin, &xout);
5339
5340     execute_odp_actions(ofproto, flow, xout.odp_actions.data,
5341                         xout.odp_actions.size, packet);
5342
5343     xlate_out_uninit(&xout);
5344 }
5345
5346 static enum ofperr
5347 rule_execute(struct rule *rule, const struct flow *flow,
5348              struct ofpbuf *packet)
5349 {
5350     rule_dpif_execute(rule_dpif_cast(rule), flow, packet);
5351     ofpbuf_delete(packet);
5352     return 0;
5353 }
5354
5355 static void
5356 rule_modify_actions(struct rule *rule_)
5357 {
5358     struct rule_dpif *rule = rule_dpif_cast(rule_);
5359
5360     complete_operation(rule);
5361 }
5362 \f
5363 /* Sends 'packet' out 'ofport'.
5364  * May modify 'packet'.
5365  * Returns 0 if successful, otherwise a positive errno value. */
5366 static int
5367 send_packet(const struct ofport_dpif *ofport, struct ofpbuf *packet)
5368 {
5369     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofport->up.ofproto);
5370     uint64_t odp_actions_stub[1024 / 8];
5371     struct ofpbuf key, odp_actions;
5372     struct dpif_flow_stats stats;
5373     struct odputil_keybuf keybuf;
5374     struct ofpact_output output;
5375     struct xlate_out xout;
5376     struct xlate_in xin;
5377     struct flow flow;
5378     union flow_in_port in_port_;
5379     int error;
5380
5381     ofpbuf_use_stub(&odp_actions, odp_actions_stub, sizeof odp_actions_stub);
5382     ofpbuf_use_stack(&key, &keybuf, sizeof keybuf);
5383
5384     /* Use OFPP_NONE as the in_port to avoid special packet processing. */
5385     in_port_.ofp_port = OFPP_NONE;
5386     flow_extract(packet, 0, 0, NULL, &in_port_, &flow);
5387     odp_flow_key_from_flow(&key, &flow, ofp_port_to_odp_port(ofproto,
5388                                                              OFPP_LOCAL));
5389     dpif_flow_stats_extract(&flow, packet, time_msec(), &stats);
5390
5391     ofpact_init(&output.ofpact, OFPACT_OUTPUT, sizeof output);
5392     output.port = ofport->up.ofp_port;
5393     output.max_len = 0;
5394
5395     xlate_in_init(&xin, ofproto, &flow, NULL, 0, packet);
5396     xin.ofpacts_len = sizeof output;
5397     xin.ofpacts = &output.ofpact;
5398     xin.resubmit_stats = &stats;
5399     xlate_actions(&xin, &xout);
5400
5401     error = dpif_execute(ofproto->backer->dpif,
5402                          key.data, key.size,
5403                          xout.odp_actions.data, xout.odp_actions.size,
5404                          packet);
5405     xlate_out_uninit(&xout);
5406
5407     if (error) {
5408         VLOG_WARN_RL(&rl, "%s: failed to send packet on port %s (%s)",
5409                      ofproto->up.name, netdev_get_name(ofport->up.netdev),
5410                      strerror(error));
5411     }
5412
5413     ofproto->stats.tx_packets++;
5414     ofproto->stats.tx_bytes += packet->size;
5415     return error;
5416 }
5417
5418 /* Composes an ODP action for a "slow path" action for 'flow' within 'ofproto'.
5419  * The action will state 'slow' as the reason that the action is in the slow
5420  * path.  (This is purely informational: it allows a human viewing "ovs-dpctl
5421  * dump-flows" output to see why a flow is in the slow path.)
5422  *
5423  * The 'stub_size' bytes in 'stub' will be used to store the action.
5424  * 'stub_size' must be large enough for the action.
5425  *
5426  * The action and its size will be stored in '*actionsp' and '*actions_lenp',
5427  * respectively. */
5428 static void
5429 compose_slow_path(const struct ofproto_dpif *ofproto, const struct flow *flow,
5430                   enum slow_path_reason slow,
5431                   uint64_t *stub, size_t stub_size,
5432                   const struct nlattr **actionsp, size_t *actions_lenp)
5433 {
5434     union user_action_cookie cookie;
5435     struct ofpbuf buf;
5436
5437     cookie.type = USER_ACTION_COOKIE_SLOW_PATH;
5438     cookie.slow_path.unused = 0;
5439     cookie.slow_path.reason = slow;
5440
5441     ofpbuf_use_stack(&buf, stub, stub_size);
5442     if (slow & (SLOW_CFM | SLOW_BFD | SLOW_LACP | SLOW_STP)) {
5443         uint32_t pid = dpif_port_get_pid(ofproto->backer->dpif,
5444                                          ODPP_NONE);
5445         odp_put_userspace_action(pid, &cookie, sizeof cookie.slow_path, &buf);
5446     } else {
5447         put_userspace_action(ofproto, &buf, flow, &cookie,
5448                              sizeof cookie.slow_path);
5449     }
5450     *actionsp = buf.data;
5451     *actions_lenp = buf.size;
5452 }
5453
5454 size_t
5455 put_userspace_action(const struct ofproto_dpif *ofproto,
5456                      struct ofpbuf *odp_actions,
5457                      const struct flow *flow,
5458                      const union user_action_cookie *cookie,
5459                      const size_t cookie_size)
5460 {
5461     uint32_t pid;
5462
5463     pid = dpif_port_get_pid(ofproto->backer->dpif,
5464                             ofp_port_to_odp_port(ofproto,
5465                                                  flow->in_port.ofp_port));
5466
5467     return odp_put_userspace_action(pid, cookie, cookie_size, odp_actions);
5468 }
5469
5470
5471 static void
5472 update_mirror_stats(struct ofproto_dpif *ofproto, mirror_mask_t mirrors,
5473                     uint64_t packets, uint64_t bytes)
5474 {
5475     if (!mirrors) {
5476         return;
5477     }
5478
5479     for (; mirrors; mirrors = zero_rightmost_1bit(mirrors)) {
5480         struct ofmirror *m;
5481
5482         m = ofproto->mirrors[mirror_mask_ffs(mirrors) - 1];
5483
5484         if (!m) {
5485             /* In normal circumstances 'm' will not be NULL.  However,
5486              * if mirrors are reconfigured, we can temporarily get out
5487              * of sync in facet_revalidate().  We could "correct" the
5488              * mirror list before reaching here, but doing that would
5489              * not properly account the traffic stats we've currently
5490              * accumulated for previous mirror configuration. */
5491             continue;
5492         }
5493
5494         m->packet_count += packets;
5495         m->byte_count += bytes;
5496     }
5497 }
5498
5499 \f
5500 /* Optimized flow revalidation.
5501  *
5502  * It's a difficult problem, in general, to tell which facets need to have
5503  * their actions recalculated whenever the OpenFlow flow table changes.  We
5504  * don't try to solve that general problem: for most kinds of OpenFlow flow
5505  * table changes, we recalculate the actions for every facet.  This is
5506  * relatively expensive, but it's good enough if the OpenFlow flow table
5507  * doesn't change very often.
5508  *
5509  * However, we can expect one particular kind of OpenFlow flow table change to
5510  * happen frequently: changes caused by MAC learning.  To avoid wasting a lot
5511  * of CPU on revalidating every facet whenever MAC learning modifies the flow
5512  * table, we add a special case that applies to flow tables in which every rule
5513  * has the same form (that is, the same wildcards), except that the table is
5514  * also allowed to have a single "catch-all" flow that matches all packets.  We
5515  * optimize this case by tagging all of the facets that resubmit into the table
5516  * and invalidating the same tag whenever a flow changes in that table.  The
5517  * end result is that we revalidate just the facets that need it (and sometimes
5518  * a few more, but not all of the facets or even all of the facets that
5519  * resubmit to the table modified by MAC learning). */
5520
5521 /* Calculates the tag to use for 'flow' and mask 'mask' when it is inserted
5522  * into an OpenFlow table with the given 'basis'. */
5523 tag_type
5524 rule_calculate_tag(const struct flow *flow, const struct minimask *mask,
5525                    uint32_t secret)
5526 {
5527     if (minimask_is_catchall(mask)) {
5528         return 0;
5529     } else {
5530         uint32_t hash = flow_hash_in_minimask(flow, mask, secret);
5531         return tag_create_deterministic(hash);
5532     }
5533 }
5534
5535 /* Following a change to OpenFlow table 'table_id' in 'ofproto', update the
5536  * taggability of that table.
5537  *
5538  * This function must be called after *each* change to a flow table.  If you
5539  * skip calling it on some changes then the pointer comparisons at the end can
5540  * be invalid if you get unlucky.  For example, if a flow removal causes a
5541  * cls_table to be destroyed and then a flow insertion causes a cls_table with
5542  * different wildcards to be created with the same address, then this function
5543  * will incorrectly skip revalidation. */
5544 static void
5545 table_update_taggable(struct ofproto_dpif *ofproto, uint8_t table_id)
5546 {
5547     struct table_dpif *table = &ofproto->tables[table_id];
5548     const struct oftable *oftable = &ofproto->up.tables[table_id];
5549     struct cls_table *catchall, *other;
5550     struct cls_table *t;
5551
5552     catchall = other = NULL;
5553
5554     switch (hmap_count(&oftable->cls.tables)) {
5555     case 0:
5556         /* We could tag this OpenFlow table but it would make the logic a
5557          * little harder and it's a corner case that doesn't seem worth it
5558          * yet. */
5559         break;
5560
5561     case 1:
5562     case 2:
5563         HMAP_FOR_EACH (t, hmap_node, &oftable->cls.tables) {
5564             if (cls_table_is_catchall(t)) {
5565                 catchall = t;
5566             } else if (!other) {
5567                 other = t;
5568             } else {
5569                 /* Indicate that we can't tag this by setting both tables to
5570                  * NULL.  (We know that 'catchall' is already NULL.) */
5571                 other = NULL;
5572             }
5573         }
5574         break;
5575
5576     default:
5577         /* Can't tag this table. */
5578         break;
5579     }
5580
5581     if (table->catchall_table != catchall || table->other_table != other) {
5582         table->catchall_table = catchall;
5583         table->other_table = other;
5584         ofproto->backer->need_revalidate = REV_FLOW_TABLE;
5585     }
5586 }
5587
5588 /* Given 'rule' that has changed in some way (either it is a rule being
5589  * inserted, a rule being deleted, or a rule whose actions are being
5590  * modified), marks facets for revalidation to ensure that packets will be
5591  * forwarded correctly according to the new state of the flow table.
5592  *
5593  * This function must be called after *each* change to a flow table.  See
5594  * the comment on table_update_taggable() for more information. */
5595 static void
5596 rule_invalidate(const struct rule_dpif *rule)
5597 {
5598     struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
5599
5600     table_update_taggable(ofproto, rule->up.table_id);
5601
5602     if (!ofproto->backer->need_revalidate) {
5603         struct table_dpif *table = &ofproto->tables[rule->up.table_id];
5604
5605         if (table->other_table && rule->tag) {
5606             tag_set_add(&ofproto->backer->revalidate_set, rule->tag);
5607         } else {
5608             ofproto->backer->need_revalidate = REV_FLOW_TABLE;
5609         }
5610     }
5611 }
5612 \f
5613 static bool
5614 set_frag_handling(struct ofproto *ofproto_,
5615                   enum ofp_config_flags frag_handling)
5616 {
5617     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
5618     if (frag_handling != OFPC_FRAG_REASM) {
5619         ofproto->backer->need_revalidate = REV_RECONFIGURE;
5620         return true;
5621     } else {
5622         return false;
5623     }
5624 }
5625
5626 static enum ofperr
5627 packet_out(struct ofproto *ofproto_, struct ofpbuf *packet,
5628            const struct flow *flow,
5629            const struct ofpact *ofpacts, size_t ofpacts_len)
5630 {
5631     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
5632     struct odputil_keybuf keybuf;
5633     struct dpif_flow_stats stats;
5634     struct xlate_out xout;
5635     struct xlate_in xin;
5636     struct ofpbuf key;
5637
5638
5639     ofpbuf_use_stack(&key, &keybuf, sizeof keybuf);
5640     odp_flow_key_from_flow(&key, flow,
5641                            ofp_port_to_odp_port(ofproto,
5642                                       flow->in_port.ofp_port));
5643
5644     dpif_flow_stats_extract(flow, packet, time_msec(), &stats);
5645
5646     xlate_in_init(&xin, ofproto, flow, NULL, stats.tcp_flags, packet);
5647     xin.resubmit_stats = &stats;
5648     xin.ofpacts_len = ofpacts_len;
5649     xin.ofpacts = ofpacts;
5650
5651     xlate_actions(&xin, &xout);
5652     dpif_execute(ofproto->backer->dpif, key.data, key.size,
5653                  xout.odp_actions.data, xout.odp_actions.size, packet);
5654     xlate_out_uninit(&xout);
5655
5656     return 0;
5657 }
5658 \f
5659 /* NetFlow. */
5660
5661 static int
5662 set_netflow(struct ofproto *ofproto_,
5663             const struct netflow_options *netflow_options)
5664 {
5665     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
5666
5667     if (netflow_options) {
5668         if (!ofproto->netflow) {
5669             ofproto->netflow = netflow_create();
5670             ofproto->backer->need_revalidate = REV_RECONFIGURE;
5671         }
5672         return netflow_set_options(ofproto->netflow, netflow_options);
5673     } else if (ofproto->netflow) {
5674         ofproto->backer->need_revalidate = REV_RECONFIGURE;
5675         netflow_destroy(ofproto->netflow);
5676         ofproto->netflow = NULL;
5677     }
5678
5679     return 0;
5680 }
5681
5682 static void
5683 get_netflow_ids(const struct ofproto *ofproto_,
5684                 uint8_t *engine_type, uint8_t *engine_id)
5685 {
5686     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
5687
5688     dpif_get_netflow_ids(ofproto->backer->dpif, engine_type, engine_id);
5689 }
5690
5691 static void
5692 send_active_timeout(struct ofproto_dpif *ofproto, struct facet *facet)
5693 {
5694     if (!facet_is_controller_flow(facet) &&
5695         netflow_active_timeout_expired(ofproto->netflow, &facet->nf_flow)) {
5696         struct subfacet *subfacet;
5697         struct ofexpired expired;
5698
5699         LIST_FOR_EACH (subfacet, list_node, &facet->subfacets) {
5700             if (subfacet->path == SF_FAST_PATH) {
5701                 struct dpif_flow_stats stats;
5702
5703                 subfacet_install(subfacet, &facet->xout.odp_actions,
5704                                  &stats);
5705                 subfacet_update_stats(subfacet, &stats);
5706             }
5707         }
5708
5709         expired.flow = facet->flow;
5710         expired.packet_count = facet->packet_count;
5711         expired.byte_count = facet->byte_count;
5712         expired.used = facet->used;
5713         netflow_expire(ofproto->netflow, &facet->nf_flow, &expired);
5714     }
5715 }
5716
5717 static void
5718 send_netflow_active_timeouts(struct ofproto_dpif *ofproto)
5719 {
5720     struct cls_cursor cursor;
5721     struct facet *facet;
5722
5723     cls_cursor_init(&cursor, &ofproto->facets, NULL);
5724     CLS_CURSOR_FOR_EACH (facet, cr, &cursor) {
5725         send_active_timeout(ofproto, facet);
5726     }
5727 }
5728 \f
5729 static struct ofproto_dpif *
5730 ofproto_dpif_lookup(const char *name)
5731 {
5732     struct ofproto_dpif *ofproto;
5733
5734     HMAP_FOR_EACH_WITH_HASH (ofproto, all_ofproto_dpifs_node,
5735                              hash_string(name, 0), &all_ofproto_dpifs) {
5736         if (!strcmp(ofproto->up.name, name)) {
5737             return ofproto;
5738         }
5739     }
5740     return NULL;
5741 }
5742
5743 static void
5744 ofproto_unixctl_fdb_flush(struct unixctl_conn *conn, int argc,
5745                           const char *argv[], void *aux OVS_UNUSED)
5746 {
5747     struct ofproto_dpif *ofproto;
5748
5749     if (argc > 1) {
5750         ofproto = ofproto_dpif_lookup(argv[1]);
5751         if (!ofproto) {
5752             unixctl_command_reply_error(conn, "no such bridge");
5753             return;
5754         }
5755         mac_learning_flush(ofproto->ml, &ofproto->backer->revalidate_set);
5756     } else {
5757         HMAP_FOR_EACH (ofproto, all_ofproto_dpifs_node, &all_ofproto_dpifs) {
5758             mac_learning_flush(ofproto->ml, &ofproto->backer->revalidate_set);
5759         }
5760     }
5761
5762     unixctl_command_reply(conn, "table successfully flushed");
5763 }
5764
5765 static void
5766 ofproto_unixctl_fdb_show(struct unixctl_conn *conn, int argc OVS_UNUSED,
5767                          const char *argv[], void *aux OVS_UNUSED)
5768 {
5769     struct ds ds = DS_EMPTY_INITIALIZER;
5770     const struct ofproto_dpif *ofproto;
5771     const struct mac_entry *e;
5772
5773     ofproto = ofproto_dpif_lookup(argv[1]);
5774     if (!ofproto) {
5775         unixctl_command_reply_error(conn, "no such bridge");
5776         return;
5777     }
5778
5779     ds_put_cstr(&ds, " port  VLAN  MAC                Age\n");
5780     LIST_FOR_EACH (e, lru_node, &ofproto->ml->lrus) {
5781         struct ofbundle *bundle = e->port.p;
5782         char name[OFP_MAX_PORT_NAME_LEN];
5783
5784         ofputil_port_to_string(ofbundle_get_a_port(bundle)->up.ofp_port,
5785                                name, sizeof name);
5786         ds_put_format(&ds, "%5s  %4d  "ETH_ADDR_FMT"  %3d\n",
5787                       name, e->vlan, ETH_ADDR_ARGS(e->mac),
5788                       mac_entry_age(ofproto->ml, e));
5789     }
5790     unixctl_command_reply(conn, ds_cstr(&ds));
5791     ds_destroy(&ds);
5792 }
5793
5794 struct trace_ctx {
5795     struct xlate_out xout;
5796     struct xlate_in xin;
5797     struct flow flow;
5798     struct ds *result;
5799 };
5800
5801 static void
5802 trace_format_rule(struct ds *result, int level, const struct rule_dpif *rule)
5803 {
5804     ds_put_char_multiple(result, '\t', level);
5805     if (!rule) {
5806         ds_put_cstr(result, "No match\n");
5807         return;
5808     }
5809
5810     ds_put_format(result, "Rule: table=%"PRIu8" cookie=%#"PRIx64" ",
5811                   rule ? rule->up.table_id : 0, ntohll(rule->up.flow_cookie));
5812     cls_rule_format(&rule->up.cr, result);
5813     ds_put_char(result, '\n');
5814
5815     ds_put_char_multiple(result, '\t', level);
5816     ds_put_cstr(result, "OpenFlow ");
5817     ofpacts_format(rule->up.ofpacts, rule->up.ofpacts_len, result);
5818     ds_put_char(result, '\n');
5819 }
5820
5821 static void
5822 trace_format_flow(struct ds *result, int level, const char *title,
5823                   struct trace_ctx *trace)
5824 {
5825     ds_put_char_multiple(result, '\t', level);
5826     ds_put_format(result, "%s: ", title);
5827     if (flow_equal(&trace->xin.flow, &trace->flow)) {
5828         ds_put_cstr(result, "unchanged");
5829     } else {
5830         flow_format(result, &trace->xin.flow);
5831         trace->flow = trace->xin.flow;
5832     }
5833     ds_put_char(result, '\n');
5834 }
5835
5836 static void
5837 trace_format_regs(struct ds *result, int level, const char *title,
5838                   struct trace_ctx *trace)
5839 {
5840     size_t i;
5841
5842     ds_put_char_multiple(result, '\t', level);
5843     ds_put_format(result, "%s:", title);
5844     for (i = 0; i < FLOW_N_REGS; i++) {
5845         ds_put_format(result, " reg%zu=0x%"PRIx32, i, trace->flow.regs[i]);
5846     }
5847     ds_put_char(result, '\n');
5848 }
5849
5850 static void
5851 trace_format_odp(struct ds *result, int level, const char *title,
5852                  struct trace_ctx *trace)
5853 {
5854     struct ofpbuf *odp_actions = &trace->xout.odp_actions;
5855
5856     ds_put_char_multiple(result, '\t', level);
5857     ds_put_format(result, "%s: ", title);
5858     format_odp_actions(result, odp_actions->data, odp_actions->size);
5859     ds_put_char(result, '\n');
5860 }
5861
5862 static void
5863 trace_resubmit(struct xlate_in *xin, struct rule_dpif *rule, int recurse)
5864 {
5865     struct trace_ctx *trace = CONTAINER_OF(xin, struct trace_ctx, xin);
5866     struct ds *result = trace->result;
5867
5868     ds_put_char(result, '\n');
5869     trace_format_flow(result, recurse + 1, "Resubmitted flow", trace);
5870     trace_format_regs(result, recurse + 1, "Resubmitted regs", trace);
5871     trace_format_odp(result,  recurse + 1, "Resubmitted  odp", trace);
5872     trace_format_rule(result, recurse + 1, rule);
5873 }
5874
5875 static void
5876 trace_report(struct xlate_in *xin, const char *s, int recurse)
5877 {
5878     struct trace_ctx *trace = CONTAINER_OF(xin, struct trace_ctx, xin);
5879     struct ds *result = trace->result;
5880
5881     ds_put_char_multiple(result, '\t', recurse);
5882     ds_put_cstr(result, s);
5883     ds_put_char(result, '\n');
5884 }
5885
5886 static void
5887 ofproto_unixctl_trace(struct unixctl_conn *conn, int argc, const char *argv[],
5888                       void *aux OVS_UNUSED)
5889 {
5890     const struct dpif_backer *backer;
5891     struct ofproto_dpif *ofproto;
5892     struct ofpbuf odp_key;
5893     struct ofpbuf *packet;
5894     struct ds result;
5895     struct flow flow;
5896     char *s;
5897
5898     packet = NULL;
5899     backer = NULL;
5900     ds_init(&result);
5901     ofpbuf_init(&odp_key, 0);
5902
5903     /* Handle "-generate" or a hex string as the last argument. */
5904     if (!strcmp(argv[argc - 1], "-generate")) {
5905         packet = ofpbuf_new(0);
5906         argc--;
5907     } else {
5908         const char *error = eth_from_hex(argv[argc - 1], &packet);
5909         if (!error) {
5910             argc--;
5911         } else if (argc == 4) {
5912             /* The 3-argument form must end in "-generate' or a hex string. */
5913             unixctl_command_reply_error(conn, error);
5914             goto exit;
5915         }
5916     }
5917
5918     /* Parse the flow and determine whether a datapath or
5919      * bridge is specified. If function odp_flow_key_from_string()
5920      * returns 0, the flow is a odp_flow. If function
5921      * parse_ofp_exact_flow() returns 0, the flow is a br_flow. */
5922     if (!odp_flow_from_string(argv[argc - 1], NULL, &odp_key, NULL)) {
5923         /* If the odp_flow is the second argument,
5924          * the datapath name is the first argument. */
5925         if (argc == 3) {
5926             const char *dp_type;
5927             if (!strncmp(argv[1], "ovs-", 4)) {
5928                 dp_type = argv[1] + 4;
5929             } else {
5930                 dp_type = argv[1];
5931             }
5932             backer = shash_find_data(&all_dpif_backers, dp_type);
5933             if (!backer) {
5934                 unixctl_command_reply_error(conn, "Cannot find datapath "
5935                                "of this name");
5936                 goto exit;
5937             }
5938         } else {
5939             /* No datapath name specified, so there should be only one
5940              * datapath. */
5941             struct shash_node *node;
5942             if (shash_count(&all_dpif_backers) != 1) {
5943                 unixctl_command_reply_error(conn, "Must specify datapath "
5944                          "name, there is more than one type of datapath");
5945                 goto exit;
5946             }
5947             node = shash_first(&all_dpif_backers);
5948             backer = node->data;
5949         }
5950
5951         /* Extract the ofproto_dpif object from the ofproto_receive()
5952          * function. */
5953         if (ofproto_receive(backer, NULL, odp_key.data,
5954                             odp_key.size, &flow, NULL, &ofproto, NULL)) {
5955             unixctl_command_reply_error(conn, "Invalid datapath flow");
5956             goto exit;
5957         }
5958         ds_put_format(&result, "Bridge: %s\n", ofproto->up.name);
5959     } else if (!parse_ofp_exact_flow(&flow, argv[argc - 1])) {
5960         if (argc != 3) {
5961             unixctl_command_reply_error(conn, "Must specify bridge name");
5962             goto exit;
5963         }
5964
5965         ofproto = ofproto_dpif_lookup(argv[1]);
5966         if (!ofproto) {
5967             unixctl_command_reply_error(conn, "Unknown bridge name");
5968             goto exit;
5969         }
5970     } else {
5971         unixctl_command_reply_error(conn, "Bad flow syntax");
5972         goto exit;
5973     }
5974
5975     /* Generate a packet, if requested. */
5976     if (packet) {
5977         if (!packet->size) {
5978             flow_compose(packet, &flow);
5979         } else {
5980             union flow_in_port in_port_;
5981
5982             in_port_ = flow.in_port;
5983             ds_put_cstr(&result, "Packet: ");
5984             s = ofp_packet_to_string(packet->data, packet->size);
5985             ds_put_cstr(&result, s);
5986             free(s);
5987
5988             /* Use the metadata from the flow and the packet argument
5989              * to reconstruct the flow. */
5990             flow_extract(packet, flow.skb_priority, flow.skb_mark, NULL,
5991                          &in_port_, &flow);
5992         }
5993     }
5994
5995     ofproto_trace(ofproto, &flow, packet, &result);
5996     unixctl_command_reply(conn, ds_cstr(&result));
5997
5998 exit:
5999     ds_destroy(&result);
6000     ofpbuf_delete(packet);
6001     ofpbuf_uninit(&odp_key);
6002 }
6003
6004 void
6005 ofproto_trace(struct ofproto_dpif *ofproto, const struct flow *flow,
6006               const struct ofpbuf *packet, struct ds *ds)
6007 {
6008     struct rule_dpif *rule;
6009
6010     ds_put_cstr(ds, "Flow: ");
6011     flow_format(ds, flow);
6012     ds_put_char(ds, '\n');
6013
6014     rule = rule_dpif_lookup(ofproto, flow, NULL);
6015
6016     trace_format_rule(ds, 0, rule);
6017     if (rule == ofproto->miss_rule) {
6018         ds_put_cstr(ds, "\nNo match, flow generates \"packet in\"s.\n");
6019     } else if (rule == ofproto->no_packet_in_rule) {
6020         ds_put_cstr(ds, "\nNo match, packets dropped because "
6021                     "OFPPC_NO_PACKET_IN is set on in_port.\n");
6022     } else if (rule == ofproto->drop_frags_rule) {
6023         ds_put_cstr(ds, "\nPackets dropped because they are IP fragments "
6024                     "and the fragment handling mode is \"drop\".\n");
6025     }
6026
6027     if (rule) {
6028         uint64_t odp_actions_stub[1024 / 8];
6029         struct ofpbuf odp_actions;
6030         struct trace_ctx trace;
6031         struct match match;
6032         uint8_t tcp_flags;
6033
6034         tcp_flags = packet ? packet_get_tcp_flags(packet, flow) : 0;
6035         trace.result = ds;
6036         trace.flow = *flow;
6037         ofpbuf_use_stub(&odp_actions,
6038                         odp_actions_stub, sizeof odp_actions_stub);
6039         xlate_in_init(&trace.xin, ofproto, flow, rule, tcp_flags, packet);
6040         trace.xin.resubmit_hook = trace_resubmit;
6041         trace.xin.report_hook = trace_report;
6042
6043         xlate_actions(&trace.xin, &trace.xout);
6044
6045         ds_put_char(ds, '\n');
6046         trace_format_flow(ds, 0, "Final flow", &trace);
6047
6048         match_init(&match, flow, &trace.xout.wc);
6049         ds_put_cstr(ds, "Relevant fields: ");
6050         match_format(&match, ds, OFP_DEFAULT_PRIORITY);
6051         ds_put_char(ds, '\n');
6052
6053         ds_put_cstr(ds, "Datapath actions: ");
6054         format_odp_actions(ds, trace.xout.odp_actions.data,
6055                            trace.xout.odp_actions.size);
6056
6057         if (trace.xout.slow) {
6058             ds_put_cstr(ds, "\nThis flow is handled by the userspace "
6059                         "slow path because it:");
6060             switch (trace.xout.slow) {
6061             case SLOW_CFM:
6062                 ds_put_cstr(ds, "\n\t- Consists of CFM packets.");
6063                 break;
6064             case SLOW_LACP:
6065                 ds_put_cstr(ds, "\n\t- Consists of LACP packets.");
6066                 break;
6067             case SLOW_STP:
6068                 ds_put_cstr(ds, "\n\t- Consists of STP packets.");
6069                 break;
6070             case SLOW_BFD:
6071                 ds_put_cstr(ds, "\n\t- Consists of BFD packets.");
6072                 break;
6073             case SLOW_CONTROLLER:
6074                 ds_put_cstr(ds, "\n\t- Sends \"packet-in\" messages "
6075                             "to the OpenFlow controller.");
6076                 break;
6077             case __SLOW_MAX:
6078                 NOT_REACHED();
6079             }
6080         }
6081
6082         xlate_out_uninit(&trace.xout);
6083     }
6084 }
6085
6086 static void
6087 ofproto_dpif_clog(struct unixctl_conn *conn OVS_UNUSED, int argc OVS_UNUSED,
6088                   const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED)
6089 {
6090     clogged = true;
6091     unixctl_command_reply(conn, NULL);
6092 }
6093
6094 static void
6095 ofproto_dpif_unclog(struct unixctl_conn *conn OVS_UNUSED, int argc OVS_UNUSED,
6096                     const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED)
6097 {
6098     clogged = false;
6099     unixctl_command_reply(conn, NULL);
6100 }
6101
6102 /* Runs a self-check of flow translations in 'ofproto'.  Appends a message to
6103  * 'reply' describing the results. */
6104 static void
6105 ofproto_dpif_self_check__(struct ofproto_dpif *ofproto, struct ds *reply)
6106 {
6107     struct cls_cursor cursor;
6108     struct facet *facet;
6109     int errors;
6110
6111     errors = 0;
6112     cls_cursor_init(&cursor, &ofproto->facets, NULL);
6113     CLS_CURSOR_FOR_EACH (facet, cr, &cursor) {
6114         if (!facet_check_consistency(facet)) {
6115             errors++;
6116         }
6117     }
6118     if (errors) {
6119         ofproto->backer->need_revalidate = REV_INCONSISTENCY;
6120     }
6121
6122     if (errors) {
6123         ds_put_format(reply, "%s: self-check failed (%d errors)\n",
6124                       ofproto->up.name, errors);
6125     } else {
6126         ds_put_format(reply, "%s: self-check passed\n", ofproto->up.name);
6127     }
6128 }
6129
6130 static void
6131 ofproto_dpif_self_check(struct unixctl_conn *conn,
6132                         int argc, const char *argv[], void *aux OVS_UNUSED)
6133 {
6134     struct ds reply = DS_EMPTY_INITIALIZER;
6135     struct ofproto_dpif *ofproto;
6136
6137     if (argc > 1) {
6138         ofproto = ofproto_dpif_lookup(argv[1]);
6139         if (!ofproto) {
6140             unixctl_command_reply_error(conn, "Unknown ofproto (use "
6141                                         "ofproto/list for help)");
6142             return;
6143         }
6144         ofproto_dpif_self_check__(ofproto, &reply);
6145     } else {
6146         HMAP_FOR_EACH (ofproto, all_ofproto_dpifs_node, &all_ofproto_dpifs) {
6147             ofproto_dpif_self_check__(ofproto, &reply);
6148         }
6149     }
6150
6151     unixctl_command_reply(conn, ds_cstr(&reply));
6152     ds_destroy(&reply);
6153 }
6154
6155 /* Store the current ofprotos in 'ofproto_shash'.  Returns a sorted list
6156  * of the 'ofproto_shash' nodes.  It is the responsibility of the caller
6157  * to destroy 'ofproto_shash' and free the returned value. */
6158 static const struct shash_node **
6159 get_ofprotos(struct shash *ofproto_shash)
6160 {
6161     const struct ofproto_dpif *ofproto;
6162
6163     HMAP_FOR_EACH (ofproto, all_ofproto_dpifs_node, &all_ofproto_dpifs) {
6164         char *name = xasprintf("%s@%s", ofproto->up.type, ofproto->up.name);
6165         shash_add_nocopy(ofproto_shash, name, ofproto);
6166     }
6167
6168     return shash_sort(ofproto_shash);
6169 }
6170
6171 static void
6172 ofproto_unixctl_dpif_dump_dps(struct unixctl_conn *conn, int argc OVS_UNUSED,
6173                               const char *argv[] OVS_UNUSED,
6174                               void *aux OVS_UNUSED)
6175 {
6176     struct ds ds = DS_EMPTY_INITIALIZER;
6177     struct shash ofproto_shash;
6178     const struct shash_node **sorted_ofprotos;
6179     int i;
6180
6181     shash_init(&ofproto_shash);
6182     sorted_ofprotos = get_ofprotos(&ofproto_shash);
6183     for (i = 0; i < shash_count(&ofproto_shash); i++) {
6184         const struct shash_node *node = sorted_ofprotos[i];
6185         ds_put_format(&ds, "%s\n", node->name);
6186     }
6187
6188     shash_destroy(&ofproto_shash);
6189     free(sorted_ofprotos);
6190
6191     unixctl_command_reply(conn, ds_cstr(&ds));
6192     ds_destroy(&ds);
6193 }
6194
6195 static void
6196 show_dp_rates(struct ds *ds, const char *heading,
6197               const struct avg_subfacet_rates *rates)
6198 {
6199     ds_put_format(ds, "%s add rate: %5.3f/min, del rate: %5.3f/min\n",
6200                   heading, rates->add_rate, rates->del_rate);
6201 }
6202
6203 static void
6204 dpif_show_backer(const struct dpif_backer *backer, struct ds *ds)
6205 {
6206     const struct shash_node **ofprotos;
6207     struct ofproto_dpif *ofproto;
6208     struct shash ofproto_shash;
6209     uint64_t n_hit, n_missed;
6210     long long int minutes;
6211     size_t i;
6212
6213     n_hit = n_missed = 0;
6214     HMAP_FOR_EACH (ofproto, all_ofproto_dpifs_node, &all_ofproto_dpifs) {
6215         if (ofproto->backer == backer) {
6216             n_missed += ofproto->n_missed;
6217             n_hit += ofproto->n_hit;
6218         }
6219     }
6220
6221     ds_put_format(ds, "%s: hit:%"PRIu64" missed:%"PRIu64"\n",
6222                   dpif_name(backer->dpif), n_hit, n_missed);
6223     ds_put_format(ds, "\tflows: cur: %zu, avg: %u, max: %u,"
6224                   " life span: %lldms\n", hmap_count(&backer->subfacets),
6225                   backer->avg_n_subfacet, backer->max_n_subfacet,
6226                   backer->avg_subfacet_life);
6227
6228     minutes = (time_msec() - backer->created) / (1000 * 60);
6229     if (minutes >= 60) {
6230         show_dp_rates(ds, "\thourly avg:", &backer->hourly);
6231     }
6232     if (minutes >= 60 * 24) {
6233         show_dp_rates(ds, "\tdaily avg:",  &backer->daily);
6234     }
6235     show_dp_rates(ds, "\toverall avg:",  &backer->lifetime);
6236
6237     shash_init(&ofproto_shash);
6238     ofprotos = get_ofprotos(&ofproto_shash);
6239     for (i = 0; i < shash_count(&ofproto_shash); i++) {
6240         struct ofproto_dpif *ofproto = ofprotos[i]->data;
6241         const struct shash_node **ports;
6242         size_t j;
6243
6244         if (ofproto->backer != backer) {
6245             continue;
6246         }
6247
6248         ds_put_format(ds, "\t%s: hit:%"PRIu64" missed:%"PRIu64"\n",
6249                       ofproto->up.name, ofproto->n_hit, ofproto->n_missed);
6250
6251         ports = shash_sort(&ofproto->up.port_by_name);
6252         for (j = 0; j < shash_count(&ofproto->up.port_by_name); j++) {
6253             const struct shash_node *node = ports[j];
6254             struct ofport *ofport = node->data;
6255             struct smap config;
6256             odp_port_t odp_port;
6257
6258             ds_put_format(ds, "\t\t%s %u/", netdev_get_name(ofport->netdev),
6259                           ofport->ofp_port);
6260
6261             odp_port = ofp_port_to_odp_port(ofproto, ofport->ofp_port);
6262             if (odp_port != ODPP_NONE) {
6263                 ds_put_format(ds, "%"PRIu32":", odp_port);
6264             } else {
6265                 ds_put_cstr(ds, "none:");
6266             }
6267
6268             ds_put_format(ds, " (%s", netdev_get_type(ofport->netdev));
6269
6270             smap_init(&config);
6271             if (!netdev_get_config(ofport->netdev, &config)) {
6272                 const struct smap_node **nodes;
6273                 size_t i;
6274
6275                 nodes = smap_sort(&config);
6276                 for (i = 0; i < smap_count(&config); i++) {
6277                     const struct smap_node *node = nodes[i];
6278                     ds_put_format(ds, "%c %s=%s", i ? ',' : ':',
6279                                   node->key, node->value);
6280                 }
6281                 free(nodes);
6282             }
6283             smap_destroy(&config);
6284
6285             ds_put_char(ds, ')');
6286             ds_put_char(ds, '\n');
6287         }
6288         free(ports);
6289     }
6290     shash_destroy(&ofproto_shash);
6291     free(ofprotos);
6292 }
6293
6294 static void
6295 ofproto_unixctl_dpif_show(struct unixctl_conn *conn, int argc OVS_UNUSED,
6296                           const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED)
6297 {
6298     struct ds ds = DS_EMPTY_INITIALIZER;
6299     const struct shash_node **backers;
6300     int i;
6301
6302     backers = shash_sort(&all_dpif_backers);
6303     for (i = 0; i < shash_count(&all_dpif_backers); i++) {
6304         dpif_show_backer(backers[i]->data, &ds);
6305     }
6306     free(backers);
6307
6308     unixctl_command_reply(conn, ds_cstr(&ds));
6309     ds_destroy(&ds);
6310 }
6311
6312 /* Dump the megaflow (facet) cache.  This is useful to check the
6313  * correctness of flow wildcarding, since the same mechanism is used for
6314  * both xlate caching and kernel wildcarding.
6315  *
6316  * It's important to note that in the output the flow description uses
6317  * OpenFlow (OFP) ports, but the actions use datapath (ODP) ports.
6318  *
6319  * This command is only needed for advanced debugging, so it's not
6320  * documented in the man page. */
6321 static void
6322 ofproto_unixctl_dpif_dump_megaflows(struct unixctl_conn *conn,
6323                                     int argc OVS_UNUSED, const char *argv[],
6324                                     void *aux OVS_UNUSED)
6325 {
6326     struct ds ds = DS_EMPTY_INITIALIZER;
6327     const struct ofproto_dpif *ofproto;
6328     long long int now = time_msec();
6329     struct cls_cursor cursor;
6330     struct facet *facet;
6331
6332     ofproto = ofproto_dpif_lookup(argv[1]);
6333     if (!ofproto) {
6334         unixctl_command_reply_error(conn, "no such bridge");
6335         return;
6336     }
6337
6338     cls_cursor_init(&cursor, &ofproto->facets, NULL);
6339     CLS_CURSOR_FOR_EACH (facet, cr, &cursor) {
6340         cls_rule_format(&facet->cr, &ds);
6341         ds_put_cstr(&ds, ", ");
6342         ds_put_format(&ds, "n_subfacets:%zu, ", list_size(&facet->subfacets));
6343         ds_put_format(&ds, "used:%.3fs, ", (now - facet->used) / 1000.0);
6344         ds_put_cstr(&ds, "Datapath actions: ");
6345         if (facet->xout.slow) {
6346             uint64_t slow_path_stub[128 / 8];
6347             const struct nlattr *actions;
6348             size_t actions_len;
6349
6350             compose_slow_path(ofproto, &facet->flow, facet->xout.slow,
6351                               slow_path_stub, sizeof slow_path_stub,
6352                               &actions, &actions_len);
6353             format_odp_actions(&ds, actions, actions_len);
6354         } else {
6355             format_odp_actions(&ds, facet->xout.odp_actions.data,
6356                                facet->xout.odp_actions.size);
6357         }
6358         ds_put_cstr(&ds, "\n");
6359     }
6360
6361     ds_chomp(&ds, '\n');
6362     unixctl_command_reply(conn, ds_cstr(&ds));
6363     ds_destroy(&ds);
6364 }
6365
6366 static void
6367 ofproto_unixctl_dpif_dump_flows(struct unixctl_conn *conn,
6368                                 int argc OVS_UNUSED, const char *argv[],
6369                                 void *aux OVS_UNUSED)
6370 {
6371     struct ds ds = DS_EMPTY_INITIALIZER;
6372     const struct ofproto_dpif *ofproto;
6373     struct subfacet *subfacet;
6374
6375     ofproto = ofproto_dpif_lookup(argv[1]);
6376     if (!ofproto) {
6377         unixctl_command_reply_error(conn, "no such bridge");
6378         return;
6379     }
6380
6381     update_stats(ofproto->backer);
6382
6383     HMAP_FOR_EACH (subfacet, hmap_node, &ofproto->backer->subfacets) {
6384         struct facet *facet = subfacet->facet;
6385
6386         if (ofproto_dpif_cast(facet->rule->up.ofproto) != ofproto) {
6387             continue;
6388         }
6389
6390         odp_flow_key_format(subfacet->key, subfacet->key_len, &ds);
6391
6392         ds_put_format(&ds, ", packets:%"PRIu64", bytes:%"PRIu64", used:",
6393                       subfacet->dp_packet_count, subfacet->dp_byte_count);
6394         if (subfacet->used) {
6395             ds_put_format(&ds, "%.3fs",
6396                           (time_msec() - subfacet->used) / 1000.0);
6397         } else {
6398             ds_put_format(&ds, "never");
6399         }
6400         if (subfacet->facet->tcp_flags) {
6401             ds_put_cstr(&ds, ", flags:");
6402             packet_format_tcp_flags(&ds, subfacet->facet->tcp_flags);
6403         }
6404
6405         ds_put_cstr(&ds, ", actions:");
6406         if (facet->xout.slow) {
6407             uint64_t slow_path_stub[128 / 8];
6408             const struct nlattr *actions;
6409             size_t actions_len;
6410
6411             compose_slow_path(ofproto, &facet->flow, facet->xout.slow,
6412                               slow_path_stub, sizeof slow_path_stub,
6413                               &actions, &actions_len);
6414             format_odp_actions(&ds, actions, actions_len);
6415         } else {
6416             format_odp_actions(&ds, facet->xout.odp_actions.data,
6417                                facet->xout.odp_actions.size);
6418         }
6419         ds_put_char(&ds, '\n');
6420     }
6421
6422     unixctl_command_reply(conn, ds_cstr(&ds));
6423     ds_destroy(&ds);
6424 }
6425
6426 static void
6427 ofproto_unixctl_dpif_del_flows(struct unixctl_conn *conn,
6428                                int argc OVS_UNUSED, const char *argv[],
6429                                void *aux OVS_UNUSED)
6430 {
6431     struct ds ds = DS_EMPTY_INITIALIZER;
6432     struct ofproto_dpif *ofproto;
6433
6434     ofproto = ofproto_dpif_lookup(argv[1]);
6435     if (!ofproto) {
6436         unixctl_command_reply_error(conn, "no such bridge");
6437         return;
6438     }
6439
6440     flush(&ofproto->up);
6441
6442     unixctl_command_reply(conn, ds_cstr(&ds));
6443     ds_destroy(&ds);
6444 }
6445
6446 static void
6447 ofproto_dpif_unixctl_init(void)
6448 {
6449     static bool registered;
6450     if (registered) {
6451         return;
6452     }
6453     registered = true;
6454
6455     unixctl_command_register(
6456         "ofproto/trace",
6457         "[dp_name]|bridge odp_flow|br_flow [-generate|packet]",
6458         1, 3, ofproto_unixctl_trace, NULL);
6459     unixctl_command_register("fdb/flush", "[bridge]", 0, 1,
6460                              ofproto_unixctl_fdb_flush, NULL);
6461     unixctl_command_register("fdb/show", "bridge", 1, 1,
6462                              ofproto_unixctl_fdb_show, NULL);
6463     unixctl_command_register("ofproto/clog", "", 0, 0,
6464                              ofproto_dpif_clog, NULL);
6465     unixctl_command_register("ofproto/unclog", "", 0, 0,
6466                              ofproto_dpif_unclog, NULL);
6467     unixctl_command_register("ofproto/self-check", "[bridge]", 0, 1,
6468                              ofproto_dpif_self_check, NULL);
6469     unixctl_command_register("dpif/dump-dps", "", 0, 0,
6470                              ofproto_unixctl_dpif_dump_dps, NULL);
6471     unixctl_command_register("dpif/show", "", 0, 0, ofproto_unixctl_dpif_show,
6472                              NULL);
6473     unixctl_command_register("dpif/dump-flows", "bridge", 1, 1,
6474                              ofproto_unixctl_dpif_dump_flows, NULL);
6475     unixctl_command_register("dpif/del-flows", "bridge", 1, 1,
6476                              ofproto_unixctl_dpif_del_flows, NULL);
6477     unixctl_command_register("dpif/dump-megaflows", "bridge", 1, 1,
6478                              ofproto_unixctl_dpif_dump_megaflows, NULL);
6479 }
6480 \f
6481 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
6482  *
6483  * This is deprecated.  It is only for compatibility with broken device drivers
6484  * in old versions of Linux that do not properly support VLANs when VLAN
6485  * devices are not used.  When broken device drivers are no longer in
6486  * widespread use, we will delete these interfaces. */
6487
6488 static int
6489 set_realdev(struct ofport *ofport_, ofp_port_t realdev_ofp_port, int vid)
6490 {
6491     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofport_->ofproto);
6492     struct ofport_dpif *ofport = ofport_dpif_cast(ofport_);
6493
6494     if (realdev_ofp_port == ofport->realdev_ofp_port
6495         && vid == ofport->vlandev_vid) {
6496         return 0;
6497     }
6498
6499     ofproto->backer->need_revalidate = REV_RECONFIGURE;
6500
6501     if (ofport->realdev_ofp_port) {
6502         vsp_remove(ofport);
6503     }
6504     if (realdev_ofp_port && ofport->bundle) {
6505         /* vlandevs are enslaved to their realdevs, so they are not allowed to
6506          * themselves be part of a bundle. */
6507         bundle_set(ofport->up.ofproto, ofport->bundle, NULL);
6508     }
6509
6510     ofport->realdev_ofp_port = realdev_ofp_port;
6511     ofport->vlandev_vid = vid;
6512
6513     if (realdev_ofp_port) {
6514         vsp_add(ofport, realdev_ofp_port, vid);
6515     }
6516
6517     return 0;
6518 }
6519
6520 static uint32_t
6521 hash_realdev_vid(ofp_port_t realdev_ofp_port, int vid)
6522 {
6523     return hash_2words(ofp_to_u16(realdev_ofp_port), vid);
6524 }
6525
6526 /* Returns the OFP port number of the Linux VLAN device that corresponds to
6527  * 'vlan_tci' on the network device with port number 'realdev_ofp_port' in
6528  * 'struct ofport_dpif'.  For example, given 'realdev_ofp_port' of eth0 and
6529  * 'vlan_tci' 9, it would return the port number of eth0.9.
6530  *
6531  * Unless VLAN splinters are enabled for port 'realdev_ofp_port', this
6532  * function just returns its 'realdev_ofp_port' argument. */
6533 ofp_port_t
6534 vsp_realdev_to_vlandev(const struct ofproto_dpif *ofproto,
6535                        ofp_port_t realdev_ofp_port, ovs_be16 vlan_tci)
6536 {
6537     if (!hmap_is_empty(&ofproto->realdev_vid_map)) {
6538         int vid = vlan_tci_to_vid(vlan_tci);
6539         const struct vlan_splinter *vsp;
6540
6541         HMAP_FOR_EACH_WITH_HASH (vsp, realdev_vid_node,
6542                                  hash_realdev_vid(realdev_ofp_port, vid),
6543                                  &ofproto->realdev_vid_map) {
6544             if (vsp->realdev_ofp_port == realdev_ofp_port
6545                 && vsp->vid == vid) {
6546                 return vsp->vlandev_ofp_port;
6547             }
6548         }
6549     }
6550     return realdev_ofp_port;
6551 }
6552
6553 static struct vlan_splinter *
6554 vlandev_find(const struct ofproto_dpif *ofproto, ofp_port_t vlandev_ofp_port)
6555 {
6556     struct vlan_splinter *vsp;
6557
6558     HMAP_FOR_EACH_WITH_HASH (vsp, vlandev_node,
6559                              hash_int(ofp_to_u16(vlandev_ofp_port), 0),
6560                              &ofproto->vlandev_map) {
6561         if (vsp->vlandev_ofp_port == vlandev_ofp_port) {
6562             return vsp;
6563         }
6564     }
6565
6566     return NULL;
6567 }
6568
6569 /* Returns the OpenFlow port number of the "real" device underlying the Linux
6570  * VLAN device with OpenFlow port number 'vlandev_ofp_port' and stores the
6571  * VLAN VID of the Linux VLAN device in '*vid'.  For example, given
6572  * 'vlandev_ofp_port' of eth0.9, it would return the OpenFlow port number of
6573  * eth0 and store 9 in '*vid'.
6574  *
6575  * Returns 0 and does not modify '*vid' if 'vlandev_ofp_port' is not a Linux
6576  * VLAN device.  Unless VLAN splinters are enabled, this is what this function
6577  * always does.*/
6578 static ofp_port_t
6579 vsp_vlandev_to_realdev(const struct ofproto_dpif *ofproto,
6580                        ofp_port_t vlandev_ofp_port, int *vid)
6581 {
6582     if (!hmap_is_empty(&ofproto->vlandev_map)) {
6583         const struct vlan_splinter *vsp;
6584
6585         vsp = vlandev_find(ofproto, vlandev_ofp_port);
6586         if (vsp) {
6587             if (vid) {
6588                 *vid = vsp->vid;
6589             }
6590             return vsp->realdev_ofp_port;
6591         }
6592     }
6593     return 0;
6594 }
6595
6596 /* Given 'flow', a flow representing a packet received on 'ofproto', checks
6597  * whether 'flow->in_port' represents a Linux VLAN device.  If so, changes
6598  * 'flow->in_port' to the "real" device backing the VLAN device, sets
6599  * 'flow->vlan_tci' to the VLAN VID, and returns true.  Otherwise (which is
6600  * always the case unless VLAN splinters are enabled), returns false without
6601  * making any changes. */
6602 static bool
6603 vsp_adjust_flow(const struct ofproto_dpif *ofproto, struct flow *flow)
6604 {
6605     ofp_port_t realdev;
6606     int vid;
6607
6608     realdev = vsp_vlandev_to_realdev(ofproto, flow->in_port.ofp_port, &vid);
6609     if (!realdev) {
6610         return false;
6611     }
6612
6613     /* Cause the flow to be processed as if it came in on the real device with
6614      * the VLAN device's VLAN ID. */
6615     flow->in_port.ofp_port = realdev;
6616     flow->vlan_tci = htons((vid & VLAN_VID_MASK) | VLAN_CFI);
6617     return true;
6618 }
6619
6620 static void
6621 vsp_remove(struct ofport_dpif *port)
6622 {
6623     struct ofproto_dpif *ofproto = ofproto_dpif_cast(port->up.ofproto);
6624     struct vlan_splinter *vsp;
6625
6626     vsp = vlandev_find(ofproto, port->up.ofp_port);
6627     if (vsp) {
6628         hmap_remove(&ofproto->vlandev_map, &vsp->vlandev_node);
6629         hmap_remove(&ofproto->realdev_vid_map, &vsp->realdev_vid_node);
6630         free(vsp);
6631
6632         port->realdev_ofp_port = 0;
6633     } else {
6634         VLOG_ERR("missing vlan device record");
6635     }
6636 }
6637
6638 static void
6639 vsp_add(struct ofport_dpif *port, ofp_port_t realdev_ofp_port, int vid)
6640 {
6641     struct ofproto_dpif *ofproto = ofproto_dpif_cast(port->up.ofproto);
6642
6643     if (!vsp_vlandev_to_realdev(ofproto, port->up.ofp_port, NULL)
6644         && (vsp_realdev_to_vlandev(ofproto, realdev_ofp_port, htons(vid))
6645             == realdev_ofp_port)) {
6646         struct vlan_splinter *vsp;
6647
6648         vsp = xmalloc(sizeof *vsp);
6649         hmap_insert(&ofproto->vlandev_map, &vsp->vlandev_node,
6650                     hash_int(ofp_to_u16(port->up.ofp_port), 0));
6651         hmap_insert(&ofproto->realdev_vid_map, &vsp->realdev_vid_node,
6652                     hash_realdev_vid(realdev_ofp_port, vid));
6653         vsp->realdev_ofp_port = realdev_ofp_port;
6654         vsp->vlandev_ofp_port = port->up.ofp_port;
6655         vsp->vid = vid;
6656
6657         port->realdev_ofp_port = realdev_ofp_port;
6658     } else {
6659         VLOG_ERR("duplicate vlan device record");
6660     }
6661 }
6662
6663 odp_port_t
6664 ofp_port_to_odp_port(const struct ofproto_dpif *ofproto, ofp_port_t ofp_port)
6665 {
6666     const struct ofport_dpif *ofport = get_ofp_port(ofproto, ofp_port);
6667     return ofport ? ofport->odp_port : ODPP_NONE;
6668 }
6669
6670 static struct ofport_dpif *
6671 odp_port_to_ofport(const struct dpif_backer *backer, odp_port_t odp_port)
6672 {
6673     struct ofport_dpif *port;
6674
6675     HMAP_FOR_EACH_IN_BUCKET (port, odp_port_node,
6676                              hash_int(odp_to_u32(odp_port), 0),
6677                              &backer->odp_to_ofport_map) {
6678         if (port->odp_port == odp_port) {
6679             return port;
6680         }
6681     }
6682
6683     return NULL;
6684 }
6685
6686 static ofp_port_t
6687 odp_port_to_ofp_port(const struct ofproto_dpif *ofproto, odp_port_t odp_port)
6688 {
6689     struct ofport_dpif *port;
6690
6691     port = odp_port_to_ofport(ofproto->backer, odp_port);
6692     if (port && &ofproto->up == port->up.ofproto) {
6693         return port->up.ofp_port;
6694     } else {
6695         return OFPP_NONE;
6696     }
6697 }
6698
6699 /* Compute exponentially weighted moving average, adding 'new' as the newest,
6700  * most heavily weighted element.  'base' designates the rate of decay: after
6701  * 'base' further updates, 'new''s weight in the EWMA decays to about 1/e
6702  * (about .37). */
6703 static void
6704 exp_mavg(double *avg, int base, double new)
6705 {
6706     *avg = (*avg * (base - 1) + new) / base;
6707 }
6708
6709 static void
6710 update_moving_averages(struct dpif_backer *backer)
6711 {
6712     const int min_ms = 60 * 1000; /* milliseconds in one minute. */
6713     long long int minutes = (time_msec() - backer->created) / min_ms;
6714
6715     if (minutes > 0) {
6716         backer->lifetime.add_rate = (double) backer->total_subfacet_add_count
6717             / minutes;
6718         backer->lifetime.del_rate = (double) backer->total_subfacet_del_count
6719             / minutes;
6720     } else {
6721         backer->lifetime.add_rate = 0.0;
6722         backer->lifetime.del_rate = 0.0;
6723     }
6724
6725     /* Update hourly averages on the minute boundaries. */
6726     if (time_msec() - backer->last_minute >= min_ms) {
6727         exp_mavg(&backer->hourly.add_rate, 60, backer->subfacet_add_count);
6728         exp_mavg(&backer->hourly.del_rate, 60, backer->subfacet_del_count);
6729
6730         /* Update daily averages on the hour boundaries. */
6731         if ((backer->last_minute - backer->created) / min_ms % 60 == 59) {
6732             exp_mavg(&backer->daily.add_rate, 24, backer->hourly.add_rate);
6733             exp_mavg(&backer->daily.del_rate, 24, backer->hourly.del_rate);
6734         }
6735
6736         backer->total_subfacet_add_count += backer->subfacet_add_count;
6737         backer->total_subfacet_del_count += backer->subfacet_del_count;
6738         backer->subfacet_add_count = 0;
6739         backer->subfacet_del_count = 0;
6740         backer->last_minute += min_ms;
6741     }
6742 }
6743
6744 const struct ofproto_class ofproto_dpif_class = {
6745     init,
6746     enumerate_types,
6747     enumerate_names,
6748     del,
6749     port_open_type,
6750     type_run,
6751     type_run_fast,
6752     type_wait,
6753     alloc,
6754     construct,
6755     destruct,
6756     dealloc,
6757     run,
6758     run_fast,
6759     wait,
6760     get_memory_usage,
6761     flush,
6762     get_features,
6763     get_tables,
6764     port_alloc,
6765     port_construct,
6766     port_destruct,
6767     port_dealloc,
6768     port_modified,
6769     port_reconfigured,
6770     port_query_by_name,
6771     port_add,
6772     port_del,
6773     port_get_stats,
6774     port_dump_start,
6775     port_dump_next,
6776     port_dump_done,
6777     port_poll,
6778     port_poll_wait,
6779     port_is_lacp_current,
6780     NULL,                       /* rule_choose_table */
6781     rule_alloc,
6782     rule_construct,
6783     rule_destruct,
6784     rule_dealloc,
6785     rule_get_stats,
6786     rule_execute,
6787     rule_modify_actions,
6788     set_frag_handling,
6789     packet_out,
6790     set_netflow,
6791     get_netflow_ids,
6792     set_sflow,
6793     set_ipfix,
6794     set_cfm,
6795     get_cfm_status,
6796     set_bfd,
6797     get_bfd_status,
6798     set_stp,
6799     get_stp_status,
6800     set_stp_port,
6801     get_stp_port_status,
6802     set_queues,
6803     bundle_set,
6804     bundle_remove,
6805     mirror_set,
6806     mirror_get_stats,
6807     set_flood_vlans,
6808     is_mirror_output_bundle,
6809     forward_bpdu_changed,
6810     set_mac_table_config,
6811     set_realdev,
6812 };