lib/rconn.c

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011 Nicira Networks.
   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     /* If we can't connect to the peer, it could be for any number of reasons.
 108      * Usually, one would assume it is because the peer is not running or
 109      * because the network is partitioned.  But it could also be because the
 110      * network topology has changed, in which case the upper layer will need to
 111      * reassess it (in particular, obtain a new IP address via DHCP and find
 112      * the new location of the controller).  We set this flag when we suspect
 113      * that this could be the case. */
 114     bool questionable_connectivity;
 115     time_t last_questioned;
 116
 117     /* Throughout this file, "probe" is shorthand for "inactivity probe".
 118      * When nothing has been received from the peer for a while, we send out
 119      * an echo request as an inactivity probe packet.  We should receive back
 120      * a response. */
 121     int probe_interval;         /* Secs of inactivity before sending probe. */
 122
 123     /* When we create a vconn we obtain these values, to save them past the end
 124      * of the vconn's lifetime.  Otherwise, in-band control will only allow
 125      * traffic when a vconn is actually open, but it is nice to allow ARP to
 126      * complete even between connection attempts, and it is also polite to
 127      * allow traffic from other switches to go through to the controller
 128      * whether or not we are connected.
 129      *
 130      * We don't cache the local port, because that changes from one connection
 131      * attempt to the next. */
 132     uint32_t local_ip, remote_ip;
 133     uint16_t remote_port;
 134
 135     /* Messages sent or received are copied to the monitor connections. */
 136 #define MAX_MONITORS 8
 137     struct vconn *monitors[8];
 138     size_t n_monitors;
 139 };
 140
 141 static unsigned int elapsed_in_this_state(const struct rconn *);
 142 static unsigned int timeout(const struct rconn *);
 143 static bool timed_out(const struct rconn *);
 144 static void state_transition(struct rconn *, enum state);
 145 static void rconn_set_target__(struct rconn *,
 146                                const char *target, const char *name);
 147 static int try_send(struct rconn *);
 148 static void reconnect(struct rconn *);
 149 static void report_error(struct rconn *, int error);
 150 static void disconnect(struct rconn *, int error);
 151 static void flush_queue(struct rconn *);
 152 static void question_connectivity(struct rconn *);
 153 static void copy_to_monitor(struct rconn *, const struct ofpbuf *);
 154 static bool is_connected_state(enum state);
 155 static bool is_admitted_msg(const struct ofpbuf *);
 156 static bool rconn_logging_connection_attempts__(const struct rconn *);
 157
 158 /* Creates and returns a new rconn.
 159  *
 160  * 'probe_interval' is a number of seconds.  If the interval passes once
 161  * without an OpenFlow message being received from the peer, the rconn sends
 162  * out an "echo request" message.  If the interval passes again without a
 163  * message being received, the rconn disconnects and re-connects to the peer.
 164  * Setting 'probe_interval' to 0 disables this behavior.
 165  *
 166  * 'max_backoff' is the maximum number of seconds between attempts to connect
 167  * to the peer.  The actual interval starts at 1 second and doubles on each
 168  * failure until it reaches 'max_backoff'.  If 0 is specified, the default of
 169  * 8 seconds is used.
 170  *
 171  * The new rconn is initially unconnected.  Use rconn_connect() or
 172  * rconn_connect_unreliably() to connect it. */
 173 struct rconn *
 174 rconn_create(int probe_interval, int max_backoff)
 175 {
 176     struct rconn *rc = xzalloc(sizeof *rc);
 177
 178     rc->state = S_VOID;
 179     rc->state_entered = time_now();
 180
 181     rc->vconn = NULL;
 182     rc->name = xstrdup("void");
 183     rc->target = xstrdup("void");
 184     rc->reliable = false;
 185
 186     list_init(&rc->txq);
 187
 188     rc->backoff = 0;
 189     rc->max_backoff = max_backoff ? max_backoff : 8;
 190     rc->backoff_deadline = TIME_MIN;
 191     rc->last_received = time_now();
 192     rc->last_connected = TIME_MIN;
 193     rc->last_disconnected = TIME_MIN;
 194     rc->seqno = 0;
 195
 196     rc->packets_sent = 0;
 197
 198     rc->probably_admitted = false;
 199     rc->last_admitted = time_now();
 200
 201     rc->packets_received = 0;
 202     rc->n_attempted_connections = 0;
 203     rc->n_successful_connections = 0;
 204     rc->creation_time = time_now();
 205     rc->total_time_connected = 0;
 206
 207     rc->questionable_connectivity = false;
 208     rc->last_questioned = time_now();
 209
 210     rconn_set_probe_interval(rc, probe_interval);
 211
 212     rc->n_monitors = 0;
 213
 214     return rc;
 215 }
 216
 217 void
 218 rconn_set_max_backoff(struct rconn *rc, int max_backoff)
 219 {
 220     rc->max_backoff = MAX(1, max_backoff);
 221     if (rc->state == S_BACKOFF && rc->backoff > max_backoff) {
 222         rc->backoff = max_backoff;
 223         if (rc->backoff_deadline > time_now() + max_backoff) {
 224             rc->backoff_deadline = time_now() + max_backoff;
 225         }
 226     }
 227 }
 228
 229 int
 230 rconn_get_max_backoff(const struct rconn *rc)
 231 {
 232     return rc->max_backoff;
 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, OFP_VERSION, &rc->vconn);
 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         question_connectivity(rc);
 468         VLOG_ERR("%s: no response to inactivity probe after %u "
 469                  "seconds, disconnecting",
 470                  rc->name, elapsed_in_this_state(rc));
 471         disconnect(rc, ETIMEDOUT);
 472     } else {
 473         do_tx_work(rc);
 474     }
 475 }
 476
 477 /* Performs whatever activities are necessary to maintain 'rc': if 'rc' is
 478  * disconnected, attempts to (re)connect, backing off as necessary; if 'rc' is
 479  * connected, attempts to send packets in the send queue, if any. */
 480 void
 481 rconn_run(struct rconn *rc)
 482 {
 483     int old_state;
 484     size_t i;
 485
 486     if (rc->vconn) {
 487         vconn_run(rc->vconn);
 488     }
 489     for (i = 0; i < rc->n_monitors; i++) {
 490         vconn_run(rc->monitors[i]);
 491     }
 492
 493     do {
 494         old_state = rc->state;
 495         switch (rc->state) {
 496 #define STATE(NAME, VALUE) case S_##NAME: run_##NAME(rc); break;
 497             STATES
 498 #undef STATE
 499         default:
 500             NOT_REACHED();
 501         }
 502     } while (rc->state != old_state);
 503 }
 504
 505 /* Causes the next call to poll_block() to wake up when rconn_run() should be
 506  * called on 'rc'. */
 507 void
 508 rconn_run_wait(struct rconn *rc)
 509 {
 510     unsigned int timeo;
 511     size_t i;
 512
 513     if (rc->vconn) {
 514         vconn_run_wait(rc->vconn);
 515         if ((rc->state & (S_ACTIVE | S_IDLE)) && !list_is_empty(&rc->txq)) {
 516             vconn_wait(rc->vconn, WAIT_SEND);
 517         }
 518     }
 519     for (i = 0; i < rc->n_monitors; i++) {
 520         vconn_run_wait(rc->monitors[i]);
 521     }
 522
 523     timeo = timeout(rc);
 524     if (timeo != UINT_MAX) {
 525         long long int expires = sat_add(rc->state_entered, timeo);
 526         poll_timer_wait_until(expires * 1000);
 527     }
 528 }
 529
 530 /* Attempts to receive a packet from 'rc'.  If successful, returns the packet;
 531  * otherwise, returns a null pointer.  The caller is responsible for freeing
 532  * the packet (with ofpbuf_delete()). */
 533 struct ofpbuf *
 534 rconn_recv(struct rconn *rc)
 535 {
 536     if (rc->state & (S_ACTIVE | S_IDLE)) {
 537         struct ofpbuf *buffer;
 538         int error = vconn_recv(rc->vconn, &buffer);
 539         if (!error) {
 540             copy_to_monitor(rc, buffer);
 541             if (rc->probably_admitted || is_admitted_msg(buffer)
 542                 || time_now() - rc->last_connected >= 30) {
 543                 rc->probably_admitted = true;
 544                 rc->last_admitted = time_now();
 545             }
 546             rc->last_received = time_now();
 547             rc->packets_received++;
 548             if (rc->state == S_IDLE) {
 549                 state_transition(rc, S_ACTIVE);
 550             }
 551             return buffer;
 552         } else if (error != EAGAIN) {
 553             report_error(rc, error);
 554             disconnect(rc, error);
 555         }
 556     }
 557     return NULL;
 558 }
 559
 560 /* Causes the next call to poll_block() to wake up when a packet may be ready
 561  * to be received by vconn_recv() on 'rc'.  */
 562 void
 563 rconn_recv_wait(struct rconn *rc)
 564 {
 565     if (rc->vconn) {
 566         vconn_wait(rc->vconn, WAIT_RECV);
 567     }
 568 }
 569
 570 /* Sends 'b' on 'rc'.  Returns 0 if successful (in which case 'b' is
 571  * destroyed), or ENOTCONN if 'rc' is not currently connected (in which case
 572  * the caller retains ownership of 'b').
 573  *
 574  * If 'counter' is non-null, then 'counter' will be incremented while the
 575  * packet is in flight, then decremented when it has been sent (or discarded
 576  * due to disconnection).  Because 'b' may be sent (or discarded) before this
 577  * function returns, the caller may not be able to observe any change in
 578  * 'counter'.
 579  *
 580  * There is no rconn_send_wait() function: an rconn has a send queue that it
 581  * takes care of sending if you call rconn_run(), which will have the side
 582  * effect of waking up poll_block(). */
 583 int
 584 rconn_send(struct rconn *rc, struct ofpbuf *b,
 585            struct rconn_packet_counter *counter)
 586 {
 587     if (rconn_is_connected(rc)) {
 588         COVERAGE_INC(rconn_queued);
 589         copy_to_monitor(rc, b);
 590         b->private_p = counter;
 591         if (counter) {
 592             rconn_packet_counter_inc(counter);
 593         }
 594         list_push_back(&rc->txq, &b->list_node);
 595
 596         /* If the queue was empty before we added 'b', try to send some
 597          * packets.  (But if the queue had packets in it, it's because the
 598          * vconn is backlogged and there's no point in stuffing more into it
 599          * now.  We'll get back to that in rconn_run().) */
 600         if (rc->txq.next == &b->list_node) {
 601             try_send(rc);
 602         }
 603         return 0;
 604     } else {
 605         return ENOTCONN;
 606     }
 607 }
 608
 609 /* Sends 'b' on 'rc'.  Increments 'counter' while the packet is in flight; it
 610  * will be decremented when it has been sent (or discarded due to
 611  * disconnection).  Returns 0 if successful, EAGAIN if 'counter->n' is already
 612  * at least as large as 'queue_limit', or ENOTCONN if 'rc' is not currently
 613  * connected.  Regardless of return value, 'b' is destroyed.
 614  *
 615  * Because 'b' may be sent (or discarded) before this function returns, the
 616  * caller may not be able to observe any change in 'counter'.
 617  *
 618  * There is no rconn_send_wait() function: an rconn has a send queue that it
 619  * takes care of sending if you call rconn_run(), which will have the side
 620  * effect of waking up poll_block(). */
 621 int
 622 rconn_send_with_limit(struct rconn *rc, struct ofpbuf *b,
 623                       struct rconn_packet_counter *counter, int queue_limit)
 624 {
 625     int retval;
 626     retval = counter->n >= queue_limit ? EAGAIN : rconn_send(rc, b, counter);
 627     if (retval) {
 628         COVERAGE_INC(rconn_overflow);
 629         ofpbuf_delete(b);
 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 uint32_t
 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 uint16_t
 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 uint32_t
 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 uint16_t
 744 rconn_get_local_port(const struct rconn *rconn)
 745 {
 746     return rconn->vconn ? vconn_get_local_port(rconn->vconn) : 0;
 747 }
 748
 749 /* If 'rconn' can't connect to the peer, it could be for any number of reasons.
 750  * Usually, one would assume it is because the peer is not running or because
 751  * the network is partitioned.  But it could also be because the network
 752  * topology has changed, in which case the upper layer will need to reassess it
 753  * (in particular, obtain a new IP address via DHCP and find the new location
 754  * of the controller).  When this appears that this might be the case, this
 755  * function returns true.  It also clears the questionability flag and prevents
 756  * it from being set again for some time. */
 757 bool
 758 rconn_is_connectivity_questionable(struct rconn *rconn)
 759 {
 760     bool questionable = rconn->questionable_connectivity;
 761     rconn->questionable_connectivity = false;
 762     return questionable;
 763 }
 764
 765 /* Returns the total number of packets successfully received by the underlying
 766  * vconn.  */
 767 unsigned int
 768 rconn_packets_received(const struct rconn *rc)
 769 {
 770     return rc->packets_received;
 771 }
 772
 773 /* Returns a string representing the internal state of 'rc'.  The caller must
 774  * not modify or free the string. */
 775 const char *
 776 rconn_get_state(const struct rconn *rc)
 777 {
 778     return state_name(rc->state);
 779 }
 780
 781 /* Returns the number of connection attempts made by 'rc', including any
 782  * ongoing attempt that has not yet succeeded or failed. */
 783 unsigned int
 784 rconn_get_attempted_connections(const struct rconn *rc)
 785 {
 786     return rc->n_attempted_connections;
 787 }
 788
 789 /* Returns the number of successful connection attempts made by 'rc'. */
 790 unsigned int
 791 rconn_get_successful_connections(const struct rconn *rc)
 792 {
 793     return rc->n_successful_connections;
 794 }
 795
 796 /* Returns the time at which the last successful connection was made by
 797  * 'rc'. Returns TIME_MIN if never connected. */
 798 time_t
 799 rconn_get_last_connection(const struct rconn *rc)
 800 {
 801     return rc->last_connected;
 802 }
 803
 804 /* Returns the time at which 'rc' was last disconnected. Returns TIME_MIN
 805  * if never disconnected. */
 806 time_t
 807 rconn_get_last_disconnect(const struct rconn *rc)
 808 {
 809     return rc->last_disconnected;
 810 }
 811
 812 /* Returns the time at which the last OpenFlow message was received by 'rc'.
 813  * If no packets have been received on 'rc', returns the time at which 'rc'
 814  * was created. */
 815 time_t
 816 rconn_get_last_received(const struct rconn *rc)
 817 {
 818     return rc->last_received;
 819 }
 820
 821 /* Returns the time at which 'rc' was created. */
 822 time_t
 823 rconn_get_creation_time(const struct rconn *rc)
 824 {
 825     return rc->creation_time;
 826 }
 827
 828 /* Returns the approximate number of seconds that 'rc' has been connected. */
 829 unsigned long int
 830 rconn_get_total_time_connected(const struct rconn *rc)
 831 {
 832     return (rc->total_time_connected
 833             + (rconn_is_connected(rc) ? elapsed_in_this_state(rc) : 0));
 834 }
 835
 836 /* Returns the current amount of backoff, in seconds.  This is the amount of
 837  * time after which the rconn will transition from BACKOFF to CONNECTING. */
 838 int
 839 rconn_get_backoff(const struct rconn *rc)
 840 {
 841     return rc->backoff;
 842 }
 843
 844 /* Returns the number of seconds spent in this state so far. */
 845 unsigned int
 846 rconn_get_state_elapsed(const struct rconn *rc)
 847 {
 848     return elapsed_in_this_state(rc);
 849 }
 850
 851 /* Returns 'rc''s current connection sequence number, a number that changes
 852  * every time that 'rconn' connects or disconnects. */
 853 unsigned int
 854 rconn_get_connection_seqno(const struct rconn *rc)
 855 {
 856     return rc->seqno;
 857 }
 858
 859 /* Returns a value that explains why 'rc' last disconnected:
 860  *
 861  *   - 0 means that the last disconnection was caused by a call to
 862  *     rconn_disconnect(), or that 'rc' is new and has not yet completed its
 863  *     initial connection or connection attempt.
 864  *
 865  *   - EOF means that the connection was closed in the normal way by the peer.
 866  *
 867  *   - A positive integer is an errno value that represents the error.
 868  */
 869 int
 870 rconn_get_last_error(const struct rconn *rc)
 871 {
 872     return rc->last_error;
 873 }
 874 \f
 875 struct rconn_packet_counter *
 876 rconn_packet_counter_create(void)
 877 {
 878     struct rconn_packet_counter *c = xmalloc(sizeof *c);
 879     c->n = 0;
 880     c->ref_cnt = 1;
 881     return c;
 882 }
 883
 884 void
 885 rconn_packet_counter_destroy(struct rconn_packet_counter *c)
 886 {
 887     if (c) {
 888         assert(c->ref_cnt > 0);
 889         if (!--c->ref_cnt && !c->n) {
 890             free(c);
 891         }
 892     }
 893 }
 894
 895 void
 896 rconn_packet_counter_inc(struct rconn_packet_counter *c)
 897 {
 898     c->n++;
 899 }
 900
 901 void
 902 rconn_packet_counter_dec(struct rconn_packet_counter *c)
 903 {
 904     assert(c->n > 0);
 905     if (!--c->n && !c->ref_cnt) {
 906         free(c);
 907     }
 908 }
 909 \f
 910 /* Set rc->target and rc->name to 'target' and 'name', respectively.  If 'name'
 911  * is null, 'target' is used.
 912  *
 913  * Also, clear out the cached IP address and port information, since changing
 914  * the target also likely changes these values. */
 915 static void
 916 rconn_set_target__(struct rconn *rc, const char *target, const char *name)
 917 {
 918     free(rc->name);
 919     rc->name = xstrdup(name ? name : target);
 920     free(rc->target);
 921     rc->target = xstrdup(target);
 922     rc->local_ip = 0;
 923     rc->remote_ip = 0;
 924     rc->remote_port = 0;
 925 }
 926
 927 /* Tries to send a packet from 'rc''s send buffer.  Returns 0 if successful,
 928  * otherwise a positive errno value. */
 929 static int
 930 try_send(struct rconn *rc)
 931 {
 932     struct ofpbuf *msg = ofpbuf_from_list(rc->txq.next);
 933     struct rconn_packet_counter *counter = msg->private_p;
 934     int retval;
 935
 936     /* Eagerly remove 'msg' from the txq.  We can't remove it from the list
 937      * after sending, if sending is successful, because it is then owned by the
 938      * vconn, which might have freed it already. */
 939     list_remove(&msg->list_node);
 940
 941     retval = vconn_send(rc->vconn, msg);
 942     if (retval) {
 943         list_push_front(&rc->txq, &msg->list_node);
 944         if (retval != EAGAIN) {
 945             report_error(rc, retval);
 946             disconnect(rc, retval);
 947         }
 948         return retval;
 949     }
 950     COVERAGE_INC(rconn_sent);
 951     rc->packets_sent++;
 952     if (counter) {
 953         rconn_packet_counter_dec(counter);
 954     }
 955     return 0;
 956 }
 957
 958 /* Reports that 'error' caused 'rc' to disconnect.  'error' may be a positive
 959  * errno value, or it may be EOF to indicate that the connection was closed
 960  * normally. */
 961 static void
 962 report_error(struct rconn *rc, int error)
 963 {
 964     if (error == EOF) {
 965         /* If 'rc' isn't reliable, then we don't really expect this connection
 966          * to last forever anyway (probably it's a connection that we received
 967          * via accept()), so use DBG level to avoid cluttering the logs. */
 968         enum vlog_level level = rc->reliable ? VLL_INFO : VLL_DBG;
 969         VLOG(level, "%s: connection closed by peer", rc->name);
 970     } else {
 971         VLOG_WARN("%s: connection dropped (%s)", rc->name, strerror(error));
 972     }
 973 }
 974
 975 /* Disconnects 'rc' and records 'error' as the error that caused 'rc''s last
 976  * disconnection:
 977  *
 978  *   - 0 means that this disconnection is due to a request by 'rc''s client,
 979  *     not due to any kind of network error.
 980  *
 981  *   - EOF means that the connection was closed in the normal way by the peer.
 982  *
 983  *   - A positive integer is an errno value that represents the error.
 984  */
 985 static void
 986 disconnect(struct rconn *rc, int error)
 987 {
 988     rc->last_error = error;
 989     if (rc->reliable) {
 990         time_t now = time_now();
 991
 992         if (rc->state & (S_CONNECTING | S_ACTIVE | S_IDLE)) {
 993             rc->last_disconnected = now;
 994             vconn_close(rc->vconn);
 995             rc->vconn = NULL;
 996             flush_queue(rc);
 997         }
 998
 999         if (now >= rc->backoff_deadline) {
1000             rc->backoff = 1;
1001         } else if (rc->backoff < rc->max_backoff / 2) {
1002             rc->backoff = MAX(1, 2 * rc->backoff);
1003             VLOG_INFO("%s: waiting %d seconds before reconnect",
1004                       rc->name, rc->backoff);
1005         } else {
1006             if (rconn_logging_connection_attempts__(rc)) {
1007                 VLOG_INFO("%s: continuing to retry connections in the "
1008                           "background but suppressing further logging",
1009                           rc->name);
1010             }
1011             rc->backoff = rc->max_backoff;
1012         }
1013         rc->backoff_deadline = now + rc->backoff;
1014         state_transition(rc, S_BACKOFF);
1015         if (now - rc->last_connected > 60) {
1016             question_connectivity(rc);
1017         }
1018     } else {
1019         rc->last_disconnected = time_now();
1020         rconn_disconnect(rc);
1021     }
1022 }
1023
1024 /* Drops all the packets from 'rc''s send queue and decrements their queue
1025  * counts. */
1026 static void
1027 flush_queue(struct rconn *rc)
1028 {
1029     if (list_is_empty(&rc->txq)) {
1030         return;
1031     }
1032     while (!list_is_empty(&rc->txq)) {
1033         struct ofpbuf *b = ofpbuf_from_list(list_pop_front(&rc->txq));
1034         struct rconn_packet_counter *counter = b->private_p;
1035         if (counter) {
1036             rconn_packet_counter_dec(counter);
1037         }
1038         COVERAGE_INC(rconn_discarded);
1039         ofpbuf_delete(b);
1040     }
1041     poll_immediate_wake();
1042 }
1043
1044 static unsigned int
1045 elapsed_in_this_state(const struct rconn *rc)
1046 {
1047     return time_now() - rc->state_entered;
1048 }
1049
1050 static unsigned int
1051 timeout(const struct rconn *rc)
1052 {
1053     switch (rc->state) {
1054 #define STATE(NAME, VALUE) case S_##NAME: return timeout_##NAME(rc);
1055         STATES
1056 #undef STATE
1057     default:
1058         NOT_REACHED();
1059     }
1060 }
1061
1062 static bool
1063 timed_out(const struct rconn *rc)
1064 {
1065     return time_now() >= sat_add(rc->state_entered, timeout(rc));
1066 }
1067
1068 static void
1069 state_transition(struct rconn *rc, enum state state)
1070 {
1071     rc->seqno += (rc->state == S_ACTIVE) != (state == S_ACTIVE);
1072     if (is_connected_state(state) && !is_connected_state(rc->state)) {
1073         rc->probably_admitted = false;
1074     }
1075     if (rconn_is_connected(rc)) {
1076         rc->total_time_connected += elapsed_in_this_state(rc);
1077     }
1078     VLOG_DBG("%s: entering %s", rc->name, state_name(state));
1079     rc->state = state;
1080     rc->state_entered = time_now();
1081 }
1082
1083 static void
1084 question_connectivity(struct rconn *rc)
1085 {
1086     time_t now = time_now();
1087     if (now - rc->last_questioned > 60) {
1088         rc->questionable_connectivity = true;
1089         rc->last_questioned = now;
1090     }
1091 }
1092
1093 static void
1094 copy_to_monitor(struct rconn *rc, const struct ofpbuf *b)
1095 {
1096     struct ofpbuf *clone = NULL;
1097     int retval;
1098     size_t i;
1099
1100     for (i = 0; i < rc->n_monitors; ) {
1101         struct vconn *vconn = rc->monitors[i];
1102
1103         if (!clone) {
1104             clone = ofpbuf_clone(b);
1105         }
1106         retval = vconn_send(vconn, clone);
1107         if (!retval) {
1108             clone = NULL;
1109         } else if (retval != EAGAIN) {
1110             VLOG_DBG("%s: closing monitor connection to %s: %s",
1111                      rconn_get_name(rc), vconn_get_name(vconn),
1112                      strerror(retval));
1113             rc->monitors[i] = rc->monitors[--rc->n_monitors];
1114             continue;
1115         }
1116         i++;
1117     }
1118     ofpbuf_delete(clone);
1119 }
1120
1121 static bool
1122 is_connected_state(enum state state)
1123 {
1124     return (state & (S_ACTIVE | S_IDLE)) != 0;
1125 }
1126
1127 static bool
1128 is_admitted_msg(const struct ofpbuf *b)
1129 {
1130     struct ofp_header *oh = b->data;
1131     uint8_t type = oh->type;
1132     return !(type < 32
1133              && (1u << type) & ((1u << OFPT_HELLO) |
1134                                 (1u << OFPT_ERROR) |
1135                                 (1u << OFPT_ECHO_REQUEST) |
1136                                 (1u << OFPT_ECHO_REPLY) |
1137                                 (1u << OFPT_VENDOR) |
1138                                 (1u << OFPT_FEATURES_REQUEST) |
1139                                 (1u << OFPT_FEATURES_REPLY) |
1140                                 (1u << OFPT_GET_CONFIG_REQUEST) |
1141                                 (1u << OFPT_GET_CONFIG_REPLY) |
1142                                 (1u << OFPT_SET_CONFIG)));
1143 }
1144
1145 /* Returns true if 'rc' is currently logging information about connection
1146  * attempts, false if logging should be suppressed because 'rc' hasn't
1147  * successuflly connected in too long. */
1148 static bool
1149 rconn_logging_connection_attempts__(const struct rconn *rc)
1150 {
1151     return rc->backoff < rc->max_backoff;
1152 }