gnunet-service-core_typemap.c File Reference

management of map that specifies which message types this peer supports More...

#include "platform.h"
#include "gnunet_util_lib.h"
#include "gnunet-service-core.h"
#include "gnunet-service-core_sessions.h"
#include "gnunet-service-core_typemap.h"
#include <zlib.h>

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

Go to the source code of this file.

Data Structures
struct	GSC_TypeMap
	A type map describing which messages a given neighbour is able to process. More...

Functions
static void	rehash_typemap ()
	Our type map changed, recompute its hash. More...
void	GSC_TYPEMAP_hash (const struct GSC_TypeMap *tm, struct GNUNET_HashCode *hc)
	Hash the contents of a type map. More...
int	GSC_TYPEMAP_check_hash (const struct GNUNET_HashCode *hc)
	Check if the given hash matches our current type map. More...
struct GNUNET_MessageHeader *	GSC_TYPEMAP_compute_type_map_message ()
	Compute a type map message for this peer. More...
struct GSC_TypeMap *	GSC_TYPEMAP_get_from_message (const struct GNUNET_MessageHeader *msg)
	Extract a type map from a TYPE_MAP message. More...
static void	broadcast_my_type_map ()
	Send my type map to all connected peers (it got changed). More...
void	GSC_TYPEMAP_add (const uint16_t *types, unsigned int tlen)
	Add a set of types to our type map. More...
void	GSC_TYPEMAP_remove (const uint16_t *types, unsigned int tlen)
	Remove a set of message types from our type map. More...
int	GSC_TYPEMAP_test_match (const struct GSC_TypeMap *tmap, const uint16_t *types, unsigned int tcnt)
	Test if any of the types from the types array is in the given type map. More...
struct GSC_TypeMap *	GSC_TYPEMAP_extend (const struct GSC_TypeMap *tmap, const uint16_t *types, unsigned int tcnt)
	Add additional types to a given typemap. More...
struct GSC_TypeMap *	GSC_TYPEMAP_create ()
	Create an empty type map. More...
void	GSC_TYPEMAP_destroy (struct GSC_TypeMap *tmap)
	Free the given type map. More...
void	GSC_TYPEMAP_init ()
	Initialize typemap subsystem. More...
void	GSC_TYPEMAP_done ()
	Shutdown typemap subsystem. More...

Variables
static struct GSC_TypeMap	my_type_map
	Bitmap of message types this peer is able to handle. More...
static uint8_t	map_counters [UINT16_MAX+1]
	Counters for message types this peer is able to handle. More...
static struct GNUNET_HashCode	my_tm_hash
	Current hash of our (uncompressed) type map. More...
static int	hash_current
	Is my_tm_hash() current with respect to our type map? More...

Detailed Description

management of map that specifies which message types this peer supports

Author

Christian Grothoff

Definition in file gnunet-service-core_typemap.c.

Function Documentation

rehash_typemap()

static void rehash_typemap ( )

static

Our type map changed, recompute its hash.

Definition at line 69 of file gnunet-service-core_typemap.c.

{
  hash_current = GNUNET_NO;
}

References GNUNET_NO, and hash_current.

Referenced by GSC_TYPEMAP_add(), and GSC_TYPEMAP_remove().

Here is the caller graph for this function:

GSC_TYPEMAP_hash()

void GSC_TYPEMAP_hash	(	const struct GSC_TypeMap *	tm,
		struct GNUNET_HashCode *	hc
	)

Hash the contents of a type map.

Parameters

tm	map to hash
hc	where to store the hash code

Definition at line 82 of file gnunet-service-core_typemap.c.

{
  GNUNET_CRYPTO_hash (tm, sizeof(struct GSC_TypeMap), hc);
}

References GNUNET_CRYPTO_hash().

Referenced by GSC_SESSIONS_set_typemap(), and GSC_TYPEMAP_check_hash().

Here is the call graph for this function:

Here is the caller graph for this function:

GSC_TYPEMAP_check_hash()

int GSC_TYPEMAP_check_hash

(

const struct GNUNET_HashCode *

hc

)

Check if the given hash matches our current type map.

Parameters

hc	hash code to check if it matches our type map

Returns

GNUNET_YES if the hash matches, GNUNET_NO if not

Definition at line 95 of file gnunet-service-core_typemap.c.

