GNUnet  0.17.6
Typedefs | Enumerations | Functions
gnunet-service-testbed_connectionpool.h File Reference

Interface for connection pooling subroutines. More...

#include "gnunet_ats_service.h"
#include "gnunet_core_service.h"
#include "gnunet_transport_service.h"
Include dependency graph for gnunet-service-testbed_connectionpool.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Typedefs

typedef void(* GST_connection_pool_connection_ready_cb) (void *cls, struct GNUNET_CORE_Handle *ch, struct GNUNET_TRANSPORT_CoreHandle *th, struct GNUNET_ATS_ConnectivityHandle *ac, const struct GNUNET_PeerIdentity *peer_id, const struct GNUNET_CONFIGURATION_Handle *cfg)
 Functions of this type are called when the needed handle is available for usage. More...
 
typedef void(* GST_connection_pool_peer_connect_notify) (void *cls, const struct GNUNET_PeerIdentity *target)
 Callback to notify when the target peer given to GST_connection_pool_get_handle() is connected. More...
 

Enumerations

enum  GST_ConnectionPool_Service { GST_CONNECTIONPOOL_SERVICE_TRANSPORT = 1 , GST_CONNECTIONPOOL_SERVICE_CORE , GST_CONNECTIONPOOL_SERVICE_ATS_CONNECTIVITY }
 The type of service. More...
 

Functions

void GST_connection_pool_init (unsigned int size)
 Initialise the connection pool. More...
 
void GST_connection_pool_destroy (void)
 Cleanup the connection pool. More...
 
struct GST_ConnectionPool_GetHandleGST_connection_pool_get_handle (unsigned int peer_id, const struct GNUNET_CONFIGURATION_Handle *cfg, enum GST_ConnectionPool_Service service, GST_connection_pool_connection_ready_cb cb, void *cb_cls, const struct GNUNET_PeerIdentity *target, GST_connection_pool_peer_connect_notify connect_notify_cb, void *connect_notify_cb_cls)
 Get a connection handle to service. More...
 
void GST_connection_pool_get_handle_done (struct GST_ConnectionPool_GetHandle *gh)
 Relinquish a GST_ConnectionPool_GetHandle object. More...
 

Detailed Description

Interface for connection pooling subroutines.

Author
Sree Harsha Totakura sreeh.nosp@m.arsh.nosp@m.a@tot.nosp@m.akur.nosp@m.a.in

Definition in file gnunet-service-testbed_connectionpool.h.

Typedef Documentation

◆ GST_connection_pool_connection_ready_cb

typedef void(* GST_connection_pool_connection_ready_cb) (void *cls, struct GNUNET_CORE_Handle *ch, struct GNUNET_TRANSPORT_CoreHandle *th, struct GNUNET_ATS_ConnectivityHandle *ac, const struct GNUNET_PeerIdentity *peer_id, const struct GNUNET_CONFIGURATION_Handle *cfg)

Functions of this type are called when the needed handle is available for usage.

These functions are to be registered with the function GST_connection_pool_get_handle(). The corresponding handles will be set upon success. If they are not set, then it signals an error while opening the handles.

Parameters
clsthe closure passed to GST_connection_pool_get_handle()
chthe handle to CORE. Can be NULL if it is not requested
ththe handle to TRANSPORT. Can be NULL if it is not requested
acthe handle to ATS, can be NULL if it is not requested
peer_idthe identity of the peer. Will be NULL if ch is NULL. In other cases, its value being NULL means that CORE connection has failed.
cfgconfiguration of the peer

Definition at line 90 of file gnunet-service-testbed_connectionpool.h.

◆ GST_connection_pool_peer_connect_notify

typedef void(* GST_connection_pool_peer_connect_notify) (void *cls, const struct GNUNET_PeerIdentity *target)

Callback to notify when the target peer given to GST_connection_pool_get_handle() is connected.

Parameters
clsthe closure given to GST_connection_pool_get_handle() for this callback
targetthe peer identity of the target peer

Definition at line 107 of file gnunet-service-testbed_connectionpool.h.

