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