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 struct GNUNET_CONTAINER_MultiPeerMap;
 860 /**
 861  * @ingroup hashmap
 862  * Create a multi peer map (hash map for public keys of peers).
 863  *
 864  * @param len initial size (map will grow as needed)
 865  * @param do_not_copy_keys #GNUNET_NO is always safe and should be used by default;
 866  *                         #GNUNET_YES means that on 'put', the 'key' does not have
 867  *                         to be copied as the destination of the pointer is
 868  *                         guaranteed to be life as long as the value is stored in
 869  *                         the hashmap.  This can significantly reduce memory
 870  *                         consumption, but of course is also a recipie for
 871  *                         heap corruption if the assumption is not true.  Only
 872  *                         use this if (1) memory use is important in this case and
 873  *                         (2) you have triple-checked that the invariant holds
 874  * @return NULL on error
 875  */
 876 struct GNUNET_CONTAINER_MultiPeerMap *
 877 GNUNET_CONTAINER_multipeermap_create (unsigned int len,
 878                                       int do_not_copy_keys);
 879
 880
 881 /**
 882  * @ingroup hashmap
 883  * Destroy a hash map.  Will not free any values
 884  * stored in the hash map!
 885  *
 886  * @param map the map
 887  */
 888 void
 889 GNUNET_CONTAINER_multipeermap_destroy (struct GNUNET_CONTAINER_MultiPeerMap *map);
 890
 891
 892 /**
 893  * @ingroup hashmap
 894  * Given a key find a value in the map matching the key.
 895  *
 896  * @param map the map
 897  * @param key what to look for
 898  * @return NULL if no value was found; note that
 899  *   this is indistinguishable from values that just
 900  *   happen to be NULL; use "contains" to test for
 901  *   key-value pairs with value NULL
 902  */
 903 void *
 904 GNUNET_CONTAINER_multipeermap_get (const struct GNUNET_CONTAINER_MultiPeerMap *map,
 905                                    const struct GNUNET_PeerIdentity *key);
 906
 907
 908 /**
 909  * @ingroup hashmap
 910  * Remove the given key-value pair from the map.  Note that if the
 911  * key-value pair is in the map multiple times, only one of the pairs
 912  * will be removed.
 913  *
 914  * @param map the map
 915  * @param key key of the key-value pair
 916  * @param value value of the key-value pair
 917  * @return #GNUNET_YES on success, #GNUNET_NO if the key-value pair
 918  *  is not in the map
 919  */
 920 int
 921 GNUNET_CONTAINER_multipeermap_remove (struct GNUNET_CONTAINER_MultiPeerMap *map,
 922                                       const struct GNUNET_PeerIdentity * key,
 923                                       const void *value);
 924
 925 /**
 926  * @ingroup hashmap
 927  * Remove all entries for the given key from the map.
 928  * Note that the values would not be "freed".
 929  *
 930  * @param map the map
 931  * @param key identifies values to be removed
 932  * @return number of values removed
 933  */
 934 int
 935 GNUNET_CONTAINER_multipeermap_remove_all (struct GNUNET_CONTAINER_MultiPeerMap *map,
 936                                           const struct GNUNET_PeerIdentity *key);
 937
 938
 939 /**
 940  * @ingroup hashmap
 941  * Check if the map contains any value under the given
 942  * key (including values that are NULL).
 943  *
 944  * @param map the map
 945  * @param key the key to test if a value exists for it
 946  * @return #GNUNET_YES if such a value exists,
 947  *         #GNUNET_NO if not
 948  */
 949 int
 950 GNUNET_CONTAINER_multipeermap_contains (const struct GNUNET_CONTAINER_MultiPeerMap *map,
 951                                         const struct GNUNET_PeerIdentity *key);
 952
 953
 954 /**
 955  * @ingroup hashmap
 956  * Check if the map contains the given value under the given
 957  * key.
 958  *
 959  * @param map the map
 960  * @param key the key to test if a value exists for it
 961  * @param value value to test for
 962  * @return #GNUNET_YES if such a value exists,
 963  *         #GNUNET_NO if not
 964  */
 965 int
 966 GNUNET_CONTAINER_multipeermap_contains_value (const struct GNUNET_CONTAINER_MultiPeerMap *map,
 967                                               const struct GNUNET_PeerIdentity * key,
 968                                               const void *value);
 969
 970
 971 /**
 972  * @ingroup hashmap
 973  * Store a key-value pair in the map.
 974  *
 975  * @param map the map
 976  * @param key key to use
 977  * @param value value to use
 978  * @param opt options for put
 979  * @return #GNUNET_OK on success,
 980  *         #GNUNET_NO if a value was replaced (with REPLACE)
 981  *         #GNUNET_SYSERR if #GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY was the option and the
 982  *                       value already exists
 983  */
 984 int
 985 GNUNET_CONTAINER_multipeermap_put (struct GNUNET_CONTAINER_MultiPeerMap *map,
 986                                    const struct GNUNET_PeerIdentity *key,
 987                                    void *value,
 988                                    enum GNUNET_CONTAINER_MultiHashMapOption opt);
 989
 990
 991 /**
 992  * @ingroup hashmap
 993  * Get the number of key-value pairs in the map.
 994  *
 995  * @param map the map
 996  * @return the number of key value pairs
 997  */
 998 unsigned int
 999 GNUNET_CONTAINER_multipeermap_size (const struct GNUNET_CONTAINER_MultiPeerMap *map);
