X-Git-Url: https://git.librecmc.org/?a=blobdiff_plain;f=src%2Ftestbed%2Ftestbed_api.h;h=17cd38df35c755e2ce3b0de0f4dc486870828880;hb=d17a17ea785f91c18b5694eab3372c4e4564d95e;hp=994caae8b7b34f2fe65554f1945f323e6f550a13;hpb=e3c1b801f236ea6a513d42c0b104ef0ac30de635;p=oweals%2Fgnunet.git diff --git a/src/testbed/testbed_api.h b/src/testbed/testbed_api.h index 994caae8b..17cd38df3 100644 --- a/src/testbed/testbed_api.h +++ b/src/testbed/testbed_api.h @@ -1,21 +1,21 @@ /* This file is part of GNUnet - (C) 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 */ /** @@ -27,66 +27,158 @@ #ifndef TESTBED_API_H #define TESTBED_API_H +#include "gnunet_util_lib.h" +#include "gnunet_testbed_service.h" +#include "testbed.h" +#include "testbed_helper.h" + +/** + * Testbed Helper binary name + */ +#define HELPER_TESTBED_BINARY "gnunet-helper-testbed" + /** * Enumeration of operations */ enum OperationType - { - /** - * Peer start operation - */ - OP_PEER_START, +{ + /** + * Peer create operation + */ + OP_PEER_CREATE, + + /** + * Peer start operation + */ + OP_PEER_START, - /** - * Peer destroy operation - */ - OP_PEER_DESTROY - }; + /** + * Peer stop operation + */ + OP_PEER_STOP, + + /** + * Peer destroy operation + */ + OP_PEER_DESTROY, + + /** + * Get peer information operation + */ + OP_PEER_INFO, + + /** + * Reconfigure a peer + */ + OP_PEER_RECONFIGURE, + + /** + * Overlay connection operation + */ + OP_OVERLAY_CONNECT, + + /** + * Forwarded operation + */ + OP_FORWARDED, + + /** + * Link controllers operation + */ + OP_LINK_CONTROLLERS, + + /** + * Get slave config operation + */ + OP_GET_SLAVE_CONFIG, + + /** + * Stop and destroy all peers + */ + OP_SHUTDOWN_PEERS, + + /** + * Start/stop service at a peer + */ + OP_MANAGE_SERVICE +}; /** - * Testbed operation structure + * Enumeration of states of OperationContext */ -struct GNUNET_TESTBED_Operation +enum OperationContextState { /** - * next pointer for DLL + * The initial state where the associated operation has just been created + * and is waiting in the operation queues to be started */ - struct GNUNET_TESTBED_Operation *next; + OPC_STATE_INIT = 0, /** - * prev pointer for DLL + * The operation has been started. It may occupy some resources which are to + * be freed if cancelled. */ - struct GNUNET_TESTBED_Operation *prev; + OPC_STATE_STARTED, /** - * The ID for the operation; + * The operation has finished. The end results of this operation may occupy + * some resources which are to be freed by operation_done */ - uint64_t operation_id; + OPC_STATE_FINISHED +}; + +/** + * Context information for GNUNET_TESTBED_Operation + */ +struct OperationContext +{ /** - * The type of operation + * The controller to which this operation context belongs to */ - enum OperationType type; + struct GNUNET_TESTBED_Controller *c; /** - * Data specific to OperationType + * The operation + */ + struct GNUNET_TESTBED_Operation *op; + + /** + * The operation closure + */ + void *op_cls; + + /** + * Data relevant to the operation */ void *data; -}; + /** + * The id of the opearation + */ + uint64_t id; -/** - * The message queue for sending messages to the controller service - */ -struct MessageQueue; + /** + * The type of operation + */ + enum OperationType type; + + /** + * The state of the operation + */ + enum OperationContextState state; +}; /** - * Structure for a controller link + * Operation empty callback + * + * @param cls closure */ -struct ControllerLink; +typedef void +(*TESTBED_opcq_empty_cb) (void *cls); /** @@ -100,7 +192,6 @@ struct ControllerLink; */ struct GNUNET_TESTBED_Controller { - /** * The host where the controller is running */ @@ -122,70 +213,98 @@ struct GNUNET_TESTBED_Controller struct GNUNET_CONFIGURATION_Handle *cfg; /** - * The client connection handle to the controller service + * The message queue to the controller service */ - struct GNUNET_CLIENT_Connection *client; - + struct GNUNET_MQ_Handle *mq; + /** - * The head of the message queue + * The host registration handle; NULL if no current registration requests are + * present */ - struct MessageQueue *mq_head; + struct GNUNET_TESTBED_HostRegistrationHandle *rh; /** - * The tail of the message queue + * The map of active operation contexts */ - struct MessageQueue *mq_tail; + struct GNUNET_CONTAINER_MultiHashMap32 *opc_map; /** - * The head of the ControllerLink list + * If this callback is not NULL, schedule it as a task when opc_map gets empty */ - struct ControllerLink *cl_head; + TESTBED_opcq_empty_cb opcq_empty_cb; /** - * The tail of the ControllerLink list + * Closure for the above task */ - struct ControllerLink *cl_tail; + void *opcq_empty_cls; /** - * The client transmit handle + * Operation queue for simultaneous operations */ - struct GNUNET_CLIENT_TransmitHandle *th; + struct OperationQueue *opq_parallel_operations; /** - * The host registration handle; NULL if no current registration requests are - * present + * Operation queue for simultaneous service connections */ - struct GNUNET_TESTBED_HostRegistrationHandle *rh; + struct OperationQueue *opq_parallel_service_connections; /** - * The head of the operation queue + * Operation queue for simultaneous topology configuration operations */ - struct GNUNET_TESTBED_Operation *op_head; - + struct OperationQueue *opq_parallel_topology_config_operations; + /** - * The tail of the operation queue + * handle for hashtable of barrier handles, values are + * of type `struct GNUNET_TESTBED_Barrier`. */ - struct GNUNET_TESTBED_Operation *op_tail; + struct GNUNET_CONTAINER_MultiHashMap *barrier_map; + + /** + * The controller event mask + */ + uint64_t event_mask; /** * The operation id counter. use current value and increment */ - uint64_t operation_counter; - + uint32_t operation_counter; +}; + + +/** + * Handle for barrier + */ +struct GNUNET_TESTBED_Barrier +{ /** - * The controller event mask + * hashcode identifying this barrier in the hashmap */ - uint64_t event_mask; + struct GNUNET_HashCode key; + + /** + * The controller handle given while initiliasing this barrier + */ + struct GNUNET_TESTBED_Controller *c; + + /** + * The name of the barrier + */ + char *name; + + /** + * The continuation callback to call when we have a status update on this + */ + GNUNET_TESTBED_barrier_status_cb cb; /** - * Did we start the receive loop yet? + * the closure for the above callback */ - int in_receive; + void *cls; /** - * Did we create the host for this? + * Should the barrier crossed status message be echoed back to the controller? */ - int aux_host; + int echo; }; @@ -194,10 +313,36 @@ struct GNUNET_TESTBED_Controller * * @param controller the handle to the controller * @param msg the message to queue + * @deprecated */ void GNUNET_TESTBED_queue_message_ (struct GNUNET_TESTBED_Controller *controller, - struct GNUNET_MessageHeader *msg); + struct GNUNET_MessageHeader *msg); + + +/** + * Inserts the given operation context into the operation context map of the + * given controller. Creates the operation context map if one does not exist + * for the controller + * + * @param c the controller + * @param opc the operation context to be inserted + */ +void +GNUNET_TESTBED_insert_opc_ (struct GNUNET_TESTBED_Controller *c, + struct OperationContext *opc); + + +/** + * Removes the given operation context from the operation context map of the + * given controller + * + * @param c the controller + * @param opc the operation context to remove + */ +void +GNUNET_TESTBED_remove_opc_ (const struct GNUNET_TESTBED_Controller *c, + struct OperationContext *opc); /** @@ -206,33 +351,171 @@ GNUNET_TESTBED_queue_message_ (struct GNUNET_TESTBED_Controller *controller, * @param config the serialized configuration * @param size the size of config * @param xconfig will be set to the compressed configuration (memory is fresly - * allocated) + * allocated) * @return the size of the xconfig */ size_t -GNUNET_TESTBED_compress_config_ (const char *config, size_t size, - char **xconfig); +GNUNET_TESTBED_compress_config_ (const char *config, + size_t size, + char **xconfig); /** - * Adds an operation to the queue of operations + * Function to serialize and compress using zlib a configuration through a + * configuration handle * - * @param op the operation to add + * @param cfg the configuration + * @param size the size of configuration when serialize. Will be set on success. + * @param xsize the sizeo of the compressed configuration. Will be set on success. + * @return the serialized and compressed configuration */ -void -GNUNET_TESTBED_operation_add_ (struct GNUNET_TESTBED_Operation *op); +char * +GNUNET_TESTBED_compress_cfg_ (const struct GNUNET_CONFIGURATION_Handle *cfg, + size_t *size, + size_t *xsize); /** - * Creates a helper initialization message. Only for testing. + * Creates a helper initialization message. This function is here because we + * want to use this in testing * - * @param cname the ip address of the controlling host + * @param trusted_ip the ip address of the controller which will be set as TRUSTED + * HOST(all connections form this ip are permitted by the testbed) when + * starting testbed controller at host. This can either be a single ip + * address or a network address in CIDR notation. + * @param hostname the hostname of the destination this message is intended for * @param cfg the configuration that has to used to start the testbed service * thru helper * @return the initialization message */ struct GNUNET_TESTBED_HelperInit * GNUNET_TESTBED_create_helper_init_msg_ (const char *cname, - const struct GNUNET_CONFIGURATION_Handle *cfg); + const char *hostname, + const struct + GNUNET_CONFIGURATION_Handle *cfg); + + +/** + * Sends the given message as an operation. The given callback is called when a + * reply for the operation is available. Call + * GNUNET_TESTBED_forward_operation_msg_cancel_() to cleanup the returned + * operation context if the cc hasn't been called + * + * @param controller the controller to which the message has to be sent + * @param operation_id the operation id of the message + * @param msg the message to send + * @param cc the callback to call when reply is available + * @param cc_cls the closure for the above callback + * @return the operation context which can be used to cancel the forwarded + * operation + */ +struct OperationContext * +GNUNET_TESTBED_forward_operation_msg_ (struct + GNUNET_TESTBED_Controller *controller, + uint64_t operation_id, + const struct GNUNET_MessageHeader *msg, + GNUNET_MQ_MessageCallback cc, + void *cc_cls); + +/** + * Function to cancel an operation created by simply forwarding an operation + * message. + * + * @param opc the operation context from GNUNET_TESTBED_forward_operation_msg_() + */ +void +GNUNET_TESTBED_forward_operation_msg_cancel_ (struct OperationContext *opc); + + +/** + * Generates configuration by uncompressing configuration in given message. The + * given message should be of the following types: + * #GNUNET_MESSAGE_TYPE_TESTBED_PEERCONFIG, + * #GNUNET_MESSAGE_TYPE_TESTBED_SLAVECONFIG + * + * @param msg the message containing compressed configuration + * @return handle to the parsed configuration + */ +struct GNUNET_CONFIGURATION_Handle * +GNUNET_TESTBED_extract_config_ (const struct GNUNET_MessageHeader *msg); + + +/** + * Checks the integrity of the OpeationFailureEventMessage and if good returns + * the error message it contains. + * + * @param msg the OperationFailureEventMessage + * @return the error message + */ +const char * +GNUNET_TESTBED_parse_error_string_ (const struct + GNUNET_TESTBED_OperationFailureEventMessage + *msg); + + +/** + * Function to return the operation id for a controller. The operation id is + * created from the controllers host id and its internal operation counter. + * + * @param controller the handle to the controller whose operation id has to be incremented + * @return the incremented operation id. + */ +uint64_t +GNUNET_TESTBED_get_next_op_id (struct GNUNET_TESTBED_Controller *controller); + + +/** + * Like GNUNET_TESTBED_get_slave_config(), however without the host registration + * check. Another difference is that this function takes the id of the slave + * host. + * + * @param op_cls the closure for the operation + * @param master the handle to master controller + * @param slave_host_id id of the host where the slave controller is running to + * the slave_host should remain valid until this operation is cancelled + * or marked as finished + * @return the operation handle; + */ +struct GNUNET_TESTBED_Operation * +GNUNET_TESTBED_get_slave_config_ (void *op_cls, + struct GNUNET_TESTBED_Controller *master, + uint32_t slave_host_id); + + +/** + * Initialise a barrier and call the given callback when the required percentage + * of peers (quorum) reach the barrier OR upon error. + * + * @param controller the handle to the controller + * @param name identification name of the barrier + * @param quorum the percentage of peers that is required to reach the barrier. + * Peers signal reaching a barrier by calling + * GNUNET_TESTBED_barrier_reached(). + * @param cb the callback to call when the barrier is reached or upon error. + * Cannot be NULL. + * @param cls closure for the above callback + * @param echo #GNUNET_YES to echo the barrier crossed status message back to the + * controller + * @return barrier handle; NULL upon error + */ +struct GNUNET_TESTBED_Barrier * +GNUNET_TESTBED_barrier_init_ (struct GNUNET_TESTBED_Controller *controller, + const char *name, + unsigned int quorum, + GNUNET_TESTBED_barrier_status_cb cb, + void *cls, + int echo); + + +/** + * Remove a barrier and it was the last one in the barrier hash map, destroy the + * hash map + * + * @param barrier the barrier to remove + */ +void +GNUNET_TESTBED_barrier_remove_ (struct GNUNET_TESTBED_Barrier *barrier); + #endif +/* end of testbed_api.h */