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