lib/rconn.c

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011, 2012 Nicira, Inc.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #include <config.h>
  18 #include "rconn.h"
  19 #include <assert.h>
  20 #include <errno.h>
  21 #include <limits.h>
  22 #include <stdlib.h>
  23 #include <string.h>
  24 #include "coverage.h"
  25 #include "ofp-util.h"
  26 #include "ofpbuf.h"
  27 #include "openflow/openflow.h"
  28 #include "poll-loop.h"
  29 #include "sat-math.h"
  30 #include "timeval.h"
  31 #include "util.h"
  32 #include "vconn.h"
  33 #include "vlog.h"
  34
  35 VLOG_DEFINE_THIS_MODULE(rconn);
  36
  37 COVERAGE_DEFINE(rconn_discarded);
  38 COVERAGE_DEFINE(rconn_overflow);
  39 COVERAGE_DEFINE(rconn_queued);
  40 COVERAGE_DEFINE(rconn_sent);
  41
  42 #define STATES                                  \
  43     STATE(VOID, 1 << 0)                         \
  44     STATE(BACKOFF, 1 << 1)                      \
  45     STATE(CONNECTING, 1 << 2)                   \
  46     STATE(ACTIVE, 1 << 3)                       \
  47     STATE(IDLE, 1 << 4)
  48 enum state {
  49 #define STATE(NAME, VALUE) S_##NAME = VALUE,
  50     STATES
  51 #undef STATE
  52 };
  53
  54 static const char *
  55 state_name(enum state state)
  56 {
  57     switch (state) {
  58 #define STATE(NAME, VALUE) case S_##NAME: return #NAME;
  59         STATES
  60 #undef STATE
  61     }
  62     return "***ERROR***";
  63 }
  64
  65 /* A reliable connection to an OpenFlow switch or controller.
  66  *
  67  * See the large comment in rconn.h for more information. */
  68 struct rconn {
  69     enum state state;
  70     time_t state_entered;
  71
  72     struct vconn *vconn;
  73     char *name;                 /* Human-readable descriptive name. */
  74     char *target;               /* vconn name, passed to vconn_open(). */
  75     bool reliable;
  76
  77     struct list txq;            /* Contains "struct ofpbuf"s. */
  78
  79     int backoff;
  80     int max_backoff;
  81     time_t backoff_deadline;
  82     time_t last_received;
  83     time_t last_connected;
  84     time_t last_disconnected;
  85     unsigned int packets_sent;
  86     unsigned int seqno;
  87     int last_error;
  88
  89     /* In S_ACTIVE and S_IDLE, probably_admitted reports whether we believe
  90      * that the peer has made a (positive) admission control decision on our
  91      * connection.  If we have not yet been (probably) admitted, then the
  92      * connection does not reset the timer used for deciding whether the switch
  93      * should go into fail-open mode.
  94      *
  95      * last_admitted reports the last time we believe such a positive admission
  96      * control decision was made. */
  97     bool probably_admitted;
  98     time_t last_admitted;
  99
 100     /* These values are simply for statistics reporting, not used directly by
 101      * anything internal to the rconn (or ofproto for that matter). */
 102     unsigned int packets_received;
 103     unsigned int n_attempted_connections, n_successful_connections;
 104     time_t creation_time;
 105     unsigned long int total_time_connected;
 106
 107     /* Throughout this file, "probe" is shorthand for "inactivity probe".
 108      * When nothing has been received from the peer for a while, we send out
 109      * an echo request as an inactivity probe packet.  We should receive back
 110      * a response. */
 111     int probe_interval;         /* Secs of inactivity before sending probe. */
 112
 113     /* When we create a vconn we obtain these values, to save them past the end
 114      * of the vconn's lifetime.  Otherwise, in-band control will only allow
 115      * traffic when a vconn is actually open, but it is nice to allow ARP to
 116      * complete even between connection attempts, and it is also polite to
 117      * allow traffic from other switches to go through to the controller
 118      * whether or not we are connected.
 119      *
 120      * We don't cache the local port, because that changes from one connection
 121      * attempt to the next. */
 122     ovs_be32 local_ip, remote_ip;
 123     ovs_be16 remote_port;
 124     uint8_t dscp;
 125
 126     /* Messages sent or received are copied to the monitor connections. */
 127 #define MAX_MONITORS 8
 128     struct vconn *monitors[8];
 129     size_t n_monitors;
 130 };
 131
 132 static unsigned int elapsed_in_this_state(const struct rconn *);
 133 static unsigned int timeout(const struct rconn *);
 134 static bool timed_out(const struct rconn *);
 135 static void state_transition(struct rconn *, enum state);
 136 static void rconn_set_target__(struct rconn *,
 137                                const char *target, const char *name);
 138 static int try_send(struct rconn *);
 139 static void reconnect(struct rconn *);
 140 static void report_error(struct rconn *, int error);
 141 static void disconnect(struct rconn *, int error);
 142 static void flush_queue(struct rconn *);
 143 static void copy_to_monitor(struct rconn *, const struct ofpbuf *);
 144 static bool is_connected_state(enum state);
 145 static bool is_admitted_msg(const struct ofpbuf *);
 146 static bool rconn_logging_connection_attempts__(const struct rconn *);
 147
 148 /* Creates and returns a new rconn.
 149  *
 150  * 'probe_interval' is a number of seconds.  If the interval passes once
 151  * without an OpenFlow message being received from the peer, the rconn sends
 152  * out an "echo request" message.  If the interval passes again without a
 153  * message being received, the rconn disconnects and re-connects to the peer.
 154  * Setting 'probe_interval' to 0 disables this behavior.
 155  *
 156  * 'max_backoff' is the maximum number of seconds between attempts to connect
 157  * to the peer.  The actual interval starts at 1 second and doubles on each
 158  * failure until it reaches 'max_backoff'.  If 0 is specified, the default of
 159  * 8 seconds is used.
 160  *
 161  * The new rconn is initially unconnected.  Use rconn_connect() or
 162  * rconn_connect_unreliably() to connect it. */
 163 struct rconn *
 164 rconn_create(int probe_interval, int max_backoff, uint8_t dscp)
 165 {
 166     struct rconn *rc = xzalloc(sizeof *rc);
 167
 168     rc->state = S_VOID;
 169     rc->state_entered = time_now();
 170
 171     rc->vconn = NULL;
 172     rc->name = xstrdup("void");
 173     rc->target = xstrdup("void");
 174     rc->reliable = false;
 175
 176     list_init(&rc->txq);
 177
 178     rc->backoff = 0;
 179     rc->max_backoff = max_backoff ? max_backoff : 8;
 180     rc->backoff_deadline = TIME_MIN;
 181     rc->last_received = time_now();
 182     rc->last_connected = TIME_MIN;
 183     rc->last_disconnected = TIME_MIN;
 184     rc->seqno = 0;
 185
 186     rc->packets_sent = 0;
 187
 188     rc->probably_admitted = false;
 189     rc->last_admitted = time_now();
 190
 191     rc->packets_received = 0;
 192     rc->n_attempted_connections = 0;
 193     rc->n_successful_connections = 0;
 194     rc->creation_time = time_now();
 195     rc->total_time_connected = 0;
 196
 197     rconn_set_probe_interval(rc, probe_interval);
 198     rconn_set_dscp(rc, dscp);
 199
 200     rc->n_monitors = 0;
 201
 202     return rc;
 203 }
 204
 205 void
 206 rconn_set_max_backoff(struct rconn *rc, int max_backoff)
 207 {
 208     rc->max_backoff = MAX(1, max_backoff);
 209     if (rc->state == S_BACKOFF && rc->backoff > max_backoff) {
 210         rc->backoff = max_backoff;
 211         if (rc->backoff_deadline > time_now() + max_backoff) {
 212             rc->backoff_deadline = time_now() + max_backoff;
 213         }
 214     }
 215 }
 216
 217 int
 218 rconn_get_max_backoff(const struct rconn *rc)
 219 {
 220     return rc->max_backoff;
 221 }
 222
 223 void
 224 rconn_set_dscp(struct rconn *rc, uint8_t dscp)
 225 {
 226     rc->dscp = dscp;
 227 }
 228
 229 void
 230 rconn_set_probe_interval(struct rconn *rc, int probe_interval)
 231 {
 232     rc->probe_interval = probe_interval ? MAX(5, probe_interval) : 0;
 233 }
 234
 235 int
 236 rconn_get_probe_interval(const struct rconn *rc)
 237 {
 238     return rc->probe_interval;
 239 }
 240
 241 /* Drops any existing connection on 'rc', then sets up 'rc' to connect to
 242  * 'target' and reconnect as needed.  'target' should be a remote OpenFlow
 243  * target in a form acceptable to vconn_open().
 244  *
 245  * If 'name' is nonnull, then it is used in log messages in place of 'target'.
 246  * It should presumably give more information to a human reader than 'target',
 247  * but it need not be acceptable to vconn_open(). */
 248 void
 249 rconn_connect(struct rconn *rc, const char *target, const char *name)
 250 {
 251     rconn_disconnect(rc);
 252     rconn_set_target__(rc, target, name);
 253     rc->reliable = true;
 254     reconnect(rc);
 255 }
 256
 257 /* Drops any existing connection on 'rc', then configures 'rc' to use
 258  * 'vconn'.  If the connection on 'vconn' drops, 'rc' will not reconnect on it
 259  * own.
 260  *
 261  * By default, the target obtained from vconn_get_name(vconn) is used in log
 262  * messages.  If 'name' is nonnull, then it is used instead.  It should
 263  * presumably give more information to a human reader than the target, but it
 264  * need not be acceptable to vconn_open(). */
 265 void
 266 rconn_connect_unreliably(struct rconn *rc,
 267                          struct vconn *vconn, const char *name)
 268 {
 269     assert(vconn != NULL);
 270     rconn_disconnect(rc);
 271     rconn_set_target__(rc, vconn_get_name(vconn), name);
 272     rc->reliable = false;
 273     rc->vconn = vconn;
 274     rc->last_connected = time_now();
 275     state_transition(rc, S_ACTIVE);
 276 }
 277
 278 /* If 'rc' is connected, forces it to drop the connection and reconnect. */
 279 void
 280 rconn_reconnect(struct rconn *rc)
 281 {
 282     if (rc->state & (S_ACTIVE | S_IDLE)) {
 283         VLOG_INFO("%s: disconnecting", rc->name);
 284         disconnect(rc, 0);
 285     }
 286 }
 287
 288 void
 289 rconn_disconnect(struct rconn *rc)
 290 {
 291     if (rc->state != S_VOID) {
 292         if (rc->vconn) {
 293             vconn_close(rc->vconn);
 294             rc->vconn = NULL;
 295         }
 296         rconn_set_target__(rc, "void", NULL);
 297         rc->reliable = false;
 298
 299         rc->backoff = 0;
 300         rc->backoff_deadline = TIME_MIN;
 301
 302         state_transition(rc, S_VOID);
 303     }
 304 }
 305
 306 /* Disconnects 'rc' and frees the underlying storage. */
 307 void
 308 rconn_destroy(struct rconn *rc)
 309 {
 310     if (rc) {
 311         size_t i;
 312
 313         free(rc->name);
 314         free(rc->target);
 315         vconn_close(rc->vconn);
 316         flush_queue(rc);
 317         ofpbuf_list_delete(&rc->txq);
 318         for (i = 0; i < rc->n_monitors; i++) {
 319             vconn_close(rc->monitors[i]);
 320         }
 321         free(rc);
 322     }
 323 }
 324
 325 static unsigned int
 326 timeout_VOID(const struct rconn *rc OVS_UNUSED)
 327 {
 328     return UINT_MAX;
 329 }
 330
 331 static void
 332 run_VOID(struct rconn *rc OVS_UNUSED)
 333 {
 334     /* Nothing to do. */
 335 }
 336
 337 static void
 338 reconnect(struct rconn *rc)
 339 {
 340     int retval;
 341
 342     if (rconn_logging_connection_attempts__(rc)) {
 343         VLOG_INFO("%s: connecting...", rc->name);
 344     }
 345     rc->n_attempted_connections++;
 346     retval = vconn_open(rc->target, OFP10_VERSION, &rc->vconn, rc->dscp);
 347     if (!retval) {
 348         rc->remote_ip = vconn_get_remote_ip(rc->vconn);
 349         rc->local_ip = vconn_get_local_ip(rc->vconn);
 350         rc->remote_port = vconn_get_remote_port(rc->vconn);
 351         rc->backoff_deadline = time_now() + rc->backoff;
 352         state_transition(rc, S_CONNECTING);
 353     } else {
 354         VLOG_WARN("%s: connection failed (%s)", rc->name, strerror(retval));
 355         rc->backoff_deadline = TIME_MAX; /* Prevent resetting backoff. */
 356         disconnect(rc, retval);
 357     }
 358 }
 359
 360 static unsigned int
 361 timeout_BACKOFF(const struct rconn *rc)
 362 {
 363     return rc->backoff;
 364 }
 365
 366 static void
 367 run_BACKOFF(struct rconn *rc)
 368 {
 369     if (timed_out(rc)) {
 370         reconnect(rc);
 371     }
 372 }
 373
 374 static unsigned int
 375 timeout_CONNECTING(const struct rconn *rc)
 376 {
 377     return MAX(1, rc->backoff);
 378 }
 379
 380 static void
 381 run_CONNECTING(struct rconn *rc)
 382 {
 383     int retval = vconn_connect(rc->vconn);
 384     if (!retval) {
 385         VLOG_INFO("%s: connected", rc->name);
 386         rc->n_successful_connections++;
 387         state_transition(rc, S_ACTIVE);
 388         rc->last_connected = rc->state_entered;
 389     } else if (retval != EAGAIN) {
 390         if (rconn_logging_connection_attempts__(rc)) {
 391             VLOG_INFO("%s: connection failed (%s)",
 392                       rc->name, strerror(retval));
 393         }
 394         disconnect(rc, retval);
 395     } else if (timed_out(rc)) {
 396         if (rconn_logging_connection_attempts__(rc)) {
 397             VLOG_INFO("%s: connection timed out", rc->name);
 398         }
 399         rc->backoff_deadline = TIME_MAX; /* Prevent resetting backoff. */
 400         disconnect(rc, ETIMEDOUT);
 401     }
 402 }
 403
 404 static void
 405 do_tx_work(struct rconn *rc)
 406 {
 407     if (list_is_empty(&rc->txq)) {
 408         return;
 409     }
 410     while (!list_is_empty(&rc->txq)) {
 411         int error = try_send(rc);
 412         if (error) {
 413             break;
 414         }
 415     }
 416     if (list_is_empty(&rc->txq)) {
 417         poll_immediate_wake();
 418     }
 419 }
 420
 421 static unsigned int
 422 timeout_ACTIVE(const struct rconn *rc)
 423 {
 424     if (rc->probe_interval) {
 425         unsigned int base = MAX(rc->last_received, rc->state_entered);
 426         unsigned int arg = base + rc->probe_interval - rc->state_entered;
 427         return arg;
 428     }
 429     return UINT_MAX;
 430 }
 431
 432 static void
 433 run_ACTIVE(struct rconn *rc)
 434 {
 435     if (timed_out(rc)) {
 436         unsigned int base = MAX(rc->last_received, rc->state_entered);
 437         VLOG_DBG("%s: idle %u seconds, sending inactivity probe",
 438                  rc->name, (unsigned int) (time_now() - base));
 439
 440         /* Ordering is important here: rconn_send() can transition to BACKOFF,
 441          * and we don't want to transition back to IDLE if so, because then we
 442          * can end up queuing a packet with vconn == NULL and then *boom*. */
 443         state_transition(rc, S_IDLE);
 444         rconn_send(rc, make_echo_request(), NULL);
 445         return;
 446     }
 447
 448     do_tx_work(rc);
 449 }
 450
 451 static unsigned int
 452 timeout_IDLE(const struct rconn *rc)
 453 {
 454     return rc->probe_interval;
 455 }
 456
 457 static void
 458 run_IDLE(struct rconn *rc)
 459 {
 460     if (timed_out(rc)) {
 461         VLOG_ERR("%s: no response to inactivity probe after %u "
 462                  "seconds, disconnecting",
 463                  rc->name, elapsed_in_this_state(rc));
 464         disconnect(rc, ETIMEDOUT);
 465     } else {
 466         do_tx_work(rc);
 467     }
 468 }
 469
 470 /* Performs whatever activities are necessary to maintain 'rc': if 'rc' is
 471  * disconnected, attempts to (re)connect, backing off as necessary; if 'rc' is
 472  * connected, attempts to send packets in the send queue, if any. */
 473 void
 474 rconn_run(struct rconn *rc)
 475 {
 476     int old_state;
 477     size_t i;
 478
 479     if (rc->vconn) {
 480         vconn_run(rc->vconn);
 481     }
 482     for (i = 0; i < rc->n_monitors; i++) {
 483         vconn_run(rc->monitors[i]);
 484     }
 485
 486     do {
 487         old_state = rc->state;
 488         switch (rc->state) {
 489 #define STATE(NAME, VALUE) case S_##NAME: run_##NAME(rc); break;
 490             STATES
 491 #undef STATE
 492         default:
 493             NOT_REACHED();
 494         }
 495     } while (rc->state != old_state);
 496 }
 497
 498 /* Causes the next call to poll_block() to wake up when rconn_run() should be
 499  * called on 'rc'. */
 500 void
 501 rconn_run_wait(struct rconn *rc)
 502 {
 503     unsigned int timeo;
 504     size_t i;
 505
 506     if (rc->vconn) {
 507         vconn_run_wait(rc->vconn);
 508         if ((rc->state & (S_ACTIVE | S_IDLE)) && !list_is_empty(&rc->txq)) {
 509             vconn_wait(rc->vconn, WAIT_SEND);
 510         }
 511     }
 512     for (i = 0; i < rc->n_monitors; i++) {
 513         vconn_run_wait(rc->monitors[i]);
 514     }
 515
 516     timeo = timeout(rc);
 517     if (timeo != UINT_MAX) {
 518         long long int expires = sat_add(rc->state_entered, timeo);
 519         poll_timer_wait_until(expires * 1000);
 520     }
 521 }
 522
 523 /* Attempts to receive a packet from 'rc'.  If successful, returns the packet;
 524  * otherwise, returns a null pointer.  The caller is responsible for freeing
 525  * the packet (with ofpbuf_delete()). */
 526 struct ofpbuf *
 527 rconn_recv(struct rconn *rc)
 528 {
 529     if (rc->state & (S_ACTIVE | S_IDLE)) {
 530         struct ofpbuf *buffer;
 531         int error = vconn_recv(rc->vconn, &buffer);
 532         if (!error) {
 533             copy_to_monitor(rc, buffer);
 534             if (rc->probably_admitted || is_admitted_msg(buffer)
 535                 || time_now() - rc->last_connected >= 30) {
 536                 rc->probably_admitted = true;
 537                 rc->last_admitted = time_now();
 538             }
 539             rc->last_received = time_now();
 540             rc->packets_received++;
 541             if (rc->state == S_IDLE) {
 542                 state_transition(rc, S_ACTIVE);
 543             }
 544             return buffer;
 545         } else if (error != EAGAIN) {
 546             report_error(rc, error);
 547             disconnect(rc, error);
 548         }
 549     }
 550     return NULL;
 551 }
 552
 553 /* Causes the next call to poll_block() to wake up when a packet may be ready
 554  * to be received by vconn_recv() on 'rc'.  */
 555 void
 556 rconn_recv_wait(struct rconn *rc)
 557 {
 558     if (rc->vconn) {
 559         vconn_wait(rc->vconn, WAIT_RECV);
 560     }
 561 }
 562
 563 /* Sends 'b' on 'rc'.  Returns 0 if successful, or ENOTCONN if 'rc' is not
 564  * currently connected.  Takes ownership of 'b'.
 565  *
 566  * If 'counter' is non-null, then 'counter' will be incremented while the
 567  * packet is in flight, then decremented when it has been sent (or discarded
 568  * due to disconnection).  Because 'b' may be sent (or discarded) before this
 569  * function returns, the caller may not be able to observe any change in
 570  * 'counter'.
 571  *
 572  * There is no rconn_send_wait() function: an rconn has a send queue that it
 573  * takes care of sending if you call rconn_run(), which will have the side
 574  * effect of waking up poll_block(). */
 575 int
 576 rconn_send(struct rconn *rc, struct ofpbuf *b,
 577            struct rconn_packet_counter *counter)
 578 {
 579     if (rconn_is_connected(rc)) {
 580         COVERAGE_INC(rconn_queued);
 581         copy_to_monitor(rc, b);
 582         b->private_p = counter;
 583         if (counter) {
 584             rconn_packet_counter_inc(counter);
 585         }
 586         list_push_back(&rc->txq, &b->list_node);
 587
 588         /* If the queue was empty before we added 'b', try to send some
 589          * packets.  (But if the queue had packets in it, it's because the
 590          * vconn is backlogged and there's no point in stuffing more into it
 591          * now.  We'll get back to that in rconn_run().) */
 592         if (rc->txq.next == &b->list_node) {
 593             try_send(rc);
 594         }
 595         return 0;
 596     } else {
 597         ofpbuf_delete(b);
 598         return ENOTCONN;
 599     }
 600 }
 601
 602 /* Sends 'b' on 'rc'.  Increments 'counter' while the packet is in flight; it
 603  * will be decremented when it has been sent (or discarded due to
 604  * disconnection).  Returns 0 if successful, EAGAIN if 'counter->n' is already
 605  * at least as large as 'queue_limit', or ENOTCONN if 'rc' is not currently
 606  * connected.  Regardless of return value, 'b' is destroyed.
 607  *
 608  * Because 'b' may be sent (or discarded) before this function returns, the
 609  * caller may not be able to observe any change in 'counter'.
 610  *
 611  * There is no rconn_send_wait() function: an rconn has a send queue that it
 612  * takes care of sending if you call rconn_run(), which will have the side
 613  * effect of waking up poll_block(). */
 614 int
 615 rconn_send_with_limit(struct rconn *rc, struct ofpbuf *b,
 616                       struct rconn_packet_counter *counter, int queue_limit)
 617 {
 618     int retval;
 619     retval = counter->n >= queue_limit ? EAGAIN : rconn_send(rc, b, counter);
 620     if (retval) {
 621         COVERAGE_INC(rconn_overflow);
 622     }
 623     return retval;
 624 }
 625
 626 /* Returns the total number of packets successfully sent on the underlying
 627  * vconn.  A packet is not counted as sent while it is still queued in the
 628  * rconn, only when it has been successfuly passed to the vconn.  */
 629 unsigned int
 630 rconn_packets_sent(const struct rconn *rc)
 631 {
 632     return rc->packets_sent;
 633 }
 634
 635 /* Adds 'vconn' to 'rc' as a monitoring connection, to which all messages sent
 636  * and received on 'rconn' will be copied.  'rc' takes ownership of 'vconn'. */
 637 void
 638 rconn_add_monitor(struct rconn *rc, struct vconn *vconn)
 639 {
 640     if (rc->n_monitors < ARRAY_SIZE(rc->monitors)) {
 641         VLOG_INFO("new monitor connection from %s", vconn_get_name(vconn));
 642         rc->monitors[rc->n_monitors++] = vconn;
 643     } else {
 644         VLOG_DBG("too many monitor connections, discarding %s",
 645                  vconn_get_name(vconn));
 646         vconn_close(vconn);
 647     }
 648 }
 649
 650 /* Returns 'rc''s name.  This is a name for human consumption, appropriate for
 651  * use in log messages.  It is not necessarily a name that may be passed
 652  * directly to, e.g., vconn_open(). */
 653 const char *
 654 rconn_get_name(const struct rconn *rc)
 655 {
 656     return rc->name;
 657 }
 658
 659 /* Sets 'rc''s name to 'new_name'. */
 660 void
 661 rconn_set_name(struct rconn *rc, const char *new_name)
 662 {
 663     free(rc->name);
 664     rc->name = xstrdup(new_name);
 665 }
 666
 667 /* Returns 'rc''s target.  This is intended to be a string that may be passed
 668  * directly to, e.g., vconn_open(). */
 669 const char *
 670 rconn_get_target(const struct rconn *rc)
 671 {
 672     return rc->target;
 673 }
 674
 675 /* Returns true if 'rconn' is connected or in the process of reconnecting,
 676  * false if 'rconn' is disconnected and will not reconnect on its own. */
 677 bool
 678 rconn_is_alive(const struct rconn *rconn)
 679 {
 680     return rconn->state != S_VOID;
 681 }
 682
 683 /* Returns true if 'rconn' is connected, false otherwise. */
 684 bool
 685 rconn_is_connected(const struct rconn *rconn)
 686 {
 687     return is_connected_state(rconn->state);
 688 }
 689
 690 /* Returns true if 'rconn' is connected and thought to have been accepted by
 691  * the peer's admission-control policy. */
 692 bool
 693 rconn_is_admitted(const struct rconn *rconn)
 694 {
 695     return (rconn_is_connected(rconn)
 696             && rconn->last_admitted >= rconn->last_connected);
 697 }
 698
 699 /* Returns 0 if 'rconn' is currently connected and considered to have been
 700  * accepted by the peer's admission-control policy, otherwise the number of
 701  * seconds since 'rconn' was last in such a state. */
 702 int
 703 rconn_failure_duration(const struct rconn *rconn)
 704 {
 705     return rconn_is_admitted(rconn) ? 0 : time_now() - rconn->last_admitted;
 706 }
 707
 708 /* Returns the IP address of the peer, or 0 if the peer's IP address is not
 709  * known. */
 710 ovs_be32
 711 rconn_get_remote_ip(const struct rconn *rconn)
 712 {
 713     return rconn->remote_ip;
 714 }
 715
 716 /* Returns the transport port of the peer, or 0 if the peer's port is not
 717  * known. */
 718 ovs_be16
 719 rconn_get_remote_port(const struct rconn *rconn)
 720 {
 721     return rconn->remote_port;
 722 }
 723
 724 /* Returns the IP address used to connect to the peer, or 0 if the
 725  * connection is not an IP-based protocol or if its IP address is not
 726  * known. */
 727 ovs_be32
 728 rconn_get_local_ip(const struct rconn *rconn)
 729 {
 730     return rconn->local_ip;
 731 }
 732
 733 /* Returns the transport port used to connect to the peer, or 0 if the
 734  * connection does not contain a port or if the port is not known. */
 735 ovs_be16
 736 rconn_get_local_port(const struct rconn *rconn)
 737 {
 738     return rconn->vconn ? vconn_get_local_port(rconn->vconn) : 0;
 739 }
 740
 741 /* Returns the OpenFlow version negotiated with the peer, or -1 if there is
 742  * currently no connection or if version negotiation is not yet complete. */
 743 int
 744 rconn_get_version(const struct rconn *rconn)
 745 {
 746     return rconn->vconn ? vconn_get_version(rconn->vconn) : -1;
 747 }
 748
 749 /* Returns the total number of packets successfully received by the underlying
 750  * vconn.  */
 751 unsigned int
 752 rconn_packets_received(const struct rconn *rc)
 753 {
 754     return rc->packets_received;
 755 }
 756
 757 /* Returns a string representing the internal state of 'rc'.  The caller must
 758  * not modify or free the string. */
 759 const char *
 760 rconn_get_state(const struct rconn *rc)
 761 {
 762     return state_name(rc->state);
 763 }
 764
 765 /* Returns the number of connection attempts made by 'rc', including any
 766  * ongoing attempt that has not yet succeeded or failed. */
 767 unsigned int
 768 rconn_get_attempted_connections(const struct rconn *rc)
 769 {
 770     return rc->n_attempted_connections;
 771 }
 772
 773 /* Returns the number of successful connection attempts made by 'rc'. */
 774 unsigned int
 775 rconn_get_successful_connections(const struct rconn *rc)
 776 {
 777     return rc->n_successful_connections;
 778 }
 779
 780 /* Returns the time at which the last successful connection was made by
 781  * 'rc'. Returns TIME_MIN if never connected. */
 782 time_t
 783 rconn_get_last_connection(const struct rconn *rc)
 784 {
 785     return rc->last_connected;
 786 }
 787
 788 /* Returns the time at which 'rc' was last disconnected. Returns TIME_MIN
 789  * if never disconnected. */
 790 time_t
 791 rconn_get_last_disconnect(const struct rconn *rc)
 792 {
 793     return rc->last_disconnected;
 794 }
 795
 796 /* Returns the time at which the last OpenFlow message was received by 'rc'.
 797  * If no packets have been received on 'rc', returns the time at which 'rc'
 798  * was created. */
 799 time_t
 800 rconn_get_last_received(const struct rconn *rc)
 801 {
 802     return rc->last_received;
 803 }
 804
 805 /* Returns the time at which 'rc' was created. */
 806 time_t
 807 rconn_get_creation_time(const struct rconn *rc)
 808 {
 809     return rc->creation_time;
 810 }
 811
 812 /* Returns the approximate number of seconds that 'rc' has been connected. */
 813 unsigned long int
 814 rconn_get_total_time_connected(const struct rconn *rc)
 815 {
 816     return (rc->total_time_connected
 817             + (rconn_is_connected(rc) ? elapsed_in_this_state(rc) : 0));
 818 }
 819
 820 /* Returns the current amount of backoff, in seconds.  This is the amount of
 821  * time after which the rconn will transition from BACKOFF to CONNECTING. */
 822 int
 823 rconn_get_backoff(const struct rconn *rc)
 824 {
 825     return rc->backoff;
 826 }
 827
 828 /* Returns the number of seconds spent in this state so far. */
 829 unsigned int
 830 rconn_get_state_elapsed(const struct rconn *rc)
 831 {
 832     return elapsed_in_this_state(rc);
 833 }
 834
 835 /* Returns 'rc''s current connection sequence number, a number that changes
 836  * every time that 'rconn' connects or disconnects. */
 837 unsigned int
 838 rconn_get_connection_seqno(const struct rconn *rc)
 839 {
 840     return rc->seqno;
 841 }
 842
 843 /* Returns a value that explains why 'rc' last disconnected:
 844  *
 845  *   - 0 means that the last disconnection was caused by a call to
 846  *     rconn_disconnect(), or that 'rc' is new and has not yet completed its
 847  *     initial connection or connection attempt.
 848  *
 849  *   - EOF means that the connection was closed in the normal way by the peer.
 850  *
 851  *   - A positive integer is an errno value that represents the error.
 852  */
 853 int
 854 rconn_get_last_error(const struct rconn *rc)
 855 {
 856     return rc->last_error;
 857 }
 858 \f
 859 struct rconn_packet_counter *
 860 rconn_packet_counter_create(void)
 861 {
 862     struct rconn_packet_counter *c = xmalloc(sizeof *c);
 863     c->n = 0;
 864     c->ref_cnt = 1;
 865     return c;
 866 }
 867
 868 void
 869 rconn_packet_counter_destroy(struct rconn_packet_counter *c)
 870 {
 871     if (c) {
 872         assert(c->ref_cnt > 0);
 873         if (!--c->ref_cnt && !c->n) {
 874             free(c);
 875         }
 876     }
 877 }
 878
 879 void
 880 rconn_packet_counter_inc(struct rconn_packet_counter *c)
 881 {
 882     c->n++;
 883 }
 884
 885 void
 886 rconn_packet_counter_dec(struct rconn_packet_counter *c)
 887 {
 888     assert(c->n > 0);
 889     if (!--c->n && !c->ref_cnt) {
 890         free(c);
 891     }
 892 }
 893 \f
 894 /* Set rc->target and rc->name to 'target' and 'name', respectively.  If 'name'
 895  * is null, 'target' is used.
 896  *
 897  * Also, clear out the cached IP address and port information, since changing
 898  * the target also likely changes these values. */
 899 static void
 900 rconn_set_target__(struct rconn *rc, const char *target, const char *name)
 901 {
 902     free(rc->name);
 903     rc->name = xstrdup(name ? name : target);
 904     free(rc->target);
 905     rc->target = xstrdup(target);
 906     rc->local_ip = 0;
 907     rc->remote_ip = 0;
 908     rc->remote_port = 0;
 909 }
 910
 911 /* Tries to send a packet from 'rc''s send buffer.  Returns 0 if successful,
 912  * otherwise a positive errno value. */
 913 static int
 914 try_send(struct rconn *rc)
 915 {
 916     struct ofpbuf *msg = ofpbuf_from_list(rc->txq.next);
 917     struct rconn_packet_counter *counter = msg->private_p;
 918     int retval;
 919
 920     /* Eagerly remove 'msg' from the txq.  We can't remove it from the list
 921      * after sending, if sending is successful, because it is then owned by the
 922      * vconn, which might have freed it already. */
 923     list_remove(&msg->list_node);
 924
 925     retval = vconn_send(rc->vconn, msg);
 926     if (retval) {
 927         list_push_front(&rc->txq, &msg->list_node);
 928         if (retval != EAGAIN) {
 929             report_error(rc, retval);
 930             disconnect(rc, retval);
 931         }
 932         return retval;
 933     }
 934     COVERAGE_INC(rconn_sent);
 935     rc->packets_sent++;
 936     if (counter) {
 937         rconn_packet_counter_dec(counter);
 938     }
 939     return 0;
 940 }
 941
 942 /* Reports that 'error' caused 'rc' to disconnect.  'error' may be a positive
 943  * errno value, or it may be EOF to indicate that the connection was closed
 944  * normally. */
 945 static void
 946 report_error(struct rconn *rc, int error)
 947 {
 948     if (error == EOF) {
 949         /* If 'rc' isn't reliable, then we don't really expect this connection
 950          * to last forever anyway (probably it's a connection that we received
 951          * via accept()), so use DBG level to avoid cluttering the logs. */
 952         enum vlog_level level = rc->reliable ? VLL_INFO : VLL_DBG;
 953         VLOG(level, "%s: connection closed by peer", rc->name);
 954     } else {
 955         VLOG_WARN("%s: connection dropped (%s)", rc->name, strerror(error));
 956     }
 957 }
 958
 959 /* Disconnects 'rc' and records 'error' as the error that caused 'rc''s last
 960  * disconnection:
 961  *
 962  *   - 0 means that this disconnection is due to a request by 'rc''s client,
 963  *     not due to any kind of network error.
 964  *
 965  *   - EOF means that the connection was closed in the normal way by the peer.
 966  *
 967  *   - A positive integer is an errno value that represents the error.
 968  */
 969 static void
 970 disconnect(struct rconn *rc, int error)
 971 {
 972     rc->last_error = error;
 973     if (rc->reliable) {
 974         time_t now = time_now();
 975
 976         if (rc->state & (S_CONNECTING | S_ACTIVE | S_IDLE)) {
 977             rc->last_disconnected = now;
 978             vconn_close(rc->vconn);
 979             rc->vconn = NULL;
 980             flush_queue(rc);
 981         }
 982
 983         if (now >= rc->backoff_deadline) {
 984             rc->backoff = 1;
 985         } else if (rc->backoff < rc->max_backoff / 2) {
 986             rc->backoff = MAX(1, 2 * rc->backoff);
 987             VLOG_INFO("%s: waiting %d seconds before reconnect",
 988                       rc->name, rc->backoff);
 989         } else {
 990             if (rconn_logging_connection_attempts__(rc)) {
 991                 VLOG_INFO("%s: continuing to retry connections in the "
 992                           "background but suppressing further logging",
 993                           rc->name);
 994             }
 995             rc->backoff = rc->max_backoff;
 996         }
 997         rc->backoff_deadline = now + rc->backoff;
 998         state_transition(rc, S_BACKOFF);
 999     } else {
1000         rc->last_disconnected = time_now();
1001         rconn_disconnect(rc);
1002     }
1003 }
1004
1005 /* Drops all the packets from 'rc''s send queue and decrements their queue
1006  * counts. */
1007 static void
1008 flush_queue(struct rconn *rc)
1009 {
1010     if (list_is_empty(&rc->txq)) {
1011         return;
1012     }
1013     while (!list_is_empty(&rc->txq)) {
1014         struct ofpbuf *b = ofpbuf_from_list(list_pop_front(&rc->txq));
1015         struct rconn_packet_counter *counter = b->private_p;
1016         if (counter) {
1017             rconn_packet_counter_dec(counter);
1018         }
1019         COVERAGE_INC(rconn_discarded);
1020         ofpbuf_delete(b);
1021     }
1022     poll_immediate_wake();
1023 }
1024
1025 static unsigned int
1026 elapsed_in_this_state(const struct rconn *rc)
1027 {
1028     return time_now() - rc->state_entered;
1029 }
1030
1031 static unsigned int
1032 timeout(const struct rconn *rc)
1033 {
1034     switch (rc->state) {
1035 #define STATE(NAME, VALUE) case S_##NAME: return timeout_##NAME(rc);
1036         STATES
1037 #undef STATE
1038     default:
1039         NOT_REACHED();
1040     }
1041 }
1042
1043 static bool
1044 timed_out(const struct rconn *rc)
1045 {
1046     return time_now() >= sat_add(rc->state_entered, timeout(rc));
1047 }
1048
1049 static void
1050 state_transition(struct rconn *rc, enum state state)
1051 {
1052     rc->seqno += (rc->state == S_ACTIVE) != (state == S_ACTIVE);
1053     if (is_connected_state(state) && !is_connected_state(rc->state)) {
1054         rc->probably_admitted = false;
1055     }
1056     if (rconn_is_connected(rc)) {
1057         rc->total_time_connected += elapsed_in_this_state(rc);
1058     }
1059     VLOG_DBG("%s: entering %s", rc->name, state_name(state));
1060     rc->state = state;
1061     rc->state_entered = time_now();
1062 }
1063
1064 static void
1065 copy_to_monitor(struct rconn *rc, const struct ofpbuf *b)
1066 {
1067     struct ofpbuf *clone = NULL;
1068     int retval;
1069     size_t i;
1070
1071     for (i = 0; i < rc->n_monitors; ) {
1072         struct vconn *vconn = rc->monitors[i];
1073
1074         if (!clone) {
1075             clone = ofpbuf_clone(b);
1076         }
1077         retval = vconn_send(vconn, clone);
1078         if (!retval) {
1079             clone = NULL;
1080         } else if (retval != EAGAIN) {
1081             VLOG_DBG("%s: closing monitor connection to %s: %s",
1082                      rconn_get_name(rc), vconn_get_name(vconn),
1083                      strerror(retval));
1084             rc->monitors[i] = rc->monitors[--rc->n_monitors];
1085             continue;
1086         }
1087         i++;
1088     }
1089     ofpbuf_delete(clone);
1090 }
1091
1092 static bool
1093 is_connected_state(enum state state)
1094 {
1095     return (state & (S_ACTIVE | S_IDLE)) != 0;
1096 }
1097
1098 static bool
1099 is_admitted_msg(const struct ofpbuf *b)
1100 {
1101     struct ofp_header *oh = b->data;
1102     uint8_t type = oh->type;
1103     return !(type < 32
1104              && (1u << type) & ((1u << OFPT_HELLO) |
1105                                 (1u << OFPT_ERROR) |
1106                                 (1u << OFPT_ECHO_REQUEST) |
1107                                 (1u << OFPT_ECHO_REPLY) |
1108                                 (1u << OFPT_VENDOR) |
1109                                 (1u << OFPT_FEATURES_REQUEST) |
1110                                 (1u << OFPT_FEATURES_REPLY) |
1111                                 (1u << OFPT_GET_CONFIG_REQUEST) |
1112                                 (1u << OFPT_GET_CONFIG_REPLY) |
1113                                 (1u << OFPT_SET_CONFIG)));
1114 }
1115
1116 /* Returns true if 'rc' is currently logging information about connection
1117  * attempts, false if logging should be suppressed because 'rc' hasn't
1118  * successuflly connected in too long. */
1119 static bool
1120 rconn_logging_connection_attempts__(const struct rconn *rc)
1121 {
1122     return rc->backoff < rc->max_backoff;
1123 }