ofproto/connmgr.c

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