Enumeration Type Documentation

◆ GST_ConnectionPool_Service

The type of service.

Enumerator
GST_CONNECTIONPOOL_SERVICE_TRANSPORT 

Transport service.

GST_CONNECTIONPOOL_SERVICE_CORE 

Core service.

GST_CONNECTIONPOOL_SERVICE_ATS_CONNECTIVITY 

ATS service.

Definition at line 39 of file gnunet-service-testbed_connectionpool.h.

40 {
45 
50 
55 };
@ GST_CONNECTIONPOOL_SERVICE_TRANSPORT
Transport service.
@ GST_CONNECTIONPOOL_SERVICE_CORE
Core service.
@ GST_CONNECTIONPOOL_SERVICE_ATS_CONNECTIVITY
ATS service.

Function Documentation

◆ GST_connection_pool_init()

void GST_connection_pool_init ( unsigned int  size)

Initialise the connection pool.

Parameters
sizethe size of the connection pool. Each entry in the connection pool can handle a connection to each of the services enumerated in GST_ConnectionPool_Service

Definition at line 767 of file gnunet-service-testbed_connectionpool.c.

768 {
769  max_size = size;
770  if (0 == max_size)
771  return;
772  GNUNET_assert (NULL == map);
773  map = GNUNET_CONTAINER_multihashmap32_create (((size * 3) / 4) + 1);
774 }
static struct GNUNET_CONTAINER_MultiHashMap32 * map
A hashmap for quickly finding connections in the connection pool.
static unsigned int max_size
The maximum number of entries that can be present in the connection pool.
struct GNUNET_CONTAINER_MultiHashMap32 * GNUNET_CONTAINER_multihashmap32_create(unsigned int len)
Create a 32-bit key multi hash map.
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
static unsigned int size
Size of the "table".
Definition: peer.c:67

References GNUNET_assert, GNUNET_CONTAINER_multihashmap32_create(), map, max_size, and size.

Referenced by testbed_run().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GST_connection_pool_destroy()

void GST_connection_pool_destroy ( void  )

Cleanup the connection pool.

Definition at line 781 of file gnunet-service-testbed_connectionpool.c.

