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