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 <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: 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     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)", rc->name, strerror(retval));
 383         rc->backoff_deadline = TIME_MAX; /* Prevent resetting backoff. */
 384         disconnect(rc, retval);
 385     }
 386 }
 387
 388 static unsigned int
 389 timeout_BACKOFF(const struct rconn *rc)
 390 {
 391     return rc->backoff;
 392 }
 393
 394 static void
 395 run_BACKOFF(struct rconn *rc)
 396 {
 397     if (timed_out(rc)) {
 398         reconnect(rc);
 399     }
 400 }
 401
 402 static unsigned int
 403 timeout_CONNECTING(const struct rconn *rc)
 404 {
 405     return MAX(1, rc->backoff);
 406 }
 407
 408 static void
 409 run_CONNECTING(struct rconn *rc)
 410 {
 411     int retval = vconn_connect(rc->vconn);
 412     if (!retval) {
 413         VLOG_INFO("%s: connected", rc->name);
 414         rc->n_successful_connections++;
 415         state_transition(rc, S_ACTIVE);
 416         rc->last_connected = rc->state_entered;
 417     } else if (retval != EAGAIN) {
 418         if (rconn_logging_connection_attempts__(rc)) {
 419             VLOG_INFO("%s: connection failed (%s)",
 420                       rc->name, strerror(retval));
 421         }
 422         disconnect(rc, retval);
 423     } else if (timed_out(rc)) {
 424         if (rconn_logging_connection_attempts__(rc)) {
 425             VLOG_INFO("%s: connection timed out", rc->name);
 426         }
 427         rc->backoff_deadline = TIME_MAX; /* Prevent resetting backoff. */
 428         disconnect(rc, ETIMEDOUT);
 429     }
 430 }
 431
 432 static void
 433 do_tx_work(struct rconn *rc)
 434 {
 435     if (list_is_empty(&rc->txq)) {
 436         return;
 437     }
 438     while (!list_is_empty(&rc->txq)) {
 439         int error = try_send(rc);
 440         if (error) {
 441             break;
 442         }
 443         rc->last_activity = time_now();
 444     }
 445     if (list_is_empty(&rc->txq)) {
 446         poll_immediate_wake();
 447     }
 448 }
 449
 450 static unsigned int
 451 timeout_ACTIVE(const struct rconn *rc)
 452 {
 453     if (rc->probe_interval) {
 454         unsigned int base = MAX(rc->last_activity, rc->state_entered);
 455         unsigned int arg = base + rc->probe_interval - rc->state_entered;
 456         return arg;
 457     }
 458     return UINT_MAX;
 459 }
 460
 461 static void
 462 run_ACTIVE(struct rconn *rc)
 463 {
 464     if (timed_out(rc)) {
 465         unsigned int base = MAX(rc->last_activity, rc->state_entered);
 466         int version;
 467
 468         VLOG_DBG("%s: idle %u seconds, sending inactivity probe",
 469                  rc->name, (unsigned int) (time_now() - base));
 470
 471         version = rconn_get_version(rc);
 472         assert(version >= 0 && version <= 0xff);
 473
 474         /* Ordering is important here: rconn_send() can transition to BACKOFF,
 475          * and we don't want to transition back to IDLE if so, because then we
 476          * can end up queuing a packet with vconn == NULL and then *boom*. */
 477         state_transition(rc, S_IDLE);
 478         rconn_send(rc, make_echo_request(version), NULL);
 479         return;
 480     }
 481
 482     do_tx_work(rc);
 483 }
 484
 485 static unsigned int
 486 timeout_IDLE(const struct rconn *rc)
 487 {
 488     return rc->probe_interval;
 489 }
 490
 491 static void
 492 run_IDLE(struct rconn *rc)
 493 {
 494     if (timed_out(rc)) {
 495         VLOG_ERR("%s: no response to inactivity probe after %u "
 496                  "seconds, disconnecting",
 497                  rc->name, elapsed_in_this_state(rc));
 498         disconnect(rc, ETIMEDOUT);
 499     } else {
 500         do_tx_work(rc);
 501     }
 502 }
 503
 504 /* Performs whatever activities are necessary to maintain 'rc': if 'rc' is
 505  * disconnected, attempts to (re)connect, backing off as necessary; if 'rc' is
 506  * connected, attempts to send packets in the send queue, if any. */
 507 void
 508 rconn_run(struct rconn *rc)
 509 {
 510     int old_state;
 511     size_t i;
 512
 513     if (rc->vconn) {
 514         vconn_run(rc->vconn);
 515     }
 516     for (i = 0; i < rc->n_monitors; i++) {
 517         vconn_run(rc->monitors[i]);
 518     }
 519
 520     do {
 521         old_state = rc->state;
 522         switch (rc->state) {
 523 #define STATE(NAME, VALUE) case S_##NAME: run_##NAME(rc); break;
 524             STATES
 525 #undef STATE
 526         default:
 527             NOT_REACHED();
 528         }
 529     } while (rc->state != old_state);
 530 }
 531
 532 /* Causes the next call to poll_block() to wake up when rconn_run() should be
 533  * called on 'rc'. */
 534 void
 535 rconn_run_wait(struct rconn *rc)
 536 {
 537     unsigned int timeo;
 538     size_t i;
 539
 540     if (rc->vconn) {
 541         vconn_run_wait(rc->vconn);
 542         if ((rc->state & (S_ACTIVE | S_IDLE)) && !list_is_empty(&rc->txq)) {
 543             vconn_wait(rc->vconn, WAIT_SEND);
 544         }
 545     }
 546     for (i = 0; i < rc->n_monitors; i++) {
 547         vconn_run_wait(rc->monitors[i]);
 548     }
 549
 550     timeo = timeout(rc);
 551     if (timeo != UINT_MAX) {
 552         long long int expires = sat_add(rc->state_entered, timeo);
 553         poll_timer_wait_until(expires * 1000);
 554     }
 555 }
 556
 557 /* Attempts to receive a packet from 'rc'.  If successful, returns the packet;
 558  * otherwise, returns a null pointer.  The caller is responsible for freeing
 559  * the packet (with ofpbuf_delete()). */
 560 struct ofpbuf *
 561 rconn_recv(struct rconn *rc)
 562 {
 563     if (rc->state & (S_ACTIVE | S_IDLE)) {
 564         struct ofpbuf *buffer;
 565         int error = vconn_recv(rc->vconn, &buffer);
 566         if (!error) {
 567             copy_to_monitor(rc, buffer);
 568             if (rc->probably_admitted || is_admitted_msg(buffer)
 569                 || time_now() - rc->last_connected >= 30) {
 570                 rc->probably_admitted = true;
 571                 rc->last_admitted = time_now();
 572             }
 573             rc->last_activity = time_now();
 574             rc->packets_received++;
 575             if (rc->state == S_IDLE) {
 576                 state_transition(rc, S_ACTIVE);
 577             }
 578             return buffer;
 579         } else if (error != EAGAIN) {
 580             report_error(rc, error);
 581             disconnect(rc, error);
 582         }
 583     }
 584     return NULL;
 585 }
 586
 587 /* Causes the next call to poll_block() to wake up when a packet may be ready
 588  * to be received by vconn_recv() on 'rc'.  */
 589 void
 590 rconn_recv_wait(struct rconn *rc)
 591 {
 592     if (rc->vconn) {
 593         vconn_wait(rc->vconn, WAIT_RECV);
 594     }
 595 }
 596
 597 /* Sends 'b' on 'rc'.  Returns 0 if successful, or ENOTCONN if 'rc' is not
 598  * currently connected.  Takes ownership of 'b'.
 599  *
 600  * If 'counter' is non-null, then 'counter' will be incremented while the
 601  * packet is in flight, then decremented when it has been sent (or discarded
 602  * due to disconnection).  Because 'b' may be sent (or discarded) before this
 603  * function returns, the caller may not be able to observe any change in
 604  * 'counter'.
 605  *
 606  * There is no rconn_send_wait() function: an rconn has a send queue that it
 607  * takes care of sending if you call rconn_run(), which will have the side
 608  * effect of waking up poll_block(). */
 609 int
 610 rconn_send(struct rconn *rc, struct ofpbuf *b,
 611            struct rconn_packet_counter *counter)
 612 {
 613     if (rconn_is_connected(rc)) {
 614         COVERAGE_INC(rconn_queued);
 615         copy_to_monitor(rc, b);
 616         b->private_p = counter;
 617         if (counter) {
 618             rconn_packet_counter_inc(counter, b->size);
 619         }
 620         list_push_back(&rc->txq, &b->list_node);
 621
 622         /* If the queue was empty before we added 'b', try to send some
 623          * packets.  (But if the queue had packets in it, it's because the
 624          * vconn is backlogged and there's no point in stuffing more into it
 625          * now.  We'll get back to that in rconn_run().) */
 626         if (rc->txq.next == &b->list_node) {
 627             try_send(rc);
 628         }
 629         return 0;
 630     } else {
 631         ofpbuf_delete(b);
 632         return ENOTCONN;
 633     }
 634 }
 635
 636 /* Sends 'b' on 'rc'.  Increments 'counter' while the packet is in flight; it
 637  * will be decremented when it has been sent (or discarded due to
 638  * disconnection).  Returns 0 if successful, EAGAIN if 'counter->n' is already
 639  * at least as large as 'queue_limit', or ENOTCONN if 'rc' is not currently
 640  * connected.  Regardless of return value, 'b' is destroyed.
 641  *
 642  * Because 'b' may be sent (or discarded) before this function returns, the
 643  * caller may not be able to observe any change in 'counter'.
 644  *
 645  * There is no rconn_send_wait() function: an rconn has a send queue that it
 646  * takes care of sending if you call rconn_run(), which will have the side
 647  * effect of waking up poll_block(). */
 648 int
 649 rconn_send_with_limit(struct rconn *rc, struct ofpbuf *b,
 650                       struct rconn_packet_counter *counter, int queue_limit)
 651 {
 652     if (counter->n_packets < queue_limit) {
 653         return rconn_send(rc, b, counter);
 654     } else {
 655         COVERAGE_INC(rconn_overflow);
 656         ofpbuf_delete(b);
 657         return EAGAIN;
 658     }
 659 }
 660
 661 /* Returns the total number of packets successfully sent on the underlying
 662  * vconn.  A packet is not counted as sent while it is still queued in the
 663  * rconn, only when it has been successfuly passed to the vconn.  */
 664 unsigned int
 665 rconn_packets_sent(const struct rconn *rc)
 666 {
 667     return rc->packets_sent;
 668 }
 669
 670 /* Adds 'vconn' to 'rc' as a monitoring connection, to which all messages sent
 671  * and received on 'rconn' will be copied.  'rc' takes ownership of 'vconn'. */
 672 void
 673 rconn_add_monitor(struct rconn *rc, struct vconn *vconn)
 674 {
 675     if (rc->n_monitors < ARRAY_SIZE(rc->monitors)) {
 676         int version = vconn_get_version(rc->vconn);
 677
 678         /* Override the allowed versions of the snoop vconn so that
 679          * only the version of the controller connection is allowed.
 680          * This is because the snoop will see the same messages as the
 681          * controller */
 682         vconn_set_allowed_versions(vconn, 1u << version);
 683
 684         VLOG_INFO("new monitor connection from %s", vconn_get_name(vconn));
 685         rc->monitors[rc->n_monitors++] = vconn;
 686     } else {
 687         VLOG_DBG("too many monitor connections, discarding %s",
 688                  vconn_get_name(vconn));
 689         vconn_close(vconn);
 690     }
 691 }
 692
 693 /* Returns 'rc''s name.  This is a name for human consumption, appropriate for
 694  * use in log messages.  It is not necessarily a name that may be passed
 695  * directly to, e.g., vconn_open(). */
 696 const char *
 697 rconn_get_name(const struct rconn *rc)
 698 {
 699     return rc->name;
 700 }
 701
 702 /* Sets 'rc''s name to 'new_name'. */
 703 void
 704 rconn_set_name(struct rconn *rc, const char *new_name)
 705 {
 706     free(rc->name);
 707     rc->name = xstrdup(new_name);
 708 }
 709
 710 /* Returns 'rc''s target.  This is intended to be a string that may be passed
 711  * directly to, e.g., vconn_open(). */
 712 const char *
 713 rconn_get_target(const struct rconn *rc)
 714 {
 715     return rc->target;
 716 }
 717
 718 /* Returns true if 'rconn' is connected or in the process of reconnecting,
 719  * false if 'rconn' is disconnected and will not reconnect on its own. */
 720 bool
 721 rconn_is_alive(const struct rconn *rconn)
 722 {
 723     return rconn->state != S_VOID;
 724 }
 725
 726 /* Returns true if 'rconn' is connected, false otherwise. */
 727 bool
 728 rconn_is_connected(const struct rconn *rconn)
 729 {
 730     return is_connected_state(rconn->state);
 731 }
 732
 733 /* Returns true if 'rconn' is connected and thought to have been accepted by
 734  * the peer's admission-control policy. */
 735 bool
 736 rconn_is_admitted(const struct rconn *rconn)
 737 {
 738     return (rconn_is_connected(rconn)
 739             && rconn->last_admitted >= rconn->last_connected);
 740 }
 741
 742 /* Returns 0 if 'rconn' is currently connected and considered to have been
 743  * accepted by the peer's admission-control policy, otherwise the number of
 744  * seconds since 'rconn' was last in such a state. */
 745 int
 746 rconn_failure_duration(const struct rconn *rconn)
 747 {
 748     return rconn_is_admitted(rconn) ? 0 : time_now() - rconn->last_admitted;
 749 }
 750
 751 /* Returns the IP address of the peer, or 0 if the peer's IP address is not
 752  * known. */
 753 ovs_be32
 754 rconn_get_remote_ip(const struct rconn *rconn)
 755 {
 756     return rconn->remote_ip;
 757 }
 758
 759 /* Returns the transport port of the peer, or 0 if the peer's port is not
 760  * known. */
 761 ovs_be16
 762 rconn_get_remote_port(const struct rconn *rconn)
 763 {
 764     return rconn->remote_port;
 765 }
 766
 767 /* Returns the IP address used to connect to the peer, or 0 if the
 768  * connection is not an IP-based protocol or if its IP address is not
 769  * known. */
 770 ovs_be32
 771 rconn_get_local_ip(const struct rconn *rconn)
 772 {
 773     return rconn->local_ip;
 774 }
 775
 776 /* Returns the transport port used to connect to the peer, or 0 if the
 777  * connection does not contain a port or if the port is not known. */
 778 ovs_be16
 779 rconn_get_local_port(const struct rconn *rconn)
 780 {
 781     return rconn->vconn ? vconn_get_local_port(rconn->vconn) : 0;
 782 }
 783
 784 /* Returns the OpenFlow version negotiated with the peer, or -1 if there is
 785  * currently no connection or if version negotiation is not yet complete. */
 786 int
 787 rconn_get_version(const struct rconn *rconn)
 788 {
 789     return rconn->vconn ? vconn_get_version(rconn->vconn) : -1;
 790 }
 791
 792 /* Returns the total number of packets successfully received by the underlying
 793  * vconn.  */
 794 unsigned int
 795 rconn_packets_received(const struct rconn *rc)
 796 {
 797     return rc->packets_received;
 798 }
 799
 800 /* Returns a string representing the internal state of 'rc'.  The caller must
 801  * not modify or free the string. */
 802 const char *
 803 rconn_get_state(const struct rconn *rc)
 804 {
 805     return state_name(rc->state);
 806 }
 807
 808 /* Returns the time at which the last successful connection was made by
 809  * 'rc'. Returns TIME_MIN if never connected. */
 810 time_t
 811 rconn_get_last_connection(const struct rconn *rc)
 812 {
 813     return rc->last_connected;
 814 }
 815
 816 /* Returns the time at which 'rc' was last disconnected. Returns TIME_MIN
 817  * if never disconnected. */
 818 time_t
 819 rconn_get_last_disconnect(const struct rconn *rc)
 820 {
 821     return rc->last_disconnected;
 822 }
 823
 824 /* Returns 'rc''s current connection sequence number, a number that changes
 825  * every time that 'rconn' connects or disconnects. */
 826 unsigned int
 827 rconn_get_connection_seqno(const struct rconn *rc)
 828 {
 829     return rc->seqno;
 830 }
 831
 832 /* Returns a value that explains why 'rc' last disconnected:
 833  *
 834  *   - 0 means that the last disconnection was caused by a call to
 835  *     rconn_disconnect(), or that 'rc' is new and has not yet completed its
 836  *     initial connection or connection attempt.
 837  *
 838  *   - EOF means that the connection was closed in the normal way by the peer.
 839  *
 840  *   - A positive integer is an errno value that represents the error.
 841  */
 842 int
 843 rconn_get_last_error(const struct rconn *rc)
 844 {
 845     return rc->last_error;
 846 }
 847
 848 /* Returns the number of messages queued for transmission on 'rc'. */
 849 unsigned int
 850 rconn_count_txqlen(const struct rconn *rc)
 851 {
 852     return list_size(&rc->txq);
 853 }
 854 \f
 855 struct rconn_packet_counter *
 856 rconn_packet_counter_create(void)
 857 {
 858     struct rconn_packet_counter *c = xzalloc(sizeof *c);
 859     c->ref_cnt = 1;
 860     return c;
 861 }
 862
 863 void
 864 rconn_packet_counter_destroy(struct rconn_packet_counter *c)
 865 {
 866     if (c) {
 867         assert(c->ref_cnt > 0);
 868         if (!--c->ref_cnt && !c->n_packets) {
 869             free(c);
 870         }
 871     }
 872 }
 873
 874 void
 875 rconn_packet_counter_inc(struct rconn_packet_counter *c, unsigned int n_bytes)
 876 {
 877     c->n_packets++;
 878     c->n_bytes += n_bytes;
 879 }
 880
 881 void
 882 rconn_packet_counter_dec(struct rconn_packet_counter *c, unsigned int n_bytes)
 883 {
 884     assert(c->n_packets > 0);
 885     assert(c->n_bytes >= n_bytes);
 886
 887     c->n_bytes -= n_bytes;
 888     c->n_packets--;
 889     if (!c->n_packets) {
 890         assert(!c->n_bytes);
 891         if (!c->ref_cnt) {
 892             free(c);
 893         }
 894     }
 895 }
 896 \f
 897 /* Set rc->target and rc->name to 'target' and 'name', respectively.  If 'name'
 898  * is null, 'target' is used.
 899  *
 900  * Also, clear out the cached IP address and port information, since changing
 901  * the target also likely changes these values. */
 902 static void
 903 rconn_set_target__(struct rconn *rc, const char *target, const char *name)
 904 {
 905     free(rc->name);
 906     rc->name = xstrdup(name ? name : target);
 907     free(rc->target);
 908     rc->target = xstrdup(target);
 909     rc->local_ip = 0;
 910     rc->remote_ip = 0;
 911     rc->remote_port = 0;
 912 }
 913
 914 /* Tries to send a packet from 'rc''s send buffer.  Returns 0 if successful,
 915  * otherwise a positive errno value. */
 916 static int
 917 try_send(struct rconn *rc)
 918 {
 919     struct ofpbuf *msg = ofpbuf_from_list(rc->txq.next);
 920     unsigned int n_bytes = msg->size;
 921     struct rconn_packet_counter *counter = msg->private_p;
 922     int retval;
 923
 924     /* Eagerly remove 'msg' from the txq.  We can't remove it from the list
 925      * after sending, if sending is successful, because it is then owned by the
 926      * vconn, which might have freed it already. */
 927     list_remove(&msg->list_node);
 928
 929     retval = vconn_send(rc->vconn, msg);
 930     if (retval) {
 931         list_push_front(&rc->txq, &msg->list_node);
 932         if (retval != EAGAIN) {
 933             report_error(rc, retval);
 934             disconnect(rc, retval);
 935         }
 936         return retval;
 937     }
 938     COVERAGE_INC(rconn_sent);
 939     rc->packets_sent++;
 940     if (counter) {
 941         rconn_packet_counter_dec(counter, n_bytes);
 942     }
 943     return 0;
 944 }
 945
 946 /* Reports that 'error' caused 'rc' to disconnect.  'error' may be a positive
 947  * errno value, or it may be EOF to indicate that the connection was closed
 948  * normally. */
 949 static void
 950 report_error(struct rconn *rc, int error)
 951 {
 952     if (error == EOF) {
 953         /* If 'rc' isn't reliable, then we don't really expect this connection
 954          * to last forever anyway (probably it's a connection that we received
 955          * via accept()), so use DBG level to avoid cluttering the logs. */
 956         enum vlog_level level = rc->reliable ? VLL_INFO : VLL_DBG;
 957         VLOG(level, "%s: connection closed by peer", rc->name);
 958     } else {
 959         VLOG_WARN("%s: connection dropped (%s)", rc->name, strerror(error));
 960     }
 961 }
 962
 963 /* Disconnects 'rc' and records 'error' as the error that caused 'rc''s last
 964  * disconnection:
 965  *
 966  *   - 0 means that this disconnection is due to a request by 'rc''s client,
 967  *     not due to any kind of network error.
 968  *
 969  *   - EOF means that the connection was closed in the normal way by the peer.
 970  *
 971  *   - A positive integer is an errno value that represents the error.
 972  */
 973 static void
 974 disconnect(struct rconn *rc, int error)
 975 {
 976     rc->last_error = error;
 977     if (rc->reliable) {
 978         time_t now = time_now();
 979
 980         if (rc->state & (S_CONNECTING | S_ACTIVE | S_IDLE)) {
 981             rc->last_disconnected = now;
 982             vconn_close(rc->vconn);
 983             rc->vconn = NULL;
 984             flush_queue(rc);
 985         }
 986
 987         if (now >= rc->backoff_deadline) {
 988             rc->backoff = 1;
 989         } else if (rc->backoff < rc->max_backoff / 2) {
 990             rc->backoff = MAX(1, 2 * rc->backoff);
 991             VLOG_INFO("%s: waiting %d seconds before reconnect",
 992                       rc->name, rc->backoff);
 993         } else {
 994             if (rconn_logging_connection_attempts__(rc)) {
 995                 VLOG_INFO("%s: continuing to retry connections in the "
 996                           "background but suppressing further logging",
 997                           rc->name);
 998             }
 999             rc->backoff = rc->max_backoff;
1000         }
1001         rc->backoff_deadline = now + rc->backoff;
1002         state_transition(rc, S_BACKOFF);
1003     } else {
1004         rc->last_disconnected = time_now();
1005         rconn_disconnect(rc);
1006     }
1007 }
1008
1009 /* Drops all the packets from 'rc''s send queue and decrements their queue
1010  * counts. */
1011 static void
1012 flush_queue(struct rconn *rc)
1013 {
1014     if (list_is_empty(&rc->txq)) {
1015         return;
1016     }
1017     while (!list_is_empty(&rc->txq)) {
1018         struct ofpbuf *b = ofpbuf_from_list(list_pop_front(&rc->txq));
1019         struct rconn_packet_counter *counter = b->private_p;
1020         if (counter) {
1021             rconn_packet_counter_dec(counter, b->size);
1022         }
1023         COVERAGE_INC(rconn_discarded);
1024         ofpbuf_delete(b);
1025     }
1026     poll_immediate_wake();
1027 }
1028
1029 static unsigned int
1030 elapsed_in_this_state(const struct rconn *rc)
1031 {
1032     return time_now() - rc->state_entered;
1033 }
1034
1035 static unsigned int
1036 timeout(const struct rconn *rc)
1037 {
1038     switch (rc->state) {
1039 #define STATE(NAME, VALUE) case S_##NAME: return timeout_##NAME(rc);
1040         STATES
1041 #undef STATE
1042     default:
1043         NOT_REACHED();
1044     }
1045 }
1046
1047 static bool
1048 timed_out(const struct rconn *rc)
1049 {
1050     return time_now() >= sat_add(rc->state_entered, timeout(rc));
1051 }
1052
1053 static void
1054 state_transition(struct rconn *rc, enum state state)
1055 {
1056     rc->seqno += (rc->state == S_ACTIVE) != (state == S_ACTIVE);
1057     if (is_connected_state(state) && !is_connected_state(rc->state)) {
1058         rc->probably_admitted = false;
1059     }
1060     if (rconn_is_connected(rc)) {
1061         rc->total_time_connected += elapsed_in_this_state(rc);
1062     }
1063     VLOG_DBG("%s: entering %s", rc->name, state_name(state));
1064     rc->state = state;
1065     rc->state_entered = time_now();
1066 }
1067
1068 static void
1069 copy_to_monitor(struct rconn *rc, const struct ofpbuf *b)
1070 {
1071     struct ofpbuf *clone = NULL;
1072     int retval;
1073     size_t i;
1074
1075     for (i = 0; i < rc->n_monitors; ) {
1076         struct vconn *vconn = rc->monitors[i];
1077
1078         if (!clone) {
1079             clone = ofpbuf_clone(b);
1080         }
1081         retval = vconn_send(vconn, clone);
1082         if (!retval) {
1083             clone = NULL;
1084         } else if (retval != EAGAIN) {
1085             VLOG_DBG("%s: closing monitor connection to %s: %s",
1086                      rconn_get_name(rc), vconn_get_name(vconn),
1087                      strerror(retval));
1088             rc->monitors[i] = rc->monitors[--rc->n_monitors];
1089             continue;
1090         }
1091         i++;
1092     }
1093     ofpbuf_delete(clone);
1094 }
1095
1096 static bool
1097 is_connected_state(enum state state)
1098 {
1099     return (state & (S_ACTIVE | S_IDLE)) != 0;
1100 }
1101
1102 static bool
1103 is_admitted_msg(const struct ofpbuf *b)
1104 {
1105     enum ofptype type;
1106     enum ofperr error;
1107
1108     error = ofptype_decode(&type, b->data);
1109     if (error) {
1110         return false;
1111     }
1112
1113     switch (type) {
1114     case OFPTYPE_HELLO:
1115     case OFPTYPE_ERROR:
1116     case OFPTYPE_ECHO_REQUEST:
1117     case OFPTYPE_ECHO_REPLY:
1118     case OFPTYPE_FEATURES_REQUEST:
1119     case OFPTYPE_FEATURES_REPLY:
1120     case OFPTYPE_GET_CONFIG_REQUEST:
1121     case OFPTYPE_GET_CONFIG_REPLY:
1122     case OFPTYPE_SET_CONFIG:
1123         /* FIXME: Change the following once they are implemented: */
1124     case OFPTYPE_QUEUE_GET_CONFIG_REQUEST:
1125     case OFPTYPE_QUEUE_GET_CONFIG_REPLY:
1126     case OFPTYPE_GET_ASYNC_REQUEST:
1127     case OFPTYPE_GET_ASYNC_REPLY:
1128     case OFPTYPE_METER_MOD:
1129     case OFPTYPE_GROUP_REQUEST:
1130     case OFPTYPE_GROUP_REPLY:
1131     case OFPTYPE_GROUP_DESC_REQUEST:
1132     case OFPTYPE_GROUP_DESC_REPLY:
1133     case OFPTYPE_GROUP_FEATURES_REQUEST:
1134     case OFPTYPE_GROUP_FEATURES_REPLY:
1135     case OFPTYPE_METER_REQUEST:
1136     case OFPTYPE_METER_REPLY:
1137     case OFPTYPE_METER_CONFIG_REQUEST:
1138     case OFPTYPE_METER_CONFIG_REPLY:
1139     case OFPTYPE_METER_FEATURES_REQUEST:
1140     case OFPTYPE_METER_FEATURES_REPLY:
1141     case OFPTYPE_TABLE_FEATURES_REQUEST:
1142     case OFPTYPE_TABLE_FEATURES_REPLY:
1143         return false;
1144
1145     case OFPTYPE_PACKET_IN:
1146     case OFPTYPE_FLOW_REMOVED:
1147     case OFPTYPE_PORT_STATUS:
1148     case OFPTYPE_PACKET_OUT:
1149     case OFPTYPE_FLOW_MOD:
1150     case OFPTYPE_PORT_MOD:
1151     case OFPTYPE_BARRIER_REQUEST:
1152     case OFPTYPE_BARRIER_REPLY:
1153     case OFPTYPE_DESC_STATS_REQUEST:
1154     case OFPTYPE_DESC_STATS_REPLY:
1155     case OFPTYPE_FLOW_STATS_REQUEST:
1156     case OFPTYPE_FLOW_STATS_REPLY:
1157     case OFPTYPE_AGGREGATE_STATS_REQUEST:
1158     case OFPTYPE_AGGREGATE_STATS_REPLY:
1159     case OFPTYPE_TABLE_STATS_REQUEST:
1160     case OFPTYPE_TABLE_STATS_REPLY:
1161     case OFPTYPE_PORT_STATS_REQUEST:
1162     case OFPTYPE_PORT_STATS_REPLY:
1163     case OFPTYPE_QUEUE_STATS_REQUEST:
1164     case OFPTYPE_QUEUE_STATS_REPLY:
1165     case OFPTYPE_PORT_DESC_STATS_REQUEST:
1166     case OFPTYPE_PORT_DESC_STATS_REPLY:
1167     case OFPTYPE_ROLE_REQUEST:
1168     case OFPTYPE_ROLE_REPLY:
1169     case OFPTYPE_SET_FLOW_FORMAT:
1170     case OFPTYPE_FLOW_MOD_TABLE_ID:
1171     case OFPTYPE_SET_PACKET_IN_FORMAT:
1172     case OFPTYPE_FLOW_AGE:
1173     case OFPTYPE_SET_ASYNC_CONFIG:
1174     case OFPTYPE_SET_CONTROLLER_ID:
1175     case OFPTYPE_FLOW_MONITOR_STATS_REQUEST:
1176     case OFPTYPE_FLOW_MONITOR_STATS_REPLY:
1177     case OFPTYPE_FLOW_MONITOR_CANCEL:
1178     case OFPTYPE_FLOW_MONITOR_PAUSED:
1179     case OFPTYPE_FLOW_MONITOR_RESUMED:
1180     default:
1181         return true;
1182     }
1183 }
1184
1185 /* Returns true if 'rc' is currently logging information about connection
1186  * attempts, false if logging should be suppressed because 'rc' hasn't
1187  * successuflly connected in too long. */
1188 static bool
1189 rconn_logging_connection_attempts__(const struct rconn *rc)
1190 {
1191     return rc->backoff < rc->max_backoff;
1192 }