-ensure stats queues do not grow too big
[oweals/gnunet.git] / src / testbed / testbed_api_testbed.c
index 25054bf1d0ad0670d0e8017972dac06abcf94b2f..b3b2c3987ee43eb6a1ea126923e672fe71eeae1d 100644 (file)
@@ -1,6 +1,6 @@
 /*
   This file is part of GNUnet
-  (C) 2008--2013 Christian Grothoff (and other contributing authors)
+  Copyright (C) 2008--2013 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.
 */
 
 /**
 #define DEFAULT_SETUP_TIMEOUT 300
 
 
+/**
+ * Configuration section for testbed
+ */
+#define TESTBED_CONFIG_SECTION "testbed"
+
+/**
+ * Option string for the maximum number of edges a peer is permitted to have
+ * while generating scale free topology
+ */
+#define SCALE_FREE_CAP "SCALE_FREE_TOPOLOGY_CAP"
+
+/**
+ * Option string for the number of edges to be established when adding a new
+ * node to the scale free network
+ */
+#define SCALE_FREE_M "SCALE_FREE_TOPOLOGY_M"
+
 /**
  * Context information for the operation we start
  */
@@ -236,17 +253,17 @@ struct GNUNET_TESTBED_RunHandle
   /**
    * Host registration task
    */
-  GNUNET_SCHEDULER_TaskIdentifier register_hosts_task;
+  struct GNUNET_SCHEDULER_Task * register_hosts_task;
 
   /**
    * Task to be run of a timeout
    */
-  GNUNET_SCHEDULER_TaskIdentifier timeout_task;
+  struct GNUNET_SCHEDULER_Task * timeout_task;
 
   /**
    * Task run upon shutdown interrupts
    */
-  GNUNET_SCHEDULER_TaskIdentifier interrupt_task;
+  struct GNUNET_SCHEDULER_Task *interrupt_task;
 
   /**
    * The event mask for the controller
@@ -321,7 +338,7 @@ struct GNUNET_TESTBED_RunHandle
  */
 static uint32_t
 rcop_key (void *rcop)
