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