src/include/gnunet_container_lib.h

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2001-2013 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 include/gnunet_container_lib.h
  23  * @brief container classes for GNUnet
  24  * @author Christian Grothoff
  25  * @author Nils Durner
  26  * @defgroup hashmap multi hash-map
  27  * @defgroup heap min- or max-heap with arbitrary element removal
  28  * @defgroup bloomfilter Bloom filter (probabilistic set tests)
  29  * @defgroup dll Doubly-linked list
  30  * @defgroup metadata Meta data (GNU libextractor key-value pairs)
  31  */
  32
  33 #ifndef GNUNET_CONTAINER_LIB_H
  34 #define GNUNET_CONTAINER_LIB_H
  35
  36 /* add error and config prototypes */
  37 #include "gnunet_crypto_lib.h"
  38 #include <extractor.h>
  39
  40 #ifndef EXTRACTOR_METATYPE_GNUNET_ORIGINAL_FILENAME
  41 /* hack for LE < 0.6.3 */
  42 #define EXTRACTOR_METATYPE_GNUNET_ORIGINAL_FILENAME 180
  43 #endif
  44
  45 #ifdef __cplusplus
  46 extern "C"
  47 {
  48 #if 0                           /* keep Emacsens' auto-indent happy */
  49 }
  50 #endif
  51 #endif
  52
  53
  54 /* ******************* bloomfilter ***************** */
  55
  56 /**
  57  * @brief bloomfilter representation (opaque)
  58  * @ingroup bloomfilter
  59  */
  60 struct GNUNET_CONTAINER_BloomFilter;
  61
  62
  63 /**
  64  * @ingroup bloomfilter
  65  * Iterator over `struct GNUNET_HashCode`.
  66  *
  67  * @param cls closure
  68  * @param next set to the next hash code
  69  * @return #GNUNET_YES if next was updated
  70  *         #GNUNET_NO if there are no more entries
  71  */
  72 typedef int
  73 (*GNUNET_CONTAINER_HashCodeIterator) (void *cls,
  74                                       struct GNUNET_HashCode *next);
  75
  76
  77 /**
  78  * @ingroup bloomfilter
  79  * Load a Bloom filter from a file.
  80  *
  81  * @param filename the name of the file (or the prefix)
  82  * @param size the size of the bloom-filter (number of
  83  *        bytes of storage space to use); will be rounded up
  84  *        to next power of 2
  85  * @param k the number of #GNUNET_CRYPTO_hash-functions to apply per
  86  *        element (number of bits set per element in the set)
  87  * @return the bloomfilter
  88  */
  89 struct GNUNET_CONTAINER_BloomFilter *
  90 GNUNET_CONTAINER_bloomfilter_load (const char *filename,
  91                                    size_t size,
  92                                    unsigned int k);
  93
  94
  95 /**
  96  * @ingroup bloomfilter
  97  * Create a Bloom filter from raw bits.
  98  *
  99  * @param data the raw bits in memory (maybe NULL,
 100  *        in which case all bits should be considered
 101  *        to be zero).
 102  * @param size the size of the bloom-filter (number of
 103  *        bytes of storage space to use); also size of @a data
 104  *        -- unless data is NULL.  Must be a power of 2.
 105  * @param k the number of #GNUNET_CRYPTO_hash-functions to apply per
 106  *        element (number of bits set per element in the set)
 107  * @return the bloomfilter
 108  */
 109 struct GNUNET_CONTAINER_BloomFilter *
 110 GNUNET_CONTAINER_bloomfilter_init (const char *data,
 111                                    size_t size,
 112                                    unsigned int k);
 113
 114
 115 /**
 116  * @ingroup bloomfilter
 117  * Copy the raw data of this Bloom filter into
 118  * the given data array.
 119  *
 120  * @param data where to write the data
 121  * @param size the size of the given @a data array
 122  * @return #GNUNET_SYSERR if the data array of the wrong size
 123  */
 124 int
 125 GNUNET_CONTAINER_bloomfilter_get_raw_data (const struct GNUNET_CONTAINER_BloomFilter *bf,
 126                                            char *data,
 127                                            size_t size);
 128
 129
 130 /**
 131  * @ingroup bloomfilter
 132  * Test if an element is in the filter.
 133  *
 134  * @param e the element
 135  * @param bf the filter
 136  * @return #GNUNET_YES if the element is in the filter, #GNUNET_NO if not
 137  */
 138 int
 139 GNUNET_CONTAINER_bloomfilter_test (const struct GNUNET_CONTAINER_BloomFilter *bf,
 140                                    const struct GNUNET_HashCode *e);
 141
 142
 143 /**
 144  * @ingroup bloomfilter
 145  * Add an element to the filter.
 146  *
 147  * @param bf the filter
 148  * @param e the element
 149  */
 150 void
 151 GNUNET_CONTAINER_bloomfilter_add (struct GNUNET_CONTAINER_BloomFilter *bf,
 152                                   const struct GNUNET_HashCode *e);
 153
 154
 155 /**
 156  * @ingroup bloomfilter
 157  * Remove an element from the filter.
 158  *
 159  * @param bf the filter
 160  * @param e the element to remove
 161  */
 162 void
 163 GNUNET_CONTAINER_bloomfilter_remove (struct GNUNET_CONTAINER_BloomFilter *bf,
 164                                      const struct GNUNET_HashCode *e);
 165
 166
 167 /**
 168  * @ingroup bloomfilter
 169  * Create a copy of a bloomfilter.
 170  *
 171  * @param bf the filter
 172  * @return copy of bf
 173  */
 174 struct GNUNET_CONTAINER_BloomFilter *
 175 GNUNET_CONTAINER_bloomfilter_copy (const struct GNUNET_CONTAINER_BloomFilter *bf);
 176
 177
 178
 179 /**
 180  * @ingroup bloomfilter
 181  * Free the space associcated with a filter
 182  * in memory, flush to drive if needed (do not
 183  * free the space on the drive).
 184  *
 185  * @param bf the filter
 186  */
 187 void
 188 GNUNET_CONTAINER_bloomfilter_free (struct GNUNET_CONTAINER_BloomFilter *bf);
 189
 190
 191 /**
 192  * Get the number of the addresses set per element in the bloom filter.
 193  *
 194  * @param bf the filter
 195  * @return addresses set per element in the bf
 196  */
 197 size_t
 198 GNUNET_CONTAINER_bloomfilter_get_element_addresses (const struct GNUNET_CONTAINER_BloomFilter *bf);
 199
 200
 201 /**
 202  * @ingroup bloomfilter
 203  * Get size of the bloom filter.
 204  *
 205  * @param bf the filter
 206  * @return number of bytes used for the data of the bloom filter
 207  */
 208 size_t
 209 GNUNET_CONTAINER_bloomfilter_get_size (const struct GNUNET_CONTAINER_BloomFilter *bf);
 210
 211
 212 /**
 213  * @ingroup bloomfilter
 214  * Reset a Bloom filter to empty.
 215  *
 216  * @param bf the filter
 217  */
 218 void
 219 GNUNET_CONTAINER_bloomfilter_clear (struct GNUNET_CONTAINER_BloomFilter *bf);
 220
 221
 222 /**
 223  * @ingroup bloomfilter
 224  * "or" the entries of the given raw data array with the
 225  * data of the given Bloom filter.  Assumes that
 226  * the @a size of the @a data array and the current filter
 227  * match.
 228  *
 229  * @param bf the filter
 230  * @param data data to OR-in
 231  * @param size size of @a data
 232  * @return #GNUNET_OK on success
 233  */
 234 int
 235 GNUNET_CONTAINER_bloomfilter_or (struct GNUNET_CONTAINER_BloomFilter *bf,
 236                                  const char *data, size_t size);
 237
 238
 239 /**
 240  * @ingroup bloomfilter
 241  * "or" the entries of the given raw data array with the
 242  * data of the given Bloom filter.  Assumes that
 243  * the size of the two filters matches.
 244  *
 245  * @param bf the filter
 246  * @param to_or the bloomfilter to or-in
 247  * @return #GNUNET_OK on success
 248  */
 249 int
 250 GNUNET_CONTAINER_bloomfilter_or2 (struct GNUNET_CONTAINER_BloomFilter *bf,
 251                                   const struct GNUNET_CONTAINER_BloomFilter *to_or);
 252
 253
 254 /**
 255  * @ingroup bloomfilter
 256  * Resize a bloom filter.  Note that this operation
 257  * is pretty costly.  Essentially, the Bloom filter
 258  * needs to be completely re-build.
 259  *
 260  * @param bf the filter
 261  * @param iterator an iterator over all elements stored in the BF
 262  * @param iterator_cls closure for @a iterator
 263  * @param size the new size for the filter
 264  * @param k the new number of #GNUNET_CRYPTO_hash-function to apply per element
 265  */
 266 void
 267 GNUNET_CONTAINER_bloomfilter_resize (struct GNUNET_CONTAINER_BloomFilter *bf,
 268                                      GNUNET_CONTAINER_HashCodeIterator iterator,
 269                                      void *iterator_cls,
 270                                      size_t size,
 271                                      unsigned int k);
 272
 273
 274 /* ****************** metadata ******************* */
 275
 276 /**
 277  * @ingroup metadata
 278  * Meta data to associate with a file, directory or namespace.
 279  */
 280 struct GNUNET_CONTAINER_MetaData;
 281
 282
 283 /**
 284  * @ingroup metadata
 285  * Create a fresh meta data container.
 286  *
 287  * @return empty meta-data container
 288  */
 289 struct GNUNET_CONTAINER_MetaData *
 290 GNUNET_CONTAINER_meta_data_create (void);
 291
 292
 293 /**
 294  * @ingroup metadata
 295  * Duplicate a MetaData token.
 296  *
 297  * @param md what to duplicate
 298  * @return duplicate meta-data container
 299  */
 300 struct GNUNET_CONTAINER_MetaData *
 301 GNUNET_CONTAINER_meta_data_duplicate (const struct GNUNET_CONTAINER_MetaData *md);
 302
 303
 304 /**
 305  * @ingroup metadata
 306  * Free meta data.
 307  *
 308  * @param md what to free
 309  */
 310 void
 311 GNUNET_CONTAINER_meta_data_destroy (struct GNUNET_CONTAINER_MetaData *md);
 312
 313
 314 /**
 315  * @ingroup metadata
 316  * Test if two MDs are equal. We consider them equal if
 317  * the meta types, formats and content match (we do not
 318  * include the mime types and plugins names in this
 319  * consideration).
 320  *
 321  * @param md1 first value to check
 322  * @param md2 other value to check
 323  * @return #GNUNET_YES if they are equal
 324  */
 325 int
 326 GNUNET_CONTAINER_meta_data_test_equal (const struct GNUNET_CONTAINER_MetaData *md1,
 327                                        const struct GNUNET_CONTAINER_MetaData *md2);
 328
 329
 330 /**
 331  * @ingroup metadata
 332  * Extend metadata.
 333  *
 334  * @param md metadata to extend
 335  * @param plugin_name name of the plugin that produced this value;
 336  *        special values can be used (i.e. '&lt;zlib&gt;' for zlib being
 337  *        used in the main libextractor library and yielding
 338  *        meta data).
 339  * @param type libextractor-type describing the meta data
 340  * @param format basic format information about data
 341  * @param data_mime_type mime-type of data (not of the original file);
 342  *        can be NULL (if mime-type is not known)
 343  * @param data actual meta-data found
 344  * @param data_size number of bytes in data
 345  * @return #GNUNET_OK on success, #GNUNET_SYSERR if this entry already exists
 346  *         data_mime_type and plugin_name are not considered for "exists" checks
 347  */
 348 int
 349 GNUNET_CONTAINER_meta_data_insert (struct GNUNET_CONTAINER_MetaData *md,
 350                                    const char *plugin_name,
 351                                    enum EXTRACTOR_MetaType type,
 352                                    enum EXTRACTOR_MetaFormat format,
 353                                    const char *data_mime_type,
 354                                    const char *data,
 355                                    size_t data_size);
 356
 357
 358 /**
 359  * @ingroup metadata
 360  * Extend metadata.  Merges the meta data from the second argument
 361  * into the first, discarding duplicate key-value pairs.
 362  *
 363  * @param md metadata to extend
 364  * @param in metadata to merge
 365  */
 366 void
 367 GNUNET_CONTAINER_meta_data_merge (struct GNUNET_CONTAINER_MetaData *md,
 368                                   const struct GNUNET_CONTAINER_MetaData *in);
 369
 370
 371 /**
 372  * @ingroup metadata
 373  * Remove an item.
 374  *
 375  * @param md metadata to manipulate
 376  * @param type type of the item to remove
 377  * @param data specific value to remove, NULL to remove all
 378  *        entries of the given type
 379  * @param data_size number of bytes in data
 380  * @return #GNUNET_OK on success, #GNUNET_SYSERR if the item does not exist in md
 381  */
 382 int
 383 GNUNET_CONTAINER_meta_data_delete (struct GNUNET_CONTAINER_MetaData *md,
 384                                    enum EXTRACTOR_MetaType type,
 385                                    const char *data,
 386                                    size_t data_size);
 387
 388
 389 /**
 390  * @ingroup metadata
 391  * Remove all items in the container.
 392  *
 393  * @param md metadata to manipulate
 394  */
 395 void
 396 GNUNET_CONTAINER_meta_data_clear (struct GNUNET_CONTAINER_MetaData *md);
 397
 398
 399 /**
 400  * @ingroup metadata
 401  * Add the current time as the publication date
 402  * to the meta-data.
 403  *
 404  * @param md metadata to modify
 405  */
 406 void
 407 GNUNET_CONTAINER_meta_data_add_publication_date (struct GNUNET_CONTAINER_MetaData *md);
 408
 409
 410 /**
 411  * @ingroup metadata
 412  * Iterate over MD entries.
 413  *
 414  * @param md metadata to inspect
 415  * @param iter function to call on each entry, return 0 to continue to iterate
 416  *             and 1 to abort iteration in this function (GNU libextractor API!)
 417  * @param iter_cls closure for @a iter
 418  * @return number of entries
 419  */
 420 int
 421 GNUNET_CONTAINER_meta_data_iterate (const struct GNUNET_CONTAINER_MetaData *md,
 422                                     EXTRACTOR_MetaDataProcessor iter,
 423                                     void *iter_cls);
 424
 425
 426 /**
 427  * @ingroup metadata
 428  * Get the first MD entry of the given type.  Caller
 429  * is responsible for freeing the return value.
 430  * Also, only meta data items that are strings (0-terminated)
 431  * are returned by this function.
 432  *
 433  * @param md metadata to inspect
 434  * @param type type to look for
 435  * @return NULL if no entry was found
 436  */
 437 char *
 438 GNUNET_CONTAINER_meta_data_get_by_type (const struct GNUNET_CONTAINER_MetaData *md,
 439                                         enum EXTRACTOR_MetaType type);
 440
 441
 442 /**
 443  * @ingroup metadata
 444  * Get the first matching MD entry of the given types. Caller is
 445  * responsible for freeing the return value.  Also, only meta data
 446  * items that are strings (0-terminated) are returned by this
 447  * function.
 448  *
 449  * @param md metadata to inspect
 450  * @param ... -1-terminated list of types
 451  * @return NULL if we do not have any such entry,
 452  *  otherwise client is responsible for freeing the value!
 453  */
 454 char *
 455 GNUNET_CONTAINER_meta_data_get_first_by_types (const struct GNUNET_CONTAINER_MetaData *md,
 456                                                ...);
 457
 458 /**
 459  * @ingroup metadata
 460  * Get a thumbnail from the meta-data (if present).  Only matches meta
 461  * data with mime type "image" and binary format.
 462  *
 463  * @param md metadata to inspect
 464  * @param thumb will be set to the thumbnail data.  Must be
 465  *        freed by the caller!
 466  * @return number of bytes in thumbnail, 0 if not available
 467  */
 468 size_t
 469 GNUNET_CONTAINER_meta_data_get_thumbnail (const struct GNUNET_CONTAINER_MetaData *md,
 470                                           unsigned char **thumb);
 471
 472
 473
 474 /**
 475  * @ingroup metadata
 476  * Options for metadata serialization.
 477  */
 478 enum GNUNET_CONTAINER_MetaDataSerializationOptions
 479 {
 480   /**
 481    * @ingroup metadata
 482    * Serialize all of the data.
 483    */
 484   GNUNET_CONTAINER_META_DATA_SERIALIZE_FULL = 0,
 485
 486   /**
 487    * @ingroup metadata
 488    * If not enough space is available, it is acceptable
 489    * to only serialize some of the metadata.
 490    */
 491   GNUNET_CONTAINER_META_DATA_SERIALIZE_PART = 1,
 492
 493   /**
 494    * @ingroup metadata
 495    * Speed is of the essence, do not allow compression.
 496    */
 497   GNUNET_CONTAINER_META_DATA_SERIALIZE_NO_COMPRESS = 2
 498 };
 499
 500
 501 /**
 502  * @ingroup metadata
 503  * Serialize meta-data to target.
 504  *
 505  * @param md metadata to serialize
 506  * @param target where to write the serialized metadata;
 507  *         *target can be NULL, in which case memory is allocated
 508  * @param max maximum number of bytes available
 509  * @param opt is it ok to just write SOME of the
 510  *        meta-data to match the size constraint,
 511  *        possibly discarding some data?
 512  * @return number of bytes written on success,
 513  *         -1 on error (typically: not enough
 514  *         space)
 515  */
 516 ssize_t
 517 GNUNET_CONTAINER_meta_data_serialize (const struct GNUNET_CONTAINER_MetaData *md,
 518                                       char **target,
 519                                       size_t max,
 520                                       enum GNUNET_CONTAINER_MetaDataSerializationOptions opt);
 521
 522
 523 /**
 524  * @ingroup metadata
 525  * Get the size of the full meta-data in serialized form.
 526  *
 527  * @param md metadata to inspect
 528  * @return number of bytes needed for serialization, -1 on error
 529  */
 530 ssize_t
 531 GNUNET_CONTAINER_meta_data_get_serialized_size (const struct GNUNET_CONTAINER_MetaData *md);
 532
 533
 534 /**
 535  * @ingroup metadata
 536  * Deserialize meta-data.  Initializes md.
 537  *
 538  * @param input serialized meta-data.
 539  * @param size number of bytes available
 540  * @return MD on success, NULL on error (i.e.
 541  *         bad format)
 542  */
 543 struct GNUNET_CONTAINER_MetaData *
 544 GNUNET_CONTAINER_meta_data_deserialize (const char *input,
 545                                         size_t size);
 546
 547
 548 /* ******************************* HashMap **************************** */
 549
 550 /**
 551  * @ingroup hashmap
 552  * Opaque handle for a HashMap.
 553  */
 554 struct GNUNET_CONTAINER_MultiHashMap;
 555
 556 /**
 557  * @ingroup hashmap
 558  * Opaque handle to an iterator over
 559  * a multihashmap.
 560  */
 561 struct GNUNET_CONTAINER_MultiHashMapIterator;
 562
 563 /**
 564  * @ingroup hashmap
 565  * Options for storing values in the HashMap.
 566  */
 567 enum GNUNET_CONTAINER_MultiHashMapOption
 568 {
 569
 570   /**
 571    * @ingroup hashmap
 572    * If a value with the given key exists, replace it.  Note that the
 573    * old value would NOT be freed by replace (the application has to
 574    * make sure that this happens if required).
 575    */
 576   GNUNET_CONTAINER_MULTIHASHMAPOPTION_REPLACE,
 577
 578   /**
 579    * @ingroup hashmap
 580    * Allow multiple values with the same key.
 581    */
 582   GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE,
 583
 584   /**
 585    * @ingroup hashmap
 586    * There must only be one value per key; storing a value should fail
 587    * if a value under the same key already exists.
 588    */
 589   GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY,
 590
 591   /**
 592    * @ingroup hashmap There must only be one value per key, but don't
 593    * bother checking if a value already exists (faster than
 594    * #GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY; implemented
 595    * just like #GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE but this
 596    * option documents better what is intended if
 597    * #GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY is what is
 598    * desired).
 599    */
 600   GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST
 601 };
 602
 603
 604 /**
 605  * @ingroup hashmap
 606  * Iterator over hash map entries.
 607  *
 608  * @param cls closure
 609  * @param key current key code
 610  * @param value value in the hash map
 611  * @return #GNUNET_YES if we should continue to
 612  *         iterate,
 613  *         #GNUNET_NO if not.
 614  */
 615 typedef int
 616 (*GNUNET_CONTAINER_HashMapIterator) (void *cls,
 617                                      const struct GNUNET_HashCode *key,
 618                                      void *value);
 619
 620
 621 /**
 622  * @ingroup hashmap
 623  * Create a multi hash map.
 624  *
 625  * @param len initial size (map will grow as needed)
 626  * @param do_not_copy_keys #GNUNET_NO is always safe and should be used by default;
 627  *                         #GNUNET_YES means that on 'put', the 'key' does not have
 628  *                         to be copied as the destination of the pointer is
 629  *                         guaranteed to be life as long as the value is stored in
 630  *                         the hashmap.  This can significantly reduce memory
 631  *                         consumption, but of course is also a recipie for
 632  *                         heap corruption if the assumption is not true.  Only
 633  *                         use this if (1) memory use is important in this case and
 634  *                         (2) you have triple-checked that the invariant holds
 635  * @return NULL on error
 636  */
 637 struct GNUNET_CONTAINER_MultiHashMap *
 638 GNUNET_CONTAINER_multihashmap_create (unsigned int len,
 639                                       int do_not_copy_keys);
 640
 641
 642 /**
 643  * @ingroup hashmap
 644  * Destroy a hash map.  Will not free any values
 645  * stored in the hash map!
 646  *
 647  * @param map the map
 648  */
 649 void
 650 GNUNET_CONTAINER_multihashmap_destroy (struct GNUNET_CONTAINER_MultiHashMap *map);
 651
 652
 653 /**
 654  * @ingroup hashmap
 655  * Given a key find a value in the map matching the key.
 656  *
 657  * @param map the map
 658  * @param key what to look for
 659  * @return NULL if no value was found; note that
 660  *   this is indistinguishable from values that just
 661  *   happen to be NULL; use "contains" to test for
 662  *   key-value pairs with value NULL
 663  */
 664 void *
 665 GNUNET_CONTAINER_multihashmap_get (const struct GNUNET_CONTAINER_MultiHashMap *map,
 666                                    const struct GNUNET_HashCode *key);
 667
 668
 669 /**
 670  * @ingroup hashmap
 671  * Remove the given key-value pair from the map.  Note that if the
 672  * key-value pair is in the map multiple times, only one of the pairs
 673  * will be removed.
 674  *
 675  * @param map the map
 676  * @param key key of the key-value pair
 677  * @param value value of the key-value pair
 678  * @return #GNUNET_YES on success, #GNUNET_NO if the key-value pair
 679  *  is not in the map
 680  */
 681 int
 682 GNUNET_CONTAINER_multihashmap_remove (struct GNUNET_CONTAINER_MultiHashMap *map,
 683                                       const struct GNUNET_HashCode *key,
 684                                       const void *value);
 685
 686 /**
 687  * @ingroup hashmap
 688  * Remove all entries for the given key from the map.
 689  * Note that the values would not be "freed".
 690  *
 691  * @param map the map
 692  * @param key identifies values to be removed
 693  * @return number of values removed
 694  */
 695 int
 696 GNUNET_CONTAINER_multihashmap_remove_all (struct GNUNET_CONTAINER_MultiHashMap *map,
 697                                           const struct GNUNET_HashCode *key);
 698
 699
 700 /**
 701  * @ingroup hashmap
 702  * Check if the map contains any value under the given
 703  * key (including values that are NULL).
 704  *
 705  * @param map the map
 706  * @param key the key to test if a value exists for it
 707  * @return #GNUNET_YES if such a value exists,
 708  *         #GNUNET_NO if not
 709  */
 710 int
 711 GNUNET_CONTAINER_multihashmap_contains (const struct GNUNET_CONTAINER_MultiHashMap *map,
 712                                         const struct GNUNET_HashCode * key);
 713
 714
 715 /**
 716  * @ingroup hashmap
 717  * Check if the map contains the given value under the given
 718  * key.
 719  *
 720  * @param map the map
 721  * @param key the key to test if a value exists for it
 722  * @param value value to test for
 723  * @return #GNUNET_YES if such a value exists,
 724  *         #GNUNET_NO if not
 725  */
 726 int
 727 GNUNET_CONTAINER_multihashmap_contains_value (const struct GNUNET_CONTAINER_MultiHashMap *map,
 728                                               const struct GNUNET_HashCode *key,
 729                                               const void *value);
 730
 731
 732 /**
 733  * @ingroup hashmap
 734  * Store a key-value pair in the map.
 735  *
 736  * @param map the map
 737  * @param key key to use
 738  * @param value value to use
 739  * @param opt options for put
 740  * @return #GNUNET_OK on success,
 741  *         #GNUNET_NO if a value was replaced (with REPLACE)
 742  *         #GNUNET_SYSERR if #GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY was the option and the
 743  *                       value already exists
 744  */
 745 int
 746 GNUNET_CONTAINER_multihashmap_put (struct GNUNET_CONTAINER_MultiHashMap *map,
 747                                    const struct GNUNET_HashCode *key,
 748                                    void *value,
 749                                    enum GNUNET_CONTAINER_MultiHashMapOption
 750                                    opt);
 751
 752 /**
 753  * @ingroup hashmap
 754  * Get the number of key-value pairs in the map.
 755  *
 756  * @param map the map
 757  * @return the number of key value pairs
 758  */
 759 unsigned int
 760 GNUNET_CONTAINER_multihashmap_size (const struct GNUNET_CONTAINER_MultiHashMap
 761                                     *map);
 762
 763
 764 /**
 765  * @ingroup hashmap
 766  * Iterate over all entries in the map.
 767  *
 768  * @param map the map
 769  * @param it function to call on each entry
 770  * @param it_cls extra argument to @a it
 771  * @return the number of key value pairs processed,
 772  *         #GNUNET_SYSERR if it aborted iteration
 773  */
 774 int
 775 GNUNET_CONTAINER_multihashmap_iterate (const struct
 776                                        GNUNET_CONTAINER_MultiHashMap *map,
 777                                        GNUNET_CONTAINER_HashMapIterator it,
 778                                        void *it_cls);
 779
 780
 781 /**
 782  * @ingroup hashmap
 783  * Create an iterator for a multihashmap.
 784  * The iterator can be used to retrieve all the elements in the multihashmap
 785  * one by one, without having to handle all elements at once (in contrast to
 786  * #GNUNET_CONTAINER_multihashmap_iterate).  Note that the iterator can not be
 787  * used anymore if elements have been removed from 'map' after the creation of
 788  * the iterator, or 'map' has been destroyed.  Adding elements to 'map' may
 789  * result in skipped or repeated elements.
 790  *
 791  * @param map the map to create an iterator for
 792  * @return an iterator over the given multihashmap @a map
 793  */
 794 struct GNUNET_CONTAINER_MultiHashMapIterator *
 795 GNUNET_CONTAINER_multihashmap_iterator_create (const struct GNUNET_CONTAINER_MultiHashMap *map);
 796
 797
 798 /**
 799  * @ingroup hashmap
 800  * Retrieve the next element from the hash map at the iterator's
 801  * position.  If there are no elements left, #GNUNET_NO is returned,
 802  * and @a key and @a value are not modified.  This operation is only
 803  * allowed if no elements have been removed from the multihashmap
 804  * since the creation of @a iter, and the map has not been destroyed.
 805  * Adding elements may result in repeating or skipping elements.
 806  *
 807  * @param iter the iterator to get the next element from
 808  * @param key pointer to store the key in, can be NULL
 809  * @param value pointer to store the value in, can be NULL
 810  * @return #GNUNET_YES we returned an element,
 811  *         #GNUNET_NO if we are out of elements
 812  */
 813 int
 814 GNUNET_CONTAINER_multihashmap_iterator_next (struct GNUNET_CONTAINER_MultiHashMapIterator *iter,
 815                                              struct GNUNET_HashCode *key,
 816                                              const void **value);
 817
 818
 819 /**
 820  * @ingroup hashmap
 821  * Destroy a multihashmap iterator.
 822  *
 823  * @param iter the iterator to destroy
 824  */
 825 void
 826 GNUNET_CONTAINER_multihashmap_iterator_destroy (struct GNUNET_CONTAINER_MultiHashMapIterator *iter);
 827
 828
 829 /**
 830  * @ingroup hashmap
 831  * Iterate over all entries in the map that match a particular key.
 832  *
 833  * @param map the map
 834  * @param key key that the entries must correspond to
 835  * @param it function to call on each entry
 836  * @param it_cls extra argument to @a it
 837  * @return the number of key value pairs processed,
 838  *         #GNUNET_SYSERR if it aborted iteration
 839  */
 840 int
 841 GNUNET_CONTAINER_multihashmap_get_multiple (const struct GNUNET_CONTAINER_MultiHashMap *map,
 842                                             const struct GNUNET_HashCode *key,
 843                                             GNUNET_CONTAINER_HashMapIterator it,
 844                                             void *it_cls);
 845
 846
 847 /* ***************** Version of Multihashmap for peer identities ****************** */
 848
 849 /**
 850  * @ingroup hashmap
 851  * Iterator over hash map entries.
 852  *
 853  * @param cls closure
 854  * @param key current public key
 855  * @param value value in the hash map
 856  * @return #GNUNET_YES if we should continue to
 857  *         iterate,
 858  *         #GNUNET_NO if not.
 859  */
 860 typedef int
 861 (*GNUNET_CONTAINER_PeerMapIterator) (void *cls,
 862                                      const struct GNUNET_PeerIdentity *key,
 863                                      void *value);
 864
 865
 866 struct GNUNET_CONTAINER_MultiPeerMap;
 867 /**
 868  * @ingroup hashmap
 869  * Create a multi peer map (hash map for public keys of peers).
 870  *
 871  * @param len initial size (map will grow as needed)
 872  * @param do_not_copy_keys #GNUNET_NO is always safe and should be used by default;
 873  *                         #GNUNET_YES means that on 'put', the 'key' does not have
 874  *                         to be copied as the destination of the pointer is
 875  *                         guaranteed to be life as long as the value is stored in
 876  *                         the hashmap.  This can significantly reduce memory
 877  *                         consumption, but of course is also a recipie for
 878  *                         heap corruption if the assumption is not true.  Only
 879  *                         use this if (1) memory use is important in this case and
 880  *                         (2) you have triple-checked that the invariant holds
 881  * @return NULL on error
 882  */
 883 struct GNUNET_CONTAINER_MultiPeerMap *
 884 GNUNET_CONTAINER_multipeermap_create (unsigned int len,
 885                                       int do_not_copy_keys);
 886
 887
 888 /**
 889  * @ingroup hashmap
 890  * Destroy a hash map.  Will not free any values
 891  * stored in the hash map!
 892  *
 893  * @param map the map
 894  */
 895 void
 896 GNUNET_CONTAINER_multipeermap_destroy (struct GNUNET_CONTAINER_MultiPeerMap *map);
 897
 898
 899 /**
 900  * @ingroup hashmap
 901  * Given a key find a value in the map matching the key.
 902  *
 903  * @param map the map
 904  * @param key what to look for
 905  * @return NULL if no value was found; note that
 906  *   this is indistinguishable from values that just
 907  *   happen to be NULL; use "contains" to test for
 908  *   key-value pairs with value NULL
 909  */
 910 void *
 911 GNUNET_CONTAINER_multipeermap_get (const struct GNUNET_CONTAINER_MultiPeerMap *map,
 912                                    const struct GNUNET_PeerIdentity *key);
 913
 914
 915 /**
 916  * @ingroup hashmap
 917  * Remove the given key-value pair from the map.  Note that if the
 918  * key-value pair is in the map multiple times, only one of the pairs
 919  * will be removed.
 920  *
 921  * @param map the map
 922  * @param key key of the key-value pair
 923  * @param value value of the key-value pair
 924  * @return #GNUNET_YES on success, #GNUNET_NO if the key-value pair
 925  *  is not in the map
 926  */
 927 int
 928 GNUNET_CONTAINER_multipeermap_remove (struct GNUNET_CONTAINER_MultiPeerMap *map,
 929                                       const struct GNUNET_PeerIdentity * key,
 930                                       const void *value);
 931
 932 /**
 933  * @ingroup hashmap
 934  * Remove all entries for the given key from the map.
 935  * Note that the values would not be "freed".
 936  *
 937  * @param map the map
 938  * @param key identifies values to be removed
 939  * @return number of values removed
 940  */
 941 int
 942 GNUNET_CONTAINER_multipeermap_remove_all (struct GNUNET_CONTAINER_MultiPeerMap *map,
 943                                           const struct GNUNET_PeerIdentity *key);
 944
 945
 946 /**
 947  * @ingroup hashmap
 948  * Check if the map contains any value under the given
 949  * key (including values that are NULL).
 950  *
 951  * @param map the map
 952  * @param key the key to test if a value exists for it
 953  * @return #GNUNET_YES if such a value exists,
 954  *         #GNUNET_NO if not
 955  */
 956 int
 957 GNUNET_CONTAINER_multipeermap_contains (const struct GNUNET_CONTAINER_MultiPeerMap *map,
 958                                         const struct GNUNET_PeerIdentity *key);
 959
 960
 961 /**
 962  * @ingroup hashmap
 963  * Check if the map contains the given value under the given
 964  * key.
 965  *
 966  * @param map the map
 967  * @param key the key to test if a value exists for it
 968  * @param value value to test for
 969  * @return #GNUNET_YES if such a value exists,
 970  *         #GNUNET_NO if not
 971  */
 972 int
 973 GNUNET_CONTAINER_multipeermap_contains_value (const struct GNUNET_CONTAINER_MultiPeerMap *map,
 974                                               const struct GNUNET_PeerIdentity * key,
 975                                               const void *value);
 976
 977
 978 /**
 979  * @ingroup hashmap
 980  * Store a key-value pair in the map.
 981  *
 982  * @param map the map
 983  * @param key key to use
 984  * @param value value to use
 985  * @param opt options for put
 986  * @return #GNUNET_OK on success,
 987  *         #GNUNET_NO if a value was replaced (with REPLACE)
 988  *         #GNUNET_SYSERR if #GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY was the option and the
 989  *                       value already exists
 990  */
 991 int
 992 GNUNET_CONTAINER_multipeermap_put (struct GNUNET_CONTAINER_MultiPeerMap *map,
 993                                    const struct GNUNET_PeerIdentity *key,
 994                                    void *value,
 995                                    enum GNUNET_CONTAINER_MultiHashMapOption opt);
 996
 997
 998 /**
 999  * @ingroup hashmap
1000  * Get the number of key-value pairs in the map.
1001  *
1002  * @param map the map
1003  * @return the number of key value pairs
1004  */
1005 unsigned int
1006 GNUNET_CONTAINER_multipeermap_size (const struct GNUNET_CONTAINER_MultiPeerMap *map);
1007
1008
1009 /**
1010  * @ingroup hashmap
1011  * Iterate over all entries in the map.
1012  *
1013  * @param map the map
1014  * @param it function to call on each entry
1015  * @param it_cls extra argument to @a it
1016  * @return the number of key value pairs processed,
1017  *         #GNUNET_SYSERR if it aborted iteration
1018  */
1019 int
1020 GNUNET_CONTAINER_multipeermap_iterate (const struct GNUNET_CONTAINER_MultiPeerMap *map,
1021                                        GNUNET_CONTAINER_PeerMapIterator it,
1022                                        void *it_cls);
1023
1024
1025 struct GNUNET_CONTAINER_MultiPeerMapIterator;
1026 /**
1027  * @ingroup hashmap
1028  * Create an iterator for a multihashmap.
1029  * The iterator can be used to retrieve all the elements in the multihashmap
1030  * one by one, without having to handle all elements at once (in contrast to
1031  * #GNUNET_CONTAINER_multipeermap_iterate).  Note that the iterator can not be
1032  * used anymore if elements have been removed from @a map after the creation of
1033  * the iterator, or 'map' has been destroyed.  Adding elements to @a map may
1034  * result in skipped or repeated elements.
1035  *
1036  * @param map the map to create an iterator for
1037  * @return an iterator over the given multihashmap @a map
1038  */
1039 struct GNUNET_CONTAINER_MultiPeerMapIterator *
1040 GNUNET_CONTAINER_multipeermap_iterator_create (const struct GNUNET_CONTAINER_MultiPeerMap *map);
1041
1042
1043 /**
1044  * @ingroup hashmap
1045  * Retrieve the next element from the hash map at the iterator's
1046  * position.  If there are no elements left, #GNUNET_NO is returned,
1047  * and @a key and @a value are not modified.  This operation is only
1048  * allowed if no elements have been removed from the multihashmap
1049  * since the creation of @a iter, and the map has not been destroyed.
1050  * Adding elements may result in repeating or skipping elements.
1051  *
1052  * @param iter the iterator to get the next element from
1053  * @param key pointer to store the key in, can be NULL
1054  * @param value pointer to store the value in, can be NULL
1055  * @return #GNUNET_YES we returned an element,
1056  *         #GNUNET_NO if we are out of elements
1057  */
1058 int
1059 GNUNET_CONTAINER_multipeermap_iterator_next (struct GNUNET_CONTAINER_MultiPeerMapIterator *iter,
1060                                              struct GNUNET_PeerIdentity *key,
1061                                              const void **value);
1062
1063
1064 /**
1065  * @ingroup hashmap
1066  * Destroy a multipeermap iterator.
1067  *
1068  * @param iter the iterator to destroy
1069  */
1070 void
1071 GNUNET_CONTAINER_multipeermap_iterator_destroy (struct GNUNET_CONTAINER_MultiPeerMapIterator *iter);
1072
1073
1074 /**
1075  * @ingroup hashmap
1076  * Iterate over all entries in the map that match a particular key.
1077  *
1078  * @param map the map
1079  * @param key public key that the entries must correspond to
1080  * @param it function to call on each entry
1081  * @param it_cls extra argument to @a it
1082  * @return the number of key value pairs processed,
1083  *         #GNUNET_SYSERR if it aborted iteration
1084  */
1085 int
1086 GNUNET_CONTAINER_multipeermap_get_multiple (const struct GNUNET_CONTAINER_MultiPeerMap *map,
1087                                             const struct GNUNET_PeerIdentity *key,
1088                                             GNUNET_CONTAINER_PeerMapIterator it,
1089                                             void *it_cls);
1090
1091
1092
1093 /* Version of multihashmap with 32 bit keys */
1094
1095 /**
1096  * @ingroup hashmap
1097  * Opaque handle for the 32-bit key HashMap.
1098  */
1099 struct GNUNET_CONTAINER_MultiHashMap32;
1100
1101
1102 /**
1103  * @ingroup hashmap
1104  * Opaque handle to an iterator over
1105  * a 32-bit key multihashmap.
1106  */
1107 struct GNUNET_CONTAINER_MultiHashMap32Iterator;
1108
1109
1110 /**
1111  * @ingroup hashmap
1112  * Iterator over hash map entries.
1113  *
1114  * @param cls closure
1115  * @param key current key code
1116  * @param value value in the hash map
1117  * @return #GNUNET_YES if we should continue to
1118  *         iterate,
1119  *         #GNUNET_NO if not.
1120  */
1121 typedef int (*GNUNET_CONTAINER_HashMapIterator32) (void *cls,
1122                                                    uint32_t key,
1123                                                    void *value);
1124
1125
1126 /**
1127  * @ingroup hashmap
1128  * Create a 32-bit key multi hash map.
1129  *
1130  * @param len initial size (map will grow as needed)
1131  * @return NULL on error
1132  */
1133 struct GNUNET_CONTAINER_MultiHashMap32 *
1134 GNUNET_CONTAINER_multihashmap32_create (unsigned int len);
1135
1136
1137 /**
1138  * @ingroup hashmap
1139  * Destroy a 32-bit key hash map.  Will not free any values
1140  * stored in the hash map!
1141  *
1142  * @param map the map
1143  */
1144 void
1145 GNUNET_CONTAINER_multihashmap32_destroy (struct GNUNET_CONTAINER_MultiHashMap32
1146                                          *map);
1147
1148
1149 /**
1150  * @ingroup hashmap
1151  * Get the number of key-value pairs in the map.
1152  *
1153  * @param map the map
1154  * @return the number of key value pairs
1155  */
1156 unsigned int
1157 GNUNET_CONTAINER_multihashmap32_size (const struct
1158                                       GNUNET_CONTAINER_MultiHashMap32 *map);
1159
1160
1161 /**
1162  * @ingroup hashmap
1163  * Given a key find a value in the map matching the key.
1164  *
1165  * @param map the map
1166  * @param key what to look for
1167  * @return NULL if no value was found; note that
1168  *   this is indistinguishable from values that just
1169  *   happen to be NULL; use "contains" to test for
1170  *   key-value pairs with value NULL
1171  */
1172 void *
1173 GNUNET_CONTAINER_multihashmap32_get (const struct
1174                                      GNUNET_CONTAINER_MultiHashMap32 *map,
1175                                      uint32_t key);
1176
1177
1178 /**
1179  * @ingroup hashmap
1180  * Iterate over all entries in the map.
1181  *
1182  * @param map the map
1183  * @param it function to call on each entry
1184  * @param it_cls extra argument to @a it
1185  * @return the number of key value pairs processed,
1186  *         #GNUNET_SYSERR if it aborted iteration
1187  */
1188 int
1189 GNUNET_CONTAINER_multihashmap32_iterate (const struct
1190                                          GNUNET_CONTAINER_MultiHashMap32 *map,
1191                                          GNUNET_CONTAINER_HashMapIterator32 it,
1192                                          void *it_cls);
1193
1194
1195 /**
1196  * @ingroup hashmap
1197  * Remove the given key-value pair from the map.  Note that if the
1198  * key-value pair is in the map multiple times, only one of the pairs
1199  * will be removed.
1200  *
1201  * @param map the map
1202  * @param key key of the key-value pair
1203  * @param value value of the key-value pair
1204  * @return #GNUNET_YES on success, #GNUNET_NO if the key-value pair
1205  *  is not in the map
1206  */
1207 int
1208 GNUNET_CONTAINER_multihashmap32_remove (struct GNUNET_CONTAINER_MultiHashMap32 *map,
1209                                         uint32_t key,
1210                                         const void *value);
1211
1212
1213 /**
1214  * @ingroup hashmap
1215  * Remove all entries for the given key from the map.
1216  * Note that the values would not be "freed".
1217  *
1218  * @param map the map
1219  * @param key identifies values to be removed
1220  * @return number of values removed
1221  */
1222 int
1223 GNUNET_CONTAINER_multihashmap32_remove_all (struct GNUNET_CONTAINER_MultiHashMap32 *map,
1224                                             uint32_t key);
1225
1226
1227 /**
1228  * @ingroup hashmap
1229  * Check if the map contains any value under the given
1230  * key (including values that are NULL).
1231  *
1232  * @param map the map
1233  * @param key the key to test if a value exists for it
1234  * @return #GNUNET_YES if such a value exists,
1235  *         #GNUNET_NO if not
1236  */
1237 int
1238 GNUNET_CONTAINER_multihashmap32_contains (const struct GNUNET_CONTAINER_MultiHashMap32 *map,
1239                                           uint32_t key);
1240
1241
1242 /**
1243  * @ingroup hashmap
1244  * Check if the map contains the given value under the given
1245  * key.
1246  *
1247  * @param map the map
1248  * @param key the key to test if a value exists for it
1249  * @param value value to test for
1250  * @return #GNUNET_YES if such a value exists,
1251  *         #GNUNET_NO if not
1252  */
1253 int
1254 GNUNET_CONTAINER_multihashmap32_contains_value (const struct GNUNET_CONTAINER_MultiHashMap32 *map,
1255                                                 uint32_t key,
1256                                                 const void *value);
1257
1258
1259 /**
1260  * @ingroup hashmap
1261  * Store a key-value pair in the map.
1262  *
1263  * @param map the map
1264  * @param key key to use
1265  * @param value value to use
1266  * @param opt options for put
1267  * @return #GNUNET_OK on success,
1268  *         #GNUNET_NO if a value was replaced (with REPLACE)
1269  *         #GNUNET_SYSERR if #GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY was the option and the
1270  *                       value already exists
1271  */
1272 int
1273 GNUNET_CONTAINER_multihashmap32_put (struct GNUNET_CONTAINER_MultiHashMap32 *map,
1274                                      uint32_t key,
1275                                      void *value,
1276                                      enum GNUNET_CONTAINER_MultiHashMapOption opt);
1277
1278
1279 /**
1280  * @ingroup hashmap
1281  * Iterate over all entries in the map that match a particular key.
1282  *
1283  * @param map the map
1284  * @param key key that the entries must correspond to
1285  * @param it function to call on each entry
1286  * @param it_cls extra argument to @a it
1287  * @return the number of key value pairs processed,
1288  *         #GNUNET_SYSERR if it aborted iteration
1289  */
1290 int
1291 GNUNET_CONTAINER_multihashmap32_get_multiple (const struct GNUNET_CONTAINER_MultiHashMap32 *map,
1292                                               uint32_t key,
1293                                               GNUNET_CONTAINER_HashMapIterator32 it,
1294                                               void *it_cls);
1295
1296
1297 /**
1298  * Create an iterator for a 32-bit multihashmap.
1299  * The iterator can be used to retrieve all the elements in the multihashmap
1300  * one by one, without having to handle all elements at once (in contrast to
1301  * #GNUNET_CONTAINER_multihashmap32_iterate).  Note that the iterator can not be
1302  * used anymore if elements have been removed from 'map' after the creation of
1303  * the iterator, or 'map' has been destroyed.  Adding elements to 'map' may
1304  * result in skipped or repeated elements.
1305  *
1306  * @param map the map to create an iterator for
1307  * @return an iterator over the given multihashmap map
1308  */
1309 struct GNUNET_CONTAINER_MultiHashMap32Iterator *
1310 GNUNET_CONTAINER_multihashmap32_iterator_create (const struct GNUNET_CONTAINER_MultiHashMap32 *map);
1311
1312
1313 /**
1314  * Retrieve the next element from the hash map at the iterator's position.
1315  * If there are no elements left, GNUNET_NO is returned, and 'key' and 'value'
1316  * are not modified.
1317  * This operation is only allowed if no elements have been removed from the
1318  * multihashmap since the creation of 'iter', and the map has not been destroyed.
1319  * Adding elements may result in repeating or skipping elements.
1320  *
1321  * @param iter the iterator to get the next element from
1322  * @param key pointer to store the key in, can be NULL
1323  * @param value pointer to store the value in, can be NULL
1324  * @return #GNUNET_YES we returned an element,
1325  *         #GNUNET_NO if we are out of elements
1326  */
1327 int
1328 GNUNET_CONTAINER_multihashmap32_iterator_next (struct GNUNET_CONTAINER_MultiHashMap32Iterator *iter,
1329                                                uint32_t *key,
1330                                                const void **value);
1331
1332
1333 /**
1334  * Destroy a 32-bit multihashmap iterator.
1335  *
1336  * @param iter the iterator to destroy
1337  */
1338 void
1339 GNUNET_CONTAINER_multihashmap32_iterator_destroy (struct GNUNET_CONTAINER_MultiHashMapIterator *iter);
1340
1341
1342 /* ******************** doubly-linked list *************** */
1343 /* To avoid mistakes: head->prev == tail->next == NULL     */
1344
1345 /**
1346  * @ingroup dll
1347  * Insert an element at the head of a DLL. Assumes that head, tail and
1348  * element are structs with prev and next fields.
1349  *
1350  * @param head pointer to the head of the DLL
1351  * @param tail pointer to the tail of the DLL
1352  * @param element element to insert
1353  */
1354 #define GNUNET_CONTAINER_DLL_insert(head,tail,element) do { \
1355   GNUNET_assert ( ( (element)->prev == NULL) && ((head) != (element))); \
1356   GNUNET_assert ( ( (element)->next == NULL) && ((tail) != (element))); \
1357   (element)->next = (head); \
1358   (element)->prev = NULL; \
1359   if ((tail) == NULL) \
1360     (tail) = element; \
1361   else \
1362     (head)->prev = element; \
1363   (head) = (element); } while (0)
1364
1365
1366 /**
1367  * @ingroup dll
1368  * Insert an element at the tail of a DLL. Assumes that head, tail and
1369  * element are structs with prev and next fields.
1370  *
1371  * @param head pointer to the head of the DLL
1372  * @param tail pointer to the tail of the DLL
1373  * @param element element to insert
1374  */
1375 #define GNUNET_CONTAINER_DLL_insert_tail(head,tail,element) do { \
1376   GNUNET_assert ( ( (element)->prev == NULL) && ((head) != (element))); \
1377   GNUNET_assert ( ( (element)->next == NULL) && ((tail) != (element))); \
1378   (element)->prev = (tail); \
1379   (element)->next = NULL; \
1380   if ((head) == NULL) \
1381     (head) = element; \
1382   else \
1383     (tail)->next = element; \
1384   (tail) = (element); } while (0)
1385
1386
1387 /**
1388  * @ingroup dll
1389  * Insert an element into a DLL after the given other element.  Insert
1390  * at the head if the other element is NULL.
1391  *
1392  * @param head pointer to the head of the DLL
1393  * @param tail pointer to the tail of the DLL
1394  * @param other prior element, NULL for insertion at head of DLL
1395  * @param element element to insert
1396  */
1397 #define GNUNET_CONTAINER_DLL_insert_after(head,tail,other,element) do { \
1398   GNUNET_assert ( ( (element)->prev == NULL) && ((head) != (element))); \
1399   GNUNET_assert ( ( (element)->next == NULL) && ((tail) != (element))); \
1400   (element)->prev = (other); \
1401   if (NULL == other) \
1402     { \
1403       (element)->next = (head); \
1404       (head) = (element); \
1405     } \
1406   else \
1407     { \
1408       (element)->next = (other)->next; \
1409       (other)->next = (element); \
1410     } \
1411   if (NULL == (element)->next) \
1412     (tail) = (element); \
1413   else \
1414     (element)->next->prev = (element); } while (0)
1415
1416
1417 /**
1418  * @ingroup dll
1419  * Insert an element into a DLL before the given other element.  Insert
1420  * at the tail if the other element is NULL.
1421  *
1422  * @param head pointer to the head of the DLL
1423  * @param tail pointer to the tail of the DLL
1424  * @param other prior element, NULL for insertion at head of DLL
1425  * @param element element to insert
1426  */
1427 #define GNUNET_CONTAINER_DLL_insert_before(head,tail,other,element) do { \
1428   GNUNET_assert ( ( (element)->prev == NULL) && ((head) != (element))); \
1429   GNUNET_assert ( ( (element)->next == NULL) && ((tail) != (element))); \
1430   (element)->next = (other); \
1431   if (NULL == other) \
1432     { \
1433       (element)->prev = (tail); \
1434       (tail) = (element); \
1435     } \
1436   else \
1437     { \
1438       (element)->prev = (other)->prev; \
1439       (other)->prev = (element); \
1440     } \
1441   if (NULL == (element)->prev) \
1442     (head) = (element); \
1443   else \
1444     (element)->prev->next = (element); } while (0)
1445
1446
1447 /**
1448  * @ingroup dll
1449  * Remove an element from a DLL. Assumes that head, tail and
1450  * element point to structs with prev and next fields.
1451  *
1452  * Using the head or tail pointer as the element
1453  * argument does NOT work with this macro.
1454  * Make sure to store head/tail in another pointer
1455  * and use it to remove the head or tail of the list.
1456  *
1457  * @param head pointer to the head of the DLL
1458  * @param tail pointer to the tail of the DLL
1459  * @param element element to remove
1460  */
1461 #define GNUNET_CONTAINER_DLL_remove(head,tail,element) do { \
1462   GNUNET_assert ( ( (element)->prev != NULL) || ((head) == (element))); \
1463   GNUNET_assert ( ( (element)->next != NULL) || ((tail) == (element))); \
1464   if ((element)->prev == NULL) \
1465     (head) = (element)->next;  \
1466   else \
1467     (element)->prev->next = (element)->next; \
1468   if ((element)->next == NULL) \
1469     (tail) = (element)->prev;  \
1470   else \
1471     (element)->next->prev = (element)->prev; \
1472   (element)->next = NULL; \
1473   (element)->prev = NULL; } while (0)
1474
1475
1476 /* ************ Multi-DLL interface, allows DLL elements to be
1477    in multiple lists at the same time *********************** */
1478
1479 /**
1480  * @ingroup dll
1481  * Insert an element at the head of a MDLL. Assumes that head, tail and
1482  * element are structs with prev and next fields.
1483  *
1484  * @param mdll suffix name for the next and prev pointers in the element
1485  * @param head pointer to the head of the MDLL
1486  * @param tail pointer to the tail of the MDLL
1487  * @param element element to insert
1488  */
1489 #define GNUNET_CONTAINER_MDLL_insert(mdll,head,tail,element) do {       \
1490   GNUNET_assert ( ( (element)->prev_##mdll == NULL) && ((head) != (element))); \
1491   GNUNET_assert ( ( (element)->next_##mdll == NULL) && ((tail) != (element))); \
1492   (element)->next_##mdll = (head); \
1493   (element)->prev_##mdll = NULL; \
1494   if ((tail) == NULL) \
1495     (tail) = element; \
1496   else \
1497     (head)->prev_##mdll = element; \
1498   (head) = (element); } while (0)
1499
1500
1501 /**
1502  * @ingroup dll
1503  * Insert an element at the tail of a MDLL. Assumes that head, tail and
1504  * element are structs with prev and next fields.
1505  *
1506  * @param mdll suffix name for the next and prev pointers in the element
1507  * @param head pointer to the head of the MDLL
1508  * @param tail pointer to the tail of the MDLL
1509  * @param element element to insert
1510  */
1511 #define GNUNET_CONTAINER_MDLL_insert_tail(mdll,head,tail,element) do {  \
1512   GNUNET_assert ( ( (element)->prev_##mdll == NULL) && ((head) != (element))); \
1513   GNUNET_assert ( ( (element)->next_##mdll == NULL) && ((tail) != (element))); \
1514   (element)->prev_##mdll = (tail); \
1515   (element)->next_##mdll = NULL; \
1516   if ((head) == NULL) \
1517     (head) = element; \
1518   else \
1519     (tail)->next_##mdll = element; \
1520   (tail) = (element); } while (0)
1521
1522
1523 /**
1524  * @ingroup dll
1525  * Insert an element into a MDLL after the given other element.  Insert
1526  * at the head if the other element is NULL.
1527  *
1528  * @param mdll suffix name for the next and prev pointers in the element
1529  * @param head pointer to the head of the MDLL
1530  * @param tail pointer to the tail of the MDLL
1531  * @param other prior element, NULL for insertion at head of MDLL
1532  * @param element element to insert
1533  */
1534 #define GNUNET_CONTAINER_MDLL_insert_after(mdll,head,tail,other,element) do { \
1535   GNUNET_assert ( ( (element)->prev_##mdll == NULL) && ((head) != (element))); \
1536   GNUNET_assert ( ( (element)->next_##mdll == NULL) && ((tail) != (element))); \
1537   (element)->prev_##mdll = (other); \
1538   if (NULL == other) \
1539     { \
1540       (element)->next_##mdll = (head); \
1541       (head) = (element); \
1542     } \
1543   else \
1544     { \
1545       (element)->next_##mdll = (other)->next_##mdll; \
1546       (other)->next_##mdll = (element); \
1547     } \
1548   if (NULL == (element)->next_##mdll) \
1549     (tail) = (element); \
1550   else \
1551     (element)->next->prev_##mdll = (element); } while (0)
1552
1553
1554 /**
1555  * @ingroup dll
1556  * Insert an element into a MDLL before the given other element.  Insert
1557  * at the tail if the other element is NULL.
1558  *
1559  * @param mdll suffix name for the next and prev pointers in the element
1560  * @param head pointer to the head of the MDLL
1561  * @param tail pointer to the tail of the MDLL
1562  * @param other prior element, NULL for insertion at head of MDLL
1563  * @param element element to insert
1564  */
1565 #define GNUNET_CONTAINER_MDLL_insert_before(mdll,head,tail,other,element) do { \
1566   GNUNET_assert ( ( (element)->prev_##mdll == NULL) && ((head) != (element))); \
1567   GNUNET_assert ( ( (element)->next_##mdll == NULL) && ((tail) != (element))); \
1568   (element)->next_##mdll = (other); \
1569   if (NULL == other) \
1570     { \
1571       (element)->prev = (tail); \
1572       (tail) = (element); \
1573     } \
1574   else \
1575     { \
1576       (element)->prev_##mdll = (other)->prev_##mdll; \
1577       (other)->prev_##mdll = (element); \
1578     } \
1579   if (NULL == (element)->prev_##mdll) \
1580     (head) = (element); \
1581   else \
1582     (element)->prev_##mdll->next_##mdll = (element); } while (0)
1583
1584
1585 /**
1586  * @ingroup dll
1587  * Remove an element from a MDLL. Assumes
1588  * that head, tail and element are structs
1589  * with prev and next fields.
1590  *
1591  * @param mdll suffix name for the next and prev pointers in the element
1592  * @param head pointer to the head of the MDLL
1593  * @param tail pointer to the tail of the MDLL
1594  * @param element element to remove
1595  */
1596 #define GNUNET_CONTAINER_MDLL_remove(mdll,head,tail,element) do {       \
1597   GNUNET_assert ( ( (element)->prev_##mdll != NULL) || ((head) == (element))); \
1598   GNUNET_assert ( ( (element)->next_##mdll != NULL) || ((tail) == (element))); \
1599   if ((element)->prev_##mdll == NULL) \
1600     (head) = (element)->next_##mdll;  \
1601   else \
1602     (element)->prev_##mdll->next_##mdll = (element)->next_##mdll; \
1603   if ((element)->next_##mdll == NULL) \
1604     (tail) = (element)->prev_##mdll;  \
1605   else \
1606     (element)->next_##mdll->prev_##mdll = (element)->prev_##mdll; \
1607   (element)->next_##mdll = NULL; \
1608   (element)->prev_##mdll = NULL; } while (0)
1609
1610
1611
1612 /* ******************** Heap *************** */
1613
1614
1615 /**
1616  * @ingroup heap
1617  * Cost by which elements in a heap can be ordered.
1618  */
1619 typedef uint64_t GNUNET_CONTAINER_HeapCostType;
1620
1621
1622 /**
1623  * @ingroup heap
1624  * Heap type, either max or min.
1625  */
1626 enum GNUNET_CONTAINER_HeapOrder
1627 {
1628   /**
1629    * @ingroup heap
1630    * Heap with the maximum cost at the root.
1631    */
1632   GNUNET_CONTAINER_HEAP_ORDER_MAX,
1633
1634   /**
1635    * @ingroup heap
1636    * Heap with the minimum cost at the root.
1637    */
1638   GNUNET_CONTAINER_HEAP_ORDER_MIN
1639 };
1640
1641
1642 /**
1643  * @ingroup heap
1644  * Handle to a Heap.
1645  */
1646 struct GNUNET_CONTAINER_Heap;
1647
1648
1649 /**
1650  * @ingroup heap
1651  * Handle to a node in a heap.
1652  */
1653 struct GNUNET_CONTAINER_HeapNode;
1654
1655
1656 /**
1657  * @ingroup heap
1658  * Create a new heap.
1659  *
1660  * @param order how should the heap be sorted?
1661  * @return handle to the heap
1662  */
1663 struct GNUNET_CONTAINER_Heap *
1664 GNUNET_CONTAINER_heap_create (enum GNUNET_CONTAINER_HeapOrder order);
1665
1666
1667 /**
1668  * @ingroup heap
1669  * Destroys the heap.  Only call on a heap that
1670  * is already empty.
1671  *
1672  * @param heap heap to destroy
1673  */
1674 void
1675 GNUNET_CONTAINER_heap_destroy (struct GNUNET_CONTAINER_Heap *heap);
1676
1677
1678 /**
1679  * @ingroup heap
1680  * Get element stored at the root of @a heap.
1681  *
1682  * @param heap  Heap to inspect.
1683  * @return Element at the root, or NULL if heap is empty.
1684  */
1685 void *
1686 GNUNET_CONTAINER_heap_peek (const struct GNUNET_CONTAINER_Heap *heap);
1687
1688
1689 /**
1690  * Get @a element and @a cost stored at the root of @a heap.
1691  *
1692  * @param[in]  heap     Heap to inspect.
1693  * @param[out] element  Root element is returned here.
1694  * @param[out] cost     Cost of @a element is returned here.
1695  * @return #GNUNET_YES if an element is returned,
1696  *         #GNUNET_NO  if the heap is empty.
1697  */
1698 int
1699 GNUNET_CONTAINER_heap_peek2 (const struct GNUNET_CONTAINER_Heap *heap,
1700                              void **element,
1701                              GNUNET_CONTAINER_HeapCostType *cost);
1702
1703
1704 /**
1705  * @ingroup heap
1706  * Get the current size of the heap
1707  *
1708  * @param heap the heap to get the size of
1709  * @return number of elements stored
1710  */
1711 unsigned int
1712 GNUNET_CONTAINER_heap_get_size (const struct GNUNET_CONTAINER_Heap *heap);
1713
1714
1715 /**
1716  * @ingroup heap
1717  * Get the current cost of the node
1718  *
1719  * @param node the node to get the cost of
1720  * @return cost of the node
1721  */
1722 GNUNET_CONTAINER_HeapCostType
1723 GNUNET_CONTAINER_heap_node_get_cost (const struct GNUNET_CONTAINER_HeapNode
1724                                      *node);
1725
1726 /**
1727  * @ingroup heap
1728  * Iterator for heap
1729  *
1730  * @param cls closure
1731  * @param node internal node of the heap
1732  * @param element value stored at the node
1733  * @param cost cost associated with the node
1734  * @return #GNUNET_YES if we should continue to iterate,
1735  *         #GNUNET_NO if not.
1736  */
1737 typedef int (*GNUNET_CONTAINER_HeapIterator) (void *cls,
1738                                               struct GNUNET_CONTAINER_HeapNode *
1739                                               node, void *element,
1740                                               GNUNET_CONTAINER_HeapCostType
1741                                               cost);
1742
1743
1744 /**
1745  * @ingroup heap
1746  * Iterate over all entries in the heap.
1747  *
1748  * @param heap the heap
1749  * @param iterator function to call on each entry
1750  * @param iterator_cls closure for @a iterator
1751  */
1752 void
1753 GNUNET_CONTAINER_heap_iterate (const struct GNUNET_CONTAINER_Heap *heap,
1754                                GNUNET_CONTAINER_HeapIterator iterator,
1755                                void *iterator_cls);
1756
1757 /**
1758  * @ingroup heap
1759  * Perform a random walk of the tree.  The walk is biased
1760  * towards elements closer to the root of the tree (since
1761  * each walk starts at the root and ends at a random leaf).
1762  * The heap internally tracks the current position of the
1763  * walk.
1764  *
1765  * @param heap heap to walk
1766  * @return data stored at the next random node in the walk;
1767  *         NULL if the tree is empty.
1768  */
1769 void *
1770 GNUNET_CONTAINER_heap_walk_get_next (struct GNUNET_CONTAINER_Heap *heap);
1771
1772
1773 /**
1774  * @ingroup heap
1775  * Inserts a new element into the heap.
1776  *
1777  * @param heap heap to modify
1778  * @param element element to insert
1779  * @param cost cost for the element
1780  * @return node for the new element
1781  */
1782 struct GNUNET_CONTAINER_HeapNode *
1783 GNUNET_CONTAINER_heap_insert (struct GNUNET_CONTAINER_Heap *heap, void *element,
1784                               GNUNET_CONTAINER_HeapCostType cost);
1785
1786
1787 /**
1788  * @ingroup heap
1789  * Remove root of the heap.
1790  *
1791  * @param heap heap to modify
1792  * @return element data stored at the root node
1793  */
1794 void *
1795 GNUNET_CONTAINER_heap_remove_root (struct GNUNET_CONTAINER_Heap *heap);
1796
1797
1798 /**
1799  * @ingroup heap
1800  * Removes a node from the heap.
1801  *
1802  * @param node node to remove
1803  * @return element data stored at the node, NULL if heap is empty
1804  */
1805 void *
1806 GNUNET_CONTAINER_heap_remove_node (struct GNUNET_CONTAINER_HeapNode *node);
1807
1808
1809 /**
1810  * @ingroup heap
1811  * Updates the cost of any node in the tree
1812  *
1813  * @param heap heap to modify
1814  * @param node node for which the cost is to be changed
1815  * @param new_cost new cost for the node
1816  */
1817 void
1818 GNUNET_CONTAINER_heap_update_cost (struct GNUNET_CONTAINER_Heap *heap,
1819                                    struct GNUNET_CONTAINER_HeapNode *node,
1820                                    GNUNET_CONTAINER_HeapCostType new_cost);
1821
1822
1823 #if 0                           /* keep Emacsens' auto-indent happy */
1824 {
1825 #endif
1826 #ifdef __cplusplus
1827 }
1828 #endif
1829
1830
1831 /* ifndef GNUNET_CONTAINER_LIB_H */
1832 #endif
1833 /* end of gnunet_container_lib.h */