Setting tag sliver-openvswitch-2.2.90-1
[sliver-openvswitch.git] / lib / reconnect.c
index d7357c2..5296c5c 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2008, 2009, 2010 Nicira Networks.
+ * Copyright (c) 2008, 2009, 2010, 2012, 2013 Nicira, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -17,7 +17,6 @@
 #include <config.h>
 #include "reconnect.h"
 
-#include <assert.h>
 #include <stdlib.h>
 
 #include "poll-loop.h"
@@ -28,7 +27,7 @@ VLOG_DEFINE_THIS_MODULE(reconnect);
 #define STATES                                  \
     STATE(VOID, 1 << 0)                         \
     STATE(BACKOFF, 1 << 1)                      \
-    STATE(CONNECT_IN_PROGRESS, 1 << 3)          \
+    STATE(CONNECTING, 1 << 3)          \
     STATE(ACTIVE, 1 << 4)                       \
     STATE(IDLE, 1 << 5)                         \
     STATE(RECONNECT, 1 << 6)                    \
@@ -58,8 +57,9 @@ struct reconnect {
     enum state state;
     long long int state_entered;
     int backoff;
-    long long int last_received;
+    long long int last_activity;
     long long int last_connected;
+    long long int last_disconnected;
     unsigned int max_tries;
 
     /* These values are simply for statistics reporting, not otherwise used
@@ -104,8 +104,9 @@ reconnect_create(long long int now)
     fsm->state = S_VOID;
     fsm->state_entered = now;
     fsm->backoff = 0;
-    fsm->last_received = now;
-    fsm->last_connected = now;
+    fsm->last_activity = now;
+    fsm->last_connected = LLONG_MAX;
+    fsm->last_disconnected = LLONG_MAX;
     fsm->max_tries = UINT_MAX;
     fsm->creation_time = now;
 
@@ -174,9 +175,9 @@ reconnect_get_max_backoff(const struct reconnect *fsm)
 
 /* Returns the "probe interval" for 'fsm' in milliseconds.  If this is zero, it
  * disables the connection keepalive feature.  If it is nonzero, then if the
- * interval passes while 'fsm' is connected and without reconnect_received()
+ * interval passes while 'fsm' is connected and without reconnect_activity()
  * being called for 'fsm', reconnect_run() returns RECONNECT_PROBE.  If the
- * interval passes again without reconnect_received() being called,
+ * interval passes again without reconnect_activity() being called,
  * reconnect_run() returns RECONNECT_DISCONNECT for 'fsm'. */
 int
 reconnect_get_probe_interval(const struct reconnect *fsm)
@@ -206,7 +207,8 @@ reconnect_get_max_tries(struct reconnect *fsm)
 
 /* Configures the backoff parameters for 'fsm'.  'min_backoff' is the minimum
  * number of milliseconds, and 'max_backoff' is the maximum, between connection
- * attempts.
+ * attempts.  The current backoff is also the duration that 'fsm' is willing to
+ * wait for a given connection to succeed or fail.
  *
  * 'min_backoff' must be at least 1000, and 'max_backoff' must be greater than
  * or equal to 'min_backoff'.
@@ -231,8 +233,8 @@ reconnect_set_backoff(struct reconnect *fsm, int min_backoff, int max_backoff)
 /* Sets the "probe interval" for 'fsm' to 'probe_interval', in milliseconds.
  * If this is zero, it disables the connection keepalive feature.  If it is
  * nonzero, then if the interval passes while 'fsm' is connected and without
- * reconnect_received() being called for 'fsm', reconnect_run() returns
- * RECONNECT_PROBE.  If the interval passes again without reconnect_received()
+ * reconnect_activity() being called for 'fsm', reconnect_run() returns
+ * RECONNECT_PROBE.  If the interval passes again without reconnect_activity()
  * being called, reconnect_run() returns RECONNECT_DISCONNECT for 'fsm'.
  *
  * If 'probe_interval' is nonzero, then it will be forced to a value of at
@@ -261,7 +263,7 @@ reconnect_set_passive(struct reconnect *fsm, bool passive, long long int now)
         fsm->passive = passive;
 
         if (passive
-            ? fsm->state & (S_CONNECT_IN_PROGRESS | S_RECONNECT)
+            ? fsm->state & (S_CONNECTING | S_RECONNECT)
             : fsm->state == S_LISTENING && reconnect_may_retry(fsm)) {
             reconnect_transition__(fsm, now, S_BACKOFF);
             fsm->backoff = 0;
@@ -310,7 +312,7 @@ reconnect_disable(struct reconnect *fsm, long long int now)
 void
 reconnect_force_reconnect(struct reconnect *fsm, long long int now)
 {
-    if (fsm->state & (S_CONNECT_IN_PROGRESS | S_ACTIVE | S_IDLE)) {
+    if (fsm->state & (S_CONNECTING | S_ACTIVE | S_IDLE)) {
         reconnect_transition__(fsm, now, S_RECONNECT);
     }
 }
@@ -329,7 +331,7 @@ reconnect_disconnected(struct reconnect *fsm, long long int now, int error)
         if (fsm->state & (S_ACTIVE | S_IDLE)) {
             if (error > 0) {
                 VLOG_WARN("%s: connection dropped (%s)",
-                          fsm->name, strerror(error));
+                          fsm->name, ovs_strerror(error));
             } else if (error == EOF) {
                 VLOG(fsm->info, "%s: connection closed by peer", fsm->name);
             } else {
@@ -338,7 +340,7 @@ reconnect_disconnected(struct reconnect *fsm, long long int now, int error)
         } else if (fsm->state == S_LISTENING) {
             if (error > 0) {
                 VLOG_WARN("%s: error listening for connections (%s)",
-                          fsm->name, strerror(error));
+                          fsm->name, ovs_strerror(error));
             } else {
                 VLOG(fsm->info, "%s: error listening for connections",
                      fsm->name);
@@ -346,16 +348,19 @@ reconnect_disconnected(struct reconnect *fsm, long long int now, int error)
         } else {
             const char *type = fsm->passive ? "listen" : "connection";
             if (error > 0) {
-                VLOG_WARN("%s: %s attempt failed (%s)",
-                          fsm->name, type, strerror(error));
+                VLOG_INFO("%s: %s attempt failed (%s)",
+                          fsm->name, type, ovs_strerror(error));
             } else {
                 VLOG(fsm->info, "%s: %s attempt timed out", fsm->name, type);
             }
         }
 
+        if (fsm->state & (S_ACTIVE | S_IDLE)) {
+            fsm->last_disconnected = now;
+        }
         /* Back off. */
         if (fsm->state & (S_ACTIVE | S_IDLE)
-             && (fsm->last_received - fsm->last_connected >= fsm->backoff
+             && (fsm->last_activity - fsm->last_connected >= fsm->backoff
                  || fsm->passive)) {
             fsm->backoff = fsm->passive ? 0 : fsm->min_backoff;
         } else {
@@ -388,13 +393,13 @@ reconnect_disconnected(struct reconnect *fsm, long long int now, int error)
 void
 reconnect_connecting(struct reconnect *fsm, long long int now)
 {
-    if (fsm->state != S_CONNECT_IN_PROGRESS) {
+    if (fsm->state != S_CONNECTING) {
         if (fsm->passive) {
             VLOG(fsm->info, "%s: listening...", fsm->name);
         } else {
             VLOG(fsm->info, "%s: connecting...", fsm->name);
         }
-        reconnect_transition__(fsm, now, S_CONNECT_IN_PROGRESS);
+        reconnect_transition__(fsm, now, S_CONNECTING);
     }
 }
 
@@ -436,7 +441,7 @@ reconnect_listen_error(struct reconnect *fsm, long long int now, int error)
 /* Tell 'fsm' that the connection was successful.
  *
  * The FSM will start the probe interval timer, which is reset by
- * reconnect_received().  If the timer expires, a probe will be sent (by
+ * reconnect_activity().  If the timer expires, a probe will be sent (by
  * returning RECONNECT_PROBE from reconnect_run()).  If the timer expires
  * again without being reset, the connection will be aborted (by returning
  * RECONNECT_DISCONNECT from reconnect_run()). */
@@ -462,22 +467,22 @@ reconnect_connect_failed(struct reconnect *fsm, long long int now, int error)
     reconnect_disconnected(fsm, now, error);
 }
 
-/* Tell 'fsm' that some data was received.  This resets the probe interval
- * timer, so that the connection is known not to be idle. */
+/* Tell 'fsm' that some activity has occurred on the connection.  This resets
+ * the probe interval timer, so that the connection is known not to be idle. */
 void
-reconnect_received(struct reconnect *fsm, long long int now)
+reconnect_activity(struct reconnect *fsm, long long int now)
 {
     if (fsm->state != S_ACTIVE) {
         reconnect_transition__(fsm, now, S_ACTIVE);
     }
-    fsm->last_received = now;
+    fsm->last_activity = now;
 }
 
 static void
 reconnect_transition__(struct reconnect *fsm, long long int now,
                        enum state state)
 {
-    if (fsm->state == S_CONNECT_IN_PROGRESS) {
+    if (fsm->state == S_CONNECTING) {
         fsm->n_attempted_connections++;
         if (state == S_ACTIVE) {
             fsm->n_successful_connections++;
@@ -498,7 +503,7 @@ reconnect_transition__(struct reconnect *fsm, long long int now,
 static long long int
 reconnect_deadline__(const struct reconnect *fsm)
 {
-    assert(fsm->state_entered != LLONG_MIN);
+    ovs_assert(fsm->state_entered != LLONG_MIN);
     switch (fsm->state) {
     case S_VOID:
     case S_LISTENING:
@@ -507,24 +512,27 @@ reconnect_deadline__(const struct reconnect *fsm)
     case S_BACKOFF:
         return fsm->state_entered + fsm->backoff;
 
-    case S_CONNECT_IN_PROGRESS:
+    case S_CONNECTING:
         return fsm->state_entered + MAX(1000, fsm->backoff);
 
     case S_ACTIVE:
         if (fsm->probe_interval) {
-            long long int base = MAX(fsm->last_received, fsm->state_entered);
+            long long int base = MAX(fsm->last_activity, fsm->state_entered);
             return base + fsm->probe_interval;
         }
         return LLONG_MAX;
 
     case S_IDLE:
-        return fsm->state_entered + fsm->probe_interval;
+        if (fsm->probe_interval) {
+            return fsm->state_entered + fsm->probe_interval;
+        }
+        return LLONG_MAX;
 
     case S_RECONNECT:
         return fsm->state_entered;
     }
 
-    NOT_REACHED();
+    OVS_NOT_REACHED();
 }
 
 /* Assesses whether any action should be taken on 'fsm'.  The return value is
@@ -574,12 +582,12 @@ reconnect_run(struct reconnect *fsm, long long int now)
         case S_BACKOFF:
             return RECONNECT_CONNECT;
 
-        case S_CONNECT_IN_PROGRESS:
+        case S_CONNECTING:
             return RECONNECT_DISCONNECT;
 
         case S_ACTIVE:
             VLOG_DBG("%s: idle %lld ms, sending inactivity probe", fsm->name,
-                     now - MAX(fsm->last_received, fsm->state_entered));
+                     now - MAX(fsm->last_activity, fsm->state_entered));
             reconnect_transition__(fsm, now, S_IDLE);
             return RECONNECT_PROBE;
 
@@ -596,7 +604,7 @@ reconnect_run(struct reconnect *fsm, long long int now)
             return 0;
         }
 
-        NOT_REACHED();
+        OVS_NOT_REACHED();
     } else {
         return 0;
     }
@@ -637,13 +645,26 @@ reconnect_is_connected(const struct reconnect *fsm)
     return is_connected_state(fsm->state);
 }
 
-/* Returns the number of milliseconds for which 'fsm' has been continuously
- * connected to its peer.  (If 'fsm' is not currently connected, this is 0.) */
+/* Returns the number of milliseconds since 'fsm' last successfully connected
+ * to its peer (even if it has since disconnected). Returns UINT_MAX if never
+ * connected. */
+unsigned int
+reconnect_get_last_connect_elapsed(const struct reconnect *fsm,
+                                   long long int now)
+{
+    return fsm->last_connected == LLONG_MAX ? UINT_MAX
+        : now - fsm->last_connected;
+}
+
+/* Returns the number of milliseconds since 'fsm' last disconnected
+ * from its peer (even if it has since reconnected). Returns UINT_MAX if never
+ * disconnected. */
 unsigned int
-reconnect_get_connection_duration(const struct reconnect *fsm,
-                                  long long int now)
+reconnect_get_last_disconnect_elapsed(const struct reconnect *fsm,
+                                      long long int now)
 {
-    return reconnect_is_connected(fsm) ? now - fsm->last_connected : 0;
+    return fsm->last_disconnected == LLONG_MAX ? UINT_MAX
+        : now - fsm->last_disconnected;
 }
 
 /* Copies various statistics for 'fsm' into '*stats'. */
@@ -652,15 +673,19 @@ reconnect_get_stats(const struct reconnect *fsm, long long int now,
                     struct reconnect_stats *stats)
 {
     stats->creation_time = fsm->creation_time;
-    stats->last_received = fsm->last_received;
+    stats->last_activity = fsm->last_activity;
     stats->last_connected = fsm->last_connected;
+    stats->last_disconnected = fsm->last_disconnected;
     stats->backoff = fsm->backoff;
     stats->seqno = fsm->seqno;
     stats->is_connected = reconnect_is_connected(fsm);
-    stats->current_connection_duration
-        = reconnect_get_connection_duration(fsm, now);
-    stats->total_connected_duration = (stats->current_connection_duration
-                                       + fsm->total_connected_duration);
+    stats->msec_since_connect
+        = reconnect_get_last_connect_elapsed(fsm, now);
+    stats->msec_since_disconnect
+        = reconnect_get_last_disconnect_elapsed(fsm, now);
+    stats->total_connected_duration = fsm->total_connected_duration
+        + (is_connected_state(fsm->state)
+           ? reconnect_get_last_connect_elapsed(fsm, now) : 0);
     stats->n_attempted_connections = fsm->n_attempted_connections;
     stats->n_successful_connections = fsm->n_successful_connections;
     stats->state = reconnect_state_name__(fsm->state);