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 ? ofport->opp.name : "<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 ofport->opp.name and update_port() is going to destroy
1388          * 'ofport'.  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 /* Sends 'packet' out of port 'port_no' within 'p'.  If 'vlan_tci' is zero the
1408  * packet will not have any 802.1Q hader; if it is nonzero, then the packet
1409  * will be sent with the VLAN TCI specified by 'vlan_tci & ~VLAN_CFI'.
1410  *
1411  * Returns 0 if successful, otherwise a positive errno value. */
1412 int
1413 ofproto_send_packet(struct ofproto *ofproto,
1414                     uint32_t port_no, uint16_t vlan_tci,
1415                     const struct ofpbuf *packet)
1416 {
1417     struct ofpbuf odp_actions;
1418     int error;
1419
1420     ofpbuf_init(&odp_actions, 32);
1421     if (vlan_tci != 0) {
1422         nl_msg_put_u32(&odp_actions, ODP_ACTION_ATTR_SET_DL_TCI,
1423                        ntohs(vlan_tci & ~VLAN_CFI));
1424     }
1425     nl_msg_put_u32(&odp_actions, ODP_ACTION_ATTR_OUTPUT, port_no);
1426     error = dpif_execute(ofproto->dpif, odp_actions.data, odp_actions.size,
1427                          packet);
1428     ofpbuf_uninit(&odp_actions);
1429
1430     if (error) {
1431         VLOG_WARN_RL(&rl, "%s: failed to send packet on port %"PRIu32" (%s)",
1432                      dpif_name(ofproto->dpif), port_no, strerror(error));
1433     }
1434     return error;
1435 }
1436
1437 /* Adds a flow to the OpenFlow flow table in 'p' that matches 'cls_rule' and
1438  * performs the 'n_actions' actions in 'actions'.  The new flow will not
1439  * timeout.
1440  *
1441  * If cls_rule->priority is in the range of priorities supported by OpenFlow
1442  * (0...65535, inclusive) then the flow will be visible to OpenFlow
1443  * controllers; otherwise, it will be hidden.
1444  *
1445  * The caller retains ownership of 'cls_rule' and 'actions'. */
1446 void
1447 ofproto_add_flow(struct ofproto *p, const struct cls_rule *cls_rule,
1448                  const union ofp_action *actions, size_t n_actions)
1449 {
1450     struct rule *rule;
1451     rule = rule_create(cls_rule, actions, n_actions, 0, 0, 0, false);
1452     rule_insert(p, rule);
1453 }
1454
1455 void
1456 ofproto_delete_flow(struct ofproto *ofproto, const struct cls_rule *target)
1457 {
1458     struct rule *rule;
1459
1460     rule = rule_from_cls_rule(classifier_find_rule_exactly(&ofproto->cls,
1461                                                            target));
1462     if (rule) {
1463         rule_remove(ofproto, rule);
1464     }
1465 }
1466
1467 void
1468 ofproto_flush_flows(struct ofproto *ofproto)
1469 {
1470     struct facet *facet, *next_facet;
1471     struct rule *rule, *next_rule;
1472     struct cls_cursor cursor;
1473
1474     COVERAGE_INC(ofproto_flush);
1475
1476     HMAP_FOR_EACH_SAFE (facet, next_facet, hmap_node, &ofproto->facets) {
1477         /* Mark the facet as not installed so that facet_remove() doesn't
1478          * bother trying to uninstall it.  There is no point in uninstalling it
1479          * individually since we are about to blow away all the facets with
1480          * dpif_flow_flush(). */
1481         facet->installed = false;
1482         facet->dp_packet_count = 0;
1483         facet->dp_byte_count = 0;
1484         facet_remove(ofproto, facet);
1485     }
1486
1487     cls_cursor_init(&cursor, &ofproto->cls, NULL);
1488     CLS_CURSOR_FOR_EACH_SAFE (rule, next_rule, cr, &cursor) {
1489         rule_remove(ofproto, rule);
1490     }
1491
1492     dpif_flow_flush(ofproto->dpif);
1493     if (ofproto->in_band) {
1494         in_band_flushed(ofproto->in_band);
1495     }
1496     if (ofproto->fail_open) {
1497         fail_open_flushed(ofproto->fail_open);
1498     }
1499 }
1500 \f
1501 static void
1502 reinit_ports(struct ofproto *p)
1503 {
1504     struct dpif_port_dump dump;
1505     struct shash_node *node;
1506     struct shash devnames;
1507     struct ofport *ofport;
1508     struct dpif_port dpif_port;
1509
1510     COVERAGE_INC(ofproto_reinit_ports);
1511
1512     shash_init(&devnames);
1513     HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1514         shash_add_once (&devnames, ofport->opp.name, NULL);
1515     }
1516     DPIF_PORT_FOR_EACH (&dpif_port, &dump, p->dpif) {
1517         shash_add_once (&devnames, dpif_port.name, NULL);
1518     }
1519
1520     SHASH_FOR_EACH (node, &devnames) {
1521         update_port(p, node->name);
1522     }
1523     shash_destroy(&devnames);
1524 }
1525
1526 static struct ofport *
1527 make_ofport(const struct dpif_port *dpif_port)
1528 {
1529     struct netdev_options netdev_options;
1530     enum netdev_flags flags;
1531     struct ofport *ofport;
1532     struct netdev *netdev;
1533     int error;
1534
1535     memset(&netdev_options, 0, sizeof netdev_options);
1536     netdev_options.name = dpif_port->name;
1537     netdev_options.type = dpif_port->type;
1538     netdev_options.ethertype = NETDEV_ETH_TYPE_NONE;
1539
1540     error = netdev_open(&netdev_options, &netdev);
1541     if (error) {
1542         VLOG_WARN_RL(&rl, "ignoring port %s (%"PRIu16") because netdev %s "
1543                      "cannot be opened (%s)",
1544                      dpif_port->name, dpif_port->port_no,
1545                      dpif_port->name, strerror(error));
1546         return NULL;
1547     }
1548
1549     ofport = xzalloc(sizeof *ofport);
1550     ofport->netdev = netdev;
1551     ofport->odp_port = dpif_port->port_no;
1552     ofport->opp.port_no = odp_port_to_ofp_port(dpif_port->port_no);
1553     netdev_get_etheraddr(netdev, ofport->opp.hw_addr);
1554     ovs_strlcpy(ofport->opp.name, dpif_port->name, sizeof ofport->opp.name);
1555
1556     netdev_get_flags(netdev, &flags);
1557     ofport->opp.config = flags & NETDEV_UP ? 0 : OFPPC_PORT_DOWN;
1558
1559     ofport->opp.state = netdev_get_carrier(netdev) ? 0 : OFPPS_LINK_DOWN;
1560
1561     netdev_get_features(netdev,
1562                         &ofport->opp.curr, &ofport->opp.advertised,
1563                         &ofport->opp.supported, &ofport->opp.peer);
1564     return ofport;
1565 }
1566
1567 static bool
1568 ofport_conflicts(const struct ofproto *p, const struct dpif_port *dpif_port)
1569 {
1570     if (get_port(p, dpif_port->port_no)) {
1571         VLOG_WARN_RL(&rl, "ignoring duplicate port %"PRIu16" in datapath",
1572                      dpif_port->port_no);
1573         return true;
1574     } else if (shash_find(&p->port_by_name, dpif_port->name)) {
1575         VLOG_WARN_RL(&rl, "ignoring duplicate device %s in datapath",
1576                      dpif_port->name);
1577         return true;
1578     } else {
1579         return false;
1580     }
1581 }
1582
1583 static int
1584 ofport_equal(const struct ofport *a_, const struct ofport *b_)
1585 {
1586     const struct ofp_phy_port *a = &a_->opp;
1587     const struct ofp_phy_port *b = &b_->opp;
1588
1589     BUILD_ASSERT_DECL(sizeof *a == 48); /* Detect ofp_phy_port changes. */
1590     return (a->port_no == b->port_no
1591             && !memcmp(a->hw_addr, b->hw_addr, sizeof a->hw_addr)
1592             && !strcmp(a->name, b->name)
1593             && a->state == b->state
1594             && a->config == b->config
1595             && a->curr == b->curr
1596             && a->advertised == b->advertised
1597             && a->supported == b->supported
1598             && a->peer == b->peer);
1599 }
1600
1601 static void
1602 send_port_status(struct ofproto *p, const struct ofport *ofport,
1603                  uint8_t reason)
1604 {
1605     /* XXX Should limit the number of queued port status change messages. */
1606     struct ofconn *ofconn;
1607     LIST_FOR_EACH (ofconn, node, &p->all_conns) {
1608         struct ofp_port_status *ops;
1609         struct ofpbuf *b;
1610
1611         /* Primary controllers, even slaves, should always get port status
1612            updates.  Otherwise obey ofconn_receives_async_msgs(). */
1613         if (ofconn->type != OFCONN_PRIMARY
1614             && !ofconn_receives_async_msgs(ofconn)) {
1615             continue;
1616         }
1617
1618         ops = make_openflow_xid(sizeof *ops, OFPT_PORT_STATUS, 0, &b);
1619         ops->reason = reason;
1620         ops->desc = ofport->opp;
1621         hton_ofp_phy_port(&ops->desc);
1622         queue_tx(b, ofconn, NULL);
1623     }
1624 }
1625
1626 static void
1627 ofport_install(struct ofproto *p, struct ofport *ofport)
1628 {
1629     const char *netdev_name = ofport->opp.name;
1630
1631     netdev_monitor_add(p->netdev_monitor, ofport->netdev);
1632     hmap_insert(&p->ports, &ofport->hmap_node, hash_int(ofport->odp_port, 0));
1633     shash_add(&p->port_by_name, netdev_name, ofport);
1634     if (p->sflow) {
1635         ofproto_sflow_add_port(p->sflow, ofport->odp_port, netdev_name);
1636     }
1637 }
1638
1639 static void
1640 ofport_remove(struct ofproto *p, struct ofport *ofport)
1641 {
1642     netdev_monitor_remove(p->netdev_monitor, ofport->netdev);
1643     hmap_remove(&p->ports, &ofport->hmap_node);
1644     shash_delete(&p->port_by_name,
1645                  shash_find(&p->port_by_name, ofport->opp.name));
1646     if (p->sflow) {
1647         ofproto_sflow_del_port(p->sflow, ofport->odp_port);
1648     }
1649 }
1650
1651 static void
1652 ofport_free(struct ofport *ofport)
1653 {
1654     if (ofport) {
1655         netdev_close(ofport->netdev);
1656         free(ofport);
1657     }
1658 }
1659
1660 static struct ofport *
1661 get_port(const struct ofproto *ofproto, uint16_t odp_port)
1662 {
1663     struct ofport *port;
1664
1665     HMAP_FOR_EACH_IN_BUCKET (port, hmap_node,
1666                              hash_int(odp_port, 0), &ofproto->ports) {
1667         if (port->odp_port == odp_port) {
1668             return port;
1669         }
1670     }
1671     return NULL;
1672 }
1673
1674 static void
1675 update_port(struct ofproto *p, const char *devname)
1676 {
1677     struct dpif_port dpif_port;
1678     struct ofport *old_ofport;
1679     struct ofport *new_ofport;
1680     int error;
1681
1682     COVERAGE_INC(ofproto_update_port);
1683
1684     /* Query the datapath for port information. */
1685     error = dpif_port_query_by_name(p->dpif, devname, &dpif_port);
1686
1687     /* Find the old ofport. */
1688     old_ofport = shash_find_data(&p->port_by_name, devname);
1689     if (!error) {
1690         if (!old_ofport) {
1691             /* There's no port named 'devname' but there might be a port with
1692              * the same port number.  This could happen if a port is deleted
1693              * and then a new one added in its place very quickly, or if a port
1694              * is renamed.  In the former case we want to send an OFPPR_DELETE
1695              * and an OFPPR_ADD, and in the latter case we want to send a
1696              * single OFPPR_MODIFY.  We can distinguish the cases by comparing
1697              * the old port's ifindex against the new port, or perhaps less
1698              * reliably but more portably by comparing the old port's MAC
1699              * against the new port's MAC.  However, this code isn't that smart
1700              * and always sends an OFPPR_MODIFY (XXX). */
1701             old_ofport = get_port(p, dpif_port.port_no);
1702         }
1703     } else if (error != ENOENT && error != ENODEV) {
1704         VLOG_WARN_RL(&rl, "dpif_port_query_by_name returned unexpected error "
1705                      "%s", strerror(error));
1706         goto exit;
1707     }
1708
1709     /* Create a new ofport. */
1710     new_ofport = !error ? make_ofport(&dpif_port) : NULL;
1711
1712     /* Eliminate a few pathological cases. */
1713     if (!old_ofport && !new_ofport) {
1714         goto exit;
1715     } else if (old_ofport && new_ofport) {
1716         /* Most of the 'config' bits are OpenFlow soft state, but
1717          * OFPPC_PORT_DOWN is maintained by the kernel.  So transfer the
1718          * OpenFlow bits from old_ofport.  (make_ofport() only sets
1719          * OFPPC_PORT_DOWN and leaves the other bits 0.)  */
1720         new_ofport->opp.config |= old_ofport->opp.config & ~OFPPC_PORT_DOWN;
1721
1722         if (ofport_equal(old_ofport, new_ofport)) {
1723             /* False alarm--no change. */
1724             ofport_free(new_ofport);
1725             goto exit;
1726         }
1727     }
1728
1729     /* Now deal with the normal cases. */
1730     if (old_ofport) {
1731         ofport_remove(p, old_ofport);
1732     }
1733     if (new_ofport) {
1734         ofport_install(p, new_ofport);
1735     }
1736     send_port_status(p, new_ofport ? new_ofport : old_ofport,
1737                      (!old_ofport ? OFPPR_ADD
1738                       : !new_ofport ? OFPPR_DELETE
1739                       : OFPPR_MODIFY));
1740     ofport_free(old_ofport);
1741
1742 exit:
1743     dpif_port_destroy(&dpif_port);
1744 }
1745
1746 static int
1747 init_ports(struct ofproto *p)
1748 {
1749     struct dpif_port_dump dump;
1750     struct dpif_port dpif_port;
1751
1752     DPIF_PORT_FOR_EACH (&dpif_port, &dump, p->dpif) {
1753         if (!ofport_conflicts(p, &dpif_port)) {
1754             struct ofport *ofport = make_ofport(&dpif_port);
1755             if (ofport) {
1756                 ofport_install(p, ofport);
1757             }
1758         }
1759     }
1760
1761     return 0;
1762 }
1763 \f
1764 static struct ofconn *
1765 ofconn_create(struct ofproto *p, struct rconn *rconn, enum ofconn_type type)
1766 {
1767     struct ofconn *ofconn = xzalloc(sizeof *ofconn);
1768     ofconn->ofproto = p;
1769     list_push_back(&p->all_conns, &ofconn->node);
1770     ofconn->rconn = rconn;
1771     ofconn->type = type;
1772     ofconn->flow_format = NXFF_OPENFLOW10;
1773     ofconn->role = NX_ROLE_OTHER;
1774     ofconn->packet_in_counter = rconn_packet_counter_create ();
1775     ofconn->pktbuf = NULL;
1776     ofconn->miss_send_len = 0;
1777     ofconn->reply_counter = rconn_packet_counter_create ();
1778     return ofconn;
1779 }
1780
1781 static void
1782 ofconn_destroy(struct ofconn *ofconn)
1783 {
1784     if (ofconn->type == OFCONN_PRIMARY) {
1785         hmap_remove(&ofconn->ofproto->controllers, &ofconn->hmap_node);
1786     }
1787
1788     list_remove(&ofconn->node);
1789     rconn_destroy(ofconn->rconn);
1790     rconn_packet_counter_destroy(ofconn->packet_in_counter);
1791     rconn_packet_counter_destroy(ofconn->reply_counter);
1792     pktbuf_destroy(ofconn->pktbuf);
1793     free(ofconn);
1794 }
1795
1796 static void
1797 ofconn_run(struct ofconn *ofconn)
1798 {
1799     struct ofproto *p = ofconn->ofproto;
1800     int iteration;
1801     size_t i;
1802
1803     for (i = 0; i < N_SCHEDULERS; i++) {
1804         pinsched_run(ofconn->schedulers[i], do_send_packet_in, ofconn);
1805     }
1806
1807     rconn_run(ofconn->rconn);
1808
1809     if (rconn_packet_counter_read (ofconn->reply_counter) < OFCONN_REPLY_MAX) {
1810         /* Limit the number of iterations to prevent other tasks from
1811          * starving. */
1812         for (iteration = 0; iteration < 50; iteration++) {
1813             struct ofpbuf *of_msg = rconn_recv(ofconn->rconn);
1814             if (!of_msg) {
1815                 break;
1816             }
1817             if (p->fail_open) {
1818                 fail_open_maybe_recover(p->fail_open);
1819             }
1820             handle_openflow(ofconn, of_msg);
1821             ofpbuf_delete(of_msg);
1822         }
1823     }
1824
1825     if (!rconn_is_alive(ofconn->rconn)) {
1826         ofconn_destroy(ofconn);
1827     }
1828 }
1829
1830 static void
1831 ofconn_wait(struct ofconn *ofconn)
1832 {
1833     int i;
1834
1835     for (i = 0; i < N_SCHEDULERS; i++) {
1836         pinsched_wait(ofconn->schedulers[i]);
1837     }
1838     rconn_run_wait(ofconn->rconn);
1839     if (rconn_packet_counter_read (ofconn->reply_counter) < OFCONN_REPLY_MAX) {
1840         rconn_recv_wait(ofconn->rconn);
1841     } else {
1842         COVERAGE_INC(ofproto_ofconn_stuck);
1843     }
1844 }
1845
1846 /* Returns true if 'ofconn' should receive asynchronous messages. */
1847 static bool
1848 ofconn_receives_async_msgs(const struct ofconn *ofconn)
1849 {
1850     if (ofconn->type == OFCONN_PRIMARY) {
1851         /* Primary controllers always get asynchronous messages unless they
1852          * have configured themselves as "slaves".  */
1853         return ofconn->role != NX_ROLE_SLAVE;
1854     } else {
1855         /* Service connections don't get asynchronous messages unless they have
1856          * explicitly asked for them by setting a nonzero miss send length. */
1857         return ofconn->miss_send_len > 0;
1858     }
1859 }
1860
1861 /* Returns a human-readable name for an OpenFlow connection between 'ofproto'
1862  * and 'target', suitable for use in log messages for identifying the
1863  * connection.
1864  *
1865  * The name is dynamically allocated.  The caller should free it (with free())
1866  * when it is no longer needed. */
1867 static char *
1868 ofconn_make_name(const struct ofproto *ofproto, const char *target)
1869 {
1870     return xasprintf("%s<->%s", dpif_base_name(ofproto->dpif), target);
1871 }
1872
1873 static void
1874 ofconn_set_rate_limit(struct ofconn *ofconn, int rate, int burst)
1875 {
1876     int i;
1877
1878     for (i = 0; i < N_SCHEDULERS; i++) {
1879         struct pinsched **s = &ofconn->schedulers[i];
1880
1881         if (rate > 0) {
1882             if (!*s) {
1883                 *s = pinsched_create(rate, burst);
1884             } else {
1885                 pinsched_set_limits(*s, rate, burst);
1886             }
1887         } else {
1888             pinsched_destroy(*s);
1889             *s = NULL;
1890         }
1891     }
1892 }
1893 \f
1894 static void
1895 ofservice_reconfigure(struct ofservice *ofservice,
1896                       const struct ofproto_controller *c)
1897 {
1898     ofservice->probe_interval = c->probe_interval;
1899     ofservice->rate_limit = c->rate_limit;
1900     ofservice->burst_limit = c->burst_limit;
1901 }
1902
1903 /* Creates a new ofservice in 'ofproto'.  Returns 0 if successful, otherwise a
1904  * positive errno value. */
1905 static int
1906 ofservice_create(struct ofproto *ofproto, const struct ofproto_controller *c)
1907 {
1908     struct ofservice *ofservice;
1909     struct pvconn *pvconn;
1910     int error;
1911
1912     error = pvconn_open(c->target, &pvconn);
1913     if (error) {
1914         return error;
1915     }
1916
1917     ofservice = xzalloc(sizeof *ofservice);
1918     hmap_insert(&ofproto->services, &ofservice->node,
1919                 hash_string(c->target, 0));
1920     ofservice->pvconn = pvconn;
1921
1922     ofservice_reconfigure(ofservice, c);
1923
1924     return 0;
1925 }
1926
1927 static void
1928 ofservice_destroy(struct ofproto *ofproto, struct ofservice *ofservice)
1929 {
1930     hmap_remove(&ofproto->services, &ofservice->node);
1931     pvconn_close(ofservice->pvconn);
1932     free(ofservice);
1933 }
1934
1935 /* Finds and returns the ofservice within 'ofproto' that has the given
1936  * 'target', or a null pointer if none exists. */
1937 static struct ofservice *
1938 ofservice_lookup(struct ofproto *ofproto, const char *target)
1939 {
1940     struct ofservice *ofservice;
1941
1942     HMAP_FOR_EACH_WITH_HASH (ofservice, node, hash_string(target, 0),
1943                              &ofproto->services) {
1944         if (!strcmp(pvconn_get_name(ofservice->pvconn), target)) {
1945             return ofservice;
1946         }
1947     }
1948     return NULL;
1949 }
1950 \f
1951 /* Returns true if 'rule' should be hidden from the controller.
1952  *
1953  * Rules with priority higher than UINT16_MAX are set up by ofproto itself
1954  * (e.g. by in-band control) and are intentionally hidden from the
1955  * controller. */
1956 static bool
1957 rule_is_hidden(const struct rule *rule)
1958 {
1959     return rule->cr.priority > UINT16_MAX;
1960 }
1961
1962 /* Creates and returns a new rule initialized as specified.
1963  *
1964  * The caller is responsible for inserting the rule into the classifier (with
1965  * rule_insert()). */
1966 static struct rule *
1967 rule_create(const struct cls_rule *cls_rule,
1968             const union ofp_action *actions, size_t n_actions,
1969             uint16_t idle_timeout, uint16_t hard_timeout,
1970             ovs_be64 flow_cookie, bool send_flow_removed)
1971 {
1972     struct rule *rule = xzalloc(sizeof *rule);
1973     rule->cr = *cls_rule;
1974     rule->idle_timeout = idle_timeout;
1975     rule->hard_timeout = hard_timeout;
1976     rule->flow_cookie = flow_cookie;
1977     rule->used = rule->created = time_msec();
1978     rule->send_flow_removed = send_flow_removed;
1979     list_init(&rule->facets);
1980     if (n_actions > 0) {
1981         rule->n_actions = n_actions;
1982         rule->actions = xmemdup(actions, n_actions * sizeof *actions);
1983     }
1984
1985     return rule;
1986 }
1987
1988 static struct rule *
1989 rule_from_cls_rule(const struct cls_rule *cls_rule)
1990 {
1991     return cls_rule ? CONTAINER_OF(cls_rule, struct rule, cr) : NULL;
1992 }
1993
1994 static void
1995 rule_free(struct rule *rule)
1996 {
1997     free(rule->actions);
1998     free(rule);
1999 }
2000
2001 /* Destroys 'rule' and iterates through all of its facets and revalidates them,
2002  * destroying any that no longer has a rule (which is probably all of them).
2003  *
2004  * The caller must have already removed 'rule' from the classifier. */
2005 static void
2006 rule_destroy(struct ofproto *ofproto, struct rule *rule)
2007 {
2008     struct facet *facet, *next_facet;
2009     LIST_FOR_EACH_SAFE (facet, next_facet, list_node, &rule->facets) {
2010         facet_revalidate(ofproto, facet);
2011     }
2012     rule_free(rule);
2013 }
2014
2015 /* Returns true if 'rule' has an OpenFlow OFPAT_OUTPUT or OFPAT_ENQUEUE action
2016  * that outputs to 'out_port' (output to OFPP_FLOOD and OFPP_ALL doesn't
2017  * count). */
2018 static bool
2019 rule_has_out_port(const struct rule *rule, ovs_be16 out_port)
2020 {
2021     const union ofp_action *oa;
2022     struct actions_iterator i;
2023
2024     if (out_port == htons(OFPP_NONE)) {
2025         return true;
2026     }
2027     for (oa = actions_first(&i, rule->actions, rule->n_actions); oa;
2028          oa = actions_next(&i)) {
2029         if (action_outputs_to_port(oa, out_port)) {
2030             return true;
2031         }
2032     }
2033     return false;
2034 }
2035
2036 /* Executes, within 'ofproto', the 'n_actions' actions in 'actions' on
2037  * 'packet', which arrived on 'in_port'.
2038  *
2039  * Takes ownership of 'packet'. */
2040 static bool
2041 execute_odp_actions(struct ofproto *ofproto, const struct flow *flow,
2042                     const struct nlattr *odp_actions, size_t actions_len,
2043                     struct ofpbuf *packet)
2044 {
2045     if (actions_len == NLA_ALIGN(NLA_HDRLEN + sizeof(uint64_t))
2046         && odp_actions->nla_type == ODP_ACTION_ATTR_CONTROLLER) {
2047         /* As an optimization, avoid a round-trip from userspace to kernel to
2048          * userspace.  This also avoids possibly filling up kernel packet
2049          * buffers along the way. */
2050         struct dpif_upcall upcall;
2051
2052         upcall.type = DPIF_UC_ACTION;
2053         upcall.packet = packet;
2054         upcall.key = NULL;
2055         upcall.key_len = 0;
2056         upcall.userdata = nl_attr_get_u64(odp_actions);
2057         upcall.sample_pool = 0;
2058         upcall.actions = NULL;
2059         upcall.actions_len = 0;
2060
2061         send_packet_in(ofproto, &upcall, flow, false);
2062
2063         return true;
2064     } else {
2065         int error;
2066
2067         error = dpif_execute(ofproto->dpif, odp_actions, actions_len, packet);
2068         ofpbuf_delete(packet);
2069         return !error;
2070     }
2071 }
2072
2073 /* Executes the actions indicated by 'facet' on 'packet' and credits 'facet''s
2074  * statistics appropriately.  'packet' must have at least sizeof(struct
2075  * ofp_packet_in) bytes of headroom.
2076  *
2077  * For correct results, 'packet' must actually be in 'facet''s flow; that is,
2078  * applying flow_extract() to 'packet' would yield the same flow as
2079  * 'facet->flow'.
2080  *
2081  * 'facet' must have accurately composed ODP actions; that is, it must not be
2082  * in need of revalidation.
2083  *
2084  * Takes ownership of 'packet'. */
2085 static void
2086 facet_execute(struct ofproto *ofproto, struct facet *facet,
2087               struct ofpbuf *packet)
2088 {
2089     struct dpif_flow_stats stats;
2090
2091     assert(ofpbuf_headroom(packet) >= sizeof(struct ofp_packet_in));
2092
2093     flow_extract_stats(&facet->flow, packet, &stats);
2094     stats.used = time_msec();
2095     if (execute_odp_actions(ofproto, &facet->flow,
2096                             facet->actions, facet->actions_len, packet)) {
2097         facet_update_stats(ofproto, facet, &stats);
2098     }
2099 }
2100
2101 /* Executes the actions indicated by 'rule' on 'packet' and credits 'rule''s
2102  * statistics (or the statistics for one of its facets) appropriately.
2103  * 'packet' must have at least sizeof(struct ofp_packet_in) bytes of headroom.
2104  *
2105  * 'packet' doesn't necessarily have to match 'rule'.  'rule' will be credited
2106  * with statistics for 'packet' either way.
2107  *
2108  * Takes ownership of 'packet'. */
2109 static void
2110 rule_execute(struct ofproto *ofproto, struct rule *rule, uint16_t in_port,
2111              struct ofpbuf *packet)
2112 {
2113     struct action_xlate_ctx ctx;
2114     struct ofpbuf *odp_actions;
2115     struct facet *facet;
2116     struct flow flow;
2117     size_t size;
2118
2119     assert(ofpbuf_headroom(packet) >= sizeof(struct ofp_packet_in));
2120
2121     flow_extract(packet, 0, in_port, &flow);
2122
2123     /* First look for a related facet.  If we find one, account it to that. */
2124     facet = facet_lookup_valid(ofproto, &flow);
2125     if (facet && facet->rule == rule) {
2126         facet_execute(ofproto, facet, packet);
2127         return;
2128     }
2129
2130     /* Otherwise, if 'rule' is in fact the correct rule for 'packet', then
2131      * create a new facet for it and use that. */
2132     if (rule_lookup(ofproto, &flow) == rule) {
2133         facet = facet_create(ofproto, rule, &flow, packet);
2134         facet_execute(ofproto, facet, packet);
2135         facet_install(ofproto, facet, true);
2136         return;
2137     }
2138
2139     /* We can't account anything to a facet.  If we were to try, then that
2140      * facet would have a non-matching rule, busting our invariants. */
2141     action_xlate_ctx_init(&ctx, ofproto, &flow, packet);
2142     odp_actions = xlate_actions(&ctx, rule->actions, rule->n_actions);
2143     size = packet->size;
2144     if (execute_odp_actions(ofproto, &flow, odp_actions->data,
2145                             odp_actions->size, packet)) {
2146         rule->used = time_msec();
2147         rule->packet_count++;
2148         rule->byte_count += size;
2149         flow_push_stats(ofproto, rule, &flow, 1, size, rule->used);
2150     }
2151     ofpbuf_delete(odp_actions);
2152 }
2153
2154 /* Inserts 'rule' into 'p''s flow table. */
2155 static void
2156 rule_insert(struct ofproto *p, struct rule *rule)
2157 {
2158     struct rule *displaced_rule;
2159
2160     displaced_rule = rule_from_cls_rule(classifier_insert(&p->cls, &rule->cr));
2161     if (displaced_rule) {
2162         rule_destroy(p, displaced_rule);
2163     }
2164     p->need_revalidate = true;
2165 }
2166
2167 /* Creates and returns a new facet within 'ofproto' owned by 'rule', given a
2168  * 'flow' and an example 'packet' within that flow.
2169  *
2170  * The caller must already have determined that no facet with an identical
2171  * 'flow' exists in 'ofproto' and that 'flow' is the best match for 'rule' in
2172  * 'ofproto''s classifier table. */
2173 static struct facet *
2174 facet_create(struct ofproto *ofproto, struct rule *rule,
2175              const struct flow *flow, const struct ofpbuf *packet)
2176 {
2177     struct facet *facet;
2178
2179     facet = xzalloc(sizeof *facet);
2180     facet->used = time_msec();
2181     hmap_insert(&ofproto->facets, &facet->hmap_node, flow_hash(flow, 0));
2182     list_push_back(&rule->facets, &facet->list_node);
2183     facet->rule = rule;
2184     facet->flow = *flow;
2185     netflow_flow_init(&facet->nf_flow);
2186     netflow_flow_update_time(ofproto->netflow, &facet->nf_flow, facet->used);
2187
2188     facet_make_actions(ofproto, facet, packet);
2189
2190     return facet;
2191 }
2192
2193 static void
2194 facet_free(struct facet *facet)
2195 {
2196     free(facet->actions);
2197     free(facet);
2198 }
2199
2200 /* Remove 'rule' from 'ofproto' and free up the associated memory:
2201  *
2202  *   - Removes 'rule' from the classifier.
2203  *
2204  *   - If 'rule' has facets, revalidates them (and possibly uninstalls and
2205  *     destroys them), via rule_destroy().
2206  */
2207 static void
2208 rule_remove(struct ofproto *ofproto, struct rule *rule)
2209 {
2210     COVERAGE_INC(ofproto_del_rule);
2211     ofproto->need_revalidate = true;
2212     classifier_remove(&ofproto->cls, &rule->cr);
2213     rule_destroy(ofproto, rule);
2214 }
2215
2216 /* Remove 'facet' from 'ofproto' and free up the associated memory:
2217  *
2218  *   - If 'facet' was installed in the datapath, uninstalls it and updates its
2219  *     rule's statistics, via facet_uninstall().
2220  *
2221  *   - Removes 'facet' from its rule and from ofproto->facets.
2222  */
2223 static void
2224 facet_remove(struct ofproto *ofproto, struct facet *facet)
2225 {
2226     facet_uninstall(ofproto, facet);
2227     facet_flush_stats(ofproto, facet);
2228     hmap_remove(&ofproto->facets, &facet->hmap_node);
2229     list_remove(&facet->list_node);
2230     facet_free(facet);
2231 }
2232
2233 /* Composes the ODP actions for 'facet' based on its rule's actions. */
2234 static void
2235 facet_make_actions(struct ofproto *p, struct facet *facet,
2236                    const struct ofpbuf *packet)
2237 {
2238     const struct rule *rule = facet->rule;
2239     struct ofpbuf *odp_actions;
2240     struct action_xlate_ctx ctx;
2241
2242     action_xlate_ctx_init(&ctx, p, &facet->flow, packet);
2243     odp_actions = xlate_actions(&ctx, rule->actions, rule->n_actions);
2244     facet->tags = ctx.tags;
2245     facet->may_install = ctx.may_set_up_flow;
2246     facet->nf_flow.output_iface = ctx.nf_output_iface;
2247
2248     if (facet->actions_len != odp_actions->size
2249         || memcmp(facet->actions, odp_actions->data, odp_actions->size)) {
2250         free(facet->actions);
2251         facet->actions_len = odp_actions->size;
2252         facet->actions = xmemdup(odp_actions->data, odp_actions->size);
2253     }
2254
2255     ofpbuf_delete(odp_actions);
2256 }
2257
2258 static int
2259 facet_put__(struct ofproto *ofproto, struct facet *facet,
2260             const struct nlattr *actions, size_t actions_len,
2261             struct dpif_flow_stats *stats)
2262 {
2263     uint32_t keybuf[ODPUTIL_FLOW_KEY_U32S];
2264     enum dpif_flow_put_flags flags;
2265     struct ofpbuf key;
2266
2267     flags = DPIF_FP_CREATE | DPIF_FP_MODIFY;
2268     if (stats) {
2269         flags |= DPIF_FP_ZERO_STATS;
2270         facet->dp_packet_count = 0;
2271         facet->dp_byte_count = 0;
2272     }
2273
2274     ofpbuf_use_stack(&key, keybuf, sizeof keybuf);
2275     odp_flow_key_from_flow(&key, &facet->flow);
2276     assert(key.base == keybuf);
2277
2278     return dpif_flow_put(ofproto->dpif, flags, key.data, key.size,
2279                          actions, actions_len, stats);
2280 }
2281
2282 /* If 'facet' is installable, inserts or re-inserts it into 'p''s datapath.  If
2283  * 'zero_stats' is true, clears any existing statistics from the datapath for
2284  * 'facet'. */
2285 static void
2286 facet_install(struct ofproto *p, struct facet *facet, bool zero_stats)
2287 {
2288     struct dpif_flow_stats stats;
2289
2290     if (facet->may_install
2291         && !facet_put__(p, facet, facet->actions, facet->actions_len,
2292                         zero_stats ? &stats : NULL)) {
2293         facet->installed = true;
2294     }
2295 }
2296
2297 /* Ensures that the bytes in 'facet', plus 'extra_bytes', have been passed up
2298  * to the accounting hook function in the ofhooks structure. */
2299 static void
2300 facet_account(struct ofproto *ofproto,
2301               struct facet *facet, uint64_t extra_bytes)
2302 {
2303     uint64_t total_bytes = facet->byte_count + extra_bytes;
2304
2305     if (ofproto->ofhooks->account_flow_cb
2306         && total_bytes > facet->accounted_bytes)
2307     {
2308         ofproto->ofhooks->account_flow_cb(
2309             &facet->flow, facet->tags, facet->actions, facet->actions_len,
2310             total_bytes - facet->accounted_bytes, ofproto->aux);
2311         facet->accounted_bytes = total_bytes;
2312     }
2313 }
2314
2315 /* If 'rule' is installed in the datapath, uninstalls it. */
2316 static void
2317 facet_uninstall(struct ofproto *p, struct facet *facet)
2318 {
2319     if (facet->installed) {
2320         uint32_t keybuf[ODPUTIL_FLOW_KEY_U32S];
2321         struct dpif_flow_stats stats;
2322         struct ofpbuf key;
2323
2324         ofpbuf_use_stack(&key, keybuf, sizeof keybuf);
2325         odp_flow_key_from_flow(&key, &facet->flow);
2326         assert(key.base == keybuf);
2327
2328         if (!dpif_flow_del(p->dpif, key.data, key.size, &stats)) {
2329             facet_update_stats(p, facet, &stats);
2330         }
2331         facet->installed = false;
2332         facet->dp_packet_count = 0;
2333         facet->dp_byte_count = 0;
2334     } else {
2335         assert(facet->dp_packet_count == 0);
2336         assert(facet->dp_byte_count == 0);
2337     }
2338 }
2339
2340 /* Returns true if the only action for 'facet' is to send to the controller.
2341  * (We don't report NetFlow expiration messages for such facets because they
2342  * are just part of the control logic for the network, not real traffic). */
2343 static bool
2344 facet_is_controller_flow(struct facet *facet)
2345 {
2346     return (facet
2347             && facet->rule->n_actions == 1
2348             && action_outputs_to_port(&facet->rule->actions[0],
2349                                       htons(OFPP_CONTROLLER)));
2350 }
2351
2352 /* Folds all of 'facet''s statistics into its rule.  Also updates the
2353  * accounting ofhook and emits a NetFlow expiration if appropriate.  All of
2354  * 'facet''s statistics in the datapath should have been zeroed and folded into
2355  * its packet and byte counts before this function is called. */
2356 static void
2357 facet_flush_stats(struct ofproto *ofproto, struct facet *facet)
2358 {
2359     assert(!facet->dp_byte_count);
2360     assert(!facet->dp_packet_count);
2361
2362     facet_push_stats(ofproto, facet);
2363     facet_account(ofproto, facet, 0);
2364
2365     if (ofproto->netflow && !facet_is_controller_flow(facet)) {
2366         struct ofexpired expired;
2367         expired.flow = facet->flow;
2368         expired.packet_count = facet->packet_count;
2369         expired.byte_count = facet->byte_count;
2370         expired.used = facet->used;
2371         netflow_expire(ofproto->netflow, &facet->nf_flow, &expired);
2372     }
2373
2374     facet->rule->packet_count += facet->packet_count;
2375     facet->rule->byte_count += facet->byte_count;
2376
2377     /* Reset counters to prevent double counting if 'facet' ever gets
2378      * reinstalled. */
2379     facet->packet_count = 0;
2380     facet->byte_count = 0;
2381     facet->rs_packet_count = 0;
2382     facet->rs_byte_count = 0;
2383     facet->accounted_bytes = 0;
2384
2385     netflow_flow_clear(&facet->nf_flow);
2386 }
2387
2388 /* Searches 'ofproto''s table of facets for one exactly equal to 'flow'.
2389  * Returns it if found, otherwise a null pointer.
2390  *
2391  * The returned facet might need revalidation; use facet_lookup_valid()
2392  * instead if that is important. */
2393 static struct facet *
2394 facet_find(struct ofproto *ofproto, const struct flow *flow)
2395 {
2396     struct facet *facet;
2397
2398     HMAP_FOR_EACH_WITH_HASH (facet, hmap_node, flow_hash(flow, 0),
2399                              &ofproto->facets) {
2400         if (flow_equal(flow, &facet->flow)) {
2401             return facet;
2402         }
2403     }
2404
2405     return NULL;
2406 }
2407
2408 /* Searches 'ofproto''s table of facets for one exactly equal to 'flow'.
2409  * Returns it if found, otherwise a null pointer.
2410  *
2411  * The returned facet is guaranteed to be valid. */
2412 static struct facet *
2413 facet_lookup_valid(struct ofproto *ofproto, const struct flow *flow)
2414 {
2415     struct facet *facet = facet_find(ofproto, flow);
2416
2417     /* The facet we found might not be valid, since we could be in need of
2418      * revalidation.  If it is not valid, don't return it. */
2419     if (facet
2420         && ofproto->need_revalidate
2421         && !facet_revalidate(ofproto, facet)) {
2422         COVERAGE_INC(ofproto_invalidated);
2423         return NULL;
2424     }
2425
2426     return facet;
2427 }
2428
2429 /* Re-searches 'ofproto''s classifier for a rule matching 'facet':
2430  *
2431  *   - If the rule found is different from 'facet''s current rule, moves
2432  *     'facet' to the new rule and recompiles its actions.
2433  *
2434  *   - If the rule found is the same as 'facet''s current rule, leaves 'facet'
2435  *     where it is and recompiles its actions anyway.
2436  *
2437  *   - If there is none, destroys 'facet'.
2438  *
2439  * Returns true if 'facet' still exists, false if it has been destroyed. */
2440 static bool
2441 facet_revalidate(struct ofproto *ofproto, struct facet *facet)
2442 {
2443     struct action_xlate_ctx ctx;
2444     struct ofpbuf *odp_actions;
2445     struct rule *new_rule;
2446     bool actions_changed;
2447
2448     COVERAGE_INC(facet_revalidate);
2449
2450     /* Determine the new rule. */
2451     new_rule = rule_lookup(ofproto, &facet->flow);
2452     if (!new_rule) {
2453         /* No new rule, so delete the facet. */
2454         facet_remove(ofproto, facet);
2455         return false;
2456     }
2457
2458     /* Calculate new ODP actions.
2459      *
2460      * We do not modify any 'facet' state yet, because we might need to, e.g.,
2461      * emit a NetFlow expiration and, if so, we need to have the old state
2462      * around to properly compose it. */
2463     action_xlate_ctx_init(&ctx, ofproto, &facet->flow, NULL);
2464     odp_actions = xlate_actions(&ctx, new_rule->actions, new_rule->n_actions);
2465     actions_changed = (facet->actions_len != odp_actions->size
2466                        || memcmp(facet->actions, odp_actions->data,
2467                                  facet->actions_len));
2468
2469     /* If the ODP actions changed or the installability changed, then we need
2470      * to talk to the datapath. */
2471     if (actions_changed || ctx.may_set_up_flow != facet->installed) {
2472         if (ctx.may_set_up_flow) {
2473             struct dpif_flow_stats stats;
2474
2475             facet_put__(ofproto, facet,
2476                         odp_actions->data, odp_actions->size, &stats);
2477             facet_update_stats(ofproto, facet, &stats);
2478         } else {
2479             facet_uninstall(ofproto, facet);
2480         }
2481
2482         /* The datapath flow is gone or has zeroed stats, so push stats out of
2483          * 'facet' into 'rule'. */
2484         facet_flush_stats(ofproto, facet);
2485     }
2486
2487     /* Update 'facet' now that we've taken care of all the old state. */
2488     facet->tags = ctx.tags;
2489     facet->nf_flow.output_iface = ctx.nf_output_iface;
2490     facet->may_install = ctx.may_set_up_flow;
2491     if (actions_changed) {
2492         free(facet->actions);
2493         facet->actions_len = odp_actions->size;
2494         facet->actions = xmemdup(odp_actions->data, odp_actions->size);
2495     }
2496     if (facet->rule != new_rule) {
2497         COVERAGE_INC(facet_changed_rule);
2498         list_remove(&facet->list_node);
2499         list_push_back(&new_rule->facets, &facet->list_node);
2500         facet->rule = new_rule;
2501         facet->used = new_rule->created;
2502         facet->rs_used = facet->used;
2503     }
2504
2505     ofpbuf_delete(odp_actions);
2506
2507     return true;
2508 }
2509 \f
2510 static void
2511 queue_tx(struct ofpbuf *msg, const struct ofconn *ofconn,
2512          struct rconn_packet_counter *counter)
2513 {
2514     update_openflow_length(msg);
2515     if (rconn_send(ofconn->rconn, msg, counter)) {
2516         ofpbuf_delete(msg);
2517     }
2518 }
2519
2520 static void
2521 send_error_oh(const struct ofconn *ofconn, const struct ofp_header *oh,
2522               int error)
2523 {
2524     struct ofpbuf *buf = ofputil_encode_error_msg(error, oh);
2525     if (buf) {
2526         COVERAGE_INC(ofproto_error);
2527         queue_tx(buf, ofconn, ofconn->reply_counter);
2528     }
2529 }
2530
2531 static void
2532 hton_ofp_phy_port(struct ofp_phy_port *opp)
2533 {
2534     opp->port_no = htons(opp->port_no);
2535     opp->config = htonl(opp->config);
2536     opp->state = htonl(opp->state);
2537     opp->curr = htonl(opp->curr);
2538     opp->advertised = htonl(opp->advertised);
2539     opp->supported = htonl(opp->supported);
2540     opp->peer = htonl(opp->peer);
2541 }
2542
2543 static int
2544 handle_echo_request(struct ofconn *ofconn, const struct ofp_header *oh)
2545 {
2546     queue_tx(make_echo_reply(oh), ofconn, ofconn->reply_counter);
2547     return 0;
2548 }
2549
2550 static int
2551 handle_features_request(struct ofconn *ofconn, const struct ofp_header *oh)
2552 {
2553     struct ofp_switch_features *osf;
2554     struct ofpbuf *buf;
2555     struct ofport *port;
2556
2557     osf = make_openflow_xid(sizeof *osf, OFPT_FEATURES_REPLY, oh->xid, &buf);
2558     osf->datapath_id = htonll(ofconn->ofproto->datapath_id);
2559     osf->n_buffers = htonl(pktbuf_capacity());
2560     osf->n_tables = 2;
2561     osf->capabilities = htonl(OFPC_FLOW_STATS | OFPC_TABLE_STATS |
2562                               OFPC_PORT_STATS | OFPC_ARP_MATCH_IP);
2563     osf->actions = htonl((1u << OFPAT_OUTPUT) |
2564                          (1u << OFPAT_SET_VLAN_VID) |
2565                          (1u << OFPAT_SET_VLAN_PCP) |
2566                          (1u << OFPAT_STRIP_VLAN) |
2567                          (1u << OFPAT_SET_DL_SRC) |
2568                          (1u << OFPAT_SET_DL_DST) |
2569                          (1u << OFPAT_SET_NW_SRC) |
2570                          (1u << OFPAT_SET_NW_DST) |
2571                          (1u << OFPAT_SET_NW_TOS) |
2572                          (1u << OFPAT_SET_TP_SRC) |
2573                          (1u << OFPAT_SET_TP_DST) |
2574                          (1u << OFPAT_ENQUEUE));
2575
2576     HMAP_FOR_EACH (port, hmap_node, &ofconn->ofproto->ports) {
2577         hton_ofp_phy_port(ofpbuf_put(buf, &port->opp, sizeof port->opp));
2578     }
2579
2580     queue_tx(buf, ofconn, ofconn->reply_counter);
2581     return 0;
2582 }
2583
2584 static int
2585 handle_get_config_request(struct ofconn *ofconn, const struct ofp_header *oh)
2586 {
2587     struct ofpbuf *buf;
2588     struct ofp_switch_config *osc;
2589     uint16_t flags;
2590     bool drop_frags;
2591
2592     /* Figure out flags. */
2593     dpif_get_drop_frags(ofconn->ofproto->dpif, &drop_frags);
2594     flags = drop_frags ? OFPC_FRAG_DROP : OFPC_FRAG_NORMAL;
2595
2596     /* Send reply. */
2597     osc = make_openflow_xid(sizeof *osc, OFPT_GET_CONFIG_REPLY, oh->xid, &buf);
2598     osc->flags = htons(flags);
2599     osc->miss_send_len = htons(ofconn->miss_send_len);
2600     queue_tx(buf, ofconn, ofconn->reply_counter);
2601
2602     return 0;
2603 }
2604
2605 static int
2606 handle_set_config(struct ofconn *ofconn, const struct ofp_switch_config *osc)
2607 {
2608     uint16_t flags = ntohs(osc->flags);
2609
2610     if (ofconn->type == OFCONN_PRIMARY && ofconn->role != NX_ROLE_SLAVE) {
2611         switch (flags & OFPC_FRAG_MASK) {
2612         case OFPC_FRAG_NORMAL:
2613             dpif_set_drop_frags(ofconn->ofproto->dpif, false);
2614             break;
2615         case OFPC_FRAG_DROP:
2616             dpif_set_drop_frags(ofconn->ofproto->dpif, true);
2617             break;
2618         default:
2619             VLOG_WARN_RL(&rl, "requested bad fragment mode (flags=%"PRIx16")",
2620                          osc->flags);
2621             break;
2622         }
2623     }
2624
2625     ofconn->miss_send_len = ntohs(osc->miss_send_len);
2626
2627     return 0;
2628 }
2629
2630 static void do_xlate_actions(const union ofp_action *in, size_t n_in,
2631                              struct action_xlate_ctx *ctx);
2632
2633 static void
2634 add_output_action(struct action_xlate_ctx *ctx, uint16_t port)
2635 {
2636     const struct ofport *ofport = get_port(ctx->ofproto, port);
2637
2638     if (ofport) {
2639         if (ofport->opp.config & OFPPC_NO_FWD) {
2640             /* Forwarding disabled on port. */
2641             return;
2642         }
2643     } else {
2644         /*
2645          * We don't have an ofport record for this port, but it doesn't hurt to
2646          * allow forwarding to it anyhow.  Maybe such a port will appear later
2647          * and we're pre-populating the flow table.
2648          */
2649     }
2650
2651     nl_msg_put_u32(ctx->odp_actions, ODP_ACTION_ATTR_OUTPUT, port);
2652     ctx->nf_output_iface = port;
2653 }
2654
2655 static struct rule *
2656 rule_lookup(struct ofproto *ofproto, const struct flow *flow)
2657 {
2658     return rule_from_cls_rule(classifier_lookup(&ofproto->cls, flow));
2659 }
2660
2661 static void
2662 xlate_table_action(struct action_xlate_ctx *ctx, uint16_t in_port)
2663 {
2664     if (ctx->recurse < MAX_RESUBMIT_RECURSION) {
2665         uint16_t old_in_port;
2666         struct rule *rule;
2667
2668         /* Look up a flow with 'in_port' as the input port.  Then restore the
2669          * original input port (otherwise OFPP_NORMAL and OFPP_IN_PORT will
2670          * have surprising behavior). */
2671         old_in_port = ctx->flow.in_port;
2672         ctx->flow.in_port = in_port;
2673         rule = rule_lookup(ctx->ofproto, &ctx->flow);
2674         ctx->flow.in_port = old_in_port;
2675
2676         if (ctx->resubmit_hook) {
2677             ctx->resubmit_hook(ctx, rule);
2678         }
2679
2680         if (rule) {
2681             ctx->recurse++;
2682             do_xlate_actions(rule->actions, rule->n_actions, ctx);
2683             ctx->recurse--;
2684         }
2685     } else {
2686         static struct vlog_rate_limit recurse_rl = VLOG_RATE_LIMIT_INIT(1, 1);
2687
2688         VLOG_ERR_RL(&recurse_rl, "NXAST_RESUBMIT recursed over %d times",
2689                     MAX_RESUBMIT_RECURSION);
2690     }
2691 }
2692
2693 static void
2694 flood_packets(struct ofproto *ofproto, uint16_t odp_in_port, uint32_t mask,
2695               uint16_t *nf_output_iface, struct ofpbuf *odp_actions)
2696 {
2697     struct ofport *ofport;
2698
2699     HMAP_FOR_EACH (ofport, hmap_node, &ofproto->ports) {
2700         uint16_t odp_port = ofport->odp_port;
2701         if (odp_port != odp_in_port && !(ofport->opp.config & mask)) {
2702             nl_msg_put_u32(odp_actions, ODP_ACTION_ATTR_OUTPUT, odp_port);
2703         }
2704     }
2705     *nf_output_iface = NF_OUT_FLOOD;
2706 }
2707
2708 static void
2709 xlate_output_action__(struct action_xlate_ctx *ctx,
2710                       uint16_t port, uint16_t max_len)
2711 {
2712     uint16_t odp_port;
2713     uint16_t prev_nf_output_iface = ctx->nf_output_iface;
2714
2715     ctx->nf_output_iface = NF_OUT_DROP;
2716
2717     switch (port) {
2718     case OFPP_IN_PORT:
2719         add_output_action(ctx, ctx->flow.in_port);
2720         break;
2721     case OFPP_TABLE:
2722         xlate_table_action(ctx, ctx->flow.in_port);
2723         break;
2724     case OFPP_NORMAL:
2725         if (!ctx->ofproto->ofhooks->normal_cb(&ctx->flow, ctx->packet,
2726                                               ctx->odp_actions, &ctx->tags,
2727                                               &ctx->nf_output_iface,
2728                                               ctx->ofproto->aux)) {
2729             COVERAGE_INC(ofproto_uninstallable);
2730             ctx->may_set_up_flow = false;
2731         }
2732         break;
2733     case OFPP_FLOOD:
2734         flood_packets(ctx->ofproto, ctx->flow.in_port, OFPPC_NO_FLOOD,
2735                       &ctx->nf_output_iface, ctx->odp_actions);
2736         break;
2737     case OFPP_ALL:
2738         flood_packets(ctx->ofproto, ctx->flow.in_port, 0,
2739                       &ctx->nf_output_iface, ctx->odp_actions);
2740         break;
2741     case OFPP_CONTROLLER:
2742         nl_msg_put_u64(ctx->odp_actions, ODP_ACTION_ATTR_CONTROLLER, max_len);
2743         break;
2744     case OFPP_LOCAL:
2745         add_output_action(ctx, ODPP_LOCAL);
2746         break;
2747     default:
2748         odp_port = ofp_port_to_odp_port(port);
2749         if (odp_port != ctx->flow.in_port) {
2750             add_output_action(ctx, odp_port);
2751         }
2752         break;
2753     }
2754
2755     if (prev_nf_output_iface == NF_OUT_FLOOD) {
2756         ctx->nf_output_iface = NF_OUT_FLOOD;
2757     } else if (ctx->nf_output_iface == NF_OUT_DROP) {
2758         ctx->nf_output_iface = prev_nf_output_iface;
2759     } else if (prev_nf_output_iface != NF_OUT_DROP &&
2760                ctx->nf_output_iface != NF_OUT_FLOOD) {
2761         ctx->nf_output_iface = NF_OUT_MULTI;
2762     }
2763 }
2764
2765 static void
2766 xlate_output_action(struct action_xlate_ctx *ctx,
2767                     const struct ofp_action_output *oao)
2768 {
2769     xlate_output_action__(ctx, ntohs(oao->port), ntohs(oao->max_len));
2770 }
2771
2772 /* If the final ODP action in 'ctx' is "pop priority", drop it, as an
2773  * optimization, because we're going to add another action that sets the
2774  * priority immediately after, or because there are no actions following the
2775  * pop.  */
2776 static void
2777 remove_pop_action(struct action_xlate_ctx *ctx)
2778 {
2779     if (ctx->odp_actions->size == ctx->last_pop_priority) {
2780         ctx->odp_actions->size -= NLA_ALIGN(NLA_HDRLEN);
2781         ctx->last_pop_priority = -1;
2782     }
2783 }
2784
2785 static void
2786 add_pop_action(struct action_xlate_ctx *ctx)
2787 {
2788     if (ctx->odp_actions->size != ctx->last_pop_priority) {
2789         nl_msg_put_flag(ctx->odp_actions, ODP_ACTION_ATTR_POP_PRIORITY);
2790         ctx->last_pop_priority = ctx->odp_actions->size;
2791     }
2792 }
2793
2794 static void
2795 xlate_enqueue_action(struct action_xlate_ctx *ctx,
2796                      const struct ofp_action_enqueue *oae)
2797 {
2798     uint16_t ofp_port, odp_port;
2799     uint32_t priority;
2800     int error;
2801
2802     error = dpif_queue_to_priority(ctx->ofproto->dpif, ntohl(oae->queue_id),
2803                                    &priority);
2804     if (error) {
2805         /* Fall back to ordinary output action. */
2806         xlate_output_action__(ctx, ntohs(oae->port), 0);
2807         return;
2808     }
2809
2810     /* Figure out ODP output port. */
2811     ofp_port = ntohs(oae->port);
2812     if (ofp_port != OFPP_IN_PORT) {
2813         odp_port = ofp_port_to_odp_port(ofp_port);
2814     } else {
2815         odp_port = ctx->flow.in_port;
2816     }
2817
2818     /* Add ODP actions. */
2819     remove_pop_action(ctx);
2820     nl_msg_put_u32(ctx->odp_actions, ODP_ACTION_ATTR_SET_PRIORITY, priority);
2821     add_output_action(ctx, odp_port);
2822     add_pop_action(ctx);
2823
2824     /* Update NetFlow output port. */
2825     if (ctx->nf_output_iface == NF_OUT_DROP) {
2826         ctx->nf_output_iface = odp_port;
2827     } else if (ctx->nf_output_iface != NF_OUT_FLOOD) {
2828         ctx->nf_output_iface = NF_OUT_MULTI;
2829     }
2830 }
2831
2832 static void
2833 xlate_set_queue_action(struct action_xlate_ctx *ctx,
2834                        const struct nx_action_set_queue *nasq)
2835 {
2836     uint32_t priority;
2837     int error;
2838
2839     error = dpif_queue_to_priority(ctx->ofproto->dpif, ntohl(nasq->queue_id),
2840                                    &priority);
2841     if (error) {
2842         /* Couldn't translate queue to a priority, so ignore.  A warning
2843          * has already been logged. */
2844         return;
2845     }
2846
2847     remove_pop_action(ctx);
2848     nl_msg_put_u32(ctx->odp_actions, ODP_ACTION_ATTR_SET_PRIORITY, priority);
2849 }
2850
2851 static void
2852 xlate_set_dl_tci(struct action_xlate_ctx *ctx)
2853 {
2854     ovs_be16 tci = ctx->flow.vlan_tci;
2855     if (!(tci & htons(VLAN_CFI))) {
2856         nl_msg_put_flag(ctx->odp_actions, ODP_ACTION_ATTR_STRIP_VLAN);
2857     } else {
2858         nl_msg_put_be16(ctx->odp_actions, ODP_ACTION_ATTR_SET_DL_TCI,
2859                         tci & ~htons(VLAN_CFI));
2860     }
2861 }
2862
2863 struct xlate_reg_state {
2864     ovs_be16 vlan_tci;
2865     ovs_be64 tun_id;
2866 };
2867
2868 static void
2869 save_reg_state(const struct action_xlate_ctx *ctx,
2870                struct xlate_reg_state *state)
2871 {
2872     state->vlan_tci = ctx->flow.vlan_tci;
2873     state->tun_id = ctx->flow.tun_id;
2874 }
2875
2876 static void
2877 update_reg_state(struct action_xlate_ctx *ctx,
2878                  const struct xlate_reg_state *state)
2879 {
2880     if (ctx->flow.vlan_tci != state->vlan_tci) {
2881         xlate_set_dl_tci(ctx);
2882     }
2883     if (ctx->flow.tun_id != state->tun_id) {
2884         nl_msg_put_be64(ctx->odp_actions,
2885                         ODP_ACTION_ATTR_SET_TUNNEL, ctx->flow.tun_id);
2886     }
2887 }
2888
2889 static void
2890 xlate_nicira_action(struct action_xlate_ctx *ctx,
2891                     const struct nx_action_header *nah)
2892 {
2893     const struct nx_action_resubmit *nar;
2894     const struct nx_action_set_tunnel *nast;
2895     const struct nx_action_set_queue *nasq;
2896     const struct nx_action_multipath *nam;
2897     enum nx_action_subtype subtype = ntohs(nah->subtype);
2898     struct xlate_reg_state state;
2899     ovs_be64 tun_id;
2900
2901     assert(nah->vendor == htonl(NX_VENDOR_ID));
2902     switch (subtype) {
2903     case NXAST_RESUBMIT:
2904         nar = (const struct nx_action_resubmit *) nah;
2905         xlate_table_action(ctx, ofp_port_to_odp_port(ntohs(nar->in_port)));
2906         break;
2907
2908     case NXAST_SET_TUNNEL:
2909         nast = (const struct nx_action_set_tunnel *) nah;
2910         tun_id = htonll(ntohl(nast->tun_id));
2911         nl_msg_put_be64(ctx->odp_actions, ODP_ACTION_ATTR_SET_TUNNEL, tun_id);
2912         ctx->flow.tun_id = tun_id;
2913         break;
2914
2915     case NXAST_DROP_SPOOFED_ARP:
2916         if (ctx->flow.dl_type == htons(ETH_TYPE_ARP)) {
2917             nl_msg_put_flag(ctx->odp_actions,
2918                             ODP_ACTION_ATTR_DROP_SPOOFED_ARP);
2919         }
2920         break;
2921
2922     case NXAST_SET_QUEUE:
2923         nasq = (const struct nx_action_set_queue *) nah;
2924         xlate_set_queue_action(ctx, nasq);
2925         break;
2926
2927     case NXAST_POP_QUEUE:
2928         add_pop_action(ctx);
2929         break;
2930
2931     case NXAST_REG_MOVE:
2932         save_reg_state(ctx, &state);
2933         nxm_execute_reg_move((const struct nx_action_reg_move *) nah,
2934                              &ctx->flow);
2935         update_reg_state(ctx, &state);
2936         break;
2937
2938     case NXAST_REG_LOAD:
2939         save_reg_state(ctx, &state);
2940         nxm_execute_reg_load((const struct nx_action_reg_load *) nah,
2941                              &ctx->flow);
2942         update_reg_state(ctx, &state);
2943         break;
2944
2945     case NXAST_NOTE:
2946         /* Nothing to do. */
2947         break;
2948
2949     case NXAST_SET_TUNNEL64:
2950         tun_id = ((const struct nx_action_set_tunnel64 *) nah)->tun_id;
2951         nl_msg_put_be64(ctx->odp_actions, ODP_ACTION_ATTR_SET_TUNNEL, tun_id);
2952         ctx->flow.tun_id = tun_id;
2953         break;
2954
2955     case NXAST_MULTIPATH:
2956         nam = (const struct nx_action_multipath *) nah;
2957         multipath_execute(nam, &ctx->flow);
2958         break;
2959
2960     /* If you add a new action here that modifies flow data, don't forget to
2961      * update the flow key in ctx->flow at the same time. */
2962
2963     case NXAST_SNAT__OBSOLETE:
2964     default:
2965         VLOG_DBG_RL(&rl, "unknown Nicira action type %d", (int) subtype);
2966         break;
2967     }
2968 }
2969
2970 static void
2971 do_xlate_actions(const union ofp_action *in, size_t n_in,
2972                  struct action_xlate_ctx *ctx)
2973 {
2974     struct actions_iterator iter;
2975     const union ofp_action *ia;
2976     const struct ofport *port;
2977
2978     port = get_port(ctx->ofproto, ctx->flow.in_port);
2979     if (port && port->opp.config & (OFPPC_NO_RECV | OFPPC_NO_RECV_STP) &&
2980         port->opp.config & (eth_addr_equals(ctx->flow.dl_dst, eth_addr_stp)
2981                             ? OFPPC_NO_RECV_STP : OFPPC_NO_RECV)) {
2982         /* Drop this flow. */
2983         return;
2984     }
2985
2986     for (ia = actions_first(&iter, in, n_in); ia; ia = actions_next(&iter)) {
2987         enum ofp_action_type type = ntohs(ia->type);
2988         const struct ofp_action_dl_addr *oada;
2989
2990         switch (type) {
2991         case OFPAT_OUTPUT:
2992             xlate_output_action(ctx, &ia->output);
2993             break;
2994
2995         case OFPAT_SET_VLAN_VID:
2996             ctx->flow.vlan_tci &= ~htons(VLAN_VID_MASK);
2997             ctx->flow.vlan_tci |= ia->vlan_vid.vlan_vid | htons(VLAN_CFI);
2998             xlate_set_dl_tci(ctx);
2999             break;
3000
3001         case OFPAT_SET_VLAN_PCP:
3002             ctx->flow.vlan_tci &= ~htons(VLAN_PCP_MASK);
3003             ctx->flow.vlan_tci |= htons(
3004                 (ia->vlan_pcp.vlan_pcp << VLAN_PCP_SHIFT) | VLAN_CFI);
3005             xlate_set_dl_tci(ctx);
3006             break;
3007
3008         case OFPAT_STRIP_VLAN:
3009             ctx->flow.vlan_tci = htons(0);
3010             xlate_set_dl_tci(ctx);
3011             break;
3012
3013         case OFPAT_SET_DL_SRC:
3014             oada = ((struct ofp_action_dl_addr *) ia);
3015             nl_msg_put_unspec(ctx->odp_actions, ODP_ACTION_ATTR_SET_DL_SRC,
3016                               oada->dl_addr, ETH_ADDR_LEN);
3017             memcpy(ctx->flow.dl_src, oada->dl_addr, ETH_ADDR_LEN);
3018             break;
3019
3020         case OFPAT_SET_DL_DST:
3021             oada = ((struct ofp_action_dl_addr *) ia);
3022             nl_msg_put_unspec(ctx->odp_actions, ODP_ACTION_ATTR_SET_DL_DST,
3023                               oada->dl_addr, ETH_ADDR_LEN);
3024             memcpy(ctx->flow.dl_dst, oada->dl_addr, ETH_ADDR_LEN);
3025             break;
3026
3027         case OFPAT_SET_NW_SRC:
3028             nl_msg_put_be32(ctx->odp_actions, ODP_ACTION_ATTR_SET_NW_SRC,
3029                             ia->nw_addr.nw_addr);
3030             ctx->flow.nw_src = ia->nw_addr.nw_addr;
3031             break;
3032
3033         case OFPAT_SET_NW_DST:
3034             nl_msg_put_be32(ctx->odp_actions, ODP_ACTION_ATTR_SET_NW_DST,
3035                             ia->nw_addr.nw_addr);
3036             ctx->flow.nw_dst = ia->nw_addr.nw_addr;
3037             break;
3038
3039         case OFPAT_SET_NW_TOS:
3040             nl_msg_put_u8(ctx->odp_actions, ODP_ACTION_ATTR_SET_NW_TOS,
3041                           ia->nw_tos.nw_tos);
3042             ctx->flow.nw_tos = ia->nw_tos.nw_tos;
3043             break;
3044
3045         case OFPAT_SET_TP_SRC:
3046             nl_msg_put_be16(ctx->odp_actions, ODP_ACTION_ATTR_SET_TP_SRC,
3047                             ia->tp_port.tp_port);
3048             ctx->flow.tp_src = ia->tp_port.tp_port;
3049             break;
3050
3051         case OFPAT_SET_TP_DST:
3052             nl_msg_put_be16(ctx->odp_actions, ODP_ACTION_ATTR_SET_TP_DST,
3053                             ia->tp_port.tp_port);
3054             ctx->flow.tp_dst = ia->tp_port.tp_port;
3055             break;
3056
3057         case OFPAT_VENDOR:
3058             xlate_nicira_action(ctx, (const struct nx_action_header *) ia);
3059             break;
3060
3061         case OFPAT_ENQUEUE:
3062             xlate_enqueue_action(ctx, (const struct ofp_action_enqueue *) ia);
3063             break;
3064
3065         default:
3066             VLOG_DBG_RL(&rl, "unknown action type %d", (int) type);
3067             break;
3068         }
3069     }
3070 }
3071
3072 static void
3073 action_xlate_ctx_init(struct action_xlate_ctx *ctx,
3074                       struct ofproto *ofproto, const struct flow *flow,
3075                       const struct ofpbuf *packet)
3076 {
3077     ctx->ofproto = ofproto;
3078     ctx->flow = *flow;
3079     ctx->packet = packet;
3080     ctx->resubmit_hook = NULL;
3081     ctx->check_special = true;
3082 }
3083
3084 static struct ofpbuf *
3085 xlate_actions(struct action_xlate_ctx *ctx,
3086               const union ofp_action *in, size_t n_in)
3087 {
3088     COVERAGE_INC(ofproto_ofp2odp);
3089
3090     ctx->odp_actions = ofpbuf_new(512);
3091     ctx->tags = 0;
3092     ctx->may_set_up_flow = true;
3093     ctx->nf_output_iface = NF_OUT_DROP;
3094     ctx->recurse = 0;
3095     ctx->last_pop_priority = -1;
3096
3097     if (!ctx->check_special
3098         || !ctx->ofproto->ofhooks->special_cb
3099         || ctx->ofproto->ofhooks->special_cb(&ctx->flow, ctx->packet,
3100                                              ctx->ofproto->aux)) {
3101         do_xlate_actions(in, n_in, ctx);
3102     } else {
3103         ctx->may_set_up_flow = false;
3104     }
3105
3106     remove_pop_action(ctx);
3107
3108     /* Check with in-band control to see if we're allowed to set up this
3109      * flow. */
3110     if (!in_band_rule_check(ctx->ofproto->in_band, &ctx->flow,
3111                             ctx->odp_actions->data, ctx->odp_actions->size)) {
3112         ctx->may_set_up_flow = false;
3113     }
3114
3115     return ctx->odp_actions;
3116 }
3117
3118 /* Checks whether 'ofconn' is a slave controller.  If so, returns an OpenFlow
3119  * error message code (composed with ofp_mkerr()) for the caller to propagate
3120  * upward.  Otherwise, returns 0.
3121  *
3122  * The log message mentions 'msg_type'. */
3123 static int
3124 reject_slave_controller(struct ofconn *ofconn, const const char *msg_type)
3125 {
3126     if (ofconn->type == OFCONN_PRIMARY && ofconn->role == NX_ROLE_SLAVE) {
3127         static struct vlog_rate_limit perm_rl = VLOG_RATE_LIMIT_INIT(1, 5);
3128         VLOG_WARN_RL(&perm_rl, "rejecting %s message from slave controller",
3129                      msg_type);
3130
3131         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_EPERM);
3132     } else {
3133         return 0;
3134     }
3135 }
3136
3137 static int
3138 handle_packet_out(struct ofconn *ofconn, const struct ofp_header *oh)
3139 {
3140     struct ofproto *p = ofconn->ofproto;
3141     struct ofp_packet_out *opo;
3142     struct ofpbuf payload, *buffer;
3143     union ofp_action *ofp_actions;
3144     struct action_xlate_ctx ctx;
3145     struct ofpbuf *odp_actions;
3146     struct ofpbuf request;
3147     struct flow flow;
3148     size_t n_ofp_actions;
3149     uint16_t in_port;
3150     int error;
3151
3152     COVERAGE_INC(ofproto_packet_out);
3153
3154     error = reject_slave_controller(ofconn, "OFPT_PACKET_OUT");
3155     if (error) {
3156         return error;
3157     }
3158
3159     /* Get ofp_packet_out. */
3160     ofpbuf_use_const(&request, oh, ntohs(oh->length));
3161     opo = ofpbuf_pull(&request, offsetof(struct ofp_packet_out, actions));
3162
3163     /* Get actions. */
3164     error = ofputil_pull_actions(&request, ntohs(opo->actions_len),
3165                                  &ofp_actions, &n_ofp_actions);
3166     if (error) {
3167         return error;
3168     }
3169
3170     /* Get payload. */
3171     if (opo->buffer_id != htonl(UINT32_MAX)) {
3172         error = pktbuf_retrieve(ofconn->pktbuf, ntohl(opo->buffer_id),
3173                                 &buffer, &in_port);
3174         if (error || !buffer) {
3175             return error;
3176         }
3177         payload = *buffer;
3178     } else {
3179         payload = request;
3180         buffer = NULL;
3181     }
3182
3183     /* Extract flow, check actions. */
3184     flow_extract(&payload, 0, ofp_port_to_odp_port(ntohs(opo->in_port)),
3185                  &flow);
3186     error = validate_actions(ofp_actions, n_ofp_actions, &flow, p->max_ports);
3187     if (error) {
3188         goto exit;
3189     }
3190
3191     /* Send. */
3192     action_xlate_ctx_init(&ctx, p, &flow, &payload);
3193     odp_actions = xlate_actions(&ctx, ofp_actions, n_ofp_actions);
3194     dpif_execute(p->dpif, odp_actions->data, odp_actions->size, &payload);
3195     ofpbuf_delete(odp_actions);
3196
3197 exit:
3198     ofpbuf_delete(buffer);
3199     return 0;
3200 }
3201
3202 static void
3203 update_port_config(struct ofproto *p, struct ofport *port,
3204                    uint32_t config, uint32_t mask)
3205 {
3206     mask &= config ^ port->opp.config;
3207     if (mask & OFPPC_PORT_DOWN) {
3208         if (config & OFPPC_PORT_DOWN) {
3209             netdev_turn_flags_off(port->netdev, NETDEV_UP, true);
3210         } else {
3211             netdev_turn_flags_on(port->netdev, NETDEV_UP, true);
3212         }
3213     }
3214 #define REVALIDATE_BITS (OFPPC_NO_RECV | OFPPC_NO_RECV_STP |    \
3215                          OFPPC_NO_FWD | OFPPC_NO_FLOOD)
3216     if (mask & REVALIDATE_BITS) {
3217         COVERAGE_INC(ofproto_costly_flags);
3218         port->opp.config ^= mask & REVALIDATE_BITS;
3219         p->need_revalidate = true;
3220     }
3221 #undef REVALIDATE_BITS
3222     if (mask & OFPPC_NO_PACKET_IN) {
3223         port->opp.config ^= OFPPC_NO_PACKET_IN;
3224     }
3225 }
3226
3227 static int
3228 handle_port_mod(struct ofconn *ofconn, const struct ofp_header *oh)
3229 {
3230     struct ofproto *p = ofconn->ofproto;
3231     const struct ofp_port_mod *opm = (const struct ofp_port_mod *) oh;
3232     struct ofport *port;
3233     int error;
3234
3235     error = reject_slave_controller(ofconn, "OFPT_PORT_MOD");
3236     if (error) {
3237         return error;
3238     }
3239
3240     port = get_port(p, ofp_port_to_odp_port(ntohs(opm->port_no)));
3241     if (!port) {
3242         return ofp_mkerr(OFPET_PORT_MOD_FAILED, OFPPMFC_BAD_PORT);
3243     } else if (memcmp(port->opp.hw_addr, opm->hw_addr, OFP_ETH_ALEN)) {
3244         return ofp_mkerr(OFPET_PORT_MOD_FAILED, OFPPMFC_BAD_HW_ADDR);
3245     } else {
3246         update_port_config(p, port, ntohl(opm->config), ntohl(opm->mask));
3247         if (opm->advertise) {
3248             netdev_set_advertisements(port->netdev, ntohl(opm->advertise));
3249         }
3250     }
3251     return 0;
3252 }
3253
3254 static struct ofpbuf *
3255 make_ofp_stats_reply(ovs_be32 xid, ovs_be16 type, size_t body_len)
3256 {
3257     struct ofp_stats_reply *osr;
3258     struct ofpbuf *msg;
3259
3260     msg = ofpbuf_new(MIN(sizeof *osr + body_len, UINT16_MAX));
3261     osr = put_openflow_xid(sizeof *osr, OFPT_STATS_REPLY, xid, msg);
3262     osr->type = type;
3263     osr->flags = htons(0);
3264     return msg;
3265 }
3266
3267 static struct ofpbuf *
3268 start_ofp_stats_reply(const struct ofp_header *request, size_t body_len)
3269 {
3270     const struct ofp_stats_request *osr
3271         = (const struct ofp_stats_request *) request;
3272     return make_ofp_stats_reply(osr->header.xid, osr->type, body_len);
3273 }
3274
3275 static void *
3276 append_ofp_stats_reply(size_t nbytes, struct ofconn *ofconn,
3277                        struct ofpbuf **msgp)
3278 {
3279     struct ofpbuf *msg = *msgp;
3280     assert(nbytes <= UINT16_MAX - sizeof(struct ofp_stats_reply));
3281     if (nbytes + msg->size > UINT16_MAX) {
3282         struct ofp_stats_reply *reply = msg->data;
3283         reply->flags = htons(OFPSF_REPLY_MORE);
3284         *msgp = make_ofp_stats_reply(reply->header.xid, reply->type, nbytes);
3285         queue_tx(msg, ofconn, ofconn->reply_counter);
3286     }
3287     return ofpbuf_put_uninit(*msgp, nbytes);
3288 }
3289
3290 static struct ofpbuf *
3291 make_nxstats_reply(ovs_be32 xid, ovs_be32 subtype, size_t body_len)
3292 {
3293     struct nicira_stats_msg *nsm;
3294     struct ofpbuf *msg;
3295
3296     msg = ofpbuf_new(MIN(sizeof *nsm + body_len, UINT16_MAX));
3297     nsm = put_openflow_xid(sizeof *nsm, OFPT_STATS_REPLY, xid, msg);
3298     nsm->type = htons(OFPST_VENDOR);
3299     nsm->flags = htons(0);
3300     nsm->vendor = htonl(NX_VENDOR_ID);
3301     nsm->subtype = subtype;
3302     return msg;
3303 }
3304
3305 static struct ofpbuf *
3306 start_nxstats_reply(const struct nicira_stats_msg *request, size_t body_len)
3307 {
3308     return make_nxstats_reply(request->header.xid, request->subtype, body_len);
3309 }
3310
3311 static void
3312 append_nxstats_reply(size_t nbytes, struct ofconn *ofconn,
3313                      struct ofpbuf **msgp)
3314 {
3315     struct ofpbuf *msg = *msgp;
3316     assert(nbytes <= UINT16_MAX - sizeof(struct nicira_stats_msg));
3317     if (nbytes + msg->size > UINT16_MAX) {
3318         struct nicira_stats_msg *reply = msg->data;
3319         reply->flags = htons(OFPSF_REPLY_MORE);
3320         *msgp = make_nxstats_reply(reply->header.xid, reply->subtype, nbytes);
3321         queue_tx(msg, ofconn, ofconn->reply_counter);
3322     }
3323     ofpbuf_prealloc_tailroom(*msgp, nbytes);
3324 }
3325
3326 static int
3327 handle_desc_stats_request(struct ofconn *ofconn,
3328                           const struct ofp_header *request)
3329 {
3330     struct ofproto *p = ofconn->ofproto;
3331     struct ofp_desc_stats *ods;
3332     struct ofpbuf *msg;
3333
3334     msg = start_ofp_stats_reply(request, sizeof *ods);
3335     ods = append_ofp_stats_reply(sizeof *ods, ofconn, &msg);
3336     memset(ods, 0, sizeof *ods);
3337     ovs_strlcpy(ods->mfr_desc, p->mfr_desc, sizeof ods->mfr_desc);
3338     ovs_strlcpy(ods->hw_desc, p->hw_desc, sizeof ods->hw_desc);
3339     ovs_strlcpy(ods->sw_desc, p->sw_desc, sizeof ods->sw_desc);
3340     ovs_strlcpy(ods->serial_num, p->serial_desc, sizeof ods->serial_num);
3341     ovs_strlcpy(ods->dp_desc, p->dp_desc, sizeof ods->dp_desc);
3342     queue_tx(msg, ofconn, ofconn->reply_counter);
3343
3344     return 0;
3345 }
3346
3347 static int
3348 handle_table_stats_request(struct ofconn *ofconn,
3349                            const struct ofp_header *request)
3350 {
3351     struct ofproto *p = ofconn->ofproto;
3352     struct ofp_table_stats *ots;
3353     struct ofpbuf *msg;
3354
3355     msg = start_ofp_stats_reply(request, sizeof *ots * 2);
3356
3357     /* Classifier table. */
3358     ots = append_ofp_stats_reply(sizeof *ots, ofconn, &msg);
3359     memset(ots, 0, sizeof *ots);
3360     strcpy(ots->name, "classifier");
3361     ots->wildcards = (ofconn->flow_format == NXFF_OPENFLOW10
3362                       ? htonl(OFPFW_ALL) : htonl(OVSFW_ALL));
3363     ots->max_entries = htonl(1024 * 1024); /* An arbitrary big number. */
3364     ots->active_count = htonl(classifier_count(&p->cls));
3365     put_32aligned_be64(&ots->lookup_count, htonll(0));  /* XXX */
3366     put_32aligned_be64(&ots->matched_count, htonll(0)); /* XXX */
3367
3368     queue_tx(msg, ofconn, ofconn->reply_counter);
3369     return 0;
3370 }
3371
3372 static void
3373 append_port_stat(struct ofport *port, struct ofconn *ofconn,
3374                  struct ofpbuf **msgp)
3375 {
3376     struct netdev_stats stats;
3377     struct ofp_port_stats *ops;
3378
3379     /* Intentionally ignore return value, since errors will set
3380      * 'stats' to all-1s, which is correct for OpenFlow, and
3381      * netdev_get_stats() will log errors. */
3382     netdev_get_stats(port->netdev, &stats);
3383
3384     ops = append_ofp_stats_reply(sizeof *ops, ofconn, msgp);
3385     ops->port_no = htons(port->opp.port_no);
3386     memset(ops->pad, 0, sizeof ops->pad);
3387     put_32aligned_be64(&ops->rx_packets, htonll(stats.rx_packets));
3388     put_32aligned_be64(&ops->tx_packets, htonll(stats.tx_packets));
3389     put_32aligned_be64(&ops->rx_bytes, htonll(stats.rx_bytes));
3390     put_32aligned_be64(&ops->tx_bytes, htonll(stats.tx_bytes));
3391     put_32aligned_be64(&ops->rx_dropped, htonll(stats.rx_dropped));
3392     put_32aligned_be64(&ops->tx_dropped, htonll(stats.tx_dropped));
3393     put_32aligned_be64(&ops->rx_errors, htonll(stats.rx_errors));
3394     put_32aligned_be64(&ops->tx_errors, htonll(stats.tx_errors));
3395     put_32aligned_be64(&ops->rx_frame_err, htonll(stats.rx_frame_errors));
3396     put_32aligned_be64(&ops->rx_over_err, htonll(stats.rx_over_errors));
3397     put_32aligned_be64(&ops->rx_crc_err, htonll(stats.rx_crc_errors));
3398     put_32aligned_be64(&ops->collisions, htonll(stats.collisions));
3399 }
3400
3401 static int
3402 handle_port_stats_request(struct ofconn *ofconn, const struct ofp_header *oh)
3403 {
3404     struct ofproto *p = ofconn->ofproto;
3405     const struct ofp_port_stats_request *psr = ofputil_stats_body(oh);
3406     struct ofp_port_stats *ops;
3407     struct ofpbuf *msg;
3408     struct ofport *port;
3409
3410     msg = start_ofp_stats_reply(oh, sizeof *ops * 16);
3411     if (psr->port_no != htons(OFPP_NONE)) {
3412         port = get_port(p, ofp_port_to_odp_port(ntohs(psr->port_no)));
3413         if (port) {
3414             append_port_stat(port, ofconn, &msg);
3415         }
3416     } else {
3417         HMAP_FOR_EACH (port, hmap_node, &p->ports) {
3418             append_port_stat(port, ofconn, &msg);
3419         }
3420     }
3421
3422     queue_tx(msg, ofconn, ofconn->reply_counter);
3423     return 0;
3424 }
3425
3426 static void
3427 calc_flow_duration(long long int start, ovs_be32 *sec, ovs_be32 *nsec)
3428 {
3429     long long int msecs = time_msec() - start;
3430     *sec = htonl(msecs / 1000);
3431     *nsec = htonl((msecs % 1000) * (1000 * 1000));
3432 }
3433
3434 static void
3435 put_ofp_flow_stats(struct ofconn *ofconn, struct rule *rule,
3436                    ovs_be16 out_port, struct ofpbuf **replyp)
3437 {
3438     struct ofp_flow_stats *ofs;
3439     uint64_t packet_count, byte_count;
3440     ovs_be64 cookie;
3441     size_t act_len, len;
3442
3443     if (rule_is_hidden(rule) || !rule_has_out_port(rule, out_port)) {
3444         return;
3445     }
3446
3447     act_len = sizeof *rule->actions * rule->n_actions;
3448     len = offsetof(struct ofp_flow_stats, actions) + act_len;
3449
3450     rule_get_stats(rule, &packet_count, &byte_count);
3451
3452     ofs = append_ofp_stats_reply(len, ofconn, replyp);
3453     ofs->length = htons(len);
3454     ofs->table_id = 0;
3455     ofs->pad = 0;
3456     ofputil_cls_rule_to_match(&rule->cr, ofconn->flow_format, &ofs->match,
3457                               rule->flow_cookie, &cookie);
3458     put_32aligned_be64(&ofs->cookie, cookie);
3459     calc_flow_duration(rule->created, &ofs->duration_sec, &ofs->duration_nsec);
3460     ofs->priority = htons(rule->cr.priority);
3461     ofs->idle_timeout = htons(rule->idle_timeout);
3462     ofs->hard_timeout = htons(rule->hard_timeout);
3463     memset(ofs->pad2, 0, sizeof ofs->pad2);
3464     put_32aligned_be64(&ofs->packet_count, htonll(packet_count));
3465     put_32aligned_be64(&ofs->byte_count, htonll(byte_count));
3466     if (rule->n_actions > 0) {
3467         memcpy(ofs->actions, rule->actions, act_len);
3468     }
3469 }
3470
3471 static bool
3472 is_valid_table(uint8_t table_id)
3473 {
3474     if (table_id == 0 || table_id == 0xff) {
3475         return true;
3476     } else {
3477         /* It would probably be better to reply with an error but there doesn't
3478          * seem to be any appropriate value, so that might just be
3479          * confusing. */
3480         VLOG_WARN_RL(&rl, "controller asked for invalid table %"PRIu8,
3481                      table_id);
3482         return false;
3483     }
3484 }
3485
3486 static int
3487 handle_flow_stats_request(struct ofconn *ofconn, const struct ofp_header *oh)
3488 {
3489     const struct ofp_flow_stats_request *fsr = ofputil_stats_body(oh);
3490     struct ofpbuf *reply;
3491
3492     COVERAGE_INC(ofproto_flows_req);
3493     reply = start_ofp_stats_reply(oh, 1024);
3494     if (is_valid_table(fsr->table_id)) {
3495         struct cls_cursor cursor;
3496         struct cls_rule target;
3497         struct rule *rule;
3498
3499         ofputil_cls_rule_from_match(&fsr->match, 0, NXFF_OPENFLOW10, 0,
3500                                     &target);
3501         cls_cursor_init(&cursor, &ofconn->ofproto->cls, &target);
3502         CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
3503             put_ofp_flow_stats(ofconn, rule, fsr->out_port, &reply);
3504         }
3505     }
3506     queue_tx(reply, ofconn, ofconn->reply_counter);
3507
3508     return 0;
3509 }
3510
3511 static void
3512 put_nx_flow_stats(struct ofconn *ofconn, struct rule *rule,
3513                   ovs_be16 out_port, struct ofpbuf **replyp)
3514 {
3515     struct nx_flow_stats *nfs;
3516     uint64_t packet_count, byte_count;
3517     size_t act_len, start_len;
3518     struct ofpbuf *reply;
3519
3520     if (rule_is_hidden(rule) || !rule_has_out_port(rule, out_port)) {
3521         return;
3522     }
3523
3524     rule_get_stats(rule, &packet_count, &byte_count);
3525
3526     act_len = sizeof *rule->actions * rule->n_actions;
3527
3528     append_nxstats_reply(sizeof *nfs + NXM_MAX_LEN + act_len, ofconn, replyp);
3529     start_len = (*replyp)->size;
3530     reply = *replyp;
3531
3532     nfs = ofpbuf_put_uninit(reply, sizeof *nfs);
3533     nfs->table_id = 0;
3534     nfs->pad = 0;
3535     calc_flow_duration(rule->created, &nfs->duration_sec, &nfs->duration_nsec);
3536     nfs->cookie = rule->flow_cookie;
3537     nfs->priority = htons(rule->cr.priority);
3538     nfs->idle_timeout = htons(rule->idle_timeout);
3539     nfs->hard_timeout = htons(rule->hard_timeout);
3540     nfs->match_len = htons(nx_put_match(reply, &rule->cr));
3541     memset(nfs->pad2, 0, sizeof nfs->pad2);
3542     nfs->packet_count = htonll(packet_count);
3543     nfs->byte_count = htonll(byte_count);
3544     if (rule->n_actions > 0) {
3545         ofpbuf_put(reply, rule->actions, act_len);
3546     }
3547     nfs->length = htons(reply->size - start_len);
3548 }
3549
3550 static int
3551 handle_nxst_flow(struct ofconn *ofconn, const struct ofp_header *oh)
3552 {
3553     struct nx_flow_stats_request *nfsr;
3554     struct cls_rule target;
3555     struct ofpbuf *reply;
3556     struct ofpbuf b;
3557     int error;
3558
3559     ofpbuf_use_const(&b, oh, ntohs(oh->length));
3560
3561     /* Dissect the message. */
3562     nfsr = ofpbuf_pull(&b, sizeof *nfsr);
3563     error = nx_pull_match(&b, ntohs(nfsr->match_len), 0, &target);
3564     if (error) {
3565         return error;
3566     }
3567     if (b.size) {
3568         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
3569     }
3570
3571     COVERAGE_INC(ofproto_flows_req);
3572     reply = start_nxstats_reply(&nfsr->nsm, 1024);
3573     if (is_valid_table(nfsr->table_id)) {
3574         struct cls_cursor cursor;
3575         struct rule *rule;
3576
3577         cls_cursor_init(&cursor, &ofconn->ofproto->cls, &target);
3578         CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
3579             put_nx_flow_stats(ofconn, rule, nfsr->out_port, &reply);
3580         }
3581     }
3582     queue_tx(reply, ofconn, ofconn->reply_counter);
3583
3584     return 0;
3585 }
3586
3587 static void
3588 flow_stats_ds(struct rule *rule, struct ds *results)
3589 {
3590     uint64_t packet_count, byte_count;
3591     size_t act_len = sizeof *rule->actions * rule->n_actions;
3592
3593     rule_get_stats(rule, &packet_count, &byte_count);
3594
3595     ds_put_format(results, "duration=%llds, ",
3596                   (time_msec() - rule->created) / 1000);
3597     ds_put_format(results, "idle=%.3fs, ", (time_msec() - rule->used) / 1000.0);
3598     ds_put_format(results, "priority=%u, ", rule->cr.priority);
3599     ds_put_format(results, "n_packets=%"PRIu64", ", packet_count);
3600     ds_put_format(results, "n_bytes=%"PRIu64", ", byte_count);
3601     cls_rule_format(&rule->cr, results);
3602     ds_put_char(results, ',');
3603     if (act_len > 0) {
3604         ofp_print_actions(results, &rule->actions->header, act_len);
3605     } else {
3606         ds_put_cstr(results, "drop");
3607     }
3608     ds_put_cstr(results, "\n");
3609 }
3610
3611 /* Adds a pretty-printed description of all flows to 'results', including
3612  * hidden flows (e.g., set up by in-band control). */
3613 void
3614 ofproto_get_all_flows(struct ofproto *p, struct ds *results)
3615 {
3616     struct cls_cursor cursor;
3617     struct rule *rule;
3618
3619     cls_cursor_init(&cursor, &p->cls, NULL);
3620     CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
3621         flow_stats_ds(rule, results);
3622     }
3623 }
3624
3625 static void
3626 query_aggregate_stats(struct ofproto *ofproto, struct cls_rule *target,
3627                       ovs_be16 out_port, uint8_t table_id,
3628                       struct ofp_aggregate_stats_reply *oasr)
3629 {
3630     uint64_t total_packets = 0;
3631     uint64_t total_bytes = 0;
3632     int n_flows = 0;
3633
3634     COVERAGE_INC(ofproto_agg_request);
3635
3636     if (is_valid_table(table_id)) {
3637         struct cls_cursor cursor;
3638         struct rule *rule;
3639
3640         cls_cursor_init(&cursor, &ofproto->cls, target);
3641         CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
3642             if (!rule_is_hidden(rule) && rule_has_out_port(rule, out_port)) {
3643                 uint64_t packet_count;
3644                 uint64_t byte_count;
3645
3646                 rule_get_stats(rule, &packet_count, &byte_count);
3647
3648                 total_packets += packet_count;
3649                 total_bytes += byte_count;
3650                 n_flows++;
3651             }
3652         }
3653     }
3654
3655     oasr->flow_count = htonl(n_flows);
3656     put_32aligned_be64(&oasr->packet_count, htonll(total_packets));
3657     put_32aligned_be64(&oasr->byte_count, htonll(total_bytes));
3658     memset(oasr->pad, 0, sizeof oasr->pad);
3659 }
3660
3661 static int
3662 handle_aggregate_stats_request(struct ofconn *ofconn,
3663                                const struct ofp_header *oh)
3664 {
3665     const struct ofp_aggregate_stats_request *request = ofputil_stats_body(oh);
3666     struct ofp_aggregate_stats_reply *reply;
3667     struct cls_rule target;
3668     struct ofpbuf *msg;
3669
3670     ofputil_cls_rule_from_match(&request->match, 0, NXFF_OPENFLOW10, 0,
3671                                 &target);
3672
3673     msg = start_ofp_stats_reply(oh, sizeof *reply);
3674     reply = append_ofp_stats_reply(sizeof *reply, ofconn, &msg);
3675     query_aggregate_stats(ofconn->ofproto, &target, request->out_port,
3676                           request->table_id, reply);
3677     queue_tx(msg, ofconn, ofconn->reply_counter);
3678     return 0;
3679 }
3680
3681 static int
3682 handle_nxst_aggregate(struct ofconn *ofconn, const struct ofp_header *oh)
3683 {
3684     struct nx_aggregate_stats_request *request;
3685     struct ofp_aggregate_stats_reply *reply;
3686     struct cls_rule target;
3687     struct ofpbuf b;
3688     struct ofpbuf *buf;
3689     int error;
3690
3691     ofpbuf_use_const(&b, oh, ntohs(oh->length));
3692
3693     /* Dissect the message. */
3694     request = ofpbuf_pull(&b, sizeof *request);
3695     error = nx_pull_match(&b, ntohs(request->match_len), 0, &target);
3696     if (error) {
3697         return error;
3698     }
3699     if (b.size) {
3700         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
3701     }
3702
3703     /* Reply. */
3704     COVERAGE_INC(ofproto_flows_req);
3705     buf = start_nxstats_reply(&request->nsm, sizeof *reply);
3706     reply = ofpbuf_put_uninit(buf, sizeof *reply);
3707     query_aggregate_stats(ofconn->ofproto, &target, request->out_port,
3708                           request->table_id, reply);
3709     queue_tx(buf, ofconn, ofconn->reply_counter);
3710
3711     return 0;
3712 }
3713
3714 struct queue_stats_cbdata {
3715     struct ofconn *ofconn;
3716     struct ofport *ofport;
3717     struct ofpbuf *msg;
3718 };
3719
3720 static void
3721 put_queue_stats(struct queue_stats_cbdata *cbdata, uint32_t queue_id,
3722                 const struct netdev_queue_stats *stats)
3723 {
3724     struct ofp_queue_stats *reply;
3725
3726     reply = append_ofp_stats_reply(sizeof *reply, cbdata->ofconn, &cbdata->msg);
3727     reply->port_no = htons(cbdata->ofport->opp.port_no);
3728     memset(reply->pad, 0, sizeof reply->pad);
3729     reply->queue_id = htonl(queue_id);
3730     put_32aligned_be64(&reply->tx_bytes, htonll(stats->tx_bytes));
3731     put_32aligned_be64(&reply->tx_packets, htonll(stats->tx_packets));
3732     put_32aligned_be64(&reply->tx_errors, htonll(stats->tx_errors));
3733 }
3734
3735 static void
3736 handle_queue_stats_dump_cb(uint32_t queue_id,
3737                            struct netdev_queue_stats *stats,
3738                            void *cbdata_)
3739 {
3740     struct queue_stats_cbdata *cbdata = cbdata_;
3741
3742     put_queue_stats(cbdata, queue_id, stats);
3743 }
3744
3745 static void
3746 handle_queue_stats_for_port(struct ofport *port, uint32_t queue_id,
3747                             struct queue_stats_cbdata *cbdata)
3748 {
3749     cbdata->ofport = port;
3750     if (queue_id == OFPQ_ALL) {
3751         netdev_dump_queue_stats(port->netdev,
3752                                 handle_queue_stats_dump_cb, cbdata);
3753     } else {
3754         struct netdev_queue_stats stats;
3755
3756         if (!netdev_get_queue_stats(port->netdev, queue_id, &stats)) {
3757             put_queue_stats(cbdata, queue_id, &stats);
3758         }
3759     }
3760 }
3761
3762 static int
3763 handle_queue_stats_request(struct ofconn *ofconn, const struct ofp_header *oh)
3764 {
3765     struct ofproto *ofproto = ofconn->ofproto;
3766     const struct ofp_queue_stats_request *qsr;
3767     struct queue_stats_cbdata cbdata;
3768     struct ofport *port;
3769     unsigned int port_no;
3770     uint32_t queue_id;
3771
3772     qsr = ofputil_stats_body(oh);
3773     if (!qsr) {
3774         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
3775     }
3776
3777     COVERAGE_INC(ofproto_queue_req);
3778
3779     cbdata.ofconn = ofconn;
3780     cbdata.msg = start_ofp_stats_reply(oh, 128);
3781
3782     port_no = ntohs(qsr->port_no);
3783     queue_id = ntohl(qsr->queue_id);
3784     if (port_no == OFPP_ALL) {
3785         HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
3786             handle_queue_stats_for_port(port, queue_id, &cbdata);
3787         }
3788     } else if (port_no < ofproto->max_ports) {
3789         port = get_port(ofproto, ofp_port_to_odp_port(port_no));
3790         if (port) {
3791             handle_queue_stats_for_port(port, queue_id, &cbdata);
3792         }
3793     } else {
3794         ofpbuf_delete(cbdata.msg);
3795         return ofp_mkerr(OFPET_QUEUE_OP_FAILED, OFPQOFC_BAD_PORT);
3796     }
3797     queue_tx(cbdata.msg, ofconn, ofconn->reply_counter);
3798
3799     return 0;
3800 }
3801
3802 /* Updates 'facet''s used time.  Caller is responsible for calling
3803  * facet_push_stats() to update the flows which 'facet' resubmits into. */
3804 static void
3805 facet_update_time(struct ofproto *ofproto, struct facet *facet,
3806                   long long int used)
3807 {
3808     if (used > facet->used) {
3809         facet->used = used;
3810         if (used > facet->rule->used) {
3811             facet->rule->used = used;
3812         }
3813         netflow_flow_update_time(ofproto->netflow, &facet->nf_flow, used);
3814     }
3815 }
3816
3817 /* Folds the statistics from 'stats' into the counters in 'facet'.
3818  *
3819  * Because of the meaning of a facet's counters, it only makes sense to do this
3820  * if 'stats' are not tracked in the datapath, that is, if 'stats' represents a
3821  * packet that was sent by hand or if it represents statistics that have been
3822  * cleared out of the datapath. */
3823 static void
3824 facet_update_stats(struct ofproto *ofproto, struct facet *facet,
3825                    const struct dpif_flow_stats *stats)
3826 {
3827     if (stats->n_packets || stats->used > facet->used) {
3828         facet_update_time(ofproto, facet, stats->used);
3829         facet->packet_count += stats->n_packets;
3830         facet->byte_count += stats->n_bytes;
3831         facet_push_stats(ofproto, facet);
3832         netflow_flow_update_flags(&facet->nf_flow, stats->tcp_flags);
3833     }
3834 }
3835
3836 static void
3837 facet_push_stats(struct ofproto *ofproto, struct facet *facet)
3838 {
3839     uint64_t rs_packets, rs_bytes;
3840
3841     assert(facet->packet_count >= facet->rs_packet_count);
3842     assert(facet->byte_count >= facet->rs_byte_count);
3843     assert(facet->used >= facet->rs_used);
3844
3845     rs_packets = facet->packet_count - facet->rs_packet_count;
3846     rs_bytes = facet->byte_count - facet->rs_byte_count;
3847
3848     if (rs_packets || rs_bytes || facet->used > facet->rs_used) {
3849         facet->rs_packet_count = facet->packet_count;
3850         facet->rs_byte_count = facet->byte_count;
3851         facet->rs_used = facet->used;
3852
3853         flow_push_stats(ofproto, facet->rule, &facet->flow,
3854                         rs_packets, rs_bytes, facet->used);
3855     }
3856 }
3857
3858 struct ofproto_push {
3859     struct action_xlate_ctx ctx;
3860     uint64_t packets;
3861     uint64_t bytes;
3862     long long int used;
3863 };
3864
3865 static void
3866 push_resubmit(struct action_xlate_ctx *ctx, struct rule *rule)
3867 {
3868     struct ofproto_push *push = CONTAINER_OF(ctx, struct ofproto_push, ctx);
3869
3870     if (rule) {
3871         rule->packet_count += push->packets;
3872         rule->byte_count += push->bytes;
3873         rule->used = MAX(push->used, rule->used);
3874     }
3875 }
3876
3877 /* Pushes flow statistics to the rules which 'flow' resubmits into given
3878  * 'rule''s actions. */
3879 static void
3880 flow_push_stats(struct ofproto *ofproto, const struct rule *rule,
3881                 struct flow *flow, uint64_t packets, uint64_t bytes,
3882                 long long int used)
3883 {
3884     struct ofproto_push push;
3885
3886     push.packets = packets;
3887     push.bytes = bytes;
3888     push.used = used;
3889
3890     action_xlate_ctx_init(&push.ctx, ofproto, flow, NULL);
3891     push.ctx.resubmit_hook = push_resubmit;
3892     ofpbuf_delete(xlate_actions(&push.ctx, rule->actions, rule->n_actions));
3893 }
3894
3895 /* Implements OFPFC_ADD and the cases for OFPFC_MODIFY and OFPFC_MODIFY_STRICT
3896  * in which no matching flow already exists in the flow table.
3897  *
3898  * Adds the flow specified by 'ofm', which is followed by 'n_actions'
3899  * ofp_actions, to ofconn->ofproto's flow table.  Returns 0 on success or an
3900  * OpenFlow error code as encoded by ofp_mkerr() on failure.
3901  *
3902  * 'ofconn' is used to retrieve the packet buffer specified in ofm->buffer_id,
3903  * if any. */
3904 static int
3905 add_flow(struct ofconn *ofconn, struct flow_mod *fm)
3906 {
3907     struct ofproto *p = ofconn->ofproto;
3908     struct ofpbuf *packet;
3909     struct rule *rule;
3910     uint16_t in_port;
3911     int error;
3912
3913     if (fm->flags & OFPFF_CHECK_OVERLAP
3914         && classifier_rule_overlaps(&p->cls, &fm->cr)) {
3915         return ofp_mkerr(OFPET_FLOW_MOD_FAILED, OFPFMFC_OVERLAP);
3916     }
3917
3918     error = 0;
3919     if (fm->buffer_id != UINT32_MAX) {
3920         error = pktbuf_retrieve(ofconn->pktbuf, fm->buffer_id,
3921                                 &packet, &in_port);
3922     } else {
3923         packet = NULL;
3924         in_port = UINT16_MAX;
3925     }
3926
3927     rule = rule_create(&fm->cr, fm->actions, fm->n_actions,
3928                        fm->idle_timeout, fm->hard_timeout, fm->cookie,
3929                        fm->flags & OFPFF_SEND_FLOW_REM);
3930     rule_insert(p, rule);
3931     if (packet) {
3932         rule_execute(p, rule, in_port, packet);
3933     }
3934     return error;
3935 }
3936
3937 static struct rule *
3938 find_flow_strict(struct ofproto *p, const struct flow_mod *fm)
3939 {
3940     return rule_from_cls_rule(classifier_find_rule_exactly(&p->cls, &fm->cr));
3941 }
3942
3943 static int
3944 send_buffered_packet(struct ofconn *ofconn,
3945                      struct rule *rule, uint32_t buffer_id)
3946 {
3947     struct ofpbuf *packet;
3948     uint16_t in_port;
3949     int error;
3950
3951     if (buffer_id == UINT32_MAX) {
3952         return 0;
3953     }
3954
3955     error = pktbuf_retrieve(ofconn->pktbuf, buffer_id, &packet, &in_port);
3956     if (error) {
3957         return error;
3958     }
3959
3960     rule_execute(ofconn->ofproto, rule, in_port, packet);
3961
3962     return 0;
3963 }
3964 \f
3965 /* OFPFC_MODIFY and OFPFC_MODIFY_STRICT. */
3966
3967 struct modify_flows_cbdata {
3968     struct ofproto *ofproto;
3969     const struct flow_mod *fm;
3970     struct rule *match;
3971 };
3972
3973 static int modify_flow(struct ofproto *, const struct flow_mod *,
3974                        struct rule *);
3975
3976 /* Implements OFPFC_MODIFY.  Returns 0 on success or an OpenFlow error code as
3977  * encoded by ofp_mkerr() on failure.
3978  *
3979  * 'ofconn' is used to retrieve the packet buffer specified in ofm->buffer_id,
3980  * if any. */
3981 static int
3982 modify_flows_loose(struct ofconn *ofconn, struct flow_mod *fm)
3983 {
3984     struct ofproto *p = ofconn->ofproto;
3985     struct rule *match = NULL;
3986     struct cls_cursor cursor;
3987     struct rule *rule;
3988
3989     cls_cursor_init(&cursor, &p->cls, &fm->cr);
3990     CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
3991         if (!rule_is_hidden(rule)) {
3992             match = rule;
3993             modify_flow(p, fm, rule);
3994         }
3995     }
3996
3997     if (match) {
3998         /* This credits the packet to whichever flow happened to match last.
3999          * That's weird.  Maybe we should do a lookup for the flow that
4000          * actually matches the packet?  Who knows. */
4001         send_buffered_packet(ofconn, match, fm->buffer_id);
4002         return 0;
4003     } else {
4004         return add_flow(ofconn, fm);
4005     }
4006 }
4007
4008 /* Implements OFPFC_MODIFY_STRICT.  Returns 0 on success or an OpenFlow error
4009  * code as encoded by ofp_mkerr() on failure.
4010  *
4011  * 'ofconn' is used to retrieve the packet buffer specified in ofm->buffer_id,
4012  * if any. */
4013 static int
4014 modify_flow_strict(struct ofconn *ofconn, struct flow_mod *fm)
4015 {
4016     struct ofproto *p = ofconn->ofproto;
4017     struct rule *rule = find_flow_strict(p, fm);
4018     if (rule && !rule_is_hidden(rule)) {
4019         modify_flow(p, fm, rule);
4020         return send_buffered_packet(ofconn, rule, fm->buffer_id);
4021     } else {
4022         return add_flow(ofconn, fm);
4023     }
4024 }
4025
4026 /* Implements core of OFPFC_MODIFY and OFPFC_MODIFY_STRICT where 'rule' has
4027  * been identified as a flow in 'p''s flow table to be modified, by changing
4028  * the rule's actions to match those in 'ofm' (which is followed by 'n_actions'
4029  * ofp_action[] structures). */
4030 static int
4031 modify_flow(struct ofproto *p, const struct flow_mod *fm, struct rule *rule)
4032 {
4033     size_t actions_len = fm->n_actions * sizeof *rule->actions;
4034
4035     rule->flow_cookie = fm->cookie;
4036
4037     /* If the actions are the same, do nothing. */
4038     if (fm->n_actions == rule->n_actions
4039         && (!fm->n_actions
4040             || !memcmp(fm->actions, rule->actions, actions_len))) {
4041         return 0;
4042     }
4043
4044     /* Replace actions. */
4045     free(rule->actions);
4046     rule->actions = fm->n_actions ? xmemdup(fm->actions, actions_len) : NULL;
4047     rule->n_actions = fm->n_actions;
4048
4049     p->need_revalidate = true;
4050
4051     return 0;
4052 }
4053 \f
4054 /* OFPFC_DELETE implementation. */
4055
4056 static void delete_flow(struct ofproto *, struct rule *, ovs_be16 out_port);
4057
4058 /* Implements OFPFC_DELETE. */
4059 static void
4060 delete_flows_loose(struct ofproto *p, const struct flow_mod *fm)
4061 {
4062     struct rule *rule, *next_rule;
4063     struct cls_cursor cursor;
4064
4065     cls_cursor_init(&cursor, &p->cls, &fm->cr);
4066     CLS_CURSOR_FOR_EACH_SAFE (rule, next_rule, cr, &cursor) {
4067         delete_flow(p, rule, htons(fm->out_port));
4068     }
4069 }
4070
4071 /* Implements OFPFC_DELETE_STRICT. */
4072 static void
4073 delete_flow_strict(struct ofproto *p, struct flow_mod *fm)
4074 {
4075     struct rule *rule = find_flow_strict(p, fm);
4076     if (rule) {
4077         delete_flow(p, rule, htons(fm->out_port));
4078     }
4079 }
4080
4081 /* Implements core of OFPFC_DELETE and OFPFC_DELETE_STRICT where 'rule' has
4082  * been identified as a flow to delete from 'p''s flow table, by deleting the
4083  * flow and sending out a OFPT_FLOW_REMOVED message to any interested
4084  * controller.
4085  *
4086  * Will not delete 'rule' if it is hidden.  Will delete 'rule' only if
4087  * 'out_port' is htons(OFPP_NONE) or if 'rule' actually outputs to the
4088  * specified 'out_port'. */
4089 static void
4090 delete_flow(struct ofproto *p, struct rule *rule, ovs_be16 out_port)
4091 {
4092     if (rule_is_hidden(rule)) {
4093         return;
4094     }
4095
4096     if (out_port != htons(OFPP_NONE) && !rule_has_out_port(rule, out_port)) {
4097         return;
4098     }
4099
4100     rule_send_removed(p, rule, OFPRR_DELETE);
4101     rule_remove(p, rule);
4102 }
4103 \f
4104 static int
4105 handle_flow_mod(struct ofconn *ofconn, const struct ofp_header *oh)
4106 {
4107     struct ofproto *p = ofconn->ofproto;
4108     struct flow_mod fm;
4109     int error;
4110
4111     error = reject_slave_controller(ofconn, "flow_mod");
4112     if (error) {
4113         return error;
4114     }
4115
4116     error = ofputil_decode_flow_mod(&fm, oh, ofconn->flow_format);
4117     if (error) {
4118         return error;
4119     }
4120
4121     /* We do not support the emergency flow cache.  It will hopefully get
4122      * dropped from OpenFlow in the near future. */
4123     if (fm.flags & OFPFF_EMERG) {
4124         /* There isn't a good fit for an error code, so just state that the
4125          * flow table is full. */
4126         return ofp_mkerr(OFPET_FLOW_MOD_FAILED, OFPFMFC_ALL_TABLES_FULL);
4127     }
4128
4129     error = validate_actions(fm.actions, fm.n_actions,
4130                              &fm.cr.flow, p->max_ports);
4131     if (error) {
4132         return error;
4133     }
4134
4135     switch (fm.command) {
4136     case OFPFC_ADD:
4137         return add_flow(ofconn, &fm);
4138
4139     case OFPFC_MODIFY:
4140         return modify_flows_loose(ofconn, &fm);
4141
4142     case OFPFC_MODIFY_STRICT:
4143         return modify_flow_strict(ofconn, &fm);
4144
4145     case OFPFC_DELETE:
4146         delete_flows_loose(p, &fm);
4147         return 0;
4148
4149     case OFPFC_DELETE_STRICT:
4150         delete_flow_strict(p, &fm);
4151         return 0;
4152
4153     default:
4154         return ofp_mkerr(OFPET_FLOW_MOD_FAILED, OFPFMFC_BAD_COMMAND);
4155     }
4156 }
4157
4158 static int
4159 handle_tun_id_from_cookie(struct ofconn *ofconn, const struct ofp_header *oh)
4160 {
4161     const struct nxt_tun_id_cookie *msg
4162         = (const struct nxt_tun_id_cookie *) oh;
4163
4164     ofconn->flow_format = msg->set ? NXFF_TUN_ID_FROM_COOKIE : NXFF_OPENFLOW10;
4165     return 0;
4166 }
4167
4168 static int
4169 handle_role_request(struct ofconn *ofconn, const struct ofp_header *oh)
4170 {
4171     struct nx_role_request *nrr = (struct nx_role_request *) oh;
4172     struct nx_role_request *reply;
4173     struct ofpbuf *buf;
4174     uint32_t role;
4175
4176     if (ofconn->type != OFCONN_PRIMARY) {
4177         VLOG_WARN_RL(&rl, "ignoring role request on non-controller "
4178                      "connection");
4179         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_EPERM);
4180     }
4181
4182     role = ntohl(nrr->role);
4183     if (role != NX_ROLE_OTHER && role != NX_ROLE_MASTER
4184         && role != NX_ROLE_SLAVE) {
4185         VLOG_WARN_RL(&rl, "received request for unknown role %"PRIu32, role);
4186
4187         /* There's no good error code for this. */
4188         return ofp_mkerr(OFPET_BAD_REQUEST, -1);
4189     }
4190
4191     if (role == NX_ROLE_MASTER) {
4192         struct ofconn *other;
4193
4194         HMAP_FOR_EACH (other, hmap_node, &ofconn->ofproto->controllers) {
4195             if (other->role == NX_ROLE_MASTER) {
4196                 other->role = NX_ROLE_SLAVE;
4197             }
4198         }
4199     }
4200     ofconn->role = role;
4201
4202     reply = make_nxmsg_xid(sizeof *reply, NXT_ROLE_REPLY, oh->xid, &buf);
4203     reply->role = htonl(role);
4204     queue_tx(buf, ofconn, ofconn->reply_counter);
4205
4206     return 0;
4207 }
4208
4209 static int
4210 handle_nxt_set_flow_format(struct ofconn *ofconn, const struct ofp_header *oh)
4211 {
4212     const struct nxt_set_flow_format *msg
4213         = (const struct nxt_set_flow_format *) oh;
4214     uint32_t format;
4215
4216     format = ntohl(msg->format);
4217     if (format == NXFF_OPENFLOW10
4218         || format == NXFF_TUN_ID_FROM_COOKIE
4219         || format == NXFF_NXM) {
4220         ofconn->flow_format = format;
4221         return 0;
4222     } else {
4223         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_EPERM);
4224     }
4225 }
4226
4227 static int
4228 handle_barrier_request(struct ofconn *ofconn, const struct ofp_header *oh)
4229 {
4230     struct ofp_header *ob;
4231     struct ofpbuf *buf;
4232
4233     /* Currently, everything executes synchronously, so we can just
4234      * immediately send the barrier reply. */
4235     ob = make_openflow_xid(sizeof *ob, OFPT_BARRIER_REPLY, oh->xid, &buf);
4236     queue_tx(buf, ofconn, ofconn->reply_counter);
4237     return 0;
4238 }
4239
4240 static int
4241 handle_openflow__(struct ofconn *ofconn, const struct ofpbuf *msg)
4242 {
4243     const struct ofp_header *oh = msg->data;
4244     const struct ofputil_msg_type *type;
4245     int error;
4246
4247     error = ofputil_decode_msg_type(oh, &type);
4248     if (error) {
4249         return error;
4250     }
4251
4252     switch (ofputil_msg_type_code(type)) {
4253         /* OpenFlow requests. */
4254     case OFPUTIL_OFPT_ECHO_REQUEST:
4255         return handle_echo_request(ofconn, oh);
4256
4257     case OFPUTIL_OFPT_FEATURES_REQUEST:
4258         return handle_features_request(ofconn, oh);
4259
4260     case OFPUTIL_OFPT_GET_CONFIG_REQUEST:
4261         return handle_get_config_request(ofconn, oh);
4262
4263     case OFPUTIL_OFPT_SET_CONFIG:
4264         return handle_set_config(ofconn, msg->data);
4265
4266     case OFPUTIL_OFPT_PACKET_OUT:
4267         return handle_packet_out(ofconn, oh);
4268
4269     case OFPUTIL_OFPT_PORT_MOD:
4270         return handle_port_mod(ofconn, oh);
4271
4272     case OFPUTIL_OFPT_FLOW_MOD:
4273         return handle_flow_mod(ofconn, oh);
4274
4275     case OFPUTIL_OFPT_BARRIER_REQUEST:
4276         return handle_barrier_request(ofconn, oh);
4277
4278         /* OpenFlow replies. */
4279     case OFPUTIL_OFPT_ECHO_REPLY:
4280         return 0;
4281
4282         /* Nicira extension requests. */
4283     case OFPUTIL_NXT_TUN_ID_FROM_COOKIE:
4284         return handle_tun_id_from_cookie(ofconn, oh);
4285
4286     case OFPUTIL_NXT_ROLE_REQUEST:
4287         return handle_role_request(ofconn, oh);
4288
4289     case OFPUTIL_NXT_SET_FLOW_FORMAT:
4290         return handle_nxt_set_flow_format(ofconn, oh);
4291
4292     case OFPUTIL_NXT_FLOW_MOD:
4293         return handle_flow_mod(ofconn, oh);
4294
4295         /* OpenFlow statistics requests. */
4296     case OFPUTIL_OFPST_DESC_REQUEST:
4297         return handle_desc_stats_request(ofconn, oh);
4298
4299     case OFPUTIL_OFPST_FLOW_REQUEST:
4300         return handle_flow_stats_request(ofconn, oh);
4301
4302     case OFPUTIL_OFPST_AGGREGATE_REQUEST:
4303         return handle_aggregate_stats_request(ofconn, oh);
4304
4305     case OFPUTIL_OFPST_TABLE_REQUEST:
4306         return handle_table_stats_request(ofconn, oh);
4307
4308     case OFPUTIL_OFPST_PORT_REQUEST:
4309         return handle_port_stats_request(ofconn, oh);
4310
4311     case OFPUTIL_OFPST_QUEUE_REQUEST:
4312         return handle_queue_stats_request(ofconn, oh);
4313
4314         /* Nicira extension statistics requests. */
4315     case OFPUTIL_NXST_FLOW_REQUEST:
4316         return handle_nxst_flow(ofconn, oh);
4317
4318     case OFPUTIL_NXST_AGGREGATE_REQUEST:
4319         return handle_nxst_aggregate(ofconn, oh);
4320
4321     case OFPUTIL_INVALID:
4322     case OFPUTIL_OFPT_HELLO:
4323     case OFPUTIL_OFPT_ERROR:
4324     case OFPUTIL_OFPT_FEATURES_REPLY:
4325     case OFPUTIL_OFPT_GET_CONFIG_REPLY:
4326     case OFPUTIL_OFPT_PACKET_IN:
4327     case OFPUTIL_OFPT_FLOW_REMOVED:
4328     case OFPUTIL_OFPT_PORT_STATUS:
4329     case OFPUTIL_OFPT_BARRIER_REPLY:
4330     case OFPUTIL_OFPT_QUEUE_GET_CONFIG_REQUEST:
4331     case OFPUTIL_OFPT_QUEUE_GET_CONFIG_REPLY:
4332     case OFPUTIL_OFPST_DESC_REPLY:
4333     case OFPUTIL_OFPST_FLOW_REPLY:
4334     case OFPUTIL_OFPST_QUEUE_REPLY:
4335     case OFPUTIL_OFPST_PORT_REPLY:
4336     case OFPUTIL_OFPST_TABLE_REPLY:
4337     case OFPUTIL_OFPST_AGGREGATE_REPLY:
4338     case OFPUTIL_NXT_ROLE_REPLY:
4339     case OFPUTIL_NXT_FLOW_REMOVED:
4340     case OFPUTIL_NXST_FLOW_REPLY:
4341     case OFPUTIL_NXST_AGGREGATE_REPLY:
4342     default:
4343         if (VLOG_IS_WARN_ENABLED()) {
4344             char *s = ofp_to_string(oh, ntohs(oh->length), 2);
4345             VLOG_DBG_RL(&rl, "OpenFlow message ignored: %s", s);
4346             free(s);
4347         }
4348         if (oh->type == OFPT_STATS_REQUEST || oh->type == OFPT_STATS_REPLY) {
4349             return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_STAT);
4350         } else {
4351             return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_TYPE);
4352         }
4353     }
4354 }
4355
4356 static void
4357 handle_openflow(struct ofconn *ofconn, struct ofpbuf *ofp_msg)
4358 {
4359     int error = handle_openflow__(ofconn, ofp_msg);
4360     if (error) {
4361         send_error_oh(ofconn, ofp_msg->data, error);
4362     }
4363     COVERAGE_INC(ofproto_recv_openflow);
4364 }
4365 \f
4366 static void
4367 handle_miss_upcall(struct ofproto *p, struct dpif_upcall *upcall)
4368 {
4369     struct facet *facet;
4370     struct flow flow;
4371
4372     /* Obtain in_port and tun_id, at least. */
4373     odp_flow_key_to_flow(upcall->key, upcall->key_len, &flow);
4374
4375     /* Set header pointers in 'flow'. */
4376     flow_extract(upcall->packet, flow.tun_id, flow.in_port, &flow);
4377
4378     if (p->ofhooks->special_cb
4379         && !p->ofhooks->special_cb(&flow, upcall->packet, p->aux)) {
4380         ofpbuf_delete(upcall->packet);
4381         return;
4382     }
4383
4384     /* Check with in-band control to see if this packet should be sent
4385      * to the local port regardless of the flow table. */
4386     if (in_band_msg_in_hook(p->in_band, &flow, upcall->packet)) {
4387         ofproto_send_packet(p, ODPP_LOCAL, 0, upcall->packet);
4388     }
4389
4390     facet = facet_lookup_valid(p, &flow);
4391     if (!facet) {
4392         struct rule *rule = rule_lookup(p, &flow);
4393         if (!rule) {
4394             /* Don't send a packet-in if OFPPC_NO_PACKET_IN asserted. */
4395             struct ofport *port = get_port(p, flow.in_port);
4396             if (port) {
4397                 if (port->opp.config & OFPPC_NO_PACKET_IN) {
4398                     COVERAGE_INC(ofproto_no_packet_in);
4399                     /* XXX install 'drop' flow entry */
4400                     ofpbuf_delete(upcall->packet);
4401                     return;
4402                 }
4403             } else {
4404                 VLOG_WARN_RL(&rl, "packet-in on unknown port %"PRIu16,
4405                              flow.in_port);
4406             }
4407
4408             COVERAGE_INC(ofproto_packet_in);
4409             send_packet_in(p, upcall, &flow, false);
4410             return;
4411         }
4412
4413         facet = facet_create(p, rule, &flow, upcall->packet);
4414     } else if (!facet->may_install) {
4415         /* The facet is not installable, that is, we need to process every
4416          * packet, so process the current packet's actions into 'facet'. */
4417         facet_make_actions(p, facet, upcall->packet);
4418     }
4419
4420     if (facet->rule->cr.priority == FAIL_OPEN_PRIORITY) {
4421         /*
4422          * Extra-special case for fail-open mode.
4423          *
4424          * We are in fail-open mode and the packet matched the fail-open rule,
4425          * but we are connected to a controller too.  We should send the packet
4426          * up to the controller in the hope that it will try to set up a flow
4427          * and thereby allow us to exit fail-open.
4428          *
4429          * See the top-level comment in fail-open.c for more information.
4430          */
4431         send_packet_in(p, upcall, &flow, true);
4432     }
4433
4434     facet_execute(p, facet, upcall->packet);
4435     facet_install(p, facet, false);
4436 }
4437
4438 static void
4439 handle_upcall(struct ofproto *p, struct dpif_upcall *upcall)
4440 {
4441     struct flow flow;
4442
4443     switch (upcall->type) {
4444     case DPIF_UC_ACTION:
4445         COVERAGE_INC(ofproto_ctlr_action);
4446         odp_flow_key_to_flow(upcall->key, upcall->key_len, &flow);
4447         send_packet_in(p, upcall, &flow, false);
4448         break;
4449
4450     case DPIF_UC_SAMPLE:
4451         if (p->sflow) {
4452             odp_flow_key_to_flow(upcall->key, upcall->key_len, &flow);
4453             ofproto_sflow_received(p->sflow, upcall, &flow);
4454         }
4455         ofpbuf_delete(upcall->packet);
4456         break;
4457
4458     case DPIF_UC_MISS:
4459         handle_miss_upcall(p, upcall);
4460         break;
4461
4462     case DPIF_N_UC_TYPES:
4463     default:
4464         VLOG_WARN_RL(&rl, "upcall has unexpected type %"PRIu32, upcall->type);
4465         break;
4466     }
4467 }
4468 \f
4469 /* Flow expiration. */
4470
4471 static int ofproto_dp_max_idle(const struct ofproto *);
4472 static void ofproto_update_stats(struct ofproto *);
4473 static void rule_expire(struct ofproto *, struct rule *);
4474 static void ofproto_expire_facets(struct ofproto *, int dp_max_idle);
4475
4476 /* This function is called periodically by ofproto_run().  Its job is to
4477  * collect updates for the flows that have been installed into the datapath,
4478  * most importantly when they last were used, and then use that information to
4479  * expire flows that have not been used recently.
4480  *
4481  * Returns the number of milliseconds after which it should be called again. */
4482 static int
4483 ofproto_expire(struct ofproto *ofproto)
4484 {
4485     struct rule *rule, *next_rule;
4486     struct cls_cursor cursor;
4487     int dp_max_idle;
4488
4489     /* Update stats for each flow in the datapath. */
4490     ofproto_update_stats(ofproto);
4491
4492     /* Expire facets that have been idle too long. */
4493     dp_max_idle = ofproto_dp_max_idle(ofproto);
4494     ofproto_expire_facets(ofproto, dp_max_idle);
4495
4496     /* Expire OpenFlow flows whose idle_timeout or hard_timeout has passed. */
4497     cls_cursor_init(&cursor, &ofproto->cls, NULL);
4498     CLS_CURSOR_FOR_EACH_SAFE (rule, next_rule, cr, &cursor) {
4499         rule_expire(ofproto, rule);
4500     }
4501
4502     /* Let the hook know that we're at a stable point: all outstanding data
4503      * in existing flows has been accounted to the account_cb.  Thus, the
4504      * hook can now reasonably do operations that depend on having accurate
4505      * flow volume accounting (currently, that's just bond rebalancing). */
4506     if (ofproto->ofhooks->account_checkpoint_cb) {
4507         ofproto->ofhooks->account_checkpoint_cb(ofproto->aux);
4508     }
4509
4510     return MIN(dp_max_idle, 1000);
4511 }
4512
4513 /* Update 'packet_count', 'byte_count', and 'used' members of installed facets.
4514  *
4515  * This function also pushes statistics updates to rules which each facet
4516  * resubmits into.  Generally these statistics will be accurate.  However, if a
4517  * facet changes the rule it resubmits into at some time in between
4518  * ofproto_update_stats() runs, it is possible that statistics accrued to the
4519  * old rule will be incorrectly attributed to the new rule.  This could be
4520  * avoided by calling ofproto_update_stats() whenever rules are created or
4521  * deleted.  However, the performance impact of making so many calls to the
4522  * datapath do not justify the benefit of having perfectly accurate statistics.
4523  */
4524 static void
4525 ofproto_update_stats(struct ofproto *p)
4526 {
4527     const struct dpif_flow_stats *stats;
4528     struct dpif_flow_dump dump;
4529     const struct nlattr *key;
4530     size_t key_len;
4531
4532     dpif_flow_dump_start(&dump, p->dpif);
4533     while (dpif_flow_dump_next(&dump, &key, &key_len, NULL, NULL, &stats)) {
4534         struct facet *facet;
4535         struct flow flow;
4536
4537         if (odp_flow_key_to_flow(key, key_len, &flow)) {
4538             struct ds s;
4539
4540             ds_init(&s);
4541             odp_flow_key_format(key, key_len, &s);
4542             VLOG_WARN_RL(&rl, "failed to convert ODP flow key to flow: %s",
4543                          ds_cstr(&s));
4544             ds_destroy(&s);
4545
4546             continue;
4547         }
4548         facet = facet_find(p, &flow);
4549
4550         if (facet && facet->installed) {
4551
4552             if (stats->n_packets >= facet->dp_packet_count) {
4553                 facet->packet_count += stats->n_packets - facet->dp_packet_count;
4554             } else {
4555                 VLOG_WARN_RL(&rl, "unexpected packet count from the datapath");
4556             }
4557
4558             if (stats->n_bytes >= facet->dp_byte_count) {
4559                 facet->byte_count += stats->n_bytes - facet->dp_byte_count;
4560             } else {
4561                 VLOG_WARN_RL(&rl, "unexpected byte count from datapath");
4562             }
4563
4564             facet->dp_packet_count = stats->n_packets;
4565             facet->dp_byte_count = stats->n_bytes;
4566
4567             facet_update_time(p, facet, stats->used);
4568             facet_account(p, facet, stats->n_bytes);
4569             facet_push_stats(p, facet);
4570         } else {
4571             /* There's a flow in the datapath that we know nothing about.
4572              * Delete it. */
4573             COVERAGE_INC(ofproto_unexpected_rule);
4574             dpif_flow_del(p->dpif, key, key_len, NULL);
4575         }
4576     }
4577     dpif_flow_dump_done(&dump);
4578 }
4579
4580 /* Calculates and returns the number of milliseconds of idle time after which
4581  * facets should expire from the datapath and we should fold their statistics
4582  * into their parent rules in userspace. */
4583 static int
4584 ofproto_dp_max_idle(const struct ofproto *ofproto)
4585 {
4586     /*
4587      * Idle time histogram.
4588      *
4589      * Most of the time a switch has a relatively small number of facets.  When
4590      * this is the case we might as well keep statistics for all of them in
4591      * userspace and to cache them in the kernel datapath for performance as
4592      * well.
4593      *
4594      * As the number of facets increases, the memory required to maintain
4595      * statistics about them in userspace and in the kernel becomes
4596      * significant.  However, with a large number of facets it is likely that
4597      * only a few of them are "heavy hitters" that consume a large amount of
4598      * bandwidth.  At this point, only heavy hitters are worth caching in the
4599      * kernel and maintaining in userspaces; other facets we can discard.
4600      *
4601      * The technique used to compute the idle time is to build a histogram with
4602      * N_BUCKETS buckets whose width is BUCKET_WIDTH msecs each.  Each facet
4603      * that is installed in the kernel gets dropped in the appropriate bucket.
4604      * After the histogram has been built, we compute the cutoff so that only
4605      * the most-recently-used 1% of facets (but at least 1000 flows) are kept
4606      * cached.  At least the most-recently-used bucket of facets is kept, so
4607      * actually an arbitrary number of facets can be kept in any given
4608      * expiration run (though the next run will delete most of those unless
4609      * they receive additional data).
4610      *
4611      * This requires a second pass through the facets, in addition to the pass
4612      * made by ofproto_update_stats(), because the former function never looks
4613      * at uninstallable facets.
4614      */
4615     enum { BUCKET_WIDTH = ROUND_UP(100, TIME_UPDATE_INTERVAL) };
4616     enum { N_BUCKETS = 5000 / BUCKET_WIDTH };
4617     int buckets[N_BUCKETS] = { 0 };
4618     struct facet *facet;
4619     int total, bucket;
4620     long long int now;
4621     int i;
4622
4623     total = hmap_count(&ofproto->facets);
4624     if (total <= 1000) {
4625         return N_BUCKETS * BUCKET_WIDTH;
4626     }
4627
4628     /* Build histogram. */
4629     now = time_msec();
4630     HMAP_FOR_EACH (facet, hmap_node, &ofproto->facets) {
4631         long long int idle = now - facet->used;
4632         int bucket = (idle <= 0 ? 0
4633                       : idle >= BUCKET_WIDTH * N_BUCKETS ? N_BUCKETS - 1
4634                       : (unsigned int) idle / BUCKET_WIDTH);
4635         buckets[bucket]++;
4636     }
4637
4638     /* Find the first bucket whose flows should be expired. */
4639     for (bucket = 0; bucket < N_BUCKETS; bucket++) {
4640         if (buckets[bucket]) {
4641             int subtotal = 0;
4642             do {
4643                 subtotal += buckets[bucket++];
4644             } while (bucket < N_BUCKETS && subtotal < MAX(1000, total / 100));
4645             break;
4646         }
4647     }
4648
4649     if (VLOG_IS_DBG_ENABLED()) {
4650         struct ds s;
4651
4652         ds_init(&s);
4653         ds_put_cstr(&s, "keep");
4654         for (i = 0; i < N_BUCKETS; i++) {
4655             if (i == bucket) {
4656                 ds_put_cstr(&s, ", drop");
4657             }
4658             if (buckets[i]) {
4659                 ds_put_format(&s, " %d:%d", i * BUCKET_WIDTH, buckets[i]);
4660             }
4661         }
4662         VLOG_INFO("%s: %s (msec:count)",
4663                   dpif_name(ofproto->dpif), ds_cstr(&s));
4664         ds_destroy(&s);
4665     }
4666
4667     return bucket * BUCKET_WIDTH;
4668 }
4669
4670 static void
4671 facet_active_timeout(struct ofproto *ofproto, struct facet *facet)
4672 {
4673     if (ofproto->netflow && !facet_is_controller_flow(facet) &&
4674         netflow_active_timeout_expired(ofproto->netflow, &facet->nf_flow)) {
4675         struct ofexpired expired;
4676
4677         if (facet->installed) {
4678             struct dpif_flow_stats stats;
4679
4680             facet_put__(ofproto, facet, facet->actions, facet->actions_len,
4681                         &stats);
4682             facet_update_stats(ofproto, facet, &stats);
4683         }
4684
4685         expired.flow = facet->flow;
4686         expired.packet_count = facet->packet_count;
4687         expired.byte_count = facet->byte_count;
4688         expired.used = facet->used;
4689         netflow_expire(ofproto->netflow, &facet->nf_flow, &expired);
4690     }
4691 }
4692
4693 static void
4694 ofproto_expire_facets(struct ofproto *ofproto, int dp_max_idle)
4695 {
4696     long long int cutoff = time_msec() - dp_max_idle;
4697     struct facet *facet, *next_facet;
4698
4699     HMAP_FOR_EACH_SAFE (facet, next_facet, hmap_node, &ofproto->facets) {
4700         facet_active_timeout(ofproto, facet);
4701         if (facet->used < cutoff) {
4702             facet_remove(ofproto, facet);
4703         }
4704     }
4705 }
4706
4707 /* If 'rule' is an OpenFlow rule, that has expired according to OpenFlow rules,
4708  * then delete it entirely. */
4709 static void
4710 rule_expire(struct ofproto *ofproto, struct rule *rule)
4711 {
4712     struct facet *facet, *next_facet;
4713     long long int now;
4714     uint8_t reason;
4715
4716     /* Has 'rule' expired? */
4717     now = time_msec();
4718     if (rule->hard_timeout
4719         && now > rule->created + rule->hard_timeout * 1000) {
4720         reason = OFPRR_HARD_TIMEOUT;
4721     } else if (rule->idle_timeout && list_is_empty(&rule->facets)
4722                && now >rule->used + rule->idle_timeout * 1000) {
4723         reason = OFPRR_IDLE_TIMEOUT;
4724     } else {
4725         return;
4726     }
4727
4728     COVERAGE_INC(ofproto_expired);
4729
4730     /* Update stats.  (This is a no-op if the rule expired due to an idle
4731      * timeout, because that only happens when the rule has no facets left.) */
4732     LIST_FOR_EACH_SAFE (facet, next_facet, list_node, &rule->facets) {
4733         facet_remove(ofproto, facet);
4734     }
4735
4736     /* Get rid of the rule. */
4737     if (!rule_is_hidden(rule)) {
4738         rule_send_removed(ofproto, rule, reason);
4739     }
4740     rule_remove(ofproto, rule);
4741 }
4742 \f
4743 static struct ofpbuf *
4744 compose_ofp_flow_removed(struct ofconn *ofconn, const struct rule *rule,
4745                          uint8_t reason)
4746 {
4747     struct ofp_flow_removed *ofr;
4748     struct ofpbuf *buf;
4749
4750     ofr = make_openflow_xid(sizeof *ofr, OFPT_FLOW_REMOVED, htonl(0), &buf);
4751     ofputil_cls_rule_to_match(&rule->cr, ofconn->flow_format, &ofr->match,
4752                               rule->flow_cookie, &ofr->cookie);
4753     ofr->priority = htons(rule->cr.priority);
4754     ofr->reason = reason;
4755     calc_flow_duration(rule->created, &ofr->duration_sec, &ofr->duration_nsec);
4756     ofr->idle_timeout = htons(rule->idle_timeout);
4757     ofr->packet_count = htonll(rule->packet_count);
4758     ofr->byte_count = htonll(rule->byte_count);
4759
4760     return buf;
4761 }
4762
4763 static struct ofpbuf *
4764 compose_nx_flow_removed(const struct rule *rule, uint8_t reason)
4765 {
4766     struct nx_flow_removed *nfr;
4767     struct ofpbuf *buf;
4768     int match_len;
4769
4770     make_nxmsg_xid(sizeof *nfr, NXT_FLOW_REMOVED, htonl(0), &buf);
4771     match_len = nx_put_match(buf, &rule->cr);
4772
4773     nfr = buf->data;
4774     nfr->cookie = rule->flow_cookie;
4775     nfr->priority = htons(rule->cr.priority);
4776     nfr->reason = reason;
4777     calc_flow_duration(rule->created, &nfr->duration_sec, &nfr->duration_nsec);
4778     nfr->idle_timeout = htons(rule->idle_timeout);
4779     nfr->match_len = htons(match_len);
4780     nfr->packet_count = htonll(rule->packet_count);
4781     nfr->byte_count = htonll(rule->byte_count);
4782
4783     return buf;
4784 }
4785
4786 static void
4787 rule_send_removed(struct ofproto *p, struct rule *rule, uint8_t reason)
4788 {
4789     struct ofconn *ofconn;
4790
4791     if (!rule->send_flow_removed) {
4792         return;
4793     }
4794
4795     LIST_FOR_EACH (ofconn, node, &p->all_conns) {
4796         struct ofpbuf *msg;
4797
4798         if (!rconn_is_connected(ofconn->rconn)
4799             || !ofconn_receives_async_msgs(ofconn)) {
4800             continue;
4801         }
4802
4803         msg = (ofconn->flow_format == NXFF_NXM
4804                ? compose_nx_flow_removed(rule, reason)
4805                : compose_ofp_flow_removed(ofconn, rule, reason));
4806
4807         /* Account flow expirations under ofconn->reply_counter, the counter
4808          * for replies to OpenFlow requests.  That works because preventing
4809          * OpenFlow requests from being processed also prevents new flows from
4810          * being added (and expiring).  (It also prevents processing OpenFlow
4811          * requests that would not add new flows, so it is imperfect.) */
4812         queue_tx(msg, ofconn, ofconn->reply_counter);
4813     }
4814 }
4815
4816 /* Obtains statistics for 'rule' and stores them in '*packets' and '*bytes'.
4817  * The returned statistics include statistics for all of 'rule''s facets. */
4818 static void
4819 rule_get_stats(const struct rule *rule, uint64_t *packets, uint64_t *bytes)
4820 {
4821     uint64_t p, b;
4822     struct facet *facet;
4823
4824     /* Start from historical data for 'rule' itself that are no longer tracked
4825      * in facets.  This counts, for example, facets that have expired. */
4826     p = rule->packet_count;
4827     b = rule->byte_count;
4828
4829     /* Add any statistics that are tracked by facets.  This includes
4830      * statistical data recently updated by ofproto_update_stats() as well as
4831      * stats for packets that were executed "by hand" via dpif_execute(). */
4832     LIST_FOR_EACH (facet, list_node, &rule->facets) {
4833         p += facet->packet_count;
4834         b += facet->byte_count;
4835     }
4836
4837     *packets = p;
4838     *bytes = b;
4839 }
4840
4841 /* pinsched callback for sending 'ofp_packet_in' on 'ofconn'. */
4842 static void
4843 do_send_packet_in(struct ofpbuf *ofp_packet_in, void *ofconn_)
4844 {
4845     struct ofconn *ofconn = ofconn_;
4846
4847     rconn_send_with_limit(ofconn->rconn, ofp_packet_in,
4848                           ofconn->packet_in_counter, 100);
4849 }
4850
4851 /* Takes 'upcall', whose packet has the flow specified by 'flow', composes an
4852  * OpenFlow packet-in message from it, and passes it to 'ofconn''s packet
4853  * scheduler for sending.
4854  *
4855  * If 'clone' is true, the caller retains ownership of 'upcall->packet'.
4856  * Otherwise, ownership is transferred to this function. */
4857 static void
4858 schedule_packet_in(struct ofconn *ofconn, struct dpif_upcall *upcall,
4859                    const struct flow *flow, bool clone)
4860 {
4861     enum { OPI_SIZE = offsetof(struct ofp_packet_in, data) };
4862     struct ofproto *ofproto = ofconn->ofproto;
4863     struct ofp_packet_in *opi;
4864     int total_len, send_len;
4865     struct ofpbuf *packet;
4866     uint32_t buffer_id;
4867     int idx;
4868
4869     /* Get OpenFlow buffer_id. */
4870     if (upcall->type == DPIF_UC_ACTION) {
4871         buffer_id = UINT32_MAX;
4872     } else if (ofproto->fail_open && fail_open_is_active(ofproto->fail_open)) {
4873         buffer_id = pktbuf_get_null();
4874     } else if (!ofconn->pktbuf) {
4875         buffer_id = UINT32_MAX;
4876     } else {
4877         buffer_id = pktbuf_save(ofconn->pktbuf, upcall->packet, flow->in_port);
4878     }
4879
4880     /* Figure out how much of the packet to send. */
4881     total_len = send_len = upcall->packet->size;
4882     if (buffer_id != UINT32_MAX) {
4883         send_len = MIN(send_len, ofconn->miss_send_len);
4884     }
4885     if (upcall->type == DPIF_UC_ACTION) {
4886         send_len = MIN(send_len, upcall->userdata);
4887     }
4888
4889     /* Copy or steal buffer for OFPT_PACKET_IN. */
4890     if (clone) {
4891         packet = ofpbuf_clone_data_with_headroom(upcall->packet->data,
4892                                                  send_len, OPI_SIZE);
4893     } else {
4894         packet = upcall->packet;
4895         packet->size = send_len;
4896     }
4897
4898     /* Add OFPT_PACKET_IN. */
4899     opi = ofpbuf_push_zeros(packet, OPI_SIZE);
4900     opi->header.version = OFP_VERSION;
4901     opi->header.type = OFPT_PACKET_IN;
4902     opi->total_len = htons(total_len);
4903     opi->in_port = htons(odp_port_to_ofp_port(flow->in_port));
4904     opi->reason = upcall->type == DPIF_UC_MISS ? OFPR_NO_MATCH : OFPR_ACTION;
4905     opi->buffer_id = htonl(buffer_id);
4906     update_openflow_length(packet);
4907
4908     /* Hand over to packet scheduler.  It might immediately call into
4909      * do_send_packet_in() or it might buffer it for a while (until a later
4910      * call to pinsched_run()). */
4911     idx = upcall->type == DPIF_UC_MISS ? 0 : 1;
4912     pinsched_send(ofconn->schedulers[idx], flow->in_port,
4913                   packet, do_send_packet_in, ofconn);
4914 }
4915
4916 /* Given 'upcall', of type DPIF_UC_ACTION or DPIF_UC_MISS, sends an
4917  * OFPT_PACKET_IN message to each OpenFlow controller as necessary according to
4918  * their individual configurations.
4919  *
4920  * If 'clone' is true, the caller retains ownership of 'upcall->packet'.
4921  * Otherwise, ownership is transferred to this function. */
4922 static void
4923 send_packet_in(struct ofproto *ofproto, struct dpif_upcall *upcall,
4924                const struct flow *flow, bool clone)
4925 {
4926     struct ofconn *ofconn, *prev;
4927
4928     prev = NULL;
4929     LIST_FOR_EACH (ofconn, node, &ofproto->all_conns) {
4930         if (ofconn_receives_async_msgs(ofconn)) {
4931             if (prev) {
4932                 schedule_packet_in(prev, upcall, flow, true);
4933             }
4934             prev = ofconn;
4935         }
4936     }
4937     if (prev) {
4938         schedule_packet_in(prev, upcall, flow, clone);
4939     } else if (!clone) {
4940         ofpbuf_delete(upcall->packet);
4941     }
4942 }
4943
4944 static uint64_t
4945 pick_datapath_id(const struct ofproto *ofproto)
4946 {
4947     const struct ofport *port;
4948
4949     port = get_port(ofproto, ODPP_LOCAL);
4950     if (port) {
4951         uint8_t ea[ETH_ADDR_LEN];
4952         int error;
4953
4954         error = netdev_get_etheraddr(port->netdev, ea);
4955         if (!error) {
4956             return eth_addr_to_uint64(ea);
4957         }
4958         VLOG_WARN("could not get MAC address for %s (%s)",
4959                   netdev_get_name(port->netdev), strerror(error));
4960     }
4961     return ofproto->fallback_dpid;
4962 }
4963
4964 static uint64_t
4965 pick_fallback_dpid(void)
4966 {
4967     uint8_t ea[ETH_ADDR_LEN];
4968     eth_addr_nicira_random(ea);
4969     return eth_addr_to_uint64(ea);
4970 }
4971 \f
4972 static void
4973 ofproto_unixctl_list(struct unixctl_conn *conn, const char *arg OVS_UNUSED,
4974                      void *aux OVS_UNUSED)
4975 {
4976     const struct shash_node *node;
4977     struct ds results;
4978
4979     ds_init(&results);
4980     SHASH_FOR_EACH (node, &all_ofprotos) {
4981         ds_put_format(&results, "%s\n", node->name);
4982     }
4983     unixctl_command_reply(conn, 200, ds_cstr(&results));
4984     ds_destroy(&results);
4985 }
4986
4987 struct ofproto_trace {
4988     struct action_xlate_ctx ctx;
4989     struct flow flow;
4990     struct ds *result;
4991 };
4992
4993 static void
4994 trace_format_rule(struct ds *result, int level, const struct rule *rule)
4995 {
4996     ds_put_char_multiple(result, '\t', level);
4997     if (!rule) {
4998         ds_put_cstr(result, "No match\n");
4999         return;
5000     }
5001
5002     ds_put_format(result, "Rule: cookie=%#"PRIx64" ",
5003                   ntohll(rule->flow_cookie));
5004     cls_rule_format(&rule->cr, result);
5005     ds_put_char(result, '\n');
5006
5007     ds_put_char_multiple(result, '\t', level);
5008     ds_put_cstr(result, "OpenFlow ");
5009     ofp_print_actions(result, (const struct ofp_action_header *) rule->actions,
5010                       rule->n_actions * sizeof *rule->actions);
5011     ds_put_char(result, '\n');
5012 }
5013
5014 static void
5015 trace_format_flow(struct ds *result, int level, const char *title,
5016                  struct ofproto_trace *trace)
5017 {
5018     ds_put_char_multiple(result, '\t', level);
5019     ds_put_format(result, "%s: ", title);
5020     if (flow_equal(&trace->ctx.flow, &trace->flow)) {
5021         ds_put_cstr(result, "unchanged");
5022     } else {
5023         flow_format(result, &trace->ctx.flow);
5024         trace->flow = trace->ctx.flow;
5025     }
5026     ds_put_char(result, '\n');
5027 }
5028
5029 static void
5030 trace_resubmit(struct action_xlate_ctx *ctx, struct rule *rule)
5031 {
5032     struct ofproto_trace *trace = CONTAINER_OF(ctx, struct ofproto_trace, ctx);
5033     struct ds *result = trace->result;
5034
5035     ds_put_char(result, '\n');
5036     trace_format_flow(result, ctx->recurse + 1, "Resubmitted flow", trace);
5037     trace_format_rule(result, ctx->recurse + 1, rule);
5038 }
5039
5040 static void
5041 ofproto_unixctl_trace(struct unixctl_conn *conn, const char *args_,
5042                       void *aux OVS_UNUSED)
5043 {
5044     char *dpname, *in_port_s, *tun_id_s, *packet_s;
5045     char *args = xstrdup(args_);
5046     char *save_ptr = NULL;
5047     struct ofproto *ofproto;
5048     struct ofpbuf packet;
5049     struct rule *rule;
5050     struct ds result;
5051     struct flow flow;
5052     uint16_t in_port;
5053     ovs_be64 tun_id;
5054     char *s;
5055
5056     ofpbuf_init(&packet, strlen(args) / 2);
5057     ds_init(&result);
5058
5059     dpname = strtok_r(args, " ", &save_ptr);
5060     tun_id_s = strtok_r(NULL, " ", &save_ptr);
5061     in_port_s = strtok_r(NULL, " ", &save_ptr);
5062     packet_s = strtok_r(NULL, "", &save_ptr); /* Get entire rest of line. */
5063     if (!dpname || !in_port_s || !packet_s) {
5064         unixctl_command_reply(conn, 501, "Bad command syntax");
5065         goto exit;
5066     }
5067
5068     ofproto = shash_find_data(&all_ofprotos, dpname);
5069     if (!ofproto) {
5070         unixctl_command_reply(conn, 501, "Unknown ofproto (use ofproto/list "
5071                               "for help)");
5072         goto exit;
5073     }
5074
5075     tun_id = htonll(strtoull(tun_id_s, NULL, 10));
5076     in_port = ofp_port_to_odp_port(atoi(in_port_s));
5077
5078     packet_s = ofpbuf_put_hex(&packet, packet_s, NULL);
5079     packet_s += strspn(packet_s, " ");
5080     if (*packet_s != '\0') {
5081         unixctl_command_reply(conn, 501, "Trailing garbage in command");
5082         goto exit;
5083     }
5084     if (packet.size < ETH_HEADER_LEN) {
5085         unixctl_command_reply(conn, 501, "Packet data too short for Ethernet");
5086         goto exit;
5087     }
5088
5089     ds_put_cstr(&result, "Packet: ");
5090     s = ofp_packet_to_string(packet.data, packet.size, packet.size);
5091     ds_put_cstr(&result, s);
5092     free(s);
5093
5094     flow_extract(&packet, tun_id, in_port, &flow);
5095     ds_put_cstr(&result, "Flow: ");
5096     flow_format(&result, &flow);
5097     ds_put_char(&result, '\n');
5098
5099     rule = rule_lookup(ofproto, &flow);
5100     trace_format_rule(&result, 0, rule);
5101     if (rule) {
5102         struct ofproto_trace trace;
5103         struct ofpbuf *odp_actions;
5104
5105         trace.result = &result;
5106         trace.flow = flow;
5107         action_xlate_ctx_init(&trace.ctx, ofproto, &flow, &packet);
5108         trace.ctx.resubmit_hook = trace_resubmit;
5109         odp_actions = xlate_actions(&trace.ctx,
5110                                     rule->actions, rule->n_actions);
5111
5112         ds_put_char(&result, '\n');
5113         trace_format_flow(&result, 0, "Final flow", &trace);
5114         ds_put_cstr(&result, "Datapath actions: ");
5115         format_odp_actions(&result, odp_actions->data, odp_actions->size);
5116         ofpbuf_delete(odp_actions);
5117     }
5118
5119     unixctl_command_reply(conn, 200, ds_cstr(&result));
5120
5121 exit:
5122     ds_destroy(&result);
5123     ofpbuf_uninit(&packet);
5124     free(args);
5125 }
5126
5127 static void
5128 ofproto_unixctl_init(void)
5129 {
5130     static bool registered;
5131     if (registered) {
5132         return;
5133     }
5134     registered = true;
5135
5136     unixctl_command_register("ofproto/list", ofproto_unixctl_list, NULL);
5137     unixctl_command_register("ofproto/trace", ofproto_unixctl_trace, NULL);
5138 }
5139 \f
5140 static bool
5141 default_normal_ofhook_cb(const struct flow *flow, const struct ofpbuf *packet,
5142                          struct ofpbuf *odp_actions, tag_type *tags,
5143                          uint16_t *nf_output_iface, void *ofproto_)
5144 {
5145     struct ofproto *ofproto = ofproto_;
5146     int out_port;
5147
5148     /* Drop frames for reserved multicast addresses. */
5149     if (eth_addr_is_reserved(flow->dl_dst)) {
5150         return true;
5151     }
5152
5153     /* Learn source MAC (but don't try to learn from revalidation). */
5154     if (packet != NULL) {
5155         tag_type rev_tag = mac_learning_learn(ofproto->ml, flow->dl_src,
5156                                               0, flow->in_port,
5157                                               GRAT_ARP_LOCK_NONE);
5158         if (rev_tag) {
5159             /* The log messages here could actually be useful in debugging,
5160              * so keep the rate limit relatively high. */
5161             static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(30, 300);
5162             VLOG_DBG_RL(&rl, "learned that "ETH_ADDR_FMT" is on port %"PRIu16,
5163                         ETH_ADDR_ARGS(flow->dl_src), flow->in_port);
5164             ofproto_revalidate(ofproto, rev_tag);
5165         }
5166     }
5167
5168     /* Determine output port. */
5169     out_port = mac_learning_lookup_tag(ofproto->ml, flow->dl_dst, 0, tags,
5170                                        NULL);
5171     if (out_port < 0) {
5172         flood_packets(ofproto, flow->in_port, OFPPC_NO_FLOOD,
5173                       nf_output_iface, odp_actions);
5174     } else if (out_port != flow->in_port) {
5175         nl_msg_put_u32(odp_actions, ODP_ACTION_ATTR_OUTPUT, out_port);
5176         *nf_output_iface = out_port;
5177     } else {
5178         /* Drop. */
5179     }
5180
5181     return true;
5182 }
5183
5184 static const struct ofhooks default_ofhooks = {
5185     default_normal_ofhook_cb,
5186     NULL,
5187     NULL,
5188     NULL
5189 };