ofproto/ofproto-dpif.c

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