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 "mac-learning.h"
  36 #include "multipath.h"
  37 #include "netdev.h"
  38 #include "netlink.h"
  39 #include "nx-match.h"
  40 #include "odp-util.h"
  41 #include "ofp-util.h"
  42 #include "ofpbuf.h"
  43 #include "ofp-print.h"
  44 #include "ofproto-dpif-sflow.h"
  45 #include "poll-loop.h"
  46 #include "timer.h"
  47 #include "unaligned.h"
  48 #include "unixctl.h"
  49 #include "vlan-bitmap.h"
  50 #include "vlog.h"
  51
  52 VLOG_DEFINE_THIS_MODULE(ofproto_dpif);
  53
  54 COVERAGE_DEFINE(ofproto_dpif_ctlr_action);
  55 COVERAGE_DEFINE(ofproto_dpif_expired);
  56 COVERAGE_DEFINE(ofproto_dpif_no_packet_in);
  57 COVERAGE_DEFINE(ofproto_dpif_xlate);
  58 COVERAGE_DEFINE(facet_changed_rule);
  59 COVERAGE_DEFINE(facet_invalidated);
  60 COVERAGE_DEFINE(facet_revalidate);
  61 COVERAGE_DEFINE(facet_unexpected);
  62
  63 /* Maximum depth of flow table recursion (due to NXAST_RESUBMIT actions) in a
  64  * flow translation. */
  65 #define MAX_RESUBMIT_RECURSION 16
  66
  67 struct ofport_dpif;
  68 struct ofproto_dpif;
  69
  70 struct rule_dpif {
  71     struct rule up;
  72
  73     long long int used;         /* Time last used; time created if not used. */
  74
  75     /* These statistics:
  76      *
  77      *   - Do include packets and bytes from facets that have been deleted or
  78      *     whose own statistics have been folded into the rule.
  79      *
  80      *   - Do include packets and bytes sent "by hand" that were accounted to
  81      *     the rule without any facet being involved (this is a rare corner
  82      *     case in rule_execute()).
  83      *
  84      *   - Do not include packet or bytes that can be obtained from any facet's
  85      *     packet_count or byte_count member or that can be obtained from the
  86      *     datapath by, e.g., dpif_flow_get() for any facet.
  87      */
  88     uint64_t packet_count;       /* Number of packets received. */
  89     uint64_t byte_count;         /* Number of bytes received. */
  90
  91     struct list facets;          /* List of "struct facet"s. */
  92 };
  93
  94 static struct rule_dpif *rule_dpif_cast(const struct rule *rule)
  95 {
  96     return rule ? CONTAINER_OF(rule, struct rule_dpif, up) : NULL;
  97 }
  98
  99 static struct rule_dpif *rule_dpif_lookup(struct ofproto_dpif *ofproto,
 100                                           const struct flow *flow);
 101
 102 #define MAX_MIRRORS 32
 103 typedef uint32_t mirror_mask_t;
 104 #define MIRROR_MASK_C(X) UINT32_C(X)
 105 BUILD_ASSERT_DECL(sizeof(mirror_mask_t) * CHAR_BIT >= MAX_MIRRORS);
 106 struct ofmirror {
 107     struct ofproto_dpif *ofproto; /* Owning ofproto. */
 108     size_t idx;                 /* In ofproto's "mirrors" array. */
 109     void *aux;                  /* Key supplied by ofproto's client. */
 110     char *name;                 /* Identifier for log messages. */
 111
 112     /* Selection criteria. */
 113     struct hmapx srcs;          /* Contains "struct ofbundle *"s. */
 114     struct hmapx dsts;          /* Contains "struct ofbundle *"s. */
 115     unsigned long *vlans;       /* Bitmap of chosen VLANs, NULL selects all. */
 116
 117     /* Output (mutually exclusive). */
 118     struct ofbundle *out;       /* Output port or NULL. */
 119     int out_vlan;               /* Output VLAN or -1. */
 120 };
 121
 122 static void mirror_destroy(struct ofmirror *);
 123
 124 /* A group of one or more OpenFlow ports. */
 125 #define OFBUNDLE_FLOOD ((struct ofbundle *) 1)
 126 struct ofbundle {
 127     struct ofproto_dpif *ofproto; /* Owning ofproto. */
 128     struct hmap_node hmap_node; /* In struct ofproto's "bundles" hmap. */
 129     void *aux;                  /* Key supplied by ofproto's client. */
 130     char *name;                 /* Identifier for log messages. */
 131
 132     /* Configuration. */
 133     struct list ports;          /* Contains "struct ofport"s. */
 134     int vlan;                   /* -1=trunk port, else a 12-bit VLAN ID. */
 135     unsigned long *trunks;      /* Bitmap of trunked VLANs, if 'vlan' == -1.
 136                                  * NULL if all VLANs are trunked. */
 137     struct lacp *lacp;          /* LACP if LACP is enabled, otherwise NULL. */
 138     struct bond *bond;          /* Nonnull iff more than one port. */
 139
 140     /* Status. */
 141     bool floodable;             /* True if no port has OFPPC_NO_FLOOD set. */
 142
 143     /* Port mirroring info. */
 144     mirror_mask_t src_mirrors;  /* Mirrors triggered when packet received. */
 145     mirror_mask_t dst_mirrors;  /* Mirrors triggered when packet sent. */
 146     mirror_mask_t mirror_out;   /* Mirrors that output to this bundle. */
 147 };
 148
 149 static void bundle_remove(struct ofport *);
 150 static void bundle_destroy(struct ofbundle *);
 151 static void bundle_del_port(struct ofport_dpif *);
 152 static void bundle_run(struct ofbundle *);
 153 static void bundle_wait(struct ofbundle *);
 154
 155 struct action_xlate_ctx {
 156 /* action_xlate_ctx_init() initializes these members. */
 157
 158     /* The ofproto. */
 159     struct ofproto_dpif *ofproto;
 160
 161     /* Flow to which the OpenFlow actions apply.  xlate_actions() will modify
 162      * this flow when actions change header fields. */
 163     struct flow flow;
 164
 165     /* The packet corresponding to 'flow', or a null pointer if we are
 166      * revalidating without a packet to refer to. */
 167     const struct ofpbuf *packet;
 168
 169     /* If nonnull, called just before executing a resubmit action.
 170      *
 171      * This is normally null so the client has to set it manually after
 172      * calling action_xlate_ctx_init(). */
 173     void (*resubmit_hook)(struct action_xlate_ctx *, struct rule_dpif *);
 174
 175 /* xlate_actions() initializes and uses these members.  The client might want
 176  * to look at them after it returns. */
 177
 178     struct ofpbuf *odp_actions; /* Datapath actions. */
 179     tag_type tags;              /* Tags associated with OFPP_NORMAL actions. */
 180     bool may_set_up_flow;       /* True ordinarily; false if the actions must
 181                                  * be reassessed for every packet. */
 182     uint16_t nf_output_iface;   /* Output interface index for NetFlow. */
 183
 184 /* xlate_actions() initializes and uses these members, but the client has no
 185  * reason to look at them. */
 186
 187     int recurse;                /* Recursion level, via xlate_table_action. */
 188     uint32_t priority;          /* Current flow priority. 0 if none. */
 189     struct flow base_flow;      /* Flow at the last commit. */
 190     uint32_t base_priority;     /* Priority at the last commit. */
 191 };
 192
 193 static void action_xlate_ctx_init(struct action_xlate_ctx *,
 194                                   struct ofproto_dpif *, const struct flow *,
 195                                   const struct ofpbuf *);
 196 static struct ofpbuf *xlate_actions(struct action_xlate_ctx *,
 197                                     const union ofp_action *in, size_t n_in);
 198
 199 /* An exact-match instantiation of an OpenFlow flow. */
 200 struct facet {
 201     long long int used;         /* Time last used; time created if not used. */
 202
 203     /* These statistics:
 204      *
 205      *   - Do include packets and bytes sent "by hand", e.g. with
 206      *     dpif_execute().
 207      *
 208      *   - Do include packets and bytes that were obtained from the datapath
 209      *     when a flow was deleted (e.g. dpif_flow_del()) or when its
 210      *     statistics were reset (e.g. dpif_flow_put() with
 211      *     DPIF_FP_ZERO_STATS).
 212      *
 213      *   - Do not include any packets or bytes that can currently be obtained
 214      *     from the datapath by, e.g., dpif_flow_get().
 215      */
 216     uint64_t packet_count;       /* Number of packets received. */
 217     uint64_t byte_count;         /* Number of bytes received. */
 218
 219     uint64_t dp_packet_count;    /* Last known packet count in the datapath. */
 220     uint64_t dp_byte_count;      /* Last known byte count in the datapath. */
 221
 222     uint64_t rs_packet_count;    /* Packets pushed to resubmit children. */
 223     uint64_t rs_byte_count;      /* Bytes pushed to resubmit children. */
 224     long long int rs_used;       /* Used time pushed to resubmit children. */
 225
 226     /* Number of bytes passed to account_cb.  This may include bytes that can
 227      * currently obtained from the datapath (thus, it can be greater than
 228      * byte_count). */
 229     uint64_t accounted_bytes;
 230
 231     struct hmap_node hmap_node;  /* In owning ofproto's 'facets' hmap. */
 232     struct list list_node;       /* In owning rule's 'facets' list. */
 233     struct rule_dpif *rule;      /* Owning rule. */
 234     struct flow flow;            /* Exact-match flow. */
 235     bool installed;              /* Installed in datapath? */
 236     bool may_install;            /* True ordinarily; false if actions must
 237                                   * be reassessed for every packet. */
 238     size_t actions_len;          /* Number of bytes in actions[]. */
 239     struct nlattr *actions;      /* Datapath actions. */
 240     tag_type tags;               /* Tags. */
 241     struct netflow_flow nf_flow; /* Per-flow NetFlow tracking data. */
 242 };
 243
 244 static struct facet *facet_create(struct rule_dpif *, const struct flow *,
 245                                   const struct ofpbuf *packet);
 246 static void facet_remove(struct ofproto_dpif *, struct facet *);
 247 static void facet_free(struct facet *);
 248
 249 static struct facet *facet_find(struct ofproto_dpif *, const struct flow *);
 250 static struct facet *facet_lookup_valid(struct ofproto_dpif *,
 251                                         const struct flow *);
 252 static bool facet_revalidate(struct ofproto_dpif *, struct facet *);
 253
 254 static void facet_execute(struct ofproto_dpif *, struct facet *,
 255                           struct ofpbuf *packet);
 256
 257 static int facet_put__(struct ofproto_dpif *, struct facet *,
 258                        const struct nlattr *actions, size_t actions_len,
 259                        struct dpif_flow_stats *);
 260 static void facet_install(struct ofproto_dpif *, struct facet *,
 261                           bool zero_stats);
 262 static void facet_uninstall(struct ofproto_dpif *, struct facet *);
 263 static void facet_flush_stats(struct ofproto_dpif *, struct facet *);
 264
 265 static void facet_make_actions(struct ofproto_dpif *, struct facet *,
 266                                const struct ofpbuf *packet);
 267 static void facet_update_time(struct ofproto_dpif *, struct facet *,
 268                               long long int used);
 269 static void facet_update_stats(struct ofproto_dpif *, struct facet *,
 270                                const struct dpif_flow_stats *);
 271 static void facet_reset_dp_stats(struct facet *, struct dpif_flow_stats *);
 272 static void facet_push_stats(struct facet *);
 273 static void facet_account(struct ofproto_dpif *, struct facet *,
 274                           uint64_t extra_bytes);
 275
 276 static bool facet_is_controller_flow(struct facet *);
 277
 278 static void flow_push_stats(const struct rule_dpif *,
 279                             struct flow *, uint64_t packets, uint64_t bytes,
 280                             long long int used);
 281
 282 struct ofport_dpif {
 283     struct ofport up;
 284
 285     uint32_t odp_port;
 286     struct ofbundle *bundle;    /* Bundle that contains this port, if any. */
 287     struct list bundle_node;    /* In struct ofbundle's "ports" list. */
 288     struct cfm *cfm;            /* Connectivity Fault Management, if any. */
 289     tag_type tag;               /* Tag associated with this port. */
 290     uint32_t bond_stable_id;    /* stable_id to use as bond slave, or 0. */
 291     bool may_enable;            /* May be enabled in bonds. */
 292 };
 293
 294 static struct ofport_dpif *
 295 ofport_dpif_cast(const struct ofport *ofport)
 296 {
 297     assert(ofport->ofproto->ofproto_class == &ofproto_dpif_class);
 298     return ofport ? CONTAINER_OF(ofport, struct ofport_dpif, up) : NULL;
 299 }
 300
 301 static void port_run(struct ofport_dpif *);
 302 static void port_wait(struct ofport_dpif *);
 303 static int set_cfm(struct ofport *, const struct cfm_settings *);
 304
 305 struct dpif_completion {
 306     struct list list_node;
 307     struct ofoperation *op;
 308 };
 309
 310 struct ofproto_dpif {
 311     struct ofproto up;
 312     struct dpif *dpif;
 313     int max_ports;
 314
 315     /* Statistics. */
 316     uint64_t n_matches;
 317
 318     /* Bridging. */
 319     struct netflow *netflow;
 320     struct dpif_sflow *sflow;
 321     struct hmap bundles;        /* Contains "struct ofbundle"s. */
 322     struct mac_learning *ml;
 323     struct ofmirror *mirrors[MAX_MIRRORS];
 324     bool has_bonded_bundles;
 325
 326     /* Expiration. */
 327     struct timer next_expiration;
 328
 329     /* Facets. */
 330     struct hmap facets;
 331     bool need_revalidate;
 332     struct tag_set revalidate_set;
 333
 334     /* Support for debugging async flow mods. */
 335     struct list completions;
 336
 337     bool has_bundle_action; /* True when the first bundle action appears. */
 338 };
 339
 340 /* Defer flow mod completion until "ovs-appctl ofproto/unclog"?  (Useful only
 341  * for debugging the asynchronous flow_mod implementation.) */
 342 static bool clogged;
 343
 344 static void ofproto_dpif_unixctl_init(void);
 345
 346 static struct ofproto_dpif *
 347 ofproto_dpif_cast(const struct ofproto *ofproto)
 348 {
 349     assert(ofproto->ofproto_class == &ofproto_dpif_class);
 350     return CONTAINER_OF(ofproto, struct ofproto_dpif, up);
 351 }
 352
 353 static struct ofport_dpif *get_ofp_port(struct ofproto_dpif *,
 354                                         uint16_t ofp_port);
 355 static struct ofport_dpif *get_odp_port(struct ofproto_dpif *,
 356                                         uint32_t odp_port);
 357
 358 /* Packet processing. */
 359 static void update_learning_table(struct ofproto_dpif *,
 360                                   const struct flow *, int vlan,
 361                                   struct ofbundle *);
 362 static bool is_admissible(struct ofproto_dpif *, const struct flow *,
 363                           bool have_packet, tag_type *, int *vlanp,
 364                           struct ofbundle **in_bundlep);
 365 static void handle_upcall(struct ofproto_dpif *, struct dpif_upcall *);
 366
 367 /* Flow expiration. */
 368 static int expire(struct ofproto_dpif *);
 369
 370 /* Utilities. */
 371 static int send_packet(struct ofproto_dpif *, uint32_t odp_port,
 372                        const struct ofpbuf *packet);
 373
 374 /* Global variables. */
 375 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
 376 \f
 377 /* Factory functions. */
 378
 379 static void
 380 enumerate_types(struct sset *types)
 381 {
 382     dp_enumerate_types(types);
 383 }
 384
 385 static int
 386 enumerate_names(const char *type, struct sset *names)
 387 {
 388     return dp_enumerate_names(type, names);
 389 }
 390
 391 static int
 392 del(const char *type, const char *name)
 393 {
 394     struct dpif *dpif;
 395     int error;
 396
 397     error = dpif_open(name, type, &dpif);
 398     if (!error) {
 399         error = dpif_delete(dpif);
 400         dpif_close(dpif);
 401     }
 402     return error;
 403 }
 404 \f
 405 /* Basic life-cycle. */
 406
 407 static struct ofproto *
 408 alloc(void)
 409 {
 410     struct ofproto_dpif *ofproto = xmalloc(sizeof *ofproto);
 411     return &ofproto->up;
 412 }
 413
 414 static void
 415 dealloc(struct ofproto *ofproto_)
 416 {
 417     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
 418     free(ofproto);
 419 }
 420
 421 static int
 422 construct(struct ofproto *ofproto_)
 423 {
 424     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
 425     const char *name = ofproto->up.name;
 426     int error;
 427     int i;
 428
 429     error = dpif_create_and_open(name, ofproto->up.type, &ofproto->dpif);
 430     if (error) {
 431         VLOG_ERR("failed to open datapath %s: %s", name, strerror(error));
 432         return error;
 433     }
 434
 435     ofproto->max_ports = dpif_get_max_ports(ofproto->dpif);
 436     ofproto->n_matches = 0;
 437
 438     error = dpif_recv_set_mask(ofproto->dpif,
 439                                ((1u << DPIF_UC_MISS) |
 440                                 (1u << DPIF_UC_ACTION) |
 441                                 (1u << DPIF_UC_SAMPLE)));
 442     if (error) {
 443         VLOG_ERR("failed to listen on datapath %s: %s", name, strerror(error));
 444         dpif_close(ofproto->dpif);
 445         return error;
 446     }
 447     dpif_flow_flush(ofproto->dpif);
 448     dpif_recv_purge(ofproto->dpif);
 449
 450     ofproto->netflow = NULL;
 451     ofproto->sflow = NULL;
 452     hmap_init(&ofproto->bundles);
 453     ofproto->ml = mac_learning_create();
 454     for (i = 0; i < MAX_MIRRORS; i++) {
 455         ofproto->mirrors[i] = NULL;
 456     }
 457     ofproto->has_bonded_bundles = false;
 458
 459     timer_set_duration(&ofproto->next_expiration, 1000);
 460
 461     hmap_init(&ofproto->facets);
 462     ofproto->need_revalidate = false;
 463     tag_set_init(&ofproto->revalidate_set);
 464
 465     list_init(&ofproto->completions);
 466
 467     ofproto->up.tables = xmalloc(sizeof *ofproto->up.tables);
 468     classifier_init(&ofproto->up.tables[0]);
 469     ofproto->up.n_tables = 1;
 470
 471     ofproto_dpif_unixctl_init();
 472
 473     ofproto->has_bundle_action = false;
 474
 475     return 0;
 476 }
 477
 478 static void
 479 complete_operations(struct ofproto_dpif *ofproto)
 480 {
 481     struct dpif_completion *c, *next;
 482
 483     LIST_FOR_EACH_SAFE (c, next, list_node, &ofproto->completions) {
 484         ofoperation_complete(c->op, 0);
 485         list_remove(&c->list_node);
 486         free(c);
 487     }
 488 }
 489
 490 static void
 491 destruct(struct ofproto *ofproto_)
 492 {
 493     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
 494     struct rule_dpif *rule, *next_rule;
 495     struct cls_cursor cursor;
 496     int i;
 497
 498     complete_operations(ofproto);
 499
 500     cls_cursor_init(&cursor, &ofproto->up.tables[0], NULL);
 501     CLS_CURSOR_FOR_EACH_SAFE (rule, next_rule, up.cr, &cursor) {
 502         ofproto_rule_destroy(&rule->up);
 503     }
 504
 505     for (i = 0; i < MAX_MIRRORS; i++) {
 506         mirror_destroy(ofproto->mirrors[i]);
 507     }
 508
 509     netflow_destroy(ofproto->netflow);
 510     dpif_sflow_destroy(ofproto->sflow);
 511     hmap_destroy(&ofproto->bundles);
 512     mac_learning_destroy(ofproto->ml);
 513
 514     hmap_destroy(&ofproto->facets);
 515
 516     dpif_close(ofproto->dpif);
 517 }
 518
 519 static int
 520 run(struct ofproto *ofproto_)
 521 {
 522     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
 523     struct ofport_dpif *ofport;
 524     struct ofbundle *bundle;
 525     int i;
 526
 527     if (!clogged) {
 528         complete_operations(ofproto);
 529     }
 530     dpif_run(ofproto->dpif);
 531
 532     for (i = 0; i < 50; i++) {
 533         struct dpif_upcall packet;
 534         int error;
 535
 536         error = dpif_recv(ofproto->dpif, &packet);
 537         if (error) {
 538             if (error == ENODEV) {
 539                 /* Datapath destroyed. */
 540                 return error;
 541             }
 542             break;
 543         }
 544
 545         handle_upcall(ofproto, &packet);
 546     }
 547
 548     if (timer_expired(&ofproto->next_expiration)) {
 549         int delay = expire(ofproto);
 550         timer_set_duration(&ofproto->next_expiration, delay);
 551     }
 552
 553     if (ofproto->netflow) {
 554         netflow_run(ofproto->netflow);
 555     }
 556     if (ofproto->sflow) {
 557         dpif_sflow_run(ofproto->sflow);
 558     }
 559
 560     HMAP_FOR_EACH (ofport, up.hmap_node, &ofproto->up.ports) {
 561         port_run(ofport);
 562     }
 563     HMAP_FOR_EACH (bundle, hmap_node, &ofproto->bundles) {
 564         bundle_run(bundle);
 565     }
 566
 567     /* Now revalidate if there's anything to do. */
 568     if (ofproto->need_revalidate
 569         || !tag_set_is_empty(&ofproto->revalidate_set)) {
 570         struct tag_set revalidate_set = ofproto->revalidate_set;
 571         bool revalidate_all = ofproto->need_revalidate;
 572         struct facet *facet, *next;
 573
 574         /* Clear the revalidation flags. */
 575         tag_set_init(&ofproto->revalidate_set);
 576         ofproto->need_revalidate = false;
 577
 578         HMAP_FOR_EACH_SAFE (facet, next, hmap_node, &ofproto->facets) {
 579             if (revalidate_all
 580                 || tag_set_intersects(&revalidate_set, facet->tags)) {
 581                 facet_revalidate(ofproto, facet);
 582             }
 583         }
 584     }
 585
 586     return 0;
 587 }
 588
 589 static void
 590 wait(struct ofproto *ofproto_)
 591 {
 592     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
 593     struct ofport_dpif *ofport;
 594     struct ofbundle *bundle;
 595
 596     if (!clogged && !list_is_empty(&ofproto->completions)) {
 597         poll_immediate_wake();
 598     }
 599
 600     dpif_wait(ofproto->dpif);
 601     dpif_recv_wait(ofproto->dpif);
 602     if (ofproto->sflow) {
 603         dpif_sflow_wait(ofproto->sflow);
 604     }
 605     if (!tag_set_is_empty(&ofproto->revalidate_set)) {
 606         poll_immediate_wake();
 607     }
 608     HMAP_FOR_EACH (ofport, up.hmap_node, &ofproto->up.ports) {
 609         port_wait(ofport);
 610     }
 611     HMAP_FOR_EACH (bundle, hmap_node, &ofproto->bundles) {
 612         bundle_wait(bundle);
 613     }
 614     if (ofproto->need_revalidate) {
 615         /* Shouldn't happen, but if it does just go around again. */
 616         VLOG_DBG_RL(&rl, "need revalidate in ofproto_wait_cb()");
 617         poll_immediate_wake();
 618     } else {
 619         timer_wait(&ofproto->next_expiration);
 620     }
 621 }
 622
 623 static void
 624 flush(struct ofproto *ofproto_)
 625 {
 626     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
 627     struct facet *facet, *next_facet;
 628
 629     HMAP_FOR_EACH_SAFE (facet, next_facet, hmap_node, &ofproto->facets) {
 630         /* Mark the facet as not installed so that facet_remove() doesn't
 631          * bother trying to uninstall it.  There is no point in uninstalling it
 632          * individually since we are about to blow away all the facets with
 633          * dpif_flow_flush(). */
 634         facet->installed = false;
 635         facet->dp_packet_count = 0;
 636         facet->dp_byte_count = 0;
 637         facet_remove(ofproto, facet);
 638     }
 639     dpif_flow_flush(ofproto->dpif);
 640 }
 641
 642 static void
 643 get_features(struct ofproto *ofproto_ OVS_UNUSED,
 644              bool *arp_match_ip, uint32_t *actions)
 645 {
 646     *arp_match_ip = true;
 647     *actions = ((1u << OFPAT_OUTPUT) |
 648                 (1u << OFPAT_SET_VLAN_VID) |
 649                 (1u << OFPAT_SET_VLAN_PCP) |
 650                 (1u << OFPAT_STRIP_VLAN) |
 651                 (1u << OFPAT_SET_DL_SRC) |
 652                 (1u << OFPAT_SET_DL_DST) |
 653                 (1u << OFPAT_SET_NW_SRC) |
 654                 (1u << OFPAT_SET_NW_DST) |
 655                 (1u << OFPAT_SET_NW_TOS) |
 656                 (1u << OFPAT_SET_TP_SRC) |
 657                 (1u << OFPAT_SET_TP_DST) |
 658                 (1u << OFPAT_ENQUEUE));
 659 }
 660
 661 static void
 662 get_tables(struct ofproto *ofproto_, struct ofp_table_stats *ots)
 663 {
 664     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
 665     struct odp_stats s;
 666
 667     strcpy(ots->name, "classifier");
 668
 669     dpif_get_dp_stats(ofproto->dpif, &s);
 670     put_32aligned_be64(&ots->lookup_count, htonll(s.n_hit + s.n_missed));
 671     put_32aligned_be64(&ots->matched_count,
 672                        htonll(s.n_hit + ofproto->n_matches));
 673 }
 674
 675 static int
 676 set_netflow(struct ofproto *ofproto_,
 677             const struct netflow_options *netflow_options)
 678 {
 679     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
 680
 681     if (netflow_options) {
 682         if (!ofproto->netflow) {
 683             ofproto->netflow = netflow_create();
 684         }
 685         return netflow_set_options(ofproto->netflow, netflow_options);
 686     } else {
 687         netflow_destroy(ofproto->netflow);
 688         ofproto->netflow = NULL;
 689         return 0;
 690     }
 691 }
 692
 693 static struct ofport *
 694 port_alloc(void)
 695 {
 696     struct ofport_dpif *port = xmalloc(sizeof *port);
 697     return &port->up;
 698 }
 699
 700 static void
 701 port_dealloc(struct ofport *port_)
 702 {
 703     struct ofport_dpif *port = ofport_dpif_cast(port_);
 704     free(port);
 705 }
 706
 707 static int
 708 port_construct(struct ofport *port_)
 709 {
 710     struct ofport_dpif *port = ofport_dpif_cast(port_);
 711     struct ofproto_dpif *ofproto = ofproto_dpif_cast(port->up.ofproto);
 712
 713     port->odp_port = ofp_port_to_odp_port(port->up.ofp_port);
 714     port->bundle = NULL;
 715     port->cfm = NULL;
 716     port->tag = tag_create_random();
 717     port->may_enable = true;
 718
 719     if (ofproto->sflow) {
 720         dpif_sflow_add_port(ofproto->sflow, port->odp_port,
 721                             netdev_get_name(port->up.netdev));
 722     }
 723
 724     return 0;
 725 }
 726
 727 static void
 728 port_destruct(struct ofport *port_)
 729 {
 730     struct ofport_dpif *port = ofport_dpif_cast(port_);
 731     struct ofproto_dpif *ofproto = ofproto_dpif_cast(port->up.ofproto);
 732
 733     bundle_remove(port_);
 734     set_cfm(port_, NULL);
 735     if (ofproto->sflow) {
 736         dpif_sflow_del_port(ofproto->sflow, port->odp_port);
 737     }
 738 }
 739
 740 static void
 741 port_modified(struct ofport *port_)
 742 {
 743     struct ofport_dpif *port = ofport_dpif_cast(port_);
 744
 745     if (port->bundle && port->bundle->bond) {
 746         bond_slave_set_netdev(port->bundle->bond, port, port->up.netdev);
 747     }
 748 }
 749
 750 static void
 751 port_reconfigured(struct ofport *port_, ovs_be32 old_config)
 752 {
 753     struct ofport_dpif *port = ofport_dpif_cast(port_);
 754     struct ofproto_dpif *ofproto = ofproto_dpif_cast(port->up.ofproto);
 755     ovs_be32 changed = old_config ^ port->up.opp.config;
 756
 757     if (changed & htonl(OFPPC_NO_RECV | OFPPC_NO_RECV_STP |
 758                         OFPPC_NO_FWD | OFPPC_NO_FLOOD)) {
 759         ofproto->need_revalidate = true;
 760     }
 761 }
 762
 763 static int
 764 set_sflow(struct ofproto *ofproto_,
 765           const struct ofproto_sflow_options *sflow_options)
 766 {
 767     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
 768     struct dpif_sflow *ds = ofproto->sflow;
 769     if (sflow_options) {
 770         if (!ds) {
 771             struct ofport_dpif *ofport;
 772
 773             ds = ofproto->sflow = dpif_sflow_create(ofproto->dpif);
 774             HMAP_FOR_EACH (ofport, up.hmap_node, &ofproto->up.ports) {
 775                 dpif_sflow_add_port(ds, ofport->odp_port,
 776                                     netdev_get_name(ofport->up.netdev));
 777             }
 778         }
 779         dpif_sflow_set_options(ds, sflow_options);
 780     } else {
 781         dpif_sflow_destroy(ds);
 782         ofproto->sflow = NULL;
 783     }
 784     return 0;
 785 }
 786
 787 static int
 788 set_cfm(struct ofport *ofport_, const struct cfm_settings *s)
 789 {
 790     struct ofport_dpif *ofport = ofport_dpif_cast(ofport_);
 791     int error;
 792
 793     if (!s) {
 794         error = 0;
 795     } else {
 796         if (!ofport->cfm) {
 797             ofport->cfm = cfm_create(netdev_get_name(ofport->up.netdev));
 798         }
 799
 800         if (cfm_configure(ofport->cfm, s)) {
 801             return 0;
 802         }
 803
 804         error = EINVAL;
 805     }
 806     cfm_destroy(ofport->cfm);
 807     ofport->cfm = NULL;
 808     return error;
 809 }
 810
 811 static int
 812 get_cfm_fault(const struct ofport *ofport_)
 813 {
 814     struct ofport_dpif *ofport = ofport_dpif_cast(ofport_);
 815
 816     return ofport->cfm ? cfm_get_fault(ofport->cfm) : -1;
 817 }
 818 \f
 819 /* Bundles. */
 820
 821 /* Expires all MAC learning entries associated with 'port' and forces ofproto
 822  * to revalidate every flow. */
 823 static void
 824 bundle_flush_macs(struct ofbundle *bundle)
 825 {
 826     struct ofproto_dpif *ofproto = bundle->ofproto;
 827     struct mac_learning *ml = ofproto->ml;
 828     struct mac_entry *mac, *next_mac;
 829
 830     ofproto->need_revalidate = true;
 831     LIST_FOR_EACH_SAFE (mac, next_mac, lru_node, &ml->lrus) {
 832         if (mac->port.p == bundle) {
 833             mac_learning_expire(ml, mac);
 834         }
 835     }
 836 }
 837
 838 static struct ofbundle *
 839 bundle_lookup(const struct ofproto_dpif *ofproto, void *aux)
 840 {
 841     struct ofbundle *bundle;
 842
 843     HMAP_FOR_EACH_IN_BUCKET (bundle, hmap_node, hash_pointer(aux, 0),
 844                              &ofproto->bundles) {
 845         if (bundle->aux == aux) {
 846             return bundle;
 847         }
 848     }
 849     return NULL;
 850 }
 851
 852 /* Looks up each of the 'n_auxes' pointers in 'auxes' as bundles and adds the
 853  * ones that are found to 'bundles'. */
 854 static void
 855 bundle_lookup_multiple(struct ofproto_dpif *ofproto,
 856                        void **auxes, size_t n_auxes,
 857                        struct hmapx *bundles)
 858 {
 859     size_t i;
 860
 861     hmapx_init(bundles);
 862     for (i = 0; i < n_auxes; i++) {
 863         struct ofbundle *bundle = bundle_lookup(ofproto, auxes[i]);
 864         if (bundle) {
 865             hmapx_add(bundles, bundle);
 866         }
 867     }
 868 }
 869
 870 static void
 871 bundle_del_port(struct ofport_dpif *port)
 872 {
 873     struct ofbundle *bundle = port->bundle;
 874
 875     bundle->ofproto->need_revalidate = true;
 876
 877     list_remove(&port->bundle_node);
 878     port->bundle = NULL;
 879
 880     if (bundle->lacp) {
 881         lacp_slave_unregister(bundle->lacp, port);
 882     }
 883     if (bundle->bond) {
 884         bond_slave_unregister(bundle->bond, port);
 885     }
 886
 887     bundle->floodable = true;
 888     LIST_FOR_EACH (port, bundle_node, &bundle->ports) {
 889         if (port->up.opp.config & htonl(OFPPC_NO_FLOOD)) {
 890             bundle->floodable = false;
 891         }
 892     }
 893 }
 894
 895 static bool
 896 bundle_add_port(struct ofbundle *bundle, uint32_t ofp_port,
 897                 struct lacp_slave_settings *lacp,
 898                 uint32_t bond_stable_id)
 899 {
 900     struct ofport_dpif *port;
 901
 902     port = get_ofp_port(bundle->ofproto, ofp_port);
 903     if (!port) {
 904         return false;
 905     }
 906
 907     if (port->bundle != bundle) {
 908         bundle->ofproto->need_revalidate = true;
 909         if (port->bundle) {
 910             bundle_del_port(port);
 911         }
 912
 913         port->bundle = bundle;
 914         list_push_back(&bundle->ports, &port->bundle_node);
 915         if (port->up.opp.config & htonl(OFPPC_NO_FLOOD)) {
 916             bundle->floodable = false;
 917         }
 918     }
 919     if (lacp) {
 920         lacp_slave_register(bundle->lacp, port, lacp);
 921     }
 922
 923     port->bond_stable_id = bond_stable_id;
 924
 925     return true;
 926 }
 927
 928 static void
 929 bundle_destroy(struct ofbundle *bundle)
 930 {
 931     struct ofproto_dpif *ofproto;
 932     struct ofport_dpif *port, *next_port;
 933     int i;
 934
 935     if (!bundle) {
 936         return;
 937     }
 938
 939     ofproto = bundle->ofproto;
 940     for (i = 0; i < MAX_MIRRORS; i++) {
 941         struct ofmirror *m = ofproto->mirrors[i];
 942         if (m) {
 943             if (m->out == bundle) {
 944                 mirror_destroy(m);
 945             } else if (hmapx_find_and_delete(&m->srcs, bundle)
 946                        || hmapx_find_and_delete(&m->dsts, bundle)) {
 947                 ofproto->need_revalidate = true;
 948             }
 949         }
 950     }
 951
 952     LIST_FOR_EACH_SAFE (port, next_port, bundle_node, &bundle->ports) {
 953         bundle_del_port(port);
 954     }
 955
 956     bundle_flush_macs(bundle);
 957     hmap_remove(&ofproto->bundles, &bundle->hmap_node);
 958     free(bundle->name);
 959     free(bundle->trunks);
 960     lacp_destroy(bundle->lacp);
 961     bond_destroy(bundle->bond);
 962     free(bundle);
 963 }
 964
 965 static int
 966 bundle_set(struct ofproto *ofproto_, void *aux,
 967            const struct ofproto_bundle_settings *s)
 968 {
 969     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
 970     bool need_flush = false;
 971     const unsigned long *trunks;
 972     struct ofport_dpif *port;
 973     struct ofbundle *bundle;
 974     size_t i;
 975     bool ok;
 976
 977     if (!s) {
 978         bundle_destroy(bundle_lookup(ofproto, aux));
 979         return 0;
 980     }
 981
 982     assert(s->n_slaves == 1 || s->bond != NULL);
 983     assert((s->lacp != NULL) == (s->lacp_slaves != NULL));
 984
 985     bundle = bundle_lookup(ofproto, aux);
 986     if (!bundle) {
 987         bundle = xmalloc(sizeof *bundle);
 988
 989         bundle->ofproto = ofproto;
 990         hmap_insert(&ofproto->bundles, &bundle->hmap_node,
 991                     hash_pointer(aux, 0));
 992         bundle->aux = aux;
 993         bundle->name = NULL;
 994
 995         list_init(&bundle->ports);
 996         bundle->vlan = -1;
 997         bundle->trunks = NULL;
 998         bundle->lacp = NULL;
 999         bundle->bond = NULL;
1000
1001         bundle->floodable = true;
1002
1003         bundle->src_mirrors = 0;
1004         bundle->dst_mirrors = 0;
1005         bundle->mirror_out = 0;
1006     }
1007
1008     if (!bundle->name || strcmp(s->name, bundle->name)) {
1009         free(bundle->name);
1010         bundle->name = xstrdup(s->name);
1011     }
1012
1013     /* LACP. */
1014     if (s->lacp) {
1015         if (!bundle->lacp) {
1016             bundle->lacp = lacp_create();
1017         }
1018         lacp_configure(bundle->lacp, s->lacp);
1019     } else {
1020         lacp_destroy(bundle->lacp);
1021         bundle->lacp = NULL;
1022     }
1023
1024     /* Update set of ports. */
1025     ok = true;
1026     for (i = 0; i < s->n_slaves; i++) {
1027         if (!bundle_add_port(bundle, s->slaves[i],
1028                              s->lacp ? &s->lacp_slaves[i] : NULL,
1029                              s->bond_stable_ids ? s->bond_stable_ids[i] : 0)) {
1030             ok = false;
1031         }
1032     }
1033     if (!ok || list_size(&bundle->ports) != s->n_slaves) {
1034         struct ofport_dpif *next_port;
1035
1036         LIST_FOR_EACH_SAFE (port, next_port, bundle_node, &bundle->ports) {
1037             for (i = 0; i < s->n_slaves; i++) {
1038                 if (s->slaves[i] == port->up.ofp_port) {
1039                     goto found;
1040                 }
1041             }
1042
1043             bundle_del_port(port);
1044         found: ;
1045         }
1046     }
1047     assert(list_size(&bundle->ports) <= s->n_slaves);
1048
1049     if (list_is_empty(&bundle->ports)) {
1050         bundle_destroy(bundle);
1051         return EINVAL;
1052     }
1053
1054     /* Set VLAN tag. */
1055     if (s->vlan != bundle->vlan) {
1056         bundle->vlan = s->vlan;
1057         need_flush = true;
1058     }
1059
1060     /* Get trunked VLANs. */
1061     trunks = s->vlan == -1 ? NULL : s->trunks;
1062     if (!vlan_bitmap_equal(trunks, bundle->trunks)) {
1063         free(bundle->trunks);
1064         bundle->trunks = vlan_bitmap_clone(trunks);
1065         need_flush = true;
1066     }
1067
1068     /* Bonding. */
1069     if (!list_is_short(&bundle->ports)) {
1070         bundle->ofproto->has_bonded_bundles = true;
1071         if (bundle->bond) {
1072             if (bond_reconfigure(bundle->bond, s->bond)) {
1073                 ofproto->need_revalidate = true;
1074             }
1075         } else {
1076             bundle->bond = bond_create(s->bond);
1077             ofproto->need_revalidate = true;
1078         }
1079
1080         LIST_FOR_EACH (port, bundle_node, &bundle->ports) {
1081             bond_slave_register(bundle->bond, port, port->bond_stable_id,
1082                                 port->up.netdev);
1083         }
1084     } else {
1085         bond_destroy(bundle->bond);
1086         bundle->bond = NULL;
1087     }
1088
1089     /* If we changed something that would affect MAC learning, un-learn
1090      * everything on this port and force flow revalidation. */
1091     if (need_flush) {
1092         bundle_flush_macs(bundle);
1093     }
1094
1095     return 0;
1096 }
1097
1098 static void
1099 bundle_remove(struct ofport *port_)
1100 {
1101     struct ofport_dpif *port = ofport_dpif_cast(port_);
1102     struct ofbundle *bundle = port->bundle;
1103
1104     if (bundle) {
1105         bundle_del_port(port);
1106         if (list_is_empty(&bundle->ports)) {
1107             bundle_destroy(bundle);
1108         } else if (list_is_short(&bundle->ports)) {
1109             bond_destroy(bundle->bond);
1110             bundle->bond = NULL;
1111         }
1112     }
1113 }
1114
1115 static void
1116 send_pdu_cb(void *port_, const struct lacp_pdu *pdu)
1117 {
1118     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 10);
1119     struct ofport_dpif *port = port_;
1120     uint8_t ea[ETH_ADDR_LEN];
1121     int error;
1122
1123     error = netdev_get_etheraddr(port->up.netdev, ea);
1124     if (!error) {
1125         struct lacp_pdu *packet_pdu;
1126         struct ofpbuf packet;
1127
1128         ofpbuf_init(&packet, 0);
1129         packet_pdu = eth_compose(&packet, eth_addr_lacp, ea, ETH_TYPE_LACP,
1130                                  sizeof *packet_pdu);
1131         *packet_pdu = *pdu;
1132         error = netdev_send(port->up.netdev, &packet);
1133         if (error) {
1134             VLOG_WARN_RL(&rl, "port %s: sending LACP PDU on iface %s failed "
1135                          "(%s)", port->bundle->name,
1136                          netdev_get_name(port->up.netdev), strerror(error));
1137         }
1138         ofpbuf_uninit(&packet);
1139     } else {
1140         VLOG_ERR_RL(&rl, "port %s: cannot obtain Ethernet address of iface "
1141                     "%s (%s)", port->bundle->name,
1142                     netdev_get_name(port->up.netdev), strerror(error));
1143     }
1144 }
1145
1146 static void
1147 bundle_send_learning_packets(struct ofbundle *bundle)
1148 {
1149     struct ofproto_dpif *ofproto = bundle->ofproto;
1150     int error, n_packets, n_errors;
1151     struct mac_entry *e;
1152
1153     error = n_packets = n_errors = 0;
1154     LIST_FOR_EACH (e, lru_node, &ofproto->ml->lrus) {
1155         if (e->port.p != bundle) {
1156             int ret = bond_send_learning_packet(bundle->bond, e->mac, e->vlan);
1157             if (ret) {
1158                 error = ret;
1159                 n_errors++;
1160             }
1161             n_packets++;
1162         }
1163     }
1164
1165     if (n_errors) {
1166         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
1167         VLOG_WARN_RL(&rl, "bond %s: %d errors sending %d gratuitous learning "
1168                      "packets, last error was: %s",
1169                      bundle->name, n_errors, n_packets, strerror(error));
1170     } else {
1171         VLOG_DBG("bond %s: sent %d gratuitous learning packets",
1172                  bundle->name, n_packets);
1173     }
1174 }
1175
1176 static void
1177 bundle_run(struct ofbundle *bundle)
1178 {
1179     if (bundle->lacp) {
1180         lacp_run(bundle->lacp, send_pdu_cb);
1181     }
1182     if (bundle->bond) {
1183         struct ofport_dpif *port;
1184
1185         LIST_FOR_EACH (port, bundle_node, &bundle->ports) {
1186             bond_slave_set_may_enable(bundle->bond, port, port->may_enable);
1187         }
1188
1189         bond_run(bundle->bond, &bundle->ofproto->revalidate_set,
1190                  lacp_negotiated(bundle->lacp));
1191         if (bond_should_send_learning_packets(bundle->bond)) {
1192             bundle_send_learning_packets(bundle);
1193         }
1194     }
1195 }
1196
1197 static void
1198 bundle_wait(struct ofbundle *bundle)
1199 {
1200     if (bundle->lacp) {
1201         lacp_wait(bundle->lacp);
1202     }
1203     if (bundle->bond) {
1204         bond_wait(bundle->bond);
1205     }
1206 }
1207 \f
1208 /* Mirrors. */
1209
1210 static int
1211 mirror_scan(struct ofproto_dpif *ofproto)
1212 {
1213     int idx;
1214
1215     for (idx = 0; idx < MAX_MIRRORS; idx++) {
1216         if (!ofproto->mirrors[idx]) {
1217             return idx;
1218         }
1219     }
1220     return -1;
1221 }
1222
1223 static struct ofmirror *
1224 mirror_lookup(struct ofproto_dpif *ofproto, void *aux)
1225 {
1226     int i;
1227
1228     for (i = 0; i < MAX_MIRRORS; i++) {
1229         struct ofmirror *mirror = ofproto->mirrors[i];
1230         if (mirror && mirror->aux == aux) {
1231             return mirror;
1232         }
1233     }
1234
1235     return NULL;
1236 }
1237
1238 static int
1239 mirror_set(struct ofproto *ofproto_, void *aux,
1240            const struct ofproto_mirror_settings *s)
1241 {
1242     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
1243     mirror_mask_t mirror_bit;
1244     struct ofbundle *bundle;
1245     struct ofmirror *mirror;
1246     struct ofbundle *out;
1247     struct hmapx srcs;          /* Contains "struct ofbundle *"s. */
1248     struct hmapx dsts;          /* Contains "struct ofbundle *"s. */
1249     int out_vlan;
1250
1251     mirror = mirror_lookup(ofproto, aux);
1252     if (!s) {
1253         mirror_destroy(mirror);
1254         return 0;
1255     }
1256     if (!mirror) {
1257         int idx;
1258
1259         idx = mirror_scan(ofproto);
1260         if (idx < 0) {
1261             VLOG_WARN("bridge %s: maximum of %d port mirrors reached, "
1262                       "cannot create %s",
1263                       ofproto->up.name, MAX_MIRRORS, s->name);
1264             return EFBIG;
1265         }
1266
1267         mirror = ofproto->mirrors[idx] = xzalloc(sizeof *mirror);
1268         mirror->ofproto = ofproto;
1269         mirror->idx = idx;
1270         mirror->aux = aux;
1271         mirror->out_vlan = -1;
1272         mirror->name = NULL;
1273     }
1274
1275     if (!mirror->name || strcmp(s->name, mirror->name)) {
1276         free(mirror->name);
1277         mirror->name = xstrdup(s->name);
1278     }
1279
1280     /* Get the new configuration. */
1281     if (s->out_bundle) {
1282         out = bundle_lookup(ofproto, s->out_bundle);
1283         if (!out) {
1284             mirror_destroy(mirror);
1285             return EINVAL;
1286         }
1287         out_vlan = -1;
1288     } else {
1289         out = NULL;
1290         out_vlan = s->out_vlan;
1291     }
1292     bundle_lookup_multiple(ofproto, s->srcs, s->n_srcs, &srcs);
1293     bundle_lookup_multiple(ofproto, s->dsts, s->n_dsts, &dsts);
1294
1295     /* If the configuration has not changed, do nothing. */
1296     if (hmapx_equals(&srcs, &mirror->srcs)
1297         && hmapx_equals(&dsts, &mirror->dsts)
1298         && vlan_bitmap_equal(mirror->vlans, s->src_vlans)
1299         && mirror->out == out
1300         && mirror->out_vlan == out_vlan)
1301     {
1302         hmapx_destroy(&srcs);
1303         hmapx_destroy(&dsts);
1304         return 0;
1305     }
1306
1307     hmapx_swap(&srcs, &mirror->srcs);
1308     hmapx_destroy(&srcs);
1309
1310     hmapx_swap(&dsts, &mirror->dsts);
1311     hmapx_destroy(&dsts);
1312
1313     free(mirror->vlans);
1314     mirror->vlans = vlan_bitmap_clone(s->src_vlans);
1315
1316     mirror->out = out;
1317     mirror->out_vlan = out_vlan;
1318
1319     /* Update bundles. */
1320     mirror_bit = MIRROR_MASK_C(1) << mirror->idx;
1321     HMAP_FOR_EACH (bundle, hmap_node, &mirror->ofproto->bundles) {
1322         if (hmapx_contains(&mirror->srcs, bundle)) {
1323             bundle->src_mirrors |= mirror_bit;
1324         } else {
1325             bundle->src_mirrors &= ~mirror_bit;
1326         }
1327
1328         if (hmapx_contains(&mirror->dsts, bundle)) {
1329             bundle->dst_mirrors |= mirror_bit;
1330         } else {
1331             bundle->dst_mirrors &= ~mirror_bit;
1332         }
1333
1334         if (mirror->out == bundle) {
1335             bundle->mirror_out |= mirror_bit;
1336         } else {
1337             bundle->mirror_out &= ~mirror_bit;
1338         }
1339     }
1340
1341     ofproto->need_revalidate = true;
1342     mac_learning_flush(ofproto->ml);
1343
1344     return 0;
1345 }
1346
1347 static void
1348 mirror_destroy(struct ofmirror *mirror)
1349 {
1350     struct ofproto_dpif *ofproto;
1351     mirror_mask_t mirror_bit;
1352     struct ofbundle *bundle;
1353
1354     if (!mirror) {
1355         return;
1356     }
1357
1358     ofproto = mirror->ofproto;
1359     ofproto->need_revalidate = true;
1360     mac_learning_flush(ofproto->ml);
1361
1362     mirror_bit = MIRROR_MASK_C(1) << mirror->idx;
1363     HMAP_FOR_EACH (bundle, hmap_node, &ofproto->bundles) {
1364         bundle->src_mirrors &= ~mirror_bit;
1365         bundle->dst_mirrors &= ~mirror_bit;
1366         bundle->mirror_out &= ~mirror_bit;
1367     }
1368
1369     hmapx_destroy(&mirror->srcs);
1370     hmapx_destroy(&mirror->dsts);
1371     free(mirror->vlans);
1372
1373     ofproto->mirrors[mirror->idx] = NULL;
1374     free(mirror->name);
1375     free(mirror);
1376 }
1377
1378 static int
1379 set_flood_vlans(struct ofproto *ofproto_, unsigned long *flood_vlans)
1380 {
1381     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
1382     if (mac_learning_set_flood_vlans(ofproto->ml, flood_vlans)) {
1383         ofproto->need_revalidate = true;
1384         mac_learning_flush(ofproto->ml);
1385     }
1386     return 0;
1387 }
1388
1389 static bool
1390 is_mirror_output_bundle(struct ofproto *ofproto_, void *aux)
1391 {
1392     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
1393     struct ofbundle *bundle = bundle_lookup(ofproto, aux);
1394     return bundle && bundle->mirror_out != 0;
1395 }
1396 \f
1397 /* Ports. */
1398
1399 static struct ofport_dpif *
1400 get_ofp_port(struct ofproto_dpif *ofproto, uint16_t ofp_port)
1401 {
1402     struct ofport *ofport = ofproto_get_port(&ofproto->up, ofp_port);
1403     return ofport ? ofport_dpif_cast(ofport) : NULL;
1404 }
1405
1406 static struct ofport_dpif *
1407 get_odp_port(struct ofproto_dpif *ofproto, uint32_t odp_port)
1408 {
1409     return get_ofp_port(ofproto, odp_port_to_ofp_port(odp_port));
1410 }
1411
1412 static void
1413 ofproto_port_from_dpif_port(struct ofproto_port *ofproto_port,
1414                             struct dpif_port *dpif_port)
1415 {
1416     ofproto_port->name = dpif_port->name;
1417     ofproto_port->type = dpif_port->type;
1418     ofproto_port->ofp_port = odp_port_to_ofp_port(dpif_port->port_no);
1419 }
1420
1421 static void
1422 port_run(struct ofport_dpif *ofport)
1423 {
1424     bool enable = netdev_get_carrier(ofport->up.netdev);
1425
1426     if (ofport->cfm) {
1427         cfm_run(ofport->cfm);
1428
1429         if (cfm_should_send_ccm(ofport->cfm)) {
1430             struct ofpbuf packet;
1431
1432             ofpbuf_init(&packet, 0);
1433             cfm_compose_ccm(ofport->cfm, &packet, ofport->up.opp.hw_addr);
1434             send_packet(ofproto_dpif_cast(ofport->up.ofproto),
1435                         ofport->odp_port, &packet);
1436             ofpbuf_uninit(&packet);
1437         }
1438
1439         enable = enable && !cfm_get_fault(ofport->cfm);
1440     }
1441
1442     if (ofport->bundle) {
1443         enable = enable && lacp_slave_may_enable(ofport->bundle->lacp, ofport);
1444     }
1445
1446     if (ofport->may_enable != enable) {
1447         struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofport->up.ofproto);
1448
1449         if (ofproto->has_bundle_action) {
1450             ofproto->need_revalidate = true;
1451         }
1452     }
1453
1454     ofport->may_enable = enable;
1455 }
1456
1457 static void
1458 port_wait(struct ofport_dpif *ofport)
1459 {
1460     if (ofport->cfm) {
1461         cfm_wait(ofport->cfm);
1462     }
1463 }
1464
1465 static int
1466 port_query_by_name(const struct ofproto *ofproto_, const char *devname,
1467                    struct ofproto_port *ofproto_port)
1468 {
1469     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
1470     struct dpif_port dpif_port;
1471     int error;
1472
1473     error = dpif_port_query_by_name(ofproto->dpif, devname, &dpif_port);
1474     if (!error) {
1475         ofproto_port_from_dpif_port(ofproto_port, &dpif_port);
1476     }
1477     return error;
1478 }
1479
1480 static int
1481 port_add(struct ofproto *ofproto_, struct netdev *netdev, uint16_t *ofp_portp)
1482 {
1483     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
1484     uint16_t odp_port;
1485     int error;
1486
1487     error = dpif_port_add(ofproto->dpif, netdev, &odp_port);
1488     if (!error) {
1489         *ofp_portp = odp_port_to_ofp_port(odp_port);
1490     }
1491     return error;
1492 }
1493
1494 static int
1495 port_del(struct ofproto *ofproto_, uint16_t ofp_port)
1496 {
1497     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
1498     int error;
1499
1500     error = dpif_port_del(ofproto->dpif, ofp_port_to_odp_port(ofp_port));
1501     if (!error) {
1502         struct ofport_dpif *ofport = get_ofp_port(ofproto, ofp_port);
1503         if (ofport) {
1504             /* The caller is going to close ofport->up.netdev.  If this is a
1505              * bonded port, then the bond is using that netdev, so remove it
1506              * from the bond.  The client will need to reconfigure everything
1507              * after deleting ports, so then the slave will get re-added. */
1508             bundle_remove(&ofport->up);
1509         }
1510     }
1511     return error;
1512 }
1513
1514 struct port_dump_state {
1515     struct dpif_port_dump dump;
1516     bool done;
1517 };
1518
1519 static int
1520 port_dump_start(const struct ofproto *ofproto_, void **statep)
1521 {
1522     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
1523     struct port_dump_state *state;
1524
1525     *statep = state = xmalloc(sizeof *state);
1526     dpif_port_dump_start(&state->dump, ofproto->dpif);
1527     state->done = false;
1528     return 0;
1529 }
1530
1531 static int
1532 port_dump_next(const struct ofproto *ofproto_ OVS_UNUSED, void *state_,
1533                struct ofproto_port *port)
1534 {
1535     struct port_dump_state *state = state_;
1536     struct dpif_port dpif_port;
1537
1538     if (dpif_port_dump_next(&state->dump, &dpif_port)) {
1539         ofproto_port_from_dpif_port(port, &dpif_port);
1540         return 0;
1541     } else {
1542         int error = dpif_port_dump_done(&state->dump);
1543         state->done = true;
1544         return error ? error : EOF;
1545     }
1546 }
1547
1548 static int
1549 port_dump_done(const struct ofproto *ofproto_ OVS_UNUSED, void *state_)
1550 {
1551     struct port_dump_state *state = state_;
1552
1553     if (!state->done) {
1554         dpif_port_dump_done(&state->dump);
1555     }
1556     free(state);
1557     return 0;
1558 }
1559
1560 static int
1561 port_poll(const struct ofproto *ofproto_, char **devnamep)
1562 {
1563     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
1564     return dpif_port_poll(ofproto->dpif, devnamep);
1565 }
1566
1567 static void
1568 port_poll_wait(const struct ofproto *ofproto_)
1569 {
1570     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
1571     dpif_port_poll_wait(ofproto->dpif);
1572 }
1573
1574 static int
1575 port_is_lacp_current(const struct ofport *ofport_)
1576 {
1577     const struct ofport_dpif *ofport = ofport_dpif_cast(ofport_);
1578     return (ofport->bundle && ofport->bundle->lacp
1579             ? lacp_slave_is_current(ofport->bundle->lacp, ofport)
1580             : -1);
1581 }
1582 \f
1583 /* Upcall handling. */
1584
1585 /* Given 'upcall', of type DPIF_UC_ACTION or DPIF_UC_MISS, sends an
1586  * OFPT_PACKET_IN message to each OpenFlow controller as necessary according to
1587  * their individual configurations.
1588  *
1589  * If 'clone' is true, the caller retains ownership of 'upcall->packet'.
1590  * Otherwise, ownership is transferred to this function. */
1591 static void
1592 send_packet_in(struct ofproto_dpif *ofproto, struct dpif_upcall *upcall,
1593                const struct flow *flow, bool clone)
1594 {
1595     struct ofputil_packet_in pin;
1596
1597     pin.packet = upcall->packet;
1598     pin.in_port = flow->in_port;
1599     pin.reason = upcall->type == DPIF_UC_MISS ? OFPR_NO_MATCH : OFPR_ACTION;
1600     pin.buffer_id = 0;          /* not yet known */
1601     pin.send_len = upcall->userdata;
1602     connmgr_send_packet_in(ofproto->up.connmgr, &pin, flow,
1603                            clone ? NULL : upcall->packet);
1604 }
1605
1606 static bool
1607 process_special(struct ofproto_dpif *ofproto, const struct flow *flow,
1608                 const struct ofpbuf *packet)
1609 {
1610     if (cfm_should_process_flow(flow)) {
1611         struct ofport_dpif *ofport = get_ofp_port(ofproto, flow->in_port);
1612         if (packet && ofport && ofport->cfm) {
1613             cfm_process_heartbeat(ofport->cfm, packet);
1614         }
1615         return true;
1616     } else if (flow->dl_type == htons(ETH_TYPE_LACP)) {
1617         struct ofport_dpif *port = get_ofp_port(ofproto, flow->in_port);
1618         if (packet && port && port->bundle && port->bundle->lacp) {
1619             const struct lacp_pdu *pdu = parse_lacp_packet(packet);
1620             if (pdu) {
1621                 lacp_process_pdu(port->bundle->lacp, port, pdu);
1622             }
1623         }
1624         return true;
1625     }
1626     return false;
1627 }
1628
1629 static void
1630 handle_miss_upcall(struct ofproto_dpif *ofproto, struct dpif_upcall *upcall)
1631 {
1632     struct facet *facet;
1633     struct flow flow;
1634
1635     /* Obtain in_port and tun_id, at least. */
1636     odp_flow_key_to_flow(upcall->key, upcall->key_len, &flow);
1637
1638     /* Set header pointers in 'flow'. */
1639     flow_extract(upcall->packet, flow.tun_id, flow.in_port, &flow);
1640
1641     /* Handle 802.1ag and LACP. */
1642     if (process_special(ofproto, &flow, upcall->packet)) {
1643         ofpbuf_delete(upcall->packet);
1644         ofproto->n_matches++;
1645         return;
1646     }
1647
1648     /* Check with in-band control to see if this packet should be sent
1649      * to the local port regardless of the flow table. */
1650     if (connmgr_msg_in_hook(ofproto->up.connmgr, &flow, upcall->packet)) {
1651         send_packet(ofproto, ODPP_LOCAL, upcall->packet);
1652     }
1653
1654     facet = facet_lookup_valid(ofproto, &flow);
1655     if (!facet) {
1656         struct rule_dpif *rule = rule_dpif_lookup(ofproto, &flow);
1657         if (!rule) {
1658             /* Don't send a packet-in if OFPPC_NO_PACKET_IN asserted. */
1659             struct ofport_dpif *port = get_ofp_port(ofproto, flow.in_port);
1660             if (port) {
1661                 if (port->up.opp.config & htonl(OFPPC_NO_PACKET_IN)) {
1662                     COVERAGE_INC(ofproto_dpif_no_packet_in);
1663                     /* XXX install 'drop' flow entry */
1664                     ofpbuf_delete(upcall->packet);
1665                     return;
1666                 }
1667             } else {
1668                 VLOG_WARN_RL(&rl, "packet-in on unknown port %"PRIu16,
1669                              flow.in_port);
1670             }
1671
1672             send_packet_in(ofproto, upcall, &flow, false);
1673             return;
1674         }
1675
1676         facet = facet_create(rule, &flow, upcall->packet);
1677     } else if (!facet->may_install) {
1678         /* The facet is not installable, that is, we need to process every
1679          * packet, so process the current packet's actions into 'facet'. */
1680         facet_make_actions(ofproto, facet, upcall->packet);
1681     }
1682
1683     if (facet->rule->up.cr.priority == FAIL_OPEN_PRIORITY) {
1684         /*
1685          * Extra-special case for fail-open mode.
1686          *
1687          * We are in fail-open mode and the packet matched the fail-open rule,
1688          * but we are connected to a controller too.  We should send the packet
1689          * up to the controller in the hope that it will try to set up a flow
1690          * and thereby allow us to exit fail-open.
1691          *
1692          * See the top-level comment in fail-open.c for more information.
1693          */
1694         send_packet_in(ofproto, upcall, &flow, true);
1695     }
1696
1697     facet_execute(ofproto, facet, upcall->packet);
1698     facet_install(ofproto, facet, false);
1699     ofproto->n_matches++;
1700 }
1701
1702 static void
1703 handle_upcall(struct ofproto_dpif *ofproto, struct dpif_upcall *upcall)
1704 {
1705     struct flow flow;
1706
1707     switch (upcall->type) {
1708     case DPIF_UC_ACTION:
1709         COVERAGE_INC(ofproto_dpif_ctlr_action);
1710         odp_flow_key_to_flow(upcall->key, upcall->key_len, &flow);
1711         send_packet_in(ofproto, upcall, &flow, false);
1712         break;
1713
1714     case DPIF_UC_SAMPLE:
1715         if (ofproto->sflow) {
1716             odp_flow_key_to_flow(upcall->key, upcall->key_len, &flow);
1717             dpif_sflow_received(ofproto->sflow, upcall, &flow);
1718         }
1719         ofpbuf_delete(upcall->packet);
1720         break;
1721
1722     case DPIF_UC_MISS:
1723         handle_miss_upcall(ofproto, upcall);
1724         break;
1725
1726     case DPIF_N_UC_TYPES:
1727     default:
1728         VLOG_WARN_RL(&rl, "upcall has unexpected type %"PRIu32, upcall->type);
1729         break;
1730     }
1731 }
1732 \f
1733 /* Flow expiration. */
1734
1735 static int facet_max_idle(const struct ofproto_dpif *);
1736 static void update_stats(struct ofproto_dpif *);
1737 static void rule_expire(struct rule_dpif *);
1738 static void expire_facets(struct ofproto_dpif *, int dp_max_idle);
1739
1740 /* This function is called periodically by run().  Its job is to collect
1741  * updates for the flows that have been installed into the datapath, most
1742  * importantly when they last were used, and then use that information to
1743  * expire flows that have not been used recently.
1744  *
1745  * Returns the number of milliseconds after which it should be called again. */
1746 static int
1747 expire(struct ofproto_dpif *ofproto)
1748 {
1749     struct rule_dpif *rule, *next_rule;
1750     struct cls_cursor cursor;
1751     int dp_max_idle;
1752
1753     /* Update stats for each flow in the datapath. */
1754     update_stats(ofproto);
1755
1756     /* Expire facets that have been idle too long. */
1757     dp_max_idle = facet_max_idle(ofproto);
1758     expire_facets(ofproto, dp_max_idle);
1759
1760     /* Expire OpenFlow flows whose idle_timeout or hard_timeout has passed. */
1761     cls_cursor_init(&cursor, &ofproto->up.tables[0], NULL);
1762     CLS_CURSOR_FOR_EACH_SAFE (rule, next_rule, up.cr, &cursor) {
1763         rule_expire(rule);
1764     }
1765
1766     /* All outstanding data in existing flows has been accounted, so it's a
1767      * good time to do bond rebalancing. */
1768     if (ofproto->has_bonded_bundles) {
1769         struct ofbundle *bundle;
1770
1771         HMAP_FOR_EACH (bundle, hmap_node, &ofproto->bundles) {
1772             if (bundle->bond) {
1773                 bond_rebalance(bundle->bond, &ofproto->revalidate_set);
1774             }
1775         }
1776     }
1777
1778     return MIN(dp_max_idle, 1000);
1779 }
1780
1781 /* Update 'packet_count', 'byte_count', and 'used' members of installed facets.
1782  *
1783  * This function also pushes statistics updates to rules which each facet
1784  * resubmits into.  Generally these statistics will be accurate.  However, if a
1785  * facet changes the rule it resubmits into at some time in between
1786  * update_stats() runs, it is possible that statistics accrued to the
1787  * old rule will be incorrectly attributed to the new rule.  This could be
1788  * avoided by calling update_stats() whenever rules are created or
1789  * deleted.  However, the performance impact of making so many calls to the
1790  * datapath do not justify the benefit of having perfectly accurate statistics.
1791  */
1792 static void
1793 update_stats(struct ofproto_dpif *p)
1794 {
1795     const struct dpif_flow_stats *stats;
1796     struct dpif_flow_dump dump;
1797     const struct nlattr *key;
1798     size_t key_len;
1799
1800     dpif_flow_dump_start(&dump, p->dpif);
1801     while (dpif_flow_dump_next(&dump, &key, &key_len, NULL, NULL, &stats)) {
1802         struct facet *facet;
1803         struct flow flow;
1804
1805         if (odp_flow_key_to_flow(key, key_len, &flow)) {
1806             struct ds s;
1807
1808             ds_init(&s);
1809             odp_flow_key_format(key, key_len, &s);
1810             VLOG_WARN_RL(&rl, "failed to convert ODP flow key to flow: %s",
1811                          ds_cstr(&s));
1812             ds_destroy(&s);
1813
1814             continue;
1815         }
1816         facet = facet_find(p, &flow);
1817
1818         if (facet && facet->installed) {
1819
1820             if (stats->n_packets >= facet->dp_packet_count) {
1821                 uint64_t extra = stats->n_packets - facet->dp_packet_count;
1822                 facet->packet_count += extra;
1823             } else {
1824                 VLOG_WARN_RL(&rl, "unexpected packet count from the datapath");
1825             }
1826
1827             if (stats->n_bytes >= facet->dp_byte_count) {
1828                 facet->byte_count += stats->n_bytes - facet->dp_byte_count;
1829             } else {
1830                 VLOG_WARN_RL(&rl, "unexpected byte count from datapath");
1831             }
1832
1833             facet->dp_packet_count = stats->n_packets;
1834             facet->dp_byte_count = stats->n_bytes;
1835
1836             facet_update_time(p, facet, stats->used);
1837             facet_account(p, facet, stats->n_bytes);
1838             facet_push_stats(facet);
1839         } else {
1840             /* There's a flow in the datapath that we know nothing about.
1841              * Delete it. */
1842             COVERAGE_INC(facet_unexpected);
1843             dpif_flow_del(p->dpif, key, key_len, NULL);
1844         }
1845     }
1846     dpif_flow_dump_done(&dump);
1847 }
1848
1849 /* Calculates and returns the number of milliseconds of idle time after which
1850  * facets should expire from the datapath and we should fold their statistics
1851  * into their parent rules in userspace. */
1852 static int
1853 facet_max_idle(const struct ofproto_dpif *ofproto)
1854 {
1855     /*
1856      * Idle time histogram.
1857      *
1858      * Most of the time a switch has a relatively small number of facets.  When
1859      * this is the case we might as well keep statistics for all of them in
1860      * userspace and to cache them in the kernel datapath for performance as
1861      * well.
1862      *
1863      * As the number of facets increases, the memory required to maintain
1864      * statistics about them in userspace and in the kernel becomes
1865      * significant.  However, with a large number of facets it is likely that
1866      * only a few of them are "heavy hitters" that consume a large amount of
1867      * bandwidth.  At this point, only heavy hitters are worth caching in the
1868      * kernel and maintaining in userspaces; other facets we can discard.
1869      *
1870      * The technique used to compute the idle time is to build a histogram with
1871      * N_BUCKETS buckets whose width is BUCKET_WIDTH msecs each.  Each facet
1872      * that is installed in the kernel gets dropped in the appropriate bucket.
1873      * After the histogram has been built, we compute the cutoff so that only
1874      * the most-recently-used 1% of facets (but at least
1875      * ofproto->up.flow_eviction_threshold flows) are kept cached.  At least
1876      * the most-recently-used bucket of facets is kept, so actually an
1877      * arbitrary number of facets can be kept in any given expiration run
1878      * (though the next run will delete most of those unless they receive
1879      * additional data).
1880      *
1881      * This requires a second pass through the facets, in addition to the pass
1882      * made by update_stats(), because the former function never looks
1883      * at uninstallable facets.
1884      */
1885     enum { BUCKET_WIDTH = ROUND_UP(100, TIME_UPDATE_INTERVAL) };
1886     enum { N_BUCKETS = 5000 / BUCKET_WIDTH };
1887     int buckets[N_BUCKETS] = { 0 };
1888     int total, subtotal, bucket;
1889     struct facet *facet;
1890     long long int now;
1891     int i;
1892
1893     total = hmap_count(&ofproto->facets);
1894     if (total <= ofproto->up.flow_eviction_threshold) {
1895         return N_BUCKETS * BUCKET_WIDTH;
1896     }
1897
1898     /* Build histogram. */
1899     now = time_msec();
1900     HMAP_FOR_EACH (facet, hmap_node, &ofproto->facets) {
1901         long long int idle = now - facet->used;
1902         int bucket = (idle <= 0 ? 0
1903                       : idle >= BUCKET_WIDTH * N_BUCKETS ? N_BUCKETS - 1
1904                       : (unsigned int) idle / BUCKET_WIDTH);
1905         buckets[bucket]++;
1906     }
1907
1908     /* Find the first bucket whose flows should be expired. */
1909     subtotal = bucket = 0;
1910     do {
1911         subtotal += buckets[bucket++];
1912     } while (bucket < N_BUCKETS &&
1913              subtotal < MAX(ofproto->up.flow_eviction_threshold, total / 100));
1914
1915     if (VLOG_IS_DBG_ENABLED()) {
1916         struct ds s;
1917
1918         ds_init(&s);
1919         ds_put_cstr(&s, "keep");
1920         for (i = 0; i < N_BUCKETS; i++) {
1921             if (i == bucket) {
1922                 ds_put_cstr(&s, ", drop");
1923             }
1924             if (buckets[i]) {
1925                 ds_put_format(&s, " %d:%d", i * BUCKET_WIDTH, buckets[i]);
1926             }
1927         }
1928         VLOG_INFO("%s: %s (msec:count)", ofproto->up.name, ds_cstr(&s));
1929         ds_destroy(&s);
1930     }
1931
1932     return bucket * BUCKET_WIDTH;
1933 }
1934
1935 static void
1936 facet_active_timeout(struct ofproto_dpif *ofproto, struct facet *facet)
1937 {
1938     if (ofproto->netflow && !facet_is_controller_flow(facet) &&
1939         netflow_active_timeout_expired(ofproto->netflow, &facet->nf_flow)) {
1940         struct ofexpired expired;
1941
1942         if (facet->installed) {
1943             struct dpif_flow_stats stats;
1944
1945             facet_put__(ofproto, facet, facet->actions, facet->actions_len,
1946                         &stats);
1947             facet_update_stats(ofproto, facet, &stats);
1948         }
1949
1950         expired.flow = facet->flow;
1951         expired.packet_count = facet->packet_count;
1952         expired.byte_count = facet->byte_count;
1953         expired.used = facet->used;
1954         netflow_expire(ofproto->netflow, &facet->nf_flow, &expired);
1955     }
1956 }
1957
1958 static void
1959 expire_facets(struct ofproto_dpif *ofproto, int dp_max_idle)
1960 {
1961     long long int cutoff = time_msec() - dp_max_idle;
1962     struct facet *facet, *next_facet;
1963
1964     HMAP_FOR_EACH_SAFE (facet, next_facet, hmap_node, &ofproto->facets) {
1965         facet_active_timeout(ofproto, facet);
1966         if (facet->used < cutoff) {
1967             facet_remove(ofproto, facet);
1968         }
1969     }
1970 }
1971
1972 /* If 'rule' is an OpenFlow rule, that has expired according to OpenFlow rules,
1973  * then delete it entirely. */
1974 static void
1975 rule_expire(struct rule_dpif *rule)
1976 {
1977     struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
1978     struct facet *facet, *next_facet;
1979     long long int now;
1980     uint8_t reason;
1981
1982     /* Has 'rule' expired? */
1983     now = time_msec();
1984     if (rule->up.hard_timeout
1985         && now > rule->up.created + rule->up.hard_timeout * 1000) {
1986         reason = OFPRR_HARD_TIMEOUT;
1987     } else if (rule->up.idle_timeout && list_is_empty(&rule->facets)
1988                && now > rule->used + rule->up.idle_timeout * 1000) {
1989         reason = OFPRR_IDLE_TIMEOUT;
1990     } else {
1991         return;
1992     }
1993
1994     COVERAGE_INC(ofproto_dpif_expired);
1995
1996     /* Update stats.  (This is a no-op if the rule expired due to an idle
1997      * timeout, because that only happens when the rule has no facets left.) */
1998     LIST_FOR_EACH_SAFE (facet, next_facet, list_node, &rule->facets) {
1999         facet_remove(ofproto, facet);
2000     }
2001
2002     /* Get rid of the rule. */
2003     ofproto_rule_expire(&rule->up, reason);
2004 }
2005 \f
2006 /* Facets. */
2007
2008 /* Creates and returns a new facet owned by 'rule', given a 'flow' and an
2009  * example 'packet' within that flow.
2010  *
2011  * The caller must already have determined that no facet with an identical
2012  * 'flow' exists in 'ofproto' and that 'flow' is the best match for 'rule' in
2013  * the ofproto's classifier table. */
2014 static struct facet *
2015 facet_create(struct rule_dpif *rule, const struct flow *flow,
2016              const struct ofpbuf *packet)
2017 {
2018     struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
2019     struct facet *facet;
2020
2021     facet = xzalloc(sizeof *facet);
2022     facet->used = time_msec();
2023     hmap_insert(&ofproto->facets, &facet->hmap_node, flow_hash(flow, 0));
2024     list_push_back(&rule->facets, &facet->list_node);
2025     facet->rule = rule;
2026     facet->flow = *flow;
2027     netflow_flow_init(&facet->nf_flow);
2028     netflow_flow_update_time(ofproto->netflow, &facet->nf_flow, facet->used);
2029
2030     facet_make_actions(ofproto, facet, packet);
2031
2032     return facet;
2033 }
2034
2035 static void
2036 facet_free(struct facet *facet)
2037 {
2038     free(facet->actions);
2039     free(facet);
2040 }
2041
2042 /* Executes, within 'ofproto', the 'n_actions' actions in 'actions' on
2043  * 'packet', which arrived on 'in_port'.
2044  *
2045  * Takes ownership of 'packet'. */
2046 static bool
2047 execute_odp_actions(struct ofproto_dpif *ofproto, const struct flow *flow,
2048                     const struct nlattr *odp_actions, size_t actions_len,
2049                     struct ofpbuf *packet)
2050 {
2051     if (actions_len == NLA_ALIGN(NLA_HDRLEN + sizeof(uint64_t))
2052         && odp_actions->nla_type == ODP_ACTION_ATTR_USERSPACE) {
2053         /* As an optimization, avoid a round-trip from userspace to kernel to
2054          * userspace.  This also avoids possibly filling up kernel packet
2055          * buffers along the way. */
2056         struct dpif_upcall upcall;
2057
2058         upcall.type = DPIF_UC_ACTION;
2059         upcall.packet = packet;
2060         upcall.key = NULL;
2061         upcall.key_len = 0;
2062         upcall.userdata = nl_attr_get_u64(odp_actions);
2063         upcall.sample_pool = 0;
2064         upcall.actions = NULL;
2065         upcall.actions_len = 0;
2066
2067         send_packet_in(ofproto, &upcall, flow, false);
2068
2069         return true;
2070     } else {
2071         struct odputil_keybuf keybuf;
2072         struct ofpbuf key;
2073         int error;
2074
2075         ofpbuf_use_stack(&key, &keybuf, sizeof keybuf);
2076         odp_flow_key_from_flow(&key, flow);
2077
2078         error = dpif_execute(ofproto->dpif, key.data, key.size,
2079                              odp_actions, actions_len, packet);
2080
2081         ofpbuf_delete(packet);
2082         return !error;
2083     }
2084 }
2085
2086 /* Executes the actions indicated by 'facet' on 'packet' and credits 'facet''s
2087  * statistics appropriately.  'packet' must have at least sizeof(struct
2088  * ofp_packet_in) bytes of headroom.
2089  *
2090  * For correct results, 'packet' must actually be in 'facet''s flow; that is,
2091  * applying flow_extract() to 'packet' would yield the same flow as
2092  * 'facet->flow'.
2093  *
2094  * 'facet' must have accurately composed ODP actions; that is, it must not be
2095  * in need of revalidation.
2096  *
2097  * Takes ownership of 'packet'. */
2098 static void
2099 facet_execute(struct ofproto_dpif *ofproto, struct facet *facet,
2100               struct ofpbuf *packet)
2101 {
2102     struct dpif_flow_stats stats;
2103
2104     assert(ofpbuf_headroom(packet) >= sizeof(struct ofp_packet_in));
2105
2106     flow_extract_stats(&facet->flow, packet, &stats);
2107     stats.used = time_msec();
2108     if (execute_odp_actions(ofproto, &facet->flow,
2109                             facet->actions, facet->actions_len, packet)) {
2110         facet_update_stats(ofproto, facet, &stats);
2111     }
2112 }
2113
2114 /* Remove 'facet' from 'ofproto' and free up the associated memory:
2115  *
2116  *   - If 'facet' was installed in the datapath, uninstalls it and updates its
2117  *     rule's statistics, via facet_uninstall().
2118  *
2119  *   - Removes 'facet' from its rule and from ofproto->facets.
2120  */
2121 static void
2122 facet_remove(struct ofproto_dpif *ofproto, struct facet *facet)
2123 {
2124     facet_uninstall(ofproto, facet);
2125     facet_flush_stats(ofproto, facet);
2126     hmap_remove(&ofproto->facets, &facet->hmap_node);
2127     list_remove(&facet->list_node);
2128     facet_free(facet);
2129 }
2130
2131 /* Composes the ODP actions for 'facet' based on its rule's actions. */
2132 static void
2133 facet_make_actions(struct ofproto_dpif *p, struct facet *facet,
2134                    const struct ofpbuf *packet)
2135 {
2136     const struct rule_dpif *rule = facet->rule;
2137     struct ofpbuf *odp_actions;
2138     struct action_xlate_ctx ctx;
2139
2140     action_xlate_ctx_init(&ctx, p, &facet->flow, packet);
2141     odp_actions = xlate_actions(&ctx, rule->up.actions, rule->up.n_actions);
2142     facet->tags = ctx.tags;
2143     facet->may_install = ctx.may_set_up_flow;
2144     facet->nf_flow.output_iface = ctx.nf_output_iface;
2145
2146     if (facet->actions_len != odp_actions->size
2147         || memcmp(facet->actions, odp_actions->data, odp_actions->size)) {
2148         free(facet->actions);
2149         facet->actions_len = odp_actions->size;
2150         facet->actions = xmemdup(odp_actions->data, odp_actions->size);
2151     }
2152
2153     ofpbuf_delete(odp_actions);
2154 }
2155
2156 /* Updates 'facet''s flow in the datapath setting its actions to 'actions_len'
2157  * bytes of actions in 'actions'.  If 'stats' is non-null, statistics counters
2158  * in the datapath will be zeroed and 'stats' will be updated with traffic new
2159  * since 'facet' was last updated.
2160  *
2161  * Returns 0 if successful, otherwise a positive errno value.*/
2162 static int
2163 facet_put__(struct ofproto_dpif *ofproto, struct facet *facet,
2164             const struct nlattr *actions, size_t actions_len,
2165             struct dpif_flow_stats *stats)
2166 {
2167     struct odputil_keybuf keybuf;
2168     enum dpif_flow_put_flags flags;
2169     struct ofpbuf key;
2170     int ret;
2171
2172     flags = DPIF_FP_CREATE | DPIF_FP_MODIFY;
2173     if (stats) {
2174         flags |= DPIF_FP_ZERO_STATS;
2175     }
2176
2177     ofpbuf_use_stack(&key, &keybuf, sizeof keybuf);
2178     odp_flow_key_from_flow(&key, &facet->flow);
2179
2180     ret = dpif_flow_put(ofproto->dpif, flags, key.data, key.size,
2181                         actions, actions_len, stats);
2182
2183     if (stats) {
2184         facet_reset_dp_stats(facet, stats);
2185     }
2186
2187     return ret;
2188 }
2189
2190 /* If 'facet' is installable, inserts or re-inserts it into 'p''s datapath.  If
2191  * 'zero_stats' is true, clears any existing statistics from the datapath for
2192  * 'facet'. */
2193 static void
2194 facet_install(struct ofproto_dpif *p, struct facet *facet, bool zero_stats)
2195 {
2196     struct dpif_flow_stats stats;
2197
2198     if (facet->may_install
2199         && !facet_put__(p, facet, facet->actions, facet->actions_len,
2200                         zero_stats ? &stats : NULL)) {
2201         facet->installed = true;
2202     }
2203 }
2204
2205 static int
2206 vlan_tci_to_openflow_vlan(ovs_be16 vlan_tci)
2207 {
2208     return vlan_tci != htons(0) ? vlan_tci_to_vid(vlan_tci) : OFP_VLAN_NONE;
2209 }
2210
2211 static void
2212 facet_account(struct ofproto_dpif *ofproto,
2213               struct facet *facet, uint64_t extra_bytes)
2214 {
2215     uint64_t total_bytes, n_bytes;
2216     struct ofbundle *in_bundle;
2217     const struct nlattr *a;
2218     tag_type dummy = 0;
2219     unsigned int left;
2220     ovs_be16 vlan_tci;
2221     int vlan;
2222
2223     total_bytes = facet->byte_count + extra_bytes;
2224     if (total_bytes <= facet->accounted_bytes) {
2225         return;
2226     }
2227     n_bytes = total_bytes - facet->accounted_bytes;
2228     facet->accounted_bytes = total_bytes;
2229
2230     /* Test that 'tags' is nonzero to ensure that only flows that include an
2231      * OFPP_NORMAL action are used for learning and bond slave rebalancing.
2232      * This works because OFPP_NORMAL always sets a nonzero tag value.
2233      *
2234      * Feed information from the active flows back into the learning table to
2235      * ensure that table is always in sync with what is actually flowing
2236      * through the datapath. */
2237     if (!facet->tags
2238         || !is_admissible(ofproto, &facet->flow, false, &dummy,
2239                           &vlan, &in_bundle)) {
2240         return;
2241     }
2242
2243     update_learning_table(ofproto, &facet->flow, vlan, in_bundle);
2244
2245     if (!ofproto->has_bonded_bundles) {
2246         return;
2247     }
2248
2249     /* This loop feeds byte counters to bond_account() for rebalancing to use
2250      * as a basis.  We also need to track the actual VLAN on which the packet
2251      * is going to be sent to ensure that it matches the one passed to
2252      * bond_choose_output_slave().  (Otherwise, we will account to the wrong
2253      * hash bucket.) */
2254     vlan_tci = facet->flow.vlan_tci;
2255     NL_ATTR_FOR_EACH_UNSAFE (a, left, facet->actions, facet->actions_len) {
2256         struct ofport_dpif *port;
2257
2258         switch (nl_attr_type(a)) {
2259         case ODP_ACTION_ATTR_OUTPUT:
2260             port = get_odp_port(ofproto, nl_attr_get_u32(a));
2261             if (port && port->bundle && port->bundle->bond) {
2262                 bond_account(port->bundle->bond, &facet->flow,
2263                              vlan_tci_to_openflow_vlan(vlan_tci), n_bytes);
2264             }
2265             break;
2266
2267         case ODP_ACTION_ATTR_STRIP_VLAN:
2268             vlan_tci = htons(0);
2269             break;
2270
2271         case ODP_ACTION_ATTR_SET_DL_TCI:
2272             vlan_tci = nl_attr_get_be16(a);
2273             break;
2274         }
2275     }
2276 }
2277
2278 /* If 'rule' is installed in the datapath, uninstalls it. */
2279 static void
2280 facet_uninstall(struct ofproto_dpif *p, struct facet *facet)
2281 {
2282     if (facet->installed) {
2283         struct odputil_keybuf keybuf;
2284         struct dpif_flow_stats stats;
2285         struct ofpbuf key;
2286         int error;
2287
2288         ofpbuf_use_stack(&key, &keybuf, sizeof keybuf);
2289         odp_flow_key_from_flow(&key, &facet->flow);
2290
2291         error = dpif_flow_del(p->dpif, key.data, key.size, &stats);
2292         facet_reset_dp_stats(facet, &stats);
2293         if (!error) {
2294             facet_update_stats(p, facet, &stats);
2295         }
2296         facet->installed = false;
2297     } else {
2298         assert(facet->dp_packet_count == 0);
2299         assert(facet->dp_byte_count == 0);
2300     }
2301 }
2302
2303 /* Returns true if the only action for 'facet' is to send to the controller.
2304  * (We don't report NetFlow expiration messages for such facets because they
2305  * are just part of the control logic for the network, not real traffic). */
2306 static bool
2307 facet_is_controller_flow(struct facet *facet)
2308 {
2309     return (facet
2310             && facet->rule->up.n_actions == 1
2311             && action_outputs_to_port(&facet->rule->up.actions[0],
2312                                       htons(OFPP_CONTROLLER)));
2313 }
2314
2315 /* Resets 'facet''s datapath statistics counters.  This should be called when
2316  * 'facet''s statistics are cleared in the datapath.  If 'stats' is non-null,
2317  * it should contain the statistics returned by dpif when 'facet' was reset in
2318  * the datapath.  'stats' will be modified to only included statistics new
2319  * since 'facet' was last updated. */
2320 static void
2321 facet_reset_dp_stats(struct facet *facet, struct dpif_flow_stats *stats)
2322 {
2323     if (stats && facet->dp_packet_count <= stats->n_packets
2324         && facet->dp_byte_count <= stats->n_bytes) {
2325         stats->n_packets -= facet->dp_packet_count;
2326         stats->n_bytes -= facet->dp_byte_count;
2327     }
2328
2329     facet->dp_packet_count = 0;
2330     facet->dp_byte_count = 0;
2331 }
2332
2333 /* Folds all of 'facet''s statistics into its rule.  Also updates the
2334  * accounting ofhook and emits a NetFlow expiration if appropriate.  All of
2335  * 'facet''s statistics in the datapath should have been zeroed and folded into
2336  * its packet and byte counts before this function is called. */
2337 static void
2338 facet_flush_stats(struct ofproto_dpif *ofproto, struct facet *facet)
2339 {
2340     assert(!facet->dp_byte_count);
2341     assert(!facet->dp_packet_count);
2342
2343     facet_push_stats(facet);
2344     facet_account(ofproto, facet, 0);
2345
2346     if (ofproto->netflow && !facet_is_controller_flow(facet)) {
2347         struct ofexpired expired;
2348         expired.flow = facet->flow;
2349         expired.packet_count = facet->packet_count;
2350         expired.byte_count = facet->byte_count;
2351         expired.used = facet->used;
2352         netflow_expire(ofproto->netflow, &facet->nf_flow, &expired);
2353     }
2354
2355     facet->rule->packet_count += facet->packet_count;
2356     facet->rule->byte_count += facet->byte_count;
2357
2358     /* Reset counters to prevent double counting if 'facet' ever gets
2359      * reinstalled. */
2360     facet->packet_count = 0;
2361     facet->byte_count = 0;
2362     facet->rs_packet_count = 0;
2363     facet->rs_byte_count = 0;
2364     facet->accounted_bytes = 0;
2365
2366     netflow_flow_clear(&facet->nf_flow);
2367 }
2368
2369 /* Searches 'ofproto''s table of facets for one exactly equal to 'flow'.
2370  * Returns it if found, otherwise a null pointer.
2371  *
2372  * The returned facet might need revalidation; use facet_lookup_valid()
2373  * instead if that is important. */
2374 static struct facet *
2375 facet_find(struct ofproto_dpif *ofproto, const struct flow *flow)
2376 {
2377     struct facet *facet;
2378
2379     HMAP_FOR_EACH_WITH_HASH (facet, hmap_node, flow_hash(flow, 0),
2380                              &ofproto->facets) {
2381         if (flow_equal(flow, &facet->flow)) {
2382             return facet;
2383         }
2384     }
2385
2386     return NULL;
2387 }
2388
2389 /* Searches 'ofproto''s table of facets for one exactly equal to 'flow'.
2390  * Returns it if found, otherwise a null pointer.
2391  *
2392  * The returned facet is guaranteed to be valid. */
2393 static struct facet *
2394 facet_lookup_valid(struct ofproto_dpif *ofproto, const struct flow *flow)
2395 {
2396     struct facet *facet = facet_find(ofproto, flow);
2397
2398     /* The facet we found might not be valid, since we could be in need of
2399      * revalidation.  If it is not valid, don't return it. */
2400     if (facet
2401         && ofproto->need_revalidate
2402         && !facet_revalidate(ofproto, facet)) {
2403         COVERAGE_INC(facet_invalidated);
2404         return NULL;
2405     }
2406
2407     return facet;
2408 }
2409
2410 /* Re-searches 'ofproto''s classifier for a rule matching 'facet':
2411  *
2412  *   - If the rule found is different from 'facet''s current rule, moves
2413  *     'facet' to the new rule and recompiles its actions.
2414  *
2415  *   - If the rule found is the same as 'facet''s current rule, leaves 'facet'
2416  *     where it is and recompiles its actions anyway.
2417  *
2418  *   - If there is none, destroys 'facet'.
2419  *
2420  * Returns true if 'facet' still exists, false if it has been destroyed. */
2421 static bool
2422 facet_revalidate(struct ofproto_dpif *ofproto, struct facet *facet)
2423 {
2424     struct action_xlate_ctx ctx;
2425     struct ofpbuf *odp_actions;
2426     struct rule_dpif *new_rule;
2427     bool actions_changed;
2428
2429     COVERAGE_INC(facet_revalidate);
2430
2431     /* Determine the new rule. */
2432     new_rule = rule_dpif_lookup(ofproto, &facet->flow);
2433     if (!new_rule) {
2434         /* No new rule, so delete the facet. */
2435         facet_remove(ofproto, facet);
2436         return false;
2437     }
2438
2439     /* Calculate new ODP actions.
2440      *
2441      * We do not modify any 'facet' state yet, because we might need to, e.g.,
2442      * emit a NetFlow expiration and, if so, we need to have the old state
2443      * around to properly compose it. */
2444     action_xlate_ctx_init(&ctx, ofproto, &facet->flow, NULL);
2445     odp_actions = xlate_actions(&ctx,
2446                                 new_rule->up.actions, new_rule->up.n_actions);
2447     actions_changed = (facet->actions_len != odp_actions->size
2448                        || memcmp(facet->actions, odp_actions->data,
2449                                  facet->actions_len));
2450
2451     /* If the ODP actions changed or the installability changed, then we need
2452      * to talk to the datapath. */
2453     if (actions_changed || ctx.may_set_up_flow != facet->installed) {
2454         if (ctx.may_set_up_flow) {
2455             struct dpif_flow_stats stats;
2456
2457             facet_put__(ofproto, facet,
2458                         odp_actions->data, odp_actions->size, &stats);
2459             facet_update_stats(ofproto, facet, &stats);
2460         } else {
2461             facet_uninstall(ofproto, facet);
2462         }
2463
2464         /* The datapath flow is gone or has zeroed stats, so push stats out of
2465          * 'facet' into 'rule'. */
2466         facet_flush_stats(ofproto, facet);
2467     }
2468
2469     /* Update 'facet' now that we've taken care of all the old state. */
2470     facet->tags = ctx.tags;
2471     facet->nf_flow.output_iface = ctx.nf_output_iface;
2472     facet->may_install = ctx.may_set_up_flow;
2473     if (actions_changed) {
2474         free(facet->actions);
2475         facet->actions_len = odp_actions->size;
2476         facet->actions = xmemdup(odp_actions->data, odp_actions->size);
2477     }
2478     if (facet->rule != new_rule) {
2479         COVERAGE_INC(facet_changed_rule);
2480         list_remove(&facet->list_node);
2481         list_push_back(&new_rule->facets, &facet->list_node);
2482         facet->rule = new_rule;
2483         facet->used = new_rule->up.created;
2484         facet->rs_used = facet->used;
2485     }
2486
2487     ofpbuf_delete(odp_actions);
2488
2489     return true;
2490 }
2491
2492 /* Updates 'facet''s used time.  Caller is responsible for calling
2493  * facet_push_stats() to update the flows which 'facet' resubmits into. */
2494 static void
2495 facet_update_time(struct ofproto_dpif *ofproto, struct facet *facet,
2496                   long long int used)
2497 {
2498     if (used > facet->used) {
2499         facet->used = used;
2500         if (used > facet->rule->used) {
2501             facet->rule->used = used;
2502         }
2503         netflow_flow_update_time(ofproto->netflow, &facet->nf_flow, used);
2504     }
2505 }
2506
2507 /* Folds the statistics from 'stats' into the counters in 'facet'.
2508  *
2509  * Because of the meaning of a facet's counters, it only makes sense to do this
2510  * if 'stats' are not tracked in the datapath, that is, if 'stats' represents a
2511  * packet that was sent by hand or if it represents statistics that have been
2512  * cleared out of the datapath. */
2513 static void
2514 facet_update_stats(struct ofproto_dpif *ofproto, struct facet *facet,
2515                    const struct dpif_flow_stats *stats)
2516 {
2517     if (stats->n_packets || stats->used > facet->used) {
2518         facet_update_time(ofproto, facet, stats->used);
2519         facet->packet_count += stats->n_packets;
2520         facet->byte_count += stats->n_bytes;
2521         facet_push_stats(facet);
2522         netflow_flow_update_flags(&facet->nf_flow, stats->tcp_flags);
2523     }
2524 }
2525
2526 static void
2527 facet_push_stats(struct facet *facet)
2528 {
2529     uint64_t rs_packets, rs_bytes;
2530
2531     assert(facet->packet_count >= facet->rs_packet_count);
2532     assert(facet->byte_count >= facet->rs_byte_count);
2533     assert(facet->used >= facet->rs_used);
2534
2535     rs_packets = facet->packet_count - facet->rs_packet_count;
2536     rs_bytes = facet->byte_count - facet->rs_byte_count;
2537
2538     if (rs_packets || rs_bytes || facet->used > facet->rs_used) {
2539         facet->rs_packet_count = facet->packet_count;
2540         facet->rs_byte_count = facet->byte_count;
2541         facet->rs_used = facet->used;
2542
2543         flow_push_stats(facet->rule, &facet->flow,
2544                         rs_packets, rs_bytes, facet->used);
2545     }
2546 }
2547
2548 struct ofproto_push {
2549     struct action_xlate_ctx ctx;
2550     uint64_t packets;
2551     uint64_t bytes;
2552     long long int used;
2553 };
2554
2555 static void
2556 push_resubmit(struct action_xlate_ctx *ctx, struct rule_dpif *rule)
2557 {
2558     struct ofproto_push *push = CONTAINER_OF(ctx, struct ofproto_push, ctx);
2559
2560     if (rule) {
2561         rule->packet_count += push->packets;
2562         rule->byte_count += push->bytes;
2563         rule->used = MAX(push->used, rule->used);
2564     }
2565 }
2566
2567 /* Pushes flow statistics to the rules which 'flow' resubmits into given
2568  * 'rule''s actions. */
2569 static void
2570 flow_push_stats(const struct rule_dpif *rule,
2571                 struct flow *flow, uint64_t packets, uint64_t bytes,
2572                 long long int used)
2573 {
2574     struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
2575     struct ofproto_push push;
2576
2577     push.packets = packets;
2578     push.bytes = bytes;
2579     push.used = used;
2580
2581     action_xlate_ctx_init(&push.ctx, ofproto, flow, NULL);
2582     push.ctx.resubmit_hook = push_resubmit;
2583     ofpbuf_delete(xlate_actions(&push.ctx,
2584                                 rule->up.actions, rule->up.n_actions));
2585 }
2586 \f
2587 /* Rules. */
2588
2589 static struct rule_dpif *
2590 rule_dpif_lookup(struct ofproto_dpif *ofproto, const struct flow *flow)
2591 {
2592     return rule_dpif_cast(rule_from_cls_rule(
2593                               classifier_lookup(&ofproto->up.tables[0],
2594                                                 flow)));
2595 }
2596
2597 static void
2598 complete_operation(struct rule_dpif *rule)
2599 {
2600     struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
2601
2602     ofproto->need_revalidate = true;
2603     if (clogged) {
2604         struct dpif_completion *c = xmalloc(sizeof *c);
2605         c->op = rule->up.pending;
2606         list_push_back(&ofproto->completions, &c->list_node);
2607     } else {
2608         ofoperation_complete(rule->up.pending, 0);
2609     }
2610 }
2611
2612 static struct rule *
2613 rule_alloc(void)
2614 {
2615     struct rule_dpif *rule = xmalloc(sizeof *rule);
2616     return &rule->up;
2617 }
2618
2619 static void
2620 rule_dealloc(struct rule *rule_)
2621 {
2622     struct rule_dpif *rule = rule_dpif_cast(rule_);
2623     free(rule);
2624 }
2625
2626 static int
2627 rule_construct(struct rule *rule_)
2628 {
2629     struct rule_dpif *rule = rule_dpif_cast(rule_);
2630     struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
2631     struct rule_dpif *victim;
2632     int error;
2633
2634     error = validate_actions(rule->up.actions, rule->up.n_actions,
2635                              &rule->up.cr.flow, ofproto->max_ports);
2636     if (error) {
2637         return error;
2638     }
2639
2640     rule->used = rule->up.created;
2641     rule->packet_count = 0;
2642     rule->byte_count = 0;
2643
2644     victim = rule_dpif_cast(ofoperation_get_victim(rule->up.pending));
2645     if (victim && !list_is_empty(&victim->facets)) {
2646         struct facet *facet;
2647
2648         rule->facets = victim->facets;
2649         list_moved(&rule->facets);
2650         LIST_FOR_EACH (facet, list_node, &rule->facets) {
2651             facet->rule = rule;
2652         }
2653     } else {
2654         /* Must avoid list_moved() in this case. */
2655         list_init(&rule->facets);
2656     }
2657
2658     complete_operation(rule);
2659     return 0;
2660 }
2661
2662 static void
2663 rule_destruct(struct rule *rule_)
2664 {
2665     struct rule_dpif *rule = rule_dpif_cast(rule_);
2666     struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
2667     struct facet *facet, *next_facet;
2668
2669     LIST_FOR_EACH_SAFE (facet, next_facet, list_node, &rule->facets) {
2670         facet_revalidate(ofproto, facet);
2671     }
2672
2673     complete_operation(rule);
2674 }
2675
2676 static void
2677 rule_get_stats(struct rule *rule_, uint64_t *packets, uint64_t *bytes)
2678 {
2679     struct rule_dpif *rule = rule_dpif_cast(rule_);
2680     struct facet *facet;
2681
2682     /* Start from historical data for 'rule' itself that are no longer tracked
2683      * in facets.  This counts, for example, facets that have expired. */
2684     *packets = rule->packet_count;
2685     *bytes = rule->byte_count;
2686
2687     /* Add any statistics that are tracked by facets.  This includes
2688      * statistical data recently updated by ofproto_update_stats() as well as
2689      * stats for packets that were executed "by hand" via dpif_execute(). */
2690     LIST_FOR_EACH (facet, list_node, &rule->facets) {
2691         *packets += facet->packet_count;
2692         *bytes += facet->byte_count;
2693     }
2694 }
2695
2696 static int
2697 rule_execute(struct rule *rule_, struct flow *flow, struct ofpbuf *packet)
2698 {
2699     struct rule_dpif *rule = rule_dpif_cast(rule_);
2700     struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
2701     struct action_xlate_ctx ctx;
2702     struct ofpbuf *odp_actions;
2703     struct facet *facet;
2704     size_t size;
2705
2706     /* First look for a related facet.  If we find one, account it to that. */
2707     facet = facet_lookup_valid(ofproto, flow);
2708     if (facet && facet->rule == rule) {
2709         facet_execute(ofproto, facet, packet);
2710         return 0;
2711     }
2712
2713     /* Otherwise, if 'rule' is in fact the correct rule for 'packet', then
2714      * create a new facet for it and use that. */
2715     if (rule_dpif_lookup(ofproto, flow) == rule) {
2716         facet = facet_create(rule, flow, packet);
2717         facet_execute(ofproto, facet, packet);
2718         facet_install(ofproto, facet, true);
2719         return 0;
2720     }
2721
2722     /* We can't account anything to a facet.  If we were to try, then that
2723      * facet would have a non-matching rule, busting our invariants. */
2724     action_xlate_ctx_init(&ctx, ofproto, flow, packet);
2725     odp_actions = xlate_actions(&ctx, rule->up.actions, rule->up.n_actions);
2726     size = packet->size;
2727     if (execute_odp_actions(ofproto, flow, odp_actions->data,
2728                             odp_actions->size, packet)) {
2729         rule->used = time_msec();
2730         rule->packet_count++;
2731         rule->byte_count += size;
2732         flow_push_stats(rule, flow, 1, size, rule->used);
2733     }
2734     ofpbuf_delete(odp_actions);
2735
2736     return 0;
2737 }
2738
2739 static void
2740 rule_modify_actions(struct rule *rule_)
2741 {
2742     struct rule_dpif *rule = rule_dpif_cast(rule_);
2743     struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
2744     int error;
2745
2746     error = validate_actions(rule->up.actions, rule->up.n_actions,
2747                              &rule->up.cr.flow, ofproto->max_ports);
2748     if (error) {
2749         ofoperation_complete(rule->up.pending, error);
2750         return;
2751     }
2752
2753     complete_operation(rule);
2754 }
2755 \f
2756 /* Sends 'packet' out of port 'odp_port' within 'p'.
2757  * Returns 0 if successful, otherwise a positive errno value. */
2758 static int
2759 send_packet(struct ofproto_dpif *ofproto, uint32_t odp_port,
2760             const struct ofpbuf *packet)
2761 {
2762     struct ofpbuf key, odp_actions;
2763     struct odputil_keybuf keybuf;
2764     struct flow flow;
2765     int error;
2766
2767     flow_extract((struct ofpbuf *) packet, 0, 0, &flow);
2768     ofpbuf_use_stack(&key, &keybuf, sizeof keybuf);
2769     odp_flow_key_from_flow(&key, &flow);
2770
2771     ofpbuf_init(&odp_actions, 32);
2772     nl_msg_put_u32(&odp_actions, ODP_ACTION_ATTR_OUTPUT, odp_port);
2773     error = dpif_execute(ofproto->dpif,
2774                          key.data, key.size,
2775                          odp_actions.data, odp_actions.size,
2776                          packet);
2777     ofpbuf_uninit(&odp_actions);
2778
2779     if (error) {
2780         VLOG_WARN_RL(&rl, "%s: failed to send packet on port %"PRIu32" (%s)",
2781                      ofproto->up.name, odp_port, strerror(error));
2782     }
2783     return error;
2784 }
2785 \f
2786 /* OpenFlow to ODP action translation. */
2787
2788 static void do_xlate_actions(const union ofp_action *in, size_t n_in,
2789                              struct action_xlate_ctx *ctx);
2790 static void xlate_normal(struct action_xlate_ctx *);
2791
2792 static void
2793 commit_odp_actions(struct action_xlate_ctx *ctx)
2794 {
2795     const struct flow *flow = &ctx->flow;
2796     struct flow *base = &ctx->base_flow;
2797     struct ofpbuf *odp_actions = ctx->odp_actions;
2798
2799     if (base->tun_id != flow->tun_id) {
2800         nl_msg_put_be64(odp_actions, ODP_ACTION_ATTR_SET_TUNNEL, flow->tun_id);
2801         base->tun_id = flow->tun_id;
2802     }
2803
2804     if (base->nw_src != flow->nw_src) {
2805         nl_msg_put_be32(odp_actions, ODP_ACTION_ATTR_SET_NW_SRC, flow->nw_src);
2806         base->nw_src = flow->nw_src;
2807     }
2808
2809     if (base->nw_dst != flow->nw_dst) {
2810         nl_msg_put_be32(odp_actions, ODP_ACTION_ATTR_SET_NW_DST, flow->nw_dst);
2811         base->nw_dst = flow->nw_dst;
2812     }
2813
2814     if (base->nw_tos != flow->nw_tos) {
2815         nl_msg_put_u8(odp_actions, ODP_ACTION_ATTR_SET_NW_TOS, flow->nw_tos);
2816         base->nw_tos = flow->nw_tos;
2817     }
2818
2819     if (base->vlan_tci != flow->vlan_tci) {
2820         if (!(flow->vlan_tci & htons(VLAN_CFI))) {
2821             nl_msg_put_flag(odp_actions, ODP_ACTION_ATTR_STRIP_VLAN);
2822         } else {
2823             nl_msg_put_be16(odp_actions, ODP_ACTION_ATTR_SET_DL_TCI,
2824                             flow->vlan_tci & ~htons(VLAN_CFI));
2825         }
2826         base->vlan_tci = flow->vlan_tci;
2827     }
2828
2829     if (base->tp_src != flow->tp_src) {
2830         nl_msg_put_be16(odp_actions, ODP_ACTION_ATTR_SET_TP_SRC, flow->tp_src);
2831         base->tp_src = flow->tp_src;
2832     }
2833
2834     if (base->tp_dst != flow->tp_dst) {
2835         nl_msg_put_be16(odp_actions, ODP_ACTION_ATTR_SET_TP_DST, flow->tp_dst);
2836         base->tp_dst = flow->tp_dst;
2837     }
2838
2839     if (!eth_addr_equals(base->dl_src, flow->dl_src)) {
2840         nl_msg_put_unspec(odp_actions, ODP_ACTION_ATTR_SET_DL_SRC,
2841                           flow->dl_src, ETH_ADDR_LEN);
2842         memcpy(base->dl_src, flow->dl_src, ETH_ADDR_LEN);
2843     }
2844
2845     if (!eth_addr_equals(base->dl_dst, flow->dl_dst)) {
2846         nl_msg_put_unspec(odp_actions, ODP_ACTION_ATTR_SET_DL_DST,
2847                           flow->dl_dst, ETH_ADDR_LEN);
2848         memcpy(base->dl_dst, flow->dl_dst, ETH_ADDR_LEN);
2849     }
2850
2851     if (ctx->base_priority != ctx->priority) {
2852         if (ctx->priority) {
2853             nl_msg_put_u32(odp_actions, ODP_ACTION_ATTR_SET_PRIORITY,
2854                            ctx->priority);
2855         } else {
2856             nl_msg_put_flag(odp_actions, ODP_ACTION_ATTR_POP_PRIORITY);
2857         }
2858         ctx->base_priority = ctx->priority;
2859     }
2860 }
2861
2862 static void
2863 add_output_action(struct action_xlate_ctx *ctx, uint16_t ofp_port)
2864 {
2865     const struct ofport_dpif *ofport = get_ofp_port(ctx->ofproto, ofp_port);
2866     uint16_t odp_port = ofp_port_to_odp_port(ofp_port);
2867
2868     if (ofport) {
2869         if (ofport->up.opp.config & htonl(OFPPC_NO_FWD)) {
2870             /* Forwarding disabled on port. */
2871             return;
2872         }
2873     } else {
2874         /*
2875          * We don't have an ofport record for this port, but it doesn't hurt to
2876          * allow forwarding to it anyhow.  Maybe such a port will appear later
2877          * and we're pre-populating the flow table.
2878          */
2879     }
2880
2881     commit_odp_actions(ctx);
2882     nl_msg_put_u32(ctx->odp_actions, ODP_ACTION_ATTR_OUTPUT, odp_port);
2883     ctx->nf_output_iface = ofp_port;
2884 }
2885
2886 static void
2887 xlate_table_action(struct action_xlate_ctx *ctx, uint16_t in_port)
2888 {
2889     if (ctx->recurse < MAX_RESUBMIT_RECURSION) {
2890         struct rule_dpif *rule;
2891         uint16_t old_in_port;
2892
2893         /* Look up a flow with 'in_port' as the input port.  Then restore the
2894          * original input port (otherwise OFPP_NORMAL and OFPP_IN_PORT will
2895          * have surprising behavior). */
2896         old_in_port = ctx->flow.in_port;
2897         ctx->flow.in_port = in_port;
2898         rule = rule_dpif_lookup(ctx->ofproto, &ctx->flow);
2899         ctx->flow.in_port = old_in_port;
2900
2901         if (ctx->resubmit_hook) {
2902             ctx->resubmit_hook(ctx, rule);
2903         }
2904
2905         if (rule) {
2906             ctx->recurse++;
2907             do_xlate_actions(rule->up.actions, rule->up.n_actions, ctx);
2908             ctx->recurse--;
2909         }
2910     } else {
2911         static struct vlog_rate_limit recurse_rl = VLOG_RATE_LIMIT_INIT(1, 1);
2912
2913         VLOG_ERR_RL(&recurse_rl, "NXAST_RESUBMIT recursed over %d times",
2914                     MAX_RESUBMIT_RECURSION);
2915     }
2916 }
2917
2918 static void
2919 flood_packets(struct action_xlate_ctx *ctx, ovs_be32 mask)
2920 {
2921     struct ofport_dpif *ofport;
2922
2923     commit_odp_actions(ctx);
2924     HMAP_FOR_EACH (ofport, up.hmap_node, &ctx->ofproto->up.ports) {
2925         uint16_t ofp_port = ofport->up.ofp_port;
2926         if (ofp_port != ctx->flow.in_port && !(ofport->up.opp.config & mask)) {
2927             nl_msg_put_u32(ctx->odp_actions, ODP_ACTION_ATTR_OUTPUT,
2928                            ofport->odp_port);
2929         }
2930     }
2931
2932     ctx->nf_output_iface = NF_OUT_FLOOD;
2933 }
2934
2935 static void
2936 xlate_output_action__(struct action_xlate_ctx *ctx,
2937                       uint16_t port, uint16_t max_len)
2938 {
2939     uint16_t prev_nf_output_iface = ctx->nf_output_iface;
2940
2941     ctx->nf_output_iface = NF_OUT_DROP;
2942
2943     switch (port) {
2944     case OFPP_IN_PORT:
2945         add_output_action(ctx, ctx->flow.in_port);
2946         break;
2947     case OFPP_TABLE:
2948         xlate_table_action(ctx, ctx->flow.in_port);
2949         break;
2950     case OFPP_NORMAL:
2951         xlate_normal(ctx);
2952         break;
2953     case OFPP_FLOOD:
2954         flood_packets(ctx,  htonl(OFPPC_NO_FLOOD));
2955         break;
2956     case OFPP_ALL:
2957         flood_packets(ctx, htonl(0));
2958         break;
2959     case OFPP_CONTROLLER:
2960         commit_odp_actions(ctx);
2961         nl_msg_put_u64(ctx->odp_actions, ODP_ACTION_ATTR_USERSPACE, max_len);
2962         break;
2963     case OFPP_LOCAL:
2964         add_output_action(ctx, OFPP_LOCAL);
2965         break;
2966     case OFPP_NONE:
2967         break;
2968     default:
2969         if (port != ctx->flow.in_port) {
2970             add_output_action(ctx, port);
2971         }
2972         break;
2973     }
2974
2975     if (prev_nf_output_iface == NF_OUT_FLOOD) {
2976         ctx->nf_output_iface = NF_OUT_FLOOD;
2977     } else if (ctx->nf_output_iface == NF_OUT_DROP) {
2978         ctx->nf_output_iface = prev_nf_output_iface;
2979     } else if (prev_nf_output_iface != NF_OUT_DROP &&
2980                ctx->nf_output_iface != NF_OUT_FLOOD) {
2981         ctx->nf_output_iface = NF_OUT_MULTI;
2982     }
2983 }
2984
2985 static void
2986 xlate_output_action(struct action_xlate_ctx *ctx,
2987                     const struct ofp_action_output *oao)
2988 {
2989     xlate_output_action__(ctx, ntohs(oao->port), ntohs(oao->max_len));
2990 }
2991
2992 static void
2993 xlate_enqueue_action(struct action_xlate_ctx *ctx,
2994                      const struct ofp_action_enqueue *oae)
2995 {
2996     uint16_t ofp_port, odp_port;
2997     uint32_t ctx_priority, priority;
2998     int error;
2999
3000     error = dpif_queue_to_priority(ctx->ofproto->dpif, ntohl(oae->queue_id),
3001                                    &priority);
3002     if (error) {
3003         /* Fall back to ordinary output action. */
3004         xlate_output_action__(ctx, ntohs(oae->port), 0);
3005         return;
3006     }
3007
3008     /* Figure out ODP output port. */
3009     ofp_port = ntohs(oae->port);
3010     if (ofp_port == OFPP_IN_PORT) {
3011         ofp_port = ctx->flow.in_port;
3012     }
3013     odp_port = ofp_port_to_odp_port(ofp_port);
3014
3015     /* Add ODP actions. */
3016     ctx_priority = ctx->priority;
3017     ctx->priority = priority;
3018     add_output_action(ctx, odp_port);
3019     ctx->priority = ctx_priority;
3020
3021     /* Update NetFlow output port. */
3022     if (ctx->nf_output_iface == NF_OUT_DROP) {
3023         ctx->nf_output_iface = odp_port;
3024     } else if (ctx->nf_output_iface != NF_OUT_FLOOD) {
3025         ctx->nf_output_iface = NF_OUT_MULTI;
3026     }
3027 }
3028
3029 static void
3030 xlate_set_queue_action(struct action_xlate_ctx *ctx,
3031                        const struct nx_action_set_queue *nasq)
3032 {
3033     uint32_t priority;
3034     int error;
3035
3036     error = dpif_queue_to_priority(ctx->ofproto->dpif, ntohl(nasq->queue_id),
3037                                    &priority);
3038     if (error) {
3039         /* Couldn't translate queue to a priority, so ignore.  A warning
3040          * has already been logged. */
3041         return;
3042     }
3043
3044     ctx->priority = priority;
3045 }
3046
3047 struct xlate_reg_state {
3048     ovs_be16 vlan_tci;
3049     ovs_be64 tun_id;
3050 };
3051
3052 static void
3053 xlate_autopath(struct action_xlate_ctx *ctx,
3054                const struct nx_action_autopath *naa)
3055 {
3056     uint16_t ofp_port = ntohl(naa->id);
3057     struct ofport_dpif *port = get_ofp_port(ctx->ofproto, ofp_port);
3058
3059     if (!port || !port->bundle) {
3060         ofp_port = OFPP_NONE;
3061     } else if (port->bundle->bond) {
3062         /* Autopath does not support VLAN hashing. */
3063         struct ofport_dpif *slave = bond_choose_output_slave(
3064             port->bundle->bond, &ctx->flow, OFP_VLAN_NONE, &ctx->tags);
3065         if (slave) {
3066             ofp_port = slave->up.ofp_port;
3067         }
3068     }
3069     autopath_execute(naa, &ctx->flow, ofp_port);
3070 }
3071
3072 static bool
3073 slave_enabled_cb(uint16_t ofp_port, void *ofproto_)
3074 {
3075     struct ofproto_dpif *ofproto = ofproto_;
3076     struct ofport_dpif *port;
3077
3078     switch (ofp_port) {
3079     case OFPP_IN_PORT:
3080     case OFPP_TABLE:
3081     case OFPP_NORMAL:
3082     case OFPP_FLOOD:
3083     case OFPP_ALL:
3084     case OFPP_LOCAL:
3085         return true;
3086     case OFPP_CONTROLLER: /* Not supported by the bundle action. */
3087         return false;
3088     default:
3089         port = get_ofp_port(ofproto, ofp_port);
3090         return port ? port->may_enable : false;
3091     }
3092 }
3093
3094 static void
3095 do_xlate_actions(const union ofp_action *in, size_t n_in,
3096                  struct action_xlate_ctx *ctx)
3097 {
3098     const struct ofport_dpif *port;
3099     const union ofp_action *ia;
3100     size_t left;
3101
3102     port = get_ofp_port(ctx->ofproto, ctx->flow.in_port);
3103     if (port
3104         && port->up.opp.config & htonl(OFPPC_NO_RECV | OFPPC_NO_RECV_STP) &&
3105         port->up.opp.config & (eth_addr_equals(ctx->flow.dl_dst, eth_addr_stp)
3106                                ? htonl(OFPPC_NO_RECV_STP)
3107                                : htonl(OFPPC_NO_RECV))) {
3108         /* Drop this flow. */
3109         return;
3110     }
3111
3112     OFPUTIL_ACTION_FOR_EACH_UNSAFE (ia, left, in, n_in) {
3113         const struct ofp_action_dl_addr *oada;
3114         const struct nx_action_resubmit *nar;
3115         const struct nx_action_set_tunnel *nast;
3116         const struct nx_action_set_queue *nasq;
3117         const struct nx_action_multipath *nam;
3118         const struct nx_action_autopath *naa;
3119         const struct nx_action_bundle *nab;
3120         enum ofputil_action_code code;
3121         ovs_be64 tun_id;
3122
3123         code = ofputil_decode_action_unsafe(ia);
3124         switch (code) {
3125         case OFPUTIL_OFPAT_OUTPUT:
3126             xlate_output_action(ctx, &ia->output);
3127             break;
3128
3129         case OFPUTIL_OFPAT_SET_VLAN_VID:
3130             ctx->flow.vlan_tci &= ~htons(VLAN_VID_MASK);
3131             ctx->flow.vlan_tci |= ia->vlan_vid.vlan_vid | htons(VLAN_CFI);
3132             break;
3133
3134         case OFPUTIL_OFPAT_SET_VLAN_PCP:
3135             ctx->flow.vlan_tci &= ~htons(VLAN_PCP_MASK);
3136             ctx->flow.vlan_tci |= htons(
3137                 (ia->vlan_pcp.vlan_pcp << VLAN_PCP_SHIFT) | VLAN_CFI);
3138             break;
3139
3140         case OFPUTIL_OFPAT_STRIP_VLAN:
3141             ctx->flow.vlan_tci = htons(0);
3142             break;
3143
3144         case OFPUTIL_OFPAT_SET_DL_SRC:
3145             oada = ((struct ofp_action_dl_addr *) ia);
3146             memcpy(ctx->flow.dl_src, oada->dl_addr, ETH_ADDR_LEN);
3147             break;
3148
3149         case OFPUTIL_OFPAT_SET_DL_DST:
3150             oada = ((struct ofp_action_dl_addr *) ia);
3151             memcpy(ctx->flow.dl_dst, oada->dl_addr, ETH_ADDR_LEN);
3152             break;
3153
3154         case OFPUTIL_OFPAT_SET_NW_SRC:
3155             ctx->flow.nw_src = ia->nw_addr.nw_addr;
3156             break;
3157
3158         case OFPUTIL_OFPAT_SET_NW_DST:
3159             ctx->flow.nw_dst = ia->nw_addr.nw_addr;
3160             break;
3161
3162         case OFPUTIL_OFPAT_SET_NW_TOS:
3163             ctx->flow.nw_tos = ia->nw_tos.nw_tos & IP_DSCP_MASK;
3164             break;
3165
3166         case OFPUTIL_OFPAT_SET_TP_SRC:
3167             ctx->flow.tp_src = ia->tp_port.tp_port;
3168             break;
3169
3170         case OFPUTIL_OFPAT_SET_TP_DST:
3171             ctx->flow.tp_dst = ia->tp_port.tp_port;
3172             break;
3173
3174         case OFPUTIL_OFPAT_ENQUEUE:
3175             xlate_enqueue_action(ctx, (const struct ofp_action_enqueue *) ia);
3176             break;
3177
3178         case OFPUTIL_NXAST_RESUBMIT:
3179             nar = (const struct nx_action_resubmit *) ia;
3180             xlate_table_action(ctx, ntohs(nar->in_port));
3181             break;
3182
3183         case OFPUTIL_NXAST_SET_TUNNEL:
3184             nast = (const struct nx_action_set_tunnel *) ia;
3185             tun_id = htonll(ntohl(nast->tun_id));
3186             ctx->flow.tun_id = tun_id;
3187             break;
3188
3189         case OFPUTIL_NXAST_SET_QUEUE:
3190             nasq = (const struct nx_action_set_queue *) ia;
3191             xlate_set_queue_action(ctx, nasq);
3192             break;
3193
3194         case OFPUTIL_NXAST_POP_QUEUE:
3195             ctx->priority = 0;
3196             break;
3197
3198         case OFPUTIL_NXAST_REG_MOVE:
3199             nxm_execute_reg_move((const struct nx_action_reg_move *) ia,
3200                                  &ctx->flow);
3201             break;
3202
3203         case OFPUTIL_NXAST_REG_LOAD:
3204             nxm_execute_reg_load((const struct nx_action_reg_load *) ia,
3205                                  &ctx->flow);
3206             break;
3207
3208         case OFPUTIL_NXAST_NOTE:
3209             /* Nothing to do. */
3210             break;
3211
3212         case OFPUTIL_NXAST_SET_TUNNEL64:
3213             tun_id = ((const struct nx_action_set_tunnel64 *) ia)->tun_id;
3214             ctx->flow.tun_id = tun_id;
3215             break;
3216
3217         case OFPUTIL_NXAST_MULTIPATH:
3218             nam = (const struct nx_action_multipath *) ia;
3219             multipath_execute(nam, &ctx->flow);
3220             break;
3221
3222         case OFPUTIL_NXAST_AUTOPATH:
3223             naa = (const struct nx_action_autopath *) ia;
3224             xlate_autopath(ctx, naa);
3225             break;
3226
3227         case OFPUTIL_NXAST_BUNDLE:
3228             ctx->ofproto->has_bundle_action = true;
3229             nab = (const struct nx_action_bundle *) ia;
3230             xlate_output_action__(ctx, bundle_execute(nab, &ctx->flow,
3231                                                       slave_enabled_cb,
3232                                                       ctx->ofproto), 0);
3233             break;
3234
3235         case OFPUTIL_NXAST_BUNDLE_LOAD:
3236             ctx->ofproto->has_bundle_action = true;
3237             nab = (const struct nx_action_bundle *) ia;
3238             bundle_execute_load(nab, &ctx->flow, slave_enabled_cb,
3239                                 ctx->ofproto);
3240             break;
3241         }
3242     }
3243 }
3244
3245 static void
3246 action_xlate_ctx_init(struct action_xlate_ctx *ctx,
3247                       struct ofproto_dpif *ofproto, const struct flow *flow,
3248                       const struct ofpbuf *packet)
3249 {
3250     ctx->ofproto = ofproto;
3251     ctx->flow = *flow;
3252     ctx->packet = packet;
3253     ctx->resubmit_hook = NULL;
3254 }
3255
3256 static struct ofpbuf *
3257 xlate_actions(struct action_xlate_ctx *ctx,
3258               const union ofp_action *in, size_t n_in)
3259 {
3260     COVERAGE_INC(ofproto_dpif_xlate);
3261
3262     ctx->odp_actions = ofpbuf_new(512);
3263     ctx->tags = 0;
3264     ctx->may_set_up_flow = true;
3265     ctx->nf_output_iface = NF_OUT_DROP;
3266     ctx->recurse = 0;
3267     ctx->priority = 0;
3268     ctx->base_priority = 0;
3269     ctx->base_flow = ctx->flow;
3270
3271     if (process_special(ctx->ofproto, &ctx->flow, ctx->packet)) {
3272         ctx->may_set_up_flow = false;
3273     } else {
3274         do_xlate_actions(in, n_in, ctx);
3275     }
3276
3277     /* Check with in-band control to see if we're allowed to set up this
3278      * flow. */
3279     if (!connmgr_may_set_up_flow(ctx->ofproto->up.connmgr, &ctx->flow,
3280                                  ctx->odp_actions->data,
3281                                  ctx->odp_actions->size)) {
3282         ctx->may_set_up_flow = false;
3283     }
3284
3285     return ctx->odp_actions;
3286 }
3287 \f
3288 /* OFPP_NORMAL implementation. */
3289
3290 struct dst {
3291     struct ofport_dpif *port;
3292     uint16_t vlan;
3293 };
3294
3295 struct dst_set {
3296     struct dst builtin[32];
3297     struct dst *dsts;
3298     size_t n, allocated;
3299 };
3300
3301 static void dst_set_init(struct dst_set *);
3302 static void dst_set_add(struct dst_set *, const struct dst *);
3303 static void dst_set_free(struct dst_set *);
3304
3305 static struct ofport_dpif *ofbundle_get_a_port(const struct ofbundle *);
3306
3307 static bool
3308 set_dst(struct action_xlate_ctx *ctx, struct dst *dst,
3309         const struct ofbundle *in_bundle, const struct ofbundle *out_bundle)
3310 {
3311     dst->vlan = (out_bundle->vlan >= 0 ? OFP_VLAN_NONE
3312                  : in_bundle->vlan >= 0 ? in_bundle->vlan
3313                  : ctx->flow.vlan_tci == 0 ? OFP_VLAN_NONE
3314                  : vlan_tci_to_vid(ctx->flow.vlan_tci));
3315
3316     dst->port = (!out_bundle->bond
3317                  ? ofbundle_get_a_port(out_bundle)
3318                  : bond_choose_output_slave(out_bundle->bond, &ctx->flow,
3319                                             dst->vlan, &ctx->tags));
3320
3321     return dst->port != NULL;
3322 }
3323
3324 static int
3325 mirror_mask_ffs(mirror_mask_t mask)
3326 {
3327     BUILD_ASSERT_DECL(sizeof(unsigned int) >= sizeof(mask));
3328     return ffs(mask);
3329 }
3330
3331 static void
3332 dst_set_init(struct dst_set *set)
3333 {
3334     set->dsts = set->builtin;
3335     set->n = 0;
3336     set->allocated = ARRAY_SIZE(set->builtin);
3337 }
3338
3339 static void
3340 dst_set_add(struct dst_set *set, const struct dst *dst)
3341 {
3342     if (set->n >= set->allocated) {
3343         size_t new_allocated;
3344         struct dst *new_dsts;
3345
3346         new_allocated = set->allocated * 2;
3347         new_dsts = xmalloc(new_allocated * sizeof *new_dsts);
3348         memcpy(new_dsts, set->dsts, set->n * sizeof *new_dsts);
3349
3350         dst_set_free(set);
3351
3352         set->dsts = new_dsts;
3353         set->allocated = new_allocated;
3354     }
3355     set->dsts[set->n++] = *dst;
3356 }
3357
3358 static void
3359 dst_set_free(struct dst_set *set)
3360 {
3361     if (set->dsts != set->builtin) {
3362         free(set->dsts);
3363     }
3364 }
3365
3366 static bool
3367 dst_is_duplicate(const struct dst_set *set, const struct dst *test)
3368 {
3369     size_t i;
3370     for (i = 0; i < set->n; i++) {
3371         if (set->dsts[i].vlan == test->vlan
3372             && set->dsts[i].port == test->port) {
3373             return true;
3374         }
3375     }
3376     return false;
3377 }
3378
3379 static bool
3380 ofbundle_trunks_vlan(const struct ofbundle *bundle, uint16_t vlan)
3381 {
3382     return (bundle->vlan < 0
3383             && (!bundle->trunks || bitmap_is_set(bundle->trunks, vlan)));
3384 }
3385
3386 static bool
3387 ofbundle_includes_vlan(const struct ofbundle *bundle, uint16_t vlan)
3388 {
3389     return vlan == bundle->vlan || ofbundle_trunks_vlan(bundle, vlan);
3390 }
3391
3392 /* Returns an arbitrary interface within 'bundle'. */
3393 static struct ofport_dpif *
3394 ofbundle_get_a_port(const struct ofbundle *bundle)
3395 {
3396     return CONTAINER_OF(list_front(&bundle->ports),
3397                         struct ofport_dpif, bundle_node);
3398 }
3399
3400 static void
3401 compose_dsts(struct action_xlate_ctx *ctx, uint16_t vlan,
3402              const struct ofbundle *in_bundle,
3403              const struct ofbundle *out_bundle, struct dst_set *set)
3404 {
3405     struct dst dst;
3406
3407     if (out_bundle == OFBUNDLE_FLOOD) {
3408         struct ofbundle *bundle;
3409
3410         HMAP_FOR_EACH (bundle, hmap_node, &ctx->ofproto->bundles) {
3411             if (bundle != in_bundle
3412                 && ofbundle_includes_vlan(bundle, vlan)
3413                 && bundle->floodable
3414                 && !bundle->mirror_out
3415                 && set_dst(ctx, &dst, in_bundle, bundle)) {
3416                 dst_set_add(set, &dst);
3417             }
3418         }
3419         ctx->nf_output_iface = NF_OUT_FLOOD;
3420     } else if (out_bundle && set_dst(ctx, &dst, in_bundle, out_bundle)) {
3421         dst_set_add(set, &dst);
3422         ctx->nf_output_iface = dst.port->odp_port;
3423     }
3424 }
3425
3426 static bool
3427 vlan_is_mirrored(const struct ofmirror *m, int vlan)
3428 {
3429     return !m->vlans || bitmap_is_set(m->vlans, vlan);
3430 }
3431
3432 /* Returns true if a packet with Ethernet destination MAC 'dst' may be mirrored
3433  * to a VLAN.  In general most packets may be mirrored but we want to drop
3434  * protocols that may confuse switches. */
3435 static bool
3436 eth_dst_may_rspan(const uint8_t dst[ETH_ADDR_LEN])
3437 {
3438     /* If you change this function's behavior, please update corresponding
3439      * documentation in vswitch.xml at the same time. */
3440     if (dst[0] != 0x01) {
3441         /* All the currently banned MACs happen to start with 01 currently, so
3442          * this is a quick way to eliminate most of the good ones. */
3443     } else {
3444         if (eth_addr_is_reserved(dst)) {
3445             /* Drop STP, IEEE pause frames, and other reserved protocols
3446              * (01-80-c2-00-00-0x). */
3447             return false;
3448         }
3449
3450         if (dst[0] == 0x01 && dst[1] == 0x00 && dst[2] == 0x0c) {
3451             /* Cisco OUI. */
3452             if ((dst[3] & 0xfe) == 0xcc &&
3453                 (dst[4] & 0xfe) == 0xcc &&
3454                 (dst[5] & 0xfe) == 0xcc) {
3455                 /* Drop the following protocols plus others following the same
3456                    pattern:
3457
3458                    CDP, VTP, DTP, PAgP  (01-00-0c-cc-cc-cc)
3459                    Spanning Tree PVSTP+ (01-00-0c-cc-cc-cd)
3460                    STP Uplink Fast      (01-00-0c-cd-cd-cd) */
3461                 return false;
3462             }
3463
3464             if (!(dst[3] | dst[4] | dst[5])) {
3465                 /* Drop Inter Switch Link packets (01-00-0c-00-00-00). */
3466                 return false;
3467             }
3468         }
3469     }
3470     return true;
3471 }
3472
3473 static void
3474 compose_mirror_dsts(struct action_xlate_ctx *ctx,
3475                     uint16_t vlan, const struct ofbundle *in_bundle,
3476                     struct dst_set *set)
3477 {
3478     struct ofproto_dpif *ofproto = ctx->ofproto;
3479     mirror_mask_t mirrors;
3480     int flow_vlan;
3481     size_t i;
3482
3483     mirrors = in_bundle->src_mirrors;
3484     for (i = 0; i < set->n; i++) {
3485         mirrors |= set->dsts[i].port->bundle->dst_mirrors;
3486     }
3487
3488     if (!mirrors) {
3489         return;
3490     }
3491
3492     flow_vlan = vlan_tci_to_vid(ctx->flow.vlan_tci);
3493     if (flow_vlan == 0) {
3494         flow_vlan = OFP_VLAN_NONE;
3495     }
3496
3497     while (mirrors) {
3498         struct ofmirror *m = ofproto->mirrors[mirror_mask_ffs(mirrors) - 1];
3499         if (vlan_is_mirrored(m, vlan)) {
3500             struct dst dst;
3501
3502             if (m->out) {
3503                 if (set_dst(ctx, &dst, in_bundle, m->out)
3504                     && !dst_is_duplicate(set, &dst)) {
3505                     dst_set_add(set, &dst);
3506                 }
3507             } else if (eth_dst_may_rspan(ctx->flow.dl_dst)) {
3508                 struct ofbundle *bundle;
3509
3510                 HMAP_FOR_EACH (bundle, hmap_node, &ofproto->bundles) {
3511                     if (ofbundle_includes_vlan(bundle, m->out_vlan)
3512                         && set_dst(ctx, &dst, in_bundle, bundle))
3513                     {
3514                         if (bundle->vlan < 0) {
3515                             dst.vlan = m->out_vlan;
3516                         }
3517                         if (dst_is_duplicate(set, &dst)) {
3518                             continue;
3519                         }
3520
3521                         /* Use the vlan tag on the original flow instead of
3522                          * the one passed in the vlan parameter.  This ensures
3523                          * that we compare the vlan from before any implicit
3524                          * tagging tags place. This is necessary because
3525                          * dst->vlan is the final vlan, after removing implicit
3526                          * tags. */
3527                         if (bundle == in_bundle && dst.vlan == flow_vlan) {
3528                             /* Don't send out input port on same VLAN. */
3529                             continue;
3530                         }
3531                         dst_set_add(set, &dst);
3532                     }
3533                 }
3534             }
3535         }
3536         mirrors &= mirrors - 1;
3537     }
3538 }
3539
3540 static void
3541 compose_actions(struct action_xlate_ctx *ctx, uint16_t vlan,
3542                 const struct ofbundle *in_bundle,
3543                 const struct ofbundle *out_bundle)
3544 {
3545     uint16_t initial_vlan, cur_vlan;
3546     const struct dst *dst;
3547     struct dst_set set;
3548
3549     dst_set_init(&set);
3550     compose_dsts(ctx, vlan, in_bundle, out_bundle, &set);
3551     compose_mirror_dsts(ctx, vlan, in_bundle, &set);
3552
3553     /* Output all the packets we can without having to change the VLAN. */
3554     initial_vlan = vlan_tci_to_vid(ctx->flow.vlan_tci);
3555     if (initial_vlan == 0) {
3556         initial_vlan = OFP_VLAN_NONE;
3557     }
3558     for (dst = set.dsts; dst < &set.dsts[set.n]; dst++) {
3559         if (dst->vlan != initial_vlan) {
3560             continue;
3561         }
3562         nl_msg_put_u32(ctx->odp_actions,
3563                        ODP_ACTION_ATTR_OUTPUT, dst->port->odp_port);
3564     }
3565
3566     /* Then output the rest. */
3567     cur_vlan = initial_vlan;
3568     for (dst = set.dsts; dst < &set.dsts[set.n]; dst++) {
3569         if (dst->vlan == initial_vlan) {
3570             continue;
3571         }
3572         if (dst->vlan != cur_vlan) {
3573             if (dst->vlan == OFP_VLAN_NONE) {
3574                 nl_msg_put_flag(ctx->odp_actions, ODP_ACTION_ATTR_STRIP_VLAN);
3575             } else {
3576                 ovs_be16 tci;
3577                 tci = htons(dst->vlan & VLAN_VID_MASK);
3578                 tci |= ctx->flow.vlan_tci & htons(VLAN_PCP_MASK);
3579                 nl_msg_put_be16(ctx->odp_actions,
3580                                 ODP_ACTION_ATTR_SET_DL_TCI, tci);
3581             }
3582             cur_vlan = dst->vlan;
3583         }
3584         nl_msg_put_u32(ctx->odp_actions,
3585                        ODP_ACTION_ATTR_OUTPUT, dst->port->odp_port);
3586     }
3587
3588     dst_set_free(&set);
3589 }
3590
3591 /* Returns the effective vlan of a packet, taking into account both the
3592  * 802.1Q header and implicitly tagged ports.  A value of 0 indicates that
3593  * the packet is untagged and -1 indicates it has an invalid header and
3594  * should be dropped. */
3595 static int
3596 flow_get_vlan(struct ofproto_dpif *ofproto, const struct flow *flow,
3597               struct ofbundle *in_bundle, bool have_packet)
3598 {
3599     int vlan = vlan_tci_to_vid(flow->vlan_tci);
3600     if (in_bundle->vlan >= 0) {
3601         if (vlan) {
3602             if (have_packet) {
3603                 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
3604                 VLOG_WARN_RL(&rl, "bridge %s: dropping VLAN %d tagged "
3605                              "packet received on port %s configured with "
3606                              "implicit VLAN %"PRIu16,
3607                              ofproto->up.name, vlan,
3608                              in_bundle->name, in_bundle->vlan);
3609             }
3610             return -1;
3611         }
3612         vlan = in_bundle->vlan;
3613     } else {
3614         if (!ofbundle_includes_vlan(in_bundle, vlan)) {
3615             if (have_packet) {
3616                 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
3617                 VLOG_WARN_RL(&rl, "bridge %s: dropping VLAN %d tagged "
3618                              "packet received on port %s not configured for "
3619                              "trunking VLAN %d",
3620                              ofproto->up.name, vlan, in_bundle->name, vlan);
3621             }
3622             return -1;
3623         }
3624     }
3625
3626     return vlan;
3627 }
3628
3629 /* A VM broadcasts a gratuitous ARP to indicate that it has resumed after
3630  * migration.  Older Citrix-patched Linux DomU used gratuitous ARP replies to
3631  * indicate this; newer upstream kernels use gratuitous ARP requests. */
3632 static bool
3633 is_gratuitous_arp(const struct flow *flow)
3634 {
3635     return (flow->dl_type == htons(ETH_TYPE_ARP)
3636             && eth_addr_is_broadcast(flow->dl_dst)
3637             && (flow->nw_proto == ARP_OP_REPLY
3638                 || (flow->nw_proto == ARP_OP_REQUEST
3639                     && flow->nw_src == flow->nw_dst)));
3640 }
3641
3642 static void
3643 update_learning_table(struct ofproto_dpif *ofproto,
3644                       const struct flow *flow, int vlan,
3645                       struct ofbundle *in_bundle)
3646 {
3647     struct mac_entry *mac;
3648
3649     if (!mac_learning_may_learn(ofproto->ml, flow->dl_src, vlan)) {
3650         return;
3651     }
3652
3653     mac = mac_learning_insert(ofproto->ml, flow->dl_src, vlan);
3654     if (is_gratuitous_arp(flow)) {
3655         /* We don't want to learn from gratuitous ARP packets that are
3656          * reflected back over bond slaves so we lock the learning table. */
3657         if (!in_bundle->bond) {
3658             mac_entry_set_grat_arp_lock(mac);
3659         } else if (mac_entry_is_grat_arp_locked(mac)) {
3660             return;
3661         }
3662     }
3663
3664     if (mac_entry_is_new(mac) || mac->port.p != in_bundle) {
3665         /* The log messages here could actually be useful in debugging,
3666          * so keep the rate limit relatively high. */
3667         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(30, 300);
3668         VLOG_DBG_RL(&rl, "bridge %s: learned that "ETH_ADDR_FMT" is "
3669                     "on port %s in VLAN %d",
3670                     ofproto->up.name, ETH_ADDR_ARGS(flow->dl_src),
3671                     in_bundle->name, vlan);
3672
3673         mac->port.p = in_bundle;
3674         tag_set_add(&ofproto->revalidate_set,
3675                     mac_learning_changed(ofproto->ml, mac));
3676     }
3677 }
3678
3679 /* Determines whether packets in 'flow' within 'br' should be forwarded or
3680  * dropped.  Returns true if they may be forwarded, false if they should be
3681  * dropped.
3682  *
3683  * If 'have_packet' is true, it indicates that the caller is processing a
3684  * received packet.  If 'have_packet' is false, then the caller is just
3685  * revalidating an existing flow because configuration has changed.  Either
3686  * way, 'have_packet' only affects logging (there is no point in logging errors
3687  * during revalidation).
3688  *
3689  * Sets '*in_portp' to the input port.  This will be a null pointer if
3690  * flow->in_port does not designate a known input port (in which case
3691  * is_admissible() returns false).
3692  *
3693  * When returning true, sets '*vlanp' to the effective VLAN of the input
3694  * packet, as returned by flow_get_vlan().
3695  *
3696  * May also add tags to '*tags', although the current implementation only does
3697  * so in one special case.
3698  */
3699 static bool
3700 is_admissible(struct ofproto_dpif *ofproto, const struct flow *flow,
3701               bool have_packet,
3702               tag_type *tags, int *vlanp, struct ofbundle **in_bundlep)
3703 {
3704     struct ofport_dpif *in_port;
3705     struct ofbundle *in_bundle;
3706     int vlan;
3707
3708     /* Find the port and bundle for the received packet. */
3709     in_port = get_ofp_port(ofproto, flow->in_port);
3710     *in_bundlep = in_bundle = in_port ? in_port->bundle : NULL;
3711     if (!in_port || !in_bundle) {
3712         /* No interface?  Something fishy... */
3713         if (have_packet) {
3714             /* Odd.  A few possible reasons here:
3715              *
3716              * - We deleted a port but there are still a few packets queued up
3717              *   from it.
3718              *
3719              * - Someone externally added a port (e.g. "ovs-dpctl add-if") that
3720              *   we don't know about.
3721              *
3722              * - Packet arrived on the local port but the local port is not
3723              *   part of a bundle.
3724              */
3725             static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
3726
3727             VLOG_WARN_RL(&rl, "bridge %s: received packet on unknown "
3728                          "port %"PRIu16,
3729                          ofproto->up.name, flow->in_port);
3730         }
3731         return false;
3732     }
3733     *vlanp = vlan = flow_get_vlan(ofproto, flow, in_bundle, have_packet);
3734     if (vlan < 0) {
3735         return false;
3736     }
3737
3738     /* Drop frames for reserved multicast addresses. */
3739     if (eth_addr_is_reserved(flow->dl_dst)) {
3740         return false;
3741     }
3742
3743     /* Drop frames on bundles reserved for mirroring. */
3744     if (in_bundle->mirror_out) {
3745         if (have_packet) {
3746             static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
3747             VLOG_WARN_RL(&rl, "bridge %s: dropping packet received on port "
3748                          "%s, which is reserved exclusively for mirroring",
3749                          ofproto->up.name, in_bundle->name);
3750         }
3751         return false;
3752     }
3753
3754     if (in_bundle->bond) {
3755         struct mac_entry *mac;
3756
3757         switch (bond_check_admissibility(in_bundle->bond, in_port,
3758                                          flow->dl_dst, tags)) {
3759         case BV_ACCEPT:
3760             break;
3761
3762         case BV_DROP:
3763             return false;
3764
3765         case BV_DROP_IF_MOVED:
3766             mac = mac_learning_lookup(ofproto->ml, flow->dl_src, vlan, NULL);
3767             if (mac && mac->port.p != in_bundle &&
3768                 (!is_gratuitous_arp(flow)
3769                  || mac_entry_is_grat_arp_locked(mac))) {
3770                 return false;
3771             }
3772             break;
3773         }
3774     }
3775
3776     return true;
3777 }
3778
3779 static void
3780 xlate_normal(struct action_xlate_ctx *ctx)
3781 {
3782     struct ofbundle *in_bundle;
3783     struct ofbundle *out_bundle;
3784     struct mac_entry *mac;
3785     int vlan;
3786
3787     /* Check whether we should drop packets in this flow. */
3788     if (!is_admissible(ctx->ofproto, &ctx->flow, ctx->packet != NULL,
3789                        &ctx->tags, &vlan, &in_bundle)) {
3790         out_bundle = NULL;
3791         goto done;
3792     }
3793
3794     /* Learn source MAC (but don't try to learn from revalidation). */
3795     if (ctx->packet) {
3796         update_learning_table(ctx->ofproto, &ctx->flow, vlan, in_bundle);
3797     }
3798
3799     /* Determine output bundle. */
3800     mac = mac_learning_lookup(ctx->ofproto->ml, ctx->flow.dl_dst, vlan,
3801                               &ctx->tags);
3802     if (mac) {
3803         out_bundle = mac->port.p;
3804     } else if (!ctx->packet && !eth_addr_is_multicast(ctx->flow.dl_dst)) {
3805         /* If we are revalidating but don't have a learning entry then eject
3806          * the flow.  Installing a flow that floods packets opens up a window
3807          * of time where we could learn from a packet reflected on a bond and
3808          * blackhole packets before the learning table is updated to reflect
3809          * the correct port. */
3810         ctx->may_set_up_flow = false;
3811         return;
3812     } else {
3813         out_bundle = OFBUNDLE_FLOOD;
3814     }
3815
3816     /* Don't send packets out their input bundles. */
3817     if (in_bundle == out_bundle) {
3818         out_bundle = NULL;
3819     }
3820
3821 done:
3822     if (in_bundle) {
3823         compose_actions(ctx, vlan, in_bundle, out_bundle);
3824     }
3825 }
3826 \f
3827 static bool
3828 get_drop_frags(struct ofproto *ofproto_)
3829 {
3830     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
3831     bool drop_frags;
3832
3833     dpif_get_drop_frags(ofproto->dpif, &drop_frags);
3834     return drop_frags;
3835 }
3836
3837 static void
3838 set_drop_frags(struct ofproto *ofproto_, bool drop_frags)
3839 {
3840     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
3841
3842     dpif_set_drop_frags(ofproto->dpif, drop_frags);
3843 }
3844
3845 static int
3846 packet_out(struct ofproto *ofproto_, struct ofpbuf *packet,
3847            const struct flow *flow,
3848            const union ofp_action *ofp_actions, size_t n_ofp_actions)
3849 {
3850     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
3851     int error;
3852
3853     error = validate_actions(ofp_actions, n_ofp_actions, flow,
3854                              ofproto->max_ports);
3855     if (!error) {
3856         struct odputil_keybuf keybuf;
3857         struct action_xlate_ctx ctx;
3858         struct ofpbuf *odp_actions;
3859         struct ofpbuf key;
3860
3861         ofpbuf_use_stack(&key, &keybuf, sizeof keybuf);
3862         odp_flow_key_from_flow(&key, flow);
3863
3864         action_xlate_ctx_init(&ctx, ofproto, flow, packet);
3865         odp_actions = xlate_actions(&ctx, ofp_actions, n_ofp_actions);
3866         dpif_execute(ofproto->dpif, key.data, key.size,
3867                      odp_actions->data, odp_actions->size, packet);
3868         ofpbuf_delete(odp_actions);
3869     }
3870     return error;
3871 }
3872
3873 static void
3874 get_netflow_ids(const struct ofproto *ofproto_,
3875                 uint8_t *engine_type, uint8_t *engine_id)
3876 {
3877     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
3878
3879     dpif_get_netflow_ids(ofproto->dpif, engine_type, engine_id);
3880 }
3881 \f
3882 static struct ofproto_dpif *
3883 ofproto_dpif_lookup(const char *name)
3884 {
3885     struct ofproto *ofproto = ofproto_lookup(name);
3886     return (ofproto && ofproto->ofproto_class == &ofproto_dpif_class
3887             ? ofproto_dpif_cast(ofproto)
3888             : NULL);
3889 }
3890
3891 static void
3892 ofproto_unixctl_fdb_show(struct unixctl_conn *conn,
3893                          const char *args, void *aux OVS_UNUSED)
3894 {
3895     struct ds ds = DS_EMPTY_INITIALIZER;
3896     const struct ofproto_dpif *ofproto;
3897     const struct mac_entry *e;
3898
3899     ofproto = ofproto_dpif_lookup(args);
3900     if (!ofproto) {
3901         unixctl_command_reply(conn, 501, "no such bridge");
3902         return;
3903     }
3904
3905     ds_put_cstr(&ds, " port  VLAN  MAC                Age\n");
3906     LIST_FOR_EACH (e, lru_node, &ofproto->ml->lrus) {
3907         struct ofbundle *bundle = e->port.p;
3908         ds_put_format(&ds, "%5d  %4d  "ETH_ADDR_FMT"  %3d\n",
3909                       ofbundle_get_a_port(bundle)->odp_port,
3910                       e->vlan, ETH_ADDR_ARGS(e->mac), mac_entry_age(e));
3911     }
3912     unixctl_command_reply(conn, 200, ds_cstr(&ds));
3913     ds_destroy(&ds);
3914 }
3915
3916 struct ofproto_trace {
3917     struct action_xlate_ctx ctx;
3918     struct flow flow;
3919     struct ds *result;
3920 };
3921
3922 static void
3923 trace_format_rule(struct ds *result, int level, const struct rule *rule)
3924 {
3925     ds_put_char_multiple(result, '\t', level);
3926     if (!rule) {
3927         ds_put_cstr(result, "No match\n");
3928         return;
3929     }
3930
3931     ds_put_format(result, "Rule: cookie=%#"PRIx64" ",
3932                   ntohll(rule->flow_cookie));
3933     cls_rule_format(&rule->cr, result);
3934     ds_put_char(result, '\n');
3935
3936     ds_put_char_multiple(result, '\t', level);
3937     ds_put_cstr(result, "OpenFlow ");
3938     ofp_print_actions(result, rule->actions, rule->n_actions);
3939     ds_put_char(result, '\n');
3940 }
3941
3942 static void
3943 trace_format_flow(struct ds *result, int level, const char *title,
3944                  struct ofproto_trace *trace)
3945 {
3946     ds_put_char_multiple(result, '\t', level);
3947     ds_put_format(result, "%s: ", title);
3948     if (flow_equal(&trace->ctx.flow, &trace->flow)) {
3949         ds_put_cstr(result, "unchanged");
3950     } else {
3951         flow_format(result, &trace->ctx.flow);
3952         trace->flow = trace->ctx.flow;
3953     }
3954     ds_put_char(result, '\n');
3955 }
3956
3957 static void
3958 trace_resubmit(struct action_xlate_ctx *ctx, struct rule_dpif *rule)
3959 {
3960     struct ofproto_trace *trace = CONTAINER_OF(ctx, struct ofproto_trace, ctx);
3961     struct ds *result = trace->result;
3962
3963     ds_put_char(result, '\n');
3964     trace_format_flow(result, ctx->recurse + 1, "Resubmitted flow", trace);
3965     trace_format_rule(result, ctx->recurse + 1, &rule->up);
3966 }
3967
3968 static void
3969 ofproto_unixctl_trace(struct unixctl_conn *conn, const char *args_,
3970                       void *aux OVS_UNUSED)
3971 {
3972     char *dpname, *arg1, *arg2, *arg3;
3973     char *args = xstrdup(args_);
3974     char *save_ptr = NULL;
3975     struct ofproto_dpif *ofproto;
3976     struct ofpbuf odp_key;
3977     struct ofpbuf *packet;
3978     struct rule_dpif *rule;
3979     struct ds result;
3980     struct flow flow;
3981     char *s;
3982
3983     packet = NULL;
3984     ofpbuf_init(&odp_key, 0);
3985     ds_init(&result);
3986
3987     dpname = strtok_r(args, " ", &save_ptr);
3988     arg1 = strtok_r(NULL, " ", &save_ptr);
3989     arg2 = strtok_r(NULL, " ", &save_ptr);
3990     arg3 = strtok_r(NULL, "", &save_ptr); /* Get entire rest of line. */
3991     if (dpname && arg1 && !arg2 && !arg3) {
3992         /* ofproto/trace dpname flow */
3993         int error;
3994
3995         /* Convert string to ODP key. */
3996         ofpbuf_init(&odp_key, 0);
3997         error = odp_flow_key_from_string(arg1, &odp_key);
3998         if (error) {
3999             unixctl_command_reply(conn, 501, "Bad flow syntax");
4000             goto exit;
4001         }
4002
4003         /* Convert odp_key to flow. */
4004         error = odp_flow_key_to_flow(odp_key.data, odp_key.size, &flow);
4005         if (error) {
4006             unixctl_command_reply(conn, 501, "Invalid flow");
4007             goto exit;
4008         }
4009     } else if (dpname && arg1 && arg2 && arg3) {
4010         /* ofproto/trace dpname tun_id in_port packet */
4011         uint16_t in_port;
4012         ovs_be64 tun_id;
4013
4014         tun_id = htonll(strtoull(arg1, NULL, 0));
4015         in_port = ofp_port_to_odp_port(atoi(arg2));
4016
4017         packet = ofpbuf_new(strlen(args) / 2);
4018         arg3 = ofpbuf_put_hex(packet, arg3, NULL);
4019         arg3 += strspn(arg3, " ");
4020         if (*arg3 != '\0') {
4021             unixctl_command_reply(conn, 501, "Trailing garbage in command");
4022             goto exit;
4023         }
4024         if (packet->size < ETH_HEADER_LEN) {
4025             unixctl_command_reply(conn, 501,
4026                                   "Packet data too short for Ethernet");
4027             goto exit;
4028         }
4029
4030         ds_put_cstr(&result, "Packet: ");
4031         s = ofp_packet_to_string(packet->data, packet->size, packet->size);
4032         ds_put_cstr(&result, s);
4033         free(s);
4034
4035         flow_extract(packet, tun_id, in_port, &flow);
4036     } else {
4037         unixctl_command_reply(conn, 501, "Bad command syntax");
4038         goto exit;
4039     }
4040
4041     ofproto = ofproto_dpif_lookup(dpname);
4042     if (!ofproto) {
4043         unixctl_command_reply(conn, 501, "Unknown ofproto (use ofproto/list "
4044                               "for help)");
4045         goto exit;
4046     }
4047
4048     ds_put_cstr(&result, "Flow: ");
4049     flow_format(&result, &flow);
4050     ds_put_char(&result, '\n');
4051
4052     rule = rule_dpif_lookup(ofproto, &flow);
4053     trace_format_rule(&result, 0, &rule->up);
4054     if (rule) {
4055         struct ofproto_trace trace;
4056         struct ofpbuf *odp_actions;
4057
4058         trace.result = &result;
4059         trace.flow = flow;
4060         action_xlate_ctx_init(&trace.ctx, ofproto, &flow, packet);
4061         trace.ctx.resubmit_hook = trace_resubmit;
4062         odp_actions = xlate_actions(&trace.ctx,
4063                                     rule->up.actions, rule->up.n_actions);
4064
4065         ds_put_char(&result, '\n');
4066         trace_format_flow(&result, 0, "Final flow", &trace);
4067         ds_put_cstr(&result, "Datapath actions: ");
4068         format_odp_actions(&result, odp_actions->data, odp_actions->size);
4069         ofpbuf_delete(odp_actions);
4070
4071         if (!trace.ctx.may_set_up_flow) {
4072             if (packet) {
4073                 ds_put_cstr(&result, "\nThis flow is not cachable.");
4074             } else {
4075                 ds_put_cstr(&result, "\nThe datapath actions are incomplete--"
4076                             "for complete actions, please supply a packet.");
4077             }
4078         }
4079     }
4080
4081     unixctl_command_reply(conn, 200, ds_cstr(&result));
4082
4083 exit:
4084     ds_destroy(&result);
4085     ofpbuf_delete(packet);
4086     ofpbuf_uninit(&odp_key);
4087     free(args);
4088 }
4089
4090 static void
4091 ofproto_dpif_clog(struct unixctl_conn *conn OVS_UNUSED,
4092                   const char *args_ OVS_UNUSED, void *aux OVS_UNUSED)
4093 {
4094     clogged = true;
4095     unixctl_command_reply(conn, 200, NULL);
4096 }
4097
4098 static void
4099 ofproto_dpif_unclog(struct unixctl_conn *conn OVS_UNUSED,
4100                     const char *args_ OVS_UNUSED, void *aux OVS_UNUSED)
4101 {
4102     clogged = false;
4103     unixctl_command_reply(conn, 200, NULL);
4104 }
4105
4106 static void
4107 ofproto_dpif_unixctl_init(void)
4108 {
4109     static bool registered;
4110     if (registered) {
4111         return;
4112     }
4113     registered = true;
4114
4115     unixctl_command_register("ofproto/trace", ofproto_unixctl_trace, NULL);
4116     unixctl_command_register("fdb/show", ofproto_unixctl_fdb_show, NULL);
4117
4118     unixctl_command_register("ofproto/clog", ofproto_dpif_clog, NULL);
4119     unixctl_command_register("ofproto/unclog", ofproto_dpif_unclog, NULL);
4120 }
4121 \f
4122 const struct ofproto_class ofproto_dpif_class = {
4123     enumerate_types,
4124     enumerate_names,
4125     del,
4126     alloc,
4127     construct,
4128     destruct,
4129     dealloc,
4130     run,
4131     wait,
4132     flush,
4133     get_features,
4134     get_tables,
4135     port_alloc,
4136     port_construct,
4137     port_destruct,
4138     port_dealloc,
4139     port_modified,
4140     port_reconfigured,
4141     port_query_by_name,
4142     port_add,
4143     port_del,
4144     port_dump_start,
4145     port_dump_next,
4146     port_dump_done,
4147     port_poll,
4148     port_poll_wait,
4149     port_is_lacp_current,
4150     NULL,                       /* rule_choose_table */
4151     rule_alloc,
4152     rule_construct,
4153     rule_destruct,
4154     rule_dealloc,
4155     rule_get_stats,
4156     rule_execute,
4157     rule_modify_actions,
4158     get_drop_frags,
4159     set_drop_frags,
4160     packet_out,
4161     set_netflow,
4162     get_netflow_ids,
4163     set_sflow,
4164     set_cfm,
4165     get_cfm_fault,
4166     bundle_set,
4167     bundle_remove,
4168     mirror_set,
4169     set_flood_vlans,
4170     is_mirror_output_bundle,
4171 };