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