[tor-commits] [tor/master] Implement EVENT_NETWORK_LIVENESS

[nickm at torproject.org]

commit dce9e915c77ccf42e74a5cccca309e8085738d75
Author: Andrea Shepard <andrea at torproject.org>
Date:   Wed May 6 12:37:13 2015 +0000

    Implement EVENT_NETWORK_LIVENESS
---
 src/or/circuitstats.c |    6 ++++++
 src/or/control.c      |   47 +++++++++++++++++++++++++++++++++++++++++++++++
 src/or/control.h      |    4 +++-
 3 files changed, 56 insertions(+), 1 deletion(-)

diff --git a/src/or/circuitstats.c b/src/or/circuitstats.c
index 7b3ad56..3ced5af 100644
--- a/src/or/circuitstats.c
+++ b/src/or/circuitstats.c
@@ -1232,6 +1232,9 @@ circuit_build_times_network_is_live(circuit_build_times_t *cbt)
   }
   cbt->liveness.network_last_live = now;
   cbt->liveness.nonlive_timeouts = 0;
+
+  /* Tell control.c */
+  control_event_network_liveness_update(1);
 }
 
 /**
@@ -1316,6 +1319,9 @@ circuit_build_times_network_close(circuit_build_times_t *cbt,
                  "Tor has not observed any network activity for the past %d "
                  "seconds. Disabling circuit build timeout recording.",
                  (int)(now - cbt->liveness.network_last_live));
+
+      /* Tell control.c */
+      control_event_network_liveness_update(0);
     } else {
       log_info(LD_CIRC,
              "Got non-live timeout. Current count is: %d",
diff --git a/src/or/control.c b/src/or/control.c
index 950e989..a64822e 100644
--- a/src/or/control.c
+++ b/src/or/control.c
@@ -959,6 +959,7 @@ static const struct control_event_t control_event_table[] = {
   { EVENT_TRANSPORT_LAUNCHED, "TRANSPORT_LAUNCHED" },
   { EVENT_HS_DESC, "HS_DESC" },
   { EVENT_HS_DESC_CONTENT, "HS_DESC_CONTENT" },
+  { EVENT_NETWORK_LIVENESS, "NETWORK_LIVENESS" },
   { 0, NULL },
 };
 
@@ -4992,6 +4993,52 @@ control_event_or_authdir_new_descriptor(const char *action,
   return 0;
 }
 
+/** Cached liveness for network liveness events and GETINFO
+ */
+
+static int network_is_live = 0;
+
+static int
+get_cached_network_liveness(void)
+{
+  return network_is_live;
+}
+
+static void
+set_cached_network_liveness(int liveness)
+{
+  network_is_live = liveness;
+}
+
+/** The network liveness has changed; this is called from circuitstats.c
+ * whenever we receive a cell, or when timeout expires and we assume the
+ * network is down. */
+int
+control_event_network_liveness_update(int liveness)
+{
+  if (liveness > 0) {
+    if (get_cached_network_liveness() <= 0) {
+      /* Update cached liveness */
+      set_cached_network_liveness(1);
+      log_debug(LD_CONTROL, "Sending NETWORK_LIVENESS UP");
+      send_control_event_string(EVENT_NETWORK_LIVENESS, ALL_FORMATS,
+                                "650 NETWORK_LIVENESS UP\r\n");
+    }
+    /* else was already live, no-op */
+  } else {
+    if (get_cached_network_liveness() > 0) {
+      /* Update cached liveness */
+      set_cached_network_liveness(0);
+      log_debug(LD_CONTROL, "Sending NETWORK_LIVENESS DOWN");
+      send_control_event_string(EVENT_NETWORK_LIVENESS, ALL_FORMATS,
+                                "650 NETWORK_LIVENESS DOWN\r\n");
+    }
+    /* else was already dead, no-op */
+  }
+
+  return 0;
+}
+
 /** Helper function for NS-style events. Constructs and sends an event
  * of type <b>event</b> with string <b>event_string</b> out of the set of
  * networkstatuses <b>statuses</b>. Currently it is used for NS events
diff --git a/src/or/control.h b/src/or/control.h
index cb0468f..43a95b3 100644
--- a/src/or/control.h
+++ b/src/or/control.h
@@ -67,6 +67,7 @@ int control_event_or_authdir_new_descriptor(const char *action,
                                             size_t desclen,
                                             const char *msg);
 int control_event_my_descriptor_changed(void);
+int control_event_network_liveness_update(int liveness);
 int control_event_networkstatus_changed(smartlist_t *statuses);
 
 int control_event_newconsensus(const networkstatus_t *consensus);
@@ -166,7 +167,8 @@ void control_free_all(void);
 #define EVENT_TRANSPORT_LAUNCHED      0x0020
 #define EVENT_HS_DESC                 0x0021
 #define EVENT_HS_DESC_CONTENT         0x0022
-#define EVENT_MAX_                    0x0022
+#define EVENT_NETWORK_LIVENESS        0x0023
+#define EVENT_MAX_                    0x0023
 
 /* sizeof(control_connection_t.event_mask) in bits, currently a uint64_t */
 #define EVENT_CAPACITY_               0x0040