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 * Handle for controller process
80 struct GNUNET_TESTBED_ControllerProc
85 struct GNUNET_HELPER_Handle *helper;
88 * The host where the helper is run
90 struct GNUNET_TESTBED_Host *host;
93 * The controller error callback
95 GNUNET_TESTBED_ControllerStatusCallback cb;
98 * The closure for the above callback
103 * The send handle for the helper
105 struct GNUNET_HELPER_SendHandle *shandle;
108 * The message corresponding to send handle
110 struct GNUNET_MessageHeader *msg;
113 * The port number for ssh; used for helpers starting ssh
118 * The ssh destination string; used for helpers starting ssh
123 * The configuration of the running testbed service
125 struct GNUNET_CONFIGURATION_Handle *cfg;
131 * The message queue for sending messages to the controller service
136 * The message to be sent
138 struct GNUNET_MessageHeader *msg;
141 * next pointer for DLL
143 struct MessageQueue *next;
146 * prev pointer for DLL
148 struct MessageQueue *prev;
153 * Structure for a controller link
155 struct ControllerLink
158 * The next ptr for DLL
160 struct ControllerLink *next;
163 * The prev ptr for DLL
165 struct ControllerLink *prev;
168 * The host which will be referred in the peer start request. This is the
169 * host where the peer should be started
171 struct GNUNET_TESTBED_Host *delegated_host;
174 * The host which will contacted to delegate the peer start request
176 struct GNUNET_TESTBED_Host *slave_host;
179 * The configuration to be used to connect to slave host
181 const struct GNUNET_CONFIGURATION_Handle *slave_cfg;
184 * GNUNET_YES if the slave should be started (and stopped) by us; GNUNET_NO
185 * if we are just allowed to use the slave via TCP/IP
192 * handle for host registration
194 struct GNUNET_TESTBED_HostRegistrationHandle
197 * The host being registered
199 struct GNUNET_TESTBED_Host *host;
202 * The controller at which this host is being registered
204 struct GNUNET_TESTBED_Controller *c;
207 * The Registartion completion callback
209 GNUNET_TESTBED_HostRegistrationCompletion cc;
212 * The closure for above callback
219 * Context data for forwarded Operation
221 struct ForwardedOperationData
225 * The callback to call when reply is available
227 GNUNET_CLIENT_MessageHandler cc;
230 * The closure for the above callback
238 * Context data for get slave config operations
240 struct GetSlaveConfigData
243 * The operation closure
248 * The id of the slave controller
256 * Context data for controller link operations
258 struct ControllerLinkData
261 * The controller link message
263 struct GNUNET_TESTBED_ControllerLinkMessage *msg;
266 * The operation closure
274 * Returns the operation context with the given id if found in the Operation
275 * context queues of the controller
277 * @param c the controller whose queues are searched
278 * @param id the id which has to be checked
279 * @return the matching operation context; NULL if no match found
281 static struct OperationContext *
282 find_opc (const struct GNUNET_TESTBED_Controller *c, const uint64_t id)
284 struct OperationContext *opc;
286 for (opc = c->ocq_head; NULL != opc; opc = opc->next)
296 * Handler for GNUNET_MESSAGE_TYPE_TESTBED_ADDHOSTCONFIRM message from
297 * controller (testbed service)
299 * @param c the controller handler
300 * @param msg message received
301 * @return GNUNET_YES if we can continue receiving from service; GNUNET_NO if
305 handle_addhostconfirm (struct GNUNET_TESTBED_Controller *c,
306 const struct GNUNET_TESTBED_HostConfirmedMessage *msg)
308 struct GNUNET_TESTBED_HostRegistrationHandle *rh;
317 if (GNUNET_TESTBED_host_get_id_ (rh->host) != ntohl (msg->host_id))
319 LOG_DEBUG ("Mismatch in host id's %u, %u of host confirm msg\n",
320 GNUNET_TESTBED_host_get_id_ (rh->host), ntohl (msg->host_id));
324 msg_size = ntohs (msg->header.size);
325 if (sizeof (struct GNUNET_TESTBED_HostConfirmedMessage) == msg_size)
327 LOG_DEBUG ("Host %u successfully registered\n", ntohl (msg->host_id));
328 GNUNET_TESTBED_mark_host_registered_at_ (rh->host, c);
329 rh->cc (rh->cc_cls, NULL);
333 /* We have an error message */
334 emsg = (char *) &msg[1];
336 emsg[msg_size - sizeof (struct GNUNET_TESTBED_HostConfirmedMessage)])
342 LOG (GNUNET_ERROR_TYPE_ERROR, _("Adding host %u failed with error: %s\n"),
343 ntohl (msg->host_id), emsg);
344 rh->cc (rh->cc_cls, emsg);
351 * Handler for forwarded operations
353 * @param c the controller handle
354 * @param opc the opearation context
355 * @param msg the message
358 handle_forwarded_operation_msg (struct GNUNET_TESTBED_Controller *c,
359 struct OperationContext *opc,
360 const struct GNUNET_MessageHeader *msg)
362 struct ForwardedOperationData *fo_data;
365 if (NULL != fo_data->cc)
366 fo_data->cc (fo_data->cc_cls, msg);
367 GNUNET_CONTAINER_DLL_remove (c->ocq_head, c->ocq_tail, opc);
368 GNUNET_free (fo_data);
374 * Handler for GNUNET_MESSAGE_TYPE_TESTBED_ADDHOSTCONFIRM message from
375 * controller (testbed service)
377 * @param c the controller handler
378 * @param msg message received
379 * @return GNUNET_YES if we can continue receiving from service; GNUNET_NO if
383 handle_opsuccess (struct GNUNET_TESTBED_Controller *c,
385 GNUNET_TESTBED_GenericOperationSuccessEventMessage *msg)
387 struct OperationContext *opc;
388 struct GNUNET_TESTBED_EventInformation event;
391 op_id = GNUNET_ntohll (msg->operation_id);
392 LOG_DEBUG ("Operation %ul successful\n", op_id);
393 if (NULL == (opc = find_opc (c, op_id)))
395 LOG_DEBUG ("Operation not found\n");
398 event.type = GNUNET_TESTBED_ET_OPERATION_FINISHED;
399 event.details.operation_finished.operation = opc->op;
400 event.details.operation_finished.op_cls = NULL;
401 event.details.operation_finished.emsg = NULL;
402 event.details.operation_finished.generic = NULL;
407 handle_forwarded_operation_msg
408 (c, opc, (const struct GNUNET_MessageHeader *) msg);
412 case OP_PEER_DESTROY:
414 struct GNUNET_TESTBED_Peer *peer;
422 case OP_LINK_CONTROLLERS:
424 struct ControllerLinkData *data;
427 GNUNET_assert (NULL != data);
428 event.details.operation_finished.op_cls = data->op_cls;
436 GNUNET_CONTAINER_DLL_remove (opc->c->ocq_head, opc->c->ocq_tail, opc);
437 opc->state = OPC_STATE_FINISHED;
438 if (0 != (c->event_mask & (1L << GNUNET_TESTBED_ET_OPERATION_FINISHED)))
441 c->cc (c->cc_cls, &event);
448 * Handler for GNUNET_MESSAGE_TYPE_TESTBED_PEERCREATESUCCESS message from
449 * controller (testbed service)
451 * @param c the controller handle
452 * @param msg message received
453 * @return GNUNET_YES if we can continue receiving from service; GNUNET_NO if
457 handle_peer_create_success (struct GNUNET_TESTBED_Controller *c,
459 GNUNET_TESTBED_PeerCreateSuccessEventMessage *msg)
461 struct OperationContext *opc;
462 struct PeerCreateData *data;
463 struct GNUNET_TESTBED_Peer *peer;
464 GNUNET_TESTBED_PeerCreateCallback cb;
468 GNUNET_assert (sizeof (struct GNUNET_TESTBED_PeerCreateSuccessEventMessage) ==
469 ntohs (msg->header.size));
470 op_id = GNUNET_ntohll (msg->operation_id);
471 if (NULL == (opc = find_opc (c, op_id)))
473 LOG_DEBUG ("Operation context for PeerCreateSuccessEvent not found\n");
476 if (OP_FORWARDED == opc->type)
478 handle_forwarded_operation_msg (c, opc,
479 (const struct GNUNET_MessageHeader *) msg);
482 GNUNET_assert (OP_PEER_CREATE == opc->type);
483 GNUNET_assert (NULL != opc->data);
485 GNUNET_assert (NULL != data->peer);
487 GNUNET_assert (peer->unique_id == ntohl (msg->peer_id));
488 peer->state = PS_CREATED;
491 GNUNET_free (opc->data);
492 GNUNET_CONTAINER_DLL_remove (opc->c->ocq_head, opc->c->ocq_tail, opc);
493 opc->state = OPC_STATE_FINISHED;
495 cb (cls, peer, NULL);
501 * Handler for GNUNET_MESSAGE_TYPE_TESTBED_PEEREVENT message from
502 * controller (testbed service)
504 * @param c the controller handler
505 * @param msg message received
506 * @return GNUNET_YES if we can continue receiving from service; GNUNET_NO if
510 handle_peer_event (struct GNUNET_TESTBED_Controller *c,
511 const struct GNUNET_TESTBED_PeerEventMessage *msg)
513 struct OperationContext *opc;
514 struct GNUNET_TESTBED_Peer *peer;
515 struct PeerEventData *data;
516 GNUNET_TESTBED_PeerChurnCallback pcc;
518 struct GNUNET_TESTBED_EventInformation event;
521 GNUNET_assert (sizeof (struct GNUNET_TESTBED_PeerEventMessage) ==
522 ntohs (msg->header.size));
523 op_id = GNUNET_ntohll (msg->operation_id);
524 if (NULL == (opc = find_opc (c, op_id)))
526 LOG_DEBUG ("Operation not found\n");
529 if (OP_FORWARDED == opc->type)
531 handle_forwarded_operation_msg (c, opc,
532 (const struct GNUNET_MessageHeader *) msg);
535 GNUNET_assert ((OP_PEER_START == opc->type) || (OP_PEER_STOP == opc->type));
537 GNUNET_assert (NULL != data);
539 GNUNET_assert (NULL != peer);
540 event.type = (enum GNUNET_TESTBED_EventType) ntohl (msg->event_type);
543 case GNUNET_TESTBED_ET_PEER_START:
544 peer->state = PS_STARTED;
545 event.details.peer_start.host = peer->host;
546 event.details.peer_start.peer = peer;
548 case GNUNET_TESTBED_ET_PEER_STOP:
549 peer->state = PS_STOPPED;
550 event.details.peer_stop.peer = peer;
553 GNUNET_assert (0); /* We should never reach this state */
556 pcc_cls = data->pcc_cls;
558 GNUNET_CONTAINER_DLL_remove (opc->c->ocq_head, opc->c->ocq_tail, opc);
559 opc->state = OPC_STATE_FINISHED;
561 ((GNUNET_TESTBED_ET_PEER_START | GNUNET_TESTBED_ET_PEER_STOP) &
565 c->cc (c->cc_cls, &event);
574 * Handler for GNUNET_MESSAGE_TYPE_TESTBED_PEERCONEVENT message from
575 * controller (testbed service)
577 * @param c the controller handler
578 * @param msg message received
579 * @return GNUNET_YES if we can continue receiving from service; GNUNET_NO if
583 handle_peer_conevent (struct GNUNET_TESTBED_Controller *c,
584 const struct GNUNET_TESTBED_ConnectionEventMessage *msg)
586 struct OperationContext *opc;
587 struct OverlayConnectData *data;
588 GNUNET_TESTBED_OperationCompletionCallback cb;
590 struct GNUNET_TESTBED_EventInformation event;
593 op_id = GNUNET_ntohll (msg->operation_id);
594 if (NULL == (opc = find_opc (c, op_id)))
596 LOG_DEBUG ("Operation not found\n");
599 if (OP_FORWARDED == opc->type)
601 handle_forwarded_operation_msg (c, opc,
602 (const struct GNUNET_MessageHeader *) msg);
605 GNUNET_assert (OP_OVERLAY_CONNECT == opc->type);
607 GNUNET_assert (NULL != data);
608 GNUNET_assert ((ntohl (msg->peer1) == data->p1->unique_id) &&
609 (ntohl (msg->peer2) == data->p2->unique_id));
610 event.type = (enum GNUNET_TESTBED_EventType) ntohl (msg->event_type);
613 case GNUNET_TESTBED_ET_CONNECT:
614 event.details.peer_connect.peer1 = data->p1;
615 event.details.peer_connect.peer2 = data->p2;
617 case GNUNET_TESTBED_ET_DISCONNECT:
618 GNUNET_assert (0); /* FIXME: implement */
621 GNUNET_assert (0); /* Should never reach here */
625 cb_cls = data->cb_cls;
626 GNUNET_CONTAINER_DLL_remove (opc->c->ocq_head, opc->c->ocq_tail, opc);
627 opc->state = OPC_STATE_FINISHED;
630 ((GNUNET_TESTBED_ET_CONNECT | GNUNET_TESTBED_ET_DISCONNECT) &
634 c->cc (c->cc_cls, &event);
637 cb (cb_cls, opc->op, NULL);
643 * Handler for GNUNET_MESSAGE_TYPE_TESTBED_PEERCONFIG message from
644 * controller (testbed service)
646 * @param c the controller handler
647 * @param msg message received
648 * @return GNUNET_YES if we can continue receiving from service; GNUNET_NO if
652 handle_peer_config (struct GNUNET_TESTBED_Controller *c,
654 GNUNET_TESTBED_PeerConfigurationInformationMessage *msg)
656 struct OperationContext *opc;
657 struct GNUNET_TESTBED_Peer *peer;
658 struct PeerInfoData *data;
659 struct GNUNET_TESTBED_PeerInformation *pinfo;
660 GNUNET_TESTBED_PeerInfoCallback cb;
664 op_id = GNUNET_ntohll (msg->operation_id);
665 if (NULL == (opc = find_opc (c, op_id)))
667 LOG_DEBUG ("Operation not found\n");
670 if (OP_FORWARDED == opc->type)
672 handle_forwarded_operation_msg (c, opc,
673 (const struct GNUNET_MessageHeader *) msg);
677 GNUNET_assert (NULL != data);
679 GNUNET_assert (NULL != peer);
680 GNUNET_assert (ntohl (msg->peer_id) == peer->unique_id);
681 pinfo = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_PeerInformation));
682 pinfo->pit = data->pit;
684 cb_cls = data->cb_cls;
689 case GNUNET_TESTBED_PIT_IDENTITY:
690 pinfo->result.id = GNUNET_malloc (sizeof (struct GNUNET_PeerIdentity));
691 (void) memcpy (pinfo->result.id, &msg->peer_identity,
692 sizeof (struct GNUNET_PeerIdentity));
694 case GNUNET_TESTBED_PIT_CONFIGURATION:
695 pinfo->result.cfg = /* Freed in oprelease_peer_getinfo */
696 GNUNET_TESTBED_extract_config_ (&msg->header);
698 case GNUNET_TESTBED_PIT_GENERIC:
699 GNUNET_assert (0); /* never reach here */
703 GNUNET_CONTAINER_DLL_remove (opc->c->ocq_head, opc->c->ocq_tail, opc);
704 opc->state = OPC_STATE_FINISHED;
706 cb (cb_cls, opc->op, pinfo, NULL);
712 * Handler for GNUNET_MESSAGE_TYPE_TESTBED_OPERATIONFAILEVENT message from
713 * controller (testbed service)
715 * @param c the controller handler
716 * @param msg message received
717 * @return GNUNET_YES if we can continue receiving from service; GNUNET_NO if
721 handle_op_fail_event (struct GNUNET_TESTBED_Controller *c,
722 const struct GNUNET_TESTBED_OperationFailureEventMessage
725 struct OperationContext *opc;
728 struct GNUNET_TESTBED_EventInformation event;
730 op_id = GNUNET_ntohll (msg->operation_id);
731 if (NULL == (opc = find_opc (c, op_id)))
733 LOG_DEBUG ("Operation not found\n");
736 GNUNET_CONTAINER_DLL_remove (opc->c->ocq_head, opc->c->ocq_tail, opc);
737 if (OP_FORWARDED == opc->type)
739 handle_forwarded_operation_msg (c, opc,
740 (const struct GNUNET_MessageHeader *) msg);
743 opc->state = OPC_STATE_FINISHED;
744 emsg = GNUNET_TESTBED_parse_error_string_ (msg);
746 emsg = "Unknown error";
747 if (OP_PEER_INFO == opc->type)
749 struct PeerInfoData *data;
751 if (NULL != data->cb)
752 data->cb (data->cb_cls, opc->op, NULL, emsg);
754 return GNUNET_YES; /* We do not call controller callback for peer info */
756 if ((0 != (GNUNET_TESTBED_ET_OPERATION_FINISHED & c->event_mask)) &&
759 event.type = GNUNET_TESTBED_ET_OPERATION_FINISHED;
760 event.details.operation_finished.operation = opc->op;
761 event.details.operation_finished.op_cls = NULL;
762 event.details.operation_finished.emsg = emsg;
763 event.details.operation_finished.generic = NULL;
764 c->cc (c->cc_cls, &event);
770 struct PeerCreateData *data;
772 GNUNET_free (data->peer);
773 if (NULL != data->cb)
774 data->cb (data->cls, NULL, emsg);
781 struct PeerEventData *data;
783 if (NULL != data->pcc)
784 data->pcc (data->pcc_cls, emsg);
788 case OP_PEER_DESTROY:
792 case OP_OVERLAY_CONNECT:
794 struct OverlayConnectData *data;
796 if (NULL != data->cb)
797 data->cb (data->cb_cls, opc->op, emsg);
803 case OP_LINK_CONTROLLERS: /* No secondary callback */
813 * Function to build GET_SLAVE_CONFIG message
815 * @param op_id the id this message should contain in its operation id field
816 * @param slave_id the id this message should contain in its slave id field
817 * @return newly allocated SlaveGetConfigurationMessage
819 static struct GNUNET_TESTBED_SlaveGetConfigurationMessage *
820 GNUNET_TESTBED_generate_slavegetconfig_msg_ (uint64_t op_id, uint32_t slave_id)
822 struct GNUNET_TESTBED_SlaveGetConfigurationMessage *msg;
825 msize = sizeof (struct GNUNET_TESTBED_SlaveGetConfigurationMessage);
826 msg = GNUNET_malloc (msize);
827 msg->header.size = htons (msize);
828 msg->header.type = htons (GNUNET_MESSAGE_TYPE_TESTBED_GETSLAVECONFIG);
829 msg->operation_id = GNUNET_htonll (op_id);
830 msg->slave_id = htonl (slave_id);
836 * Handler for GNUNET_MESSAGE_TYPE_TESTBED_SLAVECONFIG message from controller
839 * @param c the controller handler
840 * @param msg message received
841 * @return GNUNET_YES if we can continue receiving from service; GNUNET_NO if
845 handle_slave_config (struct GNUNET_TESTBED_Controller *c,
846 const struct GNUNET_TESTBED_SlaveConfiguration * msg)
848 struct OperationContext *opc;
851 struct GNUNET_TESTBED_EventInformation event;
853 op_id = GNUNET_ntohll (msg->operation_id);
854 if (NULL == (opc = find_opc (c, op_id)))
856 LOG_DEBUG ("Operation not found\n");
859 if (OP_GET_SLAVE_CONFIG != opc->type)
864 op_cls = ((struct GetSlaveConfigData *) opc->data)->op_cls;
865 GNUNET_free (opc->data);
867 opc->state = OPC_STATE_FINISHED;
868 GNUNET_CONTAINER_DLL_remove (opc->c->ocq_head, opc->c->ocq_tail, opc);
869 if ((0 != (GNUNET_TESTBED_ET_OPERATION_FINISHED & c->event_mask)) &&
872 opc->data = GNUNET_TESTBED_extract_config_ (&msg->header);
873 event.type = GNUNET_TESTBED_ET_OPERATION_FINISHED;
874 event.details.operation_finished.generic = opc->data;
875 event.details.operation_finished.operation = opc->op;
876 event.details.operation_finished.op_cls = op_cls;
877 event.details.operation_finished.emsg = NULL;
878 c->cc (c->cc_cls, &event);
885 * Callback to check status for suboperations generated during overlay connect.
887 * @param cls the OverlayConnectData
888 * @param message the reply message to the suboperation
891 overlay_connect_ondemand_handler (void *cls,
892 const struct GNUNET_MessageHeader *message)
894 struct OverlayConnectData *oc_data = cls;
896 switch (oc_data->state)
898 case OCD_CFG_ACQUIRE:
900 struct GNUNET_CONFIGURATION_Handle *cfg;
902 if (GNUNET_MESSAGE_TYPE_TESTBED_SLAVECONFIG != ntohs (message->type))
904 GNUNET_break (0); /* treat operation as failed */
906 cfg = GNUNET_TESTBED_extract_config_ (message);
909 GNUNET_break (0); /* failed operation */
911 oc_data->state = OCD_LINK_CONTROLLERS;
920 * Handler for GNUNET_MESSAGE_TYPE_TESTBED_NEEDCONTROLLERCONFIG message from
921 * controller (testbed service)
923 * @param c the controller handler
924 * @param msg message received
925 * @return GNUNET_YES if we can continue receiving from service; GNUNET_NO if
929 handle_need_controller_config (struct GNUNET_TESTBED_Controller *c,
930 const struct GNUNET_TESTBED_NeedControllerConfig * msg)
932 struct OperationContext *opc;
933 struct OverlayConnectData *oc_data;
936 op_id = GNUNET_ntohll (msg->operation_id);
937 if (NULL == (opc = find_opc (c, op_id)))
939 LOG_DEBUG ("Operation not found\n");
942 if (OP_FORWARDED == opc->type)
944 handle_forwarded_operation_msg (c, opc,
945 (const struct GNUNET_MessageHeader *) msg);
948 GNUNET_assert (OP_OVERLAY_CONNECT == opc->type);
950 /* FIXME: Should spawn operations to:
951 1. Acquire configuration of peer2's controller,
952 2. link peer1's controller to peer2's controller
953 3. ask them to attempt overlay connect on peer1 and peer2 again */
954 switch (oc_data->state)
958 struct GNUNET_TESTBED_SlaveGetConfigurationMessage *get_cfg_msg;
961 GNUNET_assert (NULL == oc_data->sub_opc);
962 sub_op_id = GNUNET_TESTBED_get_next_op_id (oc_data->p1->controller);
964 GNUNET_TESTBED_generate_slavegetconfig_msg_
965 (sub_op_id, GNUNET_TESTBED_host_get_id_ (oc_data->p2->host));
966 oc_data->state = OCD_CFG_ACQUIRE;
968 GNUNET_TESTBED_forward_operation_msg_ (oc_data->p1->controller,
969 sub_op_id, &get_cfg_msg->header,
970 overlay_connect_ondemand_handler,
982 * Handler for messages from controller (testbed service)
984 * @param cls the controller handler
985 * @param msg message received, NULL on timeout or fatal error
988 message_handler (void *cls, const struct GNUNET_MessageHeader *msg)
990 struct GNUNET_TESTBED_Controller *c = cls;
994 c->in_receive = GNUNET_NO;
995 /* FIXME: Add checks for message integrity */
998 LOG_DEBUG ("Receive timed out or connection to service dropped\n");
1002 msize = ntohs (msg->size);
1003 switch (ntohs (msg->type))
1005 case GNUNET_MESSAGE_TYPE_TESTBED_ADDHOSTCONFIRM:
1006 GNUNET_assert (msize >=
1007 sizeof (struct GNUNET_TESTBED_HostConfirmedMessage));
1009 handle_addhostconfirm (c,
1010 (const struct GNUNET_TESTBED_HostConfirmedMessage
1013 case GNUNET_MESSAGE_TYPE_TESTBED_GENERICOPSUCCESS:
1014 GNUNET_assert (msize ==
1016 GNUNET_TESTBED_GenericOperationSuccessEventMessage));
1018 handle_opsuccess (c,
1020 GNUNET_TESTBED_GenericOperationSuccessEventMessage *)
1023 case GNUNET_MESSAGE_TYPE_TESTBED_PEERCREATESUCCESS:
1024 GNUNET_assert (msize ==
1026 GNUNET_TESTBED_PeerCreateSuccessEventMessage));
1028 handle_peer_create_success (c,
1030 GNUNET_TESTBED_PeerCreateSuccessEventMessage
1033 case GNUNET_MESSAGE_TYPE_TESTBED_PEEREVENT:
1034 GNUNET_assert (msize == sizeof (struct GNUNET_TESTBED_PeerEventMessage));
1036 handle_peer_event (c,
1037 (const struct GNUNET_TESTBED_PeerEventMessage *)
1041 case GNUNET_MESSAGE_TYPE_TESTBED_PEERCONFIG:
1042 GNUNET_assert (msize >=
1044 GNUNET_TESTBED_PeerConfigurationInformationMessage));
1046 handle_peer_config (c,
1048 GNUNET_TESTBED_PeerConfigurationInformationMessage
1051 case GNUNET_MESSAGE_TYPE_TESTBED_PEERCONEVENT:
1052 GNUNET_assert (msize ==
1053 sizeof (struct GNUNET_TESTBED_ConnectionEventMessage));
1055 handle_peer_conevent (c,
1057 GNUNET_TESTBED_ConnectionEventMessage *) msg);
1059 case GNUNET_MESSAGE_TYPE_TESTBED_OPERATIONFAILEVENT:
1060 GNUNET_assert (msize >=
1061 sizeof (struct GNUNET_TESTBED_OperationFailureEventMessage));
1063 handle_op_fail_event (c,
1065 GNUNET_TESTBED_OperationFailureEventMessage *)
1068 case GNUNET_MESSAGE_TYPE_TESTBED_SLAVECONFIG:
1069 GNUNET_assert (msize >
1070 sizeof (struct GNUNET_TESTBED_SlaveConfiguration));
1072 handle_slave_config (c, (const struct
1073 GNUNET_TESTBED_SlaveConfiguration *) msg);
1075 case GNUNET_MESSAGE_TYPE_TESTBED_NEEDCONTROLLERCONFIG:
1076 GNUNET_assert (msize == sizeof (struct
1077 GNUNET_TESTBED_NeedControllerConfig));
1079 handle_need_controller_config (c, (const struct
1080 GNUNET_TESTBED_NeedControllerConfig
1086 if ((GNUNET_OK == status) && (GNUNET_NO == c->in_receive))
1088 c->in_receive = GNUNET_YES;
1089 GNUNET_CLIENT_receive (c->client, &message_handler, c,
1090 GNUNET_TIME_UNIT_FOREVER_REL);
1096 * Function called to notify a client about the connection begin ready to queue
1097 * more data. "buf" will be NULL and "size" zero if the connection was closed
1098 * for writing in the meantime.
1100 * @param cls closure
1101 * @param size number of bytes available in buf
1102 * @param buf where the callee should write the message
1103 * @return number of bytes written to buf
1106 transmit_ready_notify (void *cls, size_t size, void *buf)
1108 struct GNUNET_TESTBED_Controller *c = cls;
1109 struct MessageQueue *mq_entry;
1112 mq_entry = c->mq_head;
1113 GNUNET_assert (NULL != mq_entry);
1114 if ((0 == size) && (NULL == buf)) /* Timeout */
1116 LOG_DEBUG ("Message sending timed out -- retrying\n");
1118 GNUNET_CLIENT_notify_transmit_ready (c->client,
1119 ntohs (mq_entry->msg->size),
1120 TIMEOUT_REL, GNUNET_YES,
1121 &transmit_ready_notify, c);
1124 GNUNET_assert (ntohs (mq_entry->msg->size) <= size);
1125 size = ntohs (mq_entry->msg->size);
1126 memcpy (buf, mq_entry->msg, size);
1127 LOG_DEBUG ("Message of type: %u and size: %u sent\n",
1128 ntohs (mq_entry->msg->type), size);
1129 GNUNET_free (mq_entry->msg);
1130 GNUNET_CONTAINER_DLL_remove (c->mq_head, c->mq_tail, mq_entry);
1131 GNUNET_free (mq_entry);
1132 mq_entry = c->mq_head;
1133 if (NULL != mq_entry)
1135 GNUNET_CLIENT_notify_transmit_ready (c->client,
1136 ntohs (mq_entry->msg->size),
1137 TIMEOUT_REL, GNUNET_YES,
1138 &transmit_ready_notify, c);
1139 if (GNUNET_NO == c->in_receive)
1141 c->in_receive = GNUNET_YES;
1142 GNUNET_CLIENT_receive (c->client, &message_handler, c,
1143 GNUNET_TIME_UNIT_FOREVER_REL);
1150 * Queues a message in send queue for sending to the service
1152 * @param controller the handle to the controller
1153 * @param msg the message to queue
1156 GNUNET_TESTBED_queue_message_ (struct GNUNET_TESTBED_Controller *controller,
1157 struct GNUNET_MessageHeader *msg)
1159 struct MessageQueue *mq_entry;
1163 type = ntohs (msg->type);
1164 size = ntohs (msg->size);
1165 GNUNET_assert ((GNUNET_MESSAGE_TYPE_TESTBED_INIT <= type) &&
1166 (GNUNET_MESSAGE_TYPE_TESTBED_MAX > type));
1167 mq_entry = GNUNET_malloc (sizeof (struct MessageQueue));
1168 mq_entry->msg = msg;
1169 LOG (GNUNET_ERROR_TYPE_DEBUG,
1170 "Queueing message of type %u, size %u for sending\n", type,
1172 GNUNET_CONTAINER_DLL_insert_tail (controller->mq_head, controller->mq_tail,
1174 if (NULL == controller->th)
1176 GNUNET_CLIENT_notify_transmit_ready (controller->client, size,
1177 TIMEOUT_REL, GNUNET_YES,
1178 &transmit_ready_notify,
1184 * Sends the given message as an operation. The given callback is called when a
1185 * reply for the operation is available. Call
1186 * GNUNET_TESTBED_forward_operation_msg_cancel_() to cleanup the returned
1187 * operation context if the cc hasn't been called
1189 * @param controller the controller to which the message has to be sent
1190 * @param operation_id the operation id of the message
1191 * @param msg the message to send
1192 * @param cc the callback to call when reply is available
1193 * @param cc_cls the closure for the above callback
1194 * @return the operation context which can be used to cancel the forwarded
1197 struct OperationContext *
1198 GNUNET_TESTBED_forward_operation_msg_ (struct GNUNET_TESTBED_Controller
1199 *controller, uint64_t operation_id,
1200 const struct GNUNET_MessageHeader *msg,
1201 GNUNET_CLIENT_MessageHandler cc,
1204 struct OperationContext *opc;
1205 struct ForwardedOperationData *data;
1206 struct GNUNET_MessageHeader *dup_msg;
1209 data = GNUNET_malloc (sizeof (struct ForwardedOperationData));
1211 data->cc_cls = cc_cls;
1212 opc = GNUNET_malloc (sizeof (struct OperationContext));
1213 opc->c = controller;
1214 opc->type = OP_FORWARDED;
1216 opc->id = operation_id;
1217 msize = ntohs (msg->size);
1218 dup_msg = GNUNET_malloc (msize);
1219 (void) memcpy (dup_msg, msg, msize);
1220 GNUNET_TESTBED_queue_message_ (opc->c, dup_msg);
1221 GNUNET_CONTAINER_DLL_insert_tail (controller->ocq_head, controller->ocq_tail,
1228 * Function to cancel an operation created by simply forwarding an operation
1231 * @param opc the operation context from GNUNET_TESTBED_forward_operation_msg_()
1234 GNUNET_TESTBED_forward_operation_msg_cancel_ (struct OperationContext *opc)
1236 GNUNET_CONTAINER_DLL_remove (opc->c->ocq_head, opc->c->ocq_tail, opc);
1237 GNUNET_free (opc->data);
1243 * Functions with this signature are called whenever a
1244 * complete message is received by the tokenizer.
1246 * Do not call GNUNET_SERVER_mst_destroy in callback
1248 * @param cls closure
1249 * @param client identification of the client
1250 * @param message the actual message
1252 * @return GNUNET_OK on success, GNUNET_SYSERR to stop further processing
1255 helper_mst (void *cls, void *client, const struct GNUNET_MessageHeader *message)
1257 struct GNUNET_TESTBED_ControllerProc *cp = cls;
1258 const struct GNUNET_TESTBED_HelperReply *msg;
1259 const char *hostname;
1262 uLongf xconfig_size;
1264 msg = (const struct GNUNET_TESTBED_HelperReply *) message;
1265 GNUNET_assert (sizeof (struct GNUNET_TESTBED_HelperReply) <
1266 ntohs (msg->header.size));
1267 GNUNET_assert (GNUNET_MESSAGE_TYPE_TESTBED_HELPER_REPLY ==
1268 ntohs (msg->header.type));
1269 config_size = (uLongf) ntohs (msg->config_size);
1271 (uLongf) (ntohs (msg->header.size) -
1272 sizeof (struct GNUNET_TESTBED_HelperReply));
1273 config = GNUNET_malloc (config_size);
1274 GNUNET_assert (Z_OK ==
1275 uncompress ((Bytef *) config, &config_size,
1276 (const Bytef *) &msg[1], xconfig_size));
1277 GNUNET_assert (NULL == cp->cfg);
1278 cp->cfg = GNUNET_CONFIGURATION_create ();
1279 GNUNET_assert (GNUNET_CONFIGURATION_deserialize
1280 (cp->cfg, config, config_size, GNUNET_NO));
1281 GNUNET_free (config);
1282 if ((NULL == cp->host) ||
1283 (NULL == (hostname = GNUNET_TESTBED_host_get_hostname_ (cp->host))))
1284 hostname = "localhost";
1285 /* Change the hostname so that we can connect to it */
1286 GNUNET_CONFIGURATION_set_value_string (cp->cfg, "testbed", "hostname",
1288 cp->cb (cp->cls, cp->cfg, GNUNET_OK);
1294 * Continuation function from GNUNET_HELPER_send()
1296 * @param cls closure
1297 * @param result GNUNET_OK on success,
1298 * GNUNET_NO if helper process died
1299 * GNUNET_SYSERR during GNUNET_HELPER_stop
1302 clear_msg (void *cls, int result)
1304 struct GNUNET_TESTBED_ControllerProc *cp = cls;
1306 GNUNET_assert (NULL != cp->shandle);
1308 GNUNET_free (cp->msg);
1313 * Callback that will be called when the helper process dies. This is not called
1314 * when the helper process is stoped using GNUNET_HELPER_stop()
1316 * @param cls the closure from GNUNET_HELPER_start()
1319 helper_exp_cb (void *cls)
1321 struct GNUNET_TESTBED_ControllerProc *cp = cls;
1322 GNUNET_TESTBED_ControllerStatusCallback cb;
1328 GNUNET_TESTBED_controller_stop (cp);
1330 cb (cb_cls, NULL, GNUNET_SYSERR);
1335 * Function to call to start a link-controllers type operation once all queues
1336 * the operation is part of declare that the operation can be activated.
1338 * @param cls the closure from GNUNET_TESTBED_operation_create_()
1341 opstart_link_controllers (void *cls)
1343 struct OperationContext *opc = cls;
1344 struct ControllerLinkData *data;
1345 struct GNUNET_TESTBED_ControllerLinkMessage *msg;
1347 GNUNET_assert (NULL != opc->data);
1351 opc->state = OPC_STATE_STARTED;
1352 GNUNET_CONTAINER_DLL_insert_tail (opc->c->ocq_head, opc->c->ocq_tail, opc);
1353 GNUNET_TESTBED_queue_message_ (opc->c, &msg->header);
1358 * Callback which will be called when link-controllers type operation is released
1360 * @param cls the closure from GNUNET_TESTBED_operation_create_()
1363 oprelease_link_controllers (void *cls)
1365 struct OperationContext *opc = cls;
1366 struct ControllerLinkData *data;
1371 case OPC_STATE_INIT:
1372 GNUNET_free (data->msg);
1374 case OPC_STATE_STARTED:
1375 GNUNET_CONTAINER_DLL_remove (opc->c->ocq_head, opc->c->ocq_tail, opc);
1377 case OPC_STATE_FINISHED:
1380 GNUNET_free_non_null (data);
1386 * Function to be called when get slave config operation is ready
1388 * @param cls the OperationContext of type OP_GET_SLAVE_CONFIG
1391 opstart_get_slave_config (void *cls)
1393 struct OperationContext *opc = cls;
1394 struct GetSlaveConfigData *data;
1395 struct GNUNET_TESTBED_SlaveGetConfigurationMessage *msg;
1398 msg = GNUNET_TESTBED_generate_slavegetconfig_msg_ (opc->id, data->slave_id);
1399 GNUNET_CONTAINER_DLL_insert_tail (opc->c->ocq_head, opc->c->ocq_tail, opc);
1400 GNUNET_TESTBED_queue_message_ (opc->c, &msg->header);
1401 opc->state = OPC_STATE_STARTED;
1406 * Function to be called when get slave config operation is cancelled or finished
1408 * @param cls the OperationContext of type OP_GET_SLAVE_CONFIG
1411 oprelease_get_slave_config (void *cls)
1413 struct OperationContext *opc = cls;
1417 case OPC_STATE_INIT:
1418 GNUNET_free (opc->data);
1420 case OPC_STATE_STARTED:
1421 GNUNET_free (opc->data);
1422 GNUNET_CONTAINER_DLL_remove (opc->c->ocq_head, opc->c->ocq_tail, opc);
1424 case OPC_STATE_FINISHED:
1425 if (NULL != opc->data)
1426 GNUNET_CONFIGURATION_destroy (opc->data);
1434 * Starts a controller process at the host. FIXME: add controller start callback
1435 * with the configuration with which the controller is started
1437 * @param controller_ip the ip address of the controller. Will be set as TRUSTED
1438 * host when starting testbed controller at host
1439 * @param host the host where the controller has to be started; NULL for
1441 * @param cfg template configuration to use for the remote controller; the
1442 * remote controller will be started with a slightly modified
1443 * configuration (port numbers, unix domain sockets and service home
1444 * values are changed as per TESTING library on the remote host)
1445 * @param cb function called when the controller is successfully started or
1446 * dies unexpectedly; GNUNET_TESTBED_controller_stop shouldn't be
1447 * called if cb is called with GNUNET_SYSERR as status. Will never be
1448 * called in the same task as 'GNUNET_TESTBED_controller_start'
1449 * (synchronous errors will be signalled by returning NULL). This
1450 * parameter cannot be NULL.
1451 * @param cls closure for above callbacks
1452 * @return the controller process handle, NULL on errors
1454 struct GNUNET_TESTBED_ControllerProc *
1455 GNUNET_TESTBED_controller_start (const char *controller_ip,
1456 struct GNUNET_TESTBED_Host *host,
1457 const struct GNUNET_CONFIGURATION_Handle *cfg,
1458 GNUNET_TESTBED_ControllerStatusCallback cb,
1461 struct GNUNET_TESTBED_ControllerProc *cp;
1462 struct GNUNET_TESTBED_HelperInit *msg;
1463 const char *hostname;
1464 static char *const binary_argv[] = {
1465 HELPER_TESTBED_BINARY, NULL
1469 cp = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_ControllerProc));
1470 if ((NULL == host) || (0 == GNUNET_TESTBED_host_get_id_ (host)))
1472 GNUNET_HELPER_start (GNUNET_YES, HELPER_TESTBED_BINARY, binary_argv,
1473 &helper_mst, &helper_exp_cb, cp);
1476 char *remote_args[8];
1478 const char *username;
1480 username = GNUNET_TESTBED_host_get_username_ (host);
1481 hostname = GNUNET_TESTBED_host_get_hostname_ (host);
1482 GNUNET_asprintf (&cp->port, "%u", GNUNET_TESTBED_host_get_ssh_port_ (host));
1483 if (NULL == username)
1484 GNUNET_asprintf (&cp->dst, "%s", hostname);
1486 GNUNET_asprintf (&cp->dst, "%s@%s", username, hostname);
1487 LOG_DEBUG ("Starting SSH to destination %s\n", cp->dst);
1489 remote_args[argp++] = "ssh";
1490 remote_args[argp++] = "-p";
1491 remote_args[argp++] = cp->port;
1492 remote_args[argp++] = "-o";
1493 remote_args[argp++] = "BatchMode=yes";
1494 remote_args[argp++] = cp->dst;
1495 remote_args[argp++] = HELPER_TESTBED_BINARY_SSH;
1496 remote_args[argp++] = NULL;
1497 GNUNET_assert (argp == 8);
1499 GNUNET_HELPER_start (GNUNET_NO, "ssh", remote_args, &helper_mst,
1500 &helper_exp_cb, cp);
1502 if (NULL == cp->helper)
1504 GNUNET_free_non_null (cp->port);
1505 GNUNET_free_non_null (cp->dst);
1512 msg = GNUNET_TESTBED_create_helper_init_msg_ (controller_ip, hostname, cfg);
1513 cp->msg = &msg->header;
1515 GNUNET_HELPER_send (cp->helper, &msg->header, GNUNET_NO, &clear_msg, cp);
1516 if (NULL == cp->shandle)
1519 GNUNET_TESTBED_controller_stop (cp);
1527 * Stop the controller process (also will terminate all peers and controllers
1528 * dependent on this controller). This function blocks until the testbed has
1529 * been fully terminated (!). The controller status cb from
1530 * GNUNET_TESTBED_controller_start() will not be called.
1532 * @param cproc the controller process handle
1535 GNUNET_TESTBED_controller_stop (struct GNUNET_TESTBED_ControllerProc *cproc)
1537 if (NULL != cproc->shandle)
1538 GNUNET_HELPER_send_cancel (cproc->shandle);
1539 if (NULL != cproc->helper)
1540 GNUNET_HELPER_stop (cproc->helper);
1541 if (NULL != cproc->cfg)
1542 GNUNET_CONFIGURATION_destroy (cproc->cfg);
1543 GNUNET_free_non_null (cproc->port);
1544 GNUNET_free_non_null (cproc->dst);
1545 GNUNET_free (cproc);
1550 * Start a controller process using the given configuration at the
1553 * @param cfg configuration to use
1554 * @param host host to run the controller on; This should be the same host if
1555 * the controller was previously started with
1556 * GNUNET_TESTBED_controller_start; NULL for localhost
1557 * @param event_mask bit mask with set of events to call 'cc' for;
1558 * or-ed values of "1LL" shifted by the
1559 * respective 'enum GNUNET_TESTBED_EventType'
1560 * (i.e. "(1LL << GNUNET_TESTBED_ET_CONNECT) | ...")
1561 * @param cc controller callback to invoke on events
1562 * @param cc_cls closure for cc
1563 * @return handle to the controller
1565 struct GNUNET_TESTBED_Controller *
1566 GNUNET_TESTBED_controller_connect (const struct GNUNET_CONFIGURATION_Handle
1567 *cfg, struct GNUNET_TESTBED_Host *host,
1568 uint64_t event_mask,
1569 GNUNET_TESTBED_ControllerCallback cc,
1572 struct GNUNET_TESTBED_Controller *controller;
1573 struct GNUNET_TESTBED_InitMessage *msg;
1574 const char *controller_hostname;
1575 unsigned long long max_parallel_operations;
1576 unsigned long long max_parallel_service_connections;
1577 unsigned long long max_parallel_topology_config_operations;
1580 GNUNET_CONFIGURATION_get_value_number (cfg, "testbed",
1581 "MAX_PARALLEL_OPERATIONS",
1582 &max_parallel_operations))
1588 GNUNET_CONFIGURATION_get_value_number (cfg, "testbed",
1589 "MAX_PARALLEL_SERVICE_CONNECTIONS",
1590 &max_parallel_service_connections))
1596 GNUNET_CONFIGURATION_get_value_number (cfg, "testbed",
1597 "MAX_PARALLEL_TOPOLOGY_CONFIG_OPERATIONS",
1598 &max_parallel_topology_config_operations))
1603 controller = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_Controller));
1604 controller->cc = cc;
1605 controller->cc_cls = cc_cls;
1606 controller->event_mask = event_mask;
1607 controller->cfg = GNUNET_CONFIGURATION_dup (cfg);
1608 controller->client = GNUNET_CLIENT_connect ("testbed", controller->cfg);
1609 if (NULL == controller->client)
1611 GNUNET_TESTBED_controller_disconnect (controller);
1616 host = GNUNET_TESTBED_host_create_by_id_ (0);
1617 if (NULL == host) /* If the above host create fails */
1619 LOG (GNUNET_ERROR_TYPE_WARNING,
1620 "Treating NULL host as localhost. Multiple references to localhost "
1621 "may break when localhost freed before calling disconnect \n");
1622 host = GNUNET_TESTBED_host_lookup_by_id_ (0);
1626 controller->aux_host = GNUNET_YES;
1629 GNUNET_assert (NULL != host);
1630 GNUNET_TESTBED_mark_host_registered_at_ (host, controller);
1631 controller->host = host;
1632 controller->opq_parallel_operations =
1633 GNUNET_TESTBED_operation_queue_create_ ((unsigned int)
1634 max_parallel_operations);
1635 controller->opq_parallel_service_connections =
1636 GNUNET_TESTBED_operation_queue_create_ ((unsigned int)
1637 max_parallel_service_connections);
1638 controller->opq_parallel_topology_config_operations=
1639 GNUNET_TESTBED_operation_queue_create_ ((unsigned int)
1640 max_parallel_service_connections);
1641 controller_hostname = GNUNET_TESTBED_host_get_hostname_ (host);
1642 if (NULL == controller_hostname)
1643 controller_hostname = "127.0.0.1";
1645 GNUNET_malloc (sizeof (struct GNUNET_TESTBED_InitMessage) +
1646 strlen (controller_hostname) + 1);
1647 msg->header.type = htons (GNUNET_MESSAGE_TYPE_TESTBED_INIT);
1649 htons (sizeof (struct GNUNET_TESTBED_InitMessage) +
1650 strlen (controller_hostname) + 1);
1651 msg->host_id = htonl (GNUNET_TESTBED_host_get_id_ (host));
1652 msg->event_mask = GNUNET_htonll (controller->event_mask);
1653 strcpy ((char *) &msg[1], controller_hostname);
1654 GNUNET_TESTBED_queue_message_ (controller,
1655 (struct GNUNET_MessageHeader *) msg);
1661 * Configure shared services at a controller. Using this function,
1662 * you can specify that certain services (such as "resolver")
1663 * should not be run for each peer but instead be shared
1664 * across N peers on the specified host. This function
1665 * must be called before any peers are created at the host.
1667 * @param controller controller to configure
1668 * @param service_name name of the service to share
1669 * @param num_peers number of peers that should share one instance
1670 * of the specified service (1 for no sharing is the default),
1671 * use 0 to disable the service
1674 GNUNET_TESTBED_controller_configure_sharing (struct GNUNET_TESTBED_Controller
1676 const char *service_name,
1679 struct GNUNET_TESTBED_ConfigureSharedServiceMessage *msg;
1680 uint16_t service_name_size;
1683 service_name_size = strlen (service_name) + 1;
1685 sizeof (struct GNUNET_TESTBED_ConfigureSharedServiceMessage) +
1687 msg = GNUNET_malloc (msg_size);
1688 msg->header.size = htons (msg_size);
1689 msg->header.type = htons (GNUNET_MESSAGE_TYPE_TESTBED_SERVICESHARE);
1690 msg->host_id = htonl (GNUNET_TESTBED_host_get_id_ (controller->host));
1691 msg->num_peers = htonl (num_peers);
1692 memcpy (&msg[1], service_name, service_name_size);
1693 GNUNET_TESTBED_queue_message_ (controller,
1694 (struct GNUNET_MessageHeader *) msg);
1699 * disconnects from the controller.
1701 * @param controller handle to controller to stop
1704 GNUNET_TESTBED_controller_disconnect (struct GNUNET_TESTBED_Controller
1707 struct MessageQueue *mq_entry;
1709 if (NULL != controller->th)
1710 GNUNET_CLIENT_notify_transmit_ready_cancel (controller->th);
1711 /* Clear the message queue */
1712 while (NULL != (mq_entry = controller->mq_head))
1714 GNUNET_CONTAINER_DLL_remove (controller->mq_head, controller->mq_tail,
1716 GNUNET_free (mq_entry->msg);
1717 GNUNET_free (mq_entry);
1719 if (NULL != controller->client)
1720 GNUNET_CLIENT_disconnect (controller->client);
1721 GNUNET_CONFIGURATION_destroy (controller->cfg);
1722 if (GNUNET_YES == controller->aux_host)
1723 GNUNET_TESTBED_host_destroy (controller->host);
1724 GNUNET_TESTBED_operation_queue_destroy_ (controller->opq_parallel_operations);
1725 GNUNET_TESTBED_operation_queue_destroy_
1726 (controller->opq_parallel_service_connections);
1727 GNUNET_TESTBED_operation_queue_destroy_
1728 (controller->opq_parallel_topology_config_operations);
1729 GNUNET_free (controller);
1734 * Register a host with the controller
1736 * @param controller the controller handle
1737 * @param host the host to register
1738 * @param cc the completion callback to call to inform the status of
1739 * registration. After calling this callback the registration handle
1740 * will be invalid. Cannot be NULL.
1741 * @param cc_cls the closure for the cc
1742 * @return handle to the host registration which can be used to cancel the
1745 struct GNUNET_TESTBED_HostRegistrationHandle *
1746 GNUNET_TESTBED_register_host (struct GNUNET_TESTBED_Controller *controller,
1747 struct GNUNET_TESTBED_Host *host,
1748 GNUNET_TESTBED_HostRegistrationCompletion cc,
1751 struct GNUNET_TESTBED_HostRegistrationHandle *rh;
1752 struct GNUNET_TESTBED_AddHostMessage *msg;
1753 const char *username;
1754 const char *hostname;
1756 uint16_t user_name_length;
1758 if (NULL != controller->rh)
1760 hostname = GNUNET_TESTBED_host_get_hostname_ (host);
1761 if (GNUNET_YES == GNUNET_TESTBED_is_host_registered_ (host, controller))
1763 LOG (GNUNET_ERROR_TYPE_WARNING, "Host hostname: %s already registered\n",
1764 (NULL == hostname) ? "localhost" : hostname);
1767 rh = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_HostRegistrationHandle));
1770 GNUNET_assert (NULL != cc);
1772 rh->cc_cls = cc_cls;
1773 controller->rh = rh;
1774 username = GNUNET_TESTBED_host_get_username_ (host);
1775 msg_size = (sizeof (struct GNUNET_TESTBED_AddHostMessage));
1776 user_name_length = 0;
1777 if (NULL != username)
1779 user_name_length = strlen (username) + 1;
1780 msg_size += user_name_length;
1782 /* FIXME: what happens when hostname is NULL? localhost */
1783 GNUNET_assert (NULL != hostname);
1784 msg_size += strlen (hostname) + 1;
1785 msg = GNUNET_malloc (msg_size);
1786 msg->header.size = htons (msg_size);
1787 msg->header.type = htons (GNUNET_MESSAGE_TYPE_TESTBED_ADDHOST);
1788 msg->host_id = htonl (GNUNET_TESTBED_host_get_id_ (host));
1789 msg->ssh_port = htons (GNUNET_TESTBED_host_get_ssh_port_ (host));
1790 msg->user_name_length = htons (user_name_length);
1791 if (NULL != username)
1792 memcpy (&msg[1], username, user_name_length);
1793 strcpy (((void *) &msg[1]) + user_name_length, hostname);
1794 GNUNET_TESTBED_queue_message_ (controller,
1795 (struct GNUNET_MessageHeader *) msg);
1801 * Cancel the pending registration. Note that if the registration message is
1802 * already sent to the service the cancellation has only the effect that the
1803 * registration completion callback for the registration is never called.
1805 * @param handle the registration handle to cancel
1808 GNUNET_TESTBED_cancel_registration (struct GNUNET_TESTBED_HostRegistrationHandle
1811 if (handle != handle->c->rh)
1816 handle->c->rh = NULL;
1817 GNUNET_free (handle);
1822 * Same as the GNUNET_TESTBED_controller_link, however expects configuration in
1823 * serialized and compressed
1825 * @param op_cls the operation closure for the event which is generated to
1826 * signal success or failure of this operation
1827 * @param master handle to the master controller who creates the association
1828 * @param delegated_host requests to which host should be delegated; cannot be NULL
1829 * @param slave_host which host is used to run the slave controller; use NULL to
1830 * make the master controller connect to the delegated host
1831 * @param sxcfg serialized and compressed configuration
1832 * @param sxcfg_size the size sxcfg
1833 * @param scfg_size the size of uncompressed serialized configuration
1834 * @param is_subordinate GNUNET_YES if the controller at delegated_host should
1835 * be started by the slave controller; GNUNET_NO if the slave
1836 * controller has to connect to the already started delegated
1837 * controller via TCP/IP
1838 * @return the operation handle
1840 struct GNUNET_TESTBED_Operation *
1841 GNUNET_TESTBED_controller_link_2_ (void *op_cls,
1842 struct GNUNET_TESTBED_Controller *master,
1843 uint32_t delegated_host_id,
1844 uint32_t slave_host_id,
1845 const char *sxcfg, size_t sxcfg_size,
1846 size_t scfg_size, int is_subordinate)
1848 struct OperationContext *opc;
1849 struct GNUNET_TESTBED_ControllerLinkMessage *msg;
1850 struct ControllerLinkData *data;
1853 msg_size = sxcfg_size + sizeof (struct GNUNET_TESTBED_ControllerLinkMessage);
1854 msg = GNUNET_malloc (msg_size);
1855 msg->header.type = htons (GNUNET_MESSAGE_TYPE_TESTBED_LCONTROLLERS);
1856 msg->header.size = htons (msg_size);
1857 msg->delegated_host_id = htonl (delegated_host_id);
1858 msg->slave_host_id = htonl (slave_host_id);
1859 msg->config_size = htons ((uint16_t) scfg_size);
1860 msg->is_subordinate = (GNUNET_YES == is_subordinate) ? 1 : 0;
1861 memcpy (&msg[1], sxcfg, sxcfg_size);
1862 data = GNUNET_malloc (sizeof (struct ControllerLinkData));
1864 data->op_cls = op_cls;
1865 opc = GNUNET_malloc (sizeof (struct OperationContext));
1868 opc->type = OP_LINK_CONTROLLERS;
1869 opc->id = GNUNET_TESTBED_get_next_op_id (opc->c);
1870 opc->state = OPC_STATE_INIT;
1871 msg->operation_id = GNUNET_htonll (opc->id);
1873 GNUNET_TESTBED_operation_create_ (opc, &opstart_link_controllers,
1874 &oprelease_link_controllers);
1875 GNUNET_TESTBED_operation_queue_insert_ (master->opq_parallel_operations,
1882 * Same as the GNUNET_TESTBED_controller_link, however expects configuration in
1883 * serialized and compressed
1885 * @param op_cls the operation closure for the event which is generated to
1886 * signal success or failure of this operation
1887 * @param master handle to the master controller who creates the association
1888 * @param delegated_host requests to which host should be delegated; cannot be NULL
1889 * @param slave_host which host is used to run the slave controller; use NULL to
1890 * make the master controller connect to the delegated host
1891 * @param sxcfg serialized and compressed configuration
1892 * @param sxcfg_size the size sxcfg
1893 * @param scfg_size the size of uncompressed serialized configuration
1894 * @param is_subordinate GNUNET_YES if the controller at delegated_host should
1895 * be started by the slave controller; GNUNET_NO if the slave
1896 * controller has to connect to the already started delegated
1897 * controller via TCP/IP
1898 * @return the operation handle
1900 struct GNUNET_TESTBED_Operation *
1901 GNUNET_TESTBED_controller_link_2 (void *op_cls,
1902 struct GNUNET_TESTBED_Controller *master,
1903 struct GNUNET_TESTBED_Host *delegated_host,
1904 struct GNUNET_TESTBED_Host *slave_host,
1905 const char *sxcfg, size_t sxcfg_size,
1906 size_t scfg_size, int is_subordinate)
1908 uint32_t delegated_host_id;
1909 uint32_t slave_host_id;
1911 GNUNET_assert (GNUNET_YES ==
1912 GNUNET_TESTBED_is_host_registered_ (delegated_host, master));
1913 delegated_host_id = GNUNET_TESTBED_host_get_id_ (delegated_host);
1915 GNUNET_TESTBED_host_get_id_ ((NULL != slave_host)
1916 ? slave_host : master->host);
1917 if ((NULL != slave_host) && (0 != GNUNET_TESTBED_host_get_id_ (slave_host)))
1918 GNUNET_assert (GNUNET_YES ==
1919 GNUNET_TESTBED_is_host_registered_ (slave_host, master));
1921 return GNUNET_TESTBED_controller_link_2_ (op_cls,
1926 scfg_size, is_subordinate);
1932 * Compresses given configuration using zlib compress
1934 * @param config the serialized configuration
1935 * @param size the size of config
1936 * @param xconfig will be set to the compressed configuration (memory is fresly
1938 * @return the size of the xconfig
1941 GNUNET_TESTBED_compress_config_ (const char *config, size_t size,
1946 xsize = compressBound ((uLong) size);
1947 *xconfig = GNUNET_malloc (xsize);
1948 GNUNET_assert (Z_OK ==
1949 compress2 ((Bytef *) * xconfig, (uLongf *) & xsize,
1950 (const Bytef *) config, (uLongf) size,
1957 * Create a link from slave controller to delegated controller. Whenever the
1958 * master controller is asked to start a peer at the delegated controller the
1959 * request will be routed towards slave controller (if a route exists). The
1960 * slave controller will then route it to the delegated controller. The
1961 * configuration of the delegated controller is given and is used to either
1962 * create the delegated controller or to connect to an existing controller. Note
1963 * that while starting the delegated controller the configuration will be
1964 * modified to accommodate available free ports. the 'is_subordinate' specifies
1965 * if the given delegated controller should be started and managed by the slave
1966 * controller, or if the delegated controller already has a master and the slave
1967 * controller connects to it as a non master controller. The success or failure
1968 * of this operation will be signalled through the
1969 * GNUNET_TESTBED_ControllerCallback() with an event of type
1970 * GNUNET_TESTBED_ET_OPERATION_FINISHED
1972 * @param op_cls the operation closure for the event which is generated to
1973 * signal success or failure of this operation
1974 * @param master handle to the master controller who creates the association
1975 * @param delegated_host requests to which host should be delegated; cannot be NULL
1976 * @param slave_host which host is used to run the slave controller; use NULL to
1977 * make the master controller connect to the delegated host
1978 * @param slave_cfg configuration to use for the slave controller
1979 * @param is_subordinate GNUNET_YES if the controller at delegated_host should
1980 * be started by the slave controller; GNUNET_NO if the slave
1981 * controller has to connect to the already started delegated
1982 * controller via TCP/IP
1983 * @return the operation handle
1985 struct GNUNET_TESTBED_Operation *
1986 GNUNET_TESTBED_controller_link (void *op_cls,
1987 struct GNUNET_TESTBED_Controller *master,
1988 struct GNUNET_TESTBED_Host *delegated_host,
1989 struct GNUNET_TESTBED_Host *slave_host,
1990 const struct GNUNET_CONFIGURATION_Handle
1991 *slave_cfg, int is_subordinate)
1993 struct GNUNET_TESTBED_Operation *op;
1999 GNUNET_assert (GNUNET_YES ==
2000 GNUNET_TESTBED_is_host_registered_ (delegated_host, master));
2001 if ((NULL != slave_host) && (0 != GNUNET_TESTBED_host_get_id_ (slave_host)))
2002 GNUNET_assert (GNUNET_YES ==
2003 GNUNET_TESTBED_is_host_registered_ (slave_host, master));
2004 config = GNUNET_CONFIGURATION_serialize (slave_cfg, &config_size);
2005 cc_size = GNUNET_TESTBED_compress_config_ (config, config_size, &cconfig);
2006 GNUNET_free (config);
2007 /* Configuration doesn't fit in 1 message */
2008 GNUNET_assert ((UINT16_MAX -
2009 sizeof (struct GNUNET_TESTBED_ControllerLinkMessage)) >= cc_size);
2010 op = GNUNET_TESTBED_controller_link_2 (op_cls, master, delegated_host,
2011 slave_host, (const char *) cconfig,
2012 cc_size, config_size, is_subordinate);
2013 GNUNET_free (cconfig);
2019 * Like GNUNET_TESTBED_get_slave_config(), however without the host registration
2020 * check. Another difference is that this function takes the id of the slave
2023 * @param op_cls the closure for the operation
2024 * @param master the handle to master controller
2025 * @param slave_host the host where the slave controller is running; the handle
2026 * to the slave_host should remain valid until this operation is
2027 * cancelled or marked as finished
2028 * @return the operation handle;
2030 struct GNUNET_TESTBED_Operation *
2031 GNUNET_TESTBED_get_slave_config_ (void *op_cls,
2032 struct GNUNET_TESTBED_Controller *master,
2033 uint32_t slave_host_id)
2035 struct OperationContext *opc;
2036 struct GetSlaveConfigData *data;
2038 data = GNUNET_malloc (sizeof (struct GetSlaveConfigData));
2039 data->slave_id = slave_host_id;
2040 data->op_cls = op_cls;
2041 opc = GNUNET_malloc (sizeof (struct OperationContext));
2042 opc->state = OPC_STATE_INIT;
2044 opc->id = GNUNET_TESTBED_get_next_op_id (master);
2045 opc->type = OP_GET_SLAVE_CONFIG;
2048 GNUNET_TESTBED_operation_create_ (opc, &opstart_get_slave_config,
2049 &oprelease_get_slave_config);
2050 GNUNET_TESTBED_operation_queue_insert_ (master->opq_parallel_operations,
2057 * Function to acquire the configuration of a running slave controller. The
2058 * completion of the operation is signalled through the controller_cb from
2059 * GNUNET_TESTBED_controller_connect(). If the operation is successful the
2060 * handle to the configuration is available in the generic pointer of
2061 * operation_finished field of struct GNUNET_TESTBED_EventInformation.
2063 * @param op_cls the closure for the operation
2064 * @param master the handle to master controller
2065 * @param slave_host the host where the slave controller is running; the handle
2066 * to the slave_host should remain valid until this operation is
2067 * cancelled or marked as finished
2068 * @return the operation handle; NULL if the slave_host is not registered at
2071 struct GNUNET_TESTBED_Operation *
2072 GNUNET_TESTBED_get_slave_config (void *op_cls,
2073 struct GNUNET_TESTBED_Controller *master,
2074 struct GNUNET_TESTBED_Host *slave_host)
2076 if (GNUNET_NO == GNUNET_TESTBED_is_host_registered_ (slave_host, master))
2078 return GNUNET_TESTBED_get_slave_config_ (op_cls, master,
2079 GNUNET_TESTBED_host_get_id_ (slave_host));
2084 * Ask the testbed controller to write the current overlay topology to
2085 * a file. Naturally, the file will only contain a snapshot as the
2086 * topology may evolve all the time.
2088 * @param controller overlay controller to inspect
2089 * @param filename name of the file the topology should
2093 GNUNET_TESTBED_overlay_write_topology_to_file (struct GNUNET_TESTBED_Controller
2095 const char *filename)
2102 * Creates a helper initialization message. This function is here because we
2103 * want to use this in testing
2105 * @param cname the ip address of the controlling host
2106 * @param hostname the hostname of the destination this message is intended for
2107 * @param cfg the configuration that has to used to start the testbed service
2109 * @return the initialization message
2111 struct GNUNET_TESTBED_HelperInit *
2112 GNUNET_TESTBED_create_helper_init_msg_ (const char *cname,
2113 const char *hostname,
2114 const struct GNUNET_CONFIGURATION_Handle
2117 struct GNUNET_TESTBED_HelperInit *msg;
2121 size_t xconfig_size;
2123 uint16_t hostname_len;
2126 config = GNUNET_CONFIGURATION_serialize (cfg, &config_size);
2127 GNUNET_assert (NULL != config);
2129 GNUNET_TESTBED_compress_config_ (config, config_size, &xconfig);
2130 GNUNET_free (config);
2131 cname_len = strlen (cname);
2132 hostname_len = (NULL == hostname) ? 0 : strlen (hostname);
2134 xconfig_size + cname_len + 1 + sizeof (struct GNUNET_TESTBED_HelperInit);
2135 msg_size += hostname_len;
2136 msg = GNUNET_realloc (xconfig, msg_size);
2137 (void) memmove (((void *) &msg[1]) + cname_len + 1 + hostname_len,
2140 msg->header.size = htons (msg_size);
2141 msg->header.type = htons (GNUNET_MESSAGE_TYPE_TESTBED_HELPER_INIT);
2142 msg->cname_size = htons (cname_len);
2143 msg->hostname_size = htons (hostname_len);
2144 msg->config_size = htons (config_size);
2145 (void) strcpy ((char *) &msg[1], cname);
2146 if (0 != hostname_len)
2147 (void) strncpy (((char *) &msg[1]) + cname_len + 1, hostname, hostname_len);
2153 * Cancel a pending operation. Releases all resources
2154 * of the operation and will ensure that no event
2155 * is generated for the operation. Does NOT guarantee
2156 * that the operation will be fully undone (or that
2157 * nothing ever happened).
2159 * @param operation operation to cancel
2162 GNUNET_TESTBED_operation_cancel (struct GNUNET_TESTBED_Operation *operation)
2164 GNUNET_TESTBED_operation_done (operation);
2169 * Signal that the information from an operation has been fully
2170 * processed. This function MUST be called for each event
2171 * of type 'operation_finished' to fully remove the operation
2172 * from the operation queue. After calling this function, the
2173 * 'op_result' becomes invalid (!).
2175 * @param operation operation to signal completion for
2178 GNUNET_TESTBED_operation_done (struct GNUNET_TESTBED_Operation *operation)
2180 switch (operation->type)
2182 case OP_PEER_CREATE:
2183 case OP_PEER_DESTROY:
2187 case OP_OVERLAY_CONNECT:
2188 case OP_LINK_CONTROLLERS:
2189 GNUNET_TESTBED_operation_release_ (operation);
2199 * Generates configuration by uncompressing configuration in given message. The
2200 * given message should be of the following types:
2201 * GNUNET_MESSAGE_TYPE_TESTBED_PEERCONFIG,
2202 * GNUNET_MESSAGE_TYPE_TESTBED_SLAVECONFIG
2204 * @param msg the message containing compressed configuration
2205 * @return handle to the parsed configuration
2207 struct GNUNET_CONFIGURATION_Handle *
2208 GNUNET_TESTBED_extract_config_ (const struct GNUNET_MessageHeader *msg)
2210 struct GNUNET_CONFIGURATION_Handle *cfg;
2217 switch (ntohs (msg->type))
2219 case GNUNET_MESSAGE_TYPE_TESTBED_PEERCONFIG:
2221 const struct GNUNET_TESTBED_PeerConfigurationInformationMessage *imsg;
2223 imsg = (const struct GNUNET_TESTBED_PeerConfigurationInformationMessage *)
2225 data_len = (uLong) ntohs (imsg->config_size);
2226 xdata_len = ntohs (imsg->header.size)
2227 - sizeof (struct GNUNET_TESTBED_PeerConfigurationInformationMessage);
2228 xdata = (const Bytef *) &imsg[1];
2231 case GNUNET_MESSAGE_TYPE_TESTBED_SLAVECONFIG:
2233 const struct GNUNET_TESTBED_SlaveConfiguration *imsg;
2235 imsg = (const struct GNUNET_TESTBED_SlaveConfiguration *) msg;
2236 data_len = (uLong) ntohs (imsg->config_size);
2237 xdata_len = ntohs (imsg->header.size)
2238 - sizeof (struct GNUNET_TESTBED_SlaveConfiguration);
2239 xdata = (const Bytef *) &imsg[1];
2245 data = GNUNET_malloc (data_len);
2248 uncompress (data, &data_len, xdata, xdata_len)))
2250 cfg = GNUNET_CONFIGURATION_create ();
2251 GNUNET_assert (GNUNET_OK ==
2252 GNUNET_CONFIGURATION_deserialize (cfg, (const char *) data,
2261 * Checks the integrity of the OperationFailureEventMessage and if good returns
2262 * the error message it contains.
2264 * @param msg the OperationFailureEventMessage
2265 * @return the error message
2268 GNUNET_TESTBED_parse_error_string_ (const struct
2269 GNUNET_TESTBED_OperationFailureEventMessage
2275 msize = ntohs (msg->header.size);
2276 if (sizeof (struct GNUNET_TESTBED_OperationFailureEventMessage) >= msize)
2278 msize -= sizeof (struct GNUNET_TESTBED_OperationFailureEventMessage);
2279 emsg = (const char *) &msg[1];
2280 if ('\0' != emsg[msize - 1])
2290 * Function to return the operation id for a controller. The operation id is
2291 * created from the controllers host id and its internal operation counter.
2293 * @param controller the handle to the controller whose operation id has to be incremented
2294 * @return the incremented operation id.
2297 GNUNET_TESTBED_get_next_op_id (struct GNUNET_TESTBED_Controller *controller)
2301 op_id = (uint64_t) GNUNET_TESTBED_host_get_id_ (controller->host);
2302 op_id = op_id << 32;
2303 op_id |= (uint64_t) controller->operation_counter++;
2307 /* end of testbed_api.c */