src/testbed/testbed_api_hosts.c

   1 /*
   2       This file is part of GNUnet
   3       (C) 2008--2013 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_hosts.c
  23  * @brief API for manipulating 'hosts' controlled by the GNUnet testing service;
  24  *        allows parsing hosts files, starting, stopping and communicating (via
  25  *        SSH/stdin/stdout) with the remote (or local) processes
  26  * @author Christian Grothoff
  27  */
  28 #include "platform.h"
  29 #include "gnunet_util_lib.h"
  30 #include "gnunet_testbed_service.h"
  31 #include "gnunet_core_service.h"
  32 #include "gnunet_transport_service.h"
  33
  34 #include "testbed_api.h"
  35 #include "testbed_api_hosts.h"
  36 #include "testbed_helper.h"
  37 #include "testbed_api_operations.h"
  38 #include "testbed_api_sd.h"
  39
  40 #include <zlib.h>
  41
  42 /**
  43  * Generic logging shorthand
  44  */
  45 #define LOG(kind, ...)                          \
  46   GNUNET_log_from (kind, "testbed-api-hosts", __VA_ARGS__);
  47
  48 /**
  49  * Debug logging shorthand
  50  */
  51 #define LOG_DEBUG(...)                          \
  52   LOG (GNUNET_ERROR_TYPE_DEBUG, __VA_ARGS__);
  53
  54 /**
  55  * Prints API violation message
  56  */
  57 #define API_VIOLATION(cond,errstr)              \
  58   do {                                          \
  59     if (cond)                                   \
  60       break;                                    \
  61     LOG (GNUNET_ERROR_TYPE_ERROR, "API violation detected: %s\n", errstr); \
  62     GNUNET_assert (0);                                                  \
  63   } while (0)
  64
  65 /**
  66  * Log an error message at log-level 'level' that indicates a failure of the
  67  * command 'cmd' with the message given by gai_strerror(rc).
  68  */
  69 #define LOG_GAI(level, cmd, rc) do { LOG(level, _("`%s' failed at %s:%d with error: %s\n"), cmd, __FILE__, __LINE__, gai_strerror(rc)); } while(0)
  70
  71 /**
  72  * Number of extra elements we create space for when we grow host list
  73  */
  74 #define HOST_LIST_GROW_STEP 10
  75
  76
  77 /**
  78  * A list entry for registered controllers list
  79  */
  80 struct RegisteredController
  81 {
  82   /**
  83    * The controller at which this host is registered
  84    */
  85   const struct GNUNET_TESTBED_Controller *controller;
  86
  87   /**
  88    * The next ptr for DLL
  89    */
  90   struct RegisteredController *next;
  91
  92   /**
  93    * The prev ptr for DLL
  94    */
  95   struct RegisteredController *prev;
  96 };
  97
  98
  99 /**
 100  * A slot to record time taken by an overlay connect operation
 101  */
 102 struct TimeSlot
 103 {
 104   /**
 105    * A key to identify this timeslot
 106    */
 107   void *key;
 108
 109   /**
 110    * Time
 111    */
 112   struct GNUNET_TIME_Relative time;
 113
 114   /**
 115    * Number of timing values accumulated
 116    */
 117   unsigned int nvals;
 118 };
 119
 120
 121 /**
 122  * Opaque handle to a host running experiments managed by the testing framework.
 123  * The master process must be able to SSH to this host without password (via
 124  * ssh-agent).
 125  */
 126 struct GNUNET_TESTBED_Host
 127 {
 128
 129   /**
 130    * The hostname of the host; NULL for localhost
 131    */
 132   const char *hostname;
 133
 134   /**
 135    * The username to be used for SSH login
 136    */
 137   const char *username;
 138
 139   /**
 140    * the configuration to use as a template while starting a controller on this
 141    * host.  Operation queue size specific to a host are also read from this
 142    * configuration handle.  After starting the controller, it points to the actual
 143    * configuration with which the controller is running
 144    */
 145   struct GNUNET_CONFIGURATION_Handle *cfg;
 146
 147   /**
 148    * The head for the list of controllers where this host is registered
 149    */
 150   struct RegisteredController *rc_head;
 151
 152   /**
 153    * The tail for the list of controllers where this host is registered
 154    */
 155   struct RegisteredController *rc_tail;
 156
 157   /**
 158    * Operation queue for simultaneous overlay connect operations target at this
 159    * host
 160    */
 161   struct OperationQueue *opq_parallel_overlay_connect_operations;
 162
 163   /**
 164    * An array of timing slots; size should be equal to the current number of parallel
 165    * overlay connects
 166    */
 167   struct TimeSlot *tslots;
 168
 169   /**
 170    * Handle for SD calculations amount parallel overlay connect operation finish
 171    * times
 172    */
 173   struct SDHandle *poc_sd;
 174
 175   /**
 176    * The number of parallel overlay connects we do currently
 177    */
 178   unsigned int num_parallel_connects;
 179
 180   /**
 181    * Counter to indicate when all the available time slots are filled
 182    */
 183   unsigned int tslots_filled;
 184
 185   /**
 186    * Is a controller started on this host? FIXME: Is this needed?
 187    */
 188   int controller_started;
 189
 190   /**
 191    * Is this host locked by GNUNET_TESTBED_controller_start()?
 192    */
 193   int locked;
 194
 195   /**
 196    * Global ID we use to refer to a host on the network
 197    */
 198   uint32_t id;
 199
 200   /**
 201    * The port which is to be used for SSH
 202    */
 203   uint16_t port;
 204
 205 };
 206
 207
 208 /**
 209  * Array of available hosts
 210  */
 211 static struct GNUNET_TESTBED_Host **host_list;
 212
 213 /**
 214  * The size of the available hosts list
 215  */
 216 static unsigned int host_list_size;
 217
 218
 219 /**
 220  * Lookup a host by ID.
 221  *
 222  * @param id global host ID assigned to the host; 0 is
 223  *        reserved to always mean 'localhost'
 224  * @return handle to the host, NULL if host not found
 225  */
 226 struct GNUNET_TESTBED_Host *
 227 GNUNET_TESTBED_host_lookup_by_id_ (uint32_t id)
 228 {
 229   if (host_list_size <= id)
 230     return NULL;
 231   return host_list[id];
 232 }
 233
 234
 235 /**
 236  * Create a host by ID; given this host handle, we could not
 237  * run peers at the host, but we can talk about the host
 238  * internally.
 239  *
 240  * @param id global host ID assigned to the host; 0 is
 241  *        reserved to always mean 'localhost'
 242  * @param cfg the configuration to use as a template while starting a controller
 243  *          on this host.  Operation queue sizes specific to a host are also
 244  *          read from this configuration handle
 245  * @return handle to the host, NULL on error
 246  */
 247 struct GNUNET_TESTBED_Host *
 248 GNUNET_TESTBED_host_create_by_id_ (uint32_t id,
 249                                    const struct GNUNET_CONFIGURATION_Handle
 250                                    *cfg)
 251 {
 252   return GNUNET_TESTBED_host_create_with_id (id, NULL, NULL, cfg, 0);
 253 }
 254
 255
 256 /**
 257  * Obtain the host's unique global ID.
 258  *
 259  * @param host handle to the host, NULL means 'localhost'
 260  * @return id global host ID assigned to the host (0 is
 261  *         'localhost', but then obviously not globally unique)
 262  */
 263 uint32_t
 264 GNUNET_TESTBED_host_get_id_ (const struct GNUNET_TESTBED_Host * host)
 265 {
 266   return host->id;
 267 }
 268
 269
 270 /**
 271  * Obtain the host's hostname.
 272  *
 273  * @param host handle to the host, NULL means 'localhost'
 274  * @return hostname of the host
 275  */
 276 const char *
 277 GNUNET_TESTBED_host_get_hostname (const struct GNUNET_TESTBED_Host *host)
 278 {
 279   return host->hostname;
 280 }
 281
 282
 283 /**
 284  * Obtain the host's username
 285  *
 286  * @param host handle to the host, NULL means 'localhost'
 287  * @return username to login to the host
 288  */
 289 const char *
 290 GNUNET_TESTBED_host_get_username_ (const struct GNUNET_TESTBED_Host *host)
 291 {
 292   return host->username;
 293 }
 294
 295
 296 /**
 297  * Obtain the host's ssh port
 298  *
 299  * @param host handle to the host, NULL means 'localhost'
 300  * @return username to login to the host
 301  */
 302 uint16_t
 303 GNUNET_TESTBED_host_get_ssh_port_ (const struct GNUNET_TESTBED_Host * host)
 304 {
 305   return host->port;
 306 }
 307
 308
 309 /**
 310  * Check whether a controller is already started on the given host
 311  *
 312  * @param host the handle to the host
 313  * @return GNUNET_YES if the controller is already started; GNUNET_NO if not
 314  */
 315 int
 316 GNUNET_TESTBED_host_controller_started (const struct GNUNET_TESTBED_Host *host)
 317 {
 318   return host->controller_started;
 319 }
 320
 321
 322 /**
 323  * Obtain the host's configuration template
 324  *
 325  * @param host handle to the host
 326  * @return the host's configuration template
 327  */
 328 const struct GNUNET_CONFIGURATION_Handle *
 329 GNUNET_TESTBED_host_get_cfg_ (const struct GNUNET_TESTBED_Host *host)
 330 {
 331   return host->cfg;
 332 }
 333
 334
 335 /**
 336  * Function to replace host's configuration
 337  *
 338  * @param host the host handle
 339  * @param new_cfg the new configuration to replace the old one
 340  */
 341 void
 342 GNUNET_TESTBED_host_replace_cfg_ (struct GNUNET_TESTBED_Host *host,
 343                                   const struct GNUNET_CONFIGURATION_Handle *new_cfg)
 344 {
 345   GNUNET_CONFIGURATION_destroy (host->cfg);
 346   host->cfg = GNUNET_CONFIGURATION_dup (new_cfg);
 347 }
 348
 349
 350 /**
 351  * Create a host to run peers and controllers on.
 352  *
 353  * @param id global host ID assigned to the host; 0 is
 354  *        reserved to always mean 'localhost'
 355  * @param hostname name of the host, use "NULL" for localhost
 356  * @param username username to use for the login; may be NULL
 357  * @param cfg the configuration to use as a template while starting a controller
 358  *          on this host.  Operation queue sizes specific to a host are also
 359  *          read from this configuration handle
 360  * @param port port number to use for ssh; use 0 to let ssh decide
 361  * @return handle to the host, NULL on error
 362  */
 363 struct GNUNET_TESTBED_Host *
 364 GNUNET_TESTBED_host_create_with_id (uint32_t id, const char *hostname,
 365                                     const char *username,
 366                                     const struct GNUNET_CONFIGURATION_Handle
 367                                     *cfg,
 368                                     uint16_t port)
 369 {
 370   struct GNUNET_TESTBED_Host *host;
 371   unsigned int new_size;
 372
 373   if ((id < host_list_size) && (NULL != host_list[id]))
 374   {
 375     LOG (GNUNET_ERROR_TYPE_WARNING, "Host with id: %u already created\n", id);
 376     return NULL;
 377   }
 378   host = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_Host));
 379   host->hostname = (NULL != hostname) ? GNUNET_strdup (hostname) : NULL;
 380   host->username = (NULL != username) ? GNUNET_strdup (username) : NULL;
 381   host->id = id;
 382   host->port = (0 == port) ? 22 : port;
 383   host->cfg = GNUNET_CONFIGURATION_dup (cfg);
 384   host->opq_parallel_overlay_connect_operations =
 385       GNUNET_TESTBED_operation_queue_create_ (0);
 386   GNUNET_TESTBED_set_num_parallel_overlay_connects_ (host, 1);
 387   host->poc_sd = GNUNET_TESTBED_SD_init_ (10);
 388   new_size = host_list_size;
 389   while (id >= new_size)
 390     new_size += HOST_LIST_GROW_STEP;
 391   if (new_size != host_list_size)
 392     GNUNET_array_grow (host_list, host_list_size, new_size);
 393   GNUNET_assert (id < host_list_size);
 394   LOG (GNUNET_ERROR_TYPE_DEBUG, "Adding host with id: %u\n", host->id);
 395   host_list[id] = host;
 396   return host;
 397 }
 398
 399
 400 /**
 401  * Create a host to run peers and controllers on.
 402  *
 403  * @param hostname name of the host, use "NULL" for localhost
 404  * @param username username to use for the login; may be NULL
 405  * @param cfg the configuration to use as a template while starting a controller
 406  *          on this host.  Operation queue sizes specific to a host are also
 407  *          read from this configuration handle
 408  * @param port port number to use for ssh; use 0 to let ssh decide
 409  * @return handle to the host, NULL on error
 410  */
 411 struct GNUNET_TESTBED_Host *
 412 GNUNET_TESTBED_host_create (const char *hostname, const char *username,
 413                             const struct GNUNET_CONFIGURATION_Handle *cfg,
 414                             uint16_t port)
 415 {
 416   static uint32_t uid_generator;
 417
 418   if (NULL == hostname)
 419     return GNUNET_TESTBED_host_create_with_id (0, hostname, username,
 420                                                cfg, port);
 421   return GNUNET_TESTBED_host_create_with_id (++uid_generator, hostname,
 422                                              username, cfg, port);
 423 }
 424
 425
 426 /**
 427  * Load a set of hosts from a configuration file.
 428  *
 429  * @param filename file with the host specification
 430  * @param cfg the configuration to use as a template while starting a controller
 431  *          on any of the loaded hosts.  Operation queue sizes specific to a host
 432  *          are also read from this configuration handle
 433  * @param hosts set to the hosts found in the file; caller must free this if
 434  *          number of hosts returned is greater than 0
 435  * @return number of hosts returned in 'hosts', 0 on error
 436  */
 437 unsigned int
 438 GNUNET_TESTBED_hosts_load_from_file (const char *filename,
 439                                      const struct GNUNET_CONFIGURATION_Handle
 440                                      *cfg,
 441                                      struct GNUNET_TESTBED_Host ***hosts)
 442 {
 443   //struct GNUNET_TESTBED_Host **host_array;
 444   struct GNUNET_TESTBED_Host *starting_host;
 445   char *data;
 446   char *buf;
 447   char username[256];
 448   char hostname[256];
 449   uint64_t fs;
 450   short int port;
 451   int ret;
 452   unsigned int offset;
 453   unsigned int count;
 454
 455
 456   GNUNET_assert (NULL != filename);
 457   if (GNUNET_YES != GNUNET_DISK_file_test (filename))
 458   {
 459     LOG (GNUNET_ERROR_TYPE_WARNING, _("Hosts file %s not found\n"), filename);
 460     return 0;
 461   }
 462   if (GNUNET_OK !=
 463       GNUNET_DISK_file_size (filename, &fs, GNUNET_YES, GNUNET_YES))
 464     fs = 0;
 465   if (0 == fs)
 466   {
 467     LOG (GNUNET_ERROR_TYPE_WARNING, _("Hosts file %s has no data\n"), filename);
 468     return 0;
 469   }
 470   data = GNUNET_malloc (fs);
 471   if (fs != GNUNET_DISK_fn_read (filename, data, fs))
 472   {
 473     GNUNET_free (data);
 474     LOG (GNUNET_ERROR_TYPE_WARNING, _("Hosts file %s cannot be read\n"),
 475          filename);
 476     return 0;
 477   }
 478   buf = data;
 479   offset = 0;
 480   starting_host = NULL;
 481   count = 0;
 482   while (offset < (fs - 1))
 483   {
 484     offset++;
 485     if (((data[offset] == '\n')) && (buf != &data[offset]))
 486     {
 487       data[offset] = '\0';
 488       ret =
 489           SSCANF (buf, "%255[a-zA-Z0-9_]@%255[a-zA-Z0-9.]:%5hd", username,
 490                   hostname, &port);
 491       if (3 == ret)
 492       {
 493         GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 494                     "Successfully read host %s, port %d and user %s from file\n",
 495                     hostname, port, username);
 496         /* We store hosts in a static list; hence we only require the starting
 497          * host pointer in that list to access the newly created list of hosts */
 498         if (NULL == starting_host)
 499           starting_host = GNUNET_TESTBED_host_create (hostname, username, cfg,
 500                                                       port);
 501         else
 502           (void) GNUNET_TESTBED_host_create (hostname, username, cfg, port);
 503         count++;
 504       }
 505       else
 506         GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 507                     "Error reading line `%s' in hostfile\n", buf);
 508       buf = &data[offset + 1];
 509     }
 510     else if ((data[offset] == '\n') || (data[offset] == '\0'))
 511       buf = &data[offset + 1];
 512   }
 513   GNUNET_free (data);
 514   if (NULL == starting_host)
 515     return 0;
 516   *hosts = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_Host *) * count);
 517   memcpy (*hosts, &host_list[GNUNET_TESTBED_host_get_id_ (starting_host)],
 518           sizeof (struct GNUNET_TESTBED_Host *) * count);
 519   return count;
 520 }
 521
 522
 523 /**
 524  * Resolves a hostname using getaddrinfo
 525  *
 526  * @param host the hostname
 527  * @return the string representing the IPv4 address of the given host; NULL upon error
 528  */
 529 const char *
 530 simple_resolve (const char *host)
 531 {
 532   struct addrinfo *res;
 533   const struct sockaddr_in *in_addr;
 534   char *hostip;
 535   struct addrinfo hint;
 536   unsigned int rc;
 537
 538   hint.ai_family = AF_INET;     /* IPv4 */
 539   hint.ai_socktype = 0;
 540   hint.ai_protocol = 0;
 541   hint.ai_addrlen = 0;
 542   hint.ai_addr = NULL;
 543   hint.ai_canonname = NULL;
 544   hint.ai_next = NULL;
 545   hint.ai_flags = AI_NUMERICSERV;
 546   res = NULL;
 547   LOG_DEBUG ("Resolving [%s]\n", host);
 548   if (0 != (rc = getaddrinfo (host, "22", &hint, &res)))
 549   {
 550     LOG_GAI (GNUNET_ERROR_TYPE_ERROR, "getaddrinfo", rc);
 551     return NULL;
 552   }
 553   GNUNET_assert (NULL != res);
 554   GNUNET_assert (NULL != res->ai_addr);
 555   GNUNET_assert (sizeof (struct sockaddr_in) == res->ai_addrlen);
 556   in_addr = (const struct sockaddr_in *) res->ai_addr;
 557   hostip = inet_ntoa (in_addr->sin_addr);
 558   GNUNET_assert (NULL != hostip);
 559   LOG_DEBUG ("Resolved [%s] to [%s]\n", host, hostip);
 560   return hostip;
 561 }
 562
 563
 564 /**
 565  * Loads the set of host allocated by the LoadLeveler Job Scheduler.  This
 566  * function is only available when compiled with support for LoadLeveler and is
 567  * used for running on the SuperMUC
 568  *
 569  * @param cfg the configuration to use as a template while starting a controller
 570  *          on any of the loaded hosts.  Operation queue sizes specific to a host
 571  *          are also read from this configuration handle
 572  * @param hosts set to the hosts found in the file; caller must free this if
 573  *          number of hosts returned is greater than 0
 574  * @return number of hosts returned in 'hosts', 0 on error
 575  */
 576 unsigned int
 577 GNUNET_TESTBED_hosts_load_from_loadleveler (const struct
 578                                             GNUNET_CONFIGURATION_Handle *cfg,
 579                                             struct GNUNET_TESTBED_Host ***hosts)
 580 {
 581 #if !ENABLE_LL
 582   LOG (GNUNET_ERROR_TYPE_ERROR,
 583        _("The function %s is only available when compiled with (--with-ll)\n"),
 584        __func__);
 585   GNUNET_assert (0);
 586 #else
 587   const char *hostfile;
 588   char *buf;
 589   char *hostname;
 590   char **hostnames;
 591   char **hostaddrs;
 592   const char *hostip;
 593   struct GNUNET_TESTBED_Host **host_list;
 594   ssize_t rsize;
 595   uint64_t size;
 596   uint64_t offset;
 597   enum {
 598     SCAN,
 599     SKIP,
 600     TRIM,
 601     READHOST
 602   } pstep;
 603   unsigned int host;
 604   unsigned int nhosts;
 605   unsigned int nhostaddrs;
 606
 607   if (NULL == (hostfile = getenv ("MP_SAVEHOSTFILE")))
 608   {
 609     GNUNET_break (0);
 610     return 0;
 611   }
 612   if (GNUNET_SYSERR == GNUNET_DISK_file_size (hostfile, &size, GNUNET_YES,
 613                                               GNUNET_YES))
 614   {
 615     GNUNET_break (0);
 616     return 0;
 617   }
 618   if (0 == size)
 619   {
 620     GNUNET_break (0);
 621     return 0;
 622   }
 623   buf = GNUNET_malloc (size + 1);
 624   rsize = GNUNET_DISK_fn_read (hostfile, buf, (size_t) size);
 625   if ( (GNUNET_SYSERR == rsize) || ((ssize_t) size != rsize) )
 626   {
 627     GNUNET_free (buf);
 628     GNUNET_break (0);
 629     return 0;
 630   }
 631   size++;
 632   offset = 0;
 633   pstep = SCAN;
 634   hostname = NULL;
 635   hostnames = NULL;
 636   hostaddrs = NULL;
 637   nhosts = 0;
 638   nhostaddrs = 0;
 639   while (offset < size)
 640   {
 641     switch (pstep)
 642     {
 643     case SCAN:
 644       if ('!' == buf[offset])
 645         pstep = SKIP;
 646       else
 647         pstep = TRIM;
 648       break;
 649     case SKIP:
 650       if ('\n' == buf[offset])
 651         pstep = SCAN;
 652       break;
 653     case TRIM:
 654       if ('!' == buf[offset])
 655       {
 656         pstep = SKIP;
 657         break;
 658       }
 659       if ( (' ' == buf[offset])
 660            || ('\t' == buf[offset])
 661            || ('\r' == buf[offset]) )
 662         pstep = TRIM;
 663       else
 664       {
 665         pstep = READHOST;
 666         hostname = &buf[offset];
 667       }
 668       break;
 669     case READHOST:
 670       if (isspace (buf[offset]))
 671       {
 672         buf[offset] = '\0';
 673         for (host = 0; host < nhosts; host++)
 674           if (0 == strcmp (hostnames[host], hostname))
 675             break;
 676         if (host == nhosts)
 677         {
 678           LOG_DEBUG ("Adding host [%s]\n", hostname);
 679           hostname = GNUNET_strdup (hostname);
 680           GNUNET_array_append (hostnames, nhosts, hostname);
 681         }
 682         else
 683           LOG_DEBUG ("Not adding host [%s] as it is already included\n", hostname);
 684         hostname = NULL;
 685         pstep = SCAN;
 686       }
 687       break;
 688     }
 689     offset++;
 690   }
 691   GNUNET_free_non_null (buf);
 692   if (NULL == hostnames)
 693     return 0;
 694   for (host = 0; host < nhosts; host++)
 695   {
 696     hostip = simple_resolve (hostnames[host]);
 697     if (NULL == hostip)
 698     {
 699       nhosts = 0;
 700       goto cleanup;
 701     }
 702     GNUNET_array_append (hostaddrs, nhostaddrs, GNUNET_strdup (hostip));
 703   }
 704   GNUNET_assert (nhostaddrs == nhosts);
 705   if (NULL == hosts)
 706     goto cleanup;
 707   host_list = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_Host *) * nhostaddrs);
 708   for (host = 0; host < nhosts; host++)
 709     host_list[host] = GNUNET_TESTBED_host_create (hostaddrs[host], NULL, cfg, 0);
 710   *hosts = host_list;
 711
 712  cleanup:
 713   for (host = 0; host < nhosts; host++)
 714     GNUNET_free (hostnames[host]);
 715   GNUNET_free(hostnames);
 716   for (host = 0; (NULL != hostaddrs) && (host < nhostaddrs); host++)
 717     GNUNET_free (hostaddrs[host]);
 718   GNUNET_free (hostaddrs);
 719   return nhosts;
 720 #endif
 721 }
 722
 723
 724 /**
 725  * Destroy a host handle.  Must only be called once everything
 726  * running on that host has been stopped.
 727  *
 728  * @param host handle to destroy
 729  */
 730 void
 731 GNUNET_TESTBED_host_destroy (struct GNUNET_TESTBED_Host *host)
 732 {
 733   struct RegisteredController *rc;
 734   uint32_t id;
 735
 736   GNUNET_assert (host->id < host_list_size);
 737   GNUNET_assert (host_list[host->id] == host);
 738   host_list[host->id] = NULL;
 739   /* clear registered controllers list */
 740   for (rc = host->rc_head; NULL != rc; rc = host->rc_head)
 741   {
 742     GNUNET_CONTAINER_DLL_remove (host->rc_head, host->rc_tail, rc);
 743     GNUNET_free (rc);
 744   }
 745   GNUNET_free_non_null ((char *) host->username);
 746   GNUNET_free_non_null ((char *) host->hostname);
 747   GNUNET_TESTBED_operation_queue_destroy_
 748       (host->opq_parallel_overlay_connect_operations);
 749   GNUNET_TESTBED_SD_destroy_ (host->poc_sd);
 750   GNUNET_free_non_null (host->tslots);
 751   GNUNET_CONFIGURATION_destroy (host->cfg);
 752   GNUNET_free (host);
 753   while (host_list_size >= HOST_LIST_GROW_STEP)
 754   {
 755     for (id = host_list_size - 1; id > host_list_size - HOST_LIST_GROW_STEP;
 756          id--)
 757       if (NULL != host_list[id])
 758         break;
 759     if (id != host_list_size - HOST_LIST_GROW_STEP)
 760       break;
 761     if (NULL != host_list[id])
 762       break;
 763     host_list_size -= HOST_LIST_GROW_STEP;
 764   }
 765   host_list =
 766       GNUNET_realloc (host_list,
 767                       sizeof (struct GNUNET_TESTBED_Host *) * host_list_size);
 768 }
 769
 770
 771 /**
 772  * Marks a host as registered with a controller
 773  *
 774  * @param host the host to mark
 775  * @param controller the controller at which this host is registered
 776  */
 777 void
 778 GNUNET_TESTBED_mark_host_registered_at_ (struct GNUNET_TESTBED_Host *host,
 779                                          const struct GNUNET_TESTBED_Controller
 780                                          *const controller)
 781 {
 782   struct RegisteredController *rc;
 783
 784   for (rc = host->rc_head; NULL != rc; rc = rc->next)
 785   {
 786     if (controller == rc->controller)   /* already registered at controller */
 787     {
 788       GNUNET_break (0);
 789       return;
 790     }
 791   }
 792   rc = GNUNET_malloc (sizeof (struct RegisteredController));
 793   rc->controller = controller;
 794   GNUNET_CONTAINER_DLL_insert_tail (host->rc_head, host->rc_tail, rc);
 795 }
 796
 797
 798 /**
 799  * Unmarks a host registered at a controller
 800  *
 801  * @param host the host to unmark
 802  * @param controller the controller at which this host has to be unmarked
 803  */
 804 void
 805 GNUNET_TESTBED_deregister_host_at_ (struct GNUNET_TESTBED_Host *host,
 806                                     const struct GNUNET_TESTBED_Controller
 807                                     *const controller)
 808 {
 809   struct RegisteredController *rc;
 810
 811   for (rc = host->rc_head; NULL != rc; rc=rc->next)
 812     if (controller == rc->controller)
 813       break;
 814   if (NULL == rc)
 815   {
 816     GNUNET_break (0);
 817     return;
 818   }
 819   GNUNET_CONTAINER_DLL_remove (host->rc_head, host->rc_tail, rc);
 820   GNUNET_free (rc);
 821 }
 822
 823
 824 /**
 825  * Checks whether a host has been registered
 826  *
 827  * @param host the host to check
 828  * @param controller the controller at which host's registration is checked
 829  * @return GNUNET_YES if registered; GNUNET_NO if not
 830  */
 831 int
 832 GNUNET_TESTBED_is_host_registered_ (const struct GNUNET_TESTBED_Host *host,
 833                                     const struct GNUNET_TESTBED_Controller
 834                                     *const controller)
 835 {
 836   struct RegisteredController *rc;
 837
 838   for (rc = host->rc_head; NULL != rc; rc = rc->next)
 839   {
 840     if (controller == rc->controller)   /* already registered at controller */
 841     {
 842       return GNUNET_YES;
 843     }
 844   }
 845   return GNUNET_NO;
 846 }
 847
 848
 849 /**
 850  * Handle for controller process
 851  */
 852 struct GNUNET_TESTBED_ControllerProc
 853 {
 854   /**
 855    * The process handle
 856    */
 857   struct GNUNET_HELPER_Handle *helper;
 858
 859   /**
 860    * The arguments used to start the helper
 861    */
 862   char **helper_argv;
 863
 864   /**
 865    * The host where the helper is run
 866    */
 867   struct GNUNET_TESTBED_Host *host;
 868
 869   /**
 870    * The controller error callback
 871    */
 872   GNUNET_TESTBED_ControllerStatusCallback cb;
 873
 874   /**
 875    * The closure for the above callback
 876    */
 877   void *cls;
 878
 879   /**
 880    * The send handle for the helper
 881    */
 882   struct GNUNET_HELPER_SendHandle *shandle;
 883
 884   /**
 885    * The message corresponding to send handle
 886    */
 887   struct GNUNET_MessageHeader *msg;
 888
 889 };
 890
 891
 892 /**
 893  * Function to copy NULL terminated list of arguments
 894  *
 895  * @param argv the NULL terminated list of arguments. Cannot be NULL.
 896  * @return the copied NULL terminated arguments
 897  */
 898 static char **
 899 copy_argv (const char *const *argv)
 900 {
 901   char **argv_dup;
 902   unsigned int argp;
 903
 904   GNUNET_assert (NULL != argv);
 905   for (argp = 0; NULL != argv[argp]; argp++) ;
 906   argv_dup = GNUNET_malloc (sizeof (char *) * (argp + 1));
 907   for (argp = 0; NULL != argv[argp]; argp++)
 908     argv_dup[argp] = strdup (argv[argp]);
 909   return argv_dup;
 910 }
 911
 912
 913 /**
 914  * Function to join NULL terminated list of arguments
 915  *
 916  * @param argv1 the NULL terminated list of arguments. Cannot be NULL.
 917  * @param argv2 the NULL terminated list of arguments. Cannot be NULL.
 918  * @return the joined NULL terminated arguments
 919  */
 920 static char **
 921 join_argv (const char *const *argv1, const char *const *argv2)
 922 {
 923   char **argvj;
 924   char *argv;
 925   unsigned int carg;
 926   unsigned int cnt;
 927
 928   carg = 0;
 929   argvj = NULL;
 930   for (cnt = 0; NULL != argv1[cnt]; cnt++)
 931   {
 932     argv = GNUNET_strdup (argv1[cnt]);
 933     GNUNET_array_append (argvj, carg, argv);
 934   }
 935   for (cnt = 0; NULL != argv2[cnt]; cnt++)
 936   {
 937     argv = GNUNET_strdup (argv2[cnt]);
 938     GNUNET_array_append (argvj, carg, argv);
 939   }
 940   GNUNET_array_append (argvj, carg, NULL);
 941   return argvj;
 942 }
 943
 944
 945 /**
 946  * Frees the given NULL terminated arguments
 947  *
 948  * @param argv the NULL terminated list of arguments
 949  */
 950 static void
 951 free_argv (char **argv)
 952 {
 953   unsigned int argp;
 954
 955   for (argp = 0; NULL != argv[argp]; argp++)
 956     GNUNET_free (argv[argp]);
 957   GNUNET_free (argv);
 958 }
 959
 960
 961 /**
 962  * Generates arguments for opening a remote shell. Builds up the arguments
 963  * from the environment variable GNUNET_TESTBED_RSH_CMD. The variable
 964  * should not mention `-p' (port) option and destination address as these will
 965  * be set locally in the function from its parameteres. If the environmental
 966  * variable is not found then it defaults to `ssh -o BatchMode=yes -o
 967  * NoHostAuthenticationForLocalhost=yes'
 968  *
 969  * @param port the destination port number
 970  * @param dst the destination address
 971  * @return NULL terminated list of arguments
 972  */
 973 static char **
 974 gen_rsh_args (const char *port, const char *dst)
 975 {
 976   static const char *default_ssh_args[] = {
 977     "ssh",
 978     "-o",
 979     "BatchMode=yes",
 980     "-o",
 981     "NoHostAuthenticationForLocalhost=yes",
 982     NULL
 983   };
 984   char **ssh_args;
 985   char *ssh_cmd;
 986   char *ssh_cmd_cp;
 987   char *arg;
 988   unsigned int cnt;
 989
 990   ssh_args = NULL;
 991   if (NULL != (ssh_cmd = getenv ("GNUNET_TESTBED_RSH_CMD")))
 992   {
 993     ssh_cmd = GNUNET_strdup (ssh_cmd);
 994     ssh_cmd_cp = ssh_cmd;
 995     for (cnt = 0; NULL != (arg = strtok (ssh_cmd, " ")); ssh_cmd = NULL)
 996       GNUNET_array_append (ssh_args, cnt, GNUNET_strdup (arg));
 997     GNUNET_free (ssh_cmd_cp);
 998   }
 999   else
1000   {
1001     ssh_args = copy_argv (default_ssh_args);
1002     cnt = (sizeof (default_ssh_args)) / (sizeof (const char *));
1003     GNUNET_array_grow (ssh_args, cnt, cnt - 1);
1004   }
1005   GNUNET_array_append (ssh_args, cnt, GNUNET_strdup ("-p"));
1006   GNUNET_array_append (ssh_args, cnt, GNUNET_strdup (port));
1007   GNUNET_array_append (ssh_args, cnt, GNUNET_strdup (dst));
1008   GNUNET_array_append (ssh_args, cnt, NULL);
1009   return ssh_args;
1010 }
1011
1012
1013 /**
1014  * Generates the arguments needed for executing the given binary in a remote
1015  * shell. Builds the arguments from the environmental variable
1016  * GNUNET_TETSBED_RSH_CMD_SUFFIX. If the environmental variable is not found,
1017  * only the given binary name will be present in the returned arguments
1018  *
1019  * @param append_args the arguments to append after generating the suffix
1020  *          arguments. Can be NULL; if not must be NULL terminated 'char *' array
1021  * @return NULL-terminated args
1022  */
1023 static char **
1024 gen_rsh_suffix_args (const char * const *append_args)
1025 {
1026   char **rshell_args;
1027   char *rshell_cmd;
1028   char *rshell_cmd_cp;
1029   char *arg;
1030   unsigned int cnt;
1031   unsigned int append_cnt;
1032
1033   rshell_args = NULL;
1034   cnt = 0;
1035   if (NULL != (rshell_cmd = getenv ("GNUNET_TESTBED_RSH_CMD_SUFFIX")))
1036   {
1037     rshell_cmd = GNUNET_strdup (rshell_cmd);
1038     rshell_cmd_cp = rshell_cmd;
1039     for (; NULL != (arg = strtok (rshell_cmd, " ")); rshell_cmd = NULL)
1040       GNUNET_array_append (rshell_args, cnt, GNUNET_strdup (arg));
1041     GNUNET_free (rshell_cmd_cp);
1042   }
1043   if (NULL != append_args)
1044   {
1045     for (append_cnt = 0; NULL != append_args[append_cnt]; append_cnt++)
1046       GNUNET_array_append (rshell_args, cnt, GNUNET_strdup (append_args[append_cnt]));
1047   }
1048   GNUNET_array_append (rshell_args, cnt, NULL);
1049   return rshell_args;
1050 }
1051
1052
1053 /**
1054  * Functions with this signature are called whenever a
1055  * complete message is received by the tokenizer.
1056  *
1057  * Do not call GNUNET_SERVER_mst_destroy in callback
1058  *
1059  * @param cls closure
1060  * @param client identification of the client
1061  * @param message the actual message
1062  *
1063  * @return GNUNET_OK on success, GNUNET_SYSERR to stop further processing
1064  */
1065 static int
1066 helper_mst (void *cls, void *client, const struct GNUNET_MessageHeader *message)
1067 {
1068   struct GNUNET_TESTBED_ControllerProc *cp = cls;
1069   const struct GNUNET_TESTBED_HelperReply *msg;
1070   const char *hostname;
1071   char *config;
1072   uLongf config_size;
1073   uLongf xconfig_size;
1074
1075   msg = (const struct GNUNET_TESTBED_HelperReply *) message;
1076   GNUNET_assert (sizeof (struct GNUNET_TESTBED_HelperReply) <
1077                  ntohs (msg->header.size));
1078   GNUNET_assert (GNUNET_MESSAGE_TYPE_TESTBED_HELPER_REPLY ==
1079                  ntohs (msg->header.type));
1080   config_size = (uLongf) ntohs (msg->config_size);
1081   xconfig_size =
1082       (uLongf) (ntohs (msg->header.size) -
1083                 sizeof (struct GNUNET_TESTBED_HelperReply));
1084   config = GNUNET_malloc (config_size);
1085   GNUNET_assert (Z_OK ==
1086                  uncompress ((Bytef *) config, &config_size,
1087                              (const Bytef *) &msg[1], xconfig_size));
1088   /* Replace the configuration template present in the host with the
1089      controller's running configuration */
1090   GNUNET_CONFIGURATION_destroy (cp->host->cfg);
1091   cp->host->cfg = GNUNET_CONFIGURATION_create ();
1092   GNUNET_assert (GNUNET_CONFIGURATION_deserialize
1093                  (cp->host->cfg, config, config_size, GNUNET_NO));
1094   GNUNET_free (config);
1095   if ((NULL == cp->host) ||
1096       (NULL == (hostname = GNUNET_TESTBED_host_get_hostname (cp->host))))
1097     hostname = "localhost";
1098   /* Change the hostname so that we can connect to it */
1099   GNUNET_CONFIGURATION_set_value_string (cp->host->cfg, "testbed", "hostname",
1100                                          hostname);
1101   cp->host->locked = GNUNET_NO;
1102   cp->host->controller_started = GNUNET_YES;
1103   cp->cb (cp->cls, cp->host->cfg, GNUNET_OK);
1104   return GNUNET_OK;
1105 }
1106
1107
1108 /**
1109  * Continuation function from GNUNET_HELPER_send()
1110  *
1111  * @param cls closure
1112  * @param result GNUNET_OK on success,
1113  *               GNUNET_NO if helper process died
1114  *               GNUNET_SYSERR during GNUNET_HELPER_stop
1115  */
1116 static void
1117 clear_msg (void *cls, int result)
1118 {
1119   struct GNUNET_TESTBED_ControllerProc *cp = cls;
1120
1121   GNUNET_assert (NULL != cp->shandle);
1122   cp->shandle = NULL;
1123   GNUNET_free (cp->msg);
1124 }
1125
1126
1127 /**
1128  * Callback that will be called when the helper process dies. This is not called
1129  * when the helper process is stoped using GNUNET_HELPER_stop()
1130  *
1131  * @param cls the closure from GNUNET_HELPER_start()
1132  */
1133 static void
1134 helper_exp_cb (void *cls)
1135 {
1136   struct GNUNET_TESTBED_ControllerProc *cp = cls;
1137   GNUNET_TESTBED_ControllerStatusCallback cb;
1138   void *cb_cls;
1139
1140   cb = cp->cb;
1141   cb_cls = cp->cls;
1142   cp->helper = NULL;
1143   GNUNET_TESTBED_controller_stop (cp);
1144   if (NULL != cb)
1145     cb (cb_cls, NULL, GNUNET_SYSERR);
1146 }
1147
1148
1149 /**
1150  * Starts a controller process at the given host.  The given host's configration
1151  * is used as a Template configuration to use for the remote controller; the
1152  * remote controller will be started with a slightly modified configuration
1153  * (port numbers, unix domain sockets and service home values are changed as per
1154  * TESTING library on the remote host).  The modified configuration replaces the
1155  * host's existing configuration before signalling success through the
1156  * GNUNET_TESTBED_ControllerStatusCallback()
1157  *
1158  * @param trusted_ip the ip address of the controller which will be set as TRUSTED
1159  *          HOST(all connections form this ip are permitted by the testbed) when
1160  *          starting testbed controller at host. This can either be a single ip
1161  *          address or a network address in CIDR notation.
1162  * @param host the host where the controller has to be started.  CANNOT be NULL.
1163  * @param cb function called when the controller is successfully started or
1164  *          dies unexpectedly; GNUNET_TESTBED_controller_stop shouldn't be
1165  *          called if cb is called with GNUNET_SYSERR as status. Will never be
1166  *          called in the same task as 'GNUNET_TESTBED_controller_start'
1167  *          (synchronous errors will be signalled by returning NULL). This
1168  *          parameter cannot be NULL.
1169  * @param cls closure for above callbacks
1170  * @return the controller process handle, NULL on errors
1171  */
1172 struct GNUNET_TESTBED_ControllerProc *
1173 GNUNET_TESTBED_controller_start (const char *trusted_ip,
1174                                  struct GNUNET_TESTBED_Host *host,
1175                                  GNUNET_TESTBED_ControllerStatusCallback cb,
1176                                  void *cls)
1177 {
1178   struct GNUNET_TESTBED_ControllerProc *cp;
1179   struct GNUNET_TESTBED_HelperInit *msg;
1180   const struct GNUNET_CONFIGURATION_Handle *cfg;
1181   const char *hostname;
1182   static char *const binary_argv[] = {
1183     HELPER_TESTBED_BINARY, NULL
1184   };
1185
1186   GNUNET_assert (NULL != host);
1187   GNUNET_assert (NULL != (cfg = GNUNET_TESTBED_host_get_cfg_ (host)));
1188   hostname = NULL;
1189   API_VIOLATION (GNUNET_NO == host->locked,
1190                  "Host is already locked by a previous call to GNUNET_TESTBED_controller_start()");
1191   host->locked = GNUNET_YES;
1192   API_VIOLATION (GNUNET_NO == host->controller_started,
1193                  "Attempting to start a controller on a host which is already started a controller");
1194   cp = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_ControllerProc));
1195   if (0 == GNUNET_TESTBED_host_get_id_ (host))
1196   {
1197     cp->helper =
1198         GNUNET_HELPER_start (GNUNET_YES, HELPER_TESTBED_BINARY, binary_argv,
1199                              &helper_mst, &helper_exp_cb, cp);
1200   }
1201   else
1202   {
1203     char *helper_binary_path_args[2];
1204     char **rsh_args;
1205     char **rsh_suffix_args;
1206     const char *username;
1207     char *port;
1208     char *dst;
1209
1210     username = GNUNET_TESTBED_host_get_username_ (host);
1211     hostname = GNUNET_TESTBED_host_get_hostname (host);
1212     GNUNET_asprintf (&port, "%u", GNUNET_TESTBED_host_get_ssh_port_ (host));
1213     if (NULL == username)
1214       GNUNET_asprintf (&dst, "%s", hostname);
1215     else
1216       GNUNET_asprintf (&dst, "%s@%s", username, hostname);
1217     LOG_DEBUG ("Starting SSH to destination %s\n", dst);
1218
1219     if (GNUNET_OK !=
1220         GNUNET_CONFIGURATION_get_value_string (cfg, "testbed",
1221                                                "HELPER_BINARY_PATH",
1222                                                &helper_binary_path_args[0]))
1223       helper_binary_path_args[0] =
1224           GNUNET_OS_get_libexec_binary_path (HELPER_TESTBED_BINARY);
1225     helper_binary_path_args[1] = NULL;
1226     rsh_args = gen_rsh_args (port, dst);
1227     rsh_suffix_args = gen_rsh_suffix_args ((const char **) helper_binary_path_args);
1228     cp->helper_argv =
1229         join_argv ((const char **) rsh_args, (const char **) rsh_suffix_args);
1230     free_argv (rsh_args);
1231     free_argv (rsh_suffix_args);
1232     GNUNET_free (port);
1233     GNUNET_free (dst);
1234     cp->helper =
1235         GNUNET_HELPER_start (GNUNET_NO, cp->helper_argv[0], cp->helper_argv, &helper_mst,
1236                              &helper_exp_cb, cp);
1237     GNUNET_free (helper_binary_path_args[0]);
1238   }
1239   if (NULL == cp->helper)
1240   {
1241     if (NULL != cp->helper_argv)
1242       free_argv (cp->helper_argv);
1243     GNUNET_free (cp);
1244     return NULL;
1245   }
1246   cp->host = host;
1247   cp->cb = cb;
1248   cp->cls = cls;
1249   msg = GNUNET_TESTBED_create_helper_init_msg_ (trusted_ip, hostname, cfg);
1250   cp->msg = &msg->header;
1251   cp->shandle =
1252       GNUNET_HELPER_send (cp->helper, &msg->header, GNUNET_NO, &clear_msg, cp);
1253   if (NULL == cp->shandle)
1254   {
1255     GNUNET_free (msg);
1256     GNUNET_TESTBED_controller_stop (cp);
1257     return NULL;
1258   }
1259   return cp;
1260 }
1261
1262
1263 /**
1264  * Stop the controller process (also will terminate all peers and controllers
1265  * dependent on this controller).  This function blocks until the testbed has
1266  * been fully terminated (!). The controller status cb from
1267  * GNUNET_TESTBED_controller_start() will not be called.
1268  *
1269  * @param cproc the controller process handle
1270  */
1271 void
1272 GNUNET_TESTBED_controller_stop (struct GNUNET_TESTBED_ControllerProc *cproc)
1273 {
1274   if (NULL != cproc->shandle)
1275     GNUNET_HELPER_send_cancel (cproc->shandle);
1276   if (NULL != cproc->helper)
1277     GNUNET_HELPER_soft_stop (cproc->helper);
1278   if (NULL != cproc->helper_argv)
1279     free_argv (cproc->helper_argv);
1280   cproc->host->controller_started = GNUNET_NO;
1281   cproc->host->locked = GNUNET_NO;
1282   GNUNET_free (cproc);
1283 }
1284
1285
1286 /**
1287  * The handle for whether a host is habitable or not
1288  */
1289 struct GNUNET_TESTBED_HostHabitableCheckHandle
1290 {
1291   /**
1292    * The host to check
1293    */
1294   const struct GNUNET_TESTBED_Host *host;
1295
1296   /**
1297    * The callback to call once we have the status
1298    */
1299   GNUNET_TESTBED_HostHabitableCallback cb;
1300
1301   /**
1302    * The callback closure
1303    */
1304   void *cb_cls;
1305
1306   /**
1307    * The process handle for the SSH process
1308    */
1309   struct GNUNET_OS_Process *auxp;
1310
1311   /**
1312    * The arguments used to start the helper
1313    */
1314   char **helper_argv;
1315
1316   /**
1317    * Task id for the habitability check task
1318    */
1319   GNUNET_SCHEDULER_TaskIdentifier habitability_check_task;
1320
1321   /**
1322    * How long we wait before checking the process status. Should grow
1323    * exponentially
1324    */
1325   struct GNUNET_TIME_Relative wait_time;
1326
1327 };
1328
1329
1330 /**
1331  * Task for checking whether a host is habitable or not
1332  *
1333  * @param cls GNUNET_TESTBED_HostHabitableCheckHandle
1334  * @param tc the scheduler task context
1335  */
1336 static void
1337 habitability_check (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1338 {
1339   struct GNUNET_TESTBED_HostHabitableCheckHandle *h = cls;
1340   void *cb_cls;
1341   GNUNET_TESTBED_HostHabitableCallback cb;
1342   const struct GNUNET_TESTBED_Host *host;
1343   unsigned long code;
1344   enum GNUNET_OS_ProcessStatusType type;
1345   int ret;
1346
1347   h->habitability_check_task = GNUNET_SCHEDULER_NO_TASK;
1348   ret = GNUNET_OS_process_status (h->auxp, &type, &code);
1349   if (GNUNET_SYSERR == ret)
1350   {
1351     GNUNET_break (0);
1352     ret = GNUNET_NO;
1353     goto call_cb;
1354   }
1355   if (GNUNET_NO == ret)
1356   {
1357     h->wait_time = GNUNET_TIME_STD_BACKOFF (h->wait_time);
1358     h->habitability_check_task =
1359         GNUNET_SCHEDULER_add_delayed (h->wait_time, &habitability_check, h);
1360     return;
1361   }
1362   GNUNET_OS_process_destroy (h->auxp);
1363   h->auxp = NULL;
1364   ret = (0 != code) ? GNUNET_NO : GNUNET_YES;
1365
1366 call_cb:
1367   if (NULL != h->auxp)
1368     GNUNET_OS_process_destroy (h->auxp);
1369   cb = h->cb;
1370   cb_cls = h->cb_cls;
1371   host = h->host;
1372   free_argv (h->helper_argv);
1373   GNUNET_free (h);
1374   if (NULL != cb)
1375     cb (cb_cls, host, ret);
1376 }
1377
1378
1379 /**
1380  * Checks whether a host can be used to start testbed service
1381  *
1382  * @param host the host to check
1383  * @param config the configuration handle to lookup the path of the testbed
1384  *          helper
1385  * @param cb the callback to call to inform about habitability of the given host
1386  * @param cb_cls the closure for the callback
1387  * @return NULL upon any error or a handle which can be passed to
1388  *           GNUNET_TESTBED_is_host_habitable_cancel()
1389  */
1390 struct GNUNET_TESTBED_HostHabitableCheckHandle *
1391 GNUNET_TESTBED_is_host_habitable (const struct GNUNET_TESTBED_Host *host,
1392                                   const struct GNUNET_CONFIGURATION_Handle
1393                                   *config,
1394                                   GNUNET_TESTBED_HostHabitableCallback cb,
1395                                   void *cb_cls)
1396 {
1397   struct GNUNET_TESTBED_HostHabitableCheckHandle *h;
1398   char **rsh_args;
1399   char **rsh_suffix_args;
1400   char *stat_args[3];
1401   const char *hostname;
1402   char *port;
1403   char *dst;
1404
1405   h = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_HostHabitableCheckHandle));
1406   h->cb = cb;
1407   h->cb_cls = cb_cls;
1408   h->host = host;
1409   hostname = (NULL == host->hostname) ? "127.0.0.1" : host->hostname;
1410   if (NULL == host->username)
1411     dst = GNUNET_strdup (hostname);
1412   else
1413     GNUNET_asprintf (&dst, "%s@%s", host->username, hostname);
1414   if (GNUNET_OK !=
1415       GNUNET_CONFIGURATION_get_value_string (config, "testbed",
1416                                              "HELPER_BINARY_PATH",
1417                                              &stat_args[1]))
1418     stat_args[1] =
1419         GNUNET_OS_get_libexec_binary_path (HELPER_TESTBED_BINARY);
1420   GNUNET_asprintf (&port, "%u", host->port);
1421   rsh_args = gen_rsh_args (port, dst);
1422   GNUNET_free (port);
1423   GNUNET_free (dst);
1424   port = NULL;
1425   dst = NULL;
1426   stat_args[0] = "stat";
1427   stat_args[2] = NULL;
1428   rsh_suffix_args = gen_rsh_suffix_args ((const char **) stat_args);
1429   GNUNET_free (stat_args[1]);
1430   h->helper_argv = join_argv ((const char **) rsh_args,
1431                               (const char **) rsh_suffix_args);
1432   free_argv (rsh_suffix_args);
1433   free_argv (rsh_args);
1434   h->auxp =
1435       GNUNET_OS_start_process_vap (GNUNET_NO, GNUNET_OS_INHERIT_STD_ERR, NULL,
1436                                    NULL, h->helper_argv[0], h->helper_argv);
1437   if (NULL == h->auxp)
1438   {
1439     GNUNET_break (0);           /* Cannot exec SSH? */
1440     GNUNET_free (h);
1441     return NULL;
1442   }
1443   h->wait_time = GNUNET_TIME_STD_BACKOFF (h->wait_time);
1444   h->habitability_check_task =
1445       GNUNET_SCHEDULER_add_delayed (h->wait_time, &habitability_check, h);
1446   return h;
1447 }
1448
1449
1450 /**
1451  * Function to cancel a request started using GNUNET_TESTBED_is_host_habitable()
1452  *
1453  * @param handle the habitability check handle
1454  */
1455 void
1456 GNUNET_TESTBED_is_host_habitable_cancel (struct
1457                                          GNUNET_TESTBED_HostHabitableCheckHandle
1458                                          *handle)
1459 {
1460   GNUNET_SCHEDULER_cancel (handle->habitability_check_task);
1461   (void) GNUNET_OS_process_kill (handle->auxp, SIGTERM);
1462   (void) GNUNET_OS_process_wait (handle->auxp);
1463   GNUNET_OS_process_destroy (handle->auxp);
1464   free_argv (handle->helper_argv);
1465   GNUNET_free (handle);
1466 }
1467
1468
1469 /**
1470  * handle for host registration
1471  */
1472 struct GNUNET_TESTBED_HostRegistrationHandle
1473 {
1474   /**
1475    * The host being registered
1476    */
1477   struct GNUNET_TESTBED_Host *host;
1478
1479   /**
1480    * The controller at which this host is being registered
1481    */
1482   struct GNUNET_TESTBED_Controller *c;
1483
1484   /**
1485    * The Registartion completion callback
1486    */
1487   GNUNET_TESTBED_HostRegistrationCompletion cc;
1488
1489   /**
1490    * The closure for above callback
1491    */
1492   void *cc_cls;
1493 };
1494
1495
1496 /**
1497  * Register a host with the controller
1498  *
1499  * @param controller the controller handle
1500  * @param host the host to register
1501  * @param cc the completion callback to call to inform the status of
1502  *          registration. After calling this callback the registration handle
1503  *          will be invalid. Cannot be NULL.
1504  * @param cc_cls the closure for the cc
1505  * @return handle to the host registration which can be used to cancel the
1506  *           registration
1507  */
1508 struct GNUNET_TESTBED_HostRegistrationHandle *
1509 GNUNET_TESTBED_register_host (struct GNUNET_TESTBED_Controller *controller,
1510                               struct GNUNET_TESTBED_Host *host,
1511                               GNUNET_TESTBED_HostRegistrationCompletion cc,
1512                               void *cc_cls)
1513 {
1514   struct GNUNET_TESTBED_HostRegistrationHandle *rh;
1515   struct GNUNET_TESTBED_AddHostMessage *msg;
1516   const char *username;
1517   const char *hostname;
1518   char *config;
1519   char *cconfig;
1520   void *ptr;
1521   size_t cc_size;
1522   size_t config_size;
1523   uint16_t msg_size;
1524   uint16_t username_length;
1525   uint16_t hostname_length;
1526
1527   if (NULL != controller->rh)
1528     return NULL;
1529   hostname = GNUNET_TESTBED_host_get_hostname (host);
1530   if (GNUNET_YES == GNUNET_TESTBED_is_host_registered_ (host, controller))
1531   {
1532     LOG (GNUNET_ERROR_TYPE_WARNING, "Host hostname: %s already registered\n",
1533          (NULL == hostname) ? "localhost" : hostname);
1534     return NULL;
1535   }
1536   rh = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_HostRegistrationHandle));
1537   rh->host = host;
1538   rh->c = controller;
1539   GNUNET_assert (NULL != cc);
1540   rh->cc = cc;
1541   rh->cc_cls = cc_cls;
1542   controller->rh = rh;
1543   username = GNUNET_TESTBED_host_get_username_ (host);
1544   username_length = 0;
1545   if (NULL != username)
1546     username_length = strlen (username);
1547   GNUNET_assert (NULL != hostname); /* Hostname must be present */
1548   hostname_length = strlen (hostname);
1549   GNUNET_assert (NULL != host->cfg);
1550   config = GNUNET_CONFIGURATION_serialize (host->cfg, &config_size);
1551   cc_size = GNUNET_TESTBED_compress_config_ (config, config_size, &cconfig);
1552   GNUNET_free (config);
1553   msg_size = (sizeof (struct GNUNET_TESTBED_AddHostMessage));
1554   msg_size += username_length;
1555   msg_size += hostname_length;
1556   msg_size += cc_size;
1557   msg = GNUNET_malloc (msg_size);
1558   msg->header.size = htons (msg_size);
1559   msg->header.type = htons (GNUNET_MESSAGE_TYPE_TESTBED_ADD_HOST);
1560   msg->host_id = htonl (GNUNET_TESTBED_host_get_id_ (host));
1561   msg->ssh_port = htons (GNUNET_TESTBED_host_get_ssh_port_ (host));
1562   ptr = &msg[1];
1563   if (NULL != username)
1564   {
1565     msg->username_length = htons (username_length);
1566     ptr = memcpy (ptr, username, username_length);
1567     ptr += username_length;
1568   }
1569   msg->hostname_length = htons (hostname_length);
1570   ptr = memcpy (ptr, hostname, hostname_length);
1571   ptr += hostname_length;
1572   msg->config_size = htons (config_size);
1573   ptr = memcpy (ptr, cconfig, cc_size);
1574   ptr += cc_size;
1575   GNUNET_assert ((ptr - (void *) msg) == msg_size);
1576   GNUNET_free (cconfig);
1577   GNUNET_TESTBED_queue_message_ (controller,
1578                                  (struct GNUNET_MessageHeader *) msg);
1579   return rh;
1580 }
1581
1582
1583 /**
1584  * Cancel the pending registration. Note that if the registration message is
1585  * already sent to the service the cancellation has only the effect that the
1586  * registration completion callback for the registration is never called.
1587  *
1588  * @param handle the registration handle to cancel
1589  */
1590 void
1591 GNUNET_TESTBED_cancel_registration (struct GNUNET_TESTBED_HostRegistrationHandle
1592                                     *handle)
1593 {
1594   if (handle != handle->c->rh)
1595   {
1596     GNUNET_break (0);
1597     return;
1598   }
1599   handle->c->rh = NULL;
1600   GNUNET_free (handle);
1601 }
1602
1603
1604 /**
1605  * Initializes the operation queue for parallel overlay connects
1606  *
1607  * @param h the host handle
1608  * @param npoc the number of parallel overlay connects - the queue size
1609  */
1610 void
1611 GNUNET_TESTBED_set_num_parallel_overlay_connects_ (struct
1612                                                    GNUNET_TESTBED_Host *h,
1613                                                    unsigned int npoc)
1614 {
1615   //fprintf (stderr, "%d", npoc);
1616   GNUNET_free_non_null (h->tslots);
1617   h->tslots_filled = 0;
1618   h->num_parallel_connects = npoc;
1619   h->tslots = GNUNET_malloc (npoc * sizeof (struct TimeSlot));
1620   GNUNET_TESTBED_operation_queue_reset_max_active_
1621       (h->opq_parallel_overlay_connect_operations, npoc);
1622 }
1623
1624
1625 /**
1626  * Returns a timing slot which will be exclusively locked
1627  *
1628  * @param h the host handle
1629  * @param key a pointer which is associated to the returned slot; should not be
1630  *          NULL. It serves as a key to determine the correct owner of the slot
1631  * @return the time slot index in the array of time slots in the controller
1632  *           handle
1633  */
1634 unsigned int
1635 GNUNET_TESTBED_get_tslot_ (struct GNUNET_TESTBED_Host *h, void *key)
1636 {
1637   unsigned int slot;
1638
1639   GNUNET_assert (NULL != h->tslots);
1640   GNUNET_assert (NULL != key);
1641   for (slot = 0; slot < h->num_parallel_connects; slot++)
1642     if (NULL == h->tslots[slot].key)
1643     {
1644       h->tslots[slot].key = key;
1645       return slot;
1646     }
1647   GNUNET_assert (0);            /* We should always find a free tslot */
1648 }
1649
1650
1651 /**
1652  * Decides whether any change in the number of parallel overlay connects is
1653  * necessary to adapt to the load on the system
1654  *
1655  * @param h the host handle
1656  */
1657 static void
1658 decide_npoc (struct GNUNET_TESTBED_Host *h)
1659 {
1660   struct GNUNET_TIME_Relative avg;
1661   int sd;
1662   unsigned int slot;
1663   unsigned int nvals;
1664
1665   if (h->tslots_filled != h->num_parallel_connects)
1666     return;
1667   avg = GNUNET_TIME_UNIT_ZERO;
1668   nvals = 0;
1669   for (slot = 0; slot < h->num_parallel_connects; slot++)
1670   {
1671     avg = GNUNET_TIME_relative_add (avg, h->tslots[slot].time);
1672     nvals += h->tslots[slot].nvals;
1673   }
1674   GNUNET_assert (nvals >= h->num_parallel_connects);
1675   avg = GNUNET_TIME_relative_divide (avg, nvals);
1676   GNUNET_assert (GNUNET_TIME_UNIT_FOREVER_REL.rel_value != avg.rel_value);
1677   sd = GNUNET_TESTBED_SD_deviation_factor_ (h->poc_sd, (unsigned int) avg.rel_value);
1678   if ( (sd <= 5) ||
1679        (0 == GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK,
1680                                        h->num_parallel_connects)) )
1681     GNUNET_TESTBED_SD_add_data_ (h->poc_sd, (unsigned int) avg.rel_value);
1682   if (GNUNET_SYSERR == sd)
1683   {
1684     GNUNET_TESTBED_set_num_parallel_overlay_connects_ (h,
1685                                                        h->num_parallel_connects);
1686     return;
1687   }
1688   GNUNET_assert (0 <= sd);
1689   if (0 == sd)
1690   {
1691     GNUNET_TESTBED_set_num_parallel_overlay_connects_ (h,
1692                                                        h->num_parallel_connects
1693                                                        * 2);
1694     return;
1695   }
1696   if (1 == sd)
1697   {
1698     GNUNET_TESTBED_set_num_parallel_overlay_connects_ (h,
1699                                                        h->num_parallel_connects
1700                                                        + 1);
1701     return;
1702   }
1703   if (1 == h->num_parallel_connects)
1704   {
1705     GNUNET_TESTBED_set_num_parallel_overlay_connects_ (h, 1);
1706     return;
1707   }
1708   if (2 == sd)
1709   {
1710     GNUNET_TESTBED_set_num_parallel_overlay_connects_ (h,
1711                                                        h->num_parallel_connects
1712                                                        - 1);
1713     return;
1714   }
1715   GNUNET_TESTBED_set_num_parallel_overlay_connects_ (h,
1716                                                      h->num_parallel_connects /
1717                                                      2);
1718 }
1719
1720
1721 /**
1722  * Releases a time slot thus making it available for be used again
1723  *
1724  * @param h the host handle
1725  * @param index the index of the the time slot
1726  * @param key the key to prove ownership of the timeslot
1727  * @return GNUNET_YES if the time slot is successfully removed; GNUNET_NO if the
1728  *           time slot cannot be removed - this could be because of the index
1729  *           greater than existing number of time slots or `key' being different
1730  */
1731 int
1732 GNUNET_TESTBED_release_time_slot_ (struct GNUNET_TESTBED_Host *h,
1733                                    unsigned int index, void *key)
1734 {
1735   struct TimeSlot *slot;
1736
1737   GNUNET_assert (NULL != key);
1738   if (index >= h->num_parallel_connects)
1739     return GNUNET_NO;
1740   slot = &h->tslots[index];
1741   if (key != slot->key)
1742     return GNUNET_NO;
1743   slot->key = NULL;
1744   return GNUNET_YES;
1745 }
1746
1747
1748 /**
1749  * Function to update a time slot
1750  *
1751  * @param h the host handle
1752  * @param index the index of the time slot to update
1753  * @param key the key to identify ownership of the slot
1754  * @param time the new time
1755  * @param failed should this reading be treated as coming from a fail event
1756  */
1757 void
1758 GNUNET_TESTBED_update_time_slot_ (struct GNUNET_TESTBED_Host *h,
1759                                   unsigned int index, void *key,
1760                                   struct GNUNET_TIME_Relative time, int failed)
1761 {
1762   struct TimeSlot *slot;
1763
1764   if (GNUNET_YES == failed)
1765   {
1766     if (1 == h->num_parallel_connects)
1767     {
1768       GNUNET_TESTBED_set_num_parallel_overlay_connects_ (h, 1);
1769       return;
1770     }
1771     GNUNET_TESTBED_set_num_parallel_overlay_connects_ (h,
1772                                                        h->num_parallel_connects
1773                                                        - 1);
1774   }
1775   if (GNUNET_NO == GNUNET_TESTBED_release_time_slot_ (h, index, key))
1776     return;
1777   slot = &h->tslots[index];
1778   slot->nvals++;
1779   if (GNUNET_TIME_UNIT_ZERO.rel_value == slot->time.rel_value)
1780   {
1781     slot->time = time;
1782     h->tslots_filled++;
1783     decide_npoc (h);
1784     return;
1785   }
1786   slot->time = GNUNET_TIME_relative_add (slot->time, time);
1787 }
1788
1789
1790 /**
1791  * Queues the given operation in the queue for parallel overlay connects of the
1792  * given host
1793  *
1794  * @param h the host handle
1795  * @param op the operation to queue in the given host's parally overlay connect
1796  *          queue
1797  */
1798 void
1799 GNUNET_TESTBED_host_queue_oc_ (struct GNUNET_TESTBED_Host *h,
1800                                struct GNUNET_TESTBED_Operation *op)
1801 {
1802   GNUNET_TESTBED_operation_queue_insert_
1803       (h->opq_parallel_overlay_connect_operations, op);
1804 }
1805
1806
1807 /**
1808  * Handler for GNUNET_MESSAGE_TYPE_TESTBED_ADDHOSTCONFIRM message from
1809  * controller (testbed service)
1810  *
1811  * @param c the controller handler
1812  * @param msg message received
1813  * @return GNUNET_YES if we can continue receiving from service; GNUNET_NO if
1814  *           not
1815  */
1816 int
1817 GNUNET_TESTBED_host_handle_addhostconfirm_ (struct GNUNET_TESTBED_Controller *c,
1818                                             const struct
1819                                             GNUNET_TESTBED_HostConfirmedMessage
1820                                             *msg)
1821 {
1822   struct GNUNET_TESTBED_HostRegistrationHandle *rh;
1823   char *emsg;
1824   uint16_t msg_size;
1825
1826   rh = c->rh;
1827   if (NULL == rh)
1828   {
1829     return GNUNET_OK;
1830   }
1831   if (GNUNET_TESTBED_host_get_id_ (rh->host) != ntohl (msg->host_id))
1832   {
1833     LOG_DEBUG ("Mismatch in host id's %u, %u of host confirm msg\n",
1834                GNUNET_TESTBED_host_get_id_ (rh->host), ntohl (msg->host_id));
1835     return GNUNET_OK;
1836   }
1837   c->rh = NULL;
1838   msg_size = ntohs (msg->header.size);
1839   if (sizeof (struct GNUNET_TESTBED_HostConfirmedMessage) == msg_size)
1840   {
1841     LOG_DEBUG ("Host %u successfully registered\n", ntohl (msg->host_id));
1842     GNUNET_TESTBED_mark_host_registered_at_ (rh->host, c);
1843     rh->cc (rh->cc_cls, NULL);
1844     GNUNET_free (rh);
1845     return GNUNET_OK;
1846   }
1847   /* We have an error message */
1848   emsg = (char *) &msg[1];
1849   if ('\0' !=
1850       emsg[msg_size - sizeof (struct GNUNET_TESTBED_HostConfirmedMessage)])
1851   {
1852     GNUNET_break (0);
1853     GNUNET_free (rh);
1854     return GNUNET_NO;
1855   }
1856   LOG (GNUNET_ERROR_TYPE_ERROR, _("Adding host %u failed with error: %s\n"),
1857        ntohl (msg->host_id), emsg);
1858   rh->cc (rh->cc_cls, emsg);
1859   GNUNET_free (rh);
1860   return GNUNET_OK;
1861 }
1862
1863 /* end of testbed_api_hosts.c */