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