doc: gnunet-c-tutorial: Add nodes.
[oweals/gnunet.git] / src / nse / gnunet-nse-profiler.c
index d25ad7ad07a525b7f7d51b42ffb5502ffdda1ace..4a10022e3ce81b5a308a37d78ad9c77bb34186b5 100644 (file)
@@ -1,6 +1,6 @@
 /*
      This file is part of GNUnet.
-     (C) 2011, 2012 Christian Grothoff (and other contributing authors)
+     Copyright (C) 2011, 2012 GNUnet e.V.
 
      GNUnet is free software; you can redistribute it and/or modify
      it under the terms of the GNU General Public License as published
@@ -14,8 +14,8 @@
 
      You should have received a copy of the GNU General Public License
      along with GNUnet; see the file COPYING.  If not, write to the
-     Free Software Foundation, Inc., 59 Temple Place - Suite 330,
-     Boston, MA 02111-1307, USA.
+     Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+     Boston, MA 02110-1301, USA.
 */
 /**
  * @file nse/gnunet-nse-profiler.c
@@ -83,39 +83,6 @@ struct NSEPeer
 };
 
 
-/**
- * Context for the stats task?
- */
-struct StatsContext
-{
-
-  /**
-   * How many messages have peers received during the test.
-   */
-  unsigned long long total_nse_received_messages;
-
-  /**
-   * How many messages have peers send during the test (should be == received).
-   */
-  unsigned long long total_nse_transmitted_messages;
-
-  /**
-   * How many messages have travelled an edge in both directions.
-   */
-  unsigned long long total_nse_cross;
-
-  /**
-   * How many extra messages per edge (corrections) have been received.
-   */
-  unsigned long long total_nse_extra;
-
-  /**
-   * How many messages have been discarded.
-   */
-  unsigned long long total_discarded;
-};
-
-
 /**
  * Operation map entry
  */
@@ -162,11 +129,11 @@ static int ok;
 /**
  * Be verbose (configuration option)
  */
-static int verbose;
+static unsigned int verbose;
 
 /**
  * Name of the file with the hosts to run the test over (configuration option)
- */ 
+ */
 static char *hosts_file;
 
 /**
@@ -209,11 +176,6 @@ static struct GNUNET_TESTBED_Peer **daemons;
  */
 static struct GNUNET_CONFIGURATION_Handle *testing_cfg;
 
-/**
- * The shutdown task
- */
-static GNUNET_SCHEDULER_TaskIdentifier shutdown_task_id;
-
 /**
  * Maximum number of connections to NSE services.
  */
@@ -261,9 +223,9 @@ static struct OpListEntry *oplist_head;
 static struct OpListEntry *oplist_tail;
 
 /**
- * Are we shutting down
+ * Task running each round of the experiment.
  */
-static int shutting_down;
+static struct GNUNET_SCHEDULER_Task *round_task;
 
 
 /**
@@ -298,17 +260,17 @@ close_monitor_connections ()
  * Task run on shutdown; cleans up everything.
  *
  * @param cls unused
- * @param tc unused
  */
 static void
-shutdown_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
+shutdown_task (void *cls)
 {
-  shutdown_task_id = GNUNET_SCHEDULER_NO_TASK;
-  if (GNUNET_YES == shutting_down)
-    return;
-  shutting_down = GNUNET_YES;
-  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Ending test.\n");    
+  LOG_DEBUG ("Ending test.\n");
   close_monitor_connections ();
+  if (NULL != round_task)
+  {
+    GNUNET_SCHEDULER_cancel (round_task);
+    round_task = NULL;
+  }
   if (NULL != data_file)
   {
     GNUNET_DISK_file_close (data_file);
@@ -320,20 +282,10 @@ shutdown_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
     output_file = NULL;
   }
   if (NULL != testing_cfg)
+  {
     GNUNET_CONFIGURATION_destroy (testing_cfg);
-  testing_cfg = NULL;
-}
-
-
-/**
- * Schedules shutdown task to be run now
- */
-static void
-shutdown_now ()
-{
-  if (GNUNET_SCHEDULER_NO_TASK != shutdown_task_id)
-    GNUNET_SCHEDULER_cancel (shutdown_task_id);
-  shutdown_task_id = GNUNET_SCHEDULER_add_now (&shutdown_task, NULL);
+    testing_cfg = NULL;
+  }
 }
 
 
