push back
[oweals/gnunet.git] / src / nse / gnunet-service-nse.c
index 2e7a7248d014facc8c08302e2d78b3c01432ef4a..3d980ca26ae04eed46f6671d496b9c8a54c1ea1c 100644 (file)
 #include "gnunet_nse_service.h"
 #include "nse.h"
 
-#define DEBUG_NSE GNUNET_YES
+/**
+ * Send messages on connect.
+ */
+#define SEND_ON_CONNECT GNUNET_YES
+
+/**
+ * Should we generate a histogram with the time stamps of when we received
+ * NSE messages to disk? (for performance evaluation only, not useful in
+ * production)
+ */
+#define ENABLE_HISTOGRAM GNUNET_YES
 
 /**
  * Over how many values do we calculate the weighted average?
 /**
  * Amount of work required (W-bit collisions) for NSE proofs, in collision-bits.
  */
-#define NSE_WORK_REQUIRED 8
+static unsigned long long nse_work_required;
 
 /**
  * Interval for sending network size estimation flood requests.
  */
-#define GNUNET_NSE_INTERVAL GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 60)
+static struct GNUNET_TIME_Relative gnunet_nse_interval;
 
 /**
  * Interval between proof find runs.
  */
-#define PROOF_FIND_DELAY GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MILLISECONDS, 5)
+static struct GNUNET_TIME_Relative proof_find_delay;
+
+
+#if ENABLE_HISTOGRAM
+static struct GNUNET_BIO_WriteHandle *wh;
+#endif
 
 
 /**
@@ -106,7 +121,8 @@ struct NSEPeerEntry
 
   /**
    * Did we receive or send a message about the previous round
-   * to this peer yet?  
+   * to this peer yet?   GNUNET_YES if the previous round has
+   * been taken care of.
    */
   int previous_round;
 };
@@ -292,10 +308,11 @@ setup_estimate_message (struct GNUNET_NSE_ClientMessage *em)
   mean = 0.0;
   sum = 0.0;
   sumweight = 0.0;
-  for (i=0;i<estimate_count; i++)
+  for (i = 0; i < estimate_count; i++)
     {
-      val = htonl (size_estimate_messages[(estimate_index - i + HISTORY_SIZE) % HISTORY_SIZE].matching_bits);
-      weight = estimate_count + 1 - i;
+      val = htonl (size_estimate_messages[(estimate_index - i + HISTORY_SIZE)
+          % HISTORY_SIZE].matching_bits);
+      weight = 1; /* was: estimate_count + 1 - i; */
 
       temp = weight + sumweight;
       q = val - mean;
@@ -315,11 +332,12 @@ setup_estimate_message (struct GNUNET_NSE_ClientMessage *em)
   em->header.type
     = htons (GNUNET_MESSAGE_TYPE_NSE_ESTIMATE);
   em->reserved = htonl (0);
-  em->size_estimate = mean - 0.5;
+  em->timestamp = GNUNET_TIME_absolute_hton(GNUNET_TIME_absolute_get());
+  em->size_estimate = mean - 1.0/3.0;
   em->std_deviation = std_dev;
   GNUNET_STATISTICS_set (stats, 
                         "# nodes in the network (estimate)",
-                        (uint64_t) pow (2, mean - 0.5), GNUNET_NO);
+                        (uint64_t) pow (2, mean - 1.0/3.0), GNUNET_NO);
 }
 
 
