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