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