ofproto/ofproto-dpif.c

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