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