ofproto/ofproto-dpif.c

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