src/set/ibf.c

   1 /*
   2       This file is part of GNUnet
   3       (C) 2012 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 2, 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 set/ibf.c
  23  * @brief implementation of the invertible bloom filter
  24  * @author Florian Dold
  25  */
  26
  27 #include "ibf.h"
  28
  29 /**
  30  * Compute the key's hash from the key.
  31  * Redefine to use a different hash function.
  32  */
  33 #define IBF_KEY_HASH_VAL(k) (GNUNET_CRYPTO_crc32_n (&(k), sizeof (struct IBF_KeyHash)))
  34
  35 /**
  36  * Create a key from a hashcode.
  37  *
  38  * @param hash the hashcode
  39  * @return a key
  40  */
  41 struct IBF_Key
  42 ibf_key_from_hashcode (const struct GNUNET_HashCode *hash)
  43 {
  44   /* FIXME: endianess */
  45   return *(struct IBF_Key *) hash;
  46 }
  47
  48 /**
  49  * Create a hashcode from a key, by replicating the key
  50  * until the hascode is filled
  51  *
  52  * @param key the key
  53  * @param dst hashcode to store the result in
  54  */
  55 void
  56 ibf_hashcode_from_key (struct IBF_Key key, struct GNUNET_HashCode *dst)
  57 {
  58   struct IBF_Key *p;
  59   unsigned int i;
  60   const unsigned int keys_per_hashcode = sizeof (struct GNUNET_HashCode) / sizeof (struct IBF_Key);
  61   p = (struct IBF_Key *) dst;
  62   for (i = 0; i < keys_per_hashcode; i++)
  63     *p++ = key;
  64 }
  65
  66
  67 /**
  68  * Create an invertible bloom filter.
  69  *
  70  * @param size number of IBF buckets
  71  * @param hash_num number of buckets one element is hashed in
  72  * @return the newly created invertible bloom filter
  73  */
  74 struct InvertibleBloomFilter *
  75 ibf_create (uint32_t size, uint8_t hash_num)
  76 {
  77   struct InvertibleBloomFilter *ibf;
  78
  79   /* TODO: use malloc_large */
  80
  81   ibf = GNUNET_malloc (sizeof (struct InvertibleBloomFilter));
  82   ibf->count = GNUNET_malloc (size * sizeof (uint8_t));
  83   ibf->key_sum = GNUNET_malloc (size * sizeof (struct GNUNET_HashCode));
  84   ibf->key_hash_sum = GNUNET_malloc (size * sizeof (struct GNUNET_HashCode));
  85   ibf->size = size;
  86   ibf->hash_num = hash_num;
  87
  88   return ibf;
  89 }
  90
  91 /**
  92  * Store unique bucket indices for the specified key in dst.
  93  */
  94 static inline void
  95 ibf_get_indices (const struct InvertibleBloomFilter *ibf,
  96                  struct IBF_Key key, int *dst)
  97 {
  98   uint32_t filled;
  99   uint32_t i;
 100   uint32_t bucket = key.key_val & 0xFFFFFFFF;
 101
 102   for (i = 0, filled=0; filled < ibf->hash_num; i++)
 103   {
 104     unsigned int j;
 105     uint64_t x;
 106     for (j = 0; j < filled; j++)
 107       if (dst[j] == bucket)
 108         goto try_next;
 109     dst[filled++] = bucket % ibf->size;
 110     try_next: ;
 111     x = ((uint64_t) bucket << 32) | i;
 112     bucket = GNUNET_CRYPTO_crc32_n (&x, sizeof x);
 113   }
 114 }
 115
 116
 117 static void
 118 ibf_insert_into  (struct InvertibleBloomFilter *ibf,
 119                   struct IBF_Key key,
 120                   const int *buckets, int side)
 121 {
 122   int i;
 123
 124   for (i = 0; i < ibf->hash_num; i++)
 125   {
 126     const int bucket = buckets[i];
 127     ibf->count[bucket].count_val += side;
 128     ibf->key_sum[bucket].key_val ^= key.key_val;
 129     ibf->key_hash_sum[bucket].key_hash_val
 130         ^= IBF_KEY_HASH_VAL (key);
 131   }
 132 }
 133
 134
 135 /**
 136  * Insert an element into an IBF.
 137  *
 138  * @param ibf the IBF
 139  * @param key the element's hash code
 140  */
 141 void
 142 ibf_insert (struct InvertibleBloomFilter *ibf, struct IBF_Key key)
 143 {
 144   int buckets[ibf->hash_num];
 145   GNUNET_assert (ibf->hash_num <= ibf->size);
 146   ibf_get_indices (ibf, key, buckets);
 147   ibf_insert_into (ibf, key, buckets, 1);
 148 }
 149
 150 /**
 151  * Test is the IBF is empty, i.e. all counts, keys and key hashes are zero.
 152  */
 153 static int
 154 ibf_is_empty (struct InvertibleBloomFilter *ibf)
 155 {
 156   int i;
 157   for (i = 0; i < ibf->size; i++)
 158   {
 159     if (0 != ibf->count[i].count_val)
 160       return GNUNET_NO;
 161     if (0 != ibf->key_hash_sum[i].key_hash_val)
 162       return GNUNET_NO;
 163     if (0 != ibf->key_sum[i].key_val)
 164       return GNUNET_NO;
 165   }
 166   return GNUNET_YES;
 167 }
 168
 169
 170 /**
 171  * Decode and remove an element from the IBF, if possible.
 172  *
 173  * @param ibf the invertible bloom filter to decode
 174  * @param ret_side sign of the cell's count where the decoded element came from.
 175  *                 A negative sign indicates that the element was recovered
 176  *                 resides in an IBF that was previously subtracted from.
 177  * @param ret_id receives the hash code of the decoded element, if successful
 178  * @return GNUNET_YES if decoding an element was successful,
 179  *         GNUNET_NO if the IBF is empty,
 180  *         GNUNET_SYSERR if the decoding has failed
 181  */
 182 int
 183 ibf_decode (struct InvertibleBloomFilter *ibf,
 184             int *ret_side, struct IBF_Key *ret_id)
 185 {
 186   struct IBF_KeyHash hash;
 187   int i;
 188   int buckets[ibf->hash_num];
 189
 190   GNUNET_assert (NULL != ibf);
 191
 192   for (i = 0; i < ibf->size; i++)
 193   {
 194     int j;
 195     int hit;
 196
 197     /* we can only decode from pure buckets */
 198     if ((1 != ibf->count[i].count_val) && (-1 != ibf->count[i].count_val))
 199       continue;
 200
 201     hash.key_hash_val = IBF_KEY_HASH_VAL (ibf->key_sum[i]);
 202
 203     /* test if the hash matches the key */
 204     if (hash.key_hash_val != ibf->key_hash_sum[i].key_hash_val)
 205       continue;
 206
 207     /* test if key in bucket hits its own location,
 208      * if not, the key hash was subject to collision */
 209     hit = GNUNET_NO;
 210     ibf_get_indices (ibf, ibf->key_sum[i], buckets);
 211     for (j = 0; j < ibf->hash_num; j++)
 212       if (buckets[j] == i)
 213         hit = GNUNET_YES;
 214
 215     if (GNUNET_NO == hit)
 216       continue;
 217
 218     if (NULL != ret_side)
 219       *ret_side = ibf->count[i].count_val;
 220     if (NULL != ret_id)
 221       *ret_id = ibf->key_sum[i];
 222
 223     /* insert on the opposite side, effectively removing the element */
 224     ibf_insert_into (ibf, ibf->key_sum[i], buckets, -ibf->count[i].count_val);
 225
 226     return GNUNET_YES;
 227   }
 228
 229   if (GNUNET_YES == ibf_is_empty (ibf))
 230     return GNUNET_NO;
 231   return GNUNET_SYSERR;
 232 }
 233
 234
 235 /**
 236  * Write buckets from an ibf to a buffer.
 237  * Exactly (IBF_BUCKET_SIZE*ibf->size) bytes are written to buf.
 238  *
 239  * @param ibf the ibf to write
 240  * @param start with which bucket to start
 241  * @param count how many buckets to write
 242  * @param buf buffer to write the data to
 243  */
 244 void
 245 ibf_write_slice (const struct InvertibleBloomFilter *ibf, uint32_t start, uint32_t count, void *buf)
 246 {
 247   struct IBF_Key *key_dst;
 248   struct IBF_KeyHash *key_hash_dst;
 249   struct IBF_Count *count_dst;
 250
 251   GNUNET_assert (start + count <= ibf->size);
 252
 253   /* copy keys */
 254   key_dst = (struct IBF_Key *) buf;
 255   memcpy (key_dst, ibf->key_sum + start, count * sizeof *key_dst);
 256   key_dst += count;
 257   /* copy key hashes */
 258   key_hash_dst = (struct IBF_KeyHash *) key_dst;
 259   memcpy (key_hash_dst, ibf->key_hash_sum + start, count * sizeof *key_hash_dst);
 260   key_hash_dst += count;
 261   /* copy counts */
 262   count_dst = (struct IBF_Count *) key_hash_dst;
 263   memcpy (count_dst, ibf->count + start, count * sizeof *count_dst);
 264   count_dst += count;
 265 }
 266
 267
 268 /**
 269  * Read buckets from a buffer into an ibf.
 270  *
 271  * @param buf pointer to the buffer to read from
 272  * @param start which bucket to start at
 273  * @param count how many buckets to read
 274  * @param ibf the ibf to read from
 275  */
 276 void
 277 ibf_read_slice (const void *buf, uint32_t start, uint32_t count, struct InvertibleBloomFilter *ibf)
 278 {
 279   struct IBF_Key *key_src;
 280   struct IBF_KeyHash *key_hash_src;
 281   struct IBF_Count *count_src;
 282
 283   GNUNET_assert (count > 0);
 284   GNUNET_assert (start + count <= ibf->size);
 285
 286   /* copy keys */
 287   key_src = (struct IBF_Key *) buf;
 288   memcpy (ibf->key_sum + start, key_src, count * sizeof *key_src);
 289   key_src += count;
 290   /* copy key hashes */
 291   key_hash_src = (struct IBF_KeyHash *) key_src;
 292   memcpy (ibf->key_hash_sum + start, key_hash_src, count * sizeof *key_hash_src);
 293   key_hash_src += count;
 294   /* copy counts */
 295   count_src = (struct IBF_Count *) key_hash_src;
 296   memcpy (ibf->count + start, count_src, count * sizeof *count_src);
 297   count_src += count;
 298 }
 299
 300
 301 /**
 302  * Subtract ibf2 from ibf1, storing the result in ibf1.
 303  * The two IBF's must have the same parameters size and hash_num.
 304  *
 305  * @param ibf1 IBF that is subtracted from
 306  * @param ibf2 IBF that will be subtracted from ibf1
 307  */
 308 void
 309 ibf_subtract (struct InvertibleBloomFilter *ibf1, const struct InvertibleBloomFilter *ibf2)
 310 {
 311   int i;
 312
 313   GNUNET_assert (ibf1->size == ibf2->size);
 314   GNUNET_assert (ibf1->hash_num == ibf2->hash_num);
 315
 316   for (i = 0; i < ibf1->size; i++)
 317   {
 318     ibf1->count[i].count_val -= ibf2->count[i].count_val;
 319     ibf1->key_hash_sum[i].key_hash_val ^= ibf2->key_hash_sum[i].key_hash_val;
 320     ibf1->key_sum[i].key_val ^= ibf2->key_sum[i].key_val;
 321   }
 322 }
 323
 324
 325 /**
 326  * Create a copy of an IBF, the copy has to be destroyed properly.
 327  *
 328  * @param ibf the IBF to copy
 329  */
 330 struct InvertibleBloomFilter *
 331 ibf_dup (const struct InvertibleBloomFilter *ibf)
 332 {
 333   struct InvertibleBloomFilter *copy;
 334   copy = GNUNET_malloc (sizeof *copy);
 335   copy->hash_num = ibf->hash_num;
 336   copy->size = ibf->size;
 337   copy->key_hash_sum = GNUNET_memdup (ibf->key_hash_sum, ibf->size * sizeof (struct IBF_KeyHash));
 338   copy->key_sum = GNUNET_memdup (ibf->key_sum, ibf->size * sizeof (struct IBF_Key));
 339   copy->count = GNUNET_memdup (ibf->count, ibf->size * sizeof (struct IBF_Count));
 340   return copy;
 341 }
 342
 343
 344 /**
 345  * Destroy all resources associated with the invertible bloom filter.
 346  * No more ibf_*-functions may be called on ibf after calling destroy.
 347  *
 348  * @param ibf the intertible bloom filter to destroy
 349  */
 350 void
 351 ibf_destroy (struct InvertibleBloomFilter *ibf)
 352 {
 353   GNUNET_free (ibf->key_sum);
 354   GNUNET_free (ibf->key_hash_sum);
 355   GNUNET_free (ibf->count);
 356   GNUNET_free (ibf);
 357 }
 358