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