ofproto/ofproto-dpif.c

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