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  * This context information will be created for each host that is registered at
 349  * slave controllers during overlay connects.
 350  */
 351 struct RegisteredHostContext
 352 {
 353   /**
 354    * The host which is being registered
 355    */
 356   struct GNUNET_TESTBED_Host *reg_host;
 357
 358   /**
 359    * The host of the controller which has to connect to the above rhost
 360    */
 361   struct GNUNET_TESTBED_Host *host;
 362
 363   /**
 364    * Head of the ForwardedOverlayConnectContext DLL
 365    */
 366   struct ForwardedOverlayConnectContext *focc_dll_head;
 367
 368   /**
 369    * Tail of the ForwardedOverlayConnectContext DLL
 370    */
 371   struct ForwardedOverlayConnectContext *focc_dll_tail;
 372
 373   /**
 374    * Enumeration of states for this context
 375    */
 376   enum RHCState
 377   {
 378
 379     /**
 380      * The initial state
 381      */
 382     RHC_INIT = 0,
 383
 384     /**
 385      * State where we attempt to do the overlay connection again
 386      */
 387     RHC_DONE
 388   } state;
 389
 390 };
 391
 392
 393 /**
 394  * Context data for GNUNET_MESSAGE_TYPE_TESTBED_SHUTDOWN_PEERS handler
 395  */
 396 struct HandlerContext_ShutdownPeers
 397 {
 398   /**
 399    * The number of slave we expect to hear from since we forwarded the
 400    * GNUNET_MESSAGE_TYPE_TESTBED_SHUTDOWN_PEERS message to them
 401    */
 402   unsigned int nslaves;
 403
 404   /**
 405    * Did we observe a timeout with respect to this operation at any of the
 406    * slaves
 407    */
 408   int timeout;
 409 };
 410
 411
 412 /**
 413  * Our configuration
 414  */
 415 struct GNUNET_CONFIGURATION_Handle *our_config;
 416
 417 /**
 418  * The master context; generated with the first INIT message
 419  */
 420 extern struct Context *GST_context;
 421
 422 /**
 423  * DLL head for forwarded operation contexts
 424  */
 425 extern struct ForwardedOperationContext *fopcq_head;
 426
 427 /**
 428  * DLL tail for forwarded operation contexts
 429  */
 430 extern struct ForwardedOperationContext *fopcq_tail;
 431
 432 /**
 433  * A list of peers we know about
 434  */
 435 extern struct Peer **GST_peer_list;
 436
 437 /**
 438  * Array of hosts
 439  */
 440 extern struct GNUNET_TESTBED_Host **GST_host_list;
 441
 442 /**
 443  * Operation queue for open file descriptors
 444  */
 445 extern struct OperationQueue *GST_opq_openfds;
 446
 447 /**
 448  * Timeout for operations which may take some time
 449  */
 450 const extern struct GNUNET_TIME_Relative GST_timeout;
 451
 452 /**
 453  * The size of the peer list
 454  */
 455 extern unsigned int GST_peer_list_size;
 456
 457 /**
 458  * The size of the host list
 459  */
 460 extern unsigned int GST_host_list_size;
 461
 462 /**
 463  * The directory where to store load statistics data
 464  */
 465 extern char *GST_stats_dir;
 466
 467 /**
 468  * Condition to check if host id is valid
 469  */
 470 #define VALID_HOST_ID(id) \
 471   ( ((id) < GST_host_list_size) && (NULL != GST_host_list[id]) )
 472
 473 /**
 474  * Condition to check if peer id is valid
 475  */
 476 #define VALID_PEER_ID(id) \
 477   ( ((id) < GST_peer_list_size) && (NULL != GST_peer_list[id]) )
 478
 479
 480 /**
 481  * Similar to GNUNET_array_grow(); however instead of calling GNUNET_array_grow()
 482  * several times we call it only once. The array is also made to grow in steps
 483  * of LIST_GROW_STEP.
 484  *
 485  * @param ptr the array pointer to grow
 486  * @param size the size of array
 487  * @param accommodate_size the size which the array has to accommdate; after
 488  *          this call the array will be big enough to accommdate sizes upto
 489  *          accommodate_size
 490  */
 491 #define GST_array_grow_large_enough(ptr, size, accommodate_size) \
 492   do                                                                    \
 493   {                                                                     \
 494     unsigned int growth_size;                                           \
 495     GNUNET_assert (size <= accommodate_size);                            \
 496     growth_size = size;                                                 \
 497     while (growth_size <= accommodate_size)                             \
 498       growth_size += LIST_GROW_STEP;                                    \
 499     GNUNET_array_grow (ptr, size, growth_size);                         \
 500     GNUNET_assert (size > accommodate_size);                            \
 501   } while (0)
 502
 503
 504 /**
 505  * Queues a message in send queue for sending to the service
 506  *
 507  * @param client the client to whom the queued message has to be sent
 508  * @param msg the message to queue
 509  */
 510 void
 511 GST_queue_message (struct GNUNET_SERVER_Client *client,
 512                    struct GNUNET_MessageHeader *msg);
 513
 514
 515 /**
 516  * Function to destroy a peer
 517  *
 518  * @param peer the peer structure to destroy
 519  */
 520 void
 521 GST_destroy_peer (struct Peer *peer);
 522
 523
 524 /**
 525  * Stops and destroys all peers
 526  */
 527 void
 528 GST_destroy_peers ();
 529
 530
 531 /**
 532  * Finds the route with directly connected host as destination through which
 533  * the destination host can be reached
 534  *
 535  * @param host_id the id of the destination host
 536  * @return the route with directly connected destination host; NULL if no route
 537  *           is found
 538  */
 539 struct Route *
 540 GST_find_dest_route (uint32_t host_id);
 541
 542
 543 /**
 544  * Handler for GNUNET_MESSAGE_TYPE_TESTBED_OLCONNECT messages
 545  *
 546  * @param cls NULL
 547  * @param client identification of the client
 548  * @param message the actual message
 549  */
 550 void
 551 GST_handle_overlay_connect (void *cls, struct GNUNET_SERVER_Client *client,
 552                             const struct GNUNET_MessageHeader *message);
 553
 554
 555 /**
 556  * Adds a host registration's request to a slave's registration queue
 557  *
 558  * @param slave the slave controller at which the given host has to be
 559  *          registered
 560  * @param cb the host registration completion callback
 561  * @param cb_cls the closure for the host registration completion callback
 562  * @param host the host which has to be registered
 563  */
 564 void
 565 GST_queue_host_registration (struct Slave *slave,
 566                              GNUNET_TESTBED_HostRegistrationCompletion cb,
 567                              void *cb_cls, struct GNUNET_TESTBED_Host *host);
 568
 569
 570 /**
 571  * Callback to relay the reply msg of a forwarded operation back to the client
 572  *
 573  * @param cls ForwardedOperationContext
 574  * @param msg the message to relay
 575  */
 576 void
 577 GST_forwarded_operation_reply_relay (void *cls,
 578                                      const struct GNUNET_MessageHeader *msg);
 579
 580
 581 /**
 582  * Task to free resources when forwarded operation has been timedout
 583  *
 584  * @param cls the ForwardedOperationContext
 585  * @param tc the task context from scheduler
 586  */
 587 void
 588 GST_forwarded_operation_timeout (void *cls,
 589                                  const struct GNUNET_SCHEDULER_TaskContext *tc);
 590
 591
 592 /**
 593  * Clears the forwarded operations queue
 594  */
 595 void
 596 GST_clear_fopcq ();
 597
 598
 599 /**
 600  * Send operation failure message to client
 601  *
 602  * @param client the client to which the failure message has to be sent to
 603  * @param operation_id the id of the failed operation
 604  * @param emsg the error message; can be NULL
 605  */
 606 void
 607 GST_send_operation_fail_msg (struct GNUNET_SERVER_Client *client,
 608                              uint64_t operation_id, const char *emsg);
 609
 610
 611 /**
 612  * Function to send generic operation success message to given client
 613  *
 614  * @param client the client to send the message to
 615  * @param operation_id the id of the operation which was successful
 616  */
 617 void
 618 GST_send_operation_success_msg (struct GNUNET_SERVER_Client *client,
 619                                 uint64_t operation_id);
 620
 621
 622 /**
 623  * Handler for GNUNET_MESSAGE_TYPE_TESTBED_REQUESTCONNECT messages
 624  *
 625  * @param cls NULL
 626  * @param client identification of the client
 627  * @param message the actual message
 628  */
 629 void
 630 GST_handle_remote_overlay_connect (void *cls,
 631                                    struct GNUNET_SERVER_Client *client,
 632                                    const struct GNUNET_MessageHeader *message);
 633
 634
 635 /**
 636  * Handler for GNUNET_MESSAGE_TYPE_TESTBED_CREATEPEER messages
 637  *
 638  * @param cls NULL
 639  * @param client identification of the client
 640  * @param message the actual message
 641  */
 642 void
 643 GST_handle_peer_create (void *cls, struct GNUNET_SERVER_Client *client,
 644                         const struct GNUNET_MessageHeader *message);
 645
 646
 647 /**
 648  * Message handler for GNUNET_MESSAGE_TYPE_TESTBED_DESTROYPEER messages
 649  *
 650  * @param cls NULL
 651  * @param client identification of the client
 652  * @param message the actual message
 653  */
 654 void
 655 GST_handle_peer_destroy (void *cls, struct GNUNET_SERVER_Client *client,
 656                          const struct GNUNET_MessageHeader *message);
 657
 658
 659 /**
 660  * Message handler for GNUNET_MESSAGE_TYPE_TESTBED_DESTROYPEER messages
 661  *
 662  * @param cls NULL
 663  * @param client identification of the client
 664  * @param message the actual message
 665  */
 666 void
 667 GST_handle_peer_start (void *cls, struct GNUNET_SERVER_Client *client,
 668                        const struct GNUNET_MessageHeader *message);
 669
 670
 671 /**
 672  * Message handler for GNUNET_MESSAGE_TYPE_TESTBED_DESTROYPEER messages
 673  *
 674  * @param cls NULL
 675  * @param client identification of the client
 676  * @param message the actual message
 677  */
 678 void
 679 GST_handle_peer_stop (void *cls, struct GNUNET_SERVER_Client *client,
 680                       const struct GNUNET_MessageHeader *message);
 681
 682
 683 /**
 684  * Handler for GNUNET_MESSAGE_TYPE_TESTBED_GETPEERCONFIG messages
 685  *
 686  * @param cls NULL
 687  * @param client identification of the client
 688  * @param message the actual message
 689  */
 690 void
 691 GST_handle_peer_get_config (void *cls, struct GNUNET_SERVER_Client *client,
 692                             const struct GNUNET_MessageHeader *message);
 693
 694
 695 /**
 696  * Handler for GNUNET_MESSAGE_TYPE_TESTBED_SHUTDOWN_PEERS messages
 697  *
 698  * @param cls NULL
 699  * @param client identification of the client
 700  * @param message the actual message
 701  */
 702 void
 703 GST_handle_shutdown_peers (void *cls, struct GNUNET_SERVER_Client *client,
 704                            const struct GNUNET_MessageHeader *message);
 705
 706
 707 /**
 708  * Handler for GNUNET_TESTBED_ManagePeerServiceMessage message
 709  *
 710  * @param cls NULL
 711  * @param client identification of client
 712  * @param message the actual message
 713  */
 714 void
 715 GST_handle_manage_peer_service (void *cls, struct GNUNET_SERVER_Client *client,
 716                                 const struct GNUNET_MessageHeader *message);
 717
 718
 719 /**
 720  * Frees the ManageServiceContext queue
 721  */
 722 void
 723 GST_free_mctxq ();
 724
 725
 726 /**
 727  * Cleans up the queue used for forwarding link controllers requests
 728  */
 729 void
 730 GST_free_lcfq ();
 731
 732
 733 /**
 734  * Cleans up the route list
 735  */
 736 void
 737 GST_route_list_clear ();
 738
 739
 740 /**
 741  * Processes a forwarded overlay connect context in the queue of the given RegisteredHostContext
 742  *
 743  * @param rhc the RegisteredHostContext
 744  */
 745 void
 746 GST_process_next_focc (struct RegisteredHostContext *rhc);
 747
 748
 749 /**
 750  * Cleans up ForwardedOverlayConnectContext
 751  *
 752  * @param focc the ForwardedOverlayConnectContext to cleanup
 753  */
 754 void
 755 GST_cleanup_focc (struct ForwardedOverlayConnectContext *focc);
 756
 757
 758 /**
 759  * Clears all pending overlay connect contexts in queue
 760  */
 761 void
 762 GST_free_occq ();
 763
 764
 765 /**
 766  * Clears all pending remote overlay connect contexts in queue
 767  */
 768 void
 769 GST_free_roccq ();
 770
 771
 772 /**
 773  * Initializes the cache
 774  *
 775  * @param size the size of the cache
 776  */
 777 void
 778 GST_cache_init (unsigned int size);
 779
 780
 781 /**
 782  * Clear cache
 783  */
 784 void
 785 GST_cache_clear ();
 786
 787
 788 /**
 789  * Looks up in the hello cache and returns the HELLO of the given peer
 790  *
 791  * @param peer_id the index of the peer whose HELLO has to be looked up
 792  * @return the HELLO message; NULL if not found
 793  */
 794 const struct GNUNET_MessageHeader *
 795 GST_cache_lookup_hello (const unsigned int peer_id);
 796
 797
 798 /**
 799  * Caches the HELLO of the given peer. Updates the HELLO if it was already
 800  * cached before
 801  *
 802  * @param peer_id the peer identity of the peer whose HELLO has to be cached
 803  * @param hello the HELLO message
 804  */
 805 void
 806 GST_cache_add_hello (const unsigned int peer_id,
 807                      const struct GNUNET_MessageHeader *hello);
 808
 809
 810 /**
 811  * Functions of this type are called when the needed handle is available for
 812  * usage. These functions are to be registered with either of the functions
 813  * GST_cache_get_handle_transport() or GST_cache_get_handle_core(). The
 814  * corresponding handles will be set and if they are not, then it signals an
 815  * error while opening the handles.
 816  *
 817  * @param cls the closure passed to GST_cache_get_handle_transport() or
 818  *          GST_cache_get_handle_core()
 819  * @param ch the handle to CORE. Can be NULL if it is not requested
 820  * @param th the handle to TRANSPORT. Can be NULL if it is not requested
 821  * @param peer_id the identity of the peer. Will be NULL if ch is NULL. In other
 822  *          cases, its value being NULL means that CORE connection has failed.
 823  */
 824 typedef void (*GST_cache_handle_ready_cb) (void *cls,
 825                                            struct GNUNET_CORE_Handle * ch,
 826                                            struct GNUNET_TRANSPORT_Handle * th,
 827                                            const struct GNUNET_PeerIdentity *
 828                                            peer_id);
 829
 830
 831 /**
 832  * Callback to notify when the target peer given to
 833  * GST_cache_get_handle_transport() is connected. Note that this callback may
 834  * not be called if the target peer is already connected. Use
 835  * GNUNET_TRANSPORT_check_neighbour_connected() to check if the target peer is
 836  * already connected or not. This callback will be called only once or never (in
 837  * case the target cannot be connected).
 838  *
 839  * @param cls the closure given to GST_cache_get_handle_done() for this callback
 840  * @param target the peer identity of the target peer. The pointer should be
 841  *          valid until GST_cache_get_handle_done() is called.
 842  */
 843 typedef void (*GST_cache_peer_connect_notify) (void *cls,
 844                                                const struct GNUNET_PeerIdentity
 845                                                * target);
 846
 847
 848 /**
 849  * Get a transport handle with the given configuration. If the handle is already
 850  * cached before, it will be retured in the given callback; the peer_id is used to lookup in the
 851  * cache. If not a new operation is started to open the transport handle and
 852  * will be given in the callback when it is available.
 853  *
 854  * @param peer_id the index of the peer
 855  * @param cfg the configuration with which the transport handle has to be
 856  *          created if it was not present in the cache
 857  * @param cb the callback to notify when the transport handle is available
 858  * @param cb_cls the closure for the above callback
 859  * @param target the peer identify of the peer whose connection to our TRANSPORT
 860  *          subsystem will be notified through the connect_notify_cb. Can be NULL
 861  * @param connect_notify_cb the callback to call when the given target peer is
 862  *          connected. This callback will only be called once or never again (in
 863  *          case the target peer cannot be connected). Can be NULL
 864  * @param connect_notify_cb_cls the closure for the above callback
 865  * @return the handle which can be used cancel or mark that the handle is no
 866  *           longer being used
 867  */
 868 struct GSTCacheGetHandle *
 869 GST_cache_get_handle_transport (unsigned int peer_id,
 870                                 const struct GNUNET_CONFIGURATION_Handle *cfg,
 871                                 GST_cache_handle_ready_cb cb, void *cb_cls,
 872                                 const struct GNUNET_PeerIdentity *target,
 873                                 GST_cache_peer_connect_notify connect_notify_cb,
 874                                 void *connect_notify_cb_cls);
 875
 876
 877 /**
 878  * Get a CORE handle with the given configuration. If the handle is already
 879  * cached before, it will be retured in the given callback; the peer_id is used
 880  * to lookup in the cache. If the handle is not cached before, a new operation
 881  * is started to open the CORE handle and will be given in the callback when it
 882  * is available along with the peer identity
 883  *
 884  * @param peer_id the index of the peer
 885  * @param cfg the configuration with which the transport handle has to be
 886  *          created if it was not present in the cache
 887  * @param cb the callback to notify when the transport handle is available
 888  * @param cb_cls the closure for the above callback
 889  * @param target the peer identify of the peer whose connection to our CORE
 890  *          subsystem will be notified through the connect_notify_cb. Can be NULL
 891  * @param connect_notify_cb the callback to call when the given target peer is
 892  *          connected. This callback will only be called once or never again (in
 893  *          case the target peer cannot be connected). Can be NULL
 894  * @param connect_notify_cb_cls the closure for the above callback
 895  * @return the handle which can be used cancel or mark that the handle is no
 896  *           longer being used
 897  */
 898 struct GSTCacheGetHandle *
 899 GST_cache_get_handle_core (unsigned int peer_id,
 900                            const struct GNUNET_CONFIGURATION_Handle *cfg,
 901                            GST_cache_handle_ready_cb cb, void *cb_cls,
 902                            const struct GNUNET_PeerIdentity *target,
 903                            GST_cache_peer_connect_notify connect_notify_cb,
 904                            void *connect_notify_cb_cls);
 905
 906
 907 /**
 908  * Mark the GetCacheHandle as being done if a handle has been provided already
 909  * or as being cancelled if the callback for the handle hasn't been called.
 910  *
 911  * @param cgh the CacheGetHandle handle
 912  */
 913 void
 914 GST_cache_get_handle_done (struct GSTCacheGetHandle *cgh);
 915
 916
 917 /**
 918  * Initialize logging CPU and IO statisticfs.  Checks the configuration for
 919  * "STATS_DIR" and logs to a file in that directory.  The file is name is
 920  * generated from the hostname and the process's PID.
 921  */
 922 void
 923 GST_stats_init (const struct GNUNET_CONFIGURATION_Handle *cfg);
 924
 925
 926 /**
 927  * Shutdown the status calls module.
 928  */
 929 void
 930 GST_stats_destroy ();
 931
 932 /* End of gnunet-service-testbed.h */