X-Git-Url: https://git.librecmc.org/?a=blobdiff_plain;f=src%2Ftestbed%2Ftestbed_api.h;h=17cd38df35c755e2ce3b0de0f4dc486870828880;hb=d17a17ea785f91c18b5694eab3372c4e4564d95e;hp=8bd8a037163b5e01445e5287a716f0a3721d284e;hpb=6e08b7d1f56715c71ea6f0372b9abaddced8253b;p=oweals%2Fgnunet.git diff --git a/src/testbed/testbed_api.h b/src/testbed/testbed_api.h index 8bd8a0371..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,131 +27,105 @@ #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 create operation - */ + /** + * Peer create operation + */ OP_PEER_CREATE, - /** - * Peer start operation - */ + /** + * Peer start operation + */ OP_PEER_START, - /** - * Peer stop operation - */ + /** + * Peer stop operation + */ OP_PEER_STOP, - /** - * Peer destroy operation - */ + /** + * Peer destroy operation + */ OP_PEER_DESTROY, - /** - * Get peer information operation - */ + /** + * Get peer information operation + */ OP_PEER_INFO, - /** - * Overlay connection operation - */ - OP_OVERLAY_CONNECT, - - /** - * Forwarded operation - */ - OP_FORWARDED, - - /** - * Link controllers operation - */ - OP_LINK_CONTROLLERS, - /** - * Get slave config operation + * Reconfigure a peer */ - OP_GET_SLAVE_CONFIG - -}; - + OP_PEER_RECONFIGURE, -/** - * Testbed operation structure - */ -struct GNUNET_TESTBED_Operation -{ /** - * next pointer for DLL + * Overlay connection operation */ - struct GNUNET_TESTBED_Operation *next; + OP_OVERLAY_CONNECT, /** - * prev pointer for DLL + * Forwarded operation */ - struct GNUNET_TESTBED_Operation *prev; + OP_FORWARDED, /** - * The controller on which this operation operates + * Link controllers operation */ - struct GNUNET_TESTBED_Controller *controller; + OP_LINK_CONTROLLERS, /** - * The ID for the operation; + * Get slave config operation */ - uint64_t operation_id; + OP_GET_SLAVE_CONFIG, /** - * The type of operation + * Stop and destroy all peers */ - enum OperationType type; + OP_SHUTDOWN_PEERS, /** - * Data specific to OperationType + * Start/stop service at a peer */ - void *data; + OP_MANAGE_SERVICE }; -/** - * The message queue for sending messages to the controller service - */ -struct MessageQueue; - -/** - * Structure for a controller link - */ -struct ControllerLink; - - /** * Enumeration of states of OperationContext */ enum OperationContextState { - /** - * The initial state where the associated operation has just been created - * and is waiting in the operation queues to be started - */ + /** + * The initial state where the associated operation has just been created + * and is waiting in the operation queues to be started + */ OPC_STATE_INIT = 0, - /** - * The operation has been started. It may occupy some resources which are to - * be freed if cancelled. - */ + /** + * The operation has been started. It may occupy some resources which are to + * be freed if cancelled. + */ OPC_STATE_STARTED, - /** - * The operation has finished. The end results of this operation may occupy - * some resources which are to be freed by operation_done - */ + /** + * The operation has finished. The end results of this operation may occupy + * some resources which are to be freed by operation_done + */ OPC_STATE_FINISHED }; @@ -161,16 +135,6 @@ enum OperationContextState */ struct OperationContext { - /** - * next ptr for DLL - */ - struct OperationContext *next; - - /** - * prev ptr for DLL - */ - struct OperationContext *prev; - /** * The controller to which this operation context belongs to */ @@ -181,6 +145,11 @@ struct OperationContext */ struct GNUNET_TESTBED_Operation *op; + /** + * The operation closure + */ + void *op_cls; + /** * Data relevant to the operation */ @@ -203,6 +172,15 @@ struct OperationContext }; +/** + * Operation empty callback + * + * @param cls closure + */ +typedef void +(*TESTBED_opcq_empty_cb) (void *cls); + + /** * Handle to interact with a GNUnet testbed controller. Each * controller has at least one master handle which is created when the @@ -214,7 +192,6 @@ struct OperationContext */ struct GNUNET_TESTBED_Controller { - /** * The host where the controller is running */ @@ -236,85 +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_MQ_Handle *mq; + + /** + * The host registration handle; NULL if no current registration requests are + * present */ - struct GNUNET_CLIENT_Connection *client; + struct GNUNET_TESTBED_HostRegistrationHandle *rh; /** - * The head of the message queue + * The map of active operation contexts */ - struct MessageQueue *mq_head; + struct GNUNET_CONTAINER_MultiHashMap32 *opc_map; /** - * The tail of the message queue + * If this callback is not NULL, schedule it as a task when opc_map gets empty */ - struct MessageQueue *mq_tail; + TESTBED_opcq_empty_cb opcq_empty_cb; /** - * The head of the ControllerLink list + * Closure for the above task */ - struct ControllerLink *cl_head; + void *opcq_empty_cls; /** - * The tail of the ControllerLink list + * Operation queue for simultaneous operations */ - struct ControllerLink *cl_tail; + struct OperationQueue *opq_parallel_operations; /** - * The client transmit handle + * Operation queue for simultaneous service connections */ - struct GNUNET_CLIENT_TransmitHandle *th; + struct OperationQueue *opq_parallel_service_connections; /** - * The host registration handle; NULL if no current registration requests are - * present + * Operation queue for simultaneous topology configuration operations */ - struct GNUNET_TESTBED_HostRegistrationHandle *rh; + struct OperationQueue *opq_parallel_topology_config_operations; /** - * The head of the opeartion context queue + * handle for hashtable of barrier handles, values are + * of type `struct GNUNET_TESTBED_Barrier`. */ - struct OperationContext *ocq_head; + struct GNUNET_CONTAINER_MultiHashMap *barrier_map; /** - * The tail of the operation context queue + * The controller event mask */ - struct OperationContext *ocq_tail; + uint64_t event_mask; /** - * Operation queue for simultaneous operations + * The operation id counter. use current value and increment */ - struct OperationQueue *opq_parallel_operations; + uint32_t operation_counter; +}; + +/** + * Handle for barrier + */ +struct GNUNET_TESTBED_Barrier +{ /** - * Operation queue for simultaneous service connections + * hashcode identifying this barrier in the hashmap */ - struct OperationQueue *opq_parallel_service_connections; + struct GNUNET_HashCode key; /** - * Operation queue for simultaneous topology configuration operations + * The controller handle given while initiliasing this barrier */ - struct OperationQueue *opq_parallel_topology_config_operations; + struct GNUNET_TESTBED_Controller *c; /** - * The operation id counter. use current value and increment + * The name of the barrier */ - uint64_t operation_counter; + char *name; /** - * The controller event mask + * The continuation callback to call when we have a status update on this */ - uint64_t event_mask; + 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; }; @@ -323,12 +313,38 @@ 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); +/** + * 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); + + /** * Compresses given configuration using zlib compress * @@ -339,31 +355,44 @@ GNUNET_TESTBED_queue_message_ (struct GNUNET_TESTBED_Controller *controller, * @return the size of the xconfig */ size_t -GNUNET_TESTBED_compress_config_ (const char *config, size_t size, +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); /** @@ -381,10 +410,11 @@ GNUNET_TESTBED_create_helper_init_msg_ (const char *cname, * operation */ struct OperationContext * -GNUNET_TESTBED_forward_operation_msg_ (struct GNUNET_TESTBED_Controller - *controller, uint64_t operation_id, +GNUNET_TESTBED_forward_operation_msg_ (struct + GNUNET_TESTBED_Controller *controller, + uint64_t operation_id, const struct GNUNET_MessageHeader *msg, - GNUNET_CLIENT_MessageHandler cc, + GNUNET_MQ_MessageCallback cc, void *cc_cls); /** @@ -398,14 +428,16 @@ GNUNET_TESTBED_forward_operation_msg_cancel_ (struct OperationContext *opc); /** - * Generates configuration by parsing Peer configuration information reply message + * 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 peer configuration information message + * @param msg the message containing compressed configuration * @return handle to the parsed configuration */ struct GNUNET_CONFIGURATION_Handle * -GNUNET_TESTBED_get_config_from_peerinfo_msg_ (const struct - GNUNET_MessageHeader *msg); +GNUNET_TESTBED_extract_config_ (const struct GNUNET_MessageHeader *msg); /** @@ -420,5 +452,70 @@ 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 */