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 = rule_make_actions(ofproto, rule, NULL);
1653     if (rule->may_install) {
1654         if (rule->installed) {
1655             if (actions_changed) {
1656                 /* XXX should really do rule_post_uninstall() for the *old* set
1657                  * of actions, and distinguish the old stats from the new. */
1658                 struct odp_flow_put put;
1659                 do_put_flow(ofproto, rule, ODPPF_CREATE | ODPPF_MODIFY, &put);
1660             }
1661         } else {
1662             rule_install(ofproto, rule, NULL);
1663         }
1664     } else {
1665         rule_uninstall(ofproto, rule);
1666     }
1667 }
1668
1669 static void
1670 rule_account(struct ofproto *ofproto, struct rule *rule, uint64_t extra_bytes)
1671 {
1672     uint64_t total_bytes = rule->byte_count + extra_bytes;
1673
1674     if (ofproto->ofhooks->account_flow_cb
1675         && total_bytes > rule->accounted_bytes)
1676     {
1677         ofproto->ofhooks->account_flow_cb(
1678             &rule->cr.flow, rule->odp_actions, rule->n_odp_actions,
1679             total_bytes - rule->accounted_bytes, ofproto->aux);
1680         rule->accounted_bytes = total_bytes;
1681     }
1682 }
1683
1684 static void
1685 rule_uninstall(struct ofproto *p, struct rule *rule)
1686 {
1687     assert(!rule->cr.wc.wildcards);
1688     if (rule->installed) {
1689         struct odp_flow odp_flow;
1690
1691         odp_flow.key = rule->cr.flow;
1692         odp_flow.actions = NULL;
1693         odp_flow.n_actions = 0;
1694         if (!dpif_flow_del(&p->dpif, &odp_flow)) {
1695             update_stats(p, rule, &odp_flow.stats);
1696         }
1697         rule->installed = false;
1698
1699         rule_post_uninstall(p, rule);
1700     }
1701 }
1702
1703 static bool
1704 is_controller_rule(struct rule *rule)
1705 {
1706     /* If the only action is send to the controller then don't report
1707      * NetFlow expiration messages since it is just part of the control
1708      * logic for the network and not real traffic. */
1709
1710     if (rule && rule->super) {
1711         struct rule *super = rule->super;
1712
1713         return super->n_actions == 1 &&
1714                super->actions[0].type == htons(OFPAT_OUTPUT) &&
1715                super->actions[0].output.port == htons(OFPP_CONTROLLER);
1716     }
1717
1718     return false;
1719 }
1720
1721 static void
1722 rule_post_uninstall(struct ofproto *ofproto, struct rule *rule)
1723 {
1724     struct rule *super = rule->super;
1725
1726     rule_account(ofproto, rule, 0);
1727
1728     if (ofproto->netflow && !is_controller_rule(rule)) {
1729         struct ofexpired expired;
1730         expired.flow = rule->cr.flow;
1731         expired.packet_count = rule->packet_count;
1732         expired.byte_count = rule->byte_count;
1733         expired.used = rule->used;
1734         netflow_expire(ofproto->netflow, &rule->nf_flow, &expired);
1735     }
1736     if (super) {
1737         super->packet_count += rule->packet_count;
1738         super->byte_count += rule->byte_count;
1739
1740         /* Reset counters to prevent double counting if the rule ever gets
1741          * reinstalled. */
1742         rule->packet_count = 0;
1743         rule->byte_count = 0;
1744         rule->accounted_bytes = 0;
1745
1746         netflow_flow_clear(&rule->nf_flow);
1747     }
1748 }
1749 \f
1750 static void
1751 queue_tx(struct ofpbuf *msg, const struct ofconn *ofconn,
1752          struct rconn_packet_counter *counter)
1753 {
1754     update_openflow_length(msg);
1755     if (rconn_send(ofconn->rconn, msg, counter)) {
1756         ofpbuf_delete(msg);
1757     }
1758 }
1759
1760 static void
1761 send_error(const struct ofconn *ofconn, const struct ofp_header *oh,
1762            int error, const void *data, size_t len)
1763 {
1764     struct ofpbuf *buf;
1765     struct ofp_error_msg *oem;
1766
1767     if (!(error >> 16)) {
1768         VLOG_WARN_RL(&rl, "not sending bad error code %d to controller",
1769                      error);
1770         return;
1771     }
1772
1773     COVERAGE_INC(ofproto_error);
1774     oem = make_openflow_xid(len + sizeof *oem, OFPT_ERROR,
1775                             oh ? oh->xid : 0, &buf);
1776     oem->type = htons((unsigned int) error >> 16);
1777     oem->code = htons(error & 0xffff);
1778     memcpy(oem->data, data, len);
1779     queue_tx(buf, ofconn, ofconn->reply_counter);
1780 }
1781
1782 static void
1783 send_error_oh(const struct ofconn *ofconn, const struct ofp_header *oh,
1784               int error)
1785 {
1786     size_t oh_length = ntohs(oh->length);
1787     send_error(ofconn, oh, error, oh, MIN(oh_length, 64));
1788 }
1789
1790 static void
1791 hton_ofp_phy_port(struct ofp_phy_port *opp)
1792 {
1793     opp->port_no = htons(opp->port_no);
1794     opp->config = htonl(opp->config);
1795     opp->state = htonl(opp->state);
1796     opp->curr = htonl(opp->curr);
1797     opp->advertised = htonl(opp->advertised);
1798     opp->supported = htonl(opp->supported);
1799     opp->peer = htonl(opp->peer);
1800 }
1801
1802 static int
1803 handle_echo_request(struct ofconn *ofconn, struct ofp_header *oh)
1804 {
1805     struct ofp_header *rq = oh;
1806     queue_tx(make_echo_reply(rq), ofconn, ofconn->reply_counter);
1807     return 0;
1808 }
1809
1810 static int
1811 handle_features_request(struct ofproto *p, struct ofconn *ofconn,
1812                         struct ofp_header *oh)
1813 {
1814     struct ofp_switch_features *osf;
1815     struct ofpbuf *buf;
1816     unsigned int port_no;
1817     struct ofport *port;
1818
1819     osf = make_openflow_xid(sizeof *osf, OFPT_FEATURES_REPLY, oh->xid, &buf);
1820     osf->datapath_id = htonll(p->datapath_id);
1821     osf->n_buffers = htonl(pktbuf_capacity());
1822     osf->n_tables = 2;
1823     osf->capabilities = htonl(OFPC_FLOW_STATS | OFPC_TABLE_STATS |
1824                               OFPC_PORT_STATS | OFPC_MULTI_PHY_TX);
1825     osf->actions = htonl((1u << OFPAT_OUTPUT) |
1826                          (1u << OFPAT_SET_VLAN_VID) |
1827                          (1u << OFPAT_SET_VLAN_PCP) |
1828                          (1u << OFPAT_STRIP_VLAN) |
1829                          (1u << OFPAT_SET_DL_SRC) |
1830                          (1u << OFPAT_SET_DL_DST) |
1831                          (1u << OFPAT_SET_NW_SRC) |
1832                          (1u << OFPAT_SET_NW_DST) |
1833                          (1u << OFPAT_SET_TP_SRC) |
1834                          (1u << OFPAT_SET_TP_DST));
1835
1836     PORT_ARRAY_FOR_EACH (port, &p->ports, port_no) {
1837         hton_ofp_phy_port(ofpbuf_put(buf, &port->opp, sizeof port->opp));
1838     }
1839
1840     queue_tx(buf, ofconn, ofconn->reply_counter);
1841     return 0;
1842 }
1843
1844 static int
1845 handle_get_config_request(struct ofproto *p, struct ofconn *ofconn,
1846                           struct ofp_header *oh)
1847 {
1848     struct ofpbuf *buf;
1849     struct ofp_switch_config *osc;
1850     uint16_t flags;
1851     bool drop_frags;
1852
1853     /* Figure out flags. */
1854     dpif_get_drop_frags(&p->dpif, &drop_frags);
1855     flags = drop_frags ? OFPC_FRAG_DROP : OFPC_FRAG_NORMAL;
1856     if (ofconn->send_flow_exp) {
1857         flags |= OFPC_SEND_FLOW_EXP;
1858     }
1859
1860     /* Send reply. */
1861     osc = make_openflow_xid(sizeof *osc, OFPT_GET_CONFIG_REPLY, oh->xid, &buf);
1862     osc->flags = htons(flags);
1863     osc->miss_send_len = htons(ofconn->miss_send_len);
1864     queue_tx(buf, ofconn, ofconn->reply_counter);
1865
1866     return 0;
1867 }
1868
1869 static int
1870 handle_set_config(struct ofproto *p, struct ofconn *ofconn,
1871                   struct ofp_switch_config *osc)
1872 {
1873     uint16_t flags;
1874     int error;
1875
1876     error = check_ofp_message(&osc->header, OFPT_SET_CONFIG, sizeof *osc);
1877     if (error) {
1878         return error;
1879     }
1880     flags = ntohs(osc->flags);
1881
1882     ofconn->send_flow_exp = (flags & OFPC_SEND_FLOW_EXP) != 0;
1883
1884     if (ofconn == p->controller) {
1885         switch (flags & OFPC_FRAG_MASK) {
1886         case OFPC_FRAG_NORMAL:
1887             dpif_set_drop_frags(&p->dpif, false);
1888             break;
1889         case OFPC_FRAG_DROP:
1890             dpif_set_drop_frags(&p->dpif, true);
1891             break;
1892         default:
1893             VLOG_WARN_RL(&rl, "requested bad fragment mode (flags=%"PRIx16")",
1894                          osc->flags);
1895             break;
1896         }
1897     }
1898
1899     if ((ntohs(osc->miss_send_len) != 0) != (ofconn->miss_send_len != 0)) {
1900         if (ntohs(osc->miss_send_len) != 0) {
1901             ofconn->pktbuf = pktbuf_create();
1902         } else {
1903             pktbuf_destroy(ofconn->pktbuf);
1904         }
1905     }
1906
1907     ofconn->miss_send_len = ntohs(osc->miss_send_len);
1908
1909     return 0;
1910 }
1911
1912 static void
1913 add_output_group_action(struct odp_actions *actions, uint16_t group,
1914                         uint16_t *nf_output_iface)
1915 {
1916     odp_actions_add(actions, ODPAT_OUTPUT_GROUP)->output_group.group = group;
1917
1918     if (group == DP_GROUP_ALL || group == DP_GROUP_FLOOD) {
1919         *nf_output_iface = NF_OUT_FLOOD;
1920     }
1921 }
1922
1923 static void
1924 add_controller_action(struct odp_actions *actions,
1925                       const struct ofp_action_output *oao)
1926 {
1927     union odp_action *a = odp_actions_add(actions, ODPAT_CONTROLLER);
1928     a->controller.arg = oao->max_len ? ntohs(oao->max_len) : UINT32_MAX;
1929 }
1930
1931 struct action_xlate_ctx {
1932     /* Input. */
1933     const flow_t *flow;         /* Flow to which these actions correspond. */
1934     int recurse;                /* Recursion level, via xlate_table_action. */
1935     struct ofproto *ofproto;
1936     const struct ofpbuf *packet; /* The packet corresponding to 'flow', or a
1937                                   * null pointer if we are revalidating
1938                                   * without a packet to refer to. */
1939
1940     /* Output. */
1941     struct odp_actions *out;    /* Datapath actions. */
1942     tag_type *tags;             /* Tags associated with OFPP_NORMAL actions. */
1943     bool may_set_up_flow;       /* True ordinarily; false if the actions must
1944                                  * be reassessed for every packet. */
1945     uint16_t nf_output_iface;   /* Output interface index for NetFlow. */
1946 };
1947
1948 static void do_xlate_actions(const union ofp_action *in, size_t n_in,
1949                              struct action_xlate_ctx *ctx);
1950
1951 static void
1952 add_output_action(struct action_xlate_ctx *ctx, uint16_t port)
1953 {
1954     const struct ofport *ofport = port_array_get(&ctx->ofproto->ports, port);
1955
1956     if (ofport) {
1957         if (ofport->opp.config & OFPPC_NO_FWD) {
1958             /* Forwarding disabled on port. */
1959             return;
1960         }
1961     } else {
1962         /*
1963          * We don't have an ofport record for this port, but it doesn't hurt to
1964          * allow forwarding to it anyhow.  Maybe such a port will appear later
1965          * and we're pre-populating the flow table.
1966          */
1967     }
1968
1969     odp_actions_add(ctx->out, ODPAT_OUTPUT)->output.port = port;
1970     ctx->nf_output_iface = port;
1971 }
1972
1973 static struct rule *
1974 lookup_valid_rule(struct ofproto *ofproto, const flow_t *flow)
1975 {
1976     struct rule *rule;
1977     rule = rule_from_cls_rule(classifier_lookup(&ofproto->cls, flow));
1978
1979     /* The rule we found might not be valid, since we could be in need of
1980      * revalidation.  If it is not valid, don't return it. */
1981     if (rule
1982         && rule->super
1983         && ofproto->need_revalidate
1984         && !revalidate_rule(ofproto, rule)) {
1985         COVERAGE_INC(ofproto_invalidated);
1986         return NULL;
1987     }
1988
1989     return rule;
1990 }
1991
1992 static void
1993 xlate_table_action(struct action_xlate_ctx *ctx, uint16_t in_port)
1994 {
1995     if (!ctx->recurse) {
1996         struct rule *rule;
1997         flow_t flow;
1998
1999         flow = *ctx->flow;
2000         flow.in_port = in_port;
2001
2002         rule = lookup_valid_rule(ctx->ofproto, &flow);
2003         if (rule) {
2004             if (rule->super) {
2005                 rule = rule->super;
2006             }
2007
2008             ctx->recurse++;
2009             do_xlate_actions(rule->actions, rule->n_actions, ctx);
2010             ctx->recurse--;
2011         }
2012     }
2013 }
2014
2015 static void
2016 xlate_output_action(struct action_xlate_ctx *ctx,
2017                     const struct ofp_action_output *oao)
2018 {
2019     uint16_t odp_port;
2020     uint16_t prev_nf_output_iface = ctx->nf_output_iface;
2021
2022     ctx->nf_output_iface = NF_OUT_DROP;
2023
2024     switch (ntohs(oao->port)) {
2025     case OFPP_IN_PORT:
2026         add_output_action(ctx, ctx->flow->in_port);
2027         break;
2028     case OFPP_TABLE:
2029         xlate_table_action(ctx, ctx->flow->in_port);
2030         break;
2031     case OFPP_NORMAL:
2032         if (!ctx->ofproto->ofhooks->normal_cb(ctx->flow, ctx->packet,
2033                                               ctx->out, ctx->tags,
2034                                               &ctx->nf_output_iface,
2035                                               ctx->ofproto->aux)) {
2036             COVERAGE_INC(ofproto_uninstallable);
2037             ctx->may_set_up_flow = false;
2038         }
2039         break;
2040     case OFPP_FLOOD:
2041         add_output_group_action(ctx->out, DP_GROUP_FLOOD,
2042                                 &ctx->nf_output_iface);
2043         break;
2044     case OFPP_ALL:
2045         add_output_group_action(ctx->out, DP_GROUP_ALL, &ctx->nf_output_iface);
2046         break;
2047     case OFPP_CONTROLLER:
2048         add_controller_action(ctx->out, oao);
2049         break;
2050     case OFPP_LOCAL:
2051         add_output_action(ctx, ODPP_LOCAL);
2052         break;
2053     default:
2054         odp_port = ofp_port_to_odp_port(ntohs(oao->port));
2055         if (odp_port != ctx->flow->in_port) {
2056             add_output_action(ctx, odp_port);
2057         }
2058         break;
2059     }
2060
2061     if (prev_nf_output_iface == NF_OUT_FLOOD) {
2062         ctx->nf_output_iface = NF_OUT_FLOOD;
2063     } else if (ctx->nf_output_iface == NF_OUT_DROP) {
2064         ctx->nf_output_iface = prev_nf_output_iface;
2065     } else if (prev_nf_output_iface != NF_OUT_DROP &&
2066                ctx->nf_output_iface != NF_OUT_FLOOD) {
2067         ctx->nf_output_iface = NF_OUT_MULTI;
2068     }
2069 }
2070
2071 static void
2072 xlate_nicira_action(struct action_xlate_ctx *ctx,
2073                     const struct nx_action_header *nah)
2074 {
2075     const struct nx_action_resubmit *nar;
2076     int subtype = ntohs(nah->subtype);
2077
2078     assert(nah->vendor == htonl(NX_VENDOR_ID));
2079     switch (subtype) {
2080     case NXAST_RESUBMIT:
2081         nar = (const struct nx_action_resubmit *) nah;
2082         xlate_table_action(ctx, ofp_port_to_odp_port(ntohs(nar->in_port)));
2083         break;
2084
2085     default:
2086         VLOG_DBG_RL(&rl, "unknown Nicira action type %"PRIu16, subtype);
2087         break;
2088     }
2089 }
2090
2091 static void
2092 do_xlate_actions(const union ofp_action *in, size_t n_in,
2093                  struct action_xlate_ctx *ctx)
2094 {
2095     struct actions_iterator iter;
2096     const union ofp_action *ia;
2097     const struct ofport *port;
2098
2099     port = port_array_get(&ctx->ofproto->ports, ctx->flow->in_port);
2100     if (port && port->opp.config & (OFPPC_NO_RECV | OFPPC_NO_RECV_STP) &&
2101         port->opp.config & (eth_addr_equals(ctx->flow->dl_dst, stp_eth_addr)
2102                             ? OFPPC_NO_RECV_STP : OFPPC_NO_RECV)) {
2103         /* Drop this flow. */
2104         return;
2105     }
2106
2107     for (ia = actions_first(&iter, in, n_in); ia; ia = actions_next(&iter)) {
2108         uint16_t type = ntohs(ia->type);
2109         union odp_action *oa;
2110
2111         switch (type) {
2112         case OFPAT_OUTPUT:
2113             xlate_output_action(ctx, &ia->output);
2114             break;
2115
2116         case OFPAT_SET_VLAN_VID:
2117             oa = odp_actions_add(ctx->out, ODPAT_SET_VLAN_VID);
2118             oa->vlan_vid.vlan_vid = ia->vlan_vid.vlan_vid;
2119             break;
2120
2121         case OFPAT_SET_VLAN_PCP:
2122             oa = odp_actions_add(ctx->out, ODPAT_SET_VLAN_PCP);
2123             oa->vlan_pcp.vlan_pcp = ia->vlan_pcp.vlan_pcp;
2124             break;
2125
2126         case OFPAT_STRIP_VLAN:
2127             odp_actions_add(ctx->out, ODPAT_STRIP_VLAN);
2128             break;
2129
2130         case OFPAT_SET_DL_SRC:
2131             oa = odp_actions_add(ctx->out, ODPAT_SET_DL_SRC);
2132             memcpy(oa->dl_addr.dl_addr,
2133                    ((struct ofp_action_dl_addr *) ia)->dl_addr, ETH_ADDR_LEN);
2134             break;
2135
2136         case OFPAT_SET_DL_DST:
2137             oa = odp_actions_add(ctx->out, ODPAT_SET_DL_DST);
2138             memcpy(oa->dl_addr.dl_addr,
2139                    ((struct ofp_action_dl_addr *) ia)->dl_addr, ETH_ADDR_LEN);
2140             break;
2141
2142         case OFPAT_SET_NW_SRC:
2143             oa = odp_actions_add(ctx->out, ODPAT_SET_NW_SRC);
2144             oa->nw_addr.nw_addr = ia->nw_addr.nw_addr;
2145             break;
2146
2147         case OFPAT_SET_TP_SRC:
2148             oa = odp_actions_add(ctx->out, ODPAT_SET_TP_SRC);
2149             oa->tp_port.tp_port = ia->tp_port.tp_port;
2150             break;
2151
2152         case OFPAT_VENDOR:
2153             xlate_nicira_action(ctx, (const struct nx_action_header *) ia);
2154             break;
2155
2156         default:
2157             VLOG_DBG_RL(&rl, "unknown action type %"PRIu16, type);
2158             break;
2159         }
2160     }
2161 }
2162
2163 static int
2164 xlate_actions(const union ofp_action *in, size_t n_in,
2165               const flow_t *flow, struct ofproto *ofproto,
2166               const struct ofpbuf *packet,
2167               struct odp_actions *out, tag_type *tags, bool *may_set_up_flow,
2168               uint16_t *nf_output_iface)
2169 {
2170     tag_type no_tags = 0;
2171     struct action_xlate_ctx ctx;
2172     COVERAGE_INC(ofproto_ofp2odp);
2173     odp_actions_init(out);
2174     ctx.flow = flow;
2175     ctx.recurse = 0;
2176     ctx.ofproto = ofproto;
2177     ctx.packet = packet;
2178     ctx.out = out;
2179     ctx.tags = tags ? tags : &no_tags;
2180     ctx.may_set_up_flow = true;
2181     ctx.nf_output_iface = NF_OUT_DROP;
2182     do_xlate_actions(in, n_in, &ctx);
2183
2184     /* Check with in-band control to see if we're allowed to set up this
2185      * flow. */
2186     if (!in_band_rule_check(ofproto->in_band, flow, out)) {
2187         ctx.may_set_up_flow = false;
2188     }
2189
2190     if (may_set_up_flow) {
2191         *may_set_up_flow = ctx.may_set_up_flow;
2192     }
2193     if (nf_output_iface) {
2194         *nf_output_iface = ctx.nf_output_iface;
2195     }
2196     if (odp_actions_overflow(out)) {
2197         odp_actions_init(out);
2198         return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_TOO_MANY);
2199     }
2200     return 0;
2201 }
2202
2203 static int
2204 handle_packet_out(struct ofproto *p, struct ofconn *ofconn,
2205                   struct ofp_header *oh)
2206 {
2207     struct ofp_packet_out *opo;
2208     struct ofpbuf payload, *buffer;
2209     struct odp_actions actions;
2210     int n_actions;
2211     uint16_t in_port;
2212     flow_t flow;
2213     int error;
2214
2215     error = check_ofp_packet_out(oh, &payload, &n_actions, p->max_ports);
2216     if (error) {
2217         return error;
2218     }
2219     opo = (struct ofp_packet_out *) oh;
2220
2221     COVERAGE_INC(ofproto_packet_out);
2222     if (opo->buffer_id != htonl(UINT32_MAX)) {
2223         error = pktbuf_retrieve(ofconn->pktbuf, ntohl(opo->buffer_id),
2224                                 &buffer, &in_port);
2225         if (error || !buffer) {
2226             return error;
2227         }
2228         payload = *buffer;
2229     } else {
2230         buffer = NULL;
2231     }
2232
2233     flow_extract(&payload, ofp_port_to_odp_port(ntohs(opo->in_port)), &flow);
2234     error = xlate_actions((const union ofp_action *) opo->actions, n_actions,
2235                           &flow, p, &payload, &actions, NULL, NULL, NULL);
2236     if (error) {
2237         return error;
2238     }
2239
2240     dpif_execute(&p->dpif, flow.in_port, actions.actions, actions.n_actions,
2241                  &payload);
2242     ofpbuf_delete(buffer);
2243
2244     return 0;
2245 }
2246
2247 static void
2248 update_port_config(struct ofproto *p, struct ofport *port,
2249                    uint32_t config, uint32_t mask)
2250 {
2251     mask &= config ^ port->opp.config;
2252     if (mask & OFPPC_PORT_DOWN) {
2253         if (config & OFPPC_PORT_DOWN) {
2254             netdev_turn_flags_off(port->netdev, NETDEV_UP, true);
2255         } else {
2256             netdev_turn_flags_on(port->netdev, NETDEV_UP, true);
2257         }
2258     }
2259 #define REVALIDATE_BITS (OFPPC_NO_RECV | OFPPC_NO_RECV_STP | OFPPC_NO_FWD)
2260     if (mask & REVALIDATE_BITS) {
2261         COVERAGE_INC(ofproto_costly_flags);
2262         port->opp.config ^= mask & REVALIDATE_BITS;
2263         p->need_revalidate = true;
2264     }
2265 #undef REVALIDATE_BITS
2266     if (mask & OFPPC_NO_FLOOD) {
2267         port->opp.config ^= OFPPC_NO_FLOOD;
2268         refresh_port_group(p, DP_GROUP_FLOOD);
2269     }
2270     if (mask & OFPPC_NO_PACKET_IN) {
2271         port->opp.config ^= OFPPC_NO_PACKET_IN;
2272     }
2273 }
2274
2275 static int
2276 handle_port_mod(struct ofproto *p, struct ofp_header *oh)
2277 {
2278     const struct ofp_port_mod *opm;
2279     struct ofport *port;
2280     int error;
2281
2282     error = check_ofp_message(oh, OFPT_PORT_MOD, sizeof *opm);
2283     if (error) {
2284         return error;
2285     }
2286     opm = (struct ofp_port_mod *) oh;
2287
2288     port = port_array_get(&p->ports,
2289                           ofp_port_to_odp_port(ntohs(opm->port_no)));
2290     if (!port) {
2291         return ofp_mkerr(OFPET_PORT_MOD_FAILED, OFPPMFC_BAD_PORT);
2292     } else if (memcmp(port->opp.hw_addr, opm->hw_addr, OFP_ETH_ALEN)) {
2293         return ofp_mkerr(OFPET_PORT_MOD_FAILED, OFPPMFC_BAD_HW_ADDR);
2294     } else {
2295         update_port_config(p, port, ntohl(opm->config), ntohl(opm->mask));
2296         if (opm->advertise) {
2297             netdev_set_advertisements(port->netdev, ntohl(opm->advertise));
2298         }
2299     }
2300     return 0;
2301 }
2302
2303 static struct ofpbuf *
2304 make_stats_reply(uint32_t xid, uint16_t type, size_t body_len)
2305 {
2306     struct ofp_stats_reply *osr;
2307     struct ofpbuf *msg;
2308
2309     msg = ofpbuf_new(MIN(sizeof *osr + body_len, UINT16_MAX));
2310     osr = put_openflow_xid(sizeof *osr, OFPT_STATS_REPLY, xid, msg);
2311     osr->type = type;
2312     osr->flags = htons(0);
2313     return msg;
2314 }
2315
2316 static struct ofpbuf *
2317 start_stats_reply(const struct ofp_stats_request *request, size_t body_len)
2318 {
2319     return make_stats_reply(request->header.xid, request->type, body_len);
2320 }
2321
2322 static void *
2323 append_stats_reply(size_t nbytes, struct ofconn *ofconn, struct ofpbuf **msgp)
2324 {
2325     struct ofpbuf *msg = *msgp;
2326     assert(nbytes <= UINT16_MAX - sizeof(struct ofp_stats_reply));
2327     if (nbytes + msg->size > UINT16_MAX) {
2328         struct ofp_stats_reply *reply = msg->data;
2329         reply->flags = htons(OFPSF_REPLY_MORE);
2330         *msgp = make_stats_reply(reply->header.xid, reply->type, nbytes);
2331         queue_tx(msg, ofconn, ofconn->reply_counter);
2332     }
2333     return ofpbuf_put_uninit(*msgp, nbytes);
2334 }
2335
2336 static int
2337 handle_desc_stats_request(struct ofproto *p, struct ofconn *ofconn,
2338                            struct ofp_stats_request *request)
2339 {
2340     struct ofp_desc_stats *ods;
2341     struct ofpbuf *msg;
2342
2343     msg = start_stats_reply(request, sizeof *ods);
2344     ods = append_stats_reply(sizeof *ods, ofconn, &msg);
2345     strncpy(ods->mfr_desc, p->manufacturer, sizeof ods->mfr_desc);
2346     strncpy(ods->hw_desc, p->hardware, sizeof ods->hw_desc);
2347     strncpy(ods->sw_desc, p->software, sizeof ods->sw_desc);
2348     strncpy(ods->serial_num, p->serial, sizeof ods->serial_num);
2349     queue_tx(msg, ofconn, ofconn->reply_counter);
2350
2351     return 0;
2352 }
2353
2354 static void
2355 count_subrules(struct cls_rule *cls_rule, void *n_subrules_)
2356 {
2357     struct rule *rule = rule_from_cls_rule(cls_rule);
2358     int *n_subrules = n_subrules_;
2359
2360     if (rule->super) {
2361         (*n_subrules)++;
2362     }
2363 }
2364
2365 static int
2366 handle_table_stats_request(struct ofproto *p, struct ofconn *ofconn,
2367                            struct ofp_stats_request *request)
2368 {
2369     struct ofp_table_stats *ots;
2370     struct ofpbuf *msg;
2371     struct odp_stats dpstats;
2372     int n_exact, n_subrules, n_wild;
2373
2374     msg = start_stats_reply(request, sizeof *ots * 2);
2375
2376     /* Count rules of various kinds. */
2377     n_subrules = 0;
2378     classifier_for_each(&p->cls, CLS_INC_EXACT, count_subrules, &n_subrules);
2379     n_exact = classifier_count_exact(&p->cls) - n_subrules;
2380     n_wild = classifier_count(&p->cls) - classifier_count_exact(&p->cls);
2381
2382     /* Hash table. */
2383     dpif_get_dp_stats(&p->dpif, &dpstats);
2384     ots = append_stats_reply(sizeof *ots, ofconn, &msg);
2385     memset(ots, 0, sizeof *ots);
2386     ots->table_id = TABLEID_HASH;
2387     strcpy(ots->name, "hash");
2388     ots->wildcards = htonl(0);
2389     ots->max_entries = htonl(dpstats.max_capacity);
2390     ots->active_count = htonl(n_exact);
2391     ots->lookup_count = htonll(dpstats.n_frags + dpstats.n_hit +
2392                                dpstats.n_missed);
2393     ots->matched_count = htonll(dpstats.n_hit); /* XXX */
2394
2395     /* Classifier table. */
2396     ots = append_stats_reply(sizeof *ots, ofconn, &msg);
2397     memset(ots, 0, sizeof *ots);
2398     ots->table_id = TABLEID_CLASSIFIER;
2399     strcpy(ots->name, "classifier");
2400     ots->wildcards = htonl(OFPFW_ALL);
2401     ots->max_entries = htonl(65536);
2402     ots->active_count = htonl(n_wild);
2403     ots->lookup_count = htonll(0);              /* XXX */
2404     ots->matched_count = htonll(0);             /* XXX */
2405
2406     queue_tx(msg, ofconn, ofconn->reply_counter);
2407     return 0;
2408 }
2409
2410 static int
2411 handle_port_stats_request(struct ofproto *p, struct ofconn *ofconn,
2412                           struct ofp_stats_request *request)
2413 {
2414     struct ofp_port_stats *ops;
2415     struct ofpbuf *msg;
2416     struct ofport *port;
2417     unsigned int port_no;
2418
2419     msg = start_stats_reply(request, sizeof *ops * 16);
2420     PORT_ARRAY_FOR_EACH (port, &p->ports, port_no) {
2421         struct netdev_stats stats;
2422
2423         /* Intentionally ignore return value, since errors will set 'stats' to
2424          * all-1s, which is correct for OpenFlow, and netdev_get_stats() will
2425          * log errors. */
2426         netdev_get_stats(port->netdev, &stats);
2427
2428         ops = append_stats_reply(sizeof *ops, ofconn, &msg);
2429         ops->port_no = htons(odp_port_to_ofp_port(port_no));
2430         memset(ops->pad, 0, sizeof ops->pad);
2431         ops->rx_packets = htonll(stats.rx_packets);
2432         ops->tx_packets = htonll(stats.tx_packets);
2433         ops->rx_bytes = htonll(stats.rx_bytes);
2434         ops->tx_bytes = htonll(stats.tx_bytes);
2435         ops->rx_dropped = htonll(stats.rx_dropped);
2436         ops->tx_dropped = htonll(stats.tx_dropped);
2437         ops->rx_errors = htonll(stats.rx_errors);
2438         ops->tx_errors = htonll(stats.tx_errors);
2439         ops->rx_frame_err = htonll(stats.rx_frame_errors);
2440         ops->rx_over_err = htonll(stats.rx_over_errors);
2441         ops->rx_crc_err = htonll(stats.rx_crc_errors);
2442         ops->collisions = htonll(stats.collisions);
2443     }
2444
2445     queue_tx(msg, ofconn, ofconn->reply_counter);
2446     return 0;
2447 }
2448
2449 struct flow_stats_cbdata {
2450     struct ofproto *ofproto;
2451     struct ofconn *ofconn;
2452     uint16_t out_port;
2453     struct ofpbuf *msg;
2454 };
2455
2456 static void
2457 query_stats(struct ofproto *p, struct rule *rule,
2458             uint64_t *packet_countp, uint64_t *byte_countp)
2459 {
2460     uint64_t packet_count, byte_count;
2461     struct rule *subrule;
2462     struct odp_flow *odp_flows;
2463     size_t n_odp_flows;
2464
2465     packet_count = rule->packet_count;
2466     byte_count = rule->byte_count;
2467
2468     n_odp_flows = rule->cr.wc.wildcards ? list_size(&rule->list) : 1;
2469     odp_flows = xcalloc(1, n_odp_flows * sizeof *odp_flows);
2470     if (rule->cr.wc.wildcards) {
2471         size_t i = 0;
2472         LIST_FOR_EACH (subrule, struct rule, list, &rule->list) {
2473             odp_flows[i++].key = subrule->cr.flow;
2474             packet_count += subrule->packet_count;
2475             byte_count += subrule->byte_count;
2476         }
2477     } else {
2478         odp_flows[0].key = rule->cr.flow;
2479     }
2480
2481     if (!dpif_flow_get_multiple(&p->dpif, odp_flows, n_odp_flows)) {
2482         size_t i;
2483         for (i = 0; i < n_odp_flows; i++) {
2484             struct odp_flow *odp_flow = &odp_flows[i];
2485             packet_count += odp_flow->stats.n_packets;
2486             byte_count += odp_flow->stats.n_bytes;
2487         }
2488     }
2489     free(odp_flows);
2490
2491     *packet_countp = packet_count;
2492     *byte_countp = byte_count;
2493 }
2494
2495 static void
2496 flow_stats_cb(struct cls_rule *rule_, void *cbdata_)
2497 {
2498     struct rule *rule = rule_from_cls_rule(rule_);
2499     struct flow_stats_cbdata *cbdata = cbdata_;
2500     struct ofp_flow_stats *ofs;
2501     uint64_t packet_count, byte_count;
2502     size_t act_len, len;
2503
2504     if (rule_is_hidden(rule) || !rule_has_out_port(rule, cbdata->out_port)) {
2505         return;
2506     }
2507
2508     act_len = sizeof *rule->actions * rule->n_actions;
2509     len = offsetof(struct ofp_flow_stats, actions) + act_len;
2510
2511     query_stats(cbdata->ofproto, rule, &packet_count, &byte_count);
2512
2513     ofs = append_stats_reply(len, cbdata->ofconn, &cbdata->msg);
2514     ofs->length = htons(len);
2515     ofs->table_id = rule->cr.wc.wildcards ? TABLEID_CLASSIFIER : TABLEID_HASH;
2516     ofs->pad = 0;
2517     flow_to_match(&rule->cr.flow, rule->cr.wc.wildcards, &ofs->match);
2518     ofs->duration = htonl((time_msec() - rule->created) / 1000);
2519     ofs->priority = htons(rule->cr.priority);
2520     ofs->idle_timeout = htons(rule->idle_timeout);
2521     ofs->hard_timeout = htons(rule->hard_timeout);
2522     memset(ofs->pad2, 0, sizeof ofs->pad2);
2523     ofs->packet_count = htonll(packet_count);
2524     ofs->byte_count = htonll(byte_count);
2525     memcpy(ofs->actions, rule->actions, act_len);
2526 }
2527
2528 static int
2529 table_id_to_include(uint8_t table_id)
2530 {
2531     return (table_id == TABLEID_HASH ? CLS_INC_EXACT
2532             : table_id == TABLEID_CLASSIFIER ? CLS_INC_WILD
2533             : table_id == 0xff ? CLS_INC_ALL
2534             : 0);
2535 }
2536
2537 static int
2538 handle_flow_stats_request(struct ofproto *p, struct ofconn *ofconn,
2539                           const struct ofp_stats_request *osr,
2540                           size_t arg_size)
2541 {
2542     struct ofp_flow_stats_request *fsr;
2543     struct flow_stats_cbdata cbdata;
2544     struct cls_rule target;
2545
2546     if (arg_size != sizeof *fsr) {
2547         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LENGTH);
2548     }
2549     fsr = (struct ofp_flow_stats_request *) osr->body;
2550
2551     COVERAGE_INC(ofproto_flows_req);
2552     cbdata.ofproto = p;
2553     cbdata.ofconn = ofconn;
2554     cbdata.out_port = fsr->out_port;
2555     cbdata.msg = start_stats_reply(osr, 1024);
2556     cls_rule_from_match(&target, &fsr->match, 0);
2557     classifier_for_each_match(&p->cls, &target,
2558                               table_id_to_include(fsr->table_id),
2559                               flow_stats_cb, &cbdata);
2560     queue_tx(cbdata.msg, ofconn, ofconn->reply_counter);
2561     return 0;
2562 }
2563
2564 struct flow_stats_ds_cbdata {
2565     struct ofproto *ofproto;
2566     struct ds *results;
2567 };
2568
2569 static void
2570 flow_stats_ds_cb(struct cls_rule *rule_, void *cbdata_)
2571 {
2572     struct rule *rule = rule_from_cls_rule(rule_);
2573     struct flow_stats_ds_cbdata *cbdata = cbdata_;
2574     struct ds *results = cbdata->results;
2575     struct ofp_match match;
2576     uint64_t packet_count, byte_count;
2577     size_t act_len = sizeof *rule->actions * rule->n_actions;
2578
2579     /* Don't report on subrules. */
2580     if (rule->super != NULL) {
2581         return;
2582     }
2583
2584     query_stats(cbdata->ofproto, rule, &packet_count, &byte_count);
2585     flow_to_ovs_match(&rule->cr.flow, rule->cr.wc.wildcards, &match);
2586
2587     ds_put_format(results, "duration=%llds, ",
2588                   (time_msec() - rule->created) / 1000);
2589     ds_put_format(results, "priority=%u, ", rule->cr.priority);
2590     ds_put_format(results, "n_packets=%"PRIu64", ", packet_count);
2591     ds_put_format(results, "n_bytes=%"PRIu64", ", byte_count);
2592     ofp_print_match(results, &match, true);
2593     ofp_print_actions(results, &rule->actions->header, act_len);
2594     ds_put_cstr(results, "\n");
2595 }
2596
2597 /* Adds a pretty-printed description of all flows to 'results', including
2598  * those marked hidden by secchan (e.g., by in-band control). */
2599 void
2600 ofproto_get_all_flows(struct ofproto *p, struct ds *results)
2601 {
2602     struct ofp_match match;
2603     struct cls_rule target;
2604     struct flow_stats_ds_cbdata cbdata;
2605
2606     memset(&match, 0, sizeof match);
2607     match.wildcards = htonl(OFPFW_ALL);
2608
2609     cbdata.ofproto = p;
2610     cbdata.results = results;
2611
2612     cls_rule_from_match(&target, &match, 0);
2613     classifier_for_each_match(&p->cls, &target, CLS_INC_ALL,
2614                               flow_stats_ds_cb, &cbdata);
2615 }
2616
2617 struct aggregate_stats_cbdata {
2618     struct ofproto *ofproto;
2619     uint16_t out_port;
2620     uint64_t packet_count;
2621     uint64_t byte_count;
2622     uint32_t n_flows;
2623 };
2624
2625 static void
2626 aggregate_stats_cb(struct cls_rule *rule_, void *cbdata_)
2627 {
2628     struct rule *rule = rule_from_cls_rule(rule_);
2629     struct aggregate_stats_cbdata *cbdata = cbdata_;
2630     uint64_t packet_count, byte_count;
2631
2632     if (rule_is_hidden(rule) || !rule_has_out_port(rule, cbdata->out_port)) {
2633         return;
2634     }
2635
2636     query_stats(cbdata->ofproto, rule, &packet_count, &byte_count);
2637
2638     cbdata->packet_count += packet_count;
2639     cbdata->byte_count += byte_count;
2640     cbdata->n_flows++;
2641 }
2642
2643 static int
2644 handle_aggregate_stats_request(struct ofproto *p, struct ofconn *ofconn,
2645                                const struct ofp_stats_request *osr,
2646                                size_t arg_size)
2647 {
2648     struct ofp_aggregate_stats_request *asr;
2649     struct ofp_aggregate_stats_reply *reply;
2650     struct aggregate_stats_cbdata cbdata;
2651     struct cls_rule target;
2652     struct ofpbuf *msg;
2653
2654     if (arg_size != sizeof *asr) {
2655         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LENGTH);
2656     }
2657     asr = (struct ofp_aggregate_stats_request *) osr->body;
2658
2659     COVERAGE_INC(ofproto_agg_request);
2660     cbdata.ofproto = p;
2661     cbdata.out_port = asr->out_port;
2662     cbdata.packet_count = 0;
2663     cbdata.byte_count = 0;
2664     cbdata.n_flows = 0;
2665     cls_rule_from_match(&target, &asr->match, 0);
2666     classifier_for_each_match(&p->cls, &target,
2667                               table_id_to_include(asr->table_id),
2668                               aggregate_stats_cb, &cbdata);
2669
2670     msg = start_stats_reply(osr, sizeof *reply);
2671     reply = append_stats_reply(sizeof *reply, ofconn, &msg);
2672     reply->flow_count = htonl(cbdata.n_flows);
2673     reply->packet_count = htonll(cbdata.packet_count);
2674     reply->byte_count = htonll(cbdata.byte_count);
2675     queue_tx(msg, ofconn, ofconn->reply_counter);
2676     return 0;
2677 }
2678
2679 static int
2680 handle_stats_request(struct ofproto *p, struct ofconn *ofconn,
2681                      struct ofp_header *oh)
2682 {
2683     struct ofp_stats_request *osr;
2684     size_t arg_size;
2685     int error;
2686
2687     error = check_ofp_message_array(oh, OFPT_STATS_REQUEST, sizeof *osr,
2688                                     1, &arg_size);
2689     if (error) {
2690         return error;
2691     }
2692     osr = (struct ofp_stats_request *) oh;
2693
2694     switch (ntohs(osr->type)) {
2695     case OFPST_DESC:
2696         return handle_desc_stats_request(p, ofconn, osr);
2697
2698     case OFPST_FLOW:
2699         return handle_flow_stats_request(p, ofconn, osr, arg_size);
2700
2701     case OFPST_AGGREGATE:
2702         return handle_aggregate_stats_request(p, ofconn, osr, arg_size);
2703
2704     case OFPST_TABLE:
2705         return handle_table_stats_request(p, ofconn, osr);
2706
2707     case OFPST_PORT:
2708         return handle_port_stats_request(p, ofconn, osr);
2709
2710     case OFPST_VENDOR:
2711         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_VENDOR);
2712
2713     default:
2714         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_STAT);
2715     }
2716 }
2717
2718 static long long int
2719 msec_from_nsec(uint64_t sec, uint32_t nsec)
2720 {
2721     return !sec ? 0 : sec * 1000 + nsec / 1000000;
2722 }
2723
2724 static void
2725 update_time(struct ofproto *ofproto, struct rule *rule,
2726             const struct odp_flow_stats *stats)
2727 {
2728     long long int used = msec_from_nsec(stats->used_sec, stats->used_nsec);
2729     if (used > rule->used) {
2730         rule->used = used;
2731         netflow_flow_update_time(ofproto->netflow, &rule->nf_flow, used);
2732     }
2733 }
2734
2735 static void
2736 update_stats(struct ofproto *ofproto, struct rule *rule,
2737              const struct odp_flow_stats *stats)
2738 {
2739     if (stats->n_packets) {
2740         update_time(ofproto, rule, stats);
2741         rule->packet_count += stats->n_packets;
2742         rule->byte_count += stats->n_bytes;
2743         netflow_flow_update_flags(&rule->nf_flow, stats->ip_tos,
2744                                   stats->tcp_flags);
2745     }
2746 }
2747
2748 static int
2749 add_flow(struct ofproto *p, struct ofconn *ofconn,
2750          struct ofp_flow_mod *ofm, size_t n_actions)
2751 {
2752     struct ofpbuf *packet;
2753     struct rule *rule;
2754     uint16_t in_port;
2755     int error;
2756
2757     rule = rule_create(p, NULL, (const union ofp_action *) ofm->actions,
2758                        n_actions, ntohs(ofm->idle_timeout),
2759                        ntohs(ofm->hard_timeout));
2760     cls_rule_from_match(&rule->cr, &ofm->match, ntohs(ofm->priority));
2761
2762     packet = NULL;
2763     error = 0;
2764     if (ofm->buffer_id != htonl(UINT32_MAX)) {
2765         error = pktbuf_retrieve(ofconn->pktbuf, ntohl(ofm->buffer_id),
2766                                 &packet, &in_port);
2767     }
2768
2769     rule_insert(p, rule, packet, in_port);
2770     ofpbuf_delete(packet);
2771     return error;
2772 }
2773
2774 static int
2775 modify_flow(struct ofproto *p, const struct ofp_flow_mod *ofm,
2776             size_t n_actions, uint16_t command, struct rule *rule)
2777 {
2778     if (rule_is_hidden(rule)) {
2779         return 0;
2780     }
2781
2782     if (command == OFPFC_DELETE) {
2783         rule_remove(p, rule);
2784     } else {
2785         size_t actions_len = n_actions * sizeof *rule->actions;
2786
2787         if (n_actions == rule->n_actions
2788             && !memcmp(ofm->actions, rule->actions, actions_len))
2789         {
2790             return 0;
2791         }
2792
2793         free(rule->actions);
2794         rule->actions = xmemdup(ofm->actions, actions_len);
2795         rule->n_actions = n_actions;
2796
2797         if (rule->cr.wc.wildcards) {
2798             COVERAGE_INC(ofproto_mod_wc_flow);
2799             p->need_revalidate = true;
2800         } else {
2801             rule_update_actions(p, rule);
2802         }
2803     }
2804
2805     return 0;
2806 }
2807
2808 static int
2809 modify_flows_strict(struct ofproto *p, const struct ofp_flow_mod *ofm,
2810                     size_t n_actions, uint16_t command)
2811 {
2812     struct rule *rule;
2813     uint32_t wildcards;
2814     flow_t flow;
2815
2816     flow_from_match(&flow, &wildcards, &ofm->match);
2817     rule = rule_from_cls_rule(classifier_find_rule_exactly(
2818                                   &p->cls, &flow, wildcards,
2819                                   ntohs(ofm->priority)));
2820
2821     if (rule) {
2822         if (command == OFPFC_DELETE
2823             && ofm->out_port != htons(OFPP_NONE)
2824             && !rule_has_out_port(rule, ofm->out_port)) {
2825             return 0;
2826         }
2827
2828         modify_flow(p, ofm, n_actions, command, rule);
2829     }
2830     return 0;
2831 }
2832
2833 struct modify_flows_cbdata {
2834     struct ofproto *ofproto;
2835     const struct ofp_flow_mod *ofm;
2836     uint16_t out_port;
2837     size_t n_actions;
2838     uint16_t command;
2839 };
2840
2841 static void
2842 modify_flows_cb(struct cls_rule *rule_, void *cbdata_)
2843 {
2844     struct rule *rule = rule_from_cls_rule(rule_);
2845     struct modify_flows_cbdata *cbdata = cbdata_;
2846
2847     if (cbdata->out_port != htons(OFPP_NONE)
2848         && !rule_has_out_port(rule, cbdata->out_port)) {
2849         return;
2850     }
2851
2852     modify_flow(cbdata->ofproto, cbdata->ofm, cbdata->n_actions,
2853                 cbdata->command, rule);
2854 }
2855
2856 static int
2857 modify_flows_loose(struct ofproto *p, const struct ofp_flow_mod *ofm,
2858                    size_t n_actions, uint16_t command)
2859 {
2860     struct modify_flows_cbdata cbdata;
2861     struct cls_rule target;
2862
2863     cbdata.ofproto = p;
2864     cbdata.ofm = ofm;
2865     cbdata.out_port = (command == OFPFC_DELETE ? ofm->out_port
2866                        : htons(OFPP_NONE));
2867     cbdata.n_actions = n_actions;
2868     cbdata.command = command;
2869
2870     cls_rule_from_match(&target, &ofm->match, 0);
2871
2872     classifier_for_each_match(&p->cls, &target, CLS_INC_ALL,
2873                               modify_flows_cb, &cbdata);
2874     return 0;
2875 }
2876
2877 static int
2878 handle_flow_mod(struct ofproto *p, struct ofconn *ofconn,
2879                 struct ofp_flow_mod *ofm)
2880 {
2881     size_t n_actions;
2882     int error;
2883
2884     error = check_ofp_message_array(&ofm->header, OFPT_FLOW_MOD, sizeof *ofm,
2885                                     sizeof *ofm->actions, &n_actions);
2886     if (error) {
2887         return error;
2888     }
2889
2890     normalize_match(&ofm->match);
2891     if (!ofm->match.wildcards) {
2892         ofm->priority = htons(UINT16_MAX);
2893     }
2894
2895     error = validate_actions((const union ofp_action *) ofm->actions,
2896                              n_actions, p->max_ports);
2897     if (error) {
2898         return error;
2899     }
2900
2901     switch (ntohs(ofm->command)) {
2902     case OFPFC_ADD:
2903         return add_flow(p, ofconn, ofm, n_actions);
2904
2905     case OFPFC_MODIFY:
2906         return modify_flows_loose(p, ofm, n_actions, OFPFC_MODIFY);
2907
2908     case OFPFC_MODIFY_STRICT:
2909         return modify_flows_strict(p, ofm, n_actions, OFPFC_MODIFY);
2910
2911     case OFPFC_DELETE:
2912         return modify_flows_loose(p, ofm, n_actions, OFPFC_DELETE);
2913
2914     case OFPFC_DELETE_STRICT:
2915         return modify_flows_strict(p, ofm, n_actions, OFPFC_DELETE);
2916
2917     default:
2918         return ofp_mkerr(OFPET_FLOW_MOD_FAILED, OFPFMFC_BAD_COMMAND);
2919     }
2920 }
2921
2922 static void
2923 send_capability_reply(struct ofproto *p, struct ofconn *ofconn, uint32_t xid)
2924 {
2925     struct ofmp_capability_reply *ocr;
2926     struct ofpbuf *b;
2927     char capabilities[] = "com.nicira.mgmt.manager=false\n";
2928
2929     ocr = make_openflow_xid(sizeof(*ocr), OFPT_VENDOR, xid, &b);
2930     ocr->header.header.vendor = htonl(NX_VENDOR_ID);
2931     ocr->header.header.subtype = htonl(NXT_MGMT);
2932     ocr->header.type = htons(OFMPT_CAPABILITY_REPLY);
2933
2934     ocr->format = htonl(OFMPCOF_SIMPLE);
2935     ocr->mgmt_id = htonll(p->mgmt_id);
2936
2937     ofpbuf_put(b, capabilities, strlen(capabilities));
2938
2939     queue_tx(b, ofconn, ofconn->reply_counter);
2940 }
2941
2942 static int
2943 handle_ofmp(struct ofproto *p, struct ofconn *ofconn,
2944             struct ofmp_header *ofmph)
2945 {
2946     size_t msg_len = ntohs(ofmph->header.header.length);
2947     if (msg_len < sizeof(*ofmph)) {
2948         VLOG_WARN_RL(&rl, "dropping short managment message: %zu\n", msg_len);
2949         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LENGTH);
2950     }
2951
2952     if (ofmph->type == htons(OFMPT_CAPABILITY_REQUEST)) {
2953         struct ofmp_capability_request *ofmpcr;
2954
2955         if (msg_len < sizeof(struct ofmp_capability_request)) {
2956             VLOG_WARN_RL(&rl, "dropping short capability request: %zu\n",
2957                     msg_len);
2958             return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LENGTH);
2959         }
2960
2961         ofmpcr = (struct ofmp_capability_request *)ofmph;
2962         if (ofmpcr->format != htonl(OFMPCAF_SIMPLE)) {
2963             /* xxx Find a better type than bad subtype */
2964             return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_SUBTYPE);
2965         }
2966
2967         send_capability_reply(p, ofconn, ofmph->header.header.xid);
2968         return 0;
2969     } else {
2970         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_SUBTYPE);
2971     }
2972 }
2973
2974 static int
2975 handle_vendor(struct ofproto *p, struct ofconn *ofconn, void *msg)
2976 {
2977     struct ofp_vendor_header *ovh = msg;
2978     struct nicira_header *nh;
2979
2980     if (ntohs(ovh->header.length) < sizeof(struct ofp_vendor_header)) {
2981         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LENGTH);
2982     }
2983     if (ovh->vendor != htonl(NX_VENDOR_ID)) {
2984         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_VENDOR);
2985     }
2986     if (ntohs(ovh->header.length) < sizeof(struct nicira_header)) {
2987         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LENGTH);
2988     }
2989
2990     nh = msg;
2991     switch (ntohl(nh->subtype)) {
2992     case NXT_STATUS_REQUEST:
2993         return switch_status_handle_request(p->switch_status, ofconn->rconn,
2994                                             msg);
2995
2996     case NXT_ACT_SET_CONFIG:
2997         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_SUBTYPE); /* XXX */
2998
2999     case NXT_ACT_GET_CONFIG:
3000         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_SUBTYPE); /* XXX */
3001
3002     case NXT_COMMAND_REQUEST:
3003         if (p->executer) {
3004             return executer_handle_request(p->executer, ofconn->rconn, msg);
3005         }
3006         break;
3007
3008     case NXT_MGMT:
3009         return handle_ofmp(p, ofconn, msg);
3010     }
3011
3012     return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_SUBTYPE);
3013 }
3014
3015 static void
3016 handle_openflow(struct ofconn *ofconn, struct ofproto *p,
3017                 struct ofpbuf *ofp_msg)
3018 {
3019     struct ofp_header *oh = ofp_msg->data;
3020     int error;
3021
3022     COVERAGE_INC(ofproto_recv_openflow);
3023     switch (oh->type) {
3024     case OFPT_ECHO_REQUEST:
3025         error = handle_echo_request(ofconn, oh);
3026         break;
3027
3028     case OFPT_ECHO_REPLY:
3029         error = 0;
3030         break;
3031
3032     case OFPT_FEATURES_REQUEST:
3033         error = handle_features_request(p, ofconn, oh);
3034         break;
3035
3036     case OFPT_GET_CONFIG_REQUEST:
3037         error = handle_get_config_request(p, ofconn, oh);
3038         break;
3039
3040     case OFPT_SET_CONFIG:
3041         error = handle_set_config(p, ofconn, ofp_msg->data);
3042         break;
3043
3044     case OFPT_PACKET_OUT:
3045         error = handle_packet_out(p, ofconn, ofp_msg->data);
3046         break;
3047
3048     case OFPT_PORT_MOD:
3049         error = handle_port_mod(p, oh);
3050         break;
3051
3052     case OFPT_FLOW_MOD:
3053         error = handle_flow_mod(p, ofconn, ofp_msg->data);
3054         break;
3055
3056     case OFPT_STATS_REQUEST:
3057         error = handle_stats_request(p, ofconn, oh);
3058         break;
3059
3060     case OFPT_VENDOR:
3061         error = handle_vendor(p, ofconn, ofp_msg->data);
3062         break;
3063
3064     default:
3065         if (VLOG_IS_WARN_ENABLED()) {
3066             char *s = ofp_to_string(oh, ntohs(oh->length), 2);
3067             VLOG_DBG_RL(&rl, "OpenFlow message ignored: %s", s);
3068             free(s);
3069         }
3070         error = ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_TYPE);
3071         break;
3072     }
3073
3074     if (error) {
3075         send_error_oh(ofconn, ofp_msg->data, error);
3076     }
3077 }
3078 \f
3079 static void
3080 handle_odp_msg(struct ofproto *p, struct ofpbuf *packet)
3081 {
3082     struct odp_msg *msg = packet->data;
3083     uint16_t in_port = odp_port_to_ofp_port(msg->port);
3084     struct rule *rule;
3085     struct ofpbuf payload;
3086     flow_t flow;
3087
3088     /* Handle controller actions. */
3089     if (msg->type == _ODPL_ACTION_NR) {
3090         COVERAGE_INC(ofproto_ctlr_action);
3091         pinsched_send(p->action_sched, in_port, packet,
3092                       send_packet_in_action, p);
3093         return;
3094     }
3095
3096     payload.data = msg + 1;
3097     payload.size = msg->length - sizeof *msg;
3098     flow_extract(&payload, msg->port, &flow);
3099
3100     /* Check with in-band control to see if this packet should be sent
3101      * to the local port regardless of the flow table. */
3102     if (in_band_msg_in_hook(p->in_band, &flow, &payload)) {
3103         union odp_action action;
3104
3105         memset(&action, 0, sizeof(action));
3106         action.output.type = ODPAT_OUTPUT;
3107         action.output.port = ODPP_LOCAL;
3108         dpif_execute(&p->dpif, flow.in_port, &action, 1, &payload);
3109     }
3110
3111     rule = lookup_valid_rule(p, &flow);
3112     if (!rule) {
3113         /* Don't send a packet-in if OFPPC_NO_PACKET_IN asserted. */
3114         struct ofport *port = port_array_get(&p->ports, msg->port);
3115         if (port) {
3116             if (port->opp.config & OFPPC_NO_PACKET_IN) {
3117                 COVERAGE_INC(ofproto_no_packet_in);
3118                 /* XXX install 'drop' flow entry */
3119                 ofpbuf_delete(packet);
3120                 return;
3121             }
3122         } else {
3123             VLOG_WARN_RL(&rl, "packet-in on unknown port %"PRIu16, msg->port);
3124         }
3125
3126         COVERAGE_INC(ofproto_packet_in);
3127         pinsched_send(p->miss_sched, in_port, packet, send_packet_in_miss, p);
3128         return;
3129     }
3130
3131     if (rule->cr.wc.wildcards) {
3132         rule = rule_create_subrule(p, rule, &flow);
3133         rule_make_actions(p, rule, packet);
3134     } else {
3135         if (!rule->may_install) {
3136             /* The rule is not installable, that is, we need to process every
3137              * packet, so process the current packet and set its actions into
3138              * 'subrule'. */
3139             rule_make_actions(p, rule, packet);
3140         } else {
3141             /* XXX revalidate rule if it needs it */
3142         }
3143     }
3144
3145     rule_execute(p, rule, &payload, &flow);
3146     rule_reinstall(p, rule);
3147
3148     if (rule->super && rule->super->cr.priority == FAIL_OPEN_PRIORITY
3149         && rconn_is_connected(p->controller->rconn)) {
3150         /*
3151          * Extra-special case for fail-open mode.
3152          *
3153          * We are in fail-open mode and the packet matched the fail-open rule,
3154          * but we are connected to a controller too.  We should send the packet
3155          * up to the controller in the hope that it will try to set up a flow
3156          * and thereby allow us to exit fail-open.
3157          *
3158          * See the top-level comment in fail-open.c for more information.
3159          */
3160         pinsched_send(p->miss_sched, in_port, packet, send_packet_in_miss, p);
3161     } else {
3162         ofpbuf_delete(packet);
3163     }
3164 }
3165 \f
3166 static void
3167 revalidate_cb(struct cls_rule *sub_, void *cbdata_)
3168 {
3169     struct rule *sub = rule_from_cls_rule(sub_);
3170     struct revalidate_cbdata *cbdata = cbdata_;
3171
3172     if (cbdata->revalidate_all
3173         || (cbdata->revalidate_subrules && sub->super)
3174         || (tag_set_intersects(&cbdata->revalidate_set, sub->tags))) {
3175         revalidate_rule(cbdata->ofproto, sub);
3176     }
3177 }
3178
3179 static bool
3180 revalidate_rule(struct ofproto *p, struct rule *rule)
3181 {
3182     const flow_t *flow = &rule->cr.flow;
3183
3184     COVERAGE_INC(ofproto_revalidate_rule);
3185     if (rule->super) {
3186         struct rule *super;
3187         super = rule_from_cls_rule(classifier_lookup_wild(&p->cls, flow));
3188         if (!super) {
3189             rule_remove(p, rule);
3190             return false;
3191         } else if (super != rule->super) {
3192             COVERAGE_INC(ofproto_revalidate_moved);
3193             list_remove(&rule->list);
3194             list_push_back(&super->list, &rule->list);
3195             rule->super = super;
3196             rule->hard_timeout = super->hard_timeout;
3197             rule->idle_timeout = super->idle_timeout;
3198             rule->created = super->created;
3199             rule->used = 0;
3200         }
3201     }
3202
3203     rule_update_actions(p, rule);
3204     return true;
3205 }
3206
3207 static struct ofpbuf *
3208 compose_flow_exp(const struct rule *rule, long long int now, uint8_t reason)
3209 {
3210     struct ofp_flow_expired *ofe;
3211     struct ofpbuf *buf;
3212
3213     ofe = make_openflow(sizeof *ofe, OFPT_FLOW_EXPIRED, &buf);
3214     flow_to_match(&rule->cr.flow, rule->cr.wc.wildcards, &ofe->match);
3215     ofe->priority = htons(rule->cr.priority);
3216     ofe->reason = reason;
3217     ofe->duration = htonl((now - rule->created) / 1000);
3218     ofe->packet_count = htonll(rule->packet_count);
3219     ofe->byte_count = htonll(rule->byte_count);
3220
3221     return buf;
3222 }
3223
3224 static void
3225 send_flow_exp(struct ofproto *p, struct rule *rule,
3226               long long int now, uint8_t reason)
3227 {
3228     struct ofconn *ofconn;
3229     struct ofconn *prev;
3230     struct ofpbuf *buf;
3231
3232     /* We limit the maximum number of queued flow expirations it by accounting
3233      * them under the counter for replies.  That works because preventing
3234      * OpenFlow requests from being processed also prevents new flows from
3235      * being added (and expiring).  (It also prevents processing OpenFlow
3236      * requests that would not add new flows, so it is imperfect.) */
3237
3238     prev = NULL;
3239     LIST_FOR_EACH (ofconn, struct ofconn, node, &p->all_conns) {
3240         if (ofconn->send_flow_exp && rconn_is_connected(ofconn->rconn)) {
3241             if (prev) {
3242                 queue_tx(ofpbuf_clone(buf), prev, prev->reply_counter);
3243             } else {
3244                 buf = compose_flow_exp(rule, now, reason);
3245             }
3246             prev = ofconn;
3247         }
3248     }
3249     if (prev) {
3250         queue_tx(buf, prev, prev->reply_counter);
3251     }
3252 }
3253
3254 static void
3255 uninstall_idle_flow(struct ofproto *ofproto, struct rule *rule)
3256 {
3257     assert(rule->installed);
3258     assert(!rule->cr.wc.wildcards);
3259
3260     if (rule->super) {
3261         rule_remove(ofproto, rule);
3262     } else {
3263         rule_uninstall(ofproto, rule);
3264     }
3265 }
3266
3267 static void
3268 expire_rule(struct cls_rule *cls_rule, void *p_)
3269 {
3270     struct ofproto *p = p_;
3271     struct rule *rule = rule_from_cls_rule(cls_rule);
3272     long long int hard_expire, idle_expire, expire, now;
3273
3274     hard_expire = (rule->hard_timeout
3275                    ? rule->created + rule->hard_timeout * 1000
3276                    : LLONG_MAX);
3277     idle_expire = (rule->idle_timeout
3278                    && (rule->super || list_is_empty(&rule->list))
3279                    ? rule->used + rule->idle_timeout * 1000
3280                    : LLONG_MAX);
3281     expire = MIN(hard_expire, idle_expire);
3282
3283     now = time_msec();
3284     if (now < expire) {
3285         if (rule->installed && now >= rule->used + 5000) {
3286             uninstall_idle_flow(p, rule);
3287         } else if (!rule->cr.wc.wildcards) {
3288             active_timeout(p, rule);
3289         }
3290
3291         return;
3292     }
3293
3294     COVERAGE_INC(ofproto_expired);
3295
3296     /* Update stats.  This code will be a no-op if the rule expired
3297      * due to an idle timeout. */
3298     if (rule->cr.wc.wildcards) {
3299         struct rule *subrule, *next;
3300         LIST_FOR_EACH_SAFE (subrule, next, struct rule, list, &rule->list) {
3301             rule_remove(p, subrule);
3302         }
3303     } else {
3304         rule_uninstall(p, rule);
3305     }
3306
3307     send_flow_exp(p, rule, now,
3308                   (now >= hard_expire
3309                    ? OFPER_HARD_TIMEOUT : OFPER_IDLE_TIMEOUT));
3310     rule_remove(p, rule);
3311 }
3312
3313 static void
3314 active_timeout(struct ofproto *ofproto, struct rule *rule)
3315 {
3316     if (ofproto->netflow && !is_controller_rule(rule) &&
3317         netflow_active_timeout_expired(ofproto->netflow, &rule->nf_flow)) {
3318         struct ofexpired expired;
3319         struct odp_flow odp_flow;
3320
3321         /* Get updated flow stats. */
3322         memset(&odp_flow, 0, sizeof odp_flow);
3323         if (rule->installed) {
3324             odp_flow.key = rule->cr.flow;
3325             odp_flow.flags = ODPFF_ZERO_TCP_FLAGS;
3326             dpif_flow_get(&ofproto->dpif, &odp_flow);
3327
3328             if (odp_flow.stats.n_packets) {
3329                 update_time(ofproto, rule, &odp_flow.stats);
3330                 netflow_flow_update_flags(&rule->nf_flow, odp_flow.stats.ip_tos,
3331                                           odp_flow.stats.tcp_flags);
3332             }
3333         }
3334
3335         expired.flow = rule->cr.flow;
3336         expired.packet_count = rule->packet_count +
3337                                odp_flow.stats.n_packets;
3338         expired.byte_count = rule->byte_count + odp_flow.stats.n_bytes;
3339         expired.used = rule->used;
3340
3341         netflow_expire(ofproto->netflow, &rule->nf_flow, &expired);
3342
3343         /* Schedule us to send the accumulated records once we have
3344          * collected all of them. */
3345         poll_immediate_wake();
3346     }
3347 }
3348
3349 static void
3350 update_used(struct ofproto *p)
3351 {
3352     struct odp_flow *flows;
3353     size_t n_flows;
3354     size_t i;
3355     int error;
3356
3357     error = dpif_flow_list_all(&p->dpif, &flows, &n_flows);
3358     if (error) {
3359         return;
3360     }
3361
3362     for (i = 0; i < n_flows; i++) {
3363         struct odp_flow *f = &flows[i];
3364         struct rule *rule;
3365
3366         rule = rule_from_cls_rule(
3367             classifier_find_rule_exactly(&p->cls, &f->key, 0, UINT16_MAX));
3368         if (!rule || !rule->installed) {
3369             COVERAGE_INC(ofproto_unexpected_rule);
3370             dpif_flow_del(&p->dpif, f);
3371             continue;
3372         }
3373
3374         update_time(p, rule, &f->stats);
3375         rule_account(p, rule, f->stats.n_bytes);
3376     }
3377     free(flows);
3378 }
3379
3380 static void
3381 do_send_packet_in(struct ofconn *ofconn, uint32_t buffer_id,
3382                   const struct ofpbuf *packet, int send_len)
3383 {
3384     struct odp_msg *msg = packet->data;
3385     struct ofpbuf payload;
3386     struct ofpbuf *opi;
3387     uint8_t reason;
3388
3389     /* Extract packet payload from 'msg'. */
3390     payload.data = msg + 1;
3391     payload.size = msg->length - sizeof *msg;
3392
3393     /* Construct ofp_packet_in message. */
3394     reason = msg->type == _ODPL_ACTION_NR ? OFPR_ACTION : OFPR_NO_MATCH;
3395     opi = make_packet_in(buffer_id, odp_port_to_ofp_port(msg->port), reason,
3396                          &payload, send_len);
3397
3398     /* Send. */
3399     rconn_send_with_limit(ofconn->rconn, opi, ofconn->packet_in_counter, 100);
3400 }
3401
3402 static void
3403 send_packet_in_action(struct ofpbuf *packet, void *p_)
3404 {
3405     struct ofproto *p = p_;
3406     struct ofconn *ofconn;
3407     struct odp_msg *msg;
3408
3409     msg = packet->data;
3410     LIST_FOR_EACH (ofconn, struct ofconn, node, &p->all_conns) {
3411         if (ofconn == p->controller || ofconn->miss_send_len) {
3412             do_send_packet_in(ofconn, UINT32_MAX, packet, msg->arg);
3413         }
3414     }
3415     ofpbuf_delete(packet);
3416 }
3417
3418 static void
3419 send_packet_in_miss(struct ofpbuf *packet, void *p_)
3420 {
3421     struct ofproto *p = p_;
3422     bool in_fail_open = p->fail_open && fail_open_is_active(p->fail_open);
3423     struct ofconn *ofconn;
3424     struct ofpbuf payload;
3425     struct odp_msg *msg;
3426
3427     msg = packet->data;
3428     payload.data = msg + 1;
3429     payload.size = msg->length - sizeof *msg;
3430     LIST_FOR_EACH (ofconn, struct ofconn, node, &p->all_conns) {
3431         if (ofconn->miss_send_len) {
3432             struct pktbuf *pb = ofconn->pktbuf;
3433             uint32_t buffer_id = (in_fail_open
3434                                   ? pktbuf_get_null()
3435                                   : pktbuf_save(pb, &payload, msg->port));
3436             int send_len = (buffer_id != UINT32_MAX ? ofconn->miss_send_len
3437                             : UINT32_MAX);
3438             do_send_packet_in(ofconn, buffer_id, packet, send_len);
3439         }
3440     }
3441     ofpbuf_delete(packet);
3442 }
3443
3444 static uint64_t
3445 pick_datapath_id(struct dpif *dpif, uint64_t fallback_dpid)
3446 {
3447     char local_name[IF_NAMESIZE];
3448     uint8_t ea[ETH_ADDR_LEN];
3449     int error;
3450
3451     error = dpif_get_name(dpif, local_name, sizeof local_name);
3452     if (!error) {
3453         error = netdev_nodev_get_etheraddr(local_name, ea);
3454         if (!error) {
3455             return eth_addr_to_uint64(ea);
3456         }
3457         VLOG_WARN("could not get MAC address for %s (%s)",
3458                   local_name, strerror(error));
3459     }
3460
3461     return fallback_dpid;
3462 }
3463
3464 static uint64_t
3465 pick_fallback_dpid(void)
3466 {
3467     uint8_t ea[ETH_ADDR_LEN];
3468     eth_addr_random(ea);
3469     ea[0] = 0x00;               /* Set Nicira OUI. */
3470     ea[1] = 0x23;
3471     ea[2] = 0x20;
3472     return eth_addr_to_uint64(ea);
3473 }
3474 \f
3475 static bool
3476 default_normal_ofhook_cb(const flow_t *flow, const struct ofpbuf *packet,
3477                          struct odp_actions *actions, tag_type *tags,
3478                          uint16_t *nf_output_iface, void *ofproto_)
3479 {
3480     struct ofproto *ofproto = ofproto_;
3481     int out_port;
3482
3483     /* Drop frames for reserved multicast addresses. */
3484     if (eth_addr_is_reserved(flow->dl_dst)) {
3485         return true;
3486     }
3487
3488     /* Learn source MAC (but don't try to learn from revalidation). */
3489     if (packet != NULL) {
3490         tag_type rev_tag = mac_learning_learn(ofproto->ml, flow->dl_src,
3491                                               0, flow->in_port);
3492         if (rev_tag) {
3493             /* The log messages here could actually be useful in debugging,
3494              * so keep the rate limit relatively high. */
3495             static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(30, 300);
3496             VLOG_DBG_RL(&rl, "learned that "ETH_ADDR_FMT" is on port %"PRIu16,
3497                         ETH_ADDR_ARGS(flow->dl_src), flow->in_port);
3498             ofproto_revalidate(ofproto, rev_tag);
3499         }
3500     }
3501
3502     /* Determine output port. */
3503     out_port = mac_learning_lookup_tag(ofproto->ml, flow->dl_dst, 0, tags);
3504     if (out_port < 0) {
3505         add_output_group_action(actions, DP_GROUP_FLOOD, nf_output_iface);
3506     } else if (out_port != flow->in_port) {
3507         odp_actions_add(actions, ODPAT_OUTPUT)->output.port = out_port;
3508         *nf_output_iface = out_port;
3509     } else {
3510         /* Drop. */
3511     }
3512
3513     return true;
3514 }
3515
3516 static const struct ofhooks default_ofhooks = {
3517     NULL,
3518     default_normal_ofhook_cb,
3519     NULL,
3520     NULL
3521 };