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