ofproto/ofproto-dpif.c

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