782 {
783  struct PooledConnection *entry;
784 
785  if (NULL != map)
786  {
787  GNUNET_assert (
788  GNUNET_SYSERR !=
791  map = NULL;
792  }
793  while (NULL != (entry = head_lru))
794  {
797  }
798  GNUNET_assert (NULL == head_not_pooled);
799 }
static void destroy_pooled_connection(struct PooledConnection *entry)
Destroy a PooledConnection object.
static struct PooledConnection * tail_lru
DLL tail for maitaining the least recently used PooledConnection objects.
static int cleanup_iterator(void *cls, uint32_t key, void *value)
This function will be called for every PooledConnection object in map.
static struct PooledConnection * head_not_pooled
DLL head for maintaining PooledConnection objects that are not added into the connection pool as it w...
static struct PooledConnection * head_lru
DLL head for maitaining the least recently used PooledConnection objects.
#define GNUNET_CONTAINER_DLL_remove(head, tail, element)
Remove an element from a DLL.
int GNUNET_CONTAINER_multihashmap32_iterate(struct GNUNET_CONTAINER_MultiHashMap32 *map, GNUNET_CONTAINER_MulitHashMapIterator32Callback it, void *it_cls)
Iterate over all entries in the map.
void GNUNET_CONTAINER_multihashmap32_destroy(struct GNUNET_CONTAINER_MultiHashMap32 *map)
Destroy a 32-bit key hash map.
@ GNUNET_SYSERR
Definition: gnunet_common.h:97

References cleanup_iterator(), destroy_pooled_connection(), GNUNET_assert, GNUNET_CONTAINER_DLL_remove, GNUNET_CONTAINER_multihashmap32_destroy(), GNUNET_CONTAINER_multihashmap32_iterate(), GNUNET_SYSERR, head_lru, head_not_pooled, map, and tail_lru.

Referenced by shutdown_task().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GST_connection_pool_get_handle()

struct GST_ConnectionPool_GetHandle* GST_connection_pool_get_handle ( unsigned int  peer_id,
const struct GNUNET_CONFIGURATION_Handle cfg,
enum GST_ConnectionPool_Service  service,
GST_connection_pool_connection_ready_cb  cb,
void *  cb_cls,
const struct GNUNET_PeerIdentity target,
GST_connection_pool_peer_connect_notify  connect_notify_cb,
void *  connect_notify_cb_cls 
)

Get a connection handle to service.

If the connection is opened before and the connection handle is present in the connection pool, it is returned through cb. peer_id is used for the lookup in the connection pool. If the connection handle is not present in the connection pool, a new connection handle is opened for the service using cfg. Additionally, target, connect_notify_cb can be specified to get notified when target is connected at service.

Note
connect_notify_cb will not be called if target is already connected service level. Use GNUNET_TRANSPORT_check_peer_connected() or a similar function from the respective service's API to check if the target peer is already connected or not. connect_notify_cb will be called only once or never (in case target cannot be connected or is already connected).
Parameters
peer_idthe index of the peer
cfgthe configuration with which the transport handle has to be created if it was not present in the cache
servicethe service of interest
cbthe callback to notify when the transport handle is available
cb_clsthe closure for cb
targetthe peer identify of the peer whose connection to our TRANSPORT subsystem will be notified through the connect_notify_cb. Can be NULL
connect_notify_cbthe callback to call when the 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
connect_notify_cb_clsthe closure for connect_notify_cb
Returns
the handle which can be used cancel or mark that the handle is no longer being used

Definition at line 835 of file gnunet-service-testbed_connectionpool.c.

844 {
846  struct PooledConnection *entry;
848  void *handle;
849  uint32_t peer_id32;
850 
851  peer_id32 = (uint32_t) peer_id;
852  handle = NULL;
853  entry = NULL;
854  if (NULL != map)
855  entry = GNUNET_CONTAINER_multihashmap32_get (map, peer_id32);
856  if (NULL != entry)
857  {
858  if (entry->in_lru)
859  {
860  GNUNET_assert (0 == entry->demand);
861  expire_task_cancel (entry);
863  entry->in_lru = GNUNET_NO;
864  }
865  switch (service)
866  {
868  handle = entry->handle_transport;
869  if (NULL != handle)
870  LOG_DEBUG ("Found TRANSPORT handle for peer %u\n",
871  entry->index);
872  break;
874  handle = entry->handle_core;
875  if (NULL != handle)
876  LOG_DEBUG ("Found CORE handle for peer %u\n",
877  entry->index);
878  break;
881  if (NULL != handle)
882  LOG_DEBUG ("Found ATS CONNECTIVITY handle for peer %u\n",
883  entry->index);
884  break;
885  }
886  }
887  else
888  {
889  entry = GNUNET_new (struct PooledConnection);
890  entry->index = peer_id32;
891  if ((NULL != map) &&
893  {
896  map,
897  entry->index,
898  entry,
900  entry->in_pool = GNUNET_YES;
901  }
902  else
903  {
906  entry);
907  }
908  entry->cfg = GNUNET_CONFIGURATION_dup (cfg);
909  }
910  entry->demand++;
912  gh->entry = entry;
913  gh->cb = cb;
914  gh->cb_cls = cb_cls;
915  gh->target = target;
916  gh->connect_notify_cb = connect_notify_cb;
917  gh->connect_notify_cb_cls = connect_notify_cb_cls;
918  gh->service = service;
920  entry->tail_waiting,
921  gh);
922  if (NULL != handle)
923  {
924  if (NULL == entry->notify_task)
925  {
926  if (NULL != search_waiting (entry, entry->head_waiting))
927  entry->notify_task =
929  }
930  return gh;
931  }
932  op = NULL;
933  switch (gh->service)
934  {
936  if (NULL != entry->op_transport)
937  return gh; /* Operation pending */
941  entry->op_transport = op;
942  break;
943 
945  if (NULL != entry->op_core)
946  return gh; /* Operation pending */
950  entry->op_core = op;
951  break;
952 
954  if (NULL != entry->op_ats_connectivity)
955  return gh; /* Operation pending */
956  op =
960  entry->op_ats_connectivity = op;
961  break;
962  }
965  return gh;
966 }
static const struct GNUNET_CONFIGURATION_Handle * cfg
Configuration we are using.
Definition: gnunet-abd.c:36
static struct GNUNET_ARM_Operation * op
Current operation.
Definition: gnunet-arm.c:144
static char * peer_id
Option –peer.
Definition: gnunet-cadet.c:42
static struct GNUNET_DNS_Handle * handle
Handle to transport service.
#define LOG_DEBUG(...)
Debug logging shorthand.
static struct GNUNET_TRANSPORT_HelloGetHandle * gh
Pending GNUNET_TRANSPORT_hello_get() operation.
static struct GNUNET_SERVICE_Handle * service
Handle to our service instance.
struct OperationQueue * GST_opq_openfds
Operation queue for open file descriptors.
static void oprelease_get_handle_ats_connectivity(void *cls)
Function called when the operation responsible for opening a ATS connection is marked as done.
static void opstart_get_handle_ats_connectivity(void *cls)
Function called when resources for opening a connection to ATS are available.
static struct GST_ConnectionPool_GetHandle * search_waiting(const struct PooledConnection *entry, struct GST_ConnectionPool_GetHandle *head)
Function to find a GST_ConnectionPool_GetHandle which is waiting for one of the handles in given entr...
static void connection_ready(void *cls)
A handle in the PooledConnection object pointed by cls is ready and there is a GST_ConnectionPool_Get...
static struct PooledConnection * tail_not_pooled
DLL tail for maintaining PooledConnection objects that are not added into the connection pool as it w...
static void oprelease_get_handle_core(void *cls)
Function called when the operation responsible for opening a CORE connection is marked as done.
static void opstart_get_handle_transport(void *cls)
Function called when resources for opening a connection to TRANSPORT are available.
static void expire_task_cancel(struct PooledConnection *entry)
Cancel the expiration task of the give PooledConnection object.
static void opstart_get_handle_core(void *cls)
Function called when resources for opening a connection to CORE are available.
static void oprelease_get_handle_transport(void *cls)
Function called when the operation responsible for opening a TRANSPORT connection is marked as done.
struct GNUNET_CONFIGURATION_Handle * GNUNET_CONFIGURATION_dup(const struct GNUNET_CONFIGURATION_Handle *cfg)
Duplicate an existing configuration object.
#define GNUNET_CONTAINER_DLL_insert_tail(head, tail, element)
Insert an element at the tail of a DLL.
#define GNUNET_CONTAINER_DLL_insert(head, tail, element)
Insert an element at the head of a DLL.
enum GNUNET_GenericReturnValue GNUNET_CONTAINER_multihashmap32_put(struct GNUNET_CONTAINER_MultiHashMap32 *map, uint32_t key, void *value, enum GNUNET_CONTAINER_MultiHashMapOption opt)
Store a key-value pair in the map.
unsigned int GNUNET_CONTAINER_multihashmap32_size(const struct GNUNET_CONTAINER_MultiHashMap32 *map)
Get the number of key-value pairs in the map.
void * GNUNET_CONTAINER_multihashmap32_get(const struct GNUNET_CONTAINER_MultiHashMap32 *map, uint32_t key)
Given a key find a value in the map matching the key.
@ GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST
, ' bother checking if a value already exists (faster than GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE...
@ GNUNET_OK
Definition: gnunet_common.h:99
@ GNUNET_YES
@ GNUNET_NO
Definition: gnunet_common.h:98
#define GNUNET_new(type)
Allocate a struct or union of the given type.
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_now(GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run as soon as possible.
Definition: scheduler.c:1281
Opaque handle to an abstract operation to be executed by the testing framework.
void * cb_cls
Closure for callbacks.
The request handle for obtaining a pooled connection.
struct GNUNET_TESTBED_Operation * op_ats_connectivity
The operation handle for ATS handle.
struct GST_ConnectionPool_GetHandle * tail_waiting
DLL tail for the queue of GST_ConnectionPool_GetHandle requests that are waiting for this connection ...
struct GNUNET_CONFIGURATION_Handle * cfg
The configuration of the peer.
unsigned int demand
Number of active requests using this pooled connection.
struct GNUNET_ATS_ConnectivityHandle * handle_ats_connectivity
The ATS handle to the peer correspondign to this entry; can be NULL.
struct GNUNET_TRANSPORT_CoreHandle * handle_transport
The transport handle to the peer corresponding to this entry; can be NULL.
int in_pool
Is this entry present in the connection pool.
struct GST_ConnectionPool_GetHandle * head_waiting
DLL head for the queue of GST_ConnectionPool_GetHandle requests that are waiting for this connection ...
struct GNUNET_TESTBED_Operation * op_transport
The operation handle for transport handle.
struct GNUNET_SCHEDULER_Task * notify_task
The task to notify a waiting GST_ConnectionPool_GetHandle object.
struct GNUNET_CORE_Handle * handle_core
The core handle to the peer corresponding to this entry; can be NULL.
uint32_t index
The index of this peer.
struct GNUNET_TESTBED_Operation * op_core
The operation handle for core handle.
struct GNUNET_TESTBED_Operation * GNUNET_TESTBED_operation_create_(void *cls, OperationStart start, OperationRelease release)
Create an 'operation' to be performed.
void GNUNET_TESTBED_operation_queue_insert_(struct OperationQueue *queue, struct GNUNET_TESTBED_Operation *op)
Add an operation to a queue.
void GNUNET_TESTBED_operation_begin_wait_(struct GNUNET_TESTBED_Operation *op)
Marks the given operation as waiting on the queues.

References GNUNET_TESTBED_Operation::cb_cls, cfg, PooledConnection::cfg, connection_ready(), PooledConnection::demand, expire_task_cancel(), gh, GNUNET_assert, GNUNET_CONFIGURATION_dup(), GNUNET_CONTAINER_DLL_insert, GNUNET_CONTAINER_DLL_insert_tail, GNUNET_CONTAINER_DLL_remove, GNUNET_CONTAINER_multihashmap32_get(), GNUNET_CONTAINER_multihashmap32_put(), GNUNET_CONTAINER_multihashmap32_size(), GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST, GNUNET_new, GNUNET_NO, GNUNET_OK, GNUNET_SCHEDULER_add_now(), GNUNET_TESTBED_operation_begin_wait_(), GNUNET_TESTBED_operation_create_(), GNUNET_TESTBED_operation_queue_insert_(), GNUNET_YES, GST_CONNECTIONPOOL_SERVICE_ATS_CONNECTIVITY, GST_CONNECTIONPOOL_SERVICE_CORE, GST_CONNECTIONPOOL_SERVICE_TRANSPORT, GST_opq_openfds, handle, PooledConnection::handle_ats_connectivity, PooledConnection::handle_core, PooledConnection::handle_transport, head_lru, head_not_pooled, PooledConnection::head_waiting, PooledConnection::in_lru, PooledConnection::in_pool, PooledConnection::index, LOG_DEBUG, map, max_size, PooledConnection::notify_task, op, PooledConnection::op_ats_connectivity, PooledConnection::op_core, PooledConnection::op_transport, oprelease_get_handle_ats_connectivity(), oprelease_get_handle_core(), oprelease_get_handle_transport(), opstart_get_handle_ats_connectivity(), opstart_get_handle_core(), opstart_get_handle_transport(), peer_id, search_waiting(), service, tail_lru, tail_not_pooled, and PooledConnection::tail_waiting.

Referenced by handle_overlay_connect(), handle_remote_overlay_connect(), occ_cache_get_handle_core_cb(), occ_hello_sent_cb(), overlay_connect_get_config(), p2_transport_connect(), and rocc_hello_sent_cb().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GST_connection_pool_get_handle_done()

void GST_connection_pool_get_handle_done ( struct GST_ConnectionPool_GetHandle gh)

Relinquish a GST_ConnectionPool_GetHandle object.

If the connection associated with the object is currently being used by other GST_ConnectionPool_GetHandle objects, it is left in the connection pool. If no other objects are using the connection and the connection pool is not full then it is placed in a LRU queue. If the connection pool is full, then connections from the LRU queue are evicted and closed to create place for this connection. If the connection pool if full and the LRU queue is empty, then the connection is closed.

Parameters
ghthe handle

Definition at line 982 of file gnunet-service-testbed_connectionpool.c.

983 {
984  struct PooledConnection *entry;
985 
986  if (NULL == gh)
987  return;
988  entry = gh->entry;
989  LOG_DEBUG ("Cleaning up get handle %p for service %u, peer %u\n",
990  gh,
991  gh->service,
992  entry->index);
993  if (! gh->connection_ready_called)
994  {
996  if ((NULL == search_waiting (entry, entry->head_waiting)) &&
997  (NULL != entry->notify_task))
998  {
1000  entry->notify_task = NULL;
1001  }
1002  }
1003  if (gh->notify_waiting)
1004  {
1006  gh->notify_waiting = 0;
1007  }
1008  GNUNET_free (gh);
1009  gh = NULL;
1010  GNUNET_assert (! entry->in_lru);
1011  if (! entry->in_pool)
1013  if (NULL != map)
1014  {
1015  if (GNUNET_YES ==
1017  goto unallocate;
1019  {
1020  if (NULL == head_lru)
1021  goto unallocate;
1023  }
1026  map,
1027  entry->index,
1028  entry,
1030  entry->in_pool = GNUNET_YES;
1031  }
1032 
1033 unallocate:
1034  GNUNET_assert (0 < entry->demand);
1035  entry->demand--;
1036  if (0 != entry->demand)
1037  return;
1038  if (entry->in_pool)
1039  {
1040  add_to_lru (entry);
1041  return;
1042  }
1043  destroy_pooled_connection (entry);
1044 }
static void add_to_lru(struct PooledConnection *entry)
Function to add a PooledConnection object into LRU and begin the expiry task.
enum GNUNET_GenericReturnValue GNUNET_CONTAINER_multihashmap32_contains(const struct GNUNET_CONTAINER_MultiHashMap32 *map, uint32_t key)
Check if the map contains any value under the given key (including values that are NULL).
@ GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY
There must only be one value per key; storing a value should fail if a value under the same key alrea...
#define GNUNET_free(ptr)
Wrapper around free.
void * GNUNET_SCHEDULER_cancel(struct GNUNET_SCHEDULER_Task *task)
Cancel the task with the specified identifier.
Definition: scheduler.c:957
struct GST_ConnectionPool_GetHandle * tail_notify
DLL tail for the queue to serve notifications when a peer is connected.
struct GST_ConnectionPool_GetHandle * head_notify
DLL head for the queue to serve notifications when a peer is connected.

References add_to_lru(), PooledConnection::demand, destroy_pooled_connection(), gh, GNUNET_assert, GNUNET_CONTAINER_DLL_remove, GNUNET_CONTAINER_multihashmap32_contains(), GNUNET_CONTAINER_multihashmap32_put(), GNUNET_CONTAINER_multihashmap32_size(), GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY, GNUNET_free, GNUNET_OK, GNUNET_SCHEDULER_cancel(), GNUNET_YES, head_lru, head_not_pooled, PooledConnection::head_notify, PooledConnection::head_waiting, PooledConnection::in_lru, PooledConnection::in_pool, PooledConnection::index, LOG_DEBUG, map, max_size, PooledConnection::notify_task, search_waiting(), tail_not_pooled, PooledConnection::tail_notify, and PooledConnection::tail_waiting.

Referenced by cleanup_occ(), cleanup_occ_lp2c(), cleanup_rocc(), and hello_update_cb().

Here is the call graph for this function:
Here is the caller graph for this function: