/*
This file is part of GNUnet.
- (C) 2012 Christian Grothoff (and other contributing authors)
+ (C) 2008--2013 Christian Grothoff (and other contributing authors)
GNUnet is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published
* @author Sree Harsha Totakura
*/
+#include "platform.h"
#include "gnunet_util_lib.h"
#include "gnunet_testbed_service.h"
#include "gnunet_transport_service.h"
#include "testbed_api_operations.h"
#include "testbed_api_hosts.h"
#include "gnunet_testing_lib.h"
+#include "gnunet-service-testbed_links.h"
/**
*/
#define LIST_GROW_STEP 10
-/**
- * Default timeout for operations which may take some time
- */
-#define TIMEOUT GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_SECONDS, 15)
-
/**
* A routing entry
* The prev pointer for DLL
*/
struct ForwardedOperationContext *prev;
-
+
/**
* The generated operation context
*/
};
-/**
- * Structure representing a connected(directly-linked) controller
- */
-struct Slave
-{
- /**
- * The controller process handle if we had started the controller
- */
- struct GNUNET_TESTBED_ControllerProc *controller_proc;
-
- /**
- * The controller handle
- */
- struct GNUNET_TESTBED_Controller *controller;
-
- /**
- * The configuration of the slave. Cannot be NULL
- */
- struct GNUNET_CONFIGURATION_Handle *cfg;
-
- /**
- * handle to lcc which is associated with this slave startup. Should be set to
- * NULL when the slave has successfully started up
- */
- struct LinkControllersContext *lcc;
-
- /**
- * Head of the host registration DLL
- */
- struct HostRegistration *hr_dll_head;
-
- /**
- * Tail of the host registration DLL
- */
- struct HostRegistration *hr_dll_tail;
-
- /**
- * The current host registration handle
- */
- struct GNUNET_TESTBED_HostRegistrationHandle *rhandle;
-
- /**
- * Hashmap to hold Registered host contexts
- */
- struct GNUNET_CONTAINER_MultiHashMap *reghost_map;
-
- /**
- * The id of the host this controller is running on
- */
- uint32_t host_id;
-
-};
-
-
/**
* A peer
*/
struct Peer
{
-
+
union
{
struct
* peer is configured with
*/
struct GNUNET_CONFIGURATION_Handle *cfg;
-
+
/**
* Is the peer running
*/
/**
- * Context information for transport try connect
+ * The main context information associated with the client which started us
*/
-struct TryConnectContext
+struct Context
{
/**
- * The identity of the peer to which the transport has to attempt a connection
- */
- struct GNUNET_PeerIdentity *pid;
-
- /**
- * The transport handle
- */
- struct GNUNET_TRANSPORT_Handle *th;
-
- /**
- * the try connect handle
+ * The client handle associated with this context
*/
- struct GNUNET_TRANSPORT_TryConnectHandle *tch;
+ struct GNUNET_SERVER_Client *client;
/**
- * The task handle
+ * The network address of the master controller
*/
- GNUNET_SCHEDULER_TaskIdentifier task;
+ char *master_ips;
/**
- * The id of the operation which is resposible for this context
+ * The TESTING system handle for starting peers locally
*/
- uint64_t op_id;
+ struct GNUNET_TESTING_System *system;
/**
- * The number of times we attempted to connect
+ * Our host id according to this context
*/
- unsigned int retries;
-
+ uint32_t host_id;
};
/**
- * Context information for connecting 2 peers in overlay
+ * The structure for identifying a shared service
*/
-struct OverlayConnectContext
+struct SharedService
{
/**
- * The next pointer for maintaining a DLL
+ * The name of the shared service
*/
- struct OverlayConnectContext *next;
+ char *name;
/**
- * The prev pointer for maintaining a DLL
- */
- struct OverlayConnectContext *prev;
-
- /**
- * The client which has requested for overlay connection
+ * Number of shared peers per instance of the shared service
*/
- struct GNUNET_SERVER_Client *client;
+ uint32_t num_shared;
/**
- * the peer which has to connect to the other peer
+ * Number of peers currently sharing the service
*/
- struct Peer *peer;
+ uint32_t num_sharing;
+};
- /**
- * Transport handle of the first peer to get its HELLO
- */
- struct GNUNET_TRANSPORT_Handle *p1th;
+/**
+ * Context information to used during operations which forward the overlay
+ * connect message
+ */
+struct ForwardedOverlayConnectContext
+{
/**
- * Core handles of the first peer; used to notify when second peer connects to it
+ * next ForwardedOverlayConnectContext in the DLL
*/
- struct GNUNET_CORE_Handle *ch;
+ struct ForwardedOverlayConnectContext *next;
/**
- * HELLO of the other peer
+ * previous ForwardedOverlayConnectContext in the DLL
*/
- struct GNUNET_MessageHeader *hello;
+ struct ForwardedOverlayConnectContext *prev;
/**
- * Get hello handle to acquire HELLO of first peer
+ * A copy of the original overlay connect message
*/
- struct GNUNET_TRANSPORT_GetHelloHandle *ghh;
+ struct GNUNET_MessageHeader *orig_msg;
/**
- * The handle for offering HELLO
+ * The client handle
*/
- struct GNUNET_TRANSPORT_OfferHelloHandle *ohh;
+ struct GNUNET_SERVER_Client *client;
/**
- * The error message we send if this overlay connect operation has timed out
+ * The id of the operation which created this context information
*/
- char *emsg;
+ uint64_t operation_id;
/**
- * Operation context for suboperations
+ * the id of peer 1
*/
- struct OperationContext *opc;
+ uint32_t peer1;
/**
- * Controller of peer 2; NULL if the peer is local
+ * The id of peer 2
*/
- struct GNUNET_TESTBED_Controller *peer2_controller;
+ uint32_t peer2;
/**
- * The transport try connect context
+ * Id of the host where peer2 is running
*/
- struct TryConnectContext tcc;
+ uint32_t peer2_host_id;
+};
- /**
- * The peer identity of the first peer
- */
- struct GNUNET_PeerIdentity peer_identity;
+/**
+ * This context information will be created for each host that is registered at
+ * slave controllers during overlay connects.
+ */
+struct RegisteredHostContext
+{
/**
- * The peer identity of the other peer
+ * The host which is being registered
*/
- struct GNUNET_PeerIdentity other_peer_identity;
+ struct GNUNET_TESTBED_Host *reg_host;
/**
- * The id of the operation responsible for creating this context
+ * The host of the controller which has to connect to the above rhost
*/
- uint64_t op_id;
+ struct GNUNET_TESTBED_Host *host;
/**
- * The id of the task for sending HELLO of peer 2 to peer 1 and ask peer 1 to
- * connect to peer 2
+ * Head of the ForwardedOverlayConnectContext DLL
*/
- GNUNET_SCHEDULER_TaskIdentifier send_hello_task;
+ struct ForwardedOverlayConnectContext *focc_dll_head;
/**
- * The id of the overlay connect timeout task
+ * Tail of the ForwardedOverlayConnectContext DLL
*/
- GNUNET_SCHEDULER_TaskIdentifier timeout_task;
+ struct ForwardedOverlayConnectContext *focc_dll_tail;
/**
- * The id of the cleanup task
+ * Enumeration of states for this context
*/
- GNUNET_SCHEDULER_TaskIdentifier cleanup_task;
+ enum RHCState
+ {
- /**
- * The id of peer A
- */
- uint32_t peer_id;
+ /**
+ * The initial state
+ */
+ RHC_INIT = 0,
- /**
- * The id of peer B
- */
- uint32_t other_peer_id;
+ /**
+ * State where we attempt to do the overlay connection again
+ */
+ RHC_DONE
+ } state;
};
/**
- * Context information for RequestOverlayConnect
- * operations. RequestOverlayConnect is used when peers A, B reside on different
- * hosts and the host controller for peer B is asked by the host controller of
- * peer A to make peer B connect to peer A
+ * Context data for GNUNET_MESSAGE_TYPE_TESTBED_SHUTDOWN_PEERS handler
*/
-struct RequestOverlayConnectContext
+struct HandlerContext_ShutdownPeers
{
/**
- * the next pointer for DLL
+ * The number of slave we expect to hear from since we forwarded the
+ * GNUNET_MESSAGE_TYPE_TESTBED_SHUTDOWN_PEERS message to them
*/
- struct RequestOverlayConnectContext *next;
+ unsigned int nslaves;
/**
- * the prev pointer for DLL
+ * Did we observe a timeout with respect to this operation at any of the
+ * slaves
*/
- struct RequestOverlayConnectContext *prev;
+ int timeout;
+};
- /**
- * The peer handle of peer B
- */
- struct Peer *peer;
-
- /**
- * Peer A's HELLO
- */
- struct GNUNET_MessageHeader *hello;
- /**
- * The handle for offering HELLO
- */
- struct GNUNET_TRANSPORT_OfferHelloHandle *ohh;
+/**
+ * Our configuration
+ */
+extern struct GNUNET_CONFIGURATION_Handle *our_config;
- /**
- * The transport try connect context
- */
- struct TryConnectContext tcc;
+/**
+ * The master context; generated with the first INIT message
+ */
+extern struct Context *GST_context;
- /**
- * The peer identity of peer A
- */
- struct GNUNET_PeerIdentity a_id;
+/**
+ * DLL head for forwarded operation contexts
+ */
+extern struct ForwardedOperationContext *fopcq_head;
- /**
- * Task for offering HELLO of A to B and doing try_connect
- */
- GNUNET_SCHEDULER_TaskIdentifier attempt_connect_task_id;
-
- /**
- * Task to timeout RequestOverlayConnect
- */
- GNUNET_SCHEDULER_TaskIdentifier timeout_rocc_task_id;
-
- /**
- * The id of the operation responsible for creating this context
- */
- uint64_t op_id;
-};
+/**
+ * DLL tail for forwarded operation contexts
+ */
+extern struct ForwardedOperationContext *fopcq_tail;
+/**
+ * A list of peers we know about
+ */
+extern struct Peer **GST_peer_list;
/**
- * Context information to used during operations which forward the overlay
- * connect message
+ * Array of hosts
*/
-struct ForwardedOverlayConnectContext
-{
- /**
- * next ForwardedOverlayConnectContext in the DLL
- */
- struct ForwardedOverlayConnectContext *next;
+extern struct GNUNET_TESTBED_Host **GST_host_list;
- /**
- * previous ForwardedOverlayConnectContext in the DLL
- */
- struct ForwardedOverlayConnectContext *prev;
+/**
+ * Operation queue for open file descriptors
+ */
+extern struct OperationQueue *GST_opq_openfds;
- /**
- * A copy of the original overlay connect message
- */
- struct GNUNET_MessageHeader *orig_msg;
+/**
+ * Timeout for operations which may take some time
+ */
+const extern struct GNUNET_TIME_Relative GST_timeout;
- /**
- * The id of the operation which created this context information
- */
- uint64_t operation_id;
+/**
+ * The size of the peer list
+ */
+extern unsigned int GST_peer_list_size;
- /**
- * the id of peer 1
- */
- uint32_t peer1;
-
- /**
- * The id of peer 2
- */
- uint32_t peer2;
-
- /**
- * Id of the host where peer2 is running
- */
- uint32_t peer2_host_id;
-};
+/**
+ * The size of the host list
+ */
+extern unsigned int GST_host_list_size;
+/**
+ * The directory where to store load statistics data
+ */
+extern char *GST_stats_dir;
/**
- * The main context information associated with the client which started us
+ * Condition to check if host id is valid
*/
-struct Context
-{
- /**
- * The client handle associated with this context
- */
- struct GNUNET_SERVER_Client *client;
+#define VALID_HOST_ID(id) \
+ ( ((id) < GST_host_list_size) && (NULL != GST_host_list[id]) )
- /**
- * The network address of the master controller
- */
- char *master_ip;
+/**
+ * Condition to check if peer id is valid
+ */
+#define VALID_PEER_ID(id) \
+ ( ((id) < GST_peer_list_size) && (NULL != GST_peer_list[id]) )
- /**
- * The TESTING system handle for starting peers locally
- */
- struct GNUNET_TESTING_System *system;
-
- /**
- * Our host id according to this context
- */
- uint32_t host_id;
-};
+
+/**
+ * Similar to GNUNET_array_grow(); however instead of calling GNUNET_array_grow()
+ * several times we call it only once. The array is also made to grow in steps
+ * of LIST_GROW_STEP.
+ *
+ * @param ptr the array pointer to grow
+ * @param size the size of array
+ * @param accommodate_size the size which the array has to accommdate; after
+ * this call the array will be big enough to accommdate sizes upto
+ * accommodate_size
+ */
+#define GST_array_grow_large_enough(ptr, size, accommodate_size) \
+ do \
+ { \
+ unsigned int growth_size; \
+ GNUNET_assert (size <= accommodate_size); \
+ growth_size = size; \
+ while (growth_size <= accommodate_size) \
+ growth_size += LIST_GROW_STEP; \
+ GNUNET_array_grow (ptr, size, growth_size); \
+ GNUNET_assert (size > accommodate_size); \
+ } while (0)
/**
- * The structure for identifying a shared service
+ * Queues a message in send queue for sending to the service
+ *
+ * @param client the client to whom the queued message has to be sent
+ * @param msg the message to queue
*/
-struct SharedService
-{
- /**
- * The name of the shared service
- */
- char *name;
+void
+GST_queue_message (struct GNUNET_SERVER_Client *client,
+ struct GNUNET_MessageHeader *msg);
- /**
- * Number of shared peers per instance of the shared service
- */
- uint32_t num_shared;
- /**
- * Number of peers currently sharing the service
- */
- uint32_t num_sharing;
-};
+/**
+ * Function to destroy a peer
+ *
+ * @param peer the peer structure to destroy
+ */
+void
+GST_destroy_peer (struct Peer *peer);
/**
- * This context information will be created for each host that is registered at
- * slave controllers during overlay connects.
+ * Stops and destroys all peers
*/
-struct RegisteredHostContext
-{
- /**
- * The host which is being registered
- */
- struct GNUNET_TESTBED_Host *reg_host;
+void
+GST_destroy_peers ();
- /**
- * The host of the controller which has to connect to the above rhost
- */
- struct GNUNET_TESTBED_Host *host;
- /**
- * The gateway to which this operation is forwarded to
- */
- struct Slave *gateway;
+/**
+ * Finds the route with directly connected host as destination through which
+ * the destination host can be reached
+ *
+ * @param host_id the id of the destination host
+ * @return the route with directly connected destination host; NULL if no route
+ * is found
+ */
+struct Route *
+GST_find_dest_route (uint32_t host_id);
- /**
- * The gateway through which peer2's controller can be reached
- */
- struct Slave *gateway2;
- /**
- * Handle for sub-operations
- */
- struct GNUNET_TESTBED_Operation *sub_op;
+/**
+ * Handler for GNUNET_MESSAGE_TYPE_TESTBED_OLCONNECT messages
+ *
+ * @param cls NULL
+ * @param client identification of the client
+ * @param message the actual message
+ */
+void
+GST_handle_overlay_connect (void *cls, struct GNUNET_SERVER_Client *client,
+ const struct GNUNET_MessageHeader *message);
- /**
- * The client which initiated the link controller operation
- */
- struct GNUNET_SERVER_Client *client;
- /**
- * Head of the ForwardedOverlayConnectContext DLL
- */
- struct ForwardedOverlayConnectContext *focc_dll_head;
+/**
+ * Adds a host registration's request to a slave's registration queue
+ *
+ * @param slave the slave controller at which the given host has to be
+ * registered
+ * @param cb the host registration completion callback
+ * @param cb_cls the closure for the host registration completion callback
+ * @param host the host which has to be registered
+ */
+void
+GST_queue_host_registration (struct Slave *slave,
+ GNUNET_TESTBED_HostRegistrationCompletion cb,
+ void *cb_cls, struct GNUNET_TESTBED_Host *host);
- /**
- * Tail of the ForwardedOverlayConnectContext DLL
- */
- struct ForwardedOverlayConnectContext *focc_dll_tail;
-
- /**
- * Enumeration of states for this context
- */
- enum RHCState {
- /**
- * The initial state
- */
- RHC_INIT = 0,
+/**
+ * Callback to relay the reply msg of a forwarded operation back to the client
+ *
+ * @param cls ForwardedOperationContext
+ * @param msg the message to relay
+ */
+void
+GST_forwarded_operation_reply_relay (void *cls,
+ const struct GNUNET_MessageHeader *msg);
- /**
- * State where we attempt to get peer2's controller configuration
- */
- RHC_GET_CFG,
- /**
- * State where we attempt to link the controller of peer 1 to the controller
- * of peer2
- */
- RHC_LINK,
+/**
+ * Task to free resources when forwarded operation has been timedout
+ *
+ * @param cls the ForwardedOperationContext
+ * @param tc the task context from scheduler
+ */
+void
+GST_forwarded_operation_timeout (void *cls,
+ const struct GNUNET_SCHEDULER_TaskContext *tc);
- /**
- * State where we attempt to do the overlay connection again
- */
- RHC_OL_CONNECT
-
- } state;
-};
+/**
+ * Clears the forwarded operations queue
+ */
+void
+GST_clear_fopcq ();
/**
- * States of LCFContext
+ * Send operation failure message to client
+ *
+ * @param client the client to which the failure message has to be sent to
+ * @param operation_id the id of the failed operation
+ * @param emsg the error message; can be NULL
*/
-enum LCFContextState
-{
- /**
- * The Context has been initialized; Nothing has been done on it
- */
- INIT,
+void
+GST_send_operation_fail_msg (struct GNUNET_SERVER_Client *client,
+ uint64_t operation_id, const char *emsg);
- /**
- * Delegated host has been registered at the forwarding controller
- */
- DELEGATED_HOST_REGISTERED,
-
- /**
- * The slave host has been registred at the forwarding controller
- */
- SLAVE_HOST_REGISTERED,
-
- /**
- * The context has been finished (may have error)
- */
- FINISHED
-};
+
+/**
+ * Function to send generic operation success message to given client
+ *
+ * @param client the client to send the message to
+ * @param operation_id the id of the operation which was successful
+ */
+void
+GST_send_operation_success_msg (struct GNUNET_SERVER_Client *client,
+ uint64_t operation_id);
/**
- * Link controllers request forwarding context
+ * Handler for GNUNET_MESSAGE_TYPE_TESTBED_REQUESTCONNECT messages
+ *
+ * @param cls NULL
+ * @param client identification of the client
+ * @param message the actual message
*/
-struct LCFContext
-{
- /**
- * The gateway which will pass the link message to delegated host
- */
- struct Slave *gateway;
+void
+GST_handle_remote_overlay_connect (void *cls,
+ struct GNUNET_SERVER_Client *client,
+ const struct GNUNET_MessageHeader *message);
- /**
- * The controller link message that has to be forwarded to
- */
- struct GNUNET_TESTBED_ControllerLinkMessage *msg;
- /**
- * The client which has asked to perform this operation
- */
- struct GNUNET_SERVER_Client *client;
+/**
+ * Handler for GNUNET_MESSAGE_TYPE_TESTBED_CREATEPEER messages
+ *
+ * @param cls NULL
+ * @param client identification of the client
+ * @param message the actual message
+ */
+void
+GST_handle_peer_create (void *cls, struct GNUNET_SERVER_Client *client,
+ const struct GNUNET_MessageHeader *message);
- /**
- * Handle for operations which are forwarded while linking controllers
- */
- struct ForwardedOperationContext *fopc;
- /**
- * The id of the operation which created this context
- */
- uint64_t operation_id;
+/**
+ * Message handler for GNUNET_MESSAGE_TYPE_TESTBED_DESTROYPEER messages
+ *
+ * @param cls NULL
+ * @param client identification of the client
+ * @param message the actual message
+ */
+void
+GST_handle_peer_destroy (void *cls, struct GNUNET_SERVER_Client *client,
+ const struct GNUNET_MessageHeader *message);
- /**
- * The state of this context
- */
- enum LCFContextState state;
- /**
- * The delegated host
- */
- uint32_t delegated_host_id;
+/**
+ * Message handler for GNUNET_MESSAGE_TYPE_TESTBED_DESTROYPEER messages
+ *
+ * @param cls NULL
+ * @param client identification of the client
+ * @param message the actual message
+ */
+void
+GST_handle_peer_start (void *cls, struct GNUNET_SERVER_Client *client,
+ const struct GNUNET_MessageHeader *message);
- /**
- * The slave host
- */
- uint32_t slave_host_id;
-};
+/**
+ * Message handler for GNUNET_MESSAGE_TYPE_TESTBED_DESTROYPEER messages
+ *
+ * @param cls NULL
+ * @param client identification of the client
+ * @param message the actual message
+ */
+void
+GST_handle_peer_stop (void *cls, struct GNUNET_SERVER_Client *client,
+ const struct GNUNET_MessageHeader *message);
/**
- * Structure of a queue entry in LCFContext request queue
+ * Handler for GNUNET_MESSAGE_TYPE_TESTBED_GETPEERCONFIG messages
+ *
+ * @param cls NULL
+ * @param client identification of the client
+ * @param message the actual message
*/
-struct LCFContextQueue
-{
- /**
- * The LCFContext
- */
- struct LCFContext *lcf;
+void
+GST_handle_peer_get_config (void *cls, struct GNUNET_SERVER_Client *client,
+ const struct GNUNET_MessageHeader *message);
- /**
- * Head prt for DLL
- */
- struct LCFContextQueue *next;
- /**
- * Tail ptr for DLL
- */
- struct LCFContextQueue *prev;
-};
+/**
+ * Handler for GNUNET_MESSAGE_TYPE_TESTBED_SHUTDOWN_PEERS messages
+ *
+ * @param cls NULL
+ * @param client identification of the client
+ * @param message the actual message
+ */
+void
+GST_handle_shutdown_peers (void *cls, struct GNUNET_SERVER_Client *client,
+ const struct GNUNET_MessageHeader *message);
/**
- * Hello cache entry
+ * Handler for GNUNET_TESTBED_ManagePeerServiceMessage message
+ *
+ * @param cls NULL
+ * @param client identification of client
+ * @param message the actual message
*/
-struct HelloCacheEntry
-{
- /**
- * DLL next ptr for least recently used hello cache entries
- */
- struct HelloCacheEntry *next;
+void
+GST_handle_manage_peer_service (void *cls, struct GNUNET_SERVER_Client *client,
+ const struct GNUNET_MessageHeader *message);
- /**
- * DLL prev ptr for least recently used hello cache entries
- */
- struct HelloCacheEntry *prev;
- /**
- * The key for this entry
- */
- struct GNUNET_HashCode key;
-
- /**
- * The HELLO message
- */
- struct GNUNET_MessageHeader *hello;
-};
+/**
+ * Handler for GNUNET_MESSAGE_TYPDE_TESTBED_RECONFIGURE_PEER type messages.
+ * Should stop the peer asyncronously, destroy it and create it again with the
+ * new configuration.
+ *
+ * @param cls NULL
+ * @param client identification of the client
+ * @param message the actual message
+ */
+void
+GST_handle_peer_reconfigure (void *cls, struct GNUNET_SERVER_Client *client,
+ const struct GNUNET_MessageHeader *message);
+
+
+/**
+ * Frees the ManageServiceContext queue
+ */
+void
+GST_free_mctxq ();
+
+
+/**
+ * Cleans up the queue used for forwarding link controllers requests
+ */
+void
+GST_free_lcfq ();
+
+
+/**
+ * Cleans up the route list
+ */
+void
+GST_route_list_clear ();
+
+
+/**
+ * Processes a forwarded overlay connect context in the queue of the given RegisteredHostContext
+ *
+ * @param rhc the RegisteredHostContext
+ */
+void
+GST_process_next_focc (struct RegisteredHostContext *rhc);
+
+
+/**
+ * Cleans up ForwardedOverlayConnectContext
+ *
+ * @param focc the ForwardedOverlayConnectContext to cleanup
+ */
+void
+GST_cleanup_focc (struct ForwardedOverlayConnectContext *focc);
+
+
+/**
+ * Clears all pending overlay connect contexts in queue
+ */
+void
+GST_free_occq ();
+
+
+/**
+ * Clears all pending remote overlay connect contexts in queue
+ */
+void
+GST_free_roccq ();
+
+
+/**
+ * Cleans up the Peer reconfigure context list
+ */
+void
+GST_free_prcq ();
+
+
+/**
+ * Initializes the cache
+ *
+ * @param size the size of the cache
+ */
+void
+GST_cache_init (unsigned int size);
+
+
+/**
+ * Clear cache
+ */
+void
+GST_cache_clear ();
+
+
+/**
+ * Looks up in the hello cache and returns the HELLO of the given peer
+ *
+ * @param peer_id the index of the peer whose HELLO has to be looked up
+ * @return the HELLO message; NULL if not found
+ */
+const struct GNUNET_MessageHeader *
+GST_cache_lookup_hello (const unsigned int peer_id);
+
+
+/**
+ * Caches the HELLO of the given peer. Updates the HELLO if it was already
+ * cached before
+ *
+ * @param peer_id the peer identity of the peer whose HELLO has to be cached
+ * @param hello the HELLO message
+ */
+void
+GST_cache_add_hello (const unsigned int peer_id,
+ const struct GNUNET_MessageHeader *hello);
+
+
+/**
+ * Functions of this type are called when the needed handle is available for
+ * usage. These functions are to be registered with either of the functions
+ * GST_cache_get_handle_transport() or GST_cache_get_handle_core(). The
+ * corresponding handles will be set and if they are not, then it signals an
+ * error while opening the handles.
+ *
+ * @param cls the closure passed to GST_cache_get_handle_transport() or
+ * GST_cache_get_handle_core()
+ * @param ch the handle to CORE. Can be NULL if it is not requested
+ * @param th the handle to TRANSPORT. Can be NULL if it is not requested
+ * @param peer_id the identity of the peer. Will be NULL if ch is NULL. In other
+ * cases, its value being NULL means that CORE connection has failed.
+ */
+typedef void (*GST_cache_handle_ready_cb) (void *cls,
+ struct GNUNET_CORE_Handle * ch,
+ struct GNUNET_TRANSPORT_Handle * th,
+ const struct GNUNET_PeerIdentity *
+ peer_id);
+
+
+/**
+ * Callback to notify when the target peer given to
+ * GST_cache_get_handle_transport() is connected. Note that this callback may
+ * not be called if the target peer is already connected. Use
+ * GNUNET_TRANSPORT_check_neighbour_connected() to check if the target peer is
+ * already connected or not. This callback will be called only once or never (in
+ * case the target cannot be connected).
+ *
+ * @param cls the closure given to GST_cache_get_handle_done() for this callback
+ * @param target the peer identity of the target peer. The pointer should be
+ * valid until GST_cache_get_handle_done() is called.
+ */
+typedef void (*GST_cache_peer_connect_notify) (void *cls,
+ const struct GNUNET_PeerIdentity
+ * target);
+
+
+/**
+ * Get a transport handle with the given configuration. If the handle is already
+ * cached before, it will be retured in the given callback; the peer_id is used to lookup in the
+ * cache. If not a new operation is started to open the transport handle and
+ * will be given in the callback when it is available.
+ *
+ * @param peer_id the index of the peer
+ * @param cfg the configuration with which the transport handle has to be
+ * created if it was not present in the cache
+ * @param cb the callback to notify when the transport handle is available
+ * @param cb_cls the closure for the above callback
+ * @param target the peer identify of the peer whose connection to our TRANSPORT
+ * subsystem will be notified through the connect_notify_cb. Can be NULL
+ * @param connect_notify_cb the callback to call when the given target peer is
+ * connected. This callback will only be called once or never again (in
+ * case the target peer cannot be connected). Can be NULL
+ * @param connect_notify_cb_cls the closure for the above callback
+ * @return the handle which can be used cancel or mark that the handle is no
+ * longer being used
+ */
+struct GSTCacheGetHandle *
+GST_cache_get_handle_transport (unsigned int peer_id,
+ const struct GNUNET_CONFIGURATION_Handle *cfg,
+ GST_cache_handle_ready_cb cb, void *cb_cls,
+ const struct GNUNET_PeerIdentity *target,
+ GST_cache_peer_connect_notify connect_notify_cb,
+ void *connect_notify_cb_cls);
+
+
+/**
+ * Get a CORE handle with the given configuration. If the handle is already
+ * cached before, it will be retured in the given callback; the peer_id is used
+ * to lookup in the cache. If the handle is not cached before, a new operation
+ * is started to open the CORE handle and will be given in the callback when it
+ * is available along with the peer identity
+ *
+ * @param peer_id the index of the peer
+ * @param cfg the configuration with which the transport handle has to be
+ * created if it was not present in the cache
+ * @param cb the callback to notify when the transport handle is available
+ * @param cb_cls the closure for the above callback
+ * @param target the peer identify of the peer whose connection to our CORE
+ * subsystem will be notified through the connect_notify_cb. Can be NULL
+ * @param connect_notify_cb the callback to call when the given target peer is
+ * connected. This callback will only be called once or never again (in
+ * case the target peer cannot be connected). Can be NULL
+ * @param connect_notify_cb_cls the closure for the above callback
+ * @return the handle which can be used cancel or mark that the handle is no
+ * longer being used
+ */
+struct GSTCacheGetHandle *
+GST_cache_get_handle_core (unsigned int peer_id,
+ const struct GNUNET_CONFIGURATION_Handle *cfg,
+ GST_cache_handle_ready_cb cb, void *cb_cls,
+ const struct GNUNET_PeerIdentity *target,
+ GST_cache_peer_connect_notify connect_notify_cb,
+ void *connect_notify_cb_cls);
+
+
+/**
+ * Mark the GetCacheHandle as being done if a handle has been provided already
+ * or as being cancelled if the callback for the handle hasn't been called.
+ *
+ * @param cgh the CacheGetHandle handle
+ */
+void
+GST_cache_get_handle_done (struct GSTCacheGetHandle *cgh);
+
+
+/**
+ * Initialize logging CPU and IO statisticfs. Checks the configuration for
+ * "STATS_DIR" and logs to a file in that directory. The file is name is
+ * generated from the hostname and the process's PID.
+ */
+void
+GST_stats_init (const struct GNUNET_CONFIGURATION_Handle *cfg);
+
+
+/**
+ * Shutdown the status calls module.
+ */
+void
+GST_stats_destroy ();
+/* End of gnunet-service-testbed.h */
projects / oweals / gnunet.git / blobdiff