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_odp_port(port->odp_port));
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     ofproto->backer->need_revalidate = REV_RECONFIGURE;
1524
1525     dp_port_name = netdev_vport_get_dpif_port(port->up.netdev, namebuf,
1526                                               sizeof namebuf);
1527     if (dpif_port_exists(ofproto->backer->dpif, dp_port_name)) {
1528         /* The underlying device is still there, so delete it.  This
1529          * happens when the ofproto is being destroyed, since the caller
1530          * assumes that removal of attached ports will happen as part of
1531          * destruction. */
1532         if (!port->tnl_port) {
1533             dpif_port_del(ofproto->backer->dpif, port->odp_port);
1534         }
1535     }
1536
1537     if (port->peer) {
1538         port->peer->peer = NULL;
1539         port->peer = NULL;
1540     }
1541
1542     if (port->odp_port != ODPP_NONE && !port->tnl_port) {
1543         hmap_remove(&ofproto->backer->odp_to_ofport_map, &port->odp_port_node);
1544     }
1545
1546     tnl_port_del(port->tnl_port);
1547     sset_find_and_delete(&ofproto->ports, devname);
1548     sset_find_and_delete(&ofproto->ghost_ports, devname);
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 =
1576             REV_RECONFIGURE;
1577     }
1578
1579     ofport_update_peer(port);
1580 }
1581
1582 static void
1583 port_reconfigured(struct ofport *port_, enum ofputil_port_config old_config)
1584 {
1585     struct ofport_dpif *port = ofport_dpif_cast(port_);
1586     struct ofproto_dpif *ofproto = ofproto_dpif_cast(port->up.ofproto);
1587     enum ofputil_port_config changed = old_config ^ port->up.pp.config;
1588
1589     if (changed & (OFPUTIL_PC_NO_RECV | OFPUTIL_PC_NO_RECV_STP |
1590                    OFPUTIL_PC_NO_FWD | OFPUTIL_PC_NO_FLOOD |
1591                    OFPUTIL_PC_NO_PACKET_IN)) {
1592         ofproto->backer->need_revalidate = REV_RECONFIGURE;
1593
1594         if (changed & OFPUTIL_PC_NO_FLOOD && port->bundle) {
1595             bundle_update(port->bundle);
1596         }
1597     }
1598 }
1599
1600 static int
1601 set_sflow(struct ofproto *ofproto_,
1602           const struct ofproto_sflow_options *sflow_options)
1603 {
1604     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
1605     struct dpif_sflow *ds = ofproto->sflow;
1606
1607     if (sflow_options) {
1608         if (!ds) {
1609             struct ofport_dpif *ofport;
1610
1611             ds = ofproto->sflow = dpif_sflow_create();
1612             HMAP_FOR_EACH (ofport, up.hmap_node, &ofproto->up.ports) {
1613                 dpif_sflow_add_port(ds, &ofport->up, ofport->odp_port);
1614             }
1615             ofproto->backer->need_revalidate = REV_RECONFIGURE;
1616         }
1617         dpif_sflow_set_options(ds, sflow_options);
1618     } else {
1619         if (ds) {
1620             dpif_sflow_destroy(ds);
1621             ofproto->backer->need_revalidate = REV_RECONFIGURE;
1622             ofproto->sflow = NULL;
1623         }
1624     }
1625     return 0;
1626 }
1627
1628 static int
1629 set_ipfix(
1630     struct ofproto *ofproto_,
1631     const struct ofproto_ipfix_bridge_exporter_options *bridge_exporter_options,
1632     const struct ofproto_ipfix_flow_exporter_options *flow_exporters_options,
1633     size_t n_flow_exporters_options)
1634 {
1635     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
1636     struct dpif_ipfix *di = ofproto->ipfix;
1637
1638     if (bridge_exporter_options || flow_exporters_options) {
1639         if (!di) {
1640             di = ofproto->ipfix = dpif_ipfix_create();
1641         }
1642         dpif_ipfix_set_options(
1643             di, bridge_exporter_options, flow_exporters_options,
1644             n_flow_exporters_options);
1645     } else {
1646         if (di) {
1647             dpif_ipfix_destroy(di);
1648             ofproto->ipfix = NULL;
1649         }
1650     }
1651     return 0;
1652 }
1653
1654 static int
1655 set_cfm(struct ofport *ofport_, const struct cfm_settings *s)
1656 {
1657     struct ofport_dpif *ofport = ofport_dpif_cast(ofport_);
1658     int error;
1659
1660     if (!s) {
1661         error = 0;
1662     } else {
1663         if (!ofport->cfm) {
1664             struct ofproto_dpif *ofproto;
1665
1666             ofproto = ofproto_dpif_cast(ofport->up.ofproto);
1667             ofproto->backer->need_revalidate = REV_RECONFIGURE;
1668             ofport->cfm = cfm_create(ofport->up.netdev);
1669         }
1670
1671         if (cfm_configure(ofport->cfm, s)) {
1672             return 0;
1673         }
1674
1675         error = EINVAL;
1676     }
1677     cfm_destroy(ofport->cfm);
1678     ofport->cfm = NULL;
1679     return error;
1680 }
1681
1682 static bool
1683 get_cfm_status(const struct ofport *ofport_,
1684                struct ofproto_cfm_status *status)
1685 {
1686     struct ofport_dpif *ofport = ofport_dpif_cast(ofport_);
1687
1688     if (ofport->cfm) {
1689         status->faults = cfm_get_fault(ofport->cfm);
1690         status->remote_opstate = cfm_get_opup(ofport->cfm);
1691         status->health = cfm_get_health(ofport->cfm);
1692         cfm_get_remote_mpids(ofport->cfm, &status->rmps, &status->n_rmps);
1693         return true;
1694     } else {
1695         return false;
1696     }
1697 }
1698
1699 static int
1700 set_bfd(struct ofport *ofport_, const struct smap *cfg)
1701 {
1702     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofport_->ofproto);
1703     struct ofport_dpif *ofport = ofport_dpif_cast(ofport_);
1704     struct bfd *old;
1705
1706     old = ofport->bfd;
1707     ofport->bfd = bfd_configure(old, netdev_get_name(ofport->up.netdev), cfg);
1708     if (ofport->bfd != old) {
1709         ofproto->backer->need_revalidate = REV_RECONFIGURE;
1710     }
1711
1712     return 0;
1713 }
1714
1715 static int
1716 get_bfd_status(struct ofport *ofport_, struct smap *smap)
1717 {
1718     struct ofport_dpif *ofport = ofport_dpif_cast(ofport_);
1719
1720     if (ofport->bfd) {
1721         bfd_get_status(ofport->bfd, smap);
1722         return 0;
1723     } else {
1724         return ENOENT;
1725     }
1726 }
1727 \f
1728 /* Spanning Tree. */
1729
1730 static void
1731 send_bpdu_cb(struct ofpbuf *pkt, int port_num, void *ofproto_)
1732 {
1733     struct ofproto_dpif *ofproto = ofproto_;
1734     struct stp_port *sp = stp_get_port(ofproto->stp, port_num);
1735     struct ofport_dpif *ofport;
1736
1737     ofport = stp_port_get_aux(sp);
1738     if (!ofport) {
1739         VLOG_WARN_RL(&rl, "%s: cannot send BPDU on unknown port %d",
1740                      ofproto->up.name, port_num);
1741     } else {
1742         struct eth_header *eth = pkt->l2;
1743
1744         netdev_get_etheraddr(ofport->up.netdev, eth->eth_src);
1745         if (eth_addr_is_zero(eth->eth_src)) {
1746             VLOG_WARN_RL(&rl, "%s: cannot send BPDU on port %d "
1747                          "with unknown MAC", ofproto->up.name, port_num);
1748         } else {
1749             send_packet(ofport, pkt);
1750         }
1751     }
1752     ofpbuf_delete(pkt);
1753 }
1754
1755 /* Configures STP on 'ofproto_' using the settings defined in 's'. */
1756 static int
1757 set_stp(struct ofproto *ofproto_, const struct ofproto_stp_settings *s)
1758 {
1759     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
1760
1761     /* Only revalidate flows if the configuration changed. */
1762     if (!s != !ofproto->stp) {
1763         ofproto->backer->need_revalidate = REV_RECONFIGURE;
1764     }
1765
1766     if (s) {
1767         if (!ofproto->stp) {
1768             ofproto->stp = stp_create(ofproto_->name, s->system_id,
1769                                       send_bpdu_cb, ofproto);
1770             ofproto->stp_last_tick = time_msec();
1771         }
1772
1773         stp_set_bridge_id(ofproto->stp, s->system_id);
1774         stp_set_bridge_priority(ofproto->stp, s->priority);
1775         stp_set_hello_time(ofproto->stp, s->hello_time);
1776         stp_set_max_age(ofproto->stp, s->max_age);
1777         stp_set_forward_delay(ofproto->stp, s->fwd_delay);
1778     }  else {
1779         struct ofport *ofport;
1780
1781         HMAP_FOR_EACH (ofport, hmap_node, &ofproto->up.ports) {
1782             set_stp_port(ofport, NULL);
1783         }
1784
1785         stp_destroy(ofproto->stp);
1786         ofproto->stp = NULL;
1787     }
1788
1789     return 0;
1790 }
1791
1792 static int
1793 get_stp_status(struct ofproto *ofproto_, struct ofproto_stp_status *s)
1794 {
1795     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
1796
1797     if (ofproto->stp) {
1798         s->enabled = true;
1799         s->bridge_id = stp_get_bridge_id(ofproto->stp);
1800         s->designated_root = stp_get_designated_root(ofproto->stp);
1801         s->root_path_cost = stp_get_root_path_cost(ofproto->stp);
1802     } else {
1803         s->enabled = false;
1804     }
1805
1806     return 0;
1807 }
1808
1809 static void
1810 update_stp_port_state(struct ofport_dpif *ofport)
1811 {
1812     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofport->up.ofproto);
1813     enum stp_state state;
1814
1815     /* Figure out new state. */
1816     state = ofport->stp_port ? stp_port_get_state(ofport->stp_port)
1817                              : STP_DISABLED;
1818
1819     /* Update state. */
1820     if (ofport->stp_state != state) {
1821         enum ofputil_port_state of_state;
1822         bool fwd_change;
1823
1824         VLOG_DBG_RL(&rl, "port %s: STP state changed from %s to %s",
1825                     netdev_get_name(ofport->up.netdev),
1826                     stp_state_name(ofport->stp_state),
1827                     stp_state_name(state));
1828         if (stp_learn_in_state(ofport->stp_state)
1829                 != stp_learn_in_state(state)) {
1830             /* xxx Learning action flows should also be flushed. */
1831             mac_learning_flush(ofproto->ml,
1832                                &ofproto->backer->revalidate_set);
1833         }
1834         fwd_change = stp_forward_in_state(ofport->stp_state)
1835                         != stp_forward_in_state(state);
1836
1837         ofproto->backer->need_revalidate = REV_STP;
1838         ofport->stp_state = state;
1839         ofport->stp_state_entered = time_msec();
1840
1841         if (fwd_change && ofport->bundle) {
1842             bundle_update(ofport->bundle);
1843         }
1844
1845         /* Update the STP state bits in the OpenFlow port description. */
1846         of_state = ofport->up.pp.state & ~OFPUTIL_PS_STP_MASK;
1847         of_state |= (state == STP_LISTENING ? OFPUTIL_PS_STP_LISTEN
1848                      : state == STP_LEARNING ? OFPUTIL_PS_STP_LEARN
1849                      : state == STP_FORWARDING ? OFPUTIL_PS_STP_FORWARD
1850                      : state == STP_BLOCKING ?  OFPUTIL_PS_STP_BLOCK
1851                      : 0);
1852         ofproto_port_set_state(&ofport->up, of_state);
1853     }
1854 }
1855
1856 /* Configures STP on 'ofport_' using the settings defined in 's'.  The
1857  * caller is responsible for assigning STP port numbers and ensuring
1858  * there are no duplicates. */
1859 static int
1860 set_stp_port(struct ofport *ofport_,
1861              const struct ofproto_port_stp_settings *s)
1862 {
1863     struct ofport_dpif *ofport = ofport_dpif_cast(ofport_);
1864     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofport->up.ofproto);
1865     struct stp_port *sp = ofport->stp_port;
1866
1867     if (!s || !s->enable) {
1868         if (sp) {
1869             ofport->stp_port = NULL;
1870             stp_port_disable(sp);
1871             update_stp_port_state(ofport);
1872         }
1873         return 0;
1874     } else if (sp && stp_port_no(sp) != s->port_num
1875             && ofport == stp_port_get_aux(sp)) {
1876         /* The port-id changed, so disable the old one if it's not
1877          * already in use by another port. */
1878         stp_port_disable(sp);
1879     }
1880
1881     sp = ofport->stp_port = stp_get_port(ofproto->stp, s->port_num);
1882     stp_port_enable(sp);
1883
1884     stp_port_set_aux(sp, ofport);
1885     stp_port_set_priority(sp, s->priority);
1886     stp_port_set_path_cost(sp, s->path_cost);
1887
1888     update_stp_port_state(ofport);
1889
1890     return 0;
1891 }
1892
1893 static int
1894 get_stp_port_status(struct ofport *ofport_,
1895                     struct ofproto_port_stp_status *s)
1896 {
1897     struct ofport_dpif *ofport = ofport_dpif_cast(ofport_);
1898     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofport->up.ofproto);
1899     struct stp_port *sp = ofport->stp_port;
1900
1901     if (!ofproto->stp || !sp) {
1902         s->enabled = false;
1903         return 0;
1904     }
1905
1906     s->enabled = true;
1907     s->port_id = stp_port_get_id(sp);
1908     s->state = stp_port_get_state(sp);
1909     s->sec_in_state = (time_msec() - ofport->stp_state_entered) / 1000;
1910     s->role = stp_port_get_role(sp);
1911     stp_port_get_counts(sp, &s->tx_count, &s->rx_count, &s->error_count);
1912
1913     return 0;
1914 }
1915
1916 static void
1917 stp_run(struct ofproto_dpif *ofproto)
1918 {
1919     if (ofproto->stp) {
1920         long long int now = time_msec();
1921         long long int elapsed = now - ofproto->stp_last_tick;
1922         struct stp_port *sp;
1923
1924         if (elapsed > 0) {
1925             stp_tick(ofproto->stp, MIN(INT_MAX, elapsed));
1926             ofproto->stp_last_tick = now;
1927         }
1928         while (stp_get_changed_port(ofproto->stp, &sp)) {
1929             struct ofport_dpif *ofport = stp_port_get_aux(sp);
1930
1931             if (ofport) {
1932                 update_stp_port_state(ofport);
1933             }
1934         }
1935
1936         if (stp_check_and_reset_fdb_flush(ofproto->stp)) {
1937             mac_learning_flush(ofproto->ml, &ofproto->backer->revalidate_set);
1938         }
1939     }
1940 }
1941
1942 static void
1943 stp_wait(struct ofproto_dpif *ofproto)
1944 {
1945     if (ofproto->stp) {
1946         poll_timer_wait(1000);
1947     }
1948 }
1949
1950 /* Returns true if STP should process 'flow'.  Sets fields in 'wc' that
1951  * were used to make the determination.*/
1952 bool
1953 stp_should_process_flow(const struct flow *flow, struct flow_wildcards *wc)
1954 {
1955     memset(&wc->masks.dl_dst, 0xff, sizeof wc->masks.dl_dst);
1956     return eth_addr_equals(flow->dl_dst, eth_addr_stp);
1957 }
1958
1959 void
1960 stp_process_packet(const struct ofport_dpif *ofport,
1961                    const struct ofpbuf *packet)
1962 {
1963     struct ofpbuf payload = *packet;
1964     struct eth_header *eth = payload.data;
1965     struct stp_port *sp = ofport->stp_port;
1966
1967     /* Sink packets on ports that have STP disabled when the bridge has
1968      * STP enabled. */
1969     if (!sp || stp_port_get_state(sp) == STP_DISABLED) {
1970         return;
1971     }
1972
1973     /* Trim off padding on payload. */
1974     if (payload.size > ntohs(eth->eth_type) + ETH_HEADER_LEN) {
1975         payload.size = ntohs(eth->eth_type) + ETH_HEADER_LEN;
1976     }
1977
1978     if (ofpbuf_try_pull(&payload, ETH_HEADER_LEN + LLC_HEADER_LEN)) {
1979         stp_received_bpdu(sp, payload.data, payload.size);
1980     }
1981 }
1982 \f
1983 int
1984 ofproto_dpif_queue_to_priority(const struct ofproto_dpif *ofproto,
1985                                uint32_t queue_id, uint32_t *priority)
1986 {
1987     return dpif_queue_to_priority(ofproto->backer->dpif, queue_id, priority);
1988 }
1989
1990 static struct priority_to_dscp *
1991 get_priority(const struct ofport_dpif *ofport, uint32_t priority)
1992 {
1993     struct priority_to_dscp *pdscp;
1994     uint32_t hash;
1995
1996     hash = hash_int(priority, 0);
1997     HMAP_FOR_EACH_IN_BUCKET (pdscp, hmap_node, hash, &ofport->priorities) {
1998         if (pdscp->priority == priority) {
1999             return pdscp;
2000         }
2001     }
2002     return NULL;
2003 }
2004
2005 bool
2006 ofproto_dpif_dscp_from_priority(const struct ofport_dpif *ofport,
2007                                 uint32_t priority, uint8_t *dscp)
2008 {
2009     struct priority_to_dscp *pdscp = get_priority(ofport, priority);
2010     *dscp = pdscp ? pdscp->dscp : 0;
2011     return pdscp != NULL;
2012 }
2013
2014 static void
2015 ofport_clear_priorities(struct ofport_dpif *ofport)
2016 {
2017     struct priority_to_dscp *pdscp, *next;
2018
2019     HMAP_FOR_EACH_SAFE (pdscp, next, hmap_node, &ofport->priorities) {
2020         hmap_remove(&ofport->priorities, &pdscp->hmap_node);
2021         free(pdscp);
2022     }
2023 }
2024
2025 static int
2026 set_queues(struct ofport *ofport_,
2027            const struct ofproto_port_queue *qdscp_list,
2028            size_t n_qdscp)
2029 {
2030     struct ofport_dpif *ofport = ofport_dpif_cast(ofport_);
2031     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofport->up.ofproto);
2032     struct hmap new = HMAP_INITIALIZER(&new);
2033     size_t i;
2034
2035     for (i = 0; i < n_qdscp; i++) {
2036         struct priority_to_dscp *pdscp;
2037         uint32_t priority;
2038         uint8_t dscp;
2039
2040         dscp = (qdscp_list[i].dscp << 2) & IP_DSCP_MASK;
2041         if (dpif_queue_to_priority(ofproto->backer->dpif, qdscp_list[i].queue,
2042                                    &priority)) {
2043             continue;
2044         }
2045
2046         pdscp = get_priority(ofport, priority);
2047         if (pdscp) {
2048             hmap_remove(&ofport->priorities, &pdscp->hmap_node);
2049         } else {
2050             pdscp = xmalloc(sizeof *pdscp);
2051             pdscp->priority = priority;
2052             pdscp->dscp = dscp;
2053             ofproto->backer->need_revalidate = REV_RECONFIGURE;
2054         }
2055
2056         if (pdscp->dscp != dscp) {
2057             pdscp->dscp = dscp;
2058             ofproto->backer->need_revalidate = REV_RECONFIGURE;
2059         }
2060
2061         hmap_insert(&new, &pdscp->hmap_node, hash_int(pdscp->priority, 0));
2062     }
2063
2064     if (!hmap_is_empty(&ofport->priorities)) {
2065         ofport_clear_priorities(ofport);
2066         ofproto->backer->need_revalidate = REV_RECONFIGURE;
2067     }
2068
2069     hmap_swap(&new, &ofport->priorities);
2070     hmap_destroy(&new);
2071
2072     return 0;
2073 }
2074 \f
2075 /* Bundles. */
2076
2077 /* Expires all MAC learning entries associated with 'bundle' and forces its
2078  * ofproto to revalidate every flow.
2079  *
2080  * Normally MAC learning entries are removed only from the ofproto associated
2081  * with 'bundle', but if 'all_ofprotos' is true, then the MAC learning entries
2082  * are removed from every ofproto.  When patch ports and SLB bonds are in use
2083  * and a VM migration happens and the gratuitous ARPs are somehow lost, this
2084  * avoids a MAC_ENTRY_IDLE_TIME delay before the migrated VM can communicate
2085  * with the host from which it migrated. */
2086 static void
2087 bundle_flush_macs(struct ofbundle *bundle, bool all_ofprotos)
2088 {
2089     struct ofproto_dpif *ofproto = bundle->ofproto;
2090     struct mac_learning *ml = ofproto->ml;
2091     struct mac_entry *mac, *next_mac;
2092
2093     ofproto->backer->need_revalidate = REV_RECONFIGURE;
2094     LIST_FOR_EACH_SAFE (mac, next_mac, lru_node, &ml->lrus) {
2095         if (mac->port.p == bundle) {
2096             if (all_ofprotos) {
2097                 struct ofproto_dpif *o;
2098
2099                 HMAP_FOR_EACH (o, all_ofproto_dpifs_node, &all_ofproto_dpifs) {
2100                     if (o != ofproto) {
2101                         struct mac_entry *e;
2102
2103                         e = mac_learning_lookup(o->ml, mac->mac, mac->vlan,
2104                                                 NULL);
2105                         if (e) {
2106                             mac_learning_expire(o->ml, e);
2107                         }
2108                     }
2109                 }
2110             }
2111
2112             mac_learning_expire(ml, mac);
2113         }
2114     }
2115 }
2116
2117 static struct ofbundle *
2118 bundle_lookup(const struct ofproto_dpif *ofproto, void *aux)
2119 {
2120     struct ofbundle *bundle;
2121
2122     HMAP_FOR_EACH_IN_BUCKET (bundle, hmap_node, hash_pointer(aux, 0),
2123                              &ofproto->bundles) {
2124         if (bundle->aux == aux) {
2125             return bundle;
2126         }
2127     }
2128     return NULL;
2129 }
2130
2131 /* Looks up each of the 'n_auxes' pointers in 'auxes' as bundles and adds the
2132  * ones that are found to 'bundles'. */
2133 static void
2134 bundle_lookup_multiple(struct ofproto_dpif *ofproto,
2135                        void **auxes, size_t n_auxes,
2136                        struct hmapx *bundles)
2137 {
2138     size_t i;
2139
2140     hmapx_init(bundles);
2141     for (i = 0; i < n_auxes; i++) {
2142         struct ofbundle *bundle = bundle_lookup(ofproto, auxes[i]);
2143         if (bundle) {
2144             hmapx_add(bundles, bundle);
2145         }
2146     }
2147 }
2148
2149 static void
2150 bundle_update(struct ofbundle *bundle)
2151 {
2152     struct ofport_dpif *port;
2153
2154     bundle->floodable = true;
2155     LIST_FOR_EACH (port, bundle_node, &bundle->ports) {
2156         if (port->up.pp.config & OFPUTIL_PC_NO_FLOOD
2157             || !stp_forward_in_state(port->stp_state)) {
2158             bundle->floodable = false;
2159             break;
2160         }
2161     }
2162 }
2163
2164 static void
2165 bundle_del_port(struct ofport_dpif *port)
2166 {
2167     struct ofbundle *bundle = port->bundle;
2168
2169     bundle->ofproto->backer->need_revalidate = REV_RECONFIGURE;
2170
2171     list_remove(&port->bundle_node);
2172     port->bundle = NULL;
2173
2174     if (bundle->lacp) {
2175         lacp_slave_unregister(bundle->lacp, port);
2176     }
2177     if (bundle->bond) {
2178         bond_slave_unregister(bundle->bond, port);
2179     }
2180
2181     bundle_update(bundle);
2182 }
2183
2184 static bool
2185 bundle_add_port(struct ofbundle *bundle, ofp_port_t ofp_port,
2186                 struct lacp_slave_settings *lacp)
2187 {
2188     struct ofport_dpif *port;
2189
2190     port = get_ofp_port(bundle->ofproto, ofp_port);
2191     if (!port) {
2192         return false;
2193     }
2194
2195     if (port->bundle != bundle) {
2196         bundle->ofproto->backer->need_revalidate = REV_RECONFIGURE;
2197         if (port->bundle) {
2198             bundle_del_port(port);
2199         }
2200
2201         port->bundle = bundle;
2202         list_push_back(&bundle->ports, &port->bundle_node);
2203         if (port->up.pp.config & OFPUTIL_PC_NO_FLOOD
2204             || !stp_forward_in_state(port->stp_state)) {
2205             bundle->floodable = false;
2206         }
2207     }
2208     if (lacp) {
2209         bundle->ofproto->backer->need_revalidate = REV_RECONFIGURE;
2210         lacp_slave_register(bundle->lacp, port, lacp);
2211     }
2212
2213     return true;
2214 }
2215
2216 static void
2217 bundle_destroy(struct ofbundle *bundle)
2218 {
2219     struct ofproto_dpif *ofproto;
2220     struct ofport_dpif *port, *next_port;
2221     int i;
2222
2223     if (!bundle) {
2224         return;
2225     }
2226
2227     ofproto = bundle->ofproto;
2228     for (i = 0; i < MAX_MIRRORS; i++) {
2229         struct ofmirror *m = ofproto->mirrors[i];
2230         if (m) {
2231             if (m->out == bundle) {
2232                 mirror_destroy(m);
2233             } else if (hmapx_find_and_delete(&m->srcs, bundle)
2234                        || hmapx_find_and_delete(&m->dsts, bundle)) {
2235                 ofproto->backer->need_revalidate = REV_RECONFIGURE;
2236             }
2237         }
2238     }
2239
2240     LIST_FOR_EACH_SAFE (port, next_port, bundle_node, &bundle->ports) {
2241         bundle_del_port(port);
2242     }
2243
2244     bundle_flush_macs(bundle, true);
2245     hmap_remove(&ofproto->bundles, &bundle->hmap_node);
2246     free(bundle->name);
2247     free(bundle->trunks);
2248     lacp_destroy(bundle->lacp);
2249     bond_destroy(bundle->bond);
2250     free(bundle);
2251 }
2252
2253 static int
2254 bundle_set(struct ofproto *ofproto_, void *aux,
2255            const struct ofproto_bundle_settings *s)
2256 {
2257     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
2258     bool need_flush = false;
2259     struct ofport_dpif *port;
2260     struct ofbundle *bundle;
2261     unsigned long *trunks;
2262     int vlan;
2263     size_t i;
2264     bool ok;
2265
2266     if (!s) {
2267         bundle_destroy(bundle_lookup(ofproto, aux));
2268         return 0;
2269     }
2270
2271     ovs_assert(s->n_slaves == 1 || s->bond != NULL);
2272     ovs_assert((s->lacp != NULL) == (s->lacp_slaves != NULL));
2273
2274     bundle = bundle_lookup(ofproto, aux);
2275     if (!bundle) {
2276         bundle = xmalloc(sizeof *bundle);
2277
2278         bundle->ofproto = ofproto;
2279         hmap_insert(&ofproto->bundles, &bundle->hmap_node,
2280                     hash_pointer(aux, 0));
2281         bundle->aux = aux;
2282         bundle->name = NULL;
2283
2284         list_init(&bundle->ports);
2285         bundle->vlan_mode = PORT_VLAN_TRUNK;
2286         bundle->vlan = -1;
2287         bundle->trunks = NULL;
2288         bundle->use_priority_tags = s->use_priority_tags;
2289         bundle->lacp = NULL;
2290         bundle->bond = NULL;
2291
2292         bundle->floodable = true;
2293
2294         bundle->src_mirrors = 0;
2295         bundle->dst_mirrors = 0;
2296         bundle->mirror_out = 0;
2297     }
2298
2299     if (!bundle->name || strcmp(s->name, bundle->name)) {
2300         free(bundle->name);
2301         bundle->name = xstrdup(s->name);
2302     }
2303
2304     /* LACP. */
2305     if (s->lacp) {
2306         if (!bundle->lacp) {
2307             ofproto->backer->need_revalidate = REV_RECONFIGURE;
2308             bundle->lacp = lacp_create();
2309         }
2310         lacp_configure(bundle->lacp, s->lacp);
2311     } else {
2312         lacp_destroy(bundle->lacp);
2313         bundle->lacp = NULL;
2314     }
2315
2316     /* Update set of ports. */
2317     ok = true;
2318     for (i = 0; i < s->n_slaves; i++) {
2319         if (!bundle_add_port(bundle, s->slaves[i],
2320                              s->lacp ? &s->lacp_slaves[i] : NULL)) {
2321             ok = false;
2322         }
2323     }
2324     if (!ok || list_size(&bundle->ports) != s->n_slaves) {
2325         struct ofport_dpif *next_port;
2326
2327         LIST_FOR_EACH_SAFE (port, next_port, bundle_node, &bundle->ports) {
2328             for (i = 0; i < s->n_slaves; i++) {
2329                 if (s->slaves[i] == port->up.ofp_port) {
2330                     goto found;
2331                 }
2332             }
2333
2334             bundle_del_port(port);
2335         found: ;
2336         }
2337     }
2338     ovs_assert(list_size(&bundle->ports) <= s->n_slaves);
2339
2340     if (list_is_empty(&bundle->ports)) {
2341         bundle_destroy(bundle);
2342         return EINVAL;
2343     }
2344
2345     /* Set VLAN tagging mode */
2346     if (s->vlan_mode != bundle->vlan_mode
2347         || s->use_priority_tags != bundle->use_priority_tags) {
2348         bundle->vlan_mode = s->vlan_mode;
2349         bundle->use_priority_tags = s->use_priority_tags;
2350         need_flush = true;
2351     }
2352
2353     /* Set VLAN tag. */
2354     vlan = (s->vlan_mode == PORT_VLAN_TRUNK ? -1
2355             : s->vlan >= 0 && s->vlan <= 4095 ? s->vlan
2356             : 0);
2357     if (vlan != bundle->vlan) {
2358         bundle->vlan = vlan;
2359         need_flush = true;
2360     }
2361
2362     /* Get trunked VLANs. */
2363     switch (s->vlan_mode) {
2364     case PORT_VLAN_ACCESS:
2365         trunks = NULL;
2366         break;
2367
2368     case PORT_VLAN_TRUNK:
2369         trunks = CONST_CAST(unsigned long *, s->trunks);
2370         break;
2371
2372     case PORT_VLAN_NATIVE_UNTAGGED:
2373     case PORT_VLAN_NATIVE_TAGGED:
2374         if (vlan != 0 && (!s->trunks
2375                           || !bitmap_is_set(s->trunks, vlan)
2376                           || bitmap_is_set(s->trunks, 0))) {
2377             /* Force trunking the native VLAN and prohibit trunking VLAN 0. */
2378             if (s->trunks) {
2379                 trunks = bitmap_clone(s->trunks, 4096);
2380             } else {
2381                 trunks = bitmap_allocate1(4096);
2382             }
2383             bitmap_set1(trunks, vlan);
2384             bitmap_set0(trunks, 0);
2385         } else {
2386             trunks = CONST_CAST(unsigned long *, s->trunks);
2387         }
2388         break;
2389
2390     default:
2391         NOT_REACHED();
2392     }
2393     if (!vlan_bitmap_equal(trunks, bundle->trunks)) {
2394         free(bundle->trunks);
2395         if (trunks == s->trunks) {
2396             bundle->trunks = vlan_bitmap_clone(trunks);
2397         } else {
2398             bundle->trunks = trunks;
2399             trunks = NULL;
2400         }
2401         need_flush = true;
2402     }
2403     if (trunks != s->trunks) {
2404         free(trunks);
2405     }
2406
2407     /* Bonding. */
2408     if (!list_is_short(&bundle->ports)) {
2409         bundle->ofproto->has_bonded_bundles = true;
2410         if (bundle->bond) {
2411             if (bond_reconfigure(bundle->bond, s->bond)) {
2412                 ofproto->backer->need_revalidate = REV_RECONFIGURE;
2413             }
2414         } else {
2415             bundle->bond = bond_create(s->bond);
2416             ofproto->backer->need_revalidate = REV_RECONFIGURE;
2417         }
2418
2419         LIST_FOR_EACH (port, bundle_node, &bundle->ports) {
2420             bond_slave_register(bundle->bond, port, port->up.netdev);
2421         }
2422     } else {
2423         bond_destroy(bundle->bond);
2424         bundle->bond = NULL;
2425     }
2426
2427     /* If we changed something that would affect MAC learning, un-learn
2428      * everything on this port and force flow revalidation. */
2429     if (need_flush) {
2430         bundle_flush_macs(bundle, false);
2431     }
2432
2433     return 0;
2434 }
2435
2436 static void
2437 bundle_remove(struct ofport *port_)
2438 {
2439     struct ofport_dpif *port = ofport_dpif_cast(port_);
2440     struct ofbundle *bundle = port->bundle;
2441
2442     if (bundle) {
2443         bundle_del_port(port);
2444         if (list_is_empty(&bundle->ports)) {
2445             bundle_destroy(bundle);
2446         } else if (list_is_short(&bundle->ports)) {
2447             bond_destroy(bundle->bond);
2448             bundle->bond = NULL;
2449         }
2450     }
2451 }
2452
2453 static void
2454 send_pdu_cb(void *port_, const void *pdu, size_t pdu_size)
2455 {
2456     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 10);
2457     struct ofport_dpif *port = port_;
2458     uint8_t ea[ETH_ADDR_LEN];
2459     int error;
2460
2461     error = netdev_get_etheraddr(port->up.netdev, ea);
2462     if (!error) {
2463         struct ofpbuf packet;
2464         void *packet_pdu;
2465
2466         ofpbuf_init(&packet, 0);
2467         packet_pdu = eth_compose(&packet, eth_addr_lacp, ea, ETH_TYPE_LACP,
2468                                  pdu_size);
2469         memcpy(packet_pdu, pdu, pdu_size);
2470
2471         send_packet(port, &packet);
2472         ofpbuf_uninit(&packet);
2473     } else {
2474         VLOG_ERR_RL(&rl, "port %s: cannot obtain Ethernet address of iface "
2475                     "%s (%s)", port->bundle->name,
2476                     netdev_get_name(port->up.netdev), strerror(error));
2477     }
2478 }
2479
2480 static void
2481 bundle_send_learning_packets(struct ofbundle *bundle)
2482 {
2483     struct ofproto_dpif *ofproto = bundle->ofproto;
2484     int error, n_packets, n_errors;
2485     struct mac_entry *e;
2486
2487     error = n_packets = n_errors = 0;
2488     LIST_FOR_EACH (e, lru_node, &ofproto->ml->lrus) {
2489         if (e->port.p != bundle) {
2490             struct ofpbuf *learning_packet;
2491             struct ofport_dpif *port;
2492             void *port_void;
2493             int ret;
2494
2495             /* The assignment to "port" is unnecessary but makes "grep"ing for
2496              * struct ofport_dpif more effective. */
2497             learning_packet = bond_compose_learning_packet(bundle->bond,
2498                                                            e->mac, e->vlan,
2499                                                            &port_void);
2500             port = port_void;
2501             ret = send_packet(port, learning_packet);
2502             ofpbuf_delete(learning_packet);
2503             if (ret) {
2504                 error = ret;
2505                 n_errors++;
2506             }
2507             n_packets++;
2508         }
2509     }
2510
2511     if (n_errors) {
2512         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
2513         VLOG_WARN_RL(&rl, "bond %s: %d errors sending %d gratuitous learning "
2514                      "packets, last error was: %s",
2515                      bundle->name, n_errors, n_packets, strerror(error));
2516     } else {
2517         VLOG_DBG("bond %s: sent %d gratuitous learning packets",
2518                  bundle->name, n_packets);
2519     }
2520 }
2521
2522 static void
2523 bundle_run(struct ofbundle *bundle)
2524 {
2525     if (bundle->lacp) {
2526         lacp_run(bundle->lacp, send_pdu_cb);
2527     }
2528     if (bundle->bond) {
2529         struct ofport_dpif *port;
2530
2531         LIST_FOR_EACH (port, bundle_node, &bundle->ports) {
2532             bond_slave_set_may_enable(bundle->bond, port, port->may_enable);
2533         }
2534
2535         bond_run(bundle->bond, &bundle->ofproto->backer->revalidate_set,
2536                  lacp_status(bundle->lacp));
2537         if (bond_should_send_learning_packets(bundle->bond)) {
2538             bundle_send_learning_packets(bundle);
2539         }
2540     }
2541 }
2542
2543 static void
2544 bundle_wait(struct ofbundle *bundle)
2545 {
2546     if (bundle->lacp) {
2547         lacp_wait(bundle->lacp);
2548     }
2549     if (bundle->bond) {
2550         bond_wait(bundle->bond);
2551     }
2552 }
2553 \f
2554 /* Mirrors. */
2555
2556 static int
2557 mirror_scan(struct ofproto_dpif *ofproto)
2558 {
2559     int idx;
2560
2561     for (idx = 0; idx < MAX_MIRRORS; idx++) {
2562         if (!ofproto->mirrors[idx]) {
2563             return idx;
2564         }
2565     }
2566     return -1;
2567 }
2568
2569 static struct ofmirror *
2570 mirror_lookup(struct ofproto_dpif *ofproto, void *aux)
2571 {
2572     int i;
2573
2574     for (i = 0; i < MAX_MIRRORS; i++) {
2575         struct ofmirror *mirror = ofproto->mirrors[i];
2576         if (mirror && mirror->aux == aux) {
2577             return mirror;
2578         }
2579     }
2580
2581     return NULL;
2582 }
2583
2584 /* Update the 'dup_mirrors' member of each of the ofmirrors in 'ofproto'. */
2585 static void
2586 mirror_update_dups(struct ofproto_dpif *ofproto)
2587 {
2588     int i;
2589
2590     for (i = 0; i < MAX_MIRRORS; i++) {
2591         struct ofmirror *m = ofproto->mirrors[i];
2592
2593         if (m) {
2594             m->dup_mirrors = MIRROR_MASK_C(1) << i;
2595         }
2596     }
2597
2598     for (i = 0; i < MAX_MIRRORS; i++) {
2599         struct ofmirror *m1 = ofproto->mirrors[i];
2600         int j;
2601
2602         if (!m1) {
2603             continue;
2604         }
2605
2606         for (j = i + 1; j < MAX_MIRRORS; j++) {
2607             struct ofmirror *m2 = ofproto->mirrors[j];
2608
2609             if (m2 && m1->out == m2->out && m1->out_vlan == m2->out_vlan) {
2610                 m1->dup_mirrors |= MIRROR_MASK_C(1) << j;
2611                 m2->dup_mirrors |= m1->dup_mirrors;
2612             }
2613         }
2614     }
2615 }
2616
2617 static int
2618 mirror_set(struct ofproto *ofproto_, void *aux,
2619            const struct ofproto_mirror_settings *s)
2620 {
2621     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
2622     mirror_mask_t mirror_bit;
2623     struct ofbundle *bundle;
2624     struct ofmirror *mirror;
2625     struct ofbundle *out;
2626     struct hmapx srcs;          /* Contains "struct ofbundle *"s. */
2627     struct hmapx dsts;          /* Contains "struct ofbundle *"s. */
2628     int out_vlan;
2629
2630     mirror = mirror_lookup(ofproto, aux);
2631     if (!s) {
2632         mirror_destroy(mirror);
2633         return 0;
2634     }
2635     if (!mirror) {
2636         int idx;
2637
2638         idx = mirror_scan(ofproto);
2639         if (idx < 0) {
2640             VLOG_WARN("bridge %s: maximum of %d port mirrors reached, "
2641                       "cannot create %s",
2642                       ofproto->up.name, MAX_MIRRORS, s->name);
2643             return EFBIG;
2644         }
2645
2646         mirror = ofproto->mirrors[idx] = xzalloc(sizeof *mirror);
2647         mirror->ofproto = ofproto;
2648         mirror->idx = idx;
2649         mirror->aux = aux;
2650         mirror->out_vlan = -1;
2651         mirror->name = NULL;
2652     }
2653
2654     if (!mirror->name || strcmp(s->name, mirror->name)) {
2655         free(mirror->name);
2656         mirror->name = xstrdup(s->name);
2657     }
2658
2659     /* Get the new configuration. */
2660     if (s->out_bundle) {
2661         out = bundle_lookup(ofproto, s->out_bundle);
2662         if (!out) {
2663             mirror_destroy(mirror);
2664             return EINVAL;
2665         }
2666         out_vlan = -1;
2667     } else {
2668         out = NULL;
2669         out_vlan = s->out_vlan;
2670     }
2671     bundle_lookup_multiple(ofproto, s->srcs, s->n_srcs, &srcs);
2672     bundle_lookup_multiple(ofproto, s->dsts, s->n_dsts, &dsts);
2673
2674     /* If the configuration has not changed, do nothing. */
2675     if (hmapx_equals(&srcs, &mirror->srcs)
2676         && hmapx_equals(&dsts, &mirror->dsts)
2677         && vlan_bitmap_equal(mirror->vlans, s->src_vlans)
2678         && mirror->out == out
2679         && mirror->out_vlan == out_vlan)
2680     {
2681         hmapx_destroy(&srcs);
2682         hmapx_destroy(&dsts);
2683         return 0;
2684     }
2685
2686     hmapx_swap(&srcs, &mirror->srcs);
2687     hmapx_destroy(&srcs);
2688
2689     hmapx_swap(&dsts, &mirror->dsts);
2690     hmapx_destroy(&dsts);
2691
2692     free(mirror->vlans);
2693     mirror->vlans = vlan_bitmap_clone(s->src_vlans);
2694
2695     mirror->out = out;
2696     mirror->out_vlan = out_vlan;
2697
2698     /* Update bundles. */
2699     mirror_bit = MIRROR_MASK_C(1) << mirror->idx;
2700     HMAP_FOR_EACH (bundle, hmap_node, &mirror->ofproto->bundles) {
2701         if (hmapx_contains(&mirror->srcs, bundle)) {
2702             bundle->src_mirrors |= mirror_bit;
2703         } else {
2704             bundle->src_mirrors &= ~mirror_bit;
2705         }
2706
2707         if (hmapx_contains(&mirror->dsts, bundle)) {
2708             bundle->dst_mirrors |= mirror_bit;
2709         } else {
2710             bundle->dst_mirrors &= ~mirror_bit;
2711         }
2712
2713         if (mirror->out == bundle) {
2714             bundle->mirror_out |= mirror_bit;
2715         } else {
2716             bundle->mirror_out &= ~mirror_bit;
2717         }
2718     }
2719
2720     ofproto->backer->need_revalidate = REV_RECONFIGURE;
2721     ofproto->has_mirrors = true;
2722     mac_learning_flush(ofproto->ml,
2723                        &ofproto->backer->revalidate_set);
2724     mirror_update_dups(ofproto);
2725
2726     return 0;
2727 }
2728
2729 static void
2730 mirror_destroy(struct ofmirror *mirror)
2731 {
2732     struct ofproto_dpif *ofproto;
2733     mirror_mask_t mirror_bit;
2734     struct ofbundle *bundle;
2735     int i;
2736
2737     if (!mirror) {
2738         return;
2739     }
2740
2741     ofproto = mirror->ofproto;
2742     ofproto->backer->need_revalidate = REV_RECONFIGURE;
2743     mac_learning_flush(ofproto->ml, &ofproto->backer->revalidate_set);
2744
2745     mirror_bit = MIRROR_MASK_C(1) << mirror->idx;
2746     HMAP_FOR_EACH (bundle, hmap_node, &ofproto->bundles) {
2747         bundle->src_mirrors &= ~mirror_bit;
2748         bundle->dst_mirrors &= ~mirror_bit;
2749         bundle->mirror_out &= ~mirror_bit;
2750     }
2751
2752     hmapx_destroy(&mirror->srcs);
2753     hmapx_destroy(&mirror->dsts);
2754     free(mirror->vlans);
2755
2756     ofproto->mirrors[mirror->idx] = NULL;
2757     free(mirror->name);
2758     free(mirror);
2759
2760     mirror_update_dups(ofproto);
2761
2762     ofproto->has_mirrors = false;
2763     for (i = 0; i < MAX_MIRRORS; i++) {
2764         if (ofproto->mirrors[i]) {
2765             ofproto->has_mirrors = true;
2766             break;
2767         }
2768     }
2769 }
2770
2771 static int
2772 mirror_get_stats(struct ofproto *ofproto_, void *aux,
2773                  uint64_t *packets, uint64_t *bytes)
2774 {
2775     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
2776     struct ofmirror *mirror = mirror_lookup(ofproto, aux);
2777
2778     if (!mirror) {
2779         *packets = *bytes = UINT64_MAX;
2780         return 0;
2781     }
2782
2783     push_all_stats();
2784
2785     *packets = mirror->packet_count;
2786     *bytes = mirror->byte_count;
2787
2788     return 0;
2789 }
2790
2791 static int
2792 set_flood_vlans(struct ofproto *ofproto_, unsigned long *flood_vlans)
2793 {
2794     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
2795     if (mac_learning_set_flood_vlans(ofproto->ml, flood_vlans)) {
2796         mac_learning_flush(ofproto->ml, &ofproto->backer->revalidate_set);
2797     }
2798     return 0;
2799 }
2800
2801 static bool
2802 is_mirror_output_bundle(const struct ofproto *ofproto_, void *aux)
2803 {
2804     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
2805     struct ofbundle *bundle = bundle_lookup(ofproto, aux);
2806     return bundle && bundle->mirror_out != 0;
2807 }
2808
2809 static void
2810 forward_bpdu_changed(struct ofproto *ofproto_)
2811 {
2812     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
2813     ofproto->backer->need_revalidate = REV_RECONFIGURE;
2814 }
2815
2816 static void
2817 set_mac_table_config(struct ofproto *ofproto_, unsigned int idle_time,
2818                      size_t max_entries)
2819 {
2820     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
2821     mac_learning_set_idle_time(ofproto->ml, idle_time);
2822     mac_learning_set_max_entries(ofproto->ml, max_entries);
2823 }
2824 \f
2825 /* Ports. */
2826
2827 struct ofport_dpif *
2828 get_ofp_port(const struct ofproto_dpif *ofproto, ofp_port_t ofp_port)
2829 {
2830     struct ofport *ofport = ofproto_get_port(&ofproto->up, ofp_port);
2831     return ofport ? ofport_dpif_cast(ofport) : NULL;
2832 }
2833
2834 struct ofport_dpif *
2835 get_odp_port(const struct ofproto_dpif *ofproto, odp_port_t odp_port)
2836 {
2837     struct ofport_dpif *port = odp_port_to_ofport(ofproto->backer, odp_port);
2838     return port && &ofproto->up == port->up.ofproto ? port : NULL;
2839 }
2840
2841 static void
2842 ofproto_port_from_dpif_port(struct ofproto_dpif *ofproto,
2843                             struct ofproto_port *ofproto_port,
2844                             struct dpif_port *dpif_port)
2845 {
2846     ofproto_port->name = dpif_port->name;
2847     ofproto_port->type = dpif_port->type;
2848     ofproto_port->ofp_port = odp_port_to_ofp_port(ofproto, dpif_port->port_no);
2849 }
2850
2851 static void
2852 ofport_update_peer(struct ofport_dpif *ofport)
2853 {
2854     const struct ofproto_dpif *ofproto;
2855     struct dpif_backer *backer;
2856     const char *peer_name;
2857
2858     if (!netdev_vport_is_patch(ofport->up.netdev)) {
2859         return;
2860     }
2861
2862     backer = ofproto_dpif_cast(ofport->up.ofproto)->backer;
2863     backer->need_revalidate = REV_RECONFIGURE;
2864
2865     if (ofport->peer) {
2866         ofport->peer->peer = NULL;
2867         ofport->peer = NULL;
2868     }
2869
2870     peer_name = netdev_vport_patch_peer(ofport->up.netdev);
2871     if (!peer_name) {
2872         return;
2873     }
2874
2875     HMAP_FOR_EACH (ofproto, all_ofproto_dpifs_node, &all_ofproto_dpifs) {
2876         struct ofport *peer_ofport;
2877         struct ofport_dpif *peer;
2878         const char *peer_peer;
2879
2880         if (ofproto->backer != backer) {
2881             continue;
2882         }
2883
2884         peer_ofport = shash_find_data(&ofproto->up.port_by_name, peer_name);
2885         if (!peer_ofport) {
2886             continue;
2887         }
2888
2889         peer = ofport_dpif_cast(peer_ofport);
2890         peer_peer = netdev_vport_patch_peer(peer->up.netdev);
2891         if (peer_peer && !strcmp(netdev_get_name(ofport->up.netdev),
2892                                  peer_peer)) {
2893             ofport->peer = peer;
2894             ofport->peer->peer = ofport;
2895         }
2896
2897         return;
2898     }
2899 }
2900
2901 static void
2902 port_run_fast(struct ofport_dpif *ofport)
2903 {
2904     if (ofport->cfm && cfm_should_send_ccm(ofport->cfm)) {
2905         struct ofpbuf packet;
2906
2907         ofpbuf_init(&packet, 0);
2908         cfm_compose_ccm(ofport->cfm, &packet, ofport->up.pp.hw_addr);
2909         send_packet(ofport, &packet);
2910         ofpbuf_uninit(&packet);
2911     }
2912
2913     if (ofport->bfd && bfd_should_send_packet(ofport->bfd)) {
2914         struct ofpbuf packet;
2915
2916         ofpbuf_init(&packet, 0);
2917         bfd_put_packet(ofport->bfd, &packet, ofport->up.pp.hw_addr);
2918         send_packet(ofport, &packet);
2919         ofpbuf_uninit(&packet);
2920     }
2921 }
2922
2923 static void
2924 port_run(struct ofport_dpif *ofport)
2925 {
2926     long long int carrier_seq = netdev_get_carrier_resets(ofport->up.netdev);
2927     bool carrier_changed = carrier_seq != ofport->carrier_seq;
2928     bool enable = netdev_get_carrier(ofport->up.netdev);
2929
2930     ofport->carrier_seq = carrier_seq;
2931
2932     port_run_fast(ofport);
2933
2934     if (ofport->cfm) {
2935         int cfm_opup = cfm_get_opup(ofport->cfm);
2936
2937         cfm_run(ofport->cfm);
2938         enable = enable && !cfm_get_fault(ofport->cfm);
2939
2940         if (cfm_opup >= 0) {
2941             enable = enable && cfm_opup;
2942         }
2943     }
2944
2945     if (ofport->bfd) {
2946         bfd_run(ofport->bfd);
2947         enable = enable && bfd_forwarding(ofport->bfd);
2948     }
2949
2950     if (ofport->bundle) {
2951         enable = enable && lacp_slave_may_enable(ofport->bundle->lacp, ofport);
2952         if (carrier_changed) {
2953             lacp_slave_carrier_changed(ofport->bundle->lacp, ofport);
2954         }
2955     }
2956
2957     if (ofport->may_enable != enable) {
2958         struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofport->up.ofproto);
2959
2960         if (ofproto->has_bundle_action) {
2961             ofproto->backer->need_revalidate = REV_PORT_TOGGLED;
2962         }
2963     }
2964
2965     ofport->may_enable = enable;
2966 }
2967
2968 static void
2969 port_wait(struct ofport_dpif *ofport)
2970 {
2971     if (ofport->cfm) {
2972         cfm_wait(ofport->cfm);
2973     }
2974
2975     if (ofport->bfd) {
2976         bfd_wait(ofport->bfd);
2977     }
2978 }
2979
2980 static int
2981 port_query_by_name(const struct ofproto *ofproto_, const char *devname,
2982                    struct ofproto_port *ofproto_port)
2983 {
2984     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
2985     struct dpif_port dpif_port;
2986     int error;
2987
2988     if (sset_contains(&ofproto->ghost_ports, devname)) {
2989         const char *type = netdev_get_type_from_name(devname);
2990
2991         /* We may be called before ofproto->up.port_by_name is populated with
2992          * the appropriate ofport.  For this reason, we must get the name and
2993          * type from the netdev layer directly. */
2994         if (type) {
2995             const struct ofport *ofport;
2996
2997             ofport = shash_find_data(&ofproto->up.port_by_name, devname);
2998             ofproto_port->ofp_port = ofport ? ofport->ofp_port : OFPP_NONE;
2999             ofproto_port->name = xstrdup(devname);
3000             ofproto_port->type = xstrdup(type);
3001             return 0;
3002         }
3003         return ENODEV;
3004     }
3005
3006     if (!sset_contains(&ofproto->ports, devname)) {
3007         return ENODEV;
3008     }
3009     error = dpif_port_query_by_name(ofproto->backer->dpif,
3010                                     devname, &dpif_port);
3011     if (!error) {
3012         ofproto_port_from_dpif_port(ofproto, ofproto_port, &dpif_port);
3013     }
3014     return error;
3015 }
3016
3017 static int
3018 port_add(struct ofproto *ofproto_, struct netdev *netdev)
3019 {
3020     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
3021     const char *devname = netdev_get_name(netdev);
3022     char namebuf[NETDEV_VPORT_NAME_BUFSIZE];
3023     const char *dp_port_name;
3024
3025     if (netdev_vport_is_patch(netdev)) {
3026         sset_add(&ofproto->ghost_ports, netdev_get_name(netdev));
3027         return 0;
3028     }
3029
3030     dp_port_name = netdev_vport_get_dpif_port(netdev, namebuf, sizeof namebuf);
3031     if (!dpif_port_exists(ofproto->backer->dpif, dp_port_name)) {
3032         odp_port_t port_no = ODPP_NONE;
3033         int error;
3034
3035         error = dpif_port_add(ofproto->backer->dpif, netdev, &port_no);
3036         if (error) {
3037             return error;
3038         }
3039         if (netdev_get_tunnel_config(netdev)) {
3040             simap_put(&ofproto->backer->tnl_backers,
3041                       dp_port_name, odp_to_u32(port_no));
3042         }
3043     }
3044
3045     if (netdev_get_tunnel_config(netdev)) {
3046         sset_add(&ofproto->ghost_ports, devname);
3047     } else {
3048         sset_add(&ofproto->ports, devname);
3049     }
3050     return 0;
3051 }
3052
3053 static int
3054 port_del(struct ofproto *ofproto_, ofp_port_t ofp_port)
3055 {
3056     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
3057     struct ofport_dpif *ofport = get_ofp_port(ofproto, ofp_port);
3058     int error = 0;
3059
3060     if (!ofport) {
3061         return 0;
3062     }
3063
3064     sset_find_and_delete(&ofproto->ghost_ports,
3065                          netdev_get_name(ofport->up.netdev));
3066     ofproto->backer->need_revalidate = REV_RECONFIGURE;
3067     if (!ofport->tnl_port) {
3068         error = dpif_port_del(ofproto->backer->dpif, ofport->odp_port);
3069         if (!error) {
3070             /* The caller is going to close ofport->up.netdev.  If this is a
3071              * bonded port, then the bond is using that netdev, so remove it
3072              * from the bond.  The client will need to reconfigure everything
3073              * after deleting ports, so then the slave will get re-added. */
3074             bundle_remove(&ofport->up);
3075         }
3076     }
3077     return error;
3078 }
3079
3080 static int
3081 port_get_stats(const struct ofport *ofport_, struct netdev_stats *stats)
3082 {
3083     struct ofport_dpif *ofport = ofport_dpif_cast(ofport_);
3084     int error;
3085
3086     push_all_stats();
3087
3088     error = netdev_get_stats(ofport->up.netdev, stats);
3089
3090     if (!error && ofport_->ofp_port == OFPP_LOCAL) {
3091         struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofport->up.ofproto);
3092
3093         /* ofproto->stats.tx_packets represents packets that we created
3094          * internally and sent to some port (e.g. packets sent with
3095          * send_packet()).  Account for them as if they had come from
3096          * OFPP_LOCAL and got forwarded. */
3097
3098         if (stats->rx_packets != UINT64_MAX) {
3099             stats->rx_packets += ofproto->stats.tx_packets;
3100         }
3101
3102         if (stats->rx_bytes != UINT64_MAX) {
3103             stats->rx_bytes += ofproto->stats.tx_bytes;
3104         }
3105
3106         /* ofproto->stats.rx_packets represents packets that were received on
3107          * some port and we processed internally and dropped (e.g. STP).
3108          * Account for them as if they had been forwarded to OFPP_LOCAL. */
3109
3110         if (stats->tx_packets != UINT64_MAX) {
3111             stats->tx_packets += ofproto->stats.rx_packets;
3112         }
3113
3114         if (stats->tx_bytes != UINT64_MAX) {
3115             stats->tx_bytes += ofproto->stats.rx_bytes;
3116         }
3117     }
3118
3119     return error;
3120 }
3121
3122 struct port_dump_state {
3123     uint32_t bucket;
3124     uint32_t offset;
3125     bool ghost;
3126
3127     struct ofproto_port port;
3128     bool has_port;
3129 };
3130
3131 static int
3132 port_dump_start(const struct ofproto *ofproto_ OVS_UNUSED, void **statep)
3133 {
3134     *statep = xzalloc(sizeof(struct port_dump_state));
3135     return 0;
3136 }
3137
3138 static int
3139 port_dump_next(const struct ofproto *ofproto_, void *state_,
3140                struct ofproto_port *port)
3141 {
3142     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
3143     struct port_dump_state *state = state_;
3144     const struct sset *sset;
3145     struct sset_node *node;
3146
3147     if (state->has_port) {
3148         ofproto_port_destroy(&state->port);
3149         state->has_port = false;
3150     }
3151     sset = state->ghost ? &ofproto->ghost_ports : &ofproto->ports;
3152     while ((node = sset_at_position(sset, &state->bucket, &state->offset))) {
3153         int error;
3154
3155         error = port_query_by_name(ofproto_, node->name, &state->port);
3156         if (!error) {
3157             *port = state->port;
3158             state->has_port = true;
3159             return 0;
3160         } else if (error != ENODEV) {
3161             return error;
3162         }
3163     }
3164
3165     if (!state->ghost) {
3166         state->ghost = true;
3167         state->bucket = 0;
3168         state->offset = 0;
3169         return port_dump_next(ofproto_, state_, port);
3170     }
3171
3172     return EOF;
3173 }
3174
3175 static int
3176 port_dump_done(const struct ofproto *ofproto_ OVS_UNUSED, void *state_)
3177 {
3178     struct port_dump_state *state = state_;
3179
3180     if (state->has_port) {
3181         ofproto_port_destroy(&state->port);
3182     }
3183     free(state);
3184     return 0;
3185 }
3186
3187 static int
3188 port_poll(const struct ofproto *ofproto_, char **devnamep)
3189 {
3190     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
3191
3192     if (ofproto->port_poll_errno) {
3193         int error = ofproto->port_poll_errno;
3194         ofproto->port_poll_errno = 0;
3195         return error;
3196     }
3197
3198     if (sset_is_empty(&ofproto->port_poll_set)) {
3199         return EAGAIN;
3200     }
3201
3202     *devnamep = sset_pop(&ofproto->port_poll_set);
3203     return 0;
3204 }
3205
3206 static void
3207 port_poll_wait(const struct ofproto *ofproto_)
3208 {
3209     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
3210     dpif_port_poll_wait(ofproto->backer->dpif);
3211 }
3212
3213 static int
3214 port_is_lacp_current(const struct ofport *ofport_)
3215 {
3216     const struct ofport_dpif *ofport = ofport_dpif_cast(ofport_);
3217     return (ofport->bundle && ofport->bundle->lacp
3218             ? lacp_slave_is_current(ofport->bundle->lacp, ofport)
3219             : -1);
3220 }
3221 \f
3222 /* Upcall handling. */
3223
3224 /* Flow miss batching.
3225  *
3226  * Some dpifs implement operations faster when you hand them off in a batch.
3227  * To allow batching, "struct flow_miss" queues the dpif-related work needed
3228  * for a given flow.  Each "struct flow_miss" corresponds to sending one or
3229  * more packets, plus possibly installing the flow in the dpif.
3230  *
3231  * So far we only batch the operations that affect flow setup time the most.
3232  * It's possible to batch more than that, but the benefit might be minimal. */
3233 struct flow_miss {
3234     struct hmap_node hmap_node;
3235     struct ofproto_dpif *ofproto;
3236     struct flow flow;
3237     enum odp_key_fitness key_fitness;
3238     const struct nlattr *key;
3239     size_t key_len;
3240     struct list packets;
3241     enum dpif_upcall_type upcall_type;
3242 };
3243
3244 struct flow_miss_op {
3245     struct dpif_op dpif_op;
3246
3247     uint64_t slow_stub[128 / 8]; /* Buffer for compose_slow_path() */
3248     struct xlate_out xout;
3249     bool xout_garbage;           /* 'xout' needs to be uninitialized? */
3250
3251     struct ofpbuf mask;          /* Flow mask for "put" ops. */
3252     struct odputil_keybuf maskbuf;
3253
3254     /* If this is a "put" op, then a pointer to the subfacet that should
3255      * be marked as uninstalled if the operation fails. */
3256     struct subfacet *subfacet;
3257 };
3258
3259 /* Sends an OFPT_PACKET_IN message for 'packet' of type OFPR_NO_MATCH to each
3260  * OpenFlow controller as necessary according to their individual
3261  * configurations. */
3262 static void
3263 send_packet_in_miss(struct ofproto_dpif *ofproto, const struct ofpbuf *packet,
3264                     const struct flow *flow)
3265 {
3266     struct ofputil_packet_in pin;
3267
3268     pin.packet = packet->data;
3269     pin.packet_len = packet->size;
3270     pin.reason = OFPR_NO_MATCH;
3271     pin.controller_id = 0;
3272
3273     pin.table_id = 0;
3274     pin.cookie = 0;
3275
3276     pin.send_len = 0;           /* not used for flow table misses */
3277
3278     flow_get_metadata(flow, &pin.fmd);
3279
3280     connmgr_send_packet_in(ofproto->up.connmgr, &pin);
3281 }
3282
3283 static struct flow_miss *
3284 flow_miss_find(struct hmap *todo, const struct ofproto_dpif *ofproto,
3285                const struct flow *flow, uint32_t hash)
3286 {
3287     struct flow_miss *miss;
3288
3289     HMAP_FOR_EACH_WITH_HASH (miss, hmap_node, hash, todo) {
3290         if (miss->ofproto == ofproto && flow_equal(&miss->flow, flow)) {
3291             return miss;
3292         }
3293     }
3294
3295     return NULL;
3296 }
3297
3298 /* Partially Initializes 'op' as an "execute" operation for 'miss' and
3299  * 'packet'.  The caller must initialize op->actions and op->actions_len.  If
3300  * 'miss' is associated with a subfacet the caller must also initialize the
3301  * returned op->subfacet, and if anything needs to be freed after processing
3302  * the op, the caller must initialize op->garbage also. */
3303 static void
3304 init_flow_miss_execute_op(struct flow_miss *miss, struct ofpbuf *packet,
3305                           struct flow_miss_op *op)
3306 {
3307     if (miss->flow.in_port.ofp_port
3308         != vsp_realdev_to_vlandev(miss->ofproto, miss->flow.in_port.ofp_port,
3309                                   miss->flow.vlan_tci)) {
3310         /* This packet was received on a VLAN splinter port.  We
3311          * added a VLAN to the packet to make the packet resemble
3312          * the flow, but the actions were composed assuming that
3313          * the packet contained no VLAN.  So, we must remove the
3314          * VLAN header from the packet before trying to execute the
3315          * actions. */
3316         eth_pop_vlan(packet);
3317     }
3318
3319     op->subfacet = NULL;
3320     op->xout_garbage = false;
3321     op->dpif_op.type = DPIF_OP_EXECUTE;
3322     op->dpif_op.u.execute.key = miss->key;
3323     op->dpif_op.u.execute.key_len = miss->key_len;
3324     op->dpif_op.u.execute.packet = packet;
3325     ofpbuf_use_stack(&op->mask, &op->maskbuf, sizeof op->maskbuf);
3326 }
3327
3328 /* Helper for handle_flow_miss_without_facet() and
3329  * handle_flow_miss_with_facet(). */
3330 static void
3331 handle_flow_miss_common(struct rule_dpif *rule,
3332                         struct ofpbuf *packet, const struct flow *flow)
3333 {
3334     struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
3335
3336     if (rule->up.cr.priority == FAIL_OPEN_PRIORITY) {
3337         /*
3338          * Extra-special case for fail-open mode.
3339          *
3340          * We are in fail-open mode and the packet matched the fail-open
3341          * rule, but we are connected to a controller too.  We should send
3342          * the packet up to the controller in the hope that it will try to
3343          * set up a flow and thereby allow us to exit fail-open.
3344          *
3345          * See the top-level comment in fail-open.c for more information.
3346          */
3347         send_packet_in_miss(ofproto, packet, flow);
3348     }
3349 }
3350
3351 /* Figures out whether a flow that missed in 'ofproto', whose details are in
3352  * 'miss' masked by 'wc', is likely to be worth tracking in detail in userspace
3353  * and (usually) installing a datapath flow.  The answer is usually "yes" (a
3354  * return value of true).  However, for short flows the cost of bookkeeping is
3355  * much higher than the benefits, so when the datapath holds a large number of
3356  * flows we impose some heuristics to decide which flows are likely to be worth
3357  * tracking. */
3358 static bool
3359 flow_miss_should_make_facet(struct flow_miss *miss, struct flow_wildcards *wc)
3360 {
3361     struct dpif_backer *backer = miss->ofproto->backer;
3362     uint32_t hash;
3363
3364     switch (flow_miss_model) {
3365     case OFPROTO_HANDLE_MISS_AUTO:
3366         break;
3367     case OFPROTO_HANDLE_MISS_WITH_FACETS:
3368         return true;
3369     case OFPROTO_HANDLE_MISS_WITHOUT_FACETS:
3370         return false;
3371     }
3372
3373     if (!backer->governor) {
3374         size_t n_subfacets;
3375
3376         n_subfacets = hmap_count(&backer->subfacets);
3377         if (n_subfacets * 2 <= flow_eviction_threshold) {
3378             return true;
3379         }
3380
3381         backer->governor = governor_create();
3382     }
3383
3384     hash = flow_hash_in_wildcards(&miss->flow, wc, 0);
3385     return governor_should_install_flow(backer->governor, hash,
3386                                         list_size(&miss->packets));
3387 }
3388
3389 /* Handles 'miss' without creating a facet or subfacet or creating any datapath
3390  * flow.  'miss->flow' must have matched 'rule' and been xlated into 'xout'.
3391  * May add an "execute" operation to 'ops' and increment '*n_ops'. */
3392 static void
3393 handle_flow_miss_without_facet(struct rule_dpif *rule, struct xlate_out *xout,
3394                                struct flow_miss *miss,
3395                                struct flow_miss_op *ops, size_t *n_ops)
3396 {
3397     struct ofpbuf *packet;
3398
3399     LIST_FOR_EACH (packet, list_node, &miss->packets) {
3400
3401         COVERAGE_INC(facet_suppress);
3402
3403         handle_flow_miss_common(rule, packet, &miss->flow);
3404
3405         if (xout->slow) {
3406             struct xlate_in xin;
3407
3408             xlate_in_init(&xin, miss->ofproto, &miss->flow, rule, 0, packet);
3409             xlate_actions_for_side_effects(&xin);
3410         }
3411
3412         if (xout->odp_actions.size) {
3413             struct flow_miss_op *op = &ops[*n_ops];
3414             struct dpif_execute *execute = &op->dpif_op.u.execute;
3415
3416             init_flow_miss_execute_op(miss, packet, op);
3417             xlate_out_copy(&op->xout, xout);
3418             execute->actions = op->xout.odp_actions.data;
3419             execute->actions_len = op->xout.odp_actions.size;
3420             op->xout_garbage = true;
3421
3422             (*n_ops)++;
3423         }
3424     }
3425 }
3426
3427 /* Handles 'miss', which matches 'facet'.  May add any required datapath
3428  * operations to 'ops', incrementing '*n_ops' for each new op.
3429  *
3430  * All of the packets in 'miss' are considered to have arrived at time 'now'.
3431  * This is really important only for new facets: if we just called time_msec()
3432  * here, then the new subfacet or its packets could look (occasionally) as
3433  * though it was used some time after the facet was used.  That can make a
3434  * one-packet flow look like it has a nonzero duration, which looks odd in
3435  * e.g. NetFlow statistics.
3436  *
3437  * If non-null, 'stats' will be folded into 'facet'. */
3438 static void
3439 handle_flow_miss_with_facet(struct flow_miss *miss, struct facet *facet,
3440                             long long int now, struct dpif_flow_stats *stats,
3441                             struct flow_miss_op *ops, size_t *n_ops)
3442 {
3443     struct ofproto_dpif *ofproto = ofproto_dpif_cast(facet->rule->up.ofproto);
3444     enum subfacet_path want_path;
3445     struct subfacet *subfacet;
3446     struct ofpbuf *packet;
3447
3448     subfacet = subfacet_create(facet, miss, now);
3449     want_path = facet->xout.slow ? SF_SLOW_PATH : SF_FAST_PATH;
3450     if (stats) {
3451         subfacet_update_stats(subfacet, stats);
3452     }
3453
3454     LIST_FOR_EACH (packet, list_node, &miss->packets) {
3455         struct flow_miss_op *op = &ops[*n_ops];
3456
3457         handle_flow_miss_common(facet->rule, packet, &miss->flow);
3458
3459         if (want_path != SF_FAST_PATH) {
3460             struct xlate_in xin;
3461
3462             xlate_in_init(&xin, ofproto, &miss->flow, facet->rule, 0, packet);
3463             xlate_actions_for_side_effects(&xin);
3464         }
3465
3466         if (facet->xout.odp_actions.size) {
3467             struct dpif_execute *execute = &op->dpif_op.u.execute;
3468
3469             init_flow_miss_execute_op(miss, packet, op);
3470             execute->actions = facet->xout.odp_actions.data,
3471             execute->actions_len = facet->xout.odp_actions.size;
3472             (*n_ops)++;
3473         }
3474     }
3475
3476     if (miss->upcall_type == DPIF_UC_MISS || subfacet->path != want_path) {
3477         struct flow_miss_op *op = &ops[(*n_ops)++];
3478         struct dpif_flow_put *put = &op->dpif_op.u.flow_put;
3479
3480         subfacet->path = want_path;
3481
3482         ofpbuf_use_stack(&op->mask, &op->maskbuf, sizeof op->maskbuf);
3483         odp_flow_key_from_mask(&op->mask, &facet->xout.wc.masks,
3484                                &miss->flow, UINT32_MAX);
3485
3486         op->xout_garbage = false;
3487         op->dpif_op.type = DPIF_OP_FLOW_PUT;
3488         op->subfacet = subfacet;
3489         put->flags = DPIF_FP_CREATE | DPIF_FP_MODIFY;
3490         put->key = miss->key;
3491         put->key_len = miss->key_len;
3492         put->mask = op->mask.data;
3493         put->mask_len = op->mask.size;
3494
3495         if (want_path == SF_FAST_PATH) {
3496             put->actions = facet->xout.odp_actions.data;
3497             put->actions_len = facet->xout.odp_actions.size;
3498         } else {
3499             compose_slow_path(ofproto, &miss->flow, facet->xout.slow,
3500                               op->slow_stub, sizeof op->slow_stub,
3501                               &put->actions, &put->actions_len);
3502         }
3503         put->stats = NULL;
3504     }
3505 }
3506
3507 /* Handles flow miss 'miss'.  May add any required datapath operations
3508  * to 'ops', incrementing '*n_ops' for each new op. */
3509 static void
3510 handle_flow_miss(struct flow_miss *miss, struct flow_miss_op *ops,
3511                  size_t *n_ops)
3512 {
3513     struct ofproto_dpif *ofproto = miss->ofproto;
3514     struct dpif_flow_stats stats__;
3515     struct dpif_flow_stats *stats = &stats__;
3516     struct ofpbuf *packet;
3517     struct facet *facet;
3518     long long int now;
3519
3520     now = time_msec();
3521     memset(stats, 0, sizeof *stats);
3522     stats->used = now;
3523     LIST_FOR_EACH (packet, list_node, &miss->packets) {
3524         stats->tcp_flags |= packet_get_tcp_flags(packet, &miss->flow);
3525         stats->n_bytes += packet->size;
3526         stats->n_packets++;
3527     }
3528
3529     facet = facet_lookup_valid(ofproto, &miss->flow);
3530     if (!facet) {
3531         struct flow_wildcards wc;
3532         struct rule_dpif *rule;
3533         struct xlate_out xout;
3534         struct xlate_in xin;
3535
3536         flow_wildcards_init_catchall(&wc);
3537         rule = rule_dpif_lookup(ofproto, &miss->flow, &wc);
3538         rule_credit_stats(rule, stats);
3539
3540         xlate_in_init(&xin, ofproto, &miss->flow, rule, stats->tcp_flags,
3541                       NULL);
3542         xin.resubmit_stats = stats;
3543         xin.may_learn = true;
3544         xlate_actions(&xin, &xout);
3545         flow_wildcards_or(&xout.wc, &xout.wc, &wc);
3546
3547         /* There does not exist a bijection between 'struct flow' and datapath
3548          * flow keys with fitness ODP_FIT_TO_LITTLE.  This breaks a fundamental
3549          * assumption used throughout the facet and subfacet handling code.
3550          * Since we have to handle these misses in userspace anyway, we simply
3551          * skip facet creation, avoiding the problem altogether. */
3552         if (miss->key_fitness == ODP_FIT_TOO_LITTLE
3553             || !flow_miss_should_make_facet(miss, &xout.wc)) {
3554             handle_flow_miss_without_facet(rule, &xout, miss, ops, n_ops);
3555             return;
3556         }
3557
3558         facet = facet_create(miss, rule, &xout, stats);
3559         stats = NULL;
3560     }
3561     handle_flow_miss_with_facet(miss, facet, now, stats, ops, n_ops);
3562 }
3563
3564 static struct drop_key *
3565 drop_key_lookup(const struct dpif_backer *backer, const struct nlattr *key,
3566                 size_t key_len)
3567 {
3568     struct drop_key *drop_key;
3569
3570     HMAP_FOR_EACH_WITH_HASH (drop_key, hmap_node, hash_bytes(key, key_len, 0),
3571                              &backer->drop_keys) {
3572         if (drop_key->key_len == key_len
3573             && !memcmp(drop_key->key, key, key_len)) {
3574             return drop_key;
3575         }
3576     }
3577     return NULL;
3578 }
3579
3580 static void
3581 drop_key_clear(struct dpif_backer *backer)
3582 {
3583     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 15);
3584     struct drop_key *drop_key, *next;
3585
3586     HMAP_FOR_EACH_SAFE (drop_key, next, hmap_node, &backer->drop_keys) {
3587         int error;
3588
3589         error = dpif_flow_del(backer->dpif, drop_key->key, drop_key->key_len,
3590                               NULL);
3591         if (error && !VLOG_DROP_WARN(&rl)) {
3592             struct ds ds = DS_EMPTY_INITIALIZER;
3593             odp_flow_key_format(drop_key->key, drop_key->key_len, &ds);
3594             VLOG_WARN("Failed to delete drop key (%s) (%s)", strerror(error),
3595                       ds_cstr(&ds));
3596             ds_destroy(&ds);
3597         }
3598
3599         hmap_remove(&backer->drop_keys, &drop_key->hmap_node);
3600         free(drop_key->key);
3601         free(drop_key);
3602     }
3603 }
3604
3605 /* Given a datpath, packet, and flow metadata ('backer', 'packet', and 'key'
3606  * respectively), populates 'flow' with the result of odp_flow_key_to_flow().
3607  * Optionally, if nonnull, populates 'fitnessp' with the fitness of 'flow' as
3608  * returned by odp_flow_key_to_flow().  Also, optionally populates 'ofproto'
3609  * with the ofproto_dpif, and 'odp_in_port' with the datapath in_port, that
3610  * 'packet' ingressed.
3611  *
3612  * If 'ofproto' is nonnull, requires 'flow''s in_port to exist.  Otherwise sets
3613  * 'flow''s in_port to OFPP_NONE.
3614  *
3615  * This function does post-processing on data returned from
3616  * odp_flow_key_to_flow() to help make VLAN splinters transparent to the rest
3617  * of the upcall processing logic.  In particular, if the extracted in_port is
3618  * a VLAN splinter port, it replaces flow->in_port by the "real" port, sets
3619  * flow->vlan_tci correctly for the VLAN of the VLAN splinter port, and pushes
3620  * a VLAN header onto 'packet' (if it is nonnull).
3621  *
3622  * Similarly, this function also includes some logic to help with tunnels.  It
3623  * may modify 'flow' as necessary to make the tunneling implementation
3624  * transparent to the upcall processing logic.
3625  *
3626  * Returns 0 if successful, ENODEV if the parsed flow has no associated ofport,
3627  * or some other positive errno if there are other problems. */
3628 static int
3629 ofproto_receive(const struct dpif_backer *backer, struct ofpbuf *packet,
3630                 const struct nlattr *key, size_t key_len,
3631                 struct flow *flow, enum odp_key_fitness *fitnessp,
3632                 struct ofproto_dpif **ofproto, odp_port_t *odp_in_port)
3633 {
3634     const struct ofport_dpif *port;
3635     enum odp_key_fitness fitness;
3636     int error = ENODEV;
3637
3638     fitness = odp_flow_key_to_flow(key, key_len, flow);
3639     if (fitness == ODP_FIT_ERROR) {
3640         error = EINVAL;
3641         goto exit;
3642     }
3643
3644     if (odp_in_port) {
3645         *odp_in_port = flow->in_port.odp_port;
3646     }
3647
3648     port = (tnl_port_should_receive(flow)
3649             ? ofport_dpif_cast(tnl_port_receive(flow))
3650             : odp_port_to_ofport(backer, flow->in_port.odp_port));
3651     flow->in_port.ofp_port = port ? port->up.ofp_port : OFPP_NONE;
3652     if (!port) {
3653         goto exit;
3654     }
3655
3656     /* XXX: Since the tunnel module is not scoped per backer, for a tunnel port
3657      * it's theoretically possible that we'll receive an ofport belonging to an
3658      * entirely different datapath.  In practice, this can't happen because no
3659      * platforms has two separate datapaths which each support tunneling. */
3660     ovs_assert(ofproto_dpif_cast(port->up.ofproto)->backer == backer);
3661
3662     if (vsp_adjust_flow(ofproto_dpif_cast(port->up.ofproto), flow)) {
3663         if (packet) {
3664             /* Make the packet resemble the flow, so that it gets sent to
3665              * an OpenFlow controller properly, so that it looks correct
3666              * for sFlow, and so that flow_extract() will get the correct
3667              * vlan_tci if it is called on 'packet'.
3668              *
3669              * The allocated space inside 'packet' probably also contains
3670              * 'key', that is, both 'packet' and 'key' are probably part of
3671              * a struct dpif_upcall (see the large comment on that
3672              * structure definition), so pushing data on 'packet' is in
3673              * general not a good idea since it could overwrite 'key' or
3674              * free it as a side effect.  However, it's OK in this special
3675              * case because we know that 'packet' is inside a Netlink
3676              * attribute: pushing 4 bytes will just overwrite the 4-byte
3677              * "struct nlattr", which is fine since we don't need that
3678              * header anymore. */
3679             eth_push_vlan(packet, flow->vlan_tci);
3680         }
3681         /* We can't reproduce 'key' from 'flow'. */
3682         fitness = fitness == ODP_FIT_PERFECT ? ODP_FIT_TOO_MUCH : fitness;
3683     }
3684     error = 0;
3685
3686     if (ofproto) {
3687         *ofproto = ofproto_dpif_cast(port->up.ofproto);
3688     }
3689
3690 exit:
3691     if (fitnessp) {
3692         *fitnessp = fitness;
3693     }
3694     return error;
3695 }
3696
3697 static void
3698 handle_miss_upcalls(struct dpif_backer *backer, struct dpif_upcall *upcalls,
3699                     size_t n_upcalls)
3700 {
3701     struct dpif_upcall *upcall;
3702     struct flow_miss *miss;
3703     struct flow_miss misses[FLOW_MISS_MAX_BATCH];
3704     struct flow_miss_op flow_miss_ops[FLOW_MISS_MAX_BATCH * 2];
3705     struct dpif_op *dpif_ops[FLOW_MISS_MAX_BATCH * 2];
3706     struct hmap todo;
3707     int n_misses;
3708     size_t n_ops;
3709     size_t i;
3710
3711     if (!n_upcalls) {
3712         return;
3713     }
3714
3715     /* Construct the to-do list.
3716      *
3717      * This just amounts to extracting the flow from each packet and sticking
3718      * the packets that have the same flow in the same "flow_miss" structure so
3719      * that we can process them together. */
3720     hmap_init(&todo);
3721     n_misses = 0;
3722     for (upcall = upcalls; upcall < &upcalls[n_upcalls]; upcall++) {
3723         struct flow_miss *miss = &misses[n_misses];
3724         struct flow_miss *existing_miss;
3725         struct ofproto_dpif *ofproto;
3726         odp_port_t odp_in_port;
3727         struct flow flow;
3728         uint32_t hash;
3729         int error;
3730
3731         error = ofproto_receive(backer, upcall->packet, upcall->key,
3732                                 upcall->key_len, &flow, &miss->key_fitness,
3733                                 &ofproto, &odp_in_port);
3734         if (error == ENODEV) {
3735             struct drop_key *drop_key;
3736
3737             /* Received packet on datapath port for which we couldn't
3738              * associate an ofproto.  This can happen if a port is removed
3739              * while traffic is being received.  Print a rate-limited message
3740              * in case it happens frequently.  Install a drop flow so
3741              * that future packets of the flow are inexpensively dropped
3742              * in the kernel. */
3743             VLOG_INFO_RL(&rl, "received packet on unassociated datapath port "
3744                               "%"PRIu32, odp_in_port);
3745
3746             drop_key = drop_key_lookup(backer, upcall->key, upcall->key_len);
3747             if (!drop_key) {
3748                 drop_key = xmalloc(sizeof *drop_key);
3749                 drop_key->key = xmemdup(upcall->key, upcall->key_len);
3750                 drop_key->key_len = upcall->key_len;
3751
3752                 hmap_insert(&backer->drop_keys, &drop_key->hmap_node,
3753                             hash_bytes(drop_key->key, drop_key->key_len, 0));
3754                 dpif_flow_put(backer->dpif, DPIF_FP_CREATE | DPIF_FP_MODIFY,
3755                               drop_key->key, drop_key->key_len,
3756                               NULL, 0, NULL, 0, NULL);
3757             }
3758             continue;
3759         }
3760         if (error) {
3761             continue;
3762         }
3763
3764         ofproto->n_missed++;
3765         flow_extract(upcall->packet, flow.skb_priority, flow.skb_mark,
3766                      &flow.tunnel, &flow.in_port, &miss->flow);
3767
3768         /* Add other packets to a to-do list. */
3769         hash = flow_hash(&miss->flow, 0);
3770         existing_miss = flow_miss_find(&todo, ofproto, &miss->flow, hash);
3771         if (!existing_miss) {
3772             hmap_insert(&todo, &miss->hmap_node, hash);
3773             miss->ofproto = ofproto;
3774             miss->key = upcall->key;
3775             miss->key_len = upcall->key_len;
3776             miss->upcall_type = upcall->type;
3777             list_init(&miss->packets);
3778
3779             n_misses++;
3780         } else {
3781             miss = existing_miss;
3782         }
3783         list_push_back(&miss->packets, &upcall->packet->list_node);
3784     }
3785
3786     /* Process each element in the to-do list, constructing the set of
3787      * operations to batch. */
3788     n_ops = 0;
3789     HMAP_FOR_EACH (miss, hmap_node, &todo) {
3790         handle_flow_miss(miss, flow_miss_ops, &n_ops);
3791     }
3792     ovs_assert(n_ops <= ARRAY_SIZE(flow_miss_ops));
3793
3794     /* Execute batch. */
3795     for (i = 0; i < n_ops; i++) {
3796         dpif_ops[i] = &flow_miss_ops[i].dpif_op;
3797     }
3798     dpif_operate(backer->dpif, dpif_ops, n_ops);
3799
3800     for (i = 0; i < n_ops; i++) {
3801         if (dpif_ops[i]->error != 0
3802             && flow_miss_ops[i].dpif_op.type == DPIF_OP_FLOW_PUT
3803             && flow_miss_ops[i].subfacet) {
3804             struct subfacet *subfacet = flow_miss_ops[i].subfacet;
3805
3806             COVERAGE_INC(subfacet_install_fail);
3807
3808             subfacet->path = SF_NOT_INSTALLED;
3809         }
3810
3811         /* Free memory. */
3812         if (flow_miss_ops[i].xout_garbage) {
3813             xlate_out_uninit(&flow_miss_ops[i].xout);
3814         }
3815     }
3816     hmap_destroy(&todo);
3817 }
3818
3819 static enum { SFLOW_UPCALL, MISS_UPCALL, BAD_UPCALL, FLOW_SAMPLE_UPCALL,
3820               IPFIX_UPCALL }
3821 classify_upcall(const struct dpif_upcall *upcall)
3822 {
3823     size_t userdata_len;
3824     union user_action_cookie cookie;
3825
3826     /* First look at the upcall type. */
3827     switch (upcall->type) {
3828     case DPIF_UC_ACTION:
3829         break;
3830
3831     case DPIF_UC_MISS:
3832         return MISS_UPCALL;
3833
3834     case DPIF_N_UC_TYPES:
3835     default:
3836         VLOG_WARN_RL(&rl, "upcall has unexpected type %"PRIu32, upcall->type);
3837         return BAD_UPCALL;
3838     }
3839
3840     /* "action" upcalls need a closer look. */
3841     if (!upcall->userdata) {
3842         VLOG_WARN_RL(&rl, "action upcall missing cookie");
3843         return BAD_UPCALL;
3844     }
3845     userdata_len = nl_attr_get_size(upcall->userdata);
3846     if (userdata_len < sizeof cookie.type
3847         || userdata_len > sizeof cookie) {
3848         VLOG_WARN_RL(&rl, "action upcall cookie has unexpected size %zu",
3849                      userdata_len);
3850         return BAD_UPCALL;
3851     }
3852     memset(&cookie, 0, sizeof cookie);
3853     memcpy(&cookie, nl_attr_get(upcall->userdata), userdata_len);
3854     if (userdata_len == sizeof cookie.sflow
3855         && cookie.type == USER_ACTION_COOKIE_SFLOW) {
3856         return SFLOW_UPCALL;
3857     } else if (userdata_len == sizeof cookie.slow_path
3858                && cookie.type == USER_ACTION_COOKIE_SLOW_PATH) {
3859         return MISS_UPCALL;
3860     } else if (userdata_len == sizeof cookie.flow_sample
3861                && cookie.type == USER_ACTION_COOKIE_FLOW_SAMPLE) {
3862         return FLOW_SAMPLE_UPCALL;
3863     } else if (userdata_len == sizeof cookie.ipfix
3864                && cookie.type == USER_ACTION_COOKIE_IPFIX) {
3865         return IPFIX_UPCALL;
3866     } else {
3867         VLOG_WARN_RL(&rl, "invalid user cookie of type %"PRIu16
3868                      " and size %zu", cookie.type, userdata_len);
3869         return BAD_UPCALL;
3870     }
3871 }
3872
3873 static void
3874 handle_sflow_upcall(struct dpif_backer *backer,
3875                     const struct dpif_upcall *upcall)
3876 {
3877     struct ofproto_dpif *ofproto;
3878     union user_action_cookie cookie;
3879     struct flow flow;
3880     odp_port_t odp_in_port;
3881
3882     if (ofproto_receive(backer, upcall->packet, upcall->key, upcall->key_len,
3883                         &flow, NULL, &ofproto, &odp_in_port)
3884         || !ofproto->sflow) {
3885         return;
3886     }
3887
3888     memset(&cookie, 0, sizeof cookie);
3889     memcpy(&cookie, nl_attr_get(upcall->userdata), sizeof cookie.sflow);
3890     dpif_sflow_received(ofproto->sflow, upcall->packet, &flow,
3891                         odp_in_port, &cookie);
3892 }
3893
3894 static void
3895 handle_flow_sample_upcall(struct dpif_backer *backer,
3896                           const struct dpif_upcall *upcall)
3897 {
3898     struct ofproto_dpif *ofproto;
3899     union user_action_cookie cookie;
3900     struct flow flow;
3901
3902     if (ofproto_receive(backer, upcall->packet, upcall->key, upcall->key_len,
3903                         &flow, NULL, &ofproto, NULL)
3904         || !ofproto->ipfix) {
3905         return;
3906     }
3907
3908     memset(&cookie, 0, sizeof cookie);
3909     memcpy(&cookie, nl_attr_get(upcall->userdata), sizeof cookie.flow_sample);
3910
3911     /* The flow reflects exactly the contents of the packet.  Sample
3912      * the packet using it. */
3913     dpif_ipfix_flow_sample(ofproto->ipfix, upcall->packet, &flow,
3914                            cookie.flow_sample.collector_set_id,
3915                            cookie.flow_sample.probability,
3916                            cookie.flow_sample.obs_domain_id,
3917                            cookie.flow_sample.obs_point_id);
3918 }
3919
3920 static void
3921 handle_ipfix_upcall(struct dpif_backer *backer,
3922                     const struct dpif_upcall *upcall)
3923 {
3924     struct ofproto_dpif *ofproto;
3925     struct flow flow;
3926
3927     if (ofproto_receive(backer, upcall->packet, upcall->key, upcall->key_len,
3928                         &flow, NULL, &ofproto, NULL)
3929         || !ofproto->ipfix) {
3930         return;
3931     }
3932
3933     /* The flow reflects exactly the contents of the packet.  Sample
3934      * the packet using it. */
3935     dpif_ipfix_bridge_sample(ofproto->ipfix, upcall->packet, &flow);
3936 }
3937
3938 static int
3939 handle_upcalls(struct dpif_backer *backer, unsigned int max_batch)
3940 {
3941     struct dpif_upcall misses[FLOW_MISS_MAX_BATCH];
3942     struct ofpbuf miss_bufs[FLOW_MISS_MAX_BATCH];
3943     uint64_t miss_buf_stubs[FLOW_MISS_MAX_BATCH][4096 / 8];
3944     int n_processed;
3945     int n_misses;
3946     int i;
3947
3948     ovs_assert(max_batch <= FLOW_MISS_MAX_BATCH);
3949
3950     n_misses = 0;
3951     for (n_processed = 0; n_processed < max_batch; n_processed++) {
3952         struct dpif_upcall *upcall = &misses[n_misses];
3953         struct ofpbuf *buf = &miss_bufs[n_misses];
3954         int error;
3955
3956         ofpbuf_use_stub(buf, miss_buf_stubs[n_misses],
3957                         sizeof miss_buf_stubs[n_misses]);
3958         error = dpif_recv(backer->dpif, upcall, buf);
3959         if (error) {
3960             ofpbuf_uninit(buf);
3961             break;
3962         }
3963
3964         switch (classify_upcall(upcall)) {
3965         case MISS_UPCALL:
3966             /* Handle it later. */
3967             n_misses++;
3968             break;
3969
3970         case SFLOW_UPCALL:
3971             handle_sflow_upcall(backer, upcall);
3972             ofpbuf_uninit(buf);
3973             break;
3974
3975         case FLOW_SAMPLE_UPCALL:
3976             handle_flow_sample_upcall(backer, upcall);
3977             ofpbuf_uninit(buf);
3978             break;
3979
3980         case IPFIX_UPCALL:
3981             handle_ipfix_upcall(backer, upcall);
3982             ofpbuf_uninit(buf);
3983             break;
3984
3985         case BAD_UPCALL:
3986             ofpbuf_uninit(buf);
3987             break;
3988         }
3989     }
3990
3991     /* Handle deferred MISS_UPCALL processing. */
3992     handle_miss_upcalls(backer, misses, n_misses);
3993     for (i = 0; i < n_misses; i++) {
3994         ofpbuf_uninit(&miss_bufs[i]);
3995     }
3996
3997     return n_processed;
3998 }
3999 \f
4000 /* Flow expiration. */
4001
4002 static int subfacet_max_idle(const struct dpif_backer *);
4003 static void update_stats(struct dpif_backer *);
4004 static void rule_expire(struct rule_dpif *);
4005 static void expire_subfacets(struct dpif_backer *, int dp_max_idle);
4006
4007 /* This function is called periodically by run().  Its job is to collect
4008  * updates for the flows that have been installed into the datapath, most
4009  * importantly when they last were used, and then use that information to
4010  * expire flows that have not been used recently.
4011  *
4012  * Returns the number of milliseconds after which it should be called again. */
4013 static int
4014 expire(struct dpif_backer *backer)
4015 {
4016     struct ofproto_dpif *ofproto;
4017     size_t n_subfacets;
4018     int max_idle;
4019
4020     /* Periodically clear out the drop keys in an effort to keep them
4021      * relatively few. */
4022     drop_key_clear(backer);
4023
4024     /* Update stats for each flow in the backer. */
4025     update_stats(backer);
4026
4027     n_subfacets = hmap_count(&backer->subfacets);
4028     if (n_subfacets) {
4029         struct subfacet *subfacet;
4030         long long int total, now;
4031
4032         total = 0;
4033         now = time_msec();
4034         HMAP_FOR_EACH (subfacet, hmap_node, &backer->subfacets) {
4035             total += now - subfacet->created;
4036         }
4037         backer->avg_subfacet_life += total / n_subfacets;
4038     }
4039     backer->avg_subfacet_life /= 2;
4040
4041     backer->avg_n_subfacet += n_subfacets;
4042     backer->avg_n_subfacet /= 2;
4043
4044     backer->max_n_subfacet = MAX(backer->max_n_subfacet, n_subfacets);
4045
4046     max_idle = subfacet_max_idle(backer);
4047     expire_subfacets(backer, max_idle);
4048
4049     HMAP_FOR_EACH (ofproto, all_ofproto_dpifs_node, &all_ofproto_dpifs) {
4050         struct rule *rule, *next_rule;
4051
4052         if (ofproto->backer != backer) {
4053             continue;
4054         }
4055
4056         /* Expire OpenFlow flows whose idle_timeout or hard_timeout
4057          * has passed. */
4058         LIST_FOR_EACH_SAFE (rule, next_rule, expirable,
4059                             &ofproto->up.expirable) {
4060             rule_expire(rule_dpif_cast(rule));
4061         }
4062
4063         /* All outstanding data in existing flows has been accounted, so it's a
4064          * good time to do bond rebalancing. */
4065         if (ofproto->has_bonded_bundles) {
4066             struct ofbundle *bundle;
4067
4068             HMAP_FOR_EACH (bundle, hmap_node, &ofproto->bundles) {
4069                 if (bundle->bond) {
4070                     bond_rebalance(bundle->bond, &backer->revalidate_set);
4071                 }
4072             }
4073         }
4074     }
4075
4076     return MIN(max_idle, 1000);
4077 }
4078
4079 /* Updates flow table statistics given that the datapath just reported 'stats'
4080  * as 'subfacet''s statistics. */
4081 static void
4082 update_subfacet_stats(struct subfacet *subfacet,
4083                       const struct dpif_flow_stats *stats)
4084 {
4085     struct facet *facet = subfacet->facet;
4086     struct ofproto_dpif *ofproto = ofproto_dpif_cast(facet->rule->up.ofproto);
4087     struct dpif_flow_stats diff;
4088
4089     diff.tcp_flags = stats->tcp_flags;
4090     diff.used = stats->used;
4091
4092     if (stats->n_packets >= subfacet->dp_packet_count) {
4093         diff.n_packets = stats->n_packets - subfacet->dp_packet_count;
4094     } else {
4095         VLOG_WARN_RL(&rl, "unexpected packet count from the datapath");
4096         diff.n_packets = 0;
4097     }
4098
4099     if (stats->n_bytes >= subfacet->dp_byte_count) {
4100         diff.n_bytes = stats->n_bytes - subfacet->dp_byte_count;
4101     } else {
4102         VLOG_WARN_RL(&rl, "unexpected byte count from datapath");
4103         diff.n_bytes = 0;
4104     }
4105
4106     ofproto->n_hit += diff.n_packets;
4107     subfacet->dp_packet_count = stats->n_packets;
4108     subfacet->dp_byte_count = stats->n_bytes;
4109     subfacet_update_stats(subfacet, &diff);
4110
4111     if (facet->accounted_bytes < facet->byte_count) {
4112         facet_learn(facet);
4113         facet_account(facet);
4114         facet->accounted_bytes = facet->byte_count;
4115     }
4116 }
4117
4118 /* 'key' with length 'key_len' bytes is a flow in 'dpif' that we know nothing
4119  * about, or a flow that shouldn't be installed but was anyway.  Delete it. */
4120 static void
4121 delete_unexpected_flow(struct dpif_backer *backer,
4122                        const struct nlattr *key, size_t key_len)
4123 {
4124     if (!VLOG_DROP_WARN(&rl)) {
4125         struct ds s;
4126
4127         ds_init(&s);
4128         odp_flow_key_format(key, key_len, &s);
4129         VLOG_WARN("unexpected flow: %s", ds_cstr(&s));
4130         ds_destroy(&s);
4131     }
4132
4133     COVERAGE_INC(facet_unexpected);
4134     dpif_flow_del(backer->dpif, key, key_len, NULL);
4135 }
4136
4137 /* Update 'packet_count', 'byte_count', and 'used' members of installed facets.
4138  *
4139  * This function also pushes statistics updates to rules which each facet
4140  * resubmits into.  Generally these statistics will be accurate.  However, if a
4141  * facet changes the rule it resubmits into at some time in between
4142  * update_stats() runs, it is possible that statistics accrued to the
4143  * old rule will be incorrectly attributed to the new rule.  This could be
4144  * avoided by calling update_stats() whenever rules are created or
4145  * deleted.  However, the performance impact of making so many calls to the
4146  * datapath do not justify the benefit of having perfectly accurate statistics.
4147  *
4148  * In addition, this function maintains per ofproto flow hit counts. The patch
4149  * port is not treated specially. e.g. A packet ingress from br0 patched into
4150  * br1 will increase the hit count of br0 by 1, however, does not affect
4151  * the hit or miss counts of br1.
4152  */
4153 static void
4154 update_stats(struct dpif_backer *backer)
4155 {
4156     const struct dpif_flow_stats *stats;
4157     struct dpif_flow_dump dump;
4158     const struct nlattr *key, *mask;
4159     size_t key_len, mask_len;
4160
4161     dpif_flow_dump_start(&dump, backer->dpif);
4162     while (dpif_flow_dump_next(&dump, &key, &key_len,
4163                                &mask, &mask_len, NULL, NULL, &stats)) {
4164         struct subfacet *subfacet;
4165         uint32_t key_hash;
4166
4167         key_hash = odp_flow_key_hash(key, key_len);
4168         subfacet = subfacet_find(backer, key, key_len, key_hash);
4169         switch (subfacet ? subfacet->path : SF_NOT_INSTALLED) {
4170         case SF_FAST_PATH:
4171             update_subfacet_stats(subfacet, stats);
4172             break;
4173
4174         case SF_SLOW_PATH:
4175             /* Stats are updated per-packet. */
4176             break;
4177
4178         case SF_NOT_INSTALLED:
4179         default:
4180             delete_unexpected_flow(backer, key, key_len);
4181             break;
4182         }
4183         run_fast_rl();
4184     }
4185     dpif_flow_dump_done(&dump);
4186
4187     update_moving_averages(backer);
4188 }
4189
4190 /* Calculates and returns the number of milliseconds of idle time after which
4191  * subfacets should expire from the datapath.  When a subfacet expires, we fold
4192  * its statistics into its facet, and when a facet's last subfacet expires, we
4193  * fold its statistic into its rule. */
4194 static int
4195 subfacet_max_idle(const struct dpif_backer *backer)
4196 {
4197     /*
4198      * Idle time histogram.
4199      *
4200      * Most of the time a switch has a relatively small number of subfacets.
4201      * When this is the case we might as well keep statistics for all of them
4202      * in userspace and to cache them in the kernel datapath for performance as
4203      * well.
4204      *
4205      * As the number of subfacets increases, the memory required to maintain
4206      * statistics about them in userspace and in the kernel becomes
4207      * significant.  However, with a large number of subfacets it is likely
4208      * that only a few of them are "heavy hitters" that consume a large amount
4209      * of bandwidth.  At this point, only heavy hitters are worth caching in
4210      * the kernel and maintaining in userspaces; other subfacets we can
4211      * discard.
4212      *
4213      * The technique used to compute the idle time is to build a histogram with
4214      * N_BUCKETS buckets whose width is BUCKET_WIDTH msecs each.  Each subfacet
4215      * that is installed in the kernel gets dropped in the appropriate bucket.
4216      * After the histogram has been built, we compute the cutoff so that only
4217      * the most-recently-used 1% of subfacets (but at least
4218      * flow_eviction_threshold flows) are kept cached.  At least
4219      * the most-recently-used bucket of subfacets is kept, so actually an
4220      * arbitrary number of subfacets can be kept in any given expiration run
4221      * (though the next run will delete most of those unless they receive
4222      * additional data).
4223      *
4224      * This requires a second pass through the subfacets, in addition to the
4225      * pass made by update_stats(), because the former function never looks at
4226      * uninstallable subfacets.
4227      */
4228     enum { BUCKET_WIDTH = ROUND_UP(100, TIME_UPDATE_INTERVAL) };
4229     enum { N_BUCKETS = 5000 / BUCKET_WIDTH };
4230     int buckets[N_BUCKETS] = { 0 };
4231     int total, subtotal, bucket;
4232     struct subfacet *subfacet;
4233     long long int now;
4234     int i;
4235
4236     total = hmap_count(&backer->subfacets);
4237     if (total <= flow_eviction_threshold) {
4238         return N_BUCKETS * BUCKET_WIDTH;
4239     }
4240
4241     /* Build histogram. */
4242     now = time_msec();
4243     HMAP_FOR_EACH (subfacet, hmap_node, &backer->subfacets) {
4244         long long int idle = now - subfacet->used;
4245         int bucket = (idle <= 0 ? 0
4246                       : idle >= BUCKET_WIDTH * N_BUCKETS ? N_BUCKETS - 1
4247                       : (unsigned int) idle / BUCKET_WIDTH);
4248         buckets[bucket]++;
4249     }
4250
4251     /* Find the first bucket whose flows should be expired. */
4252     subtotal = bucket = 0;
4253     do {
4254         subtotal += buckets[bucket++];
4255     } while (bucket < N_BUCKETS &&
4256              subtotal < MAX(flow_eviction_threshold, total / 100));
4257
4258     if (VLOG_IS_DBG_ENABLED()) {
4259         struct ds s;
4260
4261         ds_init(&s);
4262         ds_put_cstr(&s, "keep");
4263         for (i = 0; i < N_BUCKETS; i++) {
4264             if (i == bucket) {
4265                 ds_put_cstr(&s, ", drop");
4266             }
4267             if (buckets[i]) {
4268                 ds_put_format(&s, " %d:%d", i * BUCKET_WIDTH, buckets[i]);
4269             }
4270         }
4271         VLOG_INFO("%s (msec:count)", ds_cstr(&s));
4272         ds_destroy(&s);
4273     }
4274
4275     return bucket * BUCKET_WIDTH;
4276 }
4277
4278 static void
4279 expire_subfacets(struct dpif_backer *backer, int dp_max_idle)
4280 {
4281     /* Cutoff time for most flows. */
4282     long long int normal_cutoff = time_msec() - dp_max_idle;
4283
4284     /* We really want to keep flows for special protocols around, so use a more
4285      * conservative cutoff. */
4286     long long int special_cutoff = time_msec() - 10000;
4287
4288     struct subfacet *subfacet, *next_subfacet;
4289     struct subfacet *batch[SUBFACET_DESTROY_MAX_BATCH];
4290     int n_batch;
4291
4292     n_batch = 0;
4293     HMAP_FOR_EACH_SAFE (subfacet, next_subfacet, hmap_node,
4294                         &backer->subfacets) {
4295         long long int cutoff;
4296
4297         cutoff = (subfacet->facet->xout.slow & (SLOW_CFM | SLOW_BFD | SLOW_LACP
4298                                                 | SLOW_STP)
4299                   ? special_cutoff
4300                   : normal_cutoff);
4301         if (subfacet->used < cutoff) {
4302             if (subfacet->path != SF_NOT_INSTALLED) {
4303                 batch[n_batch++] = subfacet;
4304                 if (n_batch >= SUBFACET_DESTROY_MAX_BATCH) {
4305                     subfacet_destroy_batch(backer, batch, n_batch);
4306                     n_batch = 0;
4307                 }
4308             } else {
4309                 subfacet_destroy(subfacet);
4310             }
4311         }
4312     }
4313
4314     if (n_batch > 0) {
4315         subfacet_destroy_batch(backer, batch, n_batch);
4316     }
4317 }
4318
4319 /* If 'rule' is an OpenFlow rule, that has expired according to OpenFlow rules,
4320  * then delete it entirely. */
4321 static void
4322 rule_expire(struct rule_dpif *rule)
4323 {
4324     struct facet *facet, *next_facet;
4325     long long int now;
4326     uint8_t reason;
4327
4328     if (rule->up.pending) {
4329         /* We'll have to expire it later. */
4330         return;
4331     }
4332
4333     /* Has 'rule' expired? */
4334     now = time_msec();
4335     if (rule->up.hard_timeout
4336         && now > rule->up.modified + rule->up.hard_timeout * 1000) {
4337         reason = OFPRR_HARD_TIMEOUT;
4338     } else if (rule->up.idle_timeout
4339                && now > rule->up.used + rule->up.idle_timeout * 1000) {
4340         reason = OFPRR_IDLE_TIMEOUT;
4341     } else {
4342         return;
4343     }
4344
4345     COVERAGE_INC(ofproto_dpif_expired);
4346
4347     /* Update stats.  (This is a no-op if the rule expired due to an idle
4348      * timeout, because that only happens when the rule has no facets left.) */
4349     LIST_FOR_EACH_SAFE (facet, next_facet, list_node, &rule->facets) {
4350         facet_remove(facet);
4351     }
4352
4353     /* Get rid of the rule. */
4354     ofproto_rule_expire(&rule->up, reason);
4355 }
4356 \f
4357 /* Facets. */
4358
4359 /* Creates and returns a new facet based on 'miss'.
4360  *
4361  * The caller must already have determined that no facet with an identical
4362  * 'miss->flow' exists in 'miss->ofproto'.
4363  *
4364  * 'rule' and 'xout' must have been created based on 'miss'.
4365  *
4366  * 'facet'' statistics are initialized based on 'stats'.
4367  *
4368  * The facet will initially have no subfacets.  The caller should create (at
4369  * least) one subfacet with subfacet_create(). */
4370 static struct facet *
4371 facet_create(const struct flow_miss *miss, struct rule_dpif *rule,
4372              struct xlate_out *xout, struct dpif_flow_stats *stats)
4373 {
4374     struct ofproto_dpif *ofproto = miss->ofproto;
4375     struct facet *facet;
4376     struct match match;
4377
4378     facet = xzalloc(sizeof *facet);
4379     facet->packet_count = facet->prev_packet_count = stats->n_packets;
4380     facet->byte_count = facet->prev_byte_count = stats->n_bytes;
4381     facet->tcp_flags = stats->tcp_flags;
4382     facet->used = stats->used;
4383     facet->flow = miss->flow;
4384     facet->learn_rl = time_msec() + 500;
4385     facet->rule = rule;
4386
4387     list_push_back(&facet->rule->facets, &facet->list_node);
4388     list_init(&facet->subfacets);
4389     netflow_flow_init(&facet->nf_flow);
4390     netflow_flow_update_time(ofproto->netflow, &facet->nf_flow, facet->used);
4391
4392     xlate_out_copy(&facet->xout, xout);
4393
4394     match_init(&match, &facet->flow, &facet->xout.wc);
4395     cls_rule_init(&facet->cr, &match, OFP_DEFAULT_PRIORITY);
4396     classifier_insert(&ofproto->facets, &facet->cr);
4397
4398     facet->nf_flow.output_iface = facet->xout.nf_output_iface;
4399
4400     return facet;
4401 }
4402
4403 static void
4404 facet_free(struct facet *facet)
4405 {
4406     if (facet) {
4407         xlate_out_uninit(&facet->xout);
4408         free(facet);
4409     }
4410 }
4411
4412 /* Executes, within 'ofproto', the 'n_actions' actions in 'actions' on
4413  * 'packet', which arrived on 'in_port'. */
4414 static bool
4415 execute_odp_actions(struct ofproto_dpif *ofproto, const struct flow *flow,
4416                     const struct nlattr *odp_actions, size_t actions_len,
4417                     struct ofpbuf *packet)
4418 {
4419     struct odputil_keybuf keybuf;
4420     struct ofpbuf key;
4421     int error;
4422
4423     ofpbuf_use_stack(&key, &keybuf, sizeof keybuf);
4424     odp_flow_key_from_flow(&key, flow,
4425                            ofp_port_to_odp_port(ofproto, flow->in_port.ofp_port));
4426
4427     error = dpif_execute(ofproto->backer->dpif, key.data, key.size,
4428                          odp_actions, actions_len, packet);
4429     return !error;
4430 }
4431
4432 /* Remove 'facet' from its ofproto and free up the associated memory:
4433  *
4434  *   - If 'facet' was installed in the datapath, uninstalls it and updates its
4435  *     rule's statistics, via subfacet_uninstall().
4436  *
4437  *   - Removes 'facet' from its rule and from ofproto->facets.
4438  */
4439 static void
4440 facet_remove(struct facet *facet)
4441 {
4442     struct ofproto_dpif *ofproto = ofproto_dpif_cast(facet->rule->up.ofproto);
4443     struct subfacet *subfacet, *next_subfacet;
4444
4445     ovs_assert(!list_is_empty(&facet->subfacets));
4446
4447     /* First uninstall all of the subfacets to get final statistics. */
4448     LIST_FOR_EACH (subfacet, list_node, &facet->subfacets) {
4449         subfacet_uninstall(subfacet);
4450     }
4451
4452     /* Flush the final stats to the rule.
4453      *
4454      * This might require us to have at least one subfacet around so that we
4455      * can use its actions for accounting in facet_account(), which is why we
4456      * have uninstalled but not yet destroyed the subfacets. */
4457     facet_flush_stats(facet);
4458
4459     /* Now we're really all done so destroy everything. */
4460     LIST_FOR_EACH_SAFE (subfacet, next_subfacet, list_node,
4461                         &facet->subfacets) {
4462         subfacet_destroy__(subfacet);
4463     }
4464     classifier_remove(&ofproto->facets, &facet->cr);
4465     cls_rule_destroy(&facet->cr);
4466     list_remove(&facet->list_node);
4467     facet_free(facet);
4468 }
4469
4470 /* Feed information from 'facet' back into the learning table to keep it in
4471  * sync with what is actually flowing through the datapath. */
4472 static void
4473 facet_learn(struct facet *facet)
4474 {
4475     long long int now = time_msec();
4476
4477     if (!facet->xout.has_fin_timeout && now < facet->learn_rl) {
4478         return;
4479     }
4480
4481     facet->learn_rl = now + 500;
4482
4483     if (!facet->xout.has_learn
4484         && !facet->xout.has_normal
4485         && (!facet->xout.has_fin_timeout
4486             || !(facet->tcp_flags & (TCP_FIN | TCP_RST)))) {
4487         return;
4488     }
4489
4490     facet_push_stats(facet, true);
4491 }
4492
4493 static void
4494 facet_account(struct facet *facet)
4495 {
4496     struct ofproto_dpif *ofproto = ofproto_dpif_cast(facet->rule->up.ofproto);
4497     const struct nlattr *a;
4498     unsigned int left;
4499     ovs_be16 vlan_tci;
4500     uint64_t n_bytes;
4501
4502     if (!facet->xout.has_normal || !ofproto->has_bonded_bundles) {
4503         return;
4504     }
4505     n_bytes = facet->byte_count - facet->accounted_bytes;
4506
4507     /* This loop feeds byte counters to bond_account() for rebalancing to use
4508      * as a basis.  We also need to track the actual VLAN on which the packet
4509      * is going to be sent to ensure that it matches the one passed to
4510      * bond_choose_output_slave().  (Otherwise, we will account to the wrong
4511      * hash bucket.)
4512      *
4513      * We use the actions from an arbitrary subfacet because they should all
4514      * be equally valid for our purpose. */
4515     vlan_tci = facet->flow.vlan_tci;
4516     NL_ATTR_FOR_EACH_UNSAFE (a, left, facet->xout.odp_actions.data,
4517                              facet->xout.odp_actions.size) {
4518         const struct ovs_action_push_vlan *vlan;
4519         struct ofport_dpif *port;
4520
4521         switch (nl_attr_type(a)) {
4522         case OVS_ACTION_ATTR_OUTPUT:
4523             port = get_odp_port(ofproto, nl_attr_get_odp_port(a));
4524             if (port && port->bundle && port->bundle->bond) {
4525                 bond_account(port->bundle->bond, &facet->flow,
4526                              vlan_tci_to_vid(vlan_tci), n_bytes);
4527             }
4528             break;
4529
4530         case OVS_ACTION_ATTR_POP_VLAN:
4531             vlan_tci = htons(0);
4532             break;
4533
4534         case OVS_ACTION_ATTR_PUSH_VLAN:
4535             vlan = nl_attr_get(a);
4536             vlan_tci = vlan->vlan_tci;
4537             break;
4538         }
4539     }
4540 }
4541
4542 /* Returns true if the only action for 'facet' is to send to the controller.
4543  * (We don't report NetFlow expiration messages for such facets because they
4544  * are just part of the control logic for the network, not real traffic). */
4545 static bool
4546 facet_is_controller_flow(struct facet *facet)
4547 {
4548     if (facet) {
4549         const struct rule *rule = &facet->rule->up;
4550         const struct ofpact *ofpacts = rule->ofpacts;
4551         size_t ofpacts_len = rule->ofpacts_len;
4552
4553         if (ofpacts_len > 0 &&
4554             ofpacts->type == OFPACT_CONTROLLER &&
4555             ofpact_next(ofpacts) >= ofpact_end(ofpacts, ofpacts_len)) {
4556             return true;
4557         }
4558     }
4559     return false;
4560 }
4561
4562 /* Folds all of 'facet''s statistics into its rule.  Also updates the
4563  * accounting ofhook and emits a NetFlow expiration if appropriate.  All of
4564  * 'facet''s statistics in the datapath should have been zeroed and folded into
4565  * its packet and byte counts before this function is called. */
4566 static void
4567 facet_flush_stats(struct facet *facet)
4568 {
4569     struct ofproto_dpif *ofproto = ofproto_dpif_cast(facet->rule->up.ofproto);
4570     struct subfacet *subfacet;
4571
4572     LIST_FOR_EACH (subfacet, list_node, &facet->subfacets) {
4573         ovs_assert(!subfacet->dp_byte_count);
4574         ovs_assert(!subfacet->dp_packet_count);
4575     }
4576
4577     facet_push_stats(facet, false);
4578     if (facet->accounted_bytes < facet->byte_count) {
4579         facet_account(facet);
4580         facet->accounted_bytes = facet->byte_count;
4581     }
4582
4583     if (ofproto->netflow && !facet_is_controller_flow(facet)) {
4584         struct ofexpired expired;
4585         expired.flow = facet->flow;
4586         expired.packet_count = facet->packet_count;
4587         expired.byte_count = facet->byte_count;
4588         expired.used = facet->used;
4589         netflow_expire(ofproto->netflow, &facet->nf_flow, &expired);
4590     }
4591
4592     /* Reset counters to prevent double counting if 'facet' ever gets
4593      * reinstalled. */
4594     facet_reset_counters(facet);
4595
4596     netflow_flow_clear(&facet->nf_flow);
4597     facet->tcp_flags = 0;
4598 }
4599
4600 /* Searches 'ofproto''s table of facets for one which would be responsible for
4601  * 'flow'.  Returns it if found, otherwise a null pointer.
4602  *
4603  * The returned facet might need revalidation; use facet_lookup_valid()
4604  * instead if that is important. */
4605 static struct facet *
4606 facet_find(struct ofproto_dpif *ofproto, const struct flow *flow)
4607 {
4608     struct cls_rule *cr = classifier_lookup(&ofproto->facets, flow, NULL);
4609     return cr ? CONTAINER_OF(cr, struct facet, cr) : NULL;
4610 }
4611
4612 /* Searches 'ofproto''s table of facets for one capable that covers
4613  * 'flow'.  Returns it if found, otherwise a null pointer.
4614  *
4615  * The returned facet is guaranteed to be valid. */
4616 static struct facet *
4617 facet_lookup_valid(struct ofproto_dpif *ofproto, const struct flow *flow)
4618 {
4619     struct facet *facet;
4620
4621     facet = facet_find(ofproto, flow);
4622     if (facet
4623         && (ofproto->backer->need_revalidate
4624             || tag_set_intersects(&ofproto->backer->revalidate_set,
4625                                   facet->xout.tags))
4626         && !facet_revalidate(facet)) {
4627         return NULL;
4628     }
4629
4630     return facet;
4631 }
4632
4633 static bool
4634 facet_check_consistency(struct facet *facet)
4635 {
4636     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 15);
4637
4638     struct ofproto_dpif *ofproto = ofproto_dpif_cast(facet->rule->up.ofproto);
4639
4640     struct xlate_out xout;
4641     struct xlate_in xin;
4642
4643     struct rule_dpif *rule;
4644     bool ok;
4645
4646     /* Check the rule for consistency. */
4647     rule = rule_dpif_lookup(ofproto, &facet->flow, NULL);
4648     if (rule != facet->rule) {
4649         if (!VLOG_DROP_WARN(&rl)) {
4650             struct ds s = DS_EMPTY_INITIALIZER;
4651
4652             flow_format(&s, &facet->flow);
4653             ds_put_format(&s, ": facet associated with wrong rule (was "
4654                           "table=%"PRIu8",", facet->rule->up.table_id);
4655             cls_rule_format(&facet->rule->up.cr, &s);
4656             ds_put_format(&s, ") (should have been table=%"PRIu8",",
4657                           rule->up.table_id);
4658             cls_rule_format(&rule->up.cr, &s);
4659             ds_put_char(&s, ')');
4660
4661             VLOG_WARN("%s", ds_cstr(&s));
4662             ds_destroy(&s);
4663         }
4664         return false;
4665     }
4666
4667     /* Check the datapath actions for consistency. */
4668     xlate_in_init(&xin, ofproto, &facet->flow, rule, 0, NULL);
4669     xlate_actions(&xin, &xout);
4670
4671     ok = ofpbuf_equal(&facet->xout.odp_actions, &xout.odp_actions)
4672         && facet->xout.slow == xout.slow;
4673     if (!ok && !VLOG_DROP_WARN(&rl)) {
4674         struct ds s = DS_EMPTY_INITIALIZER;
4675
4676         flow_format(&s, &facet->flow);
4677         ds_put_cstr(&s, ": inconsistency in facet");
4678
4679         if (!ofpbuf_equal(&facet->xout.odp_actions, &xout.odp_actions)) {
4680             ds_put_cstr(&s, " (actions were: ");
4681             format_odp_actions(&s, facet->xout.odp_actions.data,
4682                                facet->xout.odp_actions.size);
4683             ds_put_cstr(&s, ") (correct actions: ");
4684             format_odp_actions(&s, xout.odp_actions.data,
4685                                xout.odp_actions.size);
4686             ds_put_char(&s, ')');
4687         }
4688
4689         if (facet->xout.slow != xout.slow) {
4690             ds_put_format(&s, " slow path incorrect. should be %d", xout.slow);
4691         }
4692
4693         VLOG_WARN("%s", ds_cstr(&s));
4694         ds_destroy(&s);
4695     }
4696     xlate_out_uninit(&xout);
4697
4698     return ok;
4699 }
4700
4701 /* Re-searches the classifier for 'facet':
4702  *
4703  *   - If the rule found is different from 'facet''s current rule, moves
4704  *     'facet' to the new rule and recompiles its actions.
4705  *
4706  *   - If the rule found is the same as 'facet''s current rule, leaves 'facet'
4707  *     where it is and recompiles its actions anyway.
4708  *
4709  *   - If any of 'facet''s subfacets correspond to a new flow according to
4710  *     ofproto_receive(), 'facet' is removed.
4711  *
4712  *   Returns true if 'facet' is still valid.  False if 'facet' was removed. */
4713 static bool
4714 facet_revalidate(struct facet *facet)
4715 {
4716     struct ofproto_dpif *ofproto = ofproto_dpif_cast(facet->rule->up.ofproto);
4717     struct rule_dpif *new_rule;
4718     struct subfacet *subfacet;
4719     struct flow_wildcards wc;
4720     struct xlate_out xout;
4721     struct xlate_in xin;
4722
4723     COVERAGE_INC(facet_revalidate);
4724
4725     /* Check that child subfacets still correspond to this facet.  Tunnel
4726      * configuration changes could cause a subfacet's OpenFlow in_port to
4727      * change. */
4728     LIST_FOR_EACH (subfacet, list_node, &facet->subfacets) {
4729         struct ofproto_dpif *recv_ofproto;
4730         struct flow recv_flow;
4731         int error;
4732
4733         error = ofproto_receive(ofproto->backer, NULL, subfacet->key,
4734                                 subfacet->key_len, &recv_flow, NULL,
4735                                 &recv_ofproto, NULL);
4736         if (error
4737             || recv_ofproto != ofproto
4738             || facet != facet_find(ofproto, &recv_flow)) {
4739             facet_remove(facet);
4740             return false;
4741         }
4742     }
4743
4744     flow_wildcards_init_catchall(&wc);
4745     new_rule = rule_dpif_lookup(ofproto, &facet->flow, &wc);
4746
4747     /* Calculate new datapath actions.
4748      *
4749      * We do not modify any 'facet' state yet, because we might need to, e.g.,
4750      * emit a NetFlow expiration and, if so, we need to have the old state
4751      * around to properly compose it. */
4752     xlate_in_init(&xin, ofproto, &facet->flow, new_rule, 0, NULL);
4753     xlate_actions(&xin, &xout);
4754     flow_wildcards_or(&xout.wc, &xout.wc, &wc);
4755
4756     /* A facet's slow path reason should only change under dramatic
4757      * circumstances.  Rather than try to update everything, it's simpler to
4758      * remove the facet and start over.
4759      *
4760      * More importantly, if a facet's wildcards change, it will be relatively
4761      * difficult to figure out if its subfacets still belong to it, and if not
4762      * which facet they may belong to.  Again, to avoid the complexity, we
4763      * simply give up instead. */
4764     if (facet->xout.slow != xout.slow
4765         || memcmp(&facet->xout.wc, &xout.wc, sizeof xout.wc)) {
4766         facet_remove(facet);
4767         xlate_out_uninit(&xout);
4768         return false;
4769     }
4770
4771     if (!ofpbuf_equal(&facet->xout.odp_actions, &xout.odp_actions)) {
4772         LIST_FOR_EACH(subfacet, list_node, &facet->subfacets) {
4773             if (subfacet->path == SF_FAST_PATH) {
4774                 struct dpif_flow_stats stats;
4775
4776                 subfacet_install(subfacet, &xout.odp_actions, &stats);
4777                 subfacet_update_stats(subfacet, &stats);
4778             }
4779         }
4780
4781         facet_flush_stats(facet);
4782
4783         ofpbuf_clear(&facet->xout.odp_actions);
4784         ofpbuf_put(&facet->xout.odp_actions, xout.odp_actions.data,
4785                    xout.odp_actions.size);
4786     }
4787
4788     /* Update 'facet' now that we've taken care of all the old state. */
4789     facet->xout.tags = xout.tags;
4790     facet->xout.slow = xout.slow;
4791     facet->xout.has_learn = xout.has_learn;
4792     facet->xout.has_normal = xout.has_normal;
4793     facet->xout.has_fin_timeout = xout.has_fin_timeout;
4794     facet->xout.nf_output_iface = xout.nf_output_iface;
4795     facet->xout.mirrors = xout.mirrors;
4796     facet->nf_flow.output_iface = facet->xout.nf_output_iface;
4797
4798     if (facet->rule != new_rule) {
4799         COVERAGE_INC(facet_changed_rule);
4800         list_remove(&facet->list_node);
4801         list_push_back(&new_rule->facets, &facet->list_node);
4802         facet->rule = new_rule;
4803         facet->used = new_rule->up.created;
4804         facet->prev_used = facet->used;
4805     }
4806
4807     xlate_out_uninit(&xout);
4808     return true;
4809 }
4810
4811 static void
4812 facet_reset_counters(struct facet *facet)
4813 {
4814     facet->packet_count = 0;
4815     facet->byte_count = 0;
4816     facet->prev_packet_count = 0;
4817     facet->prev_byte_count = 0;
4818     facet->accounted_bytes = 0;
4819 }
4820
4821 static void
4822 facet_push_stats(struct facet *facet, bool may_learn)
4823 {
4824     struct dpif_flow_stats stats;
4825
4826     ovs_assert(facet->packet_count >= facet->prev_packet_count);
4827     ovs_assert(facet->byte_count >= facet->prev_byte_count);
4828     ovs_assert(facet->used >= facet->prev_used);
4829
4830     stats.n_packets = facet->packet_count - facet->prev_packet_count;
4831     stats.n_bytes = facet->byte_count - facet->prev_byte_count;
4832     stats.used = facet->used;
4833     stats.tcp_flags = facet->tcp_flags;
4834
4835     if (may_learn || stats.n_packets || facet->used > facet->prev_used) {
4836         struct ofproto_dpif *ofproto =
4837             ofproto_dpif_cast(facet->rule->up.ofproto);
4838
4839         struct ofport_dpif *in_port;
4840         struct xlate_in xin;
4841
4842         facet->prev_packet_count = facet->packet_count;
4843         facet->prev_byte_count = facet->byte_count;
4844         facet->prev_used = facet->used;
4845
4846         in_port = get_ofp_port(ofproto, facet->flow.in_port.ofp_port);
4847         if (in_port && in_port->tnl_port) {
4848             netdev_vport_inc_rx(in_port->up.netdev, &stats);
4849         }
4850
4851         rule_credit_stats(facet->rule, &stats);
4852         netflow_flow_update_time(ofproto->netflow, &facet->nf_flow,
4853                                  facet->used);
4854         netflow_flow_update_flags(&facet->nf_flow, facet->tcp_flags);
4855         update_mirror_stats(ofproto, facet->xout.mirrors, stats.n_packets,
4856                             stats.n_bytes);
4857
4858         xlate_in_init(&xin, ofproto, &facet->flow, facet->rule,
4859                       stats.tcp_flags, NULL);
4860         xin.resubmit_stats = &stats;
4861         xin.may_learn = may_learn;
4862         xlate_actions_for_side_effects(&xin);
4863     }
4864 }
4865
4866 static void
4867 push_all_stats__(bool run_fast)
4868 {
4869     static long long int rl = LLONG_MIN;
4870     struct ofproto_dpif *ofproto;
4871
4872     if (time_msec() < rl) {
4873         return;
4874     }
4875
4876     HMAP_FOR_EACH (ofproto, all_ofproto_dpifs_node, &all_ofproto_dpifs) {
4877         struct cls_cursor cursor;
4878         struct facet *facet;
4879
4880         cls_cursor_init(&cursor, &ofproto->facets, NULL);
4881         CLS_CURSOR_FOR_EACH (facet, cr, &cursor) {
4882             facet_push_stats(facet, false);
4883             if (run_fast) {
4884                 run_fast_rl();
4885             }
4886         }
4887     }
4888
4889     rl = time_msec() + 100;
4890 }
4891
4892 static void
4893 push_all_stats(void)
4894 {
4895     push_all_stats__(true);
4896 }
4897
4898 void
4899 rule_credit_stats(struct rule_dpif *rule, const struct dpif_flow_stats *stats)
4900 {
4901     rule->packet_count += stats->n_packets;
4902     rule->byte_count += stats->n_bytes;
4903     ofproto_rule_update_used(&rule->up, stats->used);
4904 }
4905 \f
4906 /* Subfacets. */
4907
4908 static struct subfacet *
4909 subfacet_find(struct dpif_backer *backer, const struct nlattr *key,
4910               size_t key_len, uint32_t key_hash)
4911 {
4912     struct subfacet *subfacet;
4913
4914     HMAP_FOR_EACH_WITH_HASH (subfacet, hmap_node, key_hash,
4915                              &backer->subfacets) {
4916         if (subfacet->key_len == key_len
4917             && !memcmp(key, subfacet->key, key_len)) {
4918             return subfacet;
4919         }
4920     }
4921
4922     return NULL;
4923 }
4924
4925 /* Searches 'facet' (within 'ofproto') for a subfacet with the specified
4926  * 'key_fitness', 'key', and 'key_len' members in 'miss'.  Returns the
4927  * existing subfacet if there is one, otherwise creates and returns a
4928  * new subfacet. */
4929 static struct subfacet *
4930 subfacet_create(struct facet *facet, struct flow_miss *miss,
4931                 long long int now)
4932 {
4933     struct dpif_backer *backer = miss->ofproto->backer;
4934     enum odp_key_fitness key_fitness = miss->key_fitness;
4935     const struct nlattr *key = miss->key;
4936     size_t key_len = miss->key_len;
4937     uint32_t key_hash;
4938     struct subfacet *subfacet;
4939
4940     key_hash = odp_flow_key_hash(key, key_len);
4941
4942     if (list_is_empty(&facet->subfacets)) {
4943         subfacet = &facet->one_subfacet;
4944     } else {
4945         subfacet = subfacet_find(backer, key, key_len, key_hash);
4946         if (subfacet) {
4947             if (subfacet->facet == facet) {
4948                 return subfacet;
4949             }
4950
4951             /* This shouldn't happen. */
4952             VLOG_ERR_RL(&rl, "subfacet with wrong facet");
4953             subfacet_destroy(subfacet);
4954         }
4955
4956         subfacet = xmalloc(sizeof *subfacet);
4957     }
4958
4959     hmap_insert(&backer->subfacets, &subfacet->hmap_node, key_hash);
4960     list_push_back(&facet->subfacets, &subfacet->list_node);
4961     subfacet->facet = facet;
4962     subfacet->key_fitness = key_fitness;
4963     subfacet->key = xmemdup(key, key_len);
4964     subfacet->key_len = key_len;
4965     subfacet->used = now;
4966     subfacet->created = now;
4967     subfacet->dp_packet_count = 0;
4968     subfacet->dp_byte_count = 0;
4969     subfacet->path = SF_NOT_INSTALLED;
4970     subfacet->backer = backer;
4971
4972     backer->subfacet_add_count++;
4973     return subfacet;
4974 }
4975
4976 /* Uninstalls 'subfacet' from the datapath, if it is installed, removes it from
4977  * its facet within 'ofproto', and frees it. */
4978 static void
4979 subfacet_destroy__(struct subfacet *subfacet)
4980 {
4981     struct facet *facet = subfacet->facet;
4982     struct ofproto_dpif *ofproto = ofproto_dpif_cast(facet->rule->up.ofproto);
4983
4984     /* Update ofproto stats before uninstall the subfacet. */
4985     ofproto->backer->subfacet_del_count++;
4986
4987     subfacet_uninstall(subfacet);
4988     hmap_remove(&subfacet->backer->subfacets, &subfacet->hmap_node);
4989     list_remove(&subfacet->list_node);
4990     free(subfacet->key);
4991     if (subfacet != &facet->one_subfacet) {
4992         free(subfacet);
4993     }
4994 }
4995
4996 /* Destroys 'subfacet', as with subfacet_destroy__(), and then if this was the
4997  * last remaining subfacet in its facet destroys the facet too. */
4998 static void
4999 subfacet_destroy(struct subfacet *subfacet)
5000 {
5001     struct facet *facet = subfacet->facet;
5002
5003     if (list_is_singleton(&facet->subfacets)) {
5004         /* facet_remove() needs at least one subfacet (it will remove it). */
5005         facet_remove(facet);
5006     } else {
5007         subfacet_destroy__(subfacet);
5008     }
5009 }
5010
5011 static void
5012 subfacet_destroy_batch(struct dpif_backer *backer,
5013                        struct subfacet **subfacets, int n)
5014 {
5015     struct dpif_op ops[SUBFACET_DESTROY_MAX_BATCH];
5016     struct dpif_op *opsp[SUBFACET_DESTROY_MAX_BATCH];
5017     struct dpif_flow_stats stats[SUBFACET_DESTROY_MAX_BATCH];
5018     int i;
5019
5020     for (i = 0; i < n; i++) {
5021         ops[i].type = DPIF_OP_FLOW_DEL;
5022         ops[i].u.flow_del.key = subfacets[i]->key;
5023         ops[i].u.flow_del.key_len = subfacets[i]->key_len;
5024         ops[i].u.flow_del.stats = &stats[i];
5025         opsp[i] = &ops[i];
5026     }
5027
5028     dpif_operate(backer->dpif, opsp, n);
5029     for (i = 0; i < n; i++) {
5030         subfacet_reset_dp_stats(subfacets[i], &stats[i]);
5031         subfacets[i]->path = SF_NOT_INSTALLED;
5032         subfacet_destroy(subfacets[i]);
5033         run_fast_rl();
5034     }
5035 }
5036
5037 /* Updates 'subfacet''s datapath flow, setting its actions to 'actions_len'
5038  * bytes of actions in 'actions'.  If 'stats' is non-null, statistics counters
5039  * in the datapath will be zeroed and 'stats' will be updated with traffic new
5040  * since 'subfacet' was last updated.
5041  *
5042  * Returns 0 if successful, otherwise a positive errno value. */
5043 static int
5044 subfacet_install(struct subfacet *subfacet, const struct ofpbuf *odp_actions,
5045                  struct dpif_flow_stats *stats)
5046 {
5047     struct facet *facet = subfacet->facet;
5048     struct ofproto_dpif *ofproto = ofproto_dpif_cast(facet->rule->up.ofproto);
5049     enum subfacet_path path = facet->xout.slow ? SF_SLOW_PATH : SF_FAST_PATH;
5050     const struct nlattr *actions = odp_actions->data;
5051     size_t actions_len = odp_actions->size;
5052     struct odputil_keybuf maskbuf;
5053     struct ofpbuf mask;
5054
5055     uint64_t slow_path_stub[128 / 8];
5056     enum dpif_flow_put_flags flags;
5057     int ret;
5058
5059     flags = DPIF_FP_CREATE | DPIF_FP_MODIFY;
5060     if (stats) {
5061         flags |= DPIF_FP_ZERO_STATS;
5062     }
5063
5064     if (path == SF_SLOW_PATH) {
5065         compose_slow_path(ofproto, &facet->flow, facet->xout.slow,
5066                           slow_path_stub, sizeof slow_path_stub,
5067                           &actions, &actions_len);
5068     }
5069
5070     ofpbuf_use_stack(&mask, &maskbuf, sizeof maskbuf);
5071     odp_flow_key_from_mask(&mask, &facet->xout.wc.masks,
5072                            &facet->flow, UINT32_MAX);
5073
5074     ret = dpif_flow_put(subfacet->backer->dpif, flags, subfacet->key,
5075                         subfacet->key_len,  mask.data, mask.size,
5076                         actions, actions_len, stats);
5077
5078     if (stats) {
5079         subfacet_reset_dp_stats(subfacet, stats);
5080     }
5081
5082     if (ret) {
5083         COVERAGE_INC(subfacet_install_fail);
5084     } else {
5085         subfacet->path = path;
5086     }
5087     return ret;
5088 }
5089
5090 /* If 'subfacet' is installed in the datapath, uninstalls it. */
5091 static void
5092 subfacet_uninstall(struct subfacet *subfacet)
5093 {
5094     if (subfacet->path != SF_NOT_INSTALLED) {
5095         struct rule_dpif *rule = subfacet->facet->rule;
5096         struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
5097         struct dpif_flow_stats stats;
5098         int error;
5099
5100         error = dpif_flow_del(ofproto->backer->dpif, subfacet->key,
5101                               subfacet->key_len, &stats);
5102         subfacet_reset_dp_stats(subfacet, &stats);
5103         if (!error) {
5104             subfacet_update_stats(subfacet, &stats);
5105         }
5106         subfacet->path = SF_NOT_INSTALLED;
5107     } else {
5108         ovs_assert(subfacet->dp_packet_count == 0);
5109         ovs_assert(subfacet->dp_byte_count == 0);
5110     }
5111 }
5112
5113 /* Resets 'subfacet''s datapath statistics counters.  This should be called
5114  * when 'subfacet''s statistics are cleared in the datapath.  If 'stats' is
5115  * non-null, it should contain the statistics returned by dpif when 'subfacet'
5116  * was reset in the datapath.  'stats' will be modified to include only
5117  * statistics new since 'subfacet' was last updated. */
5118 static void
5119 subfacet_reset_dp_stats(struct subfacet *subfacet,
5120                         struct dpif_flow_stats *stats)
5121 {
5122     if (stats
5123         && subfacet->dp_packet_count <= stats->n_packets
5124         && subfacet->dp_byte_count <= stats->n_bytes) {
5125         stats->n_packets -= subfacet->dp_packet_count;
5126         stats->n_bytes -= subfacet->dp_byte_count;
5127     }
5128
5129     subfacet->dp_packet_count = 0;
5130     subfacet->dp_byte_count = 0;
5131 }
5132
5133 /* Folds the statistics from 'stats' into the counters in 'subfacet'.
5134  *
5135  * Because of the meaning of a subfacet's counters, it only makes sense to do
5136  * this if 'stats' are not tracked in the datapath, that is, if 'stats'
5137  * represents a packet that was sent by hand or if it represents statistics
5138  * that have been cleared out of the datapath. */
5139 static void
5140 subfacet_update_stats(struct subfacet *subfacet,
5141                       const struct dpif_flow_stats *stats)
5142 {
5143     if (stats->n_packets || stats->used > subfacet->used) {
5144         struct facet *facet = subfacet->facet;
5145
5146         subfacet->used = MAX(subfacet->used, stats->used);
5147         facet->used = MAX(facet->used, stats->used);
5148         facet->packet_count += stats->n_packets;
5149         facet->byte_count += stats->n_bytes;
5150         facet->tcp_flags |= stats->tcp_flags;
5151     }
5152 }
5153 \f
5154 /* Rules. */
5155
5156 /* Lookup 'flow' in 'ofproto''s classifier.  If 'wc' is non-null, sets
5157  * the fields that were relevant as part of the lookup. */
5158 static struct rule_dpif *
5159 rule_dpif_lookup(struct ofproto_dpif *ofproto, const struct flow *flow,
5160                  struct flow_wildcards *wc)
5161 {
5162     struct rule_dpif *rule;
5163
5164     rule = rule_dpif_lookup_in_table(ofproto, flow, wc, 0);
5165     if (rule) {
5166         return rule;
5167     }
5168
5169     return rule_dpif_miss_rule(ofproto, flow);
5170 }
5171
5172 struct rule_dpif *
5173 rule_dpif_lookup_in_table(struct ofproto_dpif *ofproto,
5174                           const struct flow *flow, struct flow_wildcards *wc,
5175                           uint8_t table_id)
5176 {
5177     struct cls_rule *cls_rule;
5178     struct classifier *cls;
5179     bool frag;
5180
5181     if (table_id >= N_TABLES) {
5182         return NULL;
5183     }
5184
5185     if (wc) {
5186         memset(&wc->masks.dl_type, 0xff, sizeof wc->masks.dl_type);
5187         wc->masks.nw_frag |= FLOW_NW_FRAG_MASK;
5188     }
5189
5190     cls = &ofproto->up.tables[table_id].cls;
5191     frag = (flow->nw_frag & FLOW_NW_FRAG_ANY) != 0;
5192     if (frag && ofproto->up.frag_handling == OFPC_FRAG_NORMAL) {
5193         /* We must pretend that transport ports are unavailable. */
5194         struct flow ofpc_normal_flow = *flow;
5195         ofpc_normal_flow.tp_src = htons(0);
5196         ofpc_normal_flow.tp_dst = htons(0);
5197         cls_rule = classifier_lookup(cls, &ofpc_normal_flow, wc);
5198     } else if (frag && ofproto->up.frag_handling == OFPC_FRAG_DROP) {
5199         cls_rule = &ofproto->drop_frags_rule->up.cr;
5200         if (wc) {
5201             flow_wildcards_init_exact(wc);
5202         }
5203     } else {
5204         cls_rule = classifier_lookup(cls, flow, wc);
5205     }
5206     return rule_dpif_cast(rule_from_cls_rule(cls_rule));
5207 }
5208
5209 struct rule_dpif *
5210 rule_dpif_miss_rule(struct ofproto_dpif *ofproto, const struct flow *flow)
5211 {
5212     struct ofport_dpif *port;
5213
5214     port = get_ofp_port(ofproto, flow->in_port.ofp_port);
5215     if (!port) {
5216         VLOG_WARN_RL(&rl, "packet-in on unknown OpenFlow port %"PRIu16,
5217                      flow->in_port.ofp_port);
5218         return ofproto->miss_rule;
5219     }
5220
5221     if (port->up.pp.config & OFPUTIL_PC_NO_PACKET_IN) {
5222         return ofproto->no_packet_in_rule;
5223     }
5224     return ofproto->miss_rule;
5225 }
5226
5227 static void
5228 complete_operation(struct rule_dpif *rule)
5229 {
5230     struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
5231
5232     rule_invalidate(rule);
5233     if (clogged) {
5234         struct dpif_completion *c = xmalloc(sizeof *c);
5235         c->op = rule->up.pending;
5236         list_push_back(&ofproto->completions, &c->list_node);
5237     } else {
5238         ofoperation_complete(rule->up.pending, 0);
5239     }
5240 }
5241
5242 static struct rule *
5243 rule_alloc(void)
5244 {
5245     struct rule_dpif *rule = xmalloc(sizeof *rule);
5246     return &rule->up;
5247 }
5248
5249 static void
5250 rule_dealloc(struct rule *rule_)
5251 {
5252     struct rule_dpif *rule = rule_dpif_cast(rule_);
5253     free(rule);
5254 }
5255
5256 static enum ofperr
5257 rule_construct(struct rule *rule_)
5258 {
5259     struct rule_dpif *rule = rule_dpif_cast(rule_);
5260     struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
5261     struct rule_dpif *victim;
5262     uint8_t table_id;
5263
5264     rule->packet_count = 0;
5265     rule->byte_count = 0;
5266
5267     victim = rule_dpif_cast(ofoperation_get_victim(rule->up.pending));
5268     if (victim && !list_is_empty(&victim->facets)) {
5269         struct facet *facet;
5270
5271         rule->facets = victim->facets;
5272         list_moved(&rule->facets);
5273         LIST_FOR_EACH (facet, list_node, &rule->facets) {
5274             /* XXX: We're only clearing our local counters here.  It's possible
5275              * that quite a few packets are unaccounted for in the datapath
5276              * statistics.  These will be accounted to the new rule instead of
5277              * cleared as required.  This could be fixed by clearing out the
5278              * datapath statistics for this facet, but currently it doesn't
5279              * seem worth it. */
5280             facet_reset_counters(facet);
5281             facet->rule = rule;
5282         }
5283     } else {
5284         /* Must avoid list_moved() in this case. */
5285         list_init(&rule->facets);
5286     }
5287
5288     table_id = rule->up.table_id;
5289     if (victim) {
5290         rule->tag = victim->tag;
5291     } else if (table_id == 0) {
5292         rule->tag = 0;
5293     } else {
5294         struct flow flow;
5295
5296         miniflow_expand(&rule->up.cr.match.flow, &flow);
5297         rule->tag = rule_calculate_tag(&flow, &rule->up.cr.match.mask,
5298                                        ofproto->tables[table_id].basis);
5299     }
5300
5301     complete_operation(rule);
5302     return 0;
5303 }
5304
5305 static void
5306 rule_destruct(struct rule *rule_)
5307 {
5308     struct rule_dpif *rule = rule_dpif_cast(rule_);
5309     struct facet *facet, *next_facet;
5310
5311     LIST_FOR_EACH_SAFE (facet, next_facet, list_node, &rule->facets) {
5312         facet_revalidate(facet);
5313     }
5314
5315     complete_operation(rule);
5316 }
5317
5318 static void
5319 rule_get_stats(struct rule *rule_, uint64_t *packets, uint64_t *bytes)
5320 {
5321     struct rule_dpif *rule = rule_dpif_cast(rule_);
5322
5323     /* push_all_stats() can handle flow misses which, when using the learn
5324      * action, can cause rules to be added and deleted.  This can corrupt our
5325      * caller's datastructures which assume that rule_get_stats() doesn't have
5326      * an impact on the flow table. To be safe, we disable miss handling. */
5327     push_all_stats__(false);
5328
5329     /* Start from historical data for 'rule' itself that are no longer tracked
5330      * in facets.  This counts, for example, facets that have expired. */
5331     *packets = rule->packet_count;
5332     *bytes = rule->byte_count;
5333 }
5334
5335 static void
5336 rule_dpif_execute(struct rule_dpif *rule, const struct flow *flow,
5337                   struct ofpbuf *packet)
5338 {
5339     struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
5340     struct dpif_flow_stats stats;
5341     struct xlate_out xout;
5342     struct xlate_in xin;
5343
5344     dpif_flow_stats_extract(flow, packet, time_msec(), &stats);
5345     rule_credit_stats(rule, &stats);
5346
5347     xlate_in_init(&xin, ofproto, flow, rule, stats.tcp_flags, packet);
5348     xin.resubmit_stats = &stats;
5349     xlate_actions(&xin, &xout);
5350
5351     execute_odp_actions(ofproto, flow, xout.odp_actions.data,
5352                         xout.odp_actions.size, packet);
5353
5354     xlate_out_uninit(&xout);
5355 }
5356
5357 static enum ofperr
5358 rule_execute(struct rule *rule, const struct flow *flow,
5359              struct ofpbuf *packet)
5360 {
5361     rule_dpif_execute(rule_dpif_cast(rule), flow, packet);
5362     ofpbuf_delete(packet);
5363     return 0;
5364 }
5365
5366 static void
5367 rule_modify_actions(struct rule *rule_)
5368 {
5369     struct rule_dpif *rule = rule_dpif_cast(rule_);
5370
5371     complete_operation(rule);
5372 }
5373 \f
5374 /* Sends 'packet' out 'ofport'.
5375  * May modify 'packet'.
5376  * Returns 0 if successful, otherwise a positive errno value. */
5377 static int
5378 send_packet(const struct ofport_dpif *ofport, struct ofpbuf *packet)
5379 {
5380     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofport->up.ofproto);
5381     uint64_t odp_actions_stub[1024 / 8];
5382     struct ofpbuf key, odp_actions;
5383     struct dpif_flow_stats stats;
5384     struct odputil_keybuf keybuf;
5385     struct ofpact_output output;
5386     struct xlate_out xout;
5387     struct xlate_in xin;
5388     struct flow flow;
5389     union flow_in_port in_port_;
5390     int error;
5391
5392     ofpbuf_use_stub(&odp_actions, odp_actions_stub, sizeof odp_actions_stub);
5393     ofpbuf_use_stack(&key, &keybuf, sizeof keybuf);
5394
5395     /* Use OFPP_NONE as the in_port to avoid special packet processing. */
5396     in_port_.ofp_port = OFPP_NONE;
5397     flow_extract(packet, 0, 0, NULL, &in_port_, &flow);
5398     odp_flow_key_from_flow(&key, &flow, ofp_port_to_odp_port(ofproto,
5399                                                              OFPP_LOCAL));
5400     dpif_flow_stats_extract(&flow, packet, time_msec(), &stats);
5401
5402     ofpact_init(&output.ofpact, OFPACT_OUTPUT, sizeof output);
5403     output.port = ofport->up.ofp_port;
5404     output.max_len = 0;
5405
5406     xlate_in_init(&xin, ofproto, &flow, NULL, 0, packet);
5407     xin.ofpacts_len = sizeof output;
5408     xin.ofpacts = &output.ofpact;
5409     xin.resubmit_stats = &stats;
5410     xlate_actions(&xin, &xout);
5411
5412     error = dpif_execute(ofproto->backer->dpif,
5413                          key.data, key.size,
5414                          xout.odp_actions.data, xout.odp_actions.size,
5415                          packet);
5416     xlate_out_uninit(&xout);
5417
5418     if (error) {
5419         VLOG_WARN_RL(&rl, "%s: failed to send packet on port %s (%s)",
5420                      ofproto->up.name, netdev_get_name(ofport->up.netdev),
5421                      strerror(error));
5422     }
5423
5424     ofproto->stats.tx_packets++;
5425     ofproto->stats.tx_bytes += packet->size;
5426     return error;
5427 }
5428
5429 /* Composes an ODP action for a "slow path" action for 'flow' within 'ofproto'.
5430  * The action will state 'slow' as the reason that the action is in the slow
5431  * path.  (This is purely informational: it allows a human viewing "ovs-dpctl
5432  * dump-flows" output to see why a flow is in the slow path.)
5433  *
5434  * The 'stub_size' bytes in 'stub' will be used to store the action.
5435  * 'stub_size' must be large enough for the action.
5436  *
5437  * The action and its size will be stored in '*actionsp' and '*actions_lenp',
5438  * respectively. */
5439 static void
5440 compose_slow_path(const struct ofproto_dpif *ofproto, const struct flow *flow,
5441                   enum slow_path_reason slow,
5442                   uint64_t *stub, size_t stub_size,
5443                   const struct nlattr **actionsp, size_t *actions_lenp)
5444 {
5445     union user_action_cookie cookie;
5446     struct ofpbuf buf;
5447
5448     cookie.type = USER_ACTION_COOKIE_SLOW_PATH;
5449     cookie.slow_path.unused = 0;
5450     cookie.slow_path.reason = slow;
5451
5452     ofpbuf_use_stack(&buf, stub, stub_size);
5453     if (slow & (SLOW_CFM | SLOW_BFD | SLOW_LACP | SLOW_STP)) {
5454         uint32_t pid = dpif_port_get_pid(ofproto->backer->dpif,
5455                                          ODPP_NONE);
5456         odp_put_userspace_action(pid, &cookie, sizeof cookie.slow_path, &buf);
5457     } else {
5458         put_userspace_action(ofproto, &buf, flow, &cookie,
5459                              sizeof cookie.slow_path);
5460     }
5461     *actionsp = buf.data;
5462     *actions_lenp = buf.size;
5463 }
5464
5465 size_t
5466 put_userspace_action(const struct ofproto_dpif *ofproto,
5467                      struct ofpbuf *odp_actions,
5468                      const struct flow *flow,
5469                      const union user_action_cookie *cookie,
5470                      const size_t cookie_size)
5471 {
5472     uint32_t pid;
5473
5474     pid = dpif_port_get_pid(ofproto->backer->dpif,
5475                             ofp_port_to_odp_port(ofproto,
5476                                                  flow->in_port.ofp_port));
5477
5478     return odp_put_userspace_action(pid, cookie, cookie_size, odp_actions);
5479 }
5480
5481
5482 static void
5483 update_mirror_stats(struct ofproto_dpif *ofproto, mirror_mask_t mirrors,
5484                     uint64_t packets, uint64_t bytes)
5485 {
5486     if (!mirrors) {
5487         return;
5488     }
5489
5490     for (; mirrors; mirrors = zero_rightmost_1bit(mirrors)) {
5491         struct ofmirror *m;
5492
5493         m = ofproto->mirrors[mirror_mask_ffs(mirrors) - 1];
5494
5495         if (!m) {
5496             /* In normal circumstances 'm' will not be NULL.  However,
5497              * if mirrors are reconfigured, we can temporarily get out
5498              * of sync in facet_revalidate().  We could "correct" the
5499              * mirror list before reaching here, but doing that would
5500              * not properly account the traffic stats we've currently
5501              * accumulated for previous mirror configuration. */
5502             continue;
5503         }
5504
5505         m->packet_count += packets;
5506         m->byte_count += bytes;
5507     }
5508 }
5509
5510 \f
5511 /* Optimized flow revalidation.
5512  *
5513  * It's a difficult problem, in general, to tell which facets need to have
5514  * their actions recalculated whenever the OpenFlow flow table changes.  We
5515  * don't try to solve that general problem: for most kinds of OpenFlow flow
5516  * table changes, we recalculate the actions for every facet.  This is
5517  * relatively expensive, but it's good enough if the OpenFlow flow table
5518  * doesn't change very often.
5519  *
5520  * However, we can expect one particular kind of OpenFlow flow table change to
5521  * happen frequently: changes caused by MAC learning.  To avoid wasting a lot
5522  * of CPU on revalidating every facet whenever MAC learning modifies the flow
5523  * table, we add a special case that applies to flow tables in which every rule
5524  * has the same form (that is, the same wildcards), except that the table is
5525  * also allowed to have a single "catch-all" flow that matches all packets.  We
5526  * optimize this case by tagging all of the facets that resubmit into the table
5527  * and invalidating the same tag whenever a flow changes in that table.  The
5528  * end result is that we revalidate just the facets that need it (and sometimes
5529  * a few more, but not all of the facets or even all of the facets that
5530  * resubmit to the table modified by MAC learning). */
5531
5532 /* Calculates the tag to use for 'flow' and mask 'mask' when it is inserted
5533  * into an OpenFlow table with the given 'basis'. */
5534 tag_type
5535 rule_calculate_tag(const struct flow *flow, const struct minimask *mask,
5536                    uint32_t secret)
5537 {
5538     if (minimask_is_catchall(mask)) {
5539         return 0;
5540     } else {
5541         uint32_t hash = flow_hash_in_minimask(flow, mask, secret);
5542         return tag_create_deterministic(hash);
5543     }
5544 }
5545
5546 /* Following a change to OpenFlow table 'table_id' in 'ofproto', update the
5547  * taggability of that table.
5548  *
5549  * This function must be called after *each* change to a flow table.  If you
5550  * skip calling it on some changes then the pointer comparisons at the end can
5551  * be invalid if you get unlucky.  For example, if a flow removal causes a
5552  * cls_table to be destroyed and then a flow insertion causes a cls_table with
5553  * different wildcards to be created with the same address, then this function
5554  * will incorrectly skip revalidation. */
5555 static void
5556 table_update_taggable(struct ofproto_dpif *ofproto, uint8_t table_id)
5557 {
5558     struct table_dpif *table = &ofproto->tables[table_id];
5559     const struct oftable *oftable = &ofproto->up.tables[table_id];
5560     struct cls_table *catchall, *other;
5561     struct cls_table *t;
5562
5563     catchall = other = NULL;
5564
5565     switch (hmap_count(&oftable->cls.tables)) {
5566     case 0:
5567         /* We could tag this OpenFlow table but it would make the logic a
5568          * little harder and it's a corner case that doesn't seem worth it
5569          * yet. */
5570         break;
5571
5572     case 1:
5573     case 2:
5574         HMAP_FOR_EACH (t, hmap_node, &oftable->cls.tables) {
5575             if (cls_table_is_catchall(t)) {
5576                 catchall = t;
5577             } else if (!other) {
5578                 other = t;
5579             } else {
5580                 /* Indicate that we can't tag this by setting both tables to
5581                  * NULL.  (We know that 'catchall' is already NULL.) */
5582                 other = NULL;
5583             }
5584         }
5585         break;
5586
5587     default:
5588         /* Can't tag this table. */
5589         break;
5590     }
5591
5592     if (table->catchall_table != catchall || table->other_table != other) {
5593         table->catchall_table = catchall;
5594         table->other_table = other;
5595         ofproto->backer->need_revalidate = REV_FLOW_TABLE;
5596     }
5597 }
5598
5599 /* Given 'rule' that has changed in some way (either it is a rule being
5600  * inserted, a rule being deleted, or a rule whose actions are being
5601  * modified), marks facets for revalidation to ensure that packets will be
5602  * forwarded correctly according to the new state of the flow table.
5603  *
5604  * This function must be called after *each* change to a flow table.  See
5605  * the comment on table_update_taggable() for more information. */
5606 static void
5607 rule_invalidate(const struct rule_dpif *rule)
5608 {
5609     struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
5610
5611     table_update_taggable(ofproto, rule->up.table_id);
5612
5613     if (!ofproto->backer->need_revalidate) {
5614         struct table_dpif *table = &ofproto->tables[rule->up.table_id];
5615
5616         if (table->other_table && rule->tag) {
5617             tag_set_add(&ofproto->backer->revalidate_set, rule->tag);
5618         } else {
5619             ofproto->backer->need_revalidate = REV_FLOW_TABLE;
5620         }
5621     }
5622 }
5623 \f
5624 static bool
5625 set_frag_handling(struct ofproto *ofproto_,
5626                   enum ofp_config_flags frag_handling)
5627 {
5628     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
5629     if (frag_handling != OFPC_FRAG_REASM) {
5630         ofproto->backer->need_revalidate = REV_RECONFIGURE;
5631         return true;
5632     } else {
5633         return false;
5634     }
5635 }
5636
5637 static enum ofperr
5638 packet_out(struct ofproto *ofproto_, struct ofpbuf *packet,
5639            const struct flow *flow,
5640            const struct ofpact *ofpacts, size_t ofpacts_len)
5641 {
5642     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
5643     struct odputil_keybuf keybuf;
5644     struct dpif_flow_stats stats;
5645     struct xlate_out xout;
5646     struct xlate_in xin;
5647     struct ofpbuf key;
5648
5649
5650     ofpbuf_use_stack(&key, &keybuf, sizeof keybuf);
5651     odp_flow_key_from_flow(&key, flow,
5652                            ofp_port_to_odp_port(ofproto,
5653                                       flow->in_port.ofp_port));
5654
5655     dpif_flow_stats_extract(flow, packet, time_msec(), &stats);
5656
5657     xlate_in_init(&xin, ofproto, flow, NULL, stats.tcp_flags, packet);
5658     xin.resubmit_stats = &stats;
5659     xin.ofpacts_len = ofpacts_len;
5660     xin.ofpacts = ofpacts;
5661
5662     xlate_actions(&xin, &xout);
5663     dpif_execute(ofproto->backer->dpif, key.data, key.size,
5664                  xout.odp_actions.data, xout.odp_actions.size, packet);
5665     xlate_out_uninit(&xout);
5666
5667     return 0;
5668 }
5669 \f
5670 /* NetFlow. */
5671
5672 static int
5673 set_netflow(struct ofproto *ofproto_,
5674             const struct netflow_options *netflow_options)
5675 {
5676     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
5677
5678     if (netflow_options) {
5679         if (!ofproto->netflow) {
5680             ofproto->netflow = netflow_create();
5681             ofproto->backer->need_revalidate = REV_RECONFIGURE;
5682         }
5683         return netflow_set_options(ofproto->netflow, netflow_options);
5684     } else if (ofproto->netflow) {
5685         ofproto->backer->need_revalidate = REV_RECONFIGURE;
5686         netflow_destroy(ofproto->netflow);
5687         ofproto->netflow = NULL;
5688     }
5689
5690     return 0;
5691 }
5692
5693 static void
5694 get_netflow_ids(const struct ofproto *ofproto_,
5695                 uint8_t *engine_type, uint8_t *engine_id)
5696 {
5697     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
5698
5699     dpif_get_netflow_ids(ofproto->backer->dpif, engine_type, engine_id);
5700 }
5701
5702 static void
5703 send_active_timeout(struct ofproto_dpif *ofproto, struct facet *facet)
5704 {
5705     if (!facet_is_controller_flow(facet) &&
5706         netflow_active_timeout_expired(ofproto->netflow, &facet->nf_flow)) {
5707         struct subfacet *subfacet;
5708         struct ofexpired expired;
5709
5710         LIST_FOR_EACH (subfacet, list_node, &facet->subfacets) {
5711             if (subfacet->path == SF_FAST_PATH) {
5712                 struct dpif_flow_stats stats;
5713
5714                 subfacet_install(subfacet, &facet->xout.odp_actions,
5715                                  &stats);
5716                 subfacet_update_stats(subfacet, &stats);
5717             }
5718         }
5719
5720         expired.flow = facet->flow;
5721         expired.packet_count = facet->packet_count;
5722         expired.byte_count = facet->byte_count;
5723         expired.used = facet->used;
5724         netflow_expire(ofproto->netflow, &facet->nf_flow, &expired);
5725     }
5726 }
5727
5728 static void
5729 send_netflow_active_timeouts(struct ofproto_dpif *ofproto)
5730 {
5731     struct cls_cursor cursor;
5732     struct facet *facet;
5733
5734     cls_cursor_init(&cursor, &ofproto->facets, NULL);
5735     CLS_CURSOR_FOR_EACH (facet, cr, &cursor) {
5736         send_active_timeout(ofproto, facet);
5737     }
5738 }
5739 \f
5740 static struct ofproto_dpif *
5741 ofproto_dpif_lookup(const char *name)
5742 {
5743     struct ofproto_dpif *ofproto;
5744
5745     HMAP_FOR_EACH_WITH_HASH (ofproto, all_ofproto_dpifs_node,
5746                              hash_string(name, 0), &all_ofproto_dpifs) {
5747         if (!strcmp(ofproto->up.name, name)) {
5748             return ofproto;
5749         }
5750     }
5751     return NULL;
5752 }
5753
5754 static void
5755 ofproto_unixctl_fdb_flush(struct unixctl_conn *conn, int argc,
5756                           const char *argv[], void *aux OVS_UNUSED)
5757 {
5758     struct ofproto_dpif *ofproto;
5759
5760     if (argc > 1) {
5761         ofproto = ofproto_dpif_lookup(argv[1]);
5762         if (!ofproto) {
5763             unixctl_command_reply_error(conn, "no such bridge");
5764             return;
5765         }
5766         mac_learning_flush(ofproto->ml, &ofproto->backer->revalidate_set);
5767     } else {
5768         HMAP_FOR_EACH (ofproto, all_ofproto_dpifs_node, &all_ofproto_dpifs) {
5769             mac_learning_flush(ofproto->ml, &ofproto->backer->revalidate_set);
5770         }
5771     }
5772
5773     unixctl_command_reply(conn, "table successfully flushed");
5774 }
5775
5776 static void
5777 ofproto_unixctl_fdb_show(struct unixctl_conn *conn, int argc OVS_UNUSED,
5778                          const char *argv[], void *aux OVS_UNUSED)
5779 {
5780     struct ds ds = DS_EMPTY_INITIALIZER;
5781     const struct ofproto_dpif *ofproto;
5782     const struct mac_entry *e;
5783
5784     ofproto = ofproto_dpif_lookup(argv[1]);
5785     if (!ofproto) {
5786         unixctl_command_reply_error(conn, "no such bridge");
5787         return;
5788     }
5789
5790     ds_put_cstr(&ds, " port  VLAN  MAC                Age\n");
5791     LIST_FOR_EACH (e, lru_node, &ofproto->ml->lrus) {
5792         struct ofbundle *bundle = e->port.p;
5793         char name[OFP_MAX_PORT_NAME_LEN];
5794
5795         ofputil_port_to_string(ofbundle_get_a_port(bundle)->up.ofp_port,
5796                                name, sizeof name);
5797         ds_put_format(&ds, "%5s  %4d  "ETH_ADDR_FMT"  %3d\n",
5798                       name, e->vlan, ETH_ADDR_ARGS(e->mac),
5799                       mac_entry_age(ofproto->ml, e));
5800     }
5801     unixctl_command_reply(conn, ds_cstr(&ds));
5802     ds_destroy(&ds);
5803 }
5804
5805 struct trace_ctx {
5806     struct xlate_out xout;
5807     struct xlate_in xin;
5808     struct flow flow;
5809     struct ds *result;
5810 };
5811
5812 static void
5813 trace_format_rule(struct ds *result, int level, const struct rule_dpif *rule)
5814 {
5815     ds_put_char_multiple(result, '\t', level);
5816     if (!rule) {
5817         ds_put_cstr(result, "No match\n");
5818         return;
5819     }
5820
5821     ds_put_format(result, "Rule: table=%"PRIu8" cookie=%#"PRIx64" ",
5822                   rule ? rule->up.table_id : 0, ntohll(rule->up.flow_cookie));
5823     cls_rule_format(&rule->up.cr, result);
5824     ds_put_char(result, '\n');
5825
5826     ds_put_char_multiple(result, '\t', level);
5827     ds_put_cstr(result, "OpenFlow ");
5828     ofpacts_format(rule->up.ofpacts, rule->up.ofpacts_len, result);
5829     ds_put_char(result, '\n');
5830 }
5831
5832 static void
5833 trace_format_flow(struct ds *result, int level, const char *title,
5834                   struct trace_ctx *trace)
5835 {
5836     ds_put_char_multiple(result, '\t', level);
5837     ds_put_format(result, "%s: ", title);
5838     if (flow_equal(&trace->xin.flow, &trace->flow)) {
5839         ds_put_cstr(result, "unchanged");
5840     } else {
5841         flow_format(result, &trace->xin.flow);
5842         trace->flow = trace->xin.flow;
5843     }
5844     ds_put_char(result, '\n');
5845 }
5846
5847 static void
5848 trace_format_regs(struct ds *result, int level, const char *title,
5849                   struct trace_ctx *trace)
5850 {
5851     size_t i;
5852
5853     ds_put_char_multiple(result, '\t', level);
5854     ds_put_format(result, "%s:", title);
5855     for (i = 0; i < FLOW_N_REGS; i++) {
5856         ds_put_format(result, " reg%zu=0x%"PRIx32, i, trace->flow.regs[i]);
5857     }
5858     ds_put_char(result, '\n');
5859 }
5860
5861 static void
5862 trace_format_odp(struct ds *result, int level, const char *title,
5863                  struct trace_ctx *trace)
5864 {
5865     struct ofpbuf *odp_actions = &trace->xout.odp_actions;
5866
5867     ds_put_char_multiple(result, '\t', level);
5868     ds_put_format(result, "%s: ", title);
5869     format_odp_actions(result, odp_actions->data, odp_actions->size);
5870     ds_put_char(result, '\n');
5871 }
5872
5873 static void
5874 trace_resubmit(struct xlate_in *xin, struct rule_dpif *rule, int recurse)
5875 {
5876     struct trace_ctx *trace = CONTAINER_OF(xin, struct trace_ctx, xin);
5877     struct ds *result = trace->result;
5878
5879     ds_put_char(result, '\n');
5880     trace_format_flow(result, recurse + 1, "Resubmitted flow", trace);
5881     trace_format_regs(result, recurse + 1, "Resubmitted regs", trace);
5882     trace_format_odp(result,  recurse + 1, "Resubmitted  odp", trace);
5883     trace_format_rule(result, recurse + 1, rule);
5884 }
5885
5886 static void
5887 trace_report(struct xlate_in *xin, const char *s, int recurse)
5888 {
5889     struct trace_ctx *trace = CONTAINER_OF(xin, struct trace_ctx, xin);
5890     struct ds *result = trace->result;
5891
5892     ds_put_char_multiple(result, '\t', recurse);
5893     ds_put_cstr(result, s);
5894     ds_put_char(result, '\n');
5895 }
5896
5897 static void
5898 ofproto_unixctl_trace(struct unixctl_conn *conn, int argc, const char *argv[],
5899                       void *aux OVS_UNUSED)
5900 {
5901     const struct dpif_backer *backer;
5902     struct ofproto_dpif *ofproto;
5903     struct ofpbuf odp_key;
5904     struct ofpbuf *packet;
5905     struct ds result;
5906     struct flow flow;
5907     char *s;
5908
5909     packet = NULL;
5910     backer = NULL;
5911     ds_init(&result);
5912     ofpbuf_init(&odp_key, 0);
5913
5914     /* Handle "-generate" or a hex string as the last argument. */
5915     if (!strcmp(argv[argc - 1], "-generate")) {
5916         packet = ofpbuf_new(0);
5917         argc--;
5918     } else {
5919         const char *error = eth_from_hex(argv[argc - 1], &packet);
5920         if (!error) {
5921             argc--;
5922         } else if (argc == 4) {
5923             /* The 3-argument form must end in "-generate' or a hex string. */
5924             unixctl_command_reply_error(conn, error);
5925             goto exit;
5926         }
5927     }
5928
5929     /* Parse the flow and determine whether a datapath or
5930      * bridge is specified. If function odp_flow_key_from_string()
5931      * returns 0, the flow is a odp_flow. If function
5932      * parse_ofp_exact_flow() returns 0, the flow is a br_flow. */
5933     if (!odp_flow_from_string(argv[argc - 1], NULL, &odp_key, NULL)) {
5934         /* If the odp_flow is the second argument,
5935          * the datapath name is the first argument. */
5936         if (argc == 3) {
5937             const char *dp_type;
5938             if (!strncmp(argv[1], "ovs-", 4)) {
5939                 dp_type = argv[1] + 4;
5940             } else {
5941                 dp_type = argv[1];
5942             }
5943             backer = shash_find_data(&all_dpif_backers, dp_type);
5944             if (!backer) {
5945                 unixctl_command_reply_error(conn, "Cannot find datapath "
5946                                "of this name");
5947                 goto exit;
5948             }
5949         } else {
5950             /* No datapath name specified, so there should be only one
5951              * datapath. */
5952             struct shash_node *node;
5953             if (shash_count(&all_dpif_backers) != 1) {
5954                 unixctl_command_reply_error(conn, "Must specify datapath "
5955                          "name, there is more than one type of datapath");
5956                 goto exit;
5957             }
5958             node = shash_first(&all_dpif_backers);
5959             backer = node->data;
5960         }
5961
5962         /* Extract the ofproto_dpif object from the ofproto_receive()
5963          * function. */
5964         if (ofproto_receive(backer, NULL, odp_key.data,
5965                             odp_key.size, &flow, NULL, &ofproto, NULL)) {
5966             unixctl_command_reply_error(conn, "Invalid datapath flow");
5967             goto exit;
5968         }
5969         ds_put_format(&result, "Bridge: %s\n", ofproto->up.name);
5970     } else if (!parse_ofp_exact_flow(&flow, argv[argc - 1])) {
5971         if (argc != 3) {
5972             unixctl_command_reply_error(conn, "Must specify bridge name");
5973             goto exit;
5974         }
5975
5976         ofproto = ofproto_dpif_lookup(argv[1]);
5977         if (!ofproto) {
5978             unixctl_command_reply_error(conn, "Unknown bridge name");
5979             goto exit;
5980         }
5981     } else {
5982         unixctl_command_reply_error(conn, "Bad flow syntax");
5983         goto exit;
5984     }
5985
5986     /* Generate a packet, if requested. */
5987     if (packet) {
5988         if (!packet->size) {
5989             flow_compose(packet, &flow);
5990         } else {
5991             union flow_in_port in_port_;
5992
5993             in_port_ = flow.in_port;
5994             ds_put_cstr(&result, "Packet: ");
5995             s = ofp_packet_to_string(packet->data, packet->size);
5996             ds_put_cstr(&result, s);
5997             free(s);
5998
5999             /* Use the metadata from the flow and the packet argument
6000              * to reconstruct the flow. */
6001             flow_extract(packet, flow.skb_priority, flow.skb_mark, NULL,
6002                          &in_port_, &flow);
6003         }
6004     }
6005
6006     ofproto_trace(ofproto, &flow, packet, &result);
6007     unixctl_command_reply(conn, ds_cstr(&result));
6008
6009 exit:
6010     ds_destroy(&result);
6011     ofpbuf_delete(packet);
6012     ofpbuf_uninit(&odp_key);
6013 }
6014
6015 void
6016 ofproto_trace(struct ofproto_dpif *ofproto, const struct flow *flow,
6017               const struct ofpbuf *packet, struct ds *ds)
6018 {
6019     struct rule_dpif *rule;
6020
6021     ds_put_cstr(ds, "Flow: ");
6022     flow_format(ds, flow);
6023     ds_put_char(ds, '\n');
6024
6025     rule = rule_dpif_lookup(ofproto, flow, NULL);
6026
6027     trace_format_rule(ds, 0, rule);
6028     if (rule == ofproto->miss_rule) {
6029         ds_put_cstr(ds, "\nNo match, flow generates \"packet in\"s.\n");
6030     } else if (rule == ofproto->no_packet_in_rule) {
6031         ds_put_cstr(ds, "\nNo match, packets dropped because "
6032                     "OFPPC_NO_PACKET_IN is set on in_port.\n");
6033     } else if (rule == ofproto->drop_frags_rule) {
6034         ds_put_cstr(ds, "\nPackets dropped because they are IP fragments "
6035                     "and the fragment handling mode is \"drop\".\n");
6036     }
6037
6038     if (rule) {
6039         uint64_t odp_actions_stub[1024 / 8];
6040         struct ofpbuf odp_actions;
6041         struct trace_ctx trace;
6042         struct match match;
6043         uint8_t tcp_flags;
6044
6045         tcp_flags = packet ? packet_get_tcp_flags(packet, flow) : 0;
6046         trace.result = ds;
6047         trace.flow = *flow;
6048         ofpbuf_use_stub(&odp_actions,
6049                         odp_actions_stub, sizeof odp_actions_stub);
6050         xlate_in_init(&trace.xin, ofproto, flow, rule, tcp_flags, packet);
6051         trace.xin.resubmit_hook = trace_resubmit;
6052         trace.xin.report_hook = trace_report;
6053
6054         xlate_actions(&trace.xin, &trace.xout);
6055
6056         ds_put_char(ds, '\n');
6057         trace_format_flow(ds, 0, "Final flow", &trace);
6058
6059         match_init(&match, flow, &trace.xout.wc);
6060         ds_put_cstr(ds, "Relevant fields: ");
6061         match_format(&match, ds, OFP_DEFAULT_PRIORITY);
6062         ds_put_char(ds, '\n');
6063
6064         ds_put_cstr(ds, "Datapath actions: ");
6065         format_odp_actions(ds, trace.xout.odp_actions.data,
6066                            trace.xout.odp_actions.size);
6067
6068         if (trace.xout.slow) {
6069             ds_put_cstr(ds, "\nThis flow is handled by the userspace "
6070                         "slow path because it:");
6071             switch (trace.xout.slow) {
6072             case SLOW_CFM:
6073                 ds_put_cstr(ds, "\n\t- Consists of CFM packets.");
6074                 break;
6075             case SLOW_LACP:
6076                 ds_put_cstr(ds, "\n\t- Consists of LACP packets.");
6077                 break;
6078             case SLOW_STP:
6079                 ds_put_cstr(ds, "\n\t- Consists of STP packets.");
6080                 break;
6081             case SLOW_BFD:
6082                 ds_put_cstr(ds, "\n\t- Consists of BFD packets.");
6083                 break;
6084             case SLOW_CONTROLLER:
6085                 ds_put_cstr(ds, "\n\t- Sends \"packet-in\" messages "
6086                             "to the OpenFlow controller.");
6087                 break;
6088             case __SLOW_MAX:
6089                 NOT_REACHED();
6090             }
6091         }
6092
6093         xlate_out_uninit(&trace.xout);
6094     }
6095 }
6096
6097 static void
6098 ofproto_dpif_clog(struct unixctl_conn *conn OVS_UNUSED, int argc OVS_UNUSED,
6099                   const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED)
6100 {
6101     clogged = true;
6102     unixctl_command_reply(conn, NULL);
6103 }
6104
6105 static void
6106 ofproto_dpif_unclog(struct unixctl_conn *conn OVS_UNUSED, int argc OVS_UNUSED,
6107                     const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED)
6108 {
6109     clogged = false;
6110     unixctl_command_reply(conn, NULL);
6111 }
6112
6113 /* Runs a self-check of flow translations in 'ofproto'.  Appends a message to
6114  * 'reply' describing the results. */
6115 static void
6116 ofproto_dpif_self_check__(struct ofproto_dpif *ofproto, struct ds *reply)
6117 {
6118     struct cls_cursor cursor;
6119     struct facet *facet;
6120     int errors;
6121
6122     errors = 0;
6123     cls_cursor_init(&cursor, &ofproto->facets, NULL);
6124     CLS_CURSOR_FOR_EACH (facet, cr, &cursor) {
6125         if (!facet_check_consistency(facet)) {
6126             errors++;
6127         }
6128     }
6129     if (errors) {
6130         ofproto->backer->need_revalidate = REV_INCONSISTENCY;
6131     }
6132
6133     if (errors) {
6134         ds_put_format(reply, "%s: self-check failed (%d errors)\n",
6135                       ofproto->up.name, errors);
6136     } else {
6137         ds_put_format(reply, "%s: self-check passed\n", ofproto->up.name);
6138     }
6139 }
6140
6141 static void
6142 ofproto_dpif_self_check(struct unixctl_conn *conn,
6143                         int argc, const char *argv[], void *aux OVS_UNUSED)
6144 {
6145     struct ds reply = DS_EMPTY_INITIALIZER;
6146     struct ofproto_dpif *ofproto;
6147
6148     if (argc > 1) {
6149         ofproto = ofproto_dpif_lookup(argv[1]);
6150         if (!ofproto) {
6151             unixctl_command_reply_error(conn, "Unknown ofproto (use "
6152                                         "ofproto/list for help)");
6153             return;
6154         }
6155         ofproto_dpif_self_check__(ofproto, &reply);
6156     } else {
6157         HMAP_FOR_EACH (ofproto, all_ofproto_dpifs_node, &all_ofproto_dpifs) {
6158             ofproto_dpif_self_check__(ofproto, &reply);
6159         }
6160     }
6161
6162     unixctl_command_reply(conn, ds_cstr(&reply));
6163     ds_destroy(&reply);
6164 }
6165
6166 /* Store the current ofprotos in 'ofproto_shash'.  Returns a sorted list
6167  * of the 'ofproto_shash' nodes.  It is the responsibility of the caller
6168  * to destroy 'ofproto_shash' and free the returned value. */
6169 static const struct shash_node **
6170 get_ofprotos(struct shash *ofproto_shash)
6171 {
6172     const struct ofproto_dpif *ofproto;
6173
6174     HMAP_FOR_EACH (ofproto, all_ofproto_dpifs_node, &all_ofproto_dpifs) {
6175         char *name = xasprintf("%s@%s", ofproto->up.type, ofproto->up.name);
6176         shash_add_nocopy(ofproto_shash, name, ofproto);
6177     }
6178
6179     return shash_sort(ofproto_shash);
6180 }
6181
6182 static void
6183 ofproto_unixctl_dpif_dump_dps(struct unixctl_conn *conn, int argc OVS_UNUSED,
6184                               const char *argv[] OVS_UNUSED,
6185                               void *aux OVS_UNUSED)
6186 {
6187     struct ds ds = DS_EMPTY_INITIALIZER;
6188     struct shash ofproto_shash;
6189     const struct shash_node **sorted_ofprotos;
6190     int i;
6191
6192     shash_init(&ofproto_shash);
6193     sorted_ofprotos = get_ofprotos(&ofproto_shash);
6194     for (i = 0; i < shash_count(&ofproto_shash); i++) {
6195         const struct shash_node *node = sorted_ofprotos[i];
6196         ds_put_format(&ds, "%s\n", node->name);
6197     }
6198
6199     shash_destroy(&ofproto_shash);
6200     free(sorted_ofprotos);
6201
6202     unixctl_command_reply(conn, ds_cstr(&ds));
6203     ds_destroy(&ds);
6204 }
6205
6206 static void
6207 show_dp_rates(struct ds *ds, const char *heading,
6208               const struct avg_subfacet_rates *rates)
6209 {
6210     ds_put_format(ds, "%s add rate: %5.3f/min, del rate: %5.3f/min\n",
6211                   heading, rates->add_rate, rates->del_rate);
6212 }
6213
6214 static void
6215 dpif_show_backer(const struct dpif_backer *backer, struct ds *ds)
6216 {
6217     const struct shash_node **ofprotos;
6218     struct ofproto_dpif *ofproto;
6219     struct shash ofproto_shash;
6220     uint64_t n_hit, n_missed;
6221     long long int minutes;
6222     size_t i;
6223
6224     n_hit = n_missed = 0;
6225     HMAP_FOR_EACH (ofproto, all_ofproto_dpifs_node, &all_ofproto_dpifs) {
6226         if (ofproto->backer == backer) {
6227             n_missed += ofproto->n_missed;
6228             n_hit += ofproto->n_hit;
6229         }
6230     }
6231
6232     ds_put_format(ds, "%s: hit:%"PRIu64" missed:%"PRIu64"\n",
6233                   dpif_name(backer->dpif), n_hit, n_missed);
6234     ds_put_format(ds, "\tflows: cur: %zu, avg: %u, max: %u,"
6235                   " life span: %lldms\n", hmap_count(&backer->subfacets),
6236                   backer->avg_n_subfacet, backer->max_n_subfacet,
6237                   backer->avg_subfacet_life);
6238
6239     minutes = (time_msec() - backer->created) / (1000 * 60);
6240     if (minutes >= 60) {
6241         show_dp_rates(ds, "\thourly avg:", &backer->hourly);
6242     }
6243     if (minutes >= 60 * 24) {
6244         show_dp_rates(ds, "\tdaily avg:",  &backer->daily);
6245     }
6246     show_dp_rates(ds, "\toverall avg:",  &backer->lifetime);
6247
6248     shash_init(&ofproto_shash);
6249     ofprotos = get_ofprotos(&ofproto_shash);
6250     for (i = 0; i < shash_count(&ofproto_shash); i++) {
6251         struct ofproto_dpif *ofproto = ofprotos[i]->data;
6252         const struct shash_node **ports;
6253         size_t j;
6254
6255         if (ofproto->backer != backer) {
6256             continue;
6257         }
6258
6259         ds_put_format(ds, "\t%s: hit:%"PRIu64" missed:%"PRIu64"\n",
6260                       ofproto->up.name, ofproto->n_hit, ofproto->n_missed);
6261
6262         ports = shash_sort(&ofproto->up.port_by_name);
6263         for (j = 0; j < shash_count(&ofproto->up.port_by_name); j++) {
6264             const struct shash_node *node = ports[j];
6265             struct ofport *ofport = node->data;
6266             struct smap config;
6267             odp_port_t odp_port;
6268
6269             ds_put_format(ds, "\t\t%s %u/", netdev_get_name(ofport->netdev),
6270                           ofport->ofp_port);
6271
6272             odp_port = ofp_port_to_odp_port(ofproto, ofport->ofp_port);
6273             if (odp_port != ODPP_NONE) {
6274                 ds_put_format(ds, "%"PRIu32":", odp_port);
6275             } else {
6276                 ds_put_cstr(ds, "none:");
6277             }
6278
6279             ds_put_format(ds, " (%s", netdev_get_type(ofport->netdev));
6280
6281             smap_init(&config);
6282             if (!netdev_get_config(ofport->netdev, &config)) {
6283                 const struct smap_node **nodes;
6284                 size_t i;
6285
6286                 nodes = smap_sort(&config);
6287                 for (i = 0; i < smap_count(&config); i++) {
6288                     const struct smap_node *node = nodes[i];
6289                     ds_put_format(ds, "%c %s=%s", i ? ',' : ':',
6290                                   node->key, node->value);
6291                 }
6292                 free(nodes);
6293             }
6294             smap_destroy(&config);
6295
6296             ds_put_char(ds, ')');
6297             ds_put_char(ds, '\n');
6298         }
6299         free(ports);
6300     }
6301     shash_destroy(&ofproto_shash);
6302     free(ofprotos);
6303 }
6304
6305 static void
6306 ofproto_unixctl_dpif_show(struct unixctl_conn *conn, int argc OVS_UNUSED,
6307                           const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED)
6308 {
6309     struct ds ds = DS_EMPTY_INITIALIZER;
6310     const struct shash_node **backers;
6311     int i;
6312
6313     backers = shash_sort(&all_dpif_backers);
6314     for (i = 0; i < shash_count(&all_dpif_backers); i++) {
6315         dpif_show_backer(backers[i]->data, &ds);
6316     }
6317     free(backers);
6318
6319     unixctl_command_reply(conn, ds_cstr(&ds));
6320     ds_destroy(&ds);
6321 }
6322
6323 /* Dump the megaflow (facet) cache.  This is useful to check the
6324  * correctness of flow wildcarding, since the same mechanism is used for
6325  * both xlate caching and kernel wildcarding.
6326  *
6327  * It's important to note that in the output the flow description uses
6328  * OpenFlow (OFP) ports, but the actions use datapath (ODP) ports.
6329  *
6330  * This command is only needed for advanced debugging, so it's not
6331  * documented in the man page. */
6332 static void
6333 ofproto_unixctl_dpif_dump_megaflows(struct unixctl_conn *conn,
6334                                     int argc OVS_UNUSED, const char *argv[],
6335                                     void *aux OVS_UNUSED)
6336 {
6337     struct ds ds = DS_EMPTY_INITIALIZER;
6338     const struct ofproto_dpif *ofproto;
6339     long long int now = time_msec();
6340     struct cls_cursor cursor;
6341     struct facet *facet;
6342
6343     ofproto = ofproto_dpif_lookup(argv[1]);
6344     if (!ofproto) {
6345         unixctl_command_reply_error(conn, "no such bridge");
6346         return;
6347     }
6348
6349     cls_cursor_init(&cursor, &ofproto->facets, NULL);
6350     CLS_CURSOR_FOR_EACH (facet, cr, &cursor) {
6351         cls_rule_format(&facet->cr, &ds);
6352         ds_put_cstr(&ds, ", ");
6353         ds_put_format(&ds, "n_subfacets:%zu, ", list_size(&facet->subfacets));
6354         ds_put_format(&ds, "used:%.3fs, ", (now - facet->used) / 1000.0);
6355         ds_put_cstr(&ds, "Datapath actions: ");
6356         if (facet->xout.slow) {
6357             uint64_t slow_path_stub[128 / 8];
6358             const struct nlattr *actions;
6359             size_t actions_len;
6360
6361             compose_slow_path(ofproto, &facet->flow, facet->xout.slow,
6362                               slow_path_stub, sizeof slow_path_stub,
6363                               &actions, &actions_len);
6364             format_odp_actions(&ds, actions, actions_len);
6365         } else {
6366             format_odp_actions(&ds, facet->xout.odp_actions.data,
6367                                facet->xout.odp_actions.size);
6368         }
6369         ds_put_cstr(&ds, "\n");
6370     }
6371
6372     ds_chomp(&ds, '\n');
6373     unixctl_command_reply(conn, ds_cstr(&ds));
6374     ds_destroy(&ds);
6375 }
6376
6377 static void
6378 ofproto_unixctl_dpif_dump_flows(struct unixctl_conn *conn,
6379                                 int argc OVS_UNUSED, const char *argv[],
6380                                 void *aux OVS_UNUSED)
6381 {
6382     struct ds ds = DS_EMPTY_INITIALIZER;
6383     const struct ofproto_dpif *ofproto;
6384     struct subfacet *subfacet;
6385
6386     ofproto = ofproto_dpif_lookup(argv[1]);
6387     if (!ofproto) {
6388         unixctl_command_reply_error(conn, "no such bridge");
6389         return;
6390     }
6391
6392     update_stats(ofproto->backer);
6393
6394     HMAP_FOR_EACH (subfacet, hmap_node, &ofproto->backer->subfacets) {
6395         struct facet *facet = subfacet->facet;
6396
6397         if (ofproto_dpif_cast(facet->rule->up.ofproto) != ofproto) {
6398             continue;
6399         }
6400
6401         odp_flow_key_format(subfacet->key, subfacet->key_len, &ds);
6402
6403         ds_put_format(&ds, ", packets:%"PRIu64", bytes:%"PRIu64", used:",
6404                       subfacet->dp_packet_count, subfacet->dp_byte_count);
6405         if (subfacet->used) {
6406             ds_put_format(&ds, "%.3fs",
6407                           (time_msec() - subfacet->used) / 1000.0);
6408         } else {
6409             ds_put_format(&ds, "never");
6410         }
6411         if (subfacet->facet->tcp_flags) {
6412             ds_put_cstr(&ds, ", flags:");
6413             packet_format_tcp_flags(&ds, subfacet->facet->tcp_flags);
6414         }
6415
6416         ds_put_cstr(&ds, ", actions:");
6417         if (facet->xout.slow) {
6418             uint64_t slow_path_stub[128 / 8];
6419             const struct nlattr *actions;
6420             size_t actions_len;
6421
6422             compose_slow_path(ofproto, &facet->flow, facet->xout.slow,
6423                               slow_path_stub, sizeof slow_path_stub,
6424                               &actions, &actions_len);
6425             format_odp_actions(&ds, actions, actions_len);
6426         } else {
6427             format_odp_actions(&ds, facet->xout.odp_actions.data,
6428                                facet->xout.odp_actions.size);
6429         }
6430         ds_put_char(&ds, '\n');
6431     }
6432
6433     unixctl_command_reply(conn, ds_cstr(&ds));
6434     ds_destroy(&ds);
6435 }
6436
6437 static void
6438 ofproto_unixctl_dpif_del_flows(struct unixctl_conn *conn,
6439                                int argc OVS_UNUSED, const char *argv[],
6440                                void *aux OVS_UNUSED)
6441 {
6442     struct ds ds = DS_EMPTY_INITIALIZER;
6443     struct ofproto_dpif *ofproto;
6444
6445     ofproto = ofproto_dpif_lookup(argv[1]);
6446     if (!ofproto) {
6447         unixctl_command_reply_error(conn, "no such bridge");
6448         return;
6449     }
6450
6451     flush(&ofproto->up);
6452
6453     unixctl_command_reply(conn, ds_cstr(&ds));
6454     ds_destroy(&ds);
6455 }
6456
6457 static void
6458 ofproto_dpif_unixctl_init(void)
6459 {
6460     static bool registered;
6461     if (registered) {
6462         return;
6463     }
6464     registered = true;
6465
6466     unixctl_command_register(
6467         "ofproto/trace",
6468         "[dp_name]|bridge odp_flow|br_flow [-generate|packet]",
6469         1, 3, ofproto_unixctl_trace, NULL);
6470     unixctl_command_register("fdb/flush", "[bridge]", 0, 1,
6471                              ofproto_unixctl_fdb_flush, NULL);
6472     unixctl_command_register("fdb/show", "bridge", 1, 1,
6473                              ofproto_unixctl_fdb_show, NULL);
6474     unixctl_command_register("ofproto/clog", "", 0, 0,
6475                              ofproto_dpif_clog, NULL);
6476     unixctl_command_register("ofproto/unclog", "", 0, 0,
6477                              ofproto_dpif_unclog, NULL);
6478     unixctl_command_register("ofproto/self-check", "[bridge]", 0, 1,
6479                              ofproto_dpif_self_check, NULL);
6480     unixctl_command_register("dpif/dump-dps", "", 0, 0,
6481                              ofproto_unixctl_dpif_dump_dps, NULL);
6482     unixctl_command_register("dpif/show", "", 0, 0, ofproto_unixctl_dpif_show,
6483                              NULL);
6484     unixctl_command_register("dpif/dump-flows", "bridge", 1, 1,
6485                              ofproto_unixctl_dpif_dump_flows, NULL);
6486     unixctl_command_register("dpif/del-flows", "bridge", 1, 1,
6487                              ofproto_unixctl_dpif_del_flows, NULL);
6488     unixctl_command_register("dpif/dump-megaflows", "bridge", 1, 1,
6489                              ofproto_unixctl_dpif_dump_megaflows, NULL);
6490 }
6491 \f
6492 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
6493  *
6494  * This is deprecated.  It is only for compatibility with broken device drivers
6495  * in old versions of Linux that do not properly support VLANs when VLAN
6496  * devices are not used.  When broken device drivers are no longer in
6497  * widespread use, we will delete these interfaces. */
6498
6499 static int
6500 set_realdev(struct ofport *ofport_, ofp_port_t realdev_ofp_port, int vid)
6501 {
6502     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofport_->ofproto);
6503     struct ofport_dpif *ofport = ofport_dpif_cast(ofport_);
6504
6505     if (realdev_ofp_port == ofport->realdev_ofp_port
6506         && vid == ofport->vlandev_vid) {
6507         return 0;
6508     }
6509
6510     ofproto->backer->need_revalidate = REV_RECONFIGURE;
6511
6512     if (ofport->realdev_ofp_port) {
6513         vsp_remove(ofport);
6514     }
6515     if (realdev_ofp_port && ofport->bundle) {
6516         /* vlandevs are enslaved to their realdevs, so they are not allowed to
6517          * themselves be part of a bundle. */
6518         bundle_set(ofport->up.ofproto, ofport->bundle, NULL);
6519     }
6520
6521     ofport->realdev_ofp_port = realdev_ofp_port;
6522     ofport->vlandev_vid = vid;
6523
6524     if (realdev_ofp_port) {
6525         vsp_add(ofport, realdev_ofp_port, vid);
6526     }
6527
6528     return 0;
6529 }
6530
6531 static uint32_t
6532 hash_realdev_vid(ofp_port_t realdev_ofp_port, int vid)
6533 {
6534     return hash_2words(ofp_to_u16(realdev_ofp_port), vid);
6535 }
6536
6537 /* Returns the OFP port number of the Linux VLAN device that corresponds to
6538  * 'vlan_tci' on the network device with port number 'realdev_ofp_port' in
6539  * 'struct ofport_dpif'.  For example, given 'realdev_ofp_port' of eth0 and
6540  * 'vlan_tci' 9, it would return the port number of eth0.9.
6541  *
6542  * Unless VLAN splinters are enabled for port 'realdev_ofp_port', this
6543  * function just returns its 'realdev_ofp_port' argument. */
6544 ofp_port_t
6545 vsp_realdev_to_vlandev(const struct ofproto_dpif *ofproto,
6546                        ofp_port_t realdev_ofp_port, ovs_be16 vlan_tci)
6547 {
6548     if (!hmap_is_empty(&ofproto->realdev_vid_map)) {
6549         int vid = vlan_tci_to_vid(vlan_tci);
6550         const struct vlan_splinter *vsp;
6551
6552         HMAP_FOR_EACH_WITH_HASH (vsp, realdev_vid_node,
6553                                  hash_realdev_vid(realdev_ofp_port, vid),
6554                                  &ofproto->realdev_vid_map) {
6555             if (vsp->realdev_ofp_port == realdev_ofp_port
6556                 && vsp->vid == vid) {
6557                 return vsp->vlandev_ofp_port;
6558             }
6559         }
6560     }
6561     return realdev_ofp_port;
6562 }
6563
6564 static struct vlan_splinter *
6565 vlandev_find(const struct ofproto_dpif *ofproto, ofp_port_t vlandev_ofp_port)
6566 {
6567     struct vlan_splinter *vsp;
6568
6569     HMAP_FOR_EACH_WITH_HASH (vsp, vlandev_node,
6570                              hash_ofp_port(vlandev_ofp_port),
6571                              &ofproto->vlandev_map) {
6572         if (vsp->vlandev_ofp_port == vlandev_ofp_port) {
6573             return vsp;
6574         }
6575     }
6576
6577     return NULL;
6578 }
6579
6580 /* Returns the OpenFlow port number of the "real" device underlying the Linux
6581  * VLAN device with OpenFlow port number 'vlandev_ofp_port' and stores the
6582  * VLAN VID of the Linux VLAN device in '*vid'.  For example, given
6583  * 'vlandev_ofp_port' of eth0.9, it would return the OpenFlow port number of
6584  * eth0 and store 9 in '*vid'.
6585  *
6586  * Returns 0 and does not modify '*vid' if 'vlandev_ofp_port' is not a Linux
6587  * VLAN device.  Unless VLAN splinters are enabled, this is what this function
6588  * always does.*/
6589 static ofp_port_t
6590 vsp_vlandev_to_realdev(const struct ofproto_dpif *ofproto,
6591                        ofp_port_t vlandev_ofp_port, int *vid)
6592 {
6593     if (!hmap_is_empty(&ofproto->vlandev_map)) {
6594         const struct vlan_splinter *vsp;
6595
6596         vsp = vlandev_find(ofproto, vlandev_ofp_port);
6597         if (vsp) {
6598             if (vid) {
6599                 *vid = vsp->vid;
6600             }
6601             return vsp->realdev_ofp_port;
6602         }
6603     }
6604     return 0;
6605 }
6606
6607 /* Given 'flow', a flow representing a packet received on 'ofproto', checks
6608  * whether 'flow->in_port' represents a Linux VLAN device.  If so, changes
6609  * 'flow->in_port' to the "real" device backing the VLAN device, sets
6610  * 'flow->vlan_tci' to the VLAN VID, and returns true.  Otherwise (which is
6611  * always the case unless VLAN splinters are enabled), returns false without
6612  * making any changes. */
6613 static bool
6614 vsp_adjust_flow(const struct ofproto_dpif *ofproto, struct flow *flow)
6615 {
6616     ofp_port_t realdev;
6617     int vid;
6618
6619     realdev = vsp_vlandev_to_realdev(ofproto, flow->in_port.ofp_port, &vid);
6620     if (!realdev) {
6621         return false;
6622     }
6623
6624     /* Cause the flow to be processed as if it came in on the real device with
6625      * the VLAN device's VLAN ID. */
6626     flow->in_port.ofp_port = realdev;
6627     flow->vlan_tci = htons((vid & VLAN_VID_MASK) | VLAN_CFI);
6628     return true;
6629 }
6630
6631 static void
6632 vsp_remove(struct ofport_dpif *port)
6633 {
6634     struct ofproto_dpif *ofproto = ofproto_dpif_cast(port->up.ofproto);
6635     struct vlan_splinter *vsp;
6636
6637     vsp = vlandev_find(ofproto, port->up.ofp_port);
6638     if (vsp) {
6639         hmap_remove(&ofproto->vlandev_map, &vsp->vlandev_node);
6640         hmap_remove(&ofproto->realdev_vid_map, &vsp->realdev_vid_node);
6641         free(vsp);
6642
6643         port->realdev_ofp_port = 0;
6644     } else {
6645         VLOG_ERR("missing vlan device record");
6646     }
6647 }
6648
6649 static void
6650 vsp_add(struct ofport_dpif *port, ofp_port_t realdev_ofp_port, int vid)
6651 {
6652     struct ofproto_dpif *ofproto = ofproto_dpif_cast(port->up.ofproto);
6653
6654     if (!vsp_vlandev_to_realdev(ofproto, port->up.ofp_port, NULL)
6655         && (vsp_realdev_to_vlandev(ofproto, realdev_ofp_port, htons(vid))
6656             == realdev_ofp_port)) {
6657         struct vlan_splinter *vsp;
6658
6659         vsp = xmalloc(sizeof *vsp);
6660         hmap_insert(&ofproto->vlandev_map, &vsp->vlandev_node,
6661                     hash_ofp_port(port->up.ofp_port));
6662         hmap_insert(&ofproto->realdev_vid_map, &vsp->realdev_vid_node,
6663                     hash_realdev_vid(realdev_ofp_port, vid));
6664         vsp->realdev_ofp_port = realdev_ofp_port;
6665         vsp->vlandev_ofp_port = port->up.ofp_port;
6666         vsp->vid = vid;
6667
6668         port->realdev_ofp_port = realdev_ofp_port;
6669     } else {
6670         VLOG_ERR("duplicate vlan device record");
6671     }
6672 }
6673
6674 odp_port_t
6675 ofp_port_to_odp_port(const struct ofproto_dpif *ofproto, ofp_port_t ofp_port)
6676 {
6677     const struct ofport_dpif *ofport = get_ofp_port(ofproto, ofp_port);
6678     return ofport ? ofport->odp_port : ODPP_NONE;
6679 }
6680
6681 static struct ofport_dpif *
6682 odp_port_to_ofport(const struct dpif_backer *backer, odp_port_t odp_port)
6683 {
6684     struct ofport_dpif *port;
6685
6686     HMAP_FOR_EACH_IN_BUCKET (port, odp_port_node, hash_odp_port(odp_port),
6687                              &backer->odp_to_ofport_map) {
6688         if (port->odp_port == odp_port) {
6689             return port;
6690         }
6691     }
6692
6693     return NULL;
6694 }
6695
6696 static ofp_port_t
6697 odp_port_to_ofp_port(const struct ofproto_dpif *ofproto, odp_port_t odp_port)
6698 {
6699     struct ofport_dpif *port;
6700
6701     port = odp_port_to_ofport(ofproto->backer, odp_port);
6702     if (port && &ofproto->up == port->up.ofproto) {
6703         return port->up.ofp_port;
6704     } else {
6705         return OFPP_NONE;
6706     }
6707 }
6708
6709 /* Compute exponentially weighted moving average, adding 'new' as the newest,
6710  * most heavily weighted element.  'base' designates the rate of decay: after
6711  * 'base' further updates, 'new''s weight in the EWMA decays to about 1/e
6712  * (about .37). */
6713 static void
6714 exp_mavg(double *avg, int base, double new)
6715 {
6716     *avg = (*avg * (base - 1) + new) / base;
6717 }
6718
6719 static void
6720 update_moving_averages(struct dpif_backer *backer)
6721 {
6722     const int min_ms = 60 * 1000; /* milliseconds in one minute. */
6723     long long int minutes = (time_msec() - backer->created) / min_ms;
6724
6725     if (minutes > 0) {
6726         backer->lifetime.add_rate = (double) backer->total_subfacet_add_count
6727             / minutes;
6728         backer->lifetime.del_rate = (double) backer->total_subfacet_del_count
6729             / minutes;
6730     } else {
6731         backer->lifetime.add_rate = 0.0;
6732         backer->lifetime.del_rate = 0.0;
6733     }
6734
6735     /* Update hourly averages on the minute boundaries. */
6736     if (time_msec() - backer->last_minute >= min_ms) {
6737         exp_mavg(&backer->hourly.add_rate, 60, backer->subfacet_add_count);
6738         exp_mavg(&backer->hourly.del_rate, 60, backer->subfacet_del_count);
6739
6740         /* Update daily averages on the hour boundaries. */
6741         if ((backer->last_minute - backer->created) / min_ms % 60 == 59) {
6742             exp_mavg(&backer->daily.add_rate, 24, backer->hourly.add_rate);
6743             exp_mavg(&backer->daily.del_rate, 24, backer->hourly.del_rate);
6744         }
6745
6746         backer->total_subfacet_add_count += backer->subfacet_add_count;
6747         backer->total_subfacet_del_count += backer->subfacet_del_count;
6748         backer->subfacet_add_count = 0;
6749         backer->subfacet_del_count = 0;
6750         backer->last_minute += min_ms;
6751     }
6752 }
6753
6754 const struct ofproto_class ofproto_dpif_class = {
6755     init,
6756     enumerate_types,
6757     enumerate_names,
6758     del,
6759     port_open_type,
6760     type_run,
6761     type_run_fast,
6762     type_wait,
6763     alloc,
6764     construct,
6765     destruct,
6766     dealloc,
6767     run,
6768     run_fast,
6769     wait,
6770     get_memory_usage,
6771     flush,
6772     get_features,
6773     get_tables,
6774     port_alloc,
6775     port_construct,
6776     port_destruct,
6777     port_dealloc,
6778     port_modified,
6779     port_reconfigured,
6780     port_query_by_name,
6781     port_add,
6782     port_del,
6783     port_get_stats,
6784     port_dump_start,
6785     port_dump_next,
6786     port_dump_done,
6787     port_poll,
6788     port_poll_wait,
6789     port_is_lacp_current,
6790     NULL,                       /* rule_choose_table */
6791     rule_alloc,
6792     rule_construct,
6793     rule_destruct,
6794     rule_dealloc,
6795     rule_get_stats,
6796     rule_execute,
6797     rule_modify_actions,
6798     set_frag_handling,
6799     packet_out,
6800     set_netflow,
6801     get_netflow_ids,
6802     set_sflow,
6803     set_ipfix,
6804     set_cfm,
6805     get_cfm_status,
6806     set_bfd,
6807     get_bfd_status,
6808     set_stp,
6809     get_stp_status,
6810     set_stp_port,
6811     get_stp_port_status,
6812     set_queues,
6813     bundle_set,
6814     bundle_remove,
6815     mirror_set,
6816     mirror_get_stats,
6817     set_flood_vlans,
6818     is_mirror_output_bundle,
6819     forward_bpdu_changed,
6820     set_mac_table_config,
6821     set_realdev,
6822 };