ofproto/ofproto-dpif.c

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