ofproto/connmgr.c

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