ofproto/ofproto-dpif.c

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