lib/rconn.c

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