GNUnet  0.11.x
Data Structures | Functions | Variables
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_transport_service.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_MessageHeaderGSC_TYPEMAP_compute_type_map_message ()
 Compute a type map message for this peer. More...
 
struct GSC_TypeMapGSC_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 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_TypeMapGSC_TYPEMAP_extend (const struct GSC_TypeMap *tmap, const uint16_t *types, unsigned int tcnt)
 Add additional types to a given typemap. More...
 
struct GSC_TypeMapGSC_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 70 of file gnunet-service-core_typemap.c.

71 {
73 }
static int hash_current
Is my_tm_hash() current with respect to our type map?
@ GNUNET_NO
Definition: gnunet_common.h:94

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
tmmap to hash
hcwhere to store the hash code

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

84 {
85  GNUNET_CRYPTO_hash (tm, sizeof(struct GSC_TypeMap), hc);
86 }
void GNUNET_CRYPTO_hash(const void *block, size_t size, struct GNUNET_HashCode *ret)
Compute hash of a given block.
Definition: crypto_hash.c:41
A type map describing which messages a given neighbour is able to process.

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
hchash code to check if it matches our type map
Returns
GNUNET_YES if the hash matches, GNUNET_NO if not

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

97 {
98  if (GNUNET_NO == hash_current)
99  {
102  }
103  return (0 == memcmp (hc, &my_tm_hash, sizeof(struct GNUNET_HashCode)))
104  ? GNUNET_YES
105  : GNUNET_NO;
106 }
static struct GNUNET_HashCode my_tm_hash
Current hash of our (uncompressed) type map.
static struct GSC_TypeMap my_type_map
Bitmap of message types this peer is able to handle.
void GSC_TYPEMAP_hash(const struct GSC_TypeMap *tm, struct GNUNET_HashCode *hc)
Hash the contents of a type map.
@ GNUNET_YES
Definition: gnunet_common.h:97
A 512-bit hashcode.

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 115 of file gnunet-service-core_typemap.c.

116 {
117  char *tmp;
118  uLongf dlen;
119  struct GNUNET_MessageHeader *hdr;
120 
121 #ifdef compressBound
122  dlen = compressBound (sizeof(my_type_map));
123 #else
124  dlen = sizeof(my_type_map) + (sizeof(my_type_map) / 100) + 20;
125  /* documentation says 100.1% oldSize + 12 bytes, but we
126  * should be able to overshoot by more to be safe */
127 #endif
128  hdr = GNUNET_malloc (dlen + sizeof(struct GNUNET_MessageHeader));
129  tmp = (char *) &hdr[1];
130  if ((Z_OK != compress2 ((Bytef *) tmp,
131  &dlen,
132  (const Bytef *) &my_type_map,
133  sizeof(my_type_map),
134  9)) ||
135  (dlen >= sizeof(my_type_map)))
136  {
137  /* compression failed, use uncompressed map */
138  dlen = sizeof(my_type_map);
139  GNUNET_memcpy (tmp, &my_type_map, sizeof(my_type_map));
141  }
142  else
143  {
144  /* compression worked, use compressed map */
146  }
147  hdr->size = htons ((uint16_t) dlen + sizeof(struct GNUNET_MessageHeader));
148  return hdr;
149 }
#define GNUNET_memcpy(dst, src, n)
Call memcpy() but check for n being 0 first.
#define GNUNET_malloc(size)
Wrapper around malloc.
#define GNUNET_MESSAGE_TYPE_CORE_BINARY_TYPE_MAP
uncompressed type map of the sender
#define GNUNET_MESSAGE_TYPE_CORE_COMPRESSED_TYPE_MAP
gzip-compressed type map of the sender
Header for all communications.
uint16_t type
The type of the message (GNUNET_MESSAGE_TYPE_XXXX), in big-endian format.
uint16_t size
The length of the struct (in bytes, including the length field itself), in big-endian format.

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
msga type map message
Returns
NULL on error

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

