lib/rconn.c

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