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 process handle
 430    */
 431   struct GNUNET_HELPER_Handle *helper;
 432
 433   /**
 434    * The controller error callback
 435    */
 436   GNUNET_TESTBED_ControllerStatusCallback cb;
 437
 438   /**
 439    * The closure for the above callback
 440    */
 441   void *cls;
 442
 443   /**
 444    * The send handle for the helper
 445    */
 446   struct GNUNET_HELPER_SendHandle *shandle;
 447
 448   /**
 449    * The port number for ssh; used for helpers starting ssh
 450    */
 451   char *port;
 452
 453   /**
 454    * The ssh destination string; used for helpers starting ssh
 455    */
 456   char *dst;
 457
 458 };
 459
 460
 461 /**
 462  * Functions with this signature are called whenever a
 463  * complete message is received by the tokenizer.
 464  *
 465  * Do not call GNUNET_SERVER_mst_destroy in callback
 466  *
 467  * @param cls closure
 468  * @param client identification of the client
 469  * @param message the actual message
 470  *
 471  * @return GNUNET_OK on success, GNUNET_SYSERR to stop further processing
 472  */
 473 static int helper_mst (void *cls, void *client,
 474                        const struct GNUNET_MessageHeader *message)
 475 {
 476   GNUNET_break (0);
 477   return GNUNET_OK;
 478 }
 479
 480
 481 /**
 482  * Continuation function from GNUNET_HELPER_send()
 483  *
 484  * @param cls closure
 485  * @param result GNUNET_OK on success,
 486  *               GNUNET_NO if helper process died
 487  *               GNUNET_SYSERR during GNUNET_HELPER_stop
 488  */
 489 static void
 490 clear_msg (void *cls, int result)
 491 {
 492   GNUNET_free (cls);
 493 }
 494
 495
 496 /**
 497  * Callback that will be called when the helper process dies. This is not called
 498  * when the helper process is stoped using GNUNET_HELPER_stop()
 499  *
 500  * @param cls the closure from GNUNET_HELPER_start()
 501  */
 502 static void
 503 helper_exp_cb (void *cls)
 504 {
 505   struct GNUNET_TESTBED_ControllerProc *cp = cls;
 506   GNUNET_TESTBED_ControllerStatusCallback cb;
 507   void *cb_cls;
 508
 509   cb = cp->cb;
 510   cb_cls = cp->cls;
 511   GNUNET_TESTBED_controller_stop (cp);
 512   if (NULL != cb)
 513     cb (cb_cls, NULL, GNUNET_SYSERR);
 514 }
 515
 516
 517 /**
 518  * Starts a controller process at the host. FIXME: add controller start callback
 519  * with the configuration with which the controller is started
 520  *
 521  * @param controller_ip the ip address of the controller. Will be set as TRUSTED
 522  *          host when starting testbed controller at host
 523  * @param host the host where the controller has to be started; NULL for
 524  *          localhost
 525  * @param cfg template configuration to use for the remote controller; the
 526  *          remote controller will be started with a slightly modified
 527  *          configuration (port numbers, unix domain sockets and service home
 528  *          values are changed as per TESTING library on the remote host)
 529  * @param cb function called when the controller is successfully started or
 530  *           dies unexpectedly; GNUNET_TESTBED_controller_stop shouldn't be
 531  *           called if cb is called with GNUNET_SYSERR as status. Will never be
 532  *           called in the same task as 'GNUNET_TESTBED_controller_start'
 533  *           (synchronous errors will be signalled by returning NULL)
 534  * @param cls closure for above callbacks
 535  * @return the controller process handle, NULL on errors
 536  */
 537 struct GNUNET_TESTBED_ControllerProc *
 538 GNUNET_TESTBED_controller_start (const char *controller_ip,
 539                                  struct GNUNET_TESTBED_Host *host,
 540                                  const struct GNUNET_CONFIGURATION_Handle *cfg,
 541                                  GNUNET_TESTBED_ControllerStatusCallback cb,
 542                                  void *cls)
 543 {
 544   struct GNUNET_TESTBED_ControllerProc *cp;
 545   struct GNUNET_TESTBED_HelperInit *msg;
 546
 547   cp = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_ControllerProc));
 548   if ((NULL == host) || (0 == GNUNET_TESTBED_host_get_id_ (host)))
 549   {
 550     char * const binary_argv[] = {
 551       "gnunet-testbed-helper", NULL
 552     };
 553
 554     cp->helper = GNUNET_HELPER_start ("gnunet-testbed-helper", binary_argv,
 555                                       &helper_mst, &helper_exp_cb, cp);
 556   }
 557   else
 558   {
 559     char *remote_args[6 + 1];
 560     unsigned int argp;
 561     const char *username;
 562     const char *hostname;
 563
 564     username = GNUNET_TESTBED_host_get_username_ (host);
 565     hostname = GNUNET_TESTBED_host_get_hostname_ (host);
 566     GNUNET_asprintf (&cp->port, "%u", GNUNET_TESTBED_host_get_ssh_port_ (host));
 567     if (NULL == username)
 568       GNUNET_asprintf (&cp->dst, "%s", hostname);
 569     else
 570       GNUNET_asprintf (&cp->dst, "%s@%s", hostname, username);
 571     argp = 0;
 572     remote_args[argp++] = "ssh";
 573     remote_args[argp++] = "-p";
 574     remote_args[argp++] = cp->port;
 575     remote_args[argp++] = "-q";
 576     remote_args[argp++] = cp->dst;
 577     remote_args[argp++] = "gnunet-testbed-helper";
 578     remote_args[argp++] = NULL;
 579     GNUNET_assert (argp == 6 + 1);
 580     cp->helper = GNUNET_HELPER_start ("ssh", remote_args,
 581                                       &helper_mst, &helper_exp_cb, cp);
 582   }
 583   if (NULL == cp->helper)
 584   {
 585     GNUNET_free_non_null (cp->port);
 586     GNUNET_free_non_null (cp->dst);
 587     GNUNET_free (cp);
 588     return NULL;
 589   }
 590   cp->cb = cb;
 591   cp->cls = cls;
 592   msg = GNUNET_TESTBED_create_helper_init_msg_ (controller_ip, cfg);
 593   cp->shandle = GNUNET_HELPER_send (cp->helper, &msg->header, GNUNET_NO,
 594                                     &clear_msg, msg);
 595   if (NULL == cp->shandle)
 596   {
 597     GNUNET_free (msg);
 598     GNUNET_TESTBED_controller_stop (cp);
 599     return NULL;
 600   }
 601   return cp;
 602 }
 603
 604
 605 /**
 606  * Stop the controller process (also will terminate all peers and controllers
 607  * dependent on this controller).  This function blocks until the testbed has
 608  * been fully terminated (!).
 609  *
 610  * @param cproc the controller process handle
 611  */
 612 void
 613 GNUNET_TESTBED_controller_stop (struct GNUNET_TESTBED_ControllerProc *cp)
 614 {
 615   if (NULL != cp->shandle)
 616     GNUNET_HELPER_send_cancel (cp->shandle);
 617   GNUNET_HELPER_stop (cp->helper);
 618   GNUNET_free_non_null (cp->port);
 619   GNUNET_free_non_null (cp->dst);
 620   GNUNET_free (cp);
 621 }
 622
 623
 624 /**
 625  * Start a controller process using the given configuration at the
 626  * given host.
 627  *
 628  * @param cfg configuration to use
 629  * @param host host to run the controller on; This should be the same host if
 630  *          the controller was previously started with
 631  *          GNUNET_TESTBED_controller_start; NULL for localhost
 632  * @param event_mask bit mask with set of events to call 'cc' for;
 633  *                   or-ed values of "1LL" shifted by the
 634  *                   respective 'enum GNUNET_TESTBED_EventType'
 635  *                   (i.e.  "(1LL << GNUNET_TESTBED_ET_CONNECT) | ...")
 636  * @param cc controller callback to invoke on events
 637  * @param cc_cls closure for cc
 638  * @return handle to the controller
 639  */
 640 struct GNUNET_TESTBED_Controller *
 641 GNUNET_TESTBED_controller_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
 642                                    struct GNUNET_TESTBED_Host *host,
 643                                    uint64_t event_mask,
 644                                    GNUNET_TESTBED_ControllerCallback cc,
 645                                    void *cc_cls)
 646 {
 647   struct GNUNET_TESTBED_Controller *controller;
 648   struct GNUNET_TESTBED_InitMessage *msg;
 649
 650   controller = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_Controller));
 651   controller->cc = cc;
 652   controller->cc_cls = cc_cls;
 653   controller->event_mask = event_mask;
 654   controller->cfg = GNUNET_CONFIGURATION_dup (cfg);
 655   controller->client = GNUNET_CLIENT_connect ("testbed", controller->cfg);
 656   if (NULL == controller->client)
 657   {
 658     GNUNET_TESTBED_controller_disconnect (controller);
 659     return NULL;
 660   }
 661   if (NULL == host)
 662   {
 663     host = GNUNET_TESTBED_host_create_by_id_ (0);
 664     if (NULL == host)
 665     {
 666       LOG (GNUNET_ERROR_TYPE_WARNING,
 667            "Treating NULL host as localhost. Multiple references to localhost. "
 668            " May break when localhost freed before calling disconnect \n");
 669       host = GNUNET_TESTBED_host_lookup_by_id_ (0);
 670     }
 671     else
 672     {
 673       controller->aux_host = GNUNET_YES;
 674     }
 675   }
 676   GNUNET_assert (NULL != host);
 677   msg = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_InitMessage));
 678   msg->header.type = htons (GNUNET_MESSAGE_TYPE_TESTBED_INIT);
 679   msg->header.size = htons (sizeof (struct GNUNET_TESTBED_InitMessage));
 680   msg->host_id = htonl (GNUNET_TESTBED_host_get_id_ (host));
 681   msg->event_mask = GNUNET_htonll (controller->event_mask);
 682   GNUNET_TESTBED_queue_message (controller, (struct GNUNET_MessageHeader *) msg);
 683   return controller;
 684 }
 685
 686
 687 /**
 688  * Configure shared services at a controller.  Using this function,
 689  * you can specify that certain services (such as "resolver")
 690  * should not be run for each peer but instead be shared
 691  * across N peers on the specified host.  This function
 692  * must be called before any peers are created at the host.
 693  *
 694  * @param controller controller to configure
 695  * @param service_name name of the service to share
 696  * @param num_peers number of peers that should share one instance
 697  *        of the specified service (1 for no sharing is the default),
 698  *        use 0 to disable the service
 699  */
 700 void
 701 GNUNET_TESTBED_controller_configure_sharing (struct GNUNET_TESTBED_Controller *controller,
 702                                              const char *service_name,
 703                                              uint32_t num_peers)
 704 {
 705   struct GNUNET_TESTBED_ConfigureSharedServiceMessage *msg;
 706   uint16_t service_name_size;
 707   uint16_t msg_size;
 708
 709   service_name_size = strlen (service_name) + 1;
 710   msg_size = sizeof (struct GNUNET_TESTBED_ConfigureSharedServiceMessage)
 711     + service_name_size;
 712   msg = GNUNET_malloc (msg_size);
 713   msg->header.size = htons (msg_size);
 714   msg->header.type = htons (GNUNET_MESSAGE_TYPE_TESTBED_SERVICESHARE);
 715   msg->host_id = htonl (GNUNET_TESTBED_host_get_id_ (controller->host));
 716   msg->num_peers = htonl (num_peers);
 717   memcpy (&msg[1], service_name, service_name_size);
 718   GNUNET_TESTBED_queue_message (controller, (struct GNUNET_MessageHeader *) msg);
 719 }
 720
 721
 722 /**
 723  * disconnects from the controller.
 724  *
 725  * @param controller handle to controller to stop
 726  */
 727 void
 728 GNUNET_TESTBED_controller_disconnect (struct GNUNET_TESTBED_Controller *controller)
 729 {
 730   struct MessageQueue *mq_entry;
 731
 732   if (NULL != controller->th)
 733     GNUNET_CLIENT_notify_transmit_ready_cancel (controller->th);
 734  /* Clear the message queue */
 735   while (NULL != (mq_entry = controller->mq_head))
 736   {
 737     GNUNET_CONTAINER_DLL_remove (controller->mq_head,
 738                                  controller->mq_tail,
 739                                  mq_entry);
 740     GNUNET_free (mq_entry->msg);
 741     GNUNET_free (mq_entry);
 742   }
 743   if (NULL != controller->client)
 744     GNUNET_CLIENT_disconnect (controller->client);
 745   GNUNET_CONFIGURATION_destroy (controller->cfg);
 746   if (GNUNET_YES == controller->aux_host)
 747     GNUNET_TESTBED_host_destroy (controller->host);
 748   GNUNET_free (controller);
 749 }
 750
 751
 752 /**
 753  * Register a host with the controller
 754  *
 755  * @param controller the controller handle
 756  * @param host the host to register
 757  * @param cc the completion callback to call to inform the status of
 758  *          registration. After calling this callback the registration handle
 759  *          will be invalid. Cannot be NULL.
 760  * @param cc_cls the closure for the cc
 761  * @return handle to the host registration which can be used to cancel the
 762  *           registration
 763  */
 764 struct GNUNET_TESTBED_HostRegistrationHandle *
 765 GNUNET_TESTBED_register_host (struct GNUNET_TESTBED_Controller *controller,
 766                               struct GNUNET_TESTBED_Host *host,
 767                               GNUNET_TESTBED_HostRegistrationCompletion cc,
 768                               void *cc_cls)
 769 {
 770   struct GNUNET_TESTBED_HostRegistrationHandle *rh;
 771   struct GNUNET_TESTBED_AddHostMessage *msg;
 772   const char *username;
 773   const char *hostname;
 774   uint16_t msg_size;
 775   uint16_t user_name_length;
 776
 777   if (NULL != controller->rh)
 778     return NULL;
 779   hostname = GNUNET_TESTBED_host_get_hostname_ (host);
 780   if (GNUNET_YES == GNUNET_TESTBED_is_host_registered_ (host, controller))
 781   {
 782     LOG (GNUNET_ERROR_TYPE_WARNING,
 783          "Host hostname: %s already registered\n",
 784          (NULL == hostname) ? "localhost" : hostname);
 785     return NULL;
 786   }
 787   rh = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_HostRegistrationHandle));
 788   rh->host = host;
 789   rh->c = controller;
 790   GNUNET_assert (NULL != cc);
 791   rh->cc = cc;
 792   rh->cc_cls = cc_cls;
 793   controller->rh = rh;
 794   username = GNUNET_TESTBED_host_get_username_ (host);
 795   msg_size = (sizeof (struct GNUNET_TESTBED_AddHostMessage));
 796   user_name_length = 0;
 797   if (NULL != username)
 798   {
 799     user_name_length = strlen (username) + 1;
 800     msg_size += user_name_length;
 801   }
 802   /* FIXME: what happens when hostname is NULL? localhost */
 803   GNUNET_assert (NULL != hostname);
 804   msg_size += strlen (hostname) + 1;
 805   msg = GNUNET_malloc (msg_size);
 806   msg->header.size = htons (msg_size);
 807   msg->header.type = htons (GNUNET_MESSAGE_TYPE_TESTBED_ADDHOST);
 808   msg->host_id = htonl (GNUNET_TESTBED_host_get_id_ (host));
 809   msg->ssh_port = htons (GNUNET_TESTBED_host_get_ssh_port_ (host));
 810   msg->user_name_length = htons (user_name_length);
 811   if (NULL != username)
 812     memcpy (&msg[1], username, user_name_length);
 813   strcpy (((void *) &msg[1]) + user_name_length, hostname);
 814   GNUNET_TESTBED_queue_message (controller, (struct GNUNET_MessageHeader *) msg);
 815   return rh;
 816 }
 817
 818
 819 /**
 820  * Cancel the pending registration. Note that if the registration message is
 821  * already sent to the service the cancellation has only the effect that the
 822  * registration completion callback for the registration is never called.
 823  *
 824  * @param handle the registration handle to cancel
 825  */
 826 void
 827 GNUNET_TESTBED_cancel_registration (struct GNUNET_TESTBED_HostRegistrationHandle
 828                                     *handle)
 829 {
 830   if (handle != handle->c->rh)
 831   {
 832     GNUNET_break (0);
 833     return;
 834   }
 835   handle->c->rh = NULL;
 836   GNUNET_free (handle);
 837 }
 838
 839
 840 /**
 841  * Same as the GNUNET_TESTBED_controller_link, however expects configuration in
 842  * serialized and compressed
 843  *
 844  * @param master handle to the master controller who creates the association
 845  * @param delegated_host requests to which host should be delegated; cannot be NULL
 846  * @param slave_host which host is used to run the slave controller; use NULL to
 847  *          make the master controller connect to the delegated host
 848  * @param sxcfg serialized and compressed configuration
 849  * @param sxcfg_size the size scfg
 850  * @param scfg_size the size of uncompressed serialized configuration
 851  * @param is_subordinate GNUNET_YES if the controller at delegated_host should
 852  *          be started by the master controller; GNUNET_NO if we are just
 853  *          allowed to use the slave via TCP/IP
 854  */
 855 void
 856 GNUNET_TESTBED_controller_link_2 (struct GNUNET_TESTBED_Controller *master,
 857                                   struct GNUNET_TESTBED_Host *delegated_host,
 858                                   struct GNUNET_TESTBED_Host *slave_host,
 859                                   const char *sxcfg,
 860                                   size_t sxcfg_size,
 861                                   size_t scfg_size,
 862                                   int is_subordinate)
 863 {
 864   struct GNUNET_TESTBED_ControllerLinkMessage *msg;
 865   uint16_t msg_size;
 866
 867   GNUNET_assert (GNUNET_YES ==
 868                  GNUNET_TESTBED_is_host_registered_ (delegated_host, master));
 869   if ((NULL != slave_host) && (0 != GNUNET_TESTBED_host_get_id_ (slave_host)))
 870     GNUNET_assert (GNUNET_YES ==
 871                    GNUNET_TESTBED_is_host_registered_ (slave_host, master));
 872   msg_size = sxcfg_size + sizeof (struct GNUNET_TESTBED_ControllerLinkMessage);
 873   msg = GNUNET_malloc (msg_size);
 874   msg->header.type = htons (GNUNET_MESSAGE_TYPE_TESTBED_LCONTROLLERS);
 875   msg->header.size = htons (msg_size);
 876   msg->delegated_host_id = htonl (GNUNET_TESTBED_host_get_id_ (delegated_host));
 877   msg->slave_host_id = htonl (GNUNET_TESTBED_host_get_id_
 878                               ((NULL != slave_host) ? slave_host : master->host));
 879   msg->config_size = htons ((uint16_t) scfg_size);
 880   msg->is_subordinate = (GNUNET_YES == is_subordinate) ? 1 : 0;
 881   memcpy (&msg[1], sxcfg, sxcfg_size);
 882   GNUNET_TESTBED_queue_message (master, (struct GNUNET_MessageHeader *) msg);
 883 }
 884
 885
 886 /**
 887  * Compresses given configuration using zlib compress
 888  *
 889  * @param config the serialized configuration
 890  * @param size the size of config
 891  * @param xconfig will be set to the compressed configuration (memory is fresly
 892  *          allocated)
 893  * @return the size of the xconfig
 894  */
 895 size_t
 896 GNUNET_TESTBED_compress_config (const char *config, size_t size,
 897                                 char **xconfig)
 898 {
 899   size_t xsize;
 900
 901   xsize = compressBound ((uLong) size);
 902   *xconfig = GNUNET_malloc (xsize);
 903   GNUNET_assert (Z_OK ==
 904                  compress2 ((Bytef *)* xconfig, (uLongf *) &xsize,
 905                             (const Bytef *) config, (uLongf) size,
 906                             Z_BEST_SPEED));
 907   return xsize;
 908 }
 909
 910
 911 /**
 912  * Create a link from slave controller to delegated controller. Whenever the
 913  * master controller is asked to start a peer at the delegated controller the
 914  * request will be routed towards slave controller (if a route exists). The
 915  * slave controller will then route it to the delegated controller. The
 916  * configuration of the slave controller is given and to be used to either
 917  * create the slave controller or to connect to an existing slave controller
 918  * process.  'is_subordinate' specifies if the given slave controller should be
 919  * started and managed by the master controller, or if the slave already has a
 920  * master and this is just a secondary master that is also allowed to use the
 921  * existing slave.
 922  *
 923  * @param master handle to the master controller who creates the association
 924  * @param delegated_host requests to which host should be delegated
 925  * @param slave_host which host is used to run the slave controller
 926  * @param slave_cfg configuration to use for the slave controller
 927  * @param is_subordinate GNUNET_YES if the slave should be started (and stopped)
 928  *                       by the master controller; GNUNET_NO if we are just
 929  *                       allowed to use the slave via TCP/IP
 930  */
 931 void
 932 GNUNET_TESTBED_controller_link (struct GNUNET_TESTBED_Controller *master,
 933                                 struct GNUNET_TESTBED_Host *delegated_host,
 934                                 struct GNUNET_TESTBED_Host *slave_host,
 935                                 const struct GNUNET_CONFIGURATION_Handle *slave_cfg,
 936                                 int is_subordinate)
 937 {
 938   char *config;
 939   char *cconfig;
 940   size_t cc_size;
 941   size_t config_size;
 942
 943   GNUNET_assert (GNUNET_YES ==
 944                  GNUNET_TESTBED_is_host_registered_ (delegated_host, master));
 945   if ((NULL != slave_host) && (0 != GNUNET_TESTBED_host_get_id_ (slave_host)))
 946     GNUNET_assert (GNUNET_YES ==
 947                    GNUNET_TESTBED_is_host_registered_ (slave_host, master));
 948   config = GNUNET_CONFIGURATION_serialize (slave_cfg, &config_size);
 949   cc_size = GNUNET_TESTBED_compress_config (config, config_size, &cconfig);
 950   GNUNET_free (config);
 951   GNUNET_assert ((UINT16_MAX -
 952                   sizeof (struct GNUNET_TESTBED_ControllerLinkMessage))
 953                   >= cc_size); /* Configuration doesn't fit in 1 message */
 954   GNUNET_TESTBED_controller_link_2 (master, delegated_host, slave_host,
 955                                     (const char *) cconfig,
 956                                     cc_size, config_size, is_subordinate);
 957   GNUNET_free (cconfig);
 958 }
 959
 960
 961 /**
 962  * Ask the testbed controller to write the current overlay topology to
 963  * a file.  Naturally, the file will only contain a snapshot as the
 964  * topology may evolve all the time.
 965  *
 966  * @param controller overlay controller to inspect
 967  * @param filename name of the file the topology should
 968  *        be written to.
 969  */
 970 void
 971 GNUNET_TESTBED_overlay_write_topology_to_file (struct GNUNET_TESTBED_Controller *controller,
 972                                                const char *filename)
 973 {
 974   GNUNET_break (0);
 975 }
 976
 977
 978
 979 /* end of testbed_api.c */