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 /* Sends an OFPT_PACKET_IN message for 'packet' of type OFPR_NO_MATCH to each
1719  * OpenFlow controller as necessary according to their individual
1720  * configurations.
1721  *
1722  * If 'clone' is true, the caller retains ownership of 'packet'.  Otherwise,
1723  * ownership is transferred to this function. */
1724 static void
1725 send_packet_in_miss(struct ofproto_dpif *ofproto, struct ofpbuf *packet,
1726                     const struct flow *flow, bool clone)
1727 {
1728     struct ofputil_packet_in pin;
1729
1730     pin.packet = packet;
1731     pin.in_port = flow->in_port;
1732     pin.reason = OFPR_NO_MATCH;
1733     pin.buffer_id = 0;          /* not yet known */
1734     pin.send_len = 0;           /* not used for flow table misses */
1735     connmgr_send_packet_in(ofproto->up.connmgr, &pin, flow,
1736                            clone ? NULL : packet);
1737 }
1738
1739 /* Sends an OFPT_PACKET_IN message for 'packet' of type OFPR_ACTION to each
1740  * OpenFlow controller as necessary according to their individual
1741  * configurations.
1742  *
1743  * 'send_len' should be the number of bytes of 'packet' to send to the
1744  * controller, as specified in the action that caused the packet to be sent.
1745  *
1746  * If 'clone' is true, the caller retains ownership of 'upcall->packet'.
1747  * Otherwise, ownership is transferred to this function. */
1748 static void
1749 send_packet_in_action(struct ofproto_dpif *ofproto, struct ofpbuf *packet,
1750                       uint64_t userdata, const struct flow *flow, bool clone)
1751 {
1752     struct ofputil_packet_in pin;
1753     struct user_action_cookie cookie;
1754
1755     memcpy(&cookie, &userdata, sizeof(cookie));
1756
1757     pin.packet = packet;
1758     pin.in_port = flow->in_port;
1759     pin.reason = OFPR_ACTION;
1760     pin.buffer_id = 0;          /* not yet known */
1761     pin.send_len = cookie.data;
1762     connmgr_send_packet_in(ofproto->up.connmgr, &pin, flow,
1763                            clone ? NULL : packet);
1764 }
1765
1766 static bool
1767 process_special(struct ofproto_dpif *ofproto, const struct flow *flow,
1768                 const struct ofpbuf *packet)
1769 {
1770     struct ofport_dpif *ofport = get_ofp_port(ofproto, flow->in_port);
1771
1772     if (!ofport) {
1773         return false;
1774     }
1775
1776     if (ofport->cfm && cfm_should_process_flow(ofport->cfm, flow)) {
1777         if (packet) {
1778             cfm_process_heartbeat(ofport->cfm, packet);
1779         }
1780         return true;
1781     } else if (ofport->bundle && ofport->bundle->lacp
1782                && flow->dl_type == htons(ETH_TYPE_LACP)) {
1783         if (packet) {
1784             lacp_process_packet(ofport->bundle->lacp, ofport, packet);
1785         }
1786         return true;
1787     }
1788     return false;
1789 }
1790
1791 static void
1792 handle_miss_upcall(struct ofproto_dpif *ofproto, struct dpif_upcall *upcall)
1793 {
1794     struct facet *facet;
1795     struct flow flow;
1796
1797     /* Obtain in_port and tun_id, at least. */
1798     odp_flow_key_to_flow(upcall->key, upcall->key_len, &flow);
1799
1800     /* Set header pointers in 'flow'. */
1801     flow_extract(upcall->packet, flow.tun_id, flow.in_port, &flow);
1802
1803     /* Handle 802.1ag and LACP. */
1804     if (process_special(ofproto, &flow, upcall->packet)) {
1805         ofpbuf_delete(upcall->packet);
1806         ofproto->n_matches++;
1807         return;
1808     }
1809
1810     facet = facet_lookup_valid(ofproto, &flow);
1811     if (!facet) {
1812         struct rule_dpif *rule = rule_dpif_lookup(ofproto, &flow, 0);
1813         if (!rule) {
1814             /* Don't send a packet-in if OFPPC_NO_PACKET_IN asserted. */
1815             struct ofport_dpif *port = get_ofp_port(ofproto, flow.in_port);
1816             if (port) {
1817                 if (port->up.opp.config & htonl(OFPPC_NO_PACKET_IN)) {
1818                     COVERAGE_INC(ofproto_dpif_no_packet_in);
1819                     /* XXX install 'drop' flow entry */
1820                     ofpbuf_delete(upcall->packet);
1821                     return;
1822                 }
1823             } else {
1824                 VLOG_WARN_RL(&rl, "packet-in on unknown port %"PRIu16,
1825                              flow.in_port);
1826             }
1827
1828             send_packet_in_miss(ofproto, upcall->packet, &flow, false);
1829             return;
1830         }
1831
1832         facet = facet_create(rule, &flow, upcall->packet);
1833     } else if (!facet->may_install) {
1834         /* The facet is not installable, that is, we need to process every
1835          * packet, so process the current packet's actions into 'facet'. */
1836         facet_make_actions(ofproto, facet, upcall->packet);
1837     }
1838
1839     if (facet->rule->up.cr.priority == FAIL_OPEN_PRIORITY) {
1840         /*
1841          * Extra-special case for fail-open mode.
1842          *
1843          * We are in fail-open mode and the packet matched the fail-open rule,
1844          * but we are connected to a controller too.  We should send the packet
1845          * up to the controller in the hope that it will try to set up a flow
1846          * and thereby allow us to exit fail-open.
1847          *
1848          * See the top-level comment in fail-open.c for more information.
1849          */
1850         send_packet_in_miss(ofproto, upcall->packet, &flow, true);
1851     }
1852
1853     facet_execute(ofproto, facet, upcall->packet);
1854     facet_install(ofproto, facet, false);
1855     ofproto->n_matches++;
1856 }
1857
1858 static void
1859 handle_userspace_upcall(struct ofproto_dpif *ofproto,
1860                         struct dpif_upcall *upcall)
1861 {
1862     struct flow flow;
1863     struct user_action_cookie cookie;
1864
1865     memcpy(&cookie, &upcall->userdata, sizeof(cookie));
1866
1867     if (cookie.type == USER_ACTION_COOKIE_SFLOW) {
1868         if (ofproto->sflow) {
1869             odp_flow_key_to_flow(upcall->key, upcall->key_len, &flow);
1870             dpif_sflow_received(ofproto->sflow, upcall->packet, &flow, &cookie);
1871         }
1872         ofpbuf_delete(upcall->packet);
1873
1874     } else if (cookie.type == USER_ACTION_COOKIE_CONTROLLER) {
1875         COVERAGE_INC(ofproto_dpif_ctlr_action);
1876         odp_flow_key_to_flow(upcall->key, upcall->key_len, &flow);
1877         send_packet_in_action(ofproto, upcall->packet, upcall->userdata,
1878                               &flow, false);
1879     } else {
1880         VLOG_WARN_RL(&rl, "invalid user cookie : 0x%"PRIx64, upcall->userdata);
1881     }
1882 }
1883
1884 static void
1885 handle_upcall(struct ofproto_dpif *ofproto, struct dpif_upcall *upcall)
1886 {
1887     switch (upcall->type) {
1888     case DPIF_UC_ACTION:
1889         handle_userspace_upcall(ofproto, upcall);
1890         break;
1891
1892     case DPIF_UC_MISS:
1893         handle_miss_upcall(ofproto, upcall);
1894         break;
1895
1896     case DPIF_N_UC_TYPES:
1897     default:
1898         VLOG_WARN_RL(&rl, "upcall has unexpected type %"PRIu32, upcall->type);
1899         break;
1900     }
1901 }
1902 \f
1903 /* Flow expiration. */
1904
1905 static int facet_max_idle(const struct ofproto_dpif *);
1906 static void update_stats(struct ofproto_dpif *);
1907 static void rule_expire(struct rule_dpif *);
1908 static void expire_facets(struct ofproto_dpif *, int dp_max_idle);
1909
1910 /* This function is called periodically by run().  Its job is to collect
1911  * updates for the flows that have been installed into the datapath, most
1912  * importantly when they last were used, and then use that information to
1913  * expire flows that have not been used recently.
1914  *
1915  * Returns the number of milliseconds after which it should be called again. */
1916 static int
1917 expire(struct ofproto_dpif *ofproto)
1918 {
1919     struct rule_dpif *rule, *next_rule;
1920     struct classifier *table;
1921     int dp_max_idle;
1922
1923     /* Update stats for each flow in the datapath. */
1924     update_stats(ofproto);
1925
1926     /* Expire facets that have been idle too long. */
1927     dp_max_idle = facet_max_idle(ofproto);
1928     expire_facets(ofproto, dp_max_idle);
1929
1930     /* Expire OpenFlow flows whose idle_timeout or hard_timeout has passed. */
1931     OFPROTO_FOR_EACH_TABLE (table, &ofproto->up) {
1932         struct cls_cursor cursor;
1933
1934         cls_cursor_init(&cursor, table, NULL);
1935         CLS_CURSOR_FOR_EACH_SAFE (rule, next_rule, up.cr, &cursor) {
1936             rule_expire(rule);
1937         }
1938     }
1939
1940     /* All outstanding data in existing flows has been accounted, so it's a
1941      * good time to do bond rebalancing. */
1942     if (ofproto->has_bonded_bundles) {
1943         struct ofbundle *bundle;
1944
1945         HMAP_FOR_EACH (bundle, hmap_node, &ofproto->bundles) {
1946             if (bundle->bond) {
1947                 bond_rebalance(bundle->bond, &ofproto->revalidate_set);
1948             }
1949         }
1950     }
1951
1952     return MIN(dp_max_idle, 1000);
1953 }
1954
1955 /* Update 'packet_count', 'byte_count', and 'used' members of installed facets.
1956  *
1957  * This function also pushes statistics updates to rules which each facet
1958  * resubmits into.  Generally these statistics will be accurate.  However, if a
1959  * facet changes the rule it resubmits into at some time in between
1960  * update_stats() runs, it is possible that statistics accrued to the
1961  * old rule will be incorrectly attributed to the new rule.  This could be
1962  * avoided by calling update_stats() whenever rules are created or
1963  * deleted.  However, the performance impact of making so many calls to the
1964  * datapath do not justify the benefit of having perfectly accurate statistics.
1965  */
1966 static void
1967 update_stats(struct ofproto_dpif *p)
1968 {
1969     const struct dpif_flow_stats *stats;
1970     struct dpif_flow_dump dump;
1971     const struct nlattr *key;
1972     size_t key_len;
1973
1974     dpif_flow_dump_start(&dump, p->dpif);
1975     while (dpif_flow_dump_next(&dump, &key, &key_len, NULL, NULL, &stats)) {
1976         struct facet *facet;
1977         struct flow flow;
1978
1979         if (odp_flow_key_to_flow(key, key_len, &flow)) {
1980             struct ds s;
1981
1982             ds_init(&s);
1983             odp_flow_key_format(key, key_len, &s);
1984             VLOG_WARN_RL(&rl, "failed to convert datapath flow key to flow: %s",
1985                          ds_cstr(&s));
1986             ds_destroy(&s);
1987
1988             continue;
1989         }
1990         facet = facet_find(p, &flow);
1991
1992         if (facet && facet->installed) {
1993
1994             if (stats->n_packets >= facet->dp_packet_count) {
1995                 uint64_t extra = stats->n_packets - facet->dp_packet_count;
1996                 facet->packet_count += extra;
1997             } else {
1998                 VLOG_WARN_RL(&rl, "unexpected packet count from the datapath");
1999             }
2000
2001             if (stats->n_bytes >= facet->dp_byte_count) {
2002                 facet->byte_count += stats->n_bytes - facet->dp_byte_count;
2003             } else {
2004                 VLOG_WARN_RL(&rl, "unexpected byte count from datapath");
2005             }
2006
2007             facet->dp_packet_count = stats->n_packets;
2008             facet->dp_byte_count = stats->n_bytes;
2009
2010             facet_update_time(p, facet, stats->used);
2011             facet_account(p, facet);
2012             facet_push_stats(facet);
2013         } else {
2014             /* There's a flow in the datapath that we know nothing about.
2015              * Delete it. */
2016             COVERAGE_INC(facet_unexpected);
2017             dpif_flow_del(p->dpif, key, key_len, NULL);
2018         }
2019     }
2020     dpif_flow_dump_done(&dump);
2021 }
2022
2023 /* Calculates and returns the number of milliseconds of idle time after which
2024  * facets should expire from the datapath and we should fold their statistics
2025  * into their parent rules in userspace. */
2026 static int
2027 facet_max_idle(const struct ofproto_dpif *ofproto)
2028 {
2029     /*
2030      * Idle time histogram.
2031      *
2032      * Most of the time a switch has a relatively small number of facets.  When
2033      * this is the case we might as well keep statistics for all of them in
2034      * userspace and to cache them in the kernel datapath for performance as
2035      * well.
2036      *
2037      * As the number of facets increases, the memory required to maintain
2038      * statistics about them in userspace and in the kernel becomes
2039      * significant.  However, with a large number of facets it is likely that
2040      * only a few of them are "heavy hitters" that consume a large amount of
2041      * bandwidth.  At this point, only heavy hitters are worth caching in the
2042      * kernel and maintaining in userspaces; other facets we can discard.
2043      *
2044      * The technique used to compute the idle time is to build a histogram with
2045      * N_BUCKETS buckets whose width is BUCKET_WIDTH msecs each.  Each facet
2046      * that is installed in the kernel gets dropped in the appropriate bucket.
2047      * After the histogram has been built, we compute the cutoff so that only
2048      * the most-recently-used 1% of facets (but at least
2049      * ofproto->up.flow_eviction_threshold flows) are kept cached.  At least
2050      * the most-recently-used bucket of facets is kept, so actually an
2051      * arbitrary number of facets can be kept in any given expiration run
2052      * (though the next run will delete most of those unless they receive
2053      * additional data).
2054      *
2055      * This requires a second pass through the facets, in addition to the pass
2056      * made by update_stats(), because the former function never looks
2057      * at uninstallable facets.
2058      */
2059     enum { BUCKET_WIDTH = ROUND_UP(100, TIME_UPDATE_INTERVAL) };
2060     enum { N_BUCKETS = 5000 / BUCKET_WIDTH };
2061     int buckets[N_BUCKETS] = { 0 };
2062     int total, subtotal, bucket;
2063     struct facet *facet;
2064     long long int now;
2065     int i;
2066
2067     total = hmap_count(&ofproto->facets);
2068     if (total <= ofproto->up.flow_eviction_threshold) {
2069         return N_BUCKETS * BUCKET_WIDTH;
2070     }
2071
2072     /* Build histogram. */
2073     now = time_msec();
2074     HMAP_FOR_EACH (facet, hmap_node, &ofproto->facets) {
2075         long long int idle = now - facet->used;
2076         int bucket = (idle <= 0 ? 0
2077                       : idle >= BUCKET_WIDTH * N_BUCKETS ? N_BUCKETS - 1
2078                       : (unsigned int) idle / BUCKET_WIDTH);
2079         buckets[bucket]++;
2080     }
2081
2082     /* Find the first bucket whose flows should be expired. */
2083     subtotal = bucket = 0;
2084     do {
2085         subtotal += buckets[bucket++];
2086     } while (bucket < N_BUCKETS &&
2087              subtotal < MAX(ofproto->up.flow_eviction_threshold, total / 100));
2088
2089     if (VLOG_IS_DBG_ENABLED()) {
2090         struct ds s;
2091
2092         ds_init(&s);
2093         ds_put_cstr(&s, "keep");
2094         for (i = 0; i < N_BUCKETS; i++) {
2095             if (i == bucket) {
2096                 ds_put_cstr(&s, ", drop");
2097             }
2098             if (buckets[i]) {
2099                 ds_put_format(&s, " %d:%d", i * BUCKET_WIDTH, buckets[i]);
2100             }
2101         }
2102         VLOG_INFO("%s: %s (msec:count)", ofproto->up.name, ds_cstr(&s));
2103         ds_destroy(&s);
2104     }
2105
2106     return bucket * BUCKET_WIDTH;
2107 }
2108
2109 static void
2110 facet_active_timeout(struct ofproto_dpif *ofproto, struct facet *facet)
2111 {
2112     if (ofproto->netflow && !facet_is_controller_flow(facet) &&
2113         netflow_active_timeout_expired(ofproto->netflow, &facet->nf_flow)) {
2114         struct ofexpired expired;
2115
2116         if (facet->installed) {
2117             struct dpif_flow_stats stats;
2118
2119             facet_put__(ofproto, facet, facet->actions, facet->actions_len,
2120                         &stats);
2121             facet_update_stats(ofproto, facet, &stats);
2122         }
2123
2124         expired.flow = facet->flow;
2125         expired.packet_count = facet->packet_count;
2126         expired.byte_count = facet->byte_count;
2127         expired.used = facet->used;
2128         netflow_expire(ofproto->netflow, &facet->nf_flow, &expired);
2129     }
2130 }
2131
2132 static void
2133 expire_facets(struct ofproto_dpif *ofproto, int dp_max_idle)
2134 {
2135     long long int cutoff = time_msec() - dp_max_idle;
2136     struct facet *facet, *next_facet;
2137
2138     HMAP_FOR_EACH_SAFE (facet, next_facet, hmap_node, &ofproto->facets) {
2139         facet_active_timeout(ofproto, facet);
2140         if (facet->used < cutoff) {
2141             facet_remove(ofproto, facet);
2142         }
2143     }
2144 }
2145
2146 /* If 'rule' is an OpenFlow rule, that has expired according to OpenFlow rules,
2147  * then delete it entirely. */
2148 static void
2149 rule_expire(struct rule_dpif *rule)
2150 {
2151     struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
2152     struct facet *facet, *next_facet;
2153     long long int now;
2154     uint8_t reason;
2155
2156     /* Has 'rule' expired? */
2157     now = time_msec();
2158     if (rule->up.hard_timeout
2159         && now > rule->up.modified + rule->up.hard_timeout * 1000) {
2160         reason = OFPRR_HARD_TIMEOUT;
2161     } else if (rule->up.idle_timeout && list_is_empty(&rule->facets)
2162                && now > rule->used + rule->up.idle_timeout * 1000) {
2163         reason = OFPRR_IDLE_TIMEOUT;
2164     } else {
2165         return;
2166     }
2167
2168     COVERAGE_INC(ofproto_dpif_expired);
2169
2170     /* Update stats.  (This is a no-op if the rule expired due to an idle
2171      * timeout, because that only happens when the rule has no facets left.) */
2172     LIST_FOR_EACH_SAFE (facet, next_facet, list_node, &rule->facets) {
2173         facet_remove(ofproto, facet);
2174     }
2175
2176     /* Get rid of the rule. */
2177     ofproto_rule_expire(&rule->up, reason);
2178 }
2179 \f
2180 /* Facets. */
2181
2182 /* Creates and returns a new facet owned by 'rule', given a 'flow' and an
2183  * example 'packet' within that flow.
2184  *
2185  * The caller must already have determined that no facet with an identical
2186  * 'flow' exists in 'ofproto' and that 'flow' is the best match for 'rule' in
2187  * the ofproto's classifier table. */
2188 static struct facet *
2189 facet_create(struct rule_dpif *rule, const struct flow *flow,
2190              const struct ofpbuf *packet)
2191 {
2192     struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
2193     struct facet *facet;
2194
2195     facet = xzalloc(sizeof *facet);
2196     facet->used = time_msec();
2197     hmap_insert(&ofproto->facets, &facet->hmap_node, flow_hash(flow, 0));
2198     list_push_back(&rule->facets, &facet->list_node);
2199     facet->rule = rule;
2200     facet->flow = *flow;
2201     netflow_flow_init(&facet->nf_flow);
2202     netflow_flow_update_time(ofproto->netflow, &facet->nf_flow, facet->used);
2203
2204     facet_make_actions(ofproto, facet, packet);
2205
2206     return facet;
2207 }
2208
2209 static void
2210 facet_free(struct facet *facet)
2211 {
2212     free(facet->actions);
2213     free(facet);
2214 }
2215
2216 /* Executes, within 'ofproto', the 'n_actions' actions in 'actions' on
2217  * 'packet', which arrived on 'in_port'.
2218  *
2219  * Takes ownership of 'packet'. */
2220 static bool
2221 execute_odp_actions(struct ofproto_dpif *ofproto, const struct flow *flow,
2222                     const struct nlattr *odp_actions, size_t actions_len,
2223                     struct ofpbuf *packet)
2224 {
2225     struct odputil_keybuf keybuf;
2226     struct ofpbuf key;
2227     int error;
2228
2229     if (actions_len == 0) {
2230         return true;
2231     } else if (odp_actions->nla_type == OVS_ACTION_ATTR_USERSPACE
2232                && NLA_ALIGN(odp_actions->nla_len) == actions_len) {
2233         /* As an optimization, avoid a round-trip from userspace to kernel to
2234          * userspace.  This also avoids possibly filling up kernel packet
2235          * buffers along the way.
2236          *
2237          * This optimization will not accidentally catch sFlow
2238          * OVS_ACTION_ATTR_USERSPACE actions, since those are encapsulated
2239          * inside OVS_ACTION_ATTR_SAMPLE. */
2240         const struct nlattr *nla;
2241
2242         nla = nl_attr_find_nested(odp_actions, OVS_USERSPACE_ATTR_USERDATA);
2243         send_packet_in_action(ofproto, packet, nl_attr_get_u64(nla), flow,
2244                               false);
2245         return true;
2246     }
2247
2248     ofpbuf_use_stack(&key, &keybuf, sizeof keybuf);
2249     odp_flow_key_from_flow(&key, flow);
2250
2251     error = dpif_execute(ofproto->dpif, key.data, key.size,
2252                          odp_actions, actions_len, packet);
2253
2254     ofpbuf_delete(packet);
2255     return !error;
2256 }
2257
2258 /* Executes the actions indicated by 'facet' on 'packet' and credits 'facet''s
2259  * statistics appropriately.  'packet' must have at least sizeof(struct
2260  * ofp_packet_in) bytes of headroom.
2261  *
2262  * For correct results, 'packet' must actually be in 'facet''s flow; that is,
2263  * applying flow_extract() to 'packet' would yield the same flow as
2264  * 'facet->flow'.
2265  *
2266  * 'facet' must have accurately composed datapath actions; that is, it must
2267  * not be in need of revalidation.
2268  *
2269  * Takes ownership of 'packet'. */
2270 static void
2271 facet_execute(struct ofproto_dpif *ofproto, struct facet *facet,
2272               struct ofpbuf *packet)
2273 {
2274     struct dpif_flow_stats stats;
2275
2276     assert(ofpbuf_headroom(packet) >= sizeof(struct ofp_packet_in));
2277
2278     dpif_flow_stats_extract(&facet->flow, packet, &stats);
2279     stats.used = time_msec();
2280     if (execute_odp_actions(ofproto, &facet->flow,
2281                             facet->actions, facet->actions_len, packet)) {
2282         facet_update_stats(ofproto, facet, &stats);
2283     }
2284 }
2285
2286 /* Remove 'facet' from 'ofproto' and free up the associated memory:
2287  *
2288  *   - If 'facet' was installed in the datapath, uninstalls it and updates its
2289  *     rule's statistics, via facet_uninstall().
2290  *
2291  *   - Removes 'facet' from its rule and from ofproto->facets.
2292  */
2293 static void
2294 facet_remove(struct ofproto_dpif *ofproto, struct facet *facet)
2295 {
2296     facet_uninstall(ofproto, facet);
2297     facet_flush_stats(ofproto, facet);
2298     hmap_remove(&ofproto->facets, &facet->hmap_node);
2299     list_remove(&facet->list_node);
2300     facet_free(facet);
2301 }
2302
2303 /* Composes the datapath actions for 'facet' based on its rule's actions. */
2304 static void
2305 facet_make_actions(struct ofproto_dpif *p, struct facet *facet,
2306                    const struct ofpbuf *packet)
2307 {
2308     const struct rule_dpif *rule = facet->rule;
2309     struct ofpbuf *odp_actions;
2310     struct action_xlate_ctx ctx;
2311
2312     action_xlate_ctx_init(&ctx, p, &facet->flow, packet);
2313     odp_actions = xlate_actions(&ctx, rule->up.actions, rule->up.n_actions);
2314     facet->tags = ctx.tags;
2315     facet->may_install = ctx.may_set_up_flow;
2316     facet->has_learn = ctx.has_learn;
2317     facet->has_normal = ctx.has_normal;
2318     facet->nf_flow.output_iface = ctx.nf_output_iface;
2319
2320     if (facet->actions_len != odp_actions->size
2321         || memcmp(facet->actions, odp_actions->data, odp_actions->size)) {
2322         free(facet->actions);
2323         facet->actions_len = odp_actions->size;
2324         facet->actions = xmemdup(odp_actions->data, odp_actions->size);
2325     }
2326
2327     ofpbuf_delete(odp_actions);
2328 }
2329
2330 /* Updates 'facet''s flow in the datapath setting its actions to 'actions_len'
2331  * bytes of actions in 'actions'.  If 'stats' is non-null, statistics counters
2332  * in the datapath will be zeroed and 'stats' will be updated with traffic new
2333  * since 'facet' was last updated.
2334  *
2335  * Returns 0 if successful, otherwise a positive errno value.*/
2336 static int
2337 facet_put__(struct ofproto_dpif *ofproto, struct facet *facet,
2338             const struct nlattr *actions, size_t actions_len,
2339             struct dpif_flow_stats *stats)
2340 {
2341     struct odputil_keybuf keybuf;
2342     enum dpif_flow_put_flags flags;
2343     struct ofpbuf key;
2344     int ret;
2345
2346     flags = DPIF_FP_CREATE | DPIF_FP_MODIFY;
2347     if (stats) {
2348         flags |= DPIF_FP_ZERO_STATS;
2349     }
2350
2351     ofpbuf_use_stack(&key, &keybuf, sizeof keybuf);
2352     odp_flow_key_from_flow(&key, &facet->flow);
2353
2354     ret = dpif_flow_put(ofproto->dpif, flags, key.data, key.size,
2355                         actions, actions_len, stats);
2356
2357     if (stats) {
2358         facet_reset_dp_stats(facet, stats);
2359     }
2360
2361     return ret;
2362 }
2363
2364 /* If 'facet' is installable, inserts or re-inserts it into 'p''s datapath.  If
2365  * 'zero_stats' is true, clears any existing statistics from the datapath for
2366  * 'facet'. */
2367 static void
2368 facet_install(struct ofproto_dpif *p, struct facet *facet, bool zero_stats)
2369 {
2370     struct dpif_flow_stats stats;
2371
2372     if (facet->may_install
2373         && !facet_put__(p, facet, facet->actions, facet->actions_len,
2374                         zero_stats ? &stats : NULL)) {
2375         facet->installed = true;
2376     }
2377 }
2378
2379 static void
2380 facet_account(struct ofproto_dpif *ofproto, struct facet *facet)
2381 {
2382     uint64_t n_bytes;
2383     const struct nlattr *a;
2384     unsigned int left;
2385     ovs_be16 vlan_tci;
2386
2387     if (facet->byte_count <= facet->accounted_bytes) {
2388         return;
2389     }
2390     n_bytes = facet->byte_count - facet->accounted_bytes;
2391     facet->accounted_bytes = facet->byte_count;
2392
2393     /* Feed information from the active flows back into the learning table to
2394      * ensure that table is always in sync with what is actually flowing
2395      * through the datapath. */
2396     if (facet->has_learn || facet->has_normal) {
2397         struct action_xlate_ctx ctx;
2398
2399         action_xlate_ctx_init(&ctx, ofproto, &facet->flow, NULL);
2400         ctx.may_learn = true;
2401         ofpbuf_delete(xlate_actions(&ctx, facet->rule->up.actions,
2402                                     facet->rule->up.n_actions));
2403     }
2404
2405     if (!facet->has_normal || !ofproto->has_bonded_bundles) {
2406         return;
2407     }
2408
2409     /* This loop feeds byte counters to bond_account() for rebalancing to use
2410      * as a basis.  We also need to track the actual VLAN on which the packet
2411      * is going to be sent to ensure that it matches the one passed to
2412      * bond_choose_output_slave().  (Otherwise, we will account to the wrong
2413      * hash bucket.) */
2414     vlan_tci = facet->flow.vlan_tci;
2415     NL_ATTR_FOR_EACH_UNSAFE (a, left, facet->actions, facet->actions_len) {
2416         struct ofport_dpif *port;
2417
2418         switch (nl_attr_type(a)) {
2419         case OVS_ACTION_ATTR_OUTPUT:
2420             port = get_odp_port(ofproto, nl_attr_get_u32(a));
2421             if (port && port->bundle && port->bundle->bond) {
2422                 bond_account(port->bundle->bond, &facet->flow,
2423                              vlan_tci_to_vid(vlan_tci), n_bytes);
2424             }
2425             break;
2426
2427         case OVS_ACTION_ATTR_POP_VLAN:
2428             vlan_tci = htons(0);
2429             break;
2430
2431         case OVS_ACTION_ATTR_PUSH_VLAN:
2432             vlan_tci = nl_attr_get_be16(a);
2433             break;
2434         }
2435     }
2436 }
2437
2438 /* If 'rule' is installed in the datapath, uninstalls it. */
2439 static void
2440 facet_uninstall(struct ofproto_dpif *p, struct facet *facet)
2441 {
2442     if (facet->installed) {
2443         struct odputil_keybuf keybuf;
2444         struct dpif_flow_stats stats;
2445         struct ofpbuf key;
2446         int error;
2447
2448         ofpbuf_use_stack(&key, &keybuf, sizeof keybuf);
2449         odp_flow_key_from_flow(&key, &facet->flow);
2450
2451         error = dpif_flow_del(p->dpif, key.data, key.size, &stats);
2452         facet_reset_dp_stats(facet, &stats);
2453         if (!error) {
2454             facet_update_stats(p, facet, &stats);
2455         }
2456         facet->installed = false;
2457     } else {
2458         assert(facet->dp_packet_count == 0);
2459         assert(facet->dp_byte_count == 0);
2460     }
2461 }
2462
2463 /* Returns true if the only action for 'facet' is to send to the controller.
2464  * (We don't report NetFlow expiration messages for such facets because they
2465  * are just part of the control logic for the network, not real traffic). */
2466 static bool
2467 facet_is_controller_flow(struct facet *facet)
2468 {
2469     return (facet
2470             && facet->rule->up.n_actions == 1
2471             && action_outputs_to_port(&facet->rule->up.actions[0],
2472                                       htons(OFPP_CONTROLLER)));
2473 }
2474
2475 /* Resets 'facet''s datapath statistics counters.  This should be called when
2476  * 'facet''s statistics are cleared in the datapath.  If 'stats' is non-null,
2477  * it should contain the statistics returned by dpif when 'facet' was reset in
2478  * the datapath.  'stats' will be modified to only included statistics new
2479  * since 'facet' was last updated. */
2480 static void
2481 facet_reset_dp_stats(struct facet *facet, struct dpif_flow_stats *stats)
2482 {
2483     if (stats && facet->dp_packet_count <= stats->n_packets
2484         && facet->dp_byte_count <= stats->n_bytes) {
2485         stats->n_packets -= facet->dp_packet_count;
2486         stats->n_bytes -= facet->dp_byte_count;
2487     }
2488
2489     facet->dp_packet_count = 0;
2490     facet->dp_byte_count = 0;
2491 }
2492
2493 /* Folds all of 'facet''s statistics into its rule.  Also updates the
2494  * accounting ofhook and emits a NetFlow expiration if appropriate.  All of
2495  * 'facet''s statistics in the datapath should have been zeroed and folded into
2496  * its packet and byte counts before this function is called. */
2497 static void
2498 facet_flush_stats(struct ofproto_dpif *ofproto, struct facet *facet)
2499 {
2500     assert(!facet->dp_byte_count);
2501     assert(!facet->dp_packet_count);
2502
2503     facet_push_stats(facet);
2504     facet_account(ofproto, facet);
2505
2506     if (ofproto->netflow && !facet_is_controller_flow(facet)) {
2507         struct ofexpired expired;
2508         expired.flow = facet->flow;
2509         expired.packet_count = facet->packet_count;
2510         expired.byte_count = facet->byte_count;
2511         expired.used = facet->used;
2512         netflow_expire(ofproto->netflow, &facet->nf_flow, &expired);
2513     }
2514
2515     facet->rule->packet_count += facet->packet_count;
2516     facet->rule->byte_count += facet->byte_count;
2517
2518     /* Reset counters to prevent double counting if 'facet' ever gets
2519      * reinstalled. */
2520     facet_reset_counters(facet);
2521
2522     netflow_flow_clear(&facet->nf_flow);
2523 }
2524
2525 /* Searches 'ofproto''s table of facets for one exactly equal to 'flow'.
2526  * Returns it if found, otherwise a null pointer.
2527  *
2528  * The returned facet might need revalidation; use facet_lookup_valid()
2529  * instead if that is important. */
2530 static struct facet *
2531 facet_find(struct ofproto_dpif *ofproto, const struct flow *flow)
2532 {
2533     struct facet *facet;
2534
2535     HMAP_FOR_EACH_WITH_HASH (facet, hmap_node, flow_hash(flow, 0),
2536                              &ofproto->facets) {
2537         if (flow_equal(flow, &facet->flow)) {
2538             return facet;
2539         }
2540     }
2541
2542     return NULL;
2543 }
2544
2545 /* Searches 'ofproto''s table of facets for one exactly equal to 'flow'.
2546  * Returns it if found, otherwise a null pointer.
2547  *
2548  * The returned facet is guaranteed to be valid. */
2549 static struct facet *
2550 facet_lookup_valid(struct ofproto_dpif *ofproto, const struct flow *flow)
2551 {
2552     struct facet *facet = facet_find(ofproto, flow);
2553
2554     /* The facet we found might not be valid, since we could be in need of
2555      * revalidation.  If it is not valid, don't return it. */
2556     if (facet
2557         && (ofproto->need_revalidate
2558             || tag_set_intersects(&ofproto->revalidate_set, facet->tags))
2559         && !facet_revalidate(ofproto, facet)) {
2560         COVERAGE_INC(facet_invalidated);
2561         return NULL;
2562     }
2563
2564     return facet;
2565 }
2566
2567 /* Re-searches 'ofproto''s classifier for a rule matching 'facet':
2568  *
2569  *   - If the rule found is different from 'facet''s current rule, moves
2570  *     'facet' to the new rule and recompiles its actions.
2571  *
2572  *   - If the rule found is the same as 'facet''s current rule, leaves 'facet'
2573  *     where it is and recompiles its actions anyway.
2574  *
2575  *   - If there is none, destroys 'facet'.
2576  *
2577  * Returns true if 'facet' still exists, false if it has been destroyed. */
2578 static bool
2579 facet_revalidate(struct ofproto_dpif *ofproto, struct facet *facet)
2580 {
2581     struct action_xlate_ctx ctx;
2582     struct ofpbuf *odp_actions;
2583     struct rule_dpif *new_rule;
2584     bool actions_changed;
2585
2586     COVERAGE_INC(facet_revalidate);
2587
2588     /* Determine the new rule. */
2589     new_rule = rule_dpif_lookup(ofproto, &facet->flow, 0);
2590     if (!new_rule) {
2591         /* No new rule, so delete the facet. */
2592         facet_remove(ofproto, facet);
2593         return false;
2594     }
2595
2596     /* Calculate new datapath actions.
2597      *
2598      * We do not modify any 'facet' state yet, because we might need to, e.g.,
2599      * emit a NetFlow expiration and, if so, we need to have the old state
2600      * around to properly compose it. */
2601     action_xlate_ctx_init(&ctx, ofproto, &facet->flow, NULL);
2602     odp_actions = xlate_actions(&ctx,
2603                                 new_rule->up.actions, new_rule->up.n_actions);
2604     actions_changed = (facet->actions_len != odp_actions->size
2605                        || memcmp(facet->actions, odp_actions->data,
2606                                  facet->actions_len));
2607
2608     /* If the datapath actions changed or the installability changed,
2609      * then we need to talk to the datapath. */
2610     if (actions_changed || ctx.may_set_up_flow != facet->installed) {
2611         if (ctx.may_set_up_flow) {
2612             struct dpif_flow_stats stats;
2613
2614             facet_put__(ofproto, facet,
2615                         odp_actions->data, odp_actions->size, &stats);
2616             facet_update_stats(ofproto, facet, &stats);
2617         } else {
2618             facet_uninstall(ofproto, facet);
2619         }
2620
2621         /* The datapath flow is gone or has zeroed stats, so push stats out of
2622          * 'facet' into 'rule'. */
2623         facet_flush_stats(ofproto, facet);
2624     }
2625
2626     /* Update 'facet' now that we've taken care of all the old state. */
2627     facet->tags = ctx.tags;
2628     facet->nf_flow.output_iface = ctx.nf_output_iface;
2629     facet->may_install = ctx.may_set_up_flow;
2630     facet->has_learn = ctx.has_learn;
2631     facet->has_normal = ctx.has_normal;
2632     if (actions_changed) {
2633         free(facet->actions);
2634         facet->actions_len = odp_actions->size;
2635         facet->actions = xmemdup(odp_actions->data, odp_actions->size);
2636     }
2637     if (facet->rule != new_rule) {
2638         COVERAGE_INC(facet_changed_rule);
2639         list_remove(&facet->list_node);
2640         list_push_back(&new_rule->facets, &facet->list_node);
2641         facet->rule = new_rule;
2642         facet->used = new_rule->up.created;
2643         facet->rs_used = facet->used;
2644     }
2645
2646     ofpbuf_delete(odp_actions);
2647
2648     return true;
2649 }
2650
2651 /* Updates 'facet''s used time.  Caller is responsible for calling
2652  * facet_push_stats() to update the flows which 'facet' resubmits into. */
2653 static void
2654 facet_update_time(struct ofproto_dpif *ofproto, struct facet *facet,
2655                   long long int used)
2656 {
2657     if (used > facet->used) {
2658         facet->used = used;
2659         if (used > facet->rule->used) {
2660             facet->rule->used = used;
2661         }
2662         netflow_flow_update_time(ofproto->netflow, &facet->nf_flow, used);
2663     }
2664 }
2665
2666 /* Folds the statistics from 'stats' into the counters in 'facet'.
2667  *
2668  * Because of the meaning of a facet's counters, it only makes sense to do this
2669  * if 'stats' are not tracked in the datapath, that is, if 'stats' represents a
2670  * packet that was sent by hand or if it represents statistics that have been
2671  * cleared out of the datapath. */
2672 static void
2673 facet_update_stats(struct ofproto_dpif *ofproto, struct facet *facet,
2674                    const struct dpif_flow_stats *stats)
2675 {
2676     if (stats->n_packets || stats->used > facet->used) {
2677         facet_update_time(ofproto, facet, stats->used);
2678         facet->packet_count += stats->n_packets;
2679         facet->byte_count += stats->n_bytes;
2680         facet_push_stats(facet);
2681         netflow_flow_update_flags(&facet->nf_flow, stats->tcp_flags);
2682     }
2683 }
2684
2685 static void
2686 facet_reset_counters(struct facet *facet)
2687 {
2688     facet->packet_count = 0;
2689     facet->byte_count = 0;
2690     facet->rs_packet_count = 0;
2691     facet->rs_byte_count = 0;
2692     facet->accounted_bytes = 0;
2693 }
2694
2695 static void
2696 facet_push_stats(struct facet *facet)
2697 {
2698     uint64_t rs_packets, rs_bytes;
2699
2700     assert(facet->packet_count >= facet->rs_packet_count);
2701     assert(facet->byte_count >= facet->rs_byte_count);
2702     assert(facet->used >= facet->rs_used);
2703
2704     rs_packets = facet->packet_count - facet->rs_packet_count;
2705     rs_bytes = facet->byte_count - facet->rs_byte_count;
2706
2707     if (rs_packets || rs_bytes || facet->used > facet->rs_used) {
2708         facet->rs_packet_count = facet->packet_count;
2709         facet->rs_byte_count = facet->byte_count;
2710         facet->rs_used = facet->used;
2711
2712         flow_push_stats(facet->rule, &facet->flow,
2713                         rs_packets, rs_bytes, facet->used);
2714     }
2715 }
2716
2717 struct ofproto_push {
2718     struct action_xlate_ctx ctx;
2719     uint64_t packets;
2720     uint64_t bytes;
2721     long long int used;
2722 };
2723
2724 static void
2725 push_resubmit(struct action_xlate_ctx *ctx, struct rule_dpif *rule)
2726 {
2727     struct ofproto_push *push = CONTAINER_OF(ctx, struct ofproto_push, ctx);
2728
2729     if (rule) {
2730         rule->packet_count += push->packets;
2731         rule->byte_count += push->bytes;
2732         rule->used = MAX(push->used, rule->used);
2733     }
2734 }
2735
2736 /* Pushes flow statistics to the rules which 'flow' resubmits into given
2737  * 'rule''s actions. */
2738 static void
2739 flow_push_stats(const struct rule_dpif *rule,
2740                 struct flow *flow, uint64_t packets, uint64_t bytes,
2741                 long long int used)
2742 {
2743     struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
2744     struct ofproto_push push;
2745
2746     push.packets = packets;
2747     push.bytes = bytes;
2748     push.used = used;
2749
2750     action_xlate_ctx_init(&push.ctx, ofproto, flow, NULL);
2751     push.ctx.resubmit_hook = push_resubmit;
2752     ofpbuf_delete(xlate_actions(&push.ctx,
2753                                 rule->up.actions, rule->up.n_actions));
2754 }
2755 \f
2756 /* Rules. */
2757
2758 static struct rule_dpif *
2759 rule_dpif_lookup(struct ofproto_dpif *ofproto, const struct flow *flow,
2760                  uint8_t table_id)
2761 {
2762     if (table_id >= N_TABLES) {
2763         return NULL;
2764     }
2765
2766     return rule_dpif_cast(rule_from_cls_rule(
2767                               classifier_lookup(&ofproto->up.tables[table_id],
2768                                                 flow)));
2769 }
2770
2771 static void
2772 complete_operation(struct rule_dpif *rule)
2773 {
2774     struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
2775
2776     rule_invalidate(rule);
2777     if (clogged) {
2778         struct dpif_completion *c = xmalloc(sizeof *c);
2779         c->op = rule->up.pending;
2780         list_push_back(&ofproto->completions, &c->list_node);
2781     } else {
2782         ofoperation_complete(rule->up.pending, 0);
2783     }
2784 }
2785
2786 static struct rule *
2787 rule_alloc(void)
2788 {
2789     struct rule_dpif *rule = xmalloc(sizeof *rule);
2790     return &rule->up;
2791 }
2792
2793 static void
2794 rule_dealloc(struct rule *rule_)
2795 {
2796     struct rule_dpif *rule = rule_dpif_cast(rule_);
2797     free(rule);
2798 }
2799
2800 static int
2801 rule_construct(struct rule *rule_)
2802 {
2803     struct rule_dpif *rule = rule_dpif_cast(rule_);
2804     struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
2805     struct rule_dpif *victim;
2806     uint8_t table_id;
2807     int error;
2808
2809     error = validate_actions(rule->up.actions, rule->up.n_actions,
2810                              &rule->up.cr.flow, ofproto->max_ports);
2811     if (error) {
2812         return error;
2813     }
2814
2815     rule->used = rule->up.created;
2816     rule->packet_count = 0;
2817     rule->byte_count = 0;
2818
2819     victim = rule_dpif_cast(ofoperation_get_victim(rule->up.pending));
2820     if (victim && !list_is_empty(&victim->facets)) {
2821         struct facet *facet;
2822
2823         rule->facets = victim->facets;
2824         list_moved(&rule->facets);
2825         LIST_FOR_EACH (facet, list_node, &rule->facets) {
2826             /* XXX: We're only clearing our local counters here.  It's possible
2827              * that quite a few packets are unaccounted for in the datapath
2828              * statistics.  These will be accounted to the new rule instead of
2829              * cleared as required.  This could be fixed by clearing out the
2830              * datapath statistics for this facet, but currently it doesn't
2831              * seem worth it. */
2832             facet_reset_counters(facet);
2833             facet->rule = rule;
2834         }
2835     } else {
2836         /* Must avoid list_moved() in this case. */
2837         list_init(&rule->facets);
2838     }
2839
2840     table_id = rule->up.table_id;
2841     rule->tag = (victim ? victim->tag
2842                  : table_id == 0 ? 0
2843                  : rule_calculate_tag(&rule->up.cr.flow, &rule->up.cr.wc,
2844                                       ofproto->tables[table_id].basis));
2845
2846     complete_operation(rule);
2847     return 0;
2848 }
2849
2850 static void
2851 rule_destruct(struct rule *rule_)
2852 {
2853     struct rule_dpif *rule = rule_dpif_cast(rule_);
2854     struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
2855     struct facet *facet, *next_facet;
2856
2857     LIST_FOR_EACH_SAFE (facet, next_facet, list_node, &rule->facets) {
2858         facet_revalidate(ofproto, facet);
2859     }
2860
2861     complete_operation(rule);
2862 }
2863
2864 static void
2865 rule_get_stats(struct rule *rule_, uint64_t *packets, uint64_t *bytes)
2866 {
2867     struct rule_dpif *rule = rule_dpif_cast(rule_);
2868     struct facet *facet;
2869
2870     /* Start from historical data for 'rule' itself that are no longer tracked
2871      * in facets.  This counts, for example, facets that have expired. */
2872     *packets = rule->packet_count;
2873     *bytes = rule->byte_count;
2874
2875     /* Add any statistics that are tracked by facets.  This includes
2876      * statistical data recently updated by ofproto_update_stats() as well as
2877      * stats for packets that were executed "by hand" via dpif_execute(). */
2878     LIST_FOR_EACH (facet, list_node, &rule->facets) {
2879         *packets += facet->packet_count;
2880         *bytes += facet->byte_count;
2881     }
2882 }
2883
2884 static int
2885 rule_execute(struct rule *rule_, struct flow *flow, struct ofpbuf *packet)
2886 {
2887     struct rule_dpif *rule = rule_dpif_cast(rule_);
2888     struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
2889     struct action_xlate_ctx ctx;
2890     struct ofpbuf *odp_actions;
2891     struct facet *facet;
2892     size_t size;
2893
2894     /* First look for a related facet.  If we find one, account it to that. */
2895     facet = facet_lookup_valid(ofproto, flow);
2896     if (facet && facet->rule == rule) {
2897         if (!facet->may_install) {
2898             facet_make_actions(ofproto, facet, packet);
2899         }
2900         facet_execute(ofproto, facet, packet);
2901         return 0;
2902     }
2903
2904     /* Otherwise, if 'rule' is in fact the correct rule for 'packet', then
2905      * create a new facet for it and use that. */
2906     if (rule_dpif_lookup(ofproto, flow, 0) == rule) {
2907         facet = facet_create(rule, flow, packet);
2908         facet_execute(ofproto, facet, packet);
2909         facet_install(ofproto, facet, true);
2910         return 0;
2911     }
2912
2913     /* We can't account anything to a facet.  If we were to try, then that
2914      * facet would have a non-matching rule, busting our invariants. */
2915     action_xlate_ctx_init(&ctx, ofproto, flow, packet);
2916     odp_actions = xlate_actions(&ctx, rule->up.actions, rule->up.n_actions);
2917     size = packet->size;
2918     if (execute_odp_actions(ofproto, flow, odp_actions->data,
2919                             odp_actions->size, packet)) {
2920         rule->used = time_msec();
2921         rule->packet_count++;
2922         rule->byte_count += size;
2923         flow_push_stats(rule, flow, 1, size, rule->used);
2924     }
2925     ofpbuf_delete(odp_actions);
2926
2927     return 0;
2928 }
2929
2930 static void
2931 rule_modify_actions(struct rule *rule_)
2932 {
2933     struct rule_dpif *rule = rule_dpif_cast(rule_);
2934     struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
2935     int error;
2936
2937     error = validate_actions(rule->up.actions, rule->up.n_actions,
2938                              &rule->up.cr.flow, ofproto->max_ports);
2939     if (error) {
2940         ofoperation_complete(rule->up.pending, error);
2941         return;
2942     }
2943
2944     complete_operation(rule);
2945 }
2946 \f
2947 /* Sends 'packet' out of port 'odp_port' within 'ofproto'.
2948  * Returns 0 if successful, otherwise a positive errno value. */
2949 static int
2950 send_packet(struct ofproto_dpif *ofproto, uint32_t odp_port,
2951             const struct ofpbuf *packet)
2952 {
2953     struct ofpbuf key, odp_actions;
2954     struct odputil_keybuf keybuf;
2955     struct flow flow;
2956     int error;
2957
2958     flow_extract((struct ofpbuf *) packet, 0, 0, &flow);
2959     ofpbuf_use_stack(&key, &keybuf, sizeof keybuf);
2960     odp_flow_key_from_flow(&key, &flow);
2961
2962     ofpbuf_init(&odp_actions, 32);
2963     compose_sflow_action(ofproto, &odp_actions, &flow, odp_port);
2964
2965     nl_msg_put_u32(&odp_actions, OVS_ACTION_ATTR_OUTPUT, odp_port);
2966     error = dpif_execute(ofproto->dpif,
2967                          key.data, key.size,
2968                          odp_actions.data, odp_actions.size,
2969                          packet);
2970     ofpbuf_uninit(&odp_actions);
2971
2972     if (error) {
2973         VLOG_WARN_RL(&rl, "%s: failed to send packet on port %"PRIu32" (%s)",
2974                      ofproto->up.name, odp_port, strerror(error));
2975     }
2976     return error;
2977 }
2978 \f
2979 /* OpenFlow to datapath action translation. */
2980
2981 static void do_xlate_actions(const union ofp_action *in, size_t n_in,
2982                              struct action_xlate_ctx *ctx);
2983 static void xlate_normal(struct action_xlate_ctx *);
2984
2985 static size_t
2986 put_userspace_action(const struct ofproto_dpif *ofproto,
2987                      struct ofpbuf *odp_actions,
2988                      const struct flow *flow,
2989                      const struct user_action_cookie *cookie)
2990 {
2991     size_t offset;
2992     uint32_t pid;
2993
2994     pid = dpif_port_get_pid(ofproto->dpif,
2995                             ofp_port_to_odp_port(flow->in_port));
2996
2997     offset = nl_msg_start_nested(odp_actions, OVS_ACTION_ATTR_USERSPACE);
2998     nl_msg_put_u32(odp_actions, OVS_USERSPACE_ATTR_PID, pid);
2999     nl_msg_put_unspec(odp_actions, OVS_USERSPACE_ATTR_USERDATA,
3000                       cookie, sizeof *cookie);
3001     nl_msg_end_nested(odp_actions, offset);
3002
3003     return odp_actions->size - NLA_ALIGN(sizeof *cookie);
3004 }
3005
3006 /* Compose SAMPLE action for sFlow. */
3007 static size_t
3008 compose_sflow_action(const struct ofproto_dpif *ofproto,
3009                      struct ofpbuf *odp_actions,
3010                      const struct flow *flow,
3011                      uint32_t odp_port)
3012 {
3013     uint32_t port_ifindex;
3014     uint32_t probability;
3015     struct user_action_cookie cookie;
3016     size_t sample_offset, actions_offset;
3017     int cookie_offset, n_output;
3018
3019     if (!ofproto->sflow || flow->in_port == OFPP_NONE) {
3020         return 0;
3021     }
3022
3023     if (odp_port == OVSP_NONE) {
3024         port_ifindex = 0;
3025         n_output = 0;
3026     } else {
3027         port_ifindex = dpif_sflow_odp_port_to_ifindex(ofproto->sflow, odp_port);
3028         n_output = 1;
3029     }
3030
3031     sample_offset = nl_msg_start_nested(odp_actions, OVS_ACTION_ATTR_SAMPLE);
3032
3033     /* Number of packets out of UINT_MAX to sample. */
3034     probability = dpif_sflow_get_probability(ofproto->sflow);
3035     nl_msg_put_u32(odp_actions, OVS_SAMPLE_ATTR_PROBABILITY, probability);
3036
3037     actions_offset = nl_msg_start_nested(odp_actions, OVS_SAMPLE_ATTR_ACTIONS);
3038
3039     cookie.type = USER_ACTION_COOKIE_SFLOW;
3040     cookie.data = port_ifindex;
3041     cookie.n_output = n_output;
3042     cookie.vlan_tci = 0;
3043     cookie_offset = put_userspace_action(ofproto, odp_actions, flow, &cookie);
3044
3045     nl_msg_end_nested(odp_actions, actions_offset);
3046     nl_msg_end_nested(odp_actions, sample_offset);
3047     return cookie_offset;
3048 }
3049
3050 /* SAMPLE action must be first action in any given list of actions.
3051  * At this point we do not have all information required to build it. So try to
3052  * build sample action as complete as possible. */
3053 static void
3054 add_sflow_action(struct action_xlate_ctx *ctx)
3055 {
3056     ctx->user_cookie_offset = compose_sflow_action(ctx->ofproto,
3057                                                    ctx->odp_actions,
3058                                                    &ctx->flow, OVSP_NONE);
3059     ctx->sflow_odp_port = 0;
3060     ctx->sflow_n_outputs = 0;
3061 }
3062
3063 /* Fix SAMPLE action according to data collected while composing ODP actions.
3064  * We need to fix SAMPLE actions OVS_SAMPLE_ATTR_ACTIONS attribute, i.e. nested
3065  * USERSPACE action's user-cookie which is required for sflow. */
3066 static void
3067 fix_sflow_action(struct action_xlate_ctx *ctx)
3068 {
3069     const struct flow *base = &ctx->base_flow;
3070     struct user_action_cookie *cookie;
3071
3072     if (!ctx->user_cookie_offset) {
3073         return;
3074     }
3075
3076     cookie = ofpbuf_at(ctx->odp_actions, ctx->user_cookie_offset,
3077                      sizeof(*cookie));
3078     assert(cookie != NULL);
3079     assert(cookie->type == USER_ACTION_COOKIE_SFLOW);
3080
3081     if (ctx->sflow_n_outputs) {
3082         cookie->data = dpif_sflow_odp_port_to_ifindex(ctx->ofproto->sflow,
3083                                                     ctx->sflow_odp_port);
3084     }
3085     if (ctx->sflow_n_outputs >= 255) {
3086         cookie->n_output = 255;
3087     } else {
3088         cookie->n_output = ctx->sflow_n_outputs;
3089     }
3090     cookie->vlan_tci = base->vlan_tci;
3091 }
3092
3093 static void
3094 commit_vlan_tci(struct action_xlate_ctx *ctx, ovs_be16 vlan_tci)
3095 {
3096     struct flow *base = &ctx->base_flow;
3097     struct ofpbuf *odp_actions = ctx->odp_actions;
3098
3099     if (base->vlan_tci != vlan_tci) {
3100         if (!(vlan_tci & htons(VLAN_CFI))) {
3101             nl_msg_put_flag(odp_actions, OVS_ACTION_ATTR_POP_VLAN);
3102         } else {
3103             if (base->vlan_tci != htons(0)) {
3104                 nl_msg_put_flag(odp_actions, OVS_ACTION_ATTR_POP_VLAN);
3105             }
3106             nl_msg_put_be16(odp_actions, OVS_ACTION_ATTR_PUSH_VLAN,
3107                             vlan_tci & ~htons(VLAN_CFI));
3108         }
3109         base->vlan_tci = vlan_tci;
3110     }
3111 }
3112
3113 static void
3114 commit_odp_actions(struct action_xlate_ctx *ctx)
3115 {
3116     const struct flow *flow = &ctx->flow;
3117     struct flow *base = &ctx->base_flow;
3118     struct ofpbuf *odp_actions = ctx->odp_actions;
3119
3120     if (base->tun_id != flow->tun_id) {
3121         nl_msg_put_be64(odp_actions, OVS_ACTION_ATTR_SET_TUNNEL, flow->tun_id);
3122         base->tun_id = flow->tun_id;
3123     }
3124
3125     if (base->nw_src != flow->nw_src) {
3126         nl_msg_put_be32(odp_actions, OVS_ACTION_ATTR_SET_NW_SRC, flow->nw_src);
3127         base->nw_src = flow->nw_src;
3128     }
3129
3130     if (base->nw_dst != flow->nw_dst) {
3131         nl_msg_put_be32(odp_actions, OVS_ACTION_ATTR_SET_NW_DST, flow->nw_dst);
3132         base->nw_dst = flow->nw_dst;
3133     }
3134
3135     if (base->nw_tos != flow->nw_tos) {
3136         nl_msg_put_u8(odp_actions, OVS_ACTION_ATTR_SET_NW_TOS, flow->nw_tos);
3137         base->nw_tos = flow->nw_tos;
3138     }
3139
3140     commit_vlan_tci(ctx, flow->vlan_tci);
3141
3142     if (base->tp_src != flow->tp_src) {
3143         nl_msg_put_be16(odp_actions, OVS_ACTION_ATTR_SET_TP_SRC, flow->tp_src);
3144         base->tp_src = flow->tp_src;
3145     }
3146
3147     if (base->tp_dst != flow->tp_dst) {
3148         nl_msg_put_be16(odp_actions, OVS_ACTION_ATTR_SET_TP_DST, flow->tp_dst);
3149         base->tp_dst = flow->tp_dst;
3150     }
3151
3152     if (!eth_addr_equals(base->dl_src, flow->dl_src)) {
3153         nl_msg_put_unspec(odp_actions, OVS_ACTION_ATTR_SET_DL_SRC,
3154                           flow->dl_src, ETH_ADDR_LEN);
3155         memcpy(base->dl_src, flow->dl_src, ETH_ADDR_LEN);
3156     }
3157
3158     if (!eth_addr_equals(base->dl_dst, flow->dl_dst)) {
3159         nl_msg_put_unspec(odp_actions, OVS_ACTION_ATTR_SET_DL_DST,
3160                           flow->dl_dst, ETH_ADDR_LEN);
3161         memcpy(base->dl_dst, flow->dl_dst, ETH_ADDR_LEN);
3162     }
3163
3164     if (ctx->base_priority != ctx->priority) {
3165         if (ctx->priority) {
3166             nl_msg_put_u32(odp_actions, OVS_ACTION_ATTR_SET_PRIORITY,
3167                            ctx->priority);
3168         } else {
3169             nl_msg_put_flag(odp_actions, OVS_ACTION_ATTR_POP_PRIORITY);
3170         }
3171         ctx->base_priority = ctx->priority;
3172     }
3173 }
3174
3175 static void
3176 compose_output_action(struct action_xlate_ctx *ctx, uint16_t odp_port)
3177 {
3178     nl_msg_put_u32(ctx->odp_actions, OVS_ACTION_ATTR_OUTPUT, odp_port);
3179     ctx->sflow_odp_port = odp_port;
3180     ctx->sflow_n_outputs++;
3181 }
3182
3183 static void
3184 add_output_action(struct action_xlate_ctx *ctx, uint16_t ofp_port)
3185 {
3186     const struct ofport_dpif *ofport = get_ofp_port(ctx->ofproto, ofp_port);
3187     uint16_t odp_port = ofp_port_to_odp_port(ofp_port);
3188
3189     if (ofport) {
3190         if (ofport->up.opp.config & htonl(OFPPC_NO_FWD)) {
3191             /* Forwarding disabled on port. */
3192             return;
3193         }
3194     } else {
3195         /*
3196          * We don't have an ofport record for this port, but it doesn't hurt to
3197          * allow forwarding to it anyhow.  Maybe such a port will appear later
3198          * and we're pre-populating the flow table.
3199          */
3200     }
3201
3202     commit_odp_actions(ctx);
3203     compose_output_action(ctx, odp_port);
3204     ctx->nf_output_iface = ofp_port;
3205 }
3206
3207 static void
3208 xlate_table_action(struct action_xlate_ctx *ctx,
3209                    uint16_t in_port, uint8_t table_id)
3210 {
3211     if (ctx->recurse < MAX_RESUBMIT_RECURSION) {
3212         struct ofproto_dpif *ofproto = ctx->ofproto;
3213         struct rule_dpif *rule;
3214         uint16_t old_in_port;
3215         uint8_t old_table_id;
3216
3217         old_table_id = ctx->table_id;
3218         ctx->table_id = table_id;
3219
3220         /* Look up a flow with 'in_port' as the input port. */
3221         old_in_port = ctx->flow.in_port;
3222         ctx->flow.in_port = in_port;
3223         rule = rule_dpif_lookup(ofproto, &ctx->flow, table_id);
3224
3225         /* Tag the flow. */
3226         if (table_id > 0 && table_id < N_TABLES) {
3227             struct table_dpif *table = &ofproto->tables[table_id];
3228             if (table->other_table) {
3229                 ctx->tags |= (rule
3230                               ? rule->tag
3231                               : rule_calculate_tag(&ctx->flow,
3232                                                    &table->other_table->wc,
3233                                                    table->basis));
3234             }
3235         }
3236
3237         /* Restore the original input port.  Otherwise OFPP_NORMAL and
3238          * OFPP_IN_PORT will have surprising behavior. */
3239         ctx->flow.in_port = old_in_port;
3240
3241         if (ctx->resubmit_hook) {
3242             ctx->resubmit_hook(ctx, rule);
3243         }
3244
3245         if (rule) {
3246             ctx->recurse++;
3247             do_xlate_actions(rule->up.actions, rule->up.n_actions, ctx);
3248             ctx->recurse--;
3249         }
3250
3251         ctx->table_id = old_table_id;
3252     } else {
3253         static struct vlog_rate_limit recurse_rl = VLOG_RATE_LIMIT_INIT(1, 1);
3254
3255         VLOG_ERR_RL(&recurse_rl, "resubmit actions recursed over %d times",
3256                     MAX_RESUBMIT_RECURSION);
3257     }
3258 }
3259
3260 static void
3261 xlate_resubmit_table(struct action_xlate_ctx *ctx,
3262                      const struct nx_action_resubmit *nar)
3263 {
3264     uint16_t in_port;
3265     uint8_t table_id;
3266
3267     in_port = (nar->in_port == htons(OFPP_IN_PORT)
3268                ? ctx->flow.in_port
3269                : ntohs(nar->in_port));
3270     table_id = nar->table == 255 ? ctx->table_id : nar->table;
3271
3272     xlate_table_action(ctx, in_port, table_id);
3273 }
3274
3275 static void
3276 flood_packets(struct action_xlate_ctx *ctx, ovs_be32 mask)
3277 {
3278     struct ofport_dpif *ofport;
3279
3280     commit_odp_actions(ctx);
3281     HMAP_FOR_EACH (ofport, up.hmap_node, &ctx->ofproto->up.ports) {
3282         uint16_t ofp_port = ofport->up.ofp_port;
3283         if (ofp_port != ctx->flow.in_port && !(ofport->up.opp.config & mask)) {
3284             compose_output_action(ctx, ofport->odp_port);
3285         }
3286     }
3287
3288     ctx->nf_output_iface = NF_OUT_FLOOD;
3289 }
3290
3291 static void
3292 compose_controller_action(struct action_xlate_ctx *ctx, int len)
3293 {
3294     struct user_action_cookie cookie;
3295
3296     cookie.type = USER_ACTION_COOKIE_CONTROLLER;
3297     cookie.data = len;
3298     cookie.n_output = 0;
3299     cookie.vlan_tci = 0;
3300     put_userspace_action(ctx->ofproto, ctx->odp_actions, &ctx->flow, &cookie);
3301 }
3302
3303 static void
3304 xlate_output_action__(struct action_xlate_ctx *ctx,
3305                       uint16_t port, uint16_t max_len)
3306 {
3307     uint16_t prev_nf_output_iface = ctx->nf_output_iface;
3308
3309     ctx->nf_output_iface = NF_OUT_DROP;
3310
3311     switch (port) {
3312     case OFPP_IN_PORT:
3313         add_output_action(ctx, ctx->flow.in_port);
3314         break;
3315     case OFPP_TABLE:
3316         xlate_table_action(ctx, ctx->flow.in_port, ctx->table_id);
3317         break;
3318     case OFPP_NORMAL:
3319         xlate_normal(ctx);
3320         break;
3321     case OFPP_FLOOD:
3322         flood_packets(ctx,  htonl(OFPPC_NO_FLOOD));
3323         break;
3324     case OFPP_ALL:
3325         flood_packets(ctx, htonl(0));
3326         break;
3327     case OFPP_CONTROLLER:
3328         commit_odp_actions(ctx);
3329         compose_controller_action(ctx, max_len);
3330         break;
3331     case OFPP_LOCAL:
3332         add_output_action(ctx, OFPP_LOCAL);
3333         break;
3334     case OFPP_NONE:
3335         break;
3336     default:
3337         if (port != ctx->flow.in_port) {
3338             add_output_action(ctx, port);
3339         }
3340         break;
3341     }
3342
3343     if (prev_nf_output_iface == NF_OUT_FLOOD) {
3344         ctx->nf_output_iface = NF_OUT_FLOOD;
3345     } else if (ctx->nf_output_iface == NF_OUT_DROP) {
3346         ctx->nf_output_iface = prev_nf_output_iface;
3347     } else if (prev_nf_output_iface != NF_OUT_DROP &&
3348                ctx->nf_output_iface != NF_OUT_FLOOD) {
3349         ctx->nf_output_iface = NF_OUT_MULTI;
3350     }
3351 }
3352
3353 static void
3354 xlate_output_reg_action(struct action_xlate_ctx *ctx,
3355                         const struct nx_action_output_reg *naor)
3356 {
3357     uint64_t ofp_port;
3358
3359     ofp_port = nxm_read_field_bits(naor->src, naor->ofs_nbits, &ctx->flow);
3360
3361     if (ofp_port <= UINT16_MAX) {
3362         xlate_output_action__(ctx, ofp_port, ntohs(naor->max_len));
3363     }
3364 }
3365
3366 static void
3367 xlate_output_action(struct action_xlate_ctx *ctx,
3368                     const struct ofp_action_output *oao)
3369 {
3370     xlate_output_action__(ctx, ntohs(oao->port), ntohs(oao->max_len));
3371 }
3372
3373 static void
3374 xlate_enqueue_action(struct action_xlate_ctx *ctx,
3375                      const struct ofp_action_enqueue *oae)
3376 {
3377     uint16_t ofp_port, odp_port;
3378     uint32_t ctx_priority, priority;
3379     int error;
3380
3381     error = dpif_queue_to_priority(ctx->ofproto->dpif, ntohl(oae->queue_id),
3382                                    &priority);
3383     if (error) {
3384         /* Fall back to ordinary output action. */
3385         xlate_output_action__(ctx, ntohs(oae->port), 0);
3386         return;
3387     }
3388
3389     /* Figure out datapath output port. */
3390     ofp_port = ntohs(oae->port);
3391     if (ofp_port == OFPP_IN_PORT) {
3392         ofp_port = ctx->flow.in_port;
3393     }
3394     odp_port = ofp_port_to_odp_port(ofp_port);
3395
3396     /* Add datapath actions. */
3397     ctx_priority = ctx->priority;
3398     ctx->priority = priority;
3399     add_output_action(ctx, odp_port);
3400     ctx->priority = ctx_priority;
3401
3402     /* Update NetFlow output port. */
3403     if (ctx->nf_output_iface == NF_OUT_DROP) {
3404         ctx->nf_output_iface = odp_port;
3405     } else if (ctx->nf_output_iface != NF_OUT_FLOOD) {
3406         ctx->nf_output_iface = NF_OUT_MULTI;
3407     }
3408 }
3409
3410 static void
3411 xlate_set_queue_action(struct action_xlate_ctx *ctx,
3412                        const struct nx_action_set_queue *nasq)
3413 {
3414     uint32_t priority;
3415     int error;
3416
3417     error = dpif_queue_to_priority(ctx->ofproto->dpif, ntohl(nasq->queue_id),
3418                                    &priority);
3419     if (error) {
3420         /* Couldn't translate queue to a priority, so ignore.  A warning
3421          * has already been logged. */
3422         return;
3423     }
3424
3425     ctx->priority = priority;
3426 }
3427
3428 struct xlate_reg_state {
3429     ovs_be16 vlan_tci;
3430     ovs_be64 tun_id;
3431 };
3432
3433 static void
3434 xlate_autopath(struct action_xlate_ctx *ctx,
3435                const struct nx_action_autopath *naa)
3436 {
3437     uint16_t ofp_port = ntohl(naa->id);
3438     struct ofport_dpif *port = get_ofp_port(ctx->ofproto, ofp_port);
3439
3440     if (!port || !port->bundle) {
3441         ofp_port = OFPP_NONE;
3442     } else if (port->bundle->bond) {
3443         /* Autopath does not support VLAN hashing. */
3444         struct ofport_dpif *slave = bond_choose_output_slave(
3445             port->bundle->bond, &ctx->flow, 0, &ctx->tags);
3446         if (slave) {
3447             ofp_port = slave->up.ofp_port;
3448         }
3449     }
3450     autopath_execute(naa, &ctx->flow, ofp_port);
3451 }
3452
3453 static bool
3454 slave_enabled_cb(uint16_t ofp_port, void *ofproto_)
3455 {
3456     struct ofproto_dpif *ofproto = ofproto_;
3457     struct ofport_dpif *port;
3458
3459     switch (ofp_port) {
3460     case OFPP_IN_PORT:
3461     case OFPP_TABLE:
3462     case OFPP_NORMAL:
3463     case OFPP_FLOOD:
3464     case OFPP_ALL:
3465     case OFPP_LOCAL:
3466         return true;
3467     case OFPP_CONTROLLER: /* Not supported by the bundle action. */
3468         return false;
3469     default:
3470         port = get_ofp_port(ofproto, ofp_port);
3471         return port ? port->may_enable : false;
3472     }
3473 }
3474
3475 static void
3476 xlate_learn_action(struct action_xlate_ctx *ctx,
3477                    const struct nx_action_learn *learn)
3478 {
3479     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 1);
3480     struct ofputil_flow_mod fm;
3481     int error;
3482
3483     learn_execute(learn, &ctx->flow, &fm);
3484
3485     error = ofproto_flow_mod(&ctx->ofproto->up, &fm);
3486     if (error && !VLOG_DROP_WARN(&rl)) {
3487         char *msg = ofputil_error_to_string(error);
3488         VLOG_WARN("learning action failed to modify flow table (%s)", msg);
3489         free(msg);
3490     }
3491
3492     free(fm.actions);
3493 }
3494
3495 static void
3496 do_xlate_actions(const union ofp_action *in, size_t n_in,
3497                  struct action_xlate_ctx *ctx)
3498 {
3499     const struct ofport_dpif *port;
3500     const union ofp_action *ia;
3501     size_t left;
3502
3503     port = get_ofp_port(ctx->ofproto, ctx->flow.in_port);
3504     if (port
3505         && port->up.opp.config & htonl(OFPPC_NO_RECV | OFPPC_NO_RECV_STP) &&
3506         port->up.opp.config & (eth_addr_equals(ctx->flow.dl_dst, eth_addr_stp)
3507                                ? htonl(OFPPC_NO_RECV_STP)
3508                                : htonl(OFPPC_NO_RECV))) {
3509         /* Drop this flow. */
3510         return;
3511     }
3512
3513     OFPUTIL_ACTION_FOR_EACH_UNSAFE (ia, left, in, n_in) {
3514         const struct ofp_action_dl_addr *oada;
3515         const struct nx_action_resubmit *nar;
3516         const struct nx_action_set_tunnel *nast;
3517         const struct nx_action_set_queue *nasq;
3518         const struct nx_action_multipath *nam;
3519         const struct nx_action_autopath *naa;
3520         const struct nx_action_bundle *nab;
3521         const struct nx_action_output_reg *naor;
3522         enum ofputil_action_code code;
3523         ovs_be64 tun_id;
3524
3525         code = ofputil_decode_action_unsafe(ia);
3526         switch (code) {
3527         case OFPUTIL_OFPAT_OUTPUT:
3528             xlate_output_action(ctx, &ia->output);
3529             break;
3530
3531         case OFPUTIL_OFPAT_SET_VLAN_VID:
3532             ctx->flow.vlan_tci &= ~htons(VLAN_VID_MASK);
3533             ctx->flow.vlan_tci |= ia->vlan_vid.vlan_vid | htons(VLAN_CFI);
3534             break;
3535
3536         case OFPUTIL_OFPAT_SET_VLAN_PCP:
3537             ctx->flow.vlan_tci &= ~htons(VLAN_PCP_MASK);
3538             ctx->flow.vlan_tci |= htons(
3539                 (ia->vlan_pcp.vlan_pcp << VLAN_PCP_SHIFT) | VLAN_CFI);
3540             break;
3541
3542         case OFPUTIL_OFPAT_STRIP_VLAN:
3543             ctx->flow.vlan_tci = htons(0);
3544             break;
3545
3546         case OFPUTIL_OFPAT_SET_DL_SRC:
3547             oada = ((struct ofp_action_dl_addr *) ia);
3548             memcpy(ctx->flow.dl_src, oada->dl_addr, ETH_ADDR_LEN);
3549             break;
3550
3551         case OFPUTIL_OFPAT_SET_DL_DST:
3552             oada = ((struct ofp_action_dl_addr *) ia);
3553             memcpy(ctx->flow.dl_dst, oada->dl_addr, ETH_ADDR_LEN);
3554             break;
3555
3556         case OFPUTIL_OFPAT_SET_NW_SRC:
3557             ctx->flow.nw_src = ia->nw_addr.nw_addr;
3558             break;
3559
3560         case OFPUTIL_OFPAT_SET_NW_DST:
3561             ctx->flow.nw_dst = ia->nw_addr.nw_addr;
3562             break;
3563
3564         case OFPUTIL_OFPAT_SET_NW_TOS:
3565             ctx->flow.nw_tos = ia->nw_tos.nw_tos & IP_DSCP_MASK;
3566             break;
3567
3568         case OFPUTIL_OFPAT_SET_TP_SRC:
3569             ctx->flow.tp_src = ia->tp_port.tp_port;
3570             break;
3571
3572         case OFPUTIL_OFPAT_SET_TP_DST:
3573             ctx->flow.tp_dst = ia->tp_port.tp_port;
3574             break;
3575
3576         case OFPUTIL_OFPAT_ENQUEUE:
3577             xlate_enqueue_action(ctx, (const struct ofp_action_enqueue *) ia);
3578             break;
3579
3580         case OFPUTIL_NXAST_RESUBMIT:
3581             nar = (const struct nx_action_resubmit *) ia;
3582             xlate_table_action(ctx, ntohs(nar->in_port), ctx->table_id);
3583             break;
3584
3585         case OFPUTIL_NXAST_RESUBMIT_TABLE:
3586             xlate_resubmit_table(ctx, (const struct nx_action_resubmit *) ia);
3587             break;
3588
3589         case OFPUTIL_NXAST_SET_TUNNEL:
3590             nast = (const struct nx_action_set_tunnel *) ia;
3591             tun_id = htonll(ntohl(nast->tun_id));
3592             ctx->flow.tun_id = tun_id;
3593             break;
3594
3595         case OFPUTIL_NXAST_SET_QUEUE:
3596             nasq = (const struct nx_action_set_queue *) ia;
3597             xlate_set_queue_action(ctx, nasq);
3598             break;
3599
3600         case OFPUTIL_NXAST_POP_QUEUE:
3601             ctx->priority = 0;
3602             break;
3603
3604         case OFPUTIL_NXAST_REG_MOVE:
3605             nxm_execute_reg_move((const struct nx_action_reg_move *) ia,
3606                                  &ctx->flow);
3607             break;
3608
3609         case OFPUTIL_NXAST_REG_LOAD:
3610             nxm_execute_reg_load((const struct nx_action_reg_load *) ia,
3611                                  &ctx->flow);
3612             break;
3613
3614         case OFPUTIL_NXAST_NOTE:
3615             /* Nothing to do. */
3616             break;
3617
3618         case OFPUTIL_NXAST_SET_TUNNEL64:
3619             tun_id = ((const struct nx_action_set_tunnel64 *) ia)->tun_id;
3620             ctx->flow.tun_id = tun_id;
3621             break;
3622
3623         case OFPUTIL_NXAST_MULTIPATH:
3624             nam = (const struct nx_action_multipath *) ia;
3625             multipath_execute(nam, &ctx->flow);
3626             break;
3627
3628         case OFPUTIL_NXAST_AUTOPATH:
3629             naa = (const struct nx_action_autopath *) ia;
3630             xlate_autopath(ctx, naa);
3631             break;
3632
3633         case OFPUTIL_NXAST_BUNDLE:
3634             ctx->ofproto->has_bundle_action = true;
3635             nab = (const struct nx_action_bundle *) ia;
3636             xlate_output_action__(ctx, bundle_execute(nab, &ctx->flow,
3637                                                       slave_enabled_cb,
3638                                                       ctx->ofproto), 0);
3639             break;
3640
3641         case OFPUTIL_NXAST_BUNDLE_LOAD:
3642             ctx->ofproto->has_bundle_action = true;
3643             nab = (const struct nx_action_bundle *) ia;
3644             bundle_execute_load(nab, &ctx->flow, slave_enabled_cb,
3645                                 ctx->ofproto);
3646             break;
3647
3648         case OFPUTIL_NXAST_OUTPUT_REG:
3649             naor = (const struct nx_action_output_reg *) ia;
3650             xlate_output_reg_action(ctx, naor);
3651             break;
3652
3653         case OFPUTIL_NXAST_LEARN:
3654             ctx->has_learn = true;
3655             if (ctx->may_learn) {
3656                 xlate_learn_action(ctx, (const struct nx_action_learn *) ia);
3657             }
3658             break;
3659         }
3660     }
3661 }
3662
3663 static void
3664 action_xlate_ctx_init(struct action_xlate_ctx *ctx,
3665                       struct ofproto_dpif *ofproto, const struct flow *flow,
3666                       const struct ofpbuf *packet)
3667 {
3668     ctx->ofproto = ofproto;
3669     ctx->flow = *flow;
3670     ctx->packet = packet;
3671     ctx->may_learn = packet != NULL;
3672     ctx->resubmit_hook = NULL;
3673 }
3674
3675 static struct ofpbuf *
3676 xlate_actions(struct action_xlate_ctx *ctx,
3677               const union ofp_action *in, size_t n_in)
3678 {
3679     COVERAGE_INC(ofproto_dpif_xlate);
3680
3681     ctx->odp_actions = ofpbuf_new(512);
3682     ofpbuf_reserve(ctx->odp_actions, NL_A_U32_SIZE);
3683     ctx->tags = 0;
3684     ctx->may_set_up_flow = true;
3685     ctx->has_learn = false;
3686     ctx->has_normal = false;
3687     ctx->nf_output_iface = NF_OUT_DROP;
3688     ctx->recurse = 0;
3689     ctx->priority = 0;
3690     ctx->base_priority = 0;
3691     ctx->base_flow = ctx->flow;
3692     ctx->base_flow.tun_id = 0;
3693     ctx->table_id = 0;
3694
3695     if (process_special(ctx->ofproto, &ctx->flow, ctx->packet)) {
3696         ctx->may_set_up_flow = false;
3697         return ctx->odp_actions;
3698     } else {
3699         add_sflow_action(ctx);
3700         do_xlate_actions(in, n_in, ctx);
3701         fix_sflow_action(ctx);
3702
3703         if (!connmgr_may_set_up_flow(ctx->ofproto->up.connmgr, &ctx->flow,
3704                                      ctx->odp_actions->data,
3705                                      ctx->odp_actions->size)) {
3706             ctx->may_set_up_flow = false;
3707             if (ctx->packet
3708                 && connmgr_msg_in_hook(ctx->ofproto->up.connmgr, &ctx->flow,
3709                                        ctx->packet)) {
3710                 nl_msg_push_u32(ctx->odp_actions, OVS_ACTION_ATTR_OUTPUT,
3711                                 OVSP_LOCAL);
3712             }
3713         }
3714     }
3715
3716     return ctx->odp_actions;
3717 }
3718 \f
3719 /* OFPP_NORMAL implementation. */
3720
3721 struct dst {
3722     struct ofport_dpif *port;
3723     uint16_t vid;
3724 };
3725
3726 struct dst_set {
3727     struct dst builtin[32];
3728     struct dst *dsts;
3729     size_t n, allocated;
3730 };
3731
3732 static void dst_set_init(struct dst_set *);
3733 static void dst_set_add(struct dst_set *, const struct dst *);
3734 static void dst_set_free(struct dst_set *);
3735
3736 static struct ofport_dpif *ofbundle_get_a_port(const struct ofbundle *);
3737
3738 /* Given 'vid', the VID obtained from the 802.1Q header that was received as
3739  * part of a packet (specify 0 if there was no 802.1Q header), and 'in_bundle',
3740  * the bundle on which the packet was received, returns the VLAN to which the
3741  * packet belongs.
3742  *
3743  * Both 'vid' and the return value are in the range 0...4095. */
3744 static uint16_t
3745 input_vid_to_vlan(const struct ofbundle *in_bundle, uint16_t vid)
3746 {
3747     switch (in_bundle->vlan_mode) {
3748     case PORT_VLAN_ACCESS:
3749         return in_bundle->vlan;
3750         break;
3751
3752     case PORT_VLAN_TRUNK:
3753         return vid;
3754
3755     case PORT_VLAN_NATIVE_UNTAGGED:
3756     case PORT_VLAN_NATIVE_TAGGED:
3757         return vid ? vid : in_bundle->vlan;
3758
3759     default:
3760         NOT_REACHED();
3761     }
3762 }
3763
3764 /* Given 'vlan', the VLAN that a packet belongs to, and
3765  * 'out_bundle', a bundle on which the packet is to be output, returns the VID
3766  * that should be included in the 802.1Q header.  (If the return value is 0,
3767  * then the 802.1Q header should only be included in the packet if there is a
3768  * nonzero PCP.)
3769  *
3770  * Both 'vlan' and the return value are in the range 0...4095. */
3771 static uint16_t
3772 output_vlan_to_vid(const struct ofbundle *out_bundle, uint16_t vlan)
3773 {
3774     switch (out_bundle->vlan_mode) {
3775     case PORT_VLAN_ACCESS:
3776         return 0;
3777
3778     case PORT_VLAN_TRUNK:
3779     case PORT_VLAN_NATIVE_TAGGED:
3780         return vlan;
3781
3782     case PORT_VLAN_NATIVE_UNTAGGED:
3783         return vlan == out_bundle->vlan ? 0 : vlan;
3784
3785     default:
3786         NOT_REACHED();
3787     }
3788 }
3789
3790 static bool
3791 set_dst(struct action_xlate_ctx *ctx, struct dst *dst,
3792         const struct ofbundle *in_bundle, const struct ofbundle *out_bundle)
3793 {
3794     uint16_t vlan;
3795
3796     vlan = input_vid_to_vlan(in_bundle, vlan_tci_to_vid(ctx->flow.vlan_tci));
3797     dst->vid = output_vlan_to_vid(out_bundle, vlan);
3798
3799     dst->port = (!out_bundle->bond
3800                  ? ofbundle_get_a_port(out_bundle)
3801                  : bond_choose_output_slave(out_bundle->bond, &ctx->flow,
3802                                             dst->vid, &ctx->tags));
3803     return dst->port != NULL;
3804 }
3805
3806 static int
3807 mirror_mask_ffs(mirror_mask_t mask)
3808 {
3809     BUILD_ASSERT_DECL(sizeof(unsigned int) >= sizeof(mask));
3810     return ffs(mask);
3811 }
3812
3813 static void
3814 dst_set_init(struct dst_set *set)
3815 {
3816     set->dsts = set->builtin;
3817     set->n = 0;
3818     set->allocated = ARRAY_SIZE(set->builtin);
3819 }
3820
3821 static void
3822 dst_set_add(struct dst_set *set, const struct dst *dst)
3823 {
3824     if (set->n >= set->allocated) {
3825         size_t new_allocated;
3826         struct dst *new_dsts;
3827
3828         new_allocated = set->allocated * 2;
3829         new_dsts = xmalloc(new_allocated * sizeof *new_dsts);
3830         memcpy(new_dsts, set->dsts, set->n * sizeof *new_dsts);
3831
3832         dst_set_free(set);
3833
3834         set->dsts = new_dsts;
3835         set->allocated = new_allocated;
3836     }
3837     set->dsts[set->n++] = *dst;
3838 }
3839
3840 static void
3841 dst_set_free(struct dst_set *set)
3842 {
3843     if (set->dsts != set->builtin) {
3844         free(set->dsts);
3845     }
3846 }
3847
3848 static bool
3849 dst_is_duplicate(const struct dst_set *set, const struct dst *test)
3850 {
3851     size_t i;
3852     for (i = 0; i < set->n; i++) {
3853         if (set->dsts[i].vid == test->vid
3854             && set->dsts[i].port == test->port) {
3855             return true;
3856         }
3857     }
3858     return false;
3859 }
3860
3861 static bool
3862 ofbundle_trunks_vlan(const struct ofbundle *bundle, uint16_t vlan)
3863 {
3864     return (bundle->vlan_mode != PORT_VLAN_ACCESS
3865             && (!bundle->trunks || bitmap_is_set(bundle->trunks, vlan)));
3866 }
3867
3868 static bool
3869 ofbundle_includes_vlan(const struct ofbundle *bundle, uint16_t vlan)
3870 {
3871     return vlan == bundle->vlan || ofbundle_trunks_vlan(bundle, vlan);
3872 }
3873
3874 /* Returns an arbitrary interface within 'bundle'. */
3875 static struct ofport_dpif *
3876 ofbundle_get_a_port(const struct ofbundle *bundle)
3877 {
3878     return CONTAINER_OF(list_front(&bundle->ports),
3879                         struct ofport_dpif, bundle_node);
3880 }
3881
3882 static void
3883 compose_dsts(struct action_xlate_ctx *ctx, uint16_t vlan,
3884              const struct ofbundle *in_bundle,
3885              const struct ofbundle *out_bundle, struct dst_set *set)
3886 {
3887     struct dst dst;
3888
3889     if (out_bundle == OFBUNDLE_FLOOD) {
3890         struct ofbundle *bundle;
3891
3892         HMAP_FOR_EACH (bundle, hmap_node, &ctx->ofproto->bundles) {
3893             if (bundle != in_bundle
3894                 && ofbundle_includes_vlan(bundle, vlan)
3895                 && bundle->floodable
3896                 && !bundle->mirror_out
3897                 && set_dst(ctx, &dst, in_bundle, bundle)) {
3898                 dst_set_add(set, &dst);
3899             }
3900         }
3901         ctx->nf_output_iface = NF_OUT_FLOOD;
3902     } else if (out_bundle && set_dst(ctx, &dst, in_bundle, out_bundle)) {
3903         dst_set_add(set, &dst);
3904         ctx->nf_output_iface = dst.port->odp_port;
3905     }
3906 }
3907
3908 static bool
3909 vlan_is_mirrored(const struct ofmirror *m, int vlan)
3910 {
3911     return !m->vlans || bitmap_is_set(m->vlans, vlan);
3912 }
3913
3914 /* Returns true if a packet with Ethernet destination MAC 'dst' may be mirrored
3915  * to a VLAN.  In general most packets may be mirrored but we want to drop
3916  * protocols that may confuse switches. */
3917 static bool
3918 eth_dst_may_rspan(const uint8_t dst[ETH_ADDR_LEN])
3919 {
3920     /* If you change this function's behavior, please update corresponding
3921      * documentation in vswitch.xml at the same time. */
3922     if (dst[0] != 0x01) {
3923         /* All the currently banned MACs happen to start with 01 currently, so
3924          * this is a quick way to eliminate most of the good ones. */
3925     } else {
3926         if (eth_addr_is_reserved(dst)) {
3927             /* Drop STP, IEEE pause frames, and other reserved protocols
3928              * (01-80-c2-00-00-0x). */
3929             return false;
3930         }
3931
3932         if (dst[0] == 0x01 && dst[1] == 0x00 && dst[2] == 0x0c) {
3933             /* Cisco OUI. */
3934             if ((dst[3] & 0xfe) == 0xcc &&
3935                 (dst[4] & 0xfe) == 0xcc &&
3936                 (dst[5] & 0xfe) == 0xcc) {
3937                 /* Drop the following protocols plus others following the same
3938                    pattern:
3939
3940                    CDP, VTP, DTP, PAgP  (01-00-0c-cc-cc-cc)
3941                    Spanning Tree PVSTP+ (01-00-0c-cc-cc-cd)
3942                    STP Uplink Fast      (01-00-0c-cd-cd-cd) */
3943                 return false;
3944             }
3945
3946             if (!(dst[3] | dst[4] | dst[5])) {
3947                 /* Drop Inter Switch Link packets (01-00-0c-00-00-00). */
3948                 return false;
3949             }
3950         }
3951     }
3952     return true;
3953 }
3954
3955 static void
3956 compose_mirror_dsts(struct action_xlate_ctx *ctx,
3957                     uint16_t vlan, const struct ofbundle *in_bundle,
3958                     struct dst_set *set)
3959 {
3960     struct ofproto_dpif *ofproto = ctx->ofproto;
3961     mirror_mask_t mirrors;
3962     uint16_t flow_vid;
3963     size_t i;
3964
3965     mirrors = in_bundle->src_mirrors;
3966     for (i = 0; i < set->n; i++) {
3967         mirrors |= set->dsts[i].port->bundle->dst_mirrors;
3968     }
3969
3970     if (!mirrors) {
3971         return;
3972     }
3973
3974     flow_vid = vlan_tci_to_vid(ctx->flow.vlan_tci);
3975     while (mirrors) {
3976         struct ofmirror *m = ofproto->mirrors[mirror_mask_ffs(mirrors) - 1];
3977         if (vlan_is_mirrored(m, vlan)) {
3978             struct dst dst;
3979
3980             if (m->out) {
3981                 if (set_dst(ctx, &dst, in_bundle, m->out)
3982                     && !dst_is_duplicate(set, &dst)) {
3983                     dst_set_add(set, &dst);
3984                 }
3985             } else if (eth_dst_may_rspan(ctx->flow.dl_dst)) {
3986                 struct ofbundle *bundle;
3987
3988                 HMAP_FOR_EACH (bundle, hmap_node, &ofproto->bundles) {
3989                     if (ofbundle_includes_vlan(bundle, m->out_vlan)
3990                         && set_dst(ctx, &dst, in_bundle, bundle))
3991                     {
3992                         /* set_dst() got dst->vid from the input packet's VLAN,
3993                          * not from m->out_vlan, so recompute it. */
3994                         dst.vid = output_vlan_to_vid(bundle, m->out_vlan);
3995
3996                         if (dst_is_duplicate(set, &dst)) {
3997                             continue;
3998                         }
3999
4000                         if (bundle == in_bundle && dst.vid == flow_vid) {
4001                             /* Don't send out input port on same VLAN. */
4002                             continue;
4003                         }
4004                         dst_set_add(set, &dst);
4005                     }
4006                 }
4007             }
4008         }
4009         mirrors &= mirrors - 1;
4010     }
4011 }
4012
4013 static void
4014 compose_actions(struct action_xlate_ctx *ctx, uint16_t vlan,
4015                 const struct ofbundle *in_bundle,
4016                 const struct ofbundle *out_bundle)
4017 {
4018     uint16_t initial_vid, cur_vid;
4019     const struct dst *dst;
4020     struct dst_set set;
4021
4022     dst_set_init(&set);
4023     compose_dsts(ctx, vlan, in_bundle, out_bundle, &set);
4024     compose_mirror_dsts(ctx, vlan, in_bundle, &set);
4025     if (!set.n) {
4026         dst_set_free(&set);
4027         return;
4028     }
4029
4030     /* Output all the packets we can without having to change the VLAN. */
4031     commit_odp_actions(ctx);
4032     initial_vid = vlan_tci_to_vid(ctx->flow.vlan_tci);
4033     for (dst = set.dsts; dst < &set.dsts[set.n]; dst++) {
4034         if (dst->vid != initial_vid) {
4035             continue;
4036         }
4037         compose_output_action(ctx, dst->port->odp_port);
4038     }
4039
4040     /* Then output the rest. */
4041     cur_vid = initial_vid;
4042     for (dst = set.dsts; dst < &set.dsts[set.n]; dst++) {
4043         if (dst->vid == initial_vid) {
4044             continue;
4045         }
4046         if (dst->vid != cur_vid) {
4047             ovs_be16 tci;
4048
4049             tci = htons(dst->vid);
4050             tci |= ctx->flow.vlan_tci & htons(VLAN_PCP_MASK);
4051             if (tci) {
4052                 tci |= htons(VLAN_CFI);
4053             }
4054             commit_vlan_tci(ctx, tci);
4055
4056             cur_vid = dst->vid;
4057         }
4058         compose_output_action(ctx, dst->port->odp_port);
4059     }
4060
4061     dst_set_free(&set);
4062 }
4063
4064 /* Returns the effective vlan of a packet, taking into account both the
4065  * 802.1Q header and implicitly tagged ports.  A value of 0 indicates that
4066  * the packet is untagged and -1 indicates it has an invalid header and
4067  * should be dropped. */
4068 static int
4069 flow_get_vlan(struct ofproto_dpif *ofproto, const struct flow *flow,
4070               struct ofbundle *in_bundle, bool have_packet)
4071 {
4072     int vlan = vlan_tci_to_vid(flow->vlan_tci);
4073     if (vlan) {
4074         if (in_bundle->vlan_mode == PORT_VLAN_ACCESS) {
4075             /* Drop tagged packet on access port */
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 configured with "
4080                              "implicit VLAN %"PRIu16,
4081                              ofproto->up.name, vlan,
4082                              in_bundle->name, in_bundle->vlan);
4083             }
4084             return -1;
4085         } else if (ofbundle_includes_vlan(in_bundle, vlan)) {
4086             return vlan;
4087         } else {
4088             /* Drop packets from a VLAN not member of the trunk */
4089             if (have_packet) {
4090                 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
4091                 VLOG_WARN_RL(&rl, "bridge %s: dropping VLAN %d tagged "
4092                              "packet received on port %s not configured for "
4093                              "trunking VLAN %d",
4094                              ofproto->up.name, vlan, in_bundle->name, vlan);
4095             }
4096             return -1;
4097         }
4098     } else {
4099         if (in_bundle->vlan_mode != PORT_VLAN_TRUNK) {
4100             return in_bundle->vlan;
4101         } else {
4102             return ofbundle_includes_vlan(in_bundle, 0) ? 0 : -1;
4103         }
4104     }
4105 }
4106
4107 /* A VM broadcasts a gratuitous ARP to indicate that it has resumed after
4108  * migration.  Older Citrix-patched Linux DomU used gratuitous ARP replies to
4109  * indicate this; newer upstream kernels use gratuitous ARP requests. */
4110 static bool
4111 is_gratuitous_arp(const struct flow *flow)
4112 {
4113     return (flow->dl_type == htons(ETH_TYPE_ARP)
4114             && eth_addr_is_broadcast(flow->dl_dst)
4115             && (flow->nw_proto == ARP_OP_REPLY
4116                 || (flow->nw_proto == ARP_OP_REQUEST
4117                     && flow->nw_src == flow->nw_dst)));
4118 }
4119
4120 static void
4121 update_learning_table(struct ofproto_dpif *ofproto,
4122                       const struct flow *flow, int vlan,
4123                       struct ofbundle *in_bundle)
4124 {
4125     struct mac_entry *mac;
4126
4127     if (!mac_learning_may_learn(ofproto->ml, flow->dl_src, vlan)) {
4128         return;
4129     }
4130
4131     mac = mac_learning_insert(ofproto->ml, flow->dl_src, vlan);
4132     if (is_gratuitous_arp(flow)) {
4133         /* We don't want to learn from gratuitous ARP packets that are
4134          * reflected back over bond slaves so we lock the learning table. */
4135         if (!in_bundle->bond) {
4136             mac_entry_set_grat_arp_lock(mac);
4137         } else if (mac_entry_is_grat_arp_locked(mac)) {
4138             return;
4139         }
4140     }
4141
4142     if (mac_entry_is_new(mac) || mac->port.p != in_bundle) {
4143         /* The log messages here could actually be useful in debugging,
4144          * so keep the rate limit relatively high. */
4145         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(30, 300);
4146         VLOG_DBG_RL(&rl, "bridge %s: learned that "ETH_ADDR_FMT" is "
4147                     "on port %s in VLAN %d",
4148                     ofproto->up.name, ETH_ADDR_ARGS(flow->dl_src),
4149                     in_bundle->name, vlan);
4150
4151         mac->port.p = in_bundle;
4152         tag_set_add(&ofproto->revalidate_set,
4153                     mac_learning_changed(ofproto->ml, mac));
4154     }
4155 }
4156
4157 /* Determines whether packets in 'flow' within 'br' should be forwarded or
4158  * dropped.  Returns true if they may be forwarded, false if they should be
4159  * dropped.
4160  *
4161  * If 'have_packet' is true, it indicates that the caller is processing a
4162  * received packet.  If 'have_packet' is false, then the caller is just
4163  * revalidating an existing flow because configuration has changed.  Either
4164  * way, 'have_packet' only affects logging (there is no point in logging errors
4165  * during revalidation).
4166  *
4167  * Sets '*in_portp' to the input port.  This will be a null pointer if
4168  * flow->in_port does not designate a known input port (in which case
4169  * is_admissible() returns false).
4170  *
4171  * When returning true, sets '*vlanp' to the effective VLAN of the input
4172  * packet, as returned by flow_get_vlan().
4173  *
4174  * May also add tags to '*tags', although the current implementation only does
4175  * so in one special case.
4176  */
4177 static bool
4178 is_admissible(struct ofproto_dpif *ofproto, const struct flow *flow,
4179               bool have_packet,
4180               tag_type *tags, int *vlanp, struct ofbundle **in_bundlep)
4181 {
4182     struct ofport_dpif *in_port;
4183     struct ofbundle *in_bundle;
4184     int vlan;
4185
4186     /* Find the port and bundle for the received packet. */
4187     in_port = get_ofp_port(ofproto, flow->in_port);
4188     *in_bundlep = in_bundle = in_port ? in_port->bundle : NULL;
4189     if (!in_port || !in_bundle) {
4190         /* No interface?  Something fishy... */
4191         if (have_packet) {
4192             /* Odd.  A few possible reasons here:
4193              *
4194              * - We deleted a port but there are still a few packets queued up
4195              *   from it.
4196              *
4197              * - Someone externally added a port (e.g. "ovs-dpctl add-if") that
4198              *   we don't know about.
4199              *
4200              * - Packet arrived on the local port but the local port is not
4201              *   part of a bundle.
4202              */
4203             static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
4204
4205             VLOG_WARN_RL(&rl, "bridge %s: received packet on unknown "
4206                          "port %"PRIu16,
4207                          ofproto->up.name, flow->in_port);
4208         }
4209         *vlanp = -1;
4210         return false;
4211     }
4212     *vlanp = vlan = flow_get_vlan(ofproto, flow, in_bundle, have_packet);
4213     if (vlan < 0) {
4214         return false;
4215     }
4216
4217     /* Drop frames for reserved multicast addresses
4218      * only if forward_bpdu option is absent. */
4219     if (eth_addr_is_reserved(flow->dl_dst) &&
4220         !ofproto->up.forward_bpdu) {
4221         return false;
4222     }
4223
4224     /* Drop frames on bundles reserved for mirroring. */
4225     if (in_bundle->mirror_out) {
4226         if (have_packet) {
4227             static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
4228             VLOG_WARN_RL(&rl, "bridge %s: dropping packet received on port "
4229                          "%s, which is reserved exclusively for mirroring",
4230                          ofproto->up.name, in_bundle->name);
4231         }
4232         return false;
4233     }
4234
4235     if (in_bundle->bond) {
4236         struct mac_entry *mac;
4237
4238         switch (bond_check_admissibility(in_bundle->bond, in_port,
4239                                          flow->dl_dst, tags)) {
4240         case BV_ACCEPT:
4241             break;
4242
4243         case BV_DROP:
4244             return false;
4245
4246         case BV_DROP_IF_MOVED:
4247             mac = mac_learning_lookup(ofproto->ml, flow->dl_src, vlan, NULL);
4248             if (mac && mac->port.p != in_bundle &&
4249                 (!is_gratuitous_arp(flow)
4250                  || mac_entry_is_grat_arp_locked(mac))) {
4251                 return false;
4252             }
4253             break;
4254         }
4255     }
4256
4257     return true;
4258 }
4259
4260 static void
4261 xlate_normal(struct action_xlate_ctx *ctx)
4262 {
4263     struct ofbundle *in_bundle;
4264     struct ofbundle *out_bundle;
4265     struct mac_entry *mac;
4266     int vlan;
4267
4268     ctx->has_normal = true;
4269
4270     /* Check whether we should drop packets in this flow. */
4271     if (!is_admissible(ctx->ofproto, &ctx->flow, ctx->packet != NULL,
4272                        &ctx->tags, &vlan, &in_bundle)) {
4273         out_bundle = NULL;
4274         goto done;
4275     }
4276
4277     /* Learn source MAC. */
4278     if (ctx->may_learn) {
4279         update_learning_table(ctx->ofproto, &ctx->flow, vlan, in_bundle);
4280     }
4281
4282     /* Determine output bundle. */
4283     mac = mac_learning_lookup(ctx->ofproto->ml, ctx->flow.dl_dst, vlan,
4284                               &ctx->tags);
4285     if (mac) {
4286         out_bundle = mac->port.p;
4287     } else if (!ctx->packet && !eth_addr_is_multicast(ctx->flow.dl_dst)) {
4288         /* If we are revalidating but don't have a learning entry then eject
4289          * the flow.  Installing a flow that floods packets opens up a window
4290          * of time where we could learn from a packet reflected on a bond and
4291          * blackhole packets before the learning table is updated to reflect
4292          * the correct port. */
4293         ctx->may_set_up_flow = false;
4294         return;
4295     } else {
4296         out_bundle = OFBUNDLE_FLOOD;
4297     }
4298
4299     /* Don't send packets out their input bundles. */
4300     if (in_bundle == out_bundle) {
4301         out_bundle = NULL;
4302     }
4303
4304 done:
4305     if (in_bundle) {
4306         compose_actions(ctx, vlan, in_bundle, out_bundle);
4307     }
4308 }
4309 \f
4310 /* Optimized flow revalidation.
4311  *
4312  * It's a difficult problem, in general, to tell which facets need to have
4313  * their actions recalculated whenever the OpenFlow flow table changes.  We
4314  * don't try to solve that general problem: for most kinds of OpenFlow flow
4315  * table changes, we recalculate the actions for every facet.  This is
4316  * relatively expensive, but it's good enough if the OpenFlow flow table
4317  * doesn't change very often.
4318  *
4319  * However, we can expect one particular kind of OpenFlow flow table change to
4320  * happen frequently: changes caused by MAC learning.  To avoid wasting a lot
4321  * of CPU on revalidating every facet whenever MAC learning modifies the flow
4322  * table, we add a special case that applies to flow tables in which every rule
4323  * has the same form (that is, the same wildcards), except that the table is
4324  * also allowed to have a single "catch-all" flow that matches all packets.  We
4325  * optimize this case by tagging all of the facets that resubmit into the table
4326  * and invalidating the same tag whenever a flow changes in that table.  The
4327  * end result is that we revalidate just the facets that need it (and sometimes
4328  * a few more, but not all of the facets or even all of the facets that
4329  * resubmit to the table modified by MAC learning). */
4330
4331 /* Calculates the tag to use for 'flow' and wildcards 'wc' when it is inserted
4332  * into an OpenFlow table with the given 'basis'. */
4333 static uint32_t
4334 rule_calculate_tag(const struct flow *flow, const struct flow_wildcards *wc,
4335                    uint32_t secret)
4336 {
4337     if (flow_wildcards_is_catchall(wc)) {
4338         return 0;
4339     } else {
4340         struct flow tag_flow = *flow;
4341         flow_zero_wildcards(&tag_flow, wc);
4342         return tag_create_deterministic(flow_hash(&tag_flow, secret));
4343     }
4344 }
4345
4346 /* Following a change to OpenFlow table 'table_id' in 'ofproto', update the
4347  * taggability of that table.
4348  *
4349  * This function must be called after *each* change to a flow table.  If you
4350  * skip calling it on some changes then the pointer comparisons at the end can
4351  * be invalid if you get unlucky.  For example, if a flow removal causes a
4352  * cls_table to be destroyed and then a flow insertion causes a cls_table with
4353  * different wildcards to be created with the same address, then this function
4354  * will incorrectly skip revalidation. */
4355 static void
4356 table_update_taggable(struct ofproto_dpif *ofproto, uint8_t table_id)
4357 {
4358     struct table_dpif *table = &ofproto->tables[table_id];
4359     const struct classifier *cls = &ofproto->up.tables[table_id];
4360     struct cls_table *catchall, *other;
4361     struct cls_table *t;
4362
4363     catchall = other = NULL;
4364
4365     switch (hmap_count(&cls->tables)) {
4366     case 0:
4367         /* We could tag this OpenFlow table but it would make the logic a
4368          * little harder and it's a corner case that doesn't seem worth it
4369          * yet. */
4370         break;
4371
4372     case 1:
4373     case 2:
4374         HMAP_FOR_EACH (t, hmap_node, &cls->tables) {
4375             if (cls_table_is_catchall(t)) {
4376                 catchall = t;
4377             } else if (!other) {
4378                 other = t;
4379             } else {
4380                 /* Indicate that we can't tag this by setting both tables to
4381                  * NULL.  (We know that 'catchall' is already NULL.) */
4382                 other = NULL;
4383             }
4384         }
4385         break;
4386
4387     default:
4388         /* Can't tag this table. */
4389         break;
4390     }
4391
4392     if (table->catchall_table != catchall || table->other_table != other) {
4393         table->catchall_table = catchall;
4394         table->other_table = other;
4395         ofproto->need_revalidate = true;
4396     }
4397 }
4398
4399 /* Given 'rule' that has changed in some way (either it is a rule being
4400  * inserted, a rule being deleted, or a rule whose actions are being
4401  * modified), marks facets for revalidation to ensure that packets will be
4402  * forwarded correctly according to the new state of the flow table.
4403  *
4404  * This function must be called after *each* change to a flow table.  See
4405  * the comment on table_update_taggable() for more information. */
4406 static void
4407 rule_invalidate(const struct rule_dpif *rule)
4408 {
4409     struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
4410
4411     table_update_taggable(ofproto, rule->up.table_id);
4412
4413     if (!ofproto->need_revalidate) {
4414         struct table_dpif *table = &ofproto->tables[rule->up.table_id];
4415
4416         if (table->other_table && rule->tag) {
4417             tag_set_add(&ofproto->revalidate_set, rule->tag);
4418         } else {
4419             ofproto->need_revalidate = true;
4420         }
4421     }
4422 }
4423 \f
4424 static bool
4425 get_drop_frags(struct ofproto *ofproto_)
4426 {
4427     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
4428     bool drop_frags;
4429
4430     dpif_get_drop_frags(ofproto->dpif, &drop_frags);
4431     return drop_frags;
4432 }
4433
4434 static void
4435 set_drop_frags(struct ofproto *ofproto_, bool drop_frags)
4436 {
4437     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
4438
4439     dpif_set_drop_frags(ofproto->dpif, drop_frags);
4440 }
4441
4442 static int
4443 packet_out(struct ofproto *ofproto_, struct ofpbuf *packet,
4444            const struct flow *flow,
4445            const union ofp_action *ofp_actions, size_t n_ofp_actions)
4446 {
4447     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
4448     int error;
4449
4450     error = validate_actions(ofp_actions, n_ofp_actions, flow,
4451                              ofproto->max_ports);
4452     if (!error) {
4453         struct odputil_keybuf keybuf;
4454         struct action_xlate_ctx ctx;
4455         struct ofpbuf *odp_actions;
4456         struct ofpbuf key;
4457
4458         ofpbuf_use_stack(&key, &keybuf, sizeof keybuf);
4459         odp_flow_key_from_flow(&key, flow);
4460
4461         action_xlate_ctx_init(&ctx, ofproto, flow, packet);
4462         odp_actions = xlate_actions(&ctx, ofp_actions, n_ofp_actions);
4463         dpif_execute(ofproto->dpif, key.data, key.size,
4464                      odp_actions->data, odp_actions->size, packet);
4465         ofpbuf_delete(odp_actions);
4466     }
4467     return error;
4468 }
4469
4470 static void
4471 get_netflow_ids(const struct ofproto *ofproto_,
4472                 uint8_t *engine_type, uint8_t *engine_id)
4473 {
4474     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
4475
4476     dpif_get_netflow_ids(ofproto->dpif, engine_type, engine_id);
4477 }
4478 \f
4479 static struct ofproto_dpif *
4480 ofproto_dpif_lookup(const char *name)
4481 {
4482     struct ofproto *ofproto = ofproto_lookup(name);
4483     return (ofproto && ofproto->ofproto_class == &ofproto_dpif_class
4484             ? ofproto_dpif_cast(ofproto)
4485             : NULL);
4486 }
4487
4488 static void
4489 ofproto_unixctl_fdb_show(struct unixctl_conn *conn,
4490                          const char *args, void *aux OVS_UNUSED)
4491 {
4492     struct ds ds = DS_EMPTY_INITIALIZER;
4493     const struct ofproto_dpif *ofproto;
4494     const struct mac_entry *e;
4495
4496     ofproto = ofproto_dpif_lookup(args);
4497     if (!ofproto) {
4498         unixctl_command_reply(conn, 501, "no such bridge");
4499         return;
4500     }
4501
4502     ds_put_cstr(&ds, " port  VLAN  MAC                Age\n");
4503     LIST_FOR_EACH (e, lru_node, &ofproto->ml->lrus) {
4504         struct ofbundle *bundle = e->port.p;
4505         ds_put_format(&ds, "%5d  %4d  "ETH_ADDR_FMT"  %3d\n",
4506                       ofbundle_get_a_port(bundle)->odp_port,
4507                       e->vlan, ETH_ADDR_ARGS(e->mac), mac_entry_age(e));
4508     }
4509     unixctl_command_reply(conn, 200, ds_cstr(&ds));
4510     ds_destroy(&ds);
4511 }
4512
4513 struct ofproto_trace {
4514     struct action_xlate_ctx ctx;
4515     struct flow flow;
4516     struct ds *result;
4517 };
4518
4519 static void
4520 trace_format_rule(struct ds *result, uint8_t table_id, int level,
4521                   const struct rule_dpif *rule)
4522 {
4523     ds_put_char_multiple(result, '\t', level);
4524     if (!rule) {
4525         ds_put_cstr(result, "No match\n");
4526         return;
4527     }
4528
4529     ds_put_format(result, "Rule: table=%"PRIu8" cookie=%#"PRIx64" ",
4530                   table_id, ntohll(rule->up.flow_cookie));
4531     cls_rule_format(&rule->up.cr, result);
4532     ds_put_char(result, '\n');
4533
4534     ds_put_char_multiple(result, '\t', level);
4535     ds_put_cstr(result, "OpenFlow ");
4536     ofp_print_actions(result, rule->up.actions, rule->up.n_actions);
4537     ds_put_char(result, '\n');
4538 }
4539
4540 static void
4541 trace_format_flow(struct ds *result, int level, const char *title,
4542                  struct ofproto_trace *trace)
4543 {
4544     ds_put_char_multiple(result, '\t', level);
4545     ds_put_format(result, "%s: ", title);
4546     if (flow_equal(&trace->ctx.flow, &trace->flow)) {
4547         ds_put_cstr(result, "unchanged");
4548     } else {
4549         flow_format(result, &trace->ctx.flow);
4550         trace->flow = trace->ctx.flow;
4551     }
4552     ds_put_char(result, '\n');
4553 }
4554
4555 static void
4556 trace_format_regs(struct ds *result, int level, const char *title,
4557                   struct ofproto_trace *trace)
4558 {
4559     size_t i;
4560
4561     ds_put_char_multiple(result, '\t', level);
4562     ds_put_format(result, "%s:", title);
4563     for (i = 0; i < FLOW_N_REGS; i++) {
4564         ds_put_format(result, " reg%zu=0x%"PRIx32, i, trace->flow.regs[i]);
4565     }
4566     ds_put_char(result, '\n');
4567 }
4568
4569 static void
4570 trace_resubmit(struct action_xlate_ctx *ctx, struct rule_dpif *rule)
4571 {
4572     struct ofproto_trace *trace = CONTAINER_OF(ctx, struct ofproto_trace, ctx);
4573     struct ds *result = trace->result;
4574
4575     ds_put_char(result, '\n');
4576     trace_format_flow(result, ctx->recurse + 1, "Resubmitted flow", trace);
4577     trace_format_regs(result, ctx->recurse + 1, "Resubmitted regs", trace);
4578     trace_format_rule(result, ctx->table_id, ctx->recurse + 1, rule);
4579 }
4580
4581 static void
4582 ofproto_unixctl_trace(struct unixctl_conn *conn, const char *args_,
4583                       void *aux OVS_UNUSED)
4584 {
4585     char *dpname, *arg1, *arg2, *arg3;
4586     char *args = xstrdup(args_);
4587     char *save_ptr = NULL;
4588     struct ofproto_dpif *ofproto;
4589     struct ofpbuf odp_key;
4590     struct ofpbuf *packet;
4591     struct rule_dpif *rule;
4592     struct ds result;
4593     struct flow flow;
4594     char *s;
4595
4596     packet = NULL;
4597     ofpbuf_init(&odp_key, 0);
4598     ds_init(&result);
4599
4600     dpname = strtok_r(args, " ", &save_ptr);
4601     arg1 = strtok_r(NULL, " ", &save_ptr);
4602     arg2 = strtok_r(NULL, " ", &save_ptr);
4603     arg3 = strtok_r(NULL, "", &save_ptr); /* Get entire rest of line. */
4604     if (dpname && arg1 && (!arg2 || !strcmp(arg2, "-generate")) && !arg3) {
4605         /* ofproto/trace dpname flow [-generate] */
4606         int error;
4607
4608         /* Convert string to datapath key. */
4609         ofpbuf_init(&odp_key, 0);
4610         error = odp_flow_key_from_string(arg1, &odp_key);
4611         if (error) {
4612             unixctl_command_reply(conn, 501, "Bad flow syntax");
4613             goto exit;
4614         }
4615
4616         /* Convert odp_key to flow. */
4617         error = odp_flow_key_to_flow(odp_key.data, odp_key.size, &flow);
4618         if (error) {
4619             unixctl_command_reply(conn, 501, "Invalid flow");
4620             goto exit;
4621         }
4622
4623         /* Generate a packet, if requested. */
4624         if (arg2) {
4625             packet = ofpbuf_new(0);
4626             flow_compose(packet, &flow);
4627         }
4628     } else if (dpname && arg1 && arg2 && arg3) {
4629         /* ofproto/trace dpname tun_id in_port packet */
4630         uint16_t in_port;
4631         ovs_be64 tun_id;
4632
4633         tun_id = htonll(strtoull(arg1, NULL, 0));
4634         in_port = ofp_port_to_odp_port(atoi(arg2));
4635
4636         packet = ofpbuf_new(strlen(args) / 2);
4637         arg3 = ofpbuf_put_hex(packet, arg3, NULL);
4638         arg3 += strspn(arg3, " ");
4639         if (*arg3 != '\0') {
4640             unixctl_command_reply(conn, 501, "Trailing garbage in command");
4641             goto exit;
4642         }
4643         if (packet->size < ETH_HEADER_LEN) {
4644             unixctl_command_reply(conn, 501,
4645                                   "Packet data too short for Ethernet");
4646             goto exit;
4647         }
4648
4649         ds_put_cstr(&result, "Packet: ");
4650         s = ofp_packet_to_string(packet->data, packet->size, packet->size);
4651         ds_put_cstr(&result, s);
4652         free(s);
4653
4654         flow_extract(packet, tun_id, in_port, &flow);
4655     } else {
4656         unixctl_command_reply(conn, 501, "Bad command syntax");
4657         goto exit;
4658     }
4659
4660     ofproto = ofproto_dpif_lookup(dpname);
4661     if (!ofproto) {
4662         unixctl_command_reply(conn, 501, "Unknown ofproto (use ofproto/list "
4663                               "for help)");
4664         goto exit;
4665     }
4666
4667     ds_put_cstr(&result, "Flow: ");
4668     flow_format(&result, &flow);
4669     ds_put_char(&result, '\n');
4670
4671     rule = rule_dpif_lookup(ofproto, &flow, 0);
4672     trace_format_rule(&result, 0, 0, rule);
4673     if (rule) {
4674         struct ofproto_trace trace;
4675         struct ofpbuf *odp_actions;
4676
4677         trace.result = &result;
4678         trace.flow = flow;
4679         action_xlate_ctx_init(&trace.ctx, ofproto, &flow, packet);
4680         trace.ctx.resubmit_hook = trace_resubmit;
4681         odp_actions = xlate_actions(&trace.ctx,
4682                                     rule->up.actions, rule->up.n_actions);
4683
4684         ds_put_char(&result, '\n');
4685         trace_format_flow(&result, 0, "Final flow", &trace);
4686         ds_put_cstr(&result, "Datapath actions: ");
4687         format_odp_actions(&result, odp_actions->data, odp_actions->size);
4688         ofpbuf_delete(odp_actions);
4689
4690         if (!trace.ctx.may_set_up_flow) {
4691             if (packet) {
4692                 ds_put_cstr(&result, "\nThis flow is not cachable.");
4693             } else {
4694                 ds_put_cstr(&result, "\nThe datapath actions are incomplete--"
4695                             "for complete actions, please supply a packet.");
4696             }
4697         }
4698     }
4699
4700     unixctl_command_reply(conn, 200, ds_cstr(&result));
4701
4702 exit:
4703     ds_destroy(&result);
4704     ofpbuf_delete(packet);
4705     ofpbuf_uninit(&odp_key);
4706     free(args);
4707 }
4708
4709 static void
4710 ofproto_dpif_clog(struct unixctl_conn *conn OVS_UNUSED,
4711                   const char *args_ OVS_UNUSED, void *aux OVS_UNUSED)
4712 {
4713     clogged = true;
4714     unixctl_command_reply(conn, 200, NULL);
4715 }
4716
4717 static void
4718 ofproto_dpif_unclog(struct unixctl_conn *conn OVS_UNUSED,
4719                     const char *args_ OVS_UNUSED, void *aux OVS_UNUSED)
4720 {
4721     clogged = false;
4722     unixctl_command_reply(conn, 200, NULL);
4723 }
4724
4725 static void
4726 ofproto_dpif_unixctl_init(void)
4727 {
4728     static bool registered;
4729     if (registered) {
4730         return;
4731     }
4732     registered = true;
4733
4734     unixctl_command_register("ofproto/trace",
4735                       "bridge {tun_id in_port packet | odp_flow [-generate]}",
4736                       ofproto_unixctl_trace, NULL);
4737     unixctl_command_register("fdb/show", "bridge", ofproto_unixctl_fdb_show,
4738                              NULL);
4739     unixctl_command_register("ofproto/clog", "", ofproto_dpif_clog, NULL);
4740     unixctl_command_register("ofproto/unclog", "", ofproto_dpif_unclog, NULL);
4741 }
4742 \f
4743 const struct ofproto_class ofproto_dpif_class = {
4744     enumerate_types,
4745     enumerate_names,
4746     del,
4747     alloc,
4748     construct,
4749     destruct,
4750     dealloc,
4751     run,
4752     wait,
4753     flush,
4754     get_features,
4755     get_tables,
4756     port_alloc,
4757     port_construct,
4758     port_destruct,
4759     port_dealloc,
4760     port_modified,
4761     port_reconfigured,
4762     port_query_by_name,
4763     port_add,
4764     port_del,
4765     port_dump_start,
4766     port_dump_next,
4767     port_dump_done,
4768     port_poll,
4769     port_poll_wait,
4770     port_is_lacp_current,
4771     NULL,                       /* rule_choose_table */
4772     rule_alloc,
4773     rule_construct,
4774     rule_destruct,
4775     rule_dealloc,
4776     rule_get_stats,
4777     rule_execute,
4778     rule_modify_actions,
4779     get_drop_frags,
4780     set_drop_frags,
4781     packet_out,
4782     set_netflow,
4783     get_netflow_ids,
4784     set_sflow,
4785     set_cfm,
4786     get_cfm_fault,
4787     get_cfm_remote_mpids,
4788     bundle_set,
4789     bundle_remove,
4790     mirror_set,
4791     set_flood_vlans,
4792     is_mirror_output_bundle,
4793     forward_bpdu_changed,
4794 };