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 it
6 under the terms of the GNU Affero General Public License as published
7 by the Free Software Foundation, either version 3 of the License,
8 or (at your 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 Affero General Public License for more details.
15 You should have received a copy of the GNU Affero General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>.
18 SPDX-License-Identifier: AGPL3.0-or-later
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, struct GNUNET_HashCode *hc)
85 GNUNET_CRYPTO_hash (tm, sizeof(struct GSC_TypeMap), hc);
90 * Check if the given hash matches our current type map.
92 * @param hc hash code to check if it matches our type map
93 * @return #GNUNET_YES if the hash matches, #GNUNET_NO if not
96 GSC_TYPEMAP_check_hash (const struct GNUNET_HashCode *hc)
98 if (GNUNET_NO == hash_current)
100 GSC_TYPEMAP_hash (&my_type_map, &my_tm_hash);
101 hash_current = GNUNET_YES;
103 return (0 == memcmp (hc, &my_tm_hash, sizeof(struct GNUNET_HashCode)))
110 * Compute a type map message for this peer.
112 * @return this peers current type map message.
114 struct GNUNET_MessageHeader *
115 GSC_TYPEMAP_compute_type_map_message ()
119 struct GNUNET_MessageHeader *hdr;
122 dlen = compressBound (sizeof(my_type_map));
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 */
128 hdr = GNUNET_malloc (dlen + sizeof(struct GNUNET_MessageHeader));
129 tmp = (char *) &hdr[1];
130 if ((Z_OK != compress2 ((Bytef *) tmp,
132 (const Bytef *) &my_type_map,
135 (dlen >= sizeof(my_type_map)))
137 /* compression failed, use uncompressed map */
138 dlen = sizeof(my_type_map);
139 GNUNET_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,
170 gettext_noop ("# type maps received"),
173 if (size != sizeof(struct GSC_TypeMap))
178 ret = GNUNET_new (struct GSC_TypeMap);
179 GNUNET_memcpy (ret, &msg[1], sizeof(struct GSC_TypeMap));
182 case GNUNET_MESSAGE_TYPE_CORE_COMPRESSED_TYPE_MAP:
183 GNUNET_STATISTICS_update (GSC_stats,
184 gettext_noop ("# type maps received"),
187 ret = GNUNET_new (struct GSC_TypeMap);
188 dlen = sizeof(struct GSC_TypeMap);
189 if ((Z_OK != uncompress ((Bytef *) ret,
191 (const Bytef *) &msg[1],
193 (dlen != sizeof(struct GSC_TypeMap)))
209 * Send my type map to all connected peers (it got changed).
212 broadcast_my_type_map ()
214 struct GNUNET_MessageHeader *hdr;
216 hdr = GSC_TYPEMAP_compute_type_map_message ();
217 GNUNET_STATISTICS_update (GSC_stats,
218 gettext_noop ("# updates to my type map"),
221 GSC_SESSIONS_broadcast_typemap (hdr);
227 * Add a set of types to our type map.
229 * @param types array of message types supported by this peer
230 * @param tlen number of entries in @a types
233 GSC_TYPEMAP_add (const uint16_t *types, unsigned int tlen)
239 for (i = 0; i < tlen; i++)
241 if (0 == map_counters[types[i]]++)
243 my_type_map.bits[types[i] / 32] |= (1 << (types[i] % 32));
244 changed = GNUNET_YES;
247 if (GNUNET_YES == changed)
249 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Typemap changed, broadcasting!\n");
251 broadcast_my_type_map ();
257 * Remove a set of types from our type map.
259 * @param types array of types to remove
260 * @param tlen length of the @a types array
263 GSC_TYPEMAP_remove (const uint16_t *types, unsigned int tlen)
268 for (unsigned int i = 0; i < tlen; i++)
270 if (0 == --map_counters[types[i]])
272 my_type_map.bits[types[i] / 32] &= ~(1 << (types[i] % 32));
273 changed = GNUNET_YES;
276 if (GNUNET_YES == changed)
279 broadcast_my_type_map ();
285 * Test if any of the types from the types array is in the
288 * @param tmap map to test
289 * @param types array of types
290 * @param tcnt number of entries in @a types
291 * @return #GNUNET_YES if a type is in the map, #GNUNET_NO if not
294 GSC_TYPEMAP_test_match (const struct GSC_TypeMap *tmap,
295 const uint16_t *types,
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))))
310 * Add additional types to a given typemap.
312 * @param tmap map to extend (not changed)
313 * @param types array of types to add
314 * @param tcnt number of entries in @a types
315 * @return updated type map (fresh copy)
318 GSC_TYPEMAP_extend (const struct GSC_TypeMap *tmap,
319 const uint16_t *types,
322 struct GSC_TypeMap *ret;
324 ret = GNUNET_new (struct GSC_TypeMap);
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));
334 * Create an empty type map.
336 * @return an empty type map
339 GSC_TYPEMAP_create ()
341 return GNUNET_new (struct GSC_TypeMap);
346 * Free the given type map.
348 * @param tmap a type map
351 GSC_TYPEMAP_destroy (struct GSC_TypeMap *tmap)
358 * Initialize typemap subsystem.
368 * Shutdown typemap subsystem.
377 /* end of gnunet-service-core_typemap.c */