2 This file is part of GNUnet
3 Copyright (C) 2008--2013 GNUnet e.V.
5 GNUnet is free software: you can redistribute it and/or modify it
6 under the terms of the GNU Affero General Public License as published
7 by the Free Software Foundation, either version 3 of the License,
8 or (at your option) any later version.
10 GNUnet is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 Affero General Public License for more details.
15 You should have received a copy of the GNU Affero General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>.
18 SPDX-License-Identifier: AGPL3.0-or-later
22 * @file testbed/testbed_api.h
23 * @brief Interface for functions internally exported from testbed_api.c
24 * @author Sree Harsha Totakura
30 #include "gnunet_util_lib.h"
31 #include "gnunet_testbed_service.h"
33 #include "testbed_helper.h"
36 * Testbed Helper binary name
38 #define HELPER_TESTBED_BINARY "gnunet-helper-testbed"
42 * Enumeration of operations
47 * Peer create operation
52 * Peer start operation
62 * Peer destroy operation
67 * Get peer information operation
77 * Overlay connection operation
87 * Link controllers operation
92 * Get slave config operation
97 * Stop and destroy all peers
102 * Start/stop service at a peer
109 * Enumeration of states of OperationContext
111 enum OperationContextState
114 * The initial state where the associated operation has just been created
115 * and is waiting in the operation queues to be started
120 * The operation has been started. It may occupy some resources which are to
121 * be freed if cancelled.
126 * The operation has finished. The end results of this operation may occupy
127 * some resources which are to be freed by operation_done
134 * Context information for GNUNET_TESTBED_Operation
136 struct OperationContext
139 * The controller to which this operation context belongs to
141 struct GNUNET_TESTBED_Controller *c;
146 struct GNUNET_TESTBED_Operation *op;
149 * The operation closure
154 * Data relevant to the operation
159 * The id of the opearation
164 * The type of operation
166 enum OperationType type;
169 * The state of the operation
171 enum OperationContextState state;
176 * Operation empty callback
181 (*TESTBED_opcq_empty_cb) (void *cls);
185 * Handle to interact with a GNUnet testbed controller. Each
186 * controller has at least one master handle which is created when the
187 * controller is created; this master handle interacts with the
188 * controller process, destroying it destroys the controller (by
189 * closing stdin of the controller process). Additionally,
190 * controllers can interact with each other (in a P2P fashion); those
191 * links are established via TCP/IP on the controller's service port.
193 struct GNUNET_TESTBED_Controller
196 * The host where the controller is running
198 struct GNUNET_TESTBED_Host *host;
201 * The controller callback
203 GNUNET_TESTBED_ControllerCallback cc;
206 * The closure for controller callback
211 * The configuration to use while connecting to controller
213 struct GNUNET_CONFIGURATION_Handle *cfg;
216 * The message queue to the controller service
218 struct GNUNET_MQ_Handle *mq;
221 * The host registration handle; NULL if no current registration requests are
224 struct GNUNET_TESTBED_HostRegistrationHandle *rh;
227 * The map of active operation contexts
229 struct GNUNET_CONTAINER_MultiHashMap32 *opc_map;
232 * If this callback is not NULL, schedule it as a task when opc_map gets empty
234 TESTBED_opcq_empty_cb opcq_empty_cb;
237 * Closure for the above task
239 void *opcq_empty_cls;
242 * Operation queue for simultaneous operations
244 struct OperationQueue *opq_parallel_operations;
247 * Operation queue for simultaneous service connections
249 struct OperationQueue *opq_parallel_service_connections;
252 * Operation queue for simultaneous topology configuration operations
254 struct OperationQueue *opq_parallel_topology_config_operations;
257 * handle for hashtable of barrier handles, values are
258 * of type `struct GNUNET_TESTBED_Barrier`.
260 struct GNUNET_CONTAINER_MultiHashMap *barrier_map;
263 * The controller event mask
268 * The operation id counter. use current value and increment
270 uint32_t operation_counter;
277 struct GNUNET_TESTBED_Barrier
280 * hashcode identifying this barrier in the hashmap
282 struct GNUNET_HashCode key;
285 * The controller handle given while initiliasing this barrier
287 struct GNUNET_TESTBED_Controller *c;
290 * The name of the barrier
295 * The continuation callback to call when we have a status update on this
297 GNUNET_TESTBED_barrier_status_cb cb;
300 * the closure for the above callback
305 * Should the barrier crossed status message be echoed back to the controller?
312 * Queues a message in send queue for sending to the service
314 * @param controller the handle to the controller
315 * @param msg the message to queue
319 GNUNET_TESTBED_queue_message_ (struct GNUNET_TESTBED_Controller *controller,
320 struct GNUNET_MessageHeader *msg);
324 * Inserts the given operation context into the operation context map of the
325 * given controller. Creates the operation context map if one does not exist
328 * @param c the controller
329 * @param opc the operation context to be inserted
332 GNUNET_TESTBED_insert_opc_ (struct GNUNET_TESTBED_Controller *c,
333 struct OperationContext *opc);
337 * Removes the given operation context from the operation context map of the
340 * @param c the controller
341 * @param opc the operation context to remove
344 GNUNET_TESTBED_remove_opc_ (const struct GNUNET_TESTBED_Controller *c,
345 struct OperationContext *opc);
349 * Compresses given configuration using zlib compress
351 * @param config the serialized configuration
352 * @param size the size of config
353 * @param xconfig will be set to the compressed configuration (memory is fresly
355 * @return the size of the xconfig
358 GNUNET_TESTBED_compress_config_ (const char *config,
364 * Function to serialize and compress using zlib a configuration through a
365 * configuration handle
367 * @param cfg the configuration
368 * @param size the size of configuration when serialize. Will be set on success.
369 * @param xsize the sizeo of the compressed configuration. Will be set on success.
370 * @return the serialized and compressed configuration
373 GNUNET_TESTBED_compress_cfg_ (const struct GNUNET_CONFIGURATION_Handle *cfg,
379 * Creates a helper initialization message. This function is here because we
380 * want to use this in testing
382 * @param trusted_ip the ip address of the controller which will be set as TRUSTED
383 * HOST(all connections form this ip are permitted by the testbed) when
384 * starting testbed controller at host. This can either be a single ip
385 * address or a network address in CIDR notation.
386 * @param hostname the hostname of the destination this message is intended for
387 * @param cfg the configuration that has to used to start the testbed service
389 * @return the initialization message
391 struct GNUNET_TESTBED_HelperInit *
392 GNUNET_TESTBED_create_helper_init_msg_ (const char *cname,
393 const char *hostname,
395 GNUNET_CONFIGURATION_Handle *cfg);
399 * Sends the given message as an operation. The given callback is called when a
400 * reply for the operation is available. Call
401 * GNUNET_TESTBED_forward_operation_msg_cancel_() to cleanup the returned
402 * operation context if the cc hasn't been called
404 * @param controller the controller to which the message has to be sent
405 * @param operation_id the operation id of the message
406 * @param msg the message to send
407 * @param cc the callback to call when reply is available
408 * @param cc_cls the closure for the above callback
409 * @return the operation context which can be used to cancel the forwarded
412 struct OperationContext *
413 GNUNET_TESTBED_forward_operation_msg_ (struct
414 GNUNET_TESTBED_Controller *controller,
415 uint64_t operation_id,
416 const struct GNUNET_MessageHeader *msg,
417 GNUNET_MQ_MessageCallback cc,
421 * Function to cancel an operation created by simply forwarding an operation
424 * @param opc the operation context from GNUNET_TESTBED_forward_operation_msg_()
427 GNUNET_TESTBED_forward_operation_msg_cancel_ (struct OperationContext *opc);
431 * Generates configuration by uncompressing configuration in given message. The
432 * given message should be of the following types:
433 * #GNUNET_MESSAGE_TYPE_TESTBED_PEERCONFIG,
434 * #GNUNET_MESSAGE_TYPE_TESTBED_SLAVECONFIG
436 * @param msg the message containing compressed configuration
437 * @return handle to the parsed configuration
439 struct GNUNET_CONFIGURATION_Handle *
440 GNUNET_TESTBED_extract_config_ (const struct GNUNET_MessageHeader *msg);
444 * Checks the integrity of the OpeationFailureEventMessage and if good returns
445 * the error message it contains.
447 * @param msg the OperationFailureEventMessage
448 * @return the error message
451 GNUNET_TESTBED_parse_error_string_ (const struct
452 GNUNET_TESTBED_OperationFailureEventMessage
457 * Function to return the operation id for a controller. The operation id is
458 * created from the controllers host id and its internal operation counter.
460 * @param controller the handle to the controller whose operation id has to be incremented
461 * @return the incremented operation id.
464 GNUNET_TESTBED_get_next_op_id (struct GNUNET_TESTBED_Controller *controller);
468 * Like GNUNET_TESTBED_get_slave_config(), however without the host registration
469 * check. Another difference is that this function takes the id of the slave
472 * @param op_cls the closure for the operation
473 * @param master the handle to master controller
474 * @param slave_host_id id of the host where the slave controller is running to
475 * the slave_host should remain valid until this operation is cancelled
476 * or marked as finished
477 * @return the operation handle;
479 struct GNUNET_TESTBED_Operation *
480 GNUNET_TESTBED_get_slave_config_ (void *op_cls,
481 struct GNUNET_TESTBED_Controller *master,
482 uint32_t slave_host_id);
486 * Initialise a barrier and call the given callback when the required percentage
487 * of peers (quorum) reach the barrier OR upon error.
489 * @param controller the handle to the controller
490 * @param name identification name of the barrier
491 * @param quorum the percentage of peers that is required to reach the barrier.
492 * Peers signal reaching a barrier by calling
493 * GNUNET_TESTBED_barrier_reached().
494 * @param cb the callback to call when the barrier is reached or upon error.
496 * @param cls closure for the above callback
497 * @param echo #GNUNET_YES to echo the barrier crossed status message back to the
499 * @return barrier handle; NULL upon error
501 struct GNUNET_TESTBED_Barrier *
502 GNUNET_TESTBED_barrier_init_ (struct GNUNET_TESTBED_Controller *controller,
505 GNUNET_TESTBED_barrier_status_cb cb,
511 * Remove a barrier and it was the last one in the barrier hash map, destroy the
514 * @param barrier the barrier to remove
517 GNUNET_TESTBED_barrier_remove_ (struct GNUNET_TESTBED_Barrier *barrier);
521 /* end of testbed_api.h */