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