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 "dpif.h"
  26 #include "fail-open.h"
  27 #include "in-band.h"
  28 #include "odp-util.h"
  29 #include "ofp-util.h"
  30 #include "ofpbuf.h"
  31 #include "pinsched.h"
  32 #include "poll-loop.h"
  33 #include "pktbuf.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     struct shash new_controllers;
 394     struct ofconn *ofconn, *next_ofconn;
 395     struct ofservice *ofservice, *next_ofservice;
 396     size_t i;
 397
 398     /* Create newly configured controllers and services.
 399      * Create a name to ofproto_controller mapping in 'new_controllers'. */
 400     shash_init(&new_controllers);
 401     for (i = 0; i < n_controllers; i++) {
 402         const struct ofproto_controller *c = &controllers[i];
 403
 404         if (!vconn_verify_name(c->target)) {
 405             if (!find_controller_by_target(mgr, c->target)) {
 406                 add_controller(mgr, c->target);
 407             }
 408         } else if (!pvconn_verify_name(c->target)) {
 409             if (!ofservice_lookup(mgr, c->target)) {
 410                 ofservice_create(mgr, c->target);
 411             }
 412         } else {
 413             VLOG_WARN_RL(&rl, "%s: unsupported controller \"%s\"",
 414                          mgr->name, c->target);
 415             continue;
 416         }
 417
 418         shash_add_once(&new_controllers, c->target, &controllers[i]);
 419     }
 420
 421     /* Delete controllers that are no longer configured.
 422      * Update configuration of all now-existing controllers. */
 423     HMAP_FOR_EACH_SAFE (ofconn, next_ofconn, hmap_node, &mgr->controllers) {
 424         struct ofproto_controller *c;
 425
 426         c = shash_find_data(&new_controllers, ofconn_get_target(ofconn));
 427         if (!c) {
 428             ofconn_destroy(ofconn);
 429         } else {
 430             ofconn_reconfigure(ofconn, c);
 431         }
 432     }
 433
 434     /* Delete services that are no longer configured.
 435      * Update configuration of all now-existing services. */
 436     HMAP_FOR_EACH_SAFE (ofservice, next_ofservice, node, &mgr->services) {
 437         struct ofproto_controller *c;
 438
 439         c = shash_find_data(&new_controllers,
 440                             pvconn_get_name(ofservice->pvconn));
 441         if (!c) {
 442             ofservice_destroy(mgr, ofservice);
 443         } else {
 444             ofservice_reconfigure(ofservice, c);
 445         }
 446     }
 447
 448     shash_destroy(&new_controllers);
 449
 450     update_in_band_remotes(mgr);
 451     update_fail_open(mgr);
 452 }
 453
 454 /* Drops the connections between 'mgr' and all of its primary and secondary
 455  * controllers, forcing them to reconnect. */
 456 void
 457 connmgr_reconnect(const struct connmgr *mgr)
 458 {
 459     struct ofconn *ofconn;
 460
 461     LIST_FOR_EACH (ofconn, node, &mgr->all_conns) {
 462         rconn_reconnect(ofconn->rconn);
 463     }
 464 }
 465
 466 /* Sets the "snoops" for 'mgr' to the pvconn targets listed in 'snoops'.
 467  *
 468  * A "snoop" is a pvconn to which every OpenFlow message to or from the most
 469  * important controller on 'mgr' is mirrored. */
 470 int
 471 connmgr_set_snoops(struct connmgr *mgr, const struct sset *snoops)
 472 {
 473     return set_pvconns(&mgr->snoops, &mgr->n_snoops, snoops);
 474 }
 475
 476 /* Adds each of the snoops currently configured on 'mgr' to 'snoops'. */
 477 void
 478 connmgr_get_snoops(const struct connmgr *mgr, struct sset *snoops)
 479 {
 480     size_t i;
 481
 482     for (i = 0; i < mgr->n_snoops; i++) {
 483         sset_add(snoops, pvconn_get_name(mgr->snoops[i]));
 484     }
 485 }
 486
 487 /* Returns true if 'mgr' has at least one snoop, false if it has none. */
 488 bool
 489 connmgr_has_snoops(const struct connmgr *mgr)
 490 {
 491     return mgr->n_snoops > 0;
 492 }
 493
 494 /* Creates a new controller for 'target' in 'mgr'.  update_controller() needs
 495  * to be called later to finish the new ofconn's configuration. */
 496 static void
 497 add_controller(struct connmgr *mgr, const char *target)
 498 {
 499     char *name = ofconn_make_name(mgr, target);
 500     struct ofconn *ofconn;
 501
 502     ofconn = ofconn_create(mgr, rconn_create(5, 8), OFCONN_PRIMARY);
 503     ofconn->pktbuf = pktbuf_create();
 504     ofconn->miss_send_len = OFP_DEFAULT_MISS_SEND_LEN;
 505     rconn_connect(ofconn->rconn, target, name);
 506     hmap_insert(&mgr->controllers, &ofconn->hmap_node, hash_string(target, 0));
 507
 508     free(name);
 509 }
 510
 511 static struct ofconn *
 512 find_controller_by_target(struct connmgr *mgr, const char *target)
 513 {
 514     struct ofconn *ofconn;
 515
 516     HMAP_FOR_EACH_WITH_HASH (ofconn, hmap_node,
 517                              hash_string(target, 0), &mgr->controllers) {
 518         if (!strcmp(ofconn_get_target(ofconn), target)) {
 519             return ofconn;
 520         }
 521     }
 522     return NULL;
 523 }
 524
 525 static void
 526 update_in_band_remotes(struct connmgr *mgr)
 527 {
 528     struct sockaddr_in *addrs;
 529     size_t max_addrs, n_addrs;
 530     struct ofconn *ofconn;
 531     size_t i;
 532
 533     /* Allocate enough memory for as many remotes as we could possibly have. */
 534     max_addrs = mgr->n_extra_remotes + hmap_count(&mgr->controllers);
 535     addrs = xmalloc(max_addrs * sizeof *addrs);
 536     n_addrs = 0;
 537
 538     /* Add all the remotes. */
 539     HMAP_FOR_EACH (ofconn, hmap_node, &mgr->controllers) {
 540         struct sockaddr_in *sin = &addrs[n_addrs];
 541
 542         if (ofconn->band == OFPROTO_OUT_OF_BAND) {
 543             continue;
 544         }
 545
 546         sin->sin_addr.s_addr = rconn_get_remote_ip(ofconn->rconn);
 547         if (sin->sin_addr.s_addr) {
 548             sin->sin_port = rconn_get_remote_port(ofconn->rconn);
 549             n_addrs++;
 550         }
 551     }
 552     for (i = 0; i < mgr->n_extra_remotes; i++) {
 553         addrs[n_addrs++] = mgr->extra_in_band_remotes[i];
 554     }
 555
 556     /* Create or update or destroy in-band. */
 557     if (n_addrs) {
 558         if (!mgr->in_band) {
 559             in_band_create(mgr->ofproto, mgr->local_port_name, &mgr->in_band);
 560         }
 561         if (mgr->in_band) {
 562             in_band_set_remotes(mgr->in_band, addrs, n_addrs);
 563         }
 564         in_band_set_queue(mgr->in_band, mgr->in_band_queue);
 565         mgr->next_in_band_update = time_msec() + 1000;
 566     } else {
 567         in_band_destroy(mgr->in_band);
 568         mgr->in_band = NULL;
 569     }
 570
 571     /* Clean up. */
 572     free(addrs);
 573 }
 574
 575 static void
 576 update_fail_open(struct connmgr *mgr)
 577 {
 578     if (connmgr_has_controllers(mgr)
 579         && mgr->fail_mode == OFPROTO_FAIL_STANDALONE) {
 580         if (!mgr->fail_open) {
 581             mgr->fail_open = fail_open_create(mgr->ofproto, mgr);
 582         }
 583     } else {
 584         fail_open_destroy(mgr->fail_open);
 585         mgr->fail_open = NULL;
 586     }
 587 }
 588
 589 static int
 590 set_pvconns(struct pvconn ***pvconnsp, size_t *n_pvconnsp,
 591             const struct sset *sset)
 592 {
 593     struct pvconn **pvconns = *pvconnsp;
 594     size_t n_pvconns = *n_pvconnsp;
 595     const char *name;
 596     int retval = 0;
 597     size_t i;
 598
 599     for (i = 0; i < n_pvconns; i++) {
 600         pvconn_close(pvconns[i]);
 601     }
 602     free(pvconns);
 603
 604     pvconns = xmalloc(sset_count(sset) * sizeof *pvconns);
 605     n_pvconns = 0;
 606     SSET_FOR_EACH (name, sset) {
 607         struct pvconn *pvconn;
 608         int error;
 609
 610         error = pvconn_open(name, &pvconn);
 611         if (!error) {
 612             pvconns[n_pvconns++] = pvconn;
 613         } else {
 614             VLOG_ERR("failed to listen on %s: %s", name, strerror(error));
 615             if (!retval) {
 616                 retval = error;
 617             }
 618         }
 619     }
 620
 621     *pvconnsp = pvconns;
 622     *n_pvconnsp = n_pvconns;
 623
 624     return retval;
 625 }
 626
 627 /* Returns a "preference level" for snooping 'ofconn'.  A higher return value
 628  * means that 'ofconn' is more interesting for monitoring than a lower return
 629  * value. */
 630 static int
 631 snoop_preference(const struct ofconn *ofconn)
 632 {
 633     switch (ofconn->role) {
 634     case NX_ROLE_MASTER:
 635         return 3;
 636     case NX_ROLE_OTHER:
 637         return 2;
 638     case NX_ROLE_SLAVE:
 639         return 1;
 640     default:
 641         /* Shouldn't happen. */
 642         return 0;
 643     }
 644 }
 645
 646 /* One of 'mgr''s "snoop" pvconns has accepted a new connection on 'vconn'.
 647  * Connects this vconn to a controller. */
 648 static void
 649 add_snooper(struct connmgr *mgr, struct vconn *vconn)
 650 {
 651     struct ofconn *ofconn, *best;
 652
 653     /* Pick a controller for monitoring. */
 654     best = NULL;
 655     LIST_FOR_EACH (ofconn, node, &mgr->all_conns) {
 656         if (ofconn->type == OFCONN_PRIMARY
 657             && (!best || snoop_preference(ofconn) > snoop_preference(best))) {
 658             best = ofconn;
 659         }
 660     }
 661
 662     if (best) {
 663         rconn_add_monitor(best->rconn, vconn);
 664     } else {
 665         VLOG_INFO_RL(&rl, "no controller connection to snoop");
 666         vconn_close(vconn);
 667     }
 668 }
 669 \f
 670 /* Public ofconn functions. */
 671
 672 /* Returns the connection type, either OFCONN_PRIMARY or OFCONN_SERVICE. */
 673 enum ofconn_type
 674 ofconn_get_type(const struct ofconn *ofconn)
 675 {
 676     return ofconn->type;
 677 }
 678
 679 /* Returns the role configured for 'ofconn'.
 680  *
 681  * The default role, if no other role has been set, is NX_ROLE_OTHER. */
 682 enum nx_role
 683 ofconn_get_role(const struct ofconn *ofconn)
 684 {
 685     return ofconn->role;
 686 }
 687
 688 /* Changes 'ofconn''s role to 'role'.  If 'role' is NX_ROLE_MASTER then any
 689  * existing master is demoted to a slave. */
 690 void
 691 ofconn_set_role(struct ofconn *ofconn, enum nx_role role)
 692 {
 693     if (role == NX_ROLE_MASTER) {
 694         struct ofconn *other;
 695
 696         HMAP_FOR_EACH (other, hmap_node, &ofconn->connmgr->controllers) {
 697             if (other->role == NX_ROLE_MASTER) {
 698                 other->role = NX_ROLE_SLAVE;
 699             }
 700         }
 701     }
 702     ofconn->role = role;
 703 }
 704
 705 /* Returns the currently configured flow format for 'ofconn', one of NXFF_*.
 706  *
 707  * The default, if no other format has been set, is NXFF_OPENFLOW10. */
 708 enum nx_flow_format
 709 ofconn_get_flow_format(struct ofconn *ofconn)
 710 {
 711     return ofconn->flow_format;
 712 }
 713
 714 /* Sets the flow format for 'ofconn' to 'flow_format' (one of NXFF_*). */
 715 void
 716 ofconn_set_flow_format(struct ofconn *ofconn, enum nx_flow_format flow_format)
 717 {
 718     ofconn->flow_format = flow_format;
 719 }
 720
 721 /* Returns the default miss send length for 'ofconn'. */
 722 int
 723 ofconn_get_miss_send_len(const struct ofconn *ofconn)
 724 {
 725     return ofconn->miss_send_len;
 726 }
 727
 728 /* Sets the default miss send length for 'ofconn' to 'miss_send_len'. */
 729 void
 730 ofconn_set_miss_send_len(struct ofconn *ofconn, int miss_send_len)
 731 {
 732     ofconn->miss_send_len = miss_send_len;
 733 }
 734
 735 /* Sends 'msg' on 'ofconn', accounting it as a reply.  (If there is a
 736  * sufficient number of OpenFlow replies in-flight on a single ofconn, then the
 737  * connmgr will stop accepting new OpenFlow requests on that ofconn until the
 738  * controller has accepted some of the replies.) */
 739 void
 740 ofconn_send_reply(const struct ofconn *ofconn, struct ofpbuf *msg)
 741 {
 742     ofconn_send(ofconn, msg, ofconn->reply_counter);
 743 }
 744
 745 /* Same as pktbuf_retrieve(), using the pktbuf owned by 'ofconn'. */
 746 int
 747 ofconn_pktbuf_retrieve(struct ofconn *ofconn, uint32_t id,
 748                        struct ofpbuf **bufferp, uint16_t *in_port)
 749 {
 750     return pktbuf_retrieve(ofconn->pktbuf, id, bufferp, in_port);
 751 }
 752 \f
 753 /* Private ofconn functions. */
 754
 755 static const char *
 756 ofconn_get_target(const struct ofconn *ofconn)
 757 {
 758     return rconn_get_target(ofconn->rconn);
 759 }
 760
 761 static struct ofconn *
 762 ofconn_create(struct connmgr *mgr, struct rconn *rconn, enum ofconn_type type)
 763 {
 764     struct ofconn *ofconn = xzalloc(sizeof *ofconn);
 765     ofconn->connmgr = mgr;
 766     list_push_back(&mgr->all_conns, &ofconn->node);
 767     ofconn->rconn = rconn;
 768     ofconn->type = type;
 769     ofconn->flow_format = NXFF_OPENFLOW10;
 770     ofconn->role = NX_ROLE_OTHER;
 771     ofconn->packet_in_counter = rconn_packet_counter_create ();
 772     ofconn->pktbuf = NULL;
 773     ofconn->miss_send_len = 0;
 774     ofconn->reply_counter = rconn_packet_counter_create ();
 775     return ofconn;
 776 }
 777
 778 static void
 779 ofconn_destroy(struct ofconn *ofconn)
 780 {
 781     if (ofconn->type == OFCONN_PRIMARY) {
 782         hmap_remove(&ofconn->connmgr->controllers, &ofconn->hmap_node);
 783     }
 784
 785     list_remove(&ofconn->node);
 786     rconn_destroy(ofconn->rconn);
 787     rconn_packet_counter_destroy(ofconn->packet_in_counter);
 788     rconn_packet_counter_destroy(ofconn->reply_counter);
 789     pktbuf_destroy(ofconn->pktbuf);
 790     free(ofconn);
 791 }
 792
 793 /* Reconfigures 'ofconn' to match 'c'.  'ofconn' and 'c' must have the same
 794  * target. */
 795 static void
 796 ofconn_reconfigure(struct ofconn *ofconn, const struct ofproto_controller *c)
 797 {
 798     int probe_interval;
 799
 800     ofconn->band = c->band;
 801
 802     rconn_set_max_backoff(ofconn->rconn, c->max_backoff);
 803
 804     probe_interval = c->probe_interval ? MAX(c->probe_interval, 5) : 0;
 805     rconn_set_probe_interval(ofconn->rconn, probe_interval);
 806
 807     ofconn_set_rate_limit(ofconn, c->rate_limit, c->burst_limit);
 808 }
 809
 810 static void
 811 ofconn_run(struct ofconn *ofconn,
 812            void (*handle_openflow)(struct ofconn *, struct ofpbuf *ofp_msg))
 813 {
 814     struct connmgr *mgr = ofconn->connmgr;
 815     int iteration;
 816     size_t i;
 817
 818     for (i = 0; i < N_SCHEDULERS; i++) {
 819         pinsched_run(ofconn->schedulers[i], do_send_packet_in, ofconn);
 820     }
 821
 822     rconn_run(ofconn->rconn);
 823
 824     if (rconn_packet_counter_read (ofconn->reply_counter) < OFCONN_REPLY_MAX) {
 825         /* Limit the number of iterations to prevent other tasks from
 826          * starving. */
 827         for (iteration = 0; iteration < 50; iteration++) {
 828             struct ofpbuf *of_msg = rconn_recv(ofconn->rconn);
 829             if (!of_msg) {
 830                 break;
 831             }
 832             if (mgr->fail_open) {
 833                 fail_open_maybe_recover(mgr->fail_open);
 834             }
 835             handle_openflow(ofconn, of_msg);
 836             ofpbuf_delete(of_msg);
 837         }
 838     }
 839
 840     if (!rconn_is_alive(ofconn->rconn)) {
 841         ofconn_destroy(ofconn);
 842     }
 843 }
 844
 845 static void
 846 ofconn_wait(struct ofconn *ofconn)
 847 {
 848     int i;
 849
 850     for (i = 0; i < N_SCHEDULERS; i++) {
 851         pinsched_wait(ofconn->schedulers[i]);
 852     }
 853     rconn_run_wait(ofconn->rconn);
 854     if (rconn_packet_counter_read (ofconn->reply_counter) < OFCONN_REPLY_MAX) {
 855         rconn_recv_wait(ofconn->rconn);
 856     } else {
 857         COVERAGE_INC(ofconn_stuck);
 858     }
 859 }
 860
 861 /* Returns true if 'ofconn' should receive asynchronous messages. */
 862 static bool
 863 ofconn_receives_async_msgs(const struct ofconn *ofconn)
 864 {
 865     if (!rconn_is_connected(ofconn->rconn)) {
 866         return false;
 867     } else if (ofconn->type == OFCONN_PRIMARY) {
 868         /* Primary controllers always get asynchronous messages unless they
 869          * have configured themselves as "slaves".  */
 870         return ofconn->role != NX_ROLE_SLAVE;
 871     } else {
 872         /* Service connections don't get asynchronous messages unless they have
 873          * explicitly asked for them by setting a nonzero miss send length. */
 874         return ofconn->miss_send_len > 0;
 875     }
 876 }
 877
 878 /* Returns a human-readable name for an OpenFlow connection between 'mgr' and
 879  * 'target', suitable for use in log messages for identifying the connection.
 880  *
 881  * The name is dynamically allocated.  The caller should free it (with free())
 882  * when it is no longer needed. */
 883 static char *
 884 ofconn_make_name(const struct connmgr *mgr, const char *target)
 885 {
 886     return xasprintf("%s<->%s", mgr->name, target);
 887 }
 888
 889 static void
 890 ofconn_set_rate_limit(struct ofconn *ofconn, int rate, int burst)
 891 {
 892     int i;
 893
 894     for (i = 0; i < N_SCHEDULERS; i++) {
 895         struct pinsched **s = &ofconn->schedulers[i];
 896
 897         if (rate > 0) {
 898             if (!*s) {
 899                 *s = pinsched_create(rate, burst);
 900             } else {
 901                 pinsched_set_limits(*s, rate, burst);
 902             }
 903         } else {
 904             pinsched_destroy(*s);
 905             *s = NULL;
 906         }
 907     }
 908 }
 909
 910 static void
 911 ofconn_send(const struct ofconn *ofconn, struct ofpbuf *msg,
 912             struct rconn_packet_counter *counter)
 913 {
 914     update_openflow_length(msg);
 915     if (rconn_send(ofconn->rconn, msg, counter)) {
 916         ofpbuf_delete(msg);
 917     }
 918 }
 919 \f
 920 /* Sending asynchronous messages. */
 921
 922 static void schedule_packet_in(struct ofconn *, const struct dpif_upcall *,
 923                                const struct flow *, struct ofpbuf *rw_packet);
 924
 925 /* Sends an OFPT_PORT_STATUS message with 'opp' and 'reason' to appropriate
 926  * controllers managed by 'mgr'.
 927  *
 928  * 'opp' is in *HOST* byte order. */
 929 void
 930 connmgr_send_port_status(struct connmgr *mgr, const struct ofp_phy_port *opp,
 931                          uint8_t reason)
 932 {
 933     /* XXX Should limit the number of queued port status change messages. */
 934     struct ofconn *ofconn;
 935
 936     LIST_FOR_EACH (ofconn, node, &mgr->all_conns) {
 937         struct ofp_port_status *ops;
 938         struct ofpbuf *b;
 939
 940         /* Primary controllers, even slaves, should always get port status
 941            updates.  Otherwise obey ofconn_receives_async_msgs(). */
 942         if (ofconn->type != OFCONN_PRIMARY
 943             && !ofconn_receives_async_msgs(ofconn)) {
 944             continue;
 945         }
 946
 947         ops = make_openflow_xid(sizeof *ops, OFPT_PORT_STATUS, 0, &b);
 948         ops->reason = reason;
 949         ops->desc = *opp;
 950         hton_ofp_phy_port(&ops->desc);
 951         ofconn_send(ofconn, b, NULL);
 952     }
 953 }
 954
 955 /* Sends an OFPT_FLOW_REMOVED or NXT_FLOW_REMOVED message based on 'fr' to
 956  * appropriate controllers managed by 'mgr'. */
 957 void
 958 connmgr_send_flow_removed(struct connmgr *mgr,
 959                           const struct ofputil_flow_removed *fr)
 960 {
 961     struct ofconn *ofconn;
 962
 963     LIST_FOR_EACH (ofconn, node, &mgr->all_conns) {
 964         struct ofpbuf *msg;
 965
 966         if (!ofconn_receives_async_msgs(ofconn)) {
 967             continue;
 968         }
 969
 970         /* Account flow expirations as replies to OpenFlow requests.  That
 971          * works because preventing OpenFlow requests from being processed also
 972          * prevents new flows from being added (and expiring).  (It also
 973          * prevents processing OpenFlow requests that would not add new flows,
 974          * so it is imperfect.) */
 975         msg = ofputil_encode_flow_removed(fr, ofconn->flow_format);
 976         ofconn_send_reply(ofconn, msg);
 977     }
 978 }
 979
 980 /* Given 'upcall', of type DPIF_UC_ACTION or DPIF_UC_MISS, sends an
 981  * OFPT_PACKET_IN message to each OpenFlow controller as necessary according to
 982  * their individual configurations.
 983  *
 984  * 'rw_packet' may be NULL.  Otherwise, 'rw_packet' must contain the same data
 985  * as upcall->packet.  (rw_packet == upcall->packet is also valid.)  Ownership
 986  * of 'rw_packet' is transferred to this function. */
 987 void
 988 connmgr_send_packet_in(struct connmgr *mgr, const struct dpif_upcall *upcall,
 989                        const struct flow *flow, struct ofpbuf *rw_packet)
 990 {
 991     struct ofconn *ofconn, *prev;
 992
 993     prev = NULL;
 994     LIST_FOR_EACH (ofconn, node, &mgr->all_conns) {
 995         if (ofconn_receives_async_msgs(ofconn)) {
 996             if (prev) {
 997                 schedule_packet_in(prev, upcall, flow, NULL);
 998             }
 999             prev = ofconn;
1000         }
1001     }
1002     if (prev) {
1003         schedule_packet_in(prev, upcall, flow, rw_packet);
1004     } else {
1005         ofpbuf_delete(rw_packet);
1006     }
1007 }
1008
1009 /* pinsched callback for sending 'ofp_packet_in' on 'ofconn'. */
1010 static void
1011 do_send_packet_in(struct ofpbuf *ofp_packet_in, void *ofconn_)
1012 {
1013     struct ofconn *ofconn = ofconn_;
1014
1015     rconn_send_with_limit(ofconn->rconn, ofp_packet_in,
1016                           ofconn->packet_in_counter, 100);
1017 }
1018
1019 /* Takes 'upcall', whose packet has the flow specified by 'flow', composes an
1020  * OpenFlow packet-in message from it, and passes it to 'ofconn''s packet
1021  * scheduler for sending.
1022  *
1023  * 'rw_packet' may be NULL.  Otherwise, 'rw_packet' must contain the same data
1024  * as upcall->packet.  (rw_packet == upcall->packet is also valid.)  Ownership
1025  * of 'rw_packet' is transferred to this function. */
1026 static void
1027 schedule_packet_in(struct ofconn *ofconn, const struct dpif_upcall *upcall,
1028                    const struct flow *flow, struct ofpbuf *rw_packet)
1029 {
1030     struct connmgr *mgr = ofconn->connmgr;
1031     struct ofputil_packet_in pin;
1032
1033     /* Figure out the easy parts. */
1034     pin.packet = upcall->packet;
1035     pin.in_port = odp_port_to_ofp_port(flow->in_port);
1036     pin.reason = upcall->type == DPIF_UC_MISS ? OFPR_NO_MATCH : OFPR_ACTION;
1037
1038     /* Get OpenFlow buffer_id. */
1039     if (upcall->type == DPIF_UC_ACTION) {
1040         pin.buffer_id = UINT32_MAX;
1041     } else if (mgr->fail_open && fail_open_is_active(mgr->fail_open)) {
1042         pin.buffer_id = pktbuf_get_null();
1043     } else if (!ofconn->pktbuf) {
1044         pin.buffer_id = UINT32_MAX;
1045     } else {
1046         pin.buffer_id = pktbuf_save(ofconn->pktbuf, upcall->packet,
1047                                     flow->in_port);
1048     }
1049
1050     /* Figure out how much of the packet to send. */
1051     pin.send_len = upcall->packet->size;
1052     if (pin.buffer_id != UINT32_MAX) {
1053         pin.send_len = MIN(pin.send_len, ofconn->miss_send_len);
1054     }
1055     if (upcall->type == DPIF_UC_ACTION) {
1056         pin.send_len = MIN(pin.send_len, upcall->userdata);
1057     }
1058
1059     /* Make OFPT_PACKET_IN and hand over to packet scheduler.  It might
1060      * immediately call into do_send_packet_in() or it might buffer it for a
1061      * while (until a later call to pinsched_run()). */
1062     pinsched_send(ofconn->schedulers[upcall->type == DPIF_UC_MISS ? 0 : 1],
1063                   flow->in_port, ofputil_encode_packet_in(&pin, rw_packet),
1064                   do_send_packet_in, ofconn);
1065 }
1066 \f
1067 /* Fail-open settings. */
1068
1069 /* Returns the failure handling mode (OFPROTO_FAIL_SECURE or
1070  * OFPROTO_FAIL_STANDALONE) for 'mgr'. */
1071 enum ofproto_fail_mode
1072 connmgr_get_fail_mode(const struct connmgr *mgr)
1073 {
1074     return mgr->fail_mode;
1075 }
1076
1077 /* Sets the failure handling mode for 'mgr' to 'fail_mode' (either
1078  * OFPROTO_FAIL_SECURE or OFPROTO_FAIL_STANDALONE). */
1079 void
1080 connmgr_set_fail_mode(struct connmgr *mgr, enum ofproto_fail_mode fail_mode)
1081 {
1082     mgr->fail_mode = fail_mode;
1083     update_fail_open(mgr);
1084 }
1085 \f
1086 /* Fail-open implementation. */
1087
1088 /* Returns the longest probe interval among the primary controllers configured
1089  * on 'mgr'.  Returns 0 if there are no primary controllers. */
1090 int
1091 connmgr_get_max_probe_interval(const struct connmgr *mgr)
1092 {
1093     const struct ofconn *ofconn;
1094     int max_probe_interval;
1095
1096     max_probe_interval = 0;
1097     HMAP_FOR_EACH (ofconn, hmap_node, &mgr->controllers) {
1098         int probe_interval = rconn_get_probe_interval(ofconn->rconn);
1099         max_probe_interval = MAX(max_probe_interval, probe_interval);
1100     }
1101     return max_probe_interval;
1102 }
1103
1104 /* Returns the number of seconds for which all of 'mgr's primary controllers
1105  * have been disconnected.  Returns 0 if 'mgr' has no primary controllers. */
1106 int
1107 connmgr_failure_duration(const struct connmgr *mgr)
1108 {
1109     const struct ofconn *ofconn;
1110     int min_failure_duration;
1111
1112     if (!connmgr_has_controllers(mgr)) {
1113         return 0;
1114     }
1115
1116     min_failure_duration = INT_MAX;
1117     HMAP_FOR_EACH (ofconn, hmap_node, &mgr->controllers) {
1118         int failure_duration = rconn_failure_duration(ofconn->rconn);
1119         min_failure_duration = MIN(min_failure_duration, failure_duration);
1120     }
1121     return min_failure_duration;
1122 }
1123
1124 /* Returns true if at least one primary controller is connected (regardless of
1125  * whether those controllers are believed to have authenticated and accepted
1126  * this switch), false if none of them are connected. */
1127 bool
1128 connmgr_is_any_controller_connected(const struct connmgr *mgr)
1129 {
1130     const struct ofconn *ofconn;
1131
1132     HMAP_FOR_EACH (ofconn, hmap_node, &mgr->controllers) {
1133         if (rconn_is_connected(ofconn->rconn)) {
1134             return true;
1135         }
1136     }
1137     return false;
1138 }
1139
1140 /* Returns true if at least one primary controller is believed to have
1141  * authenticated and accepted this switch, false otherwise. */
1142 bool
1143 connmgr_is_any_controller_admitted(const struct connmgr *mgr)
1144 {
1145     const struct ofconn *ofconn;
1146
1147     HMAP_FOR_EACH (ofconn, hmap_node, &mgr->controllers) {
1148         if (rconn_is_admitted(ofconn->rconn)) {
1149             return true;
1150         }
1151     }
1152     return false;
1153 }
1154
1155 /* Sends 'packet' to each controller connected to 'mgr'.  Takes ownership of
1156  * 'packet'. */
1157 void
1158 connmgr_broadcast(struct connmgr *mgr, struct ofpbuf *packet)
1159 {
1160     struct ofconn *ofconn, *prev;
1161
1162     prev = NULL;
1163     LIST_FOR_EACH (ofconn, node, &mgr->all_conns) {
1164         if (prev) {
1165             ofconn_send_reply(ofconn, ofpbuf_clone(packet));
1166         }
1167         if (rconn_is_connected(ofconn->rconn)) {
1168             prev = ofconn;
1169         }
1170     }
1171     if (prev) {
1172         ofconn_send_reply(prev, packet);
1173     } else {
1174         ofpbuf_delete(packet);
1175     }
1176 }
1177 \f
1178 /* In-band configuration. */
1179
1180 static bool any_extras_changed(const struct connmgr *,
1181                                const struct sockaddr_in *extras, size_t n);
1182
1183 /* Sets the 'n' TCP port addresses in 'extras' as ones to which 'mgr''s
1184  * in-band control should guarantee access, in the same way that in-band
1185  * control guarantees access to OpenFlow controllers. */
1186 void
1187 connmgr_set_extra_in_band_remotes(struct connmgr *mgr,
1188                                   const struct sockaddr_in *extras, size_t n)
1189 {
1190     if (!any_extras_changed(mgr, extras, n)) {
1191         return;
1192     }
1193
1194     free(mgr->extra_in_band_remotes);
1195     mgr->n_extra_remotes = n;
1196     mgr->extra_in_band_remotes = xmemdup(extras, n * sizeof *extras);
1197
1198     update_in_band_remotes(mgr);
1199 }
1200
1201 /* Sets the OpenFlow queue used by flows set up by in-band control on
1202  * 'mgr' to 'queue_id'.  If 'queue_id' is negative, then in-band control
1203  * flows will use the default queue. */
1204 void
1205 connmgr_set_in_band_queue(struct connmgr *mgr, int queue_id)
1206 {
1207     if (queue_id != mgr->in_band_queue) {
1208         mgr->in_band_queue = queue_id;
1209         update_in_band_remotes(mgr);
1210     }
1211 }
1212
1213 static bool
1214 any_extras_changed(const struct connmgr *mgr,
1215                    const struct sockaddr_in *extras, size_t n)
1216 {
1217     size_t i;
1218
1219     if (n != mgr->n_extra_remotes) {
1220         return true;
1221     }
1222
1223     for (i = 0; i < n; i++) {
1224         const struct sockaddr_in *old = &mgr->extra_in_band_remotes[i];
1225         const struct sockaddr_in *new = &extras[i];
1226
1227         if (old->sin_addr.s_addr != new->sin_addr.s_addr ||
1228             old->sin_port != new->sin_port) {
1229             return true;
1230         }
1231     }
1232
1233     return false;
1234 }
1235 \f
1236 /* In-band implementation. */
1237
1238 bool
1239 connmgr_msg_in_hook(struct connmgr *mgr, const struct flow *flow,
1240                     const struct ofpbuf *packet)
1241 {
1242     return mgr->in_band && in_band_msg_in_hook(mgr->in_band, flow, packet);
1243 }
1244
1245 bool
1246 connmgr_may_set_up_flow(struct connmgr *mgr, const struct flow *flow,
1247                         const struct nlattr *odp_actions,
1248                         size_t actions_len)
1249 {
1250     return !mgr->in_band || in_band_rule_check(flow, odp_actions, actions_len);
1251 }
1252 \f
1253 /* Fail-open and in-band implementation. */
1254
1255 /* Called by 'ofproto' after all flows have been flushed, to allow fail-open
1256  * and in-band control to re-create their flows. */
1257 void
1258 connmgr_flushed(struct connmgr *mgr)
1259 {
1260     if (mgr->in_band) {
1261         in_band_flushed(mgr->in_band);
1262     }
1263     if (mgr->fail_open) {
1264         fail_open_flushed(mgr->fail_open);
1265     }
1266 }
1267 \f
1268 /* Creates a new ofservice for 'target' in 'mgr'.  Returns 0 if successful,
1269  * otherwise a positive errno value.
1270  *
1271  * ofservice_reconfigure() must be called to fully configure the new
1272  * ofservice. */
1273 static int
1274 ofservice_create(struct connmgr *mgr, const char *target)
1275 {
1276     struct ofservice *ofservice;
1277     struct pvconn *pvconn;
1278     int error;
1279
1280     error = pvconn_open(target, &pvconn);
1281     if (error) {
1282         return error;
1283     }
1284
1285     ofservice = xzalloc(sizeof *ofservice);
1286     hmap_insert(&mgr->services, &ofservice->node, hash_string(target, 0));
1287     ofservice->pvconn = pvconn;
1288
1289     return 0;
1290 }
1291
1292 static void
1293 ofservice_destroy(struct connmgr *mgr, struct ofservice *ofservice)
1294 {
1295     hmap_remove(&mgr->services, &ofservice->node);
1296     pvconn_close(ofservice->pvconn);
1297     free(ofservice);
1298 }
1299
1300 static void
1301 ofservice_reconfigure(struct ofservice *ofservice,
1302                       const struct ofproto_controller *c)
1303 {
1304     ofservice->probe_interval = c->probe_interval;
1305     ofservice->rate_limit = c->rate_limit;
1306     ofservice->burst_limit = c->burst_limit;
1307 }
1308
1309 /* Finds and returns the ofservice within 'mgr' that has the given
1310  * 'target', or a null pointer if none exists. */
1311 static struct ofservice *
1312 ofservice_lookup(struct connmgr *mgr, const char *target)
1313 {
1314     struct ofservice *ofservice;
1315
1316     HMAP_FOR_EACH_WITH_HASH (ofservice, node, hash_string(target, 0),
1317                              &mgr->services) {
1318         if (!strcmp(pvconn_get_name(ofservice->pvconn), target)) {
1319             return ofservice;
1320         }
1321     }
1322     return NULL;
1323 }