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"
74 #define HELPER_TESTBED_BINARY_SSH ". ~/.bashrc; gnunet-helper-testbed"
78 * The message queue for sending messages to the controller service
83 * The message to be sent
85 struct GNUNET_MessageHeader *msg;
88 * next pointer for DLL
90 struct MessageQueue *next;
93 * prev pointer for DLL
95 struct MessageQueue *prev;
100 * Structure for a controller link
102 struct ControllerLink
105 * The next ptr for DLL
107 struct ControllerLink *next;
110 * The prev ptr for DLL
112 struct ControllerLink *prev;
115 * The host which will be referred in the peer start request. This is the
116 * host where the peer should be started
118 struct GNUNET_TESTBED_Host *delegated_host;
121 * The host which will contacted to delegate the peer start request
123 struct GNUNET_TESTBED_Host *slave_host;
126 * The configuration to be used to connect to slave host
128 const struct GNUNET_CONFIGURATION_Handle *slave_cfg;
131 * GNUNET_YES if the slave should be started (and stopped) by us; GNUNET_NO
132 * if we are just allowed to use the slave via TCP/IP
139 * handle for host registration
141 struct GNUNET_TESTBED_HostRegistrationHandle
144 * The host being registered
146 struct GNUNET_TESTBED_Host *host;
149 * The controller at which this host is being registered
151 struct GNUNET_TESTBED_Controller *c;
154 * The Registartion completion callback
156 GNUNET_TESTBED_HostRegistrationCompletion cc;
159 * The closure for above callback
166 * Context data for forwarded Operation
168 struct ForwardedOperationData
172 * The callback to call when reply is available
174 GNUNET_CLIENT_MessageHandler cc;
177 * The closure for the above callback
185 * Context data for get slave config operations
187 struct GetSlaveConfigData
190 * The operation closure
195 * The id of the slave controller
203 * Returns the operation context with the given id if found in the Operation
204 * context queues of the controller
206 * @param c the controller whose queues are searched
207 * @param id the id which has to be checked
208 * @return the matching operation context; NULL if no match found
210 static struct OperationContext *
211 find_opc (const struct GNUNET_TESTBED_Controller *c, const uint64_t id)
213 struct OperationContext *opc;
215 for (opc = c->ocq_head; NULL != opc; opc = opc->next)
225 * Handler for GNUNET_MESSAGE_TYPE_TESTBED_ADDHOSTCONFIRM message from
226 * controller (testbed service)
228 * @param c the controller handler
229 * @param msg message received
230 * @return GNUNET_YES if we can continue receiving from service; GNUNET_NO if
234 handle_addhostconfirm (struct GNUNET_TESTBED_Controller *c,
235 const struct GNUNET_TESTBED_HostConfirmedMessage *msg)
237 struct GNUNET_TESTBED_HostRegistrationHandle *rh;
246 if (GNUNET_TESTBED_host_get_id_ (rh->host) != ntohl (msg->host_id))
248 LOG_DEBUG ("Mismatch in host id's %u, %u of host confirm msg\n",
249 GNUNET_TESTBED_host_get_id_ (rh->host), ntohl (msg->host_id));
253 msg_size = ntohs (msg->header.size);
254 if (sizeof (struct GNUNET_TESTBED_HostConfirmedMessage) == msg_size)
256 LOG_DEBUG ("Host %u successfully registered\n", ntohl (msg->host_id));
257 GNUNET_TESTBED_mark_host_registered_at_ (rh->host, c);
258 rh->cc (rh->cc_cls, NULL);
262 /* We have an error message */
263 emsg = (char *) &msg[1];
265 emsg[msg_size - sizeof (struct GNUNET_TESTBED_HostConfirmedMessage)])
271 LOG (GNUNET_ERROR_TYPE_ERROR, _("Adding host %u failed with error: %s\n"),
272 ntohl (msg->host_id), emsg);
273 rh->cc (rh->cc_cls, emsg);
280 * Handler for forwarded operations
282 * @param c the controller handle
283 * @param opc the opearation context
284 * @param msg the message
287 handle_forwarded_operation_msg (struct GNUNET_TESTBED_Controller *c,
288 struct OperationContext *opc,
289 const struct GNUNET_MessageHeader *msg)
291 struct ForwardedOperationData *fo_data;
294 if (NULL != fo_data->cc)
295 fo_data->cc (fo_data->cc_cls, msg);
296 GNUNET_CONTAINER_DLL_remove (c->ocq_head, c->ocq_tail, opc);
297 GNUNET_free (fo_data);
303 * Handler for GNUNET_MESSAGE_TYPE_TESTBED_ADDHOSTCONFIRM message from
304 * controller (testbed service)
306 * @param c the controller handler
307 * @param msg message received
308 * @return GNUNET_YES if we can continue receiving from service; GNUNET_NO if
312 handle_opsuccess (struct GNUNET_TESTBED_Controller *c,
314 GNUNET_TESTBED_GenericOperationSuccessEventMessage *msg)
316 struct OperationContext *opc;
317 struct GNUNET_TESTBED_EventInformation event;
320 op_id = GNUNET_ntohll (msg->operation_id);
321 LOG_DEBUG ("Operation %ul successful\n", op_id);
322 if (NULL == (opc = find_opc (c, op_id)))
324 LOG_DEBUG ("Operation not found\n");
331 handle_forwarded_operation_msg
332 (c, opc, (const struct GNUNET_MessageHeader *) msg);
336 case OP_PEER_DESTROY:
338 struct GNUNET_TESTBED_Peer *peer;
346 case OP_LINK_CONTROLLERS:
351 event.type = GNUNET_TESTBED_ET_OPERATION_FINISHED;
352 event.details.operation_finished.operation = opc->op;
353 event.details.operation_finished.op_cls = NULL;
354 event.details.operation_finished.emsg = NULL;
355 event.details.operation_finished.generic = NULL;
356 GNUNET_CONTAINER_DLL_remove (opc->c->ocq_head, opc->c->ocq_tail, opc);
357 opc->state = OPC_STATE_FINISHED;
358 if (0 != (c->event_mask & (1L << GNUNET_TESTBED_ET_OPERATION_FINISHED)))
361 c->cc (c->cc_cls, &event);
368 * Handler for GNUNET_MESSAGE_TYPE_TESTBED_PEERCREATESUCCESS message from
369 * controller (testbed service)
371 * @param c the controller handle
372 * @param msg message received
373 * @return GNUNET_YES if we can continue receiving from service; GNUNET_NO if
377 handle_peer_create_success (struct GNUNET_TESTBED_Controller *c,
379 GNUNET_TESTBED_PeerCreateSuccessEventMessage *msg)
381 struct OperationContext *opc;
382 struct PeerCreateData *data;
383 struct GNUNET_TESTBED_Peer *peer;
384 GNUNET_TESTBED_PeerCreateCallback cb;
388 GNUNET_assert (sizeof (struct GNUNET_TESTBED_PeerCreateSuccessEventMessage) ==
389 ntohs (msg->header.size));
390 op_id = GNUNET_ntohll (msg->operation_id);
391 if (NULL == (opc = find_opc (c, op_id)))
393 LOG_DEBUG ("Operation context for PeerCreateSuccessEvent not found\n");
396 if (OP_FORWARDED == opc->type)
398 handle_forwarded_operation_msg (c, opc,
399 (const struct GNUNET_MessageHeader *) msg);
402 GNUNET_assert (OP_PEER_CREATE == opc->type);
403 GNUNET_assert (NULL != opc->data);
405 GNUNET_assert (NULL != data->peer);
407 GNUNET_assert (peer->unique_id == ntohl (msg->peer_id));
408 peer->state = PS_CREATED;
411 GNUNET_free (opc->data);
412 GNUNET_CONTAINER_DLL_remove (opc->c->ocq_head, opc->c->ocq_tail, opc);
413 opc->state = OPC_STATE_FINISHED;
415 cb (cls, peer, NULL);
421 * Handler for GNUNET_MESSAGE_TYPE_TESTBED_PEEREVENT message from
422 * controller (testbed service)
424 * @param c the controller handler
425 * @param msg message received
426 * @return GNUNET_YES if we can continue receiving from service; GNUNET_NO if
430 handle_peer_event (struct GNUNET_TESTBED_Controller *c,
431 const struct GNUNET_TESTBED_PeerEventMessage *msg)
433 struct OperationContext *opc;
434 struct GNUNET_TESTBED_Peer *peer;
435 struct PeerEventData *data;
436 GNUNET_TESTBED_PeerChurnCallback pcc;
438 struct GNUNET_TESTBED_EventInformation event;
441 GNUNET_assert (sizeof (struct GNUNET_TESTBED_PeerEventMessage) ==
442 ntohs (msg->header.size));
443 op_id = GNUNET_ntohll (msg->operation_id);
444 if (NULL == (opc = find_opc (c, op_id)))
446 LOG_DEBUG ("Operation not found\n");
449 if (OP_FORWARDED == opc->type)
451 handle_forwarded_operation_msg (c, opc,
452 (const struct GNUNET_MessageHeader *) msg);
455 GNUNET_assert ((OP_PEER_START == opc->type) || (OP_PEER_STOP == opc->type));
457 GNUNET_assert (NULL != data);
459 GNUNET_assert (NULL != peer);
460 event.type = (enum GNUNET_TESTBED_EventType) ntohl (msg->event_type);
463 case GNUNET_TESTBED_ET_PEER_START:
464 peer->state = PS_STARTED;
465 event.details.peer_start.host = peer->host;
466 event.details.peer_start.peer = peer;
468 case GNUNET_TESTBED_ET_PEER_STOP:
469 peer->state = PS_STOPPED;
470 event.details.peer_stop.peer = peer;
473 GNUNET_assert (0); /* We should never reach this state */
476 pcc_cls = data->pcc_cls;
478 GNUNET_CONTAINER_DLL_remove (opc->c->ocq_head, opc->c->ocq_tail, opc);
479 opc->state = OPC_STATE_FINISHED;
481 ((GNUNET_TESTBED_ET_PEER_START | GNUNET_TESTBED_ET_PEER_STOP) &
485 c->cc (c->cc_cls, &event);
494 * Handler for GNUNET_MESSAGE_TYPE_TESTBED_PEERCONEVENT message from
495 * controller (testbed service)
497 * @param c the controller handler
498 * @param msg message received
499 * @return GNUNET_YES if we can continue receiving from service; GNUNET_NO if
503 handle_peer_conevent (struct GNUNET_TESTBED_Controller *c,
504 const struct GNUNET_TESTBED_ConnectionEventMessage *msg)
506 struct OperationContext *opc;
507 struct OverlayConnectData *data;
508 GNUNET_TESTBED_OperationCompletionCallback cb;
510 struct GNUNET_TESTBED_EventInformation event;
513 op_id = GNUNET_ntohll (msg->operation_id);
514 if (NULL == (opc = find_opc (c, op_id)))
516 LOG_DEBUG ("Operation not found\n");
519 if (OP_FORWARDED == opc->type)
521 handle_forwarded_operation_msg (c, opc,
522 (const struct GNUNET_MessageHeader *) msg);
525 GNUNET_assert (OP_OVERLAY_CONNECT == opc->type);
527 GNUNET_assert (NULL != data);
528 GNUNET_assert ((ntohl (msg->peer1) == data->p1->unique_id) &&
529 (ntohl (msg->peer2) == data->p2->unique_id));
530 event.type = (enum GNUNET_TESTBED_EventType) ntohl (msg->event_type);
533 case GNUNET_TESTBED_ET_CONNECT:
534 event.details.peer_connect.peer1 = data->p1;
535 event.details.peer_connect.peer2 = data->p2;
537 case GNUNET_TESTBED_ET_DISCONNECT:
538 GNUNET_assert (0); /* FIXME: implement */
541 GNUNET_assert (0); /* Should never reach here */
545 cb_cls = data->cb_cls;
546 GNUNET_CONTAINER_DLL_remove (opc->c->ocq_head, opc->c->ocq_tail, opc);
547 opc->state = OPC_STATE_FINISHED;
550 ((GNUNET_TESTBED_ET_CONNECT | GNUNET_TESTBED_ET_DISCONNECT) &
554 c->cc (c->cc_cls, &event);
557 cb (cb_cls, opc->op, NULL);
563 * Handler for GNUNET_MESSAGE_TYPE_TESTBED_PEERCONFIG message from
564 * controller (testbed service)
566 * @param c the controller handler
567 * @param msg message received
568 * @return GNUNET_YES if we can continue receiving from service; GNUNET_NO if
572 handle_peer_config (struct GNUNET_TESTBED_Controller *c,
574 GNUNET_TESTBED_PeerConfigurationInformationMessage *msg)
576 struct OperationContext *opc;
577 struct GNUNET_TESTBED_Peer *peer;
578 struct PeerInfoData *data;
579 struct GNUNET_TESTBED_PeerInformation *pinfo;
580 GNUNET_TESTBED_PeerInfoCallback cb;
584 op_id = GNUNET_ntohll (msg->operation_id);
585 if (NULL == (opc = find_opc (c, op_id)))
587 LOG_DEBUG ("Operation not found\n");
590 if (OP_FORWARDED == opc->type)
592 handle_forwarded_operation_msg (c, opc,
593 (const struct GNUNET_MessageHeader *) msg);
597 GNUNET_assert (NULL != data);
599 GNUNET_assert (NULL != peer);
600 GNUNET_assert (ntohl (msg->peer_id) == peer->unique_id);
601 pinfo = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_PeerInformation));
602 pinfo->pit = data->pit;
604 cb_cls = data->cb_cls;
609 case GNUNET_TESTBED_PIT_IDENTITY:
610 pinfo->result.id = GNUNET_malloc (sizeof (struct GNUNET_PeerIdentity));
611 (void) memcpy (pinfo->result.id, &msg->peer_identity,
612 sizeof (struct GNUNET_PeerIdentity));
614 case GNUNET_TESTBED_PIT_CONFIGURATION:
615 pinfo->result.cfg = /* Freed in oprelease_peer_getinfo */
616 GNUNET_TESTBED_extract_config_ (&msg->header);
618 case GNUNET_TESTBED_PIT_GENERIC:
619 GNUNET_assert (0); /* never reach here */
623 GNUNET_CONTAINER_DLL_remove (opc->c->ocq_head, opc->c->ocq_tail, opc);
624 opc->state = OPC_STATE_FINISHED;
626 cb (cb_cls, opc->op, pinfo, NULL);
632 * Handler for GNUNET_MESSAGE_TYPE_TESTBED_OPERATIONFAILEVENT message from
633 * controller (testbed service)
635 * @param c the controller handler
636 * @param msg message received
637 * @return GNUNET_YES if we can continue receiving from service; GNUNET_NO if
641 handle_op_fail_event (struct GNUNET_TESTBED_Controller *c,
642 const struct GNUNET_TESTBED_OperationFailureEventMessage
645 struct OperationContext *opc;
648 struct GNUNET_TESTBED_EventInformation event;
650 op_id = GNUNET_ntohll (msg->operation_id);
651 if (NULL == (opc = find_opc (c, op_id)))
653 LOG_DEBUG ("Operation not found\n");
656 GNUNET_CONTAINER_DLL_remove (opc->c->ocq_head, opc->c->ocq_tail, opc);
657 if (OP_FORWARDED == opc->type)
659 handle_forwarded_operation_msg (c, opc,
660 (const struct GNUNET_MessageHeader *) msg);
663 opc->state = OPC_STATE_FINISHED;
664 emsg = GNUNET_TESTBED_parse_error_string_ (msg);
666 emsg = "Unknown error";
667 if (OP_PEER_INFO == opc->type)
669 struct PeerInfoData *data;
671 if (NULL != data->cb)
672 data->cb (data->cb_cls, opc->op, NULL, emsg);
674 return GNUNET_YES; /* We do not call controller callback for peer info */
676 if ((0 != (GNUNET_TESTBED_ET_OPERATION_FINISHED & c->event_mask)) &&
679 event.type = GNUNET_TESTBED_ET_OPERATION_FINISHED;
680 event.details.operation_finished.operation = opc->op;
681 event.details.operation_finished.op_cls = NULL;
682 event.details.operation_finished.emsg = emsg;
683 event.details.operation_finished.generic = NULL;
684 c->cc (c->cc_cls, &event);
690 struct PeerCreateData *data;
692 GNUNET_free (data->peer);
693 if (NULL != data->cb)
694 data->cb (data->cls, NULL, emsg);
701 struct PeerEventData *data;
703 if (NULL != data->pcc)
704 data->pcc (data->pcc_cls, emsg);
708 case OP_PEER_DESTROY:
712 case OP_OVERLAY_CONNECT:
714 struct OverlayConnectData *data;
716 if (NULL != data->cb)
717 data->cb (data->cb_cls, opc->op, emsg);
723 case OP_LINK_CONTROLLERS: /* No secondary callback */
733 * Handler for GNUNET_MESSAGE_TYPE_TESTBED_SLAVECONFIG message from controller
736 * @param c the controller handler
737 * @param msg message received
738 * @return GNUNET_YES if we can continue receiving from service; GNUNET_NO if
742 handle_slave_config (struct GNUNET_TESTBED_Controller *c,
743 const struct GNUNET_TESTBED_SlaveConfiguration * msg)
745 struct OperationContext *opc;
748 struct GNUNET_TESTBED_EventInformation event;
750 op_id = GNUNET_ntohll (msg->operation_id);
751 if (NULL == (opc = find_opc (c, op_id)))
753 LOG_DEBUG ("Operation not found\n");
756 if (OP_GET_SLAVE_CONFIG != opc->type)
761 op_cls = ((struct GetSlaveConfigData *) opc->data)->op_cls;
762 GNUNET_free (opc->data);
764 opc->state = OPC_STATE_FINISHED;
765 GNUNET_CONTAINER_DLL_remove (opc->c->ocq_head, opc->c->ocq_tail, opc);
766 if ((0 != (GNUNET_TESTBED_ET_OPERATION_FINISHED & c->event_mask)) &&
769 opc->data = GNUNET_TESTBED_extract_config_ (&msg->header);
770 event.type = GNUNET_TESTBED_ET_OPERATION_FINISHED;
771 event.details.operation_finished.generic = opc->data;
772 event.details.operation_finished.operation = opc->op;
773 event.details.operation_finished.op_cls = op_cls;
774 event.details.operation_finished.emsg = NULL;
775 c->cc (c->cc_cls, &event);
782 * Handler for messages from controller (testbed service)
784 * @param cls the controller handler
785 * @param msg message received, NULL on timeout or fatal error
788 message_handler (void *cls, const struct GNUNET_MessageHeader *msg)
790 struct GNUNET_TESTBED_Controller *c = cls;
794 c->in_receive = GNUNET_NO;
795 /* FIXME: Add checks for message integrity */
798 LOG_DEBUG ("Receive timed out or connection to service dropped\n");
802 msize = ntohs (msg->size);
803 switch (ntohs (msg->type))
805 case GNUNET_MESSAGE_TYPE_TESTBED_ADDHOSTCONFIRM:
806 GNUNET_assert (msize >=
807 sizeof (struct GNUNET_TESTBED_HostConfirmedMessage));
809 handle_addhostconfirm (c,
810 (const struct GNUNET_TESTBED_HostConfirmedMessage
813 case GNUNET_MESSAGE_TYPE_TESTBED_GENERICOPSUCCESS:
814 GNUNET_assert (msize ==
816 GNUNET_TESTBED_GenericOperationSuccessEventMessage));
820 GNUNET_TESTBED_GenericOperationSuccessEventMessage *)
823 case GNUNET_MESSAGE_TYPE_TESTBED_PEERCREATESUCCESS:
824 GNUNET_assert (msize ==
826 GNUNET_TESTBED_PeerCreateSuccessEventMessage));
828 handle_peer_create_success (c,
830 GNUNET_TESTBED_PeerCreateSuccessEventMessage
833 case GNUNET_MESSAGE_TYPE_TESTBED_PEEREVENT:
834 GNUNET_assert (msize == sizeof (struct GNUNET_TESTBED_PeerEventMessage));
836 handle_peer_event (c,
837 (const struct GNUNET_TESTBED_PeerEventMessage *)
841 case GNUNET_MESSAGE_TYPE_TESTBED_PEERCONFIG:
842 GNUNET_assert (msize >=
844 GNUNET_TESTBED_PeerConfigurationInformationMessage));
846 handle_peer_config (c,
848 GNUNET_TESTBED_PeerConfigurationInformationMessage
851 case GNUNET_MESSAGE_TYPE_TESTBED_PEERCONEVENT:
852 GNUNET_assert (msize ==
853 sizeof (struct GNUNET_TESTBED_ConnectionEventMessage));
855 handle_peer_conevent (c,
857 GNUNET_TESTBED_ConnectionEventMessage *) msg);
859 case GNUNET_MESSAGE_TYPE_TESTBED_OPERATIONFAILEVENT:
860 GNUNET_assert (msize >=
861 sizeof (struct GNUNET_TESTBED_OperationFailureEventMessage));
863 handle_op_fail_event (c,
865 GNUNET_TESTBED_OperationFailureEventMessage *)
868 case GNUNET_MESSAGE_TYPE_TESTBED_SLAVECONFIG:
869 GNUNET_assert (msize >
870 sizeof (struct GNUNET_TESTBED_SlaveConfiguration));
872 handle_slave_config (c, (const struct
873 GNUNET_TESTBED_SlaveConfiguration *) msg);
878 if ((GNUNET_OK == status) && (GNUNET_NO == c->in_receive))
880 c->in_receive = GNUNET_YES;
881 GNUNET_CLIENT_receive (c->client, &message_handler, c,
882 GNUNET_TIME_UNIT_FOREVER_REL);
888 * Function called to notify a client about the connection begin ready to queue
889 * more data. "buf" will be NULL and "size" zero if the connection was closed
890 * for writing in the meantime.
893 * @param size number of bytes available in buf
894 * @param buf where the callee should write the message
895 * @return number of bytes written to buf
898 transmit_ready_notify (void *cls, size_t size, void *buf)
900 struct GNUNET_TESTBED_Controller *c = cls;
901 struct MessageQueue *mq_entry;
904 mq_entry = c->mq_head;
905 GNUNET_assert (NULL != mq_entry);
906 if ((0 == size) && (NULL == buf)) /* Timeout */
908 LOG_DEBUG ("Message sending timed out -- retrying\n");
910 GNUNET_CLIENT_notify_transmit_ready (c->client,
911 ntohs (mq_entry->msg->size),
912 TIMEOUT_REL, GNUNET_YES,
913 &transmit_ready_notify, c);
916 GNUNET_assert (ntohs (mq_entry->msg->size) <= size);
917 size = ntohs (mq_entry->msg->size);
918 memcpy (buf, mq_entry->msg, size);
919 LOG_DEBUG ("Message of type: %u and size: %u sent\n",
920 ntohs (mq_entry->msg->type), size);
921 GNUNET_free (mq_entry->msg);
922 GNUNET_CONTAINER_DLL_remove (c->mq_head, c->mq_tail, mq_entry);
923 GNUNET_free (mq_entry);
924 mq_entry = c->mq_head;
925 if (NULL != mq_entry)
927 GNUNET_CLIENT_notify_transmit_ready (c->client,
928 ntohs (mq_entry->msg->size),
929 TIMEOUT_REL, GNUNET_YES,
930 &transmit_ready_notify, c);
931 if (GNUNET_NO == c->in_receive)
933 c->in_receive = GNUNET_YES;
934 GNUNET_CLIENT_receive (c->client, &message_handler, c,
935 GNUNET_TIME_UNIT_FOREVER_REL);
942 * Queues a message in send queue for sending to the service
944 * @param controller the handle to the controller
945 * @param msg the message to queue
948 GNUNET_TESTBED_queue_message_ (struct GNUNET_TESTBED_Controller *controller,
949 struct GNUNET_MessageHeader *msg)
951 struct MessageQueue *mq_entry;
955 type = ntohs (msg->type);
956 size = ntohs (msg->size);
957 GNUNET_assert ((GNUNET_MESSAGE_TYPE_TESTBED_INIT <= type) &&
958 (GNUNET_MESSAGE_TYPE_TESTBED_MAX > type));
959 mq_entry = GNUNET_malloc (sizeof (struct MessageQueue));
961 LOG (GNUNET_ERROR_TYPE_DEBUG,
962 "Queueing message of type %u, size %u for sending\n", type,
964 GNUNET_CONTAINER_DLL_insert_tail (controller->mq_head, controller->mq_tail,
966 if (NULL == controller->th)
968 GNUNET_CLIENT_notify_transmit_ready (controller->client, size,
969 TIMEOUT_REL, GNUNET_YES,
970 &transmit_ready_notify,
976 * Sends the given message as an operation. The given callback is called when a
977 * reply for the operation is available. Call
978 * GNUNET_TESTBED_forward_operation_msg_cancel_() to cleanup the returned
979 * operation context if the cc hasn't been called
981 * @param controller the controller to which the message has to be sent
982 * @param operation_id the operation id of the message
983 * @param msg the message to send
984 * @param cc the callback to call when reply is available
985 * @param cc_cls the closure for the above callback
986 * @return the operation context which can be used to cancel the forwarded
989 struct OperationContext *
990 GNUNET_TESTBED_forward_operation_msg_ (struct GNUNET_TESTBED_Controller
991 *controller, uint64_t operation_id,
992 const struct GNUNET_MessageHeader *msg,
993 GNUNET_CLIENT_MessageHandler cc,
996 struct OperationContext *opc;
997 struct ForwardedOperationData *data;
998 struct GNUNET_MessageHeader *dup_msg;
1001 data = GNUNET_malloc (sizeof (struct ForwardedOperationData));
1003 data->cc_cls = cc_cls;
1004 opc = GNUNET_malloc (sizeof (struct OperationContext));
1005 opc->c = controller;
1006 opc->type = OP_FORWARDED;
1008 opc->id = operation_id;
1009 msize = ntohs (msg->size);
1010 dup_msg = GNUNET_malloc (msize);
1011 (void) memcpy (dup_msg, msg, msize);
1012 GNUNET_TESTBED_queue_message_ (opc->c, dup_msg);
1013 GNUNET_CONTAINER_DLL_insert_tail (controller->ocq_head, controller->ocq_tail,
1020 * Function to cancel an operation created by simply forwarding an operation
1023 * @param opc the operation context from GNUNET_TESTBED_forward_operation_msg_()
1026 GNUNET_TESTBED_forward_operation_msg_cancel_ (struct OperationContext *opc)
1028 GNUNET_CONTAINER_DLL_remove (opc->c->ocq_head, opc->c->ocq_tail, opc);
1029 GNUNET_free (opc->data);
1035 * Handle for controller process
1037 struct GNUNET_TESTBED_ControllerProc
1040 * The process handle
1042 struct GNUNET_HELPER_Handle *helper;
1045 * The host where the helper is run
1047 struct GNUNET_TESTBED_Host *host;
1050 * The controller error callback
1052 GNUNET_TESTBED_ControllerStatusCallback cb;
1055 * The closure for the above callback
1060 * The send handle for the helper
1062 struct GNUNET_HELPER_SendHandle *shandle;
1065 * The message corresponding to send handle
1067 struct GNUNET_MessageHeader *msg;
1070 * The port number for ssh; used for helpers starting ssh
1075 * The ssh destination string; used for helpers starting ssh
1080 * The configuration of the running testbed service
1082 struct GNUNET_CONFIGURATION_Handle *cfg;
1088 * Functions with this signature are called whenever a
1089 * complete message is received by the tokenizer.
1091 * Do not call GNUNET_SERVER_mst_destroy in callback
1093 * @param cls closure
1094 * @param client identification of the client
1095 * @param message the actual message
1097 * @return GNUNET_OK on success, GNUNET_SYSERR to stop further processing
1100 helper_mst (void *cls, void *client, const struct GNUNET_MessageHeader *message)
1102 struct GNUNET_TESTBED_ControllerProc *cp = cls;
1103 const struct GNUNET_TESTBED_HelperReply *msg;
1104 const char *hostname;
1107 uLongf xconfig_size;
1109 msg = (const struct GNUNET_TESTBED_HelperReply *) message;
1110 GNUNET_assert (sizeof (struct GNUNET_TESTBED_HelperReply) <
1111 ntohs (msg->header.size));
1112 GNUNET_assert (GNUNET_MESSAGE_TYPE_TESTBED_HELPER_REPLY ==
1113 ntohs (msg->header.type));
1114 config_size = (uLongf) ntohs (msg->config_size);
1116 (uLongf) (ntohs (msg->header.size) -
1117 sizeof (struct GNUNET_TESTBED_HelperReply));
1118 config = GNUNET_malloc (config_size);
1119 GNUNET_assert (Z_OK ==
1120 uncompress ((Bytef *) config, &config_size,
1121 (const Bytef *) &msg[1], xconfig_size));
1122 GNUNET_assert (NULL == cp->cfg);
1123 cp->cfg = GNUNET_CONFIGURATION_create ();
1124 GNUNET_assert (GNUNET_CONFIGURATION_deserialize
1125 (cp->cfg, config, config_size, GNUNET_NO));
1126 GNUNET_free (config);
1127 if ((NULL == cp->host) ||
1128 (NULL == (hostname = GNUNET_TESTBED_host_get_hostname_ (cp->host))))
1129 hostname = "localhost";
1130 /* Change the hostname so that we can connect to it */
1131 GNUNET_CONFIGURATION_set_value_string (cp->cfg, "testbed", "hostname",
1133 cp->cb (cp->cls, cp->cfg, GNUNET_OK);
1139 * Continuation function from GNUNET_HELPER_send()
1141 * @param cls closure
1142 * @param result GNUNET_OK on success,
1143 * GNUNET_NO if helper process died
1144 * GNUNET_SYSERR during GNUNET_HELPER_stop
1147 clear_msg (void *cls, int result)
1149 struct GNUNET_TESTBED_ControllerProc *cp = cls;
1151 GNUNET_assert (NULL != cp->shandle);
1153 GNUNET_free (cp->msg);
1158 * Callback that will be called when the helper process dies. This is not called
1159 * when the helper process is stoped using GNUNET_HELPER_stop()
1161 * @param cls the closure from GNUNET_HELPER_start()
1164 helper_exp_cb (void *cls)
1166 struct GNUNET_TESTBED_ControllerProc *cp = cls;
1167 GNUNET_TESTBED_ControllerStatusCallback cb;
1173 GNUNET_TESTBED_controller_stop (cp);
1175 cb (cb_cls, NULL, GNUNET_SYSERR);
1180 * Function to call to start a link-controllers type operation once all queues
1181 * the operation is part of declare that the operation can be activated.
1183 * @param cls the closure from GNUNET_TESTBED_operation_create_()
1186 opstart_link_controllers (void *cls)
1188 struct OperationContext *opc = cls;
1189 struct GNUNET_TESTBED_ControllerLinkMessage *msg;
1191 GNUNET_assert (NULL != opc->data);
1194 opc->state = OPC_STATE_STARTED;
1195 GNUNET_CONTAINER_DLL_insert_tail (opc->c->ocq_head, opc->c->ocq_tail, opc);
1196 GNUNET_TESTBED_queue_message_ (opc->c, &msg->header);
1201 * Callback which will be called when link-controllers type operation is released
1203 * @param cls the closure from GNUNET_TESTBED_operation_create_()
1206 oprelease_link_controllers (void *cls)
1208 struct OperationContext *opc = cls;
1210 if (OPC_STATE_INIT == opc->state)
1211 GNUNET_free (opc->data);
1212 if (OPC_STATE_STARTED == opc->state)
1213 GNUNET_CONTAINER_DLL_remove (opc->c->ocq_head, opc->c->ocq_tail, opc);
1219 * Function to be called when get slave config operation is ready
1221 * @param cls the OperationContext of type OP_GET_SLAVE_CONFIG
1224 opstart_get_slave_config (void *cls)
1226 struct OperationContext *opc = cls;
1227 struct GetSlaveConfigData *data;
1228 struct GNUNET_TESTBED_SlaveGetConfigurationMessage *msg;
1232 msize = sizeof (struct GNUNET_TESTBED_SlaveGetConfigurationMessage);
1233 msg = GNUNET_malloc (msize);
1234 msg->header.size = htons (msize);
1235 msg->header.type = htons (GNUNET_MESSAGE_TYPE_TESTBED_GETSLAVECONFIG);
1236 msg->operation_id = GNUNET_htonll (opc->id);
1237 msg->slave_id = htonl (data->slave_id);
1238 GNUNET_CONTAINER_DLL_insert_tail (opc->c->ocq_head, opc->c->ocq_tail, opc);
1239 GNUNET_TESTBED_queue_message_ (opc->c, &msg->header);
1240 opc->state = OPC_STATE_STARTED;
1245 * Function to be called when get slave config operation is cancelled or finished
1247 * @param cls the OperationContext of type OP_GET_SLAVE_CONFIG
1250 oprelease_get_slave_config (void *cls)
1252 struct OperationContext *opc = cls;
1256 case OPC_STATE_INIT:
1257 GNUNET_free (opc->data);
1259 case OPC_STATE_STARTED:
1260 GNUNET_free (opc->data);
1261 GNUNET_CONTAINER_DLL_remove (opc->c->ocq_head, opc->c->ocq_tail, opc);
1263 case OPC_STATE_FINISHED:
1264 if (NULL != opc->data)
1265 GNUNET_CONFIGURATION_destroy (opc->data);
1273 * Starts a controller process at the host. FIXME: add controller start callback
1274 * with the configuration with which the controller is started
1276 * @param controller_ip the ip address of the controller. Will be set as TRUSTED
1277 * host when starting testbed controller at host
1278 * @param host the host where the controller has to be started; NULL for
1280 * @param cfg template configuration to use for the remote controller; the
1281 * remote controller will be started with a slightly modified
1282 * configuration (port numbers, unix domain sockets and service home
1283 * values are changed as per TESTING library on the remote host)
1284 * @param cb function called when the controller is successfully started or
1285 * dies unexpectedly; GNUNET_TESTBED_controller_stop shouldn't be
1286 * called if cb is called with GNUNET_SYSERR as status. Will never be
1287 * called in the same task as 'GNUNET_TESTBED_controller_start'
1288 * (synchronous errors will be signalled by returning NULL). This
1289 * parameter cannot be NULL.
1290 * @param cls closure for above callbacks
1291 * @return the controller process handle, NULL on errors
1293 struct GNUNET_TESTBED_ControllerProc *
1294 GNUNET_TESTBED_controller_start (const char *controller_ip,
1295 struct GNUNET_TESTBED_Host *host,
1296 const struct GNUNET_CONFIGURATION_Handle *cfg,
1297 GNUNET_TESTBED_ControllerStatusCallback cb,
1300 struct GNUNET_TESTBED_ControllerProc *cp;
1301 struct GNUNET_TESTBED_HelperInit *msg;
1302 static char *const binary_argv[] = {
1303 HELPER_TESTBED_BINARY, NULL
1306 cp = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_ControllerProc));
1307 if ((NULL == host) || (0 == GNUNET_TESTBED_host_get_id_ (host)))
1309 GNUNET_HELPER_start (GNUNET_YES, HELPER_TESTBED_BINARY, binary_argv,
1310 &helper_mst, &helper_exp_cb, cp);
1313 char *remote_args[8];
1315 const char *username;
1316 const char *hostname;
1318 username = GNUNET_TESTBED_host_get_username_ (host);
1319 hostname = GNUNET_TESTBED_host_get_hostname_ (host);
1320 GNUNET_asprintf (&cp->port, "%u", GNUNET_TESTBED_host_get_ssh_port_ (host));
1321 if (NULL == username)
1322 GNUNET_asprintf (&cp->dst, "%s", hostname);
1324 GNUNET_asprintf (&cp->dst, "%s@%s", username, hostname);
1325 LOG_DEBUG ("Starting SSH to destination %s\n", cp->dst);
1327 remote_args[argp++] = "ssh";
1328 remote_args[argp++] = "-p";
1329 remote_args[argp++] = cp->port;
1330 remote_args[argp++] = "-o";
1331 remote_args[argp++] = "BatchMode=yes";
1332 remote_args[argp++] = cp->dst;
1333 remote_args[argp++] = HELPER_TESTBED_BINARY_SSH;
1334 remote_args[argp++] = NULL;
1335 GNUNET_assert (argp == 8);
1337 GNUNET_HELPER_start (GNUNET_NO, "ssh", remote_args, &helper_mst,
1338 &helper_exp_cb, cp);
1340 if (NULL == cp->helper)
1342 GNUNET_free_non_null (cp->port);
1343 GNUNET_free_non_null (cp->dst);
1350 msg = GNUNET_TESTBED_create_helper_init_msg_ (controller_ip, cfg);
1351 cp->msg = &msg->header;
1353 GNUNET_HELPER_send (cp->helper, &msg->header, GNUNET_NO, &clear_msg, cp);
1354 if (NULL == cp->shandle)
1357 GNUNET_TESTBED_controller_stop (cp);
1365 * Stop the controller process (also will terminate all peers and controllers
1366 * dependent on this controller). This function blocks until the testbed has
1367 * been fully terminated (!). The controller status cb from
1368 * GNUNET_TESTBED_controller_start() will not be called.
1370 * @param cproc the controller process handle
1373 GNUNET_TESTBED_controller_stop (struct GNUNET_TESTBED_ControllerProc *cproc)
1375 if (NULL != cproc->shandle)
1376 GNUNET_HELPER_send_cancel (cproc->shandle);
1377 if (NULL != cproc->helper)
1378 GNUNET_HELPER_stop (cproc->helper);
1379 if (NULL != cproc->cfg)
1380 GNUNET_CONFIGURATION_destroy (cproc->cfg);
1381 GNUNET_free_non_null (cproc->port);
1382 GNUNET_free_non_null (cproc->dst);
1383 GNUNET_free (cproc);
1388 * Start a controller process using the given configuration at the
1391 * @param cfg configuration to use
1392 * @param host host to run the controller on; This should be the same host if
1393 * the controller was previously started with
1394 * GNUNET_TESTBED_controller_start; NULL for localhost
1395 * @param event_mask bit mask with set of events to call 'cc' for;
1396 * or-ed values of "1LL" shifted by the
1397 * respective 'enum GNUNET_TESTBED_EventType'
1398 * (i.e. "(1LL << GNUNET_TESTBED_ET_CONNECT) | ...")
1399 * @param cc controller callback to invoke on events
1400 * @param cc_cls closure for cc
1401 * @return handle to the controller
1403 struct GNUNET_TESTBED_Controller *
1404 GNUNET_TESTBED_controller_connect (const struct GNUNET_CONFIGURATION_Handle
1405 *cfg, struct GNUNET_TESTBED_Host *host,
1406 uint64_t event_mask,
1407 GNUNET_TESTBED_ControllerCallback cc,
1410 struct GNUNET_TESTBED_Controller *controller;
1411 struct GNUNET_TESTBED_InitMessage *msg;
1412 const char *controller_hostname;
1413 unsigned long long max_parallel_operations;
1414 unsigned long long max_parallel_service_connections;
1415 unsigned long long max_parallel_topology_config_operations;
1418 GNUNET_CONFIGURATION_get_value_number (cfg, "testbed",
1419 "MAX_PARALLEL_OPERATIONS",
1420 &max_parallel_operations))
1426 GNUNET_CONFIGURATION_get_value_number (cfg, "testbed",
1427 "MAX_PARALLEL_SERVICE_CONNECTIONS",
1428 &max_parallel_service_connections))
1434 GNUNET_CONFIGURATION_get_value_number (cfg, "testbed",
1435 "MAX_PARALLEL_TOPOLOGY_CONFIG_OPERATIONS",
1436 &max_parallel_topology_config_operations))
1441 controller = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_Controller));
1442 controller->cc = cc;
1443 controller->cc_cls = cc_cls;
1444 controller->event_mask = event_mask;
1445 controller->cfg = GNUNET_CONFIGURATION_dup (cfg);
1446 controller->client = GNUNET_CLIENT_connect ("testbed", controller->cfg);
1447 if (NULL == controller->client)
1449 GNUNET_TESTBED_controller_disconnect (controller);
1454 host = GNUNET_TESTBED_host_create_by_id_ (0);
1455 if (NULL == host) /* If the above host create fails */
1457 LOG (GNUNET_ERROR_TYPE_WARNING,
1458 "Treating NULL host as localhost. Multiple references to localhost "
1459 "may break when localhost freed before calling disconnect \n");
1460 host = GNUNET_TESTBED_host_lookup_by_id_ (0);
1464 controller->aux_host = GNUNET_YES;
1467 GNUNET_assert (NULL != host);
1468 GNUNET_TESTBED_mark_host_registered_at_ (host, controller);
1469 controller->host = host;
1470 controller->opq_parallel_operations =
1471 GNUNET_TESTBED_operation_queue_create_ ((unsigned int)
1472 max_parallel_operations);
1473 controller->opq_parallel_service_connections =
1474 GNUNET_TESTBED_operation_queue_create_ ((unsigned int)
1475 max_parallel_service_connections);
1476 controller->opq_parallel_topology_config_operations=
1477 GNUNET_TESTBED_operation_queue_create_ ((unsigned int)
1478 max_parallel_service_connections);
1479 controller_hostname = GNUNET_TESTBED_host_get_hostname_ (host);
1480 if (NULL == controller_hostname)
1481 controller_hostname = "127.0.0.1";
1483 GNUNET_malloc (sizeof (struct GNUNET_TESTBED_InitMessage) +
1484 strlen (controller_hostname) + 1);
1485 msg->header.type = htons (GNUNET_MESSAGE_TYPE_TESTBED_INIT);
1487 htons (sizeof (struct GNUNET_TESTBED_InitMessage) +
1488 strlen (controller_hostname) + 1);
1489 msg->host_id = htonl (GNUNET_TESTBED_host_get_id_ (host));
1490 msg->event_mask = GNUNET_htonll (controller->event_mask);
1491 strcpy ((char *) &msg[1], controller_hostname);
1492 GNUNET_TESTBED_queue_message_ (controller,
1493 (struct GNUNET_MessageHeader *) msg);
1499 * Configure shared services at a controller. Using this function,
1500 * you can specify that certain services (such as "resolver")
1501 * should not be run for each peer but instead be shared
1502 * across N peers on the specified host. This function
1503 * must be called before any peers are created at the host.
1505 * @param controller controller to configure
1506 * @param service_name name of the service to share
1507 * @param num_peers number of peers that should share one instance
1508 * of the specified service (1 for no sharing is the default),
1509 * use 0 to disable the service
1512 GNUNET_TESTBED_controller_configure_sharing (struct GNUNET_TESTBED_Controller
1514 const char *service_name,
1517 struct GNUNET_TESTBED_ConfigureSharedServiceMessage *msg;
1518 uint16_t service_name_size;
1521 service_name_size = strlen (service_name) + 1;
1523 sizeof (struct GNUNET_TESTBED_ConfigureSharedServiceMessage) +
1525 msg = GNUNET_malloc (msg_size);
1526 msg->header.size = htons (msg_size);
1527 msg->header.type = htons (GNUNET_MESSAGE_TYPE_TESTBED_SERVICESHARE);
1528 msg->host_id = htonl (GNUNET_TESTBED_host_get_id_ (controller->host));
1529 msg->num_peers = htonl (num_peers);
1530 memcpy (&msg[1], service_name, service_name_size);
1531 GNUNET_TESTBED_queue_message_ (controller,
1532 (struct GNUNET_MessageHeader *) msg);
1537 * disconnects from the controller.
1539 * @param controller handle to controller to stop
1542 GNUNET_TESTBED_controller_disconnect (struct GNUNET_TESTBED_Controller
1545 struct MessageQueue *mq_entry;
1547 if (NULL != controller->th)
1548 GNUNET_CLIENT_notify_transmit_ready_cancel (controller->th);
1549 /* Clear the message queue */
1550 while (NULL != (mq_entry = controller->mq_head))
1552 GNUNET_CONTAINER_DLL_remove (controller->mq_head, controller->mq_tail,
1554 GNUNET_free (mq_entry->msg);
1555 GNUNET_free (mq_entry);
1557 if (NULL != controller->client)
1558 GNUNET_CLIENT_disconnect (controller->client);
1559 GNUNET_CONFIGURATION_destroy (controller->cfg);
1560 if (GNUNET_YES == controller->aux_host)
1561 GNUNET_TESTBED_host_destroy (controller->host);
1562 GNUNET_TESTBED_operation_queue_destroy_ (controller->opq_parallel_operations);
1563 GNUNET_TESTBED_operation_queue_destroy_
1564 (controller->opq_parallel_service_connections);
1565 GNUNET_TESTBED_operation_queue_destroy_
1566 (controller->opq_parallel_topology_config_operations);
1567 GNUNET_free (controller);
1572 * Register a host with the controller
1574 * @param controller the controller handle
1575 * @param host the host to register
1576 * @param cc the completion callback to call to inform the status of
1577 * registration. After calling this callback the registration handle
1578 * will be invalid. Cannot be NULL.
1579 * @param cc_cls the closure for the cc
1580 * @return handle to the host registration which can be used to cancel the
1583 struct GNUNET_TESTBED_HostRegistrationHandle *
1584 GNUNET_TESTBED_register_host (struct GNUNET_TESTBED_Controller *controller,
1585 struct GNUNET_TESTBED_Host *host,
1586 GNUNET_TESTBED_HostRegistrationCompletion cc,
1589 struct GNUNET_TESTBED_HostRegistrationHandle *rh;
1590 struct GNUNET_TESTBED_AddHostMessage *msg;
1591 const char *username;
1592 const char *hostname;
1594 uint16_t user_name_length;
1596 if (NULL != controller->rh)
1598 hostname = GNUNET_TESTBED_host_get_hostname_ (host);
1599 if (GNUNET_YES == GNUNET_TESTBED_is_host_registered_ (host, controller))
1601 LOG (GNUNET_ERROR_TYPE_WARNING, "Host hostname: %s already registered\n",
1602 (NULL == hostname) ? "localhost" : hostname);
1605 rh = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_HostRegistrationHandle));
1608 GNUNET_assert (NULL != cc);
1610 rh->cc_cls = cc_cls;
1611 controller->rh = rh;
1612 username = GNUNET_TESTBED_host_get_username_ (host);
1613 msg_size = (sizeof (struct GNUNET_TESTBED_AddHostMessage));
1614 user_name_length = 0;
1615 if (NULL != username)
1617 user_name_length = strlen (username) + 1;
1618 msg_size += user_name_length;
1620 /* FIXME: what happens when hostname is NULL? localhost */
1621 GNUNET_assert (NULL != hostname);
1622 msg_size += strlen (hostname) + 1;
1623 msg = GNUNET_malloc (msg_size);
1624 msg->header.size = htons (msg_size);
1625 msg->header.type = htons (GNUNET_MESSAGE_TYPE_TESTBED_ADDHOST);
1626 msg->host_id = htonl (GNUNET_TESTBED_host_get_id_ (host));
1627 msg->ssh_port = htons (GNUNET_TESTBED_host_get_ssh_port_ (host));
1628 msg->user_name_length = htons (user_name_length);
1629 if (NULL != username)
1630 memcpy (&msg[1], username, user_name_length);
1631 strcpy (((void *) &msg[1]) + user_name_length, hostname);
1632 GNUNET_TESTBED_queue_message_ (controller,
1633 (struct GNUNET_MessageHeader *) msg);
1639 * Cancel the pending registration. Note that if the registration message is
1640 * already sent to the service the cancellation has only the effect that the
1641 * registration completion callback for the registration is never called.
1643 * @param handle the registration handle to cancel
1646 GNUNET_TESTBED_cancel_registration (struct GNUNET_TESTBED_HostRegistrationHandle
1649 if (handle != handle->c->rh)
1654 handle->c->rh = NULL;
1655 GNUNET_free (handle);
1660 * Same as the GNUNET_TESTBED_controller_link, however expects configuration in
1661 * serialized and compressed
1663 * @param master handle to the master controller who creates the association
1664 * @param delegated_host requests to which host should be delegated; cannot be NULL
1665 * @param slave_host which host is used to run the slave controller; use NULL to
1666 * make the master controller connect to the delegated host
1667 * @param sxcfg serialized and compressed configuration
1668 * @param sxcfg_size the size scfg
1669 * @param scfg_size the size of uncompressed serialized configuration
1670 * @param is_subordinate GNUNET_YES if the controller at delegated_host should
1671 * be started by the master controller; GNUNET_NO if we are just
1672 * allowed to use the slave via TCP/IP
1674 struct GNUNET_TESTBED_Operation *
1675 GNUNET_TESTBED_controller_link_2 (struct GNUNET_TESTBED_Controller *master,
1676 struct GNUNET_TESTBED_Host *delegated_host,
1677 struct GNUNET_TESTBED_Host *slave_host,
1678 const char *sxcfg, size_t sxcfg_size,
1679 size_t scfg_size, int is_subordinate)
1681 struct OperationContext *opc;
1682 struct GNUNET_TESTBED_ControllerLinkMessage *msg;
1685 GNUNET_assert (GNUNET_YES ==
1686 GNUNET_TESTBED_is_host_registered_ (delegated_host, master));
1687 if ((NULL != slave_host) && (0 != GNUNET_TESTBED_host_get_id_ (slave_host)))
1688 GNUNET_assert (GNUNET_YES ==
1689 GNUNET_TESTBED_is_host_registered_ (slave_host, master));
1690 msg_size = sxcfg_size + sizeof (struct GNUNET_TESTBED_ControllerLinkMessage);
1691 msg = GNUNET_malloc (msg_size);
1692 msg->header.type = htons (GNUNET_MESSAGE_TYPE_TESTBED_LCONTROLLERS);
1693 msg->header.size = htons (msg_size);
1694 msg->delegated_host_id = htonl (GNUNET_TESTBED_host_get_id_ (delegated_host));
1695 msg->slave_host_id =
1696 htonl (GNUNET_TESTBED_host_get_id_
1697 ((NULL != slave_host) ? slave_host : master->host));
1698 msg->config_size = htons ((uint16_t) scfg_size);
1699 msg->is_subordinate = (GNUNET_YES == is_subordinate) ? 1 : 0;
1700 memcpy (&msg[1], sxcfg, sxcfg_size);
1701 opc = GNUNET_malloc (sizeof (struct OperationContext));
1704 opc->type = OP_LINK_CONTROLLERS;
1705 opc->id = master->operation_counter++;
1706 opc->state = OPC_STATE_INIT;
1707 msg->operation_id = GNUNET_htonll (opc->id);
1709 GNUNET_TESTBED_operation_create_ (opc, &opstart_link_controllers,
1710 &oprelease_link_controllers);
1711 GNUNET_TESTBED_operation_queue_insert_ (master->opq_parallel_operations,
1718 * Compresses given configuration using zlib compress
1720 * @param config the serialized configuration
1721 * @param size the size of config
1722 * @param xconfig will be set to the compressed configuration (memory is fresly
1724 * @return the size of the xconfig
1727 GNUNET_TESTBED_compress_config_ (const char *config, size_t size,
1732 xsize = compressBound ((uLong) size);
1733 *xconfig = GNUNET_malloc (xsize);
1734 GNUNET_assert (Z_OK ==
1735 compress2 ((Bytef *) * xconfig, (uLongf *) & xsize,
1736 (const Bytef *) config, (uLongf) size,
1743 * Create a link from slave controller to delegated controller. Whenever the
1744 * master controller is asked to start a peer at the delegated controller the
1745 * request will be routed towards slave controller (if a route exists). The
1746 * slave controller will then route it to the delegated controller. The
1747 * configuration of the slave controller is given and to be used to either
1748 * create the slave controller or to connect to an existing slave controller
1749 * process. 'is_subordinate' specifies if the given slave controller should be
1750 * started and managed by the master controller, or if the slave already has a
1751 * master and this is just a secondary master that is also allowed to use the
1754 * @param master handle to the master controller who creates the association
1755 * @param delegated_host requests to which host should be delegated
1756 * @param slave_host which host is used to run the slave controller
1757 * @param slave_cfg configuration to use for the slave controller
1758 * @param is_subordinate GNUNET_YES if the slave should be started (and stopped)
1759 * by the master controller; GNUNET_NO if we are just
1760 * allowed to use the slave via TCP/IP
1761 * @return the operation handle
1763 struct GNUNET_TESTBED_Operation *
1764 GNUNET_TESTBED_controller_link (struct GNUNET_TESTBED_Controller *master,
1765 struct GNUNET_TESTBED_Host *delegated_host,
1766 struct GNUNET_TESTBED_Host *slave_host,
1767 const struct GNUNET_CONFIGURATION_Handle
1768 *slave_cfg, int is_subordinate)
1770 struct GNUNET_TESTBED_Operation *op;
1776 GNUNET_assert (GNUNET_YES ==
1777 GNUNET_TESTBED_is_host_registered_ (delegated_host, master));
1778 if ((NULL != slave_host) && (0 != GNUNET_TESTBED_host_get_id_ (slave_host)))
1779 GNUNET_assert (GNUNET_YES ==
1780 GNUNET_TESTBED_is_host_registered_ (slave_host, master));
1781 config = GNUNET_CONFIGURATION_serialize (slave_cfg, &config_size);
1782 cc_size = GNUNET_TESTBED_compress_config_ (config, config_size, &cconfig);
1783 GNUNET_free (config);
1784 /* Configuration doesn't fit in 1 message */
1785 GNUNET_assert ((UINT16_MAX -
1786 sizeof (struct GNUNET_TESTBED_ControllerLinkMessage)) >= cc_size);
1787 op = GNUNET_TESTBED_controller_link_2 (master, delegated_host, slave_host,
1788 (const char *) cconfig, cc_size,
1789 config_size, is_subordinate);
1790 GNUNET_free (cconfig);
1796 * Function to acquire the configuration of a running slave controller. The
1797 * completion of the operation is signalled through the controller_cb from
1798 * GNUNET_TESTBED_controller_connect(). If the operation is successful the
1799 * handle to the configuration is available in the generic pointer of
1800 * operation_finished field of struct GNUNET_TESTBED_EventInformation.
1802 * @param op_cls the closure for the operation
1803 * @param master the handle to master controller
1804 * @param slave_host the host where the slave controller is running; the handle
1805 * to the slave_host should remain valid until this operation is
1806 * cancelled or marked as finished
1807 * @return the operation handle; NULL if the slave_host is not registered at
1810 struct GNUNET_TESTBED_Operation *
1811 GNUNET_TESTBED_get_slave_config (void *op_cls,
1812 struct GNUNET_TESTBED_Controller *master,
1813 struct GNUNET_TESTBED_Host *slave_host)
1815 struct OperationContext *opc;
1816 struct GetSlaveConfigData *data;
1818 if (GNUNET_NO == GNUNET_TESTBED_is_host_registered_ (slave_host, master))
1820 data = GNUNET_malloc (sizeof (struct GetSlaveConfigData));
1821 data->slave_id = GNUNET_TESTBED_host_get_id_ (slave_host);
1822 data->op_cls = op_cls;
1823 opc = GNUNET_malloc (sizeof (struct OperationContext));
1824 opc->state = OPC_STATE_INIT;
1826 opc->id = master->operation_counter++;
1827 opc->type = OP_GET_SLAVE_CONFIG;
1830 GNUNET_TESTBED_operation_create_ (opc, &opstart_get_slave_config,
1831 &oprelease_get_slave_config);
1832 GNUNET_TESTBED_operation_queue_insert_ (master->opq_parallel_operations,
1839 * Ask the testbed controller to write the current overlay topology to
1840 * a file. Naturally, the file will only contain a snapshot as the
1841 * topology may evolve all the time.
1843 * @param controller overlay controller to inspect
1844 * @param filename name of the file the topology should
1848 GNUNET_TESTBED_overlay_write_topology_to_file (struct GNUNET_TESTBED_Controller
1850 const char *filename)
1857 * Creates a helper initialization message. This function is here because we
1858 * want to use this in testing
1860 * @param cname the ip address of the controlling host
1861 * @param cfg the configuration that has to used to start the testbed service
1863 * @return the initialization message
1865 struct GNUNET_TESTBED_HelperInit *
1866 GNUNET_TESTBED_create_helper_init_msg_ (const char *cname,
1867 const struct GNUNET_CONFIGURATION_Handle
1870 struct GNUNET_TESTBED_HelperInit *msg;
1874 size_t xconfig_size;
1878 config = GNUNET_CONFIGURATION_serialize (cfg, &config_size);
1879 GNUNET_assert (NULL != config);
1881 GNUNET_TESTBED_compress_config_ (config, config_size, &xconfig);
1882 GNUNET_free (config);
1883 cname_len = strlen (cname);
1885 xconfig_size + cname_len + 1 + sizeof (struct GNUNET_TESTBED_HelperInit);
1886 msg = GNUNET_realloc (xconfig, msg_size);
1887 (void) memmove (((void *) &msg[1]) + cname_len + 1, msg, xconfig_size);
1888 msg->header.size = htons (msg_size);
1889 msg->header.type = htons (GNUNET_MESSAGE_TYPE_TESTBED_HELPER_INIT);
1890 msg->cname_size = htons (cname_len);
1891 msg->config_size = htons (config_size);
1892 (void) strcpy ((char *) &msg[1], cname);
1898 * Cancel a pending operation. Releases all resources
1899 * of the operation and will ensure that no event
1900 * is generated for the operation. Does NOT guarantee
1901 * that the operation will be fully undone (or that
1902 * nothing ever happened).
1904 * @param operation operation to cancel
1907 GNUNET_TESTBED_operation_cancel (struct GNUNET_TESTBED_Operation *operation)
1909 GNUNET_TESTBED_operation_done (operation);
1914 * Signal that the information from an operation has been fully
1915 * processed. This function MUST be called for each event
1916 * of type 'operation_finished' to fully remove the operation
1917 * from the operation queue. After calling this function, the
1918 * 'op_result' becomes invalid (!).
1920 * @param operation operation to signal completion for
1923 GNUNET_TESTBED_operation_done (struct GNUNET_TESTBED_Operation *operation)
1925 switch (operation->type)
1927 case OP_PEER_CREATE:
1928 case OP_PEER_DESTROY:
1932 case OP_OVERLAY_CONNECT:
1933 case OP_LINK_CONTROLLERS:
1934 GNUNET_TESTBED_operation_release_ (operation);
1944 * Generates configuration by uncompressing configuration in given message. The
1945 * given message should be of the following types:
1946 * GNUNET_MESSAGE_TYPE_TESTBED_PEERCONFIG,
1947 * GNUNET_MESSAGE_TYPE_TESTBED_SLAVECONFIG
1949 * @param msg the message containing compressed configuration
1950 * @return handle to the parsed configuration
1952 struct GNUNET_CONFIGURATION_Handle *
1953 GNUNET_TESTBED_extract_config_ (const struct GNUNET_MessageHeader *msg)
1955 struct GNUNET_CONFIGURATION_Handle *cfg;
1962 switch (ntohs (msg->type))
1964 case GNUNET_MESSAGE_TYPE_TESTBED_PEERCONFIG:
1966 const struct GNUNET_TESTBED_PeerConfigurationInformationMessage *imsg;
1968 imsg = (const struct GNUNET_TESTBED_PeerConfigurationInformationMessage *)
1970 data_len = (uLong) ntohs (imsg->config_size);
1971 xdata_len = ntohs (imsg->header.size)
1972 - sizeof (struct GNUNET_TESTBED_PeerConfigurationInformationMessage);
1973 xdata = (const Bytef *) &imsg[1];
1976 case GNUNET_MESSAGE_TYPE_TESTBED_SLAVECONFIG:
1978 const struct GNUNET_TESTBED_SlaveConfiguration *imsg;
1980 imsg = (const struct GNUNET_TESTBED_SlaveConfiguration *) msg;
1981 data_len = (uLong) ntohs (imsg->config_size);
1982 xdata_len = ntohs (imsg->header.size)
1983 - sizeof (struct GNUNET_TESTBED_SlaveConfiguration);
1984 xdata = (const Bytef *) &imsg[1];
1990 data = GNUNET_malloc (data_len);
1993 uncompress (data, &data_len, xdata, xdata_len)))
1995 cfg = GNUNET_CONFIGURATION_create ();
1996 GNUNET_assert (GNUNET_OK ==
1997 GNUNET_CONFIGURATION_deserialize (cfg, (const char *) data,
2006 * Checks the integrity of the OperationFailureEventMessage and if good returns
2007 * the error message it contains.
2009 * @param msg the OperationFailureEventMessage
2010 * @return the error message
2013 GNUNET_TESTBED_parse_error_string_ (const struct
2014 GNUNET_TESTBED_OperationFailureEventMessage
2020 msize = ntohs (msg->header.size);
2021 if (sizeof (struct GNUNET_TESTBED_OperationFailureEventMessage) >= msize)
2023 msize -= sizeof (struct GNUNET_TESTBED_OperationFailureEventMessage);
2024 emsg = (const char *) &msg[1];
2025 if ('\0' != emsg[msize - 1])
2033 /* end of testbed_api.c */