X-Git-Url: https://git.librecmc.org/?a=blobdiff_plain;f=src%2Ftestbed%2Ftestbed_api_hosts.h;h=9b19eb8ec8e50b633e374bd75675921b34d2ee85;hb=d17a17ea785f91c18b5694eab3372c4e4564d95e;hp=1eab193635bdd383f2b35176d149073361f41dbb;hpb=640ff05da5015bdf48bed436eb617d42528a664c;p=oweals%2Fgnunet.git diff --git a/src/testbed/testbed_api_hosts.h b/src/testbed/testbed_api_hosts.h index 1eab19363..9b19eb8ec 100644 --- a/src/testbed/testbed_api_hosts.h +++ b/src/testbed/testbed_api_hosts.h @@ -1,21 +1,21 @@ /* This file is part of GNUnet - (C) 2008--2012 Christian Grothoff (and other contributing authors) + Copyright (C) 2008--2013 GNUnet e.V. - GNUnet is free software; you can redistribute it and/or modify - it under the terms of the GNU General Public License as published - by the Free Software Foundation; either version 3, or (at your - option) any later version. + GNUnet is free software: you can redistribute it and/or modify it + under the terms of the GNU Affero General Public License as published + by the Free Software Foundation, either version 3 of the License, + or (at your option) any later version. GNUnet is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - General Public License for more details. + Affero General Public License for more details. - You should have received a copy of the GNU General Public License - along with GNUnet; see the file COPYING. If not, write to the - Free Software Foundation, Inc., 59 Temple Place - Suite 330, - Boston, MA 02111-1307, USA. + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + + SPDX-License-Identifier: AGPL3.0-or-later */ /** @@ -23,16 +23,45 @@ * @brief internal API to access the 'hosts' subsystem * @author Christian Grothoff */ -#ifndef NEW_TESTING_API_HOSTS_H -#define NEW_TESTING_API_HOSTS_H -#include "gnunet_testbed_service.h" -#include "gnunet_helper_lib.h" +#ifndef TESTBED_API_HOSTS_H +#define TESTBED_API_HOSTS_H + +// #include "gnunet_testbed_service.h" +// #include "testbed_helper.h" +#include "testbed.h" + + +/** + * handle for host registration + */ +struct GNUNET_TESTBED_HostRegistrationHandle +{ + /** + * The host being registered + */ + struct GNUNET_TESTBED_Host *host; + + /** + * The controller at which this host is being registered + */ + struct GNUNET_TESTBED_Controller *c; + + /** + * The Registartion completion callback + */ + GNUNET_TESTBED_HostRegistrationCompletion cc; + + /** + * The closure for above callback + */ + void *cc_cls; +}; /** * 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 @@ -45,18 +74,23 @@ GNUNET_TESTBED_host_lookup_by_id_ (uint32_t 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' + * @param cfg the configuration to use as a template while starting a controller + * on this host. Operation queue sizes specific to a host are also + * read from this configuration handle * @return handle to the host, NULL on error */ struct GNUNET_TESTBED_Host * -GNUNET_TESTBED_host_create_by_id_ (uint32_t id); +GNUNET_TESTBED_host_create_by_id_ (uint32_t id, + const struct GNUNET_CONFIGURATION_Handle + *cfg); /** * Obtain a 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) @@ -65,19 +99,9 @@ uint32_t GNUNET_TESTBED_host_get_id_ (const struct GNUNET_TESTBED_Host *host); -/** - * 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); - - /** * Obtain the host's username - * + * * @param host handle to the host, NULL means 'localhost' * @return username to login to the host */ @@ -87,7 +111,7 @@ GNUNET_TESTBED_host_get_username_ (const struct GNUNET_TESTBED_Host *host); /** * Obtain the host's ssh port - * + * * @param host handle to the host, NULL means 'localhost' * @return username to login to the host */ @@ -96,33 +120,25 @@ GNUNET_TESTBED_host_get_ssh_port_ (const struct GNUNET_TESTBED_Host *host); /** - * Opaque wrapper around GNUNET_HELPER_Handle - */ -struct GNUNET_TESTBED_HelperHandle; - - -/** - * 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 - * @return handle to terminate the command, NULL on error + * Obtain the host's configuration template + * + * @param host handle to the host + * @return the host's configuration template */ -struct GNUNET_TESTBED_HelperHandle * -GNUNET_TESTBED_host_run_ (const struct GNUNET_TESTBED_Host *host, - char *const binary_argv[]); +const struct GNUNET_CONFIGURATION_Handle * +GNUNET_TESTBED_host_get_cfg_ (const struct GNUNET_TESTBED_Host *host); /** - * Stops a helper in the HelperHandle using GNUNET_HELPER_stop + * Function to replace host's configuration * - * @param handle the handle returned from GNUNET_TESTBED_host_start_ + * @param host the host handle + * @param new_cfg the new configuration to replace the old one */ void -GNUNET_TESTBED_host_stop_ (struct GNUNET_TESTBED_HelperHandle *handle); +GNUNET_TESTBED_host_replace_cfg_ (struct GNUNET_TESTBED_Host *host, + const struct + GNUNET_CONFIGURATION_Handle *new_cfg); /** @@ -133,8 +149,20 @@ GNUNET_TESTBED_host_stop_ (struct GNUNET_TESTBED_HelperHandle *handle); */ void GNUNET_TESTBED_mark_host_registered_at_ (struct GNUNET_TESTBED_Host *host, - const struct GNUNET_TESTBED_Controller - *controller); + const struct GNUNET_TESTBED_Controller + *controller); + + +/** + * Unmarks a host registered at a controller + * + * @param host the host to unmark + * @param controller the controller at which this host has to be unmarked + */ +void +GNUNET_TESTBED_deregister_host_at_ (struct GNUNET_TESTBED_Host *host, + const struct GNUNET_TESTBED_Controller + *const controller); /** @@ -146,8 +174,50 @@ GNUNET_TESTBED_mark_host_registered_at_ (struct GNUNET_TESTBED_Host *host, */ int GNUNET_TESTBED_is_host_registered_ (const struct GNUNET_TESTBED_Host *host, - const struct GNUNET_TESTBED_Controller - *controller); + const struct GNUNET_TESTBED_Controller + *controller); + + +/** + * Queues the given operation in the queue for parallel overlay connects of the + * given host + * + * @param h the host handle + * @param op the operation to queue in the given host's parally overlay connect + * queue + */ +void +GNUNET_TESTBED_host_queue_oc_ (struct GNUNET_TESTBED_Host *h, + struct GNUNET_TESTBED_Operation *op); + + +/** + * Sends termination signal to the controller's helper process + * + * @param cproc the handle to the controller's helper process + */ +void +GNUNET_TESTBED_controller_kill_ (struct GNUNET_TESTBED_ControllerProc *cproc); + + +/** + * Cleans-up the controller's helper process handle + * + * @param cproc the handle to the controller's helper process + */ +void +GNUNET_TESTBED_controller_destroy_ (struct GNUNET_TESTBED_ControllerProc + *cproc); + + +/** + * Resolves the hostname of the host to an ip address + * + * @param host the host whose hostname is to be resolved + */ +void +GNUNET_TESTBED_host_resolve_ (struct GNUNET_TESTBED_Host *host); + #endif /* end of testbed_api_hosts.h */