lib/rconn.c

   1 /*
   2  * Copyright (c) 2008, 2009, 2010 Nicira Networks.
   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 "ofpbuf.h"
  26 #include "openflow/openflow.h"
  27 #include "poll-loop.h"
  28 #include "sat-math.h"
  29 #include "timeval.h"
  30 #include "util.h"
  31 #include "vconn.h"
  32
  33 #define THIS_MODULE VLM_rconn
  34 #include "vlog.h"
  35
  36 #define STATES                                  \
  37     STATE(VOID, 1 << 0)                         \
  38     STATE(BACKOFF, 1 << 1)                      \
  39     STATE(CONNECTING, 1 << 2)                   \
  40     STATE(ACTIVE, 1 << 3)                       \
  41     STATE(IDLE, 1 << 4)
  42 enum state {
  43 #define STATE(NAME, VALUE) S_##NAME = VALUE,
  44     STATES
  45 #undef STATE
  46 };
  47
  48 static const char *
  49 state_name(enum state state)
  50 {
  51     switch (state) {
  52 #define STATE(NAME, VALUE) case S_##NAME: return #NAME;
  53         STATES
  54 #undef STATE
  55     }
  56     return "***ERROR***";
  57 }
  58
  59 /* A reliable connection to an OpenFlow switch or controller.
  60  *
  61  * See the large comment in rconn.h for more information. */
  62 struct rconn {
  63     enum state state;
  64     time_t state_entered;
  65
  66     struct vconn *vconn;
  67     char *name;
  68     bool reliable;
  69
  70     struct ovs_queue txq;
  71
  72     int backoff;
  73     int max_backoff;
  74     time_t backoff_deadline;
  75     time_t last_received;
  76     time_t last_connected;
  77     unsigned int packets_sent;
  78     unsigned int seqno;
  79
  80     /* In S_ACTIVE and S_IDLE, probably_admitted reports whether we believe
  81      * that the peer has made a (positive) admission control decision on our
  82      * connection.  If we have not yet been (probably) admitted, then the
  83      * connection does not reset the timer used for deciding whether the switch
  84      * should go into fail-open mode.
  85      *
  86      * last_admitted reports the last time we believe such a positive admission
  87      * control decision was made. */
  88     bool probably_admitted;
  89     time_t last_admitted;
  90
  91     /* These values are simply for statistics reporting, not used directly by
  92      * anything internal to the rconn (or ofproto for that matter). */
  93     unsigned int packets_received;
  94     unsigned int n_attempted_connections, n_successful_connections;
  95     time_t creation_time;
  96     unsigned long int total_time_connected;
  97
  98     /* If we can't connect to the peer, it could be for any number of reasons.
  99      * Usually, one would assume it is because the peer is not running or
 100      * because the network is partitioned.  But it could also be because the
 101      * network topology has changed, in which case the upper layer will need to
 102      * reassess it (in particular, obtain a new IP address via DHCP and find
 103      * the new location of the controller).  We set this flag when we suspect
 104      * that this could be the case. */
 105     bool questionable_connectivity;
 106     time_t last_questioned;
 107
 108     /* Throughout this file, "probe" is shorthand for "inactivity probe".
 109      * When nothing has been received from the peer for a while, we send out
 110      * an echo request as an inactivity probe packet.  We should receive back
 111      * a response. */
 112     int probe_interval;         /* Secs of inactivity before sending probe. */
 113
 114     /* When we create a vconn we obtain these values, to save them past the end
 115      * of the vconn's lifetime.  Otherwise, in-band control will only allow
 116      * traffic when a vconn is actually open, but it is nice to allow ARP to
 117      * complete even between connection attempts, and it is also polite to
 118      * allow traffic from other switches to go through to the controller
 119      * whether or not we are connected.
 120      *
 121      * We don't cache the local port, because that changes from one connection
 122      * attempt to the next. */
 123     uint32_t local_ip, remote_ip;
 124     uint16_t remote_port;
 125
 126     /* Messages sent or received are copied to the monitor connections. */
 127 #define MAX_MONITORS 8
 128     struct vconn *monitors[8];
 129     size_t n_monitors;
 130 };
 131
 132 static unsigned int elapsed_in_this_state(const struct rconn *);
 133 static unsigned int timeout(const struct rconn *);
 134 static bool timed_out(const struct rconn *);
 135 static void state_transition(struct rconn *, enum state);
 136 static void set_vconn_name(struct rconn *, const char *name);
 137 static int try_send(struct rconn *);
 138 static int reconnect(struct rconn *);
 139 static void disconnect(struct rconn *, int error);
 140 static void flush_queue(struct rconn *);
 141 static void question_connectivity(struct rconn *);
 142 static void copy_to_monitor(struct rconn *, const struct ofpbuf *);
 143 static bool is_connected_state(enum state);
 144 static bool is_admitted_msg(const struct ofpbuf *);
 145
 146 /* Creates a new rconn, connects it (reliably) to 'name', and returns it. */
 147 struct rconn *
 148 rconn_new(const char *name, int inactivity_probe_interval, int max_backoff)
 149 {
 150     struct rconn *rc = rconn_create(inactivity_probe_interval, max_backoff);
 151     rconn_connect(rc, name);
 152     return rc;
 153 }
 154
 155 /* Creates a new rconn, connects it (unreliably) to 'vconn', and returns it. */
 156 struct rconn *
 157 rconn_new_from_vconn(const char *name, struct vconn *vconn)
 158 {
 159     struct rconn *rc = rconn_create(60, 0);
 160     rconn_connect_unreliably(rc, name, vconn);
 161     return rc;
 162 }
 163
 164 /* Creates and returns a new rconn.
 165  *
 166  * 'probe_interval' is a number of seconds.  If the interval passes once
 167  * without an OpenFlow message being received from the peer, the rconn sends
 168  * out an "echo request" message.  If the interval passes again without a
 169  * message being received, the rconn disconnects and re-connects to the peer.
 170  * Setting 'probe_interval' to 0 disables this behavior.
 171  *
 172  * 'max_backoff' is the maximum number of seconds between attempts to connect
 173  * to the peer.  The actual interval starts at 1 second and doubles on each
 174  * failure until it reaches 'max_backoff'.  If 0 is specified, the default of
 175  * 8 seconds is used. */
 176 struct rconn *
 177 rconn_create(int probe_interval, int max_backoff)
 178 {
 179     struct rconn *rc = xzalloc(sizeof *rc);
 180
 181     rc->state = S_VOID;
 182     rc->state_entered = time_now();
 183
 184     rc->vconn = NULL;
 185     rc->name = xstrdup("void");
 186     rc->reliable = false;
 187
 188     queue_init(&rc->txq);
 189
 190     rc->backoff = 0;
 191     rc->max_backoff = max_backoff ? max_backoff : 8;
 192     rc->backoff_deadline = TIME_MIN;
 193     rc->last_received = time_now();
 194     rc->last_connected = time_now();
 195     rc->seqno = 0;
 196
 197     rc->packets_sent = 0;
 198
 199     rc->probably_admitted = false;
 200     rc->last_admitted = time_now();
 201
 202     rc->packets_received = 0;
 203     rc->n_attempted_connections = 0;
 204     rc->n_successful_connections = 0;
 205     rc->creation_time = time_now();
 206     rc->total_time_connected = 0;
 207
 208     rc->questionable_connectivity = false;
 209     rc->last_questioned = time_now();
 210
 211     rconn_set_probe_interval(rc, probe_interval);
 212
 213     rc->n_monitors = 0;
 214
 215     return rc;
 216 }
 217
 218 void
 219 rconn_set_max_backoff(struct rconn *rc, int max_backoff)
 220 {
 221     rc->max_backoff = MAX(1, max_backoff);
 222     if (rc->state == S_BACKOFF && rc->backoff > max_backoff) {
 223         rc->backoff = max_backoff;
 224         if (rc->backoff_deadline > time_now() + max_backoff) {
 225             rc->backoff_deadline = time_now() + max_backoff;
 226         }
 227     }
 228 }
 229
 230 int
 231 rconn_get_max_backoff(const struct rconn *rc)
 232 {
 233     return rc->max_backoff;
 234 }
 235
 236 void
 237 rconn_set_probe_interval(struct rconn *rc, int probe_interval)
 238 {
 239     rc->probe_interval = probe_interval ? MAX(5, probe_interval) : 0;
 240 }
 241
 242 int
 243 rconn_get_probe_interval(const struct rconn *rc)
 244 {
 245     return rc->probe_interval;
 246 }
 247
 248 int
 249 rconn_connect(struct rconn *rc, const char *name)
 250 {
 251     rconn_disconnect(rc);
 252     set_vconn_name(rc, name);
 253     rc->reliable = true;
 254     return reconnect(rc);
 255 }
 256
 257 void
 258 rconn_connect_unreliably(struct rconn *rc,
 259                          const char *name, struct vconn *vconn)
 260 {
 261     assert(vconn != NULL);
 262     rconn_disconnect(rc);
 263     set_vconn_name(rc, name);
 264     rc->reliable = false;
 265     rc->vconn = vconn;
 266     rc->last_connected = time_now();
 267     state_transition(rc, S_ACTIVE);
 268 }
 269
 270 /* If 'rc' is connected, forces it to drop the connection and reconnect. */
 271 void
 272 rconn_reconnect(struct rconn *rc)
 273 {
 274     if (rc->state & (S_ACTIVE | S_IDLE)) {
 275         disconnect(rc, 0);
 276     }
 277 }
 278
 279 void
 280 rconn_disconnect(struct rconn *rc)
 281 {
 282     if (rc->state != S_VOID) {
 283         if (rc->vconn) {
 284             vconn_close(rc->vconn);
 285             rc->vconn = NULL;
 286         }
 287         set_vconn_name(rc, "void");
 288         rc->reliable = false;
 289
 290         rc->backoff = 0;
 291         rc->backoff_deadline = TIME_MIN;
 292
 293         state_transition(rc, S_VOID);
 294     }
 295 }
 296
 297 /* Disconnects 'rc' and frees the underlying storage. */
 298 void
 299 rconn_destroy(struct rconn *rc)
 300 {
 301     if (rc) {
 302         size_t i;
 303
 304         free(rc->name);
 305         vconn_close(rc->vconn);
 306         flush_queue(rc);
 307         queue_destroy(&rc->txq);
 308         for (i = 0; i < rc->n_monitors; i++) {
 309             vconn_close(rc->monitors[i]);
 310         }
 311         free(rc);
 312     }
 313 }
 314
 315 static unsigned int
 316 timeout_VOID(const struct rconn *rc OVS_UNUSED)
 317 {
 318     return UINT_MAX;
 319 }
 320
 321 static void
 322 run_VOID(struct rconn *rc OVS_UNUSED)
 323 {
 324     /* Nothing to do. */
 325 }
 326
 327 static int
 328 reconnect(struct rconn *rc)
 329 {
 330     int retval;
 331
 332     VLOG_INFO("%s: connecting...", rc->name);
 333     rc->n_attempted_connections++;
 334     retval = vconn_open(rc->name, OFP_VERSION, &rc->vconn);
 335     if (!retval) {
 336         rc->remote_ip = vconn_get_remote_ip(rc->vconn);
 337         rc->local_ip = vconn_get_local_ip(rc->vconn);
 338         rc->remote_port = vconn_get_remote_port(rc->vconn);
 339         rc->backoff_deadline = time_now() + rc->backoff;
 340         state_transition(rc, S_CONNECTING);
 341     } else {
 342         VLOG_WARN("%s: connection failed (%s)", rc->name, strerror(retval));
 343         rc->backoff_deadline = TIME_MAX; /* Prevent resetting backoff. */
 344         disconnect(rc, 0);
 345     }
 346     return retval;
 347 }
 348
 349 static unsigned int
 350 timeout_BACKOFF(const struct rconn *rc)
 351 {
 352     return rc->backoff;
 353 }
 354
 355 static void
 356 run_BACKOFF(struct rconn *rc)
 357 {
 358     if (timed_out(rc)) {
 359         reconnect(rc);
 360     }
 361 }
 362
 363 static unsigned int
 364 timeout_CONNECTING(const struct rconn *rc)
 365 {
 366     return MAX(1, rc->backoff);
 367 }
 368
 369 static void
 370 run_CONNECTING(struct rconn *rc)
 371 {
 372     int retval = vconn_connect(rc->vconn);
 373     if (!retval) {
 374         VLOG_INFO("%s: connected", rc->name);
 375         rc->n_successful_connections++;
 376         state_transition(rc, S_ACTIVE);
 377         rc->last_connected = rc->state_entered;
 378     } else if (retval != EAGAIN) {
 379         VLOG_INFO("%s: connection failed (%s)", rc->name, strerror(retval));
 380         disconnect(rc, retval);
 381     } else if (timed_out(rc)) {
 382         VLOG_INFO("%s: connection timed out", rc->name);
 383         rc->backoff_deadline = TIME_MAX; /* Prevent resetting backoff. */
 384         disconnect(rc, 0);
 385     }
 386 }
 387
 388 static void
 389 do_tx_work(struct rconn *rc)
 390 {
 391     if (!rc->txq.n) {
 392         return;
 393     }
 394     while (rc->txq.n > 0) {
 395         int error = try_send(rc);
 396         if (error) {
 397             break;
 398         }
 399     }
 400     if (!rc->txq.n) {
 401         poll_immediate_wake();
 402     }
 403 }
 404
 405 static unsigned int
 406 timeout_ACTIVE(const struct rconn *rc)
 407 {
 408     if (rc->probe_interval) {
 409         unsigned int base = MAX(rc->last_received, rc->state_entered);
 410         unsigned int arg = base + rc->probe_interval - rc->state_entered;
 411         return arg;
 412     }
 413     return UINT_MAX;
 414 }
 415
 416 static void
 417 run_ACTIVE(struct rconn *rc)
 418 {
 419     if (timed_out(rc)) {
 420         unsigned int base = MAX(rc->last_received, rc->state_entered);
 421         VLOG_DBG("%s: idle %u seconds, sending inactivity probe",
 422                  rc->name, (unsigned int) (time_now() - base));
 423
 424         /* Ordering is important here: rconn_send() can transition to BACKOFF,
 425          * and we don't want to transition back to IDLE if so, because then we
 426          * can end up queuing a packet with vconn == NULL and then *boom*. */
 427         state_transition(rc, S_IDLE);
 428         rconn_send(rc, make_echo_request(), NULL);
 429         return;
 430     }
 431
 432     do_tx_work(rc);
 433 }
 434
 435 static unsigned int
 436 timeout_IDLE(const struct rconn *rc)
 437 {
 438     return rc->probe_interval;
 439 }
 440
 441 static void
 442 run_IDLE(struct rconn *rc)
 443 {
 444     if (timed_out(rc)) {
 445         question_connectivity(rc);
 446         VLOG_ERR("%s: no response to inactivity probe after %u "
 447                  "seconds, disconnecting",
 448                  rc->name, elapsed_in_this_state(rc));
 449         disconnect(rc, 0);
 450     } else {
 451         do_tx_work(rc);
 452     }
 453 }
 454
 455 /* Performs whatever activities are necessary to maintain 'rc': if 'rc' is
 456  * disconnected, attempts to (re)connect, backing off as necessary; if 'rc' is
 457  * connected, attempts to send packets in the send queue, if any. */
 458 void
 459 rconn_run(struct rconn *rc)
 460 {
 461     int old_state;
 462     size_t i;
 463
 464     if (rc->vconn) {
 465         vconn_run(rc->vconn);
 466     }
 467     for (i = 0; i < rc->n_monitors; i++) {
 468         vconn_run(rc->monitors[i]);
 469     }
 470
 471     do {
 472         old_state = rc->state;
 473         switch (rc->state) {
 474 #define STATE(NAME, VALUE) case S_##NAME: run_##NAME(rc); break;
 475             STATES
 476 #undef STATE
 477         default:
 478             NOT_REACHED();
 479         }
 480     } while (rc->state != old_state);
 481 }
 482
 483 /* Causes the next call to poll_block() to wake up when rconn_run() should be
 484  * called on 'rc'. */
 485 void
 486 rconn_run_wait(struct rconn *rc)
 487 {
 488     unsigned int timeo;
 489     size_t i;
 490
 491     if (rc->vconn) {
 492         vconn_run_wait(rc->vconn);
 493     }
 494     for (i = 0; i < rc->n_monitors; i++) {
 495         vconn_run_wait(rc->monitors[i]);
 496     }
 497
 498     timeo = timeout(rc);
 499     if (timeo != UINT_MAX) {
 500         unsigned int expires = sat_add(rc->state_entered, timeo);
 501         unsigned int remaining = sat_sub(expires, time_now());
 502         poll_timer_wait(sat_mul(remaining, 1000));
 503     }
 504
 505     if ((rc->state & (S_ACTIVE | S_IDLE)) && rc->txq.n) {
 506         vconn_wait(rc->vconn, WAIT_SEND);
 507     }
 508 }
 509
 510 /* Attempts to receive a packet from 'rc'.  If successful, returns the packet;
 511  * otherwise, returns a null pointer.  The caller is responsible for freeing
 512  * the packet (with ofpbuf_delete()). */
 513 struct ofpbuf *
 514 rconn_recv(struct rconn *rc)
 515 {
 516     if (rc->state & (S_ACTIVE | S_IDLE)) {
 517         struct ofpbuf *buffer;
 518         int error = vconn_recv(rc->vconn, &buffer);
 519         if (!error) {
 520             copy_to_monitor(rc, buffer);
 521             if (rc->probably_admitted || is_admitted_msg(buffer)
 522                 || time_now() - rc->last_connected >= 30) {
 523                 rc->probably_admitted = true;
 524                 rc->last_admitted = time_now();
 525             }
 526             rc->last_received = time_now();
 527             rc->packets_received++;
 528             if (rc->state == S_IDLE) {
 529                 state_transition(rc, S_ACTIVE);
 530             }
 531             return buffer;
 532         } else if (error != EAGAIN) {
 533             disconnect(rc, error);
 534         }
 535     }
 536     return NULL;
 537 }
 538
 539 /* Causes the next call to poll_block() to wake up when a packet may be ready
 540  * to be received by vconn_recv() on 'rc'.  */
 541 void
 542 rconn_recv_wait(struct rconn *rc)
 543 {
 544     if (rc->vconn) {
 545         vconn_wait(rc->vconn, WAIT_RECV);
 546     }
 547 }
 548
 549 /* Sends 'b' on 'rc'.  Returns 0 if successful (in which case 'b' is
 550  * destroyed), or ENOTCONN if 'rc' is not currently connected (in which case
 551  * the caller retains ownership of 'b').
 552  *
 553  * If 'counter' is non-null, then 'counter' will be incremented while the
 554  * packet is in flight, then decremented when it has been sent (or discarded
 555  * due to disconnection).  Because 'b' may be sent (or discarded) before this
 556  * function returns, the caller may not be able to observe any change in
 557  * 'counter'.
 558  *
 559  * There is no rconn_send_wait() function: an rconn has a send queue that it
 560  * takes care of sending if you call rconn_run(), which will have the side
 561  * effect of waking up poll_block(). */
 562 int
 563 rconn_send(struct rconn *rc, struct ofpbuf *b,
 564            struct rconn_packet_counter *counter)
 565 {
 566     if (rconn_is_connected(rc)) {
 567         COVERAGE_INC(rconn_queued);
 568         copy_to_monitor(rc, b);
 569         b->private_p = counter;
 570         if (counter) {
 571             rconn_packet_counter_inc(counter);
 572         }
 573         queue_push_tail(&rc->txq, b);
 574
 575         /* If the queue was empty before we added 'b', try to send some
 576          * packets.  (But if the queue had packets in it, it's because the
 577          * vconn is backlogged and there's no point in stuffing more into it
 578          * now.  We'll get back to that in rconn_run().) */
 579         if (rc->txq.n == 1) {
 580             try_send(rc);
 581         }
 582         return 0;
 583     } else {
 584         return ENOTCONN;
 585     }
 586 }
 587
 588 /* Sends 'b' on 'rc'.  Increments 'counter' while the packet is in flight; it
 589  * will be decremented when it has been sent (or discarded due to
 590  * disconnection).  Returns 0 if successful, EAGAIN if 'counter->n' is already
 591  * at least as large as 'queue_limit', or ENOTCONN if 'rc' is not currently
 592  * connected.  Regardless of return value, 'b' is destroyed.
 593  *
 594  * Because 'b' may be sent (or discarded) before this function returns, the
 595  * caller may not be able to observe any change in 'counter'.
 596  *
 597  * There is no rconn_send_wait() function: an rconn has a send queue that it
 598  * takes care of sending if you call rconn_run(), which will have the side
 599  * effect of waking up poll_block(). */
 600 int
 601 rconn_send_with_limit(struct rconn *rc, struct ofpbuf *b,
 602                       struct rconn_packet_counter *counter, int queue_limit)
 603 {
 604     int retval;
 605     retval = counter->n >= queue_limit ? EAGAIN : rconn_send(rc, b, counter);
 606     if (retval) {
 607         COVERAGE_INC(rconn_overflow);
 608         ofpbuf_delete(b);
 609     }
 610     return retval;
 611 }
 612
 613 /* Returns the total number of packets successfully sent on the underlying
 614  * vconn.  A packet is not counted as sent while it is still queued in the
 615  * rconn, only when it has been successfuly passed to the vconn.  */
 616 unsigned int
 617 rconn_packets_sent(const struct rconn *rc)
 618 {
 619     return rc->packets_sent;
 620 }
 621
 622 /* Adds 'vconn' to 'rc' as a monitoring connection, to which all messages sent
 623  * and received on 'rconn' will be copied.  'rc' takes ownership of 'vconn'. */
 624 void
 625 rconn_add_monitor(struct rconn *rc, struct vconn *vconn)
 626 {
 627     if (rc->n_monitors < ARRAY_SIZE(rc->monitors)) {
 628         VLOG_INFO("new monitor connection from %s", vconn_get_name(vconn));
 629         rc->monitors[rc->n_monitors++] = vconn;
 630     } else {
 631         VLOG_DBG("too many monitor connections, discarding %s",
 632                  vconn_get_name(vconn));
 633         vconn_close(vconn);
 634     }
 635 }
 636
 637 /* Returns 'rc''s name (the 'name' argument passed to rconn_new()). */
 638 const char *
 639 rconn_get_name(const struct rconn *rc)
 640 {
 641     return rc->name;
 642 }
 643
 644 /* Returns true if 'rconn' is connected or in the process of reconnecting,
 645  * false if 'rconn' is disconnected and will not reconnect on its own. */
 646 bool
 647 rconn_is_alive(const struct rconn *rconn)
 648 {
 649     return rconn->state != S_VOID;
 650 }
 651
 652 /* Returns true if 'rconn' is connected, false otherwise. */
 653 bool
 654 rconn_is_connected(const struct rconn *rconn)
 655 {
 656     return is_connected_state(rconn->state);
 657 }
 658
 659 /* Returns true if 'rconn' is connected and thought to have been accepted by
 660  * the peer's admission-control policy. */
 661 bool
 662 rconn_is_admitted(const struct rconn *rconn)
 663 {
 664     return (rconn_is_connected(rconn)
 665             && rconn->last_admitted >= rconn->last_connected);
 666 }
 667
 668 /* Returns 0 if 'rconn' is currently connected and considered to have been
 669  * accepted by the peer's admission-control policy, otherwise the number of
 670  * seconds since 'rconn' was last in such a state. */
 671 int
 672 rconn_failure_duration(const struct rconn *rconn)
 673 {
 674     return rconn_is_admitted(rconn) ? 0 : time_now() - rconn->last_admitted;
 675 }
 676
 677 /* Returns the IP address of the peer, or 0 if the peer's IP address is not
 678  * known. */
 679 uint32_t
 680 rconn_get_remote_ip(const struct rconn *rconn)
 681 {
 682     return rconn->remote_ip;
 683 }
 684
 685 /* Returns the transport port of the peer, or 0 if the peer's port is not
 686  * known. */
 687 uint16_t
 688 rconn_get_remote_port(const struct rconn *rconn)
 689 {
 690     return rconn->remote_port;
 691 }
 692
 693 /* Returns the IP address used to connect to the peer, or 0 if the
 694  * connection is not an IP-based protocol or if its IP address is not
 695  * known. */
 696 uint32_t
 697 rconn_get_local_ip(const struct rconn *rconn)
 698 {
 699     return rconn->local_ip;
 700 }
 701
 702 /* Returns the transport port used to connect to the peer, or 0 if the
 703  * connection does not contain a port or if the port is not known. */
 704 uint16_t
 705 rconn_get_local_port(const struct rconn *rconn)
 706 {
 707     return rconn->vconn ? vconn_get_local_port(rconn->vconn) : 0;
 708 }
 709
 710 /* If 'rconn' can't connect to the peer, it could be for any number of reasons.
 711  * Usually, one would assume it is because the peer is not running or because
 712  * the network is partitioned.  But it could also be because the network
 713  * topology has changed, in which case the upper layer will need to reassess it
 714  * (in particular, obtain a new IP address via DHCP and find the new location
 715  * of the controller).  When this appears that this might be the case, this
 716  * function returns true.  It also clears the questionability flag and prevents
 717  * it from being set again for some time. */
 718 bool
 719 rconn_is_connectivity_questionable(struct rconn *rconn)
 720 {
 721     bool questionable = rconn->questionable_connectivity;
 722     rconn->questionable_connectivity = false;
 723     return questionable;
 724 }
 725
 726 /* Returns the total number of packets successfully received by the underlying
 727  * vconn.  */
 728 unsigned int
 729 rconn_packets_received(const struct rconn *rc)
 730 {
 731     return rc->packets_received;
 732 }
 733
 734 /* Returns a string representing the internal state of 'rc'.  The caller must
 735  * not modify or free the string. */
 736 const char *
 737 rconn_get_state(const struct rconn *rc)
 738 {
 739     return state_name(rc->state);
 740 }
 741
 742 /* Returns the number of connection attempts made by 'rc', including any
 743  * ongoing attempt that has not yet succeeded or failed. */
 744 unsigned int
 745 rconn_get_attempted_connections(const struct rconn *rc)
 746 {
 747     return rc->n_attempted_connections;
 748 }
 749
 750 /* Returns the number of successful connection attempts made by 'rc'. */
 751 unsigned int
 752 rconn_get_successful_connections(const struct rconn *rc)
 753 {
 754     return rc->n_successful_connections;
 755 }
 756
 757 /* Returns the time at which the last successful connection was made by
 758  * 'rc'. */
 759 time_t
 760 rconn_get_last_connection(const struct rconn *rc)
 761 {
 762     return rc->last_connected;
 763 }
 764
 765 /* Returns the time at which the last OpenFlow message was received by 'rc'.
 766  * If no packets have been received on 'rc', returns the time at which 'rc'
 767  * was created. */
 768 time_t
 769 rconn_get_last_received(const struct rconn *rc)
 770 {
 771     return rc->last_received;
 772 }
 773
 774 /* Returns the time at which 'rc' was created. */
 775 time_t
 776 rconn_get_creation_time(const struct rconn *rc)
 777 {
 778     return rc->creation_time;
 779 }
 780
 781 /* Returns the approximate number of seconds that 'rc' has been connected. */
 782 unsigned long int
 783 rconn_get_total_time_connected(const struct rconn *rc)
 784 {
 785     return (rc->total_time_connected
 786             + (rconn_is_connected(rc) ? elapsed_in_this_state(rc) : 0));
 787 }
 788
 789 /* Returns the current amount of backoff, in seconds.  This is the amount of
 790  * time after which the rconn will transition from BACKOFF to CONNECTING. */
 791 int
 792 rconn_get_backoff(const struct rconn *rc)
 793 {
 794     return rc->backoff;
 795 }
 796
 797 /* Returns the number of seconds spent in this state so far. */
 798 unsigned int
 799 rconn_get_state_elapsed(const struct rconn *rc)
 800 {
 801     return elapsed_in_this_state(rc);
 802 }
 803
 804 /* Returns 'rc''s current connection sequence number, a number that changes
 805  * every time that 'rconn' connects or disconnects. */
 806 unsigned int
 807 rconn_get_connection_seqno(const struct rconn *rc)
 808 {
 809     return rc->seqno;
 810 }
 811 \f
 812 struct rconn_packet_counter *
 813 rconn_packet_counter_create(void)
 814 {
 815     struct rconn_packet_counter *c = xmalloc(sizeof *c);
 816     c->n = 0;
 817     c->ref_cnt = 1;
 818     return c;
 819 }
 820
 821 void
 822 rconn_packet_counter_destroy(struct rconn_packet_counter *c)
 823 {
 824     if (c) {
 825         assert(c->ref_cnt > 0);
 826         if (!--c->ref_cnt && !c->n) {
 827             free(c);
 828         }
 829     }
 830 }
 831
 832 void
 833 rconn_packet_counter_inc(struct rconn_packet_counter *c)
 834 {
 835     c->n++;
 836 }
 837
 838 void
 839 rconn_packet_counter_dec(struct rconn_packet_counter *c)
 840 {
 841     assert(c->n > 0);
 842     if (!--c->n && !c->ref_cnt) {
 843         free(c);
 844     }
 845 }
 846 \f
 847 /* Set the name of the remote vconn to 'name' and clear out the cached IP
 848  * address and port information, since changing the name also likely changes
 849  * these values. */
 850 static void
 851 set_vconn_name(struct rconn *rc, const char *name)
 852 {
 853     free(rc->name);
 854     rc->name = xstrdup(name);
 855     rc->local_ip = 0;
 856     rc->remote_ip = 0;
 857     rc->remote_port = 0;
 858 }
 859
 860 /* Tries to send a packet from 'rc''s send buffer.  Returns 0 if successful,
 861  * otherwise a positive errno value. */
 862 static int
 863 try_send(struct rconn *rc)
 864 {
 865     int retval = 0;
 866     struct ofpbuf *next = rc->txq.head->next;
 867     struct rconn_packet_counter *counter = rc->txq.head->private_p;
 868     retval = vconn_send(rc->vconn, rc->txq.head);
 869     if (retval) {
 870         if (retval != EAGAIN) {
 871             disconnect(rc, retval);
 872         }
 873         return retval;
 874     }
 875     COVERAGE_INC(rconn_sent);
 876     rc->packets_sent++;
 877     if (counter) {
 878         rconn_packet_counter_dec(counter);
 879     }
 880     queue_advance_head(&rc->txq, next);
 881     return 0;
 882 }
 883
 884 /* Disconnects 'rc'.  'error' is used only for logging purposes.  If it is
 885  * nonzero, then it should be EOF to indicate the connection was closed by the
 886  * peer in a normal fashion or a positive errno value. */
 887 static void
 888 disconnect(struct rconn *rc, int error)
 889 {
 890     if (rc->reliable) {
 891         time_t now = time_now();
 892
 893         if (rc->state & (S_CONNECTING | S_ACTIVE | S_IDLE)) {
 894             if (error > 0) {
 895                 VLOG_WARN("%s: connection dropped (%s)",
 896                           rc->name, strerror(error));
 897             } else if (error == EOF) {
 898                 if (rc->reliable) {
 899                     VLOG_INFO("%s: connection closed by peer", rc->name);
 900                 }
 901             } else {
 902                 VLOG_INFO("%s: connection dropped", rc->name);
 903             }
 904             vconn_close(rc->vconn);
 905             rc->vconn = NULL;
 906             flush_queue(rc);
 907         }
 908
 909         if (now >= rc->backoff_deadline) {
 910             rc->backoff = 1;
 911         } else {
 912             rc->backoff = MIN(rc->max_backoff, MAX(1, 2 * rc->backoff));
 913             VLOG_INFO("%s: waiting %d seconds before reconnect\n",
 914                       rc->name, rc->backoff);
 915         }
 916         rc->backoff_deadline = now + rc->backoff;
 917         state_transition(rc, S_BACKOFF);
 918         if (now - rc->last_connected > 60) {
 919             question_connectivity(rc);
 920         }
 921     } else {
 922         rconn_disconnect(rc);
 923     }
 924 }
 925
 926 /* Drops all the packets from 'rc''s send queue and decrements their queue
 927  * counts. */
 928 static void
 929 flush_queue(struct rconn *rc)
 930 {
 931     if (!rc->txq.n) {
 932         return;
 933     }
 934     while (rc->txq.n > 0) {
 935         struct ofpbuf *b = queue_pop_head(&rc->txq);
 936         struct rconn_packet_counter *counter = b->private_p;
 937         if (counter) {
 938             rconn_packet_counter_dec(counter);
 939         }
 940         COVERAGE_INC(rconn_discarded);
 941         ofpbuf_delete(b);
 942     }
 943     poll_immediate_wake();
 944 }
 945
 946 static unsigned int
 947 elapsed_in_this_state(const struct rconn *rc)
 948 {
 949     return time_now() - rc->state_entered;
 950 }
 951
 952 static unsigned int
 953 timeout(const struct rconn *rc)
 954 {
 955     switch (rc->state) {
 956 #define STATE(NAME, VALUE) case S_##NAME: return timeout_##NAME(rc);
 957         STATES
 958 #undef STATE
 959     default:
 960         NOT_REACHED();
 961     }
 962 }
 963
 964 static bool
 965 timed_out(const struct rconn *rc)
 966 {
 967     return time_now() >= sat_add(rc->state_entered, timeout(rc));
 968 }
 969
 970 static void
 971 state_transition(struct rconn *rc, enum state state)
 972 {
 973     rc->seqno += (rc->state == S_ACTIVE) != (state == S_ACTIVE);
 974     if (is_connected_state(state) && !is_connected_state(rc->state)) {
 975         rc->probably_admitted = false;
 976     }
 977     if (rconn_is_connected(rc)) {
 978         rc->total_time_connected += elapsed_in_this_state(rc);
 979     }
 980     VLOG_DBG("%s: entering %s", rc->name, state_name(state));
 981     rc->state = state;
 982     rc->state_entered = time_now();
 983 }
 984
 985 static void
 986 question_connectivity(struct rconn *rc)
 987 {
 988     time_t now = time_now();
 989     if (now - rc->last_questioned > 60) {
 990         rc->questionable_connectivity = true;
 991         rc->last_questioned = now;
 992     }
 993 }
 994
 995 static void
 996 copy_to_monitor(struct rconn *rc, const struct ofpbuf *b)
 997 {
 998     struct ofpbuf *clone = NULL;
 999     int retval;
1000     size_t i;
1001
1002     for (i = 0; i < rc->n_monitors; ) {
1003         struct vconn *vconn = rc->monitors[i];
1004
1005         if (!clone) {
1006             clone = ofpbuf_clone(b);
1007         }
1008         retval = vconn_send(vconn, clone);
1009         if (!retval) {
1010             clone = NULL;
1011         } else if (retval != EAGAIN) {
1012             VLOG_DBG("%s: closing monitor connection to %s: %s",
1013                      rconn_get_name(rc), vconn_get_name(vconn),
1014                      strerror(retval));
1015             rc->monitors[i] = rc->monitors[--rc->n_monitors];
1016             continue;
1017         }
1018         i++;
1019     }
1020     ofpbuf_delete(clone);
1021 }
1022
1023 static bool
1024 is_connected_state(enum state state)
1025 {
1026     return (state & (S_ACTIVE | S_IDLE)) != 0;
1027 }
1028
1029 static bool
1030 is_admitted_msg(const struct ofpbuf *b)
1031 {
1032     struct ofp_header *oh = b->data;
1033     uint8_t type = oh->type;
1034     return !(type < 32
1035              && (1u << type) & ((1u << OFPT_HELLO) |
1036                                 (1u << OFPT_ERROR) |
1037                                 (1u << OFPT_ECHO_REQUEST) |
1038                                 (1u << OFPT_ECHO_REPLY) |
1039                                 (1u << OFPT_VENDOR) |
1040                                 (1u << OFPT_FEATURES_REQUEST) |
1041                                 (1u << OFPT_FEATURES_REPLY) |
1042                                 (1u << OFPT_GET_CONFIG_REQUEST) |
1043                                 (1u << OFPT_GET_CONFIG_REPLY) |
1044                                 (1u << OFPT_SET_CONFIG)));
1045 }