ofproto/ofproto.c

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