ofproto/ofproto.c

   1 /*
   2  * Copyright (c) 2009 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 #include "ofproto.h"
  19 #include <errno.h>
  20 #include <inttypes.h>
  21 #include <net/if.h>
  22 #include <netinet/in.h>
  23 #include <stdbool.h>
  24 #include <stdlib.h>
  25 #include "classifier.h"
  26 #include "coverage.h"
  27 #include "discovery.h"
  28 #include "dpif.h"
  29 #include "dynamic-string.h"
  30 #include "fail-open.h"
  31 #include "in-band.h"
  32 #include "mac-learning.h"
  33 #include "netdev.h"
  34 #include "netflow.h"
  35 #include "odp-util.h"
  36 #include "ofp-print.h"
  37 #include "ofpbuf.h"
  38 #include "openflow/nicira-ext.h"
  39 #include "openflow/openflow.h"
  40 #include "openflow/openflow-mgmt.h"
  41 #include "openvswitch/datapath-protocol.h"
  42 #include "packets.h"
  43 #include "pinsched.h"
  44 #include "pktbuf.h"
  45 #include "poll-loop.h"
  46 #include "port-array.h"
  47 #include "rconn.h"
  48 #include "shash.h"
  49 #include "status.h"
  50 #include "stp.h"
  51 #include "svec.h"
  52 #include "tag.h"
  53 #include "timeval.h"
  54 #include "unixctl.h"
  55 #include "vconn.h"
  56 #include "vconn-ssl.h"
  57 #include "xtoxll.h"
  58
  59 #define THIS_MODULE VLM_ofproto
  60 #include "vlog.h"
  61
  62 enum {
  63     DP_GROUP_FLOOD = 0,
  64     DP_GROUP_ALL = 1
  65 };
  66
  67 enum {
  68     TABLEID_HASH = 0,
  69     TABLEID_CLASSIFIER = 1
  70 };
  71
  72 struct ofport {
  73     struct netdev *netdev;
  74     struct ofp_phy_port opp;    /* In host byte order. */
  75 };
  76
  77 static void ofport_free(struct ofport *);
  78 static void hton_ofp_phy_port(struct ofp_phy_port *);
  79
  80 static int xlate_actions(const union ofp_action *in, size_t n_in,
  81                          const flow_t *flow, struct ofproto *ofproto,
  82                          const struct ofpbuf *packet,
  83                          struct odp_actions *out, tag_type *tags,
  84                          bool *may_set_up_flow, uint16_t *nf_output_iface);
  85
  86 struct rule {
  87     struct cls_rule cr;
  88
  89     uint16_t idle_timeout;      /* In seconds from time of last use. */
  90     uint16_t hard_timeout;      /* In seconds from time of creation. */
  91     long long int used;         /* Last-used time (0 if never used). */
  92     long long int created;      /* Creation time. */
  93     uint64_t packet_count;      /* Number of packets received. */
  94     uint64_t byte_count;        /* Number of bytes received. */
  95     uint64_t accounted_bytes;   /* Number of bytes passed to account_cb. */
  96     tag_type tags;              /* Tags (set only by hooks). */
  97     struct netflow_flow nf_flow; /* Per-flow NetFlow tracking data. */
  98
  99     /* If 'super' is non-NULL, this rule is a subrule, that is, it is an
 100      * exact-match rule (having cr.wc.wildcards of 0) generated from the
 101      * wildcard rule 'super'.  In this case, 'list' is an element of the
 102      * super-rule's list.
 103      *
 104      * If 'super' is NULL, this rule is a super-rule, and 'list' is the head of
 105      * a list of subrules.  A super-rule with no wildcards (where
 106      * cr.wc.wildcards is 0) will never have any subrules. */
 107     struct rule *super;
 108     struct list list;
 109
 110     /* OpenFlow actions.
 111      *
 112      * A subrule has no actions (it uses the super-rule's actions). */
 113     int n_actions;
 114     union ofp_action *actions;
 115
 116     /* Datapath actions.
 117      *
 118      * A super-rule with wildcard fields never has ODP actions (since the
 119      * datapath only supports exact-match flows). */
 120     bool installed;             /* Installed in datapath? */
 121     bool may_install;           /* True ordinarily; false if actions must
 122                                  * be reassessed for every packet. */
 123     int n_odp_actions;
 124     union odp_action *odp_actions;
 125 };
 126
 127 static inline bool
 128 rule_is_hidden(const struct rule *rule)
 129 {
 130     /* Subrules are merely an implementation detail, so hide them from the
 131      * controller. */
 132     if (rule->super != NULL) {
 133         return true;
 134     }
 135
 136     /* Rules with priority higher than UINT16_MAX are set up by ofproto itself
 137      * (e.g. by in-band control) and are intentionally hidden from the
 138      * controller. */
 139     if (rule->cr.priority > UINT16_MAX) {
 140         return true;
 141     }
 142
 143     return false;
 144 }
 145
 146 static struct rule *rule_create(struct ofproto *, struct rule *super,
 147                                 const union ofp_action *, size_t n_actions,
 148                                 uint16_t idle_timeout, uint16_t hard_timeout);
 149 static void rule_free(struct rule *);
 150 static void rule_destroy(struct ofproto *, struct rule *);
 151 static struct rule *rule_from_cls_rule(const struct cls_rule *);
 152 static void rule_insert(struct ofproto *, struct rule *,
 153                         struct ofpbuf *packet, uint16_t in_port);
 154 static void rule_remove(struct ofproto *, struct rule *);
 155 static bool rule_make_actions(struct ofproto *, struct rule *,
 156                               const struct ofpbuf *packet);
 157 static void rule_install(struct ofproto *, struct rule *,
 158                          struct rule *displaced_rule);
 159 static void rule_uninstall(struct ofproto *, struct rule *);
 160 static void rule_post_uninstall(struct ofproto *, struct rule *);
 161
 162 struct ofconn {
 163     struct list node;
 164     struct rconn *rconn;
 165     struct pktbuf *pktbuf;
 166     bool send_flow_exp;
 167     int miss_send_len;
 168
 169     struct rconn_packet_counter *packet_in_counter;
 170
 171     /* Number of OpenFlow messages queued as replies to OpenFlow requests, and
 172      * the maximum number before we stop reading OpenFlow requests.  */
 173 #define OFCONN_REPLY_MAX 100
 174     struct rconn_packet_counter *reply_counter;
 175 };
 176
 177 static struct ofconn *ofconn_create(struct ofproto *, struct rconn *);
 178 static void ofconn_destroy(struct ofconn *, struct ofproto *);
 179 static void ofconn_run(struct ofconn *, struct ofproto *);
 180 static void ofconn_wait(struct ofconn *);
 181 static void queue_tx(struct ofpbuf *msg, const struct ofconn *ofconn,
 182                      struct rconn_packet_counter *counter);
 183
 184 struct ofproto {
 185     /* Settings. */
 186     uint64_t datapath_id;       /* Datapath ID. */
 187     uint64_t fallback_dpid;     /* Datapath ID if no better choice found. */
 188     uint64_t mgmt_id;           /* Management channel identifier. */
 189     char *manufacturer;         /* Manufacturer. */
 190     char *hardware;             /* Hardware. */
 191     char *software;             /* Software version. */
 192     char *serial;               /* Serial number. */
 193
 194     /* Datapath. */
 195     struct dpif *dpif;
 196     struct netdev_monitor *netdev_monitor;
 197     struct port_array ports;    /* Index is ODP port nr; ofport->opp.port_no is
 198                                  * OFP port nr. */
 199     struct shash port_by_name;
 200     uint32_t max_ports;
 201
 202     /* Configuration. */
 203     struct switch_status *switch_status;
 204     struct status_category *ss_cat;
 205     struct in_band *in_band;
 206     struct discovery *discovery;
 207     struct fail_open *fail_open;
 208     struct pinsched *miss_sched, *action_sched;
 209     struct netflow *netflow;
 210
 211     /* Flow table. */
 212     struct classifier cls;
 213     bool need_revalidate;
 214     long long int next_expiration;
 215     struct tag_set revalidate_set;
 216
 217     /* OpenFlow connections. */
 218     struct list all_conns;
 219     struct ofconn *controller;
 220     struct pvconn **listeners;
 221     size_t n_listeners;
 222     struct pvconn **snoops;
 223     size_t n_snoops;
 224
 225     /* Hooks for ovs-vswitchd. */
 226     const struct ofhooks *ofhooks;
 227     void *aux;
 228
 229     /* Used by default ofhooks. */
 230     struct mac_learning *ml;
 231 };
 232
 233 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
 234
 235 static const struct ofhooks default_ofhooks;
 236
 237 static uint64_t pick_datapath_id(const struct ofproto *);
 238 static uint64_t pick_fallback_dpid(void);
 239 static void send_packet_in_miss(struct ofpbuf *, void *ofproto);
 240 static void send_packet_in_action(struct ofpbuf *, void *ofproto);
 241 static void update_used(struct ofproto *);
 242 static void update_stats(struct ofproto *, struct rule *,
 243                          const struct odp_flow_stats *);
 244 static void expire_rule(struct cls_rule *, void *ofproto);
 245 static void active_timeout(struct ofproto *ofproto, struct rule *rule);
 246 static bool revalidate_rule(struct ofproto *p, struct rule *rule);
 247 static void revalidate_cb(struct cls_rule *rule_, void *p_);
 248
 249 static void handle_odp_msg(struct ofproto *, struct ofpbuf *);
 250
 251 static void handle_openflow(struct ofconn *, struct ofproto *,
 252                             struct ofpbuf *);
 253
 254 static void refresh_port_group(struct ofproto *, unsigned int group);
 255 static void update_port(struct ofproto *, const char *devname);
 256 static int init_ports(struct ofproto *);
 257 static void reinit_ports(struct ofproto *);
 258
 259 int
 260 ofproto_create(const char *datapath, const struct ofhooks *ofhooks, void *aux,
 261                struct ofproto **ofprotop)
 262 {
 263     struct odp_stats stats;
 264     struct ofproto *p;
 265     struct dpif *dpif;
 266     int error;
 267
 268     *ofprotop = NULL;
 269
 270     /* Connect to datapath and start listening for messages. */
 271     error = dpif_open(datapath, &dpif);
 272     if (error) {
 273         VLOG_ERR("failed to open datapath %s: %s", datapath, strerror(error));
 274         return error;
 275     }
 276     error = dpif_get_dp_stats(dpif, &stats);
 277     if (error) {
 278         VLOG_ERR("failed to obtain stats for datapath %s: %s",
 279                  datapath, strerror(error));
 280         dpif_close(dpif);
 281         return error;
 282     }
 283     error = dpif_recv_set_mask(dpif, ODPL_MISS | ODPL_ACTION);
 284     if (error) {
 285         VLOG_ERR("failed to listen on datapath %s: %s",
 286                  datapath, strerror(error));
 287         dpif_close(dpif);
 288         return error;
 289     }
 290     dpif_flow_flush(dpif);
 291     dpif_recv_purge(dpif);
 292
 293     /* Initialize settings. */
 294     p = xzalloc(sizeof *p);
 295     p->fallback_dpid = pick_fallback_dpid();
 296     p->datapath_id = p->fallback_dpid;
 297     p->manufacturer = xstrdup("Nicira Networks, Inc.");
 298     p->hardware = xstrdup("Reference Implementation");
 299     p->software = xstrdup(VERSION BUILDNR);
 300     p->serial = xstrdup("None");
 301
 302     /* Initialize datapath. */
 303     p->dpif = dpif;
 304     p->netdev_monitor = netdev_monitor_create();
 305     port_array_init(&p->ports);
 306     shash_init(&p->port_by_name);
 307     p->max_ports = stats.max_ports;
 308
 309     /* Initialize submodules. */
 310     p->switch_status = switch_status_create(p);
 311     p->in_band = NULL;
 312     p->discovery = NULL;
 313     p->fail_open = NULL;
 314     p->miss_sched = p->action_sched = NULL;
 315     p->netflow = NULL;
 316
 317     /* Initialize flow table. */
 318     classifier_init(&p->cls);
 319     p->need_revalidate = false;
 320     p->next_expiration = time_msec() + 1000;
 321     tag_set_init(&p->revalidate_set);
 322
 323     /* Initialize OpenFlow connections. */
 324     list_init(&p->all_conns);
 325     p->controller = ofconn_create(p, rconn_create(5, 8));
 326     p->controller->pktbuf = pktbuf_create();
 327     p->controller->miss_send_len = OFP_DEFAULT_MISS_SEND_LEN;
 328     p->listeners = NULL;
 329     p->n_listeners = 0;
 330     p->snoops = NULL;
 331     p->n_snoops = 0;
 332
 333     /* Initialize hooks. */
 334     if (ofhooks) {
 335         p->ofhooks = ofhooks;
 336         p->aux = aux;
 337         p->ml = NULL;
 338     } else {
 339         p->ofhooks = &default_ofhooks;
 340         p->aux = p;
 341         p->ml = mac_learning_create();
 342     }
 343
 344     /* Register switch status category. */
 345     p->ss_cat = switch_status_register(p->switch_status, "remote",
 346                                        rconn_status_cb, p->controller->rconn);
 347
 348     /* Almost done... */
 349     error = init_ports(p);
 350     if (error) {
 351         ofproto_destroy(p);
 352         return error;
 353     }
 354
 355     /* Pick final datapath ID. */
 356     p->datapath_id = pick_datapath_id(p);
 357     VLOG_INFO("using datapath ID %012"PRIx64, p->datapath_id);
 358
 359     *ofprotop = p;
 360     return 0;
 361 }
 362
 363 void
 364 ofproto_set_datapath_id(struct ofproto *p, uint64_t datapath_id)
 365 {
 366     uint64_t old_dpid = p->datapath_id;
 367     p->datapath_id = datapath_id ? datapath_id : pick_datapath_id(p);
 368     if (p->datapath_id != old_dpid) {
 369         VLOG_INFO("datapath ID changed to %012"PRIx64, p->datapath_id);
 370         rconn_reconnect(p->controller->rconn);
 371     }
 372 }
 373
 374 void
 375 ofproto_set_mgmt_id(struct ofproto *p, uint64_t mgmt_id)
 376 {
 377     p->mgmt_id = mgmt_id;
 378 }
 379
 380 void
 381 ofproto_set_probe_interval(struct ofproto *p, int probe_interval)
 382 {
 383     probe_interval = probe_interval ? MAX(probe_interval, 5) : 0;
 384     rconn_set_probe_interval(p->controller->rconn, probe_interval);
 385     if (p->fail_open) {
 386         int trigger_duration = probe_interval ? probe_interval * 3 : 15;
 387         fail_open_set_trigger_duration(p->fail_open, trigger_duration);
 388     }
 389 }
 390
 391 void
 392 ofproto_set_max_backoff(struct ofproto *p, int max_backoff)
 393 {
 394     rconn_set_max_backoff(p->controller->rconn, max_backoff);
 395 }
 396
 397 void
 398 ofproto_set_desc(struct ofproto *p,
 399                  const char *manufacturer, const char *hardware,
 400                  const char *software, const char *serial)
 401 {
 402     if (manufacturer) {
 403         free(p->manufacturer);
 404         p->manufacturer = xstrdup(manufacturer);
 405     }
 406     if (hardware) {
 407         free(p->hardware);
 408         p->hardware = xstrdup(hardware);
 409     }
 410     if (software) {
 411         free(p->software);
 412         p->software = xstrdup(software);
 413     }
 414     if (serial) {
 415         free(p->serial);
 416         p->serial = xstrdup(serial);
 417     }
 418 }
 419
 420 int
 421 ofproto_set_in_band(struct ofproto *p, bool in_band)
 422 {
 423     if (in_band != (p->in_band != NULL)) {
 424         if (in_band) {
 425             return in_band_create(p, p->dpif, p->switch_status,
 426                                   p->controller->rconn, &p->in_band);
 427         } else {
 428             ofproto_set_discovery(p, false, NULL, true);
 429             in_band_destroy(p->in_band);
 430             p->in_band = NULL;
 431         }
 432         rconn_reconnect(p->controller->rconn);
 433     }
 434     return 0;
 435 }
 436
 437 int
 438 ofproto_set_discovery(struct ofproto *p, bool discovery,
 439                       const char *re, bool update_resolv_conf)
 440 {
 441     if (discovery != (p->discovery != NULL)) {
 442         if (discovery) {
 443             int error = ofproto_set_in_band(p, true);
 444             if (error) {
 445                 return error;
 446             }
 447             error = discovery_create(re, update_resolv_conf,
 448                                      p->dpif, p->switch_status,
 449                                      &p->discovery);
 450             if (error) {
 451                 return error;
 452             }
 453         } else {
 454             discovery_destroy(p->discovery);
 455             p->discovery = NULL;
 456         }
 457         rconn_disconnect(p->controller->rconn);
 458     } else if (discovery) {
 459         discovery_set_update_resolv_conf(p->discovery, update_resolv_conf);
 460         return discovery_set_accept_controller_re(p->discovery, re);
 461     }
 462     return 0;
 463 }
 464
 465 int
 466 ofproto_set_controller(struct ofproto *ofproto, const char *controller)
 467 {
 468     if (ofproto->discovery) {
 469         return EINVAL;
 470     } else if (controller) {
 471         if (strcmp(rconn_get_name(ofproto->controller->rconn), controller)) {
 472             return rconn_connect(ofproto->controller->rconn, controller);
 473         } else {
 474             return 0;
 475         }
 476     } else {
 477         rconn_disconnect(ofproto->controller->rconn);
 478         return 0;
 479     }
 480 }
 481
 482 static int
 483 set_pvconns(struct pvconn ***pvconnsp, size_t *n_pvconnsp,
 484             const struct svec *svec)
 485 {
 486     struct pvconn **pvconns = *pvconnsp;
 487     size_t n_pvconns = *n_pvconnsp;
 488     int retval = 0;
 489     size_t i;
 490
 491     for (i = 0; i < n_pvconns; i++) {
 492         pvconn_close(pvconns[i]);
 493     }
 494     free(pvconns);
 495
 496     pvconns = xmalloc(svec->n * sizeof *pvconns);
 497     n_pvconns = 0;
 498     for (i = 0; i < svec->n; i++) {
 499         const char *name = svec->names[i];
 500         struct pvconn *pvconn;
 501         int error;
 502
 503         error = pvconn_open(name, &pvconn);
 504         if (!error) {
 505             pvconns[n_pvconns++] = pvconn;
 506         } else {
 507             VLOG_ERR("failed to listen on %s: %s", name, strerror(error));
 508             if (!retval) {
 509                 retval = error;
 510             }
 511         }
 512     }
 513
 514     *pvconnsp = pvconns;
 515     *n_pvconnsp = n_pvconns;
 516
 517     return retval;
 518 }
 519
 520 int
 521 ofproto_set_listeners(struct ofproto *ofproto, const struct svec *listeners)
 522 {
 523     return set_pvconns(&ofproto->listeners, &ofproto->n_listeners, listeners);
 524 }
 525
 526 int
 527 ofproto_set_snoops(struct ofproto *ofproto, const struct svec *snoops)
 528 {
 529     return set_pvconns(&ofproto->snoops, &ofproto->n_snoops, snoops);
 530 }
 531
 532 int
 533 ofproto_set_netflow(struct ofproto *ofproto,
 534                     const struct netflow_options *nf_options)
 535 {
 536     if (nf_options && nf_options->collectors.n) {
 537         if (!ofproto->netflow) {
 538             ofproto->netflow = netflow_create();
 539         }
 540         return netflow_set_options(ofproto->netflow, nf_options);
 541     } else {
 542         netflow_destroy(ofproto->netflow);
 543         ofproto->netflow = NULL;
 544         return 0;
 545     }
 546 }
 547
 548 void
 549 ofproto_set_failure(struct ofproto *ofproto, bool fail_open)
 550 {
 551     if (fail_open) {
 552         struct rconn *rconn = ofproto->controller->rconn;
 553         int trigger_duration = rconn_get_probe_interval(rconn) * 3;
 554         if (!ofproto->fail_open) {
 555             ofproto->fail_open = fail_open_create(ofproto, trigger_duration,
 556                                                   ofproto->switch_status,
 557                                                   rconn);
 558         } else {
 559             fail_open_set_trigger_duration(ofproto->fail_open,
 560                                            trigger_duration);
 561         }
 562     } else {
 563         fail_open_destroy(ofproto->fail_open);
 564         ofproto->fail_open = NULL;
 565     }
 566 }
 567
 568 void
 569 ofproto_set_rate_limit(struct ofproto *ofproto,
 570                        int rate_limit, int burst_limit)
 571 {
 572     if (rate_limit > 0) {
 573         if (!ofproto->miss_sched) {
 574             ofproto->miss_sched = pinsched_create(rate_limit, burst_limit,
 575                                                   ofproto->switch_status);
 576             ofproto->action_sched = pinsched_create(rate_limit, burst_limit,
 577                                                     NULL);
 578         } else {
 579             pinsched_set_limits(ofproto->miss_sched, rate_limit, burst_limit);
 580             pinsched_set_limits(ofproto->action_sched,
 581                                 rate_limit, burst_limit);
 582         }
 583     } else {
 584         pinsched_destroy(ofproto->miss_sched);
 585         ofproto->miss_sched = NULL;
 586         pinsched_destroy(ofproto->action_sched);
 587         ofproto->action_sched = NULL;
 588     }
 589 }
 590
 591 int
 592 ofproto_set_stp(struct ofproto *ofproto UNUSED, bool enable_stp)
 593 {
 594     /* XXX */
 595     if (enable_stp) {
 596         VLOG_WARN("STP is not yet implemented");
 597         return EINVAL;
 598     } else {
 599         return 0;
 600     }
 601 }
 602
 603 uint64_t
 604 ofproto_get_datapath_id(const struct ofproto *ofproto)
 605 {
 606     return ofproto->datapath_id;
 607 }
 608
 609 uint64_t
 610 ofproto_get_mgmt_id(const struct ofproto *ofproto)
 611 {
 612     return ofproto->mgmt_id;
 613 }
 614
 615 int
 616 ofproto_get_probe_interval(const struct ofproto *ofproto)
 617 {
 618     return rconn_get_probe_interval(ofproto->controller->rconn);
 619 }
 620
 621 int
 622 ofproto_get_max_backoff(const struct ofproto *ofproto)
 623 {
 624     return rconn_get_max_backoff(ofproto->controller->rconn);
 625 }
 626
 627 bool
 628 ofproto_get_in_band(const struct ofproto *ofproto)
 629 {
 630     return ofproto->in_band != NULL;
 631 }
 632
 633 bool
 634 ofproto_get_discovery(const struct ofproto *ofproto)
 635 {
 636     return ofproto->discovery != NULL;
 637 }
 638
 639 const char *
 640 ofproto_get_controller(const struct ofproto *ofproto)
 641 {
 642     return rconn_get_name(ofproto->controller->rconn);
 643 }
 644
 645 void
 646 ofproto_get_listeners(const struct ofproto *ofproto, struct svec *listeners)
 647 {
 648     size_t i;
 649
 650     for (i = 0; i < ofproto->n_listeners; i++) {
 651         svec_add(listeners, pvconn_get_name(ofproto->listeners[i]));
 652     }
 653 }
 654
 655 void
 656 ofproto_get_snoops(const struct ofproto *ofproto, struct svec *snoops)
 657 {
 658     size_t i;
 659
 660     for (i = 0; i < ofproto->n_snoops; i++) {
 661         svec_add(snoops, pvconn_get_name(ofproto->snoops[i]));
 662     }
 663 }
 664
 665 void
 666 ofproto_destroy(struct ofproto *p)
 667 {
 668     struct ofconn *ofconn, *next_ofconn;
 669     struct ofport *ofport;
 670     unsigned int port_no;
 671     size_t i;
 672
 673     if (!p) {
 674         return;
 675     }
 676
 677     ofproto_flush_flows(p);
 678     classifier_destroy(&p->cls);
 679
 680     LIST_FOR_EACH_SAFE (ofconn, next_ofconn, struct ofconn, node,
 681                         &p->all_conns) {
 682         ofconn_destroy(ofconn, p);
 683     }
 684
 685     dpif_close(p->dpif);
 686     netdev_monitor_destroy(p->netdev_monitor);
 687     PORT_ARRAY_FOR_EACH (ofport, &p->ports, port_no) {
 688         ofport_free(ofport);
 689     }
 690     shash_destroy(&p->port_by_name);
 691
 692     switch_status_destroy(p->switch_status);
 693     in_band_destroy(p->in_band);
 694     discovery_destroy(p->discovery);
 695     fail_open_destroy(p->fail_open);
 696     pinsched_destroy(p->miss_sched);
 697     pinsched_destroy(p->action_sched);
 698     netflow_destroy(p->netflow);
 699
 700     switch_status_unregister(p->ss_cat);
 701
 702     for (i = 0; i < p->n_listeners; i++) {
 703         pvconn_close(p->listeners[i]);
 704     }
 705     free(p->listeners);
 706
 707     for (i = 0; i < p->n_snoops; i++) {
 708         pvconn_close(p->snoops[i]);
 709     }
 710     free(p->snoops);
 711
 712     mac_learning_destroy(p->ml);
 713
 714     free(p);
 715 }
 716
 717 int
 718 ofproto_run(struct ofproto *p)
 719 {
 720     int error = ofproto_run1(p);
 721     if (!error) {
 722         error = ofproto_run2(p, false);
 723     }
 724     return error;
 725 }
 726
 727 static void
 728 process_port_change(struct ofproto *ofproto, int error, char *devname)
 729 {
 730     if (error == ENOBUFS) {
 731         reinit_ports(ofproto);
 732     } else if (!error) {
 733         update_port(ofproto, devname);
 734         free(devname);
 735     }
 736 }
 737
 738 int
 739 ofproto_run1(struct ofproto *p)
 740 {
 741     struct ofconn *ofconn, *next_ofconn;
 742     char *devname;
 743     int error;
 744     int i;
 745
 746     for (i = 0; i < 50; i++) {
 747         struct ofpbuf *buf;
 748         int error;
 749
 750         error = dpif_recv(p->dpif, &buf);
 751         if (error) {
 752             if (error == ENODEV) {
 753                 /* Someone destroyed the datapath behind our back.  The caller
 754                  * better destroy us and give up, because we're just going to
 755                  * spin from here on out. */
 756                 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
 757                 VLOG_ERR_RL(&rl, "%s: datapath was destroyed externally",
 758                             dpif_name(p->dpif));
 759                 return ENODEV;
 760             }
 761             break;
 762         }
 763
 764         handle_odp_msg(p, buf);
 765     }
 766
 767     while ((error = dpif_port_poll(p->dpif, &devname)) != EAGAIN) {
 768         process_port_change(p, error, devname);
 769     }
 770     while ((error = netdev_monitor_poll(p->netdev_monitor,
 771                                         &devname)) != EAGAIN) {
 772         process_port_change(p, error, devname);
 773     }
 774
 775     if (p->in_band) {
 776         in_band_run(p->in_band);
 777     }
 778     if (p->discovery) {
 779         char *controller_name;
 780         if (rconn_is_connectivity_questionable(p->controller->rconn)) {
 781             discovery_question_connectivity(p->discovery);
 782         }
 783         if (discovery_run(p->discovery, &controller_name)) {
 784             if (controller_name) {
 785                 rconn_connect(p->controller->rconn, controller_name);
 786             } else {
 787                 rconn_disconnect(p->controller->rconn);
 788             }
 789         }
 790     }
 791     pinsched_run(p->miss_sched, send_packet_in_miss, p);
 792     pinsched_run(p->action_sched, send_packet_in_action, p);
 793
 794     LIST_FOR_EACH_SAFE (ofconn, next_ofconn, struct ofconn, node,
 795                         &p->all_conns) {
 796         ofconn_run(ofconn, p);
 797     }
 798
 799     /* Fail-open maintenance.  Do this after processing the ofconns since
 800      * fail-open checks the status of the controller rconn. */
 801     if (p->fail_open) {
 802         fail_open_run(p->fail_open);
 803     }
 804
 805     for (i = 0; i < p->n_listeners; i++) {
 806         struct vconn *vconn;
 807         int retval;
 808
 809         retval = pvconn_accept(p->listeners[i], OFP_VERSION, &vconn);
 810         if (!retval) {
 811             ofconn_create(p, rconn_new_from_vconn("passive", vconn));
 812         } else if (retval != EAGAIN) {
 813             VLOG_WARN_RL(&rl, "accept failed (%s)", strerror(retval));
 814         }
 815     }
 816
 817     for (i = 0; i < p->n_snoops; i++) {
 818         struct vconn *vconn;
 819         int retval;
 820
 821         retval = pvconn_accept(p->snoops[i], OFP_VERSION, &vconn);
 822         if (!retval) {
 823             rconn_add_monitor(p->controller->rconn, vconn);
 824         } else if (retval != EAGAIN) {
 825             VLOG_WARN_RL(&rl, "accept failed (%s)", strerror(retval));
 826         }
 827     }
 828
 829     if (time_msec() >= p->next_expiration) {
 830         COVERAGE_INC(ofproto_expiration);
 831         p->next_expiration = time_msec() + 1000;
 832         update_used(p);
 833
 834         classifier_for_each(&p->cls, CLS_INC_ALL, expire_rule, p);
 835
 836         /* Let the hook know that we're at a stable point: all outstanding data
 837          * in existing flows has been accounted to the account_cb.  Thus, the
 838          * hook can now reasonably do operations that depend on having accurate
 839          * flow volume accounting (currently, that's just bond rebalancing). */
 840         if (p->ofhooks->account_checkpoint_cb) {
 841             p->ofhooks->account_checkpoint_cb(p->aux);
 842         }
 843     }
 844
 845     if (p->netflow) {
 846         netflow_run(p->netflow);
 847     }
 848
 849     return 0;
 850 }
 851
 852 struct revalidate_cbdata {
 853     struct ofproto *ofproto;
 854     bool revalidate_all;        /* Revalidate all exact-match rules? */
 855     bool revalidate_subrules;   /* Revalidate all exact-match subrules? */
 856     struct tag_set revalidate_set; /* Set of tags to revalidate. */
 857 };
 858
 859 int
 860 ofproto_run2(struct ofproto *p, bool revalidate_all)
 861 {
 862     if (p->need_revalidate || revalidate_all
 863         || !tag_set_is_empty(&p->revalidate_set)) {
 864         struct revalidate_cbdata cbdata;
 865         cbdata.ofproto = p;
 866         cbdata.revalidate_all = revalidate_all;
 867         cbdata.revalidate_subrules = p->need_revalidate;
 868         cbdata.revalidate_set = p->revalidate_set;
 869         tag_set_init(&p->revalidate_set);
 870         COVERAGE_INC(ofproto_revalidate);
 871         classifier_for_each(&p->cls, CLS_INC_EXACT, revalidate_cb, &cbdata);
 872         p->need_revalidate = false;
 873     }
 874
 875     return 0;
 876 }
 877
 878 void
 879 ofproto_wait(struct ofproto *p)
 880 {
 881     struct ofconn *ofconn;
 882     size_t i;
 883
 884     dpif_recv_wait(p->dpif);
 885     dpif_port_poll_wait(p->dpif);
 886     netdev_monitor_poll_wait(p->netdev_monitor);
 887     LIST_FOR_EACH (ofconn, struct ofconn, node, &p->all_conns) {
 888         ofconn_wait(ofconn);
 889     }
 890     if (p->in_band) {
 891         in_band_wait(p->in_band);
 892     }
 893     if (p->discovery) {
 894         discovery_wait(p->discovery);
 895     }
 896     if (p->fail_open) {
 897         fail_open_wait(p->fail_open);
 898     }
 899     pinsched_wait(p->miss_sched);
 900     pinsched_wait(p->action_sched);
 901     if (!tag_set_is_empty(&p->revalidate_set)) {
 902         poll_immediate_wake();
 903     }
 904     if (p->need_revalidate) {
 905         /* Shouldn't happen, but if it does just go around again. */
 906         VLOG_DBG_RL(&rl, "need revalidate in ofproto_wait_cb()");
 907         poll_immediate_wake();
 908     } else if (p->next_expiration != LLONG_MAX) {
 909         poll_timer_wait(p->next_expiration - time_msec());
 910     }
 911     for (i = 0; i < p->n_listeners; i++) {
 912         pvconn_wait(p->listeners[i]);
 913     }
 914     for (i = 0; i < p->n_snoops; i++) {
 915         pvconn_wait(p->snoops[i]);
 916     }
 917 }
 918
 919 void
 920 ofproto_revalidate(struct ofproto *ofproto, tag_type tag)
 921 {
 922     tag_set_add(&ofproto->revalidate_set, tag);
 923 }
 924
 925 struct tag_set *
 926 ofproto_get_revalidate_set(struct ofproto *ofproto)
 927 {
 928     return &ofproto->revalidate_set;
 929 }
 930
 931 bool
 932 ofproto_is_alive(const struct ofproto *p)
 933 {
 934     return p->discovery || rconn_is_alive(p->controller->rconn);
 935 }
 936
 937 int
 938 ofproto_send_packet(struct ofproto *p, const flow_t *flow,
 939                     const union ofp_action *actions, size_t n_actions,
 940                     const struct ofpbuf *packet)
 941 {
 942     struct odp_actions odp_actions;
 943     int error;
 944
 945     error = xlate_actions(actions, n_actions, flow, p, packet, &odp_actions,
 946                           NULL, NULL, NULL);
 947     if (error) {
 948         return error;
 949     }
 950
 951     /* XXX Should we translate the dpif_execute() errno value into an OpenFlow
 952      * error code? */
 953     dpif_execute(p->dpif, flow->in_port, odp_actions.actions,
 954                  odp_actions.n_actions, packet);
 955     return 0;
 956 }
 957
 958 void
 959 ofproto_add_flow(struct ofproto *p,
 960                  const flow_t *flow, uint32_t wildcards, unsigned int priority,
 961                  const union ofp_action *actions, size_t n_actions,
 962                  int idle_timeout)
 963 {
 964     struct rule *rule;
 965     rule = rule_create(p, NULL, actions, n_actions,
 966                        idle_timeout >= 0 ? idle_timeout : 5 /* XXX */, 0);
 967     cls_rule_from_flow(&rule->cr, flow, wildcards, priority);
 968     rule_insert(p, rule, NULL, 0);
 969 }
 970
 971 void
 972 ofproto_delete_flow(struct ofproto *ofproto, const flow_t *flow,
 973                     uint32_t wildcards, unsigned int priority)
 974 {
 975     struct rule *rule;
 976
 977     rule = rule_from_cls_rule(classifier_find_rule_exactly(&ofproto->cls,
 978                                                            flow, wildcards,
 979                                                            priority));
 980     if (rule) {
 981         rule_remove(ofproto, rule);
 982     }
 983 }
 984
 985 static void
 986 destroy_rule(struct cls_rule *rule_, void *ofproto_)
 987 {
 988     struct rule *rule = rule_from_cls_rule(rule_);
 989     struct ofproto *ofproto = ofproto_;
 990
 991     /* Mark the flow as not installed, even though it might really be
 992      * installed, so that rule_remove() doesn't bother trying to uninstall it.
 993      * There is no point in uninstalling it individually since we are about to
 994      * blow away all the flows with dpif_flow_flush(). */
 995     rule->installed = false;
 996
 997     rule_remove(ofproto, rule);
 998 }
 999