@@ -347,7 +299,7 @@ shutdown_now ()
  *                of the size estimation values seen
  */
 static void
-handle_estimate (void *cls, 
+handle_estimate (void *cls,
                 struct GNUNET_TIME_Absolute timestamp,
                  double estimate, double std_dev)
 {
@@ -362,11 +314,11 @@ handle_estimate (void *cls,
               peer, estimate, std_dev);
       return;
     }
-  size = GNUNET_snprintf (output_buffer, 
+  size = GNUNET_snprintf (output_buffer,
                          sizeof (output_buffer),
                          "%p %llu %llu %f %f %f\n",
                          peer, peers_running,
-                         timestamp.abs_value,
+                         (unsigned long long) timestamp.abs_value_us,
                          GNUNET_NSE_log_estimate_to_n (estimate), estimate,
                          std_dev);
   if (size != GNUNET_DISK_file_write (output_file, output_buffer, size))
@@ -378,7 +330,7 @@ handle_estimate (void *cls,
 /**
  * Adapter function called to establish a connection to
  * NSE service.
- * 
+ *
  * @param cls closure (the 'struct NSEPeer')
  * @param cfg configuration of the peer to connect to; will be available until
  *          GNUNET_TESTBED_operation_done() is called on the operation returned
@@ -398,11 +350,11 @@ nse_connect_adapter (void *cls,
 /**
  * Adapter function called to destroy a connection to
  * NSE service.
- * 
+ *
  * @param cls closure
  * @param op_result service handle returned from the connect adapter
  */
-static void 
+static void
 nse_disconnect_adapter (void *cls,
                        void *op_result)
 {
@@ -413,17 +365,18 @@ nse_disconnect_adapter (void *cls,
 /**
  * Callback function to process statistic values.
  *
- * @param cls struct StatsContext
- * @param peer the peer the statistics belong to
+ * @param cls `struct NSEPeer`
  * @param subsystem name of subsystem that created the statistic
  * @param name the name of the datum
  * @param value the current value
- * @param is_persistent GNUNET_YES if the value is persistent, GNUNET_NO if not
- * @return GNUNET_OK to continue, GNUNET_SYSERR to abort iteration
+ * @param is_persistent #GNUNET_YES if the value is persistent, #GNUNET_NO if not
+ * @return #GNUNET_OK to continue, #GNUNET_SYSERR to abort iteration
  */
 static int
-stat_iterator (void *cls, const char *subsystem, const char *name,
-                     uint64_t value, int is_persistent)
+stat_iterator (void *cls,
+              const char *subsystem,
+              const char *name,
+              uint64_t value, int is_persistent)
 {
   char *output_buffer;
   struct GNUNET_TIME_Absolute now;
@@ -436,12 +389,15 @@ stat_iterator (void *cls, const char *subsystem, const char *name,
   if (0 != flag)
     flag = 1;
   size = GNUNET_asprintf (&output_buffer, "%llu %llu %u\n",
-                          now.abs_value/1000, value, flag);
+                          now.abs_value_us / 1000LL / 1000LL,
+                         value, flag);
   if (size != GNUNET_DISK_file_write (data_file, output_buffer, size))
   {
     GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "Unable to write to file!\n");
+    GNUNET_free (output_buffer);
     return GNUNET_SYSERR;
   }
+  GNUNET_free (output_buffer);
   return GNUNET_OK;
 }
 
@@ -460,7 +416,7 @@ stat_connect_adapter (void *cls,
                       const struct GNUNET_CONFIGURATION_Handle *cfg)
 {
   struct NSEPeer *peer = cls;
-  
+
   peer->sh = GNUNET_STATISTICS_create ("nse-profiler", cfg);
   return peer->sh;
 }
@@ -531,19 +487,18 @@ connect_nse_service ()
   unsigned int connections;
 
   if (0 == connection_limit)
-    return;  
-  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Connecting to nse service of peers\n");
+    return;
+  LOG_DEBUG ("Connecting to nse service of peers\n");
   connections = 0;
   for (i = 0; i < num_peers_in_round[current_round]; i++)
   {
-    if ((num_peers_in_round[current_round] > connection_limit) && 
+    if ((num_peers_in_round[current_round] > connection_limit) &&
        (0 != (i % (num_peers_in_round[current_round] / connection_limit))))
       continue;
-    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
-                "nse-profiler: connecting to nse service of peer %d\n", i);
-    current_peer = GNUNET_malloc (sizeof (struct NSEPeer));
+    LOG_DEBUG ("Connecting to nse service of peer %d\n", i);
+    current_peer = GNUNET_new (struct NSEPeer);
     current_peer->daemon = daemons[i];
-    current_peer->nse_op 
+    current_peer->nse_op
         = GNUNET_TESTBED_service_connect (NULL,
                                           current_peer->daemon,
                                           "nse",
@@ -572,11 +527,9 @@ connect_nse_service ()
  * Task that starts/stops peers to move to the next round.
  *
  * @param cls NULL, unused
- * @param tc scheduler context (unused)
  */
 static void
-next_round (void *cls, 
-           const struct GNUNET_SCHEDULER_TaskContext *tc);
+next_round (void *cls);
 
 
 /**
@@ -585,17 +538,15 @@ next_round (void *cls,
  * the next round.
  *
  * @param cls unused, NULL
- * @param tc unused
  */
 static void
-finish_round (void *cls, 
-             const struct GNUNET_SCHEDULER_TaskContext *tc)
+finish_round (void *cls)
 {
-  if (0 != (GNUNET_SCHEDULER_REASON_SHUTDOWN & tc->reason))
-    return;
-  LOG (GNUNET_ERROR_TYPE_INFO, "Have %u connections\n", total_connections);
+  LOG (GNUNET_ERROR_TYPE_INFO,
+       "Have %u connections\n",
+       total_connections);
   close_monitor_connections ();
-  GNUNET_SCHEDULER_add_now (&next_round, NULL);
+  round_task = GNUNET_SCHEDULER_add_now (&next_round, NULL);
 }
 
 
@@ -607,7 +558,8 @@ finish_round (void *cls,
 static void
 run_round ()
 {
-  LOG_DEBUG ("Running round %u\n", current_round);
+  LOG_DEBUG ("Running round %u\n",
+            current_round);
   connect_nse_service ();
   GNUNET_SCHEDULER_add_delayed (wait_time,
                                &finish_round,
@@ -623,8 +575,10 @@ make_oplist_entry ()
 {
   struct OpListEntry *entry;
 
-  entry = GNUNET_malloc (sizeof (struct OpListEntry));
-  GNUNET_CONTAINER_DLL_insert_tail (oplist_head, oplist_tail, entry);
+  entry = GNUNET_new (struct OpListEntry);
+  GNUNET_CONTAINER_DLL_insert_tail (oplist_head,
+                                   oplist_tail,
+                                   entry);
   return entry;
 }
 
@@ -636,12 +590,13 @@ make_oplist_entry ()
  * @param op the operation handle
  * @param emsg NULL on success; otherwise an error description
  */
-static void 
-manage_service_cb (void *cls, struct GNUNET_TESTBED_Operation *op,
+static void
+manage_service_cb (void *cls,
+                  struct GNUNET_TESTBED_Operation *op,
                    const char *emsg)
 {
   struct OpListEntry *entry = cls;
-  
+
   GNUNET_TESTBED_operation_done (entry->op);
   if (NULL != emsg)
   {
@@ -651,7 +606,9 @@ manage_service_cb (void *cls, struct GNUNET_TESTBED_Operation *op,
   }
   GNUNET_assert (0 != entry->delta);
   peers_running += entry->delta;
-  GNUNET_CONTAINER_DLL_remove (oplist_head, oplist_tail, entry);
+  GNUNET_CONTAINER_DLL_remove (oplist_head,
+                              oplist_tail,
+                              entry);
   GNUNET_free (entry);
   if (num_peers_in_round[current_round] == peers_running)
     run_round ();
@@ -700,29 +657,26 @@ adjust_running_peers ()
  * peers; then get statistics from *all* peers.
  *
  * @param cls NULL, unused
- * @param tc unused
  */
 static void
-next_round (void *cls, 
-           const struct GNUNET_SCHEDULER_TaskContext *tc)
+next_round (void *cls)
 {
-  if (0 != (GNUNET_SCHEDULER_REASON_SHUTDOWN & tc->reason))
-    return;
-  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "disconnecting nse service of peers\n");
-  current_round++;  
+  round_task = NULL;
+  LOG_DEBUG ("Disconnecting nse service of peers\n");
+  current_round++;
   if (current_round == num_rounds)
-    {
-      /* this was the last round, terminate */
-      ok = 0;
-      GNUNET_SCHEDULER_shutdown ();
-      return;
-    }
+  {
+    /* this was the last round, terminate */
+    ok = 0;
+    GNUNET_SCHEDULER_shutdown ();
+    return;
+  }
   if (num_peers_in_round[current_round] == peers_running)
-    {
-      /* no need to churn, just run next round */
-      run_round ();
-      return;
-    }
+  {
+    /* no need to churn, just run next round */
+    run_round ();
+    return;
+  }
   adjust_running_peers ();
 }
 
@@ -735,7 +689,7 @@ next_round (void *cls,
  * @param event information on what is happening
  */
 static void
-master_controller_cb (void *cls, 
+master_controller_cb (void *cls,
                      const struct GNUNET_TESTBED_EventInformation *event)
 {
   switch (event->type)
@@ -756,6 +710,7 @@ master_controller_cb (void *cls,
  * Signature of a main function for a testcase.
  *
  * @param cls NULL
+ * @param h the run handle
  * @param num_peers_ number of peers in 'peers'
  * @param peers handle to peers run in the testbed.  NULL upon timeout (see
  *          GNUNET_TESTBED_test_run()).
@@ -764,8 +719,9 @@ master_controller_cb (void *cls,
  * @param links_failed the number of overlay link connection attempts that
  *          failed
  */
-static void 
+static void
 test_master (void *cls,
+             struct GNUNET_TESTBED_RunHandle *h,
              unsigned int num_peers_,
              struct GNUNET_TESTBED_Peer **peers,
              unsigned int links_succeeded,
@@ -773,7 +729,7 @@ test_master (void *cls,
 {
   if (NULL == peers)
   {
-    shutdown_now ();
+    GNUNET_SCHEDULER_shutdown ();
     return;
   }
   daemons = peers;
@@ -803,11 +759,11 @@ run (void *cls, char *const *args, const char *cfgfile,
 {
   char *tok;
   uint64_t event_mask;
-  unsigned int num;  
+  unsigned int num;
 
   ok = 1;
   testing_cfg = GNUNET_CONFIGURATION_dup (cfg);
-  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Starting daemons.\n");
+  LOG_DEBUG ("Starting daemons.\n");
   if (NULL == num_peer_spec)
   {
     fprintf (stderr, "You need to specify the number of peers to run\n");
@@ -834,7 +790,7 @@ run (void *cls, char *const *args, const char *cfgfile,
       return;
     }
   if ( (NULL != data_filename) &&
-       (NULL == (data_file = 
+       (NULL == (data_file =
                 GNUNET_DISK_file_open (data_filename,
                                        GNUNET_DISK_OPEN_READWRITE |
                                        GNUNET_DISK_OPEN_TRUNCATE |
@@ -867,9 +823,7 @@ run (void *cls, char *const *args, const char *cfgfile,
                       NULL,     /* master_controller_cb cls */
                       &test_master,
                       NULL);    /* test_master cls */
-  shutdown_task_id = 
-      GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL,
-                                    &shutdown_task, NULL);
+  GNUNET_SCHEDULER_add_shutdown (&shutdown_task, NULL);
 }
 
 
@@ -881,28 +835,47 @@ run (void *cls, char *const *args, const char *cfgfile,
 int
 main (int argc, char *const *argv)
 {
-  static struct GNUNET_GETOPT_CommandLineOption options[] = {
-    {'C', "connections", "COUNT",
-     gettext_noop ("limit to the number of connections to NSE services, 0 for none"),
-     1, &GNUNET_GETOPT_set_uint, &connection_limit},
-    {'d', "details", "FILENAME",
-     gettext_noop ("name of the file for writing connection information and statistics"),
-     1, &GNUNET_GETOPT_set_string, &data_filename},
-    {'H', "hosts", "FILENAME",
-     gettext_noop ("name of the file with the login information for the testbed"),
-     1, &GNUNET_GETOPT_set_string, &hosts_file},
-    {'o', "output", "FILENAME",
-     gettext_noop ("name of the file for writing the main results"),
-     1, &GNUNET_GETOPT_set_string, &output_filename},
-    {'p', "peers", "NETWORKSIZESPEC",
-     gettext_noop ("Number of peers to run in each round, separated by commas"),
-     1, &GNUNET_GETOPT_set_string, &num_peer_spec},
-    {'V', "verbose", NULL,
-     gettext_noop ("be verbose (print progress information)"),
-     0, &GNUNET_GETOPT_increment_value, &verbose},
-    {'w', "wait", "DELAY",
-     gettext_noop ("delay between rounds"),
-     1, &GNUNET_GETOPT_set_relative_time, &wait_time},
+  struct GNUNET_GETOPT_CommandLineOption options[] = {
+    GNUNET_GETOPT_option_uint ('C',
+                                   "connections",
+                                   "COUNT",
+                                   gettext_noop ("limit to the number of connections to NSE services, 0 for none"),
+                                   &connection_limit),
+    GNUNET_GETOPT_option_string ('d',
+                                 "details",
+                                 "FILENAME",
+                                 gettext_noop ("name of the file for writing connection information and statistics"),
+                                 &data_filename),
+
+    GNUNET_GETOPT_option_string ('H',
+                                 "hosts",
+                                 "FILENAME",
+                                 gettext_noop ("name of the file with the login information for the testbed"),
+                                 &hosts_file),
+
+    GNUNET_GETOPT_option_string ('o',
+                                 "output",
+                                 "FILENAME",
+                                 gettext_noop ("name of the file for writing the main results"),
+                                 &output_filename),
+
+
+    GNUNET_GETOPT_option_string ('p',
+                                 "peers",
+                                 "NETWORKSIZESPEC",
+                                 gettext_noop ("Number of peers to run in each round, separated by commas"),
+                                 &num_peer_spec),
+
+    GNUNET_GETOPT_option_increment_uint ('V',
+                                          "verbose",
+                                          gettext_noop ("be verbose (print progress information)"),
+                                          &verbose),
+
+    GNUNET_GETOPT_option_relative_time ('w',
+                                            "wait",
+                                            "DELAY",
+                                            gettext_noop ("delay between rounds"),
+                                            &wait_time),
     GNUNET_GETOPT_OPTION_END
   };
   if (GNUNET_OK != GNUNET_STRINGS_get_utf8_args (argc, argv, &argc, &argv))