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-provider.h"
  20
  21 #include <errno.h>
  22
  23 #include "bfd.h"
  24 #include "bond.h"
  25 #include "bundle.h"
  26 #include "byte-order.h"
  27 #include "connmgr.h"
  28 #include "coverage.h"
  29 #include "cfm.h"
  30 #include "dpif.h"
  31 #include "dynamic-string.h"
  32 #include "fail-open.h"
  33 #include "hmapx.h"
  34 #include "lacp.h"
  35 #include "learn.h"
  36 #include "mac-learning.h"
  37 #include "meta-flow.h"
  38 #include "multipath.h"
  39 #include "netdev-vport.h"
  40 #include "netdev.h"
  41 #include "netlink.h"
  42 #include "nx-match.h"
  43 #include "odp-util.h"
  44 #include "ofp-util.h"
  45 #include "ofpbuf.h"
  46 #include "ofp-actions.h"
  47 #include "ofp-parse.h"
  48 #include "ofp-print.h"
  49 #include "ofproto-dpif-governor.h"
  50 #include "ofproto-dpif-ipfix.h"
  51 #include "ofproto-dpif-sflow.h"
  52 #include "poll-loop.h"
  53 #include "simap.h"
  54 #include "smap.h"
  55 #include "timer.h"
  56 #include "tunnel.h"
  57 #include "unaligned.h"
  58 #include "unixctl.h"
  59 #include "vlan-bitmap.h"
  60 #include "vlog.h"
  61
  62 VLOG_DEFINE_THIS_MODULE(ofproto_dpif);
  63
  64 COVERAGE_DEFINE(ofproto_dpif_expired);
  65 COVERAGE_DEFINE(ofproto_dpif_xlate);
  66 COVERAGE_DEFINE(facet_changed_rule);
  67 COVERAGE_DEFINE(facet_revalidate);
  68 COVERAGE_DEFINE(facet_unexpected);
  69 COVERAGE_DEFINE(facet_suppress);
  70
  71 /* Maximum depth of flow table recursion (due to resubmit actions) in a
  72  * flow translation. */
  73 #define MAX_RESUBMIT_RECURSION 64
  74
  75 /* Number of implemented OpenFlow tables. */
  76 enum { N_TABLES = 255 };
  77 enum { TBL_INTERNAL = N_TABLES - 1 };    /* Used for internal hidden rules. */
  78 BUILD_ASSERT_DECL(N_TABLES >= 2 && N_TABLES <= 255);
  79
  80 struct ofport_dpif;
  81 struct ofproto_dpif;
  82 struct flow_miss;
  83 struct facet;
  84
  85 struct rule_dpif {
  86     struct rule up;
  87
  88     /* These statistics:
  89      *
  90      *   - Do include packets and bytes from facets that have been deleted or
  91      *     whose own statistics have been folded into the rule.
  92      *
  93      *   - Do include packets and bytes sent "by hand" that were accounted to
  94      *     the rule without any facet being involved (this is a rare corner
  95      *     case in rule_execute()).
  96      *
  97      *   - Do not include packet or bytes that can be obtained from any facet's
  98      *     packet_count or byte_count member or that can be obtained from the
  99      *     datapath by, e.g., dpif_flow_get() for any subfacet.
 100      */
 101     uint64_t packet_count;       /* Number of packets received. */
 102     uint64_t byte_count;         /* Number of bytes received. */
 103
 104     tag_type tag;                /* Caches rule_calculate_tag() result. */
 105
 106     struct list facets;          /* List of "struct facet"s. */
 107 };
 108
 109 static struct rule_dpif *rule_dpif_cast(const struct rule *rule)
 110 {
 111     return rule ? CONTAINER_OF(rule, struct rule_dpif, up) : NULL;
 112 }
 113
 114 static struct rule_dpif *rule_dpif_lookup(struct ofproto_dpif *,
 115                                           const struct flow *);
 116 static struct rule_dpif *rule_dpif_lookup__(struct ofproto_dpif *,
 117                                             const struct flow *,
 118                                             uint8_t table);
 119 static struct rule_dpif *rule_dpif_miss_rule(struct ofproto_dpif *ofproto,
 120                                              const struct flow *flow);
 121
 122 static void rule_credit_stats(struct rule_dpif *,
 123                               const struct dpif_flow_stats *);
 124 static void flow_push_stats(struct facet *, const struct dpif_flow_stats *);
 125 static tag_type rule_calculate_tag(const struct flow *,
 126                                    const struct minimask *, uint32_t basis);
 127 static void rule_invalidate(const struct rule_dpif *);
 128
 129 #define MAX_MIRRORS 32
 130 typedef uint32_t mirror_mask_t;
 131 #define MIRROR_MASK_C(X) UINT32_C(X)
 132 BUILD_ASSERT_DECL(sizeof(mirror_mask_t) * CHAR_BIT >= MAX_MIRRORS);
 133 struct ofmirror {
 134     struct ofproto_dpif *ofproto; /* Owning ofproto. */
 135     size_t idx;                 /* In ofproto's "mirrors" array. */
 136     void *aux;                  /* Key supplied by ofproto's client. */
 137     char *name;                 /* Identifier for log messages. */
 138
 139     /* Selection criteria. */
 140     struct hmapx srcs;          /* Contains "struct ofbundle *"s. */
 141     struct hmapx dsts;          /* Contains "struct ofbundle *"s. */
 142     unsigned long *vlans;       /* Bitmap of chosen VLANs, NULL selects all. */
 143
 144     /* Output (exactly one of out == NULL and out_vlan == -1 is true). */
 145     struct ofbundle *out;       /* Output port or NULL. */
 146     int out_vlan;               /* Output VLAN or -1. */
 147     mirror_mask_t dup_mirrors;  /* Bitmap of mirrors with the same output. */
 148
 149     /* Counters. */
 150     int64_t packet_count;       /* Number of packets sent. */
 151     int64_t byte_count;         /* Number of bytes sent. */
 152 };
 153
 154 static void mirror_destroy(struct ofmirror *);
 155 static void update_mirror_stats(struct ofproto_dpif *ofproto,
 156                                 mirror_mask_t mirrors,
 157                                 uint64_t packets, uint64_t bytes);
 158
 159 struct ofbundle {
 160     struct hmap_node hmap_node; /* In struct ofproto's "bundles" hmap. */
 161     struct ofproto_dpif *ofproto; /* Owning ofproto. */
 162     void *aux;                  /* Key supplied by ofproto's client. */
 163     char *name;                 /* Identifier for log messages. */
 164
 165     /* Configuration. */
 166     struct list ports;          /* Contains "struct ofport"s. */
 167     enum port_vlan_mode vlan_mode; /* VLAN mode */
 168     int vlan;                   /* -1=trunk port, else a 12-bit VLAN ID. */
 169     unsigned long *trunks;      /* Bitmap of trunked VLANs, if 'vlan' == -1.
 170                                  * NULL if all VLANs are trunked. */
 171     struct lacp *lacp;          /* LACP if LACP is enabled, otherwise NULL. */
 172     struct bond *bond;          /* Nonnull iff more than one port. */
 173     bool use_priority_tags;     /* Use 802.1p tag for frames in VLAN 0? */
 174
 175     /* Status. */
 176     bool floodable;          /* True if no port has OFPUTIL_PC_NO_FLOOD set. */
 177
 178     /* Port mirroring info. */
 179     mirror_mask_t src_mirrors;  /* Mirrors triggered when packet received. */
 180     mirror_mask_t dst_mirrors;  /* Mirrors triggered when packet sent. */
 181     mirror_mask_t mirror_out;   /* Mirrors that output to this bundle. */
 182 };
 183
 184 static void bundle_remove(struct ofport *);
 185 static void bundle_update(struct ofbundle *);
 186 static void bundle_destroy(struct ofbundle *);
 187 static void bundle_del_port(struct ofport_dpif *);
 188 static void bundle_run(struct ofbundle *);
 189 static void bundle_wait(struct ofbundle *);
 190 static struct ofbundle *lookup_input_bundle(const struct ofproto_dpif *,
 191                                             uint16_t in_port, bool warn,
 192                                             struct ofport_dpif **in_ofportp);
 193
 194 /* A controller may use OFPP_NONE as the ingress port to indicate that
 195  * it did not arrive on a "real" port.  'ofpp_none_bundle' exists for
 196  * when an input bundle is needed for validation (e.g., mirroring or
 197  * OFPP_NORMAL processing).  It is not connected to an 'ofproto' or have
 198  * any 'port' structs, so care must be taken when dealing with it. */
 199 static struct ofbundle ofpp_none_bundle = {
 200     .name      = "OFPP_NONE",
 201     .vlan_mode = PORT_VLAN_TRUNK
 202 };
 203
 204 static void stp_run(struct ofproto_dpif *ofproto);
 205 static void stp_wait(struct ofproto_dpif *ofproto);
 206 static int set_stp_port(struct ofport *,
 207                         const struct ofproto_port_stp_settings *);
 208
 209 static bool ofbundle_includes_vlan(const struct ofbundle *, uint16_t vlan);
 210
 211 struct action_xlate_ctx {
 212 /* action_xlate_ctx_init() initializes these members. */
 213
 214     /* The ofproto. */
 215     struct ofproto_dpif *ofproto;
 216
 217     /* Flow to which the OpenFlow actions apply.  xlate_actions() will modify
 218      * this flow when actions change header fields. */
 219     struct flow flow;
 220
 221     /* stack for the push and pop actions.
 222      * Each stack element is of the type "union mf_subvalue". */
 223     struct ofpbuf stack;
 224     union mf_subvalue init_stack[1024 / sizeof(union mf_subvalue)];
 225
 226     /* The packet corresponding to 'flow', or a null pointer if we are
 227      * revalidating without a packet to refer to. */
 228     const struct ofpbuf *packet;
 229
 230     /* Should OFPP_NORMAL update the MAC learning table?  Should "learn"
 231      * actions update the flow table?
 232      *
 233      * We want to update these tables if we are actually processing a packet,
 234      * or if we are accounting for packets that the datapath has processed, but
 235      * not if we are just revalidating. */
 236     bool may_learn;
 237
 238     /* The rule that we are currently translating, or NULL. */
 239     struct rule_dpif *rule;
 240
 241     /* Union of the set of TCP flags seen so far in this flow.  (Used only by
 242      * NXAST_FIN_TIMEOUT.  Set to zero to avoid updating updating rules'
 243      * timeouts.) */
 244     uint8_t tcp_flags;
 245
 246     /* If nonnull, flow translation calls this function just before executing a
 247      * resubmit or OFPP_TABLE action.  In addition, disables logging of traces
 248      * when the recursion depth is exceeded.
 249      *
 250      * 'rule' is the rule being submitted into.  It will be null if the
 251      * resubmit or OFPP_TABLE action didn't find a matching rule.
 252      *
 253      * This is normally null so the client has to set it manually after
 254      * calling action_xlate_ctx_init(). */
 255     void (*resubmit_hook)(struct action_xlate_ctx *, struct rule_dpif *rule);
 256
 257     /* If nonnull, flow translation calls this function to report some
 258      * significant decision, e.g. to explain why OFPP_NORMAL translation
 259      * dropped a packet. */
 260     void (*report_hook)(struct action_xlate_ctx *, const char *s);
 261
 262     /* If nonnull, flow translation credits the specified statistics to each
 263      * rule reached through a resubmit or OFPP_TABLE action.
 264      *
 265      * This is normally null so the client has to set it manually after
 266      * calling action_xlate_ctx_init(). */
 267     const struct dpif_flow_stats *resubmit_stats;
 268
 269 /* xlate_actions() initializes and uses these members.  The client might want
 270  * to look at them after it returns. */
 271
 272     struct ofpbuf *odp_actions; /* Datapath actions. */
 273     tag_type tags;              /* Tags associated with actions. */
 274     enum slow_path_reason slow; /* 0 if fast path may be used. */
 275     bool has_learn;             /* Actions include NXAST_LEARN? */
 276     bool has_normal;            /* Actions output to OFPP_NORMAL? */
 277     bool has_fin_timeout;       /* Actions include NXAST_FIN_TIMEOUT? */
 278     uint16_t nf_output_iface;   /* Output interface index for NetFlow. */
 279     mirror_mask_t mirrors;      /* Bitmap of associated mirrors. */
 280
 281 /* xlate_actions() initializes and uses these members, but the client has no
 282  * reason to look at them. */
 283
 284     int recurse;                /* Recursion level, via xlate_table_action. */
 285     bool max_resubmit_trigger;  /* Recursed too deeply during translation. */
 286     struct flow base_flow;      /* Flow at the last commit. */
 287     uint32_t orig_skb_priority; /* Priority when packet arrived. */
 288     uint8_t table_id;           /* OpenFlow table ID where flow was found. */
 289     uint32_t sflow_n_outputs;   /* Number of output ports. */
 290     uint32_t sflow_odp_port;    /* Output port for composing sFlow action. */
 291     uint16_t user_cookie_offset;/* Used for user_action_cookie fixup. */
 292     bool exit;                  /* No further actions should be processed. */
 293 };
 294
 295 /* Initial values of fields of the packet that may be changed during
 296  * flow processing and needed later. */
 297 struct initial_vals {
 298    /* This is the value of vlan_tci in the packet as actually received from
 299     * dpif.  This is the same as the facet's flow.vlan_tci unless the packet
 300     * was received via a VLAN splinter.  In that case, this value is 0
 301     * (because the packet as actually received from the dpif had no 802.1Q
 302     * tag) but the facet's flow.vlan_tci is set to the VLAN that the splinter
 303     * represents.
 304     *
 305     * This member should be removed when the VLAN splinters feature is no
 306     * longer needed. */
 307     ovs_be16 vlan_tci;
 308 };
 309
 310 static void action_xlate_ctx_init(struct action_xlate_ctx *,
 311                                   struct ofproto_dpif *, const struct flow *,
 312                                   const struct initial_vals *initial_vals,
 313                                   struct rule_dpif *,
 314                                   uint8_t tcp_flags, const struct ofpbuf *);
 315 static void xlate_actions(struct action_xlate_ctx *,
 316                           const struct ofpact *ofpacts, size_t ofpacts_len,
 317                           struct ofpbuf *odp_actions);
 318 static void xlate_actions_for_side_effects(struct action_xlate_ctx *,
 319                                            const struct ofpact *ofpacts,
 320                                            size_t ofpacts_len);
 321 static void xlate_table_action(struct action_xlate_ctx *, uint16_t in_port,
 322                                uint8_t table_id, bool may_packet_in);
 323
 324 static size_t put_userspace_action(const struct ofproto_dpif *,
 325                                    struct ofpbuf *odp_actions,
 326                                    const struct flow *,
 327                                    const union user_action_cookie *,
 328                                    const size_t);
 329
 330 static void compose_slow_path(const struct ofproto_dpif *, const struct flow *,
 331                               enum slow_path_reason,
 332                               uint64_t *stub, size_t stub_size,
 333                               const struct nlattr **actionsp,
 334                               size_t *actions_lenp);
 335
 336 static void xlate_report(struct action_xlate_ctx *ctx, const char *s);
 337
 338 /* A subfacet (see "struct subfacet" below) has three possible installation
 339  * states:
 340  *
 341  *   - SF_NOT_INSTALLED: Not installed in the datapath.  This will only be the
 342  *     case just after the subfacet is created, just before the subfacet is
 343  *     destroyed, or if the datapath returns an error when we try to install a
 344  *     subfacet.
 345  *
 346  *   - SF_FAST_PATH: The subfacet's actions are installed in the datapath.
 347  *
 348  *   - SF_SLOW_PATH: An action that sends every packet for the subfacet through
 349  *     ofproto_dpif is installed in the datapath.
 350  */
 351 enum subfacet_path {
 352     SF_NOT_INSTALLED,           /* No datapath flow for this subfacet. */
 353     SF_FAST_PATH,               /* Full actions are installed. */
 354     SF_SLOW_PATH,               /* Send-to-userspace action is installed. */
 355 };
 356
 357 static const char *subfacet_path_to_string(enum subfacet_path);
 358
 359 /* A dpif flow and actions associated with a facet.
 360  *
 361  * See also the large comment on struct facet. */
 362 struct subfacet {
 363     /* Owners. */
 364     struct hmap_node hmap_node; /* In struct ofproto_dpif 'subfacets' list. */
 365     struct list list_node;      /* In struct facet's 'facets' list. */
 366     struct facet *facet;        /* Owning facet. */
 367
 368     enum odp_key_fitness key_fitness;
 369     struct nlattr *key;
 370     int key_len;
 371
 372     long long int used;         /* Time last used; time created if not used. */
 373     long long int created;      /* Time created. */
 374
 375     uint64_t dp_packet_count;   /* Last known packet count in the datapath. */
 376     uint64_t dp_byte_count;     /* Last known byte count in the datapath. */
 377
 378     /* Datapath actions.
 379      *
 380      * These should be essentially identical for every subfacet in a facet, but
 381      * may differ in trivial ways due to VLAN splinters. */
 382     size_t actions_len;         /* Number of bytes in actions[]. */
 383     struct nlattr *actions;     /* Datapath actions. */
 384
 385     enum slow_path_reason slow; /* 0 if fast path may be used. */
 386     enum subfacet_path path;    /* Installed in datapath? */
 387
 388     /* Initial values of the packet that may be needed later. */
 389     struct initial_vals initial_vals;
 390
 391     /* Datapath port the packet arrived on.  This is needed to remove
 392      * flows for ports that are no longer part of the bridge.  Since the
 393      * flow definition only has the OpenFlow port number and the port is
 394      * no longer part of the bridge, we can't determine the datapath port
 395      * number needed to delete the flow from the datapath. */
 396     uint32_t odp_in_port;
 397 };
 398
 399 #define SUBFACET_DESTROY_MAX_BATCH 50
 400
 401 static struct subfacet *subfacet_create(struct facet *, struct flow_miss *miss,
 402                                         long long int now);
 403 static struct subfacet *subfacet_find(struct ofproto_dpif *,
 404                                       const struct nlattr *key, size_t key_len,
 405                                       uint32_t key_hash);
 406 static void subfacet_destroy(struct subfacet *);
 407 static void subfacet_destroy__(struct subfacet *);
 408 static void subfacet_destroy_batch(struct ofproto_dpif *,
 409                                    struct subfacet **, int n);
 410 static void subfacet_reset_dp_stats(struct subfacet *,
 411                                     struct dpif_flow_stats *);
 412 static void subfacet_update_time(struct subfacet *, long long int used);
 413 static void subfacet_update_stats(struct subfacet *,
 414                                   const struct dpif_flow_stats *);
 415 static void subfacet_make_actions(struct subfacet *,
 416                                   const struct ofpbuf *packet,
 417                                   struct ofpbuf *odp_actions);
 418 static int subfacet_install(struct subfacet *,
 419                             const struct nlattr *actions, size_t actions_len,
 420                             struct dpif_flow_stats *, enum slow_path_reason);
 421 static void subfacet_uninstall(struct subfacet *);
 422
 423 static enum subfacet_path subfacet_want_path(enum slow_path_reason);
 424
 425 /* An exact-match instantiation of an OpenFlow flow.
 426  *
 427  * A facet associates a "struct flow", which represents the Open vSwitch
 428  * userspace idea of an exact-match flow, with one or more subfacets.  Each
 429  * subfacet tracks the datapath's idea of the exact-match flow equivalent to
 430  * the facet.  When the kernel module (or other dpif implementation) and Open
 431  * vSwitch userspace agree on the definition of a flow key, there is exactly
 432  * one subfacet per facet.  If the dpif implementation supports more-specific
 433  * flow matching than userspace, however, a facet can have more than one
 434  * subfacet, each of which corresponds to some distinction in flow that
 435  * userspace simply doesn't understand.
 436  *
 437  * Flow expiration works in terms of subfacets, so a facet must have at least
 438  * one subfacet or it will never expire, leaking memory. */
 439 struct facet {
 440     /* Owners. */
 441     struct hmap_node hmap_node;  /* In owning ofproto's 'facets' hmap. */
 442     struct list list_node;       /* In owning rule's 'facets' list. */
 443     struct rule_dpif *rule;      /* Owning rule. */
 444
 445     /* Owned data. */
 446     struct list subfacets;
 447     long long int used;         /* Time last used; time created if not used. */
 448
 449     /* Key. */
 450     struct flow flow;
 451
 452     /* These statistics:
 453      *
 454      *   - Do include packets and bytes sent "by hand", e.g. with
 455      *     dpif_execute().
 456      *
 457      *   - Do include packets and bytes that were obtained from the datapath
 458      *     when a subfacet's statistics were reset (e.g. dpif_flow_put() with
 459      *     DPIF_FP_ZERO_STATS).
 460      *
 461      *   - Do not include packets or bytes that can be obtained from the
 462      *     datapath for any existing subfacet.
 463      */
 464     uint64_t packet_count;       /* Number of packets received. */
 465     uint64_t byte_count;         /* Number of bytes received. */
 466
 467     /* Resubmit statistics. */
 468     uint64_t prev_packet_count;  /* Number of packets from last stats push. */
 469     uint64_t prev_byte_count;    /* Number of bytes from last stats push. */
 470     long long int prev_used;     /* Used time from last stats push. */
 471
 472     /* Accounting. */
 473     uint64_t accounted_bytes;    /* Bytes processed by facet_account(). */
 474     struct netflow_flow nf_flow; /* Per-flow NetFlow tracking data. */
 475     uint8_t tcp_flags;           /* TCP flags seen for this 'rule'. */
 476
 477     /* Properties of datapath actions.
 478      *
 479      * Every subfacet has its own actions because actions can differ slightly
 480      * between splintered and non-splintered subfacets due to the VLAN tag
 481      * being initially different (present vs. absent).  All of them have these
 482      * properties in common so we just store one copy of them here. */
 483     bool has_learn;              /* Actions include NXAST_LEARN? */
 484     bool has_normal;             /* Actions output to OFPP_NORMAL? */
 485     bool has_fin_timeout;        /* Actions include NXAST_FIN_TIMEOUT? */
 486     tag_type tags;               /* Tags that would require revalidation. */
 487     mirror_mask_t mirrors;       /* Bitmap of dependent mirrors. */
 488
 489     /* Storage for a single subfacet, to reduce malloc() time and space
 490      * overhead.  (A facet always has at least one subfacet and in the common
 491      * case has exactly one subfacet.  However, 'one_subfacet' may not
 492      * always be valid, since it could have been removed after newer
 493      * subfacets were pushed onto the 'subfacets' list.) */
 494     struct subfacet one_subfacet;
 495
 496     long long int learn_rl;      /* Rate limiter for facet_learn(). */
 497 };
 498
 499 static struct facet *facet_create(struct rule_dpif *,
 500                                   const struct flow *, uint32_t hash);
 501 static void facet_remove(struct facet *);
 502 static void facet_free(struct facet *);
 503
 504 static struct facet *facet_find(struct ofproto_dpif *,
 505                                 const struct flow *, uint32_t hash);
 506 static struct facet *facet_lookup_valid(struct ofproto_dpif *,
 507                                         const struct flow *, uint32_t hash);
 508 static void facet_revalidate(struct facet *);
 509 static bool facet_check_consistency(struct facet *);
 510
 511 static void facet_flush_stats(struct facet *);
 512
 513 static void facet_update_time(struct facet *, long long int used);
 514 static void facet_reset_counters(struct facet *);
 515 static void facet_push_stats(struct facet *);
 516 static void facet_learn(struct facet *);
 517 static void facet_account(struct facet *);
 518 static void push_all_stats(void);
 519
 520 static struct subfacet *facet_get_subfacet(struct facet *);
 521
 522 static bool facet_is_controller_flow(struct facet *);
 523
 524 struct ofport_dpif {
 525     struct hmap_node odp_port_node; /* In dpif_backer's "odp_to_ofport_map". */
 526     struct ofport up;
 527
 528     uint32_t odp_port;
 529     struct ofbundle *bundle;    /* Bundle that contains this port, if any. */
 530     struct list bundle_node;    /* In struct ofbundle's "ports" list. */
 531     struct cfm *cfm;            /* Connectivity Fault Management, if any. */
 532     struct bfd *bfd;            /* BFD, if any. */
 533     tag_type tag;               /* Tag associated with this port. */
 534     bool may_enable;            /* May be enabled in bonds. */
 535     long long int carrier_seq;  /* Carrier status changes. */
 536     struct tnl_port *tnl_port;  /* Tunnel handle, or null. */
 537
 538     /* Spanning tree. */
 539     struct stp_port *stp_port;  /* Spanning Tree Protocol, if any. */
 540     enum stp_state stp_state;   /* Always STP_DISABLED if STP not in use. */
 541     long long int stp_state_entered;
 542
 543     struct hmap priorities;     /* Map of attached 'priority_to_dscp's. */
 544
 545     /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
 546      *
 547      * This is deprecated.  It is only for compatibility with broken device
 548      * drivers in old versions of Linux that do not properly support VLANs when
 549      * VLAN devices are not used.  When broken device drivers are no longer in
 550      * widespread use, we will delete these interfaces. */
 551     uint16_t realdev_ofp_port;
 552     int vlandev_vid;
 553 };
 554
 555 /* Node in 'ofport_dpif''s 'priorities' map.  Used to maintain a map from
 556  * 'priority' (the datapath's term for QoS queue) to the dscp bits which all
 557  * traffic egressing the 'ofport' with that priority should be marked with. */
 558 struct priority_to_dscp {
 559     struct hmap_node hmap_node; /* Node in 'ofport_dpif''s 'priorities' map. */
 560     uint32_t priority;          /* Priority of this queue (see struct flow). */
 561
 562     uint8_t dscp;               /* DSCP bits to mark outgoing traffic with. */
 563 };
 564
 565 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
 566  *
 567  * This is deprecated.  It is only for compatibility with broken device drivers
 568  * in old versions of Linux that do not properly support VLANs when VLAN
 569  * devices are not used.  When broken device drivers are no longer in
 570  * widespread use, we will delete these interfaces. */
 571 struct vlan_splinter {
 572     struct hmap_node realdev_vid_node;
 573     struct hmap_node vlandev_node;
 574     uint16_t realdev_ofp_port;
 575     uint16_t vlandev_ofp_port;
 576     int vid;
 577 };
 578
 579 static uint32_t vsp_realdev_to_vlandev(const struct ofproto_dpif *,
 580                                        uint32_t realdev, ovs_be16 vlan_tci);
 581 static bool vsp_adjust_flow(const struct ofproto_dpif *, struct flow *);
 582 static void vsp_remove(struct ofport_dpif *);
 583 static void vsp_add(struct ofport_dpif *, uint16_t realdev_ofp_port, int vid);
 584
 585 static uint32_t ofp_port_to_odp_port(const struct ofproto_dpif *,
 586                                      uint16_t ofp_port);
 587 static uint16_t odp_port_to_ofp_port(const struct ofproto_dpif *,
 588                                      uint32_t odp_port);
 589
 590 static struct ofport_dpif *
 591 ofport_dpif_cast(const struct ofport *ofport)
 592 {
 593     return ofport ? CONTAINER_OF(ofport, struct ofport_dpif, up) : NULL;
 594 }
 595
 596 static void port_run(struct ofport_dpif *);
 597 static void port_run_fast(struct ofport_dpif *);
 598 static void port_wait(struct ofport_dpif *);
 599 static int set_cfm(struct ofport *, const struct cfm_settings *);
 600 static void ofport_clear_priorities(struct ofport_dpif *);
 601 static void run_fast_rl(void);
 602
 603 struct dpif_completion {
 604     struct list list_node;
 605     struct ofoperation *op;
 606 };
 607
 608 /* Extra information about a classifier table.
 609  * Currently used just for optimized flow revalidation. */
 610 struct table_dpif {
 611     /* If either of these is nonnull, then this table has a form that allows
 612      * flows to be tagged to avoid revalidating most flows for the most common
 613      * kinds of flow table changes. */
 614     struct cls_table *catchall_table; /* Table that wildcards all fields. */
 615     struct cls_table *other_table;    /* Table with any other wildcard set. */
 616     uint32_t basis;                   /* Keeps each table's tags separate. */
 617 };
 618
 619 /* Reasons that we might need to revalidate every facet, and corresponding
 620  * coverage counters.
 621  *
 622  * A value of 0 means that there is no need to revalidate.
 623  *
 624  * It would be nice to have some cleaner way to integrate with coverage
 625  * counters, but with only a few reasons I guess this is good enough for
 626  * now. */
 627 enum revalidate_reason {
 628     REV_RECONFIGURE = 1,       /* Switch configuration changed. */
 629     REV_STP,                   /* Spanning tree protocol port status change. */
 630     REV_PORT_TOGGLED,          /* Port enabled or disabled by CFM, LACP, ...*/
 631     REV_FLOW_TABLE,            /* Flow table changed. */
 632     REV_INCONSISTENCY          /* Facet self-check failed. */
 633 };
 634 COVERAGE_DEFINE(rev_reconfigure);
 635 COVERAGE_DEFINE(rev_stp);
 636 COVERAGE_DEFINE(rev_port_toggled);
 637 COVERAGE_DEFINE(rev_flow_table);
 638 COVERAGE_DEFINE(rev_inconsistency);
 639
 640 /* Drop keys are odp flow keys which have drop flows installed in the kernel.
 641  * These are datapath flows which have no associated ofproto, if they did we
 642  * would use facets. */
 643 struct drop_key {
 644     struct hmap_node hmap_node;
 645     struct nlattr *key;
 646     size_t key_len;
 647 };
 648
 649 /* All datapaths of a given type share a single dpif backer instance. */
 650 struct dpif_backer {
 651     char *type;
 652     int refcount;
 653     struct dpif *dpif;
 654     struct timer next_expiration;
 655     struct hmap odp_to_ofport_map; /* ODP port to ofport mapping. */
 656
 657     struct simap tnl_backers;      /* Set of dpif ports backing tunnels. */
 658
 659     /* Facet revalidation flags applying to facets which use this backer. */
 660     enum revalidate_reason need_revalidate; /* Revalidate every facet. */
 661     struct tag_set revalidate_set; /* Revalidate only matching facets. */
 662
 663     struct hmap drop_keys; /* Set of dropped odp keys. */
 664 };
 665
 666 /* All existing ofproto_backer instances, indexed by ofproto->up.type. */
 667 static struct shash all_dpif_backers = SHASH_INITIALIZER(&all_dpif_backers);
 668
 669 static void drop_key_clear(struct dpif_backer *);
 670 static struct ofport_dpif *
 671 odp_port_to_ofport(const struct dpif_backer *, uint32_t odp_port);
 672
 673 static void dpif_stats_update_hit_count(struct ofproto_dpif *ofproto,
 674                                         uint64_t delta);
 675 struct avg_subfacet_rates {
 676     double add_rate;     /* Moving average of new flows created per minute. */
 677     double del_rate;     /* Moving average of flows deleted per minute. */
 678 };
 679 static void show_dp_rates(struct ds *ds, const char *heading,
 680                           const struct avg_subfacet_rates *rates);
 681 static void exp_mavg(double *avg, int base, double new);
 682
 683 struct ofproto_dpif {
 684     struct hmap_node all_ofproto_dpifs_node; /* In 'all_ofproto_dpifs'. */
 685     struct ofproto up;
 686     struct dpif_backer *backer;
 687
 688     /* Special OpenFlow rules. */
 689     struct rule_dpif *miss_rule; /* Sends flow table misses to controller. */
 690     struct rule_dpif *no_packet_in_rule; /* Drops flow table misses. */
 691
 692     /* Statistics. */
 693     uint64_t n_matches;
 694
 695     /* Bridging. */
 696     struct netflow *netflow;
 697     struct dpif_sflow *sflow;
 698     struct dpif_ipfix *ipfix;
 699     struct hmap bundles;        /* Contains "struct ofbundle"s. */
 700     struct mac_learning *ml;
 701     struct ofmirror *mirrors[MAX_MIRRORS];
 702     bool has_mirrors;
 703     bool has_bonded_bundles;
 704
 705     /* Facets. */
 706     struct hmap facets;
 707     struct hmap subfacets;
 708     struct governor *governor;
 709     long long int consistency_rl;
 710
 711     /* Revalidation. */
 712     struct table_dpif tables[N_TABLES];
 713
 714     /* Support for debugging async flow mods. */
 715     struct list completions;
 716
 717     bool has_bundle_action; /* True when the first bundle action appears. */
 718     struct netdev_stats stats; /* To account packets generated and consumed in
 719                                 * userspace. */
 720
 721     /* Spanning tree. */
 722     struct stp *stp;
 723     long long int stp_last_tick;
 724
 725     /* VLAN splinters. */
 726     struct hmap realdev_vid_map; /* (realdev,vid) -> vlandev. */
 727     struct hmap vlandev_map;     /* vlandev -> (realdev,vid). */
 728
 729     /* Ports. */
 730     struct sset ports;             /* Set of standard port names. */
 731     struct sset ghost_ports;       /* Ports with no datapath port. */
 732     struct sset port_poll_set;     /* Queued names for port_poll() reply. */
 733     int port_poll_errno;           /* Last errno for port_poll() reply. */
 734
 735     /* Per ofproto's dpif stats. */
 736     uint64_t n_hit;
 737     uint64_t n_missed;
 738
 739     /* Subfacet statistics.
 740      *
 741      * These keep track of the total number of subfacets added and deleted and
 742      * flow life span.  They are useful for computing the flow rates stats
 743      * exposed via "ovs-appctl dpif/show".  The goal is to learn about
 744      * traffic patterns in ways that we can use later to improve Open vSwitch
 745      * performance in new situations.  */
 746     long long int created;         /* Time when it is created. */
 747     unsigned int max_n_subfacet;   /* Maximum number of flows */
 748
 749     /* The average number of subfacets... */
 750     struct avg_subfacet_rates hourly; /* ...over the last hour. */
 751     struct avg_subfacet_rates daily;  /* ...over the last day. */
 752     long long int last_minute;        /* Last time 'hourly' was updated. */
 753
 754     /* Number of subfacets added or deleted since 'last_minute'. */
 755     unsigned int subfacet_add_count;
 756     unsigned int subfacet_del_count;
 757
 758     /* Number of subfacets added or deleted from 'created' to 'last_minute.' */
 759     unsigned long long int total_subfacet_add_count;
 760     unsigned long long int total_subfacet_del_count;
 761
 762     /* Sum of the number of milliseconds that each subfacet existed,
 763      * over the subfacets that have been added and then later deleted. */
 764     unsigned long long int total_subfacet_life_span;
 765
 766     /* Incremented by the number of currently existing subfacets, each
 767      * time we pull statistics from the kernel. */
 768     unsigned long long int total_subfacet_count;
 769
 770     /* Number of times we pull statistics from the kernel. */
 771     unsigned long long int n_update_stats;
 772 };
 773 static unsigned long long int avg_subfacet_life_span(
 774                                         const struct ofproto_dpif *);
 775 static double avg_subfacet_count(const struct ofproto_dpif *ofproto);
 776 static void update_moving_averages(struct ofproto_dpif *ofproto);
 777 static void dpif_stats_update_hit_count(struct ofproto_dpif *ofproto,
 778                                         uint64_t delta);
 779 static void update_max_subfacet_count(struct ofproto_dpif *ofproto);
 780
 781 /* Defer flow mod completion until "ovs-appctl ofproto/unclog"?  (Useful only
 782  * for debugging the asynchronous flow_mod implementation.) */
 783 static bool clogged;
 784
 785 /* All existing ofproto_dpif instances, indexed by ->up.name. */
 786 static struct hmap all_ofproto_dpifs = HMAP_INITIALIZER(&all_ofproto_dpifs);
 787
 788 static void ofproto_dpif_unixctl_init(void);
 789
 790 static struct ofproto_dpif *
 791 ofproto_dpif_cast(const struct ofproto *ofproto)
 792 {
 793     ovs_assert(ofproto->ofproto_class == &ofproto_dpif_class);
 794     return CONTAINER_OF(ofproto, struct ofproto_dpif, up);
 795 }
 796
 797 static struct ofport_dpif *get_ofp_port(const struct ofproto_dpif *,
 798                                         uint16_t ofp_port);
 799 static struct ofport_dpif *get_odp_port(const struct ofproto_dpif *,
 800                                         uint32_t odp_port);
 801 static void ofproto_trace(struct ofproto_dpif *, const struct flow *,
 802                           const struct ofpbuf *,
 803                           const struct initial_vals *, struct ds *);
 804
 805 /* Packet processing. */
 806 static void update_learning_table(struct ofproto_dpif *,
 807                                   const struct flow *, int vlan,
 808                                   struct ofbundle *);
 809 /* Upcalls. */
 810 #define FLOW_MISS_MAX_BATCH 50
 811 static int handle_upcalls(struct dpif_backer *, unsigned int max_batch);
 812
 813 /* Flow expiration. */
 814 static int expire(struct dpif_backer *);
 815
 816 /* NetFlow. */
 817 static void send_netflow_active_timeouts(struct ofproto_dpif *);
 818
 819 /* Utilities. */
 820 static int send_packet(const struct ofport_dpif *, struct ofpbuf *packet);
 821 static size_t compose_sflow_action(const struct ofproto_dpif *,
 822                                    struct ofpbuf *odp_actions,
 823                                    const struct flow *, uint32_t odp_port);
 824 static void compose_ipfix_action(const struct ofproto_dpif *,
 825                                  struct ofpbuf *odp_actions,
 826                                  const struct flow *);
 827 static void add_mirror_actions(struct action_xlate_ctx *ctx,
 828                                const struct flow *flow);
 829 /* Global variables. */
 830 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
 831
 832 /* Initial mappings of port to bridge mappings. */
 833 static struct shash init_ofp_ports = SHASH_INITIALIZER(&init_ofp_ports);
 834 \f
 835 /* Factory functions. */
 836
 837 static void
 838 init(const struct shash *iface_hints)
 839 {
 840     struct shash_node *node;
 841
 842     /* Make a local copy, since we don't own 'iface_hints' elements. */
 843     SHASH_FOR_EACH(node, iface_hints) {
 844         const struct iface_hint *orig_hint = node->data;
 845         struct iface_hint *new_hint = xmalloc(sizeof *new_hint);
 846
 847         new_hint->br_name = xstrdup(orig_hint->br_name);
 848         new_hint->br_type = xstrdup(orig_hint->br_type);
 849         new_hint->ofp_port = orig_hint->ofp_port;
 850
 851         shash_add(&init_ofp_ports, node->name, new_hint);
 852     }
 853 }
 854
 855 static void
 856 enumerate_types(struct sset *types)
 857 {
 858     dp_enumerate_types(types);
 859 }
 860
 861 static int
 862 enumerate_names(const char *type, struct sset *names)
 863 {
 864     struct ofproto_dpif *ofproto;
 865
 866     sset_clear(names);
 867     HMAP_FOR_EACH (ofproto, all_ofproto_dpifs_node, &all_ofproto_dpifs) {
 868         if (strcmp(type, ofproto->up.type)) {
 869             continue;
 870         }
 871         sset_add(names, ofproto->up.name);
 872     }
 873
 874     return 0;
 875 }
 876
 877 static int
 878 del(const char *type, const char *name)
 879 {
 880     struct dpif *dpif;
 881     int error;
 882
 883     error = dpif_open(name, type, &dpif);
 884     if (!error) {
 885         error = dpif_delete(dpif);
 886         dpif_close(dpif);
 887     }
 888     return error;
 889 }
 890 \f
 891 static const char *
 892 port_open_type(const char *datapath_type, const char *port_type)
 893 {
 894     return dpif_port_open_type(datapath_type, port_type);
 895 }
 896
 897 /* Type functions. */
 898
 899 static struct ofproto_dpif *
 900 lookup_ofproto_dpif_by_port_name(const char *name)
 901 {
 902     struct ofproto_dpif *ofproto;
 903
 904     HMAP_FOR_EACH (ofproto, all_ofproto_dpifs_node, &all_ofproto_dpifs) {
 905         if (sset_contains(&ofproto->ports, name)) {
 906             return ofproto;
 907         }
 908     }
 909
 910     return NULL;
 911 }
 912
 913 static int
 914 type_run(const char *type)
 915 {
 916     static long long int push_timer = LLONG_MIN;
 917     struct dpif_backer *backer;
 918     char *devname;
 919     int error;
 920
 921     backer = shash_find_data(&all_dpif_backers, type);
 922     if (!backer) {
 923         /* This is not necessarily a problem, since backers are only
 924          * created on demand. */
 925         return 0;
 926     }
 927
 928     dpif_run(backer->dpif);
 929
 930     /* The most natural place to push facet statistics is when they're pulled
 931      * from the datapath.  However, when there are many flows in the datapath,
 932      * this expensive operation can occur so frequently, that it reduces our
 933      * ability to quickly set up flows.  To reduce the cost, we push statistics
 934      * here instead. */
 935     if (time_msec() > push_timer) {
 936         push_timer = time_msec() + 2000;
 937         push_all_stats();
 938     }
 939
 940     if (backer->need_revalidate
 941         || !tag_set_is_empty(&backer->revalidate_set)) {
 942         struct tag_set revalidate_set = backer->revalidate_set;
 943         bool need_revalidate = backer->need_revalidate;
 944         struct ofproto_dpif *ofproto;
 945         struct simap_node *node;
 946         struct simap tmp_backers;
 947
 948         /* Handle tunnel garbage collection. */
 949         simap_init(&tmp_backers);
 950         simap_swap(&backer->tnl_backers, &tmp_backers);
 951
 952         HMAP_FOR_EACH (ofproto, all_ofproto_dpifs_node, &all_ofproto_dpifs) {
 953             struct ofport_dpif *iter;
 954
 955             if (backer != ofproto->backer) {
 956                 continue;
 957             }
 958
 959             HMAP_FOR_EACH (iter, up.hmap_node, &ofproto->up.ports) {
 960                 const char *dp_port;
 961
 962                 if (!iter->tnl_port) {
 963                     continue;
 964                 }
 965
 966                 dp_port = netdev_vport_get_dpif_port(iter->up.netdev);
 967                 node = simap_find(&tmp_backers, dp_port);
 968                 if (node) {
 969                     simap_put(&backer->tnl_backers, dp_port, node->data);
 970                     simap_delete(&tmp_backers, node);
 971                     node = simap_find(&backer->tnl_backers, dp_port);
 972                 } else {
 973                     node = simap_find(&backer->tnl_backers, dp_port);
 974                     if (!node) {
 975                         uint32_t odp_port = UINT32_MAX;
 976
 977                         if (!dpif_port_add(backer->dpif, iter->up.netdev,
 978                                            &odp_port)) {
 979                             simap_put(&backer->tnl_backers, dp_port, odp_port);
 980                             node = simap_find(&backer->tnl_backers, dp_port);
 981                         }
 982                     }
 983                 }
 984
 985                 iter->odp_port = node ? node->data : OVSP_NONE;
 986                 if (tnl_port_reconfigure(&iter->up, iter->odp_port,
 987                                          &iter->tnl_port)) {
 988                     backer->need_revalidate = REV_RECONFIGURE;
 989                 }
 990             }
 991         }
 992
 993         SIMAP_FOR_EACH (node, &tmp_backers) {
 994             dpif_port_del(backer->dpif, node->data);
 995         }
 996         simap_destroy(&tmp_backers);
 997
 998         switch (backer->need_revalidate) {
 999         case REV_RECONFIGURE:   COVERAGE_INC(rev_reconfigure);   break;
1000         case REV_STP:           COVERAGE_INC(rev_stp);           break;
1001         case REV_PORT_TOGGLED:  COVERAGE_INC(rev_port_toggled);  break;
1002         case REV_FLOW_TABLE:    COVERAGE_INC(rev_flow_table);    break;
1003         case REV_INCONSISTENCY: COVERAGE_INC(rev_inconsistency); break;
1004         }
1005
1006         if (backer->need_revalidate) {
1007             /* Clear the drop_keys in case we should now be accepting some
1008              * formerly dropped flows. */
1009             drop_key_clear(backer);
1010         }
1011
1012         /* Clear the revalidation flags. */
1013         tag_set_init(&backer->revalidate_set);
1014         backer->need_revalidate = 0;
1015
1016         HMAP_FOR_EACH (ofproto, all_ofproto_dpifs_node, &all_ofproto_dpifs) {
1017             struct facet *facet, *next;
1018
1019             if (ofproto->backer != backer) {
1020                 continue;
1021             }
1022
1023             HMAP_FOR_EACH_SAFE (facet, next, hmap_node, &ofproto->facets) {
1024                 if (need_revalidate
1025                     || tag_set_intersects(&revalidate_set, facet->tags)) {
1026                     facet_revalidate(facet);
1027                     run_fast_rl();
1028                 }
1029             }
1030         }
1031     }
1032
1033     if (timer_expired(&backer->next_expiration)) {
1034         int delay = expire(backer);
1035         timer_set_duration(&backer->next_expiration, delay);
1036     }
1037
1038     /* Check for port changes in the dpif. */
1039     while ((error = dpif_port_poll(backer->dpif, &devname)) == 0) {
1040         struct ofproto_dpif *ofproto;
1041         struct dpif_port port;
1042
1043         /* Don't report on the datapath's device. */
1044         if (!strcmp(devname, dpif_base_name(backer->dpif))) {
1045             goto next;
1046         }
1047
1048         HMAP_FOR_EACH (ofproto, all_ofproto_dpifs_node,
1049                        &all_ofproto_dpifs) {
1050             if (simap_contains(&ofproto->backer->tnl_backers, devname)) {
1051                 goto next;
1052             }
1053         }
1054
1055         ofproto = lookup_ofproto_dpif_by_port_name(devname);
1056         if (dpif_port_query_by_name(backer->dpif, devname, &port)) {
1057             /* The port was removed.  If we know the datapath,
1058              * report it through poll_set().  If we don't, it may be
1059              * notifying us of a removal we initiated, so ignore it.
1060              * If there's a pending ENOBUFS, let it stand, since
1061              * everything will be reevaluated. */
1062             if (ofproto && ofproto->port_poll_errno != ENOBUFS) {
1063                 sset_add(&ofproto->port_poll_set, devname);
1064                 ofproto->port_poll_errno = 0;
1065             }
1066         } else if (!ofproto) {
1067             /* The port was added, but we don't know with which
1068              * ofproto we should associate it.  Delete it. */
1069             dpif_port_del(backer->dpif, port.port_no);
1070         }
1071         dpif_port_destroy(&port);
1072
1073     next:
1074         free(devname);
1075     }
1076
1077     if (error != EAGAIN) {
1078         struct ofproto_dpif *ofproto;
1079
1080         /* There was some sort of error, so propagate it to all
1081          * ofprotos that use this backer. */
1082         HMAP_FOR_EACH (ofproto, all_ofproto_dpifs_node,
1083                        &all_ofproto_dpifs) {
1084             if (ofproto->backer == backer) {
1085                 sset_clear(&ofproto->port_poll_set);
1086                 ofproto->port_poll_errno = error;
1087             }
1088         }
1089     }
1090
1091     return 0;
1092 }
1093
1094 static int
1095 dpif_backer_run_fast(struct dpif_backer *backer, int max_batch)
1096 {
1097     unsigned int work;
1098
1099     /* Handle one or more batches of upcalls, until there's nothing left to do
1100      * or until we do a fixed total amount of work.
1101      *
1102      * We do work in batches because it can be much cheaper to set up a number
1103      * of flows and fire off their patches all at once.  We do multiple batches
1104      * because in some cases handling a packet can cause another packet to be
1105      * queued almost immediately as part of the return flow.  Both
1106      * optimizations can make major improvements on some benchmarks and
1107      * presumably for real traffic as well. */
1108     work = 0;
1109     while (work < max_batch) {
1110         int retval = handle_upcalls(backer, max_batch - work);
1111         if (retval <= 0) {
1112             return -retval;
1113         }
1114         work += retval;
1115     }
1116
1117     return 0;
1118 }
1119
1120 static int
1121 type_run_fast(const char *type)
1122 {
1123     struct dpif_backer *backer;
1124
1125     backer = shash_find_data(&all_dpif_backers, type);
1126     if (!backer) {
1127         /* This is not necessarily a problem, since backers are only
1128          * created on demand. */
1129         return 0;
1130     }
1131
1132     return dpif_backer_run_fast(backer, FLOW_MISS_MAX_BATCH);
1133 }
1134
1135 static void
1136 run_fast_rl(void)
1137 {
1138     static long long int port_rl = LLONG_MIN;
1139     static unsigned int backer_rl = 0;
1140
1141     if (time_msec() >= port_rl) {
1142         struct ofproto_dpif *ofproto;
1143         struct ofport_dpif *ofport;
1144
1145         HMAP_FOR_EACH (ofproto, all_ofproto_dpifs_node, &all_ofproto_dpifs) {
1146
1147             HMAP_FOR_EACH (ofport, up.hmap_node, &ofproto->up.ports) {
1148                 port_run_fast(ofport);
1149             }
1150         }
1151         port_rl = time_msec() + 200;
1152     }
1153
1154     /* XXX: We have to be careful not to do too much work in this function.  If
1155      * we call dpif_backer_run_fast() too often, or with too large a batch,
1156      * performance improves signifcantly, but at a cost.  It's possible for the
1157      * number of flows in the datapath to increase without bound, and for poll
1158      * loops to take 10s of seconds.   The correct solution to this problem,
1159      * long term, is to separate flow miss handling into it's own thread so it
1160      * isn't affected by revalidations, and expirations.  Until then, this is
1161      * the best we can do. */
1162     if (++backer_rl >= 10) {
1163         struct shash_node *node;
1164
1165         backer_rl = 0;
1166         SHASH_FOR_EACH (node, &all_dpif_backers) {
1167             dpif_backer_run_fast(node->data, 1);
1168         }
1169     }
1170 }
1171
1172 static void
1173 type_wait(const char *type)
1174 {
1175     struct dpif_backer *backer;
1176
1177     backer = shash_find_data(&all_dpif_backers, type);
1178     if (!backer) {
1179         /* This is not necessarily a problem, since backers are only
1180          * created on demand. */
1181         return;
1182     }
1183
1184     timer_wait(&backer->next_expiration);
1185 }
1186 \f
1187 /* Basic life-cycle. */
1188
1189 static int add_internal_flows(struct ofproto_dpif *);
1190
1191 static struct ofproto *
1192 alloc(void)
1193 {
1194     struct ofproto_dpif *ofproto = xmalloc(sizeof *ofproto);
1195     return &ofproto->up;
1196 }
1197
1198 static void
1199 dealloc(struct ofproto *ofproto_)
1200 {
1201     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
1202     free(ofproto);
1203 }
1204
1205 static void
1206 close_dpif_backer(struct dpif_backer *backer)
1207 {
1208     struct shash_node *node;
1209
1210     ovs_assert(backer->refcount > 0);
1211
1212     if (--backer->refcount) {
1213         return;
1214     }
1215
1216     drop_key_clear(backer);
1217     hmap_destroy(&backer->drop_keys);
1218
1219     simap_destroy(&backer->tnl_backers);
1220     hmap_destroy(&backer->odp_to_ofport_map);
1221     node = shash_find(&all_dpif_backers, backer->type);
1222     free(backer->type);
1223     shash_delete(&all_dpif_backers, node);
1224     dpif_close(backer->dpif);
1225
1226     free(backer);
1227 }
1228
1229 /* Datapath port slated for removal from datapath. */
1230 struct odp_garbage {
1231     struct list list_node;
1232     uint32_t odp_port;
1233 };
1234
1235 static int
1236 open_dpif_backer(const char *type, struct dpif_backer **backerp)
1237 {
1238     struct dpif_backer *backer;
1239     struct dpif_port_dump port_dump;
1240     struct dpif_port port;
1241     struct shash_node *node;
1242     struct list garbage_list;
1243     struct odp_garbage *garbage, *next;
1244     struct sset names;
1245     char *backer_name;
1246     const char *name;
1247     int error;
1248
1249     backer = shash_find_data(&all_dpif_backers, type);
1250     if (backer) {
1251         backer->refcount++;
1252         *backerp = backer;
1253         return 0;
1254     }
1255
1256     backer_name = xasprintf("ovs-%s", type);
1257
1258     /* Remove any existing datapaths, since we assume we're the only
1259      * userspace controlling the datapath. */
1260     sset_init(&names);
1261     dp_enumerate_names(type, &names);
1262     SSET_FOR_EACH(name, &names) {
1263         struct dpif *old_dpif;
1264
1265         /* Don't remove our backer if it exists. */
1266         if (!strcmp(name, backer_name)) {
1267             continue;
1268         }
1269
1270         if (dpif_open(name, type, &old_dpif)) {
1271             VLOG_WARN("couldn't open old datapath %s to remove it", name);
1272         } else {
1273             dpif_delete(old_dpif);
1274             dpif_close(old_dpif);
1275         }
1276     }
1277     sset_destroy(&names);
1278
1279     backer = xmalloc(sizeof *backer);
1280
1281     error = dpif_create_and_open(backer_name, type, &backer->dpif);
1282     free(backer_name);
1283     if (error) {
1284         VLOG_ERR("failed to open datapath of type %s: %s", type,
1285                  strerror(error));
1286         free(backer);
1287         return error;
1288     }
1289
1290     backer->type = xstrdup(type);
1291     backer->refcount = 1;
1292     hmap_init(&backer->odp_to_ofport_map);
1293     hmap_init(&backer->drop_keys);
1294     timer_set_duration(&backer->next_expiration, 1000);
1295     backer->need_revalidate = 0;
1296     simap_init(&backer->tnl_backers);
1297     tag_set_init(&backer->revalidate_set);
1298     *backerp = backer;
1299
1300     dpif_flow_flush(backer->dpif);
1301
1302     /* Loop through the ports already on the datapath and remove any
1303      * that we don't need anymore. */
1304     list_init(&garbage_list);
1305     dpif_port_dump_start(&port_dump, backer->dpif);
1306     while (dpif_port_dump_next(&port_dump, &port)) {
1307         node = shash_find(&init_ofp_ports, port.name);
1308         if (!node && strcmp(port.name, dpif_base_name(backer->dpif))) {
1309             garbage = xmalloc(sizeof *garbage);
1310             garbage->odp_port = port.port_no;
1311             list_push_front(&garbage_list, &garbage->list_node);
1312         }
1313     }
1314     dpif_port_dump_done(&port_dump);
1315
1316     LIST_FOR_EACH_SAFE (garbage, next, list_node, &garbage_list) {
1317         dpif_port_del(backer->dpif, garbage->odp_port);
1318         list_remove(&garbage->list_node);
1319         free(garbage);
1320     }
1321
1322     shash_add(&all_dpif_backers, type, backer);
1323
1324     error = dpif_recv_set(backer->dpif, true);
1325     if (error) {
1326         VLOG_ERR("failed to listen on datapath of type %s: %s",
1327                  type, strerror(error));
1328         close_dpif_backer(backer);
1329         return error;
1330     }
1331
1332     return error;
1333 }
1334
1335 static int
1336 construct(struct ofproto *ofproto_)
1337 {
1338     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
1339     struct shash_node *node, *next;
1340     int max_ports;
1341     int error;
1342     int i;
1343
1344     error = open_dpif_backer(ofproto->up.type, &ofproto->backer);
1345     if (error) {
1346         return error;
1347     }
1348
1349     max_ports = dpif_get_max_ports(ofproto->backer->dpif);
1350     ofproto_init_max_ports(ofproto_, MIN(max_ports, OFPP_MAX));
1351
1352     ofproto->n_matches = 0;
1353
1354     ofproto->netflow = NULL;
1355     ofproto->sflow = NULL;
1356     ofproto->ipfix = NULL;
1357     ofproto->stp = NULL;
1358     hmap_init(&ofproto->bundles);
1359     ofproto->ml = mac_learning_create(MAC_ENTRY_DEFAULT_IDLE_TIME);
1360     for (i = 0; i < MAX_MIRRORS; i++) {
1361         ofproto->mirrors[i] = NULL;
1362     }
1363     ofproto->has_bonded_bundles = false;
1364
1365     hmap_init(&ofproto->facets);
1366     hmap_init(&ofproto->subfacets);
1367     ofproto->governor = NULL;
1368     ofproto->consistency_rl = LLONG_MIN;
1369
1370     for (i = 0; i < N_TABLES; i++) {
1371         struct table_dpif *table = &ofproto->tables[i];
1372
1373         table->catchall_table = NULL;
1374         table->other_table = NULL;
1375         table->basis = random_uint32();
1376     }
1377
1378     list_init(&ofproto->completions);
1379
1380     ofproto_dpif_unixctl_init();
1381
1382     ofproto->has_mirrors = false;
1383     ofproto->has_bundle_action = false;
1384
1385     hmap_init(&ofproto->vlandev_map);
1386     hmap_init(&ofproto->realdev_vid_map);
1387
1388     sset_init(&ofproto->ports);
1389     sset_init(&ofproto->ghost_ports);
1390     sset_init(&ofproto->port_poll_set);
1391     ofproto->port_poll_errno = 0;
1392
1393     SHASH_FOR_EACH_SAFE (node, next, &init_ofp_ports) {
1394         struct iface_hint *iface_hint = node->data;
1395
1396         if (!strcmp(iface_hint->br_name, ofproto->up.name)) {
1397             /* Check if the datapath already has this port. */
1398             if (dpif_port_exists(ofproto->backer->dpif, node->name)) {
1399                 sset_add(&ofproto->ports, node->name);
1400             }
1401
1402             free(iface_hint->br_name);
1403             free(iface_hint->br_type);
1404             free(iface_hint);
1405             shash_delete(&init_ofp_ports, node);
1406         }
1407     }
1408
1409     hmap_insert(&all_ofproto_dpifs, &ofproto->all_ofproto_dpifs_node,
1410                 hash_string(ofproto->up.name, 0));
1411     memset(&ofproto->stats, 0, sizeof ofproto->stats);
1412
1413     ofproto_init_tables(ofproto_, N_TABLES);
1414     error = add_internal_flows(ofproto);
1415     ofproto->up.tables[TBL_INTERNAL].flags = OFTABLE_HIDDEN | OFTABLE_READONLY;
1416
1417     ofproto->n_hit = 0;
1418     ofproto->n_missed = 0;
1419
1420     ofproto->max_n_subfacet = 0;
1421     ofproto->created = time_msec();
1422     ofproto->last_minute = ofproto->created;
1423     memset(&ofproto->hourly, 0, sizeof ofproto->hourly);
1424     memset(&ofproto->daily, 0, sizeof ofproto->daily);
1425     ofproto->subfacet_add_count = 0;
1426     ofproto->subfacet_del_count = 0;
1427     ofproto->total_subfacet_add_count = 0;
1428     ofproto->total_subfacet_del_count = 0;
1429     ofproto->total_subfacet_life_span = 0;
1430     ofproto->total_subfacet_count = 0;
1431     ofproto->n_update_stats = 0;
1432
1433     return error;
1434 }
1435
1436 static int
1437 add_internal_flow(struct ofproto_dpif *ofproto, int id,
1438                   const struct ofpbuf *ofpacts, struct rule_dpif **rulep)
1439 {
1440     struct ofputil_flow_mod fm;
1441     int error;
1442
1443     match_init_catchall(&fm.match);
1444     fm.priority = 0;
1445     match_set_reg(&fm.match, 0, id);
1446     fm.new_cookie = htonll(0);
1447     fm.cookie = htonll(0);
1448     fm.cookie_mask = htonll(0);
1449     fm.table_id = TBL_INTERNAL;
1450     fm.command = OFPFC_ADD;
1451     fm.idle_timeout = 0;
1452     fm.hard_timeout = 0;
1453     fm.buffer_id = 0;
1454     fm.out_port = 0;
1455     fm.flags = 0;
1456     fm.ofpacts = ofpacts->data;
1457     fm.ofpacts_len = ofpacts->size;
1458
1459     error = ofproto_flow_mod(&ofproto->up, &fm);
1460     if (error) {
1461         VLOG_ERR_RL(&rl, "failed to add internal flow %d (%s)",
1462                     id, ofperr_to_string(error));
1463         return error;
1464     }
1465
1466     *rulep = rule_dpif_lookup__(ofproto, &fm.match.flow, TBL_INTERNAL);
1467     ovs_assert(*rulep != NULL);
1468
1469     return 0;
1470 }
1471
1472 static int
1473 add_internal_flows(struct ofproto_dpif *ofproto)
1474 {
1475     struct ofpact_controller *controller;
1476     uint64_t ofpacts_stub[128 / 8];
1477     struct ofpbuf ofpacts;
1478     int error;
1479     int id;
1480
1481     ofpbuf_use_stack(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
1482     id = 1;
1483
1484     controller = ofpact_put_CONTROLLER(&ofpacts);
1485     controller->max_len = UINT16_MAX;
1486     controller->controller_id = 0;
1487     controller->reason = OFPR_NO_MATCH;
1488     ofpact_pad(&ofpacts);
1489
1490     error = add_internal_flow(ofproto, id++, &ofpacts, &ofproto->miss_rule);
1491     if (error) {
1492         return error;
1493     }
1494
1495     ofpbuf_clear(&ofpacts);
1496     error = add_internal_flow(ofproto, id++, &ofpacts,
1497                               &ofproto->no_packet_in_rule);
1498     return error;
1499 }
1500
1501 static void
1502 complete_operations(struct ofproto_dpif *ofproto)
1503 {
1504     struct dpif_completion *c, *next;
1505
1506     LIST_FOR_EACH_SAFE (c, next, list_node, &ofproto->completions) {
1507         ofoperation_complete(c->op, 0);
1508         list_remove(&c->list_node);
1509         free(c);
1510     }
1511 }
1512
1513 static void
1514 destruct(struct ofproto *ofproto_)
1515 {
1516     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
1517     struct rule_dpif *rule, *next_rule;
1518     struct oftable *table;
1519     int i;
1520
1521     hmap_remove(&all_ofproto_dpifs, &ofproto->all_ofproto_dpifs_node);
1522     complete_operations(ofproto);
1523
1524     OFPROTO_FOR_EACH_TABLE (table, &ofproto->up) {
1525         struct cls_cursor cursor;
1526
1527         cls_cursor_init(&cursor, &table->cls, NULL);
1528         CLS_CURSOR_FOR_EACH_SAFE (rule, next_rule, up.cr, &cursor) {
1529             ofproto_rule_destroy(&rule->up);
1530         }
1531     }
1532
1533     for (i = 0; i < MAX_MIRRORS; i++) {
1534         mirror_destroy(ofproto->mirrors[i]);
1535     }
1536
1537     netflow_destroy(ofproto->netflow);
1538     dpif_sflow_destroy(ofproto->sflow);
1539     hmap_destroy(&ofproto->bundles);
1540     mac_learning_destroy(ofproto->ml);
1541
1542     hmap_destroy(&ofproto->facets);
1543     hmap_destroy(&ofproto->subfacets);
1544     governor_destroy(ofproto->governor);
1545
1546     hmap_destroy(&ofproto->vlandev_map);
1547     hmap_destroy(&ofproto->realdev_vid_map);
1548
1549     sset_destroy(&ofproto->ports);
1550     sset_destroy(&ofproto->ghost_ports);
1551     sset_destroy(&ofproto->port_poll_set);
1552
1553     close_dpif_backer(ofproto->backer);
1554 }
1555
1556 static int
1557 run_fast(struct ofproto *ofproto_)
1558 {
1559     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
1560     struct ofport_dpif *ofport;
1561
1562     HMAP_FOR_EACH (ofport, up.hmap_node, &ofproto->up.ports) {
1563         port_run_fast(ofport);
1564     }
1565
1566     return 0;
1567 }
1568
1569 static int
1570 run(struct ofproto *ofproto_)
1571 {
1572     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
1573     struct ofport_dpif *ofport;
1574     struct ofbundle *bundle;
1575     int error;
1576
1577     if (!clogged) {
1578         complete_operations(ofproto);
1579     }
1580
1581     error = run_fast(ofproto_);
1582     if (error) {
1583         return error;
1584     }
1585
1586     if (ofproto->netflow) {
1587         if (netflow_run(ofproto->netflow)) {
1588             send_netflow_active_timeouts(ofproto);
1589         }
1590     }
1591     if (ofproto->sflow) {
1592         dpif_sflow_run(ofproto->sflow);
1593     }
1594
1595     HMAP_FOR_EACH (ofport, up.hmap_node, &ofproto->up.ports) {
1596         port_run(ofport);
1597     }
1598     HMAP_FOR_EACH (bundle, hmap_node, &ofproto->bundles) {
1599         bundle_run(bundle);
1600     }
1601
1602     stp_run(ofproto);
1603     mac_learning_run(ofproto->ml, &ofproto->backer->revalidate_set);
1604
1605     /* Check the consistency of a random facet, to aid debugging. */
1606     if (time_msec() >= ofproto->consistency_rl
1607         && !hmap_is_empty(&ofproto->facets)
1608         && !ofproto->backer->need_revalidate) {
1609         struct facet *facet;
1610
1611         ofproto->consistency_rl = time_msec() + 250;
1612
1613         facet = CONTAINER_OF(hmap_random_node(&ofproto->facets),
1614                              struct facet, hmap_node);
1615         if (!tag_set_intersects(&ofproto->backer->revalidate_set,
1616                                 facet->tags)) {
1617             if (!facet_check_consistency(facet)) {
1618                 ofproto->backer->need_revalidate = REV_INCONSISTENCY;
1619             }
1620         }
1621     }
1622
1623     if (ofproto->governor) {
1624         size_t n_subfacets;
1625
1626         governor_run(ofproto->governor);
1627
1628         /* If the governor has shrunk to its minimum size and the number of
1629          * subfacets has dwindled, then drop the governor entirely.
1630          *
1631          * For hysteresis, the number of subfacets to drop the governor is
1632          * smaller than the number needed to trigger its creation. */
1633         n_subfacets = hmap_count(&ofproto->subfacets);
1634         if (n_subfacets * 4 < ofproto->up.flow_eviction_threshold
1635             && governor_is_idle(ofproto->governor)) {
1636             governor_destroy(ofproto->governor);
1637             ofproto->governor = NULL;
1638         }
1639     }
1640
1641     return 0;
1642 }
1643
1644 static void
1645 wait(struct ofproto *ofproto_)
1646 {
1647     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
1648     struct ofport_dpif *ofport;
1649     struct ofbundle *bundle;
1650
1651     if (!clogged && !list_is_empty(&ofproto->completions)) {
1652         poll_immediate_wake();
1653     }
1654
1655     dpif_wait(ofproto->backer->dpif);
1656     dpif_recv_wait(ofproto->backer->dpif);
1657     if (ofproto->sflow) {
1658         dpif_sflow_wait(ofproto->sflow);
1659     }
1660     if (!tag_set_is_empty(&ofproto->backer->revalidate_set)) {
1661         poll_immediate_wake();
1662     }
1663     HMAP_FOR_EACH (ofport, up.hmap_node, &ofproto->up.ports) {
1664         port_wait(ofport);
1665     }
1666     HMAP_FOR_EACH (bundle, hmap_node, &ofproto->bundles) {
1667         bundle_wait(bundle);
1668     }
1669     if (ofproto->netflow) {
1670         netflow_wait(ofproto->netflow);
1671     }
1672     mac_learning_wait(ofproto->ml);
1673     stp_wait(ofproto);
1674     if (ofproto->backer->need_revalidate) {
1675         /* Shouldn't happen, but if it does just go around again. */
1676         VLOG_DBG_RL(&rl, "need revalidate in ofproto_wait_cb()");
1677         poll_immediate_wake();
1678     }
1679     if (ofproto->governor) {
1680         governor_wait(ofproto->governor);
1681     }
1682 }
1683
1684 static void
1685 get_memory_usage(const struct ofproto *ofproto_, struct simap *usage)
1686 {
1687     const struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
1688
1689     simap_increase(usage, "facets", hmap_count(&ofproto->facets));
1690     simap_increase(usage, "subfacets", hmap_count(&ofproto->subfacets));
1691 }
1692
1693 static void
1694 flush(struct ofproto *ofproto_)
1695 {
1696     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
1697     struct subfacet *subfacet, *next_subfacet;
1698     struct subfacet *batch[SUBFACET_DESTROY_MAX_BATCH];
1699     int n_batch;
1700
1701     n_batch = 0;
1702     HMAP_FOR_EACH_SAFE (subfacet, next_subfacet, hmap_node,
1703                         &ofproto->subfacets) {
1704         if (subfacet->path != SF_NOT_INSTALLED) {
1705             batch[n_batch++] = subfacet;
1706             if (n_batch >= SUBFACET_DESTROY_MAX_BATCH) {
1707                 subfacet_destroy_batch(ofproto, batch, n_batch);
1708                 n_batch = 0;
1709             }
1710         } else {
1711             subfacet_destroy(subfacet);
1712         }
1713     }
1714
1715     if (n_batch > 0) {
1716         subfacet_destroy_batch(ofproto, batch, n_batch);
1717     }
1718 }
1719
1720 static void
1721 get_features(struct ofproto *ofproto_ OVS_UNUSED,
1722              bool *arp_match_ip, enum ofputil_action_bitmap *actions)
1723 {
1724     *arp_match_ip = true;
1725     *actions = (OFPUTIL_A_OUTPUT |
1726                 OFPUTIL_A_SET_VLAN_VID |
1727                 OFPUTIL_A_SET_VLAN_PCP |
1728                 OFPUTIL_A_STRIP_VLAN |
1729                 OFPUTIL_A_SET_DL_SRC |
1730                 OFPUTIL_A_SET_DL_DST |
1731                 OFPUTIL_A_SET_NW_SRC |
1732                 OFPUTIL_A_SET_NW_DST |
1733                 OFPUTIL_A_SET_NW_TOS |
1734                 OFPUTIL_A_SET_TP_SRC |
1735                 OFPUTIL_A_SET_TP_DST |
1736                 OFPUTIL_A_ENQUEUE);
1737 }
1738
1739 static void
1740 get_tables(struct ofproto *ofproto_, struct ofp12_table_stats *ots)
1741 {
1742     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
1743     struct dpif_dp_stats s;
1744
1745     strcpy(ots->name, "classifier");
1746
1747     dpif_get_dp_stats(ofproto->backer->dpif, &s);
1748
1749     ots->lookup_count = htonll(s.n_hit + s.n_missed);
1750     ots->matched_count = htonll(s.n_hit + ofproto->n_matches);
1751 }
1752
1753 static struct ofport *
1754 port_alloc(void)
1755 {
1756     struct ofport_dpif *port = xmalloc(sizeof *port);
1757     return &port->up;
1758 }
1759
1760 static void
1761 port_dealloc(struct ofport *port_)
1762 {
1763     struct ofport_dpif *port = ofport_dpif_cast(port_);
1764     free(port);
1765 }
1766
1767 static int
1768 port_construct(struct ofport *port_)
1769 {
1770     struct ofport_dpif *port = ofport_dpif_cast(port_);
1771     struct ofproto_dpif *ofproto = ofproto_dpif_cast(port->up.ofproto);
1772     const struct netdev *netdev = port->up.netdev;
1773     struct dpif_port dpif_port;
1774     int error;
1775
1776     ofproto->backer->need_revalidate = REV_RECONFIGURE;
1777     port->bundle = NULL;
1778     port->cfm = NULL;
1779     port->bfd = NULL;
1780     port->tag = tag_create_random();
1781     port->may_enable = true;
1782     port->stp_port = NULL;
1783     port->stp_state = STP_DISABLED;
1784     port->tnl_port = NULL;
1785     hmap_init(&port->priorities);
1786     port->realdev_ofp_port = 0;
1787     port->vlandev_vid = 0;
1788     port->carrier_seq = netdev_get_carrier_resets(netdev);
1789
1790     if (netdev_vport_is_patch(netdev)) {
1791         /* By bailing out here, we don't submit the port to the sFlow module
1792          * to be considered for counter polling export.  This is correct
1793          * because the patch port represents an interface that sFlow considers
1794          * to be "internal" to the switch as a whole, and therefore not an
1795          * candidate for counter polling. */
1796         port->odp_port = OVSP_NONE;
1797         return 0;
1798     }
1799
1800     error = dpif_port_query_by_name(ofproto->backer->dpif,
1801                                     netdev_vport_get_dpif_port(netdev),
1802                                     &dpif_port);
1803     if (error) {
1804         return error;
1805     }
1806
1807     port->odp_port = dpif_port.port_no;
1808
1809     if (netdev_get_tunnel_config(netdev)) {
1810         port->tnl_port = tnl_port_add(&port->up, port->odp_port);
1811     } else {
1812         /* Sanity-check that a mapping doesn't already exist.  This
1813          * shouldn't happen for non-tunnel ports. */
1814         if (odp_port_to_ofp_port(ofproto, port->odp_port) != OFPP_NONE) {
1815             VLOG_ERR("port %s already has an OpenFlow port number",
1816                      dpif_port.name);
1817             dpif_port_destroy(&dpif_port);
1818             return EBUSY;
1819         }
1820
1821         hmap_insert(&ofproto->backer->odp_to_ofport_map, &port->odp_port_node,
1822                     hash_int(port->odp_port, 0));
1823     }
1824     dpif_port_destroy(&dpif_port);
1825
1826     if (ofproto->sflow) {
1827         dpif_sflow_add_port(ofproto->sflow, port_, port->odp_port);
1828     }
1829
1830     return 0;
1831 }
1832
1833 static void
1834 port_destruct(struct ofport *port_)
1835 {
1836     struct ofport_dpif *port = ofport_dpif_cast(port_);
1837     struct ofproto_dpif *ofproto = ofproto_dpif_cast(port->up.ofproto);
1838     const char *dp_port_name = netdev_vport_get_dpif_port(port->up.netdev);
1839     const char *devname = netdev_get_name(port->up.netdev);
1840
1841     if (dpif_port_exists(ofproto->backer->dpif, dp_port_name)) {
1842         /* The underlying device is still there, so delete it.  This
1843          * happens when the ofproto is being destroyed, since the caller
1844          * assumes that removal of attached ports will happen as part of
1845          * destruction. */
1846         if (!port->tnl_port) {
1847             dpif_port_del(ofproto->backer->dpif, port->odp_port);
1848         }
1849         ofproto->backer->need_revalidate = REV_RECONFIGURE;
1850     }
1851
1852     if (port->odp_port != OVSP_NONE && !port->tnl_port) {
1853         hmap_remove(&ofproto->backer->odp_to_ofport_map, &port->odp_port_node);
1854     }
1855
1856     tnl_port_del(port->tnl_port);
1857     sset_find_and_delete(&ofproto->ports, devname);
1858     sset_find_and_delete(&ofproto->ghost_ports, devname);
1859     ofproto->backer->need_revalidate = REV_RECONFIGURE;
1860     bundle_remove(port_);
1861     set_cfm(port_, NULL);
1862     if (ofproto->sflow) {
1863         dpif_sflow_del_port(ofproto->sflow, port->odp_port);
1864     }
1865
1866     ofport_clear_priorities(port);
1867     hmap_destroy(&port->priorities);
1868 }
1869
1870 static void
1871 port_modified(struct ofport *port_)
1872 {
1873     struct ofport_dpif *port = ofport_dpif_cast(port_);
1874
1875     if (port->bundle && port->bundle->bond) {
1876         bond_slave_set_netdev(port->bundle->bond, port, port->up.netdev);
1877     }
1878 }
1879
1880 static void
1881 port_reconfigured(struct ofport *port_, enum ofputil_port_config old_config)
1882 {
1883     struct ofport_dpif *port = ofport_dpif_cast(port_);
1884     struct ofproto_dpif *ofproto = ofproto_dpif_cast(port->up.ofproto);
1885     enum ofputil_port_config changed = old_config ^ port->up.pp.config;
1886
1887     if (changed & (OFPUTIL_PC_NO_RECV | OFPUTIL_PC_NO_RECV_STP |
1888                    OFPUTIL_PC_NO_FWD | OFPUTIL_PC_NO_FLOOD |
1889                    OFPUTIL_PC_NO_PACKET_IN)) {
1890         ofproto->backer->need_revalidate = REV_RECONFIGURE;
1891
1892         if (changed & OFPUTIL_PC_NO_FLOOD && port->bundle) {
1893             bundle_update(port->bundle);
1894         }
1895     }
1896 }
1897
1898 static int
1899 set_sflow(struct ofproto *ofproto_,
1900           const struct ofproto_sflow_options *sflow_options)
1901 {
1902     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
1903     struct dpif_sflow *ds = ofproto->sflow;
1904
1905     if (sflow_options) {
1906         if (!ds) {
1907             struct ofport_dpif *ofport;
1908
1909             ds = ofproto->sflow = dpif_sflow_create();
1910             HMAP_FOR_EACH (ofport, up.hmap_node, &ofproto->up.ports) {
1911                 dpif_sflow_add_port(ds, &ofport->up, ofport->odp_port);
1912             }
1913             ofproto->backer->need_revalidate = REV_RECONFIGURE;
1914         }
1915         dpif_sflow_set_options(ds, sflow_options);
1916     } else {
1917         if (ds) {
1918             dpif_sflow_destroy(ds);
1919             ofproto->backer->need_revalidate = REV_RECONFIGURE;
1920             ofproto->sflow = NULL;
1921         }
1922     }
1923     return 0;
1924 }
1925
1926 static int
1927 set_ipfix(
1928     struct ofproto *ofproto_,
1929     const struct ofproto_ipfix_bridge_exporter_options *bridge_exporter_options,
1930     const struct ofproto_ipfix_flow_exporter_options *flow_exporters_options,
1931     size_t n_flow_exporters_options)
1932 {
1933     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
1934     struct dpif_ipfix *di = ofproto->ipfix;
1935
1936     if (bridge_exporter_options || flow_exporters_options) {
1937         if (!di) {
1938             di = ofproto->ipfix = dpif_ipfix_create();
1939         }
1940         dpif_ipfix_set_options(
1941             di, bridge_exporter_options, flow_exporters_options,
1942             n_flow_exporters_options);
1943     } else {
1944         if (di) {
1945             dpif_ipfix_destroy(di);
1946             ofproto->ipfix = NULL;
1947         }
1948     }
1949     return 0;
1950 }
1951
1952 static int
1953 set_cfm(struct ofport *ofport_, const struct cfm_settings *s)
1954 {
1955     struct ofport_dpif *ofport = ofport_dpif_cast(ofport_);
1956     int error;
1957
1958     if (!s) {
1959         error = 0;
1960     } else {
1961         if (!ofport->cfm) {
1962             struct ofproto_dpif *ofproto;
1963
1964             ofproto = ofproto_dpif_cast(ofport->up.ofproto);
1965             ofproto->backer->need_revalidate = REV_RECONFIGURE;
1966             ofport->cfm = cfm_create(netdev_get_name(ofport->up.netdev));
1967         }
1968
1969         if (cfm_configure(ofport->cfm, s)) {
1970             return 0;
1971         }
1972
1973         error = EINVAL;
1974     }
1975     cfm_destroy(ofport->cfm);
1976     ofport->cfm = NULL;
1977     return error;
1978 }
1979
1980 static bool
1981 get_cfm_status(const struct ofport *ofport_,
1982                struct ofproto_cfm_status *status)
1983 {
1984     struct ofport_dpif *ofport = ofport_dpif_cast(ofport_);
1985
1986     if (ofport->cfm) {
1987         status->faults = cfm_get_fault(ofport->cfm);
1988         status->remote_opstate = cfm_get_opup(ofport->cfm);
1989         status->health = cfm_get_health(ofport->cfm);
1990         cfm_get_remote_mpids(ofport->cfm, &status->rmps, &status->n_rmps);
1991         return true;
1992     } else {
1993         return false;
1994     }
1995 }
1996
1997 static int
1998 set_bfd(struct ofport *ofport_, const struct smap *cfg)
1999 {
2000     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofport_->ofproto);
2001     struct ofport_dpif *ofport = ofport_dpif_cast(ofport_);
2002     struct bfd *old;
2003
2004     old = ofport->bfd;
2005     ofport->bfd = bfd_configure(old, netdev_get_name(ofport->up.netdev), cfg);
2006     if (ofport->bfd != old) {
2007         ofproto->backer->need_revalidate = REV_RECONFIGURE;
2008     }
2009
2010     return 0;
2011 }
2012
2013 static int
2014 get_bfd_status(struct ofport *ofport_, struct smap *smap)
2015 {
2016     struct ofport_dpif *ofport = ofport_dpif_cast(ofport_);
2017
2018     if (ofport->bfd) {
2019         bfd_get_status(ofport->bfd, smap);
2020         return 0;
2021     } else {
2022         return ENOENT;
2023     }
2024 }
2025 \f
2026 /* Spanning Tree. */
2027
2028 static void
2029 send_bpdu_cb(struct ofpbuf *pkt, int port_num, void *ofproto_)
2030 {
2031     struct ofproto_dpif *ofproto = ofproto_;
2032     struct stp_port *sp = stp_get_port(ofproto->stp, port_num);
2033     struct ofport_dpif *ofport;
2034
2035     ofport = stp_port_get_aux(sp);
2036     if (!ofport) {
2037         VLOG_WARN_RL(&rl, "%s: cannot send BPDU on unknown port %d",
2038                      ofproto->up.name, port_num);
2039     } else {
2040         struct eth_header *eth = pkt->l2;
2041
2042         netdev_get_etheraddr(ofport->up.netdev, eth->eth_src);
2043         if (eth_addr_is_zero(eth->eth_src)) {
2044             VLOG_WARN_RL(&rl, "%s: cannot send BPDU on port %d "
2045                          "with unknown MAC", ofproto->up.name, port_num);
2046         } else {
2047             send_packet(ofport, pkt);
2048         }
2049     }
2050     ofpbuf_delete(pkt);
2051 }
2052
2053 /* Configures STP on 'ofproto_' using the settings defined in 's'. */
2054 static int
2055 set_stp(struct ofproto *ofproto_, const struct ofproto_stp_settings *s)
2056 {
2057     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
2058
2059     /* Only revalidate flows if the configuration changed. */
2060     if (!s != !ofproto->stp) {
2061         ofproto->backer->need_revalidate = REV_RECONFIGURE;
2062     }
2063
2064     if (s) {
2065         if (!ofproto->stp) {
2066             ofproto->stp = stp_create(ofproto_->name, s->system_id,
2067                                       send_bpdu_cb, ofproto);
2068             ofproto->stp_last_tick = time_msec();
2069         }
2070
2071         stp_set_bridge_id(ofproto->stp, s->system_id);
2072         stp_set_bridge_priority(ofproto->stp, s->priority);
2073         stp_set_hello_time(ofproto->stp, s->hello_time);
2074         stp_set_max_age(ofproto->stp, s->max_age);
2075         stp_set_forward_delay(ofproto->stp, s->fwd_delay);
2076     }  else {
2077         struct ofport *ofport;
2078
2079         HMAP_FOR_EACH (ofport, hmap_node, &ofproto->up.ports) {
2080             set_stp_port(ofport, NULL);
2081         }
2082
2083         stp_destroy(ofproto->stp);
2084         ofproto->stp = NULL;
2085     }
2086
2087     return 0;
2088 }
2089
2090 static int
2091 get_stp_status(struct ofproto *ofproto_, struct ofproto_stp_status *s)
2092 {
2093     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
2094
2095     if (ofproto->stp) {
2096         s->enabled = true;
2097         s->bridge_id = stp_get_bridge_id(ofproto->stp);
2098         s->designated_root = stp_get_designated_root(ofproto->stp);
2099         s->root_path_cost = stp_get_root_path_cost(ofproto->stp);
2100     } else {
2101         s->enabled = false;
2102     }
2103
2104     return 0;
2105 }
2106
2107 static void
2108 update_stp_port_state(struct ofport_dpif *ofport)
2109 {
2110     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofport->up.ofproto);
2111     enum stp_state state;
2112
2113     /* Figure out new state. */
2114     state = ofport->stp_port ? stp_port_get_state(ofport->stp_port)
2115                              : STP_DISABLED;
2116
2117     /* Update state. */
2118     if (ofport->stp_state != state) {
2119         enum ofputil_port_state of_state;
2120         bool fwd_change;
2121
2122         VLOG_DBG_RL(&rl, "port %s: STP state changed from %s to %s",
2123                     netdev_get_name(ofport->up.netdev),
2124                     stp_state_name(ofport->stp_state),
2125                     stp_state_name(state));
2126         if (stp_learn_in_state(ofport->stp_state)
2127                 != stp_learn_in_state(state)) {
2128             /* xxx Learning action flows should also be flushed. */
2129             mac_learning_flush(ofproto->ml,
2130                                &ofproto->backer->revalidate_set);
2131         }
2132         fwd_change = stp_forward_in_state(ofport->stp_state)
2133                         != stp_forward_in_state(state);
2134
2135         ofproto->backer->need_revalidate = REV_STP;
2136         ofport->stp_state = state;
2137         ofport->stp_state_entered = time_msec();
2138
2139         if (fwd_change && ofport->bundle) {
2140             bundle_update(ofport->bundle);
2141         }
2142
2143         /* Update the STP state bits in the OpenFlow port description. */
2144         of_state = ofport->up.pp.state & ~OFPUTIL_PS_STP_MASK;
2145         of_state |= (state == STP_LISTENING ? OFPUTIL_PS_STP_LISTEN
2146                      : state == STP_LEARNING ? OFPUTIL_PS_STP_LEARN
2147                      : state == STP_FORWARDING ? OFPUTIL_PS_STP_FORWARD
2148                      : state == STP_BLOCKING ?  OFPUTIL_PS_STP_BLOCK
2149                      : 0);
2150         ofproto_port_set_state(&ofport->up, of_state);
2151     }
2152 }
2153
2154 /* Configures STP on 'ofport_' using the settings defined in 's'.  The
2155  * caller is responsible for assigning STP port numbers and ensuring
2156  * there are no duplicates. */
2157 static int
2158 set_stp_port(struct ofport *ofport_,
2159              const struct ofproto_port_stp_settings *s)
2160 {
2161     struct ofport_dpif *ofport = ofport_dpif_cast(ofport_);
2162     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofport->up.ofproto);
2163     struct stp_port *sp = ofport->stp_port;
2164
2165     if (!s || !s->enable) {
2166         if (sp) {
2167             ofport->stp_port = NULL;
2168             stp_port_disable(sp);
2169             update_stp_port_state(ofport);
2170         }
2171         return 0;
2172     } else if (sp && stp_port_no(sp) != s->port_num
2173             && ofport == stp_port_get_aux(sp)) {
2174         /* The port-id changed, so disable the old one if it's not
2175          * already in use by another port. */
2176         stp_port_disable(sp);
2177     }
2178
2179     sp = ofport->stp_port = stp_get_port(ofproto->stp, s->port_num);
2180     stp_port_enable(sp);
2181
2182     stp_port_set_aux(sp, ofport);
2183     stp_port_set_priority(sp, s->priority);
2184     stp_port_set_path_cost(sp, s->path_cost);
2185
2186     update_stp_port_state(ofport);
2187
2188     return 0;
2189 }
2190
2191 static int
2192 get_stp_port_status(struct ofport *ofport_,
2193                     struct ofproto_port_stp_status *s)
2194 {
2195     struct ofport_dpif *ofport = ofport_dpif_cast(ofport_);
2196     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofport->up.ofproto);
2197     struct stp_port *sp = ofport->stp_port;
2198
2199     if (!ofproto->stp || !sp) {
2200         s->enabled = false;
2201         return 0;
2202     }
2203
2204     s->enabled = true;
2205     s->port_id = stp_port_get_id(sp);
2206     s->state = stp_port_get_state(sp);
2207     s->sec_in_state = (time_msec() - ofport->stp_state_entered) / 1000;
2208     s->role = stp_port_get_role(sp);
2209     stp_port_get_counts(sp, &s->tx_count, &s->rx_count, &s->error_count);
2210
2211     return 0;
2212 }
2213
2214 static void
2215 stp_run(struct ofproto_dpif *ofproto)
2216 {
2217     if (ofproto->stp) {
2218         long long int now = time_msec();
2219         long long int elapsed = now - ofproto->stp_last_tick;
2220         struct stp_port *sp;
2221
2222         if (elapsed > 0) {
2223             stp_tick(ofproto->stp, MIN(INT_MAX, elapsed));
2224             ofproto->stp_last_tick = now;
2225         }
2226         while (stp_get_changed_port(ofproto->stp, &sp)) {
2227             struct ofport_dpif *ofport = stp_port_get_aux(sp);
2228
2229             if (ofport) {
2230                 update_stp_port_state(ofport);
2231             }
2232         }
2233
2234         if (stp_check_and_reset_fdb_flush(ofproto->stp)) {
2235             mac_learning_flush(ofproto->ml, &ofproto->backer->revalidate_set);
2236         }
2237     }
2238 }
2239
2240 static void
2241 stp_wait(struct ofproto_dpif *ofproto)
2242 {
2243     if (ofproto->stp) {
2244         poll_timer_wait(1000);
2245     }
2246 }
2247
2248 /* Returns true if STP should process 'flow'. */
2249 static bool
2250 stp_should_process_flow(const struct flow *flow)
2251 {
2252     return eth_addr_equals(flow->dl_dst, eth_addr_stp);
2253 }
2254
2255 static void
2256 stp_process_packet(const struct ofport_dpif *ofport,
2257                    const struct ofpbuf *packet)
2258 {
2259     struct ofpbuf payload = *packet;
2260     struct eth_header *eth = payload.data;
2261     struct stp_port *sp = ofport->stp_port;
2262
2263     /* Sink packets on ports that have STP disabled when the bridge has
2264      * STP enabled. */
2265     if (!sp || stp_port_get_state(sp) == STP_DISABLED) {
2266         return;
2267     }
2268
2269     /* Trim off padding on payload. */
2270     if (payload.size > ntohs(eth->eth_type) + ETH_HEADER_LEN) {
2271         payload.size = ntohs(eth->eth_type) + ETH_HEADER_LEN;
2272     }
2273
2274     if (ofpbuf_try_pull(&payload, ETH_HEADER_LEN + LLC_HEADER_LEN)) {
2275         stp_received_bpdu(sp, payload.data, payload.size);
2276     }
2277 }
2278 \f
2279 static struct priority_to_dscp *
2280 get_priority(const struct ofport_dpif *ofport, uint32_t priority)
2281 {
2282     struct priority_to_dscp *pdscp;
2283     uint32_t hash;
2284
2285     hash = hash_int(priority, 0);
2286     HMAP_FOR_EACH_IN_BUCKET (pdscp, hmap_node, hash, &ofport->priorities) {
2287         if (pdscp->priority == priority) {
2288             return pdscp;
2289         }
2290     }
2291     return NULL;
2292 }
2293
2294 static void
2295 ofport_clear_priorities(struct ofport_dpif *ofport)
2296 {
2297     struct priority_to_dscp *pdscp, *next;
2298
2299     HMAP_FOR_EACH_SAFE (pdscp, next, hmap_node, &ofport->priorities) {
2300         hmap_remove(&ofport->priorities, &pdscp->hmap_node);
2301         free(pdscp);
2302     }
2303 }
2304
2305 static int
2306 set_queues(struct ofport *ofport_,
2307            const struct ofproto_port_queue *qdscp_list,
2308            size_t n_qdscp)
2309 {
2310     struct ofport_dpif *ofport = ofport_dpif_cast(ofport_);
2311     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofport->up.ofproto);
2312     struct hmap new = HMAP_INITIALIZER(&new);
2313     size_t i;
2314
2315     for (i = 0; i < n_qdscp; i++) {
2316         struct priority_to_dscp *pdscp;
2317         uint32_t priority;
2318         uint8_t dscp;
2319
2320         dscp = (qdscp_list[i].dscp << 2) & IP_DSCP_MASK;
2321         if (dpif_queue_to_priority(ofproto->backer->dpif, qdscp_list[i].queue,
2322                                    &priority)) {
2323             continue;
2324         }
2325
2326         pdscp = get_priority(ofport, priority);
2327         if (pdscp) {
2328             hmap_remove(&ofport->priorities, &pdscp->hmap_node);
2329         } else {
2330             pdscp = xmalloc(sizeof *pdscp);
2331             pdscp->priority = priority;
2332             pdscp->dscp = dscp;
2333             ofproto->backer->need_revalidate = REV_RECONFIGURE;
2334         }
2335
2336         if (pdscp->dscp != dscp) {
2337             pdscp->dscp = dscp;
2338             ofproto->backer->need_revalidate = REV_RECONFIGURE;
2339         }
2340
2341         hmap_insert(&new, &pdscp->hmap_node, hash_int(pdscp->priority, 0));
2342     }
2343
2344     if (!hmap_is_empty(&ofport->priorities)) {
2345         ofport_clear_priorities(ofport);
2346         ofproto->backer->need_revalidate = REV_RECONFIGURE;
2347     }
2348
2349     hmap_swap(&new, &ofport->priorities);
2350     hmap_destroy(&new);
2351
2352     return 0;
2353 }
2354 \f
2355 /* Bundles. */
2356
2357 /* Expires all MAC learning entries associated with 'bundle' and forces its
2358  * ofproto to revalidate every flow.
2359  *
2360  * Normally MAC learning entries are removed only from the ofproto associated
2361  * with 'bundle', but if 'all_ofprotos' is true, then the MAC learning entries
2362  * are removed from every ofproto.  When patch ports and SLB bonds are in use
2363  * and a VM migration happens and the gratuitous ARPs are somehow lost, this
2364  * avoids a MAC_ENTRY_IDLE_TIME delay before the migrated VM can communicate
2365  * with the host from which it migrated. */
2366 static void
2367 bundle_flush_macs(struct ofbundle *bundle, bool all_ofprotos)
2368 {
2369     struct ofproto_dpif *ofproto = bundle->ofproto;
2370     struct mac_learning *ml = ofproto->ml;
2371     struct mac_entry *mac, *next_mac;
2372
2373     ofproto->backer->need_revalidate = REV_RECONFIGURE;
2374     LIST_FOR_EACH_SAFE (mac, next_mac, lru_node, &ml->lrus) {
2375         if (mac->port.p == bundle) {
2376             if (all_ofprotos) {
2377                 struct ofproto_dpif *o;
2378
2379                 HMAP_FOR_EACH (o, all_ofproto_dpifs_node, &all_ofproto_dpifs) {
2380                     if (o != ofproto) {
2381                         struct mac_entry *e;
2382
2383                         e = mac_learning_lookup(o->ml, mac->mac, mac->vlan,
2384                                                 NULL);
2385                         if (e) {
2386                             mac_learning_expire(o->ml, e);
2387                         }
2388                     }
2389                 }
2390             }
2391
2392             mac_learning_expire(ml, mac);
2393         }
2394     }
2395 }
2396
2397 static struct ofbundle *
2398 bundle_lookup(const struct ofproto_dpif *ofproto, void *aux)
2399 {
2400     struct ofbundle *bundle;
2401
2402     HMAP_FOR_EACH_IN_BUCKET (bundle, hmap_node, hash_pointer(aux, 0),
2403                              &ofproto->bundles) {
2404         if (bundle->aux == aux) {
2405             return bundle;
2406         }
2407     }
2408     return NULL;
2409 }
2410
2411 /* Looks up each of the 'n_auxes' pointers in 'auxes' as bundles and adds the
2412  * ones that are found to 'bundles'. */
2413 static void
2414 bundle_lookup_multiple(struct ofproto_dpif *ofproto,
2415                        void **auxes, size_t n_auxes,
2416                        struct hmapx *bundles)
2417 {
2418     size_t i;
2419
2420     hmapx_init(bundles);
2421     for (i = 0; i < n_auxes; i++) {
2422         struct ofbundle *bundle = bundle_lookup(ofproto, auxes[i]);
2423         if (bundle) {
2424             hmapx_add(bundles, bundle);
2425         }
2426     }
2427 }
2428
2429 static void
2430 bundle_update(struct ofbundle *bundle)
2431 {
2432     struct ofport_dpif *port;
2433
2434     bundle->floodable = true;
2435     LIST_FOR_EACH (port, bundle_node, &bundle->ports) {
2436         if (port->up.pp.config & OFPUTIL_PC_NO_FLOOD
2437             || !stp_forward_in_state(port->stp_state)) {
2438             bundle->floodable = false;
2439             break;
2440         }
2441     }
2442 }
2443
2444 static void
2445 bundle_del_port(struct ofport_dpif *port)
2446 {
2447     struct ofbundle *bundle = port->bundle;
2448
2449     bundle->ofproto->backer->need_revalidate = REV_RECONFIGURE;
2450
2451     list_remove(&port->bundle_node);
2452     port->bundle = NULL;
2453
2454     if (bundle->lacp) {
2455         lacp_slave_unregister(bundle->lacp, port);
2456     }
2457     if (bundle->bond) {
2458         bond_slave_unregister(bundle->bond, port);
2459     }
2460
2461     bundle_update(bundle);
2462 }
2463
2464 static bool
2465 bundle_add_port(struct ofbundle *bundle, uint32_t ofp_port,
2466                 struct lacp_slave_settings *lacp)
2467 {
2468     struct ofport_dpif *port;
2469
2470     port = get_ofp_port(bundle->ofproto, ofp_port);
2471     if (!port) {
2472         return false;
2473     }
2474
2475     if (port->bundle != bundle) {
2476         bundle->ofproto->backer->need_revalidate = REV_RECONFIGURE;
2477         if (port->bundle) {
2478             bundle_del_port(port);
2479         }
2480
2481         port->bundle = bundle;
2482         list_push_back(&bundle->ports, &port->bundle_node);
2483         if (port->up.pp.config & OFPUTIL_PC_NO_FLOOD
2484             || !stp_forward_in_state(port->stp_state)) {
2485             bundle->floodable = false;
2486         }
2487     }
2488     if (lacp) {
2489         bundle->ofproto->backer->need_revalidate = REV_RECONFIGURE;
2490         lacp_slave_register(bundle->lacp, port, lacp);
2491     }
2492
2493     return true;
2494 }
2495
2496 static void
2497 bundle_destroy(struct ofbundle *bundle)
2498 {
2499     struct ofproto_dpif *ofproto;
2500     struct ofport_dpif *port, *next_port;
2501     int i;
2502
2503     if (!bundle) {
2504         return;
2505     }
2506
2507     ofproto = bundle->ofproto;
2508     for (i = 0; i < MAX_MIRRORS; i++) {
2509         struct ofmirror *m = ofproto->mirrors[i];
2510         if (m) {
2511             if (m->out == bundle) {
2512                 mirror_destroy(m);
2513             } else if (hmapx_find_and_delete(&m->srcs, bundle)
2514                        || hmapx_find_and_delete(&m->dsts, bundle)) {
2515                 ofproto->backer->need_revalidate = REV_RECONFIGURE;
2516             }
2517         }
2518     }
2519
2520     LIST_FOR_EACH_SAFE (port, next_port, bundle_node, &bundle->ports) {
2521         bundle_del_port(port);
2522     }
2523
2524     bundle_flush_macs(bundle, true);
2525     hmap_remove(&ofproto->bundles, &bundle->hmap_node);
2526     free(bundle->name);
2527     free(bundle->trunks);
2528     lacp_destroy(bundle->lacp);
2529     bond_destroy(bundle->bond);
2530     free(bundle);
2531 }
2532
2533 static int
2534 bundle_set(struct ofproto *ofproto_, void *aux,
2535            const struct ofproto_bundle_settings *s)
2536 {
2537     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
2538     bool need_flush = false;
2539     struct ofport_dpif *port;
2540     struct ofbundle *bundle;
2541     unsigned long *trunks;
2542     int vlan;
2543     size_t i;
2544     bool ok;
2545
2546     if (!s) {
2547         bundle_destroy(bundle_lookup(ofproto, aux));
2548         return 0;
2549     }
2550
2551     ovs_assert(s->n_slaves == 1 || s->bond != NULL);
2552     ovs_assert((s->lacp != NULL) == (s->lacp_slaves != NULL));
2553
2554     bundle = bundle_lookup(ofproto, aux);
2555     if (!bundle) {
2556         bundle = xmalloc(sizeof *bundle);
2557
2558         bundle->ofproto = ofproto;
2559         hmap_insert(&ofproto->bundles, &bundle->hmap_node,
2560                     hash_pointer(aux, 0));
2561         bundle->aux = aux;
2562         bundle->name = NULL;
2563
2564         list_init(&bundle->ports);
2565         bundle->vlan_mode = PORT_VLAN_TRUNK;
2566         bundle->vlan = -1;
2567         bundle->trunks = NULL;
2568         bundle->use_priority_tags = s->use_priority_tags;
2569         bundle->lacp = NULL;
2570         bundle->bond = NULL;
2571
2572         bundle->floodable = true;
2573
2574         bundle->src_mirrors = 0;
2575         bundle->dst_mirrors = 0;
2576         bundle->mirror_out = 0;
2577     }
2578
2579     if (!bundle->name || strcmp(s->name, bundle->name)) {
2580         free(bundle->name);
2581         bundle->name = xstrdup(s->name);
2582     }
2583
2584     /* LACP. */
2585     if (s->lacp) {
2586         if (!bundle->lacp) {
2587             ofproto->backer->need_revalidate = REV_RECONFIGURE;
2588             bundle->lacp = lacp_create();
2589         }
2590         lacp_configure(bundle->lacp, s->lacp);
2591     } else {
2592         lacp_destroy(bundle->lacp);
2593         bundle->lacp = NULL;
2594     }
2595
2596     /* Update set of ports. */
2597     ok = true;
2598     for (i = 0; i < s->n_slaves; i++) {
2599         if (!bundle_add_port(bundle, s->slaves[i],
2600                              s->lacp ? &s->lacp_slaves[i] : NULL)) {
2601             ok = false;
2602         }
2603     }
2604     if (!ok || list_size(&bundle->ports) != s->n_slaves) {
2605         struct ofport_dpif *next_port;
2606
2607         LIST_FOR_EACH_SAFE (port, next_port, bundle_node, &bundle->ports) {
2608             for (i = 0; i < s->n_slaves; i++) {
2609                 if (s->slaves[i] == port->up.ofp_port) {
2610                     goto found;
2611                 }
2612             }
2613
2614             bundle_del_port(port);
2615         found: ;
2616         }
2617     }
2618     ovs_assert(list_size(&bundle->ports) <= s->n_slaves);
2619
2620     if (list_is_empty(&bundle->ports)) {
2621         bundle_destroy(bundle);
2622         return EINVAL;
2623     }
2624
2625     /* Set VLAN tagging mode */
2626     if (s->vlan_mode != bundle->vlan_mode
2627         || s->use_priority_tags != bundle->use_priority_tags) {
2628         bundle->vlan_mode = s->vlan_mode;
2629         bundle->use_priority_tags = s->use_priority_tags;
2630         need_flush = true;
2631     }
2632
2633     /* Set VLAN tag. */
2634     vlan = (s->vlan_mode == PORT_VLAN_TRUNK ? -1
2635             : s->vlan >= 0 && s->vlan <= 4095 ? s->vlan
2636             : 0);
2637     if (vlan != bundle->vlan) {
2638         bundle->vlan = vlan;
2639         need_flush = true;
2640     }
2641
2642     /* Get trunked VLANs. */
2643     switch (s->vlan_mode) {
2644     case PORT_VLAN_ACCESS:
2645         trunks = NULL;
2646         break;
2647
2648     case PORT_VLAN_TRUNK:
2649         trunks = CONST_CAST(unsigned long *, s->trunks);
2650         break;
2651
2652     case PORT_VLAN_NATIVE_UNTAGGED:
2653     case PORT_VLAN_NATIVE_TAGGED:
2654         if (vlan != 0 && (!s->trunks
2655                           || !bitmap_is_set(s->trunks, vlan)
2656                           || bitmap_is_set(s->trunks, 0))) {
2657             /* Force trunking the native VLAN and prohibit trunking VLAN 0. */
2658             if (s->trunks) {
2659                 trunks = bitmap_clone(s->trunks, 4096);
2660             } else {
2661                 trunks = bitmap_allocate1(4096);
2662             }
2663             bitmap_set1(trunks, vlan);
2664             bitmap_set0(trunks, 0);
2665         } else {
2666             trunks = CONST_CAST(unsigned long *, s->trunks);
2667         }
2668         break;
2669
2670     default:
2671         NOT_REACHED();
2672     }
2673     if (!vlan_bitmap_equal(trunks, bundle->trunks)) {
2674         free(bundle->trunks);
2675         if (trunks == s->trunks) {
2676             bundle->trunks = vlan_bitmap_clone(trunks);
2677         } else {
2678             bundle->trunks = trunks;
2679             trunks = NULL;
2680         }
2681         need_flush = true;
2682     }
2683     if (trunks != s->trunks) {
2684         free(trunks);
2685     }
2686
2687     /* Bonding. */
2688     if (!list_is_short(&bundle->ports)) {
2689         bundle->ofproto->has_bonded_bundles = true;
2690         if (bundle->bond) {
2691             if (bond_reconfigure(bundle->bond, s->bond)) {
2692                 ofproto->backer->need_revalidate = REV_RECONFIGURE;
2693             }
2694         } else {
2695             bundle->bond = bond_create(s->bond);
2696             ofproto->backer->need_revalidate = REV_RECONFIGURE;
2697         }
2698
2699         LIST_FOR_EACH (port, bundle_node, &bundle->ports) {
2700             bond_slave_register(bundle->bond, port, port->up.netdev);
2701         }
2702     } else {
2703         bond_destroy(bundle->bond);
2704         bundle->bond = NULL;
2705     }
2706
2707     /* If we changed something that would affect MAC learning, un-learn
2708      * everything on this port and force flow revalidation. */
2709     if (need_flush) {
2710         bundle_flush_macs(bundle, false);
2711     }
2712
2713     return 0;
2714 }
2715
2716 static void
2717 bundle_remove(struct ofport *port_)
2718 {
2719     struct ofport_dpif *port = ofport_dpif_cast(port_);
2720     struct ofbundle *bundle = port->bundle;
2721
2722     if (bundle) {
2723         bundle_del_port(port);
2724         if (list_is_empty(&bundle->ports)) {
2725             bundle_destroy(bundle);
2726         } else if (list_is_short(&bundle->ports)) {
2727             bond_destroy(bundle->bond);
2728             bundle->bond = NULL;
2729         }
2730     }
2731 }
2732
2733 static void
2734 send_pdu_cb(void *port_, const void *pdu, size_t pdu_size)
2735 {
2736     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 10);
2737     struct ofport_dpif *port = port_;
2738     uint8_t ea[ETH_ADDR_LEN];
2739     int error;
2740
2741     error = netdev_get_etheraddr(port->up.netdev, ea);
2742     if (!error) {
2743         struct ofpbuf packet;
2744         void *packet_pdu;
2745
2746         ofpbuf_init(&packet, 0);
2747         packet_pdu = eth_compose(&packet, eth_addr_lacp, ea, ETH_TYPE_LACP,
2748                                  pdu_size);
2749         memcpy(packet_pdu, pdu, pdu_size);
2750
2751         send_packet(port, &packet);
2752         ofpbuf_uninit(&packet);
2753     } else {
2754         VLOG_ERR_RL(&rl, "port %s: cannot obtain Ethernet address of iface "
2755                     "%s (%s)", port->bundle->name,
2756                     netdev_get_name(port->up.netdev), strerror(error));
2757     }
2758 }
2759
2760 static void
2761 bundle_send_learning_packets(struct ofbundle *bundle)
2762 {
2763     struct ofproto_dpif *ofproto = bundle->ofproto;
2764     int error, n_packets, n_errors;
2765     struct mac_entry *e;
2766
2767     error = n_packets = n_errors = 0;
2768     LIST_FOR_EACH (e, lru_node, &ofproto->ml->lrus) {
2769         if (e->port.p != bundle) {
2770             struct ofpbuf *learning_packet;
2771             struct ofport_dpif *port;
2772             void *port_void;
2773             int ret;
2774
2775             /* The assignment to "port" is unnecessary but makes "grep"ing for
2776              * struct ofport_dpif more effective. */
2777             learning_packet = bond_compose_learning_packet(bundle->bond,
2778                                                            e->mac, e->vlan,
2779                                                            &port_void);
2780             port = port_void;
2781             ret = send_packet(port, learning_packet);
2782             ofpbuf_delete(learning_packet);
2783             if (ret) {
2784                 error = ret;
2785                 n_errors++;
2786             }
2787             n_packets++;
2788         }
2789     }
2790
2791     if (n_errors) {
2792         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
2793         VLOG_WARN_RL(&rl, "bond %s: %d errors sending %d gratuitous learning "
2794                      "packets, last error was: %s",
2795                      bundle->name, n_errors, n_packets, strerror(error));
2796     } else {
2797         VLOG_DBG("bond %s: sent %d gratuitous learning packets",
2798                  bundle->name, n_packets);
2799     }
2800 }
2801
2802 static void
2803 bundle_run(struct ofbundle *bundle)
2804 {
2805     if (bundle->lacp) {
2806         lacp_run(bundle->lacp, send_pdu_cb);
2807     }
2808     if (bundle->bond) {
2809         struct ofport_dpif *port;
2810
2811         LIST_FOR_EACH (port, bundle_node, &bundle->ports) {
2812             bond_slave_set_may_enable(bundle->bond, port, port->may_enable);
2813         }
2814
2815         bond_run(bundle->bond, &bundle->ofproto->backer->revalidate_set,
2816                  lacp_status(bundle->lacp));
2817         if (bond_should_send_learning_packets(bundle->bond)) {
2818             bundle_send_learning_packets(bundle);
2819         }
2820     }
2821 }
2822
2823 static void
2824 bundle_wait(struct ofbundle *bundle)
2825 {
2826     if (bundle->lacp) {
2827         lacp_wait(bundle->lacp);
2828     }
2829     if (bundle->bond) {
2830         bond_wait(bundle->bond);
2831     }
2832 }
2833 \f
2834 /* Mirrors. */
2835
2836 static int
2837 mirror_scan(struct ofproto_dpif *ofproto)
2838 {
2839     int idx;
2840
2841     for (idx = 0; idx < MAX_MIRRORS; idx++) {
2842         if (!ofproto->mirrors[idx]) {
2843             return idx;
2844         }
2845     }
2846     return -1;
2847 }
2848
2849 static struct ofmirror *
2850 mirror_lookup(struct ofproto_dpif *ofproto, void *aux)
2851 {
2852     int i;
2853
2854     for (i = 0; i < MAX_MIRRORS; i++) {
2855         struct ofmirror *mirror = ofproto->mirrors[i];
2856         if (mirror && mirror->aux == aux) {
2857             return mirror;
2858         }
2859     }
2860
2861     return NULL;
2862 }
2863
2864 /* Update the 'dup_mirrors' member of each of the ofmirrors in 'ofproto'. */
2865 static void
2866 mirror_update_dups(struct ofproto_dpif *ofproto)
2867 {
2868     int i;
2869
2870     for (i = 0; i < MAX_MIRRORS; i++) {
2871         struct ofmirror *m = ofproto->mirrors[i];
2872
2873         if (m) {
2874             m->dup_mirrors = MIRROR_MASK_C(1) << i;
2875         }
2876     }
2877
2878     for (i = 0; i < MAX_MIRRORS; i++) {
2879         struct ofmirror *m1 = ofproto->mirrors[i];
2880         int j;
2881
2882         if (!m1) {
2883             continue;
2884         }
2885
2886         for (j = i + 1; j < MAX_MIRRORS; j++) {
2887             struct ofmirror *m2 = ofproto->mirrors[j];
2888
2889             if (m2 && m1->out == m2->out && m1->out_vlan == m2->out_vlan) {
2890                 m1->dup_mirrors |= MIRROR_MASK_C(1) << j;
2891                 m2->dup_mirrors |= m1->dup_mirrors;
2892             }
2893         }
2894     }
2895 }
2896
2897 static int
2898 mirror_set(struct ofproto *ofproto_, void *aux,
2899            const struct ofproto_mirror_settings *s)
2900 {
2901     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
2902     mirror_mask_t mirror_bit;
2903     struct ofbundle *bundle;
2904     struct ofmirror *mirror;
2905     struct ofbundle *out;
2906     struct hmapx srcs;          /* Contains "struct ofbundle *"s. */
2907     struct hmapx dsts;          /* Contains "struct ofbundle *"s. */
2908     int out_vlan;
2909
2910     mirror = mirror_lookup(ofproto, aux);
2911     if (!s) {
2912         mirror_destroy(mirror);
2913         return 0;
2914     }
2915     if (!mirror) {
2916         int idx;
2917
2918         idx = mirror_scan(ofproto);
2919         if (idx < 0) {
2920             VLOG_WARN("bridge %s: maximum of %d port mirrors reached, "
2921                       "cannot create %s",
2922                       ofproto->up.name, MAX_MIRRORS, s->name);
2923             return EFBIG;
2924         }
2925
2926         mirror = ofproto->mirrors[idx] = xzalloc(sizeof *mirror);
2927         mirror->ofproto = ofproto;
2928         mirror->idx = idx;
2929         mirror->aux = aux;
2930         mirror->out_vlan = -1;
2931         mirror->name = NULL;
2932     }
2933
2934     if (!mirror->name || strcmp(s->name, mirror->name)) {
2935         free(mirror->name);
2936         mirror->name = xstrdup(s->name);
2937     }
2938
2939     /* Get the new configuration. */
2940     if (s->out_bundle) {
2941         out = bundle_lookup(ofproto, s->out_bundle);
2942         if (!out) {
2943             mirror_destroy(mirror);
2944             return EINVAL;
2945         }
2946         out_vlan = -1;
2947     } else {
2948         out = NULL;
2949         out_vlan = s->out_vlan;
2950     }
2951     bundle_lookup_multiple(ofproto, s->srcs, s->n_srcs, &srcs);
2952     bundle_lookup_multiple(ofproto, s->dsts, s->n_dsts, &dsts);
2953
2954     /* If the configuration has not changed, do nothing. */
2955     if (hmapx_equals(&srcs, &mirror->srcs)
2956         && hmapx_equals(&dsts, &mirror->dsts)
2957         && vlan_bitmap_equal(mirror->vlans, s->src_vlans)
2958         && mirror->out == out
2959         && mirror->out_vlan == out_vlan)
2960     {
2961         hmapx_destroy(&srcs);
2962         hmapx_destroy(&dsts);
2963         return 0;
2964     }
2965
2966     hmapx_swap(&srcs, &mirror->srcs);
2967     hmapx_destroy(&srcs);
2968
2969     hmapx_swap(&dsts, &mirror->dsts);
2970     hmapx_destroy(&dsts);
2971
2972     free(mirror->vlans);
2973     mirror->vlans = vlan_bitmap_clone(s->src_vlans);
2974
2975     mirror->out = out;
2976     mirror->out_vlan = out_vlan;
2977
2978     /* Update bundles. */
2979     mirror_bit = MIRROR_MASK_C(1) << mirror->idx;
2980     HMAP_FOR_EACH (bundle, hmap_node, &mirror->ofproto->bundles) {
2981         if (hmapx_contains(&mirror->srcs, bundle)) {
2982             bundle->src_mirrors |= mirror_bit;
2983         } else {
2984             bundle->src_mirrors &= ~mirror_bit;
2985         }
2986
2987         if (hmapx_contains(&mirror->dsts, bundle)) {
2988             bundle->dst_mirrors |= mirror_bit;
2989         } else {
2990             bundle->dst_mirrors &= ~mirror_bit;
2991         }
2992
2993         if (mirror->out == bundle) {
2994             bundle->mirror_out |= mirror_bit;
2995         } else {
2996             bundle->mirror_out &= ~mirror_bit;
2997         }
2998     }
2999
3000     ofproto->backer->need_revalidate = REV_RECONFIGURE;
3001     ofproto->has_mirrors = true;
3002     mac_learning_flush(ofproto->ml,
3003                        &ofproto->backer->revalidate_set);
3004     mirror_update_dups(ofproto);
3005
3006     return 0;
3007 }
3008
3009 static void
3010 mirror_destroy(struct ofmirror *mirror)
3011 {
3012     struct ofproto_dpif *ofproto;
3013     mirror_mask_t mirror_bit;
3014     struct ofbundle *bundle;
3015     int i;
3016
3017     if (!mirror) {
3018         return;
3019     }
3020
3021     ofproto = mirror->ofproto;
3022     ofproto->backer->need_revalidate = REV_RECONFIGURE;
3023     mac_learning_flush(ofproto->ml, &ofproto->backer->revalidate_set);
3024
3025     mirror_bit = MIRROR_MASK_C(1) << mirror->idx;
3026     HMAP_FOR_EACH (bundle, hmap_node, &ofproto->bundles) {
3027         bundle->src_mirrors &= ~mirror_bit;
3028         bundle->dst_mirrors &= ~mirror_bit;
3029         bundle->mirror_out &= ~mirror_bit;
3030     }
3031
3032     hmapx_destroy(&mirror->srcs);
3033     hmapx_destroy(&mirror->dsts);
3034     free(mirror->vlans);
3035
3036     ofproto->mirrors[mirror->idx] = NULL;
3037     free(mirror->name);
3038     free(mirror);
3039
3040     mirror_update_dups(ofproto);
3041
3042     ofproto->has_mirrors = false;
3043     for (i = 0; i < MAX_MIRRORS; i++) {
3044         if (ofproto->mirrors[i]) {
3045             ofproto->has_mirrors = true;
3046             break;
3047         }
3048     }
3049 }
3050
3051 static int
3052 mirror_get_stats(struct ofproto *ofproto_, void *aux,
3053                  uint64_t *packets, uint64_t *bytes)
3054 {
3055     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
3056     struct ofmirror *mirror = mirror_lookup(ofproto, aux);
3057
3058     if (!mirror) {
3059         *packets = *bytes = UINT64_MAX;
3060         return 0;
3061     }
3062
3063     push_all_stats();
3064
3065     *packets = mirror->packet_count;
3066     *bytes = mirror->byte_count;
3067
3068     return 0;
3069 }
3070
3071 static int
3072 set_flood_vlans(struct ofproto *ofproto_, unsigned long *flood_vlans)
3073 {
3074     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
3075     if (mac_learning_set_flood_vlans(ofproto->ml, flood_vlans)) {
3076         mac_learning_flush(ofproto->ml, &ofproto->backer->revalidate_set);
3077     }
3078     return 0;
3079 }
3080
3081 static bool
3082 is_mirror_output_bundle(const struct ofproto *ofproto_, void *aux)
3083 {
3084     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
3085     struct ofbundle *bundle = bundle_lookup(ofproto, aux);
3086     return bundle && bundle->mirror_out != 0;
3087 }
3088
3089 static void
3090 forward_bpdu_changed(struct ofproto *ofproto_)
3091 {
3092     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
3093     ofproto->backer->need_revalidate = REV_RECONFIGURE;
3094 }
3095
3096 static void
3097 set_mac_table_config(struct ofproto *ofproto_, unsigned int idle_time,
3098                      size_t max_entries)
3099 {
3100     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
3101     mac_learning_set_idle_time(ofproto->ml, idle_time);
3102     mac_learning_set_max_entries(ofproto->ml, max_entries);
3103 }
3104 \f
3105 /* Ports. */
3106
3107 static struct ofport_dpif *
3108 get_ofp_port(const struct ofproto_dpif *ofproto, uint16_t ofp_port)
3109 {
3110     struct ofport *ofport = ofproto_get_port(&ofproto->up, ofp_port);
3111     return ofport ? ofport_dpif_cast(ofport) : NULL;
3112 }
3113
3114 static struct ofport_dpif *
3115 get_odp_port(const struct ofproto_dpif *ofproto, uint32_t odp_port)
3116 {
3117     struct ofport_dpif *port = odp_port_to_ofport(ofproto->backer, odp_port);
3118     return port && &ofproto->up == port->up.ofproto ? port : NULL;
3119 }
3120
3121 static void
3122 ofproto_port_from_dpif_port(struct ofproto_dpif *ofproto,
3123                             struct ofproto_port *ofproto_port,
3124                             struct dpif_port *dpif_port)
3125 {
3126     ofproto_port->name = dpif_port->name;
3127     ofproto_port->type = dpif_port->type;
3128     ofproto_port->ofp_port = odp_port_to_ofp_port(ofproto, dpif_port->port_no);
3129 }
3130
3131 static struct ofport_dpif *
3132 ofport_get_peer(const struct ofport_dpif *ofport_dpif)
3133 {
3134     const struct ofproto_dpif *ofproto;
3135     const char *peer;
3136
3137     peer = netdev_vport_patch_peer(ofport_dpif->up.netdev);
3138     if (!peer) {
3139         return NULL;
3140     }
3141
3142     HMAP_FOR_EACH (ofproto, all_ofproto_dpifs_node, &all_ofproto_dpifs) {
3143         struct ofport *ofport;
3144
3145         ofport = shash_find_data(&ofproto->up.port_by_name, peer);
3146         if (ofport && ofport->ofproto->ofproto_class == &ofproto_dpif_class) {
3147             return ofport_dpif_cast(ofport);
3148         }
3149     }
3150     return NULL;
3151 }
3152
3153 static void
3154 port_run_fast(struct ofport_dpif *ofport)
3155 {
3156     if (ofport->cfm && cfm_should_send_ccm(ofport->cfm)) {
3157         struct ofpbuf packet;
3158
3159         ofpbuf_init(&packet, 0);
3160         cfm_compose_ccm(ofport->cfm, &packet, ofport->up.pp.hw_addr);
3161         send_packet(ofport, &packet);
3162         ofpbuf_uninit(&packet);
3163     }
3164
3165     if (ofport->bfd && bfd_should_send_packet(ofport->bfd)) {
3166         struct ofpbuf packet;
3167
3168         ofpbuf_init(&packet, 0);
3169         bfd_put_packet(ofport->bfd, &packet, ofport->up.pp.hw_addr);
3170         send_packet(ofport, &packet);
3171         ofpbuf_uninit(&packet);
3172     }
3173 }
3174
3175 static void
3176 port_run(struct ofport_dpif *ofport)
3177 {
3178     long long int carrier_seq = netdev_get_carrier_resets(ofport->up.netdev);
3179     bool carrier_changed = carrier_seq != ofport->carrier_seq;
3180     bool enable = netdev_get_carrier(ofport->up.netdev);
3181
3182     ofport->carrier_seq = carrier_seq;
3183
3184     port_run_fast(ofport);
3185
3186     if (ofport->tnl_port
3187         && tnl_port_reconfigure(&ofport->up, ofport->odp_port,
3188                                 &ofport->tnl_port)) {
3189         ofproto_dpif_cast(ofport->up.ofproto)->backer->need_revalidate = true;
3190     }
3191
3192     if (ofport->cfm) {
3193         int cfm_opup = cfm_get_opup(ofport->cfm);
3194
3195         cfm_run(ofport->cfm);
3196         enable = enable && !cfm_get_fault(ofport->cfm);
3197
3198         if (cfm_opup >= 0) {
3199             enable = enable && cfm_opup;
3200         }
3201     }
3202
3203     if (ofport->bfd) {
3204         bfd_run(ofport->bfd);
3205         enable = enable && bfd_forwarding(ofport->bfd);
3206     }
3207
3208     if (ofport->bundle) {
3209         enable = enable && lacp_slave_may_enable(ofport->bundle->lacp, ofport);
3210         if (carrier_changed) {
3211             lacp_slave_carrier_changed(ofport->bundle->lacp, ofport);
3212         }
3213     }
3214
3215     if (ofport->may_enable != enable) {
3216         struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofport->up.ofproto);
3217
3218         if (ofproto->has_bundle_action) {
3219             ofproto->backer->need_revalidate = REV_PORT_TOGGLED;
3220         }
3221     }
3222
3223     ofport->may_enable = enable;
3224 }
3225
3226 static void
3227 port_wait(struct ofport_dpif *ofport)
3228 {
3229     if (ofport->cfm) {
3230         cfm_wait(ofport->cfm);
3231     }
3232
3233     if (ofport->bfd) {
3234         bfd_wait(ofport->bfd);
3235     }
3236 }
3237
3238 static int
3239 port_query_by_name(const struct ofproto *ofproto_, const char *devname,
3240                    struct ofproto_port *ofproto_port)
3241 {
3242     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
3243     struct dpif_port dpif_port;
3244     int error;
3245
3246     if (sset_contains(&ofproto->ghost_ports, devname)) {
3247         const char *type = netdev_get_type_from_name(devname);
3248
3249         /* We may be called before ofproto->up.port_by_name is populated with
3250          * the appropriate ofport.  For this reason, we must get the name and
3251          * type from the netdev layer directly. */
3252         if (type) {
3253             const struct ofport *ofport;
3254
3255             ofport = shash_find_data(&ofproto->up.port_by_name, devname);
3256             ofproto_port->ofp_port = ofport ? ofport->ofp_port : OFPP_NONE;
3257             ofproto_port->name = xstrdup(devname);
3258             ofproto_port->type = xstrdup(type);
3259             return 0;
3260         }
3261         return ENODEV;
3262     }
3263
3264     if (!sset_contains(&ofproto->ports, devname)) {
3265         return ENODEV;
3266     }
3267     error = dpif_port_query_by_name(ofproto->backer->dpif,
3268                                     devname, &dpif_port);
3269     if (!error) {
3270         ofproto_port_from_dpif_port(ofproto, ofproto_port, &dpif_port);
3271     }
3272     return error;
3273 }
3274
3275 static int
3276 port_add(struct ofproto *ofproto_, struct netdev *netdev)
3277 {
3278     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
3279     const char *dp_port_name = netdev_vport_get_dpif_port(netdev);
3280     const char *devname = netdev_get_name(netdev);
3281
3282     if (netdev_vport_is_patch(netdev)) {
3283         sset_add(&ofproto->ghost_ports, netdev_get_name(netdev));
3284         return 0;
3285     }
3286
3287     if (!dpif_port_exists(ofproto->backer->dpif, dp_port_name)) {
3288         uint32_t port_no = UINT32_MAX;
3289         int error;
3290
3291         error = dpif_port_add(ofproto->backer->dpif, netdev, &port_no);
3292         if (error) {
3293             return error;
3294         }
3295         if (netdev_get_tunnel_config(netdev)) {
3296             simap_put(&ofproto->backer->tnl_backers, dp_port_name, port_no);
3297         }
3298     }
3299
3300     if (netdev_get_tunnel_config(netdev)) {
3301         sset_add(&ofproto->ghost_ports, devname);
3302     } else {
3303         sset_add(&ofproto->ports, devname);
3304     }
3305     return 0;
3306 }
3307
3308 static int
3309 port_del(struct ofproto *ofproto_, uint16_t ofp_port)
3310 {
3311     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
3312     struct ofport_dpif *ofport = get_ofp_port(ofproto, ofp_port);
3313     int error = 0;
3314
3315     if (!ofport) {
3316         return 0;
3317     }
3318
3319     sset_find_and_delete(&ofproto->ghost_ports,
3320                          netdev_get_name(ofport->up.netdev));
3321     ofproto->backer->need_revalidate = REV_RECONFIGURE;
3322     if (!ofport->tnl_port) {
3323         error = dpif_port_del(ofproto->backer->dpif, ofport->odp_port);
3324         if (!error) {
3325             /* The caller is going to close ofport->up.netdev.  If this is a
3326              * bonded port, then the bond is using that netdev, so remove it
3327              * from the bond.  The client will need to reconfigure everything
3328              * after deleting ports, so then the slave will get re-added. */
3329             bundle_remove(&ofport->up);
3330         }
3331     }
3332     return error;
3333 }
3334
3335 static int
3336 port_get_stats(const struct ofport *ofport_, struct netdev_stats *stats)
3337 {
3338     struct ofport_dpif *ofport = ofport_dpif_cast(ofport_);
3339     int error;
3340
3341     push_all_stats();
3342
3343     error = netdev_get_stats(ofport->up.netdev, stats);
3344
3345     if (!error && ofport_->ofp_port == OFPP_LOCAL) {
3346         struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofport->up.ofproto);
3347
3348         /* ofproto->stats.tx_packets represents packets that we created
3349          * internally and sent to some port (e.g. packets sent with
3350          * send_packet()).  Account for them as if they had come from
3351          * OFPP_LOCAL and got forwarded. */
3352
3353         if (stats->rx_packets != UINT64_MAX) {
3354             stats->rx_packets += ofproto->stats.tx_packets;
3355         }
3356
3357         if (stats->rx_bytes != UINT64_MAX) {
3358             stats->rx_bytes += ofproto->stats.tx_bytes;
3359         }
3360
3361         /* ofproto->stats.rx_packets represents packets that were received on
3362          * some port and we processed internally and dropped (e.g. STP).
3363          * Account for them as if they had been forwarded to OFPP_LOCAL. */
3364
3365         if (stats->tx_packets != UINT64_MAX) {
3366             stats->tx_packets += ofproto->stats.rx_packets;
3367         }
3368
3369         if (stats->tx_bytes != UINT64_MAX) {
3370             stats->tx_bytes += ofproto->stats.rx_bytes;
3371         }
3372     }
3373
3374     return error;
3375 }
3376
3377 /* Account packets for LOCAL port. */
3378 static void
3379 ofproto_update_local_port_stats(const struct ofproto *ofproto_,
3380                                 size_t tx_size, size_t rx_size)
3381 {
3382     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
3383
3384     if (rx_size) {
3385         ofproto->stats.rx_packets++;
3386         ofproto->stats.rx_bytes += rx_size;
3387     }
3388     if (tx_size) {
3389         ofproto->stats.tx_packets++;
3390         ofproto->stats.tx_bytes += tx_size;
3391     }
3392 }
3393
3394 struct port_dump_state {
3395     uint32_t bucket;
3396     uint32_t offset;
3397     bool ghost;
3398
3399     struct ofproto_port port;
3400     bool has_port;
3401 };
3402
3403 static int
3404 port_dump_start(const struct ofproto *ofproto_ OVS_UNUSED, void **statep)
3405 {
3406     *statep = xzalloc(sizeof(struct port_dump_state));
3407     return 0;
3408 }
3409
3410 static int
3411 port_dump_next(const struct ofproto *ofproto_, void *state_,
3412                struct ofproto_port *port)
3413 {
3414     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
3415     struct port_dump_state *state = state_;
3416     const struct sset *sset;
3417     struct sset_node *node;
3418
3419     if (state->has_port) {
3420         ofproto_port_destroy(&state->port);
3421         state->has_port = false;
3422     }
3423     sset = state->ghost ? &ofproto->ghost_ports : &ofproto->ports;
3424     while ((node = sset_at_position(sset, &state->bucket, &state->offset))) {
3425         int error;
3426
3427         error = port_query_by_name(ofproto_, node->name, &state->port);
3428         if (!error) {
3429             *port = state->port;
3430             state->has_port = true;
3431             return 0;
3432         } else if (error != ENODEV) {
3433             return error;
3434         }
3435     }
3436
3437     if (!state->ghost) {
3438         state->ghost = true;
3439         state->bucket = 0;
3440         state->offset = 0;
3441         return port_dump_next(ofproto_, state_, port);
3442     }
3443
3444     return EOF;
3445 }
3446
3447 static int
3448 port_dump_done(const struct ofproto *ofproto_ OVS_UNUSED, void *state_)
3449 {
3450     struct port_dump_state *state = state_;
3451
3452     if (state->has_port) {
3453         ofproto_port_destroy(&state->port);
3454     }
3455     free(state);
3456     return 0;
3457 }
3458
3459 static int
3460 port_poll(const struct ofproto *ofproto_, char **devnamep)
3461 {
3462     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
3463
3464     if (ofproto->port_poll_errno) {
3465         int error = ofproto->port_poll_errno;
3466         ofproto->port_poll_errno = 0;
3467         return error;
3468     }
3469
3470     if (sset_is_empty(&ofproto->port_poll_set)) {
3471         return EAGAIN;
3472     }
3473
3474     *devnamep = sset_pop(&ofproto->port_poll_set);
3475     return 0;
3476 }
3477
3478 static void
3479 port_poll_wait(const struct ofproto *ofproto_)
3480 {
3481     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
3482     dpif_port_poll_wait(ofproto->backer->dpif);
3483 }
3484
3485 static int
3486 port_is_lacp_current(const struct ofport *ofport_)
3487 {
3488     const struct ofport_dpif *ofport = ofport_dpif_cast(ofport_);
3489     return (ofport->bundle && ofport->bundle->lacp
3490             ? lacp_slave_is_current(ofport->bundle->lacp, ofport)
3491             : -1);
3492 }
3493 \f
3494 /* Upcall handling. */
3495
3496 /* Flow miss batching.
3497  *
3498  * Some dpifs implement operations faster when you hand them off in a batch.
3499  * To allow batching, "struct flow_miss" queues the dpif-related work needed
3500  * for a given flow.  Each "struct flow_miss" corresponds to sending one or
3501  * more packets, plus possibly installing the flow in the dpif.
3502  *
3503  * So far we only batch the operations that affect flow setup time the most.
3504  * It's possible to batch more than that, but the benefit might be minimal. */
3505 struct flow_miss {
3506     struct hmap_node hmap_node;
3507     struct ofproto_dpif *ofproto;
3508     struct flow flow;
3509     enum odp_key_fitness key_fitness;
3510     const struct nlattr *key;
3511     size_t key_len;
3512     struct initial_vals initial_vals;
3513     struct list packets;
3514     enum dpif_upcall_type upcall_type;
3515     uint32_t odp_in_port;
3516 };
3517
3518 struct flow_miss_op {
3519     struct dpif_op dpif_op;
3520     void *garbage;              /* Pointer to pass to free(), NULL if none. */
3521     uint64_t stub[1024 / 8];    /* Temporary buffer. */
3522 };
3523
3524 /* Sends an OFPT_PACKET_IN message for 'packet' of type OFPR_NO_MATCH to each
3525  * OpenFlow controller as necessary according to their individual
3526  * configurations. */
3527 static void
3528 send_packet_in_miss(struct ofproto_dpif *ofproto, const struct ofpbuf *packet,
3529                     const struct flow *flow)
3530 {
3531     struct ofputil_packet_in pin;
3532
3533     pin.packet = packet->data;
3534     pin.packet_len = packet->size;
3535     pin.reason = OFPR_NO_MATCH;
3536     pin.controller_id = 0;
3537
3538     pin.table_id = 0;
3539     pin.cookie = 0;
3540
3541     pin.send_len = 0;           /* not used for flow table misses */
3542
3543     flow_get_metadata(flow, &pin.fmd);
3544
3545     connmgr_send_packet_in(ofproto->up.connmgr, &pin);
3546 }
3547
3548 static enum slow_path_reason
3549 process_special(struct ofproto_dpif *ofproto, const struct flow *flow,
3550                 const struct ofport_dpif *ofport, const struct ofpbuf *packet)
3551 {
3552     if (!ofport) {
3553         return 0;
3554     } else if (ofport->cfm && cfm_should_process_flow(ofport->cfm, flow)) {
3555         if (packet) {
3556             cfm_process_heartbeat(ofport->cfm, packet);
3557         }
3558         return SLOW_CFM;
3559     } else if (ofport->bfd && bfd_should_process_flow(flow)) {
3560         if (packet) {
3561             bfd_process_packet(ofport->bfd, flow, packet);
3562         }
3563         return SLOW_BFD;
3564     } else if (ofport->bundle && ofport->bundle->lacp
3565                && flow->dl_type == htons(ETH_TYPE_LACP)) {
3566         if (packet) {
3567             lacp_process_packet(ofport->bundle->lacp, ofport, packet);
3568         }
3569         return SLOW_LACP;
3570     } else if (ofproto->stp && stp_should_process_flow(flow)) {
3571         if (packet) {
3572             stp_process_packet(ofport, packet);
3573         }
3574         return SLOW_STP;
3575     } else {
3576         return 0;
3577     }
3578 }
3579
3580 static struct flow_miss *
3581 flow_miss_find(struct hmap *todo, const struct ofproto_dpif *ofproto,
3582                const struct flow *flow, uint32_t hash)
3583 {
3584     struct flow_miss *miss;
3585
3586     HMAP_FOR_EACH_WITH_HASH (miss, hmap_node, hash, todo) {
3587         if (miss->ofproto == ofproto && flow_equal(&miss->flow, flow)) {
3588             return miss;
3589         }
3590     }
3591
3592     return NULL;
3593 }
3594
3595 /* Partially Initializes 'op' as an "execute" operation for 'miss' and
3596  * 'packet'.  The caller must initialize op->actions and op->actions_len.  If
3597  * 'miss' is associated with a subfacet the caller must also initialize the
3598  * returned op->subfacet, and if anything needs to be freed after processing
3599  * the op, the caller must initialize op->garbage also. */
3600 static void
3601 init_flow_miss_execute_op(struct flow_miss *miss, struct ofpbuf *packet,
3602                           struct flow_miss_op *op)
3603 {
3604     if (miss->flow.vlan_tci != miss->initial_vals.vlan_tci) {
3605         /* This packet was received on a VLAN splinter port.  We
3606          * added a VLAN to the packet to make the packet resemble
3607          * the flow, but the actions were composed assuming that
3608          * the packet contained no VLAN.  So, we must remove the
3609          * VLAN header from the packet before trying to execute the
3610          * actions. */
3611         eth_pop_vlan(packet);
3612     }
3613
3614     op->garbage = NULL;
3615     op->dpif_op.type = DPIF_OP_EXECUTE;
3616     op->dpif_op.u.execute.key = miss->key;
3617     op->dpif_op.u.execute.key_len = miss->key_len;
3618     op->dpif_op.u.execute.packet = packet;
3619 }
3620
3621 /* Helper for handle_flow_miss_without_facet() and
3622  * handle_flow_miss_with_facet(). */
3623 static void
3624 handle_flow_miss_common(struct rule_dpif *rule,
3625                         struct ofpbuf *packet, const struct flow *flow)
3626 {
3627     struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
3628
3629     ofproto->n_matches++;
3630
3631     if (rule->up.cr.priority == FAIL_OPEN_PRIORITY) {
3632         /*
3633          * Extra-special case for fail-open mode.
3634          *
3635          * We are in fail-open mode and the packet matched the fail-open
3636          * rule, but we are connected to a controller too.  We should send
3637          * the packet up to the controller in the hope that it will try to
3638          * set up a flow and thereby allow us to exit fail-open.
3639          *
3640          * See the top-level comment in fail-open.c for more information.
3641          */
3642         send_packet_in_miss(ofproto, packet, flow);
3643     }
3644 }
3645
3646 /* Figures out whether a flow that missed in 'ofproto', whose details are in
3647  * 'miss', is likely to be worth tracking in detail in userspace and (usually)
3648  * installing a datapath flow.  The answer is usually "yes" (a return value of
3649  * true).  However, for short flows the cost of bookkeeping is much higher than
3650  * the benefits, so when the datapath holds a large number of flows we impose
3651  * some heuristics to decide which flows are likely to be worth tracking. */
3652 static bool
3653 flow_miss_should_make_facet(struct ofproto_dpif *ofproto,
3654                             struct flow_miss *miss, uint32_t hash)
3655 {
3656     if (!ofproto->governor) {
3657         size_t n_subfacets;
3658
3659         n_subfacets = hmap_count(&ofproto->subfacets);
3660         if (n_subfacets * 2 <= ofproto->up.flow_eviction_threshold) {
3661             return true;
3662         }
3663
3664         ofproto->governor = governor_create(ofproto->up.name);
3665     }
3666
3667     return governor_should_install_flow(ofproto->governor, hash,
3668                                         list_size(&miss->packets));
3669 }
3670
3671 /* Handles 'miss', which matches 'rule', without creating a facet or subfacet
3672  * or creating any datapath flow.  May add an "execute" operation to 'ops' and
3673  * increment '*n_ops'. */
3674 static void
3675 handle_flow_miss_without_facet(struct flow_miss *miss,
3676                                struct rule_dpif *rule,
3677                                struct flow_miss_op *ops, size_t *n_ops)
3678 {
3679     struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
3680     long long int now = time_msec();
3681     struct action_xlate_ctx ctx;
3682     struct ofpbuf *packet;
3683
3684     LIST_FOR_EACH (packet, list_node, &miss->packets) {
3685         struct flow_miss_op *op = &ops[*n_ops];
3686         struct dpif_flow_stats stats;
3687         struct ofpbuf odp_actions;
3688
3689         COVERAGE_INC(facet_suppress);
3690
3691         ofpbuf_use_stub(&odp_actions, op->stub, sizeof op->stub);
3692
3693         dpif_flow_stats_extract(&miss->flow, packet, now, &stats);
3694         rule_credit_stats(rule, &stats);
3695
3696         action_xlate_ctx_init(&ctx, ofproto, &miss->flow,
3697                               &miss->initial_vals, rule, 0, packet);
3698         ctx.resubmit_stats = &stats;
3699         xlate_actions(&ctx, rule->up.ofpacts, rule->up.ofpacts_len,
3700                       &odp_actions);
3701
3702         if (odp_actions.size) {
3703             struct dpif_execute *execute = &op->dpif_op.u.execute;
3704
3705             init_flow_miss_execute_op(miss, packet, op);
3706             execute->actions = odp_actions.data;
3707             execute->actions_len = odp_actions.size;
3708             op->garbage = ofpbuf_get_uninit_pointer(&odp_actions);
3709
3710             (*n_ops)++;
3711         } else {
3712             ofpbuf_uninit(&odp_actions);
3713         }
3714     }
3715 }
3716
3717 /* Handles 'miss', which matches 'facet'.  May add any required datapath
3718  * operations to 'ops', incrementing '*n_ops' for each new op.
3719  *
3720  * All of the packets in 'miss' are considered to have arrived at time 'now'.
3721  * This is really important only for new facets: if we just called time_msec()
3722  * here, then the new subfacet or its packets could look (occasionally) as
3723  * though it was used some time after the facet was used.  That can make a
3724  * one-packet flow look like it has a nonzero duration, which looks odd in
3725  * e.g. NetFlow statistics. */
3726 static void
3727 handle_flow_miss_with_facet(struct flow_miss *miss, struct facet *facet,
3728                             long long int now,
3729                             struct flow_miss_op *ops, size_t *n_ops)
3730 {
3731     struct ofproto_dpif *ofproto = ofproto_dpif_cast(facet->rule->up.ofproto);
3732     enum subfacet_path want_path;
3733     struct subfacet *subfacet;
3734     struct ofpbuf *packet;
3735
3736     subfacet = subfacet_create(facet, miss, now);
3737
3738     LIST_FOR_EACH (packet, list_node, &miss->packets) {
3739         struct flow_miss_op *op = &ops[*n_ops];
3740         struct dpif_flow_stats stats;
3741         struct ofpbuf odp_actions;
3742
3743         handle_flow_miss_common(facet->rule, packet, &miss->flow);
3744
3745         ofpbuf_use_stub(&odp_actions, op->stub, sizeof op->stub);
3746         if (!subfacet->actions || subfacet->slow) {
3747             subfacet_make_actions(subfacet, packet, &odp_actions);
3748         }
3749
3750         dpif_flow_stats_extract(&facet->flow, packet, now, &stats);
3751         subfacet_update_stats(subfacet, &stats);
3752
3753         if (subfacet->actions_len) {
3754             struct dpif_execute *execute = &op->dpif_op.u.execute;
3755
3756             init_flow_miss_execute_op(miss, packet, op);
3757             if (!subfacet->slow) {
3758                 execute->actions = subfacet->actions;
3759                 execute->actions_len = subfacet->actions_len;
3760                 ofpbuf_uninit(&odp_actions);
3761             } else {
3762                 execute->actions = odp_actions.data;
3763                 execute->actions_len = odp_actions.size;
3764                 op->garbage = ofpbuf_get_uninit_pointer(&odp_actions);
3765             }
3766
3767             (*n_ops)++;
3768         } else {
3769             ofpbuf_uninit(&odp_actions);
3770         }
3771     }
3772
3773     want_path = subfacet_want_path(subfacet->slow);
3774     if (miss->upcall_type == DPIF_UC_MISS || subfacet->path != want_path) {
3775         struct flow_miss_op *op = &ops[(*n_ops)++];
3776         struct dpif_flow_put *put = &op->dpif_op.u.flow_put;
3777
3778         subfacet->path = want_path;
3779
3780         op->garbage = NULL;
3781         op->dpif_op.type = DPIF_OP_FLOW_PUT;
3782         put->flags = DPIF_FP_CREATE | DPIF_FP_MODIFY;
3783         put->key = miss->key;
3784         put->key_len = miss->key_len;
3785         if (want_path == SF_FAST_PATH) {
3786             put->actions = subfacet->actions;
3787             put->actions_len = subfacet->actions_len;
3788         } else {
3789             compose_slow_path(ofproto, &facet->flow, subfacet->slow,
3790                               op->stub, sizeof op->stub,
3791                               &put->actions, &put->actions_len);
3792         }
3793         put->stats = NULL;
3794     }
3795 }
3796
3797 /* Handles flow miss 'miss'.  May add any required datapath operations
3798  * to 'ops', incrementing '*n_ops' for each new op. */
3799 static void
3800 handle_flow_miss(struct flow_miss *miss, struct flow_miss_op *ops,
3801                  size_t *n_ops)
3802 {
3803     struct ofproto_dpif *ofproto = miss->ofproto;
3804     struct facet *facet;
3805     long long int now;
3806     uint32_t hash;
3807
3808     /* The caller must ensure that miss->hmap_node.hash contains
3809      * flow_hash(miss->flow, 0). */
3810     hash = miss->hmap_node.hash;
3811
3812     facet = facet_lookup_valid(ofproto, &miss->flow, hash);
3813     if (!facet) {
3814         struct rule_dpif *rule = rule_dpif_lookup(ofproto, &miss->flow);
3815
3816         if (!flow_miss_should_make_facet(ofproto, miss, hash)) {
3817             handle_flow_miss_without_facet(miss, rule, ops, n_ops);
3818             return;
3819         }
3820
3821         facet = facet_create(rule, &miss->flow, hash);
3822         now = facet->used;
3823     } else {
3824         now = time_msec();
3825     }
3826     handle_flow_miss_with_facet(miss, facet, now, ops, n_ops);
3827 }
3828
3829 static struct drop_key *
3830 drop_key_lookup(const struct dpif_backer *backer, const struct nlattr *key,
3831                 size_t key_len)
3832 {
3833     struct drop_key *drop_key;
3834
3835     HMAP_FOR_EACH_WITH_HASH (drop_key, hmap_node, hash_bytes(key, key_len, 0),
3836                              &backer->drop_keys) {
3837         if (drop_key->key_len == key_len
3838             && !memcmp(drop_key->key, key, key_len)) {
3839             return drop_key;
3840         }
3841     }
3842     return NULL;
3843 }
3844
3845 static void
3846 drop_key_clear(struct dpif_backer *backer)
3847 {
3848     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 15);
3849     struct drop_key *drop_key, *next;
3850
3851     HMAP_FOR_EACH_SAFE (drop_key, next, hmap_node, &backer->drop_keys) {
3852         int error;
3853
3854         error = dpif_flow_del(backer->dpif, drop_key->key, drop_key->key_len,
3855                               NULL);
3856         if (error && !VLOG_DROP_WARN(&rl)) {
3857             struct ds ds = DS_EMPTY_INITIALIZER;
3858             odp_flow_key_format(drop_key->key, drop_key->key_len, &ds);
3859             VLOG_WARN("Failed to delete drop key (%s) (%s)", strerror(error),
3860                       ds_cstr(&ds));
3861             ds_destroy(&ds);
3862         }
3863
3864         hmap_remove(&backer->drop_keys, &drop_key->hmap_node);
3865         free(drop_key->key);
3866         free(drop_key);
3867     }
3868 }
3869
3870 /* Given a datpath, packet, and flow metadata ('backer', 'packet', and 'key'
3871  * respectively), populates 'flow' with the result of odp_flow_key_to_flow().
3872  * Optionally, if nonnull, populates 'fitnessp' with the fitness of 'flow' as
3873  * returned by odp_flow_key_to_flow().  Also, optionally populates 'ofproto'
3874  * with the ofproto_dpif, and 'odp_in_port' with the datapath in_port, that
3875  * 'packet' ingressed.
3876  *
3877  * If 'ofproto' is nonnull, requires 'flow''s in_port to exist.  Otherwise sets
3878  * 'flow''s in_port to OFPP_NONE.
3879  *
3880  * This function does post-processing on data returned from
3881  * odp_flow_key_to_flow() to help make VLAN splinters transparent to the rest
3882  * of the upcall processing logic.  In particular, if the extracted in_port is
3883  * a VLAN splinter port, it replaces flow->in_port by the "real" port, sets
3884  * flow->vlan_tci correctly for the VLAN of the VLAN splinter port, and pushes
3885  * a VLAN header onto 'packet' (if it is nonnull).
3886  *
3887  * Optionally, if 'initial_vals' is nonnull, sets 'initial_vals->vlan_tci'
3888  * to the VLAN TCI with which the packet was really received, that is, the
3889  * actual VLAN TCI extracted by odp_flow_key_to_flow().  (This differs from
3890  * the value returned in flow->vlan_tci only for packets received on
3891  * VLAN splinters.)
3892  *
3893  * Similarly, this function also includes some logic to help with tunnels.  It
3894  * may modify 'flow' as necessary to make the tunneling implementation
3895  * transparent to the upcall processing logic.
3896  *
3897  * Returns 0 if successful, ENODEV if the parsed flow has no associated ofport,
3898  * or some other positive errno if there are other problems. */
3899 static int
3900 ofproto_receive(const struct dpif_backer *backer, struct ofpbuf *packet,
3901                 const struct nlattr *key, size_t key_len,
3902                 struct flow *flow, enum odp_key_fitness *fitnessp,
3903                 struct ofproto_dpif **ofproto, uint32_t *odp_in_port,
3904                 struct initial_vals *initial_vals)
3905 {
3906     const struct ofport_dpif *port;
3907     enum odp_key_fitness fitness;
3908     int error = ENODEV;
3909
3910     fitness = odp_flow_key_to_flow(key, key_len, flow);
3911     if (fitness == ODP_FIT_ERROR) {
3912         error = EINVAL;
3913         goto exit;
3914     }
3915
3916     if (initial_vals) {
3917         initial_vals->vlan_tci = flow->vlan_tci;
3918     }
3919
3920     if (odp_in_port) {
3921         *odp_in_port = flow->in_port;
3922     }
3923
3924     if (tnl_port_should_receive(flow)) {
3925         const struct ofport *ofport = tnl_port_receive(flow);
3926         if (!ofport) {
3927             flow->in_port = OFPP_NONE;
3928             goto exit;
3929         }
3930         port = ofport_dpif_cast(ofport);
3931
3932         /* XXX: Since the tunnel module is not scoped per backer, it's
3933          * theoretically possible that we'll receive an ofport belonging to an
3934          * entirely different datapath.  In practice, this can't happen because
3935          * no platforms has two separate datapaths which each support
3936          * tunneling. */
3937         ovs_assert(ofproto_dpif_cast(port->up.ofproto)->backer == backer);
3938     } else {
3939         port = odp_port_to_ofport(backer, flow->in_port);
3940         if (!port) {
3941             flow->in_port = OFPP_NONE;
3942             goto exit;
3943         }
3944
3945         flow->in_port = port->up.ofp_port;
3946         if (vsp_adjust_flow(ofproto_dpif_cast(port->up.ofproto), flow)) {
3947             if (packet) {
3948                 /* Make the packet resemble the flow, so that it gets sent to
3949                  * an OpenFlow controller properly, so that it looks correct
3950                  * for sFlow, and so that flow_extract() will get the correct
3951                  * vlan_tci if it is called on 'packet'.
3952                  *
3953                  * The allocated space inside 'packet' probably also contains
3954                  * 'key', that is, both 'packet' and 'key' are probably part of
3955                  * a struct dpif_upcall (see the large comment on that
3956                  * structure definition), so pushing data on 'packet' is in
3957                  * general not a good idea since it could overwrite 'key' or
3958                  * free it as a side effect.  However, it's OK in this special
3959                  * case because we know that 'packet' is inside a Netlink
3960                  * attribute: pushing 4 bytes will just overwrite the 4-byte
3961                  * "struct nlattr", which is fine since we don't need that
3962                  * header anymore. */
3963                 eth_push_vlan(packet, flow->vlan_tci);
3964             }
3965             /* We can't reproduce 'key' from 'flow'. */
3966             fitness = fitness == ODP_FIT_PERFECT ? ODP_FIT_TOO_MUCH : fitness;
3967         }
3968     }
3969     error = 0;
3970
3971     if (ofproto) {
3972         *ofproto = ofproto_dpif_cast(port->up.ofproto);
3973     }
3974
3975 exit:
3976     if (fitnessp) {
3977         *fitnessp = fitness;
3978     }
3979     return error;
3980 }
3981
3982 static void
3983 handle_miss_upcalls(struct dpif_backer *backer, struct dpif_upcall *upcalls,
3984                     size_t n_upcalls)
3985 {
3986     struct dpif_upcall *upcall;
3987     struct flow_miss *miss;
3988     struct flow_miss misses[FLOW_MISS_MAX_BATCH];
3989     struct flow_miss_op flow_miss_ops[FLOW_MISS_MAX_BATCH * 2];
3990     struct dpif_op *dpif_ops[FLOW_MISS_MAX_BATCH * 2];
3991     struct hmap todo;
3992     int n_misses;
3993     size_t n_ops;
3994     size_t i;
3995
3996     if (!n_upcalls) {
3997         return;
3998     }
3999
4000     /* Construct the to-do list.
4001      *
4002      * This just amounts to extracting the flow from each packet and sticking
4003      * the packets that have the same flow in the same "flow_miss" structure so
4004      * that we can process them together. */
4005     hmap_init(&todo);
4006     n_misses = 0;
4007     for (upcall = upcalls; upcall < &upcalls[n_upcalls]; upcall++) {
4008         struct flow_miss *miss = &misses[n_misses];
4009         struct flow_miss *existing_miss;
4010         struct ofproto_dpif *ofproto;
4011         uint32_t odp_in_port;
4012         struct flow flow;
4013         uint32_t hash;
4014         int error;
4015
4016         error = ofproto_receive(backer, upcall->packet, upcall->key,
4017                                 upcall->key_len, &flow, &miss->key_fitness,
4018                                 &ofproto, &odp_in_port, &miss->initial_vals);
4019         if (error == ENODEV) {
4020             struct drop_key *drop_key;
4021
4022             /* Received packet on port for which we couldn't associate
4023              * an ofproto.  This can happen if a port is removed while
4024              * traffic is being received.  Print a rate-limited message
4025              * in case it happens frequently.  Install a drop flow so
4026              * that future packets of the flow are inexpensively dropped
4027              * in the kernel. */
4028             VLOG_INFO_RL(&rl, "received packet on unassociated port %"PRIu32,
4029                          flow.in_port);
4030
4031             drop_key = drop_key_lookup(backer, upcall->key, upcall->key_len);
4032             if (!drop_key) {
4033                 drop_key = xmalloc(sizeof *drop_key);
4034                 drop_key->key = xmemdup(upcall->key, upcall->key_len);
4035                 drop_key->key_len = upcall->key_len;
4036
4037                 hmap_insert(&backer->drop_keys, &drop_key->hmap_node,
4038                             hash_bytes(drop_key->key, drop_key->key_len, 0));
4039                 dpif_flow_put(backer->dpif, DPIF_FP_CREATE | DPIF_FP_MODIFY,
4040                               drop_key->key, drop_key->key_len, NULL, 0, NULL);
4041             }
4042             continue;
4043         }
4044         if (error) {
4045             continue;
4046         }
4047
4048         ofproto->n_missed++;
4049         flow_extract(upcall->packet, flow.skb_priority, flow.skb_mark,
4050                      &flow.tunnel, flow.in_port, &miss->flow);
4051
4052         /* Add other packets to a to-do list. */
4053         hash = flow_hash(&miss->flow, 0);
4054         existing_miss = flow_miss_find(&todo, ofproto, &miss->flow, hash);
4055         if (!existing_miss) {
4056             hmap_insert(&todo, &miss->hmap_node, hash);
4057             miss->ofproto = ofproto;
4058             miss->key = upcall->key;
4059             miss->key_len = upcall->key_len;
4060             miss->upcall_type = upcall->type;
4061             miss->odp_in_port = odp_in_port;
4062             list_init(&miss->packets);
4063
4064             n_misses++;
4065         } else {
4066             miss = existing_miss;
4067         }
4068         list_push_back(&miss->packets, &upcall->packet->list_node);
4069     }
4070
4071     /* Process each element in the to-do list, constructing the set of
4072      * operations to batch. */
4073     n_ops = 0;
4074     HMAP_FOR_EACH (miss, hmap_node, &todo) {
4075         handle_flow_miss(miss, flow_miss_ops, &n_ops);
4076     }
4077     ovs_assert(n_ops <= ARRAY_SIZE(flow_miss_ops));
4078
4079     /* Execute batch. */
4080     for (i = 0; i < n_ops; i++) {
4081         dpif_ops[i] = &flow_miss_ops[i].dpif_op;
4082     }
4083     dpif_operate(backer->dpif, dpif_ops, n_ops);
4084
4085     /* Free memory. */
4086     for (i = 0; i < n_ops; i++) {
4087         free(flow_miss_ops[i].garbage);
4088     }
4089     hmap_destroy(&todo);
4090 }
4091
4092 static enum { SFLOW_UPCALL, MISS_UPCALL, BAD_UPCALL, FLOW_SAMPLE_UPCALL,
4093               IPFIX_UPCALL }
4094 classify_upcall(const struct dpif_upcall *upcall)
4095 {
4096     size_t userdata_len;
4097     union user_action_cookie cookie;
4098
4099     /* First look at the upcall type. */
4100     switch (upcall->type) {
4101     case DPIF_UC_ACTION:
4102         break;
4103
4104     case DPIF_UC_MISS:
4105         return MISS_UPCALL;
4106
4107     case DPIF_N_UC_TYPES:
4108     default:
4109         VLOG_WARN_RL(&rl, "upcall has unexpected type %"PRIu32, upcall->type);
4110         return BAD_UPCALL;
4111     }
4112
4113     /* "action" upcalls need a closer look. */
4114     if (!upcall->userdata) {
4115         VLOG_WARN_RL(&rl, "action upcall missing cookie");
4116         return BAD_UPCALL;
4117     }
4118     userdata_len = nl_attr_get_size(upcall->userdata);
4119     if (userdata_len < sizeof cookie.type
4120         || userdata_len > sizeof cookie) {
4121         VLOG_WARN_RL(&rl, "action upcall cookie has unexpected size %zu",
4122                      userdata_len);
4123         return BAD_UPCALL;
4124     }
4125     memset(&cookie, 0, sizeof cookie);
4126     memcpy(&cookie, nl_attr_get(upcall->userdata), userdata_len);
4127     if (userdata_len == sizeof cookie.sflow
4128         && cookie.type == USER_ACTION_COOKIE_SFLOW) {
4129         return SFLOW_UPCALL;
4130     } else if (userdata_len == sizeof cookie.slow_path
4131                && cookie.type == USER_ACTION_COOKIE_SLOW_PATH) {
4132         return MISS_UPCALL;
4133     } else if (userdata_len == sizeof cookie.flow_sample
4134                && cookie.type == USER_ACTION_COOKIE_FLOW_SAMPLE) {
4135         return FLOW_SAMPLE_UPCALL;
4136     } else if (userdata_len == sizeof cookie.ipfix
4137                && cookie.type == USER_ACTION_COOKIE_IPFIX) {
4138         return IPFIX_UPCALL;
4139     } else {
4140         VLOG_WARN_RL(&rl, "invalid user cookie of type %"PRIu16
4141                      " and size %zu", cookie.type, userdata_len);
4142         return BAD_UPCALL;
4143     }
4144 }
4145
4146 static void
4147 handle_sflow_upcall(struct dpif_backer *backer,
4148                     const struct dpif_upcall *upcall)
4149 {
4150     struct ofproto_dpif *ofproto;
4151     union user_action_cookie cookie;
4152     struct flow flow;
4153     uint32_t odp_in_port;
4154
4155     if (ofproto_receive(backer, upcall->packet, upcall->key, upcall->key_len,
4156                         &flow, NULL, &ofproto, &odp_in_port, NULL)
4157         || !ofproto->sflow) {
4158         return;
4159     }
4160
4161     memset(&cookie, 0, sizeof cookie);
4162     memcpy(&cookie, nl_attr_get(upcall->userdata), sizeof cookie.sflow);
4163     dpif_sflow_received(ofproto->sflow, upcall->packet, &flow,
4164                         odp_in_port, &cookie);
4165 }
4166
4167 static void
4168 handle_flow_sample_upcall(struct dpif_backer *backer,
4169                           const struct dpif_upcall *upcall)
4170 {
4171     struct ofproto_dpif *ofproto;
4172     union user_action_cookie cookie;
4173     struct flow flow;
4174
4175     if (ofproto_receive(backer, upcall->packet, upcall->key, upcall->key_len,
4176                         &flow, NULL, &ofproto, NULL, NULL)
4177         || !ofproto->ipfix) {
4178         return;
4179     }
4180
4181     memset(&cookie, 0, sizeof cookie);
4182     memcpy(&cookie, nl_attr_get(upcall->userdata), sizeof cookie.flow_sample);
4183
4184     /* The flow reflects exactly the contents of the packet.  Sample
4185      * the packet using it. */
4186     dpif_ipfix_flow_sample(ofproto->ipfix, upcall->packet, &flow,
4187                            cookie.flow_sample.collector_set_id,
4188                            cookie.flow_sample.probability,
4189                            cookie.flow_sample.obs_domain_id,
4190                            cookie.flow_sample.obs_point_id);
4191 }
4192
4193 static void
4194 handle_ipfix_upcall(struct dpif_backer *backer,
4195                     const struct dpif_upcall *upcall)
4196 {
4197     struct ofproto_dpif *ofproto;
4198     struct flow flow;
4199
4200     if (ofproto_receive(backer, upcall->packet, upcall->key, upcall->key_len,
4201                         &flow, NULL, &ofproto, NULL, NULL)
4202         || !ofproto->ipfix) {
4203         return;
4204     }
4205
4206     /* The flow reflects exactly the contents of the packet.  Sample
4207      * the packet using it. */
4208     dpif_ipfix_bridge_sample(ofproto->ipfix, upcall->packet, &flow);
4209 }
4210
4211 static int
4212 handle_upcalls(struct dpif_backer *backer, unsigned int max_batch)
4213 {
4214     struct dpif_upcall misses[FLOW_MISS_MAX_BATCH];
4215     struct ofpbuf miss_bufs[FLOW_MISS_MAX_BATCH];
4216     uint64_t miss_buf_stubs[FLOW_MISS_MAX_BATCH][4096 / 8];
4217     int n_processed;
4218     int n_misses;
4219     int i;
4220
4221     ovs_assert(max_batch <= FLOW_MISS_MAX_BATCH);
4222
4223     n_misses = 0;
4224     for (n_processed = 0; n_processed < max_batch; n_processed++) {
4225         struct dpif_upcall *upcall = &misses[n_misses];
4226         struct ofpbuf *buf = &miss_bufs[n_misses];
4227         int error;
4228
4229         ofpbuf_use_stub(buf, miss_buf_stubs[n_misses],
4230                         sizeof miss_buf_stubs[n_misses]);
4231         error = dpif_recv(backer->dpif, upcall, buf);
4232         if (error) {
4233             ofpbuf_uninit(buf);
4234             break;
4235         }
4236
4237         switch (classify_upcall(upcall)) {
4238         case MISS_UPCALL:
4239             /* Handle it later. */
4240             n_misses++;
4241             break;
4242
4243         case SFLOW_UPCALL:
4244             handle_sflow_upcall(backer, upcall);
4245             ofpbuf_uninit(buf);
4246             break;
4247
4248         case FLOW_SAMPLE_UPCALL:
4249             handle_flow_sample_upcall(backer, upcall);
4250             ofpbuf_uninit(buf);
4251             break;
4252
4253         case IPFIX_UPCALL:
4254             handle_ipfix_upcall(backer, upcall);
4255             ofpbuf_uninit(buf);
4256             break;
4257
4258         case BAD_UPCALL:
4259             ofpbuf_uninit(buf);
4260             break;
4261         }
4262     }
4263
4264     /* Handle deferred MISS_UPCALL processing. */
4265     handle_miss_upcalls(backer, misses, n_misses);
4266     for (i = 0; i < n_misses; i++) {
4267         ofpbuf_uninit(&miss_bufs[i]);
4268     }
4269
4270     return n_processed;
4271 }
4272 \f
4273 /* Flow expiration. */
4274
4275 static int subfacet_max_idle(const struct ofproto_dpif *);
4276 static void update_stats(struct dpif_backer *);
4277 static void rule_expire(struct rule_dpif *);
4278 static void expire_subfacets(struct ofproto_dpif *, int dp_max_idle);
4279
4280 /* This function is called periodically by run().  Its job is to collect
4281  * updates for the flows that have been installed into the datapath, most
4282  * importantly when they last were used, and then use that information to
4283  * expire flows that have not been used recently.
4284  *
4285  * Returns the number of milliseconds after which it should be called again. */
4286 static int
4287 expire(struct dpif_backer *backer)
4288 {
4289     struct ofproto_dpif *ofproto;
4290     int max_idle = INT32_MAX;
4291
4292     /* Periodically clear out the drop keys in an effort to keep them
4293      * relatively few. */
4294     drop_key_clear(backer);
4295
4296     /* Update stats for each flow in the backer. */
4297     update_stats(backer);
4298
4299     HMAP_FOR_EACH (ofproto, all_ofproto_dpifs_node, &all_ofproto_dpifs) {
4300         struct rule *rule, *next_rule;
4301         int dp_max_idle;
4302
4303         if (ofproto->backer != backer) {
4304             continue;
4305         }
4306
4307         /* Keep track of the max number of flows per ofproto_dpif. */
4308         update_max_subfacet_count(ofproto);
4309
4310         /* Expire subfacets that have been idle too long. */
4311         dp_max_idle = subfacet_max_idle(ofproto);
4312         expire_subfacets(ofproto, dp_max_idle);
4313
4314         max_idle = MIN(max_idle, dp_max_idle);
4315
4316         /* Expire OpenFlow flows whose idle_timeout or hard_timeout
4317          * has passed. */
4318         LIST_FOR_EACH_SAFE (rule, next_rule, expirable,
4319                             &ofproto->up.expirable) {
4320             rule_expire(rule_dpif_cast(rule));
4321         }
4322
4323         /* All outstanding data in existing flows has been accounted, so it's a
4324          * good time to do bond rebalancing. */
4325         if (ofproto->has_bonded_bundles) {
4326             struct ofbundle *bundle;
4327
4328             HMAP_FOR_EACH (bundle, hmap_node, &ofproto->bundles) {
4329                 if (bundle->bond) {
4330                     bond_rebalance(bundle->bond, &backer->revalidate_set);
4331                 }
4332             }
4333         }
4334     }
4335
4336     return MIN(max_idle, 1000);
4337 }
4338
4339 /* Updates flow table statistics given that the datapath just reported 'stats'
4340  * as 'subfacet''s statistics. */
4341 static void
4342 update_subfacet_stats(struct subfacet *subfacet,
4343                       const struct dpif_flow_stats *stats)
4344 {
4345     struct facet *facet = subfacet->facet;
4346
4347     if (stats->n_packets >= subfacet->dp_packet_count) {
4348         uint64_t extra = stats->n_packets - subfacet->dp_packet_count;
4349         facet->packet_count += extra;
4350     } else {
4351         VLOG_WARN_RL(&rl, "unexpected packet count from the datapath");
4352     }
4353
4354     if (stats->n_bytes >= subfacet->dp_byte_count) {
4355         facet->byte_count += stats->n_bytes - subfacet->dp_byte_count;
4356     } else {
4357         VLOG_WARN_RL(&rl, "unexpected byte count from datapath");
4358     }
4359
4360     subfacet->dp_packet_count = stats->n_packets;
4361     subfacet->dp_byte_count = stats->n_bytes;
4362
4363     facet->tcp_flags |= stats->tcp_flags;
4364
4365     subfacet_update_time(subfacet, stats->used);
4366     if (facet->accounted_bytes < facet->byte_count) {
4367         facet_learn(facet);
4368         facet_account(facet);
4369         facet->accounted_bytes = facet->byte_count;
4370     }
4371 }
4372
4373 /* 'key' with length 'key_len' bytes is a flow in 'dpif' that we know nothing
4374  * about, or a flow that shouldn't be installed but was anyway.  Delete it. */
4375 static void
4376 delete_unexpected_flow(struct ofproto_dpif *ofproto,
4377                        const struct nlattr *key, size_t key_len)
4378 {
4379     if (!VLOG_DROP_WARN(&rl)) {
4380         struct ds s;
4381
4382         ds_init(&s);
4383         odp_flow_key_format(key, key_len, &s);
4384         VLOG_WARN("unexpected flow on %s: %s", ofproto->up.name, ds_cstr(&s));
4385         ds_destroy(&s);
4386     }
4387
4388     COVERAGE_INC(facet_unexpected);
4389     dpif_flow_del(ofproto->backer->dpif, key, key_len, NULL);
4390 }
4391
4392 /* Update 'packet_count', 'byte_count', and 'used' members of installed facets.
4393  *
4394  * This function also pushes statistics updates to rules which each facet
4395  * resubmits into.  Generally these statistics will be accurate.  However, if a
4396  * facet changes the rule it resubmits into at some time in between
4397  * update_stats() runs, it is possible that statistics accrued to the
4398  * old rule will be incorrectly attributed to the new rule.  This could be
4399  * avoided by calling update_stats() whenever rules are created or
4400  * deleted.  However, the performance impact of making so many calls to the
4401  * datapath do not justify the benefit of having perfectly accurate statistics.
4402  *
4403  * In addition, this function maintains per ofproto flow hit counts. The patch
4404  * port is not treated specially. e.g. A packet ingress from br0 patched into
4405  * br1 will increase the hit count of br0 by 1, however, does not affect
4406  * the hit or miss counts of br1.
4407  */
4408 static void
4409 update_stats(struct dpif_backer *backer)
4410 {
4411     const struct dpif_flow_stats *stats;
4412     struct dpif_flow_dump dump;
4413     const struct nlattr *key;
4414     struct ofproto_dpif *ofproto;
4415     size_t key_len;
4416
4417     dpif_flow_dump_start(&dump, backer->dpif);
4418     while (dpif_flow_dump_next(&dump, &key, &key_len, NULL, NULL, &stats)) {
4419         struct flow flow;
4420         struct subfacet *subfacet;
4421         struct ofport_dpif *ofport;
4422         uint32_t key_hash;
4423
4424         if (ofproto_receive(backer, NULL, key, key_len, &flow, NULL, &ofproto,
4425                             NULL, NULL)) {
4426             continue;
4427         }
4428
4429         ofproto->total_subfacet_count += hmap_count(&ofproto->subfacets);
4430         ofproto->n_update_stats++;
4431
4432         ofport = get_ofp_port(ofproto, flow.in_port);
4433         if (ofport && ofport->tnl_port) {
4434             netdev_vport_inc_rx(ofport->up.netdev, stats);
4435         }
4436
4437         key_hash = odp_flow_key_hash(key, key_len);
4438         subfacet = subfacet_find(ofproto, key, key_len, key_hash);
4439         switch (subfacet ? subfacet->path : SF_NOT_INSTALLED) {
4440         case SF_FAST_PATH:
4441             /* Update ofproto_dpif's hit count. */
4442             if (stats->n_packets > subfacet->dp_packet_count) {
4443                 uint64_t delta = stats->n_packets - subfacet->dp_packet_count;
4444                 dpif_stats_update_hit_count(ofproto, delta);
4445             }
4446
4447             update_subfacet_stats(subfacet, stats);
4448             break;
4449
4450         case SF_SLOW_PATH:
4451             /* Stats are updated per-packet. */
4452             break;
4453
4454         case SF_NOT_INSTALLED:
4455         default:
4456             delete_unexpected_flow(ofproto, key, key_len);
4457             break;
4458         }
4459         run_fast_rl();
4460     }
4461     dpif_flow_dump_done(&dump);
4462
4463     HMAP_FOR_EACH (ofproto, all_ofproto_dpifs_node, &all_ofproto_dpifs) {
4464         update_moving_averages(ofproto);
4465     }
4466
4467 }
4468
4469 /* Calculates and returns the number of milliseconds of idle time after which
4470  * subfacets should expire from the datapath.  When a subfacet expires, we fold
4471  * its statistics into its facet, and when a facet's last subfacet expires, we
4472  * fold its statistic into its rule. */
4473 static int
4474 subfacet_max_idle(const struct ofproto_dpif *ofproto)
4475 {
4476     /*
4477      * Idle time histogram.
4478      *
4479      * Most of the time a switch has a relatively small number of subfacets.
4480      * When this is the case we might as well keep statistics for all of them
4481      * in userspace and to cache them in the kernel datapath for performance as
4482      * well.
4483      *
4484      * As the number of subfacets increases, the memory required to maintain
4485      * statistics about them in userspace and in the kernel becomes
4486      * significant.  However, with a large number of subfacets it is likely
4487      * that only a few of them are "heavy hitters" that consume a large amount
4488      * of bandwidth.  At this point, only heavy hitters are worth caching in
4489      * the kernel and maintaining in userspaces; other subfacets we can
4490      * discard.
4491      *
4492      * The technique used to compute the idle time is to build a histogram with
4493      * N_BUCKETS buckets whose width is BUCKET_WIDTH msecs each.  Each subfacet
4494      * that is installed in the kernel gets dropped in the appropriate bucket.
4495      * After the histogram has been built, we compute the cutoff so that only
4496      * the most-recently-used 1% of subfacets (but at least
4497      * ofproto->up.flow_eviction_threshold flows) are kept cached.  At least
4498      * the most-recently-used bucket of subfacets is kept, so actually an
4499      * arbitrary number of subfacets can be kept in any given expiration run
4500      * (though the next run will delete most of those unless they receive
4501      * additional data).
4502      *
4503      * This requires a second pass through the subfacets, in addition to the
4504      * pass made by update_stats(), because the former function never looks at
4505      * uninstallable subfacets.
4506      */
4507     enum { BUCKET_WIDTH = ROUND_UP(100, TIME_UPDATE_INTERVAL) };
4508     enum { N_BUCKETS = 5000 / BUCKET_WIDTH };
4509     int buckets[N_BUCKETS] = { 0 };
4510     int total, subtotal, bucket;
4511     struct subfacet *subfacet;
4512     long long int now;
4513     int i;
4514
4515     total = hmap_count(&ofproto->subfacets);
4516     if (total <= ofproto->up.flow_eviction_threshold) {
4517         return N_BUCKETS * BUCKET_WIDTH;
4518     }
4519
4520     /* Build histogram. */
4521     now = time_msec();
4522     HMAP_FOR_EACH (subfacet, hmap_node, &ofproto->subfacets) {
4523         long long int idle = now - subfacet->used;
4524         int bucket = (idle <= 0 ? 0
4525                       : idle >= BUCKET_WIDTH * N_BUCKETS ? N_BUCKETS - 1
4526                       : (unsigned int) idle / BUCKET_WIDTH);
4527         buckets[bucket]++;
4528     }
4529
4530     /* Find the first bucket whose flows should be expired. */
4531     subtotal = bucket = 0;
4532     do {
4533         subtotal += buckets[bucket++];
4534     } while (bucket < N_BUCKETS &&
4535              subtotal < MAX(ofproto->up.flow_eviction_threshold, total / 100));
4536
4537     if (VLOG_IS_DBG_ENABLED()) {
4538         struct ds s;
4539
4540         ds_init(&s);
4541         ds_put_cstr(&s, "keep");
4542         for (i = 0; i < N_BUCKETS; i++) {
4543             if (i == bucket) {
4544                 ds_put_cstr(&s, ", drop");
4545             }
4546             if (buckets[i]) {
4547                 ds_put_format(&s, " %d:%d", i * BUCKET_WIDTH, buckets[i]);
4548             }
4549         }
4550         VLOG_INFO("%s: %s (msec:count)", ofproto->up.name, ds_cstr(&s));
4551         ds_destroy(&s);
4552     }
4553
4554     return bucket * BUCKET_WIDTH;
4555 }
4556
4557 static void
4558 expire_subfacets(struct ofproto_dpif *ofproto, int dp_max_idle)
4559 {
4560     /* Cutoff time for most flows. */
4561     long long int normal_cutoff = time_msec() - dp_max_idle;
4562
4563     /* We really want to keep flows for special protocols around, so use a more
4564      * conservative cutoff. */
4565     long long int special_cutoff = time_msec() - 10000;
4566
4567     struct subfacet *subfacet, *next_subfacet;
4568     struct subfacet *batch[SUBFACET_DESTROY_MAX_BATCH];
4569     int n_batch;
4570
4571     n_batch = 0;
4572     HMAP_FOR_EACH_SAFE (subfacet, next_subfacet, hmap_node,
4573                         &ofproto->subfacets) {
4574         long long int cutoff;
4575
4576         cutoff = (subfacet->slow & (SLOW_CFM | SLOW_BFD | SLOW_LACP | SLOW_STP)
4577                   ? special_cutoff
4578                   : normal_cutoff);
4579         if (subfacet->used < cutoff) {
4580             if (subfacet->path != SF_NOT_INSTALLED) {
4581                 batch[n_batch++] = subfacet;
4582                 if (n_batch >= SUBFACET_DESTROY_MAX_BATCH) {
4583                     subfacet_destroy_batch(ofproto, batch, n_batch);
4584                     n_batch = 0;
4585                 }
4586             } else {
4587                 subfacet_destroy(subfacet);
4588             }
4589         }
4590     }
4591
4592     if (n_batch > 0) {
4593         subfacet_destroy_batch(ofproto, batch, n_batch);
4594     }
4595 }
4596
4597 /* If 'rule' is an OpenFlow rule, that has expired according to OpenFlow rules,
4598  * then delete it entirely. */
4599 static void
4600 rule_expire(struct rule_dpif *rule)
4601 {
4602     struct facet *facet, *next_facet;
4603     long long int now;
4604     uint8_t reason;
4605
4606     if (rule->up.pending) {
4607         /* We'll have to expire it later. */
4608         return;
4609     }
4610
4611     /* Has 'rule' expired? */
4612     now = time_msec();
4613     if (rule->up.hard_timeout
4614         && now > rule->up.modified + rule->up.hard_timeout * 1000) {
4615         reason = OFPRR_HARD_TIMEOUT;
4616     } else if (rule->up.idle_timeout
4617                && now > rule->up.used + rule->up.idle_timeout * 1000) {
4618         reason = OFPRR_IDLE_TIMEOUT;
4619     } else {
4620         return;
4621     }
4622
4623     COVERAGE_INC(ofproto_dpif_expired);
4624
4625     /* Update stats.  (This is a no-op if the rule expired due to an idle
4626      * timeout, because that only happens when the rule has no facets left.) */
4627     LIST_FOR_EACH_SAFE (facet, next_facet, list_node, &rule->facets) {
4628         facet_remove(facet);
4629     }
4630
4631     /* Get rid of the rule. */
4632     ofproto_rule_expire(&rule->up, reason);
4633 }
4634 \f
4635 /* Facets. */
4636
4637 /* Creates and returns a new facet owned by 'rule', given a 'flow'.
4638  *
4639  * The caller must already have determined that no facet with an identical
4640  * 'flow' exists in 'ofproto' and that 'flow' is the best match for 'rule' in
4641  * the ofproto's classifier table.
4642  *
4643  * 'hash' must be the return value of flow_hash(flow, 0).
4644  *
4645  * The facet will initially have no subfacets.  The caller should create (at
4646  * least) one subfacet with subfacet_create(). */
4647 static struct facet *
4648 facet_create(struct rule_dpif *rule, const struct flow *flow, uint32_t hash)
4649 {
4650     struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
4651     struct facet *facet;
4652
4653     facet = xzalloc(sizeof *facet);
4654     facet->used = time_msec();
4655     hmap_insert(&ofproto->facets, &facet->hmap_node, hash);
4656     list_push_back(&rule->facets, &facet->list_node);
4657     facet->rule = rule;
4658     facet->flow = *flow;
4659     list_init(&facet->subfacets);
4660     netflow_flow_init(&facet->nf_flow);
4661     netflow_flow_update_time(ofproto->netflow, &facet->nf_flow, facet->used);
4662
4663     facet->learn_rl = time_msec() + 500;
4664
4665     return facet;
4666 }
4667
4668 static void
4669 facet_free(struct facet *facet)
4670 {
4671     free(facet);
4672 }
4673
4674 /* Executes, within 'ofproto', the 'n_actions' actions in 'actions' on
4675  * 'packet', which arrived on 'in_port'. */
4676 static bool
4677 execute_odp_actions(struct ofproto_dpif *ofproto, const struct flow *flow,
4678                     const struct nlattr *odp_actions, size_t actions_len,
4679                     struct ofpbuf *packet)
4680 {
4681     struct odputil_keybuf keybuf;
4682     struct ofpbuf key;
4683     int error;
4684
4685     ofpbuf_use_stack(&key, &keybuf, sizeof keybuf);
4686     odp_flow_key_from_flow(&key, flow,
4687                            ofp_port_to_odp_port(ofproto, flow->in_port));
4688
4689     error = dpif_execute(ofproto->backer->dpif, key.data, key.size,
4690                          odp_actions, actions_len, packet);
4691     return !error;
4692 }
4693
4694 /* Remove 'facet' from 'ofproto' and free up the associated memory:
4695  *
4696  *   - If 'facet' was installed in the datapath, uninstalls it and updates its
4697  *     rule's statistics, via subfacet_uninstall().
4698  *
4699  *   - Removes 'facet' from its rule and from ofproto->facets.
4700  */
4701 static void
4702 facet_remove(struct facet *facet)
4703 {
4704     struct ofproto_dpif *ofproto = ofproto_dpif_cast(facet->rule->up.ofproto);
4705     struct subfacet *subfacet, *next_subfacet;
4706
4707     ovs_assert(!list_is_empty(&facet->subfacets));
4708
4709     /* First uninstall all of the subfacets to get final statistics. */
4710     LIST_FOR_EACH (subfacet, list_node, &facet->subfacets) {
4711         subfacet_uninstall(subfacet);
4712     }
4713
4714     /* Flush the final stats to the rule.
4715      *
4716      * This might require us to have at least one subfacet around so that we
4717      * can use its actions for accounting in facet_account(), which is why we
4718      * have uninstalled but not yet destroyed the subfacets. */
4719     facet_flush_stats(facet);
4720
4721     /* Now we're really all done so destroy everything. */
4722     LIST_FOR_EACH_SAFE (subfacet, next_subfacet, list_node,
4723                         &facet->subfacets) {
4724         subfacet_destroy__(subfacet);
4725     }
4726     hmap_remove(&ofproto->facets, &facet->hmap_node);
4727     list_remove(&facet->list_node);
4728     facet_free(facet);
4729 }
4730
4731 /* Feed information from 'facet' back into the learning table to keep it in
4732  * sync with what is actually flowing through the datapath. */
4733 static void
4734 facet_learn(struct facet *facet)
4735 {
4736     struct ofproto_dpif *ofproto = ofproto_dpif_cast(facet->rule->up.ofproto);
4737     struct subfacet *subfacet= CONTAINER_OF(list_front(&facet->subfacets),
4738                                             struct subfacet, list_node);
4739     long long int now = time_msec();
4740     struct action_xlate_ctx ctx;
4741
4742     if (!facet->has_fin_timeout && now < facet->learn_rl) {
4743         return;
4744     }
4745
4746     facet->learn_rl = now + 500;
4747
4748     if (!facet->has_learn
4749         && !facet->has_normal
4750         && (!facet->has_fin_timeout
4751             || !(facet->tcp_flags & (TCP_FIN | TCP_RST)))) {
4752         return;
4753     }
4754
4755     action_xlate_ctx_init(&ctx, ofproto, &facet->flow,
4756                           &subfacet->initial_vals,
4757                           facet->rule, facet->tcp_flags, NULL);
4758     ctx.may_learn = true;
4759     xlate_actions_for_side_effects(&ctx, facet->rule->up.ofpacts,
4760                                    facet->rule->up.ofpacts_len);
4761 }
4762
4763 static void
4764 facet_account(struct facet *facet)
4765 {
4766     struct ofproto_dpif *ofproto = ofproto_dpif_cast(facet->rule->up.ofproto);
4767     struct subfacet *subfacet = facet_get_subfacet(facet);
4768     const struct nlattr *a;
4769     unsigned int left;
4770     ovs_be16 vlan_tci;
4771     uint64_t n_bytes;
4772
4773     if (!facet->has_normal || !ofproto->has_bonded_bundles) {
4774         return;
4775     }
4776     n_bytes = facet->byte_count - facet->accounted_bytes;
4777
4778     /* This loop feeds byte counters to bond_account() for rebalancing to use
4779      * as a basis.  We also need to track the actual VLAN on which the packet
4780      * is going to be sent to ensure that it matches the one passed to
4781      * bond_choose_output_slave().  (Otherwise, we will account to the wrong
4782      * hash bucket.)
4783      *
4784      * We use the actions from an arbitrary subfacet because they should all
4785      * be equally valid for our purpose. */
4786     vlan_tci = facet->flow.vlan_tci;
4787     NL_ATTR_FOR_EACH_UNSAFE (a, left,
4788                              subfacet->actions, subfacet->actions_len) {
4789         const struct ovs_action_push_vlan *vlan;
4790         struct ofport_dpif *port;
4791
4792         switch (nl_attr_type(a)) {
4793         case OVS_ACTION_ATTR_OUTPUT:
4794             port = get_odp_port(ofproto, nl_attr_get_u32(a));
4795             if (port && port->bundle && port->bundle->bond) {
4796                 bond_account(port->bundle->bond, &facet->flow,
4797                              vlan_tci_to_vid(vlan_tci), n_bytes);
4798             }
4799             break;
4800
4801         case OVS_ACTION_ATTR_POP_VLAN:
4802             vlan_tci = htons(0);
4803             break;
4804
4805         case OVS_ACTION_ATTR_PUSH_VLAN:
4806             vlan = nl_attr_get(a);
4807             vlan_tci = vlan->vlan_tci;
4808             break;
4809         }
4810     }
4811 }
4812
4813 /* Returns true if the only action for 'facet' is to send to the controller.
4814  * (We don't report NetFlow expiration messages for such facets because they
4815  * are just part of the control logic for the network, not real traffic). */
4816 static bool
4817 facet_is_controller_flow(struct facet *facet)
4818 {
4819     if (facet) {
4820         const struct rule *rule = &facet->rule->up;
4821         const struct ofpact *ofpacts = rule->ofpacts;
4822         size_t ofpacts_len = rule->ofpacts_len;
4823
4824         if (ofpacts_len > 0 &&
4825             ofpacts->type == OFPACT_CONTROLLER &&
4826             ofpact_next(ofpacts) >= ofpact_end(ofpacts, ofpacts_len)) {
4827             return true;
4828         }
4829     }
4830     return false;
4831 }
4832
4833 /* Folds all of 'facet''s statistics into its rule.  Also updates the
4834  * accounting ofhook and emits a NetFlow expiration if appropriate.  All of
4835  * 'facet''s statistics in the datapath should have been zeroed and folded into
4836  * its packet and byte counts before this function is called. */
4837 static void
4838 facet_flush_stats(struct facet *facet)
4839 {
4840     struct ofproto_dpif *ofproto = ofproto_dpif_cast(facet->rule->up.ofproto);
4841     struct subfacet *subfacet;
4842
4843     LIST_FOR_EACH (subfacet, list_node, &facet->subfacets) {
4844         ovs_assert(!subfacet->dp_byte_count);
4845         ovs_assert(!subfacet->dp_packet_count);
4846     }
4847
4848     facet_push_stats(facet);
4849     if (facet->accounted_bytes < facet->byte_count) {
4850         facet_account(facet);
4851         facet->accounted_bytes = facet->byte_count;
4852     }
4853
4854     if (ofproto->netflow && !facet_is_controller_flow(facet)) {
4855         struct ofexpired expired;
4856         expired.flow = facet->flow;
4857         expired.packet_count = facet->packet_count;
4858         expired.byte_count = facet->byte_count;
4859         expired.used = facet->used;
4860         netflow_expire(ofproto->netflow, &facet->nf_flow, &expired);
4861     }
4862
4863     facet->rule->packet_count += facet->packet_count;
4864     facet->rule->byte_count += facet->byte_count;
4865
4866     /* Reset counters to prevent double counting if 'facet' ever gets
4867      * reinstalled. */
4868     facet_reset_counters(facet);
4869
4870     netflow_flow_clear(&facet->nf_flow);
4871     facet->tcp_flags = 0;
4872 }
4873
4874 /* Searches 'ofproto''s table of facets for one exactly equal to 'flow'.
4875  * Returns it if found, otherwise a null pointer.
4876  *
4877  * 'hash' must be the return value of flow_hash(flow, 0).
4878  *
4879  * The returned facet might need revalidation; use facet_lookup_valid()
4880  * instead if that is important. */
4881 static struct facet *
4882 facet_find(struct ofproto_dpif *ofproto,
4883            const struct flow *flow, uint32_t hash)
4884 {
4885     struct facet *facet;
4886
4887     HMAP_FOR_EACH_WITH_HASH (facet, hmap_node, hash, &ofproto->facets) {
4888         if (flow_equal(flow, &facet->flow)) {
4889             return facet;
4890         }
4891     }
4892
4893     return NULL;
4894 }
4895
4896 /* Searches 'ofproto''s table of facets for one exactly equal to 'flow'.
4897  * Returns it if found, otherwise a null pointer.
4898  *
4899  * 'hash' must be the return value of flow_hash(flow, 0).
4900  *
4901  * The returned facet is guaranteed to be valid. */
4902 static struct facet *
4903 facet_lookup_valid(struct ofproto_dpif *ofproto, const struct flow *flow,
4904                    uint32_t hash)
4905 {
4906     struct facet *facet;
4907
4908     facet = facet_find(ofproto, flow, hash);
4909     if (facet
4910         && (ofproto->backer->need_revalidate
4911             || tag_set_intersects(&ofproto->backer->revalidate_set,
4912                                   facet->tags))) {
4913         facet_revalidate(facet);
4914
4915         /* facet_revalidate() may have destroyed 'facet'. */
4916         facet = facet_find(ofproto, flow, hash);
4917     }
4918
4919     return facet;
4920 }
4921
4922 /* Return a subfacet from 'facet'.  A facet consists of one or more
4923  * subfacets, and this function returns one of them. */
4924 static struct subfacet *facet_get_subfacet(struct facet *facet)
4925 {
4926     return CONTAINER_OF(list_front(&facet->subfacets), struct subfacet,
4927                         list_node);
4928 }
4929
4930 static const char *
4931 subfacet_path_to_string(enum subfacet_path path)
4932 {
4933     switch (path) {
4934     case SF_NOT_INSTALLED:
4935         return "not installed";
4936     case SF_FAST_PATH:
4937         return "in fast path";
4938     case SF_SLOW_PATH:
4939         return "in slow path";
4940     default:
4941         return "<error>";
4942     }
4943 }
4944
4945 /* Returns the path in which a subfacet should be installed if its 'slow'
4946  * member has the specified value. */
4947 static enum subfacet_path
4948 subfacet_want_path(enum slow_path_reason slow)
4949 {
4950     return slow ? SF_SLOW_PATH : SF_FAST_PATH;
4951 }
4952
4953 /* Returns true if 'subfacet' needs to have its datapath flow updated,
4954  * supposing that its actions have been recalculated as 'want_actions' and that
4955  * 'slow' is nonzero iff 'subfacet' should be in the slow path. */
4956 static bool
4957 subfacet_should_install(struct subfacet *subfacet, enum slow_path_reason slow,
4958                         const struct ofpbuf *want_actions)
4959 {
4960     enum subfacet_path want_path = subfacet_want_path(slow);
4961     return (want_path != subfacet->path
4962             || (want_path == SF_FAST_PATH
4963                 && (subfacet->actions_len != want_actions->size
4964                     || memcmp(subfacet->actions, want_actions->data,
4965                               subfacet->actions_len))));
4966 }
4967
4968 static bool
4969 facet_check_consistency(struct facet *facet)
4970 {
4971     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 15);
4972
4973     struct ofproto_dpif *ofproto = ofproto_dpif_cast(facet->rule->up.ofproto);
4974
4975     uint64_t odp_actions_stub[1024 / 8];
4976     struct ofpbuf odp_actions;
4977
4978     struct rule_dpif *rule;
4979     struct subfacet *subfacet;
4980     bool may_log = false;
4981     bool ok;
4982
4983     /* Check the rule for consistency. */
4984     rule = rule_dpif_lookup(ofproto, &facet->flow);
4985     ok = rule == facet->rule;
4986     if (!ok) {
4987         may_log = !VLOG_DROP_WARN(&rl);
4988         if (may_log) {
4989             struct ds s;
4990
4991             ds_init(&s);
4992             flow_format(&s, &facet->flow);
4993             ds_put_format(&s, ": facet associated with wrong rule (was "
4994                           "table=%"PRIu8",", facet->rule->up.table_id);
4995             cls_rule_format(&facet->rule->up.cr, &s);
4996             ds_put_format(&s, ") (should have been table=%"PRIu8",",
4997                           rule->up.table_id);
4998             cls_rule_format(&rule->up.cr, &s);
4999             ds_put_char(&s, ')');
5000
5001             VLOG_WARN("%s", ds_cstr(&s));
5002             ds_destroy(&s);
5003         }
5004     }
5005
5006     /* Check the datapath actions for consistency. */
5007     ofpbuf_use_stub(&odp_actions, odp_actions_stub, sizeof odp_actions_stub);
5008     LIST_FOR_EACH (subfacet, list_node, &facet->subfacets) {
5009         enum subfacet_path want_path;
5010         struct action_xlate_ctx ctx;
5011         struct ds s;
5012
5013         action_xlate_ctx_init(&ctx, ofproto, &facet->flow,
5014                               &subfacet->initial_vals, rule, 0, NULL);
5015         xlate_actions(&ctx, rule->up.ofpacts, rule->up.ofpacts_len,
5016                       &odp_actions);
5017
5018         if (subfacet->path == SF_NOT_INSTALLED) {
5019             /* This only happens if the datapath reported an error when we
5020              * tried to install the flow.  Don't flag another error here. */
5021             continue;
5022         }
5023
5024         want_path = subfacet_want_path(subfacet->slow);
5025         if (want_path == SF_SLOW_PATH && subfacet->path == SF_SLOW_PATH) {
5026             /* The actions for slow-path flows may legitimately vary from one
5027              * packet to the next.  We're done. */
5028             continue;
5029         }
5030
5031         if (!subfacet_should_install(subfacet, subfacet->slow, &odp_actions)) {
5032             continue;
5033         }
5034
5035         /* Inconsistency! */
5036         if (ok) {
5037             may_log = !VLOG_DROP_WARN(&rl);
5038             ok = false;
5039         }
5040         if (!may_log) {
5041             /* Rate-limited, skip reporting. */
5042             continue;
5043         }
5044
5045         ds_init(&s);
5046         odp_flow_key_format(subfacet->key, subfacet->key_len, &s);
5047
5048         ds_put_cstr(&s, ": inconsistency in subfacet");
5049         if (want_path != subfacet->path) {
5050             enum odp_key_fitness fitness = subfacet->key_fitness;
5051
5052             ds_put_format(&s, " (%s, fitness=%s)",
5053                           subfacet_path_to_string(subfacet->path),
5054                           odp_key_fitness_to_string(fitness));
5055             ds_put_format(&s, " (should have been %s)",
5056                           subfacet_path_to_string(want_path));
5057         } else if (want_path == SF_FAST_PATH) {
5058             ds_put_cstr(&s, " (actions were: ");
5059             format_odp_actions(&s, subfacet->actions,
5060                                subfacet->actions_len);
5061             ds_put_cstr(&s, ") (correct actions: ");
5062             format_odp_actions(&s, odp_actions.data, odp_actions.size);
5063             ds_put_char(&s, ')');
5064         } else {
5065             ds_put_cstr(&s, " (actions: ");
5066             format_odp_actions(&s, subfacet->actions,
5067                                subfacet->actions_len);
5068             ds_put_char(&s, ')');
5069         }
5070         VLOG_WARN("%s", ds_cstr(&s));
5071         ds_destroy(&s);
5072     }
5073     ofpbuf_uninit(&odp_actions);
5074
5075     return ok;
5076 }
5077
5078 /* Re-searches the classifier for 'facet':
5079  *
5080  *   - If the rule found is different from 'facet''s current rule, moves
5081  *     'facet' to the new rule and recompiles its actions.
5082  *
5083  *   - If the rule found is the same as 'facet''s current rule, leaves 'facet'
5084  *     where it is and recompiles its actions anyway.
5085  *
5086  *   - If any of 'facet''s subfacets correspond to a new flow according to
5087  *     ofproto_receive(), 'facet' is removed. */
5088 static void
5089 facet_revalidate(struct facet *facet)
5090 {
5091     struct ofproto_dpif *ofproto = ofproto_dpif_cast(facet->rule->up.ofproto);
5092     struct actions {
5093         struct nlattr *odp_actions;
5094         size_t actions_len;
5095     };
5096     struct actions *new_actions;
5097
5098     struct action_xlate_ctx ctx;
5099     uint64_t odp_actions_stub[1024 / 8];
5100     struct ofpbuf odp_actions;
5101
5102     struct rule_dpif *new_rule;
5103     struct subfacet *subfacet;
5104     int i;
5105
5106     COVERAGE_INC(facet_revalidate);
5107
5108     /* Check that child subfacets still correspond to this facet.  Tunnel
5109      * configuration changes could cause a subfacet's OpenFlow in_port to
5110      * change. */
5111     LIST_FOR_EACH (subfacet, list_node, &facet->subfacets) {
5112         struct ofproto_dpif *recv_ofproto;
5113         struct flow recv_flow;
5114         int error;
5115
5116         error = ofproto_receive(ofproto->backer, NULL, subfacet->key,
5117                                 subfacet->key_len, &recv_flow, NULL,
5118                                 &recv_ofproto, NULL, NULL);
5119         if (error
5120             || recv_ofproto != ofproto
5121             || memcmp(&recv_flow, &facet->flow, sizeof recv_flow)) {
5122             facet_remove(facet);
5123             return;
5124         }
5125     }
5126
5127     new_rule = rule_dpif_lookup(ofproto, &facet->flow);
5128
5129     /* Calculate new datapath actions.
5130      *
5131      * We do not modify any 'facet' state yet, because we might need to, e.g.,
5132      * emit a NetFlow expiration and, if so, we need to have the old state
5133      * around to properly compose it. */
5134
5135     /* If the datapath actions changed or the installability changed,
5136      * then we need to talk to the datapath. */
5137     i = 0;
5138     new_actions = NULL;
5139     memset(&ctx, 0, sizeof ctx);
5140     ofpbuf_use_stub(&odp_actions, odp_actions_stub, sizeof odp_actions_stub);
5141     LIST_FOR_EACH (subfacet, list_node, &facet->subfacets) {
5142         enum slow_path_reason slow;
5143
5144         action_xlate_ctx_init(&ctx, ofproto, &facet->flow,
5145                               &subfacet->initial_vals, new_rule, 0, NULL);
5146         xlate_actions(&ctx, new_rule->up.ofpacts, new_rule->up.ofpacts_len,
5147                       &odp_actions);
5148
5149         slow = (subfacet->slow & SLOW_MATCH) | ctx.slow;
5150         if (subfacet_should_install(subfacet, slow, &odp_actions)) {
5151             struct dpif_flow_stats stats;
5152
5153             subfacet_install(subfacet,
5154                              odp_actions.data, odp_actions.size, &stats, slow);
5155             subfacet_update_stats(subfacet, &stats);
5156
5157             if (!new_actions) {
5158                 new_actions = xcalloc(list_size(&facet->subfacets),
5159                                       sizeof *new_actions);
5160             }
5161             new_actions[i].odp_actions = xmemdup(odp_actions.data,
5162                                                  odp_actions.size);
5163             new_actions[i].actions_len = odp_actions.size;
5164         }
5165
5166         i++;
5167     }
5168     ofpbuf_uninit(&odp_actions);
5169
5170     if (new_actions) {
5171         facet_flush_stats(facet);
5172     }
5173
5174     /* Update 'facet' now that we've taken care of all the old state. */
5175     facet->tags = ctx.tags;
5176     facet->nf_flow.output_iface = ctx.nf_output_iface;
5177     facet->has_learn = ctx.has_learn;
5178     facet->has_normal = ctx.has_normal;
5179     facet->has_fin_timeout = ctx.has_fin_timeout;
5180     facet->mirrors = ctx.mirrors;
5181
5182     i = 0;
5183     LIST_FOR_EACH (subfacet, list_node, &facet->subfacets) {
5184         subfacet->slow = (subfacet->slow & SLOW_MATCH) | ctx.slow;
5185
5186         if (new_actions && new_actions[i].odp_actions) {
5187             free(subfacet->actions);
5188             subfacet->actions = new_actions[i].odp_actions;
5189             subfacet->actions_len = new_actions[i].actions_len;
5190         }
5191         i++;
5192     }
5193     free(new_actions);
5194
5195     if (facet->rule != new_rule) {
5196         COVERAGE_INC(facet_changed_rule);
5197         list_remove(&facet->list_node);
5198         list_push_back(&new_rule->facets, &facet->list_node);
5199         facet->rule = new_rule;
5200         facet->used = new_rule->up.created;
5201         facet->prev_used = facet->used;
5202     }
5203 }
5204
5205 /* Updates 'facet''s used time.  Caller is responsible for calling
5206  * facet_push_stats() to update the flows which 'facet' resubmits into. */
5207 static void
5208 facet_update_time(struct facet *facet, long long int used)
5209 {
5210     struct ofproto_dpif *ofproto = ofproto_dpif_cast(facet->rule->up.ofproto);
5211     if (used > facet->used) {
5212         facet->used = used;
5213         ofproto_rule_update_used(&facet->rule->up, used);
5214         netflow_flow_update_time(ofproto->netflow, &facet->nf_flow, used);
5215     }
5216 }
5217
5218 static void
5219 facet_reset_counters(struct facet *facet)
5220 {
5221     facet->packet_count = 0;
5222     facet->byte_count = 0;
5223     facet->prev_packet_count = 0;
5224     facet->prev_byte_count = 0;
5225     facet->accounted_bytes = 0;
5226 }
5227
5228 static void
5229 facet_push_stats(struct facet *facet)
5230 {
5231     struct dpif_flow_stats stats;
5232
5233     ovs_assert(facet->packet_count >= facet->prev_packet_count);
5234     ovs_assert(facet->byte_count >= facet->prev_byte_count);
5235     ovs_assert(facet->used >= facet->prev_used);
5236
5237     stats.n_packets = facet->packet_count - facet->prev_packet_count;
5238     stats.n_bytes = facet->byte_count - facet->prev_byte_count;
5239     stats.used = facet->used;
5240     stats.tcp_flags = 0;
5241
5242     if (stats.n_packets || stats.n_bytes || facet->used > facet->prev_used) {
5243         facet->prev_packet_count = facet->packet_count;
5244         facet->prev_byte_count = facet->byte_count;
5245         facet->prev_used = facet->used;
5246
5247         flow_push_stats(facet, &stats);
5248
5249         update_mirror_stats(ofproto_dpif_cast(facet->rule->up.ofproto),
5250                             facet->mirrors, stats.n_packets, stats.n_bytes);
5251     }
5252 }
5253
5254 static void
5255 push_all_stats__(bool run_fast)
5256 {
5257     static long long int rl = LLONG_MIN;
5258     struct ofproto_dpif *ofproto;
5259
5260     if (time_msec() < rl) {
5261         return;
5262     }
5263
5264     HMAP_FOR_EACH (ofproto, all_ofproto_dpifs_node, &all_ofproto_dpifs) {
5265         struct facet *facet;
5266
5267         HMAP_FOR_EACH (facet, hmap_node, &ofproto->facets) {
5268             facet_push_stats(facet);
5269             if (run_fast) {
5270                 run_fast_rl();
5271             }
5272         }
5273     }
5274
5275     rl = time_msec() + 100;
5276 }
5277
5278 static void
5279 push_all_stats(void)
5280 {
5281     push_all_stats__(true);
5282 }
5283
5284 static void
5285 rule_credit_stats(struct rule_dpif *rule, const struct dpif_flow_stats *stats)
5286 {
5287     rule->packet_count += stats->n_packets;
5288     rule->byte_count += stats->n_bytes;
5289     ofproto_rule_update_used(&rule->up, stats->used);
5290 }
5291
5292 /* Pushes flow statistics to the rules which 'facet->flow' resubmits
5293  * into given 'facet->rule''s actions and mirrors. */
5294 static void
5295 flow_push_stats(struct facet *facet, const struct dpif_flow_stats *stats)
5296 {
5297     struct rule_dpif *rule = facet->rule;
5298     struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
5299     struct subfacet *subfacet = facet_get_subfacet(facet);
5300     struct action_xlate_ctx ctx;
5301
5302     ofproto_rule_update_used(&rule->up, stats->used);
5303
5304     action_xlate_ctx_init(&ctx, ofproto, &facet->flow,
5305                           &subfacet->initial_vals, rule, 0, NULL);
5306     ctx.resubmit_stats = stats;
5307     xlate_actions_for_side_effects(&ctx, rule->up.ofpacts,
5308                                    rule->up.ofpacts_len);
5309 }
5310 \f
5311 /* Subfacets. */
5312
5313 static struct subfacet *
5314 subfacet_find(struct ofproto_dpif *ofproto,
5315               const struct nlattr *key, size_t key_len, uint32_t key_hash)
5316 {
5317     struct subfacet *subfacet;
5318
5319     HMAP_FOR_EACH_WITH_HASH (subfacet, hmap_node, key_hash,
5320                              &ofproto->subfacets) {
5321         if (subfacet->key_len == key_len
5322             && !memcmp(key, subfacet->key, key_len)) {
5323             return subfacet;
5324         }
5325     }
5326
5327     return NULL;
5328 }
5329
5330 /* Searches 'facet' (within 'ofproto') for a subfacet with the specified
5331  * 'key_fitness', 'key', and 'key_len' members in 'miss'.  Returns the
5332  * existing subfacet if there is one, otherwise creates and returns a
5333  * new subfacet.
5334  *
5335  * If the returned subfacet is new, then subfacet->actions will be NULL, in
5336  * which case the caller must populate the actions with
5337  * subfacet_make_actions(). */
5338 static struct subfacet *
5339 subfacet_create(struct facet *facet, struct flow_miss *miss,
5340                 long long int now)
5341 {
5342     struct ofproto_dpif *ofproto = ofproto_dpif_cast(facet->rule->up.ofproto);
5343     enum odp_key_fitness key_fitness = miss->key_fitness;
5344     const struct nlattr *key = miss->key;
5345     size_t key_len = miss->key_len;
5346     uint32_t key_hash;
5347     struct subfacet *subfacet;
5348
5349     key_hash = odp_flow_key_hash(key, key_len);
5350
5351     if (list_is_empty(&facet->subfacets)) {
5352         subfacet = &facet->one_subfacet;
5353     } else {
5354         subfacet = subfacet_find(ofproto, key, key_len, key_hash);
5355         if (subfacet) {
5356             if (subfacet->facet == facet) {
5357                 return subfacet;
5358             }
5359
5360             /* This shouldn't happen. */
5361             VLOG_ERR_RL(&rl, "subfacet with wrong facet");
5362             subfacet_destroy(subfacet);
5363         }
5364
5365         subfacet = xmalloc(sizeof *subfacet);
5366     }
5367
5368     hmap_insert(&ofproto->subfacets, &subfacet->hmap_node, key_hash);
5369     list_push_back(&facet->subfacets, &subfacet->list_node);
5370     subfacet->facet = facet;
5371     subfacet->key_fitness = key_fitness;
5372     subfacet->key = xmemdup(key, key_len);
5373     subfacet->key_len = key_len;
5374     subfacet->used = now;
5375     subfacet->created = now;
5376     subfacet->dp_packet_count = 0;
5377     subfacet->dp_byte_count = 0;
5378     subfacet->actions_len = 0;
5379     subfacet->actions = NULL;
5380     subfacet->slow = (subfacet->key_fitness == ODP_FIT_TOO_LITTLE
5381                       ? SLOW_MATCH
5382                       : 0);
5383     subfacet->path = SF_NOT_INSTALLED;
5384     subfacet->initial_vals = miss->initial_vals;
5385     subfacet->odp_in_port = miss->odp_in_port;
5386
5387     ofproto->subfacet_add_count++;
5388     return subfacet;
5389 }
5390
5391 /* Uninstalls 'subfacet' from the datapath, if it is installed, removes it from
5392  * its facet within 'ofproto', and frees it. */
5393 static void
5394 subfacet_destroy__(struct subfacet *subfacet)
5395 {
5396     struct facet *facet = subfacet->facet;
5397     struct ofproto_dpif *ofproto = ofproto_dpif_cast(facet->rule->up.ofproto);
5398
5399     /* Update ofproto stats before uninstall the subfacet. */
5400     ofproto->subfacet_del_count++;
5401     ofproto->total_subfacet_life_span += (time_msec() - subfacet->created);
5402
5403     subfacet_uninstall(subfacet);
5404     hmap_remove(&ofproto->subfacets, &subfacet->hmap_node);
5405     list_remove(&subfacet->list_node);
5406     free(subfacet->key);
5407     free(subfacet->actions);
5408     if (subfacet != &facet->one_subfacet) {
5409         free(subfacet);
5410     }
5411 }
5412
5413 /* Destroys 'subfacet', as with subfacet_destroy__(), and then if this was the
5414  * last remaining subfacet in its facet destroys the facet too. */
5415 static void
5416 subfacet_destroy(struct subfacet *subfacet)
5417 {
5418     struct facet *facet = subfacet->facet;
5419
5420     if (list_is_singleton(&facet->subfacets)) {
5421         /* facet_remove() needs at least one subfacet (it will remove it). */
5422         facet_remove(facet);
5423     } else {
5424         subfacet_destroy__(subfacet);
5425     }
5426 }
5427
5428 static void
5429 subfacet_destroy_batch(struct ofproto_dpif *ofproto,
5430                        struct subfacet **subfacets, int n)
5431 {
5432     struct dpif_op ops[SUBFACET_DESTROY_MAX_BATCH];
5433     struct dpif_op *opsp[SUBFACET_DESTROY_MAX_BATCH];
5434     struct dpif_flow_stats stats[SUBFACET_DESTROY_MAX_BATCH];
5435     int i;
5436
5437     for (i = 0; i < n; i++) {
5438         ops[i].type = DPIF_OP_FLOW_DEL;
5439         ops[i].u.flow_del.key = subfacets[i]->key;
5440         ops[i].u.flow_del.key_len = subfacets[i]->key_len;
5441         ops[i].u.flow_del.stats = &stats[i];
5442         opsp[i] = &ops[i];
5443     }
5444
5445     dpif_operate(ofproto->backer->dpif, opsp, n);
5446     for (i = 0; i < n; i++) {
5447         subfacet_reset_dp_stats(subfacets[i], &stats[i]);
5448         subfacets[i]->path = SF_NOT_INSTALLED;
5449         subfacet_destroy(subfacets[i]);
5450         run_fast_rl();
5451     }
5452 }
5453
5454 /* Composes the datapath actions for 'subfacet' based on its rule's actions.
5455  * Translates the actions into 'odp_actions', which the caller must have
5456  * initialized and is responsible for uninitializing. */
5457 static void
5458 subfacet_make_actions(struct subfacet *subfacet, const struct ofpbuf *packet,
5459                       struct ofpbuf *odp_actions)
5460 {
5461     struct facet *facet = subfacet->facet;
5462     struct rule_dpif *rule = facet->rule;
5463     struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
5464
5465     struct action_xlate_ctx ctx;
5466
5467     action_xlate_ctx_init(&ctx, ofproto, &facet->flow,
5468                           &subfacet->initial_vals, rule, 0, packet);
5469     xlate_actions(&ctx, rule->up.ofpacts, rule->up.ofpacts_len, odp_actions);
5470     facet->tags = ctx.tags;
5471     facet->has_learn = ctx.has_learn;
5472     facet->has_normal = ctx.has_normal;
5473     facet->has_fin_timeout = ctx.has_fin_timeout;
5474     facet->nf_flow.output_iface = ctx.nf_output_iface;
5475     facet->mirrors = ctx.mirrors;
5476
5477     subfacet->slow = (subfacet->slow & SLOW_MATCH) | ctx.slow;
5478     if (subfacet->actions_len != odp_actions->size
5479         || memcmp(subfacet->actions, odp_actions->data, odp_actions->size)) {
5480         free(subfacet->actions);
5481         subfacet->actions_len = odp_actions->size;
5482         subfacet->actions = xmemdup(odp_actions->data, odp_actions->size);
5483     }
5484 }
5485
5486 /* Updates 'subfacet''s datapath flow, setting its actions to 'actions_len'
5487  * bytes of actions in 'actions'.  If 'stats' is non-null, statistics counters
5488  * in the datapath will be zeroed and 'stats' will be updated with traffic new
5489  * since 'subfacet' was last updated.
5490  *
5491  * Returns 0 if successful, otherwise a positive errno value. */
5492 static int
5493 subfacet_install(struct subfacet *subfacet,
5494                  const struct nlattr *actions, size_t actions_len,
5495                  struct dpif_flow_stats *stats,
5496                  enum slow_path_reason slow)
5497 {
5498     struct facet *facet = subfacet->facet;
5499     struct ofproto_dpif *ofproto = ofproto_dpif_cast(facet->rule->up.ofproto);
5500     enum subfacet_path path = subfacet_want_path(slow);
5501     uint64_t slow_path_stub[128 / 8];
5502     enum dpif_flow_put_flags flags;
5503     int ret;
5504
5505     flags = DPIF_FP_CREATE | DPIF_FP_MODIFY;
5506     if (stats) {
5507         flags |= DPIF_FP_ZERO_STATS;
5508     }
5509
5510     if (path == SF_SLOW_PATH) {
5511         compose_slow_path(ofproto, &facet->flow, slow,
5512                           slow_path_stub, sizeof slow_path_stub,
5513                           &actions, &actions_len);
5514     }
5515
5516     ret = dpif_flow_put(ofproto->backer->dpif, flags, subfacet->key,
5517                         subfacet->key_len, actions, actions_len, stats);
5518
5519     if (stats) {
5520         subfacet_reset_dp_stats(subfacet, stats);
5521     }
5522
5523     if (!ret) {
5524         subfacet->path = path;
5525     }
5526     return ret;
5527 }
5528
5529 static int
5530 subfacet_reinstall(struct subfacet *subfacet, struct dpif_flow_stats *stats)
5531 {
5532     return subfacet_install(subfacet, subfacet->actions, subfacet->actions_len,
5533                             stats, subfacet->slow);
5534 }
5535
5536 /* If 'subfacet' is installed in the datapath, uninstalls it. */
5537 static void
5538 subfacet_uninstall(struct subfacet *subfacet)
5539 {
5540     if (subfacet->path != SF_NOT_INSTALLED) {
5541         struct rule_dpif *rule = subfacet->facet->rule;
5542         struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
5543         struct dpif_flow_stats stats;
5544         int error;
5545
5546         error = dpif_flow_del(ofproto->backer->dpif, subfacet->key,
5547                               subfacet->key_len, &stats);
5548         subfacet_reset_dp_stats(subfacet, &stats);
5549         if (!error) {
5550             subfacet_update_stats(subfacet, &stats);
5551         }
5552         subfacet->path = SF_NOT_INSTALLED;
5553     } else {
5554         ovs_assert(subfacet->dp_packet_count == 0);
5555         ovs_assert(subfacet->dp_byte_count == 0);
5556     }
5557 }
5558
5559 /* Resets 'subfacet''s datapath statistics counters.  This should be called
5560  * when 'subfacet''s statistics are cleared in the datapath.  If 'stats' is
5561  * non-null, it should contain the statistics returned by dpif when 'subfacet'
5562  * was reset in the datapath.  'stats' will be modified to include only
5563  * statistics new since 'subfacet' was last updated. */
5564 static void
5565 subfacet_reset_dp_stats(struct subfacet *subfacet,
5566                         struct dpif_flow_stats *stats)
5567 {
5568     if (stats
5569         && subfacet->dp_packet_count <= stats->n_packets
5570         && subfacet->dp_byte_count <= stats->n_bytes) {
5571         stats->n_packets -= subfacet->dp_packet_count;
5572         stats->n_bytes -= subfacet->dp_byte_count;
5573     }
5574
5575     subfacet->dp_packet_count = 0;
5576     subfacet->dp_byte_count = 0;
5577 }
5578
5579 /* Updates 'subfacet''s used time.  The caller is responsible for calling
5580  * facet_push_stats() to update the flows which 'subfacet' resubmits into. */
5581 static void
5582 subfacet_update_time(struct subfacet *subfacet, long long int used)
5583 {
5584     if (used > subfacet->used) {
5585         subfacet->used = used;
5586         facet_update_time(subfacet->facet, used);
5587     }
5588 }
5589
5590 /* Folds the statistics from 'stats' into the counters in 'subfacet'.
5591  *
5592  * Because of the meaning of a subfacet's counters, it only makes sense to do
5593  * this if 'stats' are not tracked in the datapath, that is, if 'stats'
5594  * represents a packet that was sent by hand or if it represents statistics
5595  * that have been cleared out of the datapath. */
5596 static void
5597 subfacet_update_stats(struct subfacet *subfacet,
5598                       const struct dpif_flow_stats *stats)
5599 {
5600     if (stats->n_packets || stats->used > subfacet->used) {
5601         struct facet *facet = subfacet->facet;
5602
5603         subfacet_update_time(subfacet, stats->used);
5604         facet->packet_count += stats->n_packets;
5605         facet->byte_count += stats->n_bytes;
5606         facet->tcp_flags |= stats->tcp_flags;
5607         netflow_flow_update_flags(&facet->nf_flow, stats->tcp_flags);
5608     }
5609 }
5610 \f
5611 /* Rules. */
5612
5613 static struct rule_dpif *
5614 rule_dpif_lookup(struct ofproto_dpif *ofproto, const struct flow *flow)
5615 {
5616     struct rule_dpif *rule;
5617
5618     rule = rule_dpif_lookup__(ofproto, flow, 0);
5619     if (rule) {
5620         return rule;
5621     }
5622
5623     return rule_dpif_miss_rule(ofproto, flow);
5624 }
5625
5626 static struct rule_dpif *
5627 rule_dpif_lookup__(struct ofproto_dpif *ofproto, const struct flow *flow,
5628                    uint8_t table_id)
5629 {
5630     struct cls_rule *cls_rule;
5631     struct classifier *cls;
5632
5633     if (table_id >= N_TABLES) {
5634         return NULL;
5635     }
5636
5637     cls = &ofproto->up.tables[table_id].cls;
5638     if (flow->nw_frag & FLOW_NW_FRAG_ANY
5639         && ofproto->up.frag_handling == OFPC_FRAG_NORMAL) {
5640         /* For OFPC_NORMAL frag_handling, we must pretend that transport ports
5641          * are unavailable. */
5642         struct flow ofpc_normal_flow = *flow;
5643         ofpc_normal_flow.tp_src = htons(0);
5644         ofpc_normal_flow.tp_dst = htons(0);
5645         cls_rule = classifier_lookup(cls, &ofpc_normal_flow);
5646     } else {
5647         cls_rule = classifier_lookup(cls, flow);
5648     }
5649     return rule_dpif_cast(rule_from_cls_rule(cls_rule));
5650 }
5651
5652 static struct rule_dpif *
5653 rule_dpif_miss_rule(struct ofproto_dpif *ofproto, const struct flow *flow)
5654 {
5655     struct ofport_dpif *port;
5656
5657     port = get_ofp_port(ofproto, flow->in_port);
5658     if (!port) {
5659         VLOG_WARN_RL(&rl, "packet-in on unknown port %"PRIu16, flow->in_port);
5660         return ofproto->miss_rule;
5661     }
5662
5663     if (port->up.pp.config & OFPUTIL_PC_NO_PACKET_IN) {
5664         return ofproto->no_packet_in_rule;
5665     }
5666     return ofproto->miss_rule;
5667 }
5668
5669 static void
5670 complete_operation(struct rule_dpif *rule)
5671 {
5672     struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
5673
5674     rule_invalidate(rule);
5675     if (clogged) {
5676         struct dpif_completion *c = xmalloc(sizeof *c);
5677         c->op = rule->up.pending;
5678         list_push_back(&ofproto->completions, &c->list_node);
5679     } else {
5680         ofoperation_complete(rule->up.pending, 0);
5681     }
5682 }
5683
5684 static struct rule *
5685 rule_alloc(void)
5686 {
5687     struct rule_dpif *rule = xmalloc(sizeof *rule);
5688     return &rule->up;
5689 }
5690
5691 static void
5692 rule_dealloc(struct rule *rule_)
5693 {
5694     struct rule_dpif *rule = rule_dpif_cast(rule_);
5695     free(rule);
5696 }
5697
5698 static enum ofperr
5699 rule_construct(struct rule *rule_)
5700 {
5701     struct rule_dpif *rule = rule_dpif_cast(rule_);
5702     struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
5703     struct rule_dpif *victim;
5704     uint8_t table_id;
5705
5706     rule->packet_count = 0;
5707     rule->byte_count = 0;
5708
5709     victim = rule_dpif_cast(ofoperation_get_victim(rule->up.pending));
5710     if (victim && !list_is_empty(&victim->facets)) {
5711         struct facet *facet;
5712
5713         rule->facets = victim->facets;
5714         list_moved(&rule->facets);
5715         LIST_FOR_EACH (facet, list_node, &rule->facets) {
5716             /* XXX: We're only clearing our local counters here.  It's possible
5717              * that quite a few packets are unaccounted for in the datapath
5718              * statistics.  These will be accounted to the new rule instead of
5719              * cleared as required.  This could be fixed by clearing out the
5720              * datapath statistics for this facet, but currently it doesn't
5721              * seem worth it. */
5722             facet_reset_counters(facet);
5723             facet->rule = rule;
5724         }
5725     } else {
5726         /* Must avoid list_moved() in this case. */
5727         list_init(&rule->facets);
5728     }
5729
5730     table_id = rule->up.table_id;
5731     if (victim) {
5732         rule->tag = victim->tag;
5733     } else if (table_id == 0) {
5734         rule->tag = 0;
5735     } else {
5736         struct flow flow;
5737
5738         miniflow_expand(&rule->up.cr.match.flow, &flow);
5739         rule->tag = rule_calculate_tag(&flow, &rule->up.cr.match.mask,
5740                                        ofproto->tables[table_id].basis);
5741     }
5742
5743     complete_operation(rule);
5744     return 0;
5745 }
5746
5747 static void
5748 rule_destruct(struct rule *rule_)
5749 {
5750     struct rule_dpif *rule = rule_dpif_cast(rule_);
5751     struct facet *facet, *next_facet;
5752
5753     LIST_FOR_EACH_SAFE (facet, next_facet, list_node, &rule->facets) {
5754         facet_revalidate(facet);
5755     }
5756
5757     complete_operation(rule);
5758 }
5759
5760 static void
5761 rule_get_stats(struct rule *rule_, uint64_t *packets, uint64_t *bytes)
5762 {
5763     struct rule_dpif *rule = rule_dpif_cast(rule_);
5764     struct facet *facet;
5765
5766     /* push_all_stats() can handle flow misses which, when using the learn
5767      * action, can cause rules to be added and deleted.  This can corrupt our
5768      * caller's datastructures which assume that rule_get_stats() doesn't have
5769      * an impact on the flow table. To be safe, we disable miss handling. */
5770     push_all_stats__(false);
5771
5772     /* Start from historical data for 'rule' itself that are no longer tracked
5773      * in facets.  This counts, for example, facets that have expired. */
5774     *packets = rule->packet_count;
5775     *bytes = rule->byte_count;
5776
5777     /* Add any statistics that are tracked by facets.  This includes
5778      * statistical data recently updated by ofproto_update_stats() as well as
5779      * stats for packets that were executed "by hand" via dpif_execute(). */
5780     LIST_FOR_EACH (facet, list_node, &rule->facets) {
5781         *packets += facet->packet_count;
5782         *bytes += facet->byte_count;
5783     }
5784 }
5785
5786 static void
5787 rule_dpif_execute(struct rule_dpif *rule, const struct flow *flow,
5788                   struct ofpbuf *packet)
5789 {
5790     struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
5791     struct initial_vals initial_vals;
5792     struct dpif_flow_stats stats;
5793     struct action_xlate_ctx ctx;
5794     uint64_t odp_actions_stub[1024 / 8];
5795     struct ofpbuf odp_actions;
5796
5797     dpif_flow_stats_extract(flow, packet, time_msec(), &stats);
5798     rule_credit_stats(rule, &stats);
5799
5800     initial_vals.vlan_tci = flow->vlan_tci;
5801     ofpbuf_use_stub(&odp_actions, odp_actions_stub, sizeof odp_actions_stub);
5802     action_xlate_ctx_init(&ctx, ofproto, flow, &initial_vals,
5803                           rule, stats.tcp_flags, packet);
5804     ctx.resubmit_stats = &stats;
5805     xlate_actions(&ctx, rule->up.ofpacts, rule->up.ofpacts_len, &odp_actions);
5806
5807     execute_odp_actions(ofproto, flow, odp_actions.data,
5808                         odp_actions.size, packet);
5809
5810     ofpbuf_uninit(&odp_actions);
5811 }
5812
5813 static enum ofperr
5814 rule_execute(struct rule *rule, const struct flow *flow,
5815              struct ofpbuf *packet)
5816 {
5817     rule_dpif_execute(rule_dpif_cast(rule), flow, packet);
5818     ofpbuf_delete(packet);
5819     return 0;
5820 }
5821
5822 static void
5823 rule_modify_actions(struct rule *rule_)
5824 {
5825     struct rule_dpif *rule = rule_dpif_cast(rule_);
5826
5827     complete_operation(rule);
5828 }
5829 \f
5830 /* Sends 'packet' out 'ofport'.
5831  * May modify 'packet'.
5832  * Returns 0 if successful, otherwise a positive errno value. */
5833 static int
5834 send_packet(const struct ofport_dpif *ofport, struct ofpbuf *packet)
5835 {
5836     const struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofport->up.ofproto);
5837     uint64_t odp_actions_stub[1024 / 8];
5838     struct ofpbuf key, odp_actions;
5839     struct odputil_keybuf keybuf;
5840     uint32_t odp_port;
5841     struct flow flow;
5842     int error;
5843
5844     flow_extract(packet, 0, 0, NULL, OFPP_LOCAL, &flow);
5845     if (netdev_vport_is_patch(ofport->up.netdev)) {
5846         struct ofproto_dpif *peer_ofproto;
5847         struct dpif_flow_stats stats;
5848         struct ofport_dpif *peer;
5849         struct rule_dpif *rule;
5850
5851         peer = ofport_get_peer(ofport);
5852         if (!peer) {
5853             return ENODEV;
5854         }
5855
5856         dpif_flow_stats_extract(&flow, packet, time_msec(), &stats);
5857         netdev_vport_inc_tx(ofport->up.netdev, &stats);
5858         netdev_vport_inc_rx(peer->up.netdev, &stats);
5859
5860         flow.in_port = peer->up.ofp_port;
5861         peer_ofproto = ofproto_dpif_cast(peer->up.ofproto);
5862         rule = rule_dpif_lookup(peer_ofproto, &flow);
5863         rule_dpif_execute(rule, &flow, packet);
5864
5865         return 0;
5866     }
5867
5868     ofpbuf_use_stub(&odp_actions, odp_actions_stub, sizeof odp_actions_stub);
5869
5870     if (ofport->tnl_port) {
5871         struct dpif_flow_stats stats;
5872
5873         odp_port = tnl_port_send(ofport->tnl_port, &flow);
5874         if (odp_port == OVSP_NONE) {
5875             return ENODEV;
5876         }
5877
5878         dpif_flow_stats_extract(&flow, packet, time_msec(), &stats);
5879         netdev_vport_inc_tx(ofport->up.netdev, &stats);
5880         odp_put_tunnel_action(&flow.tunnel, &odp_actions);
5881         odp_put_skb_mark_action(flow.skb_mark, &odp_actions);
5882     } else {
5883         odp_port = vsp_realdev_to_vlandev(ofproto, ofport->odp_port,
5884                                           flow.vlan_tci);
5885         if (odp_port != ofport->odp_port) {
5886             eth_pop_vlan(packet);
5887             flow.vlan_tci = htons(0);
5888         }
5889     }
5890
5891     ofpbuf_use_stack(&key, &keybuf, sizeof keybuf);
5892     odp_flow_key_from_flow(&key, &flow,
5893                            ofp_port_to_odp_port(ofproto, flow.in_port));
5894
5895     compose_sflow_action(ofproto, &odp_actions, &flow, odp_port);
5896     compose_ipfix_action(ofproto, &odp_actions, &flow);
5897
5898     nl_msg_put_u32(&odp_actions, OVS_ACTION_ATTR_OUTPUT, odp_port);
5899     error = dpif_execute(ofproto->backer->dpif,
5900                          key.data, key.size,
5901                          odp_actions.data, odp_actions.size,
5902                          packet);
5903     ofpbuf_uninit(&odp_actions);
5904
5905     if (error) {
5906         VLOG_WARN_RL(&rl, "%s: failed to send packet on port %"PRIu32" (%s)",
5907                      ofproto->up.name, odp_port, strerror(error));
5908     }
5909     ofproto_update_local_port_stats(ofport->up.ofproto, packet->size, 0);
5910     return error;
5911 }
5912 \f
5913 /* OpenFlow to datapath action translation. */
5914
5915 static bool may_receive(const struct ofport_dpif *, struct action_xlate_ctx *);
5916 static void do_xlate_actions(const struct ofpact *, size_t ofpacts_len,
5917                              struct action_xlate_ctx *);
5918 static void xlate_normal(struct action_xlate_ctx *);
5919
5920 /* Composes an ODP action for a "slow path" action for 'flow' within 'ofproto'.
5921  * The action will state 'slow' as the reason that the action is in the slow
5922  * path.  (This is purely informational: it allows a human viewing "ovs-dpctl
5923  * dump-flows" output to see why a flow is in the slow path.)
5924  *
5925  * The 'stub_size' bytes in 'stub' will be used to store the action.
5926  * 'stub_size' must be large enough for the action.
5927  *
5928  * The action and its size will be stored in '*actionsp' and '*actions_lenp',
5929  * respectively. */
5930 static void
5931 compose_slow_path(const struct ofproto_dpif *ofproto, const struct flow *flow,
5932                   enum slow_path_reason slow,
5933                   uint64_t *stub, size_t stub_size,
5934                   const struct nlattr **actionsp, size_t *actions_lenp)
5935 {
5936     union user_action_cookie cookie;
5937     struct ofpbuf buf;
5938
5939     cookie.type = USER_ACTION_COOKIE_SLOW_PATH;
5940     cookie.slow_path.unused = 0;
5941     cookie.slow_path.reason = slow;
5942
5943     ofpbuf_use_stack(&buf, stub, stub_size);
5944     if (slow & (SLOW_CFM | SLOW_BFD | SLOW_LACP | SLOW_STP)) {
5945         uint32_t pid = dpif_port_get_pid(ofproto->backer->dpif, UINT32_MAX);
5946         odp_put_userspace_action(pid, &cookie, sizeof cookie.slow_path, &buf);
5947     } else {
5948         put_userspace_action(ofproto, &buf, flow, &cookie,
5949                              sizeof cookie.slow_path);
5950     }
5951     *actionsp = buf.data;
5952     *actions_lenp = buf.size;
5953 }
5954
5955 static size_t
5956 put_userspace_action(const struct ofproto_dpif *ofproto,
5957                      struct ofpbuf *odp_actions,
5958                      const struct flow *flow,
5959                      const union user_action_cookie *cookie,
5960                      const size_t cookie_size)
5961 {
5962     uint32_t pid;
5963
5964     pid = dpif_port_get_pid(ofproto->backer->dpif,
5965                             ofp_port_to_odp_port(ofproto, flow->in_port));
5966
5967     return odp_put_userspace_action(pid, cookie, cookie_size, odp_actions);
5968 }
5969
5970 /* Compose SAMPLE action for sFlow or IPFIX.  The given probability is
5971  * the number of packets out of UINT32_MAX to sample.  The given
5972  * cookie is passed back in the callback for each sampled packet.
5973  */
5974 static size_t
5975 compose_sample_action(const struct ofproto_dpif *ofproto,
5976                       struct ofpbuf *odp_actions,
5977                       const struct flow *flow,
5978                       const uint32_t probability,
5979                       const union user_action_cookie *cookie,
5980                       const size_t cookie_size)
5981 {
5982     size_t sample_offset, actions_offset;
5983     int cookie_offset;
5984
5985     sample_offset = nl_msg_start_nested(odp_actions, OVS_ACTION_ATTR_SAMPLE);
5986
5987     nl_msg_put_u32(odp_actions, OVS_SAMPLE_ATTR_PROBABILITY, probability);
5988
5989     actions_offset = nl_msg_start_nested(odp_actions, OVS_SAMPLE_ATTR_ACTIONS);
5990     cookie_offset = put_userspace_action(ofproto, odp_actions, flow, cookie,
5991                                          cookie_size);
5992
5993     nl_msg_end_nested(odp_actions, actions_offset);
5994     nl_msg_end_nested(odp_actions, sample_offset);
5995     return cookie_offset;
5996 }
5997
5998 static void
5999 compose_sflow_cookie(const struct ofproto_dpif *ofproto,
6000                      ovs_be16 vlan_tci, uint32_t odp_port,
6001                      unsigned int n_outputs, union user_action_cookie *cookie)
6002 {
6003     int ifindex;
6004
6005     cookie->type = USER_ACTION_COOKIE_SFLOW;
6006     cookie->sflow.vlan_tci = vlan_tci;
6007
6008     /* See http://www.sflow.org/sflow_version_5.txt (search for "Input/output
6009      * port information") for the interpretation of cookie->output. */
6010     switch (n_outputs) {
6011     case 0:
6012         /* 0x40000000 | 256 means "packet dropped for unknown reason". */
6013         cookie->sflow.output = 0x40000000 | 256;
6014         break;
6015
6016     case 1:
6017         ifindex = dpif_sflow_odp_port_to_ifindex(ofproto->sflow, odp_port);
6018         if (ifindex) {
6019             cookie->sflow.output = ifindex;
6020             break;
6021         }
6022         /* Fall through. */
6023     default:
6024         /* 0x80000000 means "multiple output ports. */
6025         cookie->sflow.output = 0x80000000 | n_outputs;
6026         break;
6027     }
6028 }
6029
6030 /* Compose SAMPLE action for sFlow bridge sampling. */
6031 static size_t
6032 compose_sflow_action(const struct ofproto_dpif *ofproto,
6033                      struct ofpbuf *odp_actions,
6034                      const struct flow *flow,
6035                      uint32_t odp_port)
6036 {
6037     uint32_t probability;
6038     union user_action_cookie cookie;
6039
6040     if (!ofproto->sflow || flow->in_port == OFPP_NONE) {
6041         return 0;
6042     }
6043
6044     probability = dpif_sflow_get_probability(ofproto->sflow);
6045     compose_sflow_cookie(ofproto, htons(0), odp_port,
6046                          odp_port == OVSP_NONE ? 0 : 1, &cookie);
6047
6048     return compose_sample_action(ofproto, odp_actions, flow,  probability,
6049                                  &cookie, sizeof cookie.sflow);
6050 }
6051
6052 static void
6053 compose_flow_sample_cookie(uint16_t probability, uint32_t collector_set_id,
6054                            uint32_t obs_domain_id, uint32_t obs_point_id,
6055                            union user_action_cookie *cookie)
6056 {
6057     cookie->type = USER_ACTION_COOKIE_FLOW_SAMPLE;
6058     cookie->flow_sample.probability = probability;
6059     cookie->flow_sample.collector_set_id = collector_set_id;
6060     cookie->flow_sample.obs_domain_id = obs_domain_id;
6061     cookie->flow_sample.obs_point_id = obs_point_id;
6062 }
6063
6064 static void
6065 compose_ipfix_cookie(union user_action_cookie *cookie)
6066 {
6067     cookie->type = USER_ACTION_COOKIE_IPFIX;
6068 }
6069
6070 /* Compose SAMPLE action for IPFIX bridge sampling. */
6071 static void
6072 compose_ipfix_action(const struct ofproto_dpif *ofproto,
6073                      struct ofpbuf *odp_actions,
6074                      const struct flow *flow)
6075 {
6076     uint32_t probability;
6077     union user_action_cookie cookie;
6078
6079     if (!ofproto->ipfix || flow->in_port == OFPP_NONE) {
6080         return;
6081     }
6082
6083     probability = dpif_ipfix_get_bridge_exporter_probability(ofproto->ipfix);
6084     compose_ipfix_cookie(&cookie);
6085
6086     compose_sample_action(ofproto, odp_actions, flow,  probability,
6087                           &cookie, sizeof cookie.ipfix);
6088 }
6089
6090 /* SAMPLE action for sFlow must be first action in any given list of
6091  * actions.  At this point we do not have all information required to
6092  * build it. So try to build sample action as complete as possible. */
6093 static void
6094 add_sflow_action(struct action_xlate_ctx *ctx)
6095 {
6096     ctx->user_cookie_offset = compose_sflow_action(ctx->ofproto,
6097                                                    ctx->odp_actions,
6098                                                    &ctx->flow, OVSP_NONE);
6099     ctx->sflow_odp_port = 0;
6100     ctx->sflow_n_outputs = 0;
6101 }
6102
6103 /* SAMPLE action for IPFIX must be 1st or 2nd action in any given list
6104  * of actions, eventually after the SAMPLE action for sFlow. */
6105 static void
6106 add_ipfix_action(struct action_xlate_ctx *ctx)
6107 {
6108     compose_ipfix_action(ctx->ofproto, ctx->odp_actions, &ctx->flow);
6109 }
6110
6111 /* Fix SAMPLE action according to data collected while composing ODP actions.
6112  * We need to fix SAMPLE actions OVS_SAMPLE_ATTR_ACTIONS attribute, i.e. nested
6113  * USERSPACE action's user-cookie which is required for sflow. */
6114 static void
6115 fix_sflow_action(struct action_xlate_ctx *ctx)
6116 {
6117     const struct flow *base = &ctx->base_flow;
6118     union user_action_cookie *cookie;
6119
6120     if (!ctx->user_cookie_offset) {
6121         return;
6122     }
6123
6124     cookie = ofpbuf_at(ctx->odp_actions, ctx->user_cookie_offset,
6125                        sizeof cookie->sflow);
6126     ovs_assert(cookie->type == USER_ACTION_COOKIE_SFLOW);
6127
6128     compose_sflow_cookie(ctx->ofproto, base->vlan_tci,
6129                          ctx->sflow_odp_port, ctx->sflow_n_outputs, cookie);
6130 }
6131
6132 static void
6133 compose_output_action__(struct action_xlate_ctx *ctx, uint16_t ofp_port,
6134                         bool check_stp)
6135 {
6136     const struct ofport_dpif *ofport = get_ofp_port(ctx->ofproto, ofp_port);
6137     ovs_be16 flow_vlan_tci;
6138     uint32_t flow_skb_mark;
6139     uint8_t flow_nw_tos;
6140     struct priority_to_dscp *pdscp;
6141     uint32_t out_port, odp_port;
6142
6143     /* If 'struct flow' gets additional metadata, we'll need to zero it out
6144      * before traversing a patch port. */
6145     BUILD_ASSERT_DECL(FLOW_WC_SEQ == 20);
6146
6147     if (!ofport) {
6148         xlate_report(ctx, "Nonexistent output port");
6149         return;
6150     } else if (ofport->up.pp.config & OFPUTIL_PC_NO_FWD) {
6151         xlate_report(ctx, "OFPPC_NO_FWD set, skipping output");
6152         return;
6153     } else if (check_stp && !stp_forward_in_state(ofport->stp_state)) {
6154         xlate_report(ctx, "STP not in forwarding state, skipping output");
6155         return;
6156     }
6157
6158     if (netdev_vport_is_patch(ofport->up.netdev)) {
6159         struct ofport_dpif *peer = ofport_get_peer(ofport);
6160         struct flow old_flow = ctx->flow;
6161         const struct ofproto_dpif *peer_ofproto;
6162         enum slow_path_reason special;
6163         struct ofport_dpif *in_port;
6164
6165         if (!peer) {
6166             xlate_report(ctx, "Nonexistent patch port peer");
6167             return;
6168         }
6169
6170         peer_ofproto = ofproto_dpif_cast(peer->up.ofproto);
6171         if (peer_ofproto->backer != ctx->ofproto->backer) {
6172             xlate_report(ctx, "Patch port peer on a different datapath");
6173             return;
6174         }
6175
6176         ctx->ofproto = ofproto_dpif_cast(peer->up.ofproto);
6177         ctx->flow.in_port = peer->up.ofp_port;
6178         ctx->flow.metadata = htonll(0);
6179         memset(&ctx->flow.tunnel, 0, sizeof ctx->flow.tunnel);
6180         memset(ctx->flow.regs, 0, sizeof ctx->flow.regs);
6181
6182         in_port = get_ofp_port(ctx->ofproto, ctx->flow.in_port);
6183         special = process_special(ctx->ofproto, &ctx->flow, in_port,
6184                                   ctx->packet);
6185         if (special) {
6186             ctx->slow |= special;
6187         } else if (!in_port || may_receive(in_port, ctx)) {
6188             if (!in_port || stp_forward_in_state(in_port->stp_state)) {
6189                 xlate_table_action(ctx, ctx->flow.in_port, 0, true);
6190             } else {
6191                 /* Forwarding is disabled by STP.  Let OFPP_NORMAL and the
6192                  * learning action look at the packet, then drop it. */
6193                 struct flow old_base_flow = ctx->base_flow;
6194                 size_t old_size = ctx->odp_actions->size;
6195                 xlate_table_action(ctx, ctx->flow.in_port, 0, true);
6196                 ctx->base_flow = old_base_flow;
6197                 ctx->odp_actions->size = old_size;
6198             }
6199         }
6200
6201         ctx->flow = old_flow;
6202         ctx->ofproto = ofproto_dpif_cast(ofport->up.ofproto);
6203
6204         if (ctx->resubmit_stats) {
6205             netdev_vport_inc_tx(ofport->up.netdev, ctx->resubmit_stats);
6206             netdev_vport_inc_rx(peer->up.netdev, ctx->resubmit_stats);
6207         }
6208
6209         return;
6210     }
6211
6212     flow_vlan_tci = ctx->flow.vlan_tci;
6213     flow_skb_mark = ctx->flow.skb_mark;
6214     flow_nw_tos = ctx->flow.nw_tos;
6215
6216     pdscp = get_priority(ofport, ctx->flow.skb_priority);
6217     if (pdscp) {
6218         ctx->flow.nw_tos &= ~IP_DSCP_MASK;
6219         ctx->flow.nw_tos |= pdscp->dscp;
6220     }
6221
6222     if (ofport->tnl_port) {
6223          /* Save tunnel metadata so that changes made due to
6224           * the Logical (tunnel) Port are not visible for any further
6225           * matches, while explicit set actions on tunnel metadata are.
6226           */
6227         struct flow_tnl flow_tnl = ctx->flow.tunnel;
6228         odp_port = tnl_port_send(ofport->tnl_port, &ctx->flow);
6229         if (odp_port == OVSP_NONE) {
6230             xlate_report(ctx, "Tunneling decided against output");
6231             goto out; /* restore flow_nw_tos */
6232         }
6233
6234         if (ctx->resubmit_stats) {
6235             netdev_vport_inc_tx(ofport->up.netdev, ctx->resubmit_stats);
6236         }
6237         out_port = odp_port;
6238         commit_odp_tunnel_action(&ctx->flow, &ctx->base_flow,
6239                                  ctx->odp_actions);
6240         ctx->flow.tunnel = flow_tnl; /* Restore tunnel metadata */
6241     } else {
6242         odp_port = ofport->odp_port;
6243         out_port = vsp_realdev_to_vlandev(ctx->ofproto, odp_port,
6244                                           ctx->flow.vlan_tci);
6245         if (out_port != odp_port) {
6246             ctx->flow.vlan_tci = htons(0);
6247         }
6248         ctx->flow.skb_mark &= ~IPSEC_MARK;
6249     }
6250     commit_odp_actions(&ctx->flow, &ctx->base_flow, ctx->odp_actions);
6251     nl_msg_put_u32(ctx->odp_actions, OVS_ACTION_ATTR_OUTPUT, out_port);
6252
6253     ctx->sflow_odp_port = odp_port;
6254     ctx->sflow_n_outputs++;
6255     ctx->nf_output_iface = ofp_port;
6256
6257     /* Restore flow */
6258     ctx->flow.vlan_tci = flow_vlan_tci;
6259     ctx->flow.skb_mark = flow_skb_mark;
6260  out:
6261     ctx->flow.nw_tos = flow_nw_tos;
6262 }
6263
6264 static void
6265 compose_output_action(struct action_xlate_ctx *ctx, uint16_t ofp_port)
6266 {
6267     compose_output_action__(ctx, ofp_port, true);
6268 }
6269
6270 static void
6271 tag_the_flow(struct action_xlate_ctx *ctx, struct rule_dpif *rule)
6272 {
6273     struct ofproto_dpif *ofproto = ctx->ofproto;
6274     uint8_t table_id = ctx->table_id;
6275
6276     if (table_id > 0 && table_id < N_TABLES) {
6277         struct table_dpif *table = &ofproto->tables[table_id];
6278         if (table->other_table) {
6279             ctx->tags |= (rule && rule->tag
6280                           ? rule->tag
6281                           : rule_calculate_tag(&ctx->flow,
6282                                                &table->other_table->mask,
6283                                                table->basis));
6284         }
6285     }
6286 }
6287
6288 /* Common rule processing in one place to avoid duplicating code. */
6289 static struct rule_dpif *
6290 ctx_rule_hooks(struct action_xlate_ctx *ctx, struct rule_dpif *rule,
6291                bool may_packet_in)
6292 {
6293     if (ctx->resubmit_hook) {
6294         ctx->resubmit_hook(ctx, rule);
6295     }
6296     if (rule == NULL && may_packet_in) {
6297         /* XXX
6298          * check if table configuration flags
6299          * OFPTC_TABLE_MISS_CONTROLLER, default.
6300          * OFPTC_TABLE_MISS_CONTINUE,
6301          * OFPTC_TABLE_MISS_DROP
6302          * When OF1.0, OFPTC_TABLE_MISS_CONTINUE is used. What to do?
6303          */
6304         rule = rule_dpif_miss_rule(ctx->ofproto, &ctx->flow);
6305     }
6306     if (rule && ctx->resubmit_stats) {
6307         rule_credit_stats(rule, ctx->resubmit_stats);
6308     }
6309     return rule;
6310 }
6311
6312 static void
6313 xlate_table_action(struct action_xlate_ctx *ctx,
6314                    uint16_t in_port, uint8_t table_id, bool may_packet_in)
6315 {
6316     if (ctx->recurse < MAX_RESUBMIT_RECURSION) {
6317         struct rule_dpif *rule;
6318         uint16_t old_in_port = ctx->flow.in_port;
6319         uint8_t old_table_id = ctx->table_id;
6320
6321         ctx->table_id = table_id;
6322
6323         /* Look up a flow with 'in_port' as the input port. */
6324         ctx->flow.in_port = in_port;
6325         rule = rule_dpif_lookup__(ctx->ofproto, &ctx->flow, table_id);
6326
6327         tag_the_flow(ctx, rule);
6328
6329         /* Restore the original input port.  Otherwise OFPP_NORMAL and
6330          * OFPP_IN_PORT will have surprising behavior. */
6331         ctx->flow.in_port = old_in_port;
6332
6333         rule = ctx_rule_hooks(ctx, rule, may_packet_in);
6334
6335         if (rule) {
6336             struct rule_dpif *old_rule = ctx->rule;
6337
6338             ctx->recurse++;
6339             ctx->rule = rule;
6340             do_xlate_actions(rule->up.ofpacts, rule->up.ofpacts_len, ctx);
6341             ctx->rule = old_rule;
6342             ctx->recurse--;
6343         }
6344
6345         ctx->table_id = old_table_id;
6346     } else {
6347         static struct vlog_rate_limit recurse_rl = VLOG_RATE_LIMIT_INIT(1, 1);
6348
6349         VLOG_ERR_RL(&recurse_rl, "resubmit actions recursed over %d times",
6350                     MAX_RESUBMIT_RECURSION);
6351         ctx->max_resubmit_trigger = true;
6352     }
6353 }
6354
6355 static void
6356 xlate_ofpact_resubmit(struct action_xlate_ctx *ctx,
6357                       const struct ofpact_resubmit *resubmit)
6358 {
6359     uint16_t in_port;
6360     uint8_t table_id;
6361
6362     in_port = resubmit->in_port;
6363     if (in_port == OFPP_IN_PORT) {
6364         in_port = ctx->flow.in_port;
6365     }
6366
6367     table_id = resubmit->table_id;
6368     if (table_id == 255) {
6369         table_id = ctx->table_id;
6370     }
6371
6372     xlate_table_action(ctx, in_port, table_id, false);
6373 }
6374
6375 static void
6376 flood_packets(struct action_xlate_ctx *ctx, bool all)
6377 {
6378     struct ofport_dpif *ofport;
6379
6380     HMAP_FOR_EACH (ofport, up.hmap_node, &ctx->ofproto->up.ports) {
6381         uint16_t ofp_port = ofport->up.ofp_port;
6382
6383         if (ofp_port == ctx->flow.in_port) {
6384             continue;
6385         }
6386
6387         if (all) {
6388             compose_output_action__(ctx, ofp_port, false);
6389         } else if (!(ofport->up.pp.config & OFPUTIL_PC_NO_FLOOD)) {
6390             compose_output_action(ctx, ofp_port);
6391         }
6392     }
6393
6394     ctx->nf_output_iface = NF_OUT_FLOOD;
6395 }
6396
6397 static void
6398 execute_controller_action(struct action_xlate_ctx *ctx, int len,
6399                           enum ofp_packet_in_reason reason,
6400                           uint16_t controller_id)
6401 {
6402     struct ofputil_packet_in pin;
6403     struct ofpbuf *packet;
6404
6405     ctx->slow |= SLOW_CONTROLLER;
6406     if (!ctx->packet) {
6407         return;
6408     }
6409
6410     packet = ofpbuf_clone(ctx->packet);
6411
6412     if (packet->l2 && packet->l3) {
6413         struct eth_header *eh;
6414         uint16_t mpls_depth;
6415
6416         eth_pop_vlan(packet);
6417         eh = packet->l2;
6418
6419         memcpy(eh->eth_src, ctx->flow.dl_src, sizeof eh->eth_src);
6420         memcpy(eh->eth_dst, ctx->flow.dl_dst, sizeof eh->eth_dst);
6421
6422         if (ctx->flow.vlan_tci & htons(VLAN_CFI)) {
6423             eth_push_vlan(packet, ctx->flow.vlan_tci);
6424         }
6425
6426         mpls_depth = eth_mpls_depth(packet);
6427
6428         if (mpls_depth < ctx->flow.mpls_depth) {
6429             push_mpls(packet, ctx->flow.dl_type, ctx->flow.mpls_lse);
6430         } else if (mpls_depth > ctx->flow.mpls_depth) {
6431             pop_mpls(packet, ctx->flow.dl_type);
6432         } else if (mpls_depth) {
6433             set_mpls_lse(packet, ctx->flow.mpls_lse);
6434         }
6435
6436         if (packet->l4) {
6437             if (ctx->flow.dl_type == htons(ETH_TYPE_IP)) {
6438                 packet_set_ipv4(packet, ctx->flow.nw_src, ctx->flow.nw_dst,
6439                                 ctx->flow.nw_tos, ctx->flow.nw_ttl);
6440             }
6441
6442             if (packet->l7) {
6443                 if (ctx->flow.nw_proto == IPPROTO_TCP) {
6444                     packet_set_tcp_port(packet, ctx->flow.tp_src,
6445                                         ctx->flow.tp_dst);
6446                 } else if (ctx->flow.nw_proto == IPPROTO_UDP) {
6447                     packet_set_udp_port(packet, ctx->flow.tp_src,
6448                                         ctx->flow.tp_dst);
6449                 }
6450             }
6451         }
6452     }
6453
6454     pin.packet = packet->data;
6455     pin.packet_len = packet->size;
6456     pin.reason = reason;
6457     pin.controller_id = controller_id;
6458     pin.table_id = ctx->table_id;
6459     pin.cookie = ctx->rule ? ctx->rule->up.flow_cookie : 0;
6460
6461     pin.send_len = len;
6462     flow_get_metadata(&ctx->flow, &pin.fmd);
6463
6464     connmgr_send_packet_in(ctx->ofproto->up.connmgr, &pin);
6465     ofpbuf_delete(packet);
6466 }
6467
6468 static void
6469 execute_mpls_push_action(struct action_xlate_ctx *ctx, ovs_be16 eth_type)
6470 {
6471     ovs_assert(eth_type_mpls(eth_type));
6472
6473     if (ctx->base_flow.mpls_depth) {
6474         ctx->flow.mpls_lse &= ~htonl(MPLS_BOS_MASK);
6475         ctx->flow.mpls_depth++;
6476     } else {
6477         ovs_be32 label;
6478         uint8_t tc, ttl;
6479
6480         if (ctx->flow.dl_type == htons(ETH_TYPE_IPV6)) {
6481             label = htonl(0x2); /* IPV6 Explicit Null. */
6482         } else {
6483             label = htonl(0x0); /* IPV4 Explicit Null. */
6484         }
6485         tc = (ctx->flow.nw_tos & IP_DSCP_MASK) >> 2;
6486         ttl = ctx->flow.nw_ttl ? ctx->flow.nw_ttl : 0x40;
6487         ctx->flow.mpls_lse = set_mpls_lse_values(ttl, tc, 1, label);
6488         ctx->flow.mpls_depth = 1;
6489     }
6490     ctx->flow.dl_type = eth_type;
6491 }
6492
6493 static void
6494 execute_mpls_pop_action(struct action_xlate_ctx *ctx, ovs_be16 eth_type)
6495 {
6496     ovs_assert(eth_type_mpls(ctx->flow.dl_type));
6497     ovs_assert(!eth_type_mpls(eth_type));
6498
6499     if (ctx->flow.mpls_depth) {
6500         ctx->flow.mpls_depth--;
6501         ctx->flow.mpls_lse = htonl(0);
6502         if (!ctx->flow.mpls_depth) {
6503             ctx->flow.dl_type = eth_type;
6504         }
6505     }
6506 }
6507
6508 static bool
6509 compose_dec_ttl(struct action_xlate_ctx *ctx, struct ofpact_cnt_ids *ids)
6510 {
6511     if (ctx->flow.dl_type != htons(ETH_TYPE_IP) &&
6512         ctx->flow.dl_type != htons(ETH_TYPE_IPV6)) {
6513         return false;
6514     }
6515
6516     if (ctx->flow.nw_ttl > 1) {
6517         ctx->flow.nw_ttl--;
6518         return false;
6519     } else {
6520         size_t i;
6521
6522         for (i = 0; i < ids->n_controllers; i++) {
6523             execute_controller_action(ctx, UINT16_MAX, OFPR_INVALID_TTL,
6524                                       ids->cnt_ids[i]);
6525         }
6526
6527         /* Stop processing for current table. */
6528         return true;
6529     }
6530 }
6531
6532 static bool
6533 execute_set_mpls_ttl_action(struct action_xlate_ctx *ctx, uint8_t ttl)
6534 {
6535     if (!eth_type_mpls(ctx->flow.dl_type)) {
6536         return true;
6537     }
6538
6539     set_mpls_lse_ttl(&ctx->flow.mpls_lse, ttl);
6540     return false;
6541 }
6542
6543 static bool
6544 execute_dec_mpls_ttl_action(struct action_xlate_ctx *ctx)
6545 {
6546     uint8_t ttl = mpls_lse_to_ttl(ctx->flow.mpls_lse);
6547
6548     if (!eth_type_mpls(ctx->flow.dl_type)) {
6549         return false;
6550     }
6551
6552     if (ttl > 1) {
6553         ttl--;
6554         set_mpls_lse_ttl(&ctx->flow.mpls_lse, ttl);
6555         return false;
6556     } else {
6557         execute_controller_action(ctx, UINT16_MAX, OFPR_INVALID_TTL, 0);
6558
6559         /* Stop processing for current table. */
6560         return true;
6561     }
6562 }
6563
6564 static void
6565 xlate_output_action(struct action_xlate_ctx *ctx,
6566                     uint16_t port, uint16_t max_len, bool may_packet_in)
6567 {
6568     uint16_t prev_nf_output_iface = ctx->nf_output_iface;
6569
6570     ctx->nf_output_iface = NF_OUT_DROP;
6571
6572     switch (port) {
6573     case OFPP_IN_PORT:
6574         compose_output_action(ctx, ctx->flow.in_port);
6575         break;
6576     case OFPP_TABLE:
6577         xlate_table_action(ctx, ctx->flow.in_port, 0, may_packet_in);
6578         break;
6579     case OFPP_NORMAL:
6580         xlate_normal(ctx);
6581         break;
6582     case OFPP_FLOOD:
6583         flood_packets(ctx,  false);
6584         break;
6585     case OFPP_ALL:
6586         flood_packets(ctx, true);
6587         break;
6588     case OFPP_CONTROLLER:
6589         execute_controller_action(ctx, max_len, OFPR_ACTION, 0);
6590         break;
6591     case OFPP_NONE:
6592         break;
6593     case OFPP_LOCAL:
6594     default:
6595         if (port != ctx->flow.in_port) {
6596             compose_output_action(ctx, port);
6597         } else {
6598             xlate_report(ctx, "skipping output to input port");
6599         }
6600         break;
6601     }
6602
6603     if (prev_nf_output_iface == NF_OUT_FLOOD) {
6604         ctx->nf_output_iface = NF_OUT_FLOOD;
6605     } else if (ctx->nf_output_iface == NF_OUT_DROP) {
6606         ctx->nf_output_iface = prev_nf_output_iface;
6607     } else if (prev_nf_output_iface != NF_OUT_DROP &&
6608                ctx->nf_output_iface != NF_OUT_FLOOD) {
6609         ctx->nf_output_iface = NF_OUT_MULTI;
6610     }
6611 }
6612
6613 static void
6614 xlate_output_reg_action(struct action_xlate_ctx *ctx,
6615                         const struct ofpact_output_reg *or)
6616 {
6617     uint64_t port = mf_get_subfield(&or->src, &ctx->flow);
6618     if (port <= UINT16_MAX) {
6619         xlate_output_action(ctx, port, or->max_len, false);
6620     }
6621 }
6622
6623 static void
6624 xlate_enqueue_action(struct action_xlate_ctx *ctx,
6625                      const struct ofpact_enqueue *enqueue)
6626 {
6627     uint16_t ofp_port = enqueue->port;
6628     uint32_t queue_id = enqueue->queue;
6629     uint32_t flow_priority, priority;
6630     int error;
6631
6632     /* Translate queue to priority. */
6633     error = dpif_queue_to_priority(ctx->ofproto->backer->dpif,
6634                                    queue_id, &priority);
6635     if (error) {
6636         /* Fall back to ordinary output action. */
6637         xlate_output_action(ctx, enqueue->port, 0, false);
6638         return;
6639     }
6640
6641     /* Check output port. */
6642     if (ofp_port == OFPP_IN_PORT) {
6643         ofp_port = ctx->flow.in_port;
6644     } else if (ofp_port == ctx->flow.in_port) {
6645         return;
6646     }
6647
6648     /* Add datapath actions. */
6649     flow_priority = ctx->flow.skb_priority;
6650     ctx->flow.skb_priority = priority;
6651     compose_output_action(ctx, ofp_port);
6652     ctx->flow.skb_priority = flow_priority;
6653
6654     /* Update NetFlow output port. */
6655     if (ctx->nf_output_iface == NF_OUT_DROP) {
6656         ctx->nf_output_iface = ofp_port;
6657     } else if (ctx->nf_output_iface != NF_OUT_FLOOD) {
6658         ctx->nf_output_iface = NF_OUT_MULTI;
6659     }
6660 }
6661
6662 static void
6663 xlate_set_queue_action(struct action_xlate_ctx *ctx, uint32_t queue_id)
6664 {
6665     uint32_t skb_priority;
6666
6667     if (!dpif_queue_to_priority(ctx->ofproto->backer->dpif,
6668                                 queue_id, &skb_priority)) {
6669         ctx->flow.skb_priority = skb_priority;
6670     } else {
6671         /* Couldn't translate queue to a priority.  Nothing to do.  A warning
6672          * has already been logged. */
6673     }
6674 }
6675
6676 static bool
6677 slave_enabled_cb(uint16_t ofp_port, void *ofproto_)
6678 {
6679     struct ofproto_dpif *ofproto = ofproto_;
6680     struct ofport_dpif *port;
6681
6682     switch (ofp_port) {
6683     case OFPP_IN_PORT:
6684     case OFPP_TABLE:
6685     case OFPP_NORMAL:
6686     case OFPP_FLOOD:
6687     case OFPP_ALL:
6688     case OFPP_NONE:
6689         return true;
6690     case OFPP_CONTROLLER: /* Not supported by the bundle action. */
6691         return false;
6692     default:
6693         port = get_ofp_port(ofproto, ofp_port);
6694         return port ? port->may_enable : false;
6695     }
6696 }
6697
6698 static void
6699 xlate_bundle_action(struct action_xlate_ctx *ctx,
6700                     const struct ofpact_bundle *bundle)
6701 {
6702     uint16_t port;
6703
6704     port = bundle_execute(bundle, &ctx->flow, slave_enabled_cb, ctx->ofproto);
6705     if (bundle->dst.field) {
6706         nxm_reg_load(&bundle->dst, port, &ctx->flow);
6707     } else {
6708         xlate_output_action(ctx, port, 0, false);
6709     }
6710 }
6711
6712 static void
6713 xlate_learn_action(struct action_xlate_ctx *ctx,
6714                    const struct ofpact_learn *learn)
6715 {
6716     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 1);
6717     struct ofputil_flow_mod fm;
6718     uint64_t ofpacts_stub[1024 / 8];
6719     struct ofpbuf ofpacts;
6720     int error;
6721
6722     ofpbuf_use_stack(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
6723     learn_execute(learn, &ctx->flow, &fm, &ofpacts);
6724
6725     error = ofproto_flow_mod(&ctx->ofproto->up, &fm);
6726     if (error && !VLOG_DROP_WARN(&rl)) {
6727         VLOG_WARN("learning action failed to modify flow table (%s)",
6728                   ofperr_get_name(error));
6729     }
6730
6731     ofpbuf_uninit(&ofpacts);
6732 }
6733
6734 /* Reduces '*timeout' to no more than 'max'.  A value of zero in either case
6735  * means "infinite". */
6736 static void
6737 reduce_timeout(uint16_t max, uint16_t *timeout)
6738 {
6739     if (max && (!*timeout || *timeout > max)) {
6740         *timeout = max;
6741     }
6742 }
6743
6744 static void
6745 xlate_fin_timeout(struct action_xlate_ctx *ctx,
6746                   const struct ofpact_fin_timeout *oft)
6747 {
6748     if (ctx->tcp_flags & (TCP_FIN | TCP_RST) && ctx->rule) {
6749         struct rule_dpif *rule = ctx->rule;
6750
6751         reduce_timeout(oft->fin_idle_timeout, &rule->up.idle_timeout);
6752         reduce_timeout(oft->fin_hard_timeout, &rule->up.hard_timeout);
6753     }
6754 }
6755
6756 static void
6757 xlate_sample_action(struct action_xlate_ctx *ctx,
6758                     const struct ofpact_sample *os)
6759 {
6760   union user_action_cookie cookie;
6761   /* Scale the probability from 16-bit to 32-bit while representing
6762    * the same percentage. */
6763   uint32_t probability = (os->probability << 16) | os->probability;
6764
6765   commit_odp_actions(&ctx->flow, &ctx->base_flow, ctx->odp_actions);
6766
6767   compose_flow_sample_cookie(os->probability, os->collector_set_id,
6768                              os->obs_domain_id, os->obs_point_id, &cookie);
6769   compose_sample_action(ctx->ofproto, ctx->odp_actions, &ctx->flow,
6770                         probability, &cookie, sizeof cookie.flow_sample);
6771 }
6772
6773 static bool
6774 may_receive(const struct ofport_dpif *port, struct action_xlate_ctx *ctx)
6775 {
6776     if (port->up.pp.config & (eth_addr_equals(ctx->flow.dl_dst, eth_addr_stp)
6777                               ? OFPUTIL_PC_NO_RECV_STP
6778                               : OFPUTIL_PC_NO_RECV)) {
6779         return false;
6780     }
6781
6782     /* Only drop packets here if both forwarding and learning are
6783      * disabled.  If just learning is enabled, we need to have
6784      * OFPP_NORMAL and the learning action have a look at the packet
6785      * before we can drop it. */
6786     if (!stp_forward_in_state(port->stp_state)
6787             && !stp_learn_in_state(port->stp_state)) {
6788         return false;
6789     }
6790
6791     return true;
6792 }
6793
6794 static bool
6795 tunnel_ecn_ok(struct action_xlate_ctx *ctx)
6796 {
6797     if (is_ip_any(&ctx->base_flow)
6798         && (ctx->flow.tunnel.ip_tos & IP_ECN_MASK) == IP_ECN_CE) {
6799         if ((ctx->base_flow.nw_tos & IP_ECN_MASK) == IP_ECN_NOT_ECT) {
6800             VLOG_WARN_RL(&rl, "dropping tunnel packet marked ECN CE"
6801                          " but is not ECN capable");
6802             return false;
6803         } else {
6804             /* Set the ECN CE value in the tunneled packet. */
6805             ctx->flow.nw_tos |= IP_ECN_CE;
6806         }
6807     }
6808
6809     return true;
6810 }
6811
6812 static void
6813 do_xlate_actions(const struct ofpact *ofpacts, size_t ofpacts_len,
6814                  struct action_xlate_ctx *ctx)
6815 {
6816     bool was_evictable = true;
6817     const struct ofpact *a;
6818
6819     if (ctx->rule) {
6820         /* Don't let the rule we're working on get evicted underneath us. */
6821         was_evictable = ctx->rule->up.evictable;
6822         ctx->rule->up.evictable = false;
6823     }
6824
6825  do_xlate_actions_again:
6826     OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
6827         struct ofpact_controller *controller;
6828         const struct ofpact_metadata *metadata;
6829
6830         if (ctx->exit) {
6831             break;
6832         }
6833
6834         switch (a->type) {
6835         case OFPACT_OUTPUT:
6836             xlate_output_action(ctx, ofpact_get_OUTPUT(a)->port,
6837                                 ofpact_get_OUTPUT(a)->max_len, true);
6838             break;
6839
6840         case OFPACT_CONTROLLER:
6841             controller = ofpact_get_CONTROLLER(a);
6842             execute_controller_action(ctx, controller->max_len,
6843                                       controller->reason,
6844                                       controller->controller_id);
6845             break;
6846
6847         case OFPACT_ENQUEUE:
6848             xlate_enqueue_action(ctx, ofpact_get_ENQUEUE(a));
6849             break;
6850
6851         case OFPACT_SET_VLAN_VID:
6852             ctx->flow.vlan_tci &= ~htons(VLAN_VID_MASK);
6853             ctx->flow.vlan_tci |= (htons(ofpact_get_SET_VLAN_VID(a)->vlan_vid)
6854                                    | htons(VLAN_CFI));
6855             break;
6856
6857         case OFPACT_SET_VLAN_PCP:
6858             ctx->flow.vlan_tci &= ~htons(VLAN_PCP_MASK);
6859             ctx->flow.vlan_tci |= htons((ofpact_get_SET_VLAN_PCP(a)->vlan_pcp
6860                                          << VLAN_PCP_SHIFT)
6861                                         | VLAN_CFI);
6862             break;
6863
6864         case OFPACT_STRIP_VLAN:
6865             ctx->flow.vlan_tci = htons(0);
6866             break;
6867
6868         case OFPACT_PUSH_VLAN:
6869             /* XXX 802.1AD(QinQ) */
6870             ctx->flow.vlan_tci = htons(VLAN_CFI);
6871             break;
6872
6873         case OFPACT_SET_ETH_SRC:
6874             memcpy(ctx->flow.dl_src, ofpact_get_SET_ETH_SRC(a)->mac,
6875                    ETH_ADDR_LEN);
6876             break;
6877
6878         case OFPACT_SET_ETH_DST:
6879             memcpy(ctx->flow.dl_dst, ofpact_get_SET_ETH_DST(a)->mac,
6880                    ETH_ADDR_LEN);
6881             break;
6882
6883         case OFPACT_SET_IPV4_SRC:
6884             if (ctx->flow.dl_type == htons(ETH_TYPE_IP)) {
6885                 ctx->flow.nw_src = ofpact_get_SET_IPV4_SRC(a)->ipv4;
6886             }
6887             break;
6888
6889         case OFPACT_SET_IPV4_DST:
6890             if (ctx->flow.dl_type == htons(ETH_TYPE_IP)) {
6891                 ctx->flow.nw_dst = ofpact_get_SET_IPV4_DST(a)->ipv4;
6892             }
6893             break;
6894
6895         case OFPACT_SET_IPV4_DSCP:
6896             /* OpenFlow 1.0 only supports IPv4. */
6897             if (ctx->flow.dl_type == htons(ETH_TYPE_IP)) {
6898                 ctx->flow.nw_tos &= ~IP_DSCP_MASK;
6899                 ctx->flow.nw_tos |= ofpact_get_SET_IPV4_DSCP(a)->dscp;
6900             }
6901             break;
6902
6903         case OFPACT_SET_L4_SRC_PORT:
6904             if (is_ip_any(&ctx->flow)) {
6905                 ctx->flow.tp_src = htons(ofpact_get_SET_L4_SRC_PORT(a)->port);
6906             }
6907             break;
6908
6909         case OFPACT_SET_L4_DST_PORT:
6910             if (is_ip_any(&ctx->flow)) {
6911                 ctx->flow.tp_dst = htons(ofpact_get_SET_L4_DST_PORT(a)->port);
6912             }
6913             break;
6914
6915         case OFPACT_RESUBMIT:
6916             xlate_ofpact_resubmit(ctx, ofpact_get_RESUBMIT(a));
6917             break;
6918
6919         case OFPACT_SET_TUNNEL:
6920             ctx->flow.tunnel.tun_id = htonll(ofpact_get_SET_TUNNEL(a)->tun_id);
6921             break;
6922
6923         case OFPACT_SET_QUEUE:
6924             xlate_set_queue_action(ctx, ofpact_get_SET_QUEUE(a)->queue_id);
6925             break;
6926
6927         case OFPACT_POP_QUEUE:
6928             ctx->flow.skb_priority = ctx->orig_skb_priority;
6929             break;
6930
6931         case OFPACT_REG_MOVE:
6932             nxm_execute_reg_move(ofpact_get_REG_MOVE(a), &ctx->flow);
6933             break;
6934
6935         case OFPACT_REG_LOAD:
6936             nxm_execute_reg_load(ofpact_get_REG_LOAD(a), &ctx->flow);
6937             break;
6938
6939         case OFPACT_STACK_PUSH:
6940             nxm_execute_stack_push(ofpact_get_STACK_PUSH(a), &ctx->flow,
6941                                    &ctx->stack);
6942             break;
6943
6944         case OFPACT_STACK_POP:
6945             nxm_execute_stack_pop(ofpact_get_STACK_POP(a), &ctx->flow,
6946                                   &ctx->stack);
6947             break;
6948
6949         case OFPACT_PUSH_MPLS:
6950             execute_mpls_push_action(ctx, ofpact_get_PUSH_MPLS(a)->ethertype);
6951             break;
6952
6953         case OFPACT_POP_MPLS:
6954             execute_mpls_pop_action(ctx, ofpact_get_POP_MPLS(a)->ethertype);
6955             break;
6956
6957         case OFPACT_SET_MPLS_TTL:
6958             if (execute_set_mpls_ttl_action(ctx, ofpact_get_SET_MPLS_TTL(a)->ttl)) {
6959                 goto out;
6960             }
6961             break;
6962
6963         case OFPACT_DEC_MPLS_TTL:
6964             if (execute_dec_mpls_ttl_action(ctx)) {
6965                 goto out;
6966             }
6967             break;
6968
6969         case OFPACT_DEC_TTL:
6970             if (compose_dec_ttl(ctx, ofpact_get_DEC_TTL(a))) {
6971                 goto out;
6972             }
6973             break;
6974
6975         case OFPACT_NOTE:
6976             /* Nothing to do. */
6977             break;
6978
6979         case OFPACT_MULTIPATH:
6980             multipath_execute(ofpact_get_MULTIPATH(a), &ctx->flow);
6981             break;
6982
6983         case OFPACT_BUNDLE:
6984             ctx->ofproto->has_bundle_action = true;
6985             xlate_bundle_action(ctx, ofpact_get_BUNDLE(a));
6986             break;
6987
6988         case OFPACT_OUTPUT_REG:
6989             xlate_output_reg_action(ctx, ofpact_get_OUTPUT_REG(a));
6990             break;
6991
6992         case OFPACT_LEARN:
6993             ctx->has_learn = true;
6994             if (ctx->may_learn) {
6995                 xlate_learn_action(ctx, ofpact_get_LEARN(a));
6996             }
6997             break;
6998
6999         case OFPACT_EXIT:
7000             ctx->exit = true;
7001             break;
7002
7003         case OFPACT_FIN_TIMEOUT:
7004             ctx->has_fin_timeout = true;
7005             xlate_fin_timeout(ctx, ofpact_get_FIN_TIMEOUT(a));
7006             break;
7007
7008         case OFPACT_CLEAR_ACTIONS:
7009             /* XXX
7010              * Nothing to do because writa-actions is not supported for now.
7011              * When writa-actions is supported, clear-actions also must
7012              * be supported at the same time.
7013              */
7014             break;
7015
7016         case OFPACT_WRITE_METADATA:
7017             metadata = ofpact_get_WRITE_METADATA(a);
7018             ctx->flow.metadata &= ~metadata->mask;
7019             ctx->flow.metadata |= metadata->metadata & metadata->mask;
7020             break;
7021
7022         case OFPACT_GOTO_TABLE: {
7023             /* It is assumed that goto-table is the last action. */
7024             struct ofpact_goto_table *ogt = ofpact_get_GOTO_TABLE(a);
7025             struct rule_dpif *rule;
7026
7027             ovs_assert(ctx->table_id < ogt->table_id);
7028
7029             ctx->table_id = ogt->table_id;
7030
7031             /* Look up a flow from the new table. */
7032             rule = rule_dpif_lookup__(ctx->ofproto, &ctx->flow, ctx->table_id);
7033
7034             tag_the_flow(ctx, rule);
7035
7036             rule = ctx_rule_hooks(ctx, rule, true);
7037
7038             if (rule) {
7039                 if (ctx->rule) {
7040                     ctx->rule->up.evictable = was_evictable;
7041                 }
7042                 ctx->rule = rule;
7043                 was_evictable = rule->up.evictable;
7044                 rule->up.evictable = false;
7045
7046                 /* Tail recursion removal. */
7047                 ofpacts = rule->up.ofpacts;
7048                 ofpacts_len = rule->up.ofpacts_len;
7049                 goto do_xlate_actions_again;
7050             }
7051             break;
7052         }
7053
7054         case OFPACT_SAMPLE:
7055             xlate_sample_action(ctx, ofpact_get_SAMPLE(a));
7056             break;
7057         }
7058     }
7059
7060 out:
7061     if (ctx->rule) {
7062         ctx->rule->up.evictable = was_evictable;
7063     }
7064 }
7065
7066 static void
7067 action_xlate_ctx_init(struct action_xlate_ctx *ctx,
7068                       struct ofproto_dpif *ofproto, const struct flow *flow,
7069                       const struct initial_vals *initial_vals,
7070                       struct rule_dpif *rule,
7071                       uint8_t tcp_flags, const struct ofpbuf *packet)
7072 {
7073     /* Flow initialization rules:
7074      * - 'base_flow' must match the kernel's view of the packet at the
7075      *   time that action processing starts.  'flow' represents any
7076      *   transformations we wish to make through actions.
7077      * - By default 'base_flow' and 'flow' are the same since the input
7078      *   packet matches the output before any actions are applied.
7079      * - When using VLAN splinters, 'base_flow''s VLAN is set to the value
7080      *   of the received packet as seen by the kernel.  If we later output
7081      *   to another device without any modifications this will cause us to
7082      *   insert a new tag since the original one was stripped off by the
7083      *   VLAN device.
7084      * - Tunnel metadata as received is retained in 'flow'. This allows
7085      *   tunnel metadata matching also in later tables.
7086      *   Since a kernel action for setting the tunnel metadata will only be
7087      *   generated with actual tunnel output, changing the tunnel metadata
7088      *   values in 'flow' (such as tun_id) will only have effect with a later
7089      *   tunnel output action.
7090      * - Tunnel 'base_flow' is completely cleared since that is what the
7091      *   kernel does.  If we wish to maintain the original values an action
7092      *   needs to be generated. */
7093
7094     ctx->ofproto = ofproto;
7095     ctx->flow = *flow;
7096     ctx->base_flow = ctx->flow;
7097     memset(&ctx->base_flow.tunnel, 0, sizeof ctx->base_flow.tunnel);
7098     ctx->base_flow.vlan_tci = initial_vals->vlan_tci;
7099     ctx->rule = rule;
7100     ctx->packet = packet;
7101     ctx->may_learn = packet != NULL;
7102     ctx->tcp_flags = tcp_flags;
7103     ctx->resubmit_hook = NULL;
7104     ctx->report_hook = NULL;
7105     ctx->resubmit_stats = NULL;
7106 }
7107
7108 /* Translates the 'ofpacts_len' bytes of "struct ofpacts" starting at 'ofpacts'
7109  * into datapath actions in 'odp_actions', using 'ctx'. */
7110 static void
7111 xlate_actions(struct action_xlate_ctx *ctx,
7112               const struct ofpact *ofpacts, size_t ofpacts_len,
7113               struct ofpbuf *odp_actions)
7114 {
7115     /* Normally false.  Set to true if we ever hit MAX_RESUBMIT_RECURSION, so
7116      * that in the future we always keep a copy of the original flow for
7117      * tracing purposes. */
7118     static bool hit_resubmit_limit;
7119
7120     enum slow_path_reason special;
7121     struct ofport_dpif *in_port;
7122     struct flow orig_flow;
7123
7124     COVERAGE_INC(ofproto_dpif_xlate);
7125
7126     ofpbuf_clear(odp_actions);
7127     ofpbuf_reserve(odp_actions, NL_A_U32_SIZE);
7128
7129     ctx->odp_actions = odp_actions;
7130     ctx->tags = 0;
7131     ctx->slow = 0;
7132     ctx->has_learn = false;
7133     ctx->has_normal = false;
7134     ctx->has_fin_timeout = false;
7135     ctx->nf_output_iface = NF_OUT_DROP;
7136     ctx->mirrors = 0;
7137     ctx->recurse = 0;
7138     ctx->max_resubmit_trigger = false;
7139     ctx->orig_skb_priority = ctx->flow.skb_priority;
7140     ctx->table_id = 0;
7141     ctx->exit = false;
7142
7143     ofpbuf_use_stub(&ctx->stack, ctx->init_stack, sizeof ctx->init_stack);
7144
7145     if (ctx->ofproto->has_mirrors || hit_resubmit_limit) {
7146         /* Do this conditionally because the copy is expensive enough that it
7147          * shows up in profiles. */
7148         orig_flow = ctx->flow;
7149     }
7150
7151     if (ctx->flow.nw_frag & FLOW_NW_FRAG_ANY) {
7152         switch (ctx->ofproto->up.frag_handling) {
7153         case OFPC_FRAG_NORMAL:
7154             /* We must pretend that transport ports are unavailable. */
7155             ctx->flow.tp_src = ctx->base_flow.tp_src = htons(0);
7156             ctx->flow.tp_dst = ctx->base_flow.tp_dst = htons(0);
7157             break;
7158
7159         case OFPC_FRAG_DROP:
7160             return;
7161
7162         case OFPC_FRAG_REASM:
7163             NOT_REACHED();
7164
7165         case OFPC_FRAG_NX_MATCH:
7166             /* Nothing to do. */
7167             break;
7168
7169         case OFPC_INVALID_TTL_TO_CONTROLLER:
7170             NOT_REACHED();
7171         }
7172     }
7173
7174     in_port = get_ofp_port(ctx->ofproto, ctx->flow.in_port);
7175     special = process_special(ctx->ofproto, &ctx->flow, in_port, ctx->packet);
7176     if (special) {
7177         ctx->slow |= special;
7178     } else {
7179         static struct vlog_rate_limit trace_rl = VLOG_RATE_LIMIT_INIT(1, 1);
7180         struct initial_vals initial_vals;
7181         size_t sample_actions_len;
7182         uint32_t local_odp_port;
7183
7184         initial_vals.vlan_tci = ctx->base_flow.vlan_tci;
7185
7186         add_sflow_action(ctx);
7187         add_ipfix_action(ctx);
7188         sample_actions_len = ctx->odp_actions->size;
7189
7190         if (tunnel_ecn_ok(ctx) && (!in_port || may_receive(in_port, ctx))) {
7191             do_xlate_actions(ofpacts, ofpacts_len, ctx);
7192
7193             /* We've let OFPP_NORMAL and the learning action look at the
7194              * packet, so drop it now if forwarding is disabled. */
7195             if (in_port && !stp_forward_in_state(in_port->stp_state)) {
7196                 ctx->odp_actions->size = sample_actions_len;
7197             }
7198         }
7199
7200         if (ctx->max_resubmit_trigger && !ctx->resubmit_hook) {
7201             if (!hit_resubmit_limit) {
7202                 /* We didn't record the original flow.  Make sure we do from
7203                  * now on. */
7204                 hit_resubmit_limit = true;
7205             } else if (!VLOG_DROP_ERR(&trace_rl)) {
7206                 struct ds ds = DS_EMPTY_INITIALIZER;
7207
7208                 ofproto_trace(ctx->ofproto, &orig_flow, ctx->packet,
7209                               &initial_vals, &ds);
7210                 VLOG_ERR("Trace triggered by excessive resubmit "
7211                          "recursion:\n%s", ds_cstr(&ds));
7212                 ds_destroy(&ds);
7213             }
7214         }
7215
7216         local_odp_port = ofp_port_to_odp_port(ctx->ofproto, OFPP_LOCAL);
7217         if (!connmgr_may_set_up_flow(ctx->ofproto->up.connmgr, &ctx->flow,
7218                                      local_odp_port,
7219                                      ctx->odp_actions->data,
7220                                      ctx->odp_actions->size)) {
7221             ctx->slow |= SLOW_IN_BAND;
7222             if (ctx->packet
7223                 && connmgr_msg_in_hook(ctx->ofproto->up.connmgr, &ctx->flow,
7224                                        ctx->packet)) {
7225                 compose_output_action(ctx, OFPP_LOCAL);
7226             }
7227         }
7228         if (ctx->ofproto->has_mirrors) {
7229             add_mirror_actions(ctx, &orig_flow);
7230         }
7231         fix_sflow_action(ctx);
7232     }
7233
7234     ofpbuf_uninit(&ctx->stack);
7235 }
7236
7237 /* Translates the 'ofpacts_len' bytes of "struct ofpact"s starting at 'ofpacts'
7238  * into datapath actions, using 'ctx', and discards the datapath actions. */
7239 static void
7240 xlate_actions_for_side_effects(struct action_xlate_ctx *ctx,
7241                                const struct ofpact *ofpacts,
7242                                size_t ofpacts_len)
7243 {
7244     uint64_t odp_actions_stub[1024 / 8];
7245     struct ofpbuf odp_actions;
7246
7247     ofpbuf_use_stub(&odp_actions, odp_actions_stub, sizeof odp_actions_stub);
7248     xlate_actions(ctx, ofpacts, ofpacts_len, &odp_actions);
7249     ofpbuf_uninit(&odp_actions);
7250 }
7251
7252 static void
7253 xlate_report(struct action_xlate_ctx *ctx, const char *s)
7254 {
7255     if (ctx->report_hook) {
7256         ctx->report_hook(ctx, s);
7257     }
7258 }
7259 \f
7260 /* OFPP_NORMAL implementation. */
7261
7262 static struct ofport_dpif *ofbundle_get_a_port(const struct ofbundle *);
7263
7264 /* Given 'vid', the VID obtained from the 802.1Q header that was received as
7265  * part of a packet (specify 0 if there was no 802.1Q header), and 'in_bundle',
7266  * the bundle on which the packet was received, returns the VLAN to which the
7267  * packet belongs.
7268  *
7269  * Both 'vid' and the return value are in the range 0...4095. */
7270 static uint16_t
7271 input_vid_to_vlan(const struct ofbundle *in_bundle, uint16_t vid)
7272 {
7273     switch (in_bundle->vlan_mode) {
7274     case PORT_VLAN_ACCESS:
7275         return in_bundle->vlan;
7276         break;
7277
7278     case PORT_VLAN_TRUNK:
7279         return vid;
7280
7281     case PORT_VLAN_NATIVE_UNTAGGED:
7282     case PORT_VLAN_NATIVE_TAGGED:
7283         return vid ? vid : in_bundle->vlan;
7284
7285     default:
7286         NOT_REACHED();
7287     }
7288 }
7289
7290 /* Checks whether a packet with the given 'vid' may ingress on 'in_bundle'.
7291  * If so, returns true.  Otherwise, returns false and, if 'warn' is true, logs
7292  * a warning.
7293  *
7294  * 'vid' should be the VID obtained from the 802.1Q header that was received as
7295  * part of a packet (specify 0 if there was no 802.1Q header), in the range
7296  * 0...4095. */
7297 static bool
7298 input_vid_is_valid(uint16_t vid, struct ofbundle *in_bundle, bool warn)
7299 {
7300     /* Allow any VID on the OFPP_NONE port. */
7301     if (in_bundle == &ofpp_none_bundle) {
7302         return true;
7303     }
7304
7305     switch (in_bundle->vlan_mode) {
7306     case PORT_VLAN_ACCESS:
7307         if (vid) {
7308             if (warn) {
7309                 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
7310                 VLOG_WARN_RL(&rl, "bridge %s: dropping VLAN %"PRIu16" tagged "
7311                              "packet received on port %s configured as VLAN "
7312                              "%"PRIu16" access port",
7313                              in_bundle->ofproto->up.name, vid,
7314                              in_bundle->name, in_bundle->vlan);
7315             }
7316             return false;
7317         }
7318         return true;
7319
7320     case PORT_VLAN_NATIVE_UNTAGGED:
7321     case PORT_VLAN_NATIVE_TAGGED:
7322         if (!vid) {
7323             /* Port must always carry its native VLAN. */
7324             return true;
7325         }
7326         /* Fall through. */
7327     case PORT_VLAN_TRUNK:
7328         if (!ofbundle_includes_vlan(in_bundle, vid)) {
7329             if (warn) {
7330                 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
7331                 VLOG_WARN_RL(&rl, "bridge %s: dropping VLAN %"PRIu16" packet "
7332                              "received on port %s not configured for trunking "
7333                              "VLAN %"PRIu16,
7334                              in_bundle->ofproto->up.name, vid,
7335                              in_bundle->name, vid);
7336             }
7337             return false;
7338         }
7339         return true;
7340
7341     default:
7342         NOT_REACHED();
7343     }
7344
7345 }
7346
7347 /* Given 'vlan', the VLAN that a packet belongs to, and
7348  * 'out_bundle', a bundle on which the packet is to be output, returns the VID
7349  * that should be included in the 802.1Q header.  (If the return value is 0,
7350  * then the 802.1Q header should only be included in the packet if there is a
7351  * nonzero PCP.)
7352  *
7353  * Both 'vlan' and the return value are in the range 0...4095. */
7354 static uint16_t
7355 output_vlan_to_vid(const struct ofbundle *out_bundle, uint16_t vlan)
7356 {
7357     switch (out_bundle->vlan_mode) {
7358     case PORT_VLAN_ACCESS:
7359         return 0;
7360
7361     case PORT_VLAN_TRUNK:
7362     case PORT_VLAN_NATIVE_TAGGED:
7363         return vlan;
7364
7365     case PORT_VLAN_NATIVE_UNTAGGED:
7366         return vlan == out_bundle->vlan ? 0 : vlan;
7367
7368     default:
7369         NOT_REACHED();
7370     }
7371 }
7372
7373 static void
7374 output_normal(struct action_xlate_ctx *ctx, const struct ofbundle *out_bundle,
7375               uint16_t vlan)
7376 {
7377     struct ofport_dpif *port;
7378     uint16_t vid;
7379     ovs_be16 tci, old_tci;
7380
7381     vid = output_vlan_to_vid(out_bundle, vlan);
7382     if (!out_bundle->bond) {
7383         port = ofbundle_get_a_port(out_bundle);
7384     } else {
7385         port = bond_choose_output_slave(out_bundle->bond, &ctx->flow,
7386                                         vid, &ctx->tags);
7387         if (!port) {
7388             /* No slaves enabled, so drop packet. */
7389             return;
7390         }
7391     }
7392
7393     old_tci = ctx->flow.vlan_tci;
7394     tci = htons(vid);
7395     if (tci || out_bundle->use_priority_tags) {
7396         tci |= ctx->flow.vlan_tci & htons(VLAN_PCP_MASK);
7397         if (tci) {
7398             tci |= htons(VLAN_CFI);
7399         }
7400     }
7401     ctx->flow.vlan_tci = tci;
7402
7403     compose_output_action(ctx, port->up.ofp_port);
7404     ctx->flow.vlan_tci = old_tci;
7405 }
7406
7407 static int
7408 mirror_mask_ffs(mirror_mask_t mask)
7409 {
7410     BUILD_ASSERT_DECL(sizeof(unsigned int) >= sizeof(mask));
7411     return ffs(mask);
7412 }
7413
7414 static bool
7415 ofbundle_trunks_vlan(const struct ofbundle *bundle, uint16_t vlan)
7416 {
7417     return (bundle->vlan_mode != PORT_VLAN_ACCESS
7418             && (!bundle->trunks || bitmap_is_set(bundle->trunks, vlan)));
7419 }
7420
7421 static bool
7422 ofbundle_includes_vlan(const struct ofbundle *bundle, uint16_t vlan)
7423 {
7424     return vlan == bundle->vlan || ofbundle_trunks_vlan(bundle, vlan);
7425 }
7426
7427 /* Returns an arbitrary interface within 'bundle'. */
7428 static struct ofport_dpif *
7429 ofbundle_get_a_port(const struct ofbundle *bundle)
7430 {
7431     return CONTAINER_OF(list_front(&bundle->ports),
7432                         struct ofport_dpif, bundle_node);
7433 }
7434
7435 static bool
7436 vlan_is_mirrored(const struct ofmirror *m, int vlan)
7437 {
7438     return !m->vlans || bitmap_is_set(m->vlans, vlan);
7439 }
7440
7441 static void
7442 add_mirror_actions(struct action_xlate_ctx *ctx, const struct flow *orig_flow)
7443 {
7444     struct ofproto_dpif *ofproto = ctx->ofproto;
7445     mirror_mask_t mirrors;
7446     struct ofbundle *in_bundle;
7447     uint16_t vlan;
7448     uint16_t vid;
7449     const struct nlattr *a;
7450     size_t left;
7451
7452     in_bundle = lookup_input_bundle(ctx->ofproto, orig_flow->in_port,
7453                                     ctx->packet != NULL, NULL);
7454     if (!in_bundle) {
7455         return;
7456     }
7457     mirrors = in_bundle->src_mirrors;
7458
7459     /* Drop frames on bundles reserved for mirroring. */
7460     if (in_bundle->mirror_out) {
7461         if (ctx->packet != NULL) {
7462             static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
7463             VLOG_WARN_RL(&rl, "bridge %s: dropping packet received on port "
7464                          "%s, which is reserved exclusively for mirroring",
7465                          ctx->ofproto->up.name, in_bundle->name);
7466         }
7467         return;
7468     }
7469
7470     /* Check VLAN. */
7471     vid = vlan_tci_to_vid(orig_flow->vlan_tci);
7472     if (!input_vid_is_valid(vid, in_bundle, ctx->packet != NULL)) {
7473         return;
7474     }
7475     vlan = input_vid_to_vlan(in_bundle, vid);
7476
7477     /* Look at the output ports to check for destination selections. */
7478
7479     NL_ATTR_FOR_EACH (a, left, ctx->odp_actions->data,
7480                       ctx->odp_actions->size) {
7481         enum ovs_action_attr type = nl_attr_type(a);
7482         struct ofport_dpif *ofport;
7483
7484         if (type != OVS_ACTION_ATTR_OUTPUT) {
7485             continue;
7486         }
7487
7488         ofport = get_odp_port(ofproto, nl_attr_get_u32(a));
7489         if (ofport && ofport->bundle) {
7490             mirrors |= ofport->bundle->dst_mirrors;
7491         }
7492     }
7493
7494     if (!mirrors) {
7495         return;
7496     }
7497
7498     /* Restore the original packet before adding the mirror actions. */
7499     ctx->flow = *orig_flow;
7500
7501     while (mirrors) {
7502         struct ofmirror *m;
7503
7504         m = ofproto->mirrors[mirror_mask_ffs(mirrors) - 1];
7505
7506         if (!vlan_is_mirrored(m, vlan)) {
7507             mirrors = zero_rightmost_1bit(mirrors);
7508             continue;
7509         }
7510
7511         mirrors &= ~m->dup_mirrors;
7512         ctx->mirrors |= m->dup_mirrors;
7513         if (m->out) {
7514             output_normal(ctx, m->out, vlan);
7515         } else if (vlan != m->out_vlan
7516                    && !eth_addr_is_reserved(orig_flow->dl_dst)) {
7517             struct ofbundle *bundle;
7518
7519             HMAP_FOR_EACH (bundle, hmap_node, &ofproto->bundles) {
7520                 if (ofbundle_includes_vlan(bundle, m->out_vlan)
7521                     && !bundle->mirror_out) {
7522                     output_normal(ctx, bundle, m->out_vlan);
7523                 }
7524             }
7525         }
7526     }
7527 }
7528
7529 static void
7530 update_mirror_stats(struct ofproto_dpif *ofproto, mirror_mask_t mirrors,
7531                     uint64_t packets, uint64_t bytes)
7532 {
7533     if (!mirrors) {
7534         return;
7535     }
7536
7537     for (; mirrors; mirrors = zero_rightmost_1bit(mirrors)) {
7538         struct ofmirror *m;
7539
7540         m = ofproto->mirrors[mirror_mask_ffs(mirrors) - 1];
7541
7542         if (!m) {
7543             /* In normal circumstances 'm' will not be NULL.  However,
7544              * if mirrors are reconfigured, we can temporarily get out
7545              * of sync in facet_revalidate().  We could "correct" the
7546              * mirror list before reaching here, but doing that would
7547              * not properly account the traffic stats we've currently
7548              * accumulated for previous mirror configuration. */
7549             continue;
7550         }
7551
7552         m->packet_count += packets;
7553         m->byte_count += bytes;
7554     }
7555 }
7556
7557 /* A VM broadcasts a gratuitous ARP to indicate that it has resumed after
7558  * migration.  Older Citrix-patched Linux DomU used gratuitous ARP replies to
7559  * indicate this; newer upstream kernels use gratuitous ARP requests. */
7560 static bool
7561 is_gratuitous_arp(const struct flow *flow)
7562 {
7563     return (flow->dl_type == htons(ETH_TYPE_ARP)
7564             && eth_addr_is_broadcast(flow->dl_dst)
7565             && (flow->nw_proto == ARP_OP_REPLY
7566                 || (flow->nw_proto == ARP_OP_REQUEST
7567                     && flow->nw_src == flow->nw_dst)));
7568 }
7569
7570 static void
7571 update_learning_table(struct ofproto_dpif *ofproto,
7572                       const struct flow *flow, int vlan,
7573                       struct ofbundle *in_bundle)
7574 {
7575     struct mac_entry *mac;
7576
7577     /* Don't learn the OFPP_NONE port. */
7578     if (in_bundle == &ofpp_none_bundle) {
7579         return;
7580     }
7581
7582     if (!mac_learning_may_learn(ofproto->ml, flow->dl_src, vlan)) {
7583         return;
7584     }
7585
7586     mac = mac_learning_insert(ofproto->ml, flow->dl_src, vlan);
7587     if (is_gratuitous_arp(flow)) {
7588         /* We don't want to learn from gratuitous ARP packets that are
7589          * reflected back over bond slaves so we lock the learning table. */
7590         if (!in_bundle->bond) {
7591             mac_entry_set_grat_arp_lock(mac);
7592         } else if (mac_entry_is_grat_arp_locked(mac)) {
7593             return;
7594         }
7595     }
7596
7597     if (mac_entry_is_new(mac) || mac->port.p != in_bundle) {
7598         /* The log messages here could actually be useful in debugging,
7599          * so keep the rate limit relatively high. */
7600         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(30, 300);
7601         VLOG_DBG_RL(&rl, "bridge %s: learned that "ETH_ADDR_FMT" is "
7602                     "on port %s in VLAN %d",
7603                     ofproto->up.name, ETH_ADDR_ARGS(flow->dl_src),
7604                     in_bundle->name, vlan);
7605
7606         mac->port.p = in_bundle;
7607         tag_set_add(&ofproto->backer->revalidate_set,
7608                     mac_learning_changed(ofproto->ml, mac));
7609     }
7610 }
7611
7612 static struct ofbundle *
7613 lookup_input_bundle(const struct ofproto_dpif *ofproto, uint16_t in_port,
7614                     bool warn, struct ofport_dpif **in_ofportp)
7615 {
7616     struct ofport_dpif *ofport;
7617
7618     /* Find the port and bundle for the received packet. */
7619     ofport = get_ofp_port(ofproto, in_port);
7620     if (in_ofportp) {
7621         *in_ofportp = ofport;
7622     }
7623     if (ofport && ofport->bundle) {
7624         return ofport->bundle;
7625     }
7626
7627     /* Special-case OFPP_NONE, which a controller may use as the ingress
7628      * port for traffic that it is sourcing. */
7629     if (in_port == OFPP_NONE) {
7630         return &ofpp_none_bundle;
7631     }
7632
7633     /* Odd.  A few possible reasons here:
7634      *
7635      * - We deleted a port but there are still a few packets queued up
7636      *   from it.
7637      *
7638      * - Someone externally added a port (e.g. "ovs-dpctl add-if") that
7639      *   we don't know about.
7640      *
7641      * - The ofproto client didn't configure the port as part of a bundle.
7642      *   This is particularly likely to happen if a packet was received on the
7643      *   port after it was created, but before the client had a chance to
7644      *   configure its bundle.
7645      */
7646     if (warn) {
7647         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
7648
7649         VLOG_WARN_RL(&rl, "bridge %s: received packet on unknown "
7650                      "port %"PRIu16, ofproto->up.name, in_port);
7651     }
7652     return NULL;
7653 }
7654
7655 /* Determines whether packets in 'flow' within 'ofproto' should be forwarded or
7656  * dropped.  Returns true if they may be forwarded, false if they should be
7657  * dropped.
7658  *
7659  * 'in_port' must be the ofport_dpif that corresponds to flow->in_port.
7660  * 'in_port' must be part of a bundle (e.g. in_port->bundle must be nonnull).
7661  *
7662  * 'vlan' must be the VLAN that corresponds to flow->vlan_tci on 'in_port', as
7663  * returned by input_vid_to_vlan().  It must be a valid VLAN for 'in_port', as
7664  * checked by input_vid_is_valid().
7665  *
7666  * May also add tags to '*tags', although the current implementation only does
7667  * so in one special case.
7668  */
7669 static bool
7670 is_admissible(struct action_xlate_ctx *ctx, struct ofport_dpif *in_port,
7671               uint16_t vlan)
7672 {
7673     struct ofproto_dpif *ofproto = ctx->ofproto;
7674     struct flow *flow = &ctx->flow;
7675     struct ofbundle *in_bundle = in_port->bundle;
7676
7677     /* Drop frames for reserved multicast addresses
7678      * only if forward_bpdu option is absent. */
7679     if (!ofproto->up.forward_bpdu && eth_addr_is_reserved(flow->dl_dst)) {
7680         xlate_report(ctx, "packet has reserved destination MAC, dropping");
7681         return false;
7682     }
7683
7684     if (in_bundle->bond) {
7685         struct mac_entry *mac;
7686
7687         switch (bond_check_admissibility(in_bundle->bond, in_port,
7688                                          flow->dl_dst, &ctx->tags)) {
7689         case BV_ACCEPT:
7690             break;
7691
7692         case BV_DROP:
7693             xlate_report(ctx, "bonding refused admissibility, dropping");
7694             return false;
7695
7696         case BV_DROP_IF_MOVED:
7697             mac = mac_learning_lookup(ofproto->ml, flow->dl_src, vlan, NULL);
7698             if (mac && mac->port.p != in_bundle &&
7699                 (!is_gratuitous_arp(flow)
7700                  || mac_entry_is_grat_arp_locked(mac))) {
7701                 xlate_report(ctx, "SLB bond thinks this packet looped back, "
7702                             "dropping");
7703                 return false;
7704             }
7705             break;
7706         }
7707     }
7708
7709     return true;
7710 }
7711
7712 static void
7713 xlate_normal(struct action_xlate_ctx *ctx)
7714 {
7715     struct ofport_dpif *in_port;
7716     struct ofbundle *in_bundle;
7717     struct mac_entry *mac;
7718     uint16_t vlan;
7719     uint16_t vid;
7720
7721     ctx->has_normal = true;
7722
7723     in_bundle = lookup_input_bundle(ctx->ofproto, ctx->flow.in_port,
7724                                     ctx->packet != NULL, &in_port);
7725     if (!in_bundle) {
7726         xlate_report(ctx, "no input bundle, dropping");
7727         return;
7728     }
7729
7730     /* Drop malformed frames. */
7731     if (ctx->flow.dl_type == htons(ETH_TYPE_VLAN) &&
7732         !(ctx->flow.vlan_tci & htons(VLAN_CFI))) {
7733         if (ctx->packet != NULL) {
7734             static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
7735             VLOG_WARN_RL(&rl, "bridge %s: dropping packet with partial "
7736                          "VLAN tag received on port %s",
7737                          ctx->ofproto->up.name, in_bundle->name);
7738         }
7739         xlate_report(ctx, "partial VLAN tag, dropping");
7740         return;
7741     }
7742
7743     /* Drop frames on bundles reserved for mirroring. */
7744     if (in_bundle->mirror_out) {
7745         if (ctx->packet != NULL) {
7746             static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
7747             VLOG_WARN_RL(&rl, "bridge %s: dropping packet received on port "
7748                          "%s, which is reserved exclusively for mirroring",
7749                          ctx->ofproto->up.name, in_bundle->name);
7750         }
7751         xlate_report(ctx, "input port is mirror output port, dropping");
7752         return;
7753     }
7754
7755     /* Check VLAN. */
7756     vid = vlan_tci_to_vid(ctx->flow.vlan_tci);
7757     if (!input_vid_is_valid(vid, in_bundle, ctx->packet != NULL)) {
7758         xlate_report(ctx, "disallowed VLAN VID for this input port, dropping");
7759         return;
7760     }
7761     vlan = input_vid_to_vlan(in_bundle, vid);
7762
7763     /* Check other admissibility requirements. */
7764     if (in_port && !is_admissible(ctx, in_port, vlan)) {
7765         return;
7766     }
7767
7768     /* Learn source MAC. */
7769     if (ctx->may_learn) {
7770         update_learning_table(ctx->ofproto, &ctx->flow, vlan, in_bundle);
7771     }
7772
7773     /* Determine output bundle. */
7774     mac = mac_learning_lookup(ctx->ofproto->ml, ctx->flow.dl_dst, vlan,
7775                               &ctx->tags);
7776     if (mac) {
7777         if (mac->port.p != in_bundle) {
7778             xlate_report(ctx, "forwarding to learned port");
7779             output_normal(ctx, mac->port.p, vlan);
7780         } else {
7781             xlate_report(ctx, "learned port is input port, dropping");
7782         }
7783     } else {
7784         struct ofbundle *bundle;
7785
7786         xlate_report(ctx, "no learned MAC for destination, flooding");
7787         HMAP_FOR_EACH (bundle, hmap_node, &ctx->ofproto->bundles) {
7788             if (bundle != in_bundle
7789                 && ofbundle_includes_vlan(bundle, vlan)
7790                 && bundle->floodable
7791                 && !bundle->mirror_out) {
7792                 output_normal(ctx, bundle, vlan);
7793             }
7794         }
7795         ctx->nf_output_iface = NF_OUT_FLOOD;
7796     }
7797 }
7798 \f
7799 /* Optimized flow revalidation.
7800  *
7801  * It's a difficult problem, in general, to tell which facets need to have
7802  * their actions recalculated whenever the OpenFlow flow table changes.  We
7803  * don't try to solve that general problem: for most kinds of OpenFlow flow
7804  * table changes, we recalculate the actions for every facet.  This is
7805  * relatively expensive, but it's good enough if the OpenFlow flow table
7806  * doesn't change very often.
7807  *
7808  * However, we can expect one particular kind of OpenFlow flow table change to
7809  * happen frequently: changes caused by MAC learning.  To avoid wasting a lot
7810  * of CPU on revalidating every facet whenever MAC learning modifies the flow
7811  * table, we add a special case that applies to flow tables in which every rule
7812  * has the same form (that is, the same wildcards), except that the table is
7813  * also allowed to have a single "catch-all" flow that matches all packets.  We
7814  * optimize this case by tagging all of the facets that resubmit into the table
7815  * and invalidating the same tag whenever a flow changes in that table.  The
7816  * end result is that we revalidate just the facets that need it (and sometimes
7817  * a few more, but not all of the facets or even all of the facets that
7818  * resubmit to the table modified by MAC learning). */
7819
7820 /* Calculates the tag to use for 'flow' and mask 'mask' when it is inserted
7821  * into an OpenFlow table with the given 'basis'. */
7822 static tag_type
7823 rule_calculate_tag(const struct flow *flow, const struct minimask *mask,
7824                    uint32_t secret)
7825 {
7826     if (minimask_is_catchall(mask)) {
7827         return 0;
7828     } else {
7829         uint32_t hash = flow_hash_in_minimask(flow, mask, secret);
7830         return tag_create_deterministic(hash);
7831     }
7832 }
7833
7834 /* Following a change to OpenFlow table 'table_id' in 'ofproto', update the
7835  * taggability of that table.
7836  *
7837  * This function must be called after *each* change to a flow table.  If you
7838  * skip calling it on some changes then the pointer comparisons at the end can
7839  * be invalid if you get unlucky.  For example, if a flow removal causes a
7840  * cls_table to be destroyed and then a flow insertion causes a cls_table with
7841  * different wildcards to be created with the same address, then this function
7842  * will incorrectly skip revalidation. */
7843 static void
7844 table_update_taggable(struct ofproto_dpif *ofproto, uint8_t table_id)
7845 {
7846     struct table_dpif *table = &ofproto->tables[table_id];
7847     const struct oftable *oftable = &ofproto->up.tables[table_id];
7848     struct cls_table *catchall, *other;
7849     struct cls_table *t;
7850
7851     catchall = other = NULL;
7852
7853     switch (hmap_count(&oftable->cls.tables)) {
7854     case 0:
7855         /* We could tag this OpenFlow table but it would make the logic a
7856          * little harder and it's a corner case that doesn't seem worth it
7857          * yet. */
7858         break;
7859
7860     case 1:
7861     case 2:
7862         HMAP_FOR_EACH (t, hmap_node, &oftable->cls.tables) {
7863             if (cls_table_is_catchall(t)) {
7864                 catchall = t;
7865             } else if (!other) {
7866                 other = t;
7867             } else {
7868                 /* Indicate that we can't tag this by setting both tables to
7869                  * NULL.  (We know that 'catchall' is already NULL.) */
7870                 other = NULL;
7871             }
7872         }
7873         break;
7874
7875     default:
7876         /* Can't tag this table. */
7877         break;
7878     }
7879
7880     if (table->catchall_table != catchall || table->other_table != other) {
7881         table->catchall_table = catchall;
7882         table->other_table = other;
7883         ofproto->backer->need_revalidate = REV_FLOW_TABLE;
7884     }
7885 }
7886
7887 /* Given 'rule' that has changed in some way (either it is a rule being
7888  * inserted, a rule being deleted, or a rule whose actions are being
7889  * modified), marks facets for revalidation to ensure that packets will be
7890  * forwarded correctly according to the new state of the flow table.
7891  *
7892  * This function must be called after *each* change to a flow table.  See
7893  * the comment on table_update_taggable() for more information. */
7894 static void
7895 rule_invalidate(const struct rule_dpif *rule)
7896 {
7897     struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
7898
7899     table_update_taggable(ofproto, rule->up.table_id);
7900
7901     if (!ofproto->backer->need_revalidate) {
7902         struct table_dpif *table = &ofproto->tables[rule->up.table_id];
7903
7904         if (table->other_table && rule->tag) {
7905             tag_set_add(&ofproto->backer->revalidate_set, rule->tag);
7906         } else {
7907             ofproto->backer->need_revalidate = REV_FLOW_TABLE;
7908         }
7909     }
7910 }
7911 \f
7912 static bool
7913 set_frag_handling(struct ofproto *ofproto_,
7914                   enum ofp_config_flags frag_handling)
7915 {
7916     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
7917     if (frag_handling != OFPC_FRAG_REASM) {
7918         ofproto->backer->need_revalidate = REV_RECONFIGURE;
7919         return true;
7920     } else {
7921         return false;
7922     }
7923 }
7924
7925 static enum ofperr
7926 packet_out(struct ofproto *ofproto_, struct ofpbuf *packet,
7927            const struct flow *flow,
7928            const struct ofpact *ofpacts, size_t ofpacts_len)
7929 {
7930     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
7931     struct initial_vals initial_vals;
7932     struct odputil_keybuf keybuf;
7933     struct dpif_flow_stats stats;
7934
7935     struct ofpbuf key;
7936
7937     struct action_xlate_ctx ctx;
7938     uint64_t odp_actions_stub[1024 / 8];
7939     struct ofpbuf odp_actions;
7940
7941     ofpbuf_use_stack(&key, &keybuf, sizeof keybuf);
7942     odp_flow_key_from_flow(&key, flow,
7943                            ofp_port_to_odp_port(ofproto, flow->in_port));
7944
7945     dpif_flow_stats_extract(flow, packet, time_msec(), &stats);
7946
7947     initial_vals.vlan_tci = flow->vlan_tci;
7948     action_xlate_ctx_init(&ctx, ofproto, flow, &initial_vals, NULL,
7949                           packet_get_tcp_flags(packet, flow), packet);
7950     ctx.resubmit_stats = &stats;
7951
7952     ofpbuf_use_stub(&odp_actions,
7953                     odp_actions_stub, sizeof odp_actions_stub);
7954     xlate_actions(&ctx, ofpacts, ofpacts_len, &odp_actions);
7955     dpif_execute(ofproto->backer->dpif, key.data, key.size,
7956                  odp_actions.data, odp_actions.size, packet);
7957     ofpbuf_uninit(&odp_actions);
7958
7959     return 0;
7960 }
7961 \f
7962 /* NetFlow. */
7963
7964 static int
7965 set_netflow(struct ofproto *ofproto_,
7966             const struct netflow_options *netflow_options)
7967 {
7968     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
7969
7970     if (netflow_options) {
7971         if (!ofproto->netflow) {
7972             ofproto->netflow = netflow_create();
7973         }
7974         return netflow_set_options(ofproto->netflow, netflow_options);
7975     } else {
7976         netflow_destroy(ofproto->netflow);
7977         ofproto->netflow = NULL;
7978         return 0;
7979     }
7980 }
7981
7982 static void
7983 get_netflow_ids(const struct ofproto *ofproto_,
7984                 uint8_t *engine_type, uint8_t *engine_id)
7985 {
7986     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
7987
7988     dpif_get_netflow_ids(ofproto->backer->dpif, engine_type, engine_id);
7989 }
7990
7991 static void
7992 send_active_timeout(struct ofproto_dpif *ofproto, struct facet *facet)
7993 {
7994     if (!facet_is_controller_flow(facet) &&
7995         netflow_active_timeout_expired(ofproto->netflow, &facet->nf_flow)) {
7996         struct subfacet *subfacet;
7997         struct ofexpired expired;
7998
7999         LIST_FOR_EACH (subfacet, list_node, &facet->subfacets) {
8000             if (subfacet->path == SF_FAST_PATH) {
8001                 struct dpif_flow_stats stats;
8002
8003                 subfacet_reinstall(subfacet, &stats);
8004                 subfacet_update_stats(subfacet, &stats);
8005             }
8006         }
8007
8008         expired.flow = facet->flow;
8009         expired.packet_count = facet->packet_count;
8010         expired.byte_count = facet->byte_count;
8011         expired.used = facet->used;
8012         netflow_expire(ofproto->netflow, &facet->nf_flow, &expired);
8013     }
8014 }
8015
8016 static void
8017 send_netflow_active_timeouts(struct ofproto_dpif *ofproto)
8018 {
8019     struct facet *facet;
8020
8021     HMAP_FOR_EACH (facet, hmap_node, &ofproto->facets) {
8022         send_active_timeout(ofproto, facet);
8023     }
8024 }
8025 \f
8026 static struct ofproto_dpif *
8027 ofproto_dpif_lookup(const char *name)
8028 {
8029     struct ofproto_dpif *ofproto;
8030
8031     HMAP_FOR_EACH_WITH_HASH (ofproto, all_ofproto_dpifs_node,
8032                              hash_string(name, 0), &all_ofproto_dpifs) {
8033         if (!strcmp(ofproto->up.name, name)) {
8034             return ofproto;
8035         }
8036     }
8037     return NULL;
8038 }
8039
8040 static void
8041 ofproto_unixctl_fdb_flush(struct unixctl_conn *conn, int argc,
8042                           const char *argv[], void *aux OVS_UNUSED)
8043 {
8044     struct ofproto_dpif *ofproto;
8045
8046     if (argc > 1) {
8047         ofproto = ofproto_dpif_lookup(argv[1]);
8048         if (!ofproto) {
8049             unixctl_command_reply_error(conn, "no such bridge");
8050             return;
8051         }
8052         mac_learning_flush(ofproto->ml, &ofproto->backer->revalidate_set);
8053     } else {
8054         HMAP_FOR_EACH (ofproto, all_ofproto_dpifs_node, &all_ofproto_dpifs) {
8055             mac_learning_flush(ofproto->ml, &ofproto->backer->revalidate_set);
8056         }
8057     }
8058
8059     unixctl_command_reply(conn, "table successfully flushed");
8060 }
8061
8062 static void
8063 ofproto_unixctl_fdb_show(struct unixctl_conn *conn, int argc OVS_UNUSED,
8064                          const char *argv[], void *aux OVS_UNUSED)
8065 {
8066     struct ds ds = DS_EMPTY_INITIALIZER;
8067     const struct ofproto_dpif *ofproto;
8068     const struct mac_entry *e;
8069
8070     ofproto = ofproto_dpif_lookup(argv[1]);
8071     if (!ofproto) {
8072         unixctl_command_reply_error(conn, "no such bridge");
8073         return;
8074     }
8075
8076     ds_put_cstr(&ds, " port  VLAN  MAC                Age\n");
8077     LIST_FOR_EACH (e, lru_node, &ofproto->ml->lrus) {
8078         struct ofbundle *bundle = e->port.p;
8079         ds_put_format(&ds, "%5d  %4d  "ETH_ADDR_FMT"  %3d\n",
8080                       ofbundle_get_a_port(bundle)->odp_port,
8081                       e->vlan, ETH_ADDR_ARGS(e->mac),
8082                       mac_entry_age(ofproto->ml, e));
8083     }
8084     unixctl_command_reply(conn, ds_cstr(&ds));
8085     ds_destroy(&ds);
8086 }
8087
8088 struct trace_ctx {
8089     struct action_xlate_ctx ctx;
8090     struct flow flow;
8091     struct ds *result;
8092 };
8093
8094 static void
8095 trace_format_rule(struct ds *result, uint8_t table_id, int level,
8096                   const struct rule_dpif *rule)
8097 {
8098     ds_put_char_multiple(result, '\t', level);
8099     if (!rule) {
8100         ds_put_cstr(result, "No match\n");
8101         return;
8102     }
8103
8104     ds_put_format(result, "Rule: table=%"PRIu8" cookie=%#"PRIx64" ",
8105                   table_id, ntohll(rule->up.flow_cookie));
8106     cls_rule_format(&rule->up.cr, result);
8107     ds_put_char(result, '\n');
8108
8109     ds_put_char_multiple(result, '\t', level);
8110     ds_put_cstr(result, "OpenFlow ");
8111     ofpacts_format(rule->up.ofpacts, rule->up.ofpacts_len, result);
8112     ds_put_char(result, '\n');
8113 }
8114
8115 static void
8116 trace_format_flow(struct ds *result, int level, const char *title,
8117                  struct trace_ctx *trace)
8118 {
8119     ds_put_char_multiple(result, '\t', level);
8120     ds_put_format(result, "%s: ", title);
8121     if (flow_equal(&trace->ctx.flow, &trace->flow)) {
8122         ds_put_cstr(result, "unchanged");
8123     } else {
8124         flow_format(result, &trace->ctx.flow);
8125         trace->flow = trace->ctx.flow;
8126     }
8127     ds_put_char(result, '\n');
8128 }
8129
8130 static void
8131 trace_format_regs(struct ds *result, int level, const char *title,
8132                   struct trace_ctx *trace)
8133 {
8134     size_t i;
8135
8136     ds_put_char_multiple(result, '\t', level);
8137     ds_put_format(result, "%s:", title);
8138     for (i = 0; i < FLOW_N_REGS; i++) {
8139         ds_put_format(result, " reg%zu=0x%"PRIx32, i, trace->flow.regs[i]);
8140     }
8141     ds_put_char(result, '\n');
8142 }
8143
8144 static void
8145 trace_format_odp(struct ds *result, int level, const char *title,
8146                  struct trace_ctx *trace)
8147 {
8148     struct ofpbuf *odp_actions = trace->ctx.odp_actions;
8149
8150     ds_put_char_multiple(result, '\t', level);
8151     ds_put_format(result, "%s: ", title);
8152     format_odp_actions(result, odp_actions->data, odp_actions->size);
8153     ds_put_char(result, '\n');
8154 }
8155
8156 static void
8157 trace_resubmit(struct action_xlate_ctx *ctx, struct rule_dpif *rule)
8158 {
8159     struct trace_ctx *trace = CONTAINER_OF(ctx, struct trace_ctx, ctx);
8160     struct ds *result = trace->result;
8161
8162     ds_put_char(result, '\n');
8163     trace_format_flow(result, ctx->recurse + 1, "Resubmitted flow", trace);
8164     trace_format_regs(result, ctx->recurse + 1, "Resubmitted regs", trace);
8165     trace_format_odp(result,  ctx->recurse + 1, "Resubmitted  odp", trace);
8166     trace_format_rule(result, ctx->table_id, ctx->recurse + 1, rule);
8167 }
8168
8169 static void
8170 trace_report(struct action_xlate_ctx *ctx, const char *s)
8171 {
8172     struct trace_ctx *trace = CONTAINER_OF(ctx, struct trace_ctx, ctx);
8173     struct ds *result = trace->result;
8174
8175     ds_put_char_multiple(result, '\t', ctx->recurse);
8176     ds_put_cstr(result, s);
8177     ds_put_char(result, '\n');
8178 }
8179
8180 static void
8181 ofproto_unixctl_trace(struct unixctl_conn *conn, int argc, const char *argv[],
8182                       void *aux OVS_UNUSED)
8183 {
8184     const char *dpname = argv[1];
8185     struct ofproto_dpif *ofproto;
8186     struct ofpbuf odp_key;
8187     struct ofpbuf *packet;
8188     struct initial_vals initial_vals;
8189     struct ds result;
8190     struct flow flow;
8191     char *s;
8192
8193     packet = NULL;
8194     ofpbuf_init(&odp_key, 0);
8195     ds_init(&result);
8196
8197     ofproto = ofproto_dpif_lookup(dpname);
8198     if (!ofproto) {
8199         unixctl_command_reply_error(conn, "Unknown ofproto (use ofproto/list "
8200                                     "for help)");
8201         goto exit;
8202     }
8203     if (argc == 3 || (argc == 4 && !strcmp(argv[3], "-generate"))) {
8204         /* ofproto/trace dpname flow [-generate] */
8205         const char *flow_s = argv[2];
8206         const char *generate_s = argv[3];
8207
8208         /* Allow 'flow_s' to be either a datapath flow or an OpenFlow-like
8209          * flow.  We guess which type it is based on whether 'flow_s' contains
8210          * an '(', since a datapath flow always contains '(') but an
8211          * OpenFlow-like flow should not (in fact it's allowed but I believe
8212          * that's not documented anywhere).
8213          *
8214          * An alternative would be to try to parse 'flow_s' both ways, but then
8215          * it would be tricky giving a sensible error message.  After all, do
8216          * you just say "syntax error" or do you present both error messages?
8217          * Both choices seem lousy. */
8218         if (strchr(flow_s, '(')) {
8219             int error;
8220
8221             /* Convert string to datapath key. */
8222             ofpbuf_init(&odp_key, 0);
8223             error = odp_flow_key_from_string(flow_s, NULL, &odp_key);
8224             if (error) {
8225                 unixctl_command_reply_error(conn, "Bad flow syntax");
8226                 goto exit;
8227             }
8228
8229             /* The user might have specified the wrong ofproto but within the
8230              * same backer.  That's OK, ofproto_receive() can find the right
8231              * one for us. */
8232             if (ofproto_receive(ofproto->backer, NULL, odp_key.data,
8233                                 odp_key.size, &flow, NULL, &ofproto, NULL,
8234                                 &initial_vals)) {
8235                 unixctl_command_reply_error(conn, "Invalid flow");
8236                 goto exit;
8237             }
8238             ds_put_format(&result, "Bridge: %s\n", ofproto->up.name);
8239         } else {
8240             char *error_s;
8241
8242             error_s = parse_ofp_exact_flow(&flow, argv[2]);
8243             if (error_s) {
8244                 unixctl_command_reply_error(conn, error_s);
8245                 free(error_s);
8246                 goto exit;
8247             }
8248
8249             initial_vals.vlan_tci = flow.vlan_tci;
8250         }
8251
8252         /* Generate a packet, if requested. */
8253         if (generate_s) {
8254             packet = ofpbuf_new(0);
8255             flow_compose(packet, &flow);
8256         }
8257     } else if (argc == 7) {
8258         /* ofproto/trace dpname priority tun_id in_port mark packet */
8259         const char *priority_s = argv[2];
8260         const char *tun_id_s = argv[3];
8261         const char *in_port_s = argv[4];
8262         const char *mark_s = argv[5];
8263         const char *packet_s = argv[6];
8264         uint32_t in_port = atoi(in_port_s);
8265         ovs_be64 tun_id = htonll(strtoull(tun_id_s, NULL, 0));
8266         uint32_t priority = atoi(priority_s);
8267         uint32_t mark = atoi(mark_s);
8268         const char *msg;
8269
8270         msg = eth_from_hex(packet_s, &packet);
8271         if (msg) {
8272             unixctl_command_reply_error(conn, msg);
8273             goto exit;
8274         }
8275
8276         ds_put_cstr(&result, "Packet: ");
8277         s = ofp_packet_to_string(packet->data, packet->size);
8278         ds_put_cstr(&result, s);
8279         free(s);
8280
8281         flow_extract(packet, priority, mark, NULL, in_port, &flow);
8282         flow.tunnel.tun_id = tun_id;
8283         initial_vals.vlan_tci = flow.vlan_tci;
8284     } else {
8285         unixctl_command_reply_error(conn, "Bad command syntax");
8286         goto exit;
8287     }
8288
8289     ofproto_trace(ofproto, &flow, packet, &initial_vals, &result);
8290     unixctl_command_reply(conn, ds_cstr(&result));
8291
8292 exit:
8293     ds_destroy(&result);
8294     ofpbuf_delete(packet);
8295     ofpbuf_uninit(&odp_key);
8296 }
8297
8298 static void
8299 ofproto_trace(struct ofproto_dpif *ofproto, const struct flow *flow,
8300               const struct ofpbuf *packet,
8301               const struct initial_vals *initial_vals, struct ds *ds)
8302 {
8303     struct rule_dpif *rule;
8304
8305     ds_put_cstr(ds, "Flow: ");
8306     flow_format(ds, flow);
8307     ds_put_char(ds, '\n');
8308
8309     rule = rule_dpif_lookup(ofproto, flow);
8310
8311     trace_format_rule(ds, 0, 0, rule);
8312     if (rule == ofproto->miss_rule) {
8313         ds_put_cstr(ds, "\nNo match, flow generates \"packet in\"s.\n");
8314     } else if (rule == ofproto->no_packet_in_rule) {
8315         ds_put_cstr(ds, "\nNo match, packets dropped because "
8316                     "OFPPC_NO_PACKET_IN is set on in_port.\n");
8317     }
8318
8319     if (rule) {
8320         uint64_t odp_actions_stub[1024 / 8];
8321         struct ofpbuf odp_actions;
8322
8323         struct trace_ctx trace;
8324         uint8_t tcp_flags;
8325
8326         tcp_flags = packet ? packet_get_tcp_flags(packet, flow) : 0;
8327         trace.result = ds;
8328         trace.flow = *flow;
8329         ofpbuf_use_stub(&odp_actions,
8330                         odp_actions_stub, sizeof odp_actions_stub);
8331         action_xlate_ctx_init(&trace.ctx, ofproto, flow, initial_vals,
8332                               rule, tcp_flags, packet);
8333         trace.ctx.resubmit_hook = trace_resubmit;
8334         trace.ctx.report_hook = trace_report;
8335         xlate_actions(&trace.ctx, rule->up.ofpacts, rule->up.ofpacts_len,
8336                       &odp_actions);
8337
8338         ds_put_char(ds, '\n');
8339         trace_format_flow(ds, 0, "Final flow", &trace);
8340         ds_put_cstr(ds, "Datapath actions: ");
8341         format_odp_actions(ds, odp_actions.data, odp_actions.size);
8342         ofpbuf_uninit(&odp_actions);
8343
8344         if (trace.ctx.slow) {
8345             enum slow_path_reason slow;
8346
8347             ds_put_cstr(ds, "\nThis flow is handled by the userspace "
8348                         "slow path because it:");
8349             for (slow = trace.ctx.slow; slow; ) {
8350                 enum slow_path_reason bit = rightmost_1bit(slow);
8351
8352                 switch (bit) {
8353                 case SLOW_CFM:
8354                     ds_put_cstr(ds, "\n\t- Consists of CFM packets.");
8355                     break;
8356                 case SLOW_LACP:
8357                     ds_put_cstr(ds, "\n\t- Consists of LACP packets.");
8358                     break;
8359                 case SLOW_STP:
8360                     ds_put_cstr(ds, "\n\t- Consists of STP packets.");
8361                     break;
8362                 case SLOW_BFD:
8363                     ds_put_cstr(ds, "\n\t- Consists of BFD packets.");
8364                     break;
8365                 case SLOW_IN_BAND:
8366                     ds_put_cstr(ds, "\n\t- Needs in-band special case "
8367                                 "processing.");
8368                     if (!packet) {
8369                         ds_put_cstr(ds, "\n\t  (The datapath actions are "
8370                                     "incomplete--for complete actions, "
8371                                     "please supply a packet.)");
8372                     }
8373                     break;
8374                 case SLOW_CONTROLLER:
8375                     ds_put_cstr(ds, "\n\t- Sends \"packet-in\" messages "
8376                                 "to the OpenFlow controller.");
8377                     break;
8378                 case SLOW_MATCH:
8379                     ds_put_cstr(ds, "\n\t- Needs more specific matching "
8380                                 "than the datapath supports.");
8381                     break;
8382                 }
8383
8384                 slow &= ~bit;
8385             }
8386
8387             if (slow & ~SLOW_MATCH) {
8388                 ds_put_cstr(ds, "\nThe datapath actions above do not reflect "
8389                             "the special slow-path processing.");
8390             }
8391         }
8392     }
8393 }
8394
8395 static void
8396 ofproto_dpif_clog(struct unixctl_conn *conn OVS_UNUSED, int argc OVS_UNUSED,
8397                   const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED)
8398 {
8399     clogged = true;
8400     unixctl_command_reply(conn, NULL);
8401 }
8402
8403 static void
8404 ofproto_dpif_unclog(struct unixctl_conn *conn OVS_UNUSED, int argc OVS_UNUSED,
8405                     const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED)
8406 {
8407     clogged = false;
8408     unixctl_command_reply(conn, NULL);
8409 }
8410
8411 /* Runs a self-check of flow translations in 'ofproto'.  Appends a message to
8412  * 'reply' describing the results. */
8413 static void
8414 ofproto_dpif_self_check__(struct ofproto_dpif *ofproto, struct ds *reply)
8415 {
8416     struct facet *facet;
8417     int errors;
8418
8419     errors = 0;
8420     HMAP_FOR_EACH (facet, hmap_node, &ofproto->facets) {
8421         if (!facet_check_consistency(facet)) {
8422             errors++;
8423         }
8424     }
8425     if (errors) {
8426         ofproto->backer->need_revalidate = REV_INCONSISTENCY;
8427     }
8428
8429     if (errors) {
8430         ds_put_format(reply, "%s: self-check failed (%d errors)\n",
8431                       ofproto->up.name, errors);
8432     } else {
8433         ds_put_format(reply, "%s: self-check passed\n", ofproto->up.name);
8434     }
8435 }
8436
8437 static void
8438 ofproto_dpif_self_check(struct unixctl_conn *conn,
8439                         int argc, const char *argv[], void *aux OVS_UNUSED)
8440 {
8441     struct ds reply = DS_EMPTY_INITIALIZER;
8442     struct ofproto_dpif *ofproto;
8443
8444     if (argc > 1) {
8445         ofproto = ofproto_dpif_lookup(argv[1]);
8446         if (!ofproto) {
8447             unixctl_command_reply_error(conn, "Unknown ofproto (use "
8448                                         "ofproto/list for help)");
8449             return;
8450         }
8451         ofproto_dpif_self_check__(ofproto, &reply);
8452     } else {
8453         HMAP_FOR_EACH (ofproto, all_ofproto_dpifs_node, &all_ofproto_dpifs) {
8454             ofproto_dpif_self_check__(ofproto, &reply);
8455         }
8456     }
8457
8458     unixctl_command_reply(conn, ds_cstr(&reply));
8459     ds_destroy(&reply);
8460 }
8461
8462 /* Store the current ofprotos in 'ofproto_shash'.  Returns a sorted list
8463  * of the 'ofproto_shash' nodes.  It is the responsibility of the caller
8464  * to destroy 'ofproto_shash' and free the returned value. */
8465 static const struct shash_node **
8466 get_ofprotos(struct shash *ofproto_shash)
8467 {
8468     const struct ofproto_dpif *ofproto;
8469
8470     HMAP_FOR_EACH (ofproto, all_ofproto_dpifs_node, &all_ofproto_dpifs) {
8471         char *name = xasprintf("%s@%s", ofproto->up.type, ofproto->up.name);
8472         shash_add_nocopy(ofproto_shash, name, ofproto);
8473     }
8474
8475     return shash_sort(ofproto_shash);
8476 }
8477
8478 static void
8479 ofproto_unixctl_dpif_dump_dps(struct unixctl_conn *conn, int argc OVS_UNUSED,
8480                               const char *argv[] OVS_UNUSED,
8481                               void *aux OVS_UNUSED)
8482 {
8483     struct ds ds = DS_EMPTY_INITIALIZER;
8484     struct shash ofproto_shash;
8485     const struct shash_node **sorted_ofprotos;
8486     int i;
8487
8488     shash_init(&ofproto_shash);
8489     sorted_ofprotos = get_ofprotos(&ofproto_shash);
8490     for (i = 0; i < shash_count(&ofproto_shash); i++) {
8491         const struct shash_node *node = sorted_ofprotos[i];
8492         ds_put_format(&ds, "%s\n", node->name);
8493     }
8494
8495     shash_destroy(&ofproto_shash);
8496     free(sorted_ofprotos);
8497
8498     unixctl_command_reply(conn, ds_cstr(&ds));
8499     ds_destroy(&ds);
8500 }
8501
8502 static void
8503 show_dp_format(const struct ofproto_dpif *ofproto, struct ds *ds)
8504 {
8505     const struct shash_node **ports;
8506     int i;
8507     struct avg_subfacet_rates lifetime;
8508     unsigned long long int minutes;
8509     const int min_ms = 60 * 1000; /* milliseconds in one minute. */
8510
8511     minutes = (time_msec() - ofproto->created) / min_ms;
8512
8513     if (minutes > 0) {
8514         lifetime.add_rate = (double)ofproto->total_subfacet_add_count
8515                             / minutes;
8516         lifetime.del_rate = (double)ofproto->total_subfacet_del_count
8517                             / minutes;
8518     }else {
8519         lifetime.add_rate = 0.0;
8520         lifetime.del_rate = 0.0;
8521     }
8522
8523     ds_put_format(ds, "%s (%s):\n", ofproto->up.name,
8524                   dpif_name(ofproto->backer->dpif));
8525     ds_put_format(ds,
8526                   "\tlookups: hit:%"PRIu64" missed:%"PRIu64"\n",
8527                   ofproto->n_hit, ofproto->n_missed);
8528     ds_put_format(ds, "\tflows: cur: %zu, avg: %5.3f, max: %d,"
8529                   " life span: %llu(ms)\n",
8530                   hmap_count(&ofproto->subfacets),
8531                   avg_subfacet_count(ofproto),
8532                   ofproto->max_n_subfacet,
8533                   avg_subfacet_life_span(ofproto));
8534     if (minutes >= 60) {
8535         show_dp_rates(ds, "\t\thourly avg:", &ofproto->hourly);
8536     }
8537     if (minutes >= 60 * 24) {
8538         show_dp_rates(ds, "\t\tdaily avg:",  &ofproto->daily);
8539     }
8540     show_dp_rates(ds, "\t\toverall avg:",  &lifetime);
8541
8542     ports = shash_sort(&ofproto->up.port_by_name);
8543     for (i = 0; i < shash_count(&ofproto->up.port_by_name); i++) {
8544         const struct shash_node *node = ports[i];
8545         struct ofport *ofport = node->data;
8546         const char *name = netdev_get_name(ofport->netdev);
8547         const char *type = netdev_get_type(ofport->netdev);
8548         uint32_t odp_port;
8549
8550         ds_put_format(ds, "\t%s %u/", name, ofport->ofp_port);
8551
8552         odp_port = ofp_port_to_odp_port(ofproto, ofport->ofp_port);
8553         if (odp_port != OVSP_NONE) {
8554             ds_put_format(ds, "%"PRIu32":", odp_port);
8555         } else {
8556             ds_put_cstr(ds, "none:");
8557         }
8558
8559         if (strcmp(type, "system")) {
8560             struct netdev *netdev;
8561             int error;
8562
8563             ds_put_format(ds, " (%s", type);
8564
8565             error = netdev_open(name, type, &netdev);
8566             if (!error) {
8567                 struct smap config;
8568
8569                 smap_init(&config);
8570                 error = netdev_get_config(netdev, &config);
8571                 if (!error) {
8572                     const struct smap_node **nodes;
8573                     size_t i;
8574
8575                     nodes = smap_sort(&config);
8576                     for (i = 0; i < smap_count(&config); i++) {
8577                         const struct smap_node *node = nodes[i];
8578                         ds_put_format(ds, "%c %s=%s", i ? ',' : ':',
8579                                       node->key, node->value);
8580                     }
8581                     free(nodes);
8582                 }
8583                 smap_destroy(&config);
8584
8585                 netdev_close(netdev);
8586             }
8587             ds_put_char(ds, ')');
8588         }
8589         ds_put_char(ds, '\n');
8590     }
8591     free(ports);
8592 }
8593
8594 static void
8595 ofproto_unixctl_dpif_show(struct unixctl_conn *conn, int argc,
8596                           const char *argv[], void *aux OVS_UNUSED)
8597 {
8598     struct ds ds = DS_EMPTY_INITIALIZER;
8599     const struct ofproto_dpif *ofproto;
8600
8601     if (argc > 1) {
8602         int i;
8603         for (i = 1; i < argc; i++) {
8604             ofproto = ofproto_dpif_lookup(argv[i]);
8605             if (!ofproto) {
8606                 ds_put_format(&ds, "Unknown bridge %s (use dpif/dump-dps "
8607                                    "for help)", argv[i]);
8608                 unixctl_command_reply_error(conn, ds_cstr(&ds));
8609                 return;
8610             }
8611             show_dp_format(ofproto, &ds);
8612         }
8613     } else {
8614         struct shash ofproto_shash;
8615         const struct shash_node **sorted_ofprotos;
8616         int i;
8617
8618         shash_init(&ofproto_shash);
8619         sorted_ofprotos = get_ofprotos(&ofproto_shash);
8620         for (i = 0; i < shash_count(&ofproto_shash); i++) {
8621             const struct shash_node *node = sorted_ofprotos[i];
8622             show_dp_format(node->data, &ds);
8623         }
8624
8625         shash_destroy(&ofproto_shash);
8626         free(sorted_ofprotos);
8627     }
8628
8629     unixctl_command_reply(conn, ds_cstr(&ds));
8630     ds_destroy(&ds);
8631 }
8632
8633 static void
8634 ofproto_unixctl_dpif_dump_flows(struct unixctl_conn *conn,
8635                                 int argc OVS_UNUSED, const char *argv[],
8636                                 void *aux OVS_UNUSED)
8637 {
8638     struct ds ds = DS_EMPTY_INITIALIZER;
8639     const struct ofproto_dpif *ofproto;
8640     struct subfacet *subfacet;
8641
8642     ofproto = ofproto_dpif_lookup(argv[1]);
8643     if (!ofproto) {
8644         unixctl_command_reply_error(conn, "no such bridge");
8645         return;
8646     }
8647
8648     update_stats(ofproto->backer);
8649
8650     HMAP_FOR_EACH (subfacet, hmap_node, &ofproto->subfacets) {
8651         odp_flow_key_format(subfacet->key, subfacet->key_len, &ds);
8652
8653         ds_put_format(&ds, ", packets:%"PRIu64", bytes:%"PRIu64", used:",
8654                       subfacet->dp_packet_count, subfacet->dp_byte_count);
8655         if (subfacet->used) {
8656             ds_put_format(&ds, "%.3fs",
8657                           (time_msec() - subfacet->used) / 1000.0);
8658         } else {
8659             ds_put_format(&ds, "never");
8660         }
8661         if (subfacet->facet->tcp_flags) {
8662             ds_put_cstr(&ds, ", flags:");
8663             packet_format_tcp_flags(&ds, subfacet->facet->tcp_flags);
8664         }
8665
8666         ds_put_cstr(&ds, ", actions:");
8667         if (subfacet->slow) {
8668             uint64_t slow_path_stub[128 / 8];
8669             const struct nlattr *actions;
8670             size_t actions_len;
8671
8672             compose_slow_path(ofproto, &subfacet->facet->flow, subfacet->slow,
8673                               slow_path_stub, sizeof slow_path_stub,
8674                               &actions, &actions_len);
8675             format_odp_actions(&ds, actions, actions_len);
8676         } else {
8677             format_odp_actions(&ds, subfacet->actions, subfacet->actions_len);
8678         }
8679         ds_put_char(&ds, '\n');
8680     }
8681
8682     unixctl_command_reply(conn, ds_cstr(&ds));
8683     ds_destroy(&ds);
8684 }
8685
8686 static void
8687 ofproto_unixctl_dpif_del_flows(struct unixctl_conn *conn,
8688                                int argc OVS_UNUSED, const char *argv[],
8689                                void *aux OVS_UNUSED)
8690 {
8691     struct ds ds = DS_EMPTY_INITIALIZER;
8692     struct ofproto_dpif *ofproto;
8693
8694     ofproto = ofproto_dpif_lookup(argv[1]);
8695     if (!ofproto) {
8696         unixctl_command_reply_error(conn, "no such bridge");
8697         return;
8698     }
8699
8700     flush(&ofproto->up);
8701
8702     unixctl_command_reply(conn, ds_cstr(&ds));
8703     ds_destroy(&ds);
8704 }
8705
8706 static void
8707 ofproto_dpif_unixctl_init(void)
8708 {
8709     static bool registered;
8710     if (registered) {
8711         return;
8712     }
8713     registered = true;
8714
8715     unixctl_command_register(
8716         "ofproto/trace",
8717         "bridge {priority tun_id in_port mark packet | odp_flow [-generate]}",
8718         2, 6, ofproto_unixctl_trace, NULL);
8719     unixctl_command_register("fdb/flush", "[bridge]", 0, 1,
8720                              ofproto_unixctl_fdb_flush, NULL);
8721     unixctl_command_register("fdb/show", "bridge", 1, 1,
8722                              ofproto_unixctl_fdb_show, NULL);
8723     unixctl_command_register("ofproto/clog", "", 0, 0,
8724                              ofproto_dpif_clog, NULL);
8725     unixctl_command_register("ofproto/unclog", "", 0, 0,
8726                              ofproto_dpif_unclog, NULL);
8727     unixctl_command_register("ofproto/self-check", "[bridge]", 0, 1,
8728                              ofproto_dpif_self_check, NULL);
8729     unixctl_command_register("dpif/dump-dps", "", 0, 0,
8730                              ofproto_unixctl_dpif_dump_dps, NULL);
8731     unixctl_command_register("dpif/show", "[bridge]", 0, INT_MAX,
8732                              ofproto_unixctl_dpif_show, NULL);
8733     unixctl_command_register("dpif/dump-flows", "bridge", 1, 1,
8734                              ofproto_unixctl_dpif_dump_flows, NULL);
8735     unixctl_command_register("dpif/del-flows", "bridge", 1, 1,
8736                              ofproto_unixctl_dpif_del_flows, NULL);
8737 }
8738 \f
8739 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
8740  *
8741  * This is deprecated.  It is only for compatibility with broken device drivers
8742  * in old versions of Linux that do not properly support VLANs when VLAN
8743  * devices are not used.  When broken device drivers are no longer in
8744  * widespread use, we will delete these interfaces. */
8745
8746 static int
8747 set_realdev(struct ofport *ofport_, uint16_t realdev_ofp_port, int vid)
8748 {
8749     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofport_->ofproto);
8750     struct ofport_dpif *ofport = ofport_dpif_cast(ofport_);
8751
8752     if (realdev_ofp_port == ofport->realdev_ofp_port
8753         && vid == ofport->vlandev_vid) {
8754         return 0;
8755     }
8756
8757     ofproto->backer->need_revalidate = REV_RECONFIGURE;
8758
8759     if (ofport->realdev_ofp_port) {
8760         vsp_remove(ofport);
8761     }
8762     if (realdev_ofp_port && ofport->bundle) {
8763         /* vlandevs are enslaved to their realdevs, so they are not allowed to
8764          * themselves be part of a bundle. */
8765         bundle_set(ofport->up.ofproto, ofport->bundle, NULL);
8766     }
8767
8768     ofport->realdev_ofp_port = realdev_ofp_port;
8769     ofport->vlandev_vid = vid;
8770
8771     if (realdev_ofp_port) {
8772         vsp_add(ofport, realdev_ofp_port, vid);
8773     }
8774
8775     return 0;
8776 }
8777
8778 static uint32_t
8779 hash_realdev_vid(uint16_t realdev_ofp_port, int vid)
8780 {
8781     return hash_2words(realdev_ofp_port, vid);
8782 }
8783
8784 /* Returns the ODP port number of the Linux VLAN device that corresponds to
8785  * 'vlan_tci' on the network device with port number 'realdev_odp_port' in
8786  * 'ofproto'.  For example, given 'realdev_odp_port' of eth0 and 'vlan_tci' 9,
8787  * it would return the port number of eth0.9.
8788  *
8789  * Unless VLAN splinters are enabled for port 'realdev_odp_port', this
8790  * function just returns its 'realdev_odp_port' argument. */
8791 static uint32_t
8792 vsp_realdev_to_vlandev(const struct ofproto_dpif *ofproto,
8793                        uint32_t realdev_odp_port, ovs_be16 vlan_tci)
8794 {
8795     if (!hmap_is_empty(&ofproto->realdev_vid_map)) {
8796         uint16_t realdev_ofp_port;
8797         int vid = vlan_tci_to_vid(vlan_tci);
8798         const struct vlan_splinter *vsp;
8799
8800         realdev_ofp_port = odp_port_to_ofp_port(ofproto, realdev_odp_port);
8801         HMAP_FOR_EACH_WITH_HASH (vsp, realdev_vid_node,
8802                                  hash_realdev_vid(realdev_ofp_port, vid),
8803                                  &ofproto->realdev_vid_map) {
8804             if (vsp->realdev_ofp_port == realdev_ofp_port
8805                 && vsp->vid == vid) {
8806                 return ofp_port_to_odp_port(ofproto, vsp->vlandev_ofp_port);
8807             }
8808         }
8809     }
8810     return realdev_odp_port;
8811 }
8812
8813 static struct vlan_splinter *
8814 vlandev_find(const struct ofproto_dpif *ofproto, uint16_t vlandev_ofp_port)
8815 {
8816     struct vlan_splinter *vsp;
8817
8818     HMAP_FOR_EACH_WITH_HASH (vsp, vlandev_node, hash_int(vlandev_ofp_port, 0),
8819                              &ofproto->vlandev_map) {
8820         if (vsp->vlandev_ofp_port == vlandev_ofp_port) {
8821             return vsp;
8822         }
8823     }
8824
8825     return NULL;
8826 }
8827
8828 /* Returns the OpenFlow port number of the "real" device underlying the Linux
8829  * VLAN device with OpenFlow port number 'vlandev_ofp_port' and stores the
8830  * VLAN VID of the Linux VLAN device in '*vid'.  For example, given
8831  * 'vlandev_ofp_port' of eth0.9, it would return the OpenFlow port number of
8832  * eth0 and store 9 in '*vid'.
8833  *
8834  * Returns 0 and does not modify '*vid' if 'vlandev_ofp_port' is not a Linux
8835  * VLAN device.  Unless VLAN splinters are enabled, this is what this function
8836  * always does.*/
8837 static uint16_t
8838 vsp_vlandev_to_realdev(const struct ofproto_dpif *ofproto,
8839                        uint16_t vlandev_ofp_port, int *vid)
8840 {
8841     if (!hmap_is_empty(&ofproto->vlandev_map)) {
8842         const struct vlan_splinter *vsp;
8843
8844         vsp = vlandev_find(ofproto, vlandev_ofp_port);
8845         if (vsp) {
8846             if (vid) {
8847                 *vid = vsp->vid;
8848             }
8849             return vsp->realdev_ofp_port;
8850         }
8851     }
8852     return 0;
8853 }
8854
8855 /* Given 'flow', a flow representing a packet received on 'ofproto', checks
8856  * whether 'flow->in_port' represents a Linux VLAN device.  If so, changes
8857  * 'flow->in_port' to the "real" device backing the VLAN device, sets
8858  * 'flow->vlan_tci' to the VLAN VID, and returns true.  Otherwise (which is
8859  * always the case unless VLAN splinters are enabled), returns false without
8860  * making any changes. */
8861 static bool
8862 vsp_adjust_flow(const struct ofproto_dpif *ofproto, struct flow *flow)
8863 {
8864     uint16_t realdev;
8865     int vid;
8866
8867     realdev = vsp_vlandev_to_realdev(ofproto, flow->in_port, &vid);
8868     if (!realdev) {
8869         return false;
8870     }
8871
8872     /* Cause the flow to be processed as if it came in on the real device with
8873      * the VLAN device's VLAN ID. */
8874     flow->in_port = realdev;
8875     flow->vlan_tci = htons((vid & VLAN_VID_MASK) | VLAN_CFI);
8876     return true;
8877 }
8878
8879 static void
8880 vsp_remove(struct ofport_dpif *port)
8881 {
8882     struct ofproto_dpif *ofproto = ofproto_dpif_cast(port->up.ofproto);
8883     struct vlan_splinter *vsp;
8884
8885     vsp = vlandev_find(ofproto, port->up.ofp_port);
8886     if (vsp) {
8887         hmap_remove(&ofproto->vlandev_map, &vsp->vlandev_node);
8888         hmap_remove(&ofproto->realdev_vid_map, &vsp->realdev_vid_node);
8889         free(vsp);
8890
8891         port->realdev_ofp_port = 0;
8892     } else {
8893         VLOG_ERR("missing vlan device record");
8894     }
8895 }
8896
8897 static void
8898 vsp_add(struct ofport_dpif *port, uint16_t realdev_ofp_port, int vid)
8899 {
8900     struct ofproto_dpif *ofproto = ofproto_dpif_cast(port->up.ofproto);
8901
8902     if (!vsp_vlandev_to_realdev(ofproto, port->up.ofp_port, NULL)
8903         && (vsp_realdev_to_vlandev(ofproto, realdev_ofp_port, htons(vid))
8904             == realdev_ofp_port)) {
8905         struct vlan_splinter *vsp;
8906
8907         vsp = xmalloc(sizeof *vsp);
8908         hmap_insert(&ofproto->vlandev_map, &vsp->vlandev_node,
8909                     hash_int(port->up.ofp_port, 0));
8910         hmap_insert(&ofproto->realdev_vid_map, &vsp->realdev_vid_node,
8911                     hash_realdev_vid(realdev_ofp_port, vid));
8912         vsp->realdev_ofp_port = realdev_ofp_port;
8913         vsp->vlandev_ofp_port = port->up.ofp_port;
8914         vsp->vid = vid;
8915
8916         port->realdev_ofp_port = realdev_ofp_port;
8917     } else {
8918         VLOG_ERR("duplicate vlan device record");
8919     }
8920 }
8921
8922 static uint32_t
8923 ofp_port_to_odp_port(const struct ofproto_dpif *ofproto, uint16_t ofp_port)
8924 {
8925     const struct ofport_dpif *ofport = get_ofp_port(ofproto, ofp_port);
8926     return ofport ? ofport->odp_port : OVSP_NONE;
8927 }
8928
8929 static struct ofport_dpif *
8930 odp_port_to_ofport(const struct dpif_backer *backer, uint32_t odp_port)
8931 {
8932     struct ofport_dpif *port;
8933
8934     HMAP_FOR_EACH_IN_BUCKET (port, odp_port_node,
8935                              hash_int(odp_port, 0),
8936                              &backer->odp_to_ofport_map) {
8937         if (port->odp_port == odp_port) {
8938             return port;
8939         }
8940     }
8941
8942     return NULL;
8943 }
8944
8945 static uint16_t
8946 odp_port_to_ofp_port(const struct ofproto_dpif *ofproto, uint32_t odp_port)
8947 {
8948     struct ofport_dpif *port;
8949
8950     port = odp_port_to_ofport(ofproto->backer, odp_port);
8951     if (port && &ofproto->up == port->up.ofproto) {
8952         return port->up.ofp_port;
8953     } else {
8954         return OFPP_NONE;
8955     }
8956 }
8957 static unsigned long long int
8958 avg_subfacet_life_span(const struct ofproto_dpif *ofproto)
8959 {
8960     unsigned long long int dc;
8961     unsigned long long int avg;
8962
8963     dc = ofproto->total_subfacet_del_count + ofproto->subfacet_del_count;
8964     avg = dc ? ofproto->total_subfacet_life_span / dc : 0;
8965
8966     return avg;
8967 }
8968
8969 static double
8970 avg_subfacet_count(const struct ofproto_dpif *ofproto)
8971 {
8972     double avg_c = 0.0;
8973
8974     if (ofproto->n_update_stats) {
8975         avg_c = (double)ofproto->total_subfacet_count
8976                 / ofproto->n_update_stats;
8977     }
8978
8979     return avg_c;
8980 }
8981
8982 static void
8983 show_dp_rates(struct ds *ds, const char *heading,
8984               const struct avg_subfacet_rates *rates)
8985 {
8986     ds_put_format(ds, "%s add rate: %5.3f/min, del rate: %5.3f/min\n",
8987                   heading, rates->add_rate, rates->del_rate);
8988 }
8989
8990 static void
8991 update_max_subfacet_count(struct ofproto_dpif *ofproto)
8992 {
8993     ofproto->max_n_subfacet = MAX(ofproto->max_n_subfacet,
8994                                   hmap_count(&ofproto->subfacets));
8995 }
8996
8997 /* Compute exponentially weighted moving average, adding 'new' as the newest,
8998  * most heavily weighted element.  'base' designates the rate of decay: after
8999  * 'base' further updates, 'new''s weight in the EWMA decays to about 1/e
9000  * (about .37). */
9001 static void
9002 exp_mavg(double *avg, int base, double new)
9003 {
9004     *avg = (*avg * (base - 1) + new) / base;
9005 }
9006
9007 static void
9008 update_moving_averages(struct ofproto_dpif *ofproto)
9009 {
9010     const int min_ms = 60 * 1000; /* milliseconds in one minute. */
9011
9012     /* Update hourly averages on the minute boundaries. */
9013     if (time_msec() - ofproto->last_minute >= min_ms) {
9014         exp_mavg(&ofproto->hourly.add_rate, 60, ofproto->subfacet_add_count);
9015         exp_mavg(&ofproto->hourly.del_rate, 60, ofproto->subfacet_del_count);
9016
9017         /* Update daily averages on the hour boundaries. */
9018         if ((ofproto->last_minute - ofproto->created) / min_ms % 60 == 59) {
9019             exp_mavg(&ofproto->daily.add_rate, 24, ofproto->hourly.add_rate);
9020             exp_mavg(&ofproto->daily.del_rate, 24, ofproto->hourly.del_rate);
9021         }
9022
9023         ofproto->total_subfacet_add_count += ofproto->subfacet_add_count;
9024         ofproto->total_subfacet_del_count += ofproto->subfacet_del_count;
9025         ofproto->subfacet_add_count = 0;
9026         ofproto->subfacet_del_count = 0;
9027         ofproto->last_minute += min_ms;
9028     }
9029 }
9030
9031 static void
9032 dpif_stats_update_hit_count(struct ofproto_dpif *ofproto, uint64_t delta)
9033 {
9034     ofproto->n_hit += delta;
9035 }
9036
9037 const struct ofproto_class ofproto_dpif_class = {
9038     init,
9039     enumerate_types,
9040     enumerate_names,
9041     del,
9042     port_open_type,
9043     type_run,
9044     type_run_fast,
9045     type_wait,
9046     alloc,
9047     construct,
9048     destruct,
9049     dealloc,
9050     run,
9051     run_fast,
9052     wait,
9053     get_memory_usage,
9054     flush,
9055     get_features,
9056     get_tables,
9057     port_alloc,
9058     port_construct,
9059     port_destruct,
9060     port_dealloc,
9061     port_modified,
9062     port_reconfigured,
9063     port_query_by_name,
9064     port_add,
9065     port_del,
9066     port_get_stats,
9067     port_dump_start,
9068     port_dump_next,
9069     port_dump_done,
9070     port_poll,
9071     port_poll_wait,
9072     port_is_lacp_current,
9073     NULL,                       /* rule_choose_table */
9074     rule_alloc,
9075     rule_construct,
9076     rule_destruct,
9077     rule_dealloc,
9078     rule_get_stats,
9079     rule_execute,
9080     rule_modify_actions,
9081     set_frag_handling,
9082     packet_out,
9083     set_netflow,
9084     get_netflow_ids,
9085     set_sflow,
9086     set_ipfix,
9087     set_cfm,
9088     get_cfm_status,
9089     set_bfd,
9090     get_bfd_status,
9091     set_stp,
9092     get_stp_status,
9093     set_stp_port,
9094     get_stp_port_status,
9095     set_queues,
9096     bundle_set,
9097     bundle_remove,
9098     mirror_set,
9099     mirror_get_stats,
9100     set_flood_vlans,
9101     is_mirror_output_bundle,
9102     forward_bpdu_changed,
9103     set_mac_table_config,
9104     set_realdev,
9105 };