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