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   freeaddrinfo (res);
 560   LOG_DEBUG ("Resolved [%s] to [%s]\n", host, hostip);
 561   return hostip;
 562 }
 563
 564
 565 /**
 566  * Loads the set of host allocated by the LoadLeveler Job Scheduler.  This
 567  * function is only available when compiled with support for LoadLeveler and is
 568  * used for running on the SuperMUC
 569  *
 570  * @param cfg the configuration to use as a template while starting a controller
 571  *          on any of the loaded hosts.  Operation queue sizes specific to a host
 572  *          are also read from this configuration handle
 573  * @param hosts set to the hosts found in the file; caller must free this if
 574  *          number of hosts returned is greater than 0
 575  * @return number of hosts returned in 'hosts', 0 on error
 576  */
 577 unsigned int
 578 GNUNET_TESTBED_hosts_load_from_loadleveler (const struct
 579                                             GNUNET_CONFIGURATION_Handle *cfg,
 580                                             struct GNUNET_TESTBED_Host ***hosts)
 581 {
 582 #if !ENABLE_LL
 583   LOG (GNUNET_ERROR_TYPE_ERROR,
 584        _("The function %s is only available when compiled with (--with-ll)\n"),
 585        __func__);
 586   GNUNET_assert (0);
 587 #else
 588   const char *hostfile;
 589   char *buf;
 590   char *hostname;
 591   char **hostnames;
 592   char **hostaddrs;
 593   const char *hostip;
 594   struct GNUNET_TESTBED_Host **host_list;
 595   ssize_t rsize;
 596   uint64_t size;
 597   uint64_t offset;
 598   enum {
 599     SCAN,
 600     SKIP,
 601     TRIM,
 602     READHOST
 603   } pstep;
 604   unsigned int host;
 605   unsigned int nhosts;
 606   unsigned int nhostaddrs;
 607
 608   if (NULL == (hostfile = getenv ("MP_SAVEHOSTFILE")))
 609   {
 610     GNUNET_break (0);
 611     return 0;
 612   }
 613   if (GNUNET_SYSERR == GNUNET_DISK_file_size (hostfile, &size, GNUNET_YES,
 614                                               GNUNET_YES))
 615   {
 616     GNUNET_break (0);
 617     return 0;
 618   }
 619   if (0 == size)
 620   {
 621     GNUNET_break (0);
 622     return 0;
 623   }
 624   buf = GNUNET_malloc (size + 1);
 625   rsize = GNUNET_DISK_fn_read (hostfile, buf, (size_t) size);
 626   if ( (GNUNET_SYSERR == rsize) || ((ssize_t) size != rsize) )
 627   {
 628     GNUNET_free (buf);
 629     GNUNET_break (0);
 630     return 0;
 631   }
 632   size++;
 633   offset = 0;
 634   pstep = SCAN;
 635   hostname = NULL;
 636   hostnames = NULL;
 637   hostaddrs = NULL;
 638   nhosts = 0;
 639   nhostaddrs = 0;
 640   while (offset < size)
 641   {
 642     switch (pstep)
 643     {
 644     case SCAN:
 645       if ('!' == buf[offset])
 646         pstep = SKIP;
 647       else
 648         pstep = TRIM;
 649       break;
 650     case SKIP:
 651       if ('\n' == buf[offset])
 652         pstep = SCAN;
 653       break;
 654     case TRIM:
 655       if ('!' == buf[offset])
 656       {
 657         pstep = SKIP;
 658         break;
 659       }
 660       if ( (' ' == buf[offset])
 661            || ('\t' == buf[offset])
 662            || ('\r' == buf[offset]) )
 663         pstep = TRIM;
 664       else
 665       {
 666         pstep = READHOST;
 667         hostname = &buf[offset];
 668       }
 669       break;
 670     case READHOST:
 671       if (isspace (buf[offset]))
 672       {
 673         buf[offset] = '\0';
 674         for (host = 0; host < nhosts; host++)
 675           if (0 == strcmp (hostnames[host], hostname))
 676             break;
 677         if (host == nhosts)
 678         {
 679           LOG_DEBUG ("Adding host [%s]\n", hostname);
 680           hostname = GNUNET_strdup (hostname);
 681           GNUNET_array_append (hostnames, nhosts, hostname);
 682         }
 683         else
 684           LOG_DEBUG ("Not adding host [%s] as it is already included\n", hostname);
 685         hostname = NULL;
 686         pstep = SCAN;
 687       }
 688       break;
 689     }
 690     offset++;
 691   }
 692   GNUNET_free_non_null (buf);
 693   if (NULL == hostnames)
 694     return 0;
 695   for (host = 0; host < nhosts; host++)
 696   {
 697     hostip = simple_resolve (hostnames[host]);
 698     if (NULL == hostip)
 699     {
 700       nhosts = 0;
 701       goto cleanup;
 702     }
 703     GNUNET_array_append (hostaddrs, nhostaddrs, GNUNET_strdup (hostip));
 704   }
 705   GNUNET_assert (nhostaddrs == nhosts);
 706   if (NULL == hosts)
 707     goto cleanup;
 708   host_list = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_Host *) * nhostaddrs);
 709   for (host = 0; host < nhosts; host++)
 710     host_list[host] = GNUNET_TESTBED_host_create (hostaddrs[host], NULL, cfg, 0);
 711   *hosts = host_list;
 712
 713  cleanup:
 714   for (host = 0; host < nhosts; host++)
 715     GNUNET_free (hostnames[host]);
 716   GNUNET_free(hostnames);
 717   for (host = 0; (NULL != hostaddrs) && (host < nhostaddrs); host++)
 718     GNUNET_free (hostaddrs[host]);
 719   GNUNET_free (hostaddrs);
 720   return nhosts;
 721 #endif
 722 }
 723
 724
 725 /**
 726  * Destroy a host handle.  Must only be called once everything
 727  * running on that host has been stopped.
 728  *
 729  * @param host handle to destroy
 730  */
 731 void
 732 GNUNET_TESTBED_host_destroy (struct GNUNET_TESTBED_Host *host)
 733 {
 734   struct RegisteredController *rc;
 735   uint32_t id;
 736
 737   GNUNET_assert (host->id < host_list_size);
 738   GNUNET_assert (host_list[host->id] == host);
 739   host_list[host->id] = NULL;
 740   /* clear registered controllers list */
 741   for (rc = host->rc_head; NULL != rc; rc = host->rc_head)
 742   {
 743     GNUNET_CONTAINER_DLL_remove (host->rc_head, host->rc_tail, rc);
 744     GNUNET_free (rc);
 745   }
 746   GNUNET_free_non_null ((char *) host->username);
 747   GNUNET_free_non_null ((char *) host->hostname);
 748   GNUNET_TESTBED_operation_queue_destroy_
 749       (host->opq_parallel_overlay_connect_operations);
 750   GNUNET_TESTBED_SD_destroy_ (host->poc_sd);
 751   GNUNET_free_non_null (host->tslots);
 752   GNUNET_CONFIGURATION_destroy (host->cfg);
 753   GNUNET_free (host);
 754   while (host_list_size >= HOST_LIST_GROW_STEP)
 755   {
 756     for (id = host_list_size - 1; id > host_list_size - HOST_LIST_GROW_STEP;
 757          id--)
 758       if (NULL != host_list[id])
 759         break;
 760     if (id != host_list_size - HOST_LIST_GROW_STEP)
 761       break;
 762     if (NULL != host_list[id])
 763       break;
 764     host_list_size -= HOST_LIST_GROW_STEP;
 765   }
 766   host_list =
 767       GNUNET_realloc (host_list,
 768                       sizeof (struct GNUNET_TESTBED_Host *) * host_list_size);
 769 }
 770
 771
 772 /**
 773  * Marks a host as registered with a controller
 774  *
 775  * @param host the host to mark
 776  * @param controller the controller at which this host is registered
 777  */
 778 void
 779 GNUNET_TESTBED_mark_host_registered_at_ (struct GNUNET_TESTBED_Host *host,
 780                                          const struct GNUNET_TESTBED_Controller
 781                                          *const controller)
 782 {
 783   struct RegisteredController *rc;
 784
 785   for (rc = host->rc_head; NULL != rc; rc = rc->next)
 786   {
 787     if (controller == rc->controller)   /* already registered at controller */
 788     {
 789       GNUNET_break (0);
 790       return;
 791     }
 792   }
 793   rc = GNUNET_malloc (sizeof (struct RegisteredController));
 794   rc->controller = controller;
 795   GNUNET_CONTAINER_DLL_insert_tail (host->rc_head, host->rc_tail, rc);
 796 }
 797
 798
 799 /**
 800  * Unmarks a host registered at a controller
 801  *
 802  * @param host the host to unmark
 803  * @param controller the controller at which this host has to be unmarked
 804  */
 805 void
 806 GNUNET_TESTBED_deregister_host_at_ (struct GNUNET_TESTBED_Host *host,
 807                                     const struct GNUNET_TESTBED_Controller
 808                                     *const controller)
 809 {
 810   struct RegisteredController *rc;
 811
 812   for (rc = host->rc_head; NULL != rc; rc=rc->next)
 813     if (controller == rc->controller)
 814       break;
 815   if (NULL == rc)
 816   {
 817     GNUNET_break (0);
 818     return;
 819   }
 820   GNUNET_CONTAINER_DLL_remove (host->rc_head, host->rc_tail, rc);
 821   GNUNET_free (rc);
 822 }
 823
 824
 825 /**
 826  * Checks whether a host has been registered
 827  *
 828  * @param host the host to check
 829  * @param controller the controller at which host's registration is checked
 830  * @return GNUNET_YES if registered; GNUNET_NO if not
 831  */
 832 int
 833 GNUNET_TESTBED_is_host_registered_ (const struct GNUNET_TESTBED_Host *host,
 834                                     const struct GNUNET_TESTBED_Controller
 835                                     *const controller)
 836 {
 837   struct RegisteredController *rc;
 838
 839   for (rc = host->rc_head; NULL != rc; rc = rc->next)
 840   {
 841     if (controller == rc->controller)   /* already registered at controller */
 842     {
 843       return GNUNET_YES;
 844     }
 845   }
 846   return GNUNET_NO;
 847 }
 848
 849
 850 /**
 851  * Handle for controller process
 852  */
 853 struct GNUNET_TESTBED_ControllerProc
 854 {
 855   /**
 856    * The process handle
 857    */
 858   struct GNUNET_HELPER_Handle *helper;
 859
 860   /**
 861    * The arguments used to start the helper
 862    */
 863   char **helper_argv;
 864
 865   /**
 866    * The host where the helper is run
 867    */
 868   struct GNUNET_TESTBED_Host *host;
 869
 870   /**
 871    * The controller error callback
 872    */
 873   GNUNET_TESTBED_ControllerStatusCallback cb;
 874
 875   /**
 876    * The closure for the above callback
 877    */
 878   void *cls;
 879
 880   /**
 881    * The send handle for the helper
 882    */
 883   struct GNUNET_HELPER_SendHandle *shandle;
 884
 885   /**
 886    * The message corresponding to send handle
 887    */
 888   struct GNUNET_MessageHeader *msg;
 889
 890 };
 891
 892
 893 /**
 894  * Function to copy NULL terminated list of arguments
 895  *
 896  * @param argv the NULL terminated list of arguments. Cannot be NULL.
 897  * @return the copied NULL terminated arguments
 898  */
 899 static char **
 900 copy_argv (const char *const *argv)
 901 {
 902   char **argv_dup;
 903   unsigned int argp;
 904
 905   GNUNET_assert (NULL != argv);
 906   for (argp = 0; NULL != argv[argp]; argp++) ;
 907   argv_dup = GNUNET_malloc (sizeof (char *) * (argp + 1));
 908   for (argp = 0; NULL != argv[argp]; argp++)
 909     argv_dup[argp] = strdup (argv[argp]);
 910   return argv_dup;
 911 }
 912
 913
 914 /**
 915  * Function to join NULL terminated list of arguments
 916  *
 917  * @param argv1 the NULL terminated list of arguments. Cannot be NULL.
 918  * @param argv2 the NULL terminated list of arguments. Cannot be NULL.
 919  * @return the joined NULL terminated arguments
 920  */
 921 static char **
 922 join_argv (const char *const *argv1, const char *const *argv2)
 923 {
 924   char **argvj;
 925   char *argv;
 926   unsigned int carg;
 927   unsigned int cnt;
 928
 929   carg = 0;
 930   argvj = NULL;
 931   for (cnt = 0; NULL != argv1[cnt]; cnt++)
 932   {
 933     argv = GNUNET_strdup (argv1[cnt]);
 934     GNUNET_array_append (argvj, carg, argv);
 935   }
 936   for (cnt = 0; NULL != argv2[cnt]; cnt++)
 937   {
 938     argv = GNUNET_strdup (argv2[cnt]);
 939     GNUNET_array_append (argvj, carg, argv);
 940   }
 941   GNUNET_array_append (argvj, carg, NULL);
 942   return argvj;
 943 }
 944
 945
 946 /**
 947  * Frees the given NULL terminated arguments
 948  *
 949  * @param argv the NULL terminated list of arguments
 950  */
 951 static void
 952 free_argv (char **argv)
 953 {
 954   unsigned int argp;
 955
 956   for (argp = 0; NULL != argv[argp]; argp++)
 957     GNUNET_free (argv[argp]);
 958   GNUNET_free (argv);
 959 }
 960
 961
 962 /**
 963  * Generates arguments for opening a remote shell. Builds up the arguments
 964  * from the environment variable GNUNET_TESTBED_RSH_CMD. The variable
 965  * should not mention `-p' (port) option and destination address as these will
 966  * be set locally in the function from its parameteres. If the environmental
 967  * variable is not found then it defaults to `ssh -o BatchMode=yes -o
 968  * NoHostAuthenticationForLocalhost=yes'
 969  *
 970  * @param port the destination port number
 971  * @param dst the destination address
 972  * @return NULL terminated list of arguments
 973  */
 974 static char **
 975 gen_rsh_args (const char *port, const char *dst)
 976 {
 977   static const char *default_ssh_args[] = {
 978     "ssh",
 979     "-o",
 980     "BatchMode=yes",
 981     "-o",
 982     "NoHostAuthenticationForLocalhost=yes",
 983     NULL
 984   };
 985   char **ssh_args;
 986   char *ssh_cmd;
 987   char *ssh_cmd_cp;
 988   char *arg;
 989   unsigned int cnt;
 990
 991   ssh_args = NULL;
 992   if (NULL != (ssh_cmd = getenv ("GNUNET_TESTBED_RSH_CMD")))
 993   {
 994     ssh_cmd = GNUNET_strdup (ssh_cmd);
 995     ssh_cmd_cp = ssh_cmd;
 996     for (cnt = 0; NULL != (arg = strtok (ssh_cmd, " ")); ssh_cmd = NULL)
 997       GNUNET_array_append (ssh_args, cnt, GNUNET_strdup (arg));
 998     GNUNET_free (ssh_cmd_cp);
 999   }
1000   else
1001   {
1002     ssh_args = copy_argv (default_ssh_args);
1003     cnt = (sizeof (default_ssh_args)) / (sizeof (const char *));
1004     GNUNET_array_grow (ssh_args, cnt, cnt - 1);
1005   }
1006   GNUNET_array_append (ssh_args, cnt, GNUNET_strdup ("-p"));
1007   GNUNET_array_append (ssh_args, cnt, GNUNET_strdup (port));
1008   GNUNET_array_append (ssh_args, cnt, GNUNET_strdup (dst));
1009   GNUNET_array_append (ssh_args, cnt, NULL);
1010   return ssh_args;
1011 }
1012
1013
1014 /**
1015  * Generates the arguments needed for executing the given binary in a remote
1016  * shell. Builds the arguments from the environmental variable
1017  * GNUNET_TETSBED_RSH_CMD_SUFFIX. If the environmental variable is not found,
1018  * only the given binary name will be present in the returned arguments
1019  *
1020  * @param append_args the arguments to append after generating the suffix
1021  *          arguments. Can be NULL; if not must be NULL terminated 'char *' array
1022  * @return NULL-terminated args
1023  */
1024 static char **
1025 gen_rsh_suffix_args (const char * const *append_args)
1026 {
1027   char **rshell_args;
1028   char *rshell_cmd;
1029   char *rshell_cmd_cp;
1030   char *arg;
1031   unsigned int cnt;
1032   unsigned int append_cnt;
1033
1034   rshell_args = NULL;
1035   cnt = 0;
1036   if (NULL != (rshell_cmd = getenv ("GNUNET_TESTBED_RSH_CMD_SUFFIX")))
1037   {
1038     rshell_cmd = GNUNET_strdup (rshell_cmd);
1039     rshell_cmd_cp = rshell_cmd;
1040     for (; NULL != (arg = strtok (rshell_cmd, " ")); rshell_cmd = NULL)
1041       GNUNET_array_append (rshell_args, cnt, GNUNET_strdup (arg));
1042     GNUNET_free (rshell_cmd_cp);
1043   }
1044   if (NULL != append_args)
1045   {
1046     for (append_cnt = 0; NULL != append_args[append_cnt]; append_cnt++)
1047       GNUNET_array_append (rshell_args, cnt, GNUNET_strdup (append_args[append_cnt]));
1048   }
1049   GNUNET_array_append (rshell_args, cnt, NULL);
1050   return rshell_args;
1051 }
1052
1053
1054 /**
1055  * Functions with this signature are called whenever a
1056  * complete message is received by the tokenizer.
1057  *
1058  * Do not call GNUNET_SERVER_mst_destroy in callback
1059  *
1060  * @param cls closure
1061  * @param client identification of the client
1062  * @param message the actual message
1063  *
1064  * @return GNUNET_OK on success, GNUNET_SYSERR to stop further processing
1065  */
1066 static int
1067 helper_mst (void *cls, void *client, const struct GNUNET_MessageHeader *message)
1068 {
1069   struct GNUNET_TESTBED_ControllerProc *cp = cls;
1070   const struct GNUNET_TESTBED_HelperReply *msg;
1071   const char *hostname;
1072   const char *hostip;
1073   char *config;
1074   uLongf config_size;
1075   uLongf xconfig_size;
1076
1077   msg = (const struct GNUNET_TESTBED_HelperReply *) message;
1078   GNUNET_assert (sizeof (struct GNUNET_TESTBED_HelperReply) <
1079                  ntohs (msg->header.size));
1080   GNUNET_assert (GNUNET_MESSAGE_TYPE_TESTBED_HELPER_REPLY ==
1081                  ntohs (msg->header.type));
1082   config_size = (uLongf) ntohs (msg->config_size);
1083   xconfig_size =
1084       (uLongf) (ntohs (msg->header.size) -
1085                 sizeof (struct GNUNET_TESTBED_HelperReply));
1086   config = GNUNET_malloc (config_size);
1087   GNUNET_assert (Z_OK ==
1088                  uncompress ((Bytef *) config, &config_size,
1089                              (const Bytef *) &msg[1], xconfig_size));
1090   /* Replace the configuration template present in the host with the
1091      controller's running configuration */
1092   GNUNET_CONFIGURATION_destroy (cp->host->cfg);
1093   cp->host->cfg = GNUNET_CONFIGURATION_create ();
1094   GNUNET_assert (GNUNET_CONFIGURATION_deserialize
1095                  (cp->host->cfg, config, config_size, GNUNET_NO));
1096   GNUNET_free (config);
1097   if ((NULL == cp->host) ||
1098       (NULL == (hostname = GNUNET_TESTBED_host_get_hostname (cp->host))))
1099     hostname = "localhost";
1100   hostip = simple_resolve (hostname);
1101   if (NULL == hostip)
1102     hostip = "127.0.0.1";
1103   /* Change the hostname so that we can connect to it */
1104   GNUNET_CONFIGURATION_set_value_string (cp->host->cfg, "testbed", "hostname",
1105                                          hostip);
1106   cp->host->locked = GNUNET_NO;
1107   cp->host->controller_started = GNUNET_YES;
1108   cp->cb (cp->cls, cp->host->cfg, GNUNET_OK);
1109   return GNUNET_OK;
1110 }
1111
1112
1113 /**
1114  * Continuation function from GNUNET_HELPER_send()
1115  *
1116  * @param cls closure
1117  * @param result GNUNET_OK on success,
1118  *               GNUNET_NO if helper process died
1119  *               GNUNET_SYSERR during GNUNET_HELPER_stop
1120  */
1121 static void
1122 clear_msg (void *cls, int result)
1123 {
1124   struct GNUNET_TESTBED_ControllerProc *cp = cls;
1125
1126   GNUNET_assert (NULL != cp->shandle);
1127   cp->shandle = NULL;
1128   GNUNET_free (cp->msg);
1129 }
1130
1131
1132 /**
1133  * Callback that will be called when the helper process dies. This is not called
1134  * when the helper process is stoped using GNUNET_HELPER_stop()
1135  *
1136  * @param cls the closure from GNUNET_HELPER_start()
1137  */
1138 static void
1139 helper_exp_cb (void *cls)
1140 {
1141   struct GNUNET_TESTBED_ControllerProc *cp = cls;
1142   GNUNET_TESTBED_ControllerStatusCallback cb;
1143   void *cb_cls;
1144
1145   cb = cp->cb;
1146   cb_cls = cp->cls;
1147   cp->helper = NULL;
1148   GNUNET_TESTBED_controller_stop (cp);
1149   if (NULL != cb)
1150     cb (cb_cls, NULL, GNUNET_SYSERR);
1151 }
1152
1153
1154 /**
1155  * Starts a controller process at the given host.  The given host's configration
1156  * is used as a Template configuration to use for the remote controller; the
1157  * remote controller will be started with a slightly modified configuration
1158  * (port numbers, unix domain sockets and service home values are changed as per
1159  * TESTING library on the remote host).  The modified configuration replaces the
1160  * host's existing configuration before signalling success through the
1161  * GNUNET_TESTBED_ControllerStatusCallback()
1162  *
1163  * @param trusted_ip the ip address of the controller which will be set as TRUSTED
1164  *          HOST(all connections form this ip are permitted by the testbed) when
1165  *          starting testbed controller at host. This can either be a single ip
1166  *          address or a network address in CIDR notation.
1167  * @param host the host where the controller has to be started.  CANNOT be NULL.
1168  * @param cb function called when the controller is successfully started or
1169  *          dies unexpectedly; GNUNET_TESTBED_controller_stop shouldn't be
1170  *          called if cb is called with GNUNET_SYSERR as status. Will never be
1171  *          called in the same task as 'GNUNET_TESTBED_controller_start'
1172  *          (synchronous errors will be signalled by returning NULL). This
1173  *          parameter cannot be NULL.
1174  * @param cls closure for above callbacks
1175  * @return the controller process handle, NULL on errors
1176  */
1177 struct GNUNET_TESTBED_ControllerProc *
1178 GNUNET_TESTBED_controller_start (const char *trusted_ip,
1179                                  struct GNUNET_TESTBED_Host *host,
1180                                  GNUNET_TESTBED_ControllerStatusCallback cb,
1181                                  void *cls)
1182 {
1183   struct GNUNET_TESTBED_ControllerProc *cp;
1184   struct GNUNET_TESTBED_HelperInit *msg;
1185   const struct GNUNET_CONFIGURATION_Handle *cfg;
1186   const char *hostname;
1187   static char *const binary_argv[] = {
1188     HELPER_TESTBED_BINARY, NULL
1189   };
1190
1191   GNUNET_assert (NULL != host);
1192   GNUNET_assert (NULL != (cfg = GNUNET_TESTBED_host_get_cfg_ (host)));
1193   hostname = NULL;
1194   API_VIOLATION (GNUNET_NO == host->locked,
1195                  "Host is already locked by a previous call to GNUNET_TESTBED_controller_start()");
1196   host->locked = GNUNET_YES;
1197   API_VIOLATION (GNUNET_NO == host->controller_started,
1198                  "Attempting to start a controller on a host which is already started a controller");
1199   cp = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_ControllerProc));
1200   if (0 == GNUNET_TESTBED_host_get_id_ (host))
1201   {
1202     cp->helper =
1203         GNUNET_HELPER_start (GNUNET_YES, HELPER_TESTBED_BINARY, binary_argv,
1204                              &helper_mst, &helper_exp_cb, cp);
1205   }
1206   else
1207   {
1208     char *helper_binary_path_args[2];
1209     char **rsh_args;
1210     char **rsh_suffix_args;
1211     const char *username;
1212     char *port;
1213     char *dst;
1214
1215     username = GNUNET_TESTBED_host_get_username_ (host);
1216     hostname = GNUNET_TESTBED_host_get_hostname (host);
1217     GNUNET_asprintf (&port, "%u", GNUNET_TESTBED_host_get_ssh_port_ (host));
1218     if (NULL == username)
1219       GNUNET_asprintf (&dst, "%s", hostname);
1220     else
1221       GNUNET_asprintf (&dst, "%s@%s", username, hostname);
1222     LOG_DEBUG ("Starting SSH to destination %s\n", dst);
1223
1224     if (GNUNET_OK !=
1225         GNUNET_CONFIGURATION_get_value_string (cfg, "testbed",
1226                                                "HELPER_BINARY_PATH",
1227                                                &helper_binary_path_args[0]))
1228       helper_binary_path_args[0] =
1229           GNUNET_OS_get_libexec_binary_path (HELPER_TESTBED_BINARY);
1230     helper_binary_path_args[1] = NULL;
1231     rsh_args = gen_rsh_args (port, dst);
1232     rsh_suffix_args = gen_rsh_suffix_args ((const char **) helper_binary_path_args);
1233     cp->helper_argv =
1234         join_argv ((const char **) rsh_args, (const char **) rsh_suffix_args);
1235     free_argv (rsh_args);
1236     free_argv (rsh_suffix_args);
1237     GNUNET_free (port);
1238     GNUNET_free (dst);
1239     cp->helper =
1240         GNUNET_HELPER_start (GNUNET_NO, cp->helper_argv[0], cp->helper_argv, &helper_mst,
1241                              &helper_exp_cb, cp);
1242     GNUNET_free (helper_binary_path_args[0]);
1243   }
1244   if (NULL == cp->helper)
1245   {
1246     if (NULL != cp->helper_argv)
1247       free_argv (cp->helper_argv);
1248     GNUNET_free (cp);
1249     return NULL;
1250   }
1251   cp->host = host;
1252   cp->cb = cb;
1253   cp->cls = cls;
1254   msg = GNUNET_TESTBED_create_helper_init_msg_ (trusted_ip, hostname, cfg);
1255   cp->msg = &msg->header;
1256   cp->shandle =
1257       GNUNET_HELPER_send (cp->helper, &msg->header, GNUNET_NO, &clear_msg, cp);
1258   if (NULL == cp->shandle)
1259   {
1260     GNUNET_free (msg);
1261     GNUNET_TESTBED_controller_stop (cp);
1262     return NULL;
1263   }
1264   return cp;
1265 }
1266
1267
1268 /**
1269  * Sends termination signal to the controller's helper process
1270  *
1271  * @param cproc the handle to the controller's helper process
1272  */
1273 void
1274 GNUNET_TESTBED_controller_kill_ (struct GNUNET_TESTBED_ControllerProc *cproc)
1275 {
1276   if (NULL != cproc->shandle)
1277     GNUNET_HELPER_send_cancel (cproc->shandle);
1278   if (NULL != cproc->helper)
1279     GNUNET_HELPER_kill (cproc->helper, GNUNET_YES);
1280 }
1281
1282
1283 /**
1284  * Cleans-up the controller's helper process handle
1285  *
1286  * @param cproc the handle to the controller's helper process
1287  */
1288 void
1289 GNUNET_TESTBED_controller_destroy_ (struct GNUNET_TESTBED_ControllerProc *cproc)
1290 {
1291   if (NULL != cproc->helper)
1292   {
1293     GNUNET_break (GNUNET_OK == GNUNET_HELPER_wait (cproc->helper));
1294     GNUNET_HELPER_destroy (cproc->helper);
1295   }
1296   if (NULL != cproc->helper_argv)
1297     free_argv (cproc->helper_argv);
1298   cproc->host->controller_started = GNUNET_NO;
1299   cproc->host->locked = GNUNET_NO;
1300   GNUNET_free (cproc);
1301 }
1302
1303
1304 /**
1305  * Stop the controller process (also will terminate all peers and controllers
1306  * dependent on this controller).  This function blocks until the testbed has
1307  * been fully terminated (!). The controller status cb from
1308  * GNUNET_TESTBED_controller_start() will not be called.
1309  *
1310  * @param cproc the controller process handle
1311  */
1312 void
1313 GNUNET_TESTBED_controller_stop (struct GNUNET_TESTBED_ControllerProc *cproc)
1314 {
1315   GNUNET_TESTBED_controller_kill_ (cproc);
1316   GNUNET_TESTBED_controller_destroy_ (cproc);
1317 }
1318
1319
1320 /**
1321  * The handle for whether a host is habitable or not
1322  */
1323 struct GNUNET_TESTBED_HostHabitableCheckHandle
1324 {
1325   /**
1326    * The host to check
1327    */
1328   const struct GNUNET_TESTBED_Host *host;
1329
1330   /**
1331    * The callback to call once we have the status
1332    */
1333   GNUNET_TESTBED_HostHabitableCallback cb;
1334
1335   /**
1336    * The callback closure
1337    */
1338   void *cb_cls;
1339
1340   /**
1341    * The process handle for the SSH process
1342    */
1343   struct GNUNET_OS_Process *auxp;
1344
1345   /**
1346    * The arguments used to start the helper
1347    */
1348   char **helper_argv;
1349
1350   /**
1351    * Task id for the habitability check task
1352    */
1353   GNUNET_SCHEDULER_TaskIdentifier habitability_check_task;
1354
1355   /**
1356    * How long we wait before checking the process status. Should grow
1357    * exponentially
1358    */
1359   struct GNUNET_TIME_Relative wait_time;
1360
1361 };
1362
1363
1364 /**
1365  * Task for checking whether a host is habitable or not
1366  *
1367  * @param cls GNUNET_TESTBED_HostHabitableCheckHandle
1368  * @param tc the scheduler task context
1369  */
1370 static void
1371 habitability_check (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1372 {
1373   struct GNUNET_TESTBED_HostHabitableCheckHandle *h = cls;
1374   void *cb_cls;
1375   GNUNET_TESTBED_HostHabitableCallback cb;
1376   const struct GNUNET_TESTBED_Host *host;
1377   unsigned long code;
1378   enum GNUNET_OS_ProcessStatusType type;
1379   int ret;
1380
1381   h->habitability_check_task = GNUNET_SCHEDULER_NO_TASK;
1382   ret = GNUNET_OS_process_status (h->auxp, &type, &code);
1383   if (GNUNET_SYSERR == ret)
1384   {
1385     GNUNET_break (0);
1386     ret = GNUNET_NO;
1387     goto call_cb;
1388   }
1389   if (GNUNET_NO == ret)
1390   {
1391     h->wait_time = GNUNET_TIME_STD_BACKOFF (h->wait_time);
1392     h->habitability_check_task =
1393         GNUNET_SCHEDULER_add_delayed (h->wait_time, &habitability_check, h);
1394     return;
1395   }
1396   GNUNET_OS_process_destroy (h->auxp);
1397   h->auxp = NULL;
1398   ret = (0 != code) ? GNUNET_NO : GNUNET_YES;
1399
1400 call_cb:
1401   if (NULL != h->auxp)
1402     GNUNET_OS_process_destroy (h->auxp);
1403   cb = h->cb;
1404   cb_cls = h->cb_cls;
1405   host = h->host;
1406   free_argv (h->helper_argv);
1407   GNUNET_free (h);
1408   if (NULL != cb)
1409     cb (cb_cls, host, ret);
1410 }
1411
1412
1413 /**
1414  * Checks whether a host can be used to start testbed service
1415  *
1416  * @param host the host to check
1417  * @param config the configuration handle to lookup the path of the testbed
1418  *          helper
1419  * @param cb the callback to call to inform about habitability of the given host
1420  * @param cb_cls the closure for the callback
1421  * @return NULL upon any error or a handle which can be passed to
1422  *           GNUNET_TESTBED_is_host_habitable_cancel()
1423  */
1424 struct GNUNET_TESTBED_HostHabitableCheckHandle *
1425 GNUNET_TESTBED_is_host_habitable (const struct GNUNET_TESTBED_Host *host,
1426                                   const struct GNUNET_CONFIGURATION_Handle
1427                                   *config,
1428                                   GNUNET_TESTBED_HostHabitableCallback cb,
1429                                   void *cb_cls)
1430 {
1431   struct GNUNET_TESTBED_HostHabitableCheckHandle *h;
1432   char **rsh_args;
1433   char **rsh_suffix_args;
1434   char *stat_args[3];
1435   const char *hostname;
1436   char *port;
1437   char *dst;
1438
1439   h = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_HostHabitableCheckHandle));
1440   h->cb = cb;
1441   h->cb_cls = cb_cls;
1442   h->host = host;
1443   hostname = (NULL == host->hostname) ? "127.0.0.1" : host->hostname;
1444   if (NULL == host->username)
1445     dst = GNUNET_strdup (hostname);
1446   else
1447     GNUNET_asprintf (&dst, "%s@%s", host->username, hostname);
1448   if (GNUNET_OK !=
1449       GNUNET_CONFIGURATION_get_value_string (config, "testbed",
1450                                              "HELPER_BINARY_PATH",
1451                                              &stat_args[1]))
1452     stat_args[1] =
1453         GNUNET_OS_get_libexec_binary_path (HELPER_TESTBED_BINARY);
1454   GNUNET_asprintf (&port, "%u", host->port);
1455   rsh_args = gen_rsh_args (port, dst);
1456   GNUNET_free (port);
1457   GNUNET_free (dst);
1458   port = NULL;
1459   dst = NULL;
1460   stat_args[0] = "stat";
1461   stat_args[2] = NULL;
1462   rsh_suffix_args = gen_rsh_suffix_args ((const char **) stat_args);
1463   GNUNET_free (stat_args[1]);
1464   h->helper_argv = join_argv ((const char **) rsh_args,
1465                               (const char **) rsh_suffix_args);
1466   free_argv (rsh_suffix_args);
1467   free_argv (rsh_args);
1468   h->auxp =
1469       GNUNET_OS_start_process_vap (GNUNET_NO, GNUNET_OS_INHERIT_STD_ERR, NULL,
1470                                    NULL, h->helper_argv[0], h->helper_argv);
1471   if (NULL == h->auxp)
1472   {
1473     GNUNET_break (0);           /* Cannot exec SSH? */
1474     GNUNET_free (h);
1475     return NULL;
1476   }
1477   h->wait_time = GNUNET_TIME_STD_BACKOFF (h->wait_time);
1478   h->habitability_check_task =
1479       GNUNET_SCHEDULER_add_delayed (h->wait_time, &habitability_check, h);
1480   return h;
1481 }
1482
1483
1484 /**
1485  * Function to cancel a request started using GNUNET_TESTBED_is_host_habitable()
1486  *
1487  * @param handle the habitability check handle
1488  */
1489 void
1490 GNUNET_TESTBED_is_host_habitable_cancel (struct
1491                                          GNUNET_TESTBED_HostHabitableCheckHandle
1492                                          *handle)
1493 {
1494   GNUNET_SCHEDULER_cancel (handle->habitability_check_task);
1495   (void) GNUNET_OS_process_kill (handle->auxp, SIGTERM);
1496   (void) GNUNET_OS_process_wait (handle->auxp);
1497   GNUNET_OS_process_destroy (handle->auxp);
1498   free_argv (handle->helper_argv);
1499   GNUNET_free (handle);
1500 }
1501
1502
1503 /**
1504  * handle for host registration
1505  */
1506 struct GNUNET_TESTBED_HostRegistrationHandle
1507 {
1508   /**
1509    * The host being registered
1510    */
1511   struct GNUNET_TESTBED_Host *host;
1512
1513   /**
1514    * The controller at which this host is being registered
1515    */
1516   struct GNUNET_TESTBED_Controller *c;
1517
1518   /**
1519    * The Registartion completion callback
1520    */
1521   GNUNET_TESTBED_HostRegistrationCompletion cc;
1522
1523   /**
1524    * The closure for above callback
1525    */
1526   void *cc_cls;
1527 };
1528
1529
1530 /**
1531  * Register a host with the controller
1532  *
1533  * @param controller the controller handle
1534  * @param host the host to register
1535  * @param cc the completion callback to call to inform the status of
1536  *          registration. After calling this callback the registration handle
1537  *          will be invalid. Cannot be NULL.
1538  * @param cc_cls the closure for the cc
1539  * @return handle to the host registration which can be used to cancel the
1540  *           registration
1541  */
1542 struct GNUNET_TESTBED_HostRegistrationHandle *
1543 GNUNET_TESTBED_register_host (struct GNUNET_TESTBED_Controller *controller,
1544                               struct GNUNET_TESTBED_Host *host,
1545                               GNUNET_TESTBED_HostRegistrationCompletion cc,
1546                               void *cc_cls)
1547 {
1548   struct GNUNET_TESTBED_HostRegistrationHandle *rh;
1549   struct GNUNET_TESTBED_AddHostMessage *msg;
1550   const char *username;
1551   const char *hostname;
1552   char *config;
1553   char *cconfig;
1554   void *ptr;
1555   size_t cc_size;
1556   size_t config_size;
1557   uint16_t msg_size;
1558   uint16_t username_length;
1559   uint16_t hostname_length;
1560
1561   if (NULL != controller->rh)
1562     return NULL;
1563   hostname = GNUNET_TESTBED_host_get_hostname (host);
1564   if (GNUNET_YES == GNUNET_TESTBED_is_host_registered_ (host, controller))
1565   {
1566     LOG (GNUNET_ERROR_TYPE_WARNING, "Host hostname: %s already registered\n",
1567          (NULL == hostname) ? "localhost" : hostname);
1568     return NULL;
1569   }
1570   rh = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_HostRegistrationHandle));
1571   rh->host = host;
1572   rh->c = controller;
1573   GNUNET_assert (NULL != cc);
1574   rh->cc = cc;
1575   rh->cc_cls = cc_cls;
1576   controller->rh = rh;
1577   username = GNUNET_TESTBED_host_get_username_ (host);
1578   username_length = 0;
1579   if (NULL != username)
1580     username_length = strlen (username);
1581   GNUNET_assert (NULL != hostname); /* Hostname must be present */
1582   hostname_length = strlen (hostname);
1583   GNUNET_assert (NULL != host->cfg);
1584   config = GNUNET_CONFIGURATION_serialize (host->cfg, &config_size);
1585   cc_size = GNUNET_TESTBED_compress_config_ (config, config_size, &cconfig);
1586   GNUNET_free (config);
1587   msg_size = (sizeof (struct GNUNET_TESTBED_AddHostMessage));
1588   msg_size += username_length;
1589   msg_size += hostname_length;
1590   msg_size += cc_size;
1591   msg = GNUNET_malloc (msg_size);
1592   msg->header.size = htons (msg_size);
1593   msg->header.type = htons (GNUNET_MESSAGE_TYPE_TESTBED_ADD_HOST);
1594   msg->host_id = htonl (GNUNET_TESTBED_host_get_id_ (host));
1595   msg->ssh_port = htons (GNUNET_TESTBED_host_get_ssh_port_ (host));
1596   ptr = &msg[1];
1597   if (NULL != username)
1598   {
1599     msg->username_length = htons (username_length);
1600     ptr = memcpy (ptr, username, username_length);
1601     ptr += username_length;
1602   }
1603   msg->hostname_length = htons (hostname_length);
1604   ptr = memcpy (ptr, hostname, hostname_length);
1605   ptr += hostname_length;
1606   msg->config_size = htons (config_size);
1607   ptr = memcpy (ptr, cconfig, cc_size);
1608   ptr += cc_size;
1609   GNUNET_assert ((ptr - (void *) msg) == msg_size);
1610   GNUNET_free (cconfig);
1611   GNUNET_TESTBED_queue_message_ (controller,
1612                                  (struct GNUNET_MessageHeader *) msg);
1613   return rh;
1614 }
1615
1616
1617 /**
1618  * Cancel the pending registration. Note that if the registration message is
1619  * already sent to the service the cancellation has only the effect that the
1620  * registration completion callback for the registration is never called.
1621  *
1622  * @param handle the registration handle to cancel
1623  */
1624 void
1625 GNUNET_TESTBED_cancel_registration (struct GNUNET_TESTBED_HostRegistrationHandle
1626                                     *handle)
1627 {
1628   if (handle != handle->c->rh)
1629   {
1630     GNUNET_break (0);
1631     return;
1632   }
1633   handle->c->rh = NULL;
1634   GNUNET_free (handle);
1635 }
1636
1637
1638 /**
1639  * Initializes the operation queue for parallel overlay connects
1640  *
1641  * @param h the host handle
1642  * @param npoc the number of parallel overlay connects - the queue size
1643  */
1644 void
1645 GNUNET_TESTBED_set_num_parallel_overlay_connects_ (struct
1646                                                    GNUNET_TESTBED_Host *h,
1647                                                    unsigned int npoc)
1648 {
1649   //fprintf (stderr, "%d", npoc);
1650   GNUNET_free_non_null (h->tslots);
1651   h->tslots_filled = 0;
1652   h->num_parallel_connects = npoc;
1653   h->tslots = GNUNET_malloc (npoc * sizeof (struct TimeSlot));
1654   GNUNET_TESTBED_operation_queue_reset_max_active_
1655       (h->opq_parallel_overlay_connect_operations, npoc);
1656 }
1657
1658
1659 /**
1660  * Returns a timing slot which will be exclusively locked
1661  *
1662  * @param h the host handle
1663  * @param key a pointer which is associated to the returned slot; should not be
1664  *          NULL. It serves as a key to determine the correct owner of the slot
1665  * @return the time slot index in the array of time slots in the controller
1666  *           handle
1667  */
1668 unsigned int
1669 GNUNET_TESTBED_get_tslot_ (struct GNUNET_TESTBED_Host *h, void *key)
1670 {
1671   unsigned int slot;
1672
1673   GNUNET_assert (NULL != h->tslots);
1674   GNUNET_assert (NULL != key);
1675   for (slot = 0; slot < h->num_parallel_connects; slot++)
1676     if (NULL == h->tslots[slot].key)
1677     {
1678       h->tslots[slot].key = key;
1679       return slot;
1680     }
1681   GNUNET_assert (0);            /* We should always find a free tslot */
1682 }
1683
1684
1685 /**
1686  * Decides whether any change in the number of parallel overlay connects is
1687  * necessary to adapt to the load on the system
1688  *
1689  * @param h the host handle
1690  */
1691 static void
1692 decide_npoc (struct GNUNET_TESTBED_Host *h)
1693 {
1694   struct GNUNET_TIME_Relative avg;
1695   int sd;
1696   unsigned int slot;
1697   unsigned int nvals;
1698
1699   if (h->tslots_filled != h->num_parallel_connects)
1700     return;
1701   avg = GNUNET_TIME_UNIT_ZERO;
1702   nvals = 0;
1703   for (slot = 0; slot < h->num_parallel_connects; slot++)
1704   {
1705     avg = GNUNET_TIME_relative_add (avg, h->tslots[slot].time);
1706     nvals += h->tslots[slot].nvals;
1707   }
1708   GNUNET_assert (nvals >= h->num_parallel_connects);
1709   avg = GNUNET_TIME_relative_divide (avg, nvals);
1710   GNUNET_assert (GNUNET_TIME_UNIT_FOREVER_REL.rel_value != avg.rel_value);
1711   sd = GNUNET_TESTBED_SD_deviation_factor_ (h->poc_sd, (unsigned int) avg.rel_value);
1712   if ( (sd <= 5) ||
1713        (0 == GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK,
1714                                        h->num_parallel_connects)) )
1715     GNUNET_TESTBED_SD_add_data_ (h->poc_sd, (unsigned int) avg.rel_value);
1716   if (GNUNET_SYSERR == sd)
1717   {
1718     GNUNET_TESTBED_set_num_parallel_overlay_connects_ (h,
1719                                                        h->num_parallel_connects);
1720     return;
1721   }
1722   GNUNET_assert (0 <= sd);
1723   if (0 == sd)
1724   {
1725     GNUNET_TESTBED_set_num_parallel_overlay_connects_ (h,
1726                                                        h->num_parallel_connects
1727                                                        * 2);
1728     return;
1729   }
1730   if (1 == sd)
1731   {
1732     GNUNET_TESTBED_set_num_parallel_overlay_connects_ (h,
1733                                                        h->num_parallel_connects
1734                                                        + 1);
1735     return;
1736   }
1737   if (1 == h->num_parallel_connects)
1738   {
1739     GNUNET_TESTBED_set_num_parallel_overlay_connects_ (h, 1);
1740     return;
1741   }
1742   if (2 == sd)
1743   {
1744     GNUNET_TESTBED_set_num_parallel_overlay_connects_ (h,
1745                                                        h->num_parallel_connects
1746                                                        - 1);
1747     return;
1748   }
1749   GNUNET_TESTBED_set_num_parallel_overlay_connects_ (h,
1750                                                      h->num_parallel_connects /
1751                                                      2);
1752 }
1753
1754
1755 /**
1756  * Releases a time slot thus making it available for be used again
1757  *
1758  * @param h the host handle
1759  * @param index the index of the the time slot
1760  * @param key the key to prove ownership of the timeslot
1761  * @return GNUNET_YES if the time slot is successfully removed; GNUNET_NO if the
1762  *           time slot cannot be removed - this could be because of the index
1763  *           greater than existing number of time slots or `key' being different
1764  */
1765 int
1766 GNUNET_TESTBED_release_time_slot_ (struct GNUNET_TESTBED_Host *h,
1767                                    unsigned int index, void *key)
1768 {
1769   struct TimeSlot *slot;
1770
1771   GNUNET_assert (NULL != key);
1772   if (index >= h->num_parallel_connects)
1773     return GNUNET_NO;
1774   slot = &h->tslots[index];
1775   if (key != slot->key)
1776     return GNUNET_NO;
1777   slot->key = NULL;
1778   return GNUNET_YES;
1779 }
1780
1781
1782 /**
1783  * Function to update a time slot
1784  *
1785  * @param h the host handle
1786  * @param index the index of the time slot to update
1787  * @param key the key to identify ownership of the slot
1788  * @param time the new time
1789  * @param failed should this reading be treated as coming from a fail event
1790  */
1791 void
1792 GNUNET_TESTBED_update_time_slot_ (struct GNUNET_TESTBED_Host *h,
1793                                   unsigned int index, void *key,
1794                                   struct GNUNET_TIME_Relative time, int failed)
1795 {
1796   struct TimeSlot *slot;
1797
1798   if (GNUNET_YES == failed)
1799   {
1800     if (1 == h->num_parallel_connects)
1801     {
1802       GNUNET_TESTBED_set_num_parallel_overlay_connects_ (h, 1);
1803       return;
1804     }
1805     GNUNET_TESTBED_set_num_parallel_overlay_connects_ (h,
1806                                                        h->num_parallel_connects
1807                                                        - 1);
1808   }
1809   if (GNUNET_NO == GNUNET_TESTBED_release_time_slot_ (h, index, key))
1810     return;
1811   slot = &h->tslots[index];
1812   slot->nvals++;
1813   if (GNUNET_TIME_UNIT_ZERO.rel_value == slot->time.rel_value)
1814   {
1815     slot->time = time;
1816     h->tslots_filled++;
1817     decide_npoc (h);
1818     return;
1819   }
1820   slot->time = GNUNET_TIME_relative_add (slot->time, time);
1821 }
1822
1823
1824 /**
1825  * Queues the given operation in the queue for parallel overlay connects of the
1826  * given host
1827  *
1828  * @param h the host handle
1829  * @param op the operation to queue in the given host's parally overlay connect
1830  *          queue
1831  */
1832 void
1833 GNUNET_TESTBED_host_queue_oc_ (struct GNUNET_TESTBED_Host *h,
1834                                struct GNUNET_TESTBED_Operation *op)
1835 {
1836   GNUNET_TESTBED_operation_queue_insert_
1837       (h->opq_parallel_overlay_connect_operations, op);
1838 }
1839
1840
1841 /**
1842  * Handler for GNUNET_MESSAGE_TYPE_TESTBED_ADDHOSTCONFIRM message from
1843  * controller (testbed service)
1844  *
1845  * @param c the controller handler
1846  * @param msg message received
1847  * @return GNUNET_YES if we can continue receiving from service; GNUNET_NO if
1848  *           not
1849  */
1850 int
1851 GNUNET_TESTBED_host_handle_addhostconfirm_ (struct GNUNET_TESTBED_Controller *c,
1852                                             const struct
1853                                             GNUNET_TESTBED_HostConfirmedMessage
1854                                             *msg)
1855 {
1856   struct GNUNET_TESTBED_HostRegistrationHandle *rh;
1857   char *emsg;
1858   uint16_t msg_size;
1859
1860   rh = c->rh;
1861   if (NULL == rh)
1862   {
1863     return GNUNET_OK;
1864   }
1865   if (GNUNET_TESTBED_host_get_id_ (rh->host) != ntohl (msg->host_id))
1866   {
1867     LOG_DEBUG ("Mismatch in host id's %u, %u of host confirm msg\n",
1868                GNUNET_TESTBED_host_get_id_ (rh->host), ntohl (msg->host_id));
1869     return GNUNET_OK;
1870   }
1871   c->rh = NULL;
1872   msg_size = ntohs (msg->header.size);
1873   if (sizeof (struct GNUNET_TESTBED_HostConfirmedMessage) == msg_size)
1874   {
1875     LOG_DEBUG ("Host %u successfully registered\n", ntohl (msg->host_id));
1876     GNUNET_TESTBED_mark_host_registered_at_ (rh->host, c);
1877     rh->cc (rh->cc_cls, NULL);
1878     GNUNET_free (rh);
1879     return GNUNET_OK;
1880   }
1881   /* We have an error message */
1882   emsg = (char *) &msg[1];
1883   if ('\0' !=
1884       emsg[msg_size - sizeof (struct GNUNET_TESTBED_HostConfirmedMessage)])
1885   {
1886     GNUNET_break (0);
1887     GNUNET_free (rh);
1888     return GNUNET_NO;
1889   }
1890   LOG (GNUNET_ERROR_TYPE_ERROR, _("Adding host %u failed with error: %s\n"),
1891        ntohl (msg->host_id), emsg);
1892   rh->cc (rh->cc_cls, emsg);
1893   GNUNET_free (rh);
1894   return GNUNET_OK;
1895 }
1896
1897 /* end of testbed_api_hosts.c */