src/testbed/testbed_api.c

   1 /*
   2       This file is part of GNUnet
   3       Copyright (C) 2008--2013 GNUnet e.V.
   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., 51 Franklin Street, Fifth Floor,
  18       Boston, MA 02110-1301, 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 #include "platform.h"
  30 #include "gnunet_testbed_service.h"
  31 #include "gnunet_core_service.h"
  32 #include "gnunet_constants.h"
  33 #include "gnunet_transport_service.h"
  34 #include "gnunet_hello_lib.h"
  35 #include <zlib.h>
  36
  37 #include "testbed.h"
  38 #include "testbed_api.h"
  39 #include "testbed_api_hosts.h"
  40 #include "testbed_api_peers.h"
  41 #include "testbed_api_operations.h"
  42 #include "testbed_api_sd.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  * Context data for forwarded Operation
  71  */
  72 struct ForwardedOperationData
  73 {
  74
  75   /**
  76    * The callback to call when reply is available
  77    */
  78   GNUNET_CLIENT_MessageHandler cc;
  79
  80   /**
  81    * The closure for the above callback
  82    */
  83   void *cc_cls;
  84
  85 };
  86
  87
  88 /**
  89  * Context data for get slave config operations
  90  */
  91 struct GetSlaveConfigData
  92 {
  93   /**
  94    * The id of the slave controller
  95    */
  96   uint32_t slave_id;
  97
  98 };
  99
 100
 101 /**
 102  * Context data for controller link operations
 103  */
 104 struct ControllerLinkData
 105 {
 106   /**
 107    * The controller link message
 108    */
 109   struct GNUNET_TESTBED_ControllerLinkRequest *msg;
 110
 111   /**
 112    * The id of the host which is hosting the controller to be linked
 113    */
 114   uint32_t host_id;
 115
 116 };
 117
 118
 119 /**
 120  * Date context for OP_SHUTDOWN_PEERS operations
 121  */
 122 struct ShutdownPeersData
 123 {
 124   /**
 125    * The operation completion callback to call
 126    */
 127   GNUNET_TESTBED_OperationCompletionCallback cb;
 128
 129   /**
 130    * The closure for the above callback
 131    */
 132   void *cb_cls;
 133 };
 134
 135
 136 /**
 137  * An entry in the stack for keeping operations which are about to expire
 138  */
 139 struct ExpireOperationEntry
 140 {
 141   /**
 142    * DLL head; new entries are to be inserted here
 143    */
 144   struct ExpireOperationEntry *next;
 145
 146   /**
 147    * DLL tail; entries are deleted from here
 148    */
 149   struct ExpireOperationEntry *prev;
 150
 151   /**
 152    * The operation.  This will be a dangling pointer when the operation is freed
 153    */
 154   const struct GNUNET_TESTBED_Operation *op;
 155 };
 156
 157
 158 /**
 159  * DLL head for list of operations marked for expiry
 160  */
 161 static struct ExpireOperationEntry *exop_head;
 162
 163 /**
 164  * DLL tail for list of operation marked for expiry
 165  */
 166 static struct ExpireOperationEntry *exop_tail;
 167
 168
 169 /**
 170  * Inserts an operation into the list of operations marked for expiry
 171  *
 172  * @param op the operation to insert
 173  */
 174 static void
 175 exop_insert (struct GNUNET_TESTBED_Operation *op)
 176 {
 177   struct ExpireOperationEntry *entry;
 178
 179   entry = GNUNET_new (struct ExpireOperationEntry);
 180   entry->op = op;
 181   GNUNET_CONTAINER_DLL_insert_tail (exop_head, exop_tail, entry);
 182 }
 183
 184
 185 /**
 186  * Checks if an operation is present in the list of operations marked for
 187  * expiry.  If the operation is found, it and the tail of operations after it
 188  * are removed from the list.
 189  *
 190  * @param op the operation to check
 191  * @return GNUNET_NO if the operation is not present in the list; GNUNET_YES if
 192  *           the operation is found in the list (the operation is then removed
 193  *           from the list -- calling this function again with the same
 194  *           paramenter will return GNUNET_NO)
 195  */
 196 static int
 197 exop_check (const struct GNUNET_TESTBED_Operation *const op)
 198 {
 199   struct ExpireOperationEntry *entry;
 200   struct ExpireOperationEntry *entry2;
 201   int found;
 202
 203   found = GNUNET_NO;
 204   entry = exop_head;
 205   while (NULL != entry)
 206   {
 207     if (op == entry->op)
 208     {
 209       found = GNUNET_YES;
 210       break;
 211     }
 212     entry = entry->next;
 213   }
 214   if (GNUNET_NO == found)
 215     return GNUNET_NO;
 216   /* Truncate the tail */
 217   while (NULL != entry)
 218   {
 219     entry2 = entry->next;
 220     GNUNET_CONTAINER_DLL_remove (exop_head,
 221                                  exop_tail,
 222                                  entry);
 223     GNUNET_free (entry);
 224     entry = entry2;
 225   }
 226   return GNUNET_YES;
 227 }
 228
 229
 230 /**
 231  * Context information to be used while searching for operation contexts
 232  */
 233 struct SearchContext
 234 {
 235   /**
 236    * The result of the search
 237    */
 238   struct OperationContext *opc;
 239
 240   /**
 241    * The id of the operation context we are searching for
 242    */
 243   uint64_t id;
 244 };
 245
 246
 247 /**
 248  * Search iterator for searching an operation context
 249  *
 250  * @param cls the serach context
 251  * @param key current key code
 252  * @param value value in the hash map
 253  * @return #GNUNET_YES if we should continue to iterate,
 254  *         #GNUNET_NO if not.
 255  */
 256 static int
 257 opc_search_iterator (void *cls,
 258                      uint32_t key,
 259                      void *value)
 260 {
 261   struct SearchContext *sc = cls;
 262   struct OperationContext *opc = value;
 263
 264   GNUNET_assert (NULL != opc);
 265   GNUNET_assert (NULL == sc->opc);
 266   if (opc->id != sc->id)
 267     return GNUNET_YES;
 268   sc->opc = opc;
 269   return GNUNET_NO;
 270 }
 271
 272
 273 /**
 274  * Returns the operation context with the given id if found in the Operation
 275  * context queues of the controller
 276  *
 277  * @param c the controller whose operation context map is searched
 278  * @param id the id which has to be checked
 279  * @return the matching operation context; NULL if no match found
 280  */
 281 static struct OperationContext *
 282 find_opc (const struct GNUNET_TESTBED_Controller *c, const uint64_t id)
 283 {
 284   struct SearchContext sc;
 285
 286   sc.id = id;
 287   sc.opc = NULL;
 288   GNUNET_assert (NULL != c->opc_map);
 289   if (GNUNET_SYSERR !=
 290       GNUNET_CONTAINER_multihashmap32_get_multiple (c->opc_map, (uint32_t) id,
 291                                                     &opc_search_iterator, &sc))
 292     return NULL;
 293   return sc.opc;
 294 }
 295
 296
 297 /**
 298  * Inserts the given operation context into the operation context map of the
 299  * given controller.  Creates the operation context map if one does not exist
 300  * for the controller
 301  *
 302  * @param c the controller
 303  * @param opc the operation context to be inserted
 304  */
 305 void
 306 GNUNET_TESTBED_insert_opc_ (struct GNUNET_TESTBED_Controller *c,
 307                             struct OperationContext *opc)
 308 {
 309   if (NULL == c->opc_map)
 310     c->opc_map = GNUNET_CONTAINER_multihashmap32_create (256);
 311   GNUNET_assert (GNUNET_OK ==
 312                  GNUNET_CONTAINER_multihashmap32_put (c->opc_map,
 313                                                       (uint32_t) opc->id, opc,
 314                                                       GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE));
 315 }
 316
 317
 318 /**
 319  * Removes the given operation context from the operation context map of the
 320  * given controller
 321  *
 322  * @param c the controller
 323  * @param opc the operation context to remove
 324  */
 325 void
 326 GNUNET_TESTBED_remove_opc_ (const struct GNUNET_TESTBED_Controller *c,
 327                             struct OperationContext *opc)
 328 {
 329   GNUNET_assert (NULL != c->opc_map);
 330   GNUNET_assert (GNUNET_YES ==
 331                  GNUNET_CONTAINER_multihashmap32_remove (c->opc_map,
 332                                                          (uint32_t) opc->id,
 333                                                          opc));
 334   if ( (0 == GNUNET_CONTAINER_multihashmap32_size (c->opc_map))
 335        && (NULL != c->opcq_empty_cb) )
 336     c->opcq_empty_cb (c->opcq_empty_cls);
 337 }
 338
 339
 340
 341 /**
 342  * Check #GNUNET_MESSAGE_TYPE_TESTBED_ADDHOSTCONFIRM message is well-formed.
 343  *
 344  * @param cls the controller handler
 345  * @param msg message received
 346  * @return #GNUNET_OK if message is well-formed
 347  */
 348 static int
 349 check_add_host_confirm (void *cls,
 350                         const struct GNUNET_TESTBED_HostConfirmedMessage *msg)
 351 {
 352   const char *emsg;
 353   uint16_t msg_size;
 354
 355   msg_size = ntohs (msg->header.size) - sizeof (*msg);
 356   if (0 == msg_size)
 357     return GNUNET_OK;
 358   /* We have an error message */
 359   emsg = (const char *) &msg[1];
 360   if ('\0' != emsg[msg_size - 1])
 361   {
 362     GNUNET_break (0);
 363     return GNUNET_SYSERR;
 364   }
 365   return GNUNET_OK;
 366 }
 367
 368
 369 /**
 370  * Handler for #GNUNET_MESSAGE_TYPE_TESTBED_ADDHOSTCONFIRM message from
 371  * controller (testbed service)
 372  *
 373  * @param cls the controller handler
 374  * @param msg message received
 375  */
 376 static void
 377 handle_add_host_confirm (void *cls,
 378                          const struct GNUNET_TESTBED_HostConfirmedMessage *msg)
 379 {
 380   struct GNUNET_TESTBED_Controller *c = cls;
 381   struct GNUNET_TESTBED_HostRegistrationHandle *rh = c->rh;
 382   const char *emsg;
 383   uint16_t msg_size;
 384
 385   if (NULL == rh)
 386     return;
 387   if (GNUNET_TESTBED_host_get_id_ (rh->host) != ntohl (msg->host_id))
 388   {
 389     LOG_DEBUG ("Mismatch in host id's %u, %u of host confirm msg\n",
 390                GNUNET_TESTBED_host_get_id_ (rh->host),
 391                ntohl (msg->host_id));
 392     return;
 393   }
 394   c->rh = NULL;
 395   msg_size = ntohs (msg->header.size) - sizeof (*msg);
 396   if (0 == msg_size)
 397   {
 398     LOG_DEBUG ("Host %u successfully registered\n",
 399                ntohl (msg->host_id));
 400     GNUNET_TESTBED_mark_host_registered_at_ (rh->host,
 401                                              c);
 402     rh->cc (rh->cc_cls,
 403             NULL);
 404     GNUNET_free (rh);
 405     return;
 406   }
 407   /* We have an error message */
 408   emsg = (const char *) &msg[1];
 409   LOG (GNUNET_ERROR_TYPE_ERROR,
 410        _("Adding host %u failed with error: %s\n"),
 411        ntohl (msg->host_id),
 412        emsg);
 413   rh->cc (rh->cc_cls,
 414           emsg);
 415   GNUNET_free (rh);
 416 }
 417
 418
 419 /**
 420  * Handler for forwarded operations
 421  *
 422  * @param c the controller handle
 423  * @param opc the opearation context
 424  * @param msg the message
 425  */
 426 static void
 427 handle_forwarded_operation_msg (void *cls,
 428                                 struct OperationContext *opc,
 429                                 const struct GNUNET_MessageHeader *msg)
 430 {
 431   struct GNUNET_TESTBED_Controller *c = cls;
 432   struct ForwardedOperationData *fo_data;
 433
 434   fo_data = opc->data;
 435   if (NULL != fo_data->cc)
 436     fo_data->cc (fo_data->cc_cls, msg);
 437   GNUNET_TESTBED_remove_opc_ (c, opc);
 438   GNUNET_free (fo_data);
 439   GNUNET_free (opc);
 440 }
 441
 442
 443 /**
 444  * Handler for #GNUNET_MESSAGE_TYPE_TESTBED_ADD_HOST_SUCCESS message from
 445  * controller (testbed service)
 446  *
 447  * @param c the controller handler
 448  * @param msg message received
 449  */
 450 static void
 451 handle_opsuccess (void *cls,
 452                   const struct GNUNET_TESTBED_GenericOperationSuccessEventMessage *msg)
 453 {
 454   struct GNUNET_TESTBED_Controller *c = cls;
 455   struct OperationContext *opc;
 456   GNUNET_TESTBED_OperationCompletionCallback op_comp_cb;
 457   void *op_comp_cb_cls;
 458   struct GNUNET_TESTBED_EventInformation event;
 459   uint64_t op_id;
 460
 461   op_id = GNUNET_ntohll (msg->operation_id);
 462   LOG_DEBUG ("Operation %lu successful\n", op_id);
 463   if (NULL == (opc = find_opc (c, op_id)))
 464   {
 465     LOG_DEBUG ("Operation not found\n");
 466     return;
 467   }
 468   event.type = GNUNET_TESTBED_ET_OPERATION_FINISHED;
 469   event.op = opc->op;
 470   event.op_cls = opc->op_cls;
 471   event.details.operation_finished.emsg = NULL;
 472   event.details.operation_finished.generic = NULL;
 473   op_comp_cb = NULL;
 474   op_comp_cb_cls = NULL;
 475   switch (opc->type)
 476   {
 477   case OP_FORWARDED:
 478     {
 479       handle_forwarded_operation_msg (c, opc,
 480                                       (const struct GNUNET_MessageHeader *) msg);
 481       return;
 482     }
 483     break;
 484   case OP_PEER_DESTROY:
 485   {
 486     struct GNUNET_TESTBED_Peer *peer;
 487
 488     peer = opc->data;
 489     GNUNET_TESTBED_peer_deregister_ (peer);
 490     GNUNET_free (peer);
 491     opc->data = NULL;
 492     //PEERDESTROYDATA
 493   }
 494     break;
 495   case OP_SHUTDOWN_PEERS:
 496   {
 497     struct ShutdownPeersData *data;
 498
 499     data = opc->data;
 500     op_comp_cb = data->cb;
 501     op_comp_cb_cls = data->cb_cls;
 502     GNUNET_free (data);
 503     opc->data = NULL;
 504     GNUNET_TESTBED_cleanup_peers_ ();
 505   }
 506     break;
 507   case OP_MANAGE_SERVICE:
 508   {
 509     struct ManageServiceData *data;
 510
 511     GNUNET_assert (NULL != (data = opc->data));
 512     op_comp_cb = data->cb;
 513     op_comp_cb_cls = data->cb_cls;
 514     GNUNET_free (data);
 515     opc->data = NULL;
 516   }
 517     break;
 518   case OP_PEER_RECONFIGURE:
 519     break;
 520   default:
 521     GNUNET_assert (0);
 522   }
 523   GNUNET_TESTBED_remove_opc_ (opc->c, opc);
 524   opc->state = OPC_STATE_FINISHED;
 525   exop_insert (event.op);
 526   if (0 != (c->event_mask & (1L << GNUNET_TESTBED_ET_OPERATION_FINISHED)))
 527   {
 528     if (NULL != c->cc)
 529       c->cc (c->cc_cls, &event);
 530     if (GNUNET_NO == exop_check (event.op))
 531       return;
 532   }
 533   else
 534     LOG_DEBUG ("Not calling callback\n");
 535   if (NULL != op_comp_cb)
 536     op_comp_cb (op_comp_cb_cls, event.op, NULL);
 537    /* You could have marked the operation as done by now */
 538   GNUNET_break (GNUNET_NO == exop_check (event.op));
 539 }
 540
 541
 542 /**
 543  * Handler for #GNUNET_MESSAGE_TYPE_TESTBED_CREATE_PEER_SUCCESS message from
 544  * controller (testbed service)
 545  *
 546  * @param c the controller handle
 547  * @param msg message received
 548  */
 549 static void
 550 handle_peer_create_success (void *cls,
 551                             const struct GNUNET_TESTBED_PeerCreateSuccessEventMessage *msg)
 552 {
 553   struct GNUNET_TESTBED_Controller *c = cls;
 554   struct OperationContext *opc;
 555   struct PeerCreateData *data;
 556   struct GNUNET_TESTBED_Peer *peer;
 557   struct GNUNET_TESTBED_Operation *op;
 558   GNUNET_TESTBED_PeerCreateCallback cb;
 559   void *cb_cls;
 560   uint64_t op_id;
 561
 562   GNUNET_assert (sizeof (struct GNUNET_TESTBED_PeerCreateSuccessEventMessage) ==
 563                  ntohs (msg->header.size));
 564   op_id = GNUNET_ntohll (msg->operation_id);
 565   if (NULL == (opc = find_opc (c, op_id)))
 566   {
 567     LOG_DEBUG ("Operation context for PeerCreateSuccessEvent not found\n");
 568     return;
 569   }
 570   if (OP_FORWARDED == opc->type)
 571   {
 572     handle_forwarded_operation_msg (c, opc,
 573                                     (const struct GNUNET_MessageHeader *) msg);
 574     return;
 575   }
 576   GNUNET_assert (OP_PEER_CREATE == opc->type);
 577   GNUNET_assert (NULL != opc->data);
 578   data = opc->data;
 579   GNUNET_assert (NULL != data->peer);
 580   peer = data->peer;
 581   GNUNET_assert (peer->unique_id == ntohl (msg->peer_id));
 582   peer->state = TESTBED_PS_CREATED;
 583   GNUNET_TESTBED_peer_register_ (peer);
 584   cb = data->cb;
 585   cb_cls = data->cls;
 586   op = opc->op;
 587   GNUNET_free (opc->data);
 588   GNUNET_TESTBED_remove_opc_ (opc->c, opc);
 589   opc->state = OPC_STATE_FINISHED;
 590   exop_insert (op);
 591   if (NULL != cb)
 592     cb (cb_cls, peer, NULL);
 593    /* You could have marked the operation as done by now */
 594   GNUNET_break (GNUNET_NO == exop_check (op));
 595 }
 596
 597
 598 /**
 599  * Handler for #GNUNET_MESSAGE_TYPE_TESTBED_PEER_EVENT message from
 600  * controller (testbed service)
 601  *
 602  * @param c the controller handler
 603  * @param msg message received
 604  */
 605 static void
 606 handle_peer_event (void *cls,
 607                    const struct GNUNET_TESTBED_PeerEventMessage *msg)
 608 {
 609   struct GNUNET_TESTBED_Controller *c = cls;
 610   struct OperationContext *opc;
 611   struct GNUNET_TESTBED_Peer *peer;
 612   struct PeerEventData *data;
 613   GNUNET_TESTBED_PeerChurnCallback pcc;
 614   void *pcc_cls;
 615   struct GNUNET_TESTBED_EventInformation event;
 616   uint64_t op_id;
 617   uint64_t mask;
 618
 619   GNUNET_assert (sizeof (struct GNUNET_TESTBED_PeerEventMessage) ==
 620                  ntohs (msg->header.size));
 621   op_id = GNUNET_ntohll (msg->operation_id);
 622   if (NULL == (opc = find_opc (c, op_id)))
 623   {
 624     LOG_DEBUG ("Operation not found\n");
 625     return;
 626   }
 627   if (OP_FORWARDED == opc->type)
 628   {
 629     handle_forwarded_operation_msg (c, opc,
 630                                     (const struct GNUNET_MessageHeader *) msg);
 631     return;
 632   }
 633   GNUNET_assert ((OP_PEER_START == opc->type) || (OP_PEER_STOP == opc->type));
 634   data = opc->data;
 635   GNUNET_assert (NULL != data);
 636   peer = data->peer;
 637   GNUNET_assert (NULL != peer);
 638   event.type = (enum GNUNET_TESTBED_EventType) ntohl (msg->event_type);
 639   event.op = opc->op;
 640   event.op_cls = opc->op_cls;
 641   switch (event.type)
 642   {
 643   case GNUNET_TESTBED_ET_PEER_START:
 644     peer->state = TESTBED_PS_STARTED;
 645     event.details.peer_start.host = peer->host;
 646     event.details.peer_start.peer = peer;
 647     break;
 648   case GNUNET_TESTBED_ET_PEER_STOP:
 649     peer->state = TESTBED_PS_STOPPED;
 650     event.details.peer_stop.peer = peer;
 651     break;
 652   default:
 653     GNUNET_assert (0);          /* We should never reach this state */
 654   }
 655   pcc = data->pcc;
 656   pcc_cls = data->pcc_cls;
 657   GNUNET_free (data);
 658   GNUNET_TESTBED_remove_opc_ (opc->c, opc);
 659   opc->state = OPC_STATE_FINISHED;
 660   exop_insert (event.op);
 661   mask = 1LL << GNUNET_TESTBED_ET_PEER_START;
 662   mask |= 1LL << GNUNET_TESTBED_ET_PEER_STOP;
 663   if (0 != (mask & c->event_mask))
 664   {
 665     if (NULL != c->cc)
 666       c->cc (c->cc_cls, &event);
 667     if (GNUNET_NO == exop_check (event.op))
 668       return;
 669   }
 670   if (NULL != pcc)
 671     pcc (pcc_cls, NULL);
 672    /* You could have marked the operation as done by now */
 673   GNUNET_break (GNUNET_NO == exop_check (event.op));
 674 }
 675
 676
 677 /**
 678  * Handler for #GNUNET_MESSAGE_TYPE_TESTBED_PEER_CONNECT_EVENT message from
 679  * controller (testbed service)
 680  *
 681  * @param c the controller handler
 682  * @param msg message received
 683  */
 684 static void
 685 handle_peer_conevent (void *cls,
 686                       const struct GNUNET_TESTBED_ConnectionEventMessage *msg)
 687 {
 688   struct GNUNET_TESTBED_Controller *c = cls;
 689   struct OperationContext *opc;
 690   struct OverlayConnectData *data;
 691   GNUNET_TESTBED_OperationCompletionCallback cb;
 692   void *cb_cls;
 693   struct GNUNET_TESTBED_EventInformation event;
 694   uint64_t op_id;
 695   uint64_t mask;
 696
 697   op_id = GNUNET_ntohll (msg->operation_id);
 698   if (NULL == (opc = find_opc (c, op_id)))
 699   {
 700     LOG_DEBUG ("Operation not found\n");
 701     return;
 702   }
 703   if (OP_FORWARDED == opc->type)
 704   {
 705     handle_forwarded_operation_msg (c, opc,
 706                                     (const struct GNUNET_MessageHeader *) msg);
 707     return;
 708   }
 709   GNUNET_assert (OP_OVERLAY_CONNECT == opc->type);
 710   GNUNET_assert (NULL != (data = opc->data));
 711   GNUNET_assert ((ntohl (msg->peer1) == data->p1->unique_id) &&
 712                  (ntohl (msg->peer2) == data->p2->unique_id));
 713   event.type = (enum GNUNET_TESTBED_EventType) ntohl (msg->event_type);
 714   event.op = opc->op;
 715   event.op_cls = opc->op_cls;
 716   switch (event.type)
 717   {
 718   case GNUNET_TESTBED_ET_CONNECT:
 719     event.details.peer_connect.peer1 = data->p1;
 720     event.details.peer_connect.peer2 = data->p2;
 721     break;
 722   case GNUNET_TESTBED_ET_DISCONNECT:
 723     GNUNET_assert (0);          /* FIXME: implement */
 724     break;
 725   default:
 726     GNUNET_assert (0);          /* Should never reach here */
 727     break;
 728   }
 729   cb = data->cb;
 730   cb_cls = data->cb_cls;
 731   GNUNET_TESTBED_remove_opc_ (opc->c, opc);
 732   opc->state = OPC_STATE_FINISHED;
 733   exop_insert (event.op);
 734   mask = 1LL << GNUNET_TESTBED_ET_CONNECT;
 735   mask |= 1LL << GNUNET_TESTBED_ET_DISCONNECT;
 736   if (0 != (mask & c->event_mask))
 737   {
 738     if (NULL != c->cc)
 739       c->cc (c->cc_cls, &event);
 740     if (GNUNET_NO == exop_check (event.op))
 741       return;
 742   }
 743   if (NULL != cb)
 744     cb (cb_cls, opc->op, NULL);
 745    /* You could have marked the operation as done by now */
 746   GNUNET_break (GNUNET_NO == exop_check (event.op));
 747 }
 748
 749
 750 /**
 751  * Validate #GNUNET_MESSAGE_TYPE_TESTBED_PEER_INFORMATION message from
 752  * controller (testbed service)
 753  *
 754  * @param c the controller handler
 755  * @param msg message received
 756  */
 757 static int
 758 check_peer_config (void *cls,
 759                    const struct GNUNET_TESTBED_PeerConfigurationInformationMessage *msg)
 760 {
 761   /* anything goes? */
 762   return GNUNET_OK;
 763 }
 764
 765
 766 /**
 767  * Handler for #GNUNET_MESSAGE_TYPE_TESTBED_PEER_INFORMATION message from
 768  * controller (testbed service)
 769  *
 770  * @param c the controller handler
 771  * @param msg message received
 772  */
 773 static void
 774 handle_peer_config (void *cls,
 775                     const struct GNUNET_TESTBED_PeerConfigurationInformationMessage *msg)
 776 {
 777   struct GNUNET_TESTBED_Controller *c = cls;
 778   struct OperationContext *opc;
 779   struct GNUNET_TESTBED_Peer *peer;
 780   struct PeerInfoData *data;
 781   struct GNUNET_TESTBED_PeerInformation *pinfo;
 782   GNUNET_TESTBED_PeerInfoCallback cb;
 783   void *cb_cls;
 784   uint64_t op_id;
 785
 786   op_id = GNUNET_ntohll (msg->operation_id);
 787   if (NULL == (opc = find_opc (c, op_id)))
 788   {
 789     LOG_DEBUG ("Operation not found\n");
 790     return;
 791   }
 792   if (OP_FORWARDED == opc->type)
 793   {
 794     handle_forwarded_operation_msg (c,
 795                                     opc,
 796                                     &msg->header);
 797     return;
 798   }
 799   data = opc->data;
 800   GNUNET_assert (NULL != data);
 801   peer = data->peer;
 802   GNUNET_assert (NULL != peer);
 803   GNUNET_assert (ntohl (msg->peer_id) == peer->unique_id);
 804   pinfo = GNUNET_new (struct GNUNET_TESTBED_PeerInformation);
 805   pinfo->pit = data->pit;
 806   cb = data->cb;
 807   cb_cls = data->cb_cls;
 808   GNUNET_assert (NULL != cb);
 809   GNUNET_free (data);
 810   opc->data = NULL;
 811   switch (pinfo->pit)
 812   {
 813   case GNUNET_TESTBED_PIT_IDENTITY:
 814     pinfo->result.id = GNUNET_new (struct GNUNET_PeerIdentity);
 815     (void) memcpy (pinfo->result.id,
 816                    &msg->peer_identity,
 817                    sizeof (struct GNUNET_PeerIdentity));
 818     break;
 819   case GNUNET_TESTBED_PIT_CONFIGURATION:
 820     pinfo->result.cfg =         /* Freed in oprelease_peer_getinfo */
 821         GNUNET_TESTBED_extract_config_ (&msg->header);
 822     break;
 823   case GNUNET_TESTBED_PIT_GENERIC:
 824     GNUNET_assert (0);          /* never reach here */
 825     break;
 826   }
 827   opc->data = pinfo;
 828   GNUNET_TESTBED_remove_opc_ (opc->c, opc);
 829   opc->state = OPC_STATE_FINISHED;
 830   cb (cb_cls, opc->op, pinfo, NULL);
 831   /* We dont check whether the operation is marked as done here as the
 832      operation contains data (cfg/identify) which will be freed at a later point
 833   */
 834 }
 835
 836
 837 /**
 838  * Validate #GNUNET_MESSAGE_TYPE_TESTBED_OPERATION_FAIL_EVENT message from
 839  * controller (testbed service)
 840  *
 841  * @param c the controller handler
 842  * @param msg message received
 843  * @return #GNUNET_OK if message is well-formed
 844  */
 845 static int
 846 check_op_fail_event (void *cls,
 847                      const struct GNUNET_TESTBED_OperationFailureEventMessage *msg)
 848 {
 849   /* we accept anything as a valid error message */
 850   return GNUNET_OK;
 851 }
 852
 853
 854 /**
 855  * Handler for #GNUNET_MESSAGE_TYPE_TESTBED_OPERATION_FAIL_EVENT message from
 856  * controller (testbed service)
 857  *
 858  * @param c the controller handler
 859  * @param msg message received
 860  */
 861 static void
 862 handle_op_fail_event (void *cls,
 863                       const struct GNUNET_TESTBED_OperationFailureEventMessage *msg)
 864 {
 865   struct GNUNET_TESTBED_Controller *c = cls;
 866   struct OperationContext *opc;
 867   const char *emsg;
 868   uint64_t op_id;
 869   uint64_t mask;
 870   struct GNUNET_TESTBED_EventInformation event;
 871
 872   op_id = GNUNET_ntohll (msg->operation_id);
 873   if (NULL == (opc = find_opc (c, op_id)))
 874   {
 875     LOG_DEBUG ("Operation not found\n");
 876     return;
 877   }
 878   if (OP_FORWARDED == opc->type)
 879   {
 880     handle_forwarded_operation_msg (c, opc,
 881                                     (const struct GNUNET_MessageHeader *) msg);
 882     return;
 883   }
 884   GNUNET_TESTBED_remove_opc_ (opc->c, opc);
 885   opc->state = OPC_STATE_FINISHED;
 886   emsg = GNUNET_TESTBED_parse_error_string_ (msg);
 887   if (NULL == emsg)
 888     emsg = "Unknown error";
 889   if (OP_PEER_INFO == opc->type)
 890   {
 891     struct PeerInfoData *data;
 892
 893     data = opc->data;
 894     if (NULL != data->cb)
 895       data->cb (data->cb_cls, opc->op, NULL, emsg);
 896     GNUNET_free (data);
 897     return;          /* We do not call controller callback for peer info */
 898   }
 899   event.type = GNUNET_TESTBED_ET_OPERATION_FINISHED;
 900   event.op = opc->op;
 901   event.op_cls = opc->op_cls;
 902   event.details.operation_finished.emsg = emsg;
 903   event.details.operation_finished.generic = NULL;
 904   mask = (1LL << GNUNET_TESTBED_ET_OPERATION_FINISHED);
 905   if ((0 != (mask & c->event_mask)) && (NULL != c->cc))
 906   {
 907     exop_insert (event.op);
 908     c->cc (c->cc_cls, &event);
 909     if (GNUNET_NO == exop_check (event.op))
 910       return;
 911   }
 912   switch (opc->type)
 913   {
 914   case OP_PEER_CREATE:
 915     {
 916       struct PeerCreateData *data;
 917
 918       data = opc->data;
 919       GNUNET_free (data->peer);
 920       if (NULL != data->cb)
 921         data->cb (data->cls, NULL, emsg);
 922       GNUNET_free (data);
 923     }
 924     break;
 925   case OP_PEER_START:
 926   case OP_PEER_STOP:
 927     {
 928       struct PeerEventData *data;
 929
 930       data = opc->data;
 931       if (NULL != data->pcc)
 932         data->pcc (data->pcc_cls, emsg);
 933       GNUNET_free (data);
 934     }
 935     break;
 936   case OP_PEER_DESTROY:
 937     break;
 938   case OP_PEER_INFO:
 939     GNUNET_assert (0);
 940   case OP_OVERLAY_CONNECT:
 941     {
 942       struct OverlayConnectData *data;
 943
 944       data = opc->data;
 945       GNUNET_TESTBED_operation_mark_failed (opc->op);
 946       if (NULL != data->cb)
 947         data->cb (data->cb_cls, opc->op, emsg);
 948     }
 949     break;
 950   case OP_FORWARDED:
 951     GNUNET_assert (0);
 952   case OP_LINK_CONTROLLERS:    /* No secondary callback */
 953     break;
 954   case OP_SHUTDOWN_PEERS:
 955     {
 956       struct ShutdownPeersData *data;
 957
 958       data = opc->data;
 959       GNUNET_free (data);         /* FIXME: Decide whether we call data->op_cb */
 960       opc->data = NULL;
 961     }
 962     break;
 963   case OP_MANAGE_SERVICE:
 964     {
 965       struct ManageServiceData *data = opc->data;
 966       GNUNET_TESTBED_OperationCompletionCallback cb;
 967       void *cb_cls;
 968
 969       GNUNET_assert (NULL != data);
 970       cb = data->cb;
 971       cb_cls = data->cb_cls;
 972       GNUNET_free (data);
 973       opc->data = NULL;
 974       exop_insert (event.op);
 975       if (NULL != cb)
 976         cb (cb_cls, opc->op, emsg);
 977       /* You could have marked the operation as done by now */
 978       GNUNET_break (GNUNET_NO == exop_check (event.op));
 979     }
 980     break;
 981   default:
 982     GNUNET_break (0);
 983   }
 984 }
 985
 986
 987 /**
 988  * Function to build GET_SLAVE_CONFIG message
 989  *
 990  * @param op_id the id this message should contain in its operation id field
 991  * @param slave_id the id this message should contain in its slave id field
 992  * @return newly allocated SlaveGetConfigurationMessage
 993  */
 994 static struct GNUNET_TESTBED_SlaveGetConfigurationMessage *
 995 GNUNET_TESTBED_generate_slavegetconfig_msg_ (uint64_t op_id, uint32_t slave_id)
 996 {
 997   struct GNUNET_TESTBED_SlaveGetConfigurationMessage *msg;
 998   uint16_t msize;
 999
1000   msize = sizeof (struct GNUNET_TESTBED_SlaveGetConfigurationMessage);
1001   msg = GNUNET_malloc (msize);
1002   msg->header.size = htons (msize);
1003   msg->header.type =
1004       htons (GNUNET_MESSAGE_TYPE_TESTBED_GET_SLAVE_CONFIGURATION);
1005   msg->operation_id = GNUNET_htonll (op_id);
1006   msg->slave_id = htonl (slave_id);
1007   return msg;
1008 }
1009
1010
1011
1012 /**
1013  * Validate #GNUNET_MESSAGE_TYPE_TESTBED_SLAVE_INFORMATION message from
1014  * controller (testbed service)
1015  *
1016  * @param c the controller handler
1017  * @param msg message received
1018  */
1019 static int
1020 check_slave_config (void *cls,
1021                     const struct GNUNET_TESTBED_SlaveConfiguration *msg)
1022 {
1023   /* anything goes? */
1024   return GNUNET_OK;
1025 }
1026
1027
1028 /**
1029  * Handler for #GNUNET_MESSAGE_TYPE_TESTBED_SLAVE_CONFIGURATION message from controller
1030  * (testbed service)
1031  *
1032  * @param c the controller handler
1033  * @param msg message received
1034  */
1035 static void
1036 handle_slave_config (void *cls,
1037                      const struct GNUNET_TESTBED_SlaveConfiguration *msg)
1038 {
1039   struct GNUNET_TESTBED_Controller *c = cls;
1040   struct OperationContext *opc;
1041   uint64_t op_id;
1042   uint64_t mask;
1043   struct GNUNET_TESTBED_EventInformation event;
1044
1045   op_id = GNUNET_ntohll (msg->operation_id);
1046   if (NULL == (opc = find_opc (c, op_id)))
1047   {
1048     LOG_DEBUG ("Operation not found\n");
1049     return;
1050   }
1051   if (OP_GET_SLAVE_CONFIG != opc->type)
1052   {
1053     GNUNET_break (0);
1054     return;
1055   }
1056   opc->state = OPC_STATE_FINISHED;
1057   GNUNET_TESTBED_remove_opc_ (opc->c, opc);
1058   mask = 1LL << GNUNET_TESTBED_ET_OPERATION_FINISHED;
1059   if ((0 != (mask & c->event_mask)) &&
1060       (NULL != c->cc))
1061   {
1062     opc->data = GNUNET_TESTBED_extract_config_ (&msg->header);
1063     event.type = GNUNET_TESTBED_ET_OPERATION_FINISHED;
1064     event.op = opc->op;
1065     event.op_cls = opc->op_cls;
1066     event.details.operation_finished.generic = opc->data;
1067     event.details.operation_finished.emsg = NULL;
1068     c->cc (c->cc_cls, &event);
1069   }
1070 }
1071
1072
1073 /**
1074  * Check #GNUNET_MESSAGE_TYPE_TESTBED_LINK_CONTROLLERS_RESULT message from controller
1075  * (testbed service)
1076  *
1077  * @param c the controller handler
1078  * @param msg message received
1079  * @return #GNUNET_OK if @a msg is well-formed
1080  */
1081 static int
1082 check_link_controllers_result (void *cls,
1083                                 const struct GNUNET_TESTBED_ControllerLinkResponse *msg)
1084 {
1085   /* actual check to be implemented */
1086   return GNUNET_OK;
1087 }
1088
1089
1090 /**
1091  * Handler for #GNUNET_MESSAGE_TYPE_TESTBED_LINK_CONTROLLERS_RESULT message from controller
1092  * (testbed service)
1093  *
1094  * @param c the controller handler
1095  * @param msg message received
1096  */
1097 static void
1098 handle_link_controllers_result (void *cls,
1099                                 const struct GNUNET_TESTBED_ControllerLinkResponse *msg)
1100 {
1101   struct GNUNET_TESTBED_Controller *c = cls;
1102   struct OperationContext *opc;
1103   struct ControllerLinkData *data;
1104   struct GNUNET_CONFIGURATION_Handle *cfg;
1105   struct GNUNET_TESTBED_Host *host;
1106   char *emsg;
1107   uint64_t op_id;
1108   struct GNUNET_TESTBED_EventInformation event;
1109
1110   op_id = GNUNET_ntohll (msg->operation_id);
1111   if (NULL == (opc = find_opc (c, op_id)))
1112   {
1113     LOG_DEBUG ("Operation not found\n");
1114     return;
1115   }
1116   if (OP_FORWARDED == opc->type)
1117   {
1118     handle_forwarded_operation_msg (c, opc,
1119                                     (const struct GNUNET_MessageHeader *) msg);
1120     return;
1121   }
1122   if (OP_LINK_CONTROLLERS != opc->type)
1123   {
1124     GNUNET_break (0);
1125     return;
1126   }
1127   GNUNET_assert (NULL != (data = opc->data));
1128   host = GNUNET_TESTBED_host_lookup_by_id_ (data->host_id);
1129   GNUNET_assert (NULL != host);
1130   GNUNET_free (data);
1131   opc->data = NULL;
1132   opc->state = OPC_STATE_FINISHED;
1133   GNUNET_TESTBED_remove_opc_ (opc->c, opc);
1134   event.type = GNUNET_TESTBED_ET_OPERATION_FINISHED;
1135   event.op = opc->op;
1136   event.op_cls = opc->op_cls;
1137   event.details.operation_finished.emsg = NULL;
1138   event.details.operation_finished.generic = NULL;
1139   emsg = NULL;
1140   cfg = NULL;
1141   if (GNUNET_NO == ntohs (msg->success))
1142   {
1143     emsg = GNUNET_malloc (ntohs (msg->header.size)
1144                           - sizeof (struct
1145                                     GNUNET_TESTBED_ControllerLinkResponse) + 1);
1146     memcpy (emsg, &msg[1], ntohs (msg->header.size)
1147                           - sizeof (struct
1148                                     GNUNET_TESTBED_ControllerLinkResponse));
1149     event.details.operation_finished.emsg = emsg;
1150   }
1151   else
1152   {
1153     if (0 != ntohs (msg->config_size))
1154     {
1155       cfg = GNUNET_TESTBED_extract_config_ ((const struct GNUNET_MessageHeader *) msg);
1156       GNUNET_assert (NULL != cfg);
1157       GNUNET_TESTBED_host_replace_cfg_ (host, cfg);
1158     }
1159   }
1160   if (0 != (c->event_mask & (1L << GNUNET_TESTBED_ET_OPERATION_FINISHED)))
1161   {
1162     if (NULL != c->cc)
1163       c->cc (c->cc_cls, &event);
1164   }
1165   else
1166     LOG_DEBUG ("Not calling callback\n");
1167   if (NULL != cfg)
1168     GNUNET_CONFIGURATION_destroy (cfg);
1169   GNUNET_free_non_null (emsg);
1170 }
1171
1172
1173 /**
1174  * Validate #GNUNET_MESSAGE_TYPE_TESTBED_BARRIER_STATUS message.
1175  *
1176  * @param cls the controller handle to determine the connection this message
1177  *   belongs to
1178  * @param msg the barrier status message
1179  * @return #GNUNET_OK if the message is valid; #GNUNET_SYSERR to tear it
1180  *   down signalling an error (message malformed)
1181  */
1182 static int
1183 check_barrier_status (void *cls,
1184                       const struct GNUNET_TESTBED_BarrierStatusMsg *msg)
1185 {
1186   uint16_t msize;
1187   uint16_t name_len;
1188   int status;
1189   const char *name;
1190   size_t emsg_len;
1191
1192   msize = ntohs (msg->header.size);
1193   name = msg->data;
1194   name_len = ntohs (msg->name_len);
1195
1196   if (sizeof (struct GNUNET_TESTBED_BarrierStatusMsg) + name_len + 1 > msize)
1197   {
1198     GNUNET_break_op (0);
1199     return GNUNET_SYSERR;
1200   }
1201   if ('\0' != name[name_len])
1202   {
1203     GNUNET_break_op (0);
1204     return GNUNET_SYSERR;
1205   }
1206   status = ntohs (msg->status);
1207   if (GNUNET_TESTBED_BARRIERSTATUS_ERROR == status)
1208   {
1209     emsg_len = msize - (sizeof (struct GNUNET_TESTBED_BarrierStatusMsg) + name_len
1210                         + 1); /* +1!? */
1211     if (0 == emsg_len)
1212     {
1213       GNUNET_break_op (0);
1214       return GNUNET_SYSERR;
1215     }
1216   }
1217   return GNUNET_OK;
1218 }
1219
1220
1221 /**
1222  * Handler for #GNUNET_MESSAGE_TYPE_TESTBED_BARRIER_STATUS messages
1223  *
1224  * @param cls the controller handle to determine the connection this message
1225  *   belongs to
1226  * @param msg the barrier status message
1227  */
1228 static void
1229 handle_barrier_status (void *cls,
1230                        const struct GNUNET_TESTBED_BarrierStatusMsg *msg)
1231 {
1232   struct GNUNET_TESTBED_Controller *c = cls;
1233   struct GNUNET_TESTBED_Barrier *barrier;
1234   char *emsg;
1235   const char *name;
1236   struct GNUNET_HashCode key;
1237   size_t emsg_len;
1238   int status;
1239   uint16_t msize;
1240   uint16_t name_len;
1241
1242   emsg = NULL;
1243   barrier = NULL;
1244   msize = ntohs (msg->header.size);
1245   name = msg->data;
1246   name_len = ntohs (msg->name_len);
1247   LOG_DEBUG ("Received BARRIER_STATUS msg\n");
1248   status = ntohs (msg->status);
1249   if (GNUNET_TESTBED_BARRIERSTATUS_ERROR == status)
1250   {
1251     status = -1;
1252     emsg_len = msize - (sizeof (struct GNUNET_TESTBED_BarrierStatusMsg) + name_len
1253                         + 1);
1254     emsg = GNUNET_malloc (emsg_len + 1);
1255     memcpy (emsg,
1256             msg->data + name_len + 1,
1257             emsg_len);
1258   }
1259   if (NULL == c->barrier_map)
1260   {
1261     GNUNET_break_op (0);
1262     goto cleanup;
1263   }
1264   GNUNET_CRYPTO_hash (name, name_len, &key);
1265   barrier = GNUNET_CONTAINER_multihashmap_get (c->barrier_map, &key);
1266   if (NULL == barrier)
1267   {
1268     GNUNET_break_op (0);
1269     goto cleanup;
1270   }
1271   GNUNET_assert (NULL != barrier->cb);
1272   if ((GNUNET_YES == barrier->echo) &&
1273       (GNUNET_TESTBED_BARRIERSTATUS_CROSSED == status))
1274     GNUNET_TESTBED_queue_message_ (c, GNUNET_copy_message (&msg->header));
1275   barrier->cb (barrier->cls, name, barrier, status, emsg);
1276   if (GNUNET_TESTBED_BARRIERSTATUS_INITIALISED == status)
1277     return;           /* just initialised; skip cleanup */
1278
1279  cleanup:
1280   GNUNET_free_non_null (emsg);
1281   if (NULL != barrier)
1282     GNUNET_TESTBED_barrier_remove_ (barrier);
1283 }
1284
1285
1286 /**
1287  * Queues a message in send queue for sending to the service
1288  *
1289  * @param controller the handle to the controller
1290  * @param msg the message to queue
1291  */
1292 void
1293 GNUNET_TESTBED_queue_message_ (struct GNUNET_TESTBED_Controller *controller,
1294                                struct GNUNET_MessageHeader *msg)
1295 {
1296   struct GNUNET_MQ_Envelope *env;
1297   struct GNUNET_MessageHeader *m2;
1298   uint16_t type;
1299   uint16_t size;
1300
1301   type = ntohs (msg->type);
1302   size = ntohs (msg->size);
1303   GNUNET_assert ((GNUNET_MESSAGE_TYPE_TESTBED_INIT <= type) &&
1304                  (GNUNET_MESSAGE_TYPE_TESTBED_MAX > type));
1305   env = GNUNET_MQ_msg_extra (m2,
1306                              size - sizeof (*m2),
1307                              type);
1308   memcpy (m2, msg, size);
1309   GNUNET_free (msg);
1310   GNUNET_MQ_send (controller->mq,
1311                   env);
1312 }
1313
1314
1315 /**
1316  * Sends the given message as an operation. The given callback is called when a
1317  * reply for the operation is available.  Call
1318  * GNUNET_TESTBED_forward_operation_msg_cancel_() to cleanup the returned
1319  * operation context if the cc hasn't been called
1320  *
1321  * @param controller the controller to which the message has to be sent
1322  * @param operation_id the operation id of the message
1323  * @param msg the message to send
1324  * @param cc the callback to call when reply is available
1325  * @param cc_cls the closure for the above callback
1326  * @return the operation context which can be used to cancel the forwarded
1327  *           operation
1328  */
1329 struct OperationContext *
1330 GNUNET_TESTBED_forward_operation_msg_ (struct GNUNET_TESTBED_Controller *controller,
1331                                        uint64_t operation_id,
1332                                        const struct GNUNET_MessageHeader *msg,
1333                                        GNUNET_CLIENT_MessageHandler cc,
1334                                        void *cc_cls)
1335 {
1336   struct OperationContext *opc;
1337   struct ForwardedOperationData *data;
1338   struct GNUNET_MQ_Envelope *env;
1339   struct GNUNET_MessageHeader *m2;
1340   uint16_t type = ntohs (msg->type);
1341   uint16_t size = ntohs (msg->size);
1342
1343   env = GNUNET_MQ_msg_extra (m2,
1344                              size - sizeof (*m2),
1345                              type);
1346   memcpy (m2,
1347           msg,
1348           size);
1349   GNUNET_MQ_send (controller->mq,
1350                   env);
1351   data = GNUNET_new (struct ForwardedOperationData);
1352   data->cc = cc;
1353   data->cc_cls = cc_cls;
1354   opc = GNUNET_new (struct OperationContext);
1355   opc->c = controller;
1356   opc->type = OP_FORWARDED;
1357   opc->data = data;
1358   opc->id = operation_id;
1359   GNUNET_TESTBED_insert_opc_ (controller,
1360                               opc);
1361   return opc;
1362 }
1363
1364
1365 /**
1366  * Function to cancel an operation created by simply forwarding an operation
1367  * message.
1368  *
1369  * @param opc the operation context from GNUNET_TESTBED_forward_operation_msg_()
1370  */
1371 void
1372 GNUNET_TESTBED_forward_operation_msg_cancel_ (struct OperationContext *opc)
1373 {
1374   GNUNET_TESTBED_remove_opc_ (opc->c,
1375                               opc);
1376   GNUNET_free (opc->data);
1377   GNUNET_free (opc);
1378 }
1379
1380
1381 /**
1382  * Function to call to start a link-controllers type operation once all queues
1383  * the operation is part of declare that the operation can be activated.
1384  *
1385  * @param cls the closure from GNUNET_TESTBED_operation_create_()
1386  */
1387 static void
1388 opstart_link_controllers (void *cls)
1389 {
1390   struct OperationContext *opc = cls;
1391   struct ControllerLinkData *data;
1392   struct GNUNET_TESTBED_ControllerLinkRequest *msg;
1393
1394   GNUNET_assert (NULL != opc->data);
1395   data = opc->data;
1396   msg = data->msg;
1397   data->msg = NULL;
1398   opc->state = OPC_STATE_STARTED;
1399   GNUNET_TESTBED_insert_opc_ (opc->c, opc);
1400   GNUNET_TESTBED_queue_message_ (opc->c, &msg->header);
1401 }
1402
1403
1404 /**
1405  * Callback which will be called when link-controllers type operation is released
1406  *
1407  * @param cls the closure from GNUNET_TESTBED_operation_create_()
1408  */
1409 static void
1410 oprelease_link_controllers (void *cls)
1411 {
1412   struct OperationContext *opc = cls;
1413   struct ControllerLinkData *data;
1414
1415   data = opc->data;
1416   switch (opc->state)
1417   {
1418   case OPC_STATE_INIT:
1419     GNUNET_free (data->msg);
1420     break;
1421   case OPC_STATE_STARTED:
1422     GNUNET_TESTBED_remove_opc_ (opc->c, opc);
1423     break;
1424   case OPC_STATE_FINISHED:
1425     break;
1426   }
1427   GNUNET_free_non_null (data);
1428   GNUNET_free (opc);
1429 }
1430
1431
1432 /**
1433  * Function to be called when get slave config operation is ready
1434  *
1435  * @param cls the OperationContext of type OP_GET_SLAVE_CONFIG
1436  */
1437 static void
1438 opstart_get_slave_config (void *cls)
1439 {
1440   struct OperationContext *opc = cls;
1441   struct GetSlaveConfigData *data = opc->data;
1442   struct GNUNET_TESTBED_SlaveGetConfigurationMessage *msg;
1443
1444   GNUNET_assert (NULL != data);
1445   msg = GNUNET_TESTBED_generate_slavegetconfig_msg_ (opc->id, data->slave_id);
1446   GNUNET_free (opc->data);
1447   data = NULL;
1448   opc->data = NULL;
1449   GNUNET_TESTBED_insert_opc_ (opc->c, opc);
1450   GNUNET_TESTBED_queue_message_ (opc->c, &msg->header);
1451   opc->state = OPC_STATE_STARTED;
1452 }
1453
1454
1455 /**
1456  * Function to be called when get slave config operation is cancelled or finished
1457  *
1458  * @param cls the OperationContext of type OP_GET_SLAVE_CONFIG
1459  */
1460 static void
1461 oprelease_get_slave_config (void *cls)
1462 {
1463   struct OperationContext *opc = cls;
1464
1465   switch (opc->state)
1466   {
1467   case OPC_STATE_INIT:
1468     GNUNET_free (opc->data);
1469     break;
1470   case OPC_STATE_STARTED:
1471     GNUNET_TESTBED_remove_opc_ (opc->c, opc);
1472     break;
1473   case OPC_STATE_FINISHED:
1474     if (NULL != opc->data)
1475       GNUNET_CONFIGURATION_destroy (opc->data);
1476     break;
1477   }
1478   GNUNET_free (opc);
1479 }
1480
1481
1482 /**
1483  * Generic error handler, called with the appropriate error code and
1484  * the same closure specified at the creation of the message queue.
1485  * Not every message queue implementation supports an error handler.
1486  *
1487  * @param cls closure, a `struct GNUNET_TESTBED_Controller *`
1488  * @param error error code
1489  */
1490 static void
1491 mq_error_handler (void *cls,
1492                   enum GNUNET_MQ_Error error)
1493 {
1494   /* struct GNUNET_TESTBED_Controller *c = cls; */
1495
1496   GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1497               "Encountered MQ error: %d\n",
1498               error);
1499   /* now what? */
1500   GNUNET_SCHEDULER_shutdown (); /* seems most reasonable */
1501 }
1502
1503
1504 /**
1505  * Start a controller process using the given configuration at the
1506  * given host.
1507  *
1508  * @param host host to run the controller on; This should be the same host if
1509  *          the controller was previously started with
1510  *          GNUNET_TESTBED_controller_start()
1511  * @param event_mask bit mask with set of events to call 'cc' for;
1512  *                   or-ed values of "1LL" shifted by the
1513  *                   respective 'enum GNUNET_TESTBED_EventType'
1514  *                   (i.e.  "(1LL << GNUNET_TESTBED_ET_CONNECT) | ...")
1515  * @param cc controller callback to invoke on events
1516  * @param cc_cls closure for cc
1517  * @return handle to the controller
1518  */
1519 struct GNUNET_TESTBED_Controller *
1520 GNUNET_TESTBED_controller_connect (struct GNUNET_TESTBED_Host *host,
1521                                    uint64_t event_mask,
1522                                    GNUNET_TESTBED_ControllerCallback cc,
1523                                    void *cc_cls)
1524 {
1525   GNUNET_MQ_hd_var_size (add_host_confirm,
1526                          GNUNET_MESSAGE_TYPE_TESTBED_ADD_HOST_SUCCESS,
1527                          struct GNUNET_TESTBED_HostConfirmedMessage);
1528   GNUNET_MQ_hd_fixed_size (peer_conevent,
1529                            GNUNET_MESSAGE_TYPE_TESTBED_PEER_CONNECT_EVENT,
1530                            struct GNUNET_TESTBED_ConnectionEventMessage);
1531   GNUNET_MQ_hd_fixed_size (opsuccess,
1532                            GNUNET_MESSAGE_TYPE_TESTBED_GENERIC_OPERATION_SUCCESS,
1533                            struct GNUNET_TESTBED_GenericOperationSuccessEventMessage);
1534   GNUNET_MQ_hd_var_size (op_fail_event,
1535                          GNUNET_MESSAGE_TYPE_TESTBED_OPERATION_FAIL_EVENT,
1536                          struct GNUNET_TESTBED_OperationFailureEventMessage);
1537   GNUNET_MQ_hd_fixed_size (peer_create_success,
1538                            GNUNET_MESSAGE_TYPE_TESTBED_CREATE_PEER_SUCCESS,
1539                            struct GNUNET_TESTBED_PeerCreateSuccessEventMessage);
1540   GNUNET_MQ_hd_fixed_size (peer_event,
1541                            GNUNET_MESSAGE_TYPE_TESTBED_PEER_EVENT,
1542                            struct GNUNET_TESTBED_PeerEventMessage);
1543   GNUNET_MQ_hd_var_size (peer_config,
1544                          GNUNET_MESSAGE_TYPE_TESTBED_PEER_INFORMATION,
1545                          struct GNUNET_TESTBED_PeerConfigurationInformationMessage);
1546   GNUNET_MQ_hd_var_size (slave_config,
1547                          GNUNET_MESSAGE_TYPE_TESTBED_SLAVE_CONFIGURATION,
1548                          struct GNUNET_TESTBED_SlaveConfiguration);
1549   GNUNET_MQ_hd_var_size (link_controllers_result,
1550                          GNUNET_MESSAGE_TYPE_TESTBED_LINK_CONTROLLERS_RESULT,
1551                          struct GNUNET_TESTBED_ControllerLinkResponse);
1552   GNUNET_MQ_hd_var_size (barrier_status,
1553                          GNUNET_MESSAGE_TYPE_TESTBED_BARRIER_STATUS,
1554                          const struct GNUNET_TESTBED_BarrierStatusMsg);
1555   struct GNUNET_TESTBED_Controller *controller
1556     = GNUNET_new (struct GNUNET_TESTBED_Controller);
1557   struct GNUNET_MQ_MessageHandler handlers[] = {
1558     make_add_host_confirm_handler (controller),
1559     make_peer_conevent_handler (controller),
1560     make_opsuccess_handler (controller),
1561     make_op_fail_event_handler (controller),
1562     make_peer_create_success_handler (controller),
1563     make_peer_event_handler (controller),
1564     make_peer_config_handler (controller),
1565     make_slave_config_handler (controller),
1566     make_link_controllers_result_handler (controller),
1567     make_barrier_status_handler (controller),
1568     GNUNET_MQ_handler_end ()
1569   };
1570   struct GNUNET_TESTBED_InitMessage *msg;
1571   struct GNUNET_MQ_Envelope *env;
1572   const struct GNUNET_CONFIGURATION_Handle *cfg;
1573   const char *controller_hostname;
1574   unsigned long long max_parallel_operations;
1575   unsigned long long max_parallel_service_connections;
1576   unsigned long long max_parallel_topology_config_operations;
1577   size_t slen;
1578
1579   GNUNET_assert (NULL != (cfg = GNUNET_TESTBED_host_get_cfg_ (host)));
1580   if (GNUNET_OK !=
1581       GNUNET_CONFIGURATION_get_value_number (cfg, "testbed",
1582                                              "MAX_PARALLEL_OPERATIONS",
1583                                              &max_parallel_operations))
1584   {
1585     GNUNET_break (0);
1586     GNUNET_free (controller);
1587     return NULL;
1588   }
1589   if (GNUNET_OK !=
1590       GNUNET_CONFIGURATION_get_value_number (cfg, "testbed",
1591                                              "MAX_PARALLEL_SERVICE_CONNECTIONS",
1592                                              &max_parallel_service_connections))
1593   {
1594     GNUNET_break (0);
1595     GNUNET_free (controller);
1596     return NULL;
1597   }
1598   if (GNUNET_OK !=
1599       GNUNET_CONFIGURATION_get_value_number (cfg, "testbed",
1600                                              "MAX_PARALLEL_TOPOLOGY_CONFIG_OPERATIONS",
1601                                              &max_parallel_topology_config_operations))
1602   {
1603     GNUNET_break (0);
1604     GNUNET_free (controller);
1605     return NULL;
1606   }
1607   controller->cc = cc;
1608   controller->cc_cls = cc_cls;
1609   controller->event_mask = event_mask;
1610   controller->cfg = GNUNET_CONFIGURATION_dup (cfg);
1611   controller->mq = GNUNET_CLIENT_connecT (controller->cfg,
1612                                           "testbed",
1613                                           handlers,
1614                                           &mq_error_handler,
1615                                           controller);
1616   if (NULL == controller->mq)
1617   {
1618     GNUNET_break (0);
1619     GNUNET_TESTBED_controller_disconnect (controller);
1620     return NULL;
1621   }
1622   GNUNET_TESTBED_mark_host_registered_at_ (host, controller);
1623   controller->host = host;
1624   controller->opq_parallel_operations =
1625       GNUNET_TESTBED_operation_queue_create_ (OPERATION_QUEUE_TYPE_FIXED,
1626                                               (unsigned int) max_parallel_operations);
1627   controller->opq_parallel_service_connections =
1628       GNUNET_TESTBED_operation_queue_create_ (OPERATION_QUEUE_TYPE_FIXED,
1629                                               (unsigned int)
1630                                               max_parallel_service_connections);
1631   controller->opq_parallel_topology_config_operations =
1632       GNUNET_TESTBED_operation_queue_create_ (OPERATION_QUEUE_TYPE_FIXED,
1633                                               (unsigned int)
1634                                               max_parallel_topology_config_operations);
1635   controller_hostname = GNUNET_TESTBED_host_get_hostname (host);
1636   if (NULL == controller_hostname)
1637     controller_hostname = "127.0.0.1";
1638   slen = strlen (controller_hostname) + 1;
1639   env = GNUNET_MQ_msg_extra (msg,
1640                              slen,
1641                              GNUNET_MESSAGE_TYPE_TESTBED_INIT);
1642   msg->host_id = htonl (GNUNET_TESTBED_host_get_id_ (host));
1643   msg->event_mask = GNUNET_htonll (controller->event_mask);
1644   memcpy (&msg[1],
1645           controller_hostname,
1646           slen);
1647   GNUNET_MQ_send (controller->mq,
1648                   env);
1649   return controller;
1650 }
1651
1652
1653 /**
1654  * Iterator to free opc map entries
1655  *
1656  * @param cls closure
1657  * @param key current key code
1658  * @param value value in the hash map
1659  * @return #GNUNET_YES if we should continue to iterate,
1660  *         #GNUNET_NO if not.
1661  */
1662 static int
1663 opc_free_iterator (void *cls, uint32_t key, void *value)
1664 {
1665   struct GNUNET_CONTAINER_MultiHashMap32 *map = cls;
1666   struct OperationContext *opc = value;
1667
1668   GNUNET_assert (NULL != opc);
1669   GNUNET_break (0);
1670   GNUNET_assert (GNUNET_YES ==
1671                  GNUNET_CONTAINER_multihashmap32_remove (map, key, value));
1672   GNUNET_free (opc);
1673   return GNUNET_YES;
1674 }
1675
1676
1677 /**
1678  * Stop the given controller (also will terminate all peers and
1679  * controllers dependent on this controller).  This function
1680  * blocks until the testbed has been fully terminated (!).
1681  *
1682  * @param c handle to controller to stop
1683  */
1684 void
1685 GNUNET_TESTBED_controller_disconnect (struct GNUNET_TESTBED_Controller *c)
1686 {
1687   if (NULL != c->mq)
1688   {
1689     GNUNET_MQ_destroy (c->mq);
1690     c->mq = NULL;
1691   }
1692   if (NULL != c->host)
1693     GNUNET_TESTBED_deregister_host_at_ (c->host, c);
1694   GNUNET_CONFIGURATION_destroy (c->cfg);
1695   GNUNET_TESTBED_operation_queue_destroy_ (c->opq_parallel_operations);
1696   GNUNET_TESTBED_operation_queue_destroy_
1697       (c->opq_parallel_service_connections);
1698   GNUNET_TESTBED_operation_queue_destroy_
1699       (c->opq_parallel_topology_config_operations);
1700   if (NULL != c->opc_map)
1701   {
1702     GNUNET_assert (GNUNET_SYSERR !=
1703                    GNUNET_CONTAINER_multihashmap32_iterate (c->opc_map,
1704                                                             &opc_free_iterator,
1705                                                             c->opc_map));
1706     GNUNET_assert (0 == GNUNET_CONTAINER_multihashmap32_size (c->opc_map));
1707     GNUNET_CONTAINER_multihashmap32_destroy (c->opc_map);
1708   }
1709   GNUNET_free (c);
1710 }
1711
1712
1713 /**
1714  * Compresses given configuration using zlib compress
1715  *
1716  * @param config the serialized configuration
1717  * @param size the size of config
1718  * @param xconfig will be set to the compressed configuration (memory is fresly
1719  *          allocated)
1720  * @return the size of the xconfig
1721  */
1722 size_t
1723 GNUNET_TESTBED_compress_config_ (const char *config,
1724                                  size_t size,
1725                                  char **xconfig)
1726 {
1727   size_t xsize;
1728
1729   xsize = compressBound ((uLong) size);
1730   *xconfig = GNUNET_malloc (xsize);
1731   GNUNET_assert (Z_OK ==
1732                  compress2 ((Bytef *) * xconfig, (uLongf *) & xsize,
1733                             (const Bytef *) config, (uLongf) size,
1734                             Z_BEST_SPEED));
1735   return xsize;
1736 }
1737
1738
1739 /**
1740  * Function to serialize and compress using zlib a configuration through a
1741  * configuration handle
1742  *
1743  * @param cfg the configuration
1744  * @param size the size of configuration when serialize.  Will be set on success.
1745  * @param xsize the sizeo of the compressed configuration.  Will be set on success.
1746  * @return the serialized and compressed configuration
1747  */
1748 char *
1749 GNUNET_TESTBED_compress_cfg_ (const struct GNUNET_CONFIGURATION_Handle *cfg,
1750                               size_t *size, size_t *xsize)
1751 {
1752   char *config;
1753   char *xconfig;
1754   size_t size_;
1755   size_t xsize_;
1756
1757   config = GNUNET_CONFIGURATION_serialize (cfg, &size_);
1758   xsize_ = GNUNET_TESTBED_compress_config_ (config, size_, &xconfig);
1759   GNUNET_free (config);
1760   *size = size_;
1761   *xsize = xsize_;
1762   return xconfig;
1763 }
1764
1765
1766 /**
1767  * Create a link from slave controller to delegated controller. Whenever the
1768  * master controller is asked to start a peer at the delegated controller the
1769  * request will be routed towards slave controller (if a route exists). The
1770  * slave controller will then route it to the delegated controller. The
1771  * configuration of the delegated controller is given and is used to either
1772  * create the delegated controller or to connect to an existing controller. Note
1773  * that while starting the delegated controller the configuration will be
1774  * modified to accommodate available free ports.  the 'is_subordinate' specifies
1775  * if the given delegated controller should be started and managed by the slave
1776  * controller, or if the delegated controller already has a master and the slave
1777  * controller connects to it as a non master controller. The success or failure
1778  * of this operation will be signalled through the
1779  * GNUNET_TESTBED_ControllerCallback() with an event of type
1780  * GNUNET_TESTBED_ET_OPERATION_FINISHED
1781  *
1782  * @param op_cls the operation closure for the event which is generated to
1783  *          signal success or failure of this operation
1784  * @param master handle to the master controller who creates the association
1785  * @param delegated_host requests to which host should be delegated; cannot be NULL
1786  * @param slave_host which host is used to run the slave controller; use NULL to
1787  *          make the master controller connect to the delegated host
1788  * @param is_subordinate GNUNET_YES if the controller at delegated_host should
1789  *          be started by the slave controller; GNUNET_NO if the slave
1790  *          controller has to connect to the already started delegated
1791  *          controller via TCP/IP
1792  * @return the operation handle
1793  */
1794 struct GNUNET_TESTBED_Operation *
1795 GNUNET_TESTBED_controller_link (void *op_cls,
1796                                 struct GNUNET_TESTBED_Controller *master,
1797                                 struct GNUNET_TESTBED_Host *delegated_host,
1798                                 struct GNUNET_TESTBED_Host *slave_host,
1799                                 int is_subordinate)
1800 {
1801   struct OperationContext *opc;
1802   struct GNUNET_TESTBED_ControllerLinkRequest *msg;
1803   struct ControllerLinkData *data;
1804   uint32_t slave_host_id;
1805   uint32_t delegated_host_id;
1806   uint16_t msg_size;
1807
1808   GNUNET_assert (GNUNET_YES ==
1809                  GNUNET_TESTBED_is_host_registered_ (delegated_host, master));
1810   slave_host_id =
1811       GNUNET_TESTBED_host_get_id_ ((NULL !=
1812                                     slave_host) ? slave_host : master->host);
1813   delegated_host_id = GNUNET_TESTBED_host_get_id_ (delegated_host);
1814   if ((NULL != slave_host) && (0 != slave_host_id))
1815     GNUNET_assert (GNUNET_YES ==
1816                    GNUNET_TESTBED_is_host_registered_ (slave_host, master));
1817   msg_size = sizeof (struct GNUNET_TESTBED_ControllerLinkRequest);
1818   msg = GNUNET_malloc (msg_size);
1819   msg->header.type = htons (GNUNET_MESSAGE_TYPE_TESTBED_LINK_CONTROLLERS);
1820   msg->header.size = htons (msg_size);
1821   msg->delegated_host_id = htonl (delegated_host_id);
1822   msg->slave_host_id = htonl (slave_host_id);
1823   msg->is_subordinate = (GNUNET_YES == is_subordinate) ? 1 : 0;
1824   data = GNUNET_new (struct ControllerLinkData);
1825   data->msg = msg;
1826   data->host_id = delegated_host_id;
1827   opc = GNUNET_new (struct OperationContext);
1828   opc->c = master;
1829   opc->data = data;
1830   opc->type = OP_LINK_CONTROLLERS;
1831   opc->id = GNUNET_TESTBED_get_next_op_id (opc->c);
1832   opc->state = OPC_STATE_INIT;
1833   opc->op_cls = op_cls;
1834   msg->operation_id = GNUNET_htonll (opc->id);
1835   opc->op =
1836       GNUNET_TESTBED_operation_create_ (opc, &opstart_link_controllers,
1837                                         &oprelease_link_controllers);
1838   GNUNET_TESTBED_operation_queue_insert_ (master->opq_parallel_operations,
1839                                           opc->op);
1840   GNUNET_TESTBED_operation_begin_wait_ (opc->op);
1841   return opc->op;
1842 }
1843
1844
1845 /**
1846  * Like GNUNET_TESTBED_get_slave_config(), however without the host registration
1847  * check. Another difference is that this function takes the id of the slave
1848  * host.
1849  *
1850  * @param op_cls the closure for the operation
1851  * @param master the handle to master controller
1852  * @param slave_host_id id of the host where the slave controller is running to
1853  *          the slave_host should remain valid until this operation is cancelled
1854  *          or marked as finished
1855  * @return the operation handle;
1856  */
1857 struct GNUNET_TESTBED_Operation *
1858 GNUNET_TESTBED_get_slave_config_ (void *op_cls,
1859                                   struct GNUNET_TESTBED_Controller *master,
1860                                   uint32_t slave_host_id)
1861 {
1862   struct OperationContext *opc;
1863   struct GetSlaveConfigData *data;
1864
1865   data = GNUNET_new (struct GetSlaveConfigData);
1866   data->slave_id = slave_host_id;
1867   opc = GNUNET_new (struct OperationContext);
1868   opc->state = OPC_STATE_INIT;
1869   opc->c = master;
1870   opc->id = GNUNET_TESTBED_get_next_op_id (master);
1871   opc->type = OP_GET_SLAVE_CONFIG;
1872   opc->data = data;
1873   opc->op_cls = op_cls;
1874   opc->op =
1875       GNUNET_TESTBED_operation_create_ (opc, &opstart_get_slave_config,
1876                                         &oprelease_get_slave_config);
1877   GNUNET_TESTBED_operation_queue_insert_ (master->opq_parallel_operations,
1878                                           opc->op);
1879   GNUNET_TESTBED_operation_begin_wait_ (opc->op);
1880   return opc->op;
1881 }
1882
1883
1884 /**
1885  * Function to acquire the configuration of a running slave controller. The
1886  * completion of the operation is signalled through the controller_cb from
1887  * GNUNET_TESTBED_controller_connect(). If the operation is successful the
1888  * handle to the configuration is available in the generic pointer of
1889  * operation_finished field of struct GNUNET_TESTBED_EventInformation.
1890  *
1891  * @param op_cls the closure for the operation
1892  * @param master the handle to master controller
1893  * @param slave_host the host where the slave controller is running; the handle
1894  *          to the slave_host should remain valid until this operation is
1895  *          cancelled or marked as finished
1896  * @return the operation handle; NULL if the slave_host is not registered at
1897  *           master
1898  */
1899 struct GNUNET_TESTBED_Operation *
1900 GNUNET_TESTBED_get_slave_config (void *op_cls,
1901                                  struct GNUNET_TESTBED_Controller *master,
1902                                  struct GNUNET_TESTBED_Host *slave_host)
1903 {
1904   if (GNUNET_NO == GNUNET_TESTBED_is_host_registered_ (slave_host, master))
1905     return NULL;
1906   return GNUNET_TESTBED_get_slave_config_ (op_cls, master,
1907                                            GNUNET_TESTBED_host_get_id_
1908                                            (slave_host));
1909 }
1910
1911
1912 /**
1913  * Ask the testbed controller to write the current overlay topology to
1914  * a file.  Naturally, the file will only contain a snapshot as the
1915  * topology may evolve all the time.
1916  *
1917  * @param controller overlay controller to inspect
1918  * @param filename name of the file the topology should
1919  *        be written to.
1920  */
1921 void
1922 GNUNET_TESTBED_overlay_write_topology_to_file (struct GNUNET_TESTBED_Controller
1923                                                *controller,
1924                                                const char *filename)
1925 {
1926   GNUNET_break (0);
1927 }
1928
1929
1930 /**
1931  * Creates a helper initialization message. This function is here because we
1932  * want to use this in testing
1933  *
1934  * @param trusted_ip the ip address of the controller which will be set as TRUSTED
1935  *          HOST(all connections form this ip are permitted by the testbed) when
1936  *          starting testbed controller at host. This can either be a single ip
1937  *          address or a network address in CIDR notation.
1938  * @param hostname the hostname of the destination this message is intended for
1939  * @param cfg the configuration that has to used to start the testbed service
1940  *          thru helper
1941  * @return the initialization message
1942  */
1943 struct GNUNET_TESTBED_HelperInit *
1944 GNUNET_TESTBED_create_helper_init_msg_ (const char *trusted_ip,
1945                                         const char *hostname,
1946                                         const struct GNUNET_CONFIGURATION_Handle
1947                                         *cfg)
1948 {
1949   struct GNUNET_TESTBED_HelperInit *msg;
1950   char *config;
1951   char *xconfig;
1952   size_t config_size;
1953   size_t xconfig_size;
1954   uint16_t trusted_ip_len;
1955   uint16_t hostname_len;
1956   uint16_t msg_size;
1957
1958   config = GNUNET_CONFIGURATION_serialize (cfg, &config_size);
1959   GNUNET_assert (NULL != config);
1960   xconfig_size =
1961       GNUNET_TESTBED_compress_config_ (config, config_size, &xconfig);
1962   GNUNET_free (config);
1963   trusted_ip_len = strlen (trusted_ip);
1964   hostname_len = (NULL == hostname) ? 0 : strlen (hostname);
1965   msg_size =
1966       xconfig_size + trusted_ip_len + 1 +
1967       sizeof (struct GNUNET_TESTBED_HelperInit);
1968   msg_size += hostname_len;
1969   msg = GNUNET_realloc (xconfig, msg_size);
1970   (void) memmove (((void *) &msg[1]) + trusted_ip_len + 1 + hostname_len, msg,
1971                   xconfig_size);
1972   msg->header.size = htons (msg_size);
1973   msg->header.type = htons (GNUNET_MESSAGE_TYPE_TESTBED_HELPER_INIT);
1974   msg->trusted_ip_size = htons (trusted_ip_len);
1975   msg->hostname_size = htons (hostname_len);
1976   msg->config_size = htons (config_size);
1977   (void) strcpy ((char *) &msg[1], trusted_ip);
1978   if (0 != hostname_len)
1979     (void) strncpy (((char *) &msg[1]) + trusted_ip_len + 1, hostname,
1980                     hostname_len);
1981   return msg;
1982 }
1983
1984
1985 /**
1986  * This function is used to signal that the event information (struct
1987  * GNUNET_TESTBED_EventInformation) from an operation has been fully processed
1988  * i.e. if the event callback is ever called for this operation. If the event
1989  * callback for this operation has not yet been called, calling this function
1990  * cancels the operation, frees its resources and ensures the no event is
1991  * generated with respect to this operation. Note that however cancelling an
1992  * operation does NOT guarantee that the operation will be fully undone (or that
1993  * nothing ever happened).
1994  *
1995  * This function MUST be called for every operation to fully remove the
1996  * operation from the operation queue.  After calling this function, if
1997  * operation is completed and its event information is of type
1998  * GNUNET_TESTBED_ET_OPERATION_FINISHED, the 'op_result' becomes invalid (!).
1999
2000  * If the operation is generated from GNUNET_TESTBED_service_connect() then
2001  * calling this function on such as operation calls the disconnect adapter if
2002  * the connect adapter was ever called.
2003  *
2004  * @param operation operation to signal completion or cancellation
2005  */
2006 void
2007 GNUNET_TESTBED_operation_done (struct GNUNET_TESTBED_Operation *operation)
2008 {
2009   (void) exop_check (operation);
2010   GNUNET_TESTBED_operation_release_ (operation);
2011 }
2012
2013
2014 /**
2015  * Generates configuration by uncompressing configuration in given message. The
2016  * given message should be of the following types:
2017  * #GNUNET_MESSAGE_TYPE_TESTBED_PEER_INFORMATION,
2018  * #GNUNET_MESSAGE_TYPE_TESTBED_SLAVE_CONFIGURATION,
2019  * #GNUNET_MESSAGE_TYPE_TESTBED_ADD_HOST,
2020  * #GNUNET_MESSAGE_TYPE_TESTBED_LINK_CONTROLLERS,
2021  * #GNUNET_MESSAGE_TYPE_TESTBED_LINK_CONTROLLERS_RESULT,
2022  *
2023  * FIXME: This API is incredibly ugly.
2024  *
2025  * @param msg the message containing compressed configuration
2026  * @return handle to the parsed configuration; NULL upon error while parsing the message
2027  */
2028 struct GNUNET_CONFIGURATION_Handle *
2029 GNUNET_TESTBED_extract_config_ (const struct GNUNET_MessageHeader *msg)
2030 {
2031   struct GNUNET_CONFIGURATION_Handle *cfg;
2032   Bytef *data;
2033   const Bytef *xdata;
2034   uLong data_len;
2035   uLong xdata_len;
2036   int ret;
2037
2038   switch (ntohs (msg->type))
2039   {
2040   case GNUNET_MESSAGE_TYPE_TESTBED_PEER_INFORMATION:
2041   {
2042     const struct GNUNET_TESTBED_PeerConfigurationInformationMessage *imsg;
2043
2044     imsg =
2045         (const struct GNUNET_TESTBED_PeerConfigurationInformationMessage *) msg;
2046     data_len = (uLong) ntohs (imsg->config_size);
2047     xdata_len =
2048         ntohs (imsg->header.size) -
2049         sizeof (struct GNUNET_TESTBED_PeerConfigurationInformationMessage);
2050     xdata = (const Bytef *) &imsg[1];
2051   }
2052     break;
2053   case GNUNET_MESSAGE_TYPE_TESTBED_SLAVE_CONFIGURATION:
2054   {
2055     const struct GNUNET_TESTBED_SlaveConfiguration *imsg;
2056
2057     imsg = (const struct GNUNET_TESTBED_SlaveConfiguration *) msg;
2058     data_len = (uLong) ntohs (imsg->config_size);
2059     xdata_len =
2060         ntohs (imsg->header.size) -
2061         sizeof (struct GNUNET_TESTBED_SlaveConfiguration);
2062     xdata = (const Bytef *) &imsg[1];
2063   }
2064   break;
2065   case GNUNET_MESSAGE_TYPE_TESTBED_ADD_HOST:
2066     {
2067       const struct GNUNET_TESTBED_AddHostMessage *imsg;
2068       uint16_t osize;
2069
2070       imsg = (const struct GNUNET_TESTBED_AddHostMessage *) msg;
2071       data_len = (uLong) ntohs (imsg->config_size);
2072       osize = sizeof (struct GNUNET_TESTBED_AddHostMessage) +
2073           ntohs (imsg->username_length) + ntohs (imsg->hostname_length);
2074       xdata_len = ntohs (imsg->header.size) - osize;
2075       xdata = (const Bytef *) ((const void *) imsg + osize);
2076     }
2077     break;
2078   case GNUNET_MESSAGE_TYPE_TESTBED_LINK_CONTROLLERS_RESULT:
2079     {
2080       const struct GNUNET_TESTBED_ControllerLinkResponse *imsg;
2081
2082       imsg = (const struct GNUNET_TESTBED_ControllerLinkResponse *) msg;
2083       data_len = ntohs (imsg->config_size);
2084       xdata_len = ntohs (imsg->header.size) -
2085           sizeof (const struct GNUNET_TESTBED_ControllerLinkResponse);
2086       xdata = (const Bytef *) &imsg[1];
2087     }
2088     break;
2089   case GNUNET_MESSAGE_TYPE_TESTBED_CREATE_PEER:
2090     {
2091       const struct GNUNET_TESTBED_PeerCreateMessage *imsg;
2092
2093       imsg = (const struct GNUNET_TESTBED_PeerCreateMessage *) msg;
2094       data_len = ntohs (imsg->config_size);
2095       xdata_len = ntohs (imsg->header.size) -
2096           sizeof (struct GNUNET_TESTBED_PeerCreateMessage);
2097       xdata = (const Bytef *) &imsg[1];
2098     }
2099     break;
2100   case GNUNET_MESSAGE_TYPE_TESTBED_RECONFIGURE_PEER:
2101     {
2102       const struct GNUNET_TESTBED_PeerReconfigureMessage *imsg;
2103
2104       imsg = (const struct GNUNET_TESTBED_PeerReconfigureMessage *) msg;
2105       data_len =  ntohs (imsg->config_size);
2106       xdata_len = ntohs (imsg->header.size) -
2107           sizeof (struct GNUNET_TESTBED_PeerReconfigureMessage);
2108       xdata = (const Bytef *) &imsg[1];
2109     }
2110     break;
2111   default:
2112     GNUNET_assert (0);
2113   }
2114   data = GNUNET_malloc (data_len);
2115   if (Z_OK != (ret = uncompress (data, &data_len, xdata, xdata_len)))
2116   {
2117     GNUNET_free (data);
2118     GNUNET_break_op (0);        /* Un-compression failure */
2119     return NULL;
2120   }
2121   cfg = GNUNET_CONFIGURATION_create ();
2122   if (GNUNET_OK !=
2123       GNUNET_CONFIGURATION_deserialize (cfg, (const char *) data,
2124                                         (size_t) data_len,
2125                                         GNUNET_NO))
2126   {
2127     GNUNET_free (data);
2128     GNUNET_break_op (0);        /* De-serialization failure */
2129     return NULL;
2130   }
2131   GNUNET_free (data);
2132   return cfg;
2133 }
2134
2135
2136 /**
2137  * Checks the integrity of the OperationFailureEventMessage and if good returns
2138  * the error message it contains.
2139  *
2140  * @param msg the OperationFailureEventMessage
2141  * @return the error message
2142  */
2143 const char *
2144 GNUNET_TESTBED_parse_error_string_ (const struct
2145                                     GNUNET_TESTBED_OperationFailureEventMessage
2146                                     *msg)
2147 {
2148   uint16_t msize;
2149   const char *emsg;
2150
2151   msize = ntohs (msg->header.size);
2152   if (sizeof (struct GNUNET_TESTBED_OperationFailureEventMessage) >= msize)
2153     return NULL;
2154   msize -= sizeof (struct GNUNET_TESTBED_OperationFailureEventMessage);
2155   emsg = (const char *) &msg[1];
2156   if ('\0' != emsg[msize - 1])
2157   {
2158     GNUNET_break (0);
2159     return NULL;
2160   }
2161   return emsg;
2162 }
2163
2164
2165 /**
2166  * Function to return the operation id for a controller. The operation id is
2167  * created from the controllers host id and its internal operation counter.
2168  *
2169  * @param controller the handle to the controller whose operation id has to be incremented
2170  * @return the incremented operation id.
2171  */
2172 uint64_t
2173 GNUNET_TESTBED_get_next_op_id (struct GNUNET_TESTBED_Controller * controller)
2174 {
2175   uint64_t op_id;
2176
2177   op_id = (uint64_t) GNUNET_TESTBED_host_get_id_ (controller->host);
2178   op_id = op_id << 32;
2179   op_id |= (uint64_t) controller->operation_counter++;
2180   return op_id;
2181 }
2182
2183
2184 /**
2185  * Function called when a shutdown peers operation is ready
2186  *
2187  * @param cls the closure from GNUNET_TESTBED_operation_create_()
2188  */
2189 static void
2190 opstart_shutdown_peers (void *cls)
2191 {
2192   struct OperationContext *opc = cls;
2193   struct GNUNET_MQ_Envelope *env;
2194   struct GNUNET_TESTBED_ShutdownPeersMessage *msg;
2195
2196   opc->state = OPC_STATE_STARTED;
2197   env = GNUNET_MQ_msg (msg,
2198                        GNUNET_MESSAGE_TYPE_TESTBED_SHUTDOWN_PEERS);
2199   msg->operation_id = GNUNET_htonll (opc->id);
2200   GNUNET_TESTBED_insert_opc_ (opc->c,
2201                               opc);
2202   GNUNET_MQ_send (opc->c->mq,
2203                   env);
2204 }
2205
2206
2207 /**
2208  * Callback which will be called when shutdown peers operation is released
2209  *
2210  * @param cls the closure from GNUNET_TESTBED_operation_create_()
2211  */
2212 static void
2213 oprelease_shutdown_peers (void *cls)
2214 {
2215   struct OperationContext *opc = cls;
2216
2217   switch (opc->state)
2218   {
2219   case OPC_STATE_STARTED:
2220     GNUNET_TESTBED_remove_opc_ (opc->c, opc);
2221     /* no break; continue */
2222   case OPC_STATE_INIT:
2223     GNUNET_free (opc->data);
2224     break;
2225   case OPC_STATE_FINISHED:
2226     break;
2227   }
2228   GNUNET_free (opc);
2229 }
2230
2231
2232 /**
2233  * Stops and destroys all peers.  Is equivalent of calling
2234  * GNUNET_TESTBED_peer_stop() and GNUNET_TESTBED_peer_destroy() on all peers,
2235  * except that the peer stop event and operation finished event corresponding to
2236  * the respective functions are not generated.  This function should be called
2237  * when there are no other pending operations.  If there are pending operations,
2238  * it will return NULL
2239  *
2240  * @param c the controller to send this message to
2241  * @param op_cls closure for the operation
2242  * @param cb the callback to call when all peers are stopped and destroyed
2243  * @param cb_cls the closure for the callback
2244  * @return operation handle on success; NULL if any pending operations are
2245  *           present
2246  */
2247 struct GNUNET_TESTBED_Operation *
2248 GNUNET_TESTBED_shutdown_peers (struct GNUNET_TESTBED_Controller *c,
2249                                void *op_cls,
2250                                GNUNET_TESTBED_OperationCompletionCallback cb,
2251                                void *cb_cls)
2252 {
2253   struct OperationContext *opc;
2254   struct ShutdownPeersData *data;
2255
2256   if (0 != GNUNET_CONTAINER_multihashmap32_size (c->opc_map))
2257     return NULL;
2258   data = GNUNET_new (struct ShutdownPeersData);
2259   data->cb = cb;
2260   data->cb_cls = cb_cls;
2261   opc = GNUNET_new (struct OperationContext);
2262   opc->c = c;
2263   opc->op_cls = op_cls;
2264   opc->data = data;
2265   opc->id =  GNUNET_TESTBED_get_next_op_id (c);
2266   opc->type = OP_SHUTDOWN_PEERS;
2267   opc->state = OPC_STATE_INIT;
2268   opc->op = GNUNET_TESTBED_operation_create_ (opc, &opstart_shutdown_peers,
2269                                               &oprelease_shutdown_peers);
2270   GNUNET_TESTBED_operation_queue_insert_ (opc->c->opq_parallel_operations,
2271                                         opc->op);
2272   GNUNET_TESTBED_operation_begin_wait_ (opc->op);
2273   return opc->op;
2274 }
2275
2276
2277 /**
2278  * Return the index of the peer inside of the total peer array,
2279  * aka. the peer's "unique ID".
2280  *
2281  * @param peer Peer handle.
2282  *
2283  * @return The peer's unique ID.
2284  */
2285 uint32_t
2286 GNUNET_TESTBED_get_index (const struct GNUNET_TESTBED_Peer *peer)
2287 {
2288   return peer->unique_id;
2289 }
2290
2291
2292 /**
2293  * Remove a barrier and it was the last one in the barrier hash map, destroy the
2294  * hash map
2295  *
2296  * @param barrier the barrier to remove
2297  */
2298 void
2299 GNUNET_TESTBED_barrier_remove_ (struct GNUNET_TESTBED_Barrier *barrier)
2300 {
2301   struct GNUNET_TESTBED_Controller *c = barrier->c;
2302
2303   GNUNET_assert (NULL != c->barrier_map); /* No barriers present */
2304   GNUNET_assert (GNUNET_OK ==
2305                  GNUNET_CONTAINER_multihashmap_remove (c->barrier_map,
2306                                                        &barrier->key,
2307                                                        barrier));
2308   GNUNET_free (barrier->name);
2309   GNUNET_free (barrier);
2310   if (0 == GNUNET_CONTAINER_multihashmap_size (c->barrier_map))
2311   {
2312     GNUNET_CONTAINER_multihashmap_destroy (c->barrier_map);
2313     c->barrier_map = NULL;
2314   }
2315 }
2316
2317
2318 /**
2319  * Initialise a barrier and call the given callback when the required percentage
2320  * of peers (quorum) reach the barrier OR upon error.
2321  *
2322  * @param controller the handle to the controller
2323  * @param name identification name of the barrier
2324  * @param quorum the percentage of peers that is required to reach the barrier.
2325  *   Peers signal reaching a barrier by calling
2326  *   GNUNET_TESTBED_barrier_reached().
2327  * @param cb the callback to call when the barrier is reached or upon error.
2328  *   Cannot be NULL.
2329  * @param cls closure for the above callback
2330  * @param echo GNUNET_YES to echo the barrier crossed status message back to the
2331  *   controller
2332  * @return barrier handle; NULL upon error
2333  */
2334 struct GNUNET_TESTBED_Barrier *
2335 GNUNET_TESTBED_barrier_init_ (struct GNUNET_TESTBED_Controller *controller,
2336                               const char *name,
2337                               unsigned int quorum,
2338                               GNUNET_TESTBED_barrier_status_cb cb, void *cls,
2339                               int echo)
2340 {
2341   struct GNUNET_TESTBED_BarrierInit *msg;
2342   struct GNUNET_MQ_Envelope *env;
2343   struct GNUNET_TESTBED_Barrier *barrier;
2344   struct GNUNET_HashCode key;
2345   size_t name_len;
2346
2347   GNUNET_assert (quorum <= 100);
2348   GNUNET_assert (NULL != cb);
2349   name_len = strlen (name);
2350   GNUNET_assert (0 < name_len);
2351   GNUNET_CRYPTO_hash (name, name_len, &key);
2352   if (NULL == controller->barrier_map)
2353     controller->barrier_map = GNUNET_CONTAINER_multihashmap_create (3, GNUNET_YES);
2354   if (GNUNET_YES ==
2355       GNUNET_CONTAINER_multihashmap_contains (controller->barrier_map,
2356                                               &key))
2357   {
2358     GNUNET_break (0);
2359     return NULL;
2360   }
2361   LOG_DEBUG ("Initialising barrier `%s'\n", name);
2362   barrier = GNUNET_new (struct GNUNET_TESTBED_Barrier);
2363   barrier->c = controller;
2364   barrier->name = GNUNET_strdup (name);
2365   barrier->cb = cb;
2366   barrier->cls = cls;
2367   barrier->echo = echo;
2368   (void) memcpy (&barrier->key, &key, sizeof (struct GNUNET_HashCode));
2369   GNUNET_assert (GNUNET_OK ==
2370                  GNUNET_CONTAINER_multihashmap_put (controller->barrier_map,
2371                                                     &barrier->key,
2372                                                     barrier,
2373                                                     GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST));
2374
2375   env = GNUNET_MQ_msg_extra (msg,
2376                              name_len,
2377                              GNUNET_MESSAGE_TYPE_TESTBED_BARRIER_INIT);
2378   msg->quorum = (uint8_t) quorum;
2379   memcpy (msg->name,
2380           barrier->name,
2381           name_len);
2382   GNUNET_MQ_send (barrier->c->mq,
2383                   env);
2384   return barrier;
2385 }
2386
2387
2388 /**
2389  * Initialise a barrier and call the given callback when the required percentage
2390  * of peers (quorum) reach the barrier OR upon error.
2391  *
2392  * @param controller the handle to the controller
2393  * @param name identification name of the barrier
2394  * @param quorum the percentage of peers that is required to reach the barrier.
2395  *   Peers signal reaching a barrier by calling
2396  *   GNUNET_TESTBED_barrier_reached().
2397  * @param cb the callback to call when the barrier is reached or upon error.
2398  *   Cannot be NULL.
2399  * @param cls closure for the above callback
2400  * @return barrier handle; NULL upon error
2401  */
2402 struct GNUNET_TESTBED_Barrier *
2403 GNUNET_TESTBED_barrier_init (struct GNUNET_TESTBED_Controller *controller,
2404                              const char *name,
2405                              unsigned int quorum,
2406                              GNUNET_TESTBED_barrier_status_cb cb, void *cls)
2407 {
2408   return GNUNET_TESTBED_barrier_init_ (controller,
2409                                        name, quorum, cb, cls, GNUNET_YES);
2410 }
2411
2412
2413 /**
2414  * Cancel a barrier.
2415  *
2416  * @param barrier the barrier handle
2417  */
2418 void
2419 GNUNET_TESTBED_barrier_cancel (struct GNUNET_TESTBED_Barrier *barrier)
2420 {
2421   struct GNUNET_MQ_Envelope *env;
2422   struct GNUNET_TESTBED_BarrierCancel *msg;
2423   size_t slen;
2424
2425   slen = strlen (barrier->name);
2426   env = GNUNET_MQ_msg_extra (msg,
2427                              slen,
2428                              GNUNET_MESSAGE_TYPE_TESTBED_BARRIER_CANCEL);
2429   memcpy (msg->name,
2430           barrier->name,
2431           slen);
2432   GNUNET_MQ_send (barrier->c->mq,
2433                   env);
2434   GNUNET_TESTBED_barrier_remove_ (barrier);
2435 }
2436
2437
2438 /* end of testbed_api.c */