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   GNUNET_CONTAINER_DLL_remove (c->op_head, c->op_tail, op);
 277   GNUNET_free (op);
 278   if (NULL != event)
 279   {
 280     if (NULL != c->cc)
 281       c->cc (c->cc_cls, event);
 282     GNUNET_free (event);
 283   }
 284   return GNUNET_YES;
 285 }
 286
 287
 288 /**
 289  * Handler for GNUNET_MESSAGE_TYPE_TESTBED_PEERCREATESUCCESS message from
 290  * controller (testbed service)
 291  *
 292  * @param c the controller handler
 293  * @param msg message received
 294  * @return GNUNET_YES if we can continue receiving from service; GNUNET_NO if
 295  *           not
 296  */
 297 static int
 298 handle_peer_create_success (struct GNUNET_TESTBED_Controller *c,
 299                             const struct
 300                             GNUNET_TESTBED_PeerCreateSuccessEventMessage *msg)
 301 {
 302   struct GNUNET_TESTBED_Operation *op;
 303   struct PeerCreateData *data;
 304   struct GNUNET_TESTBED_Peer *peer;
 305   GNUNET_TESTBED_PeerCreateCallback cb;
 306   void *cls;
 307   uint64_t op_id;
 308
 309   GNUNET_assert (sizeof (struct GNUNET_TESTBED_PeerCreateSuccessEventMessage)
 310                  == ntohs (msg->header.size));
 311   op_id = GNUNET_ntohll (msg->operation_id);
 312   for (op = c->op_head; NULL != op; op = op->next)
 313   {
 314     if (op->operation_id == op_id)
 315       break;
 316   }
 317   if (NULL == op)
 318   {
 319     LOG_DEBUG ("Operation not found\n");
 320     return GNUNET_YES;
 321   }
 322   GNUNET_assert (OP_PEER_CREATE == op->type);
 323   GNUNET_assert (NULL != op->data);
 324   data = op->data;
 325   GNUNET_assert (NULL != data->peer);
 326   peer = data->peer;
 327   GNUNET_assert (peer->unique_id == ntohl (msg->peer_id));
 328   cb = data->cb;
 329   cls = data->cls;
 330   GNUNET_CONTAINER_DLL_remove (c->op_head, c->op_tail, op);
 331   GNUNET_free (data);
 332   GNUNET_free (op);
 333   if (NULL != cb)
 334     cb (cls, peer, NULL);
 335   return GNUNET_YES;
 336 }
 337
 338
 339 /**
 340  * Handler for GNUNET_MESSAGE_TYPE_TESTBED_PEEREVENT message from
 341  * controller (testbed service)
 342  *
 343  * @param c the controller handler
 344  * @param msg message received
 345  * @return GNUNET_YES if we can continue receiving from service; GNUNET_NO if
 346  *           not
 347  */
 348 static int
 349 handle_peer_event (struct GNUNET_TESTBED_Controller *c,
 350                    const struct GNUNET_TESTBED_PeerEventMessage *msg)
 351 {
 352   struct GNUNET_TESTBED_Operation *op;
 353   struct GNUNET_TESTBED_Peer *peer;
 354   struct GNUNET_TESTBED_EventInformation event;
 355   uint64_t op_id;
 356
 357   GNUNET_assert (sizeof (struct GNUNET_TESTBED_PeerEventMessage)
 358                  == ntohs (msg->header.size));
 359   op_id = GNUNET_ntohll (msg->operation_id);
 360   for (op = c->op_head; NULL != op; op = op->next)
 361   {
 362     if (op->operation_id == op_id)
 363       break;
 364   }
 365   if (NULL == op)
 366   {
 367     LOG_DEBUG ("Operation not found\n");
 368     return GNUNET_YES;
 369   }
 370   GNUNET_assert ((OP_PEER_START == op->type) || (OP_PEER_STOP == op->type));
 371   peer = op->data;
 372   GNUNET_assert (NULL != peer);
 373   event.type = (enum GNUNET_TESTBED_EventType) ntohl (msg->event_type);
 374   switch (event.type)
 375   {
 376   case GNUNET_TESTBED_ET_PEER_START:
 377     event.details.peer_start.host = peer->host;
 378     event.details.peer_start.peer = peer;
 379     break;
 380   case GNUNET_TESTBED_ET_PEER_STOP:
 381     event.details.peer_stop.peer = peer;
 382     break;
 383   default:
 384     GNUNET_assert (0);          /* We should never reach this state */
 385   }
 386   GNUNET_CONTAINER_DLL_remove (c->op_head, c->op_tail, op);
 387   GNUNET_free (op);
 388   if (0 != ((GNUNET_TESTBED_ET_PEER_START | GNUNET_TESTBED_ET_PEER_STOP)
 389             & c->event_mask))
 390   {
 391     if (NULL != c->cc)
 392       c->cc (c->cc_cls, &event);
 393   }
 394   return GNUNET_YES;
 395 }
 396
 397
 398 /**
 399  * Handler for messages from controller (testbed service)
 400  *
 401  * @param cls the controller handler
 402  * @param msg message received, NULL on timeout or fatal error
 403  */
 404 static void
 405 message_handler (void *cls, const struct GNUNET_MessageHeader *msg)
 406 {
 407   struct GNUNET_TESTBED_Controller *c = cls;
 408   int status;
 409
 410   c->in_receive = GNUNET_NO;
 411   /* FIXME: Add checks for message integrity */
 412   if (NULL == msg)
 413   {
 414     LOG_DEBUG ("Receive timed out or connection to service dropped\n");
 415     return;
 416   }
 417   status = GNUNET_OK;
 418   switch (ntohs (msg->type))
 419   {
 420   case GNUNET_MESSAGE_TYPE_TESTBED_ADDHOSTCONFIRM:
 421     status =
 422       handle_addhostconfirm (c, (const struct
 423                                  GNUNET_TESTBED_HostConfirmedMessage *) msg);
 424     break;
 425   case GNUNET_MESSAGE_TYPE_TESTBED_GENERICOPSUCCESS:
 426     status =
 427       handle_opsuccess (c, (const struct
 428                             GNUNET_TESTBED_GenericOperationSuccessEventMessage
 429                             *) msg);
 430     break;
 431   case GNUNET_MESSAGE_TYPE_TESTBED_PEERCREATESUCCESS:
 432     status =
 433       handle_peer_create_success
 434       (c, (const struct GNUNET_TESTBED_PeerCreateSuccessEventMessage *)msg);
 435     break;
 436   case GNUNET_MESSAGE_TYPE_TESTBED_PEEREVENT:
 437     status =
 438       handle_peer_event (c, (const struct GNUNET_TESTBED_PeerEventMessage *) msg);
 439     break;
 440   default:
 441     GNUNET_break (0);
 442   }
 443   if ((GNUNET_OK == status) && (GNUNET_NO == c->in_receive))
 444   {
 445     c->in_receive = GNUNET_YES;
 446     GNUNET_CLIENT_receive (c->client, &message_handler, c,
 447                            GNUNET_TIME_UNIT_FOREVER_REL);
 448   }
 449 }
 450
 451
 452 /**
 453  * Function called to notify a client about the connection begin ready to queue
 454  * more data.  "buf" will be NULL and "size" zero if the connection was closed
 455  * for writing in the meantime.
 456  *
 457  * @param cls closure
 458  * @param size number of bytes available in buf
 459  * @param buf where the callee should write the message
 460  * @return number of bytes written to buf
 461  */
 462 static size_t
 463 transmit_ready_notify (void *cls, size_t size, void *buf)
 464 {
 465   struct GNUNET_TESTBED_Controller *c = cls;
 466   struct MessageQueue *mq_entry;
 467
 468   c->th = NULL;
 469   mq_entry = c->mq_head;
 470   GNUNET_assert (NULL != mq_entry);
 471   if ((0 == size) && (NULL == buf)) /* Timeout */
 472   {
 473     LOG_DEBUG ("Message sending timed out -- retrying\n");
 474     c->th =
 475       GNUNET_CLIENT_notify_transmit_ready (c->client,
 476                                            ntohs (mq_entry->msg->size),
 477                                            TIMEOUT_REL,
 478                                            GNUNET_YES, &transmit_ready_notify,
 479                                            c);
 480     return 0;
 481   }
 482   GNUNET_assert (ntohs (mq_entry->msg->size) <= size);
 483   size = ntohs (mq_entry->msg->size);
 484   memcpy (buf, mq_entry->msg, size);
 485   LOG_DEBUG ("Message of type: %u and size: %u sent\n",
 486              ntohs (mq_entry->msg->type), size);
 487   GNUNET_free (mq_entry->msg);
 488   GNUNET_CONTAINER_DLL_remove (c->mq_head, c->mq_tail, mq_entry);
 489   GNUNET_free (mq_entry);
 490   mq_entry = c->mq_head;
 491   if (NULL != mq_entry)
 492     c->th =
 493       GNUNET_CLIENT_notify_transmit_ready (c->client,
 494                                            ntohs (mq_entry->msg->size),
 495                                            TIMEOUT_REL,
 496                                            GNUNET_YES, &transmit_ready_notify,
 497                                            c);
 498   if (GNUNET_NO == c->in_receive)
 499   {
 500     c->in_receive = GNUNET_YES;
 501     GNUNET_CLIENT_receive (c->client, &message_handler, c,
 502                            GNUNET_TIME_UNIT_FOREVER_REL);
 503   }
 504   return size;
 505 }
 506
 507
 508 /**
 509  * Queues a message in send queue for sending to the service
 510  *
 511  * @param controller the handle to the controller
 512  * @param msg the message to queue
 513  */
 514 void
 515 GNUNET_TESTBED_queue_message_ (struct GNUNET_TESTBED_Controller *controller,
 516                                struct GNUNET_MessageHeader *msg)
 517 {
 518   struct MessageQueue *mq_entry;
 519   uint16_t type;
 520   uint16_t size;
 521
 522   type = ntohs (msg->type);
 523   size = ntohs (msg->size);
 524   GNUNET_assert ((GNUNET_MESSAGE_TYPE_TESTBED_INIT <= type) &&
 525                  (GNUNET_MESSAGE_TYPE_TESTBED_MAX > type));
 526   mq_entry = GNUNET_malloc (sizeof (struct MessageQueue));
 527   mq_entry->msg = msg;
 528   LOG (GNUNET_ERROR_TYPE_DEBUG,
 529        "Queueing message of type %u, size %u for sending\n", type,
 530        ntohs (msg->size));
 531   GNUNET_CONTAINER_DLL_insert_tail (controller->mq_head, controller->mq_tail,
 532                                     mq_entry);
 533   if (NULL == controller->th)
 534     controller->th =
 535       GNUNET_CLIENT_notify_transmit_ready (controller->client, size,
 536                                            TIMEOUT_REL,
 537                                            GNUNET_YES, &transmit_ready_notify,
 538                                            controller);
 539 }
 540
 541
 542 /**
 543  * Handle for controller process
 544  */
 545 struct GNUNET_TESTBED_ControllerProc
 546 {
 547   /**
 548    * The process handle
 549    */
 550   struct GNUNET_HELPER_Handle *helper;
 551
 552   /**
 553    * The host where the helper is run
 554    */
 555   struct GNUNET_TESTBED_Host *host;
 556
 557   /**
 558    * The controller error callback
 559    */
 560   GNUNET_TESTBED_ControllerStatusCallback cb;
 561
 562   /**
 563    * The closure for the above callback
 564    */
 565   void *cls;
 566
 567   /**
 568    * The send handle for the helper
 569    */
 570   struct GNUNET_HELPER_SendHandle *shandle;
 571
 572   /**
 573    * The message corresponding to send handle
 574    */
 575   struct GNUNET_MessageHeader *msg;
 576
 577   /**
 578    * The port number for ssh; used for helpers starting ssh
 579    */
 580   char *port;
 581
 582   /**
 583    * The ssh destination string; used for helpers starting ssh
 584    */
 585   char *dst;
 586
 587   /**
 588    * The configuration of the running testbed service
 589    */
 590   struct GNUNET_CONFIGURATION_Handle *cfg;
 591
 592 };
 593
 594
 595 /**
 596  * Functions with this signature are called whenever a
 597  * complete message is received by the tokenizer.
 598  *
 599  * Do not call GNUNET_SERVER_mst_destroy in callback
 600  *
 601  * @param cls closure
 602  * @param client identification of the client
 603  * @param message the actual message
 604  *
 605  * @return GNUNET_OK on success, GNUNET_SYSERR to stop further processing
 606  */
 607 static int helper_mst (void *cls, void *client,
 608                        const struct GNUNET_MessageHeader *message)
 609 {
 610   struct GNUNET_TESTBED_ControllerProc *cp = cls;
 611   const struct GNUNET_TESTBED_HelperReply *msg;
 612   const char *hostname;
 613   char *config;
 614   uLongf config_size;
 615   uLongf xconfig_size;
 616
 617   msg = (const struct GNUNET_TESTBED_HelperReply *) message;
 618   GNUNET_assert (sizeof (struct GNUNET_TESTBED_HelperReply)
 619                  < ntohs (msg->header.size));
 620   GNUNET_assert (GNUNET_MESSAGE_TYPE_TESTBED_HELPER_REPLY
 621                  == ntohs (msg->header.type));
 622   config_size = (uLongf) ntohs (msg->config_size);
 623   xconfig_size = (uLongf) (ntohs (msg->header.size)
 624                            - sizeof (struct GNUNET_TESTBED_HelperReply));
 625   config = GNUNET_malloc (config_size);
 626   GNUNET_assert (Z_OK == uncompress ((Bytef *) config, &config_size,
 627                                      (const Bytef *) &msg[1], xconfig_size));
 628   GNUNET_assert (NULL == cp->cfg);
 629   cp->cfg = GNUNET_CONFIGURATION_create ();
 630   GNUNET_assert (GNUNET_CONFIGURATION_deserialize (cp->cfg, config,
 631                                                    config_size, GNUNET_NO));
 632   GNUNET_free (config);
 633   if ((NULL == cp->host) ||
 634       (NULL == (hostname = GNUNET_TESTBED_host_get_hostname_ (cp->host))))
 635     hostname = "localhost";
 636   /* Change the hostname so that we can connect to it */
 637   GNUNET_CONFIGURATION_set_value_string (cp->cfg, "testbed", "hostname",
 638                                          hostname);
 639   cp->cb (cp->cls, cp->cfg, GNUNET_OK);
 640   return GNUNET_OK;
 641 }
 642
 643
 644 /**
 645  * Continuation function from GNUNET_HELPER_send()
 646  *
 647  * @param cls closure
 648  * @param result GNUNET_OK on success,
 649  *               GNUNET_NO if helper process died
 650  *               GNUNET_SYSERR during GNUNET_HELPER_stop
 651  */
 652 static void
 653 clear_msg (void *cls, int result)
 654 {
 655   struct GNUNET_TESTBED_ControllerProc *cp = cls;
 656
 657   GNUNET_assert (NULL != cp->shandle);
 658   cp->shandle = NULL;
 659   GNUNET_free (cp->msg);
 660 }
 661
 662
 663 /**
 664  * Callback that will be called when the helper process dies. This is not called
 665  * when the helper process is stoped using GNUNET_HELPER_stop()
 666  *
 667  * @param cls the closure from GNUNET_HELPER_start()
 668  */
 669 static void
 670 helper_exp_cb (void *cls)
 671 {
 672   struct GNUNET_TESTBED_ControllerProc *cp = cls;
 673   GNUNET_TESTBED_ControllerStatusCallback cb;
 674   void *cb_cls;
 675
 676   cb = cp->cb;
 677   cb_cls = cp->cls;
 678   GNUNET_TESTBED_controller_stop (cp);
 679   if (NULL != cb)
 680     cb (cb_cls, NULL, GNUNET_SYSERR);
 681 }
 682
 683
 684 /**
 685  * Starts a controller process at the host. FIXME: add controller start callback
 686  * with the configuration with which the controller is started
 687  *
 688  * @param controller_ip the ip address of the controller. Will be set as TRUSTED
 689  *          host when starting testbed controller at host
 690  * @param host the host where the controller has to be started; NULL for
 691  *          localhost
 692  * @param cfg template configuration to use for the remote controller; the
 693  *          remote controller will be started with a slightly modified
 694  *          configuration (port numbers, unix domain sockets and service home
 695  *          values are changed as per TESTING library on the remote host)
 696  * @param cb function called when the controller is successfully started or
 697  *          dies unexpectedly; GNUNET_TESTBED_controller_stop shouldn't be
 698  *          called if cb is called with GNUNET_SYSERR as status. Will never be
 699  *          called in the same task as 'GNUNET_TESTBED_controller_start'
 700  *          (synchronous errors will be signalled by returning NULL). This
 701  *          parameter cannot be NULL.
 702  * @param cls closure for above callbacks
 703  * @return the controller process handle, NULL on errors
 704  */
 705 struct GNUNET_TESTBED_ControllerProc *
 706 GNUNET_TESTBED_controller_start (const char *controller_ip,
 707                                  struct GNUNET_TESTBED_Host *host,
 708                                  const struct GNUNET_CONFIGURATION_Handle *cfg,
 709                                  GNUNET_TESTBED_ControllerStatusCallback cb,
 710                                  void *cls)
 711 {
 712   struct GNUNET_TESTBED_ControllerProc *cp;
 713   struct GNUNET_TESTBED_HelperInit *msg;
 714
 715   cp = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_ControllerProc));
 716   if ((NULL == host) || (0 == GNUNET_TESTBED_host_get_id_ (host)))
 717   {
 718     char * const binary_argv[] = {
 719       "gnunet-testbed-helper", NULL
 720     };
 721
 722     cp->helper = GNUNET_HELPER_start ("gnunet-testbed-helper", binary_argv,
 723                                       &helper_mst, &helper_exp_cb, cp);
 724   }
 725   else
 726   {
 727     char *remote_args[6 + 1];
 728     unsigned int argp;
 729     const char *username;
 730     const char *hostname;
 731
 732     username = GNUNET_TESTBED_host_get_username_ (host);
 733     hostname = GNUNET_TESTBED_host_get_hostname_ (host);
 734     GNUNET_asprintf (&cp->port, "%u", GNUNET_TESTBED_host_get_ssh_port_ (host));
 735     if (NULL == username)
 736       GNUNET_asprintf (&cp->dst, "%s", hostname);
 737     else
 738       GNUNET_asprintf (&cp->dst, "%s@%s", hostname, username);
 739     argp = 0;
 740     remote_args[argp++] = "ssh";
 741     remote_args[argp++] = "-p";
 742     remote_args[argp++] = cp->port;
 743     remote_args[argp++] = "-q";
 744     remote_args[argp++] = cp->dst;
 745     remote_args[argp++] = "gnunet-testbed-helper";
 746     remote_args[argp++] = NULL;
 747     GNUNET_assert (argp == 6 + 1);
 748     cp->helper = GNUNET_HELPER_start ("ssh", remote_args,
 749                                       &helper_mst, &helper_exp_cb, cp);
 750   }
 751   if (NULL == cp->helper)
 752   {
 753     GNUNET_free_non_null (cp->port);
 754     GNUNET_free_non_null (cp->dst);
 755     GNUNET_free (cp);
 756     return NULL;
 757   }
 758   cp->host = host;
 759   cp->cb = cb;
 760   cp->cls = cls;
 761   msg = GNUNET_TESTBED_create_helper_init_msg_ (controller_ip, cfg);
 762   cp->msg = &msg->header;
 763   cp->shandle = GNUNET_HELPER_send (cp->helper, &msg->header, GNUNET_NO,
 764                                     &clear_msg, cp);
 765   if (NULL == cp->shandle)
 766   {
 767     GNUNET_free (msg);
 768     GNUNET_TESTBED_controller_stop (cp);
 769     return NULL;
 770   }
 771   return cp;
 772 }
 773
 774
 775 /**
 776  * Stop the controller process (also will terminate all peers and controllers
 777  * dependent on this controller).  This function blocks until the testbed has
 778  * been fully terminated (!).
 779  *
 780  * @param cproc the controller process handle
 781  */
 782 void
 783 GNUNET_TESTBED_controller_stop (struct GNUNET_TESTBED_ControllerProc *cproc)
 784 {
 785   if (NULL != cproc->shandle)
 786     GNUNET_HELPER_send_cancel (cproc->shandle);
 787   GNUNET_HELPER_stop (cproc->helper);
 788   if (NULL != cproc->cfg)
 789     GNUNET_CONFIGURATION_destroy (cproc->cfg);
 790   GNUNET_free_non_null (cproc->port);
 791   GNUNET_free_non_null (cproc->dst);
 792   GNUNET_free (cproc);
 793 }
 794
 795
 796 /**
 797  * Start a controller process using the given configuration at the
 798  * given host.
 799  *
 800  * @param cfg configuration to use
 801  * @param host host to run the controller on; This should be the same host if
 802  *          the controller was previously started with
 803  *          GNUNET_TESTBED_controller_start; NULL for localhost
 804  * @param event_mask bit mask with set of events to call 'cc' for;
 805  *                   or-ed values of "1LL" shifted by the
 806  *                   respective 'enum GNUNET_TESTBED_EventType'
 807  *                   (i.e.  "(1LL << GNUNET_TESTBED_ET_CONNECT) | ...")
 808  * @param cc controller callback to invoke on events
 809  * @param cc_cls closure for cc
 810  * @return handle to the controller
 811  */
 812 struct GNUNET_TESTBED_Controller *
 813 GNUNET_TESTBED_controller_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
 814                                    struct GNUNET_TESTBED_Host *host,
 815                                    uint64_t event_mask,
 816                                    GNUNET_TESTBED_ControllerCallback cc,
 817                                    void *cc_cls)
 818 {
 819   struct GNUNET_TESTBED_Controller *controller;
 820   struct GNUNET_TESTBED_InitMessage *msg;
 821
 822   controller = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_Controller));
 823   controller->cc = cc;
 824   controller->cc_cls = cc_cls;
 825   controller->event_mask = event_mask;
 826   controller->cfg = GNUNET_CONFIGURATION_dup (cfg);
 827   controller->client = GNUNET_CLIENT_connect ("testbed", controller->cfg);
 828   if (NULL == controller->client)
 829   {
 830     GNUNET_TESTBED_controller_disconnect (controller);
 831     return NULL;
 832   }
 833   if (NULL == host)
 834   {
 835     host = GNUNET_TESTBED_host_create_by_id_ (0);
 836     if (NULL == host)
 837     {
 838       LOG (GNUNET_ERROR_TYPE_WARNING,
 839            "Treating NULL host as localhost. Multiple references to localhost. "
 840            " May break when localhost freed before calling disconnect \n");
 841       host = GNUNET_TESTBED_host_lookup_by_id_ (0);
 842     }
 843     else
 844     {
 845       controller->aux_host = GNUNET_YES;
 846     }
 847   }
 848   GNUNET_assert (NULL != host);
 849   msg = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_InitMessage));
 850   msg->header.type = htons (GNUNET_MESSAGE_TYPE_TESTBED_INIT);
 851   msg->header.size = htons (sizeof (struct GNUNET_TESTBED_InitMessage));
 852   msg->host_id = htonl (GNUNET_TESTBED_host_get_id_ (host));
 853   msg->event_mask = GNUNET_htonll (controller->event_mask);
 854   GNUNET_TESTBED_queue_message_ (controller, (struct GNUNET_MessageHeader *) msg);
 855   return controller;
 856 }
 857
 858
 859 /**
 860  * Configure shared services at a controller.  Using this function,
 861  * you can specify that certain services (such as "resolver")
 862  * should not be run for each peer but instead be shared
 863  * across N peers on the specified host.  This function
 864  * must be called before any peers are created at the host.
 865  *
 866  * @param controller controller to configure
 867  * @param service_name name of the service to share
 868  * @param num_peers number of peers that should share one instance
 869  *        of the specified service (1 for no sharing is the default),
 870  *        use 0 to disable the service
 871  */
 872 void
 873 GNUNET_TESTBED_controller_configure_sharing (struct GNUNET_TESTBED_Controller *controller,
 874                                              const char *service_name,
 875                                              uint32_t num_peers)
 876 {
 877   struct GNUNET_TESTBED_ConfigureSharedServiceMessage *msg;
 878   uint16_t service_name_size;
 879   uint16_t msg_size;
 880
 881   service_name_size = strlen (service_name) + 1;
 882   msg_size = sizeof (struct GNUNET_TESTBED_ConfigureSharedServiceMessage)
 883     + service_name_size;
 884   msg = GNUNET_malloc (msg_size);
 885   msg->header.size = htons (msg_size);
 886   msg->header.type = htons (GNUNET_MESSAGE_TYPE_TESTBED_SERVICESHARE);
 887   msg->host_id = htonl (GNUNET_TESTBED_host_get_id_ (controller->host));
 888   msg->num_peers = htonl (num_peers);
 889   memcpy (&msg[1], service_name, service_name_size);
 890   GNUNET_TESTBED_queue_message_ (controller, (struct GNUNET_MessageHeader *) msg);
 891 }
 892
 893
 894 /**
 895  * disconnects from the controller.
 896  *
 897  * @param controller handle to controller to stop
 898  */
 899 void
 900 GNUNET_TESTBED_controller_disconnect (struct GNUNET_TESTBED_Controller *controller)
 901 {
 902   struct MessageQueue *mq_entry;
 903
 904   if (NULL != controller->th)
 905     GNUNET_CLIENT_notify_transmit_ready_cancel (controller->th);
 906  /* Clear the message queue */
 907   while (NULL != (mq_entry = controller->mq_head))
 908   {
 909     GNUNET_CONTAINER_DLL_remove (controller->mq_head,
 910                                  controller->mq_tail,
 911                                  mq_entry);
 912     GNUNET_free (mq_entry->msg);
 913     GNUNET_free (mq_entry);
 914   }
 915   if (NULL != controller->client)
 916     GNUNET_CLIENT_disconnect (controller->client);
 917   GNUNET_CONFIGURATION_destroy (controller->cfg);
 918   if (GNUNET_YES == controller->aux_host)
 919     GNUNET_TESTBED_host_destroy (controller->host);
 920   GNUNET_free (controller);
 921 }
 922
 923
 924 /**
 925  * Register a host with the controller
 926  *
 927  * @param controller the controller handle
 928  * @param host the host to register
 929  * @param cc the completion callback to call to inform the status of
 930  *          registration. After calling this callback the registration handle
 931  *          will be invalid. Cannot be NULL.
 932  * @param cc_cls the closure for the cc
 933  * @return handle to the host registration which can be used to cancel the
 934  *           registration
 935  */
 936 struct GNUNET_TESTBED_HostRegistrationHandle *
 937 GNUNET_TESTBED_register_host (struct GNUNET_TESTBED_Controller *controller,
 938                               struct GNUNET_TESTBED_Host *host,
 939                               GNUNET_TESTBED_HostRegistrationCompletion cc,
 940                               void *cc_cls)
 941 {
 942   struct GNUNET_TESTBED_HostRegistrationHandle *rh;
 943   struct GNUNET_TESTBED_AddHostMessage *msg;
 944   const char *username;
 945   const char *hostname;
 946   uint16_t msg_size;
 947   uint16_t user_name_length;
 948
 949   if (NULL != controller->rh)
 950     return NULL;
 951   hostname = GNUNET_TESTBED_host_get_hostname_ (host);
 952   if (GNUNET_YES == GNUNET_TESTBED_is_host_registered_ (host, controller))
 953   {
 954     LOG (GNUNET_ERROR_TYPE_WARNING,
 955          "Host hostname: %s already registered\n",
 956          (NULL == hostname) ? "localhost" : hostname);
 957     return NULL;
 958   }
 959   rh = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_HostRegistrationHandle));
 960   rh->host = host;
 961   rh->c = controller;
 962   GNUNET_assert (NULL != cc);
 963   rh->cc = cc;
 964   rh->cc_cls = cc_cls;
 965   controller->rh = rh;
 966   username = GNUNET_TESTBED_host_get_username_ (host);
 967   msg_size = (sizeof (struct GNUNET_TESTBED_AddHostMessage));
 968   user_name_length = 0;
 969   if (NULL != username)
 970   {
 971     user_name_length = strlen (username) + 1;
 972     msg_size += user_name_length;
 973   }
 974   /* FIXME: what happens when hostname is NULL? localhost */
 975   GNUNET_assert (NULL != hostname);
 976   msg_size += strlen (hostname) + 1;
 977   msg = GNUNET_malloc (msg_size);
 978   msg->header.size = htons (msg_size);
 979   msg->header.type = htons (GNUNET_MESSAGE_TYPE_TESTBED_ADDHOST);
 980   msg->host_id = htonl (GNUNET_TESTBED_host_get_id_ (host));
 981   msg->ssh_port = htons (GNUNET_TESTBED_host_get_ssh_port_ (host));
 982   msg->user_name_length = htons (user_name_length);
 983   if (NULL != username)
 984     memcpy (&msg[1], username, user_name_length);
 985   strcpy (((void *) &msg[1]) + user_name_length, hostname);
 986   GNUNET_TESTBED_queue_message_ (controller, (struct GNUNET_MessageHeader *) msg);
 987   return rh;
 988 }
 989
 990
 991 /**
 992  * Cancel the pending registration. Note that if the registration message is
 993  * already sent to the service the cancellation has only the effect that the
 994  * registration completion callback for the registration is never called.
 995  *
 996  * @param handle the registration handle to cancel
 997  */
 998 void
 999 GNUNET_TESTBED_cancel_registration (struct GNUNET_TESTBED_HostRegistrationHandle
1000                                     *handle)
1001 {
1002   if (handle != handle->c->rh)
1003   {
1004     GNUNET_break (0);
1005     return;
1006   }
1007   handle->c->rh = NULL;
1008   GNUNET_free (handle);
1009 }
1010
1011
1012 /**
1013  * Same as the GNUNET_TESTBED_controller_link, however expects configuration in
1014  * serialized and compressed
1015  *
1016  * @param master handle to the master controller who creates the association
1017  * @param delegated_host requests to which host should be delegated; cannot be NULL
1018  * @param slave_host which host is used to run the slave controller; use NULL to
1019  *          make the master controller connect to the delegated host
1020  * @param sxcfg serialized and compressed configuration
1021  * @param sxcfg_size the size scfg
1022  * @param scfg_size the size of uncompressed serialized configuration
1023  * @param is_subordinate GNUNET_YES if the controller at delegated_host should
1024  *          be started by the master controller; GNUNET_NO if we are just
1025  *          allowed to use the slave via TCP/IP
1026  */
1027 void
1028 GNUNET_TESTBED_controller_link_2 (struct GNUNET_TESTBED_Controller *master,
1029                                   struct GNUNET_TESTBED_Host *delegated_host,
1030                                   struct GNUNET_TESTBED_Host *slave_host,
1031                                   const char *sxcfg,
1032                                   size_t sxcfg_size,
1033                                   size_t scfg_size,
1034                                   int is_subordinate)
1035 {
1036   struct GNUNET_TESTBED_ControllerLinkMessage *msg;
1037   uint16_t msg_size;
1038
1039   GNUNET_assert (GNUNET_YES ==
1040                  GNUNET_TESTBED_is_host_registered_ (delegated_host, master));
1041   if ((NULL != slave_host) && (0 != GNUNET_TESTBED_host_get_id_ (slave_host)))
1042     GNUNET_assert (GNUNET_YES ==
1043                    GNUNET_TESTBED_is_host_registered_ (slave_host, master));
1044   msg_size = sxcfg_size + sizeof (struct GNUNET_TESTBED_ControllerLinkMessage);
1045   msg = GNUNET_malloc (msg_size);
1046   msg->header.type = htons (GNUNET_MESSAGE_TYPE_TESTBED_LCONTROLLERS);
1047   msg->header.size = htons (msg_size);
1048   msg->delegated_host_id = htonl (GNUNET_TESTBED_host_get_id_ (delegated_host));
1049   msg->slave_host_id = htonl (GNUNET_TESTBED_host_get_id_
1050                               ((NULL != slave_host) ? slave_host : master->host));
1051   msg->config_size = htons ((uint16_t) scfg_size);
1052   msg->is_subordinate = (GNUNET_YES == is_subordinate) ? 1 : 0;
1053   memcpy (&msg[1], sxcfg, sxcfg_size);
1054   GNUNET_TESTBED_queue_message_ (master, (struct GNUNET_MessageHeader *) msg);
1055 }
1056
1057
1058 /**
1059  * Compresses given configuration using zlib compress
1060  *
1061  * @param config the serialized configuration
1062  * @param size the size of config
1063  * @param xconfig will be set to the compressed configuration (memory is fresly
1064  *          allocated)
1065  * @return the size of the xconfig
1066  */
1067 size_t
1068 GNUNET_TESTBED_compress_config_ (const char *config, size_t size,
1069                                  char **xconfig)
1070 {
1071   size_t xsize;
1072
1073   xsize = compressBound ((uLong) size);
1074   *xconfig = GNUNET_malloc (xsize);
1075   GNUNET_assert (Z_OK ==
1076                  compress2 ((Bytef *)* xconfig, (uLongf *) &xsize,
1077                             (const Bytef *) config, (uLongf) size,
1078                             Z_BEST_SPEED));
1079   return xsize;
1080 }
1081
1082
1083 /**
1084  * Create a link from slave controller to delegated controller. Whenever the
1085  * master controller is asked to start a peer at the delegated controller the
1086  * request will be routed towards slave controller (if a route exists). The
1087  * slave controller will then route it to the delegated controller. The
1088  * configuration of the slave controller is given and to be used to either
1089  * create the slave controller or to connect to an existing slave controller
1090  * process.  'is_subordinate' specifies if the given slave controller should be
1091  * started and managed by the master controller, or if the slave already has a
1092  * master and this is just a secondary master that is also allowed to use the
1093  * existing slave.
1094  *
1095  * @param master handle to the master controller who creates the association
1096  * @param delegated_host requests to which host should be delegated
1097  * @param slave_host which host is used to run the slave controller
1098  * @param slave_cfg configuration to use for the slave controller
1099  * @param is_subordinate GNUNET_YES if the slave should be started (and stopped)
1100  *                       by the master controller; GNUNET_NO if we are just
1101  *                       allowed to use the slave via TCP/IP
1102  */
1103 void
1104 GNUNET_TESTBED_controller_link (struct GNUNET_TESTBED_Controller *master,
1105                                 struct GNUNET_TESTBED_Host *delegated_host,
1106                                 struct GNUNET_TESTBED_Host *slave_host,
1107                                 const struct GNUNET_CONFIGURATION_Handle *slave_cfg,
1108                                 int is_subordinate)
1109 {
1110   char *config;
1111   char *cconfig;
1112   size_t cc_size;
1113   size_t config_size;
1114
1115   GNUNET_assert (GNUNET_YES ==
1116                  GNUNET_TESTBED_is_host_registered_ (delegated_host, master));
1117   if ((NULL != slave_host) && (0 != GNUNET_TESTBED_host_get_id_ (slave_host)))
1118     GNUNET_assert (GNUNET_YES ==
1119                    GNUNET_TESTBED_is_host_registered_ (slave_host, master));
1120   config = GNUNET_CONFIGURATION_serialize (slave_cfg, &config_size);
1121   cc_size = GNUNET_TESTBED_compress_config_ (config, config_size, &cconfig);
1122   GNUNET_free (config);
1123   GNUNET_assert ((UINT16_MAX -
1124                   sizeof (struct GNUNET_TESTBED_ControllerLinkMessage))
1125                   >= cc_size); /* Configuration doesn't fit in 1 message */
1126   GNUNET_TESTBED_controller_link_2 (master, delegated_host, slave_host,
1127                                     (const char *) cconfig,
1128                                     cc_size, config_size, is_subordinate);
1129   GNUNET_free (cconfig);
1130 }
1131
1132
1133 /**
1134  * Ask the testbed controller to write the current overlay topology to
1135  * a file.  Naturally, the file will only contain a snapshot as the
1136  * topology may evolve all the time.
1137  *
1138  * @param controller overlay controller to inspect
1139  * @param filename name of the file the topology should
1140  *        be written to.
1141  */
1142 void
1143 GNUNET_TESTBED_overlay_write_topology_to_file (struct GNUNET_TESTBED_Controller *controller,
1144                                                const char *filename)
1145 {
1146   GNUNET_break (0);
1147 }
1148
1149
1150 /**
1151  * Creates a helper initialization message. Only for testing.
1152  *
1153  * @param cname the ip address of the controlling host
1154  * @param cfg the configuration that has to used to start the testbed service
1155  *          thru helper
1156  * @return the initialization message
1157  */
1158 struct GNUNET_TESTBED_HelperInit *
1159 GNUNET_TESTBED_create_helper_init_msg_ (const char *cname,
1160                                          const struct GNUNET_CONFIGURATION_Handle *cfg)
1161 {
1162   struct GNUNET_TESTBED_HelperInit *msg;
1163   char *config;
1164   char *xconfig;
1165   size_t config_size;
1166   size_t xconfig_size;
1167   uint16_t cname_len;
1168   uint16_t msg_size;
1169
1170   config = GNUNET_CONFIGURATION_serialize (cfg, &config_size);
1171   GNUNET_assert (NULL != config);
1172   xconfig_size =
1173     GNUNET_TESTBED_compress_config_ (config, config_size, &xconfig);
1174   GNUNET_free (config);
1175   cname_len = strlen (cname);
1176   msg_size = xconfig_size + cname_len + 1 +
1177     sizeof (struct GNUNET_TESTBED_HelperInit);
1178   msg = GNUNET_realloc (xconfig, msg_size);
1179   (void) memmove ( ((void *) &msg[1]) + cname_len + 1, msg, xconfig_size);
1180   msg->header.size = htons (msg_size);
1181   msg->header.type = htons (GNUNET_MESSAGE_TYPE_TESTBED_HELPER_INIT);
1182   msg->cname_size = htons (cname_len);
1183   msg->config_size = htons (config_size);
1184   (void) strcpy ((char *) &msg[1], cname);
1185   return msg;
1186 }
1187
1188
1189 /* end of testbed_api.c */