ofproto/connmgr.c

   1 /*
   2  * Copyright (c) 2009, 2010, 2011, 2012, 2013, 2014 Nicira, Inc.
   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 "dynamic-string.h"
  26 #include "fail-open.h"
  27 #include "in-band.h"
  28 #include "odp-util.h"
  29 #include "ofp-actions.h"
  30 #include "ofp-msgs.h"
  31 #include "ofp-util.h"
  32 #include "ofpbuf.h"
  33 #include "ofproto-provider.h"
  34 #include "pinsched.h"
  35 #include "poll-loop.h"
  36 #include "pktbuf.h"
  37 #include "rconn.h"
  38 #include "shash.h"
  39 #include "simap.h"
  40 #include "stream.h"
  41 #include "timeval.h"
  42 #include "vconn.h"
  43 #include "vlog.h"
  44
  45 #include "bundles.h"
  46
  47 VLOG_DEFINE_THIS_MODULE(connmgr);
  48 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
  49
  50 /* An OpenFlow connection.
  51  *
  52  *
  53  * Thread-safety
  54  * =============
  55  *
  56  * 'ofproto_mutex' must be held whenever an ofconn is created or destroyed or,
  57  * more or less equivalently, whenever an ofconn is added to or removed from a
  58  * connmgr.  'ofproto_mutex' doesn't protect the data inside the ofconn, except
  59  * as specifically noted below. */
  60 struct ofconn {
  61 /* Configuration that persists from one connection to the next. */
  62
  63     struct list node;           /* In struct connmgr's "all_conns" list. */
  64     struct hmap_node hmap_node; /* In struct connmgr's "controllers" map. */
  65
  66     struct connmgr *connmgr;    /* Connection's manager. */
  67     struct rconn *rconn;        /* OpenFlow connection. */
  68     enum ofconn_type type;      /* Type. */
  69     enum ofproto_band band;     /* In-band or out-of-band? */
  70     bool enable_async_msgs;     /* Initially enable async messages? */
  71
  72 /* State that should be cleared from one connection to the next. */
  73
  74     /* OpenFlow state. */
  75     enum ofp12_controller_role role;           /* Role. */
  76     enum ofputil_protocol protocol; /* Current protocol variant. */
  77     enum nx_packet_in_format packet_in_format; /* OFPT_PACKET_IN format. */
  78
  79     /* OFPT_PACKET_IN related data. */
  80     struct rconn_packet_counter *packet_in_counter; /* # queued on 'rconn'. */
  81 #define N_SCHEDULERS 2
  82     struct pinsched *schedulers[N_SCHEDULERS];
  83     struct pktbuf *pktbuf;         /* OpenFlow packet buffers. */
  84     int miss_send_len;             /* Bytes to send of buffered packets. */
  85     uint16_t controller_id;     /* Connection controller ID. */
  86
  87     /* Number of OpenFlow messages queued on 'rconn' as replies to OpenFlow
  88      * requests, and the maximum number before we stop reading OpenFlow
  89      * requests.  */
  90 #define OFCONN_REPLY_MAX 100
  91     struct rconn_packet_counter *reply_counter;
  92
  93     /* Asynchronous message configuration in each possible roles.
  94      *
  95      * A 1-bit enables sending an asynchronous message for one possible reason
  96      * that the message might be generated, a 0-bit disables it. */
  97     uint32_t master_async_config[OAM_N_TYPES]; /* master, other */
  98     uint32_t slave_async_config[OAM_N_TYPES];  /* slave */
  99
 100     /* Flow table operation logging. */
 101     int n_add, n_delete, n_modify; /* Number of unreported ops of each kind. */
 102     long long int first_op, last_op; /* Range of times for unreported ops. */
 103     long long int next_op_report;    /* Time to report ops, or LLONG_MAX. */
 104     long long int op_backoff;        /* Earliest time to report ops again. */
 105
 106 /* Flow monitors (e.g. NXST_FLOW_MONITOR). */
 107
 108     /* Configuration.  Contains "struct ofmonitor"s. */
 109     struct hmap monitors OVS_GUARDED_BY(ofproto_mutex);
 110
 111     /* Flow control.
 112      *
 113      * When too many flow monitor notifications back up in the transmit buffer,
 114      * we pause the transmission of further notifications.  These members track
 115      * the flow control state.
 116      *
 117      * When notifications are flowing, 'monitor_paused' is 0.  When
 118      * notifications are paused, 'monitor_paused' is the value of
 119      * 'monitor_seqno' at the point we paused.
 120      *
 121      * 'monitor_counter' counts the OpenFlow messages and bytes currently in
 122      * flight.  This value growing too large triggers pausing. */
 123     uint64_t monitor_paused OVS_GUARDED_BY(ofproto_mutex);
 124     struct rconn_packet_counter *monitor_counter OVS_GUARDED_BY(ofproto_mutex);
 125
 126     /* State of monitors for a single ongoing flow_mod.
 127      *
 128      * 'updates' is a list of "struct ofpbuf"s that contain
 129      * NXST_FLOW_MONITOR_REPLY messages representing the changes made by the
 130      * current flow_mod.
 131      *
 132      * When 'updates' is nonempty, 'sent_abbrev_update' is true if 'updates'
 133      * contains an update event of type NXFME_ABBREV and false otherwise.. */
 134     struct list updates OVS_GUARDED_BY(ofproto_mutex);
 135     bool sent_abbrev_update OVS_GUARDED_BY(ofproto_mutex);
 136
 137     /* Active bundles. Contains "struct ofp_bundle"s. */
 138     struct hmap bundles;
 139 };
 140
 141 static struct ofconn *ofconn_create(struct connmgr *, struct rconn *,
 142                                     enum ofconn_type, bool enable_async_msgs)
 143     OVS_REQUIRES(ofproto_mutex);
 144 static void ofconn_destroy(struct ofconn *) OVS_REQUIRES(ofproto_mutex);
 145 static void ofconn_flush(struct ofconn *) OVS_REQUIRES(ofproto_mutex);
 146
 147 static void ofconn_reconfigure(struct ofconn *,
 148                                const struct ofproto_controller *);
 149
 150 static void ofconn_run(struct ofconn *,
 151                        void (*handle_openflow)(struct ofconn *,
 152                                                const struct ofpbuf *ofp_msg));
 153 static void ofconn_wait(struct ofconn *);
 154
 155 static void ofconn_log_flow_mods(struct ofconn *);
 156
 157 static const char *ofconn_get_target(const struct ofconn *);
 158 static char *ofconn_make_name(const struct connmgr *, const char *target);
 159
 160 static void ofconn_set_rate_limit(struct ofconn *, int rate, int burst);
 161
 162 static void ofconn_send(const struct ofconn *, struct ofpbuf *,
 163                         struct rconn_packet_counter *);
 164
 165 static void do_send_packet_ins(struct ofconn *, struct list *txq);
 166
 167 /* A listener for incoming OpenFlow "service" connections. */
 168 struct ofservice {
 169     struct hmap_node node;      /* In struct connmgr's "services" hmap. */
 170     struct pvconn *pvconn;      /* OpenFlow connection listener. */
 171
 172     /* These are not used by ofservice directly.  They are settings for
 173      * accepted "struct ofconn"s from the pvconn. */
 174     int probe_interval;         /* Max idle time before probing, in seconds. */
 175     int rate_limit;             /* Max packet-in rate in packets per second. */
 176     int burst_limit;            /* Limit on accumulating packet credits. */
 177     bool enable_async_msgs;     /* Initially enable async messages? */
 178     uint8_t dscp;               /* DSCP Value for controller connection */
 179     uint32_t allowed_versions;  /* OpenFlow protocol versions that may
 180                                  * be negotiated for a session. */
 181 };
 182
 183 static void ofservice_reconfigure(struct ofservice *,
 184                                   const struct ofproto_controller *);
 185 static int ofservice_create(struct connmgr *mgr, const char *target,
 186                             uint32_t allowed_versions, uint8_t dscp);
 187 static void ofservice_destroy(struct connmgr *, struct ofservice *);
 188 static struct ofservice *ofservice_lookup(struct connmgr *,
 189                                           const char *target);
 190
 191 /* Connection manager for an OpenFlow switch. */
 192 struct connmgr {
 193     struct ofproto *ofproto;
 194     char *name;
 195     char *local_port_name;
 196
 197     /* OpenFlow connections. */
 198     struct hmap controllers;   /* All OFCONN_PRIMARY controllers. */
 199     struct list all_conns;     /* All controllers. */
 200     uint64_t master_election_id; /* monotonically increasing sequence number
 201                                   * for master election */
 202     bool master_election_id_defined;
 203
 204     /* OpenFlow listeners. */
 205     struct hmap services;       /* Contains "struct ofservice"s. */
 206     struct pvconn **snoops;
 207     size_t n_snoops;
 208
 209     /* Fail open. */
 210     struct fail_open *fail_open;
 211     enum ofproto_fail_mode fail_mode;
 212
 213     /* In-band control. */
 214     struct in_band *in_band;
 215     struct sockaddr_in *extra_in_band_remotes;
 216     size_t n_extra_remotes;
 217     int in_band_queue;
 218 };
 219
 220 static void update_in_band_remotes(struct connmgr *);
 221 static void add_snooper(struct connmgr *, struct vconn *);
 222 static void ofmonitor_run(struct connmgr *);
 223 static void ofmonitor_wait(struct connmgr *);
 224
 225 /* Creates and returns a new connection manager owned by 'ofproto'.  'name' is
 226  * a name for the ofproto suitable for using in log messages.
 227  * 'local_port_name' is the name of the local port (OFPP_LOCAL) within
 228  * 'ofproto'. */
 229 struct connmgr *
 230 connmgr_create(struct ofproto *ofproto,
 231                const char *name, const char *local_port_name)
 232 {
 233     struct connmgr *mgr;
 234
 235     mgr = xmalloc(sizeof *mgr);
 236     mgr->ofproto = ofproto;
 237     mgr->name = xstrdup(name);
 238     mgr->local_port_name = xstrdup(local_port_name);
 239
 240     hmap_init(&mgr->controllers);
 241     list_init(&mgr->all_conns);
 242     mgr->master_election_id = 0;
 243     mgr->master_election_id_defined = false;
 244
 245     hmap_init(&mgr->services);
 246     mgr->snoops = NULL;
 247     mgr->n_snoops = 0;
 248
 249     mgr->fail_open = NULL;
 250     mgr->fail_mode = OFPROTO_FAIL_SECURE;
 251
 252     mgr->in_band = NULL;
 253     mgr->extra_in_band_remotes = NULL;
 254     mgr->n_extra_remotes = 0;
 255     mgr->in_band_queue = -1;
 256
 257     return mgr;
 258 }
 259
 260 /* Frees 'mgr' and all of its resources. */
 261 void
 262 connmgr_destroy(struct connmgr *mgr)
 263 {
 264     struct ofservice *ofservice, *next_ofservice;
 265     struct ofconn *ofconn, *next_ofconn;
 266     size_t i;
 267
 268     if (!mgr) {
 269         return;
 270     }
 271
 272     ovs_mutex_lock(&ofproto_mutex);
 273     LIST_FOR_EACH_SAFE (ofconn, next_ofconn, node, &mgr->all_conns) {
 274         ofconn_destroy(ofconn);
 275     }
 276     ovs_mutex_unlock(&ofproto_mutex);
 277
 278     hmap_destroy(&mgr->controllers);
 279
 280     HMAP_FOR_EACH_SAFE (ofservice, next_ofservice, node, &mgr->services) {
 281         ofservice_destroy(mgr, ofservice);
 282     }
 283     hmap_destroy(&mgr->services);
 284
 285     for (i = 0; i < mgr->n_snoops; i++) {
 286         pvconn_close(mgr->snoops[i]);
 287     }
 288     free(mgr->snoops);
 289
 290     fail_open_destroy(mgr->fail_open);
 291     mgr->fail_open = NULL;
 292
 293     in_band_destroy(mgr->in_band);
 294     mgr->in_band = NULL;
 295     free(mgr->extra_in_band_remotes);
 296     free(mgr->name);
 297     free(mgr->local_port_name);
 298
 299     free(mgr);
 300 }
 301
 302 /* Does all of the periodic maintenance required by 'mgr'.  Calls
 303  * 'handle_openflow' for each message received on an OpenFlow connection,
 304  * passing along the OpenFlow connection itself and the message that was sent.
 305  * 'handle_openflow' must not modify or free the message. */
 306 void
 307 connmgr_run(struct connmgr *mgr,
 308             void (*handle_openflow)(struct ofconn *,
 309                                     const struct ofpbuf *ofp_msg))
 310     OVS_EXCLUDED(ofproto_mutex)
 311 {
 312     struct ofconn *ofconn, *next_ofconn;
 313     struct ofservice *ofservice;
 314     size_t i;
 315
 316     if (mgr->in_band) {
 317         if (!in_band_run(mgr->in_band)) {
 318             in_band_destroy(mgr->in_band);
 319             mgr->in_band = NULL;
 320         }
 321     }
 322
 323     LIST_FOR_EACH_SAFE (ofconn, next_ofconn, node, &mgr->all_conns) {
 324         ofconn_run(ofconn, handle_openflow);
 325     }
 326     ofmonitor_run(mgr);
 327
 328     /* Fail-open maintenance.  Do this after processing the ofconns since
 329      * fail-open checks the status of the controller rconn. */
 330     if (mgr->fail_open) {
 331         fail_open_run(mgr->fail_open);
 332     }
 333
 334     HMAP_FOR_EACH (ofservice, node, &mgr->services) {
 335         struct vconn *vconn;
 336         int retval;
 337
 338         retval = pvconn_accept(ofservice->pvconn, &vconn);
 339         if (!retval) {
 340             struct rconn *rconn;
 341             char *name;
 342
 343             /* Passing default value for creation of the rconn */
 344             rconn = rconn_create(ofservice->probe_interval, 0, ofservice->dscp,
 345                                  vconn_get_allowed_versions(vconn));
 346             name = ofconn_make_name(mgr, vconn_get_name(vconn));
 347             rconn_connect_unreliably(rconn, vconn, name);
 348             free(name);
 349
 350             ovs_mutex_lock(&ofproto_mutex);
 351             ofconn = ofconn_create(mgr, rconn, OFCONN_SERVICE,
 352                                    ofservice->enable_async_msgs);
 353             ovs_mutex_unlock(&ofproto_mutex);
 354
 355             ofconn_set_rate_limit(ofconn, ofservice->rate_limit,
 356                                   ofservice->burst_limit);
 357         } else if (retval != EAGAIN) {
 358             VLOG_WARN_RL(&rl, "accept failed (%s)", ovs_strerror(retval));
 359         }
 360     }
 361
 362     for (i = 0; i < mgr->n_snoops; i++) {
 363         struct vconn *vconn;
 364         int retval;
 365
 366         retval = pvconn_accept(mgr->snoops[i], &vconn);
 367         if (!retval) {
 368             add_snooper(mgr, vconn);
 369         } else if (retval != EAGAIN) {
 370             VLOG_WARN_RL(&rl, "accept failed (%s)", ovs_strerror(retval));
 371         }
 372     }
 373 }
 374
 375 /* Causes the poll loop to wake up when connmgr_run() needs to run. */
 376 void
 377 connmgr_wait(struct connmgr *mgr)
 378 {
 379     struct ofservice *ofservice;
 380     struct ofconn *ofconn;
 381     size_t i;
 382
 383     LIST_FOR_EACH (ofconn, node, &mgr->all_conns) {
 384         ofconn_wait(ofconn);
 385     }
 386     ofmonitor_wait(mgr);
 387     if (mgr->in_band) {
 388         in_band_wait(mgr->in_band);
 389     }
 390     if (mgr->fail_open) {
 391         fail_open_wait(mgr->fail_open);
 392     }
 393     HMAP_FOR_EACH (ofservice, node, &mgr->services) {
 394         pvconn_wait(ofservice->pvconn);
 395     }
 396     for (i = 0; i < mgr->n_snoops; i++) {
 397         pvconn_wait(mgr->snoops[i]);
 398     }
 399 }
 400
 401 /* Adds some memory usage statistics for 'mgr' into 'usage', for use with
 402  * memory_report(). */
 403 void
 404 connmgr_get_memory_usage(const struct connmgr *mgr, struct simap *usage)
 405 {
 406     const struct ofconn *ofconn;
 407     unsigned int packets = 0;
 408     unsigned int ofconns = 0;
 409
 410     LIST_FOR_EACH (ofconn, node, &mgr->all_conns) {
 411         int i;
 412
 413         ofconns++;
 414
 415         packets += rconn_count_txqlen(ofconn->rconn);
 416         for (i = 0; i < N_SCHEDULERS; i++) {
 417             struct pinsched_stats stats;
 418
 419             pinsched_get_stats(ofconn->schedulers[i], &stats);
 420             packets += stats.n_queued;;
 421         }
 422         packets += pktbuf_count_packets(ofconn->pktbuf);
 423     }
 424     simap_increase(usage, "ofconns", ofconns);
 425     simap_increase(usage, "packets", packets);
 426 }
 427
 428 /* Returns the ofproto that owns 'ofconn''s connmgr. */
 429 struct ofproto *
 430 ofconn_get_ofproto(const struct ofconn *ofconn)
 431 {
 432     return ofconn->connmgr->ofproto;
 433 }
 434 \f
 435 /* OpenFlow configuration. */
 436
 437 static void add_controller(struct connmgr *, const char *target, uint8_t dscp,
 438                            uint32_t allowed_versions)
 439     OVS_REQUIRES(ofproto_mutex);
 440 static struct ofconn *find_controller_by_target(struct connmgr *,
 441                                                 const char *target);
 442 static void update_fail_open(struct connmgr *) OVS_EXCLUDED(ofproto_mutex);
 443 static int set_pvconns(struct pvconn ***pvconnsp, size_t *n_pvconnsp,
 444                        const struct sset *);
 445
 446 /* Returns true if 'mgr' has any configured primary controllers.
 447  *
 448  * Service controllers do not count, but configured primary controllers do
 449  * count whether or not they are currently connected. */
 450 bool
 451 connmgr_has_controllers(const struct connmgr *mgr)
 452 {
 453     return !hmap_is_empty(&mgr->controllers);
 454 }
 455
 456 /* Initializes 'info' and populates it with information about each configured
 457  * primary controller.  The keys in 'info' are the controllers' targets; the
 458  * data values are corresponding "struct ofproto_controller_info".
 459  *
 460  * The caller owns 'info' and everything in it and should free it when it is no
 461  * longer needed. */
 462 void
 463 connmgr_get_controller_info(struct connmgr *mgr, struct shash *info)
 464 {
 465     const struct ofconn *ofconn;
 466
 467     HMAP_FOR_EACH (ofconn, hmap_node, &mgr->controllers) {
 468         const struct rconn *rconn = ofconn->rconn;
 469         const char *target = rconn_get_target(rconn);
 470
 471         if (!shash_find(info, target)) {
 472             struct ofproto_controller_info *cinfo = xmalloc(sizeof *cinfo);
 473             time_t now = time_now();
 474             time_t last_connection = rconn_get_last_connection(rconn);
 475             time_t last_disconnect = rconn_get_last_disconnect(rconn);
 476             int last_error = rconn_get_last_error(rconn);
 477             int i;
 478
 479             shash_add(info, target, cinfo);
 480
 481             cinfo->is_connected = rconn_is_connected(rconn);
 482             cinfo->role = ofconn->role;
 483
 484             smap_init(&cinfo->pairs);
 485             if (last_error) {
 486                 smap_add(&cinfo->pairs, "last_error",
 487                          ovs_retval_to_string(last_error));
 488             }
 489
 490             smap_add(&cinfo->pairs, "state", rconn_get_state(rconn));
 491
 492             if (last_connection != TIME_MIN) {
 493                 smap_add_format(&cinfo->pairs, "sec_since_connect",
 494                                 "%ld", (long int) (now - last_connection));
 495             }
 496
 497             if (last_disconnect != TIME_MIN) {
 498                 smap_add_format(&cinfo->pairs, "sec_since_disconnect",
 499                                 "%ld", (long int) (now - last_disconnect));
 500             }
 501
 502             for (i = 0; i < N_SCHEDULERS; i++) {
 503                 if (ofconn->schedulers[i]) {
 504                     const char *name = i ? "miss" : "action";
 505                     struct pinsched_stats stats;
 506
 507                     pinsched_get_stats(ofconn->schedulers[i], &stats);
 508                     smap_add_nocopy(&cinfo->pairs,
 509                                     xasprintf("packet-in-%s-backlog", name),
 510                                     xasprintf("%u", stats.n_queued));
 511                     smap_add_nocopy(&cinfo->pairs,
 512                                     xasprintf("packet-in-%s-bypassed", name),
 513                                     xasprintf("%llu", stats.n_normal));
 514                     smap_add_nocopy(&cinfo->pairs,
 515                                     xasprintf("packet-in-%s-queued", name),
 516                                     xasprintf("%llu", stats.n_limited));
 517                     smap_add_nocopy(&cinfo->pairs,
 518                                     xasprintf("packet-in-%s-dropped", name),
 519                                     xasprintf("%llu", stats.n_queue_dropped));
 520                 }
 521             }
 522         }
 523     }
 524 }
 525
 526 void
 527 connmgr_free_controller_info(struct shash *info)
 528 {
 529     struct shash_node *node;
 530
 531     SHASH_FOR_EACH (node, info) {
 532         struct ofproto_controller_info *cinfo = node->data;
 533         smap_destroy(&cinfo->pairs);
 534         free(cinfo);
 535     }
 536     shash_destroy(info);
 537 }
 538
 539 /* Changes 'mgr''s set of controllers to the 'n_controllers' controllers in
 540  * 'controllers'. */
 541 void
 542 connmgr_set_controllers(struct connmgr *mgr,
 543                         const struct ofproto_controller *controllers,
 544                         size_t n_controllers, uint32_t allowed_versions)
 545     OVS_EXCLUDED(ofproto_mutex)
 546 {
 547     bool had_controllers = connmgr_has_controllers(mgr);
 548     struct shash new_controllers;
 549     struct ofconn *ofconn, *next_ofconn;
 550     struct ofservice *ofservice, *next_ofservice;
 551     size_t i;
 552
 553     /* Required to add and remove ofconns.  This could probably be narrowed to
 554      * cover a smaller amount of code, if that yielded some benefit. */
 555     ovs_mutex_lock(&ofproto_mutex);
 556
 557     /* Create newly configured controllers and services.
 558      * Create a name to ofproto_controller mapping in 'new_controllers'. */
 559     shash_init(&new_controllers);
 560     for (i = 0; i < n_controllers; i++) {
 561         const struct ofproto_controller *c = &controllers[i];
 562
 563         if (!vconn_verify_name(c->target)) {
 564             bool add = false;
 565             ofconn = find_controller_by_target(mgr, c->target);
 566             if (!ofconn) {
 567                 VLOG_INFO("%s: added primary controller \"%s\"",
 568                           mgr->name, c->target);
 569                 add = true;
 570             } else if (rconn_get_allowed_versions(ofconn->rconn) !=
 571                        allowed_versions) {
 572                 VLOG_INFO("%s: re-added primary controller \"%s\"",
 573                           mgr->name, c->target);
 574                 add = true;
 575                 ofconn_destroy(ofconn);
 576             }
 577             if (add) {
 578                 add_controller(mgr, c->target, c->dscp, allowed_versions);
 579             }
 580         } else if (!pvconn_verify_name(c->target)) {
 581             bool add = false;
 582             ofservice = ofservice_lookup(mgr, c->target);
 583             if (!ofservice) {
 584                 VLOG_INFO("%s: added service controller \"%s\"",
 585                           mgr->name, c->target);
 586                 add = true;
 587             } else if (ofservice->allowed_versions != allowed_versions) {
 588                 VLOG_INFO("%s: re-added service controller \"%s\"",
 589                           mgr->name, c->target);
 590                 ofservice_destroy(mgr, ofservice);
 591                 add = true;
 592             }
 593             if (add) {
 594                 ofservice_create(mgr, c->target, allowed_versions, c->dscp);
 595             }
 596         } else {
 597             VLOG_WARN_RL(&rl, "%s: unsupported controller \"%s\"",
 598                          mgr->name, c->target);
 599             continue;
 600         }
 601
 602         shash_add_once(&new_controllers, c->target, &controllers[i]);
 603     }
 604
 605     /* Delete controllers that are no longer configured.
 606      * Update configuration of all now-existing controllers. */
 607     HMAP_FOR_EACH_SAFE (ofconn, next_ofconn, hmap_node, &mgr->controllers) {
 608         const char *target = ofconn_get_target(ofconn);
 609         struct ofproto_controller *c;
 610
 611         c = shash_find_data(&new_controllers, target);
 612         if (!c) {
 613             VLOG_INFO("%s: removed primary controller \"%s\"",
 614                       mgr->name, target);
 615             ofconn_destroy(ofconn);
 616         } else {
 617             ofconn_reconfigure(ofconn, c);
 618         }
 619     }
 620
 621     /* Delete services that are no longer configured.
 622      * Update configuration of all now-existing services. */
 623     HMAP_FOR_EACH_SAFE (ofservice, next_ofservice, node, &mgr->services) {
 624         const char *target = pvconn_get_name(ofservice->pvconn);
 625         struct ofproto_controller *c;
 626
 627         c = shash_find_data(&new_controllers, target);
 628         if (!c) {
 629             VLOG_INFO("%s: removed service controller \"%s\"",
 630                       mgr->name, target);
 631             ofservice_destroy(mgr, ofservice);
 632         } else {
 633             ofservice_reconfigure(ofservice, c);
 634         }
 635     }
 636
 637     shash_destroy(&new_controllers);
 638
 639     ovs_mutex_unlock(&ofproto_mutex);
 640
 641     update_in_band_remotes(mgr);
 642     update_fail_open(mgr);
 643     if (had_controllers != connmgr_has_controllers(mgr)) {
 644         ofproto_flush_flows(mgr->ofproto);
 645     }
 646 }
 647
 648 /* Drops the connections between 'mgr' and all of its primary and secondary
 649  * controllers, forcing them to reconnect. */
 650 void
 651 connmgr_reconnect(const struct connmgr *mgr)
 652 {
 653     struct ofconn *ofconn;
 654
 655     LIST_FOR_EACH (ofconn, node, &mgr->all_conns) {
 656         rconn_reconnect(ofconn->rconn);
 657     }
 658 }
 659
 660 /* Sets the "snoops" for 'mgr' to the pvconn targets listed in 'snoops'.
 661  *
 662  * A "snoop" is a pvconn to which every OpenFlow message to or from the most
 663  * important controller on 'mgr' is mirrored. */
 664 int
 665 connmgr_set_snoops(struct connmgr *mgr, const struct sset *snoops)
 666 {
 667     return set_pvconns(&mgr->snoops, &mgr->n_snoops, snoops);
 668 }
 669
 670 /* Adds each of the snoops currently configured on 'mgr' to 'snoops'. */
 671 void
 672 connmgr_get_snoops(const struct connmgr *mgr, struct sset *snoops)
 673 {
 674     size_t i;
 675
 676     for (i = 0; i < mgr->n_snoops; i++) {
 677         sset_add(snoops, pvconn_get_name(mgr->snoops[i]));
 678     }
 679 }
 680
 681 /* Returns true if 'mgr' has at least one snoop, false if it has none. */
 682 bool
 683 connmgr_has_snoops(const struct connmgr *mgr)
 684 {
 685     return mgr->n_snoops > 0;
 686 }
 687
 688 /* Creates a new controller for 'target' in 'mgr'.  update_controller() needs
 689  * to be called later to finish the new ofconn's configuration. */
 690 static void
 691 add_controller(struct connmgr *mgr, const char *target, uint8_t dscp,
 692                uint32_t allowed_versions)
 693     OVS_REQUIRES(ofproto_mutex)
 694 {
 695     char *name = ofconn_make_name(mgr, target);
 696     struct ofconn *ofconn;
 697
 698     ofconn = ofconn_create(mgr, rconn_create(5, 8, dscp, allowed_versions),
 699                            OFCONN_PRIMARY, true);
 700     ofconn->pktbuf = pktbuf_create();
 701     rconn_connect(ofconn->rconn, target, name);
 702     hmap_insert(&mgr->controllers, &ofconn->hmap_node, hash_string(target, 0));
 703
 704     free(name);
 705 }
 706
 707 static struct ofconn *
 708 find_controller_by_target(struct connmgr *mgr, const char *target)
 709 {
 710     struct ofconn *ofconn;
 711
 712     HMAP_FOR_EACH_WITH_HASH (ofconn, hmap_node,
 713                              hash_string(target, 0), &mgr->controllers) {
 714         if (!strcmp(ofconn_get_target(ofconn), target)) {
 715             return ofconn;
 716         }
 717     }
 718     return NULL;
 719 }
 720
 721 static void
 722 update_in_band_remotes(struct connmgr *mgr)
 723 {
 724     struct sockaddr_in *addrs;
 725     size_t max_addrs, n_addrs;
 726     struct ofconn *ofconn;
 727     size_t i;
 728
 729     /* Allocate enough memory for as many remotes as we could possibly have. */
 730     max_addrs = mgr->n_extra_remotes + hmap_count(&mgr->controllers);
 731     addrs = xmalloc(max_addrs * sizeof *addrs);
 732     n_addrs = 0;
 733
 734     /* Add all the remotes. */
 735     HMAP_FOR_EACH (ofconn, hmap_node, &mgr->controllers) {
 736         const char *target = rconn_get_target(ofconn->rconn);
 737         struct sockaddr_storage ss;
 738
 739         if (ofconn->band == OFPROTO_IN_BAND
 740             && stream_parse_target_with_default_port(target, OFP_OLD_PORT, &ss)
 741             && ss.ss_family == AF_INET) {
 742             addrs[n_addrs++] = *(struct sockaddr_in *) &ss;
 743         }
 744     }
 745     for (i = 0; i < mgr->n_extra_remotes; i++) {
 746         addrs[n_addrs++] = mgr->extra_in_band_remotes[i];
 747     }
 748
 749     /* Create or update or destroy in-band. */
 750     if (n_addrs) {
 751         if (!mgr->in_band) {
 752             in_band_create(mgr->ofproto, mgr->local_port_name, &mgr->in_band);
 753         }
 754         in_band_set_queue(mgr->in_band, mgr->in_band_queue);
 755     } else {
 756         /* in_band_run() needs a chance to delete any existing in-band flows.
 757          * We will destroy mgr->in_band after it's done with that. */
 758     }
 759     if (mgr->in_band) {
 760         in_band_set_remotes(mgr->in_band, addrs, n_addrs);
 761     }
 762
 763     /* Clean up. */
 764     free(addrs);
 765 }
 766
 767 static void
 768 update_fail_open(struct connmgr *mgr)
 769     OVS_EXCLUDED(ofproto_mutex)
 770 {
 771     if (connmgr_has_controllers(mgr)
 772         && mgr->fail_mode == OFPROTO_FAIL_STANDALONE) {
 773         if (!mgr->fail_open) {
 774             mgr->fail_open = fail_open_create(mgr->ofproto, mgr);
 775         }
 776     } else {
 777         fail_open_destroy(mgr->fail_open);
 778         mgr->fail_open = NULL;
 779     }
 780 }
 781
 782 static int
 783 set_pvconns(struct pvconn ***pvconnsp, size_t *n_pvconnsp,
 784             const struct sset *sset)
 785 {
 786     struct pvconn **pvconns = *pvconnsp;
 787     size_t n_pvconns = *n_pvconnsp;
 788     const char *name;
 789     int retval = 0;
 790     size_t i;
 791
 792     for (i = 0; i < n_pvconns; i++) {
 793         pvconn_close(pvconns[i]);
 794     }
 795     free(pvconns);
 796
 797     pvconns = xmalloc(sset_count(sset) * sizeof *pvconns);
 798     n_pvconns = 0;
 799     SSET_FOR_EACH (name, sset) {
 800         struct pvconn *pvconn;
 801         int error;
 802         error = pvconn_open(name, 0, 0, &pvconn);
 803         if (!error) {
 804             pvconns[n_pvconns++] = pvconn;
 805         } else {
 806             VLOG_ERR("failed to listen on %s: %s", name, ovs_strerror(error));
 807             if (!retval) {
 808                 retval = error;
 809             }
 810         }
 811     }
 812
 813     *pvconnsp = pvconns;
 814     *n_pvconnsp = n_pvconns;
 815
 816     return retval;
 817 }
 818
 819 /* Returns a "preference level" for snooping 'ofconn'.  A higher return value
 820  * means that 'ofconn' is more interesting for monitoring than a lower return
 821  * value. */
 822 static int
 823 snoop_preference(const struct ofconn *ofconn)
 824 {
 825     switch (ofconn->role) {
 826     case OFPCR12_ROLE_MASTER:
 827         return 3;
 828     case OFPCR12_ROLE_EQUAL:
 829         return 2;
 830     case OFPCR12_ROLE_SLAVE:
 831         return 1;
 832     case OFPCR12_ROLE_NOCHANGE:
 833     default:
 834         /* Shouldn't happen. */
 835         return 0;
 836     }
 837 }
 838
 839 /* One of 'mgr''s "snoop" pvconns has accepted a new connection on 'vconn'.
 840  * Connects this vconn to a controller. */
 841 static void
 842 add_snooper(struct connmgr *mgr, struct vconn *vconn)
 843 {
 844     struct ofconn *ofconn, *best;
 845
 846     /* Pick a controller for monitoring. */
 847     best = NULL;
 848     LIST_FOR_EACH (ofconn, node, &mgr->all_conns) {
 849         if (ofconn->type == OFCONN_PRIMARY
 850             && (!best || snoop_preference(ofconn) > snoop_preference(best))) {
 851             best = ofconn;
 852         }
 853     }
 854
 855     if (best) {
 856         rconn_add_monitor(best->rconn, vconn);
 857     } else {
 858         VLOG_INFO_RL(&rl, "no controller connection to snoop");
 859         vconn_close(vconn);
 860     }
 861 }
 862 \f
 863 /* Public ofconn functions. */
 864
 865 /* Returns the connection type, either OFCONN_PRIMARY or OFCONN_SERVICE. */
 866 enum ofconn_type
 867 ofconn_get_type(const struct ofconn *ofconn)
 868 {
 869     return ofconn->type;
 870 }
 871
 872 /* If a master election id is defined, stores it into '*idp' and returns
 873  * true.  Otherwise, stores UINT64_MAX into '*idp' and returns false. */
 874 bool
 875 ofconn_get_master_election_id(const struct ofconn *ofconn, uint64_t *idp)
 876 {
 877     *idp = (ofconn->connmgr->master_election_id_defined
 878             ? ofconn->connmgr->master_election_id
 879             : UINT64_MAX);
 880     return ofconn->connmgr->master_election_id_defined;
 881 }
 882
 883 /* Sets the master election id.
 884  *
 885  * Returns true if successful, false if the id is stale
 886  */
 887 bool
 888 ofconn_set_master_election_id(struct ofconn *ofconn, uint64_t id)
 889 {
 890     if (ofconn->connmgr->master_election_id_defined
 891         &&
 892         /* Unsigned difference interpreted as a two's complement signed
 893          * value */
 894         (int64_t)(id - ofconn->connmgr->master_election_id) < 0) {
 895         return false;
 896     }
 897     ofconn->connmgr->master_election_id = id;
 898     ofconn->connmgr->master_election_id_defined = true;
 899
 900     return true;
 901 }
 902
 903 /* Returns the role configured for 'ofconn'.
 904  *
 905  * The default role, if no other role has been set, is OFPCR12_ROLE_EQUAL. */
 906 enum ofp12_controller_role
 907 ofconn_get_role(const struct ofconn *ofconn)
 908 {
 909     return ofconn->role;
 910 }
 911
 912 void
 913 ofconn_send_role_status(struct ofconn *ofconn, uint32_t role, uint8_t reason)
 914 {
 915     struct ofputil_role_status status;
 916     struct ofpbuf *buf;
 917
 918     status.reason = reason;
 919     status.role = role;
 920     ofconn_get_master_election_id(ofconn, &status.generation_id);
 921
 922     buf = ofputil_encode_role_status(&status, ofconn_get_protocol(ofconn));
 923
 924     ofconn_send(ofconn, buf, NULL);
 925 }
 926
 927 /* Changes 'ofconn''s role to 'role'.  If 'role' is OFPCR12_ROLE_MASTER then
 928  * any existing master is demoted to a slave. */
 929 void
 930 ofconn_set_role(struct ofconn *ofconn, enum ofp12_controller_role role)
 931 {
 932     if (role != ofconn->role && role == OFPCR12_ROLE_MASTER) {
 933         struct ofconn *other;
 934
 935         LIST_FOR_EACH (other, node, &ofconn->connmgr->all_conns) {
 936             if (other->role == OFPCR12_ROLE_MASTER) {
 937                 other->role = OFPCR12_ROLE_SLAVE;
 938                 ofconn_send_role_status(other, OFPCR12_ROLE_SLAVE, OFPCRR_MASTER_REQUEST);
 939             }
 940         }
 941     }
 942     ofconn->role = role;
 943 }
 944
 945 void
 946 ofconn_set_invalid_ttl_to_controller(struct ofconn *ofconn, bool enable)
 947 {
 948     uint32_t bit = 1u << OFPR_INVALID_TTL;
 949     if (enable) {
 950         ofconn->master_async_config[OAM_PACKET_IN] |= bit;
 951     } else {
 952         ofconn->master_async_config[OAM_PACKET_IN] &= ~bit;
 953     }
 954 }
 955
 956 bool
 957 ofconn_get_invalid_ttl_to_controller(struct ofconn *ofconn)
 958 {
 959     uint32_t bit = 1u << OFPR_INVALID_TTL;
 960     return (ofconn->master_async_config[OAM_PACKET_IN] & bit) != 0;
 961 }
 962
 963 /* Returns the currently configured protocol for 'ofconn', one of OFPUTIL_P_*.
 964  *
 965  * Returns OFPUTIL_P_NONE, which is not a valid protocol, if 'ofconn' hasn't
 966  * completed version negotiation.  This can't happen if at least one OpenFlow
 967  * message, other than OFPT_HELLO, has been received on the connection (such as
 968  * in ofproto.c's message handling code), since version negotiation is a
 969  * prerequisite for starting to receive messages.  This means that
 970  * OFPUTIL_P_NONE is a special case that most callers need not worry about. */
 971 enum ofputil_protocol
 972 ofconn_get_protocol(const struct ofconn *ofconn)
 973 {
 974     if (ofconn->protocol == OFPUTIL_P_NONE &&
 975         rconn_is_connected(ofconn->rconn)) {
 976         int version = rconn_get_version(ofconn->rconn);
 977         if (version > 0) {
 978             ofconn_set_protocol(CONST_CAST(struct ofconn *, ofconn),
 979                                 ofputil_protocol_from_ofp_version(version));
 980         }
 981     }
 982
 983     return ofconn->protocol;
 984 }
 985
 986 /* Sets the protocol for 'ofconn' to 'protocol' (one of OFPUTIL_P_*).
 987  *
 988  * (This doesn't actually send anything to accomplish this.  Presumably the
 989  * caller already did that.) */
 990 void
 991 ofconn_set_protocol(struct ofconn *ofconn, enum ofputil_protocol protocol)
 992 {
 993     ofconn->protocol = protocol;
 994 }
 995
 996 /* Returns the currently configured packet in format for 'ofconn', one of
 997  * NXPIF_*.
 998  *
 999  * The default, if no other format has been set, is NXPIF_OPENFLOW10. */
