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