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/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     /* In S_ACTIVE and S_IDLE, probably_admitted reports whether we believe
  96      * that the peer has made a (positive) admission control decision on our
  97      * connection.  If we have not yet been (probably) admitted, then the
  98      * connection does not reset the timer used for deciding whether the switch
  99      * should go into fail-open mode.
 100      *
 101      * last_admitted reports the last time we believe such a positive admission
 102      * control decision was made. */
 103     bool probably_admitted;
 104     time_t last_admitted;
 105
 106     /* These values are simply for statistics reporting, not used directly by
 107      * anything internal to the rconn (or the secchan for that matter). */
 108     unsigned int packets_received;
 109     unsigned int n_attempted_connections, n_successful_connections;
 110     time_t creation_time;
 111     unsigned long int total_time_connected;
 112
 113     /* If we can't connect to the peer, it could be for any number of reasons.
 114      * Usually, one would assume it is because the peer is not running or
 115      * because the network is partitioned.  But it could also be because the
 116      * network topology has changed, in which case the upper layer will need to
 117      * reassess it (in particular, obtain a new IP address via DHCP and find
 118      * the new location of the controller).  We set this flag when we suspect
 119      * that this could be the case. */
 120     bool questionable_connectivity;
 121     time_t last_questioned;
 122
 123     /* Throughout this file, "probe" is shorthand for "inactivity probe".
 124      * When nothing has been received from the peer for a while, we send out
 125      * an echo request as an inactivity probe packet.  We should receive back
 126      * a response. */
 127     int probe_interval;         /* Secs of inactivity before sending probe. */
 128
 129     /* Messages sent or received are copied to the monitor connections. */
 130 #define MAX_MONITORS 8
 131     struct vconn *monitors[8];
 132     size_t n_monitors;
 133 };
 134
 135 static unsigned int elapsed_in_this_state(const struct rconn *);
 136 static unsigned int timeout(const struct rconn *);
 137 static bool timed_out(const struct rconn *);
 138 static void state_transition(struct rconn *, enum state);
 139 static int try_send(struct rconn *);
 140 static int reconnect(struct rconn *);
 141 static void disconnect(struct rconn *, int error);
 142 static void flush_queue(struct rconn *);
 143 static void question_connectivity(struct rconn *);
 144 static void copy_to_monitor(struct rconn *, const struct ofpbuf *);
 145 static bool is_connected_state(enum state);
 146 static bool is_admitted_msg(const struct ofpbuf *);
 147
 148 /* Creates a new rconn, connects it (reliably) to 'name', and returns it. */
 149 struct rconn *
 150 rconn_new(const char *name, int inactivity_probe_interval, int max_backoff)
 151 {
 152     struct rconn *rc = rconn_create(inactivity_probe_interval, max_backoff);
 153     rconn_connect(rc, name);
 154     return rc;
 155 }
 156
 157 /* Creates a new rconn, connects it (unreliably) to 'vconn', and returns it. */
 158 struct rconn *
 159 rconn_new_from_vconn(const char *name, struct vconn *vconn)
 160 {
 161     struct rconn *rc = rconn_create(60, 0);
 162     rconn_connect_unreliably(rc, name, vconn);
 163     return rc;
 164 }
 165
 166 /* Creates and returns a new rconn.
 167  *
 168  * 'probe_interval' is a number of seconds.  If the interval passes once
 169  * without an OpenFlow message being received from the peer, the rconn sends
 170  * out an "echo request" message.  If the interval passes again without a
 171  * message being received, the rconn disconnects and re-connects to the peer.
 172  * Setting 'probe_interval' to 0 disables this behavior.
 173  *
 174  * 'max_backoff' is the maximum number of seconds between attempts to connect
 175  * to the peer.  The actual interval starts at 1 second and doubles on each
 176  * failure until it reaches 'max_backoff'.  If 0 is specified, the default of
 177  * 60 seconds is used. */
 178 struct rconn *
 179 rconn_create(int probe_interval, int max_backoff)
 180 {
 181     struct rconn *rc = xcalloc(1, sizeof *rc);
 182
 183     rc->state = S_VOID;
 184     rc->state_entered = time_now();
 185
 186     rc->vconn = NULL;
 187     rc->name = xstrdup("void");
 188     rc->reliable = false;
 189
 190     queue_init(&rc->txq);
 191
 192     rc->backoff = 0;
 193     rc->max_backoff = max_backoff ? max_backoff : 60;
 194     rc->backoff_deadline = TIME_MIN;
 195     rc->last_received = time_now();
 196     rc->last_connected = time_now();
 197
 198     rc->packets_sent = 0;
 199
 200     rc->probably_admitted = false;
 201     rc->last_admitted = time_now();
 202
 203     rc->packets_received = 0;
 204     rc->n_attempted_connections = 0;
 205     rc->n_successful_connections = 0;
 206     rc->creation_time = time_now();
 207     rc->total_time_connected = 0;
 208
 209     rc->questionable_connectivity = false;
 210     rc->last_questioned = time_now();
 211
 212     rc->probe_interval = probe_interval ? MAX(5, probe_interval) : 0;
 213
 214     rc->n_monitors = 0;
 215
 216     return rc;
 217 }
 218
 219 int
 220 rconn_connect(struct rconn *rc, const char *name)
 221 {
 222     rconn_disconnect(rc);
 223     free(rc->name);
 224     rc->name = xstrdup(name);
 225     rc->reliable = true;
 226     return reconnect(rc);
 227 }
 228
 229 void
 230 rconn_connect_unreliably(struct rconn *rc,
 231                          const char *name, struct vconn *vconn)
 232 {
 233     assert(vconn != NULL);
 234     rconn_disconnect(rc);
 235     free(rc->name);
 236     rc->name = xstrdup(name);
 237     rc->reliable = false;
 238     rc->vconn = vconn;
 239     rc->last_connected = time_now();
 240     state_transition(rc, S_ACTIVE);
 241 }
 242
 243 void
 244 rconn_disconnect(struct rconn *rc)
 245 {
 246     if (rc->state != S_VOID) {
 247         if (rc->vconn) {
 248             vconn_close(rc->vconn);
 249             rc->vconn = NULL;
 250         }
 251         free(rc->name);
 252         rc->name = xstrdup("void");
 253         rc->reliable = false;
 254
 255         rc->backoff = 0;
 256         rc->backoff_deadline = TIME_MIN;
 257
 258         state_transition(rc, S_VOID);
 259     }
 260 }
 261
 262 /* Disconnects 'rc' and frees the underlying storage. */
 263 void
 264 rconn_destroy(struct rconn *rc)
 265 {
 266     if (rc) {
 267         free(rc->name);
 268         vconn_close(rc->vconn);
 269         flush_queue(rc);
 270         queue_destroy(&rc->txq);
 271         free(rc);
 272     }
 273 }
 274
 275 static unsigned int
 276 timeout_VOID(const struct rconn *rc)
 277 {
 278     return UINT_MAX;
 279 }
 280
 281 static void
 282 run_VOID(struct rconn *rc)
 283 {
 284     /* Nothing to do. */
 285 }
 286
 287 static int
 288 reconnect(struct rconn *rc)
 289 {
 290     int retval;
 291
 292     VLOG_WARN("%s: connecting...", rc->name);
 293     rc->n_attempted_connections++;
 294     retval = vconn_open(rc->name, OFP_VERSION, &rc->vconn);
 295     if (!retval) {
 296         rc->backoff_deadline = time_now() + rc->backoff;
 297         state_transition(rc, S_CONNECTING);
 298     } else {
 299         VLOG_WARN("%s: connection failed (%s)", rc->name, strerror(retval));
 300         rc->backoff_deadline = TIME_MAX; /* Prevent resetting backoff. */
 301         disconnect(rc, 0);
 302     }
 303     return retval;
 304 }
 305
 306 static unsigned int
 307 timeout_BACKOFF(const struct rconn *rc)
 308 {
 309     return rc->backoff;
 310 }
 311
 312 static void
 313 run_BACKOFF(struct rconn *rc)
 314 {
 315     if (timed_out(rc)) {
 316         reconnect(rc);
 317     }
 318 }
 319
 320 static unsigned int
 321 timeout_CONNECTING(const struct rconn *rc)
 322 {
 323     return MAX(1, rc->backoff);
 324 }
 325
 326 static void
 327 run_CONNECTING(struct rconn *rc)
 328 {
 329     int retval = vconn_connect(rc->vconn);
 330     if (!retval) {
 331         VLOG_WARN("%s: connected", rc->name);
 332         rc->n_successful_connections++;
 333         state_transition(rc, S_ACTIVE);
 334         rc->last_connected = rc->state_entered;
 335     } else if (retval != EAGAIN) {
 336         VLOG_WARN("%s: connection failed (%s)", rc->name, strerror(retval));
 337         disconnect(rc, retval);
 338     } else if (timed_out(rc)) {
 339         VLOG_WARN("%s: connection timed out", rc->name);
 340         rc->backoff_deadline = TIME_MAX; /* Prevent resetting backoff. */
 341         disconnect(rc, 0);
 342     }
 343 }
 344
 345 static void
 346 do_tx_work(struct rconn *rc)
 347 {
 348     if (!rc->txq.n) {
 349         return;
 350     }
 351     while (rc->txq.n > 0) {
 352         int error = try_send(rc);
 353         if (error) {
 354             break;
 355         }
 356     }
 357     if (!rc->txq.n) {
 358         poll_immediate_wake();
 359     }
 360 }
 361
 362 static unsigned int
 363 timeout_ACTIVE(const struct rconn *rc)
 364 {
 365     if (rc->probe_interval) {
 366         unsigned int base = MAX(rc->last_received, rc->state_entered);
 367         unsigned int arg = base + rc->probe_interval - rc->state_entered;
 368         return arg;
 369     }
 370     return UINT_MAX;
 371 }
 372
 373 static void
 374 run_ACTIVE(struct rconn *rc)
 375 {
 376     if (timed_out(rc)) {
 377         unsigned int base = MAX(rc->last_received, rc->state_entered);
 378         rconn_send(rc, make_echo_request(), NULL);
 379         VLOG_DBG("%s: idle %u seconds, sending inactivity probe",
 380                  rc->name, (unsigned int) (time_now() - base));
 381         state_transition(rc, S_IDLE);
 382         return;
 383     }
 384
 385     do_tx_work(rc);
 386 }
 387
 388 static unsigned int
 389 timeout_IDLE(const struct rconn *rc)
 390 {
 391     return rc->probe_interval;
 392 }
 393
 394 static void
 395 run_IDLE(struct rconn *rc)
 396 {
 397     if (timed_out(rc)) {
 398         question_connectivity(rc);
 399         VLOG_ERR("%s: no response to inactivity probe after %u "
 400                  "seconds, disconnecting",
 401                  rc->name, elapsed_in_this_state(rc));
 402         disconnect(rc, 0);
 403     } else {
 404         do_tx_work(rc);
 405     }
 406 }
 407
 408 /* Performs whatever activities are necessary to maintain 'rc': if 'rc' is
 409  * disconnected, attempts to (re)connect, backing off as necessary; if 'rc' is
 410  * connected, attempts to send packets in the send queue, if any. */
 411 void
 412 rconn_run(struct rconn *rc)
 413 {
 414     int old_state;
 415     do {
 416         old_state = rc->state;
 417         switch (rc->state) {
 418 #define STATE(NAME, VALUE) case S_##NAME: run_##NAME(rc); break;
 419             STATES
 420 #undef STATE
 421         default:
 422             NOT_REACHED();
 423         }
 424     } while (rc->state != old_state);
 425 }
 426
 427 /* Causes the next call to poll_block() to wake up when rconn_run() should be
 428  * called on 'rc'. */
 429 void
 430 rconn_run_wait(struct rconn *rc)
 431 {
 432     unsigned int timeo = timeout(rc);
 433     if (timeo != UINT_MAX) {
 434         unsigned int expires = sat_add(rc->state_entered, timeo);
 435         unsigned int remaining = sat_sub(expires, time_now());
 436         poll_timer_wait(sat_mul(remaining, 1000));
 437     }
 438
 439     if ((rc->state & (S_ACTIVE | S_IDLE)) && rc->txq.n) {
 440         vconn_wait(rc->vconn, WAIT_SEND);
 441     }
 442 }
 443
 444 /* Attempts to receive a packet from 'rc'.  If successful, returns the packet;
 445  * otherwise, returns a null pointer.  The caller is responsible for freeing
 446  * the packet (with ofpbuf_delete()). */
 447 struct ofpbuf *
 448 rconn_recv(struct rconn *rc)
 449 {
 450     if (rc->state & (S_ACTIVE | S_IDLE)) {
 451         struct ofpbuf *buffer;
 452         int error = vconn_recv(rc->vconn, &buffer);
 453         if (!error) {
 454             copy_to_monitor(rc, buffer);
 455             if (is_admitted_msg(buffer)
 456                 || time_now() - rc->last_connected >= 30) {
 457                 rc->probably_admitted = true;
 458                 rc->last_admitted = time_now();
 459             }
 460             rc->last_received = time_now();
 461             rc->packets_received++;
 462             if (rc->state == S_IDLE) {
 463                 state_transition(rc, S_ACTIVE);
 464             }
 465             return buffer;
 466         } else if (error != EAGAIN) {
 467             disconnect(rc, error);
 468         }
 469     }
 470     return NULL;
 471 }
 472
 473 /* Causes the next call to poll_block() to wake up when a packet may be ready
 474  * to be received by vconn_recv() on 'rc'.  */
 475 void
 476 rconn_recv_wait(struct rconn *rc)
 477 {
 478     if (rc->vconn) {
 479         vconn_wait(rc->vconn, WAIT_RECV);
 480     }
 481 }
 482
 483 /* Sends 'b' on 'rc'.  Returns 0 if successful (in which case 'b' is
 484  * destroyed), or ENOTCONN if 'rc' is not currently connected (in which case
 485  * the caller retains ownership of 'b').
 486  *
 487  * If 'n_queued' is non-null, then '*n_queued' will be incremented while the
 488  * packet is in flight, then decremented when it has been sent (or discarded
 489  * due to disconnection).  Because 'b' may be sent (or discarded) before this
 490  * function returns, the caller may not be able to observe any change in
 491  * '*n_queued'.
 492  *
 493  * There is no rconn_send_wait() function: an rconn has a send queue that it
 494  * takes care of sending if you call rconn_run(), which will have the side
 495  * effect of waking up poll_block(). */
 496 int
 497 rconn_send(struct rconn *rc, struct ofpbuf *b, int *n_queued)
 498 {
 499     if (rconn_is_connected(rc)) {
 500         copy_to_monitor(rc, b);
 501         b->private = n_queued;
 502         if (n_queued) {
 503             ++*n_queued;
 504         }
 505         queue_push_tail(&rc->txq, b);
 506         if (rc->txq.n == 1) {
 507             try_send(rc);
 508         }
 509         return 0;
 510     } else {
 511         return ENOTCONN;
 512     }
 513 }
 514
 515 /* Sends 'b' on 'rc'.  Increments '*n_queued' while the packet is in flight; it
 516  * will be decremented when it has been sent (or discarded due to
 517  * disconnection).  Returns 0 if successful, EAGAIN if '*n_queued' is already
 518  * at least as large as 'queue_limit', or ENOTCONN if 'rc' is not currently
 519  * connected.  Regardless of return value, 'b' is destroyed.
 520  *
 521  * Because 'b' may be sent (or discarded) before this function returns, the
 522  * caller may not be able to observe any change in '*n_queued'.
 523  *
 524  * There is no rconn_send_wait() function: an rconn has a send queue that it
 525  * takes care of sending if you call rconn_run(), which will have the side
 526  * effect of waking up poll_block(). */
 527 int
 528 rconn_send_with_limit(struct rconn *rc, struct ofpbuf *b,
 529                       int *n_queued, int queue_limit)
 530 {
 531     int retval;
 532     retval = *n_queued >= queue_limit ? EAGAIN : rconn_send(rc, b, n_queued);
 533     if (retval) {
 534         ofpbuf_delete(b);
 535     }
 536     return retval;
 537 }
 538
 539 /* Returns the total number of packets successfully sent on the underlying
 540  * vconn.  A packet is not counted as sent while it is still queued in the
 541  * rconn, only when it has been successfuly passed to the vconn.  */
 542 unsigned int
 543 rconn_packets_sent(const struct rconn *rc)
 544 {
 545     return rc->packets_sent;
 546 }
 547
 548 /* Adds 'vconn' to 'rc' as a monitoring connection, to which all messages sent
 549  * and received on 'rconn' will be copied.  'rc' takes ownership of 'vconn'. */
 550 void
 551 rconn_add_monitor(struct rconn *rc, struct vconn *vconn)
 552 {
 553     if (rc->n_monitors < ARRAY_SIZE(rc->monitors)) {
 554         VLOG_WARN("new monitor connection from %s", vconn_get_name(vconn));
 555         rc->monitors[rc->n_monitors++] = vconn;
 556     } else {
 557         VLOG_DBG("too many monitor connections, discarding %s",
 558                  vconn_get_name(vconn));
 559         vconn_close(vconn);
 560     }
 561 }
 562
 563 /* Returns 'rc''s name (the 'name' argument passed to rconn_new()). */
 564 const char *
 565 rconn_get_name(const struct rconn *rc)
 566 {
 567     return rc->name;
 568 }
 569
 570 /* Returns true if 'rconn' is connected or in the process of reconnecting,
 571  * false if 'rconn' is disconnected and will not reconnect on its own. */
 572 bool
 573 rconn_is_alive(const struct rconn *rconn)
 574 {
 575     return rconn->state != S_VOID;
 576 }
 577
 578 /* Returns true if 'rconn' is connected, false otherwise. */
 579 bool
 580 rconn_is_connected(const struct rconn *rconn)
 581 {
 582     return is_connected_state(rconn->state);
 583 }
 584
 585 /* Returns 0 if 'rconn' is connected.  Otherwise, if 'rconn' is in a "failure
 586  * mode" (that is, it is not connected), returns the number of seconds that it
 587  * has been in failure mode, ignoring any times that it connected but the
 588  * controller's admission control policy caused it to be quickly
 589  * disconnected. */
 590 int
 591 rconn_failure_duration(const struct rconn *rconn)
 592 {
 593     return rconn_is_connected(rconn) ? 0 : time_now() - rconn->last_admitted;
 594 }
 595
 596 /* Returns the IP address of the peer, or 0 if the peer is not connected over
 597  * an IP-based protocol or if its IP address is not known. */
 598 uint32_t
 599 rconn_get_ip(const struct rconn *rconn)
 600 {
 601     return rconn->vconn ? vconn_get_ip(rconn->vconn) : 0;
 602 }
 603
 604 /* If 'rconn' can't connect to the peer, it could be for any number of reasons.
 605  * Usually, one would assume it is because the peer is not running or because
 606  * the network is partitioned.  But it could also be because the network
 607  * topology has changed, in which case the upper layer will need to reassess it
 608  * (in particular, obtain a new IP address via DHCP and find the new location
 609  * of the controller).  When this appears that this might be the case, this
 610  * function returns true.  It also clears the questionability flag and prevents
 611  * it from being set again for some time. */
 612 bool
 613 rconn_is_connectivity_questionable(struct rconn *rconn)
 614 {
 615     bool questionable = rconn->questionable_connectivity;
 616     rconn->questionable_connectivity = false;
 617     return questionable;
 618 }
 619
 620 /* Returns the total number of packets successfully received by the underlying
 621  * vconn.  */
 622 unsigned int
 623 rconn_packets_received(const struct rconn *rc)
 624 {
 625     return rc->packets_received;
 626 }
 627
 628 /* Returns a string representing the internal state of 'rc'.  The caller must
 629  * not modify or free the string. */
 630 const char *
 631 rconn_get_state(const struct rconn *rc)
 632 {
 633     return state_name(rc->state);
 634 }
 635
 636 /* Returns the number of connection attempts made by 'rc', including any
 637  * ongoing attempt that has not yet succeeded or failed. */
 638 unsigned int
 639 rconn_get_attempted_connections(const struct rconn *rc)
 640 {
 641     return rc->n_attempted_connections;
 642 }
 643
 644 /* Returns the number of successful connection attempts made by 'rc'. */
 645 unsigned int
 646 rconn_get_successful_connections(const struct rconn *rc)
 647 {
 648     return rc->n_successful_connections;
 649 }
 650
 651 /* Returns the time at which the last successful connection was made by
 652  * 'rc'. */
 653 time_t
 654 rconn_get_last_connection(const struct rconn *rc)
 655 {
 656     return rc->last_connected;
 657 }
 658
 659 /* Returns the time at which 'rc' was created. */
 660 time_t
 661 rconn_get_creation_time(const struct rconn *rc)
 662 {
 663     return rc->creation_time;
 664 }
 665
 666 /* Returns the approximate number of seconds that 'rc' has been connected. */
 667 unsigned long int
 668 rconn_get_total_time_connected(const struct rconn *rc)
 669 {
 670     return (rc->total_time_connected
 671             + (rconn_is_connected(rc) ? elapsed_in_this_state(rc) : 0));
 672 }
 673
 674 /* Returns the current amount of backoff, in seconds.  This is the amount of
 675  * time after which the rconn will transition from BACKOFF to CONNECTING. */
 676 int
 677 rconn_get_backoff(const struct rconn *rc)
 678 {
 679     return rc->backoff;
 680 }
 681
 682 /* Returns the number of seconds spent in this state so far. */
 683 unsigned int
 684 rconn_get_state_elapsed(const struct rconn *rc)
 685 {
 686     return elapsed_in_this_state(rc);
 687 }
 688 \f
 689 /* Tries to send a packet from 'rc''s send buffer.  Returns 0 if successful,
 690  * otherwise a positive errno value. */
 691 static int
 692 try_send(struct rconn *rc)
 693 {
 694     int retval = 0;
 695     struct ofpbuf *next = rc->txq.head->next;
 696     int *n_queued = rc->txq.head->private;
 697     retval = vconn_send(rc->vconn, rc->txq.head);
 698     if (retval) {
 699         if (retval != EAGAIN) {
 700             disconnect(rc, retval);
 701         }
 702         return retval;
 703     }
 704     rc->packets_sent++;
 705     if (n_queued) {
 706         --*n_queued;
 707     }
 708     queue_advance_head(&rc->txq, next);
 709     return 0;
 710 }
 711
 712 /* Disconnects 'rc'.  'error' is used only for logging purposes.  If it is
 713  * nonzero, then it should be EOF to indicate the connection was closed by the
 714  * peer in a normal fashion or a positive errno value. */
 715 static void
 716 disconnect(struct rconn *rc, int error)
 717 {
 718     if (rc->reliable) {
 719         time_t now = time_now();
 720
 721         if (rc->state & (S_CONNECTING | S_ACTIVE | S_IDLE)) {
 722             if (error > 0) {
 723                 VLOG_WARN("%s: connection dropped (%s)",
 724                           rc->name, strerror(error));
 725             } else if (error == EOF) {
 726                 if (rc->reliable) {
 727                     VLOG_WARN("%s: connection closed by peer", rc->name);
 728                 }
 729             } else {
 730                 VLOG_WARN("%s: connection dropped", rc->name);
 731             }
 732             vconn_close(rc->vconn);
 733             rc->vconn = NULL;
 734             flush_queue(rc);
 735         }
 736
 737         if (now >= rc->backoff_deadline) {
 738             rc->backoff = 1;
 739         } else {
 740             rc->backoff = MIN(rc->max_backoff, MAX(1, 2 * rc->backoff));
 741             VLOG_WARN("%s: waiting %d seconds before reconnect\n",
 742                       rc->name, rc->backoff);
 743         }
 744         rc->backoff_deadline = now + rc->backoff;
 745         state_transition(rc, S_BACKOFF);
 746         if (now - rc->last_connected > 60) {
 747             question_connectivity(rc);
 748         }
 749     } else {
 750         rconn_disconnect(rc);
 751     }
 752 }
 753
 754 /* Drops all the packets from 'rc''s send queue and decrements their queue
 755  * counts. */
 756 static void
 757 flush_queue(struct rconn *rc)
 758 {
 759     if (!rc->txq.n) {
 760         return;
 761     }
 762     while (rc->txq.n > 0) {
 763         struct ofpbuf *b = queue_pop_head(&rc->txq);
 764         int *n_queued = b->private;
 765         if (n_queued) {
 766             --*n_queued;
 767         }
 768         ofpbuf_delete(b);
 769     }
 770     poll_immediate_wake();
 771 }
 772
 773 static unsigned int
 774 elapsed_in_this_state(const struct rconn *rc)
 775 {
 776     return time_now() - rc->state_entered;
 777 }
 778
 779 static unsigned int
 780 timeout(const struct rconn *rc)
 781 {
 782     switch (rc->state) {
 783 #define STATE(NAME, VALUE) case S_##NAME: return timeout_##NAME(rc);
 784         STATES
 785 #undef STATE
 786     default:
 787         NOT_REACHED();
 788     }
 789 }
 790
 791 static bool
 792 timed_out(const struct rconn *rc)
 793 {
 794     return time_now() >= sat_add(rc->state_entered, timeout(rc));
 795 }
 796
 797 static void
 798 state_transition(struct rconn *rc, enum state state)
 799 {
 800     if (is_connected_state(state) && !is_connected_state(rc->state)) {
 801         rc->probably_admitted = false;
 802     }
 803     if (rconn_is_connected(rc)) {
 804         rc->total_time_connected += elapsed_in_this_state(rc);
 805     }
 806     VLOG_DBG("%s: entering %s", rc->name, state_name(state));
 807     rc->state = state;
 808     rc->state_entered = time_now();
 809 }
 810
 811 static void
 812 question_connectivity(struct rconn *rc)
 813 {
 814     time_t now = time_now();
 815     if (now - rc->last_questioned > 60) {
 816         rc->questionable_connectivity = true;
 817         rc->last_questioned = now;
 818     }
 819 }
 820
 821 static void
 822 copy_to_monitor(struct rconn *rc, const struct ofpbuf *b)
 823 {
 824     struct ofpbuf *clone = NULL;
 825     int retval;
 826     size_t i;
 827
 828     for (i = 0; i < rc->n_monitors; ) {
 829         struct vconn *vconn = rc->monitors[i];
 830
 831         if (!clone) {
 832             clone = ofpbuf_clone(b);
 833         }
 834         retval = vconn_send(vconn, clone);
 835         if (!retval) {
 836             clone = NULL;
 837         } else if (retval != EAGAIN) {
 838             VLOG_DBG("%s: closing monitor connection to %s: %s",
 839                      rconn_get_name(rc), vconn_get_name(vconn),
 840                      strerror(retval));
 841             rc->monitors[i] = rc->monitors[--rc->n_monitors];
 842             continue;
 843         }
 844         i++;
 845     }
 846     ofpbuf_delete(clone);
 847 }
 848
 849 static bool
 850 is_connected_state(enum state state)
 851 {
 852     return (state & (S_ACTIVE | S_IDLE)) != 0;
 853 }
 854
 855 static bool
 856 is_admitted_msg(const struct ofpbuf *b)
 857 {
 858     struct ofp_header *oh = b->data;
 859     uint8_t type = oh->type;
 860     return !(type < 32
 861              && (1u << type) & ((1u << OFPT_HELLO) |
 862                                 (1u << OFPT_ERROR) |
 863                                 (1u << OFPT_ECHO_REQUEST) |
 864                                 (1u << OFPT_ECHO_REPLY) |
 865                                 (1u << OFPT_VENDOR) |
 866                                 (1u << OFPT_FEATURES_REQUEST) |
 867                                 (1u << OFPT_FEATURES_REPLY) |
 868                                 (1u << OFPT_GET_CONFIG_REQUEST) |
 869                                 (1u << OFPT_GET_CONFIG_REPLY) |
 870                                 (1u << OFPT_SET_CONFIG)));
 871 }