2 This file is part of GNUnet
3 (C) 2008--2012 Christian Grothoff (and other contributing authors)
5 GNUnet is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published
7 by the Free Software Foundation; either version 3, or (at your
8 option) any later version.
10 GNUnet is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with GNUnet; see the file COPYING. If not, write to the
17 Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
22 * @file testbed/testbed_api.c
23 * @brief API for accessing the GNUnet testing service.
24 * This library is supposed to make it easier to write
25 * testcases and script large-scale benchmarks.
26 * @author Christian Grothoff
27 * @author Sree Harsha Totakura
32 #include "gnunet_testbed_service.h"
33 #include "gnunet_core_service.h"
34 #include "gnunet_constants.h"
35 #include "gnunet_transport_service.h"
36 #include "gnunet_hello_lib.h"
40 #include "testbed_api.h"
41 #include "testbed_api_hosts.h"
42 #include "testbed_api_peers.h"
43 #include "testbed_api_operations.h"
46 * Generic logging shorthand
48 #define LOG(kind, ...) \
49 GNUNET_log_from (kind, "testbed-api", __VA_ARGS__);
54 #define LOG_DEBUG(...) \
55 LOG (GNUNET_ERROR_TYPE_DEBUG, __VA_ARGS__);
58 * Relative time seconds shorthand
60 #define TIME_REL_SECS(sec) \
61 GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, sec)
65 * Default server message sending retry timeout
67 #define TIMEOUT_REL TIME_REL_SECS(1)
71 * Testbed Helper binary name
73 #define HELPER_TESTBED_BINARY "gnunet-helper-testbed"
74 #define HELPER_TESTBED_BINARY_SSH ". ~/.bashrc; gnunet-helper-testbed"
78 * The message queue for sending messages to the controller service
83 * The message to be sent
85 struct GNUNET_MessageHeader *msg;
88 * next pointer for DLL
90 struct MessageQueue *next;
93 * prev pointer for DLL
95 struct MessageQueue *prev;
100 * Structure for a controller link
102 struct ControllerLink
105 * The next ptr for DLL
107 struct ControllerLink *next;
110 * The prev ptr for DLL
112 struct ControllerLink *prev;
115 * The host which will be referred in the peer start request. This is the
116 * host where the peer should be started
118 struct GNUNET_TESTBED_Host *delegated_host;
121 * The host which will contacted to delegate the peer start request
123 struct GNUNET_TESTBED_Host *slave_host;
126 * The configuration to be used to connect to slave host
128 const struct GNUNET_CONFIGURATION_Handle *slave_cfg;
131 * GNUNET_YES if the slave should be started (and stopped) by us; GNUNET_NO
132 * if we are just allowed to use the slave via TCP/IP
139 * handle for host registration
141 struct GNUNET_TESTBED_HostRegistrationHandle
144 * The host being registered
146 struct GNUNET_TESTBED_Host *host;
149 * The controller at which this host is being registered
151 struct GNUNET_TESTBED_Controller *c;
154 * The Registartion completion callback
156 GNUNET_TESTBED_HostRegistrationCompletion cc;
159 * The closure for above callback
166 * Context data for forwarded Operation
168 struct ForwardedOperationData
172 * The callback to call when reply is available
174 GNUNET_CLIENT_MessageHandler cc;
177 * The closure for the above callback
185 * Context data for get slave config operations
187 struct GetSlaveConfigData
190 * The operation closure
195 * The id of the slave controller
203 * Returns the operation context with the given id if found in the Operation
204 * context queues of the controller
206 * @param c the controller whose queues are searched
207 * @param id the id which has to be checked
208 * @return the matching operation context; NULL if no match found
210 static struct OperationContext *
211 find_opc (const struct GNUNET_TESTBED_Controller *c, const uint64_t id)
213 struct OperationContext *opc;
215 for (opc = c->ocq_head; NULL != opc; opc = opc->next)
225 * Handler for GNUNET_MESSAGE_TYPE_TESTBED_ADDHOSTCONFIRM message from
226 * controller (testbed service)
228 * @param c the controller handler
229 * @param msg message received
230 * @return GNUNET_YES if we can continue receiving from service; GNUNET_NO if
234 handle_addhostconfirm (struct GNUNET_TESTBED_Controller *c,
235 const struct GNUNET_TESTBED_HostConfirmedMessage *msg)
237 struct GNUNET_TESTBED_HostRegistrationHandle *rh;
246 if (GNUNET_TESTBED_host_get_id_ (rh->host) != ntohl (msg->host_id))
248 LOG_DEBUG ("Mismatch in host id's %u, %u of host confirm msg\n",
249 GNUNET_TESTBED_host_get_id_ (rh->host), ntohl (msg->host_id));
253 msg_size = ntohs (msg->header.size);
254 if (sizeof (struct GNUNET_TESTBED_HostConfirmedMessage) == msg_size)
256 LOG_DEBUG ("Host %u successfully registered\n", ntohl (msg->host_id));
257 GNUNET_TESTBED_mark_host_registered_at_ (rh->host, c);
258 rh->cc (rh->cc_cls, NULL);
262 /* We have an error message */
263 emsg = (char *) &msg[1];
265 emsg[msg_size - sizeof (struct GNUNET_TESTBED_HostConfirmedMessage)])
271 LOG (GNUNET_ERROR_TYPE_ERROR, _("Adding host %u failed with error: %s\n"),
272 ntohl (msg->host_id), emsg);
273 rh->cc (rh->cc_cls, emsg);
280 * Handler for GNUNET_MESSAGE_TYPE_TESTBED_ADDHOSTCONFIRM message from
281 * controller (testbed service)
283 * @param c the controller handler
284 * @param msg message received
285 * @return GNUNET_YES if we can continue receiving from service; GNUNET_NO if
289 handle_opsuccess (struct GNUNET_TESTBED_Controller *c,
291 GNUNET_TESTBED_GenericOperationSuccessEventMessage *msg)
293 struct OperationContext *opc;
294 struct GNUNET_TESTBED_EventInformation event;
297 op_id = GNUNET_ntohll (msg->operation_id);
298 LOG_DEBUG ("Operation %ul successful\n", op_id);
299 if (NULL == (opc = find_opc (c, op_id)))
301 LOG_DEBUG ("Operation not found\n");
308 struct ForwardedOperationData *fo_data;
311 if (NULL != fo_data->cc)
312 fo_data->cc (fo_data->cc_cls, (const struct GNUNET_MessageHeader *) msg);
313 GNUNET_CONTAINER_DLL_remove (c->ocq_head, c->ocq_tail, opc);
314 GNUNET_free (fo_data);
319 case OP_PEER_DESTROY:
321 struct GNUNET_TESTBED_Peer *peer;
329 case OP_LINK_CONTROLLERS:
334 event.type = GNUNET_TESTBED_ET_OPERATION_FINISHED;
335 event.details.operation_finished.operation = opc->op;
336 event.details.operation_finished.op_cls = NULL;
337 event.details.operation_finished.emsg = NULL;
338 event.details.operation_finished.generic = NULL;
339 GNUNET_CONTAINER_DLL_remove (opc->c->ocq_head, opc->c->ocq_tail, opc);
340 opc->state = OPC_STATE_FINISHED;
341 if (0 != (c->event_mask & (1L << GNUNET_TESTBED_ET_OPERATION_FINISHED)))
344 c->cc (c->cc_cls, &event);
351 * Handler for GNUNET_MESSAGE_TYPE_TESTBED_PEERCREATESUCCESS message from
352 * controller (testbed service)
354 * @param c the controller handler
355 * @param msg message received
356 * @return GNUNET_YES if we can continue receiving from service; GNUNET_NO if
360 handle_peer_create_success (struct GNUNET_TESTBED_Controller *c,
362 GNUNET_TESTBED_PeerCreateSuccessEventMessage *msg)
364 struct OperationContext *opc;
365 struct PeerCreateData *data;
366 struct GNUNET_TESTBED_Peer *peer;
367 GNUNET_TESTBED_PeerCreateCallback cb;
371 GNUNET_assert (sizeof (struct GNUNET_TESTBED_PeerCreateSuccessEventMessage) ==
372 ntohs (msg->header.size));
373 op_id = GNUNET_ntohll (msg->operation_id);
374 if (NULL == (opc = find_opc (c, op_id)))
376 LOG_DEBUG ("Operation context for PeerCreateSuccessEvent not found\n");
379 if (OP_FORWARDED == opc->type)
381 struct ForwardedOperationData *fo_data;
384 if (NULL != fo_data->cc)
385 fo_data->cc (fo_data->cc_cls, (const struct GNUNET_MessageHeader *) msg);
386 GNUNET_CONTAINER_DLL_remove (c->ocq_head, c->ocq_tail, opc);
387 GNUNET_free (fo_data);
391 GNUNET_assert (OP_PEER_CREATE == opc->type);
392 GNUNET_assert (NULL != opc->data);
394 GNUNET_assert (NULL != data->peer);
396 GNUNET_assert (peer->unique_id == ntohl (msg->peer_id));
397 peer->state = PS_CREATED;
400 GNUNET_free (opc->data);
401 GNUNET_CONTAINER_DLL_remove (opc->c->ocq_head, opc->c->ocq_tail, opc);
402 opc->state = OPC_STATE_FINISHED;
404 cb (cls, peer, NULL);
410 * Handler for GNUNET_MESSAGE_TYPE_TESTBED_PEEREVENT message from
411 * controller (testbed service)
413 * @param c the controller handler
414 * @param msg message received
415 * @return GNUNET_YES if we can continue receiving from service; GNUNET_NO if
419 handle_peer_event (struct GNUNET_TESTBED_Controller *c,
420 const struct GNUNET_TESTBED_PeerEventMessage *msg)
422 struct OperationContext *opc;
423 struct GNUNET_TESTBED_Peer *peer;
424 struct PeerEventData *data;
425 GNUNET_TESTBED_PeerChurnCallback pcc;
427 struct GNUNET_TESTBED_EventInformation event;
430 GNUNET_assert (sizeof (struct GNUNET_TESTBED_PeerEventMessage) ==
431 ntohs (msg->header.size));
432 op_id = GNUNET_ntohll (msg->operation_id);
433 if (NULL == (opc = find_opc (c, op_id)))
435 LOG_DEBUG ("Operation not found\n");
438 if (OP_FORWARDED == opc->type)
440 struct ForwardedOperationData *fo_data;
443 if (NULL != fo_data->cc)
444 fo_data->cc (fo_data->cc_cls, (const struct GNUNET_MessageHeader *) msg);
445 GNUNET_CONTAINER_DLL_remove (c->ocq_head, c->ocq_tail, opc);
446 GNUNET_free (fo_data);
450 GNUNET_assert ((OP_PEER_START == opc->type) || (OP_PEER_STOP == opc->type));
452 GNUNET_assert (NULL != data);
454 GNUNET_assert (NULL != peer);
455 event.type = (enum GNUNET_TESTBED_EventType) ntohl (msg->event_type);
458 case GNUNET_TESTBED_ET_PEER_START:
459 peer->state = PS_STARTED;
460 event.details.peer_start.host = peer->host;
461 event.details.peer_start.peer = peer;
463 case GNUNET_TESTBED_ET_PEER_STOP:
464 peer->state = PS_STOPPED;
465 event.details.peer_stop.peer = peer;
468 GNUNET_assert (0); /* We should never reach this state */
471 pcc_cls = data->pcc_cls;
473 GNUNET_CONTAINER_DLL_remove (opc->c->ocq_head, opc->c->ocq_tail, opc);
474 opc->state = OPC_STATE_FINISHED;
476 ((GNUNET_TESTBED_ET_PEER_START | GNUNET_TESTBED_ET_PEER_STOP) &
480 c->cc (c->cc_cls, &event);
489 * Handler for GNUNET_MESSAGE_TYPE_TESTBED_PEERCONEVENT message from
490 * controller (testbed service)
492 * @param c the controller handler
493 * @param msg message received
494 * @return GNUNET_YES if we can continue receiving from service; GNUNET_NO if
498 handle_peer_conevent (struct GNUNET_TESTBED_Controller *c,
499 const struct GNUNET_TESTBED_ConnectionEventMessage *msg)
501 struct OperationContext *opc;
502 struct OverlayConnectData *data;
503 GNUNET_TESTBED_OperationCompletionCallback cb;
505 struct GNUNET_TESTBED_EventInformation event;
508 op_id = GNUNET_ntohll (msg->operation_id);
509 if (NULL == (opc = find_opc (c, op_id)))
511 LOG_DEBUG ("Operation not found\n");
515 GNUNET_assert (NULL != data);
516 GNUNET_assert ((ntohl (msg->peer1) == data->p1->unique_id) &&
517 (ntohl (msg->peer2) == data->p2->unique_id));
518 event.type = (enum GNUNET_TESTBED_EventType) ntohl (msg->event_type);
521 case GNUNET_TESTBED_ET_CONNECT:
522 event.details.peer_connect.peer1 = data->p1;
523 event.details.peer_connect.peer2 = data->p2;
525 case GNUNET_TESTBED_ET_DISCONNECT:
526 GNUNET_assert (0); /* FIXME: implement */
529 GNUNET_assert (0); /* Should never reach here */
533 cb_cls = data->cb_cls;
534 GNUNET_CONTAINER_DLL_remove (opc->c->ocq_head, opc->c->ocq_tail, opc);
535 opc->state = OPC_STATE_FINISHED;
538 ((GNUNET_TESTBED_ET_CONNECT | GNUNET_TESTBED_ET_DISCONNECT) &
542 c->cc (c->cc_cls, &event);
545 cb (cb_cls, opc->op, NULL);
551 * Handler for GNUNET_MESSAGE_TYPE_TESTBED_PEERCONFIG message from
552 * controller (testbed service)
554 * @param c the controller handler
555 * @param msg message received
556 * @return GNUNET_YES if we can continue receiving from service; GNUNET_NO if
560 handle_peer_config (struct GNUNET_TESTBED_Controller *c,
562 GNUNET_TESTBED_PeerConfigurationInformationMessage *msg)
564 struct OperationContext *opc;
565 struct GNUNET_TESTBED_Peer *peer;
566 struct PeerInfoData *data;
567 struct GNUNET_TESTBED_PeerInformation *pinfo;
568 GNUNET_TESTBED_PeerInfoCallback cb;
572 op_id = GNUNET_ntohll (msg->operation_id);
573 if (NULL == (opc = find_opc (c, op_id)))
575 LOG_DEBUG ("Operation not found\n");
578 if (OP_FORWARDED == opc->type)
580 struct ForwardedOperationData *fo_data;
583 if (NULL != fo_data->cc)
584 fo_data->cc (fo_data->cc_cls, (const struct GNUNET_MessageHeader *) msg);
585 GNUNET_CONTAINER_DLL_remove (c->ocq_head, c->ocq_tail, opc);
586 GNUNET_free (fo_data);
591 GNUNET_assert (NULL != data);
593 GNUNET_assert (NULL != peer);
594 GNUNET_assert (ntohl (msg->peer_id) == peer->unique_id);
595 pinfo = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_PeerInformation));
596 pinfo->pit = data->pit;
598 cb_cls = data->cb_cls;
603 case GNUNET_TESTBED_PIT_IDENTITY:
604 pinfo->result.id = GNUNET_malloc (sizeof (struct GNUNET_PeerIdentity));
605 (void) memcpy (pinfo->result.id, &msg->peer_identity,
606 sizeof (struct GNUNET_PeerIdentity));
608 case GNUNET_TESTBED_PIT_CONFIGURATION:
609 pinfo->result.cfg = /* Freed in oprelease_peer_getinfo */
610 GNUNET_TESTBED_extract_config_ (&msg->header);
612 case GNUNET_TESTBED_PIT_GENERIC:
613 GNUNET_assert (0); /* never reach here */
617 GNUNET_CONTAINER_DLL_remove (opc->c->ocq_head, opc->c->ocq_tail, opc);
618 opc->state = OPC_STATE_FINISHED;
620 cb (cb_cls, opc->op, pinfo, NULL);
626 * Handler for GNUNET_MESSAGE_TYPE_TESTBED_OPERATIONFAILEVENT message from
627 * controller (testbed service)
629 * @param c the controller handler
630 * @param msg message received
631 * @return GNUNET_YES if we can continue receiving from service; GNUNET_NO if
635 handle_op_fail_event (struct GNUNET_TESTBED_Controller *c,
636 const struct GNUNET_TESTBED_OperationFailureEventMessage
639 struct OperationContext *opc;
642 struct GNUNET_TESTBED_EventInformation event;
644 op_id = GNUNET_ntohll (msg->operation_id);
645 if (NULL == (opc = find_opc (c, op_id)))
647 LOG_DEBUG ("Operation not found\n");
650 GNUNET_CONTAINER_DLL_remove (opc->c->ocq_head, opc->c->ocq_tail, opc);
651 if (OP_FORWARDED == opc->type)
653 struct ForwardedOperationData *fo_data;
656 if (NULL != fo_data->cc)
657 fo_data->cc (fo_data->cc_cls, (const struct GNUNET_MessageHeader *) msg);
658 GNUNET_free (fo_data);
662 opc->state = OPC_STATE_FINISHED;
663 emsg = GNUNET_TESTBED_parse_error_string_ (msg);
665 emsg = "Unknown error";
666 if (OP_PEER_INFO == opc->type)
668 struct PeerInfoData *data;
670 if (NULL != data->cb)
671 data->cb (data->cb_cls, opc->op, NULL, emsg);
673 return GNUNET_YES; /* We do not call controller callback for peer info */
675 if ((0 != (GNUNET_TESTBED_ET_OPERATION_FINISHED & c->event_mask)) &&
678 event.type = GNUNET_TESTBED_ET_OPERATION_FINISHED;
679 event.details.operation_finished.operation = opc->op;
680 event.details.operation_finished.op_cls = NULL;
681 event.details.operation_finished.emsg = emsg;
682 event.details.operation_finished.generic = NULL;
683 c->cc (c->cc_cls, &event);
689 struct PeerCreateData *data;
691 GNUNET_free (data->peer);
692 if (NULL != data->cb)
693 data->cb (data->cls, NULL, emsg);
700 struct PeerEventData *data;
702 if (NULL != data->pcc)
703 data->pcc (data->pcc_cls, emsg);
707 case OP_PEER_DESTROY:
711 case OP_OVERLAY_CONNECT:
713 struct OverlayConnectData *data;
715 if (NULL != data->cb)
716 data->cb (data->cb_cls, opc->op, emsg);
722 case OP_LINK_CONTROLLERS: /* No secondary callback */
732 * Handler for GNUNET_MESSAGE_TYPE_TESTBED_SLAVECONFIG message from controller
735 * @param c the controller handler
736 * @param msg message received
737 * @return GNUNET_YES if we can continue receiving from service; GNUNET_NO if
741 handle_slave_config (struct GNUNET_TESTBED_Controller *c,
742 const struct GNUNET_TESTBED_SlaveConfiguration * msg)
744 struct OperationContext *opc;
747 struct GNUNET_TESTBED_EventInformation event;
749 op_id = GNUNET_ntohll (msg->operation_id);
750 if (NULL == (opc = find_opc (c, op_id)))
752 LOG_DEBUG ("Operation not found\n");
755 if (OP_GET_SLAVE_CONFIG != opc->type)
760 op_cls = ((struct GetSlaveConfigData *) opc->data)->op_cls;
761 GNUNET_free (opc->data);
763 opc->state = OPC_STATE_FINISHED;
764 GNUNET_CONTAINER_DLL_remove (opc->c->ocq_head, opc->c->ocq_tail, opc);
765 if ((0 != (GNUNET_TESTBED_ET_OPERATION_FINISHED & c->event_mask)) &&
768 opc->data = GNUNET_TESTBED_extract_config_ (&msg->header);
769 event.type = GNUNET_TESTBED_ET_OPERATION_FINISHED;
770 event.details.operation_finished.generic = opc->data;
771 event.details.operation_finished.operation = opc->op;
772 event.details.operation_finished.op_cls = op_cls;
773 event.details.operation_finished.emsg = NULL;
774 c->cc (c->cc_cls, &event);
781 * Handler for messages from controller (testbed service)
783 * @param cls the controller handler
784 * @param msg message received, NULL on timeout or fatal error
787 message_handler (void *cls, const struct GNUNET_MessageHeader *msg)
789 struct GNUNET_TESTBED_Controller *c = cls;
793 c->in_receive = GNUNET_NO;
794 /* FIXME: Add checks for message integrity */
797 LOG_DEBUG ("Receive timed out or connection to service dropped\n");
801 msize = ntohs (msg->size);
802 switch (ntohs (msg->type))
804 case GNUNET_MESSAGE_TYPE_TESTBED_ADDHOSTCONFIRM:
805 GNUNET_assert (msize >=
806 sizeof (struct GNUNET_TESTBED_HostConfirmedMessage));
808 handle_addhostconfirm (c,
809 (const struct GNUNET_TESTBED_HostConfirmedMessage
812 case GNUNET_MESSAGE_TYPE_TESTBED_GENERICOPSUCCESS:
813 GNUNET_assert (msize ==
815 GNUNET_TESTBED_GenericOperationSuccessEventMessage));
819 GNUNET_TESTBED_GenericOperationSuccessEventMessage *)
822 case GNUNET_MESSAGE_TYPE_TESTBED_PEERCREATESUCCESS:
823 GNUNET_assert (msize ==
825 GNUNET_TESTBED_PeerCreateSuccessEventMessage));
827 handle_peer_create_success (c,
829 GNUNET_TESTBED_PeerCreateSuccessEventMessage
832 case GNUNET_MESSAGE_TYPE_TESTBED_PEEREVENT:
833 GNUNET_assert (msize == sizeof (struct GNUNET_TESTBED_PeerEventMessage));
835 handle_peer_event (c,
836 (const struct GNUNET_TESTBED_PeerEventMessage *)
840 case GNUNET_MESSAGE_TYPE_TESTBED_PEERCONFIG:
841 GNUNET_assert (msize >=
843 GNUNET_TESTBED_PeerConfigurationInformationMessage));
845 handle_peer_config (c,
847 GNUNET_TESTBED_PeerConfigurationInformationMessage
850 case GNUNET_MESSAGE_TYPE_TESTBED_PEERCONEVENT:
851 GNUNET_assert (msize ==
852 sizeof (struct GNUNET_TESTBED_ConnectionEventMessage));
854 handle_peer_conevent (c,
856 GNUNET_TESTBED_ConnectionEventMessage *) msg);
858 case GNUNET_MESSAGE_TYPE_TESTBED_OPERATIONFAILEVENT:
859 GNUNET_assert (msize >=
860 sizeof (struct GNUNET_TESTBED_OperationFailureEventMessage));
862 handle_op_fail_event (c,
864 GNUNET_TESTBED_OperationFailureEventMessage *)
867 case GNUNET_MESSAGE_TYPE_TESTBED_SLAVECONFIG:
868 GNUNET_assert (msize >
869 sizeof (struct GNUNET_TESTBED_SlaveConfiguration));
871 handle_slave_config (c, (const struct
872 GNUNET_TESTBED_SlaveConfiguration *) msg);
877 if ((GNUNET_OK == status) && (GNUNET_NO == c->in_receive))
879 c->in_receive = GNUNET_YES;
880 GNUNET_CLIENT_receive (c->client, &message_handler, c,
881 GNUNET_TIME_UNIT_FOREVER_REL);
887 * Function called to notify a client about the connection begin ready to queue
888 * more data. "buf" will be NULL and "size" zero if the connection was closed
889 * for writing in the meantime.
892 * @param size number of bytes available in buf
893 * @param buf where the callee should write the message
894 * @return number of bytes written to buf
897 transmit_ready_notify (void *cls, size_t size, void *buf)
899 struct GNUNET_TESTBED_Controller *c = cls;
900 struct MessageQueue *mq_entry;
903 mq_entry = c->mq_head;
904 GNUNET_assert (NULL != mq_entry);
905 if ((0 == size) && (NULL == buf)) /* Timeout */
907 LOG_DEBUG ("Message sending timed out -- retrying\n");
909 GNUNET_CLIENT_notify_transmit_ready (c->client,
910 ntohs (mq_entry->msg->size),
911 TIMEOUT_REL, GNUNET_YES,
912 &transmit_ready_notify, c);
915 GNUNET_assert (ntohs (mq_entry->msg->size) <= size);
916 size = ntohs (mq_entry->msg->size);
917 memcpy (buf, mq_entry->msg, size);
918 LOG_DEBUG ("Message of type: %u and size: %u sent\n",
919 ntohs (mq_entry->msg->type), size);
920 GNUNET_free (mq_entry->msg);
921 GNUNET_CONTAINER_DLL_remove (c->mq_head, c->mq_tail, mq_entry);
922 GNUNET_free (mq_entry);
923 mq_entry = c->mq_head;
924 if (NULL != mq_entry)
926 GNUNET_CLIENT_notify_transmit_ready (c->client,
927 ntohs (mq_entry->msg->size),
928 TIMEOUT_REL, GNUNET_YES,
929 &transmit_ready_notify, c);
930 if (GNUNET_NO == c->in_receive)
932 c->in_receive = GNUNET_YES;
933 GNUNET_CLIENT_receive (c->client, &message_handler, c,
934 GNUNET_TIME_UNIT_FOREVER_REL);
941 * Queues a message in send queue for sending to the service
943 * @param controller the handle to the controller
944 * @param msg the message to queue
947 GNUNET_TESTBED_queue_message_ (struct GNUNET_TESTBED_Controller *controller,
948 struct GNUNET_MessageHeader *msg)
950 struct MessageQueue *mq_entry;
954 type = ntohs (msg->type);
955 size = ntohs (msg->size);
956 GNUNET_assert ((GNUNET_MESSAGE_TYPE_TESTBED_INIT <= type) &&
957 (GNUNET_MESSAGE_TYPE_TESTBED_MAX > type));
958 mq_entry = GNUNET_malloc (sizeof (struct MessageQueue));
960 LOG (GNUNET_ERROR_TYPE_DEBUG,
961 "Queueing message of type %u, size %u for sending\n", type,
963 GNUNET_CONTAINER_DLL_insert_tail (controller->mq_head, controller->mq_tail,
965 if (NULL == controller->th)
967 GNUNET_CLIENT_notify_transmit_ready (controller->client, size,
968 TIMEOUT_REL, GNUNET_YES,
969 &transmit_ready_notify,
975 * Sends the given message as an operation. The given callback is called when a
976 * reply for the operation is available. Call
977 * GNUNET_TESTBED_forward_operation_msg_cancel_() to cleanup the returned
978 * operation context if the cc hasn't been called
980 * @param controller the controller to which the message has to be sent
981 * @param operation_id the operation id of the message
982 * @param msg the message to send
983 * @param cc the callback to call when reply is available
984 * @param cc_cls the closure for the above callback
985 * @return the operation context which can be used to cancel the forwarded
988 struct OperationContext *
989 GNUNET_TESTBED_forward_operation_msg_ (struct GNUNET_TESTBED_Controller
990 *controller, uint64_t operation_id,
991 const struct GNUNET_MessageHeader *msg,
992 GNUNET_CLIENT_MessageHandler cc,
995 struct OperationContext *opc;
996 struct ForwardedOperationData *data;
997 struct GNUNET_MessageHeader *dup_msg;
1000 data = GNUNET_malloc (sizeof (struct ForwardedOperationData));
1002 data->cc_cls = cc_cls;
1003 opc = GNUNET_malloc (sizeof (struct OperationContext));
1004 opc->c = controller;
1005 opc->type = OP_FORWARDED;
1007 opc->id = operation_id;
1008 msize = ntohs (msg->size);
1009 dup_msg = GNUNET_malloc (msize);
1010 (void) memcpy (dup_msg, msg, msize);
1011 GNUNET_TESTBED_queue_message_ (opc->c, dup_msg);
1012 GNUNET_CONTAINER_DLL_insert_tail (controller->ocq_head, controller->ocq_tail,
1019 * Function to cancel an operation created by simply forwarding an operation
1022 * @param opc the operation context from GNUNET_TESTBED_forward_operation_msg_()
1025 GNUNET_TESTBED_forward_operation_msg_cancel_ (struct OperationContext *opc)
1027 GNUNET_CONTAINER_DLL_remove (opc->c->ocq_head, opc->c->ocq_tail, opc);
1028 GNUNET_free (opc->data);
1034 * Handle for controller process
1036 struct GNUNET_TESTBED_ControllerProc
1039 * The process handle
1041 struct GNUNET_HELPER_Handle *helper;
1044 * The host where the helper is run
1046 struct GNUNET_TESTBED_Host *host;
1049 * The controller error callback
1051 GNUNET_TESTBED_ControllerStatusCallback cb;
1054 * The closure for the above callback
1059 * The send handle for the helper
1061 struct GNUNET_HELPER_SendHandle *shandle;
1064 * The message corresponding to send handle
1066 struct GNUNET_MessageHeader *msg;
1069 * The port number for ssh; used for helpers starting ssh
1074 * The ssh destination string; used for helpers starting ssh
1079 * The configuration of the running testbed service
1081 struct GNUNET_CONFIGURATION_Handle *cfg;
1087 * Functions with this signature are called whenever a
1088 * complete message is received by the tokenizer.
1090 * Do not call GNUNET_SERVER_mst_destroy in callback
1092 * @param cls closure
1093 * @param client identification of the client
1094 * @param message the actual message
1096 * @return GNUNET_OK on success, GNUNET_SYSERR to stop further processing
1099 helper_mst (void *cls, void *client, const struct GNUNET_MessageHeader *message)
1101 struct GNUNET_TESTBED_ControllerProc *cp = cls;
1102 const struct GNUNET_TESTBED_HelperReply *msg;
1103 const char *hostname;
1106 uLongf xconfig_size;
1108 msg = (const struct GNUNET_TESTBED_HelperReply *) message;
1109 GNUNET_assert (sizeof (struct GNUNET_TESTBED_HelperReply) <
1110 ntohs (msg->header.size));
1111 GNUNET_assert (GNUNET_MESSAGE_TYPE_TESTBED_HELPER_REPLY ==
1112 ntohs (msg->header.type));
1113 config_size = (uLongf) ntohs (msg->config_size);
1115 (uLongf) (ntohs (msg->header.size) -
1116 sizeof (struct GNUNET_TESTBED_HelperReply));
1117 config = GNUNET_malloc (config_size);
1118 GNUNET_assert (Z_OK ==
1119 uncompress ((Bytef *) config, &config_size,
1120 (const Bytef *) &msg[1], xconfig_size));
1121 GNUNET_assert (NULL == cp->cfg);
1122 cp->cfg = GNUNET_CONFIGURATION_create ();
1123 GNUNET_assert (GNUNET_CONFIGURATION_deserialize
1124 (cp->cfg, config, config_size, GNUNET_NO));
1125 GNUNET_free (config);
1126 if ((NULL == cp->host) ||
1127 (NULL == (hostname = GNUNET_TESTBED_host_get_hostname_ (cp->host))))
1128 hostname = "localhost";
1129 /* Change the hostname so that we can connect to it */
1130 GNUNET_CONFIGURATION_set_value_string (cp->cfg, "testbed", "hostname",
1132 cp->cb (cp->cls, cp->cfg, GNUNET_OK);
1138 * Continuation function from GNUNET_HELPER_send()
1140 * @param cls closure
1141 * @param result GNUNET_OK on success,
1142 * GNUNET_NO if helper process died
1143 * GNUNET_SYSERR during GNUNET_HELPER_stop
1146 clear_msg (void *cls, int result)
1148 struct GNUNET_TESTBED_ControllerProc *cp = cls;
1150 GNUNET_assert (NULL != cp->shandle);
1152 GNUNET_free (cp->msg);
1157 * Callback that will be called when the helper process dies. This is not called
1158 * when the helper process is stoped using GNUNET_HELPER_stop()
1160 * @param cls the closure from GNUNET_HELPER_start()
1163 helper_exp_cb (void *cls)
1165 struct GNUNET_TESTBED_ControllerProc *cp = cls;
1166 GNUNET_TESTBED_ControllerStatusCallback cb;
1172 GNUNET_TESTBED_controller_stop (cp);
1174 cb (cb_cls, NULL, GNUNET_SYSERR);
1179 * Function to call to start a link-controllers type operation once all queues
1180 * the operation is part of declare that the operation can be activated.
1182 * @param cls the closure from GNUNET_TESTBED_operation_create_()
1185 opstart_link_controllers (void *cls)
1187 struct OperationContext *opc = cls;
1188 struct GNUNET_TESTBED_ControllerLinkMessage *msg;
1190 GNUNET_assert (NULL != opc->data);
1193 opc->state = OPC_STATE_STARTED;
1194 GNUNET_CONTAINER_DLL_insert_tail (opc->c->ocq_head, opc->c->ocq_tail, opc);
1195 GNUNET_TESTBED_queue_message_ (opc->c, &msg->header);
1200 * Callback which will be called when link-controllers type operation is released
1202 * @param cls the closure from GNUNET_TESTBED_operation_create_()
1205 oprelease_link_controllers (void *cls)
1207 struct OperationContext *opc = cls;
1209 if (OPC_STATE_INIT == opc->state)
1210 GNUNET_free (opc->data);
1211 if (OPC_STATE_STARTED == opc->state)
1212 GNUNET_CONTAINER_DLL_remove (opc->c->ocq_head, opc->c->ocq_tail, opc);
1218 * Function to be called when get slave config operation is ready
1220 * @param cls the OperationContext of type OP_GET_SLAVE_CONFIG
1223 opstart_get_slave_config (void *cls)
1225 struct OperationContext *opc = cls;
1226 struct GetSlaveConfigData *data;
1227 struct GNUNET_TESTBED_SlaveGetConfigurationMessage *msg;
1231 msize = sizeof (struct GNUNET_TESTBED_SlaveGetConfigurationMessage);
1232 msg = GNUNET_malloc (msize);
1233 msg->header.size = htons (msize);
1234 msg->header.type = htons (GNUNET_MESSAGE_TYPE_TESTBED_GETSLAVECONFIG);
1235 msg->operation_id = GNUNET_htonll (opc->id);
1236 msg->slave_id = htonl (data->slave_id);
1237 GNUNET_CONTAINER_DLL_insert_tail (opc->c->ocq_head, opc->c->ocq_tail, opc);
1238 GNUNET_TESTBED_queue_message_ (opc->c, &msg->header);
1239 opc->state = OPC_STATE_STARTED;
1244 * Function to be called when get slave config operation is cancelled or finished
1246 * @param cls the OperationContext of type OP_GET_SLAVE_CONFIG
1249 oprelease_get_slave_config (void *cls)
1251 struct OperationContext *opc = cls;
1255 case OPC_STATE_INIT:
1256 GNUNET_free (opc->data);
1258 case OPC_STATE_STARTED:
1259 GNUNET_free (opc->data);
1260 GNUNET_CONTAINER_DLL_remove (opc->c->ocq_head, opc->c->ocq_tail, opc);
1262 case OPC_STATE_FINISHED:
1263 if (NULL != opc->data)
1264 GNUNET_CONFIGURATION_destroy (opc->data);
1272 * Starts a controller process at the host. FIXME: add controller start callback
1273 * with the configuration with which the controller is started
1275 * @param controller_ip the ip address of the controller. Will be set as TRUSTED
1276 * host when starting testbed controller at host
1277 * @param host the host where the controller has to be started; NULL for
1279 * @param cfg template configuration to use for the remote controller; the
1280 * remote controller will be started with a slightly modified
1281 * configuration (port numbers, unix domain sockets and service home
1282 * values are changed as per TESTING library on the remote host)
1283 * @param cb function called when the controller is successfully started or
1284 * dies unexpectedly; GNUNET_TESTBED_controller_stop shouldn't be
1285 * called if cb is called with GNUNET_SYSERR as status. Will never be
1286 * called in the same task as 'GNUNET_TESTBED_controller_start'
1287 * (synchronous errors will be signalled by returning NULL). This
1288 * parameter cannot be NULL.
1289 * @param cls closure for above callbacks
1290 * @return the controller process handle, NULL on errors
1292 struct GNUNET_TESTBED_ControllerProc *
1293 GNUNET_TESTBED_controller_start (const char *controller_ip,
1294 struct GNUNET_TESTBED_Host *host,
1295 const struct GNUNET_CONFIGURATION_Handle *cfg,
1296 GNUNET_TESTBED_ControllerStatusCallback cb,
1299 struct GNUNET_TESTBED_ControllerProc *cp;
1300 struct GNUNET_TESTBED_HelperInit *msg;
1301 static char *const binary_argv[] = {
1302 HELPER_TESTBED_BINARY, NULL
1305 cp = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_ControllerProc));
1306 if ((NULL == host) || (0 == GNUNET_TESTBED_host_get_id_ (host)))
1308 GNUNET_HELPER_start (GNUNET_YES, HELPER_TESTBED_BINARY, binary_argv,
1309 &helper_mst, &helper_exp_cb, cp);
1312 char *remote_args[8];
1314 const char *username;
1315 const char *hostname;
1317 username = GNUNET_TESTBED_host_get_username_ (host);
1318 hostname = GNUNET_TESTBED_host_get_hostname_ (host);
1319 GNUNET_asprintf (&cp->port, "%u", GNUNET_TESTBED_host_get_ssh_port_ (host));
1320 if (NULL == username)
1321 GNUNET_asprintf (&cp->dst, "%s", hostname);
1323 GNUNET_asprintf (&cp->dst, "%s@%s", username, hostname);
1324 LOG_DEBUG ("Starting SSH to destination %s\n", cp->dst);
1326 remote_args[argp++] = "ssh";
1327 remote_args[argp++] = "-p";
1328 remote_args[argp++] = cp->port;
1329 remote_args[argp++] = "-o";
1330 remote_args[argp++] = "BatchMode=yes";
1331 remote_args[argp++] = cp->dst;
1332 remote_args[argp++] = HELPER_TESTBED_BINARY_SSH;
1333 remote_args[argp++] = NULL;
1334 GNUNET_assert (argp == 8);
1336 GNUNET_HELPER_start (GNUNET_NO, "ssh", remote_args, &helper_mst,
1337 &helper_exp_cb, cp);
1339 if (NULL == cp->helper)
1341 GNUNET_free_non_null (cp->port);
1342 GNUNET_free_non_null (cp->dst);
1349 msg = GNUNET_TESTBED_create_helper_init_msg_ (controller_ip, cfg);
1350 cp->msg = &msg->header;
1352 GNUNET_HELPER_send (cp->helper, &msg->header, GNUNET_NO, &clear_msg, cp);
1353 if (NULL == cp->shandle)
1356 GNUNET_TESTBED_controller_stop (cp);
1364 * Stop the controller process (also will terminate all peers and controllers
1365 * dependent on this controller). This function blocks until the testbed has
1366 * been fully terminated (!).
1368 * @param cproc the controller process handle
1371 GNUNET_TESTBED_controller_stop (struct GNUNET_TESTBED_ControllerProc *cproc)
1373 if (NULL != cproc->shandle)
1374 GNUNET_HELPER_send_cancel (cproc->shandle);
1375 if (NULL != cproc->helper)
1376 GNUNET_HELPER_stop (cproc->helper);
1377 if (NULL != cproc->cfg)
1378 GNUNET_CONFIGURATION_destroy (cproc->cfg);
1379 GNUNET_free_non_null (cproc->port);
1380 GNUNET_free_non_null (cproc->dst);
1381 GNUNET_free (cproc);
1386 * Start a controller process using the given configuration at the
1389 * @param cfg configuration to use
1390 * @param host host to run the controller on; This should be the same host if
1391 * the controller was previously started with
1392 * GNUNET_TESTBED_controller_start; NULL for localhost
1393 * @param event_mask bit mask with set of events to call 'cc' for;
1394 * or-ed values of "1LL" shifted by the
1395 * respective 'enum GNUNET_TESTBED_EventType'
1396 * (i.e. "(1LL << GNUNET_TESTBED_ET_CONNECT) | ...")
1397 * @param cc controller callback to invoke on events
1398 * @param cc_cls closure for cc
1399 * @return handle to the controller
1401 struct GNUNET_TESTBED_Controller *
1402 GNUNET_TESTBED_controller_connect (const struct GNUNET_CONFIGURATION_Handle
1403 *cfg, struct GNUNET_TESTBED_Host *host,
1404 uint64_t event_mask,
1405 GNUNET_TESTBED_ControllerCallback cc,
1408 struct GNUNET_TESTBED_Controller *controller;
1409 struct GNUNET_TESTBED_InitMessage *msg;
1410 const char *controller_hostname;
1411 unsigned long long max_parallel_operations;
1412 unsigned long long max_parallel_service_connections;
1413 unsigned long long max_parallel_topology_config_operations;
1416 GNUNET_CONFIGURATION_get_value_number (cfg, "testbed",
1417 "MAX_PARALLEL_OPERATIONS",
1418 &max_parallel_operations))
1424 GNUNET_CONFIGURATION_get_value_number (cfg, "testbed",
1425 "MAX_PARALLEL_SERVICE_CONNECTIONS",
1426 &max_parallel_service_connections))
1432 GNUNET_CONFIGURATION_get_value_number (cfg, "testbed",
1433 "MAX_PARALLEL_TOPOLOGY_CONFIG_OPERATIONS",
1434 &max_parallel_topology_config_operations))
1439 controller = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_Controller));
1440 controller->cc = cc;
1441 controller->cc_cls = cc_cls;
1442 controller->event_mask = event_mask;
1443 controller->cfg = GNUNET_CONFIGURATION_dup (cfg);
1444 controller->client = GNUNET_CLIENT_connect ("testbed", controller->cfg);
1445 if (NULL == controller->client)
1447 GNUNET_TESTBED_controller_disconnect (controller);
1452 host = GNUNET_TESTBED_host_create_by_id_ (0);
1453 if (NULL == host) /* If the above host create fails */
1455 LOG (GNUNET_ERROR_TYPE_WARNING,
1456 "Treating NULL host as localhost. Multiple references to localhost "
1457 "may break when localhost freed before calling disconnect \n");
1458 host = GNUNET_TESTBED_host_lookup_by_id_ (0);
1462 controller->aux_host = GNUNET_YES;
1465 GNUNET_assert (NULL != host);
1466 GNUNET_TESTBED_mark_host_registered_at_ (host, controller);
1467 controller->host = host;
1468 controller->opq_parallel_operations =
1469 GNUNET_TESTBED_operation_queue_create_ ((unsigned int)
1470 max_parallel_operations);
1471 controller->opq_parallel_service_connections =
1472 GNUNET_TESTBED_operation_queue_create_ ((unsigned int)
1473 max_parallel_service_connections);
1474 controller->opq_parallel_topology_config_operations=
1475 GNUNET_TESTBED_operation_queue_create_ ((unsigned int)
1476 max_parallel_service_connections);
1477 controller_hostname = GNUNET_TESTBED_host_get_hostname_ (host);
1478 if (NULL == controller_hostname)
1479 controller_hostname = "127.0.0.1";
1481 GNUNET_malloc (sizeof (struct GNUNET_TESTBED_InitMessage) +
1482 strlen (controller_hostname) + 1);
1483 msg->header.type = htons (GNUNET_MESSAGE_TYPE_TESTBED_INIT);
1485 htons (sizeof (struct GNUNET_TESTBED_InitMessage) +
1486 strlen (controller_hostname) + 1);
1487 msg->host_id = htonl (GNUNET_TESTBED_host_get_id_ (host));
1488 msg->event_mask = GNUNET_htonll (controller->event_mask);
1489 strcpy ((char *) &msg[1], controller_hostname);
1490 GNUNET_TESTBED_queue_message_ (controller,
1491 (struct GNUNET_MessageHeader *) msg);
1497 * Configure shared services at a controller. Using this function,
1498 * you can specify that certain services (such as "resolver")
1499 * should not be run for each peer but instead be shared
1500 * across N peers on the specified host. This function
1501 * must be called before any peers are created at the host.
1503 * @param controller controller to configure
1504 * @param service_name name of the service to share
1505 * @param num_peers number of peers that should share one instance
1506 * of the specified service (1 for no sharing is the default),
1507 * use 0 to disable the service
1510 GNUNET_TESTBED_controller_configure_sharing (struct GNUNET_TESTBED_Controller
1512 const char *service_name,
1515 struct GNUNET_TESTBED_ConfigureSharedServiceMessage *msg;
1516 uint16_t service_name_size;
1519 service_name_size = strlen (service_name) + 1;
1521 sizeof (struct GNUNET_TESTBED_ConfigureSharedServiceMessage) +
1523 msg = GNUNET_malloc (msg_size);
1524 msg->header.size = htons (msg_size);
1525 msg->header.type = htons (GNUNET_MESSAGE_TYPE_TESTBED_SERVICESHARE);
1526 msg->host_id = htonl (GNUNET_TESTBED_host_get_id_ (controller->host));
1527 msg->num_peers = htonl (num_peers);
1528 memcpy (&msg[1], service_name, service_name_size);
1529 GNUNET_TESTBED_queue_message_ (controller,
1530 (struct GNUNET_MessageHeader *) msg);
1535 * disconnects from the controller.
1537 * @param controller handle to controller to stop
1540 GNUNET_TESTBED_controller_disconnect (struct GNUNET_TESTBED_Controller
1543 struct MessageQueue *mq_entry;
1545 if (NULL != controller->th)
1546 GNUNET_CLIENT_notify_transmit_ready_cancel (controller->th);
1547 /* Clear the message queue */
1548 while (NULL != (mq_entry = controller->mq_head))
1550 GNUNET_CONTAINER_DLL_remove (controller->mq_head, controller->mq_tail,
1552 GNUNET_free (mq_entry->msg);
1553 GNUNET_free (mq_entry);
1555 if (NULL != controller->client)
1556 GNUNET_CLIENT_disconnect (controller->client);
1557 GNUNET_CONFIGURATION_destroy (controller->cfg);
1558 if (GNUNET_YES == controller->aux_host)
1559 GNUNET_TESTBED_host_destroy (controller->host);
1560 GNUNET_TESTBED_operation_queue_destroy_ (controller->opq_parallel_operations);
1561 GNUNET_TESTBED_operation_queue_destroy_
1562 (controller->opq_parallel_service_connections);
1563 GNUNET_TESTBED_operation_queue_destroy_
1564 (controller->opq_parallel_topology_config_operations);
1565 GNUNET_free (controller);
1570 * Register a host with the controller
1572 * @param controller the controller handle
1573 * @param host the host to register
1574 * @param cc the completion callback to call to inform the status of
1575 * registration. After calling this callback the registration handle
1576 * will be invalid. Cannot be NULL.
1577 * @param cc_cls the closure for the cc
1578 * @return handle to the host registration which can be used to cancel the
1581 struct GNUNET_TESTBED_HostRegistrationHandle *
1582 GNUNET_TESTBED_register_host (struct GNUNET_TESTBED_Controller *controller,
1583 struct GNUNET_TESTBED_Host *host,
1584 GNUNET_TESTBED_HostRegistrationCompletion cc,
1587 struct GNUNET_TESTBED_HostRegistrationHandle *rh;
1588 struct GNUNET_TESTBED_AddHostMessage *msg;
1589 const char *username;
1590 const char *hostname;
1592 uint16_t user_name_length;
1594 if (NULL != controller->rh)
1596 hostname = GNUNET_TESTBED_host_get_hostname_ (host);
1597 if (GNUNET_YES == GNUNET_TESTBED_is_host_registered_ (host, controller))
1599 LOG (GNUNET_ERROR_TYPE_WARNING, "Host hostname: %s already registered\n",
1600 (NULL == hostname) ? "localhost" : hostname);
1603 rh = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_HostRegistrationHandle));
1606 GNUNET_assert (NULL != cc);
1608 rh->cc_cls = cc_cls;
1609 controller->rh = rh;
1610 username = GNUNET_TESTBED_host_get_username_ (host);
1611 msg_size = (sizeof (struct GNUNET_TESTBED_AddHostMessage));
1612 user_name_length = 0;
1613 if (NULL != username)
1615 user_name_length = strlen (username) + 1;
1616 msg_size += user_name_length;
1618 /* FIXME: what happens when hostname is NULL? localhost */
1619 GNUNET_assert (NULL != hostname);
1620 msg_size += strlen (hostname) + 1;
1621 msg = GNUNET_malloc (msg_size);
1622 msg->header.size = htons (msg_size);
1623 msg->header.type = htons (GNUNET_MESSAGE_TYPE_TESTBED_ADDHOST);
1624 msg->host_id = htonl (GNUNET_TESTBED_host_get_id_ (host));
1625 msg->ssh_port = htons (GNUNET_TESTBED_host_get_ssh_port_ (host));
1626 msg->user_name_length = htons (user_name_length);
1627 if (NULL != username)
1628 memcpy (&msg[1], username, user_name_length);
1629 strcpy (((void *) &msg[1]) + user_name_length, hostname);
1630 GNUNET_TESTBED_queue_message_ (controller,
1631 (struct GNUNET_MessageHeader *) msg);
1637 * Cancel the pending registration. Note that if the registration message is
1638 * already sent to the service the cancellation has only the effect that the
1639 * registration completion callback for the registration is never called.
1641 * @param handle the registration handle to cancel
1644 GNUNET_TESTBED_cancel_registration (struct GNUNET_TESTBED_HostRegistrationHandle
1647 if (handle != handle->c->rh)
1652 handle->c->rh = NULL;
1653 GNUNET_free (handle);
1658 * Same as the GNUNET_TESTBED_controller_link, however expects configuration in
1659 * serialized and compressed
1661 * @param master handle to the master controller who creates the association
1662 * @param delegated_host requests to which host should be delegated; cannot be NULL
1663 * @param slave_host which host is used to run the slave controller; use NULL to
1664 * make the master controller connect to the delegated host
1665 * @param sxcfg serialized and compressed configuration
1666 * @param sxcfg_size the size scfg
1667 * @param scfg_size the size of uncompressed serialized configuration
1668 * @param is_subordinate GNUNET_YES if the controller at delegated_host should
1669 * be started by the master controller; GNUNET_NO if we are just
1670 * allowed to use the slave via TCP/IP
1672 struct GNUNET_TESTBED_Operation *
1673 GNUNET_TESTBED_controller_link_2 (struct GNUNET_TESTBED_Controller *master,
1674 struct GNUNET_TESTBED_Host *delegated_host,
1675 struct GNUNET_TESTBED_Host *slave_host,
1676 const char *sxcfg, size_t sxcfg_size,
1677 size_t scfg_size, int is_subordinate)
1679 struct OperationContext *opc;
1680 struct GNUNET_TESTBED_ControllerLinkMessage *msg;
1683 GNUNET_assert (GNUNET_YES ==
1684 GNUNET_TESTBED_is_host_registered_ (delegated_host, master));
1685 if ((NULL != slave_host) && (0 != GNUNET_TESTBED_host_get_id_ (slave_host)))
1686 GNUNET_assert (GNUNET_YES ==
1687 GNUNET_TESTBED_is_host_registered_ (slave_host, master));
1688 msg_size = sxcfg_size + sizeof (struct GNUNET_TESTBED_ControllerLinkMessage);
1689 msg = GNUNET_malloc (msg_size);
1690 msg->header.type = htons (GNUNET_MESSAGE_TYPE_TESTBED_LCONTROLLERS);
1691 msg->header.size = htons (msg_size);
1692 msg->delegated_host_id = htonl (GNUNET_TESTBED_host_get_id_ (delegated_host));
1693 msg->slave_host_id =
1694 htonl (GNUNET_TESTBED_host_get_id_
1695 ((NULL != slave_host) ? slave_host : master->host));
1696 msg->config_size = htons ((uint16_t) scfg_size);
1697 msg->is_subordinate = (GNUNET_YES == is_subordinate) ? 1 : 0;
1698 memcpy (&msg[1], sxcfg, sxcfg_size);
1699 opc = GNUNET_malloc (sizeof (struct OperationContext));
1702 opc->type = OP_LINK_CONTROLLERS;
1703 opc->id = master->operation_counter++;
1704 opc->state = OPC_STATE_INIT;
1705 msg->operation_id = GNUNET_htonll (opc->id);
1707 GNUNET_TESTBED_operation_create_ (opc, &opstart_link_controllers,
1708 &oprelease_link_controllers);
1709 GNUNET_TESTBED_operation_queue_insert_ (master->opq_parallel_operations,
1716 * Compresses given configuration using zlib compress
1718 * @param config the serialized configuration
1719 * @param size the size of config
1720 * @param xconfig will be set to the compressed configuration (memory is fresly
1722 * @return the size of the xconfig
1725 GNUNET_TESTBED_compress_config_ (const char *config, size_t size,
1730 xsize = compressBound ((uLong) size);
1731 *xconfig = GNUNET_malloc (xsize);
1732 GNUNET_assert (Z_OK ==
1733 compress2 ((Bytef *) * xconfig, (uLongf *) & xsize,
1734 (const Bytef *) config, (uLongf) size,
1741 * Create a link from slave controller to delegated controller. Whenever the
1742 * master controller is asked to start a peer at the delegated controller the
1743 * request will be routed towards slave controller (if a route exists). The
1744 * slave controller will then route it to the delegated controller. The
1745 * configuration of the slave controller is given and to be used to either
1746 * create the slave controller or to connect to an existing slave controller
1747 * process. 'is_subordinate' specifies if the given slave controller should be
1748 * started and managed by the master controller, or if the slave already has a
1749 * master and this is just a secondary master that is also allowed to use the
1752 * @param master handle to the master controller who creates the association
1753 * @param delegated_host requests to which host should be delegated
1754 * @param slave_host which host is used to run the slave controller
1755 * @param slave_cfg configuration to use for the slave controller
1756 * @param is_subordinate GNUNET_YES if the slave should be started (and stopped)
1757 * by the master controller; GNUNET_NO if we are just
1758 * allowed to use the slave via TCP/IP
1759 * @return the operation handle
1761 struct GNUNET_TESTBED_Operation *
1762 GNUNET_TESTBED_controller_link (struct GNUNET_TESTBED_Controller *master,
1763 struct GNUNET_TESTBED_Host *delegated_host,
1764 struct GNUNET_TESTBED_Host *slave_host,
1765 const struct GNUNET_CONFIGURATION_Handle
1766 *slave_cfg, int is_subordinate)
1768 struct GNUNET_TESTBED_Operation *op;
1774 GNUNET_assert (GNUNET_YES ==
1775 GNUNET_TESTBED_is_host_registered_ (delegated_host, master));
1776 if ((NULL != slave_host) && (0 != GNUNET_TESTBED_host_get_id_ (slave_host)))
1777 GNUNET_assert (GNUNET_YES ==
1778 GNUNET_TESTBED_is_host_registered_ (slave_host, master));
1779 config = GNUNET_CONFIGURATION_serialize (slave_cfg, &config_size);
1780 cc_size = GNUNET_TESTBED_compress_config_ (config, config_size, &cconfig);
1781 GNUNET_free (config);
1782 /* Configuration doesn't fit in 1 message */
1783 GNUNET_assert ((UINT16_MAX -
1784 sizeof (struct GNUNET_TESTBED_ControllerLinkMessage)) >= cc_size);
1785 op = GNUNET_TESTBED_controller_link_2 (master, delegated_host, slave_host,
1786 (const char *) cconfig, cc_size,
1787 config_size, is_subordinate);
1788 GNUNET_free (cconfig);
1794 * Function to acquire the configuration of a running slave controller. The
1795 * completion of the operation is signalled through the controller_cb from
1796 * GNUNET_TESTBED_controller_connect(). If the operation is successful the
1797 * handle to the configuration is available in the generic pointer of
1798 * operation_finished field of struct GNUNET_TESTBED_EventInformation.
1800 * @param op_cls the closure for the operation
1801 * @param master the handle to master controller
1802 * @param slave_host the host where the slave controller is running; the handle
1803 * to the slave_host should remain valid until this operation is
1804 * cancelled or marked as finished
1805 * @return the operation handle; NULL if the slave_host is not registered at
1808 struct GNUNET_TESTBED_Operation *
1809 GNUNET_TESTBED_get_slave_config (void *op_cls,
1810 struct GNUNET_TESTBED_Controller *master,
1811 struct GNUNET_TESTBED_Host *slave_host)
1813 struct OperationContext *opc;
1814 struct GetSlaveConfigData *data;
1816 if (GNUNET_NO == GNUNET_TESTBED_is_host_registered_ (slave_host, master))
1818 data = GNUNET_malloc (sizeof (struct GetSlaveConfigData));
1819 data->slave_id = GNUNET_TESTBED_host_get_id_ (slave_host);
1820 data->op_cls = op_cls;
1821 opc = GNUNET_malloc (sizeof (struct OperationContext));
1822 opc->state = OPC_STATE_INIT;
1824 opc->id = master->operation_counter++;
1825 opc->type = OP_GET_SLAVE_CONFIG;
1828 GNUNET_TESTBED_operation_create_ (opc, &opstart_get_slave_config,
1829 &oprelease_get_slave_config);
1830 GNUNET_TESTBED_operation_queue_insert_ (master->opq_parallel_operations,
1837 * Ask the testbed controller to write the current overlay topology to
1838 * a file. Naturally, the file will only contain a snapshot as the
1839 * topology may evolve all the time.
1841 * @param controller overlay controller to inspect
1842 * @param filename name of the file the topology should
1846 GNUNET_TESTBED_overlay_write_topology_to_file (struct GNUNET_TESTBED_Controller
1848 const char *filename)
1855 * Creates a helper initialization message. This function is here because we
1856 * want to use this in testing
1858 * @param cname the ip address of the controlling host
1859 * @param cfg the configuration that has to used to start the testbed service
1861 * @return the initialization message
1863 struct GNUNET_TESTBED_HelperInit *
1864 GNUNET_TESTBED_create_helper_init_msg_ (const char *cname,
1865 const struct GNUNET_CONFIGURATION_Handle
1868 struct GNUNET_TESTBED_HelperInit *msg;
1872 size_t xconfig_size;
1876 config = GNUNET_CONFIGURATION_serialize (cfg, &config_size);
1877 GNUNET_assert (NULL != config);
1879 GNUNET_TESTBED_compress_config_ (config, config_size, &xconfig);
1880 GNUNET_free (config);
1881 cname_len = strlen (cname);
1883 xconfig_size + cname_len + 1 + sizeof (struct GNUNET_TESTBED_HelperInit);
1884 msg = GNUNET_realloc (xconfig, msg_size);
1885 (void) memmove (((void *) &msg[1]) + cname_len + 1, msg, xconfig_size);
1886 msg->header.size = htons (msg_size);
1887 msg->header.type = htons (GNUNET_MESSAGE_TYPE_TESTBED_HELPER_INIT);
1888 msg->cname_size = htons (cname_len);
1889 msg->config_size = htons (config_size);
1890 (void) strcpy ((char *) &msg[1], cname);
1896 * Cancel a pending operation. Releases all resources
1897 * of the operation and will ensure that no event
1898 * is generated for the operation. Does NOT guarantee
1899 * that the operation will be fully undone (or that
1900 * nothing ever happened).
1902 * @param operation operation to cancel
1905 GNUNET_TESTBED_operation_cancel (struct GNUNET_TESTBED_Operation *operation)
1907 GNUNET_TESTBED_operation_done (operation);
1912 * Signal that the information from an operation has been fully
1913 * processed. This function MUST be called for each event
1914 * of type 'operation_finished' to fully remove the operation
1915 * from the operation queue. After calling this function, the
1916 * 'op_result' becomes invalid (!).
1918 * @param operation operation to signal completion for
1921 GNUNET_TESTBED_operation_done (struct GNUNET_TESTBED_Operation *operation)
1923 switch (operation->type)
1925 case OP_PEER_CREATE:
1926 case OP_PEER_DESTROY:
1930 case OP_OVERLAY_CONNECT:
1931 case OP_LINK_CONTROLLERS:
1932 GNUNET_TESTBED_operation_release_ (operation);
1942 * Generates configuration by uncompressing configuration in given message. The
1943 * given message should be of the following types:
1944 * GNUNET_MESSAGE_TYPE_TESTBED_PEERCONFIG,
1945 * GNUNET_MESSAGE_TYPE_TESTBED_SLAVECONFIG
1947 * @param msg the message containing compressed configuration
1948 * @return handle to the parsed configuration
1950 struct GNUNET_CONFIGURATION_Handle *
1951 GNUNET_TESTBED_extract_config_ (const struct GNUNET_MessageHeader *msg)
1953 struct GNUNET_CONFIGURATION_Handle *cfg;
1960 switch (ntohs (msg->type))
1962 case GNUNET_MESSAGE_TYPE_TESTBED_PEERCONFIG:
1964 const struct GNUNET_TESTBED_PeerConfigurationInformationMessage *imsg;
1966 imsg = (const struct GNUNET_TESTBED_PeerConfigurationInformationMessage *)
1968 data_len = (uLong) ntohs (imsg->config_size);
1969 xdata_len = ntohs (imsg->header.size)
1970 - sizeof (struct GNUNET_TESTBED_PeerConfigurationInformationMessage);
1971 xdata = (const Bytef *) &imsg[1];
1974 case GNUNET_MESSAGE_TYPE_TESTBED_GETSLAVECONFIG:
1976 const struct GNUNET_TESTBED_SlaveConfiguration *imsg;
1978 imsg = (const struct GNUNET_TESTBED_SlaveConfiguration *) msg;
1979 data_len = (uLong) ntohs (imsg->config_size);
1980 xdata_len = ntohs (imsg->header.size)
1981 - sizeof (struct GNUNET_TESTBED_SlaveConfiguration);
1982 xdata = (const Bytef *) &imsg[1];
1988 data = GNUNET_malloc (data_len);
1991 uncompress (data, &data_len, xdata, xdata_len)))
1993 cfg = GNUNET_CONFIGURATION_create ();
1994 GNUNET_assert (GNUNET_OK ==
1995 GNUNET_CONFIGURATION_deserialize (cfg, (const char *) data,
2004 * Checks the integrity of the OperationFailureEventMessage and if good returns
2005 * the error message it contains.
2007 * @param msg the OperationFailureEventMessage
2008 * @return the error message
2011 GNUNET_TESTBED_parse_error_string_ (const struct
2012 GNUNET_TESTBED_OperationFailureEventMessage
2018 msize = ntohs (msg->header.size);
2019 if (sizeof (struct GNUNET_TESTBED_OperationFailureEventMessage) >= msize)
2021 msize -= sizeof (struct GNUNET_TESTBED_OperationFailureEventMessage);
2022 emsg = (const char *) &msg[1];
2023 if ('\0' != emsg[msize])
2031 /* end of testbed_api.c */