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