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     GNUNET_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     GNUNET_memcpy (emsg,
1147                    &msg[1],
1148                    ntohs (msg->header.size)- sizeof (struct 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   if (msize <= sizeof (struct GNUNET_TESTBED_BarrierStatusMsg))
1246   {
1247     GNUNET_break_op (0);
1248     goto cleanup;
1249   }
1250   name = msg->data;
1251   name_len = ntohs (msg->name_len);
1252   if (name_len >=  //name_len is strlen(barrier_name)
1253       (msize - ((sizeof msg->header) + sizeof (msg->status)) )   )
1254   {
1255     GNUNET_break_op (0);
1256     goto cleanup;
1257   }
1258   if ('\0' != name[name_len])
1259   {
1260     GNUNET_break_op (0);
1261     goto cleanup;
1262   }
1263   LOG_DEBUG ("Received BARRIER_STATUS msg\n");
1264   status = ntohs (msg->status);
1265   if (GNUNET_TESTBED_BARRIERSTATUS_ERROR == status)
1266   {
1267     status = -1;
1268     //unlike name_len, emsg_len includes the trailing zero
1269     emsg_len = msize - (sizeof (struct GNUNET_TESTBED_BarrierStatusMsg)
1270                         + (name_len + 1));
1271     if (0 == emsg_len)
1272     {
1273       GNUNET_break_op (0);
1274       goto cleanup;
1275     }
1276     if ('\0' != (msg->data[(name_len + 1) + (emsg_len - 1)]))
1277     {
1278       GNUNET_break_op (0);
1279       goto cleanup;
1280     }
1281     emsg = GNUNET_malloc (emsg_len);
1282     GNUNET_memcpy (emsg,
1283                    msg->data + name_len + 1,
1284                    emsg_len);
1285   }
1286   if (NULL == c->barrier_map)
1287   {
1288     GNUNET_break_op (0);
1289     goto cleanup;
1290   }
1291   GNUNET_CRYPTO_hash (name, name_len, &key);
1292   barrier = GNUNET_CONTAINER_multihashmap_get (c->barrier_map, &key);
1293   if (NULL == barrier)
1294   {
1295     GNUNET_break_op (0);
1296     goto cleanup;
1297   }
1298   GNUNET_assert (NULL != barrier->cb);
1299   if ((GNUNET_YES == barrier->echo) &&
1300       (GNUNET_TESTBED_BARRIERSTATUS_CROSSED == status))
1301     GNUNET_TESTBED_queue_message_ (c, GNUNET_copy_message (&msg->header));
1302   barrier->cb (barrier->cls, name, barrier, status, emsg);
1303   if (GNUNET_TESTBED_BARRIERSTATUS_INITIALISED == status)
1304     return;           /* just initialised; skip cleanup */
1305
1306  cleanup:
1307   GNUNET_free_non_null (emsg);
1308   if (NULL != barrier)
1309     GNUNET_TESTBED_barrier_remove_ (barrier);
1310 }
1311
1312
1313 /**
1314  * Queues a message in send queue for sending to the service
1315  *
1316  * @param controller the handle to the controller
1317  * @param msg the message to queue
1318  */
1319 void
1320 GNUNET_TESTBED_queue_message_ (struct GNUNET_TESTBED_Controller *controller,
1321                                struct GNUNET_MessageHeader *msg)
1322 {
1323   struct GNUNET_MQ_Envelope *env;
1324   struct GNUNET_MessageHeader *m2;
1325   uint16_t type;
1326   uint16_t size;
1327
1328   type = ntohs (msg->type);
1329   size = ntohs (msg->size);
1330   GNUNET_assert ((GNUNET_MESSAGE_TYPE_TESTBED_INIT <= type) &&
1331                  (GNUNET_MESSAGE_TYPE_TESTBED_MAX > type));
1332   env = GNUNET_MQ_msg_extra (m2,
1333                              size - sizeof (*m2),
1334                              type);
1335   GNUNET_memcpy (m2, msg, size);
1336   GNUNET_free (msg);
1337   GNUNET_MQ_send (controller->mq,
1338                   env);
1339 }
1340
1341
1342 /**
1343  * Sends the given message as an operation. The given callback is called when a
1344  * reply for the operation is available.  Call
1345  * GNUNET_TESTBED_forward_operation_msg_cancel_() to cleanup the returned
1346  * operation context if the cc hasn't been called
1347  *
1348  * @param controller the controller to which the message has to be sent
1349  * @param operation_id the operation id of the message
1350  * @param msg the message to send
1351  * @param cc the callback to call when reply is available
1352  * @param cc_cls the closure for the above callback
1353  * @return the operation context which can be used to cancel the forwarded
1354  *           operation
1355  */
1356 struct OperationContext *
1357 GNUNET_TESTBED_forward_operation_msg_ (struct GNUNET_TESTBED_Controller *controller,
1358                                        uint64_t operation_id,
1359                                        const struct GNUNET_MessageHeader *msg,
1360                                        GNUNET_CLIENT_MessageHandler cc,
1361                                        void *cc_cls)
1362 {
1363   struct OperationContext *opc;
1364   struct ForwardedOperationData *data;
1365   struct GNUNET_MQ_Envelope *env;
1366   struct GNUNET_MessageHeader *m2;
1367   uint16_t type = ntohs (msg->type);
1368   uint16_t size = ntohs (msg->size);
1369
1370   env = GNUNET_MQ_msg_extra (m2,
1371                              size - sizeof (*m2),
1372                              type);
1373   GNUNET_memcpy (m2,
1374                  msg,
1375                  size);
1376   GNUNET_MQ_send (controller->mq,
1377                   env);
1378   data = GNUNET_new (struct ForwardedOperationData);
1379   data->cc = cc;
1380   data->cc_cls = cc_cls;
1381   opc = GNUNET_new (struct OperationContext);
1382   opc->c = controller;
1383   opc->type = OP_FORWARDED;
1384   opc->data = data;
1385   opc->id = operation_id;
1386   GNUNET_TESTBED_insert_opc_ (controller,
1387                               opc);
1388   return opc;
1389 }
1390
1391
1392 /**
1393  * Function to cancel an operation created by simply forwarding an operation
1394  * message.
1395  *
1396  * @param opc the operation context from GNUNET_TESTBED_forward_operation_msg_()
1397  */
1398 void
1399 GNUNET_TESTBED_forward_operation_msg_cancel_ (struct OperationContext *opc)
1400 {
1401   GNUNET_TESTBED_remove_opc_ (opc->c,
1402                               opc);
1403   GNUNET_free (opc->data);
1404   GNUNET_free (opc);
1405 }
1406
1407
1408 /**
1409  * Function to call to start a link-controllers type operation once all queues
1410  * the operation is part of declare that the operation can be activated.
1411  *
1412  * @param cls the closure from GNUNET_TESTBED_operation_create_()
1413  */
1414 static void
1415 opstart_link_controllers (void *cls)
1416 {
1417   struct OperationContext *opc = cls;
1418   struct ControllerLinkData *data;
1419   struct GNUNET_TESTBED_ControllerLinkRequest *msg;
1420
1421   GNUNET_assert (NULL != opc->data);
1422   data = opc->data;
1423   msg = data->msg;
1424   data->msg = NULL;
1425   opc->state = OPC_STATE_STARTED;
1426   GNUNET_TESTBED_insert_opc_ (opc->c, opc);
1427   GNUNET_TESTBED_queue_message_ (opc->c, &msg->header);
1428 }
1429
1430
1431 /**
1432  * Callback which will be called when link-controllers type operation is released
1433  *
1434  * @param cls the closure from GNUNET_TESTBED_operation_create_()
1435  */
1436 static void
1437 oprelease_link_controllers (void *cls)
1438 {
1439   struct OperationContext *opc = cls;
1440   struct ControllerLinkData *data;
1441
1442   data = opc->data;
1443   switch (opc->state)
1444   {
1445   case OPC_STATE_INIT:
1446     GNUNET_free (data->msg);
1447     break;
1448   case OPC_STATE_STARTED:
1449     GNUNET_TESTBED_remove_opc_ (opc->c, opc);
1450     break;
1451   case OPC_STATE_FINISHED:
1452     break;
1453   }
1454   GNUNET_free_non_null (data);
1455   GNUNET_free (opc);
1456 }
1457
1458
1459 /**
1460  * Function to be called when get slave config operation is ready
1461  *
1462  * @param cls the OperationContext of type OP_GET_SLAVE_CONFIG
1463  */
1464 static void
1465 opstart_get_slave_config (void *cls)
1466 {
1467   struct OperationContext *opc = cls;
1468   struct GetSlaveConfigData *data = opc->data;
1469   struct GNUNET_TESTBED_SlaveGetConfigurationMessage *msg;
1470
1471   GNUNET_assert (NULL != data);
1472   msg = GNUNET_TESTBED_generate_slavegetconfig_msg_ (opc->id, data->slave_id);
1473   GNUNET_free (opc->data);
1474   data = NULL;
1475   opc->data = NULL;
1476   GNUNET_TESTBED_insert_opc_ (opc->c, opc);
1477   GNUNET_TESTBED_queue_message_ (opc->c, &msg->header);
1478   opc->state = OPC_STATE_STARTED;
1479 }
1480
1481
1482 /**
1483  * Function to be called when get slave config operation is cancelled or finished
1484  *
1485  * @param cls the OperationContext of type OP_GET_SLAVE_CONFIG
1486  */
1487 static void
1488 oprelease_get_slave_config (void *cls)
1489 {
1490   struct OperationContext *opc = cls;
1491
1492   switch (opc->state)
1493   {
1494   case OPC_STATE_INIT:
1495     GNUNET_free (opc->data);
1496     break;
1497   case OPC_STATE_STARTED:
1498     GNUNET_TESTBED_remove_opc_ (opc->c, opc);
1499     break;
1500   case OPC_STATE_FINISHED:
1501     if (NULL != opc->data)
1502       GNUNET_CONFIGURATION_destroy (opc->data);
1503     break;
1504   }
1505   GNUNET_free (opc);
1506 }
1507
1508
1509 /**
1510  * Generic error handler, called with the appropriate error code and
1511  * the same closure specified at the creation of the message queue.
1512  * Not every message queue implementation supports an error handler.
1513  *
1514  * @param cls closure, a `struct GNUNET_TESTBED_Controller *`
1515  * @param error error code
1516  */
1517 static void
1518 mq_error_handler (void *cls,
1519                   enum GNUNET_MQ_Error error)
1520 {
1521   /* struct GNUNET_TESTBED_Controller *c = cls; */
1522
1523   GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1524               "Encountered MQ error: %d\n",
1525               error);
1526   /* now what? */
1527   GNUNET_SCHEDULER_shutdown (); /* seems most reasonable */
1528 }
1529
1530
1531 /**
1532  * Start a controller process using the given configuration at the
1533  * given host.
1534  *
1535  * @param host host to run the controller on; This should be the same host if
1536  *          the controller was previously started with
1537  *          GNUNET_TESTBED_controller_start()
1538  * @param event_mask bit mask with set of events to call 'cc' for;
1539  *                   or-ed values of "1LL" shifted by the
1540  *                   respective 'enum GNUNET_TESTBED_EventType'
1541  *                   (i.e.  "(1LL << GNUNET_TESTBED_ET_CONNECT) | ...")
1542  * @param cc controller callback to invoke on events
1543  * @param cc_cls closure for cc
1544  * @return handle to the controller
1545  */
1546 struct GNUNET_TESTBED_Controller *
1547 GNUNET_TESTBED_controller_connect (struct GNUNET_TESTBED_Host *host,
1548                                    uint64_t event_mask,
1549                                    GNUNET_TESTBED_ControllerCallback cc,
1550                                    void *cc_cls)
1551 {
1552   struct GNUNET_TESTBED_Controller *controller
1553     = GNUNET_new (struct GNUNET_TESTBED_Controller);
1554   struct GNUNET_MQ_MessageHandler handlers[] = {
1555     GNUNET_MQ_hd_var_size (add_host_confirm,
1556                            GNUNET_MESSAGE_TYPE_TESTBED_ADD_HOST_SUCCESS,
1557                            struct GNUNET_TESTBED_HostConfirmedMessage,
1558                            controller),
1559     GNUNET_MQ_hd_fixed_size (peer_conevent,
1560                              GNUNET_MESSAGE_TYPE_TESTBED_PEER_CONNECT_EVENT,
1561                              struct GNUNET_TESTBED_ConnectionEventMessage,
1562                              controller),
1563     GNUNET_MQ_hd_fixed_size (opsuccess,
1564                              GNUNET_MESSAGE_TYPE_TESTBED_GENERIC_OPERATION_SUCCESS,
1565                              struct GNUNET_TESTBED_GenericOperationSuccessEventMessage,
1566                              controller),
1567     GNUNET_MQ_hd_var_size (op_fail_event,
1568                            GNUNET_MESSAGE_TYPE_TESTBED_OPERATION_FAIL_EVENT,
1569                            struct GNUNET_TESTBED_OperationFailureEventMessage,
1570                            controller),
1571     GNUNET_MQ_hd_fixed_size (peer_create_success,
1572                              GNUNET_MESSAGE_TYPE_TESTBED_CREATE_PEER_SUCCESS,
1573                              struct GNUNET_TESTBED_PeerCreateSuccessEventMessage,
1574                              controller),
1575     GNUNET_MQ_hd_fixed_size (peer_event,
1576                              GNUNET_MESSAGE_TYPE_TESTBED_PEER_EVENT,
1577                              struct GNUNET_TESTBED_PeerEventMessage,
1578                              controller),
1579     GNUNET_MQ_hd_var_size (peer_config,
1580                            GNUNET_MESSAGE_TYPE_TESTBED_PEER_INFORMATION,
1581                            struct GNUNET_TESTBED_PeerConfigurationInformationMessage,
1582                            controller),
1583     GNUNET_MQ_hd_var_size (slave_config,
1584                            GNUNET_MESSAGE_TYPE_TESTBED_SLAVE_CONFIGURATION,
1585                            struct GNUNET_TESTBED_SlaveConfiguration,
1586                            controller),
1587     GNUNET_MQ_hd_var_size (link_controllers_result,
1588                            GNUNET_MESSAGE_TYPE_TESTBED_LINK_CONTROLLERS_RESULT,
1589                            struct GNUNET_TESTBED_ControllerLinkResponse,
1590                            controller),
1591     GNUNET_MQ_hd_var_size (barrier_status,
1592                            GNUNET_MESSAGE_TYPE_TESTBED_BARRIER_STATUS,
1593                            const struct GNUNET_TESTBED_BarrierStatusMsg,
1594                            controller),
1595     GNUNET_MQ_handler_end ()
1596   };
1597   struct GNUNET_TESTBED_InitMessage *msg;
1598   struct GNUNET_MQ_Envelope *env;
1599   const struct GNUNET_CONFIGURATION_Handle *cfg;
1600   const char *controller_hostname;
1601   unsigned long long max_parallel_operations;
1602   unsigned long long max_parallel_service_connections;
1603   unsigned long long max_parallel_topology_config_operations;
1604   size_t slen;
1605
1606   GNUNET_assert (NULL != (cfg = GNUNET_TESTBED_host_get_cfg_ (host)));
1607   if (GNUNET_OK !=
1608       GNUNET_CONFIGURATION_get_value_number (cfg, "testbed",
1609                                              "MAX_PARALLEL_OPERATIONS",
1610                                              &max_parallel_operations))
1611   {
1612     GNUNET_break (0);
1613     GNUNET_free (controller);
1614     return NULL;
1615   }
1616   if (GNUNET_OK !=
1617       GNUNET_CONFIGURATION_get_value_number (cfg, "testbed",
1618                                              "MAX_PARALLEL_SERVICE_CONNECTIONS",
1619                                              &max_parallel_service_connections))
1620   {
1621     GNUNET_break (0);
1622     GNUNET_free (controller);
1623     return NULL;
1624   }
1625   if (GNUNET_OK !=
1626       GNUNET_CONFIGURATION_get_value_number (cfg, "testbed",
1627                                              "MAX_PARALLEL_TOPOLOGY_CONFIG_OPERATIONS",
1628                                              &max_parallel_topology_config_operations))
1629   {
1630     GNUNET_break (0);
1631     GNUNET_free (controller);
1632     return NULL;
1633   }
1634   controller->cc = cc;
1635   controller->cc_cls = cc_cls;
1636   controller->event_mask = event_mask;
1637   controller->cfg = GNUNET_CONFIGURATION_dup (cfg);
1638   controller->mq = GNUNET_CLIENT_connecT (controller->cfg,
1639                                           "testbed",
1640                                           handlers,
1641                                           &mq_error_handler,
1642                                           controller);
1643   if (NULL == controller->mq)
1644   {
1645     GNUNET_break (0);
1646     GNUNET_TESTBED_controller_disconnect (controller);
1647     return NULL;
1648   }
1649   GNUNET_TESTBED_mark_host_registered_at_ (host, controller);
1650   controller->host = host;
1651   controller->opq_parallel_operations =
1652       GNUNET_TESTBED_operation_queue_create_ (OPERATION_QUEUE_TYPE_FIXED,
1653                                               (unsigned int) max_parallel_operations);
1654   controller->opq_parallel_service_connections =
1655       GNUNET_TESTBED_operation_queue_create_ (OPERATION_QUEUE_TYPE_FIXED,
1656                                               (unsigned int)
1657                                               max_parallel_service_connections);
1658   controller->opq_parallel_topology_config_operations =
1659       GNUNET_TESTBED_operation_queue_create_ (OPERATION_QUEUE_TYPE_FIXED,
1660                                               (unsigned int)
1661                                               max_parallel_topology_config_operations);
1662   controller_hostname = GNUNET_TESTBED_host_get_hostname (host);
1663   if (NULL == controller_hostname)
1664     controller_hostname = "127.0.0.1";
1665   slen = strlen (controller_hostname) + 1;
1666   env = GNUNET_MQ_msg_extra (msg,
1667                              slen,
1668                              GNUNET_MESSAGE_TYPE_TESTBED_INIT);
1669   msg->host_id = htonl (GNUNET_TESTBED_host_get_id_ (host));
1670   msg->event_mask = GNUNET_htonll (controller->event_mask);
1671   GNUNET_memcpy (&msg[1],
1672                  controller_hostname,
1673                  slen);
1674   GNUNET_MQ_send (controller->mq,
1675                   env);
1676   return controller;
1677 }
1678
1679
1680 /**
1681  * Iterator to free opc map entries
1682  *
1683  * @param cls closure
1684  * @param key current key code
1685  * @param value value in the hash map
1686  * @return #GNUNET_YES if we should continue to iterate,
1687  *         #GNUNET_NO if not.
1688  */
1689 static int
1690 opc_free_iterator (void *cls, uint32_t key, void *value)
1691 {
1692   struct GNUNET_CONTAINER_MultiHashMap32 *map = cls;
1693   struct OperationContext *opc = value;
1694
1695   GNUNET_assert (NULL != opc);
1696   GNUNET_break (0);
1697   GNUNET_assert (GNUNET_YES ==
1698                  GNUNET_CONTAINER_multihashmap32_remove (map, key, value));
1699   GNUNET_free (opc);
1700   return GNUNET_YES;
1701 }
1702
1703
1704 /**
1705  * Stop the given controller (also will terminate all peers and
1706  * controllers dependent on this controller).  This function
1707  * blocks until the testbed has been fully terminated (!).
1708  *
1709  * @param c handle to controller to stop
1710  */
1711 void
1712 GNUNET_TESTBED_controller_disconnect (struct GNUNET_TESTBED_Controller *c)
1713 {
1714   if (NULL != c->mq)
1715   {
1716     GNUNET_MQ_destroy (c->mq);
1717     c->mq = NULL;
1718   }
1719   if (NULL != c->host)
1720     GNUNET_TESTBED_deregister_host_at_ (c->host, c);
1721   GNUNET_CONFIGURATION_destroy (c->cfg);
1722   GNUNET_TESTBED_operation_queue_destroy_ (c->opq_parallel_operations);
1723   GNUNET_TESTBED_operation_queue_destroy_
1724       (c->opq_parallel_service_connections);
1725   GNUNET_TESTBED_operation_queue_destroy_
1726       (c->opq_parallel_topology_config_operations);
1727   if (NULL != c->opc_map)
1728   {
1729     GNUNET_assert (GNUNET_SYSERR !=
1730                    GNUNET_CONTAINER_multihashmap32_iterate (c->opc_map,
1731                                                             &opc_free_iterator,
1732                                                             c->opc_map));
1733     GNUNET_assert (0 == GNUNET_CONTAINER_multihashmap32_size (c->opc_map));
1734     GNUNET_CONTAINER_multihashmap32_destroy (c->opc_map);
1735   }
1736   GNUNET_free (c);
1737 }
1738
1739
1740 /**
1741  * Compresses given configuration using zlib compress
1742  *
1743  * @param config the serialized configuration
1744  * @param size the size of config
1745  * @param xconfig will be set to the compressed configuration (memory is fresly
1746  *          allocated)
1747  * @return the size of the xconfig
1748  */
1749 size_t
1750 GNUNET_TESTBED_compress_config_ (const char *config,
1751                                  size_t size,
1752                                  char **xconfig)
1753 {
1754   size_t xsize;
1755
1756   xsize = compressBound ((uLong) size);
1757   *xconfig = GNUNET_malloc (xsize);
1758   GNUNET_assert (Z_OK ==
1759                  compress2 ((Bytef *) * xconfig, (uLongf *) & xsize,
1760                             (const Bytef *) config, (uLongf) size,
1761                             Z_BEST_SPEED));
1762   return xsize;
1763 }
1764
1765
1766 /**
1767  * Function to serialize and compress using zlib a configuration through a
1768  * configuration handle
1769  *
1770  * @param cfg the configuration
1771  * @param size the size of configuration when serialize.  Will be set on success.
1772  * @param xsize the sizeo of the compressed configuration.  Will be set on success.
1773  * @return the serialized and compressed configuration
1774  */
1775 char *
1776 GNUNET_TESTBED_compress_cfg_ (const struct GNUNET_CONFIGURATION_Handle *cfg,
1777                               size_t *size, size_t *xsize)
1778 {
1779   char *config;
1780   char *xconfig;
1781   size_t size_;
1782   size_t xsize_;
1783
1784   config = GNUNET_CONFIGURATION_serialize (cfg, &size_);
1785   xsize_ = GNUNET_TESTBED_compress_config_ (config, size_, &xconfig);
1786   GNUNET_free (config);
1787   *size = size_;
1788   *xsize = xsize_;
1789   return xconfig;
1790 }
1791
1792
1793 /**
1794  * Create a link from slave controller to delegated controller. Whenever the
1795  * master controller is asked to start a peer at the delegated controller the
1796  * request will be routed towards slave controller (if a route exists). The
1797  * slave controller will then route it to the delegated controller. The
1798  * configuration of the delegated controller is given and is used to either
1799  * create the delegated controller or to connect to an existing controller. Note
1800  * that while starting the delegated controller the configuration will be
1801  * modified to accommodate available free ports.  the 'is_subordinate' specifies
1802  * if the given delegated controller should be started and managed by the slave
1803  * controller, or if the delegated controller already has a master and the slave
1804  * controller connects to it as a non master controller. The success or failure
1805  * of this operation will be signalled through the
1806  * GNUNET_TESTBED_ControllerCallback() with an event of type
1807  * GNUNET_TESTBED_ET_OPERATION_FINISHED
1808  *
1809  * @param op_cls the operation closure for the event which is generated to
1810  *          signal success or failure of this operation
1811  * @param master handle to the master controller who creates the association
1812  * @param delegated_host requests to which host should be delegated; cannot be NULL
1813  * @param slave_host which host is used to run the slave controller; use NULL to
1814  *          make the master controller connect to the delegated host
1815  * @param is_subordinate GNUNET_YES if the controller at delegated_host should
1816  *          be started by the slave controller; GNUNET_NO if the slave
1817  *          controller has to connect to the already started delegated
1818  *          controller via TCP/IP
1819  * @return the operation handle
1820  */
1821 struct GNUNET_TESTBED_Operation *
1822 GNUNET_TESTBED_controller_link (void *op_cls,
1823                                 struct GNUNET_TESTBED_Controller *master,
1824                                 struct GNUNET_TESTBED_Host *delegated_host,
1825                                 struct GNUNET_TESTBED_Host *slave_host,
1826                                 int is_subordinate)
1827 {
1828   struct OperationContext *opc;
1829   struct GNUNET_TESTBED_ControllerLinkRequest *msg;
1830   struct ControllerLinkData *data;
1831   uint32_t slave_host_id;
1832   uint32_t delegated_host_id;
1833   uint16_t msg_size;
1834
1835   GNUNET_assert (GNUNET_YES ==
1836                  GNUNET_TESTBED_is_host_registered_ (delegated_host, master));
1837   slave_host_id =
1838       GNUNET_TESTBED_host_get_id_ ((NULL !=
1839                                     slave_host) ? slave_host : master->host);
1840   delegated_host_id = GNUNET_TESTBED_host_get_id_ (delegated_host);
1841   if ((NULL != slave_host) && (0 != slave_host_id))
1842     GNUNET_assert (GNUNET_YES ==
1843                    GNUNET_TESTBED_is_host_registered_ (slave_host, master));
1844   msg_size = sizeof (struct GNUNET_TESTBED_ControllerLinkRequest);
1845   msg = GNUNET_malloc (msg_size);
1846   msg->header.type = htons (GNUNET_MESSAGE_TYPE_TESTBED_LINK_CONTROLLERS);
1847   msg->header.size = htons (msg_size);
1848   msg->delegated_host_id = htonl (delegated_host_id);
1849   msg->slave_host_id = htonl (slave_host_id);
1850   msg->is_subordinate = (GNUNET_YES == is_subordinate) ? 1 : 0;
1851   data = GNUNET_new (struct ControllerLinkData);
1852   data->msg = msg;
1853   data->host_id = delegated_host_id;
1854   opc = GNUNET_new (struct OperationContext);
1855   opc->c = master;
1856   opc->data = data;
1857   opc->type = OP_LINK_CONTROLLERS;
1858   opc->id = GNUNET_TESTBED_get_next_op_id (opc->c);
1859   opc->state = OPC_STATE_INIT;
1860   opc->op_cls = op_cls;
1861   msg->operation_id = GNUNET_htonll (opc->id);
1862   opc->op =
1863       GNUNET_TESTBED_operation_create_ (opc, &opstart_link_controllers,
1864                                         &oprelease_link_controllers);
1865   GNUNET_TESTBED_operation_queue_insert_ (master->opq_parallel_operations,
1866                                           opc->op);
1867   GNUNET_TESTBED_operation_begin_wait_ (opc->op);
1868   return opc->op;
1869 }
1870
1871
1872 /**
1873  * Like GNUNET_TESTBED_get_slave_config(), however without the host registration
1874  * check. Another difference is that this function takes the id of the slave
1875  * host.
1876  *
1877  * @param op_cls the closure for the operation
1878  * @param master the handle to master controller
1879  * @param slave_host_id id of the host where the slave controller is running to
1880  *          the slave_host should remain valid until this operation is cancelled
1881  *          or marked as finished
1882  * @return the operation handle;
1883  */
1884 struct GNUNET_TESTBED_Operation *
1885 GNUNET_TESTBED_get_slave_config_ (void *op_cls,
1886                                   struct GNUNET_TESTBED_Controller *master,
1887                                   uint32_t slave_host_id)
1888 {
1889   struct OperationContext *opc;
1890   struct GetSlaveConfigData *data;
1891
1892   data = GNUNET_new (struct GetSlaveConfigData);
1893   data->slave_id = slave_host_id;
1894   opc = GNUNET_new (struct OperationContext);
1895   opc->state = OPC_STATE_INIT;
1896   opc->c = master;
1897   opc->id = GNUNET_TESTBED_get_next_op_id (master);
1898   opc->type = OP_GET_SLAVE_CONFIG;
1899   opc->data = data;
1900   opc->op_cls = op_cls;
1901   opc->op =
1902       GNUNET_TESTBED_operation_create_ (opc, &opstart_get_slave_config,
1903                                         &oprelease_get_slave_config);
1904   GNUNET_TESTBED_operation_queue_insert_ (master->opq_parallel_operations,
1905                                           opc->op);
1906   GNUNET_TESTBED_operation_begin_wait_ (opc->op);
1907   return opc->op;
1908 }
1909
1910
1911 /**
1912  * Function to acquire the configuration of a running slave controller. The
1913  * completion of the operation is signalled through the controller_cb from
1914  * GNUNET_TESTBED_controller_connect(). If the operation is successful the
1915  * handle to the configuration is available in the generic pointer of
1916  * operation_finished field of struct GNUNET_TESTBED_EventInformation.
1917  *
1918  * @param op_cls the closure for the operation
1919  * @param master the handle to master controller
1920  * @param slave_host the host where the slave controller is running; the handle
1921  *          to the slave_host should remain valid until this operation is
1922  *          cancelled or marked as finished
1923  * @return the operation handle; NULL if the slave_host is not registered at
1924  *           master
1925  */
1926 struct GNUNET_TESTBED_Operation *
1927 GNUNET_TESTBED_get_slave_config (void *op_cls,
1928                                  struct GNUNET_TESTBED_Controller *master,
1929                                  struct GNUNET_TESTBED_Host *slave_host)
1930 {
1931   if (GNUNET_NO == GNUNET_TESTBED_is_host_registered_ (slave_host, master))
1932     return NULL;
1933   return GNUNET_TESTBED_get_slave_config_ (op_cls, master,
1934                                            GNUNET_TESTBED_host_get_id_
1935                                            (slave_host));
1936 }
1937
1938
1939 /**
1940  * Ask the testbed controller to write the current overlay topology to
1941  * a file.  Naturally, the file will only contain a snapshot as the
1942  * topology may evolve all the time.
1943  *
1944  * @param controller overlay controller to inspect
1945  * @param filename name of the file the topology should
1946  *        be written to.
1947  */
1948 void
1949 GNUNET_TESTBED_overlay_write_topology_to_file (struct GNUNET_TESTBED_Controller
1950                                                *controller,
1951                                                const char *filename)
1952 {
1953   GNUNET_break (0);
1954 }
1955
1956
1957 /**
1958  * Creates a helper initialization message. This function is here because we
1959  * want to use this in testing
1960  *
1961  * @param trusted_ip the ip address of the controller which will be set as TRUSTED
1962  *          HOST(all connections form this ip are permitted by the testbed) when
1963  *          starting testbed controller at host. This can either be a single ip
1964  *          address or a network address in CIDR notation.
1965  * @param hostname the hostname of the destination this message is intended for
1966  * @param cfg the configuration that has to used to start the testbed service
1967  *          thru helper
1968  * @return the initialization message
1969  */
1970 struct GNUNET_TESTBED_HelperInit *
1971 GNUNET_TESTBED_create_helper_init_msg_ (const char *trusted_ip,
1972                                         const char *hostname,
1973                                         const struct GNUNET_CONFIGURATION_Handle
1974                                         *cfg)
1975 {
1976   struct GNUNET_TESTBED_HelperInit *msg;
1977   char *config;
1978   char *xconfig;
1979   size_t config_size;
1980   size_t xconfig_size;
1981   uint16_t trusted_ip_len;
1982   uint16_t hostname_len;
1983   uint16_t msg_size;
1984
1985   config = GNUNET_CONFIGURATION_serialize (cfg, &config_size);
1986   GNUNET_assert (NULL != config);
1987   xconfig_size =
1988       GNUNET_TESTBED_compress_config_ (config, config_size, &xconfig);
1989   GNUNET_free (config);
1990   trusted_ip_len = strlen (trusted_ip);
1991   hostname_len = (NULL == hostname) ? 0 : strlen (hostname);
1992   msg_size =
1993       xconfig_size + trusted_ip_len + 1 +
1994       sizeof (struct GNUNET_TESTBED_HelperInit);
1995   msg_size += hostname_len;
1996   msg = GNUNET_realloc (xconfig, msg_size);
1997   (void) memmove (((void *) &msg[1]) + trusted_ip_len + 1 + hostname_len, msg,
1998                   xconfig_size);
1999   msg->header.size = htons (msg_size);
2000   msg->header.type = htons (GNUNET_MESSAGE_TYPE_TESTBED_HELPER_INIT);
2001   msg->trusted_ip_size = htons (trusted_ip_len);
2002   msg->hostname_size = htons (hostname_len);
2003   msg->config_size = htons (config_size);
2004   (void) strcpy ((char *) &msg[1], trusted_ip);
2005   if (0 != hostname_len)
2006     (void) strncpy (((char *) &msg[1]) + trusted_ip_len + 1, hostname,
2007                     hostname_len);
2008   return msg;
2009 }
2010
2011
2012 /**
2013  * This function is used to signal that the event information (struct
2014  * GNUNET_TESTBED_EventInformation) from an operation has been fully processed
2015  * i.e. if the event callback is ever called for this operation. If the event
2016  * callback for this operation has not yet been called, calling this function
2017  * cancels the operation, frees its resources and ensures the no event is
2018  * generated with respect to this operation. Note that however cancelling an
2019  * operation does NOT guarantee that the operation will be fully undone (or that
2020  * nothing ever happened).
2021  *
2022  * This function MUST be called for every operation to fully remove the
2023  * operation from the operation queue.  After calling this function, if
2024  * operation is completed and its event information is of type
2025  * GNUNET_TESTBED_ET_OPERATION_FINISHED, the 'op_result' becomes invalid (!).
2026
2027  * If the operation is generated from GNUNET_TESTBED_service_connect() then
2028  * calling this function on such as operation calls the disconnect adapter if
2029  * the connect adapter was ever called.
2030  *
2031  * @param operation operation to signal completion or cancellation
2032  */
2033 void
2034 GNUNET_TESTBED_operation_done (struct GNUNET_TESTBED_Operation *operation)
2035 {
2036   (void) exop_check (operation);
2037   GNUNET_TESTBED_operation_release_ (operation);
2038 }
2039
2040
2041 /**
2042  * Generates configuration by uncompressing configuration in given message. The
2043  * given message should be of the following types:
2044  * #GNUNET_MESSAGE_TYPE_TESTBED_PEER_INFORMATION,
2045  * #GNUNET_MESSAGE_TYPE_TESTBED_SLAVE_CONFIGURATION,
2046  * #GNUNET_MESSAGE_TYPE_TESTBED_ADD_HOST,
2047  * #GNUNET_MESSAGE_TYPE_TESTBED_LINK_CONTROLLERS,
2048  * #GNUNET_MESSAGE_TYPE_TESTBED_LINK_CONTROLLERS_RESULT,
2049  *
2050  * FIXME: This API is incredibly ugly.
2051  *
2052  * @param msg the message containing compressed configuration
2053  * @return handle to the parsed configuration; NULL upon error while parsing the message
2054  */
2055 struct GNUNET_CONFIGURATION_Handle *
2056 GNUNET_TESTBED_extract_config_ (const struct GNUNET_MessageHeader *msg)
2057 {
2058   struct GNUNET_CONFIGURATION_Handle *cfg;
2059   Bytef *data;
2060   const Bytef *xdata;
2061   uLong data_len;
2062   uLong xdata_len;
2063   int ret;
2064
2065   switch (ntohs (msg->type))
2066   {
2067   case GNUNET_MESSAGE_TYPE_TESTBED_PEER_INFORMATION:
2068   {
2069     const struct GNUNET_TESTBED_PeerConfigurationInformationMessage *imsg;
2070
2071     imsg =
2072         (const struct GNUNET_TESTBED_PeerConfigurationInformationMessage *) msg;
2073     data_len = (uLong) ntohs (imsg->config_size);
2074     xdata_len =
2075         ntohs (imsg->header.size) -
2076         sizeof (struct GNUNET_TESTBED_PeerConfigurationInformationMessage);
2077     xdata = (const Bytef *) &imsg[1];
2078   }
2079     break;
2080   case GNUNET_MESSAGE_TYPE_TESTBED_SLAVE_CONFIGURATION:
2081   {
2082     const struct GNUNET_TESTBED_SlaveConfiguration *imsg;
2083
2084     imsg = (const struct GNUNET_TESTBED_SlaveConfiguration *) msg;
2085     data_len = (uLong) ntohs (imsg->config_size);
2086     xdata_len =
2087         ntohs (imsg->header.size) -
2088         sizeof (struct GNUNET_TESTBED_SlaveConfiguration);
2089     xdata = (const Bytef *) &imsg[1];
2090   }
2091   break;
2092   case GNUNET_MESSAGE_TYPE_TESTBED_ADD_HOST:
2093     {
2094       const struct GNUNET_TESTBED_AddHostMessage *imsg;
2095       uint16_t osize;
2096
2097       imsg = (const struct GNUNET_TESTBED_AddHostMessage *) msg;
2098       data_len = (uLong) ntohs (imsg->config_size);
2099       osize = sizeof (struct GNUNET_TESTBED_AddHostMessage) +
2100           ntohs (imsg->username_length) + ntohs (imsg->hostname_length);
2101       xdata_len = ntohs (imsg->header.size) - osize;
2102       xdata = (const Bytef *) ((const void *) imsg + osize);
2103     }
2104     break;
2105   case GNUNET_MESSAGE_TYPE_TESTBED_LINK_CONTROLLERS_RESULT:
2106     {
2107       const struct GNUNET_TESTBED_ControllerLinkResponse *imsg;
2108
2109       imsg = (const struct GNUNET_TESTBED_ControllerLinkResponse *) msg;
2110       data_len = ntohs (imsg->config_size);
2111       xdata_len = ntohs (imsg->header.size) -
2112           sizeof (const struct GNUNET_TESTBED_ControllerLinkResponse);
2113       xdata = (const Bytef *) &imsg[1];
2114     }
2115     break;
2116   case GNUNET_MESSAGE_TYPE_TESTBED_CREATE_PEER:
2117     {
2118       const struct GNUNET_TESTBED_PeerCreateMessage *imsg;
2119
2120       imsg = (const struct GNUNET_TESTBED_PeerCreateMessage *) msg;
2121       data_len = ntohs (imsg->config_size);
2122       xdata_len = ntohs (imsg->header.size) -
2123           sizeof (struct GNUNET_TESTBED_PeerCreateMessage);
2124       xdata = (const Bytef *) &imsg[1];
2125     }
2126     break;
2127   case GNUNET_MESSAGE_TYPE_TESTBED_RECONFIGURE_PEER:
2128     {
2129       const struct GNUNET_TESTBED_PeerReconfigureMessage *imsg;
2130
2131       imsg = (const struct GNUNET_TESTBED_PeerReconfigureMessage *) msg;
2132       data_len =  ntohs (imsg->config_size);
2133       xdata_len = ntohs (imsg->header.size) -
2134           sizeof (struct GNUNET_TESTBED_PeerReconfigureMessage);
2135       xdata = (const Bytef *) &imsg[1];
2136     }
2137     break;
2138   default:
2139     GNUNET_assert (0);
2140   }
2141   data = GNUNET_malloc (data_len);
2142   if (Z_OK != (ret = uncompress (data, &data_len, xdata, xdata_len)))
2143   {
2144     GNUNET_free (data);
2145     GNUNET_break_op (0);        /* Un-compression failure */
2146     return NULL;
2147   }
2148   cfg = GNUNET_CONFIGURATION_create ();
2149   if (GNUNET_OK !=
2150       GNUNET_CONFIGURATION_deserialize (cfg, (const char *) data,
2151                                         (size_t) data_len,
2152                                         GNUNET_NO))
2153   {
2154     GNUNET_free (data);
2155     GNUNET_break_op (0);        /* De-serialization failure */
2156     return NULL;
2157   }
2158   GNUNET_free (data);
2159   return cfg;
2160 }
2161
2162
2163 /**
2164  * Checks the integrity of the OperationFailureEventMessage and if good returns
2165  * the error message it contains.
2166  *
2167  * @param msg the OperationFailureEventMessage
2168  * @return the error message
2169  */
2170 const char *
2171 GNUNET_TESTBED_parse_error_string_ (const struct
2172                                     GNUNET_TESTBED_OperationFailureEventMessage
2173                                     *msg)
2174 {
2175   uint16_t msize;
2176   const char *emsg;
2177
2178   msize = ntohs (msg->header.size);
2179   if (sizeof (struct GNUNET_TESTBED_OperationFailureEventMessage) >= msize)
2180     return NULL;
2181   msize -= sizeof (struct GNUNET_TESTBED_OperationFailureEventMessage);
2182   emsg = (const char *) &msg[1];
2183   if ('\0' != emsg[msize - 1])
2184   {
2185     GNUNET_break (0);
2186     return NULL;
2187   }
2188   return emsg;
2189 }
2190
2191
2192 /**
2193  * Function to return the operation id for a controller. The operation id is
2194  * created from the controllers host id and its internal operation counter.
2195  *
2196  * @param controller the handle to the controller whose operation id has to be incremented
2197  * @return the incremented operation id.
2198  */
2199 uint64_t
2200 GNUNET_TESTBED_get_next_op_id (struct GNUNET_TESTBED_Controller * controller)
2201 {
2202   uint64_t op_id;
2203
2204   op_id = (uint64_t) GNUNET_TESTBED_host_get_id_ (controller->host);
2205   op_id = op_id << 32;
2206   op_id |= (uint64_t) controller->operation_counter++;
2207   return op_id;
2208 }
2209
2210
2211 /**
2212  * Function called when a shutdown peers operation is ready
2213  *
2214  * @param cls the closure from GNUNET_TESTBED_operation_create_()
2215  */
2216 static void
2217 opstart_shutdown_peers (void *cls)
2218 {
2219   struct OperationContext *opc = cls;
2220   struct GNUNET_MQ_Envelope *env;
2221   struct GNUNET_TESTBED_ShutdownPeersMessage *msg;
2222
2223   opc->state = OPC_STATE_STARTED;
2224   env = GNUNET_MQ_msg (msg,
2225                        GNUNET_MESSAGE_TYPE_TESTBED_SHUTDOWN_PEERS);
2226   msg->operation_id = GNUNET_htonll (opc->id);
2227   GNUNET_TESTBED_insert_opc_ (opc->c,
2228                               opc);
2229   GNUNET_MQ_send (opc->c->mq,
2230                   env);
2231 }
2232
2233
2234 /**
2235  * Callback which will be called when shutdown peers operation is released
2236  *
2237  * @param cls the closure from GNUNET_TESTBED_operation_create_()
2238  */
2239 static void
2240 oprelease_shutdown_peers (void *cls)
2241 {
2242   struct OperationContext *opc = cls;
2243
2244   switch (opc->state)
2245   {
2246   case OPC_STATE_STARTED:
2247     GNUNET_TESTBED_remove_opc_ (opc->c, opc);
2248     /* no break; continue */
2249   case OPC_STATE_INIT:
2250     GNUNET_free (opc->data);
2251     break;
2252   case OPC_STATE_FINISHED:
2253     break;
2254   }
2255   GNUNET_free (opc);
2256 }
2257
2258
2259 /**
2260  * Stops and destroys all peers.  Is equivalent of calling
2261  * GNUNET_TESTBED_peer_stop() and GNUNET_TESTBED_peer_destroy() on all peers,
2262  * except that the peer stop event and operation finished event corresponding to
2263  * the respective functions are not generated.  This function should be called
2264  * when there are no other pending operations.  If there are pending operations,
2265  * it will return NULL
2266  *
2267  * @param c the controller to send this message to
2268  * @param op_cls closure for the operation
2269  * @param cb the callback to call when all peers are stopped and destroyed
2270  * @param cb_cls the closure for the callback
2271  * @return operation handle on success; NULL if any pending operations are
2272  *           present
2273  */
2274 struct GNUNET_TESTBED_Operation *
2275 GNUNET_TESTBED_shutdown_peers (struct GNUNET_TESTBED_Controller *c,
2276                                void *op_cls,
2277                                GNUNET_TESTBED_OperationCompletionCallback cb,
2278                                void *cb_cls)
2279 {
2280   struct OperationContext *opc;
2281   struct ShutdownPeersData *data;
2282
2283   if (0 != GNUNET_CONTAINER_multihashmap32_size (c->opc_map))
2284     return NULL;
2285   data = GNUNET_new (struct ShutdownPeersData);
2286   data->cb = cb;
2287   data->cb_cls = cb_cls;
2288   opc = GNUNET_new (struct OperationContext);
2289   opc->c = c;
2290   opc->op_cls = op_cls;
2291   opc->data = data;
2292   opc->id =  GNUNET_TESTBED_get_next_op_id (c);
2293   opc->type = OP_SHUTDOWN_PEERS;
2294   opc->state = OPC_STATE_INIT;
2295   opc->op = GNUNET_TESTBED_operation_create_ (opc, &opstart_shutdown_peers,
2296                                               &oprelease_shutdown_peers);
2297   GNUNET_TESTBED_operation_queue_insert_ (opc->c->opq_parallel_operations,
2298                                         opc->op);
2299   GNUNET_TESTBED_operation_begin_wait_ (opc->op);
2300   return opc->op;
2301 }
2302
2303
2304 /**
2305  * Return the index of the peer inside of the total peer array,
2306  * aka. the peer's "unique ID".
2307  *
2308  * @param peer Peer handle.
2309  *
2310  * @return The peer's unique ID.
2311  */
2312 uint32_t
2313 GNUNET_TESTBED_get_index (const struct GNUNET_TESTBED_Peer *peer)
2314 {
2315   return peer->unique_id;
2316 }
2317
2318
2319 /**
2320  * Remove a barrier and it was the last one in the barrier hash map, destroy the
2321  * hash map
2322  *
2323  * @param barrier the barrier to remove
2324  */
2325 void
2326 GNUNET_TESTBED_barrier_remove_ (struct GNUNET_TESTBED_Barrier *barrier)
2327 {
2328   struct GNUNET_TESTBED_Controller *c = barrier->c;
2329
2330   GNUNET_assert (NULL != c->barrier_map); /* No barriers present */
2331   GNUNET_assert (GNUNET_OK ==
2332                  GNUNET_CONTAINER_multihashmap_remove (c->barrier_map,
2333                                                        &barrier->key,
2334                                                        barrier));
2335   GNUNET_free (barrier->name);
2336   GNUNET_free (barrier);
2337   if (0 == GNUNET_CONTAINER_multihashmap_size (c->barrier_map))
2338   {
2339     GNUNET_CONTAINER_multihashmap_destroy (c->barrier_map);
2340     c->barrier_map = NULL;
2341   }
2342 }
2343
2344
2345 /**
2346  * Initialise a barrier and call the given callback when the required percentage
2347  * of peers (quorum) reach the barrier OR upon error.
2348  *
2349  * @param controller the handle to the controller
2350  * @param name identification name of the barrier
2351  * @param quorum the percentage of peers that is required to reach the barrier.
2352  *   Peers signal reaching a barrier by calling
2353  *   GNUNET_TESTBED_barrier_reached().
2354  * @param cb the callback to call when the barrier is reached or upon error.
2355  *   Cannot be NULL.
2356  * @param cls closure for the above callback
2357  * @param echo GNUNET_YES to echo the barrier crossed status message back to the
2358  *   controller
2359  * @return barrier handle; NULL upon error
2360  */
2361 struct GNUNET_TESTBED_Barrier *
2362 GNUNET_TESTBED_barrier_init_ (struct GNUNET_TESTBED_Controller *controller,
2363                               const char *name,
2364                               unsigned int quorum,
2365                               GNUNET_TESTBED_barrier_status_cb cb, void *cls,
2366                               int echo)
2367 {
2368   struct GNUNET_TESTBED_BarrierInit *msg;
2369   struct GNUNET_MQ_Envelope *env;
2370   struct GNUNET_TESTBED_Barrier *barrier;
2371   struct GNUNET_HashCode key;
2372   size_t name_len;
2373
2374   GNUNET_assert (quorum <= 100);
2375   GNUNET_assert (NULL != cb);
2376   name_len = strlen (name);
2377   GNUNET_assert (0 < name_len);
2378   GNUNET_CRYPTO_hash (name, name_len, &key);
2379   if (NULL == controller->barrier_map)
2380     controller->barrier_map = GNUNET_CONTAINER_multihashmap_create (3, GNUNET_YES);
2381   if (GNUNET_YES ==
2382       GNUNET_CONTAINER_multihashmap_contains (controller->barrier_map,
2383                                               &key))
2384   {
2385     GNUNET_break (0);
2386     return NULL;
2387   }
2388   LOG_DEBUG ("Initialising barrier `%s'\n", name);
2389   barrier = GNUNET_new (struct GNUNET_TESTBED_Barrier);
2390   barrier->c = controller;
2391   barrier->name = GNUNET_strdup (name);
2392   barrier->cb = cb;
2393   barrier->cls = cls;
2394   barrier->echo = echo;
2395   GNUNET_memcpy (&barrier->key, &key, sizeof (struct GNUNET_HashCode));
2396   GNUNET_assert (GNUNET_OK ==
2397                  GNUNET_CONTAINER_multihashmap_put (controller->barrier_map,
2398                                                     &barrier->key,
2399                                                     barrier,
2400                                                     GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST));
2401
2402   env = GNUNET_MQ_msg_extra (msg,
2403                              name_len,
2404                              GNUNET_MESSAGE_TYPE_TESTBED_BARRIER_INIT);
2405   msg->quorum = (uint8_t) quorum;
2406   GNUNET_memcpy (msg->name,
2407                  barrier->name,
2408                  name_len);
2409   GNUNET_MQ_send (barrier->c->mq,
2410                   env);
2411   return barrier;
2412 }
2413
2414
2415 /**
2416  * Initialise a barrier and call the given callback when the required percentage
2417  * of peers (quorum) reach the barrier OR upon error.
2418  *
2419  * @param controller the handle to the controller
2420  * @param name identification name of the barrier
2421  * @param quorum the percentage of peers that is required to reach the barrier.
2422  *   Peers signal reaching a barrier by calling
2423  *   GNUNET_TESTBED_barrier_reached().
2424  * @param cb the callback to call when the barrier is reached or upon error.
2425  *   Cannot be NULL.
2426  * @param cls closure for the above callback
2427  * @return barrier handle; NULL upon error
2428  */
2429 struct GNUNET_TESTBED_Barrier *
2430 GNUNET_TESTBED_barrier_init (struct GNUNET_TESTBED_Controller *controller,
2431                              const char *name,
2432                              unsigned int quorum,
2433                              GNUNET_TESTBED_barrier_status_cb cb, void *cls)
2434 {
2435   return GNUNET_TESTBED_barrier_init_ (controller,
2436                                        name, quorum, cb, cls, GNUNET_YES);
2437 }
2438
2439
2440 /**
2441  * Cancel a barrier.
2442  *
2443  * @param barrier the barrier handle
2444  */
2445 void
2446 GNUNET_TESTBED_barrier_cancel (struct GNUNET_TESTBED_Barrier *barrier)
2447 {
2448   struct GNUNET_MQ_Envelope *env;
2449   struct GNUNET_TESTBED_BarrierCancel *msg;
2450   size_t slen;
2451
2452   slen = strlen (barrier->name);
2453   env = GNUNET_MQ_msg_extra (msg,
2454                              slen,
2455                              GNUNET_MESSAGE_TYPE_TESTBED_BARRIER_CANCEL);
2456   GNUNET_memcpy (msg->name,
2457                  barrier->name,
2458                  slen);
2459   GNUNET_MQ_send (barrier->c->mq,
2460                   env);
2461   GNUNET_TESTBED_barrier_remove_ (barrier);
2462 }
2463
2464
2465 /* end of testbed_api.c */