ofproto/connmgr.c

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