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.h"
37 #include "testbed_api_hosts.h"
38 #include "testbed_helper.h"
41 * Generic logging shorthand
43 #define LOG(kind, ...) \
44 GNUNET_log_from (kind, "testbed-api-hosts", __VA_ARGS__);
47 * Number of extra elements we create space for when we grow host list
49 #define HOST_LIST_GROW_STEP 10
53 * A list entry for registered controllers list
55 struct RegisteredController
58 * The controller at which this host is registered
60 const struct GNUNET_TESTBED_Controller *controller;
63 * The next ptr for DLL
65 struct RegisteredController *next;
68 * The prev ptr for DLL
70 struct RegisteredController *prev;
75 * Opaque handle to a host running experiments managed by the testing framework.
76 * The master process must be able to SSH to this host without password (via
79 struct GNUNET_TESTBED_Host
83 * The next pointer for DLL
85 struct GNUNET_TESTBED_Host *next;
88 * The prev pointer for DLL
90 struct GNUNET_TESTBED_Host *prev;
93 * The hostname of the host; NULL for localhost
98 * The username to be used for SSH login
100 const char *username;
103 * The head for the list of controllers where this host is registered
105 struct RegisteredController *rc_head;
108 * The tail for the list of controllers where this host is registered
110 struct RegisteredController *rc_tail;
113 * Global ID we use to refer to a host on the network
118 * The port which is to be used for SSH
126 * Array of available hosts
128 static struct GNUNET_TESTBED_Host **host_list;
131 * The size of the available hosts list
133 static uint32_t host_list_size;
137 * Lookup a host by ID.
139 * @param id global host ID assigned to the host; 0 is
140 * reserved to always mean 'localhost'
141 * @return handle to the host, NULL if host not found
143 struct GNUNET_TESTBED_Host *
144 GNUNET_TESTBED_host_lookup_by_id_ (uint32_t id)
146 if (host_list_size <= id)
148 return host_list[id];
153 * Create a host by ID; given this host handle, we could not
154 * run peers at the host, but we can talk about the host
157 * @param id global host ID assigned to the host; 0 is
158 * reserved to always mean 'localhost'
159 * @return handle to the host, NULL on error
161 struct GNUNET_TESTBED_Host *
162 GNUNET_TESTBED_host_create_by_id_ (uint32_t id)
164 return GNUNET_TESTBED_host_create_with_id (id, NULL, NULL, 0);
169 * Obtain the host's unique global ID.
171 * @param host handle to the host, NULL means 'localhost'
172 * @return id global host ID assigned to the host (0 is
173 * 'localhost', but then obviously not globally unique)
176 GNUNET_TESTBED_host_get_id_ (const struct GNUNET_TESTBED_Host *host)
183 * Obtain the host's hostname.
185 * @param host handle to the host, NULL means 'localhost'
186 * @return hostname of the host
189 GNUNET_TESTBED_host_get_hostname_ (const struct GNUNET_TESTBED_Host *host)
191 return host->hostname;
196 * Obtain the host's username
198 * @param host handle to the host, NULL means 'localhost'
199 * @return username to login to the host
202 GNUNET_TESTBED_host_get_username_ (const struct GNUNET_TESTBED_Host *host)
204 return host->username;
209 * Obtain the host's ssh port
211 * @param host handle to the host, NULL means 'localhost'
212 * @return username to login to the host
215 GNUNET_TESTBED_host_get_ssh_port_ (const struct GNUNET_TESTBED_Host *host)
222 * Create a host to run peers and controllers on.
224 * @param id global host ID assigned to the host; 0 is
225 * reserved to always mean 'localhost'
226 * @param hostname name of the host, use "NULL" for localhost
227 * @param username username to use for the login; may be NULL
228 * @param port port number to use for ssh; use 0 to let ssh decide
229 * @return handle to the host, NULL on error
231 struct GNUNET_TESTBED_Host *
232 GNUNET_TESTBED_host_create_with_id (uint32_t id,
233 const char *hostname,
234 const char *username,
237 struct GNUNET_TESTBED_Host *host;
239 if ((id < host_list_size) && (NULL != host_list[id]))
241 LOG (GNUNET_ERROR_TYPE_WARNING, "Host with id: %u already created\n");
244 host = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_Host));
245 host->hostname = hostname;
246 host->username = username;
248 host->port = (0 == port) ? 22 : port;
249 if (id >= host_list_size)
251 host_list_size += HOST_LIST_GROW_STEP;
252 host_list = GNUNET_realloc (host_list, sizeof (struct GNUNET_TESTBED_Host)
254 (void) memset(&host_list[host_list_size - HOST_LIST_GROW_STEP],
255 0, sizeof (struct GNUNET_TESTBED_Host) * host_list_size);
257 LOG (GNUNET_ERROR_TYPE_DEBUG,
258 "Adding host with id: %u\n", host->id);
259 host_list[id] = host;
265 * Create a host to run peers and controllers on.
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
272 struct GNUNET_TESTBED_Host *
273 GNUNET_TESTBED_host_create (const char *hostname,
274 const char *username,
277 static uint32_t uid_generator;
279 if (NULL == hostname)
280 return GNUNET_TESTBED_host_create_with_id (0, hostname, username, port);
281 return GNUNET_TESTBED_host_create_with_id (++uid_generator,
288 * Load a set of hosts from a configuration file.
290 * @param filename file with the host specification
291 * @param hosts set to the hosts found in the file
292 * @return number of hosts returned in 'hosts', 0 on error
295 GNUNET_TESTBED_hosts_load_from_file (const char *filename,
296 struct GNUNET_TESTBED_Host **hosts)
298 // see testing_group.c, GNUNET_TESTING_hosts_load
305 * Destroy a host handle. Must only be called once everything
306 * running on that host has been stopped.
308 * @param host handle to destroy
311 GNUNET_TESTBED_host_destroy (struct GNUNET_TESTBED_Host *host)
313 struct RegisteredController *rc;
316 GNUNET_assert (host->id < host_list_size);
317 GNUNET_assert (host_list[host->id] == host);
318 host_list[host->id] = NULL;
319 /* clear registered controllers list */
320 for (rc=host->rc_head; NULL != rc; rc=host->rc_head)
322 GNUNET_CONTAINER_DLL_remove (host->rc_head, host->rc_tail, rc);
325 for (id = 0; id < HOST_LIST_GROW_STEP; id++)
327 if (((host->id + id) >= host_list_size) ||
328 (NULL != host_list[host->id + id]))
331 if (HOST_LIST_GROW_STEP == id)
333 host_list_size -= HOST_LIST_GROW_STEP;
334 host_list = GNUNET_realloc (host_list, host_list_size);
341 * Continuation function from GNUNET_HELPER_send()
344 * @param result GNUNET_OK on success,
345 * GNUNET_NO if helper process died
346 * GNUNET_SYSERR during GNUNET_HELPER_stop
349 clear_msg (void *cls, int result)
356 * Callback that will be called when the helper process dies. This is not called
357 * when the helper process is stoped using GNUNET_HELPER_stop()
359 * @param cls the closure from GNUNET_HELPER_start()
360 * @param h the handle representing the helper process. This handle is invalid
361 * in this callback. It is only presented for reference. No operations
362 * can be performed using it.
365 helper_exp_cb (void *cls, const struct GNUNET_HELPER_Handle *h)
367 struct GNUNET_TESTBED_HelperHandle *handle = cls;
369 handle->is_stopped = GNUNET_YES;
370 GNUNET_TESTBED_host_stop_ (handle);
371 handle->exp_cb (handle->exp_cb_cls, h);
376 * Run a given helper process at the given host. Communication
377 * with the helper will be via GNUnet messages on stdin/stdout.
378 * Runs the process via 'ssh' at the specified host, or locally.
379 * Essentially an SSH-wrapper around the 'gnunet_helper_lib.h' API.
381 * @param controller_ip the ip address of the controller. Will be set as TRUSTED
382 * host when starting testbed controller at host
383 * @param host host to use, use "NULL" for localhost
384 * @param binary_argv binary name and command-line arguments to give to the
386 * @param cfg template configuration to use for the remote controller; the
387 * remote controller will be started with a slightly modified
388 * configuration (port numbers, unix domain sockets and service home
389 * values are changed as per TESTING library on the remote host)
390 * @param cb the callback to run when helper process dies; cannot be NULL
391 * @param cb_cls the closure for the above callback
392 * @return handle to terminate the command, NULL on error
394 struct GNUNET_TESTBED_HelperHandle *
395 GNUNET_TESTBED_host_run_ (const char *controller_ip,
396 const struct GNUNET_TESTBED_Host *host,
397 const struct GNUNET_CONFIGURATION_Handle *cfg,
398 GNUNET_HELPER_ExceptionCallback cb,
401 struct GNUNET_TESTBED_HelperHandle *h;
402 struct GNUNET_TESTBED_HelperInit *msg;
404 GNUNET_assert (NULL != cb);
405 h = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_HelperHandle));
407 h->exp_cb_cls = cb_cls;
408 h->is_stopped = GNUNET_NO;
409 if ((NULL == host) || (0 == host->id))
411 char * const binary_argv[] = {
412 "gnunet-testbed-helper", NULL
416 GNUNET_HELPER_start ("gnunet-testbed-helper", binary_argv, NULL, &helper_exp_cb, h);
420 char *remote_args[6 + 1];
423 GNUNET_asprintf (&h->port, "%d", host->port);
424 if (NULL == host->username)
425 GNUNET_asprintf (&h->dst, "%s", host->hostname);
427 GNUNET_asprintf (&h->dst, "%s@%s", host->hostname, host->username);
429 remote_args[argp++] = "ssh";
430 remote_args[argp++] = "-p";
431 remote_args[argp++] = h->port;
432 remote_args[argp++] = "-q";
433 remote_args[argp++] = h->dst;
434 remote_args[argp++] = "gnunet-testbed-helper";
435 remote_args[argp++] = NULL;
436 GNUNET_assert (argp == 6 + 1);
437 h->helper = GNUNET_HELPER_start ("ssh", remote_args, NULL, &helper_exp_cb, h);
439 msg = GNUNET_TESTBED_create_helper_init_msg_ (controller_ip, cfg);
440 if ((NULL == h->helper) ||
441 (NULL == (h->helper_shandle = GNUNET_HELPER_send (h->helper, &msg->header, GNUNET_NO,
445 GNUNET_free_non_null (h->port);
446 GNUNET_free_non_null (h->dst);
455 * Stops a helper in the HelperHandle using GNUNET_HELPER_stop
457 * @param handle the handle returned from GNUNET_TESTBED_host_start_
460 GNUNET_TESTBED_host_stop_ (struct GNUNET_TESTBED_HelperHandle *handle)
462 if (GNUNET_YES != handle->is_stopped)
463 GNUNET_HELPER_stop (handle->helper);
464 GNUNET_free_non_null (handle->port);
465 GNUNET_free_non_null (handle->dst);
466 GNUNET_free (handle);
471 * Marks a host as registered with a controller
473 * @param host the host to mark
474 * @param controller the controller at which this host is registered
477 GNUNET_TESTBED_mark_host_registered_at_ (struct GNUNET_TESTBED_Host *host,
478 const struct GNUNET_TESTBED_Controller
481 struct RegisteredController *rc;
483 for (rc=host->rc_head; NULL != rc; rc=rc->next)
485 if (controller == rc->controller) /* already registered at controller */
491 rc = GNUNET_malloc (sizeof (struct RegisteredController));
492 rc->controller = controller;
493 //host->controller = controller;
494 GNUNET_CONTAINER_DLL_insert_tail (host->rc_head, host->rc_tail, rc);
499 * Checks whether a host has been registered
501 * @param host the host to check
502 * @param controller the controller at which host's registration is checked
503 * @return GNUNET_YES if registered; GNUNET_NO if not
506 GNUNET_TESTBED_is_host_registered_ (const struct GNUNET_TESTBED_Host *host,
507 const struct GNUNET_TESTBED_Controller
510 struct RegisteredController *rc;
512 for (rc=host->rc_head; NULL != rc; rc=rc->next)
514 if (controller == rc->controller) /* already registered at controller */
524 * Creates a helper initialization message. Only for testing.
526 * @param cname the ip address of the controlling host
527 * @param cfg the configuration that has to used to start the testbed service
529 * @return the initialization message
531 struct GNUNET_TESTBED_HelperInit *
532 GNUNET_TESTBED_create_helper_init_msg_ (const char *cname,
533 const struct GNUNET_CONFIGURATION_Handle *cfg)
535 struct GNUNET_TESTBED_HelperInit *msg;
543 config = GNUNET_CONFIGURATION_serialize (cfg, &config_size);
544 GNUNET_assert (NULL != config);
546 GNUNET_TESTBED_compress_config (config, config_size, &xconfig);
547 GNUNET_free (config);
548 cname_len = strlen (cname);
549 msg_size = xconfig_size + cname_len + 1 +
550 sizeof (struct GNUNET_TESTBED_HelperInit);
551 msg = GNUNET_realloc (xconfig, msg_size);
552 (void) memmove ( ((void *) &msg[1]) + cname_len + 1, msg, xconfig_size);
553 msg->header.size = htons (msg_size);
554 msg->header.type = htons (GNUNET_MESSAGE_TYPE_TESTBED_HELPER_INIT);
555 msg->cname_size = htons (cname_len);
556 msg->config_size = htons (config_size);
557 (void) strcpy ((char *) &msg[1], cname);
562 /* end of testbed_api_hosts.c */