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_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
  37 /**
  38  * Generic logging shorthand
  39  */
  40 #define LOG(kind, ...)                          \
  41   GNUNET_log_from (kind, "testbed-api-hosts", __VA_ARGS__);
  42
  43 /**
  44  * Number of extra elements we create space for when we grow host list
  45  */
  46 #define HOST_LIST_GROW_STEP 10
  47
  48
  49 /**
  50  * A list entry for registered controllers list
  51  */
  52 struct RegisteredController
  53 {
  54   /**
  55    * The controller at which this host is registered
  56    */
  57   const struct GNUNET_TESTBED_Controller *controller;
  58
  59   /**
  60    * The next ptr for DLL
  61    */
  62   struct RegisteredController *next;
  63
  64   /**
  65    * The prev ptr for DLL
  66    */
  67   struct RegisteredController *prev;
  68 };
  69
  70
  71 /**
  72  * Opaque handle to a host running experiments managed by the testing framework.
  73  * The master process must be able to SSH to this host without password (via
  74  * ssh-agent).
  75  */
  76 struct GNUNET_TESTBED_Host
  77 {
  78
  79   /**
  80    * The next pointer for DLL
  81    */
  82   struct GNUNET_TESTBED_Host *next;
  83
  84   /**
  85    * The prev pointer for DLL
  86    */
  87   struct GNUNET_TESTBED_Host *prev;
  88
  89   /**
  90    * The hostname of the host; NULL for localhost
  91    */
  92   const char *hostname;
  93
  94   /**
  95    * The username to be used for SSH login
  96    */
  97   const char *username;
  98
  99   /**
 100    * The head for the list of controllers where this host is registered
 101    */
 102   struct RegisteredController *rc_head;
 103
 104   /**
 105    * The tail for the list of controllers where this host is registered
 106    */
 107   struct RegisteredController *rc_tail;
 108
 109   /**
 110    * Global ID we use to refer to a host on the network
 111    */
 112   uint32_t id;
 113
 114   /**
 115    * The port which is to be used for SSH
 116    */
 117   uint16_t port;
 118
 119 };
 120
 121
 122 /**
 123  * Array of available hosts
 124  */
 125 static struct GNUNET_TESTBED_Host **host_list;
 126
 127 /**
 128  * The size of the available hosts list
 129  */
 130 static uint32_t host_list_size;
 131
 132
 133 /**
 134  * Lookup a host by ID.
 135  *
 136  * @param id global host ID assigned to the host; 0 is
 137  *        reserved to always mean 'localhost'
 138  * @return handle to the host, NULL if host not found
 139  */
 140 struct GNUNET_TESTBED_Host *
 141 GNUNET_TESTBED_host_lookup_by_id_ (uint32_t id)
 142 {
 143   if (host_list_size <= id)
 144     return NULL;
 145   return host_list[id];
 146 }
 147
 148
 149 /**
 150  * Create a host by ID; given this host handle, we could not
 151  * run peers at the host, but we can talk about the host
 152  * internally.
 153  *
 154  * @param id global host ID assigned to the host; 0 is
 155  *        reserved to always mean 'localhost'
 156  * @return handle to the host, NULL on error
 157  */
 158 struct GNUNET_TESTBED_Host *
 159 GNUNET_TESTBED_host_create_by_id_ (uint32_t id)
 160 {
 161   return GNUNET_TESTBED_host_create_with_id (id, NULL, NULL, 0);
 162 }
 163
 164
 165 /**
 166  * Obtain the host's unique global ID.
 167  *
 168  * @param host handle to the host, NULL means 'localhost'
 169  * @return id global host ID assigned to the host (0 is
 170  *         'localhost', but then obviously not globally unique)
 171  */
 172 uint32_t
 173 GNUNET_TESTBED_host_get_id_ (const struct GNUNET_TESTBED_Host * host)
 174 {
 175   return host->id;
 176 }
 177
 178
 179 /**
 180  * Obtain the host's hostname.
 181  *
 182  * @param host handle to the host, NULL means 'localhost'
 183  * @return hostname of the host
 184  */
 185 const char *
 186 GNUNET_TESTBED_host_get_hostname_ (const struct GNUNET_TESTBED_Host *host)
 187 {
 188   return host->hostname;
 189 }
 190
 191
 192 /**
 193  * Obtain the host's username
 194  *
 195  * @param host handle to the host, NULL means 'localhost'
 196  * @return username to login to the host
 197  */
 198 const char *
 199 GNUNET_TESTBED_host_get_username_ (const struct GNUNET_TESTBED_Host *host)
 200 {
 201   return host->username;
 202 }
 203
 204
 205 /**
 206  * Obtain the host's ssh port
 207  *
 208  * @param host handle to the host, NULL means 'localhost'
 209  * @return username to login to the host
 210  */
 211 uint16_t
 212 GNUNET_TESTBED_host_get_ssh_port_ (const struct GNUNET_TESTBED_Host * host)
 213 {
 214   return host->port;
 215 }
 216
 217
 218 /**
 219  * Create a host to run peers and controllers on.
 220  *
 221  * @param id global host ID assigned to the host; 0 is
 222  *        reserved to always mean 'localhost'
 223  * @param hostname name of the host, use "NULL" for localhost
 224  * @param username username to use for the login; may be NULL
 225  * @param port port number to use for ssh; use 0 to let ssh decide
 226  * @return handle to the host, NULL on error
 227  */
 228 struct GNUNET_TESTBED_Host *
 229 GNUNET_TESTBED_host_create_with_id (uint32_t id, const char *hostname,
 230                                     const char *username, uint16_t port)
 231 {
 232   struct GNUNET_TESTBED_Host *host;
 233   uint32_t new_size;
 234
 235   if ((id < host_list_size) && (NULL != host_list[id]))
 236   {
 237     LOG (GNUNET_ERROR_TYPE_WARNING, "Host with id: %u already created\n", id);
 238     return NULL;
 239   }
 240   host = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_Host));
 241   host->hostname = (NULL != hostname) ? GNUNET_strdup (hostname) : NULL;
 242   host->username = (NULL != username) ? GNUNET_strdup (username) : NULL;
 243   host->id = id;
 244   host->port = (0 == port) ? 22 : port;
 245   new_size = host_list_size;
 246   while (id >= new_size)
 247     new_size += HOST_LIST_GROW_STEP;
 248   if (new_size != host_list_size)
 249   {
 250     host_list =
 251         GNUNET_realloc (host_list,
 252                         sizeof (struct GNUNET_TESTBED_Host *) * new_size);
 253     (void) memset (&host_list[host_list_size], 0,
 254                    sizeof (struct GNUNET_TESTBED_Host *) * (new_size -
 255                                                             host_list_size));
 256     host_list_size = new_size;
 257   }
 258   LOG (GNUNET_ERROR_TYPE_DEBUG, "Adding host with id: %u\n", host->id);
 259   host_list[id] = host;
 260   return host;
 261 }
 262
 263
 264 /**
 265  * Create a host to run peers and controllers on.
 266  *
 267  * @param hostname name of the host, use "NULL" for localhost
 268  * @param username username to use for the login; may be NULL
 269  * @param port port number to use for ssh; use 0 to let ssh decide
 270  * @return handle to the host, NULL on error
 271  */
 272 struct GNUNET_TESTBED_Host *
 273 GNUNET_TESTBED_host_create (const char *hostname, const char *username,
 274                             uint16_t port)
 275 {
 276   static uint32_t uid_generator;
 277
 278   if (NULL == hostname)
 279     return GNUNET_TESTBED_host_create_with_id (0, hostname, username, port);
 280   return GNUNET_TESTBED_host_create_with_id (++uid_generator, hostname,
 281                                              username, port);
 282 }
 283
 284
 285 /**
 286  * Load a set of hosts from a configuration file.
 287  *
 288  * @param filename file with the host specification
 289  * @param hosts set to the hosts found in the file; caller must free this if
 290  *          number of hosts returned is greater than 0
 291  * @return number of hosts returned in 'hosts', 0 on error
 292  */
 293 unsigned int
 294 GNUNET_TESTBED_hosts_load_from_file (const char *filename,
 295                                      struct GNUNET_TESTBED_Host ***hosts)
 296 {
 297   //struct GNUNET_TESTBED_Host **host_array;
 298   struct GNUNET_TESTBED_Host *starting_host;
 299   char *data;
 300   char *buf;
 301   char username[256];
 302   char hostname[256];
 303   uint64_t fs;
 304   short int port;
 305   int ret;
 306   unsigned int offset;
 307   unsigned int count;
 308
 309
 310   GNUNET_assert (NULL != filename);
 311   if (GNUNET_YES != GNUNET_DISK_file_test (filename))
 312   {
 313     LOG (GNUNET_ERROR_TYPE_WARNING, _("Hosts file %s not found\n"), filename);
 314     return 0;
 315   }
 316   if (GNUNET_OK !=
 317       GNUNET_DISK_file_size (filename, &fs, GNUNET_YES, GNUNET_YES))
 318     fs = 0;
 319   if (0 == fs)
 320   {
 321     LOG (GNUNET_ERROR_TYPE_WARNING, _("Hosts file %s has no data\n"), filename);
 322     return 0;
 323   }
 324   data = GNUNET_malloc (fs);
 325   if (fs != GNUNET_DISK_fn_read (filename, data, fs))
 326   {
 327     GNUNET_free (data);
 328     LOG (GNUNET_ERROR_TYPE_WARNING, _("Hosts file %s cannot be read\n"),
 329          filename);
 330     return 0;
 331   }
 332   buf = data;
 333   offset = 0;
 334   starting_host = NULL;
 335   count = 0;
 336   while (offset < (fs - 1))
 337   {
 338     offset++;
 339     if (((data[offset] == '\n')) && (buf != &data[offset]))
 340     {
 341       data[offset] = '\0';
 342       ret = SSCANF (buf, "%255[a-zA-Z0-9_]@%255[a-zA-Z0-9.]:%5hd",
 343                     username, hostname, &port);
 344       if  (3 == ret)
 345       {
 346         GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 347                     "Successfully read host %s, port %d and user %s from file\n",
 348                     hostname, port, username);
 349         /* We store hosts in a static list; hence we only require the starting
 350            host pointer in that list to access the newly created list of hosts */
 351         if (NULL == starting_host)
 352           starting_host = GNUNET_TESTBED_host_create (hostname, username,
 353                                                       port);
 354         else
 355           (void) GNUNET_TESTBED_host_create (hostname, username, port);
 356         count++;
 357       }
 358       else
 359         GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 360                     "Error reading line `%s' in hostfile\n", buf);
 361       buf = &data[offset + 1];
 362     }
 363     else if ((data[offset] == '\n') || (data[offset] == '\0'))
 364       buf = &data[offset + 1];
 365   }
 366   GNUNET_free (data);
 367   if (NULL == starting_host)
 368     return 0;
 369   *hosts = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_Host *) * count);
 370   memcpy (*hosts,
 371           &host_list[GNUNET_TESTBED_host_get_id_ (starting_host)],
 372           sizeof (struct GNUNET_TESTBED_Host *) * count);
 373   return count;
 374 }
 375
 376
 377 /**
 378  * Destroy a host handle.  Must only be called once everything
 379  * running on that host has been stopped.
 380  *
 381  * @param host handle to destroy
 382  */
 383 void
 384 GNUNET_TESTBED_host_destroy (struct GNUNET_TESTBED_Host *host)
 385 {
 386   struct RegisteredController *rc;
 387   uint32_t id;
 388
 389   GNUNET_assert (host->id < host_list_size);
 390   GNUNET_assert (host_list[host->id] == host);
 391   host_list[host->id] = NULL;
 392   /* clear registered controllers list */
 393   for (rc = host->rc_head; NULL != rc; rc = host->rc_head)
 394   {
 395     GNUNET_CONTAINER_DLL_remove (host->rc_head, host->rc_tail, rc);
 396     GNUNET_free (rc);
 397   }
 398   GNUNET_free_non_null ((char *) host->username);
 399   GNUNET_free_non_null ((char *) host->hostname);
 400   GNUNET_free (host);
 401   while (host_list_size >= HOST_LIST_GROW_STEP)
 402   {
 403     for (id = host_list_size - 1; id > host_list_size - HOST_LIST_GROW_STEP;
 404          id--)
 405       if (NULL != host_list[id])
 406         break;
 407     if (id != host_list_size - HOST_LIST_GROW_STEP)
 408       break;
 409     if (NULL != host_list[id])
 410       break;
 411     host_list_size -= HOST_LIST_GROW_STEP;
 412   }
 413   host_list =
 414       GNUNET_realloc (host_list,
 415                       sizeof (struct GNUNET_TESTBED_Host *) * host_list_size);
 416 }
 417
 418
 419 /**
 420  * Marks a host as registered with a controller
 421  *
 422  * @param host the host to mark
 423  * @param controller the controller at which this host is registered
 424  */
 425 void
 426 GNUNET_TESTBED_mark_host_registered_at_ (struct GNUNET_TESTBED_Host *host,
 427                                          const struct GNUNET_TESTBED_Controller
 428                                          *const controller)
 429 {
 430   struct RegisteredController *rc;
 431
 432   for (rc = host->rc_head; NULL != rc; rc = rc->next)
 433   {
 434     if (controller == rc->controller)   /* already registered at controller */
 435     {
 436       GNUNET_break (0);
 437       return;
 438     }
 439   }
 440   rc = GNUNET_malloc (sizeof (struct RegisteredController));
 441   rc->controller = controller;
 442   GNUNET_CONTAINER_DLL_insert_tail (host->rc_head, host->rc_tail, rc);
 443 }
 444
 445
 446 /**
 447  * Checks whether a host has been registered
 448  *
 449  * @param host the host to check
 450  * @param controller the controller at which host's registration is checked
 451  * @return GNUNET_YES if registered; GNUNET_NO if not
 452  */
 453 int
 454 GNUNET_TESTBED_is_host_registered_ (const 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       return GNUNET_YES;
 465     }
 466   }
 467   return GNUNET_NO;
 468 }
 469
 470
 471 /**
 472  * Checks whether a host can be used to start testbed service
 473  *
 474  * @param host the host to check
 475  * @return GNUNET_YES if testbed service can be started on the given host
 476  *           remotely; GNUNET_NO if not
 477  */
 478 int
 479 GNUNET_TESTBED_is_host_habitable (const struct GNUNET_TESTBED_Host *host)
 480 {
 481   char *remote_args[11];
 482   char *portstr;
 483   char *ssh_addr;
 484   const char *hostname;
 485   struct GNUNET_OS_Process *auxp;
 486   unsigned long code;
 487   enum GNUNET_OS_ProcessStatusType type;
 488   int ret;
 489   unsigned int argp;
 490
 491   portstr = NULL;
 492   ssh_addr = NULL;
 493   hostname = (NULL == host->hostname) ? "127.0.0.1" : host->hostname;
 494   if (NULL == host->username)
 495     ssh_addr = GNUNET_strdup (hostname);
 496   else
 497     GNUNET_asprintf (&ssh_addr, "%s@%s", host->username, hostname);
 498   argp = 0;
 499   remote_args[argp++] = "ssh";
 500   GNUNET_asprintf (&portstr, "%u", host->port);
 501   remote_args[argp++] = "-p";
 502   remote_args[argp++] = portstr;
 503   remote_args[argp++] = "-o";
 504   remote_args[argp++] = "BatchMode=yes";
 505   remote_args[argp++] = "-o";
 506   remote_args[argp++] = "NoHostAuthenticationForLocalhost=yes";
 507   remote_args[argp++] = ssh_addr;
 508   remote_args[argp++] = "which";
 509   remote_args[argp++] = "gnunet-helper-testbed";
 510   remote_args[argp++] = NULL;
 511   GNUNET_assert (argp == 11);
 512   auxp =
 513       GNUNET_OS_start_process_vap (GNUNET_NO, GNUNET_OS_INHERIT_STD_ALL, NULL,
 514                                    NULL, "ssh", remote_args);
 515   if (NULL == auxp)
 516   {
 517     GNUNET_free (ssh_addr);
 518     GNUNET_free (portstr);
 519     return GNUNET_NO;
 520   }
 521   do
 522   {
 523     ret = GNUNET_OS_process_status (auxp, &type, &code);
 524     GNUNET_assert (GNUNET_SYSERR != ret);
 525     (void) usleep (300);
 526   }
 527   while (GNUNET_NO == ret);
 528   //(void) GNUNET_OS_process_wait (auxp);
 529   GNUNET_OS_process_destroy (auxp);
 530   GNUNET_free (ssh_addr);
 531   GNUNET_free (portstr);
 532   return (0 != code) ? GNUNET_NO : GNUNET_YES;
 533 }
 534
 535 /* end of testbed_api_hosts.c */