lib/rconn.c

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