X-Git-Url: https://git.librecmc.org/?a=blobdiff_plain;f=src%2Ftestbed%2Ftestbed_api.h;h=17cd38df35c755e2ce3b0de0f4dc486870828880;hb=d17a17ea785f91c18b5694eab3372c4e4564d95e;hp=f658c08dd7fd2bac35ba6a570faafec10faffa0c;hpb=5e1efe185cf484018f53dd33d64e546ac042fdee;p=oweals%2Fgnunet.git diff --git a/src/testbed/testbed_api.h b/src/testbed/testbed_api.h index f658c08dd..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) 2008--2013 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,6 +27,7 @@ #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" @@ -42,29 +43,29 @@ */ 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, /** @@ -72,19 +73,19 @@ enum OperationType */ OP_PEER_RECONFIGURE, - /** - * Overlay connection operation - */ + /** + * Overlay connection operation + */ OP_OVERLAY_CONNECT, - /** - * Forwarded operation - */ + /** + * Forwarded operation + */ OP_FORWARDED, - /** - * Link controllers operation - */ + /** + * Link controllers operation + */ OP_LINK_CONTROLLERS, /** @@ -93,7 +94,7 @@ enum OperationType OP_GET_SLAVE_CONFIG, /** - * Stop and destroy all peers + * Stop and destroy all peers */ OP_SHUTDOWN_PEERS, @@ -104,33 +105,27 @@ enum OperationType }; -/** - * The message queue for sending messages to the controller service - */ -struct MessageQueue; - - /** * 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 }; @@ -177,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 @@ -209,35 +213,30 @@ 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 client transmit handle + * If this callback is not NULL, schedule it as a task when opc_map gets empty */ - struct GNUNET_CLIENT_TransmitHandle *th; + TESTBED_opcq_empty_cb opcq_empty_cb; /** - * The host registration handle; NULL if no current registration requests are - * present + * Closure for the above task */ - struct GNUNET_TESTBED_HostRegistrationHandle *rh; - - /** - * The map of active operation contexts - */ - struct GNUNET_CONTAINER_MultiHashMap32 *opc_map; + void *opcq_empty_cls; /** * Operation queue for simultaneous operations @@ -255,20 +254,57 @@ struct GNUNET_TESTBED_Controller struct OperationQueue *opq_parallel_topology_config_operations; /** - * The controller event mask + * handle for hashtable of barrier handles, values are + * of type `struct GNUNET_TESTBED_Barrier`. */ - uint64_t event_mask; + struct GNUNET_CONTAINER_MultiHashMap *barrier_map; /** - * Did we start the receive loop yet? + * The controller event mask */ - int in_receive; + uint64_t event_mask; /** * The operation id counter. use current value and increment */ uint32_t operation_counter; +}; + +/** + * Handle for barrier + */ +struct GNUNET_TESTBED_Barrier +{ + /** + * hashcode identifying this barrier in the hashmap + */ + 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; + + /** + * the closure for the above callback + */ + void *cls; + + /** + * Should the barrier crossed status message be echoed back to the controller? + */ + int echo; }; @@ -277,6 +313,7 @@ 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, @@ -301,7 +338,7 @@ GNUNET_TESTBED_insert_opc_ (struct GNUNET_TESTBED_Controller *c, * given controller * * @param c the controller - * @param opc the operation context to remove + * @param opc the operation context to remove */ void GNUNET_TESTBED_remove_opc_ (const struct GNUNET_TESTBED_Controller *c, @@ -318,7 +355,8 @@ GNUNET_TESTBED_remove_opc_ (const struct GNUNET_TESTBED_Controller *c, * @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); @@ -333,7 +371,8 @@ GNUNET_TESTBED_compress_config_ (const char *config, size_t size, */ char * GNUNET_TESTBED_compress_cfg_ (const struct GNUNET_CONFIGURATION_Handle *cfg, - size_t *size, size_t *xsize); + size_t *size, + size_t *xsize); /** @@ -350,9 +389,10 @@ GNUNET_TESTBED_compress_cfg_ (const struct GNUNET_CONFIGURATION_Handle *cfg, * @return the initialization message */ struct GNUNET_TESTBED_HelperInit * -GNUNET_TESTBED_create_helper_init_msg_ (const char *cname, const char *hostname, - const struct GNUNET_CONFIGURATION_Handle - *cfg); +GNUNET_TESTBED_create_helper_init_msg_ (const char *cname, + const char *hostname, + const struct + GNUNET_CONFIGURATION_Handle *cfg); /** @@ -370,10 +410,11 @@ GNUNET_TESTBED_create_helper_init_msg_ (const char *cname, const char *hostname, * 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); /** @@ -389,8 +430,8 @@ 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 + * #GNUNET_MESSAGE_TYPE_TESTBED_PEERCONFIG, + * #GNUNET_MESSAGE_TYPE_TESTBED_SLAVECONFIG * * @param msg the message containing compressed configuration * @return handle to the parsed configuration @@ -442,76 +483,38 @@ GNUNET_TESTBED_get_slave_config_ (void *op_cls, /** - * Same as the GNUNET_TESTBED_controller_link_2, but with ids for delegated host - * and slave host - * - * @param op_cls the operation closure for the event which is generated to - * signal success or failure of this operation - * @param master handle to the master controller who creates the association - * @param delegated_host_id id of the host to which requests should be delegated - * @param slave_host_id id of the host which is used to run the slave controller - * @param sxcfg serialized and compressed configuration - * @param sxcfg_size the size sxcfg - * @param scfg_size the size of uncompressed serialized configuration - * @param is_subordinate GNUNET_YES if the controller at delegated_host should - * be started by the slave controller; GNUNET_NO if the slave - * controller has to connect to the already started delegated - * controller via TCP/IP - * @return the operation handle - */ -struct GNUNET_TESTBED_Operation * -GNUNET_TESTBED_controller_link_2_ (void *op_cls, - struct GNUNET_TESTBED_Controller *master, - uint32_t delegated_host_id, - uint32_t slave_host_id, const char *sxcfg, - size_t sxcfg_size, size_t scfg_size, - int is_subordinate); - - -/** - * Same as the GNUNET_TESTBED_controller_link, but with ids for delegated host - * and slave host + * Initialise a barrier and call the given callback when the required percentage + * of peers (quorum) reach the barrier OR upon error. * - * @param op_cls the operation closure for the event which is generated to - * signal success or failure of this operation - * @param master handle to the master controller who creates the association - * @param delegated_host_id id of the host to which requests should be - * delegated; cannot be NULL - * @param slave_host_id id of the host which should connect to controller - * running on delegated host ; use NULL to make the master controller - * connect to the delegated host - * @param slave_cfg configuration to use for the slave controller - * @param is_subordinate GNUNET_YES if the controller at delegated_host should - * be started by the slave controller; GNUNET_NO if the slave - * controller has to connect to the already started delegated - * controller via TCP/IP - * @return the operation handle + * @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_Operation * -GNUNET_TESTBED_controller_link_ (void *op_cls, - struct GNUNET_TESTBED_Controller *master, - uint32_t delegated_host_id, - uint32_t slave_host_id, - const struct GNUNET_CONFIGURATION_Handle - *slave_cfg, int is_subordinate); +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); /** - * Handler for GNUNET_MESSAGE_TYPE_TESTBED_BARRIER_STATUS messages. This - * function is defined in @file testbed_api_barriers.c + * Remove a barrier and it was the last one in the barrier hash map, destroy the + * hash map * - * @param c the controller handle to determine the connection this message - * belongs to - * @param msg the barrier status message - * @return GNUNET_OK to keep the connection active; GNUNET_SYSERR to tear it - * down signalling an error + * @param barrier the barrier to remove */ -int -GNUNET_TESTBED_handle_barrier_status_ (struct GNUNET_TESTBED_Controller *c, - const struct GNUNET_TESTBED_BarrierStatus - *msg); - - +void +GNUNET_TESTBED_barrier_remove_ (struct GNUNET_TESTBED_Barrier *barrier); #endif