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