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     if (size != sizeof (struct GSC_TypeMap))
 111     {
 112       GNUNET_break_op (0);
 113       return NULL;
 114     }
 115     ret = GNUNET_malloc (sizeof (struct GSC_TypeMap));
 116     memcpy (ret, &msg[1], sizeof (struct GSC_TypeMap));
 117     return ret;
 118   case GNUNET_MESSAGE_TYPE_CORE_COMPRESSED_TYPE_MAP:
 119     ret = GNUNET_malloc (sizeof (struct GSC_TypeMap));
 120     dlen = sizeof (struct GSC_TypeMap);
 121     if ( (Z_OK !=
 122           uncompress ((Bytef*) ret, &dlen,
 123                       (const Bytef*) &msg[1], (uLong) size)) ||
 124          (dlen != sizeof (struct GSC_TypeMap) ) )
 125     {
 126       GNUNET_break_op (0);
 127       GNUNET_free (ret);
 128       return NULL;
 129     }
 130     return ret;
 131   default:
 132     GNUNET_break (0);
 133     return NULL;
 134   }
 135 }
 136
 137
 138 /**
 139  * Send my type map to all connected peers (it got changed).
 140  */
 141 static void
 142 broadcast_my_type_map ()
 143 {
 144   struct GNUNET_MessageHeader *hdr;
 145
 146   hdr = GSC_TYPEMAP_compute_type_map_message ();
 147   GSC_SESSIONS_broadcast (hdr);
 148   GNUNET_free (hdr);
 149 }
 150
 151
 152 /**
 153  * Add a set of types to our type map.
 154  */
 155 void
 156 GSC_TYPEMAP_add (const uint16_t *types,
 157                  unsigned int tlen)
 158 {
 159   unsigned int i;
 160   int changed;
 161
 162   changed = GNUNET_NO;
 163   for (i=0;i<tlen;i++)
 164   {
 165     if (0 == map_counters[types[i]]++)
 166     {
 167       my_type_map.bits[types[i] / 32] |= (1 << (types[i] % 32));
 168       changed = GNUNET_YES;
 169     }
 170   }
 171   if (GNUNET_YES == changed)
 172     broadcast_my_type_map ();
 173 }
 174
 175
 176 /**
 177  * Remove a set of types from our type map.
 178  */
 179 void
 180 GSC_TYPEMAP_remove (const uint16_t *types,
 181                     unsigned int tlen)
 182 {
 183   unsigned int i;
 184   int changed;
 185
 186   changed = GNUNET_NO;
 187   for (i=0;i<tlen;i++)
 188   {
 189     if (0 == --map_counters[types[i]])
 190     {
 191       my_type_map.bits[types[i] / 32] &= ~(1 << (types[i] % 32));
 192       changed = GNUNET_YES;
 193     }
 194   }
 195   if (GNUNET_YES == changed)
 196     broadcast_my_type_map ();
 197 }
 198
 199
 200 /**
 201  * Test if any of the types from the types array is in the
 202  * given type map.
 203  *
 204  * @param map map to test
 205  * @param types array of types
 206  * @param tcnt number of entries in types
 207  * @return GNUNET_YES if a type is in the map, GNUNET_NO if not
 208  */
 209 int
 210 GSC_TYPEMAP_test_match (const struct GSC_TypeMap *tmap,
 211                         const uint16_t *types,
 212                         unsigned int tcnt)
 213 {
 214   unsigned int i;
 215
 216   if (NULL == tmap)
 217     return GNUNET_NO;
 218   for (i=0;i<tcnt;i++)
 219     if (0 != (tmap->bits[types[i] / 32] & (1 << (types[i] % 32))))
 220       return GNUNET_YES;
 221   return GNUNET_NO;
 222 }
 223
 224
 225 /**
 226  * Add additional types to a given typemap.
 227  *
 228  * @param map map to extend (not changed)
 229  * @param types array of types to add
 230  * @param tcnt number of entries in types
 231  * @return updated type map (fresh copy)
 232  */
 233 struct GSC_TypeMap *
 234 GSC_TYPEMAP_extend (const struct GSC_TypeMap *tmap,
 235                     const uint16_t *types,
 236                     unsigned int tcnt)
 237 {
 238   struct GSC_TypeMap *ret;
 239   unsigned int i;
 240
 241   ret = GNUNET_malloc (sizeof (struct GSC_TypeMap));
 242   if (NULL != tmap)
 243     memcpy (ret, tmap, sizeof (struct GSC_TypeMap));
 244   for (i=0;i<tcnt;i++)
 245     ret->bits[types[i] / 32] |= (1 << (types[i] % 32));
 246   return ret;
 247 }
 248
 249
 250 /**
 251  * Free the given type map.
 252  *
 253  * @param map a type map
 254  */
 255 void
 256 GSC_TYPEMAP_destroy (struct GSC_TypeMap *tmap)
 257 {
 258   GNUNET_free (tmap);
 259 }
 260
 261
 262 /**
 263  * Initialize typemap subsystem.
 264  */
 265 void
 266 GSC_TYPEMAP_init ()
 267 {
 268   /* nothing to do */
 269 }
 270
 271
 272 /**
 273  * Shutdown typemap subsystem.
 274  */
 275 void
 276 GSC_TYPEMAP_done ()
 277 {
 278   /* nothing to do */
 279 }
 280
 281 /* end of gnunet-service-core_typemap.c */