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