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