2 This file is part of GNUnet
3 (C) 2012 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"
34 * Enumeration of operations
39 * Peer create operation
44 * Peer start operation
54 * Peer destroy operation
59 * Get peer information operation
64 * Overlay connection operation
74 * Link controllers operation
79 * Get slave config operation
87 * Testbed operation structure
89 struct GNUNET_TESTBED_Operation
92 * next pointer for DLL
94 struct GNUNET_TESTBED_Operation *next;
97 * prev pointer for DLL
99 struct GNUNET_TESTBED_Operation *prev;
102 * The controller on which this operation operates
104 struct GNUNET_TESTBED_Controller *controller;
107 * The ID for the operation;
109 uint64_t operation_id;
112 * The type of operation
114 enum OperationType type;
117 * Data specific to OperationType
124 * The message queue for sending messages to the controller service
129 * Structure for a controller link
131 struct ControllerLink;
135 * Enumeration of states of OperationContext
137 enum OperationContextState
140 * The initial state where the associated operation has just been created
141 * and is waiting in the operation queues to be started
146 * The operation has been started. It may occupy some resources which are to
147 * be freed if cancelled.
152 * The operation has finished. The end results of this operation may occupy
153 * some resources which are to be freed by operation_done
160 * Context information for GNUNET_TESTBED_Operation
162 struct OperationContext
167 struct OperationContext *next;
172 struct OperationContext *prev;
175 * The controller to which this operation context belongs to
177 struct GNUNET_TESTBED_Controller *c;
182 struct GNUNET_TESTBED_Operation *op;
185 * Data relevant to the operation
190 * The id of the opearation
195 * The type of operation
197 enum OperationType type;
200 * The state of the operation
202 enum OperationContextState state;
207 * Handle to interact with a GNUnet testbed controller. Each
208 * controller has at least one master handle which is created when the
209 * controller is created; this master handle interacts with the
210 * controller process, destroying it destroys the controller (by
211 * closing stdin of the controller process). Additionally,
212 * controllers can interact with each other (in a P2P fashion); those
213 * links are established via TCP/IP on the controller's service port.
215 struct GNUNET_TESTBED_Controller
219 * The host where the controller is running
221 struct GNUNET_TESTBED_Host *host;
224 * The controller callback
226 GNUNET_TESTBED_ControllerCallback cc;
229 * The closure for controller callback
234 * The configuration to use while connecting to controller
236 struct GNUNET_CONFIGURATION_Handle *cfg;
239 * The client connection handle to the controller service
241 struct GNUNET_CLIENT_Connection *client;
244 * The head of the message queue
246 struct MessageQueue *mq_head;
249 * The tail of the message queue
251 struct MessageQueue *mq_tail;
254 * The head of the ControllerLink list
256 struct ControllerLink *cl_head;
259 * The tail of the ControllerLink list
261 struct ControllerLink *cl_tail;
264 * The client transmit handle
266 struct GNUNET_CLIENT_TransmitHandle *th;
269 * The host registration handle; NULL if no current registration requests are
272 struct GNUNET_TESTBED_HostRegistrationHandle *rh;
275 * The head of the opeartion context queue
277 struct OperationContext *ocq_head;
280 * The tail of the operation context queue
282 struct OperationContext *ocq_tail;
285 * Operation queue for simultaneous operations
287 struct OperationQueue *opq_parallel_operations;
290 * Operation queue for simultaneous service connections
292 struct OperationQueue *opq_parallel_service_connections;
295 * Operation queue for simultaneous topology configuration operations
297 struct OperationQueue *opq_parallel_topology_config_operations;
300 * The operation id counter. use current value and increment
302 uint64_t operation_counter;
305 * The controller event mask
310 * Did we start the receive loop yet?
315 * Did we create the host for this?
322 * Queues a message in send queue for sending to the service
324 * @param controller the handle to the controller
325 * @param msg the message to queue
328 GNUNET_TESTBED_queue_message_ (struct GNUNET_TESTBED_Controller *controller,
329 struct GNUNET_MessageHeader *msg);
333 * Compresses given configuration using zlib compress
335 * @param config the serialized configuration
336 * @param size the size of config
337 * @param xconfig will be set to the compressed configuration (memory is fresly
339 * @return the size of the xconfig
342 GNUNET_TESTBED_compress_config_ (const char *config, size_t size,
347 * Adds an operation to the queue of operations
349 * @param op the operation to add
352 GNUNET_TESTBED_operation_add_ (struct GNUNET_TESTBED_Operation *op);
356 * Creates a helper initialization message. Only for testing.
358 * @param cname the ip address of the controlling host
359 * @param hostname the hostname of the destination this message is intended for
360 * @param cfg the configuration that has to used to start the testbed service
362 * @return the initialization message
364 struct GNUNET_TESTBED_HelperInit *
365 GNUNET_TESTBED_create_helper_init_msg_ (const char *cname,
366 const char *hostname,
367 const struct GNUNET_CONFIGURATION_Handle
372 * Sends the given message as an operation. The given callback is called when a
373 * reply for the operation is available. Call
374 * GNUNET_TESTBED_forward_operation_msg_cancel_() to cleanup the returned
375 * operation context if the cc hasn't been called
377 * @param controller the controller to which the message has to be sent
378 * @param operation_id the operation id of the message
379 * @param msg the message to send
380 * @param cc the callback to call when reply is available
381 * @param cc_cls the closure for the above callback
382 * @return the operation context which can be used to cancel the forwarded
385 struct OperationContext *
386 GNUNET_TESTBED_forward_operation_msg_ (struct GNUNET_TESTBED_Controller
387 *controller, uint64_t operation_id,
388 const struct GNUNET_MessageHeader *msg,
389 GNUNET_CLIENT_MessageHandler cc,
393 * Function to cancel an operation created by simply forwarding an operation
396 * @param opc the operation context from GNUNET_TESTBED_forward_operation_msg_()
399 GNUNET_TESTBED_forward_operation_msg_cancel_ (struct OperationContext *opc);
403 * Generates configuration by uncompressing configuration in given message. The
404 * given message should be of the following types:
405 * GNUNET_MESSAGE_TYPE_TESTBED_PEERCONFIG,
406 * GNUNET_MESSAGE_TYPE_TESTBED_SLAVECONFIG
408 * @param msg the message containing compressed configuration
409 * @return handle to the parsed configuration
411 struct GNUNET_CONFIGURATION_Handle *
412 GNUNET_TESTBED_extract_config_ (const struct GNUNET_MessageHeader *msg);
416 * Checks the integrity of the OpeationFailureEventMessage and if good returns
417 * the error message it contains.
419 * @param msg the OperationFailureEventMessage
420 * @return the error message
423 GNUNET_TESTBED_parse_error_string_ (const struct
424 GNUNET_TESTBED_OperationFailureEventMessage
428 /* end of testbed_api.h */