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 /* If a master election id is defined, stores it into '*idp' and returns
 827  * true.  Otherwise, stores UINT64_MAX into '*idp' and returns false. */
 828 bool
 829 ofconn_get_master_election_id(const struct ofconn *ofconn, uint64_t *idp)
 830 {
 831     *idp = (ofconn->connmgr->master_election_id_defined
 832             ? ofconn->connmgr->master_election_id
 833             : UINT64_MAX);
 834     return ofconn->connmgr->master_election_id_defined;
 835 }
 836
 837 /* Sets the master election id.
 838  *
 839  * Returns true if successful, false if the id is stale
 840  */
 841 bool
 842 ofconn_set_master_election_id(struct ofconn *ofconn, uint64_t id)
 843 {
 844     if (ofconn->connmgr->master_election_id_defined
 845         &&
 846         /* Unsigned difference interpreted as a two's complement signed
 847          * value */
 848         (int64_t)(id - ofconn->connmgr->master_election_id) < 0) {
 849         return false;
 850     }
 851     ofconn->connmgr->master_election_id = id;
 852     ofconn->connmgr->master_election_id_defined = true;
 853
 854     return true;
 855 }
 856
 857 /* Returns the role configured for 'ofconn'.
 858  *
 859  * The default role, if no other role has been set, is OFPCR12_ROLE_EQUAL. */
 860 enum ofp12_controller_role
 861 ofconn_get_role(const struct ofconn *ofconn)
 862 {
 863     return ofconn->role;
 864 }
 865
 866 /* Changes 'ofconn''s role to 'role'.  If 'role' is OFPCR12_ROLE_MASTER then
 867  * any existing master is demoted to a slave. */
 868 void
 869 ofconn_set_role(struct ofconn *ofconn, enum ofp12_controller_role role)
 870 {
 871     if (role == OFPCR12_ROLE_MASTER) {
 872         struct ofconn *other;
 873
 874         HMAP_FOR_EACH (other, hmap_node, &ofconn->connmgr->controllers) {
 875             if (other->role == OFPCR12_ROLE_MASTER) {
 876                 other->role = OFPCR12_ROLE_SLAVE;
 877             }
 878         }
 879     }
 880     ofconn->role = role;
 881 }
 882
 883 void
 884 ofconn_set_invalid_ttl_to_controller(struct ofconn *ofconn, bool enable)
 885 {
 886     uint32_t bit = 1u << OFPR_INVALID_TTL;
 887     if (enable) {
 888         ofconn->master_async_config[OAM_PACKET_IN] |= bit;
 889     } else {
 890         ofconn->master_async_config[OAM_PACKET_IN] &= ~bit;
 891     }
 892 }
 893
 894 bool
 895 ofconn_get_invalid_ttl_to_controller(struct ofconn *ofconn)
 896 {
 897     uint32_t bit = 1u << OFPR_INVALID_TTL;
 898     return (ofconn->master_async_config[OAM_PACKET_IN] & bit) != 0;
 899 }
 900
 901 /* Returns the currently configured protocol for 'ofconn', one of OFPUTIL_P_*.
 902  *
 903  * Returns OFPUTIL_P_NONE, which is not a valid protocol, if 'ofconn' hasn't
 904  * completed version negotiation.  This can't happen if at least one OpenFlow
 905  * message, other than OFPT_HELLO, has been received on the connection (such as
 906  * in ofproto.c's message handling code), since version negotiation is a
 907  * prerequisite for starting to receive messages.  This means that
 908  * OFPUTIL_P_NONE is a special case that most callers need not worry about. */
 909 enum ofputil_protocol
 910 ofconn_get_protocol(const struct ofconn *ofconn)
 911 {
 912     if (ofconn->protocol == OFPUTIL_P_NONE &&
 913         rconn_is_connected(ofconn->rconn)) {
 914         int version = rconn_get_version(ofconn->rconn);
 915         if (version > 0) {
 916             ofconn_set_protocol(CONST_CAST(struct ofconn *, ofconn),
 917                                 ofputil_protocol_from_ofp_version(version));
 918         }
 919     }
 920
 921     return ofconn->protocol;
 922 }
 923
 924 /* Sets the protocol for 'ofconn' to 'protocol' (one of OFPUTIL_P_*).
 925  *
 926  * (This doesn't actually send anything to accomplish this.  Presumably the
 927  * caller already did that.) */
 928 void
 929 ofconn_set_protocol(struct ofconn *ofconn, enum ofputil_protocol protocol)
 930 {
 931     ofconn->protocol = protocol;
 932 }
 933
 934 /* Returns the currently configured packet in format for 'ofconn', one of
 935  * NXPIF_*.
 936  *
 937  * The default, if no other format has been set, is NXPIF_OPENFLOW10. */
 938 enum nx_packet_in_format
 939 ofconn_get_packet_in_format(struct ofconn *ofconn)
 940 {
 941     return ofconn->packet_in_format;
 942 }
 943
 944 /* Sets the packet in format for 'ofconn' to 'packet_in_format' (one of
 945  * NXPIF_*). */
 946 void
 947 ofconn_set_packet_in_format(struct ofconn *ofconn,
 948                             enum nx_packet_in_format packet_in_format)
 949 {
 950     ofconn->packet_in_format = packet_in_format;
 951 }
 952
 953 /* Sets the controller connection ID for 'ofconn' to 'controller_id'.
 954  *
 955  * The connection controller ID is used for OFPP_CONTROLLER and
 956  * NXAST_CONTROLLER actions.  See "struct nx_action_controller" for details. */
 957 void
 958 ofconn_set_controller_id(struct ofconn *ofconn, uint16_t controller_id)
 959 {
 960     ofconn->controller_id = controller_id;
 961 }
 962
 963 /* Returns the default miss send length for 'ofconn'. */
 964 int
 965 ofconn_get_miss_send_len(const struct ofconn *ofconn)
 966 {
 967     return ofconn->miss_send_len;
 968 }
 969
 970 /* Sets the default miss send length for 'ofconn' to 'miss_send_len'. */
 971 void
 972 ofconn_set_miss_send_len(struct ofconn *ofconn, int miss_send_len)
 973 {
 974     ofconn->miss_send_len = miss_send_len;
 975 }
 976
 977 void
 978 ofconn_set_async_config(struct ofconn *ofconn,
 979                         const uint32_t master_masks[OAM_N_TYPES],
 980                         const uint32_t slave_masks[OAM_N_TYPES])
 981 {
 982     size_t size = sizeof ofconn->master_async_config;
 983     memcpy(ofconn->master_async_config, master_masks, size);
 984     memcpy(ofconn->slave_async_config, slave_masks, size);
 985 }
 986
 987 /* Sends 'msg' on 'ofconn', accounting it as a reply.  (If there is a
 988  * sufficient number of OpenFlow replies in-flight on a single ofconn, then the
 989  * connmgr will stop accepting new OpenFlow requests on that ofconn until the
 990  * controller has accepted some of the replies.) */
 991 void
 992 ofconn_send_reply(const struct ofconn *ofconn, struct ofpbuf *msg)
 993 {
 994     ofconn_send(ofconn, msg, ofconn->reply_counter);
 995 }
 996
 997 /* Sends each of the messages in list 'replies' on 'ofconn' in order,
 998  * accounting them as replies. */
 999 void
