src/core/gnunet-service-core_typemap.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2011 Christian Grothoff (and other contributing authors)
   4
   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.
   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      General Public License for more details.
  14
  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., 59 Temple Place - Suite 330,
  18      Boston, MA 02111-1307, USA.
  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 /**
  56  * Compute a type map message for this peer.
  57  *
  58  * @return this peers current type map message.
  59  */
  60 struct GNUNET_MessageHeader *
  61 GSC_TYPEMAP_compute_type_map_message ()
  62 {
  63   char *tmp;
  64   uLongf dlen;
  65   struct GNUNET_MessageHeader *hdr;
  66
  67 #ifdef compressBound
  68   dlen = compressBound (sizeof (my_type_map));
  69 #else
  70   dlen = sizeof (my_type_map) + (sizeof (my_type_map) / 100) + 20;
  71   /* documentation says 100.1% oldSize + 12 bytes, but we
  72    * should be able to overshoot by more to be safe */
  73 #endif
  74   hdr = GNUNET_malloc (dlen + sizeof (struct GNUNET_MessageHeader));
  75   tmp = (char *) &hdr[1];
  76   if ((Z_OK !=
  77        compress2 ((Bytef *) tmp, &dlen, (const Bytef *) &my_type_map,
  78                   sizeof (my_type_map), 9)) || (dlen >= sizeof (my_type_map)))
  79   {
  80     dlen = sizeof (my_type_map);
  81     memcpy (tmp, &my_type_map, sizeof (my_type_map));
  82     hdr->type = htons (GNUNET_MESSAGE_TYPE_CORE_BINARY_TYPE_MAP);
  83   }
  84   else
  85   {
  86     hdr->type = htons (GNUNET_MESSAGE_TYPE_CORE_COMPRESSED_TYPE_MAP);
  87   }
  88   hdr->size = htons ((uint16_t) dlen + sizeof (struct GNUNET_MessageHeader));
  89   return hdr;
  90 }
  91
  92
  93 /**
  94  * Extract a type map from a TYPE_MAP message.
  95  *
  96  * @param msg a type map message
  97  * @return NULL on error
  98  */
  99 struct GSC_TypeMap *
 100 GSC_TYPEMAP_get_from_message (const struct GNUNET_MessageHeader *msg)
 101 {
 102   struct GSC_TypeMap *ret;
 103   uint16_t size;
 104   uLongf dlen;
 105
 106   size = ntohs (msg->size);
 107   switch (ntohs (msg->type))
 108   {
 109   case GNUNET_MESSAGE_TYPE_CORE_BINARY_TYPE_MAP:
 110     GNUNET_STATISTICS_update (GSC_stats, gettext_noop ("# type maps received"),
 111                               1, GNUNET_NO);
 112     if (size != sizeof (struct GSC_TypeMap))
 113     {
 114       GNUNET_break_op (0);
 115       return NULL;
 116     }
 117     ret = GNUNET_malloc (sizeof (struct GSC_TypeMap));
 118     memcpy (ret, &msg[1], sizeof (struct GSC_TypeMap));
 119     return ret;
 120   case GNUNET_MESSAGE_TYPE_CORE_COMPRESSED_TYPE_MAP:
 121     GNUNET_STATISTICS_update (GSC_stats, gettext_noop ("# type maps received"),
 122                               1, GNUNET_NO);
 123     ret = GNUNET_malloc (sizeof (struct GSC_TypeMap));
 124     dlen = sizeof (struct GSC_TypeMap);
 125     if ((Z_OK !=
 126          uncompress ((Bytef *) ret, &dlen, (const Bytef *) &msg[1],
 127                      (uLong) size)) || (dlen != sizeof (struct GSC_TypeMap)))
 128     {
 129       GNUNET_break_op (0);
 130       GNUNET_free (ret);
 131       return NULL;
 132     }
 133     return ret;
 134   default:
 135     GNUNET_break (0);
 136     return NULL;
 137   }
 138 }
 139
 140
 141 /**
 142  * Send my type map to all connected peers (it got changed).
 143  */
 144 static void
 145 broadcast_my_type_map ()
 146 {
 147   struct GNUNET_MessageHeader *hdr;
 148
 149   GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 150               "broadcasting typemap\n");
 151   hdr = GSC_TYPEMAP_compute_type_map_message ();
 152   GNUNET_STATISTICS_update (GSC_stats,
 153                             gettext_noop ("# updates to my type map"), 1,
 154                             GNUNET_NO);
 155   GSC_SESSIONS_broadcast (hdr);
 156   GNUNET_free (hdr);
 157 }
 158
 159
 160 /**
 161  * Add a set of types to our type map.
 162  */
 163 void
 164 GSC_TYPEMAP_add (const uint16_t * types, unsigned int tlen)
 165 {
 166   unsigned int i;
 167   int changed;
 168
 169   changed = GNUNET_NO;
 170   for (i = 0; i < tlen; i++)
 171   {
 172     if (0 == map_counters[types[i]]++)
 173     {
 174       my_type_map.bits[types[i] / 32] |= (1 << (types[i] % 32));
 175       changed = GNUNET_YES;
 176     }
 177   }
 178   if (GNUNET_YES == changed)
 179     broadcast_my_type_map ();
 180 }
 181
 182
 183 /**
 184  * Remove a set of types from our type map.
 185  */
 186 void
 187 GSC_TYPEMAP_remove (const uint16_t * types, unsigned int tlen)
 188 {
 189   unsigned int i;
 190   int changed;
 191
 192   changed = GNUNET_NO;
 193   for (i = 0; i < tlen; i++)
 194   {
 195     if (0 == --map_counters[types[i]])
 196     {
 197       my_type_map.bits[types[i] / 32] &= ~(1 << (types[i] % 32));
 198       changed = GNUNET_YES;
 199     }
 200   }
 201   if (GNUNET_YES == changed)
 202     broadcast_my_type_map ();
 203 }
 204
 205
 206 /**
 207  * Test if any of the types from the types array is in the
 208  * given type map.
 209  *
 210  * @param tmap map to test
 211  * @param types array of types
 212  * @param tcnt number of entries in types
 213  * @return GNUNET_YES if a type is in the map, GNUNET_NO if not
 214  */
 215 int
 216 GSC_TYPEMAP_test_match (const struct GSC_TypeMap *tmap, const uint16_t * types,
 217                         unsigned int tcnt)
 218 {
 219   unsigned int i;
 220
 221   if (NULL == tmap)
 222     return GNUNET_NO;
 223   if (0 == tcnt)
 224     return GNUNET_YES;          /* matches all */
 225   for (i = 0; i < tcnt; i++)
 226     if (0 != (tmap->bits[types[i] / 32] & (1 << (types[i] % 32))))
 227       return GNUNET_YES;
 228   return GNUNET_NO;
 229 }
 230
 231
 232 /**
 233  * Add additional types to a given typemap.
 234  *
 235  * @param tmap map to extend (not changed)
 236  * @param types array of types to add
 237  * @param tcnt number of entries in types
 238  * @return updated type map (fresh copy)
 239  */
 240 struct GSC_TypeMap *
 241 GSC_TYPEMAP_extend (const struct GSC_TypeMap *tmap, const uint16_t * types,
 242                     unsigned int tcnt)
 243 {
 244   struct GSC_TypeMap *ret;
 245   unsigned int i;
 246
 247   ret = GNUNET_malloc (sizeof (struct GSC_TypeMap));
 248   if (NULL != tmap)
 249     memcpy (ret, tmap, sizeof (struct GSC_TypeMap));
 250   for (i = 0; i < tcnt; i++)
 251     ret->bits[types[i] / 32] |= (1 << (types[i] % 32));
 252   return ret;
 253 }
 254
 255
 256 /**
 257  * Create an empty type map.
 258  *
 259  * @return an empty type map
 260  */
 261 struct GSC_TypeMap *
 262 GSC_TYPEMAP_create ()
 263 {
 264   return GNUNET_malloc (sizeof (struct GSC_TypeMap));
 265 }
 266
 267
 268 /**
 269  * Free the given type map.
 270  *
 271  * @param tmap a type map
 272  */
 273 void
 274 GSC_TYPEMAP_destroy (struct GSC_TypeMap *tmap)
 275 {
 276   GNUNET_free (tmap);
 277 }
 278
 279
 280 /**
 281  * Initialize typemap subsystem.
 282  */
 283 void
 284 GSC_TYPEMAP_init ()
 285 {
 286   /* nothing to do */
 287 }
 288
 289
 290 /**
 291  * Shutdown typemap subsystem.
 292  */
 293 void
 294 GSC_TYPEMAP_done ()
 295 {
 296   /* nothing to do */
 297 }
 298
 299 /* end of gnunet-service-core_typemap.c */