*/
/**
- * @file testing/new_testing_api_hosts.c
+ * @file testbed/testbed_api_hosts.c
* @brief API for manipulating 'hosts' controlled by the GNUnet testing service;
* allows parsing hosts files, starting, stopping and communicating (via
* SSH/stdin/stdout) with the remote (or local) processes
* @author Christian Grothoff
*/
#include "platform.h"
-#include "gnunet_testing_service.h"
+#include "gnunet_util_lib.h"
+#include "gnunet_testbed_service.h"
#include "gnunet_core_service.h"
-#include "gnunet_constants.h"
#include "gnunet_transport_service.h"
-#include "gnunet_hello_lib.h"
+#include "testbed_api.h"
+#include "testbed_api_hosts.h"
+
+/**
+ * Generic logging shorthand
+ */
+#define LOG(kind, ...) \
+ GNUNET_log_from (kind, "testbed-api-hosts", __VA_ARGS__);
+
+/**
+ * Number of extra elements we create space for when we grow host list
+ */
+#define HOST_LIST_GROW_STEP 10
+
+
+/**
+ * A list entry for registered controllers list
+ */
+struct RegisteredController
+{
+ /**
+ * The controller at which this host is registered
+ */
+ const struct GNUNET_TESTBED_Controller *controller;
+
+ /**
+ * The next ptr for DLL
+ */
+ struct RegisteredController *next;
+
+ /**
+ * The prev ptr for DLL
+ */
+ struct RegisteredController *prev;
+};
/**
struct GNUNET_TESTBED_Host
{
+ /**
+ * The next pointer for DLL
+ */
+ struct GNUNET_TESTBED_Host *next;
+
+ /**
+ * The prev pointer for DLL
+ */
+ struct GNUNET_TESTBED_Host *prev;
+ /**
+ * The hostname of the host; NULL for localhost
+ */
const char *hostname;
+ /**
+ * The username to be used for SSH login
+ */
const char *username;
+ /**
+ * The head for the list of controllers where this host is registered
+ */
+ struct RegisteredController *rc_head;
+
+ /**
+ * The tail for the list of controllers where this host is registered
+ */
+ struct RegisteredController *rc_tail;
+
/**
* Global ID we use to refer to a host on the network
*/
- uint32_t unique_id;
+ uint32_t id;
+ /**
+ * The port which is to be used for SSH
+ */
uint16_t port;
+
};
+/**
+ * Array of available hosts
+ */
+static struct GNUNET_TESTBED_Host **host_list;
+
+/**
+ * The size of the available hosts list
+ */
+static uint32_t host_list_size;
+
+
/**
* Lookup a host by ID.
- *
+ *
* @param id global host ID assigned to the host; 0 is
* reserved to always mean 'localhost'
- * @return handle to the host, NULL on error
+ * @return handle to the host, NULL if host not found
*/
struct GNUNET_TESTBED_Host *
GNUNET_TESTBED_host_lookup_by_id_ (uint32_t id)
{
- GNUNET_break (0);
- return NULL;
+ if (host_list_size <= id)
+ return NULL;
+ return host_list[id];
}
* Create a host by ID; given this host handle, we could not
* run peers at the host, but we can talk about the host
* internally.
- *
+ *
* @param id global host ID assigned to the host; 0 is
* reserved to always mean 'localhost'
* @return handle to the host, NULL on error
struct GNUNET_TESTBED_Host *
GNUNET_TESTBED_host_create_by_id_ (uint32_t id)
{
- return NULL;
+ return GNUNET_TESTBED_host_create_with_id (id, NULL, NULL, 0);
}
/**
- * Obtain a host's unique global ID.
- *
+ * Obtain the host's unique global ID.
+ *
* @param host handle to the host, NULL means 'localhost'
* @return id global host ID assigned to the host (0 is
* 'localhost', but then obviously not globally unique)
*/
uint32_t
-GNUNET_TESTBED_host_get_id_ (struct GNUNET_TESTBED_Host *host)
+GNUNET_TESTBED_host_get_id_ (const struct GNUNET_TESTBED_Host * host)
+{
+ return host->id;
+}
+
+
+/**
+ * Obtain the host's hostname.
+ *
+ * @param host handle to the host, NULL means 'localhost'
+ * @return hostname of the host
+ */
+const char *
+GNUNET_TESTBED_host_get_hostname_ (const struct GNUNET_TESTBED_Host *host)
+{
+ return host->hostname;
+}
+
+
+/**
+ * Obtain the host's hostname.
+ *
+ * @param host handle to the host, NULL means 'localhost'
+ * @return hostname of the host
+ */
+const char *
+GNUNET_TESTBED_host_get_hostname (const struct GNUNET_TESTBED_Host *host)
{
- GNUNET_break (0);
- return 0;
+ return GNUNET_TESTBED_host_get_hostname_ (host);
+}
+
+
+/**
+ * Obtain the host's username
+ *
+ * @param host handle to the host, NULL means 'localhost'
+ * @return username to login to the host
+ */
+const char *
+GNUNET_TESTBED_host_get_username_ (const struct GNUNET_TESTBED_Host *host)
+{
+ return host->username;
+}
+
+
+/**
+ * Obtain the host's ssh port
+ *
+ * @param host handle to the host, NULL means 'localhost'
+ * @return username to login to the host
+ */
+uint16_t
+GNUNET_TESTBED_host_get_ssh_port_ (const struct GNUNET_TESTBED_Host * host)
+{
+ return host->port;
}
/**
* Create a host to run peers and controllers on.
- *
+ *
* @param id global host ID assigned to the host; 0 is
* reserved to always mean 'localhost'
* @param hostname name of the host, use "NULL" for localhost
* @return handle to the host, NULL on error
*/
struct GNUNET_TESTBED_Host *
-GNUNET_TESTBED_host_create_with_id_ (uint32_t id,
- const char *hostname,
- const char *username,
- uint16_t port)
+GNUNET_TESTBED_host_create_with_id (uint32_t id, const char *hostname,
+ const char *username, uint16_t port)
{
- GNUNET_break (0);
- return NULL;
+ struct GNUNET_TESTBED_Host *host;
+ uint32_t new_size;
+
+ if ((id < host_list_size) && (NULL != host_list[id]))
+ {
+ LOG (GNUNET_ERROR_TYPE_WARNING, "Host with id: %u already created\n", id);
+ return NULL;
+ }
+ host = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_Host));
+ host->hostname = (NULL != hostname) ? GNUNET_strdup (hostname) : NULL;
+ host->username = (NULL != username) ? GNUNET_strdup (username) : NULL;
+ host->id = id;
+ host->port = (0 == port) ? 22 : port;
+ new_size = host_list_size;
+ while (id >= new_size)
+ new_size += HOST_LIST_GROW_STEP;
+ if (new_size != host_list_size)
+ {
+ host_list =
+ GNUNET_realloc (host_list,
+ sizeof (struct GNUNET_TESTBED_Host *) * new_size);
+ (void) memset (&host_list[host_list_size], 0,
+ sizeof (struct GNUNET_TESTBED_Host *) * (new_size -
+ host_list_size));
+ host_list_size = new_size;
+ }
+ LOG (GNUNET_ERROR_TYPE_DEBUG, "Adding host with id: %u\n", host->id);
+ host_list[id] = host;
+ return host;
}
/**
* Create a host to run peers and controllers on.
- *
+ *
* @param hostname name of the host, use "NULL" for localhost
* @param username username to use for the login; may be NULL
* @param port port number to use for ssh; use 0 to let ssh decide
* @return handle to the host, NULL on error
*/
struct GNUNET_TESTBED_Host *
-GNUNET_TESTBED_host_create (const char *hostname,
- const char *username,
- uint16_t port)
+GNUNET_TESTBED_host_create (const char *hostname, const char *username,
+ uint16_t port)
{
static uint32_t uid_generator;
- return GNUNET_TESTBED_host_create_with_id_ (++uid_generator,
- hostname, username,
- port);
+ if (NULL == hostname)
+ return GNUNET_TESTBED_host_create_with_id (0, hostname, username, port);
+ return GNUNET_TESTBED_host_create_with_id (++uid_generator, hostname,
+ username, port);
}
* Load a set of hosts from a configuration file.
*
* @param filename file with the host specification
- * @param hosts set to the hosts found in the file
+ * @param hosts set to the hosts found in the file; caller must free this if
+ * number of hosts returned is greater than 0
* @return number of hosts returned in 'hosts', 0 on error
*/
unsigned int
GNUNET_TESTBED_hosts_load_from_file (const char *filename,
- struct GNUNET_TESTBED_Host **hosts)
+ struct GNUNET_TESTBED_Host ***hosts)
{
- GNUNET_break (0);
- return 0;
+ //struct GNUNET_TESTBED_Host **host_array;
+ struct GNUNET_TESTBED_Host *starting_host;
+ char *data;
+ char *buf;
+ char username[256];
+ char hostname[256];
+ uint64_t fs;
+ short int port;
+ int ret;
+ unsigned int offset;
+ unsigned int count;
+
+
+ GNUNET_assert (NULL != filename);
+ if (GNUNET_YES != GNUNET_DISK_file_test (filename))
+ {
+ LOG (GNUNET_ERROR_TYPE_WARNING, _("Hosts file %s not found\n"), filename);
+ return 0;
+ }
+ if (GNUNET_OK !=
+ GNUNET_DISK_file_size (filename, &fs, GNUNET_YES, GNUNET_YES))
+ fs = 0;
+ if (0 == fs)
+ {
+ LOG (GNUNET_ERROR_TYPE_WARNING, _("Hosts file %s has no data\n"), filename);
+ return 0;
+ }
+ data = GNUNET_malloc (fs);
+ if (fs != GNUNET_DISK_fn_read (filename, data, fs))
+ {
+ GNUNET_free (data);
+ LOG (GNUNET_ERROR_TYPE_WARNING, _("Hosts file %s cannot be read\n"),
+ filename);
+ return 0;
+ }
+ buf = data;
+ offset = 0;
+ starting_host = NULL;
+ count = 0;
+ while (offset < (fs - 1))
+ {
+ offset++;
+ if (((data[offset] == '\n')) && (buf != &data[offset]))
+ {
+ data[offset] = '\0';
+ ret = SSCANF (buf, "%255[a-zA-Z0-9_]@%255[a-zA-Z0-9.]:%5hd",
+ username, hostname, &port);
+ if (3 == ret)
+ {
+ GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
+ "Successfully read host %s, port %d and user %s from file\n",
+ hostname, port, username);
+ /* We store hosts in a static list; hence we only require the starting
+ host pointer in that list to access the newly created list of hosts */
+ if (NULL == starting_host)
+ starting_host = GNUNET_TESTBED_host_create (hostname, username,
+ port);
+ else
+ (void) GNUNET_TESTBED_host_create (hostname, username, port);
+ count++;
+ }
+ else
+ GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
+ "Error reading line `%s' in hostfile\n", buf);
+ buf = &data[offset + 1];
+ }
+ else if ((data[offset] == '\n') || (data[offset] == '\0'))
+ buf = &data[offset + 1];
+ }
+ GNUNET_free (data);
+ if (NULL == starting_host)
+ return 0;
+ *hosts = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_Host *) * count);
+ memcpy (*hosts,
+ &host_list[GNUNET_TESTBED_host_get_id_ (starting_host)],
+ sizeof (struct GNUNET_TESTBED_Host *) * count);
+ return count;
}
void
GNUNET_TESTBED_host_destroy (struct GNUNET_TESTBED_Host *host)
{
- GNUNET_break (0);
+ struct RegisteredController *rc;
+ uint32_t id;
+
+ GNUNET_assert (host->id < host_list_size);
+ GNUNET_assert (host_list[host->id] == host);
+ host_list[host->id] = NULL;
+ /* clear registered controllers list */
+ for (rc = host->rc_head; NULL != rc; rc = host->rc_head)
+ {
+ GNUNET_CONTAINER_DLL_remove (host->rc_head, host->rc_tail, rc);
+ GNUNET_free (rc);
+ }
+ GNUNET_free_non_null ((char *) host->username);
+ GNUNET_free_non_null ((char *) host->hostname);
+ GNUNET_free (host);
+ while (host_list_size >= HOST_LIST_GROW_STEP)
+ {
+ for (id = host_list_size - 1; id > host_list_size - HOST_LIST_GROW_STEP;
+ id--)
+ if (NULL != host_list[id])
+ break;
+ if (id != host_list_size - HOST_LIST_GROW_STEP)
+ break;
+ if (NULL != host_list[id])
+ break;
+ host_list_size -= HOST_LIST_GROW_STEP;
+ }
+ host_list =
+ GNUNET_realloc (host_list,
+ sizeof (struct GNUNET_TESTBED_Host *) * host_list_size);
+}
+
+
+/**
+ * Marks a host as registered with a controller
+ *
+ * @param host the host to mark
+ * @param controller the controller at which this host is registered
+ */
+void
+GNUNET_TESTBED_mark_host_registered_at_ (struct GNUNET_TESTBED_Host *host,
+ const struct GNUNET_TESTBED_Controller
+ *const controller)
+{
+ struct RegisteredController *rc;
+
+ for (rc = host->rc_head; NULL != rc; rc = rc->next)
+ {
+ if (controller == rc->controller) /* already registered at controller */
+ {
+ GNUNET_break (0);
+ return;
+ }
+ }
+ rc = GNUNET_malloc (sizeof (struct RegisteredController));
+ rc->controller = controller;
+ GNUNET_CONTAINER_DLL_insert_tail (host->rc_head, host->rc_tail, rc);
}
/**
- * Run a given helper process at the given host. Communication
- * with the helper will be via GNUnet messages on stdin/stdout.
- * Runs the process via 'ssh' at the specified host, or locally.
- * Essentially an SSH-wrapper around the 'gnunet_helper_lib.h' API.
- *
- * @param host host to use, use "NULL" for localhost
- * @param binary_argv binary name and command-line arguments to give to the binary
- * @param cb function to call for messages received from the binary
- * @param cb_cls closure for cb
- * @return handle to terminate the command, NULL on error
+ * Checks whether a host has been registered
+ *
+ * @param host the host to check
+ * @param controller the controller at which host's registration is checked
+ * @return GNUNET_YES if registered; GNUNET_NO if not
*/
-struct GNUNET_HELPER_Handle *
-GNUNET_TESTBED_host_run_ (struct GNUNET_TESTBED_Host *host,
- char *const binary_argv[],
- GNUNET_SERVER_MessageTokenizerCallback cb, void *cb_cls)
+int
+GNUNET_TESTBED_is_host_registered_ (const struct GNUNET_TESTBED_Host *host,
+ const struct GNUNET_TESTBED_Controller
+ *const controller)
{
- /* FIXME: decide on the SSH command line, prepend it and
- run GNUNET_HELPER_start with the modified binary_name and binary_argv! */
- GNUNET_break (0);
- return NULL;
+ struct RegisteredController *rc;
+
+ for (rc = host->rc_head; NULL != rc; rc = rc->next)
+ {
+ if (controller == rc->controller) /* already registered at controller */
+ {
+ return GNUNET_YES;
+ }
+ }
+ return GNUNET_NO;
}
-/* end of new_testing_api_hosts.c */
+/**
+ * Checks whether a host can be used to start testbed service
+ *
+ * @param host the host to check
+ * @param config the configuration handle to lookup the path of the testbed helper
+ * @return GNUNET_YES if testbed service can be started on the given host
+ * remotely; GNUNET_NO if not
+ */
+int
+GNUNET_TESTBED_is_host_habitable (const struct GNUNET_TESTBED_Host *host,
+ const struct GNUNET_CONFIGURATION_Handle *config)
+{
+ char *remote_args[11];
+ char *helper_binary_path;
+ char *portstr;
+ char *ssh_addr;
+ const char *hostname;
+ struct GNUNET_OS_Process *auxp;
+ unsigned long code;
+ enum GNUNET_OS_ProcessStatusType type;
+ int ret;
+ unsigned int argp;
+
+ portstr = NULL;
+ ssh_addr = NULL;
+ hostname = (NULL == host->hostname) ? "127.0.0.1" : host->hostname;
+ if (NULL == host->username)
+ ssh_addr = GNUNET_strdup (hostname);
+ else
+ GNUNET_asprintf (&ssh_addr, "%s@%s", host->username, hostname);
+ if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_string (config, "testbed",
+ "HELPER_BINARY_PATH",
+ &helper_binary_path))
+ helper_binary_path = GNUNET_OS_get_libexec_binary_path (HELPER_TESTBED_BINARY);
+ argp = 0;
+ remote_args[argp++] = "ssh";
+ GNUNET_asprintf (&portstr, "%u", host->port);
+ remote_args[argp++] = "-p";
+ remote_args[argp++] = portstr;
+ remote_args[argp++] = "-o";
+ remote_args[argp++] = "BatchMode=yes";
+ remote_args[argp++] = "-o";
+ remote_args[argp++] = "NoHostAuthenticationForLocalhost=yes";
+ remote_args[argp++] = ssh_addr;
+ remote_args[argp++] = "stat";
+ remote_args[argp++] = helper_binary_path;
+ remote_args[argp++] = NULL;
+ GNUNET_assert (argp == 11);
+ auxp =
+ GNUNET_OS_start_process_vap (GNUNET_NO, GNUNET_OS_INHERIT_STD_ERR, NULL,
+ NULL, "ssh", remote_args);
+ if (NULL == auxp)
+ {
+ GNUNET_free (ssh_addr);
+ GNUNET_free (portstr);
+ return GNUNET_NO;
+ }
+ do
+ {
+ ret = GNUNET_OS_process_status (auxp, &type, &code);
+ GNUNET_assert (GNUNET_SYSERR != ret);
+ (void) usleep (300);
+ }
+ while (GNUNET_NO == ret);
+ GNUNET_OS_process_destroy (auxp);
+ GNUNET_free (ssh_addr);
+ GNUNET_free (portstr);
+ GNUNET_free (helper_binary_path);
+ return (0 != code) ? GNUNET_NO : GNUNET_YES;
+}
+
+/* end of testbed_api_hosts.c */