1000
1001
1002 /**
1003  * @ingroup hashmap
1004  * Iterate over all entries in the map.
1005  *
1006  * @param map the map
1007  * @param it function to call on each entry
1008  * @param it_cls extra argument to @a it
1009  * @return the number of key value pairs processed,
1010  *         #GNUNET_SYSERR if it aborted iteration
1011  */
1012 int
1013 GNUNET_CONTAINER_multipeermap_iterate (const struct GNUNET_CONTAINER_MultiPeerMap *map,
1014                                        GNUNET_CONTAINER_PeerMapIterator it,
1015                                        void *it_cls);
1016
1017
1018 struct GNUNET_CONTAINER_MultiPeerMapIterator;
1019 /**
1020  * @ingroup hashmap
1021  * Create an iterator for a multihashmap.
1022  * The iterator can be used to retrieve all the elements in the multihashmap
1023  * one by one, without having to handle all elements at once (in contrast to
1024  * #GNUNET_CONTAINER_multipeermap_iterate).  Note that the iterator can not be
1025  * used anymore if elements have been removed from @a map after the creation of
1026  * the iterator, or 'map' has been destroyed.  Adding elements to @a map may
1027  * result in skipped or repeated elements.
1028  *
1029  * @param map the map to create an iterator for
1030  * @return an iterator over the given multihashmap @a map
1031  */
1032 struct GNUNET_CONTAINER_MultiPeerMapIterator *
1033 GNUNET_CONTAINER_multipeermap_iterator_create (const struct GNUNET_CONTAINER_MultiPeerMap *map);
1034
1035
1036 /**
1037  * @ingroup hashmap
1038  * Retrieve the next element from the hash map at the iterator's
1039  * position.  If there are no elements left, #GNUNET_NO is returned,
1040  * and @a key and @a value are not modified.  This operation is only
1041  * allowed if no elements have been removed from the multihashmap
1042  * since the creation of @a iter, and the map has not been destroyed.
1043  * Adding elements may result in repeating or skipping elements.
1044  *
1045  * @param iter the iterator to get the next element from
1046  * @param key pointer to store the key in, can be NULL
1047  * @param value pointer to store the value in, can be NULL
1048  * @return #GNUNET_YES we returned an element,
1049  *         #GNUNET_NO if we are out of elements
1050  */
1051 int
1052 GNUNET_CONTAINER_multipeermap_iterator_next (struct GNUNET_CONTAINER_MultiPeerMapIterator *iter,
1053                                              struct GNUNET_PeerIdentity *key,
1054                                              const void **value);
1055
1056
1057 /**
1058  * @ingroup hashmap
1059  * Destroy a multipeermap iterator.
1060  *
1061  * @param iter the iterator to destroy
1062  */
1063 void
1064 GNUNET_CONTAINER_multipeermap_iterator_destroy (struct GNUNET_CONTAINER_MultiPeerMapIterator *iter);
1065
1066
1067 /**
1068  * @ingroup hashmap
1069  * Iterate over all entries in the map that match a particular key.
1070  *
1071  * @param map the map
1072  * @param key public key that the entries must correspond to
1073  * @param it function to call on each entry
1074  * @param it_cls extra argument to @a it
1075  * @return the number of key value pairs processed,
1076  *         #GNUNET_SYSERR if it aborted iteration
1077  */
1078 int
1079 GNUNET_CONTAINER_multipeermap_get_multiple (const struct GNUNET_CONTAINER_MultiPeerMap *map,
1080                                             const struct GNUNET_PeerIdentity *key,
1081                                             GNUNET_CONTAINER_PeerMapIterator it,
1082                                             void *it_cls);
1083
1084
1085
1086 /* Version of multihashmap with 32 bit keys */
1087
1088 /**
1089  * @ingroup hashmap
1090  * Opaque handle for the 32-bit key HashMap.
1091  */
1092 struct GNUNET_CONTAINER_MultiHashMap32;
1093
1094
1095 /**
1096  * @ingroup hashmap
1097  * Opaque handle to an iterator over
1098  * a 32-bit key multihashmap.
1099  */
1100 struct GNUNET_CONTAINER_MultiHashMap32Iterator;
1101
1102
1103 /**
1104  * @ingroup hashmap
1105  * Iterator over hash map entries.
1106  *
1107  * @param cls closure
1108  * @param key current key code
1109  * @param value value in the hash map
1110  * @return #GNUNET_YES if we should continue to
1111  *         iterate,
1112  *         #GNUNET_NO if not.
1113  */
1114 typedef int (*GNUNET_CONTAINER_HashMapIterator32) (void *cls,
1115                                                    uint32_t key,
1116                                                    void *value);
1117
1118
1119 /**
1120  * @ingroup hashmap
1121  * Create a 32-bit key multi hash map.
1122  *
1123  * @param len initial size (map will grow as needed)
1124  * @return NULL on error
1125  */
1126 struct GNUNET_CONTAINER_MultiHashMap32 *
1127 GNUNET_CONTAINER_multihashmap32_create (unsigned int len);
1128
1129
1130 /**
1131  * @ingroup hashmap
1132  * Destroy a 32-bit key hash map.  Will not free any values
1133  * stored in the hash map!
1134  *
1135  * @param map the map
1136  */
1137 void
1138 GNUNET_CONTAINER_multihashmap32_destroy (struct GNUNET_CONTAINER_MultiHashMap32
1139                                          *map);
1140
1141
1142 /**
1143  * @ingroup hashmap
1144  * Get the number of key-value pairs in the map.
1145  *
1146  * @param map the map
1147  * @return the number of key value pairs
1148  */
1149 unsigned int
1150 GNUNET_CONTAINER_multihashmap32_size (const struct
1151                                       GNUNET_CONTAINER_MultiHashMap32 *map);
1152
1153
1154 /**
1155  * @ingroup hashmap
1156  * Given a key find a value in the map matching the key.
1157  *
1158  * @param map the map
1159  * @param key what to look for
1160  * @return NULL if no value was found; note that
1161  *   this is indistinguishable from values that just
1162  *   happen to be NULL; use "contains" to test for
1163  *   key-value pairs with value NULL
1164  */
1165 void *
1166 GNUNET_CONTAINER_multihashmap32_get (const struct
1167                                      GNUNET_CONTAINER_MultiHashMap32 *map,
1168                                      uint32_t key);
1169
1170
1171 /**
1172  * @ingroup hashmap
1173  * Iterate over all entries in the map.
1174  *
1175  * @param map the map
1176  * @param it function to call on each entry
1177  * @param it_cls extra argument to @a it
1178  * @return the number of key value pairs processed,
1179  *         #GNUNET_SYSERR if it aborted iteration
1180  */
1181 int
1182 GNUNET_CONTAINER_multihashmap32_iterate (const struct
1183                                          GNUNET_CONTAINER_MultiHashMap32 *map,
1184                                          GNUNET_CONTAINER_HashMapIterator32 it,
1185                                          void *it_cls);
1186
1187
1188 /**
1189  * @ingroup hashmap
1190  * Remove the given key-value pair from the map.  Note that if the
1191  * key-value pair is in the map multiple times, only one of the pairs
1192  * will be removed.
1193  *
1194  * @param map the map
1195  * @param key key of the key-value pair
1196  * @param value value of the key-value pair
1197  * @return #GNUNET_YES on success, #GNUNET_NO if the key-value pair
1198  *  is not in the map
1199  */
1200 int
1201 GNUNET_CONTAINER_multihashmap32_remove (struct GNUNET_CONTAINER_MultiHashMap32 *map,
1202                                         uint32_t key,
1203                                         const void *value);
1204
1205
1206 /**
1207  * @ingroup hashmap
1208  * Remove all entries for the given key from the map.
1209  * Note that the values would not be "freed".
1210  *
1211  * @param map the map
1212  * @param key identifies values to be removed
1213  * @return number of values removed
1214  */
1215 int
1216 GNUNET_CONTAINER_multihashmap32_remove_all (struct GNUNET_CONTAINER_MultiHashMap32 *map,
1217                                             uint32_t key);
1218
1219
1220 /**
1221  * @ingroup hashmap
1222  * Check if the map contains any value under the given
1223  * key (including values that are NULL).
1224  *
1225  * @param map the map
1226  * @param key the key to test if a value exists for it
1227  * @return #GNUNET_YES if such a value exists,
1228  *         #GNUNET_NO if not
1229  */
1230 int
1231 GNUNET_CONTAINER_multihashmap32_contains (const struct GNUNET_CONTAINER_MultiHashMap32 *map,
1232                                           uint32_t key);
1233
1234
1235 /**
1236  * @ingroup hashmap
1237  * Check if the map contains the given value under the given
1238  * key.
1239  *
1240  * @param map the map
1241  * @param key the key to test if a value exists for it
1242  * @param value value to test for
1243  * @return #GNUNET_YES if such a value exists,
1244  *         #GNUNET_NO if not
1245  */
1246 int
1247 GNUNET_CONTAINER_multihashmap32_contains_value (const struct GNUNET_CONTAINER_MultiHashMap32 *map,
1248                                                 uint32_t key,
1249                                                 const void *value);
1250
1251
1252 /**
1253  * @ingroup hashmap
1254  * Store a key-value pair in the map.
1255  *
1256  * @param map the map
1257  * @param key key to use
1258  * @param value value to use
1259  * @param opt options for put
1260  * @return #GNUNET_OK on success,
1261  *         #GNUNET_NO if a value was replaced (with REPLACE)
1262  *         #GNUNET_SYSERR if #GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY was the option and the
1263  *                       value already exists
1264  */
1265 int
1266 GNUNET_CONTAINER_multihashmap32_put (struct GNUNET_CONTAINER_MultiHashMap32 *map,
1267                                      uint32_t key,
1268                                      void *value,
1269                                      enum GNUNET_CONTAINER_MultiHashMapOption opt);
1270
1271
1272 /**
1273  * @ingroup hashmap
1274  * Iterate over all entries in the map that match a particular key.
1275  *
1276  * @param map the map
1277  * @param key key that the entries must correspond to
1278  * @param it function to call on each entry
1279  * @param it_cls extra argument to @a it
1280  * @return the number of key value pairs processed,
1281  *         #GNUNET_SYSERR if it aborted iteration
1282  */
1283 int
1284 GNUNET_CONTAINER_multihashmap32_get_multiple (const struct GNUNET_CONTAINER_MultiHashMap32 *map,
1285                                               uint32_t key,
1286                                               GNUNET_CONTAINER_HashMapIterator32 it,
1287                                               void *it_cls);
1288
1289
1290 /**
1291  * Create an iterator for a 32-bit multihashmap.
1292  * The iterator can be used to retrieve all the elements in the multihashmap
1293  * one by one, without having to handle all elements at once (in contrast to
1294  * #GNUNET_CONTAINER_multihashmap32_iterate).  Note that the iterator can not be
1295  * used anymore if elements have been removed from 'map' after the creation of
1296  * the iterator, or 'map' has been destroyed.  Adding elements to 'map' may
1297  * result in skipped or repeated elements.
1298  *
1299  * @param map the map to create an iterator for
1300  * @return an iterator over the given multihashmap map
1301  */
1302 struct GNUNET_CONTAINER_MultiHashMap32Iterator *
1303 GNUNET_CONTAINER_multihashmap32_iterator_create (const struct GNUNET_CONTAINER_MultiHashMap32 *map);
1304
1305
1306 /**
1307  * Retrieve the next element from the hash map at the iterator's position.
1308  * If there are no elements left, GNUNET_NO is returned, and 'key' and 'value'
1309  * are not modified.
1310  * This operation is only allowed if no elements have been removed from the
1311  * multihashmap since the creation of 'iter', and the map has not been destroyed.
1312  * Adding elements may result in repeating or skipping elements.
1313  *
1314  * @param iter the iterator to get the next element from
1315  * @param key pointer to store the key in, can be NULL
1316  * @param value pointer to store the value in, can be NULL
1317  * @return #GNUNET_YES we returned an element,
1318  *         #GNUNET_NO if we are out of elements
1319  */
1320 int
1321 GNUNET_CONTAINER_multihashmap32_iterator_next (struct GNUNET_CONTAINER_MultiHashMap32Iterator *iter,
1322                                                uint32_t *key,
1323                                                const void **value);
1324
1325
1326 /**
1327  * Destroy a 32-bit multihashmap iterator.
1328  *
1329  * @param iter the iterator to destroy
1330  */
1331 void
1332 GNUNET_CONTAINER_multihashmap32_iterator_destroy (struct GNUNET_CONTAINER_MultiHashMapIterator *iter);
1333
1334
1335 /* ******************** doubly-linked list *************** */
1336 /* To avoid mistakes: head->prev == tail->next == NULL     */
1337
1338 /**
1339  * @ingroup dll
1340  * Insert an element at the head of a DLL. Assumes that head, tail and
1341  * element are structs with prev and next fields.
1342  *
1343  * @param head pointer to the head of the DLL
1344  * @param tail pointer to the tail of the DLL
1345  * @param element element to insert
1346  */
1347 #define GNUNET_CONTAINER_DLL_insert(head,tail,element) do { \
1348   GNUNET_assert ( ( (element)->prev == NULL) && ((head) != (element))); \
1349   GNUNET_assert ( ( (element)->next == NULL) && ((tail) != (element))); \
1350   (element)->next = (head); \
1351   (element)->prev = NULL; \
1352   if ((tail) == NULL) \
1353     (tail) = element; \
1354   else \
1355     (head)->prev = element; \
1356   (head) = (element); } while (0)
1357
1358
1359 /**
1360  * @ingroup dll
1361  * Insert an element at the tail of a DLL. Assumes that head, tail and
1362  * element are structs with prev and next fields.
1363  *
1364  * @param head pointer to the head of the DLL
1365  * @param tail pointer to the tail of the DLL
1366  * @param element element to insert
1367  */
1368 #define GNUNET_CONTAINER_DLL_insert_tail(head,tail,element) do { \
1369   GNUNET_assert ( ( (element)->prev == NULL) && ((head) != (element))); \
1370   GNUNET_assert ( ( (element)->next == NULL) && ((tail) != (element))); \
1371   (element)->prev = (tail); \
1372   (element)->next = NULL; \
1373   if ((head) == NULL) \
1374     (head) = element; \
1375   else \
1376     (tail)->next = element; \
1377   (tail) = (element); } while (0)
1378
1379
1380 /**
1381  * @ingroup dll
1382  * Insert an element into a DLL after the given other element.  Insert
1383  * at the head if the other element is NULL.
1384  *
1385  * @param head pointer to the head of the DLL
1386  * @param tail pointer to the tail of the DLL
1387  * @param other prior element, NULL for insertion at head of DLL
1388  * @param element element to insert
1389  */
1390 #define GNUNET_CONTAINER_DLL_insert_after(head,tail,other,element) do { \
1391   GNUNET_assert ( ( (element)->prev == NULL) && ((head) != (element))); \
1392   GNUNET_assert ( ( (element)->next == NULL) && ((tail) != (element))); \
1393   (element)->prev = (other); \
1394   if (NULL == other) \
1395     { \
1396       (element)->next = (head); \
1397       (head) = (element); \
1398     } \
1399   else \
1400     { \
1401       (element)->next = (other)->next; \
1402       (other)->next = (element); \
1403     } \
1404   if (NULL == (element)->next) \
1405     (tail) = (element); \
1406   else \
1407     (element)->next->prev = (element); } while (0)
1408
1409
1410 /**
1411  * @ingroup dll
1412  * Insert an element into a DLL before the given other element.  Insert
1413  * at the tail if the other element is NULL.
1414  *
1415  * @param head pointer to the head of the DLL
1416  * @param tail pointer to the tail of the DLL
1417  * @param other prior element, NULL for insertion at head of DLL
1418  * @param element element to insert
1419  */
1420 #define GNUNET_CONTAINER_DLL_insert_before(head,tail,other,element) do { \
1421   GNUNET_assert ( ( (element)->prev == NULL) && ((head) != (element))); \
1422   GNUNET_assert ( ( (element)->next == NULL) && ((tail) != (element))); \
1423   (element)->next = (other); \
1424   if (NULL == other) \
1425     { \
1426       (element)->prev = (tail); \
1427       (tail) = (element); \
1428     } \
1429   else \
1430     { \
1431       (element)->prev = (other)->prev; \
1432       (other)->prev = (element); \
1433     } \
1434   if (NULL == (element)->prev) \
1435     (head) = (element); \
1436   else \
1437     (element)->prev->next = (element); } while (0)
1438
1439
1440 /**
1441  * @ingroup dll
1442  * Remove an element from a DLL. Assumes that head, tail and
1443  * element point to structs with prev and next fields.
1444  *
1445  * Using the head or tail pointer as the element
1446  * argument does NOT work with this macro.
1447  * Make sure to store head/tail in another pointer
1448  * and use it to remove the head or tail of the list.
1449  *
1450  * @param head pointer to the head of the DLL
1451  * @param tail pointer to the tail of the DLL
1452  * @param element element to remove
1453  */
1454 #define GNUNET_CONTAINER_DLL_remove(head,tail,element) do { \
1455   GNUNET_assert ( ( (element)->prev != NULL) || ((head) == (element))); \
1456   GNUNET_assert ( ( (element)->next != NULL) || ((tail) == (element))); \
1457   if ((element)->prev == NULL) \
1458     (head) = (element)->next;  \
1459   else \
1460     (element)->prev->next = (element)->next; \
1461   if ((element)->next == NULL) \
1462     (tail) = (element)->prev;  \
1463   else \
1464     (element)->next->prev = (element)->prev; \
1465   (element)->next = NULL; \
1466   (element)->prev = NULL; } while (0)
1467
1468
1469 /* ************ Multi-DLL interface, allows DLL elements to be
1470    in multiple lists at the same time *********************** */
1471
1472 /**
1473  * @ingroup dll
1474  * Insert an element at the head of a MDLL. Assumes that head, tail and
1475  * element are structs with prev and next fields.
1476  *
1477  * @param mdll suffix name for the next and prev pointers in the element
1478  * @param head pointer to the head of the MDLL
1479  * @param tail pointer to the tail of the MDLL
1480  * @param element element to insert
1481  */
1482 #define GNUNET_CONTAINER_MDLL_insert(mdll,head,tail,element) do {       \
1483   GNUNET_assert ( ( (element)->prev_##mdll == NULL) && ((head) != (element))); \
1484   GNUNET_assert ( ( (element)->next_##mdll == NULL) && ((tail) != (element))); \
1485   (element)->next_##mdll = (head); \
1486   (element)->prev_##mdll = NULL; \
1487   if ((tail) == NULL) \
1488     (tail) = element; \
1489   else \
1490     (head)->prev_##mdll = element; \
1491   (head) = (element); } while (0)
1492
1493
1494 /**
1495  * @ingroup dll
1496  * Insert an element at the tail of a MDLL. Assumes that head, tail and
1497  * element are structs with prev and next fields.
1498  *
1499  * @param mdll suffix name for the next and prev pointers in the element
1500  * @param head pointer to the head of the MDLL
1501  * @param tail pointer to the tail of the MDLL
1502  * @param element element to insert
1503  */
1504 #define GNUNET_CONTAINER_MDLL_insert_tail(mdll,head,tail,element) do {  \
1505   GNUNET_assert ( ( (element)->prev_##mdll == NULL) && ((head) != (element))); \
1506   GNUNET_assert ( ( (element)->next_##mdll == NULL) && ((tail) != (element))); \
1507   (element)->prev_##mdll = (tail); \
1508   (element)->next_##mdll = NULL; \
1509   if ((head) == NULL) \
1510     (head) = element; \
1511   else \
1512     (tail)->next_##mdll = element; \
1513   (tail) = (element); } while (0)
1514
1515
1516 /**
1517  * @ingroup dll
1518  * Insert an element into a MDLL after the given other element.  Insert
1519  * at the head if the other element is NULL.
1520  *
1521  * @param mdll suffix name for the next and prev pointers in the element
1522  * @param head pointer to the head of the MDLL
1523  * @param tail pointer to the tail of the MDLL
1524  * @param other prior element, NULL for insertion at head of MDLL
1525  * @param element element to insert
1526  */
1527 #define GNUNET_CONTAINER_MDLL_insert_after(mdll,head,tail,other,element) do { \
1528   GNUNET_assert ( ( (element)->prev_##mdll == NULL) && ((head) != (element))); \
1529   GNUNET_assert ( ( (element)->next_##mdll == NULL) && ((tail) != (element))); \
1530   (element)->prev_##mdll = (other); \
1531   if (NULL == other) \
1532     { \
1533       (element)->next_##mdll = (head); \
1534       (head) = (element); \
1535     } \
1536   else \
1537     { \
1538       (element)->next_##mdll = (other)->next_##mdll; \
1539       (other)->next_##mdll = (element); \
1540     } \
1541   if (NULL == (element)->next_##mdll) \
1542     (tail) = (element); \
1543   else \
1544     (element)->next->prev_##mdll = (element); } while (0)
1545
1546
1547 /**
1548  * @ingroup dll
1549  * Insert an element into a MDLL before the given other element.  Insert
1550  * at the tail if the other element is NULL.
1551  *
1552  * @param mdll suffix name for the next and prev pointers in the element
1553  * @param head pointer to the head of the MDLL
1554  * @param tail pointer to the tail of the MDLL
1555  * @param other prior element, NULL for insertion at head of MDLL
1556  * @param element element to insert
1557  */
1558 #define GNUNET_CONTAINER_MDLL_insert_before(mdll,head,tail,other,element) do { \
1559   GNUNET_assert ( ( (element)->prev_##mdll == NULL) && ((head) != (element))); \
1560   GNUNET_assert ( ( (element)->next_##mdll == NULL) && ((tail) != (element))); \
1561   (element)->next_##mdll = (other); \
1562   if (NULL == other) \
1563     { \
1564       (element)->prev = (tail); \
1565       (tail) = (element); \
1566     } \
1567   else \
1568     { \
1569       (element)->prev_##mdll = (other)->prev_##mdll; \
1570       (other)->prev_##mdll = (element); \
1571     } \
1572   if (NULL == (element)->prev_##mdll) \
1573     (head) = (element); \
1574   else \
1575     (element)->prev_##mdll->next_##mdll = (element); } while (0)
1576
1577
1578 /**
1579  * @ingroup dll
1580  * Remove an element from a MDLL. Assumes
1581  * that head, tail and element are structs
1582  * with prev and next fields.
1583  *
1584  * @param mdll suffix name for the next and prev pointers in the element
1585  * @param head pointer to the head of the MDLL
1586  * @param tail pointer to the tail of the MDLL
1587  * @param element element to remove
1588  */
1589 #define GNUNET_CONTAINER_MDLL_remove(mdll,head,tail,element) do {       \
1590   GNUNET_assert ( ( (element)->prev_##mdll != NULL) || ((head) == (element))); \
1591   GNUNET_assert ( ( (element)->next_##mdll != NULL) || ((tail) == (element))); \
1592   if ((element)->prev_##mdll == NULL) \
1593     (head) = (element)->next_##mdll;  \
1594   else \
1595     (element)->prev_##mdll->next_##mdll = (element)->next_##mdll; \
1596   if ((element)->next_##mdll == NULL) \
1597     (tail) = (element)->prev_##mdll;  \
1598   else \
1599     (element)->next_##mdll->prev_##mdll = (element)->prev_##mdll; \
1600   (element)->next_##mdll = NULL; \
1601   (element)->prev_##mdll = NULL; } while (0)
1602
1603
1604
1605 /* ******************** Heap *************** */
1606
1607
1608 /**
1609  * @ingroup heap
1610  * Cost by which elements in a heap can be ordered.
1611  */
1612 typedef uint64_t GNUNET_CONTAINER_HeapCostType;
1613
1614
1615 /**
1616  * @ingroup heap
1617  * Heap type, either max or min.
1618  */
1619 enum GNUNET_CONTAINER_HeapOrder
1620 {
1621   /**
1622    * @ingroup heap
1623    * Heap with the maximum cost at the root.
1624    */
1625   GNUNET_CONTAINER_HEAP_ORDER_MAX,
1626
1627   /**
1628    * @ingroup heap
1629    * Heap with the minimum cost at the root.
1630    */
1631   GNUNET_CONTAINER_HEAP_ORDER_MIN
1632 };
1633
1634
1635 /**
1636  * @ingroup heap
1637  * Handle to a Heap.
1638  */
1639 struct GNUNET_CONTAINER_Heap;
1640
1641
1642 /**
1643  * @ingroup heap
1644  * Handle to a node in a heap.
1645  */
1646 struct GNUNET_CONTAINER_HeapNode;
1647
1648
1649 /**
1650  * @ingroup heap
1651  * Create a new heap.
1652  *
1653  * @param order how should the heap be sorted?
1654  * @return handle to the heap
1655  */
1656 struct GNUNET_CONTAINER_Heap *
1657 GNUNET_CONTAINER_heap_create (enum GNUNET_CONTAINER_HeapOrder order);
1658
1659
1660 /**
1661  * @ingroup heap
1662  * Destroys the heap.  Only call on a heap that
1663  * is already empty.
1664  *
1665  * @param heap heap to destroy
1666  */
1667 void
1668 GNUNET_CONTAINER_heap_destroy (struct GNUNET_CONTAINER_Heap *heap);
1669
1670
1671 /**
1672  * @ingroup heap
1673  * Get element stored at root of heap.
1674  *
1675  * @param heap heap to inspect
1676  * @return NULL if heap is empty
1677  */
1678 void *
1679 GNUNET_CONTAINER_heap_peek (const struct GNUNET_CONTAINER_Heap *heap);
1680
1681
1682 /**
1683  * @ingroup heap
1684  * Get the current size of the heap
1685  *
1686  * @param heap the heap to get the size of
1687  * @return number of elements stored
1688  */
1689 unsigned int
1690 GNUNET_CONTAINER_heap_get_size (const struct GNUNET_CONTAINER_Heap *heap);
1691
1692
1693 /**
1694  * @ingroup heap
1695  * Get the current cost of the node
1696  *
1697  * @param node the node to get the cost of
1698  * @return cost of the node
1699  */
1700 GNUNET_CONTAINER_HeapCostType
1701 GNUNET_CONTAINER_heap_node_get_cost (const struct GNUNET_CONTAINER_HeapNode
1702                                      *node);
1703
1704 /**
1705  * @ingroup heap
1706  * Iterator for heap
1707  *
1708  * @param cls closure
1709  * @param node internal node of the heap
1710  * @param element value stored at the node
1711  * @param cost cost associated with the node
1712  * @return #GNUNET_YES if we should continue to iterate,
1713  *         #GNUNET_NO if not.
1714  */
1715 typedef int (*GNUNET_CONTAINER_HeapIterator) (void *cls,
1716                                               struct GNUNET_CONTAINER_HeapNode *
1717                                               node, void *element,
1718                                               GNUNET_CONTAINER_HeapCostType
1719                                               cost);
1720
1721
1722 /**
1723  * @ingroup heap
1724  * Iterate over all entries in the heap.
1725  *
1726  * @param heap the heap
1727  * @param iterator function to call on each entry
1728  * @param iterator_cls closure for @a iterator
1729  */
1730 void
1731 GNUNET_CONTAINER_heap_iterate (const struct GNUNET_CONTAINER_Heap *heap,
1732                                GNUNET_CONTAINER_HeapIterator iterator,
1733                                void *iterator_cls);
1734
1735 /**
1736  * @ingroup heap
1737  * Perform a random walk of the tree.  The walk is biased
1738  * towards elements closer to the root of the tree (since
1739  * each walk starts at the root and ends at a random leaf).
1740  * The heap internally tracks the current position of the
1741  * walk.
1742  *
1743  * @param heap heap to walk
1744  * @return data stored at the next random node in the walk;
1745  *         NULL if the tree is empty.
1746  */
1747 void *
1748 GNUNET_CONTAINER_heap_walk_get_next (struct GNUNET_CONTAINER_Heap *heap);
1749
1750
1751 /**
1752  * @ingroup heap
1753  * Inserts a new element into the heap.
1754  *
1755  * @param heap heap to modify
1756  * @param element element to insert
1757  * @param cost cost for the element
1758  * @return node for the new element
1759  */
1760 struct GNUNET_CONTAINER_HeapNode *
1761 GNUNET_CONTAINER_heap_insert (struct GNUNET_CONTAINER_Heap *heap, void *element,
1762                               GNUNET_CONTAINER_HeapCostType cost);
1763
1764
1765 /**
1766  * @ingroup heap
1767  * Remove root of the heap.
1768  *
1769  * @param heap heap to modify
1770  * @return element data stored at the root node
1771  */
1772 void *
1773 GNUNET_CONTAINER_heap_remove_root (struct GNUNET_CONTAINER_Heap *heap);
1774
1775
1776 /**
1777  * @ingroup heap
1778  * Removes a node from the heap.
1779  *
1780  * @param node node to remove
1781  * @return element data stored at the node, NULL if heap is empty
1782  */
1783 void *
1784 GNUNET_CONTAINER_heap_remove_node (struct GNUNET_CONTAINER_HeapNode *node);
1785
1786
1787 /**
1788  * @ingroup heap
1789  * Updates the cost of any node in the tree
1790  *
1791  * @param heap heap to modify
1792  * @param node node for which the cost is to be changed
1793  * @param new_cost new cost for the node
1794  */
1795 void
1796 GNUNET_CONTAINER_heap_update_cost (struct GNUNET_CONTAINER_Heap *heap,
1797                                    struct GNUNET_CONTAINER_HeapNode *node,
1798                                    GNUNET_CONTAINER_HeapCostType new_cost);
1799
1800
1801 /* ******************** Singly linked list *************** */
1802
1803 /**
1804  * Possible ways for how data stored in the linked list
1805  * might be allocated.
1806  * @deprecated use DLL macros
1807  */
1808 enum GNUNET_CONTAINER_SListDisposition
1809 {
1810   /**
1811    * Single-linked list must copy the buffer.
1812    * @deprecated use DLL macros
1813    */
1814   GNUNET_CONTAINER_SLIST_DISPOSITION_TRANSIENT = 0,
1815
1816   /**
1817    * Data is static, no need to copy or free.
1818    * @deprecated use DLL macros
1819    */
1820   GNUNET_CONTAINER_SLIST_DISPOSITION_STATIC = 2,
1821
1822   /**
1823    * Data is dynamic, do not copy but free when done.
1824    * @deprecated use DLL macros
1825    */
1826   GNUNET_CONTAINER_SLIST_DISPOSITION_DYNAMIC = 4
1827 };
1828
1829 struct GNUNET_CONTAINER_SList_Elem;
1830
1831
1832 /**
1833  * Handle to a singly linked list
1834  * @deprecated use DLL macros
1835  */
1836 struct GNUNET_CONTAINER_SList;
1837
1838 /**
1839  * Handle to a singly linked list iterator
1840  * @deprecated use DLL macros
1841  */
1842 struct GNUNET_CONTAINER_SList_Iterator
1843 {
1844   /**
1845    * Linked list that we are iterating over.
1846    */
1847   struct GNUNET_CONTAINER_SList *list;
1848
1849   /**
1850    * Last element accessed.
1851    */
1852   struct GNUNET_CONTAINER_SList_Elem *last;
1853
1854   /**
1855    * Current list element.
1856    */
1857   struct GNUNET_CONTAINER_SList_Elem *elem;
1858 };
1859
1860
1861
1862 /**
1863  * Add a new element to the list
1864  * @param l list
1865  * @param disp memory disposition
1866  * @param buf payload buffer
1867  * @param len length of the buffer
1868  * @deprecated use DLL macros
1869  */
1870 void
1871 GNUNET_CONTAINER_slist_add (struct GNUNET_CONTAINER_SList *l,
1872                             enum GNUNET_CONTAINER_SListDisposition disp,
1873                             const void *buf, size_t len);
1874
1875
1876 /**
1877  * Add a new element to the end of the list
1878  * @param l list
1879  * @param disp memory disposition
1880  * @param buf payload buffer
1881  * @param len length of the buffer
1882  * @deprecated use DLL macros
1883  */
1884 void
1885 GNUNET_CONTAINER_slist_add_end (struct GNUNET_CONTAINER_SList *l,
1886                                 enum GNUNET_CONTAINER_SListDisposition disp,
1887                                 const void *buf, size_t len);
1888
1889
1890 /**
1891  * Append a singly linked list to another
1892  * @param dst list to append to
1893  * @param src source
1894  * @deprecated use DLL macros
1895  */
1896 void
1897 GNUNET_CONTAINER_slist_append (struct GNUNET_CONTAINER_SList *dst,
1898                                struct GNUNET_CONTAINER_SList *src);
1899
1900
1901 /**
1902  * Create a new singly linked list
1903  * @return the new list
1904  * @deprecated use DLL macros
1905  */
1906 struct GNUNET_CONTAINER_SList *
1907 GNUNET_CONTAINER_slist_create (void);
1908
1909
1910 /**
1911  * Destroy a singly linked list
1912  * @param l the list to be destroyed
1913  * @deprecated use DLL macros
1914  */
1915 void
1916 GNUNET_CONTAINER_slist_destroy (struct GNUNET_CONTAINER_SList *l);
1917
1918
1919 /**
1920  * Return the beginning of a list
1921  *
1922  * @param l list
1923  * @return iterator pointing to the beginning (by value! Either allocate the
1924  *   structure on the stack, or use GNUNET_malloc() yourself! All other
1925  *   functions do take pointer to this struct though)
1926  * @deprecated use DLL macros
1927  */
1928 struct GNUNET_CONTAINER_SList_Iterator
1929 GNUNET_CONTAINER_slist_begin (struct GNUNET_CONTAINER_SList *l);
1930
1931
1932 /**
1933  * Clear a list
1934  *
1935  * @param l list
1936  * @deprecated use DLL macros
1937  */
1938 void
1939 GNUNET_CONTAINER_slist_clear (struct GNUNET_CONTAINER_SList *l);
1940
1941
1942 /**
1943  * Check if a list contains a certain element
1944  * @param l list
1945  * @param buf payload buffer to find
1946  * @param len length of the payload (number of bytes in buf)
1947  * @return GNUNET_YES if found, GNUNET_NO otherwise
1948  * @deprecated use DLL macros
1949  */
1950 int
1951 GNUNET_CONTAINER_slist_contains (const struct GNUNET_CONTAINER_SList *l,
1952                                  const void *buf, size_t len);
1953
1954 /**
1955  * Check if a list contains a certain element using 'compare' function
1956  *
1957  * @param l list
1958  * @param buf payload buffer to find
1959  * @param len length of the payload (number of bytes in buf)
1960  * @param compare comparison function
1961  *
1962  * @return NULL if the 'buf' could not be found, pointer to the
1963  *         list element, if found
1964  * @deprecated use DLL macros
1965  */
1966 void *
1967 GNUNET_CONTAINER_slist_contains2 (const struct GNUNET_CONTAINER_SList *l,
1968                                   const void *buf, size_t len,
1969                                   int (*compare)(const void *, const size_t, const void *, const size_t));
1970 /**
1971  * Count the elements of a list
1972  * @param l list
1973  * @return number of elements in the list
1974  * @deprecated use DLL macros
1975  */
1976 int
1977 GNUNET_CONTAINER_slist_count (const struct GNUNET_CONTAINER_SList *l);
1978
1979
1980 /**
1981  * Remove an element from the list
1982  * @param i iterator that points to the element to be removed
1983  * @deprecated use DLL macros
1984  */
1985 void
1986 GNUNET_CONTAINER_slist_erase (struct GNUNET_CONTAINER_SList_Iterator *i);
1987
1988
1989 /**
1990  * Insert an element into a list at a specific position
1991  * @param before where to insert the new element
1992  * @param disp memory disposition
1993  * @param buf payload buffer
1994  * @param len length of the payload
1995  * @deprecated use DLL macros
1996  */
1997 void
1998 GNUNET_CONTAINER_slist_insert (struct GNUNET_CONTAINER_SList_Iterator *before,
1999                                enum GNUNET_CONTAINER_SListDisposition disp,
2000                                const void *buf, size_t len);
2001
2002
2003 /**
2004  * Advance an iterator to the next element
2005  * @param i iterator
2006  * @return GNUNET_YES on success, GNUNET_NO if the end has been reached
2007  * @deprecated use DLL macros
2008  */
2009 int
2010 GNUNET_CONTAINER_slist_next (struct GNUNET_CONTAINER_SList_Iterator *i);
2011
2012
2013 /**
2014  * Check if an iterator points beyond the end of a list
2015  * @param i iterator
2016  * @return GNUNET_YES if the end has been reached, GNUNET_NO if the iterator
2017  *         points to a valid element
2018  * @deprecated use DLL macros
2019  */
2020 int
2021 GNUNET_CONTAINER_slist_end (struct GNUNET_CONTAINER_SList_Iterator *i);
2022
2023
2024 /**
2025  * Retrieve the element at a specific position in a list
2026  *
2027  * @param i iterator
2028  * @param len set to the payload length
2029  * @return payload
2030  * @deprecated use DLL macros
2031  */
2032 void *
2033 GNUNET_CONTAINER_slist_get (const struct GNUNET_CONTAINER_SList_Iterator *i,
2034                             size_t *len);
2035
2036
2037 /**
2038  * Release an iterator
2039  * @param i iterator
2040  * @deprecated use DLL macros
2041  */
2042 void
2043 GNUNET_CONTAINER_slist_iter_destroy (struct GNUNET_CONTAINER_SList_Iterator *i);
2044
2045
2046 #if 0                           /* keep Emacsens' auto-indent happy */
2047 {
2048 #endif
2049 #ifdef __cplusplus
2050 }
2051 #endif
2052
2053
2054 /* ifndef GNUNET_CONTAINER_LIB_H */
2055 #endif
2056 /* end of gnunet_container_lib.h */