{
  if (GNUNET_NO == hash_current)
  {
    GSC_TYPEMAP_hash (&my_type_map, &my_tm_hash);
    hash_current = GNUNET_YES;
  }
  return (0 == memcmp (hc, &my_tm_hash, sizeof(struct GNUNET_HashCode)))
         ? GNUNET_YES
         : GNUNET_NO;
}

References GNUNET_NO, GNUNET_YES, GSC_TYPEMAP_hash(), hash_current, my_tm_hash, and my_type_map.

Referenced by GSC_SESSIONS_confirm_typemap().

Here is the call graph for this function:

Here is the caller graph for this function:

GSC_TYPEMAP_compute_type_map_message()

struct GNUNET_MessageHeader * GSC_TYPEMAP_compute_type_map_message

(

void

)

Compute a type map message for this peer.

Returns

this peers current type map message.

Definition at line 114 of file gnunet-service-core_typemap.c.

{
  char *tmp;
  uLongf dlen;
  struct GNUNET_MessageHeader *hdr;
 
#ifdef compressBound
  dlen = compressBound (sizeof(my_type_map));
#else
  dlen = sizeof(my_type_map) + (sizeof(my_type_map) / 100) + 20;
  /* documentation says 100.1% oldSize + 12 bytes, but we
   * should be able to overshoot by more to be safe */
#endif
  hdr = GNUNET_malloc (dlen + sizeof(struct GNUNET_MessageHeader));
  tmp = (char *) &hdr[1];
  if ((Z_OK != compress2 ((Bytef *) tmp,
                          &dlen,
                          (const Bytef *) &my_type_map,
                          sizeof(my_type_map),
                          9)) ||
      (dlen >= sizeof(my_type_map)))
  {
    /* compression failed, use uncompressed map */
    dlen = sizeof(my_type_map);
    GNUNET_memcpy (tmp, &my_type_map, sizeof(my_type_map));
    hdr->type = htons (GNUNET_MESSAGE_TYPE_CORE_BINARY_TYPE_MAP);
  }
  else
  {
    /* compression worked, use compressed map */
    hdr->type = htons (GNUNET_MESSAGE_TYPE_CORE_COMPRESSED_TYPE_MAP);
  }
  hdr->size = htons ((uint16_t) dlen + sizeof(struct GNUNET_MessageHeader));
  return hdr;
}

References GNUNET_malloc, GNUNET_memcpy, GNUNET_MESSAGE_TYPE_CORE_BINARY_TYPE_MAP, GNUNET_MESSAGE_TYPE_CORE_COMPRESSED_TYPE_MAP, my_type_map, GNUNET_MessageHeader::size, and GNUNET_MessageHeader::type.

Referenced by broadcast_my_type_map(), and transmit_typemap_task().

Here is the caller graph for this function:

GSC_TYPEMAP_get_from_message()

struct GSC_TypeMap * GSC_TYPEMAP_get_from_message

(

const struct GNUNET_MessageHeader *

msg

)

Extract a type map from a TYPE_MAP message.

Extract a type map from a #GNUNET_MESSAGE_TYPE_CORE_COMRESSED_TYPE_MAP or GNUNET_MESSAGE_TYPE_CORE_BINARY_TYPE_MAP message.

Parameters

msg	a type map message

Returns

NULL on error

Definition at line 158 of file gnunet-service-core_typemap.c.

{
  struct GSC_TypeMap *ret;
  uint16_t size;
  uLongf dlen;
 
  size = ntohs (msg->size);
  switch (ntohs (msg->type))
  {
  case GNUNET_MESSAGE_TYPE_CORE_BINARY_TYPE_MAP:
    GNUNET_STATISTICS_update (GSC_stats,
                              gettext_noop ("# type maps received"),
                              1,
                              GNUNET_NO);
    if (size != sizeof(struct GSC_TypeMap))
    {
      GNUNET_break_op (0);
      return NULL;
    }
    ret = GNUNET_new (struct GSC_TypeMap);
    GNUNET_memcpy (ret, &msg[1], sizeof(struct GSC_TypeMap));
    return ret;
 
  case GNUNET_MESSAGE_TYPE_CORE_COMPRESSED_TYPE_MAP:
    GNUNET_STATISTICS_update (GSC_stats,
                              gettext_noop ("# type maps received"),
                              1,
                              GNUNET_NO);
    ret = GNUNET_new (struct GSC_TypeMap);
    dlen = sizeof(struct GSC_TypeMap);
    if ((Z_OK != uncompress ((Bytef *) ret,
                             &dlen,
                             (const Bytef *) &msg[1],
                             (uLong) size)) ||
        (dlen != sizeof(struct GSC_TypeMap)))
    {
      GNUNET_break_op (0);
      GNUNET_free (ret);
      return NULL;
    }
    return ret;
 
  default:
    GNUNET_break (0);
    return NULL;
  }
}

