src/testbed/testbed_api.c

   1 /*
   2       This file is part of GNUnet
   3       (C) 2008--2012 Christian Grothoff (and other contributing authors)
   4
   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.
   9
  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.
  14
  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.
  19  */
  20
  21 /**
  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
  28  */
  29
  30
  31 #include "platform.h"
  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"
  37 #include <zlib.h>
  38
  39 #include "testbed.h"
  40 #include "testbed_api.h"
  41 #include "testbed_api_hosts.h"
  42 #include "testbed_api_peers.h"
  43 #include "testbed_api_operations.h"
  44
  45 /**
  46  * Generic logging shorthand
  47  */
  48 #define LOG(kind, ...)                          \
  49   GNUNET_log_from (kind, "testbed-api", __VA_ARGS__);
  50
  51 /**
  52  * Debug logging
  53  */
  54 #define LOG_DEBUG(...)                          \
  55   LOG (GNUNET_ERROR_TYPE_DEBUG, __VA_ARGS__);
  56
  57 /**
  58  * Relative time seconds shorthand
  59  */
  60 #define TIME_REL_SECS(sec) \
  61   GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, sec)
  62
  63
  64 /**
  65  * Default server message sending retry timeout
  66  */
  67 #define TIMEOUT_REL TIME_REL_SECS(1)
  68
  69
  70 /**
  71  * The message queue for sending messages to the controller service
  72  */
  73 struct MessageQueue
  74 {
  75   /**
  76    * The message to be sent
  77    */
  78   struct GNUNET_MessageHeader *msg;
  79
  80   /**
  81    * next pointer for DLL
  82    */
  83   struct MessageQueue *next;
  84
  85   /**
  86    * prev pointer for DLL
  87    */
  88   struct MessageQueue *prev;
  89 };
  90
  91
  92 /**
  93  * Structure for a controller link
  94  */
  95 struct ControllerLink
  96 {
  97   /**
  98    * The next ptr for DLL
  99    */
 100   struct ControllerLink *next;
 101
 102   /**
 103    * The prev ptr for DLL
 104    */
 105   struct ControllerLink *prev;
 106
 107   /**
 108    * The host which will be referred in the peer start request. This is the
 109    * host where the peer should be started
 110    */
 111   struct GNUNET_TESTBED_Host *delegated_host;
 112
 113   /**
 114    * The host which will contacted to delegate the peer start request
 115    */
 116   struct GNUNET_TESTBED_Host *slave_host;
 117
 118   /**
 119    * The configuration to be used to connect to slave host
 120    */
 121   const struct GNUNET_CONFIGURATION_Handle *slave_cfg;
 122
 123   /**
 124    * GNUNET_YES if the slave should be started (and stopped) by us; GNUNET_NO
 125    * if we are just allowed to use the slave via TCP/IP
 126    */
 127   int is_subordinate;
 128 };
 129
 130
 131 /**
 132  * handle for host registration
 133  */
 134 struct GNUNET_TESTBED_HostRegistrationHandle
 135 {
 136   /**
 137    * The host being registered
 138    */
 139   struct GNUNET_TESTBED_Host *host;
 140
 141   /**
 142    * The controller at which this host is being registered
 143    */
 144   struct GNUNET_TESTBED_Controller *c;
 145
 146   /**
 147    * The Registartion completion callback
 148    */
 149   GNUNET_TESTBED_HostRegistrationCompletion cc;
 150
 151   /**
 152    * The closure for above callback
 153    */
 154   void *cc_cls;
 155 };
 156
 157
 158 /**
 159  * Context data for forwarded Operation
 160  */
 161 struct ForwardedOperationData
 162 {
 163
 164   /**
 165    * The callback to call when reply is available
 166    */
 167   GNUNET_CLIENT_MessageHandler cc;
 168
 169   /**
 170    * The closure for the above callback
 171    */
 172   void *cc_cls;
 173
 174 };
 175
 176
 177 /**
 178  * Returns the operation context with the given id if found in the Operation
 179  * context queues of the controller
 180  *
 181  * @param c the controller whose queues are searched
 182  * @param id the id which has to be checked
 183  * @return the matching operation context; NULL if no match found
 184  */
 185 static struct OperationContext *
 186 find_opc (const struct GNUNET_TESTBED_Controller *c, const uint64_t id)
 187 {
 188   struct OperationContext *opc;
 189
 190   for (opc = c->ocq_head; NULL != opc; opc = opc->next)
 191   {
 192     if (id == opc->id)
 193       return opc;
 194   }
 195   return NULL;
 196 }
 197
 198
 199 /**
 200  * Handler for GNUNET_MESSAGE_TYPE_TESTBED_ADDHOSTCONFIRM message from
 201  * controller (testbed service)
 202  *
 203  * @param c the controller handler
 204  * @param msg message received
 205  * @return GNUNET_YES if we can continue receiving from service; GNUNET_NO if
 206  *           not
 207  */
 208 static int
 209 handle_addhostconfirm (struct GNUNET_TESTBED_Controller *c,
 210                        const struct GNUNET_TESTBED_HostConfirmedMessage *msg)
 211 {
 212   struct GNUNET_TESTBED_HostRegistrationHandle *rh;
 213   char *emsg;
 214   uint16_t msg_size;
 215
 216   rh = c->rh;
 217   if (NULL == rh)
 218   {
 219     return GNUNET_OK;
 220   }
 221   if (GNUNET_TESTBED_host_get_id_ (rh->host) != ntohl (msg->host_id))
 222   {
 223     LOG_DEBUG ("Mismatch in host id's %u, %u of host confirm msg\n",
 224                GNUNET_TESTBED_host_get_id_ (rh->host), ntohl (msg->host_id));
 225     return GNUNET_OK;
 226   }
 227   c->rh = NULL;
 228   msg_size = ntohs (msg->header.size);
 229   if (sizeof (struct GNUNET_TESTBED_HostConfirmedMessage) == msg_size)
 230   {
 231     LOG_DEBUG ("Host %u successfully registered\n", ntohl (msg->host_id));
 232     GNUNET_TESTBED_mark_host_registered_at_  (rh->host, c);
 233     rh->cc (rh->cc_cls, NULL);
 234     GNUNET_free (rh);
 235     return GNUNET_OK;
 236   }
 237   /* We have an error message */
 238   emsg = (char *) &msg[1];
 239   if ('\0' != emsg[msg_size -
 240                    sizeof (struct GNUNET_TESTBED_HostConfirmedMessage)])
 241   {
 242     GNUNET_break (0);
 243     GNUNET_free (rh);
 244     return GNUNET_NO;
 245   }
 246   LOG (GNUNET_ERROR_TYPE_ERROR, _("Adding host %u failed with error: %s\n"),
 247        ntohl (msg->host_id), emsg);
 248   rh->cc (rh->cc_cls, emsg);
 249   GNUNET_free (rh);
 250   return GNUNET_OK;
 251 }
 252
 253
 254 /**
 255  * Handler for GNUNET_MESSAGE_TYPE_TESTBED_ADDHOSTCONFIRM message from
 256  * controller (testbed service)
 257  *
 258  * @param c the controller handler
 259  * @param msg message received
 260  * @return GNUNET_YES if we can continue receiving from service; GNUNET_NO if
 261  *           not
 262  */
 263 static int
 264 handle_opsuccess (struct GNUNET_TESTBED_Controller *c,
 265                   const struct
 266                   GNUNET_TESTBED_GenericOperationSuccessEventMessage *msg)
 267 {
 268   struct OperationContext *opc;
 269   struct GNUNET_TESTBED_EventInformation *event;
 270   uint64_t op_id;
 271
 272   op_id = GNUNET_ntohll (msg->operation_id);
 273   LOG_DEBUG ("Operation %ul successful\n", op_id);
 274   if (NULL == (opc = find_opc (c, op_id)))
 275   {
 276     LOG_DEBUG ("Operation not found\n");
 277     return GNUNET_YES;
 278   }
 279   event = NULL;
 280   if (0 != (c->event_mask & (1L << GNUNET_TESTBED_ET_OPERATION_FINISHED)))
 281     event = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_EventInformation));
 282   if (NULL != event)
 283     event->type = GNUNET_TESTBED_ET_OPERATION_FINISHED;
 284   switch (opc->type)
 285   {
 286   case OP_FORWARDED:
 287     {
 288       struct ForwardedOperationData *fo_data;
 289
 290       fo_data = opc->data;
 291       if (NULL != fo_data->cc)
 292         fo_data->cc (fo_data->cc_cls, (const struct GNUNET_MessageHeader *) msg);
 293       GNUNET_CONTAINER_DLL_remove (c->ocq_head, c->ocq_tail, opc);
 294       GNUNET_free (fo_data);
 295       GNUNET_free (opc);
 296       return GNUNET_YES;
 297     }
 298     break;
 299   case OP_PEER_DESTROY:
 300     {
 301       struct GNUNET_TESTBED_Peer *peer;
 302       peer = opc->data;
 303       GNUNET_free (peer);
 304       opc->data = NULL;
 305       //PEERDESTROYDATA
 306     }
 307     break;
 308   case OP_LINK_CONTROLLERS:
 309     break;
 310   default:
 311     GNUNET_assert (0);
 312   }
 313   if (NULL != event)
 314   {
 315     event->details.operation_finished.operation = opc->op;
 316     event->details.operation_finished.op_cls = NULL;
 317     event->details.operation_finished.emsg = NULL;
 318     event->details.operation_finished.pit = GNUNET_TESTBED_PIT_GENERIC;
 319     event->details.operation_finished.op_result.generic = NULL;
 320   }
 321   GNUNET_CONTAINER_DLL_remove (opc->c->ocq_head, opc->c->ocq_tail, opc);
 322   opc->state = OPC_STATE_FINISHED;
 323   if (NULL != event)
 324   {
 325     if (NULL != c->cc)
 326       c->cc (c->cc_cls, event);
 327     GNUNET_free (event);
 328   }
 329   return GNUNET_YES;
 330 }
 331
 332
 333 /**
 334  * Handler for GNUNET_MESSAGE_TYPE_TESTBED_PEERCREATESUCCESS message from
 335  * controller (testbed service)
 336  *
 337  * @param c the controller handler
 338  * @param msg message received
 339  * @return GNUNET_YES if we can continue receiving from service; GNUNET_NO if
 340  *           not
 341  */
 342 static int
 343 handle_peer_create_success (struct GNUNET_TESTBED_Controller *c,
 344                             const struct
 345                             GNUNET_TESTBED_PeerCreateSuccessEventMessage *msg)
 346 {
 347   struct OperationContext *opc;
 348   struct PeerCreateData *data;
 349   struct GNUNET_TESTBED_Peer *peer;
 350   GNUNET_TESTBED_PeerCreateCallback cb;
 351   void *cls;
 352   uint64_t op_id;
 353
 354   GNUNET_assert (sizeof (struct GNUNET_TESTBED_PeerCreateSuccessEventMessage)
 355                  == ntohs (msg->header.size));
 356   op_id = GNUNET_ntohll (msg->operation_id);
 357   if (NULL == (opc = find_opc (c, op_id)))
 358   {
 359     LOG_DEBUG ("Operation context for PeerCreateSuccessEvent not found\n");
 360     return GNUNET_YES;
 361   }
 362   if (OP_FORWARDED == opc->type)
 363   {
 364     struct ForwardedOperationData *fo_data;
 365
 366     fo_data = opc->data;
 367     if (NULL != fo_data->cc)
 368       fo_data->cc (fo_data->cc_cls, (const struct GNUNET_MessageHeader *) msg);
 369     GNUNET_CONTAINER_DLL_remove (c->ocq_head, c->ocq_tail, opc);
 370     GNUNET_free (fo_data);
 371     GNUNET_free (opc);
 372     return GNUNET_YES;
 373   }
 374   GNUNET_assert (OP_PEER_CREATE == opc->type);
 375   GNUNET_assert (NULL != opc->data);
 376   data = opc->data;
 377   GNUNET_assert (NULL != data->peer);
 378   peer = data->peer;
 379   GNUNET_assert (peer->unique_id == ntohl (msg->peer_id));
 380   peer->state = PS_CREATED;
 381   cb = data->cb;
 382   cls = data->cls;
 383   GNUNET_free (opc->data);
 384   GNUNET_CONTAINER_DLL_remove (opc->c->ocq_head, opc->c->ocq_tail, opc);
 385   opc->state = OPC_STATE_FINISHED;
 386   if (NULL != cb)
 387     cb (cls, peer, NULL);
 388   return GNUNET_YES;
 389 }
 390
 391
 392 /**
 393  * Handler for GNUNET_MESSAGE_TYPE_TESTBED_PEEREVENT message from
 394  * controller (testbed service)
 395  *
 396  * @param c the controller handler
 397  * @param msg message received
 398  * @return GNUNET_YES if we can continue receiving from service; GNUNET_NO if
 399  *           not
 400  */
 401 static int
 402 handle_peer_event (struct GNUNET_TESTBED_Controller *c,
 403                    const struct GNUNET_TESTBED_PeerEventMessage *msg)
 404 {
 405   struct OperationContext *opc;
 406   struct GNUNET_TESTBED_Peer *peer;
 407   struct GNUNET_TESTBED_EventInformation event;
 408   uint64_t op_id;
 409
 410   GNUNET_assert (sizeof (struct GNUNET_TESTBED_PeerEventMessage)
 411                  == ntohs (msg->header.size));
 412   op_id = GNUNET_ntohll (msg->operation_id);
 413   if (NULL == (opc = find_opc (c, op_id)))
 414   {
 415     LOG_DEBUG ("Operation not found\n");
 416     return GNUNET_YES;
 417   }
 418   if (OP_FORWARDED == opc->type)
 419   {
 420     struct ForwardedOperationData *fo_data;
 421
 422     fo_data = opc->data;
 423     if (NULL != fo_data->cc)
 424       fo_data->cc (fo_data->cc_cls, (const struct GNUNET_MessageHeader *) msg);
 425     GNUNET_CONTAINER_DLL_remove (c->ocq_head, c->ocq_tail, opc);
 426     GNUNET_free (fo_data);
 427     GNUNET_free (opc);
 428     return GNUNET_YES;
 429   }
 430   GNUNET_assert ((OP_PEER_START == opc->type) || (OP_PEER_STOP == opc->type));
 431   peer = opc->data;
 432   GNUNET_assert (NULL != peer);
 433   event.type = (enum GNUNET_TESTBED_EventType) ntohl (msg->event_type);
 434   switch (event.type)
 435   {
 436   case GNUNET_TESTBED_ET_PEER_START:
 437     peer->state = PS_STARTED;
 438     event.details.peer_start.host = peer->host;
 439     event.details.peer_start.peer = peer;
 440     break;
 441   case GNUNET_TESTBED_ET_PEER_STOP:
 442     peer->state = PS_STOPPED;
 443     event.details.peer_stop.peer = peer;
 444     break;
 445   default:
 446     GNUNET_assert (0);          /* We should never reach this state */
 447   }
 448   GNUNET_CONTAINER_DLL_remove (opc->c->ocq_head, opc->c->ocq_tail, opc);
 449   opc->state = OPC_STATE_FINISHED;
 450   if (0 != ((GNUNET_TESTBED_ET_PEER_START | GNUNET_TESTBED_ET_PEER_STOP)
 451             & c->event_mask))
 452   {
 453     if (NULL != c->cc)
 454       c->cc (c->cc_cls, &event);
 455   }
 456   return GNUNET_YES;
 457 }
 458
 459
 460 /**
 461  * Handler for GNUNET_MESSAGE_TYPE_TESTBED_PEERCONEVENT message from
 462  * controller (testbed service)
 463  *
 464  * @param c the controller handler
 465  * @param msg message received
 466  * @return GNUNET_YES if we can continue receiving from service; GNUNET_NO if
 467  *           not
 468  */
 469 static int
 470 handle_peer_conevent (struct GNUNET_TESTBED_Controller *c,
 471                       const struct GNUNET_TESTBED_ConnectionEventMessage *msg)
 472 {
 473   struct OperationContext *opc;
 474   struct OverlayConnectData *data;
 475   struct GNUNET_TESTBED_EventInformation event;
 476   uint64_t op_id;
 477
 478   op_id = GNUNET_ntohll (msg->operation_id);
 479   if (NULL == (opc = find_opc (c, op_id)))
 480   {
 481     LOG_DEBUG ("Operation not found\n");
 482     return GNUNET_YES;
 483   }
 484   data = opc->data;
 485   GNUNET_assert (NULL != data);
 486   GNUNET_assert ((ntohl (msg->peer1) == data->p1->unique_id)
 487                   && (ntohl (msg->peer2) == data->p2->unique_id));
 488   event.type = (enum GNUNET_TESTBED_EventType) ntohl (msg->event_type);
 489   switch (event.type)
 490   {
 491   case GNUNET_TESTBED_ET_CONNECT:
 492     event.details.peer_connect.peer1 = data->p1;
 493     event.details.peer_connect.peer2 = data->p2;
 494     break;
 495   case GNUNET_TESTBED_ET_DISCONNECT:
 496     GNUNET_assert (0);          /* FIXME: implement */
 497     break;
 498   default:
 499     GNUNET_assert (0);          /* Should never reach here */
 500     break;
 501   }
 502   GNUNET_CONTAINER_DLL_remove (opc->c->ocq_head, opc->c->ocq_tail, opc);
 503   opc->state = OPC_STATE_FINISHED;
 504   GNUNET_free (data);
 505   if (0 != ((GNUNET_TESTBED_ET_CONNECT | GNUNET_TESTBED_ET_DISCONNECT)
 506             & c->event_mask))
 507   {
 508     if (NULL != c->cc)
 509       c->cc (c->cc_cls, &event);
 510   }
 511   return GNUNET_YES;
 512 }
 513
 514
 515 /**
 516  * Handler for GNUNET_MESSAGE_TYPE_TESTBED_PEERCONFIG message from
 517  * controller (testbed service)
 518  *
 519  * @param c the controller handler
 520  * @param msg message received
 521  * @return GNUNET_YES if we can continue receiving from service; GNUNET_NO if
 522  *           not
 523  */
 524 static int
 525 handle_peer_config (struct GNUNET_TESTBED_Controller *c,
 526                     const struct GNUNET_TESTBED_PeerConfigurationInformationMessage *msg)
 527 {
 528   struct OperationContext *opc;
 529   struct GNUNET_TESTBED_Peer *peer;
 530   struct PeerInfoData *data;
 531   struct PeerInfoData2 *response_data;
 532   struct GNUNET_TESTBED_EventInformation info;
 533   uint64_t op_id;
 534
 535   op_id = GNUNET_ntohll (msg->operation_id);
 536   if (NULL == (opc = find_opc (c, op_id)))
 537   {
 538     LOG_DEBUG ("Operation not found\n");
 539     return GNUNET_YES;
 540   }
 541   if (OP_FORWARDED == opc->type)
 542   {
 543     struct ForwardedOperationData *fo_data;
 544
 545     fo_data = opc->data;
 546     if (NULL != fo_data->cc)
 547       fo_data->cc (fo_data->cc_cls, (const struct GNUNET_MessageHeader *) msg);
 548     GNUNET_CONTAINER_DLL_remove (c->ocq_head, c->ocq_tail, opc);
 549     GNUNET_free (fo_data);
 550     GNUNET_free (opc);
 551     return GNUNET_YES;
 552   }
 553   data = opc->data;
 554   GNUNET_assert (NULL != data);
 555   peer = data->peer;
 556   GNUNET_assert (NULL != peer);
 557   GNUNET_assert (ntohl (msg->peer_id) == peer->unique_id);
 558   if (0 == (c->event_mask & (1L << GNUNET_TESTBED_ET_OPERATION_FINISHED)))
 559   {
 560     LOG_DEBUG ("Skipping operation callback as flag not set\n");
 561     return GNUNET_YES;
 562   }
 563   response_data = GNUNET_malloc (sizeof (struct PeerInfoData2));
 564   response_data->pit = data->pit;
 565   GNUNET_free (data);
 566   opc->data = NULL;
 567   info.type = GNUNET_TESTBED_ET_OPERATION_FINISHED;
 568   info.details.operation_finished.operation = opc->op;
 569   info.details.operation_finished.op_cls = NULL;
 570   info.details.operation_finished.emsg = NULL;
 571   info.details.operation_finished.pit = response_data->pit;
 572   switch (response_data->pit)
 573   {
 574   case GNUNET_TESTBED_PIT_IDENTITY:
 575     {
 576       struct GNUNET_PeerIdentity *peer_identity;
 577
 578       peer_identity = GNUNET_malloc (sizeof (struct GNUNET_PeerIdentity));
 579       (void) memcpy (peer_identity, &msg->peer_identity,
 580                      sizeof (struct GNUNET_PeerIdentity));
 581       response_data->details.peer_identity = peer_identity;
 582       info.details.operation_finished.op_result.pid = peer_identity;
 583     }
 584     break;
 585   case GNUNET_TESTBED_PIT_CONFIGURATION:
 586     response_data->details.cfg = /* Freed in oprelease_peer_getinfo */
 587       GNUNET_TESTBED_get_config_from_peerinfo_msg_ (msg);
 588     info.details.operation_finished.op_result.cfg = response_data->details.cfg;
 589     break;
 590   case GNUNET_TESTBED_PIT_GENERIC:
 591     GNUNET_assert (0);          /* never reach here */
 592     break;
 593   }
 594   opc->data = response_data;
 595   GNUNET_CONTAINER_DLL_remove (opc->c->ocq_head, opc->c->ocq_tail, opc);
 596   opc->state = OPC_STATE_FINISHED;
 597   if (0 != ((GNUNET_TESTBED_ET_CONNECT | GNUNET_TESTBED_ET_DISCONNECT)
 598             & c->event_mask))
 599   {
 600     if (NULL != c->cc)
 601       c->cc (c->cc_cls, &info);
 602   }
 603
 604   return GNUNET_YES;
 605 }
 606
 607
 608 /**
 609  * Handler for messages from controller (testbed service)
 610  *
 611  * @param cls the controller handler
 612  * @param msg message received, NULL on timeout or fatal error
 613  */
 614 static void
 615 message_handler (void *cls, const struct GNUNET_MessageHeader *msg)
 616 {
 617   struct GNUNET_TESTBED_Controller *c = cls;
 618   int status;
 619   uint16_t msize;
 620
 621   c->in_receive = GNUNET_NO;
 622   /* FIXME: Add checks for message integrity */
 623   if (NULL == msg)
 624   {
 625     LOG_DEBUG ("Receive timed out or connection to service dropped\n");
 626     return;
 627   }
 628   status = GNUNET_OK;
 629   msize = ntohs (msg->size);
 630   switch (ntohs (msg->type))
 631   {
 632   case GNUNET_MESSAGE_TYPE_TESTBED_ADDHOSTCONFIRM:
 633     GNUNET_assert (msize >= sizeof (struct
 634                                     GNUNET_TESTBED_HostConfirmedMessage));
 635     status =
 636       handle_addhostconfirm (c, (const struct GNUNET_TESTBED_HostConfirmedMessage *) msg);
 637     break;
 638   case GNUNET_MESSAGE_TYPE_TESTBED_GENERICOPSUCCESS:
 639     GNUNET_assert
 640       (msize == sizeof (struct GNUNET_TESTBED_GenericOperationSuccessEventMessage));
 641     status =
 642       handle_opsuccess (c, (const struct
 643                             GNUNET_TESTBED_GenericOperationSuccessEventMessage
 644                             *) msg);
 645     break;
 646   case GNUNET_MESSAGE_TYPE_TESTBED_PEERCREATESUCCESS:
 647     GNUNET_assert (msize ==
 648                    sizeof (struct GNUNET_TESTBED_PeerCreateSuccessEventMessage));
 649     status =
 650       handle_peer_create_success
 651       (c, (const struct GNUNET_TESTBED_PeerCreateSuccessEventMessage *)msg);
 652     break;
 653   case GNUNET_MESSAGE_TYPE_TESTBED_PEEREVENT:
 654     GNUNET_assert (msize == sizeof (struct GNUNET_TESTBED_PeerEventMessage));
 655     status =
 656       handle_peer_event (c, (const struct GNUNET_TESTBED_PeerEventMessage *) msg);
 657
 658     break;
 659   case GNUNET_MESSAGE_TYPE_TESTBED_PEERCONFIG:
 660     GNUNET_assert (msize >=
 661                    sizeof (struct GNUNET_TESTBED_PeerConfigurationInformationMessage));
 662     status =
 663       handle_peer_config
 664       (c, (const struct GNUNET_TESTBED_PeerConfigurationInformationMessage *)
 665   msg);
 666     break;
 667   case GNUNET_MESSAGE_TYPE_TESTBED_PEERCONEVENT:
 668     GNUNET_assert (msize ==
 669                    sizeof (struct GNUNET_TESTBED_ConnectionEventMessage));
 670     status =
 671       handle_peer_conevent (c, (const struct
 672                                 GNUNET_TESTBED_ConnectionEventMessage *) msg);
 673     break;
 674   default:
 675     GNUNET_break (0);
 676   }
 677   if ((GNUNET_OK == status) && (GNUNET_NO == c->in_receive))
 678   {
 679     c->in_receive = GNUNET_YES;
 680     GNUNET_CLIENT_receive (c->client, &message_handler, c,
 681                            GNUNET_TIME_UNIT_FOREVER_REL);
 682   }
 683 }
 684
 685
 686 /**
 687  * Function called to notify a client about the connection begin ready to queue
 688  * more data.  "buf" will be NULL and "size" zero if the connection was closed
 689  * for writing in the meantime.
 690  *
 691  * @param cls closure
 692  * @param size number of bytes available in buf
 693  * @param buf where the callee should write the message
 694  * @return number of bytes written to buf
 695  */
 696 static size_t
 697 transmit_ready_notify (void *cls, size_t size, void *buf)
 698 {
 699   struct GNUNET_TESTBED_Controller *c = cls;
 700   struct MessageQueue *mq_entry;
 701
 702   c->th = NULL;
 703   mq_entry = c->mq_head;
 704   GNUNET_assert (NULL != mq_entry);
 705   if ((0 == size) && (NULL == buf)) /* Timeout */
 706   {
 707     LOG_DEBUG ("Message sending timed out -- retrying\n");
 708     c->th =
 709       GNUNET_CLIENT_notify_transmit_ready (c->client,
 710                                            ntohs (mq_entry->msg->size),
 711                                            TIMEOUT_REL,
 712                                            GNUNET_YES, &transmit_ready_notify,
 713                                            c);
 714     return 0;
 715   }
 716   GNUNET_assert (ntohs (mq_entry->msg->size) <= size);
 717   size = ntohs (mq_entry->msg->size);
 718   memcpy (buf, mq_entry->msg, size);
 719   LOG_DEBUG ("Message of type: %u and size: %u sent\n",
 720              ntohs (mq_entry->msg->type), size);
 721   GNUNET_free (mq_entry->msg);
 722   GNUNET_CONTAINER_DLL_remove (c->mq_head, c->mq_tail, mq_entry);
 723   GNUNET_free (mq_entry);
 724   mq_entry = c->mq_head;
 725   if (NULL != mq_entry)
 726     c->th =
 727       GNUNET_CLIENT_notify_transmit_ready (c->client,
 728                                            ntohs (mq_entry->msg->size),
 729                                            TIMEOUT_REL,
 730                                            GNUNET_YES, &transmit_ready_notify,
 731                                            c);
 732   if (GNUNET_NO == c->in_receive)
 733   {
 734     c->in_receive = GNUNET_YES;
 735     GNUNET_CLIENT_receive (c->client, &message_handler, c,
 736                            GNUNET_TIME_UNIT_FOREVER_REL);
 737   }
 738   return size;
 739 }
 740
 741
 742 /**
 743  * Queues a message in send queue for sending to the service
 744  *
 745  * @param controller the handle to the controller
 746  * @param msg the message to queue
 747  */
 748 void
 749 GNUNET_TESTBED_queue_message_ (struct GNUNET_TESTBED_Controller *controller,
 750                                struct GNUNET_MessageHeader *msg)
 751 {
 752   struct MessageQueue *mq_entry;
 753   uint16_t type;
 754   uint16_t size;
 755
 756   type = ntohs (msg->type);
 757   size = ntohs (msg->size);
 758   GNUNET_assert ((GNUNET_MESSAGE_TYPE_TESTBED_INIT <= type) &&
 759                  (GNUNET_MESSAGE_TYPE_TESTBED_MAX > type));
 760   mq_entry = GNUNET_malloc (sizeof (struct MessageQueue));
 761   mq_entry->msg = msg;
 762   LOG (GNUNET_ERROR_TYPE_DEBUG,
 763        "Queueing message of type %u, size %u for sending\n", type,
 764        ntohs (msg->size));
 765   GNUNET_CONTAINER_DLL_insert_tail (controller->mq_head, controller->mq_tail,
 766                                     mq_entry);
 767   if (NULL == controller->th)
 768     controller->th =
 769       GNUNET_CLIENT_notify_transmit_ready (controller->client, size,
 770                                            TIMEOUT_REL,
 771                                            GNUNET_YES, &transmit_ready_notify,
 772                                            controller);
 773 }
 774
 775
 776 /**
 777  * Sends the given message as an operation. The given callback is called when a
 778  * reply for the operation is available.  Call
 779  * GNUNET_TESTBED_forward_operation_msg_cancel_() to cleanup the returned
 780  * operation context if the cc hasn't been called
 781  *
 782  * @param controller the controller to which the message has to be sent
 783  * @param operation_id the operation id of the message
 784  * @param msg the message to send
 785  * @param cc the callback to call when reply is available
 786  * @param cc_cls the closure for the above callback
 787  * @return the operation context which can be used to cancel the forwarded
 788  *           operation
 789  */
 790 struct OperationContext *
 791 GNUNET_TESTBED_forward_operation_msg_ (struct GNUNET_TESTBED_Controller
 792                                        * controller,
 793                                        uint64_t operation_id,
 794                                        const struct GNUNET_MessageHeader *msg,
 795                                        GNUNET_CLIENT_MessageHandler cc,
 796                                        void *cc_cls)
 797 {
 798   struct OperationContext *opc;
 799   struct ForwardedOperationData *data;
 800   struct GNUNET_MessageHeader *dup_msg;
 801   uint16_t msize;
 802
 803   data = GNUNET_malloc (sizeof (struct ForwardedOperationData));
 804   data->cc = cc;
 805   data->cc_cls = cc_cls;
 806   opc = GNUNET_malloc (sizeof (struct OperationContext));
 807   opc->c = controller;
 808   opc->type = OP_FORWARDED;
 809   opc->data = data;
 810   opc->id = operation_id;
 811   msize = ntohs (msg->size);
 812   dup_msg = GNUNET_malloc (msize);
 813   (void) memcpy (dup_msg, msg, msize);
 814   GNUNET_TESTBED_queue_message_ (opc->c, dup_msg);
 815   GNUNET_CONTAINER_DLL_insert_tail (controller->ocq_head,
 816                                     controller->ocq_tail, opc);
 817   return opc;
 818 }
 819
 820
 821 /**
 822  * Function to cancel an operation created by simply forwarding an operation
 823  * message.
 824  *
 825  * @param opc the operation context from GNUNET_TESTBED_forward_operation_msg_()
 826  */
 827 void
 828 GNUNET_TESTBED_forward_operation_msg_cancel_ (struct OperationContext *opc)
 829 {
 830   GNUNET_CONTAINER_DLL_remove (opc->c->ocq_head, opc->c->ocq_tail, opc);
 831   GNUNET_free (opc->data);
 832   GNUNET_free (opc);
 833 }
 834
 835
 836 /**
 837  * Handle for controller process
 838  */
 839 struct GNUNET_TESTBED_ControllerProc
 840 {
 841   /**
 842    * The process handle
 843    */
 844   struct GNUNET_HELPER_Handle *helper;
 845
 846   /**
 847    * The host where the helper is run
 848    */
 849   struct GNUNET_TESTBED_Host *host;
 850
 851   /**
 852    * The controller error callback
 853    */
 854   GNUNET_TESTBED_ControllerStatusCallback cb;
 855
 856   /**
 857    * The closure for the above callback
 858    */
 859   void *cls;
 860
 861   /**
 862    * The send handle for the helper
 863    */
 864   struct GNUNET_HELPER_SendHandle *shandle;
 865
 866   /**
 867    * The message corresponding to send handle
 868    */
 869   struct GNUNET_MessageHeader *msg;
 870
 871   /**
 872    * The port number for ssh; used for helpers starting ssh
 873    */
 874   char *port;
 875
 876   /**
 877    * The ssh destination string; used for helpers starting ssh
 878    */
 879   char *dst;
 880
 881   /**
 882    * The configuration of the running testbed service
 883    */
 884   struct GNUNET_CONFIGURATION_Handle *cfg;
 885
 886 };
 887
 888
 889 /**
 890  * Functions with this signature are called whenever a
 891  * complete message is received by the tokenizer.
 892  *
 893  * Do not call GNUNET_SERVER_mst_destroy in callback
 894  *
 895  * @param cls closure
 896  * @param client identification of the client
 897  * @param message the actual message
 898  *
 899  * @return GNUNET_OK on success, GNUNET_SYSERR to stop further processing
 900  */
 901 static int
 902 helper_mst (void *cls, void *client,
 903             const struct GNUNET_MessageHeader *message)
 904 {
 905   struct GNUNET_TESTBED_ControllerProc *cp = cls;
 906   const struct GNUNET_TESTBED_HelperReply *msg;
 907   const char *hostname;
 908   char *config;
 909   uLongf config_size;
 910   uLongf xconfig_size;
 911
 912   msg = (const struct GNUNET_TESTBED_HelperReply *) message;
 913   GNUNET_assert (sizeof (struct GNUNET_TESTBED_HelperReply)
 914                  < ntohs (msg->header.size));
 915   GNUNET_assert (GNUNET_MESSAGE_TYPE_TESTBED_HELPER_REPLY
 916                  == ntohs (msg->header.type));
 917   config_size = (uLongf) ntohs (msg->config_size);
 918   xconfig_size = (uLongf) (ntohs (msg->header.size)
 919                            - sizeof (struct GNUNET_TESTBED_HelperReply));
 920   config = GNUNET_malloc (config_size);
 921   GNUNET_assert (Z_OK == uncompress ((Bytef *) config, &config_size,
 922                                      (const Bytef *) &msg[1], xconfig_size));
 923   GNUNET_assert (NULL == cp->cfg);
 924   cp->cfg = GNUNET_CONFIGURATION_create ();
 925   GNUNET_assert (GNUNET_CONFIGURATION_deserialize (cp->cfg, config,
 926                                                    config_size, GNUNET_NO));
 927   GNUNET_free (config);
 928   if ((NULL == cp->host) ||
 929       (NULL == (hostname = GNUNET_TESTBED_host_get_hostname_ (cp->host))))
 930     hostname = "localhost";
 931   /* Change the hostname so that we can connect to it */
 932   GNUNET_CONFIGURATION_set_value_string (cp->cfg, "testbed", "hostname",
 933                                          hostname);
 934   cp->cb (cp->cls, cp->cfg, GNUNET_OK);
 935   return GNUNET_OK;
 936 }
 937
 938
 939 /**
 940  * Continuation function from GNUNET_HELPER_send()
 941  *
 942  * @param cls closure
 943  * @param result GNUNET_OK on success,
 944  *               GNUNET_NO if helper process died
 945  *               GNUNET_SYSERR during GNUNET_HELPER_stop
 946  */
 947 static void
 948 clear_msg (void *cls, int result)
 949 {
 950   struct GNUNET_TESTBED_ControllerProc *cp = cls;
 951
 952   GNUNET_assert (NULL != cp->shandle);
 953   cp->shandle = NULL;
 954   GNUNET_free (cp->msg);
 955 }
 956
 957
 958 /**
 959  * Callback that will be called when the helper process dies. This is not called
 960  * when the helper process is stoped using GNUNET_HELPER_stop()
 961  *
 962  * @param cls the closure from GNUNET_HELPER_start()
 963  */
 964 static void
 965 helper_exp_cb (void *cls)
 966 {
 967   struct GNUNET_TESTBED_ControllerProc *cp = cls;
 968   GNUNET_TESTBED_ControllerStatusCallback cb;
 969   void *cb_cls;
 970
 971   cb = cp->cb;
 972   cb_cls = cp->cls;
 973   cp->helper = NULL;
 974   GNUNET_TESTBED_controller_stop (cp);
 975   if (NULL != cb)
 976     cb (cb_cls, NULL, GNUNET_SYSERR);
 977 }
 978
 979
 980 /**
 981  * Function to call to start a link-controllers type operation once all queues
 982  * the operation is part of declare that the operation can be activated.
 983  *
 984  * @param cls the closure from GNUNET_TESTBED_operation_create_()
 985  */
 986 static void
 987 opstart_link_controllers (void *cls)
 988 {
 989   struct OperationContext *opc = cls;
 990   struct GNUNET_TESTBED_ControllerLinkMessage *msg;
 991
 992   GNUNET_assert (NULL != opc->data);
 993   msg = opc->data;
 994   opc->data = NULL;
 995   opc->state = OPC_STATE_STARTED;
 996   GNUNET_CONTAINER_DLL_insert_tail (opc->c->ocq_head, opc->c->ocq_tail, opc);
 997   GNUNET_TESTBED_queue_message_ (opc->c, &msg->header);
 998 }
 999
