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 uint8_t
 230 rconn_get_dscp(const struct rconn *rc)
 231 {
 232     return rc->dscp;
 233 }
 234
 235 void
 236 rconn_set_probe_interval(struct rconn *rc, int probe_interval)
 237 {
 238     rc->probe_interval = probe_interval ? MAX(5, probe_interval) : 0;
 239 }
 240
 241 int
 242 rconn_get_probe_interval(const struct rconn *rc)
 243 {
 244     return rc->probe_interval;
 245 }
 246
 247 /* Drops any existing connection on 'rc', then sets up 'rc' to connect to
 248  * 'target' and reconnect as needed.  'target' should be a remote OpenFlow
 249  * target in a form acceptable to vconn_open().
 250  *
 251  * If 'name' is nonnull, then it is used in log messages in place of 'target'.
 252  * It should presumably give more information to a human reader than 'target',
 253  * but it need not be acceptable to vconn_open(). */
 254 void
 255 rconn_connect(struct rconn *rc, const char *target, const char *name)
 256 {
 257     rconn_disconnect(rc);
 258     rconn_set_target__(rc, target, name);
 259     rc->reliable = true;
 260     reconnect(rc);
 261 }
 262
 263 /* Drops any existing connection on 'rc', then configures 'rc' to use
 264  * 'vconn'.  If the connection on 'vconn' drops, 'rc' will not reconnect on it
 265  * own.
 266  *
 267  * By default, the target obtained from vconn_get_name(vconn) is used in log
 268  * messages.  If 'name' is nonnull, then it is used instead.  It should
 269  * presumably give more information to a human reader than the target, but it
 270  * need not be acceptable to vconn_open(). */
 271 void
 272 rconn_connect_unreliably(struct rconn *rc,
 273                          struct vconn *vconn, const char *name)
 274 {
 275     assert(vconn != NULL);
 276     rconn_disconnect(rc);
 277     rconn_set_target__(rc, vconn_get_name(vconn), name);
 278     rc->reliable = false;
 279     rc->vconn = vconn;
 280     rc->last_connected = time_now();
 281     state_transition(rc, S_ACTIVE);
 282 }
 283
 284 /* If 'rc' is connected, forces it to drop the connection and reconnect. */
 285 void
 286 rconn_reconnect(struct rconn *rc)
 287 {
 288     if (rc->state & (S_ACTIVE | S_IDLE)) {
 289         VLOG_INFO("%s: disconnecting", rc->name);
 290         disconnect(rc, 0);
 291     }
 292 }
 293
 294 void
 295 rconn_disconnect(struct rconn *rc)
 296 {
 297     if (rc->state != S_VOID) {
 298         if (rc->vconn) {
 299             vconn_close(rc->vconn);
 300             rc->vconn = NULL;
 301         }
 302         rconn_set_target__(rc, "void", NULL);
 303         rc->reliable = false;
 304
 305         rc->backoff = 0;
 306         rc->backoff_deadline = TIME_MIN;
 307
 308         state_transition(rc, S_VOID);
 309     }
 310 }
 311
 312 /* Disconnects 'rc' and frees the underlying storage. */
 313 void
 314 rconn_destroy(struct rconn *rc)
 315 {
 316     if (rc) {
 317         size_t i;
 318
 319         free(rc->name);
 320         free(rc->target);
 321         vconn_close(rc->vconn);
 322         flush_queue(rc);
 323         ofpbuf_list_delete(&rc->txq);
 324         for (i = 0; i < rc->n_monitors; i++) {
 325             vconn_close(rc->monitors[i]);
 326         }
 327         free(rc);
 328     }
 329 }
 330
 331 static unsigned int
 332 timeout_VOID(const struct rconn *rc OVS_UNUSED)
 333 {
 334     return UINT_MAX;
 335 }
 336
 337 static void
 338 run_VOID(struct rconn *rc OVS_UNUSED)
 339 {
 340     /* Nothing to do. */
 341 }
 342
 343 static void
 344 reconnect(struct rconn *rc)
 345 {
 346     int retval;
 347
 348     if (rconn_logging_connection_attempts__(rc)) {
 349         VLOG_INFO("%s: connecting...", rc->name);
 350     }
 351     rc->n_attempted_connections++;
 352     retval = vconn_open(rc->target, OFP10_VERSION, &rc->vconn, rc->dscp);
 353     if (!retval) {
 354         rc->remote_ip = vconn_get_remote_ip(rc->vconn);
 355         rc->local_ip = vconn_get_local_ip(rc->vconn);
 356         rc->remote_port = vconn_get_remote_port(rc->vconn);
 357         rc->backoff_deadline = time_now() + rc->backoff;
 358         state_transition(rc, S_CONNECTING);
 359     } else {
 360         VLOG_WARN("%s: connection failed (%s)", rc->name, strerror(retval));
 361         rc->backoff_deadline = TIME_MAX; /* Prevent resetting backoff. */
 362         disconnect(rc, retval);
 363     }
 364 }
 365
 366 static unsigned int
 367 timeout_BACKOFF(const struct rconn *rc)
 368 {
 369     return rc->backoff;
 370 }
 371
 372 static void
 373 run_BACKOFF(struct rconn *rc)
 374 {
 375     if (timed_out(rc)) {
 376         reconnect(rc);
 377     }
 378 }
 379
 380 static unsigned int
 381 timeout_CONNECTING(const struct rconn *rc)
 382 {
 383     return MAX(1, rc->backoff);
 384 }
 385
 386 static void
 387 run_CONNECTING(struct rconn *rc)
 388 {
 389     int retval = vconn_connect(rc->vconn);
 390     if (!retval) {
 391         VLOG_INFO("%s: connected", rc->name);
 392         rc->n_successful_connections++;
 393         state_transition(rc, S_ACTIVE);
 394         rc->last_connected = rc->state_entered;
 395     } else if (retval != EAGAIN) {
 396         if (rconn_logging_connection_attempts__(rc)) {
 397             VLOG_INFO("%s: connection failed (%s)",
 398                       rc->name, strerror(retval));
 399         }
 400         disconnect(rc, retval);
 401     } else if (timed_out(rc)) {
 402         if (rconn_logging_connection_attempts__(rc)) {
 403             VLOG_INFO("%s: connection timed out", rc->name);
 404         }
 405         rc->backoff_deadline = TIME_MAX; /* Prevent resetting backoff. */
 406         disconnect(rc, ETIMEDOUT);
 407     }
 408 }
 409
 410 static void
 411 do_tx_work(struct rconn *rc)
 412 {
 413     if (list_is_empty(&rc->txq)) {
 414         return;
 415     }
 416     while (!list_is_empty(&rc->txq)) {
 417         int error = try_send(rc);
 418         if (error) {
 419             break;
 420         }
 421     }
 422     if (list_is_empty(&rc->txq)) {
 423         poll_immediate_wake();
 424     }
 425 }
 426
 427 static unsigned int
 428 timeout_ACTIVE(const struct rconn *rc)
 429 {
 430     if (rc->probe_interval) {
 431         unsigned int base = MAX(rc->last_received, rc->state_entered);
 432         unsigned int arg = base + rc->probe_interval - rc->state_entered;
 433         return arg;
 434     }
 435     return UINT_MAX;
 436 }
 437
 438 static void
 439 run_ACTIVE(struct rconn *rc)
 440 {
 441     if (timed_out(rc)) {
 442         unsigned int base = MAX(rc->last_received, rc->state_entered);
 443         VLOG_DBG("%s: idle %u seconds, sending inactivity probe",
 444                  rc->name, (unsigned int) (time_now() - base));
 445
 446         /* Ordering is important here: rconn_send() can transition to BACKOFF,
 447          * and we don't want to transition back to IDLE if so, because then we
 448          * can end up queuing a packet with vconn == NULL and then *boom*. */
 449         state_transition(rc, S_IDLE);
 450         rconn_send(rc, make_echo_request(), NULL);
 451         return;
 452     }
 453
 454     do_tx_work(rc);
 455 }
 456
 457 static unsigned int
 458 timeout_IDLE(const struct rconn *rc)
 459 {
 460     return rc->probe_interval;
 461 }
 462
 463 static void
 464 run_IDLE(struct rconn *rc)
 465 {
 466     if (timed_out(rc)) {
 467         VLOG_ERR("%s: no response to inactivity probe after %u "
 468                  "seconds, disconnecting",
 469                  rc->name, elapsed_in_this_state(rc));
 470         disconnect(rc, ETIMEDOUT);
 471     } else {
 472         do_tx_work(rc);
 473     }
 474 }
 475
 476 /* Performs whatever activities are necessary to maintain 'rc': if 'rc' is
 477  * disconnected, attempts to (re)connect, backing off as necessary; if 'rc' is
 478  * connected, attempts to send packets in the send queue, if any. */
 479 void
 480 rconn_run(struct rconn *rc)
 481 {
 482     int old_state;
 483     size_t i;
 484
 485     if (rc->vconn) {
 486         vconn_run(rc->vconn);
 487     }
 488     for (i = 0; i < rc->n_monitors; i++) {
 489         vconn_run(rc->monitors[i]);
 490     }
 491
 492     do {
 493         old_state = rc->state;
 494         switch (rc->state) {
 495 #define STATE(NAME, VALUE) case S_##NAME: run_##NAME(rc); break;
 496             STATES
 497 #undef STATE
 498         default:
 499             NOT_REACHED();
 500         }
 501     } while (rc->state != old_state);
 502 }
 503
 504 /* Causes the next call to poll_block() to wake up when rconn_run() should be
 505  * called on 'rc'. */
 506 void
 507 rconn_run_wait(struct rconn *rc)
 508 {
 509     unsigned int timeo;
 510     size_t i;
 511
 512     if (rc->vconn) {
 513         vconn_run_wait(rc->vconn);
 514         if ((rc->state & (S_ACTIVE | S_IDLE)) && !list_is_empty(&rc->txq)) {
 515             vconn_wait(rc->vconn, WAIT_SEND);
 516         }
 517     }
 518     for (i = 0; i < rc->n_monitors; i++) {
 519         vconn_run_wait(rc->monitors[i]);
 520     }
 521
 522     timeo = timeout(rc);
 523     if (timeo != UINT_MAX) {
 524         long long int expires = sat_add(rc->state_entered, timeo);
 525         poll_timer_wait_until(expires * 1000);
 526     }
 527 }
 528
 529 /* Attempts to receive a packet from 'rc'.  If successful, returns the packet;
 530  * otherwise, returns a null pointer.  The caller is responsible for freeing
 531  * the packet (with ofpbuf_delete()). */
 532 struct ofpbuf *
 533 rconn_recv(struct rconn *rc)
 534 {
 535     if (rc->state & (S_ACTIVE | S_IDLE)) {
 536         struct ofpbuf *buffer;
 537         int error = vconn_recv(rc->vconn, &buffer);
 538         if (!error) {
 539             copy_to_monitor(rc, buffer);
 540             if (rc->probably_admitted || is_admitted_msg(buffer)
 541                 || time_now() - rc->last_connected >= 30) {
 542                 rc->probably_admitted = true;
 543                 rc->last_admitted = time_now();
 544             }
 545             rc->last_received = time_now();
 546             rc->packets_received++;
 547             if (rc->state == S_IDLE) {
 548                 state_transition(rc, S_ACTIVE);
 549             }
 550             return buffer;
 551         } else if (error != EAGAIN) {
 552             report_error(rc, error);
 553             disconnect(rc, error);
 554         }
 555     }
 556     return NULL;
 557 }
 558
 559 /* Causes the next call to poll_block() to wake up when a packet may be ready
 560  * to be received by vconn_recv() on 'rc'.  */
 561 void
 562 rconn_recv_wait(struct rconn *rc)
 563 {
 564     if (rc->vconn) {
 565         vconn_wait(rc->vconn, WAIT_RECV);
 566     }
 567 }
 568
 569 /* Sends 'b' on 'rc'.  Returns 0 if successful, or ENOTCONN if 'rc' is not
 570  * currently connected.  Takes ownership of 'b'.
 571  *
 572  * If 'counter' is non-null, then 'counter' will be incremented while the
 573  * packet is in flight, then decremented when it has been sent (or discarded
 574  * due to disconnection).  Because 'b' may be sent (or discarded) before this
 575  * function returns, the caller may not be able to observe any change in
 576  * 'counter'.
 577  *
 578  * There is no rconn_send_wait() function: an rconn has a send queue that it
 579  * takes care of sending if you call rconn_run(), which will have the side
 580  * effect of waking up poll_block(). */
 581 int
 582 rconn_send(struct rconn *rc, struct ofpbuf *b,
 583            struct rconn_packet_counter *counter)
 584 {
 585     if (rconn_is_connected(rc)) {
 586         COVERAGE_INC(rconn_queued);
 587         copy_to_monitor(rc, b);
 588         b->private_p = counter;
 589         if (counter) {
 590             rconn_packet_counter_inc(counter, b->size);
 591         }
 592         list_push_back(&rc->txq, &b->list_node);
 593
 594         /* If the queue was empty before we added 'b', try to send some
 595          * packets.  (But if the queue had packets in it, it's because the
 596          * vconn is backlogged and there's no point in stuffing more into it
 597          * now.  We'll get back to that in rconn_run().) */
 598         if (rc->txq.next == &b->list_node) {
 599             try_send(rc);
 600         }
 601         return 0;
 602     } else {
 603         ofpbuf_delete(b);
 604         return ENOTCONN;
 605     }
 606 }
 607
 608 /* Sends 'b' on 'rc'.  Increments 'counter' while the packet is in flight; it
 609  * will be decremented when it has been sent (or discarded due to
 610  * disconnection).  Returns 0 if successful, EAGAIN if 'counter->n' is already
 611  * at least as large as 'queue_limit', or ENOTCONN if 'rc' is not currently
 612  * connected.  Regardless of return value, 'b' is destroyed.
 613  *
 614  * Because 'b' may be sent (or discarded) before this function returns, the
 615  * caller may not be able to observe any change in 'counter'.
 616  *
 617  * There is no rconn_send_wait() function: an rconn has a send queue that it
 618  * takes care of sending if you call rconn_run(), which will have the side
 619  * effect of waking up poll_block(). */
 620 int
 621 rconn_send_with_limit(struct rconn *rc, struct ofpbuf *b,
 622                       struct rconn_packet_counter *counter, int queue_limit)
 623 {
 624     int retval;
 625     retval = (counter->n_packets >= queue_limit
 626               ? EAGAIN
 627               : rconn_send(rc, b, counter));
 628     if (retval) {
 629         COVERAGE_INC(rconn_overflow);
 630     }
 631     return retval;
 632 }
 633
 634 /* Returns the total number of packets successfully sent on the underlying
 635  * vconn.  A packet is not counted as sent while it is still queued in the
 636  * rconn, only when it has been successfuly passed to the vconn.  */
 637 unsigned int
 638 rconn_packets_sent(const struct rconn *rc)
 639 {
 640     return rc->packets_sent;
 641 }
 642
 643 /* Adds 'vconn' to 'rc' as a monitoring connection, to which all messages sent
 644  * and received on 'rconn' will be copied.  'rc' takes ownership of 'vconn'. */
 645 void
 646 rconn_add_monitor(struct rconn *rc, struct vconn *vconn)
 647 {
 648     if (rc->n_monitors < ARRAY_SIZE(rc->monitors)) {
 649         VLOG_INFO("new monitor connection from %s", vconn_get_name(vconn));
 650         rc->monitors[rc->n_monitors++] = vconn;
 651     } else {
 652         VLOG_DBG("too many monitor connections, discarding %s",
 653                  vconn_get_name(vconn));
 654         vconn_close(vconn);
 655     }
 656 }
 657
 658 /* Returns 'rc''s name.  This is a name for human consumption, appropriate for
 659  * use in log messages.  It is not necessarily a name that may be passed
 660  * directly to, e.g., vconn_open(). */
 661 const char *
 662 rconn_get_name(const struct rconn *rc)
 663 {
 664     return rc->name;
 665 }
 666
 667 /* Sets 'rc''s name to 'new_name'. */
 668 void
 669 rconn_set_name(struct rconn *rc, const char *new_name)
 670 {
 671     free(rc->name);
 672     rc->name = xstrdup(new_name);
 673 }
 674
 675 /* Returns 'rc''s target.  This is intended to be a string that may be passed
 676  * directly to, e.g., vconn_open(). */
 677 const char *
 678 rconn_get_target(const struct rconn *rc)
 679 {
 680     return rc->target;
 681 }
 682
 683 /* Returns true if 'rconn' is connected or in the process of reconnecting,
 684  * false if 'rconn' is disconnected and will not reconnect on its own. */
 685 bool
 686 rconn_is_alive(const struct rconn *rconn)
 687 {
 688     return rconn->state != S_VOID;
 689 }
 690
 691 /* Returns true if 'rconn' is connected, false otherwise. */
 692 bool
 693 rconn_is_connected(const struct rconn *rconn)
 694 {
 695     return is_connected_state(rconn->state);
 696 }
 697
 698 /* Returns true if 'rconn' is connected and thought to have been accepted by
 699  * the peer's admission-control policy. */
 700 bool
 701 rconn_is_admitted(const struct rconn *rconn)
 702 {
 703     return (rconn_is_connected(rconn)
 704             && rconn->last_admitted >= rconn->last_connected);
 705 }
 706
 707 /* Returns 0 if 'rconn' is currently connected and considered to have been
 708  * accepted by the peer's admission-control policy, otherwise the number of
 709  * seconds since 'rconn' was last in such a state. */
 710 int
 711 rconn_failure_duration(const struct rconn *rconn)
 712 {
 713     return rconn_is_admitted(rconn) ? 0 : time_now() - rconn->last_admitted;
 714 }
 715
 716 /* Returns the IP address of the peer, or 0 if the peer's IP address is not
 717  * known. */
 718 ovs_be32
 719 rconn_get_remote_ip(const struct rconn *rconn)
 720 {
 721     return rconn->remote_ip;
 722 }
 723
 724 /* Returns the transport port of the peer, or 0 if the peer's port is not
 725  * known. */
 726 ovs_be16
 727 rconn_get_remote_port(const struct rconn *rconn)
 728 {
 729     return rconn->remote_port;
 730 }
 731
 732 /* Returns the IP address used to connect to the peer, or 0 if the
 733  * connection is not an IP-based protocol or if its IP address is not
 734  * known. */
 735 ovs_be32
 736 rconn_get_local_ip(const struct rconn *rconn)
 737 {
 738     return rconn->local_ip;
 739 }
 740
 741 /* Returns the transport port used to connect to the peer, or 0 if the
 742  * connection does not contain a port or if the port is not known. */
 743 ovs_be16
 744 rconn_get_local_port(const struct rconn *rconn)
 745 {
 746     return rconn->vconn ? vconn_get_local_port(rconn->vconn) : 0;
 747 }
 748
 749 /* Returns the OpenFlow version negotiated with the peer, or -1 if there is
 750  * currently no connection or if version negotiation is not yet complete. */
 751 int
 752 rconn_get_version(const struct rconn *rconn)
 753 {
 754     return rconn->vconn ? vconn_get_version(rconn->vconn) : -1;
 755 }
 756
 757 /* Returns the total number of packets successfully received by the underlying
 758  * vconn.  */
 759 unsigned int
 760 rconn_packets_received(const struct rconn *rc)
 761 {
 762     return rc->packets_received;
 763 }
 764
 765 /* Returns a string representing the internal state of 'rc'.  The caller must
 766  * not modify or free the string. */
 767 const char *
 768 rconn_get_state(const struct rconn *rc)
 769 {
 770     return state_name(rc->state);
 771 }
 772
 773 /* Returns the number of connection attempts made by 'rc', including any
 774  * ongoing attempt that has not yet succeeded or failed. */
 775 unsigned int
 776 rconn_get_attempted_connections(const struct rconn *rc)
 777 {
 778     return rc->n_attempted_connections;
 779 }
 780
 781 /* Returns the number of successful connection attempts made by 'rc'. */
 782 unsigned int
 783 rconn_get_successful_connections(const struct rconn *rc)
 784 {
 785     return rc->n_successful_connections;
 786 }
 787
 788 /* Returns the time at which the last successful connection was made by
 789  * 'rc'. Returns TIME_MIN if never connected. */
 790 time_t
 791 rconn_get_last_connection(const struct rconn *rc)
 792 {
 793     return rc->last_connected;
 794 }
 795
 796 /* Returns the time at which 'rc' was last disconnected. Returns TIME_MIN
 797  * if never disconnected. */
 798 time_t
 799 rconn_get_last_disconnect(const struct rconn *rc)
 800 {
 801     return rc->last_disconnected;
 802 }
 803
 804 /* Returns the time at which the last OpenFlow message was received by 'rc'.
 805  * If no packets have been received on 'rc', returns the time at which 'rc'
 806  * was created. */
 807 time_t
 808 rconn_get_last_received(const struct rconn *rc)
 809 {
 810     return rc->last_received;
 811 }
 812
 813 /* Returns the time at which 'rc' was created. */
 814 time_t
 815 rconn_get_creation_time(const struct rconn *rc)
 816 {
 817     return rc->creation_time;
 818 }
 819
 820 /* Returns the approximate number of seconds that 'rc' has been connected. */
 821 unsigned long int
 822 rconn_get_total_time_connected(const struct rconn *rc)
 823 {
 824     return (rc->total_time_connected
 825             + (rconn_is_connected(rc) ? elapsed_in_this_state(rc) : 0));
 826 }
 827
 828 /* Returns the current amount of backoff, in seconds.  This is the amount of
 829  * time after which the rconn will transition from BACKOFF to CONNECTING. */
 830 int
 831 rconn_get_backoff(const struct rconn *rc)
 832 {
 833     return rc->backoff;
 834 }
 835
 836 /* Returns the number of seconds spent in this state so far. */
 837 unsigned int
 838 rconn_get_state_elapsed(const struct rconn *rc)
 839 {
 840     return elapsed_in_this_state(rc);
 841 }
 842
 843 /* Returns 'rc''s current connection sequence number, a number that changes
 844  * every time that 'rconn' connects or disconnects. */
 845 unsigned int
 846 rconn_get_connection_seqno(const struct rconn *rc)
 847 {
 848     return rc->seqno;
 849 }
 850
 851 /* Returns a value that explains why 'rc' last disconnected:
 852  *
 853  *   - 0 means that the last disconnection was caused by a call to
 854  *     rconn_disconnect(), or that 'rc' is new and has not yet completed its
 855  *     initial connection or connection attempt.
 856  *
 857  *   - EOF means that the connection was closed in the normal way by the peer.
 858  *
 859  *   - A positive integer is an errno value that represents the error.
 860  */
 861 int
 862 rconn_get_last_error(const struct rconn *rc)
 863 {
 864     return rc->last_error;
 865 }
 866
 867 /* Returns the number of messages queued for transmission on 'rc'. */
 868 unsigned int
 869 rconn_count_txqlen(const struct rconn *rc)
 870 {
 871     return list_size(&rc->txq);
 872 }
 873 \f
 874 struct rconn_packet_counter *
 875 rconn_packet_counter_create(void)
 876 {
 877     struct rconn_packet_counter *c = xzalloc(sizeof *c);
 878     c->ref_cnt = 1;
 879     return c;
 880 }
 881
 882 void
 883 rconn_packet_counter_destroy(struct rconn_packet_counter *c)
 884 {
 885     if (c) {
 886         assert(c->ref_cnt > 0);
 887         if (!--c->ref_cnt && !c->n_packets) {
 888             free(c);
 889         }
 890     }
 891 }
 892
 893 void
 894 rconn_packet_counter_inc(struct rconn_packet_counter *c, unsigned int n_bytes)
 895 {
 896     c->n_packets++;
 897     c->n_bytes += n_bytes;
 898 }
 899
 900 void
 901 rconn_packet_counter_dec(struct rconn_packet_counter *c, unsigned int n_bytes)
 902 {
 903     assert(c->n_packets > 0);
 904     assert(c->n_bytes >= n_bytes);
 905
 906     c->n_bytes -= n_bytes;
 907     c->n_packets--;
 908     if (!c->n_packets) {
 909         assert(!c->n_bytes);
 910         if (!c->ref_cnt) {
 911             free(c);
 912         }
 913     }
 914 }
 915 \f
 916 /* Set rc->target and rc->name to 'target' and 'name', respectively.  If 'name'
 917  * is null, 'target' is used.
 918  *
 919  * Also, clear out the cached IP address and port information, since changing
 920  * the target also likely changes these values. */
 921 static void
 922 rconn_set_target__(struct rconn *rc, const char *target, const char *name)
 923 {
 924     free(rc->name);
 925     rc->name = xstrdup(name ? name : target);
 926     free(rc->target);
 927     rc->target = xstrdup(target);
 928     rc->local_ip = 0;
 929     rc->remote_ip = 0;
 930     rc->remote_port = 0;
 931 }
 932
 933 /* Tries to send a packet from 'rc''s send buffer.  Returns 0 if successful,
 934  * otherwise a positive errno value. */
 935 static int
 936 try_send(struct rconn *rc)
 937 {
 938     struct ofpbuf *msg = ofpbuf_from_list(rc->txq.next);
 939     unsigned int n_bytes = msg->size;
 940     struct rconn_packet_counter *counter = msg->private_p;
 941     int retval;
 942
 943     /* Eagerly remove 'msg' from the txq.  We can't remove it from the list
 944      * after sending, if sending is successful, because it is then owned by the
 945      * vconn, which might have freed it already. */
 946     list_remove(&msg->list_node);
 947
 948     retval = vconn_send(rc->vconn, msg);
 949     if (retval) {
 950         list_push_front(&rc->txq, &msg->list_node);
 951         if (retval != EAGAIN) {
 952             report_error(rc, retval);
 953             disconnect(rc, retval);
 954         }
 955         return retval;
 956     }
 957     COVERAGE_INC(rconn_sent);
 958     rc->packets_sent++;
 959     if (counter) {
 960         rconn_packet_counter_dec(counter, n_bytes);
 961     }
 962     return 0;
 963 }
 964
 965 /* Reports that 'error' caused 'rc' to disconnect.  'error' may be a positive
 966  * errno value, or it may be EOF to indicate that the connection was closed
 967  * normally. */
 968 static void
 969 report_error(struct rconn *rc, int error)
 970 {
 971     if (error == EOF) {
 972         /* If 'rc' isn't reliable, then we don't really expect this connection
 973          * to last forever anyway (probably it's a connection that we received
 974          * via accept()), so use DBG level to avoid cluttering the logs. */
 975         enum vlog_level level = rc->reliable ? VLL_INFO : VLL_DBG;
 976         VLOG(level, "%s: connection closed by peer", rc->name);
 977     } else {
 978         VLOG_WARN("%s: connection dropped (%s)", rc->name, strerror(error));
 979     }
 980 }
 981
 982 /* Disconnects 'rc' and records 'error' as the error that caused 'rc''s last
 983  * disconnection:
 984  *
 985  *   - 0 means that this disconnection is due to a request by 'rc''s client,
 986  *     not due to any kind of network error.
 987  *
 988  *   - EOF means that the connection was closed in the normal way by the peer.
 989  *
 990  *   - A positive integer is an errno value that represents the error.
 991  */
 992 static void
 993 disconnect(struct rconn *rc, int error)
 994 {
 995     rc->last_error = error;
 996     if (rc->reliable) {
 997         time_t now = time_now();
 998
 999         if (rc->state & (S_CONNECTING | S_ACTIVE | S_IDLE)) {
1000             rc->last_disconnected = now;
1001             vconn_close(rc->vconn);
1002             rc->vconn = NULL;
1003             flush_queue(rc);
1004         }
1005
1006         if (now >= rc->backoff_deadline) {
1007             rc->backoff = 1;
1008         } else if (rc->backoff < rc->max_backoff / 2) {
1009             rc->backoff = MAX(1, 2 * rc->backoff);
1010             VLOG_INFO("%s: waiting %d seconds before reconnect",
1011                       rc->name, rc->backoff);
1012         } else {
1013             if (rconn_logging_connection_attempts__(rc)) {
1014                 VLOG_INFO("%s: continuing to retry connections in the "
1015                           "background but suppressing further logging",
1016                           rc->name);
1017             }
1018             rc->backoff = rc->max_backoff;
1019         }
1020         rc->backoff_deadline = now + rc->backoff;
1021         state_transition(rc, S_BACKOFF);
1022     } else {
1023         rc->last_disconnected = time_now();
1024         rconn_disconnect(rc);
1025     }
1026 }
1027
1028 /* Drops all the packets from 'rc''s send queue and decrements their queue
1029  * counts. */
1030 static void
1031 flush_queue(struct rconn *rc)
1032 {
1033     if (list_is_empty(&rc->txq)) {
1034         return;
1035     }
1036     while (!list_is_empty(&rc->txq)) {
1037         struct ofpbuf *b = ofpbuf_from_list(list_pop_front(&rc->txq));
1038         struct rconn_packet_counter *counter = b->private_p;
1039         if (counter) {
1040             rconn_packet_counter_dec(counter, b->size);
1041         }
1042         COVERAGE_INC(rconn_discarded);
1043         ofpbuf_delete(b);
1044     }
1045     poll_immediate_wake();
1046 }
1047
1048 static unsigned int
1049 elapsed_in_this_state(const struct rconn *rc)
1050 {
1051     return time_now() - rc->state_entered;
1052 }
1053
1054 static unsigned int
1055 timeout(const struct rconn *rc)
1056 {
1057     switch (rc->state) {
1058 #define STATE(NAME, VALUE) case S_##NAME: return timeout_##NAME(rc);
1059         STATES
1060 #undef STATE
1061     default:
1062         NOT_REACHED();
1063     }
1064 }
1065
1066 static bool
1067 timed_out(const struct rconn *rc)
1068 {
1069     return time_now() >= sat_add(rc->state_entered, timeout(rc));
1070 }
1071
1072 static void
1073 state_transition(struct rconn *rc, enum state state)
1074 {
1075     rc->seqno += (rc->state == S_ACTIVE) != (state == S_ACTIVE);
1076     if (is_connected_state(state) && !is_connected_state(rc->state)) {
1077         rc->probably_admitted = false;
1078     }
1079     if (rconn_is_connected(rc)) {
1080         rc->total_time_connected += elapsed_in_this_state(rc);
1081     }
1082     VLOG_DBG("%s: entering %s", rc->name, state_name(state));
1083     rc->state = state;
1084     rc->state_entered = time_now();
1085 }
1086
1087 static void
1088 copy_to_monitor(struct rconn *rc, const struct ofpbuf *b)
1089 {
1090     struct ofpbuf *clone = NULL;
1091     int retval;
1092     size_t i;
1093
1094     for (i = 0; i < rc->n_monitors; ) {
1095         struct vconn *vconn = rc->monitors[i];
1096
1097         if (!clone) {
1098             clone = ofpbuf_clone(b);
1099         }
1100         retval = vconn_send(vconn, clone);
1101         if (!retval) {
1102             clone = NULL;
1103         } else if (retval != EAGAIN) {
1104             VLOG_DBG("%s: closing monitor connection to %s: %s",
1105                      rconn_get_name(rc), vconn_get_name(vconn),
1106                      strerror(retval));
1107             rc->monitors[i] = rc->monitors[--rc->n_monitors];
1108             continue;
1109         }
1110         i++;
1111     }
1112     ofpbuf_delete(clone);
1113 }
1114
1115 static bool
1116 is_connected_state(enum state state)
1117 {
1118     return (state & (S_ACTIVE | S_IDLE)) != 0;
1119 }
1120
1121 static bool
1122 is_admitted_msg(const struct ofpbuf *b)
1123 {
1124     struct ofp_header *oh = b->data;
1125     uint8_t type = oh->type;
1126     return !(type < 32
1127              && (1u << type) & ((1u << OFPT_HELLO) |
1128                                 (1u << OFPT_ERROR) |
1129                                 (1u << OFPT_ECHO_REQUEST) |
1130                                 (1u << OFPT_ECHO_REPLY) |
1131                                 (1u << OFPT_VENDOR) |
1132                                 (1u << OFPT_FEATURES_REQUEST) |
1133                                 (1u << OFPT_FEATURES_REPLY) |
1134                                 (1u << OFPT_GET_CONFIG_REQUEST) |
1135                                 (1u << OFPT_GET_CONFIG_REPLY) |
1136                                 (1u << OFPT_SET_CONFIG)));
1137 }
1138
1139 /* Returns true if 'rc' is currently logging information about connection
1140  * attempts, false if logging should be suppressed because 'rc' hasn't
1141  * successuflly connected in too long. */
1142 static bool
1143 rconn_logging_connection_attempts__(const struct rconn *rc)
1144 {
1145     return rc->backoff < rc->max_backoff;
1146 }