ofproto/ofproto-dpif.c

   1 /*
   2  * Copyright (c) 2009, 2010, 2011, 2012, 2013 Nicira, Inc.
   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 "bfd.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-vport.h"
  40 #include "netdev.h"
  41 #include "netlink.h"
  42 #include "nx-match.h"
  43 #include "odp-util.h"
  44 #include "ofp-util.h"
  45 #include "ofpbuf.h"
  46 #include "ofp-actions.h"
  47 #include "ofp-parse.h"
  48 #include "ofp-print.h"
  49 #include "ofproto-dpif-governor.h"
  50 #include "ofproto-dpif-ipfix.h"
  51 #include "ofproto-dpif-sflow.h"
  52 #include "poll-loop.h"
  53 #include "simap.h"
  54 #include "smap.h"
  55 #include "timer.h"
  56 #include "tunnel.h"
  57 #include "unaligned.h"
  58 #include "unixctl.h"
  59 #include "vlan-bitmap.h"
  60 #include "vlog.h"
  61
  62 VLOG_DEFINE_THIS_MODULE(ofproto_dpif);
  63
  64 COVERAGE_DEFINE(ofproto_dpif_expired);
  65 COVERAGE_DEFINE(ofproto_dpif_xlate);
  66 COVERAGE_DEFINE(facet_changed_rule);
  67 COVERAGE_DEFINE(facet_revalidate);
  68 COVERAGE_DEFINE(facet_unexpected);
  69 COVERAGE_DEFINE(facet_suppress);
  70
  71 /* Maximum depth of flow table recursion (due to resubmit actions) in a
  72  * flow translation. */
  73 #define MAX_RESUBMIT_RECURSION 64
  74
  75 /* Number of implemented OpenFlow tables. */
  76 enum { N_TABLES = 255 };
  77 enum { TBL_INTERNAL = N_TABLES - 1 };    /* Used for internal hidden rules. */
  78 BUILD_ASSERT_DECL(N_TABLES >= 2 && N_TABLES <= 255);
  79
  80 struct ofport_dpif;
  81 struct ofproto_dpif;
  82 struct flow_miss;
  83 struct facet;
  84
  85 struct rule_dpif {
  86     struct rule up;
  87
  88     /* These statistics:
  89      *
  90      *   - Do include packets and bytes from facets that have been deleted or
  91      *     whose own statistics have been folded into the rule.
  92      *
  93      *   - Do include packets and bytes sent "by hand" that were accounted to
  94      *     the rule without any facet being involved (this is a rare corner
  95      *     case in rule_execute()).
  96      *
  97      *   - Do not include packet or bytes that can be obtained from any facet's
  98      *     packet_count or byte_count member or that can be obtained from the
  99      *     datapath by, e.g., dpif_flow_get() for any subfacet.
 100      */
 101     uint64_t packet_count;       /* Number of packets received. */
 102     uint64_t byte_count;         /* Number of bytes received. */
 103
 104     tag_type tag;                /* Caches rule_calculate_tag() result. */
 105
 106     struct list facets;          /* List of "struct facet"s. */
 107 };
 108
 109 static struct rule_dpif *rule_dpif_cast(const struct rule *rule)
 110 {
 111     return rule ? CONTAINER_OF(rule, struct rule_dpif, up) : NULL;
 112 }
 113
 114 static struct rule_dpif *rule_dpif_lookup(struct ofproto_dpif *,
 115                                           const struct flow *);
 116 static struct rule_dpif *rule_dpif_lookup__(struct ofproto_dpif *,
 117                                             const struct flow *,
 118                                             uint8_t table);
 119 static struct rule_dpif *rule_dpif_miss_rule(struct ofproto_dpif *ofproto,
 120                                              const struct flow *flow);
 121
 122 static void rule_credit_stats(struct rule_dpif *,
 123                               const struct dpif_flow_stats *);
 124 static void flow_push_stats(struct facet *, const struct dpif_flow_stats *);
 125 static tag_type rule_calculate_tag(const struct flow *,
 126                                    const struct minimask *, uint32_t basis);
 127 static void rule_invalidate(const struct rule_dpif *);
 128
 129 #define MAX_MIRRORS 32
 130 typedef uint32_t mirror_mask_t;
 131 #define MIRROR_MASK_C(X) UINT32_C(X)
 132 BUILD_ASSERT_DECL(sizeof(mirror_mask_t) * CHAR_BIT >= MAX_MIRRORS);
 133 struct ofmirror {
 134     struct ofproto_dpif *ofproto; /* Owning ofproto. */
 135     size_t idx;                 /* In ofproto's "mirrors" array. */
 136     void *aux;                  /* Key supplied by ofproto's client. */
 137     char *name;                 /* Identifier for log messages. */
 138
 139     /* Selection criteria. */
 140     struct hmapx srcs;          /* Contains "struct ofbundle *"s. */
 141     struct hmapx dsts;          /* Contains "struct ofbundle *"s. */
 142     unsigned long *vlans;       /* Bitmap of chosen VLANs, NULL selects all. */
 143
 144     /* Output (exactly one of out == NULL and out_vlan == -1 is true). */
 145     struct ofbundle *out;       /* Output port or NULL. */
 146     int out_vlan;               /* Output VLAN or -1. */
 147     mirror_mask_t dup_mirrors;  /* Bitmap of mirrors with the same output. */
 148
 149     /* Counters. */
 150     int64_t packet_count;       /* Number of packets sent. */
 151     int64_t byte_count;         /* Number of bytes sent. */
 152 };
 153
 154 static void mirror_destroy(struct ofmirror *);
 155 static void update_mirror_stats(struct ofproto_dpif *ofproto,
 156                                 mirror_mask_t mirrors,
 157                                 uint64_t packets, uint64_t bytes);
 158
 159 struct ofbundle {
 160     struct hmap_node hmap_node; /* In struct ofproto's "bundles" hmap. */
 161     struct ofproto_dpif *ofproto; /* Owning ofproto. */
 162     void *aux;                  /* Key supplied by ofproto's client. */
 163     char *name;                 /* Identifier for log messages. */
 164
 165     /* Configuration. */
 166     struct list ports;          /* Contains "struct ofport"s. */
 167     enum port_vlan_mode vlan_mode; /* VLAN mode */
 168     int vlan;                   /* -1=trunk port, else a 12-bit VLAN ID. */
 169     unsigned long *trunks;      /* Bitmap of trunked VLANs, if 'vlan' == -1.
 170                                  * NULL if all VLANs are trunked. */
 171     struct lacp *lacp;          /* LACP if LACP is enabled, otherwise NULL. */
 172     struct bond *bond;          /* Nonnull iff more than one port. */
 173     bool use_priority_tags;     /* Use 802.1p tag for frames in VLAN 0? */
 174
 175     /* Status. */
 176     bool floodable;          /* True if no port has OFPUTIL_PC_NO_FLOOD set. */
 177
 178     /* Port mirroring info. */
 179     mirror_mask_t src_mirrors;  /* Mirrors triggered when packet received. */
 180     mirror_mask_t dst_mirrors;  /* Mirrors triggered when packet sent. */
 181     mirror_mask_t mirror_out;   /* Mirrors that output to this bundle. */
 182 };
 183
 184 static void bundle_remove(struct ofport *);
 185 static void bundle_update(struct ofbundle *);
 186 static void bundle_destroy(struct ofbundle *);
 187 static void bundle_del_port(struct ofport_dpif *);
 188 static void bundle_run(struct ofbundle *);
 189 static void bundle_wait(struct ofbundle *);
 190 static struct ofbundle *lookup_input_bundle(const struct ofproto_dpif *,
 191                                             uint16_t in_port, bool warn,
 192                                             struct ofport_dpif **in_ofportp);
 193
 194 /* A controller may use OFPP_NONE as the ingress port to indicate that
 195  * it did not arrive on a "real" port.  'ofpp_none_bundle' exists for
 196  * when an input bundle is needed for validation (e.g., mirroring or
 197  * OFPP_NORMAL processing).  It is not connected to an 'ofproto' or have
 198  * any 'port' structs, so care must be taken when dealing with it. */
 199 static struct ofbundle ofpp_none_bundle = {
 200     .name      = "OFPP_NONE",
 201     .vlan_mode = PORT_VLAN_TRUNK
 202 };
 203
 204 static void stp_run(struct ofproto_dpif *ofproto);
 205 static void stp_wait(struct ofproto_dpif *ofproto);
 206 static int set_stp_port(struct ofport *,
 207                         const struct ofproto_port_stp_settings *);
 208
 209 static bool ofbundle_includes_vlan(const struct ofbundle *, uint16_t vlan);
 210
 211 struct action_xlate_ctx {
 212 /* action_xlate_ctx_init() initializes these members. */
 213
 214     /* The ofproto. */
 215     struct ofproto_dpif *ofproto;
 216
 217     /* Flow to which the OpenFlow actions apply.  xlate_actions() will modify
 218      * this flow when actions change header fields. */
 219     struct flow flow;
 220
 221     /* stack for the push and pop actions.
 222      * Each stack element is of the type "union mf_subvalue". */
 223     struct ofpbuf stack;
 224     union mf_subvalue init_stack[1024 / sizeof(union mf_subvalue)];
 225
 226     /* The packet corresponding to 'flow', or a null pointer if we are
 227      * revalidating without a packet to refer to. */
 228     const struct ofpbuf *packet;
 229
 230     /* Should OFPP_NORMAL update the MAC learning table?  Should "learn"
 231      * actions update the flow table?
 232      *
 233      * We want to update these tables if we are actually processing a packet,
 234      * or if we are accounting for packets that the datapath has processed, but
 235      * not if we are just revalidating. */
 236     bool may_learn;
 237
 238     /* The rule that we are currently translating, or NULL. */
 239     struct rule_dpif *rule;
 240
 241     /* Union of the set of TCP flags seen so far in this flow.  (Used only by
 242      * NXAST_FIN_TIMEOUT.  Set to zero to avoid updating updating rules'
 243      * timeouts.) */
 244     uint8_t tcp_flags;
 245
 246     /* If nonnull, flow translation calls this function just before executing a
 247      * resubmit or OFPP_TABLE action.  In addition, disables logging of traces
 248      * when the recursion depth is exceeded.
 249      *
 250      * 'rule' is the rule being submitted into.  It will be null if the
 251      * resubmit or OFPP_TABLE action didn't find a matching rule.
 252      *
 253      * This is normally null so the client has to set it manually after
 254      * calling action_xlate_ctx_init(). */
 255     void (*resubmit_hook)(struct action_xlate_ctx *, struct rule_dpif *rule);
 256
 257     /* If nonnull, flow translation calls this function to report some
 258      * significant decision, e.g. to explain why OFPP_NORMAL translation
 259      * dropped a packet. */
 260     void (*report_hook)(struct action_xlate_ctx *, const char *s);
 261
 262     /* If nonnull, flow translation credits the specified statistics to each
 263      * rule reached through a resubmit or OFPP_TABLE action.
 264      *
 265      * This is normally null so the client has to set it manually after
 266      * calling action_xlate_ctx_init(). */
 267     const struct dpif_flow_stats *resubmit_stats;
 268
 269 /* xlate_actions() initializes and uses these members.  The client might want
 270  * to look at them after it returns. */
 271
 272     struct ofpbuf *odp_actions; /* Datapath actions. */
 273     tag_type tags;              /* Tags associated with actions. */
 274     enum slow_path_reason slow; /* 0 if fast path may be used. */
 275     bool has_learn;             /* Actions include NXAST_LEARN? */
 276     bool has_normal;            /* Actions output to OFPP_NORMAL? */
 277     bool has_fin_timeout;       /* Actions include NXAST_FIN_TIMEOUT? */
 278     uint16_t nf_output_iface;   /* Output interface index for NetFlow. */
 279     mirror_mask_t mirrors;      /* Bitmap of associated mirrors. */
 280
 281 /* xlate_actions() initializes and uses these members, but the client has no
 282  * reason to look at them. */
 283
 284     int recurse;                /* Recursion level, via xlate_table_action. */
 285     bool max_resubmit_trigger;  /* Recursed too deeply during translation. */
 286     struct flow base_flow;      /* Flow at the last commit. */
 287     uint32_t orig_skb_priority; /* Priority when packet arrived. */
 288     uint8_t table_id;           /* OpenFlow table ID where flow was found. */
 289     uint32_t sflow_n_outputs;   /* Number of output ports. */
 290     uint32_t sflow_odp_port;    /* Output port for composing sFlow action. */
 291     uint16_t user_cookie_offset;/* Used for user_action_cookie fixup. */
 292     bool exit;                  /* No further actions should be processed. */
 293 };
 294
 295 /* Initial values of fields of the packet that may be changed during
 296  * flow processing and needed later. */
 297 struct initial_vals {
 298    /* This is the value of vlan_tci in the packet as actually received from
 299     * dpif.  This is the same as the facet's flow.vlan_tci unless the packet
 300     * was received via a VLAN splinter.  In that case, this value is 0
 301     * (because the packet as actually received from the dpif had no 802.1Q
 302     * tag) but the facet's flow.vlan_tci is set to the VLAN that the splinter
 303     * represents.
 304     *
 305     * This member should be removed when the VLAN splinters feature is no
 306     * longer needed. */
 307     ovs_be16 vlan_tci;
 308 };
 309
 310 static void action_xlate_ctx_init(struct action_xlate_ctx *,
 311                                   struct ofproto_dpif *, const struct flow *,
 312                                   const struct initial_vals *initial_vals,
 313                                   struct rule_dpif *,
 314                                   uint8_t tcp_flags, const struct ofpbuf *);
 315 static void xlate_actions(struct action_xlate_ctx *,
 316                           const struct ofpact *ofpacts, size_t ofpacts_len,
 317                           struct ofpbuf *odp_actions);
 318 static void xlate_actions_for_side_effects(struct action_xlate_ctx *,
 319                                            const struct ofpact *ofpacts,
 320                                            size_t ofpacts_len);
 321 static void xlate_table_action(struct action_xlate_ctx *, uint16_t in_port,
 322                                uint8_t table_id, bool may_packet_in);
 323
 324 static size_t put_userspace_action(const struct ofproto_dpif *,
 325                                    struct ofpbuf *odp_actions,
 326                                    const struct flow *,
 327                                    const union user_action_cookie *,
 328                                    const size_t);
 329
 330 static void compose_slow_path(const struct ofproto_dpif *, const struct flow *,
 331                               enum slow_path_reason,
 332                               uint64_t *stub, size_t stub_size,
 333                               const struct nlattr **actionsp,
 334                               size_t *actions_lenp);
 335
 336 static void xlate_report(struct action_xlate_ctx *ctx, const char *s);
 337
 338 /* A subfacet (see "struct subfacet" below) has three possible installation
 339  * states:
 340  *
 341  *   - SF_NOT_INSTALLED: Not installed in the datapath.  This will only be the
 342  *     case just after the subfacet is created, just before the subfacet is
 343  *     destroyed, or if the datapath returns an error when we try to install a
 344  *     subfacet.
 345  *
 346  *   - SF_FAST_PATH: The subfacet's actions are installed in the datapath.
 347  *
 348  *   - SF_SLOW_PATH: An action that sends every packet for the subfacet through
 349  *     ofproto_dpif is installed in the datapath.
 350  */
 351 enum subfacet_path {
 352     SF_NOT_INSTALLED,           /* No datapath flow for this subfacet. */
 353     SF_FAST_PATH,               /* Full actions are installed. */
 354     SF_SLOW_PATH,               /* Send-to-userspace action is installed. */
 355 };
 356
 357 static const char *subfacet_path_to_string(enum subfacet_path);
 358
 359 /* A dpif flow and actions associated with a facet.
 360  *
 361  * See also the large comment on struct facet. */
 362 struct subfacet {
 363     /* Owners. */
 364     struct hmap_node hmap_node; /* In struct ofproto_dpif 'subfacets' list. */
 365     struct list list_node;      /* In struct facet's 'facets' list. */
 366     struct facet *facet;        /* Owning facet. */
 367
 368     enum odp_key_fitness key_fitness;
 369     struct nlattr *key;
 370     int key_len;
 371
 372     long long int used;         /* Time last used; time created if not used. */
 373     long long int created;      /* Time created. */
 374
 375     uint64_t dp_packet_count;   /* Last known packet count in the datapath. */
 376     uint64_t dp_byte_count;     /* Last known byte count in the datapath. */
 377
 378     /* Datapath actions.
 379      *
 380      * These should be essentially identical for every subfacet in a facet, but
 381      * may differ in trivial ways due to VLAN splinters. */
 382     size_t actions_len;         /* Number of bytes in actions[]. */
 383     struct nlattr *actions;     /* Datapath actions. */
 384
 385     enum slow_path_reason slow; /* 0 if fast path may be used. */
 386     enum subfacet_path path;    /* Installed in datapath? */
 387
 388     /* Initial values of the packet that may be needed later. */
 389     struct initial_vals initial_vals;
 390
 391     /* Datapath port the packet arrived on.  This is needed to remove
 392      * flows for ports that are no longer part of the bridge.  Since the
 393      * flow definition only has the OpenFlow port number and the port is
 394      * no longer part of the bridge, we can't determine the datapath port
 395      * number needed to delete the flow from the datapath. */
 396     uint32_t odp_in_port;
 397 };
 398
 399 #define SUBFACET_DESTROY_MAX_BATCH 50
 400
 401 static struct subfacet *subfacet_create(struct facet *, struct flow_miss *miss,
 402                                         long long int now);
 403 static struct subfacet *subfacet_find(struct ofproto_dpif *,
 404                                       const struct nlattr *key, size_t key_len,
 405                                       uint32_t key_hash);
 406 static void subfacet_destroy(struct subfacet *);
 407 static void subfacet_destroy__(struct subfacet *);
 408 static void subfacet_destroy_batch(struct ofproto_dpif *,
 409                                    struct subfacet **, int n);
 410 static void subfacet_reset_dp_stats(struct subfacet *,
 411                                     struct dpif_flow_stats *);
 412 static void subfacet_update_time(struct subfacet *, long long int used);
 413 static void subfacet_update_stats(struct subfacet *,
 414                                   const struct dpif_flow_stats *);
 415 static void subfacet_make_actions(struct subfacet *,
 416                                   const struct ofpbuf *packet,
 417                                   struct ofpbuf *odp_actions);
 418 static int subfacet_install(struct subfacet *,
 419                             const struct nlattr *actions, size_t actions_len,
 420                             struct dpif_flow_stats *, enum slow_path_reason);
 421 static void subfacet_uninstall(struct subfacet *);
 422
 423 static enum subfacet_path subfacet_want_path(enum slow_path_reason);
 424
 425 /* An exact-match instantiation of an OpenFlow flow.
 426  *
 427  * A facet associates a "struct flow", which represents the Open vSwitch
 428  * userspace idea of an exact-match flow, with one or more subfacets.  Each
 429  * subfacet tracks the datapath's idea of the exact-match flow equivalent to
 430  * the facet.  When the kernel module (or other dpif implementation) and Open
 431  * vSwitch userspace agree on the definition of a flow key, there is exactly
 432  * one subfacet per facet.  If the dpif implementation supports more-specific
 433  * flow matching than userspace, however, a facet can have more than one
 434  * subfacet, each of which corresponds to some distinction in flow that
 435  * userspace simply doesn't understand.
 436  *
 437  * Flow expiration works in terms of subfacets, so a facet must have at least
 438  * one subfacet or it will never expire, leaking memory. */
 439 struct facet {
 440     /* Owners. */
 441     struct hmap_node hmap_node;  /* In owning ofproto's 'facets' hmap. */
 442     struct list list_node;       /* In owning rule's 'facets' list. */
 443     struct rule_dpif *rule;      /* Owning rule. */
 444
 445     /* Owned data. */
 446     struct list subfacets;
 447     long long int used;         /* Time last used; time created if not used. */
 448
 449     /* Key. */
 450     struct flow flow;
 451
 452     /* These statistics:
 453      *
 454      *   - Do include packets and bytes sent "by hand", e.g. with
 455      *     dpif_execute().
 456      *
 457      *   - Do include packets and bytes that were obtained from the datapath
 458      *     when a subfacet's statistics were reset (e.g. dpif_flow_put() with
 459      *     DPIF_FP_ZERO_STATS).
 460      *
 461      *   - Do not include packets or bytes that can be obtained from the
 462      *     datapath for any existing subfacet.
 463      */
 464     uint64_t packet_count;       /* Number of packets received. */
 465     uint64_t byte_count;         /* Number of bytes received. */
 466
 467     /* Resubmit statistics. */
 468     uint64_t prev_packet_count;  /* Number of packets from last stats push. */
 469     uint64_t prev_byte_count;    /* Number of bytes from last stats push. */
 470     long long int prev_used;     /* Used time from last stats push. */
 471
 472     /* Accounting. */
 473     uint64_t accounted_bytes;    /* Bytes processed by facet_account(). */
 474     struct netflow_flow nf_flow; /* Per-flow NetFlow tracking data. */
 475     uint8_t tcp_flags;           /* TCP flags seen for this 'rule'. */
 476
 477     /* Properties of datapath actions.
 478      *
 479      * Every subfacet has its own actions because actions can differ slightly
 480      * between splintered and non-splintered subfacets due to the VLAN tag
 481      * being initially different (present vs. absent).  All of them have these
 482      * properties in common so we just store one copy of them here. */
 483     bool has_learn;              /* Actions include NXAST_LEARN? */
 484     bool has_normal;             /* Actions output to OFPP_NORMAL? */
 485     bool has_fin_timeout;        /* Actions include NXAST_FIN_TIMEOUT? */
 486     tag_type tags;               /* Tags that would require revalidation. */
 487     mirror_mask_t mirrors;       /* Bitmap of dependent mirrors. */
 488
 489     /* Storage for a single subfacet, to reduce malloc() time and space
 490      * overhead.  (A facet always has at least one subfacet and in the common
 491      * case has exactly one subfacet.  However, 'one_subfacet' may not
 492      * always be valid, since it could have been removed after newer
 493      * subfacets were pushed onto the 'subfacets' list.) */
 494     struct subfacet one_subfacet;
 495
 496     long long int learn_rl;      /* Rate limiter for facet_learn(). */
 497 };
 498
 499 static struct facet *facet_create(struct rule_dpif *,
 500                                   const struct flow *, uint32_t hash);
 501 static void facet_remove(struct facet *);
 502 static void facet_free(struct facet *);
 503
 504 static struct facet *facet_find(struct ofproto_dpif *,
 505                                 const struct flow *, uint32_t hash);
 506 static struct facet *facet_lookup_valid(struct ofproto_dpif *,
 507                                         const struct flow *, uint32_t hash);
 508 static void facet_revalidate(struct facet *);
 509 static bool facet_check_consistency(struct facet *);
 510
 511 static void facet_flush_stats(struct facet *);
 512
 513 static void facet_update_time(struct facet *, long long int used);
 514 static void facet_reset_counters(struct facet *);
 515 static void facet_push_stats(struct facet *);
 516 static void facet_learn(struct facet *);
 517 static void facet_account(struct facet *);
 518 static void push_all_stats(void);
 519
 520 static struct subfacet *facet_get_subfacet(struct facet *);
 521
 522 static bool facet_is_controller_flow(struct facet *);
 523
 524 struct ofport_dpif {
 525     struct hmap_node odp_port_node; /* In dpif_backer's "odp_to_ofport_map". */
 526     struct ofport up;
 527
 528     uint32_t odp_port;
 529     struct ofbundle *bundle;    /* Bundle that contains this port, if any. */
 530     struct list bundle_node;    /* In struct ofbundle's "ports" list. */
 531     struct cfm *cfm;            /* Connectivity Fault Management, if any. */
 532     struct bfd *bfd;            /* BFD, if any. */
 533     tag_type tag;               /* Tag associated with this port. */
 534     bool may_enable;            /* May be enabled in bonds. */
 535     long long int carrier_seq;  /* Carrier status changes. */
 536     struct tnl_port *tnl_port;  /* Tunnel handle, or null. */
 537
 538     /* Spanning tree. */
 539     struct stp_port *stp_port;  /* Spanning Tree Protocol, if any. */
 540     enum stp_state stp_state;   /* Always STP_DISABLED if STP not in use. */
 541     long long int stp_state_entered;
 542
 543     struct hmap priorities;     /* Map of attached 'priority_to_dscp's. */
 544
 545     /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
 546      *
 547      * This is deprecated.  It is only for compatibility with broken device
 548      * drivers in old versions of Linux that do not properly support VLANs when
 549      * VLAN devices are not used.  When broken device drivers are no longer in
 550      * widespread use, we will delete these interfaces. */
 551     uint16_t realdev_ofp_port;
 552     int vlandev_vid;
 553 };
 554
 555 /* Node in 'ofport_dpif''s 'priorities' map.  Used to maintain a map from
 556  * 'priority' (the datapath's term for QoS queue) to the dscp bits which all
 557  * traffic egressing the 'ofport' with that priority should be marked with. */
 558 struct priority_to_dscp {
 559     struct hmap_node hmap_node; /* Node in 'ofport_dpif''s 'priorities' map. */
 560     uint32_t priority;          /* Priority of this queue (see struct flow). */
 561
 562     uint8_t dscp;               /* DSCP bits to mark outgoing traffic with. */
 563 };
 564
 565 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
 566  *
 567  * This is deprecated.  It is only for compatibility with broken device drivers
 568  * in old versions of Linux that do not properly support VLANs when VLAN
 569  * devices are not used.  When broken device drivers are no longer in
 570  * widespread use, we will delete these interfaces. */
 571 struct vlan_splinter {
 572     struct hmap_node realdev_vid_node;
 573     struct hmap_node vlandev_node;
 574     uint16_t realdev_ofp_port;
 575     uint16_t vlandev_ofp_port;
 576     int vid;
 577 };
 578
 579 static uint32_t vsp_realdev_to_vlandev(const struct ofproto_dpif *,
 580                                        uint32_t realdev, ovs_be16 vlan_tci);
 581 static bool vsp_adjust_flow(const struct ofproto_dpif *, struct flow *);
 582 static void vsp_remove(struct ofport_dpif *);
 583 static void vsp_add(struct ofport_dpif *, uint16_t realdev_ofp_port, int vid);
 584
 585 static uint32_t ofp_port_to_odp_port(const struct ofproto_dpif *,
 586                                      uint16_t ofp_port);
 587 static uint16_t odp_port_to_ofp_port(const struct ofproto_dpif *,
 588                                      uint32_t odp_port);
 589
 590 static struct ofport_dpif *
 591 ofport_dpif_cast(const struct ofport *ofport)
 592 {
 593     ovs_assert(ofport->ofproto->ofproto_class == &ofproto_dpif_class);
 594     return ofport ? CONTAINER_OF(ofport, struct ofport_dpif, up) : NULL;
 595 }
 596
 597 static void port_run(struct ofport_dpif *);
 598 static void port_run_fast(struct ofport_dpif *);
 599 static void port_wait(struct ofport_dpif *);
 600 static int set_cfm(struct ofport *, const struct cfm_settings *);
 601 static void ofport_clear_priorities(struct ofport_dpif *);
 602 static void run_fast_rl(void);
 603
 604 struct dpif_completion {
 605     struct list list_node;
 606     struct ofoperation *op;
 607 };
 608
 609 /* Extra information about a classifier table.
 610  * Currently used just for optimized flow revalidation. */
 611 struct table_dpif {
 612     /* If either of these is nonnull, then this table has a form that allows
 613      * flows to be tagged to avoid revalidating most flows for the most common
 614      * kinds of flow table changes. */
 615     struct cls_table *catchall_table; /* Table that wildcards all fields. */
 616     struct cls_table *other_table;    /* Table with any other wildcard set. */
 617     uint32_t basis;                   /* Keeps each table's tags separate. */
 618 };
 619
 620 /* Reasons that we might need to revalidate every facet, and corresponding
 621  * coverage counters.
 622  *
 623  * A value of 0 means that there is no need to revalidate.
 624  *
 625  * It would be nice to have some cleaner way to integrate with coverage
 626  * counters, but with only a few reasons I guess this is good enough for
 627  * now. */
 628 enum revalidate_reason {
 629     REV_RECONFIGURE = 1,       /* Switch configuration changed. */
 630     REV_STP,                   /* Spanning tree protocol port status change. */
 631     REV_PORT_TOGGLED,          /* Port enabled or disabled by CFM, LACP, ...*/
 632     REV_FLOW_TABLE,            /* Flow table changed. */
 633     REV_INCONSISTENCY          /* Facet self-check failed. */
 634 };
 635 COVERAGE_DEFINE(rev_reconfigure);
 636 COVERAGE_DEFINE(rev_stp);
 637 COVERAGE_DEFINE(rev_port_toggled);
 638 COVERAGE_DEFINE(rev_flow_table);
 639 COVERAGE_DEFINE(rev_inconsistency);
 640
 641 /* Drop keys are odp flow keys which have drop flows installed in the kernel.
 642  * These are datapath flows which have no associated ofproto, if they did we
 643  * would use facets. */
 644 struct drop_key {
 645     struct hmap_node hmap_node;
 646     struct nlattr *key;
 647     size_t key_len;
 648 };
 649
 650 /* All datapaths of a given type share a single dpif backer instance. */
 651 struct dpif_backer {
 652     char *type;
 653     int refcount;
 654     struct dpif *dpif;
 655     struct timer next_expiration;
 656     struct hmap odp_to_ofport_map; /* ODP port to ofport mapping. */
 657
 658     struct simap tnl_backers;      /* Set of dpif ports backing tunnels. */
 659
 660     /* Facet revalidation flags applying to facets which use this backer. */
 661     enum revalidate_reason need_revalidate; /* Revalidate every facet. */
 662     struct tag_set revalidate_set; /* Revalidate only matching facets. */
 663
 664     struct hmap drop_keys; /* Set of dropped odp keys. */
 665 };
 666
 667 /* All existing ofproto_backer instances, indexed by ofproto->up.type. */
 668 static struct shash all_dpif_backers = SHASH_INITIALIZER(&all_dpif_backers);
 669
 670 static void drop_key_clear(struct dpif_backer *);
 671 static struct ofport_dpif *
 672 odp_port_to_ofport(const struct dpif_backer *, uint32_t odp_port);
 673
 674 static void dpif_stats_update_hit_count(struct ofproto_dpif *ofproto,
 675                                         uint64_t delta);
 676 struct avg_subfacet_rates {
 677     double add_rate;     /* Moving average of new flows created per minute. */
 678     double del_rate;     /* Moving average of flows deleted per minute. */
 679 };
 680 static void show_dp_rates(struct ds *ds, const char *heading,
 681                           const struct avg_subfacet_rates *rates);
 682 static void exp_mavg(double *avg, int base, double new);
 683
 684 struct ofproto_dpif {
 685     struct hmap_node all_ofproto_dpifs_node; /* In 'all_ofproto_dpifs'. */
 686     struct ofproto up;
 687     struct dpif_backer *backer;
 688
 689     /* Special OpenFlow rules. */
 690     struct rule_dpif *miss_rule; /* Sends flow table misses to controller. */
 691     struct rule_dpif *no_packet_in_rule; /* Drops flow table misses. */
 692
 693     /* Statistics. */
 694     uint64_t n_matches;
 695
 696     /* Bridging. */
 697     struct netflow *netflow;
 698     struct dpif_sflow *sflow;
 699     struct dpif_ipfix *ipfix;
 700     struct hmap bundles;        /* Contains "struct ofbundle"s. */
 701     struct mac_learning *ml;
 702     struct ofmirror *mirrors[MAX_MIRRORS];
 703     bool has_mirrors;
 704     bool has_bonded_bundles;
 705
 706     /* Facets. */
 707     struct hmap facets;
 708     struct hmap subfacets;
 709     struct governor *governor;
 710     long long int consistency_rl;
 711
 712     /* Revalidation. */
 713     struct table_dpif tables[N_TABLES];
 714
 715     /* Support for debugging async flow mods. */
 716     struct list completions;
 717
 718     bool has_bundle_action; /* True when the first bundle action appears. */
 719     struct netdev_stats stats; /* To account packets generated and consumed in
 720                                 * userspace. */
 721
 722     /* Spanning tree. */
 723     struct stp *stp;
 724     long long int stp_last_tick;
 725
 726     /* VLAN splinters. */
 727     struct hmap realdev_vid_map; /* (realdev,vid) -> vlandev. */
 728     struct hmap vlandev_map;     /* vlandev -> (realdev,vid). */
 729
 730     /* Ports. */
 731     struct sset ports;             /* Set of standard port names. */
 732     struct sset ghost_ports;       /* Ports with no datapath port. */
 733     struct sset port_poll_set;     /* Queued names for port_poll() reply. */
 734     int port_poll_errno;           /* Last errno for port_poll() reply. */
 735
 736     /* Per ofproto's dpif stats. */
 737     uint64_t n_hit;
 738     uint64_t n_missed;
 739
 740     /* Subfacet statistics.
 741      *
 742      * These keep track of the total number of subfacets added and deleted and
 743      * flow life span.  They are useful for computing the flow rates stats
 744      * exposed via "ovs-appctl dpif/show".  The goal is to learn about
 745      * traffic patterns in ways that we can use later to improve Open vSwitch
 746      * performance in new situations.  */
 747     long long int created;         /* Time when it is created. */
 748     unsigned int max_n_subfacet;   /* Maximum number of flows */
 749
 750     /* The average number of subfacets... */
 751     struct avg_subfacet_rates hourly; /* ...over the last hour. */
 752     struct avg_subfacet_rates daily;  /* ...over the last day. */
 753     long long int last_minute;        /* Last time 'hourly' was updated. */
 754
 755     /* Number of subfacets added or deleted since 'last_minute'. */
 756     unsigned int subfacet_add_count;
 757     unsigned int subfacet_del_count;
 758
 759     /* Number of subfacets added or deleted from 'created' to 'last_minute.' */
 760     unsigned long long int total_subfacet_add_count;
 761     unsigned long long int total_subfacet_del_count;
 762
 763     /* Sum of the number of milliseconds that each subfacet existed,
 764      * over the subfacets that have been added and then later deleted. */
 765     unsigned long long int total_subfacet_life_span;
 766
 767     /* Incremented by the number of currently existing subfacets, each
 768      * time we pull statistics from the kernel. */
 769     unsigned long long int total_subfacet_count;
 770
 771     /* Number of times we pull statistics from the kernel. */
 772     unsigned long long int n_update_stats;
 773 };
 774 static unsigned long long int avg_subfacet_life_span(
 775                                         const struct ofproto_dpif *);
 776 static double avg_subfacet_count(const struct ofproto_dpif *ofproto);
 777 static void update_moving_averages(struct ofproto_dpif *ofproto);
 778 static void dpif_stats_update_hit_count(struct ofproto_dpif *ofproto,
 779                                         uint64_t delta);
 780 static void update_max_subfacet_count(struct ofproto_dpif *ofproto);
 781
 782 /* Defer flow mod completion until "ovs-appctl ofproto/unclog"?  (Useful only
 783  * for debugging the asynchronous flow_mod implementation.) */
 784 static bool clogged;
 785
 786 /* All existing ofproto_dpif instances, indexed by ->up.name. */
 787 static struct hmap all_ofproto_dpifs = HMAP_INITIALIZER(&all_ofproto_dpifs);
 788
 789 static void ofproto_dpif_unixctl_init(void);
 790
 791 static struct ofproto_dpif *
 792 ofproto_dpif_cast(const struct ofproto *ofproto)
 793 {
 794     ovs_assert(ofproto->ofproto_class == &ofproto_dpif_class);
 795     return CONTAINER_OF(ofproto, struct ofproto_dpif, up);
 796 }
 797
 798 static struct ofport_dpif *get_ofp_port(const struct ofproto_dpif *,
 799                                         uint16_t ofp_port);
 800 static struct ofport_dpif *get_odp_port(const struct ofproto_dpif *,
 801                                         uint32_t odp_port);
 802 static void ofproto_trace(struct ofproto_dpif *, const struct flow *,
 803                           const struct ofpbuf *,
 804                           const struct initial_vals *, struct ds *);
 805
 806 /* Packet processing. */
 807 static void update_learning_table(struct ofproto_dpif *,
 808                                   const struct flow *, int vlan,
 809                                   struct ofbundle *);
 810 /* Upcalls. */
 811 #define FLOW_MISS_MAX_BATCH 50
 812 static int handle_upcalls(struct dpif_backer *, unsigned int max_batch);
 813
 814 /* Flow expiration. */
 815 static int expire(struct dpif_backer *);
 816
 817 /* NetFlow. */
 818 static void send_netflow_active_timeouts(struct ofproto_dpif *);
 819
 820 /* Utilities. */
 821 static int send_packet(const struct ofport_dpif *, struct ofpbuf *packet);
 822 static size_t compose_sflow_action(const struct ofproto_dpif *,
 823                                    struct ofpbuf *odp_actions,
 824                                    const struct flow *, uint32_t odp_port);
 825 static void compose_ipfix_action(const struct ofproto_dpif *,
 826                                  struct ofpbuf *odp_actions,
 827                                  const struct flow *);
 828 static void add_mirror_actions(struct action_xlate_ctx *ctx,
 829                                const struct flow *flow);
 830 /* Global variables. */
 831 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
 832
 833 /* Initial mappings of port to bridge mappings. */
 834 static struct shash init_ofp_ports = SHASH_INITIALIZER(&init_ofp_ports);
 835 \f
 836 /* Factory functions. */
 837
 838 static void
 839 init(const struct shash *iface_hints)
 840 {
 841     struct shash_node *node;
 842
 843     /* Make a local copy, since we don't own 'iface_hints' elements. */
 844     SHASH_FOR_EACH(node, iface_hints) {
 845         const struct iface_hint *orig_hint = node->data;
 846         struct iface_hint *new_hint = xmalloc(sizeof *new_hint);
 847
 848         new_hint->br_name = xstrdup(orig_hint->br_name);
 849         new_hint->br_type = xstrdup(orig_hint->br_type);
 850         new_hint->ofp_port = orig_hint->ofp_port;
 851
 852         shash_add(&init_ofp_ports, node->name, new_hint);
 853     }
 854 }
 855
 856 static void
 857 enumerate_types(struct sset *types)
 858 {
 859     dp_enumerate_types(types);
 860 }
 861
 862 static int
 863 enumerate_names(const char *type, struct sset *names)
 864 {
 865     struct ofproto_dpif *ofproto;
 866
 867     sset_clear(names);
 868     HMAP_FOR_EACH (ofproto, all_ofproto_dpifs_node, &all_ofproto_dpifs) {
 869         if (strcmp(type, ofproto->up.type)) {
 870             continue;
 871         }
 872         sset_add(names, ofproto->up.name);
 873     }
 874
 875     return 0;
 876 }
 877
 878 static int
 879 del(const char *type, const char *name)
 880 {
 881     struct dpif *dpif;
 882     int error;
 883
 884     error = dpif_open(name, type, &dpif);
 885     if (!error) {
 886         error = dpif_delete(dpif);
 887         dpif_close(dpif);
 888     }
 889     return error;
 890 }
 891 \f
 892 static const char *
 893 port_open_type(const char *datapath_type, const char *port_type)
 894 {
 895     return dpif_port_open_type(datapath_type, port_type);
 896 }
 897
 898 /* Type functions. */
 899
 900 static struct ofproto_dpif *
 901 lookup_ofproto_dpif_by_port_name(const char *name)
 902 {
 903     struct ofproto_dpif *ofproto;
 904
 905     HMAP_FOR_EACH (ofproto, all_ofproto_dpifs_node, &all_ofproto_dpifs) {
 906         if (sset_contains(&ofproto->ports, name)) {
 907             return ofproto;
 908         }
 909     }
 910
 911     return NULL;
 912 }
 913
 914 static int
 915 type_run(const char *type)
 916 {
 917     static long long int push_timer = LLONG_MIN;
 918     struct dpif_backer *backer;
 919     char *devname;
 920     int error;
 921
 922     backer = shash_find_data(&all_dpif_backers, type);
 923     if (!backer) {
 924         /* This is not necessarily a problem, since backers are only
 925          * created on demand. */
 926         return 0;
 927     }
 928
 929     dpif_run(backer->dpif);
 930
 931     /* The most natural place to push facet statistics is when they're pulled
 932      * from the datapath.  However, when there are many flows in the datapath,
 933      * this expensive operation can occur so frequently, that it reduces our
 934      * ability to quickly set up flows.  To reduce the cost, we push statistics
 935      * here instead. */
 936     if (time_msec() > push_timer) {
 937         push_timer = time_msec() + 2000;
 938         push_all_stats();
 939     }
 940
 941     if (backer->need_revalidate
 942         || !tag_set_is_empty(&backer->revalidate_set)) {
 943         struct tag_set revalidate_set = backer->revalidate_set;
 944         bool need_revalidate = backer->need_revalidate;
 945         struct ofproto_dpif *ofproto;
 946         struct simap_node *node;
 947         struct simap tmp_backers;
 948
 949         /* Handle tunnel garbage collection. */
 950         simap_init(&tmp_backers);
 951         simap_swap(&backer->tnl_backers, &tmp_backers);
 952
 953         HMAP_FOR_EACH (ofproto, all_ofproto_dpifs_node, &all_ofproto_dpifs) {
 954             struct ofport_dpif *iter;
 955
 956             if (backer != ofproto->backer) {
 957                 continue;
 958             }
 959
 960             HMAP_FOR_EACH (iter, up.hmap_node, &ofproto->up.ports) {
 961                 const char *dp_port;
 962
 963                 if (!iter->tnl_port) {
 964                     continue;
 965                 }
 966
 967                 dp_port = netdev_vport_get_dpif_port(iter->up.netdev);
 968                 node = simap_find(&tmp_backers, dp_port);
 969                 if (node) {
 970                     simap_put(&backer->tnl_backers, dp_port, node->data);
 971                     simap_delete(&tmp_backers, node);
 972                     node = simap_find(&backer->tnl_backers, dp_port);
 973                 } else {
 974                     node = simap_find(&backer->tnl_backers, dp_port);
 975                     if (!node) {
 976                         uint32_t odp_port = UINT32_MAX;
 977
 978                         if (!dpif_port_add(backer->dpif, iter->up.netdev,
 979                                            &odp_port)) {
 980                             simap_put(&backer->tnl_backers, dp_port, odp_port);
 981                             node = simap_find(&backer->tnl_backers, dp_port);
 982                         }
 983                     }
 984                 }
 985
 986                 iter->odp_port = node ? node->data : OVSP_NONE;
 987                 if (tnl_port_reconfigure(&iter->up, iter->odp_port,
 988                                          &iter->tnl_port)) {
 989                     backer->need_revalidate = REV_RECONFIGURE;
 990                 }
 991             }
 992         }
 993
 994         SIMAP_FOR_EACH (node, &tmp_backers) {
 995             dpif_port_del(backer->dpif, node->data);
 996         }
 997         simap_destroy(&tmp_backers);
 998
 999         switch (backer->need_revalidate) {
1000         case REV_RECONFIGURE:   COVERAGE_INC(rev_reconfigure);   break;
1001         case REV_STP:           COVERAGE_INC(rev_stp);           break;
1002         case REV_PORT_TOGGLED:  COVERAGE_INC(rev_port_toggled);  break;
1003         case REV_FLOW_TABLE:    COVERAGE_INC(rev_flow_table);    break;
1004         case REV_INCONSISTENCY: COVERAGE_INC(rev_inconsistency); break;
1005         }
1006
1007         if (backer->need_revalidate) {
1008             /* Clear the drop_keys in case we should now be accepting some
1009              * formerly dropped flows. */
1010             drop_key_clear(backer);
1011         }
1012
1013         /* Clear the revalidation flags. */
1014         tag_set_init(&backer->revalidate_set);
1015         backer->need_revalidate = 0;
1016
1017         HMAP_FOR_EACH (ofproto, all_ofproto_dpifs_node, &all_ofproto_dpifs) {
1018             struct facet *facet, *next;
1019
1020             if (ofproto->backer != backer) {
1021                 continue;
1022             }
1023
1024             HMAP_FOR_EACH_SAFE (facet, next, hmap_node, &ofproto->facets) {
1025                 if (need_revalidate
1026                     || tag_set_intersects(&revalidate_set, facet->tags)) {
1027                     facet_revalidate(facet);
1028                     run_fast_rl();
1029                 }
1030             }
1031         }
1032     }
1033
1034     if (timer_expired(&backer->next_expiration)) {
1035         int delay = expire(backer);
1036         timer_set_duration(&backer->next_expiration, delay);
1037     }
1038
1039     /* Check for port changes in the dpif. */
1040     while ((error = dpif_port_poll(backer->dpif, &devname)) == 0) {
1041         struct ofproto_dpif *ofproto;
1042         struct dpif_port port;
1043
1044         /* Don't report on the datapath's device. */
1045         if (!strcmp(devname, dpif_base_name(backer->dpif))) {
1046             goto next;
1047         }
1048
1049         HMAP_FOR_EACH (ofproto, all_ofproto_dpifs_node,
1050                        &all_ofproto_dpifs) {
1051             if (simap_contains(&ofproto->backer->tnl_backers, devname)) {
1052                 goto next;
1053             }
1054         }
1055
1056         ofproto = lookup_ofproto_dpif_by_port_name(devname);
1057         if (dpif_port_query_by_name(backer->dpif, devname, &port)) {
1058             /* The port was removed.  If we know the datapath,
1059              * report it through poll_set().  If we don't, it may be
1060              * notifying us of a removal we initiated, so ignore it.
1061              * If there's a pending ENOBUFS, let it stand, since
1062              * everything will be reevaluated. */
1063             if (ofproto && ofproto->port_poll_errno != ENOBUFS) {
1064                 sset_add(&ofproto->port_poll_set, devname);
1065                 ofproto->port_poll_errno = 0;
1066             }
1067         } else if (!ofproto) {
1068             /* The port was added, but we don't know with which
1069              * ofproto we should associate it.  Delete it. */
1070             dpif_port_del(backer->dpif, port.port_no);
1071         }
1072         dpif_port_destroy(&port);
1073
1074     next:
1075         free(devname);
1076     }
1077
1078     if (error != EAGAIN) {
1079         struct ofproto_dpif *ofproto;
1080
1081         /* There was some sort of error, so propagate it to all
1082          * ofprotos that use this backer. */
1083         HMAP_FOR_EACH (ofproto, all_ofproto_dpifs_node,
1084                        &all_ofproto_dpifs) {
1085             if (ofproto->backer == backer) {
1086                 sset_clear(&ofproto->port_poll_set);
1087                 ofproto->port_poll_errno = error;
1088             }
1089         }
1090     }
1091
1092     return 0;
1093 }
1094
1095 static int
1096 dpif_backer_run_fast(struct dpif_backer *backer, int max_batch)
1097 {
1098     unsigned int work;
1099
1100     /* Handle one or more batches of upcalls, until there's nothing left to do
1101      * or until we do a fixed total amount of work.
1102      *
1103      * We do work in batches because it can be much cheaper to set up a number
1104      * of flows and fire off their patches all at once.  We do multiple batches
1105      * because in some cases handling a packet can cause another packet to be
1106      * queued almost immediately as part of the return flow.  Both
1107      * optimizations can make major improvements on some benchmarks and
1108      * presumably for real traffic as well. */
1109     work = 0;
1110     while (work < max_batch) {
1111         int retval = handle_upcalls(backer, max_batch - work);
1112         if (retval <= 0) {
1113             return -retval;
1114         }
1115         work += retval;
1116     }
1117
1118     return 0;
1119 }
1120
1121 static int
1122 type_run_fast(const char *type)
1123 {
1124     struct dpif_backer *backer;
1125
1126     backer = shash_find_data(&all_dpif_backers, type);
1127     if (!backer) {
1128         /* This is not necessarily a problem, since backers are only
1129          * created on demand. */
1130         return 0;
1131     }
1132
1133     return dpif_backer_run_fast(backer, FLOW_MISS_MAX_BATCH);
1134 }
1135
1136 static void
1137 run_fast_rl(void)
1138 {
1139     static long long int port_rl = LLONG_MIN;
1140     static unsigned int backer_rl = 0;
1141
1142     if (time_msec() >= port_rl) {
1143         struct ofproto_dpif *ofproto;
1144         struct ofport_dpif *ofport;
1145
1146         HMAP_FOR_EACH (ofproto, all_ofproto_dpifs_node, &all_ofproto_dpifs) {
1147
1148             HMAP_FOR_EACH (ofport, up.hmap_node, &ofproto->up.ports) {
1149                 port_run_fast(ofport);
1150             }
1151         }
1152         port_rl = time_msec() + 200;
1153     }
1154
1155     /* XXX: We have to be careful not to do too much work in this function.  If
1156      * we call dpif_backer_run_fast() too often, or with too large a batch,
1157      * performance improves signifcantly, but at a cost.  It's possible for the
1158      * number of flows in the datapath to increase without bound, and for poll
1159      * loops to take 10s of seconds.   The correct solution to this problem,
1160      * long term, is to separate flow miss handling into it's own thread so it
1161      * isn't affected by revalidations, and expirations.  Until then, this is
1162      * the best we can do. */
1163     if (++backer_rl >= 10) {
1164         struct shash_node *node;
1165
1166         backer_rl = 0;
1167         SHASH_FOR_EACH (node, &all_dpif_backers) {
1168             dpif_backer_run_fast(node->data, 1);
1169         }
1170     }
1171 }
1172
1173 static void
1174 type_wait(const char *type)
1175 {
1176     struct dpif_backer *backer;
1177
1178     backer = shash_find_data(&all_dpif_backers, type);
1179     if (!backer) {
1180         /* This is not necessarily a problem, since backers are only
1181          * created on demand. */
1182         return;
1183     }
1184
1185     timer_wait(&backer->next_expiration);
1186 }
1187 \f
1188 /* Basic life-cycle. */
1189
1190 static int add_internal_flows(struct ofproto_dpif *);
1191
1192 static struct ofproto *
1193 alloc(void)
1194 {
1195     struct ofproto_dpif *ofproto = xmalloc(sizeof *ofproto);
1196     return &ofproto->up;
1197 }
1198
1199 static void
1200 dealloc(struct ofproto *ofproto_)
1201 {
1202     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
1203     free(ofproto);
1204 }
1205
1206 static void
1207 close_dpif_backer(struct dpif_backer *backer)
1208 {
1209     struct shash_node *node;
1210
1211     ovs_assert(backer->refcount > 0);
1212
1213     if (--backer->refcount) {
1214         return;
1215     }
1216
1217     drop_key_clear(backer);
1218     hmap_destroy(&backer->drop_keys);
1219
1220     simap_destroy(&backer->tnl_backers);
1221     hmap_destroy(&backer->odp_to_ofport_map);
1222     node = shash_find(&all_dpif_backers, backer->type);
1223     free(backer->type);
1224     shash_delete(&all_dpif_backers, node);
1225     dpif_close(backer->dpif);
1226
1227     free(backer);
1228 }
1229
1230 /* Datapath port slated for removal from datapath. */
1231 struct odp_garbage {
1232     struct list list_node;
1233     uint32_t odp_port;
1234 };
1235
1236 static int
1237 open_dpif_backer(const char *type, struct dpif_backer **backerp)
1238 {
1239     struct dpif_backer *backer;
1240     struct dpif_port_dump port_dump;
1241     struct dpif_port port;
1242     struct shash_node *node;
1243     struct list garbage_list;
1244     struct odp_garbage *garbage, *next;
1245     struct sset names;
1246     char *backer_name;
1247     const char *name;
1248     int error;
1249
1250     backer = shash_find_data(&all_dpif_backers, type);
1251     if (backer) {
1252         backer->refcount++;
1253         *backerp = backer;
1254         return 0;
1255     }
1256
1257     backer_name = xasprintf("ovs-%s", type);
1258
1259     /* Remove any existing datapaths, since we assume we're the only
1260      * userspace controlling the datapath. */
1261     sset_init(&names);
1262     dp_enumerate_names(type, &names);
1263     SSET_FOR_EACH(name, &names) {
1264         struct dpif *old_dpif;
1265
1266         /* Don't remove our backer if it exists. */
1267         if (!strcmp(name, backer_name)) {
1268             continue;
1269         }
1270
1271         if (dpif_open(name, type, &old_dpif)) {
1272             VLOG_WARN("couldn't open old datapath %s to remove it", name);
1273         } else {
1274             dpif_delete(old_dpif);
1275             dpif_close(old_dpif);
1276         }
1277     }
1278     sset_destroy(&names);
1279
1280     backer = xmalloc(sizeof *backer);
1281
1282     error = dpif_create_and_open(backer_name, type, &backer->dpif);
1283     free(backer_name);
1284     if (error) {
1285         VLOG_ERR("failed to open datapath of type %s: %s", type,
1286                  strerror(error));
1287         free(backer);
1288         return error;
1289     }
1290
1291     backer->type = xstrdup(type);
1292     backer->refcount = 1;
1293     hmap_init(&backer->odp_to_ofport_map);
1294     hmap_init(&backer->drop_keys);
1295     timer_set_duration(&backer->next_expiration, 1000);
1296     backer->need_revalidate = 0;
1297     simap_init(&backer->tnl_backers);
1298     tag_set_init(&backer->revalidate_set);
1299     *backerp = backer;
1300
1301     dpif_flow_flush(backer->dpif);
1302
1303     /* Loop through the ports already on the datapath and remove any
1304      * that we don't need anymore. */
1305     list_init(&garbage_list);
1306     dpif_port_dump_start(&port_dump, backer->dpif);
1307     while (dpif_port_dump_next(&port_dump, &port)) {
1308         node = shash_find(&init_ofp_ports, port.name);
1309         if (!node && strcmp(port.name, dpif_base_name(backer->dpif))) {
1310             garbage = xmalloc(sizeof *garbage);
1311             garbage->odp_port = port.port_no;
1312             list_push_front(&garbage_list, &garbage->list_node);
1313         }
1314     }
1315     dpif_port_dump_done(&port_dump);
1316
1317     LIST_FOR_EACH_SAFE (garbage, next, list_node, &garbage_list) {
1318         dpif_port_del(backer->dpif, garbage->odp_port);
1319         list_remove(&garbage->list_node);
1320         free(garbage);
1321     }
1322
1323     shash_add(&all_dpif_backers, type, backer);
1324
1325     error = dpif_recv_set(backer->dpif, true);
1326     if (error) {
1327         VLOG_ERR("failed to listen on datapath of type %s: %s",
1328                  type, strerror(error));
1329         close_dpif_backer(backer);
1330         return error;
1331     }
1332
1333     return error;
1334 }
1335
1336 static int
1337 construct(struct ofproto *ofproto_)
1338 {
1339     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
1340     struct shash_node *node, *next;
1341     int max_ports;
1342     int error;
1343     int i;
1344
1345     error = open_dpif_backer(ofproto->up.type, &ofproto->backer);
1346     if (error) {
1347         return error;
1348     }
1349
1350     max_ports = dpif_get_max_ports(ofproto->backer->dpif);
1351     ofproto_init_max_ports(ofproto_, MIN(max_ports, OFPP_MAX));
1352
1353     ofproto->n_matches = 0;
1354
1355     ofproto->netflow = NULL;
1356     ofproto->sflow = NULL;
1357     ofproto->ipfix = NULL;
1358     ofproto->stp = NULL;
1359     hmap_init(&ofproto->bundles);
1360     ofproto->ml = mac_learning_create(MAC_ENTRY_DEFAULT_IDLE_TIME);
1361     for (i = 0; i < MAX_MIRRORS; i++) {
1362         ofproto->mirrors[i] = NULL;
1363     }
1364     ofproto->has_bonded_bundles = false;
1365
1366     hmap_init(&ofproto->facets);
1367     hmap_init(&ofproto->subfacets);
1368     ofproto->governor = NULL;
1369     ofproto->consistency_rl = LLONG_MIN;
1370
1371     for (i = 0; i < N_TABLES; i++) {
1372         struct table_dpif *table = &ofproto->tables[i];
1373
1374         table->catchall_table = NULL;
1375         table->other_table = NULL;
1376         table->basis = random_uint32();
1377     }
1378
1379     list_init(&ofproto->completions);
1380
1381     ofproto_dpif_unixctl_init();
1382
1383     ofproto->has_mirrors = false;
1384     ofproto->has_bundle_action = false;
1385
1386     hmap_init(&ofproto->vlandev_map);
1387     hmap_init(&ofproto->realdev_vid_map);
1388
1389     sset_init(&ofproto->ports);
1390     sset_init(&ofproto->ghost_ports);
1391     sset_init(&ofproto->port_poll_set);
1392     ofproto->port_poll_errno = 0;
1393
1394     SHASH_FOR_EACH_SAFE (node, next, &init_ofp_ports) {
1395         struct iface_hint *iface_hint = node->data;
1396
1397         if (!strcmp(iface_hint->br_name, ofproto->up.name)) {
1398             /* Check if the datapath already has this port. */
1399             if (dpif_port_exists(ofproto->backer->dpif, node->name)) {
1400                 sset_add(&ofproto->ports, node->name);
1401             }
1402
1403             free(iface_hint->br_name);
1404             free(iface_hint->br_type);
1405             free(iface_hint);
1406             shash_delete(&init_ofp_ports, node);
1407         }
1408     }
1409
1410     hmap_insert(&all_ofproto_dpifs, &ofproto->all_ofproto_dpifs_node,
1411                 hash_string(ofproto->up.name, 0));
1412     memset(&ofproto->stats, 0, sizeof ofproto->stats);
1413
1414     ofproto_init_tables(ofproto_, N_TABLES);
1415     error = add_internal_flows(ofproto);
1416     ofproto->up.tables[TBL_INTERNAL].flags = OFTABLE_HIDDEN | OFTABLE_READONLY;
1417
1418     ofproto->n_hit = 0;
1419     ofproto->n_missed = 0;
1420
1421     ofproto->max_n_subfacet = 0;
1422     ofproto->created = time_msec();
1423     ofproto->last_minute = ofproto->created;
1424     memset(&ofproto->hourly, 0, sizeof ofproto->hourly);
1425     memset(&ofproto->daily, 0, sizeof ofproto->daily);
1426     ofproto->subfacet_add_count = 0;
1427     ofproto->subfacet_del_count = 0;
1428     ofproto->total_subfacet_add_count = 0;
1429     ofproto->total_subfacet_del_count = 0;
1430     ofproto->total_subfacet_life_span = 0;
1431     ofproto->total_subfacet_count = 0;
1432     ofproto->n_update_stats = 0;
1433
1434     return error;
1435 }
1436
1437 static int
1438 add_internal_flow(struct ofproto_dpif *ofproto, int id,
1439                   const struct ofpbuf *ofpacts, struct rule_dpif **rulep)
1440 {
1441     struct ofputil_flow_mod fm;
1442     int error;
1443
1444     match_init_catchall(&fm.match);
1445     fm.priority = 0;
1446     match_set_reg(&fm.match, 0, id);
1447     fm.new_cookie = htonll(0);
1448     fm.cookie = htonll(0);
1449     fm.cookie_mask = htonll(0);
1450     fm.table_id = TBL_INTERNAL;
1451     fm.command = OFPFC_ADD;
1452     fm.idle_timeout = 0;
1453     fm.hard_timeout = 0;
1454     fm.buffer_id = 0;
1455     fm.out_port = 0;
1456     fm.flags = 0;
1457     fm.ofpacts = ofpacts->data;
1458     fm.ofpacts_len = ofpacts->size;
1459
1460     error = ofproto_flow_mod(&ofproto->up, &fm);
1461     if (error) {
1462         VLOG_ERR_RL(&rl, "failed to add internal flow %d (%s)",
1463                     id, ofperr_to_string(error));
1464         return error;
1465     }
1466
1467     *rulep = rule_dpif_lookup__(ofproto, &fm.match.flow, TBL_INTERNAL);
1468     ovs_assert(*rulep != NULL);
1469
1470     return 0;
1471 }
1472
1473 static int
1474 add_internal_flows(struct ofproto_dpif *ofproto)
1475 {
1476     struct ofpact_controller *controller;
1477     uint64_t ofpacts_stub[128 / 8];
1478     struct ofpbuf ofpacts;
1479     int error;
1480     int id;
1481
1482     ofpbuf_use_stack(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
1483     id = 1;
1484
1485     controller = ofpact_put_CONTROLLER(&ofpacts);
1486     controller->max_len = UINT16_MAX;
1487     controller->controller_id = 0;
1488     controller->reason = OFPR_NO_MATCH;
1489     ofpact_pad(&ofpacts);
1490
1491     error = add_internal_flow(ofproto, id++, &ofpacts, &ofproto->miss_rule);
1492     if (error) {
1493         return error;
1494     }
1495
1496     ofpbuf_clear(&ofpacts);
1497     error = add_internal_flow(ofproto, id++, &ofpacts,
1498                               &ofproto->no_packet_in_rule);
1499     return error;
1500 }
1501
1502 static void
1503 complete_operations(struct ofproto_dpif *ofproto)
1504 {
1505     struct dpif_completion *c, *next;
1506
1507     LIST_FOR_EACH_SAFE (c, next, list_node, &ofproto->completions) {
1508         ofoperation_complete(c->op, 0);
1509         list_remove(&c->list_node);
1510         free(c);
1511     }
1512 }
1513
1514 static void
1515 destruct(struct ofproto *ofproto_)
1516 {
1517     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
1518     struct rule_dpif *rule, *next_rule;
1519     struct oftable *table;
1520     int i;
1521
1522     hmap_remove(&all_ofproto_dpifs, &ofproto->all_ofproto_dpifs_node);
1523     complete_operations(ofproto);
1524
1525     OFPROTO_FOR_EACH_TABLE (table, &ofproto->up) {
1526         struct cls_cursor cursor;
1527
1528         cls_cursor_init(&cursor, &table->cls, NULL);
1529         CLS_CURSOR_FOR_EACH_SAFE (rule, next_rule, up.cr, &cursor) {
1530             ofproto_rule_destroy(&rule->up);
1531         }
1532     }
1533
1534     for (i = 0; i < MAX_MIRRORS; i++) {
1535         mirror_destroy(ofproto->mirrors[i]);
1536     }
1537
1538     netflow_destroy(ofproto->netflow);
1539     dpif_sflow_destroy(ofproto->sflow);
1540     hmap_destroy(&ofproto->bundles);
1541     mac_learning_destroy(ofproto->ml);
1542
1543     hmap_destroy(&ofproto->facets);
1544     hmap_destroy(&ofproto->subfacets);
1545     governor_destroy(ofproto->governor);
1546
1547     hmap_destroy(&ofproto->vlandev_map);
1548     hmap_destroy(&ofproto->realdev_vid_map);
1549
1550     sset_destroy(&ofproto->ports);
1551     sset_destroy(&ofproto->ghost_ports);
1552     sset_destroy(&ofproto->port_poll_set);
1553
1554     close_dpif_backer(ofproto->backer);
1555 }
1556
1557 static int
1558 run_fast(struct ofproto *ofproto_)
1559 {
1560     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
1561     struct ofport_dpif *ofport;
1562
1563     HMAP_FOR_EACH (ofport, up.hmap_node, &ofproto->up.ports) {
1564         port_run_fast(ofport);
1565     }
1566
1567     return 0;
1568 }
1569
1570 static int
1571 run(struct ofproto *ofproto_)
1572 {
1573     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
1574     struct ofport_dpif *ofport;
1575     struct ofbundle *bundle;
1576     int error;
1577
1578     if (!clogged) {
1579         complete_operations(ofproto);
1580     }
1581
1582     error = run_fast(ofproto_);
1583     if (error) {
1584         return error;
1585     }
1586
1587     if (ofproto->netflow) {
1588         if (netflow_run(ofproto->netflow)) {
1589             send_netflow_active_timeouts(ofproto);
1590         }
1591     }
1592     if (ofproto->sflow) {
1593         dpif_sflow_run(ofproto->sflow);
1594     }
1595
1596     HMAP_FOR_EACH (ofport, up.hmap_node, &ofproto->up.ports) {
1597         port_run(ofport);
1598     }
1599     HMAP_FOR_EACH (bundle, hmap_node, &ofproto->bundles) {
1600         bundle_run(bundle);
1601     }
1602
1603     stp_run(ofproto);
1604     mac_learning_run(ofproto->ml, &ofproto->backer->revalidate_set);
1605
1606     /* Check the consistency of a random facet, to aid debugging. */
1607     if (time_msec() >= ofproto->consistency_rl
1608         && !hmap_is_empty(&ofproto->facets)
1609         && !ofproto->backer->need_revalidate) {
1610         struct facet *facet;
1611
1612         ofproto->consistency_rl = time_msec() + 250;
1613
1614         facet = CONTAINER_OF(hmap_random_node(&ofproto->facets),
1615                              struct facet, hmap_node);
1616         if (!tag_set_intersects(&ofproto->backer->revalidate_set,
1617                                 facet->tags)) {
1618             if (!facet_check_consistency(facet)) {
1619                 ofproto->backer->need_revalidate = REV_INCONSISTENCY;
1620             }
1621         }
1622     }
1623
1624     if (ofproto->governor) {
1625         size_t n_subfacets;
1626
1627         governor_run(ofproto->governor);
1628
1629         /* If the governor has shrunk to its minimum size and the number of
1630          * subfacets has dwindled, then drop the governor entirely.
1631          *
1632          * For hysteresis, the number of subfacets to drop the governor is
1633          * smaller than the number needed to trigger its creation. */
1634         n_subfacets = hmap_count(&ofproto->subfacets);
1635         if (n_subfacets * 4 < ofproto->up.flow_eviction_threshold
1636             && governor_is_idle(ofproto->governor)) {
1637             governor_destroy(ofproto->governor);
1638             ofproto->governor = NULL;
1639         }
1640     }
1641
1642     return 0;
1643 }
1644
1645 static void
1646 wait(struct ofproto *ofproto_)
1647 {
1648     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
1649     struct ofport_dpif *ofport;
1650     struct ofbundle *bundle;
1651
1652     if (!clogged && !list_is_empty(&ofproto->completions)) {
1653         poll_immediate_wake();
1654     }
1655
1656     dpif_wait(ofproto->backer->dpif);
1657     dpif_recv_wait(ofproto->backer->dpif);
1658     if (ofproto->sflow) {
1659         dpif_sflow_wait(ofproto->sflow);
1660     }
1661     if (!tag_set_is_empty(&ofproto->backer->revalidate_set)) {
1662         poll_immediate_wake();
1663     }
1664     HMAP_FOR_EACH (ofport, up.hmap_node, &ofproto->up.ports) {
1665         port_wait(ofport);
1666     }
1667     HMAP_FOR_EACH (bundle, hmap_node, &ofproto->bundles) {
1668         bundle_wait(bundle);
1669     }
1670     if (ofproto->netflow) {
1671         netflow_wait(ofproto->netflow);
1672     }
1673     mac_learning_wait(ofproto->ml);
1674     stp_wait(ofproto);
1675     if (ofproto->backer->need_revalidate) {
1676         /* Shouldn't happen, but if it does just go around again. */
1677         VLOG_DBG_RL(&rl, "need revalidate in ofproto_wait_cb()");
1678         poll_immediate_wake();
1679     }
1680     if (ofproto->governor) {
1681         governor_wait(ofproto->governor);
1682     }
1683 }
1684
1685 static void
1686 get_memory_usage(const struct ofproto *ofproto_, struct simap *usage)
1687 {
1688     const struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
1689
1690     simap_increase(usage, "facets", hmap_count(&ofproto->facets));
1691     simap_increase(usage, "subfacets", hmap_count(&ofproto->subfacets));
1692 }
1693
1694 static void
1695 flush(struct ofproto *ofproto_)
1696 {
1697     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
1698     struct subfacet *subfacet, *next_subfacet;
1699     struct subfacet *batch[SUBFACET_DESTROY_MAX_BATCH];
1700     int n_batch;
1701
1702     n_batch = 0;
1703     HMAP_FOR_EACH_SAFE (subfacet, next_subfacet, hmap_node,
1704                         &ofproto->subfacets) {
1705         if (subfacet->path != SF_NOT_INSTALLED) {
1706             batch[n_batch++] = subfacet;
1707             if (n_batch >= SUBFACET_DESTROY_MAX_BATCH) {
1708                 subfacet_destroy_batch(ofproto, batch, n_batch);
1709                 n_batch = 0;
1710             }
1711         } else {
1712             subfacet_destroy(subfacet);
1713         }
1714     }
1715
1716     if (n_batch > 0) {
1717         subfacet_destroy_batch(ofproto, batch, n_batch);
1718     }
1719 }
1720
1721 static void
1722 get_features(struct ofproto *ofproto_ OVS_UNUSED,
1723              bool *arp_match_ip, enum ofputil_action_bitmap *actions)
1724 {
1725     *arp_match_ip = true;
1726     *actions = (OFPUTIL_A_OUTPUT |
1727                 OFPUTIL_A_SET_VLAN_VID |
1728                 OFPUTIL_A_SET_VLAN_PCP |
1729                 OFPUTIL_A_STRIP_VLAN |
1730                 OFPUTIL_A_SET_DL_SRC |
1731                 OFPUTIL_A_SET_DL_DST |
1732                 OFPUTIL_A_SET_NW_SRC |
1733                 OFPUTIL_A_SET_NW_DST |
1734                 OFPUTIL_A_SET_NW_TOS |
1735                 OFPUTIL_A_SET_TP_SRC |
1736                 OFPUTIL_A_SET_TP_DST |
1737                 OFPUTIL_A_ENQUEUE);
1738 }
1739
1740 static void
1741 get_tables(struct ofproto *ofproto_, struct ofp12_table_stats *ots)
1742 {
1743     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
1744     struct dpif_dp_stats s;
1745
1746     strcpy(ots->name, "classifier");
1747
1748     dpif_get_dp_stats(ofproto->backer->dpif, &s);
1749
1750     ots->lookup_count = htonll(s.n_hit + s.n_missed);
1751     ots->matched_count = htonll(s.n_hit + ofproto->n_matches);
1752 }
1753
1754 static struct ofport *
1755 port_alloc(void)
1756 {
1757     struct ofport_dpif *port = xmalloc(sizeof *port);
1758     return &port->up;
1759 }
1760
1761 static void
1762 port_dealloc(struct ofport *port_)
1763 {
1764     struct ofport_dpif *port = ofport_dpif_cast(port_);
1765     free(port);
1766 }
1767
1768 static int
1769 port_construct(struct ofport *port_)
1770 {
1771     struct ofport_dpif *port = ofport_dpif_cast(port_);
1772     struct ofproto_dpif *ofproto = ofproto_dpif_cast(port->up.ofproto);
1773     const struct netdev *netdev = port->up.netdev;
1774     struct dpif_port dpif_port;
1775     int error;
1776
1777     ofproto->backer->need_revalidate = REV_RECONFIGURE;
1778     port->bundle = NULL;
1779     port->cfm = NULL;
1780     port->bfd = NULL;
1781     port->tag = tag_create_random();
1782     port->may_enable = true;
1783     port->stp_port = NULL;
1784     port->stp_state = STP_DISABLED;
1785     port->tnl_port = NULL;
1786     hmap_init(&port->priorities);
1787     port->realdev_ofp_port = 0;
1788     port->vlandev_vid = 0;
1789     port->carrier_seq = netdev_get_carrier_resets(netdev);
1790
1791     if (netdev_vport_is_patch(netdev)) {
1792         /* By bailing out here, we don't submit the port to the sFlow module
1793          * to be considered for counter polling export.  This is correct
1794          * because the patch port represents an interface that sFlow considers
1795          * to be "internal" to the switch as a whole, and therefore not an
1796          * candidate for counter polling. */
1797         port->odp_port = OVSP_NONE;
1798         return 0;
1799     }
1800
1801     error = dpif_port_query_by_name(ofproto->backer->dpif,
1802                                     netdev_vport_get_dpif_port(netdev),
1803                                     &dpif_port);
1804     if (error) {
1805         return error;
1806     }
1807
1808     port->odp_port = dpif_port.port_no;
1809
1810     if (netdev_get_tunnel_config(netdev)) {
1811         port->tnl_port = tnl_port_add(&port->up, port->odp_port);
1812     } else {
1813         /* Sanity-check that a mapping doesn't already exist.  This
1814          * shouldn't happen for non-tunnel ports. */
1815         if (odp_port_to_ofp_port(ofproto, port->odp_port) != OFPP_NONE) {
1816             VLOG_ERR("port %s already has an OpenFlow port number",
1817                      dpif_port.name);
1818             dpif_port_destroy(&dpif_port);
1819             return EBUSY;
1820         }
1821
1822         hmap_insert(&ofproto->backer->odp_to_ofport_map, &port->odp_port_node,
1823                     hash_int(port->odp_port, 0));
1824     }
1825     dpif_port_destroy(&dpif_port);
1826
1827     if (ofproto->sflow) {
1828         dpif_sflow_add_port(ofproto->sflow, port_, port->odp_port);
1829     }
1830
1831     return 0;
1832 }
1833
1834 static void
1835 port_destruct(struct ofport *port_)
1836 {
1837     struct ofport_dpif *port = ofport_dpif_cast(port_);
1838     struct ofproto_dpif *ofproto = ofproto_dpif_cast(port->up.ofproto);
1839     const char *dp_port_name = netdev_vport_get_dpif_port(port->up.netdev);
1840     const char *devname = netdev_get_name(port->up.netdev);
1841
1842     if (dpif_port_exists(ofproto->backer->dpif, dp_port_name)) {
1843         /* The underlying device is still there, so delete it.  This
1844          * happens when the ofproto is being destroyed, since the caller
1845          * assumes that removal of attached ports will happen as part of
1846          * destruction. */
1847         if (!port->tnl_port) {
1848             dpif_port_del(ofproto->backer->dpif, port->odp_port);
1849         }
1850         ofproto->backer->need_revalidate = REV_RECONFIGURE;
1851     }
1852
1853     if (port->odp_port != OVSP_NONE && !port->tnl_port) {
1854         hmap_remove(&ofproto->backer->odp_to_ofport_map, &port->odp_port_node);
1855     }
1856
1857     tnl_port_del(port->tnl_port);
1858     sset_find_and_delete(&ofproto->ports, devname);
1859     sset_find_and_delete(&ofproto->ghost_ports, devname);
1860     ofproto->backer->need_revalidate = REV_RECONFIGURE;
1861     bundle_remove(port_);
1862     set_cfm(port_, NULL);
1863     if (ofproto->sflow) {
1864         dpif_sflow_del_port(ofproto->sflow, port->odp_port);
1865     }
1866
1867     ofport_clear_priorities(port);
1868     hmap_destroy(&port->priorities);
1869 }
1870
1871 static void
1872 port_modified(struct ofport *port_)
1873 {
1874     struct ofport_dpif *port = ofport_dpif_cast(port_);
1875
1876     if (port->bundle && port->bundle->bond) {
1877         bond_slave_set_netdev(port->bundle->bond, port, port->up.netdev);
1878     }
1879 }
1880
1881 static void
1882 port_reconfigured(struct ofport *port_, enum ofputil_port_config old_config)
1883 {
1884     struct ofport_dpif *port = ofport_dpif_cast(port_);
1885     struct ofproto_dpif *ofproto = ofproto_dpif_cast(port->up.ofproto);
1886     enum ofputil_port_config changed = old_config ^ port->up.pp.config;
1887
1888     if (changed & (OFPUTIL_PC_NO_RECV | OFPUTIL_PC_NO_RECV_STP |
1889                    OFPUTIL_PC_NO_FWD | OFPUTIL_PC_NO_FLOOD |
1890                    OFPUTIL_PC_NO_PACKET_IN)) {
1891         ofproto->backer->need_revalidate = REV_RECONFIGURE;
1892
1893         if (changed & OFPUTIL_PC_NO_FLOOD && port->bundle) {
1894             bundle_update(port->bundle);
1895         }
1896     }
1897 }
1898
1899 static int
1900 set_sflow(struct ofproto *ofproto_,
1901           const struct ofproto_sflow_options *sflow_options)
1902 {
1903     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
1904     struct dpif_sflow *ds = ofproto->sflow;
1905
1906     if (sflow_options) {
1907         if (!ds) {
1908             struct ofport_dpif *ofport;
1909
1910             ds = ofproto->sflow = dpif_sflow_create();
1911             HMAP_FOR_EACH (ofport, up.hmap_node, &ofproto->up.ports) {
1912                 dpif_sflow_add_port(ds, &ofport->up, ofport->odp_port);
1913             }
1914             ofproto->backer->need_revalidate = REV_RECONFIGURE;
1915         }
1916         dpif_sflow_set_options(ds, sflow_options);
1917     } else {
1918         if (ds) {
1919             dpif_sflow_destroy(ds);
1920             ofproto->backer->need_revalidate = REV_RECONFIGURE;
1921             ofproto->sflow = NULL;
1922         }
1923     }
1924     return 0;
1925 }
1926
1927 static int
1928 set_ipfix(
1929     struct ofproto *ofproto_,
1930     const struct ofproto_ipfix_bridge_exporter_options *bridge_exporter_options,
1931     const struct ofproto_ipfix_flow_exporter_options *flow_exporters_options,
1932     size_t n_flow_exporters_options)
1933 {
1934     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
1935     struct dpif_ipfix *di = ofproto->ipfix;
1936
1937     if (bridge_exporter_options || flow_exporters_options) {
1938         if (!di) {
1939             di = ofproto->ipfix = dpif_ipfix_create();
1940         }
1941         dpif_ipfix_set_options(
1942             di, bridge_exporter_options, flow_exporters_options,
1943             n_flow_exporters_options);
1944     } else {
1945         if (di) {
1946             dpif_ipfix_destroy(di);
1947             ofproto->ipfix = NULL;
1948         }
1949     }
1950     return 0;
1951 }
1952
1953 static int
1954 set_cfm(struct ofport *ofport_, const struct cfm_settings *s)
1955 {
1956     struct ofport_dpif *ofport = ofport_dpif_cast(ofport_);
1957     int error;
1958
1959     if (!s) {
1960         error = 0;
1961     } else {
1962         if (!ofport->cfm) {
1963             struct ofproto_dpif *ofproto;
1964
1965             ofproto = ofproto_dpif_cast(ofport->up.ofproto);
1966             ofproto->backer->need_revalidate = REV_RECONFIGURE;
1967             ofport->cfm = cfm_create(netdev_get_name(ofport->up.netdev));
1968         }
1969
1970         if (cfm_configure(ofport->cfm, s)) {
1971             return 0;
1972         }
1973
1974         error = EINVAL;
1975     }
1976     cfm_destroy(ofport->cfm);
1977     ofport->cfm = NULL;
1978     return error;
1979 }
1980
1981 static bool
1982 get_cfm_status(const struct ofport *ofport_,
1983                struct ofproto_cfm_status *status)
1984 {
1985     struct ofport_dpif *ofport = ofport_dpif_cast(ofport_);
1986
1987     if (ofport->cfm) {
1988         status->faults = cfm_get_fault(ofport->cfm);
1989         status->remote_opstate = cfm_get_opup(ofport->cfm);
1990         status->health = cfm_get_health(ofport->cfm);
1991         cfm_get_remote_mpids(ofport->cfm, &status->rmps, &status->n_rmps);
1992         return true;
1993     } else {
1994         return false;
1995     }
1996 }
1997
1998 static int
1999 set_bfd(struct ofport *ofport_, const struct smap *cfg)
2000 {
2001     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofport_->ofproto);
2002     struct ofport_dpif *ofport = ofport_dpif_cast(ofport_);
2003     struct bfd *old;
2004
2005     old = ofport->bfd;
2006     ofport->bfd = bfd_configure(old, netdev_get_name(ofport->up.netdev), cfg);
2007     if (ofport->bfd != old) {
2008         ofproto->backer->need_revalidate = REV_RECONFIGURE;
2009     }
2010
2011     return 0;
2012 }
2013
2014 static int
2015 get_bfd_status(struct ofport *ofport_, struct smap *smap)
2016 {
2017     struct ofport_dpif *ofport = ofport_dpif_cast(ofport_);
2018
2019     if (ofport->bfd) {
2020         bfd_get_status(ofport->bfd, smap);
2021         return 0;
2022     } else {
2023         return ENOENT;
2024     }
2025 }
2026 \f
2027 /* Spanning Tree. */
2028
2029 static void
2030 send_bpdu_cb(struct ofpbuf *pkt, int port_num, void *ofproto_)
2031 {
2032     struct ofproto_dpif *ofproto = ofproto_;
2033     struct stp_port *sp = stp_get_port(ofproto->stp, port_num);
2034     struct ofport_dpif *ofport;
2035
2036     ofport = stp_port_get_aux(sp);
2037     if (!ofport) {
2038         VLOG_WARN_RL(&rl, "%s: cannot send BPDU on unknown port %d",
2039                      ofproto->up.name, port_num);
2040     } else {
2041         struct eth_header *eth = pkt->l2;
2042
2043         netdev_get_etheraddr(ofport->up.netdev, eth->eth_src);
2044         if (eth_addr_is_zero(eth->eth_src)) {
2045             VLOG_WARN_RL(&rl, "%s: cannot send BPDU on port %d "
2046                          "with unknown MAC", ofproto->up.name, port_num);
2047         } else {
2048             send_packet(ofport, pkt);
2049         }
2050     }
2051     ofpbuf_delete(pkt);
2052 }
2053
2054 /* Configures STP on 'ofproto_' using the settings defined in 's'. */
2055 static int
2056 set_stp(struct ofproto *ofproto_, const struct ofproto_stp_settings *s)
2057 {
2058     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
2059
2060     /* Only revalidate flows if the configuration changed. */
2061     if (!s != !ofproto->stp) {
2062         ofproto->backer->need_revalidate = REV_RECONFIGURE;
2063     }
2064
2065     if (s) {
2066         if (!ofproto->stp) {
2067             ofproto->stp = stp_create(ofproto_->name, s->system_id,
2068                                       send_bpdu_cb, ofproto);
2069             ofproto->stp_last_tick = time_msec();
2070         }
2071
2072         stp_set_bridge_id(ofproto->stp, s->system_id);
2073         stp_set_bridge_priority(ofproto->stp, s->priority);
2074         stp_set_hello_time(ofproto->stp, s->hello_time);
2075         stp_set_max_age(ofproto->stp, s->max_age);
2076         stp_set_forward_delay(ofproto->stp, s->fwd_delay);
2077     }  else {
2078         struct ofport *ofport;
2079
2080         HMAP_FOR_EACH (ofport, hmap_node, &ofproto->up.ports) {
2081             set_stp_port(ofport, NULL);
2082         }
2083
2084         stp_destroy(ofproto->stp);
2085         ofproto->stp = NULL;
2086     }
2087
2088     return 0;
2089 }
2090
2091 static int
2092 get_stp_status(struct ofproto *ofproto_, struct ofproto_stp_status *s)
2093 {
2094     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
2095
2096     if (ofproto->stp) {
2097         s->enabled = true;
2098         s->bridge_id = stp_get_bridge_id(ofproto->stp);
2099         s->designated_root = stp_get_designated_root(ofproto->stp);
2100         s->root_path_cost = stp_get_root_path_cost(ofproto->stp);
2101     } else {
2102         s->enabled = false;
2103     }
2104
2105     return 0;
2106 }
2107
2108 static void
2109 update_stp_port_state(struct ofport_dpif *ofport)
2110 {
2111     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofport->up.ofproto);
2112     enum stp_state state;
2113
2114     /* Figure out new state. */
2115     state = ofport->stp_port ? stp_port_get_state(ofport->stp_port)
2116                              : STP_DISABLED;
2117
2118     /* Update state. */
2119     if (ofport->stp_state != state) {
2120         enum ofputil_port_state of_state;
2121         bool fwd_change;
2122
2123         VLOG_DBG_RL(&rl, "port %s: STP state changed from %s to %s",
2124                     netdev_get_name(ofport->up.netdev),
2125                     stp_state_name(ofport->stp_state),
2126                     stp_state_name(state));
2127         if (stp_learn_in_state(ofport->stp_state)
2128                 != stp_learn_in_state(state)) {
2129             /* xxx Learning action flows should also be flushed. */
2130             mac_learning_flush(ofproto->ml,
2131                                &ofproto->backer->revalidate_set);
2132         }
2133         fwd_change = stp_forward_in_state(ofport->stp_state)
2134                         != stp_forward_in_state(state);
2135
2136         ofproto->backer->need_revalidate = REV_STP;
2137         ofport->stp_state = state;
2138         ofport->stp_state_entered = time_msec();
2139
2140         if (fwd_change && ofport->bundle) {
2141             bundle_update(ofport->bundle);
2142         }
2143
2144         /* Update the STP state bits in the OpenFlow port description. */
2145         of_state = ofport->up.pp.state & ~OFPUTIL_PS_STP_MASK;
2146         of_state |= (state == STP_LISTENING ? OFPUTIL_PS_STP_LISTEN
2147                      : state == STP_LEARNING ? OFPUTIL_PS_STP_LEARN
2148                      : state == STP_FORWARDING ? OFPUTIL_PS_STP_FORWARD
2149                      : state == STP_BLOCKING ?  OFPUTIL_PS_STP_BLOCK
2150                      : 0);
2151         ofproto_port_set_state(&ofport->up, of_state);
2152     }
2153 }
2154
2155 /* Configures STP on 'ofport_' using the settings defined in 's'.  The
2156  * caller is responsible for assigning STP port numbers and ensuring
2157  * there are no duplicates. */
2158 static int
2159 set_stp_port(struct ofport *ofport_,
2160              const struct ofproto_port_stp_settings *s)
2161 {
2162     struct ofport_dpif *ofport = ofport_dpif_cast(ofport_);
2163     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofport->up.ofproto);
2164     struct stp_port *sp = ofport->stp_port;
2165
2166     if (!s || !s->enable) {
2167         if (sp) {
2168             ofport->stp_port = NULL;
2169             stp_port_disable(sp);
2170             update_stp_port_state(ofport);
2171         }
2172         return 0;
2173     } else if (sp && stp_port_no(sp) != s->port_num
2174             && ofport == stp_port_get_aux(sp)) {
2175         /* The port-id changed, so disable the old one if it's not
2176          * already in use by another port. */
2177         stp_port_disable(sp);
2178     }
2179
2180     sp = ofport->stp_port = stp_get_port(ofproto->stp, s->port_num);
2181     stp_port_enable(sp);
2182
2183     stp_port_set_aux(sp, ofport);
2184     stp_port_set_priority(sp, s->priority);
2185     stp_port_set_path_cost(sp, s->path_cost);
2186
2187     update_stp_port_state(ofport);
2188
2189     return 0;
2190 }
2191
2192 static int
2193 get_stp_port_status(struct ofport *ofport_,
2194                     struct ofproto_port_stp_status *s)
2195 {
2196     struct ofport_dpif *ofport = ofport_dpif_cast(ofport_);
2197     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofport->up.ofproto);
2198     struct stp_port *sp = ofport->stp_port;
2199
2200     if (!ofproto->stp || !sp) {
2201         s->enabled = false;
2202         return 0;
2203     }
2204
2205     s->enabled = true;
2206     s->port_id = stp_port_get_id(sp);
2207     s->state = stp_port_get_state(sp);
2208     s->sec_in_state = (time_msec() - ofport->stp_state_entered) / 1000;
2209     s->role = stp_port_get_role(sp);
2210     stp_port_get_counts(sp, &s->tx_count, &s->rx_count, &s->error_count);
2211
2212     return 0;
2213 }
2214
2215 static void
2216 stp_run(struct ofproto_dpif *ofproto)
2217 {
2218     if (ofproto->stp) {
2219         long long int now = time_msec();
2220         long long int elapsed = now - ofproto->stp_last_tick;
2221         struct stp_port *sp;
2222
2223         if (elapsed > 0) {
2224             stp_tick(ofproto->stp, MIN(INT_MAX, elapsed));
2225             ofproto->stp_last_tick = now;
2226         }
2227         while (stp_get_changed_port(ofproto->stp, &sp)) {
2228             struct ofport_dpif *ofport = stp_port_get_aux(sp);
2229
2230             if (ofport) {
2231                 update_stp_port_state(ofport);
2232             }
2233         }
2234
2235         if (stp_check_and_reset_fdb_flush(ofproto->stp)) {
2236             mac_learning_flush(ofproto->ml, &ofproto->backer->revalidate_set);
2237         }
2238     }
2239 }
2240
2241 static void
2242 stp_wait(struct ofproto_dpif *ofproto)
2243 {
2244     if (ofproto->stp) {
2245         poll_timer_wait(1000);
2246     }
2247 }
2248
2249 /* Returns true if STP should process 'flow'. */
2250 static bool
2251 stp_should_process_flow(const struct flow *flow)
2252 {
2253     return eth_addr_equals(flow->dl_dst, eth_addr_stp);
2254 }
2255
2256 static void
2257 stp_process_packet(const struct ofport_dpif *ofport,
2258                    const struct ofpbuf *packet)
2259 {
2260     struct ofpbuf payload = *packet;
2261     struct eth_header *eth = payload.data;
2262     struct stp_port *sp = ofport->stp_port;
2263
2264     /* Sink packets on ports that have STP disabled when the bridge has
2265      * STP enabled. */
2266     if (!sp || stp_port_get_state(sp) == STP_DISABLED) {
2267         return;
2268     }
2269
2270     /* Trim off padding on payload. */
2271     if (payload.size > ntohs(eth->eth_type) + ETH_HEADER_LEN) {
2272         payload.size = ntohs(eth->eth_type) + ETH_HEADER_LEN;
2273     }
2274
2275     if (ofpbuf_try_pull(&payload, ETH_HEADER_LEN + LLC_HEADER_LEN)) {
2276         stp_received_bpdu(sp, payload.data, payload.size);
2277     }
2278 }
2279 \f
2280 static struct priority_to_dscp *
2281 get_priority(const struct ofport_dpif *ofport, uint32_t priority)
2282 {
2283     struct priority_to_dscp *pdscp;
2284     uint32_t hash;
2285
2286     hash = hash_int(priority, 0);
2287     HMAP_FOR_EACH_IN_BUCKET (pdscp, hmap_node, hash, &ofport->priorities) {
2288         if (pdscp->priority == priority) {
2289             return pdscp;
2290         }
2291     }
2292     return NULL;
2293 }
2294
2295 static void
2296 ofport_clear_priorities(struct ofport_dpif *ofport)
2297 {
2298     struct priority_to_dscp *pdscp, *next;
2299
2300     HMAP_FOR_EACH_SAFE (pdscp, next, hmap_node, &ofport->priorities) {
2301         hmap_remove(&ofport->priorities, &pdscp->hmap_node);
2302         free(pdscp);
2303     }
2304 }
2305
2306 static int
2307 set_queues(struct ofport *ofport_,
2308            const struct ofproto_port_queue *qdscp_list,
2309            size_t n_qdscp)
2310 {
2311     struct ofport_dpif *ofport = ofport_dpif_cast(ofport_);
2312     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofport->up.ofproto);
2313     struct hmap new = HMAP_INITIALIZER(&new);
2314     size_t i;
2315
2316     for (i = 0; i < n_qdscp; i++) {
2317         struct priority_to_dscp *pdscp;
2318         uint32_t priority;
2319         uint8_t dscp;
2320
2321         dscp = (qdscp_list[i].dscp << 2) & IP_DSCP_MASK;
2322         if (dpif_queue_to_priority(ofproto->backer->dpif, qdscp_list[i].queue,
2323                                    &priority)) {
2324             continue;
2325         }
2326
2327         pdscp = get_priority(ofport, priority);
2328         if (pdscp) {
2329             hmap_remove(&ofport->priorities, &pdscp->hmap_node);
2330         } else {
2331             pdscp = xmalloc(sizeof *pdscp);
2332             pdscp->priority = priority;
2333             pdscp->dscp = dscp;
2334             ofproto->backer->need_revalidate = REV_RECONFIGURE;
2335         }
2336
2337         if (pdscp->dscp != dscp) {
2338             pdscp->dscp = dscp;
2339             ofproto->backer->need_revalidate = REV_RECONFIGURE;
2340         }
2341
2342         hmap_insert(&new, &pdscp->hmap_node, hash_int(pdscp->priority, 0));
2343     }
2344
2345     if (!hmap_is_empty(&ofport->priorities)) {
2346         ofport_clear_priorities(ofport);
2347         ofproto->backer->need_revalidate = REV_RECONFIGURE;
2348     }
2349
2350     hmap_swap(&new, &ofport->priorities);
2351     hmap_destroy(&new);
2352
2353     return 0;
2354 }
2355 \f
2356 /* Bundles. */
2357
2358 /* Expires all MAC learning entries associated with 'bundle' and forces its
2359  * ofproto to revalidate every flow.
2360  *
2361  * Normally MAC learning entries are removed only from the ofproto associated
2362  * with 'bundle', but if 'all_ofprotos' is true, then the MAC learning entries
2363  * are removed from every ofproto.  When patch ports and SLB bonds are in use
2364  * and a VM migration happens and the gratuitous ARPs are somehow lost, this
2365  * avoids a MAC_ENTRY_IDLE_TIME delay before the migrated VM can communicate
2366  * with the host from which it migrated. */
2367 static void
2368 bundle_flush_macs(struct ofbundle *bundle, bool all_ofprotos)
2369 {
2370     struct ofproto_dpif *ofproto = bundle->ofproto;
2371     struct mac_learning *ml = ofproto->ml;
2372     struct mac_entry *mac, *next_mac;
2373
2374     ofproto->backer->need_revalidate = REV_RECONFIGURE;
2375     LIST_FOR_EACH_SAFE (mac, next_mac, lru_node, &ml->lrus) {
2376         if (mac->port.p == bundle) {
2377             if (all_ofprotos) {
2378                 struct ofproto_dpif *o;
2379
2380                 HMAP_FOR_EACH (o, all_ofproto_dpifs_node, &all_ofproto_dpifs) {
2381                     if (o != ofproto) {
2382                         struct mac_entry *e;
2383
2384                         e = mac_learning_lookup(o->ml, mac->mac, mac->vlan,
2385                                                 NULL);
2386                         if (e) {
2387                             mac_learning_expire(o->ml, e);
2388                         }
2389                     }
2390                 }
2391             }
2392
2393             mac_learning_expire(ml, mac);
2394         }
2395     }
2396 }
2397
2398 static struct ofbundle *
2399 bundle_lookup(const struct ofproto_dpif *ofproto, void *aux)
2400 {
2401     struct ofbundle *bundle;
2402
2403     HMAP_FOR_EACH_IN_BUCKET (bundle, hmap_node, hash_pointer(aux, 0),
2404                              &ofproto->bundles) {
2405         if (bundle->aux == aux) {
2406             return bundle;
2407         }
2408     }
2409     return NULL;
2410 }
2411
2412 /* Looks up each of the 'n_auxes' pointers in 'auxes' as bundles and adds the
2413  * ones that are found to 'bundles'. */
2414 static void
2415 bundle_lookup_multiple(struct ofproto_dpif *ofproto,
2416                        void **auxes, size_t n_auxes,
2417                        struct hmapx *bundles)
2418 {
2419     size_t i;
2420
2421     hmapx_init(bundles);
2422     for (i = 0; i < n_auxes; i++) {
2423         struct ofbundle *bundle = bundle_lookup(ofproto, auxes[i]);
2424         if (bundle) {
2425             hmapx_add(bundles, bundle);
2426         }
2427     }
2428 }
2429
2430 static void
2431 bundle_update(struct ofbundle *bundle)
2432 {
2433     struct ofport_dpif *port;
2434
2435     bundle->floodable = true;
2436     LIST_FOR_EACH (port, bundle_node, &bundle->ports) {
2437         if (port->up.pp.config & OFPUTIL_PC_NO_FLOOD
2438             || !stp_forward_in_state(port->stp_state)) {
2439             bundle->floodable = false;
2440             break;
2441         }
2442     }
2443 }
2444
2445 static void
2446 bundle_del_port(struct ofport_dpif *port)
2447 {
2448     struct ofbundle *bundle = port->bundle;
2449
2450     bundle->ofproto->backer->need_revalidate = REV_RECONFIGURE;
2451
2452     list_remove(&port->bundle_node);
2453     port->bundle = NULL;
2454
2455     if (bundle->lacp) {
2456         lacp_slave_unregister(bundle->lacp, port);
2457     }
2458     if (bundle->bond) {
2459         bond_slave_unregister(bundle->bond, port);
2460     }
2461
2462     bundle_update(bundle);
2463 }
2464
2465 static bool
2466 bundle_add_port(struct ofbundle *bundle, uint32_t ofp_port,
2467                 struct lacp_slave_settings *lacp)
2468 {
2469     struct ofport_dpif *port;
2470
2471     port = get_ofp_port(bundle->ofproto, ofp_port);
2472     if (!port) {
2473         return false;
2474     }
2475
2476     if (port->bundle != bundle) {
2477         bundle->ofproto->backer->need_revalidate = REV_RECONFIGURE;
2478         if (port->bundle) {
2479             bundle_del_port(port);
2480         }
2481
2482         port->bundle = bundle;
2483         list_push_back(&bundle->ports, &port->bundle_node);
2484         if (port->up.pp.config & OFPUTIL_PC_NO_FLOOD
2485             || !stp_forward_in_state(port->stp_state)) {
2486             bundle->floodable = false;
2487         }
2488     }
2489     if (lacp) {
2490         bundle->ofproto->backer->need_revalidate = REV_RECONFIGURE;
2491         lacp_slave_register(bundle->lacp, port, lacp);
2492     }
2493
2494     return true;
2495 }
2496
2497 static void
2498 bundle_destroy(struct ofbundle *bundle)
2499 {
2500     struct ofproto_dpif *ofproto;
2501     struct ofport_dpif *port, *next_port;
2502     int i;
2503
2504     if (!bundle) {
2505         return;
2506     }
2507
2508     ofproto = bundle->ofproto;
2509     for (i = 0; i < MAX_MIRRORS; i++) {
2510         struct ofmirror *m = ofproto->mirrors[i];
2511         if (m) {
2512             if (m->out == bundle) {
2513                 mirror_destroy(m);
2514             } else if (hmapx_find_and_delete(&m->srcs, bundle)
2515                        || hmapx_find_and_delete(&m->dsts, bundle)) {
2516                 ofproto->backer->need_revalidate = REV_RECONFIGURE;
2517             }
2518         }
2519     }
2520
2521     LIST_FOR_EACH_SAFE (port, next_port, bundle_node, &bundle->ports) {
2522         bundle_del_port(port);
2523     }
2524
2525     bundle_flush_macs(bundle, true);
2526     hmap_remove(&ofproto->bundles, &bundle->hmap_node);
2527     free(bundle->name);
2528     free(bundle->trunks);
2529     lacp_destroy(bundle->lacp);
2530     bond_destroy(bundle->bond);
2531     free(bundle);
2532 }
2533
2534 static int
2535 bundle_set(struct ofproto *ofproto_, void *aux,
2536            const struct ofproto_bundle_settings *s)
2537 {
2538     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
2539     bool need_flush = false;
2540     struct ofport_dpif *port;
2541     struct ofbundle *bundle;
2542     unsigned long *trunks;
2543     int vlan;
2544     size_t i;
2545     bool ok;
2546
2547     if (!s) {
2548         bundle_destroy(bundle_lookup(ofproto, aux));
2549         return 0;
2550     }
2551
2552     ovs_assert(s->n_slaves == 1 || s->bond != NULL);
2553     ovs_assert((s->lacp != NULL) == (s->lacp_slaves != NULL));
2554
2555     bundle = bundle_lookup(ofproto, aux);
2556     if (!bundle) {
2557         bundle = xmalloc(sizeof *bundle);
2558
2559         bundle->ofproto = ofproto;
2560         hmap_insert(&ofproto->bundles, &bundle->hmap_node,
2561                     hash_pointer(aux, 0));
2562         bundle->aux = aux;
2563         bundle->name = NULL;
2564
2565         list_init(&bundle->ports);
2566         bundle->vlan_mode = PORT_VLAN_TRUNK;
2567         bundle->vlan = -1;
2568         bundle->trunks = NULL;
2569         bundle->use_priority_tags = s->use_priority_tags;
2570         bundle->lacp = NULL;
2571         bundle->bond = NULL;
2572
2573         bundle->floodable = true;
2574
2575         bundle->src_mirrors = 0;
2576         bundle->dst_mirrors = 0;
2577         bundle->mirror_out = 0;
2578     }
2579
2580     if (!bundle->name || strcmp(s->name, bundle->name)) {
2581         free(bundle->name);
2582         bundle->name = xstrdup(s->name);
2583     }
2584
2585     /* LACP. */
2586     if (s->lacp) {
2587         if (!bundle->lacp) {
2588             ofproto->backer->need_revalidate = REV_RECONFIGURE;
2589             bundle->lacp = lacp_create();
2590         }
2591         lacp_configure(bundle->lacp, s->lacp);
2592     } else {
2593         lacp_destroy(bundle->lacp);
2594         bundle->lacp = NULL;
2595     }
2596
2597     /* Update set of ports. */
2598     ok = true;
2599     for (i = 0; i < s->n_slaves; i++) {
2600         if (!bundle_add_port(bundle, s->slaves[i],
2601                              s->lacp ? &s->lacp_slaves[i] : NULL)) {
2602             ok = false;
2603         }
2604     }
2605     if (!ok || list_size(&bundle->ports) != s->n_slaves) {
2606         struct ofport_dpif *next_port;
2607
2608         LIST_FOR_EACH_SAFE (port, next_port, bundle_node, &bundle->ports) {
2609             for (i = 0; i < s->n_slaves; i++) {
2610                 if (s->slaves[i] == port->up.ofp_port) {
2611                     goto found;
2612                 }
2613             }
2614
2615             bundle_del_port(port);
2616         found: ;
2617         }
2618     }
2619     ovs_assert(list_size(&bundle->ports) <= s->n_slaves);
2620
2621     if (list_is_empty(&bundle->ports)) {
2622         bundle_destroy(bundle);
2623         return EINVAL;
2624     }
2625
2626     /* Set VLAN tagging mode */
2627     if (s->vlan_mode != bundle->vlan_mode
2628         || s->use_priority_tags != bundle->use_priority_tags) {
2629         bundle->vlan_mode = s->vlan_mode;
2630         bundle->use_priority_tags = s->use_priority_tags;
2631         need_flush = true;
2632     }
2633
2634     /* Set VLAN tag. */
2635     vlan = (s->vlan_mode == PORT_VLAN_TRUNK ? -1
2636             : s->vlan >= 0 && s->vlan <= 4095 ? s->vlan
2637             : 0);
2638     if (vlan != bundle->vlan) {
2639         bundle->vlan = vlan;
2640         need_flush = true;
2641     }
2642
2643     /* Get trunked VLANs. */
2644     switch (s->vlan_mode) {
2645     case PORT_VLAN_ACCESS:
2646         trunks = NULL;
2647         break;
2648
2649     case PORT_VLAN_TRUNK:
2650         trunks = CONST_CAST(unsigned long *, s->trunks);
2651         break;
2652
2653     case PORT_VLAN_NATIVE_UNTAGGED:
2654     case PORT_VLAN_NATIVE_TAGGED:
2655         if (vlan != 0 && (!s->trunks
2656                           || !bitmap_is_set(s->trunks, vlan)
2657                           || bitmap_is_set(s->trunks, 0))) {
2658             /* Force trunking the native VLAN and prohibit trunking VLAN 0. */
2659             if (s->trunks) {
2660                 trunks = bitmap_clone(s->trunks, 4096);
2661             } else {
2662                 trunks = bitmap_allocate1(4096);
2663             }
2664             bitmap_set1(trunks, vlan);
2665             bitmap_set0(trunks, 0);
2666         } else {
2667             trunks = CONST_CAST(unsigned long *, s->trunks);
2668         }
2669         break;
2670
2671     default:
2672         NOT_REACHED();
2673     }
2674     if (!vlan_bitmap_equal(trunks, bundle->trunks)) {
2675         free(bundle->trunks);
2676         if (trunks == s->trunks) {
2677             bundle->trunks = vlan_bitmap_clone(trunks);
2678         } else {
2679             bundle->trunks = trunks;
2680             trunks = NULL;
2681         }
2682         need_flush = true;
2683     }
2684     if (trunks != s->trunks) {
2685         free(trunks);
2686     }
2687
2688     /* Bonding. */
2689     if (!list_is_short(&bundle->ports)) {
2690         bundle->ofproto->has_bonded_bundles = true;
2691         if (bundle->bond) {
2692             if (bond_reconfigure(bundle->bond, s->bond)) {
2693                 ofproto->backer->need_revalidate = REV_RECONFIGURE;
2694             }
2695         } else {
2696             bundle->bond = bond_create(s->bond);
2697             ofproto->backer->need_revalidate = REV_RECONFIGURE;
2698         }
2699
2700         LIST_FOR_EACH (port, bundle_node, &bundle->ports) {
2701             bond_slave_register(bundle->bond, port, port->up.netdev);
2702         }
2703     } else {
2704         bond_destroy(bundle->bond);
2705         bundle->bond = NULL;
2706     }
2707
2708     /* If we changed something that would affect MAC learning, un-learn
2709      * everything on this port and force flow revalidation. */
2710     if (need_flush) {
2711         bundle_flush_macs(bundle, false);
2712     }
2713
2714     return 0;
2715 }
2716
2717 static void
2718 bundle_remove(struct ofport *port_)
2719 {
2720     struct ofport_dpif *port = ofport_dpif_cast(port_);
2721     struct ofbundle *bundle = port->bundle;
2722
2723     if (bundle) {
2724         bundle_del_port(port);
2725         if (list_is_empty(&bundle->ports)) {
2726             bundle_destroy(bundle);
2727         } else if (list_is_short(&bundle->ports)) {
2728             bond_destroy(bundle->bond);
2729             bundle->bond = NULL;
2730         }
2731     }
2732 }
2733
2734 static void
2735 send_pdu_cb(void *port_, const void *pdu, size_t pdu_size)
2736 {
2737     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 10);
2738     struct ofport_dpif *port = port_;
2739     uint8_t ea[ETH_ADDR_LEN];
2740     int error;
2741
2742     error = netdev_get_etheraddr(port->up.netdev, ea);
2743     if (!error) {
2744         struct ofpbuf packet;
2745         void *packet_pdu;
2746
2747         ofpbuf_init(&packet, 0);
2748         packet_pdu = eth_compose(&packet, eth_addr_lacp, ea, ETH_TYPE_LACP,
2749                                  pdu_size);
2750         memcpy(packet_pdu, pdu, pdu_size);
2751
2752         send_packet(port, &packet);
2753         ofpbuf_uninit(&packet);
2754     } else {
2755         VLOG_ERR_RL(&rl, "port %s: cannot obtain Ethernet address of iface "
2756                     "%s (%s)", port->bundle->name,
2757                     netdev_get_name(port->up.netdev), strerror(error));
2758     }
2759 }
2760
2761 static void
2762 bundle_send_learning_packets(struct ofbundle *bundle)
2763 {
2764     struct ofproto_dpif *ofproto = bundle->ofproto;
2765     int error, n_packets, n_errors;
2766     struct mac_entry *e;
2767
2768     error = n_packets = n_errors = 0;
2769     LIST_FOR_EACH (e, lru_node, &ofproto->ml->lrus) {
2770         if (e->port.p != bundle) {
2771             struct ofpbuf *learning_packet;
2772             struct ofport_dpif *port;
2773             void *port_void;
2774             int ret;
2775
2776             /* The assignment to "port" is unnecessary but makes "grep"ing for
2777              * struct ofport_dpif more effective. */
2778             learning_packet = bond_compose_learning_packet(bundle->bond,
2779                                                            e->mac, e->vlan,
2780                                                            &port_void);
2781             port = port_void;
2782             ret = send_packet(port, learning_packet);
2783             ofpbuf_delete(learning_packet);
2784             if (ret) {
2785                 error = ret;
2786                 n_errors++;
2787             }
2788             n_packets++;
2789         }
2790     }
2791
2792     if (n_errors) {
2793         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
2794         VLOG_WARN_RL(&rl, "bond %s: %d errors sending %d gratuitous learning "
2795                      "packets, last error was: %s",
2796                      bundle->name, n_errors, n_packets, strerror(error));
2797     } else {
2798         VLOG_DBG("bond %s: sent %d gratuitous learning packets",
2799                  bundle->name, n_packets);
2800     }
2801 }
2802
2803 static void
2804 bundle_run(struct ofbundle *bundle)
2805 {
2806     if (bundle->lacp) {
2807         lacp_run(bundle->lacp, send_pdu_cb);
2808     }
2809     if (bundle->bond) {
2810         struct ofport_dpif *port;
2811
2812         LIST_FOR_EACH (port, bundle_node, &bundle->ports) {
2813             bond_slave_set_may_enable(bundle->bond, port, port->may_enable);
2814         }
2815
2816         bond_run(bundle->bond, &bundle->ofproto->backer->revalidate_set,
2817                  lacp_status(bundle->lacp));
2818         if (bond_should_send_learning_packets(bundle->bond)) {
2819             bundle_send_learning_packets(bundle);
2820         }
2821     }
2822 }
2823
2824 static void
2825 bundle_wait(struct ofbundle *bundle)
2826 {
2827     if (bundle->lacp) {
2828         lacp_wait(bundle->lacp);
2829     }
2830     if (bundle->bond) {
2831         bond_wait(bundle->bond);
2832     }
2833 }
2834 \f
2835 /* Mirrors. */
2836
2837 static int
2838 mirror_scan(struct ofproto_dpif *ofproto)
2839 {
2840     int idx;
2841
2842     for (idx = 0; idx < MAX_MIRRORS; idx++) {
2843         if (!ofproto->mirrors[idx]) {
2844             return idx;
2845         }
2846     }
2847     return -1;
2848 }
2849
2850 static struct ofmirror *
2851 mirror_lookup(struct ofproto_dpif *ofproto, void *aux)
2852 {
2853     int i;
2854
2855     for (i = 0; i < MAX_MIRRORS; i++) {
2856         struct ofmirror *mirror = ofproto->mirrors[i];
2857         if (mirror && mirror->aux == aux) {
2858             return mirror;
2859         }
2860     }
2861
2862     return NULL;
2863 }
2864
2865 /* Update the 'dup_mirrors' member of each of the ofmirrors in 'ofproto'. */
2866 static void
2867 mirror_update_dups(struct ofproto_dpif *ofproto)
2868 {
2869     int i;
2870
2871     for (i = 0; i < MAX_MIRRORS; i++) {
2872         struct ofmirror *m = ofproto->mirrors[i];
2873
2874         if (m) {
2875             m->dup_mirrors = MIRROR_MASK_C(1) << i;
2876         }
2877     }
2878
2879     for (i = 0; i < MAX_MIRRORS; i++) {
2880         struct ofmirror *m1 = ofproto->mirrors[i];
2881         int j;
2882
2883         if (!m1) {
2884             continue;
2885         }
2886
2887         for (j = i + 1; j < MAX_MIRRORS; j++) {
2888             struct ofmirror *m2 = ofproto->mirrors[j];
2889
2890             if (m2 && m1->out == m2->out && m1->out_vlan == m2->out_vlan) {
2891                 m1->dup_mirrors |= MIRROR_MASK_C(1) << j;
2892                 m2->dup_mirrors |= m1->dup_mirrors;
2893             }
2894         }
2895     }
2896 }
2897
2898 static int
2899 mirror_set(struct ofproto *ofproto_, void *aux,
2900            const struct ofproto_mirror_settings *s)
2901 {
2902     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
2903     mirror_mask_t mirror_bit;
2904     struct ofbundle *bundle;
2905     struct ofmirror *mirror;
2906     struct ofbundle *out;
2907     struct hmapx srcs;          /* Contains "struct ofbundle *"s. */
2908     struct hmapx dsts;          /* Contains "struct ofbundle *"s. */
2909     int out_vlan;
2910
2911     mirror = mirror_lookup(ofproto, aux);
2912     if (!s) {
2913         mirror_destroy(mirror);
2914         return 0;
2915     }
2916     if (!mirror) {
2917         int idx;
2918
2919         idx = mirror_scan(ofproto);
2920         if (idx < 0) {
2921             VLOG_WARN("bridge %s: maximum of %d port mirrors reached, "
2922                       "cannot create %s",
2923                       ofproto->up.name, MAX_MIRRORS, s->name);
2924             return EFBIG;
2925         }
2926
2927         mirror = ofproto->mirrors[idx] = xzalloc(sizeof *mirror);
2928         mirror->ofproto = ofproto;
2929         mirror->idx = idx;
2930         mirror->aux = aux;
2931         mirror->out_vlan = -1;
2932         mirror->name = NULL;
2933     }
2934
2935     if (!mirror->name || strcmp(s->name, mirror->name)) {
2936         free(mirror->name);
2937         mirror->name = xstrdup(s->name);
2938     }
2939
2940     /* Get the new configuration. */
2941     if (s->out_bundle) {
2942         out = bundle_lookup(ofproto, s->out_bundle);
2943         if (!out) {
2944             mirror_destroy(mirror);
2945             return EINVAL;
2946         }
2947         out_vlan = -1;
2948     } else {
2949         out = NULL;
2950         out_vlan = s->out_vlan;
2951     }
2952     bundle_lookup_multiple(ofproto, s->srcs, s->n_srcs, &srcs);
2953     bundle_lookup_multiple(ofproto, s->dsts, s->n_dsts, &dsts);
2954
2955     /* If the configuration has not changed, do nothing. */
2956     if (hmapx_equals(&srcs, &mirror->srcs)
2957         && hmapx_equals(&dsts, &mirror->dsts)
2958         && vlan_bitmap_equal(mirror->vlans, s->src_vlans)
2959         && mirror->out == out
2960         && mirror->out_vlan == out_vlan)
2961     {
2962         hmapx_destroy(&srcs);
2963         hmapx_destroy(&dsts);
2964         return 0;
2965     }
2966
2967     hmapx_swap(&srcs, &mirror->srcs);
2968     hmapx_destroy(&srcs);
2969
2970     hmapx_swap(&dsts, &mirror->dsts);
2971     hmapx_destroy(&dsts);
2972
2973     free(mirror->vlans);
2974     mirror->vlans = vlan_bitmap_clone(s->src_vlans);
2975
2976     mirror->out = out;
2977     mirror->out_vlan = out_vlan;
2978
2979     /* Update bundles. */
2980     mirror_bit = MIRROR_MASK_C(1) << mirror->idx;
2981     HMAP_FOR_EACH (bundle, hmap_node, &mirror->ofproto->bundles) {
2982         if (hmapx_contains(&mirror->srcs, bundle)) {
2983             bundle->src_mirrors |= mirror_bit;
2984         } else {
2985             bundle->src_mirrors &= ~mirror_bit;
2986         }
2987
2988         if (hmapx_contains(&mirror->dsts, bundle)) {
2989             bundle->dst_mirrors |= mirror_bit;
2990         } else {
2991             bundle->dst_mirrors &= ~mirror_bit;
2992         }
2993
2994         if (mirror->out == bundle) {
2995             bundle->mirror_out |= mirror_bit;
2996         } else {
2997             bundle->mirror_out &= ~mirror_bit;
2998         }
2999     }
3000
3001     ofproto->backer->need_revalidate = REV_RECONFIGURE;
3002     ofproto->has_mirrors = true;
3003     mac_learning_flush(ofproto->ml,
3004                        &ofproto->backer->revalidate_set);
3005     mirror_update_dups(ofproto);
3006
3007     return 0;
3008 }
3009
3010 static void
3011 mirror_destroy(struct ofmirror *mirror)
3012 {
3013     struct ofproto_dpif *ofproto;
3014     mirror_mask_t mirror_bit;
3015     struct ofbundle *bundle;
3016     int i;
3017
3018     if (!mirror) {
3019         return;
3020     }
3021
3022     ofproto = mirror->ofproto;
3023     ofproto->backer->need_revalidate = REV_RECONFIGURE;
3024     mac_learning_flush(ofproto->ml, &ofproto->backer->revalidate_set);
3025
3026     mirror_bit = MIRROR_MASK_C(1) << mirror->idx;
3027     HMAP_FOR_EACH (bundle, hmap_node, &ofproto->bundles) {
3028         bundle->src_mirrors &= ~mirror_bit;
3029         bundle->dst_mirrors &= ~mirror_bit;
3030         bundle->mirror_out &= ~mirror_bit;
3031     }
3032
3033     hmapx_destroy(&mirror->srcs);
3034     hmapx_destroy(&mirror->dsts);
3035     free(mirror->vlans);
3036
3037     ofproto->mirrors[mirror->idx] = NULL;
3038     free(mirror->name);
3039     free(mirror);
3040
3041     mirror_update_dups(ofproto);
3042
3043     ofproto->has_mirrors = false;
3044     for (i = 0; i < MAX_MIRRORS; i++) {
3045         if (ofproto->mirrors[i]) {
3046             ofproto->has_mirrors = true;
3047             break;
3048         }
3049     }
3050 }
3051
3052 static int
3053 mirror_get_stats(struct ofproto *ofproto_, void *aux,
3054                  uint64_t *packets, uint64_t *bytes)
3055 {
3056     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
3057     struct ofmirror *mirror = mirror_lookup(ofproto, aux);
3058
3059     if (!mirror) {
3060         *packets = *bytes = UINT64_MAX;
3061         return 0;
3062     }
3063
3064     push_all_stats();
3065
3066     *packets = mirror->packet_count;
3067     *bytes = mirror->byte_count;
3068
3069     return 0;
3070 }
3071
3072 static int
3073 set_flood_vlans(struct ofproto *ofproto_, unsigned long *flood_vlans)
3074 {
3075     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
3076     if (mac_learning_set_flood_vlans(ofproto->ml, flood_vlans)) {
3077         mac_learning_flush(ofproto->ml, &ofproto->backer->revalidate_set);
3078     }
3079     return 0;
3080 }
3081
3082 static bool
3083 is_mirror_output_bundle(const struct ofproto *ofproto_, void *aux)
3084 {
3085     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
3086     struct ofbundle *bundle = bundle_lookup(ofproto, aux);
3087     return bundle && bundle->mirror_out != 0;
3088 }
3089
3090 static void
3091 forward_bpdu_changed(struct ofproto *ofproto_)
3092 {
3093     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
3094     ofproto->backer->need_revalidate = REV_RECONFIGURE;
3095 }
3096
3097 static void
3098 set_mac_table_config(struct ofproto *ofproto_, unsigned int idle_time,
3099                      size_t max_entries)
3100 {
3101     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
3102     mac_learning_set_idle_time(ofproto->ml, idle_time);
3103     mac_learning_set_max_entries(ofproto->ml, max_entries);
3104 }
3105 \f
3106 /* Ports. */
3107
3108 static struct ofport_dpif *
3109 get_ofp_port(const struct ofproto_dpif *ofproto, uint16_t ofp_port)
3110 {
3111     struct ofport *ofport = ofproto_get_port(&ofproto->up, ofp_port);
3112     return ofport ? ofport_dpif_cast(ofport) : NULL;
3113 }
3114
3115 static struct ofport_dpif *
3116 get_odp_port(const struct ofproto_dpif *ofproto, uint32_t odp_port)
3117 {
3118     struct ofport_dpif *port = odp_port_to_ofport(ofproto->backer, odp_port);
3119     return port && &ofproto->up == port->up.ofproto ? port : NULL;
3120 }
3121
3122 static void
3123 ofproto_port_from_dpif_port(struct ofproto_dpif *ofproto,
3124                             struct ofproto_port *ofproto_port,
3125                             struct dpif_port *dpif_port)
3126 {
3127     ofproto_port->name = dpif_port->name;
3128     ofproto_port->type = dpif_port->type;
3129     ofproto_port->ofp_port = odp_port_to_ofp_port(ofproto, dpif_port->port_no);
3130 }
3131
3132 static struct ofport_dpif *
3133 ofport_get_peer(const struct ofport_dpif *ofport_dpif)
3134 {
3135     const struct ofproto_dpif *ofproto;
3136     const char *peer;
3137
3138     peer = netdev_vport_patch_peer(ofport_dpif->up.netdev);
3139     if (!peer) {
3140         return NULL;
3141     }
3142
3143     HMAP_FOR_EACH (ofproto, all_ofproto_dpifs_node, &all_ofproto_dpifs) {
3144         struct ofport *ofport;
3145
3146         ofport = shash_find_data(&ofproto->up.port_by_name, peer);
3147         if (ofport && ofport->ofproto->ofproto_class == &ofproto_dpif_class) {
3148             return ofport_dpif_cast(ofport);
3149         }
3150     }
3151     return NULL;
3152 }
3153
3154 static void
3155 port_run_fast(struct ofport_dpif *ofport)
3156 {
3157     if (ofport->cfm && cfm_should_send_ccm(ofport->cfm)) {
3158         struct ofpbuf packet;
3159
3160         ofpbuf_init(&packet, 0);
3161         cfm_compose_ccm(ofport->cfm, &packet, ofport->up.pp.hw_addr);
3162         send_packet(ofport, &packet);
3163         ofpbuf_uninit(&packet);
3164     }
3165
3166     if (ofport->bfd && bfd_should_send_packet(ofport->bfd)) {
3167         struct ofpbuf packet;
3168
3169         ofpbuf_init(&packet, 0);
3170         bfd_put_packet(ofport->bfd, &packet, ofport->up.pp.hw_addr);
3171         send_packet(ofport, &packet);
3172         ofpbuf_uninit(&packet);
3173     }
3174 }
3175
3176 static void
3177 port_run(struct ofport_dpif *ofport)
3178 {
3179     long long int carrier_seq = netdev_get_carrier_resets(ofport->up.netdev);
3180     bool carrier_changed = carrier_seq != ofport->carrier_seq;
3181     bool enable = netdev_get_carrier(ofport->up.netdev);
3182
3183     ofport->carrier_seq = carrier_seq;
3184
3185     port_run_fast(ofport);
3186
3187     if (ofport->tnl_port
3188         && tnl_port_reconfigure(&ofport->up, ofport->odp_port,
3189                                 &ofport->tnl_port)) {
3190         ofproto_dpif_cast(ofport->up.ofproto)->backer->need_revalidate = true;
3191     }
3192
3193     if (ofport->cfm) {
3194         int cfm_opup = cfm_get_opup(ofport->cfm);
3195
3196         cfm_run(ofport->cfm);
3197         enable = enable && !cfm_get_fault(ofport->cfm);
3198
3199         if (cfm_opup >= 0) {
3200             enable = enable && cfm_opup;
3201         }
3202     }
3203
3204     if (ofport->bfd) {
3205         bfd_run(ofport->bfd);
3206         enable = enable && bfd_forwarding(ofport->bfd);
3207     }
3208
3209     if (ofport->bundle) {
3210         enable = enable && lacp_slave_may_enable(ofport->bundle->lacp, ofport);
3211         if (carrier_changed) {
3212             lacp_slave_carrier_changed(ofport->bundle->lacp, ofport);
3213         }
3214     }
3215
3216     if (ofport->may_enable != enable) {
3217         struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofport->up.ofproto);
3218
3219         if (ofproto->has_bundle_action) {
3220             ofproto->backer->need_revalidate = REV_PORT_TOGGLED;
3221         }
3222     }
3223
3224     ofport->may_enable = enable;
3225 }
3226
3227 static void
3228 port_wait(struct ofport_dpif *ofport)
3229 {
3230     if (ofport->cfm) {
3231         cfm_wait(ofport->cfm);
3232     }
3233
3234     if (ofport->bfd) {
3235         bfd_wait(ofport->bfd);
3236     }
3237 }
3238
3239 static int
3240 port_query_by_name(const struct ofproto *ofproto_, const char *devname,
3241                    struct ofproto_port *ofproto_port)
3242 {
3243     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
3244     struct dpif_port dpif_port;
3245     int error;
3246
3247     if (sset_contains(&ofproto->ghost_ports, devname)) {
3248         const char *type = netdev_get_type_from_name(devname);
3249
3250         /* We may be called before ofproto->up.port_by_name is populated with
3251          * the appropriate ofport.  For this reason, we must get the name and
3252          * type from the netdev layer directly. */
3253         if (type) {
3254             const struct ofport *ofport;
3255
3256             ofport = shash_find_data(&ofproto->up.port_by_name, devname);
3257             ofproto_port->ofp_port = ofport ? ofport->ofp_port : OFPP_NONE;
3258             ofproto_port->name = xstrdup(devname);
3259             ofproto_port->type = xstrdup(type);
3260             return 0;
3261         }
3262         return ENODEV;
3263     }
3264
3265     if (!sset_contains(&ofproto->ports, devname)) {
3266         return ENODEV;
3267     }
3268     error = dpif_port_query_by_name(ofproto->backer->dpif,
3269                                     devname, &dpif_port);
3270     if (!error) {
3271         ofproto_port_from_dpif_port(ofproto, ofproto_port, &dpif_port);
3272     }
3273     return error;
3274 }
3275
3276 static int
3277 port_add(struct ofproto *ofproto_, struct netdev *netdev)
3278 {
3279     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
3280     const char *dp_port_name = netdev_vport_get_dpif_port(netdev);
3281     const char *devname = netdev_get_name(netdev);
3282
3283     if (netdev_vport_is_patch(netdev)) {
3284         sset_add(&ofproto->ghost_ports, netdev_get_name(netdev));
3285         return 0;
3286     }
3287
3288     if (!dpif_port_exists(ofproto->backer->dpif, dp_port_name)) {
3289         uint32_t port_no = UINT32_MAX;
3290         int error;
3291
3292         error = dpif_port_add(ofproto->backer->dpif, netdev, &port_no);
3293         if (error) {
3294             return error;
3295         }
3296         if (netdev_get_tunnel_config(netdev)) {
3297             simap_put(&ofproto->backer->tnl_backers, dp_port_name, port_no);
3298         }
3299     }
3300
3301     if (netdev_get_tunnel_config(netdev)) {
3302         sset_add(&ofproto->ghost_ports, devname);
3303     } else {
3304         sset_add(&ofproto->ports, devname);
3305     }
3306     return 0;
3307 }
3308
3309 static int
3310 port_del(struct ofproto *ofproto_, uint16_t ofp_port)
3311 {
3312     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
3313     struct ofport_dpif *ofport = get_ofp_port(ofproto, ofp_port);
3314     int error = 0;
3315
3316     if (!ofport) {
3317         return 0;
3318     }
3319
3320     sset_find_and_delete(&ofproto->ghost_ports,
3321                          netdev_get_name(ofport->up.netdev));
3322     ofproto->backer->need_revalidate = REV_RECONFIGURE;
3323     if (!ofport->tnl_port) {
3324         error = dpif_port_del(ofproto->backer->dpif, ofport->odp_port);
3325         if (!error) {
3326             /* The caller is going to close ofport->up.netdev.  If this is a
3327              * bonded port, then the bond is using that netdev, so remove it
3328              * from the bond.  The client will need to reconfigure everything
3329              * after deleting ports, so then the slave will get re-added. */
3330             bundle_remove(&ofport->up);
3331         }
3332     }
3333     return error;
3334 }
3335
3336 static int
3337 port_get_stats(const struct ofport *ofport_, struct netdev_stats *stats)
3338 {
3339     struct ofport_dpif *ofport = ofport_dpif_cast(ofport_);
3340     int error;
3341
3342     push_all_stats();
3343
3344     error = netdev_get_stats(ofport->up.netdev, stats);
3345
3346     if (!error && ofport_->ofp_port == OFPP_LOCAL) {
3347         struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofport->up.ofproto);
3348
3349         /* ofproto->stats.tx_packets represents packets that we created
3350          * internally and sent to some port (e.g. packets sent with
3351          * send_packet()).  Account for them as if they had come from
3352          * OFPP_LOCAL and got forwarded. */
3353
3354         if (stats->rx_packets != UINT64_MAX) {
3355             stats->rx_packets += ofproto->stats.tx_packets;
3356         }
3357
3358         if (stats->rx_bytes != UINT64_MAX) {
3359             stats->rx_bytes += ofproto->stats.tx_bytes;
3360         }
3361
3362         /* ofproto->stats.rx_packets represents packets that were received on
3363          * some port and we processed internally and dropped (e.g. STP).
3364          * Account for them as if they had been forwarded to OFPP_LOCAL. */
3365
3366         if (stats->tx_packets != UINT64_MAX) {
3367             stats->tx_packets += ofproto->stats.rx_packets;
3368         }
3369
3370         if (stats->tx_bytes != UINT64_MAX) {
3371             stats->tx_bytes += ofproto->stats.rx_bytes;
3372         }
3373     }
3374
3375     return error;
3376 }
3377
3378 /* Account packets for LOCAL port. */
3379 static void
3380 ofproto_update_local_port_stats(const struct ofproto *ofproto_,
3381                                 size_t tx_size, size_t rx_size)
3382 {
3383     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
3384
3385     if (rx_size) {
3386         ofproto->stats.rx_packets++;
3387         ofproto->stats.rx_bytes += rx_size;
3388     }
3389     if (tx_size) {
3390         ofproto->stats.tx_packets++;
3391         ofproto->stats.tx_bytes += tx_size;
3392     }
3393 }
3394
3395 struct port_dump_state {
3396     uint32_t bucket;
3397     uint32_t offset;
3398     bool ghost;
3399
3400     struct ofproto_port port;
3401     bool has_port;
3402 };
3403
3404 static int
3405 port_dump_start(const struct ofproto *ofproto_ OVS_UNUSED, void **statep)
3406 {
3407     *statep = xzalloc(sizeof(struct port_dump_state));
3408     return 0;
3409 }
3410
3411 static int
3412 port_dump_next(const struct ofproto *ofproto_, void *state_,
3413                struct ofproto_port *port)
3414 {
3415     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
3416     struct port_dump_state *state = state_;
3417     const struct sset *sset;
3418     struct sset_node *node;
3419
3420     if (state->has_port) {
3421         ofproto_port_destroy(&state->port);
3422         state->has_port = false;
3423     }
3424     sset = state->ghost ? &ofproto->ghost_ports : &ofproto->ports;
3425     while ((node = sset_at_position(sset, &state->bucket, &state->offset))) {
3426         int error;
3427
3428         error = port_query_by_name(ofproto_, node->name, &state->port);
3429         if (!error) {
3430             *port = state->port;
3431             state->has_port = true;
3432             return 0;
3433         } else if (error != ENODEV) {
3434             return error;
3435         }
3436     }
3437
3438     if (!state->ghost) {
3439         state->ghost = true;
3440         state->bucket = 0;
3441         state->offset = 0;
3442         return port_dump_next(ofproto_, state_, port);
3443     }
3444
3445     return EOF;
3446 }
3447
3448 static int
3449 port_dump_done(const struct ofproto *ofproto_ OVS_UNUSED, void *state_)
3450 {
3451     struct port_dump_state *state = state_;
3452
3453     if (state->has_port) {
3454         ofproto_port_destroy(&state->port);
3455     }
3456     free(state);
3457     return 0;
3458 }
3459
3460 static int
3461 port_poll(const struct ofproto *ofproto_, char **devnamep)
3462 {
3463     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
3464
3465     if (ofproto->port_poll_errno) {
3466         int error = ofproto->port_poll_errno;
3467         ofproto->port_poll_errno = 0;
3468         return error;
3469     }
3470
3471     if (sset_is_empty(&ofproto->port_poll_set)) {
3472         return EAGAIN;
3473     }
3474
3475     *devnamep = sset_pop(&ofproto->port_poll_set);
3476     return 0;
3477 }
3478
3479 static void
3480 port_poll_wait(const struct ofproto *ofproto_)
3481 {
3482     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
3483     dpif_port_poll_wait(ofproto->backer->dpif);
3484 }
3485
3486 static int
3487 port_is_lacp_current(const struct ofport *ofport_)
3488 {
3489     const struct ofport_dpif *ofport = ofport_dpif_cast(ofport_);
3490     return (ofport->bundle && ofport->bundle->lacp
3491             ? lacp_slave_is_current(ofport->bundle->lacp, ofport)
3492             : -1);
3493 }
3494 \f
3495 /* Upcall handling. */
3496
3497 /* Flow miss batching.
3498  *
3499  * Some dpifs implement operations faster when you hand them off in a batch.
3500  * To allow batching, "struct flow_miss" queues the dpif-related work needed
3501  * for a given flow.  Each "struct flow_miss" corresponds to sending one or
3502  * more packets, plus possibly installing the flow in the dpif.
3503  *
3504  * So far we only batch the operations that affect flow setup time the most.
3505  * It's possible to batch more than that, but the benefit might be minimal. */
3506 struct flow_miss {
3507     struct hmap_node hmap_node;
3508     struct ofproto_dpif *ofproto;
3509     struct flow flow;
3510     enum odp_key_fitness key_fitness;
3511     const struct nlattr *key;
3512     size_t key_len;
3513     struct initial_vals initial_vals;
3514     struct list packets;
3515     enum dpif_upcall_type upcall_type;
3516     uint32_t odp_in_port;
3517 };
3518
3519 struct flow_miss_op {
3520     struct dpif_op dpif_op;
3521     void *garbage;              /* Pointer to pass to free(), NULL if none. */
3522     uint64_t stub[1024 / 8];    /* Temporary buffer. */
3523 };
3524
3525 /* Sends an OFPT_PACKET_IN message for 'packet' of type OFPR_NO_MATCH to each
3526  * OpenFlow controller as necessary according to their individual
3527  * configurations. */
3528 static void
3529 send_packet_in_miss(struct ofproto_dpif *ofproto, const struct ofpbuf *packet,
3530                     const struct flow *flow)
3531 {
3532     struct ofputil_packet_in pin;
3533
3534     pin.packet = packet->data;
3535     pin.packet_len = packet->size;
3536     pin.reason = OFPR_NO_MATCH;
3537     pin.controller_id = 0;
3538
3539     pin.table_id = 0;
3540     pin.cookie = 0;
3541
3542     pin.send_len = 0;           /* not used for flow table misses */
3543
3544     flow_get_metadata(flow, &pin.fmd);
3545
3546     connmgr_send_packet_in(ofproto->up.connmgr, &pin);
3547 }
3548
3549 static enum slow_path_reason
3550 process_special(struct ofproto_dpif *ofproto, const struct flow *flow,
3551                 const struct ofport_dpif *ofport, const struct ofpbuf *packet)
3552 {
3553     if (!ofport) {
3554         return 0;
3555     } else if (ofport->cfm && cfm_should_process_flow(ofport->cfm, flow)) {
3556         if (packet) {
3557             cfm_process_heartbeat(ofport->cfm, packet);
3558         }
3559         return SLOW_CFM;
3560     } else if (ofport->bfd && bfd_should_process_flow(flow)) {
3561         if (packet) {
3562             bfd_process_packet(ofport->bfd, flow, packet);
3563         }
3564         return SLOW_BFD;
3565     } else if (ofport->bundle && ofport->bundle->lacp
3566                && flow->dl_type == htons(ETH_TYPE_LACP)) {
3567         if (packet) {
3568             lacp_process_packet(ofport->bundle->lacp, ofport, packet);
3569         }
3570         return SLOW_LACP;
3571     } else if (ofproto->stp && stp_should_process_flow(flow)) {
3572         if (packet) {
3573             stp_process_packet(ofport, packet);
3574         }
3575         return SLOW_STP;
3576     } else {
3577         return 0;
3578     }
3579 }
3580
3581 static struct flow_miss *
3582 flow_miss_find(struct hmap *todo, const struct ofproto_dpif *ofproto,
3583                const struct flow *flow, uint32_t hash)
3584 {
3585     struct flow_miss *miss;
3586
3587     HMAP_FOR_EACH_WITH_HASH (miss, hmap_node, hash, todo) {
3588         if (miss->ofproto == ofproto && flow_equal(&miss->flow, flow)) {
3589             return miss;
3590         }
3591     }
3592
3593     return NULL;
3594 }
3595
3596 /* Partially Initializes 'op' as an "execute" operation for 'miss' and
3597  * 'packet'.  The caller must initialize op->actions and op->actions_len.  If
3598  * 'miss' is associated with a subfacet the caller must also initialize the
3599  * returned op->subfacet, and if anything needs to be freed after processing
3600  * the op, the caller must initialize op->garbage also. */
3601 static void
3602 init_flow_miss_execute_op(struct flow_miss *miss, struct ofpbuf *packet,
3603                           struct flow_miss_op *op)
3604 {
3605     if (miss->flow.vlan_tci != miss->initial_vals.vlan_tci) {
3606         /* This packet was received on a VLAN splinter port.  We
3607          * added a VLAN to the packet to make the packet resemble
3608          * the flow, but the actions were composed assuming that
3609          * the packet contained no VLAN.  So, we must remove the
3610          * VLAN header from the packet before trying to execute the
3611          * actions. */
3612         eth_pop_vlan(packet);
3613     }
3614
3615     op->garbage = NULL;
3616     op->dpif_op.type = DPIF_OP_EXECUTE;
3617     op->dpif_op.u.execute.key = miss->key;
3618     op->dpif_op.u.execute.key_len = miss->key_len;
3619     op->dpif_op.u.execute.packet = packet;
3620 }
3621
3622 /* Helper for handle_flow_miss_without_facet() and
3623  * handle_flow_miss_with_facet(). */
3624 static void
3625 handle_flow_miss_common(struct rule_dpif *rule,
3626                         struct ofpbuf *packet, const struct flow *flow)
3627 {
3628     struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
3629
3630     ofproto->n_matches++;
3631
3632     if (rule->up.cr.priority == FAIL_OPEN_PRIORITY) {
3633         /*
3634          * Extra-special case for fail-open mode.
3635          *
3636          * We are in fail-open mode and the packet matched the fail-open
3637          * rule, but we are connected to a controller too.  We should send
3638          * the packet up to the controller in the hope that it will try to
3639          * set up a flow and thereby allow us to exit fail-open.
3640          *
3641          * See the top-level comment in fail-open.c for more information.
3642          */
3643         send_packet_in_miss(ofproto, packet, flow);
3644     }
3645 }
3646
3647 /* Figures out whether a flow that missed in 'ofproto', whose details are in
3648  * 'miss', is likely to be worth tracking in detail in userspace and (usually)
3649  * installing a datapath flow.  The answer is usually "yes" (a return value of
3650  * true).  However, for short flows the cost of bookkeeping is much higher than
3651  * the benefits, so when the datapath holds a large number of flows we impose
3652  * some heuristics to decide which flows are likely to be worth tracking. */
3653 static bool
3654 flow_miss_should_make_facet(struct ofproto_dpif *ofproto,
3655                             struct flow_miss *miss, uint32_t hash)
3656 {
3657     if (!ofproto->governor) {
3658         size_t n_subfacets;
3659
3660         n_subfacets = hmap_count(&ofproto->subfacets);
3661         if (n_subfacets * 2 <= ofproto->up.flow_eviction_threshold) {
3662             return true;
3663         }
3664
3665         ofproto->governor = governor_create(ofproto->up.name);
3666     }
3667
3668     return governor_should_install_flow(ofproto->governor, hash,
3669                                         list_size(&miss->packets));
3670 }
3671
3672 /* Handles 'miss', which matches 'rule', without creating a facet or subfacet
3673  * or creating any datapath flow.  May add an "execute" operation to 'ops' and
3674  * increment '*n_ops'. */
3675 static void
3676 handle_flow_miss_without_facet(struct flow_miss *miss,
3677                                struct rule_dpif *rule,
3678                                struct flow_miss_op *ops, size_t *n_ops)
3679 {
3680     struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
3681     long long int now = time_msec();
3682     struct action_xlate_ctx ctx;
3683     struct ofpbuf *packet;
3684
3685     LIST_FOR_EACH (packet, list_node, &miss->packets) {
3686         struct flow_miss_op *op = &ops[*n_ops];
3687         struct dpif_flow_stats stats;
3688         struct ofpbuf odp_actions;
3689
3690         COVERAGE_INC(facet_suppress);
3691
3692         ofpbuf_use_stub(&odp_actions, op->stub, sizeof op->stub);
3693
3694         dpif_flow_stats_extract(&miss->flow, packet, now, &stats);
3695         rule_credit_stats(rule, &stats);
3696
3697         action_xlate_ctx_init(&ctx, ofproto, &miss->flow,
3698                               &miss->initial_vals, rule, 0, packet);
3699         ctx.resubmit_stats = &stats;
3700         xlate_actions(&ctx, rule->up.ofpacts, rule->up.ofpacts_len,
3701                       &odp_actions);
3702
3703         if (odp_actions.size) {
3704             struct dpif_execute *execute = &op->dpif_op.u.execute;
3705
3706             init_flow_miss_execute_op(miss, packet, op);
3707             execute->actions = odp_actions.data;
3708             execute->actions_len = odp_actions.size;
3709             op->garbage = ofpbuf_get_uninit_pointer(&odp_actions);
3710
3711             (*n_ops)++;
3712         } else {
3713             ofpbuf_uninit(&odp_actions);
3714         }
3715     }
3716 }
3717
3718 /* Handles 'miss', which matches 'facet'.  May add any required datapath
3719  * operations to 'ops', incrementing '*n_ops' for each new op.
3720  *
3721  * All of the packets in 'miss' are considered to have arrived at time 'now'.
3722  * This is really important only for new facets: if we just called time_msec()
3723  * here, then the new subfacet or its packets could look (occasionally) as
3724  * though it was used some time after the facet was used.  That can make a
3725  * one-packet flow look like it has a nonzero duration, which looks odd in
3726  * e.g. NetFlow statistics. */
3727 static void
3728 handle_flow_miss_with_facet(struct flow_miss *miss, struct facet *facet,
3729                             long long int now,
3730                             struct flow_miss_op *ops, size_t *n_ops)
3731 {
3732     struct ofproto_dpif *ofproto = ofproto_dpif_cast(facet->rule->up.ofproto);
3733     enum subfacet_path want_path;
3734     struct subfacet *subfacet;
3735     struct ofpbuf *packet;
3736
3737     subfacet = subfacet_create(facet, miss, now);
3738
3739     LIST_FOR_EACH (packet, list_node, &miss->packets) {
3740         struct flow_miss_op *op = &ops[*n_ops];
3741         struct dpif_flow_stats stats;
3742         struct ofpbuf odp_actions;
3743
3744         handle_flow_miss_common(facet->rule, packet, &miss->flow);
3745
3746         ofpbuf_use_stub(&odp_actions, op->stub, sizeof op->stub);
3747         if (!subfacet->actions || subfacet->slow) {
3748             subfacet_make_actions(subfacet, packet, &odp_actions);
3749         }
3750
3751         dpif_flow_stats_extract(&facet->flow, packet, now, &stats);
3752         subfacet_update_stats(subfacet, &stats);
3753
3754         if (subfacet->actions_len) {
3755             struct dpif_execute *execute = &op->dpif_op.u.execute;
3756
3757             init_flow_miss_execute_op(miss, packet, op);
3758             if (!subfacet->slow) {
3759                 execute->actions = subfacet->actions;
3760                 execute->actions_len = subfacet->actions_len;
3761                 ofpbuf_uninit(&odp_actions);
3762             } else {
3763                 execute->actions = odp_actions.data;
3764                 execute->actions_len = odp_actions.size;
3765                 op->garbage = ofpbuf_get_uninit_pointer(&odp_actions);
3766             }
3767
3768             (*n_ops)++;
3769         } else {
3770             ofpbuf_uninit(&odp_actions);
3771         }
3772     }
3773
3774     want_path = subfacet_want_path(subfacet->slow);
3775     if (miss->upcall_type == DPIF_UC_MISS || subfacet->path != want_path) {
3776         struct flow_miss_op *op = &ops[(*n_ops)++];
3777         struct dpif_flow_put *put = &op->dpif_op.u.flow_put;
3778
3779         subfacet->path = want_path;
3780
3781         op->garbage = NULL;
3782         op->dpif_op.type = DPIF_OP_FLOW_PUT;
3783         put->flags = DPIF_FP_CREATE | DPIF_FP_MODIFY;
3784         put->key = miss->key;
3785         put->key_len = miss->key_len;
3786         if (want_path == SF_FAST_PATH) {
3787             put->actions = subfacet->actions;
3788             put->actions_len = subfacet->actions_len;
3789         } else {
3790             compose_slow_path(ofproto, &facet->flow, subfacet->slow,
3791                               op->stub, sizeof op->stub,
3792                               &put->actions, &put->actions_len);
3793         }
3794         put->stats = NULL;
3795     }
3796 }
3797
3798 /* Handles flow miss 'miss'.  May add any required datapath operations
3799  * to 'ops', incrementing '*n_ops' for each new op. */
3800 static void
3801 handle_flow_miss(struct flow_miss *miss, struct flow_miss_op *ops,
3802                  size_t *n_ops)
3803 {
3804     struct ofproto_dpif *ofproto = miss->ofproto;
3805     struct facet *facet;
3806     long long int now;
3807     uint32_t hash;
3808
3809     /* The caller must ensure that miss->hmap_node.hash contains
3810      * flow_hash(miss->flow, 0). */
3811     hash = miss->hmap_node.hash;
3812
3813     facet = facet_lookup_valid(ofproto, &miss->flow, hash);
3814     if (!facet) {
3815         struct rule_dpif *rule = rule_dpif_lookup(ofproto, &miss->flow);
3816
3817         if (!flow_miss_should_make_facet(ofproto, miss, hash)) {
3818             handle_flow_miss_without_facet(miss, rule, ops, n_ops);
3819             return;
3820         }
3821
3822         facet = facet_create(rule, &miss->flow, hash);
3823         now = facet->used;
3824     } else {
3825         now = time_msec();
3826     }
3827     handle_flow_miss_with_facet(miss, facet, now, ops, n_ops);
3828 }
3829
3830 static struct drop_key *
3831 drop_key_lookup(const struct dpif_backer *backer, const struct nlattr *key,
3832                 size_t key_len)
3833 {
3834     struct drop_key *drop_key;
3835
3836     HMAP_FOR_EACH_WITH_HASH (drop_key, hmap_node, hash_bytes(key, key_len, 0),
3837                              &backer->drop_keys) {
3838         if (drop_key->key_len == key_len
3839             && !memcmp(drop_key->key, key, key_len)) {
3840             return drop_key;
3841         }
3842     }
3843     return NULL;
3844 }
3845
3846 static void
3847 drop_key_clear(struct dpif_backer *backer)
3848 {
3849     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 15);
3850     struct drop_key *drop_key, *next;
3851
3852     HMAP_FOR_EACH_SAFE (drop_key, next, hmap_node, &backer->drop_keys) {
3853         int error;
3854
3855         error = dpif_flow_del(backer->dpif, drop_key->key, drop_key->key_len,
3856                               NULL);
3857         if (error && !VLOG_DROP_WARN(&rl)) {
3858             struct ds ds = DS_EMPTY_INITIALIZER;
3859             odp_flow_key_format(drop_key->key, drop_key->key_len, &ds);
3860             VLOG_WARN("Failed to delete drop key (%s) (%s)", strerror(error),
3861                       ds_cstr(&ds));
3862             ds_destroy(&ds);
3863         }
3864
3865         hmap_remove(&backer->drop_keys, &drop_key->hmap_node);
3866         free(drop_key->key);
3867         free(drop_key);
3868     }
3869 }
3870
3871 /* Given a datpath, packet, and flow metadata ('backer', 'packet', and 'key'
3872  * respectively), populates 'flow' with the result of odp_flow_key_to_flow().
3873  * Optionally, if nonnull, populates 'fitnessp' with the fitness of 'flow' as
3874  * returned by odp_flow_key_to_flow().  Also, optionally populates 'ofproto'
3875  * with the ofproto_dpif, and 'odp_in_port' with the datapath in_port, that
3876  * 'packet' ingressed.
3877  *
3878  * If 'ofproto' is nonnull, requires 'flow''s in_port to exist.  Otherwise sets
3879  * 'flow''s in_port to OFPP_NONE.
3880  *
3881  * This function does post-processing on data returned from
3882  * odp_flow_key_to_flow() to help make VLAN splinters transparent to the rest
3883  * of the upcall processing logic.  In particular, if the extracted in_port is
3884  * a VLAN splinter port, it replaces flow->in_port by the "real" port, sets
3885  * flow->vlan_tci correctly for the VLAN of the VLAN splinter port, and pushes
3886  * a VLAN header onto 'packet' (if it is nonnull).
3887  *
3888  * Optionally, if 'initial_vals' is nonnull, sets 'initial_vals->vlan_tci'
3889  * to the VLAN TCI with which the packet was really received, that is, the
3890  * actual VLAN TCI extracted by odp_flow_key_to_flow().  (This differs from
3891  * the value returned in flow->vlan_tci only for packets received on
3892  * VLAN splinters.)
3893  *
3894  * Similarly, this function also includes some logic to help with tunnels.  It
3895  * may modify 'flow' as necessary to make the tunneling implementation
3896  * transparent to the upcall processing logic.
3897  *
3898  * Returns 0 if successful, ENODEV if the parsed flow has no associated ofport,
3899  * or some other positive errno if there are other problems. */
3900 static int
3901 ofproto_receive(const struct dpif_backer *backer, struct ofpbuf *packet,
3902                 const struct nlattr *key, size_t key_len,
3903                 struct flow *flow, enum odp_key_fitness *fitnessp,
3904                 struct ofproto_dpif **ofproto, uint32_t *odp_in_port,
3905                 struct initial_vals *initial_vals)
3906 {
3907     const struct ofport_dpif *port;
3908     enum odp_key_fitness fitness;
3909     int error = ENODEV;
3910
3911     fitness = odp_flow_key_to_flow(key, key_len, flow);
3912     if (fitness == ODP_FIT_ERROR) {
3913         error = EINVAL;
3914         goto exit;
3915     }
3916
3917     if (initial_vals) {
3918         initial_vals->vlan_tci = flow->vlan_tci;
3919     }
3920
3921     if (odp_in_port) {
3922         *odp_in_port = flow->in_port;
3923     }
3924
3925     if (tnl_port_should_receive(flow)) {
3926         const struct ofport *ofport = tnl_port_receive(flow);
3927         if (!ofport) {
3928             flow->in_port = OFPP_NONE;
3929             goto exit;
3930         }
3931         port = ofport_dpif_cast(ofport);
3932
3933         /* XXX: Since the tunnel module is not scoped per backer, it's
3934          * theoretically possible that we'll receive an ofport belonging to an
3935          * entirely different datapath.  In practice, this can't happen because
3936          * no platforms has two separate datapaths which each support
3937          * tunneling. */
3938         ovs_assert(ofproto_dpif_cast(port->up.ofproto)->backer == backer);
3939     } else {
3940         port = odp_port_to_ofport(backer, flow->in_port);
3941         if (!port) {
3942             flow->in_port = OFPP_NONE;
3943             goto exit;
3944         }
3945
3946         flow->in_port = port->up.ofp_port;
3947         if (vsp_adjust_flow(ofproto_dpif_cast(port->up.ofproto), flow)) {
3948             if (packet) {
3949                 /* Make the packet resemble the flow, so that it gets sent to
3950                  * an OpenFlow controller properly, so that it looks correct
3951                  * for sFlow, and so that flow_extract() will get the correct
3952                  * vlan_tci if it is called on 'packet'.
3953                  *
3954                  * The allocated space inside 'packet' probably also contains
3955                  * 'key', that is, both 'packet' and 'key' are probably part of
3956                  * a struct dpif_upcall (see the large comment on that
3957                  * structure definition), so pushing data on 'packet' is in
3958                  * general not a good idea since it could overwrite 'key' or
3959                  * free it as a side effect.  However, it's OK in this special
3960                  * case because we know that 'packet' is inside a Netlink
3961                  * attribute: pushing 4 bytes will just overwrite the 4-byte
3962                  * "struct nlattr", which is fine since we don't need that
3963                  * header anymore. */
3964                 eth_push_vlan(packet, flow->vlan_tci);
3965             }
3966             /* We can't reproduce 'key' from 'flow'. */
3967             fitness = fitness == ODP_FIT_PERFECT ? ODP_FIT_TOO_MUCH : fitness;
3968         }
3969     }
3970     error = 0;
3971
3972     if (ofproto) {
3973         *ofproto = ofproto_dpif_cast(port->up.ofproto);
3974     }
3975
3976 exit:
3977     if (fitnessp) {
3978         *fitnessp = fitness;
3979     }
3980     return error;
3981 }
3982
3983 static void
3984 handle_miss_upcalls(struct dpif_backer *backer, struct dpif_upcall *upcalls,
3985                     size_t n_upcalls)
3986 {
3987     struct dpif_upcall *upcall;
3988     struct flow_miss *miss;
3989     struct flow_miss misses[FLOW_MISS_MAX_BATCH];
3990     struct flow_miss_op flow_miss_ops[FLOW_MISS_MAX_BATCH * 2];
3991     struct dpif_op *dpif_ops[FLOW_MISS_MAX_BATCH * 2];
3992     struct hmap todo;
3993     int n_misses;
3994     size_t n_ops;
3995     size_t i;
3996
3997     if (!n_upcalls) {
3998         return;
3999     }
4000
4001     /* Construct the to-do list.
4002      *
4003      * This just amounts to extracting the flow from each packet and sticking
4004      * the packets that have the same flow in the same "flow_miss" structure so
4005      * that we can process them together. */
4006     hmap_init(&todo);
4007     n_misses = 0;
4008     for (upcall = upcalls; upcall < &upcalls[n_upcalls]; upcall++) {
4009         struct flow_miss *miss = &misses[n_misses];
4010         struct flow_miss *existing_miss;
4011         struct ofproto_dpif *ofproto;
4012         uint32_t odp_in_port;
4013         struct flow flow;
4014         uint32_t hash;
4015         int error;
4016
4017         error = ofproto_receive(backer, upcall->packet, upcall->key,
4018                                 upcall->key_len, &flow, &miss->key_fitness,
4019                                 &ofproto, &odp_in_port, &miss->initial_vals);
4020         if (error == ENODEV) {
4021             struct drop_key *drop_key;
4022
4023             /* Received packet on port for which we couldn't associate
4024              * an ofproto.  This can happen if a port is removed while
4025              * traffic is being received.  Print a rate-limited message
4026              * in case it happens frequently.  Install a drop flow so
4027              * that future packets of the flow are inexpensively dropped
4028              * in the kernel. */
4029             VLOG_INFO_RL(&rl, "received packet on unassociated port %"PRIu32,
4030                          flow.in_port);
4031
4032             drop_key = drop_key_lookup(backer, upcall->key, upcall->key_len);
4033             if (!drop_key) {
4034                 drop_key = xmalloc(sizeof *drop_key);
4035                 drop_key->key = xmemdup(upcall->key, upcall->key_len);
4036                 drop_key->key_len = upcall->key_len;
4037
4038                 hmap_insert(&backer->drop_keys, &drop_key->hmap_node,
4039                             hash_bytes(drop_key->key, drop_key->key_len, 0));
4040                 dpif_flow_put(backer->dpif, DPIF_FP_CREATE | DPIF_FP_MODIFY,
4041                               drop_key->key, drop_key->key_len, NULL, 0, NULL);
4042             }
4043             continue;
4044         }
4045         if (error) {
4046             continue;
4047         }
4048
4049         ofproto->n_missed++;
4050         flow_extract(upcall->packet, flow.skb_priority, flow.skb_mark,
4051                      &flow.tunnel, flow.in_port, &miss->flow);
4052
4053         /* Add other packets to a to-do list. */
4054         hash = flow_hash(&miss->flow, 0);
4055         existing_miss = flow_miss_find(&todo, ofproto, &miss->flow, hash);
4056         if (!existing_miss) {
4057             hmap_insert(&todo, &miss->hmap_node, hash);
4058             miss->ofproto = ofproto;
4059             miss->key = upcall->key;
4060             miss->key_len = upcall->key_len;
4061             miss->upcall_type = upcall->type;
4062             miss->odp_in_port = odp_in_port;
4063             list_init(&miss->packets);
4064
4065             n_misses++;
4066         } else {
4067             miss = existing_miss;
4068         }
4069         list_push_back(&miss->packets, &upcall->packet->list_node);
4070     }
4071
4072     /* Process each element in the to-do list, constructing the set of
4073      * operations to batch. */
4074     n_ops = 0;
4075     HMAP_FOR_EACH (miss, hmap_node, &todo) {
4076         handle_flow_miss(miss, flow_miss_ops, &n_ops);
4077     }
4078     ovs_assert(n_ops <= ARRAY_SIZE(flow_miss_ops));
4079
4080     /* Execute batch. */
4081     for (i = 0; i < n_ops; i++) {
4082         dpif_ops[i] = &flow_miss_ops[i].dpif_op;
4083     }
4084     dpif_operate(backer->dpif, dpif_ops, n_ops);
4085
4086     /* Free memory. */
4087     for (i = 0; i < n_ops; i++) {
4088         free(flow_miss_ops[i].garbage);
4089     }
4090     hmap_destroy(&todo);
4091 }
4092
4093 static enum { SFLOW_UPCALL, MISS_UPCALL, BAD_UPCALL, FLOW_SAMPLE_UPCALL,
4094               IPFIX_UPCALL }
4095 classify_upcall(const struct dpif_upcall *upcall)
4096 {
4097     size_t userdata_len;
4098     union user_action_cookie cookie;
4099
4100     /* First look at the upcall type. */
4101     switch (upcall->type) {
4102     case DPIF_UC_ACTION:
4103         break;
4104
4105     case DPIF_UC_MISS:
4106         return MISS_UPCALL;
4107
4108     case DPIF_N_UC_TYPES:
4109     default:
4110         VLOG_WARN_RL(&rl, "upcall has unexpected type %"PRIu32, upcall->type);
4111         return BAD_UPCALL;
4112     }
4113
4114     /* "action" upcalls need a closer look. */
4115     if (!upcall->userdata) {
4116         VLOG_WARN_RL(&rl, "action upcall missing cookie");
4117         return BAD_UPCALL;
4118     }
4119     userdata_len = nl_attr_get_size(upcall->userdata);
4120     if (userdata_len < sizeof cookie.type
4121         || userdata_len > sizeof cookie) {
4122         VLOG_WARN_RL(&rl, "action upcall cookie has unexpected size %zu",
4123                      userdata_len);
4124         return BAD_UPCALL;
4125     }
4126     memset(&cookie, 0, sizeof cookie);
4127     memcpy(&cookie, nl_attr_get(upcall->userdata), userdata_len);
4128     if (userdata_len == sizeof cookie.sflow
4129         && cookie.type == USER_ACTION_COOKIE_SFLOW) {
4130         return SFLOW_UPCALL;
4131     } else if (userdata_len == sizeof cookie.slow_path
4132                && cookie.type == USER_ACTION_COOKIE_SLOW_PATH) {
4133         return MISS_UPCALL;
4134     } else if (userdata_len == sizeof cookie.flow_sample
4135                && cookie.type == USER_ACTION_COOKIE_FLOW_SAMPLE) {
4136         return FLOW_SAMPLE_UPCALL;
4137     } else if (userdata_len == sizeof cookie.ipfix
4138                && cookie.type == USER_ACTION_COOKIE_IPFIX) {
4139         return IPFIX_UPCALL;
4140     } else {
4141         VLOG_WARN_RL(&rl, "invalid user cookie of type %"PRIu16
4142                      " and size %zu", cookie.type, userdata_len);
4143         return BAD_UPCALL;
4144     }
4145 }
4146
4147 static void
4148 handle_sflow_upcall(struct dpif_backer *backer,
4149                     const struct dpif_upcall *upcall)
4150 {
4151     struct ofproto_dpif *ofproto;
4152     union user_action_cookie cookie;
4153     struct flow flow;
4154     uint32_t odp_in_port;
4155
4156     if (ofproto_receive(backer, upcall->packet, upcall->key, upcall->key_len,
4157                         &flow, NULL, &ofproto, &odp_in_port, NULL)
4158         || !ofproto->sflow) {
4159         return;
4160     }
4161
4162     memset(&cookie, 0, sizeof cookie);
4163     memcpy(&cookie, nl_attr_get(upcall->userdata), sizeof cookie.sflow);
4164     dpif_sflow_received(ofproto->sflow, upcall->packet, &flow,
4165                         odp_in_port, &cookie);
4166 }
4167
4168 static void
4169 handle_flow_sample_upcall(struct dpif_backer *backer,
4170                           const struct dpif_upcall *upcall)
4171 {
4172     struct ofproto_dpif *ofproto;
4173     union user_action_cookie cookie;
4174     struct flow flow;
4175
4176     if (ofproto_receive(backer, upcall->packet, upcall->key, upcall->key_len,
4177                         &flow, NULL, &ofproto, NULL, NULL)
4178         || !ofproto->ipfix) {
4179         return;
4180     }
4181
4182     memset(&cookie, 0, sizeof cookie);
4183     memcpy(&cookie, nl_attr_get(upcall->userdata), sizeof cookie.flow_sample);
4184
4185     /* The flow reflects exactly the contents of the packet.  Sample
4186      * the packet using it. */
4187     dpif_ipfix_flow_sample(ofproto->ipfix, upcall->packet, &flow,
4188                            cookie.flow_sample.collector_set_id,
4189                            cookie.flow_sample.probability,
4190                            cookie.flow_sample.obs_domain_id,
4191                            cookie.flow_sample.obs_point_id);
4192 }
4193
4194 static void
4195 handle_ipfix_upcall(struct dpif_backer *backer,
4196                     const struct dpif_upcall *upcall)
4197 {
4198     struct ofproto_dpif *ofproto;
4199     struct flow flow;
4200
4201     if (ofproto_receive(backer, upcall->packet, upcall->key, upcall->key_len,
4202                         &flow, NULL, &ofproto, NULL, NULL)
4203         || !ofproto->ipfix) {
4204         return;
4205     }
4206
4207     /* The flow reflects exactly the contents of the packet.  Sample
4208      * the packet using it. */
4209     dpif_ipfix_bridge_sample(ofproto->ipfix, upcall->packet, &flow);
4210 }
4211
4212 static int
4213 handle_upcalls(struct dpif_backer *backer, unsigned int max_batch)
4214 {
4215     struct dpif_upcall misses[FLOW_MISS_MAX_BATCH];
4216     struct ofpbuf miss_bufs[FLOW_MISS_MAX_BATCH];
4217     uint64_t miss_buf_stubs[FLOW_MISS_MAX_BATCH][4096 / 8];
4218     int n_processed;
4219     int n_misses;
4220     int i;
4221
4222     ovs_assert(max_batch <= FLOW_MISS_MAX_BATCH);
4223
4224     n_misses = 0;
4225     for (n_processed = 0; n_processed < max_batch; n_processed++) {
4226         struct dpif_upcall *upcall = &misses[n_misses];
4227         struct ofpbuf *buf = &miss_bufs[n_misses];
4228         int error;
4229
4230         ofpbuf_use_stub(buf, miss_buf_stubs[n_misses],
4231                         sizeof miss_buf_stubs[n_misses]);
4232         error = dpif_recv(backer->dpif, upcall, buf);
4233         if (error) {
4234             ofpbuf_uninit(buf);
4235             break;
4236         }
4237
4238         switch (classify_upcall(upcall)) {
4239         case MISS_UPCALL:
4240             /* Handle it later. */
4241             n_misses++;
4242             break;
4243
4244         case SFLOW_UPCALL:
4245             handle_sflow_upcall(backer, upcall);
4246             ofpbuf_uninit(buf);
4247             break;
4248
4249         case FLOW_SAMPLE_UPCALL:
4250             handle_flow_sample_upcall(backer, upcall);
4251             ofpbuf_uninit(buf);
4252             break;
4253
4254         case IPFIX_UPCALL:
4255             handle_ipfix_upcall(backer, upcall);
4256             ofpbuf_uninit(buf);
4257             break;
4258
4259         case BAD_UPCALL:
4260             ofpbuf_uninit(buf);
4261             break;
4262         }
4263     }
4264
4265     /* Handle deferred MISS_UPCALL processing. */
4266     handle_miss_upcalls(backer, misses, n_misses);
4267     for (i = 0; i < n_misses; i++) {
4268         ofpbuf_uninit(&miss_bufs[i]);
4269     }
4270
4271     return n_processed;
4272 }
4273 \f
4274 /* Flow expiration. */
4275
4276 static int subfacet_max_idle(const struct ofproto_dpif *);
4277 static void update_stats(struct dpif_backer *);
4278 static void rule_expire(struct rule_dpif *);
4279 static void expire_subfacets(struct ofproto_dpif *, int dp_max_idle);
4280
4281 /* This function is called periodically by run().  Its job is to collect
4282  * updates for the flows that have been installed into the datapath, most
4283  * importantly when they last were used, and then use that information to
4284  * expire flows that have not been used recently.
4285  *
4286  * Returns the number of milliseconds after which it should be called again. */
4287 static int
4288 expire(struct dpif_backer *backer)
4289 {
4290     struct ofproto_dpif *ofproto;
4291     int max_idle = INT32_MAX;
4292
4293     /* Periodically clear out the drop keys in an effort to keep them
4294      * relatively few. */
4295     drop_key_clear(backer);
4296
4297     /* Update stats for each flow in the backer. */
4298     update_stats(backer);
4299
4300     HMAP_FOR_EACH (ofproto, all_ofproto_dpifs_node, &all_ofproto_dpifs) {
4301         struct rule *rule, *next_rule;
4302         int dp_max_idle;
4303
4304         if (ofproto->backer != backer) {
4305             continue;
4306         }
4307
4308         /* Keep track of the max number of flows per ofproto_dpif. */
4309         update_max_subfacet_count(ofproto);
4310
4311         /* Expire subfacets that have been idle too long. */
4312         dp_max_idle = subfacet_max_idle(ofproto);
4313         expire_subfacets(ofproto, dp_max_idle);
4314
4315         max_idle = MIN(max_idle, dp_max_idle);
4316
4317         /* Expire OpenFlow flows whose idle_timeout or hard_timeout
4318          * has passed. */
4319         LIST_FOR_EACH_SAFE (rule, next_rule, expirable,
4320                             &ofproto->up.expirable) {
4321             rule_expire(rule_dpif_cast(rule));
4322         }
4323
4324         /* All outstanding data in existing flows has been accounted, so it's a
4325          * good time to do bond rebalancing. */
4326         if (ofproto->has_bonded_bundles) {
4327             struct ofbundle *bundle;
4328
4329             HMAP_FOR_EACH (bundle, hmap_node, &ofproto->bundles) {
4330                 if (bundle->bond) {
4331                     bond_rebalance(bundle->bond, &backer->revalidate_set);
4332                 }
4333             }
4334         }
4335     }
4336
4337     return MIN(max_idle, 1000);
4338 }
4339
4340 /* Updates flow table statistics given that the datapath just reported 'stats'
4341  * as 'subfacet''s statistics. */
4342 static void
4343 update_subfacet_stats(struct subfacet *subfacet,
4344                       const struct dpif_flow_stats *stats)
4345 {
4346     struct facet *facet = subfacet->facet;
4347
4348     if (stats->n_packets >= subfacet->dp_packet_count) {
4349         uint64_t extra = stats->n_packets - subfacet->dp_packet_count;
4350         facet->packet_count += extra;
4351     } else {
4352         VLOG_WARN_RL(&rl, "unexpected packet count from the datapath");
4353     }
4354
4355     if (stats->n_bytes >= subfacet->dp_byte_count) {
4356         facet->byte_count += stats->n_bytes - subfacet->dp_byte_count;
4357     } else {
4358         VLOG_WARN_RL(&rl, "unexpected byte count from datapath");
4359     }
4360
4361     subfacet->dp_packet_count = stats->n_packets;
4362     subfacet->dp_byte_count = stats->n_bytes;
4363
4364     facet->tcp_flags |= stats->tcp_flags;
4365
4366     subfacet_update_time(subfacet, stats->used);
4367     if (facet->accounted_bytes < facet->byte_count) {
4368         facet_learn(facet);
4369         facet_account(facet);
4370         facet->accounted_bytes = facet->byte_count;
4371     }
4372 }
4373
4374 /* 'key' with length 'key_len' bytes is a flow in 'dpif' that we know nothing
4375  * about, or a flow that shouldn't be installed but was anyway.  Delete it. */
4376 static void
4377 delete_unexpected_flow(struct ofproto_dpif *ofproto,
4378                        const struct nlattr *key, size_t key_len)
4379 {
4380     if (!VLOG_DROP_WARN(&rl)) {
4381         struct ds s;
4382
4383         ds_init(&s);
4384         odp_flow_key_format(key, key_len, &s);
4385         VLOG_WARN("unexpected flow on %s: %s", ofproto->up.name, ds_cstr(&s));
4386         ds_destroy(&s);
4387     }
4388
4389     COVERAGE_INC(facet_unexpected);
4390     dpif_flow_del(ofproto->backer->dpif, key, key_len, NULL);
4391 }
4392
4393 /* Update 'packet_count', 'byte_count', and 'used' members of installed facets.
4394  *
4395  * This function also pushes statistics updates to rules which each facet
4396  * resubmits into.  Generally these statistics will be accurate.  However, if a
4397  * facet changes the rule it resubmits into at some time in between
4398  * update_stats() runs, it is possible that statistics accrued to the
4399  * old rule will be incorrectly attributed to the new rule.  This could be
4400  * avoided by calling update_stats() whenever rules are created or
4401  * deleted.  However, the performance impact of making so many calls to the
4402  * datapath do not justify the benefit of having perfectly accurate statistics.
4403  *
4404  * In addition, this function maintains per ofproto flow hit counts. The patch
4405  * port is not treated specially. e.g. A packet ingress from br0 patched into
4406  * br1 will increase the hit count of br0 by 1, however, does not affect
4407  * the hit or miss counts of br1.
4408  */
4409 static void
4410 update_stats(struct dpif_backer *backer)
4411 {
4412     const struct dpif_flow_stats *stats;
4413     struct dpif_flow_dump dump;
4414     const struct nlattr *key;
4415     struct ofproto_dpif *ofproto;
4416     size_t key_len;
4417
4418     dpif_flow_dump_start(&dump, backer->dpif);
4419     while (dpif_flow_dump_next(&dump, &key, &key_len, NULL, NULL, &stats)) {
4420         struct flow flow;
4421         struct subfacet *subfacet;
4422         struct ofport_dpif *ofport;
4423         uint32_t key_hash;
4424
4425         if (ofproto_receive(backer, NULL, key, key_len, &flow, NULL, &ofproto,
4426                             NULL, NULL)) {
4427             continue;
4428         }
4429
4430         ofproto->total_subfacet_count += hmap_count(&ofproto->subfacets);
4431         ofproto->n_update_stats++;
4432
4433         ofport = get_ofp_port(ofproto, flow.in_port);
4434         if (ofport && ofport->tnl_port) {
4435             netdev_vport_inc_rx(ofport->up.netdev, stats);
4436         }
4437
4438         key_hash = odp_flow_key_hash(key, key_len);
4439         subfacet = subfacet_find(ofproto, key, key_len, key_hash);
4440         switch (subfacet ? subfacet->path : SF_NOT_INSTALLED) {
4441         case SF_FAST_PATH:
4442             /* Update ofproto_dpif's hit count. */
4443             if (stats->n_packets > subfacet->dp_packet_count) {
4444                 uint64_t delta = stats->n_packets - subfacet->dp_packet_count;
4445                 dpif_stats_update_hit_count(ofproto, delta);
4446             }
4447
4448             update_subfacet_stats(subfacet, stats);
4449             break;
4450
4451         case SF_SLOW_PATH:
4452             /* Stats are updated per-packet. */
4453             break;
4454
4455         case SF_NOT_INSTALLED:
4456         default:
4457             delete_unexpected_flow(ofproto, key, key_len);
4458             break;
4459         }
4460         run_fast_rl();
4461     }
4462     dpif_flow_dump_done(&dump);
4463
4464     HMAP_FOR_EACH (ofproto, all_ofproto_dpifs_node, &all_ofproto_dpifs) {
4465         update_moving_averages(ofproto);
4466     }
4467
4468 }
4469
4470 /* Calculates and returns the number of milliseconds of idle time after which
4471  * subfacets should expire from the datapath.  When a subfacet expires, we fold
4472  * its statistics into its facet, and when a facet's last subfacet expires, we
4473  * fold its statistic into its rule. */
4474 static int
4475 subfacet_max_idle(const struct ofproto_dpif *ofproto)
4476 {
4477     /*
4478      * Idle time histogram.
4479      *
4480      * Most of the time a switch has a relatively small number of subfacets.
4481      * When this is the case we might as well keep statistics for all of them
4482      * in userspace and to cache them in the kernel datapath for performance as
4483      * well.
4484      *
4485      * As the number of subfacets increases, the memory required to maintain
4486      * statistics about them in userspace and in the kernel becomes
4487      * significant.  However, with a large number of subfacets it is likely
4488      * that only a few of them are "heavy hitters" that consume a large amount
4489      * of bandwidth.  At this point, only heavy hitters are worth caching in
4490      * the kernel and maintaining in userspaces; other subfacets we can
4491      * discard.
4492      *
4493      * The technique used to compute the idle time is to build a histogram with
4494      * N_BUCKETS buckets whose width is BUCKET_WIDTH msecs each.  Each subfacet
4495      * that is installed in the kernel gets dropped in the appropriate bucket.
4496      * After the histogram has been built, we compute the cutoff so that only
4497      * the most-recently-used 1% of subfacets (but at least
4498      * ofproto->up.flow_eviction_threshold flows) are kept cached.  At least
4499      * the most-recently-used bucket of subfacets is kept, so actually an
4500      * arbitrary number of subfacets can be kept in any given expiration run
4501      * (though the next run will delete most of those unless they receive
4502      * additional data).
4503      *
4504      * This requires a second pass through the subfacets, in addition to the
4505      * pass made by update_stats(), because the former function never looks at
4506      * uninstallable subfacets.
4507      */
4508     enum { BUCKET_WIDTH = ROUND_UP(100, TIME_UPDATE_INTERVAL) };
4509     enum { N_BUCKETS = 5000 / BUCKET_WIDTH };
4510     int buckets[N_BUCKETS] = { 0 };
4511     int total, subtotal, bucket;
4512     struct subfacet *subfacet;
4513     long long int now;
4514     int i;
4515
4516     total = hmap_count(&ofproto->subfacets);
4517     if (total <= ofproto->up.flow_eviction_threshold) {
4518         return N_BUCKETS * BUCKET_WIDTH;
4519     }
4520
4521     /* Build histogram. */
4522     now = time_msec();
4523     HMAP_FOR_EACH (subfacet, hmap_node, &ofproto->subfacets) {
4524         long long int idle = now - subfacet->used;
4525         int bucket = (idle <= 0 ? 0
4526                       : idle >= BUCKET_WIDTH * N_BUCKETS ? N_BUCKETS - 1
4527                       : (unsigned int) idle / BUCKET_WIDTH);
4528         buckets[bucket]++;
4529     }
4530
4531     /* Find the first bucket whose flows should be expired. */
4532     subtotal = bucket = 0;
4533     do {
4534         subtotal += buckets[bucket++];
4535     } while (bucket < N_BUCKETS &&
4536              subtotal < MAX(ofproto->up.flow_eviction_threshold, total / 100));
4537
4538     if (VLOG_IS_DBG_ENABLED()) {
4539         struct ds s;
4540
4541         ds_init(&s);
4542         ds_put_cstr(&s, "keep");
4543         for (i = 0; i < N_BUCKETS; i++) {
4544             if (i == bucket) {
4545                 ds_put_cstr(&s, ", drop");
4546             }
4547             if (buckets[i]) {
4548                 ds_put_format(&s, " %d:%d", i * BUCKET_WIDTH, buckets[i]);
4549             }
4550         }
4551         VLOG_INFO("%s: %s (msec:count)", ofproto->up.name, ds_cstr(&s));
4552         ds_destroy(&s);
4553     }
4554
4555     return bucket * BUCKET_WIDTH;
4556 }
4557
4558 static void
4559 expire_subfacets(struct ofproto_dpif *ofproto, int dp_max_idle)
4560 {
4561     /* Cutoff time for most flows. */
4562     long long int normal_cutoff = time_msec() - dp_max_idle;
4563
4564     /* We really want to keep flows for special protocols around, so use a more
4565      * conservative cutoff. */
4566     long long int special_cutoff = time_msec() - 10000;
4567
4568     struct subfacet *subfacet, *next_subfacet;
4569     struct subfacet *batch[SUBFACET_DESTROY_MAX_BATCH];
4570     int n_batch;
4571
4572     n_batch = 0;
4573     HMAP_FOR_EACH_SAFE (subfacet, next_subfacet, hmap_node,
4574                         &ofproto->subfacets) {
4575         long long int cutoff;
4576
4577         cutoff = (subfacet->slow & (SLOW_CFM | SLOW_BFD | SLOW_LACP | SLOW_STP)
4578                   ? special_cutoff
4579                   : normal_cutoff);
4580         if (subfacet->used < cutoff) {
4581             if (subfacet->path != SF_NOT_INSTALLED) {
4582                 batch[n_batch++] = subfacet;
4583                 if (n_batch >= SUBFACET_DESTROY_MAX_BATCH) {
4584                     subfacet_destroy_batch(ofproto, batch, n_batch);
4585                     n_batch = 0;
4586                 }
4587             } else {
4588                 subfacet_destroy(subfacet);
4589             }
4590         }
4591     }
4592
4593     if (n_batch > 0) {
4594         subfacet_destroy_batch(ofproto, batch, n_batch);
4595     }
4596 }
4597
4598 /* If 'rule' is an OpenFlow rule, that has expired according to OpenFlow rules,
4599  * then delete it entirely. */
4600 static void
4601 rule_expire(struct rule_dpif *rule)
4602 {
4603     struct facet *facet, *next_facet;
4604     long long int now;
4605     uint8_t reason;
4606
4607     if (rule->up.pending) {
4608         /* We'll have to expire it later. */
4609         return;
4610     }
4611
4612     /* Has 'rule' expired? */
4613     now = time_msec();
4614     if (rule->up.hard_timeout
4615         && now > rule->up.modified + rule->up.hard_timeout * 1000) {
4616         reason = OFPRR_HARD_TIMEOUT;
4617     } else if (rule->up.idle_timeout
4618                && now > rule->up.used + rule->up.idle_timeout * 1000) {
4619         reason = OFPRR_IDLE_TIMEOUT;
4620     } else {
4621         return;
4622     }
4623
4624     COVERAGE_INC(ofproto_dpif_expired);
4625
4626     /* Update stats.  (This is a no-op if the rule expired due to an idle
4627      * timeout, because that only happens when the rule has no facets left.) */
4628     LIST_FOR_EACH_SAFE (facet, next_facet, list_node, &rule->facets) {
4629         facet_remove(facet);
4630     }
4631
4632     /* Get rid of the rule. */
4633     ofproto_rule_expire(&rule->up, reason);
4634 }
4635 \f
4636 /* Facets. */
4637
4638 /* Creates and returns a new facet owned by 'rule', given a 'flow'.
4639  *
4640  * The caller must already have determined that no facet with an identical
4641  * 'flow' exists in 'ofproto' and that 'flow' is the best match for 'rule' in
4642  * the ofproto's classifier table.
4643  *
4644  * 'hash' must be the return value of flow_hash(flow, 0).
4645  *
4646  * The facet will initially have no subfacets.  The caller should create (at
4647  * least) one subfacet with subfacet_create(). */
4648 static struct facet *
4649 facet_create(struct rule_dpif *rule, const struct flow *flow, uint32_t hash)
4650 {
4651     struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
4652     struct facet *facet;
4653
4654     facet = xzalloc(sizeof *facet);
4655     facet->used = time_msec();
4656     hmap_insert(&ofproto->facets, &facet->hmap_node, hash);
4657     list_push_back(&rule->facets, &facet->list_node);
4658     facet->rule = rule;
4659     facet->flow = *flow;
4660     list_init(&facet->subfacets);
4661     netflow_flow_init(&facet->nf_flow);
4662     netflow_flow_update_time(ofproto->netflow, &facet->nf_flow, facet->used);
4663
4664     facet->learn_rl = time_msec() + 500;
4665
4666     return facet;
4667 }
4668
4669 static void
4670 facet_free(struct facet *facet)
4671 {
4672     free(facet);
4673 }
4674
4675 /* Executes, within 'ofproto', the 'n_actions' actions in 'actions' on
4676  * 'packet', which arrived on 'in_port'. */
4677 static bool
4678 execute_odp_actions(struct ofproto_dpif *ofproto, const struct flow *flow,
4679                     const struct nlattr *odp_actions, size_t actions_len,
4680                     struct ofpbuf *packet)
4681 {
4682     struct odputil_keybuf keybuf;
4683     struct ofpbuf key;
4684     int error;
4685
4686     ofpbuf_use_stack(&key, &keybuf, sizeof keybuf);
4687     odp_flow_key_from_flow(&key, flow,
4688                            ofp_port_to_odp_port(ofproto, flow->in_port));
4689
4690     error = dpif_execute(ofproto->backer->dpif, key.data, key.size,
4691                          odp_actions, actions_len, packet);
4692     return !error;
4693 }
4694
4695 /* Remove 'facet' from 'ofproto' and free up the associated memory:
4696  *
4697  *   - If 'facet' was installed in the datapath, uninstalls it and updates its
4698  *     rule's statistics, via subfacet_uninstall().
4699  *
4700  *   - Removes 'facet' from its rule and from ofproto->facets.
4701  */
4702 static void
4703 facet_remove(struct facet *facet)
4704 {
4705     struct ofproto_dpif *ofproto = ofproto_dpif_cast(facet->rule->up.ofproto);
4706     struct subfacet *subfacet, *next_subfacet;
4707
4708     ovs_assert(!list_is_empty(&facet->subfacets));
4709
4710     /* First uninstall all of the subfacets to get final statistics. */
4711     LIST_FOR_EACH (subfacet, list_node, &facet->subfacets) {
4712         subfacet_uninstall(subfacet);
4713     }
4714
4715     /* Flush the final stats to the rule.
4716      *
4717      * This might require us to have at least one subfacet around so that we
4718      * can use its actions for accounting in facet_account(), which is why we
4719      * have uninstalled but not yet destroyed the subfacets. */
4720     facet_flush_stats(facet);
4721
4722     /* Now we're really all done so destroy everything. */
4723     LIST_FOR_EACH_SAFE (subfacet, next_subfacet, list_node,
4724                         &facet->subfacets) {
4725         subfacet_destroy__(subfacet);
4726     }
4727     hmap_remove(&ofproto->facets, &facet->hmap_node);
4728     list_remove(&facet->list_node);
4729     facet_free(facet);
4730 }
4731
4732 /* Feed information from 'facet' back into the learning table to keep it in
4733  * sync with what is actually flowing through the datapath. */
4734 static void
4735 facet_learn(struct facet *facet)
4736 {
4737     struct ofproto_dpif *ofproto = ofproto_dpif_cast(facet->rule->up.ofproto);
4738     struct subfacet *subfacet= CONTAINER_OF(list_front(&facet->subfacets),
4739                                             struct subfacet, list_node);
4740     long long int now = time_msec();
4741     struct action_xlate_ctx ctx;
4742
4743     if (!facet->has_fin_timeout && now < facet->learn_rl) {
4744         return;
4745     }
4746
4747     facet->learn_rl = now + 500;
4748
4749     if (!facet->has_learn
4750         && !facet->has_normal
4751         && (!facet->has_fin_timeout
4752             || !(facet->tcp_flags & (TCP_FIN | TCP_RST)))) {
4753         return;
4754     }
4755
4756     action_xlate_ctx_init(&ctx, ofproto, &facet->flow,
4757                           &subfacet->initial_vals,
4758                           facet->rule, facet->tcp_flags, NULL);
4759     ctx.may_learn = true;
4760     xlate_actions_for_side_effects(&ctx, facet->rule->up.ofpacts,
4761                                    facet->rule->up.ofpacts_len);
4762 }
4763
4764 static void
4765 facet_account(struct facet *facet)
4766 {
4767     struct ofproto_dpif *ofproto = ofproto_dpif_cast(facet->rule->up.ofproto);
4768     struct subfacet *subfacet = facet_get_subfacet(facet);
4769     const struct nlattr *a;
4770     unsigned int left;
4771     ovs_be16 vlan_tci;
4772     uint64_t n_bytes;
4773
4774     if (!facet->has_normal || !ofproto->has_bonded_bundles) {
4775         return;
4776     }
4777     n_bytes = facet->byte_count - facet->accounted_bytes;
4778
4779     /* This loop feeds byte counters to bond_account() for rebalancing to use
4780      * as a basis.  We also need to track the actual VLAN on which the packet
4781      * is going to be sent to ensure that it matches the one passed to
4782      * bond_choose_output_slave().  (Otherwise, we will account to the wrong
4783      * hash bucket.)
4784      *
4785      * We use the actions from an arbitrary subfacet because they should all
4786      * be equally valid for our purpose. */
4787     vlan_tci = facet->flow.vlan_tci;
4788     NL_ATTR_FOR_EACH_UNSAFE (a, left,
4789                              subfacet->actions, subfacet->actions_len) {
4790         const struct ovs_action_push_vlan *vlan;
4791         struct ofport_dpif *port;
4792
4793         switch (nl_attr_type(a)) {
4794         case OVS_ACTION_ATTR_OUTPUT:
4795             port = get_odp_port(ofproto, nl_attr_get_u32(a));
4796             if (port && port->bundle && port->bundle->bond) {
4797                 bond_account(port->bundle->bond, &facet->flow,
4798                              vlan_tci_to_vid(vlan_tci), n_bytes);
4799             }
4800             break;
4801
4802         case OVS_ACTION_ATTR_POP_VLAN:
4803             vlan_tci = htons(0);
4804             break;
4805
4806         case OVS_ACTION_ATTR_PUSH_VLAN:
4807             vlan = nl_attr_get(a);
4808             vlan_tci = vlan->vlan_tci;
4809             break;
4810         }
4811     }
4812 }
4813
4814 /* Returns true if the only action for 'facet' is to send to the controller.
4815  * (We don't report NetFlow expiration messages for such facets because they
4816  * are just part of the control logic for the network, not real traffic). */
4817 static bool
4818 facet_is_controller_flow(struct facet *facet)
4819 {
4820     if (facet) {
4821         const struct rule *rule = &facet->rule->up;
4822         const struct ofpact *ofpacts = rule->ofpacts;
4823         size_t ofpacts_len = rule->ofpacts_len;
4824
4825         if (ofpacts_len > 0 &&
4826             ofpacts->type == OFPACT_CONTROLLER &&
4827             ofpact_next(ofpacts) >= ofpact_end(ofpacts, ofpacts_len)) {
4828             return true;
4829         }
4830     }
4831     return false;
4832 }
4833
4834 /* Folds all of 'facet''s statistics into its rule.  Also updates the
4835  * accounting ofhook and emits a NetFlow expiration if appropriate.  All of
4836  * 'facet''s statistics in the datapath should have been zeroed and folded into
4837  * its packet and byte counts before this function is called. */
4838 static void
4839 facet_flush_stats(struct facet *facet)
4840 {
4841     struct ofproto_dpif *ofproto = ofproto_dpif_cast(facet->rule->up.ofproto);
4842     struct subfacet *subfacet;
4843
4844     LIST_FOR_EACH (subfacet, list_node, &facet->subfacets) {
4845         ovs_assert(!subfacet->dp_byte_count);
4846         ovs_assert(!subfacet->dp_packet_count);
4847     }
4848
4849     facet_push_stats(facet);
4850     if (facet->accounted_bytes < facet->byte_count) {
4851         facet_account(facet);
4852         facet->accounted_bytes = facet->byte_count;
4853     }
4854
4855     if (ofproto->netflow && !facet_is_controller_flow(facet)) {
4856         struct ofexpired expired;
4857         expired.flow = facet->flow;
4858         expired.packet_count = facet->packet_count;
4859         expired.byte_count = facet->byte_count;
4860         expired.used = facet->used;
4861         netflow_expire(ofproto->netflow, &facet->nf_flow, &expired);
4862     }
4863
4864     facet->rule->packet_count += facet->packet_count;
4865     facet->rule->byte_count += facet->byte_count;
4866
4867     /* Reset counters to prevent double counting if 'facet' ever gets
4868      * reinstalled. */
4869     facet_reset_counters(facet);
4870
4871     netflow_flow_clear(&facet->nf_flow);
4872     facet->tcp_flags = 0;
4873 }
4874
4875 /* Searches 'ofproto''s table of facets for one exactly equal to 'flow'.
4876  * Returns it if found, otherwise a null pointer.
4877  *
4878  * 'hash' must be the return value of flow_hash(flow, 0).
4879  *
4880  * The returned facet might need revalidation; use facet_lookup_valid()
4881  * instead if that is important. */
4882 static struct facet *
4883 facet_find(struct ofproto_dpif *ofproto,
4884            const struct flow *flow, uint32_t hash)
4885 {
4886     struct facet *facet;
4887
4888     HMAP_FOR_EACH_WITH_HASH (facet, hmap_node, hash, &ofproto->facets) {
4889         if (flow_equal(flow, &facet->flow)) {
4890             return facet;
4891         }
4892     }
4893
4894     return NULL;
4895 }
4896
4897 /* Searches 'ofproto''s table of facets for one exactly equal to 'flow'.
4898  * Returns it if found, otherwise a null pointer.
4899  *
4900  * 'hash' must be the return value of flow_hash(flow, 0).
4901  *
4902  * The returned facet is guaranteed to be valid. */
4903 static struct facet *
4904 facet_lookup_valid(struct ofproto_dpif *ofproto, const struct flow *flow,
4905                    uint32_t hash)
4906 {
4907     struct facet *facet;
4908
4909     facet = facet_find(ofproto, flow, hash);
4910     if (facet
4911         && (ofproto->backer->need_revalidate
4912             || tag_set_intersects(&ofproto->backer->revalidate_set,
4913                                   facet->tags))) {
4914         facet_revalidate(facet);
4915
4916         /* facet_revalidate() may have destroyed 'facet'. */
4917         facet = facet_find(ofproto, flow, hash);
4918     }
4919
4920     return facet;
4921 }
4922
4923 /* Return a subfacet from 'facet'.  A facet consists of one or more
4924  * subfacets, and this function returns one of them. */
4925 static struct subfacet *facet_get_subfacet(struct facet *facet)
4926 {
4927     return CONTAINER_OF(list_front(&facet->subfacets), struct subfacet,
4928                         list_node);
4929 }
4930
4931 static const char *
4932 subfacet_path_to_string(enum subfacet_path path)
4933 {
4934     switch (path) {
4935     case SF_NOT_INSTALLED:
4936         return "not installed";
4937     case SF_FAST_PATH:
4938         return "in fast path";
4939     case SF_SLOW_PATH:
4940         return "in slow path";
4941     default:
4942         return "<error>";
4943     }
4944 }
4945
4946 /* Returns the path in which a subfacet should be installed if its 'slow'
4947  * member has the specified value. */
4948 static enum subfacet_path
4949 subfacet_want_path(enum slow_path_reason slow)
4950 {
4951     return slow ? SF_SLOW_PATH : SF_FAST_PATH;
4952 }
4953
4954 /* Returns true if 'subfacet' needs to have its datapath flow updated,
4955  * supposing that its actions have been recalculated as 'want_actions' and that
4956  * 'slow' is nonzero iff 'subfacet' should be in the slow path. */
4957 static bool
4958 subfacet_should_install(struct subfacet *subfacet, enum slow_path_reason slow,
4959                         const struct ofpbuf *want_actions)
4960 {
4961     enum subfacet_path want_path = subfacet_want_path(slow);
4962     return (want_path != subfacet->path
4963             || (want_path == SF_FAST_PATH
4964                 && (subfacet->actions_len != want_actions->size
4965                     || memcmp(subfacet->actions, want_actions->data,
4966                               subfacet->actions_len))));
4967 }
4968
4969 static bool
4970 facet_check_consistency(struct facet *facet)
4971 {
4972     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 15);
4973
4974     struct ofproto_dpif *ofproto = ofproto_dpif_cast(facet->rule->up.ofproto);
4975
4976     uint64_t odp_actions_stub[1024 / 8];
4977     struct ofpbuf odp_actions;
4978
4979     struct rule_dpif *rule;
4980     struct subfacet *subfacet;
4981     bool may_log = false;
4982     bool ok;
4983
4984     /* Check the rule for consistency. */
4985     rule = rule_dpif_lookup(ofproto, &facet->flow);
4986     ok = rule == facet->rule;
4987     if (!ok) {
4988         may_log = !VLOG_DROP_WARN(&rl);
4989         if (may_log) {
4990             struct ds s;
4991
4992             ds_init(&s);
4993             flow_format(&s, &facet->flow);
4994             ds_put_format(&s, ": facet associated with wrong rule (was "
4995                           "table=%"PRIu8",", facet->rule->up.table_id);
4996             cls_rule_format(&facet->rule->up.cr, &s);
4997             ds_put_format(&s, ") (should have been table=%"PRIu8",",
4998                           rule->up.table_id);
4999             cls_rule_format(&rule->up.cr, &s);
5000             ds_put_char(&s, ')');
5001
5002             VLOG_WARN("%s", ds_cstr(&s));
5003             ds_destroy(&s);
5004         }
5005     }
5006
5007     /* Check the datapath actions for consistency. */
5008     ofpbuf_use_stub(&odp_actions, odp_actions_stub, sizeof odp_actions_stub);
5009     LIST_FOR_EACH (subfacet, list_node, &facet->subfacets) {
5010         enum subfacet_path want_path;
5011         struct action_xlate_ctx ctx;
5012         struct ds s;
5013
5014         action_xlate_ctx_init(&ctx, ofproto, &facet->flow,
5015                               &subfacet->initial_vals, rule, 0, NULL);
5016         xlate_actions(&ctx, rule->up.ofpacts, rule->up.ofpacts_len,
5017                       &odp_actions);
5018
5019         if (subfacet->path == SF_NOT_INSTALLED) {
5020             /* This only happens if the datapath reported an error when we
5021              * tried to install the flow.  Don't flag another error here. */
5022             continue;
5023         }
5024
5025         want_path = subfacet_want_path(subfacet->slow);
5026         if (want_path == SF_SLOW_PATH && subfacet->path == SF_SLOW_PATH) {
5027             /* The actions for slow-path flows may legitimately vary from one
5028              * packet to the next.  We're done. */
5029             continue;
5030         }
5031
5032         if (!subfacet_should_install(subfacet, subfacet->slow, &odp_actions)) {
5033             continue;
5034         }
5035
5036         /* Inconsistency! */
5037         if (ok) {
5038             may_log = !VLOG_DROP_WARN(&rl);
5039             ok = false;
5040         }
5041         if (!may_log) {
5042             /* Rate-limited, skip reporting. */
5043             continue;
5044         }
5045
5046         ds_init(&s);
5047         odp_flow_key_format(subfacet->key, subfacet->key_len, &s);
5048
5049         ds_put_cstr(&s, ": inconsistency in subfacet");
5050         if (want_path != subfacet->path) {
5051             enum odp_key_fitness fitness = subfacet->key_fitness;
5052
5053             ds_put_format(&s, " (%s, fitness=%s)",
5054                           subfacet_path_to_string(subfacet->path),
5055                           odp_key_fitness_to_string(fitness));
5056             ds_put_format(&s, " (should have been %s)",
5057                           subfacet_path_to_string(want_path));
5058         } else if (want_path == SF_FAST_PATH) {
5059             ds_put_cstr(&s, " (actions were: ");
5060             format_odp_actions(&s, subfacet->actions,
5061                                subfacet->actions_len);
5062             ds_put_cstr(&s, ") (correct actions: ");
5063             format_odp_actions(&s, odp_actions.data, odp_actions.size);
5064             ds_put_char(&s, ')');
5065         } else {
5066             ds_put_cstr(&s, " (actions: ");
5067             format_odp_actions(&s, subfacet->actions,
5068                                subfacet->actions_len);
5069             ds_put_char(&s, ')');
5070         }
5071         VLOG_WARN("%s", ds_cstr(&s));
5072         ds_destroy(&s);
5073     }
5074     ofpbuf_uninit(&odp_actions);
5075
5076     return ok;
5077 }
5078
5079 /* Re-searches the classifier for 'facet':
5080  *
5081  *   - If the rule found is different from 'facet''s current rule, moves
5082  *     'facet' to the new rule and recompiles its actions.
5083  *
5084  *   - If the rule found is the same as 'facet''s current rule, leaves 'facet'
5085  *     where it is and recompiles its actions anyway.
5086  *
5087  *   - If any of 'facet''s subfacets correspond to a new flow according to
5088  *     ofproto_receive(), 'facet' is removed. */
5089 static void
5090 facet_revalidate(struct facet *facet)
5091 {
5092     struct ofproto_dpif *ofproto = ofproto_dpif_cast(facet->rule->up.ofproto);
5093     struct actions {
5094         struct nlattr *odp_actions;
5095         size_t actions_len;
5096     };
5097     struct actions *new_actions;
5098
5099     struct action_xlate_ctx ctx;
5100     uint64_t odp_actions_stub[1024 / 8];
5101     struct ofpbuf odp_actions;
5102
5103     struct rule_dpif *new_rule;
5104     struct subfacet *subfacet;
5105     int i;
5106
5107     COVERAGE_INC(facet_revalidate);
5108
5109     /* Check that child subfacets still correspond to this facet.  Tunnel
5110      * configuration changes could cause a subfacet's OpenFlow in_port to
5111      * change. */
5112     LIST_FOR_EACH (subfacet, list_node, &facet->subfacets) {
5113         struct ofproto_dpif *recv_ofproto;
5114         struct flow recv_flow;
5115         int error;
5116
5117         error = ofproto_receive(ofproto->backer, NULL, subfacet->key,
5118                                 subfacet->key_len, &recv_flow, NULL,
5119                                 &recv_ofproto, NULL, NULL);
5120         if (error
5121             || recv_ofproto != ofproto
5122             || memcmp(&recv_flow, &facet->flow, sizeof recv_flow)) {
5123             facet_remove(facet);
5124             return;
5125         }
5126     }
5127
5128     new_rule = rule_dpif_lookup(ofproto, &facet->flow);
5129
5130     /* Calculate new datapath actions.
5131      *
5132      * We do not modify any 'facet' state yet, because we might need to, e.g.,
5133      * emit a NetFlow expiration and, if so, we need to have the old state
5134      * around to properly compose it. */
5135
5136     /* If the datapath actions changed or the installability changed,
5137      * then we need to talk to the datapath. */
5138     i = 0;
5139     new_actions = NULL;
5140     memset(&ctx, 0, sizeof ctx);
5141     ofpbuf_use_stub(&odp_actions, odp_actions_stub, sizeof odp_actions_stub);
5142     LIST_FOR_EACH (subfacet, list_node, &facet->subfacets) {
5143         enum slow_path_reason slow;
5144
5145         action_xlate_ctx_init(&ctx, ofproto, &facet->flow,
5146                               &subfacet->initial_vals, new_rule, 0, NULL);
5147         xlate_actions(&ctx, new_rule->up.ofpacts, new_rule->up.ofpacts_len,
5148                       &odp_actions);
5149
5150         slow = (subfacet->slow & SLOW_MATCH) | ctx.slow;
5151         if (subfacet_should_install(subfacet, slow, &odp_actions)) {
5152             struct dpif_flow_stats stats;
5153
5154             subfacet_install(subfacet,
5155                              odp_actions.data, odp_actions.size, &stats, slow);
5156             subfacet_update_stats(subfacet, &stats);
5157
5158             if (!new_actions) {
5159                 new_actions = xcalloc(list_size(&facet->subfacets),
5160                                       sizeof *new_actions);
5161             }
5162             new_actions[i].odp_actions = xmemdup(odp_actions.data,
5163                                                  odp_actions.size);
5164             new_actions[i].actions_len = odp_actions.size;
5165         }
5166
5167         i++;
5168     }
5169     ofpbuf_uninit(&odp_actions);
5170
5171     if (new_actions) {
5172         facet_flush_stats(facet);
5173     }
5174
5175     /* Update 'facet' now that we've taken care of all the old state. */
5176     facet->tags = ctx.tags;
5177     facet->nf_flow.output_iface = ctx.nf_output_iface;
5178     facet->has_learn = ctx.has_learn;
5179     facet->has_normal = ctx.has_normal;
5180     facet->has_fin_timeout = ctx.has_fin_timeout;
5181     facet->mirrors = ctx.mirrors;
5182
5183     i = 0;
5184     LIST_FOR_EACH (subfacet, list_node, &facet->subfacets) {
5185         subfacet->slow = (subfacet->slow & SLOW_MATCH) | ctx.slow;
5186
5187         if (new_actions && new_actions[i].odp_actions) {
5188             free(subfacet->actions);
5189             subfacet->actions = new_actions[i].odp_actions;
5190             subfacet->actions_len = new_actions[i].actions_len;
5191         }
5192         i++;
5193     }
5194     free(new_actions);
5195
5196     if (facet->rule != new_rule) {
5197         COVERAGE_INC(facet_changed_rule);
5198         list_remove(&facet->list_node);
5199         list_push_back(&new_rule->facets, &facet->list_node);
5200         facet->rule = new_rule;
5201         facet->used = new_rule->up.created;
5202         facet->prev_used = facet->used;
5203     }
5204 }
5205
5206 /* Updates 'facet''s used time.  Caller is responsible for calling
5207  * facet_push_stats() to update the flows which 'facet' resubmits into. */
5208 static void
5209 facet_update_time(struct facet *facet, long long int used)
5210 {
5211     struct ofproto_dpif *ofproto = ofproto_dpif_cast(facet->rule->up.ofproto);
5212     if (used > facet->used) {
5213         facet->used = used;
5214         ofproto_rule_update_used(&facet->rule->up, used);
5215         netflow_flow_update_time(ofproto->netflow, &facet->nf_flow, used);
5216     }
5217 }
5218
5219 static void
5220 facet_reset_counters(struct facet *facet)
5221 {
5222     facet->packet_count = 0;
5223     facet->byte_count = 0;
5224     facet->prev_packet_count = 0;
5225     facet->prev_byte_count = 0;
5226     facet->accounted_bytes = 0;
5227 }
5228
5229 static void
5230 facet_push_stats(struct facet *facet)
5231 {
5232     struct dpif_flow_stats stats;
5233
5234     ovs_assert(facet->packet_count >= facet->prev_packet_count);
5235     ovs_assert(facet->byte_count >= facet->prev_byte_count);
5236     ovs_assert(facet->used >= facet->prev_used);
5237
5238     stats.n_packets = facet->packet_count - facet->prev_packet_count;
5239     stats.n_bytes = facet->byte_count - facet->prev_byte_count;
5240     stats.used = facet->used;
5241     stats.tcp_flags = 0;
5242
5243     if (stats.n_packets || stats.n_bytes || facet->used > facet->prev_used) {
5244         facet->prev_packet_count = facet->packet_count;
5245         facet->prev_byte_count = facet->byte_count;
5246         facet->prev_used = facet->used;
5247
5248         flow_push_stats(facet, &stats);
5249
5250         update_mirror_stats(ofproto_dpif_cast(facet->rule->up.ofproto),
5251                             facet->mirrors, stats.n_packets, stats.n_bytes);
5252     }
5253 }
5254
5255 static void
5256 push_all_stats__(bool run_fast)
5257 {
5258     static long long int rl = LLONG_MIN;
5259     struct ofproto_dpif *ofproto;
5260
5261     if (time_msec() < rl) {
5262         return;
5263     }
5264
5265     HMAP_FOR_EACH (ofproto, all_ofproto_dpifs_node, &all_ofproto_dpifs) {
5266         struct facet *facet;
5267
5268         HMAP_FOR_EACH (facet, hmap_node, &ofproto->facets) {
5269             facet_push_stats(facet);
5270             if (run_fast) {
5271                 run_fast_rl();
5272             }
5273         }
5274     }
5275
5276     rl = time_msec() + 100;
5277 }
5278
5279 static void
5280 push_all_stats(void)
5281 {
5282     push_all_stats__(true);
5283 }
5284
5285 static void
5286 rule_credit_stats(struct rule_dpif *rule, const struct dpif_flow_stats *stats)
5287 {
5288     rule->packet_count += stats->n_packets;
5289     rule->byte_count += stats->n_bytes;
5290     ofproto_rule_update_used(&rule->up, stats->used);
5291 }
5292
5293 /* Pushes flow statistics to the rules which 'facet->flow' resubmits
5294  * into given 'facet->rule''s actions and mirrors. */
5295 static void
5296 flow_push_stats(struct facet *facet, const struct dpif_flow_stats *stats)
5297 {
5298     struct rule_dpif *rule = facet->rule;
5299     struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
5300     struct subfacet *subfacet = facet_get_subfacet(facet);
5301     struct action_xlate_ctx ctx;
5302
5303     ofproto_rule_update_used(&rule->up, stats->used);
5304
5305     action_xlate_ctx_init(&ctx, ofproto, &facet->flow,
5306                           &subfacet->initial_vals, rule, 0, NULL);
5307     ctx.resubmit_stats = stats;
5308     xlate_actions_for_side_effects(&ctx, rule->up.ofpacts,
5309                                    rule->up.ofpacts_len);
5310 }
5311 \f
5312 /* Subfacets. */
5313
5314 static struct subfacet *
5315 subfacet_find(struct ofproto_dpif *ofproto,
5316               const struct nlattr *key, size_t key_len, uint32_t key_hash)
5317 {
5318     struct subfacet *subfacet;
5319
5320     HMAP_FOR_EACH_WITH_HASH (subfacet, hmap_node, key_hash,
5321                              &ofproto->subfacets) {
5322         if (subfacet->key_len == key_len
5323             && !memcmp(key, subfacet->key, key_len)) {
5324             return subfacet;
5325         }
5326     }
5327
5328     return NULL;
5329 }
5330
5331 /* Searches 'facet' (within 'ofproto') for a subfacet with the specified
5332  * 'key_fitness', 'key', and 'key_len' members in 'miss'.  Returns the
5333  * existing subfacet if there is one, otherwise creates and returns a
5334  * new subfacet.
5335  *
5336  * If the returned subfacet is new, then subfacet->actions will be NULL, in
5337  * which case the caller must populate the actions with
5338  * subfacet_make_actions(). */
5339 static struct subfacet *
5340 subfacet_create(struct facet *facet, struct flow_miss *miss,
5341                 long long int now)
5342 {
5343     struct ofproto_dpif *ofproto = ofproto_dpif_cast(facet->rule->up.ofproto);
5344     enum odp_key_fitness key_fitness = miss->key_fitness;
5345     const struct nlattr *key = miss->key;
5346     size_t key_len = miss->key_len;
5347     uint32_t key_hash;
5348     struct subfacet *subfacet;
5349
5350     key_hash = odp_flow_key_hash(key, key_len);
5351
5352     if (list_is_empty(&facet->subfacets)) {
5353         subfacet = &facet->one_subfacet;
5354     } else {
5355         subfacet = subfacet_find(ofproto, key, key_len, key_hash);
5356         if (subfacet) {
5357             if (subfacet->facet == facet) {
5358                 return subfacet;
5359             }
5360
5361             /* This shouldn't happen. */
5362             VLOG_ERR_RL(&rl, "subfacet with wrong facet");
5363             subfacet_destroy(subfacet);
5364         }
5365
5366         subfacet = xmalloc(sizeof *subfacet);
5367     }
5368
5369     hmap_insert(&ofproto->subfacets, &subfacet->hmap_node, key_hash);
5370     list_push_back(&facet->subfacets, &subfacet->list_node);
5371     subfacet->facet = facet;
5372     subfacet->key_fitness = key_fitness;
5373     subfacet->key = xmemdup(key, key_len);
5374     subfacet->key_len = key_len;
5375     subfacet->used = now;
5376     subfacet->created = now;
5377     subfacet->dp_packet_count = 0;
5378     subfacet->dp_byte_count = 0;
5379     subfacet->actions_len = 0;
5380     subfacet->actions = NULL;
5381     subfacet->slow = (subfacet->key_fitness == ODP_FIT_TOO_LITTLE
5382                       ? SLOW_MATCH
5383                       : 0);
5384     subfacet->path = SF_NOT_INSTALLED;
5385     subfacet->initial_vals = miss->initial_vals;
5386     subfacet->odp_in_port = miss->odp_in_port;
5387
5388     ofproto->subfacet_add_count++;
5389     return subfacet;
5390 }
5391
5392 /* Uninstalls 'subfacet' from the datapath, if it is installed, removes it from
5393  * its facet within 'ofproto', and frees it. */
5394 static void
5395 subfacet_destroy__(struct subfacet *subfacet)
5396 {
5397     struct facet *facet = subfacet->facet;
5398     struct ofproto_dpif *ofproto = ofproto_dpif_cast(facet->rule->up.ofproto);
5399
5400     /* Update ofproto stats before uninstall the subfacet. */
5401     ofproto->subfacet_del_count++;
5402     ofproto->total_subfacet_life_span += (time_msec() - subfacet->created);
5403
5404     subfacet_uninstall(subfacet);
5405     hmap_remove(&ofproto->subfacets, &subfacet->hmap_node);
5406     list_remove(&subfacet->list_node);
5407     free(subfacet->key);
5408     free(subfacet->actions);
5409     if (subfacet != &facet->one_subfacet) {
5410         free(subfacet);
5411     }
5412 }
5413
5414 /* Destroys 'subfacet', as with subfacet_destroy__(), and then if this was the
5415  * last remaining subfacet in its facet destroys the facet too. */
5416 static void
5417 subfacet_destroy(struct subfacet *subfacet)
5418 {
5419     struct facet *facet = subfacet->facet;
5420
5421     if (list_is_singleton(&facet->subfacets)) {
5422         /* facet_remove() needs at least one subfacet (it will remove it). */
5423         facet_remove(facet);
5424     } else {
5425         subfacet_destroy__(subfacet);
5426     }
5427 }
5428
5429 static void
5430 subfacet_destroy_batch(struct ofproto_dpif *ofproto,
5431                        struct subfacet **subfacets, int n)
5432 {
5433     struct dpif_op ops[SUBFACET_DESTROY_MAX_BATCH];
5434     struct dpif_op *opsp[SUBFACET_DESTROY_MAX_BATCH];
5435     struct dpif_flow_stats stats[SUBFACET_DESTROY_MAX_BATCH];
5436     int i;
5437
5438     for (i = 0; i < n; i++) {
5439         ops[i].type = DPIF_OP_FLOW_DEL;
5440         ops[i].u.flow_del.key = subfacets[i]->key;
5441         ops[i].u.flow_del.key_len = subfacets[i]->key_len;
5442         ops[i].u.flow_del.stats = &stats[i];
5443         opsp[i] = &ops[i];
5444     }
5445
5446     dpif_operate(ofproto->backer->dpif, opsp, n);
5447     for (i = 0; i < n; i++) {
5448         subfacet_reset_dp_stats(subfacets[i], &stats[i]);
5449         subfacets[i]->path = SF_NOT_INSTALLED;
5450         subfacet_destroy(subfacets[i]);
5451         run_fast_rl();
5452     }
5453 }
5454
5455 /* Composes the datapath actions for 'subfacet' based on its rule's actions.
5456  * Translates the actions into 'odp_actions', which the caller must have
5457  * initialized and is responsible for uninitializing. */
5458 static void
5459 subfacet_make_actions(struct subfacet *subfacet, const struct ofpbuf *packet,
5460                       struct ofpbuf *odp_actions)
5461 {
5462     struct facet *facet = subfacet->facet;
5463     struct rule_dpif *rule = facet->rule;
5464     struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
5465
5466     struct action_xlate_ctx ctx;
5467
5468     action_xlate_ctx_init(&ctx, ofproto, &facet->flow,
5469                           &subfacet->initial_vals, rule, 0, packet);
5470     xlate_actions(&ctx, rule->up.ofpacts, rule->up.ofpacts_len, odp_actions);
5471     facet->tags = ctx.tags;
5472     facet->has_learn = ctx.has_learn;
5473     facet->has_normal = ctx.has_normal;
5474     facet->has_fin_timeout = ctx.has_fin_timeout;
5475     facet->nf_flow.output_iface = ctx.nf_output_iface;
5476     facet->mirrors = ctx.mirrors;
5477
5478     subfacet->slow = (subfacet->slow & SLOW_MATCH) | ctx.slow;
5479     if (subfacet->actions_len != odp_actions->size
5480         || memcmp(subfacet->actions, odp_actions->data, odp_actions->size)) {
5481         free(subfacet->actions);
5482         subfacet->actions_len = odp_actions->size;
5483         subfacet->actions = xmemdup(odp_actions->data, odp_actions->size);
5484     }
5485 }
5486
5487 /* Updates 'subfacet''s datapath flow, setting its actions to 'actions_len'
5488  * bytes of actions in 'actions'.  If 'stats' is non-null, statistics counters
5489  * in the datapath will be zeroed and 'stats' will be updated with traffic new
5490  * since 'subfacet' was last updated.
5491  *
5492  * Returns 0 if successful, otherwise a positive errno value. */
5493 static int
5494 subfacet_install(struct subfacet *subfacet,
5495                  const struct nlattr *actions, size_t actions_len,
5496                  struct dpif_flow_stats *stats,
5497                  enum slow_path_reason slow)
5498 {
5499     struct facet *facet = subfacet->facet;
5500     struct ofproto_dpif *ofproto = ofproto_dpif_cast(facet->rule->up.ofproto);
5501     enum subfacet_path path = subfacet_want_path(slow);
5502     uint64_t slow_path_stub[128 / 8];
5503     enum dpif_flow_put_flags flags;
5504     int ret;
5505
5506     flags = DPIF_FP_CREATE | DPIF_FP_MODIFY;
5507     if (stats) {
5508         flags |= DPIF_FP_ZERO_STATS;
5509     }
5510
5511     if (path == SF_SLOW_PATH) {
5512         compose_slow_path(ofproto, &facet->flow, slow,
5513                           slow_path_stub, sizeof slow_path_stub,
5514                           &actions, &actions_len);
5515     }
5516
5517     ret = dpif_flow_put(ofproto->backer->dpif, flags, subfacet->key,
5518                         subfacet->key_len, actions, actions_len, stats);
5519
5520     if (stats) {
5521         subfacet_reset_dp_stats(subfacet, stats);
5522     }
5523
5524     if (!ret) {
5525         subfacet->path = path;
5526     }
5527     return ret;
5528 }
5529
5530 static int
5531 subfacet_reinstall(struct subfacet *subfacet, struct dpif_flow_stats *stats)
5532 {
5533     return subfacet_install(subfacet, subfacet->actions, subfacet->actions_len,
5534                             stats, subfacet->slow);
5535 }
5536
5537 /* If 'subfacet' is installed in the datapath, uninstalls it. */
5538 static void
5539 subfacet_uninstall(struct subfacet *subfacet)
5540 {
5541     if (subfacet->path != SF_NOT_INSTALLED) {
5542         struct rule_dpif *rule = subfacet->facet->rule;
5543         struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
5544         struct dpif_flow_stats stats;
5545         int error;
5546
5547         error = dpif_flow_del(ofproto->backer->dpif, subfacet->key,
5548                               subfacet->key_len, &stats);
5549         subfacet_reset_dp_stats(subfacet, &stats);
5550         if (!error) {
5551             subfacet_update_stats(subfacet, &stats);
5552         }
5553         subfacet->path = SF_NOT_INSTALLED;
5554     } else {
5555         ovs_assert(subfacet->dp_packet_count == 0);
5556         ovs_assert(subfacet->dp_byte_count == 0);
5557     }
5558 }
5559
5560 /* Resets 'subfacet''s datapath statistics counters.  This should be called
5561  * when 'subfacet''s statistics are cleared in the datapath.  If 'stats' is
5562  * non-null, it should contain the statistics returned by dpif when 'subfacet'
5563  * was reset in the datapath.  'stats' will be modified to include only
5564  * statistics new since 'subfacet' was last updated. */
5565 static void
5566 subfacet_reset_dp_stats(struct subfacet *subfacet,
5567                         struct dpif_flow_stats *stats)
5568 {
5569     if (stats
5570         && subfacet->dp_packet_count <= stats->n_packets
5571         && subfacet->dp_byte_count <= stats->n_bytes) {
5572         stats->n_packets -= subfacet->dp_packet_count;
5573         stats->n_bytes -= subfacet->dp_byte_count;
5574     }
5575
5576     subfacet->dp_packet_count = 0;
5577     subfacet->dp_byte_count = 0;
5578 }
5579
5580 /* Updates 'subfacet''s used time.  The caller is responsible for calling
5581  * facet_push_stats() to update the flows which 'subfacet' resubmits into. */
5582 static void
5583 subfacet_update_time(struct subfacet *subfacet, long long int used)
5584 {
5585     if (used > subfacet->used) {
5586         subfacet->used = used;
5587         facet_update_time(subfacet->facet, used);
5588     }
5589 }
5590
5591 /* Folds the statistics from 'stats' into the counters in 'subfacet'.
5592  *
5593  * Because of the meaning of a subfacet's counters, it only makes sense to do
5594  * this if 'stats' are not tracked in the datapath, that is, if 'stats'
5595  * represents a packet that was sent by hand or if it represents statistics
5596  * that have been cleared out of the datapath. */
5597 static void
5598 subfacet_update_stats(struct subfacet *subfacet,
5599                       const struct dpif_flow_stats *stats)
5600 {
5601     if (stats->n_packets || stats->used > subfacet->used) {
5602         struct facet *facet = subfacet->facet;
5603
5604         subfacet_update_time(subfacet, stats->used);
5605         facet->packet_count += stats->n_packets;
5606         facet->byte_count += stats->n_bytes;
5607         facet->tcp_flags |= stats->tcp_flags;
5608         netflow_flow_update_flags(&facet->nf_flow, stats->tcp_flags);
5609     }
5610 }
5611 \f
5612 /* Rules. */
5613
5614 static struct rule_dpif *
5615 rule_dpif_lookup(struct ofproto_dpif *ofproto, const struct flow *flow)
5616 {
5617     struct rule_dpif *rule;
5618
5619     rule = rule_dpif_lookup__(ofproto, flow, 0);
5620     if (rule) {
5621         return rule;
5622     }
5623
5624     return rule_dpif_miss_rule(ofproto, flow);
5625 }
5626
5627 static struct rule_dpif *
5628 rule_dpif_lookup__(struct ofproto_dpif *ofproto, const struct flow *flow,
5629                    uint8_t table_id)
5630 {
5631     struct cls_rule *cls_rule;
5632     struct classifier *cls;
5633
5634     if (table_id >= N_TABLES) {
5635         return NULL;
5636     }
5637
5638     cls = &ofproto->up.tables[table_id].cls;
5639     if (flow->nw_frag & FLOW_NW_FRAG_ANY
5640         && ofproto->up.frag_handling == OFPC_FRAG_NORMAL) {
5641         /* For OFPC_NORMAL frag_handling, we must pretend that transport ports
5642          * are unavailable. */
5643         struct flow ofpc_normal_flow = *flow;
5644         ofpc_normal_flow.tp_src = htons(0);
5645         ofpc_normal_flow.tp_dst = htons(0);
5646         cls_rule = classifier_lookup(cls, &ofpc_normal_flow);
5647     } else {
5648         cls_rule = classifier_lookup(cls, flow);
5649     }
5650     return rule_dpif_cast(rule_from_cls_rule(cls_rule));
5651 }
5652
5653 static struct rule_dpif *
5654 rule_dpif_miss_rule(struct ofproto_dpif *ofproto, const struct flow *flow)
5655 {
5656     struct ofport_dpif *port;
5657
5658     port = get_ofp_port(ofproto, flow->in_port);
5659     if (!port) {
5660         VLOG_WARN_RL(&rl, "packet-in on unknown port %"PRIu16, flow->in_port);
5661         return ofproto->miss_rule;
5662     }
5663
5664     if (port->up.pp.config & OFPUTIL_PC_NO_PACKET_IN) {
5665         return ofproto->no_packet_in_rule;
5666     }
5667     return ofproto->miss_rule;
5668 }
5669
5670 static void
5671 complete_operation(struct rule_dpif *rule)
5672 {
5673     struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
5674
5675     rule_invalidate(rule);
5676     if (clogged) {
5677         struct dpif_completion *c = xmalloc(sizeof *c);
5678         c->op = rule->up.pending;
5679         list_push_back(&ofproto->completions, &c->list_node);
5680     } else {
5681         ofoperation_complete(rule->up.pending, 0);
5682     }
5683 }
5684
5685 static struct rule *
5686 rule_alloc(void)
5687 {
5688     struct rule_dpif *rule = xmalloc(sizeof *rule);
5689     return &rule->up;
5690 }
5691
5692 static void
5693 rule_dealloc(struct rule *rule_)
5694 {
5695     struct rule_dpif *rule = rule_dpif_cast(rule_);
5696     free(rule);
5697 }
5698
5699 static enum ofperr
5700 rule_construct(struct rule *rule_)
5701 {
5702     struct rule_dpif *rule = rule_dpif_cast(rule_);
5703     struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
5704     struct rule_dpif *victim;
5705     uint8_t table_id;
5706
5707     rule->packet_count = 0;
5708     rule->byte_count = 0;
5709
5710     victim = rule_dpif_cast(ofoperation_get_victim(rule->up.pending));
5711     if (victim && !list_is_empty(&victim->facets)) {
5712         struct facet *facet;
5713
5714         rule->facets = victim->facets;
5715         list_moved(&rule->facets);
5716         LIST_FOR_EACH (facet, list_node, &rule->facets) {
5717             /* XXX: We're only clearing our local counters here.  It's possible
5718              * that quite a few packets are unaccounted for in the datapath
5719              * statistics.  These will be accounted to the new rule instead of
5720              * cleared as required.  This could be fixed by clearing out the
5721              * datapath statistics for this facet, but currently it doesn't
5722              * seem worth it. */
5723             facet_reset_counters(facet);
5724             facet->rule = rule;
5725         }
5726     } else {
5727         /* Must avoid list_moved() in this case. */
5728         list_init(&rule->facets);
5729     }
5730
5731     table_id = rule->up.table_id;
5732     if (victim) {
5733         rule->tag = victim->tag;
5734     } else if (table_id == 0) {
5735         rule->tag = 0;
5736     } else {
5737         struct flow flow;
5738
5739         miniflow_expand(&rule->up.cr.match.flow, &flow);
5740         rule->tag = rule_calculate_tag(&flow, &rule->up.cr.match.mask,
5741                                        ofproto->tables[table_id].basis);
5742     }
5743
5744     complete_operation(rule);
5745     return 0;
5746 }
5747
5748 static void
5749 rule_destruct(struct rule *rule_)
5750 {
5751     struct rule_dpif *rule = rule_dpif_cast(rule_);
5752     struct facet *facet, *next_facet;
5753
5754     LIST_FOR_EACH_SAFE (facet, next_facet, list_node, &rule->facets) {
5755         facet_revalidate(facet);
5756     }
5757
5758     complete_operation(rule);
5759 }
5760
5761 static void
5762 rule_get_stats(struct rule *rule_, uint64_t *packets, uint64_t *bytes)
5763 {
5764     struct rule_dpif *rule = rule_dpif_cast(rule_);
5765     struct facet *facet;
5766
5767     /* push_all_stats() can handle flow misses which, when using the learn
5768      * action, can cause rules to be added and deleted.  This can corrupt our
5769      * caller's datastructures which assume that rule_get_stats() doesn't have
5770      * an impact on the flow table. To be safe, we disable miss handling. */
5771     push_all_stats__(false);
5772
5773     /* Start from historical data for 'rule' itself that are no longer tracked
5774      * in facets.  This counts, for example, facets that have expired. */
5775     *packets = rule->packet_count;
5776     *bytes = rule->byte_count;
5777
5778     /* Add any statistics that are tracked by facets.  This includes
5779      * statistical data recently updated by ofproto_update_stats() as well as
5780      * stats for packets that were executed "by hand" via dpif_execute(). */
5781     LIST_FOR_EACH (facet, list_node, &rule->facets) {
5782         *packets += facet->packet_count;
5783         *bytes += facet->byte_count;
5784     }
5785 }
5786
5787 static void
5788 rule_dpif_execute(struct rule_dpif *rule, const struct flow *flow,
5789                   struct ofpbuf *packet)
5790 {
5791     struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
5792     struct initial_vals initial_vals;
5793     struct dpif_flow_stats stats;
5794     struct action_xlate_ctx ctx;
5795     uint64_t odp_actions_stub[1024 / 8];
5796     struct ofpbuf odp_actions;
5797
5798     dpif_flow_stats_extract(flow, packet, time_msec(), &stats);
5799     rule_credit_stats(rule, &stats);
5800
5801     initial_vals.vlan_tci = flow->vlan_tci;
5802     ofpbuf_use_stub(&odp_actions, odp_actions_stub, sizeof odp_actions_stub);
5803     action_xlate_ctx_init(&ctx, ofproto, flow, &initial_vals,
5804                           rule, stats.tcp_flags, packet);
5805     ctx.resubmit_stats = &stats;
5806     xlate_actions(&ctx, rule->up.ofpacts, rule->up.ofpacts_len, &odp_actions);
5807
5808     execute_odp_actions(ofproto, flow, odp_actions.data,
5809                         odp_actions.size, packet);
5810
5811     ofpbuf_uninit(&odp_actions);
5812 }
5813
5814 static enum ofperr
5815 rule_execute(struct rule *rule, const struct flow *flow,
5816              struct ofpbuf *packet)
5817 {
5818     rule_dpif_execute(rule_dpif_cast(rule), flow, packet);
5819     ofpbuf_delete(packet);
5820     return 0;
5821 }
5822
5823 static void
5824 rule_modify_actions(struct rule *rule_)
5825 {
5826     struct rule_dpif *rule = rule_dpif_cast(rule_);
5827
5828     complete_operation(rule);
5829 }
5830 \f
5831 /* Sends 'packet' out 'ofport'.
5832  * May modify 'packet'.
5833  * Returns 0 if successful, otherwise a positive errno value. */
5834 static int
5835 send_packet(const struct ofport_dpif *ofport, struct ofpbuf *packet)
5836 {
5837     const struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofport->up.ofproto);
5838     uint64_t odp_actions_stub[1024 / 8];
5839     struct ofpbuf key, odp_actions;
5840     struct odputil_keybuf keybuf;
5841     uint32_t odp_port;
5842     struct flow flow;
5843     int error;
5844
5845     flow_extract(packet, 0, 0, NULL, OFPP_LOCAL, &flow);
5846     if (netdev_vport_is_patch(ofport->up.netdev)) {
5847         struct ofproto_dpif *peer_ofproto;
5848         struct dpif_flow_stats stats;
5849         struct ofport_dpif *peer;
5850         struct rule_dpif *rule;
5851
5852         peer = ofport_get_peer(ofport);
5853         if (!peer) {
5854             return ENODEV;
5855         }
5856
5857         dpif_flow_stats_extract(&flow, packet, time_msec(), &stats);
5858         netdev_vport_inc_tx(ofport->up.netdev, &stats);
5859         netdev_vport_inc_rx(peer->up.netdev, &stats);
5860
5861         flow.in_port = peer->up.ofp_port;
5862         peer_ofproto = ofproto_dpif_cast(peer->up.ofproto);
5863         rule = rule_dpif_lookup(peer_ofproto, &flow);
5864         rule_dpif_execute(rule, &flow, packet);
5865
5866         return 0;
5867     }
5868
5869     ofpbuf_use_stub(&odp_actions, odp_actions_stub, sizeof odp_actions_stub);
5870
5871     if (ofport->tnl_port) {
5872         struct dpif_flow_stats stats;
5873
5874         odp_port = tnl_port_send(ofport->tnl_port, &flow);
5875         if (odp_port == OVSP_NONE) {
5876             return ENODEV;
5877         }
5878
5879         dpif_flow_stats_extract(&flow, packet, time_msec(), &stats);
5880         netdev_vport_inc_tx(ofport->up.netdev, &stats);
5881         odp_put_tunnel_action(&flow.tunnel, &odp_actions);
5882         odp_put_skb_mark_action(flow.skb_mark, &odp_actions);
5883     } else {
5884         odp_port = vsp_realdev_to_vlandev(ofproto, ofport->odp_port,
5885                                           flow.vlan_tci);
5886         if (odp_port != ofport->odp_port) {
5887             eth_pop_vlan(packet);
5888             flow.vlan_tci = htons(0);
5889         }
5890     }
5891
5892     ofpbuf_use_stack(&key, &keybuf, sizeof keybuf);
5893     odp_flow_key_from_flow(&key, &flow,
5894                            ofp_port_to_odp_port(ofproto, flow.in_port));
5895
5896     compose_sflow_action(ofproto, &odp_actions, &flow, odp_port);
5897     compose_ipfix_action(ofproto, &odp_actions, &flow);
5898
5899     nl_msg_put_u32(&odp_actions, OVS_ACTION_ATTR_OUTPUT, odp_port);
5900     error = dpif_execute(ofproto->backer->dpif,
5901                          key.data, key.size,
5902                          odp_actions.data, odp_actions.size,
5903                          packet);
5904     ofpbuf_uninit(&odp_actions);
5905
5906     if (error) {
5907         VLOG_WARN_RL(&rl, "%s: failed to send packet on port %"PRIu32" (%s)",
5908                      ofproto->up.name, odp_port, strerror(error));
5909     }
5910     ofproto_update_local_port_stats(ofport->up.ofproto, packet->size, 0);
5911     return error;
5912 }
5913 \f
5914 /* OpenFlow to datapath action translation. */
5915
5916 static bool may_receive(const struct ofport_dpif *, struct action_xlate_ctx *);
5917 static void do_xlate_actions(const struct ofpact *, size_t ofpacts_len,
5918                              struct action_xlate_ctx *);
5919 static void xlate_normal(struct action_xlate_ctx *);
5920
5921 /* Composes an ODP action for a "slow path" action for 'flow' within 'ofproto'.
5922  * The action will state 'slow' as the reason that the action is in the slow
5923  * path.  (This is purely informational: it allows a human viewing "ovs-dpctl
5924  * dump-flows" output to see why a flow is in the slow path.)
5925  *
5926  * The 'stub_size' bytes in 'stub' will be used to store the action.
5927  * 'stub_size' must be large enough for the action.
5928  *
5929  * The action and its size will be stored in '*actionsp' and '*actions_lenp',
5930  * respectively. */
5931 static void
5932 compose_slow_path(const struct ofproto_dpif *ofproto, const struct flow *flow,
5933                   enum slow_path_reason slow,
5934                   uint64_t *stub, size_t stub_size,
5935                   const struct nlattr **actionsp, size_t *actions_lenp)
5936 {
5937     union user_action_cookie cookie;
5938     struct ofpbuf buf;
5939
5940     cookie.type = USER_ACTION_COOKIE_SLOW_PATH;
5941     cookie.slow_path.unused = 0;
5942     cookie.slow_path.reason = slow;
5943
5944     ofpbuf_use_stack(&buf, stub, stub_size);
5945     if (slow & (SLOW_CFM | SLOW_BFD | SLOW_LACP | SLOW_STP)) {
5946         uint32_t pid = dpif_port_get_pid(ofproto->backer->dpif, UINT32_MAX);
5947         odp_put_userspace_action(pid, &cookie, sizeof cookie.slow_path, &buf);
5948     } else {
5949         put_userspace_action(ofproto, &buf, flow, &cookie,
5950                              sizeof cookie.slow_path);
5951     }
5952     *actionsp = buf.data;
5953     *actions_lenp = buf.size;
5954 }
5955
5956 static size_t
5957 put_userspace_action(const struct ofproto_dpif *ofproto,
5958                      struct ofpbuf *odp_actions,
5959                      const struct flow *flow,
5960                      const union user_action_cookie *cookie,
5961                      const size_t cookie_size)
5962 {
5963     uint32_t pid;
5964
5965     pid = dpif_port_get_pid(ofproto->backer->dpif,
5966                             ofp_port_to_odp_port(ofproto, flow->in_port));
5967
5968     return odp_put_userspace_action(pid, cookie, cookie_size, odp_actions);
5969 }
5970
5971 /* Compose SAMPLE action for sFlow or IPFIX.  The given probability is
5972  * the number of packets out of UINT32_MAX to sample.  The given
5973  * cookie is passed back in the callback for each sampled packet.
5974  */
5975 static size_t
5976 compose_sample_action(const struct ofproto_dpif *ofproto,
5977                       struct ofpbuf *odp_actions,
5978                       const struct flow *flow,
5979                       const uint32_t probability,
5980                       const union user_action_cookie *cookie,
5981                       const size_t cookie_size)
5982 {
5983     size_t sample_offset, actions_offset;
5984     int cookie_offset;
5985
5986     sample_offset = nl_msg_start_nested(odp_actions, OVS_ACTION_ATTR_SAMPLE);
5987
5988     nl_msg_put_u32(odp_actions, OVS_SAMPLE_ATTR_PROBABILITY, probability);
5989
5990     actions_offset = nl_msg_start_nested(odp_actions, OVS_SAMPLE_ATTR_ACTIONS);
5991     cookie_offset = put_userspace_action(ofproto, odp_actions, flow, cookie,
5992                                          cookie_size);
5993
5994     nl_msg_end_nested(odp_actions, actions_offset);
5995     nl_msg_end_nested(odp_actions, sample_offset);
5996     return cookie_offset;
5997 }
5998
5999 static void
6000 compose_sflow_cookie(const struct ofproto_dpif *ofproto,
6001                      ovs_be16 vlan_tci, uint32_t odp_port,
6002                      unsigned int n_outputs, union user_action_cookie *cookie)
6003 {
6004     int ifindex;
6005
6006     cookie->type = USER_ACTION_COOKIE_SFLOW;
6007     cookie->sflow.vlan_tci = vlan_tci;
6008
6009     /* See http://www.sflow.org/sflow_version_5.txt (search for "Input/output
6010      * port information") for the interpretation of cookie->output. */
6011     switch (n_outputs) {
6012     case 0:
6013         /* 0x40000000 | 256 means "packet dropped for unknown reason". */
6014         cookie->sflow.output = 0x40000000 | 256;
6015         break;
6016
6017     case 1:
6018         ifindex = dpif_sflow_odp_port_to_ifindex(ofproto->sflow, odp_port);
6019         if (ifindex) {
6020             cookie->sflow.output = ifindex;
6021             break;
6022         }
6023         /* Fall through. */
6024     default:
6025         /* 0x80000000 means "multiple output ports. */
6026         cookie->sflow.output = 0x80000000 | n_outputs;
6027         break;
6028     }
6029 }
6030
6031 /* Compose SAMPLE action for sFlow bridge sampling. */
6032 static size_t
6033 compose_sflow_action(const struct ofproto_dpif *ofproto,
6034                      struct ofpbuf *odp_actions,
6035                      const struct flow *flow,
6036                      uint32_t odp_port)
6037 {
6038     uint32_t probability;
6039     union user_action_cookie cookie;
6040
6041     if (!ofproto->sflow || flow->in_port == OFPP_NONE) {
6042         return 0;
6043     }
6044
6045     probability = dpif_sflow_get_probability(ofproto->sflow);
6046     compose_sflow_cookie(ofproto, htons(0), odp_port,
6047                          odp_port == OVSP_NONE ? 0 : 1, &cookie);
6048
6049     return compose_sample_action(ofproto, odp_actions, flow,  probability,
6050                                  &cookie, sizeof cookie.sflow);
6051 }
6052
6053 static void
6054 compose_flow_sample_cookie(uint16_t probability, uint32_t collector_set_id,
6055                            uint32_t obs_domain_id, uint32_t obs_point_id,
6056                            union user_action_cookie *cookie)
6057 {
6058     cookie->type = USER_ACTION_COOKIE_FLOW_SAMPLE;
6059     cookie->flow_sample.probability = probability;
6060     cookie->flow_sample.collector_set_id = collector_set_id;
6061     cookie->flow_sample.obs_domain_id = obs_domain_id;
6062     cookie->flow_sample.obs_point_id = obs_point_id;
6063 }
6064
6065 static void
6066 compose_ipfix_cookie(union user_action_cookie *cookie)
6067 {
6068     cookie->type = USER_ACTION_COOKIE_IPFIX;
6069 }
6070
6071 /* Compose SAMPLE action for IPFIX bridge sampling. */
6072 static void
6073 compose_ipfix_action(const struct ofproto_dpif *ofproto,
6074                      struct ofpbuf *odp_actions,
6075                      const struct flow *flow)
6076 {
6077     uint32_t probability;
6078     union user_action_cookie cookie;
6079
6080     if (!ofproto->ipfix || flow->in_port == OFPP_NONE) {
6081         return;
6082     }
6083
6084     probability = dpif_ipfix_get_bridge_exporter_probability(ofproto->ipfix);
6085     compose_ipfix_cookie(&cookie);
6086
6087     compose_sample_action(ofproto, odp_actions, flow,  probability,
6088                           &cookie, sizeof cookie.ipfix);
6089 }
6090
6091 /* SAMPLE action for sFlow must be first action in any given list of
6092  * actions.  At this point we do not have all information required to
6093  * build it. So try to build sample action as complete as possible. */
6094 static void
6095 add_sflow_action(struct action_xlate_ctx *ctx)
6096 {
6097     ctx->user_cookie_offset = compose_sflow_action(ctx->ofproto,
6098                                                    ctx->odp_actions,
6099                                                    &ctx->flow, OVSP_NONE);
6100     ctx->sflow_odp_port = 0;
6101     ctx->sflow_n_outputs = 0;
6102 }
6103
6104 /* SAMPLE action for IPFIX must be 1st or 2nd action in any given list
6105  * of actions, eventually after the SAMPLE action for sFlow. */
6106 static void
6107 add_ipfix_action(struct action_xlate_ctx *ctx)
6108 {
6109     compose_ipfix_action(ctx->ofproto, ctx->odp_actions, &ctx->flow);
6110 }
6111
6112 /* Fix SAMPLE action according to data collected while composing ODP actions.
6113  * We need to fix SAMPLE actions OVS_SAMPLE_ATTR_ACTIONS attribute, i.e. nested
6114  * USERSPACE action's user-cookie which is required for sflow. */
6115 static void
6116 fix_sflow_action(struct action_xlate_ctx *ctx)
6117 {
6118     const struct flow *base = &ctx->base_flow;
6119     union user_action_cookie *cookie;
6120
6121     if (!ctx->user_cookie_offset) {
6122         return;
6123     }
6124
6125     cookie = ofpbuf_at(ctx->odp_actions, ctx->user_cookie_offset,
6126                        sizeof cookie->sflow);
6127     ovs_assert(cookie->type == USER_ACTION_COOKIE_SFLOW);
6128
6129     compose_sflow_cookie(ctx->ofproto, base->vlan_tci,
6130                          ctx->sflow_odp_port, ctx->sflow_n_outputs, cookie);
6131 }
6132
6133 static void
6134 compose_output_action__(struct action_xlate_ctx *ctx, uint16_t ofp_port,
6135                         bool check_stp)
6136 {
6137     const struct ofport_dpif *ofport = get_ofp_port(ctx->ofproto, ofp_port);
6138     ovs_be16 flow_vlan_tci;
6139     uint32_t flow_skb_mark;
6140     uint8_t flow_nw_tos;
6141     struct priority_to_dscp *pdscp;
6142     uint32_t out_port, odp_port;
6143
6144     /* If 'struct flow' gets additional metadata, we'll need to zero it out
6145      * before traversing a patch port. */
6146     BUILD_ASSERT_DECL(FLOW_WC_SEQ == 20);
6147
6148     if (!ofport) {
6149         xlate_report(ctx, "Nonexistent output port");
6150         return;
6151     } else if (ofport->up.pp.config & OFPUTIL_PC_NO_FWD) {
6152         xlate_report(ctx, "OFPPC_NO_FWD set, skipping output");
6153         return;
6154     } else if (check_stp && !stp_forward_in_state(ofport->stp_state)) {
6155         xlate_report(ctx, "STP not in forwarding state, skipping output");
6156         return;
6157     }
6158
6159     if (netdev_vport_is_patch(ofport->up.netdev)) {
6160         struct ofport_dpif *peer = ofport_get_peer(ofport);
6161         struct flow old_flow = ctx->flow;
6162         const struct ofproto_dpif *peer_ofproto;
6163         enum slow_path_reason special;
6164         struct ofport_dpif *in_port;
6165
6166         if (!peer) {
6167             xlate_report(ctx, "Nonexistent patch port peer");
6168             return;
6169         }
6170
6171         peer_ofproto = ofproto_dpif_cast(peer->up.ofproto);
6172         if (peer_ofproto->backer != ctx->ofproto->backer) {
6173             xlate_report(ctx, "Patch port peer on a different datapath");
6174             return;
6175         }
6176
6177         ctx->ofproto = ofproto_dpif_cast(peer->up.ofproto);
6178         ctx->flow.in_port = peer->up.ofp_port;
6179         ctx->flow.metadata = htonll(0);
6180         memset(&ctx->flow.tunnel, 0, sizeof ctx->flow.tunnel);
6181         memset(ctx->flow.regs, 0, sizeof ctx->flow.regs);
6182
6183         in_port = get_ofp_port(ctx->ofproto, ctx->flow.in_port);
6184         special = process_special(ctx->ofproto, &ctx->flow, in_port,
6185                                   ctx->packet);
6186         if (special) {
6187             ctx->slow |= special;
6188         } else if (!in_port || may_receive(in_port, ctx)) {
6189             if (!in_port || stp_forward_in_state(in_port->stp_state)) {
6190                 xlate_table_action(ctx, ctx->flow.in_port, 0, true);
6191             } else {
6192                 /* Forwarding is disabled by STP.  Let OFPP_NORMAL and the
6193                  * learning action look at the packet, then drop it. */
6194                 struct flow old_base_flow = ctx->base_flow;
6195                 size_t old_size = ctx->odp_actions->size;
6196                 xlate_table_action(ctx, ctx->flow.in_port, 0, true);
6197                 ctx->base_flow = old_base_flow;
6198                 ctx->odp_actions->size = old_size;
6199             }
6200         }
6201
6202         ctx->flow = old_flow;
6203         ctx->ofproto = ofproto_dpif_cast(ofport->up.ofproto);
6204
6205         if (ctx->resubmit_stats) {
6206             netdev_vport_inc_tx(ofport->up.netdev, ctx->resubmit_stats);
6207             netdev_vport_inc_rx(peer->up.netdev, ctx->resubmit_stats);
6208         }
6209
6210         return;
6211     }
6212
6213     flow_vlan_tci = ctx->flow.vlan_tci;
6214     flow_skb_mark = ctx->flow.skb_mark;
6215     flow_nw_tos = ctx->flow.nw_tos;
6216
6217     pdscp = get_priority(ofport, ctx->flow.skb_priority);
6218     if (pdscp) {
6219         ctx->flow.nw_tos &= ~IP_DSCP_MASK;
6220         ctx->flow.nw_tos |= pdscp->dscp;
6221     }
6222
6223     if (ofport->tnl_port) {
6224          /* Save tunnel metadata so that changes made due to
6225           * the Logical (tunnel) Port are not visible for any further
6226           * matches, while explicit set actions on tunnel metadata are.
6227           */
6228         struct flow_tnl flow_tnl = ctx->flow.tunnel;
6229         odp_port = tnl_port_send(ofport->tnl_port, &ctx->flow);
6230         if (odp_port == OVSP_NONE) {
6231             xlate_report(ctx, "Tunneling decided against output");
6232             goto out; /* restore flow_nw_tos */
6233         }
6234
6235         if (ctx->resubmit_stats) {
6236             netdev_vport_inc_tx(ofport->up.netdev, ctx->resubmit_stats);
6237         }
6238         out_port = odp_port;
6239         commit_odp_tunnel_action(&ctx->flow, &ctx->base_flow,
6240                                  ctx->odp_actions);
6241         ctx->flow.tunnel = flow_tnl; /* Restore tunnel metadata */
6242     } else {
6243         odp_port = ofport->odp_port;
6244         out_port = vsp_realdev_to_vlandev(ctx->ofproto, odp_port,
6245                                           ctx->flow.vlan_tci);
6246         if (out_port != odp_port) {
6247             ctx->flow.vlan_tci = htons(0);
6248         }
6249         ctx->flow.skb_mark &= ~IPSEC_MARK;
6250     }
6251     commit_odp_actions(&ctx->flow, &ctx->base_flow, ctx->odp_actions);
6252     nl_msg_put_u32(ctx->odp_actions, OVS_ACTION_ATTR_OUTPUT, out_port);
6253
6254     ctx->sflow_odp_port = odp_port;
6255     ctx->sflow_n_outputs++;
6256     ctx->nf_output_iface = ofp_port;
6257
6258     /* Restore flow */
6259     ctx->flow.vlan_tci = flow_vlan_tci;
6260     ctx->flow.skb_mark = flow_skb_mark;
6261  out:
6262     ctx->flow.nw_tos = flow_nw_tos;
6263 }
6264
6265 static void
6266 compose_output_action(struct action_xlate_ctx *ctx, uint16_t ofp_port)
6267 {
6268     compose_output_action__(ctx, ofp_port, true);
6269 }
6270
6271 static void
6272 tag_the_flow(struct action_xlate_ctx *ctx, struct rule_dpif *rule)
6273 {
6274     struct ofproto_dpif *ofproto = ctx->ofproto;
6275     uint8_t table_id = ctx->table_id;
6276
6277     if (table_id > 0 && table_id < N_TABLES) {
6278         struct table_dpif *table = &ofproto->tables[table_id];
6279         if (table->other_table) {
6280             ctx->tags |= (rule && rule->tag
6281                           ? rule->tag
6282                           : rule_calculate_tag(&ctx->flow,
6283                                                &table->other_table->mask,
6284                                                table->basis));
6285         }
6286     }
6287 }
6288
6289 /* Common rule processing in one place to avoid duplicating code. */
6290 static struct rule_dpif *
6291 ctx_rule_hooks(struct action_xlate_ctx *ctx, struct rule_dpif *rule,
6292                bool may_packet_in)
6293 {
6294     if (ctx->resubmit_hook) {
6295         ctx->resubmit_hook(ctx, rule);
6296     }
6297     if (rule == NULL && may_packet_in) {
6298         /* XXX
6299          * check if table configuration flags
6300          * OFPTC_TABLE_MISS_CONTROLLER, default.
6301          * OFPTC_TABLE_MISS_CONTINUE,
6302          * OFPTC_TABLE_MISS_DROP
6303          * When OF1.0, OFPTC_TABLE_MISS_CONTINUE is used. What to do?
6304          */
6305         rule = rule_dpif_miss_rule(ctx->ofproto, &ctx->flow);
6306     }
6307     if (rule && ctx->resubmit_stats) {
6308         rule_credit_stats(rule, ctx->resubmit_stats);
6309     }
6310     return rule;
6311 }
6312
6313 static void
6314 xlate_table_action(struct action_xlate_ctx *ctx,
6315                    uint16_t in_port, uint8_t table_id, bool may_packet_in)
6316 {
6317     if (ctx->recurse < MAX_RESUBMIT_RECURSION) {
6318         struct rule_dpif *rule;
6319         uint16_t old_in_port = ctx->flow.in_port;
6320         uint8_t old_table_id = ctx->table_id;
6321
6322         ctx->table_id = table_id;
6323
6324         /* Look up a flow with 'in_port' as the input port. */
6325         ctx->flow.in_port = in_port;
6326         rule = rule_dpif_lookup__(ctx->ofproto, &ctx->flow, table_id);
6327
6328         tag_the_flow(ctx, rule);
6329
6330         /* Restore the original input port.  Otherwise OFPP_NORMAL and
6331          * OFPP_IN_PORT will have surprising behavior. */
6332         ctx->flow.in_port = old_in_port;
6333
6334         rule = ctx_rule_hooks(ctx, rule, may_packet_in);
6335
6336         if (rule) {
6337             struct rule_dpif *old_rule = ctx->rule;
6338
6339             ctx->recurse++;
6340             ctx->rule = rule;
6341             do_xlate_actions(rule->up.ofpacts, rule->up.ofpacts_len, ctx);
6342             ctx->rule = old_rule;
6343             ctx->recurse--;
6344         }
6345
6346         ctx->table_id = old_table_id;
6347     } else {
6348         static struct vlog_rate_limit recurse_rl = VLOG_RATE_LIMIT_INIT(1, 1);
6349
6350         VLOG_ERR_RL(&recurse_rl, "resubmit actions recursed over %d times",
6351                     MAX_RESUBMIT_RECURSION);
6352         ctx->max_resubmit_trigger = true;
6353     }
6354 }
6355
6356 static void
6357 xlate_ofpact_resubmit(struct action_xlate_ctx *ctx,
6358                       const struct ofpact_resubmit *resubmit)
6359 {
6360     uint16_t in_port;
6361     uint8_t table_id;
6362
6363     in_port = resubmit->in_port;
6364     if (in_port == OFPP_IN_PORT) {
6365         in_port = ctx->flow.in_port;
6366     }
6367
6368     table_id = resubmit->table_id;
6369     if (table_id == 255) {
6370         table_id = ctx->table_id;
6371     }
6372
6373     xlate_table_action(ctx, in_port, table_id, false);
6374 }
6375
6376 static void
6377 flood_packets(struct action_xlate_ctx *ctx, bool all)
6378 {
6379     struct ofport_dpif *ofport;
6380
6381     HMAP_FOR_EACH (ofport, up.hmap_node, &ctx->ofproto->up.ports) {
6382         uint16_t ofp_port = ofport->up.ofp_port;
6383
6384         if (ofp_port == ctx->flow.in_port) {
6385             continue;
6386         }
6387
6388         if (all) {
6389             compose_output_action__(ctx, ofp_port, false);
6390         } else if (!(ofport->up.pp.config & OFPUTIL_PC_NO_FLOOD)) {
6391             compose_output_action(ctx, ofp_port);
6392         }
6393     }
6394
6395     ctx->nf_output_iface = NF_OUT_FLOOD;
6396 }
6397
6398 static void
6399 execute_controller_action(struct action_xlate_ctx *ctx, int len,
6400                           enum ofp_packet_in_reason reason,
6401                           uint16_t controller_id)
6402 {
6403     struct ofputil_packet_in pin;
6404     struct ofpbuf *packet;
6405
6406     ctx->slow |= SLOW_CONTROLLER;
6407     if (!ctx->packet) {
6408         return;
6409     }
6410
6411     packet = ofpbuf_clone(ctx->packet);
6412
6413     if (packet->l2 && packet->l3) {
6414         struct eth_header *eh;
6415         uint16_t mpls_depth;
6416
6417         eth_pop_vlan(packet);
6418         eh = packet->l2;
6419
6420         memcpy(eh->eth_src, ctx->flow.dl_src, sizeof eh->eth_src);
6421         memcpy(eh->eth_dst, ctx->flow.dl_dst, sizeof eh->eth_dst);
6422
6423         if (ctx->flow.vlan_tci & htons(VLAN_CFI)) {
6424             eth_push_vlan(packet, ctx->flow.vlan_tci);
6425         }
6426
6427         mpls_depth = eth_mpls_depth(packet);
6428
6429         if (mpls_depth < ctx->flow.mpls_depth) {
6430             push_mpls(packet, ctx->flow.dl_type, ctx->flow.mpls_lse);
6431         } else if (mpls_depth > ctx->flow.mpls_depth) {
6432             pop_mpls(packet, ctx->flow.dl_type);
6433         } else if (mpls_depth) {
6434             set_mpls_lse(packet, ctx->flow.mpls_lse);
6435         }
6436
6437         if (packet->l4) {
6438             if (ctx->flow.dl_type == htons(ETH_TYPE_IP)) {
6439                 packet_set_ipv4(packet, ctx->flow.nw_src, ctx->flow.nw_dst,
6440                                 ctx->flow.nw_tos, ctx->flow.nw_ttl);
6441             }
6442
6443             if (packet->l7) {
6444                 if (ctx->flow.nw_proto == IPPROTO_TCP) {
6445                     packet_set_tcp_port(packet, ctx->flow.tp_src,
6446                                         ctx->flow.tp_dst);
6447                 } else if (ctx->flow.nw_proto == IPPROTO_UDP) {
6448                     packet_set_udp_port(packet, ctx->flow.tp_src,
6449                                         ctx->flow.tp_dst);
6450                 }
6451             }
6452         }
6453     }
6454
6455     pin.packet = packet->data;
6456     pin.packet_len = packet->size;
6457     pin.reason = reason;
6458     pin.controller_id = controller_id;
6459     pin.table_id = ctx->table_id;
6460     pin.cookie = ctx->rule ? ctx->rule->up.flow_cookie : 0;
6461
6462     pin.send_len = len;
6463     flow_get_metadata(&ctx->flow, &pin.fmd);
6464
6465     connmgr_send_packet_in(ctx->ofproto->up.connmgr, &pin);
6466     ofpbuf_delete(packet);
6467 }
6468
6469 static void
6470 execute_mpls_push_action(struct action_xlate_ctx *ctx, ovs_be16 eth_type)
6471 {
6472     ovs_assert(eth_type_mpls(eth_type));
6473
6474     if (ctx->base_flow.mpls_depth) {
6475         ctx->flow.mpls_lse &= ~htonl(MPLS_BOS_MASK);
6476         ctx->flow.mpls_depth++;
6477     } else {
6478         ovs_be32 label;
6479         uint8_t tc, ttl;
6480
6481         if (ctx->flow.dl_type == htons(ETH_TYPE_IPV6)) {
6482             label = htonl(0x2); /* IPV6 Explicit Null. */
6483         } else {
6484             label = htonl(0x0); /* IPV4 Explicit Null. */
6485         }
6486         tc = (ctx->flow.nw_tos & IP_DSCP_MASK) >> 2;
6487         ttl = ctx->flow.nw_ttl ? ctx->flow.nw_ttl : 0x40;
6488         ctx->flow.mpls_lse = set_mpls_lse_values(ttl, tc, 1, label);
6489         ctx->flow.mpls_depth = 1;
6490     }
6491     ctx->flow.dl_type = eth_type;
6492 }
6493
6494 static void
6495 execute_mpls_pop_action(struct action_xlate_ctx *ctx, ovs_be16 eth_type)
6496 {
6497     ovs_assert(eth_type_mpls(ctx->flow.dl_type));
6498     ovs_assert(!eth_type_mpls(eth_type));
6499
6500     if (ctx->flow.mpls_depth) {
6501         ctx->flow.mpls_depth--;
6502         ctx->flow.mpls_lse = htonl(0);
6503         if (!ctx->flow.mpls_depth) {
6504             ctx->flow.dl_type = eth_type;
6505         }
6506     }
6507 }
6508
6509 static bool
6510 compose_dec_ttl(struct action_xlate_ctx *ctx, struct ofpact_cnt_ids *ids)
6511 {
6512     if (ctx->flow.dl_type != htons(ETH_TYPE_IP) &&
6513         ctx->flow.dl_type != htons(ETH_TYPE_IPV6)) {
6514         return false;
6515     }
6516
6517     if (ctx->flow.nw_ttl > 1) {
6518         ctx->flow.nw_ttl--;
6519         return false;
6520     } else {
6521         size_t i;
6522
6523         for (i = 0; i < ids->n_controllers; i++) {
6524             execute_controller_action(ctx, UINT16_MAX, OFPR_INVALID_TTL,
6525                                       ids->cnt_ids[i]);
6526         }
6527
6528         /* Stop processing for current table. */
6529         return true;
6530     }
6531 }
6532
6533 static bool
6534 execute_set_mpls_ttl_action(struct action_xlate_ctx *ctx, uint8_t ttl)
6535 {
6536     if (!eth_type_mpls(ctx->flow.dl_type)) {
6537         return true;
6538     }
6539
6540     set_mpls_lse_ttl(&ctx->flow.mpls_lse, ttl);
6541     return false;
6542 }
6543
6544 static bool
6545 execute_dec_mpls_ttl_action(struct action_xlate_ctx *ctx)
6546 {
6547     uint8_t ttl = mpls_lse_to_ttl(ctx->flow.mpls_lse);
6548
6549     if (!eth_type_mpls(ctx->flow.dl_type)) {
6550         return false;
6551     }
6552
6553     if (ttl > 1) {
6554         ttl--;
6555         set_mpls_lse_ttl(&ctx->flow.mpls_lse, ttl);
6556         return false;
6557     } else {
6558         execute_controller_action(ctx, UINT16_MAX, OFPR_INVALID_TTL, 0);
6559
6560         /* Stop processing for current table. */
6561         return true;
6562     }
6563 }
6564
6565 static void
6566 xlate_output_action(struct action_xlate_ctx *ctx,
6567                     uint16_t port, uint16_t max_len, bool may_packet_in)
6568 {
6569     uint16_t prev_nf_output_iface = ctx->nf_output_iface;
6570
6571     ctx->nf_output_iface = NF_OUT_DROP;
6572
6573     switch (port) {
6574     case OFPP_IN_PORT:
6575         compose_output_action(ctx, ctx->flow.in_port);
6576         break;
6577     case OFPP_TABLE:
6578         xlate_table_action(ctx, ctx->flow.in_port, 0, may_packet_in);
6579         break;
6580     case OFPP_NORMAL:
6581         xlate_normal(ctx);
6582         break;
6583     case OFPP_FLOOD:
6584         flood_packets(ctx,  false);
6585         break;
6586     case OFPP_ALL:
6587         flood_packets(ctx, true);
6588         break;
6589     case OFPP_CONTROLLER:
6590         execute_controller_action(ctx, max_len, OFPR_ACTION, 0);
6591         break;
6592     case OFPP_NONE:
6593         break;
6594     case OFPP_LOCAL:
6595     default:
6596         if (port != ctx->flow.in_port) {
6597             compose_output_action(ctx, port);
6598         } else {
6599             xlate_report(ctx, "skipping output to input port");
6600         }
6601         break;
6602     }
6603
6604     if (prev_nf_output_iface == NF_OUT_FLOOD) {
6605         ctx->nf_output_iface = NF_OUT_FLOOD;
6606     } else if (ctx->nf_output_iface == NF_OUT_DROP) {
6607         ctx->nf_output_iface = prev_nf_output_iface;
6608     } else if (prev_nf_output_iface != NF_OUT_DROP &&
6609                ctx->nf_output_iface != NF_OUT_FLOOD) {
6610         ctx->nf_output_iface = NF_OUT_MULTI;
6611     }
6612 }
6613
6614 static void
6615 xlate_output_reg_action(struct action_xlate_ctx *ctx,
6616                         const struct ofpact_output_reg *or)
6617 {
6618     uint64_t port = mf_get_subfield(&or->src, &ctx->flow);
6619     if (port <= UINT16_MAX) {
6620         xlate_output_action(ctx, port, or->max_len, false);
6621     }
6622 }
6623
6624 static void
6625 xlate_enqueue_action(struct action_xlate_ctx *ctx,
6626                      const struct ofpact_enqueue *enqueue)
6627 {
6628     uint16_t ofp_port = enqueue->port;
6629     uint32_t queue_id = enqueue->queue;
6630     uint32_t flow_priority, priority;
6631     int error;
6632
6633     /* Translate queue to priority. */
6634     error = dpif_queue_to_priority(ctx->ofproto->backer->dpif,
6635                                    queue_id, &priority);
6636     if (error) {
6637         /* Fall back to ordinary output action. */
6638         xlate_output_action(ctx, enqueue->port, 0, false);
6639         return;
6640     }
6641
6642     /* Check output port. */
6643     if (ofp_port == OFPP_IN_PORT) {
6644         ofp_port = ctx->flow.in_port;
6645     } else if (ofp_port == ctx->flow.in_port) {
6646         return;
6647     }
6648
6649     /* Add datapath actions. */
6650     flow_priority = ctx->flow.skb_priority;
6651     ctx->flow.skb_priority = priority;
6652     compose_output_action(ctx, ofp_port);
6653     ctx->flow.skb_priority = flow_priority;
6654
6655     /* Update NetFlow output port. */
6656     if (ctx->nf_output_iface == NF_OUT_DROP) {
6657         ctx->nf_output_iface = ofp_port;
6658     } else if (ctx->nf_output_iface != NF_OUT_FLOOD) {
6659         ctx->nf_output_iface = NF_OUT_MULTI;
6660     }
6661 }
6662
6663 static void
6664 xlate_set_queue_action(struct action_xlate_ctx *ctx, uint32_t queue_id)
6665 {
6666     uint32_t skb_priority;
6667
6668     if (!dpif_queue_to_priority(ctx->ofproto->backer->dpif,
6669                                 queue_id, &skb_priority)) {
6670         ctx->flow.skb_priority = skb_priority;
6671     } else {
6672         /* Couldn't translate queue to a priority.  Nothing to do.  A warning
6673          * has already been logged. */
6674     }
6675 }
6676
6677 static bool
6678 slave_enabled_cb(uint16_t ofp_port, void *ofproto_)
6679 {
6680     struct ofproto_dpif *ofproto = ofproto_;
6681     struct ofport_dpif *port;
6682
6683     switch (ofp_port) {
6684     case OFPP_IN_PORT:
6685     case OFPP_TABLE:
6686     case OFPP_NORMAL:
6687     case OFPP_FLOOD:
6688     case OFPP_ALL:
6689     case OFPP_NONE:
6690         return true;
6691     case OFPP_CONTROLLER: /* Not supported by the bundle action. */
6692         return false;
6693     default:
6694         port = get_ofp_port(ofproto, ofp_port);
6695         return port ? port->may_enable : false;
6696     }
6697 }
6698
6699 static void
6700 xlate_bundle_action(struct action_xlate_ctx *ctx,
6701                     const struct ofpact_bundle *bundle)
6702 {
6703     uint16_t port;
6704
6705     port = bundle_execute(bundle, &ctx->flow, slave_enabled_cb, ctx->ofproto);
6706     if (bundle->dst.field) {
6707         nxm_reg_load(&bundle->dst, port, &ctx->flow);
6708     } else {
6709         xlate_output_action(ctx, port, 0, false);
6710     }
6711 }
6712
6713 static void
6714 xlate_learn_action(struct action_xlate_ctx *ctx,
6715                    const struct ofpact_learn *learn)
6716 {
6717     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 1);
6718     struct ofputil_flow_mod fm;
6719     uint64_t ofpacts_stub[1024 / 8];
6720     struct ofpbuf ofpacts;
6721     int error;
6722
6723     ofpbuf_use_stack(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
6724     learn_execute(learn, &ctx->flow, &fm, &ofpacts);
6725
6726     error = ofproto_flow_mod(&ctx->ofproto->up, &fm);
6727     if (error && !VLOG_DROP_WARN(&rl)) {
6728         VLOG_WARN("learning action failed to modify flow table (%s)",
6729                   ofperr_get_name(error));
6730     }
6731
6732     ofpbuf_uninit(&ofpacts);
6733 }
6734
6735 /* Reduces '*timeout' to no more than 'max'.  A value of zero in either case
6736  * means "infinite". */
6737 static void
6738 reduce_timeout(uint16_t max, uint16_t *timeout)
6739 {
6740     if (max && (!*timeout || *timeout > max)) {
6741         *timeout = max;
6742     }
6743 }
6744
6745 static void
6746 xlate_fin_timeout(struct action_xlate_ctx *ctx,
6747                   const struct ofpact_fin_timeout *oft)
6748 {
6749     if (ctx->tcp_flags & (TCP_FIN | TCP_RST) && ctx->rule) {
6750         struct rule_dpif *rule = ctx->rule;
6751
6752         reduce_timeout(oft->fin_idle_timeout, &rule->up.idle_timeout);
6753         reduce_timeout(oft->fin_hard_timeout, &rule->up.hard_timeout);
6754     }
6755 }
6756
6757 static void
6758 xlate_sample_action(struct action_xlate_ctx *ctx,
6759                     const struct ofpact_sample *os)
6760 {
6761   union user_action_cookie cookie;
6762   /* Scale the probability from 16-bit to 32-bit while representing
6763    * the same percentage. */
6764   uint32_t probability = (os->probability << 16) | os->probability;
6765
6766   commit_odp_actions(&ctx->flow, &ctx->base_flow, ctx->odp_actions);
6767
6768   compose_flow_sample_cookie(os->probability, os->collector_set_id,
6769                              os->obs_domain_id, os->obs_point_id, &cookie);
6770   compose_sample_action(ctx->ofproto, ctx->odp_actions, &ctx->flow,
6771                         probability, &cookie, sizeof cookie.flow_sample);
6772 }
6773
6774 static bool
6775 may_receive(const struct ofport_dpif *port, struct action_xlate_ctx *ctx)
6776 {
6777     if (port->up.pp.config & (eth_addr_equals(ctx->flow.dl_dst, eth_addr_stp)
6778                               ? OFPUTIL_PC_NO_RECV_STP
6779                               : OFPUTIL_PC_NO_RECV)) {
6780         return false;
6781     }
6782
6783     /* Only drop packets here if both forwarding and learning are
6784      * disabled.  If just learning is enabled, we need to have
6785      * OFPP_NORMAL and the learning action have a look at the packet
6786      * before we can drop it. */
6787     if (!stp_forward_in_state(port->stp_state)
6788             && !stp_learn_in_state(port->stp_state)) {
6789         return false;
6790     }
6791
6792     return true;
6793 }
6794
6795 static bool
6796 tunnel_ecn_ok(struct action_xlate_ctx *ctx)
6797 {
6798     if (is_ip_any(&ctx->base_flow)
6799         && (ctx->flow.tunnel.ip_tos & IP_ECN_MASK) == IP_ECN_CE) {
6800         if ((ctx->base_flow.nw_tos & IP_ECN_MASK) == IP_ECN_NOT_ECT) {
6801             VLOG_WARN_RL(&rl, "dropping tunnel packet marked ECN CE"
6802                          " but is not ECN capable");
6803             return false;
6804         } else {
6805             /* Set the ECN CE value in the tunneled packet. */
6806             ctx->flow.nw_tos |= IP_ECN_CE;
6807         }
6808     }
6809
6810     return true;
6811 }
6812
6813 static void
6814 do_xlate_actions(const struct ofpact *ofpacts, size_t ofpacts_len,
6815                  struct action_xlate_ctx *ctx)
6816 {
6817     bool was_evictable = true;
6818     const struct ofpact *a;
6819
6820     if (ctx->rule) {
6821         /* Don't let the rule we're working on get evicted underneath us. */
6822         was_evictable = ctx->rule->up.evictable;
6823         ctx->rule->up.evictable = false;
6824     }
6825
6826  do_xlate_actions_again:
6827     OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
6828         struct ofpact_controller *controller;
6829         const struct ofpact_metadata *metadata;
6830
6831         if (ctx->exit) {
6832             break;
6833         }
6834
6835         switch (a->type) {
6836         case OFPACT_OUTPUT:
6837             xlate_output_action(ctx, ofpact_get_OUTPUT(a)->port,
6838                                 ofpact_get_OUTPUT(a)->max_len, true);
6839             break;
6840
6841         case OFPACT_CONTROLLER:
6842             controller = ofpact_get_CONTROLLER(a);
6843             execute_controller_action(ctx, controller->max_len,
6844                                       controller->reason,
6845                                       controller->controller_id);
6846             break;
6847
6848         case OFPACT_ENQUEUE:
6849             xlate_enqueue_action(ctx, ofpact_get_ENQUEUE(a));
6850             break;
6851
6852         case OFPACT_SET_VLAN_VID:
6853             ctx->flow.vlan_tci &= ~htons(VLAN_VID_MASK);
6854             ctx->flow.vlan_tci |= (htons(ofpact_get_SET_VLAN_VID(a)->vlan_vid)
6855                                    | htons(VLAN_CFI));
6856             break;
6857
6858         case OFPACT_SET_VLAN_PCP:
6859             ctx->flow.vlan_tci &= ~htons(VLAN_PCP_MASK);
6860             ctx->flow.vlan_tci |= htons((ofpact_get_SET_VLAN_PCP(a)->vlan_pcp
6861                                          << VLAN_PCP_SHIFT)
6862                                         | VLAN_CFI);
6863             break;
6864
6865         case OFPACT_STRIP_VLAN:
6866             ctx->flow.vlan_tci = htons(0);
6867             break;
6868
6869         case OFPACT_PUSH_VLAN:
6870             /* XXX 802.1AD(QinQ) */
6871             ctx->flow.vlan_tci = htons(VLAN_CFI);
6872             break;
6873
6874         case OFPACT_SET_ETH_SRC:
6875             memcpy(ctx->flow.dl_src, ofpact_get_SET_ETH_SRC(a)->mac,
6876                    ETH_ADDR_LEN);
6877             break;
6878
6879         case OFPACT_SET_ETH_DST:
6880             memcpy(ctx->flow.dl_dst, ofpact_get_SET_ETH_DST(a)->mac,
6881                    ETH_ADDR_LEN);
6882             break;
6883
6884         case OFPACT_SET_IPV4_SRC:
6885             if (ctx->flow.dl_type == htons(ETH_TYPE_IP)) {
6886                 ctx->flow.nw_src = ofpact_get_SET_IPV4_SRC(a)->ipv4;
6887             }
6888             break;
6889
6890         case OFPACT_SET_IPV4_DST:
6891             if (ctx->flow.dl_type == htons(ETH_TYPE_IP)) {
6892                 ctx->flow.nw_dst = ofpact_get_SET_IPV4_DST(a)->ipv4;
6893             }
6894             break;
6895
6896         case OFPACT_SET_IPV4_DSCP:
6897             /* OpenFlow 1.0 only supports IPv4. */
6898             if (ctx->flow.dl_type == htons(ETH_TYPE_IP)) {
6899                 ctx->flow.nw_tos &= ~IP_DSCP_MASK;
6900                 ctx->flow.nw_tos |= ofpact_get_SET_IPV4_DSCP(a)->dscp;
6901             }
6902             break;
6903
6904         case OFPACT_SET_L4_SRC_PORT:
6905             if (is_ip_any(&ctx->flow)) {
6906                 ctx->flow.tp_src = htons(ofpact_get_SET_L4_SRC_PORT(a)->port);
6907             }
6908             break;
6909
6910         case OFPACT_SET_L4_DST_PORT:
6911             if (is_ip_any(&ctx->flow)) {
6912                 ctx->flow.tp_dst = htons(ofpact_get_SET_L4_DST_PORT(a)->port);
6913             }
6914             break;
6915
6916         case OFPACT_RESUBMIT:
6917             xlate_ofpact_resubmit(ctx, ofpact_get_RESUBMIT(a));
6918             break;
6919
6920         case OFPACT_SET_TUNNEL:
6921             ctx->flow.tunnel.tun_id = htonll(ofpact_get_SET_TUNNEL(a)->tun_id);
6922             break;
6923
6924         case OFPACT_SET_QUEUE:
6925             xlate_set_queue_action(ctx, ofpact_get_SET_QUEUE(a)->queue_id);
6926             break;
6927
6928         case OFPACT_POP_QUEUE:
6929             ctx->flow.skb_priority = ctx->orig_skb_priority;
6930             break;
6931
6932         case OFPACT_REG_MOVE:
6933             nxm_execute_reg_move(ofpact_get_REG_MOVE(a), &ctx->flow);
6934             break;
6935
6936         case OFPACT_REG_LOAD:
6937             nxm_execute_reg_load(ofpact_get_REG_LOAD(a), &ctx->flow);
6938             break;
6939
6940         case OFPACT_STACK_PUSH:
6941             nxm_execute_stack_push(ofpact_get_STACK_PUSH(a), &ctx->flow,
6942                                    &ctx->stack);
6943             break;
6944
6945         case OFPACT_STACK_POP:
6946             nxm_execute_stack_pop(ofpact_get_STACK_POP(a), &ctx->flow,
6947                                   &ctx->stack);
6948             break;
6949
6950         case OFPACT_PUSH_MPLS:
6951             execute_mpls_push_action(ctx, ofpact_get_PUSH_MPLS(a)->ethertype);
6952             break;
6953
6954         case OFPACT_POP_MPLS:
6955             execute_mpls_pop_action(ctx, ofpact_get_POP_MPLS(a)->ethertype);
6956             break;
6957
6958         case OFPACT_SET_MPLS_TTL:
6959             if (execute_set_mpls_ttl_action(ctx, ofpact_get_SET_MPLS_TTL(a)->ttl)) {
6960                 goto out;
6961             }
6962             break;
6963
6964         case OFPACT_DEC_MPLS_TTL:
6965             if (execute_dec_mpls_ttl_action(ctx)) {
6966                 goto out;
6967             }
6968             break;
6969
6970         case OFPACT_DEC_TTL:
6971             if (compose_dec_ttl(ctx, ofpact_get_DEC_TTL(a))) {
6972                 goto out;
6973             }
6974             break;
6975
6976         case OFPACT_NOTE:
6977             /* Nothing to do. */
6978             break;
6979
6980         case OFPACT_MULTIPATH:
6981             multipath_execute(ofpact_get_MULTIPATH(a), &ctx->flow);
6982             break;
6983
6984         case OFPACT_BUNDLE:
6985             ctx->ofproto->has_bundle_action = true;
6986             xlate_bundle_action(ctx, ofpact_get_BUNDLE(a));
6987             break;
6988
6989         case OFPACT_OUTPUT_REG:
6990             xlate_output_reg_action(ctx, ofpact_get_OUTPUT_REG(a));
6991             break;
6992
6993         case OFPACT_LEARN:
6994             ctx->has_learn = true;
6995             if (ctx->may_learn) {
6996                 xlate_learn_action(ctx, ofpact_get_LEARN(a));
6997             }
6998             break;
6999
7000         case OFPACT_EXIT:
7001             ctx->exit = true;
7002             break;
7003
7004         case OFPACT_FIN_TIMEOUT:
7005             ctx->has_fin_timeout = true;
7006             xlate_fin_timeout(ctx, ofpact_get_FIN_TIMEOUT(a));
7007             break;
7008
7009         case OFPACT_CLEAR_ACTIONS:
7010             /* XXX
7011              * Nothing to do because writa-actions is not supported for now.
7012              * When writa-actions is supported, clear-actions also must
7013              * be supported at the same time.
7014              */
7015             break;
7016
7017         case OFPACT_WRITE_METADATA:
7018             metadata = ofpact_get_WRITE_METADATA(a);
7019             ctx->flow.metadata &= ~metadata->mask;
7020             ctx->flow.metadata |= metadata->metadata & metadata->mask;
7021             break;
7022
7023         case OFPACT_GOTO_TABLE: {
7024             /* It is assumed that goto-table is the last action. */
7025             struct ofpact_goto_table *ogt = ofpact_get_GOTO_TABLE(a);
7026             struct rule_dpif *rule;
7027
7028             ovs_assert(ctx->table_id < ogt->table_id);
7029
7030             ctx->table_id = ogt->table_id;
7031
7032             /* Look up a flow from the new table. */
7033             rule = rule_dpif_lookup__(ctx->ofproto, &ctx->flow, ctx->table_id);
7034
7035             tag_the_flow(ctx, rule);
7036
7037             rule = ctx_rule_hooks(ctx, rule, true);
7038
7039             if (rule) {
7040                 if (ctx->rule) {
7041                     ctx->rule->up.evictable = was_evictable;
7042                 }
7043                 ctx->rule = rule;
7044                 was_evictable = rule->up.evictable;
7045                 rule->up.evictable = false;
7046
7047                 /* Tail recursion removal. */
7048                 ofpacts = rule->up.ofpacts;
7049                 ofpacts_len = rule->up.ofpacts_len;
7050                 goto do_xlate_actions_again;
7051             }
7052             break;
7053         }
7054
7055         case OFPACT_SAMPLE:
7056             xlate_sample_action(ctx, ofpact_get_SAMPLE(a));
7057             break;
7058         }
7059     }
7060
7061 out:
7062     if (ctx->rule) {
7063         ctx->rule->up.evictable = was_evictable;
7064     }
7065 }
7066
7067 static void
7068 action_xlate_ctx_init(struct action_xlate_ctx *ctx,
7069                       struct ofproto_dpif *ofproto, const struct flow *flow,
7070                       const struct initial_vals *initial_vals,
7071                       struct rule_dpif *rule,
7072                       uint8_t tcp_flags, const struct ofpbuf *packet)
7073 {
7074     /* Flow initialization rules:
7075      * - 'base_flow' must match the kernel's view of the packet at the
7076      *   time that action processing starts.  'flow' represents any
7077      *   transformations we wish to make through actions.
7078      * - By default 'base_flow' and 'flow' are the same since the input
7079      *   packet matches the output before any actions are applied.
7080      * - When using VLAN splinters, 'base_flow''s VLAN is set to the value
7081      *   of the received packet as seen by the kernel.  If we later output
7082      *   to another device without any modifications this will cause us to
7083      *   insert a new tag since the original one was stripped off by the
7084      *   VLAN device.
7085      * - Tunnel metadata as received is retained in 'flow'. This allows
7086      *   tunnel metadata matching also in later tables.
7087      *   Since a kernel action for setting the tunnel metadata will only be
7088      *   generated with actual tunnel output, changing the tunnel metadata
7089      *   values in 'flow' (such as tun_id) will only have effect with a later
7090      *   tunnel output action.
7091      * - Tunnel 'base_flow' is completely cleared since that is what the
7092      *   kernel does.  If we wish to maintain the original values an action
7093      *   needs to be generated. */
7094
7095     ctx->ofproto = ofproto;
7096     ctx->flow = *flow;
7097     ctx->base_flow = ctx->flow;
7098     memset(&ctx->base_flow.tunnel, 0, sizeof ctx->base_flow.tunnel);
7099     ctx->base_flow.vlan_tci = initial_vals->vlan_tci;
7100     ctx->rule = rule;
7101     ctx->packet = packet;
7102     ctx->may_learn = packet != NULL;
7103     ctx->tcp_flags = tcp_flags;
7104     ctx->resubmit_hook = NULL;
7105     ctx->report_hook = NULL;
7106     ctx->resubmit_stats = NULL;
7107 }
7108
7109 /* Translates the 'ofpacts_len' bytes of "struct ofpacts" starting at 'ofpacts'
7110  * into datapath actions in 'odp_actions', using 'ctx'. */
7111 static void
7112 xlate_actions(struct action_xlate_ctx *ctx,
7113               const struct ofpact *ofpacts, size_t ofpacts_len,
7114               struct ofpbuf *odp_actions)
7115 {
7116     /* Normally false.  Set to true if we ever hit MAX_RESUBMIT_RECURSION, so
7117      * that in the future we always keep a copy of the original flow for
7118      * tracing purposes. */
7119     static bool hit_resubmit_limit;
7120
7121     enum slow_path_reason special;
7122     struct ofport_dpif *in_port;
7123     struct flow orig_flow;
7124
7125     COVERAGE_INC(ofproto_dpif_xlate);
7126
7127     ofpbuf_clear(odp_actions);
7128     ofpbuf_reserve(odp_actions, NL_A_U32_SIZE);
7129
7130     ctx->odp_actions = odp_actions;
7131     ctx->tags = 0;
7132     ctx->slow = 0;
7133     ctx->has_learn = false;
7134     ctx->has_normal = false;
7135     ctx->has_fin_timeout = false;
7136     ctx->nf_output_iface = NF_OUT_DROP;
7137     ctx->mirrors = 0;
7138     ctx->recurse = 0;
7139     ctx->max_resubmit_trigger = false;
7140     ctx->orig_skb_priority = ctx->flow.skb_priority;
7141     ctx->table_id = 0;
7142     ctx->exit = false;
7143
7144     ofpbuf_use_stub(&ctx->stack, ctx->init_stack, sizeof ctx->init_stack);
7145
7146     if (ctx->ofproto->has_mirrors || hit_resubmit_limit) {
7147         /* Do this conditionally because the copy is expensive enough that it
7148          * shows up in profiles. */
7149         orig_flow = ctx->flow;
7150     }
7151
7152     if (ctx->flow.nw_frag & FLOW_NW_FRAG_ANY) {
7153         switch (ctx->ofproto->up.frag_handling) {
7154         case OFPC_FRAG_NORMAL:
7155             /* We must pretend that transport ports are unavailable. */
7156             ctx->flow.tp_src = ctx->base_flow.tp_src = htons(0);
7157             ctx->flow.tp_dst = ctx->base_flow.tp_dst = htons(0);
7158             break;
7159
7160         case OFPC_FRAG_DROP:
7161             return;
7162
7163         case OFPC_FRAG_REASM:
7164             NOT_REACHED();
7165
7166         case OFPC_FRAG_NX_MATCH:
7167             /* Nothing to do. */
7168             break;
7169
7170         case OFPC_INVALID_TTL_TO_CONTROLLER:
7171             NOT_REACHED();
7172         }
7173     }
7174
7175     in_port = get_ofp_port(ctx->ofproto, ctx->flow.in_port);
7176     special = process_special(ctx->ofproto, &ctx->flow, in_port, ctx->packet);
7177     if (special) {
7178         ctx->slow |= special;
7179     } else {
7180         static struct vlog_rate_limit trace_rl = VLOG_RATE_LIMIT_INIT(1, 1);
7181         struct initial_vals initial_vals;
7182         size_t sample_actions_len;
7183         uint32_t local_odp_port;
7184
7185         initial_vals.vlan_tci = ctx->base_flow.vlan_tci;
7186
7187         add_sflow_action(ctx);
7188         add_ipfix_action(ctx);
7189         sample_actions_len = ctx->odp_actions->size;
7190
7191         if (tunnel_ecn_ok(ctx) && (!in_port || may_receive(in_port, ctx))) {
7192             do_xlate_actions(ofpacts, ofpacts_len, ctx);
7193
7194             /* We've let OFPP_NORMAL and the learning action look at the
7195              * packet, so drop it now if forwarding is disabled. */
7196             if (in_port && !stp_forward_in_state(in_port->stp_state)) {
7197                 ctx->odp_actions->size = sample_actions_len;
7198             }
7199         }
7200
7201         if (ctx->max_resubmit_trigger && !ctx->resubmit_hook) {
7202             if (!hit_resubmit_limit) {
7203                 /* We didn't record the original flow.  Make sure we do from
7204                  * now on. */
7205                 hit_resubmit_limit = true;
7206             } else if (!VLOG_DROP_ERR(&trace_rl)) {
7207                 struct ds ds = DS_EMPTY_INITIALIZER;
7208
7209                 ofproto_trace(ctx->ofproto, &orig_flow, ctx->packet,
7210                               &initial_vals, &ds);
7211                 VLOG_ERR("Trace triggered by excessive resubmit "
7212                          "recursion:\n%s", ds_cstr(&ds));
7213                 ds_destroy(&ds);
7214             }
7215         }
7216
7217         local_odp_port = ofp_port_to_odp_port(ctx->ofproto, OFPP_LOCAL);
7218         if (!connmgr_may_set_up_flow(ctx->ofproto->up.connmgr, &ctx->flow,
7219                                      local_odp_port,
7220                                      ctx->odp_actions->data,
7221                                      ctx->odp_actions->size)) {
7222             ctx->slow |= SLOW_IN_BAND;
7223             if (ctx->packet
7224                 && connmgr_msg_in_hook(ctx->ofproto->up.connmgr, &ctx->flow,
7225                                        ctx->packet)) {
7226                 compose_output_action(ctx, OFPP_LOCAL);
7227             }
7228         }
7229         if (ctx->ofproto->has_mirrors) {
7230             add_mirror_actions(ctx, &orig_flow);
7231         }
7232         fix_sflow_action(ctx);
7233     }
7234
7235     ofpbuf_uninit(&ctx->stack);
7236 }
7237
7238 /* Translates the 'ofpacts_len' bytes of "struct ofpact"s starting at 'ofpacts'
7239  * into datapath actions, using 'ctx', and discards the datapath actions. */
7240 static void
7241 xlate_actions_for_side_effects(struct action_xlate_ctx *ctx,
7242                                const struct ofpact *ofpacts,
7243                                size_t ofpacts_len)
7244 {
7245     uint64_t odp_actions_stub[1024 / 8];
7246     struct ofpbuf odp_actions;
7247
7248     ofpbuf_use_stub(&odp_actions, odp_actions_stub, sizeof odp_actions_stub);
7249     xlate_actions(ctx, ofpacts, ofpacts_len, &odp_actions);
7250     ofpbuf_uninit(&odp_actions);
7251 }
7252
7253 static void
7254 xlate_report(struct action_xlate_ctx *ctx, const char *s)
7255 {
7256     if (ctx->report_hook) {
7257         ctx->report_hook(ctx, s);
7258     }
7259 }
7260 \f
7261 /* OFPP_NORMAL implementation. */
7262
7263 static struct ofport_dpif *ofbundle_get_a_port(const struct ofbundle *);
7264
7265 /* Given 'vid', the VID obtained from the 802.1Q header that was received as
7266  * part of a packet (specify 0 if there was no 802.1Q header), and 'in_bundle',
7267  * the bundle on which the packet was received, returns the VLAN to which the
7268  * packet belongs.
7269  *
7270  * Both 'vid' and the return value are in the range 0...4095. */
7271 static uint16_t
7272 input_vid_to_vlan(const struct ofbundle *in_bundle, uint16_t vid)
7273 {
7274     switch (in_bundle->vlan_mode) {
7275     case PORT_VLAN_ACCESS:
7276         return in_bundle->vlan;
7277         break;
7278
7279     case PORT_VLAN_TRUNK:
7280         return vid;
7281
7282     case PORT_VLAN_NATIVE_UNTAGGED:
7283     case PORT_VLAN_NATIVE_TAGGED:
7284         return vid ? vid : in_bundle->vlan;
7285
7286     default:
7287         NOT_REACHED();
7288     }
7289 }
7290
7291 /* Checks whether a packet with the given 'vid' may ingress on 'in_bundle'.
7292  * If so, returns true.  Otherwise, returns false and, if 'warn' is true, logs
7293  * a warning.
7294  *
7295  * 'vid' should be the VID obtained from the 802.1Q header that was received as
7296  * part of a packet (specify 0 if there was no 802.1Q header), in the range
7297  * 0...4095. */
7298 static bool
7299 input_vid_is_valid(uint16_t vid, struct ofbundle *in_bundle, bool warn)
7300 {
7301     /* Allow any VID on the OFPP_NONE port. */
7302     if (in_bundle == &ofpp_none_bundle) {
7303         return true;
7304     }
7305
7306     switch (in_bundle->vlan_mode) {
7307     case PORT_VLAN_ACCESS:
7308         if (vid) {
7309             if (warn) {
7310                 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
7311                 VLOG_WARN_RL(&rl, "bridge %s: dropping VLAN %"PRIu16" tagged "
7312                              "packet received on port %s configured as VLAN "
7313                              "%"PRIu16" access port",
7314                              in_bundle->ofproto->up.name, vid,
7315                              in_bundle->name, in_bundle->vlan);
7316             }
7317             return false;
7318         }
7319         return true;
7320
7321     case PORT_VLAN_NATIVE_UNTAGGED:
7322     case PORT_VLAN_NATIVE_TAGGED:
7323         if (!vid) {
7324             /* Port must always carry its native VLAN. */
7325             return true;
7326         }
7327         /* Fall through. */
7328     case PORT_VLAN_TRUNK:
7329         if (!ofbundle_includes_vlan(in_bundle, vid)) {
7330             if (warn) {
7331                 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
7332                 VLOG_WARN_RL(&rl, "bridge %s: dropping VLAN %"PRIu16" packet "
7333                              "received on port %s not configured for trunking "
7334                              "VLAN %"PRIu16,
7335                              in_bundle->ofproto->up.name, vid,
7336                              in_bundle->name, vid);
7337             }
7338             return false;
7339         }
7340         return true;
7341
7342     default:
7343         NOT_REACHED();
7344     }
7345
7346 }
7347
7348 /* Given 'vlan', the VLAN that a packet belongs to, and
7349  * 'out_bundle', a bundle on which the packet is to be output, returns the VID
7350  * that should be included in the 802.1Q header.  (If the return value is 0,
7351  * then the 802.1Q header should only be included in the packet if there is a
7352  * nonzero PCP.)
7353  *
7354  * Both 'vlan' and the return value are in the range 0...4095. */
7355 static uint16_t
7356 output_vlan_to_vid(const struct ofbundle *out_bundle, uint16_t vlan)
7357 {
7358     switch (out_bundle->vlan_mode) {
7359     case PORT_VLAN_ACCESS:
7360         return 0;
7361
7362     case PORT_VLAN_TRUNK:
7363     case PORT_VLAN_NATIVE_TAGGED:
7364         return vlan;
7365
7366     case PORT_VLAN_NATIVE_UNTAGGED:
7367         return vlan == out_bundle->vlan ? 0 : vlan;
7368
7369     default:
7370         NOT_REACHED();
7371     }
7372 }
7373
7374 static void
7375 output_normal(struct action_xlate_ctx *ctx, const struct ofbundle *out_bundle,
7376               uint16_t vlan)
7377 {
7378     struct ofport_dpif *port;
7379     uint16_t vid;
7380     ovs_be16 tci, old_tci;
7381
7382     vid = output_vlan_to_vid(out_bundle, vlan);
7383     if (!out_bundle->bond) {
7384         port = ofbundle_get_a_port(out_bundle);
7385     } else {
7386         port = bond_choose_output_slave(out_bundle->bond, &ctx->flow,
7387                                         vid, &ctx->tags);
7388         if (!port) {
7389             /* No slaves enabled, so drop packet. */
7390             return;
7391         }
7392     }
7393
7394     old_tci = ctx->flow.vlan_tci;
7395     tci = htons(vid);
7396     if (tci || out_bundle->use_priority_tags) {
7397         tci |= ctx->flow.vlan_tci & htons(VLAN_PCP_MASK);
7398         if (tci) {
7399             tci |= htons(VLAN_CFI);
7400         }
7401     }
7402     ctx->flow.vlan_tci = tci;
7403
7404     compose_output_action(ctx, port->up.ofp_port);
7405     ctx->flow.vlan_tci = old_tci;
7406 }
7407
7408 static int
7409 mirror_mask_ffs(mirror_mask_t mask)
7410 {
7411     BUILD_ASSERT_DECL(sizeof(unsigned int) >= sizeof(mask));
7412     return ffs(mask);
7413 }
7414
7415 static bool
7416 ofbundle_trunks_vlan(const struct ofbundle *bundle, uint16_t vlan)
7417 {
7418     return (bundle->vlan_mode != PORT_VLAN_ACCESS
7419             && (!bundle->trunks || bitmap_is_set(bundle->trunks, vlan)));
7420 }
7421
7422 static bool
7423 ofbundle_includes_vlan(const struct ofbundle *bundle, uint16_t vlan)
7424 {
7425     return vlan == bundle->vlan || ofbundle_trunks_vlan(bundle, vlan);
7426 }
7427
7428 /* Returns an arbitrary interface within 'bundle'. */
7429 static struct ofport_dpif *
7430 ofbundle_get_a_port(const struct ofbundle *bundle)
7431 {
7432     return CONTAINER_OF(list_front(&bundle->ports),
7433                         struct ofport_dpif, bundle_node);
7434 }
7435
7436 static bool
7437 vlan_is_mirrored(const struct ofmirror *m, int vlan)
7438 {
7439     return !m->vlans || bitmap_is_set(m->vlans, vlan);
7440 }
7441
7442 static void
7443 add_mirror_actions(struct action_xlate_ctx *ctx, const struct flow *orig_flow)
7444 {
7445     struct ofproto_dpif *ofproto = ctx->ofproto;
7446     mirror_mask_t mirrors;
7447     struct ofbundle *in_bundle;
7448     uint16_t vlan;
7449     uint16_t vid;
7450     const struct nlattr *a;
7451     size_t left;
7452
7453     in_bundle = lookup_input_bundle(ctx->ofproto, orig_flow->in_port,
7454                                     ctx->packet != NULL, NULL);
7455     if (!in_bundle) {
7456         return;
7457     }
7458     mirrors = in_bundle->src_mirrors;
7459
7460     /* Drop frames on bundles reserved for mirroring. */
7461     if (in_bundle->mirror_out) {
7462         if (ctx->packet != NULL) {
7463             static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
7464             VLOG_WARN_RL(&rl, "bridge %s: dropping packet received on port "
7465                          "%s, which is reserved exclusively for mirroring",
7466                          ctx->ofproto->up.name, in_bundle->name);
7467         }
7468         return;
7469     }
7470
7471     /* Check VLAN. */
7472     vid = vlan_tci_to_vid(orig_flow->vlan_tci);
7473     if (!input_vid_is_valid(vid, in_bundle, ctx->packet != NULL)) {
7474         return;
7475     }
7476     vlan = input_vid_to_vlan(in_bundle, vid);
7477
7478     /* Look at the output ports to check for destination selections. */
7479
7480     NL_ATTR_FOR_EACH (a, left, ctx->odp_actions->data,
7481                       ctx->odp_actions->size) {
7482         enum ovs_action_attr type = nl_attr_type(a);
7483         struct ofport_dpif *ofport;
7484
7485         if (type != OVS_ACTION_ATTR_OUTPUT) {
7486             continue;
7487         }
7488
7489         ofport = get_odp_port(ofproto, nl_attr_get_u32(a));
7490         if (ofport && ofport->bundle) {
7491             mirrors |= ofport->bundle->dst_mirrors;
7492         }
7493     }
7494
7495     if (!mirrors) {
7496         return;
7497     }
7498
7499     /* Restore the original packet before adding the mirror actions. */
7500     ctx->flow = *orig_flow;
7501
7502     while (mirrors) {
7503         struct ofmirror *m;
7504
7505         m = ofproto->mirrors[mirror_mask_ffs(mirrors) - 1];
7506
7507         if (!vlan_is_mirrored(m, vlan)) {
7508             mirrors = zero_rightmost_1bit(mirrors);
7509             continue;
7510         }
7511
7512         mirrors &= ~m->dup_mirrors;
7513         ctx->mirrors |= m->dup_mirrors;
7514         if (m->out) {
7515             output_normal(ctx, m->out, vlan);
7516         } else if (vlan != m->out_vlan
7517                    && !eth_addr_is_reserved(orig_flow->dl_dst)) {
7518             struct ofbundle *bundle;
7519
7520             HMAP_FOR_EACH (bundle, hmap_node, &ofproto->bundles) {
7521                 if (ofbundle_includes_vlan(bundle, m->out_vlan)
7522                     && !bundle->mirror_out) {
7523                     output_normal(ctx, bundle, m->out_vlan);
7524                 }
7525             }
7526         }
7527     }
7528 }
7529
7530 static void
7531 update_mirror_stats(struct ofproto_dpif *ofproto, mirror_mask_t mirrors,
7532                     uint64_t packets, uint64_t bytes)
7533 {
7534     if (!mirrors) {
7535         return;
7536     }
7537
7538     for (; mirrors; mirrors = zero_rightmost_1bit(mirrors)) {
7539         struct ofmirror *m;
7540
7541         m = ofproto->mirrors[mirror_mask_ffs(mirrors) - 1];
7542
7543         if (!m) {
7544             /* In normal circumstances 'm' will not be NULL.  However,
7545              * if mirrors are reconfigured, we can temporarily get out
7546              * of sync in facet_revalidate().  We could "correct" the
7547              * mirror list before reaching here, but doing that would
7548              * not properly account the traffic stats we've currently
7549              * accumulated for previous mirror configuration. */
7550             continue;
7551         }
7552
7553         m->packet_count += packets;
7554         m->byte_count += bytes;
7555     }
7556 }
7557
7558 /* A VM broadcasts a gratuitous ARP to indicate that it has resumed after
7559  * migration.  Older Citrix-patched Linux DomU used gratuitous ARP replies to
7560  * indicate this; newer upstream kernels use gratuitous ARP requests. */
7561 static bool
7562 is_gratuitous_arp(const struct flow *flow)
7563 {
7564     return (flow->dl_type == htons(ETH_TYPE_ARP)
7565             && eth_addr_is_broadcast(flow->dl_dst)
7566             && (flow->nw_proto == ARP_OP_REPLY
7567                 || (flow->nw_proto == ARP_OP_REQUEST
7568                     && flow->nw_src == flow->nw_dst)));
7569 }
7570
7571 static void
7572 update_learning_table(struct ofproto_dpif *ofproto,
7573                       const struct flow *flow, int vlan,
7574                       struct ofbundle *in_bundle)
7575 {
7576     struct mac_entry *mac;
7577
7578     /* Don't learn the OFPP_NONE port. */
7579     if (in_bundle == &ofpp_none_bundle) {
7580         return;
7581     }
7582
7583     if (!mac_learning_may_learn(ofproto->ml, flow->dl_src, vlan)) {
7584         return;
7585     }
7586
7587     mac = mac_learning_insert(ofproto->ml, flow->dl_src, vlan);
7588     if (is_gratuitous_arp(flow)) {
7589         /* We don't want to learn from gratuitous ARP packets that are
7590          * reflected back over bond slaves so we lock the learning table. */
7591         if (!in_bundle->bond) {
7592             mac_entry_set_grat_arp_lock(mac);
7593         } else if (mac_entry_is_grat_arp_locked(mac)) {
7594             return;
7595         }
7596     }
7597
7598     if (mac_entry_is_new(mac) || mac->port.p != in_bundle) {
7599         /* The log messages here could actually be useful in debugging,
7600          * so keep the rate limit relatively high. */
7601         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(30, 300);
7602         VLOG_DBG_RL(&rl, "bridge %s: learned that "ETH_ADDR_FMT" is "
7603                     "on port %s in VLAN %d",
7604                     ofproto->up.name, ETH_ADDR_ARGS(flow->dl_src),
7605                     in_bundle->name, vlan);
7606
7607         mac->port.p = in_bundle;
7608         tag_set_add(&ofproto->backer->revalidate_set,
7609                     mac_learning_changed(ofproto->ml, mac));
7610     }
7611 }
7612
7613 static struct ofbundle *
7614 lookup_input_bundle(const struct ofproto_dpif *ofproto, uint16_t in_port,
7615                     bool warn, struct ofport_dpif **in_ofportp)
7616 {
7617     struct ofport_dpif *ofport;
7618
7619     /* Find the port and bundle for the received packet. */
7620     ofport = get_ofp_port(ofproto, in_port);
7621     if (in_ofportp) {
7622         *in_ofportp = ofport;
7623     }
7624     if (ofport && ofport->bundle) {
7625         return ofport->bundle;
7626     }
7627
7628     /* Special-case OFPP_NONE, which a controller may use as the ingress
7629      * port for traffic that it is sourcing. */
7630     if (in_port == OFPP_NONE) {
7631         return &ofpp_none_bundle;
7632     }
7633
7634     /* Odd.  A few possible reasons here:
7635      *
7636      * - We deleted a port but there are still a few packets queued up
7637      *   from it.
7638      *
7639      * - Someone externally added a port (e.g. "ovs-dpctl add-if") that
7640      *   we don't know about.
7641      *
7642      * - The ofproto client didn't configure the port as part of a bundle.
7643      *   This is particularly likely to happen if a packet was received on the
7644      *   port after it was created, but before the client had a chance to
7645      *   configure its bundle.
7646      */
7647     if (warn) {
7648         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
7649
7650         VLOG_WARN_RL(&rl, "bridge %s: received packet on unknown "
7651                      "port %"PRIu16, ofproto->up.name, in_port);
7652     }
7653     return NULL;
7654 }
7655
7656 /* Determines whether packets in 'flow' within 'ofproto' should be forwarded or
7657  * dropped.  Returns true if they may be forwarded, false if they should be
7658  * dropped.
7659  *
7660  * 'in_port' must be the ofport_dpif that corresponds to flow->in_port.
7661  * 'in_port' must be part of a bundle (e.g. in_port->bundle must be nonnull).
7662  *
7663  * 'vlan' must be the VLAN that corresponds to flow->vlan_tci on 'in_port', as
7664  * returned by input_vid_to_vlan().  It must be a valid VLAN for 'in_port', as
7665  * checked by input_vid_is_valid().
7666  *
7667  * May also add tags to '*tags', although the current implementation only does
7668  * so in one special case.
7669  */
7670 static bool
7671 is_admissible(struct action_xlate_ctx *ctx, struct ofport_dpif *in_port,
7672               uint16_t vlan)
7673 {
7674     struct ofproto_dpif *ofproto = ctx->ofproto;
7675     struct flow *flow = &ctx->flow;
7676     struct ofbundle *in_bundle = in_port->bundle;
7677
7678     /* Drop frames for reserved multicast addresses
7679      * only if forward_bpdu option is absent. */
7680     if (!ofproto->up.forward_bpdu && eth_addr_is_reserved(flow->dl_dst)) {
7681         xlate_report(ctx, "packet has reserved destination MAC, dropping");
7682         return false;
7683     }
7684
7685     if (in_bundle->bond) {
7686         struct mac_entry *mac;
7687
7688         switch (bond_check_admissibility(in_bundle->bond, in_port,
7689                                          flow->dl_dst, &ctx->tags)) {
7690         case BV_ACCEPT:
7691             break;
7692
7693         case BV_DROP:
7694             xlate_report(ctx, "bonding refused admissibility, dropping");
7695             return false;
7696
7697         case BV_DROP_IF_MOVED:
7698             mac = mac_learning_lookup(ofproto->ml, flow->dl_src, vlan, NULL);
7699             if (mac && mac->port.p != in_bundle &&
7700                 (!is_gratuitous_arp(flow)
7701                  || mac_entry_is_grat_arp_locked(mac))) {
7702                 xlate_report(ctx, "SLB bond thinks this packet looped back, "
7703                             "dropping");
7704                 return false;
7705             }
7706             break;
7707         }
7708     }
7709
7710     return true;
7711 }
7712
7713 static void
7714 xlate_normal(struct action_xlate_ctx *ctx)
7715 {
7716     struct ofport_dpif *in_port;
7717     struct ofbundle *in_bundle;
7718     struct mac_entry *mac;
7719     uint16_t vlan;
7720     uint16_t vid;
7721
7722     ctx->has_normal = true;
7723
7724     in_bundle = lookup_input_bundle(ctx->ofproto, ctx->flow.in_port,
7725                                     ctx->packet != NULL, &in_port);
7726     if (!in_bundle) {
7727         xlate_report(ctx, "no input bundle, dropping");
7728         return;
7729     }
7730
7731     /* Drop malformed frames. */
7732     if (ctx->flow.dl_type == htons(ETH_TYPE_VLAN) &&
7733         !(ctx->flow.vlan_tci & htons(VLAN_CFI))) {
7734         if (ctx->packet != NULL) {
7735             static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
7736             VLOG_WARN_RL(&rl, "bridge %s: dropping packet with partial "
7737                          "VLAN tag received on port %s",
7738                          ctx->ofproto->up.name, in_bundle->name);
7739         }
7740         xlate_report(ctx, "partial VLAN tag, dropping");
7741         return;
7742     }
7743
7744     /* Drop frames on bundles reserved for mirroring. */
7745     if (in_bundle->mirror_out) {
7746         if (ctx->packet != NULL) {
7747             static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
7748             VLOG_WARN_RL(&rl, "bridge %s: dropping packet received on port "
7749                          "%s, which is reserved exclusively for mirroring",
7750                          ctx->ofproto->up.name, in_bundle->name);
7751         }
7752         xlate_report(ctx, "input port is mirror output port, dropping");
7753         return;
7754     }
7755
7756     /* Check VLAN. */
7757     vid = vlan_tci_to_vid(ctx->flow.vlan_tci);
7758     if (!input_vid_is_valid(vid, in_bundle, ctx->packet != NULL)) {
7759         xlate_report(ctx, "disallowed VLAN VID for this input port, dropping");
7760         return;
7761     }
7762     vlan = input_vid_to_vlan(in_bundle, vid);
7763
7764     /* Check other admissibility requirements. */
7765     if (in_port && !is_admissible(ctx, in_port, vlan)) {
7766         return;
7767     }
7768
7769     /* Learn source MAC. */
7770     if (ctx->may_learn) {
7771         update_learning_table(ctx->ofproto, &ctx->flow, vlan, in_bundle);
7772     }
7773
7774     /* Determine output bundle. */
7775     mac = mac_learning_lookup(ctx->ofproto->ml, ctx->flow.dl_dst, vlan,
7776                               &ctx->tags);
7777     if (mac) {
7778         if (mac->port.p != in_bundle) {
7779             xlate_report(ctx, "forwarding to learned port");
7780             output_normal(ctx, mac->port.p, vlan);
7781         } else {
7782             xlate_report(ctx, "learned port is input port, dropping");
7783         }
7784     } else {
7785         struct ofbundle *bundle;
7786
7787         xlate_report(ctx, "no learned MAC for destination, flooding");
7788         HMAP_FOR_EACH (bundle, hmap_node, &ctx->ofproto->bundles) {
7789             if (bundle != in_bundle
7790                 && ofbundle_includes_vlan(bundle, vlan)
7791                 && bundle->floodable
7792                 && !bundle->mirror_out) {
7793                 output_normal(ctx, bundle, vlan);
7794             }
7795         }
7796         ctx->nf_output_iface = NF_OUT_FLOOD;
7797     }
7798 }
7799 \f
7800 /* Optimized flow revalidation.
7801  *
7802  * It's a difficult problem, in general, to tell which facets need to have
7803  * their actions recalculated whenever the OpenFlow flow table changes.  We
7804  * don't try to solve that general problem: for most kinds of OpenFlow flow
7805  * table changes, we recalculate the actions for every facet.  This is
7806  * relatively expensive, but it's good enough if the OpenFlow flow table
7807  * doesn't change very often.
7808  *
7809  * However, we can expect one particular kind of OpenFlow flow table change to
7810  * happen frequently: changes caused by MAC learning.  To avoid wasting a lot
7811  * of CPU on revalidating every facet whenever MAC learning modifies the flow
7812  * table, we add a special case that applies to flow tables in which every rule
7813  * has the same form (that is, the same wildcards), except that the table is
7814  * also allowed to have a single "catch-all" flow that matches all packets.  We
7815  * optimize this case by tagging all of the facets that resubmit into the table
7816  * and invalidating the same tag whenever a flow changes in that table.  The
7817  * end result is that we revalidate just the facets that need it (and sometimes
7818  * a few more, but not all of the facets or even all of the facets that
7819  * resubmit to the table modified by MAC learning). */
7820
7821 /* Calculates the tag to use for 'flow' and mask 'mask' when it is inserted
7822  * into an OpenFlow table with the given 'basis'. */
7823 static tag_type
7824 rule_calculate_tag(const struct flow *flow, const struct minimask *mask,
7825                    uint32_t secret)
7826 {
7827     if (minimask_is_catchall(mask)) {
7828         return 0;
7829     } else {
7830         uint32_t hash = flow_hash_in_minimask(flow, mask, secret);
7831         return tag_create_deterministic(hash);
7832     }
7833 }
7834
7835 /* Following a change to OpenFlow table 'table_id' in 'ofproto', update the
7836  * taggability of that table.
7837  *
7838  * This function must be called after *each* change to a flow table.  If you
7839  * skip calling it on some changes then the pointer comparisons at the end can
7840  * be invalid if you get unlucky.  For example, if a flow removal causes a
7841  * cls_table to be destroyed and then a flow insertion causes a cls_table with
7842  * different wildcards to be created with the same address, then this function
7843  * will incorrectly skip revalidation. */
7844 static void
7845 table_update_taggable(struct ofproto_dpif *ofproto, uint8_t table_id)
7846 {
7847     struct table_dpif *table = &ofproto->tables[table_id];
7848     const struct oftable *oftable = &ofproto->up.tables[table_id];
7849     struct cls_table *catchall, *other;
7850     struct cls_table *t;
7851
7852     catchall = other = NULL;
7853
7854     switch (hmap_count(&oftable->cls.tables)) {
7855     case 0:
7856         /* We could tag this OpenFlow table but it would make the logic a
7857          * little harder and it's a corner case that doesn't seem worth it
7858          * yet. */
7859         break;
7860
7861     case 1:
7862     case 2:
7863         HMAP_FOR_EACH (t, hmap_node, &oftable->cls.tables) {
7864             if (cls_table_is_catchall(t)) {
7865                 catchall = t;
7866             } else if (!other) {
7867                 other = t;
7868             } else {
7869                 /* Indicate that we can't tag this by setting both tables to
7870                  * NULL.  (We know that 'catchall' is already NULL.) */
7871                 other = NULL;
7872             }
7873         }
7874         break;
7875
7876     default:
7877         /* Can't tag this table. */
7878         break;
7879     }
7880
7881     if (table->catchall_table != catchall || table->other_table != other) {
7882         table->catchall_table = catchall;
7883         table->other_table = other;
7884         ofproto->backer->need_revalidate = REV_FLOW_TABLE;
7885     }
7886 }
7887
7888 /* Given 'rule' that has changed in some way (either it is a rule being
7889  * inserted, a rule being deleted, or a rule whose actions are being
7890  * modified), marks facets for revalidation to ensure that packets will be
7891  * forwarded correctly according to the new state of the flow table.
7892  *
7893  * This function must be called after *each* change to a flow table.  See
7894  * the comment on table_update_taggable() for more information. */
7895 static void
7896 rule_invalidate(const struct rule_dpif *rule)
7897 {
7898     struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
7899
7900     table_update_taggable(ofproto, rule->up.table_id);
7901
7902     if (!ofproto->backer->need_revalidate) {
7903         struct table_dpif *table = &ofproto->tables[rule->up.table_id];
7904
7905         if (table->other_table && rule->tag) {
7906             tag_set_add(&ofproto->backer->revalidate_set, rule->tag);
7907         } else {
7908             ofproto->backer->need_revalidate = REV_FLOW_TABLE;
7909         }
7910     }
7911 }
7912 \f
7913 static bool
7914 set_frag_handling(struct ofproto *ofproto_,
7915                   enum ofp_config_flags frag_handling)
7916 {
7917     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
7918     if (frag_handling != OFPC_FRAG_REASM) {
7919         ofproto->backer->need_revalidate = REV_RECONFIGURE;
7920         return true;
7921     } else {
7922         return false;
7923     }
7924 }
7925
7926 static enum ofperr
7927 packet_out(struct ofproto *ofproto_, struct ofpbuf *packet,
7928            const struct flow *flow,
7929            const struct ofpact *ofpacts, size_t ofpacts_len)
7930 {
7931     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
7932     struct initial_vals initial_vals;
7933     struct odputil_keybuf keybuf;
7934     struct dpif_flow_stats stats;
7935
7936     struct ofpbuf key;
7937
7938     struct action_xlate_ctx ctx;
7939     uint64_t odp_actions_stub[1024 / 8];
7940     struct ofpbuf odp_actions;
7941
7942     ofpbuf_use_stack(&key, &keybuf, sizeof keybuf);
7943     odp_flow_key_from_flow(&key, flow,
7944                            ofp_port_to_odp_port(ofproto, flow->in_port));
7945
7946     dpif_flow_stats_extract(flow, packet, time_msec(), &stats);
7947
7948     initial_vals.vlan_tci = flow->vlan_tci;
7949     action_xlate_ctx_init(&ctx, ofproto, flow, &initial_vals, NULL,
7950                           packet_get_tcp_flags(packet, flow), packet);
7951     ctx.resubmit_stats = &stats;
7952
7953     ofpbuf_use_stub(&odp_actions,
7954                     odp_actions_stub, sizeof odp_actions_stub);
7955     xlate_actions(&ctx, ofpacts, ofpacts_len, &odp_actions);
7956     dpif_execute(ofproto->backer->dpif, key.data, key.size,
7957                  odp_actions.data, odp_actions.size, packet);
7958     ofpbuf_uninit(&odp_actions);
7959
7960     return 0;
7961 }
7962 \f
7963 /* NetFlow. */
7964
7965 static int
7966 set_netflow(struct ofproto *ofproto_,
7967             const struct netflow_options *netflow_options)
7968 {
7969     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
7970
7971     if (netflow_options) {
7972         if (!ofproto->netflow) {
7973             ofproto->netflow = netflow_create();
7974         }
7975         return netflow_set_options(ofproto->netflow, netflow_options);
7976     } else {
7977         netflow_destroy(ofproto->netflow);
7978         ofproto->netflow = NULL;
7979         return 0;
7980     }
7981 }
7982
7983 static void
7984 get_netflow_ids(const struct ofproto *ofproto_,
7985                 uint8_t *engine_type, uint8_t *engine_id)
7986 {
7987     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
7988
7989     dpif_get_netflow_ids(ofproto->backer->dpif, engine_type, engine_id);
7990 }
7991
7992 static void
7993 send_active_timeout(struct ofproto_dpif *ofproto, struct facet *facet)
7994 {
7995     if (!facet_is_controller_flow(facet) &&
7996         netflow_active_timeout_expired(ofproto->netflow, &facet->nf_flow)) {
7997         struct subfacet *subfacet;
7998         struct ofexpired expired;
7999
8000         LIST_FOR_EACH (subfacet, list_node, &facet->subfacets) {
8001             if (subfacet->path == SF_FAST_PATH) {
8002                 struct dpif_flow_stats stats;
8003
8004                 subfacet_reinstall(subfacet, &stats);
8005                 subfacet_update_stats(subfacet, &stats);
8006             }
8007         }
8008
8009         expired.flow = facet->flow;
8010         expired.packet_count = facet->packet_count;
8011         expired.byte_count = facet->byte_count;
8012         expired.used = facet->used;
8013         netflow_expire(ofproto->netflow, &facet->nf_flow, &expired);
8014     }
8015 }
8016
8017 static void
8018 send_netflow_active_timeouts(struct ofproto_dpif *ofproto)
8019 {
8020     struct facet *facet;
8021
8022     HMAP_FOR_EACH (facet, hmap_node, &ofproto->facets) {
8023         send_active_timeout(ofproto, facet);
8024     }
8025 }
8026 \f
8027 static struct ofproto_dpif *
8028 ofproto_dpif_lookup(const char *name)
8029 {
8030     struct ofproto_dpif *ofproto;
8031
8032     HMAP_FOR_EACH_WITH_HASH (ofproto, all_ofproto_dpifs_node,
8033                              hash_string(name, 0), &all_ofproto_dpifs) {
8034         if (!strcmp(ofproto->up.name, name)) {
8035             return ofproto;
8036         }
8037     }
8038     return NULL;
8039 }
8040
8041 static void
8042 ofproto_unixctl_fdb_flush(struct unixctl_conn *conn, int argc,
8043                           const char *argv[], void *aux OVS_UNUSED)
8044 {
8045     struct ofproto_dpif *ofproto;
8046
8047     if (argc > 1) {
8048         ofproto = ofproto_dpif_lookup(argv[1]);
8049         if (!ofproto) {
8050             unixctl_command_reply_error(conn, "no such bridge");
8051             return;
8052         }
8053         mac_learning_flush(ofproto->ml, &ofproto->backer->revalidate_set);
8054     } else {
8055         HMAP_FOR_EACH (ofproto, all_ofproto_dpifs_node, &all_ofproto_dpifs) {
8056             mac_learning_flush(ofproto->ml, &ofproto->backer->revalidate_set);
8057         }
8058     }
8059
8060     unixctl_command_reply(conn, "table successfully flushed");
8061 }
8062
8063 static void
8064 ofproto_unixctl_fdb_show(struct unixctl_conn *conn, int argc OVS_UNUSED,
8065                          const char *argv[], void *aux OVS_UNUSED)
8066 {
8067     struct ds ds = DS_EMPTY_INITIALIZER;
8068     const struct ofproto_dpif *ofproto;
8069     const struct mac_entry *e;
8070
8071     ofproto = ofproto_dpif_lookup(argv[1]);
8072     if (!ofproto) {
8073         unixctl_command_reply_error(conn, "no such bridge");
8074         return;
8075     }
8076
8077     ds_put_cstr(&ds, " port  VLAN  MAC                Age\n");
8078     LIST_FOR_EACH (e, lru_node, &ofproto->ml->lrus) {
8079         struct ofbundle *bundle = e->port.p;
8080         ds_put_format(&ds, "%5d  %4d  "ETH_ADDR_FMT"  %3d\n",
8081                       ofbundle_get_a_port(bundle)->odp_port,
8082                       e->vlan, ETH_ADDR_ARGS(e->mac),
8083                       mac_entry_age(ofproto->ml, e));
8084     }
8085     unixctl_command_reply(conn, ds_cstr(&ds));
8086     ds_destroy(&ds);
8087 }
8088
8089 struct trace_ctx {
8090     struct action_xlate_ctx ctx;
8091     struct flow flow;
8092     struct ds *result;
8093 };
8094
8095 static void
8096 trace_format_rule(struct ds *result, uint8_t table_id, int level,
8097                   const struct rule_dpif *rule)
8098 {
8099     ds_put_char_multiple(result, '\t', level);
8100     if (!rule) {
8101         ds_put_cstr(result, "No match\n");
8102         return;
8103     }
8104
8105     ds_put_format(result, "Rule: table=%"PRIu8" cookie=%#"PRIx64" ",
8106                   table_id, ntohll(rule->up.flow_cookie));
8107     cls_rule_format(&rule->up.cr, result);
8108     ds_put_char(result, '\n');
8109
8110     ds_put_char_multiple(result, '\t', level);
8111     ds_put_cstr(result, "OpenFlow ");
8112     ofpacts_format(rule->up.ofpacts, rule->up.ofpacts_len, result);
8113     ds_put_char(result, '\n');
8114 }
8115
8116 static void
8117 trace_format_flow(struct ds *result, int level, const char *title,
8118                  struct trace_ctx *trace)
8119 {
8120     ds_put_char_multiple(result, '\t', level);
8121     ds_put_format(result, "%s: ", title);
8122     if (flow_equal(&trace->ctx.flow, &trace->flow)) {
8123         ds_put_cstr(result, "unchanged");
8124     } else {
8125         flow_format(result, &trace->ctx.flow);
8126         trace->flow = trace->ctx.flow;
8127     }
8128     ds_put_char(result, '\n');
8129 }
8130
8131 static void
8132 trace_format_regs(struct ds *result, int level, const char *title,
8133                   struct trace_ctx *trace)
8134 {
8135     size_t i;
8136
8137     ds_put_char_multiple(result, '\t', level);
8138     ds_put_format(result, "%s:", title);
8139     for (i = 0; i < FLOW_N_REGS; i++) {
8140         ds_put_format(result, " reg%zu=0x%"PRIx32, i, trace->flow.regs[i]);
8141     }
8142     ds_put_char(result, '\n');
8143 }
8144
8145 static void
8146 trace_format_odp(struct ds *result, int level, const char *title,
8147                  struct trace_ctx *trace)
8148 {
8149     struct ofpbuf *odp_actions = trace->ctx.odp_actions;
8150
8151     ds_put_char_multiple(result, '\t', level);
8152     ds_put_format(result, "%s: ", title);
8153     format_odp_actions(result, odp_actions->data, odp_actions->size);
8154     ds_put_char(result, '\n');
8155 }
8156
8157 static void
8158 trace_resubmit(struct action_xlate_ctx *ctx, struct rule_dpif *rule)
8159 {
8160     struct trace_ctx *trace = CONTAINER_OF(ctx, struct trace_ctx, ctx);
8161     struct ds *result = trace->result;
8162
8163     ds_put_char(result, '\n');
8164     trace_format_flow(result, ctx->recurse + 1, "Resubmitted flow", trace);
8165     trace_format_regs(result, ctx->recurse + 1, "Resubmitted regs", trace);
8166     trace_format_odp(result,  ctx->recurse + 1, "Resubmitted  odp", trace);
8167     trace_format_rule(result, ctx->table_id, ctx->recurse + 1, rule);
8168 }
8169
8170 static void
8171 trace_report(struct action_xlate_ctx *ctx, const char *s)
8172 {
8173     struct trace_ctx *trace = CONTAINER_OF(ctx, struct trace_ctx, ctx);
8174     struct ds *result = trace->result;
8175
8176     ds_put_char_multiple(result, '\t', ctx->recurse);
8177     ds_put_cstr(result, s);
8178     ds_put_char(result, '\n');
8179 }
8180
8181 static void
8182 ofproto_unixctl_trace(struct unixctl_conn *conn, int argc, const char *argv[],
8183                       void *aux OVS_UNUSED)
8184 {
8185     const char *dpname = argv[1];
8186     struct ofproto_dpif *ofproto;
8187     struct ofpbuf odp_key;
8188     struct ofpbuf *packet;
8189     struct initial_vals initial_vals;
8190     struct ds result;
8191     struct flow flow;
8192     char *s;
8193
8194     packet = NULL;
8195     ofpbuf_init(&odp_key, 0);
8196     ds_init(&result);
8197
8198     ofproto = ofproto_dpif_lookup(dpname);
8199     if (!ofproto) {
8200         unixctl_command_reply_error(conn, "Unknown ofproto (use ofproto/list "
8201                                     "for help)");
8202         goto exit;
8203     }
8204     if (argc == 3 || (argc == 4 && !strcmp(argv[3], "-generate"))) {
8205         /* ofproto/trace dpname flow [-generate] */
8206         const char *flow_s = argv[2];
8207         const char *generate_s = argv[3];
8208
8209         /* Allow 'flow_s' to be either a datapath flow or an OpenFlow-like
8210          * flow.  We guess which type it is based on whether 'flow_s' contains
8211          * an '(', since a datapath flow always contains '(') but an
8212          * OpenFlow-like flow should not (in fact it's allowed but I believe
8213          * that's not documented anywhere).
8214          *
8215          * An alternative would be to try to parse 'flow_s' both ways, but then
8216          * it would be tricky giving a sensible error message.  After all, do
8217          * you just say "syntax error" or do you present both error messages?
8218          * Both choices seem lousy. */
8219         if (strchr(flow_s, '(')) {
8220             int error;
8221
8222             /* Convert string to datapath key. */
8223             ofpbuf_init(&odp_key, 0);
8224             error = odp_flow_key_from_string(flow_s, NULL, &odp_key);
8225             if (error) {
8226                 unixctl_command_reply_error(conn, "Bad flow syntax");
8227                 goto exit;
8228             }
8229
8230             /* The user might have specified the wrong ofproto but within the
8231              * same backer.  That's OK, ofproto_receive() can find the right
8232              * one for us. */
8233             if (ofproto_receive(ofproto->backer, NULL, odp_key.data,
8234                                 odp_key.size, &flow, NULL, &ofproto, NULL,
8235                                 &initial_vals)) {
8236                 unixctl_command_reply_error(conn, "Invalid flow");
8237                 goto exit;
8238             }
8239             ds_put_format(&result, "Bridge: %s\n", ofproto->up.name);
8240         } else {
8241             char *error_s;
8242
8243             error_s = parse_ofp_exact_flow(&flow, argv[2]);
8244             if (error_s) {
8245                 unixctl_command_reply_error(conn, error_s);
8246                 free(error_s);
8247                 goto exit;
8248             }
8249
8250             initial_vals.vlan_tci = flow.vlan_tci;
8251         }
8252
8253         /* Generate a packet, if requested. */
8254         if (generate_s) {
8255             packet = ofpbuf_new(0);
8256             flow_compose(packet, &flow);
8257         }
8258     } else if (argc == 7) {
8259         /* ofproto/trace dpname priority tun_id in_port mark packet */
8260         const char *priority_s = argv[2];
8261         const char *tun_id_s = argv[3];
8262         const char *in_port_s = argv[4];
8263         const char *mark_s = argv[5];
8264         const char *packet_s = argv[6];
8265         uint32_t in_port = atoi(in_port_s);
8266         ovs_be64 tun_id = htonll(strtoull(tun_id_s, NULL, 0));
8267         uint32_t priority = atoi(priority_s);
8268         uint32_t mark = atoi(mark_s);
8269         const char *msg;
8270
8271         msg = eth_from_hex(packet_s, &packet);
8272         if (msg) {
8273             unixctl_command_reply_error(conn, msg);
8274             goto exit;
8275         }
8276
8277         ds_put_cstr(&result, "Packet: ");
8278         s = ofp_packet_to_string(packet->data, packet->size);
8279         ds_put_cstr(&result, s);
8280         free(s);
8281
8282         flow_extract(packet, priority, mark, NULL, in_port, &flow);
8283         flow.tunnel.tun_id = tun_id;
8284         initial_vals.vlan_tci = flow.vlan_tci;
8285     } else {
8286         unixctl_command_reply_error(conn, "Bad command syntax");
8287         goto exit;
8288     }
8289
8290     ofproto_trace(ofproto, &flow, packet, &initial_vals, &result);
8291     unixctl_command_reply(conn, ds_cstr(&result));
8292
8293 exit:
8294     ds_destroy(&result);
8295     ofpbuf_delete(packet);
8296     ofpbuf_uninit(&odp_key);
8297 }
8298
8299 static void
8300 ofproto_trace(struct ofproto_dpif *ofproto, const struct flow *flow,
8301               const struct ofpbuf *packet,
8302               const struct initial_vals *initial_vals, struct ds *ds)
8303 {
8304     struct rule_dpif *rule;
8305
8306     ds_put_cstr(ds, "Flow: ");
8307     flow_format(ds, flow);
8308     ds_put_char(ds, '\n');
8309
8310     rule = rule_dpif_lookup(ofproto, flow);
8311
8312     trace_format_rule(ds, 0, 0, rule);
8313     if (rule == ofproto->miss_rule) {
8314         ds_put_cstr(ds, "\nNo match, flow generates \"packet in\"s.\n");
8315     } else if (rule == ofproto->no_packet_in_rule) {
8316         ds_put_cstr(ds, "\nNo match, packets dropped because "
8317                     "OFPPC_NO_PACKET_IN is set on in_port.\n");
8318     }
8319
8320     if (rule) {
8321         uint64_t odp_actions_stub[1024 / 8];
8322         struct ofpbuf odp_actions;
8323
8324         struct trace_ctx trace;
8325         uint8_t tcp_flags;
8326
8327         tcp_flags = packet ? packet_get_tcp_flags(packet, flow) : 0;
8328         trace.result = ds;
8329         trace.flow = *flow;
8330         ofpbuf_use_stub(&odp_actions,
8331                         odp_actions_stub, sizeof odp_actions_stub);
8332         action_xlate_ctx_init(&trace.ctx, ofproto, flow, initial_vals,
8333                               rule, tcp_flags, packet);
8334         trace.ctx.resubmit_hook = trace_resubmit;
8335         trace.ctx.report_hook = trace_report;
8336         xlate_actions(&trace.ctx, rule->up.ofpacts, rule->up.ofpacts_len,
8337                       &odp_actions);
8338
8339         ds_put_char(ds, '\n');
8340         trace_format_flow(ds, 0, "Final flow", &trace);
8341         ds_put_cstr(ds, "Datapath actions: ");
8342         format_odp_actions(ds, odp_actions.data, odp_actions.size);
8343         ofpbuf_uninit(&odp_actions);
8344
8345         if (trace.ctx.slow) {
8346             enum slow_path_reason slow;
8347
8348             ds_put_cstr(ds, "\nThis flow is handled by the userspace "
8349                         "slow path because it:");
8350             for (slow = trace.ctx.slow; slow; ) {
8351                 enum slow_path_reason bit = rightmost_1bit(slow);
8352
8353                 switch (bit) {
8354                 case SLOW_CFM:
8355                     ds_put_cstr(ds, "\n\t- Consists of CFM packets.");
8356                     break;
8357                 case SLOW_LACP:
8358                     ds_put_cstr(ds, "\n\t- Consists of LACP packets.");
8359                     break;
8360                 case SLOW_STP:
8361                     ds_put_cstr(ds, "\n\t- Consists of STP packets.");
8362                     break;
8363                 case SLOW_BFD:
8364                     ds_put_cstr(ds, "\n\t- Consists of BFD packets.");
8365                     break;
8366                 case SLOW_IN_BAND:
8367                     ds_put_cstr(ds, "\n\t- Needs in-band special case "
8368                                 "processing.");
8369                     if (!packet) {
8370                         ds_put_cstr(ds, "\n\t  (The datapath actions are "
8371                                     "incomplete--for complete actions, "
8372                                     "please supply a packet.)");
8373                     }
8374                     break;
8375                 case SLOW_CONTROLLER:
8376                     ds_put_cstr(ds, "\n\t- Sends \"packet-in\" messages "
8377                                 "to the OpenFlow controller.");
8378                     break;
8379                 case SLOW_MATCH:
8380                     ds_put_cstr(ds, "\n\t- Needs more specific matching "
8381                                 "than the datapath supports.");
8382                     break;
8383                 }
8384
8385                 slow &= ~bit;
8386             }
8387
8388             if (slow & ~SLOW_MATCH) {
8389                 ds_put_cstr(ds, "\nThe datapath actions above do not reflect "
8390                             "the special slow-path processing.");
8391             }
8392         }
8393     }
8394 }
8395
8396 static void
8397 ofproto_dpif_clog(struct unixctl_conn *conn OVS_UNUSED, int argc OVS_UNUSED,
8398                   const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED)
8399 {
8400     clogged = true;
8401     unixctl_command_reply(conn, NULL);
8402 }
8403
8404 static void
8405 ofproto_dpif_unclog(struct unixctl_conn *conn OVS_UNUSED, int argc OVS_UNUSED,
8406                     const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED)
8407 {
8408     clogged = false;
8409     unixctl_command_reply(conn, NULL);
8410 }
8411
8412 /* Runs a self-check of flow translations in 'ofproto'.  Appends a message to
8413  * 'reply' describing the results. */
8414 static void
8415 ofproto_dpif_self_check__(struct ofproto_dpif *ofproto, struct ds *reply)
8416 {
8417     struct facet *facet;
8418     int errors;
8419
8420     errors = 0;
8421     HMAP_FOR_EACH (facet, hmap_node, &ofproto->facets) {
8422         if (!facet_check_consistency(facet)) {
8423             errors++;
8424         }
8425     }
8426     if (errors) {
8427         ofproto->backer->need_revalidate = REV_INCONSISTENCY;
8428     }
8429
8430     if (errors) {
8431         ds_put_format(reply, "%s: self-check failed (%d errors)\n",
8432                       ofproto->up.name, errors);
8433     } else {
8434         ds_put_format(reply, "%s: self-check passed\n", ofproto->up.name);
8435     }
8436 }
8437
8438 static void
8439 ofproto_dpif_self_check(struct unixctl_conn *conn,
8440                         int argc, const char *argv[], void *aux OVS_UNUSED)
8441 {
8442     struct ds reply = DS_EMPTY_INITIALIZER;
8443     struct ofproto_dpif *ofproto;
8444
8445     if (argc > 1) {
8446         ofproto = ofproto_dpif_lookup(argv[1]);
8447         if (!ofproto) {
8448             unixctl_command_reply_error(conn, "Unknown ofproto (use "
8449                                         "ofproto/list for help)");
8450             return;
8451         }
8452         ofproto_dpif_self_check__(ofproto, &reply);
8453     } else {
8454         HMAP_FOR_EACH (ofproto, all_ofproto_dpifs_node, &all_ofproto_dpifs) {
8455             ofproto_dpif_self_check__(ofproto, &reply);
8456         }
8457     }
8458
8459     unixctl_command_reply(conn, ds_cstr(&reply));
8460     ds_destroy(&reply);
8461 }
8462
8463 /* Store the current ofprotos in 'ofproto_shash'.  Returns a sorted list
8464  * of the 'ofproto_shash' nodes.  It is the responsibility of the caller
8465  * to destroy 'ofproto_shash' and free the returned value. */
8466 static const struct shash_node **
8467 get_ofprotos(struct shash *ofproto_shash)
8468 {
8469     const struct ofproto_dpif *ofproto;
8470
8471     HMAP_FOR_EACH (ofproto, all_ofproto_dpifs_node, &all_ofproto_dpifs) {
8472         char *name = xasprintf("%s@%s", ofproto->up.type, ofproto->up.name);
8473         shash_add_nocopy(ofproto_shash, name, ofproto);
8474     }
8475
8476     return shash_sort(ofproto_shash);
8477 }
8478
8479 static void
8480 ofproto_unixctl_dpif_dump_dps(struct unixctl_conn *conn, int argc OVS_UNUSED,
8481                               const char *argv[] OVS_UNUSED,
8482                               void *aux OVS_UNUSED)
8483 {
8484     struct ds ds = DS_EMPTY_INITIALIZER;
8485     struct shash ofproto_shash;
8486     const struct shash_node **sorted_ofprotos;
8487     int i;
8488
8489     shash_init(&ofproto_shash);
8490     sorted_ofprotos = get_ofprotos(&ofproto_shash);
8491     for (i = 0; i < shash_count(&ofproto_shash); i++) {
8492         const struct shash_node *node = sorted_ofprotos[i];
8493         ds_put_format(&ds, "%s\n", node->name);
8494     }
8495
8496     shash_destroy(&ofproto_shash);
8497     free(sorted_ofprotos);
8498
8499     unixctl_command_reply(conn, ds_cstr(&ds));
8500     ds_destroy(&ds);
8501 }
8502
8503 static void
8504 show_dp_format(const struct ofproto_dpif *ofproto, struct ds *ds)
8505 {
8506     const struct shash_node **ports;
8507     int i;
8508     struct avg_subfacet_rates lifetime;
8509     unsigned long long int minutes;
8510     const int min_ms = 60 * 1000; /* milliseconds in one minute. */
8511
8512     minutes = (time_msec() - ofproto->created) / min_ms;
8513
8514     if (minutes > 0) {
8515         lifetime.add_rate = (double)ofproto->total_subfacet_add_count
8516                             / minutes;
8517         lifetime.del_rate = (double)ofproto->total_subfacet_del_count
8518                             / minutes;
8519     }else {
8520         lifetime.add_rate = 0.0;
8521         lifetime.del_rate = 0.0;
8522     }
8523
8524     ds_put_format(ds, "%s (%s):\n", ofproto->up.name,
8525                   dpif_name(ofproto->backer->dpif));
8526     ds_put_format(ds,
8527                   "\tlookups: hit:%"PRIu64" missed:%"PRIu64"\n",
8528                   ofproto->n_hit, ofproto->n_missed);
8529     ds_put_format(ds, "\tflows: cur: %zu, avg: %5.3f, max: %d,"
8530                   " life span: %llu(ms)\n",
8531                   hmap_count(&ofproto->subfacets),
8532                   avg_subfacet_count(ofproto),
8533                   ofproto->max_n_subfacet,
8534                   avg_subfacet_life_span(ofproto));
8535     if (minutes >= 60) {
8536         show_dp_rates(ds, "\t\thourly avg:", &ofproto->hourly);
8537     }
8538     if (minutes >= 60 * 24) {
8539         show_dp_rates(ds, "\t\tdaily avg:",  &ofproto->daily);
8540     }
8541     show_dp_rates(ds, "\t\toverall avg:",  &lifetime);
8542
8543     ports = shash_sort(&ofproto->up.port_by_name);
8544     for (i = 0; i < shash_count(&ofproto->up.port_by_name); i++) {
8545         const struct shash_node *node = ports[i];
8546         struct ofport *ofport = node->data;
8547         const char *name = netdev_get_name(ofport->netdev);
8548         const char *type = netdev_get_type(ofport->netdev);
8549         uint32_t odp_port;
8550
8551         ds_put_format(ds, "\t%s %u/", name, ofport->ofp_port);
8552
8553         odp_port = ofp_port_to_odp_port(ofproto, ofport->ofp_port);
8554         if (odp_port != OVSP_NONE) {
8555             ds_put_format(ds, "%"PRIu32":", odp_port);
8556         } else {
8557             ds_put_cstr(ds, "none:");
8558         }
8559
8560         if (strcmp(type, "system")) {
8561             struct netdev *netdev;
8562             int error;
8563
8564             ds_put_format(ds, " (%s", type);
8565
8566             error = netdev_open(name, type, &netdev);
8567             if (!error) {
8568                 struct smap config;
8569
8570                 smap_init(&config);
8571                 error = netdev_get_config(netdev, &config);
8572                 if (!error) {
8573                     const struct smap_node **nodes;
8574                     size_t i;
8575
8576                     nodes = smap_sort(&config);
8577                     for (i = 0; i < smap_count(&config); i++) {
8578                         const struct smap_node *node = nodes[i];
8579                         ds_put_format(ds, "%c %s=%s", i ? ',' : ':',
8580                                       node->key, node->value);
8581                     }
8582                     free(nodes);
8583                 }
8584                 smap_destroy(&config);
8585
8586                 netdev_close(netdev);
8587             }
8588             ds_put_char(ds, ')');
8589         }
8590         ds_put_char(ds, '\n');
8591     }
8592     free(ports);
8593 }
8594
8595 static void
8596 ofproto_unixctl_dpif_show(struct unixctl_conn *conn, int argc,
8597                           const char *argv[], void *aux OVS_UNUSED)
8598 {
8599     struct ds ds = DS_EMPTY_INITIALIZER;
8600     const struct ofproto_dpif *ofproto;
8601
8602     if (argc > 1) {
8603         int i;
8604         for (i = 1; i < argc; i++) {
8605             ofproto = ofproto_dpif_lookup(argv[i]);
8606             if (!ofproto) {
8607                 ds_put_format(&ds, "Unknown bridge %s (use dpif/dump-dps "
8608                                    "for help)", argv[i]);
8609                 unixctl_command_reply_error(conn, ds_cstr(&ds));
8610                 return;
8611             }
8612             show_dp_format(ofproto, &ds);
8613         }
8614     } else {
8615         struct shash ofproto_shash;
8616         const struct shash_node **sorted_ofprotos;
8617         int i;
8618
8619         shash_init(&ofproto_shash);
8620         sorted_ofprotos = get_ofprotos(&ofproto_shash);
8621         for (i = 0; i < shash_count(&ofproto_shash); i++) {
8622             const struct shash_node *node = sorted_ofprotos[i];
8623             show_dp_format(node->data, &ds);
8624         }
8625
8626         shash_destroy(&ofproto_shash);
8627         free(sorted_ofprotos);
8628     }
8629
8630     unixctl_command_reply(conn, ds_cstr(&ds));
8631     ds_destroy(&ds);
8632 }
8633
8634 static void
8635 ofproto_unixctl_dpif_dump_flows(struct unixctl_conn *conn,
8636                                 int argc OVS_UNUSED, const char *argv[],
8637                                 void *aux OVS_UNUSED)
8638 {
8639     struct ds ds = DS_EMPTY_INITIALIZER;
8640     const struct ofproto_dpif *ofproto;
8641     struct subfacet *subfacet;
8642
8643     ofproto = ofproto_dpif_lookup(argv[1]);
8644     if (!ofproto) {
8645         unixctl_command_reply_error(conn, "no such bridge");
8646         return;
8647     }
8648
8649     update_stats(ofproto->backer);
8650
8651     HMAP_FOR_EACH (subfacet, hmap_node, &ofproto->subfacets) {
8652         odp_flow_key_format(subfacet->key, subfacet->key_len, &ds);
8653
8654         ds_put_format(&ds, ", packets:%"PRIu64", bytes:%"PRIu64", used:",
8655                       subfacet->dp_packet_count, subfacet->dp_byte_count);
8656         if (subfacet->used) {
8657             ds_put_format(&ds, "%.3fs",
8658                           (time_msec() - subfacet->used) / 1000.0);
8659         } else {
8660             ds_put_format(&ds, "never");
8661         }
8662         if (subfacet->facet->tcp_flags) {
8663             ds_put_cstr(&ds, ", flags:");
8664             packet_format_tcp_flags(&ds, subfacet->facet->tcp_flags);
8665         }
8666
8667         ds_put_cstr(&ds, ", actions:");
8668         if (subfacet->slow) {
8669             uint64_t slow_path_stub[128 / 8];
8670             const struct nlattr *actions;
8671             size_t actions_len;
8672
8673             compose_slow_path(ofproto, &subfacet->facet->flow, subfacet->slow,
8674                               slow_path_stub, sizeof slow_path_stub,
8675                               &actions, &actions_len);
8676             format_odp_actions(&ds, actions, actions_len);
8677         } else {
8678             format_odp_actions(&ds, subfacet->actions, subfacet->actions_len);
8679         }
8680         ds_put_char(&ds, '\n');
8681     }
8682
8683     unixctl_command_reply(conn, ds_cstr(&ds));
8684     ds_destroy(&ds);
8685 }
8686
8687 static void
8688 ofproto_unixctl_dpif_del_flows(struct unixctl_conn *conn,
8689                                int argc OVS_UNUSED, const char *argv[],
8690                                void *aux OVS_UNUSED)
8691 {
8692     struct ds ds = DS_EMPTY_INITIALIZER;
8693     struct ofproto_dpif *ofproto;
8694
8695     ofproto = ofproto_dpif_lookup(argv[1]);
8696     if (!ofproto) {
8697         unixctl_command_reply_error(conn, "no such bridge");
8698         return;
8699     }
8700
8701     flush(&ofproto->up);
8702
8703     unixctl_command_reply(conn, ds_cstr(&ds));
8704     ds_destroy(&ds);
8705 }
8706
8707 static void
8708 ofproto_dpif_unixctl_init(void)
8709 {
8710     static bool registered;
8711     if (registered) {
8712         return;
8713     }
8714     registered = true;
8715
8716     unixctl_command_register(
8717         "ofproto/trace",
8718         "bridge {priority tun_id in_port mark packet | odp_flow [-generate]}",
8719         2, 6, ofproto_unixctl_trace, NULL);
8720     unixctl_command_register("fdb/flush", "[bridge]", 0, 1,
8721                              ofproto_unixctl_fdb_flush, NULL);
8722     unixctl_command_register("fdb/show", "bridge", 1, 1,
8723                              ofproto_unixctl_fdb_show, NULL);
8724     unixctl_command_register("ofproto/clog", "", 0, 0,
8725                              ofproto_dpif_clog, NULL);
8726     unixctl_command_register("ofproto/unclog", "", 0, 0,
8727                              ofproto_dpif_unclog, NULL);
8728     unixctl_command_register("ofproto/self-check", "[bridge]", 0, 1,
8729                              ofproto_dpif_self_check, NULL);
8730     unixctl_command_register("dpif/dump-dps", "", 0, 0,
8731                              ofproto_unixctl_dpif_dump_dps, NULL);
8732     unixctl_command_register("dpif/show", "[bridge]", 0, INT_MAX,
8733                              ofproto_unixctl_dpif_show, NULL);
8734     unixctl_command_register("dpif/dump-flows", "bridge", 1, 1,
8735                              ofproto_unixctl_dpif_dump_flows, NULL);
8736     unixctl_command_register("dpif/del-flows", "bridge", 1, 1,
8737                              ofproto_unixctl_dpif_del_flows, NULL);
8738 }
8739 \f
8740 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
8741  *
8742  * This is deprecated.  It is only for compatibility with broken device drivers
8743  * in old versions of Linux that do not properly support VLANs when VLAN
8744  * devices are not used.  When broken device drivers are no longer in
8745  * widespread use, we will delete these interfaces. */
8746
8747 static int
8748 set_realdev(struct ofport *ofport_, uint16_t realdev_ofp_port, int vid)
8749 {
8750     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofport_->ofproto);
8751     struct ofport_dpif *ofport = ofport_dpif_cast(ofport_);
8752
8753     if (realdev_ofp_port == ofport->realdev_ofp_port
8754         && vid == ofport->vlandev_vid) {
8755         return 0;
8756     }
8757
8758     ofproto->backer->need_revalidate = REV_RECONFIGURE;
8759
8760     if (ofport->realdev_ofp_port) {
8761         vsp_remove(ofport);
8762     }
8763     if (realdev_ofp_port && ofport->bundle) {
8764         /* vlandevs are enslaved to their realdevs, so they are not allowed to
8765          * themselves be part of a bundle. */
8766         bundle_set(ofport->up.ofproto, ofport->bundle, NULL);
8767     }
8768
8769     ofport->realdev_ofp_port = realdev_ofp_port;
8770     ofport->vlandev_vid = vid;
8771
8772     if (realdev_ofp_port) {
8773         vsp_add(ofport, realdev_ofp_port, vid);
8774     }
8775
8776     return 0;
8777 }
8778
8779 static uint32_t
8780 hash_realdev_vid(uint16_t realdev_ofp_port, int vid)
8781 {
8782     return hash_2words(realdev_ofp_port, vid);
8783 }
8784
8785 /* Returns the ODP port number of the Linux VLAN device that corresponds to
8786  * 'vlan_tci' on the network device with port number 'realdev_odp_port' in
8787  * 'ofproto'.  For example, given 'realdev_odp_port' of eth0 and 'vlan_tci' 9,
8788  * it would return the port number of eth0.9.
8789  *
8790  * Unless VLAN splinters are enabled for port 'realdev_odp_port', this
8791  * function just returns its 'realdev_odp_port' argument. */
8792 static uint32_t
8793 vsp_realdev_to_vlandev(const struct ofproto_dpif *ofproto,
8794                        uint32_t realdev_odp_port, ovs_be16 vlan_tci)
8795 {
8796     if (!hmap_is_empty(&ofproto->realdev_vid_map)) {
8797         uint16_t realdev_ofp_port;
8798         int vid = vlan_tci_to_vid(vlan_tci);
8799         const struct vlan_splinter *vsp;
8800
8801         realdev_ofp_port = odp_port_to_ofp_port(ofproto, realdev_odp_port);
8802         HMAP_FOR_EACH_WITH_HASH (vsp, realdev_vid_node,
8803                                  hash_realdev_vid(realdev_ofp_port, vid),
8804                                  &ofproto->realdev_vid_map) {
8805             if (vsp->realdev_ofp_port == realdev_ofp_port
8806                 && vsp->vid == vid) {
8807                 return ofp_port_to_odp_port(ofproto, vsp->vlandev_ofp_port);
8808             }
8809         }
8810     }
8811     return realdev_odp_port;
8812 }
8813
8814 static struct vlan_splinter *
8815 vlandev_find(const struct ofproto_dpif *ofproto, uint16_t vlandev_ofp_port)
8816 {
8817     struct vlan_splinter *vsp;
8818
8819     HMAP_FOR_EACH_WITH_HASH (vsp, vlandev_node, hash_int(vlandev_ofp_port, 0),
8820                              &ofproto->vlandev_map) {
8821         if (vsp->vlandev_ofp_port == vlandev_ofp_port) {
8822             return vsp;
8823         }
8824     }
8825
8826     return NULL;
8827 }
8828
8829 /* Returns the OpenFlow port number of the "real" device underlying the Linux
8830  * VLAN device with OpenFlow port number 'vlandev_ofp_port' and stores the
8831  * VLAN VID of the Linux VLAN device in '*vid'.  For example, given
8832  * 'vlandev_ofp_port' of eth0.9, it would return the OpenFlow port number of
8833  * eth0 and store 9 in '*vid'.
8834  *
8835  * Returns 0 and does not modify '*vid' if 'vlandev_ofp_port' is not a Linux
8836  * VLAN device.  Unless VLAN splinters are enabled, this is what this function
8837  * always does.*/
8838 static uint16_t
8839 vsp_vlandev_to_realdev(const struct ofproto_dpif *ofproto,
8840                        uint16_t vlandev_ofp_port, int *vid)
8841 {
8842     if (!hmap_is_empty(&ofproto->vlandev_map)) {
8843         const struct vlan_splinter *vsp;
8844
8845         vsp = vlandev_find(ofproto, vlandev_ofp_port);
8846         if (vsp) {
8847             if (vid) {
8848                 *vid = vsp->vid;
8849             }
8850             return vsp->realdev_ofp_port;
8851         }
8852     }
8853     return 0;
8854 }
8855
8856 /* Given 'flow', a flow representing a packet received on 'ofproto', checks
8857  * whether 'flow->in_port' represents a Linux VLAN device.  If so, changes
8858  * 'flow->in_port' to the "real" device backing the VLAN device, sets
8859  * 'flow->vlan_tci' to the VLAN VID, and returns true.  Otherwise (which is
8860  * always the case unless VLAN splinters are enabled), returns false without
8861  * making any changes. */
8862 static bool
8863 vsp_adjust_flow(const struct ofproto_dpif *ofproto, struct flow *flow)
8864 {
8865     uint16_t realdev;
8866     int vid;
8867
8868     realdev = vsp_vlandev_to_realdev(ofproto, flow->in_port, &vid);
8869     if (!realdev) {
8870         return false;
8871     }
8872
8873     /* Cause the flow to be processed as if it came in on the real device with
8874      * the VLAN device's VLAN ID. */
8875     flow->in_port = realdev;
8876     flow->vlan_tci = htons((vid & VLAN_VID_MASK) | VLAN_CFI);
8877     return true;
8878 }
8879
8880 static void
8881 vsp_remove(struct ofport_dpif *port)
8882 {
8883     struct ofproto_dpif *ofproto = ofproto_dpif_cast(port->up.ofproto);
8884     struct vlan_splinter *vsp;
8885
8886     vsp = vlandev_find(ofproto, port->up.ofp_port);
8887     if (vsp) {
8888         hmap_remove(&ofproto->vlandev_map, &vsp->vlandev_node);
8889         hmap_remove(&ofproto->realdev_vid_map, &vsp->realdev_vid_node);
8890         free(vsp);
8891
8892         port->realdev_ofp_port = 0;
8893     } else {
8894         VLOG_ERR("missing vlan device record");
8895     }
8896 }
8897
8898 static void
8899 vsp_add(struct ofport_dpif *port, uint16_t realdev_ofp_port, int vid)
8900 {
8901     struct ofproto_dpif *ofproto = ofproto_dpif_cast(port->up.ofproto);
8902
8903     if (!vsp_vlandev_to_realdev(ofproto, port->up.ofp_port, NULL)
8904         && (vsp_realdev_to_vlandev(ofproto, realdev_ofp_port, htons(vid))
8905             == realdev_ofp_port)) {
8906         struct vlan_splinter *vsp;
8907
8908         vsp = xmalloc(sizeof *vsp);
8909         hmap_insert(&ofproto->vlandev_map, &vsp->vlandev_node,
8910                     hash_int(port->up.ofp_port, 0));
8911         hmap_insert(&ofproto->realdev_vid_map, &vsp->realdev_vid_node,
8912                     hash_realdev_vid(realdev_ofp_port, vid));
8913         vsp->realdev_ofp_port = realdev_ofp_port;
8914         vsp->vlandev_ofp_port = port->up.ofp_port;
8915         vsp->vid = vid;
8916
8917         port->realdev_ofp_port = realdev_ofp_port;
8918     } else {
8919         VLOG_ERR("duplicate vlan device record");
8920     }
8921 }
8922
8923 static uint32_t
8924 ofp_port_to_odp_port(const struct ofproto_dpif *ofproto, uint16_t ofp_port)
8925 {
8926     const struct ofport_dpif *ofport = get_ofp_port(ofproto, ofp_port);
8927     return ofport ? ofport->odp_port : OVSP_NONE;
8928 }
8929
8930 static struct ofport_dpif *
8931 odp_port_to_ofport(const struct dpif_backer *backer, uint32_t odp_port)
8932 {
8933     struct ofport_dpif *port;
8934
8935     HMAP_FOR_EACH_IN_BUCKET (port, odp_port_node,
8936                              hash_int(odp_port, 0),
8937                              &backer->odp_to_ofport_map) {
8938         if (port->odp_port == odp_port) {
8939             return port;
8940         }
8941     }
8942
8943     return NULL;
8944 }
8945
8946 static uint16_t
8947 odp_port_to_ofp_port(const struct ofproto_dpif *ofproto, uint32_t odp_port)
8948 {
8949     struct ofport_dpif *port;
8950
8951     port = odp_port_to_ofport(ofproto->backer, odp_port);
8952     if (port && &ofproto->up == port->up.ofproto) {
8953         return port->up.ofp_port;
8954     } else {
8955         return OFPP_NONE;
8956     }
8957 }
8958 static unsigned long long int
8959 avg_subfacet_life_span(const struct ofproto_dpif *ofproto)
8960 {
8961     unsigned long long int dc;
8962     unsigned long long int avg;
8963
8964     dc = ofproto->total_subfacet_del_count + ofproto->subfacet_del_count;
8965     avg = dc ? ofproto->total_subfacet_life_span / dc : 0;
8966
8967     return avg;
8968 }
8969
8970 static double
8971 avg_subfacet_count(const struct ofproto_dpif *ofproto)
8972 {
8973     double avg_c = 0.0;
8974
8975     if (ofproto->n_update_stats) {
8976         avg_c = (double)ofproto->total_subfacet_count
8977                 / ofproto->n_update_stats;
8978     }
8979
8980     return avg_c;
8981 }
8982
8983 static void
8984 show_dp_rates(struct ds *ds, const char *heading,
8985               const struct avg_subfacet_rates *rates)
8986 {
8987     ds_put_format(ds, "%s add rate: %5.3f/min, del rate: %5.3f/min\n",
8988                   heading, rates->add_rate, rates->del_rate);
8989 }
8990
8991 static void
8992 update_max_subfacet_count(struct ofproto_dpif *ofproto)
8993 {
8994     ofproto->max_n_subfacet = MAX(ofproto->max_n_subfacet,
8995                                   hmap_count(&ofproto->subfacets));
8996 }
8997
8998 /* Compute exponentially weighted moving average, adding 'new' as the newest,
8999  * most heavily weighted element.  'base' designates the rate of decay: after
9000  * 'base' further updates, 'new''s weight in the EWMA decays to about 1/e
9001  * (about .37). */
9002 static void
9003 exp_mavg(double *avg, int base, double new)
9004 {
9005     *avg = (*avg * (base - 1) + new) / base;
9006 }
9007
9008 static void
9009 update_moving_averages(struct ofproto_dpif *ofproto)
9010 {
9011     const int min_ms = 60 * 1000; /* milliseconds in one minute. */
9012
9013     /* Update hourly averages on the minute boundaries. */
9014     if (time_msec() - ofproto->last_minute >= min_ms) {
9015         exp_mavg(&ofproto->hourly.add_rate, 60, ofproto->subfacet_add_count);
9016         exp_mavg(&ofproto->hourly.del_rate, 60, ofproto->subfacet_del_count);
9017
9018         /* Update daily averages on the hour boundaries. */
9019         if ((ofproto->last_minute - ofproto->created) / min_ms % 60 == 59) {
9020             exp_mavg(&ofproto->daily.add_rate, 24, ofproto->hourly.add_rate);
9021             exp_mavg(&ofproto->daily.del_rate, 24, ofproto->hourly.del_rate);
9022         }
9023
9024         ofproto->total_subfacet_add_count += ofproto->subfacet_add_count;
9025         ofproto->total_subfacet_del_count += ofproto->subfacet_del_count;
9026         ofproto->subfacet_add_count = 0;
9027         ofproto->subfacet_del_count = 0;
9028         ofproto->last_minute += min_ms;
9029     }
9030 }
9031
9032 static void
9033 dpif_stats_update_hit_count(struct ofproto_dpif *ofproto, uint64_t delta)
9034 {
9035     ofproto->n_hit += delta;
9036 }
9037
9038 const struct ofproto_class ofproto_dpif_class = {
9039     init,
9040     enumerate_types,
9041     enumerate_names,
9042     del,
9043     port_open_type,
9044     type_run,
9045     type_run_fast,
9046     type_wait,
9047     alloc,
9048     construct,
9049     destruct,
9050     dealloc,
9051     run,
9052     run_fast,
9053     wait,
9054     get_memory_usage,
9055     flush,
9056     get_features,
9057     get_tables,
9058     port_alloc,
9059     port_construct,
9060     port_destruct,
9061     port_dealloc,
9062     port_modified,
9063     port_reconfigured,
9064     port_query_by_name,
9065     port_add,
9066     port_del,
9067     port_get_stats,
9068     port_dump_start,
9069     port_dump_next,
9070     port_dump_done,
9071     port_poll,
9072     port_poll_wait,
9073     port_is_lacp_current,
9074     NULL,                       /* rule_choose_table */
9075     rule_alloc,
9076     rule_construct,
9077     rule_destruct,
9078     rule_dealloc,
9079     rule_get_stats,
9080     rule_execute,
9081     rule_modify_actions,
9082     set_frag_handling,
9083     packet_out,
9084     set_netflow,
9085     get_netflow_ids,
9086     set_sflow,
9087     set_ipfix,
9088     set_cfm,
9089     get_cfm_status,
9090     set_bfd,
9091     get_bfd_status,
9092     set_stp,
9093     get_stp_status,
9094     set_stp_port,
9095     get_stp_port_status,
9096     set_queues,
9097     bundle_set,
9098     bundle_remove,
9099     mirror_set,
9100     mirror_get_stats,
9101     set_flood_vlans,
9102     is_mirror_output_bundle,
9103     forward_bpdu_changed,
9104     set_mac_table_config,
9105     set_realdev,
9106 };