aboutsummaryrefslogtreecommitdiff
path: root/src/testbed/testbed_api_hosts.c
diff options
context:
space:
mode:
Diffstat (limited to 'src/testbed/testbed_api_hosts.c')
-rw-r--r--src/testbed/testbed_api_hosts.c1574
1 files changed, 0 insertions, 1574 deletions
diff --git a/src/testbed/testbed_api_hosts.c b/src/testbed/testbed_api_hosts.c
deleted file mode 100644
index 1a8d9976d..000000000
--- a/src/testbed/testbed_api_hosts.c
+++ /dev/null
@@ -1,1574 +0,0 @@
1/*
2 This file is part of GNUnet
3 Copyright (C) 2008--2013 GNUnet e.V.
4
5 GNUnet is free software: you can redistribute it and/or modify it
6 under the terms of the GNU Affero General Public License as published
7 by the Free Software Foundation, either version 3 of the License,
8 or (at your 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 Affero General Public License for more details.
14
15 You should have received a copy of the GNU Affero General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>.
17
18 SPDX-License-Identifier: AGPL3.0-or-later
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#include "testbed_helper.h"
37#include "testbed_api_operations.h"
38
39#include <zlib.h>
40#include <regex.h>
41
42/**
43 * Generic logging shorthand
44 */
45#define LOG(kind, ...) GNUNET_log_from (kind, "testbed-api-hosts", __VA_ARGS__);
46
47/**
48 * Debug logging shorthand
49 */
50#define LOG_DEBUG(...) LOG (GNUNET_ERROR_TYPE_DEBUG, __VA_ARGS__);
51
52/**
53 * Prints API violation message
54 */
55#define API_VIOLATION(cond, errstr) \
56 do \
57 { \
58 if (cond) \
59 break; \
60 LOG (GNUNET_ERROR_TYPE_ERROR, "API violation detected: %s\n", errstr); \
61 GNUNET_assert (0); \
62 } while (0)
63
64/**
65 * Log an error message at log-level 'level' that indicates a failure of the
66 * command 'cmd' with the message given by gai_strerror(rc).
67 */
68#define LOG_GAI(level, cmd, rc) \
69 do \
70 { \
71 LOG (level, \
72 _ ("`%s' failed at %s:%d with error: %s\n"), \
73 cmd, \
74 __FILE__, \
75 __LINE__, \
76 gai_strerror (rc)); \
77 } while (0)
78
79/**
80 * Number of extra elements we create space for when we grow host list
81 */
82#define HOST_LIST_GROW_STEP 10
83
84
85/**
86 * A list entry for registered controllers list
87 */
88struct RegisteredController
89{
90 /**
91 * The controller at which this host is registered
92 */
93 const struct GNUNET_TESTBED_Controller *controller;
94
95 /**
96 * The next ptr for DLL
97 */
98 struct RegisteredController *next;
99
100 /**
101 * The prev ptr for DLL
102 */
103 struct RegisteredController *prev;
104};
105
106
107/**
108 * Opaque handle to a host running experiments managed by the testing framework.
109 * The master process must be able to SSH to this host without password (via
110 * ssh-agent).
111 */
112struct GNUNET_TESTBED_Host
113{
114 /**
115 * The hostname of the host; NULL for localhost
116 */
117 const char *hostname;
118
119 /**
120 * The username to be used for SSH login
121 */
122 const char *username;
123
124 /**
125 * the configuration to use as a template while starting a controller on this
126 * host. Operation queue size specific to a host are also read from this
127 * configuration handle. After starting the controller, it points to the actual
128 * configuration with which the controller is running
129 */
130 struct GNUNET_CONFIGURATION_Handle *cfg;
131
132 /**
133 * The head for the list of controllers where this host is registered
134 */
135 struct RegisteredController *rc_head;
136
137 /**
138 * The tail for the list of controllers where this host is registered
139 */
140 struct RegisteredController *rc_tail;
141
142 /**
143 * Operation queue for simultaneous overlay connect operations target at this
144 * host
145 */
146 struct OperationQueue *opq_parallel_overlay_connect_operations;
147
148 /**
149 * Is a controller started on this host? FIXME: Is this needed?
150 */
151 int controller_started;
152
153 /**
154 * Is this host locked by GNUNET_TESTBED_controller_start()?
155 */
156 int locked;
157
158 /**
159 * Global ID we use to refer to a host on the network
160 */
161 uint32_t id;
162
163 /**
164 * The port which is to be used for SSH
165 */
166 uint16_t port;
167};
168
169
170/**
171 * Array of available hosts
172 */
173static struct GNUNET_TESTBED_Host **host_list;
174
175/**
176 * The size of the available hosts list
177 */
178static unsigned int host_list_size;
179
180
181/**
182 * Lookup a host by ID.
183 *
184 * @param id global host ID assigned to the host; 0 is
185 * reserved to always mean 'localhost'
186 * @return handle to the host, NULL if host not found
187 */
188struct GNUNET_TESTBED_Host *
189GNUNET_TESTBED_host_lookup_by_id_ (uint32_t id)
190{
191 if (host_list_size <= id)
192 return NULL;
193 return host_list[id];
194}
195
196
197/**
198 * Create a host by ID; given this host handle, we could not
199 * run peers at the host, but we can talk about the host
200 * internally.
201 *
202 * @param id global host ID assigned to the host; 0 is
203 * reserved to always mean 'localhost'
204 * @param cfg the configuration to use as a template while starting a controller
205 * on this host. Operation queue sizes specific to a host are also
206 * read from this configuration handle
207 * @return handle to the host, NULL on error
208 */
209struct GNUNET_TESTBED_Host *
210GNUNET_TESTBED_host_create_by_id_ (
211 uint32_t id,
212 const struct GNUNET_CONFIGURATION_Handle *cfg)
213{
214 return GNUNET_TESTBED_host_create_with_id (id, NULL, NULL, cfg, 0);
215}
216
217
218/**
219 * Obtain the host's unique global ID.
220 *
221 * @param host handle to the host, NULL means 'localhost'
222 * @return id global host ID assigned to the host (0 is
223 * 'localhost', but then obviously not globally unique)
224 */
225uint32_t
226GNUNET_TESTBED_host_get_id_ (const struct GNUNET_TESTBED_Host *host)
227{
228 return host->id;
229}
230
231
232/**
233 * Obtain the host's hostname.
234 *
235 * @param host handle to the host, NULL means 'localhost'
236 * @return hostname of the host
237 */
238const char *
239GNUNET_TESTBED_host_get_hostname (const struct GNUNET_TESTBED_Host *host)
240{
241 return host->hostname;
242}
243
244
245/**
246 * Obtain the host's username
247 *
248 * @param host handle to the host, NULL means 'localhost'
249 * @return username to login to the host
250 */
251const char *
252GNUNET_TESTBED_host_get_username_ (const struct GNUNET_TESTBED_Host *host)
253{
254 return host->username;
255}
256
257
258/**
259 * Obtain the host's ssh port
260 *
261 * @param host handle to the host, NULL means 'localhost'
262 * @return username to login to the host
263 */
264uint16_t
265GNUNET_TESTBED_host_get_ssh_port_ (const struct GNUNET_TESTBED_Host *host)
266{
267 return host->port;
268}
269
270
271/**
272 * Check whether a controller is already started on the given host
273 *
274 * @param host the handle to the host
275 * @return GNUNET_YES if the controller is already started; GNUNET_NO if not
276 */
277int
278GNUNET_TESTBED_host_controller_started (const struct GNUNET_TESTBED_Host *host)
279{
280 return host->controller_started;
281}
282
283
284/**
285 * Obtain the host's configuration template
286 *
287 * @param host handle to the host
288 * @return the host's configuration template
289 */
290const struct GNUNET_CONFIGURATION_Handle *
291GNUNET_TESTBED_host_get_cfg_ (const struct GNUNET_TESTBED_Host *host)
292{
293 return host->cfg;
294}
295
296
297/**
298 * Function to replace host's configuration
299 *
300 * @param host the host handle
301 * @param new_cfg the new configuration to replace the old one
302 */
303void
304GNUNET_TESTBED_host_replace_cfg_ (
305 struct GNUNET_TESTBED_Host *host,
306 const struct GNUNET_CONFIGURATION_Handle *new_cfg)
307{
308 GNUNET_CONFIGURATION_destroy (host->cfg);
309 host->cfg = GNUNET_CONFIGURATION_dup (new_cfg);
310}
311
312
313/**
314 * Create a host to run peers and controllers on.
315 *
316 * @param id global host ID assigned to the host; 0 is
317 * reserved to always mean 'localhost'
318 * @param hostname name of the host, use "NULL" for localhost
319 * @param username username to use for the login; may be NULL
320 * @param cfg the configuration to use as a template while starting a controller
321 * on this host. Operation queue sizes specific to a host are also
322 * read from this configuration handle
323 * @param port port number to use for ssh; use 0 to let ssh decide
324 * @return handle to the host, NULL on error
325 */
326struct GNUNET_TESTBED_Host *
327GNUNET_TESTBED_host_create_with_id (
328 uint32_t id,
329 const char *hostname,
330 const char *username,
331 const struct GNUNET_CONFIGURATION_Handle *cfg,
332 uint16_t port)
333{
334 struct GNUNET_TESTBED_Host *host;
335 unsigned int new_size;
336
337 if ((id < host_list_size) && (NULL != host_list[id]))
338 {
339 LOG (GNUNET_ERROR_TYPE_WARNING, "Host with id: %u already created\n", id);
340 return NULL;
341 }
342 host = GNUNET_new (struct GNUNET_TESTBED_Host);
343 host->hostname = (NULL != hostname) ? GNUNET_strdup (hostname) : NULL;
344 host->username = (NULL != username) ? GNUNET_strdup (username) : NULL;
345 host->id = id;
346 host->port = (0 == port) ? 22 : port;
347 host->cfg = GNUNET_CONFIGURATION_dup (cfg);
348 host->opq_parallel_overlay_connect_operations =
349 GNUNET_TESTBED_operation_queue_create_ (OPERATION_QUEUE_TYPE_ADAPTIVE,
350 UINT_MAX);
351 new_size = host_list_size;
352 while (id >= new_size)
353 new_size += HOST_LIST_GROW_STEP;
354 if (new_size != host_list_size)
355 GNUNET_array_grow (host_list, host_list_size, new_size);
356 GNUNET_assert (id < host_list_size);
357 LOG (GNUNET_ERROR_TYPE_DEBUG, "Adding host with id: %u\n", host->id);
358 host_list[id] = host;
359 return host;
360}
361
362
363/**
364 * Create a host to run peers and controllers on.
365 *
366 * @param hostname name of the host, use "NULL" for localhost
367 * @param username username to use for the login; may be NULL
368 * @param cfg the configuration to use as a template while starting a controller
369 * on this host. Operation queue sizes specific to a host are also
370 * read from this configuration handle
371 * @param port port number to use for ssh; use 0 to let ssh decide
372 * @return handle to the host, NULL on error
373 */
374struct GNUNET_TESTBED_Host *
375GNUNET_TESTBED_host_create (const char *hostname,
376 const char *username,
377 const struct GNUNET_CONFIGURATION_Handle *cfg,
378 uint16_t port)
379{
380 static uint32_t uid_generator;
381
382 if (NULL == hostname)
383 return GNUNET_TESTBED_host_create_with_id (0,
384 hostname,
385 username,
386 cfg,
387 port);
388 return GNUNET_TESTBED_host_create_with_id (++uid_generator,
389 hostname,
390 username,
391 cfg,
392 port);
393}
394
395
396/**
397 * Load a set of hosts from a configuration file.
398 *
399 * @param filename file with the host specification
400 * @param cfg the configuration to use as a template while starting a controller
401 * on any of the loaded hosts. Operation queue sizes specific to a host
402 * are also read from this configuration handle
403 * @param hosts set to the hosts found in the file; caller must free this if
404 * number of hosts returned is greater than 0
405 * @return number of hosts returned in 'hosts', 0 on error
406 */
407unsigned int
408GNUNET_TESTBED_hosts_load_from_file (
409 const char *filename,
410 const struct GNUNET_CONFIGURATION_Handle *cfg,
411 struct GNUNET_TESTBED_Host ***hosts)
412{
413 struct GNUNET_TESTBED_Host *starting_host;
414 char *data;
415 char *buf;
416 char *username;
417 char *hostname;
418 regex_t rex;
419 regmatch_t pmatch[6];
420 uint64_t fs;
421 short int port;
422 unsigned int offset;
423 unsigned int count;
424
425
426 GNUNET_assert (NULL != filename);
427 if (GNUNET_YES != GNUNET_DISK_file_test (filename))
428 {
429 LOG (GNUNET_ERROR_TYPE_WARNING, _ ("Hosts file %s not found\n"), filename);
430 return 0;
431 }
432 if (GNUNET_OK !=
433 GNUNET_DISK_file_size (filename, &fs, GNUNET_YES, GNUNET_YES))
434 fs = 0;
435 if (0 == fs)
436 {
437 LOG (GNUNET_ERROR_TYPE_WARNING,
438 _ ("Hosts file %s has no data\n"),
439 filename);
440 return 0;
441 }
442 data = GNUNET_malloc (fs);
443 if (fs != GNUNET_DISK_fn_read (filename, data, fs))
444 {
445 GNUNET_free (data);
446 LOG (GNUNET_ERROR_TYPE_WARNING,
447 _ ("Hosts file %s cannot be read\n"),
448 filename);
449 return 0;
450 }
451 buf = data;
452 offset = 0;
453 starting_host = NULL;
454 count = 0;
455 /* refer RFC 952 and RFC 1123 for valid hostnames */
456 GNUNET_assert (0 == regcomp (&rex,
457 "^(([[:alnum:]]+)@)?" /* username */
458 "([[:alnum:]]+[-[:alnum:]_\\.]+)" /* hostname */
459 "(:([[:digit:]]{1,5}))?", /* port */
460 REG_EXTENDED | REG_ICASE));
461 while (offset < (fs - 1))
462 {
463 offset++;
464 if (((data[offset] == '\n')) && (buf != &data[offset]))
465 {
466 unsigned int size;
467
468 data[offset] = '\0';
469 username = NULL;
470 hostname = NULL;
471 port = 0;
472 if ((REG_NOMATCH == regexec (&rex, buf, 6, pmatch, 0)) ||
473 (-1 == pmatch[3].rm_so))
474 {
475 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
476 "Error reading line `%s' in hostfile\n",
477 buf);
478 buf = &data[offset + 1];
479 continue;
480 }
481 if (-1 != pmatch[2].rm_so)
482 {
483 size = pmatch[2].rm_eo - pmatch[2].rm_so;
484 username = GNUNET_malloc (size + 1);
485 GNUNET_assert (
486 0 != GNUNET_strlcpy (username, buf + pmatch[2].rm_so, size + 1));
487 }
488 if (-1 != pmatch[5].rm_so)
489 {
490 (void) sscanf (buf + pmatch[5].rm_so, "%5hd", &port);
491 }
492 size = pmatch[3].rm_eo - pmatch[3].rm_so;
493 hostname = GNUNET_malloc (size + 1);
494 GNUNET_assert (
495 0 != GNUNET_strlcpy (hostname, buf + pmatch[3].rm_so, size + 1));
496 LOG (GNUNET_ERROR_TYPE_DEBUG,
497 "Successfully read host %s, port %d and user %s from file\n",
498 (NULL == hostname) ? "NULL" : hostname,
499 port,
500 (NULL == username) ? "NULL" : username);
501 /* We store hosts in a static list; hence we only require the starting
502 * host pointer in that list to access the newly created list of hosts */
503 if (NULL == starting_host)
504 starting_host =
505 GNUNET_TESTBED_host_create (hostname, username, cfg, port);
506 else
507 (void) GNUNET_TESTBED_host_create (hostname, username, cfg, port);
508 count++;
509 GNUNET_free (username);
510 GNUNET_free (hostname);
511 buf = &data[offset + 1];
512 }
513 else if ((data[offset] == '\n') || (data[offset] == '\0'))
514 buf = &data[offset + 1];
515 }
516 regfree (&rex);
517 GNUNET_free (data);
518 if (NULL == starting_host)
519 return 0;
520 *hosts = GNUNET_malloc (sizeof(struct GNUNET_TESTBED_Host *) * count);
521 GNUNET_memcpy (*hosts,
522 &host_list[GNUNET_TESTBED_host_get_id_ (starting_host)],
523 sizeof(struct GNUNET_TESTBED_Host *) * count);
524 return count;
525}
526
527
528/**
529 * Resolves a hostname using getaddrinfo
530 *
531 * @param host the hostname
532 * @return the string representing the IPv4 address of the given host; NULL upon error
533 */
534const char *
535simple_resolve (const char *host)
536{
537 struct addrinfo *res;
538 const struct sockaddr_in *in_addr;
539 char *hostip;
540 struct addrinfo hint;
541 unsigned int rc;
542
543 hint.ai_family = AF_INET; /* IPv4 */
544 hint.ai_socktype = 0;
545 hint.ai_protocol = 0;
546 hint.ai_addrlen = 0;
547 hint.ai_addr = NULL;
548 hint.ai_canonname = NULL;
549 hint.ai_next = NULL;
550 hint.ai_flags = AI_NUMERICSERV;
551 res = NULL;
552 LOG_DEBUG ("Resolving [%s]\n", host);
553 if (0 != (rc = getaddrinfo (host, "22", &hint, &res)))
554 {
555 LOG_GAI (GNUNET_ERROR_TYPE_ERROR, "getaddrinfo", rc);
556 return NULL;
557 }
558 GNUNET_assert (NULL != res);
559 GNUNET_assert (NULL != res->ai_addr);
560 GNUNET_assert (sizeof(struct sockaddr_in) == res->ai_addrlen);
561 in_addr = (const struct sockaddr_in *) res->ai_addr;
562 hostip = inet_ntoa (in_addr->sin_addr);
563 GNUNET_assert (NULL != hostip);
564 freeaddrinfo (res);
565 LOG_DEBUG ("Resolved [%s] to [%s]\n", host, hostip);
566 return hostip;
567}
568
569
570/**
571 * Loads the set of host allocated by the LoadLeveler Job Scheduler. This
572 * function is only available when compiled with support for LoadLeveler and is
573 * used for running on the SuperMUC
574 *
575 * @param cfg the configuration to use as a template while starting a controller
576 * on any of the loaded hosts. Operation queue sizes specific to a host
577 * are also read from this configuration handle
578 * @param hosts set to the hosts found in the file; caller must free this if
579 * number of hosts returned is greater than 0
580 * @return number of hosts returned in 'hosts', 0 on error
581 */
582unsigned int
583GNUNET_TESTBED_hosts_load_from_loadleveler (
584 const struct GNUNET_CONFIGURATION_Handle *cfg,
585 struct GNUNET_TESTBED_Host ***hosts)
586{
587#if ! ENABLE_SUPERMUC
588 LOG (GNUNET_ERROR_TYPE_ERROR,
589 _ ("The function %s is only available when compiled with (--with-ll)\n"),
590 __func__);
591 GNUNET_assert (0);
592#else
593 const char *hostfile;
594
595 if (NULL == (hostfile = getenv ("MP_SAVEHOSTFILE")))
596 {
597 GNUNET_break (0);
598 return 0;
599 }
600 return GNUNET_TESTBED_hosts_load_from_file (hostfile, cfg, hosts);
601#endif
602}
603
604
605/**
606 * Destroy a host handle. Must only be called once everything
607 * running on that host has been stopped.
608 *
609 * @param host handle to destroy
610 */
611void
612GNUNET_TESTBED_host_destroy (struct GNUNET_TESTBED_Host *host)
613{
614 GNUNET_assert (host->id < host_list_size);
615 GNUNET_assert (host_list[host->id] == host);
616 host_list[host->id] = NULL;
617 /* clear registered controllers list */
618 for (struct RegisteredController *rc = host->rc_head;
619 NULL != rc;
620 rc = host->rc_head)
621 {
622 GNUNET_CONTAINER_DLL_remove (host->rc_head, host->rc_tail, rc);
623 GNUNET_free (rc);
624 }
625 GNUNET_free_nz ((char *) host->username);
626 GNUNET_free_nz ((char *) host->hostname);
627 GNUNET_TESTBED_operation_queue_destroy_ (
628 host->opq_parallel_overlay_connect_operations);
629 GNUNET_CONFIGURATION_destroy (host->cfg);
630 GNUNET_free (host);
631 while (host_list_size >= HOST_LIST_GROW_STEP)
632 {
633 uint32_t id;
634
635 for (id = host_list_size - 1; id > host_list_size - HOST_LIST_GROW_STEP;
636 id--)
637 if (NULL != host_list[id])
638 break;
639 if (id != host_list_size - HOST_LIST_GROW_STEP)
640 break;
641 if (NULL != host_list[id])
642 break;
643 host_list_size -= HOST_LIST_GROW_STEP;
644 }
645 host_list =
646 GNUNET_realloc (host_list,
647 sizeof(struct GNUNET_TESTBED_Host *) * host_list_size);
648}
649
650
651/**
652 * Marks a host as registered with a controller
653 *
654 * @param host the host to mark
655 * @param controller the controller at which this host is registered
656 */
657void
658GNUNET_TESTBED_mark_host_registered_at_ (
659 struct GNUNET_TESTBED_Host *host,
660 const struct GNUNET_TESTBED_Controller *const controller)
661{
662 struct RegisteredController *rc;
663
664 for (rc = host->rc_head; NULL != rc; rc = rc->next)
665 {
666 if (controller == rc->controller) /* already registered at controller */
667 {
668 GNUNET_break (0);
669 return;
670 }
671 }
672 rc = GNUNET_new (struct RegisteredController);
673 rc->controller = controller;
674 GNUNET_CONTAINER_DLL_insert_tail (host->rc_head, host->rc_tail, rc);
675}
676
677
678/**
679 * Unmarks a host registered at a controller
680 *
681 * @param host the host to unmark
682 * @param controller the controller at which this host has to be unmarked
683 */
684void
685GNUNET_TESTBED_deregister_host_at_ (
686 struct GNUNET_TESTBED_Host *host,
687 const struct GNUNET_TESTBED_Controller *const controller)
688{
689 struct RegisteredController *rc;
690
691 for (rc = host->rc_head; NULL != rc; rc = rc->next)
692 if (controller == rc->controller)
693 break;
694 if (NULL == rc)
695 {
696 GNUNET_break (0);
697 return;
698 }
699 GNUNET_CONTAINER_DLL_remove (host->rc_head, host->rc_tail, rc);
700 GNUNET_free (rc);
701}
702
703
704/**
705 * Checks whether a host has been registered
706 *
707 * @param host the host to check
708 * @param controller the controller at which host's registration is checked
709 * @return GNUNET_YES if registered; GNUNET_NO if not
710 */
711int
712GNUNET_TESTBED_is_host_registered_ (
713 const struct GNUNET_TESTBED_Host *host,
714 const struct GNUNET_TESTBED_Controller *const controller)
715{
716 struct RegisteredController *rc;
717
718 for (rc = host->rc_head; NULL != rc; rc = rc->next)
719 {
720 if (controller == rc->controller) /* already registered at controller */
721 {
722 return GNUNET_YES;
723 }
724 }
725 return GNUNET_NO;
726}
727
728
729/**
730 * Handle for controller process
731 */
732struct GNUNET_TESTBED_ControllerProc
733{
734 /**
735 * The process handle
736 */
737 struct GNUNET_HELPER_Handle *helper;
738
739 /**
740 * The arguments used to start the helper
741 */
742 char **helper_argv;
743
744 /**
745 * The host where the helper is run
746 */
747 struct GNUNET_TESTBED_Host *host;
748
749 /**
750 * The controller error callback
751 */
752 GNUNET_TESTBED_ControllerStatusCallback cb;
753
754 /**
755 * The closure for the above callback
756 */
757 void *cls;
758
759 /**
760 * The send handle for the helper
761 */
762 struct GNUNET_HELPER_SendHandle *shandle;
763
764 /**
765 * The message corresponding to send handle
766 */
767 struct GNUNET_MessageHeader *msg;
768};
769
770
771/**
772 * Function to copy NULL terminated list of arguments
773 *
774 * @param argv the NULL terminated list of arguments. Cannot be NULL.
775 * @return the copied NULL terminated arguments
776 */
777static char **
778copy_argv (const char *const *argv)
779{
780 char **argv_dup;
781 unsigned int argp;
782
783 GNUNET_assert (NULL != argv);
784 for (argp = 0; NULL != argv[argp]; argp++)
785 ;
786 argv_dup = GNUNET_malloc (sizeof(char *) * (argp + 1));
787 for (argp = 0; NULL != argv[argp]; argp++)
788 argv_dup[argp] = GNUNET_strdup (argv[argp]);
789 return argv_dup;
790}
791
792
793/**
794 * Function to join NULL terminated list of arguments
795 *
796 * @param argv1 the NULL terminated list of arguments. Cannot be NULL.
797 * @param argv2 the NULL terminated list of arguments. Cannot be NULL.
798 * @return the joined NULL terminated arguments
799 */
800static char **
801join_argv (const char *const *argv1, const char *const *argv2)
802{
803 char **argvj;
804 char *argv;
805 unsigned int carg;
806 unsigned int cnt;
807
808 carg = 0;
809 argvj = NULL;
810 for (cnt = 0; NULL != argv1[cnt]; cnt++)
811 {
812 argv = GNUNET_strdup (argv1[cnt]);
813 GNUNET_array_append (argvj, carg, argv);
814 }
815 for (cnt = 0; NULL != argv2[cnt]; cnt++)
816 {
817 argv = GNUNET_strdup (argv2[cnt]);
818 GNUNET_array_append (argvj, carg, argv);
819 }
820 GNUNET_array_append (argvj, carg, NULL);
821 return argvj;
822}
823
824
825/**
826 * Frees the given NULL terminated arguments
827 *
828 * @param argv the NULL terminated list of arguments
829 */
830static void
831free_argv (char **argv)
832{
833 unsigned int argp;
834
835 for (argp = 0; NULL != argv[argp]; argp++)
836 GNUNET_free (argv[argp]);
837 GNUNET_free (argv);
838}
839
840
841/**
842 * Generates arguments for opening a remote shell. Builds up the arguments
843 * from the environment variable GNUNET_TESTBED_RSH_CMD. The variable
844 * should not mention `-p' (port) option and destination address as these will
845 * be set locally in the function from its parameteres. If the environmental
846 * variable is not found then it defaults to `ssh -o BatchMode=yes -o
847 * NoHostAuthenticationForLocalhost=yes -o StrictHostkeyChecking=no -o
848 * PasswordAuthentication=noc'
849 *
850 * @param port the destination port number
851 * @param hostname the hostname of the target host
852 * @param username the username to use while connecting to target host
853 * @return NULL terminated list of arguments
854 */
855static char **
856gen_rsh_args (const char *port, const char *hostname, const char *username)
857{
858 static const char *default_ssh_args[] =
859 { "ssh",
860 "-o",
861 "BatchMode=yes",
862 "-o",
863 "NoHostAuthenticationForLocalhost=yes",
864 "-o",
865 "StrictHostKeyChecking=no",
866 "-o",
867 "PasswordAuthentication=no",
868 "%h",
869 NULL };
870 char **ssh_args;
871 char *ssh_cmd;
872 char *ssh_cmd_cp;
873 char *arg;
874 const char *new_arg;
875 unsigned int size;
876 unsigned int cnt;
877
878 ssh_args = NULL;
879 if (NULL != (ssh_cmd = getenv ("GNUNET_TESTBED_RSH_CMD")))
880 {
881 ssh_cmd = GNUNET_strdup (ssh_cmd);
882 ssh_cmd_cp = ssh_cmd;
883 for (size = 0; NULL != (arg = strtok (ssh_cmd, " ")); ssh_cmd = NULL)
884 GNUNET_array_append (ssh_args, size, GNUNET_strdup (arg));
885 GNUNET_free (ssh_cmd_cp);
886 }
887 else
888 {
889 ssh_args = copy_argv (default_ssh_args);
890 size = (sizeof(default_ssh_args)) / (sizeof(const char *));
891 GNUNET_array_grow (ssh_args, size, size - 1);
892 }
893 for (cnt = 0; cnt < size; cnt++)
894 {
895 arg = ssh_args[cnt];
896 if ('%' != arg[0])
897 continue;
898 switch (arg[1])
899 {
900 case 'p':
901 new_arg = port;
902 break;
903
904 case 'u':
905 new_arg = username;
906 break;
907
908 case 'h':
909 new_arg = hostname;
910 break;
911
912 default:
913 continue;
914 }
915 if (NULL == new_arg)
916 continue;
917 GNUNET_free (arg);
918 ssh_args[cnt] = GNUNET_strdup (new_arg);
919 }
920 GNUNET_array_append (ssh_args, size, NULL);
921 return ssh_args;
922}
923
924
925/**
926 * Generates the arguments needed for executing the given binary in a remote
927 * shell. Builds the arguments from the environmental variable
928 * GNUNET_TETSBED_RSH_CMD_SUFFIX. If the environmental variable is not found,
929 * only the given binary name will be present in the returned arguments
930 *
931 * @param append_args the arguments to append after generating the suffix
932 * arguments. Can be NULL; if not must be NULL terminated 'char *' array
933 * @return NULL-terminated args
934 */
935static char **
936gen_rsh_suffix_args (const char *const *append_args)
937{
938 char **rshell_args;
939 char *rshell_cmd;
940 char *rshell_cmd_cp;
941 char *arg;
942 unsigned int cnt;
943 unsigned int append_cnt;
944
945 rshell_args = NULL;
946 cnt = 0;
947 if (NULL != (rshell_cmd = getenv ("GNUNET_TESTBED_RSH_CMD_SUFFIX")))
948 {
949 rshell_cmd = GNUNET_strdup (rshell_cmd);
950 rshell_cmd_cp = rshell_cmd;
951 for (; NULL != (arg = strtok (rshell_cmd, " ")); rshell_cmd = NULL)
952 GNUNET_array_append (rshell_args, cnt, GNUNET_strdup (arg));
953 GNUNET_free (rshell_cmd_cp);
954 }
955 if (NULL != append_args)
956 {
957 for (append_cnt = 0; NULL != append_args[append_cnt]; append_cnt++)
958 GNUNET_array_append (rshell_args,
959 cnt,
960 GNUNET_strdup (append_args[append_cnt]));
961 }
962 GNUNET_array_append (rshell_args, cnt, NULL);
963 return rshell_args;
964}
965
966
967/**
968 * Functions with this signature are called whenever a
969 * complete message is received by the tokenizer.
970 *
971 * Do not call GNUNET_SERVER_mst_destroy in callback
972 *
973 * @param cls closure
974 * @param client identification of the client
975 * @param message the actual message
976 *
977 * @return #GNUNET_OK on success, #GNUNET_SYSERR to stop further processing
978 */
979static int
980helper_mst (void *cls, const struct GNUNET_MessageHeader *message)
981{
982 struct GNUNET_TESTBED_ControllerProc *cp = cls;
983 const struct GNUNET_TESTBED_HelperReply *msg;
984 const char *hostname;
985 char *config;
986 uLongf config_size;
987 uLongf xconfig_size;
988
989 msg = (const struct GNUNET_TESTBED_HelperReply *) message;
990 GNUNET_assert (sizeof(struct GNUNET_TESTBED_HelperReply) <
991 ntohs (msg->header.size));
992 GNUNET_assert (GNUNET_MESSAGE_TYPE_TESTBED_HELPER_REPLY ==
993 ntohs (msg->header.type));
994 config_size = (uLongf) ntohs (msg->config_size);
995 xconfig_size = (uLongf) (ntohs (msg->header.size)
996 - sizeof(struct GNUNET_TESTBED_HelperReply));
997 config = GNUNET_malloc (config_size);
998 GNUNET_assert (Z_OK == uncompress ((Bytef *) config,
999 &config_size,
1000 (const Bytef *) &msg[1],
1001 xconfig_size));
1002 /* Replace the configuration template present in the host with the
1003 controller's running configuration */
1004 GNUNET_CONFIGURATION_destroy (cp->host->cfg);
1005 cp->host->cfg = GNUNET_CONFIGURATION_create ();
1006 GNUNET_assert (GNUNET_CONFIGURATION_deserialize (cp->host->cfg,
1007 config,
1008 config_size,
1009 NULL));
1010 GNUNET_free (config);
1011 if (NULL == (hostname = GNUNET_TESTBED_host_get_hostname (cp->host)))
1012 hostname = "localhost";
1013 /* Change the hostname so that we can connect to it */
1014 GNUNET_CONFIGURATION_set_value_string (cp->host->cfg,
1015 "testbed",
1016 "hostname",
1017 hostname);
1018 cp->host->locked = GNUNET_NO;
1019 cp->host->controller_started = GNUNET_YES;
1020 cp->cb (cp->cls, cp->host->cfg, GNUNET_OK);
1021 return GNUNET_OK;
1022}
1023
1024
1025/**
1026 * Continuation function from GNUNET_HELPER_send()
1027 *
1028 * @param cls closure
1029 * @param result GNUNET_OK on success,
1030 * GNUNET_NO if helper process died
1031 * GNUNET_SYSERR during GNUNET_HELPER_stop
1032 */
1033static void
1034clear_msg (void *cls, int result)
1035{
1036 struct GNUNET_TESTBED_ControllerProc *cp = cls;
1037
1038 GNUNET_assert (NULL != cp->shandle);
1039 cp->shandle = NULL;
1040 GNUNET_free (cp->msg);
1041 cp->msg = NULL;
1042}
1043
1044
1045/**
1046 * Callback that will be called when the helper process dies. This is not called
1047 * when the helper process is stopped using GNUNET_HELPER_stop()
1048 *
1049 * @param cls the closure from GNUNET_HELPER_start()
1050 */
1051static void
1052helper_exp_cb (void *cls)
1053{
1054 struct GNUNET_TESTBED_ControllerProc *cp = cls;
1055 GNUNET_TESTBED_ControllerStatusCallback cb;
1056 void *cb_cls;
1057
1058 cb = cp->cb;
1059 cb_cls = cp->cls;
1060 cp->helper = NULL;
1061 GNUNET_TESTBED_controller_stop (cp);
1062 if (NULL != cb)
1063 cb (cb_cls, NULL, GNUNET_SYSERR);
1064}
1065
1066
1067/**
1068 * Starts a controller process at the given host. The given host's configuration
1069 * is used as a Template configuration to use for the remote controller; the
1070 * remote controller will be started with a slightly modified configuration
1071 * (port numbers, unix domain sockets and service home values are changed as per
1072 * TESTING library on the remote host). The modified configuration replaces the
1073 * host's existing configuration before signalling success through the
1074 * GNUNET_TESTBED_ControllerStatusCallback()
1075 *
1076 * @param trusted_ip the ip address of the controller which will be set as TRUSTED
1077 * HOST(all connections form this ip are permitted by the testbed) when
1078 * starting testbed controller at host. This can either be a single ip
1079 * address or a network address in CIDR notation.
1080 * @param host the host where the controller has to be started. CANNOT be NULL.
1081 * @param cb function called when the controller is successfully started or
1082 * dies unexpectedly; GNUNET_TESTBED_controller_stop shouldn't be
1083 * called if cb is called with GNUNET_SYSERR as status. Will never be
1084 * called in the same task as 'GNUNET_TESTBED_controller_start'
1085 * (synchronous errors will be signalled by returning NULL). This
1086 * parameter cannot be NULL.
1087 * @param cls closure for above callbacks
1088 * @return the controller process handle, NULL on errors
1089 */
1090struct GNUNET_TESTBED_ControllerProc *
1091GNUNET_TESTBED_controller_start (const char *trusted_ip,
1092 struct GNUNET_TESTBED_Host *host,
1093 GNUNET_TESTBED_ControllerStatusCallback cb,
1094 void *cls)
1095{
1096 struct GNUNET_TESTBED_ControllerProc *cp;
1097 struct GNUNET_TESTBED_HelperInit *msg;
1098 const struct GNUNET_CONFIGURATION_Handle *cfg;
1099 const char *hostname;
1100 static char *const binary_argv[] = { HELPER_TESTBED_BINARY, NULL };
1101
1102 GNUNET_assert (NULL != host);
1103 GNUNET_assert (NULL != (cfg = GNUNET_TESTBED_host_get_cfg_ (host)));
1104 hostname = NULL;
1105 API_VIOLATION (
1106 GNUNET_NO == host->locked,
1107 "Host is already locked by a previous call to GNUNET_TESTBED_controller_start()");
1108 host->locked = GNUNET_YES;
1109 API_VIOLATION (
1110 GNUNET_NO == host->controller_started,
1111 "Attempting to start a controller on a host which is already started a controller");
1112 cp = GNUNET_new (struct GNUNET_TESTBED_ControllerProc);
1113 if (0 == GNUNET_TESTBED_host_get_id_ (host))
1114 {
1115 cp->helper = GNUNET_HELPER_start (GNUNET_YES,
1116 HELPER_TESTBED_BINARY,
1117 binary_argv,
1118 &helper_mst,
1119 &helper_exp_cb,
1120 cp);
1121 }
1122 else
1123 {
1124 char *helper_binary_path_args[2];
1125 char **rsh_args;
1126 char **rsh_suffix_args;
1127 const char *username;
1128 char *port;
1129 char *argstr;
1130 char *aux;
1131 unsigned int cnt;
1132
1133 username = host->username;
1134 hostname = host->hostname;
1135 GNUNET_asprintf (&port, "%u", host->port);
1136 LOG_DEBUG ("Starting remote connection to destination %s\n", hostname);
1137 if (GNUNET_OK !=
1138 GNUNET_CONFIGURATION_get_value_filename (cfg,
1139 "testbed",
1140 "HELPER_BINARY_PATH",
1141 &helper_binary_path_args[0]))
1142 helper_binary_path_args[0] =
1143 GNUNET_OS_get_libexec_binary_path (HELPER_TESTBED_BINARY);
1144 helper_binary_path_args[1] = NULL;
1145 rsh_args = gen_rsh_args (port, hostname, username);
1146 rsh_suffix_args =
1147 gen_rsh_suffix_args ((const char **) helper_binary_path_args);
1148 cp->helper_argv =
1149 join_argv ((const char **) rsh_args, (const char **) rsh_suffix_args);
1150 free_argv (rsh_args);
1151 free_argv (rsh_suffix_args);
1152 GNUNET_free (port);
1153 argstr = GNUNET_strdup ("");
1154 for (cnt = 0; NULL != cp->helper_argv[cnt]; cnt++)
1155 {
1156 aux = argstr;
1157 GNUNET_assert (
1158 0 < GNUNET_asprintf (&argstr, "%s %s", aux, cp->helper_argv[cnt]));
1159 GNUNET_free (aux);
1160 }
1161 LOG_DEBUG ("Helper cmd str: %s\n", argstr);
1162 GNUNET_free (argstr);
1163 cp->helper = GNUNET_HELPER_start (GNUNET_NO,
1164 cp->helper_argv[0],
1165 cp->helper_argv,
1166 &helper_mst,
1167 &helper_exp_cb,
1168 cp);
1169 GNUNET_free (helper_binary_path_args[0]);
1170 }
1171 if (NULL == cp->helper)
1172 {
1173 if (NULL != cp->helper_argv)
1174 free_argv (cp->helper_argv);
1175 GNUNET_free (cp);
1176 return NULL;
1177 }
1178 cp->host = host;
1179 cp->cb = cb;
1180 cp->cls = cls;
1181 msg = GNUNET_TESTBED_create_helper_init_msg_ (trusted_ip, hostname, cfg);
1182 cp->msg = &msg->header;
1183 cp->shandle =
1184 GNUNET_HELPER_send (cp->helper, &msg->header, GNUNET_NO, &clear_msg, cp);
1185 if (NULL == cp->shandle)
1186 {
1187 GNUNET_free (msg);
1188 GNUNET_TESTBED_controller_stop (cp);
1189 return NULL;
1190 }
1191 return cp;
1192}
1193
1194
1195/**
1196 * Sends termination signal to the controller's helper process
1197 *
1198 * @param cproc the handle to the controller's helper process
1199 */
1200void
1201GNUNET_TESTBED_controller_kill_ (struct GNUNET_TESTBED_ControllerProc *cproc)
1202{
1203 if (NULL != cproc->shandle)
1204 GNUNET_HELPER_send_cancel (cproc->shandle);
1205 if (NULL != cproc->helper)
1206 GNUNET_HELPER_kill (cproc->helper, GNUNET_YES);
1207}
1208
1209
1210/**
1211 * Cleans-up the controller's helper process handle
1212 *
1213 * @param cproc the handle to the controller's helper process
1214 */
1215void
1216GNUNET_TESTBED_controller_destroy_ (struct GNUNET_TESTBED_ControllerProc *cproc)
1217{
1218 if (NULL != cproc->helper)
1219 {
1220 GNUNET_break (GNUNET_OK == GNUNET_HELPER_wait (cproc->helper));
1221 GNUNET_HELPER_destroy (cproc->helper);
1222 }
1223 if (NULL != cproc->helper_argv)
1224 free_argv (cproc->helper_argv);
1225 cproc->host->controller_started = GNUNET_NO;
1226 cproc->host->locked = GNUNET_NO;
1227 GNUNET_free (cproc->msg);
1228 GNUNET_free (cproc);
1229}
1230
1231
1232/**
1233 * Stop the controller process (also will terminate all peers and controllers
1234 * dependent on this controller). This function blocks until the testbed has
1235 * been fully terminated (!). The controller status cb from
1236 * GNUNET_TESTBED_controller_start() will not be called.
1237 *
1238 * @param cproc the controller process handle
1239 */
1240void
1241GNUNET_TESTBED_controller_stop (struct GNUNET_TESTBED_ControllerProc *cproc)
1242{
1243 GNUNET_TESTBED_controller_kill_ (cproc);
1244 GNUNET_TESTBED_controller_destroy_ (cproc);
1245}
1246
1247
1248/**
1249 * The handle for whether a host is habitable or not
1250 */
1251struct GNUNET_TESTBED_HostHabitableCheckHandle
1252{
1253 /**
1254 * The host to check
1255 */
1256 const struct GNUNET_TESTBED_Host *host;
1257
1258 /**
1259 * The callback to call once we have the status
1260 */
1261 GNUNET_TESTBED_HostHabitableCallback cb;
1262
1263 /**
1264 * The callback closure
1265 */
1266 void *cb_cls;
1267
1268 /**
1269 * The process handle for the SSH process
1270 */
1271 struct GNUNET_OS_Process *auxp;
1272
1273 /**
1274 * The arguments used to start the helper
1275 */
1276 char **helper_argv;
1277
1278 /**
1279 * Task id for the habitability check task
1280 */
1281 struct GNUNET_SCHEDULER_Task *habitability_check_task;
1282
1283 /**
1284 * How long we wait before checking the process status. Should grow
1285 * exponentially
1286 */
1287 struct GNUNET_TIME_Relative wait_time;
1288};
1289
1290
1291/**
1292 * Task for checking whether a host is habitable or not
1293 *
1294 * @param cls GNUNET_TESTBED_HostHabitableCheckHandle
1295 */
1296static void
1297habitability_check (void *cls)
1298{
1299 struct GNUNET_TESTBED_HostHabitableCheckHandle *h = cls;
1300 void *cb_cls;
1301 GNUNET_TESTBED_HostHabitableCallback cb;
1302 const struct GNUNET_TESTBED_Host *host;
1303 unsigned long code;
1304 enum GNUNET_OS_ProcessStatusType type;
1305 int ret;
1306
1307 h->habitability_check_task = NULL;
1308 ret = GNUNET_OS_process_status (h->auxp, &type, &code);
1309 if (GNUNET_SYSERR == ret)
1310 {
1311 GNUNET_break (0);
1312 ret = GNUNET_NO;
1313 goto call_cb;
1314 }
1315 if (GNUNET_NO == ret)
1316 {
1317 h->wait_time = GNUNET_TIME_STD_BACKOFF (h->wait_time);
1318 h->habitability_check_task =
1319 GNUNET_SCHEDULER_add_delayed (h->wait_time, &habitability_check, h);
1320 return;
1321 }
1322 GNUNET_OS_process_destroy (h->auxp);
1323 h->auxp = NULL;
1324 ret = (0 != code) ? GNUNET_NO : GNUNET_YES;
1325
1326 call_cb:
1327 if (NULL != h->auxp)
1328 GNUNET_OS_process_destroy (h->auxp);
1329 cb = h->cb;
1330 cb_cls = h->cb_cls;
1331 host = h->host;
1332 free_argv (h->helper_argv);
1333 GNUNET_free (h);
1334 if (NULL != cb)
1335 cb (cb_cls, host, ret);
1336}
1337
1338
1339/**
1340 * Checks whether a host can be used to start testbed service
1341 *
1342 * @param host the host to check
1343 * @param config the configuration handle to lookup the path of the testbed
1344 * helper
1345 * @param cb the callback to call to inform about habitability of the given host
1346 * @param cb_cls the closure for the callback
1347 * @return NULL upon any error or a handle which can be passed to
1348 * GNUNET_TESTBED_is_host_habitable_cancel()
1349 */
1350struct GNUNET_TESTBED_HostHabitableCheckHandle *
1351GNUNET_TESTBED_is_host_habitable (
1352 const struct GNUNET_TESTBED_Host *host,
1353 const struct GNUNET_CONFIGURATION_Handle *config,
1354 GNUNET_TESTBED_HostHabitableCallback cb,
1355 void *cb_cls)
1356{
1357 struct GNUNET_TESTBED_HostHabitableCheckHandle *h;
1358 char **rsh_args;
1359 char **rsh_suffix_args;
1360 char *stat_args[3];
1361 const char *hostname;
1362 char *port;
1363
1364 h = GNUNET_new (struct GNUNET_TESTBED_HostHabitableCheckHandle);
1365 h->cb = cb;
1366 h->cb_cls = cb_cls;
1367 h->host = host;
1368 hostname = (NULL == host->hostname) ? "127.0.0.1" : host->hostname;
1369 if (GNUNET_OK !=
1370 GNUNET_CONFIGURATION_get_value_filename (config,
1371 "testbed",
1372 "HELPER_BINARY_PATH",
1373 &stat_args[1]))
1374 stat_args[1] = GNUNET_OS_get_libexec_binary_path (HELPER_TESTBED_BINARY);
1375 GNUNET_asprintf (&port, "%u", host->port);
1376 rsh_args = gen_rsh_args (port, hostname, host->username);
1377 GNUNET_free (port);
1378 port = NULL;
1379 stat_args[0] = "stat";
1380 stat_args[2] = NULL;
1381 rsh_suffix_args = gen_rsh_suffix_args ((const char **) stat_args);
1382 GNUNET_free (stat_args[1]);
1383 h->helper_argv =
1384 join_argv ((const char **) rsh_args, (const char **) rsh_suffix_args);
1385 free_argv (rsh_suffix_args);
1386 free_argv (rsh_args);
1387 h->auxp = GNUNET_OS_start_process_vap (GNUNET_OS_INHERIT_STD_ERR,
1388 NULL,
1389 NULL,
1390 NULL,
1391 h->helper_argv[0],
1392 h->helper_argv);
1393 if (NULL == h->auxp)
1394 {
1395 GNUNET_break (0); /* Cannot exec SSH? */
1396 GNUNET_free (h);
1397 return NULL;
1398 }
1399 h->wait_time = GNUNET_TIME_STD_BACKOFF (h->wait_time);
1400 h->habitability_check_task =
1401 GNUNET_SCHEDULER_add_delayed (h->wait_time, &habitability_check, h);
1402 return h;
1403}
1404
1405
1406/**
1407 * Function to cancel a request started using GNUNET_TESTBED_is_host_habitable()
1408 *
1409 * @param handle the habitability check handle
1410 */
1411void
1412GNUNET_TESTBED_is_host_habitable_cancel (
1413 struct GNUNET_TESTBED_HostHabitableCheckHandle *handle)
1414{
1415 GNUNET_SCHEDULER_cancel (handle->habitability_check_task);
1416 (void) GNUNET_OS_process_kill (handle->auxp, GNUNET_TERM_SIG);
1417 (void) GNUNET_OS_process_wait (handle->auxp);
1418 GNUNET_OS_process_destroy (handle->auxp);
1419 free_argv (handle->helper_argv);
1420 GNUNET_free (handle);
1421}
1422
1423
1424/**
1425 * Register a host with the controller
1426 *
1427 * @param controller the controller handle
1428 * @param host the host to register
1429 * @param cc the completion callback to call to inform the status of
1430 * registration. After calling this callback the registration handle
1431 * will be invalid. Cannot be NULL.
1432 * @param cc_cls the closure for the cc
1433 * @return handle to the host registration which can be used to cancel the
1434 * registration
1435 */
1436struct GNUNET_TESTBED_HostRegistrationHandle *
1437GNUNET_TESTBED_register_host (struct GNUNET_TESTBED_Controller *controller,
1438 struct GNUNET_TESTBED_Host *host,
1439 GNUNET_TESTBED_HostRegistrationCompletion cc,
1440 void *cc_cls)
1441{
1442 struct GNUNET_TESTBED_HostRegistrationHandle *rh;
1443 struct GNUNET_TESTBED_AddHostMessage *msg;
1444 const char *username;
1445 const char *hostname;
1446 char *config;
1447 char *cconfig;
1448 void *ptr;
1449 size_t cc_size;
1450 size_t config_size;
1451 uint16_t msg_size;
1452 uint16_t username_length;
1453 uint16_t hostname_length;
1454
1455 if (NULL != controller->rh)
1456 return NULL;
1457 hostname = GNUNET_TESTBED_host_get_hostname (host);
1458 if (GNUNET_YES == GNUNET_TESTBED_is_host_registered_ (host, controller))
1459 {
1460 LOG (GNUNET_ERROR_TYPE_WARNING,
1461 "Host hostname: %s already registered\n",
1462 (NULL == hostname) ? "localhost" : hostname);
1463 return NULL;
1464 }
1465 rh = GNUNET_new (struct GNUNET_TESTBED_HostRegistrationHandle);
1466 rh->host = host;
1467 rh->c = controller;
1468 GNUNET_assert (NULL != cc);
1469 rh->cc = cc;
1470 rh->cc_cls = cc_cls;
1471 controller->rh = rh;
1472 username = GNUNET_TESTBED_host_get_username_ (host);
1473 username_length = 0;
1474 if (NULL != username)
1475 username_length = strlen (username);
1476 GNUNET_assert (NULL != hostname); /* Hostname must be present */
1477 hostname_length = strlen (hostname);
1478 GNUNET_assert (NULL != host->cfg);
1479 config = GNUNET_CONFIGURATION_serialize (host->cfg, &config_size);
1480 cc_size = GNUNET_TESTBED_compress_config_ (config, config_size, &cconfig);
1481 GNUNET_free (config);
1482 msg_size = (sizeof(struct GNUNET_TESTBED_AddHostMessage));
1483 msg_size += username_length;
1484 msg_size += hostname_length;
1485 msg_size += cc_size;
1486 msg = GNUNET_malloc (msg_size);
1487 msg->header.size = htons (msg_size);
1488 msg->header.type = htons (GNUNET_MESSAGE_TYPE_TESTBED_ADD_HOST);
1489 msg->host_id = htonl (GNUNET_TESTBED_host_get_id_ (host));
1490 msg->ssh_port = htons (GNUNET_TESTBED_host_get_ssh_port_ (host));
1491 ptr = &msg[1];
1492 if (NULL != username)
1493 {
1494 msg->username_length = htons (username_length);
1495 GNUNET_memcpy (ptr, username, username_length);
1496 ptr += username_length;
1497 }
1498 msg->hostname_length = htons (hostname_length);
1499 GNUNET_memcpy (ptr, hostname, hostname_length);
1500 ptr += hostname_length;
1501 msg->config_size = htons (config_size);
1502 GNUNET_memcpy (ptr, cconfig, cc_size);
1503 ptr += cc_size;
1504 GNUNET_assert ((ptr - (void *) msg) == msg_size);
1505 GNUNET_free (cconfig);
1506 GNUNET_TESTBED_queue_message_ (controller,
1507 (struct GNUNET_MessageHeader *) msg);
1508 return rh;
1509}
1510
1511
1512/**
1513 * Cancel the pending registration. Note that if the registration message is
1514 * already sent to the service the cancellation has only the effect that the
1515 * registration completion callback for the registration is never called.
1516 *
1517 * @param handle the registration handle to cancel
1518 */
1519void
1520GNUNET_TESTBED_cancel_registration (
1521 struct GNUNET_TESTBED_HostRegistrationHandle *handle)
1522{
1523 if (handle != handle->c->rh)
1524 {
1525 GNUNET_break (0);
1526 return;
1527 }
1528 handle->c->rh = NULL;
1529 GNUNET_free (handle);
1530}
1531
1532
1533/**
1534 * Queues the given operation in the queue for parallel overlay connects of the
1535 * given host
1536 *
1537 * @param h the host handle
1538 * @param op the operation to queue in the given host's parally overlay connect
1539 * queue
1540 */
1541void
1542GNUNET_TESTBED_host_queue_oc_ (struct GNUNET_TESTBED_Host *h,
1543 struct GNUNET_TESTBED_Operation *op)
1544{
1545 GNUNET_TESTBED_operation_queue_insert_ (
1546 h->opq_parallel_overlay_connect_operations,
1547 op);
1548}
1549
1550
1551/**
1552 * Resolves the hostname of the host to an ip address
1553 *
1554 * @param host the host whose hostname is to be resolved
1555 */
1556void
1557GNUNET_TESTBED_host_resolve_ (struct GNUNET_TESTBED_Host *host)
1558{
1559 char *hostname;
1560
1561 hostname = (char *) host->hostname;
1562 host->hostname = simple_resolve (hostname);
1563 if (NULL == host->hostname)
1564 {
1565 GNUNET_break (0);
1566 host->hostname = hostname;
1567 return;
1568 }
1569 GNUNET_free (hostname);
1570 host->hostname = GNUNET_strdup (host->hostname);
1571}
1572
1573
1574/* end of testbed_api_hosts.c */
generated by cgit v1.2.3 (git 2.39.1) at 2024-05-14 18:11:16 +0000