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