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