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