ofproto/ofproto.c

   1 /*
   2  * Copyright (c) 2009, 2010, 2011 Nicira Networks.
   3  * Copyright (c) 2010 Jean Tourrilhes - HP-Labs.
   4  *
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at:
   8  *
   9  *     http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  */
  17
  18 #include <config.h>
  19 #include "ofproto.h"
  20 #include <errno.h>
  21 #include <inttypes.h>
  22 #include <sys/socket.h>
  23 #include <net/if.h>
  24 #include <netinet/in.h>
  25 #include <stdbool.h>
  26 #include <stdlib.h>
  27 #include "byte-order.h"
  28 #include "classifier.h"
  29 #include "coverage.h"
  30 #include "discovery.h"
  31 #include "dpif.h"
  32 #include "dynamic-string.h"
  33 #include "fail-open.h"
  34 #include "hash.h"
  35 #include "hmap.h"
  36 #include "in-band.h"
  37 #include "mac-learning.h"
  38 #include "multipath.h"
  39 #include "netdev.h"
  40 #include "netflow.h"
  41 #include "netlink.h"
  42 #include "nx-match.h"
  43 #include "odp-util.h"
  44 #include "ofp-print.h"
  45 #include "ofp-util.h"
  46 #include "ofproto-sflow.h"
  47 #include "ofpbuf.h"
  48 #include "openflow/nicira-ext.h"
  49 #include "openflow/openflow.h"
  50 #include "openvswitch/datapath-protocol.h"
  51 #include "packets.h"
  52 #include "pinsched.h"
  53 #include "pktbuf.h"
  54 #include "poll-loop.h"
  55 #include "rconn.h"
  56 #include "shash.h"
  57 #include "status.h"
  58 #include "stream-ssl.h"
  59 #include "svec.h"
  60 #include "tag.h"
  61 #include "timeval.h"
  62 #include "unaligned.h"
  63 #include "unixctl.h"
  64 #include "vconn.h"
  65 #include "vlog.h"
  66
  67 VLOG_DEFINE_THIS_MODULE(ofproto);
  68
  69 COVERAGE_DEFINE(facet_changed_rule);
  70 COVERAGE_DEFINE(facet_revalidate);
  71 COVERAGE_DEFINE(odp_overflow);
  72 COVERAGE_DEFINE(ofproto_agg_request);
  73 COVERAGE_DEFINE(ofproto_costly_flags);
  74 COVERAGE_DEFINE(ofproto_ctlr_action);
  75 COVERAGE_DEFINE(ofproto_del_rule);
  76 COVERAGE_DEFINE(ofproto_error);
  77 COVERAGE_DEFINE(ofproto_expiration);
  78 COVERAGE_DEFINE(ofproto_expired);
  79 COVERAGE_DEFINE(ofproto_flows_req);
  80 COVERAGE_DEFINE(ofproto_flush);
  81 COVERAGE_DEFINE(ofproto_invalidated);
  82 COVERAGE_DEFINE(ofproto_no_packet_in);
  83 COVERAGE_DEFINE(ofproto_ofconn_stuck);
  84 COVERAGE_DEFINE(ofproto_ofp2odp);
  85 COVERAGE_DEFINE(ofproto_packet_in);
  86 COVERAGE_DEFINE(ofproto_packet_out);
  87 COVERAGE_DEFINE(ofproto_queue_req);
  88 COVERAGE_DEFINE(ofproto_recv_openflow);
  89 COVERAGE_DEFINE(ofproto_reinit_ports);
  90 COVERAGE_DEFINE(ofproto_unexpected_rule);
  91 COVERAGE_DEFINE(ofproto_uninstallable);
  92 COVERAGE_DEFINE(ofproto_update_port);
  93
  94 #include "sflow_api.h"
  95
  96 /* Maximum depth of flow table recursion (due to NXAST_RESUBMIT actions) in a
  97  * flow translation. */
  98 #define MAX_RESUBMIT_RECURSION 16
  99
 100 struct rule;
 101
 102 struct ofport {
 103     struct hmap_node hmap_node; /* In struct ofproto's "ports" hmap. */
 104     struct netdev *netdev;
 105     struct ofp_phy_port opp;    /* In host byte order. */
 106     uint16_t odp_port;
 107 };
 108
 109 static void ofport_free(struct ofport *);
 110 static void hton_ofp_phy_port(struct ofp_phy_port *);
 111
 112 struct action_xlate_ctx {
 113 /* action_xlate_ctx_init() initializes these members. */
 114
 115     /* The ofproto. */
 116     struct ofproto *ofproto;
 117
 118     /* Flow to which the OpenFlow actions apply.  xlate_actions() will modify
 119      * this flow when actions change header fields. */
 120     struct flow flow;
 121
 122     /* The packet corresponding to 'flow', or a null pointer if we are
 123      * revalidating without a packet to refer to. */
 124     const struct ofpbuf *packet;
 125
 126     /* If nonnull, called just before executing a resubmit action.
 127      *
 128      * This is normally null so the client has to set it manually after
 129      * calling action_xlate_ctx_init(). */
 130     void (*resubmit_hook)(struct action_xlate_ctx *, struct rule *);
 131
 132     /* If true, the speciality of 'flow' should be checked before executing
 133      * its actions.  If special_cb returns false on 'flow' rendered
 134      * uninstallable and no actions will be executed. */
 135     bool check_special;
 136
 137 /* xlate_actions() initializes and uses these members.  The client might want
 138  * to look at them after it returns. */
 139
 140     struct ofpbuf *odp_actions; /* Datapath actions. */
 141     tag_type tags;              /* Tags associated with OFPP_NORMAL actions. */
 142     bool may_set_up_flow;       /* True ordinarily; false if the actions must
 143                                  * be reassessed for every packet. */
 144     uint16_t nf_output_iface;   /* Output interface index for NetFlow. */
 145
 146 /* xlate_actions() initializes and uses these members, but the client has no
 147  * reason to look at them. */
 148
 149     int recurse;                /* Recursion level, via xlate_table_action. */
 150     int last_pop_priority;      /* Offset in 'odp_actions' just past most
 151                                  * recent ODP_ACTION_ATTR_SET_PRIORITY. */
 152 };
 153
 154 static void action_xlate_ctx_init(struct action_xlate_ctx *,
 155                                   struct ofproto *, const struct flow *,
 156                                   const struct ofpbuf *);
 157 static struct ofpbuf *xlate_actions(struct action_xlate_ctx *,
 158                                     const union ofp_action *in, size_t n_in);
 159
 160 /* An OpenFlow flow. */
 161 struct rule {
 162     long long int used;         /* Time last used; time created if not used. */
 163     long long int created;      /* Creation time. */
 164
 165     /* These statistics:
 166      *
 167      *   - Do include packets and bytes from facets that have been deleted or
 168      *     whose own statistics have been folded into the rule.
 169      *
 170      *   - Do include packets and bytes sent "by hand" that were accounted to
 171      *     the rule without any facet being involved (this is a rare corner
 172      *     case in rule_execute()).
 173      *
 174      *   - Do not include packet or bytes that can be obtained from any facet's
 175      *     packet_count or byte_count member or that can be obtained from the
 176      *     datapath by, e.g., dpif_flow_get() for any facet.
 177      */
 178     uint64_t packet_count;       /* Number of packets received. */
 179     uint64_t byte_count;         /* Number of bytes received. */
 180
 181     ovs_be64 flow_cookie;        /* Controller-issued identifier. */
 182
 183     struct cls_rule cr;          /* In owning ofproto's classifier. */
 184     uint16_t idle_timeout;       /* In seconds from time of last use. */
 185     uint16_t hard_timeout;       /* In seconds from time of creation. */
 186     bool send_flow_removed;      /* Send a flow removed message? */
 187     int n_actions;               /* Number of elements in actions[]. */
 188     union ofp_action *actions;   /* OpenFlow actions. */
 189     struct list facets;          /* List of "struct facet"s. */
 190 };
 191
 192 static struct rule *rule_from_cls_rule(const struct cls_rule *);
 193 static bool rule_is_hidden(const struct rule *);
 194
 195 static struct rule *rule_create(const struct cls_rule *,
 196                                 const union ofp_action *, size_t n_actions,
 197                                 uint16_t idle_timeout, uint16_t hard_timeout,
 198                                 ovs_be64 flow_cookie, bool send_flow_removed);
 199 static void rule_destroy(struct ofproto *, struct rule *);
 200 static void rule_free(struct rule *);
 201
 202 static struct rule *rule_lookup(struct ofproto *, const struct flow *);
 203 static void rule_insert(struct ofproto *, struct rule *);
 204 static void rule_remove(struct ofproto *, struct rule *);
 205
 206 static void rule_send_removed(struct ofproto *, struct rule *, uint8_t reason);
 207 static void rule_get_stats(const struct rule *, uint64_t *packets,
 208                            uint64_t *bytes);
 209
 210 /* An exact-match instantiation of an OpenFlow flow. */
 211 struct facet {
 212     long long int used;         /* Time last used; time created if not used. */
 213
 214     /* These statistics:
 215      *
 216      *   - Do include packets and bytes sent "by hand", e.g. with
 217      *     dpif_execute().
 218      *
 219      *   - Do include packets and bytes that were obtained from the datapath
 220      *     when a flow was deleted (e.g. dpif_flow_del()) or when its
 221      *     statistics were reset (e.g. dpif_flow_put() with
 222      *     DPIF_FP_ZERO_STATS).
 223      *
 224      *   - Do not include any packets or bytes that can currently be obtained
 225      *     from the datapath by, e.g., dpif_flow_get().
 226      */
 227     uint64_t packet_count;       /* Number of packets received. */
 228     uint64_t byte_count;         /* Number of bytes received. */
 229
 230     uint64_t dp_packet_count;    /* Last known packet count in the datapath. */
 231     uint64_t dp_byte_count;      /* Last known byte count in the datapath. */
 232
 233     uint64_t rs_packet_count;    /* Packets pushed to resubmit children. */
 234     uint64_t rs_byte_count;      /* Bytes pushed to resubmit children. */
 235     long long int rs_used;       /* Used time pushed to resubmit children. */
 236
 237     /* Number of bytes passed to account_cb.  This may include bytes that can
 238      * currently obtained from the datapath (thus, it can be greater than
 239      * byte_count). */
 240     uint64_t accounted_bytes;
 241
 242     struct hmap_node hmap_node;  /* In owning ofproto's 'facets' hmap. */
 243     struct list list_node;       /* In owning rule's 'facets' list. */
 244     struct rule *rule;           /* Owning rule. */
 245     struct flow flow;            /* Exact-match flow. */
 246     bool installed;              /* Installed in datapath? */
 247     bool may_install;            /* True ordinarily; false if actions must
 248                                   * be reassessed for every packet. */
 249     size_t actions_len;          /* Number of bytes in actions[]. */
 250     struct nlattr *actions;      /* Datapath actions. */
 251     tag_type tags;               /* Tags (set only by hooks). */
 252     struct netflow_flow nf_flow; /* Per-flow NetFlow tracking data. */
 253 };
 254
 255 static struct facet *facet_create(struct ofproto *, struct rule *,
 256                                   const struct flow *,
 257                                   const struct ofpbuf *packet);
 258 static void facet_remove(struct ofproto *, struct facet *);
 259 static void facet_free(struct facet *);
 260
 261 static struct facet *facet_lookup_valid(struct ofproto *, const struct flow *);
 262 static bool facet_revalidate(struct ofproto *, struct facet *);
 263
 264 static void facet_install(struct ofproto *, struct facet *, bool zero_stats);
 265 static void facet_uninstall(struct ofproto *, struct facet *);
 266 static void facet_flush_stats(struct ofproto *, struct facet *);
 267
 268 static void facet_make_actions(struct ofproto *, struct facet *,
 269                                const struct ofpbuf *packet);
 270 static void facet_update_stats(struct ofproto *, struct facet *,
 271                                const struct dpif_flow_stats *);
 272 static void facet_push_stats(struct ofproto *, struct facet *);
 273
 274 /* ofproto supports two kinds of OpenFlow connections:
 275  *
 276  *   - "Primary" connections to ordinary OpenFlow controllers.  ofproto
 277  *     maintains persistent connections to these controllers and by default
 278  *     sends them asynchronous messages such as packet-ins.
 279  *
 280  *   - "Service" connections, e.g. from ovs-ofctl.  When these connections
 281  *     drop, it is the other side's responsibility to reconnect them if
 282  *     necessary.  ofproto does not send them asynchronous messages by default.
 283  *
 284  * Currently, active (tcp, ssl, unix) connections are always "primary"
 285  * connections and passive (ptcp, pssl, punix) connections are always "service"
 286  * connections.  There is no inherent reason for this, but it reflects the
 287  * common case.
 288  */
 289 enum ofconn_type {
 290     OFCONN_PRIMARY,             /* An ordinary OpenFlow controller. */
 291     OFCONN_SERVICE              /* A service connection, e.g. "ovs-ofctl". */
 292 };
 293
 294 /* A listener for incoming OpenFlow "service" connections. */
 295 struct ofservice {
 296     struct hmap_node node;      /* In struct ofproto's "services" hmap. */
 297     struct pvconn *pvconn;      /* OpenFlow connection listener. */
 298
 299     /* These are not used by ofservice directly.  They are settings for
 300      * accepted "struct ofconn"s from the pvconn. */
 301     int probe_interval;         /* Max idle time before probing, in seconds. */
 302     int rate_limit;             /* Max packet-in rate in packets per second. */
 303     int burst_limit;            /* Limit on accumulating packet credits. */
 304 };
 305
 306 static struct ofservice *ofservice_lookup(struct ofproto *,
 307                                           const char *target);
 308 static int ofservice_create(struct ofproto *,
 309                             const struct ofproto_controller *);
 310 static void ofservice_reconfigure(struct ofservice *,
 311                                   const struct ofproto_controller *);
 312 static void ofservice_destroy(struct ofproto *, struct ofservice *);
 313
 314 /* An OpenFlow connection. */
 315 struct ofconn {
 316     struct ofproto *ofproto;    /* The ofproto that owns this connection. */
 317     struct list node;           /* In struct ofproto's "all_conns" list. */
 318     struct rconn *rconn;        /* OpenFlow connection. */
 319     enum ofconn_type type;      /* Type. */
 320     enum nx_flow_format flow_format; /* Currently selected flow format. */
 321
 322     /* OFPT_PACKET_IN related data. */
 323     struct rconn_packet_counter *packet_in_counter; /* # queued on 'rconn'. */
 324 #define N_SCHEDULERS 2
 325     struct pinsched *schedulers[N_SCHEDULERS];
 326     struct pktbuf *pktbuf;         /* OpenFlow packet buffers. */
 327     int miss_send_len;             /* Bytes to send of buffered packets. */
 328
 329     /* Number of OpenFlow messages queued on 'rconn' as replies to OpenFlow
 330      * requests, and the maximum number before we stop reading OpenFlow
 331      * requests.  */
 332 #define OFCONN_REPLY_MAX 100
 333     struct rconn_packet_counter *reply_counter;
 334
 335     /* type == OFCONN_PRIMARY only. */
 336     enum nx_role role;           /* Role. */
 337     struct hmap_node hmap_node;  /* In struct ofproto's "controllers" map. */
 338     struct discovery *discovery; /* Controller discovery object, if enabled. */
 339     struct status_category *ss;  /* Switch status category. */
 340     enum ofproto_band band;      /* In-band or out-of-band? */
 341 };
 342
 343
 344 static struct ofconn *ofconn_create(struct ofproto *, struct rconn *,
 345                                     enum ofconn_type);
 346 static void ofconn_destroy(struct ofconn *);
 347 static void ofconn_run(struct ofconn *);
 348 static void ofconn_wait(struct ofconn *);
 349 static bool ofconn_receives_async_msgs(const struct ofconn *);
 350 static char *ofconn_make_name(const struct ofproto *, const char *target);
 351 static void ofconn_set_rate_limit(struct ofconn *, int rate, int burst);
 352
 353 static void queue_tx(struct ofpbuf *msg, const struct ofconn *ofconn,
 354                      struct rconn_packet_counter *counter);
 355
 356 static void send_packet_in(struct ofproto *, struct dpif_upcall *,
 357                            const struct flow *, bool clone);
 358 static void do_send_packet_in(struct ofpbuf *ofp_packet_in, void *ofconn);
 359
 360 struct ofproto {
 361     /* Settings. */
 362     uint64_t datapath_id;       /* Datapath ID. */
 363     uint64_t fallback_dpid;     /* Datapath ID if no better choice found. */
 364     char *mfr_desc;             /* Manufacturer. */
 365     char *hw_desc;              /* Hardware. */
 366     char *sw_desc;              /* Software version. */
 367     char *serial_desc;          /* Serial number. */
 368     char *dp_desc;              /* Datapath description. */
 369
 370     /* Datapath. */
 371     struct dpif *dpif;
 372     struct netdev_monitor *netdev_monitor;
 373     struct hmap ports;          /* Contains "struct ofport"s. */
 374     struct shash port_by_name;
 375     uint32_t max_ports;
 376
 377     /* Configuration. */
 378     struct switch_status *switch_status;
 379     struct fail_open *fail_open;
 380     struct netflow *netflow;
 381     struct ofproto_sflow *sflow;
 382
 383     /* In-band control. */
 384     struct in_band *in_band;
 385     long long int next_in_band_update;
 386     struct sockaddr_in *extra_in_band_remotes;
 387     size_t n_extra_remotes;
 388     int in_band_queue;
 389
 390     /* Flow table. */
 391     struct classifier cls;
 392     long long int next_expiration;
 393
 394     /* Facets. */
 395     struct hmap facets;
 396     bool need_revalidate;
 397     struct tag_set revalidate_set;
 398
 399     /* OpenFlow connections. */
 400     struct hmap controllers;   /* Controller "struct ofconn"s. */
 401     struct list all_conns;     /* Contains "struct ofconn"s. */
 402     enum ofproto_fail_mode fail_mode;
 403
 404     /* OpenFlow listeners. */
 405     struct hmap services;       /* Contains "struct ofservice"s. */
 406     struct pvconn **snoops;
 407     size_t n_snoops;
 408
 409     /* Hooks for ovs-vswitchd. */
 410     const struct ofhooks *ofhooks;
 411     void *aux;
 412
 413     /* Used by default ofhooks. */
 414     struct mac_learning *ml;
 415 };
 416
 417 /* Map from dpif name to struct ofproto, for use by unixctl commands. */
 418 static struct shash all_ofprotos = SHASH_INITIALIZER(&all_ofprotos);
 419
 420 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
 421
 422 static const struct ofhooks default_ofhooks;
 423
 424 static uint64_t pick_datapath_id(const struct ofproto *);
 425 static uint64_t pick_fallback_dpid(void);
 426
 427 static int ofproto_expire(struct ofproto *);
 428 static void flow_push_stats(struct ofproto *, const struct rule *,
 429                             struct flow *, uint64_t packets, uint64_t bytes,
 430                             long long int used);
 431
 432 static void handle_upcall(struct ofproto *, struct dpif_upcall *);
 433
 434 static void handle_openflow(struct ofconn *, struct ofpbuf *);
 435
 436 static struct ofport *get_port(const struct ofproto *, uint16_t odp_port);
 437 static void update_port(struct ofproto *, const char *devname);
 438 static int init_ports(struct ofproto *);
 439 static void reinit_ports(struct ofproto *);
 440
 441 static void ofproto_unixctl_init(void);
 442
 443 int
 444 ofproto_create(const char *datapath, const char *datapath_type,
 445                const struct ofhooks *ofhooks, void *aux,
 446                struct ofproto **ofprotop)
 447 {
 448     struct ofproto *p;
 449     struct dpif *dpif;
 450     int error;
 451
 452     *ofprotop = NULL;
 453
 454     ofproto_unixctl_init();
 455
 456     /* Connect to datapath and start listening for messages. */
 457     error = dpif_open(datapath, datapath_type, &dpif);
 458     if (error) {
 459         VLOG_ERR("failed to open datapath %s: %s", datapath, strerror(error));
 460         return error;
 461     }
 462     error = dpif_recv_set_mask(dpif,
 463                                ((1u << DPIF_UC_MISS) |
 464                                 (1u << DPIF_UC_ACTION) |
 465                                 (1u << DPIF_UC_SAMPLE)));
 466     if (error) {
 467         VLOG_ERR("failed to listen on datapath %s: %s",
 468                  datapath, strerror(error));
 469         dpif_close(dpif);
 470         return error;
 471     }
 472     dpif_flow_flush(dpif);
 473     dpif_recv_purge(dpif);
 474
 475     /* Initialize settings. */
 476     p = xzalloc(sizeof *p);
 477     p->fallback_dpid = pick_fallback_dpid();
 478     p->datapath_id = p->fallback_dpid;
 479     p->mfr_desc = xstrdup(DEFAULT_MFR_DESC);
 480     p->hw_desc = xstrdup(DEFAULT_HW_DESC);
 481     p->sw_desc = xstrdup(DEFAULT_SW_DESC);
 482     p->serial_desc = xstrdup(DEFAULT_SERIAL_DESC);
 483     p->dp_desc = xstrdup(DEFAULT_DP_DESC);
 484
 485     /* Initialize datapath. */
 486     p->dpif = dpif;
 487     p->netdev_monitor = netdev_monitor_create();
 488     hmap_init(&p->ports);
 489     shash_init(&p->port_by_name);
 490     p->max_ports = dpif_get_max_ports(dpif);
 491
 492     /* Initialize submodules. */
 493     p->switch_status = switch_status_create(p);
 494     p->fail_open = NULL;
 495     p->netflow = NULL;
 496     p->sflow = NULL;
 497
 498     /* Initialize in-band control. */
 499     p->in_band = NULL;
 500     p->in_band_queue = -1;
 501
 502     /* Initialize flow table. */
 503     classifier_init(&p->cls);
 504     p->next_expiration = time_msec() + 1000;
 505
 506     /* Initialize facet table. */
 507     hmap_init(&p->facets);
 508     p->need_revalidate = false;
 509     tag_set_init(&p->revalidate_set);
 510
 511     /* Initialize OpenFlow connections. */
 512     list_init(&p->all_conns);
 513     hmap_init(&p->controllers);
 514     hmap_init(&p->services);
 515     p->snoops = NULL;
 516     p->n_snoops = 0;
 517
 518     /* Initialize hooks. */
 519     if (ofhooks) {
 520         p->ofhooks = ofhooks;
 521         p->aux = aux;
 522         p->ml = NULL;
 523     } else {
 524         p->ofhooks = &default_ofhooks;
 525         p->aux = p;
 526         p->ml = mac_learning_create();
 527     }
 528
 529     /* Pick final datapath ID. */
 530     p->datapath_id = pick_datapath_id(p);
 531     VLOG_INFO("using datapath ID %016"PRIx64, p->datapath_id);
 532
 533     shash_add_once(&all_ofprotos, dpif_name(p->dpif), p);
 534
 535     *ofprotop = p;
 536     return 0;
 537 }
 538
 539 void
 540 ofproto_set_datapath_id(struct ofproto *p, uint64_t datapath_id)
 541 {
 542     uint64_t old_dpid = p->datapath_id;
 543     p->datapath_id = datapath_id ? datapath_id : pick_datapath_id(p);
 544     if (p->datapath_id != old_dpid) {
 545         VLOG_INFO("datapath ID changed to %016"PRIx64, p->datapath_id);
 546
 547         /* Force all active connections to reconnect, since there is no way to
 548          * notify a controller that the datapath ID has changed. */
 549         ofproto_reconnect_controllers(p);
 550     }
 551 }
 552
 553 static bool
 554 is_discovery_controller(const struct ofproto_controller *c)
 555 {
 556     return !strcmp(c->target, "discover");
 557 }
 558
 559 static bool
 560 is_in_band_controller(const struct ofproto_controller *c)
 561 {
 562     return is_discovery_controller(c) || c->band == OFPROTO_IN_BAND;
 563 }
 564
 565 /* Creates a new controller in 'ofproto'.  Some of the settings are initially
 566  * drawn from 'c', but update_controller() needs to be called later to finish
 567  * the new ofconn's configuration. */
 568 static void
 569 add_controller(struct ofproto *ofproto, const struct ofproto_controller *c)
 570 {
 571     struct discovery *discovery;
 572     struct ofconn *ofconn;
 573
 574     if (is_discovery_controller(c)) {
 575         int error = discovery_create(c->accept_re, c->update_resolv_conf,
 576                                      ofproto->dpif, ofproto->switch_status,
 577                                      &discovery);
 578         if (error) {
 579             return;
 580         }
 581     } else {
 582         discovery = NULL;
 583     }
 584
 585     ofconn = ofconn_create(ofproto, rconn_create(5, 8), OFCONN_PRIMARY);
 586     ofconn->pktbuf = pktbuf_create();
 587     ofconn->miss_send_len = OFP_DEFAULT_MISS_SEND_LEN;
 588     if (discovery) {
 589         ofconn->discovery = discovery;
 590     } else {
 591         char *name = ofconn_make_name(ofproto, c->target);
 592         rconn_connect(ofconn->rconn, c->target, name);
 593         free(name);
 594     }
 595     hmap_insert(&ofproto->controllers, &ofconn->hmap_node,
 596                 hash_string(c->target, 0));
 597 }
 598
 599 /* Reconfigures 'ofconn' to match 'c'.  This function cannot update an ofconn's
 600  * target or turn discovery on or off (these are done by creating new ofconns
 601  * and deleting old ones), but it can update the rest of an ofconn's
 602  * settings. */
 603 static void
 604 update_controller(struct ofconn *ofconn, const struct ofproto_controller *c)
 605 {
 606     int probe_interval;
 607
 608     ofconn->band = (is_in_band_controller(c)
 609                     ? OFPROTO_IN_BAND : OFPROTO_OUT_OF_BAND);
 610
 611     rconn_set_max_backoff(ofconn->rconn, c->max_backoff);
 612
 613     probe_interval = c->probe_interval ? MAX(c->probe_interval, 5) : 0;
 614     rconn_set_probe_interval(ofconn->rconn, probe_interval);
 615
 616     if (ofconn->discovery) {
 617         discovery_set_update_resolv_conf(ofconn->discovery,
 618                                          c->update_resolv_conf);
 619         discovery_set_accept_controller_re(ofconn->discovery, c->accept_re);
 620     }
 621
 622     ofconn_set_rate_limit(ofconn, c->rate_limit, c->burst_limit);
 623 }
 624
 625 static const char *
 626 ofconn_get_target(const struct ofconn *ofconn)
 627 {
 628     return ofconn->discovery ? "discover" : rconn_get_target(ofconn->rconn);
 629 }
 630
 631 static struct ofconn *
 632 find_controller_by_target(struct ofproto *ofproto, const char *target)
 633 {
 634     struct ofconn *ofconn;
 635
 636     HMAP_FOR_EACH_WITH_HASH (ofconn, hmap_node,
 637                              hash_string(target, 0), &ofproto->controllers) {
 638         if (!strcmp(ofconn_get_target(ofconn), target)) {
 639             return ofconn;
 640         }
 641     }
 642     return NULL;
 643 }
 644
 645 static void
 646 update_in_band_remotes(struct ofproto *ofproto)
 647 {
 648     const struct ofconn *ofconn;
 649     struct sockaddr_in *addrs;
 650     size_t max_addrs, n_addrs;
 651     bool discovery;
 652     size_t i;
 653
 654     /* Allocate enough memory for as many remotes as we could possibly have. */
 655     max_addrs = ofproto->n_extra_remotes + hmap_count(&ofproto->controllers);
 656     addrs = xmalloc(max_addrs * sizeof *addrs);
 657     n_addrs = 0;
 658
 659     /* Add all the remotes. */
 660     discovery = false;
 661     HMAP_FOR_EACH (ofconn, hmap_node, &ofproto->controllers) {
 662         struct sockaddr_in *sin = &addrs[n_addrs];
 663
 664         if (ofconn->band == OFPROTO_OUT_OF_BAND) {
 665             continue;
 666         }
 667
 668         sin->sin_addr.s_addr = rconn_get_remote_ip(ofconn->rconn);
 669         if (sin->sin_addr.s_addr) {
 670             sin->sin_port = rconn_get_remote_port(ofconn->rconn);
 671             n_addrs++;
 672         }
 673         if (ofconn->discovery) {
 674             discovery = true;
 675         }
 676     }
 677     for (i = 0; i < ofproto->n_extra_remotes; i++) {
 678         addrs[n_addrs++] = ofproto->extra_in_band_remotes[i];
 679     }
 680
 681     /* Create or update or destroy in-band.
 682      *
 683      * Ordinarily we only enable in-band if there's at least one remote
 684      * address, but discovery needs the in-band rules for DHCP to be installed
 685      * even before we know any remote addresses. */
 686     if (n_addrs || discovery) {
 687         if (!ofproto->in_band) {
 688             in_band_create(ofproto, ofproto->dpif, ofproto->switch_status,
 689                            &ofproto->in_band);
 690         }
 691         if (ofproto->in_band) {
 692             in_band_set_remotes(ofproto->in_band, addrs, n_addrs);
 693         }
 694         in_band_set_queue(ofproto->in_band, ofproto->in_band_queue);
 695         ofproto->next_in_band_update = time_msec() + 1000;
 696     } else {
 697         in_band_destroy(ofproto->in_band);
 698         ofproto->in_band = NULL;
 699     }
 700
 701     /* Clean up. */
 702     free(addrs);
 703 }
 704
 705 static void
 706 update_fail_open(struct ofproto *p)
 707 {
 708     struct ofconn *ofconn;
 709
 710     if (!hmap_is_empty(&p->controllers)
 711             && p->fail_mode == OFPROTO_FAIL_STANDALONE) {
 712         struct rconn **rconns;
 713         size_t n;
 714
 715         if (!p->fail_open) {
 716             p->fail_open = fail_open_create(p, p->switch_status);
 717         }
 718
 719         n = 0;
 720         rconns = xmalloc(hmap_count(&p->controllers) * sizeof *rconns);
 721         HMAP_FOR_EACH (ofconn, hmap_node, &p->controllers) {
 722             rconns[n++] = ofconn->rconn;
 723         }
 724
 725         fail_open_set_controllers(p->fail_open, rconns, n);
 726         /* p->fail_open takes ownership of 'rconns'. */
 727     } else {
 728         fail_open_destroy(p->fail_open);
 729         p->fail_open = NULL;
 730     }
 731 }
 732
 733 void
 734 ofproto_set_controllers(struct ofproto *p,
 735                         const struct ofproto_controller *controllers,
 736                         size_t n_controllers)
 737 {
 738     struct shash new_controllers;
 739     struct ofconn *ofconn, *next_ofconn;
 740     struct ofservice *ofservice, *next_ofservice;
 741     bool ss_exists;
 742     size_t i;
 743
 744     /* Create newly configured controllers and services.
 745      * Create a name to ofproto_controller mapping in 'new_controllers'. */
 746     shash_init(&new_controllers);
 747     for (i = 0; i < n_controllers; i++) {
 748         const struct ofproto_controller *c = &controllers[i];
 749
 750         if (!vconn_verify_name(c->target) || !strcmp(c->target, "discover")) {
 751             if (!find_controller_by_target(p, c->target)) {
 752                 add_controller(p, c);
 753             }
 754         } else if (!pvconn_verify_name(c->target)) {
 755             if (!ofservice_lookup(p, c->target) && ofservice_create(p, c)) {
 756                 continue;
 757             }
 758         } else {
 759             VLOG_WARN_RL(&rl, "%s: unsupported controller \"%s\"",
 760                          dpif_name(p->dpif), c->target);
 761             continue;
 762         }
 763
 764         shash_add_once(&new_controllers, c->target, &controllers[i]);
 765     }
 766
 767     /* Delete controllers that are no longer configured.
 768      * Update configuration of all now-existing controllers. */
 769     ss_exists = false;
 770     HMAP_FOR_EACH_SAFE (ofconn, next_ofconn, hmap_node, &p->controllers) {
 771         struct ofproto_controller *c;
 772
 773         c = shash_find_data(&new_controllers, ofconn_get_target(ofconn));
 774         if (!c) {
 775             ofconn_destroy(ofconn);
 776         } else {
 777             update_controller(ofconn, c);
 778             if (ofconn->ss) {
 779                 ss_exists = true;
 780             }
 781         }
 782     }
 783
 784     /* Delete services that are no longer configured.
 785      * Update configuration of all now-existing services. */
 786     HMAP_FOR_EACH_SAFE (ofservice, next_ofservice, node, &p->services) {
 787         struct ofproto_controller *c;
 788
 789         c = shash_find_data(&new_controllers,
 790                             pvconn_get_name(ofservice->pvconn));
 791         if (!c) {
 792             ofservice_destroy(p, ofservice);
 793         } else {
 794             ofservice_reconfigure(ofservice, c);
 795         }
 796     }
 797
 798     shash_destroy(&new_controllers);
 799
 800     update_in_band_remotes(p);
 801     update_fail_open(p);
 802
 803     if (!hmap_is_empty(&p->controllers) && !ss_exists) {
 804         ofconn = CONTAINER_OF(hmap_first(&p->controllers),
 805                               struct ofconn, hmap_node);
 806         ofconn->ss = switch_status_register(p->switch_status, "remote",
 807                                             rconn_status_cb, ofconn->rconn);
 808     }
 809 }
 810
 811 void
 812 ofproto_set_fail_mode(struct ofproto *p, enum ofproto_fail_mode fail_mode)
 813 {
 814     p->fail_mode = fail_mode;
 815     update_fail_open(p);
 816 }
 817
 818 /* Drops the connections between 'ofproto' and all of its controllers, forcing
 819  * them to reconnect. */
 820 void
 821 ofproto_reconnect_controllers(struct ofproto *ofproto)
 822 {
 823     struct ofconn *ofconn;
 824
 825     LIST_FOR_EACH (ofconn, node, &ofproto->all_conns) {
 826         rconn_reconnect(ofconn->rconn);
 827     }
 828 }
 829
 830 static bool
 831 any_extras_changed(const struct ofproto *ofproto,
 832                    const struct sockaddr_in *extras, size_t n)
 833 {
 834     size_t i;
 835
 836     if (n != ofproto->n_extra_remotes) {
 837         return true;
 838     }
 839
 840     for (i = 0; i < n; i++) {
 841         const struct sockaddr_in *old = &ofproto->extra_in_band_remotes[i];
 842         const struct sockaddr_in *new = &extras[i];
 843
 844         if (old->sin_addr.s_addr != new->sin_addr.s_addr ||
 845             old->sin_port != new->sin_port) {
 846             return true;
 847         }
 848     }
 849
 850     return false;
 851 }
 852
 853 /* Sets the 'n' TCP port addresses in 'extras' as ones to which 'ofproto''s
 854  * in-band control should guarantee access, in the same way that in-band
 855  * control guarantees access to OpenFlow controllers. */
 856 void
 857 ofproto_set_extra_in_band_remotes(struct ofproto *ofproto,
 858                                   const struct sockaddr_in *extras, size_t n)
 859 {
 860     if (!any_extras_changed(ofproto, extras, n)) {
 861         return;
 862     }
 863
 864     free(ofproto->extra_in_band_remotes);
 865     ofproto->n_extra_remotes = n;
 866     ofproto->extra_in_band_remotes = xmemdup(extras, n * sizeof *extras);
 867
 868     update_in_band_remotes(ofproto);
 869 }
 870
 871 /* Sets the OpenFlow queue used by flows set up by in-band control on
 872  * 'ofproto' to 'queue_id'.  If 'queue_id' is negative, then in-band control
 873  * flows will use the default queue. */
 874 void
 875 ofproto_set_in_band_queue(struct ofproto *ofproto, int queue_id)
 876 {
 877     if (queue_id != ofproto->in_band_queue) {
 878         ofproto->in_band_queue = queue_id;
 879         update_in_band_remotes(ofproto);
 880     }
 881 }
 882
 883 void
 884 ofproto_set_desc(struct ofproto *p,
 885                  const char *mfr_desc, const char *hw_desc,
 886                  const char *sw_desc, const char *serial_desc,
 887                  const char *dp_desc)
 888 {
 889     struct ofp_desc_stats *ods;
 890
 891     if (mfr_desc) {
 892         if (strlen(mfr_desc) >= sizeof ods->mfr_desc) {
 893             VLOG_WARN("truncating mfr_desc, must be less than %zu characters",
 894                     sizeof ods->mfr_desc);
 895         }
 896         free(p->mfr_desc);
 897         p->mfr_desc = xstrdup(mfr_desc);
 898     }
 899     if (hw_desc) {
 900         if (strlen(hw_desc) >= sizeof ods->hw_desc) {
 901             VLOG_WARN("truncating hw_desc, must be less than %zu characters",
 902                     sizeof ods->hw_desc);
 903         }
 904         free(p->hw_desc);
 905         p->hw_desc = xstrdup(hw_desc);
 906     }
 907     if (sw_desc) {
 908         if (strlen(sw_desc) >= sizeof ods->sw_desc) {
 909             VLOG_WARN("truncating sw_desc, must be less than %zu characters",
 910                     sizeof ods->sw_desc);
 911         }
 912         free(p->sw_desc);
 913         p->sw_desc = xstrdup(sw_desc);
 914     }
 915     if (serial_desc) {
 916         if (strlen(serial_desc) >= sizeof ods->serial_num) {
 917             VLOG_WARN("truncating serial_desc, must be less than %zu "
 918                     "characters",
 919                     sizeof ods->serial_num);
 920         }
 921         free(p->serial_desc);
 922         p->serial_desc = xstrdup(serial_desc);
 923     }
 924     if (dp_desc) {
 925         if (strlen(dp_desc) >= sizeof ods->dp_desc) {
 926             VLOG_WARN("truncating dp_desc, must be less than %zu characters",
 927                     sizeof ods->dp_desc);
 928         }
 929         free(p->dp_desc);
 930         p->dp_desc = xstrdup(dp_desc);
 931     }
 932 }
 933
 934 static int
 935 set_pvconns(struct pvconn ***pvconnsp, size_t *n_pvconnsp,
 936             const struct svec *svec)
 937 {
 938     struct pvconn **pvconns = *pvconnsp;
 939     size_t n_pvconns = *n_pvconnsp;
 940     int retval = 0;
 941     size_t i;
 942
 943     for (i = 0; i < n_pvconns; i++) {
 944         pvconn_close(pvconns[i]);
 945     }
 946     free(pvconns);
 947
 948     pvconns = xmalloc(svec->n * sizeof *pvconns);
 949     n_pvconns = 0;
 950     for (i = 0; i < svec->n; i++) {
 951         const char *name = svec->names[i];
 952         struct pvconn *pvconn;
 953         int error;
 954
 955         error = pvconn_open(name, &pvconn);
 956         if (!error) {
 957             pvconns[n_pvconns++] = pvconn;
 958         } else {
 959             VLOG_ERR("failed to listen on %s: %s", name, strerror(error));
 960             if (!retval) {
 961                 retval = error;
 962             }
 963         }
 964     }
 965
 966     *pvconnsp = pvconns;
 967     *n_pvconnsp = n_pvconns;
 968
 969     return retval;
 970 }
 971
 972 int
 973 ofproto_set_snoops(struct ofproto *ofproto, const struct svec *snoops)
 974 {
 975     return set_pvconns(&ofproto->snoops, &ofproto->n_snoops, snoops);
 976 }
 977
 978 int
 979 ofproto_set_netflow(struct ofproto *ofproto,
 980                     const struct netflow_options *nf_options)
 981 {
 982     if (nf_options && nf_options->collectors.n) {
 983         if (!ofproto->netflow) {
 984             ofproto->netflow = netflow_create();
 985         }
 986         return netflow_set_options(ofproto->netflow, nf_options);
 987     } else {
 988         netflow_destroy(ofproto->netflow);
 989         ofproto->netflow = NULL;
 990         return 0;
 991     }
 992 }
 993
 994 void
 995 ofproto_set_sflow(struct ofproto *ofproto,
 996                   const struct ofproto_sflow_options *oso)
 997 {
 998     struct ofproto_sflow *os = ofproto->sflow;
 999     if (oso) {
1000         if (!os) {
1001             struct ofport *ofport;
1002
1003             os = ofproto->sflow = ofproto_sflow_create(ofproto->dpif);
1004             HMAP_FOR_EACH (ofport, hmap_node, &ofproto->ports) {
1005                 ofproto_sflow_add_port(os, ofport->odp_port,
1006                                        netdev_get_name(ofport->netdev));
1007             }
1008         }
1009         ofproto_sflow_set_options(os, oso);
1010     } else {
1011         ofproto_sflow_destroy(os);
1012         ofproto->sflow = NULL;
1013     }
1014 }
1015
1016 uint64_t
1017 ofproto_get_datapath_id(const struct ofproto *ofproto)
1018 {
1019     return ofproto->datapath_id;
1020 }
1021
1022 bool
1023 ofproto_has_primary_controller(const struct ofproto *ofproto)
1024 {
1025     return !hmap_is_empty(&ofproto->controllers);
1026 }
1027
1028 enum ofproto_fail_mode
1029 ofproto_get_fail_mode(const struct ofproto *p)
1030 {
1031     return p->fail_mode;
1032 }
1033
1034 void
1035 ofproto_get_snoops(const struct ofproto *ofproto, struct svec *snoops)
1036 {
1037     size_t i;
1038
1039     for (i = 0; i < ofproto->n_snoops; i++) {
1040         svec_add(snoops, pvconn_get_name(ofproto->snoops[i]));
1041     }
1042 }
1043
1044 void
1045 ofproto_destroy(struct ofproto *p)
1046 {
1047     struct ofservice *ofservice, *next_ofservice;
1048     struct ofconn *ofconn, *next_ofconn;
1049     struct ofport *ofport, *next_ofport;
1050     size_t i;
1051
1052     if (!p) {
1053         return;
1054     }
1055
1056     shash_find_and_delete(&all_ofprotos, dpif_name(p->dpif));
1057
1058     /* Destroy fail-open and in-band early, since they touch the classifier. */
1059     fail_open_destroy(p->fail_open);
1060     p->fail_open = NULL;
1061
1062     in_band_destroy(p->in_band);
1063     p->in_band = NULL;
1064     free(p->extra_in_band_remotes);
1065
1066     ofproto_flush_flows(p);
1067     classifier_destroy(&p->cls);
1068     hmap_destroy(&p->facets);
1069
1070     LIST_FOR_EACH_SAFE (ofconn, next_ofconn, node, &p->all_conns) {
1071         ofconn_destroy(ofconn);
1072     }
1073     hmap_destroy(&p->controllers);
1074
1075     dpif_close(p->dpif);
1076     netdev_monitor_destroy(p->netdev_monitor);
1077     HMAP_FOR_EACH_SAFE (ofport, next_ofport, hmap_node, &p->ports) {
1078         hmap_remove(&p->ports, &ofport->hmap_node);
1079         ofport_free(ofport);
1080     }
1081     shash_destroy(&p->port_by_name);
1082
1083     switch_status_destroy(p->switch_status);
1084     netflow_destroy(p->netflow);
1085     ofproto_sflow_destroy(p->sflow);
1086
1087     HMAP_FOR_EACH_SAFE (ofservice, next_ofservice, node, &p->services) {
1088         ofservice_destroy(p, ofservice);
1089     }
1090     hmap_destroy(&p->services);
1091
1092     for (i = 0; i < p->n_snoops; i++) {
1093         pvconn_close(p->snoops[i]);
1094     }
1095     free(p->snoops);
1096
1097     mac_learning_destroy(p->ml);
1098
1099     free(p->mfr_desc);
1100     free(p->hw_desc);
1101     free(p->sw_desc);
1102     free(p->serial_desc);
1103     free(p->dp_desc);
1104
1105     hmap_destroy(&p->ports);
1106
1107     free(p);
1108 }
1109
1110 int
1111 ofproto_run(struct ofproto *p)
1112 {
1113     int error = ofproto_run1(p);
1114     if (!error) {
1115         error = ofproto_run2(p, false);
1116     }
1117     return error;
1118 }
1119
1120 static void
1121 process_port_change(struct ofproto *ofproto, int error, char *devname)
1122 {
1123     if (error == ENOBUFS) {
1124         reinit_ports(ofproto);
1125     } else if (!error) {
1126         update_port(ofproto, devname);
1127         free(devname);
1128     }
1129 }
1130
1131 /* Returns a "preference level" for snooping 'ofconn'.  A higher return value
1132  * means that 'ofconn' is more interesting for monitoring than a lower return
1133  * value. */
1134 static int
1135 snoop_preference(const struct ofconn *ofconn)
1136 {
1137     switch (ofconn->role) {
1138     case NX_ROLE_MASTER:
1139         return 3;
1140     case NX_ROLE_OTHER:
1141         return 2;
1142     case NX_ROLE_SLAVE:
1143         return 1;
1144     default:
1145         /* Shouldn't happen. */
1146         return 0;
1147     }
1148 }
1149
1150 /* One of ofproto's "snoop" pvconns has accepted a new connection on 'vconn'.
1151  * Connects this vconn to a controller. */
1152 static void
1153 add_snooper(struct ofproto *ofproto, struct vconn *vconn)
1154 {
1155     struct ofconn *ofconn, *best;
1156
1157     /* Pick a controller for monitoring. */
1158     best = NULL;
1159     LIST_FOR_EACH (ofconn, node, &ofproto->all_conns) {
1160         if (ofconn->type == OFCONN_PRIMARY
1161             && (!best || snoop_preference(ofconn) > snoop_preference(best))) {
1162             best = ofconn;
1163         }
1164     }
1165
1166     if (best) {
1167         rconn_add_monitor(best->rconn, vconn);
1168     } else {
1169         VLOG_INFO_RL(&rl, "no controller connection to snoop");
1170         vconn_close(vconn);
1171     }
1172 }
1173
1174 int
1175 ofproto_run1(struct ofproto *p)
1176 {
1177     struct ofconn *ofconn, *next_ofconn;
1178     struct ofservice *ofservice;
1179     char *devname;
1180     int error;
1181     int i;
1182
1183     if (shash_is_empty(&p->port_by_name)) {
1184         init_ports(p);
1185     }
1186
1187     for (i = 0; i < 50; i++) {
1188         struct dpif_upcall packet;
1189
1190         error = dpif_recv(p->dpif, &packet);
1191         if (error) {
1192             if (error == ENODEV) {
1193                 /* Someone destroyed the datapath behind our back.  The caller
1194                  * better destroy us and give up, because we're just going to
1195                  * spin from here on out. */
1196                 static struct vlog_rate_limit rl2 = VLOG_RATE_LIMIT_INIT(1, 5);
1197                 VLOG_ERR_RL(&rl2, "%s: datapath was destroyed externally",
1198                             dpif_name(p->dpif));
1199                 return ENODEV;
1200             }
1201             break;
1202         }
1203
1204         handle_upcall(p, &packet);
1205     }
1206
1207     while ((error = dpif_port_poll(p->dpif, &devname)) != EAGAIN) {
1208         process_port_change(p, error, devname);
1209     }
1210     while ((error = netdev_monitor_poll(p->netdev_monitor,
1211                                         &devname)) != EAGAIN) {
1212         process_port_change(p, error, devname);
1213     }
1214
1215     if (p->in_band) {
1216         if (time_msec() >= p->next_in_band_update) {
1217             update_in_band_remotes(p);
1218         }
1219         in_band_run(p->in_band);
1220     }
1221
1222     LIST_FOR_EACH_SAFE (ofconn, next_ofconn, node, &p->all_conns) {
1223         ofconn_run(ofconn);
1224     }
1225
1226     /* Fail-open maintenance.  Do this after processing the ofconns since
1227      * fail-open checks the status of the controller rconn. */
1228     if (p->fail_open) {
1229         fail_open_run(p->fail_open);
1230     }
1231
1232     HMAP_FOR_EACH (ofservice, node, &p->services) {
1233         struct vconn *vconn;
1234         int retval;
1235
1236         retval = pvconn_accept(ofservice->pvconn, OFP_VERSION, &vconn);
1237         if (!retval) {
1238             struct rconn *rconn;
1239             char *name;
1240
1241             rconn = rconn_create(ofservice->probe_interval, 0);
1242             name = ofconn_make_name(p, vconn_get_name(vconn));
1243             rconn_connect_unreliably(rconn, vconn, name);
1244             free(name);
1245
1246             ofconn = ofconn_create(p, rconn, OFCONN_SERVICE);
1247             ofconn_set_rate_limit(ofconn, ofservice->rate_limit,
1248                                   ofservice->burst_limit);
1249         } else if (retval != EAGAIN) {
1250             VLOG_WARN_RL(&rl, "accept failed (%s)", strerror(retval));
1251         }
1252     }
1253
1254     for (i = 0; i < p->n_snoops; i++) {
1255         struct vconn *vconn;
1256         int retval;
1257
1258         retval = pvconn_accept(p->snoops[i], OFP_VERSION, &vconn);
1259         if (!retval) {
1260             add_snooper(p, vconn);
1261         } else if (retval != EAGAIN) {
1262             VLOG_WARN_RL(&rl, "accept failed (%s)", strerror(retval));
1263         }
1264     }
1265
1266     if (time_msec() >= p->next_expiration) {
1267         int delay = ofproto_expire(p);
1268         p->next_expiration = time_msec() + delay;
1269         COVERAGE_INC(ofproto_expiration);
1270     }
1271
1272     if (p->netflow) {
1273         netflow_run(p->netflow);
1274     }
1275     if (p->sflow) {
1276         ofproto_sflow_run(p->sflow);
1277     }
1278
1279     return 0;
1280 }
1281
1282 int
1283 ofproto_run2(struct ofproto *p, bool revalidate_all)
1284 {
1285     /* Figure out what we need to revalidate now, if anything. */
1286     struct tag_set revalidate_set = p->revalidate_set;
1287     if (p->need_revalidate) {
1288         revalidate_all = true;
1289     }
1290
1291     /* Clear the revalidation flags. */
1292     tag_set_init(&p->revalidate_set);
1293     p->need_revalidate = false;
1294
1295     /* Now revalidate if there's anything to do. */
1296     if (revalidate_all || !tag_set_is_empty(&revalidate_set)) {
1297         struct facet *facet, *next;
1298
1299         HMAP_FOR_EACH_SAFE (facet, next, hmap_node, &p->facets) {
1300             if (revalidate_all
1301                 || tag_set_intersects(&revalidate_set, facet->tags)) {
1302                 facet_revalidate(p, facet);
1303             }
1304         }
1305     }
1306
1307     return 0;
1308 }
1309
1310 void
1311 ofproto_wait(struct ofproto *p)
1312 {
1313     struct ofservice *ofservice;
1314     struct ofconn *ofconn;
1315     size_t i;
1316
1317     dpif_recv_wait(p->dpif);
1318     dpif_port_poll_wait(p->dpif);
1319     netdev_monitor_poll_wait(p->netdev_monitor);
1320     LIST_FOR_EACH (ofconn, node, &p->all_conns) {
1321         ofconn_wait(ofconn);
1322     }
1323     if (p->in_band) {
1324         poll_timer_wait_until(p->next_in_band_update);
1325         in_band_wait(p->in_band);
1326     }
1327     if (p->fail_open) {
1328         fail_open_wait(p->fail_open);
1329     }
1330     if (p->sflow) {
1331         ofproto_sflow_wait(p->sflow);
1332     }
1333     if (!tag_set_is_empty(&p->revalidate_set)) {
1334         poll_immediate_wake();
1335     }
1336     if (p->need_revalidate) {
1337         /* Shouldn't happen, but if it does just go around again. */
1338         VLOG_DBG_RL(&rl, "need revalidate in ofproto_wait_cb()");
1339         poll_immediate_wake();
1340     } else if (p->next_expiration != LLONG_MAX) {
1341         poll_timer_wait_until(p->next_expiration);
1342     }
1343     HMAP_FOR_EACH (ofservice, node, &p->services) {
1344         pvconn_wait(ofservice->pvconn);
1345     }
1346     for (i = 0; i < p->n_snoops; i++) {
1347         pvconn_wait(p->snoops[i]);
1348     }
1349 }
1350
1351 void
1352 ofproto_revalidate(struct ofproto *ofproto, tag_type tag)
1353 {
1354     tag_set_add(&ofproto->revalidate_set, tag);
1355 }
1356
1357 struct tag_set *
1358 ofproto_get_revalidate_set(struct ofproto *ofproto)
1359 {
1360     return &ofproto->revalidate_set;
1361 }
1362
1363 bool
1364 ofproto_is_alive(const struct ofproto *p)
1365 {
1366     return !hmap_is_empty(&p->controllers);
1367 }
1368
1369 void
1370 ofproto_get_ofproto_controller_info(const struct ofproto * ofproto,
1371                                     struct shash *info)
1372 {
1373     const struct ofconn *ofconn;
1374
1375     shash_init(info);
1376
1377     HMAP_FOR_EACH (ofconn, hmap_node, &ofproto->controllers) {
1378         const struct rconn *rconn = ofconn->rconn;
1379         const int last_error = rconn_get_last_error(rconn);
1380         struct ofproto_controller_info *cinfo = xmalloc(sizeof *cinfo);
1381
1382         shash_add(info, rconn_get_target(rconn), cinfo);
1383
1384         cinfo->is_connected = rconn_is_connected(rconn);
1385         cinfo->role = ofconn->role;
1386
1387         cinfo->pairs.n = 0;
1388
1389         if (last_error) {
1390             cinfo->pairs.keys[cinfo->pairs.n] = "last_error";
1391             cinfo->pairs.values[cinfo->pairs.n++] =
1392                 xstrdup(ovs_retval_to_string(last_error));
1393         }
1394
1395         cinfo->pairs.keys[cinfo->pairs.n] = "state";
1396         cinfo->pairs.values[cinfo->pairs.n++] =
1397             xstrdup(rconn_get_state(rconn));
1398
1399         if (rconn_is_admitted(rconn)) {
1400             cinfo->pairs.keys[cinfo->pairs.n] = "time_connected";
1401             cinfo->pairs.values[cinfo->pairs.n++] =
1402                 xasprintf("%ld", time_now() - rconn_get_last_connection(rconn));
1403         } else {
1404             cinfo->pairs.keys[cinfo->pairs.n] = "time_disconnected";
1405             cinfo->pairs.values[cinfo->pairs.n++] =
1406                 xasprintf("%d", rconn_failure_duration(rconn));
1407         }
1408     }
1409 }
1410
1411 void
1412 ofproto_free_ofproto_controller_info(struct shash *info)
1413 {
1414     struct shash_node *node;
1415
1416     SHASH_FOR_EACH (node, info) {
1417         struct ofproto_controller_info *cinfo = node->data;
1418         while (cinfo->pairs.n) {
1419             free((char *) cinfo->pairs.values[--cinfo->pairs.n]);
1420         }
1421         free(cinfo);
1422     }
1423     shash_destroy(info);
1424 }
1425
1426 /* Deletes port number 'odp_port' from the datapath for 'ofproto'.
1427  *
1428  * This is almost the same as calling dpif_port_del() directly on the
1429  * datapath, but it also makes 'ofproto' close its open netdev for the port
1430  * (if any).  This makes it possible to create a new netdev of a different
1431  * type under the same name, which otherwise the netdev library would refuse
1432  * to do because of the conflict.  (The netdev would eventually get closed on
1433  * the next trip through ofproto_run(), but this interface is more direct.)
1434  *
1435  * Returns 0 if successful, otherwise a positive errno. */
1436 int
1437 ofproto_port_del(struct ofproto *ofproto, uint16_t odp_port)
1438 {
1439     struct ofport *ofport = get_port(ofproto, odp_port);
1440     const char *name = ofport ? ofport->opp.name : "<unknown>";
1441     int error;
1442
1443     error = dpif_port_del(ofproto->dpif, odp_port);
1444     if (error) {
1445         VLOG_ERR("%s: failed to remove port %"PRIu16" (%s) interface (%s)",
1446                  dpif_name(ofproto->dpif), odp_port, name, strerror(error));
1447     } else if (ofport) {
1448         /* 'name' is ofport->opp.name and update_port() is going to destroy
1449          * 'ofport'.  Just in case update_port() refers to 'name' after it
1450          * destroys 'ofport', make a copy of it around the update_port()
1451          * call. */
1452         char *devname = xstrdup(name);
1453         update_port(ofproto, devname);
1454         free(devname);
1455     }
1456     return error;
1457 }
1458
1459 /* Checks if 'ofproto' thinks 'odp_port' should be included in floods.  Returns
1460  * true if 'odp_port' exists and should be included, false otherwise. */
1461 bool
1462 ofproto_port_is_floodable(struct ofproto *ofproto, uint16_t odp_port)
1463 {
1464     struct ofport *ofport = get_port(ofproto, odp_port);
1465     return ofport && !(ofport->opp.config & OFPPC_NO_FLOOD);
1466 }
1467
1468 int
1469 ofproto_send_packet(struct ofproto *p, const struct flow *flow,
1470                     const union ofp_action *actions, size_t n_actions,
1471                     const struct ofpbuf *packet)
1472 {
1473     struct action_xlate_ctx ctx;
1474     struct ofpbuf *odp_actions;
1475
1476     action_xlate_ctx_init(&ctx, p, flow, packet);
1477     /* Always xlate packets originated in this function. */
1478     ctx.check_special = false;
1479     odp_actions = xlate_actions(&ctx, actions, n_actions);
1480
1481     /* XXX Should we translate the dpif_execute() errno value into an OpenFlow
1482      * error code? */
1483     dpif_execute(p->dpif, odp_actions->data, odp_actions->size, packet);
1484
1485     ofpbuf_delete(odp_actions);
1486
1487     return 0;
1488 }
1489
1490 /* Adds a flow to the OpenFlow flow table in 'p' that matches 'cls_rule' and
1491  * performs the 'n_actions' actions in 'actions'.  The new flow will not
1492  * timeout.
1493  *
1494  * If cls_rule->priority is in the range of priorities supported by OpenFlow
1495  * (0...65535, inclusive) then the flow will be visible to OpenFlow
1496  * controllers; otherwise, it will be hidden.
1497  *
1498  * The caller retains ownership of 'cls_rule' and 'actions'. */
1499 void
1500 ofproto_add_flow(struct ofproto *p, const struct cls_rule *cls_rule,
1501                  const union ofp_action *actions, size_t n_actions)
1502 {
1503     struct rule *rule;
1504     rule = rule_create(cls_rule, actions, n_actions, 0, 0, 0, false);
1505     rule_insert(p, rule);
1506 }
1507
1508 void
1509 ofproto_delete_flow(struct ofproto *ofproto, const struct cls_rule *target)
1510 {
1511     struct rule *rule;
1512
1513     rule = rule_from_cls_rule(classifier_find_rule_exactly(&ofproto->cls,
1514                                                            target));
1515     if (rule) {
1516         rule_remove(ofproto, rule);
1517     }
1518 }
1519
1520 void
1521 ofproto_flush_flows(struct ofproto *ofproto)
1522 {
1523     struct facet *facet, *next_facet;
1524     struct rule *rule, *next_rule;
1525     struct cls_cursor cursor;
1526
1527     COVERAGE_INC(ofproto_flush);
1528
1529     HMAP_FOR_EACH_SAFE (facet, next_facet, hmap_node, &ofproto->facets) {
1530         /* Mark the facet as not installed so that facet_remove() doesn't
1531          * bother trying to uninstall it.  There is no point in uninstalling it
1532          * individually since we are about to blow away all the facets with
1533          * dpif_flow_flush(). */
1534         facet->installed = false;
1535         facet->dp_packet_count = 0;
1536         facet->dp_byte_count = 0;
1537         facet_remove(ofproto, facet);
1538     }
1539
1540     cls_cursor_init(&cursor, &ofproto->cls, NULL);
1541     CLS_CURSOR_FOR_EACH_SAFE (rule, next_rule, cr, &cursor) {
1542         rule_remove(ofproto, rule);
1543     }
1544
1545     dpif_flow_flush(ofproto->dpif);
1546     if (ofproto->in_band) {
1547         in_band_flushed(ofproto->in_band);
1548     }
1549     if (ofproto->fail_open) {
1550         fail_open_flushed(ofproto->fail_open);
1551     }
1552 }
1553 \f
1554 static void
1555 reinit_ports(struct ofproto *p)
1556 {
1557     struct dpif_port_dump dump;
1558     struct shash_node *node;
1559     struct shash devnames;
1560     struct ofport *ofport;
1561     struct dpif_port dpif_port;
1562
1563     COVERAGE_INC(ofproto_reinit_ports);
1564
1565     shash_init(&devnames);
1566     HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1567         shash_add_once (&devnames, ofport->opp.name, NULL);
1568     }
1569     DPIF_PORT_FOR_EACH (&dpif_port, &dump, p->dpif) {
1570         shash_add_once (&devnames, dpif_port.name, NULL);
1571     }
1572
1573     SHASH_FOR_EACH (node, &devnames) {
1574         update_port(p, node->name);
1575     }
1576     shash_destroy(&devnames);
1577 }
1578
1579 static struct ofport *
1580 make_ofport(const struct dpif_port *dpif_port)
1581 {
1582     struct netdev_options netdev_options;
1583     enum netdev_flags flags;
1584     struct ofport *ofport;
1585     struct netdev *netdev;
1586     int error;
1587
1588     memset(&netdev_options, 0, sizeof netdev_options);
1589     netdev_options.name = dpif_port->name;
1590     netdev_options.type = dpif_port->type;
1591     netdev_options.ethertype = NETDEV_ETH_TYPE_NONE;
1592
1593     error = netdev_open(&netdev_options, &netdev);
1594     if (error) {
1595         VLOG_WARN_RL(&rl, "ignoring port %s (%"PRIu16") because netdev %s "
1596                      "cannot be opened (%s)",
1597                      dpif_port->name, dpif_port->port_no,
1598                      dpif_port->name, strerror(error));
1599         return NULL;
1600     }
1601
1602     ofport = xzalloc(sizeof *ofport);
1603     ofport->netdev = netdev;
1604     ofport->odp_port = dpif_port->port_no;
1605     ofport->opp.port_no = odp_port_to_ofp_port(dpif_port->port_no);
1606     netdev_get_etheraddr(netdev, ofport->opp.hw_addr);
1607     ovs_strlcpy(ofport->opp.name, dpif_port->name, sizeof ofport->opp.name);
1608
1609     netdev_get_flags(netdev, &flags);
1610     ofport->opp.config = flags & NETDEV_UP ? 0 : OFPPC_PORT_DOWN;
1611
1612     ofport->opp.state = netdev_get_carrier(netdev) ? 0 : OFPPS_LINK_DOWN;
1613
1614     netdev_get_features(netdev,
1615                         &ofport->opp.curr, &ofport->opp.advertised,
1616                         &ofport->opp.supported, &ofport->opp.peer);
1617     return ofport;
1618 }
1619
1620 static bool
1621 ofport_conflicts(const struct ofproto *p, const struct dpif_port *dpif_port)
1622 {
1623     if (get_port(p, dpif_port->port_no)) {
1624         VLOG_WARN_RL(&rl, "ignoring duplicate port %"PRIu16" in datapath",
1625                      dpif_port->port_no);
1626         return true;
1627     } else if (shash_find(&p->port_by_name, dpif_port->name)) {
1628         VLOG_WARN_RL(&rl, "ignoring duplicate device %s in datapath",
1629                      dpif_port->name);
1630         return true;
1631     } else {
1632         return false;
1633     }
1634 }
1635
1636 static int
1637 ofport_equal(const struct ofport *a_, const struct ofport *b_)
1638 {
1639     const struct ofp_phy_port *a = &a_->opp;
1640     const struct ofp_phy_port *b = &b_->opp;
1641
1642     BUILD_ASSERT_DECL(sizeof *a == 48); /* Detect ofp_phy_port changes. */
1643     return (a->port_no == b->port_no
1644             && !memcmp(a->hw_addr, b->hw_addr, sizeof a->hw_addr)
1645             && !strcmp(a->name, b->name)
1646             && a->state == b->state
1647             && a->config == b->config
1648             && a->curr == b->curr
1649             && a->advertised == b->advertised
1650             && a->supported == b->supported
1651             && a->peer == b->peer);
1652 }
1653
1654 static void
1655 send_port_status(struct ofproto *p, const struct ofport *ofport,
1656                  uint8_t reason)
1657 {
1658     /* XXX Should limit the number of queued port status change messages. */
1659     struct ofconn *ofconn;
1660     LIST_FOR_EACH (ofconn, node, &p->all_conns) {
1661         struct ofp_port_status *ops;
1662         struct ofpbuf *b;
1663
1664         /* Primary controllers, even slaves, should always get port status
1665            updates.  Otherwise obey ofconn_receives_async_msgs(). */
1666         if (ofconn->type != OFCONN_PRIMARY
1667             && !ofconn_receives_async_msgs(ofconn)) {
1668             continue;
1669         }
1670
1671         ops = make_openflow_xid(sizeof *ops, OFPT_PORT_STATUS, 0, &b);
1672         ops->reason = reason;
1673         ops->desc = ofport->opp;
1674         hton_ofp_phy_port(&ops->desc);
1675         queue_tx(b, ofconn, NULL);
1676     }
1677 }
1678
1679 static void
1680 ofport_install(struct ofproto *p, struct ofport *ofport)
1681 {
1682     const char *netdev_name = ofport->opp.name;
1683
1684     netdev_monitor_add(p->netdev_monitor, ofport->netdev);
1685     hmap_insert(&p->ports, &ofport->hmap_node, hash_int(ofport->odp_port, 0));
1686     shash_add(&p->port_by_name, netdev_name, ofport);
1687     if (p->sflow) {
1688         ofproto_sflow_add_port(p->sflow, ofport->odp_port, netdev_name);
1689     }
1690 }
1691
1692 static void
1693 ofport_remove(struct ofproto *p, struct ofport *ofport)
1694 {
1695     netdev_monitor_remove(p->netdev_monitor, ofport->netdev);
1696     hmap_remove(&p->ports, &ofport->hmap_node);
1697     shash_delete(&p->port_by_name,
1698                  shash_find(&p->port_by_name, ofport->opp.name));
1699     if (p->sflow) {
1700         ofproto_sflow_del_port(p->sflow, ofport->odp_port);
1701     }
1702 }
1703
1704 static void
1705 ofport_free(struct ofport *ofport)
1706 {
1707     if (ofport) {
1708         netdev_close(ofport->netdev);
1709         free(ofport);
1710     }
1711 }
1712
1713 static struct ofport *
1714 get_port(const struct ofproto *ofproto, uint16_t odp_port)
1715 {
1716     struct ofport *port;
1717
1718     HMAP_FOR_EACH_IN_BUCKET (port, hmap_node,
1719                              hash_int(odp_port, 0), &ofproto->ports) {
1720         if (port->odp_port == odp_port) {
1721             return port;
1722         }
1723     }
1724     return NULL;
1725 }
1726
1727 static void
1728 update_port(struct ofproto *p, const char *devname)
1729 {
1730     struct dpif_port dpif_port;
1731     struct ofport *old_ofport;
1732     struct ofport *new_ofport;
1733     int error;
1734
1735     COVERAGE_INC(ofproto_update_port);
1736
1737     /* Query the datapath for port information. */
1738     error = dpif_port_query_by_name(p->dpif, devname, &dpif_port);
1739
1740     /* Find the old ofport. */
1741     old_ofport = shash_find_data(&p->port_by_name, devname);
1742     if (!error) {
1743         if (!old_ofport) {
1744             /* There's no port named 'devname' but there might be a port with
1745              * the same port number.  This could happen if a port is deleted
1746              * and then a new one added in its place very quickly, or if a port
1747              * is renamed.  In the former case we want to send an OFPPR_DELETE
1748              * and an OFPPR_ADD, and in the latter case we want to send a
1749              * single OFPPR_MODIFY.  We can distinguish the cases by comparing
1750              * the old port's ifindex against the new port, or perhaps less
1751              * reliably but more portably by comparing the old port's MAC
1752              * against the new port's MAC.  However, this code isn't that smart
1753              * and always sends an OFPPR_MODIFY (XXX). */
1754             old_ofport = get_port(p, dpif_port.port_no);
1755         }
1756     } else if (error != ENOENT && error != ENODEV) {
1757         VLOG_WARN_RL(&rl, "dpif_port_query_by_name returned unexpected error "
1758                      "%s", strerror(error));
1759         goto exit;
1760     }
1761
1762     /* Create a new ofport. */
1763     new_ofport = !error ? make_ofport(&dpif_port) : NULL;
1764
1765     /* Eliminate a few pathological cases. */
1766     if (!old_ofport && !new_ofport) {
1767         goto exit;
1768     } else if (old_ofport && new_ofport) {
1769         /* Most of the 'config' bits are OpenFlow soft state, but
1770          * OFPPC_PORT_DOWN is maintained by the kernel.  So transfer the
1771          * OpenFlow bits from old_ofport.  (make_ofport() only sets
1772          * OFPPC_PORT_DOWN and leaves the other bits 0.)  */
1773         new_ofport->opp.config |= old_ofport->opp.config & ~OFPPC_PORT_DOWN;
1774
1775         if (ofport_equal(old_ofport, new_ofport)) {
1776             /* False alarm--no change. */
1777             ofport_free(new_ofport);
1778             goto exit;
1779         }
1780     }
1781
1782     /* Now deal with the normal cases. */
1783     if (old_ofport) {
1784         ofport_remove(p, old_ofport);
1785     }
1786     if (new_ofport) {
1787         ofport_install(p, new_ofport);
1788     }
1789     send_port_status(p, new_ofport ? new_ofport : old_ofport,
1790                      (!old_ofport ? OFPPR_ADD
1791                       : !new_ofport ? OFPPR_DELETE
1792                       : OFPPR_MODIFY));
1793     ofport_free(old_ofport);
1794
1795 exit:
1796     dpif_port_destroy(&dpif_port);
1797 }
1798
1799 static int
1800 init_ports(struct ofproto *p)
1801 {
1802     struct dpif_port_dump dump;
1803     struct dpif_port dpif_port;
1804
1805     DPIF_PORT_FOR_EACH (&dpif_port, &dump, p->dpif) {
1806         if (!ofport_conflicts(p, &dpif_port)) {
1807             struct ofport *ofport = make_ofport(&dpif_port);
1808             if (ofport) {
1809                 ofport_install(p, ofport);
1810             }
1811         }
1812     }
1813
1814     return 0;
1815 }
1816 \f
1817 static struct ofconn *
1818 ofconn_create(struct ofproto *p, struct rconn *rconn, enum ofconn_type type)
1819 {
1820     struct ofconn *ofconn = xzalloc(sizeof *ofconn);
1821     ofconn->ofproto = p;
1822     list_push_back(&p->all_conns, &ofconn->node);
1823     ofconn->rconn = rconn;
1824     ofconn->type = type;
1825     ofconn->flow_format = NXFF_OPENFLOW10;
1826     ofconn->role = NX_ROLE_OTHER;
1827     ofconn->packet_in_counter = rconn_packet_counter_create ();
1828     ofconn->pktbuf = NULL;
1829     ofconn->miss_send_len = 0;
1830     ofconn->reply_counter = rconn_packet_counter_create ();
1831     return ofconn;
1832 }
1833
1834 static void
1835 ofconn_destroy(struct ofconn *ofconn)
1836 {
1837     if (ofconn->type == OFCONN_PRIMARY) {
1838         hmap_remove(&ofconn->ofproto->controllers, &ofconn->hmap_node);
1839     }
1840     discovery_destroy(ofconn->discovery);
1841
1842     list_remove(&ofconn->node);
1843     switch_status_unregister(ofconn->ss);
1844     rconn_destroy(ofconn->rconn);
1845     rconn_packet_counter_destroy(ofconn->packet_in_counter);
1846     rconn_packet_counter_destroy(ofconn->reply_counter);
1847     pktbuf_destroy(ofconn->pktbuf);
1848     free(ofconn);
1849 }
1850
1851 static void
1852 ofconn_run(struct ofconn *ofconn)
1853 {
1854     struct ofproto *p = ofconn->ofproto;
1855     int iteration;
1856     size_t i;
1857
1858     if (ofconn->discovery) {
1859         char *controller_name;
1860         if (rconn_is_connectivity_questionable(ofconn->rconn)) {
1861             discovery_question_connectivity(ofconn->discovery);
1862         }
1863         if (discovery_run(ofconn->discovery, &controller_name)) {
1864             if (controller_name) {
1865                 char *ofconn_name = ofconn_make_name(p, controller_name);
1866                 rconn_connect(ofconn->rconn, controller_name, ofconn_name);
1867                 free(ofconn_name);
1868                 free(controller_name);
1869             } else {
1870                 rconn_disconnect(ofconn->rconn);
1871             }
1872         }
1873     }
1874
1875     for (i = 0; i < N_SCHEDULERS; i++) {
1876         pinsched_run(ofconn->schedulers[i], do_send_packet_in, ofconn);
1877     }
1878
1879     rconn_run(ofconn->rconn);
1880
1881     if (rconn_packet_counter_read (ofconn->reply_counter) < OFCONN_REPLY_MAX) {
1882         /* Limit the number of iterations to prevent other tasks from
1883          * starving. */
1884         for (iteration = 0; iteration < 50; iteration++) {
1885             struct ofpbuf *of_msg = rconn_recv(ofconn->rconn);
1886             if (!of_msg) {
1887                 break;
1888             }
1889             if (p->fail_open) {
1890                 fail_open_maybe_recover(p->fail_open);
1891             }
1892             handle_openflow(ofconn, of_msg);
1893             ofpbuf_delete(of_msg);
1894         }
1895     }
1896
1897     if (!ofconn->discovery && !rconn_is_alive(ofconn->rconn)) {
1898         ofconn_destroy(ofconn);
1899     }
1900 }
1901
1902 static void
1903 ofconn_wait(struct ofconn *ofconn)
1904 {
1905     int i;
1906
1907     if (ofconn->discovery) {
1908         discovery_wait(ofconn->discovery);
1909     }
1910     for (i = 0; i < N_SCHEDULERS; i++) {
1911         pinsched_wait(ofconn->schedulers[i]);
1912     }
1913     rconn_run_wait(ofconn->rconn);
1914     if (rconn_packet_counter_read (ofconn->reply_counter) < OFCONN_REPLY_MAX) {
1915         rconn_recv_wait(ofconn->rconn);
1916     } else {
1917         COVERAGE_INC(ofproto_ofconn_stuck);
1918     }
1919 }
1920
1921 /* Returns true if 'ofconn' should receive asynchronous messages. */
1922 static bool
1923 ofconn_receives_async_msgs(const struct ofconn *ofconn)
1924 {
1925     if (ofconn->type == OFCONN_PRIMARY) {
1926         /* Primary controllers always get asynchronous messages unless they
1927          * have configured themselves as "slaves".  */
1928         return ofconn->role != NX_ROLE_SLAVE;
1929     } else {
1930         /* Service connections don't get asynchronous messages unless they have
1931          * explicitly asked for them by setting a nonzero miss send length. */
1932         return ofconn->miss_send_len > 0;
1933     }
1934 }
1935
1936 /* Returns a human-readable name for an OpenFlow connection between 'ofproto'
1937  * and 'target', suitable for use in log messages for identifying the
1938  * connection.
1939  *
1940  * The name is dynamically allocated.  The caller should free it (with free())
1941  * when it is no longer needed. */
1942 static char *
1943 ofconn_make_name(const struct ofproto *ofproto, const char *target)
1944 {
1945     return xasprintf("%s<->%s", dpif_base_name(ofproto->dpif), target);
1946 }
1947
1948 static void
1949 ofconn_set_rate_limit(struct ofconn *ofconn, int rate, int burst)
1950 {
1951     int i;
1952
1953     for (i = 0; i < N_SCHEDULERS; i++) {
1954         struct pinsched **s = &ofconn->schedulers[i];
1955
1956         if (rate > 0) {
1957             if (!*s) {
1958                 *s = pinsched_create(rate, burst,
1959                                      ofconn->ofproto->switch_status);
1960             } else {
1961                 pinsched_set_limits(*s, rate, burst);
1962             }
1963         } else {
1964             pinsched_destroy(*s);
1965             *s = NULL;
1966         }
1967     }
1968 }
1969 \f
1970 static void
1971 ofservice_reconfigure(struct ofservice *ofservice,
1972                       const struct ofproto_controller *c)
1973 {
1974     ofservice->probe_interval = c->probe_interval;
1975     ofservice->rate_limit = c->rate_limit;
1976     ofservice->burst_limit = c->burst_limit;
1977 }
1978
1979 /* Creates a new ofservice in 'ofproto'.  Returns 0 if successful, otherwise a
1980  * positive errno value. */
1981 static int
1982 ofservice_create(struct ofproto *ofproto, const struct ofproto_controller *c)
1983 {
1984     struct ofservice *ofservice;
1985     struct pvconn *pvconn;
1986     int error;
1987
1988     error = pvconn_open(c->target, &pvconn);
1989     if (error) {
1990         return error;
1991     }
1992
1993     ofservice = xzalloc(sizeof *ofservice);
1994     hmap_insert(&ofproto->services, &ofservice->node,
1995                 hash_string(c->target, 0));
1996     ofservice->pvconn = pvconn;
1997
1998     ofservice_reconfigure(ofservice, c);
1999
2000     return 0;
2001 }
2002
2003 static void
2004 ofservice_destroy(struct ofproto *ofproto, struct ofservice *ofservice)
2005 {
2006     hmap_remove(&ofproto->services, &ofservice->node);
2007     pvconn_close(ofservice->pvconn);
2008     free(ofservice);
2009 }
2010
2011 /* Finds and returns the ofservice within 'ofproto' that has the given
2012  * 'target', or a null pointer if none exists. */
2013 static struct ofservice *
2014 ofservice_lookup(struct ofproto *ofproto, const char *target)
2015 {
2016     struct ofservice *ofservice;
2017
2018     HMAP_FOR_EACH_WITH_HASH (ofservice, node, hash_string(target, 0),
2019                              &ofproto->services) {
2020         if (!strcmp(pvconn_get_name(ofservice->pvconn), target)) {
2021             return ofservice;
2022         }
2023     }
2024     return NULL;
2025 }
2026 \f
2027 /* Returns true if 'rule' should be hidden from the controller.
2028  *
2029  * Rules with priority higher than UINT16_MAX are set up by ofproto itself
2030  * (e.g. by in-band control) and are intentionally hidden from the
2031  * controller. */
2032 static bool
2033 rule_is_hidden(const struct rule *rule)
2034 {
2035     return rule->cr.priority > UINT16_MAX;
2036 }
2037
2038 /* Creates and returns a new rule initialized as specified.
2039  *
2040  * The caller is responsible for inserting the rule into the classifier (with
2041  * rule_insert()). */
2042 static struct rule *
2043 rule_create(const struct cls_rule *cls_rule,
2044             const union ofp_action *actions, size_t n_actions,
2045             uint16_t idle_timeout, uint16_t hard_timeout,
2046             ovs_be64 flow_cookie, bool send_flow_removed)
2047 {
2048     struct rule *rule = xzalloc(sizeof *rule);
2049     rule->cr = *cls_rule;
2050     rule->idle_timeout = idle_timeout;
2051     rule->hard_timeout = hard_timeout;
2052     rule->flow_cookie = flow_cookie;
2053     rule->used = rule->created = time_msec();
2054     rule->send_flow_removed = send_flow_removed;
2055     list_init(&rule->facets);
2056     if (n_actions > 0) {
2057         rule->n_actions = n_actions;
2058         rule->actions = xmemdup(actions, n_actions * sizeof *actions);
2059     }
2060
2061     return rule;
2062 }
2063
2064 static struct rule *
2065 rule_from_cls_rule(const struct cls_rule *cls_rule)
2066 {
2067     return cls_rule ? CONTAINER_OF(cls_rule, struct rule, cr) : NULL;
2068 }
2069
2070 static void
2071 rule_free(struct rule *rule)
2072 {
2073     free(rule->actions);
2074     free(rule);
2075 }
2076
2077 /* Destroys 'rule' and iterates through all of its facets and revalidates them,
2078  * destroying any that no longer has a rule (which is probably all of them).
2079  *
2080  * The caller must have already removed 'rule' from the classifier. */
2081 static void
2082 rule_destroy(struct ofproto *ofproto, struct rule *rule)
2083 {
2084     struct facet *facet, *next_facet;
2085     LIST_FOR_EACH_SAFE (facet, next_facet, list_node, &rule->facets) {
2086         facet_revalidate(ofproto, facet);
2087     }
2088     rule_free(rule);
2089 }
2090
2091 /* Returns true if 'rule' has an OpenFlow OFPAT_OUTPUT or OFPAT_ENQUEUE action
2092  * that outputs to 'out_port' (output to OFPP_FLOOD and OFPP_ALL doesn't
2093  * count). */
2094 static bool
2095 rule_has_out_port(const struct rule *rule, ovs_be16 out_port)
2096 {
2097     const union ofp_action *oa;
2098     struct actions_iterator i;
2099
2100     if (out_port == htons(OFPP_NONE)) {
2101         return true;
2102     }
2103     for (oa = actions_first(&i, rule->actions, rule->n_actions); oa;
2104          oa = actions_next(&i)) {
2105         if (action_outputs_to_port(oa, out_port)) {
2106             return true;
2107         }
2108     }
2109     return false;
2110 }
2111
2112 /* Executes, within 'ofproto', the 'n_actions' actions in 'actions' on
2113  * 'packet', which arrived on 'in_port'.
2114  *
2115  * Takes ownership of 'packet'. */
2116 static bool
2117 execute_odp_actions(struct ofproto *ofproto, const struct flow *flow,
2118                     const struct nlattr *odp_actions, size_t actions_len,
2119                     struct ofpbuf *packet)
2120 {
2121     if (actions_len == NLA_ALIGN(NLA_HDRLEN + sizeof(uint64_t))
2122         && odp_actions->nla_type == ODP_ACTION_ATTR_CONTROLLER) {
2123         /* As an optimization, avoid a round-trip from userspace to kernel to
2124          * userspace.  This also avoids possibly filling up kernel packet
2125          * buffers along the way. */
2126         struct dpif_upcall upcall;
2127
2128         upcall.type = DPIF_UC_ACTION;
2129         upcall.packet = packet;
2130         upcall.key = NULL;
2131         upcall.key_len = 0;
2132         upcall.userdata = nl_attr_get_u64(odp_actions);
2133         upcall.sample_pool = 0;
2134         upcall.actions = NULL;
2135         upcall.actions_len = 0;
2136
2137         send_packet_in(ofproto, &upcall, flow, false);
2138
2139         return true;
2140     } else {
2141         int error;
2142
2143         error = dpif_execute(ofproto->dpif, odp_actions, actions_len, packet);
2144         ofpbuf_delete(packet);
2145         return !error;
2146     }
2147 }
2148
2149 /* Executes the actions indicated by 'facet' on 'packet' and credits 'facet''s
2150  * statistics appropriately.  'packet' must have at least sizeof(struct
2151  * ofp_packet_in) bytes of headroom.
2152  *
2153  * For correct results, 'packet' must actually be in 'facet''s flow; that is,
2154  * applying flow_extract() to 'packet' would yield the same flow as
2155  * 'facet->flow'.
2156  *
2157  * 'facet' must have accurately composed ODP actions; that is, it must not be
2158  * in need of revalidation.
2159  *
2160  * Takes ownership of 'packet'. */
2161 static void
2162 facet_execute(struct ofproto *ofproto, struct facet *facet,
2163               struct ofpbuf *packet)
2164 {
2165     struct dpif_flow_stats stats;
2166
2167     assert(ofpbuf_headroom(packet) >= sizeof(struct ofp_packet_in));
2168
2169     flow_extract_stats(&facet->flow, packet, &stats);
2170     stats.used = time_msec();
2171     if (execute_odp_actions(ofproto, &facet->flow,
2172                             facet->actions, facet->actions_len, packet)) {
2173         facet_update_stats(ofproto, facet, &stats);
2174     }
2175 }
2176
2177 /* Executes the actions indicated by 'rule' on 'packet' and credits 'rule''s
2178  * statistics (or the statistics for one of its facets) appropriately.
2179  * 'packet' must have at least sizeof(struct ofp_packet_in) bytes of headroom.
2180  *
2181  * 'packet' doesn't necessarily have to match 'rule'.  'rule' will be credited
2182  * with statistics for 'packet' either way.
2183  *
2184  * Takes ownership of 'packet'. */
2185 static void
2186 rule_execute(struct ofproto *ofproto, struct rule *rule, uint16_t in_port,
2187              struct ofpbuf *packet)
2188 {
2189     struct action_xlate_ctx ctx;
2190     struct ofpbuf *odp_actions;
2191     struct facet *facet;
2192     struct flow flow;
2193     size_t size;
2194
2195     assert(ofpbuf_headroom(packet) >= sizeof(struct ofp_packet_in));
2196
2197     flow_extract(packet, 0, in_port, &flow);
2198
2199     /* First look for a related facet.  If we find one, account it to that. */
2200     facet = facet_lookup_valid(ofproto, &flow);
2201     if (facet && facet->rule == rule) {
2202         facet_execute(ofproto, facet, packet);
2203         return;
2204     }
2205
2206     /* Otherwise, if 'rule' is in fact the correct rule for 'packet', then
2207      * create a new facet for it and use that. */
2208     if (rule_lookup(ofproto, &flow) == rule) {
2209         facet = facet_create(ofproto, rule, &flow, packet);
2210         facet_execute(ofproto, facet, packet);
2211         facet_install(ofproto, facet, true);
2212         return;
2213     }
2214
2215     /* We can't account anything to a facet.  If we were to try, then that
2216      * facet would have a non-matching rule, busting our invariants. */
2217     action_xlate_ctx_init(&ctx, ofproto, &flow, packet);
2218     odp_actions = xlate_actions(&ctx, rule->actions, rule->n_actions);
2219     size = packet->size;
2220     if (execute_odp_actions(ofproto, &flow, odp_actions->data,
2221                             odp_actions->size, packet)) {
2222         rule->used = time_msec();
2223         rule->packet_count++;
2224         rule->byte_count += size;
2225         flow_push_stats(ofproto, rule, &flow, 1, size, rule->used);
2226     }
2227     ofpbuf_delete(odp_actions);
2228 }
2229
2230 /* Inserts 'rule' into 'p''s flow table. */
2231 static void
2232 rule_insert(struct ofproto *p, struct rule *rule)
2233 {
2234     struct rule *displaced_rule;
2235
2236     displaced_rule = rule_from_cls_rule(classifier_insert(&p->cls, &rule->cr));
2237     if (displaced_rule) {
2238         rule_destroy(p, displaced_rule);
2239     }
2240     p->need_revalidate = true;
2241 }
2242
2243 /* Creates and returns a new facet within 'ofproto' owned by 'rule', given a
2244  * 'flow' and an example 'packet' within that flow.
2245  *
2246  * The caller must already have determined that no facet with an identical
2247  * 'flow' exists in 'ofproto' and that 'flow' is the best match for 'rule' in
2248  * 'ofproto''s classifier table. */
2249 static struct facet *
2250 facet_create(struct ofproto *ofproto, struct rule *rule,
2251              const struct flow *flow, const struct ofpbuf *packet)
2252 {
2253     struct facet *facet;
2254
2255     facet = xzalloc(sizeof *facet);
2256     facet->used = time_msec();
2257     hmap_insert(&ofproto->facets, &facet->hmap_node, flow_hash(flow, 0));
2258     list_push_back(&rule->facets, &facet->list_node);
2259     facet->rule = rule;
2260     facet->flow = *flow;
2261     netflow_flow_init(&facet->nf_flow);
2262     netflow_flow_update_time(ofproto->netflow, &facet->nf_flow, facet->used);
2263
2264     facet_make_actions(ofproto, facet, packet);
2265
2266     return facet;
2267 }
2268
2269 static void
2270 facet_free(struct facet *facet)
2271 {
2272     free(facet->actions);
2273     free(facet);
2274 }
2275
2276 /* Remove 'rule' from 'ofproto' and free up the associated memory:
2277  *
2278  *   - Removes 'rule' from the classifier.
2279  *
2280  *   - If 'rule' has facets, revalidates them (and possibly uninstalls and
2281  *     destroys them), via rule_destroy().
2282  */
2283 static void
2284 rule_remove(struct ofproto *ofproto, struct rule *rule)
2285 {
2286     COVERAGE_INC(ofproto_del_rule);
2287     ofproto->need_revalidate = true;
2288     classifier_remove(&ofproto->cls, &rule->cr);
2289     rule_destroy(ofproto, rule);
2290 }
2291
2292 /* Remove 'facet' from 'ofproto' and free up the associated memory:
2293  *
2294  *   - If 'facet' was installed in the datapath, uninstalls it and updates its
2295  *     rule's statistics, via facet_uninstall().
2296  *
2297  *   - Removes 'facet' from its rule and from ofproto->facets.
2298  */
2299 static void
2300 facet_remove(struct ofproto *ofproto, struct facet *facet)
2301 {
2302     facet_uninstall(ofproto, facet);
2303     facet_flush_stats(ofproto, facet);
2304     hmap_remove(&ofproto->facets, &facet->hmap_node);
2305     list_remove(&facet->list_node);
2306     facet_free(facet);
2307 }
2308
2309 /* Composes the ODP actions for 'facet' based on its rule's actions. */
2310 static void
2311 facet_make_actions(struct ofproto *p, struct facet *facet,
2312                    const struct ofpbuf *packet)
2313 {
2314     const struct rule *rule = facet->rule;
2315     struct ofpbuf *odp_actions;
2316     struct action_xlate_ctx ctx;
2317
2318     action_xlate_ctx_init(&ctx, p, &facet->flow, packet);
2319     odp_actions = xlate_actions(&ctx, rule->actions, rule->n_actions);
2320     facet->tags = ctx.tags;
2321     facet->may_install = ctx.may_set_up_flow;
2322     facet->nf_flow.output_iface = ctx.nf_output_iface;
2323
2324     if (facet->actions_len != odp_actions->size
2325         || memcmp(facet->actions, odp_actions->data, odp_actions->size)) {
2326         free(facet->actions);
2327         facet->actions_len = odp_actions->size;
2328         facet->actions = xmemdup(odp_actions->data, odp_actions->size);
2329     }
2330
2331     ofpbuf_delete(odp_actions);
2332 }
2333
2334 static int
2335 facet_put__(struct ofproto *ofproto, struct facet *facet,
2336             const struct nlattr *actions, size_t actions_len,
2337             struct dpif_flow_stats *stats)
2338 {
2339     uint32_t keybuf[ODPUTIL_FLOW_KEY_U32S];
2340     enum dpif_flow_put_flags flags;
2341     struct ofpbuf key;
2342
2343     flags = DPIF_FP_CREATE | DPIF_FP_MODIFY;
2344     if (stats) {
2345         flags |= DPIF_FP_ZERO_STATS;
2346         facet->dp_packet_count = 0;
2347         facet->dp_byte_count = 0;
2348     }
2349
2350     ofpbuf_use_stack(&key, keybuf, sizeof keybuf);
2351     odp_flow_key_from_flow(&key, &facet->flow);
2352     assert(key.base == keybuf);
2353
2354     return dpif_flow_put(ofproto->dpif, flags, key.data, key.size,
2355                          actions, actions_len, stats);
2356 }
2357
2358 /* If 'facet' is installable, inserts or re-inserts it into 'p''s datapath.  If
2359  * 'zero_stats' is true, clears any existing statistics from the datapath for
2360  * 'facet'. */
2361 static void
2362 facet_install(struct ofproto *p, struct facet *facet, bool zero_stats)
2363 {
2364     struct dpif_flow_stats stats;
2365
2366     if (facet->may_install
2367         && !facet_put__(p, facet, facet->actions, facet->actions_len,
2368                         zero_stats ? &stats : NULL)) {
2369         facet->installed = true;
2370     }
2371 }
2372
2373 /* Ensures that the bytes in 'facet', plus 'extra_bytes', have been passed up
2374  * to the accounting hook function in the ofhooks structure. */
2375 static void
2376 facet_account(struct ofproto *ofproto,
2377               struct facet *facet, uint64_t extra_bytes)
2378 {
2379     uint64_t total_bytes = facet->byte_count + extra_bytes;
2380
2381     if (ofproto->ofhooks->account_flow_cb
2382         && total_bytes > facet->accounted_bytes)
2383     {
2384         ofproto->ofhooks->account_flow_cb(
2385             &facet->flow, facet->tags, facet->actions, facet->actions_len,
2386             total_bytes - facet->accounted_bytes, ofproto->aux);
2387         facet->accounted_bytes = total_bytes;
2388     }
2389 }
2390
2391 /* If 'rule' is installed in the datapath, uninstalls it. */
2392 static void
2393 facet_uninstall(struct ofproto *p, struct facet *facet)
2394 {
2395     if (facet->installed) {
2396         uint32_t keybuf[ODPUTIL_FLOW_KEY_U32S];
2397         struct dpif_flow_stats stats;
2398         struct ofpbuf key;
2399
2400         ofpbuf_use_stack(&key, keybuf, sizeof keybuf);
2401         odp_flow_key_from_flow(&key, &facet->flow);
2402         assert(key.base == keybuf);
2403
2404         if (!dpif_flow_del(p->dpif, key.data, key.size, &stats)) {
2405             facet_update_stats(p, facet, &stats);
2406         }
2407         facet->installed = false;
2408         facet->dp_packet_count = 0;
2409         facet->dp_byte_count = 0;
2410     } else {
2411         assert(facet->dp_packet_count == 0);
2412         assert(facet->dp_byte_count == 0);
2413     }
2414 }
2415
2416 /* Returns true if the only action for 'facet' is to send to the controller.
2417  * (We don't report NetFlow expiration messages for such facets because they
2418  * are just part of the control logic for the network, not real traffic). */
2419 static bool
2420 facet_is_controller_flow(struct facet *facet)
2421 {
2422     return (facet
2423             && facet->rule->n_actions == 1
2424             && action_outputs_to_port(&facet->rule->actions[0],
2425                                       htons(OFPP_CONTROLLER)));
2426 }
2427
2428 /* Folds all of 'facet''s statistics into its rule.  Also updates the
2429  * accounting ofhook and emits a NetFlow expiration if appropriate.  All of
2430  * 'facet''s statistics in the datapath should have been zeroed and folded into
2431  * its packet and byte counts before this function is called. */
2432 static void
2433 facet_flush_stats(struct ofproto *ofproto, struct facet *facet)
2434 {
2435     assert(!facet->dp_byte_count);
2436     assert(!facet->dp_packet_count);
2437
2438     facet_push_stats(ofproto, facet);
2439     facet_account(ofproto, facet, 0);
2440
2441     if (ofproto->netflow && !facet_is_controller_flow(facet)) {
2442         struct ofexpired expired;
2443         expired.flow = facet->flow;
2444         expired.packet_count = facet->packet_count;
2445         expired.byte_count = facet->byte_count;
2446         expired.used = facet->used;
2447         netflow_expire(ofproto->netflow, &facet->nf_flow, &expired);
2448     }
2449
2450     facet->rule->packet_count += facet->packet_count;
2451     facet->rule->byte_count += facet->byte_count;
2452
2453     /* Reset counters to prevent double counting if 'facet' ever gets
2454      * reinstalled. */
2455     facet->packet_count = 0;
2456     facet->byte_count = 0;
2457     facet->rs_packet_count = 0;
2458     facet->rs_byte_count = 0;
2459     facet->accounted_bytes = 0;
2460
2461     netflow_flow_clear(&facet->nf_flow);
2462 }
2463
2464 /* Searches 'ofproto''s table of facets for one exactly equal to 'flow'.
2465  * Returns it if found, otherwise a null pointer.
2466  *
2467  * The returned facet might need revalidation; use facet_lookup_valid()
2468  * instead if that is important. */
2469 static struct facet *
2470 facet_find(struct ofproto *ofproto, const struct flow *flow)
2471 {
2472     struct facet *facet;
2473
2474     HMAP_FOR_EACH_WITH_HASH (facet, hmap_node, flow_hash(flow, 0),
2475                              &ofproto->facets) {
2476         if (flow_equal(flow, &facet->flow)) {
2477             return facet;
2478         }
2479     }
2480
2481     return NULL;
2482 }
2483
2484 /* Searches 'ofproto''s table of facets for one exactly equal to 'flow'.
2485  * Returns it if found, otherwise a null pointer.
2486  *
2487  * The returned facet is guaranteed to be valid. */
2488 static struct facet *
2489 facet_lookup_valid(struct ofproto *ofproto, const struct flow *flow)
2490 {
2491     struct facet *facet = facet_find(ofproto, flow);
2492
2493     /* The facet we found might not be valid, since we could be in need of
2494      * revalidation.  If it is not valid, don't return it. */
2495     if (facet
2496         && ofproto->need_revalidate
2497         && !facet_revalidate(ofproto, facet)) {
2498         COVERAGE_INC(ofproto_invalidated);
2499         return NULL;
2500     }
2501
2502     return facet;
2503 }
2504
2505 /* Re-searches 'ofproto''s classifier for a rule matching 'facet':
2506  *
2507  *   - If the rule found is different from 'facet''s current rule, moves
2508  *     'facet' to the new rule and recompiles its actions.
2509  *
2510  *   - If the rule found is the same as 'facet''s current rule, leaves 'facet'
2511  *     where it is and recompiles its actions anyway.
2512  *
2513  *   - If there is none, destroys 'facet'.
2514  *
2515  * Returns true if 'facet' still exists, false if it has been destroyed. */
2516 static bool
2517 facet_revalidate(struct ofproto *ofproto, struct facet *facet)
2518 {
2519     struct action_xlate_ctx ctx;
2520     struct ofpbuf *odp_actions;
2521     struct rule *new_rule;
2522     bool actions_changed;
2523
2524     COVERAGE_INC(facet_revalidate);
2525
2526     /* Determine the new rule. */
2527     new_rule = rule_lookup(ofproto, &facet->flow);
2528     if (!new_rule) {
2529         /* No new rule, so delete the facet. */
2530         facet_remove(ofproto, facet);
2531         return false;
2532     }
2533
2534     /* Calculate new ODP actions.
2535      *
2536      * We do not modify any 'facet' state yet, because we might need to, e.g.,
2537      * emit a NetFlow expiration and, if so, we need to have the old state
2538      * around to properly compose it. */
2539     action_xlate_ctx_init(&ctx, ofproto, &facet->flow, NULL);
2540     odp_actions = xlate_actions(&ctx, new_rule->actions, new_rule->n_actions);
2541     actions_changed = (facet->actions_len != odp_actions->size
2542                        || memcmp(facet->actions, odp_actions->data,
2543                                  facet->actions_len));
2544
2545     /* If the ODP actions changed or the installability changed, then we need
2546      * to talk to the datapath. */
2547     if (actions_changed || ctx.may_set_up_flow != facet->installed) {
2548         if (ctx.may_set_up_flow) {
2549             struct dpif_flow_stats stats;
2550
2551             facet_put__(ofproto, facet,
2552                         odp_actions->data, odp_actions->size, &stats);
2553             facet_update_stats(ofproto, facet, &stats);
2554         } else {
2555             facet_uninstall(ofproto, facet);
2556         }
2557
2558         /* The datapath flow is gone or has zeroed stats, so push stats out of
2559          * 'facet' into 'rule'. */
2560         facet_flush_stats(ofproto, facet);
2561     }
2562
2563     /* Update 'facet' now that we've taken care of all the old state. */
2564     facet->tags = ctx.tags;
2565     facet->nf_flow.output_iface = ctx.nf_output_iface;
2566     facet->may_install = ctx.may_set_up_flow;
2567     if (actions_changed) {
2568         free(facet->actions);
2569         facet->actions_len = odp_actions->size;
2570         facet->actions = xmemdup(odp_actions->data, odp_actions->size);
2571     }
2572     if (facet->rule != new_rule) {
2573         COVERAGE_INC(facet_changed_rule);
2574         list_remove(&facet->list_node);
2575         list_push_back(&new_rule->facets, &facet->list_node);
2576         facet->rule = new_rule;
2577         facet->used = new_rule->created;
2578         facet->rs_used = facet->used;
2579     }
2580
2581     ofpbuf_delete(odp_actions);
2582
2583     return true;
2584 }
2585 \f
2586 static void
2587 queue_tx(struct ofpbuf *msg, const struct ofconn *ofconn,
2588          struct rconn_packet_counter *counter)
2589 {
2590     update_openflow_length(msg);
2591     if (rconn_send(ofconn->rconn, msg, counter)) {
2592         ofpbuf_delete(msg);
2593     }
2594 }
2595
2596 static void
2597 send_error_oh(const struct ofconn *ofconn, const struct ofp_header *oh,
2598               int error)
2599 {
2600     struct ofpbuf *buf = ofputil_encode_error_msg(error, oh);
2601     if (buf) {
2602         COVERAGE_INC(ofproto_error);
2603         queue_tx(buf, ofconn, ofconn->reply_counter);
2604     }
2605 }
2606
2607 static void
2608 hton_ofp_phy_port(struct ofp_phy_port *opp)
2609 {
2610     opp->port_no = htons(opp->port_no);
2611     opp->config = htonl(opp->config);
2612     opp->state = htonl(opp->state);
2613     opp->curr = htonl(opp->curr);
2614     opp->advertised = htonl(opp->advertised);
2615     opp->supported = htonl(opp->supported);
2616     opp->peer = htonl(opp->peer);
2617 }
2618
2619 static int
2620 handle_echo_request(struct ofconn *ofconn, const struct ofp_header *oh)
2621 {
2622     queue_tx(make_echo_reply(oh), ofconn, ofconn->reply_counter);
2623     return 0;
2624 }
2625
2626 static int
2627 handle_features_request(struct ofconn *ofconn, const struct ofp_header *oh)
2628 {
2629     struct ofp_switch_features *osf;
2630     struct ofpbuf *buf;
2631     struct ofport *port;
2632
2633     osf = make_openflow_xid(sizeof *osf, OFPT_FEATURES_REPLY, oh->xid, &buf);
2634     osf->datapath_id = htonll(ofconn->ofproto->datapath_id);
2635     osf->n_buffers = htonl(pktbuf_capacity());
2636     osf->n_tables = 2;
2637     osf->capabilities = htonl(OFPC_FLOW_STATS | OFPC_TABLE_STATS |
2638                               OFPC_PORT_STATS | OFPC_ARP_MATCH_IP);
2639     osf->actions = htonl((1u << OFPAT_OUTPUT) |
2640                          (1u << OFPAT_SET_VLAN_VID) |
2641                          (1u << OFPAT_SET_VLAN_PCP) |
2642                          (1u << OFPAT_STRIP_VLAN) |
2643                          (1u << OFPAT_SET_DL_SRC) |
2644                          (1u << OFPAT_SET_DL_DST) |
2645                          (1u << OFPAT_SET_NW_SRC) |
2646                          (1u << OFPAT_SET_NW_DST) |
2647                          (1u << OFPAT_SET_NW_TOS) |
2648                          (1u << OFPAT_SET_TP_SRC) |
2649                          (1u << OFPAT_SET_TP_DST) |
2650                          (1u << OFPAT_ENQUEUE));
2651
2652     HMAP_FOR_EACH (port, hmap_node, &ofconn->ofproto->ports) {
2653         hton_ofp_phy_port(ofpbuf_put(buf, &port->opp, sizeof port->opp));
2654     }
2655
2656     queue_tx(buf, ofconn, ofconn->reply_counter);
2657     return 0;
2658 }
2659
2660 static int
2661 handle_get_config_request(struct ofconn *ofconn, const struct ofp_header *oh)
2662 {
2663     struct ofpbuf *buf;
2664     struct ofp_switch_config *osc;
2665     uint16_t flags;
2666     bool drop_frags;
2667
2668     /* Figure out flags. */
2669     dpif_get_drop_frags(ofconn->ofproto->dpif, &drop_frags);
2670     flags = drop_frags ? OFPC_FRAG_DROP : OFPC_FRAG_NORMAL;
2671
2672     /* Send reply. */
2673     osc = make_openflow_xid(sizeof *osc, OFPT_GET_CONFIG_REPLY, oh->xid, &buf);
2674     osc->flags = htons(flags);
2675     osc->miss_send_len = htons(ofconn->miss_send_len);
2676     queue_tx(buf, ofconn, ofconn->reply_counter);
2677
2678     return 0;
2679 }
2680
2681 static int
2682 handle_set_config(struct ofconn *ofconn, const struct ofp_switch_config *osc)
2683 {
2684     uint16_t flags = ntohs(osc->flags);
2685
2686     if (ofconn->type == OFCONN_PRIMARY && ofconn->role != NX_ROLE_SLAVE) {
2687         switch (flags & OFPC_FRAG_MASK) {
2688         case OFPC_FRAG_NORMAL:
2689             dpif_set_drop_frags(ofconn->ofproto->dpif, false);
2690             break;
2691         case OFPC_FRAG_DROP:
2692             dpif_set_drop_frags(ofconn->ofproto->dpif, true);
2693             break;
2694         default:
2695             VLOG_WARN_RL(&rl, "requested bad fragment mode (flags=%"PRIx16")",
2696                          osc->flags);
2697             break;
2698         }
2699     }
2700
2701     ofconn->miss_send_len = ntohs(osc->miss_send_len);
2702
2703     return 0;
2704 }
2705
2706 static void do_xlate_actions(const union ofp_action *in, size_t n_in,
2707                              struct action_xlate_ctx *ctx);
2708
2709 static void
2710 add_output_action(struct action_xlate_ctx *ctx, uint16_t port)
2711 {
2712     const struct ofport *ofport = get_port(ctx->ofproto, port);
2713
2714     if (ofport) {
2715         if (ofport->opp.config & OFPPC_NO_FWD) {
2716             /* Forwarding disabled on port. */
2717             return;
2718         }
2719     } else {
2720         /*
2721          * We don't have an ofport record for this port, but it doesn't hurt to
2722          * allow forwarding to it anyhow.  Maybe such a port will appear later
2723          * and we're pre-populating the flow table.
2724          */
2725     }
2726
2727     nl_msg_put_u32(ctx->odp_actions, ODP_ACTION_ATTR_OUTPUT, port);
2728     ctx->nf_output_iface = port;
2729 }
2730
2731 static struct rule *
2732 rule_lookup(struct ofproto *ofproto, const struct flow *flow)
2733 {
2734     return rule_from_cls_rule(classifier_lookup(&ofproto->cls, flow));
2735 }
2736
2737 static void
2738 xlate_table_action(struct action_xlate_ctx *ctx, uint16_t in_port)
2739 {
2740     if (ctx->recurse < MAX_RESUBMIT_RECURSION) {
2741         uint16_t old_in_port;
2742         struct rule *rule;
2743
2744         /* Look up a flow with 'in_port' as the input port.  Then restore the
2745          * original input port (otherwise OFPP_NORMAL and OFPP_IN_PORT will
2746          * have surprising behavior). */
2747         old_in_port = ctx->flow.in_port;
2748         ctx->flow.in_port = in_port;
2749         rule = rule_lookup(ctx->ofproto, &ctx->flow);
2750         ctx->flow.in_port = old_in_port;
2751
2752         if (ctx->resubmit_hook) {
2753             ctx->resubmit_hook(ctx, rule);
2754         }
2755
2756         if (rule) {
2757             ctx->recurse++;
2758             do_xlate_actions(rule->actions, rule->n_actions, ctx);
2759             ctx->recurse--;
2760         }
2761     } else {
2762         static struct vlog_rate_limit recurse_rl = VLOG_RATE_LIMIT_INIT(1, 1);
2763
2764         VLOG_ERR_RL(&recurse_rl, "NXAST_RESUBMIT recursed over %d times",
2765                     MAX_RESUBMIT_RECURSION);
2766     }
2767 }
2768
2769 static void
2770 flood_packets(struct ofproto *ofproto, uint16_t odp_in_port, uint32_t mask,
2771               uint16_t *nf_output_iface, struct ofpbuf *odp_actions)
2772 {
2773     struct ofport *ofport;
2774
2775     HMAP_FOR_EACH (ofport, hmap_node, &ofproto->ports) {
2776         uint16_t odp_port = ofport->odp_port;
2777         if (odp_port != odp_in_port && !(ofport->opp.config & mask)) {
2778             nl_msg_put_u32(odp_actions, ODP_ACTION_ATTR_OUTPUT, odp_port);
2779         }
2780     }
2781     *nf_output_iface = NF_OUT_FLOOD;
2782 }
2783
2784 static void
2785 xlate_output_action__(struct action_xlate_ctx *ctx,
2786                       uint16_t port, uint16_t max_len)
2787 {
2788     uint16_t odp_port;
2789     uint16_t prev_nf_output_iface = ctx->nf_output_iface;
2790
2791     ctx->nf_output_iface = NF_OUT_DROP;
2792
2793     switch (port) {
2794     case OFPP_IN_PORT:
2795         add_output_action(ctx, ctx->flow.in_port);
2796         break;
2797     case OFPP_TABLE:
2798         xlate_table_action(ctx, ctx->flow.in_port);
2799         break;
2800     case OFPP_NORMAL:
2801         if (!ctx->ofproto->ofhooks->normal_cb(&ctx->flow, ctx->packet,
2802                                               ctx->odp_actions, &ctx->tags,
2803                                               &ctx->nf_output_iface,
2804                                               ctx->ofproto->aux)) {
2805             COVERAGE_INC(ofproto_uninstallable);
2806             ctx->may_set_up_flow = false;
2807         }
2808         break;
2809     case OFPP_FLOOD:
2810         flood_packets(ctx->ofproto, ctx->flow.in_port, OFPPC_NO_FLOOD,
2811                       &ctx->nf_output_iface, ctx->odp_actions);
2812         break;
2813     case OFPP_ALL:
2814         flood_packets(ctx->ofproto, ctx->flow.in_port, 0,
2815                       &ctx->nf_output_iface, ctx->odp_actions);
2816         break;
2817     case OFPP_CONTROLLER:
2818         nl_msg_put_u64(ctx->odp_actions, ODP_ACTION_ATTR_CONTROLLER, max_len);
2819         break;
2820     case OFPP_LOCAL:
2821         add_output_action(ctx, ODPP_LOCAL);
2822         break;
2823     default:
2824         odp_port = ofp_port_to_odp_port(port);
2825         if (odp_port != ctx->flow.in_port) {
2826             add_output_action(ctx, odp_port);
2827         }
2828         break;
2829     }
2830
2831     if (prev_nf_output_iface == NF_OUT_FLOOD) {
2832         ctx->nf_output_iface = NF_OUT_FLOOD;
2833     } else if (ctx->nf_output_iface == NF_OUT_DROP) {
2834         ctx->nf_output_iface = prev_nf_output_iface;
2835     } else if (prev_nf_output_iface != NF_OUT_DROP &&
2836                ctx->nf_output_iface != NF_OUT_FLOOD) {
2837         ctx->nf_output_iface = NF_OUT_MULTI;
2838     }
2839 }
2840
2841 static void
2842 xlate_output_action(struct action_xlate_ctx *ctx,
2843                     const struct ofp_action_output *oao)
2844 {
2845     xlate_output_action__(ctx, ntohs(oao->port), ntohs(oao->max_len));
2846 }
2847
2848 /* If the final ODP action in 'ctx' is "pop priority", drop it, as an
2849  * optimization, because we're going to add another action that sets the
2850  * priority immediately after, or because there are no actions following the
2851  * pop.  */
2852 static void
2853 remove_pop_action(struct action_xlate_ctx *ctx)
2854 {
2855     if (ctx->odp_actions->size == ctx->last_pop_priority) {
2856         ctx->odp_actions->size -= NLA_ALIGN(NLA_HDRLEN);
2857         ctx->last_pop_priority = -1;
2858     }
2859 }
2860
2861 static void
2862 add_pop_action(struct action_xlate_ctx *ctx)
2863 {
2864     if (ctx->odp_actions->size != ctx->last_pop_priority) {
2865         nl_msg_put_flag(ctx->odp_actions, ODP_ACTION_ATTR_POP_PRIORITY);
2866         ctx->last_pop_priority = ctx->odp_actions->size;
2867     }
2868 }
2869
2870 static void
2871 xlate_enqueue_action(struct action_xlate_ctx *ctx,
2872                      const struct ofp_action_enqueue *oae)
2873 {
2874     uint16_t ofp_port, odp_port;
2875     uint32_t priority;
2876     int error;
2877
2878     error = dpif_queue_to_priority(ctx->ofproto->dpif, ntohl(oae->queue_id),
2879                                    &priority);
2880     if (error) {
2881         /* Fall back to ordinary output action. */
2882         xlate_output_action__(ctx, ntohs(oae->port), 0);
2883         return;
2884     }
2885
2886     /* Figure out ODP output port. */
2887     ofp_port = ntohs(oae->port);
2888     if (ofp_port != OFPP_IN_PORT) {
2889         odp_port = ofp_port_to_odp_port(ofp_port);
2890     } else {
2891         odp_port = ctx->flow.in_port;
2892     }
2893
2894     /* Add ODP actions. */
2895     remove_pop_action(ctx);
2896     nl_msg_put_u32(ctx->odp_actions, ODP_ACTION_ATTR_SET_PRIORITY, priority);
2897     add_output_action(ctx, odp_port);
2898     add_pop_action(ctx);
2899
2900     /* Update NetFlow output port. */
2901     if (ctx->nf_output_iface == NF_OUT_DROP) {
2902         ctx->nf_output_iface = odp_port;
2903     } else if (ctx->nf_output_iface != NF_OUT_FLOOD) {
2904         ctx->nf_output_iface = NF_OUT_MULTI;
2905     }
2906 }
2907
2908 static void
2909 xlate_set_queue_action(struct action_xlate_ctx *ctx,
2910                        const struct nx_action_set_queue *nasq)
2911 {
2912     uint32_t priority;
2913     int error;
2914
2915     error = dpif_queue_to_priority(ctx->ofproto->dpif, ntohl(nasq->queue_id),
2916                                    &priority);
2917     if (error) {
2918         /* Couldn't translate queue to a priority, so ignore.  A warning
2919          * has already been logged. */
2920         return;
2921     }
2922
2923     remove_pop_action(ctx);
2924     nl_msg_put_u32(ctx->odp_actions, ODP_ACTION_ATTR_SET_PRIORITY, priority);
2925 }
2926
2927 static void
2928 xlate_set_dl_tci(struct action_xlate_ctx *ctx)
2929 {
2930     ovs_be16 tci = ctx->flow.vlan_tci;
2931     if (!(tci & htons(VLAN_CFI))) {
2932         nl_msg_put_flag(ctx->odp_actions, ODP_ACTION_ATTR_STRIP_VLAN);
2933     } else {
2934         nl_msg_put_be16(ctx->odp_actions, ODP_ACTION_ATTR_SET_DL_TCI,
2935                         tci & ~htons(VLAN_CFI));
2936     }
2937 }
2938
2939 struct xlate_reg_state {
2940     ovs_be16 vlan_tci;
2941     ovs_be64 tun_id;
2942 };
2943
2944 static void
2945 save_reg_state(const struct action_xlate_ctx *ctx,
2946                struct xlate_reg_state *state)
2947 {
2948     state->vlan_tci = ctx->flow.vlan_tci;
2949     state->tun_id = ctx->flow.tun_id;
2950 }
2951
2952 static void
2953 update_reg_state(struct action_xlate_ctx *ctx,
2954                  const struct xlate_reg_state *state)
2955 {
2956     if (ctx->flow.vlan_tci != state->vlan_tci) {
2957         xlate_set_dl_tci(ctx);
2958     }
2959     if (ctx->flow.tun_id != state->tun_id) {
2960         nl_msg_put_be64(ctx->odp_actions,
2961                         ODP_ACTION_ATTR_SET_TUNNEL, ctx->flow.tun_id);
2962     }
2963 }
2964
2965 static void
2966 xlate_nicira_action(struct action_xlate_ctx *ctx,
2967                     const struct nx_action_header *nah)
2968 {
2969     const struct nx_action_resubmit *nar;
2970     const struct nx_action_set_tunnel *nast;
2971     const struct nx_action_set_queue *nasq;
2972     const struct nx_action_multipath *nam;
2973     enum nx_action_subtype subtype = ntohs(nah->subtype);
2974     struct xlate_reg_state state;
2975     ovs_be64 tun_id;
2976
2977     assert(nah->vendor == htonl(NX_VENDOR_ID));
2978     switch (subtype) {
2979     case NXAST_RESUBMIT:
2980         nar = (const struct nx_action_resubmit *) nah;
2981         xlate_table_action(ctx, ofp_port_to_odp_port(ntohs(nar->in_port)));
2982         break;
2983
2984     case NXAST_SET_TUNNEL:
2985         nast = (const struct nx_action_set_tunnel *) nah;
2986         tun_id = htonll(ntohl(nast->tun_id));
2987         nl_msg_put_be64(ctx->odp_actions, ODP_ACTION_ATTR_SET_TUNNEL, tun_id);
2988         ctx->flow.tun_id = tun_id;
2989         break;
2990
2991     case NXAST_DROP_SPOOFED_ARP:
2992         if (ctx->flow.dl_type == htons(ETH_TYPE_ARP)) {
2993             nl_msg_put_flag(ctx->odp_actions,
2994                             ODP_ACTION_ATTR_DROP_SPOOFED_ARP);
2995         }
2996         break;
2997
2998     case NXAST_SET_QUEUE:
2999         nasq = (const struct nx_action_set_queue *) nah;
3000         xlate_set_queue_action(ctx, nasq);
3001         break;
3002
3003     case NXAST_POP_QUEUE:
3004         add_pop_action(ctx);
3005         break;
3006
3007     case NXAST_REG_MOVE:
3008         save_reg_state(ctx, &state);
3009         nxm_execute_reg_move((const struct nx_action_reg_move *) nah,
3010                              &ctx->flow);
3011         update_reg_state(ctx, &state);
3012         break;
3013
3014     case NXAST_REG_LOAD:
3015         save_reg_state(ctx, &state);
3016         nxm_execute_reg_load((const struct nx_action_reg_load *) nah,
3017                              &ctx->flow);
3018         update_reg_state(ctx, &state);
3019         break;
3020
3021     case NXAST_NOTE:
3022         /* Nothing to do. */
3023         break;
3024
3025     case NXAST_SET_TUNNEL64:
3026         tun_id = ((const struct nx_action_set_tunnel64 *) nah)->tun_id;
3027         nl_msg_put_be64(ctx->odp_actions, ODP_ACTION_ATTR_SET_TUNNEL, tun_id);
3028         ctx->flow.tun_id = tun_id;
3029         break;
3030
3031     case NXAST_MULTIPATH:
3032         nam = (const struct nx_action_multipath *) nah;
3033         multipath_execute(nam, &ctx->flow);
3034         break;
3035
3036     /* If you add a new action here that modifies flow data, don't forget to
3037      * update the flow key in ctx->flow at the same time. */
3038
3039     case NXAST_SNAT__OBSOLETE:
3040     default:
3041         VLOG_DBG_RL(&rl, "unknown Nicira action type %d", (int) subtype);
3042         break;
3043     }
3044 }
3045
3046 static void
3047 do_xlate_actions(const union ofp_action *in, size_t n_in,
3048                  struct action_xlate_ctx *ctx)
3049 {
3050     struct actions_iterator iter;
3051     const union ofp_action *ia;
3052     const struct ofport *port;
3053
3054     port = get_port(ctx->ofproto, ctx->flow.in_port);
3055     if (port && port->opp.config & (OFPPC_NO_RECV | OFPPC_NO_RECV_STP) &&
3056         port->opp.config & (eth_addr_equals(ctx->flow.dl_dst, eth_addr_stp)
3057                             ? OFPPC_NO_RECV_STP : OFPPC_NO_RECV)) {
3058         /* Drop this flow. */
3059         return;
3060     }
3061
3062     for (ia = actions_first(&iter, in, n_in); ia; ia = actions_next(&iter)) {
3063         enum ofp_action_type type = ntohs(ia->type);
3064         const struct ofp_action_dl_addr *oada;
3065
3066         switch (type) {
3067         case OFPAT_OUTPUT:
3068             xlate_output_action(ctx, &ia->output);
3069             break;
3070
3071         case OFPAT_SET_VLAN_VID:
3072             ctx->flow.vlan_tci &= ~htons(VLAN_VID_MASK);
3073             ctx->flow.vlan_tci |= ia->vlan_vid.vlan_vid | htons(VLAN_CFI);
3074             xlate_set_dl_tci(ctx);
3075             break;
3076
3077         case OFPAT_SET_VLAN_PCP:
3078             ctx->flow.vlan_tci &= ~htons(VLAN_PCP_MASK);
3079             ctx->flow.vlan_tci |= htons(
3080                 (ia->vlan_pcp.vlan_pcp << VLAN_PCP_SHIFT) | VLAN_CFI);
3081             xlate_set_dl_tci(ctx);
3082             break;
3083
3084         case OFPAT_STRIP_VLAN:
3085             ctx->flow.vlan_tci = htons(0);
3086             xlate_set_dl_tci(ctx);
3087             break;
3088
3089         case OFPAT_SET_DL_SRC:
3090             oada = ((struct ofp_action_dl_addr *) ia);
3091             nl_msg_put_unspec(ctx->odp_actions, ODP_ACTION_ATTR_SET_DL_SRC,
3092                               oada->dl_addr, ETH_ADDR_LEN);
3093             memcpy(ctx->flow.dl_src, oada->dl_addr, ETH_ADDR_LEN);
3094             break;
3095
3096         case OFPAT_SET_DL_DST:
3097             oada = ((struct ofp_action_dl_addr *) ia);
3098             nl_msg_put_unspec(ctx->odp_actions, ODP_ACTION_ATTR_SET_DL_DST,
3099                               oada->dl_addr, ETH_ADDR_LEN);
3100             memcpy(ctx->flow.dl_dst, oada->dl_addr, ETH_ADDR_LEN);
3101             break;
3102
3103         case OFPAT_SET_NW_SRC:
3104             nl_msg_put_be32(ctx->odp_actions, ODP_ACTION_ATTR_SET_NW_SRC,
3105                             ia->nw_addr.nw_addr);
3106             ctx->flow.nw_src = ia->nw_addr.nw_addr;
3107             break;
3108
3109         case OFPAT_SET_NW_DST:
3110             nl_msg_put_be32(ctx->odp_actions, ODP_ACTION_ATTR_SET_NW_DST,
3111                             ia->nw_addr.nw_addr);
3112             ctx->flow.nw_dst = ia->nw_addr.nw_addr;
3113             break;
3114
3115         case OFPAT_SET_NW_TOS:
3116             nl_msg_put_u8(ctx->odp_actions, ODP_ACTION_ATTR_SET_NW_TOS,
3117                           ia->nw_tos.nw_tos);
3118             ctx->flow.nw_tos = ia->nw_tos.nw_tos;
3119             break;
3120
3121         case OFPAT_SET_TP_SRC:
3122             nl_msg_put_be16(ctx->odp_actions, ODP_ACTION_ATTR_SET_TP_SRC,
3123                             ia->tp_port.tp_port);
3124             ctx->flow.tp_src = ia->tp_port.tp_port;
3125             break;
3126
3127         case OFPAT_SET_TP_DST:
3128             nl_msg_put_be16(ctx->odp_actions, ODP_ACTION_ATTR_SET_TP_DST,
3129                             ia->tp_port.tp_port);
3130             ctx->flow.tp_dst = ia->tp_port.tp_port;
3131             break;
3132
3133         case OFPAT_VENDOR:
3134             xlate_nicira_action(ctx, (const struct nx_action_header *) ia);
3135             break;
3136
3137         case OFPAT_ENQUEUE:
3138             xlate_enqueue_action(ctx, (const struct ofp_action_enqueue *) ia);
3139             break;
3140
3141         default:
3142             VLOG_DBG_RL(&rl, "unknown action type %d", (int) type);
3143             break;
3144         }
3145     }
3146 }
3147
3148 static void
3149 action_xlate_ctx_init(struct action_xlate_ctx *ctx,
3150                       struct ofproto *ofproto, const struct flow *flow,
3151                       const struct ofpbuf *packet)
3152 {
3153     ctx->ofproto = ofproto;
3154     ctx->flow = *flow;
3155     ctx->packet = packet;
3156     ctx->resubmit_hook = NULL;
3157     ctx->check_special = true;
3158 }
3159
3160 static struct ofpbuf *
3161 xlate_actions(struct action_xlate_ctx *ctx,
3162               const union ofp_action *in, size_t n_in)
3163 {
3164     COVERAGE_INC(ofproto_ofp2odp);
3165
3166     ctx->odp_actions = ofpbuf_new(512);
3167     ctx->tags = 0;
3168     ctx->may_set_up_flow = true;
3169     ctx->nf_output_iface = NF_OUT_DROP;
3170     ctx->recurse = 0;
3171     ctx->last_pop_priority = -1;
3172
3173     if (!ctx->check_special
3174         || !ctx->ofproto->ofhooks->special_cb
3175         || ctx->ofproto->ofhooks->special_cb(&ctx->flow, ctx->packet,
3176                                              ctx->ofproto->aux)) {
3177         do_xlate_actions(in, n_in, ctx);
3178     } else {
3179         ctx->may_set_up_flow = false;
3180     }
3181
3182     remove_pop_action(ctx);
3183
3184     /* Check with in-band control to see if we're allowed to set up this
3185      * flow. */
3186     if (!in_band_rule_check(ctx->ofproto->in_band, &ctx->flow,
3187                             ctx->odp_actions->data, ctx->odp_actions->size)) {
3188         ctx->may_set_up_flow = false;
3189     }
3190
3191     return ctx->odp_actions;
3192 }
3193
3194 /* Checks whether 'ofconn' is a slave controller.  If so, returns an OpenFlow
3195  * error message code (composed with ofp_mkerr()) for the caller to propagate
3196  * upward.  Otherwise, returns 0.
3197  *
3198  * The log message mentions 'msg_type'. */
3199 static int
3200 reject_slave_controller(struct ofconn *ofconn, const const char *msg_type)
3201 {
3202     if (ofconn->type == OFCONN_PRIMARY && ofconn->role == NX_ROLE_SLAVE) {
3203         static struct vlog_rate_limit perm_rl = VLOG_RATE_LIMIT_INIT(1, 5);
3204         VLOG_WARN_RL(&perm_rl, "rejecting %s message from slave controller",
3205                      msg_type);
3206
3207         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_EPERM);
3208     } else {
3209         return 0;
3210     }
3211 }
3212
3213 static int
3214 handle_packet_out(struct ofconn *ofconn, const struct ofp_header *oh)
3215 {
3216     struct ofproto *p = ofconn->ofproto;
3217     struct ofp_packet_out *opo;
3218     struct ofpbuf payload, *buffer;
3219     union ofp_action *ofp_actions;
3220     struct action_xlate_ctx ctx;
3221     struct ofpbuf *odp_actions;
3222     struct ofpbuf request;
3223     struct flow flow;
3224     size_t n_ofp_actions;
3225     uint16_t in_port;
3226     int error;
3227
3228     COVERAGE_INC(ofproto_packet_out);
3229
3230     error = reject_slave_controller(ofconn, "OFPT_PACKET_OUT");
3231     if (error) {
3232         return error;
3233     }
3234
3235     /* Get ofp_packet_out. */
3236     ofpbuf_use_const(&request, oh, ntohs(oh->length));
3237     opo = ofpbuf_pull(&request, offsetof(struct ofp_packet_out, actions));
3238
3239     /* Get actions. */
3240     error = ofputil_pull_actions(&request, ntohs(opo->actions_len),
3241                                  &ofp_actions, &n_ofp_actions);
3242     if (error) {
3243         return error;
3244     }
3245
3246     /* Get payload. */
3247     if (opo->buffer_id != htonl(UINT32_MAX)) {
3248         error = pktbuf_retrieve(ofconn->pktbuf, ntohl(opo->buffer_id),
3249                                 &buffer, &in_port);
3250         if (error || !buffer) {
3251             return error;
3252         }
3253         payload = *buffer;
3254     } else {
3255         payload = request;
3256         buffer = NULL;
3257     }
3258
3259     /* Extract flow, check actions. */
3260     flow_extract(&payload, 0, ofp_port_to_odp_port(ntohs(opo->in_port)),
3261                  &flow);
3262     error = validate_actions(ofp_actions, n_ofp_actions, &flow, p->max_ports);
3263     if (error) {
3264         goto exit;
3265     }
3266
3267     /* Send. */
3268     action_xlate_ctx_init(&ctx, p, &flow, &payload);
3269     odp_actions = xlate_actions(&ctx, ofp_actions, n_ofp_actions);
3270     dpif_execute(p->dpif, odp_actions->data, odp_actions->size, &payload);
3271     ofpbuf_delete(odp_actions);
3272
3273 exit:
3274     ofpbuf_delete(buffer);
3275     return 0;
3276 }
3277
3278 static void
3279 update_port_config(struct ofproto *p, struct ofport *port,
3280                    uint32_t config, uint32_t mask)
3281 {
3282     mask &= config ^ port->opp.config;
3283     if (mask & OFPPC_PORT_DOWN) {
3284         if (config & OFPPC_PORT_DOWN) {
3285             netdev_turn_flags_off(port->netdev, NETDEV_UP, true);
3286         } else {
3287             netdev_turn_flags_on(port->netdev, NETDEV_UP, true);
3288         }
3289     }
3290 #define REVALIDATE_BITS (OFPPC_NO_RECV | OFPPC_NO_RECV_STP |    \
3291                          OFPPC_NO_FWD | OFPPC_NO_FLOOD)
3292     if (mask & REVALIDATE_BITS) {
3293         COVERAGE_INC(ofproto_costly_flags);
3294         port->opp.config ^= mask & REVALIDATE_BITS;
3295         p->need_revalidate = true;
3296     }
3297 #undef REVALIDATE_BITS
3298     if (mask & OFPPC_NO_PACKET_IN) {
3299         port->opp.config ^= OFPPC_NO_PACKET_IN;
3300     }
3301 }
3302
3303 static int
3304 handle_port_mod(struct ofconn *ofconn, const struct ofp_header *oh)
3305 {
3306     struct ofproto *p = ofconn->ofproto;
3307     const struct ofp_port_mod *opm = (const struct ofp_port_mod *) oh;
3308     struct ofport *port;
3309     int error;
3310
3311     error = reject_slave_controller(ofconn, "OFPT_PORT_MOD");
3312     if (error) {
3313         return error;
3314     }
3315
3316     port = get_port(p, ofp_port_to_odp_port(ntohs(opm->port_no)));
3317     if (!port) {
3318         return ofp_mkerr(OFPET_PORT_MOD_FAILED, OFPPMFC_BAD_PORT);
3319     } else if (memcmp(port->opp.hw_addr, opm->hw_addr, OFP_ETH_ALEN)) {
3320         return ofp_mkerr(OFPET_PORT_MOD_FAILED, OFPPMFC_BAD_HW_ADDR);
3321     } else {
3322         update_port_config(p, port, ntohl(opm->config), ntohl(opm->mask));
3323         if (opm->advertise) {
3324             netdev_set_advertisements(port->netdev, ntohl(opm->advertise));
3325         }
3326     }
3327     return 0;
3328 }
3329
3330 static struct ofpbuf *
3331 make_ofp_stats_reply(ovs_be32 xid, ovs_be16 type, size_t body_len)
3332 {
3333     struct ofp_stats_reply *osr;
3334     struct ofpbuf *msg;
3335
3336     msg = ofpbuf_new(MIN(sizeof *osr + body_len, UINT16_MAX));
3337     osr = put_openflow_xid(sizeof *osr, OFPT_STATS_REPLY, xid, msg);
3338     osr->type = type;
3339     osr->flags = htons(0);
3340     return msg;
3341 }
3342
3343 static struct ofpbuf *
3344 start_ofp_stats_reply(const struct ofp_header *request, size_t body_len)
3345 {
3346     const struct ofp_stats_request *osr
3347         = (const struct ofp_stats_request *) request;
3348     return make_ofp_stats_reply(osr->header.xid, osr->type, body_len);
3349 }
3350
3351 static void *
3352 append_ofp_stats_reply(size_t nbytes, struct ofconn *ofconn,
3353                        struct ofpbuf **msgp)
3354 {
3355     struct ofpbuf *msg = *msgp;
3356     assert(nbytes <= UINT16_MAX - sizeof(struct ofp_stats_reply));
3357     if (nbytes + msg->size > UINT16_MAX) {
3358         struct ofp_stats_reply *reply = msg->data;
3359         reply->flags = htons(OFPSF_REPLY_MORE);
3360         *msgp = make_ofp_stats_reply(reply->header.xid, reply->type, nbytes);
3361         queue_tx(msg, ofconn, ofconn->reply_counter);
3362     }
3363     return ofpbuf_put_uninit(*msgp, nbytes);
3364 }
3365
3366 static struct ofpbuf *
3367 make_nxstats_reply(ovs_be32 xid, ovs_be32 subtype, size_t body_len)
3368 {
3369     struct nicira_stats_msg *nsm;
3370     struct ofpbuf *msg;
3371
3372     msg = ofpbuf_new(MIN(sizeof *nsm + body_len, UINT16_MAX));
3373     nsm = put_openflow_xid(sizeof *nsm, OFPT_STATS_REPLY, xid, msg);
3374     nsm->type = htons(OFPST_VENDOR);
3375     nsm->flags = htons(0);
3376     nsm->vendor = htonl(NX_VENDOR_ID);
3377     nsm->subtype = subtype;
3378     return msg;
3379 }
3380
3381 static struct ofpbuf *
3382 start_nxstats_reply(const struct nicira_stats_msg *request, size_t body_len)
3383 {
3384     return make_nxstats_reply(request->header.xid, request->subtype, body_len);
3385 }
3386
3387 static void
3388 append_nxstats_reply(size_t nbytes, struct ofconn *ofconn,
3389                      struct ofpbuf **msgp)
3390 {
3391     struct ofpbuf *msg = *msgp;
3392     assert(nbytes <= UINT16_MAX - sizeof(struct nicira_stats_msg));
3393     if (nbytes + msg->size > UINT16_MAX) {
3394         struct nicira_stats_msg *reply = msg->data;
3395         reply->flags = htons(OFPSF_REPLY_MORE);
3396         *msgp = make_nxstats_reply(reply->header.xid, reply->subtype, nbytes);
3397         queue_tx(msg, ofconn, ofconn->reply_counter);
3398     }
3399     ofpbuf_prealloc_tailroom(*msgp, nbytes);
3400 }
3401
3402 static int
3403 handle_desc_stats_request(struct ofconn *ofconn,
3404                           const struct ofp_header *request)
3405 {
3406     struct ofproto *p = ofconn->ofproto;
3407     struct ofp_desc_stats *ods;
3408     struct ofpbuf *msg;
3409
3410     msg = start_ofp_stats_reply(request, sizeof *ods);
3411     ods = append_ofp_stats_reply(sizeof *ods, ofconn, &msg);
3412     memset(ods, 0, sizeof *ods);
3413     ovs_strlcpy(ods->mfr_desc, p->mfr_desc, sizeof ods->mfr_desc);
3414     ovs_strlcpy(ods->hw_desc, p->hw_desc, sizeof ods->hw_desc);
3415     ovs_strlcpy(ods->sw_desc, p->sw_desc, sizeof ods->sw_desc);
3416     ovs_strlcpy(ods->serial_num, p->serial_desc, sizeof ods->serial_num);
3417     ovs_strlcpy(ods->dp_desc, p->dp_desc, sizeof ods->dp_desc);
3418     queue_tx(msg, ofconn, ofconn->reply_counter);
3419
3420     return 0;
3421 }
3422
3423 static int
3424 handle_table_stats_request(struct ofconn *ofconn,
3425                            const struct ofp_header *request)
3426 {
3427     struct ofproto *p = ofconn->ofproto;
3428     struct ofp_table_stats *ots;
3429     struct ofpbuf *msg;
3430
3431     msg = start_ofp_stats_reply(request, sizeof *ots * 2);
3432
3433     /* Classifier table. */
3434     ots = append_ofp_stats_reply(sizeof *ots, ofconn, &msg);
3435     memset(ots, 0, sizeof *ots);
3436     strcpy(ots->name, "classifier");
3437     ots->wildcards = (ofconn->flow_format == NXFF_OPENFLOW10
3438                       ? htonl(OFPFW_ALL) : htonl(OVSFW_ALL));
3439     ots->max_entries = htonl(1024 * 1024); /* An arbitrary big number. */
3440     ots->active_count = htonl(classifier_count(&p->cls));
3441     put_32aligned_be64(&ots->lookup_count, htonll(0));  /* XXX */
3442     put_32aligned_be64(&ots->matched_count, htonll(0)); /* XXX */
3443
3444     queue_tx(msg, ofconn, ofconn->reply_counter);
3445     return 0;
3446 }
3447
3448 static void
3449 append_port_stat(struct ofport *port, struct ofconn *ofconn,
3450                  struct ofpbuf **msgp)
3451 {
3452     struct netdev_stats stats;
3453     struct ofp_port_stats *ops;
3454
3455     /* Intentionally ignore return value, since errors will set
3456      * 'stats' to all-1s, which is correct for OpenFlow, and
3457      * netdev_get_stats() will log errors. */
3458     netdev_get_stats(port->netdev, &stats);
3459
3460     ops = append_ofp_stats_reply(sizeof *ops, ofconn, msgp);
3461     ops->port_no = htons(port->opp.port_no);
3462     memset(ops->pad, 0, sizeof ops->pad);
3463     put_32aligned_be64(&ops->rx_packets, htonll(stats.rx_packets));
3464     put_32aligned_be64(&ops->tx_packets, htonll(stats.tx_packets));
3465     put_32aligned_be64(&ops->rx_bytes, htonll(stats.rx_bytes));
3466     put_32aligned_be64(&ops->tx_bytes, htonll(stats.tx_bytes));
3467     put_32aligned_be64(&ops->rx_dropped, htonll(stats.rx_dropped));
3468     put_32aligned_be64(&ops->tx_dropped, htonll(stats.tx_dropped));
3469     put_32aligned_be64(&ops->rx_errors, htonll(stats.rx_errors));
3470     put_32aligned_be64(&ops->tx_errors, htonll(stats.tx_errors));
3471     put_32aligned_be64(&ops->rx_frame_err, htonll(stats.rx_frame_errors));
3472     put_32aligned_be64(&ops->rx_over_err, htonll(stats.rx_over_errors));
3473     put_32aligned_be64(&ops->rx_crc_err, htonll(stats.rx_crc_errors));
3474     put_32aligned_be64(&ops->collisions, htonll(stats.collisions));
3475 }
3476
3477 static int
3478 handle_port_stats_request(struct ofconn *ofconn, const struct ofp_header *oh)
3479 {
3480     struct ofproto *p = ofconn->ofproto;
3481     const struct ofp_port_stats_request *psr = ofputil_stats_body(oh);
3482     struct ofp_port_stats *ops;
3483     struct ofpbuf *msg;
3484     struct ofport *port;
3485
3486     msg = start_ofp_stats_reply(oh, sizeof *ops * 16);
3487     if (psr->port_no != htons(OFPP_NONE)) {
3488         port = get_port(p, ofp_port_to_odp_port(ntohs(psr->port_no)));
3489         if (port) {
3490             append_port_stat(port, ofconn, &msg);
3491         }
3492     } else {
3493         HMAP_FOR_EACH (port, hmap_node, &p->ports) {
3494             append_port_stat(port, ofconn, &msg);
3495         }
3496     }
3497
3498     queue_tx(msg, ofconn, ofconn->reply_counter);
3499     return 0;
3500 }
3501
3502 static void
3503 calc_flow_duration(long long int start, ovs_be32 *sec, ovs_be32 *nsec)
3504 {
3505     long long int msecs = time_msec() - start;
3506     *sec = htonl(msecs / 1000);
3507     *nsec = htonl((msecs % 1000) * (1000 * 1000));
3508 }
3509
3510 static void
3511 put_ofp_flow_stats(struct ofconn *ofconn, struct rule *rule,
3512                    ovs_be16 out_port, struct ofpbuf **replyp)
3513 {
3514     struct ofp_flow_stats *ofs;
3515     uint64_t packet_count, byte_count;
3516     ovs_be64 cookie;
3517     size_t act_len, len;
3518
3519     if (rule_is_hidden(rule) || !rule_has_out_port(rule, out_port)) {
3520         return;
3521     }
3522
3523     act_len = sizeof *rule->actions * rule->n_actions;
3524     len = offsetof(struct ofp_flow_stats, actions) + act_len;
3525
3526     rule_get_stats(rule, &packet_count, &byte_count);
3527
3528     ofs = append_ofp_stats_reply(len, ofconn, replyp);
3529     ofs->length = htons(len);
3530     ofs->table_id = 0;
3531     ofs->pad = 0;
3532     ofputil_cls_rule_to_match(&rule->cr, ofconn->flow_format, &ofs->match,
3533                               rule->flow_cookie, &cookie);
3534     put_32aligned_be64(&ofs->cookie, cookie);
3535     calc_flow_duration(rule->created, &ofs->duration_sec, &ofs->duration_nsec);
3536     ofs->priority = htons(rule->cr.priority);
3537     ofs->idle_timeout = htons(rule->idle_timeout);
3538     ofs->hard_timeout = htons(rule->hard_timeout);
3539     memset(ofs->pad2, 0, sizeof ofs->pad2);
3540     put_32aligned_be64(&ofs->packet_count, htonll(packet_count));
3541     put_32aligned_be64(&ofs->byte_count, htonll(byte_count));
3542     if (rule->n_actions > 0) {
3543         memcpy(ofs->actions, rule->actions, act_len);
3544     }
3545 }
3546
3547 static bool
3548 is_valid_table(uint8_t table_id)
3549 {
3550     if (table_id == 0 || table_id == 0xff) {
3551         return true;
3552     } else {
3553         /* It would probably be better to reply with an error but there doesn't
3554          * seem to be any appropriate value, so that might just be
3555          * confusing. */
3556         VLOG_WARN_RL(&rl, "controller asked for invalid table %"PRIu8,
3557                      table_id);
3558         return false;
3559     }
3560 }
3561
3562 static int
3563 handle_flow_stats_request(struct ofconn *ofconn, const struct ofp_header *oh)
3564 {
3565     const struct ofp_flow_stats_request *fsr = ofputil_stats_body(oh);
3566     struct ofpbuf *reply;
3567
3568     COVERAGE_INC(ofproto_flows_req);
3569     reply = start_ofp_stats_reply(oh, 1024);
3570     if (is_valid_table(fsr->table_id)) {
3571         struct cls_cursor cursor;
3572         struct cls_rule target;
3573         struct rule *rule;
3574
3575         ofputil_cls_rule_from_match(&fsr->match, 0, NXFF_OPENFLOW10, 0,
3576                                     &target);
3577         cls_cursor_init(&cursor, &ofconn->ofproto->cls, &target);
3578         CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
3579             put_ofp_flow_stats(ofconn, rule, fsr->out_port, &reply);
3580         }
3581     }
3582     queue_tx(reply, ofconn, ofconn->reply_counter);
3583
3584     return 0;
3585 }
3586
3587 static void
3588 put_nx_flow_stats(struct ofconn *ofconn, struct rule *rule,
3589                   ovs_be16 out_port, struct ofpbuf **replyp)
3590 {
3591     struct nx_flow_stats *nfs;
3592     uint64_t packet_count, byte_count;
3593     size_t act_len, start_len;
3594     struct ofpbuf *reply;
3595
3596     if (rule_is_hidden(rule) || !rule_has_out_port(rule, out_port)) {
3597         return;
3598     }
3599
3600     rule_get_stats(rule, &packet_count, &byte_count);
3601
3602     act_len = sizeof *rule->actions * rule->n_actions;
3603
3604     append_nxstats_reply(sizeof *nfs + NXM_MAX_LEN + act_len, ofconn, replyp);
3605     start_len = (*replyp)->size;
3606     reply = *replyp;
3607
3608     nfs = ofpbuf_put_uninit(reply, sizeof *nfs);
3609     nfs->table_id = 0;
3610     nfs->pad = 0;
3611     calc_flow_duration(rule->created, &nfs->duration_sec, &nfs->duration_nsec);
3612     nfs->cookie = rule->flow_cookie;
3613     nfs->priority = htons(rule->cr.priority);
3614     nfs->idle_timeout = htons(rule->idle_timeout);
3615     nfs->hard_timeout = htons(rule->hard_timeout);
3616     nfs->match_len = htons(nx_put_match(reply, &rule->cr));
3617     memset(nfs->pad2, 0, sizeof nfs->pad2);
3618     nfs->packet_count = htonll(packet_count);
3619     nfs->byte_count = htonll(byte_count);
3620     if (rule->n_actions > 0) {
3621         ofpbuf_put(reply, rule->actions, act_len);
3622     }
3623     nfs->length = htons(reply->size - start_len);
3624 }
3625
3626 static int
3627 handle_nxst_flow(struct ofconn *ofconn, const struct ofp_header *oh)
3628 {
3629     struct nx_flow_stats_request *nfsr;
3630     struct cls_rule target;
3631     struct ofpbuf *reply;
3632     struct ofpbuf b;
3633     int error;
3634
3635     ofpbuf_use_const(&b, oh, ntohs(oh->length));
3636
3637     /* Dissect the message. */
3638     nfsr = ofpbuf_pull(&b, sizeof *nfsr);
3639     error = nx_pull_match(&b, ntohs(nfsr->match_len), 0, &target);
3640     if (error) {
3641         return error;
3642     }
3643     if (b.size) {
3644         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
3645     }
3646
3647     COVERAGE_INC(ofproto_flows_req);
3648     reply = start_nxstats_reply(&nfsr->nsm, 1024);
3649     if (is_valid_table(nfsr->table_id)) {
3650         struct cls_cursor cursor;
3651         struct rule *rule;
3652
3653         cls_cursor_init(&cursor, &ofconn->ofproto->cls, &target);
3654         CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
3655             put_nx_flow_stats(ofconn, rule, nfsr->out_port, &reply);
3656         }
3657     }
3658     queue_tx(reply, ofconn, ofconn->reply_counter);
3659
3660     return 0;
3661 }
3662
3663 static void
3664 flow_stats_ds(struct rule *rule, struct ds *results)
3665 {
3666     uint64_t packet_count, byte_count;
3667     size_t act_len = sizeof *rule->actions * rule->n_actions;
3668
3669     rule_get_stats(rule, &packet_count, &byte_count);
3670
3671     ds_put_format(results, "duration=%llds, ",
3672                   (time_msec() - rule->created) / 1000);
3673     ds_put_format(results, "idle=%.3fs, ", (time_msec() - rule->used) / 1000.0);
3674     ds_put_format(results, "priority=%u, ", rule->cr.priority);
3675     ds_put_format(results, "n_packets=%"PRIu64", ", packet_count);
3676     ds_put_format(results, "n_bytes=%"PRIu64", ", byte_count);
3677     cls_rule_format(&rule->cr, results);
3678     ds_put_char(results, ',');
3679     if (act_len > 0) {
3680         ofp_print_actions(results, &rule->actions->header, act_len);
3681     } else {
3682         ds_put_cstr(results, "drop");
3683     }
3684     ds_put_cstr(results, "\n");
3685 }
3686
3687 /* Adds a pretty-printed description of all flows to 'results', including
3688  * those marked hidden by secchan (e.g., by in-band control). */
3689 void
3690 ofproto_get_all_flows(struct ofproto *p, struct ds *results)
3691 {
3692     struct cls_cursor cursor;
3693     struct rule *rule;
3694
3695     cls_cursor_init(&cursor, &p->cls, NULL);
3696     CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
3697         flow_stats_ds(rule, results);
3698     }
3699 }
3700
3701 static void
3702 query_aggregate_stats(struct ofproto *ofproto, struct cls_rule *target,
3703                       ovs_be16 out_port, uint8_t table_id,
3704                       struct ofp_aggregate_stats_reply *oasr)
3705 {
3706     uint64_t total_packets = 0;
3707     uint64_t total_bytes = 0;
3708     int n_flows = 0;
3709
3710     COVERAGE_INC(ofproto_agg_request);
3711
3712     if (is_valid_table(table_id)) {
3713         struct cls_cursor cursor;
3714         struct rule *rule;
3715
3716         cls_cursor_init(&cursor, &ofproto->cls, target);
3717         CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
3718             if (!rule_is_hidden(rule) && rule_has_out_port(rule, out_port)) {
3719                 uint64_t packet_count;
3720                 uint64_t byte_count;
3721
3722                 rule_get_stats(rule, &packet_count, &byte_count);
3723
3724                 total_packets += packet_count;
3725                 total_bytes += byte_count;
3726                 n_flows++;
3727             }
3728         }
3729     }
3730
3731     oasr->flow_count = htonl(n_flows);
3732     put_32aligned_be64(&oasr->packet_count, htonll(total_packets));
3733     put_32aligned_be64(&oasr->byte_count, htonll(total_bytes));
3734     memset(oasr->pad, 0, sizeof oasr->pad);
3735 }
3736
3737 static int
3738 handle_aggregate_stats_request(struct ofconn *ofconn,
3739                                const struct ofp_header *oh)
3740 {
3741     const struct ofp_aggregate_stats_request *request = ofputil_stats_body(oh);
3742     struct ofp_aggregate_stats_reply *reply;
3743     struct cls_rule target;
3744     struct ofpbuf *msg;
3745
3746     ofputil_cls_rule_from_match(&request->match, 0, NXFF_OPENFLOW10, 0,
3747                                 &target);
3748
3749     msg = start_ofp_stats_reply(oh, sizeof *reply);
3750     reply = append_ofp_stats_reply(sizeof *reply, ofconn, &msg);
3751     query_aggregate_stats(ofconn->ofproto, &target, request->out_port,
3752                           request->table_id, reply);
3753     queue_tx(msg, ofconn, ofconn->reply_counter);
3754     return 0;
3755 }
3756
3757 static int
3758 handle_nxst_aggregate(struct ofconn *ofconn, const struct ofp_header *oh)
3759 {
3760     struct nx_aggregate_stats_request *request;
3761     struct ofp_aggregate_stats_reply *reply;
3762     struct cls_rule target;
3763     struct ofpbuf b;
3764     struct ofpbuf *buf;
3765     int error;
3766
3767     ofpbuf_use_const(&b, oh, ntohs(oh->length));
3768
3769     /* Dissect the message. */
3770     request = ofpbuf_pull(&b, sizeof *request);
3771     error = nx_pull_match(&b, ntohs(request->match_len), 0, &target);
3772     if (error) {
3773         return error;
3774     }
3775     if (b.size) {
3776         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
3777     }
3778
3779     /* Reply. */
3780     COVERAGE_INC(ofproto_flows_req);
3781     buf = start_nxstats_reply(&request->nsm, sizeof *reply);
3782     reply = ofpbuf_put_uninit(buf, sizeof *reply);
3783     query_aggregate_stats(ofconn->ofproto, &target, request->out_port,
3784                           request->table_id, reply);
3785     queue_tx(buf, ofconn, ofconn->reply_counter);
3786
3787     return 0;
3788 }
3789
3790 struct queue_stats_cbdata {
3791     struct ofconn *ofconn;
3792     struct ofport *ofport;
3793     struct ofpbuf *msg;
3794 };
3795
3796 static void
3797 put_queue_stats(struct queue_stats_cbdata *cbdata, uint32_t queue_id,
3798                 const struct netdev_queue_stats *stats)
3799 {
3800     struct ofp_queue_stats *reply;
3801
3802     reply = append_ofp_stats_reply(sizeof *reply, cbdata->ofconn, &cbdata->msg);
3803     reply->port_no = htons(cbdata->ofport->opp.port_no);
3804     memset(reply->pad, 0, sizeof reply->pad);
3805     reply->queue_id = htonl(queue_id);
3806     put_32aligned_be64(&reply->tx_bytes, htonll(stats->tx_bytes));
3807     put_32aligned_be64(&reply->tx_packets, htonll(stats->tx_packets));
3808     put_32aligned_be64(&reply->tx_errors, htonll(stats->tx_errors));
3809 }
3810
3811 static void
3812 handle_queue_stats_dump_cb(uint32_t queue_id,
3813                            struct netdev_queue_stats *stats,
3814                            void *cbdata_)
3815 {
3816     struct queue_stats_cbdata *cbdata = cbdata_;
3817
3818     put_queue_stats(cbdata, queue_id, stats);
3819 }
3820
3821 static void
3822 handle_queue_stats_for_port(struct ofport *port, uint32_t queue_id,
3823                             struct queue_stats_cbdata *cbdata)
3824 {
3825     cbdata->ofport = port;
3826     if (queue_id == OFPQ_ALL) {
3827         netdev_dump_queue_stats(port->netdev,
3828                                 handle_queue_stats_dump_cb, cbdata);
3829     } else {
3830         struct netdev_queue_stats stats;
3831
3832         if (!netdev_get_queue_stats(port->netdev, queue_id, &stats)) {
3833             put_queue_stats(cbdata, queue_id, &stats);
3834         }
3835     }
3836 }
3837
3838 static int
3839 handle_queue_stats_request(struct ofconn *ofconn, const struct ofp_header *oh)
3840 {
3841     struct ofproto *ofproto = ofconn->ofproto;
3842     const struct ofp_queue_stats_request *qsr;
3843     struct queue_stats_cbdata cbdata;
3844     struct ofport *port;
3845     unsigned int port_no;
3846     uint32_t queue_id;
3847
3848     qsr = ofputil_stats_body(oh);
3849     if (!qsr) {
3850         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
3851     }
3852
3853     COVERAGE_INC(ofproto_queue_req);
3854
3855     cbdata.ofconn = ofconn;
3856     cbdata.msg = start_ofp_stats_reply(oh, 128);
3857
3858     port_no = ntohs(qsr->port_no);
3859     queue_id = ntohl(qsr->queue_id);
3860     if (port_no == OFPP_ALL) {
3861         HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
3862             handle_queue_stats_for_port(port, queue_id, &cbdata);
3863         }
3864     } else if (port_no < ofproto->max_ports) {
3865         port = get_port(ofproto, ofp_port_to_odp_port(port_no));
3866         if (port) {
3867             handle_queue_stats_for_port(port, queue_id, &cbdata);
3868         }
3869     } else {
3870         ofpbuf_delete(cbdata.msg);
3871         return ofp_mkerr(OFPET_QUEUE_OP_FAILED, OFPQOFC_BAD_PORT);
3872     }
3873     queue_tx(cbdata.msg, ofconn, ofconn->reply_counter);
3874
3875     return 0;
3876 }
3877
3878 /* Updates 'facet''s used time.  Caller is responsible for calling
3879  * facet_push_stats() to update the flows which 'facet' resubmits into. */
3880 static void
3881 facet_update_time(struct ofproto *ofproto, struct facet *facet,
3882                   long long int used)
3883 {
3884     if (used > facet->used) {
3885         facet->used = used;
3886         if (used > facet->rule->used) {
3887             facet->rule->used = used;
3888         }
3889         netflow_flow_update_time(ofproto->netflow, &facet->nf_flow, used);
3890     }
3891 }
3892
3893 /* Folds the statistics from 'stats' into the counters in 'facet'.
3894  *
3895  * Because of the meaning of a facet's counters, it only makes sense to do this
3896  * if 'stats' are not tracked in the datapath, that is, if 'stats' represents a
3897  * packet that was sent by hand or if it represents statistics that have been
3898  * cleared out of the datapath. */
3899 static void
3900 facet_update_stats(struct ofproto *ofproto, struct facet *facet,
3901                    const struct dpif_flow_stats *stats)
3902 {
3903     if (stats->n_packets || stats->used > facet->used) {
3904         facet_update_time(ofproto, facet, stats->used);
3905         facet->packet_count += stats->n_packets;
3906         facet->byte_count += stats->n_bytes;
3907         facet_push_stats(ofproto, facet);
3908         netflow_flow_update_flags(&facet->nf_flow, stats->tcp_flags);
3909     }
3910 }
3911
3912 static void
3913 facet_push_stats(struct ofproto *ofproto, struct facet *facet)
3914 {
3915     uint64_t rs_packets, rs_bytes;
3916
3917     assert(facet->packet_count >= facet->rs_packet_count);
3918     assert(facet->byte_count >= facet->rs_byte_count);
3919     assert(facet->used >= facet->rs_used);
3920
3921     rs_packets = facet->packet_count - facet->rs_packet_count;
3922     rs_bytes = facet->byte_count - facet->rs_byte_count;
3923
3924     if (rs_packets || rs_bytes || facet->used > facet->rs_used) {
3925         facet->rs_packet_count = facet->packet_count;
3926         facet->rs_byte_count = facet->byte_count;
3927         facet->rs_used = facet->used;
3928
3929         flow_push_stats(ofproto, facet->rule, &facet->flow,
3930                         rs_packets, rs_bytes, facet->used);
3931     }
3932 }
3933
3934 struct ofproto_push {
3935     struct action_xlate_ctx ctx;
3936     uint64_t packets;
3937     uint64_t bytes;
3938     long long int used;
3939 };
3940
3941 static void
3942 push_resubmit(struct action_xlate_ctx *ctx, struct rule *rule)
3943 {
3944     struct ofproto_push *push = CONTAINER_OF(ctx, struct ofproto_push, ctx);
3945
3946     if (rule) {
3947         rule->packet_count += push->packets;
3948         rule->byte_count += push->bytes;
3949         rule->used = MAX(push->used, rule->used);
3950     }
3951 }
3952
3953 /* Pushes flow statistics to the rules which 'flow' resubmits into given
3954  * 'rule''s actions. */
3955 static void
3956 flow_push_stats(struct ofproto *ofproto, const struct rule *rule,
3957                 struct flow *flow, uint64_t packets, uint64_t bytes,
3958                 long long int used)
3959 {
3960     struct ofproto_push push;
3961
3962     push.packets = packets;
3963     push.bytes = bytes;
3964     push.used = used;
3965
3966     action_xlate_ctx_init(&push.ctx, ofproto, flow, NULL);
3967     push.ctx.resubmit_hook = push_resubmit;
3968     ofpbuf_delete(xlate_actions(&push.ctx, rule->actions, rule->n_actions));
3969 }
3970
3971 /* Implements OFPFC_ADD and the cases for OFPFC_MODIFY and OFPFC_MODIFY_STRICT
3972  * in which no matching flow already exists in the flow table.
3973  *
3974  * Adds the flow specified by 'ofm', which is followed by 'n_actions'
3975  * ofp_actions, to ofconn->ofproto's flow table.  Returns 0 on success or an
3976  * OpenFlow error code as encoded by ofp_mkerr() on failure.
3977  *
3978  * 'ofconn' is used to retrieve the packet buffer specified in ofm->buffer_id,
3979  * if any. */
3980 static int
3981 add_flow(struct ofconn *ofconn, struct flow_mod *fm)
3982 {
3983     struct ofproto *p = ofconn->ofproto;
3984     struct ofpbuf *packet;
3985     struct rule *rule;
3986     uint16_t in_port;
3987     int error;
3988
3989     if (fm->flags & OFPFF_CHECK_OVERLAP
3990         && classifier_rule_overlaps(&p->cls, &fm->cr)) {
3991         return ofp_mkerr(OFPET_FLOW_MOD_FAILED, OFPFMFC_OVERLAP);
3992     }
3993
3994     error = 0;
3995     if (fm->buffer_id != UINT32_MAX) {
3996         error = pktbuf_retrieve(ofconn->pktbuf, fm->buffer_id,
3997                                 &packet, &in_port);
3998     } else {
3999         packet = NULL;
4000         in_port = UINT16_MAX;
4001     }
4002
4003     rule = rule_create(&fm->cr, fm->actions, fm->n_actions,
4004                        fm->idle_timeout, fm->hard_timeout, fm->cookie,
4005                        fm->flags & OFPFF_SEND_FLOW_REM);
4006     rule_insert(p, rule);
4007     if (packet) {
4008         rule_execute(p, rule, in_port, packet);
4009     }
4010     return error;
4011 }
4012
4013 static struct rule *
4014 find_flow_strict(struct ofproto *p, const struct flow_mod *fm)
4015 {
4016     return rule_from_cls_rule(classifier_find_rule_exactly(&p->cls, &fm->cr));
4017 }
4018
4019 static int
4020 send_buffered_packet(struct ofconn *ofconn,
4021                      struct rule *rule, uint32_t buffer_id)
4022 {
4023     struct ofpbuf *packet;
4024     uint16_t in_port;
4025     int error;
4026
4027     if (buffer_id == UINT32_MAX) {
4028         return 0;
4029     }
4030
4031     error = pktbuf_retrieve(ofconn->pktbuf, buffer_id, &packet, &in_port);
4032     if (error) {
4033         return error;
4034     }
4035
4036     rule_execute(ofconn->ofproto, rule, in_port, packet);
4037
4038     return 0;
4039 }
4040 \f
4041 /* OFPFC_MODIFY and OFPFC_MODIFY_STRICT. */
4042
4043 struct modify_flows_cbdata {
4044     struct ofproto *ofproto;
4045     const struct flow_mod *fm;
4046     struct rule *match;
4047 };
4048
4049 static int modify_flow(struct ofproto *, const struct flow_mod *,
4050                        struct rule *);
4051
4052 /* Implements OFPFC_MODIFY.  Returns 0 on success or an OpenFlow error code as
4053  * encoded by ofp_mkerr() on failure.
4054  *
4055  * 'ofconn' is used to retrieve the packet buffer specified in ofm->buffer_id,
4056  * if any. */
4057 static int
4058 modify_flows_loose(struct ofconn *ofconn, struct flow_mod *fm)
4059 {
4060     struct ofproto *p = ofconn->ofproto;
4061     struct rule *match = NULL;
4062     struct cls_cursor cursor;
4063     struct rule *rule;
4064
4065     cls_cursor_init(&cursor, &p->cls, &fm->cr);
4066     CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
4067         if (!rule_is_hidden(rule)) {
4068             match = rule;
4069             modify_flow(p, fm, rule);
4070         }
4071     }
4072
4073     if (match) {
4074         /* This credits the packet to whichever flow happened to match last.
4075          * That's weird.  Maybe we should do a lookup for the flow that
4076          * actually matches the packet?  Who knows. */
4077         send_buffered_packet(ofconn, match, fm->buffer_id);
4078         return 0;
4079     } else {
4080         return add_flow(ofconn, fm);
4081     }
4082 }
4083
4084 /* Implements OFPFC_MODIFY_STRICT.  Returns 0 on success or an OpenFlow error
4085  * code as encoded by ofp_mkerr() on failure.
4086  *
4087  * 'ofconn' is used to retrieve the packet buffer specified in ofm->buffer_id,
4088  * if any. */
4089 static int
4090 modify_flow_strict(struct ofconn *ofconn, struct flow_mod *fm)
4091 {
4092     struct ofproto *p = ofconn->ofproto;
4093     struct rule *rule = find_flow_strict(p, fm);
4094     if (rule && !rule_is_hidden(rule)) {
4095         modify_flow(p, fm, rule);
4096         return send_buffered_packet(ofconn, rule, fm->buffer_id);
4097     } else {
4098         return add_flow(ofconn, fm);
4099     }
4100 }
4101
4102 /* Implements core of OFPFC_MODIFY and OFPFC_MODIFY_STRICT where 'rule' has
4103  * been identified as a flow in 'p''s flow table to be modified, by changing
4104  * the rule's actions to match those in 'ofm' (which is followed by 'n_actions'
4105  * ofp_action[] structures). */
4106 static int
4107 modify_flow(struct ofproto *p, const struct flow_mod *fm, struct rule *rule)
4108 {
4109     size_t actions_len = fm->n_actions * sizeof *rule->actions;
4110
4111     rule->flow_cookie = fm->cookie;
4112
4113     /* If the actions are the same, do nothing. */
4114     if (fm->n_actions == rule->n_actions
4115         && (!fm->n_actions
4116             || !memcmp(fm->actions, rule->actions, actions_len))) {
4117         return 0;
4118     }
4119
4120     /* Replace actions. */
4121     free(rule->actions);
4122     rule->actions = fm->n_actions ? xmemdup(fm->actions, actions_len) : NULL;
4123     rule->n_actions = fm->n_actions;
4124
4125     p->need_revalidate = true;
4126
4127     return 0;
4128 }
4129 \f
4130 /* OFPFC_DELETE implementation. */
4131
4132 static void delete_flow(struct ofproto *, struct rule *, ovs_be16 out_port);
4133
4134 /* Implements OFPFC_DELETE. */
4135 static void
4136 delete_flows_loose(struct ofproto *p, const struct flow_mod *fm)
4137 {
4138     struct rule *rule, *next_rule;
4139     struct cls_cursor cursor;
4140
4141     cls_cursor_init(&cursor, &p->cls, &fm->cr);
4142     CLS_CURSOR_FOR_EACH_SAFE (rule, next_rule, cr, &cursor) {
4143         delete_flow(p, rule, htons(fm->out_port));
4144     }
4145 }
4146
4147 /* Implements OFPFC_DELETE_STRICT. */
4148 static void
4149 delete_flow_strict(struct ofproto *p, struct flow_mod *fm)
4150 {
4151     struct rule *rule = find_flow_strict(p, fm);
4152     if (rule) {
4153         delete_flow(p, rule, htons(fm->out_port));
4154     }
4155 }
4156
4157 /* Implements core of OFPFC_DELETE and OFPFC_DELETE_STRICT where 'rule' has
4158  * been identified as a flow to delete from 'p''s flow table, by deleting the
4159  * flow and sending out a OFPT_FLOW_REMOVED message to any interested
4160  * controller.
4161  *
4162  * Will not delete 'rule' if it is hidden.  Will delete 'rule' only if
4163  * 'out_port' is htons(OFPP_NONE) or if 'rule' actually outputs to the
4164  * specified 'out_port'. */
4165 static void
4166 delete_flow(struct ofproto *p, struct rule *rule, ovs_be16 out_port)
4167 {
4168     if (rule_is_hidden(rule)) {
4169         return;
4170     }
4171
4172     if (out_port != htons(OFPP_NONE) && !rule_has_out_port(rule, out_port)) {
4173         return;
4174     }
4175
4176     rule_send_removed(p, rule, OFPRR_DELETE);
4177     rule_remove(p, rule);
4178 }
4179 \f
4180 static int
4181 handle_flow_mod(struct ofconn *ofconn, const struct ofp_header *oh)
4182 {
4183     struct ofproto *p = ofconn->ofproto;
4184     struct flow_mod fm;
4185     int error;
4186
4187     error = reject_slave_controller(ofconn, "flow_mod");
4188     if (error) {
4189         return error;
4190     }
4191
4192     error = ofputil_decode_flow_mod(&fm, oh, ofconn->flow_format);
4193     if (error) {
4194         return error;
4195     }
4196
4197     /* We do not support the emergency flow cache.  It will hopefully get
4198      * dropped from OpenFlow in the near future. */
4199     if (fm.flags & OFPFF_EMERG) {
4200         /* There isn't a good fit for an error code, so just state that the
4201          * flow table is full. */
4202         return ofp_mkerr(OFPET_FLOW_MOD_FAILED, OFPFMFC_ALL_TABLES_FULL);
4203     }
4204
4205     error = validate_actions(fm.actions, fm.n_actions,
4206                              &fm.cr.flow, p->max_ports);
4207     if (error) {
4208         return error;
4209     }
4210
4211     switch (fm.command) {
4212     case OFPFC_ADD:
4213         return add_flow(ofconn, &fm);
4214
4215     case OFPFC_MODIFY:
4216         return modify_flows_loose(ofconn, &fm);
4217
4218     case OFPFC_MODIFY_STRICT:
4219         return modify_flow_strict(ofconn, &fm);
4220
4221     case OFPFC_DELETE:
4222         delete_flows_loose(p, &fm);
4223         return 0;
4224
4225     case OFPFC_DELETE_STRICT:
4226         delete_flow_strict(p, &fm);
4227         return 0;
4228
4229     default:
4230         return ofp_mkerr(OFPET_FLOW_MOD_FAILED, OFPFMFC_BAD_COMMAND);
4231     }
4232 }
4233
4234 static int
4235 handle_tun_id_from_cookie(struct ofconn *ofconn, const struct ofp_header *oh)
4236 {
4237     const struct nxt_tun_id_cookie *msg
4238         = (const struct nxt_tun_id_cookie *) oh;
4239
4240     ofconn->flow_format = msg->set ? NXFF_TUN_ID_FROM_COOKIE : NXFF_OPENFLOW10;
4241     return 0;
4242 }
4243
4244 static int
4245 handle_role_request(struct ofconn *ofconn, const struct ofp_header *oh)
4246 {
4247     struct nx_role_request *nrr = (struct nx_role_request *) oh;
4248     struct nx_role_request *reply;
4249     struct ofpbuf *buf;
4250     uint32_t role;
4251
4252     if (ofconn->type != OFCONN_PRIMARY) {
4253         VLOG_WARN_RL(&rl, "ignoring role request on non-controller "
4254                      "connection");
4255         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_EPERM);
4256     }
4257
4258     role = ntohl(nrr->role);
4259     if (role != NX_ROLE_OTHER && role != NX_ROLE_MASTER
4260         && role != NX_ROLE_SLAVE) {
4261         VLOG_WARN_RL(&rl, "received request for unknown role %"PRIu32, role);
4262
4263         /* There's no good error code for this. */
4264         return ofp_mkerr(OFPET_BAD_REQUEST, -1);
4265     }
4266
4267     if (role == NX_ROLE_MASTER) {
4268         struct ofconn *other;
4269
4270         HMAP_FOR_EACH (other, hmap_node, &ofconn->ofproto->controllers) {
4271             if (other->role == NX_ROLE_MASTER) {
4272                 other->role = NX_ROLE_SLAVE;
4273             }
4274         }
4275     }
4276     ofconn->role = role;
4277
4278     reply = make_nxmsg_xid(sizeof *reply, NXT_ROLE_REPLY, oh->xid, &buf);
4279     reply->role = htonl(role);
4280     queue_tx(buf, ofconn, ofconn->reply_counter);
4281
4282     return 0;
4283 }
4284
4285 static int
4286 handle_nxt_set_flow_format(struct ofconn *ofconn, const struct ofp_header *oh)
4287 {
4288     const struct nxt_set_flow_format *msg
4289         = (const struct nxt_set_flow_format *) oh;
4290     uint32_t format;
4291
4292     format = ntohl(msg->format);
4293     if (format == NXFF_OPENFLOW10
4294         || format == NXFF_TUN_ID_FROM_COOKIE
4295         || format == NXFF_NXM) {
4296         ofconn->flow_format = format;
4297         return 0;
4298     } else {
4299         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_EPERM);
4300     }
4301 }
4302
4303 static int
4304 handle_barrier_request(struct ofconn *ofconn, const struct ofp_header *oh)
4305 {
4306     struct ofp_header *ob;
4307     struct ofpbuf *buf;
4308
4309     /* Currently, everything executes synchronously, so we can just
4310      * immediately send the barrier reply. */
4311     ob = make_openflow_xid(sizeof *ob, OFPT_BARRIER_REPLY, oh->xid, &buf);
4312     queue_tx(buf, ofconn, ofconn->reply_counter);
4313     return 0;
4314 }
4315
4316 static int
4317 handle_openflow__(struct ofconn *ofconn, const struct ofpbuf *msg)
4318 {
4319     const struct ofp_header *oh = msg->data;
4320     const struct ofputil_msg_type *type;
4321     int error;
4322
4323     error = ofputil_decode_msg_type(oh, &type);
4324     if (error) {
4325         return error;
4326     }
4327
4328     switch (ofputil_msg_type_code(type)) {
4329         /* OpenFlow requests. */
4330     case OFPUTIL_OFPT_ECHO_REQUEST:
4331         return handle_echo_request(ofconn, oh);
4332
4333     case OFPUTIL_OFPT_FEATURES_REQUEST:
4334         return handle_features_request(ofconn, oh);
4335
4336     case OFPUTIL_OFPT_GET_CONFIG_REQUEST:
4337         return handle_get_config_request(ofconn, oh);
4338
4339     case OFPUTIL_OFPT_SET_CONFIG:
4340         return handle_set_config(ofconn, msg->data);
4341
4342     case OFPUTIL_OFPT_PACKET_OUT:
4343         return handle_packet_out(ofconn, oh);
4344
4345     case OFPUTIL_OFPT_PORT_MOD:
4346         return handle_port_mod(ofconn, oh);
4347
4348     case OFPUTIL_OFPT_FLOW_MOD:
4349         return handle_flow_mod(ofconn, oh);
4350
4351     case OFPUTIL_OFPT_BARRIER_REQUEST:
4352         return handle_barrier_request(ofconn, oh);
4353
4354         /* OpenFlow replies. */
4355     case OFPUTIL_OFPT_ECHO_REPLY:
4356         return 0;
4357
4358         /* Nicira extension requests. */
4359     case OFPUTIL_NXT_STATUS_REQUEST:
4360         return switch_status_handle_request(
4361             ofconn->ofproto->switch_status, ofconn->rconn, oh);
4362
4363     case OFPUTIL_NXT_TUN_ID_FROM_COOKIE:
4364         return handle_tun_id_from_cookie(ofconn, oh);
4365
4366     case OFPUTIL_NXT_ROLE_REQUEST:
4367         return handle_role_request(ofconn, oh);
4368
4369     case OFPUTIL_NXT_SET_FLOW_FORMAT:
4370         return handle_nxt_set_flow_format(ofconn, oh);
4371
4372     case OFPUTIL_NXT_FLOW_MOD:
4373         return handle_flow_mod(ofconn, oh);
4374
4375         /* OpenFlow statistics requests. */
4376     case OFPUTIL_OFPST_DESC_REQUEST:
4377         return handle_desc_stats_request(ofconn, oh);
4378
4379     case OFPUTIL_OFPST_FLOW_REQUEST:
4380         return handle_flow_stats_request(ofconn, oh);
4381
4382     case OFPUTIL_OFPST_AGGREGATE_REQUEST:
4383         return handle_aggregate_stats_request(ofconn, oh);
4384
4385     case OFPUTIL_OFPST_TABLE_REQUEST:
4386         return handle_table_stats_request(ofconn, oh);
4387
4388     case OFPUTIL_OFPST_PORT_REQUEST:
4389         return handle_port_stats_request(ofconn, oh);
4390
4391     case OFPUTIL_OFPST_QUEUE_REQUEST:
4392         return handle_queue_stats_request(ofconn, oh);
4393
4394         /* Nicira extension statistics requests. */
4395     case OFPUTIL_NXST_FLOW_REQUEST:
4396         return handle_nxst_flow(ofconn, oh);
4397
4398     case OFPUTIL_NXST_AGGREGATE_REQUEST:
4399         return handle_nxst_aggregate(ofconn, oh);
4400
4401     case OFPUTIL_INVALID:
4402     case OFPUTIL_OFPT_HELLO:
4403     case OFPUTIL_OFPT_ERROR:
4404     case OFPUTIL_OFPT_FEATURES_REPLY:
4405     case OFPUTIL_OFPT_GET_CONFIG_REPLY:
4406     case OFPUTIL_OFPT_PACKET_IN:
4407     case OFPUTIL_OFPT_FLOW_REMOVED:
4408     case OFPUTIL_OFPT_PORT_STATUS:
4409     case OFPUTIL_OFPT_BARRIER_REPLY:
4410     case OFPUTIL_OFPT_QUEUE_GET_CONFIG_REQUEST:
4411     case OFPUTIL_OFPT_QUEUE_GET_CONFIG_REPLY:
4412     case OFPUTIL_OFPST_DESC_REPLY:
4413     case OFPUTIL_OFPST_FLOW_REPLY:
4414     case OFPUTIL_OFPST_QUEUE_REPLY:
4415     case OFPUTIL_OFPST_PORT_REPLY:
4416     case OFPUTIL_OFPST_TABLE_REPLY:
4417     case OFPUTIL_OFPST_AGGREGATE_REPLY:
4418     case OFPUTIL_NXT_STATUS_REPLY:
4419     case OFPUTIL_NXT_ROLE_REPLY:
4420     case OFPUTIL_NXT_FLOW_REMOVED:
4421     case OFPUTIL_NXST_FLOW_REPLY:
4422     case OFPUTIL_NXST_AGGREGATE_REPLY:
4423     default:
4424         if (VLOG_IS_WARN_ENABLED()) {
4425             char *s = ofp_to_string(oh, ntohs(oh->length), 2);
4426             VLOG_DBG_RL(&rl, "OpenFlow message ignored: %s", s);
4427             free(s);
4428         }
4429         if (oh->type == OFPT_STATS_REQUEST || oh->type == OFPT_STATS_REPLY) {
4430             return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_STAT);
4431         } else {
4432             return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_TYPE);
4433         }
4434     }
4435 }
4436
4437 static void
4438 handle_openflow(struct ofconn *ofconn, struct ofpbuf *ofp_msg)
4439 {
4440     int error = handle_openflow__(ofconn, ofp_msg);
4441     if (error) {
4442         send_error_oh(ofconn, ofp_msg->data, error);
4443     }
4444     COVERAGE_INC(ofproto_recv_openflow);
4445 }
4446 \f
4447 static void
4448 handle_miss_upcall(struct ofproto *p, struct dpif_upcall *upcall)
4449 {
4450     struct facet *facet;
4451     struct flow flow;
4452
4453     /* Obtain in_port and tun_id, at least. */
4454     odp_flow_key_to_flow(upcall->key, upcall->key_len, &flow);
4455
4456     /* Set header pointers in 'flow'. */
4457     flow_extract(upcall->packet, flow.tun_id, flow.in_port, &flow);
4458
4459     if (p->ofhooks->special_cb
4460         && !p->ofhooks->special_cb(&flow, upcall->packet, p->aux)) {
4461         ofpbuf_delete(upcall->packet);
4462         return;
4463     }
4464
4465     /* Check with in-band control to see if this packet should be sent
4466      * to the local port regardless of the flow table. */
4467     if (in_band_msg_in_hook(p->in_band, &flow, upcall->packet)) {
4468         struct ofpbuf odp_actions;
4469
4470         ofpbuf_init(&odp_actions, 32);
4471         nl_msg_put_u32(&odp_actions, ODP_ACTION_ATTR_OUTPUT, ODPP_LOCAL);
4472         dpif_execute(p->dpif, odp_actions.data, odp_actions.size,
4473                      upcall->packet);
4474         ofpbuf_uninit(&odp_actions);
4475     }
4476
4477     facet = facet_lookup_valid(p, &flow);
4478     if (!facet) {
4479         struct rule *rule = rule_lookup(p, &flow);
4480         if (!rule) {
4481             /* Don't send a packet-in if OFPPC_NO_PACKET_IN asserted. */
4482             struct ofport *port = get_port(p, flow.in_port);
4483             if (port) {
4484                 if (port->opp.config & OFPPC_NO_PACKET_IN) {
4485                     COVERAGE_INC(ofproto_no_packet_in);
4486                     /* XXX install 'drop' flow entry */
4487                     ofpbuf_delete(upcall->packet);
4488                     return;
4489                 }
4490             } else {
4491                 VLOG_WARN_RL(&rl, "packet-in on unknown port %"PRIu16,
4492                              flow.in_port);
4493             }
4494
4495             COVERAGE_INC(ofproto_packet_in);
4496             send_packet_in(p, upcall, &flow, false);
4497             return;
4498         }
4499
4500         facet = facet_create(p, rule, &flow, upcall->packet);
4501     } else if (!facet->may_install) {
4502         /* The facet is not installable, that is, we need to process every
4503          * packet, so process the current packet's actions into 'facet'. */
4504         facet_make_actions(p, facet, upcall->packet);
4505     }
4506
4507     if (facet->rule->cr.priority == FAIL_OPEN_PRIORITY) {
4508         /*
4509          * Extra-special case for fail-open mode.
4510          *
4511          * We are in fail-open mode and the packet matched the fail-open rule,
4512          * but we are connected to a controller too.  We should send the packet
4513          * up to the controller in the hope that it will try to set up a flow
4514          * and thereby allow us to exit fail-open.
4515          *
4516          * See the top-level comment in fail-open.c for more information.
4517          */
4518         send_packet_in(p, upcall, &flow, true);
4519     }
4520
4521     facet_execute(p, facet, upcall->packet);
4522     facet_install(p, facet, false);
4523 }
4524
4525 static void
4526 handle_upcall(struct ofproto *p, struct dpif_upcall *upcall)
4527 {
4528     struct flow flow;
4529
4530     switch (upcall->type) {
4531     case DPIF_UC_ACTION:
4532         COVERAGE_INC(ofproto_ctlr_action);
4533         odp_flow_key_to_flow(upcall->key, upcall->key_len, &flow);
4534         send_packet_in(p, upcall, &flow, false);
4535         break;
4536
4537     case DPIF_UC_SAMPLE:
4538         if (p->sflow) {
4539             odp_flow_key_to_flow(upcall->key, upcall->key_len, &flow);
4540             ofproto_sflow_received(p->sflow, upcall, &flow);
4541         }
4542         ofpbuf_delete(upcall->packet);
4543         break;
4544
4545     case DPIF_UC_MISS:
4546         handle_miss_upcall(p, upcall);
4547         break;
4548
4549     case DPIF_N_UC_TYPES:
4550     default:
4551         VLOG_WARN_RL(&rl, "upcall has unexpected type %"PRIu32, upcall->type);
4552         break;
4553     }
4554 }
4555 \f
4556 /* Flow expiration. */
4557
4558 static int ofproto_dp_max_idle(const struct ofproto *);
4559 static void ofproto_update_stats(struct ofproto *);
4560 static void rule_expire(struct ofproto *, struct rule *);
4561 static void ofproto_expire_facets(struct ofproto *, int dp_max_idle);
4562
4563 /* This function is called periodically by ofproto_run().  Its job is to
4564  * collect updates for the flows that have been installed into the datapath,
4565  * most importantly when they last were used, and then use that information to
4566  * expire flows that have not been used recently.
4567  *
4568  * Returns the number of milliseconds after which it should be called again. */
4569 static int
4570 ofproto_expire(struct ofproto *ofproto)
4571 {
4572     struct rule *rule, *next_rule;
4573     struct cls_cursor cursor;
4574     int dp_max_idle;
4575
4576     /* Update stats for each flow in the datapath. */
4577     ofproto_update_stats(ofproto);
4578
4579     /* Expire facets that have been idle too long. */
4580     dp_max_idle = ofproto_dp_max_idle(ofproto);
4581     ofproto_expire_facets(ofproto, dp_max_idle);
4582
4583     /* Expire OpenFlow flows whose idle_timeout or hard_timeout has passed. */
4584     cls_cursor_init(&cursor, &ofproto->cls, NULL);
4585     CLS_CURSOR_FOR_EACH_SAFE (rule, next_rule, cr, &cursor) {
4586         rule_expire(ofproto, rule);
4587     }
4588
4589     /* Let the hook know that we're at a stable point: all outstanding data
4590      * in existing flows has been accounted to the account_cb.  Thus, the
4591      * hook can now reasonably do operations that depend on having accurate
4592      * flow volume accounting (currently, that's just bond rebalancing). */
4593     if (ofproto->ofhooks->account_checkpoint_cb) {
4594         ofproto->ofhooks->account_checkpoint_cb(ofproto->aux);
4595     }
4596
4597     return MIN(dp_max_idle, 1000);
4598 }
4599
4600 /* Update 'packet_count', 'byte_count', and 'used' members of installed facets.
4601  *
4602  * This function also pushes statistics updates to rules which each facet
4603  * resubmits into.  Generally these statistics will be accurate.  However, if a
4604  * facet changes the rule it resubmits into at some time in between
4605  * ofproto_update_stats() runs, it is possible that statistics accrued to the
4606  * old rule will be incorrectly attributed to the new rule.  This could be
4607  * avoided by calling ofproto_update_stats() whenever rules are created or
4608  * deleted.  However, the performance impact of making so many calls to the
4609  * datapath do not justify the benefit of having perfectly accurate statistics.
4610  */
4611 static void
4612 ofproto_update_stats(struct ofproto *p)
4613 {
4614     const struct dpif_flow_stats *stats;
4615     struct dpif_flow_dump dump;
4616     const struct nlattr *key;
4617     size_t key_len;
4618
4619     dpif_flow_dump_start(&dump, p->dpif);
4620     while (dpif_flow_dump_next(&dump, &key, &key_len, NULL, NULL, &stats)) {
4621         struct facet *facet;
4622         struct flow flow;
4623
4624         if (odp_flow_key_to_flow(key, key_len, &flow)) {
4625             struct ds s;
4626
4627             ds_init(&s);
4628             odp_flow_key_format(key, key_len, &s);
4629             VLOG_WARN_RL(&rl, "failed to convert ODP flow key to flow: %s",
4630                          ds_cstr(&s));
4631             ds_destroy(&s);
4632
4633             continue;
4634         }
4635         facet = facet_find(p, &flow);
4636
4637         if (facet && facet->installed) {
4638
4639             if (stats->n_packets >= facet->dp_packet_count) {
4640                 facet->packet_count += stats->n_packets - facet->dp_packet_count;
4641             } else {
4642                 VLOG_WARN_RL(&rl, "unexpected packet count from the datapath");
4643             }
4644
4645             if (stats->n_bytes >= facet->dp_byte_count) {
4646                 facet->byte_count += stats->n_bytes - facet->dp_byte_count;
4647             } else {
4648                 VLOG_WARN_RL(&rl, "unexpected byte count from datapath");
4649             }
4650
4651             facet->dp_packet_count = stats->n_packets;
4652             facet->dp_byte_count = stats->n_bytes;
4653
4654             facet_update_time(p, facet, stats->used);
4655             facet_account(p, facet, stats->n_bytes);
4656             facet_push_stats(p, facet);
4657         } else {
4658             /* There's a flow in the datapath that we know nothing about.
4659              * Delete it. */
4660             COVERAGE_INC(ofproto_unexpected_rule);
4661             dpif_flow_del(p->dpif, key, key_len, NULL);
4662         }
4663     }
4664     dpif_flow_dump_done(&dump);
4665 }
4666
4667 /* Calculates and returns the number of milliseconds of idle time after which
4668  * facets should expire from the datapath and we should fold their statistics
4669  * into their parent rules in userspace. */
4670 static int
4671 ofproto_dp_max_idle(const struct ofproto *ofproto)
4672 {
4673     /*
4674      * Idle time histogram.
4675      *
4676      * Most of the time a switch has a relatively small number of facets.  When
4677      * this is the case we might as well keep statistics for all of them in
4678      * userspace and to cache them in the kernel datapath for performance as
4679      * well.
4680      *
4681      * As the number of facets increases, the memory required to maintain
4682      * statistics about them in userspace and in the kernel becomes
4683      * significant.  However, with a large number of facets it is likely that
4684      * only a few of them are "heavy hitters" that consume a large amount of
4685      * bandwidth.  At this point, only heavy hitters are worth caching in the
4686      * kernel and maintaining in userspaces; other facets we can discard.
4687      *
4688      * The technique used to compute the idle time is to build a histogram with
4689      * N_BUCKETS buckets whose width is BUCKET_WIDTH msecs each.  Each facet
4690      * that is installed in the kernel gets dropped in the appropriate bucket.
4691      * After the histogram has been built, we compute the cutoff so that only
4692      * the most-recently-used 1% of facets (but at least 1000 flows) are kept
4693      * cached.  At least the most-recently-used bucket of facets is kept, so
4694      * actually an arbitrary number of facets can be kept in any given
4695      * expiration run (though the next run will delete most of those unless
4696      * they receive additional data).
4697      *
4698      * This requires a second pass through the facets, in addition to the pass
4699      * made by ofproto_update_stats(), because the former function never looks
4700      * at uninstallable facets.
4701      */
4702     enum { BUCKET_WIDTH = ROUND_UP(100, TIME_UPDATE_INTERVAL) };
4703     enum { N_BUCKETS = 5000 / BUCKET_WIDTH };
4704     int buckets[N_BUCKETS] = { 0 };
4705     struct facet *facet;
4706     int total, bucket;
4707     long long int now;
4708     int i;
4709
4710     total = hmap_count(&ofproto->facets);
4711     if (total <= 1000) {
4712         return N_BUCKETS * BUCKET_WIDTH;
4713     }
4714
4715     /* Build histogram. */
4716     now = time_msec();
4717     HMAP_FOR_EACH (facet, hmap_node, &ofproto->facets) {
4718         long long int idle = now - facet->used;
4719         int bucket = (idle <= 0 ? 0
4720                       : idle >= BUCKET_WIDTH * N_BUCKETS ? N_BUCKETS - 1
4721                       : (unsigned int) idle / BUCKET_WIDTH);
4722         buckets[bucket]++;
4723     }
4724
4725     /* Find the first bucket whose flows should be expired. */
4726     for (bucket = 0; bucket < N_BUCKETS; bucket++) {
4727         if (buckets[bucket]) {
4728             int subtotal = 0;
4729             do {
4730                 subtotal += buckets[bucket++];
4731             } while (bucket < N_BUCKETS && subtotal < MAX(1000, total / 100));
4732             break;
4733         }
4734     }
4735
4736     if (VLOG_IS_DBG_ENABLED()) {
4737         struct ds s;
4738
4739         ds_init(&s);
4740         ds_put_cstr(&s, "keep");
4741         for (i = 0; i < N_BUCKETS; i++) {
4742             if (i == bucket) {
4743                 ds_put_cstr(&s, ", drop");
4744             }
4745             if (buckets[i]) {
4746                 ds_put_format(&s, " %d:%d", i * BUCKET_WIDTH, buckets[i]);
4747             }
4748         }
4749         VLOG_INFO("%s: %s (msec:count)",
4750                   dpif_name(ofproto->dpif), ds_cstr(&s));
4751         ds_destroy(&s);
4752     }
4753
4754     return bucket * BUCKET_WIDTH;
4755 }
4756
4757 static void
4758 facet_active_timeout(struct ofproto *ofproto, struct facet *facet)
4759 {
4760     if (ofproto->netflow && !facet_is_controller_flow(facet) &&
4761         netflow_active_timeout_expired(ofproto->netflow, &facet->nf_flow)) {
4762         struct ofexpired expired;
4763
4764         if (facet->installed) {
4765             struct dpif_flow_stats stats;
4766
4767             facet_put__(ofproto, facet, facet->actions, facet->actions_len,
4768                         &stats);
4769             facet_update_stats(ofproto, facet, &stats);
4770         }
4771
4772         expired.flow = facet->flow;
4773         expired.packet_count = facet->packet_count;
4774         expired.byte_count = facet->byte_count;
4775         expired.used = facet->used;
4776         netflow_expire(ofproto->netflow, &facet->nf_flow, &expired);
4777     }
4778 }
4779
4780 static void
4781 ofproto_expire_facets(struct ofproto *ofproto, int dp_max_idle)
4782 {
4783     long long int cutoff = time_msec() - dp_max_idle;
4784     struct facet *facet, *next_facet;
4785
4786     HMAP_FOR_EACH_SAFE (facet, next_facet, hmap_node, &ofproto->facets) {
4787         facet_active_timeout(ofproto, facet);
4788         if (facet->used < cutoff) {
4789             facet_remove(ofproto, facet);
4790         }
4791     }
4792 }
4793
4794 /* If 'rule' is an OpenFlow rule, that has expired according to OpenFlow rules,
4795  * then delete it entirely. */
4796 static void
4797 rule_expire(struct ofproto *ofproto, struct rule *rule)
4798 {
4799     struct facet *facet, *next_facet;
4800     long long int now;
4801     uint8_t reason;
4802
4803     /* Has 'rule' expired? */
4804     now = time_msec();
4805     if (rule->hard_timeout
4806         && now > rule->created + rule->hard_timeout * 1000) {
4807         reason = OFPRR_HARD_TIMEOUT;
4808     } else if (rule->idle_timeout && list_is_empty(&rule->facets)
4809                && now >rule->used + rule->idle_timeout * 1000) {
4810         reason = OFPRR_IDLE_TIMEOUT;
4811     } else {
4812         return;
4813     }
4814
4815     COVERAGE_INC(ofproto_expired);
4816
4817     /* Update stats.  (This is a no-op if the rule expired due to an idle
4818      * timeout, because that only happens when the rule has no facets left.) */
4819     LIST_FOR_EACH_SAFE (facet, next_facet, list_node, &rule->facets) {
4820         facet_remove(ofproto, facet);
4821     }
4822
4823     /* Get rid of the rule. */
4824     if (!rule_is_hidden(rule)) {
4825         rule_send_removed(ofproto, rule, reason);
4826     }
4827     rule_remove(ofproto, rule);
4828 }
4829 \f
4830 static struct ofpbuf *
4831 compose_ofp_flow_removed(struct ofconn *ofconn, const struct rule *rule,
4832                          uint8_t reason)
4833 {
4834     struct ofp_flow_removed *ofr;
4835     struct ofpbuf *buf;
4836
4837     ofr = make_openflow_xid(sizeof *ofr, OFPT_FLOW_REMOVED, htonl(0), &buf);
4838     ofputil_cls_rule_to_match(&rule->cr, ofconn->flow_format, &ofr->match,
4839                               rule->flow_cookie, &ofr->cookie);
4840     ofr->priority = htons(rule->cr.priority);
4841     ofr->reason = reason;
4842     calc_flow_duration(rule->created, &ofr->duration_sec, &ofr->duration_nsec);
4843     ofr->idle_timeout = htons(rule->idle_timeout);
4844     ofr->packet_count = htonll(rule->packet_count);
4845     ofr->byte_count = htonll(rule->byte_count);
4846
4847     return buf;
4848 }
4849
4850 static struct ofpbuf *
4851 compose_nx_flow_removed(const struct rule *rule, uint8_t reason)
4852 {
4853     struct nx_flow_removed *nfr;
4854     struct ofpbuf *buf;
4855     int match_len;
4856
4857     make_nxmsg_xid(sizeof *nfr, NXT_FLOW_REMOVED, htonl(0), &buf);
4858     match_len = nx_put_match(buf, &rule->cr);
4859
4860     nfr = buf->data;
4861     nfr->cookie = rule->flow_cookie;
4862     nfr->priority = htons(rule->cr.priority);
4863     nfr->reason = reason;
4864     calc_flow_duration(rule->created, &nfr->duration_sec, &nfr->duration_nsec);
4865     nfr->idle_timeout = htons(rule->idle_timeout);
4866     nfr->match_len = htons(match_len);
4867     nfr->packet_count = htonll(rule->packet_count);
4868     nfr->byte_count = htonll(rule->byte_count);
4869
4870     return buf;
4871 }
4872
4873 static void
4874 rule_send_removed(struct ofproto *p, struct rule *rule, uint8_t reason)
4875 {
4876     struct ofconn *ofconn;
4877
4878     if (!rule->send_flow_removed) {
4879         return;
4880     }
4881
4882     LIST_FOR_EACH (ofconn, node, &p->all_conns) {
4883         struct ofpbuf *msg;
4884
4885         if (!rconn_is_connected(ofconn->rconn)
4886             || !ofconn_receives_async_msgs(ofconn)) {
4887             continue;
4888         }
4889
4890         msg = (ofconn->flow_format == NXFF_NXM
4891                ? compose_nx_flow_removed(rule, reason)
4892                : compose_ofp_flow_removed(ofconn, rule, reason));
4893
4894         /* Account flow expirations under ofconn->reply_counter, the counter
4895          * for replies to OpenFlow requests.  That works because preventing
4896          * OpenFlow requests from being processed also prevents new flows from
4897          * being added (and expiring).  (It also prevents processing OpenFlow
4898          * requests that would not add new flows, so it is imperfect.) */
4899         queue_tx(msg, ofconn, ofconn->reply_counter);
4900     }
4901 }
4902
4903 /* Obtains statistics for 'rule' and stores them in '*packets' and '*bytes'.
4904  * The returned statistics include statistics for all of 'rule''s facets. */
4905 static void
4906 rule_get_stats(const struct rule *rule, uint64_t *packets, uint64_t *bytes)
4907 {
4908     uint64_t p, b;
4909     struct facet *facet;
4910
4911     /* Start from historical data for 'rule' itself that are no longer tracked
4912      * in facets.  This counts, for example, facets that have expired. */
4913     p = rule->packet_count;
4914     b = rule->byte_count;
4915
4916     /* Add any statistics that are tracked by facets.  This includes
4917      * statistical data recently updated by ofproto_update_stats() as well as
4918      * stats for packets that were executed "by hand" via dpif_execute(). */
4919     LIST_FOR_EACH (facet, list_node, &rule->facets) {
4920         p += facet->packet_count;
4921         b += facet->byte_count;
4922     }
4923
4924     *packets = p;
4925     *bytes = b;
4926 }
4927
4928 /* pinsched callback for sending 'ofp_packet_in' on 'ofconn'. */
4929 static void
4930 do_send_packet_in(struct ofpbuf *ofp_packet_in, void *ofconn_)
4931 {
4932     struct ofconn *ofconn = ofconn_;
4933
4934     rconn_send_with_limit(ofconn->rconn, ofp_packet_in,
4935                           ofconn->packet_in_counter, 100);
4936 }
4937
4938 /* Takes 'upcall', whose packet has the flow specified by 'flow', composes an
4939  * OpenFlow packet-in message from it, and passes it to 'ofconn''s packet
4940  * scheduler for sending.
4941  *
4942  * If 'clone' is true, the caller retains ownership of 'upcall->packet'.
4943  * Otherwise, ownership is transferred to this function. */
4944 static void
4945 schedule_packet_in(struct ofconn *ofconn, struct dpif_upcall *upcall,
4946                    const struct flow *flow, bool clone)
4947 {
4948     enum { OPI_SIZE = offsetof(struct ofp_packet_in, data) };
4949     struct ofproto *ofproto = ofconn->ofproto;
4950     struct ofp_packet_in *opi;
4951     int total_len, send_len;
4952     struct ofpbuf *packet;
4953     uint32_t buffer_id;
4954     int idx;
4955
4956     /* Get OpenFlow buffer_id. */
4957     if (upcall->type == DPIF_UC_ACTION) {
4958         buffer_id = UINT32_MAX;
4959     } else if (ofproto->fail_open && fail_open_is_active(ofproto->fail_open)) {
4960         buffer_id = pktbuf_get_null();
4961     } else if (!ofconn->pktbuf) {
4962         buffer_id = UINT32_MAX;
4963     } else {
4964         buffer_id = pktbuf_save(ofconn->pktbuf, upcall->packet, flow->in_port);
4965     }
4966
4967     /* Figure out how much of the packet to send. */
4968     total_len = send_len = upcall->packet->size;
4969     if (buffer_id != UINT32_MAX) {
4970         send_len = MIN(send_len, ofconn->miss_send_len);
4971     }
4972     if (upcall->type == DPIF_UC_ACTION) {
4973         send_len = MIN(send_len, upcall->userdata);
4974     }
4975
4976     /* Copy or steal buffer for OFPT_PACKET_IN. */
4977     if (clone) {
4978         packet = ofpbuf_clone_data_with_headroom(upcall->packet->data,
4979                                                  send_len, OPI_SIZE);
4980     } else {
4981         packet = upcall->packet;
4982         packet->size = send_len;
4983     }
4984
4985     /* Add OFPT_PACKET_IN. */
4986     opi = ofpbuf_push_zeros(packet, OPI_SIZE);
4987     opi->header.version = OFP_VERSION;
4988     opi->header.type = OFPT_PACKET_IN;
4989     opi->total_len = htons(total_len);
4990     opi->in_port = htons(odp_port_to_ofp_port(flow->in_port));
4991     opi->reason = upcall->type == DPIF_UC_MISS ? OFPR_NO_MATCH : OFPR_ACTION;
4992     opi->buffer_id = htonl(buffer_id);
4993     update_openflow_length(packet);
4994
4995     /* Hand over to packet scheduler.  It might immediately call into
4996      * do_send_packet_in() or it might buffer it for a while (until a later
4997      * call to pinsched_run()). */
4998     idx = upcall->type == DPIF_UC_MISS ? 0 : 1;
4999     pinsched_send(ofconn->schedulers[idx], flow->in_port,
5000                   packet, do_send_packet_in, ofconn);
5001 }
5002
5003 /* Given 'upcall', of type DPIF_UC_ACTION or DPIF_UC_MISS, sends an
5004  * OFPT_PACKET_IN message to each OpenFlow controller as necessary according to
5005  * their individual configurations.
5006  *
5007  * Takes ownership of 'packet'. */
5008 static void
5009 send_packet_in(struct ofproto *ofproto, struct dpif_upcall *upcall,
5010                const struct flow *flow, bool clone)
5011 {
5012     struct ofconn *ofconn, *prev;
5013
5014     prev = NULL;
5015     LIST_FOR_EACH (ofconn, node, &ofproto->all_conns) {
5016         if (ofconn_receives_async_msgs(ofconn)) {
5017             if (prev) {
5018                 schedule_packet_in(prev, upcall, flow, true);
5019             }
5020             prev = ofconn;
5021         }
5022     }
5023     if (prev) {
5024         schedule_packet_in(prev, upcall, flow, clone);
5025     } else if (!clone) {
5026         ofpbuf_delete(upcall->packet);
5027     }
5028 }
5029
5030 static uint64_t
5031 pick_datapath_id(const struct ofproto *ofproto)
5032 {
5033     const struct ofport *port;
5034
5035     port = get_port(ofproto, ODPP_LOCAL);
5036     if (port) {
5037         uint8_t ea[ETH_ADDR_LEN];
5038         int error;
5039
5040         error = netdev_get_etheraddr(port->netdev, ea);
5041         if (!error) {
5042             return eth_addr_to_uint64(ea);
5043         }
5044         VLOG_WARN("could not get MAC address for %s (%s)",
5045                   netdev_get_name(port->netdev), strerror(error));
5046     }
5047     return ofproto->fallback_dpid;
5048 }
5049
5050 static uint64_t
5051 pick_fallback_dpid(void)
5052 {
5053     uint8_t ea[ETH_ADDR_LEN];
5054     eth_addr_nicira_random(ea);
5055     return eth_addr_to_uint64(ea);
5056 }
5057 \f
5058 static void
5059 ofproto_unixctl_list(struct unixctl_conn *conn, const char *arg OVS_UNUSED,
5060                      void *aux OVS_UNUSED)
5061 {
5062     const struct shash_node *node;
5063     struct ds results;
5064
5065     ds_init(&results);
5066     SHASH_FOR_EACH (node, &all_ofprotos) {
5067         ds_put_format(&results, "%s\n", node->name);
5068     }
5069     unixctl_command_reply(conn, 200, ds_cstr(&results));
5070     ds_destroy(&results);
5071 }
5072
5073 struct ofproto_trace {
5074     struct action_xlate_ctx ctx;
5075     struct flow flow;
5076     struct ds *result;
5077 };
5078
5079 static void
5080 trace_format_rule(struct ds *result, int level, const struct rule *rule)
5081 {
5082     ds_put_char_multiple(result, '\t', level);
5083     if (!rule) {
5084         ds_put_cstr(result, "No match\n");
5085         return;
5086     }
5087
5088     ds_put_format(result, "Rule: cookie=%#"PRIx64" ",
5089                   ntohll(rule->flow_cookie));
5090     cls_rule_format(&rule->cr, result);
5091     ds_put_char(result, '\n');
5092
5093     ds_put_char_multiple(result, '\t', level);
5094     ds_put_cstr(result, "OpenFlow ");
5095     ofp_print_actions(result, (const struct ofp_action_header *) rule->actions,
5096                       rule->n_actions * sizeof *rule->actions);
5097     ds_put_char(result, '\n');
5098 }
5099
5100 static void
5101 trace_format_flow(struct ds *result, int level, const char *title,
5102                  struct ofproto_trace *trace)
5103 {
5104     ds_put_char_multiple(result, '\t', level);
5105     ds_put_format(result, "%s: ", title);
5106     if (flow_equal(&trace->ctx.flow, &trace->flow)) {
5107         ds_put_cstr(result, "unchanged");
5108     } else {
5109         flow_format(result, &trace->ctx.flow);
5110         trace->flow = trace->ctx.flow;
5111     }
5112     ds_put_char(result, '\n');
5113 }
5114
5115 static void
5116 trace_resubmit(struct action_xlate_ctx *ctx, struct rule *rule)
5117 {
5118     struct ofproto_trace *trace = CONTAINER_OF(ctx, struct ofproto_trace, ctx);
5119     struct ds *result = trace->result;
5120
5121     ds_put_char(result, '\n');
5122     trace_format_flow(result, ctx->recurse + 1, "Resubmitted flow", trace);
5123     trace_format_rule(result, ctx->recurse + 1, rule);
5124 }
5125
5126 static void
5127 ofproto_unixctl_trace(struct unixctl_conn *conn, const char *args_,
5128                       void *aux OVS_UNUSED)
5129 {
5130     char *dpname, *in_port_s, *tun_id_s, *packet_s;
5131     char *args = xstrdup(args_);
5132     char *save_ptr = NULL;
5133     struct ofproto *ofproto;
5134     struct ofpbuf packet;
5135     struct rule *rule;
5136     struct ds result;
5137     struct flow flow;
5138     uint16_t in_port;
5139     ovs_be64 tun_id;
5140     char *s;
5141
5142     ofpbuf_init(&packet, strlen(args) / 2);
5143     ds_init(&result);
5144
5145     dpname = strtok_r(args, " ", &save_ptr);
5146     tun_id_s = strtok_r(NULL, " ", &save_ptr);
5147     in_port_s = strtok_r(NULL, " ", &save_ptr);
5148     packet_s = strtok_r(NULL, "", &save_ptr); /* Get entire rest of line. */
5149     if (!dpname || !in_port_s || !packet_s) {
5150         unixctl_command_reply(conn, 501, "Bad command syntax");
5151         goto exit;
5152     }
5153
5154     ofproto = shash_find_data(&all_ofprotos, dpname);
5155     if (!ofproto) {
5156         unixctl_command_reply(conn, 501, "Unknown ofproto (use ofproto/list "
5157                               "for help)");
5158         goto exit;
5159     }
5160
5161     tun_id = htonll(strtoull(tun_id_s, NULL, 10));
5162     in_port = ofp_port_to_odp_port(atoi(in_port_s));
5163
5164     packet_s = ofpbuf_put_hex(&packet, packet_s, NULL);
5165     packet_s += strspn(packet_s, " ");
5166     if (*packet_s != '\0') {
5167         unixctl_command_reply(conn, 501, "Trailing garbage in command");
5168         goto exit;
5169     }
5170     if (packet.size < ETH_HEADER_LEN) {
5171         unixctl_command_reply(conn, 501, "Packet data too short for Ethernet");
5172         goto exit;
5173     }
5174
5175     ds_put_cstr(&result, "Packet: ");
5176     s = ofp_packet_to_string(packet.data, packet.size, packet.size);
5177     ds_put_cstr(&result, s);
5178     free(s);
5179
5180     flow_extract(&packet, tun_id, in_port, &flow);
5181     ds_put_cstr(&result, "Flow: ");
5182     flow_format(&result, &flow);
5183     ds_put_char(&result, '\n');
5184
5185     rule = rule_lookup(ofproto, &flow);
5186     trace_format_rule(&result, 0, rule);
5187     if (rule) {
5188         struct ofproto_trace trace;
5189         struct ofpbuf *odp_actions;
5190
5191         trace.result = &result;
5192         trace.flow = flow;
5193         action_xlate_ctx_init(&trace.ctx, ofproto, &flow, &packet);
5194         trace.ctx.resubmit_hook = trace_resubmit;
5195         odp_actions = xlate_actions(&trace.ctx,
5196                                     rule->actions, rule->n_actions);
5197
5198         ds_put_char(&result, '\n');
5199         trace_format_flow(&result, 0, "Final flow", &trace);
5200         ds_put_cstr(&result, "Datapath actions: ");
5201         format_odp_actions(&result, odp_actions->data, odp_actions->size);
5202         ofpbuf_delete(odp_actions);
5203     }
5204
5205     unixctl_command_reply(conn, 200, ds_cstr(&result));
5206
5207 exit:
5208     ds_destroy(&result);
5209     ofpbuf_uninit(&packet);
5210     free(args);
5211 }
5212
5213 static void
5214 ofproto_unixctl_init(void)
5215 {
5216     static bool registered;
5217     if (registered) {
5218         return;
5219     }
5220     registered = true;
5221
5222     unixctl_command_register("ofproto/list", ofproto_unixctl_list, NULL);
5223     unixctl_command_register("ofproto/trace", ofproto_unixctl_trace, NULL);
5224 }
5225 \f
5226 static bool
5227 default_normal_ofhook_cb(const struct flow *flow, const struct ofpbuf *packet,
5228                          struct ofpbuf *odp_actions, tag_type *tags,
5229                          uint16_t *nf_output_iface, void *ofproto_)
5230 {
5231     struct ofproto *ofproto = ofproto_;
5232     int out_port;
5233
5234     /* Drop frames for reserved multicast addresses. */
5235     if (eth_addr_is_reserved(flow->dl_dst)) {
5236         return true;
5237     }
5238
5239     /* Learn source MAC (but don't try to learn from revalidation). */
5240     if (packet != NULL) {
5241         tag_type rev_tag = mac_learning_learn(ofproto->ml, flow->dl_src,
5242                                               0, flow->in_port,
5243                                               GRAT_ARP_LOCK_NONE);
5244         if (rev_tag) {
5245             /* The log messages here could actually be useful in debugging,
5246              * so keep the rate limit relatively high. */
5247             static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(30, 300);
5248             VLOG_DBG_RL(&rl, "learned that "ETH_ADDR_FMT" is on port %"PRIu16,
5249                         ETH_ADDR_ARGS(flow->dl_src), flow->in_port);
5250             ofproto_revalidate(ofproto, rev_tag);
5251         }
5252     }
5253
5254     /* Determine output port. */
5255     out_port = mac_learning_lookup_tag(ofproto->ml, flow->dl_dst, 0, tags,
5256                                        NULL);
5257     if (out_port < 0) {
5258         flood_packets(ofproto, flow->in_port, OFPPC_NO_FLOOD,
5259                       nf_output_iface, odp_actions);
5260     } else if (out_port != flow->in_port) {
5261         nl_msg_put_u32(odp_actions, ODP_ACTION_ATTR_OUTPUT, out_port);
5262         *nf_output_iface = out_port;
5263     } else {
5264         /* Drop. */
5265     }
5266
5267     return true;
5268 }
5269
5270 static const struct ofhooks default_ofhooks = {
5271     default_normal_ofhook_cb,
5272     NULL,
5273     NULL,
5274     NULL
5275 };