src/include/gnunet_container_lib.h

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