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"
37 * Generic logging shorthand
39 #define LOG(kind, ...) \
40 GNUNET_log_from (kind, "testbed-api-hosts", __VA_ARGS__);
43 * Number of extra elements we create space for when we grow host list
45 #define HOST_LIST_GROW_STEP 10
49 * A list entry for registered controllers list
51 struct RegisteredController
54 * The controller at which this host is registered
56 const struct GNUNET_TESTBED_Controller *controller;
59 * The next ptr for DLL
61 struct RegisteredController *next;
64 * The prev ptr for DLL
66 struct RegisteredController *prev;
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
75 struct GNUNET_TESTBED_Host
79 * The next pointer for DLL
81 struct GNUNET_TESTBED_Host *next;
84 * The prev pointer for DLL
86 struct GNUNET_TESTBED_Host *prev;
89 * The hostname of the host; NULL for localhost
94 * The username to be used for SSH login
99 * The head for the list of controllers where this host is registered
101 struct RegisteredController *rc_head;
104 * The tail for the list of controllers where this host is registered
106 struct RegisteredController *rc_tail;
109 * Global ID we use to refer to a host on the network
114 * The port which is to be used for SSH
122 * Array of available hosts
124 static struct GNUNET_TESTBED_Host **host_list;
127 * The size of the available hosts list
129 static uint32_t host_list_size;
133 * Lookup a host by ID.
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
139 struct GNUNET_TESTBED_Host *
140 GNUNET_TESTBED_host_lookup_by_id_ (uint32_t id)
142 if (host_list_size <= id)
144 return host_list[id];
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
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
157 struct GNUNET_TESTBED_Host *
158 GNUNET_TESTBED_host_create_by_id_ (uint32_t id)
160 return GNUNET_TESTBED_host_create_with_id (id, NULL, NULL, 0);
165 * Obtain the host's unique global ID.
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)
172 GNUNET_TESTBED_host_get_id_ (const struct GNUNET_TESTBED_Host *host)
179 * Obtain the host's hostname.
181 * @param host handle to the host, NULL means 'localhost'
182 * @return hostname of the host
185 GNUNET_TESTBED_host_get_hostname_ (const struct GNUNET_TESTBED_Host *host)
187 return host->hostname;
192 * Obtain the host's username
194 * @param host handle to the host, NULL means 'localhost'
195 * @return username to login to the host
198 GNUNET_TESTBED_host_get_username_ (const struct GNUNET_TESTBED_Host *host)
200 return host->username;
205 * Obtain the host's ssh port
207 * @param host handle to the host, NULL means 'localhost'
208 * @return username to login to the host
211 GNUNET_TESTBED_host_get_ssh_port_ (const struct GNUNET_TESTBED_Host *host)
218 * Create a host to run peers and controllers on.
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
227 struct GNUNET_TESTBED_Host *
228 GNUNET_TESTBED_host_create_with_id (uint32_t id,
229 const char *hostname,
230 const char *username,
233 struct GNUNET_TESTBED_Host *host;
235 if ((id < host_list_size) && (NULL != host_list[host_list_size]))
237 LOG (GNUNET_ERROR_TYPE_WARNING, "Host with id: %u already created\n");
240 host = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_Host));
241 host->hostname = hostname;
242 host->username = username;
244 host->port = (0 == port) ? 22 : port;
245 if (id < host_list_size)
247 host_list_size += HOST_LIST_GROW_STEP;
248 host_list = GNUNET_realloc (host_list, sizeof (struct GNUNET_TESTBED_Host)
251 host_list[id] = host;
257 * Create a host to run peers and controllers on.
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
264 struct GNUNET_TESTBED_Host *
265 GNUNET_TESTBED_host_create (const char *hostname,
266 const char *username,
269 static uint32_t uid_generator;
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,
280 * Load a set of hosts from a configuration file.
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
287 GNUNET_TESTBED_hosts_load_from_file (const char *filename,
288 struct GNUNET_TESTBED_Host **hosts)
290 // see testing_group.c, GNUNET_TESTING_hosts_load
297 * Destroy a host handle. Must only be called once everything
298 * running on that host has been stopped.
300 * @param host handle to destroy
303 GNUNET_TESTBED_host_destroy (struct GNUNET_TESTBED_Host *host)
305 struct RegisteredController *rc;
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)
314 GNUNET_CONTAINER_DLL_remove (host->rc_head, host->rc_tail, rc);
317 for (id = 0; id < HOST_LIST_GROW_STEP; id++)
319 if ((host->id + id >= host_list_size) || (NULL != host_list[host->id + id]))
322 if (HOST_LIST_GROW_STEP == id)
324 host_list_size -= HOST_LIST_GROW_STEP;
325 host_list = GNUNET_realloc (host_list, host_list_size);
332 * Wrapper around GNUNET_HELPER_Handle
334 struct GNUNET_TESTBED_HelperHandle
339 struct GNUNET_OS_Process *process;
342 * Pipe connecting to stdin of the process.
344 struct GNUNET_DISK_PipeHandle *cpipe;
347 * The port number for ssh; used for helpers starting ssh
352 * The ssh destination string; used for helpers starting ssh
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.
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
368 struct GNUNET_TESTBED_HelperHandle *
369 GNUNET_TESTBED_host_run_ (const struct GNUNET_TESTBED_Host *host,
370 char *const binary_argv[])
372 struct GNUNET_TESTBED_HelperHandle *h;
376 while (NULL != binary_argv[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))
382 h->process = GNUNET_OS_start_process_vap (GNUNET_YES,
384 "gnunet-service-testbed",
389 char *remote_args[argc + 6 + 1];
392 GNUNET_asprintf (&h->port, "%d", host->port);
393 if (NULL == host->username)
394 GNUNET_asprintf (&h->dst, "%s", host->hostname);
396 GNUNET_asprintf (&h->dst, "%s@%s", host->hostname, host->username);
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])
406 remote_args[argp] = binary_argv[argp - 6];
409 remote_args[argp++] = NULL;
410 GNUNET_assert (argp == argc + 6 + 1);
411 h->process = GNUNET_OS_start_process_vap (GNUNET_YES,
416 if (NULL == h->process)
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);
424 GNUNET_break (GNUNET_OK == GNUNET_DISK_pipe_close_end (h->cpipe, GNUNET_DISK_PIPE_END_READ));
430 * Stops a helper in the HelperHandle using GNUNET_HELPER_stop
432 * @param handle the handle returned from GNUNET_TESTBED_host_start_
435 GNUNET_TESTBED_host_stop_ (struct GNUNET_TESTBED_HelperHandle *handle)
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);
448 * Marks a host as registered with a controller
450 * @param host the host to mark
451 * @param controller the controller at which this host is registered
454 GNUNET_TESTBED_mark_host_registered_at_ (struct GNUNET_TESTBED_Host *host,
455 const struct GNUNET_TESTBED_Controller
458 struct RegisteredController *rc;
460 for (rc=host->rc_head; NULL != rc; rc=rc->next)
462 if (controller == rc->controller) /* already registered at controller */
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);
476 * Checks whether a host has been registered
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
483 GNUNET_TESTBED_is_host_registered_ (const struct GNUNET_TESTBED_Host *host,
484 const struct GNUNET_TESTBED_Controller
487 struct RegisteredController *rc;
489 for (rc=host->rc_head; NULL != rc; rc=rc->next)
491 if (controller == rc->controller) /* already registered at controller */
500 /* end of testbed_api_hosts.c */