ofproto/connmgr.c

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