ofproto/ofproto-dpif.c

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