1000 ofconn_send_replies(const struct ofconn *ofconn, struct list *replies)
1001 {
1002     struct ofpbuf *reply, *next;
1003
1004     LIST_FOR_EACH_SAFE (reply, next, list_node, replies) {
1005         list_remove(&reply->list_node);
1006         ofconn_send_reply(ofconn, reply);
1007     }
1008 }
1009
1010 /* Sends 'error' on 'ofconn', as a reply to 'request'.  Only at most the
1011  * first 64 bytes of 'request' are used. */
1012 void
1013 ofconn_send_error(const struct ofconn *ofconn,
1014                   const struct ofp_header *request, enum ofperr error)
1015 {
1016     static struct vlog_rate_limit err_rl = VLOG_RATE_LIMIT_INIT(10, 10);
1017     struct ofpbuf *reply;
1018
1019     reply = ofperr_encode_reply(error, request);
1020     if (!VLOG_DROP_INFO(&err_rl)) {
1021         const char *type_name;
1022         size_t request_len;
1023         enum ofpraw raw;
1024
1025         request_len = ntohs(request->length);
1026         type_name = (!ofpraw_decode_partial(&raw, request,
1027                                             MIN(64, request_len))
1028                      ? ofpraw_get_name(raw)
1029                      : "invalid");
1030
1031         VLOG_INFO("%s: sending %s error reply to %s message",
1032                   rconn_get_name(ofconn->rconn), ofperr_to_string(error),
1033                   type_name);
1034     }
1035     ofconn_send_reply(ofconn, reply);
1036 }
1037
1038 /* Same as pktbuf_retrieve(), using the pktbuf owned by 'ofconn'. */
1039 enum ofperr
1040 ofconn_pktbuf_retrieve(struct ofconn *ofconn, uint32_t id,
1041                        struct ofpbuf **bufferp, uint16_t *in_port)
1042 {
1043     return pktbuf_retrieve(ofconn->pktbuf, id, bufferp, in_port);
1044 }
1045
1046 /* Returns true if 'ofconn' has any pending opgroups. */
1047 bool
1048 ofconn_has_pending_opgroups(const struct ofconn *ofconn)
1049 {
1050     return !list_is_empty(&ofconn->opgroups);
1051 }
1052
1053 /* Adds 'ofconn_node' to 'ofconn''s list of pending opgroups.
1054  *
1055  * If 'ofconn' is destroyed or its connection drops, then 'ofconn' will remove
1056  * 'ofconn_node' from the list and re-initialize it with list_init().  The
1057  * client may, therefore, use list_is_empty(ofconn_node) to determine whether
1058  * 'ofconn_node' is still associated with an active ofconn.
1059  *
1060  * The client may also remove ofconn_node from the list itself, with
1061  * list_remove(). */
1062 void
1063 ofconn_add_opgroup(struct ofconn *ofconn, struct list *ofconn_node)
1064 {
1065     list_push_back(&ofconn->opgroups, ofconn_node);
1066 }
1067 \f
1068 /* Private ofconn functions. */
1069
1070 static const char *
1071 ofconn_get_target(const struct ofconn *ofconn)
1072 {
1073     return rconn_get_target(ofconn->rconn);
1074 }
1075
1076 static struct ofconn *
1077 ofconn_create(struct connmgr *mgr, struct rconn *rconn, enum ofconn_type type,
1078               bool enable_async_msgs)
1079 {
1080     struct ofconn *ofconn;
1081
1082     ofconn = xzalloc(sizeof *ofconn);
1083     ofconn->connmgr = mgr;
1084     list_push_back(&mgr->all_conns, &ofconn->node);
1085     ofconn->rconn = rconn;
1086     ofconn->type = type;
1087     ofconn->enable_async_msgs = enable_async_msgs;
1088
1089     list_init(&ofconn->opgroups);
1090
1091     hmap_init(&ofconn->monitors);
1092     list_init(&ofconn->updates);
1093
1094     ofconn_flush(ofconn);
1095
1096     return ofconn;
1097 }
1098
1099 /* Clears all of the state in 'ofconn' that should not persist from one
1100  * connection to the next. */
1101 static void
1102 ofconn_flush(struct ofconn *ofconn)
1103 {
1104     struct ofmonitor *monitor, *next_monitor;
1105     int i;
1106
1107     ofconn->role = OFPCR12_ROLE_EQUAL;
1108     ofconn_set_protocol(ofconn, OFPUTIL_P_NONE);
1109     ofconn->packet_in_format = NXPIF_OPENFLOW10;
1110
1111     /* Disassociate 'ofconn' from all of the ofopgroups that it initiated that
1112      * have not yet completed.  (Those ofopgroups will still run to completion
1113      * in the usual way, but any errors that they run into will not be reported
1114      * on any OpenFlow channel.)
1115      *
1116      * Also discard any blocked operation on 'ofconn'. */
1117     while (!list_is_empty(&ofconn->opgroups)) {
1118         list_init(list_pop_front(&ofconn->opgroups));
1119     }
1120     ofpbuf_delete(ofconn->blocked);
1121     ofconn->blocked = NULL;
1122
1123     rconn_packet_counter_destroy(ofconn->packet_in_counter);
1124     ofconn->packet_in_counter = rconn_packet_counter_create();
1125     for (i = 0; i < N_SCHEDULERS; i++) {
1126         if (ofconn->schedulers[i]) {
1127             int rate, burst;
1128
1129             pinsched_get_limits(ofconn->schedulers[i], &rate, &burst);
1130             pinsched_destroy(ofconn->schedulers[i]);
1131             ofconn->schedulers[i] = pinsched_create(rate, burst);
1132         }
1133     }
1134     if (ofconn->pktbuf) {
1135         pktbuf_destroy(ofconn->pktbuf);
1136         ofconn->pktbuf = pktbuf_create();
1137     }
1138     ofconn->miss_send_len = (ofconn->type == OFCONN_PRIMARY
1139                              ? OFP_DEFAULT_MISS_SEND_LEN
1140                              : 0);
1141     ofconn->controller_id = 0;
1142
1143     rconn_packet_counter_destroy(ofconn->reply_counter);
1144     ofconn->reply_counter = rconn_packet_counter_create();
1145
1146     if (ofconn->enable_async_msgs) {
1147         uint32_t *master = ofconn->master_async_config;
1148         uint32_t *slave = ofconn->slave_async_config;
1149
1150         /* "master" and "other" roles get all asynchronous messages by default,
1151          * except that the controller needs to enable nonstandard "packet-in"
1152          * reasons itself. */
1153         master[OAM_PACKET_IN] = (1u << OFPR_NO_MATCH) | (1u << OFPR_ACTION);
1154         master[OAM_PORT_STATUS] = ((1u << OFPPR_ADD)
1155                                    | (1u << OFPPR_DELETE)
1156                                    | (1u << OFPPR_MODIFY));
1157         master[OAM_FLOW_REMOVED] = ((1u << OFPRR_IDLE_TIMEOUT)
1158                                     | (1u << OFPRR_HARD_TIMEOUT)
1159                                     | (1u << OFPRR_DELETE));
1160
1161         /* "slave" role gets port status updates by default. */
1162         slave[OAM_PACKET_IN] = 0;
1163         slave[OAM_PORT_STATUS] = ((1u << OFPPR_ADD)
1164                                   | (1u << OFPPR_DELETE)
1165                                   | (1u << OFPPR_MODIFY));
1166         slave[OAM_FLOW_REMOVED] = 0;
1167     } else {
1168         memset(ofconn->master_async_config, 0,
1169                sizeof ofconn->master_async_config);
1170         memset(ofconn->slave_async_config, 0,
1171                sizeof ofconn->slave_async_config);
1172     }
1173
1174     HMAP_FOR_EACH_SAFE (monitor, next_monitor, ofconn_node,
1175                         &ofconn->monitors) {
1176         ofmonitor_destroy(monitor);
1177     }
1178     rconn_packet_counter_destroy(ofconn->monitor_counter);
1179     ofconn->monitor_counter = rconn_packet_counter_create();
1180     ofpbuf_list_delete(&ofconn->updates); /* ...but it should be empty. */
1181 }
1182
1183 static void
1184 ofconn_destroy(struct ofconn *ofconn)
1185 {
1186     ofconn_flush(ofconn);
1187
1188     if (ofconn->type == OFCONN_PRIMARY) {
1189         hmap_remove(&ofconn->connmgr->controllers, &ofconn->hmap_node);
1190     }
1191
1192     hmap_destroy(&ofconn->monitors);
1193     list_remove(&ofconn->node);
1194     rconn_destroy(ofconn->rconn);
1195     rconn_packet_counter_destroy(ofconn->packet_in_counter);
1196     rconn_packet_counter_destroy(ofconn->reply_counter);
1197     pktbuf_destroy(ofconn->pktbuf);
1198     rconn_packet_counter_destroy(ofconn->monitor_counter);
1199     free(ofconn);
1200 }
1201
1202 /* Reconfigures 'ofconn' to match 'c'.  'ofconn' and 'c' must have the same
1203  * target. */
1204 static void
1205 ofconn_reconfigure(struct ofconn *ofconn, const struct ofproto_controller *c)
1206 {
1207     int probe_interval;
1208
1209     ofconn->band = c->band;
1210     ofconn->enable_async_msgs = c->enable_async_msgs;
1211
1212     rconn_set_max_backoff(ofconn->rconn, c->max_backoff);
1213
1214     probe_interval = c->probe_interval ? MAX(c->probe_interval, 5) : 0;
1215     rconn_set_probe_interval(ofconn->rconn, probe_interval);
1216
1217     ofconn_set_rate_limit(ofconn, c->rate_limit, c->burst_limit);
1218
1219     /* If dscp value changed reconnect. */
1220     if (c->dscp != rconn_get_dscp(ofconn->rconn)) {
1221         rconn_set_dscp(ofconn->rconn, c->dscp);
1222         rconn_reconnect(ofconn->rconn);
1223     }
1224 }
1225
1226 /* Returns true if it makes sense for 'ofconn' to receive and process OpenFlow
1227  * messages. */
1228 static bool
1229 ofconn_may_recv(const struct ofconn *ofconn)
1230 {
1231     int count = ofconn->reply_counter->n_packets;
1232     return (!ofconn->blocked || ofconn->retry) && count < OFCONN_REPLY_MAX;
1233 }
1234
1235 static void
1236 ofconn_run(struct ofconn *ofconn,
1237            bool (*handle_openflow)(struct ofconn *, struct ofpbuf *ofp_msg))
1238 {
1239     struct connmgr *mgr = ofconn->connmgr;
1240     size_t i;
1241
1242     for (i = 0; i < N_SCHEDULERS; i++) {
1243         pinsched_run(ofconn->schedulers[i], do_send_packet_in, ofconn);
1244     }
1245
1246     rconn_run(ofconn->rconn);
1247
1248     if (handle_openflow) {
1249         /* Limit the number of iterations to avoid starving other tasks. */
1250         for (i = 0; i < 50 && ofconn_may_recv(ofconn); i++) {
1251             struct ofpbuf *of_msg;
1252
1253             of_msg = (ofconn->blocked
1254                       ? ofconn->blocked
1255                       : rconn_recv(ofconn->rconn));
1256             if (!of_msg) {
1257                 break;
1258             }
1259             if (mgr->fail_open) {
1260                 fail_open_maybe_recover(mgr->fail_open);
1261             }
1262
1263             if (handle_openflow(ofconn, of_msg)) {
1264                 ofpbuf_delete(of_msg);
1265                 ofconn->blocked = NULL;
1266             } else {
1267                 ofconn->blocked = of_msg;
1268                 ofconn->retry = false;
1269             }
1270         }
1271     }
1272
1273     if (!rconn_is_alive(ofconn->rconn)) {
1274         ofconn_destroy(ofconn);
1275     } else if (!rconn_is_connected(ofconn->rconn)) {
1276         ofconn_flush(ofconn);
1277     }
1278 }
1279
1280 static void
1281 ofconn_wait(struct ofconn *ofconn, bool handling_openflow)
1282 {
1283     int i;
1284
1285     for (i = 0; i < N_SCHEDULERS; i++) {
1286         pinsched_wait(ofconn->schedulers[i]);
1287     }
1288     rconn_run_wait(ofconn->rconn);
1289     if (handling_openflow && ofconn_may_recv(ofconn)) {
1290         rconn_recv_wait(ofconn->rconn);
1291     }
1292 }
1293
1294 /* Returns true if 'ofconn' should receive asynchronous messages of the given
1295  * OAM_* 'type' and 'reason', which should be a OFPR_* value for OAM_PACKET_IN,
1296  * a OFPPR_* value for OAM_PORT_STATUS, or an OFPRR_* value for
1297  * OAM_FLOW_REMOVED.  Returns false if the message should not be sent on
1298  * 'ofconn'. */
1299 static bool
1300 ofconn_receives_async_msg(const struct ofconn *ofconn,
1301                           enum ofconn_async_msg_type type,
1302                           unsigned int reason)
1303 {
1304     const uint32_t *async_config;
1305
1306     ovs_assert(reason < 32);
1307     ovs_assert((unsigned int) type < OAM_N_TYPES);
1308
1309     if (ofconn_get_protocol(ofconn) == OFPUTIL_P_NONE
1310         || !rconn_is_connected(ofconn->rconn)) {
1311         return false;
1312     }
1313
1314     /* Keep the following code in sync with the documentation in the
1315      * "Asynchronous Messages" section in DESIGN. */
1316
1317     if (ofconn->type == OFCONN_SERVICE && !ofconn->miss_send_len) {
1318         /* Service connections don't get asynchronous messages unless they have
1319          * explicitly asked for them by setting a nonzero miss send length. */
1320         return false;
1321     }
1322
1323     async_config = (ofconn->role == OFPCR12_ROLE_SLAVE
1324                     ? ofconn->slave_async_config
1325                     : ofconn->master_async_config);
1326     if (!(async_config[type] & (1u << reason))) {
1327         return false;
1328     }
1329
1330     return true;
1331 }
1332
1333 /* Returns a human-readable name for an OpenFlow connection between 'mgr' and
1334  * 'target', suitable for use in log messages for identifying the connection.
1335  *
1336  * The name is dynamically allocated.  The caller should free it (with free())
1337  * when it is no longer needed. */
1338 static char *
1339 ofconn_make_name(const struct connmgr *mgr, const char *target)
1340 {
1341     return xasprintf("%s<->%s", mgr->name, target);
1342 }
1343
1344 static void
1345 ofconn_set_rate_limit(struct ofconn *ofconn, int rate, int burst)
1346 {
1347     int i;
1348
1349     for (i = 0; i < N_SCHEDULERS; i++) {
1350         struct pinsched **s = &ofconn->schedulers[i];
1351
1352         if (rate > 0) {
1353             if (!*s) {
1354                 *s = pinsched_create(rate, burst);
1355             } else {
1356                 pinsched_set_limits(*s, rate, burst);
1357             }
1358         } else {
1359             pinsched_destroy(*s);
1360             *s = NULL;
1361         }
1362     }
1363 }
1364
1365 static void
1366 ofconn_send(const struct ofconn *ofconn, struct ofpbuf *msg,
1367             struct rconn_packet_counter *counter)
1368 {
1369     ofpmsg_update_length(msg);
1370     rconn_send(ofconn->rconn, msg, counter);
1371 }
1372 \f
1373 /* Sending asynchronous messages. */
1374
1375 static void schedule_packet_in(struct ofconn *, struct ofputil_packet_in);
1376
1377 /* Sends an OFPT_PORT_STATUS message with 'opp' and 'reason' to appropriate
1378  * controllers managed by 'mgr'. */
1379 void
1380 connmgr_send_port_status(struct connmgr *mgr,
1381                          const struct ofputil_phy_port *pp, uint8_t reason)
1382 {
1383     /* XXX Should limit the number of queued port status change messages. */
1384     struct ofputil_port_status ps;
1385     struct ofconn *ofconn;
1386
1387     ps.reason = reason;
1388     ps.desc = *pp;
1389     LIST_FOR_EACH (ofconn, node, &mgr->all_conns) {
1390         if (ofconn_receives_async_msg(ofconn, OAM_PORT_STATUS, reason)) {
1391             struct ofpbuf *msg;
1392
1393             msg = ofputil_encode_port_status(&ps, ofconn_get_protocol(ofconn));
1394             ofconn_send(ofconn, msg, NULL);
1395         }
1396     }
1397 }
1398
1399 /* Sends an OFPT_FLOW_REMOVED or NXT_FLOW_REMOVED message based on 'fr' to
1400  * appropriate controllers managed by 'mgr'. */
1401 void
1402 connmgr_send_flow_removed(struct connmgr *mgr,
1403                           const struct ofputil_flow_removed *fr)
1404 {
1405     struct ofconn *ofconn;
1406
1407     LIST_FOR_EACH (ofconn, node, &mgr->all_conns) {
1408         if (ofconn_receives_async_msg(ofconn, OAM_FLOW_REMOVED, fr->reason)) {
1409             struct ofpbuf *msg;
1410
1411             /* Account flow expirations as replies to OpenFlow requests.  That
1412              * works because preventing OpenFlow requests from being processed
1413              * also prevents new flows from being added (and expiring).  (It
1414              * also prevents processing OpenFlow requests that would not add
1415              * new flows, so it is imperfect.) */
1416             msg = ofputil_encode_flow_removed(fr, ofconn_get_protocol(ofconn));
1417             ofconn_send_reply(ofconn, msg);
1418         }
1419     }
1420 }
1421
1422 /* Given 'pin', sends an OFPT_PACKET_IN message to each OpenFlow controller as
1423  * necessary according to their individual configurations.
1424  *
1425  * The caller doesn't need to fill in pin->buffer_id or pin->total_len. */
1426 void
1427 connmgr_send_packet_in(struct connmgr *mgr,
1428                        const struct ofputil_packet_in *pin)
1429 {
1430     struct ofconn *ofconn;
1431
1432     LIST_FOR_EACH (ofconn, node, &mgr->all_conns) {
1433         if (ofconn_receives_async_msg(ofconn, OAM_PACKET_IN, pin->reason)
1434             && ofconn->controller_id == pin->controller_id) {
1435             schedule_packet_in(ofconn, *pin);
1436         }
1437     }
1438 }
1439
1440 /* pinsched callback for sending 'ofp_packet_in' on 'ofconn'. */
1441 static void
1442 do_send_packet_in(struct ofpbuf *ofp_packet_in, void *ofconn_)
1443 {
1444     struct ofconn *ofconn = ofconn_;
1445
1446     rconn_send_with_limit(ofconn->rconn, ofp_packet_in,
1447                           ofconn->packet_in_counter, 100);
1448 }
1449
1450 /* Takes 'pin', composes an OpenFlow packet-in message from it, and passes it
1451  * to 'ofconn''s packet scheduler for sending. */
1452 static void
1453 schedule_packet_in(struct ofconn *ofconn, struct ofputil_packet_in pin)
1454 {
1455     struct connmgr *mgr = ofconn->connmgr;
1456
1457     pin.total_len = pin.packet_len;
1458
1459     /* Get OpenFlow buffer_id. */
1460     if (pin.reason == OFPR_ACTION) {
1461         pin.buffer_id = UINT32_MAX;
1462     } else if (mgr->fail_open && fail_open_is_active(mgr->fail_open)) {
1463         pin.buffer_id = pktbuf_get_null();
1464     } else if (!ofconn->pktbuf) {
1465         pin.buffer_id = UINT32_MAX;
1466     } else {
1467         pin.buffer_id = pktbuf_save(ofconn->pktbuf, pin.packet, pin.packet_len,
1468                                     pin.fmd.in_port);
1469     }
1470
1471     /* Figure out how much of the packet to send. */
1472     if (pin.reason == OFPR_NO_MATCH) {
1473         pin.send_len = pin.packet_len;
1474     } else {
1475         /* Caller should have initialized 'send_len' to 'max_len' specified in
1476          * output action. */
1477     }
1478     if (pin.buffer_id != UINT32_MAX) {
1479         pin.send_len = MIN(pin.send_len, ofconn->miss_send_len);
1480     }
1481
1482     /* Make OFPT_PACKET_IN and hand over to packet scheduler.  It might
1483      * immediately call into do_send_packet_in() or it might buffer it for a
1484      * while (until a later call to pinsched_run()). */
1485     pinsched_send(ofconn->schedulers[pin.reason == OFPR_NO_MATCH ? 0 : 1],
1486                   pin.fmd.in_port,
1487                   ofputil_encode_packet_in(&pin, ofconn_get_protocol(ofconn),
1488                                            ofconn->packet_in_format),
1489                   do_send_packet_in, ofconn);
1490 }
1491 \f
1492 /* Fail-open settings. */
1493
1494 /* Returns the failure handling mode (OFPROTO_FAIL_SECURE or
1495  * OFPROTO_FAIL_STANDALONE) for 'mgr'. */
1496 enum ofproto_fail_mode
1497 connmgr_get_fail_mode(const struct connmgr *mgr)
1498 {
1499     return mgr->fail_mode;
1500 }
1501
1502 /* Sets the failure handling mode for 'mgr' to 'fail_mode' (either
1503  * OFPROTO_FAIL_SECURE or OFPROTO_FAIL_STANDALONE). */
1504 void
1505 connmgr_set_fail_mode(struct connmgr *mgr, enum ofproto_fail_mode fail_mode)
1506 {
1507     if (mgr->fail_mode != fail_mode) {
1508         mgr->fail_mode = fail_mode;
1509         update_fail_open(mgr);
1510         if (!connmgr_has_controllers(mgr)) {
1511             ofproto_flush_flows(mgr->ofproto);
1512         }
1513     }
1514 }
1515 \f
1516 /* Fail-open implementation. */
1517
1518 /* Returns the longest probe interval among the primary controllers configured
1519  * on 'mgr'.  Returns 0 if there are no primary controllers. */
1520 int
1521 connmgr_get_max_probe_interval(const struct connmgr *mgr)
1522 {
1523     const struct ofconn *ofconn;
1524     int max_probe_interval;
1525
1526     max_probe_interval = 0;
1527     HMAP_FOR_EACH (ofconn, hmap_node, &mgr->controllers) {
1528         int probe_interval = rconn_get_probe_interval(ofconn->rconn);
1529         max_probe_interval = MAX(max_probe_interval, probe_interval);
1530     }
1531     return max_probe_interval;
1532 }
1533
1534 /* Returns the number of seconds for which all of 'mgr's primary controllers
1535  * have been disconnected.  Returns 0 if 'mgr' has no primary controllers. */
1536 int
1537 connmgr_failure_duration(const struct connmgr *mgr)
1538 {
1539     const struct ofconn *ofconn;
1540     int min_failure_duration;
1541
1542     if (!connmgr_has_controllers(mgr)) {
1543         return 0;
1544     }
1545
1546     min_failure_duration = INT_MAX;
1547     HMAP_FOR_EACH (ofconn, hmap_node, &mgr->controllers) {
1548         int failure_duration = rconn_failure_duration(ofconn->rconn);
1549         min_failure_duration = MIN(min_failure_duration, failure_duration);
1550     }
1551     return min_failure_duration;
1552 }
1553
1554 /* Returns true if at least one primary controller is connected (regardless of
1555  * whether those controllers are believed to have authenticated and accepted
1556  * this switch), false if none of them are connected. */
1557 bool
1558 connmgr_is_any_controller_connected(const struct connmgr *mgr)
1559 {
1560     const struct ofconn *ofconn;
1561
1562     HMAP_FOR_EACH (ofconn, hmap_node, &mgr->controllers) {
1563         if (rconn_is_connected(ofconn->rconn)) {
1564             return true;
1565         }
1566     }
1567     return false;
1568 }
1569
1570 /* Returns true if at least one primary controller is believed to have
1571  * authenticated and accepted this switch, false otherwise. */
1572 bool
1573 connmgr_is_any_controller_admitted(const struct connmgr *mgr)
1574 {
1575     const struct ofconn *ofconn;
1576
1577     HMAP_FOR_EACH (ofconn, hmap_node, &mgr->controllers) {
1578         if (rconn_is_admitted(ofconn->rconn)) {
1579             return true;
1580         }
1581     }
1582     return false;
1583 }
1584 \f
1585 /* In-band configuration. */
1586
1587 static bool any_extras_changed(const struct connmgr *,
1588                                const struct sockaddr_in *extras, size_t n);
1589
1590 /* Sets the 'n' TCP port addresses in 'extras' as ones to which 'mgr''s
1591  * in-band control should guarantee access, in the same way that in-band
1592  * control guarantees access to OpenFlow controllers. */
1593 void
1594 connmgr_set_extra_in_band_remotes(struct connmgr *mgr,
1595                                   const struct sockaddr_in *extras, size_t n)
1596 {
1597     if (!any_extras_changed(mgr, extras, n)) {
1598         return;
1599     }
1600
1601     free(mgr->extra_in_band_remotes);
1602     mgr->n_extra_remotes = n;
1603     mgr->extra_in_band_remotes = xmemdup(extras, n * sizeof *extras);
1604
1605     update_in_band_remotes(mgr);
1606 }
1607
1608 /* Sets the OpenFlow queue used by flows set up by in-band control on
1609  * 'mgr' to 'queue_id'.  If 'queue_id' is negative, then in-band control
1610  * flows will use the default queue. */
1611 void
1612 connmgr_set_in_band_queue(struct connmgr *mgr, int queue_id)
1613 {
1614     if (queue_id != mgr->in_band_queue) {
1615         mgr->in_band_queue = queue_id;
1616         update_in_band_remotes(mgr);
1617     }
1618 }
1619
1620 static bool
1621 any_extras_changed(const struct connmgr *mgr,
1622                    const struct sockaddr_in *extras, size_t n)
1623 {
1624     size_t i;
1625
1626     if (n != mgr->n_extra_remotes) {
1627         return true;
1628     }
1629
1630     for (i = 0; i < n; i++) {
1631         const struct sockaddr_in *old = &mgr->extra_in_band_remotes[i];
1632         const struct sockaddr_in *new = &extras[i];
1633
1634         if (old->sin_addr.s_addr != new->sin_addr.s_addr ||
1635             old->sin_port != new->sin_port) {
1636             return true;
1637         }
1638     }
1639
1640     return false;
1641 }
1642 \f
1643 /* In-band implementation. */
1644
1645 bool
1646 connmgr_must_output_local(struct connmgr *mgr, const struct flow *flow,
1647                           uint32_t local_odp_port,
1648                           const struct nlattr *odp_actions,
1649                           size_t actions_len)
1650 {
1651     return !mgr->in_band || in_band_rule_check(flow, local_odp_port,
1652                                                odp_actions, actions_len);
1653 }
1654 \f
1655 /* Fail-open and in-band implementation. */
1656
1657 /* Called by 'ofproto' after all flows have been flushed, to allow fail-open
1658  * and standalone mode to re-create their flows.
1659  *
1660  * In-band control has more sophisticated code that manages flows itself. */
1661 void
1662 connmgr_flushed(struct connmgr *mgr)
1663 {
1664     if (mgr->fail_open) {
1665         fail_open_flushed(mgr->fail_open);
1666     }
1667
1668     /* If there are no controllers and we're in standalone mode, set up a flow
1669      * that matches every packet and directs them to OFPP_NORMAL (which goes to
1670      * us).  Otherwise, the switch is in secure mode and we won't pass any
1671      * traffic until a controller has been defined and it tells us to do so. */
1672     if (!connmgr_has_controllers(mgr)
1673         && mgr->fail_mode == OFPROTO_FAIL_STANDALONE) {
1674         struct ofpbuf ofpacts;
1675         struct match match;
1676
1677         ofpbuf_init(&ofpacts, OFPACT_OUTPUT_SIZE);
1678         ofpact_put_OUTPUT(&ofpacts)->port = OFPP_NORMAL;
1679         ofpact_pad(&ofpacts);
1680
1681         match_init_catchall(&match);
1682         ofproto_add_flow(mgr->ofproto, &match, 0, ofpacts.data, ofpacts.size);
1683
1684         ofpbuf_uninit(&ofpacts);
1685     }
1686 }
1687 \f
1688 /* Creates a new ofservice for 'target' in 'mgr'.  Returns 0 if successful,
1689  * otherwise a positive errno value.
1690  *
1691  * ofservice_reconfigure() must be called to fully configure the new
1692  * ofservice. */
1693 static int
1694 ofservice_create(struct connmgr *mgr, const char *target,
1695                  uint32_t allowed_versions, uint8_t dscp)
1696 {
1697     struct ofservice *ofservice;
1698     struct pvconn *pvconn;
1699     int error;
1700
1701     error = pvconn_open(target, allowed_versions, dscp, &pvconn);
1702     if (error) {
1703         return error;
1704     }
1705
1706     ofservice = xzalloc(sizeof *ofservice);
1707     hmap_insert(&mgr->services, &ofservice->node, hash_string(target, 0));
1708     ofservice->pvconn = pvconn;
1709     ofservice->allowed_versions = allowed_versions;
1710
1711     return 0;
1712 }
1713
1714 static void
1715 ofservice_destroy(struct connmgr *mgr, struct ofservice *ofservice)
1716 {
1717     hmap_remove(&mgr->services, &ofservice->node);
1718     pvconn_close(ofservice->pvconn);
1719     free(ofservice);
1720 }
1721
1722 static void
1723 ofservice_reconfigure(struct ofservice *ofservice,
1724                       const struct ofproto_controller *c)
1725 {
1726     ofservice->probe_interval = c->probe_interval;
1727     ofservice->rate_limit = c->rate_limit;
1728     ofservice->burst_limit = c->burst_limit;
1729     ofservice->enable_async_msgs = c->enable_async_msgs;
1730     ofservice->dscp = c->dscp;
1731 }
1732
1733 /* Finds and returns the ofservice within 'mgr' that has the given
1734  * 'target', or a null pointer if none exists. */
1735 static struct ofservice *
1736 ofservice_lookup(struct connmgr *mgr, const char *target)
1737 {
1738     struct ofservice *ofservice;
1739
1740     HMAP_FOR_EACH_WITH_HASH (ofservice, node, hash_string(target, 0),
1741                              &mgr->services) {
1742         if (!strcmp(pvconn_get_name(ofservice->pvconn), target)) {
1743             return ofservice;
1744         }
1745     }
1746     return NULL;
1747 }
1748 \f
1749 /* Flow monitors (NXST_FLOW_MONITOR). */
1750
1751 /* A counter incremented when something significant happens to an OpenFlow
1752  * rule.
1753  *
1754  *     - When a rule is added, its 'add_seqno' and 'modify_seqno' are set to
1755  *       the current value (which is then incremented).
1756  *
1757  *     - When a rule is modified, its 'modify_seqno' is set to the current
1758  *       value (which is then incremented).
1759  *
1760  * Thus, by comparing an old value of monitor_seqno against a rule's
1761  * 'add_seqno', one can tell whether the rule was added before or after the old
1762  * value was read, and similarly for 'modify_seqno'.
1763  *
1764  * 32 bits should normally be sufficient (and would be nice, to save space in
1765  * each rule) but then we'd have to have some special cases for wraparound.
1766  *
1767  * We initialize monitor_seqno to 1 to allow 0 to be used as an invalid
1768  * value. */
1769 static uint64_t monitor_seqno = 1;
1770
1771 COVERAGE_DEFINE(ofmonitor_pause);
1772 COVERAGE_DEFINE(ofmonitor_resume);
1773
1774 enum ofperr
1775 ofmonitor_create(const struct ofputil_flow_monitor_request *request,
1776                  struct ofconn *ofconn, struct ofmonitor **monitorp)
1777 {
1778     struct ofmonitor *m;
1779
1780     *monitorp = NULL;
1781
1782     m = ofmonitor_lookup(ofconn, request->id);
1783     if (m) {
1784         return OFPERR_NXBRC_FM_DUPLICATE_ID;
1785     }
1786
1787     m = xmalloc(sizeof *m);
1788     m->ofconn = ofconn;
1789     hmap_insert(&ofconn->monitors, &m->ofconn_node, hash_int(request->id, 0));
1790     m->id = request->id;
1791     m->flags = request->flags;
1792     m->out_port = request->out_port;
1793     m->table_id = request->table_id;
1794     minimatch_init(&m->match, &request->match);
1795
1796     *monitorp = m;
1797     return 0;
1798 }
1799
1800 struct ofmonitor *
1801 ofmonitor_lookup(struct ofconn *ofconn, uint32_t id)
1802 {
1803     struct ofmonitor *m;
1804
1805     HMAP_FOR_EACH_IN_BUCKET (m, ofconn_node, hash_int(id, 0),
1806                              &ofconn->monitors) {
1807         if (m->id == id) {
1808             return m;
1809         }
1810     }
1811     return NULL;
1812 }
1813
1814 void
1815 ofmonitor_destroy(struct ofmonitor *m)
1816 {
1817     if (m) {
1818         minimatch_destroy(&m->match);
1819         hmap_remove(&m->ofconn->monitors, &m->ofconn_node);
1820         free(m);
1821     }
1822 }
1823
1824 void
1825 ofmonitor_report(struct connmgr *mgr, struct rule *rule,
1826                  enum nx_flow_update_event event,
1827                  enum ofp_flow_removed_reason reason,
1828                  const struct ofconn *abbrev_ofconn, ovs_be32 abbrev_xid)
1829 {
1830     enum nx_flow_monitor_flags update;
1831     struct ofconn *ofconn;
1832
1833     switch (event) {
1834     case NXFME_ADDED:
1835         update = NXFMF_ADD;
1836         rule->add_seqno = rule->modify_seqno = monitor_seqno++;
1837         break;
1838
1839     case NXFME_DELETED:
1840         update = NXFMF_DELETE;
1841         break;
1842
1843     case NXFME_MODIFIED:
1844         update = NXFMF_MODIFY;
1845         rule->modify_seqno = monitor_seqno++;
1846         break;
1847
1848     default:
1849     case NXFME_ABBREV:
1850         NOT_REACHED();
1851     }
1852
1853     LIST_FOR_EACH (ofconn, node, &mgr->all_conns) {
1854         enum nx_flow_monitor_flags flags = 0;
1855         struct ofmonitor *m;
1856
1857         if (ofconn->monitor_paused) {
1858             /* Only send NXFME_DELETED notifications for flows that were added
1859              * before we paused. */
1860             if (event != NXFME_DELETED
1861                 || rule->add_seqno > ofconn->monitor_paused) {
1862                 continue;
1863             }
1864         }
1865
1866         HMAP_FOR_EACH (m, ofconn_node, &ofconn->monitors) {
1867             if (m->flags & update
1868                 && (m->table_id == 0xff || m->table_id == rule->table_id)
1869                 && ofoperation_has_out_port(rule->pending, m->out_port)
1870                 && cls_rule_is_loose_match(&rule->cr, &m->match)) {
1871                 flags |= m->flags;
1872             }
1873         }
1874
1875         if (flags) {
1876             if (list_is_empty(&ofconn->updates)) {
1877                 ofputil_start_flow_update(&ofconn->updates);
1878                 ofconn->sent_abbrev_update = false;
1879             }
1880
1881             if (ofconn != abbrev_ofconn || ofconn->monitor_paused) {
1882                 struct ofputil_flow_update fu;
1883                 struct match match;
1884
1885                 fu.event = event;
1886                 fu.reason = event == NXFME_DELETED ? reason : 0;
1887                 fu.idle_timeout = rule->idle_timeout;
1888                 fu.hard_timeout = rule->hard_timeout;
1889                 fu.table_id = rule->table_id;
1890                 fu.cookie = rule->flow_cookie;
1891                 minimatch_expand(&rule->cr.match, &match);
1892                 fu.match = &match;
1893                 fu.priority = rule->cr.priority;
1894                 if (flags & NXFMF_ACTIONS) {
1895                     fu.ofpacts = rule->ofpacts;
1896                     fu.ofpacts_len = rule->ofpacts_len;
1897                 } else {
1898                     fu.ofpacts = NULL;
1899                     fu.ofpacts_len = 0;
1900                 }
1901                 ofputil_append_flow_update(&fu, &ofconn->updates);
1902             } else if (!ofconn->sent_abbrev_update) {
1903                 struct ofputil_flow_update fu;
1904
1905                 fu.event = NXFME_ABBREV;
1906                 fu.xid = abbrev_xid;
1907                 ofputil_append_flow_update(&fu, &ofconn->updates);
1908
1909                 ofconn->sent_abbrev_update = true;
1910             }
1911         }
1912     }
1913 }
1914
1915 void
1916 ofmonitor_flush(struct connmgr *mgr)
1917 {
1918     struct ofconn *ofconn;
1919
1920     LIST_FOR_EACH (ofconn, node, &mgr->all_conns) {
1921         struct ofpbuf *msg, *next;
1922
1923         LIST_FOR_EACH_SAFE (msg, next, list_node, &ofconn->updates) {
1924             list_remove(&msg->list_node);
1925             ofconn_send(ofconn, msg, ofconn->monitor_counter);
1926             if (!ofconn->monitor_paused
1927                 && ofconn->monitor_counter->n_bytes > 128 * 1024) {
1928                 struct ofpbuf *pause;
1929
1930                 COVERAGE_INC(ofmonitor_pause);
1931                 ofconn->monitor_paused = monitor_seqno++;
1932                 pause = ofpraw_alloc_xid(OFPRAW_NXT_FLOW_MONITOR_PAUSED,
1933                                          OFP10_VERSION, htonl(0), 0);
1934                 ofconn_send(ofconn, pause, ofconn->monitor_counter);
1935             }
1936         }
1937     }
1938 }
1939
1940 static void
1941 ofmonitor_resume(struct ofconn *ofconn)
1942 {
1943     struct ofpbuf *resumed;
1944     struct ofmonitor *m;
1945     struct list rules;
1946     struct list msgs;
1947
1948     list_init(&rules);
1949     HMAP_FOR_EACH (m, ofconn_node, &ofconn->monitors) {
1950         ofmonitor_collect_resume_rules(m, ofconn->monitor_paused, &rules);
1951     }
1952
1953     list_init(&msgs);
1954     ofmonitor_compose_refresh_updates(&rules, &msgs);
1955
1956     resumed = ofpraw_alloc_xid(OFPRAW_NXT_FLOW_MONITOR_RESUMED, OFP10_VERSION,
1957                                htonl(0), 0);
1958     list_push_back(&msgs, &resumed->list_node);
1959     ofconn_send_replies(ofconn, &msgs);
1960
1961     ofconn->monitor_paused = 0;
1962 }
1963
1964 static void
1965 ofmonitor_run(struct connmgr *mgr)
1966 {
1967     struct ofconn *ofconn;
1968
1969     LIST_FOR_EACH (ofconn, node, &mgr->all_conns) {
1970         if (ofconn->monitor_paused && !ofconn->monitor_counter->n_packets) {
1971             COVERAGE_INC(ofmonitor_resume);
1972             ofmonitor_resume(ofconn);
1973         }
1974     }
1975 }
1976
1977 static void
1978 ofmonitor_wait(struct connmgr *mgr)
1979 {
1980     struct ofconn *ofconn;
1981
1982     LIST_FOR_EACH (ofconn, node, &mgr->all_conns) {
1983         if (ofconn->monitor_paused && !ofconn->monitor_counter->n_packets) {
1984             poll_immediate_wake();
1985         }
1986     }
1987 }