ofproto/connmgr.c

   1 /*
   2  * Copyright (c) 2009, 2010, 2011 Nicira Networks.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #include <config.h>
  18
  19 #include "connmgr.h"
  20
  21 #include <errno.h>
  22 #include <stdlib.h>
  23
  24 #include "coverage.h"
  25 #include "fail-open.h"
  26 #include "in-band.h"
  27 #include "odp-util.h"
  28 #include "ofp-util.h"
  29 #include "ofpbuf.h"
  30 #include "pinsched.h"
  31 #include "poll-loop.h"
  32 #include "pktbuf.h"
  33 #include "private.h"
  34 #include "rconn.h"
  35 #include "shash.h"
  36 #include "timeval.h"
  37 #include "vconn.h"
  38 #include "vlog.h"
  39
  40 VLOG_DEFINE_THIS_MODULE(connmgr);
  41 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
  42
  43 COVERAGE_DEFINE(ofconn_stuck);
  44
  45 /* An OpenFlow connection. */
  46 struct ofconn {
  47     struct connmgr *connmgr;    /* Connection's manager. */
  48     struct list node;           /* In struct connmgr's "all_conns" list. */
  49     struct rconn *rconn;        /* OpenFlow connection. */
  50     enum ofconn_type type;      /* Type. */
  51     enum nx_flow_format flow_format; /* Currently selected flow format. */
  52
  53     /* OFPT_PACKET_IN related data. */
  54     struct rconn_packet_counter *packet_in_counter; /* # queued on 'rconn'. */
  55 #define N_SCHEDULERS 2
  56     struct pinsched *schedulers[N_SCHEDULERS];
  57     struct pktbuf *pktbuf;         /* OpenFlow packet buffers. */
  58     int miss_send_len;             /* Bytes to send of buffered packets. */
  59
  60     /* Number of OpenFlow messages queued on 'rconn' as replies to OpenFlow
  61      * requests, and the maximum number before we stop reading OpenFlow
  62      * requests.  */
  63 #define OFCONN_REPLY_MAX 100
  64     struct rconn_packet_counter *reply_counter;
  65
  66     /* type == OFCONN_PRIMARY only. */
  67     enum nx_role role;           /* Role. */
  68     struct hmap_node hmap_node;  /* In struct connmgr's "controllers" map. */
  69     enum ofproto_band band;      /* In-band or out-of-band? */
  70 };
  71
  72 static struct ofconn *ofconn_create(struct connmgr *, struct rconn *,
  73                                     enum ofconn_type);
  74 static void ofconn_destroy(struct ofconn *);
  75
  76 static void ofconn_reconfigure(struct ofconn *,
  77                                const struct ofproto_controller *);
  78
  79 static void ofconn_run(struct ofconn *,
  80                        void (*handle_openflow)(struct ofconn *,
  81                                                struct ofpbuf *ofp_msg));
  82 static void ofconn_wait(struct ofconn *);
  83
  84 static const char *ofconn_get_target(const struct ofconn *);
  85 static char *ofconn_make_name(const struct connmgr *, const char *target);
  86
  87 static void ofconn_set_rate_limit(struct ofconn *, int rate, int burst);
  88
  89 static bool ofconn_receives_async_msgs(const struct ofconn *);
  90
  91 static void ofconn_send(const struct ofconn *, struct ofpbuf *,
  92                         struct rconn_packet_counter *);
  93
  94 static void do_send_packet_in(struct ofpbuf *, void *ofconn_);
  95
  96 /* A listener for incoming OpenFlow "service" connections. */
  97 struct ofservice {
  98     struct hmap_node node;      /* In struct connmgr's "services" hmap. */
  99     struct pvconn *pvconn;      /* OpenFlow connection listener. */
 100
 101     /* These are not used by ofservice directly.  They are settings for
 102      * accepted "struct ofconn"s from the pvconn. */
 103     int probe_interval;         /* Max idle time before probing, in seconds. */
 104     int rate_limit;             /* Max packet-in rate in packets per second. */
 105     int burst_limit;            /* Limit on accumulating packet credits. */
 106 };
 107
 108 static void ofservice_reconfigure(struct ofservice *,
 109                                   const struct ofproto_controller *);
 110 static int ofservice_create(struct connmgr *, const char *target);
 111 static void ofservice_destroy(struct connmgr *, struct ofservice *);
 112 static struct ofservice *ofservice_lookup(struct connmgr *,
 113                                           const char *target);
 114
 115 /* Connection manager for an OpenFlow switch. */
 116 struct connmgr {
 117     struct ofproto *ofproto;
 118     char *name;
 119     char *local_port_name;
 120
 121     /* OpenFlow connections. */
 122     struct hmap controllers;   /* Controller "struct ofconn"s. */
 123     struct list all_conns;     /* Contains "struct ofconn"s. */
 124
 125     /* OpenFlow listeners. */
 126     struct hmap services;       /* Contains "struct ofservice"s. */
 127     struct pvconn **snoops;
 128     size_t n_snoops;
 129
 130     /* Fail open. */
 131     struct fail_open *fail_open;
 132     enum ofproto_fail_mode fail_mode;
 133
 134     /* In-band control. */
 135     struct in_band *in_band;
 136     long long int next_in_band_update;
 137     struct sockaddr_in *extra_in_band_remotes;
 138     size_t n_extra_remotes;
 139     int in_band_queue;
 140 };
 141
 142 static void update_in_band_remotes(struct connmgr *);
 143 static void add_snooper(struct connmgr *, struct vconn *);
 144
 145 /* Creates and returns a new connection manager owned by 'ofproto'.  'name' is
 146  * a name for the ofproto suitable for using in log messages.
 147  * 'local_port_name' is the name of the local port (OFPP_LOCAL) within
 148  * 'ofproto'. */
 149 struct connmgr *
 150 connmgr_create(struct ofproto *ofproto,
 151                const char *name, const char *local_port_name)
 152 {
 153     struct connmgr *mgr;
 154
 155     mgr = xmalloc(sizeof *mgr);
 156     mgr->ofproto = ofproto;
 157     mgr->name = xstrdup(name);
 158     mgr->local_port_name = xstrdup(local_port_name);
 159
 160     hmap_init(&mgr->controllers);
 161     list_init(&mgr->all_conns);
 162
 163     hmap_init(&mgr->services);
 164     mgr->snoops = NULL;
 165     mgr->n_snoops = 0;
 166
 167     mgr->fail_open = NULL;
 168     mgr->fail_mode = OFPROTO_FAIL_SECURE;
 169
 170     mgr->in_band = NULL;
 171     mgr->next_in_band_update = LLONG_MAX;
 172     mgr->extra_in_band_remotes = NULL;
 173     mgr->n_extra_remotes = 0;
 174     mgr->in_band_queue = -1;
 175
 176     return mgr;
 177 }
 178
 179 /* Frees 'mgr' and all of its resources. */
 180 void
 181 connmgr_destroy(struct connmgr *mgr)
 182 {
 183     struct ofservice *ofservice, *next_ofservice;
 184     struct ofconn *ofconn, *next_ofconn;
 185     size_t i;
 186
 187     if (!mgr) {
 188         return;
 189     }
 190
 191     LIST_FOR_EACH_SAFE (ofconn, next_ofconn, node, &mgr->all_conns) {
 192         ofconn_destroy(ofconn);
 193     }
 194     hmap_destroy(&mgr->controllers);
 195
 196     HMAP_FOR_EACH_SAFE (ofservice, next_ofservice, node, &mgr->services) {
 197         ofservice_destroy(mgr, ofservice);
 198     }
 199     hmap_destroy(&mgr->services);
 200
 201     for (i = 0; i < mgr->n_snoops; i++) {
 202         pvconn_close(mgr->snoops[i]);
 203     }
 204     free(mgr->snoops);
 205
 206     fail_open_destroy(mgr->fail_open);
 207     mgr->fail_open = NULL;
 208
 209     in_band_destroy(mgr->in_band);
 210     mgr->in_band = NULL;
 211     free(mgr->extra_in_band_remotes);
 212     free(mgr->name);
 213     free(mgr->local_port_name);
 214
 215     free(mgr);
 216 }
 217
 218 /* Does all of the periodic maintenance required by 'mgr'.  Calls
 219  * 'handle_openflow' for each message received on an OpenFlow connection,
 220  * passing along the OpenFlow connection itself and the message that was sent.
 221  * The 'handle_openflow' callback must not free the message. */
 222 void
 223 connmgr_run(struct connmgr *mgr,
 224             void (*handle_openflow)(struct ofconn *, struct ofpbuf *ofp_msg))
 225 {
 226     struct ofconn *ofconn, *next_ofconn;
 227     struct ofservice *ofservice;
 228     size_t i;
 229
 230     if (mgr->in_band) {
 231         if (time_msec() >= mgr->next_in_band_update) {
 232             update_in_band_remotes(mgr);
 233         }
 234         in_band_run(mgr->in_band);
 235     }
 236
 237     LIST_FOR_EACH_SAFE (ofconn, next_ofconn, node, &mgr->all_conns) {
 238         ofconn_run(ofconn, handle_openflow);
 239     }
 240
 241     /* Fail-open maintenance.  Do this after processing the ofconns since
 242      * fail-open checks the status of the controller rconn. */
 243     if (mgr->fail_open) {
 244         fail_open_run(mgr->fail_open);
 245     }
 246
 247     HMAP_FOR_EACH (ofservice, node, &mgr->services) {
 248         struct vconn *vconn;
 249         int retval;
 250
 251         retval = pvconn_accept(ofservice->pvconn, OFP_VERSION, &vconn);
 252         if (!retval) {
 253             struct rconn *rconn;
 254             char *name;
 255
 256             rconn = rconn_create(ofservice->probe_interval, 0);
 257             name = ofconn_make_name(mgr, vconn_get_name(vconn));
 258             rconn_connect_unreliably(rconn, vconn, name);
 259             free(name);
 260
 261             ofconn = ofconn_create(mgr, rconn, OFCONN_SERVICE);
 262             ofconn_set_rate_limit(ofconn, ofservice->rate_limit,
 263                                   ofservice->burst_limit);
 264         } else if (retval != EAGAIN) {
 265             VLOG_WARN_RL(&rl, "accept failed (%s)", strerror(retval));
 266         }
 267     }
 268
 269     for (i = 0; i < mgr->n_snoops; i++) {
 270         struct vconn *vconn;
 271         int retval;
 272
 273         retval = pvconn_accept(mgr->snoops[i], OFP_VERSION, &vconn);
 274         if (!retval) {
 275             add_snooper(mgr, vconn);
 276         } else if (retval != EAGAIN) {
 277             VLOG_WARN_RL(&rl, "accept failed (%s)", strerror(retval));
 278         }
 279     }
 280 }
 281
 282 /* Causes the poll loop to wake up when connmgr_run() needs to run. */
 283 void
 284 connmgr_wait(struct connmgr *mgr)
 285 {
 286     struct ofservice *ofservice;
 287     struct ofconn *ofconn;
 288     size_t i;
 289
 290     LIST_FOR_EACH (ofconn, node, &mgr->all_conns) {
 291         ofconn_wait(ofconn);
 292     }
 293     if (mgr->in_band) {
 294         poll_timer_wait_until(mgr->next_in_band_update);
 295         in_band_wait(mgr->in_band);
 296     }
 297     if (mgr->fail_open) {
 298         fail_open_wait(mgr->fail_open);
 299     }
 300     HMAP_FOR_EACH (ofservice, node, &mgr->services) {
 301         pvconn_wait(ofservice->pvconn);
 302     }
 303     for (i = 0; i < mgr->n_snoops; i++) {
 304         pvconn_wait(mgr->snoops[i]);
 305     }
 306 }
 307
 308 /* Returns the ofproto that owns 'ofconn''s connmgr. */
 309 struct ofproto *
 310 ofconn_get_ofproto(const struct ofconn *ofconn)
 311 {
 312     return ofconn->connmgr->ofproto;
 313 }
 314 \f
 315 /* OpenFlow configuration. */
 316
 317 static void add_controller(struct connmgr *, const char *target);
 318 static struct ofconn *find_controller_by_target(struct connmgr *,
 319                                                 const char *target);
 320 static void update_fail_open(struct connmgr *);
 321 static int set_pvconns(struct pvconn ***pvconnsp, size_t *n_pvconnsp,
 322                        const struct sset *);
 323
 324 /* Returns true if 'mgr' has any configured primary controllers.
 325  *
 326  * Service controllers do not count, but configured primary controllers do
 327  * count whether or not they are currently connected. */
 328 bool
 329 connmgr_has_controllers(const struct connmgr *mgr)
 330 {
 331     return !hmap_is_empty(&mgr->controllers);
 332 }
 333
 334 /* Initializes 'info' and populates it with information about each configured
 335  * primary controller.  The keys in 'info' are the controllers' targets; the
 336  * data values are corresponding "struct ofproto_controller_info".
 337  *
 338  * The caller owns 'info' and everything in it and should free it when it is no
 339  * longer needed. */
 340 void
 341 connmgr_get_controller_info(struct connmgr *mgr, struct shash *info)
 342 {
 343     const struct ofconn *ofconn;
 344
 345     shash_init(info);
 346
 347     HMAP_FOR_EACH (ofconn, hmap_node, &mgr->controllers) {
 348         const struct rconn *rconn = ofconn->rconn;
 349         time_t now = time_now();
 350         time_t last_connection = rconn_get_last_connection(rconn);
 351         time_t last_disconnect = rconn_get_last_disconnect(rconn);
 352         int last_error = rconn_get_last_error(rconn);
 353         struct ofproto_controller_info *cinfo = xmalloc(sizeof *cinfo);
 354
 355         shash_add(info, rconn_get_target(rconn), cinfo);
 356
 357         cinfo->is_connected = rconn_is_connected(rconn);
 358         cinfo->role = ofconn->role;
 359
 360         cinfo->pairs.n = 0;
 361
 362         if (last_error) {
 363             cinfo->pairs.keys[cinfo->pairs.n] = "last_error";
 364             cinfo->pairs.values[cinfo->pairs.n++] =
 365                 xstrdup(ovs_retval_to_string(last_error));
 366         }
 367
 368         cinfo->pairs.keys[cinfo->pairs.n] = "state";
 369         cinfo->pairs.values[cinfo->pairs.n++] =
 370             xstrdup(rconn_get_state(rconn));
 371
 372         if (last_connection != TIME_MIN) {
 373             cinfo->pairs.keys[cinfo->pairs.n] = "sec_since_connect";
 374             cinfo->pairs.values[cinfo->pairs.n++]
 375                 = xasprintf("%ld", (long int) (now - last_connection));
 376         }
 377
 378         if (last_disconnect != TIME_MIN) {
 379             cinfo->pairs.keys[cinfo->pairs.n] = "sec_since_disconnect";
 380             cinfo->pairs.values[cinfo->pairs.n++]
 381                 = xasprintf("%ld", (long int) (now - last_disconnect));
 382         }
 383     }
 384 }
 385
 386 /* Changes 'mgr''s set of controllers to the 'n_controllers' controllers in
 387  * 'controllers'. */
 388 void
 389 connmgr_set_controllers(struct connmgr *mgr,
 390                         const struct ofproto_controller *controllers,
 391                         size_t n_controllers)
 392 {
 393     bool had_controllers = connmgr_has_controllers(mgr);
 394     struct shash new_controllers;
 395     struct ofconn *ofconn, *next_ofconn;
 396     struct ofservice *ofservice, *next_ofservice;
 397     bool ss_exists;
 398     size_t i;
 399
 400     /* Create newly configured controllers and services.
 401      * Create a name to ofproto_controller mapping in 'new_controllers'. */
 402     shash_init(&new_controllers);
 403     for (i = 0; i < n_controllers; i++) {
 404         const struct ofproto_controller *c = &controllers[i];
 405
 406         if (!vconn_verify_name(c->target)) {
 407             if (!find_controller_by_target(mgr, c->target)) {
 408                 add_controller(mgr, c->target);
 409             }
 410         } else if (!pvconn_verify_name(c->target)) {
 411             if (!ofservice_lookup(mgr, c->target)) {
 412                 ofservice_create(mgr, c->target);
 413             }
 414         } else {
 415             VLOG_WARN_RL(&rl, "%s: unsupported controller \"%s\"",
 416                          mgr->name, c->target);
 417             continue;
 418         }
 419
 420         shash_add_once(&new_controllers, c->target, &controllers[i]);
 421     }
 422
 423     /* Delete controllers that are no longer configured.
 424      * Update configuration of all now-existing controllers. */
 425     ss_exists = false;
 426     HMAP_FOR_EACH_SAFE (ofconn, next_ofconn, hmap_node, &mgr->controllers) {
 427         struct ofproto_controller *c;
 428
 429         c = shash_find_data(&new_controllers, ofconn_get_target(ofconn));
 430         if (!c) {
 431             ofconn_destroy(ofconn);
 432         } else {
 433             ofconn_reconfigure(ofconn, c);
 434         }
 435     }
 436
 437     /* Delete services that are no longer configured.
 438      * Update configuration of all now-existing services. */
 439     HMAP_FOR_EACH_SAFE (ofservice, next_ofservice, node, &mgr->services) {
 440         struct ofproto_controller *c;
 441
 442         c = shash_find_data(&new_controllers,
 443                             pvconn_get_name(ofservice->pvconn));
 444         if (!c) {
 445             ofservice_destroy(mgr, ofservice);
 446         } else {
 447             ofservice_reconfigure(ofservice, c);
 448         }
 449     }
 450
 451     shash_destroy(&new_controllers);
 452
 453     update_in_band_remotes(mgr);
 454     update_fail_open(mgr);
 455     if (had_controllers != connmgr_has_controllers(mgr)) {
 456         ofproto_flush_flows(mgr->ofproto);
 457     }
 458 }
 459
 460 /* Drops the connections between 'mgr' and all of its primary and secondary
 461  * controllers, forcing them to reconnect. */
 462 void
 463 connmgr_reconnect(const struct connmgr *mgr)
 464 {
 465     struct ofconn *ofconn;
 466
 467     LIST_FOR_EACH (ofconn, node, &mgr->all_conns) {
 468         rconn_reconnect(ofconn->rconn);
 469     }
 470 }
 471
 472 /* Sets the "snoops" for 'mgr' to the pvconn targets listed in 'snoops'.
 473  *
 474  * A "snoop" is a pvconn to which every OpenFlow message to or from the most
 475  * important controller on 'mgr' is mirrored. */
 476 int
 477 connmgr_set_snoops(struct connmgr *mgr, const struct sset *snoops)
 478 {
 479     return set_pvconns(&mgr->snoops, &mgr->n_snoops, snoops);
 480 }
 481
 482 /* Adds each of the snoops currently configured on 'mgr' to 'snoops'. */
 483 void
 484 connmgr_get_snoops(const struct connmgr *mgr, struct sset *snoops)
 485 {
 486     size_t i;
 487
 488     for (i = 0; i < mgr->n_snoops; i++) {
 489         sset_add(snoops, pvconn_get_name(mgr->snoops[i]));
 490     }
 491 }
 492
 493 /* Returns true if 'mgr' has at least one snoop, false if it has none. */
 494 bool
 495 connmgr_has_snoops(const struct connmgr *mgr)
 496 {
 497     return mgr->n_snoops > 0;
 498 }
 499
 500 /* Creates a new controller for 'target' in 'mgr'.  update_controller() needs
 501  * to be called later to finish the new ofconn's configuration. */
 502 static void
 503 add_controller(struct connmgr *mgr, const char *target)
 504 {
 505     char *name = ofconn_make_name(mgr, target);
 506     struct ofconn *ofconn;
 507
 508     ofconn = ofconn_create(mgr, rconn_create(5, 8), OFCONN_PRIMARY);
 509     ofconn->pktbuf = pktbuf_create();
 510     ofconn->miss_send_len = OFP_DEFAULT_MISS_SEND_LEN;
 511     rconn_connect(ofconn->rconn, target, name);
 512     hmap_insert(&mgr->controllers, &ofconn->hmap_node, hash_string(target, 0));
 513
 514     free(name);
 515 }
 516
 517 static struct ofconn *
 518 find_controller_by_target(struct connmgr *mgr, const char *target)
 519 {
 520     struct ofconn *ofconn;
 521
 522     HMAP_FOR_EACH_WITH_HASH (ofconn, hmap_node,
 523                              hash_string(target, 0), &mgr->controllers) {
 524         if (!strcmp(ofconn_get_target(ofconn), target)) {
 525             return ofconn;
 526         }
 527     }
 528     return NULL;
 529 }
 530
 531 static void
 532 update_in_band_remotes(struct connmgr *mgr)
 533 {
 534     struct sockaddr_in *addrs;
 535     size_t max_addrs, n_addrs;
 536     struct ofconn *ofconn;
 537     size_t i;
 538
 539     /* Allocate enough memory for as many remotes as we could possibly have. */
 540     max_addrs = mgr->n_extra_remotes + hmap_count(&mgr->controllers);
 541     addrs = xmalloc(max_addrs * sizeof *addrs);
 542     n_addrs = 0;
 543
 544     /* Add all the remotes. */
 545     HMAP_FOR_EACH (ofconn, hmap_node, &mgr->controllers) {
 546         struct sockaddr_in *sin = &addrs[n_addrs];
 547
 548         if (ofconn->band == OFPROTO_OUT_OF_BAND) {
 549             continue;
 550         }
 551
 552         sin->sin_addr.s_addr = rconn_get_remote_ip(ofconn->rconn);
 553         if (sin->sin_addr.s_addr) {
 554             sin->sin_port = rconn_get_remote_port(ofconn->rconn);
 555             n_addrs++;
 556         }
 557     }
 558     for (i = 0; i < mgr->n_extra_remotes; i++) {
 559         addrs[n_addrs++] = mgr->extra_in_band_remotes[i];
 560     }
 561
 562     /* Create or update or destroy in-band. */
 563     if (n_addrs) {
 564         if (!mgr->in_band) {
 565             in_band_create(mgr->ofproto, mgr->local_port_name, &mgr->in_band);
 566         }
 567         if (mgr->in_band) {
 568             in_band_set_remotes(mgr->in_band, addrs, n_addrs);
 569         }
 570         in_band_set_queue(mgr->in_band, mgr->in_band_queue);
 571         mgr->next_in_band_update = time_msec() + 1000;
 572     } else {
 573         in_band_destroy(mgr->in_band);
 574         mgr->in_band = NULL;
 575     }
 576
 577     /* Clean up. */
 578     free(addrs);
 579 }
 580
 581 static void
 582 update_fail_open(struct connmgr *mgr)
 583 {
 584     if (connmgr_has_controllers(mgr)
 585         && mgr->fail_mode == OFPROTO_FAIL_STANDALONE) {
 586         if (!mgr->fail_open) {
 587             mgr->fail_open = fail_open_create(mgr->ofproto, mgr);
 588         }
 589     } else {
 590         fail_open_destroy(mgr->fail_open);
 591         mgr->fail_open = NULL;
 592     }
 593 }
 594
 595 static int
 596 set_pvconns(struct pvconn ***pvconnsp, size_t *n_pvconnsp,
 597             const struct sset *sset)
 598 {
 599     struct pvconn **pvconns = *pvconnsp;
 600     size_t n_pvconns = *n_pvconnsp;
 601     const char *name;
 602     int retval = 0;
 603     size_t i;
 604
 605     for (i = 0; i < n_pvconns; i++) {
 606         pvconn_close(pvconns[i]);
 607     }
 608     free(pvconns);
 609
 610     pvconns = xmalloc(sset_count(sset) * sizeof *pvconns);
 611     n_pvconns = 0;
 612     SSET_FOR_EACH (name, sset) {
 613         struct pvconn *pvconn;
 614         int error;
 615
 616         error = pvconn_open(name, &pvconn);
 617         if (!error) {
 618             pvconns[n_pvconns++] = pvconn;
 619         } else {
 620             VLOG_ERR("failed to listen on %s: %s", name, strerror(error));
 621             if (!retval) {
 622                 retval = error;
 623             }
 624         }
 625     }
 626
 627     *pvconnsp = pvconns;
 628     *n_pvconnsp = n_pvconns;
 629
 630     return retval;
 631 }
 632
 633 /* Returns a "preference level" for snooping 'ofconn'.  A higher return value
 634  * means that 'ofconn' is more interesting for monitoring than a lower return
 635  * value. */
 636 static int
 637 snoop_preference(const struct ofconn *ofconn)
 638 {
 639     switch (ofconn->role) {
 640     case NX_ROLE_MASTER:
 641         return 3;
 642     case NX_ROLE_OTHER:
 643         return 2;
 644     case NX_ROLE_SLAVE:
 645         return 1;
 646     default:
 647         /* Shouldn't happen. */
 648         return 0;
 649     }
 650 }
 651
 652 /* One of 'mgr''s "snoop" pvconns has accepted a new connection on 'vconn'.
 653  * Connects this vconn to a controller. */
 654 static void
 655 add_snooper(struct connmgr *mgr, struct vconn *vconn)
 656 {
 657     struct ofconn *ofconn, *best;
 658
 659     /* Pick a controller for monitoring. */
 660     best = NULL;
 661     LIST_FOR_EACH (ofconn, node, &mgr->all_conns) {
 662         if (ofconn->type == OFCONN_PRIMARY
 663             && (!best || snoop_preference(ofconn) > snoop_preference(best))) {
 664             best = ofconn;
 665         }
 666     }
 667
 668     if (best) {
 669         rconn_add_monitor(best->rconn, vconn);
 670     } else {
 671         VLOG_INFO_RL(&rl, "no controller connection to snoop");
 672         vconn_close(vconn);
 673     }
 674 }
 675 \f
 676 /* Public ofconn functions. */
 677
 678 /* Returns the connection type, either OFCONN_PRIMARY or OFCONN_SERVICE. */
 679 enum ofconn_type
 680 ofconn_get_type(const struct ofconn *ofconn)
 681 {
 682     return ofconn->type;
 683 }
 684
 685 /* Returns the role configured for 'ofconn'.
 686  *
 687  * The default role, if no other role has been set, is NX_ROLE_OTHER. */
 688 enum nx_role
 689 ofconn_get_role(const struct ofconn *ofconn)
 690 {
 691     return ofconn->role;
 692 }
 693
 694 /* Changes 'ofconn''s role to 'role'.  If 'role' is NX_ROLE_MASTER then any
 695  * existing master is demoted to a slave. */
 696 void
 697 ofconn_set_role(struct ofconn *ofconn, enum nx_role role)
 698 {
 699     if (role == NX_ROLE_MASTER) {
 700         struct ofconn *other;
 701
 702         HMAP_FOR_EACH (other, hmap_node, &ofconn->connmgr->controllers) {
 703             if (other->role == NX_ROLE_MASTER) {
 704                 other->role = NX_ROLE_SLAVE;
 705             }
 706         }
 707     }
 708     ofconn->role = role;
 709 }
 710
 711 /* Returns the currently configured flow format for 'ofconn', one of NXFF_*.
 712  *
 713  * The default, if no other format has been set, is NXFF_OPENFLOW10. */
 714 enum nx_flow_format
 715 ofconn_get_flow_format(struct ofconn *ofconn)
 716 {
 717     return ofconn->flow_format;
 718 }
 719
 720 /* Sets the flow format for 'ofconn' to 'flow_format' (one of NXFF_*). */
 721 void
 722 ofconn_set_flow_format(struct ofconn *ofconn, enum nx_flow_format flow_format)
 723 {
 724     ofconn->flow_format = flow_format;
 725 }
 726
 727 /* Returns the default miss send length for 'ofconn'. */
 728 int
 729 ofconn_get_miss_send_len(const struct ofconn *ofconn)
 730 {
 731     return ofconn->miss_send_len;
 732 }
 733
 734 /* Sets the default miss send length for 'ofconn' to 'miss_send_len'. */
 735 void
 736 ofconn_set_miss_send_len(struct ofconn *ofconn, int miss_send_len)
 737 {
 738     ofconn->miss_send_len = miss_send_len;
 739 }
 740
 741 /* Sends 'msg' on 'ofconn', accounting it as a reply.  (If there is a
 742  * sufficient number of OpenFlow replies in-flight on a single ofconn, then the
 743  * connmgr will stop accepting new OpenFlow requests on that ofconn until the
 744  * controller has accepted some of the replies.) */
 745 void
 746 ofconn_send_reply(const struct ofconn *ofconn, struct ofpbuf *msg)
 747 {
 748     ofconn_send(ofconn, msg, ofconn->reply_counter);
 749 }
 750
 751 /* Same as pktbuf_retrieve(), using the pktbuf owned by 'ofconn'. */
 752 int
 753 ofconn_pktbuf_retrieve(struct ofconn *ofconn, uint32_t id,
 754                        struct ofpbuf **bufferp, uint16_t *in_port)
 755 {
 756     return pktbuf_retrieve(ofconn->pktbuf, id, bufferp, in_port);
 757 }
 758 \f
 759 /* Private ofconn functions. */
 760
 761 static const char *
 762 ofconn_get_target(const struct ofconn *ofconn)
 763 {
 764     return rconn_get_target(ofconn->rconn);
 765 }
 766
 767 static struct ofconn *
 768 ofconn_create(struct connmgr *mgr, struct rconn *rconn, enum ofconn_type type)
 769 {
 770     struct ofconn *ofconn = xzalloc(sizeof *ofconn);
 771     ofconn->connmgr = mgr;
 772     list_push_back(&mgr->all_conns, &ofconn->node);
 773     ofconn->rconn = rconn;
 774     ofconn->type = type;
 775     ofconn->flow_format = NXFF_OPENFLOW10;
 776     ofconn->role = NX_ROLE_OTHER;
 777     ofconn->packet_in_counter = rconn_packet_counter_create ();
 778     ofconn->pktbuf = NULL;
 779     ofconn->miss_send_len = 0;
 780     ofconn->reply_counter = rconn_packet_counter_create ();
 781     return ofconn;
 782 }
 783
 784 static void
 785 ofconn_destroy(struct ofconn *ofconn)
 786 {
 787     if (ofconn->type == OFCONN_PRIMARY) {
 788         hmap_remove(&ofconn->connmgr->controllers, &ofconn->hmap_node);
 789     }
 790
 791     list_remove(&ofconn->node);
 792     rconn_destroy(ofconn->rconn);
 793     rconn_packet_counter_destroy(ofconn->packet_in_counter);
 794     rconn_packet_counter_destroy(ofconn->reply_counter);
 795     pktbuf_destroy(ofconn->pktbuf);
 796     free(ofconn);
 797 }
 798
 799 /* Reconfigures 'ofconn' to match 'c'.  'ofconn' and 'c' must have the same
 800  * target. */
 801 static void
 802 ofconn_reconfigure(struct ofconn *ofconn, const struct ofproto_controller *c)
 803 {
 804     int probe_interval;
 805
 806     ofconn->band = c->band;
 807
 808     rconn_set_max_backoff(ofconn->rconn, c->max_backoff);
 809
 810     probe_interval = c->probe_interval ? MAX(c->probe_interval, 5) : 0;
 811     rconn_set_probe_interval(ofconn->rconn, probe_interval);
 812
 813     ofconn_set_rate_limit(ofconn, c->rate_limit, c->burst_limit);
 814 }
 815
 816 static void
 817 ofconn_run(struct ofconn *ofconn,
 818            void (*handle_openflow)(struct ofconn *, struct ofpbuf *ofp_msg))
 819 {
 820     struct connmgr *mgr = ofconn->connmgr;
 821     int iteration;
 822     size_t i;
 823
 824     for (i = 0; i < N_SCHEDULERS; i++) {
 825         pinsched_run(ofconn->schedulers[i], do_send_packet_in, ofconn);
 826     }
 827
 828     rconn_run(ofconn->rconn);
 829
 830     if (rconn_packet_counter_read (ofconn->reply_counter) < OFCONN_REPLY_MAX) {
 831         /* Limit the number of iterations to prevent other tasks from
 832          * starving. */
 833         for (iteration = 0; iteration < 50; iteration++) {
 834             struct ofpbuf *of_msg = rconn_recv(ofconn->rconn);
 835             if (!of_msg) {
 836                 break;
 837             }
 838             if (mgr->fail_open) {
 839                 fail_open_maybe_recover(mgr->fail_open);
 840             }
 841             handle_openflow(ofconn, of_msg);
 842             ofpbuf_delete(of_msg);
 843         }
 844     }
 845
 846     if (!rconn_is_alive(ofconn->rconn)) {
 847         ofconn_destroy(ofconn);
 848     }
 849 }
 850
 851 static void
 852 ofconn_wait(struct ofconn *ofconn)
 853 {
 854     int i;
 855
 856     for (i = 0; i < N_SCHEDULERS; i++) {
 857         pinsched_wait(ofconn->schedulers[i]);
 858     }
 859     rconn_run_wait(ofconn->rconn);
 860     if (rconn_packet_counter_read (ofconn->reply_counter) < OFCONN_REPLY_MAX) {
 861         rconn_recv_wait(ofconn->rconn);
 862     } else {
 863         COVERAGE_INC(ofconn_stuck);
 864     }
 865 }
 866
 867 /* Returns true if 'ofconn' should receive asynchronous messages. */
 868 static bool
 869 ofconn_receives_async_msgs(const struct ofconn *ofconn)
 870 {
 871     if (!rconn_is_connected(ofconn->rconn)) {
 872         return false;
 873     } else if (ofconn->type == OFCONN_PRIMARY) {
 874         /* Primary controllers always get asynchronous messages unless they
 875          * have configured themselves as "slaves".  */
 876         return ofconn->role != NX_ROLE_SLAVE;
 877     } else {
 878         /* Service connections don't get asynchronous messages unless they have
 879          * explicitly asked for them by setting a nonzero miss send length. */
 880         return ofconn->miss_send_len > 0;
 881     }
 882 }
 883
 884 /* Returns a human-readable name for an OpenFlow connection between 'mgr' and
 885  * 'target', suitable for use in log messages for identifying the connection.
 886  *
 887  * The name is dynamically allocated.  The caller should free it (with free())
 888  * when it is no longer needed. */
 889 static char *
 890 ofconn_make_name(const struct connmgr *mgr, const char *target)
 891 {
 892     return xasprintf("%s<->%s", mgr->name, target);
 893 }
 894
 895 static void
 896 ofconn_set_rate_limit(struct ofconn *ofconn, int rate, int burst)
 897 {
 898     int i;
 899
 900     for (i = 0; i < N_SCHEDULERS; i++) {
 901         struct pinsched **s = &ofconn->schedulers[i];
 902
 903         if (rate > 0) {
 904             if (!*s) {
 905                 *s = pinsched_create(rate, burst);
 906             } else {
 907                 pinsched_set_limits(*s, rate, burst);
 908             }
 909         } else {
 910             pinsched_destroy(*s);
 911             *s = NULL;
 912         }
 913     }
 914 }
 915
 916 static void
 917 ofconn_send(const struct ofconn *ofconn, struct ofpbuf *msg,
 918             struct rconn_packet_counter *counter)
 919 {
 920     update_openflow_length(msg);
 921     if (rconn_send(ofconn->rconn, msg, counter)) {
 922         ofpbuf_delete(msg);
 923     }
 924 }
 925 \f
 926 /* Sending asynchronous messages. */
 927
 928 static void schedule_packet_in(struct ofconn *, struct ofputil_packet_in,
 929                                const struct flow *, struct ofpbuf *rw_packet);
 930
 931 /* Sends an OFPT_PORT_STATUS message with 'opp' and 'reason' to appropriate
 932  * controllers managed by 'mgr'. */
 933 void
 934 connmgr_send_port_status(struct connmgr *mgr, const struct ofp_phy_port *opp,
 935                          uint8_t reason)
 936 {
 937     /* XXX Should limit the number of queued port status change messages. */
 938     struct ofconn *ofconn;
 939
 940     LIST_FOR_EACH (ofconn, node, &mgr->all_conns) {
 941         struct ofp_port_status *ops;
 942         struct ofpbuf *b;
 943
 944         /* Primary controllers, even slaves, should always get port status
 945            updates.  Otherwise obey ofconn_receives_async_msgs(). */
 946         if (ofconn->type != OFCONN_PRIMARY
 947             && !ofconn_receives_async_msgs(ofconn)) {
 948             continue;
 949         }
 950
 951         ops = make_openflow_xid(sizeof *ops, OFPT_PORT_STATUS, 0, &b);
 952         ops->reason = reason;
 953         ops->desc = *opp;
 954         ofconn_send(ofconn, b, NULL);
 955     }
 956 }
 957
 958 /* Sends an OFPT_FLOW_REMOVED or NXT_FLOW_REMOVED message based on 'fr' to
 959  * appropriate controllers managed by 'mgr'. */
 960 void
 961 connmgr_send_flow_removed(struct connmgr *mgr,
 962                           const struct ofputil_flow_removed *fr)
 963 {
 964     struct ofconn *ofconn;
 965
 966     LIST_FOR_EACH (ofconn, node, &mgr->all_conns) {
 967         struct ofpbuf *msg;
 968
 969         if (!ofconn_receives_async_msgs(ofconn)) {
 970             continue;
 971         }
 972
 973         /* Account flow expirations as replies to OpenFlow requests.  That
 974          * works because preventing OpenFlow requests from being processed also
 975          * prevents new flows from being added (and expiring).  (It also
 976          * prevents processing OpenFlow requests that would not add new flows,
 977          * so it is imperfect.) */
 978         msg = ofputil_encode_flow_removed(fr, ofconn->flow_format);
 979         ofconn_send_reply(ofconn, msg);
 980     }
 981 }
 982
 983 /* Given 'pin', sends an OFPT_PACKET_IN message to each OpenFlow controller as
 984  * necessary according to their individual configurations.
 985  *
 986  * 'rw_packet' may be NULL.  Otherwise, 'rw_packet' must contain the same data
 987  * as pin->packet.  (rw_packet == pin->packet is also valid.)  Ownership of
 988  * 'rw_packet' is transferred to this function. */
 989 void
 990 connmgr_send_packet_in(struct connmgr *mgr,
 991                        const struct ofputil_packet_in *pin,
 992                        const struct flow *flow, struct ofpbuf *rw_packet)
 993 {
 994     struct ofconn *ofconn, *prev;
 995
 996     prev = NULL;
 997     LIST_FOR_EACH (ofconn, node, &mgr->all_conns) {
 998         if (ofconn_receives_async_msgs(ofconn)) {
 999             if (prev) {
1000                 schedule_packet_in(prev, *pin, flow, NULL);
1001             }
1002             prev = ofconn;
1003         }
1004     }
1005     if (prev) {
1006         schedule_packet_in(prev, *pin, flow, rw_packet);
1007     } else {
1008         ofpbuf_delete(rw_packet);
1009     }
1010 }
1011
1012 /* pinsched callback for sending 'ofp_packet_in' on 'ofconn'. */
1013 static void
1014 do_send_packet_in(struct ofpbuf *ofp_packet_in, void *ofconn_)
1015 {
1016     struct ofconn *ofconn = ofconn_;
1017
1018     rconn_send_with_limit(ofconn->rconn, ofp_packet_in,
1019                           ofconn->packet_in_counter, 100);
1020 }
1021
1022 /* Takes 'pin', whose packet has the flow specified by 'flow', composes an
1023  * OpenFlow packet-in message from it, and passes it to 'ofconn''s packet
1024  * scheduler for sending.
1025  *
1026  * 'rw_packet' may be NULL.  Otherwise, 'rw_packet' must contain the same data
1027  * as pin->packet.  (rw_packet == pin->packet is also valid.)  Ownership of
1028  * 'rw_packet' is transferred to this function. */
1029 static void
1030 schedule_packet_in(struct ofconn *ofconn, struct ofputil_packet_in pin,
1031                    const struct flow *flow, struct ofpbuf *rw_packet)
1032 {
1033     struct connmgr *mgr = ofconn->connmgr;
1034
1035     /* Get OpenFlow buffer_id. */
1036     if (pin.reason == OFPR_ACTION) {
1037         pin.buffer_id = UINT32_MAX;
1038     } else if (mgr->fail_open && fail_open_is_active(mgr->fail_open)) {
1039         pin.buffer_id = pktbuf_get_null();
1040     } else if (!ofconn->pktbuf) {
1041         pin.buffer_id = UINT32_MAX;
1042     } else {
1043         pin.buffer_id = pktbuf_save(ofconn->pktbuf, pin.packet, flow->in_port);
1044     }
1045
1046     /* Figure out how much of the packet to send. */
1047     if (pin.reason == OFPR_NO_MATCH) {
1048         pin.send_len = pin.packet->size;
1049     } else {
1050         /* Caller should have initialized 'send_len' to 'max_len' specified in
1051          * struct ofp_action_output. */
1052     }
1053     if (pin.buffer_id != UINT32_MAX) {
1054         pin.send_len = MIN(pin.send_len, ofconn->miss_send_len);
1055     }
1056
1057     /* Make OFPT_PACKET_IN and hand over to packet scheduler.  It might
1058      * immediately call into do_send_packet_in() or it might buffer it for a
1059      * while (until a later call to pinsched_run()). */
1060     pinsched_send(ofconn->schedulers[pin.reason == OFPR_NO_MATCH ? 0 : 1],
1061                   flow->in_port, ofputil_encode_packet_in(&pin, rw_packet),
1062                   do_send_packet_in, ofconn);
1063 }
1064 \f
1065 /* Fail-open settings. */
1066
1067 /* Returns the failure handling mode (OFPROTO_FAIL_SECURE or
1068  * OFPROTO_FAIL_STANDALONE) for 'mgr'. */
1069 enum ofproto_fail_mode
1070 connmgr_get_fail_mode(const struct connmgr *mgr)
1071 {
1072     return mgr->fail_mode;
1073 }
1074
1075 /* Sets the failure handling mode for 'mgr' to 'fail_mode' (either
1076  * OFPROTO_FAIL_SECURE or OFPROTO_FAIL_STANDALONE). */
1077 void
1078 connmgr_set_fail_mode(struct connmgr *mgr, enum ofproto_fail_mode fail_mode)
1079 {
1080     if (mgr->fail_mode != fail_mode) {
1081         mgr->fail_mode = fail_mode;
1082         update_fail_open(mgr);
1083         if (!connmgr_has_controllers(mgr)) {
1084             ofproto_flush_flows(mgr->ofproto);
1085         }
1086     }
1087 }
1088 \f
1089 /* Fail-open implementation. */
1090
1091 /* Returns the longest probe interval among the primary controllers configured
1092  * on 'mgr'.  Returns 0 if there are no primary controllers. */
1093 int
1094 connmgr_get_max_probe_interval(const struct connmgr *mgr)
1095 {
1096     const struct ofconn *ofconn;
1097     int max_probe_interval;
1098
1099     max_probe_interval = 0;
1100     HMAP_FOR_EACH (ofconn, hmap_node, &mgr->controllers) {
1101         int probe_interval = rconn_get_probe_interval(ofconn->rconn);
1102         max_probe_interval = MAX(max_probe_interval, probe_interval);
1103     }
1104     return max_probe_interval;
1105 }
1106
1107 /* Returns the number of seconds for which all of 'mgr's primary controllers
1108  * have been disconnected.  Returns 0 if 'mgr' has no primary controllers. */
1109 int
1110 connmgr_failure_duration(const struct connmgr *mgr)
1111 {
1112     const struct ofconn *ofconn;
1113     int min_failure_duration;
1114
1115     if (!connmgr_has_controllers(mgr)) {
1116         return 0;
1117     }
1118
1119     min_failure_duration = INT_MAX;
1120     HMAP_FOR_EACH (ofconn, hmap_node, &mgr->controllers) {
1121         int failure_duration = rconn_failure_duration(ofconn->rconn);
1122         min_failure_duration = MIN(min_failure_duration, failure_duration);
1123     }
1124     return min_failure_duration;
1125 }
1126
1127 /* Returns true if at least one primary controller is connected (regardless of
1128  * whether those controllers are believed to have authenticated and accepted
1129  * this switch), false if none of them are connected. */
1130 bool
1131 connmgr_is_any_controller_connected(const struct connmgr *mgr)
1132 {
1133     const struct ofconn *ofconn;
1134
1135     HMAP_FOR_EACH (ofconn, hmap_node, &mgr->controllers) {
1136         if (rconn_is_connected(ofconn->rconn)) {
1137             return true;
1138         }
1139     }
1140     return false;
1141 }
1142
1143 /* Returns true if at least one primary controller is believed to have
1144  * authenticated and accepted this switch, false otherwise. */
1145 bool
1146 connmgr_is_any_controller_admitted(const struct connmgr *mgr)
1147 {
1148     const struct ofconn *ofconn;
1149
1150     HMAP_FOR_EACH (ofconn, hmap_node, &mgr->controllers) {
1151         if (rconn_is_admitted(ofconn->rconn)) {
1152             return true;
1153         }
1154     }
1155     return false;
1156 }
1157
1158 /* Sends 'packet' to each controller connected to 'mgr'.  Takes ownership of
1159  * 'packet'. */
1160 void
1161 connmgr_broadcast(struct connmgr *mgr, struct ofpbuf *packet)
1162 {
1163     struct ofconn *ofconn, *prev;
1164
1165     prev = NULL;
1166     LIST_FOR_EACH (ofconn, node, &mgr->all_conns) {
1167         if (prev) {
1168             ofconn_send_reply(ofconn, ofpbuf_clone(packet));
1169         }
1170         if (rconn_is_connected(ofconn->rconn)) {
1171             prev = ofconn;
1172         }
1173     }
1174     if (prev) {
1175         ofconn_send_reply(prev, packet);
1176     } else {
1177         ofpbuf_delete(packet);
1178     }
1179 }
1180 \f
1181 /* In-band configuration. */
1182
1183 static bool any_extras_changed(const struct connmgr *,
1184                                const struct sockaddr_in *extras, size_t n);
1185
1186 /* Sets the 'n' TCP port addresses in 'extras' as ones to which 'mgr''s
1187  * in-band control should guarantee access, in the same way that in-band
1188  * control guarantees access to OpenFlow controllers. */
1189 void
1190 connmgr_set_extra_in_band_remotes(struct connmgr *mgr,
1191                                   const struct sockaddr_in *extras, size_t n)
1192 {
1193     if (!any_extras_changed(mgr, extras, n)) {
1194         return;
1195     }
1196
1197     free(mgr->extra_in_band_remotes);
1198     mgr->n_extra_remotes = n;
1199     mgr->extra_in_band_remotes = xmemdup(extras, n * sizeof *extras);
1200
1201     update_in_band_remotes(mgr);
1202 }
1203
1204 /* Sets the OpenFlow queue used by flows set up by in-band control on
1205  * 'mgr' to 'queue_id'.  If 'queue_id' is negative, then in-band control
1206  * flows will use the default queue. */
1207 void
1208 connmgr_set_in_band_queue(struct connmgr *mgr, int queue_id)
1209 {
1210     if (queue_id != mgr->in_band_queue) {
1211         mgr->in_band_queue = queue_id;
1212         update_in_band_remotes(mgr);
1213     }
1214 }
1215
1216 static bool
1217 any_extras_changed(const struct connmgr *mgr,
1218                    const struct sockaddr_in *extras, size_t n)
1219 {
1220     size_t i;
1221
1222     if (n != mgr->n_extra_remotes) {
1223         return true;
1224     }
1225
1226     for (i = 0; i < n; i++) {
1227         const struct sockaddr_in *old = &mgr->extra_in_band_remotes[i];
1228         const struct sockaddr_in *new = &extras[i];
1229
1230         if (old->sin_addr.s_addr != new->sin_addr.s_addr ||
1231             old->sin_port != new->sin_port) {
1232             return true;
1233         }
1234     }
1235
1236     return false;
1237 }
1238 \f
1239 /* In-band implementation. */
1240
1241 bool
1242 connmgr_msg_in_hook(struct connmgr *mgr, const struct flow *flow,
1243                     const struct ofpbuf *packet)
1244 {
1245     return mgr->in_band && in_band_msg_in_hook(mgr->in_band, flow, packet);
1246 }
1247
1248 bool
1249 connmgr_may_set_up_flow(struct connmgr *mgr, const struct flow *flow,
1250                         const struct nlattr *odp_actions,
1251                         size_t actions_len)
1252 {
1253     return !mgr->in_band || in_band_rule_check(flow, odp_actions, actions_len);
1254 }
1255 \f
1256 /* Fail-open and in-band implementation. */
1257
1258 /* Called by 'ofproto' after all flows have been flushed, to allow fail-open
1259  * and in-band control to re-create their flows. */
1260 void
1261 connmgr_flushed(struct connmgr *mgr)
1262 {
1263     if (mgr->in_band) {
1264         in_band_flushed(mgr->in_band);
1265     }
1266     if (mgr->fail_open) {
1267         fail_open_flushed(mgr->fail_open);
1268     }
1269
1270     /* If there are no controllers and we're in standalone mode, set up a flow
1271      * that matches every packet and directs them to OFPP_NORMAL (which goes to
1272      * us).  Otherwise, the switch is in secure mode and we won't pass any
1273      * traffic until a controller has been defined and it tells us to do so. */
1274     if (!connmgr_has_controllers(mgr)
1275         && mgr->fail_mode == OFPROTO_FAIL_STANDALONE) {
1276         union ofp_action action;
1277         struct cls_rule rule;
1278
1279         memset(&action, 0, sizeof action);
1280         action.type = htons(OFPAT_OUTPUT);
1281         action.output.len = htons(sizeof action);
1282         action.output.port = htons(OFPP_NORMAL);
1283         cls_rule_init_catchall(&rule, 0);
1284         ofproto_add_flow(mgr->ofproto, &rule, &action, 1);
1285     }
1286 }
1287 \f
1288 /* Creates a new ofservice for 'target' in 'mgr'.  Returns 0 if successful,
1289  * otherwise a positive errno value.
1290  *
1291  * ofservice_reconfigure() must be called to fully configure the new
1292  * ofservice. */
1293 static int
1294 ofservice_create(struct connmgr *mgr, const char *target)
1295 {
1296     struct ofservice *ofservice;
1297     struct pvconn *pvconn;
1298     int error;
1299
1300     error = pvconn_open(target, &pvconn);
1301     if (error) {
1302         return error;
1303     }
1304
1305     ofservice = xzalloc(sizeof *ofservice);
1306     hmap_insert(&mgr->services, &ofservice->node, hash_string(target, 0));
1307     ofservice->pvconn = pvconn;
1308
1309     return 0;
1310 }
1311
1312 static void
1313 ofservice_destroy(struct connmgr *mgr, struct ofservice *ofservice)
1314 {
1315     hmap_remove(&mgr->services, &ofservice->node);
1316     pvconn_close(ofservice->pvconn);
1317     free(ofservice);
1318 }
1319
1320 static void
1321 ofservice_reconfigure(struct ofservice *ofservice,
1322                       const struct ofproto_controller *c)
1323 {
1324     ofservice->probe_interval = c->probe_interval;
1325     ofservice->rate_limit = c->rate_limit;
1326     ofservice->burst_limit = c->burst_limit;
1327 }
1328
1329 /* Finds and returns the ofservice within 'mgr' that has the given
1330  * 'target', or a null pointer if none exists. */
1331 static struct ofservice *
1332 ofservice_lookup(struct connmgr *mgr, const char *target)
1333 {
1334     struct ofservice *ofservice;
1335
1336     HMAP_FOR_EACH_WITH_HASH (ofservice, node, hash_string(target, 0),
1337                              &mgr->services) {
1338         if (!strcmp(pvconn_get_name(ofservice->pvconn), target)) {
1339             return ofservice;
1340         }
1341     }
1342     return NULL;
1343 }