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