gnunet-service-testbed_cache.c File Reference

testbed cache implementation More...

#include "gnunet-service-testbed.h"

Include dependency graph for gnunet-service-testbed_cache.c:

Go to the source code of this file.

Data Structures
struct	CacheEntry
	Cache entry. More...

Macros
#define	LOG(kind, ...)   GNUNET_log_from (kind, "testbed-cache", __VA_ARGS__)
	Redefine LOG with a changed log component string. More...

Functions
static struct CacheEntry *	cache_lookup (unsigned int peer_id)
	Looks up in the cache and returns the entry. More...
static void	free_entry (struct CacheEntry *entry)
	Free the resources occupied by a cache entry. More...
static struct CacheEntry *	add_entry (unsigned int peer_id)
	Creates a new cache entry and then puts it into the cache's hashtable. More...
static int	cache_clear_iterator (void *cls, uint32_t key, void *value)
	Iterator over hash map entries. More...
void	GST_cache_clear ()
	Clear cache. More...
void	GST_cache_init (unsigned int size)
	Initializes the cache. More...
const struct GNUNET_MessageHeader *	GST_cache_lookup_hello (const unsigned int peer_id)
	Looks up in the hello cache and returns the HELLO of the given peer. More...
void	GST_cache_add_hello (const unsigned int peer_id, const struct GNUNET_MessageHeader *hello)
	Caches the HELLO of the given peer. More...

Variables
static struct GNUNET_CONTAINER_MultiHashMap32 *	cache
	Hashmap to maintain cache. More...
static struct CacheEntry *	cache_head
	DLL head for least recently used cache entries; least recently used cache items are at the head. More...
static struct CacheEntry *	cache_tail
	DLL tail for least recently used cache entries; recently used cache items are at the tail.The cache enties are added to this queue when their demand becomes zero. More...
static unsigned int	cache_size
	Maximum number of elements to cache. More...

Detailed Description

testbed cache implementation

Author

Sree Harsha Totakura

Definition in file gnunet-service-testbed_cache.c.

Macro Definition Documentation

LOG

#define LOG	(		kind,
			...
	)		GNUNET_log_from (kind, "testbed-cache", __VA_ARGS__)

Redefine LOG with a changed log component string.

Definition at line 34 of file gnunet-service-testbed_cache.c.

Function Documentation

cache_lookup()

static struct CacheEntry* cache_lookup ( unsigned int  peer_id )

static

Looks up in the cache and returns the entry.

Parameters

peer_id

the peer identity of the peer whose corresponding entry has to be looked up

Returns

the HELLO message; NULL if not found

Definition at line 100 of file gnunet-service-testbed_cache.c.

References GNUNET_assert, GNUNET_CONTAINER_DLL_insert_tail, GNUNET_CONTAINER_DLL_remove, and GNUNET_CONTAINER_multihashmap32_get().

Referenced by GST_cache_add_hello(), and GST_cache_lookup_hello().

{
  struct CacheEntry *entry;

  GNUNET_assert (NULL != cache);
  entry = GNUNET_CONTAINER_multihashmap32_get (cache, peer_id);
  if (NULL == entry)
    return NULL;
  GNUNET_CONTAINER_DLL_remove (cache_head, cache_tail, entry);
  GNUNET_CONTAINER_DLL_insert_tail (cache_head, cache_tail, entry);
  return entry;
}

Here is the call graph for this function:

Here is the caller graph for this function:

free_entry()

static void free_entry ( struct CacheEntry *  entry )

static

Free the resources occupied by a cache entry.

Parameters

entry

the cache entry to free

Definition at line 120 of file gnunet-service-testbed_cache.c.

References GNUNET_CONTAINER_DLL_remove, GNUNET_free, GNUNET_free_non_null, and CacheEntry::hello.

Referenced by add_entry(), and cache_clear_iterator().

{
  GNUNET_CONTAINER_DLL_remove (cache_head, cache_tail, entry);
  GNUNET_free_non_null (entry->hello);
  GNUNET_free (entry);
}

Here is the caller graph for this function:

add_entry()

static struct CacheEntry* add_entry ( unsigned int  peer_id )

static

Creates a new cache entry and then puts it into the cache's hashtable.

Parameters

peer_id

the index of the peer to tag the newly created entry

Returns

the newly created entry

Definition at line 135 of file gnunet-service-testbed_cache.c.

References cache_head, cache_size, free_entry(), GNUNET_assert, GNUNET_CONTAINER_DLL_insert_tail, GNUNET_CONTAINER_multihashmap32_put(), GNUNET_CONTAINER_multihashmap32_remove(), GNUNET_CONTAINER_multihashmap32_size(), GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST, GNUNET_new, GNUNET_OK, and CacheEntry::peer_id.

Referenced by GST_cache_add_hello().

{
  struct CacheEntry *entry;

  GNUNET_assert (NULL != cache);
  if (cache_size == GNUNET_CONTAINER_multihashmap32_size (cache))
  {
    /* remove the LRU head */
    entry = cache_head;
    GNUNET_assert (GNUNET_OK ==
                   GNUNET_CONTAINER_multihashmap32_remove (cache, (uint32_t)
                                                           entry->peer_id,
                                                           entry));
    free_entry (entry);
  }
  entry = GNUNET_new (struct CacheEntry);
  entry->peer_id = peer_id;
  GNUNET_assert (GNUNET_OK ==
                 GNUNET_CONTAINER_multihashmap32_put (cache,
                                                      (uint32_t) peer_id,
                                                      entry,
                                                      GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST));
  GNUNET_CONTAINER_DLL_insert_tail (cache_head, cache_tail, entry);
  return entry;
}

