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