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     }
2828     HMAP_FOR_EACH_SAFE (miss, next_miss, hmap_node, &todo) {
2829         ofpbuf_list_delete(&miss->packets);
2830         hmap_remove(&todo, &miss->hmap_node);
2831         free(miss);
2832     }
2833     hmap_destroy(&todo);
2834 }
2835
2836 static void
2837 handle_userspace_upcall(struct ofproto_dpif *ofproto,
2838                         struct dpif_upcall *upcall)
2839 {
2840     struct user_action_cookie cookie;
2841     enum odp_key_fitness fitness;
2842     ovs_be16 initial_tci;
2843     struct flow flow;
2844
2845     memcpy(&cookie, &upcall->userdata, sizeof(cookie));
2846
2847     fitness = ofproto_dpif_extract_flow_key(ofproto, upcall->key,
2848                                             upcall->key_len, &flow,
2849                                             &initial_tci, upcall->packet);
2850     if (fitness == ODP_FIT_ERROR) {
2851         ofpbuf_delete(upcall->packet);
2852         return;
2853     }
2854
2855     if (cookie.type == USER_ACTION_COOKIE_SFLOW) {
2856         if (ofproto->sflow) {
2857             dpif_sflow_received(ofproto->sflow, upcall->packet, &flow,
2858                                 &cookie);
2859         }
2860     } else {
2861         VLOG_WARN_RL(&rl, "invalid user cookie : 0x%"PRIx64, upcall->userdata);
2862     }
2863     ofpbuf_delete(upcall->packet);
2864 }
2865
2866 static int
2867 handle_upcalls(struct ofproto_dpif *ofproto, unsigned int max_batch)
2868 {
2869     struct dpif_upcall misses[FLOW_MISS_MAX_BATCH];
2870     int n_misses;
2871     int i;
2872
2873     assert (max_batch <= FLOW_MISS_MAX_BATCH);
2874
2875     n_misses = 0;
2876     for (i = 0; i < max_batch; i++) {
2877         struct dpif_upcall *upcall = &misses[n_misses];
2878         int error;
2879
2880         error = dpif_recv(ofproto->dpif, upcall);
2881         if (error) {
2882             break;
2883         }
2884
2885         switch (upcall->type) {
2886         case DPIF_UC_ACTION:
2887             handle_userspace_upcall(ofproto, upcall);
2888             break;
2889
2890         case DPIF_UC_MISS:
2891             /* Handle it later. */
2892             n_misses++;
2893             break;
2894
2895         case DPIF_N_UC_TYPES:
2896         default:
2897             VLOG_WARN_RL(&rl, "upcall has unexpected type %"PRIu32,
2898                          upcall->type);
2899             break;
2900         }
2901     }
2902
2903     handle_miss_upcalls(ofproto, misses, n_misses);
2904
2905     return i;
2906 }
2907 \f
2908 /* Flow expiration. */
2909
2910 static int subfacet_max_idle(const struct ofproto_dpif *);
2911 static void update_stats(struct ofproto_dpif *);
2912 static void rule_expire(struct rule_dpif *);
2913 static void expire_subfacets(struct ofproto_dpif *, int dp_max_idle);
2914
2915 /* This function is called periodically by run().  Its job is to collect
2916  * updates for the flows that have been installed into the datapath, most
2917  * importantly when they last were used, and then use that information to
2918  * expire flows that have not been used recently.
2919  *
2920  * Returns the number of milliseconds after which it should be called again. */
2921 static int
2922 expire(struct ofproto_dpif *ofproto)
2923 {
2924     struct rule_dpif *rule, *next_rule;
2925     struct oftable *table;
2926     int dp_max_idle;
2927
2928     /* Update stats for each flow in the datapath. */
2929     update_stats(ofproto);
2930
2931     /* Expire subfacets that have been idle too long. */
2932     dp_max_idle = subfacet_max_idle(ofproto);
2933     expire_subfacets(ofproto, dp_max_idle);
2934
2935     /* Expire OpenFlow flows whose idle_timeout or hard_timeout has passed. */
2936     OFPROTO_FOR_EACH_TABLE (table, &ofproto->up) {
2937         struct cls_cursor cursor;
2938
2939         cls_cursor_init(&cursor, &table->cls, NULL);
2940         CLS_CURSOR_FOR_EACH_SAFE (rule, next_rule, up.cr, &cursor) {
2941             rule_expire(rule);
2942         }
2943     }
2944
2945     /* All outstanding data in existing flows has been accounted, so it's a
2946      * good time to do bond rebalancing. */
2947     if (ofproto->has_bonded_bundles) {
2948         struct ofbundle *bundle;
2949
2950         HMAP_FOR_EACH (bundle, hmap_node, &ofproto->bundles) {
2951             if (bundle->bond) {
2952                 bond_rebalance(bundle->bond, &ofproto->revalidate_set);
2953             }
2954         }
2955     }
2956
2957     return MIN(dp_max_idle, 1000);
2958 }
2959
2960 /* Update 'packet_count', 'byte_count', and 'used' members of installed facets.
2961  *
2962  * This function also pushes statistics updates to rules which each facet
2963  * resubmits into.  Generally these statistics will be accurate.  However, if a
2964  * facet changes the rule it resubmits into at some time in between
2965  * update_stats() runs, it is possible that statistics accrued to the
2966  * old rule will be incorrectly attributed to the new rule.  This could be
2967  * avoided by calling update_stats() whenever rules are created or
2968  * deleted.  However, the performance impact of making so many calls to the
2969  * datapath do not justify the benefit of having perfectly accurate statistics.
2970  */
2971 static void
2972 update_stats(struct ofproto_dpif *p)
2973 {
2974     const struct dpif_flow_stats *stats;
2975     struct dpif_flow_dump dump;
2976     const struct nlattr *key;
2977     size_t key_len;
2978
2979     dpif_flow_dump_start(&dump, p->dpif);
2980     while (dpif_flow_dump_next(&dump, &key, &key_len, NULL, NULL, &stats)) {
2981         struct subfacet *subfacet;
2982
2983         subfacet = subfacet_find(p, key, key_len);
2984         if (subfacet && subfacet->installed) {
2985             struct facet *facet = subfacet->facet;
2986
2987             if (stats->n_packets >= subfacet->dp_packet_count) {
2988                 uint64_t extra = stats->n_packets - subfacet->dp_packet_count;
2989                 facet->packet_count += extra;
2990             } else {
2991                 VLOG_WARN_RL(&rl, "unexpected packet count from the datapath");
2992             }
2993
2994             if (stats->n_bytes >= subfacet->dp_byte_count) {
2995                 facet->byte_count += stats->n_bytes - subfacet->dp_byte_count;
2996             } else {
2997                 VLOG_WARN_RL(&rl, "unexpected byte count from datapath");
2998             }
2999
3000             subfacet->dp_packet_count = stats->n_packets;
3001             subfacet->dp_byte_count = stats->n_bytes;
3002
3003             facet->tcp_flags |= stats->tcp_flags;
3004
3005             subfacet_update_time(subfacet, stats->used);
3006             facet_account(facet, true);
3007             facet_push_stats(facet);
3008         } else {
3009             if (!VLOG_DROP_WARN(&rl)) {
3010                 struct ds s;
3011
3012                 ds_init(&s);
3013                 odp_flow_key_format(key, key_len, &s);
3014                 VLOG_WARN("unexpected flow from datapath %s", ds_cstr(&s));
3015                 ds_destroy(&s);
3016             }
3017
3018             COVERAGE_INC(facet_unexpected);
3019             /* There's a flow in the datapath that we know nothing about, or a
3020              * flow that shouldn't be installed but was anyway.  Delete it. */
3021             dpif_flow_del(p->dpif, key, key_len, NULL);
3022         }
3023     }
3024     dpif_flow_dump_done(&dump);
3025 }
3026
3027 /* Calculates and returns the number of milliseconds of idle time after which
3028  * subfacets should expire from the datapath.  When a subfacet expires, we fold
3029  * its statistics into its facet, and when a facet's last subfacet expires, we
3030  * fold its statistic into its rule. */
3031 static int
3032 subfacet_max_idle(const struct ofproto_dpif *ofproto)
3033 {
3034     /*
3035      * Idle time histogram.
3036      *
3037      * Most of the time a switch has a relatively small number of subfacets.
3038      * When this is the case we might as well keep statistics for all of them
3039      * in userspace and to cache them in the kernel datapath for performance as
3040      * well.
3041      *
3042      * As the number of subfacets increases, the memory required to maintain
3043      * statistics about them in userspace and in the kernel becomes
3044      * significant.  However, with a large number of subfacets it is likely
3045      * that only a few of them are "heavy hitters" that consume a large amount
3046      * of bandwidth.  At this point, only heavy hitters are worth caching in
3047      * the kernel and maintaining in userspaces; other subfacets we can
3048      * discard.
3049      *
3050      * The technique used to compute the idle time is to build a histogram with
3051      * N_BUCKETS buckets whose width is BUCKET_WIDTH msecs each.  Each subfacet
3052      * that is installed in the kernel gets dropped in the appropriate bucket.
3053      * After the histogram has been built, we compute the cutoff so that only
3054      * the most-recently-used 1% of subfacets (but at least
3055      * ofproto->up.flow_eviction_threshold flows) are kept cached.  At least
3056      * the most-recently-used bucket of subfacets is kept, so actually an
3057      * arbitrary number of subfacets can be kept in any given expiration run
3058      * (though the next run will delete most of those unless they receive
3059      * additional data).
3060      *
3061      * This requires a second pass through the subfacets, in addition to the
3062      * pass made by update_stats(), because the former function never looks at
3063      * uninstallable subfacets.
3064      */
3065     enum { BUCKET_WIDTH = ROUND_UP(100, TIME_UPDATE_INTERVAL) };
3066     enum { N_BUCKETS = 5000 / BUCKET_WIDTH };
3067     int buckets[N_BUCKETS] = { 0 };
3068     int total, subtotal, bucket;
3069     struct subfacet *subfacet;
3070     long long int now;
3071     int i;
3072
3073     total = hmap_count(&ofproto->subfacets);
3074     if (total <= ofproto->up.flow_eviction_threshold) {
3075         return N_BUCKETS * BUCKET_WIDTH;
3076     }
3077
3078     /* Build histogram. */
3079     now = time_msec();
3080     HMAP_FOR_EACH (subfacet, hmap_node, &ofproto->subfacets) {
3081         long long int idle = now - subfacet->used;
3082         int bucket = (idle <= 0 ? 0
3083                       : idle >= BUCKET_WIDTH * N_BUCKETS ? N_BUCKETS - 1
3084                       : (unsigned int) idle / BUCKET_WIDTH);
3085         buckets[bucket]++;
3086     }
3087
3088     /* Find the first bucket whose flows should be expired. */
3089     subtotal = bucket = 0;
3090     do {
3091         subtotal += buckets[bucket++];
3092     } while (bucket < N_BUCKETS &&
3093              subtotal < MAX(ofproto->up.flow_eviction_threshold, total / 100));
3094
3095     if (VLOG_IS_DBG_ENABLED()) {
3096         struct ds s;
3097
3098         ds_init(&s);
3099         ds_put_cstr(&s, "keep");
3100         for (i = 0; i < N_BUCKETS; i++) {
3101             if (i == bucket) {
3102                 ds_put_cstr(&s, ", drop");
3103             }
3104             if (buckets[i]) {
3105                 ds_put_format(&s, " %d:%d", i * BUCKET_WIDTH, buckets[i]);
3106             }
3107         }
3108         VLOG_INFO("%s: %s (msec:count)", ofproto->up.name, ds_cstr(&s));
3109         ds_destroy(&s);
3110     }
3111
3112     return bucket * BUCKET_WIDTH;
3113 }
3114
3115 static void
3116 expire_subfacets(struct ofproto_dpif *ofproto, int dp_max_idle)
3117 {
3118     long long int cutoff = time_msec() - dp_max_idle;
3119     struct subfacet *subfacet, *next_subfacet;
3120
3121     HMAP_FOR_EACH_SAFE (subfacet, next_subfacet, hmap_node,
3122                         &ofproto->subfacets) {
3123         if (subfacet->used < cutoff) {
3124             subfacet_destroy(subfacet);
3125         }
3126     }
3127 }
3128
3129 /* If 'rule' is an OpenFlow rule, that has expired according to OpenFlow rules,
3130  * then delete it entirely. */
3131 static void
3132 rule_expire(struct rule_dpif *rule)
3133 {
3134     struct facet *facet, *next_facet;
3135     long long int now;
3136     uint8_t reason;
3137
3138     /* Has 'rule' expired? */
3139     now = time_msec();
3140     if (rule->up.hard_timeout
3141         && now > rule->up.modified + rule->up.hard_timeout * 1000) {
3142         reason = OFPRR_HARD_TIMEOUT;
3143     } else if (rule->up.idle_timeout
3144                && now > rule->up.used + rule->up.idle_timeout * 1000) {
3145         reason = OFPRR_IDLE_TIMEOUT;
3146     } else {
3147         return;
3148     }
3149
3150     COVERAGE_INC(ofproto_dpif_expired);
3151
3152     /* Update stats.  (This is a no-op if the rule expired due to an idle
3153      * timeout, because that only happens when the rule has no facets left.) */
3154     LIST_FOR_EACH_SAFE (facet, next_facet, list_node, &rule->facets) {
3155         facet_remove(facet);
3156     }
3157
3158     /* Get rid of the rule. */
3159     ofproto_rule_expire(&rule->up, reason);
3160 }
3161 \f
3162 /* Facets. */
3163
3164 /* Creates and returns a new facet owned by 'rule', given a 'flow'.
3165  *
3166  * The caller must already have determined that no facet with an identical
3167  * 'flow' exists in 'ofproto' and that 'flow' is the best match for 'rule' in
3168  * the ofproto's classifier table.
3169  *
3170  * The facet will initially have no subfacets.  The caller should create (at
3171  * least) one subfacet with subfacet_create(). */
3172 static struct facet *
3173 facet_create(struct rule_dpif *rule, const struct flow *flow)
3174 {
3175     struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
3176     struct facet *facet;
3177
3178     facet = xzalloc(sizeof *facet);
3179     facet->used = time_msec();
3180     hmap_insert(&ofproto->facets, &facet->hmap_node, flow_hash(flow, 0));
3181     list_push_back(&rule->facets, &facet->list_node);
3182     facet->rule = rule;
3183     facet->flow = *flow;
3184     list_init(&facet->subfacets);
3185     netflow_flow_init(&facet->nf_flow);
3186     netflow_flow_update_time(ofproto->netflow, &facet->nf_flow, facet->used);
3187
3188     return facet;
3189 }
3190
3191 static void
3192 facet_free(struct facet *facet)
3193 {
3194     free(facet);
3195 }
3196
3197 /* Executes, within 'ofproto', the 'n_actions' actions in 'actions' on
3198  * 'packet', which arrived on 'in_port'.
3199  *
3200  * Takes ownership of 'packet'. */
3201 static bool
3202 execute_odp_actions(struct ofproto_dpif *ofproto, const struct flow *flow,
3203                     const struct nlattr *odp_actions, size_t actions_len,
3204                     struct ofpbuf *packet)
3205 {
3206     struct odputil_keybuf keybuf;
3207     struct ofpbuf key;
3208     int error;
3209
3210     ofpbuf_use_stack(&key, &keybuf, sizeof keybuf);
3211     odp_flow_key_from_flow(&key, flow);
3212
3213     error = dpif_execute(ofproto->dpif, key.data, key.size,
3214                          odp_actions, actions_len, packet);
3215
3216     ofpbuf_delete(packet);
3217     return !error;
3218 }
3219
3220 /* Remove 'facet' from 'ofproto' and free up the associated memory:
3221  *
3222  *   - If 'facet' was installed in the datapath, uninstalls it and updates its
3223  *     rule's statistics, via subfacet_uninstall().
3224  *
3225  *   - Removes 'facet' from its rule and from ofproto->facets.
3226  */
3227 static void
3228 facet_remove(struct facet *facet)
3229 {
3230     struct ofproto_dpif *ofproto = ofproto_dpif_cast(facet->rule->up.ofproto);
3231     struct subfacet *subfacet, *next_subfacet;
3232
3233     assert(!list_is_empty(&facet->subfacets));
3234
3235     /* First uninstall all of the subfacets to get final statistics. */
3236     LIST_FOR_EACH (subfacet, list_node, &facet->subfacets) {
3237         subfacet_uninstall(subfacet);
3238     }
3239
3240     /* Flush the final stats to the rule.
3241      *
3242      * This might require us to have at least one subfacet around so that we
3243      * can use its actions for accounting in facet_account(), which is why we
3244      * have uninstalled but not yet destroyed the subfacets. */
3245     facet_flush_stats(facet);
3246
3247     /* Now we're really all done so destroy everything. */
3248     LIST_FOR_EACH_SAFE (subfacet, next_subfacet, list_node,
3249                         &facet->subfacets) {
3250         subfacet_destroy__(subfacet);
3251     }
3252     hmap_remove(&ofproto->facets, &facet->hmap_node);
3253     list_remove(&facet->list_node);
3254     facet_free(facet);
3255 }
3256
3257 static void
3258 facet_account(struct facet *facet, bool may_flow_mod)
3259 {
3260     struct ofproto_dpif *ofproto = ofproto_dpif_cast(facet->rule->up.ofproto);
3261     uint64_t n_bytes;
3262     struct subfacet *subfacet;
3263     const struct nlattr *a;
3264     unsigned int left;
3265     ovs_be16 vlan_tci;
3266
3267     if (facet->byte_count <= facet->accounted_bytes) {
3268         return;
3269     }
3270     n_bytes = facet->byte_count - facet->accounted_bytes;
3271     facet->accounted_bytes = facet->byte_count;
3272
3273     /* Feed information from the active flows back into the learning table to
3274      * ensure that table is always in sync with what is actually flowing
3275      * through the datapath. */
3276     if (facet->has_learn || facet->has_normal
3277         || (facet->has_fin_timeout
3278             && facet->tcp_flags & (TCP_FIN | TCP_RST))) {
3279         struct action_xlate_ctx ctx;
3280
3281         action_xlate_ctx_init(&ctx, ofproto, &facet->flow,
3282                               facet->flow.vlan_tci,
3283                               facet->rule, facet->tcp_flags, NULL);
3284         ctx.may_learn_macs = true;
3285         ctx.may_flow_mod = may_flow_mod;
3286         ofpbuf_delete(xlate_actions(&ctx, facet->rule->up.actions,
3287                                     facet->rule->up.n_actions));
3288     }
3289
3290     if (!facet->has_normal || !ofproto->has_bonded_bundles) {
3291         return;
3292     }
3293
3294     /* This loop feeds byte counters to bond_account() for rebalancing to use
3295      * as a basis.  We also need to track the actual VLAN on which the packet
3296      * is going to be sent to ensure that it matches the one passed to
3297      * bond_choose_output_slave().  (Otherwise, we will account to the wrong
3298      * hash bucket.)
3299      *
3300      * We use the actions from an arbitrary subfacet because they should all
3301      * be equally valid for our purpose. */
3302     subfacet = CONTAINER_OF(list_front(&facet->subfacets),
3303                             struct subfacet, list_node);
3304     vlan_tci = facet->flow.vlan_tci;
3305     NL_ATTR_FOR_EACH_UNSAFE (a, left,
3306                              subfacet->actions, subfacet->actions_len) {
3307         const struct ovs_action_push_vlan *vlan;
3308         struct ofport_dpif *port;
3309
3310         switch (nl_attr_type(a)) {
3311         case OVS_ACTION_ATTR_OUTPUT:
3312             port = get_odp_port(ofproto, nl_attr_get_u32(a));
3313             if (port && port->bundle && port->bundle->bond) {
3314                 bond_account(port->bundle->bond, &facet->flow,
3315                              vlan_tci_to_vid(vlan_tci), n_bytes);
3316             }
3317             break;
3318
3319         case OVS_ACTION_ATTR_POP_VLAN:
3320             vlan_tci = htons(0);
3321             break;
3322
3323         case OVS_ACTION_ATTR_PUSH_VLAN:
3324             vlan = nl_attr_get(a);
3325             vlan_tci = vlan->vlan_tci;
3326             break;
3327         }
3328     }
3329 }
3330
3331 /* Returns true if the only action for 'facet' is to send to the controller.
3332  * (We don't report NetFlow expiration messages for such facets because they
3333  * are just part of the control logic for the network, not real traffic). */
3334 static bool
3335 facet_is_controller_flow(struct facet *facet)
3336 {
3337     return (facet
3338             && facet->rule->up.n_actions == 1
3339             && action_outputs_to_port(&facet->rule->up.actions[0],
3340                                       htons(OFPP_CONTROLLER)));
3341 }
3342
3343 /* Folds all of 'facet''s statistics into its rule.  Also updates the
3344  * accounting ofhook and emits a NetFlow expiration if appropriate.  All of
3345  * 'facet''s statistics in the datapath should have been zeroed and folded into
3346  * its packet and byte counts before this function is called. */
3347 static void
3348 facet_flush_stats(struct facet *facet)
3349 {
3350     struct ofproto_dpif *ofproto = ofproto_dpif_cast(facet->rule->up.ofproto);
3351     struct subfacet *subfacet;
3352
3353     LIST_FOR_EACH (subfacet, list_node, &facet->subfacets) {
3354         assert(!subfacet->dp_byte_count);
3355         assert(!subfacet->dp_packet_count);
3356     }
3357
3358     facet_push_stats(facet);
3359     facet_account(facet, false);
3360
3361     if (ofproto->netflow && !facet_is_controller_flow(facet)) {
3362         struct ofexpired expired;
3363         expired.flow = facet->flow;
3364         expired.packet_count = facet->packet_count;
3365         expired.byte_count = facet->byte_count;
3366         expired.used = facet->used;
3367         netflow_expire(ofproto->netflow, &facet->nf_flow, &expired);
3368     }
3369
3370     facet->rule->packet_count += facet->packet_count;
3371     facet->rule->byte_count += facet->byte_count;
3372
3373     /* Reset counters to prevent double counting if 'facet' ever gets
3374      * reinstalled. */
3375     facet_reset_counters(facet);
3376
3377     netflow_flow_clear(&facet->nf_flow);
3378     facet->tcp_flags = 0;
3379 }
3380
3381 /* Searches 'ofproto''s table of facets for one exactly equal to 'flow'.
3382  * Returns it if found, otherwise a null pointer.
3383  *
3384  * The returned facet might need revalidation; use facet_lookup_valid()
3385  * instead if that is important. */
3386 static struct facet *
3387 facet_find(struct ofproto_dpif *ofproto, const struct flow *flow)
3388 {
3389     struct facet *facet;
3390
3391     HMAP_FOR_EACH_WITH_HASH (facet, hmap_node, flow_hash(flow, 0),
3392                              &ofproto->facets) {
3393         if (flow_equal(flow, &facet->flow)) {
3394             return facet;
3395         }
3396     }
3397
3398     return NULL;
3399 }
3400
3401 /* Searches 'ofproto''s table of facets for one exactly equal to 'flow'.
3402  * Returns it if found, otherwise a null pointer.
3403  *
3404  * The returned facet is guaranteed to be valid. */
3405 static struct facet *
3406 facet_lookup_valid(struct ofproto_dpif *ofproto, const struct flow *flow)
3407 {
3408     struct facet *facet = facet_find(ofproto, flow);
3409
3410     /* The facet we found might not be valid, since we could be in need of
3411      * revalidation.  If it is not valid, don't return it. */
3412     if (facet
3413         && (ofproto->need_revalidate
3414             || tag_set_intersects(&ofproto->revalidate_set, facet->tags))
3415         && !facet_revalidate(facet)) {
3416         COVERAGE_INC(facet_invalidated);
3417         return NULL;
3418     }
3419
3420     return facet;
3421 }
3422
3423 static bool
3424 facet_check_consistency(struct facet *facet)
3425 {
3426     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 15);
3427
3428     struct ofproto_dpif *ofproto = ofproto_dpif_cast(facet->rule->up.ofproto);
3429
3430     struct rule_dpif *rule;
3431     struct subfacet *subfacet;
3432     bool may_log = false;
3433     bool ok;
3434
3435     /* Check the rule for consistency. */
3436     rule = rule_dpif_lookup(ofproto, &facet->flow, 0);
3437     if (!rule) {
3438         if (!VLOG_DROP_WARN(&rl)) {
3439             char *s = flow_to_string(&facet->flow);
3440             VLOG_WARN("%s: facet should not exist", s);
3441             free(s);
3442         }
3443         return false;
3444     } else if (rule != facet->rule) {
3445         may_log = !VLOG_DROP_WARN(&rl);
3446         ok = false;
3447         if (may_log) {
3448             struct ds s;
3449
3450             ds_init(&s);
3451             flow_format(&s, &facet->flow);
3452             ds_put_format(&s, ": facet associated with wrong rule (was "
3453                           "table=%"PRIu8",", facet->rule->up.table_id);
3454             cls_rule_format(&facet->rule->up.cr, &s);
3455             ds_put_format(&s, ") (should have been table=%"PRIu8",",
3456                           rule->up.table_id);
3457             cls_rule_format(&rule->up.cr, &s);
3458             ds_put_char(&s, ')');
3459
3460             VLOG_WARN("%s", ds_cstr(&s));
3461             ds_destroy(&s);
3462         }
3463     } else {
3464         ok = true;
3465     }
3466
3467     /* Check the datapath actions for consistency. */
3468     LIST_FOR_EACH (subfacet, list_node, &facet->subfacets) {
3469         struct action_xlate_ctx ctx;
3470         struct ofpbuf *odp_actions;
3471         bool actions_changed;
3472         bool should_install;
3473
3474         action_xlate_ctx_init(&ctx, ofproto, &facet->flow,
3475                               subfacet->initial_tci, rule, 0, NULL);
3476         odp_actions = xlate_actions(&ctx, rule->up.actions,
3477                                     rule->up.n_actions);
3478
3479         should_install = (ctx.may_set_up_flow
3480                           && subfacet->key_fitness != ODP_FIT_TOO_LITTLE);
3481         if (!should_install && !subfacet->installed) {
3482             /* The actions for uninstallable flows may vary from one packet to
3483              * the next, so don't compare the actions. */
3484             goto next;
3485         }
3486
3487         actions_changed = (subfacet->actions_len != odp_actions->size
3488                            || memcmp(subfacet->actions, odp_actions->data,
3489                                      subfacet->actions_len));
3490         if (should_install != subfacet->installed || actions_changed) {
3491             if (ok) {
3492                 may_log = !VLOG_DROP_WARN(&rl);
3493                 ok = false;
3494             }
3495
3496             if (may_log) {
3497                 struct odputil_keybuf keybuf;
3498                 struct ofpbuf key;
3499                 struct ds s;
3500
3501                 ds_init(&s);
3502                 subfacet_get_key(subfacet, &keybuf, &key);
3503                 odp_flow_key_format(key.data, key.size, &s);
3504
3505                 ds_put_cstr(&s, ": inconsistency in subfacet");
3506                 if (should_install != subfacet->installed) {
3507                     enum odp_key_fitness fitness = subfacet->key_fitness;
3508
3509                     ds_put_format(&s, " (should%s have been installed)",
3510                                   should_install ? "" : " not");
3511                     ds_put_format(&s, " (may_set_up_flow=%s, fitness=%s)",
3512                                   ctx.may_set_up_flow ? "true" : "false",
3513                                   odp_key_fitness_to_string(fitness));
3514                 }
3515                 if (actions_changed) {
3516                     ds_put_cstr(&s, " (actions were: ");
3517                     format_odp_actions(&s, subfacet->actions,
3518                                        subfacet->actions_len);
3519                     ds_put_cstr(&s, ") (correct actions: ");
3520                     format_odp_actions(&s, odp_actions->data,
3521                                        odp_actions->size);
3522                     ds_put_char(&s, ')');
3523                 } else {
3524                     ds_put_cstr(&s, " (actions: ");
3525                     format_odp_actions(&s, subfacet->actions,
3526                                        subfacet->actions_len);
3527                     ds_put_char(&s, ')');
3528                 }
3529                 VLOG_WARN("%s", ds_cstr(&s));
3530                 ds_destroy(&s);
3531             }
3532         }
3533
3534     next:
3535         ofpbuf_delete(odp_actions);
3536     }
3537
3538     return ok;
3539 }
3540
3541 /* Re-searches the classifier for 'facet':
3542  *
3543  *   - If the rule found is different from 'facet''s current rule, moves
3544  *     'facet' to the new rule and recompiles its actions.
3545  *
3546  *   - If the rule found is the same as 'facet''s current rule, leaves 'facet'
3547  *     where it is and recompiles its actions anyway.
3548  *
3549  *   - If there is none, destroys 'facet'.
3550  *
3551  * Returns true if 'facet' still exists, false if it has been destroyed. */
3552 static bool
3553 facet_revalidate(struct facet *facet)
3554 {
3555     struct ofproto_dpif *ofproto = ofproto_dpif_cast(facet->rule->up.ofproto);
3556     struct actions {
3557         struct nlattr *odp_actions;
3558         size_t actions_len;
3559     };
3560     struct actions *new_actions;
3561
3562     struct action_xlate_ctx ctx;
3563     struct rule_dpif *new_rule;
3564     struct subfacet *subfacet;
3565     bool actions_changed;
3566     int i;
3567
3568     COVERAGE_INC(facet_revalidate);
3569
3570     /* Determine the new rule. */
3571     new_rule = rule_dpif_lookup(ofproto, &facet->flow, 0);
3572     if (!new_rule) {
3573         /* No new rule, so delete the facet. */
3574         facet_remove(facet);
3575         return false;
3576     }
3577
3578     /* Calculate new datapath actions.
3579      *
3580      * We do not modify any 'facet' state yet, because we might need to, e.g.,
3581      * emit a NetFlow expiration and, if so, we need to have the old state
3582      * around to properly compose it. */
3583
3584     /* If the datapath actions changed or the installability changed,
3585      * then we need to talk to the datapath. */
3586     i = 0;
3587     new_actions = NULL;
3588     memset(&ctx, 0, sizeof ctx);
3589     LIST_FOR_EACH (subfacet, list_node, &facet->subfacets) {
3590         struct ofpbuf *odp_actions;
3591         bool should_install;
3592
3593         action_xlate_ctx_init(&ctx, ofproto, &facet->flow,
3594                               subfacet->initial_tci, new_rule, 0, NULL);
3595         odp_actions = xlate_actions(&ctx, new_rule->up.actions,
3596                                     new_rule->up.n_actions);
3597         actions_changed = (subfacet->actions_len != odp_actions->size
3598                            || memcmp(subfacet->actions, odp_actions->data,
3599                                      subfacet->actions_len));
3600
3601         should_install = (ctx.may_set_up_flow
3602                           && subfacet->key_fitness != ODP_FIT_TOO_LITTLE);
3603         if (actions_changed || should_install != subfacet->installed) {
3604             if (should_install) {
3605                 struct dpif_flow_stats stats;
3606
3607                 subfacet_install(subfacet,
3608                                  odp_actions->data, odp_actions->size, &stats);
3609                 subfacet_update_stats(subfacet, &stats);
3610             } else {
3611                 subfacet_uninstall(subfacet);
3612             }
3613
3614             if (!new_actions) {
3615                 new_actions = xcalloc(list_size(&facet->subfacets),
3616                                       sizeof *new_actions);
3617             }
3618             new_actions[i].odp_actions = xmemdup(odp_actions->data,
3619                                                  odp_actions->size);
3620             new_actions[i].actions_len = odp_actions->size;
3621         }
3622
3623         ofpbuf_delete(odp_actions);
3624         i++;
3625     }
3626     if (new_actions) {
3627         facet_flush_stats(facet);
3628     }
3629
3630     /* Update 'facet' now that we've taken care of all the old state. */
3631     facet->tags = ctx.tags;
3632     facet->nf_flow.output_iface = ctx.nf_output_iface;
3633     facet->may_install = ctx.may_set_up_flow;
3634     facet->has_learn = ctx.has_learn;
3635     facet->has_normal = ctx.has_normal;
3636     facet->has_fin_timeout = ctx.has_fin_timeout;
3637     facet->mirrors = ctx.mirrors;
3638     if (new_actions) {
3639         i = 0;
3640         LIST_FOR_EACH (subfacet, list_node, &facet->subfacets) {
3641             if (new_actions[i].odp_actions) {
3642                 free(subfacet->actions);
3643                 subfacet->actions = new_actions[i].odp_actions;
3644                 subfacet->actions_len = new_actions[i].actions_len;
3645             }
3646             i++;
3647         }
3648         free(new_actions);
3649     }
3650     if (facet->rule != new_rule) {
3651         COVERAGE_INC(facet_changed_rule);
3652         list_remove(&facet->list_node);
3653         list_push_back(&new_rule->facets, &facet->list_node);
3654         facet->rule = new_rule;
3655         facet->used = new_rule->up.created;
3656         facet->prev_used = facet->used;
3657     }
3658
3659     return true;
3660 }
3661
3662 /* Updates 'facet''s used time.  Caller is responsible for calling
3663  * facet_push_stats() to update the flows which 'facet' resubmits into. */
3664 static void
3665 facet_update_time(struct facet *facet, long long int used)
3666 {
3667     struct ofproto_dpif *ofproto = ofproto_dpif_cast(facet->rule->up.ofproto);
3668     if (used > facet->used) {
3669         facet->used = used;
3670         ofproto_rule_update_used(&facet->rule->up, used);
3671         netflow_flow_update_time(ofproto->netflow, &facet->nf_flow, used);
3672     }
3673 }
3674
3675 static void
3676 facet_reset_counters(struct facet *facet)
3677 {
3678     facet->packet_count = 0;
3679     facet->byte_count = 0;
3680     facet->prev_packet_count = 0;
3681     facet->prev_byte_count = 0;
3682     facet->accounted_bytes = 0;
3683 }
3684
3685 static void
3686 facet_push_stats(struct facet *facet)
3687 {
3688     uint64_t new_packets, new_bytes;
3689
3690     assert(facet->packet_count >= facet->prev_packet_count);
3691     assert(facet->byte_count >= facet->prev_byte_count);
3692     assert(facet->used >= facet->prev_used);
3693
3694     new_packets = facet->packet_count - facet->prev_packet_count;
3695     new_bytes = facet->byte_count - facet->prev_byte_count;
3696
3697     if (new_packets || new_bytes || facet->used > facet->prev_used) {
3698         facet->prev_packet_count = facet->packet_count;
3699         facet->prev_byte_count = facet->byte_count;
3700         facet->prev_used = facet->used;
3701
3702         flow_push_stats(facet->rule, &facet->flow,
3703                         new_packets, new_bytes, facet->used);
3704
3705         update_mirror_stats(ofproto_dpif_cast(facet->rule->up.ofproto),
3706                             facet->mirrors, new_packets, new_bytes);
3707     }
3708 }
3709
3710 struct ofproto_push {
3711     struct action_xlate_ctx ctx;
3712     uint64_t packets;
3713     uint64_t bytes;
3714     long long int used;
3715 };
3716
3717 static void
3718 push_resubmit(struct action_xlate_ctx *ctx, struct rule_dpif *rule)
3719 {
3720     struct ofproto_push *push = CONTAINER_OF(ctx, struct ofproto_push, ctx);
3721
3722     if (rule) {
3723         rule->packet_count += push->packets;
3724         rule->byte_count += push->bytes;
3725         ofproto_rule_update_used(&rule->up, push->used);
3726     }
3727 }
3728
3729 /* Pushes flow statistics to the rules which 'flow' resubmits into given
3730  * 'rule''s actions and mirrors. */
3731 static void
3732 flow_push_stats(struct rule_dpif *rule,
3733                 const struct flow *flow, uint64_t packets, uint64_t bytes,
3734                 long long int used)
3735 {
3736     struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
3737     struct ofproto_push push;
3738
3739     push.packets = packets;
3740     push.bytes = bytes;
3741     push.used = used;
3742
3743     ofproto_rule_update_used(&rule->up, used);
3744
3745     action_xlate_ctx_init(&push.ctx, ofproto, flow, flow->vlan_tci, rule,
3746                           0, NULL);
3747     push.ctx.resubmit_hook = push_resubmit;
3748     ofpbuf_delete(xlate_actions(&push.ctx,
3749                                 rule->up.actions, rule->up.n_actions));
3750 }
3751 \f
3752 /* Subfacets. */
3753
3754 static struct subfacet *
3755 subfacet_find__(struct ofproto_dpif *ofproto,
3756                 const struct nlattr *key, size_t key_len, uint32_t key_hash,
3757                 const struct flow *flow)
3758 {
3759     struct subfacet *subfacet;
3760
3761     HMAP_FOR_EACH_WITH_HASH (subfacet, hmap_node, key_hash,
3762                              &ofproto->subfacets) {
3763         if (subfacet->key
3764             ? (subfacet->key_len == key_len
3765                && !memcmp(key, subfacet->key, key_len))
3766             : flow_equal(flow, &subfacet->facet->flow)) {
3767             return subfacet;
3768         }
3769     }
3770
3771     return NULL;
3772 }
3773
3774 /* Searches 'facet' (within 'ofproto') for a subfacet with the specified
3775  * 'key_fitness', 'key', and 'key_len'.  Returns the existing subfacet if
3776  * there is one, otherwise creates and returns a new subfacet.
3777  *
3778  * If the returned subfacet is new, then subfacet->actions will be NULL, in
3779  * which case the caller must populate the actions with
3780  * subfacet_make_actions(). */
3781 static struct subfacet *
3782 subfacet_create(struct facet *facet, enum odp_key_fitness key_fitness,
3783                 const struct nlattr *key, size_t key_len, ovs_be16 initial_tci)
3784 {
3785     struct ofproto_dpif *ofproto = ofproto_dpif_cast(facet->rule->up.ofproto);
3786     uint32_t key_hash = odp_flow_key_hash(key, key_len);
3787     struct subfacet *subfacet;
3788
3789     subfacet = subfacet_find__(ofproto, key, key_len, key_hash, &facet->flow);
3790     if (subfacet) {
3791         if (subfacet->facet == facet) {
3792             return subfacet;
3793         }
3794
3795         /* This shouldn't happen. */
3796         VLOG_ERR_RL(&rl, "subfacet with wrong facet");
3797         subfacet_destroy(subfacet);
3798     }
3799
3800     subfacet = xzalloc(sizeof *subfacet);
3801     hmap_insert(&ofproto->subfacets, &subfacet->hmap_node, key_hash);
3802     list_push_back(&facet->subfacets, &subfacet->list_node);
3803     subfacet->facet = facet;
3804     subfacet->used = time_msec();
3805     subfacet->key_fitness = key_fitness;
3806     if (key_fitness != ODP_FIT_PERFECT) {
3807         subfacet->key = xmemdup(key, key_len);
3808         subfacet->key_len = key_len;
3809     }
3810     subfacet->installed = false;
3811     subfacet->initial_tci = initial_tci;
3812
3813     return subfacet;
3814 }
3815
3816 /* Searches 'ofproto' for a subfacet with the given 'key', 'key_len', and
3817  * 'flow'.  Returns the subfacet if one exists, otherwise NULL. */
3818 static struct subfacet *
3819 subfacet_find(struct ofproto_dpif *ofproto,
3820               const struct nlattr *key, size_t key_len)
3821 {
3822     uint32_t key_hash = odp_flow_key_hash(key, key_len);
3823     enum odp_key_fitness fitness;
3824     struct flow flow;
3825
3826     fitness = odp_flow_key_to_flow(key, key_len, &flow);
3827     if (fitness == ODP_FIT_ERROR) {
3828         return NULL;
3829     }
3830
3831     return subfacet_find__(ofproto, key, key_len, key_hash, &flow);
3832 }
3833
3834 /* Uninstalls 'subfacet' from the datapath, if it is installed, removes it from
3835  * its facet within 'ofproto', and frees it. */
3836 static void
3837 subfacet_destroy__(struct subfacet *subfacet)
3838 {
3839     struct facet *facet = subfacet->facet;
3840     struct ofproto_dpif *ofproto = ofproto_dpif_cast(facet->rule->up.ofproto);
3841
3842     subfacet_uninstall(subfacet);
3843     hmap_remove(&ofproto->subfacets, &subfacet->hmap_node);
3844     list_remove(&subfacet->list_node);
3845     free(subfacet->key);
3846     free(subfacet->actions);
3847     free(subfacet);
3848 }
3849
3850 /* Destroys 'subfacet', as with subfacet_destroy__(), and then if this was the
3851  * last remaining subfacet in its facet destroys the facet too. */
3852 static void
3853 subfacet_destroy(struct subfacet *subfacet)
3854 {
3855     struct facet *facet = subfacet->facet;
3856
3857     if (list_is_singleton(&facet->subfacets)) {
3858         /* facet_remove() needs at least one subfacet (it will remove it). */
3859         facet_remove(facet);
3860     } else {
3861         subfacet_destroy__(subfacet);
3862     }
3863 }
3864
3865 /* Initializes 'key' with the sequence of OVS_KEY_ATTR_* Netlink attributes
3866  * that can be used to refer to 'subfacet'.  The caller must provide 'keybuf'
3867  * for use as temporary storage. */
3868 static void
3869 subfacet_get_key(struct subfacet *subfacet, struct odputil_keybuf *keybuf,
3870                  struct ofpbuf *key)
3871 {
3872     if (!subfacet->key) {
3873         ofpbuf_use_stack(key, keybuf, sizeof *keybuf);
3874         odp_flow_key_from_flow(key, &subfacet->facet->flow);
3875     } else {
3876         ofpbuf_use_const(key, subfacet->key, subfacet->key_len);
3877     }
3878 }
3879
3880 /* Composes the datapath actions for 'subfacet' based on its rule's actions. */
3881 static void
3882 subfacet_make_actions(struct subfacet *subfacet, const struct ofpbuf *packet)
3883 {
3884     struct facet *facet = subfacet->facet;
3885     struct rule_dpif *rule = facet->rule;
3886     struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
3887     struct ofpbuf *odp_actions;
3888     struct action_xlate_ctx ctx;
3889
3890     action_xlate_ctx_init(&ctx, ofproto, &facet->flow, subfacet->initial_tci,
3891                           rule, 0, packet);
3892     odp_actions = xlate_actions(&ctx, rule->up.actions, rule->up.n_actions);
3893     facet->tags = ctx.tags;
3894     facet->may_install = ctx.may_set_up_flow;
3895     facet->has_learn = ctx.has_learn;
3896     facet->has_normal = ctx.has_normal;
3897     facet->has_fin_timeout = ctx.has_fin_timeout;
3898     facet->nf_flow.output_iface = ctx.nf_output_iface;
3899     facet->mirrors = ctx.mirrors;
3900
3901     if (subfacet->actions_len != odp_actions->size
3902         || memcmp(subfacet->actions, odp_actions->data, odp_actions->size)) {
3903         free(subfacet->actions);
3904         subfacet->actions_len = odp_actions->size;
3905         subfacet->actions = xmemdup(odp_actions->data, odp_actions->size);
3906     }
3907
3908     ofpbuf_delete(odp_actions);
3909 }
3910
3911 /* Updates 'subfacet''s datapath flow, setting its actions to 'actions_len'
3912  * bytes of actions in 'actions'.  If 'stats' is non-null, statistics counters
3913  * in the datapath will be zeroed and 'stats' will be updated with traffic new
3914  * since 'subfacet' was last updated.
3915  *
3916  * Returns 0 if successful, otherwise a positive errno value. */
3917 static int
3918 subfacet_install(struct subfacet *subfacet,
3919                  const struct nlattr *actions, size_t actions_len,
3920                  struct dpif_flow_stats *stats)
3921 {
3922     struct facet *facet = subfacet->facet;
3923     struct ofproto_dpif *ofproto = ofproto_dpif_cast(facet->rule->up.ofproto);
3924     struct odputil_keybuf keybuf;
3925     enum dpif_flow_put_flags flags;
3926     struct ofpbuf key;
3927     int ret;
3928
3929     flags = DPIF_FP_CREATE | DPIF_FP_MODIFY;
3930     if (stats) {
3931         flags |= DPIF_FP_ZERO_STATS;
3932     }
3933
3934     subfacet_get_key(subfacet, &keybuf, &key);
3935     ret = dpif_flow_put(ofproto->dpif, flags, key.data, key.size,
3936                         actions, actions_len, stats);
3937
3938     if (stats) {
3939         subfacet_reset_dp_stats(subfacet, stats);
3940     }
3941
3942     return ret;
3943 }
3944
3945 /* If 'subfacet' is installed in the datapath, uninstalls it. */
3946 static void
3947 subfacet_uninstall(struct subfacet *subfacet)
3948 {
3949     if (subfacet->installed) {
3950         struct rule_dpif *rule = subfacet->facet->rule;
3951         struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
3952         struct odputil_keybuf keybuf;
3953         struct dpif_flow_stats stats;
3954         struct ofpbuf key;
3955         int error;
3956
3957         subfacet_get_key(subfacet, &keybuf, &key);
3958         error = dpif_flow_del(ofproto->dpif, key.data, key.size, &stats);
3959         subfacet_reset_dp_stats(subfacet, &stats);
3960         if (!error) {
3961             subfacet_update_stats(subfacet, &stats);
3962         }
3963         subfacet->installed = false;
3964     } else {
3965         assert(subfacet->dp_packet_count == 0);
3966         assert(subfacet->dp_byte_count == 0);
3967     }
3968 }
3969
3970 /* Resets 'subfacet''s datapath statistics counters.  This should be called
3971  * when 'subfacet''s statistics are cleared in the datapath.  If 'stats' is
3972  * non-null, it should contain the statistics returned by dpif when 'subfacet'
3973  * was reset in the datapath.  'stats' will be modified to include only
3974  * statistics new since 'subfacet' was last updated. */
3975 static void
3976 subfacet_reset_dp_stats(struct subfacet *subfacet,
3977                         struct dpif_flow_stats *stats)
3978 {
3979     if (stats
3980         && subfacet->dp_packet_count <= stats->n_packets
3981         && subfacet->dp_byte_count <= stats->n_bytes) {
3982         stats->n_packets -= subfacet->dp_packet_count;
3983         stats->n_bytes -= subfacet->dp_byte_count;
3984     }
3985
3986     subfacet->dp_packet_count = 0;
3987     subfacet->dp_byte_count = 0;
3988 }
3989
3990 /* Updates 'subfacet''s used time.  The caller is responsible for calling
3991  * facet_push_stats() to update the flows which 'subfacet' resubmits into. */
3992 static void
3993 subfacet_update_time(struct subfacet *subfacet, long long int used)
3994 {
3995     if (used > subfacet->used) {
3996         subfacet->used = used;
3997         facet_update_time(subfacet->facet, used);
3998     }
3999 }
4000
4001 /* Folds the statistics from 'stats' into the counters in 'subfacet'.
4002  *
4003  * Because of the meaning of a subfacet's counters, it only makes sense to do
4004  * this if 'stats' are not tracked in the datapath, that is, if 'stats'
4005  * represents a packet that was sent by hand or if it represents statistics
4006  * that have been cleared out of the datapath. */
4007 static void
4008 subfacet_update_stats(struct subfacet *subfacet,
4009                       const struct dpif_flow_stats *stats)
4010 {
4011     if (stats->n_packets || stats->used > subfacet->used) {
4012         struct facet *facet = subfacet->facet;
4013
4014         subfacet_update_time(subfacet, stats->used);
4015         facet->packet_count += stats->n_packets;
4016         facet->byte_count += stats->n_bytes;
4017         facet->tcp_flags |= stats->tcp_flags;
4018         facet_push_stats(facet);
4019         netflow_flow_update_flags(&facet->nf_flow, stats->tcp_flags);
4020     }
4021 }
4022 \f
4023 /* Rules. */
4024
4025 static struct rule_dpif *
4026 rule_dpif_lookup(struct ofproto_dpif *ofproto, const struct flow *flow,
4027                  uint8_t table_id)
4028 {
4029     struct cls_rule *cls_rule;
4030     struct classifier *cls;
4031
4032     if (table_id >= N_TABLES) {
4033         return NULL;
4034     }
4035
4036     cls = &ofproto->up.tables[table_id].cls;
4037     if (flow->nw_frag & FLOW_NW_FRAG_ANY
4038         && ofproto->up.frag_handling == OFPC_FRAG_NORMAL) {
4039         /* For OFPC_NORMAL frag_handling, we must pretend that transport ports
4040          * are unavailable. */
4041         struct flow ofpc_normal_flow = *flow;
4042         ofpc_normal_flow.tp_src = htons(0);
4043         ofpc_normal_flow.tp_dst = htons(0);
4044         cls_rule = classifier_lookup(cls, &ofpc_normal_flow);
4045     } else {
4046         cls_rule = classifier_lookup(cls, flow);
4047     }
4048     return rule_dpif_cast(rule_from_cls_rule(cls_rule));
4049 }
4050
4051 static void
4052 complete_operation(struct rule_dpif *rule)
4053 {
4054     struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
4055
4056     rule_invalidate(rule);
4057     if (clogged) {
4058         struct dpif_completion *c = xmalloc(sizeof *c);
4059         c->op = rule->up.pending;
4060         list_push_back(&ofproto->completions, &c->list_node);
4061     } else {
4062         ofoperation_complete(rule->up.pending, 0);
4063     }
4064 }
4065
4066 static struct rule *
4067 rule_alloc(void)
4068 {
4069     struct rule_dpif *rule = xmalloc(sizeof *rule);
4070     return &rule->up;
4071 }
4072
4073 static void
4074 rule_dealloc(struct rule *rule_)
4075 {
4076     struct rule_dpif *rule = rule_dpif_cast(rule_);
4077     free(rule);
4078 }
4079
4080 static enum ofperr
4081 rule_construct(struct rule *rule_)
4082 {
4083     struct rule_dpif *rule = rule_dpif_cast(rule_);
4084     struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
4085     struct rule_dpif *victim;
4086     uint8_t table_id;
4087     enum ofperr error;
4088
4089     error = validate_actions(rule->up.actions, rule->up.n_actions,
4090                              &rule->up.cr.flow, ofproto->max_ports);
4091     if (error) {
4092         return error;
4093     }
4094
4095     rule->packet_count = 0;
4096     rule->byte_count = 0;
4097
4098     victim = rule_dpif_cast(ofoperation_get_victim(rule->up.pending));
4099     if (victim && !list_is_empty(&victim->facets)) {
4100         struct facet *facet;
4101
4102         rule->facets = victim->facets;
4103         list_moved(&rule->facets);
4104         LIST_FOR_EACH (facet, list_node, &rule->facets) {
4105             /* XXX: We're only clearing our local counters here.  It's possible
4106              * that quite a few packets are unaccounted for in the datapath
4107              * statistics.  These will be accounted to the new rule instead of
4108              * cleared as required.  This could be fixed by clearing out the
4109              * datapath statistics for this facet, but currently it doesn't
4110              * seem worth it. */
4111             facet_reset_counters(facet);
4112             facet->rule = rule;
4113         }
4114     } else {
4115         /* Must avoid list_moved() in this case. */
4116         list_init(&rule->facets);
4117     }
4118
4119     table_id = rule->up.table_id;
4120     rule->tag = (victim ? victim->tag
4121                  : table_id == 0 ? 0
4122                  : rule_calculate_tag(&rule->up.cr.flow, &rule->up.cr.wc,
4123                                       ofproto->tables[table_id].basis));
4124
4125     complete_operation(rule);
4126     return 0;
4127 }
4128
4129 static void
4130 rule_destruct(struct rule *rule_)
4131 {
4132     struct rule_dpif *rule = rule_dpif_cast(rule_);
4133     struct facet *facet, *next_facet;
4134
4135     LIST_FOR_EACH_SAFE (facet, next_facet, list_node, &rule->facets) {
4136         facet_revalidate(facet);
4137     }
4138
4139     complete_operation(rule);
4140 }
4141
4142 static void
4143 rule_get_stats(struct rule *rule_, uint64_t *packets, uint64_t *bytes)
4144 {
4145     struct rule_dpif *rule = rule_dpif_cast(rule_);
4146     struct facet *facet;
4147
4148     /* Start from historical data for 'rule' itself that are no longer tracked
4149      * in facets.  This counts, for example, facets that have expired. */
4150     *packets = rule->packet_count;
4151     *bytes = rule->byte_count;
4152
4153     /* Add any statistics that are tracked by facets.  This includes
4154      * statistical data recently updated by ofproto_update_stats() as well as
4155      * stats for packets that were executed "by hand" via dpif_execute(). */
4156     LIST_FOR_EACH (facet, list_node, &rule->facets) {
4157         *packets += facet->packet_count;
4158         *bytes += facet->byte_count;
4159     }
4160 }
4161
4162 static enum ofperr
4163 rule_execute(struct rule *rule_, const struct flow *flow,
4164              struct ofpbuf *packet)
4165 {
4166     struct rule_dpif *rule = rule_dpif_cast(rule_);
4167     struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
4168     struct action_xlate_ctx ctx;
4169     struct ofpbuf *odp_actions;
4170     size_t size;
4171
4172     action_xlate_ctx_init(&ctx, ofproto, flow, flow->vlan_tci,
4173                           rule, packet_get_tcp_flags(packet, flow), packet);
4174     odp_actions = xlate_actions(&ctx, rule->up.actions, rule->up.n_actions);
4175     size = packet->size;
4176     if (execute_odp_actions(ofproto, flow, odp_actions->data,
4177                             odp_actions->size, packet)) {
4178         rule->packet_count++;
4179         rule->byte_count += size;
4180         flow_push_stats(rule, flow, 1, size, time_msec());
4181     }
4182     ofpbuf_delete(odp_actions);
4183
4184     return 0;
4185 }
4186
4187 static void
4188 rule_modify_actions(struct rule *rule_)
4189 {
4190     struct rule_dpif *rule = rule_dpif_cast(rule_);
4191     struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
4192     enum ofperr error;
4193
4194     error = validate_actions(rule->up.actions, rule->up.n_actions,
4195                              &rule->up.cr.flow, ofproto->max_ports);
4196     if (error) {
4197         ofoperation_complete(rule->up.pending, error);
4198         return;
4199     }
4200
4201     complete_operation(rule);
4202 }
4203 \f
4204 /* Sends 'packet' out 'ofport'.
4205  * May modify 'packet'.
4206  * Returns 0 if successful, otherwise a positive errno value. */
4207 static int
4208 send_packet(const struct ofport_dpif *ofport, struct ofpbuf *packet)
4209 {
4210     const struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofport->up.ofproto);
4211     struct ofpbuf key, odp_actions;
4212     struct odputil_keybuf keybuf;
4213     uint16_t odp_port;
4214     struct flow flow;
4215     int error;
4216
4217     flow_extract((struct ofpbuf *) packet, 0, 0, 0, &flow);
4218     odp_port = vsp_realdev_to_vlandev(ofproto, ofport->odp_port,
4219                                       flow.vlan_tci);
4220     if (odp_port != ofport->odp_port) {
4221         eth_pop_vlan(packet);
4222         flow.vlan_tci = htons(0);
4223     }
4224
4225     ofpbuf_use_stack(&key, &keybuf, sizeof keybuf);
4226     odp_flow_key_from_flow(&key, &flow);
4227
4228     ofpbuf_init(&odp_actions, 32);
4229     compose_sflow_action(ofproto, &odp_actions, &flow, odp_port);
4230
4231     nl_msg_put_u32(&odp_actions, OVS_ACTION_ATTR_OUTPUT, odp_port);
4232     error = dpif_execute(ofproto->dpif,
4233                          key.data, key.size,
4234                          odp_actions.data, odp_actions.size,
4235                          packet);
4236     ofpbuf_uninit(&odp_actions);
4237
4238     if (error) {
4239         VLOG_WARN_RL(&rl, "%s: failed to send packet on port %"PRIu32" (%s)",
4240                      ofproto->up.name, odp_port, strerror(error));
4241     }
4242     ofproto_update_local_port_stats(ofport->up.ofproto, packet->size, 0);
4243     return error;
4244 }
4245 \f
4246 /* OpenFlow to datapath action translation. */
4247
4248 static void do_xlate_actions(const union ofp_action *in, size_t n_in,
4249                              struct action_xlate_ctx *ctx);
4250 static void xlate_normal(struct action_xlate_ctx *);
4251
4252 static size_t
4253 put_userspace_action(const struct ofproto_dpif *ofproto,
4254                      struct ofpbuf *odp_actions,
4255                      const struct flow *flow,
4256                      const struct user_action_cookie *cookie)
4257 {
4258     uint32_t pid;
4259
4260     pid = dpif_port_get_pid(ofproto->dpif,
4261                             ofp_port_to_odp_port(flow->in_port));
4262
4263     return odp_put_userspace_action(pid, cookie, odp_actions);
4264 }
4265
4266 /* Compose SAMPLE action for sFlow. */
4267 static size_t
4268 compose_sflow_action(const struct ofproto_dpif *ofproto,
4269                      struct ofpbuf *odp_actions,
4270                      const struct flow *flow,
4271                      uint32_t odp_port)
4272 {
4273     uint32_t port_ifindex;
4274     uint32_t probability;
4275     struct user_action_cookie cookie;
4276     size_t sample_offset, actions_offset;
4277     int cookie_offset, n_output;
4278
4279     if (!ofproto->sflow || flow->in_port == OFPP_NONE) {
4280         return 0;
4281     }
4282
4283     if (odp_port == OVSP_NONE) {
4284         port_ifindex = 0;
4285         n_output = 0;
4286     } else {
4287         port_ifindex = dpif_sflow_odp_port_to_ifindex(ofproto->sflow, odp_port);
4288         n_output = 1;
4289     }
4290
4291     sample_offset = nl_msg_start_nested(odp_actions, OVS_ACTION_ATTR_SAMPLE);
4292
4293     /* Number of packets out of UINT_MAX to sample. */
4294     probability = dpif_sflow_get_probability(ofproto->sflow);
4295     nl_msg_put_u32(odp_actions, OVS_SAMPLE_ATTR_PROBABILITY, probability);
4296
4297     actions_offset = nl_msg_start_nested(odp_actions, OVS_SAMPLE_ATTR_ACTIONS);
4298
4299     cookie.type = USER_ACTION_COOKIE_SFLOW;
4300     cookie.data = port_ifindex;
4301     cookie.n_output = n_output;
4302     cookie.vlan_tci = 0;
4303     cookie_offset = put_userspace_action(ofproto, odp_actions, flow, &cookie);
4304
4305     nl_msg_end_nested(odp_actions, actions_offset);
4306     nl_msg_end_nested(odp_actions, sample_offset);
4307     return cookie_offset;
4308 }
4309
4310 /* SAMPLE action must be first action in any given list of actions.
4311  * At this point we do not have all information required to build it. So try to
4312  * build sample action as complete as possible. */
4313 static void
4314 add_sflow_action(struct action_xlate_ctx *ctx)
4315 {
4316     ctx->user_cookie_offset = compose_sflow_action(ctx->ofproto,
4317                                                    ctx->odp_actions,
4318                                                    &ctx->flow, OVSP_NONE);
4319     ctx->sflow_odp_port = 0;
4320     ctx->sflow_n_outputs = 0;
4321 }
4322
4323 /* Fix SAMPLE action according to data collected while composing ODP actions.
4324  * We need to fix SAMPLE actions OVS_SAMPLE_ATTR_ACTIONS attribute, i.e. nested
4325  * USERSPACE action's user-cookie which is required for sflow. */
4326 static void
4327 fix_sflow_action(struct action_xlate_ctx *ctx)
4328 {
4329     const struct flow *base = &ctx->base_flow;
4330     struct user_action_cookie *cookie;
4331
4332     if (!ctx->user_cookie_offset) {
4333         return;
4334     }
4335
4336     cookie = ofpbuf_at(ctx->odp_actions, ctx->user_cookie_offset,
4337                      sizeof(*cookie));
4338     assert(cookie != NULL);
4339     assert(cookie->type == USER_ACTION_COOKIE_SFLOW);
4340
4341     if (ctx->sflow_n_outputs) {
4342         cookie->data = dpif_sflow_odp_port_to_ifindex(ctx->ofproto->sflow,
4343                                                     ctx->sflow_odp_port);
4344     }
4345     if (ctx->sflow_n_outputs >= 255) {
4346         cookie->n_output = 255;
4347     } else {
4348         cookie->n_output = ctx->sflow_n_outputs;
4349     }
4350     cookie->vlan_tci = base->vlan_tci;
4351 }
4352
4353 static void
4354 compose_output_action__(struct action_xlate_ctx *ctx, uint16_t ofp_port,
4355                         bool check_stp)
4356 {
4357     const struct ofport_dpif *ofport = get_ofp_port(ctx->ofproto, ofp_port);
4358     uint16_t odp_port = ofp_port_to_odp_port(ofp_port);
4359     ovs_be16 flow_vlan_tci = ctx->flow.vlan_tci;
4360     uint8_t flow_nw_tos = ctx->flow.nw_tos;
4361     uint16_t out_port;
4362
4363     if (ofport) {
4364         struct priority_to_dscp *pdscp;
4365
4366         if (ofport->up.pp.config & OFPUTIL_PC_NO_FWD
4367             || (check_stp && !stp_forward_in_state(ofport->stp_state))) {
4368             return;
4369         }
4370
4371         pdscp = get_priority(ofport, ctx->flow.skb_priority);
4372         if (pdscp) {
4373             ctx->flow.nw_tos &= ~IP_DSCP_MASK;
4374             ctx->flow.nw_tos |= pdscp->dscp;
4375         }
4376     } else {
4377         /* We may not have an ofport record for this port, but it doesn't hurt
4378          * to allow forwarding to it anyhow.  Maybe such a port will appear
4379          * later and we're pre-populating the flow table.  */
4380     }
4381
4382     out_port = vsp_realdev_to_vlandev(ctx->ofproto, odp_port,
4383                                       ctx->flow.vlan_tci);
4384     if (out_port != odp_port) {
4385         ctx->flow.vlan_tci = htons(0);
4386     }
4387     commit_odp_actions(&ctx->flow, &ctx->base_flow, ctx->odp_actions);
4388     nl_msg_put_u32(ctx->odp_actions, OVS_ACTION_ATTR_OUTPUT, out_port);
4389
4390     ctx->sflow_odp_port = odp_port;
4391     ctx->sflow_n_outputs++;
4392     ctx->nf_output_iface = ofp_port;
4393     ctx->flow.vlan_tci = flow_vlan_tci;
4394     ctx->flow.nw_tos = flow_nw_tos;
4395 }
4396
4397 static void
4398 compose_output_action(struct action_xlate_ctx *ctx, uint16_t ofp_port)
4399 {
4400     compose_output_action__(ctx, ofp_port, true);
4401 }
4402
4403 static void
4404 xlate_table_action(struct action_xlate_ctx *ctx,
4405                    uint16_t in_port, uint8_t table_id)
4406 {
4407     if (ctx->recurse < MAX_RESUBMIT_RECURSION) {
4408         struct ofproto_dpif *ofproto = ctx->ofproto;
4409         struct rule_dpif *rule;
4410         uint16_t old_in_port;
4411         uint8_t old_table_id;
4412
4413         old_table_id = ctx->table_id;
4414         ctx->table_id = table_id;
4415
4416         /* Look up a flow with 'in_port' as the input port. */
4417         old_in_port = ctx->flow.in_port;
4418         ctx->flow.in_port = in_port;
4419         rule = rule_dpif_lookup(ofproto, &ctx->flow, table_id);
4420
4421         /* Tag the flow. */
4422         if (table_id > 0 && table_id < N_TABLES) {
4423             struct table_dpif *table = &ofproto->tables[table_id];
4424             if (table->other_table) {
4425                 ctx->tags |= (rule && rule->tag
4426                               ? rule->tag
4427                               : rule_calculate_tag(&ctx->flow,
4428                                                    &table->other_table->wc,
4429                                                    table->basis));
4430             }
4431         }
4432
4433         /* Restore the original input port.  Otherwise OFPP_NORMAL and
4434          * OFPP_IN_PORT will have surprising behavior. */
4435         ctx->flow.in_port = old_in_port;
4436
4437         if (ctx->resubmit_hook) {
4438             ctx->resubmit_hook(ctx, rule);
4439         }
4440
4441         if (rule) {
4442             struct rule_dpif *old_rule = ctx->rule;
4443
4444             ctx->recurse++;
4445             ctx->rule = rule;
4446             do_xlate_actions(rule->up.actions, rule->up.n_actions, ctx);
4447             ctx->rule = old_rule;
4448             ctx->recurse--;
4449         }
4450
4451         ctx->table_id = old_table_id;
4452     } else {
4453         static struct vlog_rate_limit recurse_rl = VLOG_RATE_LIMIT_INIT(1, 1);
4454
4455         VLOG_ERR_RL(&recurse_rl, "resubmit actions recursed over %d times",
4456                     MAX_RESUBMIT_RECURSION);
4457         ctx->max_resubmit_trigger = true;
4458     }
4459 }
4460
4461 static void
4462 xlate_resubmit_table(struct action_xlate_ctx *ctx,
4463                      const struct nx_action_resubmit *nar)
4464 {
4465     uint16_t in_port;
4466     uint8_t table_id;
4467
4468     in_port = (nar->in_port == htons(OFPP_IN_PORT)
4469                ? ctx->flow.in_port
4470                : ntohs(nar->in_port));
4471     table_id = nar->table == 255 ? ctx->table_id : nar->table;
4472
4473     xlate_table_action(ctx, in_port, table_id);
4474 }
4475
4476 static void
4477 flood_packets(struct action_xlate_ctx *ctx, bool all)
4478 {
4479     struct ofport_dpif *ofport;
4480
4481     HMAP_FOR_EACH (ofport, up.hmap_node, &ctx->ofproto->up.ports) {
4482         uint16_t ofp_port = ofport->up.ofp_port;
4483
4484         if (ofp_port == ctx->flow.in_port) {
4485             continue;
4486         }
4487
4488         if (all) {
4489             compose_output_action__(ctx, ofp_port, false);
4490         } else if (!(ofport->up.pp.config & OFPUTIL_PC_NO_FLOOD)) {
4491             compose_output_action(ctx, ofp_port);
4492         }
4493     }
4494
4495     ctx->nf_output_iface = NF_OUT_FLOOD;
4496 }
4497
4498 static void
4499 execute_controller_action(struct action_xlate_ctx *ctx, int len,
4500                           enum ofp_packet_in_reason reason,
4501                           uint16_t controller_id)
4502 {
4503     struct ofputil_packet_in pin;
4504     struct ofpbuf *packet;
4505
4506     ctx->may_set_up_flow = false;
4507     if (!ctx->packet) {
4508         return;
4509     }
4510
4511     packet = ofpbuf_clone(ctx->packet);
4512
4513     if (packet->l2 && packet->l3) {
4514         struct eth_header *eh;
4515
4516         eth_pop_vlan(packet);
4517         eh = packet->l2;
4518
4519         /* If the Ethernet type is less than ETH_TYPE_MIN, it's likely an 802.2
4520          * LLC frame.  Calculating the Ethernet type of these frames is more
4521          * trouble than seems appropriate for a simple assertion. */
4522         assert(ntohs(eh->eth_type) < ETH_TYPE_MIN
4523                || eh->eth_type == ctx->flow.dl_type);
4524
4525         memcpy(eh->eth_src, ctx->flow.dl_src, sizeof eh->eth_src);
4526         memcpy(eh->eth_dst, ctx->flow.dl_dst, sizeof eh->eth_dst);
4527
4528         if (ctx->flow.vlan_tci & htons(VLAN_CFI)) {
4529             eth_push_vlan(packet, ctx->flow.vlan_tci);
4530         }
4531
4532         if (packet->l4) {
4533             if (ctx->flow.dl_type == htons(ETH_TYPE_IP)) {
4534                 packet_set_ipv4(packet, ctx->flow.nw_src, ctx->flow.nw_dst,
4535                                 ctx->flow.nw_tos, ctx->flow.nw_ttl);
4536             }
4537
4538             if (packet->l7) {
4539                 if (ctx->flow.nw_proto == IPPROTO_TCP) {
4540                     packet_set_tcp_port(packet, ctx->flow.tp_src,
4541                                         ctx->flow.tp_dst);
4542                 } else if (ctx->flow.nw_proto == IPPROTO_UDP) {
4543                     packet_set_udp_port(packet, ctx->flow.tp_src,
4544                                         ctx->flow.tp_dst);
4545                 }
4546             }
4547         }
4548     }
4549
4550     pin.packet = packet->data;
4551     pin.packet_len = packet->size;
4552     pin.reason = reason;
4553     pin.controller_id = controller_id;
4554     pin.table_id = ctx->table_id;
4555     pin.cookie = ctx->rule ? ctx->rule->up.flow_cookie : 0;
4556
4557     pin.send_len = len;
4558     flow_get_metadata(&ctx->flow, &pin.fmd);
4559
4560     connmgr_send_packet_in(ctx->ofproto->up.connmgr, &pin);
4561     ofpbuf_delete(packet);
4562 }
4563
4564 static bool
4565 compose_dec_ttl(struct action_xlate_ctx *ctx)
4566 {
4567     if (ctx->flow.dl_type != htons(ETH_TYPE_IP) &&
4568         ctx->flow.dl_type != htons(ETH_TYPE_IPV6)) {
4569         return false;
4570     }
4571
4572     if (ctx->flow.nw_ttl > 1) {
4573         ctx->flow.nw_ttl--;
4574         return false;
4575     } else {
4576         execute_controller_action(ctx, UINT16_MAX, OFPR_INVALID_TTL, 0);
4577
4578         /* Stop processing for current table. */
4579         return true;
4580     }
4581 }
4582
4583 static void
4584 xlate_output_action__(struct action_xlate_ctx *ctx,
4585                       uint16_t port, uint16_t max_len)
4586 {
4587     uint16_t prev_nf_output_iface = ctx->nf_output_iface;
4588
4589     ctx->nf_output_iface = NF_OUT_DROP;
4590
4591     switch (port) {
4592     case OFPP_IN_PORT:
4593         compose_output_action(ctx, ctx->flow.in_port);
4594         break;
4595     case OFPP_TABLE:
4596         xlate_table_action(ctx, ctx->flow.in_port, ctx->table_id);
4597         break;
4598     case OFPP_NORMAL:
4599         xlate_normal(ctx);
4600         break;
4601     case OFPP_FLOOD:
4602         flood_packets(ctx,  false);
4603         break;
4604     case OFPP_ALL:
4605         flood_packets(ctx, true);
4606         break;
4607     case OFPP_CONTROLLER:
4608         execute_controller_action(ctx, max_len, OFPR_ACTION, 0);
4609         break;
4610     case OFPP_NONE:
4611         break;
4612     case OFPP_LOCAL:
4613     default:
4614         if (port != ctx->flow.in_port) {
4615             compose_output_action(ctx, port);
4616         }
4617         break;
4618     }
4619
4620     if (prev_nf_output_iface == NF_OUT_FLOOD) {
4621         ctx->nf_output_iface = NF_OUT_FLOOD;
4622     } else if (ctx->nf_output_iface == NF_OUT_DROP) {
4623         ctx->nf_output_iface = prev_nf_output_iface;
4624     } else if (prev_nf_output_iface != NF_OUT_DROP &&
4625                ctx->nf_output_iface != NF_OUT_FLOOD) {
4626         ctx->nf_output_iface = NF_OUT_MULTI;
4627     }
4628 }
4629
4630 static void
4631 xlate_output_reg_action(struct action_xlate_ctx *ctx,
4632                         const struct nx_action_output_reg *naor)
4633 {
4634     struct mf_subfield src;
4635     uint64_t ofp_port;
4636
4637     nxm_decode(&src, naor->src, naor->ofs_nbits);
4638     ofp_port = mf_get_subfield(&src, &ctx->flow);
4639
4640     if (ofp_port <= UINT16_MAX) {
4641         xlate_output_action__(ctx, ofp_port, ntohs(naor->max_len));
4642     }
4643 }
4644
4645 static void
4646 xlate_output_action(struct action_xlate_ctx *ctx,
4647                     const struct ofp_action_output *oao)
4648 {
4649     xlate_output_action__(ctx, ntohs(oao->port), ntohs(oao->max_len));
4650 }
4651
4652 static void
4653 xlate_enqueue_action(struct action_xlate_ctx *ctx,
4654                      const struct ofp_action_enqueue *oae)
4655 {
4656     uint16_t ofp_port;
4657     uint32_t flow_priority, priority;
4658     int error;
4659
4660     error = dpif_queue_to_priority(ctx->ofproto->dpif, ntohl(oae->queue_id),
4661                                    &priority);
4662     if (error) {
4663         /* Fall back to ordinary output action. */
4664         xlate_output_action__(ctx, ntohs(oae->port), 0);
4665         return;
4666     }
4667
4668     /* Figure out datapath output port. */
4669     ofp_port = ntohs(oae->port);
4670     if (ofp_port == OFPP_IN_PORT) {
4671         ofp_port = ctx->flow.in_port;
4672     } else if (ofp_port == ctx->flow.in_port) {
4673         return;
4674     }
4675
4676     /* Add datapath actions. */
4677     flow_priority = ctx->flow.skb_priority;
4678     ctx->flow.skb_priority = priority;
4679     compose_output_action(ctx, ofp_port);
4680     ctx->flow.skb_priority = flow_priority;
4681
4682     /* Update NetFlow output port. */
4683     if (ctx->nf_output_iface == NF_OUT_DROP) {
4684         ctx->nf_output_iface = ofp_port;
4685     } else if (ctx->nf_output_iface != NF_OUT_FLOOD) {
4686         ctx->nf_output_iface = NF_OUT_MULTI;
4687     }
4688 }
4689
4690 static void
4691 xlate_set_queue_action(struct action_xlate_ctx *ctx,
4692                        const struct nx_action_set_queue *nasq)
4693 {
4694     uint32_t priority;
4695     int error;
4696
4697     error = dpif_queue_to_priority(ctx->ofproto->dpif, ntohl(nasq->queue_id),
4698                                    &priority);
4699     if (error) {
4700         /* Couldn't translate queue to a priority, so ignore.  A warning
4701          * has already been logged. */
4702         return;
4703     }
4704
4705     ctx->flow.skb_priority = priority;
4706 }
4707
4708 struct xlate_reg_state {
4709     ovs_be16 vlan_tci;
4710     ovs_be64 tun_id;
4711 };
4712
4713 static void
4714 xlate_autopath(struct action_xlate_ctx *ctx,
4715                const struct nx_action_autopath *naa)
4716 {
4717     uint16_t ofp_port = ntohl(naa->id);
4718     struct ofport_dpif *port = get_ofp_port(ctx->ofproto, ofp_port);
4719
4720     if (!port || !port->bundle) {
4721         ofp_port = OFPP_NONE;
4722     } else if (port->bundle->bond) {
4723         /* Autopath does not support VLAN hashing. */
4724         struct ofport_dpif *slave = bond_choose_output_slave(
4725             port->bundle->bond, &ctx->flow, 0, &ctx->tags);
4726         if (slave) {
4727             ofp_port = slave->up.ofp_port;
4728         }
4729     }
4730     autopath_execute(naa, &ctx->flow, ofp_port);
4731 }
4732
4733 static bool
4734 slave_enabled_cb(uint16_t ofp_port, void *ofproto_)
4735 {
4736     struct ofproto_dpif *ofproto = ofproto_;
4737     struct ofport_dpif *port;
4738
4739     switch (ofp_port) {
4740     case OFPP_IN_PORT:
4741     case OFPP_TABLE:
4742     case OFPP_NORMAL:
4743     case OFPP_FLOOD:
4744     case OFPP_ALL:
4745     case OFPP_NONE:
4746         return true;
4747     case OFPP_CONTROLLER: /* Not supported by the bundle action. */
4748         return false;
4749     default:
4750         port = get_ofp_port(ofproto, ofp_port);
4751         return port ? port->may_enable : false;
4752     }
4753 }
4754
4755 static void
4756 xlate_learn_action(struct action_xlate_ctx *ctx,
4757                    const struct nx_action_learn *learn)
4758 {
4759     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 1);
4760     struct ofputil_flow_mod fm;
4761     int error;
4762
4763     learn_execute(learn, &ctx->flow, &fm);
4764
4765     error = ofproto_flow_mod(&ctx->ofproto->up, &fm);
4766     if (error && !VLOG_DROP_WARN(&rl)) {
4767         VLOG_WARN("learning action failed to modify flow table (%s)",
4768                   ofperr_get_name(error));
4769     }
4770
4771     free(fm.actions);
4772 }
4773
4774 /* Reduces '*timeout' to no more than 'max'.  A value of zero in either case
4775  * means "infinite". */
4776 static void
4777 reduce_timeout(uint16_t max, uint16_t *timeout)
4778 {
4779     if (max && (!*timeout || *timeout > max)) {
4780         *timeout = max;
4781     }
4782 }
4783
4784 static void
4785 xlate_fin_timeout(struct action_xlate_ctx *ctx,
4786                   const struct nx_action_fin_timeout *naft)
4787 {
4788     if (ctx->tcp_flags & (TCP_FIN | TCP_RST) && ctx->rule) {
4789         struct rule_dpif *rule = ctx->rule;
4790
4791         reduce_timeout(ntohs(naft->fin_idle_timeout), &rule->up.idle_timeout);
4792         reduce_timeout(ntohs(naft->fin_hard_timeout), &rule->up.hard_timeout);
4793     }
4794 }
4795
4796 static bool
4797 may_receive(const struct ofport_dpif *port, struct action_xlate_ctx *ctx)
4798 {
4799     if (port->up.pp.config & (eth_addr_equals(ctx->flow.dl_dst, eth_addr_stp)
4800                               ? OFPUTIL_PC_NO_RECV_STP
4801                               : OFPUTIL_PC_NO_RECV)) {
4802         return false;
4803     }
4804
4805     /* Only drop packets here if both forwarding and learning are
4806      * disabled.  If just learning is enabled, we need to have
4807      * OFPP_NORMAL and the learning action have a look at the packet
4808      * before we can drop it. */
4809     if (!stp_forward_in_state(port->stp_state)
4810             && !stp_learn_in_state(port->stp_state)) {
4811         return false;
4812     }
4813
4814     return true;
4815 }
4816
4817 static void
4818 do_xlate_actions(const union ofp_action *in, size_t n_in,
4819                  struct action_xlate_ctx *ctx)
4820 {
4821     const struct ofport_dpif *port;
4822     const union ofp_action *ia;
4823     bool was_evictable = true;
4824     size_t left;
4825
4826     port = get_ofp_port(ctx->ofproto, ctx->flow.in_port);
4827     if (port && !may_receive(port, ctx)) {
4828         /* Drop this flow. */
4829         return;
4830     }
4831
4832     if (ctx->rule) {
4833         /* Don't let the rule we're working on get evicted underneath us. */
4834         was_evictable = ctx->rule->up.evictable;
4835         ctx->rule->up.evictable = false;
4836     }
4837     OFPUTIL_ACTION_FOR_EACH_UNSAFE (ia, left, in, n_in) {
4838         const struct ofp_action_dl_addr *oada;
4839         const struct nx_action_resubmit *nar;
4840         const struct nx_action_set_tunnel *nast;
4841         const struct nx_action_set_queue *nasq;
4842         const struct nx_action_multipath *nam;
4843         const struct nx_action_autopath *naa;
4844         const struct nx_action_bundle *nab;
4845         const struct nx_action_output_reg *naor;
4846         const struct nx_action_controller *nac;
4847         enum ofputil_action_code code;
4848         ovs_be64 tun_id;
4849
4850         if (ctx->exit) {
4851             break;
4852         }
4853
4854         code = ofputil_decode_action_unsafe(ia);
4855         switch (code) {
4856         case OFPUTIL_OFPAT10_OUTPUT:
4857             xlate_output_action(ctx, &ia->output);
4858             break;
4859
4860         case OFPUTIL_OFPAT10_SET_VLAN_VID:
4861             ctx->flow.vlan_tci &= ~htons(VLAN_VID_MASK);
4862             ctx->flow.vlan_tci |= ia->vlan_vid.vlan_vid | htons(VLAN_CFI);
4863             break;
4864
4865         case OFPUTIL_OFPAT10_SET_VLAN_PCP:
4866             ctx->flow.vlan_tci &= ~htons(VLAN_PCP_MASK);
4867             ctx->flow.vlan_tci |= htons(
4868                 (ia->vlan_pcp.vlan_pcp << VLAN_PCP_SHIFT) | VLAN_CFI);
4869             break;
4870
4871         case OFPUTIL_OFPAT10_STRIP_VLAN:
4872             ctx->flow.vlan_tci = htons(0);
4873             break;
4874
4875         case OFPUTIL_OFPAT10_SET_DL_SRC:
4876             oada = ((struct ofp_action_dl_addr *) ia);
4877             memcpy(ctx->flow.dl_src, oada->dl_addr, ETH_ADDR_LEN);
4878             break;
4879
4880         case OFPUTIL_OFPAT10_SET_DL_DST:
4881             oada = ((struct ofp_action_dl_addr *) ia);
4882             memcpy(ctx->flow.dl_dst, oada->dl_addr, ETH_ADDR_LEN);
4883             break;
4884
4885         case OFPUTIL_OFPAT10_SET_NW_SRC:
4886             ctx->flow.nw_src = ia->nw_addr.nw_addr;
4887             break;
4888
4889         case OFPUTIL_OFPAT10_SET_NW_DST:
4890             ctx->flow.nw_dst = ia->nw_addr.nw_addr;
4891             break;
4892
4893         case OFPUTIL_OFPAT10_SET_NW_TOS:
4894             /* OpenFlow 1.0 only supports IPv4. */
4895             if (ctx->flow.dl_type == htons(ETH_TYPE_IP)) {
4896                 ctx->flow.nw_tos &= ~IP_DSCP_MASK;
4897                 ctx->flow.nw_tos |= ia->nw_tos.nw_tos & IP_DSCP_MASK;
4898             }
4899             break;
4900
4901         case OFPUTIL_OFPAT10_SET_TP_SRC:
4902             ctx->flow.tp_src = ia->tp_port.tp_port;
4903             break;
4904
4905         case OFPUTIL_OFPAT10_SET_TP_DST:
4906             ctx->flow.tp_dst = ia->tp_port.tp_port;
4907             break;
4908
4909         case OFPUTIL_OFPAT10_ENQUEUE:
4910             xlate_enqueue_action(ctx, (const struct ofp_action_enqueue *) ia);
4911             break;
4912
4913         case OFPUTIL_NXAST_RESUBMIT:
4914             nar = (const struct nx_action_resubmit *) ia;
4915             xlate_table_action(ctx, ntohs(nar->in_port), ctx->table_id);
4916             break;
4917
4918         case OFPUTIL_NXAST_RESUBMIT_TABLE:
4919             xlate_resubmit_table(ctx, (const struct nx_action_resubmit *) ia);
4920             break;
4921
4922         case OFPUTIL_NXAST_SET_TUNNEL:
4923             nast = (const struct nx_action_set_tunnel *) ia;
4924             tun_id = htonll(ntohl(nast->tun_id));
4925             ctx->flow.tun_id = tun_id;
4926             break;
4927
4928         case OFPUTIL_NXAST_SET_QUEUE:
4929             nasq = (const struct nx_action_set_queue *) ia;
4930             xlate_set_queue_action(ctx, nasq);
4931             break;
4932
4933         case OFPUTIL_NXAST_POP_QUEUE:
4934             ctx->flow.skb_priority = ctx->orig_skb_priority;
4935             break;
4936
4937         case OFPUTIL_NXAST_REG_MOVE:
4938             nxm_execute_reg_move((const struct nx_action_reg_move *) ia,
4939                                  &ctx->flow);
4940             break;
4941
4942         case OFPUTIL_NXAST_REG_LOAD:
4943             nxm_execute_reg_load((const struct nx_action_reg_load *) ia,
4944                                  &ctx->flow);
4945             break;
4946
4947         case OFPUTIL_NXAST_NOTE:
4948             /* Nothing to do. */
4949             break;
4950
4951         case OFPUTIL_NXAST_SET_TUNNEL64:
4952             tun_id = ((const struct nx_action_set_tunnel64 *) ia)->tun_id;
4953             ctx->flow.tun_id = tun_id;
4954             break;
4955
4956         case OFPUTIL_NXAST_MULTIPATH:
4957             nam = (const struct nx_action_multipath *) ia;
4958             multipath_execute(nam, &ctx->flow);
4959             break;
4960
4961         case OFPUTIL_NXAST_AUTOPATH:
4962             naa = (const struct nx_action_autopath *) ia;
4963             xlate_autopath(ctx, naa);
4964             break;
4965
4966         case OFPUTIL_NXAST_BUNDLE:
4967             ctx->ofproto->has_bundle_action = true;
4968             nab = (const struct nx_action_bundle *) ia;
4969             xlate_output_action__(ctx, bundle_execute(nab, &ctx->flow,
4970                                                       slave_enabled_cb,
4971                                                       ctx->ofproto), 0);
4972             break;
4973
4974         case OFPUTIL_NXAST_BUNDLE_LOAD:
4975             ctx->ofproto->has_bundle_action = true;
4976             nab = (const struct nx_action_bundle *) ia;
4977             bundle_execute_load(nab, &ctx->flow, slave_enabled_cb,
4978                                 ctx->ofproto);
4979             break;
4980
4981         case OFPUTIL_NXAST_OUTPUT_REG:
4982             naor = (const struct nx_action_output_reg *) ia;
4983             xlate_output_reg_action(ctx, naor);
4984             break;
4985
4986         case OFPUTIL_NXAST_LEARN:
4987             ctx->has_learn = true;
4988             if (ctx->may_flow_mod) {
4989                 xlate_learn_action(ctx, (const struct nx_action_learn *) ia);
4990             }
4991             break;
4992
4993         case OFPUTIL_NXAST_DEC_TTL:
4994             if (compose_dec_ttl(ctx)) {
4995                 goto out;
4996             }
4997             break;
4998
4999         case OFPUTIL_NXAST_EXIT:
5000             ctx->exit = true;
5001             break;
5002
5003         case OFPUTIL_NXAST_FIN_TIMEOUT:
5004             ctx->has_fin_timeout = true;
5005             xlate_fin_timeout(ctx, (const struct nx_action_fin_timeout *) ia);
5006             break;
5007
5008         case OFPUTIL_NXAST_CONTROLLER:
5009             nac = (const struct nx_action_controller *) ia;
5010             execute_controller_action(ctx, ntohs(nac->max_len), nac->reason,
5011                                       ntohs(nac->controller_id));
5012             break;
5013         }
5014     }
5015
5016 out:
5017     /* We've let OFPP_NORMAL and the learning action look at the packet,
5018      * so drop it now if forwarding is disabled. */
5019     if (port && !stp_forward_in_state(port->stp_state)) {
5020         ofpbuf_clear(ctx->odp_actions);
5021         add_sflow_action(ctx);
5022     }
5023     if (ctx->rule) {
5024         ctx->rule->up.evictable = was_evictable;
5025     }
5026 }
5027
5028 static void
5029 action_xlate_ctx_init(struct action_xlate_ctx *ctx,
5030                       struct ofproto_dpif *ofproto, const struct flow *flow,
5031                       ovs_be16 initial_tci, struct rule_dpif *rule,
5032                       uint8_t tcp_flags, const struct ofpbuf *packet)
5033 {
5034     ctx->ofproto = ofproto;
5035     ctx->flow = *flow;
5036     ctx->base_flow = ctx->flow;
5037     ctx->base_flow.tun_id = 0;
5038     ctx->base_flow.vlan_tci = initial_tci;
5039     ctx->rule = rule;
5040     ctx->packet = packet;
5041     ctx->may_learn_macs = packet != NULL;
5042     ctx->may_flow_mod = packet != NULL;
5043     ctx->tcp_flags = tcp_flags;
5044     ctx->resubmit_hook = NULL;
5045 }
5046
5047 static struct ofpbuf *
5048 xlate_actions(struct action_xlate_ctx *ctx,
5049               const union ofp_action *in, size_t n_in)
5050 {
5051     struct flow orig_flow = ctx->flow;
5052
5053     COVERAGE_INC(ofproto_dpif_xlate);
5054
5055     ctx->odp_actions = ofpbuf_new(512);
5056     ofpbuf_reserve(ctx->odp_actions, NL_A_U32_SIZE);
5057     ctx->tags = 0;
5058     ctx->may_set_up_flow = true;
5059     ctx->has_learn = false;
5060     ctx->has_normal = false;
5061     ctx->has_fin_timeout = false;
5062     ctx->nf_output_iface = NF_OUT_DROP;
5063     ctx->mirrors = 0;
5064     ctx->recurse = 0;
5065     ctx->max_resubmit_trigger = false;
5066     ctx->orig_skb_priority = ctx->flow.skb_priority;
5067     ctx->table_id = 0;
5068     ctx->exit = false;
5069
5070     if (ctx->flow.nw_frag & FLOW_NW_FRAG_ANY) {
5071         switch (ctx->ofproto->up.frag_handling) {
5072         case OFPC_FRAG_NORMAL:
5073             /* We must pretend that transport ports are unavailable. */
5074             ctx->flow.tp_src = ctx->base_flow.tp_src = htons(0);
5075             ctx->flow.tp_dst = ctx->base_flow.tp_dst = htons(0);
5076             break;
5077
5078         case OFPC_FRAG_DROP:
5079             return ctx->odp_actions;
5080
5081         case OFPC_FRAG_REASM:
5082             NOT_REACHED();
5083
5084         case OFPC_FRAG_NX_MATCH:
5085             /* Nothing to do. */
5086             break;
5087
5088         case OFPC_INVALID_TTL_TO_CONTROLLER:
5089             NOT_REACHED();
5090         }
5091     }
5092
5093     if (process_special(ctx->ofproto, &ctx->flow, ctx->packet)) {
5094         ctx->may_set_up_flow = false;
5095         return ctx->odp_actions;
5096     } else {
5097         static struct vlog_rate_limit trace_rl = VLOG_RATE_LIMIT_INIT(1, 1);
5098         struct flow original_flow = ctx->flow;
5099         ovs_be16 initial_tci = ctx->base_flow.vlan_tci;
5100
5101         add_sflow_action(ctx);
5102         do_xlate_actions(in, n_in, ctx);
5103
5104         if (ctx->max_resubmit_trigger && !ctx->resubmit_hook
5105             && !VLOG_DROP_ERR(&trace_rl)) {
5106             struct ds ds = DS_EMPTY_INITIALIZER;
5107
5108             ofproto_trace(ctx->ofproto, &original_flow, ctx->packet,
5109                           initial_tci, &ds);
5110             VLOG_ERR("Trace triggered by excessive resubmit recursion:\n%s",
5111                      ds_cstr(&ds));
5112             ds_destroy(&ds);
5113         }
5114
5115         if (!connmgr_may_set_up_flow(ctx->ofproto->up.connmgr, &ctx->flow,
5116                                      ctx->odp_actions->data,
5117                                      ctx->odp_actions->size)) {
5118             ctx->may_set_up_flow = false;
5119             if (ctx->packet
5120                 && connmgr_msg_in_hook(ctx->ofproto->up.connmgr, &ctx->flow,
5121                                        ctx->packet)) {
5122                 compose_output_action(ctx, OFPP_LOCAL);
5123             }
5124         }
5125         add_mirror_actions(ctx, &orig_flow);
5126         fix_sflow_action(ctx);
5127     }
5128
5129     return ctx->odp_actions;
5130 }
5131 \f
5132 /* OFPP_NORMAL implementation. */
5133
5134 static struct ofport_dpif *ofbundle_get_a_port(const struct ofbundle *);
5135
5136 /* Given 'vid', the VID obtained from the 802.1Q header that was received as
5137  * part of a packet (specify 0 if there was no 802.1Q header), and 'in_bundle',
5138  * the bundle on which the packet was received, returns the VLAN to which the
5139  * packet belongs.
5140  *
5141  * Both 'vid' and the return value are in the range 0...4095. */
5142 static uint16_t
5143 input_vid_to_vlan(const struct ofbundle *in_bundle, uint16_t vid)
5144 {
5145     switch (in_bundle->vlan_mode) {
5146     case PORT_VLAN_ACCESS:
5147         return in_bundle->vlan;
5148         break;
5149
5150     case PORT_VLAN_TRUNK:
5151         return vid;
5152
5153     case PORT_VLAN_NATIVE_UNTAGGED:
5154     case PORT_VLAN_NATIVE_TAGGED:
5155         return vid ? vid : in_bundle->vlan;
5156
5157     default:
5158         NOT_REACHED();
5159     }
5160 }
5161
5162 /* Checks whether a packet with the given 'vid' may ingress on 'in_bundle'.
5163  * If so, returns true.  Otherwise, returns false and, if 'warn' is true, logs
5164  * a warning.
5165  *
5166  * 'vid' should be the VID obtained from the 802.1Q header that was received as
5167  * part of a packet (specify 0 if there was no 802.1Q header), in the range
5168  * 0...4095. */
5169 static bool
5170 input_vid_is_valid(uint16_t vid, struct ofbundle *in_bundle, bool warn)
5171 {
5172     /* Allow any VID on the OFPP_NONE port. */
5173     if (in_bundle == &ofpp_none_bundle) {
5174         return true;
5175     }
5176
5177     switch (in_bundle->vlan_mode) {
5178     case PORT_VLAN_ACCESS:
5179         if (vid) {
5180             if (warn) {
5181                 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
5182                 VLOG_WARN_RL(&rl, "bridge %s: dropping VLAN %"PRIu16" tagged "
5183                              "packet received on port %s configured as VLAN "
5184                              "%"PRIu16" access port",
5185                              in_bundle->ofproto->up.name, vid,
5186                              in_bundle->name, in_bundle->vlan);
5187             }
5188             return false;
5189         }
5190         return true;
5191
5192     case PORT_VLAN_NATIVE_UNTAGGED:
5193     case PORT_VLAN_NATIVE_TAGGED:
5194         if (!vid) {
5195             /* Port must always carry its native VLAN. */
5196             return true;
5197         }
5198         /* Fall through. */
5199     case PORT_VLAN_TRUNK:
5200         if (!ofbundle_includes_vlan(in_bundle, vid)) {
5201             if (warn) {
5202                 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
5203                 VLOG_WARN_RL(&rl, "bridge %s: dropping VLAN %"PRIu16" packet "
5204                              "received on port %s not configured for trunking "
5205                              "VLAN %"PRIu16,
5206                              in_bundle->ofproto->up.name, vid,
5207                              in_bundle->name, vid);
5208             }
5209             return false;
5210         }
5211         return true;
5212
5213     default:
5214         NOT_REACHED();
5215     }
5216
5217 }
5218
5219 /* Given 'vlan', the VLAN that a packet belongs to, and
5220  * 'out_bundle', a bundle on which the packet is to be output, returns the VID
5221  * that should be included in the 802.1Q header.  (If the return value is 0,
5222  * then the 802.1Q header should only be included in the packet if there is a
5223  * nonzero PCP.)
5224  *
5225  * Both 'vlan' and the return value are in the range 0...4095. */
5226 static uint16_t
5227 output_vlan_to_vid(const struct ofbundle *out_bundle, uint16_t vlan)
5228 {
5229     switch (out_bundle->vlan_mode) {
5230     case PORT_VLAN_ACCESS:
5231         return 0;
5232
5233     case PORT_VLAN_TRUNK:
5234     case PORT_VLAN_NATIVE_TAGGED:
5235         return vlan;
5236
5237     case PORT_VLAN_NATIVE_UNTAGGED:
5238         return vlan == out_bundle->vlan ? 0 : vlan;
5239
5240     default:
5241         NOT_REACHED();
5242     }
5243 }
5244
5245 static void
5246 output_normal(struct action_xlate_ctx *ctx, const struct ofbundle *out_bundle,
5247               uint16_t vlan)
5248 {
5249     struct ofport_dpif *port;
5250     uint16_t vid;
5251     ovs_be16 tci, old_tci;
5252
5253     vid = output_vlan_to_vid(out_bundle, vlan);
5254     if (!out_bundle->bond) {
5255         port = ofbundle_get_a_port(out_bundle);
5256     } else {
5257         port = bond_choose_output_slave(out_bundle->bond, &ctx->flow,
5258                                         vid, &ctx->tags);
5259         if (!port) {
5260             /* No slaves enabled, so drop packet. */
5261             return;
5262         }
5263     }
5264
5265     old_tci = ctx->flow.vlan_tci;
5266     tci = htons(vid);
5267     if (tci || out_bundle->use_priority_tags) {
5268         tci |= ctx->flow.vlan_tci & htons(VLAN_PCP_MASK);
5269         if (tci) {
5270             tci |= htons(VLAN_CFI);
5271         }
5272     }
5273     ctx->flow.vlan_tci = tci;
5274
5275     compose_output_action(ctx, port->up.ofp_port);
5276     ctx->flow.vlan_tci = old_tci;
5277 }
5278
5279 static int
5280 mirror_mask_ffs(mirror_mask_t mask)
5281 {
5282     BUILD_ASSERT_DECL(sizeof(unsigned int) >= sizeof(mask));
5283     return ffs(mask);
5284 }
5285
5286 static bool
5287 ofbundle_trunks_vlan(const struct ofbundle *bundle, uint16_t vlan)
5288 {
5289     return (bundle->vlan_mode != PORT_VLAN_ACCESS
5290             && (!bundle->trunks || bitmap_is_set(bundle->trunks, vlan)));
5291 }
5292
5293 static bool
5294 ofbundle_includes_vlan(const struct ofbundle *bundle, uint16_t vlan)
5295 {
5296     return vlan == bundle->vlan || ofbundle_trunks_vlan(bundle, vlan);
5297 }
5298
5299 /* Returns an arbitrary interface within 'bundle'. */
5300 static struct ofport_dpif *
5301 ofbundle_get_a_port(const struct ofbundle *bundle)
5302 {
5303     return CONTAINER_OF(list_front(&bundle->ports),
5304                         struct ofport_dpif, bundle_node);
5305 }
5306
5307 static bool
5308 vlan_is_mirrored(const struct ofmirror *m, int vlan)
5309 {
5310     return !m->vlans || bitmap_is_set(m->vlans, vlan);
5311 }
5312
5313 /* Returns true if a packet with Ethernet destination MAC 'dst' may be mirrored
5314  * to a VLAN.  In general most packets may be mirrored but we want to drop
5315  * protocols that may confuse switches. */
5316 static bool
5317 eth_dst_may_rspan(const uint8_t dst[ETH_ADDR_LEN])
5318 {
5319     /* If you change this function's behavior, please update corresponding
5320      * documentation in vswitch.xml at the same time. */
5321     if (dst[0] != 0x01) {
5322         /* All the currently banned MACs happen to start with 01 currently, so
5323          * this is a quick way to eliminate most of the good ones. */
5324     } else {
5325         if (eth_addr_is_reserved(dst)) {
5326             /* Drop STP, IEEE pause frames, and other reserved protocols
5327              * (01-80-c2-00-00-0x). */
5328             return false;
5329         }
5330
5331         if (dst[0] == 0x01 && dst[1] == 0x00 && dst[2] == 0x0c) {
5332             /* Cisco OUI. */
5333             if ((dst[3] & 0xfe) == 0xcc &&
5334                 (dst[4] & 0xfe) == 0xcc &&
5335                 (dst[5] & 0xfe) == 0xcc) {
5336                 /* Drop the following protocols plus others following the same
5337                    pattern:
5338
5339                    CDP, VTP, DTP, PAgP  (01-00-0c-cc-cc-cc)
5340                    Spanning Tree PVSTP+ (01-00-0c-cc-cc-cd)
5341                    STP Uplink Fast      (01-00-0c-cd-cd-cd) */
5342                 return false;
5343             }
5344
5345             if (!(dst[3] | dst[4] | dst[5])) {
5346                 /* Drop Inter Switch Link packets (01-00-0c-00-00-00). */
5347                 return false;
5348             }
5349         }
5350     }
5351     return true;
5352 }
5353
5354 static void
5355 add_mirror_actions(struct action_xlate_ctx *ctx, const struct flow *orig_flow)
5356 {
5357     struct ofproto_dpif *ofproto = ctx->ofproto;
5358     mirror_mask_t mirrors;
5359     struct ofbundle *in_bundle;
5360     uint16_t vlan;
5361     uint16_t vid;
5362     const struct nlattr *a;
5363     size_t left;
5364
5365     in_bundle = lookup_input_bundle(ctx->ofproto, orig_flow->in_port,
5366                                     ctx->packet != NULL);
5367     if (!in_bundle) {
5368         return;
5369     }
5370     mirrors = in_bundle->src_mirrors;
5371
5372     /* Drop frames on bundles reserved for mirroring. */
5373     if (in_bundle->mirror_out) {
5374         if (ctx->packet != NULL) {
5375             static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
5376             VLOG_WARN_RL(&rl, "bridge %s: dropping packet received on port "
5377                          "%s, which is reserved exclusively for mirroring",
5378                          ctx->ofproto->up.name, in_bundle->name);
5379         }
5380         return;
5381     }
5382
5383     /* Check VLAN. */
5384     vid = vlan_tci_to_vid(orig_flow->vlan_tci);
5385     if (!input_vid_is_valid(vid, in_bundle, ctx->packet != NULL)) {
5386         return;
5387     }
5388     vlan = input_vid_to_vlan(in_bundle, vid);
5389
5390     /* Look at the output ports to check for destination selections. */
5391
5392     NL_ATTR_FOR_EACH (a, left, ctx->odp_actions->data,
5393                       ctx->odp_actions->size) {
5394         enum ovs_action_attr type = nl_attr_type(a);
5395         struct ofport_dpif *ofport;
5396
5397         if (type != OVS_ACTION_ATTR_OUTPUT) {
5398             continue;
5399         }
5400
5401         ofport = get_odp_port(ofproto, nl_attr_get_u32(a));
5402         if (ofport && ofport->bundle) {
5403             mirrors |= ofport->bundle->dst_mirrors;
5404         }
5405     }
5406
5407     if (!mirrors) {
5408         return;
5409     }
5410
5411     /* Restore the original packet before adding the mirror actions. */
5412     ctx->flow = *orig_flow;
5413
5414     while (mirrors) {
5415         struct ofmirror *m;
5416
5417         m = ofproto->mirrors[mirror_mask_ffs(mirrors) - 1];
5418
5419         if (!vlan_is_mirrored(m, vlan)) {
5420             mirrors &= mirrors - 1;
5421             continue;
5422         }
5423
5424         mirrors &= ~m->dup_mirrors;
5425         ctx->mirrors |= m->dup_mirrors;
5426         if (m->out) {
5427             output_normal(ctx, m->out, vlan);
5428         } else if (eth_dst_may_rspan(orig_flow->dl_dst)
5429                    && vlan != m->out_vlan) {
5430             struct ofbundle *bundle;
5431
5432             HMAP_FOR_EACH (bundle, hmap_node, &ofproto->bundles) {
5433                 if (ofbundle_includes_vlan(bundle, m->out_vlan)
5434                     && !bundle->mirror_out) {
5435                     output_normal(ctx, bundle, m->out_vlan);
5436                 }
5437             }
5438         }
5439     }
5440 }
5441
5442 static void
5443 update_mirror_stats(struct ofproto_dpif *ofproto, mirror_mask_t mirrors,
5444                     uint64_t packets, uint64_t bytes)
5445 {
5446     if (!mirrors) {
5447         return;
5448     }
5449
5450     for (; mirrors; mirrors &= mirrors - 1) {
5451         struct ofmirror *m;
5452
5453         m = ofproto->mirrors[mirror_mask_ffs(mirrors) - 1];
5454
5455         if (!m) {
5456             /* In normal circumstances 'm' will not be NULL.  However,
5457              * if mirrors are reconfigured, we can temporarily get out
5458              * of sync in facet_revalidate().  We could "correct" the
5459              * mirror list before reaching here, but doing that would
5460              * not properly account the traffic stats we've currently
5461              * accumulated for previous mirror configuration. */
5462             continue;
5463         }
5464
5465         m->packet_count += packets;
5466         m->byte_count += bytes;
5467     }
5468 }
5469
5470 /* A VM broadcasts a gratuitous ARP to indicate that it has resumed after
5471  * migration.  Older Citrix-patched Linux DomU used gratuitous ARP replies to
5472  * indicate this; newer upstream kernels use gratuitous ARP requests. */
5473 static bool
5474 is_gratuitous_arp(const struct flow *flow)
5475 {
5476     return (flow->dl_type == htons(ETH_TYPE_ARP)
5477             && eth_addr_is_broadcast(flow->dl_dst)
5478             && (flow->nw_proto == ARP_OP_REPLY
5479                 || (flow->nw_proto == ARP_OP_REQUEST
5480                     && flow->nw_src == flow->nw_dst)));
5481 }
5482
5483 static void
5484 update_learning_table(struct ofproto_dpif *ofproto,
5485                       const struct flow *flow, int vlan,
5486                       struct ofbundle *in_bundle)
5487 {
5488     struct mac_entry *mac;
5489
5490     /* Don't learn the OFPP_NONE port. */
5491     if (in_bundle == &ofpp_none_bundle) {
5492         return;
5493     }
5494
5495     if (!mac_learning_may_learn(ofproto->ml, flow->dl_src, vlan)) {
5496         return;
5497     }
5498
5499     mac = mac_learning_insert(ofproto->ml, flow->dl_src, vlan);
5500     if (is_gratuitous_arp(flow)) {
5501         /* We don't want to learn from gratuitous ARP packets that are
5502          * reflected back over bond slaves so we lock the learning table. */
5503         if (!in_bundle->bond) {
5504             mac_entry_set_grat_arp_lock(mac);
5505         } else if (mac_entry_is_grat_arp_locked(mac)) {
5506             return;
5507         }
5508     }
5509
5510     if (mac_entry_is_new(mac) || mac->port.p != in_bundle) {
5511         /* The log messages here could actually be useful in debugging,
5512          * so keep the rate limit relatively high. */
5513         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(30, 300);
5514         VLOG_DBG_RL(&rl, "bridge %s: learned that "ETH_ADDR_FMT" is "
5515                     "on port %s in VLAN %d",
5516                     ofproto->up.name, ETH_ADDR_ARGS(flow->dl_src),
5517                     in_bundle->name, vlan);
5518
5519         mac->port.p = in_bundle;
5520         tag_set_add(&ofproto->revalidate_set,
5521                     mac_learning_changed(ofproto->ml, mac));
5522     }
5523 }
5524
5525 static struct ofbundle *
5526 lookup_input_bundle(struct ofproto_dpif *ofproto, uint16_t in_port, bool warn)
5527 {
5528     struct ofport_dpif *ofport;
5529
5530     /* Special-case OFPP_NONE, which a controller may use as the ingress
5531      * port for traffic that it is sourcing. */
5532     if (in_port == OFPP_NONE) {
5533         return &ofpp_none_bundle;
5534     }
5535
5536     /* Find the port and bundle for the received packet. */
5537     ofport = get_ofp_port(ofproto, in_port);
5538     if (ofport && ofport->bundle) {
5539         return ofport->bundle;
5540     }
5541
5542     /* Odd.  A few possible reasons here:
5543      *
5544      * - We deleted a port but there are still a few packets queued up
5545      *   from it.
5546      *
5547      * - Someone externally added a port (e.g. "ovs-dpctl add-if") that
5548      *   we don't know about.
5549      *
5550      * - The ofproto client didn't configure the port as part of a bundle.
5551      */
5552     if (warn) {
5553         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
5554
5555         VLOG_WARN_RL(&rl, "bridge %s: received packet on unknown "
5556                      "port %"PRIu16, ofproto->up.name, in_port);
5557     }
5558     return NULL;
5559 }
5560
5561 /* Determines whether packets in 'flow' within 'ofproto' should be forwarded or
5562  * dropped.  Returns true if they may be forwarded, false if they should be
5563  * dropped.
5564  *
5565  * 'in_port' must be the ofport_dpif that corresponds to flow->in_port.
5566  * 'in_port' must be part of a bundle (e.g. in_port->bundle must be nonnull).
5567  *
5568  * 'vlan' must be the VLAN that corresponds to flow->vlan_tci on 'in_port', as
5569  * returned by input_vid_to_vlan().  It must be a valid VLAN for 'in_port', as
5570  * checked by input_vid_is_valid().
5571  *
5572  * May also add tags to '*tags', although the current implementation only does
5573  * so in one special case.
5574  */
5575 static bool
5576 is_admissible(struct ofproto_dpif *ofproto, const struct flow *flow,
5577               struct ofport_dpif *in_port, uint16_t vlan, tag_type *tags)
5578 {
5579     struct ofbundle *in_bundle = in_port->bundle;
5580
5581     /* Drop frames for reserved multicast addresses
5582      * only if forward_bpdu option is absent. */
5583     if (eth_addr_is_reserved(flow->dl_dst) && !ofproto->up.forward_bpdu) {
5584         return false;
5585     }
5586
5587     if (in_bundle->bond) {
5588         struct mac_entry *mac;
5589
5590         switch (bond_check_admissibility(in_bundle->bond, in_port,
5591                                          flow->dl_dst, tags)) {
5592         case BV_ACCEPT:
5593             break;
5594
5595         case BV_DROP:
5596             return false;
5597
5598         case BV_DROP_IF_MOVED:
5599             mac = mac_learning_lookup(ofproto->ml, flow->dl_src, vlan, NULL);
5600             if (mac && mac->port.p != in_bundle &&
5601                 (!is_gratuitous_arp(flow)
5602                  || mac_entry_is_grat_arp_locked(mac))) {
5603                 return false;
5604             }
5605             break;
5606         }
5607     }
5608
5609     return true;
5610 }
5611
5612 static void
5613 xlate_normal(struct action_xlate_ctx *ctx)
5614 {
5615     struct ofport_dpif *in_port;
5616     struct ofbundle *in_bundle;
5617     struct mac_entry *mac;
5618     uint16_t vlan;
5619     uint16_t vid;
5620
5621     ctx->has_normal = true;
5622
5623     in_bundle = lookup_input_bundle(ctx->ofproto, ctx->flow.in_port,
5624                                   ctx->packet != NULL);
5625     if (!in_bundle) {
5626         return;
5627     }
5628
5629     /* We know 'in_port' exists unless it is "ofpp_none_bundle",
5630      * since lookup_input_bundle() succeeded. */
5631     in_port = get_ofp_port(ctx->ofproto, ctx->flow.in_port);
5632
5633     /* Drop malformed frames. */
5634     if (ctx->flow.dl_type == htons(ETH_TYPE_VLAN) &&
5635         !(ctx->flow.vlan_tci & htons(VLAN_CFI))) {
5636         if (ctx->packet != NULL) {
5637             static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
5638             VLOG_WARN_RL(&rl, "bridge %s: dropping packet with partial "
5639                          "VLAN tag received on port %s",
5640                          ctx->ofproto->up.name, in_bundle->name);
5641         }
5642         return;
5643     }
5644
5645     /* Drop frames on bundles reserved for mirroring. */
5646     if (in_bundle->mirror_out) {
5647         if (ctx->packet != NULL) {
5648             static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
5649             VLOG_WARN_RL(&rl, "bridge %s: dropping packet received on port "
5650                          "%s, which is reserved exclusively for mirroring",
5651                          ctx->ofproto->up.name, in_bundle->name);
5652         }
5653         return;
5654     }
5655
5656     /* Check VLAN. */
5657     vid = vlan_tci_to_vid(ctx->flow.vlan_tci);
5658     if (!input_vid_is_valid(vid, in_bundle, ctx->packet != NULL)) {
5659         return;
5660     }
5661     vlan = input_vid_to_vlan(in_bundle, vid);
5662
5663     /* Check other admissibility requirements. */
5664     if (in_port &&
5665          !is_admissible(ctx->ofproto, &ctx->flow, in_port, vlan, &ctx->tags)) {
5666         return;
5667     }
5668
5669     /* Learn source MAC. */
5670     if (ctx->may_learn_macs) {
5671         update_learning_table(ctx->ofproto, &ctx->flow, vlan, in_bundle);
5672     }
5673
5674     /* Determine output bundle. */
5675     mac = mac_learning_lookup(ctx->ofproto->ml, ctx->flow.dl_dst, vlan,
5676                               &ctx->tags);
5677     if (mac) {
5678         if (mac->port.p != in_bundle) {
5679             output_normal(ctx, mac->port.p, vlan);
5680         }
5681     } else {
5682         struct ofbundle *bundle;
5683
5684         HMAP_FOR_EACH (bundle, hmap_node, &ctx->ofproto->bundles) {
5685             if (bundle != in_bundle
5686                 && ofbundle_includes_vlan(bundle, vlan)
5687                 && bundle->floodable
5688                 && !bundle->mirror_out) {
5689                 output_normal(ctx, bundle, vlan);
5690             }
5691         }
5692         ctx->nf_output_iface = NF_OUT_FLOOD;
5693     }
5694 }
5695 \f
5696 /* Optimized flow revalidation.
5697  *
5698  * It's a difficult problem, in general, to tell which facets need to have
5699  * their actions recalculated whenever the OpenFlow flow table changes.  We
5700  * don't try to solve that general problem: for most kinds of OpenFlow flow
5701  * table changes, we recalculate the actions for every facet.  This is
5702  * relatively expensive, but it's good enough if the OpenFlow flow table
5703  * doesn't change very often.
5704  *
5705  * However, we can expect one particular kind of OpenFlow flow table change to
5706  * happen frequently: changes caused by MAC learning.  To avoid wasting a lot
5707  * of CPU on revalidating every facet whenever MAC learning modifies the flow
5708  * table, we add a special case that applies to flow tables in which every rule
5709  * has the same form (that is, the same wildcards), except that the table is
5710  * also allowed to have a single "catch-all" flow that matches all packets.  We
5711  * optimize this case by tagging all of the facets that resubmit into the table
5712  * and invalidating the same tag whenever a flow changes in that table.  The
5713  * end result is that we revalidate just the facets that need it (and sometimes
5714  * a few more, but not all of the facets or even all of the facets that
5715  * resubmit to the table modified by MAC learning). */
5716
5717 /* Calculates the tag to use for 'flow' and wildcards 'wc' when it is inserted
5718  * into an OpenFlow table with the given 'basis'. */
5719 static tag_type
5720 rule_calculate_tag(const struct flow *flow, const struct flow_wildcards *wc,
5721                    uint32_t secret)
5722 {
5723     if (flow_wildcards_is_catchall(wc)) {
5724         return 0;
5725     } else {
5726         struct flow tag_flow = *flow;
5727         flow_zero_wildcards(&tag_flow, wc);
5728         return tag_create_deterministic(flow_hash(&tag_flow, secret));
5729     }
5730 }
5731
5732 /* Following a change to OpenFlow table 'table_id' in 'ofproto', update the
5733  * taggability of that table.
5734  *
5735  * This function must be called after *each* change to a flow table.  If you
5736  * skip calling it on some changes then the pointer comparisons at the end can
5737  * be invalid if you get unlucky.  For example, if a flow removal causes a
5738  * cls_table to be destroyed and then a flow insertion causes a cls_table with
5739  * different wildcards to be created with the same address, then this function
5740  * will incorrectly skip revalidation. */
5741 static void
5742 table_update_taggable(struct ofproto_dpif *ofproto, uint8_t table_id)
5743 {
5744     struct table_dpif *table = &ofproto->tables[table_id];
5745     const struct oftable *oftable = &ofproto->up.tables[table_id];
5746     struct cls_table *catchall, *other;
5747     struct cls_table *t;
5748
5749     catchall = other = NULL;
5750
5751     switch (hmap_count(&oftable->cls.tables)) {
5752     case 0:
5753         /* We could tag this OpenFlow table but it would make the logic a
5754          * little harder and it's a corner case that doesn't seem worth it
5755          * yet. */
5756         break;
5757
5758     case 1:
5759     case 2:
5760         HMAP_FOR_EACH (t, hmap_node, &oftable->cls.tables) {
5761             if (cls_table_is_catchall(t)) {
5762                 catchall = t;
5763             } else if (!other) {
5764                 other = t;
5765             } else {
5766                 /* Indicate that we can't tag this by setting both tables to
5767                  * NULL.  (We know that 'catchall' is already NULL.) */
5768                 other = NULL;
5769             }
5770         }
5771         break;
5772
5773     default:
5774         /* Can't tag this table. */
5775         break;
5776     }
5777
5778     if (table->catchall_table != catchall || table->other_table != other) {
5779         table->catchall_table = catchall;
5780         table->other_table = other;
5781         ofproto->need_revalidate = true;
5782     }
5783 }
5784
5785 /* Given 'rule' that has changed in some way (either it is a rule being
5786  * inserted, a rule being deleted, or a rule whose actions are being
5787  * modified), marks facets for revalidation to ensure that packets will be
5788  * forwarded correctly according to the new state of the flow table.
5789  *
5790  * This function must be called after *each* change to a flow table.  See
5791  * the comment on table_update_taggable() for more information. */
5792 static void
5793 rule_invalidate(const struct rule_dpif *rule)
5794 {
5795     struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
5796
5797     table_update_taggable(ofproto, rule->up.table_id);
5798
5799     if (!ofproto->need_revalidate) {
5800         struct table_dpif *table = &ofproto->tables[rule->up.table_id];
5801
5802         if (table->other_table && rule->tag) {
5803             tag_set_add(&ofproto->revalidate_set, rule->tag);
5804         } else {
5805             ofproto->need_revalidate = true;
5806         }
5807     }
5808 }
5809 \f
5810 static bool
5811 set_frag_handling(struct ofproto *ofproto_,
5812                   enum ofp_config_flags frag_handling)
5813 {
5814     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
5815
5816     if (frag_handling != OFPC_FRAG_REASM) {
5817         ofproto->need_revalidate = true;
5818         return true;
5819     } else {
5820         return false;
5821     }
5822 }
5823
5824 static enum ofperr
5825 packet_out(struct ofproto *ofproto_, struct ofpbuf *packet,
5826            const struct flow *flow,
5827            const union ofp_action *ofp_actions, size_t n_ofp_actions)
5828 {
5829     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
5830     enum ofperr error;
5831
5832     if (flow->in_port >= ofproto->max_ports && flow->in_port < OFPP_MAX) {
5833         return OFPERR_NXBRC_BAD_IN_PORT;
5834     }
5835
5836     error = validate_actions(ofp_actions, n_ofp_actions, flow,
5837                              ofproto->max_ports);
5838     if (!error) {
5839         struct odputil_keybuf keybuf;
5840         struct ofpbuf *odp_actions;
5841         struct ofproto_push push;
5842         struct ofpbuf key;
5843
5844         ofpbuf_use_stack(&key, &keybuf, sizeof keybuf);
5845         odp_flow_key_from_flow(&key, flow);
5846
5847         action_xlate_ctx_init(&push.ctx, ofproto, flow, flow->vlan_tci, NULL,
5848                               packet_get_tcp_flags(packet, flow), packet);
5849
5850         /* Ensure that resubmits in 'ofp_actions' get accounted to their
5851          * matching rules. */
5852         push.packets = 1;
5853         push.bytes = packet->size;
5854         push.used = time_msec();
5855         push.ctx.resubmit_hook = push_resubmit;
5856
5857         odp_actions = xlate_actions(&push.ctx, ofp_actions, n_ofp_actions);
5858         dpif_execute(ofproto->dpif, key.data, key.size,
5859                      odp_actions->data, odp_actions->size, packet);
5860         ofpbuf_delete(odp_actions);
5861     }
5862     return error;
5863 }
5864 \f
5865 /* NetFlow. */
5866
5867 static int
5868 set_netflow(struct ofproto *ofproto_,
5869             const struct netflow_options *netflow_options)
5870 {
5871     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
5872
5873     if (netflow_options) {
5874         if (!ofproto->netflow) {
5875             ofproto->netflow = netflow_create();
5876         }
5877         return netflow_set_options(ofproto->netflow, netflow_options);
5878     } else {
5879         netflow_destroy(ofproto->netflow);
5880         ofproto->netflow = NULL;
5881         return 0;
5882     }
5883 }
5884
5885 static void
5886 get_netflow_ids(const struct ofproto *ofproto_,
5887                 uint8_t *engine_type, uint8_t *engine_id)
5888 {
5889     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
5890
5891     dpif_get_netflow_ids(ofproto->dpif, engine_type, engine_id);
5892 }
5893
5894 static void
5895 send_active_timeout(struct ofproto_dpif *ofproto, struct facet *facet)
5896 {
5897     if (!facet_is_controller_flow(facet) &&
5898         netflow_active_timeout_expired(ofproto->netflow, &facet->nf_flow)) {
5899         struct subfacet *subfacet;
5900         struct ofexpired expired;
5901
5902         LIST_FOR_EACH (subfacet, list_node, &facet->subfacets) {
5903             if (subfacet->installed) {
5904                 struct dpif_flow_stats stats;
5905
5906                 subfacet_install(subfacet, subfacet->actions,
5907                                  subfacet->actions_len, &stats);
5908                 subfacet_update_stats(subfacet, &stats);
5909             }
5910         }
5911
5912         expired.flow = facet->flow;
5913         expired.packet_count = facet->packet_count;
5914         expired.byte_count = facet->byte_count;
5915         expired.used = facet->used;
5916         netflow_expire(ofproto->netflow, &facet->nf_flow, &expired);
5917     }
5918 }
5919
5920 static void
5921 send_netflow_active_timeouts(struct ofproto_dpif *ofproto)
5922 {
5923     struct facet *facet;
5924
5925     HMAP_FOR_EACH (facet, hmap_node, &ofproto->facets) {
5926         send_active_timeout(ofproto, facet);
5927     }
5928 }
5929 \f
5930 static struct ofproto_dpif *
5931 ofproto_dpif_lookup(const char *name)
5932 {
5933     struct ofproto_dpif *ofproto;
5934
5935     HMAP_FOR_EACH_WITH_HASH (ofproto, all_ofproto_dpifs_node,
5936                              hash_string(name, 0), &all_ofproto_dpifs) {
5937         if (!strcmp(ofproto->up.name, name)) {
5938             return ofproto;
5939         }
5940     }
5941     return NULL;
5942 }
5943
5944 static void
5945 ofproto_unixctl_fdb_flush(struct unixctl_conn *conn, int argc,
5946                           const char *argv[], void *aux OVS_UNUSED)
5947 {
5948     struct ofproto_dpif *ofproto;
5949
5950     if (argc > 1) {
5951         ofproto = ofproto_dpif_lookup(argv[1]);
5952         if (!ofproto) {
5953             unixctl_command_reply_error(conn, "no such bridge");
5954             return;
5955         }
5956         mac_learning_flush(ofproto->ml, &ofproto->revalidate_set);
5957     } else {
5958         HMAP_FOR_EACH (ofproto, all_ofproto_dpifs_node, &all_ofproto_dpifs) {
5959             mac_learning_flush(ofproto->ml, &ofproto->revalidate_set);
5960         }
5961     }
5962
5963     unixctl_command_reply(conn, "table successfully flushed");
5964 }
5965
5966 static void
5967 ofproto_unixctl_fdb_show(struct unixctl_conn *conn, int argc OVS_UNUSED,
5968                          const char *argv[], void *aux OVS_UNUSED)
5969 {
5970     struct ds ds = DS_EMPTY_INITIALIZER;
5971     const struct ofproto_dpif *ofproto;
5972     const struct mac_entry *e;
5973
5974     ofproto = ofproto_dpif_lookup(argv[1]);
5975     if (!ofproto) {
5976         unixctl_command_reply_error(conn, "no such bridge");
5977         return;
5978     }
5979
5980     ds_put_cstr(&ds, " port  VLAN  MAC                Age\n");
5981     LIST_FOR_EACH (e, lru_node, &ofproto->ml->lrus) {
5982         struct ofbundle *bundle = e->port.p;
5983         ds_put_format(&ds, "%5d  %4d  "ETH_ADDR_FMT"  %3d\n",
5984                       ofbundle_get_a_port(bundle)->odp_port,
5985                       e->vlan, ETH_ADDR_ARGS(e->mac),
5986                       mac_entry_age(ofproto->ml, e));
5987     }
5988     unixctl_command_reply(conn, ds_cstr(&ds));
5989     ds_destroy(&ds);
5990 }
5991
5992 struct trace_ctx {
5993     struct action_xlate_ctx ctx;
5994     struct flow flow;
5995     struct ds *result;
5996 };
5997
5998 static void
5999 trace_format_rule(struct ds *result, uint8_t table_id, int level,
6000                   const struct rule_dpif *rule)
6001 {
6002     ds_put_char_multiple(result, '\t', level);
6003     if (!rule) {
6004         ds_put_cstr(result, "No match\n");
6005         return;
6006     }
6007
6008     ds_put_format(result, "Rule: table=%"PRIu8" cookie=%#"PRIx64" ",
6009                   table_id, ntohll(rule->up.flow_cookie));
6010     cls_rule_format(&rule->up.cr, result);
6011     ds_put_char(result, '\n');
6012
6013     ds_put_char_multiple(result, '\t', level);
6014     ds_put_cstr(result, "OpenFlow ");
6015     ofp_print_actions(result, rule->up.actions, rule->up.n_actions);
6016     ds_put_char(result, '\n');
6017 }
6018
6019 static void
6020 trace_format_flow(struct ds *result, int level, const char *title,
6021                  struct trace_ctx *trace)
6022 {
6023     ds_put_char_multiple(result, '\t', level);
6024     ds_put_format(result, "%s: ", title);
6025     if (flow_equal(&trace->ctx.flow, &trace->flow)) {
6026         ds_put_cstr(result, "unchanged");
6027     } else {
6028         flow_format(result, &trace->ctx.flow);
6029         trace->flow = trace->ctx.flow;
6030     }
6031     ds_put_char(result, '\n');
6032 }
6033
6034 static void
6035 trace_format_regs(struct ds *result, int level, const char *title,
6036                   struct trace_ctx *trace)
6037 {
6038     size_t i;
6039
6040     ds_put_char_multiple(result, '\t', level);
6041     ds_put_format(result, "%s:", title);
6042     for (i = 0; i < FLOW_N_REGS; i++) {
6043         ds_put_format(result, " reg%zu=0x%"PRIx32, i, trace->flow.regs[i]);
6044     }
6045     ds_put_char(result, '\n');
6046 }
6047
6048 static void
6049 trace_format_odp(struct ds *result, int level, const char *title,
6050                  struct trace_ctx *trace)
6051 {
6052     struct ofpbuf *odp_actions = trace->ctx.odp_actions;
6053
6054     ds_put_char_multiple(result, '\t', level);
6055     ds_put_format(result, "%s: ", title);
6056     format_odp_actions(result, odp_actions->data, odp_actions->size);
6057     ds_put_char(result, '\n');
6058 }
6059
6060 static void
6061 trace_resubmit(struct action_xlate_ctx *ctx, struct rule_dpif *rule)
6062 {
6063     struct trace_ctx *trace = CONTAINER_OF(ctx, struct trace_ctx, ctx);
6064     struct ds *result = trace->result;
6065
6066     ds_put_char(result, '\n');
6067     trace_format_flow(result, ctx->recurse + 1, "Resubmitted flow", trace);
6068     trace_format_regs(result, ctx->recurse + 1, "Resubmitted regs", trace);
6069     trace_format_odp(result,  ctx->recurse + 1, "Resubmitted  odp", trace);
6070     trace_format_rule(result, ctx->table_id, ctx->recurse + 1, rule);
6071 }
6072
6073 static void
6074 ofproto_unixctl_trace(struct unixctl_conn *conn, int argc, const char *argv[],
6075                       void *aux OVS_UNUSED)
6076 {
6077     const char *dpname = argv[1];
6078     struct ofproto_dpif *ofproto;
6079     struct ofpbuf odp_key;
6080     struct ofpbuf *packet;
6081     ovs_be16 initial_tci;
6082     struct ds result;
6083     struct flow flow;
6084     char *s;
6085
6086     packet = NULL;
6087     ofpbuf_init(&odp_key, 0);
6088     ds_init(&result);
6089
6090     ofproto = ofproto_dpif_lookup(dpname);
6091     if (!ofproto) {
6092         unixctl_command_reply_error(conn, "Unknown ofproto (use ofproto/list "
6093                                     "for help)");
6094         goto exit;
6095     }
6096     if (argc == 3 || (argc == 4 && !strcmp(argv[3], "-generate"))) {
6097         /* ofproto/trace dpname flow [-generate] */
6098         const char *flow_s = argv[2];
6099         const char *generate_s = argv[3];
6100         int error;
6101
6102         /* Convert string to datapath key. */
6103         ofpbuf_init(&odp_key, 0);
6104         error = odp_flow_key_from_string(flow_s, NULL, &odp_key);
6105         if (error) {
6106             unixctl_command_reply_error(conn, "Bad flow syntax");
6107             goto exit;
6108         }
6109
6110         /* Convert odp_key to flow. */
6111         error = ofproto_dpif_extract_flow_key(ofproto, odp_key.data,
6112                                               odp_key.size, &flow,
6113                                               &initial_tci, NULL);
6114         if (error == ODP_FIT_ERROR) {
6115             unixctl_command_reply_error(conn, "Invalid flow");
6116             goto exit;
6117         }
6118
6119         /* Generate a packet, if requested. */
6120         if (generate_s) {
6121             packet = ofpbuf_new(0);
6122             flow_compose(packet, &flow);
6123         }
6124     } else if (argc == 6) {
6125         /* ofproto/trace dpname priority tun_id in_port packet */
6126         const char *priority_s = argv[2];
6127         const char *tun_id_s = argv[3];
6128         const char *in_port_s = argv[4];
6129         const char *packet_s = argv[5];
6130         uint16_t in_port = ofp_port_to_odp_port(atoi(in_port_s));
6131         ovs_be64 tun_id = htonll(strtoull(tun_id_s, NULL, 0));
6132         uint32_t priority = atoi(priority_s);
6133         const char *msg;
6134
6135         msg = eth_from_hex(packet_s, &packet);
6136         if (msg) {
6137             unixctl_command_reply_error(conn, msg);
6138             goto exit;
6139         }
6140
6141         ds_put_cstr(&result, "Packet: ");
6142         s = ofp_packet_to_string(packet->data, packet->size);
6143         ds_put_cstr(&result, s);
6144         free(s);
6145
6146         flow_extract(packet, priority, tun_id, in_port, &flow);
6147         initial_tci = flow.vlan_tci;
6148     } else {
6149         unixctl_command_reply_error(conn, "Bad command syntax");
6150         goto exit;
6151     }
6152
6153     ofproto_trace(ofproto, &flow, packet, initial_tci, &result);
6154     unixctl_command_reply(conn, ds_cstr(&result));
6155
6156 exit:
6157     ds_destroy(&result);
6158     ofpbuf_delete(packet);
6159     ofpbuf_uninit(&odp_key);
6160 }
6161
6162 static void
6163 ofproto_trace(struct ofproto_dpif *ofproto, const struct flow *flow,
6164               const struct ofpbuf *packet, ovs_be16 initial_tci,
6165               struct ds *ds)
6166 {
6167     struct rule_dpif *rule;
6168
6169     ds_put_cstr(ds, "Flow: ");
6170     flow_format(ds, flow);
6171     ds_put_char(ds, '\n');
6172
6173     rule = rule_dpif_lookup(ofproto, flow, 0);
6174     trace_format_rule(ds, 0, 0, rule);
6175     if (rule) {
6176         struct trace_ctx trace;
6177         struct ofpbuf *odp_actions;
6178         uint8_t tcp_flags;
6179
6180         tcp_flags = packet ? packet_get_tcp_flags(packet, flow) : 0;
6181         trace.result = ds;
6182         trace.flow = *flow;
6183         action_xlate_ctx_init(&trace.ctx, ofproto, flow, initial_tci,
6184                               rule, tcp_flags, packet);
6185         trace.ctx.resubmit_hook = trace_resubmit;
6186         odp_actions = xlate_actions(&trace.ctx,
6187                                     rule->up.actions, rule->up.n_actions);
6188
6189         ds_put_char(ds, '\n');
6190         trace_format_flow(ds, 0, "Final flow", &trace);
6191         ds_put_cstr(ds, "Datapath actions: ");
6192         format_odp_actions(ds, odp_actions->data, odp_actions->size);
6193         ofpbuf_delete(odp_actions);
6194
6195         if (!trace.ctx.may_set_up_flow) {
6196             if (packet) {
6197                 ds_put_cstr(ds, "\nThis flow is not cachable.");
6198             } else {
6199                 ds_put_cstr(ds, "\nThe datapath actions are incomplete--"
6200                             "for complete actions, please supply a packet.");
6201             }
6202         }
6203     }
6204 }
6205
6206 static void
6207 ofproto_dpif_clog(struct unixctl_conn *conn OVS_UNUSED, int argc OVS_UNUSED,
6208                   const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED)
6209 {
6210     clogged = true;
6211     unixctl_command_reply(conn, NULL);
6212 }
6213
6214 static void
6215 ofproto_dpif_unclog(struct unixctl_conn *conn OVS_UNUSED, int argc OVS_UNUSED,
6216                     const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED)
6217 {
6218     clogged = false;
6219     unixctl_command_reply(conn, NULL);
6220 }
6221
6222 /* Runs a self-check of flow translations in 'ofproto'.  Appends a message to
6223  * 'reply' describing the results. */
6224 static void
6225 ofproto_dpif_self_check__(struct ofproto_dpif *ofproto, struct ds *reply)
6226 {
6227     struct facet *facet;
6228     int errors;
6229
6230     errors = 0;
6231     HMAP_FOR_EACH (facet, hmap_node, &ofproto->facets) {
6232         if (!facet_check_consistency(facet)) {
6233             errors++;
6234         }
6235     }
6236     if (errors) {
6237         ofproto->need_revalidate = true;
6238     }
6239
6240     if (errors) {
6241         ds_put_format(reply, "%s: self-check failed (%d errors)\n",
6242                       ofproto->up.name, errors);
6243     } else {
6244         ds_put_format(reply, "%s: self-check passed\n", ofproto->up.name);
6245     }
6246 }
6247
6248 static void
6249 ofproto_dpif_self_check(struct unixctl_conn *conn,
6250                         int argc, const char *argv[], void *aux OVS_UNUSED)
6251 {
6252     struct ds reply = DS_EMPTY_INITIALIZER;
6253     struct ofproto_dpif *ofproto;
6254
6255     if (argc > 1) {
6256         ofproto = ofproto_dpif_lookup(argv[1]);
6257         if (!ofproto) {
6258             unixctl_command_reply_error(conn, "Unknown ofproto (use "
6259                                         "ofproto/list for help)");
6260             return;
6261         }
6262         ofproto_dpif_self_check__(ofproto, &reply);
6263     } else {
6264         HMAP_FOR_EACH (ofproto, all_ofproto_dpifs_node, &all_ofproto_dpifs) {
6265             ofproto_dpif_self_check__(ofproto, &reply);
6266         }
6267     }
6268
6269     unixctl_command_reply(conn, ds_cstr(&reply));
6270     ds_destroy(&reply);
6271 }
6272
6273 static void
6274 ofproto_dpif_unixctl_init(void)
6275 {
6276     static bool registered;
6277     if (registered) {
6278         return;
6279     }
6280     registered = true;
6281
6282     unixctl_command_register(
6283         "ofproto/trace",
6284         "bridge {tun_id in_port packet | odp_flow [-generate]}",
6285         2, 5, ofproto_unixctl_trace, NULL);
6286     unixctl_command_register("fdb/flush", "[bridge]", 0, 1,
6287                              ofproto_unixctl_fdb_flush, NULL);
6288     unixctl_command_register("fdb/show", "bridge", 1, 1,
6289                              ofproto_unixctl_fdb_show, NULL);
6290     unixctl_command_register("ofproto/clog", "", 0, 0,
6291                              ofproto_dpif_clog, NULL);
6292     unixctl_command_register("ofproto/unclog", "", 0, 0,
6293                              ofproto_dpif_unclog, NULL);
6294     unixctl_command_register("ofproto/self-check", "[bridge]", 0, 1,
6295                              ofproto_dpif_self_check, NULL);
6296 }
6297 \f
6298 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
6299  *
6300  * This is deprecated.  It is only for compatibility with broken device drivers
6301  * in old versions of Linux that do not properly support VLANs when VLAN
6302  * devices are not used.  When broken device drivers are no longer in
6303  * widespread use, we will delete these interfaces. */
6304
6305 static int
6306 set_realdev(struct ofport *ofport_, uint16_t realdev_ofp_port, int vid)
6307 {
6308     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofport_->ofproto);
6309     struct ofport_dpif *ofport = ofport_dpif_cast(ofport_);
6310
6311     if (realdev_ofp_port == ofport->realdev_ofp_port
6312         && vid == ofport->vlandev_vid) {
6313         return 0;
6314     }
6315
6316     ofproto->need_revalidate = true;
6317
6318     if (ofport->realdev_ofp_port) {
6319         vsp_remove(ofport);
6320     }
6321     if (realdev_ofp_port && ofport->bundle) {
6322         /* vlandevs are enslaved to their realdevs, so they are not allowed to
6323          * themselves be part of a bundle. */
6324         bundle_set(ofport->up.ofproto, ofport->bundle, NULL);
6325     }
6326
6327     ofport->realdev_ofp_port = realdev_ofp_port;
6328     ofport->vlandev_vid = vid;
6329
6330     if (realdev_ofp_port) {
6331         vsp_add(ofport, realdev_ofp_port, vid);
6332     }
6333
6334     return 0;
6335 }
6336
6337 static uint32_t
6338 hash_realdev_vid(uint16_t realdev_ofp_port, int vid)
6339 {
6340     return hash_2words(realdev_ofp_port, vid);
6341 }
6342
6343 /* Returns the ODP port number of the Linux VLAN device that corresponds to
6344  * 'vlan_tci' on the network device with port number 'realdev_odp_port' in
6345  * 'ofproto'.  For example, given 'realdev_odp_port' of eth0 and 'vlan_tci' 9,
6346  * it would return the port number of eth0.9.
6347  *
6348  * Unless VLAN splinters are enabled for port 'realdev_odp_port', this
6349  * function just returns its 'realdev_odp_port' argument. */
6350 static uint32_t
6351 vsp_realdev_to_vlandev(const struct ofproto_dpif *ofproto,
6352                        uint32_t realdev_odp_port, ovs_be16 vlan_tci)
6353 {
6354     if (!hmap_is_empty(&ofproto->realdev_vid_map)) {
6355         uint16_t realdev_ofp_port = odp_port_to_ofp_port(realdev_odp_port);
6356         int vid = vlan_tci_to_vid(vlan_tci);
6357         const struct vlan_splinter *vsp;
6358
6359         HMAP_FOR_EACH_WITH_HASH (vsp, realdev_vid_node,
6360                                  hash_realdev_vid(realdev_ofp_port, vid),
6361                                  &ofproto->realdev_vid_map) {
6362             if (vsp->realdev_ofp_port == realdev_ofp_port
6363                 && vsp->vid == vid) {
6364                 return ofp_port_to_odp_port(vsp->vlandev_ofp_port);
6365             }
6366         }
6367     }
6368     return realdev_odp_port;
6369 }
6370
6371 static struct vlan_splinter *
6372 vlandev_find(const struct ofproto_dpif *ofproto, uint16_t vlandev_ofp_port)
6373 {
6374     struct vlan_splinter *vsp;
6375
6376     HMAP_FOR_EACH_WITH_HASH (vsp, vlandev_node, hash_int(vlandev_ofp_port, 0),
6377                              &ofproto->vlandev_map) {
6378         if (vsp->vlandev_ofp_port == vlandev_ofp_port) {
6379             return vsp;
6380         }
6381     }
6382
6383     return NULL;
6384 }
6385
6386 /* Returns the OpenFlow port number of the "real" device underlying the Linux
6387  * VLAN device with OpenFlow port number 'vlandev_ofp_port' and stores the
6388  * VLAN VID of the Linux VLAN device in '*vid'.  For example, given
6389  * 'vlandev_ofp_port' of eth0.9, it would return the OpenFlow port number of
6390  * eth0 and store 9 in '*vid'.
6391  *
6392  * Returns 0 and does not modify '*vid' if 'vlandev_ofp_port' is not a Linux
6393  * VLAN device.  Unless VLAN splinters are enabled, this is what this function
6394  * always does.*/
6395 static uint16_t
6396 vsp_vlandev_to_realdev(const struct ofproto_dpif *ofproto,
6397                        uint16_t vlandev_ofp_port, int *vid)
6398 {
6399     if (!hmap_is_empty(&ofproto->vlandev_map)) {
6400         const struct vlan_splinter *vsp;
6401
6402         vsp = vlandev_find(ofproto, vlandev_ofp_port);
6403         if (vsp) {
6404             if (vid) {
6405                 *vid = vsp->vid;
6406             }
6407             return vsp->realdev_ofp_port;
6408         }
6409     }
6410     return 0;
6411 }
6412
6413 static void
6414 vsp_remove(struct ofport_dpif *port)
6415 {
6416     struct ofproto_dpif *ofproto = ofproto_dpif_cast(port->up.ofproto);
6417     struct vlan_splinter *vsp;
6418
6419     vsp = vlandev_find(ofproto, port->up.ofp_port);
6420     if (vsp) {
6421         hmap_remove(&ofproto->vlandev_map, &vsp->vlandev_node);
6422         hmap_remove(&ofproto->realdev_vid_map, &vsp->realdev_vid_node);
6423         free(vsp);
6424
6425         port->realdev_ofp_port = 0;
6426     } else {
6427         VLOG_ERR("missing vlan device record");
6428     }
6429 }
6430
6431 static void
6432 vsp_add(struct ofport_dpif *port, uint16_t realdev_ofp_port, int vid)
6433 {
6434     struct ofproto_dpif *ofproto = ofproto_dpif_cast(port->up.ofproto);
6435
6436     if (!vsp_vlandev_to_realdev(ofproto, port->up.ofp_port, NULL)
6437         && (vsp_realdev_to_vlandev(ofproto, realdev_ofp_port, htons(vid))
6438             == realdev_ofp_port)) {
6439         struct vlan_splinter *vsp;
6440
6441         vsp = xmalloc(sizeof *vsp);
6442         hmap_insert(&ofproto->vlandev_map, &vsp->vlandev_node,
6443                     hash_int(port->up.ofp_port, 0));
6444         hmap_insert(&ofproto->realdev_vid_map, &vsp->realdev_vid_node,
6445                     hash_realdev_vid(realdev_ofp_port, vid));
6446         vsp->realdev_ofp_port = realdev_ofp_port;
6447         vsp->vlandev_ofp_port = port->up.ofp_port;
6448         vsp->vid = vid;
6449
6450         port->realdev_ofp_port = realdev_ofp_port;
6451     } else {
6452         VLOG_ERR("duplicate vlan device record");
6453     }
6454 }
6455 \f
6456 const struct ofproto_class ofproto_dpif_class = {
6457     enumerate_types,
6458     enumerate_names,
6459     del,
6460     alloc,
6461     construct,
6462     destruct,
6463     dealloc,
6464     run,
6465     run_fast,
6466     wait,
6467     flush,
6468     get_features,
6469     get_tables,
6470     port_alloc,
6471     port_construct,
6472     port_destruct,
6473     port_dealloc,
6474     port_modified,
6475     port_reconfigured,
6476     port_query_by_name,
6477     port_add,
6478     port_del,
6479     port_get_stats,
6480     port_dump_start,
6481     port_dump_next,
6482     port_dump_done,
6483     port_poll,
6484     port_poll_wait,
6485     port_is_lacp_current,
6486     NULL,                       /* rule_choose_table */
6487     rule_alloc,
6488     rule_construct,
6489     rule_destruct,
6490     rule_dealloc,
6491     rule_get_stats,
6492     rule_execute,
6493     rule_modify_actions,
6494     set_frag_handling,
6495     packet_out,
6496     set_netflow,
6497     get_netflow_ids,
6498     set_sflow,
6499     set_cfm,
6500     get_cfm_fault,
6501     get_cfm_remote_mpids,
6502     get_cfm_health,
6503     set_stp,
6504     get_stp_status,
6505     set_stp_port,
6506     get_stp_port_status,
6507     set_queues,
6508     bundle_set,
6509     bundle_remove,
6510     mirror_set,
6511     mirror_get_stats,
6512     set_flood_vlans,
6513     is_mirror_output_bundle,
6514     forward_bpdu_changed,
6515     set_mac_idle_time,
6516     set_realdev,
6517 };