ofproto/ofproto-dpif.c

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