1000 enum nx_packet_in_format
1001 ofconn_get_packet_in_format(struct ofconn *ofconn)
1002 {
1003     return ofconn->packet_in_format;
1004 }
1005
1006 /* Sets the packet in format for 'ofconn' to 'packet_in_format' (one of
1007  * NXPIF_*). */
1008 void
1009 ofconn_set_packet_in_format(struct ofconn *ofconn,
1010                             enum nx_packet_in_format packet_in_format)
1011 {
1012     ofconn->packet_in_format = packet_in_format;
1013 }
1014
1015 /* Sets the controller connection ID for 'ofconn' to 'controller_id'.
1016  *
1017  * The connection controller ID is used for OFPP_CONTROLLER and
1018  * NXAST_CONTROLLER actions.  See "struct nx_action_controller" for details. */
1019 void
1020 ofconn_set_controller_id(struct ofconn *ofconn, uint16_t controller_id)
1021 {
1022     ofconn->controller_id = controller_id;
1023 }
1024
1025 /* Returns the default miss send length for 'ofconn'. */
1026 int
1027 ofconn_get_miss_send_len(const struct ofconn *ofconn)
1028 {
1029     return ofconn->miss_send_len;
1030 }
1031
1032 /* Sets the default miss send length for 'ofconn' to 'miss_send_len'. */
1033 void
1034 ofconn_set_miss_send_len(struct ofconn *ofconn, int miss_send_len)
1035 {
1036     ofconn->miss_send_len = miss_send_len;
1037 }
1038
1039 void
1040 ofconn_set_async_config(struct ofconn *ofconn,
1041                         const uint32_t master_masks[OAM_N_TYPES],
1042                         const uint32_t slave_masks[OAM_N_TYPES])
1043 {
1044     size_t size = sizeof ofconn->master_async_config;
1045     memcpy(ofconn->master_async_config, master_masks, size);
1046     memcpy(ofconn->slave_async_config, slave_masks, size);
1047 }
1048
1049 void
1050 ofconn_get_async_config(struct ofconn *ofconn,
1051                         uint32_t *master_masks, uint32_t *slave_masks)
1052 {
1053     size_t size = sizeof ofconn->master_async_config;
1054     memcpy(master_masks, ofconn->master_async_config, size);
1055     memcpy(slave_masks, ofconn->slave_async_config, size);
1056 }
1057
1058 /* Sends 'msg' on 'ofconn', accounting it as a reply.  (If there is a
1059  * sufficient number of OpenFlow replies in-flight on a single ofconn, then the
1060  * connmgr will stop accepting new OpenFlow requests on that ofconn until the
1061  * controller has accepted some of the replies.) */
1062 void
1063 ofconn_send_reply(const struct ofconn *ofconn, struct ofpbuf *msg)
1064 {
1065     ofconn_send(ofconn, msg, ofconn->reply_counter);
1066 }
1067
1068 /* Sends each of the messages in list 'replies' on 'ofconn' in order,
1069  * accounting them as replies. */
1070 void
1071 ofconn_send_replies(const struct ofconn *ofconn, struct list *replies)
1072 {
1073     struct ofpbuf *reply, *next;
1074
1075     LIST_FOR_EACH_SAFE (reply, next, list_node, replies) {
1076         list_remove(&reply->list_node);
1077         ofconn_send_reply(ofconn, reply);
1078     }
1079 }
1080
1081 /* Sends 'error' on 'ofconn', as a reply to 'request'.  Only at most the
1082  * first 64 bytes of 'request' are used. */
1083 void
1084 ofconn_send_error(const struct ofconn *ofconn,
1085                   const struct ofp_header *request, enum ofperr error)
1086 {
1087     static struct vlog_rate_limit err_rl = VLOG_RATE_LIMIT_INIT(10, 10);
1088     struct ofpbuf *reply;
1089
1090     reply = ofperr_encode_reply(error, request);
1091     if (!VLOG_DROP_INFO(&err_rl)) {
1092         const char *type_name;
1093         size_t request_len;
1094         enum ofpraw raw;
1095
1096         request_len = ntohs(request->length);
1097         type_name = (!ofpraw_decode_partial(&raw, request,
1098                                             MIN(64, request_len))
1099                      ? ofpraw_get_name(raw)
1100                      : "invalid");
1101
1102         VLOG_INFO("%s: sending %s error reply to %s message",
1103                   rconn_get_name(ofconn->rconn), ofperr_to_string(error),
1104                   type_name);
1105     }
1106     ofconn_send_reply(ofconn, reply);
1107 }
1108
1109 /* Same as pktbuf_retrieve(), using the pktbuf owned by 'ofconn'. */
1110 enum ofperr
1111 ofconn_pktbuf_retrieve(struct ofconn *ofconn, uint32_t id,
1112                        struct ofpbuf **bufferp, ofp_port_t *in_port)
1113 {
1114     return pktbuf_retrieve(ofconn->pktbuf, id, bufferp, in_port);
1115 }
1116
1117 /* Reports that a flow_mod operation of the type specified by 'command' was
1118  * successfully executed by 'ofconn', so that the connmgr can log it. */
1119 void
1120 ofconn_report_flow_mod(struct ofconn *ofconn,
1121                        enum ofp_flow_mod_command command)
1122 {
1123     long long int now;
1124
1125     switch (command) {
1126     case OFPFC_ADD:
1127         ofconn->n_add++;
1128         break;
1129
1130     case OFPFC_MODIFY:
1131     case OFPFC_MODIFY_STRICT:
1132         ofconn->n_modify++;
1133         break;
1134
1135     case OFPFC_DELETE:
1136     case OFPFC_DELETE_STRICT:
1137         ofconn->n_delete++;
1138         break;
1139     }
1140
1141     now = time_msec();
1142     if (ofconn->next_op_report == LLONG_MAX) {
1143         ofconn->first_op = now;
1144         ofconn->next_op_report = MAX(now + 10 * 1000, ofconn->op_backoff);
1145         ofconn->op_backoff = ofconn->next_op_report + 60 * 1000;
1146     }
1147     ofconn->last_op = now;
1148 }
1149
1150 struct hmap *
1151 ofconn_get_bundles(struct ofconn *ofconn)
1152 {
1153     return &ofconn->bundles;
1154 }
1155
1156 \f
1157 /* Private ofconn functions. */
1158
1159 static const char *
1160 ofconn_get_target(const struct ofconn *ofconn)
1161 {
1162     return rconn_get_target(ofconn->rconn);
1163 }
1164
1165 static struct ofconn *
1166 ofconn_create(struct connmgr *mgr, struct rconn *rconn, enum ofconn_type type,
1167               bool enable_async_msgs)
1168 {
1169     struct ofconn *ofconn;
1170
1171     ofconn = xzalloc(sizeof *ofconn);
1172     ofconn->connmgr = mgr;
1173     list_push_back(&mgr->all_conns, &ofconn->node);
1174     ofconn->rconn = rconn;
1175     ofconn->type = type;
1176     ofconn->enable_async_msgs = enable_async_msgs;
1177
1178     hmap_init(&ofconn->monitors);
1179     list_init(&ofconn->updates);
1180
1181     hmap_init(&ofconn->bundles);
1182
1183     ofconn_flush(ofconn);
1184
1185     return ofconn;
1186 }
1187
1188 /* Clears all of the state in 'ofconn' that should not persist from one
1189  * connection to the next. */
1190 static void
1191 ofconn_flush(struct ofconn *ofconn)
1192     OVS_REQUIRES(ofproto_mutex)
1193 {
1194     struct ofmonitor *monitor, *next_monitor;
1195     int i;
1196
1197     ofconn_log_flow_mods(ofconn);
1198
1199     ofconn->role = OFPCR12_ROLE_EQUAL;
1200     ofconn_set_protocol(ofconn, OFPUTIL_P_NONE);
1201     ofconn->packet_in_format = NXPIF_OPENFLOW10;
1202
1203     rconn_packet_counter_destroy(ofconn->packet_in_counter);
1204     ofconn->packet_in_counter = rconn_packet_counter_create();
1205     for (i = 0; i < N_SCHEDULERS; i++) {
1206         if (ofconn->schedulers[i]) {
1207             int rate, burst;
1208
1209             pinsched_get_limits(ofconn->schedulers[i], &rate, &burst);
1210             pinsched_destroy(ofconn->schedulers[i]);
1211             ofconn->schedulers[i] = pinsched_create(rate, burst);
1212         }
1213     }
1214     if (ofconn->pktbuf) {
1215         pktbuf_destroy(ofconn->pktbuf);
1216         ofconn->pktbuf = pktbuf_create();
1217     }
1218     ofconn->miss_send_len = (ofconn->type == OFCONN_PRIMARY
1219                              ? OFP_DEFAULT_MISS_SEND_LEN
1220                              : 0);
1221     ofconn->controller_id = 0;
1222
1223     rconn_packet_counter_destroy(ofconn->reply_counter);
1224     ofconn->reply_counter = rconn_packet_counter_create();
1225
1226     if (ofconn->enable_async_msgs) {
1227         uint32_t *master = ofconn->master_async_config;
1228         uint32_t *slave = ofconn->slave_async_config;
1229
1230         /* "master" and "other" roles get all asynchronous messages by default,
1231          * except that the controller needs to enable nonstandard "packet-in"
1232          * reasons itself. */
1233         master[OAM_PACKET_IN] = (1u << OFPR_NO_MATCH) | (1u << OFPR_ACTION);
1234         master[OAM_PORT_STATUS] = ((1u << OFPPR_ADD)
1235                                    | (1u << OFPPR_DELETE)
1236                                    | (1u << OFPPR_MODIFY));
1237         master[OAM_FLOW_REMOVED] = ((1u << OFPRR_IDLE_TIMEOUT)
1238                                     | (1u << OFPRR_HARD_TIMEOUT)
1239                                     | (1u << OFPRR_DELETE));
1240
1241         /* "slave" role gets port status updates by default. */
1242         slave[OAM_PACKET_IN] = 0;
1243         slave[OAM_PORT_STATUS] = ((1u << OFPPR_ADD)
1244                                   | (1u << OFPPR_DELETE)
1245                                   | (1u << OFPPR_MODIFY));
1246         slave[OAM_FLOW_REMOVED] = 0;
1247     } else {
1248         memset(ofconn->master_async_config, 0,
1249                sizeof ofconn->master_async_config);
1250         memset(ofconn->slave_async_config, 0,
1251                sizeof ofconn->slave_async_config);
1252     }
1253
1254     ofconn->n_add = ofconn->n_delete = ofconn->n_modify = 0;
1255     ofconn->first_op = ofconn->last_op = LLONG_MIN;
1256     ofconn->next_op_report = LLONG_MAX;
1257     ofconn->op_backoff = LLONG_MIN;
1258
1259     HMAP_FOR_EACH_SAFE (monitor, next_monitor, ofconn_node,
1260                         &ofconn->monitors) {
1261         ofmonitor_destroy(monitor);
1262     }
1263     rconn_packet_counter_destroy(ofconn->monitor_counter);
1264     ofconn->monitor_counter = rconn_packet_counter_create();
1265     ofpbuf_list_delete(&ofconn->updates); /* ...but it should be empty. */
1266 }
1267
1268 static void
1269 ofconn_destroy(struct ofconn *ofconn)
1270     OVS_REQUIRES(ofproto_mutex)
1271 {
1272     ofconn_flush(ofconn);
1273
1274     if (ofconn->type == OFCONN_PRIMARY) {
1275         hmap_remove(&ofconn->connmgr->controllers, &ofconn->hmap_node);
1276     }
1277
1278     ofp_bundle_remove_all(ofconn);
1279
1280     hmap_destroy(&ofconn->monitors);
1281     list_remove(&ofconn->node);
1282     rconn_destroy(ofconn->rconn);
1283     rconn_packet_counter_destroy(ofconn->packet_in_counter);
1284     rconn_packet_counter_destroy(ofconn->reply_counter);
1285     pktbuf_destroy(ofconn->pktbuf);
1286     rconn_packet_counter_destroy(ofconn->monitor_counter);
1287     free(ofconn);
1288 }
1289
1290 /* Reconfigures 'ofconn' to match 'c'.  'ofconn' and 'c' must have the same
1291  * target. */
1292 static void
1293 ofconn_reconfigure(struct ofconn *ofconn, const struct ofproto_controller *c)
1294 {
1295     int probe_interval;
1296
1297     ofconn->band = c->band;
1298     ofconn->enable_async_msgs = c->enable_async_msgs;
1299
1300     rconn_set_max_backoff(ofconn->rconn, c->max_backoff);
1301
1302     probe_interval = c->probe_interval ? MAX(c->probe_interval, 5) : 0;
1303     rconn_set_probe_interval(ofconn->rconn, probe_interval);
1304
1305     ofconn_set_rate_limit(ofconn, c->rate_limit, c->burst_limit);
1306
1307     /* If dscp value changed reconnect. */
1308     if (c->dscp != rconn_get_dscp(ofconn->rconn)) {
1309         rconn_set_dscp(ofconn->rconn, c->dscp);
1310         rconn_reconnect(ofconn->rconn);
1311     }
1312 }
1313
1314 /* Returns true if it makes sense for 'ofconn' to receive and process OpenFlow
1315  * messages. */
1316 static bool
1317 ofconn_may_recv(const struct ofconn *ofconn)
1318 {
1319     int count = rconn_packet_counter_n_packets(ofconn->reply_counter);
1320     return count < OFCONN_REPLY_MAX;
1321 }
1322
1323 static void
1324 ofconn_run(struct ofconn *ofconn,
1325            void (*handle_openflow)(struct ofconn *,
1326                                    const struct ofpbuf *ofp_msg))
1327 {
1328     struct connmgr *mgr = ofconn->connmgr;
1329     size_t i;
1330
1331     for (i = 0; i < N_SCHEDULERS; i++) {
1332         struct list txq;
1333
1334         pinsched_run(ofconn->schedulers[i], &txq);
1335         do_send_packet_ins(ofconn, &txq);
1336     }
1337
1338     rconn_run(ofconn->rconn);
1339
1340     /* Limit the number of iterations to avoid starving other tasks. */
1341     for (i = 0; i < 50 && ofconn_may_recv(ofconn); i++) {
1342         struct ofpbuf *of_msg = rconn_recv(ofconn->rconn);
1343         if (!of_msg) {
1344             break;
1345         }
1346
1347         if (mgr->fail_open) {
1348             fail_open_maybe_recover(mgr->fail_open);
1349         }
1350
1351         handle_openflow(ofconn, of_msg);
1352         ofpbuf_delete(of_msg);
1353     }
1354
1355     if (time_msec() >= ofconn->next_op_report) {
1356         ofconn_log_flow_mods(ofconn);
1357     }
1358
1359     ovs_mutex_lock(&ofproto_mutex);
1360     if (!rconn_is_alive(ofconn->rconn)) {
1361         ofconn_destroy(ofconn);
1362     } else if (!rconn_is_connected(ofconn->rconn)) {
1363         ofconn_flush(ofconn);
1364     }
1365     ovs_mutex_unlock(&ofproto_mutex);
1366 }
1367
1368 static void
1369 ofconn_wait(struct ofconn *ofconn)
1370 {
1371     int i;
1372
1373     for (i = 0; i < N_SCHEDULERS; i++) {
1374         pinsched_wait(ofconn->schedulers[i]);
1375     }
1376     rconn_run_wait(ofconn->rconn);
1377     if (ofconn_may_recv(ofconn)) {
1378         rconn_recv_wait(ofconn->rconn);
1379     }
1380     if (ofconn->next_op_report != LLONG_MAX) {
1381         poll_timer_wait_until(ofconn->next_op_report);
1382     }
1383 }
1384
1385 static void
1386 ofconn_log_flow_mods(struct ofconn *ofconn)
1387 {
1388     int n_flow_mods = ofconn->n_add + ofconn->n_delete + ofconn->n_modify;
1389     if (n_flow_mods) {
1390         long long int ago = (time_msec() - ofconn->first_op) / 1000;
1391         long long int interval = (ofconn->last_op - ofconn->first_op) / 1000;
1392         struct ds s;
1393
1394         ds_init(&s);
1395         ds_put_format(&s, "%d flow_mods ", n_flow_mods);
1396         if (interval == ago) {
1397             ds_put_format(&s, "in the last %lld s", ago);
1398         } else if (interval) {
1399             ds_put_format(&s, "in the %lld s starting %lld s ago",
1400                           interval, ago);
1401         } else {
1402             ds_put_format(&s, "%lld s ago", ago);
1403         }
1404
1405         ds_put_cstr(&s, " (");
1406         if (ofconn->n_add) {
1407             ds_put_format(&s, "%d adds, ", ofconn->n_add);
1408         }
1409         if (ofconn->n_delete) {
1410             ds_put_format(&s, "%d deletes, ", ofconn->n_delete);
1411         }
1412         if (ofconn->n_modify) {
1413             ds_put_format(&s, "%d modifications, ", ofconn->n_modify);
1414         }
1415         s.length -= 2;
1416         ds_put_char(&s, ')');
1417
1418         VLOG_INFO("%s: %s", rconn_get_name(ofconn->rconn), ds_cstr(&s));
1419         ds_destroy(&s);
1420
1421         ofconn->n_add = ofconn->n_delete = ofconn->n_modify = 0;
1422     }
1423     ofconn->next_op_report = LLONG_MAX;
1424 }
1425
1426 /* Returns true if 'ofconn' should receive asynchronous messages of the given
1427  * OAM_* 'type' and 'reason', which should be a OFPR_* value for OAM_PACKET_IN,
1428  * a OFPPR_* value for OAM_PORT_STATUS, or an OFPRR_* value for
1429  * OAM_FLOW_REMOVED.  Returns false if the message should not be sent on
1430  * 'ofconn'. */
1431 static bool
1432 ofconn_receives_async_msg(const struct ofconn *ofconn,
1433                           enum ofconn_async_msg_type type,
1434                           unsigned int reason)
1435 {
1436     const uint32_t *async_config;
1437
1438     ovs_assert(reason < 32);
1439     ovs_assert((unsigned int) type < OAM_N_TYPES);
1440
1441     if (ofconn_get_protocol(ofconn) == OFPUTIL_P_NONE
1442         || !rconn_is_connected(ofconn->rconn)) {
1443         return false;
1444     }
1445
1446     /* Keep the following code in sync with the documentation in the
1447      * "Asynchronous Messages" section in DESIGN. */
1448
1449     if (ofconn->type == OFCONN_SERVICE && !ofconn->miss_send_len) {
1450         /* Service connections don't get asynchronous messages unless they have
1451          * explicitly asked for them by setting a nonzero miss send length. */
1452         return false;
1453     }
1454
1455     async_config = (ofconn->role == OFPCR12_ROLE_SLAVE
1456                     ? ofconn->slave_async_config
1457                     : ofconn->master_async_config);
1458     if (!(async_config[type] & (1u << reason))) {
1459         return false;
1460     }
1461
1462     return true;
1463 }
1464
1465 /* The default "table-miss" behaviour for OpenFlow1.3+ is to drop the
1466  * packet rather than to send the packet to the controller.
1467  *
1468  * This function returns false to indicate the packet should be dropped if
1469  * the controller action was the result of the default table-miss behaviour
1470  * and the controller is using OpenFlow1.3+.
1471  *
1472  * Otherwise true is returned to indicate the packet should be forwarded to
1473  * the controller */
1474 static bool
1475 ofconn_wants_packet_in_on_miss(struct ofconn *ofconn,
1476                                const struct ofproto_packet_in *pin)
1477 {
1478     if (pin->miss_type == OFPROTO_PACKET_IN_MISS_WITHOUT_FLOW) {
1479         enum ofputil_protocol protocol = ofconn_get_protocol(ofconn);
1480
1481         if (protocol != OFPUTIL_P_NONE
1482             && ofputil_protocol_to_ofp_version(protocol) >= OFP13_VERSION) {
1483             enum ofproto_table_config config;
1484
1485             config = ofproto_table_get_config(ofconn->connmgr->ofproto,
1486                                               pin->up.table_id);
1487             if (config == OFPROTO_TABLE_MISS_DEFAULT) {
1488                 return false;
1489             }
1490         }
1491     }
1492     return true;
1493 }
1494
1495 /* The default "table-miss" behaviour for OpenFlow1.3+ is to drop the
1496  * packet rather than to send the packet to the controller.
1497  *
1498  * This function returns false to indicate that a packet_in message
1499  * for a "table-miss" should be sent to at least one controller.
1500  * That is there is at least one controller with controller_id 0
1501  * which connected using an OpenFlow version earlier than OpenFlow1.3.
1502  *
1503  * False otherwise.
1504  *
1505  * This logic assumes that "table-miss" packet_in messages
1506  * are always sent to controller_id 0. */
1507 bool
1508 connmgr_wants_packet_in_on_miss(struct connmgr *mgr)
1509 {
1510     struct ofconn *ofconn;
1511
1512     LIST_FOR_EACH (ofconn, node, &mgr->all_conns) {
1513         enum ofputil_protocol protocol = ofconn_get_protocol(ofconn);
1514
1515         if (ofconn->controller_id == 0 &&
1516             (protocol == OFPUTIL_P_NONE ||
1517              ofputil_protocol_to_ofp_version(protocol) < OFP13_VERSION)) {
1518             return true;
1519         }
1520     }
1521     return false;
1522 }
1523
1524 /* Returns a human-readable name for an OpenFlow connection between 'mgr' and
1525  * 'target', suitable for use in log messages for identifying the connection.
1526  *
1527  * The name is dynamically allocated.  The caller should free it (with free())
1528  * when it is no longer needed. */
1529 static char *
1530 ofconn_make_name(const struct connmgr *mgr, const char *target)
1531 {
1532     return xasprintf("%s<->%s", mgr->name, target);
1533 }
1534
1535 static void
1536 ofconn_set_rate_limit(struct ofconn *ofconn, int rate, int burst)
1537 {
1538     int i;
1539
1540     for (i = 0; i < N_SCHEDULERS; i++) {
1541         struct pinsched **s = &ofconn->schedulers[i];
1542
1543         if (rate > 0) {
1544             if (!*s) {
1545                 *s = pinsched_create(rate, burst);
1546             } else {
1547                 pinsched_set_limits(*s, rate, burst);
1548             }
1549         } else {
1550             pinsched_destroy(*s);
1551             *s = NULL;
1552         }
1553     }
1554 }
1555
1556 static void
1557 ofconn_send(const struct ofconn *ofconn, struct ofpbuf *msg,
1558             struct rconn_packet_counter *counter)
1559 {
1560     ofpmsg_update_length(msg);
1561     rconn_send(ofconn->rconn, msg, counter);
1562 }
1563 \f
1564 /* Sending asynchronous messages. */
1565
1566 static void schedule_packet_in(struct ofconn *, struct ofproto_packet_in,
1567                                enum ofp_packet_in_reason wire_reason);
1568
1569 /* Sends an OFPT_PORT_STATUS message with 'opp' and 'reason' to appropriate
1570  * controllers managed by 'mgr'.  For messages caused by a controller
1571  * OFPT_PORT_MOD, specify 'source' as the controller connection that sent the
1572  * request; otherwise, specify 'source' as NULL. */
1573 void
1574 connmgr_send_port_status(struct connmgr *mgr, struct ofconn *source,
1575                          const struct ofputil_phy_port *pp, uint8_t reason)
1576 {
1577     /* XXX Should limit the number of queued port status change messages. */
1578     struct ofputil_port_status ps;
1579     struct ofconn *ofconn;
1580
1581     ps.reason = reason;
1582     ps.desc = *pp;
1583     LIST_FOR_EACH (ofconn, node, &mgr->all_conns) {
1584         if (ofconn_receives_async_msg(ofconn, OAM_PORT_STATUS, reason)) {
1585             struct ofpbuf *msg;
1586
1587             /* Before 1.5, OpenFlow specified that OFPT_PORT_MOD should not
1588              * generate OFPT_PORT_STATUS messages.  That requirement was a
1589              * relic of how OpenFlow originally supported a single controller,
1590              * so that one could expect the controller to already know the
1591              * changes it had made.
1592              *
1593              * EXT-338 changes OpenFlow 1.5 OFPT_PORT_MOD to send
1594              * OFPT_PORT_STATUS messages to every controller.  This is
1595              * obviously more useful in the multi-controller case.  We could
1596              * always implement it that way in OVS, but that would risk
1597              * confusing controllers that are intended for single-controller
1598              * use only.  (Imagine a controller that generates an OFPT_PORT_MOD
1599              * in response to any OFPT_PORT_STATUS!)
1600              *
1601              * So this compromises: for OpenFlow 1.4 and earlier, it generates
1602              * OFPT_PORT_STATUS for OFPT_PORT_MOD, but not back to the
1603              * originating controller.  In a single-controller environment, in
1604              * particular, this means that it will never generate
1605              * OFPT_PORT_STATUS for OFPT_PORT_MOD at all. */
1606             if (ofconn == source
1607                 && rconn_get_version(ofconn->rconn) < OFP15_VERSION) {
1608                 continue;
1609             }
1610
1611             msg = ofputil_encode_port_status(&ps, ofconn_get_protocol(ofconn));
1612             ofconn_send(ofconn, msg, NULL);
1613         }
1614     }
1615 }
1616
1617 /* Sends an OFPT_FLOW_REMOVED or NXT_FLOW_REMOVED message based on 'fr' to
1618  * appropriate controllers managed by 'mgr'. */
1619 void
1620 connmgr_send_flow_removed(struct connmgr *mgr,
1621                           const struct ofputil_flow_removed *fr)
1622 {
1623     struct ofconn *ofconn;
1624
1625     LIST_FOR_EACH (ofconn, node, &mgr->all_conns) {
1626         if (ofconn_receives_async_msg(ofconn, OAM_FLOW_REMOVED, fr->reason)) {
1627             struct ofpbuf *msg;
1628
1629             /* Account flow expirations as replies to OpenFlow requests.  That
1630              * works because preventing OpenFlow requests from being processed
1631              * also prevents new flows from being added (and expiring).  (It
1632              * also prevents processing OpenFlow requests that would not add
1633              * new flows, so it is imperfect.) */
1634             msg = ofputil_encode_flow_removed(fr, ofconn_get_protocol(ofconn));
1635             ofconn_send_reply(ofconn, msg);
1636         }
1637     }
1638 }
1639
1640 /* Normally a send-to-controller action uses reason OFPR_ACTION.  However, in
1641  * OpenFlow 1.3 and later, packet_ins generated by a send-to-controller action
1642  * in a "table-miss" flow (one with priority 0 and completely wildcarded) are
1643  * sent as OFPR_NO_MATCH.  This function returns the reason that should
1644  * actually be sent on 'ofconn' for 'pin'. */
1645 static enum ofp_packet_in_reason
1646 wire_reason(struct ofconn *ofconn, const struct ofproto_packet_in *pin)
1647 {
1648     if (pin->miss_type == OFPROTO_PACKET_IN_MISS_FLOW
1649         && pin->up.reason == OFPR_ACTION) {
1650         enum ofputil_protocol protocol = ofconn_get_protocol(ofconn);
1651
1652         if (protocol != OFPUTIL_P_NONE
1653             && ofputil_protocol_to_ofp_version(protocol) >= OFP13_VERSION) {
1654             return OFPR_NO_MATCH;
1655         }
1656     }
1657     return pin->up.reason;
1658 }
1659
1660 /* Given 'pin', sends an OFPT_PACKET_IN message to each OpenFlow controller as
1661  * necessary according to their individual configurations.
1662  *
1663  * The caller doesn't need to fill in pin->buffer_id or pin->total_len. */
1664 void
1665 connmgr_send_packet_in(struct connmgr *mgr,
1666                        const struct ofproto_packet_in *pin)
1667 {
1668     struct ofconn *ofconn;
1669
1670     LIST_FOR_EACH (ofconn, node, &mgr->all_conns) {
1671         enum ofp_packet_in_reason reason = wire_reason(ofconn, pin);
1672
1673         if (ofconn_wants_packet_in_on_miss(ofconn, pin)
1674             && ofconn_receives_async_msg(ofconn, OAM_PACKET_IN, pin->up.reason)
1675             && ofconn->controller_id == pin->controller_id) {
1676             schedule_packet_in(ofconn, *pin, reason);
1677         }
1678     }
1679 }
1680
1681 static void
1682 do_send_packet_ins(struct ofconn *ofconn, struct list *txq)
1683 {
1684     struct ofpbuf *pin, *next_pin;
1685
1686     LIST_FOR_EACH_SAFE (pin, next_pin, list_node, txq) {
1687         list_remove(&pin->list_node);
1688
1689         if (rconn_send_with_limit(ofconn->rconn, pin,
1690                                   ofconn->packet_in_counter, 100) == EAGAIN) {
1691             static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 5);
1692
1693             VLOG_INFO_RL(&rl, "%s: dropping packet-in due to queue overflow",
1694                          rconn_get_name(ofconn->rconn));
1695         }
1696     }
1697 }
1698
1699 /* Takes 'pin', composes an OpenFlow packet-in message from it, and passes it
1700  * to 'ofconn''s packet scheduler for sending. */
1701 static void
1702 schedule_packet_in(struct ofconn *ofconn, struct ofproto_packet_in pin,
1703                    enum ofp_packet_in_reason wire_reason)
1704 {
1705     struct connmgr *mgr = ofconn->connmgr;
1706     uint16_t controller_max_len;
1707     struct list txq;
1708
1709     pin.up.total_len = pin.up.packet_len;
1710
1711     pin.up.reason = wire_reason;
1712     if (pin.up.reason == OFPR_ACTION) {
1713         controller_max_len = pin.send_len;  /* max_len */
1714     } else {
1715         controller_max_len = ofconn->miss_send_len;
1716     }
1717
1718     /* Get OpenFlow buffer_id.
1719      * For OpenFlow 1.2+, OFPCML_NO_BUFFER (== UINT16_MAX) specifies
1720      * unbuffered.  This behaviour doesn't violate prior versions, too. */
1721     if (controller_max_len == UINT16_MAX) {
1722         pin.up.buffer_id = UINT32_MAX;
1723     } else if (mgr->fail_open && fail_open_is_active(mgr->fail_open)) {
1724         pin.up.buffer_id = pktbuf_get_null();
1725     } else if (!ofconn->pktbuf) {
1726         pin.up.buffer_id = UINT32_MAX;
1727     } else {
1728         pin.up.buffer_id = pktbuf_save(ofconn->pktbuf,
1729                                        pin.up.packet, pin.up.packet_len,
1730                                        pin.up.fmd.in_port);
1731     }
1732
1733     /* Figure out how much of the packet to send.
1734      * If not buffered, send the entire packet.  Otherwise, depending on
1735      * the reason of packet-in, send what requested by the controller. */
1736     if (pin.up.buffer_id != UINT32_MAX
1737         && controller_max_len < pin.up.packet_len) {
1738         pin.up.packet_len = controller_max_len;
1739     }
1740
1741     /* Make OFPT_PACKET_IN and hand over to packet scheduler. */
1742     pinsched_send(ofconn->schedulers[pin.up.reason == OFPR_NO_MATCH ? 0 : 1],
1743                   pin.up.fmd.in_port,
1744                   ofputil_encode_packet_in(&pin.up,
1745                                            ofconn_get_protocol(ofconn),
1746                                            ofconn->packet_in_format),
1747                   &txq);
1748     do_send_packet_ins(ofconn, &txq);
1749 }
1750 \f
1751 /* Fail-open settings. */
1752
1753 /* Returns the failure handling mode (OFPROTO_FAIL_SECURE or
1754  * OFPROTO_FAIL_STANDALONE) for 'mgr'. */
1755 enum ofproto_fail_mode
1756 connmgr_get_fail_mode(const struct connmgr *mgr)
1757 {
1758     return mgr->fail_mode;
1759 }
1760
1761 /* Sets the failure handling mode for 'mgr' to 'fail_mode' (either
1762  * OFPROTO_FAIL_SECURE or OFPROTO_FAIL_STANDALONE). */
1763 void
1764 connmgr_set_fail_mode(struct connmgr *mgr, enum ofproto_fail_mode fail_mode)
1765 {
1766     if (mgr->fail_mode != fail_mode) {
1767         mgr->fail_mode = fail_mode;
1768         update_fail_open(mgr);
1769         if (!connmgr_has_controllers(mgr)) {
1770             ofproto_flush_flows(mgr->ofproto);
1771         }
1772     }
1773 }
1774 \f
1775 /* Fail-open implementation. */
1776
1777 /* Returns the longest probe interval among the primary controllers configured
1778  * on 'mgr'.  Returns 0 if there are no primary controllers. */
1779 int
1780 connmgr_get_max_probe_interval(const struct connmgr *mgr)
1781 {
1782     const struct ofconn *ofconn;
1783     int max_probe_interval;
1784
1785     max_probe_interval = 0;
1786     HMAP_FOR_EACH (ofconn, hmap_node, &mgr->controllers) {
1787         int probe_interval = rconn_get_probe_interval(ofconn->rconn);
1788         max_probe_interval = MAX(max_probe_interval, probe_interval);
1789     }
1790     return max_probe_interval;
1791 }
1792
1793 /* Returns the number of seconds for which all of 'mgr's primary controllers
1794  * have been disconnected.  Returns 0 if 'mgr' has no primary controllers. */
1795 int
1796 connmgr_failure_duration(const struct connmgr *mgr)
1797 {
1798     const struct ofconn *ofconn;
1799     int min_failure_duration;
1800
1801     if (!connmgr_has_controllers(mgr)) {
1802         return 0;
1803     }
1804
1805     min_failure_duration = INT_MAX;
1806     HMAP_FOR_EACH (ofconn, hmap_node, &mgr->controllers) {
1807         int failure_duration = rconn_failure_duration(ofconn->rconn);
1808         min_failure_duration = MIN(min_failure_duration, failure_duration);
1809     }
1810     return min_failure_duration;
1811 }
1812
1813 /* Returns true if at least one primary controller is connected (regardless of
1814  * whether those controllers are believed to have authenticated and accepted
1815  * this switch), false if none of them are connected. */
1816 bool
1817 connmgr_is_any_controller_connected(const struct connmgr *mgr)
1818 {
1819     const struct ofconn *ofconn;
1820
1821     HMAP_FOR_EACH (ofconn, hmap_node, &mgr->controllers) {
1822         if (rconn_is_connected(ofconn->rconn)) {
1823             return true;
1824         }
1825     }
1826     return false;
1827 }
1828
1829 /* Returns true if at least one primary controller is believed to have
1830  * authenticated and accepted this switch, false otherwise. */
1831 bool
1832 connmgr_is_any_controller_admitted(const struct connmgr *mgr)
1833 {
1834     const struct ofconn *ofconn;
1835
1836     HMAP_FOR_EACH (ofconn, hmap_node, &mgr->controllers) {
1837         if (rconn_is_admitted(ofconn->rconn)) {
1838             return true;
1839         }
1840     }
1841     return false;
1842 }
1843 \f
1844 /* In-band configuration. */
1845
1846 static bool any_extras_changed(const struct connmgr *,
1847                                const struct sockaddr_in *extras, size_t n);
1848
1849 /* Sets the 'n' TCP port addresses in 'extras' as ones to which 'mgr''s
1850  * in-band control should guarantee access, in the same way that in-band
1851  * control guarantees access to OpenFlow controllers. */
1852 void
1853 connmgr_set_extra_in_band_remotes(struct connmgr *mgr,
1854                                   const struct sockaddr_in *extras, size_t n)
1855 {
1856     if (!any_extras_changed(mgr, extras, n)) {
1857         return;
1858     }
1859
1860     free(mgr->extra_in_band_remotes);
1861     mgr->n_extra_remotes = n;
1862     mgr->extra_in_band_remotes = xmemdup(extras, n * sizeof *extras);
1863
1864     update_in_band_remotes(mgr);
1865 }
1866
1867 /* Sets the OpenFlow queue used by flows set up by in-band control on
1868  * 'mgr' to 'queue_id'.  If 'queue_id' is negative, then in-band control
1869  * flows will use the default queue. */
1870 void
1871 connmgr_set_in_band_queue(struct connmgr *mgr, int queue_id)
1872 {
1873     if (queue_id != mgr->in_band_queue) {
1874         mgr->in_band_queue = queue_id;
1875         update_in_band_remotes(mgr);
1876     }
1877 }
1878
1879 static bool
1880 any_extras_changed(const struct connmgr *mgr,
1881                    const struct sockaddr_in *extras, size_t n)
1882 {
1883     size_t i;
1884
1885     if (n != mgr->n_extra_remotes) {
1886         return true;
1887     }
1888
1889     for (i = 0; i < n; i++) {
1890         const struct sockaddr_in *old = &mgr->extra_in_band_remotes[i];
1891         const struct sockaddr_in *new = &extras[i];
1892
1893         if (old->sin_addr.s_addr != new->sin_addr.s_addr ||
1894             old->sin_port != new->sin_port) {
1895             return true;
1896         }
1897     }
1898
1899     return false;
1900 }
1901 \f
1902 /* In-band implementation. */
1903
1904 bool
1905 connmgr_has_in_band(struct connmgr *mgr)
1906 {
1907     return mgr->in_band != NULL;
1908 }
1909 \f
1910 /* Fail-open and in-band implementation. */
1911
1912 /* Called by 'ofproto' after all flows have been flushed, to allow fail-open
1913  * and standalone mode to re-create their flows.
1914  *
1915  * In-band control has more sophisticated code that manages flows itself. */
1916 void
1917 connmgr_flushed(struct connmgr *mgr)
1918     OVS_EXCLUDED(ofproto_mutex)
1919 {
1920     if (mgr->fail_open) {
1921         fail_open_flushed(mgr->fail_open);
1922     }
1923
1924     /* If there are no controllers and we're in standalone mode, set up a flow
1925      * that matches every packet and directs them to OFPP_NORMAL (which goes to
1926      * us).  Otherwise, the switch is in secure mode and we won't pass any
1927      * traffic until a controller has been defined and it tells us to do so. */
1928     if (!connmgr_has_controllers(mgr)
1929         && mgr->fail_mode == OFPROTO_FAIL_STANDALONE) {
1930         struct ofpbuf ofpacts;
1931         struct match match;
1932
1933         ofpbuf_init(&ofpacts, OFPACT_OUTPUT_SIZE);
1934         ofpact_put_OUTPUT(&ofpacts)->port = OFPP_NORMAL;
1935         ofpact_pad(&ofpacts);
1936
1937         match_init_catchall(&match);
1938         ofproto_add_flow(mgr->ofproto, &match, 0, ofpbuf_data(&ofpacts),
1939                                                   ofpbuf_size(&ofpacts));
1940
1941         ofpbuf_uninit(&ofpacts);
1942     }
1943 }
1944 \f
1945 /* Creates a new ofservice for 'target' in 'mgr'.  Returns 0 if successful,
1946  * otherwise a positive errno value.
1947  *
1948  * ofservice_reconfigure() must be called to fully configure the new
1949  * ofservice. */
1950 static int
1951 ofservice_create(struct connmgr *mgr, const char *target,
1952                  uint32_t allowed_versions, uint8_t dscp)
1953 {
1954     struct ofservice *ofservice;
1955     struct pvconn *pvconn;
1956     int error;
1957
1958     error = pvconn_open(target, allowed_versions, dscp, &pvconn);
1959     if (error) {
1960         return error;
1961     }
1962
1963     ofservice = xzalloc(sizeof *ofservice);
1964     hmap_insert(&mgr->services, &ofservice->node, hash_string(target, 0));
1965     ofservice->pvconn = pvconn;
1966     ofservice->allowed_versions = allowed_versions;
1967
1968     return 0;
1969 }
1970
1971 static void
1972 ofservice_destroy(struct connmgr *mgr, struct ofservice *ofservice)
1973 {
1974     hmap_remove(&mgr->services, &ofservice->node);
1975     pvconn_close(ofservice->pvconn);
1976     free(ofservice);
1977 }
1978
1979 static void
1980 ofservice_reconfigure(struct ofservice *ofservice,
1981                       const struct ofproto_controller *c)
1982 {
1983     ofservice->probe_interval = c->probe_interval;
1984     ofservice->rate_limit = c->rate_limit;
1985     ofservice->burst_limit = c->burst_limit;
1986     ofservice->enable_async_msgs = c->enable_async_msgs;
1987     ofservice->dscp = c->dscp;
1988 }
1989
1990 /* Finds and returns the ofservice within 'mgr' that has the given
1991  * 'target', or a null pointer if none exists. */
1992 static struct ofservice *
1993 ofservice_lookup(struct connmgr *mgr, const char *target)
1994 {
1995     struct ofservice *ofservice;
1996
1997     HMAP_FOR_EACH_WITH_HASH (ofservice, node, hash_string(target, 0),
1998                              &mgr->services) {
1999         if (!strcmp(pvconn_get_name(ofservice->pvconn), target)) {
2000             return ofservice;
2001         }
2002     }
2003     return NULL;
2004 }
2005 \f
2006 /* Flow monitors (NXST_FLOW_MONITOR). */
2007
2008 /* A counter incremented when something significant happens to an OpenFlow
2009  * rule.
2010  *
2011  *     - When a rule is added, its 'add_seqno' and 'modify_seqno' are set to
2012  *       the current value (which is then incremented).
2013  *
2014  *     - When a rule is modified, its 'modify_seqno' is set to the current
2015  *       value (which is then incremented).
2016  *
2017  * Thus, by comparing an old value of monitor_seqno against a rule's
2018  * 'add_seqno', one can tell whether the rule was added before or after the old
2019  * value was read, and similarly for 'modify_seqno'.
2020  *
2021  * 32 bits should normally be sufficient (and would be nice, to save space in
2022  * each rule) but then we'd have to have some special cases for wraparound.
2023  *
2024  * We initialize monitor_seqno to 1 to allow 0 to be used as an invalid
2025  * value. */
2026 static uint64_t monitor_seqno = 1;
2027
2028 COVERAGE_DEFINE(ofmonitor_pause);
2029 COVERAGE_DEFINE(ofmonitor_resume);
2030
2031 enum ofperr
2032 ofmonitor_create(const struct ofputil_flow_monitor_request *request,
2033                  struct ofconn *ofconn, struct ofmonitor **monitorp)
2034     OVS_REQUIRES(ofproto_mutex)
2035 {
2036     struct ofmonitor *m;
2037
2038     *monitorp = NULL;
2039
2040     m = ofmonitor_lookup(ofconn, request->id);
2041     if (m) {
2042         return OFPERR_OFPMOFC_MONITOR_EXISTS;
2043     }
2044
2045     m = xmalloc(sizeof *m);
2046     m->ofconn = ofconn;
2047     hmap_insert(&ofconn->monitors, &m->ofconn_node, hash_int(request->id, 0));
2048     m->id = request->id;
2049     m->flags = request->flags;
2050     m->out_port = request->out_port;
2051     m->table_id = request->table_id;
2052     minimatch_init(&m->match, &request->match);
2053
2054     *monitorp = m;
2055     return 0;
2056 }
2057
2058 struct ofmonitor *
2059 ofmonitor_lookup(struct ofconn *ofconn, uint32_t id)
2060     OVS_REQUIRES(ofproto_mutex)
2061 {
2062     struct ofmonitor *m;
2063
2064     HMAP_FOR_EACH_IN_BUCKET (m, ofconn_node, hash_int(id, 0),
2065                              &ofconn->monitors) {
2066         if (m->id == id) {
2067             return m;
2068         }
2069     }
2070     return NULL;
2071 }
2072
2073 void
2074 ofmonitor_destroy(struct ofmonitor *m)
2075     OVS_REQUIRES(ofproto_mutex)
2076 {
2077     if (m) {
2078         minimatch_destroy(&m->match);
2079         hmap_remove(&m->ofconn->monitors, &m->ofconn_node);
2080         free(m);
2081     }
2082 }
2083
2084 void
2085 ofmonitor_report(struct connmgr *mgr, struct rule *rule,
2086                  enum nx_flow_update_event event,
2087                  enum ofp_flow_removed_reason reason,
2088                  const struct ofconn *abbrev_ofconn, ovs_be32 abbrev_xid,
2089                  const struct rule_actions *old_actions)
2090     OVS_REQUIRES(ofproto_mutex)
2091 {
2092     enum nx_flow_monitor_flags update;
2093     struct ofconn *ofconn;
2094
2095     if (rule_is_hidden(rule)) {
2096         return;
2097     }
2098
2099     switch (event) {
2100     case NXFME_ADDED:
2101         update = NXFMF_ADD;
2102         rule->add_seqno = rule->modify_seqno = monitor_seqno++;
2103         break;
2104
2105     case NXFME_DELETED:
2106         update = NXFMF_DELETE;
2107         break;
2108
2109     case NXFME_MODIFIED:
2110         update = NXFMF_MODIFY;
2111         rule->modify_seqno = monitor_seqno++;
2112         break;
2113
2114     default:
2115     case NXFME_ABBREV:
2116         OVS_NOT_REACHED();
2117     }
2118
2119     LIST_FOR_EACH (ofconn, node, &mgr->all_conns) {
2120         enum nx_flow_monitor_flags flags = 0;
2121         struct ofmonitor *m;
2122
2123         if (ofconn->monitor_paused) {
2124             /* Only send NXFME_DELETED notifications for flows that were added
2125              * before we paused. */
2126             if (event != NXFME_DELETED
2127                 || rule->add_seqno > ofconn->monitor_paused) {
2128                 continue;
2129             }
2130         }
2131
2132         HMAP_FOR_EACH (m, ofconn_node, &ofconn->monitors) {
2133             if (m->flags & update
2134                 && (m->table_id == 0xff || m->table_id == rule->table_id)
2135                 && (ofproto_rule_has_out_port(rule, m->out_port)
2136                     || (old_actions
2137                         && ofpacts_output_to_port(old_actions->ofpacts,
2138                                                   old_actions->ofpacts_len,
2139                                                   m->out_port)))
2140                 && cls_rule_is_loose_match(&rule->cr, &m->match)) {
2141                 flags |= m->flags;
2142             }
2143         }
2144
2145         if (flags) {
2146             if (list_is_empty(&ofconn->updates)) {
2147                 ofputil_start_flow_update(&ofconn->updates);
2148                 ofconn->sent_abbrev_update = false;
2149             }
2150
2151             if (flags & NXFMF_OWN || ofconn != abbrev_ofconn
2152                 || ofconn->monitor_paused) {
2153                 struct ofputil_flow_update fu;
2154                 struct match match;
2155
2156                 fu.event = event;
2157                 fu.reason = event == NXFME_DELETED ? reason : 0;
2158                 fu.table_id = rule->table_id;
2159                 fu.cookie = rule->flow_cookie;
2160                 minimatch_expand(&rule->cr.match, &match);
2161                 fu.match = &match;
2162                 fu.priority = rule->cr.priority;
2163
2164                 ovs_mutex_lock(&rule->mutex);
2165                 fu.idle_timeout = rule->idle_timeout;
2166                 fu.hard_timeout = rule->hard_timeout;
2167                 ovs_mutex_unlock(&rule->mutex);
2168
2169                 if (flags & NXFMF_ACTIONS) {
2170                     const struct rule_actions *actions = rule_get_actions(rule);
2171                     fu.ofpacts = actions->ofpacts;
2172                     fu.ofpacts_len = actions->ofpacts_len;
2173                 } else {
2174                     fu.ofpacts = NULL;
2175                     fu.ofpacts_len = 0;
2176                 }
2177                 ofputil_append_flow_update(&fu, &ofconn->updates);
2178             } else if (!ofconn->sent_abbrev_update) {
2179                 struct ofputil_flow_update fu;
2180
2181                 fu.event = NXFME_ABBREV;
2182                 fu.xid = abbrev_xid;
2183                 ofputil_append_flow_update(&fu, &ofconn->updates);
2184
2185                 ofconn->sent_abbrev_update = true;
2186             }
2187         }
2188     }
2189 }
2190
2191 void
2192 ofmonitor_flush(struct connmgr *mgr)
2193     OVS_REQUIRES(ofproto_mutex)
2194 {
2195     struct ofconn *ofconn;
2196
2197     LIST_FOR_EACH (ofconn, node, &mgr->all_conns) {
2198         struct ofpbuf *msg, *next;
2199
2200         LIST_FOR_EACH_SAFE (msg, next, list_node, &ofconn->updates) {
2201             unsigned int n_bytes;
2202
2203             list_remove(&msg->list_node);
2204             ofconn_send(ofconn, msg, ofconn->monitor_counter);
2205             n_bytes = rconn_packet_counter_n_bytes(ofconn->monitor_counter);
2206             if (!ofconn->monitor_paused && n_bytes > 128 * 1024) {
2207                 struct ofpbuf *pause;
2208
2209                 COVERAGE_INC(ofmonitor_pause);
2210                 ofconn->monitor_paused = monitor_seqno++;
2211                 pause = ofpraw_alloc_xid(OFPRAW_NXT_FLOW_MONITOR_PAUSED,
2212                                          OFP10_VERSION, htonl(0), 0);
2213                 ofconn_send(ofconn, pause, ofconn->monitor_counter);
2214             }
2215         }
2216     }
2217 }
2218
2219 static void
2220 ofmonitor_resume(struct ofconn *ofconn)
2221     OVS_REQUIRES(ofproto_mutex)
2222 {
2223     struct rule_collection rules;
2224     struct ofpbuf *resumed;
2225     struct ofmonitor *m;
2226     struct list msgs;
2227
2228     rule_collection_init(&rules);
2229     HMAP_FOR_EACH (m, ofconn_node, &ofconn->monitors) {
2230         ofmonitor_collect_resume_rules(m, ofconn->monitor_paused, &rules);
2231     }
2232
2233     list_init(&msgs);
2234     ofmonitor_compose_refresh_updates(&rules, &msgs);
2235
2236     resumed = ofpraw_alloc_xid(OFPRAW_NXT_FLOW_MONITOR_RESUMED, OFP10_VERSION,
2237                                htonl(0), 0);
2238     list_push_back(&msgs, &resumed->list_node);
2239     ofconn_send_replies(ofconn, &msgs);
2240
2241     ofconn->monitor_paused = 0;
2242 }
2243
2244 static bool
2245 ofmonitor_may_resume(const struct ofconn *ofconn)
2246     OVS_REQUIRES(ofproto_mutex)
2247 {
2248     return (ofconn->monitor_paused != 0
2249             && !rconn_packet_counter_n_packets(ofconn->monitor_counter));
2250 }
2251
2252 static void
2253 ofmonitor_run(struct connmgr *mgr)
2254 {
2255     struct ofconn *ofconn;
2256
2257     ovs_mutex_lock(&ofproto_mutex);
2258     LIST_FOR_EACH (ofconn, node, &mgr->all_conns) {
2259         if (ofmonitor_may_resume(ofconn)) {
2260             COVERAGE_INC(ofmonitor_resume);
2261             ofmonitor_resume(ofconn);
2262         }
2263     }
2264     ovs_mutex_unlock(&ofproto_mutex);
2265 }
2266
2267 static void
2268 ofmonitor_wait(struct connmgr *mgr)
2269 {
2270     struct ofconn *ofconn;
2271
2272     ovs_mutex_lock(&ofproto_mutex);
2273     LIST_FOR_EACH (ofconn, node, &mgr->all_conns) {
2274         if (ofmonitor_may_resume(ofconn)) {
2275             poll_immediate_wake();
2276         }
2277     }
2278     ovs_mutex_unlock(&ofproto_mutex);
2279 }