2 This file is part of GNUnet
3 (C) 2008--2013 Christian Grothoff (and other contributing authors)
5 GNUnet is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published
7 by the Free Software Foundation; either version 3, or (at your
8 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 General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with GNUnet; see the file COPYING. If not, write to the
17 Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
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_testbed_service.h"
32 #include "testbed_helper.h"
35 * Testbed Helper binary name
37 #define HELPER_TESTBED_BINARY "gnunet-helper-testbed"
41 * Enumeration of operations
46 * Peer create operation
51 * Peer start operation
61 * Peer destroy operation
66 * Get peer information operation
76 * Overlay connection operation
86 * Link controllers operation
91 * Get slave config operation
96 * Stop and destroy all peers
101 * Start/stop service at a peer
108 * The message queue for sending messages to the controller service
114 * Enumeration of states of OperationContext
116 enum OperationContextState
119 * The initial state where the associated operation has just been created
120 * and is waiting in the operation queues to be started
125 * The operation has been started. It may occupy some resources which are to
126 * be freed if cancelled.
131 * The operation has finished. The end results of this operation may occupy
132 * some resources which are to be freed by operation_done
139 * Context information for GNUNET_TESTBED_Operation
141 struct OperationContext
144 * The controller to which this operation context belongs to
146 struct GNUNET_TESTBED_Controller *c;
151 struct GNUNET_TESTBED_Operation *op;
154 * The operation closure
159 * Data relevant to the operation
164 * The id of the opearation
169 * The type of operation
171 enum OperationType type;
174 * The state of the operation
176 enum OperationContextState state;
181 * Handle to interact with a GNUnet testbed controller. Each
182 * controller has at least one master handle which is created when the
183 * controller is created; this master handle interacts with the
184 * controller process, destroying it destroys the controller (by
185 * closing stdin of the controller process). Additionally,
186 * controllers can interact with each other (in a P2P fashion); those
187 * links are established via TCP/IP on the controller's service port.
189 struct GNUNET_TESTBED_Controller
192 * The host where the controller is running
194 struct GNUNET_TESTBED_Host *host;
197 * The controller callback
199 GNUNET_TESTBED_ControllerCallback cc;
202 * The closure for controller callback
207 * The configuration to use while connecting to controller
209 struct GNUNET_CONFIGURATION_Handle *cfg;
212 * The client connection handle to the controller service
214 struct GNUNET_CLIENT_Connection *client;
217 * The head of the message queue
219 struct MessageQueue *mq_head;
222 * The tail of the message queue
224 struct MessageQueue *mq_tail;
227 * The client transmit handle
229 struct GNUNET_CLIENT_TransmitHandle *th;
232 * The host registration handle; NULL if no current registration requests are
235 struct GNUNET_TESTBED_HostRegistrationHandle *rh;
238 * The map of active operation contexts
240 struct GNUNET_CONTAINER_MultiHashMap32 *opc_map;
243 * Operation queue for simultaneous operations
245 struct OperationQueue *opq_parallel_operations;
248 * Operation queue for simultaneous service connections
250 struct OperationQueue *opq_parallel_service_connections;
253 * Operation queue for simultaneous topology configuration operations
255 struct OperationQueue *opq_parallel_topology_config_operations;
258 * The controller event mask
263 * Did we start the receive loop yet?
268 * The operation id counter. use current value and increment
270 uint32_t operation_counter;
276 * Queues a message in send queue for sending to the service
278 * @param controller the handle to the controller
279 * @param msg the message to queue
282 GNUNET_TESTBED_queue_message_ (struct GNUNET_TESTBED_Controller *controller,
283 struct GNUNET_MessageHeader *msg);
287 * Inserts the given operation context into the operation context map of the
288 * given controller. Creates the operation context map if one does not exist
291 * @param c the controller
292 * @param opc the operation context to be inserted
295 GNUNET_TESTBED_insert_opc_ (struct GNUNET_TESTBED_Controller *c,
296 struct OperationContext *opc);
300 * Removes the given operation context from the operation context map of the
303 * @param c the controller
304 * @param opc the operation context to remove
307 GNUNET_TESTBED_remove_opc_ (const struct GNUNET_TESTBED_Controller *c,
308 struct OperationContext *opc);
312 * Compresses given configuration using zlib compress
314 * @param config the serialized configuration
315 * @param size the size of config
316 * @param xconfig will be set to the compressed configuration (memory is fresly
318 * @return the size of the xconfig
321 GNUNET_TESTBED_compress_config_ (const char *config, size_t size,
326 * Function to serialize and compress using zlib a configuration through a
327 * configuration handle
329 * @param cfg the configuration
330 * @param size the size of configuration when serialize. Will be set on success.
331 * @param xsize the sizeo of the compressed configuration. Will be set on success.
332 * @return the serialized and compressed configuration
335 GNUNET_TESTBED_compress_cfg_ (const struct GNUNET_CONFIGURATION_Handle *cfg,
336 size_t *size, size_t *xsize);
340 * Creates a helper initialization message. This function is here because we
341 * want to use this in testing
343 * @param trusted_ip the ip address of the controller which will be set as TRUSTED
344 * HOST(all connections form this ip are permitted by the testbed) when
345 * starting testbed controller at host. This can either be a single ip
346 * address or a network address in CIDR notation.
347 * @param hostname the hostname of the destination this message is intended for
348 * @param cfg the configuration that has to used to start the testbed service
350 * @return the initialization message
352 struct GNUNET_TESTBED_HelperInit *
353 GNUNET_TESTBED_create_helper_init_msg_ (const char *cname, const char *hostname,
354 const struct GNUNET_CONFIGURATION_Handle
359 * Sends the given message as an operation. The given callback is called when a
360 * reply for the operation is available. Call
361 * GNUNET_TESTBED_forward_operation_msg_cancel_() to cleanup the returned
362 * operation context if the cc hasn't been called
364 * @param controller the controller to which the message has to be sent
365 * @param operation_id the operation id of the message
366 * @param msg the message to send
367 * @param cc the callback to call when reply is available
368 * @param cc_cls the closure for the above callback
369 * @return the operation context which can be used to cancel the forwarded
372 struct OperationContext *
373 GNUNET_TESTBED_forward_operation_msg_ (struct GNUNET_TESTBED_Controller
374 *controller, uint64_t operation_id,
375 const struct GNUNET_MessageHeader *msg,
376 GNUNET_CLIENT_MessageHandler cc,
380 * Function to cancel an operation created by simply forwarding an operation
383 * @param opc the operation context from GNUNET_TESTBED_forward_operation_msg_()
386 GNUNET_TESTBED_forward_operation_msg_cancel_ (struct OperationContext *opc);
390 * Generates configuration by uncompressing configuration in given message. The
391 * given message should be of the following types:
392 * GNUNET_MESSAGE_TYPE_TESTBED_PEERCONFIG,
393 * GNUNET_MESSAGE_TYPE_TESTBED_SLAVECONFIG
395 * @param msg the message containing compressed configuration
396 * @return handle to the parsed configuration
398 struct GNUNET_CONFIGURATION_Handle *
399 GNUNET_TESTBED_extract_config_ (const struct GNUNET_MessageHeader *msg);
403 * Checks the integrity of the OpeationFailureEventMessage and if good returns
404 * the error message it contains.
406 * @param msg the OperationFailureEventMessage
407 * @return the error message
410 GNUNET_TESTBED_parse_error_string_ (const struct
411 GNUNET_TESTBED_OperationFailureEventMessage
416 * Function to return the operation id for a controller. The operation id is
417 * created from the controllers host id and its internal operation counter.
419 * @param controller the handle to the controller whose operation id has to be incremented
420 * @return the incremented operation id.
423 GNUNET_TESTBED_get_next_op_id (struct GNUNET_TESTBED_Controller *controller);
427 * Like GNUNET_TESTBED_get_slave_config(), however without the host registration
428 * check. Another difference is that this function takes the id of the slave
431 * @param op_cls the closure for the operation
432 * @param master the handle to master controller
433 * @param slave_host_id id of the host where the slave controller is running to
434 * the slave_host should remain valid until this operation is cancelled
435 * or marked as finished
436 * @return the operation handle;
438 struct GNUNET_TESTBED_Operation *
439 GNUNET_TESTBED_get_slave_config_ (void *op_cls,
440 struct GNUNET_TESTBED_Controller *master,
441 uint32_t slave_host_id);
445 * Same as the GNUNET_TESTBED_controller_link_2, but with ids for delegated host
448 * @param op_cls the operation closure for the event which is generated to
449 * signal success or failure of this operation
450 * @param master handle to the master controller who creates the association
451 * @param delegated_host_id id of the host to which requests should be delegated
452 * @param slave_host_id id of the host which is used to run the slave controller
453 * @param sxcfg serialized and compressed configuration
454 * @param sxcfg_size the size sxcfg
455 * @param scfg_size the size of uncompressed serialized configuration
456 * @param is_subordinate GNUNET_YES if the controller at delegated_host should
457 * be started by the slave controller; GNUNET_NO if the slave
458 * controller has to connect to the already started delegated
459 * controller via TCP/IP
460 * @return the operation handle
462 struct GNUNET_TESTBED_Operation *
463 GNUNET_TESTBED_controller_link_2_ (void *op_cls,
464 struct GNUNET_TESTBED_Controller *master,
465 uint32_t delegated_host_id,
466 uint32_t slave_host_id, const char *sxcfg,
467 size_t sxcfg_size, size_t scfg_size,
472 * Same as the GNUNET_TESTBED_controller_link, but with ids for delegated host
475 * @param op_cls the operation closure for the event which is generated to
476 * signal success or failure of this operation
477 * @param master handle to the master controller who creates the association
478 * @param delegated_host_id id of the host to which requests should be
479 * delegated; cannot be NULL
480 * @param slave_host_id id of the host which should connect to controller
481 * running on delegated host ; use NULL to make the master controller
482 * connect to the delegated host
483 * @param slave_cfg configuration to use for the slave controller
484 * @param is_subordinate GNUNET_YES if the controller at delegated_host should
485 * be started by the slave controller; GNUNET_NO if the slave
486 * controller has to connect to the already started delegated
487 * controller via TCP/IP
488 * @return the operation handle
490 struct GNUNET_TESTBED_Operation *
491 GNUNET_TESTBED_controller_link_ (void *op_cls,
492 struct GNUNET_TESTBED_Controller *master,
493 uint32_t delegated_host_id,
494 uint32_t slave_host_id,
495 const struct GNUNET_CONFIGURATION_Handle
496 *slave_cfg, int is_subordinate);
502 /* end of testbed_api.h */