@@ -338,6 +356,7 @@ handle_start_message(void *cls, struct GNUNET_SERVER_Client *client,
                      const struct GNUNET_MessageHeader *message)
 {
   struct GNUNET_NSE_ClientMessage em;
+
 #if DEBUG_NSE
   GNUNET_log(GNUNET_ERROR_TYPE_DEBUG, 
             "Received START message from client\n");
@@ -360,11 +379,11 @@ get_matching_bits_delay (uint32_t matching_bits)
 {
   /* Calculated as: S + f/2 - (f / pi) * (atan(x - p'))*/  
   // S is next_timestamp (ignored in return value)
-  // f is frequency (GNUNET_NSE_INTERVAL)
+  // f is frequency (gnunet_nse_interval)
   // x is matching_bits
   // p' is current_size_estimate
-  return ((double) GNUNET_NSE_INTERVAL.rel_value / (double) 2.0)
-    - ((GNUNET_NSE_INTERVAL.rel_value / M_PI) * atan (current_size_estimate - matching_bits));
+  return ((double) gnunet_nse_interval.rel_value / (double) 2.0)
+    - ((gnunet_nse_interval.rel_value / M_PI) * atan (matching_bits - current_size_estimate));
 }
 
 
@@ -430,6 +449,11 @@ get_transmit_delay (int round_offset)
       /* previous round is randomized between 0 and 50 ms */
       ret.rel_value = GNUNET_CRYPTO_random_u64 (GNUNET_CRYPTO_QUALITY_WEAK,
                                                50);
+#if DEBUG_NSE
+      GNUNET_log(GNUNET_ERROR_TYPE_DEBUG, 
+                "Transmitting previous round behind schedule in %llu ms\n",
+                (unsigned long long) ret.rel_value);
+#endif
       return ret;
     case 0:
       /* current round is based on best-known matching_bits */
@@ -437,6 +461,13 @@ get_transmit_delay (int round_offset)
       dist_delay = get_matching_bits_delay (matching_bits);
       dist_delay += get_delay_randomization (matching_bits).rel_value;
       ret.rel_value = (uint64_t) dist_delay;
+#if DEBUG_NSE
+      GNUNET_log(GNUNET_ERROR_TYPE_DEBUG, 
+                "For round %llu, delay for %u matching bits is %llu ms\n",
+                (unsigned long long) current_timestamp.abs_value,
+                (unsigned int) matching_bits,
+                (unsigned long long) ret.rel_value);
+#endif
       /* now consider round start time and add delay to it */
       tgt = GNUNET_TIME_absolute_add (current_timestamp, ret);
       return GNUNET_TIME_absolute_get_remaining (tgt);
@@ -479,16 +510,11 @@ transmit_ready (void *cls, size_t size, void *buf)
       return 0;
     }
   GNUNET_assert (size >= sizeof (struct GNUNET_NSE_FloodMessage));
-#if DEBUG_NSE > 1
-  GNUNET_log (GNUNET_ERROR_TYPE_WARNING, 
-             "Sending size estimate to `%s'\n",
-             GNUNET_i2s (&peer_entry->id));
-#endif
   idx = estimate_index;
-  if (peer_entry->previous_round == GNUNET_YES)
+  if (peer_entry->previous_round == GNUNET_NO)
     {
-      idx = (idx + HISTORY_SIZE -1) % HISTORY_SIZE;
-      peer_entry->previous_round = GNUNET_NO;
+      idx = (idx + HISTORY_SIZE - 1) % HISTORY_SIZE;
+      peer_entry->previous_round = GNUNET_YES;
       peer_entry->transmit_task = GNUNET_SCHEDULER_add_delayed (get_transmit_delay (0),
                                                                &transmit_task,
                                                                peer_entry);
@@ -502,6 +528,13 @@ transmit_ready (void *cls, size_t size, void *buf)
                                GNUNET_NO);
       return 0; 
     }
+#if DEBUG_NSE
+  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, 
+             "In round %llu, sending to `%s' estimate with %u bits\n",
+             (unsigned long long) GNUNET_TIME_absolute_ntoh (size_estimate_messages[idx].timestamp).abs_value,
+             GNUNET_i2s (&peer_entry->id),
+             (unsigned int) ntohl (size_estimate_messages[idx].matching_bits));
+#endif
   if (ntohl (size_estimate_messages[idx].hop_count) == 0) 
     GNUNET_STATISTICS_update (stats, 
                              "# flood messages started", 
@@ -659,7 +692,7 @@ update_flood_message(void *cls,
     }
   current_timestamp = next_timestamp;
   next_timestamp = GNUNET_TIME_absolute_add (current_timestamp,
-                                            GNUNET_NSE_INTERVAL);
+                                            gnunet_nse_interval);
   estimate_index = (estimate_index + 1) % HISTORY_SIZE;
   if (estimate_count < HISTORY_SIZE)
     estimate_count++;
