2 This file is part of GNUnet
3 (C) 2008--2012 Christian Grothoff (and other contributing authors)
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.
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.
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.
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
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"
36 #include "testbed_api_hosts.h"
39 * Generic logging shorthand
41 #define LOG(kind, ...) \
42 GNUNET_log_from (kind, "testbed-api-hosts", __VA_ARGS__);
45 * Number of extra elements we create space for when we grow host list
47 #define HOST_LIST_GROW_STEP 10
51 * A list entry for registered controllers list
53 struct RegisteredController
56 * The controller at which this host is registered
58 const struct GNUNET_TESTBED_Controller *controller;
61 * The next ptr for DLL
63 struct RegisteredController *next;
66 * The prev ptr for DLL
68 struct RegisteredController *prev;
73 * Opaque handle to a host running experiments managed by the testing framework.
74 * The master process must be able to SSH to this host without password (via
77 struct GNUNET_TESTBED_Host
81 * The next pointer for DLL
83 struct GNUNET_TESTBED_Host *next;
86 * The prev pointer for DLL
88 struct GNUNET_TESTBED_Host *prev;
91 * The hostname of the host; NULL for localhost
96 * The username to be used for SSH login
101 * The head for the list of controllers where this host is registered
103 struct RegisteredController *rc_head;
106 * The tail for the list of controllers where this host is registered
108 struct RegisteredController *rc_tail;
111 * Global ID we use to refer to a host on the network
116 * The port which is to be used for SSH
124 * Array of available hosts
126 static struct GNUNET_TESTBED_Host **host_list;
129 * The size of the available hosts list
131 static uint32_t host_list_size;
135 * Lookup a host by ID.
137 * @param id global host ID assigned to the host; 0 is
138 * reserved to always mean 'localhost'
139 * @return handle to the host, NULL if host not found
141 struct GNUNET_TESTBED_Host *
142 GNUNET_TESTBED_host_lookup_by_id_ (uint32_t id)
144 if (host_list_size <= id)
146 return host_list[id];
151 * Create a host by ID; given this host handle, we could not
152 * run peers at the host, but we can talk about the host
155 * @param id global host ID assigned to the host; 0 is
156 * reserved to always mean 'localhost'
157 * @return handle to the host, NULL on error
159 struct GNUNET_TESTBED_Host *
160 GNUNET_TESTBED_host_create_by_id_ (uint32_t id)
162 return GNUNET_TESTBED_host_create_with_id (id, NULL, NULL, 0);
167 * Obtain the host's unique global ID.
169 * @param host handle to the host, NULL means 'localhost'
170 * @return id global host ID assigned to the host (0 is
171 * 'localhost', but then obviously not globally unique)
174 GNUNET_TESTBED_host_get_id_ (const struct GNUNET_TESTBED_Host *host)
181 * Obtain the host's hostname.
183 * @param host handle to the host, NULL means 'localhost'
184 * @return hostname of the host
187 GNUNET_TESTBED_host_get_hostname_ (const struct GNUNET_TESTBED_Host *host)
189 return host->hostname;
194 * Obtain the host's username
196 * @param host handle to the host, NULL means 'localhost'
197 * @return username to login to the host
200 GNUNET_TESTBED_host_get_username_ (const struct GNUNET_TESTBED_Host *host)
202 return host->username;
207 * Obtain the host's ssh port
209 * @param host handle to the host, NULL means 'localhost'
210 * @return username to login to the host
213 GNUNET_TESTBED_host_get_ssh_port_ (const struct GNUNET_TESTBED_Host *host)
220 * Create a host to run peers and controllers on.
222 * @param id global host ID assigned to the host; 0 is
223 * reserved to always mean 'localhost'
224 * @param hostname name of the host, use "NULL" for localhost
225 * @param username username to use for the login; may be NULL
226 * @param port port number to use for ssh; use 0 to let ssh decide
227 * @return handle to the host, NULL on error
229 struct GNUNET_TESTBED_Host *
230 GNUNET_TESTBED_host_create_with_id (uint32_t id,
231 const char *hostname,
232 const char *username,
235 struct GNUNET_TESTBED_Host *host;
237 if ((id < host_list_size) && (NULL != host_list[id]))
239 LOG (GNUNET_ERROR_TYPE_WARNING, "Host with id: %u already created\n");
242 host = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_Host));
243 host->hostname = hostname;
244 host->username = username;
246 host->port = (0 == port) ? 22 : port;
247 if (id >= host_list_size)
249 host_list_size += HOST_LIST_GROW_STEP;
250 host_list = GNUNET_realloc (host_list, sizeof (struct GNUNET_TESTBED_Host)
252 (void) memset(&host_list[host_list_size - HOST_LIST_GROW_STEP],
253 0, sizeof (struct GNUNET_TESTBED_Host) * host_list_size);
255 LOG (GNUNET_ERROR_TYPE_DEBUG,
256 "Adding host with id: %u\n", host->id);
257 host_list[id] = host;
263 * Create a host to run peers and controllers on.
265 * @param hostname name of the host, use "NULL" for localhost
266 * @param username username to use for the login; may be NULL
267 * @param port port number to use for ssh; use 0 to let ssh decide
268 * @return handle to the host, NULL on error
270 struct GNUNET_TESTBED_Host *
271 GNUNET_TESTBED_host_create (const char *hostname,
272 const char *username,
275 static uint32_t uid_generator;
277 if (NULL == hostname)
278 return GNUNET_TESTBED_host_create_with_id (0, hostname, username, port);
279 return GNUNET_TESTBED_host_create_with_id (++uid_generator,
286 * Load a set of hosts from a configuration file.
288 * @param filename file with the host specification
289 * @param hosts set to the hosts found in the file
290 * @return number of hosts returned in 'hosts', 0 on error
293 GNUNET_TESTBED_hosts_load_from_file (const char *filename,
294 struct GNUNET_TESTBED_Host **hosts)
296 // see testing_group.c, GNUNET_TESTING_hosts_load
303 * Destroy a host handle. Must only be called once everything
304 * running on that host has been stopped.
306 * @param host handle to destroy
309 GNUNET_TESTBED_host_destroy (struct GNUNET_TESTBED_Host *host)
311 struct RegisteredController *rc;
314 GNUNET_assert (host->id < host_list_size);
315 GNUNET_assert (host_list[host->id] == host);
316 host_list[host->id] = NULL;
317 /* clear registered controllers list */
318 for (rc=host->rc_head; NULL != rc; rc=host->rc_head)
320 GNUNET_CONTAINER_DLL_remove (host->rc_head, host->rc_tail, rc);
323 for (id = 0; id < HOST_LIST_GROW_STEP; id++)
325 if (((host->id + id) >= host_list_size) ||
326 (NULL != host_list[host->id + id]))
329 if (HOST_LIST_GROW_STEP == id)
331 host_list_size -= HOST_LIST_GROW_STEP;
332 host_list = GNUNET_realloc (host_list, host_list_size);
339 * Run a given helper process at the given host. Communication
340 * with the helper will be via GNUnet messages on stdin/stdout.
341 * Runs the process via 'ssh' at the specified host, or locally.
342 * Essentially an SSH-wrapper around the 'gnunet_helper_lib.h' API.
344 * @param host host to use, use "NULL" for localhost
345 * @param binary_argv binary name and command-line arguments to give to the binary
346 * @return handle to terminate the command, NULL on error
348 struct GNUNET_TESTBED_HelperHandle *
349 GNUNET_TESTBED_host_run_ (const struct GNUNET_TESTBED_Host *host,
350 char *const binary_argv[])
352 struct GNUNET_TESTBED_HelperHandle *h;
356 while (NULL != binary_argv[argc])
358 h = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_HelperHandle));
359 h->cpipe_in = GNUNET_DISK_pipe (GNUNET_NO, GNUNET_NO, GNUNET_YES, GNUNET_NO);
360 h->cpipe_out = GNUNET_DISK_pipe (GNUNET_NO, GNUNET_NO, GNUNET_NO, GNUNET_YES);
361 if ((NULL == h->cpipe_in) || (NULL == h->cpipe_out))
363 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR,
368 if ((NULL == host) || (0 == host->id))
370 h->process = GNUNET_OS_start_process_vap (GNUNET_YES,
371 GNUNET_OS_INHERIT_STD_ALL,
372 h->cpipe_in, h->cpipe_out,
373 "gnunet-service-testbed",
378 char *remote_args[argc + 6 + 1];
381 GNUNET_asprintf (&h->port, "%d", host->port);
382 if (NULL == host->username)
383 GNUNET_asprintf (&h->dst, "%s", host->hostname);
385 GNUNET_asprintf (&h->dst, "%s@%s", host->hostname, host->username);
387 remote_args[argp++] = "ssh";
388 remote_args[argp++] = "-p";
389 remote_args[argp++] = h->port;
390 remote_args[argp++] = "-q";
391 remote_args[argp++] = h->dst;
392 remote_args[argp++] = "gnunet-service-testbed";
393 while (NULL != binary_argv[argp-6])
395 remote_args[argp] = binary_argv[argp - 6];
398 remote_args[argp++] = NULL;
399 GNUNET_assert (argp == argc + 6 + 1);
400 h->process = GNUNET_OS_start_process_vap (GNUNET_YES,
401 GNUNET_OS_INHERIT_STD_ALL,
406 if (NULL == h->process)
408 GNUNET_break (GNUNET_OK == GNUNET_DISK_pipe_close (h->cpipe_in));
409 GNUNET_free_non_null (h->port);
410 GNUNET_free_non_null (h->dst);
414 GNUNET_break (GNUNET_OK == GNUNET_DISK_pipe_close_end (h->cpipe_in, GNUNET_DISK_PIPE_END_READ));
420 * Stops a helper in the HelperHandle using GNUNET_HELPER_stop
422 * @param handle the handle returned from GNUNET_TESTBED_host_start_
425 GNUNET_TESTBED_host_stop_ (struct GNUNET_TESTBED_HelperHandle *handle)
427 GNUNET_break (GNUNET_OK == GNUNET_DISK_pipe_close (handle->cpipe_in));
428 GNUNET_break (GNUNET_OK == GNUNET_DISK_pipe_close (handle->cpipe_out));
429 GNUNET_break (0 == GNUNET_OS_process_kill (handle->process, SIGTERM));
430 GNUNET_break (GNUNET_OK == GNUNET_OS_process_wait (handle->process));
431 GNUNET_OS_process_destroy (handle->process);
432 GNUNET_free_non_null (handle->port);
433 GNUNET_free_non_null (handle->dst);
434 GNUNET_free (handle);
439 * Marks a host as registered with a controller
441 * @param host the host to mark
442 * @param controller the controller at which this host is registered
445 GNUNET_TESTBED_mark_host_registered_at_ (struct GNUNET_TESTBED_Host *host,
446 const struct GNUNET_TESTBED_Controller
449 struct RegisteredController *rc;
451 for (rc=host->rc_head; NULL != rc; rc=rc->next)
453 if (controller == rc->controller) /* already registered at controller */
459 rc = GNUNET_malloc (sizeof (struct RegisteredController));
460 rc->controller = controller;
461 //host->controller = controller;
462 GNUNET_CONTAINER_DLL_insert_tail (host->rc_head, host->rc_tail, rc);
467 * Checks whether a host has been registered
469 * @param host the host to check
470 * @param controller the controller at which host's registration is checked
471 * @return GNUNET_YES if registered; GNUNET_NO if not
474 GNUNET_TESTBED_is_host_registered_ (const struct GNUNET_TESTBED_Host *host,
475 const struct GNUNET_TESTBED_Controller
478 struct RegisteredController *rc;
480 for (rc=host->rc_head; NULL != rc; rc=rc->next)
482 if (controller == rc->controller) /* already registered at controller */
491 /* end of testbed_api_hosts.c */