2 This file is part of GNUnet
3 (C) 2008--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.c
23 * @brief API for accessing the GNUnet testing service.
24 * This library is supposed to make it easier to write
25 * testcases and script large-scale benchmarks.
26 * @author Christian Grothoff
27 * @author Sree Harsha Totakura
32 #include "gnunet_testbed_service.h"
33 #include "gnunet_core_service.h"
34 #include "gnunet_constants.h"
35 #include "gnunet_transport_service.h"
36 #include "gnunet_hello_lib.h"
40 #include "testbed_api.h"
41 #include "testbed_api_hosts.h"
42 #include "testbed_api_peers.h"
43 #include "testbed_api_operations.h"
46 * Generic logging shorthand
48 #define LOG(kind, ...) \
49 GNUNET_log_from (kind, "testbed-api", __VA_ARGS__);
54 #define LOG_DEBUG(...) \
55 LOG (GNUNET_ERROR_TYPE_DEBUG, __VA_ARGS__);
58 * Relative time seconds shorthand
60 #define TIME_REL_SECS(sec) \
61 GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, sec)
65 * Default server message sending retry timeout
67 #define TIMEOUT_REL TIME_REL_SECS(1)
71 * Testbed Helper binary name
73 #define HELPER_TESTBED_BINARY "gnunet-helper-testbed"
77 * The message queue for sending messages to the controller service
82 * The message to be sent
84 struct GNUNET_MessageHeader *msg;
87 * next pointer for DLL
89 struct MessageQueue *next;
92 * prev pointer for DLL
94 struct MessageQueue *prev;
99 * Structure for a controller link
101 struct ControllerLink
104 * The next ptr for DLL
106 struct ControllerLink *next;
109 * The prev ptr for DLL
111 struct ControllerLink *prev;
114 * The host which will be referred in the peer start request. This is the
115 * host where the peer should be started
117 struct GNUNET_TESTBED_Host *delegated_host;
120 * The host which will contacted to delegate the peer start request
122 struct GNUNET_TESTBED_Host *slave_host;
125 * The configuration to be used to connect to slave host
127 const struct GNUNET_CONFIGURATION_Handle *slave_cfg;
130 * GNUNET_YES if the slave should be started (and stopped) by us; GNUNET_NO
131 * if we are just allowed to use the slave via TCP/IP
138 * handle for host registration
140 struct GNUNET_TESTBED_HostRegistrationHandle
143 * The host being registered
145 struct GNUNET_TESTBED_Host *host;
148 * The controller at which this host is being registered
150 struct GNUNET_TESTBED_Controller *c;
153 * The Registartion completion callback
155 GNUNET_TESTBED_HostRegistrationCompletion cc;
158 * The closure for above callback
165 * Context data for forwarded Operation
167 struct ForwardedOperationData
171 * The callback to call when reply is available
173 GNUNET_CLIENT_MessageHandler cc;
176 * The closure for the above callback
184 * Returns the operation context with the given id if found in the Operation
185 * context queues of the controller
187 * @param c the controller whose queues are searched
188 * @param id the id which has to be checked
189 * @return the matching operation context; NULL if no match found
191 static struct OperationContext *
192 find_opc (const struct GNUNET_TESTBED_Controller *c, const uint64_t id)
194 struct OperationContext *opc;
196 for (opc = c->ocq_head; NULL != opc; opc = opc->next)
206 * Handler for GNUNET_MESSAGE_TYPE_TESTBED_ADDHOSTCONFIRM message from
207 * controller (testbed service)
209 * @param c the controller handler
210 * @param msg message received
211 * @return GNUNET_YES if we can continue receiving from service; GNUNET_NO if
215 handle_addhostconfirm (struct GNUNET_TESTBED_Controller *c,
216 const struct GNUNET_TESTBED_HostConfirmedMessage *msg)
218 struct GNUNET_TESTBED_HostRegistrationHandle *rh;
227 if (GNUNET_TESTBED_host_get_id_ (rh->host) != ntohl (msg->host_id))
229 LOG_DEBUG ("Mismatch in host id's %u, %u of host confirm msg\n",
230 GNUNET_TESTBED_host_get_id_ (rh->host), ntohl (msg->host_id));
234 msg_size = ntohs (msg->header.size);
235 if (sizeof (struct GNUNET_TESTBED_HostConfirmedMessage) == msg_size)
237 LOG_DEBUG ("Host %u successfully registered\n", ntohl (msg->host_id));
238 GNUNET_TESTBED_mark_host_registered_at_ (rh->host, c);
239 rh->cc (rh->cc_cls, NULL);
243 /* We have an error message */
244 emsg = (char *) &msg[1];
246 emsg[msg_size - sizeof (struct GNUNET_TESTBED_HostConfirmedMessage)])
252 LOG (GNUNET_ERROR_TYPE_ERROR, _("Adding host %u failed with error: %s\n"),
253 ntohl (msg->host_id), emsg);
254 rh->cc (rh->cc_cls, emsg);
261 * Handler for GNUNET_MESSAGE_TYPE_TESTBED_ADDHOSTCONFIRM message from
262 * controller (testbed service)
264 * @param c the controller handler
265 * @param msg message received
266 * @return GNUNET_YES if we can continue receiving from service; GNUNET_NO if
270 handle_opsuccess (struct GNUNET_TESTBED_Controller *c,
272 GNUNET_TESTBED_GenericOperationSuccessEventMessage *msg)
274 struct OperationContext *opc;
275 struct GNUNET_TESTBED_EventInformation *event;
278 op_id = GNUNET_ntohll (msg->operation_id);
279 LOG_DEBUG ("Operation %ul successful\n", op_id);
280 if (NULL == (opc = find_opc (c, op_id)))
282 LOG_DEBUG ("Operation not found\n");
286 if (0 != (c->event_mask & (1L << GNUNET_TESTBED_ET_OPERATION_FINISHED)))
287 event = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_EventInformation));
289 event->type = GNUNET_TESTBED_ET_OPERATION_FINISHED;
294 struct ForwardedOperationData *fo_data;
297 if (NULL != fo_data->cc)
298 fo_data->cc (fo_data->cc_cls, (const struct GNUNET_MessageHeader *) msg);
299 GNUNET_CONTAINER_DLL_remove (c->ocq_head, c->ocq_tail, opc);
300 GNUNET_free (fo_data);
305 case OP_PEER_DESTROY:
307 struct GNUNET_TESTBED_Peer *peer;
315 case OP_LINK_CONTROLLERS:
322 event->details.operation_finished.operation = opc->op;
323 event->details.operation_finished.op_cls = NULL;
324 event->details.operation_finished.emsg = NULL;
325 event->details.operation_finished.generic = NULL;
327 GNUNET_CONTAINER_DLL_remove (opc->c->ocq_head, opc->c->ocq_tail, opc);
328 opc->state = OPC_STATE_FINISHED;
332 c->cc (c->cc_cls, event);
340 * Handler for GNUNET_MESSAGE_TYPE_TESTBED_PEERCREATESUCCESS message from
341 * controller (testbed service)
343 * @param c the controller handler
344 * @param msg message received
345 * @return GNUNET_YES if we can continue receiving from service; GNUNET_NO if
349 handle_peer_create_success (struct GNUNET_TESTBED_Controller *c,
351 GNUNET_TESTBED_PeerCreateSuccessEventMessage *msg)
353 struct OperationContext *opc;
354 struct PeerCreateData *data;
355 struct GNUNET_TESTBED_Peer *peer;
356 GNUNET_TESTBED_PeerCreateCallback cb;
360 GNUNET_assert (sizeof (struct GNUNET_TESTBED_PeerCreateSuccessEventMessage) ==
361 ntohs (msg->header.size));
362 op_id = GNUNET_ntohll (msg->operation_id);
363 if (NULL == (opc = find_opc (c, op_id)))
365 LOG_DEBUG ("Operation context for PeerCreateSuccessEvent not found\n");
368 if (OP_FORWARDED == opc->type)
370 struct ForwardedOperationData *fo_data;
373 if (NULL != fo_data->cc)
374 fo_data->cc (fo_data->cc_cls, (const struct GNUNET_MessageHeader *) msg);
375 GNUNET_CONTAINER_DLL_remove (c->ocq_head, c->ocq_tail, opc);
376 GNUNET_free (fo_data);
380 GNUNET_assert (OP_PEER_CREATE == opc->type);
381 GNUNET_assert (NULL != opc->data);
383 GNUNET_assert (NULL != data->peer);
385 GNUNET_assert (peer->unique_id == ntohl (msg->peer_id));
386 peer->state = PS_CREATED;
389 GNUNET_free (opc->data);
390 GNUNET_CONTAINER_DLL_remove (opc->c->ocq_head, opc->c->ocq_tail, opc);
391 opc->state = OPC_STATE_FINISHED;
393 cb (cls, peer, NULL);
399 * Handler for GNUNET_MESSAGE_TYPE_TESTBED_PEEREVENT message from
400 * controller (testbed service)
402 * @param c the controller handler
403 * @param msg message received
404 * @return GNUNET_YES if we can continue receiving from service; GNUNET_NO if
408 handle_peer_event (struct GNUNET_TESTBED_Controller *c,
409 const struct GNUNET_TESTBED_PeerEventMessage *msg)
411 struct OperationContext *opc;
412 struct GNUNET_TESTBED_Peer *peer;
413 struct PeerEventData *data;
414 GNUNET_TESTBED_PeerChurnCallback pcc;
416 struct GNUNET_TESTBED_EventInformation event;
419 GNUNET_assert (sizeof (struct GNUNET_TESTBED_PeerEventMessage) ==
420 ntohs (msg->header.size));
421 op_id = GNUNET_ntohll (msg->operation_id);
422 if (NULL == (opc = find_opc (c, op_id)))
424 LOG_DEBUG ("Operation not found\n");
427 if (OP_FORWARDED == opc->type)
429 struct ForwardedOperationData *fo_data;
432 if (NULL != fo_data->cc)
433 fo_data->cc (fo_data->cc_cls, (const struct GNUNET_MessageHeader *) msg);
434 GNUNET_CONTAINER_DLL_remove (c->ocq_head, c->ocq_tail, opc);
435 GNUNET_free (fo_data);
439 GNUNET_assert ((OP_PEER_START == opc->type) || (OP_PEER_STOP == opc->type));
441 GNUNET_assert (NULL != data);
443 GNUNET_assert (NULL != peer);
444 event.type = (enum GNUNET_TESTBED_EventType) ntohl (msg->event_type);
447 case GNUNET_TESTBED_ET_PEER_START:
448 peer->state = PS_STARTED;
449 event.details.peer_start.host = peer->host;
450 event.details.peer_start.peer = peer;
452 case GNUNET_TESTBED_ET_PEER_STOP:
453 peer->state = PS_STOPPED;
454 event.details.peer_stop.peer = peer;
457 GNUNET_assert (0); /* We should never reach this state */
460 pcc_cls = data->pcc_cls;
462 GNUNET_CONTAINER_DLL_remove (opc->c->ocq_head, opc->c->ocq_tail, opc);
463 opc->state = OPC_STATE_FINISHED;
465 ((GNUNET_TESTBED_ET_PEER_START | GNUNET_TESTBED_ET_PEER_STOP) &
469 c->cc (c->cc_cls, &event);
478 * Handler for GNUNET_MESSAGE_TYPE_TESTBED_PEERCONEVENT message from
479 * controller (testbed service)
481 * @param c the controller handler
482 * @param msg message received
483 * @return GNUNET_YES if we can continue receiving from service; GNUNET_NO if
487 handle_peer_conevent (struct GNUNET_TESTBED_Controller *c,
488 const struct GNUNET_TESTBED_ConnectionEventMessage *msg)
490 struct OperationContext *opc;
491 struct OverlayConnectData *data;
492 GNUNET_TESTBED_OperationCompletionCallback cb;
494 struct GNUNET_TESTBED_EventInformation event;
497 op_id = GNUNET_ntohll (msg->operation_id);
498 if (NULL == (opc = find_opc (c, op_id)))
500 LOG_DEBUG ("Operation not found\n");
504 GNUNET_assert (NULL != data);
505 GNUNET_assert ((ntohl (msg->peer1) == data->p1->unique_id) &&
506 (ntohl (msg->peer2) == data->p2->unique_id));
507 event.type = (enum GNUNET_TESTBED_EventType) ntohl (msg->event_type);
510 case GNUNET_TESTBED_ET_CONNECT:
511 event.details.peer_connect.peer1 = data->p1;
512 event.details.peer_connect.peer2 = data->p2;
514 case GNUNET_TESTBED_ET_DISCONNECT:
515 GNUNET_assert (0); /* FIXME: implement */
518 GNUNET_assert (0); /* Should never reach here */
522 cb_cls = data->cb_cls;
523 GNUNET_CONTAINER_DLL_remove (opc->c->ocq_head, opc->c->ocq_tail, opc);
524 opc->state = OPC_STATE_FINISHED;
527 ((GNUNET_TESTBED_ET_CONNECT | GNUNET_TESTBED_ET_DISCONNECT) &
531 c->cc (c->cc_cls, &event);
534 cb (cb_cls, opc->op, NULL);
540 * Handler for GNUNET_MESSAGE_TYPE_TESTBED_PEERCONFIG message from
541 * controller (testbed service)
543 * @param c the controller handler
544 * @param msg message received
545 * @return GNUNET_YES if we can continue receiving from service; GNUNET_NO if
549 handle_peer_config (struct GNUNET_TESTBED_Controller *c,
551 GNUNET_TESTBED_PeerConfigurationInformationMessage *msg)
553 struct OperationContext *opc;
554 struct GNUNET_TESTBED_Peer *peer;
555 struct PeerInfoData *data;
556 struct GNUNET_TESTBED_PeerInformation *pinfo;
557 GNUNET_TESTBED_PeerInfoCallback cb;
561 op_id = GNUNET_ntohll (msg->operation_id);
562 if (NULL == (opc = find_opc (c, op_id)))
564 LOG_DEBUG ("Operation not found\n");
567 if (OP_FORWARDED == opc->type)
569 struct ForwardedOperationData *fo_data;
572 if (NULL != fo_data->cc)
573 fo_data->cc (fo_data->cc_cls, (const struct GNUNET_MessageHeader *) msg);
574 GNUNET_CONTAINER_DLL_remove (c->ocq_head, c->ocq_tail, opc);
575 GNUNET_free (fo_data);
580 GNUNET_assert (NULL != data);
582 GNUNET_assert (NULL != peer);
583 GNUNET_assert (ntohl (msg->peer_id) == peer->unique_id);
584 pinfo = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_PeerInformation));
585 pinfo->pit = data->pit;
587 cb_cls = data->cb_cls;
592 case GNUNET_TESTBED_PIT_IDENTITY:
593 pinfo->result.id = GNUNET_malloc (sizeof (struct GNUNET_PeerIdentity));
594 (void) memcpy (pinfo->result.id, &msg->peer_identity,
595 sizeof (struct GNUNET_PeerIdentity));
597 case GNUNET_TESTBED_PIT_CONFIGURATION:
598 pinfo->result.cfg = /* Freed in oprelease_peer_getinfo */
599 GNUNET_TESTBED_get_config_from_peerinfo_msg_ (msg);
601 case GNUNET_TESTBED_PIT_GENERIC:
602 GNUNET_assert (0); /* never reach here */
606 GNUNET_CONTAINER_DLL_remove (opc->c->ocq_head, opc->c->ocq_tail, opc);
607 opc->state = OPC_STATE_FINISHED;
609 cb (cb_cls, opc->op, pinfo, NULL);
615 * Handler for GNUNET_MESSAGE_TYPE_TESTBED_OPERATIONFAILEVENT message from
616 * controller (testbed service)
618 * @param c the controller handler
619 * @param msg message received
620 * @return GNUNET_YES if we can continue receiving from service; GNUNET_NO if
624 handle_op_fail_event (struct GNUNET_TESTBED_Controller *c,
625 const struct GNUNET_TESTBED_OperationFailureEventMessage
628 struct OperationContext *opc;
631 struct GNUNET_TESTBED_EventInformation event;
633 op_id = GNUNET_ntohll (msg->operation_id);
634 if (NULL == (opc = find_opc (c, op_id)))
636 LOG_DEBUG ("Operation not found\n");
639 GNUNET_CONTAINER_DLL_remove (opc->c->ocq_head, opc->c->ocq_tail, opc);
640 if (OP_FORWARDED == opc->type)
642 struct ForwardedOperationData *fo_data;
645 if (NULL != fo_data->cc)
646 fo_data->cc (fo_data->cc_cls, (const struct GNUNET_MessageHeader *) msg);
647 GNUNET_free (fo_data);
651 opc->state = OPC_STATE_FINISHED;
652 emsg = GNUNET_TESTBED_parse_error_string_ (msg);
654 emsg = "Unknown error";
655 if (OP_PEER_INFO == opc->type)
657 struct PeerInfoData *data;
659 if (NULL != data->cb)
660 data->cb (data->cb_cls, opc->op, NULL, emsg);
662 return GNUNET_YES; /* We do not call controller callback for peer info */
664 if ((0 != (GNUNET_TESTBED_ET_OPERATION_FINISHED & c->event_mask)) &&
667 event.type = GNUNET_TESTBED_ET_OPERATION_FINISHED;
668 event.details.operation_finished.operation = opc->op;
669 event.details.operation_finished.op_cls = NULL;
670 event.details.operation_finished.emsg = emsg;
671 event.details.operation_finished.generic = NULL;
672 c->cc (c->cc_cls, &event);
678 struct PeerCreateData *data;
680 GNUNET_free (data->peer);
681 if (NULL != data->cb)
682 data->cb (data->cls, NULL, emsg);
689 struct PeerEventData *data;
691 if (NULL != data->pcc)
692 data->pcc (data->pcc_cls, emsg);
696 case OP_PEER_DESTROY:
700 case OP_OVERLAY_CONNECT:
702 struct OverlayConnectData *data;
704 if (NULL != data->cb)
705 data->cb (data->cb_cls, opc->op, emsg);
711 case OP_LINK_CONTROLLERS: /* No secondary callback */
721 * Handler for messages from controller (testbed service)
723 * @param cls the controller handler
724 * @param msg message received, NULL on timeout or fatal error
727 message_handler (void *cls, const struct GNUNET_MessageHeader *msg)
729 struct GNUNET_TESTBED_Controller *c = cls;
733 c->in_receive = GNUNET_NO;
734 /* FIXME: Add checks for message integrity */
737 LOG_DEBUG ("Receive timed out or connection to service dropped\n");
741 msize = ntohs (msg->size);
742 switch (ntohs (msg->type))
744 case GNUNET_MESSAGE_TYPE_TESTBED_ADDHOSTCONFIRM:
745 GNUNET_assert (msize >=
746 sizeof (struct GNUNET_TESTBED_HostConfirmedMessage));
748 handle_addhostconfirm (c,
749 (const struct GNUNET_TESTBED_HostConfirmedMessage
752 case GNUNET_MESSAGE_TYPE_TESTBED_GENERICOPSUCCESS:
753 GNUNET_assert (msize ==
755 GNUNET_TESTBED_GenericOperationSuccessEventMessage));
759 GNUNET_TESTBED_GenericOperationSuccessEventMessage *)
762 case GNUNET_MESSAGE_TYPE_TESTBED_PEERCREATESUCCESS:
763 GNUNET_assert (msize ==
765 GNUNET_TESTBED_PeerCreateSuccessEventMessage));
767 handle_peer_create_success (c,
769 GNUNET_TESTBED_PeerCreateSuccessEventMessage
772 case GNUNET_MESSAGE_TYPE_TESTBED_PEEREVENT:
773 GNUNET_assert (msize == sizeof (struct GNUNET_TESTBED_PeerEventMessage));
775 handle_peer_event (c,
776 (const struct GNUNET_TESTBED_PeerEventMessage *)
780 case GNUNET_MESSAGE_TYPE_TESTBED_PEERCONFIG:
781 GNUNET_assert (msize >=
783 GNUNET_TESTBED_PeerConfigurationInformationMessage));
785 handle_peer_config (c,
787 GNUNET_TESTBED_PeerConfigurationInformationMessage
790 case GNUNET_MESSAGE_TYPE_TESTBED_PEERCONEVENT:
791 GNUNET_assert (msize ==
792 sizeof (struct GNUNET_TESTBED_ConnectionEventMessage));
794 handle_peer_conevent (c,
796 GNUNET_TESTBED_ConnectionEventMessage *) msg);
798 case GNUNET_MESSAGE_TYPE_TESTBED_OPERATIONFAILEVENT:
799 GNUNET_assert (msize >=
800 sizeof (struct GNUNET_TESTBED_OperationFailureEventMessage));
802 handle_op_fail_event (c,
804 GNUNET_TESTBED_OperationFailureEventMessage *)
810 if ((GNUNET_OK == status) && (GNUNET_NO == c->in_receive))
812 c->in_receive = GNUNET_YES;
813 GNUNET_CLIENT_receive (c->client, &message_handler, c,
814 GNUNET_TIME_UNIT_FOREVER_REL);
820 * Function called to notify a client about the connection begin ready to queue
821 * more data. "buf" will be NULL and "size" zero if the connection was closed
822 * for writing in the meantime.
825 * @param size number of bytes available in buf
826 * @param buf where the callee should write the message
827 * @return number of bytes written to buf
830 transmit_ready_notify (void *cls, size_t size, void *buf)
832 struct GNUNET_TESTBED_Controller *c = cls;
833 struct MessageQueue *mq_entry;
836 mq_entry = c->mq_head;
837 GNUNET_assert (NULL != mq_entry);
838 if ((0 == size) && (NULL == buf)) /* Timeout */
840 LOG_DEBUG ("Message sending timed out -- retrying\n");
842 GNUNET_CLIENT_notify_transmit_ready (c->client,
843 ntohs (mq_entry->msg->size),
844 TIMEOUT_REL, GNUNET_YES,
845 &transmit_ready_notify, c);
848 GNUNET_assert (ntohs (mq_entry->msg->size) <= size);
849 size = ntohs (mq_entry->msg->size);
850 memcpy (buf, mq_entry->msg, size);
851 LOG_DEBUG ("Message of type: %u and size: %u sent\n",
852 ntohs (mq_entry->msg->type), size);
853 GNUNET_free (mq_entry->msg);
854 GNUNET_CONTAINER_DLL_remove (c->mq_head, c->mq_tail, mq_entry);
855 GNUNET_free (mq_entry);
856 mq_entry = c->mq_head;
857 if (NULL != mq_entry)
859 GNUNET_CLIENT_notify_transmit_ready (c->client,
860 ntohs (mq_entry->msg->size),
861 TIMEOUT_REL, GNUNET_YES,
862 &transmit_ready_notify, c);
863 if (GNUNET_NO == c->in_receive)
865 c->in_receive = GNUNET_YES;
866 GNUNET_CLIENT_receive (c->client, &message_handler, c,
867 GNUNET_TIME_UNIT_FOREVER_REL);
874 * Queues a message in send queue for sending to the service
876 * @param controller the handle to the controller
877 * @param msg the message to queue
880 GNUNET_TESTBED_queue_message_ (struct GNUNET_TESTBED_Controller *controller,
881 struct GNUNET_MessageHeader *msg)
883 struct MessageQueue *mq_entry;
887 type = ntohs (msg->type);
888 size = ntohs (msg->size);
889 GNUNET_assert ((GNUNET_MESSAGE_TYPE_TESTBED_INIT <= type) &&
890 (GNUNET_MESSAGE_TYPE_TESTBED_MAX > type));
891 mq_entry = GNUNET_malloc (sizeof (struct MessageQueue));
893 LOG (GNUNET_ERROR_TYPE_DEBUG,
894 "Queueing message of type %u, size %u for sending\n", type,
896 GNUNET_CONTAINER_DLL_insert_tail (controller->mq_head, controller->mq_tail,
898 if (NULL == controller->th)
900 GNUNET_CLIENT_notify_transmit_ready (controller->client, size,
901 TIMEOUT_REL, GNUNET_YES,
902 &transmit_ready_notify,
908 * Sends the given message as an operation. The given callback is called when a
909 * reply for the operation is available. Call
910 * GNUNET_TESTBED_forward_operation_msg_cancel_() to cleanup the returned
911 * operation context if the cc hasn't been called
913 * @param controller the controller to which the message has to be sent
914 * @param operation_id the operation id of the message
915 * @param msg the message to send
916 * @param cc the callback to call when reply is available
917 * @param cc_cls the closure for the above callback
918 * @return the operation context which can be used to cancel the forwarded
921 struct OperationContext *
922 GNUNET_TESTBED_forward_operation_msg_ (struct GNUNET_TESTBED_Controller
923 *controller, uint64_t operation_id,
924 const struct GNUNET_MessageHeader *msg,
925 GNUNET_CLIENT_MessageHandler cc,
928 struct OperationContext *opc;
929 struct ForwardedOperationData *data;
930 struct GNUNET_MessageHeader *dup_msg;
933 data = GNUNET_malloc (sizeof (struct ForwardedOperationData));
935 data->cc_cls = cc_cls;
936 opc = GNUNET_malloc (sizeof (struct OperationContext));
938 opc->type = OP_FORWARDED;
940 opc->id = operation_id;
941 msize = ntohs (msg->size);
942 dup_msg = GNUNET_malloc (msize);
943 (void) memcpy (dup_msg, msg, msize);
944 GNUNET_TESTBED_queue_message_ (opc->c, dup_msg);
945 GNUNET_CONTAINER_DLL_insert_tail (controller->ocq_head, controller->ocq_tail,
952 * Function to cancel an operation created by simply forwarding an operation
955 * @param opc the operation context from GNUNET_TESTBED_forward_operation_msg_()
958 GNUNET_TESTBED_forward_operation_msg_cancel_ (struct OperationContext *opc)
960 GNUNET_CONTAINER_DLL_remove (opc->c->ocq_head, opc->c->ocq_tail, opc);
961 GNUNET_free (opc->data);
967 * Handle for controller process
969 struct GNUNET_TESTBED_ControllerProc
974 struct GNUNET_HELPER_Handle *helper;
977 * The host where the helper is run
979 struct GNUNET_TESTBED_Host *host;
982 * The controller error callback
984 GNUNET_TESTBED_ControllerStatusCallback cb;
987 * The closure for the above callback
992 * The send handle for the helper
994 struct GNUNET_HELPER_SendHandle *shandle;
997 * The message corresponding to send handle
999 struct GNUNET_MessageHeader *msg;
1002 * The port number for ssh; used for helpers starting ssh
1007 * The ssh destination string; used for helpers starting ssh
1012 * The configuration of the running testbed service
1014 struct GNUNET_CONFIGURATION_Handle *cfg;
1020 * Functions with this signature are called whenever a
1021 * complete message is received by the tokenizer.
1023 * Do not call GNUNET_SERVER_mst_destroy in callback
1025 * @param cls closure
1026 * @param client identification of the client
1027 * @param message the actual message
1029 * @return GNUNET_OK on success, GNUNET_SYSERR to stop further processing
1032 helper_mst (void *cls, void *client, const struct GNUNET_MessageHeader *message)
1034 struct GNUNET_TESTBED_ControllerProc *cp = cls;
1035 const struct GNUNET_TESTBED_HelperReply *msg;
1036 const char *hostname;
1039 uLongf xconfig_size;
1041 msg = (const struct GNUNET_TESTBED_HelperReply *) message;
1042 GNUNET_assert (sizeof (struct GNUNET_TESTBED_HelperReply) <
1043 ntohs (msg->header.size));
1044 GNUNET_assert (GNUNET_MESSAGE_TYPE_TESTBED_HELPER_REPLY ==
1045 ntohs (msg->header.type));
1046 config_size = (uLongf) ntohs (msg->config_size);
1048 (uLongf) (ntohs (msg->header.size) -
1049 sizeof (struct GNUNET_TESTBED_HelperReply));
1050 config = GNUNET_malloc (config_size);
1051 GNUNET_assert (Z_OK ==
1052 uncompress ((Bytef *) config, &config_size,
1053 (const Bytef *) &msg[1], xconfig_size));
1054 GNUNET_assert (NULL == cp->cfg);
1055 cp->cfg = GNUNET_CONFIGURATION_create ();
1056 GNUNET_assert (GNUNET_CONFIGURATION_deserialize
1057 (cp->cfg, config, config_size, GNUNET_NO));
1058 GNUNET_free (config);
1059 if ((NULL == cp->host) ||
1060 (NULL == (hostname = GNUNET_TESTBED_host_get_hostname_ (cp->host))))
1061 hostname = "localhost";
1062 /* Change the hostname so that we can connect to it */
1063 GNUNET_CONFIGURATION_set_value_string (cp->cfg, "testbed", "hostname",
1065 cp->cb (cp->cls, cp->cfg, GNUNET_OK);
1071 * Continuation function from GNUNET_HELPER_send()
1073 * @param cls closure
1074 * @param result GNUNET_OK on success,
1075 * GNUNET_NO if helper process died
1076 * GNUNET_SYSERR during GNUNET_HELPER_stop
1079 clear_msg (void *cls, int result)
1081 struct GNUNET_TESTBED_ControllerProc *cp = cls;
1083 GNUNET_assert (NULL != cp->shandle);
1085 GNUNET_free (cp->msg);
1090 * Callback that will be called when the helper process dies. This is not called
1091 * when the helper process is stoped using GNUNET_HELPER_stop()
1093 * @param cls the closure from GNUNET_HELPER_start()
1096 helper_exp_cb (void *cls)
1098 struct GNUNET_TESTBED_ControllerProc *cp = cls;
1099 GNUNET_TESTBED_ControllerStatusCallback cb;
1105 GNUNET_TESTBED_controller_stop (cp);
1107 cb (cb_cls, NULL, GNUNET_SYSERR);
1112 * Function to call to start a link-controllers type operation once all queues
1113 * the operation is part of declare that the operation can be activated.
1115 * @param cls the closure from GNUNET_TESTBED_operation_create_()
1118 opstart_link_controllers (void *cls)
1120 struct OperationContext *opc = cls;
1121 struct GNUNET_TESTBED_ControllerLinkMessage *msg;
1123 GNUNET_assert (NULL != opc->data);
1126 opc->state = OPC_STATE_STARTED;
1127 GNUNET_CONTAINER_DLL_insert_tail (opc->c->ocq_head, opc->c->ocq_tail, opc);
1128 GNUNET_TESTBED_queue_message_ (opc->c, &msg->header);
1133 * Callback which will be called when link-controllers type operation is released
1135 * @param cls the closure from GNUNET_TESTBED_operation_create_()
1138 oprelease_link_controllers (void *cls)
1140 struct OperationContext *opc = cls;
1142 if (OPC_STATE_INIT == opc->state)
1143 GNUNET_free (opc->data);
1144 if (OPC_STATE_STARTED == opc->state)
1145 GNUNET_CONTAINER_DLL_remove (opc->c->ocq_head, opc->c->ocq_tail, opc);
1151 * Starts a controller process at the host. FIXME: add controller start callback
1152 * with the configuration with which the controller is started
1154 * @param controller_ip the ip address of the controller. Will be set as TRUSTED
1155 * host when starting testbed controller at host
1156 * @param host the host where the controller has to be started; NULL for
1158 * @param cfg template configuration to use for the remote controller; the
1159 * remote controller will be started with a slightly modified
1160 * configuration (port numbers, unix domain sockets and service home
1161 * values are changed as per TESTING library on the remote host)
1162 * @param cb function called when the controller is successfully started or
1163 * dies unexpectedly; GNUNET_TESTBED_controller_stop shouldn't be
1164 * called if cb is called with GNUNET_SYSERR as status. Will never be
1165 * called in the same task as 'GNUNET_TESTBED_controller_start'
1166 * (synchronous errors will be signalled by returning NULL). This
1167 * parameter cannot be NULL.
1168 * @param cls closure for above callbacks
1169 * @return the controller process handle, NULL on errors
1171 struct GNUNET_TESTBED_ControllerProc *
1172 GNUNET_TESTBED_controller_start (const char *controller_ip,
1173 struct GNUNET_TESTBED_Host *host,
1174 const struct GNUNET_CONFIGURATION_Handle *cfg,
1175 GNUNET_TESTBED_ControllerStatusCallback cb,
1178 struct GNUNET_TESTBED_ControllerProc *cp;
1179 struct GNUNET_TESTBED_HelperInit *msg;
1181 cp = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_ControllerProc));
1182 if ((NULL == host) || (0 == GNUNET_TESTBED_host_get_id_ (host)))
1184 char *const binary_argv[] = {
1185 HELPER_TESTBED_BINARY, NULL
1189 GNUNET_HELPER_start (GNUNET_YES, HELPER_TESTBED_BINARY, binary_argv,
1190 &helper_mst, &helper_exp_cb, cp);
1194 char *remote_args[8];
1196 const char *username;
1197 const char *hostname;
1199 username = GNUNET_TESTBED_host_get_username_ (host);
1200 hostname = GNUNET_TESTBED_host_get_hostname_ (host);
1201 GNUNET_asprintf (&cp->port, "%u", GNUNET_TESTBED_host_get_ssh_port_ (host));
1202 if (NULL == username)
1203 GNUNET_asprintf (&cp->dst, "%s", hostname);
1205 GNUNET_asprintf (&cp->dst, "%s@%s", username, hostname);
1206 LOG_DEBUG ("Starting SSH to destination %s\n", cp->dst);
1208 remote_args[argp++] = "ssh";
1209 remote_args[argp++] = "-p";
1210 remote_args[argp++] = cp->port;
1211 remote_args[argp++] = "-o";
1212 remote_args[argp++] = "BatchMode=yes";
1213 remote_args[argp++] = cp->dst;
1214 remote_args[argp++] = HELPER_TESTBED_BINARY;
1215 remote_args[argp++] = NULL;
1216 GNUNET_assert (argp == 8);
1218 GNUNET_HELPER_start (GNUNET_NO, "ssh", remote_args, &helper_mst,
1219 &helper_exp_cb, cp);
1221 if (NULL == cp->helper)
1223 GNUNET_free_non_null (cp->port);
1224 GNUNET_free_non_null (cp->dst);
1231 msg = GNUNET_TESTBED_create_helper_init_msg_ (controller_ip, cfg);
1232 cp->msg = &msg->header;
1234 GNUNET_HELPER_send (cp->helper, &msg->header, GNUNET_NO, &clear_msg, cp);
1235 if (NULL == cp->shandle)
1238 GNUNET_TESTBED_controller_stop (cp);
1246 * Stop the controller process (also will terminate all peers and controllers
1247 * dependent on this controller). This function blocks until the testbed has
1248 * been fully terminated (!).
1250 * @param cproc the controller process handle
1253 GNUNET_TESTBED_controller_stop (struct GNUNET_TESTBED_ControllerProc *cproc)
1255 if (NULL != cproc->shandle)
1256 GNUNET_HELPER_send_cancel (cproc->shandle);
1257 if (NULL != cproc->helper)
1258 GNUNET_HELPER_stop (cproc->helper);
1259 if (NULL != cproc->cfg)
1260 GNUNET_CONFIGURATION_destroy (cproc->cfg);
1261 GNUNET_free_non_null (cproc->port);
1262 GNUNET_free_non_null (cproc->dst);
1263 GNUNET_free (cproc);
1268 * Start a controller process using the given configuration at the
1271 * @param cfg configuration to use
1272 * @param host host to run the controller on; This should be the same host if
1273 * the controller was previously started with
1274 * GNUNET_TESTBED_controller_start; NULL for localhost
1275 * @param event_mask bit mask with set of events to call 'cc' for;
1276 * or-ed values of "1LL" shifted by the
1277 * respective 'enum GNUNET_TESTBED_EventType'
1278 * (i.e. "(1LL << GNUNET_TESTBED_ET_CONNECT) | ...")
1279 * @param cc controller callback to invoke on events
1280 * @param cc_cls closure for cc
1281 * @return handle to the controller
1283 struct GNUNET_TESTBED_Controller *
1284 GNUNET_TESTBED_controller_connect (const struct GNUNET_CONFIGURATION_Handle
1285 *cfg, struct GNUNET_TESTBED_Host *host,
1286 uint64_t event_mask,
1287 GNUNET_TESTBED_ControllerCallback cc,
1290 struct GNUNET_TESTBED_Controller *controller;
1291 struct GNUNET_TESTBED_InitMessage *msg;
1292 const char *controller_hostname;
1293 unsigned long long max_parallel_operations;
1294 unsigned long long max_parallel_service_connections;
1297 GNUNET_CONFIGURATION_get_value_number (cfg, "testbed",
1298 "MAX_PARALLEL_OPERATIONS",
1299 &max_parallel_operations))
1305 GNUNET_CONFIGURATION_get_value_number (cfg, "testbed",
1306 "MAX_PARALLEL_SERVICE_CONNECTIONS",
1307 &max_parallel_service_connections))
1312 controller = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_Controller));
1313 controller->cc = cc;
1314 controller->cc_cls = cc_cls;
1315 controller->event_mask = event_mask;
1316 controller->cfg = GNUNET_CONFIGURATION_dup (cfg);
1317 controller->client = GNUNET_CLIENT_connect ("testbed", controller->cfg);
1318 if (NULL == controller->client)
1320 GNUNET_TESTBED_controller_disconnect (controller);
1325 host = GNUNET_TESTBED_host_create_by_id_ (0);
1326 if (NULL == host) /* If the above host create fails */
1328 LOG (GNUNET_ERROR_TYPE_WARNING,
1329 "Treating NULL host as localhost. Multiple references to localhost "
1330 "may break when localhost freed before calling disconnect \n");
1331 host = GNUNET_TESTBED_host_lookup_by_id_ (0);
1335 controller->aux_host = GNUNET_YES;
1338 GNUNET_assert (NULL != host);
1339 GNUNET_TESTBED_mark_host_registered_at_ (host, controller);
1340 controller->host = host;
1341 controller->opq_parallel_operations =
1342 GNUNET_TESTBED_operation_queue_create_ ((unsigned int)
1343 max_parallel_operations);
1344 controller->opq_parallel_service_connections =
1345 GNUNET_TESTBED_operation_queue_create_ ((unsigned int)
1346 max_parallel_service_connections);
1347 controller_hostname = GNUNET_TESTBED_host_get_hostname_ (host);
1348 if (NULL == controller_hostname)
1349 controller_hostname = "127.0.0.1";
1351 GNUNET_malloc (sizeof (struct GNUNET_TESTBED_InitMessage) +
1352 strlen (controller_hostname) + 1);
1353 msg->header.type = htons (GNUNET_MESSAGE_TYPE_TESTBED_INIT);
1355 htons (sizeof (struct GNUNET_TESTBED_InitMessage) +
1356 strlen (controller_hostname) + 1);
1357 msg->host_id = htonl (GNUNET_TESTBED_host_get_id_ (host));
1358 msg->event_mask = GNUNET_htonll (controller->event_mask);
1359 strcpy ((char *) &msg[1], controller_hostname);
1360 GNUNET_TESTBED_queue_message_ (controller,
1361 (struct GNUNET_MessageHeader *) msg);
1367 * Configure shared services at a controller. Using this function,
1368 * you can specify that certain services (such as "resolver")
1369 * should not be run for each peer but instead be shared
1370 * across N peers on the specified host. This function
1371 * must be called before any peers are created at the host.
1373 * @param controller controller to configure
1374 * @param service_name name of the service to share
1375 * @param num_peers number of peers that should share one instance
1376 * of the specified service (1 for no sharing is the default),
1377 * use 0 to disable the service
1380 GNUNET_TESTBED_controller_configure_sharing (struct GNUNET_TESTBED_Controller
1382 const char *service_name,
1385 struct GNUNET_TESTBED_ConfigureSharedServiceMessage *msg;
1386 uint16_t service_name_size;
1389 service_name_size = strlen (service_name) + 1;
1391 sizeof (struct GNUNET_TESTBED_ConfigureSharedServiceMessage) +
1393 msg = GNUNET_malloc (msg_size);
1394 msg->header.size = htons (msg_size);
1395 msg->header.type = htons (GNUNET_MESSAGE_TYPE_TESTBED_SERVICESHARE);
1396 msg->host_id = htonl (GNUNET_TESTBED_host_get_id_ (controller->host));
1397 msg->num_peers = htonl (num_peers);
1398 memcpy (&msg[1], service_name, service_name_size);
1399 GNUNET_TESTBED_queue_message_ (controller,
1400 (struct GNUNET_MessageHeader *) msg);
1405 * disconnects from the controller.
1407 * @param controller handle to controller to stop
1410 GNUNET_TESTBED_controller_disconnect (struct GNUNET_TESTBED_Controller
1413 struct MessageQueue *mq_entry;
1415 if (NULL != controller->th)
1416 GNUNET_CLIENT_notify_transmit_ready_cancel (controller->th);
1417 /* Clear the message queue */
1418 while (NULL != (mq_entry = controller->mq_head))
1420 GNUNET_CONTAINER_DLL_remove (controller->mq_head, controller->mq_tail,
1422 GNUNET_free (mq_entry->msg);
1423 GNUNET_free (mq_entry);
1425 if (NULL != controller->client)
1426 GNUNET_CLIENT_disconnect (controller->client);
1427 GNUNET_CONFIGURATION_destroy (controller->cfg);
1428 if (GNUNET_YES == controller->aux_host)
1429 GNUNET_TESTBED_host_destroy (controller->host);
1430 GNUNET_TESTBED_operation_queue_destroy_ (controller->opq_parallel_operations);
1431 GNUNET_TESTBED_operation_queue_destroy_
1432 (controller->opq_parallel_service_connections);
1433 GNUNET_free (controller);
1438 * Register a host with the controller
1440 * @param controller the controller handle
1441 * @param host the host to register
1442 * @param cc the completion callback to call to inform the status of
1443 * registration. After calling this callback the registration handle
1444 * will be invalid. Cannot be NULL.
1445 * @param cc_cls the closure for the cc
1446 * @return handle to the host registration which can be used to cancel the
1449 struct GNUNET_TESTBED_HostRegistrationHandle *
1450 GNUNET_TESTBED_register_host (struct GNUNET_TESTBED_Controller *controller,
1451 struct GNUNET_TESTBED_Host *host,
1452 GNUNET_TESTBED_HostRegistrationCompletion cc,
1455 struct GNUNET_TESTBED_HostRegistrationHandle *rh;
1456 struct GNUNET_TESTBED_AddHostMessage *msg;
1457 const char *username;
1458 const char *hostname;
1460 uint16_t user_name_length;
1462 if (NULL != controller->rh)
1464 hostname = GNUNET_TESTBED_host_get_hostname_ (host);
1465 if (GNUNET_YES == GNUNET_TESTBED_is_host_registered_ (host, controller))
1467 LOG (GNUNET_ERROR_TYPE_WARNING, "Host hostname: %s already registered\n",
1468 (NULL == hostname) ? "localhost" : hostname);
1471 rh = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_HostRegistrationHandle));
1474 GNUNET_assert (NULL != cc);
1476 rh->cc_cls = cc_cls;
1477 controller->rh = rh;
1478 username = GNUNET_TESTBED_host_get_username_ (host);
1479 msg_size = (sizeof (struct GNUNET_TESTBED_AddHostMessage));
1480 user_name_length = 0;
1481 if (NULL != username)
1483 user_name_length = strlen (username) + 1;
1484 msg_size += user_name_length;
1486 /* FIXME: what happens when hostname is NULL? localhost */
1487 GNUNET_assert (NULL != hostname);
1488 msg_size += strlen (hostname) + 1;
1489 msg = GNUNET_malloc (msg_size);
1490 msg->header.size = htons (msg_size);
1491 msg->header.type = htons (GNUNET_MESSAGE_TYPE_TESTBED_ADDHOST);
1492 msg->host_id = htonl (GNUNET_TESTBED_host_get_id_ (host));
1493 msg->ssh_port = htons (GNUNET_TESTBED_host_get_ssh_port_ (host));
1494 msg->user_name_length = htons (user_name_length);
1495 if (NULL != username)
1496 memcpy (&msg[1], username, user_name_length);
1497 strcpy (((void *) &msg[1]) + user_name_length, hostname);
1498 GNUNET_TESTBED_queue_message_ (controller,
1499 (struct GNUNET_MessageHeader *) msg);
1505 * Cancel the pending registration. Note that if the registration message is
1506 * already sent to the service the cancellation has only the effect that the
1507 * registration completion callback for the registration is never called.
1509 * @param handle the registration handle to cancel
1512 GNUNET_TESTBED_cancel_registration (struct GNUNET_TESTBED_HostRegistrationHandle
1515 if (handle != handle->c->rh)
1520 handle->c->rh = NULL;
1521 GNUNET_free (handle);
1526 * Same as the GNUNET_TESTBED_controller_link, however expects configuration in
1527 * serialized and compressed
1529 * @param master handle to the master controller who creates the association
1530 * @param delegated_host requests to which host should be delegated; cannot be NULL
1531 * @param slave_host which host is used to run the slave controller; use NULL to
1532 * make the master controller connect to the delegated host
1533 * @param sxcfg serialized and compressed configuration
1534 * @param sxcfg_size the size scfg
1535 * @param scfg_size the size of uncompressed serialized configuration
1536 * @param is_subordinate GNUNET_YES if the controller at delegated_host should
1537 * be started by the master controller; GNUNET_NO if we are just
1538 * allowed to use the slave via TCP/IP
1540 struct GNUNET_TESTBED_Operation *
1541 GNUNET_TESTBED_controller_link_2 (struct GNUNET_TESTBED_Controller *master,
1542 struct GNUNET_TESTBED_Host *delegated_host,
1543 struct GNUNET_TESTBED_Host *slave_host,
1544 const char *sxcfg, size_t sxcfg_size,
1545 size_t scfg_size, int is_subordinate)
1547 struct OperationContext *opc;
1548 struct GNUNET_TESTBED_ControllerLinkMessage *msg;
1551 GNUNET_assert (GNUNET_YES ==
1552 GNUNET_TESTBED_is_host_registered_ (delegated_host, master));
1553 if ((NULL != slave_host) && (0 != GNUNET_TESTBED_host_get_id_ (slave_host)))
1554 GNUNET_assert (GNUNET_YES ==
1555 GNUNET_TESTBED_is_host_registered_ (slave_host, master));
1556 msg_size = sxcfg_size + sizeof (struct GNUNET_TESTBED_ControllerLinkMessage);
1557 msg = GNUNET_malloc (msg_size);
1558 msg->header.type = htons (GNUNET_MESSAGE_TYPE_TESTBED_LCONTROLLERS);
1559 msg->header.size = htons (msg_size);
1560 msg->delegated_host_id = htonl (GNUNET_TESTBED_host_get_id_ (delegated_host));
1561 msg->slave_host_id =
1562 htonl (GNUNET_TESTBED_host_get_id_
1563 ((NULL != slave_host) ? slave_host : master->host));
1564 msg->config_size = htons ((uint16_t) scfg_size);
1565 msg->is_subordinate = (GNUNET_YES == is_subordinate) ? 1 : 0;
1566 memcpy (&msg[1], sxcfg, sxcfg_size);
1567 opc = GNUNET_malloc (sizeof (struct OperationContext));
1570 opc->type = OP_LINK_CONTROLLERS;
1571 opc->id = master->operation_counter++;
1572 opc->state = OPC_STATE_INIT;
1573 msg->operation_id = GNUNET_htonll (opc->id);
1575 GNUNET_TESTBED_operation_create_ (opc, &opstart_link_controllers,
1576 &oprelease_link_controllers);
1577 GNUNET_TESTBED_operation_queue_insert_ (master->opq_parallel_operations,
1584 * Compresses given configuration using zlib compress
1586 * @param config the serialized configuration
1587 * @param size the size of config
1588 * @param xconfig will be set to the compressed configuration (memory is fresly
1590 * @return the size of the xconfig
1593 GNUNET_TESTBED_compress_config_ (const char *config, size_t size,
1598 xsize = compressBound ((uLong) size);
1599 *xconfig = GNUNET_malloc (xsize);
1600 GNUNET_assert (Z_OK ==
1601 compress2 ((Bytef *) * xconfig, (uLongf *) & xsize,
1602 (const Bytef *) config, (uLongf) size,
1609 * Create a link from slave controller to delegated controller. Whenever the
1610 * master controller is asked to start a peer at the delegated controller the
1611 * request will be routed towards slave controller (if a route exists). The
1612 * slave controller will then route it to the delegated controller. The
1613 * configuration of the slave controller is given and to be used to either
1614 * create the slave controller or to connect to an existing slave controller
1615 * process. 'is_subordinate' specifies if the given slave controller should be
1616 * started and managed by the master controller, or if the slave already has a
1617 * master and this is just a secondary master that is also allowed to use the
1620 * @param master handle to the master controller who creates the association
1621 * @param delegated_host requests to which host should be delegated
1622 * @param slave_host which host is used to run the slave controller
1623 * @param slave_cfg configuration to use for the slave controller
1624 * @param is_subordinate GNUNET_YES if the slave should be started (and stopped)
1625 * by the master controller; GNUNET_NO if we are just
1626 * allowed to use the slave via TCP/IP
1627 * @return the operation handle
1629 struct GNUNET_TESTBED_Operation *
1630 GNUNET_TESTBED_controller_link (struct GNUNET_TESTBED_Controller *master,
1631 struct GNUNET_TESTBED_Host *delegated_host,
1632 struct GNUNET_TESTBED_Host *slave_host,
1633 const struct GNUNET_CONFIGURATION_Handle
1634 *slave_cfg, int is_subordinate)
1636 struct GNUNET_TESTBED_Operation *op;
1642 GNUNET_assert (GNUNET_YES ==
1643 GNUNET_TESTBED_is_host_registered_ (delegated_host, master));
1644 if ((NULL != slave_host) && (0 != GNUNET_TESTBED_host_get_id_ (slave_host)))
1645 GNUNET_assert (GNUNET_YES ==
1646 GNUNET_TESTBED_is_host_registered_ (slave_host, master));
1647 config = GNUNET_CONFIGURATION_serialize (slave_cfg, &config_size);
1648 cc_size = GNUNET_TESTBED_compress_config_ (config, config_size, &cconfig);
1649 GNUNET_free (config);
1650 GNUNET_assert ((UINT16_MAX - sizeof (struct GNUNET_TESTBED_ControllerLinkMessage)) >= cc_size); /* Configuration doesn't fit in 1 message */
1651 op = GNUNET_TESTBED_controller_link_2 (master, delegated_host, slave_host,
1652 (const char *) cconfig, cc_size,
1653 config_size, is_subordinate);
1654 GNUNET_free (cconfig);
1660 * Ask the testbed controller to write the current overlay topology to
1661 * a file. Naturally, the file will only contain a snapshot as the
1662 * topology may evolve all the time.
1664 * @param controller overlay controller to inspect
1665 * @param filename name of the file the topology should
1669 GNUNET_TESTBED_overlay_write_topology_to_file (struct GNUNET_TESTBED_Controller
1671 const char *filename)
1678 * Creates a helper initialization message. This function is here because we
1679 * want to use this in testing
1681 * @param cname the ip address of the controlling host
1682 * @param cfg the configuration that has to used to start the testbed service
1684 * @return the initialization message
1686 struct GNUNET_TESTBED_HelperInit *
1687 GNUNET_TESTBED_create_helper_init_msg_ (const char *cname,
1688 const struct GNUNET_CONFIGURATION_Handle
1691 struct GNUNET_TESTBED_HelperInit *msg;
1695 size_t xconfig_size;
1699 config = GNUNET_CONFIGURATION_serialize (cfg, &config_size);
1700 GNUNET_assert (NULL != config);
1702 GNUNET_TESTBED_compress_config_ (config, config_size, &xconfig);
1703 GNUNET_free (config);
1704 cname_len = strlen (cname);
1706 xconfig_size + cname_len + 1 + sizeof (struct GNUNET_TESTBED_HelperInit);
1707 msg = GNUNET_realloc (xconfig, msg_size);
1708 (void) memmove (((void *) &msg[1]) + cname_len + 1, msg, xconfig_size);
1709 msg->header.size = htons (msg_size);
1710 msg->header.type = htons (GNUNET_MESSAGE_TYPE_TESTBED_HELPER_INIT);
1711 msg->cname_size = htons (cname_len);
1712 msg->config_size = htons (config_size);
1713 (void) strcpy ((char *) &msg[1], cname);
1719 * Cancel a pending operation. Releases all resources
1720 * of the operation and will ensure that no event
1721 * is generated for the operation. Does NOT guarantee
1722 * that the operation will be fully undone (or that
1723 * nothing ever happened).
1725 * @param operation operation to cancel
1728 GNUNET_TESTBED_operation_cancel (struct GNUNET_TESTBED_Operation *operation)
1730 GNUNET_TESTBED_operation_done (operation);
1735 * Signal that the information from an operation has been fully
1736 * processed. This function MUST be called for each event
1737 * of type 'operation_finished' to fully remove the operation
1738 * from the operation queue. After calling this function, the
1739 * 'op_result' becomes invalid (!).
1741 * @param operation operation to signal completion for
1744 GNUNET_TESTBED_operation_done (struct GNUNET_TESTBED_Operation *operation)
1746 switch (operation->type)
1748 case OP_PEER_CREATE:
1749 case OP_PEER_DESTROY:
1753 case OP_OVERLAY_CONNECT:
1754 case OP_LINK_CONTROLLERS:
1755 GNUNET_TESTBED_operation_release_ (operation);
1765 * Generates configuration by parsing Peer configuration information reply message
1767 * @param msg the peer configuration information message
1768 * @return handle to the parsed configuration
1770 struct GNUNET_CONFIGURATION_Handle *
1771 GNUNET_TESTBED_get_config_from_peerinfo_msg_ (const struct
1772 GNUNET_TESTBED_PeerConfigurationInformationMessage
1775 struct GNUNET_CONFIGURATION_Handle *cfg;
1781 config_size = (uLong) ntohs (msg->config_size);
1782 config = GNUNET_malloc (config_size);
1783 msize = ntohs (msg->header.size);
1784 msize -= sizeof (struct GNUNET_TESTBED_PeerConfigurationInformationMessage);
1787 uncompress ((Bytef *) config, &config_size, (const Bytef *) &msg[1],
1790 cfg = GNUNET_CONFIGURATION_create ();
1791 GNUNET_assert (GNUNET_OK ==
1792 GNUNET_CONFIGURATION_deserialize (cfg, config,
1793 (size_t) config_size,
1795 GNUNET_free (config);
1801 * Checks the integrity of the OperationFailureEventMessage and if good returns
1802 * the error message it contains.
1804 * @param msg the OperationFailureEventMessage
1805 * @return the error message
1808 GNUNET_TESTBED_parse_error_string_ (const struct
1809 GNUNET_TESTBED_OperationFailureEventMessage
1815 msize = ntohs (msg->header.size);
1816 if (sizeof (struct GNUNET_TESTBED_OperationFailureEventMessage) >= msize)
1818 msize -= sizeof (struct GNUNET_TESTBED_OperationFailureEventMessage);
1819 emsg = (const char *) &msg[1];
1820 if ('\0' != emsg[msize])
1828 /* end of testbed_api.c */