src/testbed/gnunet-service-testbed.h

   1 /*
   2   This file is part of GNUnet.
   3   (C) 2008--2013 Christian Grothoff (and other contributing authors)
   4
   5   GNUnet is free software; you can redistribute it and/or modify
   6   it under the terms of the GNU General Public License as published
   7   by the Free Software Foundation; either version 2, or (at your
   8   option) any later version.
   9
  10   GNUnet is distributed in the hope that it will be useful, but
  11   WITHOUT ANY WARRANTY; without even the implied warranty of
  12   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13   General Public License for more details.
  14
  15   You should have received a copy of the GNU General Public License
  16   along with GNUnet; see the file COPYING.  If not, write to the
  17   Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18   Boston, MA 02111-1307, USA.
  19 */
  20
  21 /**
  22  * @file testbed/gnunet-service-testbed.h
  23  * @brief data structures shared amongst components of TESTBED service
  24  * @author Sree Harsha Totakura
  25  */
  26
  27 #include "platform.h"
  28 #include "gnunet_util_lib.h"
  29 #include "gnunet_testbed_service.h"
  30 #include "gnunet_transport_service.h"
  31 #include "gnunet_core_service.h"
  32
  33 #include "testbed.h"
  34 #include "testbed_api.h"
  35 #include "testbed_api_operations.h"
  36 #include "testbed_api_hosts.h"
  37 #include "gnunet_testing_lib.h"
  38 #include "gnunet-service-testbed_links.h"
  39
  40
  41 /**
  42  * Generic logging
  43  */
  44 #define LOG(kind,...)                           \
  45   GNUNET_log (kind, __VA_ARGS__)
  46
  47 /**
  48  * Debug logging
  49  */
  50 #define LOG_DEBUG(...)                          \
  51   LOG (GNUNET_ERROR_TYPE_DEBUG, __VA_ARGS__)
  52
  53 /**
  54  * By how much should the arrays lists grow
  55  */
  56 #define LIST_GROW_STEP 10
  57
  58
  59 /**
  60  * A routing entry
  61  */
  62 struct Route
  63 {
  64   /**
  65    * destination host
  66    */
  67   uint32_t dest;
  68
  69   /**
  70    * The destination host is reachable thru
  71    */
  72   uint32_t thru;
  73 };
  74
  75
  76 /**
  77  * Context information for operations forwarded to subcontrollers
  78  */
  79 struct ForwardedOperationContext
  80 {
  81   /**
  82    * The next pointer for DLL
  83    */
  84   struct ForwardedOperationContext *next;
  85
  86   /**
  87    * The prev pointer for DLL
  88    */
  89   struct ForwardedOperationContext *prev;
  90
  91   /**
  92    * The generated operation context
  93    */
  94   struct OperationContext *opc;
  95
  96   /**
  97    * The client to which we have to reply
  98    */
  99   struct GNUNET_SERVER_Client *client;
 100
 101   /**
 102    * Closure pointer
 103    */
 104   void *cls;
 105
 106   /**
 107    * Task ID for the timeout task
 108    */
 109   GNUNET_SCHEDULER_TaskIdentifier timeout_task;
 110
 111   /**
 112    * The id of the operation that has been forwarded
 113    */
 114   uint64_t operation_id;
 115
 116   /**
 117    * The type of the operation which is forwarded
 118    */
 119   enum OperationType type;
 120
 121 };
 122
 123
 124 /**
 125  * A DLL of host registrations to be made
 126  */
 127 struct HostRegistration
 128 {
 129   /**
 130    * next registration in the DLL
 131    */
 132   struct HostRegistration *next;
 133
 134   /**
 135    * previous registration in the DLL
 136    */
 137   struct HostRegistration *prev;
 138
 139   /**
 140    * The callback to call after this registration's status is available
 141    */
 142   GNUNET_TESTBED_HostRegistrationCompletion cb;
 143
 144   /**
 145    * The closure for the above callback
 146    */
 147   void *cb_cls;
 148
 149   /**
 150    * The host that has to be registered
 151    */
 152   struct GNUNET_TESTBED_Host *host;
 153 };
 154
 155
 156 /**
 157  * Context information used while linking controllers
 158  */
 159 struct LinkControllersContext
 160 {
 161   /**
 162    * The client which initiated the link controller operation
 163    */
 164   struct GNUNET_SERVER_Client *client;
 165
 166   /**
 167    * The ID of the operation
 168    */
 169   uint64_t operation_id;
 170
 171 };
 172
 173
 174 /**
 175  * A peer
 176  */
 177
 178 struct Peer
 179 {
 180
 181   union
 182   {
 183     struct
 184     {
 185       /**
 186        * The peer handle from testing API
 187        */
 188       struct GNUNET_TESTING_Peer *peer;
 189
 190       /**
 191        * The modified (by GNUNET_TESTING_peer_configure) configuration this
 192        * peer is configured with
 193        */
 194       struct GNUNET_CONFIGURATION_Handle *cfg;
 195
 196       /**
 197        * Is the peer running
 198        */
 199       int is_running;
 200
 201     } local;
 202
 203     struct
 204     {
 205       /**
 206        * The slave this peer is started through
 207        */
 208       struct Slave *slave;
 209
 210       /**
 211        * The id of the remote host this peer is running on
 212        */
 213       uint32_t remote_host_id;
 214
 215     } remote;
 216
 217   } details;
 218
 219   /**
 220    * Is this peer locally created?
 221    */
 222   int is_remote;
 223
 224   /**
 225    * Our local reference id for this peer
 226    */
 227   uint32_t id;
 228
 229   /**
 230    * References to peers are using in forwarded overlay contexts and remote
 231    * overlay connect contexts. A peer can only be destroyed after all such
 232    * contexts are destroyed. For this, we maintain a reference counter. When we
 233    * use a peer in any such context, we increment this counter. We decrement it
 234    * when we are destroying these contexts
 235    */
 236   uint32_t reference_cnt;
 237
 238   /**
 239    * While destroying a peer, due to the fact that there could be references to
 240    * this peer, we delay the peer destroy to a further time. We do this by using
 241    * this flag to destroy the peer while destroying a context in which this peer
 242    * has been used. When the flag is set to 1 and reference_cnt = 0 we destroy
 243    * the peer
 244    */
 245   uint32_t destroy_flag;
 246
 247 };
 248
 249
 250 /**
 251  * The main context information associated with the client which started us
 252  */
 253 struct Context
 254 {
 255   /**
 256    * The client handle associated with this context
 257    */
 258   struct GNUNET_SERVER_Client *client;
 259
 260   /**
 261    * The network address of the master controller
 262    */
 263   char *master_ip;
 264
 265   /**
 266    * The TESTING system handle for starting peers locally
 267    */
 268   struct GNUNET_TESTING_System *system;
 269
 270   /**
 271    * Our host id according to this context
 272    */
 273   uint32_t host_id;
 274 };
 275
 276
 277 /**
 278  * The structure for identifying a shared service
 279  */
 280 struct SharedService
 281 {
 282   /**
 283    * The name of the shared service
 284    */
 285   char *name;
 286
 287   /**
 288    * Number of shared peers per instance of the shared service
 289    */
 290   uint32_t num_shared;
 291
 292   /**
 293    * Number of peers currently sharing the service
 294    */
 295   uint32_t num_sharing;
 296 };
 297
 298
 299 /**
 300  * Context information to used during operations which forward the overlay
 301  * connect message
 302  */
 303 struct ForwardedOverlayConnectContext
 304 {
 305   /**
 306    * next ForwardedOverlayConnectContext in the DLL
 307    */
 308   struct ForwardedOverlayConnectContext *next;
 309
 310   /**
 311    * previous ForwardedOverlayConnectContext in the DLL
 312    */
 313   struct ForwardedOverlayConnectContext *prev;
 314
 315   /**
 316    * A copy of the original overlay connect message
 317    */
 318   struct GNUNET_MessageHeader *orig_msg;
 319
 320   /**
 321    * The client handle
 322    */
 323   struct GNUNET_SERVER_Client *client;
 324
 325   /**
 326    * The id of the operation which created this context information
 327    */
 328   uint64_t operation_id;
 329
 330   /**
 331    * the id of peer 1
 332    */
 333   uint32_t peer1;
 334
 335   /**
 336    * The id of peer 2
 337    */
 338   uint32_t peer2;
 339
 340   /**
 341    * Id of the host where peer2 is running
 342    */
 343   uint32_t peer2_host_id;
 344 };
 345
 346
 347 /**
 348  * The type for data structures which commonly arrive at the slave_event_callback
 349  */
 350 enum ClosureType
 351 {
 352   /**
 353    * Type for RegisteredHostContext closures
 354    */
 355   CLOSURE_TYPE_RHC = 1,
 356
 357   /**
 358    * Type for LinkControllersForwardingContext closures
 359    */
 360   CLOSURE_TYPE_LCF
 361 };
 362
 363
 364 /**
 365  * This context information will be created for each host that is registered at
 366  * slave controllers during overlay connects.
 367  */
 368 struct RegisteredHostContext
 369 {
 370   /**
 371    * The host which is being registered
 372    */
 373   struct GNUNET_TESTBED_Host *reg_host;
 374
 375   /**
 376    * The host of the controller which has to connect to the above rhost
 377    */
 378   struct GNUNET_TESTBED_Host *host;
 379
 380   /**
 381    * Head of the ForwardedOverlayConnectContext DLL
 382    */
 383   struct ForwardedOverlayConnectContext *focc_dll_head;
 384
 385   /**
 386    * Tail of the ForwardedOverlayConnectContext DLL
 387    */
 388   struct ForwardedOverlayConnectContext *focc_dll_tail;
 389
 390   /**
 391    * Enumeration of states for this context
 392    */
 393   enum RHCState
 394   {
 395
 396     /**
 397      * The initial state
 398      */
 399     RHC_INIT = 0,
 400
 401     /**
 402      * State where we attempt to do the overlay connection again
 403      */
 404     RHC_DONE
 405   } state;
 406
 407 };
 408
 409
 410 /**
 411  * Context data for GNUNET_MESSAGE_TYPE_TESTBED_SHUTDOWN_PEERS handler
 412  */
 413 struct HandlerContext_ShutdownPeers
 414 {
 415   /**
 416    * The number of slave we expect to hear from since we forwarded the
 417    * GNUNET_MESSAGE_TYPE_TESTBED_SHUTDOWN_PEERS message to them
 418    */
 419   unsigned int nslaves;
 420
 421   /**
 422    * Did we observe a timeout with respect to this operation at any of the
 423    * slaves
 424    */
 425   int timeout;
 426 };
 427
 428
 429 /**
 430  * Our configuration
 431  */
 432 struct GNUNET_CONFIGURATION_Handle *our_config;
 433
 434 /**
 435  * The master context; generated with the first INIT message
 436  */
 437 extern struct Context *GST_context;
 438
 439 /**
 440  * DLL head for forwarded operation contexts
 441  */
 442 extern struct ForwardedOperationContext *fopcq_head;
 443
 444 /**
 445  * DLL tail for forwarded operation contexts
 446  */
 447 extern struct ForwardedOperationContext *fopcq_tail;
 448
 449 /**
 450  * A list of peers we know about
 451  */
 452 extern struct Peer **GST_peer_list;
 453
 454 /**
 455  * Array of hosts
 456  */
 457 extern struct GNUNET_TESTBED_Host **GST_host_list;
 458
 459 /**
 460  * Operation queue for open file descriptors
 461  */
 462 extern struct OperationQueue *GST_opq_openfds;
 463
 464 /**
 465  * Timeout for operations which may take some time
 466  */
 467 const extern struct GNUNET_TIME_Relative GST_timeout;
 468
 469 /**
 470  * The size of the peer list
 471  */
 472 extern unsigned int GST_peer_list_size;
 473
 474 /**
 475  * The size of the host list
 476  */
 477 extern unsigned int GST_host_list_size;
 478
 479 /**
 480  * The directory where to store load statistics data
 481  */
 482 extern char *GST_stats_dir;
 483
 484 /**
 485  * Condition to check if host id is invalid
 486  */
 487 #define INVALID_HOST_ID(id) \
 488   ( ((id) >= GST_host_list_size) || (NULL == GST_host_list[id]) )
 489
 490 /**
 491  * Condition to check if peer id is invalid
 492  */
 493 #define INVALID_PEER_ID(id) \
 494   ( ((id) >= GST_peer_list_size) || (NULL == GST_peer_list[id]) )
 495
 496
 497 /**
 498  * Similar to GNUNET_array_grow(); however instead of calling GNUNET_array_grow()
 499  * several times we call it only once. The array is also made to grow in steps
 500  * of LIST_GROW_STEP.
 501  *
 502  * @param ptr the array pointer to grow
 503  * @param size the size of array
 504  * @param accommodate_size the size which the array has to accommdate; after
 505  *          this call the array will be big enough to accommdate sizes upto
 506  *          accommodate_size
 507  */
 508 #define GST_array_grow_large_enough(ptr, size, accommodate_size) \
 509   do                                                                    \
 510   {                                                                     \
 511     unsigned int growth_size;                                           \
 512     GNUNET_assert (size <= accommodate_size);                            \
 513     growth_size = size;                                                 \
 514     while (growth_size <= accommodate_size)                             \
 515       growth_size += LIST_GROW_STEP;                                    \
 516     GNUNET_array_grow (ptr, size, growth_size);                         \
 517     GNUNET_assert (size > accommodate_size);                            \
 518   } while (0)
 519
 520
 521 /**
 522  * Queues a message in send queue for sending to the service
 523  *
 524  * @param client the client to whom the queued message has to be sent
 525  * @param msg the message to queue
 526  */
 527 void
 528 GST_queue_message (struct GNUNET_SERVER_Client *client,
 529                    struct GNUNET_MessageHeader *msg);
 530
 531
 532 /**
 533  * Function to destroy a peer
 534  *
 535  * @param peer the peer structure to destroy
 536  */
 537 void
 538 GST_destroy_peer (struct Peer *peer);
 539
 540
 541 /**
 542  * Stops and destroys all peers
 543  */
 544 void
 545 GST_destroy_peers ();
 546
 547
 548 /**
 549  * Finds the route with directly connected host as destination through which
 550  * the destination host can be reached
 551  *
 552  * @param host_id the id of the destination host
 553  * @return the route with directly connected destination host; NULL if no route
 554  *           is found
 555  */
 556 struct Route *
 557 GST_find_dest_route (uint32_t host_id);
 558
 559
 560 /**
 561  * Handler for GNUNET_MESSAGE_TYPE_TESTBED_OLCONNECT messages
 562  *
 563  * @param cls NULL
 564  * @param client identification of the client
 565  * @param message the actual message
 566  */
 567 void
 568 GST_handle_overlay_connect (void *cls, struct GNUNET_SERVER_Client *client,
 569                             const struct GNUNET_MessageHeader *message);
 570
 571
 572 /**
 573  * Adds a host registration's request to a slave's registration queue
 574  *
 575  * @param slave the slave controller at which the given host has to be
 576  *          registered
 577  * @param cb the host registration completion callback
 578  * @param cb_cls the closure for the host registration completion callback
 579  * @param host the host which has to be registered
 580  */
 581 void
 582 GST_queue_host_registration (struct Slave *slave,
 583                              GNUNET_TESTBED_HostRegistrationCompletion cb,
 584                              void *cb_cls, struct GNUNET_TESTBED_Host *host);
 585
 586
 587 /**
 588  * Callback to relay the reply msg of a forwarded operation back to the client
 589  *
 590  * @param cls ForwardedOperationContext
 591  * @param msg the message to relay
 592  */
 593 void
 594 GST_forwarded_operation_reply_relay (void *cls,
 595                                      const struct GNUNET_MessageHeader *msg);
 596
 597
 598 /**
 599  * Task to free resources when forwarded operation has been timedout
 600  *
 601  * @param cls the ForwardedOperationContext
 602  * @param tc the task context from scheduler
 603  */
 604 void
 605 GST_forwarded_operation_timeout (void *cls,
 606                                  const struct GNUNET_SCHEDULER_TaskContext *tc);
 607
 608
 609 /**
 610  * Clears the forwarded operations queue
 611  */
 612 void
 613 GST_clear_fopcq ();
 614
 615
 616 /**
 617  * Send operation failure message to client
 618  *
 619  * @param client the client to which the failure message has to be sent to
 620  * @param operation_id the id of the failed operation
 621  * @param emsg the error message; can be NULL
 622  */
 623 void
 624 GST_send_operation_fail_msg (struct GNUNET_SERVER_Client *client,
 625                              uint64_t operation_id, const char *emsg);
 626
 627
 628 /**
 629  * Function to send generic operation success message to given client
 630  *
 631  * @param client the client to send the message to
 632  * @param operation_id the id of the operation which was successful
 633  */
 634 void
 635 GST_send_operation_success_msg (struct GNUNET_SERVER_Client *client,
 636                                 uint64_t operation_id);
 637
 638
 639 /**
 640  * Handler for GNUNET_MESSAGE_TYPE_TESTBED_REQUESTCONNECT messages
 641  *
 642  * @param cls NULL
 643  * @param client identification of the client
 644  * @param message the actual message
 645  */
 646 void
 647 GST_handle_remote_overlay_connect (void *cls,
 648                                    struct GNUNET_SERVER_Client *client,
 649                                    const struct GNUNET_MessageHeader *message);
 650
 651
 652 /**
 653  * Handler for GNUNET_MESSAGE_TYPE_TESTBED_CREATEPEER messages
 654  *
 655  * @param cls NULL
 656  * @param client identification of the client
 657  * @param message the actual message
 658  */
 659 void
 660 GST_handle_peer_create (void *cls, struct GNUNET_SERVER_Client *client,
 661                         const struct GNUNET_MessageHeader *message);
 662
 663
 664 /**
 665  * Message handler for GNUNET_MESSAGE_TYPE_TESTBED_DESTROYPEER messages
 666  *
 667  * @param cls NULL
 668  * @param client identification of the client
 669  * @param message the actual message
 670  */
 671 void
 672 GST_handle_peer_destroy (void *cls, struct GNUNET_SERVER_Client *client,
 673                          const struct GNUNET_MessageHeader *message);
 674
 675
 676 /**
 677  * Message handler for GNUNET_MESSAGE_TYPE_TESTBED_DESTROYPEER messages
 678  *
 679  * @param cls NULL
 680  * @param client identification of the client
 681  * @param message the actual message
 682  */
 683 void
 684 GST_handle_peer_start (void *cls, struct GNUNET_SERVER_Client *client,
 685                        const struct GNUNET_MessageHeader *message);
 686
 687
 688 /**
 689  * Message handler for GNUNET_MESSAGE_TYPE_TESTBED_DESTROYPEER messages
 690  *
 691  * @param cls NULL
 692  * @param client identification of the client
 693  * @param message the actual message
 694  */
 695 void
 696 GST_handle_peer_stop (void *cls, struct GNUNET_SERVER_Client *client,
 697                       const struct GNUNET_MessageHeader *message);
 698
 699
 700 /**
 701  * Handler for GNUNET_MESSAGE_TYPE_TESTBED_GETPEERCONFIG messages
 702  *
 703  * @param cls NULL
 704  * @param client identification of the client
 705  * @param message the actual message
 706  */
 707 void
 708 GST_handle_peer_get_config (void *cls, struct GNUNET_SERVER_Client *client,
 709                             const struct GNUNET_MessageHeader *message);
 710
 711
 712 /**
 713  * Handler for GNUNET_MESSAGE_TYPE_TESTBED_SHUTDOWN_PEERS messages
 714  *
 715  * @param cls NULL
 716  * @param client identification of the client
 717  * @param message the actual message
 718  */
 719 void
 720 GST_handle_shutdown_peers (void *cls, struct GNUNET_SERVER_Client *client,
 721                            const struct GNUNET_MessageHeader *message);
 722
 723
 724 /**
 725  * Handler for GNUNET_TESTBED_ManagePeerServiceMessage message
 726  *
 727  * @param cls NULL
 728  * @param client identification of client
 729  * @param message the actual message
 730  */
 731 void
 732 GST_handle_manage_peer_service (void *cls, struct GNUNET_SERVER_Client *client,
 733                                 const struct GNUNET_MessageHeader *message);
 734
 735
 736 /**
 737  * Frees the ManageServiceContext queue
 738  */
 739 void
 740 GST_free_mctxq ();
 741
 742
 743 /**
 744  * Cleans up the queue used for forwarding link controllers requests
 745  */
 746 void
 747 GST_free_lcfq ();
 748
 749
 750 /**
 751  * Cleans up the route list
 752  */
 753 void
 754 GST_route_list_clear ();
 755
 756
 757 /**
 758  * Processes a forwarded overlay connect context in the queue of the given RegisteredHostContext
 759  *
 760  * @param rhc the RegisteredHostContext
 761  */
 762 void
 763 GST_process_next_focc (struct RegisteredHostContext *rhc);
 764
 765
 766 /**
 767  * Cleans up ForwardedOverlayConnectContext
 768  *
 769  * @param focc the ForwardedOverlayConnectContext to cleanup
 770  */
 771 void
 772 GST_cleanup_focc (struct ForwardedOverlayConnectContext *focc);
 773
 774
 775 /**
 776  * Clears all pending overlay connect contexts in queue
 777  */
 778 void
 779 GST_free_occq ();
 780
 781
 782 /**
 783  * Clears all pending remote overlay connect contexts in queue
 784  */
 785 void
 786 GST_free_roccq ();
 787
 788
 789 /**
 790  * Initializes the cache
 791  *
 792  * @param size the size of the cache
 793  */
 794 void
 795 GST_cache_init (unsigned int size);
 796
 797
 798 /**
 799  * Clear cache
 800  */
 801 void
 802 GST_cache_clear ();
 803
 804
 805 /**
 806  * Looks up in the hello cache and returns the HELLO of the given peer
 807  *
 808  * @param peer_id the index of the peer whose HELLO has to be looked up
 809  * @return the HELLO message; NULL if not found
 810  */
 811 const struct GNUNET_MessageHeader *
 812 GST_cache_lookup_hello (const unsigned int peer_id);
 813
 814
 815 /**
 816  * Caches the HELLO of the given peer. Updates the HELLO if it was already
 817  * cached before
 818  *
 819  * @param peer_id the peer identity of the peer whose HELLO has to be cached
 820  * @param hello the HELLO message
 821  */
 822 void
 823 GST_cache_add_hello (const unsigned int peer_id,
 824                      const struct GNUNET_MessageHeader *hello);
 825
 826
 827 /**
 828  * Functions of this type are called when the needed handle is available for
 829  * usage. These functions are to be registered with either of the functions
 830  * GST_cache_get_handle_transport() or GST_cache_get_handle_core(). The
 831  * corresponding handles will be set and if they are not, then it signals an
 832  * error while opening the handles.
 833  *
 834  * @param cls the closure passed to GST_cache_get_handle_transport() or
 835  *          GST_cache_get_handle_core()
 836  * @param ch the handle to CORE. Can be NULL if it is not requested
 837  * @param th the handle to TRANSPORT. Can be NULL if it is not requested
 838  * @param peer_id the identity of the peer. Will be NULL if ch is NULL. In other
 839  *          cases, its value being NULL means that CORE connection has failed.
 840  */
 841 typedef void (*GST_cache_handle_ready_cb) (void *cls,
 842                                            struct GNUNET_CORE_Handle * ch,
 843                                            struct GNUNET_TRANSPORT_Handle * th,
 844                                            const struct GNUNET_PeerIdentity *
 845                                            peer_id);
 846
 847
 848 /**
 849  * Callback to notify when the target peer given to
 850  * GST_cache_get_handle_transport() is connected. Note that this callback may
 851  * not be called if the target peer is already connected. Use
 852  * GNUNET_TRANSPORT_check_neighbour_connected() to check if the target peer is
 853  * already connected or not. This callback will be called only once or never (in
 854  * case the target cannot be connected).
 855  *
 856  * @param cls the closure given to GST_cache_get_handle_done() for this callback
 857  * @param target the peer identity of the target peer. The pointer should be
 858  *          valid until GST_cache_get_handle_done() is called.
 859  */
 860 typedef void (*GST_cache_peer_connect_notify) (void *cls,
 861                                                const struct GNUNET_PeerIdentity
 862                                                * target);
 863
 864
 865 /**
 866  * Get a transport handle with the given configuration. If the handle is already
 867  * cached before, it will be retured in the given callback; the peer_id is used to lookup in the
 868  * cache. If not a new operation is started to open the transport handle and
 869  * will be given in the callback when it is available.
 870  *
 871  * @param peer_id the index of the peer
 872  * @param cfg the configuration with which the transport handle has to be
 873  *          created if it was not present in the cache
 874  * @param cb the callback to notify when the transport handle is available
 875  * @param cb_cls the closure for the above callback
 876  * @param target the peer identify of the peer whose connection to our TRANSPORT
 877  *          subsystem will be notified through the connect_notify_cb. Can be NULL
 878  * @param connect_notify_cb the callback to call when the given target peer is
 879  *          connected. This callback will only be called once or never again (in
 880  *          case the target peer cannot be connected). Can be NULL
 881  * @param connect_notify_cb_cls the closure for the above callback
 882  * @return the handle which can be used cancel or mark that the handle is no
 883  *           longer being used
 884  */
 885 struct GSTCacheGetHandle *
 886 GST_cache_get_handle_transport (unsigned int peer_id,
 887                                 const struct GNUNET_CONFIGURATION_Handle *cfg,
 888                                 GST_cache_handle_ready_cb cb, void *cb_cls,
 889                                 const struct GNUNET_PeerIdentity *target,
 890                                 GST_cache_peer_connect_notify connect_notify_cb,
 891                                 void *connect_notify_cb_cls);
 892
 893
 894 /**
 895  * Get a CORE handle with the given configuration. If the handle is already
 896  * cached before, it will be retured in the given callback; the peer_id is used
 897  * to lookup in the cache. If the handle is not cached before, a new operation
 898  * is started to open the CORE handle and will be given in the callback when it
 899  * is available along with the peer identity
 900  *
 901  * @param peer_id the index of the peer
 902  * @param cfg the configuration with which the transport handle has to be
 903  *          created if it was not present in the cache
 904  * @param cb the callback to notify when the transport handle is available
 905  * @param cb_cls the closure for the above callback
 906  * @param target the peer identify of the peer whose connection to our CORE
 907  *          subsystem will be notified through the connect_notify_cb. Can be NULL
 908  * @param connect_notify_cb the callback to call when the given target peer is
 909  *          connected. This callback will only be called once or never again (in
 910  *          case the target peer cannot be connected). Can be NULL
 911  * @param connect_notify_cb_cls the closure for the above callback
 912  * @return the handle which can be used cancel or mark that the handle is no
 913  *           longer being used
 914  */
 915 struct GSTCacheGetHandle *
 916 GST_cache_get_handle_core (unsigned int peer_id,
 917                            const struct GNUNET_CONFIGURATION_Handle *cfg,
 918                            GST_cache_handle_ready_cb cb, void *cb_cls,
 919                            const struct GNUNET_PeerIdentity *target,
 920                            GST_cache_peer_connect_notify connect_notify_cb,
 921                            void *connect_notify_cb_cls);
 922
 923
 924 /**
 925  * Mark the GetCacheHandle as being done if a handle has been provided already
 926  * or as being cancelled if the callback for the handle hasn't been called.
 927  *
 928  * @param cgh the CacheGetHandle handle
 929  */
 930 void
 931 GST_cache_get_handle_done (struct GSTCacheGetHandle *cgh);
 932
 933
 934 /**
 935  * Initialize logging CPU and IO statisticfs.  Checks the configuration for
 936  * "STATS_DIR" and logs to a file in that directory.  The file is name is
 937  * generated from the hostname and the process's PID.
 938  */
 939 void
 940 GST_stats_init (const struct GNUNET_CONFIGURATION_Handle *cfg);
 941
 942
 943 /**
 944  * Shutdown the status calls module.
 945  */
 946 void
 947 GST_stats_destroy ();
 948
 949 /* End of gnunet-service-testbed.h */