src/core/gnunet-service-core_typemap.c

   1 /*
   2      This file is part of GNUnet.
   3      Copyright (C) 2011-2014 GNUnet e.V.
   4
   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.
   9
  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.
  14
  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/>.
  17
  18      SPDX-License-Identifier: AGPL3.0-or-later
  19 */
  20
  21 /**
  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
  25  */
  26 #include "platform.h"
  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"
  32 #include <zlib.h>
  33
  34
  35 /**
  36  * A type map describing which messages a given neighbour is able
  37  * to process.
  38  */
  39 struct GSC_TypeMap
  40 {
  41   uint32_t bits[(UINT16_MAX + 1) / 32];
  42 };
  43
  44 /**
  45  * Bitmap of message types this peer is able to handle.
  46  */
  47 static struct GSC_TypeMap my_type_map;
  48
  49 /**
  50  * Counters for message types this peer is able to handle.
  51  */
  52 static uint8_t map_counters[UINT16_MAX + 1];
  53
  54 /**
  55  * Current hash of our (uncompressed) type map.
  56  * Lazily computed when needed.
  57  */
  58 static struct GNUNET_HashCode my_tm_hash;
  59
  60 /**
  61  * Is #my_tm_hash() current with respect to our type map?
  62  */
  63 static int hash_current;
  64
  65
  66 /**
  67  * Our type map changed, recompute its hash.
  68  */
  69 static void
  70 rehash_typemap ()
  71 {
  72   hash_current = GNUNET_NO;
  73 }
  74
  75
  76 /**
  77  * Hash the contents of a type map.
  78  *
  79  * @param tm map to hash
  80  * @param hc where to store the hash code
  81  */
  82 void
  83 GSC_TYPEMAP_hash (const struct GSC_TypeMap *tm, struct GNUNET_HashCode *hc)
  84 {
  85   GNUNET_CRYPTO_hash (tm, sizeof (struct GSC_TypeMap), hc);
  86 }
  87
  88
  89 /**
  90  * Check if the given hash matches our current type map.
  91  *
  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
  94  */
  95 int
  96 GSC_TYPEMAP_check_hash (const struct GNUNET_HashCode *hc)
  97 {
  98   if (GNUNET_NO == hash_current)
  99   {
 100     GSC_TYPEMAP_hash (&my_type_map, &my_tm_hash);
 101     hash_current = GNUNET_YES;
 102   }
 103   return (0 == memcmp (hc, &my_tm_hash, sizeof (struct GNUNET_HashCode)))
 104            ? GNUNET_YES
 105            : GNUNET_NO;
 106 }
 107
 108
 109 /**
 110  * Compute a type map message for this peer.
 111  *
 112  * @return this peers current type map message.
 113  */
 114 struct GNUNET_MessageHeader *
 115 GSC_TYPEMAP_compute_type_map_message ()
 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));
 140     hdr->type = htons (GNUNET_MESSAGE_TYPE_CORE_BINARY_TYPE_MAP);
 141   }
 142   else
 143   {
 144     /* compression worked, use compressed map */
 145     hdr->type = htons (GNUNET_MESSAGE_TYPE_CORE_COMPRESSED_TYPE_MAP);
 146   }
 147   hdr->size = htons ((uint16_t) dlen + sizeof (struct GNUNET_MessageHeader));
 148   return hdr;
 149 }
 150
 151
 152 /**
 153  * Extract a type map from a TYPE_MAP message.
 154  *
 155  * @param msg a type map message
 156  * @return NULL on error
 157  */
 158 struct GSC_TypeMap *
 159 GSC_TYPEMAP_get_from_message (const struct GNUNET_MessageHeader *msg)
 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   {
 168   case GNUNET_MESSAGE_TYPE_CORE_BINARY_TYPE_MAP:
 169     GNUNET_STATISTICS_update (GSC_stats,
 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   case GNUNET_MESSAGE_TYPE_CORE_COMPRESSED_TYPE_MAP:
 182     GNUNET_STATISTICS_update (GSC_stats,
 183                               gettext_noop ("# type maps received"),
 184                               1,
 185                               GNUNET_NO);
 186     ret = GNUNET_new (struct GSC_TypeMap);
 187     dlen = sizeof (struct GSC_TypeMap);
 188     if ((Z_OK != uncompress ((Bytef *) ret,
 189                              &dlen,
 190                              (const Bytef *) &msg[1],
 191                              (uLong) size)) ||
 192         (dlen != sizeof (struct GSC_TypeMap)))
 193     {
 194       GNUNET_break_op (0);
 195       GNUNET_free (ret);
 196       return NULL;
 197     }
 198     return ret;
 199   default:
 200     GNUNET_break (0);
 201     return NULL;
 202   }
 203 }
 204
 205
 206 /**
 207  * Send my type map to all connected peers (it got changed).
 208  */
 209 static void
 210 broadcast_my_type_map ()
 211 {
 212   struct GNUNET_MessageHeader *hdr;
 213
 214   hdr = GSC_TYPEMAP_compute_type_map_message ();
 215   GNUNET_STATISTICS_update (GSC_stats,
 216                             gettext_noop ("# updates to my type map"),
 217                             1,
 218                             GNUNET_NO);
 219   GSC_SESSIONS_broadcast_typemap (hdr);
 220   GNUNET_free (hdr);
 221 }
 222
 223
 224 /**
 225  * Add a set of types to our type map.
 226  *
 227  * @param types array of message types supported by this peer
 228  * @param tlen number of entries in @a types
 229  */
 230 void
 231 GSC_TYPEMAP_add (const uint16_t *types, unsigned int tlen)
 232 {
 233   unsigned int i;
 234   int changed;
 235
 236   changed = GNUNET_NO;
 237   for (i = 0; i < tlen; i++)
 238   {
 239     if (0 == map_counters[types[i]]++)
 240     {
 241       my_type_map.bits[types[i] / 32] |= (1 << (types[i] % 32));
 242       changed = GNUNET_YES;
 243     }
 244   }
 245   if (GNUNET_YES == changed)
 246   {
 247     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Typemap changed, broadcasting!\n");
 248     rehash_typemap ();
 249     broadcast_my_type_map ();
 250   }
 251 }
 252
 253
 254 /**
 255  * Remove a set of types from our type map.
 256  *
 257  * @param types array of types to remove
 258  * @param tlen length of the @a types array
 259  */
 260 void
 261 GSC_TYPEMAP_remove (const uint16_t *types, unsigned int tlen)
 262 {
 263   int changed;
 264
 265   changed = GNUNET_NO;
 266   for (unsigned int i = 0; i < tlen; i++)
 267   {
 268     if (0 == --map_counters[types[i]])
 269     {
 270       my_type_map.bits[types[i] / 32] &= ~(1 << (types[i] % 32));
 271       changed = GNUNET_YES;
 272     }
 273   }
 274   if (GNUNET_YES == changed)
 275   {
 276     rehash_typemap ();
 277     broadcast_my_type_map ();
 278   }
 279 }
 280
 281
 282 /**
 283  * Test if any of the types from the types array is in the
 284  * given type map.
 285  *
 286  * @param tmap map to test
 287  * @param types array of types
 288  * @param tcnt number of entries in @a types
 289  * @return #GNUNET_YES if a type is in the map, #GNUNET_NO if not
 290  */
 291 int
 292 GSC_TYPEMAP_test_match (const struct GSC_TypeMap *tmap,
 293                         const uint16_t *types,
 294                         unsigned int tcnt)
 295 {
 296   if (NULL == tmap)
 297     return GNUNET_NO;
 298   if (0 == tcnt)
 299     return GNUNET_YES; /* matches all */
 300   for (unsigned int i = 0; i < tcnt; i++)
 301     if (0 != (tmap->bits[types[i] / 32] & (1 << (types[i] % 32))))
 302       return GNUNET_YES;
 303   return GNUNET_NO;
 304 }
 305
 306
 307 /**
 308  * Add additional types to a given typemap.
 309  *
 310  * @param tmap map to extend (not changed)
 311  * @param types array of types to add
 312  * @param tcnt number of entries in @a types
 313  * @return updated type map (fresh copy)
 314  */
 315 struct GSC_TypeMap *
 316 GSC_TYPEMAP_extend (const struct GSC_TypeMap *tmap,
 317                     const uint16_t *types,
 318                     unsigned int tcnt)
 319 {
 320   struct GSC_TypeMap *ret;
 321
 322   ret = GNUNET_new (struct GSC_TypeMap);
 323   if (NULL != tmap)
 324     GNUNET_memcpy (ret, tmap, sizeof (struct GSC_TypeMap));
 325   for (unsigned int i = 0; i < tcnt; i++)
 326     ret->bits[types[i] / 32] |= (1 << (types[i] % 32));
 327   return ret;
 328 }
 329
 330
 331 /**
 332  * Create an empty type map.
 333  *
 334  * @return an empty type map
 335  */
 336 struct GSC_TypeMap *
 337 GSC_TYPEMAP_create ()
 338 {
 339   return GNUNET_new (struct GSC_TypeMap);
 340 }
 341
 342
 343 /**
 344  * Free the given type map.
 345  *
 346  * @param tmap a type map
 347  */
 348 void
 349 GSC_TYPEMAP_destroy (struct GSC_TypeMap *tmap)
 350 {
 351   GNUNET_free (tmap);
 352 }
 353
 354
 355 /**
 356  * Initialize typemap subsystem.
 357  */
 358 void
 359 GSC_TYPEMAP_init ()
 360 {
 361   /* nothing to do */
 362 }
 363
 364
 365 /**
 366  * Shutdown typemap subsystem.
 367  */
 368 void
 369 GSC_TYPEMAP_done ()
 370 {
 371   /* nothing to do */
 372 }
 373
 374 /* end of gnunet-service-core_typemap.c */