@@ -675,7 +708,7 @@ update_flood_message(void *cls,
     setup_flood_message (estimate_index, current_timestamp);
   next_message.matching_bits = htonl (0); /* reset for 'next' round */
   hop_count_max = 0;
-  for (i=0;i<HISTORY_SIZE;i++)
+  for (i = 0; i < HISTORY_SIZE; i++)
     hop_count_max = GNUNET_MAX (ntohl (size_estimate_messages[i].hop_count),
                                hop_count_max);
   GNUNET_CONTAINER_multihashmap_iterate (peers,
@@ -727,7 +760,7 @@ check_proof_of_work(const struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded *pkey,
          pkey, 
          sizeof(struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded));
   GNUNET_CRYPTO_hash (buf, sizeof (buf), &result);
-  return (count_leading_zeroes (&result) >= NSE_WORK_REQUIRED) ? GNUNET_YES : GNUNET_NO;
+  return (count_leading_zeroes (&result) >= nse_work_required) ? GNUNET_YES : GNUNET_NO;
 }
 
 
@@ -785,12 +818,14 @@ find_proof (void *cls,
              &counter, 
              sizeof(uint64_t));
       GNUNET_CRYPTO_hash (buf, sizeof (buf), &result);
-      if (NSE_WORK_REQUIRED <= count_leading_zeroes(&result))
+      if (nse_work_required <= count_leading_zeroes(&result))
        {
          my_proof = counter;
-         GNUNET_log (GNUNET_ERROR_TYPE_INFO,
-                     _("Proof of work found: %llu!\n"),
+#if DEBUG_NSE
+         GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
+                     "Proof of work found: %llu!\n",
                      (unsigned long long) GNUNET_ntohll (counter));
+#endif
          for (i=0;i<HISTORY_SIZE;i++)      
            if (ntohl (size_estimate_messages[i].hop_count) == 0) 
              {
@@ -820,7 +855,7 @@ find_proof (void *cls,
     {
       my_proof = counter;
     }
-  proof_task = GNUNET_SCHEDULER_add_delayed (PROOF_FIND_DELAY,
+  proof_task = GNUNET_SCHEDULER_add_delayed (proof_find_delay,
                                             &find_proof,
                                             NULL);
 }
@@ -884,11 +919,13 @@ update_flood_times (void *cls,
     return GNUNET_OK; /* already active */
   if (peer_entry == exclude)
     return GNUNET_OK; /* trigger of the update */
-  if (peer_entry->previous_round == GNUNET_YES)
+  if (peer_entry->previous_round == GNUNET_NO)
     {
       /* still stuck in previous round, no point to update, check that 
         we are active here though... */
+#if SEND_ON_CONNECT
       GNUNET_break (peer_entry->transmit_task != GNUNET_SCHEDULER_NO_TASK);
+#endif
       return GNUNET_OK; 
     }
   if (peer_entry->transmit_task != GNUNET_SCHEDULER_NO_TASK)
@@ -925,6 +962,10 @@ handle_p2p_size_estimate(void *cls,
   uint32_t matching_bits;  
   unsigned int idx;
 
+#if ENABLE_HISTOGRAM
+  if (NULL != wh)
+    GNUNET_BIO_write_int64 (wh, GNUNET_TIME_absolute_get ().abs_value);
+#endif
   incoming_flood = (const struct GNUNET_NSE_FloodMessage *) message;
   GNUNET_STATISTICS_update (stats, 
                            "# flood messages received", 
@@ -962,15 +1003,17 @@ handle_p2p_size_estimate(void *cls,
       GNUNET_break (0);
       return GNUNET_OK;
     }
+
   ts = GNUNET_TIME_absolute_ntoh (incoming_flood->timestamp);
+
   if (ts.abs_value == current_timestamp.abs_value)
     idx = estimate_index;
-  else if (ts.abs_value == current_timestamp.abs_value - GNUNET_NSE_INTERVAL.rel_value)
+  else if (ts.abs_value == current_timestamp.abs_value - gnunet_nse_interval.rel_value)
     idx = (estimate_index + HISTORY_SIZE - 1) % HISTORY_SIZE;
-  else if (ts.abs_value == next_timestamp.abs_value - GNUNET_NSE_INTERVAL.rel_value)
+  else if (ts.abs_value == next_timestamp.abs_value - gnunet_nse_interval.rel_value)
     {
       if (matching_bits <= ntohl (next_message.matching_bits))
-       return GNUNET_OK; /* ignore, simply too early */      
+       return GNUNET_OK; /* ignore, simply too early/late */
       if (GNUNET_YES !=
          verify_message_crypto (incoming_flood))
        {
@@ -986,7 +1029,6 @@ handle_p2p_size_estimate(void *cls,
                                 "# flood messages discarded (clock skew too large)",
                                1,
                                 GNUNET_NO);
-      GNUNET_break_op (0);
       return GNUNET_OK;
     }
   if (0 == (memcmp (peer, &my_identity, sizeof(struct GNUNET_PeerIdentity))))
@@ -1003,14 +1045,13 @@ handle_p2p_size_estimate(void *cls,
       /* cancel transmission from us to this peer for this round */
       if (idx == estimate_index)
        {
-         if (peer_entry->previous_round == GNUNET_NO)
+         if (peer_entry->previous_round == GNUNET_YES)
            {
              /* cancel any activity for current round */
              if (peer_entry->transmit_task != GNUNET_SCHEDULER_NO_TASK)
                {
                  GNUNET_SCHEDULER_cancel (peer_entry->transmit_task);
                  peer_entry->transmit_task = GNUNET_SCHEDULER_NO_TASK;
-                 peer_entry->previous_round = GNUNET_NO;
                }
              if (peer_entry->th != NULL)
                {
@@ -1022,12 +1063,19 @@ handle_p2p_size_estimate(void *cls,
       else
        {
          /* cancel previous round only */
-         peer_entry->previous_round = GNUNET_NO;
-       }
+         peer_entry->previous_round = GNUNET_YES;
+       } 
     }
   if (matching_bits <= ntohl (size_estimate_messages[idx].matching_bits)) 
     {
+      if ( (idx < estimate_index) &&
+          (peer_entry->previous_round == GNUNET_YES) )
+       peer_entry->previous_round = GNUNET_NO;
+      /* push back our result now, that peer is spreading bad information... */
+      if (peer_entry->transmit_task != GNUNET_SCHEDULER_NO_TASK)
+       GNUNET_SCHEDULER_cancel (peer_entry->transmit_task);
+      peer_entry->transmit_task = GNUNET_SCHEDULER_add_now (&transmit_task,
+                                                           peer_entry);          
       /* Not closer than our most recent message, no need to do work here */
       GNUNET_STATISTICS_update (stats,
                                 "# flood messages ignored (had closer already)",
@@ -1082,9 +1130,11 @@ handle_core_connect(void *cls, const struct GNUNET_PeerIdentity *peer,
                                     &peer->hashPubKey,
                                     peer_entry,
                                     GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY);
+#if SEND_ON_CONNECT
   peer_entry->transmit_task = GNUNET_SCHEDULER_add_delayed (get_transmit_delay (-1),
                                                            &transmit_task,
                                                            peer_entry);
+#endif
 }
 
 
@@ -1169,6 +1219,13 @@ shutdown_task(void *cls,
       GNUNET_CRYPTO_rsa_key_free (my_private_key);
       my_private_key = NULL;
     }
+#if ENABLE_HISTOGRAM
+  if (wh != NULL)
+    {
+      GNUNET_BIO_write_close (wh);
+      wh = NULL;
+    }
+#endif
 }
 
 
@@ -1200,12 +1257,12 @@ core_init (void *cls, struct GNUNET_CORE_Handle *server,
     }
   GNUNET_assert (0 == memcmp (&my_identity, identity, sizeof (struct GNUNET_PeerIdentity)));
   now = GNUNET_TIME_absolute_get ();
-  current_timestamp.abs_value = (now.abs_value / GNUNET_NSE_INTERVAL.rel_value) * GNUNET_NSE_INTERVAL.rel_value;
-  next_timestamp.abs_value = current_timestamp.abs_value + GNUNET_NSE_INTERVAL.rel_value;
+  current_timestamp.abs_value = (now.abs_value / gnunet_nse_interval.rel_value) * gnunet_nse_interval.rel_value;
+  next_timestamp.abs_value = current_timestamp.abs_value + gnunet_nse_interval.rel_value;
   
-  for (i=0;i<HISTORY_SIZE;i++)
+  for (i = 0; i < HISTORY_SIZE; i++)
     {
-      prev_time.abs_value = current_timestamp.abs_value - (HISTORY_SIZE - i - 1) * GNUNET_NSE_INTERVAL.rel_value;
+      prev_time.abs_value = current_timestamp.abs_value - (HISTORY_SIZE - i - 1) * gnunet_nse_interval.rel_value;
       setup_flood_message (i, prev_time);
     }
   estimate_index = HISTORY_SIZE - 1;
@@ -1241,6 +1298,34 @@ run(void *cls, struct GNUNET_SERVER_Handle *server,
       { NULL, 0, 0 } 
     };
   cfg = c;
+
+  if ( (GNUNET_OK != 
+       GNUNET_CONFIGURATION_get_value_time (cfg,
+                                            "NSE", "INTERVAL",
+                                            &gnunet_nse_interval)) ||
+       (GNUNET_OK != 
+       GNUNET_CONFIGURATION_get_value_time (cfg,
+                                            "NSE", "WORKDELAY",
+                                            &proof_find_delay)) ||
+       (GNUNET_OK != 
+       GNUNET_CONFIGURATION_get_value_number (cfg,
+                                              "NSE", "WORKBITS",
+                                              &nse_work_required)) )       
+    {
+      GNUNET_log (GNUNET_ERROR_TYPE_ERROR, 
+                 _ ("NSE service is lacking key configuration settings.  Exiting.\n"));
+      GNUNET_SCHEDULER_shutdown ();
+      return;
+    }
+  if (nse_work_required >= sizeof (GNUNET_HashCode) * 8)
+    {
+      GNUNET_log (GNUNET_ERROR_TYPE_ERROR, 
+                 _ ("Invalid work requirement for NSE service. Exiting.\n"));
+      GNUNET_SCHEDULER_shutdown ();
+      return;
+    }
+
+
   if (GNUNET_OK != 
       GNUNET_CONFIGURATION_get_value_filename (cfg,
                                               "GNUNETD", "HOSTKEY",
@@ -1306,6 +1391,16 @@ run(void *cls, struct GNUNET_SERVER_Handle *server,
                                 core_handlers); /* Register these handlers */
   GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL,
                                &shutdown_task, NULL);
+#if ENABLE_HISTOGRAM
+  if (GNUNET_OK == 
+      GNUNET_CONFIGURATION_get_value_filename (cfg,
+                                              "NSE", "HISTOGRAM",
+                                              &proof))
+    {
+      wh = GNUNET_BIO_write_open (proof);
+      GNUNET_free (proof);
+    }
+#endif
   if (coreAPI == NULL)
     {
       GNUNET_SCHEDULER_shutdown ();