-{  
+{
   return * ((uint32_t *) &rcop);
 }
 
@@ -380,10 +397,10 @@ static struct RunContextOperation *
 search_rcop (struct GNUNET_TESTBED_RunHandle *rc, struct GNUNET_TESTBED_Operation *op)
 {
   struct SearchContext sc;
-  
+
   sc.query = op;
   sc.result = NULL;
-  if (GNUNET_SYSERR == 
+  if (GNUNET_SYSERR ==
       GNUNET_CONTAINER_multihashmap32_get_multiple (rc->rcop_map,
                                                     rcop_key (op),
                                                     &search_iterator,
@@ -431,15 +448,14 @@ remove_rcop (struct GNUNET_TESTBED_RunHandle *rc, struct RunContextOperation *rc
 /**
  * Assuming all peers have been destroyed cleanup run handle
  *
- * @param cls the run handle
+ * @param rc the run context
  */
 static void
-cleanup (void *cls)
+cleanup (struct GNUNET_TESTBED_RunHandle *rc)
 {
-  struct GNUNET_TESTBED_RunHandle *rc = cls;
   unsigned int hid;
 
-  GNUNET_assert (GNUNET_SCHEDULER_NO_TASK == rc->register_hosts_task);
+  GNUNET_assert (NULL == rc->register_hosts_task);
   GNUNET_assert (NULL == rc->reg_handle);
   GNUNET_assert (NULL == rc->peers);
   GNUNET_assert (NULL == rc->hclist);
@@ -464,7 +480,7 @@ cleanup (void *cls)
 
 
 /**
- * Iterator for cleaning up elements from rcop_map 
+ * Iterator for cleaning up elements from rcop_map
  *
  * @param cls the RunContext
  * @param key the 32-bit key
@@ -508,15 +524,15 @@ rc_cleanup_operations (struct GNUNET_TESTBED_RunHandle *rc)
     rc->hclist = NULL;
   }
   /* Stop register hosts task if it is running */
-  if (GNUNET_SCHEDULER_NO_TASK != rc->register_hosts_task)
+  if (NULL != rc->register_hosts_task)
   {
     GNUNET_SCHEDULER_cancel (rc->register_hosts_task);
-    rc->register_hosts_task = GNUNET_SCHEDULER_NO_TASK;
+    rc->register_hosts_task = NULL;
   }
-  if (GNUNET_SCHEDULER_NO_TASK != rc->timeout_task)
+  if (NULL != rc->timeout_task)
   {
     GNUNET_SCHEDULER_cancel (rc->timeout_task);
-    rc->timeout_task = GNUNET_SCHEDULER_NO_TASK;
+    rc->timeout_task = NULL;
   }
   if (NULL != rc->reg_handle)
   {
@@ -529,7 +545,7 @@ rc_cleanup_operations (struct GNUNET_TESTBED_RunHandle *rc)
     rc->topology_operation = NULL;
   }
   /* cancel any exiting operations */
-  GNUNET_assert (GNUNET_SYSERR != 
+  GNUNET_assert (GNUNET_SYSERR !=
                  GNUNET_CONTAINER_multihashmap32_iterate (rc->rcop_map,
                                                           &rcop_cleanup_iterator,
                                                           rc));
@@ -545,13 +561,13 @@ static void
 cancel_interrupt_task (struct GNUNET_TESTBED_RunHandle *rc)
 {
   GNUNET_SCHEDULER_cancel (rc->interrupt_task);
-  rc->interrupt_task = GNUNET_SCHEDULER_NO_TASK;
+  rc->interrupt_task = NULL;
 }
 
 
 /**
  * This callback will be called when all the operations are completed
- * (done/cancelled) 
+ * (done/cancelled)
  *
  * @param cls run context
  */
@@ -575,7 +591,7 @@ wait_op_completion (void *cls)
   if (NULL == rc->peers)
     goto cleanup_;
   rc->shutdown = GNUNET_YES;
-  rcop = GNUNET_malloc (sizeof (struct RunContextOperation));
+  rcop = GNUNET_new (struct RunContextOperation);
   rcop->rc = rc;
   rcop->op = GNUNET_TESTBED_shutdown_peers (rc->c, rcop, NULL, NULL);
   GNUNET_assert (NULL != rcop->op);
@@ -595,25 +611,25 @@ wait_op_completion (void *cls)
  * Task run upon interrupts (SIGINT, SIGTERM) and upon scheduler shutdown.
  *
  * @param cls the RunContext which has to be acted upon
- * @param tc the scheduler task context
  */
 static void
-interrupt (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
+interrupt (void *cls)
 {
   struct GNUNET_TESTBED_RunHandle *rc = cls;
   struct GNUNET_TESTBED_Controller *c = rc->c;
   unsigned int size;
 
   /* reschedule */
-  rc->interrupt_task = GNUNET_SCHEDULER_add_delayed
-      (GNUNET_TIME_UNIT_FOREVER_REL, &interrupt, rc);
-  rc_cleanup_operations (rc);  
-  if ( (GNUNET_NO == rc->shutdown)
-       && (NULL != c) 
-       && (0 != (size = GNUNET_CONTAINER_multihashmap32_size (c->opc_map))))
+  rc->interrupt_task = GNUNET_SCHEDULER_add_shutdown (&interrupt, rc);
+  rc_cleanup_operations (rc);
+  if ( (GNUNET_NO == rc->shutdown) &&
+       (NULL != c) &&
+       (NULL != c->opc_map) &&
+       (0 != (size = GNUNET_CONTAINER_multihashmap32_size (c->opc_map))))
   {
-    LOG (GNUNET_ERROR_TYPE_WARNING, "Shutdown postponed as there are "
-         "%u operations currently active\n", size);
+    LOG (GNUNET_ERROR_TYPE_WARNING,
+         "Shutdown postponed as there are %u operations currently active\n",
+         size);
     c->opcq_empty_cb = &wait_op_completion;
     c->opcq_empty_cls = rc;
     return;
@@ -643,10 +659,9 @@ prof_time (struct GNUNET_TESTBED_RunHandle *rc)
  * Task for starting peers
  *
  * @param cls the RunHandle
- * @param tc the task context from scheduler
  */
 static void
-start_peers_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
+start_peers_task (void *cls)
 {
   struct GNUNET_TESTBED_RunHandle *rc = cls;
   struct RunContextOperation *rcop;
@@ -656,7 +671,7 @@ start_peers_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
   rc->pstart_time = GNUNET_TIME_absolute_get ();
   for (peer = 0; peer < rc->num_peers; peer++)
   {
-    rcop = GNUNET_malloc (sizeof (struct RunContextOperation));
+    rcop = GNUNET_new (struct RunContextOperation);
     rcop->rc = rc;
     rcop->op  = GNUNET_TESTBED_peer_start (NULL, rc->peers[peer], NULL, NULL);
     GNUNET_assert (NULL != rcop->op);
@@ -714,7 +729,7 @@ static void
 call_master (struct GNUNET_TESTBED_RunHandle *rc)
 {
   GNUNET_SCHEDULER_cancel (rc->timeout_task);
-  rc->timeout_task = GNUNET_SCHEDULER_NO_TASK;
+  rc->timeout_task = NULL;
   if (NULL != rc->test_master)
     rc->test_master (rc->test_master_cls, rc, rc->num_peers, rc->peers,
                      rc->links_succeeded, rc->links_failed);
@@ -765,7 +780,7 @@ create_peers (struct GNUNET_TESTBED_RunHandle *rc)
   rc->peer_count = 0;
   for (peer = 0; peer < rc->num_peers; peer++)
   {
-    rcop = GNUNET_malloc (sizeof (struct RunContextOperation));
+    rcop = GNUNET_new (struct RunContextOperation);
     rcop->rc = rc;
     rcop->op =
         GNUNET_TESTBED_peer_create (rc->c,
@@ -869,10 +884,13 @@ call_cc:
   DEBUG ("%u peers started in %s\n", rc->num_peers, prof_time (rc));
   if (GNUNET_TESTBED_TOPOLOGY_NONE != rc->topology)
   {
-    if ((GNUNET_TESTBED_TOPOLOGY_ERDOS_RENYI == rc->topology) ||
-        (GNUNET_TESTBED_TOPOLOGY_SMALL_WORLD_RING == rc->topology) ||
-        (GNUNET_TESTBED_TOPOLOGY_SMALL_WORLD == rc->topology))
+    switch (rc->topology)
     {
+    case GNUNET_TESTBED_TOPOLOGY_NONE:
+      GNUNET_assert (0);
+    case GNUNET_TESTBED_TOPOLOGY_ERDOS_RENYI:
+    case GNUNET_TESTBED_TOPOLOGY_SMALL_WORLD_RING:
+    case GNUNET_TESTBED_TOPOLOGY_SMALL_WORLD:
       rc->topology_operation =
           GNUNET_TESTBED_overlay_configure_topology (NULL, rc->num_peers,
                                                      rc->peers, &rc->num_oc,
@@ -881,9 +899,8 @@ call_cc:
                                                      rc->topology,
                                                      rc->random_links,
                                                      GNUNET_TESTBED_TOPOLOGY_OPTION_END);
-    }
-    else if (GNUNET_TESTBED_TOPOLOGY_FROM_FILE == rc->topology)
-    {
+      break;
+    case GNUNET_TESTBED_TOPOLOGY_FROM_FILE:
       GNUNET_assert (NULL != rc->topo_file);
       rc->topology_operation =
           GNUNET_TESTBED_overlay_configure_topology (NULL, rc->num_peers,
@@ -893,8 +910,32 @@ call_cc:
                                                      rc->topology,
                                                      rc->topo_file,
                                                      GNUNET_TESTBED_TOPOLOGY_OPTION_END);
-    }
-    else
+      break;
+    case GNUNET_TESTBED_TOPOLOGY_SCALE_FREE:
+      {
+        unsigned long long number;
+        unsigned int cap;
+        GNUNET_assert (GNUNET_OK ==
+                       GNUNET_CONFIGURATION_get_value_number (rc->cfg, TESTBED_CONFIG_SECTION,
+                                                              SCALE_FREE_CAP,
+                                                              &number));
+        cap = (unsigned int) number;
+        GNUNET_assert (GNUNET_OK ==
+                       GNUNET_CONFIGURATION_get_value_number (rc->cfg, TESTBED_CONFIG_SECTION,
+                                                              SCALE_FREE_M,
+                                                              &number));
+        rc->topology_operation =
+            GNUNET_TESTBED_overlay_configure_topology (NULL, rc->num_peers,
+                                                       rc->peers, &rc->num_oc,
+                                                       &topology_completion_callback,
+                                                       rc,
+                                                       rc->topology,
+                                                       cap,    /* uint16_t */
+                                                       (unsigned int) number, /* uint8_t */
+                                                       GNUNET_TESTBED_TOPOLOGY_OPTION_END);
+      }
+      break;
+    default:
       rc->topology_operation =
           GNUNET_TESTBED_overlay_configure_topology (NULL, rc->num_peers,
                                                      rc->peers, &rc->num_oc,
@@ -902,9 +943,10 @@ call_cc:
                                                      rc,
                                                      rc->topology,
                                                      GNUNET_TESTBED_TOPOLOGY_OPTION_END);
+    }
     if (NULL == rc->topology_operation)
       LOG (GNUNET_ERROR_TYPE_WARNING,
-           "Not generating topology. Check number of peers\n");
+           "Not generating topology. Check number of peers\n");
     else
     {
       DEBUG ("Creating overlay topology\n");
@@ -921,10 +963,9 @@ call_cc:
  * Task to register all hosts available in the global host list
  *
  * @param cls the RunContext
- * @param tc the scheduler task context
  */
 static void
-register_hosts (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
+register_hosts (void *cls);
 
 
 /**
@@ -946,7 +987,8 @@ host_registration_completion (void *cls, const char *emsg)
     GNUNET_SCHEDULER_shutdown ();
     return;
   }
-  rc->register_hosts_task = GNUNET_SCHEDULER_add_now (&register_hosts, rc);
+  rc->register_hosts_task = GNUNET_SCHEDULER_add_now (&register_hosts,
+                                                     rc);
 }
 
 
@@ -954,23 +996,22 @@ host_registration_completion (void *cls, const char *emsg)
  * Task to register all hosts available in the global host list
  *
  * @param cls RunContext
- * @param tc the scheduler task context
  */
 static void
-register_hosts (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
+register_hosts (void *cls)
 {
   struct GNUNET_TESTBED_RunHandle *rc = cls;
   struct RunContextOperation *rcop;
   unsigned int slave;
 
-  rc->register_hosts_task = GNUNET_SCHEDULER_NO_TASK;
+  rc->register_hosts_task = NULL;
   if (rc->reg_hosts == rc->num_hosts)
   {
     DEBUG ("All hosts successfully registered\n");
     /* Start slaves */
     for (slave = 0; slave < rc->num_hosts; slave++)
     {
-      rcop = GNUNET_malloc (sizeof (struct RunContextOperation));
+      rcop = GNUNET_new (struct RunContextOperation);
       rcop->rc = rc;
       rcop->op =
           GNUNET_TESTBED_controller_link (rcop, rc->c, rc->hosts[slave],
@@ -1149,15 +1190,15 @@ host_habitable_cb (void *cls, const struct GNUNET_TESTBED_Host *host,
  * Task run upon timeout while setting up the testbed
  *
  * @param cls the RunContext
- * @param tc the task context
  */
 static void
-timeout_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
+timeout_task (void *cls)
 {
   struct GNUNET_TESTBED_RunHandle *rc = cls;
-  
-  rc->timeout_task = GNUNET_SCHEDULER_NO_TASK;
-  LOG (GNUNET_ERROR_TYPE_ERROR, _("Shutting down testbed due to timeout while setup.\n"));
+
+  rc->timeout_task = NULL;
+  LOG (GNUNET_ERROR_TYPE_ERROR,
+       _("Shutting down testbed due to timeout while setup.\n"));
    GNUNET_SCHEDULER_shutdown ();
    if (NULL != rc->test_master)
      rc->test_master (rc->test_master_cls, rc, 0, NULL, 0, 0);
@@ -1202,16 +1243,16 @@ GNUNET_TESTBED_run (const char *host_filename,
 {
   struct GNUNET_TESTBED_RunHandle *rc;
   char *topology;
-  struct CompatibilityCheckContext *hc;      
+  struct CompatibilityCheckContext *hc;
   struct GNUNET_TIME_Relative timeout;
-  unsigned long long random_links;
+  unsigned long long number;
   unsigned int hid;
   unsigned int nhost;
 
   GNUNET_assert (num_peers > 0);
-  rc = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_RunHandle));
+  rc = GNUNET_new (struct GNUNET_TESTBED_RunHandle);
   rc->cfg = GNUNET_CONFIGURATION_dup (cfg);
-#if ENABLE_LL
+#if ENABLE_SUPERMUC
   rc->num_hosts = GNUNET_TESTBED_hosts_load_from_loadleveler (rc->cfg,
                                                               &rc->hosts);
   if (0 == rc->num_hosts)
@@ -1245,12 +1286,12 @@ GNUNET_TESTBED_run (const char *host_filename,
   rc->state = RC_INIT;
   rc->topology = GNUNET_TESTBED_TOPOLOGY_NONE;
   if (GNUNET_OK ==
-      GNUNET_CONFIGURATION_get_value_string (rc->cfg, "testbed",
+      GNUNET_CONFIGURATION_get_value_string (rc->cfg, TESTBED_CONFIG_SECTION,
                                              "OVERLAY_TOPOLOGY", &topology))
   {
     if (GNUNET_NO == GNUNET_TESTBED_topology_get_ (&rc->topology, topology))
     {
-      GNUNET_log_config_invalid (GNUNET_ERROR_TYPE_ERROR, "testbed",
+      GNUNET_log_config_invalid (GNUNET_ERROR_TYPE_ERROR, TESTBED_CONFIG_SECTION,
                                  "OVERLAY_TOPLOGY",
                                  _
                                  ("Specified topology must be supported by testbed"));
@@ -1263,38 +1304,73 @@ GNUNET_TESTBED_run (const char *host_filename,
   case GNUNET_TESTBED_TOPOLOGY_SMALL_WORLD_RING:
   case GNUNET_TESTBED_TOPOLOGY_SMALL_WORLD:
     if (GNUNET_OK !=
-        GNUNET_CONFIGURATION_get_value_number (rc->cfg, "testbed",
+        GNUNET_CONFIGURATION_get_value_number (rc->cfg, TESTBED_CONFIG_SECTION,
                                                "OVERLAY_RANDOM_LINKS",
-                                               &random_links))
+                                               &number))
     {
       /* OVERLAY option RANDOM & SMALL_WORLD_RING requires OVERLAY_RANDOM_LINKS
        * option to be set to the number of random links to be established  */
-      GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR, "testbed",
+      GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR, TESTBED_CONFIG_SECTION,
                                  "OVERLAY_RANDOM_LINKS");
       goto error_cleanup;
     }
-    if (random_links > UINT32_MAX)
+    if (number > UINT32_MAX)
     {
       GNUNET_break (0);         /* Too big number */
       goto error_cleanup;
     }
-    rc->random_links = (unsigned int) random_links;
+    rc->random_links = (unsigned int) number;
     break;
   case GNUNET_TESTBED_TOPOLOGY_FROM_FILE:
     if (GNUNET_OK !=
-        GNUNET_CONFIGURATION_get_value_string (rc->cfg, "testbed",
+        GNUNET_CONFIGURATION_get_value_filename (rc->cfg, TESTBED_CONFIG_SECTION,
                                                "OVERLAY_TOPOLOGY_FILE",
                                                &rc->topo_file))
     {
-      GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR, "testbed",
+      GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR, TESTBED_CONFIG_SECTION,
                                  "OVERLAY_TOPOLOGY_FILE");
       goto error_cleanup;
     }
-    break;
+    goto warn_ignore;
+  case GNUNET_TESTBED_TOPOLOGY_SCALE_FREE:
+    if (GNUNET_OK !=
+        GNUNET_CONFIGURATION_get_value_number (rc->cfg, TESTBED_CONFIG_SECTION,
+                                               SCALE_FREE_CAP, &number))
+    {
+      GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR, TESTBED_CONFIG_SECTION,
+                                 SCALE_FREE_CAP);
+      goto error_cleanup;
+    }
+    if (UINT16_MAX < number)
+    {
+      LOG (GNUNET_ERROR_TYPE_ERROR,
+           _("Maximum number of edges a peer can have in a scale free topology"
+             " cannot be more than %u.  Given `%s = %llu'"), UINT16_MAX,
+           SCALE_FREE_CAP, number);
+      goto error_cleanup;
+    }
+    if (GNUNET_OK !=
+        GNUNET_CONFIGURATION_get_value_number (rc->cfg, TESTBED_CONFIG_SECTION,
+                                               SCALE_FREE_M, &number))
+    {
+      GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR, TESTBED_CONFIG_SECTION,
+                                 SCALE_FREE_M);
+      goto error_cleanup;
+    }
+    if (UINT8_MAX < number)
+    {
+      LOG (GNUNET_ERROR_TYPE_ERROR,
+           _("The number of edges that can established when adding a new node"
+             " to scale free topology cannot be more than %u.  Given `%s = %llu'"),
+           UINT8_MAX, SCALE_FREE_M, number);
+      goto error_cleanup;
+    }
+    goto warn_ignore;
   default:
+  warn_ignore:
     /* Warn if OVERLAY_RANDOM_LINKS is present that it will be ignored */
     if (GNUNET_YES ==
-        GNUNET_CONFIGURATION_have_value (rc->cfg, "testbed",
+        GNUNET_CONFIGURATION_have_value (rc->cfg, TESTBED_CONFIG_SECTION,
                                          "OVERLAY_RANDOM_LINKS"))
       LOG (GNUNET_ERROR_TYPE_WARNING,
            "Ignoring value of `OVERLAY_RANDOM_LINKS' in given configuration\n");
@@ -1330,7 +1406,7 @@ GNUNET_TESTBED_run (const char *host_filename,
     rc->cproc =
         GNUNET_TESTBED_controller_start ("127.0.0.1", rc->h,
                                          &controller_status_cb, rc);
-  if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_time (cfg, "TESTBED",
+  if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_time (cfg, TESTBED_CONFIG_SECTION,
                                                         "SETUP_TIMEOUT",
                                                         &timeout))
   {
@@ -1339,10 +1415,11 @@ GNUNET_TESTBED_run (const char *host_filename,
   }
   rc->rcop_map = GNUNET_CONTAINER_multihashmap32_create (256);
   rc->timeout_task =
-      GNUNET_SCHEDULER_add_delayed (timeout, &timeout_task, rc);
+    GNUNET_SCHEDULER_add_delayed (timeout, &timeout_task, rc);
+  GNUNET_assert (NULL == rc->interrupt_task);
   rc->interrupt_task =
-      GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL, &interrupt,
-                                    rc);
+    GNUNET_SCHEDULER_add_shutdown (&interrupt,
+                                  rc);
   return;
 
 error_cleanup: