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     GNUNET_free (event);
 281   }
 282   GNUNET_CONTAINER_DLL_remove (c->op_head, c->op_tail, op);
 283   GNUNET_free (op);
 284   return GNUNET_YES;
 285 }
 286
 287
 288 /**
 289  * Handler for messages from controller (testbed service)
 290  *
 291  * @param cls the controller handler
 292  * @param msg message received, NULL on timeout or fatal error
 293  */
 294 static void
 295 message_handler (void *cls, const struct GNUNET_MessageHeader *msg)
 296 {
 297   struct GNUNET_TESTBED_Controller *c = cls;
 298   int status;
 299
 300   c->in_receive = GNUNET_NO;
 301   /* FIXME: Add checks for message integrity */
 302   if (NULL == msg)
 303   {
 304     LOG_DEBUG ("Receive timed out or connection to service dropped\n");
 305     return;
 306   }
 307   status = GNUNET_OK;
 308   switch (ntohs (msg->type))
 309   {
 310   case GNUNET_MESSAGE_TYPE_TESTBED_ADDHOSTCONFIRM:
 311     status =
 312       handle_addhostconfirm (c, (const struct
 313                                  GNUNET_TESTBED_HostConfirmedMessage *) msg);
 314     break;
 315   case GNUNET_MESSAGE_TYPE_TESTBED_GENERICOPSUCCESS:
 316     status =
 317       handle_opsuccess (c, (const struct
 318                             GNUNET_TESTBED_GenericOperationSuccessEventMessage
 319                             *) msg);
 320     break;
 321   default:
 322     GNUNET_break (0);
 323   }
 324   if ((GNUNET_OK == status) && (GNUNET_NO == c->in_receive))
 325   {
 326     c->in_receive = GNUNET_YES;
 327     GNUNET_CLIENT_receive (c->client, &message_handler, c,
 328                            GNUNET_TIME_UNIT_FOREVER_REL);
 329   }
 330 }
 331
 332 /**
 333  * Function called to notify a client about the connection begin ready to queue
 334  * more data.  "buf" will be NULL and "size" zero if the connection was closed
 335  * for writing in the meantime.
 336  *
 337  * @param cls closure
 338  * @param size number of bytes available in buf
 339  * @param buf where the callee should write the message
 340  * @return number of bytes written to buf
 341  */
 342 static size_t
 343 transmit_ready_notify (void *cls, size_t size, void *buf)
 344 {
 345   struct GNUNET_TESTBED_Controller *c = cls;
 346   struct MessageQueue *mq_entry;
 347
 348   c->th = NULL;
 349   mq_entry = c->mq_head;
 350   GNUNET_assert (NULL != mq_entry);
 351   if ((0 == size) && (NULL == buf)) /* Timeout */
 352   {
 353     LOG_DEBUG ("Message sending timed out -- retrying\n");
 354     c->th =
 355       GNUNET_CLIENT_notify_transmit_ready (c->client,
 356                                            ntohs (mq_entry->msg->size),
 357                                            TIMEOUT_REL,
 358                                            GNUNET_YES, &transmit_ready_notify,
 359                                            c);
 360     return 0;
 361   }
 362   GNUNET_assert (ntohs (mq_entry->msg->size) <= size);
 363   size = ntohs (mq_entry->msg->size);
 364   memcpy (buf, mq_entry->msg, size);
 365   LOG_DEBUG ("Message of type: %u and size: %u sent\n",
 366              ntohs (mq_entry->msg->type), size);
 367   GNUNET_free (mq_entry->msg);
 368   GNUNET_CONTAINER_DLL_remove (c->mq_head, c->mq_tail, mq_entry);
 369   GNUNET_free (mq_entry);
 370   mq_entry = c->mq_head;
 371   if (NULL != mq_entry)
 372     c->th =
 373       GNUNET_CLIENT_notify_transmit_ready (c->client,
 374                                            ntohs (mq_entry->msg->size),
 375                                            TIMEOUT_REL,
 376                                            GNUNET_YES, &transmit_ready_notify,
 377                                            c);
 378   if (GNUNET_NO == c->in_receive)
 379   {
 380     c->in_receive = GNUNET_YES;
 381     GNUNET_CLIENT_receive (c->client, &message_handler, c,
 382                            GNUNET_TIME_UNIT_FOREVER_REL);
 383   }
 384   return size;
 385 }
 386
 387
 388 /**
 389  * Queues a message in send queue for sending to the service
 390  *
 391  * @param controller the handle to the controller
 392  * @param msg the message to queue
 393  */
 394 void
 395 GNUNET_TESTBED_queue_message (struct GNUNET_TESTBED_Controller *controller,
 396                               struct GNUNET_MessageHeader *msg)
 397 {
 398   struct MessageQueue *mq_entry;
 399   uint16_t type;
 400   uint16_t size;
 401
 402   type = ntohs (msg->type);
 403   size = ntohs (msg->size);
 404   GNUNET_assert ((GNUNET_MESSAGE_TYPE_TESTBED_INIT <= type) &&
 405                  (GNUNET_MESSAGE_TYPE_TESTBED_MAX > type));
 406   mq_entry = GNUNET_malloc (sizeof (struct MessageQueue));
 407   mq_entry->msg = msg;
 408   LOG (GNUNET_ERROR_TYPE_DEBUG,
 409        "Queueing message of type %u, size %u for sending\n", type,
 410        ntohs (msg->size));
 411   GNUNET_CONTAINER_DLL_insert_tail (controller->mq_head, controller->mq_tail,
 412                                     mq_entry);
 413   if (NULL == controller->th)
 414     controller->th =
 415       GNUNET_CLIENT_notify_transmit_ready (controller->client, size,
 416                                            TIMEOUT_REL,
 417                                            GNUNET_YES, &transmit_ready_notify,
 418                                            controller);
 419 }
 420
 421
 422 /**
 423  * Handle for controller process
 424  */
 425 struct GNUNET_TESTBED_ControllerProc
 426 {
 427   /**
 428    * The helper handle
 429    */
 430   struct GNUNET_TESTBED_HelperHandle *helper;
 431
 432 };
 433
 434
 435 /**
 436  * Starts a controller process at the host
 437  *
 438  * @param host the host where the controller has to be started; NULL for localhost
 439  * @return the controller process handle
 440  */
 441 struct GNUNET_TESTBED_ControllerProc *
 442 GNUNET_TESTBED_controller_start (struct GNUNET_TESTBED_Host *host)
 443 {
 444   struct GNUNET_TESTBED_ControllerProc *cproc;
 445   char * const binary_argv[] = {
 446     "gnunet-service-testbed",
 447     "gnunet-service-testbed",
 448     NULL
 449   };
 450
 451   cproc = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_ControllerProc));
 452   cproc->helper = GNUNET_TESTBED_host_run_ (host, binary_argv);
 453   if (NULL == cproc->helper)
 454   {
 455     GNUNET_free (cproc);
 456     return NULL;
 457   }
 458   return cproc;
 459 }
 460
 461
 462 /**
 463  * Stop the controller process (also will terminate all peers and controllers
 464  * dependent on this controller).  This function blocks until the testbed has
 465  * been fully terminated (!).
 466  *
 467  * @param cproc the controller process handle
 468  */
 469 void
 470 GNUNET_TESTBED_controller_stop (struct GNUNET_TESTBED_ControllerProc *cproc)
 471 {
 472   GNUNET_TESTBED_host_stop_ (cproc->helper);
 473   GNUNET_free (cproc);
 474 }
 475
 476
 477 /**
 478  * Start a controller process using the given configuration at the
 479  * given host.
 480  *
 481  * @param cfg configuration to use
 482  * @param host host to run the controller on; This should be the same host if
 483  *          the controller was previously started with
 484  *          GNUNET_TESTBED_controller_start; NULL for localhost
 485  * @param event_mask bit mask with set of events to call 'cc' for;
 486  *                   or-ed values of "1LL" shifted by the
 487  *                   respective 'enum GNUNET_TESTBED_EventType'
 488  *                   (i.e.  "(1LL << GNUNET_TESTBED_ET_CONNECT) | ...")
 489  * @param cc controller callback to invoke on events
 490  * @param cc_cls closure for cc
 491  * @return handle to the controller
 492  */
 493 struct GNUNET_TESTBED_Controller *
 494 GNUNET_TESTBED_controller_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
 495                                    struct GNUNET_TESTBED_Host *host,
 496                                    uint64_t event_mask,
 497                                    GNUNET_TESTBED_ControllerCallback cc,
 498                                    void *cc_cls)
 499 {
 500   struct GNUNET_TESTBED_Controller *controller;
 501   struct GNUNET_TESTBED_InitMessage *msg;
 502
 503   controller = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_Controller));
 504   controller->cc = cc;
 505   controller->cc_cls = cc_cls;
 506   controller->event_mask = event_mask;
 507   controller->cfg = GNUNET_CONFIGURATION_dup (cfg);
 508   controller->client = GNUNET_CLIENT_connect ("testbed", controller->cfg);
 509   if (NULL == controller->client)
 510   {
 511     GNUNET_TESTBED_controller_disconnect (controller);
 512     return NULL;
 513   }
 514   if (NULL == host)
 515   {
 516     host = GNUNET_TESTBED_host_create_by_id_ (0);
 517     if (NULL == host)
 518     {
 519       LOG (GNUNET_ERROR_TYPE_WARNING,
 520            "Treating NULL host as localhost. Multiple references to localhost. "
 521            " May break when localhost freed before calling disconnect \n");
 522       host = GNUNET_TESTBED_host_lookup_by_id_ (0);
 523     }
 524     else
 525     {
 526       controller->aux_host = GNUNET_YES;
 527     }
 528   }
 529   GNUNET_assert (NULL != host);
 530   msg = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_InitMessage));
 531   msg->header.type = htons (GNUNET_MESSAGE_TYPE_TESTBED_INIT);
 532   msg->header.size = htons (sizeof (struct GNUNET_TESTBED_InitMessage));
 533   msg->host_id = htonl (GNUNET_TESTBED_host_get_id_ (host));
 534   msg->event_mask = GNUNET_htonll (controller->event_mask);
 535   GNUNET_TESTBED_queue_message (controller, (struct GNUNET_MessageHeader *) msg);
 536   return controller;
 537 }
 538
 539
 540 /**
 541  * Configure shared services at a controller.  Using this function,
 542  * you can specify that certain services (such as "resolver")
 543  * should not be run for each peer but instead be shared
 544  * across N peers on the specified host.  This function
 545  * must be called before any peers are created at the host.
 546  *
 547  * @param controller controller to configure
 548  * @param service_name name of the service to share
 549  * @param num_peers number of peers that should share one instance
 550  *        of the specified service (1 for no sharing is the default),
 551  *        use 0 to disable the service
 552  */
 553 void
 554 GNUNET_TESTBED_controller_configure_sharing (struct GNUNET_TESTBED_Controller *controller,
 555                                              const char *service_name,
 556                                              uint32_t num_peers)
 557 {
 558   struct GNUNET_TESTBED_ConfigureSharedServiceMessage *msg;
 559   uint16_t service_name_size;
 560   uint16_t msg_size;
 561
 562   service_name_size = strlen (service_name) + 1;
 563   msg_size = sizeof (struct GNUNET_TESTBED_ConfigureSharedServiceMessage)
 564     + service_name_size;
 565   msg = GNUNET_malloc (msg_size);
 566   msg->header.size = htons (msg_size);
 567   msg->header.type = htons (GNUNET_MESSAGE_TYPE_TESTBED_SERVICESHARE);
 568   msg->host_id = htonl (GNUNET_TESTBED_host_get_id_ (controller->host));
 569   msg->num_peers = htonl (num_peers);
 570   memcpy (&msg[1], service_name, service_name_size);
 571   GNUNET_TESTBED_queue_message (controller, (struct GNUNET_MessageHeader *) msg);
 572 }
 573
 574
 575 /**
 576  * disconnects from the controller.
 577  *
 578  * @param controller handle to controller to stop
 579  */
 580 void
 581 GNUNET_TESTBED_controller_disconnect (struct GNUNET_TESTBED_Controller *controller)
 582 {
 583   struct MessageQueue *mq_entry;
 584
 585   if (NULL != controller->th)
 586     GNUNET_CLIENT_notify_transmit_ready_cancel (controller->th);
 587  /* Clear the message queue */
 588   while (NULL != (mq_entry = controller->mq_head))
 589   {
 590     GNUNET_CONTAINER_DLL_remove (controller->mq_head,
 591                                  controller->mq_tail,
 592                                  mq_entry);
 593     GNUNET_free (mq_entry->msg);
 594     GNUNET_free (mq_entry);
 595   }
 596   if (NULL != controller->client)
 597     GNUNET_CLIENT_disconnect (controller->client);
 598   GNUNET_CONFIGURATION_destroy (controller->cfg);
 599   if (GNUNET_YES == controller->aux_host)
 600     GNUNET_TESTBED_host_destroy (controller->host);
 601   GNUNET_free (controller);
 602 }
 603
 604
 605 /**
 606  * Register a host with the controller
 607  *
 608  * @param controller the controller handle
 609  * @param host the host to register
 610  * @param cc the completion callback to call to inform the status of
 611  *          registration. After calling this callback the registration handle
 612  *          will be invalid. Cannot be NULL.
 613  * @param cc_cls the closure for the cc
 614  * @return handle to the host registration which can be used to cancel the
 615  *           registration
 616  */
 617 struct GNUNET_TESTBED_HostRegistrationHandle *
 618 GNUNET_TESTBED_register_host (struct GNUNET_TESTBED_Controller *controller,
 619                               struct GNUNET_TESTBED_Host *host,
 620                               GNUNET_TESTBED_HostRegistrationCompletion cc,
 621                               void *cc_cls)
 622 {
 623   struct GNUNET_TESTBED_HostRegistrationHandle *rh;
 624   struct GNUNET_TESTBED_AddHostMessage *msg;
 625   const char *username;
 626   const char *hostname;
 627   uint16_t msg_size;
 628   uint16_t user_name_length;
 629
 630   if (NULL != controller->rh)
 631     return NULL;
 632   hostname = GNUNET_TESTBED_host_get_hostname_ (host);
 633   if (GNUNET_YES == GNUNET_TESTBED_is_host_registered_ (host, controller))
 634   {
 635     LOG (GNUNET_ERROR_TYPE_WARNING,
 636          "Host hostname: %s already registered\n",
 637          (NULL == hostname) ? "localhost" : hostname);
 638     return NULL;
 639   }
 640   rh = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_HostRegistrationHandle));
 641   rh->host = host;
 642   rh->c = controller;
 643   GNUNET_assert (NULL != cc);
 644   rh->cc = cc;
 645   rh->cc_cls = cc_cls;
 646   controller->rh = rh;
 647   username = GNUNET_TESTBED_host_get_username_ (host);
 648   msg_size = (sizeof (struct GNUNET_TESTBED_AddHostMessage));
 649   user_name_length = 0;
 650   if (NULL != username)
 651   {
 652     user_name_length = strlen (username) + 1;
 653     msg_size += user_name_length;
 654   }
 655   /* FIXME: what happens when hostname is NULL? localhost */
 656   GNUNET_assert (NULL != hostname);
 657   msg_size += strlen (hostname) + 1;
 658   msg = GNUNET_malloc (msg_size);
 659   msg->header.size = htons (msg_size);
 660   msg->header.type = htons (GNUNET_MESSAGE_TYPE_TESTBED_ADDHOST);
 661   msg->host_id = htonl (GNUNET_TESTBED_host_get_id_ (host));
 662   msg->ssh_port = htons (GNUNET_TESTBED_host_get_ssh_port_ (host));
 663   msg->user_name_length = htons (user_name_length);
 664   if (NULL != username)
 665     memcpy (&msg[1], username, user_name_length);
 666   strcpy (((void *) &msg[1]) + user_name_length, hostname);
 667   GNUNET_TESTBED_queue_message (controller, (struct GNUNET_MessageHeader *) msg);
 668   return rh;
 669 }
 670
 671
 672 /**
 673  * Cancel the pending registration. Note that if the registration message is
 674  * already sent to the service the cancellation has only the effect that the
 675  * registration completion callback for the registration is never called.
 676  *
 677  * @param handle the registration handle to cancel
 678  */
 679 void
 680 GNUNET_TESTBED_cancel_registration (struct GNUNET_TESTBED_HostRegistrationHandle
 681                                     *handle)
 682 {
 683   if (handle != handle->c->rh)
 684   {
 685     GNUNET_break (0);
 686     return;
 687   }
 688   handle->c->rh = NULL;
 689   GNUNET_free (handle);
 690 }
 691
 692
 693 /**
 694  * Same as the GNUNET_TESTBED_controller_link, however expects configuration in
 695  * serialized and compressed
 696  *
 697  * @param master handle to the master controller who creates the association
 698  * @param delegated_host requests to which host should be delegated; cannot be NULL
 699  * @param slave_host which host is used to run the slave controller; use NULL to
 700  *          make the master controller connect to the delegated host
 701  * @param sxcfg serialized and compressed configuration
 702  * @param sxcfg_size the size scfg
 703  * @param scfg_size the size of uncompressed serialized configuration
 704  * @param is_subordinate GNUNET_YES if the controller at delegated_host should
 705  *          be started by the master controller; GNUNET_NO if we are just
 706  *          allowed to use the slave via TCP/IP
 707  */
 708 void
 709 GNUNET_TESTBED_controller_link_2 (struct GNUNET_TESTBED_Controller *master,
 710                                   struct GNUNET_TESTBED_Host *delegated_host,
 711                                   struct GNUNET_TESTBED_Host *slave_host,
 712                                   const char *sxcfg,
 713                                   size_t sxcfg_size,
 714                                   size_t scfg_size,
 715                                   int is_subordinate)
 716 {
 717   struct GNUNET_TESTBED_ControllerLinkMessage *msg;
 718   uint16_t msg_size;
 719
 720   GNUNET_assert (GNUNET_YES ==
 721                  GNUNET_TESTBED_is_host_registered_ (delegated_host, master));
 722   if ((NULL != slave_host) && (0 != GNUNET_TESTBED_host_get_id_ (slave_host)))
 723     GNUNET_assert (GNUNET_YES ==
 724                    GNUNET_TESTBED_is_host_registered_ (slave_host, master));
 725   msg_size = sxcfg_size + sizeof (struct GNUNET_TESTBED_ControllerLinkMessage);
 726   msg = GNUNET_malloc (msg_size);
 727   msg->header.type = htons (GNUNET_MESSAGE_TYPE_TESTBED_LCONTROLLERS);
 728   msg->header.size = htons (msg_size);
 729   msg->delegated_host_id = htonl (GNUNET_TESTBED_host_get_id_ (delegated_host));
 730   msg->slave_host_id = htonl (GNUNET_TESTBED_host_get_id_
 731                               ((NULL != slave_host) ? slave_host : master->host));
 732   msg->config_size = htons ((uint16_t) scfg_size);
 733   msg->is_subordinate = (GNUNET_YES == is_subordinate) ? 1 : 0;
 734   memcpy (&msg[1], sxcfg, sxcfg_size);
 735   GNUNET_TESTBED_queue_message (master, (struct GNUNET_MessageHeader *) msg);
 736 }
 737
 738
 739 /**
 740  * Compresses given configuration using zlib compress
 741  *
 742  * @param config the serialized configuration
 743  * @param size the size of config
 744  * @param xconfig will be set to the compressed configuration (memory is fresly
 745  *          allocated)
 746  * @return the size of the xconfig
 747  */
 748 size_t
 749 GNUNET_TESTBED_compress_config (const char *config, size_t size,
 750                                 char **xconfig)
 751 {
 752   size_t xsize;
 753
 754   xsize = compressBound ((uLong) size);
 755   *xconfig = GNUNET_malloc (xsize);
 756   GNUNET_assert (Z_OK ==
 757                  compress2 ((Bytef *)* xconfig, (uLongf *) &xsize,
 758                             (const Bytef *) config, (uLongf) size,
 759                             Z_BEST_SPEED));
 760   return xsize;
 761 }
 762
 763
 764 /**
 765  * Create a link from slave controller to delegated controller. Whenever the
 766  * master controller is asked to start a peer at the delegated controller the
 767  * request will be routed towards slave controller (if a route exists). The
 768  * slave controller will then route it to the delegated controller. The
 769  * configuration of the slave controller is given and to be used to either
 770  * create the slave controller or to connect to an existing slave controller
 771  * process.  'is_subordinate' specifies if the given slave controller should be
 772  * started and managed by the master controller, or if the slave already has a
 773  * master and this is just a secondary master that is also allowed to use the
 774  * existing slave.
 775  *
 776  * @param master handle to the master controller who creates the association
 777  * @param delegated_host requests to which host should be delegated
 778  * @param slave_host which host is used to run the slave controller
 779  * @param slave_cfg configuration to use for the slave controller
 780  * @param is_subordinate GNUNET_YES if the slave should be started (and stopped)
 781  *                       by the master controller; GNUNET_NO if we are just
 782  *                       allowed to use the slave via TCP/IP
 783  */
 784 void
 785 GNUNET_TESTBED_controller_link (struct GNUNET_TESTBED_Controller *master,
 786                                 struct GNUNET_TESTBED_Host *delegated_host,
 787                                 struct GNUNET_TESTBED_Host *slave_host,
 788                                 const struct GNUNET_CONFIGURATION_Handle *slave_cfg,
 789                                 int is_subordinate)
 790 {
 791   char *config;
 792   char *cconfig;
 793   size_t cc_size;
 794   size_t config_size;
 795
 796   GNUNET_assert (GNUNET_YES ==
 797                  GNUNET_TESTBED_is_host_registered_ (delegated_host, master));
 798   if ((NULL != slave_host) && (0 != GNUNET_TESTBED_host_get_id_ (slave_host)))
 799     GNUNET_assert (GNUNET_YES ==
 800                    GNUNET_TESTBED_is_host_registered_ (slave_host, master));
 801   config = GNUNET_CONFIGURATION_serialize (slave_cfg, &config_size);
 802   cc_size = GNUNET_TESTBED_compress_config (config, config_size, &cconfig);
 803   GNUNET_free (config);
 804   GNUNET_assert ((UINT16_MAX -
 805                   sizeof (struct GNUNET_TESTBED_ControllerLinkMessage))
 806                   >= cc_size); /* Configuration doesn't fit in 1 message */
 807   GNUNET_TESTBED_controller_link_2 (master, delegated_host, slave_host,
 808                                     (const char *) cconfig,
 809                                     cc_size, config_size, is_subordinate);
 810   GNUNET_free (cconfig);
 811 }
 812
 813
 814 /**
 815  * Ask the testbed controller to write the current overlay topology to
 816  * a file.  Naturally, the file will only contain a snapshot as the
 817  * topology may evolve all the time.
 818  *
 819  * @param controller overlay controller to inspect
 820  * @param filename name of the file the topology should
 821  *        be written to.
 822  */
 823 void
 824 GNUNET_TESTBED_overlay_write_topology_to_file (struct GNUNET_TESTBED_Controller *controller,
 825                                                const char *filename)
 826 {
 827   GNUNET_break (0);
 828 }
 829
 830
 831
 832 /* end of testbed_api.c */