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