Here is the call graph for this function:

Here is the caller graph for this function:

cache_clear_iterator()

static int cache_clear_iterator ( void *  cls, uint32_t  key, void *  value  )

static

Iterator over hash map entries.

Parameters

cls	closure
key	current key
value	value in the hash map

Returns

GNUNET_YES if we should continue to iterate, GNUNET_NO if not.

Definition at line 173 of file gnunet-service-testbed_cache.c.

References free_entry(), GNUNET_assert, GNUNET_CONTAINER_multihashmap32_remove(), GNUNET_YES, and value.

Referenced by GST_cache_clear().

{
  struct CacheEntry *entry = value;

  GNUNET_assert (NULL != entry);
  GNUNET_assert (GNUNET_YES ==
                 GNUNET_CONTAINER_multihashmap32_remove (cache, key, value));
  free_entry (entry);
  return GNUNET_YES;
}

Here is the call graph for this function:

Here is the caller graph for this function:

GST_cache_clear()

void GST_cache_clear

(

void

)

Clear cache.

Definition at line 189 of file gnunet-service-testbed_cache.c.

References cache_clear_iterator(), cache_size, GNUNET_assert, GNUNET_CONTAINER_multihashmap32_destroy(), GNUNET_CONTAINER_multihashmap32_iterate(), and GNUNET_CONTAINER_multihashmap32_size().

Referenced by shutdown_task().

{
  if (NULL != cache)
  {
    GNUNET_CONTAINER_multihashmap32_iterate (cache, &cache_clear_iterator, NULL);
    GNUNET_assert (0 == GNUNET_CONTAINER_multihashmap32_size (cache));
    GNUNET_CONTAINER_multihashmap32_destroy (cache);
    cache = NULL;
  }
  cache_size = 0;
  cache_head = NULL;
  cache_tail = NULL;
}

Here is the call graph for this function:

Here is the caller graph for this function:

GST_cache_init()

void GST_cache_init

(

unsigned int

size

)

Initializes the cache.

Parameters

size	the size of the cache

Definition at line 210 of file gnunet-service-testbed_cache.c.

References cache_size, GNUNET_CONTAINER_multihashmap32_create(), and size.

Referenced by testbed_run().

{
  if (0 == size)
    return;
  cache_size = size;
  cache = GNUNET_CONTAINER_multihashmap32_create (cache_size);
}

Here is the call graph for this function:

Here is the caller graph for this function:

GST_cache_lookup_hello()

const struct GNUNET_MessageHeader* GST_cache_lookup_hello

(

const unsigned int

peer_id

)

Looks up in the hello cache and returns the HELLO of the given peer.

Parameters

peer_id

the index of the peer whose HELLO has to be looked up

Returns

the HELLO message; NULL if not found

Definition at line 226 of file gnunet-service-testbed_cache.c.

References cache_lookup(), CacheEntry::hello, and LOG_DEBUG.

Referenced by occ_cache_get_handle_core_cb().

{
  struct CacheEntry *entry;

  LOG_DEBUG ("Looking up HELLO for peer %u\n", peer_id);
  if (NULL == cache)
  {
    LOG_DEBUG ("Caching disabled\n");
    return NULL;
  }
  entry = cache_lookup (peer_id);
  if (NULL == entry)
    return NULL;
  if (NULL != entry->hello)
    LOG_DEBUG ("HELLO found for peer %u\n", peer_id);
  return entry->hello;
}

Here is the call graph for this function:

Here is the caller graph for this function:

GST_cache_add_hello()

void GST_cache_add_hello	(	const unsigned int	peer_id,
		const struct GNUNET_MessageHeader *	hello
	)

Caches the HELLO of the given peer.

Updates the HELLO if it was already cached before

Parameters

peer_id	the peer identity of the peer whose HELLO has to be cached
hello	the HELLO message

Definition at line 253 of file gnunet-service-testbed_cache.c.

References add_entry(), cache_lookup(), GNUNET_copy_message(), GNUNET_free_non_null, and CacheEntry::hello.

Referenced by hello_update_cb().

{
  struct CacheEntry *entry;

  if (NULL == cache)
    return;
  entry = cache_lookup (peer_id);
  if (NULL == entry)
    entry = add_entry (peer_id);
  GNUNET_free_non_null (entry->hello);
  entry->hello = GNUNET_copy_message (hello);
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

cache

struct GNUNET_CONTAINER_MultiHashMap32* cache

static

Hashmap to maintain cache.

Definition at line 68 of file gnunet-service-testbed_cache.c.

Referenced by GNUNET_OS_get_libexec_binary_path(), and GNUNET_OS_get_suid_binary_path().

cache_head

struct CacheEntry* cache_head

static

DLL head for least recently used cache entries; least recently used cache items are at the head.

The cache enties are added to this queue when their demand becomes zero. They are removed from the queue when they are needed by any operation.

Definition at line 76 of file gnunet-service-testbed_cache.c.

Referenced by add_entry().

cache_tail

struct CacheEntry* cache_tail

static

DLL tail for least recently used cache entries; recently used cache items are at the tail.The cache enties are added to this queue when their demand becomes zero.

They are removed from the queue when they are needed by any operation.

Definition at line 84 of file gnunet-service-testbed_cache.c.

cache_size

unsigned int cache_size

static

Maximum number of elements to cache.

Definition at line 89 of file gnunet-service-testbed_cache.c.

Referenced by add_entry(), GST_cache_clear(), and GST_cache_init().