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
1397 static void
1398 forward_bpdu_changed(struct ofproto *ofproto_)
1399 {
1400     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
1401     /* Revalidate cached flows whenever forward_bpdu option changes. */
1402     ofproto->need_revalidate = true;
1403 }
1404 \f
1405 /* Ports. */
1406
1407 static struct ofport_dpif *
1408 get_ofp_port(struct ofproto_dpif *ofproto, uint16_t ofp_port)
1409 {
1410     struct ofport *ofport = ofproto_get_port(&ofproto->up, ofp_port);
1411     return ofport ? ofport_dpif_cast(ofport) : NULL;
1412 }
1413
1414 static struct ofport_dpif *
1415 get_odp_port(struct ofproto_dpif *ofproto, uint32_t odp_port)
1416 {
1417     return get_ofp_port(ofproto, odp_port_to_ofp_port(odp_port));
1418 }
1419
1420 static void
1421 ofproto_port_from_dpif_port(struct ofproto_port *ofproto_port,
1422                             struct dpif_port *dpif_port)
1423 {
1424     ofproto_port->name = dpif_port->name;
1425     ofproto_port->type = dpif_port->type;
1426     ofproto_port->ofp_port = odp_port_to_ofp_port(dpif_port->port_no);
1427 }
1428
1429 static void
1430 port_run(struct ofport_dpif *ofport)
1431 {
1432     bool enable = netdev_get_carrier(ofport->up.netdev);
1433
1434     if (ofport->cfm) {
1435         cfm_run(ofport->cfm);
1436
1437         if (cfm_should_send_ccm(ofport->cfm)) {
1438             struct ofpbuf packet;
1439
1440             ofpbuf_init(&packet, 0);
1441             cfm_compose_ccm(ofport->cfm, &packet, ofport->up.opp.hw_addr);
1442             send_packet(ofproto_dpif_cast(ofport->up.ofproto),
1443                         ofport->odp_port, &packet);
1444             ofpbuf_uninit(&packet);
1445         }
1446
1447         enable = enable && !cfm_get_fault(ofport->cfm);
1448     }
1449
1450     if (ofport->bundle) {
1451         enable = enable && lacp_slave_may_enable(ofport->bundle->lacp, ofport);
1452     }
1453
1454     if (ofport->may_enable != enable) {
1455         struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofport->up.ofproto);
1456
1457         if (ofproto->has_bundle_action) {
1458             ofproto->need_revalidate = true;
1459         }
1460     }
1461
1462     ofport->may_enable = enable;
1463 }
1464
1465 static void
1466 port_wait(struct ofport_dpif *ofport)
1467 {
1468     if (ofport->cfm) {
1469         cfm_wait(ofport->cfm);
1470     }
1471 }
1472
1473 static int
1474 port_query_by_name(const struct ofproto *ofproto_, const char *devname,
1475                    struct ofproto_port *ofproto_port)
1476 {
1477     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
1478     struct dpif_port dpif_port;
1479     int error;
1480
1481     error = dpif_port_query_by_name(ofproto->dpif, devname, &dpif_port);
1482     if (!error) {
1483         ofproto_port_from_dpif_port(ofproto_port, &dpif_port);
1484     }
1485     return error;
1486 }
1487
1488 static int
1489 port_add(struct ofproto *ofproto_, struct netdev *netdev, uint16_t *ofp_portp)
1490 {
1491     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
1492     uint16_t odp_port;
1493     int error;
1494
1495     error = dpif_port_add(ofproto->dpif, netdev, &odp_port);
1496     if (!error) {
1497         *ofp_portp = odp_port_to_ofp_port(odp_port);
1498     }
1499     return error;
1500 }
1501
1502 static int
1503 port_del(struct ofproto *ofproto_, uint16_t ofp_port)
1504 {
1505     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
1506     int error;
1507
1508     error = dpif_port_del(ofproto->dpif, ofp_port_to_odp_port(ofp_port));
1509     if (!error) {
1510         struct ofport_dpif *ofport = get_ofp_port(ofproto, ofp_port);
1511         if (ofport) {
1512             /* The caller is going to close ofport->up.netdev.  If this is a
1513              * bonded port, then the bond is using that netdev, so remove it
1514              * from the bond.  The client will need to reconfigure everything
1515              * after deleting ports, so then the slave will get re-added. */
1516             bundle_remove(&ofport->up);
1517         }
1518     }
1519     return error;
1520 }
1521
1522 struct port_dump_state {
1523     struct dpif_port_dump dump;
1524     bool done;
1525 };
1526
1527 static int
1528 port_dump_start(const struct ofproto *ofproto_, void **statep)
1529 {
1530     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
1531     struct port_dump_state *state;
1532
1533     *statep = state = xmalloc(sizeof *state);
1534     dpif_port_dump_start(&state->dump, ofproto->dpif);
1535     state->done = false;
1536     return 0;
1537 }
1538
1539 static int
1540 port_dump_next(const struct ofproto *ofproto_ OVS_UNUSED, void *state_,
1541                struct ofproto_port *port)
1542 {
1543     struct port_dump_state *state = state_;
1544     struct dpif_port dpif_port;
1545
1546     if (dpif_port_dump_next(&state->dump, &dpif_port)) {
1547         ofproto_port_from_dpif_port(port, &dpif_port);
1548         return 0;
1549     } else {
1550         int error = dpif_port_dump_done(&state->dump);
1551         state->done = true;
1552         return error ? error : EOF;
1553     }
1554 }
1555
1556 static int
1557 port_dump_done(const struct ofproto *ofproto_ OVS_UNUSED, void *state_)
1558 {
1559     struct port_dump_state *state = state_;
1560
1561     if (!state->done) {
1562         dpif_port_dump_done(&state->dump);
1563     }
1564     free(state);
1565     return 0;
1566 }
1567
1568 static int
1569 port_poll(const struct ofproto *ofproto_, char **devnamep)
1570 {
1571     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
1572     return dpif_port_poll(ofproto->dpif, devnamep);
1573 }
1574
1575 static void
1576 port_poll_wait(const struct ofproto *ofproto_)
1577 {
1578     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
1579     dpif_port_poll_wait(ofproto->dpif);
1580 }
1581
1582 static int
1583 port_is_lacp_current(const struct ofport *ofport_)
1584 {
1585     const struct ofport_dpif *ofport = ofport_dpif_cast(ofport_);
1586     return (ofport->bundle && ofport->bundle->lacp
1587             ? lacp_slave_is_current(ofport->bundle->lacp, ofport)
1588             : -1);
1589 }
1590 \f
1591 /* Upcall handling. */
1592
1593 /* Given 'upcall', of type DPIF_UC_ACTION or DPIF_UC_MISS, sends an
1594  * OFPT_PACKET_IN message to each OpenFlow controller as necessary according to
1595  * their individual configurations.
1596  *
1597  * If 'clone' is true, the caller retains ownership of 'upcall->packet'.
1598  * Otherwise, ownership is transferred to this function. */
1599 static void
1600 send_packet_in(struct ofproto_dpif *ofproto, struct dpif_upcall *upcall,
1601                const struct flow *flow, bool clone)
1602 {
1603     struct ofputil_packet_in pin;
1604
1605     pin.packet = upcall->packet;
1606     pin.in_port = flow->in_port;
1607     pin.reason = upcall->type == DPIF_UC_MISS ? OFPR_NO_MATCH : OFPR_ACTION;
1608     pin.buffer_id = 0;          /* not yet known */
1609     pin.send_len = upcall->userdata;
1610     connmgr_send_packet_in(ofproto->up.connmgr, &pin, flow,
1611                            clone ? NULL : upcall->packet);
1612 }
1613
1614 static bool
1615 process_special(struct ofproto_dpif *ofproto, const struct flow *flow,
1616                 const struct ofpbuf *packet)
1617 {
1618     if (cfm_should_process_flow(flow)) {
1619         struct ofport_dpif *ofport = get_ofp_port(ofproto, flow->in_port);
1620         if (packet && ofport && ofport->cfm) {
1621             cfm_process_heartbeat(ofport->cfm, packet);
1622         }
1623         return true;
1624     } else if (flow->dl_type == htons(ETH_TYPE_LACP)) {
1625         struct ofport_dpif *port = get_ofp_port(ofproto, flow->in_port);
1626         if (packet && port && port->bundle && port->bundle->lacp) {
1627             const struct lacp_pdu *pdu = parse_lacp_packet(packet);
1628             if (pdu) {
1629                 lacp_process_pdu(port->bundle->lacp, port, pdu);
1630             }
1631         }
1632         return true;
1633     }
1634     return false;
1635 }
1636
1637 static void
1638 handle_miss_upcall(struct ofproto_dpif *ofproto, struct dpif_upcall *upcall)
1639 {
1640     struct facet *facet;
1641     struct flow flow;
1642
1643     /* Obtain in_port and tun_id, at least. */
1644     odp_flow_key_to_flow(upcall->key, upcall->key_len, &flow);
1645
1646     /* Set header pointers in 'flow'. */
1647     flow_extract(upcall->packet, flow.tun_id, flow.in_port, &flow);
1648
1649     /* Handle 802.1ag and LACP. */
1650     if (process_special(ofproto, &flow, upcall->packet)) {
1651         ofpbuf_delete(upcall->packet);
1652         ofproto->n_matches++;
1653         return;
1654     }
1655
1656     /* Check with in-band control to see if this packet should be sent
1657      * to the local port regardless of the flow table. */
1658     if (connmgr_msg_in_hook(ofproto->up.connmgr, &flow, upcall->packet)) {
1659         send_packet(ofproto, ODPP_LOCAL, upcall->packet);
1660     }
1661
1662     facet = facet_lookup_valid(ofproto, &flow);
1663     if (!facet) {
1664         struct rule_dpif *rule = rule_dpif_lookup(ofproto, &flow);
1665         if (!rule) {
1666             /* Don't send a packet-in if OFPPC_NO_PACKET_IN asserted. */
1667             struct ofport_dpif *port = get_ofp_port(ofproto, flow.in_port);
1668             if (port) {
1669                 if (port->up.opp.config & htonl(OFPPC_NO_PACKET_IN)) {
1670                     COVERAGE_INC(ofproto_dpif_no_packet_in);
1671                     /* XXX install 'drop' flow entry */
1672                     ofpbuf_delete(upcall->packet);
1673                     return;
1674                 }
1675             } else {
1676                 VLOG_WARN_RL(&rl, "packet-in on unknown port %"PRIu16,
1677                              flow.in_port);
1678             }
1679
1680             send_packet_in(ofproto, upcall, &flow, false);
1681             return;
1682         }
1683
1684         facet = facet_create(rule, &flow, upcall->packet);
1685     } else if (!facet->may_install) {
1686         /* The facet is not installable, that is, we need to process every
1687          * packet, so process the current packet's actions into 'facet'. */
1688         facet_make_actions(ofproto, facet, upcall->packet);
1689     }
1690
1691     if (facet->rule->up.cr.priority == FAIL_OPEN_PRIORITY) {
1692         /*
1693          * Extra-special case for fail-open mode.
1694          *
1695          * We are in fail-open mode and the packet matched the fail-open rule,
1696          * but we are connected to a controller too.  We should send the packet
1697          * up to the controller in the hope that it will try to set up a flow
1698          * and thereby allow us to exit fail-open.
1699          *
1700          * See the top-level comment in fail-open.c for more information.
1701          */
1702         send_packet_in(ofproto, upcall, &flow, true);
1703     }
1704
1705     facet_execute(ofproto, facet, upcall->packet);
1706     facet_install(ofproto, facet, false);
1707     ofproto->n_matches++;
1708 }
1709
1710 static void
1711 handle_upcall(struct ofproto_dpif *ofproto, struct dpif_upcall *upcall)
1712 {
1713     struct flow flow;
1714
1715     switch (upcall->type) {
1716     case DPIF_UC_ACTION:
1717         COVERAGE_INC(ofproto_dpif_ctlr_action);
1718         odp_flow_key_to_flow(upcall->key, upcall->key_len, &flow);
1719         send_packet_in(ofproto, upcall, &flow, false);
1720         break;
1721
1722     case DPIF_UC_SAMPLE:
1723         if (ofproto->sflow) {
1724             odp_flow_key_to_flow(upcall->key, upcall->key_len, &flow);
1725             dpif_sflow_received(ofproto->sflow, upcall, &flow);
1726         }
1727         ofpbuf_delete(upcall->packet);
1728         break;
1729
1730     case DPIF_UC_MISS:
1731         handle_miss_upcall(ofproto, upcall);
1732         break;
1733
1734     case DPIF_N_UC_TYPES:
1735     default:
1736         VLOG_WARN_RL(&rl, "upcall has unexpected type %"PRIu32, upcall->type);
1737         break;
1738     }
1739 }
1740 \f
1741 /* Flow expiration. */
1742
1743 static int facet_max_idle(const struct ofproto_dpif *);
1744 static void update_stats(struct ofproto_dpif *);
1745 static void rule_expire(struct rule_dpif *);
1746 static void expire_facets(struct ofproto_dpif *, int dp_max_idle);
1747
1748 /* This function is called periodically by run().  Its job is to collect
1749  * updates for the flows that have been installed into the datapath, most
1750  * importantly when they last were used, and then use that information to
1751  * expire flows that have not been used recently.
1752  *
1753  * Returns the number of milliseconds after which it should be called again. */
1754 static int
1755 expire(struct ofproto_dpif *ofproto)
1756 {
1757     struct rule_dpif *rule, *next_rule;
1758     struct cls_cursor cursor;
1759     int dp_max_idle;
1760
1761     /* Update stats for each flow in the datapath. */
1762     update_stats(ofproto);
1763
1764     /* Expire facets that have been idle too long. */
1765     dp_max_idle = facet_max_idle(ofproto);
1766     expire_facets(ofproto, dp_max_idle);
1767
1768     /* Expire OpenFlow flows whose idle_timeout or hard_timeout has passed. */
1769     cls_cursor_init(&cursor, &ofproto->up.tables[0], NULL);
1770     CLS_CURSOR_FOR_EACH_SAFE (rule, next_rule, up.cr, &cursor) {
1771         rule_expire(rule);
1772     }
1773
1774     /* All outstanding data in existing flows has been accounted, so it's a
1775      * good time to do bond rebalancing. */
1776     if (ofproto->has_bonded_bundles) {
1777         struct ofbundle *bundle;
1778
1779         HMAP_FOR_EACH (bundle, hmap_node, &ofproto->bundles) {
1780             if (bundle->bond) {
1781                 bond_rebalance(bundle->bond, &ofproto->revalidate_set);
1782             }
1783         }
1784     }
1785
1786     return MIN(dp_max_idle, 1000);
1787 }
1788
1789 /* Update 'packet_count', 'byte_count', and 'used' members of installed facets.
1790  *
1791  * This function also pushes statistics updates to rules which each facet
1792  * resubmits into.  Generally these statistics will be accurate.  However, if a
1793  * facet changes the rule it resubmits into at some time in between
1794  * update_stats() runs, it is possible that statistics accrued to the
1795  * old rule will be incorrectly attributed to the new rule.  This could be
1796  * avoided by calling update_stats() whenever rules are created or
1797  * deleted.  However, the performance impact of making so many calls to the
1798  * datapath do not justify the benefit of having perfectly accurate statistics.
1799  */
1800 static void
1801 update_stats(struct ofproto_dpif *p)
1802 {
1803     const struct dpif_flow_stats *stats;
1804     struct dpif_flow_dump dump;
1805     const struct nlattr *key;
1806     size_t key_len;
1807
1808     dpif_flow_dump_start(&dump, p->dpif);
1809     while (dpif_flow_dump_next(&dump, &key, &key_len, NULL, NULL, &stats)) {
1810         struct facet *facet;
1811         struct flow flow;
1812
1813         if (odp_flow_key_to_flow(key, key_len, &flow)) {
1814             struct ds s;
1815
1816             ds_init(&s);
1817             odp_flow_key_format(key, key_len, &s);
1818             VLOG_WARN_RL(&rl, "failed to convert ODP flow key to flow: %s",
1819                          ds_cstr(&s));
1820             ds_destroy(&s);
1821
1822             continue;
1823         }
1824         facet = facet_find(p, &flow);
1825
1826         if (facet && facet->installed) {
1827
1828             if (stats->n_packets >= facet->dp_packet_count) {
1829                 uint64_t extra = stats->n_packets - facet->dp_packet_count;
1830                 facet->packet_count += extra;
1831             } else {
1832                 VLOG_WARN_RL(&rl, "unexpected packet count from the datapath");
1833             }
1834
1835             if (stats->n_bytes >= facet->dp_byte_count) {
1836                 facet->byte_count += stats->n_bytes - facet->dp_byte_count;
1837             } else {
1838                 VLOG_WARN_RL(&rl, "unexpected byte count from datapath");
1839             }
1840
1841             facet->dp_packet_count = stats->n_packets;
1842             facet->dp_byte_count = stats->n_bytes;
1843
1844             facet_update_time(p, facet, stats->used);
1845             facet_account(p, facet, stats->n_bytes);
1846             facet_push_stats(facet);
1847         } else {
1848             /* There's a flow in the datapath that we know nothing about.
1849              * Delete it. */
1850             COVERAGE_INC(facet_unexpected);
1851             dpif_flow_del(p->dpif, key, key_len, NULL);
1852         }
1853     }
1854     dpif_flow_dump_done(&dump);
1855 }
1856
1857 /* Calculates and returns the number of milliseconds of idle time after which
1858  * facets should expire from the datapath and we should fold their statistics
1859  * into their parent rules in userspace. */
1860 static int
1861 facet_max_idle(const struct ofproto_dpif *ofproto)
1862 {
1863     /*
1864      * Idle time histogram.
1865      *
1866      * Most of the time a switch has a relatively small number of facets.  When
1867      * this is the case we might as well keep statistics for all of them in
1868      * userspace and to cache them in the kernel datapath for performance as
1869      * well.
1870      *
1871      * As the number of facets increases, the memory required to maintain
1872      * statistics about them in userspace and in the kernel becomes
1873      * significant.  However, with a large number of facets it is likely that
1874      * only a few of them are "heavy hitters" that consume a large amount of
1875      * bandwidth.  At this point, only heavy hitters are worth caching in the
1876      * kernel and maintaining in userspaces; other facets we can discard.
1877      *
1878      * The technique used to compute the idle time is to build a histogram with
1879      * N_BUCKETS buckets whose width is BUCKET_WIDTH msecs each.  Each facet
1880      * that is installed in the kernel gets dropped in the appropriate bucket.
1881      * After the histogram has been built, we compute the cutoff so that only
1882      * the most-recently-used 1% of facets (but at least
1883      * ofproto->up.flow_eviction_threshold flows) are kept cached.  At least
1884      * the most-recently-used bucket of facets is kept, so actually an
1885      * arbitrary number of facets can be kept in any given expiration run
1886      * (though the next run will delete most of those unless they receive
1887      * additional data).
1888      *
1889      * This requires a second pass through the facets, in addition to the pass
1890      * made by update_stats(), because the former function never looks
1891      * at uninstallable facets.
1892      */
1893     enum { BUCKET_WIDTH = ROUND_UP(100, TIME_UPDATE_INTERVAL) };
1894     enum { N_BUCKETS = 5000 / BUCKET_WIDTH };
1895     int buckets[N_BUCKETS] = { 0 };
1896     int total, subtotal, bucket;
1897     struct facet *facet;
1898     long long int now;
1899     int i;
1900
1901     total = hmap_count(&ofproto->facets);
1902     if (total <= ofproto->up.flow_eviction_threshold) {
1903         return N_BUCKETS * BUCKET_WIDTH;
1904     }
1905
1906     /* Build histogram. */
1907     now = time_msec();
1908     HMAP_FOR_EACH (facet, hmap_node, &ofproto->facets) {
1909         long long int idle = now - facet->used;
1910         int bucket = (idle <= 0 ? 0
1911                       : idle >= BUCKET_WIDTH * N_BUCKETS ? N_BUCKETS - 1
1912                       : (unsigned int) idle / BUCKET_WIDTH);
1913         buckets[bucket]++;
1914     }
1915
1916     /* Find the first bucket whose flows should be expired. */
1917     subtotal = bucket = 0;
1918     do {
1919         subtotal += buckets[bucket++];
1920     } while (bucket < N_BUCKETS &&
1921              subtotal < MAX(ofproto->up.flow_eviction_threshold, total / 100));
1922
1923     if (VLOG_IS_DBG_ENABLED()) {
1924         struct ds s;
1925
1926         ds_init(&s);
1927         ds_put_cstr(&s, "keep");
1928         for (i = 0; i < N_BUCKETS; i++) {
1929             if (i == bucket) {
1930                 ds_put_cstr(&s, ", drop");
1931             }
1932             if (buckets[i]) {
1933                 ds_put_format(&s, " %d:%d", i * BUCKET_WIDTH, buckets[i]);
1934             }
1935         }
1936         VLOG_INFO("%s: %s (msec:count)", ofproto->up.name, ds_cstr(&s));
1937         ds_destroy(&s);
1938     }
1939
1940     return bucket * BUCKET_WIDTH;
1941 }
1942
1943 static void
1944 facet_active_timeout(struct ofproto_dpif *ofproto, struct facet *facet)
1945 {
1946     if (ofproto->netflow && !facet_is_controller_flow(facet) &&
1947         netflow_active_timeout_expired(ofproto->netflow, &facet->nf_flow)) {
1948         struct ofexpired expired;
1949
1950         if (facet->installed) {
1951             struct dpif_flow_stats stats;
1952
1953             facet_put__(ofproto, facet, facet->actions, facet->actions_len,
1954                         &stats);
1955             facet_update_stats(ofproto, facet, &stats);
1956         }
1957
1958         expired.flow = facet->flow;
1959         expired.packet_count = facet->packet_count;
1960         expired.byte_count = facet->byte_count;
1961         expired.used = facet->used;
1962         netflow_expire(ofproto->netflow, &facet->nf_flow, &expired);
1963     }
1964 }
1965
1966 static void
1967 expire_facets(struct ofproto_dpif *ofproto, int dp_max_idle)
1968 {
1969     long long int cutoff = time_msec() - dp_max_idle;
1970     struct facet *facet, *next_facet;
1971
1972     HMAP_FOR_EACH_SAFE (facet, next_facet, hmap_node, &ofproto->facets) {
1973         facet_active_timeout(ofproto, facet);
1974         if (facet->used < cutoff) {
1975             facet_remove(ofproto, facet);
1976         }
1977     }
1978 }
1979
1980 /* If 'rule' is an OpenFlow rule, that has expired according to OpenFlow rules,
1981  * then delete it entirely. */
1982 static void
1983 rule_expire(struct rule_dpif *rule)
1984 {
1985     struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
1986     struct facet *facet, *next_facet;
1987     long long int now;
1988     uint8_t reason;
1989
1990     /* Has 'rule' expired? */
1991     now = time_msec();
1992     if (rule->up.hard_timeout
1993         && now > rule->up.created + rule->up.hard_timeout * 1000) {
1994         reason = OFPRR_HARD_TIMEOUT;
1995     } else if (rule->up.idle_timeout && list_is_empty(&rule->facets)
1996                && now > rule->used + rule->up.idle_timeout * 1000) {
1997         reason = OFPRR_IDLE_TIMEOUT;
1998     } else {
1999         return;
2000     }
2001
2002     COVERAGE_INC(ofproto_dpif_expired);
2003
2004     /* Update stats.  (This is a no-op if the rule expired due to an idle
2005      * timeout, because that only happens when the rule has no facets left.) */
2006     LIST_FOR_EACH_SAFE (facet, next_facet, list_node, &rule->facets) {
2007         facet_remove(ofproto, facet);
2008     }
2009
2010     /* Get rid of the rule. */
2011     ofproto_rule_expire(&rule->up, reason);
2012 }
2013 \f
2014 /* Facets. */
2015
2016 /* Creates and returns a new facet owned by 'rule', given a 'flow' and an
2017  * example 'packet' within that flow.
2018  *
2019  * The caller must already have determined that no facet with an identical
2020  * 'flow' exists in 'ofproto' and that 'flow' is the best match for 'rule' in
2021  * the ofproto's classifier table. */
2022 static struct facet *
2023 facet_create(struct rule_dpif *rule, const struct flow *flow,
2024              const struct ofpbuf *packet)
2025 {
2026     struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
2027     struct facet *facet;
2028
2029     facet = xzalloc(sizeof *facet);
2030     facet->used = time_msec();
2031     hmap_insert(&ofproto->facets, &facet->hmap_node, flow_hash(flow, 0));
2032     list_push_back(&rule->facets, &facet->list_node);
2033     facet->rule = rule;
2034     facet->flow = *flow;
2035     netflow_flow_init(&facet->nf_flow);
2036     netflow_flow_update_time(ofproto->netflow, &facet->nf_flow, facet->used);
2037
2038     facet_make_actions(ofproto, facet, packet);
2039
2040     return facet;
2041 }
2042
2043 static void
2044 facet_free(struct facet *facet)
2045 {
2046     free(facet->actions);
2047     free(facet);
2048 }
2049
2050 /* Executes, within 'ofproto', the 'n_actions' actions in 'actions' on
2051  * 'packet', which arrived on 'in_port'.
2052  *
2053  * Takes ownership of 'packet'. */
2054 static bool
2055 execute_odp_actions(struct ofproto_dpif *ofproto, const struct flow *flow,
2056                     const struct nlattr *odp_actions, size_t actions_len,
2057                     struct ofpbuf *packet)
2058 {
2059     if (actions_len == NLA_ALIGN(NLA_HDRLEN + sizeof(uint64_t))
2060         && odp_actions->nla_type == ODP_ACTION_ATTR_USERSPACE) {
2061         /* As an optimization, avoid a round-trip from userspace to kernel to
2062          * userspace.  This also avoids possibly filling up kernel packet
2063          * buffers along the way. */
2064         struct dpif_upcall upcall;
2065
2066         upcall.type = DPIF_UC_ACTION;
2067         upcall.packet = packet;
2068         upcall.key = NULL;
2069         upcall.key_len = 0;
2070         upcall.userdata = nl_attr_get_u64(odp_actions);
2071         upcall.sample_pool = 0;
2072         upcall.actions = NULL;
2073         upcall.actions_len = 0;
2074
2075         send_packet_in(ofproto, &upcall, flow, false);
2076
2077         return true;
2078     } else {
2079         struct odputil_keybuf keybuf;
2080         struct ofpbuf key;
2081         int error;
2082
2083         ofpbuf_use_stack(&key, &keybuf, sizeof keybuf);
2084         odp_flow_key_from_flow(&key, flow);
2085
2086         error = dpif_execute(ofproto->dpif, key.data, key.size,
2087                              odp_actions, actions_len, packet);
2088
2089         ofpbuf_delete(packet);
2090         return !error;
2091     }
2092 }
2093
2094 /* Executes the actions indicated by 'facet' on 'packet' and credits 'facet''s
2095  * statistics appropriately.  'packet' must have at least sizeof(struct
2096  * ofp_packet_in) bytes of headroom.
2097  *
2098  * For correct results, 'packet' must actually be in 'facet''s flow; that is,
2099  * applying flow_extract() to 'packet' would yield the same flow as
2100  * 'facet->flow'.
2101  *
2102  * 'facet' must have accurately composed ODP actions; that is, it must not be
2103  * in need of revalidation.
2104  *
2105  * Takes ownership of 'packet'. */
2106 static void
2107 facet_execute(struct ofproto_dpif *ofproto, struct facet *facet,
2108               struct ofpbuf *packet)
2109 {
2110     struct dpif_flow_stats stats;
2111
2112     assert(ofpbuf_headroom(packet) >= sizeof(struct ofp_packet_in));
2113
2114     flow_extract_stats(&facet->flow, packet, &stats);
2115     stats.used = time_msec();
2116     if (execute_odp_actions(ofproto, &facet->flow,
2117                             facet->actions, facet->actions_len, packet)) {
2118         facet_update_stats(ofproto, facet, &stats);
2119     }
2120 }
2121
2122 /* Remove 'facet' from 'ofproto' and free up the associated memory:
2123  *
2124  *   - If 'facet' was installed in the datapath, uninstalls it and updates its
2125  *     rule's statistics, via facet_uninstall().
2126  *
2127  *   - Removes 'facet' from its rule and from ofproto->facets.
2128  */
2129 static void
2130 facet_remove(struct ofproto_dpif *ofproto, struct facet *facet)
2131 {
2132     facet_uninstall(ofproto, facet);
2133     facet_flush_stats(ofproto, facet);
2134     hmap_remove(&ofproto->facets, &facet->hmap_node);
2135     list_remove(&facet->list_node);
2136     facet_free(facet);
2137 }
2138
2139 /* Composes the ODP actions for 'facet' based on its rule's actions. */
2140 static void
2141 facet_make_actions(struct ofproto_dpif *p, struct facet *facet,
2142                    const struct ofpbuf *packet)
2143 {
2144     const struct rule_dpif *rule = facet->rule;
2145     struct ofpbuf *odp_actions;
2146     struct action_xlate_ctx ctx;
2147
2148     action_xlate_ctx_init(&ctx, p, &facet->flow, packet);
2149     odp_actions = xlate_actions(&ctx, rule->up.actions, rule->up.n_actions);
2150     facet->tags = ctx.tags;
2151     facet->may_install = ctx.may_set_up_flow;
2152     facet->nf_flow.output_iface = ctx.nf_output_iface;
2153
2154     if (facet->actions_len != odp_actions->size
2155         || memcmp(facet->actions, odp_actions->data, odp_actions->size)) {
2156         free(facet->actions);
2157         facet->actions_len = odp_actions->size;
2158         facet->actions = xmemdup(odp_actions->data, odp_actions->size);
2159     }
2160
2161     ofpbuf_delete(odp_actions);
2162 }
2163
2164 /* Updates 'facet''s flow in the datapath setting its actions to 'actions_len'
2165  * bytes of actions in 'actions'.  If 'stats' is non-null, statistics counters
2166  * in the datapath will be zeroed and 'stats' will be updated with traffic new
2167  * since 'facet' was last updated.
2168  *
2169  * Returns 0 if successful, otherwise a positive errno value.*/
2170 static int
2171 facet_put__(struct ofproto_dpif *ofproto, struct facet *facet,
2172             const struct nlattr *actions, size_t actions_len,
2173             struct dpif_flow_stats *stats)
2174 {
2175     struct odputil_keybuf keybuf;
2176     enum dpif_flow_put_flags flags;
2177     struct ofpbuf key;
2178     int ret;
2179
2180     flags = DPIF_FP_CREATE | DPIF_FP_MODIFY;
2181     if (stats) {
2182         flags |= DPIF_FP_ZERO_STATS;
2183     }
2184
2185     ofpbuf_use_stack(&key, &keybuf, sizeof keybuf);
2186     odp_flow_key_from_flow(&key, &facet->flow);
2187
2188     ret = dpif_flow_put(ofproto->dpif, flags, key.data, key.size,
2189                         actions, actions_len, stats);
2190
2191     if (stats) {
2192         facet_reset_dp_stats(facet, stats);
2193     }
2194
2195     return ret;
2196 }
2197
2198 /* If 'facet' is installable, inserts or re-inserts it into 'p''s datapath.  If
2199  * 'zero_stats' is true, clears any existing statistics from the datapath for
2200  * 'facet'. */
2201 static void
2202 facet_install(struct ofproto_dpif *p, struct facet *facet, bool zero_stats)
2203 {
2204     struct dpif_flow_stats stats;
2205
2206     if (facet->may_install
2207         && !facet_put__(p, facet, facet->actions, facet->actions_len,
2208                         zero_stats ? &stats : NULL)) {
2209         facet->installed = true;
2210     }
2211 }
2212
2213 static int
2214 vlan_tci_to_openflow_vlan(ovs_be16 vlan_tci)
2215 {
2216     return vlan_tci != htons(0) ? vlan_tci_to_vid(vlan_tci) : OFP_VLAN_NONE;
2217 }
2218
2219 static void
2220 facet_account(struct ofproto_dpif *ofproto,
2221               struct facet *facet, uint64_t extra_bytes)
2222 {
2223     uint64_t total_bytes, n_bytes;
2224     struct ofbundle *in_bundle;
2225     const struct nlattr *a;
2226     tag_type dummy = 0;
2227     unsigned int left;
2228     ovs_be16 vlan_tci;
2229     int vlan;
2230
2231     total_bytes = facet->byte_count + extra_bytes;
2232     if (total_bytes <= facet->accounted_bytes) {
2233         return;
2234     }
2235     n_bytes = total_bytes - facet->accounted_bytes;
2236     facet->accounted_bytes = total_bytes;
2237
2238     /* Test that 'tags' is nonzero to ensure that only flows that include an
2239      * OFPP_NORMAL action are used for learning and bond slave rebalancing.
2240      * This works because OFPP_NORMAL always sets a nonzero tag value.
2241      *
2242      * Feed information from the active flows back into the learning table to
2243      * ensure that table is always in sync with what is actually flowing
2244      * through the datapath. */
2245     if (!facet->tags
2246         || !is_admissible(ofproto, &facet->flow, false, &dummy,
2247                           &vlan, &in_bundle)) {
2248         return;
2249     }
2250
2251     update_learning_table(ofproto, &facet->flow, vlan, in_bundle);
2252
2253     if (!ofproto->has_bonded_bundles) {
2254         return;
2255     }
2256
2257     /* This loop feeds byte counters to bond_account() for rebalancing to use
2258      * as a basis.  We also need to track the actual VLAN on which the packet
2259      * is going to be sent to ensure that it matches the one passed to
2260      * bond_choose_output_slave().  (Otherwise, we will account to the wrong
2261      * hash bucket.) */
2262     vlan_tci = facet->flow.vlan_tci;
2263     NL_ATTR_FOR_EACH_UNSAFE (a, left, facet->actions, facet->actions_len) {
2264         struct ofport_dpif *port;
2265
2266         switch (nl_attr_type(a)) {
2267         case ODP_ACTION_ATTR_OUTPUT:
2268             port = get_odp_port(ofproto, nl_attr_get_u32(a));
2269             if (port && port->bundle && port->bundle->bond) {
2270                 bond_account(port->bundle->bond, &facet->flow,
2271                              vlan_tci_to_openflow_vlan(vlan_tci), n_bytes);
2272             }
2273             break;
2274
2275         case ODP_ACTION_ATTR_STRIP_VLAN:
2276             vlan_tci = htons(0);
2277             break;
2278
2279         case ODP_ACTION_ATTR_SET_DL_TCI:
2280             vlan_tci = nl_attr_get_be16(a);
2281             break;
2282         }
2283     }
2284 }
2285
2286 /* If 'rule' is installed in the datapath, uninstalls it. */
2287 static void
2288 facet_uninstall(struct ofproto_dpif *p, struct facet *facet)
2289 {
2290     if (facet->installed) {
2291         struct odputil_keybuf keybuf;
2292         struct dpif_flow_stats stats;
2293         struct ofpbuf key;
2294         int error;
2295
2296         ofpbuf_use_stack(&key, &keybuf, sizeof keybuf);
2297         odp_flow_key_from_flow(&key, &facet->flow);
2298
2299         error = dpif_flow_del(p->dpif, key.data, key.size, &stats);
2300         facet_reset_dp_stats(facet, &stats);
2301         if (!error) {
2302             facet_update_stats(p, facet, &stats);
2303         }
2304         facet->installed = false;
2305     } else {
2306         assert(facet->dp_packet_count == 0);
2307         assert(facet->dp_byte_count == 0);
2308     }
2309 }
2310
2311 /* Returns true if the only action for 'facet' is to send to the controller.
2312  * (We don't report NetFlow expiration messages for such facets because they
2313  * are just part of the control logic for the network, not real traffic). */
2314 static bool
2315 facet_is_controller_flow(struct facet *facet)
2316 {
2317     return (facet
2318             && facet->rule->up.n_actions == 1
2319             && action_outputs_to_port(&facet->rule->up.actions[0],
2320                                       htons(OFPP_CONTROLLER)));
2321 }
2322
2323 /* Resets 'facet''s datapath statistics counters.  This should be called when
2324  * 'facet''s statistics are cleared in the datapath.  If 'stats' is non-null,
2325  * it should contain the statistics returned by dpif when 'facet' was reset in
2326  * the datapath.  'stats' will be modified to only included statistics new
2327  * since 'facet' was last updated. */
2328 static void
2329 facet_reset_dp_stats(struct facet *facet, struct dpif_flow_stats *stats)
2330 {
2331     if (stats && facet->dp_packet_count <= stats->n_packets
2332         && facet->dp_byte_count <= stats->n_bytes) {
2333         stats->n_packets -= facet->dp_packet_count;
2334         stats->n_bytes -= facet->dp_byte_count;
2335     }
2336
2337     facet->dp_packet_count = 0;
2338     facet->dp_byte_count = 0;
2339 }
2340
2341 /* Folds all of 'facet''s statistics into its rule.  Also updates the
2342  * accounting ofhook and emits a NetFlow expiration if appropriate.  All of
2343  * 'facet''s statistics in the datapath should have been zeroed and folded into
2344  * its packet and byte counts before this function is called. */
2345 static void
2346 facet_flush_stats(struct ofproto_dpif *ofproto, struct facet *facet)
2347 {
2348     assert(!facet->dp_byte_count);
2349     assert(!facet->dp_packet_count);
2350
2351     facet_push_stats(facet);
2352     facet_account(ofproto, facet, 0);
2353
2354     if (ofproto->netflow && !facet_is_controller_flow(facet)) {
2355         struct ofexpired expired;
2356         expired.flow = facet->flow;
2357         expired.packet_count = facet->packet_count;
2358         expired.byte_count = facet->byte_count;
2359         expired.used = facet->used;
2360         netflow_expire(ofproto->netflow, &facet->nf_flow, &expired);
2361     }
2362
2363     facet->rule->packet_count += facet->packet_count;
2364     facet->rule->byte_count += facet->byte_count;
2365
2366     /* Reset counters to prevent double counting if 'facet' ever gets
2367      * reinstalled. */
2368     facet->packet_count = 0;
2369     facet->byte_count = 0;
2370     facet->rs_packet_count = 0;
2371     facet->rs_byte_count = 0;
2372     facet->accounted_bytes = 0;
2373
2374     netflow_flow_clear(&facet->nf_flow);
2375 }
2376
2377 /* Searches 'ofproto''s table of facets for one exactly equal to 'flow'.
2378  * Returns it if found, otherwise a null pointer.
2379  *
2380  * The returned facet might need revalidation; use facet_lookup_valid()
2381  * instead if that is important. */
2382 static struct facet *
2383 facet_find(struct ofproto_dpif *ofproto, const struct flow *flow)
2384 {
2385     struct facet *facet;
2386
2387     HMAP_FOR_EACH_WITH_HASH (facet, hmap_node, flow_hash(flow, 0),
2388                              &ofproto->facets) {
2389         if (flow_equal(flow, &facet->flow)) {
2390             return facet;
2391         }
2392     }
2393
2394     return NULL;
2395 }
2396
2397 /* Searches 'ofproto''s table of facets for one exactly equal to 'flow'.
2398  * Returns it if found, otherwise a null pointer.
2399  *
2400  * The returned facet is guaranteed to be valid. */
2401 static struct facet *
2402 facet_lookup_valid(struct ofproto_dpif *ofproto, const struct flow *flow)
2403 {
2404     struct facet *facet = facet_find(ofproto, flow);
2405
2406     /* The facet we found might not be valid, since we could be in need of
2407      * revalidation.  If it is not valid, don't return it. */
2408     if (facet
2409         && ofproto->need_revalidate
2410         && !facet_revalidate(ofproto, facet)) {
2411         COVERAGE_INC(facet_invalidated);
2412         return NULL;
2413     }
2414
2415     return facet;
2416 }
2417
2418 /* Re-searches 'ofproto''s classifier for a rule matching 'facet':
2419  *
2420  *   - If the rule found is different from 'facet''s current rule, moves
2421  *     'facet' to the new rule and recompiles its actions.
2422  *
2423  *   - If the rule found is the same as 'facet''s current rule, leaves 'facet'
2424  *     where it is and recompiles its actions anyway.
2425  *
2426  *   - If there is none, destroys 'facet'.
2427  *
2428  * Returns true if 'facet' still exists, false if it has been destroyed. */
2429 static bool
2430 facet_revalidate(struct ofproto_dpif *ofproto, struct facet *facet)
2431 {
2432     struct action_xlate_ctx ctx;
2433     struct ofpbuf *odp_actions;
2434     struct rule_dpif *new_rule;
2435     bool actions_changed;
2436
2437     COVERAGE_INC(facet_revalidate);
2438
2439     /* Determine the new rule. */
2440     new_rule = rule_dpif_lookup(ofproto, &facet->flow);
2441     if (!new_rule) {
2442         /* No new rule, so delete the facet. */
2443         facet_remove(ofproto, facet);
2444         return false;
2445     }
2446
2447     /* Calculate new ODP actions.
2448      *
2449      * We do not modify any 'facet' state yet, because we might need to, e.g.,
2450      * emit a NetFlow expiration and, if so, we need to have the old state
2451      * around to properly compose it. */
2452     action_xlate_ctx_init(&ctx, ofproto, &facet->flow, NULL);
2453     odp_actions = xlate_actions(&ctx,
2454                                 new_rule->up.actions, new_rule->up.n_actions);
2455     actions_changed = (facet->actions_len != odp_actions->size
2456                        || memcmp(facet->actions, odp_actions->data,
2457                                  facet->actions_len));
2458
2459     /* If the ODP actions changed or the installability changed, then we need
2460      * to talk to the datapath. */
2461     if (actions_changed || ctx.may_set_up_flow != facet->installed) {
2462         if (ctx.may_set_up_flow) {
2463             struct dpif_flow_stats stats;
2464
2465             facet_put__(ofproto, facet,
2466                         odp_actions->data, odp_actions->size, &stats);
2467             facet_update_stats(ofproto, facet, &stats);
2468         } else {
2469             facet_uninstall(ofproto, facet);
2470         }
2471
2472         /* The datapath flow is gone or has zeroed stats, so push stats out of
2473          * 'facet' into 'rule'. */
2474         facet_flush_stats(ofproto, facet);
2475     }
2476
2477     /* Update 'facet' now that we've taken care of all the old state. */
2478     facet->tags = ctx.tags;
2479     facet->nf_flow.output_iface = ctx.nf_output_iface;
2480     facet->may_install = ctx.may_set_up_flow;
2481     if (actions_changed) {
2482         free(facet->actions);
2483         facet->actions_len = odp_actions->size;
2484         facet->actions = xmemdup(odp_actions->data, odp_actions->size);
2485     }
2486     if (facet->rule != new_rule) {
2487         COVERAGE_INC(facet_changed_rule);
2488         list_remove(&facet->list_node);
2489         list_push_back(&new_rule->facets, &facet->list_node);
2490         facet->rule = new_rule;
2491         facet->used = new_rule->up.created;
2492         facet->rs_used = facet->used;
2493     }
2494
2495     ofpbuf_delete(odp_actions);
2496
2497     return true;
2498 }
2499
2500 /* Updates 'facet''s used time.  Caller is responsible for calling
2501  * facet_push_stats() to update the flows which 'facet' resubmits into. */
2502 static void
2503 facet_update_time(struct ofproto_dpif *ofproto, struct facet *facet,
2504                   long long int used)
2505 {
2506     if (used > facet->used) {
2507         facet->used = used;
2508         if (used > facet->rule->used) {
2509             facet->rule->used = used;
2510         }
2511         netflow_flow_update_time(ofproto->netflow, &facet->nf_flow, used);
2512     }
2513 }
2514
2515 /* Folds the statistics from 'stats' into the counters in 'facet'.
2516  *
2517  * Because of the meaning of a facet's counters, it only makes sense to do this
2518  * if 'stats' are not tracked in the datapath, that is, if 'stats' represents a
2519  * packet that was sent by hand or if it represents statistics that have been
2520  * cleared out of the datapath. */
2521 static void
2522 facet_update_stats(struct ofproto_dpif *ofproto, struct facet *facet,
2523                    const struct dpif_flow_stats *stats)
2524 {
2525     if (stats->n_packets || stats->used > facet->used) {
2526         facet_update_time(ofproto, facet, stats->used);
2527         facet->packet_count += stats->n_packets;
2528         facet->byte_count += stats->n_bytes;
2529         facet_push_stats(facet);
2530         netflow_flow_update_flags(&facet->nf_flow, stats->tcp_flags);
2531     }
2532 }
2533
2534 static void
2535 facet_push_stats(struct facet *facet)
2536 {
2537     uint64_t rs_packets, rs_bytes;
2538
2539     assert(facet->packet_count >= facet->rs_packet_count);
2540     assert(facet->byte_count >= facet->rs_byte_count);
2541     assert(facet->used >= facet->rs_used);
2542
2543     rs_packets = facet->packet_count - facet->rs_packet_count;
2544     rs_bytes = facet->byte_count - facet->rs_byte_count;
2545
2546     if (rs_packets || rs_bytes || facet->used > facet->rs_used) {
2547         facet->rs_packet_count = facet->packet_count;
2548         facet->rs_byte_count = facet->byte_count;
2549         facet->rs_used = facet->used;
2550
2551         flow_push_stats(facet->rule, &facet->flow,
2552                         rs_packets, rs_bytes, facet->used);
2553     }
2554 }
2555
2556 struct ofproto_push {
2557     struct action_xlate_ctx ctx;
2558     uint64_t packets;
2559     uint64_t bytes;
2560     long long int used;
2561 };
2562
2563 static void
2564 push_resubmit(struct action_xlate_ctx *ctx, struct rule_dpif *rule)
2565 {
2566     struct ofproto_push *push = CONTAINER_OF(ctx, struct ofproto_push, ctx);
2567
2568     if (rule) {
2569         rule->packet_count += push->packets;
2570         rule->byte_count += push->bytes;
2571         rule->used = MAX(push->used, rule->used);
2572     }
2573 }
2574
2575 /* Pushes flow statistics to the rules which 'flow' resubmits into given
2576  * 'rule''s actions. */
2577 static void
2578 flow_push_stats(const struct rule_dpif *rule,
2579                 struct flow *flow, uint64_t packets, uint64_t bytes,
2580                 long long int used)
2581 {
2582     struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
2583     struct ofproto_push push;
2584
2585     push.packets = packets;
2586     push.bytes = bytes;
2587     push.used = used;
2588
2589     action_xlate_ctx_init(&push.ctx, ofproto, flow, NULL);
2590     push.ctx.resubmit_hook = push_resubmit;
2591     ofpbuf_delete(xlate_actions(&push.ctx,
2592                                 rule->up.actions, rule->up.n_actions));
2593 }
2594 \f
2595 /* Rules. */
2596
2597 static struct rule_dpif *
2598 rule_dpif_lookup(struct ofproto_dpif *ofproto, const struct flow *flow)
2599 {
2600     return rule_dpif_cast(rule_from_cls_rule(
2601                               classifier_lookup(&ofproto->up.tables[0],
2602                                                 flow)));
2603 }
2604
2605 static void
2606 complete_operation(struct rule_dpif *rule)
2607 {
2608     struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
2609
2610     ofproto->need_revalidate = true;
2611     if (clogged) {
2612         struct dpif_completion *c = xmalloc(sizeof *c);
2613         c->op = rule->up.pending;
2614         list_push_back(&ofproto->completions, &c->list_node);
2615     } else {
2616         ofoperation_complete(rule->up.pending, 0);
2617     }
2618 }
2619
2620 static struct rule *
2621 rule_alloc(void)
2622 {
2623     struct rule_dpif *rule = xmalloc(sizeof *rule);
2624     return &rule->up;
2625 }
2626
2627 static void
2628 rule_dealloc(struct rule *rule_)
2629 {
2630     struct rule_dpif *rule = rule_dpif_cast(rule_);
2631     free(rule);
2632 }
2633
2634 static int
2635 rule_construct(struct rule *rule_)
2636 {
2637     struct rule_dpif *rule = rule_dpif_cast(rule_);
2638     struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
2639     struct rule_dpif *victim;
2640     int error;
2641
2642     error = validate_actions(rule->up.actions, rule->up.n_actions,
2643                              &rule->up.cr.flow, ofproto->max_ports);
2644     if (error) {
2645         return error;
2646     }
2647
2648     rule->used = rule->up.created;
2649     rule->packet_count = 0;
2650     rule->byte_count = 0;
2651
2652     victim = rule_dpif_cast(ofoperation_get_victim(rule->up.pending));
2653     if (victim && !list_is_empty(&victim->facets)) {
2654         struct facet *facet;
2655
2656         rule->facets = victim->facets;
2657         list_moved(&rule->facets);
2658         LIST_FOR_EACH (facet, list_node, &rule->facets) {
2659             facet->rule = rule;
2660         }
2661     } else {
2662         /* Must avoid list_moved() in this case. */
2663         list_init(&rule->facets);
2664     }
2665
2666     complete_operation(rule);
2667     return 0;
2668 }
2669
2670 static void
2671 rule_destruct(struct rule *rule_)
2672 {
2673     struct rule_dpif *rule = rule_dpif_cast(rule_);
2674     struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
2675     struct facet *facet, *next_facet;
2676
2677     LIST_FOR_EACH_SAFE (facet, next_facet, list_node, &rule->facets) {
2678         facet_revalidate(ofproto, facet);
2679     }
2680
2681     complete_operation(rule);
2682 }
2683
2684 static void
2685 rule_get_stats(struct rule *rule_, uint64_t *packets, uint64_t *bytes)
2686 {
2687     struct rule_dpif *rule = rule_dpif_cast(rule_);
2688     struct facet *facet;
2689
2690     /* Start from historical data for 'rule' itself that are no longer tracked
2691      * in facets.  This counts, for example, facets that have expired. */
2692     *packets = rule->packet_count;
2693     *bytes = rule->byte_count;
2694
2695     /* Add any statistics that are tracked by facets.  This includes
2696      * statistical data recently updated by ofproto_update_stats() as well as
2697      * stats for packets that were executed "by hand" via dpif_execute(). */
2698     LIST_FOR_EACH (facet, list_node, &rule->facets) {
2699         *packets += facet->packet_count;
2700         *bytes += facet->byte_count;
2701     }
2702 }
2703
2704 static int
2705 rule_execute(struct rule *rule_, struct flow *flow, struct ofpbuf *packet)
2706 {
2707     struct rule_dpif *rule = rule_dpif_cast(rule_);
2708     struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
2709     struct action_xlate_ctx ctx;
2710     struct ofpbuf *odp_actions;
2711     struct facet *facet;
2712     size_t size;
2713
2714     /* First look for a related facet.  If we find one, account it to that. */
2715     facet = facet_lookup_valid(ofproto, flow);
2716     if (facet && facet->rule == rule) {
2717         facet_execute(ofproto, facet, packet);
2718         return 0;
2719     }
2720
2721     /* Otherwise, if 'rule' is in fact the correct rule for 'packet', then
2722      * create a new facet for it and use that. */
2723     if (rule_dpif_lookup(ofproto, flow) == rule) {
2724         facet = facet_create(rule, flow, packet);
2725         facet_execute(ofproto, facet, packet);
2726         facet_install(ofproto, facet, true);
2727         return 0;
2728     }
2729
2730     /* We can't account anything to a facet.  If we were to try, then that
2731      * facet would have a non-matching rule, busting our invariants. */
2732     action_xlate_ctx_init(&ctx, ofproto, flow, packet);
2733     odp_actions = xlate_actions(&ctx, rule->up.actions, rule->up.n_actions);
2734     size = packet->size;
2735     if (execute_odp_actions(ofproto, flow, odp_actions->data,
2736                             odp_actions->size, packet)) {
2737         rule->used = time_msec();
2738         rule->packet_count++;
2739         rule->byte_count += size;
2740         flow_push_stats(rule, flow, 1, size, rule->used);
2741     }
2742     ofpbuf_delete(odp_actions);
2743
2744     return 0;
2745 }
2746
2747 static void
2748 rule_modify_actions(struct rule *rule_)
2749 {
2750     struct rule_dpif *rule = rule_dpif_cast(rule_);
2751     struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
2752     int error;
2753
2754     error = validate_actions(rule->up.actions, rule->up.n_actions,
2755                              &rule->up.cr.flow, ofproto->max_ports);
2756     if (error) {
2757         ofoperation_complete(rule->up.pending, error);
2758         return;
2759     }
2760
2761     complete_operation(rule);
2762 }
2763 \f
2764 /* Sends 'packet' out of port 'odp_port' within 'p'.
2765  * Returns 0 if successful, otherwise a positive errno value. */
2766 static int
2767 send_packet(struct ofproto_dpif *ofproto, uint32_t odp_port,
2768             const struct ofpbuf *packet)
2769 {
2770     struct ofpbuf key, odp_actions;
2771     struct odputil_keybuf keybuf;
2772     struct flow flow;
2773     int error;
2774
2775     flow_extract((struct ofpbuf *) packet, 0, 0, &flow);
2776     ofpbuf_use_stack(&key, &keybuf, sizeof keybuf);
2777     odp_flow_key_from_flow(&key, &flow);
2778
2779     ofpbuf_init(&odp_actions, 32);
2780     nl_msg_put_u32(&odp_actions, ODP_ACTION_ATTR_OUTPUT, odp_port);
2781     error = dpif_execute(ofproto->dpif,
2782                          key.data, key.size,
2783                          odp_actions.data, odp_actions.size,
2784                          packet);
2785     ofpbuf_uninit(&odp_actions);
2786
2787     if (error) {
2788         VLOG_WARN_RL(&rl, "%s: failed to send packet on port %"PRIu32" (%s)",
2789                      ofproto->up.name, odp_port, strerror(error));
2790     }
2791     return error;
2792 }
2793 \f
2794 /* OpenFlow to ODP action translation. */
2795
2796 static void do_xlate_actions(const union ofp_action *in, size_t n_in,
2797                              struct action_xlate_ctx *ctx);
2798 static void xlate_normal(struct action_xlate_ctx *);
2799
2800 static void
2801 commit_odp_actions(struct action_xlate_ctx *ctx)
2802 {
2803     const struct flow *flow = &ctx->flow;
2804     struct flow *base = &ctx->base_flow;
2805     struct ofpbuf *odp_actions = ctx->odp_actions;
2806
2807     if (base->tun_id != flow->tun_id) {
2808         nl_msg_put_be64(odp_actions, ODP_ACTION_ATTR_SET_TUNNEL, flow->tun_id);
2809         base->tun_id = flow->tun_id;
2810     }
2811
2812     if (base->nw_src != flow->nw_src) {
2813         nl_msg_put_be32(odp_actions, ODP_ACTION_ATTR_SET_NW_SRC, flow->nw_src);
2814         base->nw_src = flow->nw_src;
2815     }
2816
2817     if (base->nw_dst != flow->nw_dst) {
2818         nl_msg_put_be32(odp_actions, ODP_ACTION_ATTR_SET_NW_DST, flow->nw_dst);
2819         base->nw_dst = flow->nw_dst;
2820     }
2821
2822     if (base->nw_tos != flow->nw_tos) {
2823         nl_msg_put_u8(odp_actions, ODP_ACTION_ATTR_SET_NW_TOS, flow->nw_tos);
2824         base->nw_tos = flow->nw_tos;
2825     }
2826
2827     if (base->vlan_tci != flow->vlan_tci) {
2828         if (!(flow->vlan_tci & htons(VLAN_CFI))) {
2829             nl_msg_put_flag(odp_actions, ODP_ACTION_ATTR_STRIP_VLAN);
2830         } else {
2831             nl_msg_put_be16(odp_actions, ODP_ACTION_ATTR_SET_DL_TCI,
2832                             flow->vlan_tci & ~htons(VLAN_CFI));
2833         }
2834         base->vlan_tci = flow->vlan_tci;
2835     }
2836
2837     if (base->tp_src != flow->tp_src) {
2838         nl_msg_put_be16(odp_actions, ODP_ACTION_ATTR_SET_TP_SRC, flow->tp_src);
2839         base->tp_src = flow->tp_src;
2840     }
2841
2842     if (base->tp_dst != flow->tp_dst) {
2843         nl_msg_put_be16(odp_actions, ODP_ACTION_ATTR_SET_TP_DST, flow->tp_dst);
2844         base->tp_dst = flow->tp_dst;
2845     }
2846
2847     if (!eth_addr_equals(base->dl_src, flow->dl_src)) {
2848         nl_msg_put_unspec(odp_actions, ODP_ACTION_ATTR_SET_DL_SRC,
2849                           flow->dl_src, ETH_ADDR_LEN);
2850         memcpy(base->dl_src, flow->dl_src, ETH_ADDR_LEN);
2851     }
2852
2853     if (!eth_addr_equals(base->dl_dst, flow->dl_dst)) {
2854         nl_msg_put_unspec(odp_actions, ODP_ACTION_ATTR_SET_DL_DST,
2855                           flow->dl_dst, ETH_ADDR_LEN);
2856         memcpy(base->dl_dst, flow->dl_dst, ETH_ADDR_LEN);
2857     }
2858
2859     if (ctx->base_priority != ctx->priority) {
2860         if (ctx->priority) {
2861             nl_msg_put_u32(odp_actions, ODP_ACTION_ATTR_SET_PRIORITY,
2862                            ctx->priority);
2863         } else {
2864             nl_msg_put_flag(odp_actions, ODP_ACTION_ATTR_POP_PRIORITY);
2865         }
2866         ctx->base_priority = ctx->priority;
2867     }
2868 }
2869
2870 static void
2871 add_output_action(struct action_xlate_ctx *ctx, uint16_t ofp_port)
2872 {
2873     const struct ofport_dpif *ofport = get_ofp_port(ctx->ofproto, ofp_port);
2874     uint16_t odp_port = ofp_port_to_odp_port(ofp_port);
2875
2876     if (ofport) {
2877         if (ofport->up.opp.config & htonl(OFPPC_NO_FWD)) {
2878             /* Forwarding disabled on port. */
2879             return;
2880         }
2881     } else {
2882         /*
2883          * We don't have an ofport record for this port, but it doesn't hurt to
2884          * allow forwarding to it anyhow.  Maybe such a port will appear later
2885          * and we're pre-populating the flow table.
2886          */
2887     }
2888
2889     commit_odp_actions(ctx);
2890     nl_msg_put_u32(ctx->odp_actions, ODP_ACTION_ATTR_OUTPUT, odp_port);
2891     ctx->nf_output_iface = ofp_port;
2892 }
2893
2894 static void
2895 xlate_table_action(struct action_xlate_ctx *ctx, uint16_t in_port)
2896 {
2897     if (ctx->recurse < MAX_RESUBMIT_RECURSION) {
2898         struct rule_dpif *rule;
2899         uint16_t old_in_port;
2900
2901         /* Look up a flow with 'in_port' as the input port.  Then restore the
2902          * original input port (otherwise OFPP_NORMAL and OFPP_IN_PORT will
2903          * have surprising behavior). */
2904         old_in_port = ctx->flow.in_port;
2905         ctx->flow.in_port = in_port;
2906         rule = rule_dpif_lookup(ctx->ofproto, &ctx->flow);
2907         ctx->flow.in_port = old_in_port;
2908
2909         if (ctx->resubmit_hook) {
2910             ctx->resubmit_hook(ctx, rule);
2911         }
2912
2913         if (rule) {
2914             ctx->recurse++;
2915             do_xlate_actions(rule->up.actions, rule->up.n_actions, ctx);
2916             ctx->recurse--;
2917         }
2918     } else {
2919         static struct vlog_rate_limit recurse_rl = VLOG_RATE_LIMIT_INIT(1, 1);
2920
2921         VLOG_ERR_RL(&recurse_rl, "NXAST_RESUBMIT recursed over %d times",
2922                     MAX_RESUBMIT_RECURSION);
2923     }
2924 }
2925
2926 static void
2927 flood_packets(struct action_xlate_ctx *ctx, ovs_be32 mask)
2928 {
2929     struct ofport_dpif *ofport;
2930
2931     commit_odp_actions(ctx);
2932     HMAP_FOR_EACH (ofport, up.hmap_node, &ctx->ofproto->up.ports) {
2933         uint16_t ofp_port = ofport->up.ofp_port;
2934         if (ofp_port != ctx->flow.in_port && !(ofport->up.opp.config & mask)) {
2935             nl_msg_put_u32(ctx->odp_actions, ODP_ACTION_ATTR_OUTPUT,
2936                            ofport->odp_port);
2937         }
2938     }
2939
2940     ctx->nf_output_iface = NF_OUT_FLOOD;
2941 }
2942
2943 static void
2944 xlate_output_action__(struct action_xlate_ctx *ctx,
2945                       uint16_t port, uint16_t max_len)
2946 {
2947     uint16_t prev_nf_output_iface = ctx->nf_output_iface;
2948
2949     ctx->nf_output_iface = NF_OUT_DROP;
2950
2951     switch (port) {
2952     case OFPP_IN_PORT:
2953         add_output_action(ctx, ctx->flow.in_port);
2954         break;
2955     case OFPP_TABLE:
2956         xlate_table_action(ctx, ctx->flow.in_port);
2957         break;
2958     case OFPP_NORMAL:
2959         xlate_normal(ctx);
2960         break;
2961     case OFPP_FLOOD:
2962         flood_packets(ctx,  htonl(OFPPC_NO_FLOOD));
2963         break;
2964     case OFPP_ALL:
2965         flood_packets(ctx, htonl(0));
2966         break;
2967     case OFPP_CONTROLLER:
2968         commit_odp_actions(ctx);
2969         nl_msg_put_u64(ctx->odp_actions, ODP_ACTION_ATTR_USERSPACE, max_len);
2970         break;
2971     case OFPP_LOCAL:
2972         add_output_action(ctx, OFPP_LOCAL);
2973         break;
2974     case OFPP_NONE:
2975         break;
2976     default:
2977         if (port != ctx->flow.in_port) {
2978             add_output_action(ctx, port);
2979         }
2980         break;
2981     }
2982
2983     if (prev_nf_output_iface == NF_OUT_FLOOD) {
2984         ctx->nf_output_iface = NF_OUT_FLOOD;
2985     } else if (ctx->nf_output_iface == NF_OUT_DROP) {
2986         ctx->nf_output_iface = prev_nf_output_iface;
2987     } else if (prev_nf_output_iface != NF_OUT_DROP &&
2988                ctx->nf_output_iface != NF_OUT_FLOOD) {
2989         ctx->nf_output_iface = NF_OUT_MULTI;
2990     }
2991 }
2992
2993 static void
2994 xlate_output_action(struct action_xlate_ctx *ctx,
2995                     const struct ofp_action_output *oao)
2996 {
2997     xlate_output_action__(ctx, ntohs(oao->port), ntohs(oao->max_len));
2998 }
2999
3000 static void
3001 xlate_enqueue_action(struct action_xlate_ctx *ctx,
3002                      const struct ofp_action_enqueue *oae)
3003 {
3004     uint16_t ofp_port, odp_port;
3005     uint32_t ctx_priority, priority;
3006     int error;
3007
3008     error = dpif_queue_to_priority(ctx->ofproto->dpif, ntohl(oae->queue_id),
3009                                    &priority);
3010     if (error) {
3011         /* Fall back to ordinary output action. */
3012         xlate_output_action__(ctx, ntohs(oae->port), 0);
3013         return;
3014     }
3015
3016     /* Figure out ODP output port. */
3017     ofp_port = ntohs(oae->port);
3018     if (ofp_port == OFPP_IN_PORT) {
3019         ofp_port = ctx->flow.in_port;
3020     }
3021     odp_port = ofp_port_to_odp_port(ofp_port);
3022
3023     /* Add ODP actions. */
3024     ctx_priority = ctx->priority;
3025     ctx->priority = priority;
3026     add_output_action(ctx, odp_port);
3027     ctx->priority = ctx_priority;
3028
3029     /* Update NetFlow output port. */
3030     if (ctx->nf_output_iface == NF_OUT_DROP) {
3031         ctx->nf_output_iface = odp_port;
3032     } else if (ctx->nf_output_iface != NF_OUT_FLOOD) {
3033         ctx->nf_output_iface = NF_OUT_MULTI;
3034     }
3035 }
3036
3037 static void
3038 xlate_set_queue_action(struct action_xlate_ctx *ctx,
3039                        const struct nx_action_set_queue *nasq)
3040 {
3041     uint32_t priority;
3042     int error;
3043
3044     error = dpif_queue_to_priority(ctx->ofproto->dpif, ntohl(nasq->queue_id),
3045                                    &priority);
3046     if (error) {
3047         /* Couldn't translate queue to a priority, so ignore.  A warning
3048          * has already been logged. */
3049         return;
3050     }
3051
3052     ctx->priority = priority;
3053 }
3054
3055 struct xlate_reg_state {
3056     ovs_be16 vlan_tci;
3057     ovs_be64 tun_id;
3058 };
3059
3060 static void
3061 xlate_autopath(struct action_xlate_ctx *ctx,
3062                const struct nx_action_autopath *naa)
3063 {
3064     uint16_t ofp_port = ntohl(naa->id);
3065     struct ofport_dpif *port = get_ofp_port(ctx->ofproto, ofp_port);
3066
3067     if (!port || !port->bundle) {
3068         ofp_port = OFPP_NONE;
3069     } else if (port->bundle->bond) {
3070         /* Autopath does not support VLAN hashing. */
3071         struct ofport_dpif *slave = bond_choose_output_slave(
3072             port->bundle->bond, &ctx->flow, OFP_VLAN_NONE, &ctx->tags);
3073         if (slave) {
3074             ofp_port = slave->up.ofp_port;
3075         }
3076     }
3077     autopath_execute(naa, &ctx->flow, ofp_port);
3078 }
3079
3080 static bool
3081 slave_enabled_cb(uint16_t ofp_port, void *ofproto_)
3082 {
3083     struct ofproto_dpif *ofproto = ofproto_;
3084     struct ofport_dpif *port;
3085
3086     switch (ofp_port) {
3087     case OFPP_IN_PORT:
3088     case OFPP_TABLE:
3089     case OFPP_NORMAL:
3090     case OFPP_FLOOD:
3091     case OFPP_ALL:
3092     case OFPP_LOCAL:
3093         return true;
3094     case OFPP_CONTROLLER: /* Not supported by the bundle action. */
3095         return false;
3096     default:
3097         port = get_ofp_port(ofproto, ofp_port);
3098         return port ? port->may_enable : false;
3099     }
3100 }
3101
3102 static void
3103 do_xlate_actions(const union ofp_action *in, size_t n_in,
3104                  struct action_xlate_ctx *ctx)
3105 {
3106     const struct ofport_dpif *port;
3107     const union ofp_action *ia;
3108     size_t left;
3109
3110     port = get_ofp_port(ctx->ofproto, ctx->flow.in_port);
3111     if (port
3112         && port->up.opp.config & htonl(OFPPC_NO_RECV | OFPPC_NO_RECV_STP) &&
3113         port->up.opp.config & (eth_addr_equals(ctx->flow.dl_dst, eth_addr_stp)
3114                                ? htonl(OFPPC_NO_RECV_STP)
3115                                : htonl(OFPPC_NO_RECV))) {
3116         /* Drop this flow. */
3117         return;
3118     }
3119
3120     OFPUTIL_ACTION_FOR_EACH_UNSAFE (ia, left, in, n_in) {
3121         const struct ofp_action_dl_addr *oada;
3122         const struct nx_action_resubmit *nar;
3123         const struct nx_action_set_tunnel *nast;
3124         const struct nx_action_set_queue *nasq;
3125         const struct nx_action_multipath *nam;
3126         const struct nx_action_autopath *naa;
3127         const struct nx_action_bundle *nab;
3128         enum ofputil_action_code code;
3129         ovs_be64 tun_id;
3130
3131         code = ofputil_decode_action_unsafe(ia);
3132         switch (code) {
3133         case OFPUTIL_OFPAT_OUTPUT:
3134             xlate_output_action(ctx, &ia->output);
3135             break;
3136
3137         case OFPUTIL_OFPAT_SET_VLAN_VID:
3138             ctx->flow.vlan_tci &= ~htons(VLAN_VID_MASK);
3139             ctx->flow.vlan_tci |= ia->vlan_vid.vlan_vid | htons(VLAN_CFI);
3140             break;
3141
3142         case OFPUTIL_OFPAT_SET_VLAN_PCP:
3143             ctx->flow.vlan_tci &= ~htons(VLAN_PCP_MASK);
3144             ctx->flow.vlan_tci |= htons(
3145                 (ia->vlan_pcp.vlan_pcp << VLAN_PCP_SHIFT) | VLAN_CFI);
3146             break;
3147
3148         case OFPUTIL_OFPAT_STRIP_VLAN:
3149             ctx->flow.vlan_tci = htons(0);
3150             break;
3151
3152         case OFPUTIL_OFPAT_SET_DL_SRC:
3153             oada = ((struct ofp_action_dl_addr *) ia);
3154             memcpy(ctx->flow.dl_src, oada->dl_addr, ETH_ADDR_LEN);
3155             break;
3156
3157         case OFPUTIL_OFPAT_SET_DL_DST:
3158             oada = ((struct ofp_action_dl_addr *) ia);
3159             memcpy(ctx->flow.dl_dst, oada->dl_addr, ETH_ADDR_LEN);
3160             break;
3161
3162         case OFPUTIL_OFPAT_SET_NW_SRC:
3163             ctx->flow.nw_src = ia->nw_addr.nw_addr;
3164             break;
3165
3166         case OFPUTIL_OFPAT_SET_NW_DST:
3167             ctx->flow.nw_dst = ia->nw_addr.nw_addr;
3168             break;
3169
3170         case OFPUTIL_OFPAT_SET_NW_TOS:
3171             ctx->flow.nw_tos = ia->nw_tos.nw_tos & IP_DSCP_MASK;
3172             break;
3173
3174         case OFPUTIL_OFPAT_SET_TP_SRC:
3175             ctx->flow.tp_src = ia->tp_port.tp_port;
3176             break;
3177
3178         case OFPUTIL_OFPAT_SET_TP_DST:
3179             ctx->flow.tp_dst = ia->tp_port.tp_port;
3180             break;
3181
3182         case OFPUTIL_OFPAT_ENQUEUE:
3183             xlate_enqueue_action(ctx, (const struct ofp_action_enqueue *) ia);
3184             break;
3185
3186         case OFPUTIL_NXAST_RESUBMIT:
3187             nar = (const struct nx_action_resubmit *) ia;
3188             xlate_table_action(ctx, ntohs(nar->in_port));
3189             break;
3190
3191         case OFPUTIL_NXAST_SET_TUNNEL:
3192             nast = (const struct nx_action_set_tunnel *) ia;
3193             tun_id = htonll(ntohl(nast->tun_id));
3194             ctx->flow.tun_id = tun_id;
3195             break;
3196
3197         case OFPUTIL_NXAST_SET_QUEUE:
3198             nasq = (const struct nx_action_set_queue *) ia;
3199             xlate_set_queue_action(ctx, nasq);
3200             break;
3201
3202         case OFPUTIL_NXAST_POP_QUEUE:
3203             ctx->priority = 0;
3204             break;
3205
3206         case OFPUTIL_NXAST_REG_MOVE:
3207             nxm_execute_reg_move((const struct nx_action_reg_move *) ia,
3208                                  &ctx->flow);
3209             break;
3210
3211         case OFPUTIL_NXAST_REG_LOAD:
3212             nxm_execute_reg_load((const struct nx_action_reg_load *) ia,
3213                                  &ctx->flow);
3214             break;
3215
3216         case OFPUTIL_NXAST_NOTE:
3217             /* Nothing to do. */
3218             break;
3219
3220         case OFPUTIL_NXAST_SET_TUNNEL64:
3221             tun_id = ((const struct nx_action_set_tunnel64 *) ia)->tun_id;
3222             ctx->flow.tun_id = tun_id;
3223             break;
3224
3225         case OFPUTIL_NXAST_MULTIPATH:
3226             nam = (const struct nx_action_multipath *) ia;
3227             multipath_execute(nam, &ctx->flow);
3228             break;
3229
3230         case OFPUTIL_NXAST_AUTOPATH:
3231             naa = (const struct nx_action_autopath *) ia;
3232             xlate_autopath(ctx, naa);
3233             break;
3234
3235         case OFPUTIL_NXAST_BUNDLE:
3236             ctx->ofproto->has_bundle_action = true;
3237             nab = (const struct nx_action_bundle *) ia;
3238             xlate_output_action__(ctx, bundle_execute(nab, &ctx->flow,
3239                                                       slave_enabled_cb,
3240                                                       ctx->ofproto), 0);
3241             break;
3242
3243         case OFPUTIL_NXAST_BUNDLE_LOAD:
3244             ctx->ofproto->has_bundle_action = true;
3245             nab = (const struct nx_action_bundle *) ia;
3246             bundle_execute_load(nab, &ctx->flow, slave_enabled_cb,
3247                                 ctx->ofproto);
3248             break;
3249         }
3250     }
3251 }
3252
3253 static void
3254 action_xlate_ctx_init(struct action_xlate_ctx *ctx,
3255                       struct ofproto_dpif *ofproto, const struct flow *flow,
3256                       const struct ofpbuf *packet)
3257 {
3258     ctx->ofproto = ofproto;
3259     ctx->flow = *flow;
3260     ctx->packet = packet;
3261     ctx->resubmit_hook = NULL;
3262 }
3263
3264 static struct ofpbuf *
3265 xlate_actions(struct action_xlate_ctx *ctx,
3266               const union ofp_action *in, size_t n_in)
3267 {
3268     COVERAGE_INC(ofproto_dpif_xlate);
3269
3270     ctx->odp_actions = ofpbuf_new(512);
3271     ctx->tags = 0;
3272     ctx->may_set_up_flow = true;
3273     ctx->nf_output_iface = NF_OUT_DROP;
3274     ctx->recurse = 0;
3275     ctx->priority = 0;
3276     ctx->base_priority = 0;
3277     ctx->base_flow = ctx->flow;
3278
3279     if (process_special(ctx->ofproto, &ctx->flow, ctx->packet)) {
3280         ctx->may_set_up_flow = false;
3281     } else {
3282         do_xlate_actions(in, n_in, ctx);
3283     }
3284
3285     /* Check with in-band control to see if we're allowed to set up this
3286      * flow. */
3287     if (!connmgr_may_set_up_flow(ctx->ofproto->up.connmgr, &ctx->flow,
3288                                  ctx->odp_actions->data,
3289                                  ctx->odp_actions->size)) {
3290         ctx->may_set_up_flow = false;
3291     }
3292
3293     return ctx->odp_actions;
3294 }
3295 \f
3296 /* OFPP_NORMAL implementation. */
3297
3298 struct dst {
3299     struct ofport_dpif *port;
3300     uint16_t vlan;
3301 };
3302
3303 struct dst_set {
3304     struct dst builtin[32];
3305     struct dst *dsts;
3306     size_t n, allocated;
3307 };
3308
3309 static void dst_set_init(struct dst_set *);
3310 static void dst_set_add(struct dst_set *, const struct dst *);
3311 static void dst_set_free(struct dst_set *);
3312
3313 static struct ofport_dpif *ofbundle_get_a_port(const struct ofbundle *);
3314
3315 static bool
3316 set_dst(struct action_xlate_ctx *ctx, struct dst *dst,
3317         const struct ofbundle *in_bundle, const struct ofbundle *out_bundle)
3318 {
3319     dst->vlan = (out_bundle->vlan >= 0 ? OFP_VLAN_NONE
3320                  : in_bundle->vlan >= 0 ? in_bundle->vlan
3321                  : ctx->flow.vlan_tci == 0 ? OFP_VLAN_NONE
3322                  : vlan_tci_to_vid(ctx->flow.vlan_tci));
3323
3324     dst->port = (!out_bundle->bond
3325                  ? ofbundle_get_a_port(out_bundle)
3326                  : bond_choose_output_slave(out_bundle->bond, &ctx->flow,
3327                                             dst->vlan, &ctx->tags));
3328
3329     return dst->port != NULL;
3330 }
3331
3332 static int
3333 mirror_mask_ffs(mirror_mask_t mask)
3334 {
3335     BUILD_ASSERT_DECL(sizeof(unsigned int) >= sizeof(mask));
3336     return ffs(mask);
3337 }
3338
3339 static void
3340 dst_set_init(struct dst_set *set)
3341 {
3342     set->dsts = set->builtin;
3343     set->n = 0;
3344     set->allocated = ARRAY_SIZE(set->builtin);
3345 }
3346
3347 static void
3348 dst_set_add(struct dst_set *set, const struct dst *dst)
3349 {
3350     if (set->n >= set->allocated) {
3351         size_t new_allocated;
3352         struct dst *new_dsts;
3353
3354         new_allocated = set->allocated * 2;
3355         new_dsts = xmalloc(new_allocated * sizeof *new_dsts);
3356         memcpy(new_dsts, set->dsts, set->n * sizeof *new_dsts);
3357
3358         dst_set_free(set);
3359
3360         set->dsts = new_dsts;
3361         set->allocated = new_allocated;
3362     }
3363     set->dsts[set->n++] = *dst;
3364 }
3365
3366 static void
3367 dst_set_free(struct dst_set *set)
3368 {
3369     if (set->dsts != set->builtin) {
3370         free(set->dsts);
3371     }
3372 }
3373
3374 static bool
3375 dst_is_duplicate(const struct dst_set *set, const struct dst *test)
3376 {
3377     size_t i;
3378     for (i = 0; i < set->n; i++) {
3379         if (set->dsts[i].vlan == test->vlan
3380             && set->dsts[i].port == test->port) {
3381             return true;
3382         }
3383     }
3384     return false;
3385 }
3386
3387 static bool
3388 ofbundle_trunks_vlan(const struct ofbundle *bundle, uint16_t vlan)
3389 {
3390     return (bundle->vlan < 0
3391             && (!bundle->trunks || bitmap_is_set(bundle->trunks, vlan)));
3392 }
3393
3394 static bool
3395 ofbundle_includes_vlan(const struct ofbundle *bundle, uint16_t vlan)
3396 {
3397     return vlan == bundle->vlan || ofbundle_trunks_vlan(bundle, vlan);
3398 }
3399
3400 /* Returns an arbitrary interface within 'bundle'. */
3401 static struct ofport_dpif *
3402 ofbundle_get_a_port(const struct ofbundle *bundle)
3403 {
3404     return CONTAINER_OF(list_front(&bundle->ports),
3405                         struct ofport_dpif, bundle_node);
3406 }
3407
3408 static void
3409 compose_dsts(struct action_xlate_ctx *ctx, uint16_t vlan,
3410              const struct ofbundle *in_bundle,
3411              const struct ofbundle *out_bundle, struct dst_set *set)
3412 {
3413     struct dst dst;
3414
3415     if (out_bundle == OFBUNDLE_FLOOD) {
3416         struct ofbundle *bundle;
3417
3418         HMAP_FOR_EACH (bundle, hmap_node, &ctx->ofproto->bundles) {
3419             if (bundle != in_bundle
3420                 && ofbundle_includes_vlan(bundle, vlan)
3421                 && bundle->floodable
3422                 && !bundle->mirror_out
3423                 && set_dst(ctx, &dst, in_bundle, bundle)) {
3424                 dst_set_add(set, &dst);
3425             }
3426         }
3427         ctx->nf_output_iface = NF_OUT_FLOOD;
3428     } else if (out_bundle && set_dst(ctx, &dst, in_bundle, out_bundle)) {
3429         dst_set_add(set, &dst);
3430         ctx->nf_output_iface = dst.port->odp_port;
3431     }
3432 }
3433
3434 static bool
3435 vlan_is_mirrored(const struct ofmirror *m, int vlan)
3436 {
3437     return !m->vlans || bitmap_is_set(m->vlans, vlan);
3438 }
3439
3440 /* Returns true if a packet with Ethernet destination MAC 'dst' may be mirrored
3441  * to a VLAN.  In general most packets may be mirrored but we want to drop
3442  * protocols that may confuse switches. */
3443 static bool
3444 eth_dst_may_rspan(const uint8_t dst[ETH_ADDR_LEN])
3445 {
3446     /* If you change this function's behavior, please update corresponding
3447      * documentation in vswitch.xml at the same time. */
3448     if (dst[0] != 0x01) {
3449         /* All the currently banned MACs happen to start with 01 currently, so
3450          * this is a quick way to eliminate most of the good ones. */
3451     } else {
3452         if (eth_addr_is_reserved(dst)) {
3453             /* Drop STP, IEEE pause frames, and other reserved protocols
3454              * (01-80-c2-00-00-0x). */
3455             return false;
3456         }
3457
3458         if (dst[0] == 0x01 && dst[1] == 0x00 && dst[2] == 0x0c) {
3459             /* Cisco OUI. */
3460             if ((dst[3] & 0xfe) == 0xcc &&
3461                 (dst[4] & 0xfe) == 0xcc &&
3462                 (dst[5] & 0xfe) == 0xcc) {
3463                 /* Drop the following protocols plus others following the same
3464                    pattern:
3465
3466                    CDP, VTP, DTP, PAgP  (01-00-0c-cc-cc-cc)
3467                    Spanning Tree PVSTP+ (01-00-0c-cc-cc-cd)
3468                    STP Uplink Fast      (01-00-0c-cd-cd-cd) */
3469                 return false;
3470             }
3471
3472             if (!(dst[3] | dst[4] | dst[5])) {
3473                 /* Drop Inter Switch Link packets (01-00-0c-00-00-00). */
3474                 return false;
3475             }
3476         }
3477     }
3478     return true;
3479 }
3480
3481 static void
3482 compose_mirror_dsts(struct action_xlate_ctx *ctx,
3483                     uint16_t vlan, const struct ofbundle *in_bundle,
3484                     struct dst_set *set)
3485 {
3486     struct ofproto_dpif *ofproto = ctx->ofproto;
3487     mirror_mask_t mirrors;
3488     int flow_vlan;
3489     size_t i;
3490
3491     mirrors = in_bundle->src_mirrors;
3492     for (i = 0; i < set->n; i++) {
3493         mirrors |= set->dsts[i].port->bundle->dst_mirrors;
3494     }
3495
3496     if (!mirrors) {
3497         return;
3498     }
3499
3500     flow_vlan = vlan_tci_to_vid(ctx->flow.vlan_tci);
3501     if (flow_vlan == 0) {
3502         flow_vlan = OFP_VLAN_NONE;
3503     }
3504
3505     while (mirrors) {
3506         struct ofmirror *m = ofproto->mirrors[mirror_mask_ffs(mirrors) - 1];
3507         if (vlan_is_mirrored(m, vlan)) {
3508             struct dst dst;
3509
3510             if (m->out) {
3511                 if (set_dst(ctx, &dst, in_bundle, m->out)
3512                     && !dst_is_duplicate(set, &dst)) {
3513                     dst_set_add(set, &dst);
3514                 }
3515             } else if (eth_dst_may_rspan(ctx->flow.dl_dst)) {
3516                 struct ofbundle *bundle;
3517
3518                 HMAP_FOR_EACH (bundle, hmap_node, &ofproto->bundles) {
3519                     if (ofbundle_includes_vlan(bundle, m->out_vlan)
3520                         && set_dst(ctx, &dst, in_bundle, bundle))
3521                     {
3522                         if (bundle->vlan < 0) {
3523                             dst.vlan = m->out_vlan;
3524                         }
3525                         if (dst_is_duplicate(set, &dst)) {
3526                             continue;
3527                         }
3528
3529                         /* Use the vlan tag on the original flow instead of
3530                          * the one passed in the vlan parameter.  This ensures
3531                          * that we compare the vlan from before any implicit
3532                          * tagging tags place. This is necessary because
3533                          * dst->vlan is the final vlan, after removing implicit
3534                          * tags. */
3535                         if (bundle == in_bundle && dst.vlan == flow_vlan) {
3536                             /* Don't send out input port on same VLAN. */
3537                             continue;
3538                         }
3539                         dst_set_add(set, &dst);
3540                     }
3541                 }
3542             }
3543         }
3544         mirrors &= mirrors - 1;
3545     }
3546 }
3547
3548 static void
3549 compose_actions(struct action_xlate_ctx *ctx, uint16_t vlan,
3550                 const struct ofbundle *in_bundle,
3551                 const struct ofbundle *out_bundle)
3552 {
3553     uint16_t initial_vlan, cur_vlan;
3554     const struct dst *dst;
3555     struct dst_set set;
3556
3557     dst_set_init(&set);
3558     compose_dsts(ctx, vlan, in_bundle, out_bundle, &set);
3559     compose_mirror_dsts(ctx, vlan, in_bundle, &set);
3560
3561     /* Output all the packets we can without having to change the VLAN. */
3562     initial_vlan = vlan_tci_to_vid(ctx->flow.vlan_tci);
3563     if (initial_vlan == 0) {
3564         initial_vlan = OFP_VLAN_NONE;
3565     }
3566     for (dst = set.dsts; dst < &set.dsts[set.n]; dst++) {
3567         if (dst->vlan != initial_vlan) {
3568             continue;
3569         }
3570         nl_msg_put_u32(ctx->odp_actions,
3571                        ODP_ACTION_ATTR_OUTPUT, dst->port->odp_port);
3572     }
3573
3574     /* Then output the rest. */
3575     cur_vlan = initial_vlan;
3576     for (dst = set.dsts; dst < &set.dsts[set.n]; dst++) {
3577         if (dst->vlan == initial_vlan) {
3578             continue;
3579         }
3580         if (dst->vlan != cur_vlan) {
3581             if (dst->vlan == OFP_VLAN_NONE) {
3582                 nl_msg_put_flag(ctx->odp_actions, ODP_ACTION_ATTR_STRIP_VLAN);
3583             } else {
3584                 ovs_be16 tci;
3585                 tci = htons(dst->vlan & VLAN_VID_MASK);
3586                 tci |= ctx->flow.vlan_tci & htons(VLAN_PCP_MASK);
3587                 nl_msg_put_be16(ctx->odp_actions,
3588                                 ODP_ACTION_ATTR_SET_DL_TCI, tci);
3589             }
3590             cur_vlan = dst->vlan;
3591         }
3592         nl_msg_put_u32(ctx->odp_actions,
3593                        ODP_ACTION_ATTR_OUTPUT, dst->port->odp_port);
3594     }
3595
3596     dst_set_free(&set);
3597 }
3598
3599 /* Returns the effective vlan of a packet, taking into account both the
3600  * 802.1Q header and implicitly tagged ports.  A value of 0 indicates that
3601  * the packet is untagged and -1 indicates it has an invalid header and
3602  * should be dropped. */
3603 static int
3604 flow_get_vlan(struct ofproto_dpif *ofproto, const struct flow *flow,
3605               struct ofbundle *in_bundle, bool have_packet)
3606 {
3607     int vlan = vlan_tci_to_vid(flow->vlan_tci);
3608     if (in_bundle->vlan >= 0) {
3609         if (vlan) {
3610             if (have_packet) {
3611                 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
3612                 VLOG_WARN_RL(&rl, "bridge %s: dropping VLAN %d tagged "
3613                              "packet received on port %s configured with "
3614                              "implicit VLAN %"PRIu16,
3615                              ofproto->up.name, vlan,
3616                              in_bundle->name, in_bundle->vlan);
3617             }
3618             return -1;
3619         }
3620         vlan = in_bundle->vlan;
3621     } else {
3622         if (!ofbundle_includes_vlan(in_bundle, vlan)) {
3623             if (have_packet) {
3624                 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
3625                 VLOG_WARN_RL(&rl, "bridge %s: dropping VLAN %d tagged "
3626                              "packet received on port %s not configured for "
3627                              "trunking VLAN %d",
3628                              ofproto->up.name, vlan, in_bundle->name, vlan);
3629             }
3630             return -1;
3631         }
3632     }
3633
3634     return vlan;
3635 }
3636
3637 /* A VM broadcasts a gratuitous ARP to indicate that it has resumed after
3638  * migration.  Older Citrix-patched Linux DomU used gratuitous ARP replies to
3639  * indicate this; newer upstream kernels use gratuitous ARP requests. */
3640 static bool
3641 is_gratuitous_arp(const struct flow *flow)
3642 {
3643     return (flow->dl_type == htons(ETH_TYPE_ARP)
3644             && eth_addr_is_broadcast(flow->dl_dst)
3645             && (flow->nw_proto == ARP_OP_REPLY
3646                 || (flow->nw_proto == ARP_OP_REQUEST
3647                     && flow->nw_src == flow->nw_dst)));
3648 }
3649
3650 static void
3651 update_learning_table(struct ofproto_dpif *ofproto,
3652                       const struct flow *flow, int vlan,
3653                       struct ofbundle *in_bundle)
3654 {
3655     struct mac_entry *mac;
3656
3657     if (!mac_learning_may_learn(ofproto->ml, flow->dl_src, vlan)) {
3658         return;
3659     }
3660
3661     mac = mac_learning_insert(ofproto->ml, flow->dl_src, vlan);
3662     if (is_gratuitous_arp(flow)) {
3663         /* We don't want to learn from gratuitous ARP packets that are
3664          * reflected back over bond slaves so we lock the learning table. */
3665         if (!in_bundle->bond) {
3666             mac_entry_set_grat_arp_lock(mac);
3667         } else if (mac_entry_is_grat_arp_locked(mac)) {
3668             return;
3669         }
3670     }
3671
3672     if (mac_entry_is_new(mac) || mac->port.p != in_bundle) {
3673         /* The log messages here could actually be useful in debugging,
3674          * so keep the rate limit relatively high. */
3675         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(30, 300);
3676         VLOG_DBG_RL(&rl, "bridge %s: learned that "ETH_ADDR_FMT" is "
3677                     "on port %s in VLAN %d",
3678                     ofproto->up.name, ETH_ADDR_ARGS(flow->dl_src),
3679                     in_bundle->name, vlan);
3680
3681         mac->port.p = in_bundle;
3682         tag_set_add(&ofproto->revalidate_set,
3683                     mac_learning_changed(ofproto->ml, mac));
3684     }
3685 }
3686
3687 /* Determines whether packets in 'flow' within 'br' should be forwarded or
3688  * dropped.  Returns true if they may be forwarded, false if they should be
3689  * dropped.
3690  *
3691  * If 'have_packet' is true, it indicates that the caller is processing a
3692  * received packet.  If 'have_packet' is false, then the caller is just
3693  * revalidating an existing flow because configuration has changed.  Either
3694  * way, 'have_packet' only affects logging (there is no point in logging errors
3695  * during revalidation).
3696  *
3697  * Sets '*in_portp' to the input port.  This will be a null pointer if
3698  * flow->in_port does not designate a known input port (in which case
3699  * is_admissible() returns false).
3700  *
3701  * When returning true, sets '*vlanp' to the effective VLAN of the input
3702  * packet, as returned by flow_get_vlan().
3703  *
3704  * May also add tags to '*tags', although the current implementation only does
3705  * so in one special case.
3706  */
3707 static bool
3708 is_admissible(struct ofproto_dpif *ofproto, const struct flow *flow,
3709               bool have_packet,
3710               tag_type *tags, int *vlanp, struct ofbundle **in_bundlep)
3711 {
3712     struct ofport_dpif *in_port;
3713     struct ofbundle *in_bundle;
3714     int vlan;
3715
3716     /* Find the port and bundle for the received packet. */
3717     in_port = get_ofp_port(ofproto, flow->in_port);
3718     *in_bundlep = in_bundle = in_port ? in_port->bundle : NULL;
3719     if (!in_port || !in_bundle) {
3720         /* No interface?  Something fishy... */
3721         if (have_packet) {
3722             /* Odd.  A few possible reasons here:
3723              *
3724              * - We deleted a port but there are still a few packets queued up
3725              *   from it.
3726              *
3727              * - Someone externally added a port (e.g. "ovs-dpctl add-if") that
3728              *   we don't know about.
3729              *
3730              * - Packet arrived on the local port but the local port is not
3731              *   part of a bundle.
3732              */
3733             static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
3734
3735             VLOG_WARN_RL(&rl, "bridge %s: received packet on unknown "
3736                          "port %"PRIu16,
3737                          ofproto->up.name, flow->in_port);
3738         }
3739         return false;
3740     }
3741     *vlanp = vlan = flow_get_vlan(ofproto, flow, in_bundle, have_packet);
3742     if (vlan < 0) {
3743         return false;
3744     }
3745
3746     /* Drop frames for reserved multicast addresses
3747      * only if forward_bpdu option is absent. */
3748     if (eth_addr_is_reserved(flow->dl_dst) &&
3749         !ofproto->up.forward_bpdu) {
3750         return false;
3751     }
3752
3753     /* Drop frames on bundles reserved for mirroring. */
3754     if (in_bundle->mirror_out) {
3755         if (have_packet) {
3756             static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
3757             VLOG_WARN_RL(&rl, "bridge %s: dropping packet received on port "
3758                          "%s, which is reserved exclusively for mirroring",
3759                          ofproto->up.name, in_bundle->name);
3760         }
3761         return false;
3762     }
3763
3764     if (in_bundle->bond) {
3765         struct mac_entry *mac;
3766
3767         switch (bond_check_admissibility(in_bundle->bond, in_port,
3768                                          flow->dl_dst, tags)) {
3769         case BV_ACCEPT:
3770             break;
3771
3772         case BV_DROP:
3773             return false;
3774
3775         case BV_DROP_IF_MOVED:
3776             mac = mac_learning_lookup(ofproto->ml, flow->dl_src, vlan, NULL);
3777             if (mac && mac->port.p != in_bundle &&
3778                 (!is_gratuitous_arp(flow)
3779                  || mac_entry_is_grat_arp_locked(mac))) {
3780                 return false;
3781             }
3782             break;
3783         }
3784     }
3785
3786     return true;
3787 }
3788
3789 static void
3790 xlate_normal(struct action_xlate_ctx *ctx)
3791 {
3792     struct ofbundle *in_bundle;
3793     struct ofbundle *out_bundle;
3794     struct mac_entry *mac;
3795     int vlan;
3796
3797     /* Check whether we should drop packets in this flow. */
3798     if (!is_admissible(ctx->ofproto, &ctx->flow, ctx->packet != NULL,
3799                        &ctx->tags, &vlan, &in_bundle)) {
3800         out_bundle = NULL;
3801         goto done;
3802     }
3803
3804     /* Learn source MAC (but don't try to learn from revalidation). */
3805     if (ctx->packet) {
3806         update_learning_table(ctx->ofproto, &ctx->flow, vlan, in_bundle);
3807     }
3808
3809     /* Determine output bundle. */
3810     mac = mac_learning_lookup(ctx->ofproto->ml, ctx->flow.dl_dst, vlan,
3811                               &ctx->tags);
3812     if (mac) {
3813         out_bundle = mac->port.p;
3814     } else if (!ctx->packet && !eth_addr_is_multicast(ctx->flow.dl_dst)) {
3815         /* If we are revalidating but don't have a learning entry then eject
3816          * the flow.  Installing a flow that floods packets opens up a window
3817          * of time where we could learn from a packet reflected on a bond and
3818          * blackhole packets before the learning table is updated to reflect
3819          * the correct port. */
3820         ctx->may_set_up_flow = false;
3821         return;
3822     } else {
3823         out_bundle = OFBUNDLE_FLOOD;
3824     }
3825
3826     /* Don't send packets out their input bundles. */
3827     if (in_bundle == out_bundle) {
3828         out_bundle = NULL;
3829     }
3830
3831 done:
3832     if (in_bundle) {
3833         compose_actions(ctx, vlan, in_bundle, out_bundle);
3834     }
3835 }
3836 \f
3837 static bool
3838 get_drop_frags(struct ofproto *ofproto_)
3839 {
3840     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
3841     bool drop_frags;
3842
3843     dpif_get_drop_frags(ofproto->dpif, &drop_frags);
3844     return drop_frags;
3845 }
3846
3847 static void
3848 set_drop_frags(struct ofproto *ofproto_, bool drop_frags)
3849 {
3850     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
3851
3852     dpif_set_drop_frags(ofproto->dpif, drop_frags);
3853 }
3854
3855 static int
3856 packet_out(struct ofproto *ofproto_, struct ofpbuf *packet,
3857            const struct flow *flow,
3858            const union ofp_action *ofp_actions, size_t n_ofp_actions)
3859 {
3860     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
3861     int error;
3862
3863     error = validate_actions(ofp_actions, n_ofp_actions, flow,
3864                              ofproto->max_ports);
3865     if (!error) {
3866         struct odputil_keybuf keybuf;
3867         struct action_xlate_ctx ctx;
3868         struct ofpbuf *odp_actions;
3869         struct ofpbuf key;
3870
3871         ofpbuf_use_stack(&key, &keybuf, sizeof keybuf);
3872         odp_flow_key_from_flow(&key, flow);
3873
3874         action_xlate_ctx_init(&ctx, ofproto, flow, packet);
3875         odp_actions = xlate_actions(&ctx, ofp_actions, n_ofp_actions);
3876         dpif_execute(ofproto->dpif, key.data, key.size,
3877                      odp_actions->data, odp_actions->size, packet);
3878         ofpbuf_delete(odp_actions);
3879     }
3880     return error;
3881 }
3882
3883 static void
3884 get_netflow_ids(const struct ofproto *ofproto_,
3885                 uint8_t *engine_type, uint8_t *engine_id)
3886 {
3887     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
3888
3889     dpif_get_netflow_ids(ofproto->dpif, engine_type, engine_id);
3890 }
3891 \f
3892 static struct ofproto_dpif *
3893 ofproto_dpif_lookup(const char *name)
3894 {
3895     struct ofproto *ofproto = ofproto_lookup(name);
3896     return (ofproto && ofproto->ofproto_class == &ofproto_dpif_class
3897             ? ofproto_dpif_cast(ofproto)
3898             : NULL);
3899 }
3900
3901 static void
3902 ofproto_unixctl_fdb_show(struct unixctl_conn *conn,
3903                          const char *args, void *aux OVS_UNUSED)
3904 {
3905     struct ds ds = DS_EMPTY_INITIALIZER;
3906     const struct ofproto_dpif *ofproto;
3907     const struct mac_entry *e;
3908
3909     ofproto = ofproto_dpif_lookup(args);
3910     if (!ofproto) {
3911         unixctl_command_reply(conn, 501, "no such bridge");
3912         return;
3913     }
3914
3915     ds_put_cstr(&ds, " port  VLAN  MAC                Age\n");
3916     LIST_FOR_EACH (e, lru_node, &ofproto->ml->lrus) {
3917         struct ofbundle *bundle = e->port.p;
3918         ds_put_format(&ds, "%5d  %4d  "ETH_ADDR_FMT"  %3d\n",
3919                       ofbundle_get_a_port(bundle)->odp_port,
3920                       e->vlan, ETH_ADDR_ARGS(e->mac), mac_entry_age(e));
3921     }
3922     unixctl_command_reply(conn, 200, ds_cstr(&ds));
3923     ds_destroy(&ds);
3924 }
3925
3926 struct ofproto_trace {
3927     struct action_xlate_ctx ctx;
3928     struct flow flow;
3929     struct ds *result;
3930 };
3931
3932 static void
3933 trace_format_rule(struct ds *result, int level, const struct rule *rule)
3934 {
3935     ds_put_char_multiple(result, '\t', level);
3936     if (!rule) {
3937         ds_put_cstr(result, "No match\n");
3938         return;
3939     }
3940
3941     ds_put_format(result, "Rule: cookie=%#"PRIx64" ",
3942                   ntohll(rule->flow_cookie));
3943     cls_rule_format(&rule->cr, result);
3944     ds_put_char(result, '\n');
3945
3946     ds_put_char_multiple(result, '\t', level);
3947     ds_put_cstr(result, "OpenFlow ");
3948     ofp_print_actions(result, rule->actions, rule->n_actions);
3949     ds_put_char(result, '\n');
3950 }
3951
3952 static void
3953 trace_format_flow(struct ds *result, int level, const char *title,
3954                  struct ofproto_trace *trace)
3955 {
3956     ds_put_char_multiple(result, '\t', level);
3957     ds_put_format(result, "%s: ", title);
3958     if (flow_equal(&trace->ctx.flow, &trace->flow)) {
3959         ds_put_cstr(result, "unchanged");
3960     } else {
3961         flow_format(result, &trace->ctx.flow);
3962         trace->flow = trace->ctx.flow;
3963     }
3964     ds_put_char(result, '\n');
3965 }
3966
3967 static void
3968 trace_resubmit(struct action_xlate_ctx *ctx, struct rule_dpif *rule)
3969 {
3970     struct ofproto_trace *trace = CONTAINER_OF(ctx, struct ofproto_trace, ctx);
3971     struct ds *result = trace->result;
3972
3973     ds_put_char(result, '\n');
3974     trace_format_flow(result, ctx->recurse + 1, "Resubmitted flow", trace);
3975     trace_format_rule(result, ctx->recurse + 1, &rule->up);
3976 }
3977
3978 static void
3979 ofproto_unixctl_trace(struct unixctl_conn *conn, const char *args_,
3980                       void *aux OVS_UNUSED)
3981 {
3982     char *dpname, *in_port_s, *tun_id_s, *packet_s;
3983     char *args = xstrdup(args_);
3984     char *save_ptr = NULL;
3985     struct ofproto_dpif *ofproto;
3986     struct ofpbuf packet;
3987     struct rule_dpif *rule;
3988     struct ds result;
3989     struct flow flow;
3990     uint16_t in_port;
3991     ovs_be64 tun_id;
3992     char *s;
3993
3994     ofpbuf_init(&packet, strlen(args) / 2);
3995     ds_init(&result);
3996
3997     dpname = strtok_r(args, " ", &save_ptr);
3998     tun_id_s = strtok_r(NULL, " ", &save_ptr);
3999     in_port_s = strtok_r(NULL, " ", &save_ptr);
4000     packet_s = strtok_r(NULL, "", &save_ptr); /* Get entire rest of line. */
4001     if (!dpname || !in_port_s || !packet_s) {
4002         unixctl_command_reply(conn, 501, "Bad command syntax");
4003         goto exit;
4004     }
4005
4006     ofproto = ofproto_dpif_lookup(dpname);
4007     if (!ofproto) {
4008         unixctl_command_reply(conn, 501, "Unknown ofproto (use ofproto/list "
4009                               "for help)");
4010         goto exit;
4011     }
4012
4013     tun_id = htonll(strtoull(tun_id_s, NULL, 0));
4014     in_port = ofp_port_to_odp_port(atoi(in_port_s));
4015
4016     packet_s = ofpbuf_put_hex(&packet, packet_s, NULL);
4017     packet_s += strspn(packet_s, " ");
4018     if (*packet_s != '\0') {
4019         unixctl_command_reply(conn, 501, "Trailing garbage in command");
4020         goto exit;
4021     }
4022     if (packet.size < ETH_HEADER_LEN) {
4023         unixctl_command_reply(conn, 501, "Packet data too short for Ethernet");
4024         goto exit;
4025     }
4026
4027     ds_put_cstr(&result, "Packet: ");
4028     s = ofp_packet_to_string(packet.data, packet.size, packet.size);
4029     ds_put_cstr(&result, s);
4030     free(s);
4031
4032     flow_extract(&packet, tun_id, in_port, &flow);
4033     ds_put_cstr(&result, "Flow: ");
4034     flow_format(&result, &flow);
4035     ds_put_char(&result, '\n');
4036
4037     rule = rule_dpif_lookup(ofproto, &flow);
4038     trace_format_rule(&result, 0, &rule->up);
4039     if (rule) {
4040         struct ofproto_trace trace;
4041         struct ofpbuf *odp_actions;
4042
4043         trace.result = &result;
4044         trace.flow = flow;
4045         action_xlate_ctx_init(&trace.ctx, ofproto, &flow, &packet);
4046         trace.ctx.resubmit_hook = trace_resubmit;
4047         odp_actions = xlate_actions(&trace.ctx,
4048                                     rule->up.actions, rule->up.n_actions);
4049
4050         ds_put_char(&result, '\n');
4051         trace_format_flow(&result, 0, "Final flow", &trace);
4052         ds_put_cstr(&result, "Datapath actions: ");
4053         format_odp_actions(&result, odp_actions->data, odp_actions->size);
4054         ofpbuf_delete(odp_actions);
4055     }
4056
4057     unixctl_command_reply(conn, 200, ds_cstr(&result));
4058
4059 exit:
4060     ds_destroy(&result);
4061     ofpbuf_uninit(&packet);
4062     free(args);
4063 }
4064
4065 static void
4066 ofproto_dpif_clog(struct unixctl_conn *conn OVS_UNUSED,
4067                   const char *args_ OVS_UNUSED, void *aux OVS_UNUSED)
4068 {
4069     clogged = true;
4070     unixctl_command_reply(conn, 200, NULL);
4071 }
4072
4073 static void
4074 ofproto_dpif_unclog(struct unixctl_conn *conn OVS_UNUSED,
4075                     const char *args_ OVS_UNUSED, void *aux OVS_UNUSED)
4076 {
4077     clogged = false;
4078     unixctl_command_reply(conn, 200, NULL);
4079 }
4080
4081 static void
4082 ofproto_dpif_unixctl_init(void)
4083 {
4084     static bool registered;
4085     if (registered) {
4086         return;
4087     }
4088     registered = true;
4089
4090     unixctl_command_register("ofproto/trace", ofproto_unixctl_trace, NULL);
4091     unixctl_command_register("fdb/show", ofproto_unixctl_fdb_show, NULL);
4092
4093     unixctl_command_register("ofproto/clog", ofproto_dpif_clog, NULL);
4094     unixctl_command_register("ofproto/unclog", ofproto_dpif_unclog, NULL);
4095 }
4096 \f
4097 const struct ofproto_class ofproto_dpif_class = {
4098     enumerate_types,
4099     enumerate_names,
4100     del,
4101     alloc,
4102     construct,
4103     destruct,
4104     dealloc,
4105     run,
4106     wait,
4107     flush,
4108     get_features,
4109     get_tables,
4110     port_alloc,
4111     port_construct,
4112     port_destruct,
4113     port_dealloc,
4114     port_modified,
4115     port_reconfigured,
4116     port_query_by_name,
4117     port_add,
4118     port_del,
4119     port_dump_start,
4120     port_dump_next,
4121     port_dump_done,
4122     port_poll,
4123     port_poll_wait,
4124     port_is_lacp_current,
4125     NULL,                       /* rule_choose_table */
4126     rule_alloc,
4127     rule_construct,
4128     rule_destruct,
4129     rule_dealloc,
4130     rule_get_stats,
4131     rule_execute,
4132     rule_modify_actions,
4133     get_drop_frags,
4134     set_drop_frags,
4135     packet_out,
4136     set_netflow,
4137     get_netflow_ids,
4138     set_sflow,
4139     set_cfm,
4140     get_cfm_fault,
4141     bundle_set,
4142     bundle_remove,
4143     mirror_set,
4144     set_flood_vlans,
4145     is_mirror_output_bundle,
4146     forward_bpdu_changed,
4147 };