References gettext_noop, GNUNET_break, GNUNET_break_op, GNUNET_free, GNUNET_memcpy, GNUNET_MESSAGE_TYPE_CORE_BINARY_TYPE_MAP, GNUNET_MESSAGE_TYPE_CORE_COMPRESSED_TYPE_MAP, GNUNET_new, GNUNET_NO, GNUNET_STATISTICS_update(), GSC_stats, msg, ret, GNUNET_MessageHeader::size, size, and GNUNET_MessageHeader::type.

Referenced by GSC_SESSIONS_set_typemap().

Here is the call graph for this function:

Here is the caller graph for this function:

broadcast_my_type_map()

static void broadcast_my_type_map ( )

static

Send my type map to all connected peers (it got changed).

Definition at line 211 of file gnunet-service-core_typemap.c.

{
  struct GNUNET_MessageHeader *hdr;
 
  hdr = GSC_TYPEMAP_compute_type_map_message ();
  GNUNET_STATISTICS_update (GSC_stats,
                            gettext_noop ("# updates to my type map"),
                            1,
                            GNUNET_NO);
  GSC_SESSIONS_broadcast_typemap (hdr);
  GNUNET_free (hdr);
}

References gettext_noop, GNUNET_free, GNUNET_NO, GNUNET_STATISTICS_update(), GSC_SESSIONS_broadcast_typemap(), GSC_stats, and GSC_TYPEMAP_compute_type_map_message().

Referenced by GSC_TYPEMAP_add(), and GSC_TYPEMAP_remove().

Here is the call graph for this function:

Here is the caller graph for this function:

GSC_TYPEMAP_add()

void GSC_TYPEMAP_add	(	const uint16_t *	types,
		unsigned int	tlen
	)

Add a set of types to our type map.

Parameters

types	array of message types supported by this peer
tlen	number of entries in types

Definition at line 232 of file gnunet-service-core_typemap.c.

{
  unsigned int i;
  int changed;
 
  changed = GNUNET_NO;
  for (i = 0; i < tlen; i++)
  {
    if (0 == map_counters[types[i]]++)
    {
      my_type_map.bits[types[i] / 32] |= (1 << (types[i] % 32));
      changed = GNUNET_YES;
    }
  }
  if (GNUNET_YES == changed)
  {
    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Typemap changed, broadcasting!\n");
    rehash_typemap ();
    broadcast_my_type_map ();
  }
}

References GSC_TypeMap::bits, broadcast_my_type_map(), GNUNET_ERROR_TYPE_DEBUG, GNUNET_log, GNUNET_NO, GNUNET_YES, map_counters, my_type_map, and rehash_typemap().

Referenced by handle_client_init().

Here is the call graph for this function:

Here is the caller graph for this function:

GSC_TYPEMAP_remove()

void GSC_TYPEMAP_remove	(	const uint16_t *	types,
		unsigned int	tlen
	)

Remove a set of message types from our type map.

Parameters

types	array of message types no longer supported by this peer
tlen	number of entries in types

Definition at line 256 of file gnunet-service-core_typemap.c.

{
  int changed;
 
  changed = GNUNET_NO;
  for (unsigned int i = 0; i < tlen; i++)
  {
    if (0 == --map_counters[types[i]])
    {
      my_type_map.bits[types[i] / 32] &= ~(1 << (types[i] % 32));
      changed = GNUNET_YES;
    }
  }
  if (GNUNET_YES == changed)
  {
    rehash_typemap ();
    broadcast_my_type_map ();
  }
}

References GSC_TypeMap::bits, broadcast_my_type_map(), GNUNET_NO, GNUNET_YES, map_counters, my_type_map, and rehash_typemap().

Referenced by client_disconnect_cb().

Here is the call graph for this function:

Here is the caller graph for this function:

GSC_TYPEMAP_test_match()

int GSC_TYPEMAP_test_match	(	const struct GSC_TypeMap *	tmap,
		const uint16_t *	types,
		unsigned int	tcnt
	)

Test if any of the types from the types array is in the given type map.

Parameters

tmap	map to test
types	array of types
tcnt	number of entries in types

