src/testbed/testbed_api_hosts.c

   1 /*
   2       This file is part of GNUnet
   3       (C) 2008--2012 Christian Grothoff (and other contributing authors)
   4
   5       GNUnet is free software; you can redistribute it and/or modify
   6       it under the terms of the GNU General Public License as published
   7       by the Free Software Foundation; either version 3, or (at your
   8       option) any later version.
   9
  10       GNUnet is distributed in the hope that it will be useful, but
  11       WITHOUT ANY WARRANTY; without even the implied warranty of
  12       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13       General Public License for more details.
  14
  15       You should have received a copy of the GNU General Public License
  16       along with GNUnet; see the file COPYING.  If not, write to the
  17       Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18       Boston, MA 02111-1307, USA.
  19  */
  20
  21 /**
  22  * @file testbed/testbed_api_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_testbed_service.h"
  30 #include "gnunet_core_service.h"
  31 #include "gnunet_constants.h"
  32 #include "gnunet_transport_service.h"
  33 #include "gnunet_hello_lib.h"
  34 #include "gnunet_container_lib.h"
  35
  36 /**
  37  * Generic logging shorthand
  38  */
  39 #define LOG(kind, ...)                          \
  40   GNUNET_log_from (kind, "testbed-api-hosts", __VA_ARGS__);
  41
  42 /**
  43  * Number of extra elements we create space for when we grow host list
  44  */
  45 #define HOST_LIST_GROW_STEP 10
  46
  47
  48 /**
  49  * A list entry for registered controllers list
  50  */
  51 struct RegisteredController
  52 {
  53   /**
  54    * The controller at which this host is registered
  55    */
  56   const struct GNUNET_TESTBED_Controller *controller;
  57
  58   /**
  59    * The next ptr for DLL
  60    */
  61   struct RegisteredController *next;
  62
  63   /**
  64    * The prev ptr for DLL
  65    */
  66   struct RegisteredController *prev;
  67 };
  68
  69
  70 /**
  71  * Opaque handle to a host running experiments managed by the testing framework.
  72  * The master process must be able to SSH to this host without password (via
  73  * ssh-agent).
  74  */
  75 struct GNUNET_TESTBED_Host
  76 {
  77
  78   /**
  79    * The next pointer for DLL
  80    */
  81   struct GNUNET_TESTBED_Host *next;
  82
  83   /**
  84    * The prev pointer for DLL
  85    */
  86   struct GNUNET_TESTBED_Host *prev;
  87
  88   /**
  89    * The hostname of the host; NULL for localhost
  90    */
  91   const char *hostname;
  92
  93   /**
  94    * The username to be used for SSH login
  95    */
  96   const char *username;
  97
  98   /**
  99    * The head for the list of controllers where this host is registered
 100    */
 101   struct RegisteredController *rc_head;
 102
 103   /**
 104    * The tail for the list of controllers where this host is registered
 105    */
 106   struct RegisteredController *rc_tail;
 107
 108   /**
 109    * Global ID we use to refer to a host on the network
 110    */
 111   uint32_t id;
 112
 113   /**
 114    * The port which is to be used for SSH
 115    */
 116   uint16_t port;
 117
 118 };
 119
 120
 121 /**
 122  * Array of available hosts
 123  */
 124 static struct GNUNET_TESTBED_Host **host_list;
 125
 126 /**
 127  * The size of the available hosts list
 128  */
 129 static uint32_t host_list_size;
 130
 131
 132 /**
 133  * Lookup a host by ID.
 134  *
 135  * @param id global host ID assigned to the host; 0 is
 136  *        reserved to always mean 'localhost'
 137  * @return handle to the host, NULL if host not found
 138  */
 139 struct GNUNET_TESTBED_Host *
 140 GNUNET_TESTBED_host_lookup_by_id_ (uint32_t id)
 141 {
 142   if (host_list_size <= id)
 143     return NULL;
 144   return host_list[id];
 145 }
 146
 147
 148 /**
 149  * Create a host by ID; given this host handle, we could not
 150  * run peers at the host, but we can talk about the host
 151  * internally.
 152  *
 153  * @param id global host ID assigned to the host; 0 is
 154  *        reserved to always mean 'localhost'
 155  * @return handle to the host, NULL on error
 156  */
 157 struct GNUNET_TESTBED_Host *
 158 GNUNET_TESTBED_host_create_by_id_ (uint32_t id)
 159 {
 160   return GNUNET_TESTBED_host_create_with_id (id, NULL, NULL, 0);
 161 }
 162
 163
 164 /**
 165  * Obtain the host's unique global ID.
 166  *
 167  * @param host handle to the host, NULL means 'localhost'
 168  * @return id global host ID assigned to the host (0 is
 169  *         'localhost', but then obviously not globally unique)
 170  */
 171 uint32_t
 172 GNUNET_TESTBED_host_get_id_ (const struct GNUNET_TESTBED_Host *host)
 173 {
 174   return host->id;
 175 }
 176
 177
 178 /**
 179  * Obtain the host's hostname.
 180  *
 181  * @param host handle to the host, NULL means 'localhost'
 182  * @return hostname of the host
 183  */
 184 const char *
 185 GNUNET_TESTBED_host_get_hostname_ (const struct GNUNET_TESTBED_Host *host)
 186 {
 187   return host->hostname;
 188 }
 189
 190
 191 /**
 192  * Obtain the host's username
 193  *
 194  * @param host handle to the host, NULL means 'localhost'
 195  * @return username to login to the host
 196  */
 197 const char *
 198 GNUNET_TESTBED_host_get_username_ (const struct GNUNET_TESTBED_Host *host)
 199 {
 200   return host->username;
 201 }
 202
 203
 204 /**
 205  * Obtain the host's ssh port
 206  *
 207  * @param host handle to the host, NULL means 'localhost'
 208  * @return username to login to the host
 209  */
 210 uint16_t
 211 GNUNET_TESTBED_host_get_ssh_port_ (const struct GNUNET_TESTBED_Host *host)
 212 {
 213   return host->port;
 214 }
 215
 216
 217 /**
 218  * Create a host to run peers and controllers on.
 219  *
 220  * @param id global host ID assigned to the host; 0 is
 221  *        reserved to always mean 'localhost'
 222  * @param hostname name of the host, use "NULL" for localhost
 223  * @param username username to use for the login; may be NULL
 224  * @param port port number to use for ssh; use 0 to let ssh decide
 225  * @return handle to the host, NULL on error
 226  */
 227 struct GNUNET_TESTBED_Host *
 228 GNUNET_TESTBED_host_create_with_id (uint32_t id,
 229                                     const char *hostname,
 230                                     const char *username,
 231                                     uint16_t port)
 232 {
 233   struct GNUNET_TESTBED_Host *host;
 234
 235   if ((id < host_list_size) && (NULL != host_list[host_list_size]))
 236   {
 237     LOG (GNUNET_ERROR_TYPE_WARNING, "Host with id: %u already created\n");
 238     return NULL;
 239   }
 240   host = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_Host));
 241   host->hostname = hostname;
 242   host->username = username;
 243   host->id = id;
 244   host->port = (0 == port) ? 22 : port;
 245   if (id < host_list_size)
 246   {
 247     host_list_size += HOST_LIST_GROW_STEP;
 248     host_list = GNUNET_realloc (host_list, sizeof (struct GNUNET_TESTBED_Host)
 249                                 * host_list_size);
 250   }
 251   host_list[id] = host;
 252   return host;
 253 }
 254
 255
 256 /**
 257  * Create a host to run peers and controllers on.
 258  *
 259  * @param hostname name of the host, use "NULL" for localhost
 260  * @param username username to use for the login; may be NULL
 261  * @param port port number to use for ssh; use 0 to let ssh decide
 262  * @return handle to the host, NULL on error
 263  */
 264 struct GNUNET_TESTBED_Host *
 265 GNUNET_TESTBED_host_create (const char *hostname,
 266                             const char *username,
 267                             uint16_t port)
 268 {
 269   static uint32_t uid_generator;
 270
 271   if (NULL == hostname)
 272     return GNUNET_TESTBED_host_create_with_id (0, hostname, username, port);
 273   return GNUNET_TESTBED_host_create_with_id (++uid_generator,
 274                                              hostname, username,
 275                                              port);
 276 }
 277
 278
 279 /**
 280  * Load a set of hosts from a configuration file.
 281  *
 282  * @param filename file with the host specification
 283  * @param hosts set to the hosts found in the file
 284  * @return number of hosts returned in 'hosts', 0 on error
 285  */
 286 unsigned int
 287 GNUNET_TESTBED_hosts_load_from_file (const char *filename,
 288                                      struct GNUNET_TESTBED_Host **hosts)
 289 {
 290   // see testing_group.c, GNUNET_TESTING_hosts_load
 291   GNUNET_break (0);
 292   return 0;
 293 }
 294
 295
 296 /**
 297  * Destroy a host handle.  Must only be called once everything
 298  * running on that host has been stopped.
 299  *
 300  * @param host handle to destroy
 301  */
 302 void
 303 GNUNET_TESTBED_host_destroy (struct GNUNET_TESTBED_Host *host)
 304 {
 305   struct RegisteredController *rc;
 306   uint32_t id;
 307
 308   GNUNET_assert (host->id < host_list_size);
 309   GNUNET_assert (host_list[host->id] == host);
 310   host_list[host->id] = NULL;
 311   /* clear registered controllers list */
 312   for (rc=host->rc_head; NULL != rc; rc=host->rc_head)
 313   {
 314     GNUNET_CONTAINER_DLL_remove (host->rc_head, host->rc_tail, rc);
 315     GNUNET_free (rc);
 316   }
 317   for (id = 0; id < HOST_LIST_GROW_STEP; id++)
 318   {
 319     if ((host->id + id >= host_list_size) || (NULL != host_list[host->id + id]))
 320       break;
 321   }
 322   if (HOST_LIST_GROW_STEP == id)
 323   {
 324     host_list_size -= HOST_LIST_GROW_STEP;
 325     host_list = GNUNET_realloc (host_list, host_list_size);
 326   }
 327   GNUNET_free (host);
 328 }
 329
 330
 331 /**
 332  * Wrapper around GNUNET_HELPER_Handle
 333  */
 334 struct GNUNET_TESTBED_HelperHandle
 335 {
 336   /**
 337    * The process handle
 338    */
 339   struct GNUNET_OS_Process *process;
 340
 341   /**
 342    * Pipe connecting to stdin of the process.
 343    */
 344   struct GNUNET_DISK_PipeHandle *cpipe;
 345
 346   /**
 347    * The port number for ssh; used for helpers starting ssh
 348    */
 349   char *port;
 350
 351   /**
 352    * The ssh destination string; used for helpers starting ssh
 353    */
 354   char *dst;
 355 };
 356
 357
 358 /**
 359  * Run a given helper process at the given host.  Communication
 360  * with the helper will be via GNUnet messages on stdin/stdout.
 361  * Runs the process via 'ssh' at the specified host, or locally.
 362  * Essentially an SSH-wrapper around the 'gnunet_helper_lib.h' API.
 363  *
 364  * @param host host to use, use "NULL" for localhost
 365  * @param binary_argv binary name and command-line arguments to give to the binary
 366  * @return handle to terminate the command, NULL on error
 367  */
 368 struct GNUNET_TESTBED_HelperHandle *
 369 GNUNET_TESTBED_host_run_ (const struct GNUNET_TESTBED_Host *host,
 370                           char *const binary_argv[])
 371 {
 372   struct GNUNET_TESTBED_HelperHandle *h;
 373   unsigned int argc;
 374
 375   argc = 0;
 376   while (NULL != binary_argv[argc])
 377     argc++;
 378   h = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_HelperHandle));
 379   h->cpipe = GNUNET_DISK_pipe (GNUNET_NO, GNUNET_NO, GNUNET_YES, GNUNET_NO);
 380   if ((NULL == host) || (0 == host->id))
 381   {
 382     h->process = GNUNET_OS_start_process_vap (GNUNET_YES,
 383                                               h->cpipe, NULL,
 384                                               "gnunet-service-testbed",
 385                                               binary_argv);
 386   }
 387   else
 388   {
 389     char *remote_args[argc + 6 + 1];
 390     unsigned int argp;
 391
 392     GNUNET_asprintf (&h->port, "%d", host->port);
 393     if (NULL == host->username)
 394       GNUNET_asprintf (&h->dst, "%s", host->hostname);
 395     else
 396       GNUNET_asprintf (&h->dst, "%s@%s", host->hostname, host->username);
 397     argp = 0;
 398     remote_args[argp++] = "ssh";
 399     remote_args[argp++] = "-p";
 400     remote_args[argp++] = h->port;
 401     remote_args[argp++] = "-q";
 402     remote_args[argp++] = h->dst;
 403     remote_args[argp++] = "gnunet-service-testbed";
 404     while (NULL != binary_argv[argp-6])
 405     {
 406       remote_args[argp] = binary_argv[argp - 6];
 407       argp++;
 408     }
 409     remote_args[argp++] = NULL;
 410     GNUNET_assert (argp == argc + 6 + 1);
 411     h->process = GNUNET_OS_start_process_vap (GNUNET_YES,
 412                                               h->cpipe, NULL,
 413                                               "ssh",
 414                                               remote_args);
 415   }
 416   if (NULL == h->process)
 417   {
 418     GNUNET_break (GNUNET_OK == GNUNET_DISK_pipe_close (h->cpipe));
 419     GNUNET_free_non_null (h->port);
 420     GNUNET_free_non_null (h->dst);
 421     GNUNET_free (h);
 422     return NULL;
 423   }
 424   GNUNET_break (GNUNET_OK == GNUNET_DISK_pipe_close_end (h->cpipe, GNUNET_DISK_PIPE_END_READ));
 425   return h;
 426 }
 427
 428
 429 /**
 430  * Stops a helper in the HelperHandle using GNUNET_HELPER_stop
 431  *
 432  * @param handle the handle returned from GNUNET_TESTBED_host_start_
 433  */
 434 void
 435 GNUNET_TESTBED_host_stop_ (struct GNUNET_TESTBED_HelperHandle *handle)
 436 {
 437   GNUNET_break (GNUNET_OK == GNUNET_DISK_pipe_close (handle->cpipe));
 438   GNUNET_break (0 == GNUNET_OS_process_kill (handle->process, SIGTERM));
 439   GNUNET_break (GNUNET_OK == GNUNET_OS_process_wait (handle->process));
 440   GNUNET_OS_process_destroy (handle->process);
 441   GNUNET_free_non_null (handle->port);
 442   GNUNET_free_non_null (handle->dst);
 443   GNUNET_free (handle);
 444 }
 445
 446
 447 /**
 448  * Marks a host as registered with a controller
 449  *
 450  * @param host the host to mark
 451  * @param controller the controller at which this host is registered
 452  */
 453 void
 454 GNUNET_TESTBED_mark_host_registered_at_ (struct GNUNET_TESTBED_Host *host,
 455                                          const struct GNUNET_TESTBED_Controller
 456                                          * const controller)
 457 {
 458   struct RegisteredController *rc;
 459
 460   for (rc=host->rc_head; NULL != rc; rc=rc->next)
 461   {
 462     if (controller == rc->controller) /* already registered at controller */
 463     {
 464       GNUNET_break (0);
 465       return;
 466     }
 467   }
 468   rc = GNUNET_malloc (sizeof (struct RegisteredController));
 469   rc->controller = controller;
 470   //host->controller = controller;
 471   GNUNET_CONTAINER_DLL_insert_tail (host->rc_head, host->rc_tail, rc);
 472 }
 473
 474
 475 /**
 476  * Checks whether a host has been registered
 477  *
 478  * @param host the host to check
 479  * @param controller the controller at which host's registration is checked
 480  * @return GNUNET_YES if registered; GNUNET_NO if not
 481  */
 482 int
 483 GNUNET_TESTBED_is_host_registered_ (const struct GNUNET_TESTBED_Host *host,
 484                                     const struct GNUNET_TESTBED_Controller
 485                                     *const controller)
 486 {
 487   struct RegisteredController *rc;
 488
 489   for (rc=host->rc_head; NULL != rc; rc=rc->next)
 490   {
 491     if (controller == rc->controller) /* already registered at controller */
 492     {
 493       return GNUNET_YES;
 494     }
 495   }
 496   return GNUNET_NO;
 497 }
 498
 499
 500 /* end of testbed_api_hosts.c */