src/testbed/testbed_api_testbed.c

   1 /*
   2   This file is part of GNUnet
   3   (C) 2008--2012 Christian Grothoff (and other contributing authors)
   4
   5   GNUnet is free software; you can redistribute it and/or modify
   6   it under the terms of the GNU General Public License as published
   7   by the Free Software Foundation; either version 3, or (at your
   8   option) any later version.
   9
  10   GNUnet is distributed in the hope that it will be useful, but
  11   WITHOUT ANY WARRANTY; without even the implied warranty of
  12   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13   General Public License for more details.
  14
  15   You should have received a copy of the GNU General Public License
  16   along with GNUnet; see the file COPYING.  If not, write to the
  17   Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18   Boston, MA 02111-1307, USA.
  19 */
  20
  21 /**
  22  * @file testbed/testbed_api_testbed.c
  23  * @brief high-level testbed management
  24  * @author Christian Grothoff
  25  * @author Sree Harsha Totakura
  26  */
  27
  28 #include "platform.h"
  29 #include "gnunet_util_lib.h"
  30 #include "gnunet_testbed_service.h"
  31 #include "testbed_api_peers.h"
  32 #include "testbed_api_hosts.h"
  33 #include "testbed_api_topology.h"
  34
  35 /**
  36  * Generic loggins shorthand
  37  */
  38 #define LOG(kind,...)                                           \
  39   GNUNET_log_from (kind, "testbed-api-testbed", __VA_ARGS__)
  40
  41 /**
  42  * Debug logging shortcut
  43  */
  44 #define DEBUG(...)                              \
  45   LOG (GNUNET_ERROR_TYPE_DEBUG, __VA_ARGS__)
  46
  47 /**
  48  * DLL of operations
  49  */
  50 struct DLLOperation
  51 {
  52   /**
  53    * The testbed operation handle
  54    */
  55   struct GNUNET_TESTBED_Operation *op;
  56
  57   /**
  58    * Context information for GNUNET_TESTBED_run()
  59    */
  60   struct RunContext *rc;
  61
  62   /**
  63    * Closure
  64    */
  65   void *cls;
  66
  67   /**
  68    * The next pointer for DLL
  69    */
  70   struct DLLOperation *next;
  71
  72   /**
  73    * The prev pointer for DLL
  74    */
  75   struct DLLOperation *prev;
  76 };
  77
  78
  79 /**
  80  * States of RunContext
  81  */
  82 enum State
  83 {
  84   /**
  85    * Initial state
  86    */
  87   RC_INIT = 0,
  88
  89   /**
  90    * Controllers on given hosts started and linked
  91    */
  92   RC_LINKED,
  93
  94   /**
  95    * Peers are created
  96    */
  97   RC_PEERS_CREATED,
  98
  99   /**
 100    * The testbed run is ready and the master callback can be called now. At this
 101    * time the peers are all started and if a topology is provided in the
 102    * configuration the topology would have been attempted
 103    */
 104   RC_READY,
 105
 106   /* /\** */
 107   /*  * Peers are stopped */
 108   /*  *\/ */
 109   /* RC_PEERS_STOPPED, */
 110
 111   /* /\** */
 112   /*  * Peers are destroyed */
 113   /*  *\/ */
 114   /* RC_PEERS_DESTROYED */
 115
 116   /**
 117    * All peers shutdown (stopped and destroyed)
 118    */
 119   RC_PEERS_SHUTDOWN
 120 };
 121
 122
 123 /**
 124  * Testbed Run Handle
 125  */
 126 struct RunContext
 127 {
 128   /**
 129    * The controller handle
 130    */
 131   struct GNUNET_TESTBED_Controller *c;
 132
 133   /**
 134    * The configuration of the controller. This is based on the cfg given to the
 135    * function GNUNET_TESTBED_run(). We also use this config as a template while
 136    * for peers
 137    */
 138   struct GNUNET_CONFIGURATION_Handle *cfg;
 139
 140   /**
 141    * Handle to the host on which the controller runs
 142    */
 143   struct GNUNET_TESTBED_Host *h;
 144
 145   /**
 146    * The handle to the controller process
 147    */
 148   struct GNUNET_TESTBED_ControllerProc *cproc;
 149
 150   /**
 151    * The callback to use as controller callback
 152    */
 153   GNUNET_TESTBED_ControllerCallback cc;
 154
 155   /**
 156    * The pointer to the controller callback
 157    */
 158   void *cc_cls;
 159
 160   /**
 161    * The trusted IP string
 162    */
 163   char *trusted_ip;
 164
 165   /**
 166    * TestMaster callback to call when testbed initialization is done
 167    */
 168   GNUNET_TESTBED_TestMaster test_master;
 169
 170   /**
 171    * The closure for the TestMaster callback
 172    */
 173   void *test_master_cls;
 174
 175   /**
 176    * The head element of DLL operations
 177    */
 178   struct DLLOperation *dll_op_head;
 179
 180   /**
 181    * The tail element of DLL operations
 182    */
 183   struct DLLOperation *dll_op_tail;
 184
 185   /**
 186    * An array of hosts loaded from the hostkeys file
 187    */
 188   struct GNUNET_TESTBED_Host **hosts;
 189
 190   /**
 191    * The handle for whether a host is habitable or not
 192    */
 193   struct GNUNET_TESTBED_HostHabitableCheckHandle **hc_handles;
 194
 195   /**
 196    * Array of peers which we create
 197    */
 198   struct GNUNET_TESTBED_Peer **peers;
 199
 200   /**
 201    * The topology generation operation. Will be null if no topology is set in
 202    * the configuration
 203    */
 204   struct GNUNET_TESTBED_Operation *topology_operation;
 205
 206   /**
 207    * The file containing topology data. Only used if the topology is set to 'FROM_FILE'
 208    */
 209   char *topo_file;
 210
 211   /**
 212    * Host registration handle
 213    */
 214   struct GNUNET_TESTBED_HostRegistrationHandle *reg_handle;
 215
 216   /**
 217    * Profiling start time
 218    */
 219   struct GNUNET_TIME_Absolute pstart_time;
 220
 221   /**
 222    * Host registration task
 223    */
 224   GNUNET_SCHEDULER_TaskIdentifier register_hosts_task;
 225
 226   /**
 227    * Task to be run while shutting down
 228    */
 229   GNUNET_SCHEDULER_TaskIdentifier shutdown_run_task;
 230
 231   /**
 232    * The event mask for the controller
 233    */
 234   uint64_t event_mask;
 235
 236   /**
 237    * State of this context
 238    */
 239   enum State state;
 240
 241   /**
 242    * The topology which has to be achieved with the peers started in this context
 243    */
 244   enum GNUNET_TESTBED_TopologyOption topology;
 245
 246   /**
 247    * Have we already shutdown
 248    */
 249   int shutdown;
 250
 251   /**
 252    * Number of hosts in the given host file
 253    */
 254   unsigned int num_hosts;
 255
 256   /**
 257    * Number of registered hosts. Also used as a counter while checking
 258    * habitabillity of hosts
 259    */
 260   unsigned int reg_hosts;
 261
 262   /**
 263    * Current peer count for an operation; Set this to 0 and increment for each
 264    * successful operation on a peer
 265    */
 266   unsigned int peer_count;
 267
 268   /**
 269    * number of peers to start
 270    */
 271   unsigned int num_peers;
 272
 273   /**
 274    * Expected overlay connects. Should be zero if no topology is relavant
 275    */
 276   unsigned int num_oc;
 277
 278   /**
 279    * Number of random links to established
 280    */
 281   unsigned int random_links;
 282
 283 };
 284
 285
 286 /**
 287  * Function to return the string representation of the duration between current
 288  * time and `pstart_time' in `RunContext'
 289  *
 290  * @param rc the RunContext
 291  * @return the representation string; this is NOT reentrant
 292  */
 293 static const char *
 294 prof_time (struct RunContext *rc)
 295 {
 296   struct GNUNET_TIME_Relative ptime;
 297
 298   ptime = GNUNET_TIME_absolute_get_duration (rc->pstart_time);
 299   return GNUNET_STRINGS_relative_time_to_string (ptime, GNUNET_YES);
 300 }
 301
 302
 303 /**
 304  * Task for starting peers
 305  *
 306  * @param cls the RunHandle
 307  * @param tc the task context from scheduler
 308  */
 309 static void
 310 start_peers_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 311 {
 312   struct RunContext *rc = cls;
 313   struct DLLOperation *dll_op;
 314   unsigned int peer;
 315
 316   DEBUG ("Starting Peers\n");
 317   rc->pstart_time = GNUNET_TIME_absolute_get ();
 318   for (peer = 0; peer < rc->num_peers; peer++)
 319   {
 320     dll_op = GNUNET_malloc (sizeof (struct DLLOperation));
 321     dll_op->op = GNUNET_TESTBED_peer_start (NULL, rc->peers[peer], NULL, NULL);
 322     dll_op->cls = rc->peers[peer];
 323     GNUNET_CONTAINER_DLL_insert_tail (rc->dll_op_head, rc->dll_op_tail, dll_op);
 324   }
 325   rc->peer_count = 0;
 326 }
 327
 328
 329 /**
 330  * Functions of this signature are called when a peer has been successfully
 331  * created
 332  *
 333  * @param cls the closure from GNUNET_TESTBED_peer_create()
 334  * @param peer the handle for the created peer; NULL on any error during
 335  *          creation
 336  * @param emsg NULL if peer is not NULL; else MAY contain the error description
 337  */
 338 static void
 339 peer_create_cb (void *cls, struct GNUNET_TESTBED_Peer *peer, const char *emsg)
 340 {
 341   struct DLLOperation *dll_op = cls;
 342   struct RunContext *rc;
 343
 344   GNUNET_assert (NULL != dll_op);
 345   rc = dll_op->rc;
 346   GNUNET_assert (NULL != rc);
 347   GNUNET_CONTAINER_DLL_remove (rc->dll_op_head, rc->dll_op_tail, dll_op);
 348   GNUNET_TESTBED_operation_done (dll_op->op);
 349   GNUNET_free (dll_op);
 350   if (NULL == peer)
 351   {
 352     if (NULL != emsg)
 353       LOG (GNUNET_ERROR_TYPE_WARNING, "Error while creating a peer: %s\n",
 354            emsg);
 355     /* FIXME: GNUNET_TESTBED_shutdown_run()? */
 356     return;
 357   }
 358   rc->peers[rc->peer_count] = peer;
 359   rc->peer_count++;
 360   if (rc->peer_count < rc->num_peers)
 361     return;
 362   DEBUG ("%u peers created in %s\n", rc->num_peers, prof_time (rc));
 363   rc->state = RC_PEERS_CREATED;
 364   GNUNET_SCHEDULER_add_now (&start_peers_task, rc);
 365 }
 366
 367
 368 /**
 369  * Assuming all peers have been destroyed cleanup run handle
 370  *
 371  * @param cls the run handle
 372  * @param tc the task context from scheduler
 373  */
 374 static void
 375 cleanup_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 376 {
 377   struct RunContext *rc = cls;
 378   unsigned int hid;
 379
 380   GNUNET_assert (GNUNET_SCHEDULER_NO_TASK == rc->register_hosts_task);
 381   GNUNET_assert (NULL == rc->reg_handle);
 382   GNUNET_assert (NULL == rc->peers);
 383   GNUNET_assert (NULL == rc->hc_handles);
 384   GNUNET_assert (RC_PEERS_SHUTDOWN == rc->state);
 385   GNUNET_assert (NULL == rc->dll_op_head);
 386   if (NULL != rc->c)
 387     GNUNET_TESTBED_controller_disconnect (rc->c);
 388   if (NULL != rc->cproc)
 389     GNUNET_TESTBED_controller_stop (rc->cproc);
 390   if (NULL != rc->h)
 391     GNUNET_TESTBED_host_destroy (rc->h);
 392   for (hid = 0; hid < rc->num_hosts; hid++)
 393     GNUNET_TESTBED_host_destroy (rc->hosts[hid]);
 394   GNUNET_free_non_null (rc->hosts);
 395   if (NULL != rc->cfg)
 396     GNUNET_CONFIGURATION_destroy (rc->cfg);
 397   GNUNET_free_non_null (rc->topo_file);
 398   GNUNET_free_non_null (rc->trusted_ip);
 399   GNUNET_free (rc);
 400 }
 401
 402
 403 /**
 404  * Stops the testbed run and releases any used resources
 405  *
 406  * @param cls the tesbed run handle
 407  * @param tc the task context from scheduler
 408  */
 409 static void
 410 shutdown_run (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
 411
 412
 413 /**
 414  * Function to shutdown now
 415  *
 416  * @param rc the RunContext
 417  */
 418 static void
 419 shutdown_now (struct RunContext *rc)
 420 {
 421   if (GNUNET_YES == rc->shutdown)
 422     return;
 423   if (GNUNET_SCHEDULER_NO_TASK != rc->shutdown_run_task)
 424     GNUNET_SCHEDULER_cancel (rc->shutdown_run_task);
 425   rc->shutdown_run_task = GNUNET_SCHEDULER_add_now (&shutdown_run, rc);
 426 }
 427
 428
 429 /**
 430  * Stops the testbed run and releases any used resources
 431  *
 432  * @param cls the tesbed run handle
 433  * @param tc the task context from scheduler
 434  */
 435 static void
 436 shutdown_run (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 437 {
 438   struct RunContext *rc = cls;
 439   struct DLLOperation *dll_op;
 440   unsigned int nhost;
 441
 442   GNUNET_assert (GNUNET_SCHEDULER_NO_TASK != rc->shutdown_run_task);
 443   rc->shutdown_run_task = GNUNET_SCHEDULER_NO_TASK;
 444   GNUNET_assert (GNUNET_NO == rc->shutdown);
 445   rc->shutdown = GNUNET_YES;
 446   if (NULL != rc->hc_handles)
 447   {
 448     for (nhost = 0; nhost < rc->num_hosts; nhost++)
 449       if (NULL != rc->hc_handles[nhost])
 450         GNUNET_TESTBED_is_host_habitable_cancel (rc->hc_handles[nhost]);
 451     GNUNET_free (rc->hc_handles);
 452     rc->hc_handles = NULL;
 453   }
 454   /* Stop register hosts task if it is running */
 455   if (GNUNET_SCHEDULER_NO_TASK != rc->register_hosts_task)
 456   {
 457     GNUNET_SCHEDULER_cancel (rc->register_hosts_task);
 458     rc->register_hosts_task = GNUNET_SCHEDULER_NO_TASK;
 459   }
 460   if (NULL != rc->reg_handle)
 461   {
 462     GNUNET_TESTBED_cancel_registration (rc->reg_handle);
 463     rc->reg_handle = NULL;
 464   }
 465   /* cancel any exiting operations */
 466   if (NULL != rc->dll_op_head)
 467   {
 468     while (NULL != (dll_op = rc->dll_op_head))
 469     {
 470       GNUNET_TESTBED_operation_done (dll_op->op);
 471       GNUNET_CONTAINER_DLL_remove (rc->dll_op_head, rc->dll_op_tail, dll_op);
 472       GNUNET_free (dll_op);
 473     }
 474   }
 475   if (NULL != rc->c)
 476   {
 477     if (NULL != rc->peers)
 478     {
 479       if (NULL != rc->topology_operation)
 480       {
 481         GNUNET_TESTBED_operation_done (rc->topology_operation);
 482         rc->topology_operation = NULL;
 483       }
 484       if (RC_INIT == rc->state)
 485         rc->state = RC_READY;   /* Even though we haven't called the master callback */
 486       dll_op = GNUNET_malloc (sizeof (struct DLLOperation));
 487       dll_op->op = GNUNET_TESTBED_shutdown_peers (rc->c, dll_op, NULL, NULL);
 488       DEBUG ("Shutting down peers\n");
 489       rc->pstart_time = GNUNET_TIME_absolute_get ();
 490       GNUNET_CONTAINER_DLL_insert_tail (rc->dll_op_head, rc->dll_op_tail,
 491                                         dll_op);
 492       return;
 493     }
 494   }
 495   rc->state = RC_PEERS_SHUTDOWN;       /* No peers are present so we consider the
 496                                         * state where all peers are SHUTDOWN  */
 497   GNUNET_SCHEDULER_add_now (&cleanup_task, rc);
 498 }
 499
 500
 501 /**
 502  * Task to call master task
 503  *
 504  * @param cls the run context
 505  * @param tc the task context
 506  */
 507 static void
 508 call_master (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 509 {
 510   struct RunContext *rc = cls;
 511
 512   if (NULL != rc->topology_operation)
 513   {
 514     DEBUG ("Overlay topology generated in %s\n", prof_time (rc));
 515     GNUNET_TESTBED_operation_done (rc->topology_operation);
 516     rc->topology_operation = NULL;
 517   }
 518   if (NULL != rc->test_master)
 519     rc->test_master (rc->test_master_cls, rc->num_peers, rc->peers);
 520 }
 521
 522
 523 /**
 524  * Callbacks of this type are called when topology configuration is completed
 525  *
 526  * @param cls the operation closure given to
 527  *          GNUNET_TESTBED_overlay_configure_topology_va() and
 528  *          GNUNET_TESTBED_overlay_configure() calls
 529  * @param nsuccess the number of successful overlay connects
 530  * @param nfailures the number of overlay connects which failed
 531  */
 532 static void
 533 topology_completion_callback (void *cls, unsigned int nsuccess,
 534                               unsigned int nfailures)
 535 {
 536   struct RunContext *rc = cls;
 537
 538   rc->state = RC_READY;
 539   GNUNET_SCHEDULER_add_continuation (&call_master, rc,
 540                                      GNUNET_SCHEDULER_REASON_PREREQ_DONE);
 541 }
 542
 543
 544 /**
 545  * Function to create peers
 546  *
 547  * @param rc the RunContext
 548  */
 549 static void
 550 create_peers (struct RunContext *rc)
 551 {
 552   struct DLLOperation *dll_op;
 553   unsigned int peer;
 554
 555   DEBUG ("Creating peers\n");
 556   rc->pstart_time = GNUNET_TIME_absolute_get ();
 557   rc->peers =
 558       GNUNET_malloc (sizeof (struct GNUNET_TESTBED_Peer *) * rc->num_peers);
 559   GNUNET_assert (NULL != rc->c);
 560   rc->peer_count = 0;
 561   for (peer = 0; peer < rc->num_peers; peer++)
 562   {
 563     dll_op = GNUNET_malloc (sizeof (struct DLLOperation));
 564     dll_op->rc = rc;
 565     dll_op->op =
 566         GNUNET_TESTBED_peer_create (rc->c,
 567                                     (0 ==
 568                                      rc->num_hosts) ? rc->h : rc->hosts[peer %
 569                                                                         rc->num_hosts],
 570                                     rc->cfg, peer_create_cb, dll_op);
 571     GNUNET_CONTAINER_DLL_insert_tail (rc->dll_op_head, rc->dll_op_tail, dll_op);
 572   }
 573 }
 574
 575
 576 /**
 577  * Signature of the event handler function called by the
 578  * respective event controller.
 579  *
 580  * @param cls closure
 581  * @param event information about the event
 582  */
 583 static void
 584 event_cb (void *cls, const struct GNUNET_TESTBED_EventInformation *event)
 585 {
 586   struct RunContext *rc = cls;
 587   struct DLLOperation *dll_op;
 588
 589   if (RC_INIT == rc->state)
 590   {
 591     switch (event->type)
 592     {
 593     case GNUNET_TESTBED_ET_OPERATION_FINISHED:
 594       dll_op = event->details.operation_finished.op_cls;
 595       if (NULL != event->details.operation_finished.emsg)
 596       {
 597         LOG (GNUNET_ERROR_TYPE_ERROR, _("Linking controllers failed. Exiting"));
 598         shutdown_now (rc);
 599       }
 600       else
 601         rc->reg_hosts++;
 602       GNUNET_assert (event->details.operation_finished.operation == dll_op->op);
 603       GNUNET_CONTAINER_DLL_remove (rc->dll_op_head, rc->dll_op_tail, dll_op);
 604       GNUNET_TESTBED_operation_done (dll_op->op);
 605       GNUNET_free (dll_op);
 606       if (rc->reg_hosts == rc->num_hosts)
 607       {
 608         rc->state = RC_LINKED;
 609         create_peers (rc);
 610       }
 611       return;
 612     default:
 613       GNUNET_break (0);
 614       shutdown_now (rc);
 615       return;
 616     }
 617   }
 618   for (dll_op = rc->dll_op_head; NULL != dll_op; dll_op = dll_op->next)
 619   {
 620     if ((GNUNET_TESTBED_ET_OPERATION_FINISHED == event->type) &&
 621         (event->details.operation_finished.operation == dll_op->op))
 622       break;
 623   }
 624   if (NULL == dll_op)
 625     goto call_cc;
 626   GNUNET_CONTAINER_DLL_remove (rc->dll_op_head, rc->dll_op_tail, dll_op);
 627   GNUNET_TESTBED_operation_done (dll_op->op);
 628   GNUNET_free (dll_op);
 629   switch (rc->state)
 630   {
 631   case RC_LINKED:
 632   case RC_PEERS_CREATED:
 633   case RC_READY:
 634     rc->state = RC_PEERS_SHUTDOWN;
 635     GNUNET_free (rc->peers);
 636     rc->peers = NULL;
 637     DEBUG ("Peers shut down in %s\n", prof_time (rc));
 638     GNUNET_SCHEDULER_add_now (&cleanup_task, rc);
 639     break;
 640   default:
 641     GNUNET_assert (0);
 642   }
 643   return;
 644
 645 call_cc:
 646   if ((0 != (rc->event_mask & (1LL << event->type))) && (NULL != rc->cc))
 647     rc->cc (rc->cc_cls, event);
 648   if (GNUNET_TESTBED_ET_PEER_START != event->type)
 649     return;
 650   for (dll_op = rc->dll_op_head; NULL != dll_op; dll_op = dll_op->next)
 651     if ((NULL != dll_op->cls) &&
 652         (event->details.peer_start.peer == dll_op->cls))
 653       break;
 654   if (NULL == dll_op)           /* Not our operation */
 655     return;
 656   GNUNET_CONTAINER_DLL_remove (rc->dll_op_head, rc->dll_op_tail, dll_op);
 657   GNUNET_TESTBED_operation_done (dll_op->op);
 658   GNUNET_free (dll_op);
 659   rc->peer_count++;
 660   if (rc->peer_count < rc->num_peers)
 661     return;
 662   DEBUG ("%u peers started in %s\n", rc->num_peers, prof_time (rc));
 663   if (GNUNET_TESTBED_TOPOLOGY_NONE != rc->topology)
 664   {
 665     if ((GNUNET_TESTBED_TOPOLOGY_ERDOS_RENYI == rc->topology) ||
 666         (GNUNET_TESTBED_TOPOLOGY_SMALL_WORLD_RING == rc->topology) ||
 667         (GNUNET_TESTBED_TOPOLOGY_SMALL_WORLD == rc->topology))
 668     {
 669       rc->topology_operation =
 670           GNUNET_TESTBED_overlay_configure_topology (NULL, rc->num_peers,
 671                                                      rc->peers, &rc->num_oc,
 672                                                      &topology_completion_callback,
 673                                                      rc,
 674                                                      rc->topology,
 675                                                      rc->random_links,
 676                                                      GNUNET_TESTBED_TOPOLOGY_OPTION_END);
 677     }
 678     else if (GNUNET_TESTBED_TOPOLOGY_FROM_FILE == rc->topology)
 679     {
 680       GNUNET_assert (NULL != rc->topo_file);
 681       rc->topology_operation =
 682           GNUNET_TESTBED_overlay_configure_topology (NULL, rc->num_peers,
 683                                                      rc->peers, &rc->num_oc,
 684                                                      &topology_completion_callback,
 685                                                      rc,
 686                                                      rc->topology,
 687                                                      rc->topo_file,
 688                                                      GNUNET_TESTBED_TOPOLOGY_OPTION_END);
 689     }
 690     else
 691       rc->topology_operation =
 692           GNUNET_TESTBED_overlay_configure_topology (NULL, rc->num_peers,
 693                                                      rc->peers, &rc->num_oc,
 694                                                      &topology_completion_callback,
 695                                                      rc,
 696                                                      rc->topology,
 697                                                      GNUNET_TESTBED_TOPOLOGY_OPTION_END);
 698     if (NULL == rc->topology_operation)
 699       LOG (GNUNET_ERROR_TYPE_WARNING,
 700            "Not generating topology. Check number of peers\n");
 701     else
 702     {
 703       DEBUG ("Creating overlay topology\n");
 704       rc->pstart_time = GNUNET_TIME_absolute_get ();
 705       return;
 706     }
 707   }
 708   rc->state = RC_READY;
 709   GNUNET_SCHEDULER_add_continuation (&call_master, rc,
 710                                      GNUNET_SCHEDULER_REASON_PREREQ_DONE);
 711 }
 712
 713
 714 /**
 715  * Task to register all hosts available in the global host list
 716  *
 717  * @param cls the RunContext
 718  * @param tc the scheduler task context
 719  */
 720 static void
 721 register_hosts (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
 722
 723
 724 /**
 725  * Callback which will be called to after a host registration succeeded or failed
 726  *
 727  * @param cls the closure
 728  * @param emsg the error message; NULL if host registration is successful
 729  */
 730 static void
 731 host_registration_completion (void *cls, const char *emsg)
 732 {
 733   struct RunContext *rc = cls;
 734
 735   rc->reg_handle = NULL;
 736   if (NULL != emsg)
 737   {
 738     LOG (GNUNET_ERROR_TYPE_WARNING,
 739          _("Host registration failed for a host. Error: %s\n"), emsg);
 740     shutdown_now (rc);
 741     return;
 742   }
 743   rc->register_hosts_task = GNUNET_SCHEDULER_add_now (&register_hosts, rc);
 744 }
 745
 746
 747 /**
 748  * Task to register all hosts available in the global host list
 749  *
 750  * @param cls RunContext
 751  * @param tc the scheduler task context
 752  */
 753 static void
 754 register_hosts (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 755 {
 756   struct RunContext *rc = cls;
 757   struct DLLOperation *dll_op;
 758   unsigned int slave;
 759
 760   rc->register_hosts_task = GNUNET_SCHEDULER_NO_TASK;
 761   if (rc->reg_hosts == rc->num_hosts)
 762   {
 763     DEBUG ("All hosts successfully registered\n");
 764     /* Start slaves */
 765     for (slave = 0; slave < rc->num_hosts; slave++)
 766     {
 767       dll_op = GNUNET_malloc (sizeof (struct DLLOperation));
 768       dll_op->rc = rc;
 769       dll_op->op =
 770           GNUNET_TESTBED_controller_link (dll_op, rc->c, rc->hosts[slave],
 771                                           rc->h, rc->cfg, GNUNET_YES);
 772       GNUNET_CONTAINER_DLL_insert_tail (rc->dll_op_head, rc->dll_op_tail,
 773                                         dll_op);
 774     }
 775     rc->reg_hosts = 0;
 776     return;
 777   }
 778   rc->reg_handle =
 779       GNUNET_TESTBED_register_host (rc->c, rc->hosts[rc->reg_hosts],
 780                                     host_registration_completion, rc);
 781   rc->reg_hosts++;
 782 }
 783
 784
 785 /**
 786  * Callback to signal successfull startup of the controller process
 787  *
 788  * @param cls the closure from GNUNET_TESTBED_controller_start()
 789  * @param cfg the configuration with which the controller has been started;
 790  *          NULL if status is not GNUNET_OK
 791  * @param status GNUNET_OK if the startup is successfull; GNUNET_SYSERR if not,
 792  *          GNUNET_TESTBED_controller_stop() shouldn't be called in this case
 793  */
 794 static void
 795 controller_status_cb (void *cls, const struct GNUNET_CONFIGURATION_Handle *cfg,
 796                       int status)
 797 {
 798   struct RunContext *rc = cls;
 799   uint64_t event_mask;
 800
 801   if (status != GNUNET_OK)
 802   {
 803     switch (rc->state)
 804     {
 805     case RC_INIT:
 806       GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "Testbed startup failed\n");
 807       return;
 808     default:
 809       GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 810                   "Controller crash detected. Shutting down.\n");
 811       rc->cproc = NULL;
 812       shutdown_now (rc);
 813       return;
 814     }
 815   }
 816   GNUNET_CONFIGURATION_destroy (rc->cfg);
 817   rc->cfg = GNUNET_CONFIGURATION_dup (cfg);
 818   event_mask = rc->event_mask;
 819   event_mask |= (1LL << GNUNET_TESTBED_ET_OPERATION_FINISHED);
 820   event_mask |= (1LL << GNUNET_TESTBED_ET_PEER_START);
 821   if (rc->topology < GNUNET_TESTBED_TOPOLOGY_NONE)
 822     event_mask |= GNUNET_TESTBED_ET_CONNECT;
 823   rc->c =
 824       GNUNET_TESTBED_controller_connect (rc->cfg, rc->h, event_mask, &event_cb,
 825                                          rc);
 826   if (0 < rc->num_hosts)
 827   {
 828     rc->reg_hosts = 0;
 829     rc->register_hosts_task = GNUNET_SCHEDULER_add_now (&register_hosts, rc);
 830     return;
 831   }
 832   rc->state = RC_LINKED;
 833   create_peers (rc);
 834 }
 835
 836
 837 /**
 838  * Callback function invoked for each interface found.
 839  *
 840  * @param cls closure
 841  * @param name name of the interface (can be NULL for unknown)
 842  * @param isDefault is this presumably the default interface
 843  * @param addr address of this interface (can be NULL for unknown or unassigned)
 844  * @param broadcast_addr the broadcast address (can be NULL for unknown or unassigned)
 845  * @param netmask the network mask (can be NULL for unknown or unassigned))
 846  * @param addrlen length of the address
 847  * @return GNUNET_OK to continue iteration, GNUNET_SYSERR to abort
 848  */
 849 static int
 850 netint_proc (void *cls, const char *name, int isDefault,
 851              const struct sockaddr *addr, const struct sockaddr *broadcast_addr,
 852              const struct sockaddr *netmask, socklen_t addrlen)
 853 {
 854   struct RunContext *rc = cls;
 855   char hostip[NI_MAXHOST];
 856   char *buf;
 857
 858   if (sizeof (struct sockaddr_in) != addrlen)
 859     return GNUNET_OK;           /* Only consider IPv4 for now */
 860   if (0 !=
 861       getnameinfo (addr, addrlen, hostip, NI_MAXHOST, NULL, 0, NI_NUMERICHOST))
 862     GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "getnameinfo");
 863   if (NULL == rc->trusted_ip)
 864   {
 865     rc->trusted_ip = GNUNET_strdup (hostip);
 866     return GNUNET_YES;
 867   }
 868   (void) GNUNET_asprintf (&buf, "%s; %s", rc->trusted_ip, hostip);
 869   GNUNET_free (rc->trusted_ip);
 870   rc->trusted_ip = buf;
 871   return GNUNET_YES;
 872 }
 873
 874
 875 /**
 876  * Callbacks of this type are called by GNUNET_TESTBED_is_host_habitable to
 877  * inform whether the given host is habitable or not. The Handle returned by
 878  * GNUNET_TESTBED_is_host_habitable() is invalid after this callback is called
 879  *
 880  * @param cls NULL
 881  * @param host the host whose status is being reported; will be NULL if the host
 882  *          given to GNUNET_TESTBED_is_host_habitable() is NULL
 883  * @param status GNUNET_YES if it is habitable; GNUNET_NO if not
 884  */
 885 static void
 886 host_habitable_cb (void *cls, const struct GNUNET_TESTBED_Host *host,
 887                    int status)
 888 {
 889   struct RunContext *rc = cls;
 890   struct GNUNET_TESTBED_Host **old_hosts;
 891   unsigned int nhost;
 892
 893   for (nhost = 0; nhost < rc->num_hosts; nhost++)
 894   {
 895     if (host == rc->hosts[nhost])
 896       break;
 897   }
 898   GNUNET_assert (nhost != rc->num_hosts);
 899   rc->hc_handles[nhost] = NULL;
 900   if (GNUNET_NO == status)
 901   {
 902     if ((NULL != host) && (NULL != GNUNET_TESTBED_host_get_hostname (host)))
 903       LOG (GNUNET_ERROR_TYPE_ERROR, _("Host %s cannot start testbed\n"),
 904            GNUNET_TESTBED_host_get_hostname (host));
 905     else
 906       LOG (GNUNET_ERROR_TYPE_ERROR,
 907            _("Testbed cannot be started on localhost\n"));
 908     shutdown_now (rc);
 909     return;
 910   }
 911   rc->reg_hosts++;
 912   if (rc->reg_hosts < rc->num_hosts)
 913     return;
 914   GNUNET_free (rc->hc_handles);
 915   rc->hc_handles = NULL;
 916   rc->h = rc->hosts[0];
 917   rc->num_hosts--;
 918   if (0 < rc->num_hosts)
 919   {
 920     old_hosts = rc->hosts;
 921     rc->hosts =
 922         GNUNET_malloc (sizeof (struct GNUNET_TESTBED_Host *) * rc->num_hosts);
 923     memcpy (rc->hosts, &old_hosts[1],
 924             (sizeof (struct GNUNET_TESTBED_Host *) * rc->num_hosts));
 925     GNUNET_free (old_hosts);
 926   }
 927   else
 928   {
 929     GNUNET_free (rc->hosts);
 930     rc->hosts = NULL;
 931   }
 932   GNUNET_OS_network_interfaces_list (netint_proc, rc);
 933   if (NULL == rc->trusted_ip)
 934     rc->trusted_ip = GNUNET_strdup ("127.0.0.1");
 935   rc->cproc =
 936       GNUNET_TESTBED_controller_start (rc->trusted_ip, rc->h, rc->cfg,
 937                                        &controller_status_cb, rc);
 938   GNUNET_free (rc->trusted_ip);
 939   rc->trusted_ip = NULL;
 940   if (NULL == rc->cproc)
 941   {
 942     LOG (GNUNET_ERROR_TYPE_ERROR, _("Cannot start the master controller"));
 943     shutdown_now (rc);
 944   }
 945 }
 946
 947
 948 /**
 949  * Convenience method for running a testbed with
 950  * a single call.  Underlay and overlay topology
 951  * are configured using the "UNDERLAY" and "OVERLAY"
 952  * options in the "[testbed]" section of the configuration\
 953  * (with possible options given in "UNDERLAY_XXX" and/or
 954  * "OVERLAY_XXX").
 955  *
 956  * The testbed is to be terminated using a call to
 957  * "GNUNET_SCHEDULER_shutdown".
 958  *
 959  * @param host_filename name of the file with the 'hosts', NULL
 960  *        to run everything on 'localhost'
 961  * @param cfg configuration to use (for testbed, controller and peers)
 962  * @param num_peers number of peers to start; FIXME: maybe put that ALSO into cfg?
 963  * @param event_mask bit mask with set of events to call 'cc' for;
 964  *                   or-ed values of "1LL" shifted by the
 965  *                   respective 'enum GNUNET_TESTBED_EventType'
 966  *                   (i.e.  "(1LL << GNUNET_TESTBED_ET_CONNECT) || ...")
 967  * @param cc controller callback to invoke on events; This callback is called
 968  *          for all peer start events even if GNUNET_TESTBED_ET_PEER_START isn't
 969  *          set in the event_mask as this is the only way get access to the
 970  *          handle of each peer
 971  * @param cc_cls closure for cc
 972  * @param test_master this callback will be called once the test is ready
 973  * @param test_master_cls closure for 'test_master'.
 974  */
 975 void
 976 GNUNET_TESTBED_run (const char *host_filename,
 977                     const struct GNUNET_CONFIGURATION_Handle *cfg,
 978                     unsigned int num_peers, uint64_t event_mask,
 979                     GNUNET_TESTBED_ControllerCallback cc, void *cc_cls,
 980                     GNUNET_TESTBED_TestMaster test_master,
 981                     void *test_master_cls)
 982 {
 983   struct RunContext *rc;
 984   char *topology;
 985   unsigned long long random_links;
 986   unsigned int hid;
 987   unsigned int nhost;
 988
 989   GNUNET_assert (num_peers > 0);
 990   rc = GNUNET_malloc (sizeof (struct RunContext));
 991   rc->cfg = GNUNET_CONFIGURATION_dup (cfg);
 992 #if ENABLE_LL
 993   rc->num_hosts = GNUNET_TESTBED_hosts_load_from_loadleveler (rc->cfg,
 994                                                               &rc->hosts);
 995   if (0 == rc->num_hosts)
 996   {
 997     LOG (GNUNET_ERROR_TYPE_WARNING,
 998            _("No hosts loaded from LoadLeveler. Need at least one host\n"));
 999     goto error_cleanup;
1000   }
1001 #else
1002   if (NULL != host_filename)
1003   {
1004     rc->num_hosts =
1005         GNUNET_TESTBED_hosts_load_from_file (host_filename, rc->cfg,
1006                                              &rc->hosts);
1007     if (0 == rc->num_hosts)
1008     {
1009       LOG (GNUNET_ERROR_TYPE_WARNING,
1010            _("No hosts loaded. Need at least one host\n"));
1011       goto error_cleanup;
1012     }
1013   }
1014   else
1015     rc->h = GNUNET_TESTBED_host_create (NULL, NULL, rc->cfg, 0);
1016 #endif
1017   rc->num_peers = num_peers;
1018   rc->event_mask = event_mask;
1019   rc->cc = cc;
1020   rc->cc_cls = cc_cls;
1021   rc->test_master = test_master;
1022   rc->test_master_cls = test_master_cls;
1023   rc->state = RC_INIT;
1024   rc->topology = GNUNET_TESTBED_TOPOLOGY_NONE;
1025   if (GNUNET_OK ==
1026       GNUNET_CONFIGURATION_get_value_string (rc->cfg, "testbed",
1027                                              "OVERLAY_TOPOLOGY", &topology))
1028   {
1029     if (GNUNET_NO == GNUNET_TESTBED_topology_get_ (&rc->topology, topology))
1030     {
1031       GNUNET_log_config_invalid (GNUNET_ERROR_TYPE_ERROR, "testbed",
1032                                  "OVERLAY_TOPLOGY",
1033                                  _
1034                                  ("Specified topology must be supported by testbed"));
1035     }
1036     GNUNET_free (topology);
1037   }
1038   switch (rc->topology)
1039   {
1040   case GNUNET_TESTBED_TOPOLOGY_ERDOS_RENYI:
1041   case GNUNET_TESTBED_TOPOLOGY_SMALL_WORLD_RING:
1042   case GNUNET_TESTBED_TOPOLOGY_SMALL_WORLD:
1043     if (GNUNET_OK !=
1044         GNUNET_CONFIGURATION_get_value_number (rc->cfg, "testbed",
1045                                                "OVERLAY_RANDOM_LINKS",
1046                                                &random_links))
1047     {
1048       /* OVERLAY option RANDOM & SMALL_WORLD_RING requires OVERLAY_RANDOM_LINKS
1049        * option to be set to the number of random links to be established  */
1050       GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR, "testbed",
1051                                  "OVERLAY_RANDOM_LINKS");
1052       goto error_cleanup;
1053     }
1054     if (random_links > UINT32_MAX)
1055     {
1056       GNUNET_break (0);         /* Too big number */
1057       goto error_cleanup;
1058     }
1059     rc->random_links = (unsigned int) random_links;
1060     break;
1061   case GNUNET_TESTBED_TOPOLOGY_FROM_FILE:
1062     if (GNUNET_OK !=
1063         GNUNET_CONFIGURATION_get_value_string (rc->cfg, "testbed",
1064                                                "OVERLAY_TOPOLOGY_FILE",
1065                                                &rc->topo_file))
1066     {
1067       GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR, "testbed",
1068                                  "OVERLAY_TOPOLOGY_FILE");
1069       goto error_cleanup;
1070     }
1071   default:
1072     /* Warn if OVERLAY_RANDOM_LINKS is present that it will be ignored */
1073     if (GNUNET_YES ==
1074         GNUNET_CONFIGURATION_have_value (rc->cfg, "testbed",
1075                                          "OVERLAY_RANDOM_LINKS"))
1076       LOG (GNUNET_ERROR_TYPE_WARNING,
1077            "Ignoring value of `OVERLAY_RANDOM_LINKS' in given configuration\n");
1078     break;
1079   }
1080   if (0 != rc->num_hosts)
1081   {
1082     rc->hc_handles =
1083         GNUNET_malloc (sizeof (struct GNUNET_TESTBED_HostHabitableCheckHandle *)
1084                        * rc->num_hosts);
1085     for (nhost = 0; nhost < rc->num_hosts; nhost++)
1086     {
1087       if (NULL ==
1088           (rc->hc_handles[nhost] =
1089            GNUNET_TESTBED_is_host_habitable (rc->hosts[nhost], rc->cfg,
1090                                              &host_habitable_cb, rc)))
1091       {
1092         GNUNET_break (0);
1093         for (nhost = 0; nhost < rc->num_hosts; nhost++)
1094           if (NULL != rc->hc_handles[nhost])
1095             GNUNET_TESTBED_is_host_habitable_cancel (rc->hc_handles[nhost]);
1096         GNUNET_free (rc->hc_handles);
1097         rc->hc_handles = NULL;
1098         goto error_cleanup;
1099       }
1100     }
1101   }
1102   else
1103     rc->cproc =
1104         GNUNET_TESTBED_controller_start ("127.0.0.1", rc->h, rc->cfg,
1105                                          &controller_status_cb, rc);
1106   rc->shutdown_run_task =
1107       GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL, &shutdown_run,
1108                                     rc);
1109   return;
1110
1111 error_cleanup:
1112   if (NULL != rc->h)
1113     GNUNET_TESTBED_host_destroy (rc->h);
1114   if (NULL != rc->hosts)
1115   {
1116     for (hid = 0; hid < rc->num_hosts; hid++)
1117       if (NULL != rc->hosts[hid])
1118         GNUNET_TESTBED_host_destroy (rc->hosts[hid]);
1119     GNUNET_free (rc->hosts);
1120   }
1121   if (NULL != rc->cfg)
1122     GNUNET_CONFIGURATION_destroy (rc->cfg);
1123   GNUNET_free (rc);
1124 }
1125
1126
1127 /* end of testbed_api_testbed.c */