ofproto/ofproto-dpif.c

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