2 This file is part of GNUnet.
3 Copyright (C) 2011-2014 GNUnet e.V.
5 GNUnet is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published
7 by the Free Software Foundation; either version 3, or (at your
8 option) any later version.
10 GNUnet is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with GNUnet; see the file COPYING. If not, write to the
17 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
18 Boston, MA 02110-1301, USA.
22 * @file core/gnunet-service-core_typemap.c
23 * @brief management of map that specifies which message types this peer supports
24 * @author Christian Grothoff
27 #include "gnunet_util_lib.h"
28 #include "gnunet_transport_service.h"
29 #include "gnunet-service-core.h"
30 #include "gnunet-service-core_sessions.h"
31 #include "gnunet-service-core_typemap.h"
36 * A type map describing which messages a given neighbour is able
41 uint32_t bits[(UINT16_MAX + 1) / 32];
45 * Bitmap of message types this peer is able to handle.
47 static struct GSC_TypeMap my_type_map;
50 * Counters for message types this peer is able to handle.
52 static uint8_t map_counters[UINT16_MAX + 1];
55 * Current hash of our (uncompressed) type map.
56 * Lazily computed when needed.
58 static struct GNUNET_HashCode my_tm_hash;
61 * Is #my_tm_hash() current with respect to our type map?
63 static int hash_current;
67 * Our type map changed, recompute its hash.
72 hash_current = GNUNET_NO;
77 * Hash the contents of a type map.
79 * @param tm map to hash
80 * @param hc where to store the hash code
83 GSC_TYPEMAP_hash (const struct GSC_TypeMap *tm,
84 struct GNUNET_HashCode *hc)
86 GNUNET_CRYPTO_hash (tm,
87 sizeof (struct GSC_TypeMap),
93 * Check if the given hash matches our current type map.
95 * @param hc hash code to check if it matches our type map
96 * @return #GNUNET_YES if the hash matches, #GNUNET_NO if not
99 GSC_TYPEMAP_check_hash (const struct GNUNET_HashCode *hc)
101 if (GNUNET_NO == hash_current)
103 GSC_TYPEMAP_hash (&my_type_map,
105 hash_current = GNUNET_YES;
107 return (0 == memcmp (hc, &my_tm_hash, sizeof (struct GNUNET_HashCode)))
108 ? GNUNET_YES : GNUNET_NO;
113 * Compute a type map message for this peer.
115 * @return this peers current type map message.
117 struct GNUNET_MessageHeader *
118 GSC_TYPEMAP_compute_type_map_message ()
122 struct GNUNET_MessageHeader *hdr;
125 dlen = compressBound (sizeof (my_type_map));
127 dlen = sizeof (my_type_map) + (sizeof (my_type_map) / 100) + 20;
128 /* documentation says 100.1% oldSize + 12 bytes, but we
129 * should be able to overshoot by more to be safe */
131 hdr = GNUNET_malloc (dlen + sizeof (struct GNUNET_MessageHeader));
132 tmp = (char *) &hdr[1];
134 compress2 ((Bytef *) tmp, &dlen, (const Bytef *) &my_type_map,
135 sizeof (my_type_map), 9)) || (dlen >= sizeof (my_type_map)))
137 /* compression failed, use uncompressed map */
138 dlen = sizeof (my_type_map);
139 memcpy (tmp, &my_type_map, sizeof (my_type_map));
140 hdr->type = htons (GNUNET_MESSAGE_TYPE_CORE_BINARY_TYPE_MAP);
144 /* compression worked, use compressed map */
145 hdr->type = htons (GNUNET_MESSAGE_TYPE_CORE_COMPRESSED_TYPE_MAP);
147 hdr->size = htons ((uint16_t) dlen + sizeof (struct GNUNET_MessageHeader));
153 * Extract a type map from a TYPE_MAP message.
155 * @param msg a type map message
156 * @return NULL on error
159 GSC_TYPEMAP_get_from_message (const struct GNUNET_MessageHeader *msg)
161 struct GSC_TypeMap *ret;
165 size = ntohs (msg->size);
166 switch (ntohs (msg->type))
168 case GNUNET_MESSAGE_TYPE_CORE_BINARY_TYPE_MAP:
169 GNUNET_STATISTICS_update (GSC_stats, gettext_noop ("# type maps received"),
171 if (size != sizeof (struct GSC_TypeMap))
176 ret = GNUNET_new (struct GSC_TypeMap);
177 memcpy (ret, &msg[1], sizeof (struct GSC_TypeMap));
179 case GNUNET_MESSAGE_TYPE_CORE_COMPRESSED_TYPE_MAP:
180 GNUNET_STATISTICS_update (GSC_stats, gettext_noop ("# type maps received"),
182 ret = GNUNET_new (struct GSC_TypeMap);
183 dlen = sizeof (struct GSC_TypeMap);
185 uncompress ((Bytef *) ret, &dlen, (const Bytef *) &msg[1],
186 (uLong) size)) || (dlen != sizeof (struct GSC_TypeMap)))
201 * Send my type map to all connected peers (it got changed).
204 broadcast_my_type_map ()
206 struct GNUNET_MessageHeader *hdr;
208 hdr = GSC_TYPEMAP_compute_type_map_message ();
209 GNUNET_STATISTICS_update (GSC_stats,
210 gettext_noop ("# updates to my type map"), 1,
212 GSC_SESSIONS_broadcast_typemap (hdr);
218 * Add a set of types to our type map.
220 * @param types array of message types supported by this peer
221 * @param tlen number of entries in @a types
224 GSC_TYPEMAP_add (const uint16_t *types,
231 for (i = 0; i < tlen; i++)
233 if (0 == map_counters[types[i]]++)
235 my_type_map.bits[types[i] / 32] |= (1 << (types[i] % 32));
236 changed = GNUNET_YES;
239 if (GNUNET_YES == changed)
242 broadcast_my_type_map ();
248 * Remove a set of types from our type map.
250 * @param types array of types to remove
251 * @param tlen length of the @a types array
254 GSC_TYPEMAP_remove (const uint16_t *types,
261 for (i = 0; i < tlen; i++)
263 if (0 == --map_counters[types[i]])
265 my_type_map.bits[types[i] / 32] &= ~(1 << (types[i] % 32));
266 changed = GNUNET_YES;
269 if (GNUNET_YES == changed)
272 broadcast_my_type_map ();
278 * Test if any of the types from the types array is in the
281 * @param tmap map to test
282 * @param types array of types
283 * @param tcnt number of entries in @a types
284 * @return #GNUNET_YES if a type is in the map, #GNUNET_NO if not
287 GSC_TYPEMAP_test_match (const struct GSC_TypeMap *tmap,
288 const uint16_t *types,
296 return GNUNET_YES; /* matches all */
297 for (i = 0; i < tcnt; i++)
298 if (0 != (tmap->bits[types[i] / 32] & (1 << (types[i] % 32))))
305 * Add additional types to a given typemap.
307 * @param tmap map to extend (not changed)
308 * @param types array of types to add
309 * @param tcnt number of entries in @a types
310 * @return updated type map (fresh copy)
313 GSC_TYPEMAP_extend (const struct GSC_TypeMap *tmap,
314 const uint16_t *types,
317 struct GSC_TypeMap *ret;
320 ret = GNUNET_new (struct GSC_TypeMap);
322 memcpy (ret, tmap, sizeof (struct GSC_TypeMap));
323 for (i = 0; i < tcnt; i++)
324 ret->bits[types[i] / 32] |= (1 << (types[i] % 32));
330 * Create an empty type map.
332 * @return an empty type map
335 GSC_TYPEMAP_create ()
337 return GNUNET_new (struct GSC_TypeMap);
342 * Free the given type map.
344 * @param tmap a type map
347 GSC_TYPEMAP_destroy (struct GSC_TypeMap *tmap)
354 * Initialize typemap subsystem.
364 * Shutdown typemap subsystem.
372 /* end of gnunet-service-core_typemap.c */