1000 void
1001 ofproto_flush_flows(struct ofproto *ofproto)
1002 {
1003     COVERAGE_INC(ofproto_flush);
1004     classifier_for_each(&ofproto->cls, CLS_INC_ALL, destroy_rule, ofproto);
1005     dpif_flow_flush(ofproto->dpif);
1006     if (ofproto->in_band) {
1007         in_band_flushed(ofproto->in_band);
1008     }
1009     if (ofproto->fail_open) {
1010         fail_open_flushed(ofproto->fail_open);
1011     }
1012 }
1013 \f
1014 static void
1015 reinit_ports(struct ofproto *p)
1016 {
1017     struct svec devnames;
1018     struct ofport *ofport;
1019     unsigned int port_no;
1020     struct odp_port *odp_ports;
1021     size_t n_odp_ports;
1022     size_t i;
1023
1024     svec_init(&devnames);
1025     PORT_ARRAY_FOR_EACH (ofport, &p->ports, port_no) {
1026         svec_add (&devnames, (char *) ofport->opp.name);
1027     }
1028     dpif_port_list(p->dpif, &odp_ports, &n_odp_ports);
1029     for (i = 0; i < n_odp_ports; i++) {
1030         svec_add (&devnames, odp_ports[i].devname);
1031     }
1032     free(odp_ports);
1033
1034     svec_sort_unique(&devnames);
1035     for (i = 0; i < devnames.n; i++) {
1036         update_port(p, devnames.names[i]);
1037     }
1038     svec_destroy(&devnames);
1039 }
1040
1041 static void
1042 refresh_port_group(struct ofproto *p, unsigned int group)
1043 {
1044     uint16_t *ports;
1045     size_t n_ports;
1046     struct ofport *port;
1047     unsigned int port_no;
1048
1049     assert(group == DP_GROUP_ALL || group == DP_GROUP_FLOOD);
1050
1051     ports = xmalloc(port_array_count(&p->ports) * sizeof *ports);
1052     n_ports = 0;
1053     PORT_ARRAY_FOR_EACH (port, &p->ports, port_no) {
1054         if (group == DP_GROUP_ALL || !(port->opp.config & OFPPC_NO_FLOOD)) {
1055             ports[n_ports++] = port_no;
1056         }
1057     }
1058     dpif_port_group_set(p->dpif, group, ports, n_ports);
1059     free(ports);
1060 }
1061
1062 static void
1063 refresh_port_groups(struct ofproto *p)
1064 {
1065     refresh_port_group(p, DP_GROUP_FLOOD);
1066     refresh_port_group(p, DP_GROUP_ALL);
1067 }
1068
1069 static struct ofport *
1070 make_ofport(const struct odp_port *odp_port)
1071 {
1072     enum netdev_flags flags;
1073     struct ofport *ofport;
1074     struct netdev *netdev;
1075     bool carrier;
1076     int error;
1077
1078     error = netdev_open(odp_port->devname, NETDEV_ETH_TYPE_NONE, &netdev);
1079     if (error) {
1080         VLOG_WARN_RL(&rl, "ignoring port %s (%"PRIu16") because netdev %s "
1081                      "cannot be opened (%s)",
1082                      odp_port->devname, odp_port->port,
1083                      odp_port->devname, strerror(error));
1084         return NULL;
1085     }
1086
1087     ofport = xmalloc(sizeof *ofport);
1088     ofport->netdev = netdev;
1089     ofport->opp.port_no = odp_port_to_ofp_port(odp_port->port);
1090     netdev_get_etheraddr(netdev, ofport->opp.hw_addr);
1091     memcpy(ofport->opp.name, odp_port->devname,
1092            MIN(sizeof ofport->opp.name, sizeof odp_port->devname));
1093     ofport->opp.name[sizeof ofport->opp.name - 1] = '\0';
1094
1095     netdev_get_flags(netdev, &flags);
1096     ofport->opp.config = flags & NETDEV_UP ? 0 : OFPPC_PORT_DOWN;
1097
1098     netdev_get_carrier(netdev, &carrier);
1099     ofport->opp.state = carrier ? 0 : OFPPS_LINK_DOWN;
1100
1101     netdev_get_features(netdev,
1102                         &ofport->opp.curr, &ofport->opp.advertised,
1103                         &ofport->opp.supported, &ofport->opp.peer);
1104     return ofport;
1105 }
1106
1107 static bool
1108 ofport_conflicts(const struct ofproto *p, const struct odp_port *odp_port)
1109 {
1110     if (port_array_get(&p->ports, odp_port->port)) {
1111         VLOG_WARN_RL(&rl, "ignoring duplicate port %"PRIu16" in datapath",
1112                      odp_port->port);
1113         return true;
1114     } else if (shash_find(&p->port_by_name, odp_port->devname)) {
1115         VLOG_WARN_RL(&rl, "ignoring duplicate device %s in datapath",
1116                      odp_port->devname);
1117         return true;
1118     } else {
1119         return false;
1120     }
1121 }
1122
1123 static int
1124 ofport_equal(const struct ofport *a_, const struct ofport *b_)
1125 {
1126     const struct ofp_phy_port *a = &a_->opp;
1127     const struct ofp_phy_port *b = &b_->opp;
1128
1129     BUILD_ASSERT_DECL(sizeof *a == 48); /* Detect ofp_phy_port changes. */
1130     return (a->port_no == b->port_no
1131             && !memcmp(a->hw_addr, b->hw_addr, sizeof a->hw_addr)
1132             && !strcmp((char *) a->name, (char *) b->name)
1133             && a->state == b->state
1134             && a->config == b->config
1135             && a->curr == b->curr
1136             && a->advertised == b->advertised
1137             && a->supported == b->supported
1138             && a->peer == b->peer);
1139 }
1140
1141 static void
1142 send_port_status(struct ofproto *p, const struct ofport *ofport,
1143                  uint8_t reason)
1144 {
1145     /* XXX Should limit the number of queued port status change messages. */
1146     struct ofconn *ofconn;
1147     LIST_FOR_EACH (ofconn, struct ofconn, node, &p->all_conns) {
1148         struct ofp_port_status *ops;
1149         struct ofpbuf *b;
1150
1151         ops = make_openflow_xid(sizeof *ops, OFPT_PORT_STATUS, 0, &b);
1152         ops->reason = reason;
1153         ops->desc = ofport->opp;
1154         hton_ofp_phy_port(&ops->desc);
1155         queue_tx(b, ofconn, NULL);
1156     }
1157     if (p->ofhooks->port_changed_cb) {
1158         p->ofhooks->port_changed_cb(reason, &ofport->opp, p->aux);
1159     }
1160 }
1161
1162 static void
1163 ofport_install(struct ofproto *p, struct ofport *ofport)
1164 {
1165     netdev_monitor_add(p->netdev_monitor, ofport->netdev);
1166     port_array_set(&p->ports, ofp_port_to_odp_port(ofport->opp.port_no),
1167                    ofport);
1168     shash_add(&p->port_by_name, (char *) ofport->opp.name, ofport);
1169 }
1170
1171 static void
1172 ofport_remove(struct ofproto *p, struct ofport *ofport)
1173 {
1174     netdev_monitor_remove(p->netdev_monitor, ofport->netdev);
1175     port_array_set(&p->ports, ofp_port_to_odp_port(ofport->opp.port_no), NULL);
1176     shash_delete(&p->port_by_name,
1177                  shash_find(&p->port_by_name, (char *) ofport->opp.name));
1178 }
1179
1180 static void
1181 ofport_free(struct ofport *ofport)
1182 {
1183     if (ofport) {
1184         netdev_close(ofport->netdev);
1185         free(ofport);
1186     }
1187 }
1188
1189 static void
1190 update_port(struct ofproto *p, const char *devname)
1191 {
1192     struct odp_port odp_port;
1193     struct ofport *old_ofport;
1194     struct ofport *new_ofport;
1195     int error;
1196
1197     COVERAGE_INC(ofproto_update_port);
1198
1199     /* Query the datapath for port information. */
1200     error = dpif_port_query_by_name(p->dpif, devname, &odp_port);
1201
1202     /* Find the old ofport. */
1203     old_ofport = shash_find_data(&p->port_by_name, devname);
1204     if (!error) {
1205         if (!old_ofport) {
1206             /* There's no port named 'devname' but there might be a port with
1207              * the same port number.  This could happen if a port is deleted
1208              * and then a new one added in its place very quickly, or if a port
1209              * is renamed.  In the former case we want to send an OFPPR_DELETE
1210              * and an OFPPR_ADD, and in the latter case we want to send a
1211              * single OFPPR_MODIFY.  We can distinguish the cases by comparing
1212              * the old port's ifindex against the new port, or perhaps less
1213              * reliably but more portably by comparing the old port's MAC
1214              * against the new port's MAC.  However, this code isn't that smart
1215              * and always sends an OFPPR_MODIFY (XXX). */
1216             old_ofport = port_array_get(&p->ports, odp_port.port);
1217         }
1218     } else if (error != ENOENT && error != ENODEV) {
1219         VLOG_WARN_RL(&rl, "dpif_port_query_by_name returned unexpected error "
1220                      "%s", strerror(error));
1221         return;
1222     }
1223
1224     /* Create a new ofport. */
1225     new_ofport = !error ? make_ofport(&odp_port) : NULL;
1226
1227     /* Eliminate a few pathological cases. */
1228     if (!old_ofport && !new_ofport) {
1229         return;
1230     } else if (old_ofport && new_ofport) {
1231         /* Most of the 'config' bits are OpenFlow soft state, but
1232          * OFPPC_PORT_DOWN is maintained the kernel.  So transfer the OpenFlow
1233          * bits from old_ofport.  (make_ofport() only sets OFPPC_PORT_DOWN and
1234          * leaves the other bits 0.)  */
1235         new_ofport->opp.config |= old_ofport->opp.config & ~OFPPC_PORT_DOWN;
1236
1237         if (ofport_equal(old_ofport, new_ofport)) {
1238             /* False alarm--no change. */
1239             ofport_free(new_ofport);
1240             return;
1241         }
1242     }
1243
1244     /* Now deal with the normal cases. */
1245     if (old_ofport) {
1246         ofport_remove(p, old_ofport);
1247     }
1248     if (new_ofport) {
1249         ofport_install(p, new_ofport);
1250     }
1251     send_port_status(p, new_ofport ? new_ofport : old_ofport,
1252                      (!old_ofport ? OFPPR_ADD
1253                       : !new_ofport ? OFPPR_DELETE
1254                       : OFPPR_MODIFY));
1255     ofport_free(old_ofport);
1256
1257     /* Update port groups. */
1258     refresh_port_groups(p);
1259 }
1260
1261 static int
1262 init_ports(struct ofproto *p)
1263 {
1264     struct odp_port *ports;
1265     size_t n_ports;
1266     size_t i;
1267     int error;
1268
1269     error = dpif_port_list(p->dpif, &ports, &n_ports);
1270     if (error) {
1271         return error;
1272     }
1273
1274     for (i = 0; i < n_ports; i++) {
1275         const struct odp_port *odp_port = &ports[i];
1276         if (!ofport_conflicts(p, odp_port)) {
1277             struct ofport *ofport = make_ofport(odp_port);
1278             if (ofport) {
1279                 ofport_install(p, ofport);
1280             }
1281         }
1282     }
1283     free(ports);
1284     refresh_port_groups(p);
1285     return 0;
1286 }
1287 \f
1288 static struct ofconn *
1289 ofconn_create(struct ofproto *p, struct rconn *rconn)
1290 {
1291     struct ofconn *ofconn = xmalloc(sizeof *ofconn);
1292     list_push_back(&p->all_conns, &ofconn->node);
1293     ofconn->rconn = rconn;
1294     ofconn->pktbuf = NULL;
1295     ofconn->send_flow_exp = false;
1296     ofconn->miss_send_len = 0;
1297     ofconn->packet_in_counter = rconn_packet_counter_create ();
1298     ofconn->reply_counter = rconn_packet_counter_create ();
1299     return ofconn;
1300 }
1301
1302 static void
1303 ofconn_destroy(struct ofconn *ofconn, struct ofproto *p)
1304 {
1305     list_remove(&ofconn->node);
1306     rconn_destroy(ofconn->rconn);
1307     rconn_packet_counter_destroy(ofconn->packet_in_counter);
1308     rconn_packet_counter_destroy(ofconn->reply_counter);
1309     pktbuf_destroy(ofconn->pktbuf);
1310     free(ofconn);
1311 }
1312
1313 static void
1314 ofconn_run(struct ofconn *ofconn, struct ofproto *p)
1315 {
1316     int iteration;
1317
1318     rconn_run(ofconn->rconn);
1319
1320     if (rconn_packet_counter_read (ofconn->reply_counter) < OFCONN_REPLY_MAX) {
1321         /* Limit the number of iterations to prevent other tasks from
1322          * starving. */
1323         for (iteration = 0; iteration < 50; iteration++) {
1324             struct ofpbuf *of_msg = rconn_recv(ofconn->rconn);
1325             if (!of_msg) {
1326                 break;
1327             }
1328             if (p->fail_open) {
1329                 fail_open_maybe_recover(p->fail_open);
1330             }
1331             handle_openflow(ofconn, p, of_msg);
1332             ofpbuf_delete(of_msg);
1333         }
1334     }
1335
1336     if (ofconn != p->controller && !rconn_is_alive(ofconn->rconn)) {
1337         ofconn_destroy(ofconn, p);
1338     }
1339 }
1340
1341 static void
1342 ofconn_wait(struct ofconn *ofconn)
1343 {
1344     rconn_run_wait(ofconn->rconn);
1345     if (rconn_packet_counter_read (ofconn->reply_counter) < OFCONN_REPLY_MAX) {
1346         rconn_recv_wait(ofconn->rconn);
1347     } else {
1348         COVERAGE_INC(ofproto_ofconn_stuck);
1349     }
1350 }
1351 \f
1352 /* Caller is responsible for initializing the 'cr' member of the returned
1353  * rule. */
1354 static struct rule *
1355 rule_create(struct ofproto *ofproto, struct rule *super,
1356             const union ofp_action *actions, size_t n_actions,
1357             uint16_t idle_timeout, uint16_t hard_timeout)
1358 {
1359     struct rule *rule = xzalloc(sizeof *rule);
1360     rule->idle_timeout = idle_timeout;
1361     rule->hard_timeout = hard_timeout;
1362     rule->used = rule->created = time_msec();
1363     rule->super = super;
1364     if (super) {
1365         list_push_back(&super->list, &rule->list);
1366     } else {
1367         list_init(&rule->list);
1368     }
1369     rule->n_actions = n_actions;
1370     rule->actions = xmemdup(actions, n_actions * sizeof *actions);
1371     netflow_flow_clear(&rule->nf_flow);
1372     netflow_flow_update_time(ofproto->netflow, &rule->nf_flow, rule->created);
1373
1374     return rule;
1375 }
1376
1377 static struct rule *
1378 rule_from_cls_rule(const struct cls_rule *cls_rule)
1379 {
1380     return cls_rule ? CONTAINER_OF(cls_rule, struct rule, cr) : NULL;
1381 }
1382
1383 static void
1384 rule_free(struct rule *rule)
1385 {
1386     free(rule->actions);
1387     free(rule->odp_actions);
1388     free(rule);
1389 }
1390
1391 /* Destroys 'rule'.  If 'rule' is a subrule, also removes it from its
1392  * super-rule's list of subrules.  If 'rule' is a super-rule, also iterates
1393  * through all of its subrules and revalidates them, destroying any that no
1394  * longer has a super-rule (which is probably all of them).
1395  *
1396  * Before calling this function, the caller must make have removed 'rule' from
1397  * the classifier.  If 'rule' is an exact-match rule, the caller is also
1398  * responsible for ensuring that it has been uninstalled from the datapath. */
1399 static void
1400 rule_destroy(struct ofproto *ofproto, struct rule *rule)
1401 {
1402     if (!rule->super) {
1403         struct rule *subrule, *next;
1404         LIST_FOR_EACH_SAFE (subrule, next, struct rule, list, &rule->list) {
1405             revalidate_rule(ofproto, subrule);
1406         }
1407     } else {
1408         list_remove(&rule->list);
1409     }
1410     rule_free(rule);
1411 }
1412
1413 static bool
1414 rule_has_out_port(const struct rule *rule, uint16_t out_port)
1415 {
1416     const union ofp_action *oa;
1417     struct actions_iterator i;
1418
1419     if (out_port == htons(OFPP_NONE)) {
1420         return true;
1421     }
1422     for (oa = actions_first(&i, rule->actions, rule->n_actions); oa;
1423          oa = actions_next(&i)) {
1424         if (oa->type == htons(OFPAT_OUTPUT) && oa->output.port == out_port) {
1425             return true;
1426         }
1427     }
1428     return false;
1429 }
1430
1431 /* Executes the actions indicated by 'rule' on 'packet', which is in flow
1432  * 'flow' and is considered to have arrived on ODP port 'in_port'.
1433  *
1434  * The flow that 'packet' actually contains does not need to actually match
1435  * 'rule'; the actions in 'rule' will be applied to it either way.  Likewise,
1436  * the packet and byte counters for 'rule' will be credited for the packet sent
1437  * out whether or not the packet actually matches 'rule'.
1438  *
1439  * If 'rule' is an exact-match rule and 'flow' actually equals the rule's flow,
1440  * the caller must already have accurately composed ODP actions for it given
1441  * 'packet' using rule_make_actions().  If 'rule' is a wildcard rule, or if
1442  * 'rule' is an exact-match rule but 'flow' is not the rule's flow, then this
1443  * function will compose a set of ODP actions based on 'rule''s OpenFlow
1444  * actions and apply them to 'packet'. */
1445 static void
1446 rule_execute(struct ofproto *ofproto, struct rule *rule,
1447              struct ofpbuf *packet, const flow_t *flow)
1448 {
1449     const union odp_action *actions;
1450     size_t n_actions;
1451     struct odp_actions a;
1452
1453     /* Grab or compose the ODP actions.
1454      *
1455      * The special case for an exact-match 'rule' where 'flow' is not the
1456      * rule's flow is important to avoid, e.g., sending a packet out its input
1457      * port simply because the ODP actions were composed for the wrong
1458      * scenario. */
1459     if (rule->cr.wc.wildcards || !flow_equal(flow, &rule->cr.flow)) {
1460         struct rule *super = rule->super ? rule->super : rule;
1461         if (xlate_actions(super->actions, super->n_actions, flow, ofproto,
1462                           packet, &a, NULL, 0, NULL)) {
1463             return;
1464         }
1465         actions = a.actions;
1466         n_actions = a.n_actions;
1467     } else {
1468         actions = rule->odp_actions;
1469         n_actions = rule->n_odp_actions;
1470     }
1471
1472     /* Execute the ODP actions. */
1473     if (!dpif_execute(ofproto->dpif, flow->in_port,
1474                       actions, n_actions, packet)) {
1475         struct odp_flow_stats stats;
1476         flow_extract_stats(flow, packet, &stats);
1477         update_stats(ofproto, rule, &stats);
1478         rule->used = time_msec();
1479         netflow_flow_update_time(ofproto->netflow, &rule->nf_flow, rule->used);
1480     }
1481 }
1482
1483 static void
1484 rule_insert(struct ofproto *p, struct rule *rule, struct ofpbuf *packet,
1485             uint16_t in_port)
1486 {
1487     struct rule *displaced_rule;
1488
1489     /* Insert the rule in the classifier. */
1490     displaced_rule = rule_from_cls_rule(classifier_insert(&p->cls, &rule->cr));
1491     if (!rule->cr.wc.wildcards) {
1492         rule_make_actions(p, rule, packet);
1493     }
1494
1495     /* Send the packet and credit it to the rule. */
1496     if (packet) {
1497         flow_t flow;
1498         flow_extract(packet, in_port, &flow);
1499         rule_execute(p, rule, packet, &flow);
1500     }
1501
1502     /* Install the rule in the datapath only after sending the packet, to
1503      * avoid packet reordering.  */
1504     if (rule->cr.wc.wildcards) {
1505         COVERAGE_INC(ofproto_add_wc_flow);
1506         p->need_revalidate = true;
1507     } else {
1508         rule_install(p, rule, displaced_rule);
1509     }
1510
1511     /* Free the rule that was displaced, if any. */
1512     if (displaced_rule) {
1513         rule_destroy(p, displaced_rule);
1514     }
1515 }
1516
1517 static struct rule *
1518 rule_create_subrule(struct ofproto *ofproto, struct rule *rule,
1519                     const flow_t *flow)
1520 {
1521     struct rule *subrule = rule_create(ofproto, rule, NULL, 0,
1522                                        rule->idle_timeout, rule->hard_timeout);
1523     COVERAGE_INC(ofproto_subrule_create);
1524     cls_rule_from_flow(&subrule->cr, flow, 0,
1525                        (rule->cr.priority <= UINT16_MAX ? UINT16_MAX
1526                         : rule->cr.priority));
1527     classifier_insert_exact(&ofproto->cls, &subrule->cr);
1528
1529     return subrule;
1530 }
1531
1532 static void
1533 rule_remove(struct ofproto *ofproto, struct rule *rule)
1534 {
1535     if (rule->cr.wc.wildcards) {
1536         COVERAGE_INC(ofproto_del_wc_flow);
1537         ofproto->need_revalidate = true;
1538     } else {
1539         rule_uninstall(ofproto, rule);
1540     }
1541     classifier_remove(&ofproto->cls, &rule->cr);
1542     rule_destroy(ofproto, rule);
1543 }
1544
1545 /* Returns true if the actions changed, false otherwise. */
1546 static bool
1547 rule_make_actions(struct ofproto *p, struct rule *rule,
1548                   const struct ofpbuf *packet)
1549 {
1550     const struct rule *super;
1551     struct odp_actions a;
1552     size_t actions_len;
1553
1554     assert(!rule->cr.wc.wildcards);
1555
1556     super = rule->super ? rule->super : rule;
1557     rule->tags = 0;
1558     xlate_actions(super->actions, super->n_actions, &rule->cr.flow, p,
1559                   packet, &a, &rule->tags, &rule->may_install,
1560                   &rule->nf_flow.output_iface);
1561
1562     actions_len = a.n_actions * sizeof *a.actions;
1563     if (rule->n_odp_actions != a.n_actions
1564         || memcmp(rule->odp_actions, a.actions, actions_len)) {
1565         COVERAGE_INC(ofproto_odp_unchanged);
1566         free(rule->odp_actions);
1567         rule->n_odp_actions = a.n_actions;
1568         rule->odp_actions = xmemdup(a.actions, actions_len);
1569         return true;
1570     } else {
1571         return false;
1572     }
1573 }
1574
1575 static int
1576 do_put_flow(struct ofproto *ofproto, struct rule *rule, int flags,
1577             struct odp_flow_put *put)
1578 {
1579     memset(&put->flow.stats, 0, sizeof put->flow.stats);
1580     put->flow.key = rule->cr.flow;
1581     put->flow.actions = rule->odp_actions;
1582     put->flow.n_actions = rule->n_odp_actions;
1583     put->flags = flags;
1584     return dpif_flow_put(ofproto->dpif, put);
1585 }
1586
1587 static void
1588 rule_install(struct ofproto *p, struct rule *rule, struct rule *displaced_rule)
1589 {
1590     assert(!rule->cr.wc.wildcards);
1591
1592     if (rule->may_install) {
1593         struct odp_flow_put put;
1594         if (!do_put_flow(p, rule,
1595                          ODPPF_CREATE | ODPPF_MODIFY | ODPPF_ZERO_STATS,
1596                          &put)) {
1597             rule->installed = true;
1598             if (displaced_rule) {
1599                 update_stats(p, displaced_rule, &put.flow.stats);
1600                 rule_post_uninstall(p, displaced_rule);
1601             }
1602         }
1603     } else if (displaced_rule) {
1604         rule_uninstall(p, displaced_rule);
1605     }
1606 }
1607
1608 static void
1609 rule_reinstall(struct ofproto *ofproto, struct rule *rule)
1610 {
1611     if (rule->installed) {
1612         struct odp_flow_put put;
1613         COVERAGE_INC(ofproto_dp_missed);
1614         do_put_flow(ofproto, rule, ODPPF_CREATE | ODPPF_MODIFY, &put);
1615     } else {
1616         rule_install(ofproto, rule, NULL);
1617     }
1618 }
1619
1620 static void
1621 rule_update_actions(struct ofproto *ofproto, struct rule *rule)
1622 {
1623     bool actions_changed;
1624     uint16_t new_out_iface, old_out_iface;
1625
1626     old_out_iface = rule->nf_flow.output_iface;
1627     actions_changed = rule_make_actions(ofproto, rule, NULL);
1628
1629     if (rule->may_install) {
1630         if (rule->installed) {
1631             if (actions_changed) {
1632                 struct odp_flow_put put;
1633                 do_put_flow(ofproto, rule, ODPPF_CREATE | ODPPF_MODIFY
1634                                            | ODPPF_ZERO_STATS, &put);
1635                 update_stats(ofproto, rule, &put.flow.stats);
1636
1637                 /* Temporarily set the old output iface so that NetFlow
1638                  * messages have the correct output interface for the old
1639                  * stats. */
1640                 new_out_iface = rule->nf_flow.output_iface;
1641                 rule->nf_flow.output_iface = old_out_iface;
1642                 rule_post_uninstall(ofproto, rule);
1643                 rule->nf_flow.output_iface = new_out_iface;
1644             }
1645         } else {
1646             rule_install(ofproto, rule, NULL);
1647         }
1648     } else {
1649         rule_uninstall(ofproto, rule);
1650     }
1651 }
1652
1653 static void
1654 rule_account(struct ofproto *ofproto, struct rule *rule, uint64_t extra_bytes)
1655 {
1656     uint64_t total_bytes = rule->byte_count + extra_bytes;
1657
1658     if (ofproto->ofhooks->account_flow_cb
1659         && total_bytes > rule->accounted_bytes)
1660     {
1661         ofproto->ofhooks->account_flow_cb(
1662             &rule->cr.flow, rule->odp_actions, rule->n_odp_actions,
1663             total_bytes - rule->accounted_bytes, ofproto->aux);
1664         rule->accounted_bytes = total_bytes;
1665     }
1666 }
1667
1668 static void
1669 rule_uninstall(struct ofproto *p, struct rule *rule)
1670 {
1671     assert(!rule->cr.wc.wildcards);
1672     if (rule->installed) {
1673         struct odp_flow odp_flow;
1674
1675         odp_flow.key = rule->cr.flow;
1676         odp_flow.actions = NULL;
1677         odp_flow.n_actions = 0;
1678         if (!dpif_flow_del(p->dpif, &odp_flow)) {
1679             update_stats(p, rule, &odp_flow.stats);
1680         }
1681         rule->installed = false;
1682
1683         rule_post_uninstall(p, rule);
1684     }
1685 }
1686
1687 static bool
1688 is_controller_rule(struct rule *rule)
1689 {
1690     /* If the only action is send to the controller then don't report
1691      * NetFlow expiration messages since it is just part of the control
1692      * logic for the network and not real traffic. */
1693
1694     if (rule && rule->super) {
1695         struct rule *super = rule->super;
1696
1697         return super->n_actions == 1 &&
1698                super->actions[0].type == htons(OFPAT_OUTPUT) &&
1699                super->actions[0].output.port == htons(OFPP_CONTROLLER);
1700     }
1701
1702     return false;
1703 }
1704
1705 static void
1706 rule_post_uninstall(struct ofproto *ofproto, struct rule *rule)
1707 {
1708     struct rule *super = rule->super;
1709
1710     rule_account(ofproto, rule, 0);
1711
1712     if (ofproto->netflow && !is_controller_rule(rule)) {
1713         struct ofexpired expired;
1714         expired.flow = rule->cr.flow;
1715         expired.packet_count = rule->packet_count;
1716         expired.byte_count = rule->byte_count;
1717         expired.used = rule->used;
1718         netflow_expire(ofproto->netflow, &rule->nf_flow, &expired);
1719     }
1720     if (super) {
1721         super->packet_count += rule->packet_count;
1722         super->byte_count += rule->byte_count;
1723
1724         /* Reset counters to prevent double counting if the rule ever gets
1725          * reinstalled. */
1726         rule->packet_count = 0;
1727         rule->byte_count = 0;
1728         rule->accounted_bytes = 0;
1729
1730         netflow_flow_clear(&rule->nf_flow);
1731     }
1732 }
1733 \f
1734 static void
1735 queue_tx(struct ofpbuf *msg, const struct ofconn *ofconn,
1736          struct rconn_packet_counter *counter)
1737 {
1738     update_openflow_length(msg);
1739     if (rconn_send(ofconn->rconn, msg, counter)) {
1740         ofpbuf_delete(msg);
1741     }
1742 }
1743
1744 static void
1745 send_error(const struct ofconn *ofconn, const struct ofp_header *oh,
1746            int error, const void *data, size_t len)
1747 {
1748     struct ofpbuf *buf;
1749     struct ofp_error_msg *oem;
1750
1751     if (!(error >> 16)) {
1752         VLOG_WARN_RL(&rl, "not sending bad error code %d to controller",
1753                      error);
1754         return;
1755     }
1756
1757     COVERAGE_INC(ofproto_error);
1758     oem = make_openflow_xid(len + sizeof *oem, OFPT_ERROR,
1759                             oh ? oh->xid : 0, &buf);
1760     oem->type = htons((unsigned int) error >> 16);
1761     oem->code = htons(error & 0xffff);
1762     memcpy(oem->data, data, len);
1763     queue_tx(buf, ofconn, ofconn->reply_counter);
1764 }
1765
1766 static void
1767 send_error_oh(const struct ofconn *ofconn, const struct ofp_header *oh,
1768               int error)
1769 {
1770     size_t oh_length = ntohs(oh->length);
1771     send_error(ofconn, oh, error, oh, MIN(oh_length, 64));
1772 }
1773
1774 static void
1775 hton_ofp_phy_port(struct ofp_phy_port *opp)
1776 {
1777     opp->port_no = htons(opp->port_no);
1778     opp->config = htonl(opp->config);
1779     opp->state = htonl(opp->state);
1780     opp->curr = htonl(opp->curr);
1781     opp->advertised = htonl(opp->advertised);
1782     opp->supported = htonl(opp->supported);
1783     opp->peer = htonl(opp->peer);
1784 }
1785
1786 static int
1787 handle_echo_request(struct ofconn *ofconn, struct ofp_header *oh)
1788 {
1789     struct ofp_header *rq = oh;
1790     queue_tx(make_echo_reply(rq), ofconn, ofconn->reply_counter);
1791     return 0;
1792 }
1793
1794 static int
1795 handle_features_request(struct ofproto *p, struct ofconn *ofconn,
1796                         struct ofp_header *oh)
1797 {
1798     struct ofp_switch_features *osf;
1799     struct ofpbuf *buf;
1800     unsigned int port_no;
1801     struct ofport *port;
1802
1803     osf = make_openflow_xid(sizeof *osf, OFPT_FEATURES_REPLY, oh->xid, &buf);
1804     osf->datapath_id = htonll(p->datapath_id);
1805     osf->n_buffers = htonl(pktbuf_capacity());
1806     osf->n_tables = 2;
1807     osf->capabilities = htonl(OFPC_FLOW_STATS | OFPC_TABLE_STATS |
1808                               OFPC_PORT_STATS | OFPC_MULTI_PHY_TX);
1809     osf->actions = htonl((1u << OFPAT_OUTPUT) |
1810                          (1u << OFPAT_SET_VLAN_VID) |
1811                          (1u << OFPAT_SET_VLAN_PCP) |
1812                          (1u << OFPAT_STRIP_VLAN) |
1813                          (1u << OFPAT_SET_DL_SRC) |
1814                          (1u << OFPAT_SET_DL_DST) |
1815                          (1u << OFPAT_SET_NW_SRC) |
1816                          (1u << OFPAT_SET_NW_DST) |
1817                          (1u << OFPAT_SET_TP_SRC) |
1818                          (1u << OFPAT_SET_TP_DST));
1819
1820     PORT_ARRAY_FOR_EACH (port, &p->ports, port_no) {
1821         hton_ofp_phy_port(ofpbuf_put(buf, &port->opp, sizeof port->opp));
1822     }
1823
1824     queue_tx(buf, ofconn, ofconn->reply_counter);
1825     return 0;
1826 }
1827
1828 static int
1829 handle_get_config_request(struct ofproto *p, struct ofconn *ofconn,
1830                           struct ofp_header *oh)
1831 {
1832     struct ofpbuf *buf;
1833     struct ofp_switch_config *osc;
1834     uint16_t flags;
1835     bool drop_frags;
1836
1837     /* Figure out flags. */
1838     dpif_get_drop_frags(p->dpif, &drop_frags);
1839     flags = drop_frags ? OFPC_FRAG_DROP : OFPC_FRAG_NORMAL;
1840     if (ofconn->send_flow_exp) {
1841         flags |= OFPC_SEND_FLOW_EXP;
1842     }
1843
1844     /* Send reply. */
1845     osc = make_openflow_xid(sizeof *osc, OFPT_GET_CONFIG_REPLY, oh->xid, &buf);
1846     osc->flags = htons(flags);
1847     osc->miss_send_len = htons(ofconn->miss_send_len);
1848     queue_tx(buf, ofconn, ofconn->reply_counter);
1849
1850     return 0;
1851 }
1852
1853 static int
1854 handle_set_config(struct ofproto *p, struct ofconn *ofconn,
1855                   struct ofp_switch_config *osc)
1856 {
1857     uint16_t flags;
1858     int error;
1859
1860     error = check_ofp_message(&osc->header, OFPT_SET_CONFIG, sizeof *osc);
1861     if (error) {
1862         return error;
1863     }
1864     flags = ntohs(osc->flags);
1865
1866     ofconn->send_flow_exp = (flags & OFPC_SEND_FLOW_EXP) != 0;
1867
1868     if (ofconn == p->controller) {
1869         switch (flags & OFPC_FRAG_MASK) {
1870         case OFPC_FRAG_NORMAL:
1871             dpif_set_drop_frags(p->dpif, false);
1872             break;
1873         case OFPC_FRAG_DROP:
1874             dpif_set_drop_frags(p->dpif, true);
1875             break;
1876         default:
1877             VLOG_WARN_RL(&rl, "requested bad fragment mode (flags=%"PRIx16")",
1878                          osc->flags);
1879             break;
1880         }
1881     }
1882
1883     if ((ntohs(osc->miss_send_len) != 0) != (ofconn->miss_send_len != 0)) {
1884         if (ntohs(osc->miss_send_len) != 0) {
1885             ofconn->pktbuf = pktbuf_create();
1886         } else {
1887             pktbuf_destroy(ofconn->pktbuf);
1888         }
1889     }
1890
1891     ofconn->miss_send_len = ntohs(osc->miss_send_len);
1892
1893     return 0;
1894 }
1895
1896 static void
1897 add_output_group_action(struct odp_actions *actions, uint16_t group,
1898                         uint16_t *nf_output_iface)
1899 {
1900     odp_actions_add(actions, ODPAT_OUTPUT_GROUP)->output_group.group = group;
1901
1902     if (group == DP_GROUP_ALL || group == DP_GROUP_FLOOD) {
1903         *nf_output_iface = NF_OUT_FLOOD;
1904     }
1905 }
1906
1907 static void
1908 add_controller_action(struct odp_actions *actions,
1909                       const struct ofp_action_output *oao)
1910 {
1911     union odp_action *a = odp_actions_add(actions, ODPAT_CONTROLLER);
1912     a->controller.arg = oao->max_len ? ntohs(oao->max_len) : UINT32_MAX;
1913 }
1914
1915 struct action_xlate_ctx {
1916     /* Input. */
1917     const flow_t *flow;         /* Flow to which these actions correspond. */
1918     int recurse;                /* Recursion level, via xlate_table_action. */
1919     struct ofproto *ofproto;
1920     const struct ofpbuf *packet; /* The packet corresponding to 'flow', or a
1921                                   * null pointer if we are revalidating
1922                                   * without a packet to refer to. */
1923
1924     /* Output. */
1925     struct odp_actions *out;    /* Datapath actions. */
1926     tag_type *tags;             /* Tags associated with OFPP_NORMAL actions. */
1927     bool may_set_up_flow;       /* True ordinarily; false if the actions must
1928                                  * be reassessed for every packet. */
1929     uint16_t nf_output_iface;   /* Output interface index for NetFlow. */
1930 };
1931
1932 static void do_xlate_actions(const union ofp_action *in, size_t n_in,
1933                              struct action_xlate_ctx *ctx);
1934
1935 static void
1936 add_output_action(struct action_xlate_ctx *ctx, uint16_t port)
1937 {
1938     const struct ofport *ofport = port_array_get(&ctx->ofproto->ports, port);
1939
1940     if (ofport) {
1941         if (ofport->opp.config & OFPPC_NO_FWD) {
1942             /* Forwarding disabled on port. */
1943             return;
1944         }
1945     } else {
1946         /*
1947          * We don't have an ofport record for this port, but it doesn't hurt to
1948          * allow forwarding to it anyhow.  Maybe such a port will appear later
1949          * and we're pre-populating the flow table.
1950          */
1951     }
1952
1953     odp_actions_add(ctx->out, ODPAT_OUTPUT)->output.port = port;
1954     ctx->nf_output_iface = port;
1955 }
1956
1957 static struct rule *
1958 lookup_valid_rule(struct ofproto *ofproto, const flow_t *flow)
1959 {
1960     struct rule *rule;
1961     rule = rule_from_cls_rule(classifier_lookup(&ofproto->cls, flow));
1962
1963     /* The rule we found might not be valid, since we could be in need of
1964      * revalidation.  If it is not valid, don't return it. */
1965     if (rule
1966         && rule->super
1967         && ofproto->need_revalidate
1968         && !revalidate_rule(ofproto, rule)) {
1969         COVERAGE_INC(ofproto_invalidated);
1970         return NULL;
1971     }
1972
1973     return rule;
1974 }
1975
1976 static void
1977 xlate_table_action(struct action_xlate_ctx *ctx, uint16_t in_port)
1978 {
1979     if (!ctx->recurse) {
1980         struct rule *rule;
1981         flow_t flow;
1982
1983         flow = *ctx->flow;
1984         flow.in_port = in_port;
1985
1986         rule = lookup_valid_rule(ctx->ofproto, &flow);
1987         if (rule) {
1988             if (rule->super) {
1989                 rule = rule->super;
1990             }
1991
1992             ctx->recurse++;
1993             do_xlate_actions(rule->actions, rule->n_actions, ctx);
1994             ctx->recurse--;
1995         }
1996     }
1997 }
1998
1999 static void
2000 xlate_output_action(struct action_xlate_ctx *ctx,
2001                     const struct ofp_action_output *oao)
2002 {
2003     uint16_t odp_port;
2004     uint16_t prev_nf_output_iface = ctx->nf_output_iface;
2005
2006     ctx->nf_output_iface = NF_OUT_DROP;
2007
2008     switch (ntohs(oao->port)) {
2009     case OFPP_IN_PORT:
2010         add_output_action(ctx, ctx->flow->in_port);
2011         break;
2012     case OFPP_TABLE:
2013         xlate_table_action(ctx, ctx->flow->in_port);
2014         break;
2015     case OFPP_NORMAL:
2016         if (!ctx->ofproto->ofhooks->normal_cb(ctx->flow, ctx->packet,
2017                                               ctx->out, ctx->tags,
2018                                               &ctx->nf_output_iface,
2019                                               ctx->ofproto->aux)) {
2020             COVERAGE_INC(ofproto_uninstallable);
2021             ctx->may_set_up_flow = false;
2022         }
2023         break;
2024     case OFPP_FLOOD:
2025         add_output_group_action(ctx->out, DP_GROUP_FLOOD,
2026                                 &ctx->nf_output_iface);
2027         break;
2028     case OFPP_ALL:
2029         add_output_group_action(ctx->out, DP_GROUP_ALL, &ctx->nf_output_iface);
2030         break;
2031     case OFPP_CONTROLLER:
2032         add_controller_action(ctx->out, oao);
2033         break;
2034     case OFPP_LOCAL:
2035         add_output_action(ctx, ODPP_LOCAL);
2036         break;
2037     default:
2038         odp_port = ofp_port_to_odp_port(ntohs(oao->port));
2039         if (odp_port != ctx->flow->in_port) {
2040             add_output_action(ctx, odp_port);
2041         }
2042         break;
2043     }
2044
2045     if (prev_nf_output_iface == NF_OUT_FLOOD) {
2046         ctx->nf_output_iface = NF_OUT_FLOOD;
2047     } else if (ctx->nf_output_iface == NF_OUT_DROP) {
2048         ctx->nf_output_iface = prev_nf_output_iface;
2049     } else if (prev_nf_output_iface != NF_OUT_DROP &&
2050                ctx->nf_output_iface != NF_OUT_FLOOD) {
2051         ctx->nf_output_iface = NF_OUT_MULTI;
2052     }
2053 }
2054
2055 static void
2056 xlate_nicira_action(struct action_xlate_ctx *ctx,
2057                     const struct nx_action_header *nah)
2058 {
2059     const struct nx_action_resubmit *nar;
2060     int subtype = ntohs(nah->subtype);
2061
2062     assert(nah->vendor == htonl(NX_VENDOR_ID));
2063     switch (subtype) {
2064     case NXAST_RESUBMIT:
2065         nar = (const struct nx_action_resubmit *) nah;
2066         xlate_table_action(ctx, ofp_port_to_odp_port(ntohs(nar->in_port)));
2067         break;
2068
2069     default:
2070         VLOG_DBG_RL(&rl, "unknown Nicira action type %"PRIu16, subtype);
2071         break;
2072     }
2073 }
2074
2075 static void
2076 do_xlate_actions(const union ofp_action *in, size_t n_in,
2077                  struct action_xlate_ctx *ctx)
2078 {
2079     struct actions_iterator iter;
2080     const union ofp_action *ia;
2081     const struct ofport *port;
2082
2083     port = port_array_get(&ctx->ofproto->ports, ctx->flow->in_port);
2084     if (port && port->opp.config & (OFPPC_NO_RECV | OFPPC_NO_RECV_STP) &&
2085         port->opp.config & (eth_addr_equals(ctx->flow->dl_dst, stp_eth_addr)
2086                             ? OFPPC_NO_RECV_STP : OFPPC_NO_RECV)) {
2087         /* Drop this flow. */
2088         return;
2089     }
2090
2091     for (ia = actions_first(&iter, in, n_in); ia; ia = actions_next(&iter)) {
2092         uint16_t type = ntohs(ia->type);
2093         union odp_action *oa;
2094
2095         switch (type) {
2096         case OFPAT_OUTPUT:
2097             xlate_output_action(ctx, &ia->output);
2098             break;
2099
2100         case OFPAT_SET_VLAN_VID:
2101             oa = odp_actions_add(ctx->out, ODPAT_SET_VLAN_VID);
2102             oa->vlan_vid.vlan_vid = ia->vlan_vid.vlan_vid;
2103             break;
2104
2105         case OFPAT_SET_VLAN_PCP:
2106             oa = odp_actions_add(ctx->out, ODPAT_SET_VLAN_PCP);
2107             oa->vlan_pcp.vlan_pcp = ia->vlan_pcp.vlan_pcp;
2108             break;
2109
2110         case OFPAT_STRIP_VLAN:
2111             odp_actions_add(ctx->out, ODPAT_STRIP_VLAN);
2112             break;
2113
2114         case OFPAT_SET_DL_SRC:
2115             oa = odp_actions_add(ctx->out, ODPAT_SET_DL_SRC);
2116             memcpy(oa->dl_addr.dl_addr,
2117                    ((struct ofp_action_dl_addr *) ia)->dl_addr, ETH_ADDR_LEN);
2118             break;
2119
2120         case OFPAT_SET_DL_DST:
2121             oa = odp_actions_add(ctx->out, ODPAT_SET_DL_DST);
2122             memcpy(oa->dl_addr.dl_addr,
2123                    ((struct ofp_action_dl_addr *) ia)->dl_addr, ETH_ADDR_LEN);
2124             break;
2125
2126         case OFPAT_SET_NW_SRC:
2127             oa = odp_actions_add(ctx->out, ODPAT_SET_NW_SRC);
2128             oa->nw_addr.nw_addr = ia->nw_addr.nw_addr;
2129             break;
2130
2131         case OFPAT_SET_NW_DST:
2132             oa = odp_actions_add(ctx->out, ODPAT_SET_NW_DST);
2133             oa->nw_addr.nw_addr = ia->nw_addr.nw_addr;
2134             break;
2135
2136         case OFPAT_SET_TP_SRC:
2137             oa = odp_actions_add(ctx->out, ODPAT_SET_TP_SRC);
2138             oa->tp_port.tp_port = ia->tp_port.tp_port;
2139             break;
2140
2141         case OFPAT_SET_TP_DST:
2142             oa = odp_actions_add(ctx->out, ODPAT_SET_TP_DST);
2143             oa->tp_port.tp_port = ia->tp_port.tp_port;
2144             break;
2145
2146         case OFPAT_VENDOR:
2147             xlate_nicira_action(ctx, (const struct nx_action_header *) ia);
2148             break;
2149
2150         default:
2151             VLOG_DBG_RL(&rl, "unknown action type %"PRIu16, type);
2152             break;
2153         }
2154     }
2155 }
2156
2157 static int
2158 xlate_actions(const union ofp_action *in, size_t n_in,
2159               const flow_t *flow, struct ofproto *ofproto,
2160               const struct ofpbuf *packet,
2161               struct odp_actions *out, tag_type *tags, bool *may_set_up_flow,
2162               uint16_t *nf_output_iface)
2163 {
2164     tag_type no_tags = 0;
2165     struct action_xlate_ctx ctx;
2166     COVERAGE_INC(ofproto_ofp2odp);
2167     odp_actions_init(out);
2168     ctx.flow = flow;
2169     ctx.recurse = 0;
2170     ctx.ofproto = ofproto;
2171     ctx.packet = packet;
2172     ctx.out = out;
2173     ctx.tags = tags ? tags : &no_tags;
2174     ctx.may_set_up_flow = true;
2175     ctx.nf_output_iface = NF_OUT_DROP;
2176     do_xlate_actions(in, n_in, &ctx);
2177
2178     /* Check with in-band control to see if we're allowed to set up this
2179      * flow. */
2180     if (!in_band_rule_check(ofproto->in_band, flow, out)) {
2181         ctx.may_set_up_flow = false;
2182     }
2183
2184     if (may_set_up_flow) {
2185         *may_set_up_flow = ctx.may_set_up_flow;
2186     }
2187     if (nf_output_iface) {
2188         *nf_output_iface = ctx.nf_output_iface;
2189     }
2190     if (odp_actions_overflow(out)) {
2191         odp_actions_init(out);
2192         return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_TOO_MANY);
2193     }
2194     return 0;
2195 }
2196
2197 static int
2198 handle_packet_out(struct ofproto *p, struct ofconn *ofconn,
2199                   struct ofp_header *oh)
2200 {
2201     struct ofp_packet_out *opo;
2202     struct ofpbuf payload, *buffer;
2203     struct odp_actions actions;
2204     int n_actions;
2205     uint16_t in_port;
2206     flow_t flow;
2207     int error;
2208
2209     error = check_ofp_packet_out(oh, &payload, &n_actions, p->max_ports);
2210     if (error) {
2211         return error;
2212     }
2213     opo = (struct ofp_packet_out *) oh;
2214
2215     COVERAGE_INC(ofproto_packet_out);
2216     if (opo->buffer_id != htonl(UINT32_MAX)) {
2217         error = pktbuf_retrieve(ofconn->pktbuf, ntohl(opo->buffer_id),
2218                                 &buffer, &in_port);
2219         if (error || !buffer) {
2220             return error;
2221         }
2222         payload = *buffer;
2223     } else {
2224         buffer = NULL;
2225     }
2226
2227     flow_extract(&payload, ofp_port_to_odp_port(ntohs(opo->in_port)), &flow);
2228     error = xlate_actions((const union ofp_action *) opo->actions, n_actions,
2229                           &flow, p, &payload, &actions, NULL, NULL, NULL);
2230     if (error) {
2231         return error;
2232     }
2233
2234     dpif_execute(p->dpif, flow.in_port, actions.actions, actions.n_actions,
2235                  &payload);
2236     ofpbuf_delete(buffer);
2237
2238     return 0;
2239 }
2240
2241 static void
2242 update_port_config(struct ofproto *p, struct ofport *port,
2243                    uint32_t config, uint32_t mask)
2244 {
2245     mask &= config ^ port->opp.config;
2246     if (mask & OFPPC_PORT_DOWN) {
2247         if (config & OFPPC_PORT_DOWN) {
2248             netdev_turn_flags_off(port->netdev, NETDEV_UP, true);
2249         } else {
2250             netdev_turn_flags_on(port->netdev, NETDEV_UP, true);
2251         }
2252     }
2253 #define REVALIDATE_BITS (OFPPC_NO_RECV | OFPPC_NO_RECV_STP | OFPPC_NO_FWD)
2254     if (mask & REVALIDATE_BITS) {
2255         COVERAGE_INC(ofproto_costly_flags);
2256         port->opp.config ^= mask & REVALIDATE_BITS;
2257         p->need_revalidate = true;
2258     }
2259 #undef REVALIDATE_BITS
2260     if (mask & OFPPC_NO_FLOOD) {
2261         port->opp.config ^= OFPPC_NO_FLOOD;
2262         refresh_port_group(p, DP_GROUP_FLOOD);
2263     }
2264     if (mask & OFPPC_NO_PACKET_IN) {
2265         port->opp.config ^= OFPPC_NO_PACKET_IN;
2266     }
2267 }
2268
2269 static int
2270 handle_port_mod(struct ofproto *p, struct ofp_header *oh)
2271 {
2272     const struct ofp_port_mod *opm;
2273     struct ofport *port;
2274     int error;
2275
2276     error = check_ofp_message(oh, OFPT_PORT_MOD, sizeof *opm);
2277     if (error) {
2278         return error;
2279     }
2280     opm = (struct ofp_port_mod *) oh;
2281
2282     port = port_array_get(&p->ports,
2283                           ofp_port_to_odp_port(ntohs(opm->port_no)));
2284     if (!port) {
2285         return ofp_mkerr(OFPET_PORT_MOD_FAILED, OFPPMFC_BAD_PORT);
2286     } else if (memcmp(port->opp.hw_addr, opm->hw_addr, OFP_ETH_ALEN)) {
2287         return ofp_mkerr(OFPET_PORT_MOD_FAILED, OFPPMFC_BAD_HW_ADDR);
2288     } else {
2289         update_port_config(p, port, ntohl(opm->config), ntohl(opm->mask));
2290         if (opm->advertise) {
2291             netdev_set_advertisements(port->netdev, ntohl(opm->advertise));
2292         }
2293     }
2294     return 0;
2295 }
2296
2297 static struct ofpbuf *
2298 make_stats_reply(uint32_t xid, uint16_t type, size_t body_len)
2299 {
2300     struct ofp_stats_reply *osr;
2301     struct ofpbuf *msg;
2302
2303     msg = ofpbuf_new(MIN(sizeof *osr + body_len, UINT16_MAX));
2304     osr = put_openflow_xid(sizeof *osr, OFPT_STATS_REPLY, xid, msg);
2305     osr->type = type;
2306     osr->flags = htons(0);
2307     return msg;
2308 }
2309
2310 static struct ofpbuf *
2311 start_stats_reply(const struct ofp_stats_request *request, size_t body_len)
2312 {
2313     return make_stats_reply(request->header.xid, request->type, body_len);
2314 }
2315
2316 static void *
2317 append_stats_reply(size_t nbytes, struct ofconn *ofconn, struct ofpbuf **msgp)
2318 {
2319     struct ofpbuf *msg = *msgp;
2320     assert(nbytes <= UINT16_MAX - sizeof(struct ofp_stats_reply));
2321     if (nbytes + msg->size > UINT16_MAX) {
2322         struct ofp_stats_reply *reply = msg->data;
2323         reply->flags = htons(OFPSF_REPLY_MORE);
2324         *msgp = make_stats_reply(reply->header.xid, reply->type, nbytes);
2325         queue_tx(msg, ofconn, ofconn->reply_counter);
2326     }
2327     return ofpbuf_put_uninit(*msgp, nbytes);
2328 }
2329
2330 static int
2331 handle_desc_stats_request(struct ofproto *p, struct ofconn *ofconn,
2332                            struct ofp_stats_request *request)
2333 {
2334     struct ofp_desc_stats *ods;
2335     struct ofpbuf *msg;
2336
2337     msg = start_stats_reply(request, sizeof *ods);
2338     ods = append_stats_reply(sizeof *ods, ofconn, &msg);
2339     strncpy(ods->mfr_desc, p->manufacturer, sizeof ods->mfr_desc);
2340     strncpy(ods->hw_desc, p->hardware, sizeof ods->hw_desc);
2341     strncpy(ods->sw_desc, p->software, sizeof ods->sw_desc);
2342     strncpy(ods->serial_num, p->serial, sizeof ods->serial_num);
2343     queue_tx(msg, ofconn, ofconn->reply_counter);
2344
2345     return 0;
2346 }
2347
2348 static void
2349 count_subrules(struct cls_rule *cls_rule, void *n_subrules_)
2350 {
2351     struct rule *rule = rule_from_cls_rule(cls_rule);
2352     int *n_subrules = n_subrules_;
2353
2354     if (rule->super) {
2355         (*n_subrules)++;
2356     }
2357 }
2358
2359 static int
2360 handle_table_stats_request(struct ofproto *p, struct ofconn *ofconn,
2361                            struct ofp_stats_request *request)
2362 {
2363     struct ofp_table_stats *ots;
2364     struct ofpbuf *msg;
2365     struct odp_stats dpstats;
2366     int n_exact, n_subrules, n_wild;
2367
2368     msg = start_stats_reply(request, sizeof *ots * 2);
2369
2370     /* Count rules of various kinds. */
2371     n_subrules = 0;
2372     classifier_for_each(&p->cls, CLS_INC_EXACT, count_subrules, &n_subrules);
2373     n_exact = classifier_count_exact(&p->cls) - n_subrules;
2374     n_wild = classifier_count(&p->cls) - classifier_count_exact(&p->cls);
2375
2376     /* Hash table. */
2377     dpif_get_dp_stats(p->dpif, &dpstats);
2378     ots = append_stats_reply(sizeof *ots, ofconn, &msg);
2379     memset(ots, 0, sizeof *ots);
2380     ots->table_id = TABLEID_HASH;
2381     strcpy(ots->name, "hash");
2382     ots->wildcards = htonl(0);
2383     ots->max_entries = htonl(dpstats.max_capacity);
2384     ots->active_count = htonl(n_exact);
2385     ots->lookup_count = htonll(dpstats.n_frags + dpstats.n_hit +
2386                                dpstats.n_missed);
2387     ots->matched_count = htonll(dpstats.n_hit); /* XXX */
2388
2389     /* Classifier table. */
2390     ots = append_stats_reply(sizeof *ots, ofconn, &msg);
2391     memset(ots, 0, sizeof *ots);
2392     ots->table_id = TABLEID_CLASSIFIER;
2393     strcpy(ots->name, "classifier");
2394     ots->wildcards = htonl(OFPFW_ALL);
2395     ots->max_entries = htonl(65536);
2396     ots->active_count = htonl(n_wild);
2397     ots->lookup_count = htonll(0);              /* XXX */
2398     ots->matched_count = htonll(0);             /* XXX */
2399
2400     queue_tx(msg, ofconn, ofconn->reply_counter);
2401     return 0;
2402 }
2403
2404 static int
2405 handle_port_stats_request(struct ofproto *p, struct ofconn *ofconn,
2406                           struct ofp_stats_request *request)
2407 {
2408     struct ofp_port_stats *ops;
2409     struct ofpbuf *msg;
2410     struct ofport *port;
2411     unsigned int port_no;
2412
2413     msg = start_stats_reply(request, sizeof *ops * 16);
2414     PORT_ARRAY_FOR_EACH (port, &p->ports, port_no) {
2415         struct netdev_stats stats;
2416
2417         /* Intentionally ignore return value, since errors will set 'stats' to
2418          * all-1s, which is correct for OpenFlow, and netdev_get_stats() will
2419          * log errors. */
2420         netdev_get_stats(port->netdev, &stats);
2421
2422         ops = append_stats_reply(sizeof *ops, ofconn, &msg);
2423         ops->port_no = htons(odp_port_to_ofp_port(port_no));
2424         memset(ops->pad, 0, sizeof ops->pad);
2425         ops->rx_packets = htonll(stats.rx_packets);
2426         ops->tx_packets = htonll(stats.tx_packets);
2427         ops->rx_bytes = htonll(stats.rx_bytes);
2428         ops->tx_bytes = htonll(stats.tx_bytes);
2429         ops->rx_dropped = htonll(stats.rx_dropped);
2430         ops->tx_dropped = htonll(stats.tx_dropped);
2431         ops->rx_errors = htonll(stats.rx_errors);
2432         ops->tx_errors = htonll(stats.tx_errors);
2433         ops->rx_frame_err = htonll(stats.rx_frame_errors);
2434         ops->rx_over_err = htonll(stats.rx_over_errors);
2435         ops->rx_crc_err = htonll(stats.rx_crc_errors);
2436         ops->collisions = htonll(stats.collisions);
2437     }
2438
2439     queue_tx(msg, ofconn, ofconn->reply_counter);
2440     return 0;
2441 }
2442
2443 struct flow_stats_cbdata {
2444     struct ofproto *ofproto;
2445     struct ofconn *ofconn;
2446     uint16_t out_port;
2447     struct ofpbuf *msg;
2448 };
2449
2450 static void
2451 query_stats(struct ofproto *p, struct rule *rule,
2452             uint64_t *packet_countp, uint64_t *byte_countp)
2453 {
2454     uint64_t packet_count, byte_count;
2455     struct rule *subrule;
2456     struct odp_flow *odp_flows;
2457     size_t n_odp_flows;
2458
2459     packet_count = rule->packet_count;
2460     byte_count = rule->byte_count;
2461
2462     n_odp_flows = rule->cr.wc.wildcards ? list_size(&rule->list) : 1;
2463     odp_flows = xzalloc(n_odp_flows * sizeof *odp_flows);
2464     if (rule->cr.wc.wildcards) {
2465         size_t i = 0;
2466         LIST_FOR_EACH (subrule, struct rule, list, &rule->list) {
2467             odp_flows[i++].key = subrule->cr.flow;
2468             packet_count += subrule->packet_count;
2469             byte_count += subrule->byte_count;
2470         }
2471     } else {
2472         odp_flows[0].key = rule->cr.flow;
2473     }
2474
2475     packet_count = rule->packet_count;
2476     byte_count = rule->byte_count;
2477     if (!dpif_flow_get_multiple(p->dpif, odp_flows, n_odp_flows)) {
2478         size_t i;
2479         for (i = 0; i < n_odp_flows; i++) {
2480             struct odp_flow *odp_flow = &odp_flows[i];
2481             packet_count += odp_flow->stats.n_packets;
2482             byte_count += odp_flow->stats.n_bytes;
2483         }
2484     }
2485     free(odp_flows);
2486
2487     *packet_countp = packet_count;
2488     *byte_countp = byte_count;
2489 }
2490
2491 static void
2492 flow_stats_cb(struct cls_rule *rule_, void *cbdata_)
2493 {
2494     struct rule *rule = rule_from_cls_rule(rule_);
2495     struct flow_stats_cbdata *cbdata = cbdata_;
2496     struct ofp_flow_stats *ofs;
2497     uint64_t packet_count, byte_count;
2498     size_t act_len, len;
2499
2500     if (rule_is_hidden(rule) || !rule_has_out_port(rule, cbdata->out_port)) {
2501         return;
2502     }
2503
2504     act_len = sizeof *rule->actions * rule->n_actions;
2505     len = offsetof(struct ofp_flow_stats, actions) + act_len;
2506
2507     query_stats(cbdata->ofproto, rule, &packet_count, &byte_count);
2508
2509     ofs = append_stats_reply(len, cbdata->ofconn, &cbdata->msg);
2510     ofs->length = htons(len);
2511     ofs->table_id = rule->cr.wc.wildcards ? TABLEID_CLASSIFIER : TABLEID_HASH;
2512     ofs->pad = 0;
2513     flow_to_match(&rule->cr.flow, rule->cr.wc.wildcards, &ofs->match);
2514     ofs->duration = htonl((time_msec() - rule->created) / 1000);
2515     ofs->priority = htons(rule->cr.priority);
2516     ofs->idle_timeout = htons(rule->idle_timeout);
2517     ofs->hard_timeout = htons(rule->hard_timeout);
2518     memset(ofs->pad2, 0, sizeof ofs->pad2);
2519     ofs->packet_count = htonll(packet_count);
2520     ofs->byte_count = htonll(byte_count);
2521     memcpy(ofs->actions, rule->actions, act_len);
2522 }
2523
2524 static int
2525 table_id_to_include(uint8_t table_id)
2526 {
2527     return (table_id == TABLEID_HASH ? CLS_INC_EXACT
2528             : table_id == TABLEID_CLASSIFIER ? CLS_INC_WILD
2529             : table_id == 0xff ? CLS_INC_ALL
2530             : 0);
2531 }
2532
2533 static int
2534 handle_flow_stats_request(struct ofproto *p, struct ofconn *ofconn,
2535                           const struct ofp_stats_request *osr,
2536                           size_t arg_size)
2537 {
2538     struct ofp_flow_stats_request *fsr;
2539     struct flow_stats_cbdata cbdata;
2540     struct cls_rule target;
2541
2542     if (arg_size != sizeof *fsr) {
2543         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LENGTH);
2544     }
2545     fsr = (struct ofp_flow_stats_request *) osr->body;
2546
2547     COVERAGE_INC(ofproto_flows_req);
2548     cbdata.ofproto = p;
2549     cbdata.ofconn = ofconn;
2550     cbdata.out_port = fsr->out_port;
2551     cbdata.msg = start_stats_reply(osr, 1024);
2552     cls_rule_from_match(&target, &fsr->match, 0);
2553     classifier_for_each_match(&p->cls, &target,
2554                               table_id_to_include(fsr->table_id),
2555                               flow_stats_cb, &cbdata);
2556     queue_tx(cbdata.msg, ofconn, ofconn->reply_counter);
2557     return 0;
2558 }
2559
2560 struct flow_stats_ds_cbdata {
2561     struct ofproto *ofproto;
2562     struct ds *results;
2563 };
2564
2565 static void
2566 flow_stats_ds_cb(struct cls_rule *rule_, void *cbdata_)
2567 {
2568     struct rule *rule = rule_from_cls_rule(rule_);
2569     struct flow_stats_ds_cbdata *cbdata = cbdata_;
2570     struct ds *results = cbdata->results;
2571     struct ofp_match match;
2572     uint64_t packet_count, byte_count;
2573     size_t act_len = sizeof *rule->actions * rule->n_actions;
2574
2575     /* Don't report on subrules. */
2576     if (rule->super != NULL) {
2577         return;
2578     }
2579
2580     query_stats(cbdata->ofproto, rule, &packet_count, &byte_count);
2581     flow_to_ovs_match(&rule->cr.flow, rule->cr.wc.wildcards, &match);
2582
2583     ds_put_format(results, "duration=%llds, ",
2584                   (time_msec() - rule->created) / 1000);
2585     ds_put_format(results, "priority=%u, ", rule->cr.priority);
2586     ds_put_format(results, "n_packets=%"PRIu64", ", packet_count);
2587     ds_put_format(results, "n_bytes=%"PRIu64", ", byte_count);
2588     ofp_print_match(results, &match, true);
2589     ofp_print_actions(results, &rule->actions->header, act_len);
2590     ds_put_cstr(results, "\n");
2591 }
2592
2593 /* Adds a pretty-printed description of all flows to 'results', including
2594  * those marked hidden by secchan (e.g., by in-band control). */
2595 void
2596 ofproto_get_all_flows(struct ofproto *p, struct ds *results)
2597 {
2598     struct ofp_match match;
2599     struct cls_rule target;
2600     struct flow_stats_ds_cbdata cbdata;
2601
2602     memset(&match, 0, sizeof match);
2603     match.wildcards = htonl(OFPFW_ALL);
2604
2605     cbdata.ofproto = p;
2606     cbdata.results = results;
2607
2608     cls_rule_from_match(&target, &match, 0);
2609     classifier_for_each_match(&p->cls, &target, CLS_INC_ALL,
2610                               flow_stats_ds_cb, &cbdata);
2611 }
2612
2613 struct aggregate_stats_cbdata {
2614     struct ofproto *ofproto;
2615     uint16_t out_port;
2616     uint64_t packet_count;
2617     uint64_t byte_count;
2618     uint32_t n_flows;
2619 };
2620
2621 static void
2622 aggregate_stats_cb(struct cls_rule *rule_, void *cbdata_)
2623 {
2624     struct rule *rule = rule_from_cls_rule(rule_);
2625     struct aggregate_stats_cbdata *cbdata = cbdata_;
2626     uint64_t packet_count, byte_count;
2627
2628     if (rule_is_hidden(rule) || !rule_has_out_port(rule, cbdata->out_port)) {
2629         return;
2630     }
2631
2632     query_stats(cbdata->ofproto, rule, &packet_count, &byte_count);
2633
2634     cbdata->packet_count += packet_count;
2635     cbdata->byte_count += byte_count;
2636     cbdata->n_flows++;
2637 }
2638
2639 static int
2640 handle_aggregate_stats_request(struct ofproto *p, struct ofconn *ofconn,
2641                                const struct ofp_stats_request *osr,
2642                                size_t arg_size)
2643 {
2644     struct ofp_aggregate_stats_request *asr;
2645     struct ofp_aggregate_stats_reply *reply;
2646     struct aggregate_stats_cbdata cbdata;
2647     struct cls_rule target;
2648     struct ofpbuf *msg;
2649
2650     if (arg_size != sizeof *asr) {
2651         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LENGTH);
2652     }
2653     asr = (struct ofp_aggregate_stats_request *) osr->body;
2654
2655     COVERAGE_INC(ofproto_agg_request);
2656     cbdata.ofproto = p;
2657     cbdata.out_port = asr->out_port;
2658     cbdata.packet_count = 0;
2659     cbdata.byte_count = 0;
2660     cbdata.n_flows = 0;
2661     cls_rule_from_match(&target, &asr->match, 0);
2662     classifier_for_each_match(&p->cls, &target,
2663                               table_id_to_include(asr->table_id),
2664                               aggregate_stats_cb, &cbdata);
2665
2666     msg = start_stats_reply(osr, sizeof *reply);
2667     reply = append_stats_reply(sizeof *reply, ofconn, &msg);
2668     reply->flow_count = htonl(cbdata.n_flows);
2669     reply->packet_count = htonll(cbdata.packet_count);
2670     reply->byte_count = htonll(cbdata.byte_count);
2671     queue_tx(msg, ofconn, ofconn->reply_counter);
2672     return 0;
2673 }
2674
2675 static int
2676 handle_stats_request(struct ofproto *p, struct ofconn *ofconn,
2677                      struct ofp_header *oh)
2678 {
2679     struct ofp_stats_request *osr;
2680     size_t arg_size;
2681     int error;
2682
2683     error = check_ofp_message_array(oh, OFPT_STATS_REQUEST, sizeof *osr,
2684                                     1, &arg_size);
2685     if (error) {
2686         return error;
2687     }
2688     osr = (struct ofp_stats_request *) oh;
2689
2690     switch (ntohs(osr->type)) {
2691     case OFPST_DESC:
2692         return handle_desc_stats_request(p, ofconn, osr);
2693
2694     case OFPST_FLOW:
2695         return handle_flow_stats_request(p, ofconn, osr, arg_size);
2696
2697     case OFPST_AGGREGATE:
2698         return handle_aggregate_stats_request(p, ofconn, osr, arg_size);
2699
2700     case OFPST_TABLE:
2701         return handle_table_stats_request(p, ofconn, osr);
2702
2703     case OFPST_PORT:
2704         return handle_port_stats_request(p, ofconn, osr);
2705
2706     case OFPST_VENDOR:
2707         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_VENDOR);
2708
2709     default:
2710         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_STAT);
2711     }
2712 }
2713
2714 static long long int
2715 msec_from_nsec(uint64_t sec, uint32_t nsec)
2716 {
2717     return !sec ? 0 : sec * 1000 + nsec / 1000000;
2718 }
2719
2720 static void
2721 update_time(struct ofproto *ofproto, struct rule *rule,
2722             const struct odp_flow_stats *stats)
2723 {
2724     long long int used = msec_from_nsec(stats->used_sec, stats->used_nsec);
2725     if (used > rule->used) {
2726         rule->used = used;
2727         if (rule->super && used > rule->super->used) {
2728             rule->super->used = used;
2729         }
2730         netflow_flow_update_time(ofproto->netflow, &rule->nf_flow, used);
2731     }
2732 }
2733
2734 static void
2735 update_stats(struct ofproto *ofproto, struct rule *rule,
2736              const struct odp_flow_stats *stats)
2737 {
2738     if (stats->n_packets) {
2739         update_time(ofproto, rule, stats);
2740         rule->packet_count += stats->n_packets;
2741         rule->byte_count += stats->n_bytes;
2742         netflow_flow_update_flags(&rule->nf_flow, stats->ip_tos,
2743                                   stats->tcp_flags);
2744     }
2745 }
2746
2747 static int
2748 add_flow(struct ofproto *p, struct ofconn *ofconn,
2749          struct ofp_flow_mod *ofm, size_t n_actions)
2750 {
2751     struct ofpbuf *packet;
2752     struct rule *rule;
2753     uint16_t in_port;
2754     int error;
2755
2756     rule = rule_create(p, NULL, (const union ofp_action *) ofm->actions,
2757                        n_actions, ntohs(ofm->idle_timeout),
2758                        ntohs(ofm->hard_timeout));
2759     cls_rule_from_match(&rule->cr, &ofm->match, ntohs(ofm->priority));
2760
2761     packet = NULL;
2762     error = 0;
2763     if (ofm->buffer_id != htonl(UINT32_MAX)) {
2764         error = pktbuf_retrieve(ofconn->pktbuf, ntohl(ofm->buffer_id),
2765                                 &packet, &in_port);
2766     }
2767
2768     rule_insert(p, rule, packet, in_port);
2769     ofpbuf_delete(packet);
2770     return error;
2771 }
2772
2773 static int
2774 modify_flow(struct ofproto *p, const struct ofp_flow_mod *ofm,
2775             size_t n_actions, uint16_t command, struct rule *rule)
2776 {
2777     if (rule_is_hidden(rule)) {
2778         return 0;
2779     }
2780
2781     if (command == OFPFC_DELETE) {
2782         rule_remove(p, rule);
2783     } else {
2784         size_t actions_len = n_actions * sizeof *rule->actions;
2785
2786         if (n_actions == rule->n_actions
2787             && !memcmp(ofm->actions, rule->actions, actions_len))
2788         {
2789             return 0;
2790         }
2791
2792         free(rule->actions);
2793         rule->actions = xmemdup(ofm->actions, actions_len);
2794         rule->n_actions = n_actions;
2795
2796         if (rule->cr.wc.wildcards) {
2797             COVERAGE_INC(ofproto_mod_wc_flow);
2798             p->need_revalidate = true;
2799         } else {
2800             rule_update_actions(p, rule);
2801         }
2802     }
2803
2804     return 0;
2805 }
2806
2807 static int
2808 modify_flows_strict(struct ofproto *p, const struct ofp_flow_mod *ofm,
2809                     size_t n_actions, uint16_t command)
2810 {
2811     struct rule *rule;
2812     uint32_t wildcards;
2813     flow_t flow;
2814
2815     flow_from_match(&flow, &wildcards, &ofm->match);
2816     rule = rule_from_cls_rule(classifier_find_rule_exactly(
2817                                   &p->cls, &flow, wildcards,
2818                                   ntohs(ofm->priority)));
2819
2820     if (rule) {
2821         if (command == OFPFC_DELETE
2822             && ofm->out_port != htons(OFPP_NONE)
2823             && !rule_has_out_port(rule, ofm->out_port)) {
2824             return 0;
2825         }
2826
2827         modify_flow(p, ofm, n_actions, command, rule);
2828     }
2829     return 0;
2830 }
2831
2832 struct modify_flows_cbdata {
2833     struct ofproto *ofproto;
2834     const struct ofp_flow_mod *ofm;
2835     uint16_t out_port;
2836     size_t n_actions;
2837     uint16_t command;
2838 };
2839
2840 static void
2841 modify_flows_cb(struct cls_rule *rule_, void *cbdata_)
2842 {
2843     struct rule *rule = rule_from_cls_rule(rule_);
2844     struct modify_flows_cbdata *cbdata = cbdata_;
2845
2846     if (cbdata->out_port != htons(OFPP_NONE)
2847         && !rule_has_out_port(rule, cbdata->out_port)) {
2848         return;
2849     }
2850
2851     modify_flow(cbdata->ofproto, cbdata->ofm, cbdata->n_actions,
2852                 cbdata->command, rule);
2853 }
2854
2855 static int
2856 modify_flows_loose(struct ofproto *p, const struct ofp_flow_mod *ofm,
2857                    size_t n_actions, uint16_t command)
2858 {
2859     struct modify_flows_cbdata cbdata;
2860     struct cls_rule target;
2861
2862     cbdata.ofproto = p;
2863     cbdata.ofm = ofm;
2864     cbdata.out_port = (command == OFPFC_DELETE ? ofm->out_port
2865                        : htons(OFPP_NONE));
2866     cbdata.n_actions = n_actions;
2867     cbdata.command = command;
2868
2869     cls_rule_from_match(&target, &ofm->match, 0);
2870
2871     classifier_for_each_match(&p->cls, &target, CLS_INC_ALL,
2872                               modify_flows_cb, &cbdata);
2873     return 0;
2874 }
2875
2876 static int
2877 handle_flow_mod(struct ofproto *p, struct ofconn *ofconn,
2878                 struct ofp_flow_mod *ofm)
2879 {
2880     size_t n_actions;
2881     int error;
2882
2883     error = check_ofp_message_array(&ofm->header, OFPT_FLOW_MOD, sizeof *ofm,
2884                                     sizeof *ofm->actions, &n_actions);
2885     if (error) {
2886         return error;
2887     }
2888
2889     normalize_match(&ofm->match);
2890     if (!ofm->match.wildcards) {
2891         ofm->priority = htons(UINT16_MAX);
2892     }
2893
2894     error = validate_actions((const union ofp_action *) ofm->actions,
2895                              n_actions, p->max_ports);
2896     if (error) {
2897         return error;
2898     }
2899
2900     switch (ntohs(ofm->command)) {
2901     case OFPFC_ADD:
2902         return add_flow(p, ofconn, ofm, n_actions);
2903
2904     case OFPFC_MODIFY:
2905         return modify_flows_loose(p, ofm, n_actions, OFPFC_MODIFY);
2906
2907     case OFPFC_MODIFY_STRICT:
2908         return modify_flows_strict(p, ofm, n_actions, OFPFC_MODIFY);
2909
2910     case OFPFC_DELETE:
2911         return modify_flows_loose(p, ofm, n_actions, OFPFC_DELETE);
2912
2913     case OFPFC_DELETE_STRICT:
2914         return modify_flows_strict(p, ofm, n_actions, OFPFC_DELETE);
2915
2916     default:
2917         return ofp_mkerr(OFPET_FLOW_MOD_FAILED, OFPFMFC_BAD_COMMAND);
2918     }
2919 }
2920
2921 static void
2922 send_capability_reply(struct ofproto *p, struct ofconn *ofconn, uint32_t xid)
2923 {
2924     struct ofmp_capability_reply *ocr;
2925     struct ofpbuf *b;
2926     char capabilities[] = "com.nicira.mgmt.manager=false\n";
2927
2928     ocr = make_openflow_xid(sizeof(*ocr), OFPT_VENDOR, xid, &b);
2929     ocr->header.header.vendor = htonl(NX_VENDOR_ID);
2930     ocr->header.header.subtype = htonl(NXT_MGMT);
2931     ocr->header.type = htons(OFMPT_CAPABILITY_REPLY);
2932
2933     ocr->format = htonl(OFMPCOF_SIMPLE);
2934     ocr->mgmt_id = htonll(p->mgmt_id);
2935
2936     ofpbuf_put(b, capabilities, strlen(capabilities));
2937
2938     queue_tx(b, ofconn, ofconn->reply_counter);
2939 }
2940
2941 static int
2942 handle_ofmp(struct ofproto *p, struct ofconn *ofconn,
2943             struct ofmp_header *ofmph)
2944 {
2945     size_t msg_len = ntohs(ofmph->header.header.length);
2946     if (msg_len < sizeof(*ofmph)) {
2947         VLOG_WARN_RL(&rl, "dropping short managment message: %zu\n", msg_len);
2948         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LENGTH);
2949     }
2950
2951     if (ofmph->type == htons(OFMPT_CAPABILITY_REQUEST)) {
2952         struct ofmp_capability_request *ofmpcr;
2953
2954         if (msg_len < sizeof(struct ofmp_capability_request)) {
2955             VLOG_WARN_RL(&rl, "dropping short capability request: %zu\n",
2956                     msg_len);
2957             return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LENGTH);
2958         }
2959
2960         ofmpcr = (struct ofmp_capability_request *)ofmph;
2961         if (ofmpcr->format != htonl(OFMPCAF_SIMPLE)) {
2962             /* xxx Find a better type than bad subtype */
2963             return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_SUBTYPE);
2964         }
2965
2966         send_capability_reply(p, ofconn, ofmph->header.header.xid);
2967         return 0;
2968     } else {
2969         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_SUBTYPE);
2970     }
2971 }
2972
2973 static int
2974 handle_vendor(struct ofproto *p, struct ofconn *ofconn, void *msg)
2975 {
2976     struct ofp_vendor_header *ovh = msg;
2977     struct nicira_header *nh;
2978
2979     if (ntohs(ovh->header.length) < sizeof(struct ofp_vendor_header)) {
2980         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LENGTH);
2981     }
2982     if (ovh->vendor != htonl(NX_VENDOR_ID)) {
2983         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_VENDOR);
2984     }
2985     if (ntohs(ovh->header.length) < sizeof(struct nicira_header)) {
2986         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LENGTH);
2987     }
2988
2989     nh = msg;
2990     switch (ntohl(nh->subtype)) {
2991     case NXT_STATUS_REQUEST:
2992         return switch_status_handle_request(p->switch_status, ofconn->rconn,
2993                                             msg);
2994
2995     case NXT_ACT_SET_CONFIG:
2996         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_SUBTYPE); /* XXX */
2997
2998     case NXT_ACT_GET_CONFIG:
2999         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_SUBTYPE); /* XXX */
3000
3001     case NXT_MGMT:
3002         return handle_ofmp(p, ofconn, msg);
3003     }
3004
3005     return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_SUBTYPE);
3006 }
3007
3008 static void
3009 handle_openflow(struct ofconn *ofconn, struct ofproto *p,
3010                 struct ofpbuf *ofp_msg)
3011 {
3012     struct ofp_header *oh = ofp_msg->data;
3013     int error;
3014
3015     COVERAGE_INC(ofproto_recv_openflow);
3016     switch (oh->type) {
3017     case OFPT_ECHO_REQUEST:
3018         error = handle_echo_request(ofconn, oh);
3019         break;
3020
3021     case OFPT_ECHO_REPLY:
3022         error = 0;
3023         break;
3024
3025     case OFPT_FEATURES_REQUEST:
3026         error = handle_features_request(p, ofconn, oh);
3027         break;
3028
3029     case OFPT_GET_CONFIG_REQUEST:
3030         error = handle_get_config_request(p, ofconn, oh);
3031         break;
3032
3033     case OFPT_SET_CONFIG:
3034         error = handle_set_config(p, ofconn, ofp_msg->data);
3035         break;
3036
3037     case OFPT_PACKET_OUT:
3038         error = handle_packet_out(p, ofconn, ofp_msg->data);
3039         break;
3040
3041     case OFPT_PORT_MOD:
3042         error = handle_port_mod(p, oh);
3043         break;
3044
3045     case OFPT_FLOW_MOD:
3046         error = handle_flow_mod(p, ofconn, ofp_msg->data);
3047         break;
3048
3049     case OFPT_STATS_REQUEST:
3050         error = handle_stats_request(p, ofconn, oh);
3051         break;
3052
3053     case OFPT_VENDOR:
3054         error = handle_vendor(p, ofconn, ofp_msg->data);
3055         break;
3056
3057     default:
3058         if (VLOG_IS_WARN_ENABLED()) {
3059             char *s = ofp_to_string(oh, ntohs(oh->length), 2);
3060             VLOG_DBG_RL(&rl, "OpenFlow message ignored: %s", s);
3061             free(s);
3062         }
3063         error = ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_TYPE);
3064         break;
3065     }
3066
3067     if (error) {
3068         send_error_oh(ofconn, ofp_msg->data, error);
3069     }
3070 }
3071 \f
3072 static void
3073 handle_odp_msg(struct ofproto *p, struct ofpbuf *packet)
3074 {
3075     struct odp_msg *msg = packet->data;
3076     uint16_t in_port = odp_port_to_ofp_port(msg->port);
3077     struct rule *rule;
3078     struct ofpbuf payload;
3079     flow_t flow;
3080
3081     /* Handle controller actions. */
3082     if (msg->type == _ODPL_ACTION_NR) {
3083         COVERAGE_INC(ofproto_ctlr_action);
3084         pinsched_send(p->action_sched, in_port, packet,
3085                       send_packet_in_action, p);
3086         return;
3087     }
3088
3089     payload.data = msg + 1;
3090     payload.size = msg->length - sizeof *msg;
3091     flow_extract(&payload, msg->port, &flow);
3092
3093     /* Check with in-band control to see if this packet should be sent
3094      * to the local port regardless of the flow table. */
3095     if (in_band_msg_in_hook(p->in_band, &flow, &payload)) {
3096         union odp_action action;
3097
3098         memset(&action, 0, sizeof(action));
3099         action.output.type = ODPAT_OUTPUT;
3100         action.output.port = ODPP_LOCAL;
3101         dpif_execute(p->dpif, flow.in_port, &action, 1, &payload);
3102     }
3103
3104     rule = lookup_valid_rule(p, &flow);
3105     if (!rule) {
3106         /* Don't send a packet-in if OFPPC_NO_PACKET_IN asserted. */
3107         struct ofport *port = port_array_get(&p->ports, msg->port);
3108         if (port) {
3109             if (port->opp.config & OFPPC_NO_PACKET_IN) {
3110                 COVERAGE_INC(ofproto_no_packet_in);
3111                 /* XXX install 'drop' flow entry */
3112                 ofpbuf_delete(packet);
3113                 return;
3114             }
3115         } else {
3116             VLOG_WARN_RL(&rl, "packet-in on unknown port %"PRIu16, msg->port);
3117         }
3118
3119         COVERAGE_INC(ofproto_packet_in);
3120         pinsched_send(p->miss_sched, in_port, packet, send_packet_in_miss, p);
3121         return;
3122     }
3123
3124     if (rule->cr.wc.wildcards) {
3125         rule = rule_create_subrule(p, rule, &flow);
3126         rule_make_actions(p, rule, packet);
3127     } else {
3128         if (!rule->may_install) {
3129             /* The rule is not installable, that is, we need to process every
3130              * packet, so process the current packet and set its actions into
3131              * 'subrule'. */
3132             rule_make_actions(p, rule, packet);
3133         } else {
3134             /* XXX revalidate rule if it needs it */
3135         }
3136     }
3137
3138     rule_execute(p, rule, &payload, &flow);
3139     rule_reinstall(p, rule);
3140
3141     if (rule->super && rule->super->cr.priority == FAIL_OPEN_PRIORITY
3142         && rconn_is_connected(p->controller->rconn)) {
3143         /*
3144          * Extra-special case for fail-open mode.
3145          *
3146          * We are in fail-open mode and the packet matched the fail-open rule,
3147          * but we are connected to a controller too.  We should send the packet
3148          * up to the controller in the hope that it will try to set up a flow
3149          * and thereby allow us to exit fail-open.
3150          *
3151          * See the top-level comment in fail-open.c for more information.
3152          */
3153         pinsched_send(p->miss_sched, in_port, packet, send_packet_in_miss, p);
3154     } else {
3155         ofpbuf_delete(packet);
3156     }
3157 }
3158 \f
3159 static void
3160 revalidate_cb(struct cls_rule *sub_, void *cbdata_)
3161 {
3162     struct rule *sub = rule_from_cls_rule(sub_);
3163     struct revalidate_cbdata *cbdata = cbdata_;
3164
3165     if (cbdata->revalidate_all
3166         || (cbdata->revalidate_subrules && sub->super)
3167         || (tag_set_intersects(&cbdata->revalidate_set, sub->tags))) {
3168         revalidate_rule(cbdata->ofproto, sub);
3169     }
3170 }
3171
3172 static bool
3173 revalidate_rule(struct ofproto *p, struct rule *rule)
3174 {
3175     const flow_t *flow = &rule->cr.flow;
3176
3177     COVERAGE_INC(ofproto_revalidate_rule);
3178     if (rule->super) {
3179         struct rule *super;
3180         super = rule_from_cls_rule(classifier_lookup_wild(&p->cls, flow));
3181         if (!super) {
3182             rule_remove(p, rule);
3183             return false;
3184         } else if (super != rule->super) {
3185             COVERAGE_INC(ofproto_revalidate_moved);
3186             list_remove(&rule->list);
3187             list_push_back(&super->list, &rule->list);
3188             rule->super = super;
3189             rule->hard_timeout = super->hard_timeout;
3190             rule->idle_timeout = super->idle_timeout;
3191             rule->created = super->created;
3192             rule->used = 0;
3193         }
3194     }
3195
3196     rule_update_actions(p, rule);
3197     return true;
3198 }
3199
3200 static struct ofpbuf *
3201 compose_flow_exp(const struct rule *rule, long long int now, uint8_t reason)
3202 {
3203     struct ofp_flow_expired *ofe;
3204     struct ofpbuf *buf;
3205
3206     ofe = make_openflow(sizeof *ofe, OFPT_FLOW_EXPIRED, &buf);
3207     flow_to_match(&rule->cr.flow, rule->cr.wc.wildcards, &ofe->match);
3208     ofe->priority = htons(rule->cr.priority);
3209     ofe->reason = reason;
3210     ofe->duration = htonl((now - rule->created) / 1000);
3211     ofe->packet_count = htonll(rule->packet_count);
3212     ofe->byte_count = htonll(rule->byte_count);
3213
3214     return buf;
3215 }
3216
3217 static void
3218 send_flow_exp(struct ofproto *p, struct rule *rule,
3219               long long int now, uint8_t reason)
3220 {
3221     struct ofconn *ofconn;
3222     struct ofconn *prev;
3223     struct ofpbuf *buf = NULL;
3224
3225     /* We limit the maximum number of queued flow expirations it by accounting
3226      * them under the counter for replies.  That works because preventing
3227      * OpenFlow requests from being processed also prevents new flows from
3228      * being added (and expiring).  (It also prevents processing OpenFlow
3229      * requests that would not add new flows, so it is imperfect.) */
3230
3231     prev = NULL;
3232     LIST_FOR_EACH (ofconn, struct ofconn, node, &p->all_conns) {
3233         if (ofconn->send_flow_exp && rconn_is_connected(ofconn->rconn)) {
3234             if (prev) {
3235                 queue_tx(ofpbuf_clone(buf), prev, prev->reply_counter);
3236             } else {
3237                 buf = compose_flow_exp(rule, now, reason);
3238             }
3239             prev = ofconn;
3240         }
3241     }
3242     if (prev) {
3243         queue_tx(buf, prev, prev->reply_counter);
3244     }
3245 }
3246
3247 static void
3248 uninstall_idle_flow(struct ofproto *ofproto, struct rule *rule)
3249 {
3250     assert(rule->installed);
3251     assert(!rule->cr.wc.wildcards);
3252
3253     if (rule->super) {
3254         rule_remove(ofproto, rule);
3255     } else {
3256         rule_uninstall(ofproto, rule);
3257     }
3258 }
3259
3260 static void
3261 expire_rule(struct cls_rule *cls_rule, void *p_)
3262 {
3263     struct ofproto *p = p_;
3264     struct rule *rule = rule_from_cls_rule(cls_rule);
3265     long long int hard_expire, idle_expire, expire, now;
3266
3267     hard_expire = (rule->hard_timeout
3268                    ? rule->created + rule->hard_timeout * 1000
3269                    : LLONG_MAX);
3270     idle_expire = (rule->idle_timeout
3271                    && (rule->super || list_is_empty(&rule->list))
3272                    ? rule->used + rule->idle_timeout * 1000
3273                    : LLONG_MAX);
3274     expire = MIN(hard_expire, idle_expire);
3275
3276     now = time_msec();
3277     if (now < expire) {
3278         if (rule->installed && now >= rule->used + 5000) {
3279             uninstall_idle_flow(p, rule);
3280         } else if (!rule->cr.wc.wildcards) {
3281             active_timeout(p, rule);
3282         }
3283
3284         return;
3285     }
3286
3287     COVERAGE_INC(ofproto_expired);
3288
3289     /* Update stats.  This code will be a no-op if the rule expired
3290      * due to an idle timeout. */
3291     if (rule->cr.wc.wildcards) {
3292         struct rule *subrule, *next;
3293         LIST_FOR_EACH_SAFE (subrule, next, struct rule, list, &rule->list) {
3294             rule_remove(p, subrule);
3295         }
3296     } else {
3297         rule_uninstall(p, rule);
3298     }
3299
3300     if (!rule_is_hidden(rule)) {
3301         send_flow_exp(p, rule, now,
3302                       (now >= hard_expire
3303                        ? OFPER_HARD_TIMEOUT : OFPER_IDLE_TIMEOUT));
3304     }
3305     rule_remove(p, rule);
3306 }
3307
3308 static void
3309 active_timeout(struct ofproto *ofproto, struct rule *rule)
3310 {
3311     if (ofproto->netflow && !is_controller_rule(rule) &&
3312         netflow_active_timeout_expired(ofproto->netflow, &rule->nf_flow)) {
3313         struct ofexpired expired;
3314         struct odp_flow odp_flow;
3315
3316         /* Get updated flow stats. */
3317         memset(&odp_flow, 0, sizeof odp_flow);
3318         if (rule->installed) {
3319             odp_flow.key = rule->cr.flow;
3320             odp_flow.flags = ODPFF_ZERO_TCP_FLAGS;
3321             dpif_flow_get(ofproto->dpif, &odp_flow);
3322
3323             if (odp_flow.stats.n_packets) {
3324                 update_time(ofproto, rule, &odp_flow.stats);
3325                 netflow_flow_update_flags(&rule->nf_flow, odp_flow.stats.ip_tos,
3326                                           odp_flow.stats.tcp_flags);
3327             }
3328         }
3329
3330         expired.flow = rule->cr.flow;
3331         expired.packet_count = rule->packet_count +
3332                                odp_flow.stats.n_packets;
3333         expired.byte_count = rule->byte_count + odp_flow.stats.n_bytes;
3334         expired.used = rule->used;
3335
3336         netflow_expire(ofproto->netflow, &rule->nf_flow, &expired);
3337
3338         /* Schedule us to send the accumulated records once we have
3339          * collected all of them. */
3340         poll_immediate_wake();
3341     }
3342 }
3343
3344 static void
3345 update_used(struct ofproto *p)
3346 {
3347     struct odp_flow *flows;
3348     size_t n_flows;
3349     size_t i;
3350     int error;
3351
3352     error = dpif_flow_list_all(p->dpif, &flows, &n_flows);
3353     if (error) {
3354         return;
3355     }
3356
3357     for (i = 0; i < n_flows; i++) {
3358         struct odp_flow *f = &flows[i];
3359         struct rule *rule;
3360
3361         rule = rule_from_cls_rule(
3362             classifier_find_rule_exactly(&p->cls, &f->key, 0, UINT16_MAX));
3363         if (!rule || !rule->installed) {
3364             COVERAGE_INC(ofproto_unexpected_rule);
3365             dpif_flow_del(p->dpif, f);
3366             continue;
3367         }
3368
3369         update_time(p, rule, &f->stats);
3370         rule_account(p, rule, f->stats.n_bytes);
3371     }
3372     free(flows);
3373 }
3374
3375 static void
3376 do_send_packet_in(struct ofconn *ofconn, uint32_t buffer_id,
3377                   const struct ofpbuf *packet, int send_len)
3378 {
3379     struct odp_msg *msg = packet->data;
3380     struct ofpbuf payload;
3381     struct ofpbuf *opi;
3382     uint8_t reason;
3383
3384     /* Extract packet payload from 'msg'. */
3385     payload.data = msg + 1;
3386     payload.size = msg->length - sizeof *msg;
3387
3388     /* Construct ofp_packet_in message. */
3389     reason = msg->type == _ODPL_ACTION_NR ? OFPR_ACTION : OFPR_NO_MATCH;
3390     opi = make_packet_in(buffer_id, odp_port_to_ofp_port(msg->port), reason,
3391                          &payload, send_len);
3392
3393     /* Send. */
3394     rconn_send_with_limit(ofconn->rconn, opi, ofconn->packet_in_counter, 100);
3395 }
3396
3397 static void
3398 send_packet_in_action(struct ofpbuf *packet, void *p_)
3399 {
3400     struct ofproto *p = p_;
3401     struct ofconn *ofconn;
3402     struct odp_msg *msg;
3403
3404     msg = packet->data;
3405     LIST_FOR_EACH (ofconn, struct ofconn, node, &p->all_conns) {
3406         if (ofconn == p->controller || ofconn->miss_send_len) {
3407             do_send_packet_in(ofconn, UINT32_MAX, packet, msg->arg);
3408         }
3409     }
3410     ofpbuf_delete(packet);
3411 }
3412
3413 static void
3414 send_packet_in_miss(struct ofpbuf *packet, void *p_)
3415 {
3416     struct ofproto *p = p_;
3417     bool in_fail_open = p->fail_open && fail_open_is_active(p->fail_open);
3418     struct ofconn *ofconn;
3419     struct ofpbuf payload;
3420     struct odp_msg *msg;
3421
3422     msg = packet->data;
3423     payload.data = msg + 1;
3424     payload.size = msg->length - sizeof *msg;
3425     LIST_FOR_EACH (ofconn, struct ofconn, node, &p->all_conns) {
3426         if (ofconn->miss_send_len) {
3427             struct pktbuf *pb = ofconn->pktbuf;
3428             uint32_t buffer_id = (in_fail_open
3429                                   ? pktbuf_get_null()
3430                                   : pktbuf_save(pb, &payload, msg->port));
3431             int send_len = (buffer_id != UINT32_MAX ? ofconn->miss_send_len
3432                             : UINT32_MAX);
3433             do_send_packet_in(ofconn, buffer_id, packet, send_len);
3434         }
3435     }
3436     ofpbuf_delete(packet);
3437 }
3438
3439 static uint64_t
3440 pick_datapath_id(const struct ofproto *ofproto)
3441 {
3442     const struct ofport *port;
3443
3444     port = port_array_get(&ofproto->ports, ODPP_LOCAL);
3445     if (port) {
3446         uint8_t ea[ETH_ADDR_LEN];
3447         int error;
3448
3449         error = netdev_get_etheraddr(port->netdev, ea);
3450         if (!error) {
3451             return eth_addr_to_uint64(ea);
3452         }
3453         VLOG_WARN("could not get MAC address for %s (%s)",
3454                   netdev_get_name(port->netdev), strerror(error));
3455     }
3456     return ofproto->fallback_dpid;
3457 }
3458
3459 static uint64_t
3460 pick_fallback_dpid(void)
3461 {
3462     uint8_t ea[ETH_ADDR_LEN];
3463     eth_addr_random(ea);
3464     ea[0] = 0x00;               /* Set Nicira OUI. */
3465     ea[1] = 0x23;
3466     ea[2] = 0x20;
3467     return eth_addr_to_uint64(ea);
3468 }
3469 \f
3470 static bool
3471 default_normal_ofhook_cb(const flow_t *flow, const struct ofpbuf *packet,
3472                          struct odp_actions *actions, tag_type *tags,
3473                          uint16_t *nf_output_iface, void *ofproto_)
3474 {
3475     struct ofproto *ofproto = ofproto_;
3476     int out_port;
3477
3478     /* Drop frames for reserved multicast addresses. */
3479     if (eth_addr_is_reserved(flow->dl_dst)) {
3480         return true;
3481     }
3482
3483     /* Learn source MAC (but don't try to learn from revalidation). */
3484     if (packet != NULL) {
3485         tag_type rev_tag = mac_learning_learn(ofproto->ml, flow->dl_src,
3486                                               0, flow->in_port);
3487         if (rev_tag) {
3488             /* The log messages here could actually be useful in debugging,
3489              * so keep the rate limit relatively high. */
3490             static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(30, 300);
3491             VLOG_DBG_RL(&rl, "learned that "ETH_ADDR_FMT" is on port %"PRIu16,
3492                         ETH_ADDR_ARGS(flow->dl_src), flow->in_port);
3493             ofproto_revalidate(ofproto, rev_tag);
3494         }
3495     }
3496
3497     /* Determine output port. */
3498     out_port = mac_learning_lookup_tag(ofproto->ml, flow->dl_dst, 0, tags);
3499     if (out_port < 0) {
3500         add_output_group_action(actions, DP_GROUP_FLOOD, nf_output_iface);
3501     } else if (out_port != flow->in_port) {
3502         odp_actions_add(actions, ODPAT_OUTPUT)->output.port = out_port;
3503         *nf_output_iface = out_port;
3504     } else {
3505         /* Drop. */
3506     }
3507
3508     return true;
3509 }
3510
3511 static const struct ofhooks default_ofhooks = {
3512     NULL,
3513     default_normal_ofhook_cb,
3514     NULL,
3515     NULL
3516 };