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