lib/rconn.c

   1 /* Copyright (c) 2008 The Board of Trustees of The Leland Stanford
   2  * Junior University
   3  *
   4  * We are making the OpenFlow specification and associated documentation
   5  * (Software) available for public use and benefit with the expectation
   6  * that others will use, modify and enhance the Software and contribute
   7  * those enhancements back to the community. However, since we would
   8  * like to make the Software available for broadest use, with as few
   9  * restrictions as possible permission is hereby granted, free of
  10  * charge, to any person obtaining a copy of this Software to deal in
  11  * the Software under the copyrights without restriction, including
  12  * without limitation the rights to use, copy, modify, merge, publish,
  13  * distribute, sublicense, and/or sell copies of the Software, and to
  14  * permit persons to whom the Software is furnished to do so, subject to
  15  * the following conditions:
  16  *
  17  * The above copyright notice and this permission notice shall be
  18  * included in all copies or substantial portions of the Software.
  19  *
  20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  21  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  22  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  23  * NONINFRINGEMENT.  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  24  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  25  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  26  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  27  * SOFTWARE.
  28  *
  29  * The name and trademarks of copyright holder(s) may NOT be used in
  30  * advertising or publicity pertaining to the Software or any
  31  * derivatives without specific, written prior permission.
  32  */
  33
  34 #include <config.h>
  35 #include "rconn.h"
  36 #include <assert.h>
  37 #include <errno.h>
  38 #include <limits.h>
  39 #include <stdlib.h>
  40 #include <string.h>
  41 #include "ofpbuf.h"
  42 #include "openflow.h"
  43 #include "poll-loop.h"
  44 #include "sat-math.h"
  45 #include "timeval.h"
  46 #include "util.h"
  47 #include "vconn.h"
  48
  49 #define THIS_MODULE VLM_rconn
  50 #include "vlog.h"
  51
  52 #define STATES                                  \
  53     STATE(VOID, 1 << 0)                         \
  54     STATE(BACKOFF, 1 << 1)                      \
  55     STATE(CONNECTING, 1 << 2)                   \
  56     STATE(ACTIVE, 1 << 3)                       \
  57     STATE(IDLE, 1 << 4)
  58 enum state {
  59 #define STATE(NAME, VALUE) S_##NAME = VALUE,
  60     STATES
  61 #undef STATE
  62 };
  63
  64 static const char *
  65 state_name(enum state state)
  66 {
  67     switch (state) {
  68 #define STATE(NAME, VALUE) case S_##NAME: return #NAME;
  69         STATES
  70 #undef STATE
  71     }
  72     return "***ERROR***";
  73 }
  74
  75 /* A reliable connection to an OpenFlow switch or controller.
  76  *
  77  * See the large comment in rconn.h for more information. */
  78 struct rconn {
  79     enum state state;
  80     time_t state_entered;
  81
  82     struct vconn *vconn;
  83     char *name;
  84     bool reliable;
  85
  86     struct ofp_queue txq;
  87
  88     int backoff;
  89     int max_backoff;
  90     time_t backoff_deadline;
  91     time_t last_received;
  92     time_t last_connected;
  93     unsigned int packets_sent;
  94
  95     /* These values are simply for statistics reporting, not used directly by
  96      * anything internal to the rconn (or the secchan for that matter). */
  97     unsigned int packets_received;
  98     unsigned int n_attempted_connections, n_successful_connections;
  99     time_t creation_time;
 100     unsigned long int total_time_connected;
 101
 102     /* If we can't connect to the peer, it could be for any number of reasons.
 103      * Usually, one would assume it is because the peer is not running or
 104      * because the network is partitioned.  But it could also be because the
 105      * network topology has changed, in which case the upper layer will need to
 106      * reassess it (in particular, obtain a new IP address via DHCP and find
 107      * the new location of the controller).  We set this flag when we suspect
 108      * that this could be the case. */
 109     bool questionable_connectivity;
 110     time_t last_questioned;
 111
 112     /* Throughout this file, "probe" is shorthand for "inactivity probe".
 113      * When nothing has been received from the peer for a while, we send out
 114      * an echo request as an inactivity probe packet.  We should receive back
 115      * a response. */
 116     int probe_interval;         /* Secs of inactivity before sending probe. */
 117
 118     /* Messages sent or received are copied to the monitor connections. */
 119 #define MAX_MONITORS 8
 120     struct vconn *monitors[8];
 121     size_t n_monitors;
 122 };
 123
 124 static unsigned int elapsed_in_this_state(const struct rconn *);
 125 static unsigned int timeout(const struct rconn *);
 126 static bool timed_out(const struct rconn *);
 127 static void state_transition(struct rconn *, enum state);
 128 static int try_send(struct rconn *);
 129 static int reconnect(struct rconn *);
 130 static void disconnect(struct rconn *, int error);
 131 static void flush_queue(struct rconn *);
 132 static void question_connectivity(struct rconn *);
 133 static void copy_to_monitor(struct rconn *, const struct ofpbuf *);
 134
 135 /* Creates a new rconn, connects it (reliably) to 'name', and returns it. */
 136 struct rconn *
 137 rconn_new(const char *name, int inactivity_probe_interval, int max_backoff)
 138 {
 139     struct rconn *rc = rconn_create(inactivity_probe_interval, max_backoff);
 140     rconn_connect(rc, name);
 141     return rc;
 142 }
 143
 144 /* Creates a new rconn, connects it (unreliably) to 'vconn', and returns it. */
 145 struct rconn *
 146 rconn_new_from_vconn(const char *name, struct vconn *vconn)
 147 {
 148     struct rconn *rc = rconn_create(60, 0);
 149     rconn_connect_unreliably(rc, name, vconn);
 150     return rc;
 151 }
 152
 153 /* Creates and returns a new rconn.
 154  *
 155  * 'probe_interval' is a number of seconds.  If the interval passes once
 156  * without an OpenFlow message being received from the peer, the rconn sends
 157  * out an "echo request" message.  If the interval passes again without a
 158  * message being received, the rconn disconnects and re-connects to the peer.
 159  * Setting 'probe_interval' to 0 disables this behavior.
 160  *
 161  * 'max_backoff' is the maximum number of seconds between attempts to connect
 162  * to the peer.  The actual interval starts at 1 second and doubles on each
 163  * failure until it reaches 'max_backoff'.  If 0 is specified, the default of
 164  * 60 seconds is used. */
 165 struct rconn *
 166 rconn_create(int probe_interval, int max_backoff)
 167 {
 168     struct rconn *rc = xcalloc(1, sizeof *rc);
 169
 170     rc->state = S_VOID;
 171     rc->state_entered = time_now();
 172
 173     rc->vconn = NULL;
 174     rc->name = xstrdup("void");
 175     rc->reliable = false;
 176
 177     queue_init(&rc->txq);
 178
 179     rc->backoff = 0;
 180     rc->max_backoff = max_backoff ? max_backoff : 60;
 181     rc->backoff_deadline = TIME_MIN;
 182     rc->last_received = time_now();
 183     rc->last_connected = time_now();
 184
 185     rc->packets_sent = 0;
 186
 187     rc->packets_received = 0;
 188     rc->n_attempted_connections = 0;
 189     rc->n_successful_connections = 0;
 190     rc->creation_time = time_now();
 191     rc->total_time_connected = 0;
 192
 193     rc->questionable_connectivity = false;
 194     rc->last_questioned = time_now();
 195
 196     rc->probe_interval = probe_interval ? MAX(5, probe_interval) : 0;
 197
 198     rc->n_monitors = 0;
 199
 200     return rc;
 201 }
 202
 203 int
 204 rconn_connect(struct rconn *rc, const char *name)
 205 {
 206     rconn_disconnect(rc);
 207     free(rc->name);
 208     rc->name = xstrdup(name);
 209     rc->reliable = true;
 210     return reconnect(rc);
 211 }
 212
 213 void
 214 rconn_connect_unreliably(struct rconn *rc,
 215                          const char *name, struct vconn *vconn)
 216 {
 217     assert(vconn != NULL);
 218     rconn_disconnect(rc);
 219     free(rc->name);
 220     rc->name = xstrdup(name);
 221     rc->reliable = false;
 222     rc->vconn = vconn;
 223     rc->last_connected = time_now();
 224     state_transition(rc, S_ACTIVE);
 225 }
 226
 227 void
 228 rconn_disconnect(struct rconn *rc)
 229 {
 230     if (rc->vconn) {
 231         vconn_close(rc->vconn);
 232         rc->vconn = NULL;
 233     }
 234     free(rc->name);
 235     rc->name = xstrdup("void");
 236     rc->reliable = false;
 237
 238     rc->backoff = 0;
 239     rc->backoff_deadline = TIME_MIN;
 240
 241     state_transition(rc, S_VOID);
 242 }
 243
 244 /* Disconnects 'rc' and frees the underlying storage. */
 245 void
 246 rconn_destroy(struct rconn *rc)
 247 {
 248     if (rc) {
 249         free(rc->name);
 250         vconn_close(rc->vconn);
 251         flush_queue(rc);
 252         queue_destroy(&rc->txq);
 253         free(rc);
 254     }
 255 }
 256
 257 static unsigned int
 258 timeout_VOID(const struct rconn *rc)
 259 {
 260     return UINT_MAX;
 261 }
 262
 263 static void
 264 run_VOID(struct rconn *rc)
 265 {
 266     /* Nothing to do. */
 267 }
 268
 269 static int
 270 reconnect(struct rconn *rc)
 271 {
 272     int retval;
 273
 274     VLOG_WARN("%s: connecting...", rc->name);
 275     rc->n_attempted_connections++;
 276     retval = vconn_open(rc->name, OFP_VERSION, &rc->vconn);
 277     if (!retval) {
 278         rc->backoff_deadline = time_now() + rc->backoff;
 279         state_transition(rc, S_CONNECTING);
 280     } else {
 281         VLOG_WARN("%s: connection failed (%s)", rc->name, strerror(retval));
 282         disconnect(rc, 0);
 283     }
 284     return retval;
 285 }
 286
 287 static unsigned int
 288 timeout_BACKOFF(const struct rconn *rc)
 289 {
 290     return rc->backoff;
 291 }
 292
 293 static void
 294 run_BACKOFF(struct rconn *rc)
 295 {
 296     if (timed_out(rc)) {
 297         reconnect(rc);
 298     }
 299 }
 300
 301 static unsigned int
 302 timeout_CONNECTING(const struct rconn *rc)
 303 {
 304     return MAX(1, rc->backoff);
 305 }
 306
 307 static void
 308 run_CONNECTING(struct rconn *rc)
 309 {
 310     int retval = vconn_connect(rc->vconn);
 311     if (!retval) {
 312         VLOG_WARN("%s: connected", rc->name);
 313         rc->n_successful_connections++;
 314         state_transition(rc, S_ACTIVE);
 315         rc->last_connected = rc->state_entered;
 316     } else if (retval != EAGAIN) {
 317         VLOG_WARN("%s: connection failed (%s)", rc->name, strerror(retval));
 318         disconnect(rc, retval);
 319     } else if (timed_out(rc)) {
 320         VLOG_WARN("%s: connection timed out", rc->name);
 321         rc->backoff_deadline = TIME_MAX; /* Prevent resetting backoff. */
 322         disconnect(rc, 0);
 323     }
 324 }
 325
 326 static void
 327 do_tx_work(struct rconn *rc)
 328 {
 329     if (!rc->txq.n) {
 330         return;
 331     }
 332     while (rc->txq.n > 0) {
 333         int error = try_send(rc);
 334         if (error) {
 335             break;
 336         }
 337     }
 338     if (!rc->txq.n) {
 339         poll_immediate_wake();
 340     }
 341 }
 342
 343 static unsigned int
 344 timeout_ACTIVE(const struct rconn *rc)
 345 {
 346     if (rc->probe_interval) {
 347         unsigned int base = MAX(rc->last_received, rc->state_entered);
 348         unsigned int arg = base + rc->probe_interval - rc->state_entered;
 349         return arg;
 350     }
 351     return UINT_MAX;
 352 }
 353
 354 static void
 355 run_ACTIVE(struct rconn *rc)
 356 {
 357     if (timed_out(rc)) {
 358         unsigned int base = MAX(rc->last_received, rc->state_entered);
 359         rconn_send(rc, make_echo_request(), NULL);
 360         VLOG_DBG("%s: idle %u seconds, sending inactivity probe",
 361                  rc->name, (unsigned int) (time_now() - base));
 362         state_transition(rc, S_IDLE);
 363         return;
 364     }
 365
 366     do_tx_work(rc);
 367 }
 368
 369 static unsigned int
 370 timeout_IDLE(const struct rconn *rc)
 371 {
 372     return rc->probe_interval;
 373 }
 374
 375 static void
 376 run_IDLE(struct rconn *rc)
 377 {
 378     if (timed_out(rc)) {
 379         question_connectivity(rc);
 380         VLOG_ERR("%s: no response to inactivity probe after %u "
 381                  "seconds, disconnecting",
 382                  rc->name, elapsed_in_this_state(rc));
 383         disconnect(rc, 0);
 384     } else {
 385         do_tx_work(rc);
 386     }
 387 }
 388
 389 /* Performs whatever activities are necessary to maintain 'rc': if 'rc' is
 390  * disconnected, attempts to (re)connect, backing off as necessary; if 'rc' is
 391  * connected, attempts to send packets in the send queue, if any. */
 392 void
 393 rconn_run(struct rconn *rc)
 394 {
 395     int old_state;
 396     do {
 397         old_state = rc->state;
 398         switch (rc->state) {
 399 #define STATE(NAME, VALUE) case S_##NAME: run_##NAME(rc); break;
 400             STATES
 401 #undef STATE
 402         default:
 403             NOT_REACHED();
 404         }
 405     } while (rc->state != old_state);
 406 }
 407
 408 /* Causes the next call to poll_block() to wake up when rconn_run() should be
 409  * called on 'rc'. */
 410 void
 411 rconn_run_wait(struct rconn *rc)
 412 {
 413     unsigned int timeo = timeout(rc);
 414     if (timeo != UINT_MAX) {
 415         unsigned int expires = sat_add(rc->state_entered, timeo);
 416         unsigned int remaining = sat_sub(expires, time_now());
 417         poll_timer_wait(sat_mul(remaining, 1000));
 418     }
 419
 420     if ((rc->state & (S_ACTIVE | S_IDLE)) && rc->txq.n) {
 421         vconn_wait(rc->vconn, WAIT_SEND);
 422     }
 423 }
 424
 425 /* Attempts to receive a packet from 'rc'.  If successful, returns the packet;
 426  * otherwise, returns a null pointer.  The caller is responsible for freeing
 427  * the packet (with ofpbuf_delete()). */
 428 struct ofpbuf *
 429 rconn_recv(struct rconn *rc)
 430 {
 431     if (rc->state & (S_ACTIVE | S_IDLE)) {
 432         struct ofpbuf *buffer;
 433         int error = vconn_recv(rc->vconn, &buffer);
 434         if (!error) {
 435             copy_to_monitor(rc, buffer);
 436             rc->last_received = time_now();
 437             rc->packets_received++;
 438             if (rc->state == S_IDLE) {
 439                 state_transition(rc, S_ACTIVE);
 440             }
 441             return buffer;
 442         } else if (error != EAGAIN) {
 443             disconnect(rc, error);
 444         }
 445     }
 446     return NULL;
 447 }
 448
 449 /* Causes the next call to poll_block() to wake up when a packet may be ready
 450  * to be received by vconn_recv() on 'rc'.  */
 451 void
 452 rconn_recv_wait(struct rconn *rc)
 453 {
 454     if (rc->vconn) {
 455         vconn_wait(rc->vconn, WAIT_RECV);
 456     }
 457 }
 458
 459 /* Sends 'b' on 'rc'.  Returns 0 if successful (in which case 'b' is
 460  * destroyed), or ENOTCONN if 'rc' is not currently connected (in which case
 461  * the caller retains ownership of 'b').
 462  *
 463  * If 'n_queued' is non-null, then '*n_queued' will be incremented while the
 464  * packet is in flight, then decremented when it has been sent (or discarded
 465  * due to disconnection).  Because 'b' may be sent (or discarded) before this
 466  * function returns, the caller may not be able to observe any change in
 467  * '*n_queued'.
 468  *
 469  * There is no rconn_send_wait() function: an rconn has a send queue that it
 470  * takes care of sending if you call rconn_run(), which will have the side
 471  * effect of waking up poll_block(). */
 472 int
 473 rconn_send(struct rconn *rc, struct ofpbuf *b, int *n_queued)
 474 {
 475     if (rconn_is_connected(rc)) {
 476         copy_to_monitor(rc, b);
 477         b->private = n_queued;
 478         if (n_queued) {
 479             ++*n_queued;
 480         }
 481         queue_push_tail(&rc->txq, b);
 482         if (rc->txq.n == 1) {
 483             try_send(rc);
 484         }
 485         return 0;
 486     } else {
 487         return ENOTCONN;
 488     }
 489 }
 490
 491 /* Sends 'b' on 'rc'.  Increments '*n_queued' while the packet is in flight; it
 492  * will be decremented when it has been sent (or discarded due to
 493  * disconnection).  Returns 0 if successful, EAGAIN if '*n_queued' is already
 494  * at least as large as 'queue_limit', or ENOTCONN if 'rc' is not currently
 495  * connected.  Regardless of return value, 'b' is destroyed.
 496  *
 497  * Because 'b' may be sent (or discarded) before this function returns, the
 498  * caller may not be able to observe any change in '*n_queued'.
 499  *
 500  * There is no rconn_send_wait() function: an rconn has a send queue that it
 501  * takes care of sending if you call rconn_run(), which will have the side
 502  * effect of waking up poll_block(). */
 503 int
 504 rconn_send_with_limit(struct rconn *rc, struct ofpbuf *b,
 505                       int *n_queued, int queue_limit)
 506 {
 507     int retval;
 508     retval = *n_queued >= queue_limit ? EAGAIN : rconn_send(rc, b, n_queued);
 509     if (retval) {
 510         ofpbuf_delete(b);
 511     }
 512     return retval;
 513 }
 514
 515 /* Returns the total number of packets successfully sent on the underlying
 516  * vconn.  A packet is not counted as sent while it is still queued in the
 517  * rconn, only when it has been successfuly passed to the vconn.  */
 518 unsigned int
 519 rconn_packets_sent(const struct rconn *rc)
 520 {
 521     return rc->packets_sent;
 522 }
 523
 524 /* Adds 'vconn' to 'rc' as a monitoring connection, to which all messages sent
 525  * and received on 'rconn' will be copied.  'rc' takes ownership of 'vconn'. */
 526 void
 527 rconn_add_monitor(struct rconn *rc, struct vconn *vconn)
 528 {
 529     if (rc->n_monitors < ARRAY_SIZE(rc->monitors)) {
 530         VLOG_WARN("new monitor connection from %s", vconn_get_name(vconn));
 531         rc->monitors[rc->n_monitors++] = vconn;
 532     } else {
 533         VLOG_DBG("too many monitor connections, discarding %s",
 534                  vconn_get_name(vconn));
 535         vconn_close(vconn);
 536     }
 537 }
 538
 539 /* Returns 'rc''s name (the 'name' argument passed to rconn_new()). */
 540 const char *
 541 rconn_get_name(const struct rconn *rc)
 542 {
 543     return rc->name;
 544 }
 545
 546 /* Returns true if 'rconn' is connected or in the process of reconnecting,
 547  * false if 'rconn' is disconnected and will not reconnect on its own. */
 548 bool
 549 rconn_is_alive(const struct rconn *rconn)
 550 {
 551     return rconn->state != S_VOID;
 552 }
 553
 554 /* Returns true if 'rconn' is connected, false otherwise. */
 555 bool
 556 rconn_is_connected(const struct rconn *rconn)
 557 {
 558     return rconn->state & (S_ACTIVE | S_IDLE);
 559 }
 560
 561 /* Returns 0 if 'rconn' is connected, otherwise the number of seconds that it
 562  * has been disconnected. */
 563 int
 564 rconn_disconnected_duration(const struct rconn *rconn)
 565 {
 566     return rconn_is_connected(rconn) ? 0 : time_now() - rconn->last_received;
 567 }
 568
 569 /* Returns the IP address of the peer, or 0 if the peer is not connected over
 570  * an IP-based protocol or if its IP address is not known. */
 571 uint32_t
 572 rconn_get_ip(const struct rconn *rconn)
 573 {
 574     return rconn->vconn ? vconn_get_ip(rconn->vconn) : 0;
 575 }
 576
 577 /* If 'rconn' can't connect to the peer, it could be for any number of reasons.
 578  * Usually, one would assume it is because the peer is not running or because
 579  * the network is partitioned.  But it could also be because the network
 580  * topology has changed, in which case the upper layer will need to reassess it
 581  * (in particular, obtain a new IP address via DHCP and find the new location
 582  * of the controller).  When this appears that this might be the case, this
 583  * function returns true.  It also clears the questionability flag and prevents
 584  * it from being set again for some time. */
 585 bool
 586 rconn_is_connectivity_questionable(struct rconn *rconn)
 587 {
 588     bool questionable = rconn->questionable_connectivity;
 589     rconn->questionable_connectivity = false;
 590     return questionable;
 591 }
 592
 593 /* Returns the total number of packets successfully received by the underlying
 594  * vconn.  */
 595 unsigned int
 596 rconn_packets_received(const struct rconn *rc)
 597 {
 598     return rc->packets_received;
 599 }
 600
 601 /* Returns a string representing the internal state of 'rc'.  The caller must
 602  * not modify or free the string. */
 603 const char *
 604 rconn_get_state(const struct rconn *rc)
 605 {
 606     return state_name(rc->state);
 607 }
 608
 609 /* Returns the number of connection attempts made by 'rc', including any
 610  * ongoing attempt that has not yet succeeded or failed. */
 611 unsigned int
 612 rconn_get_attempted_connections(const struct rconn *rc)
 613 {
 614     return rc->n_attempted_connections;
 615 }
 616
 617 /* Returns the number of successful connection attempts made by 'rc'. */
 618 unsigned int
 619 rconn_get_successful_connections(const struct rconn *rc)
 620 {
 621     return rc->n_successful_connections;
 622 }
 623
 624 /* Returns the time at which the last successful connection was made by
 625  * 'rc'. */
 626 time_t
 627 rconn_get_last_connection(const struct rconn *rc)
 628 {
 629     return rc->last_connected;
 630 }
 631
 632 /* Returns the time at which 'rc' was created. */
 633 time_t
 634 rconn_get_creation_time(const struct rconn *rc)
 635 {
 636     return rc->creation_time;
 637 }
 638
 639 /* Returns the approximate number of seconds that 'rc' has been connected. */
 640 unsigned long int
 641 rconn_get_total_time_connected(const struct rconn *rc)
 642 {
 643     return (rc->total_time_connected
 644             + (rconn_is_connected(rc) ? elapsed_in_this_state(rc) : 0));
 645 }
 646
 647 /* Returns the current amount of backoff, in seconds.  This is the amount of
 648  * time after which the rconn will transition from BACKOFF to CONNECTING. */
 649 int
 650 rconn_get_backoff(const struct rconn *rc)
 651 {
 652     return rc->backoff;
 653 }
 654
 655 /* Returns the number of seconds spent in this state so far. */
 656 unsigned int
 657 rconn_get_state_elapsed(const struct rconn *rc)
 658 {
 659     return elapsed_in_this_state(rc);
 660 }
 661 \f
 662 /* Tries to send a packet from 'rc''s send buffer.  Returns 0 if successful,
 663  * otherwise a positive errno value. */
 664 static int
 665 try_send(struct rconn *rc)
 666 {
 667     int retval = 0;
 668     struct ofpbuf *next = rc->txq.head->next;
 669     int *n_queued = rc->txq.head->private;
 670     retval = vconn_send(rc->vconn, rc->txq.head);
 671     if (retval) {
 672         if (retval != EAGAIN) {
 673             disconnect(rc, retval);
 674         }
 675         return retval;
 676     }
 677     rc->packets_sent++;
 678     if (n_queued) {
 679         --*n_queued;
 680     }
 681     queue_advance_head(&rc->txq, next);
 682     return 0;
 683 }
 684
 685 /* Disconnects 'rc'.  'error' is used only for logging purposes.  If it is
 686  * nonzero, then it should be EOF to indicate the connection was closed by the
 687  * peer in a normal fashion or a positive errno value. */
 688 static void
 689 disconnect(struct rconn *rc, int error)
 690 {
 691     if (rc->reliable) {
 692         time_t now = time_now();
 693
 694         if (rc->state & (S_CONNECTING | S_ACTIVE | S_IDLE)) {
 695             if (error > 0) {
 696                 VLOG_WARN("%s: connection dropped (%s)",
 697                           rc->name, strerror(error));
 698             } else if (error == EOF) {
 699                 if (rc->reliable) {
 700                     VLOG_WARN("%s: connection closed", rc->name);
 701                 }
 702             } else {
 703                 VLOG_WARN("%s: connection dropped", rc->name);
 704             }
 705             vconn_close(rc->vconn);
 706             rc->vconn = NULL;
 707             flush_queue(rc);
 708         }
 709
 710         if (now >= rc->backoff_deadline) {
 711             rc->backoff = 1;
 712         } else {
 713             rc->backoff = MIN(rc->max_backoff, MAX(1, 2 * rc->backoff));
 714             VLOG_WARN("%s: waiting %d seconds before reconnect\n",
 715                       rc->name, rc->backoff);
 716         }
 717         rc->backoff_deadline = now + rc->backoff;
 718         state_transition(rc, S_BACKOFF);
 719         if (now - rc->last_connected > 60) {
 720             question_connectivity(rc);
 721         }
 722     } else {
 723         rconn_disconnect(rc);
 724     }
 725 }
 726
 727 /* Drops all the packets from 'rc''s send queue and decrements their queue
 728  * counts. */
 729 static void
 730 flush_queue(struct rconn *rc)
 731 {
 732     if (!rc->txq.n) {
 733         return;
 734     }
 735     while (rc->txq.n > 0) {
 736         struct ofpbuf *b = queue_pop_head(&rc->txq);
 737         int *n_queued = b->private;
 738         if (n_queued) {
 739             --*n_queued;
 740         }
 741         ofpbuf_delete(b);
 742     }
 743     poll_immediate_wake();
 744 }
 745
 746 static unsigned int
 747 elapsed_in_this_state(const struct rconn *rc)
 748 {
 749     return time_now() - rc->state_entered;
 750 }
 751
 752 static unsigned int
 753 timeout(const struct rconn *rc)
 754 {
 755     switch (rc->state) {
 756 #define STATE(NAME, VALUE) case S_##NAME: return timeout_##NAME(rc);
 757         STATES
 758 #undef STATE
 759     default:
 760         NOT_REACHED();
 761     }
 762 }
 763
 764 static bool
 765 timed_out(const struct rconn *rc)
 766 {
 767     return time_now() >= sat_add(rc->state_entered, timeout(rc));
 768 }
 769
 770 static void
 771 state_transition(struct rconn *rc, enum state state)
 772 {
 773     if (rconn_is_connected(rc)) {
 774         rc->total_time_connected += elapsed_in_this_state(rc);
 775     }
 776     VLOG_DBG("%s: entering %s", rc->name, state_name(state));
 777     rc->state = state;
 778     rc->state_entered = time_now();
 779 }
 780
 781 static void
 782 question_connectivity(struct rconn *rc)
 783 {
 784     time_t now = time_now();
 785     if (now - rc->last_questioned > 60) {
 786         rc->questionable_connectivity = true;
 787         rc->last_questioned = now;
 788     }
 789 }
 790
 791 static void
 792 copy_to_monitor(struct rconn *rc, const struct ofpbuf *b)
 793 {
 794     struct ofpbuf *clone = NULL;
 795     int retval;
 796     size_t i;
 797
 798     for (i = 0; i < rc->n_monitors; ) {
 799         struct vconn *vconn = rc->monitors[i];
 800
 801         if (!clone) {
 802             clone = ofpbuf_clone(b);
 803         }
 804         retval = vconn_send(vconn, clone);
 805         if (!retval) {
 806             clone = NULL;
 807         } else if (retval != EAGAIN) {
 808             VLOG_DBG("%s: closing monitor connection to %s: %s",
 809                      rconn_get_name(rc), vconn_get_name(vconn),
 810                      strerror(retval));
 811             rc->monitors[i] = rc->monitors[--rc->n_monitors];
 812             continue;
 813         }
 814         i++;
 815     }
 816     ofpbuf_delete(clone);
 817 }