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 * Handler for GNUNET_MESSAGE_TYPE_TESTBED_SLAVECONFIG message from controller
816 * @param c the controller handler
817 * @param msg message received
818 * @return GNUNET_YES if we can continue receiving from service; GNUNET_NO if
822 handle_slave_config (struct GNUNET_TESTBED_Controller *c,
823 const struct GNUNET_TESTBED_SlaveConfiguration * msg)
825 struct OperationContext *opc;
828 struct GNUNET_TESTBED_EventInformation event;
830 op_id = GNUNET_ntohll (msg->operation_id);
831 if (NULL == (opc = find_opc (c, op_id)))
833 LOG_DEBUG ("Operation not found\n");
836 if (OP_GET_SLAVE_CONFIG != opc->type)
841 op_cls = ((struct GetSlaveConfigData *) opc->data)->op_cls;
842 GNUNET_free (opc->data);
844 opc->state = OPC_STATE_FINISHED;
845 GNUNET_CONTAINER_DLL_remove (opc->c->ocq_head, opc->c->ocq_tail, opc);
846 if ((0 != (GNUNET_TESTBED_ET_OPERATION_FINISHED & c->event_mask)) &&
849 opc->data = GNUNET_TESTBED_extract_config_ (&msg->header);
850 event.type = GNUNET_TESTBED_ET_OPERATION_FINISHED;
851 event.details.operation_finished.generic = opc->data;
852 event.details.operation_finished.operation = opc->op;
853 event.details.operation_finished.op_cls = op_cls;
854 event.details.operation_finished.emsg = NULL;
855 c->cc (c->cc_cls, &event);
862 * Handler for messages from controller (testbed service)
864 * @param cls the controller handler
865 * @param msg message received, NULL on timeout or fatal error
868 message_handler (void *cls, const struct GNUNET_MessageHeader *msg)
870 struct GNUNET_TESTBED_Controller *c = cls;
874 c->in_receive = GNUNET_NO;
875 /* FIXME: Add checks for message integrity */
878 LOG_DEBUG ("Receive timed out or connection to service dropped\n");
882 msize = ntohs (msg->size);
883 switch (ntohs (msg->type))
885 case GNUNET_MESSAGE_TYPE_TESTBED_ADDHOSTCONFIRM:
886 GNUNET_assert (msize >=
887 sizeof (struct GNUNET_TESTBED_HostConfirmedMessage));
889 handle_addhostconfirm (c,
890 (const struct GNUNET_TESTBED_HostConfirmedMessage
893 case GNUNET_MESSAGE_TYPE_TESTBED_GENERICOPSUCCESS:
894 GNUNET_assert (msize ==
896 GNUNET_TESTBED_GenericOperationSuccessEventMessage));
900 GNUNET_TESTBED_GenericOperationSuccessEventMessage *)
903 case GNUNET_MESSAGE_TYPE_TESTBED_PEERCREATESUCCESS:
904 GNUNET_assert (msize ==
906 GNUNET_TESTBED_PeerCreateSuccessEventMessage));
908 handle_peer_create_success (c,
910 GNUNET_TESTBED_PeerCreateSuccessEventMessage
913 case GNUNET_MESSAGE_TYPE_TESTBED_PEEREVENT:
914 GNUNET_assert (msize == sizeof (struct GNUNET_TESTBED_PeerEventMessage));
916 handle_peer_event (c,
917 (const struct GNUNET_TESTBED_PeerEventMessage *)
921 case GNUNET_MESSAGE_TYPE_TESTBED_PEERCONFIG:
922 GNUNET_assert (msize >=
924 GNUNET_TESTBED_PeerConfigurationInformationMessage));
926 handle_peer_config (c,
928 GNUNET_TESTBED_PeerConfigurationInformationMessage
931 case GNUNET_MESSAGE_TYPE_TESTBED_PEERCONEVENT:
932 GNUNET_assert (msize ==
933 sizeof (struct GNUNET_TESTBED_ConnectionEventMessage));
935 handle_peer_conevent (c,
937 GNUNET_TESTBED_ConnectionEventMessage *) msg);
939 case GNUNET_MESSAGE_TYPE_TESTBED_OPERATIONFAILEVENT:
940 GNUNET_assert (msize >=
941 sizeof (struct GNUNET_TESTBED_OperationFailureEventMessage));
943 handle_op_fail_event (c,
945 GNUNET_TESTBED_OperationFailureEventMessage *)
948 case GNUNET_MESSAGE_TYPE_TESTBED_SLAVECONFIG:
949 GNUNET_assert (msize >
950 sizeof (struct GNUNET_TESTBED_SlaveConfiguration));
952 handle_slave_config (c, (const struct
953 GNUNET_TESTBED_SlaveConfiguration *) msg);
958 if ((GNUNET_OK == status) && (GNUNET_NO == c->in_receive))
960 c->in_receive = GNUNET_YES;
961 GNUNET_CLIENT_receive (c->client, &message_handler, c,
962 GNUNET_TIME_UNIT_FOREVER_REL);
968 * Function called to notify a client about the connection begin ready to queue
969 * more data. "buf" will be NULL and "size" zero if the connection was closed
970 * for writing in the meantime.
973 * @param size number of bytes available in buf
974 * @param buf where the callee should write the message
975 * @return number of bytes written to buf
978 transmit_ready_notify (void *cls, size_t size, void *buf)
980 struct GNUNET_TESTBED_Controller *c = cls;
981 struct MessageQueue *mq_entry;
984 mq_entry = c->mq_head;
985 GNUNET_assert (NULL != mq_entry);
986 if ((0 == size) && (NULL == buf)) /* Timeout */
988 LOG_DEBUG ("Message sending timed out -- retrying\n");
990 GNUNET_CLIENT_notify_transmit_ready (c->client,
991 ntohs (mq_entry->msg->size),
992 TIMEOUT_REL, GNUNET_YES,
993 &transmit_ready_notify, c);
996 GNUNET_assert (ntohs (mq_entry->msg->size) <= size);
997 size = ntohs (mq_entry->msg->size);
998 memcpy (buf, mq_entry->msg, size);
999 LOG_DEBUG ("Message of type: %u and size: %u sent\n",
1000 ntohs (mq_entry->msg->type), size);
1001 GNUNET_free (mq_entry->msg);
1002 GNUNET_CONTAINER_DLL_remove (c->mq_head, c->mq_tail, mq_entry);
1003 GNUNET_free (mq_entry);
1004 mq_entry = c->mq_head;
1005 if (NULL != mq_entry)
1007 GNUNET_CLIENT_notify_transmit_ready (c->client,
1008 ntohs (mq_entry->msg->size),
1009 TIMEOUT_REL, GNUNET_YES,
1010 &transmit_ready_notify, c);
1011 if (GNUNET_NO == c->in_receive)
1013 c->in_receive = GNUNET_YES;
1014 GNUNET_CLIENT_receive (c->client, &message_handler, c,
1015 GNUNET_TIME_UNIT_FOREVER_REL);
1022 * Queues a message in send queue for sending to the service
1024 * @param controller the handle to the controller
1025 * @param msg the message to queue
1028 GNUNET_TESTBED_queue_message_ (struct GNUNET_TESTBED_Controller *controller,
1029 struct GNUNET_MessageHeader *msg)
1031 struct MessageQueue *mq_entry;
1035 type = ntohs (msg->type);
1036 size = ntohs (msg->size);
1037 GNUNET_assert ((GNUNET_MESSAGE_TYPE_TESTBED_INIT <= type) &&
1038 (GNUNET_MESSAGE_TYPE_TESTBED_MAX > type));
1039 mq_entry = GNUNET_malloc (sizeof (struct MessageQueue));
1040 mq_entry->msg = msg;
1041 LOG (GNUNET_ERROR_TYPE_DEBUG,
1042 "Queueing message of type %u, size %u for sending\n", type,
1044 GNUNET_CONTAINER_DLL_insert_tail (controller->mq_head, controller->mq_tail,
1046 if (NULL == controller->th)
1048 GNUNET_CLIENT_notify_transmit_ready (controller->client, size,
1049 TIMEOUT_REL, GNUNET_YES,
1050 &transmit_ready_notify,
1056 * Sends the given message as an operation. The given callback is called when a
1057 * reply for the operation is available. Call
1058 * GNUNET_TESTBED_forward_operation_msg_cancel_() to cleanup the returned
1059 * operation context if the cc hasn't been called
1061 * @param controller the controller to which the message has to be sent
1062 * @param operation_id the operation id of the message
1063 * @param msg the message to send
1064 * @param cc the callback to call when reply is available
1065 * @param cc_cls the closure for the above callback
1066 * @return the operation context which can be used to cancel the forwarded
1069 struct OperationContext *
1070 GNUNET_TESTBED_forward_operation_msg_ (struct GNUNET_TESTBED_Controller
1071 *controller, uint64_t operation_id,
1072 const struct GNUNET_MessageHeader *msg,
1073 GNUNET_CLIENT_MessageHandler cc,
1076 struct OperationContext *opc;
1077 struct ForwardedOperationData *data;
1078 struct GNUNET_MessageHeader *dup_msg;
1081 data = GNUNET_malloc (sizeof (struct ForwardedOperationData));
1083 data->cc_cls = cc_cls;
1084 opc = GNUNET_malloc (sizeof (struct OperationContext));
1085 opc->c = controller;
1086 opc->type = OP_FORWARDED;
1088 opc->id = operation_id;
1089 msize = ntohs (msg->size);
1090 dup_msg = GNUNET_malloc (msize);
1091 (void) memcpy (dup_msg, msg, msize);
1092 GNUNET_TESTBED_queue_message_ (opc->c, dup_msg);
1093 GNUNET_CONTAINER_DLL_insert_tail (controller->ocq_head, controller->ocq_tail,
1100 * Function to cancel an operation created by simply forwarding an operation
1103 * @param opc the operation context from GNUNET_TESTBED_forward_operation_msg_()
1106 GNUNET_TESTBED_forward_operation_msg_cancel_ (struct OperationContext *opc)
1108 GNUNET_CONTAINER_DLL_remove (opc->c->ocq_head, opc->c->ocq_tail, opc);
1109 GNUNET_free (opc->data);
1115 * Functions with this signature are called whenever a
1116 * complete message is received by the tokenizer.
1118 * Do not call GNUNET_SERVER_mst_destroy in callback
1120 * @param cls closure
1121 * @param client identification of the client
1122 * @param message the actual message
1124 * @return GNUNET_OK on success, GNUNET_SYSERR to stop further processing
1127 helper_mst (void *cls, void *client, const struct GNUNET_MessageHeader *message)
1129 struct GNUNET_TESTBED_ControllerProc *cp = cls;
1130 const struct GNUNET_TESTBED_HelperReply *msg;
1131 const char *hostname;
1134 uLongf xconfig_size;
1136 msg = (const struct GNUNET_TESTBED_HelperReply *) message;
1137 GNUNET_assert (sizeof (struct GNUNET_TESTBED_HelperReply) <
1138 ntohs (msg->header.size));
1139 GNUNET_assert (GNUNET_MESSAGE_TYPE_TESTBED_HELPER_REPLY ==
1140 ntohs (msg->header.type));
1141 config_size = (uLongf) ntohs (msg->config_size);
1143 (uLongf) (ntohs (msg->header.size) -
1144 sizeof (struct GNUNET_TESTBED_HelperReply));
1145 config = GNUNET_malloc (config_size);
1146 GNUNET_assert (Z_OK ==
1147 uncompress ((Bytef *) config, &config_size,
1148 (const Bytef *) &msg[1], xconfig_size));
1149 GNUNET_assert (NULL == cp->cfg);
1150 cp->cfg = GNUNET_CONFIGURATION_create ();
1151 GNUNET_assert (GNUNET_CONFIGURATION_deserialize
1152 (cp->cfg, config, config_size, GNUNET_NO));
1153 GNUNET_free (config);
1154 if ((NULL == cp->host) ||
1155 (NULL == (hostname = GNUNET_TESTBED_host_get_hostname_ (cp->host))))
1156 hostname = "localhost";
1157 /* Change the hostname so that we can connect to it */
1158 GNUNET_CONFIGURATION_set_value_string (cp->cfg, "testbed", "hostname",
1160 cp->cb (cp->cls, cp->cfg, GNUNET_OK);
1166 * Continuation function from GNUNET_HELPER_send()
1168 * @param cls closure
1169 * @param result GNUNET_OK on success,
1170 * GNUNET_NO if helper process died
1171 * GNUNET_SYSERR during GNUNET_HELPER_stop
1174 clear_msg (void *cls, int result)
1176 struct GNUNET_TESTBED_ControllerProc *cp = cls;
1178 GNUNET_assert (NULL != cp->shandle);
1180 GNUNET_free (cp->msg);
1185 * Callback that will be called when the helper process dies. This is not called
1186 * when the helper process is stoped using GNUNET_HELPER_stop()
1188 * @param cls the closure from GNUNET_HELPER_start()
1191 helper_exp_cb (void *cls)
1193 struct GNUNET_TESTBED_ControllerProc *cp = cls;
1194 GNUNET_TESTBED_ControllerStatusCallback cb;
1200 GNUNET_TESTBED_controller_stop (cp);
1202 cb (cb_cls, NULL, GNUNET_SYSERR);
1207 * Function to call to start a link-controllers type operation once all queues
1208 * the operation is part of declare that the operation can be activated.
1210 * @param cls the closure from GNUNET_TESTBED_operation_create_()
1213 opstart_link_controllers (void *cls)
1215 struct OperationContext *opc = cls;
1216 struct ControllerLinkData *data;
1217 struct GNUNET_TESTBED_ControllerLinkMessage *msg;
1219 GNUNET_assert (NULL != opc->data);
1223 opc->state = OPC_STATE_STARTED;
1224 GNUNET_CONTAINER_DLL_insert_tail (opc->c->ocq_head, opc->c->ocq_tail, opc);
1225 GNUNET_TESTBED_queue_message_ (opc->c, &msg->header);
1230 * Callback which will be called when link-controllers type operation is released
1232 * @param cls the closure from GNUNET_TESTBED_operation_create_()
1235 oprelease_link_controllers (void *cls)
1237 struct OperationContext *opc = cls;
1238 struct ControllerLinkData *data;
1243 case OPC_STATE_INIT:
1244 GNUNET_free (data->msg);
1246 case OPC_STATE_STARTED:
1247 GNUNET_CONTAINER_DLL_remove (opc->c->ocq_head, opc->c->ocq_tail, opc);
1249 case OPC_STATE_FINISHED:
1252 GNUNET_free_non_null (data);
1258 * Function to be called when get slave config operation is ready
1260 * @param cls the OperationContext of type OP_GET_SLAVE_CONFIG
1263 opstart_get_slave_config (void *cls)
1265 struct OperationContext *opc = cls;
1266 struct GetSlaveConfigData *data;
1267 struct GNUNET_TESTBED_SlaveGetConfigurationMessage *msg;
1271 msize = sizeof (struct GNUNET_TESTBED_SlaveGetConfigurationMessage);
1272 msg = GNUNET_malloc (msize);
1273 msg->header.size = htons (msize);
1274 msg->header.type = htons (GNUNET_MESSAGE_TYPE_TESTBED_GETSLAVECONFIG);
1275 msg->operation_id = GNUNET_htonll (opc->id);
1276 msg->slave_id = htonl (data->slave_id);
1277 GNUNET_CONTAINER_DLL_insert_tail (opc->c->ocq_head, opc->c->ocq_tail, opc);
1278 GNUNET_TESTBED_queue_message_ (opc->c, &msg->header);
1279 opc->state = OPC_STATE_STARTED;
1284 * Function to be called when get slave config operation is cancelled or finished
1286 * @param cls the OperationContext of type OP_GET_SLAVE_CONFIG
1289 oprelease_get_slave_config (void *cls)
1291 struct OperationContext *opc = cls;
1295 case OPC_STATE_INIT:
1296 GNUNET_free (opc->data);
1298 case OPC_STATE_STARTED:
1299 GNUNET_free (opc->data);
1300 GNUNET_CONTAINER_DLL_remove (opc->c->ocq_head, opc->c->ocq_tail, opc);
1302 case OPC_STATE_FINISHED:
1303 if (NULL != opc->data)
1304 GNUNET_CONFIGURATION_destroy (opc->data);
1312 * Starts a controller process at the host. FIXME: add controller start callback
1313 * with the configuration with which the controller is started
1315 * @param controller_ip the ip address of the controller. Will be set as TRUSTED
1316 * host when starting testbed controller at host
1317 * @param host the host where the controller has to be started; NULL for
1319 * @param cfg template configuration to use for the remote controller; the
1320 * remote controller will be started with a slightly modified
1321 * configuration (port numbers, unix domain sockets and service home
1322 * values are changed as per TESTING library on the remote host)
1323 * @param cb function called when the controller is successfully started or
1324 * dies unexpectedly; GNUNET_TESTBED_controller_stop shouldn't be
1325 * called if cb is called with GNUNET_SYSERR as status. Will never be
1326 * called in the same task as 'GNUNET_TESTBED_controller_start'
1327 * (synchronous errors will be signalled by returning NULL). This
1328 * parameter cannot be NULL.
1329 * @param cls closure for above callbacks
1330 * @return the controller process handle, NULL on errors
1332 struct GNUNET_TESTBED_ControllerProc *
1333 GNUNET_TESTBED_controller_start (const char *controller_ip,
1334 struct GNUNET_TESTBED_Host *host,
1335 const struct GNUNET_CONFIGURATION_Handle *cfg,
1336 GNUNET_TESTBED_ControllerStatusCallback cb,
1339 struct GNUNET_TESTBED_ControllerProc *cp;
1340 struct GNUNET_TESTBED_HelperInit *msg;
1341 const char *hostname;
1342 static char *const binary_argv[] = {
1343 HELPER_TESTBED_BINARY, NULL
1347 cp = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_ControllerProc));
1348 if ((NULL == host) || (0 == GNUNET_TESTBED_host_get_id_ (host)))
1350 GNUNET_HELPER_start (GNUNET_YES, HELPER_TESTBED_BINARY, binary_argv,
1351 &helper_mst, &helper_exp_cb, cp);
1354 char *remote_args[8];
1356 const char *username;
1358 username = GNUNET_TESTBED_host_get_username_ (host);
1359 hostname = GNUNET_TESTBED_host_get_hostname_ (host);
1360 GNUNET_asprintf (&cp->port, "%u", GNUNET_TESTBED_host_get_ssh_port_ (host));
1361 if (NULL == username)
1362 GNUNET_asprintf (&cp->dst, "%s", hostname);
1364 GNUNET_asprintf (&cp->dst, "%s@%s", username, hostname);
1365 LOG_DEBUG ("Starting SSH to destination %s\n", cp->dst);
1367 remote_args[argp++] = "ssh";
1368 remote_args[argp++] = "-p";
1369 remote_args[argp++] = cp->port;
1370 remote_args[argp++] = "-o";
1371 remote_args[argp++] = "BatchMode=yes";
1372 remote_args[argp++] = cp->dst;
1373 remote_args[argp++] = HELPER_TESTBED_BINARY_SSH;
1374 remote_args[argp++] = NULL;
1375 GNUNET_assert (argp == 8);
1377 GNUNET_HELPER_start (GNUNET_NO, "ssh", remote_args, &helper_mst,
1378 &helper_exp_cb, cp);
1380 if (NULL == cp->helper)
1382 GNUNET_free_non_null (cp->port);
1383 GNUNET_free_non_null (cp->dst);
1390 msg = GNUNET_TESTBED_create_helper_init_msg_ (controller_ip, hostname, cfg);
1391 cp->msg = &msg->header;
1393 GNUNET_HELPER_send (cp->helper, &msg->header, GNUNET_NO, &clear_msg, cp);
1394 if (NULL == cp->shandle)
1397 GNUNET_TESTBED_controller_stop (cp);
1405 * Stop the controller process (also will terminate all peers and controllers
1406 * dependent on this controller). This function blocks until the testbed has
1407 * been fully terminated (!). The controller status cb from
1408 * GNUNET_TESTBED_controller_start() will not be called.
1410 * @param cproc the controller process handle
1413 GNUNET_TESTBED_controller_stop (struct GNUNET_TESTBED_ControllerProc *cproc)
1415 if (NULL != cproc->shandle)
1416 GNUNET_HELPER_send_cancel (cproc->shandle);
1417 if (NULL != cproc->helper)
1418 GNUNET_HELPER_stop (cproc->helper);
1419 if (NULL != cproc->cfg)
1420 GNUNET_CONFIGURATION_destroy (cproc->cfg);
1421 GNUNET_free_non_null (cproc->port);
1422 GNUNET_free_non_null (cproc->dst);
1423 GNUNET_free (cproc);
1428 * Start a controller process using the given configuration at the
1431 * @param cfg configuration to use
1432 * @param host host to run the controller on; This should be the same host if
1433 * the controller was previously started with
1434 * GNUNET_TESTBED_controller_start; NULL for localhost
1435 * @param event_mask bit mask with set of events to call 'cc' for;
1436 * or-ed values of "1LL" shifted by the
1437 * respective 'enum GNUNET_TESTBED_EventType'
1438 * (i.e. "(1LL << GNUNET_TESTBED_ET_CONNECT) | ...")
1439 * @param cc controller callback to invoke on events
1440 * @param cc_cls closure for cc
1441 * @return handle to the controller
1443 struct GNUNET_TESTBED_Controller *
1444 GNUNET_TESTBED_controller_connect (const struct GNUNET_CONFIGURATION_Handle
1445 *cfg, struct GNUNET_TESTBED_Host *host,
1446 uint64_t event_mask,
1447 GNUNET_TESTBED_ControllerCallback cc,
1450 struct GNUNET_TESTBED_Controller *controller;
1451 struct GNUNET_TESTBED_InitMessage *msg;
1452 const char *controller_hostname;
1453 unsigned long long max_parallel_operations;
1454 unsigned long long max_parallel_service_connections;
1455 unsigned long long max_parallel_topology_config_operations;
1458 GNUNET_CONFIGURATION_get_value_number (cfg, "testbed",
1459 "MAX_PARALLEL_OPERATIONS",
1460 &max_parallel_operations))
1466 GNUNET_CONFIGURATION_get_value_number (cfg, "testbed",
1467 "MAX_PARALLEL_SERVICE_CONNECTIONS",
1468 &max_parallel_service_connections))
1474 GNUNET_CONFIGURATION_get_value_number (cfg, "testbed",
1475 "MAX_PARALLEL_TOPOLOGY_CONFIG_OPERATIONS",
1476 &max_parallel_topology_config_operations))
1481 controller = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_Controller));
1482 controller->cc = cc;
1483 controller->cc_cls = cc_cls;
1484 controller->event_mask = event_mask;
1485 controller->cfg = GNUNET_CONFIGURATION_dup (cfg);
1486 controller->client = GNUNET_CLIENT_connect ("testbed", controller->cfg);
1487 if (NULL == controller->client)
1489 GNUNET_TESTBED_controller_disconnect (controller);
1494 host = GNUNET_TESTBED_host_create_by_id_ (0);
1495 if (NULL == host) /* If the above host create fails */
1497 LOG (GNUNET_ERROR_TYPE_WARNING,
1498 "Treating NULL host as localhost. Multiple references to localhost "
1499 "may break when localhost freed before calling disconnect \n");
1500 host = GNUNET_TESTBED_host_lookup_by_id_ (0);
1504 controller->aux_host = GNUNET_YES;
1507 GNUNET_assert (NULL != host);
1508 GNUNET_TESTBED_mark_host_registered_at_ (host, controller);
1509 controller->host = host;
1510 controller->opq_parallel_operations =
1511 GNUNET_TESTBED_operation_queue_create_ ((unsigned int)
1512 max_parallel_operations);
1513 controller->opq_parallel_service_connections =
1514 GNUNET_TESTBED_operation_queue_create_ ((unsigned int)
1515 max_parallel_service_connections);
1516 controller->opq_parallel_topology_config_operations=
1517 GNUNET_TESTBED_operation_queue_create_ ((unsigned int)
1518 max_parallel_service_connections);
1519 controller_hostname = GNUNET_TESTBED_host_get_hostname_ (host);
1520 if (NULL == controller_hostname)
1521 controller_hostname = "127.0.0.1";
1523 GNUNET_malloc (sizeof (struct GNUNET_TESTBED_InitMessage) +
1524 strlen (controller_hostname) + 1);
1525 msg->header.type = htons (GNUNET_MESSAGE_TYPE_TESTBED_INIT);
1527 htons (sizeof (struct GNUNET_TESTBED_InitMessage) +
1528 strlen (controller_hostname) + 1);
1529 msg->host_id = htonl (GNUNET_TESTBED_host_get_id_ (host));
1530 msg->event_mask = GNUNET_htonll (controller->event_mask);
1531 strcpy ((char *) &msg[1], controller_hostname);
1532 GNUNET_TESTBED_queue_message_ (controller,
1533 (struct GNUNET_MessageHeader *) msg);
1539 * Configure shared services at a controller. Using this function,
1540 * you can specify that certain services (such as "resolver")
1541 * should not be run for each peer but instead be shared
1542 * across N peers on the specified host. This function
1543 * must be called before any peers are created at the host.
1545 * @param controller controller to configure
1546 * @param service_name name of the service to share
1547 * @param num_peers number of peers that should share one instance
1548 * of the specified service (1 for no sharing is the default),
1549 * use 0 to disable the service
1552 GNUNET_TESTBED_controller_configure_sharing (struct GNUNET_TESTBED_Controller
1554 const char *service_name,
1557 struct GNUNET_TESTBED_ConfigureSharedServiceMessage *msg;
1558 uint16_t service_name_size;
1561 service_name_size = strlen (service_name) + 1;
1563 sizeof (struct GNUNET_TESTBED_ConfigureSharedServiceMessage) +
1565 msg = GNUNET_malloc (msg_size);
1566 msg->header.size = htons (msg_size);
1567 msg->header.type = htons (GNUNET_MESSAGE_TYPE_TESTBED_SERVICESHARE);
1568 msg->host_id = htonl (GNUNET_TESTBED_host_get_id_ (controller->host));
1569 msg->num_peers = htonl (num_peers);
1570 memcpy (&msg[1], service_name, service_name_size);
1571 GNUNET_TESTBED_queue_message_ (controller,
1572 (struct GNUNET_MessageHeader *) msg);
1577 * disconnects from the controller.
1579 * @param controller handle to controller to stop
1582 GNUNET_TESTBED_controller_disconnect (struct GNUNET_TESTBED_Controller
1585 struct MessageQueue *mq_entry;
1587 if (NULL != controller->th)
1588 GNUNET_CLIENT_notify_transmit_ready_cancel (controller->th);
1589 /* Clear the message queue */
1590 while (NULL != (mq_entry = controller->mq_head))
1592 GNUNET_CONTAINER_DLL_remove (controller->mq_head, controller->mq_tail,
1594 GNUNET_free (mq_entry->msg);
1595 GNUNET_free (mq_entry);
1597 if (NULL != controller->client)
1598 GNUNET_CLIENT_disconnect (controller->client);
1599 GNUNET_CONFIGURATION_destroy (controller->cfg);
1600 if (GNUNET_YES == controller->aux_host)
1601 GNUNET_TESTBED_host_destroy (controller->host);
1602 GNUNET_TESTBED_operation_queue_destroy_ (controller->opq_parallel_operations);
1603 GNUNET_TESTBED_operation_queue_destroy_
1604 (controller->opq_parallel_service_connections);
1605 GNUNET_TESTBED_operation_queue_destroy_
1606 (controller->opq_parallel_topology_config_operations);
1607 GNUNET_free (controller);
1612 * Register a host with the controller
1614 * @param controller the controller handle
1615 * @param host the host to register
1616 * @param cc the completion callback to call to inform the status of
1617 * registration. After calling this callback the registration handle
1618 * will be invalid. Cannot be NULL.
1619 * @param cc_cls the closure for the cc
1620 * @return handle to the host registration which can be used to cancel the
1623 struct GNUNET_TESTBED_HostRegistrationHandle *
1624 GNUNET_TESTBED_register_host (struct GNUNET_TESTBED_Controller *controller,
1625 struct GNUNET_TESTBED_Host *host,
1626 GNUNET_TESTBED_HostRegistrationCompletion cc,
1629 struct GNUNET_TESTBED_HostRegistrationHandle *rh;
1630 struct GNUNET_TESTBED_AddHostMessage *msg;
1631 const char *username;
1632 const char *hostname;
1634 uint16_t user_name_length;
1636 if (NULL != controller->rh)
1638 hostname = GNUNET_TESTBED_host_get_hostname_ (host);
1639 if (GNUNET_YES == GNUNET_TESTBED_is_host_registered_ (host, controller))
1641 LOG (GNUNET_ERROR_TYPE_WARNING, "Host hostname: %s already registered\n",
1642 (NULL == hostname) ? "localhost" : hostname);
1645 rh = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_HostRegistrationHandle));
1648 GNUNET_assert (NULL != cc);
1650 rh->cc_cls = cc_cls;
1651 controller->rh = rh;
1652 username = GNUNET_TESTBED_host_get_username_ (host);
1653 msg_size = (sizeof (struct GNUNET_TESTBED_AddHostMessage));
1654 user_name_length = 0;
1655 if (NULL != username)
1657 user_name_length = strlen (username) + 1;
1658 msg_size += user_name_length;
1660 /* FIXME: what happens when hostname is NULL? localhost */
1661 GNUNET_assert (NULL != hostname);
1662 msg_size += strlen (hostname) + 1;
1663 msg = GNUNET_malloc (msg_size);
1664 msg->header.size = htons (msg_size);
1665 msg->header.type = htons (GNUNET_MESSAGE_TYPE_TESTBED_ADDHOST);
1666 msg->host_id = htonl (GNUNET_TESTBED_host_get_id_ (host));
1667 msg->ssh_port = htons (GNUNET_TESTBED_host_get_ssh_port_ (host));
1668 msg->user_name_length = htons (user_name_length);
1669 if (NULL != username)
1670 memcpy (&msg[1], username, user_name_length);
1671 strcpy (((void *) &msg[1]) + user_name_length, hostname);
1672 GNUNET_TESTBED_queue_message_ (controller,
1673 (struct GNUNET_MessageHeader *) msg);
1679 * Cancel the pending registration. Note that if the registration message is
1680 * already sent to the service the cancellation has only the effect that the
1681 * registration completion callback for the registration is never called.
1683 * @param handle the registration handle to cancel
1686 GNUNET_TESTBED_cancel_registration (struct GNUNET_TESTBED_HostRegistrationHandle
1689 if (handle != handle->c->rh)
1694 handle->c->rh = NULL;
1695 GNUNET_free (handle);
1700 * Same as the GNUNET_TESTBED_controller_link, however expects configuration in
1701 * serialized and compressed
1703 * @param op_cls the operation closure for the event which is generated to
1704 * signal success or failure of this operation
1705 * @param master handle to the master controller who creates the association
1706 * @param delegated_host requests to which host should be delegated; cannot be NULL
1707 * @param slave_host which host is used to run the slave controller; use NULL to
1708 * make the master controller connect to the delegated host
1709 * @param sxcfg serialized and compressed configuration
1710 * @param sxcfg_size the size sxcfg
1711 * @param scfg_size the size of uncompressed serialized configuration
1712 * @param is_subordinate GNUNET_YES if the controller at delegated_host should
1713 * be started by the slave controller; GNUNET_NO if the slave
1714 * controller has to connect to the already started delegated
1715 * controller via TCP/IP
1716 * @return the operation handle
1718 struct GNUNET_TESTBED_Operation *
1719 GNUNET_TESTBED_controller_link_2 (void *op_cls,
1720 struct GNUNET_TESTBED_Controller *master,
1721 struct GNUNET_TESTBED_Host *delegated_host,
1722 struct GNUNET_TESTBED_Host *slave_host,
1723 const char *sxcfg, size_t sxcfg_size,
1724 size_t scfg_size, int is_subordinate)
1726 struct OperationContext *opc;
1727 struct GNUNET_TESTBED_ControllerLinkMessage *msg;
1728 struct ControllerLinkData *data;
1731 GNUNET_assert (GNUNET_YES ==
1732 GNUNET_TESTBED_is_host_registered_ (delegated_host, master));
1733 if ((NULL != slave_host) && (0 != GNUNET_TESTBED_host_get_id_ (slave_host)))
1734 GNUNET_assert (GNUNET_YES ==
1735 GNUNET_TESTBED_is_host_registered_ (slave_host, master));
1736 msg_size = sxcfg_size + sizeof (struct GNUNET_TESTBED_ControllerLinkMessage);
1737 msg = GNUNET_malloc (msg_size);
1738 msg->header.type = htons (GNUNET_MESSAGE_TYPE_TESTBED_LCONTROLLERS);
1739 msg->header.size = htons (msg_size);
1740 msg->delegated_host_id = htonl (GNUNET_TESTBED_host_get_id_ (delegated_host));
1741 msg->slave_host_id =
1742 htonl (GNUNET_TESTBED_host_get_id_
1743 ((NULL != slave_host) ? slave_host : master->host));
1744 msg->config_size = htons ((uint16_t) scfg_size);
1745 msg->is_subordinate = (GNUNET_YES == is_subordinate) ? 1 : 0;
1746 memcpy (&msg[1], sxcfg, sxcfg_size);
1747 data = GNUNET_malloc (sizeof (struct ControllerLinkData));
1749 data->op_cls = op_cls;
1750 opc = GNUNET_malloc (sizeof (struct OperationContext));
1753 opc->type = OP_LINK_CONTROLLERS;
1754 opc->id = master->operation_counter++;
1755 opc->state = OPC_STATE_INIT;
1756 msg->operation_id = GNUNET_htonll (opc->id);
1758 GNUNET_TESTBED_operation_create_ (opc, &opstart_link_controllers,
1759 &oprelease_link_controllers);
1760 GNUNET_TESTBED_operation_queue_insert_ (master->opq_parallel_operations,
1767 * Compresses given configuration using zlib compress
1769 * @param config the serialized configuration
1770 * @param size the size of config
1771 * @param xconfig will be set to the compressed configuration (memory is fresly
1773 * @return the size of the xconfig
1776 GNUNET_TESTBED_compress_config_ (const char *config, size_t size,
1781 xsize = compressBound ((uLong) size);
1782 *xconfig = GNUNET_malloc (xsize);
1783 GNUNET_assert (Z_OK ==
1784 compress2 ((Bytef *) * xconfig, (uLongf *) & xsize,
1785 (const Bytef *) config, (uLongf) size,
1792 * Create a link from slave controller to delegated controller. Whenever the
1793 * master controller is asked to start a peer at the delegated controller the
1794 * request will be routed towards slave controller (if a route exists). The
1795 * slave controller will then route it to the delegated controller. The
1796 * configuration of the delegated controller is given and is used to either
1797 * create the delegated controller or to connect to an existing controller. Note
1798 * that while starting the delegated controller the configuration will be
1799 * modified to accommodate available free ports. the 'is_subordinate' specifies
1800 * if the given delegated controller should be started and managed by the slave
1801 * controller, or if the delegated controller already has a master and the slave
1802 * controller connects to it as a non master controller. The success or failure
1803 * of this operation will be signalled through the
1804 * GNUNET_TESTBED_ControllerCallback() with an event of type
1805 * GNUNET_TESTBED_ET_OPERATION_FINISHED
1807 * @param op_cls the operation closure for the event which is generated to
1808 * signal success or failure of this operation
1809 * @param master handle to the master controller who creates the association
1810 * @param delegated_host requests to which host should be delegated; cannot be NULL
1811 * @param slave_host which host is used to run the slave controller; use NULL to
1812 * make the master controller connect to the delegated host
1813 * @param slave_cfg configuration to use for the slave controller
1814 * @param is_subordinate GNUNET_YES if the controller at delegated_host should
1815 * be started by the slave controller; GNUNET_NO if the slave
1816 * controller has to connect to the already started delegated
1817 * controller via TCP/IP
1818 * @return the operation handle
1820 struct GNUNET_TESTBED_Operation *
1821 GNUNET_TESTBED_controller_link (void *op_cls,
1822 struct GNUNET_TESTBED_Controller *master,
1823 struct GNUNET_TESTBED_Host *delegated_host,
1824 struct GNUNET_TESTBED_Host *slave_host,
1825 const struct GNUNET_CONFIGURATION_Handle
1826 *slave_cfg, int is_subordinate)
1828 struct GNUNET_TESTBED_Operation *op;
1834 GNUNET_assert (GNUNET_YES ==
1835 GNUNET_TESTBED_is_host_registered_ (delegated_host, master));
1836 if ((NULL != slave_host) && (0 != GNUNET_TESTBED_host_get_id_ (slave_host)))
1837 GNUNET_assert (GNUNET_YES ==
1838 GNUNET_TESTBED_is_host_registered_ (slave_host, master));
1839 config = GNUNET_CONFIGURATION_serialize (slave_cfg, &config_size);
1840 cc_size = GNUNET_TESTBED_compress_config_ (config, config_size, &cconfig);
1841 GNUNET_free (config);
1842 /* Configuration doesn't fit in 1 message */
1843 GNUNET_assert ((UINT16_MAX -
1844 sizeof (struct GNUNET_TESTBED_ControllerLinkMessage)) >= cc_size);
1845 op = GNUNET_TESTBED_controller_link_2 (op_cls, master, delegated_host,
1846 slave_host, (const char *) cconfig,
1847 cc_size, config_size, is_subordinate);
1848 GNUNET_free (cconfig);
1854 * Function to acquire the configuration of a running slave controller. The
1855 * completion of the operation is signalled through the controller_cb from
1856 * GNUNET_TESTBED_controller_connect(). If the operation is successful the
1857 * handle to the configuration is available in the generic pointer of
1858 * operation_finished field of struct GNUNET_TESTBED_EventInformation.
1860 * @param op_cls the closure for the operation
1861 * @param master the handle to master controller
1862 * @param slave_host the host where the slave controller is running; the handle
1863 * to the slave_host should remain valid until this operation is
1864 * cancelled or marked as finished
1865 * @return the operation handle; NULL if the slave_host is not registered at
1868 struct GNUNET_TESTBED_Operation *
1869 GNUNET_TESTBED_get_slave_config (void *op_cls,
1870 struct GNUNET_TESTBED_Controller *master,
1871 struct GNUNET_TESTBED_Host *slave_host)
1873 struct OperationContext *opc;
1874 struct GetSlaveConfigData *data;
1876 if (GNUNET_NO == GNUNET_TESTBED_is_host_registered_ (slave_host, master))
1878 data = GNUNET_malloc (sizeof (struct GetSlaveConfigData));
1879 data->slave_id = GNUNET_TESTBED_host_get_id_ (slave_host);
1880 data->op_cls = op_cls;
1881 opc = GNUNET_malloc (sizeof (struct OperationContext));
1882 opc->state = OPC_STATE_INIT;
1884 opc->id = master->operation_counter++;
1885 opc->type = OP_GET_SLAVE_CONFIG;
1888 GNUNET_TESTBED_operation_create_ (opc, &opstart_get_slave_config,
1889 &oprelease_get_slave_config);
1890 GNUNET_TESTBED_operation_queue_insert_ (master->opq_parallel_operations,
1897 * Ask the testbed controller to write the current overlay topology to
1898 * a file. Naturally, the file will only contain a snapshot as the
1899 * topology may evolve all the time.
1901 * @param controller overlay controller to inspect
1902 * @param filename name of the file the topology should
1906 GNUNET_TESTBED_overlay_write_topology_to_file (struct GNUNET_TESTBED_Controller
1908 const char *filename)
1915 * Creates a helper initialization message. This function is here because we
1916 * want to use this in testing
1918 * @param cname the ip address of the controlling host
1919 * @param hostname the hostname of the destination this message is intended for
1920 * @param cfg the configuration that has to used to start the testbed service
1922 * @return the initialization message
1924 struct GNUNET_TESTBED_HelperInit *
1925 GNUNET_TESTBED_create_helper_init_msg_ (const char *cname,
1926 const char *hostname,
1927 const struct GNUNET_CONFIGURATION_Handle
1930 struct GNUNET_TESTBED_HelperInit *msg;
1934 size_t xconfig_size;
1936 uint16_t hostname_len;
1939 config = GNUNET_CONFIGURATION_serialize (cfg, &config_size);
1940 GNUNET_assert (NULL != config);
1942 GNUNET_TESTBED_compress_config_ (config, config_size, &xconfig);
1943 GNUNET_free (config);
1944 cname_len = strlen (cname);
1945 hostname_len = (NULL == hostname) ? 0 : strlen (hostname);
1947 xconfig_size + cname_len + 1 + sizeof (struct GNUNET_TESTBED_HelperInit);
1948 msg_size += hostname_len;
1949 msg = GNUNET_realloc (xconfig, msg_size);
1950 (void) memmove (((void *) &msg[1]) + cname_len + 1 + hostname_len,
1953 msg->header.size = htons (msg_size);
1954 msg->header.type = htons (GNUNET_MESSAGE_TYPE_TESTBED_HELPER_INIT);
1955 msg->cname_size = htons (cname_len);
1956 msg->hostname_size = htons (hostname_len);
1957 msg->config_size = htons (config_size);
1958 (void) strcpy ((char *) &msg[1], cname);
1959 if (0 != hostname_len)
1960 (void) strncpy (((char *) &msg[1]) + cname_len + 1, hostname, hostname_len);
1966 * Cancel a pending operation. Releases all resources
1967 * of the operation and will ensure that no event
1968 * is generated for the operation. Does NOT guarantee
1969 * that the operation will be fully undone (or that
1970 * nothing ever happened).
1972 * @param operation operation to cancel
1975 GNUNET_TESTBED_operation_cancel (struct GNUNET_TESTBED_Operation *operation)
1977 GNUNET_TESTBED_operation_done (operation);
1982 * Signal that the information from an operation has been fully
1983 * processed. This function MUST be called for each event
1984 * of type 'operation_finished' to fully remove the operation
1985 * from the operation queue. After calling this function, the
1986 * 'op_result' becomes invalid (!).
1988 * @param operation operation to signal completion for
1991 GNUNET_TESTBED_operation_done (struct GNUNET_TESTBED_Operation *operation)
1993 switch (operation->type)
1995 case OP_PEER_CREATE:
1996 case OP_PEER_DESTROY:
2000 case OP_OVERLAY_CONNECT:
2001 case OP_LINK_CONTROLLERS:
2002 GNUNET_TESTBED_operation_release_ (operation);
2012 * Generates configuration by uncompressing configuration in given message. The
2013 * given message should be of the following types:
2014 * GNUNET_MESSAGE_TYPE_TESTBED_PEERCONFIG,
2015 * GNUNET_MESSAGE_TYPE_TESTBED_SLAVECONFIG
2017 * @param msg the message containing compressed configuration
2018 * @return handle to the parsed configuration
2020 struct GNUNET_CONFIGURATION_Handle *
2021 GNUNET_TESTBED_extract_config_ (const struct GNUNET_MessageHeader *msg)
2023 struct GNUNET_CONFIGURATION_Handle *cfg;
2030 switch (ntohs (msg->type))
2032 case GNUNET_MESSAGE_TYPE_TESTBED_PEERCONFIG:
2034 const struct GNUNET_TESTBED_PeerConfigurationInformationMessage *imsg;
2036 imsg = (const struct GNUNET_TESTBED_PeerConfigurationInformationMessage *)
2038 data_len = (uLong) ntohs (imsg->config_size);
2039 xdata_len = ntohs (imsg->header.size)
2040 - sizeof (struct GNUNET_TESTBED_PeerConfigurationInformationMessage);
2041 xdata = (const Bytef *) &imsg[1];
2044 case GNUNET_MESSAGE_TYPE_TESTBED_SLAVECONFIG:
2046 const struct GNUNET_TESTBED_SlaveConfiguration *imsg;
2048 imsg = (const struct GNUNET_TESTBED_SlaveConfiguration *) msg;
2049 data_len = (uLong) ntohs (imsg->config_size);
2050 xdata_len = ntohs (imsg->header.size)
2051 - sizeof (struct GNUNET_TESTBED_SlaveConfiguration);
2052 xdata = (const Bytef *) &imsg[1];
2058 data = GNUNET_malloc (data_len);
2061 uncompress (data, &data_len, xdata, xdata_len)))
2063 cfg = GNUNET_CONFIGURATION_create ();
2064 GNUNET_assert (GNUNET_OK ==
2065 GNUNET_CONFIGURATION_deserialize (cfg, (const char *) data,
2074 * Checks the integrity of the OperationFailureEventMessage and if good returns
2075 * the error message it contains.
2077 * @param msg the OperationFailureEventMessage
2078 * @return the error message
2081 GNUNET_TESTBED_parse_error_string_ (const struct
2082 GNUNET_TESTBED_OperationFailureEventMessage
2088 msize = ntohs (msg->header.size);
2089 if (sizeof (struct GNUNET_TESTBED_OperationFailureEventMessage) >= msize)
2091 msize -= sizeof (struct GNUNET_TESTBED_OperationFailureEventMessage);
2092 emsg = (const char *) &msg[1];
2093 if ('\0' != emsg[msize - 1])
2101 /* end of testbed_api.c */