1000
1001 /**
1002  * Callback which will be called when link-controllers type operation is released
1003  *
1004  * @param cls the closure from GNUNET_TESTBED_operation_create_()
1005  */
1006 static void
1007 oprelease_link_controllers (void *cls)
1008 {
1009   struct OperationContext *opc = cls;
1010
1011   if (OPC_STATE_INIT == opc->state)
1012     GNUNET_free (opc->data);
1013   if (OPC_STATE_STARTED == opc->state)
1014     GNUNET_CONTAINER_DLL_remove (opc->c->ocq_head, opc->c->ocq_tail, opc);
1015   GNUNET_free (opc);
1016 }
1017
1018
1019 /**
1020  * Starts a controller process at the host. FIXME: add controller start callback
1021  * with the configuration with which the controller is started
1022  *
1023  * @param controller_ip the ip address of the controller. Will be set as TRUSTED
1024  *          host when starting testbed controller at host
1025  * @param host the host where the controller has to be started; NULL for
1026  *          localhost
1027  * @param cfg template configuration to use for the remote controller; the
1028  *          remote controller will be started with a slightly modified
1029  *          configuration (port numbers, unix domain sockets and service home
1030  *          values are changed as per TESTING library on the remote host)
1031  * @param cb function called when the controller is successfully started or
1032  *          dies unexpectedly; GNUNET_TESTBED_controller_stop shouldn't be
1033  *          called if cb is called with GNUNET_SYSERR as status. Will never be
1034  *          called in the same task as 'GNUNET_TESTBED_controller_start'
1035  *          (synchronous errors will be signalled by returning NULL). This
1036  *          parameter cannot be NULL.
1037  * @param cls closure for above callbacks
1038  * @return the controller process handle, NULL on errors
1039  */
1040 struct GNUNET_TESTBED_ControllerProc *
1041 GNUNET_TESTBED_controller_start (const char *controller_ip,
1042                                  struct GNUNET_TESTBED_Host *host,
1043                                  const struct GNUNET_CONFIGURATION_Handle *cfg,
1044                                  GNUNET_TESTBED_ControllerStatusCallback cb,
1045                                  void *cls)
1046 {
1047   struct GNUNET_TESTBED_ControllerProc *cp;
1048   struct GNUNET_TESTBED_HelperInit *msg;
1049
1050   cp = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_ControllerProc));
1051   if ((NULL == host) || (0 == GNUNET_TESTBED_host_get_id_ (host)))
1052   {
1053     char * const binary_argv[] = {
1054       "gnunet-testbed-helper", NULL
1055     };
1056
1057     cp->helper = GNUNET_HELPER_start (GNUNET_YES,
1058                                       "gnunet-testbed-helper", binary_argv,
1059                                       &helper_mst, &helper_exp_cb, cp);
1060   }
1061   else
1062   {
1063     char *remote_args[8];
1064     unsigned int argp;
1065     const char *username;
1066     const char *hostname;
1067
1068     username = GNUNET_TESTBED_host_get_username_ (host);
1069     hostname = GNUNET_TESTBED_host_get_hostname_ (host);
1070     GNUNET_asprintf (&cp->port, "%u", GNUNET_TESTBED_host_get_ssh_port_ (host));
1071     if (NULL == username)
1072       GNUNET_asprintf (&cp->dst, "%s", hostname);
1073     else
1074       GNUNET_asprintf (&cp->dst, "%s@%s", username, hostname);
1075     LOG_DEBUG ("Starting SSH to destination %s\n", cp->dst);
1076     argp = 0;
1077     remote_args[argp++] = "ssh";
1078     remote_args[argp++] = "-p";
1079     remote_args[argp++] = cp->port;
1080     remote_args[argp++] = "-o";
1081     remote_args[argp++] = "BatchMode=yes";
1082     remote_args[argp++] = cp->dst;
1083     remote_args[argp++] = "gnunet-testbed-helper";
1084     remote_args[argp++] = NULL;
1085     GNUNET_assert (argp == 8);
1086     cp->helper = GNUNET_HELPER_start (GNUNET_NO,
1087                                       "ssh", remote_args,
1088                                       &helper_mst, &helper_exp_cb, cp);
1089   }
1090   if (NULL == cp->helper)
1091   {
1092     GNUNET_free_non_null (cp->port);
1093     GNUNET_free_non_null (cp->dst);
1094     GNUNET_free (cp);
1095     return NULL;
1096   }
1097   cp->host = host;
1098   cp->cb = cb;
1099   cp->cls = cls;
1100   msg = GNUNET_TESTBED_create_helper_init_msg_ (controller_ip, cfg);
1101   cp->msg = &msg->header;
1102   cp->shandle = GNUNET_HELPER_send (cp->helper, &msg->header, GNUNET_NO,
1103                                     &clear_msg, cp);
1104   if (NULL == cp->shandle)
1105   {
1106     GNUNET_free (msg);
1107     GNUNET_TESTBED_controller_stop (cp);
1108     return NULL;
1109   }
1110   return cp;
1111 }
1112
1113
1114 /**
1115  * Stop the controller process (also will terminate all peers and controllers
1116  * dependent on this controller).  This function blocks until the testbed has
1117  * been fully terminated (!).
1118  *
1119  * @param cproc the controller process handle
1120  */
1121 void
1122 GNUNET_TESTBED_controller_stop (struct GNUNET_TESTBED_ControllerProc *cproc)
1123 {
1124   if (NULL != cproc->shandle)
1125     GNUNET_HELPER_send_cancel (cproc->shandle);
1126   if (NULL != cproc->helper)
1127     GNUNET_HELPER_stop (cproc->helper);
1128   if (NULL != cproc->cfg)
1129     GNUNET_CONFIGURATION_destroy (cproc->cfg);
1130   GNUNET_free_non_null (cproc->port);
1131   GNUNET_free_non_null (cproc->dst);
1132   GNUNET_free (cproc);
1133 }
1134
1135
1136 /**
1137  * Start a controller process using the given configuration at the
1138  * given host.
1139  *
1140  * @param cfg configuration to use
1141  * @param host host to run the controller on; This should be the same host if
1142  *          the controller was previously started with
1143  *          GNUNET_TESTBED_controller_start; NULL for localhost
1144  * @param event_mask bit mask with set of events to call 'cc' for;
1145  *                   or-ed values of "1LL" shifted by the
1146  *                   respective 'enum GNUNET_TESTBED_EventType'
1147  *                   (i.e.  "(1LL << GNUNET_TESTBED_ET_CONNECT) | ...")
1148  * @param cc controller callback to invoke on events
1149  * @param cc_cls closure for cc
1150  * @return handle to the controller
1151  */
1152 struct GNUNET_TESTBED_Controller *
1153 GNUNET_TESTBED_controller_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
1154                                    struct GNUNET_TESTBED_Host *host,
1155                                    uint64_t event_mask,
1156                                    GNUNET_TESTBED_ControllerCallback cc,
1157                                    void *cc_cls)
1158 {
1159   struct GNUNET_TESTBED_Controller *controller;
1160   struct GNUNET_TESTBED_InitMessage *msg;
1161   const char *controller_hostname;
1162   unsigned long long max_parallel_operations;
1163   unsigned long long max_parallel_service_connections;
1164
1165   if (GNUNET_OK !=
1166       GNUNET_CONFIGURATION_get_value_number (cfg, "testbed",
1167                                              "MAX_PARALLEL_OPERATIONS",
1168                                              &max_parallel_operations))
1169   {
1170     GNUNET_break (0);
1171     return NULL;
1172   }
1173   if (GNUNET_OK !=
1174       GNUNET_CONFIGURATION_get_value_number (cfg, "testbed",
1175                                              "MAX_PARALLEL_SERVICE_CONNECTIONS",
1176                                              &max_parallel_service_connections))
1177   {
1178     GNUNET_break (0);
1179     return NULL;
1180   }
1181   controller = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_Controller));
1182   controller->cc = cc;
1183   controller->cc_cls = cc_cls;
1184   controller->event_mask = event_mask;
1185   controller->cfg = GNUNET_CONFIGURATION_dup (cfg);
1186   controller->client = GNUNET_CLIENT_connect ("testbed", controller->cfg);
1187   if (NULL == controller->client)
1188   {
1189     GNUNET_TESTBED_controller_disconnect (controller);
1190     return NULL;
1191   }
1192   if (NULL == host)
1193   {
1194     host = GNUNET_TESTBED_host_create_by_id_ (0);
1195     if (NULL == host)           /* If the above host create fails */
1196     {
1197       LOG (GNUNET_ERROR_TYPE_WARNING,
1198            "Treating NULL host as localhost. Multiple references to localhost "
1199            "may break when localhost freed before calling disconnect \n");
1200       host = GNUNET_TESTBED_host_lookup_by_id_ (0);
1201     }
1202     else
1203     {
1204       controller->aux_host = GNUNET_YES;
1205     }
1206   }
1207   GNUNET_assert (NULL != host);
1208   GNUNET_TESTBED_mark_host_registered_at_ (host, controller);
1209   controller->host = host;
1210   controller->opq_parallel_operations =
1211     GNUNET_TESTBED_operation_queue_create_ ((unsigned int)
1212                                             max_parallel_operations);
1213   controller->opq_parallel_service_connections =
1214     GNUNET_TESTBED_operation_queue_create_ ((unsigned int)
1215                                             max_parallel_service_connections);
1216   controller_hostname = GNUNET_TESTBED_host_get_hostname_ (host);
1217   if (NULL == controller_hostname)
1218     controller_hostname = "127.0.0.1";
1219   msg = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_InitMessage)
1220                        + strlen (controller_hostname) + 1);
1221   msg->header.type = htons (GNUNET_MESSAGE_TYPE_TESTBED_INIT);
1222   msg->header.size = htons (sizeof (struct GNUNET_TESTBED_InitMessage)
1223                             + strlen (controller_hostname) + 1);
1224   msg->host_id = htonl (GNUNET_TESTBED_host_get_id_ (host));
1225   msg->event_mask = GNUNET_htonll (controller->event_mask);
1226   strcpy ((char *) &msg[1], controller_hostname);
1227   GNUNET_TESTBED_queue_message_ (controller, (struct GNUNET_MessageHeader *)
1228                                  msg);
1229   return controller;
1230 }
1231
1232
1233 /**
1234  * Configure shared services at a controller.  Using this function,
1235  * you can specify that certain services (such as "resolver")
1236  * should not be run for each peer but instead be shared
1237  * across N peers on the specified host.  This function
1238  * must be called before any peers are created at the host.
1239  *
1240  * @param controller controller to configure
1241  * @param service_name name of the service to share
1242  * @param num_peers number of peers that should share one instance
1243  *        of the specified service (1 for no sharing is the default),
1244  *        use 0 to disable the service
1245  */
1246 void
1247 GNUNET_TESTBED_controller_configure_sharing (struct GNUNET_TESTBED_Controller *controller,
1248                                              const char *service_name,
1249                                              uint32_t num_peers)
1250 {
1251   struct GNUNET_TESTBED_ConfigureSharedServiceMessage *msg;
1252   uint16_t service_name_size;
1253   uint16_t msg_size;
1254
1255   service_name_size = strlen (service_name) + 1;
1256   msg_size = sizeof (struct GNUNET_TESTBED_ConfigureSharedServiceMessage)
1257     + service_name_size;
1258   msg = GNUNET_malloc (msg_size);
1259   msg->header.size = htons (msg_size);
1260   msg->header.type = htons (GNUNET_MESSAGE_TYPE_TESTBED_SERVICESHARE);
1261   msg->host_id = htonl (GNUNET_TESTBED_host_get_id_ (controller->host));
1262   msg->num_peers = htonl (num_peers);
1263   memcpy (&msg[1], service_name, service_name_size);
1264   GNUNET_TESTBED_queue_message_ (controller, (struct GNUNET_MessageHeader *) msg);
1265 }
1266
1267
1268 /**
1269  * disconnects from the controller.
1270  *
1271  * @param controller handle to controller to stop
1272  */
1273 void
1274 GNUNET_TESTBED_controller_disconnect (struct GNUNET_TESTBED_Controller *controller)
1275 {
1276   struct MessageQueue *mq_entry;
1277
1278   if (NULL != controller->th)
1279     GNUNET_CLIENT_notify_transmit_ready_cancel (controller->th);
1280  /* Clear the message queue */
1281   while (NULL != (mq_entry = controller->mq_head))
1282   {
1283     GNUNET_CONTAINER_DLL_remove (controller->mq_head,
1284                                  controller->mq_tail,
1285                                  mq_entry);
1286     GNUNET_free (mq_entry->msg);
1287     GNUNET_free (mq_entry);
1288   }
1289   if (NULL != controller->client)
1290     GNUNET_CLIENT_disconnect (controller->client);
1291   GNUNET_CONFIGURATION_destroy (controller->cfg);
1292   if (GNUNET_YES == controller->aux_host)
1293     GNUNET_TESTBED_host_destroy (controller->host);
1294   GNUNET_TESTBED_operation_queue_destroy_ (controller->opq_parallel_operations);
1295   GNUNET_TESTBED_operation_queue_destroy_
1296     (controller->opq_parallel_service_connections);
1297   GNUNET_free (controller);
1298 }
1299
1300
1301 /**
1302  * Register a host with the controller
1303  *
1304  * @param controller the controller handle
1305  * @param host the host to register
1306  * @param cc the completion callback to call to inform the status of
1307  *          registration. After calling this callback the registration handle
1308  *          will be invalid. Cannot be NULL.
1309  * @param cc_cls the closure for the cc
1310  * @return handle to the host registration which can be used to cancel the
1311  *           registration
1312  */
1313 struct GNUNET_TESTBED_HostRegistrationHandle *
1314 GNUNET_TESTBED_register_host (struct GNUNET_TESTBED_Controller *controller,
1315                               struct GNUNET_TESTBED_Host *host,
1316                               GNUNET_TESTBED_HostRegistrationCompletion cc,
1317                               void *cc_cls)
1318 {
1319   struct GNUNET_TESTBED_HostRegistrationHandle *rh;
1320   struct GNUNET_TESTBED_AddHostMessage *msg;
1321   const char *username;
1322   const char *hostname;
1323   uint16_t msg_size;
1324   uint16_t user_name_length;
1325
1326   if (NULL != controller->rh)
1327     return NULL;
1328   hostname = GNUNET_TESTBED_host_get_hostname_ (host);
1329   if (GNUNET_YES == GNUNET_TESTBED_is_host_registered_ (host, controller))
1330   {
1331     LOG (GNUNET_ERROR_TYPE_WARNING,
1332          "Host hostname: %s already registered\n",
1333          (NULL == hostname) ? "localhost" : hostname);
1334     return NULL;
1335   }
1336   rh = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_HostRegistrationHandle));
1337   rh->host = host;
1338   rh->c = controller;
1339   GNUNET_assert (NULL != cc);
1340   rh->cc = cc;
1341   rh->cc_cls = cc_cls;
1342   controller->rh = rh;
1343   username = GNUNET_TESTBED_host_get_username_ (host);
1344   msg_size = (sizeof (struct GNUNET_TESTBED_AddHostMessage));
1345   user_name_length = 0;
1346   if (NULL != username)
1347   {
1348     user_name_length = strlen (username) + 1;
1349     msg_size += user_name_length;
1350   }
1351   /* FIXME: what happens when hostname is NULL? localhost */
1352   GNUNET_assert (NULL != hostname);
1353   msg_size += strlen (hostname) + 1;
1354   msg = GNUNET_malloc (msg_size);
1355   msg->header.size = htons (msg_size);
1356   msg->header.type = htons (GNUNET_MESSAGE_TYPE_TESTBED_ADDHOST);
1357   msg->host_id = htonl (GNUNET_TESTBED_host_get_id_ (host));
1358   msg->ssh_port = htons (GNUNET_TESTBED_host_get_ssh_port_ (host));
1359   msg->user_name_length = htons (user_name_length);
1360   if (NULL != username)
1361     memcpy (&msg[1], username, user_name_length);
1362   strcpy (((void *) &msg[1]) + user_name_length, hostname);
1363   GNUNET_TESTBED_queue_message_ (controller, (struct GNUNET_MessageHeader *) msg);
1364   return rh;
1365 }
1366
1367
1368 /**
1369  * Cancel the pending registration. Note that if the registration message is
1370  * already sent to the service the cancellation has only the effect that the
1371  * registration completion callback for the registration is never called.
1372  *
1373  * @param handle the registration handle to cancel
1374  */
1375 void
1376 GNUNET_TESTBED_cancel_registration (struct GNUNET_TESTBED_HostRegistrationHandle
1377                                     *handle)
1378 {
1379   if (handle != handle->c->rh)
1380   {
1381     GNUNET_break (0);
1382     return;
1383   }
1384   handle->c->rh = NULL;
1385   GNUNET_free (handle);
1386 }
1387
1388
1389 /**
1390  * Same as the GNUNET_TESTBED_controller_link, however expects configuration in
1391  * serialized and compressed
1392  *
1393  * @param master handle to the master controller who creates the association
1394  * @param delegated_host requests to which host should be delegated; cannot be NULL
1395  * @param slave_host which host is used to run the slave controller; use NULL to
1396  *          make the master controller connect to the delegated host
1397  * @param sxcfg serialized and compressed configuration
1398  * @param sxcfg_size the size scfg
1399  * @param scfg_size the size of uncompressed serialized configuration
1400  * @param is_subordinate GNUNET_YES if the controller at delegated_host should
1401  *          be started by the master controller; GNUNET_NO if we are just
1402  *          allowed to use the slave via TCP/IP
1403  */
1404 struct GNUNET_TESTBED_Operation *
1405 GNUNET_TESTBED_controller_link_2 (struct GNUNET_TESTBED_Controller *master,
1406                                   struct GNUNET_TESTBED_Host *delegated_host,
1407                                   struct GNUNET_TESTBED_Host *slave_host,
1408                                   const char *sxcfg,
1409                                   size_t sxcfg_size,
1410                                   size_t scfg_size,
1411                                   int is_subordinate)
1412 {
1413   struct OperationContext *opc;
1414   struct GNUNET_TESTBED_ControllerLinkMessage *msg;
1415   uint16_t msg_size;
1416
1417   GNUNET_assert (GNUNET_YES ==
1418                  GNUNET_TESTBED_is_host_registered_ (delegated_host, master));
1419   if ((NULL != slave_host) && (0 != GNUNET_TESTBED_host_get_id_ (slave_host)))
1420     GNUNET_assert (GNUNET_YES ==
1421                    GNUNET_TESTBED_is_host_registered_ (slave_host, master));
1422   msg_size = sxcfg_size + sizeof (struct GNUNET_TESTBED_ControllerLinkMessage);
1423   msg = GNUNET_malloc (msg_size);
1424   msg->header.type = htons (GNUNET_MESSAGE_TYPE_TESTBED_LCONTROLLERS);
1425   msg->header.size = htons (msg_size);
1426   msg->delegated_host_id = htonl (GNUNET_TESTBED_host_get_id_ (delegated_host));
1427   msg->slave_host_id = htonl (GNUNET_TESTBED_host_get_id_
1428                               ((NULL != slave_host) ? slave_host : master->host));
1429   msg->config_size = htons ((uint16_t) scfg_size);
1430   msg->is_subordinate = (GNUNET_YES == is_subordinate) ? 1 : 0;
1431   memcpy (&msg[1], sxcfg, sxcfg_size);
1432   opc = GNUNET_malloc (sizeof (struct OperationContext));
1433   opc->c = master;
1434   opc->data = msg;
1435   opc->type = OP_LINK_CONTROLLERS;
1436   opc->id = master->operation_counter++;
1437   opc->state = OPC_STATE_INIT;
1438   msg->operation_id = GNUNET_htonll (opc->id);
1439   opc->op = GNUNET_TESTBED_operation_create_ (opc, &opstart_link_controllers,
1440                                               &oprelease_link_controllers);
1441   GNUNET_TESTBED_operation_queue_insert_ (master->opq_parallel_operations,
1442                                           opc->op);
1443   return opc->op;
1444 }
1445
1446
1447 /**
1448  * Compresses given configuration using zlib compress
1449  *
1450  * @param config the serialized configuration
1451  * @param size the size of config
1452  * @param xconfig will be set to the compressed configuration (memory is fresly
1453  *          allocated)
1454  * @return the size of the xconfig
1455  */
1456 size_t
1457 GNUNET_TESTBED_compress_config_ (const char *config, size_t size,
1458                                  char **xconfig)
1459 {
1460   size_t xsize;
1461
1462   xsize = compressBound ((uLong) size);
1463   *xconfig = GNUNET_malloc (xsize);
1464   GNUNET_assert (Z_OK ==
1465                  compress2 ((Bytef *)* xconfig, (uLongf *) &xsize,
1466                             (const Bytef *) config, (uLongf) size,
1467                             Z_BEST_SPEED));
1468   return xsize;
1469 }
1470
1471
1472 /**
1473  * Create a link from slave controller to delegated controller. Whenever the
1474  * master controller is asked to start a peer at the delegated controller the
1475  * request will be routed towards slave controller (if a route exists). The
1476  * slave controller will then route it to the delegated controller. The
1477  * configuration of the slave controller is given and to be used to either
1478  * create the slave controller or to connect to an existing slave controller
1479  * process.  'is_subordinate' specifies if the given slave controller should be
1480  * started and managed by the master controller, or if the slave already has a
1481  * master and this is just a secondary master that is also allowed to use the
1482  * existing slave.
1483  *
1484  * @param master handle to the master controller who creates the association
1485  * @param delegated_host requests to which host should be delegated
1486  * @param slave_host which host is used to run the slave controller
1487  * @param slave_cfg configuration to use for the slave controller
1488  * @param is_subordinate GNUNET_YES if the slave should be started (and stopped)
1489  *                       by the master controller; GNUNET_NO if we are just
1490  *                       allowed to use the slave via TCP/IP
1491  * @return the operation handle
1492  */
1493 struct GNUNET_TESTBED_Operation *
1494 GNUNET_TESTBED_controller_link (struct GNUNET_TESTBED_Controller *master,
1495                                 struct GNUNET_TESTBED_Host *delegated_host,
1496                                 struct GNUNET_TESTBED_Host *slave_host,
1497                                 const struct GNUNET_CONFIGURATION_Handle *slave_cfg,
1498                                 int is_subordinate)
1499 {
1500   struct GNUNET_TESTBED_Operation *op;
1501   char *config;
1502   char *cconfig;
1503   size_t cc_size;
1504   size_t config_size;
1505
1506   GNUNET_assert (GNUNET_YES ==
1507                  GNUNET_TESTBED_is_host_registered_ (delegated_host, master));
1508   if ((NULL != slave_host) && (0 != GNUNET_TESTBED_host_get_id_ (slave_host)))
1509     GNUNET_assert (GNUNET_YES ==
1510                    GNUNET_TESTBED_is_host_registered_ (slave_host, master));
1511   config = GNUNET_CONFIGURATION_serialize (slave_cfg, &config_size);
1512   cc_size = GNUNET_TESTBED_compress_config_ (config, config_size, &cconfig);
1513   GNUNET_free (config);
1514   GNUNET_assert ((UINT16_MAX -
1515                   sizeof (struct GNUNET_TESTBED_ControllerLinkMessage))
1516                   >= cc_size); /* Configuration doesn't fit in 1 message */
1517   op = GNUNET_TESTBED_controller_link_2 (master, delegated_host, slave_host,
1518                                     (const char *) cconfig,
1519                                     cc_size, config_size, is_subordinate);
1520   GNUNET_free (cconfig);
1521   return op;
1522 }
1523
1524
1525 /**
1526  * Ask the testbed controller to write the current overlay topology to
1527  * a file.  Naturally, the file will only contain a snapshot as the
1528  * topology may evolve all the time.
1529  *
1530  * @param controller overlay controller to inspect
1531  * @param filename name of the file the topology should
1532  *        be written to.
1533  */
1534 void
1535 GNUNET_TESTBED_overlay_write_topology_to_file (struct GNUNET_TESTBED_Controller *controller,
1536                                                const char *filename)
1537 {
1538   GNUNET_break (0);
1539 }
1540
1541
1542 /**
1543  * Creates a helper initialization message. This function is here because we
1544  * want to use this in testing
1545  *
1546  * @param cname the ip address of the controlling host
1547  * @param cfg the configuration that has to used to start the testbed service
1548  *          thru helper
1549  * @return the initialization message
1550  */
1551 struct GNUNET_TESTBED_HelperInit *
1552 GNUNET_TESTBED_create_helper_init_msg_ (const char *cname,
1553                                         const struct GNUNET_CONFIGURATION_Handle *cfg)
1554 {
1555   struct GNUNET_TESTBED_HelperInit *msg;
1556   char *config;
1557   char *xconfig;
1558   size_t config_size;
1559   size_t xconfig_size;
1560   uint16_t cname_len;
1561   uint16_t msg_size;
1562
1563   config = GNUNET_CONFIGURATION_serialize (cfg, &config_size);
1564   GNUNET_assert (NULL != config);
1565   xconfig_size =
1566     GNUNET_TESTBED_compress_config_ (config, config_size, &xconfig);
1567   GNUNET_free (config);
1568   cname_len = strlen (cname);
1569   msg_size = xconfig_size + cname_len + 1 +
1570     sizeof (struct GNUNET_TESTBED_HelperInit);
1571   msg = GNUNET_realloc (xconfig, msg_size);
1572   (void) memmove ( ((void *) &msg[1]) + cname_len + 1, msg, xconfig_size);
1573   msg->header.size = htons (msg_size);
1574   msg->header.type = htons (GNUNET_MESSAGE_TYPE_TESTBED_HELPER_INIT);
1575   msg->cname_size = htons (cname_len);
1576   msg->config_size = htons (config_size);
1577   (void) strcpy ((char *) &msg[1], cname);
1578   return msg;
1579 }
1580
1581
1582 /**
1583  * Cancel a pending operation.  Releases all resources
1584  * of the operation and will ensure that no event
1585  * is generated for the operation.  Does NOT guarantee
1586  * that the operation will be fully undone (or that
1587  * nothing ever happened).
1588  *
1589  * @param operation operation to cancel
1590  */
1591 void
1592 GNUNET_TESTBED_operation_cancel (struct GNUNET_TESTBED_Operation *operation)
1593 {
1594   GNUNET_TESTBED_operation_done (operation);
1595 }
1596
1597
1598 /**
1599  * Signal that the information from an operation has been fully
1600  * processed.  This function MUST be called for each event
1601  * of type 'operation_finished' to fully remove the operation
1602  * from the operation queue.  After calling this function, the
1603  * 'op_result' becomes invalid (!).
1604  *
1605  * @param operation operation to signal completion for
1606  */
1607 void
1608 GNUNET_TESTBED_operation_done (struct GNUNET_TESTBED_Operation *operation)
1609 {
1610   switch (operation->type)
1611   {
1612   case OP_PEER_CREATE:
1613   case OP_PEER_DESTROY:
1614   case OP_PEER_START:
1615   case OP_PEER_STOP:
1616   case OP_PEER_INFO:
1617   case OP_OVERLAY_CONNECT:
1618   case OP_LINK_CONTROLLERS:
1619     GNUNET_TESTBED_operation_release_ (operation);
1620     return;
1621   default:
1622     GNUNET_assert (0);
1623     break;
1624   }
1625 }
1626
1627
1628 /**
1629  * Generates configuration by parsing Peer configuration information reply message
1630  *
1631  * @param msg the peer configuration information message
1632  * @return handle to the parsed configuration
1633  */
1634 struct GNUNET_CONFIGURATION_Handle *
1635 GNUNET_TESTBED_get_config_from_peerinfo_msg_ (const struct
1636                                               GNUNET_TESTBED_PeerConfigurationInformationMessage
1637                                               *msg)
1638 {
1639   struct GNUNET_CONFIGURATION_Handle *cfg;
1640   char *config;
1641   uLong config_size;
1642   int ret;
1643   uint16_t msize;
1644
1645   config_size = (uLong) ntohs (msg->config_size);
1646   config = GNUNET_malloc (config_size);
1647   msize = ntohs (msg->header.size);
1648   msize -= sizeof (struct GNUNET_TESTBED_PeerConfigurationInformationMessage);
1649   if (Z_OK != (ret = uncompress ((Bytef *) config, &config_size,
1650                                  (const Bytef *) &msg[1], (uLong) msize)))
1651     GNUNET_assert (0);
1652   cfg = GNUNET_CONFIGURATION_create ();
1653   GNUNET_assert (GNUNET_OK ==
1654                  GNUNET_CONFIGURATION_deserialize (cfg, config,
1655                                                    (size_t) config_size,
1656                                                    GNUNET_NO));
1657   GNUNET_free (config);
1658   return cfg;
1659 }
1660
1661 /* end of testbed_api.c */