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