pintos-os.org Git - openvswitch/blob - lib/rconn.c

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