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
  44 /**
  45  * Generic logging shorthand
  46  */
  47 #define LOG(kind, ...)                          \
  48   GNUNET_log_from (kind, "testbed-api", __VA_ARGS__);
  49
  50 /**
  51  * Debug logging
  52  */
  53 #define LOG_DEBUG(...)                          \
  54   LOG (GNUNET_ERROR_TYPE_DEBUG, __VA_ARGS__);
  55
  56 /**
  57  * Relative time seconds shorthand
  58  */
  59 #define TIME_REL_SECS(sec) \
  60   GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, sec)
  61
  62
  63 /**
  64  * Default server message sending retry timeout
  65  */
  66 #define TIMEOUT_REL TIME_REL_SECS(1)
  67
  68
  69 /**
  70  * The message queue for sending messages to the controller service
  71  */
  72 struct MessageQueue
  73 {
  74   /**
  75    * The message to be sent
  76    */
  77   struct GNUNET_MessageHeader *msg;
  78
  79   /**
  80    * next pointer for DLL
  81    */
  82   struct MessageQueue *next;
  83
  84   /**
  85    * prev pointer for DLL
  86    */
  87   struct MessageQueue *prev;
  88 };
  89
  90
  91 /**
  92  * Structure for a controller link
  93  */
  94 struct ControllerLink
  95 {
  96   /**
  97    * The next ptr for DLL
  98    */
  99   struct ControllerLink *next;
 100
 101   /**
 102    * The prev ptr for DLL
 103    */
 104   struct ControllerLink *prev;
 105
 106   /**
 107    * The host which will be referred in the peer start request. This is the
 108    * host where the peer should be started
 109    */
 110   struct GNUNET_TESTBED_Host *delegated_host;
 111
 112   /**
 113    * The host which will contacted to delegate the peer start request
 114    */
 115   struct GNUNET_TESTBED_Host *slave_host;
 116
 117   /**
 118    * The configuration to be used to connect to slave host
 119    */
 120   const struct GNUNET_CONFIGURATION_Handle *slave_cfg;
 121
 122   /**
 123    * GNUNET_YES if the slave should be started (and stopped) by us; GNUNET_NO
 124    * if we are just allowed to use the slave via TCP/IP
 125    */
 126   int is_subordinate;
 127 };
 128
 129
 130 /**
 131  * handle for host registration
 132  */
 133 struct GNUNET_TESTBED_HostRegistrationHandle
 134 {
 135   /**
 136    * The host being registered
 137    */
 138   struct GNUNET_TESTBED_Host *host;
 139
 140   /**
 141    * The controller at which this host is being registered
 142    */
 143   struct GNUNET_TESTBED_Controller *c;
 144
 145   /**
 146    * The Registartion completion callback
 147    */
 148   GNUNET_TESTBED_HostRegistrationCompletion cc;
 149
 150   /**
 151    * The closure for above callback
 152    */
 153   void *cc_cls;
 154 };
 155
 156
 157 /**
 158  * Handler for GNUNET_MESSAGE_TYPE_TESTBED_ADDHOSTCONFIRM message from
 159  * controller (testbed service)
 160  *
 161  * @param c the controller handler
 162  * @param msg message received
 163  * @return GNUNET_YES if we can continue receiving from service; GNUNET_NO if
 164  *           not
 165  */
 166 static int
 167 handle_addhostconfirm (struct GNUNET_TESTBED_Controller *c,
 168                        const struct GNUNET_TESTBED_HostConfirmedMessage *msg)
 169 {
 170   struct GNUNET_TESTBED_HostRegistrationHandle *rh;
 171   char *emsg;
 172   uint16_t msg_size;
 173
 174   rh = c->rh;
 175   if (NULL == rh)
 176   {
 177     return GNUNET_OK;
 178   }
 179   if (GNUNET_TESTBED_host_get_id_ (rh->host) != ntohl (msg->host_id))
 180   {
 181     LOG_DEBUG ("Mismatch in host id's %u, %u of host confirm msg\n",
 182                GNUNET_TESTBED_host_get_id_ (rh->host), ntohl (msg->host_id));
 183     return GNUNET_OK;
 184   }
 185   c->rh = NULL;
 186   msg_size = ntohs (msg->header.size);
 187   if (sizeof (struct GNUNET_TESTBED_HostConfirmedMessage) == msg_size)
 188   {
 189     LOG_DEBUG ("Host %u successfully registered\n", ntohl (msg->host_id));
 190     GNUNET_TESTBED_mark_host_registered_at_  (rh->host, c);
 191     rh->cc (rh->cc_cls, NULL);
 192     GNUNET_free (rh);
 193     return GNUNET_OK;
 194   }
 195   /* We have an error message */
 196   emsg = (char *) &msg[1];
 197   if ('\0' != emsg[msg_size -
 198                    sizeof (struct GNUNET_TESTBED_HostConfirmedMessage)])
 199   {
 200     GNUNET_break (0);
 201     GNUNET_free (rh);
 202     return GNUNET_NO;
 203   }
 204   LOG (GNUNET_ERROR_TYPE_ERROR, _("Adding host %u failed with error: %s\n"),
 205        ntohl (msg->host_id), emsg);
 206   rh->cc (rh->cc_cls, emsg);
 207   GNUNET_free (rh);
 208   return GNUNET_OK;
 209 }
 210
 211
 212 /**
 213  * Handler for GNUNET_MESSAGE_TYPE_TESTBED_ADDHOSTCONFIRM message from
 214  * controller (testbed service)
 215  *
 216  * @param c the controller handler
 217  * @param msg message received
 218  * @return GNUNET_YES if we can continue receiving from service; GNUNET_NO if
 219  *           not
 220  */
 221 static int
 222 handle_opsuccess (struct GNUNET_TESTBED_Controller *c,
 223                   const struct
 224                   GNUNET_TESTBED_GenericOperationSuccessEventMessage *msg)
 225 {
 226   struct GNUNET_TESTBED_Operation *op;
 227   struct GNUNET_TESTBED_EventInformation *event;
 228   uint64_t op_id;
 229
 230   op_id = GNUNET_ntohll (msg->operation_id);
 231   LOG_DEBUG ("Operation %ul successful\n", op_id);
 232   for (op = c->op_head; NULL != op; op = op->next)
 233   {
 234     if (op->operation_id == op_id)
 235       break;
 236   }
 237   if (NULL == op)
 238   {
 239     LOG_DEBUG ("Operation not found\n");
 240     return GNUNET_YES;
 241   }
 242   event = NULL;
 243   if (0 != (c->event_mask & (1L << GNUNET_TESTBED_ET_OPERATION_FINISHED)))
 244     event = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_EventInformation));
 245   if (NULL != event)
 246     event->type = GNUNET_TESTBED_ET_OPERATION_FINISHED;
 247   switch (op->type)
 248   {
 249   case OP_PEER_DESTROY:
 250     {
 251       struct PeerDestroyData *data;
 252
 253       if (NULL != event)
 254       {
 255         event->details.operation_finished.operation = op;
 256         event->details.operation_finished.op_cls = NULL;
 257         event->details.operation_finished.emsg = NULL;
 258         event->details.operation_finished.pit = GNUNET_TESTBED_PIT_GENERIC;
 259         event->details.operation_finished.op_result.generic = NULL;
 260       }
 261       data = (struct PeerDestroyData *) op->data;
 262       if (NULL != data->peer->details)
 263       {
 264         if (NULL != data->peer->details->cfg)
 265           GNUNET_CONFIGURATION_destroy (data->peer->details->cfg);
 266         //PEER_DETAILS
 267       }
 268       GNUNET_free (data->peer);
 269       GNUNET_free (data);
 270       //PEERDESTROYDATA
 271     }
 272     break;
 273   default:
 274     GNUNET_break (0);
 275   }
 276   if (NULL != event)
 277   {
 278     if (NULL != c->cc)
 279       c->cc (c->cc_cls, event);
 280   }
 281   GNUNET_CONTAINER_DLL_remove (c->op_head, c->op_tail, op);
 282   GNUNET_free (op);
 283   return GNUNET_YES;
 284 }
 285
 286
 287 /**
 288  * Handler for messages from controller (testbed service)
 289  *
 290  * @param cls the controller handler
 291  * @param msg message received, NULL on timeout or fatal error
 292  */
 293 static void
 294 message_handler (void *cls, const struct GNUNET_MessageHeader *msg)
 295 {
 296   struct GNUNET_TESTBED_Controller *c = cls;
 297   int status;
 298
 299   c->in_receive = GNUNET_NO;
 300   /* FIXME: Add checks for message integrity */
 301   if (NULL == msg)
 302   {
 303     LOG_DEBUG ("Receive timed out or connection to service dropped\n");
 304     return;
 305   }
 306   status = GNUNET_OK;
 307   switch (ntohs (msg->type))
 308   {
 309   case GNUNET_MESSAGE_TYPE_TESTBED_ADDHOSTCONFIRM:
 310     status =
 311       handle_addhostconfirm (c, (const struct
 312                                  GNUNET_TESTBED_HostConfirmedMessage *) msg);
 313     break;
 314   case GNUNET_MESSAGE_TYPE_TESTBED_GENERICOPSUCCESS:
 315     status =
 316       handle_opsuccess (c, (const struct
 317                             GNUNET_TESTBED_GenericOperationSuccessEventMessage
 318                             *) msg);
 319   default:
 320     GNUNET_break (0);
 321   }
 322   if ((GNUNET_OK == status) && (GNUNET_NO == c->in_receive))
 323   {
 324     c->in_receive = GNUNET_YES;
 325     GNUNET_CLIENT_receive (c->client, &message_handler, c,
 326                            GNUNET_TIME_UNIT_FOREVER_REL);
 327   }
 328 }
 329
 330 /**
 331  * Function called to notify a client about the connection begin ready to queue
 332  * more data.  "buf" will be NULL and "size" zero if the connection was closed
 333  * for writing in the meantime.
 334  *
 335  * @param cls closure
 336  * @param size number of bytes available in buf
 337  * @param buf where the callee should write the message
 338  * @return number of bytes written to buf
 339  */
 340 static size_t
 341 transmit_ready_notify (void *cls, size_t size, void *buf)
 342 {
 343   struct GNUNET_TESTBED_Controller *c = cls;
 344   struct MessageQueue *mq_entry;
 345
 346   c->th = NULL;
 347   mq_entry = c->mq_head;
 348   GNUNET_assert (NULL != mq_entry);
 349   if ((0 == size) && (NULL == buf)) /* Timeout */
 350   {
 351     LOG_DEBUG ("Message sending timed out -- retrying\n");
 352     c->th =
 353       GNUNET_CLIENT_notify_transmit_ready (c->client,
 354                                            ntohs (mq_entry->msg->size),
 355                                            TIMEOUT_REL,
 356                                            GNUNET_YES, &transmit_ready_notify,
 357                                            c);
 358     return 0;
 359   }
 360   GNUNET_assert (ntohs (mq_entry->msg->size) <= size);
 361   size = ntohs (mq_entry->msg->size);
 362   memcpy (buf, mq_entry->msg, size);
 363   LOG_DEBUG ("Message of type: %u and size: %u sent\n",
 364              ntohs (mq_entry->msg->type), size);
 365   GNUNET_free (mq_entry->msg);
 366   GNUNET_CONTAINER_DLL_remove (c->mq_head, c->mq_tail, mq_entry);
 367   GNUNET_free (mq_entry);
 368   mq_entry = c->mq_head;
 369   if (NULL != mq_entry)
 370     c->th =
 371       GNUNET_CLIENT_notify_transmit_ready (c->client,
 372                                            ntohs (mq_entry->msg->size),
 373                                            TIMEOUT_REL,
 374                                            GNUNET_YES, &transmit_ready_notify,
 375                                            c);
 376   if (GNUNET_NO == c->in_receive)
 377   {
 378     c->in_receive = GNUNET_YES;
 379     GNUNET_CLIENT_receive (c->client, &message_handler, c,
 380                            GNUNET_TIME_UNIT_FOREVER_REL);
 381   }
 382   return size;
 383 }
 384
 385
 386 /**
 387  * Queues a message in send queue for sending to the service
 388  *
 389  * @param controller the handle to the controller
 390  * @param msg the message to queue
 391  */
 392 void
 393 GNUNET_TESTBED_queue_message (struct GNUNET_TESTBED_Controller *controller,
 394                               struct GNUNET_MessageHeader *msg)
 395 {
 396   struct MessageQueue *mq_entry;
 397   uint16_t type;
 398   uint16_t size;
 399
 400   type = ntohs (msg->type);
 401   size = ntohs (msg->size);
 402   GNUNET_assert ((GNUNET_MESSAGE_TYPE_TESTBED_INIT <= type) &&
 403                  (GNUNET_MESSAGE_TYPE_TESTBED_MAX > type));
 404   mq_entry = GNUNET_malloc (sizeof (struct MessageQueue));
 405   mq_entry->msg = msg;
 406   LOG (GNUNET_ERROR_TYPE_DEBUG,
 407        "Queueing message of type %u, size %u for sending\n", type,
 408        ntohs (msg->size));
 409   GNUNET_CONTAINER_DLL_insert_tail (controller->mq_head, controller->mq_tail,
 410                                     mq_entry);
 411   if (NULL == controller->th)
 412     controller->th =
 413       GNUNET_CLIENT_notify_transmit_ready (controller->client, size,
 414                                            TIMEOUT_REL,
 415                                            GNUNET_YES, &transmit_ready_notify,
 416                                            controller);
 417 }
 418
 419
 420 /**
 421  * Handle for controller process
 422  */
 423 struct GNUNET_TESTBED_ControllerProc
 424 {
 425   /**
 426    * The helper handle
 427    */
 428   struct GNUNET_TESTBED_HelperHandle *helper;
 429
 430 };
 431
 432
 433 /**
 434  * Starts a controller process at the host
 435  *
 436  * @param host the host where the controller has to be started; NULL for localhost
 437  * @return the controller process handle
 438  */
 439 struct GNUNET_TESTBED_ControllerProc *
 440 GNUNET_TESTBED_controller_start (struct GNUNET_TESTBED_Host *host)
 441 {
 442   struct GNUNET_TESTBED_ControllerProc *cproc;
 443   char * const binary_argv[] = {
 444     "gnunet-service-testbed",
 445     "gnunet-service-testbed",
 446     NULL
 447   };
 448
 449   cproc = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_ControllerProc));
 450   cproc->helper = GNUNET_TESTBED_host_run_ (host, binary_argv);
 451   if (NULL == cproc->helper)
 452   {
 453     GNUNET_free (cproc);
 454     return NULL;
 455   }
 456   return cproc;
 457 }
 458
 459
 460 /**
 461  * Stop the controller process (also will terminate all peers and controllers
 462  * dependent on this controller).  This function blocks until the testbed has
 463  * been fully terminated (!).
 464  *
 465  * @param cproc the controller process handle
 466  */
 467 void
 468 GNUNET_TESTBED_controller_stop (struct GNUNET_TESTBED_ControllerProc *cproc)
 469 {
 470   GNUNET_TESTBED_host_stop_ (cproc->helper);
 471   GNUNET_free (cproc);
 472 }
 473
 474
 475 /**
 476  * Start a controller process using the given configuration at the
 477  * given host.
 478  *
 479  * @param cfg configuration to use
 480  * @param host host to run the controller on; This should be the same host if
 481  *          the controller was previously started with
 482  *          GNUNET_TESTBED_controller_start; NULL for localhost
 483  * @param event_mask bit mask with set of events to call 'cc' for;
 484  *                   or-ed values of "1LL" shifted by the
 485  *                   respective 'enum GNUNET_TESTBED_EventType'
 486  *                   (i.e.  "(1LL << GNUNET_TESTBED_ET_CONNECT) | ...")
 487  * @param cc controller callback to invoke on events
 488  * @param cc_cls closure for cc
 489  * @return handle to the controller
 490  */
 491 struct GNUNET_TESTBED_Controller *
 492 GNUNET_TESTBED_controller_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
 493                                    struct GNUNET_TESTBED_Host *host,
 494                                    uint64_t event_mask,
 495                                    GNUNET_TESTBED_ControllerCallback cc,
 496                                    void *cc_cls)
 497 {
 498   struct GNUNET_TESTBED_Controller *controller;
 499   struct GNUNET_TESTBED_InitMessage *msg;
 500
 501   controller = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_Controller));
 502   controller->cc = cc;
 503   controller->cc_cls = cc_cls;
 504   controller->event_mask = event_mask;
 505   controller->cfg = GNUNET_CONFIGURATION_dup (cfg);
 506   controller->client = GNUNET_CLIENT_connect ("testbed", controller->cfg);
 507   if (NULL == controller->client)
 508   {
 509     GNUNET_TESTBED_controller_disconnect (controller);
 510     return NULL;
 511   }
 512   if (NULL == host)
 513   {
 514     host = GNUNET_TESTBED_host_create_by_id_ (0);
 515     if (NULL == host)
 516     {
 517       LOG (GNUNET_ERROR_TYPE_WARNING,
 518            "Treating NULL host as localhost. Multiple references to localhost. "
 519            " May break when localhost freed before calling disconnect \n");
 520       host = GNUNET_TESTBED_host_lookup_by_id_ (0);
 521     }
 522     else
 523     {
 524       controller->aux_host = GNUNET_YES;
 525     }
 526   }
 527   GNUNET_assert (NULL != host);
 528   msg = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_InitMessage));
 529   msg->header.type = htons (GNUNET_MESSAGE_TYPE_TESTBED_INIT);
 530   msg->header.size = htons (sizeof (struct GNUNET_TESTBED_InitMessage));
 531   msg->host_id = htonl (GNUNET_TESTBED_host_get_id_ (host));
 532   msg->event_mask = GNUNET_htonll (controller->event_mask);
 533   GNUNET_TESTBED_queue_message (controller, (struct GNUNET_MessageHeader *) msg);
 534   return controller;
 535 }
 536
 537
 538 /**
 539  * Configure shared services at a controller.  Using this function,
 540  * you can specify that certain services (such as "resolver")
 541  * should not be run for each peer but instead be shared
 542  * across N peers on the specified host.  This function
 543  * must be called before any peers are created at the host.
 544  *
 545  * @param controller controller to configure
 546  * @param service_name name of the service to share
 547  * @param num_peers number of peers that should share one instance
 548  *        of the specified service (1 for no sharing is the default),
 549  *        use 0 to disable the service
 550  */
 551 void
 552 GNUNET_TESTBED_controller_configure_sharing (struct GNUNET_TESTBED_Controller *controller,
 553                                              const char *service_name,
 554                                              uint32_t num_peers)
 555 {
 556   struct GNUNET_TESTBED_ConfigureSharedServiceMessage *msg;
 557   uint16_t service_name_size;
 558   uint16_t msg_size;
 559
 560   service_name_size = strlen (service_name) + 1;
 561   msg_size = sizeof (struct GNUNET_TESTBED_ConfigureSharedServiceMessage)
 562     + service_name_size;
 563   msg = GNUNET_malloc (msg_size);
 564   msg->header.size = htons (msg_size);
 565   msg->header.type = htons (GNUNET_MESSAGE_TYPE_TESTBED_SERVICESHARE);
 566   msg->host_id = htonl (GNUNET_TESTBED_host_get_id_ (controller->host));
 567   msg->num_peers = htonl (num_peers);
 568   memcpy (&msg[1], service_name, service_name_size);
 569   GNUNET_TESTBED_queue_message (controller, (struct GNUNET_MessageHeader *) msg);
 570 }
 571
 572
 573 /**
 574  * disconnects from the controller.
 575  *
 576  * @param controller handle to controller to stop
 577  */
 578 void
 579 GNUNET_TESTBED_controller_disconnect (struct GNUNET_TESTBED_Controller *controller)
 580 {
 581   struct MessageQueue *mq_entry;
 582
 583   if (NULL != controller->th)
 584     GNUNET_CLIENT_notify_transmit_ready_cancel (controller->th);
 585  /* Clear the message queue */
 586   while (NULL != (mq_entry = controller->mq_head))
 587   {
 588     GNUNET_CONTAINER_DLL_remove (controller->mq_head,
 589                                  controller->mq_tail,
 590                                  mq_entry);
 591     GNUNET_free (mq_entry->msg);
 592     GNUNET_free (mq_entry);
 593   }
 594   if (NULL != controller->client)
 595     GNUNET_CLIENT_disconnect (controller->client);
 596   GNUNET_CONFIGURATION_destroy (controller->cfg);
 597   if (GNUNET_YES == controller->aux_host)
 598     GNUNET_TESTBED_host_destroy (controller->host);
 599   GNUNET_free (controller);
 600 }
 601
 602
 603 /**
 604  * Register a host with the controller
 605  *
 606  * @param controller the controller handle
 607  * @param host the host to register
 608  * @param cc the completion callback to call to inform the status of
 609  *          registration. After calling this callback the registration handle
 610  *          will be invalid. Cannot be NULL.
 611  * @param cc_cls the closure for the cc
 612  * @return handle to the host registration which can be used to cancel the
 613  *           registration
 614  */
 615 struct GNUNET_TESTBED_HostRegistrationHandle *
 616 GNUNET_TESTBED_register_host (struct GNUNET_TESTBED_Controller *controller,
 617                               struct GNUNET_TESTBED_Host *host,
 618                               GNUNET_TESTBED_HostRegistrationCompletion cc,
 619                               void *cc_cls)
 620 {
 621   struct GNUNET_TESTBED_HostRegistrationHandle *rh;
 622   struct GNUNET_TESTBED_AddHostMessage *msg;
 623   const char *username;
 624   const char *hostname;
 625   uint16_t msg_size;
 626   uint16_t user_name_length;
 627
 628   if (NULL != controller->rh)
 629     return NULL;
 630   hostname = GNUNET_TESTBED_host_get_hostname_ (host);
 631   if (GNUNET_YES == GNUNET_TESTBED_is_host_registered_ (host, controller))
 632   {
 633     LOG (GNUNET_ERROR_TYPE_WARNING,
 634          "Host hostname: %s already registered\n",
 635          (NULL == hostname) ? "localhost" : hostname);
 636     return NULL;
 637   }
 638   rh = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_HostRegistrationHandle));
 639   rh->host = host;
 640   rh->c = controller;
 641   GNUNET_assert (NULL != cc);
 642   rh->cc = cc;
 643   rh->cc_cls = cc_cls;
 644   controller->rh = rh;
 645   username = GNUNET_TESTBED_host_get_username_ (host);
 646   msg_size = (sizeof (struct GNUNET_TESTBED_AddHostMessage));
 647   user_name_length = 0;
 648   if (NULL != username)
 649   {
 650     user_name_length = strlen (username) + 1;
 651     msg_size += user_name_length;
 652   }
 653   /* FIXME: what happens when hostname is NULL? localhost */
 654   GNUNET_assert (NULL != hostname);
 655   msg_size += strlen (hostname) + 1;
 656   msg = GNUNET_malloc (msg_size);
 657   msg->header.size = htons (msg_size);
 658   msg->header.type = htons (GNUNET_MESSAGE_TYPE_TESTBED_ADDHOST);
 659   msg->host_id = htonl (GNUNET_TESTBED_host_get_id_ (host));
 660   msg->ssh_port = htons (GNUNET_TESTBED_host_get_ssh_port_ (host));
 661   msg->user_name_length = htons (user_name_length);
 662   if (NULL != username)
 663     memcpy (&msg[1], username, user_name_length);
 664   strcpy (((void *) &msg[1]) + user_name_length, hostname);
 665   GNUNET_TESTBED_queue_message (controller, (struct GNUNET_MessageHeader *) msg);
 666   return rh;
 667 }
 668
 669
 670 /**
 671  * Cancel the pending registration. Note that if the registration message is
 672  * already sent to the service the cancellation has only the effect that the
 673  * registration completion callback for the registration is never called.
 674  *
 675  * @param handle the registration handle to cancel
 676  */
 677 void
 678 GNUNET_TESTBED_cancel_registration (struct GNUNET_TESTBED_HostRegistrationHandle
 679                                     *handle)
 680 {
 681   if (handle != handle->c->rh)
 682   {
 683     GNUNET_break (0);
 684     return;
 685   }
 686   handle->c->rh = NULL;
 687   GNUNET_free (handle);
 688 }
 689
 690
 691 /**
 692  * Same as the GNUNET_TESTBED_controller_link, however expects configuration in
 693  * serialized and compressed
 694  *
 695  * @param master handle to the master controller who creates the association
 696  * @param delegated_host requests to which host should be delegated; cannot be NULL
 697  * @param slave_host which host is used to run the slave controller; use NULL to
 698  *          make the master controller connect to the delegated host
 699  * @param sxcfg serialized and compressed configuration
 700  * @param sxcfg_size the size scfg
 701  * @param scfg_size the size of uncompressed serialized configuration
 702  * @param is_subordinate GNUNET_YES if the controller at delegated_host should
 703  *          be started by the master controller; GNUNET_NO if we are just
 704  *          allowed to use the slave via TCP/IP
 705  */
 706 void
 707 GNUNET_TESTBED_controller_link_2 (struct GNUNET_TESTBED_Controller *master,
 708                                   struct GNUNET_TESTBED_Host *delegated_host,
 709                                   struct GNUNET_TESTBED_Host *slave_host,
 710                                   const char *sxcfg,
 711                                   size_t sxcfg_size,
 712                                   size_t scfg_size,
 713                                   int is_subordinate)
 714 {
 715   struct GNUNET_TESTBED_ControllerLinkMessage *msg;
 716   uint16_t msg_size;
 717
 718   GNUNET_assert (GNUNET_YES ==
 719                  GNUNET_TESTBED_is_host_registered_ (delegated_host, master));
 720   if ((NULL != slave_host) && (0 != GNUNET_TESTBED_host_get_id_ (slave_host)))
 721     GNUNET_assert (GNUNET_YES ==
 722                    GNUNET_TESTBED_is_host_registered_ (slave_host, master));
 723   msg_size = sxcfg_size + sizeof (struct GNUNET_TESTBED_ControllerLinkMessage);
 724   msg = GNUNET_malloc (msg_size);
 725   msg->header.type = htons (GNUNET_MESSAGE_TYPE_TESTBED_LCONTROLLERS);
 726   msg->header.size = htons (msg_size);
 727   msg->delegated_host_id = htonl (GNUNET_TESTBED_host_get_id_ (delegated_host));
 728   msg->slave_host_id = htonl (GNUNET_TESTBED_host_get_id_
 729                               ((NULL != slave_host) ? slave_host : master->host));
 730   msg->config_size = htons ((uint16_t) scfg_size);
 731   msg->is_subordinate = (GNUNET_YES == is_subordinate) ? 1 : 0;
 732   memcpy (&msg[1], sxcfg, sxcfg_size);
 733   GNUNET_TESTBED_queue_message (master, (struct GNUNET_MessageHeader *) msg);
 734 }
 735
 736
 737 /**
 738  * Compresses given configuration using zlib compress
 739  *
 740  * @param config the serialized configuration
 741  * @param size the size of config
 742  * @param xconfig will be set to the compressed configuration (memory is fresly
 743  *          allocated)
 744  * @return the size of the xconfig
 745  */
 746 size_t
 747 GNUNET_TESTBED_compress_config (const char *config, size_t size,
 748                                 char **xconfig)
 749 {
 750   size_t xsize;
 751
 752   xsize = compressBound ((uLong) size);
 753   *xconfig = GNUNET_malloc (xsize);
 754   GNUNET_assert (Z_OK ==
 755                  compress2 ((Bytef *)* xconfig, (uLongf *) &xsize,
 756                             (const Bytef *) config, (uLongf) size,
 757                             Z_BEST_SPEED));
 758   return xsize;
 759 }
 760
 761
 762 /**
 763  * Create a link from slave controller to delegated controller. Whenever the
 764  * master controller is asked to start a peer at the delegated controller the
 765  * request will be routed towards slave controller (if a route exists). The
 766  * slave controller will then route it to the delegated controller. The
 767  * configuration of the slave controller is given and to be used to either
 768  * create the slave controller or to connect to an existing slave controller
 769  * process.  'is_subordinate' specifies if the given slave controller should be
 770  * started and managed by the master controller, or if the slave already has a
 771  * master and this is just a secondary master that is also allowed to use the
 772  * existing slave.
 773  *
 774  * @param master handle to the master controller who creates the association
 775  * @param delegated_host requests to which host should be delegated
 776  * @param slave_host which host is used to run the slave controller
 777  * @param slave_cfg configuration to use for the slave controller
 778  * @param is_subordinate GNUNET_YES if the slave should be started (and stopped)
 779  *                       by the master controller; GNUNET_NO if we are just
 780  *                       allowed to use the slave via TCP/IP
 781  */
 782 void
 783 GNUNET_TESTBED_controller_link (struct GNUNET_TESTBED_Controller *master,
 784                                 struct GNUNET_TESTBED_Host *delegated_host,
 785                                 struct GNUNET_TESTBED_Host *slave_host,
 786                                 const struct GNUNET_CONFIGURATION_Handle *slave_cfg,
 787                                 int is_subordinate)
 788 {
 789   char *config;
 790   char *cconfig;
 791   size_t cc_size;
 792   size_t config_size;
 793
 794   GNUNET_assert (GNUNET_YES ==
 795                  GNUNET_TESTBED_is_host_registered_ (delegated_host, master));
 796   if ((NULL != slave_host) && (0 != GNUNET_TESTBED_host_get_id_ (slave_host)))
 797     GNUNET_assert (GNUNET_YES ==
 798                    GNUNET_TESTBED_is_host_registered_ (slave_host, master));
 799   config = GNUNET_CONFIGURATION_serialize (slave_cfg, &config_size);
 800   cc_size = GNUNET_TESTBED_compress_config (config, config_size, &cconfig);
 801   GNUNET_free (config);
 802   GNUNET_assert ((UINT16_MAX -
 803                   sizeof (struct GNUNET_TESTBED_ControllerLinkMessage))
 804                   >= cc_size); /* Configuration doesn't fit in 1 message */
 805   GNUNET_TESTBED_controller_link_2 (master, delegated_host, slave_host,
 806                                     (const char *) cconfig,
 807                                     cc_size, config_size, is_subordinate);
 808   GNUNET_free (cconfig);
 809 }
 810
 811
 812 /**
 813  * Ask the testbed controller to write the current overlay topology to
 814  * a file.  Naturally, the file will only contain a snapshot as the
 815  * topology may evolve all the time.
 816  *
 817  * @param controller overlay controller to inspect
 818  * @param filename name of the file the topology should
 819  *        be written to.
 820  */
 821 void
 822 GNUNET_TESTBED_overlay_write_topology_to_file (struct GNUNET_TESTBED_Controller *controller,
 823                                                const char *filename)
 824 {
 825   GNUNET_break (0);
 826 }
 827
 828
 829
 830 /* end of testbed_api.c */