Returns

GNUNET_YES if a type is in the map, GNUNET_NO if not

Definition at line 287 of file gnunet-service-core_typemap.c.

{
  if (NULL == tmap)
    return GNUNET_NO;
  if (0 == tcnt)
    return GNUNET_YES; /* matches all */
  for (unsigned int i = 0; i < tcnt; i++)
    if (0 != (tmap->bits[types[i] / 32] & (1 << (types[i] % 32))))
      return GNUNET_YES;
  return GNUNET_NO;
}

References GSC_TypeMap::bits, GNUNET_NO, and GNUNET_YES.

Referenced by GSC_CLIENTS_notify_client_about_neighbour(), and GSC_SESSIONS_add_to_typemap().

Here is the caller graph for this function:

GSC_TYPEMAP_extend()

struct GSC_TypeMap * GSC_TYPEMAP_extend	(	const struct GSC_TypeMap *	tmap,
		const uint16_t *	types,
		unsigned int	tcnt
	)

Add additional types to a given typemap.

Parameters

tmap	map to extend (not changed)
types	array of types to add
tcnt	number of entries in types

Returns

updated type map (fresh copy)

Definition at line 311 of file gnunet-service-core_typemap.c.

{
  struct GSC_TypeMap *ret;
 
  ret = GNUNET_new (struct GSC_TypeMap);
  if (NULL != tmap)
    GNUNET_memcpy (ret, tmap, sizeof(struct GSC_TypeMap));
  for (unsigned int i = 0; i < tcnt; i++)
    ret->bits[types[i] / 32] |= (1 << (types[i] % 32));
  return ret;
}

References GNUNET_memcpy, GNUNET_new, and ret.

Referenced by GSC_SESSIONS_add_to_typemap().

Here is the caller graph for this function:

GSC_TYPEMAP_create()

struct GSC_TypeMap * GSC_TYPEMAP_create

(

void

)

Create an empty type map.

Returns

an empty type map

Definition at line 332 of file gnunet-service-core_typemap.c.

{
  return GNUNET_new (struct GSC_TypeMap);
}

References GNUNET_new.

Referenced by GSC_SESSIONS_create().

Here is the caller graph for this function:

GSC_TYPEMAP_destroy()

void GSC_TYPEMAP_destroy

(

struct GSC_TypeMap *

tmap

)

Free the given type map.

Parameters

tmap	a type map

Definition at line 344 of file gnunet-service-core_typemap.c.

{
  GNUNET_free (tmap);
}

References GNUNET_free.

Referenced by GSC_SESSIONS_add_to_typemap(), GSC_SESSIONS_end(), and GSC_SESSIONS_set_typemap().

Here is the caller graph for this function:

GSC_TYPEMAP_init()

void GSC_TYPEMAP_init

(

void

)

Initialize typemap subsystem.

Definition at line 354 of file gnunet-service-core_typemap.c.

{
  /* nothing to do */
}

Referenced by run().

Here is the caller graph for this function:

GSC_TYPEMAP_done()

void GSC_TYPEMAP_done

(

void

)

Shutdown typemap subsystem.

Definition at line 364 of file gnunet-service-core_typemap.c.

{
  /* nothing to do */
}

Referenced by shutdown_task().

Here is the caller graph for this function:

Variable Documentation

my_type_map

struct GSC_TypeMap my_type_map

static

Bitmap of message types this peer is able to handle.

Definition at line 46 of file gnunet-service-core_typemap.c.

Referenced by GSC_TYPEMAP_add(), GSC_TYPEMAP_check_hash(), GSC_TYPEMAP_compute_type_map_message(), and GSC_TYPEMAP_remove().

map_counters

uint8_t map_counters[UINT16_MAX+1]

static

Counters for message types this peer is able to handle.

Definition at line 51 of file gnunet-service-core_typemap.c.

Referenced by GSC_TYPEMAP_add(), and GSC_TYPEMAP_remove().

my_tm_hash

struct GNUNET_HashCode my_tm_hash

static

Current hash of our (uncompressed) type map.

Lazily computed when needed.

Definition at line 57 of file gnunet-service-core_typemap.c.

Referenced by GSC_TYPEMAP_check_hash().

hash_current

int hash_current

static

Is my_tm_hash() current with respect to our type map?

Definition at line 62 of file gnunet-service-core_typemap.c.

Referenced by GSC_TYPEMAP_check_hash(), and rehash_typemap().