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