160 {
161  struct GSC_TypeMap *ret;
162  uint16_t size;
163  uLongf dlen;
164 
165  size = ntohs (msg->size);
166  switch (ntohs (msg->type))
167  {
170  gettext_noop ("# type maps received"),
171  1,
172  GNUNET_NO);
173  if (size != sizeof(struct GSC_TypeMap))
174  {
175  GNUNET_break_op (0);
176  return NULL;
177  }
178  ret = GNUNET_new (struct GSC_TypeMap);
179  GNUNET_memcpy (ret, &msg[1], sizeof(struct GSC_TypeMap));
180  return ret;
181 
184  gettext_noop ("# type maps received"),
185  1,
186  GNUNET_NO);
187  ret = GNUNET_new (struct GSC_TypeMap);
188  dlen = sizeof(struct GSC_TypeMap);
189  if ((Z_OK != uncompress ((Bytef *) ret,
190  &dlen,
191  (const Bytef *) &msg[1],
192  (uLong) size)) ||
193  (dlen != sizeof(struct GSC_TypeMap)))
194  {
195  GNUNET_break_op (0);
196  GNUNET_free (ret);
197  return NULL;
198  }
199  return ret;
200 
201  default:
202  GNUNET_break (0);
203  return NULL;
204  }
205 }
struct GNUNET_MessageHeader * msg
Definition: 005.c:2
#define gettext_noop(String)
Definition: gettext.h:69
static int ret
Return value of the commandline.
Definition: gnunet-abd.c:81
struct GNUNET_STATISTICS_Handle * GSC_stats
For creating statistics.
#define GNUNET_break_op(cond)
Use this for assertion violations caused by other peers (i.e.
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur.
#define GNUNET_new(type)
Allocate a struct or union of the given type.
#define GNUNET_free(ptr)
Wrapper around free.
void GNUNET_STATISTICS_update(struct GNUNET_STATISTICS_Handle *handle, const char *name, int64_t delta, int make_persistent)
Set statistic value for the peer.
static unsigned int size
Size of the "table".
Definition: peer.c:67

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 212 of file gnunet-service-core_typemap.c.

213 {
214  struct GNUNET_MessageHeader *hdr;
215 
218  gettext_noop ("# updates to my type map"),
219  1,
220  GNUNET_NO);
222  GNUNET_free (hdr);
223 }
void GSC_SESSIONS_broadcast_typemap(const struct GNUNET_MessageHeader *msg)
Broadcast an updated typemap message to all neighbours.
struct GNUNET_MessageHeader * GSC_TYPEMAP_compute_type_map_message()
Compute a type map message for this peer.

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
typesarray of message types supported by this peer
tlennumber of entries in types

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

234 {
235  unsigned int i;
236  int changed;
237 
238  changed = GNUNET_NO;
239  for (i = 0; i < tlen; i++)
240  {
241  if (0 == map_counters[types[i]]++)
242  {
243  my_type_map.bits[types[i] / 32] |= (1 << (types[i] % 32));
244  changed = GNUNET_YES;
245  }
246  }
247  if (GNUNET_YES == changed)
248  {
249  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Typemap changed, broadcasting!\n");
250  rehash_typemap ();
252  }
253 }
static void rehash_typemap()
Our type map changed, recompute its hash.
static uint8_t map_counters[UINT16_MAX+1]
Counters for message types this peer is able to handle.
static void broadcast_my_type_map()
Send my type map to all connected peers (it got changed).
#define GNUNET_log(kind,...)
@ GNUNET_ERROR_TYPE_DEBUG
uint32_t bits[(UINT16_MAX+1)/32]

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 types from our type map.

Remove a set of message types from our type map.

Parameters
typesarray of types to remove
tlenlength of the types array

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

264 {
265  int changed;
266 
267  changed = GNUNET_NO;
268  for (unsigned int i = 0; i < tlen; i++)
269  {
270  if (0 == --map_counters[types[i]])
271  {
272  my_type_map.bits[types[i] / 32] &= ~(1 << (types[i] % 32));
273  changed = GNUNET_YES;
274  }
275  }
276  if (GNUNET_YES == changed)
277  {
278  rehash_typemap ();
280  }
281 }

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
tmapmap to test
typesarray of types
tcntnumber of entries in types
Returns
GNUNET_YES if a type is in the map, GNUNET_NO if not

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

297 {
298  if (NULL == tmap)
299  return GNUNET_NO;
300  if (0 == tcnt)
301  return GNUNET_YES; /* matches all */
302  for (unsigned int i = 0; i < tcnt; i++)
303  if (0 != (tmap->bits[types[i] / 32] & (1 << (types[i] % 32))))
304  return GNUNET_YES;
305  return GNUNET_NO;
306 }

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
tmapmap to extend (not changed)
typesarray of types to add
tcntnumber of entries in types
Returns
updated type map (fresh copy)

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

321 {
322  struct GSC_TypeMap *ret;
323 
324  ret = GNUNET_new (struct GSC_TypeMap);
325  if (NULL != tmap)
326  GNUNET_memcpy (ret, tmap, sizeof(struct GSC_TypeMap));
327  for (unsigned int i = 0; i < tcnt; i++)
328  ret->bits[types[i] / 32] |= (1 << (types[i] % 32));
329  return ret;
330 }

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 339 of file gnunet-service-core_typemap.c.

340 {
341  return GNUNET_new (struct GSC_TypeMap);
342 }

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
tmapa type map

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

352 {
353  GNUNET_free (tmap);
354 }

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 361 of file gnunet-service-core_typemap.c.

362 {
363  /* nothing to do */
364 }

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 371 of file gnunet-service-core_typemap.c.

372 {
373  /* nothing to do */
374 }

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 1 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 52 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 52 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 63 of file gnunet-service-core_typemap.c.

Referenced by GSC_TYPEMAP_check_hash(), and rehash_typemap().