src/include/gnunet_container_lib.h

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2001, 2002, 2003, 2004, 2005, 2006, 2008, 2009, 2010 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 2, 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  *
  25  * @author Christian Grothoff
  26  * @author Nils Durner
  27  */
  28
  29 #ifndef GNUNET_CONTAINER_LIB_H
  30 #define GNUNET_CONTAINER_LIB_H
  31
  32 /* add error and config prototypes */
  33 #include "gnunet_crypto_lib.h"
  34 #include <extractor.h>
  35
  36 #ifdef __cplusplus
  37 extern "C"
  38 {
  39 #if 0                           /* keep Emacsens' auto-indent happy */
  40 }
  41 #endif
  42 #endif
  43
  44
  45 /* ******************* bloomfilter ***************** */
  46
  47 /**
  48  * @brief bloomfilter representation (opaque)
  49  */
  50 struct GNUNET_CONTAINER_BloomFilter;
  51
  52 /**
  53  * Iterator over HashCodes.
  54  *
  55  * @param cls closure
  56  * @param next set to the next hash code
  57  * @return GNUNET_YES if next was updated
  58  *         GNUNET_NO if there are no more entries
  59  */
  60 typedef int (*GNUNET_HashCodeIterator) (void *cls,
  61                                         GNUNET_HashCode * next);
  62
  63 /**
  64  * Load a bloom-filter from a file.
  65  *
  66  * @param filename the name of the file (or the prefix)
  67  * @param size the size of the bloom-filter (number of
  68  *        bytes of storage space to use)
  69  * @param k the number of GNUNET_CRYPTO_hash-functions to apply per
  70  *        element (number of bits set per element in the set)
  71  * @return the bloomfilter
  72  */
  73 struct GNUNET_CONTAINER_BloomFilter *
  74 GNUNET_CONTAINER_bloomfilter_load (const
  75                                    char
  76                                    *filename,
  77                                    size_t
  78                                    size,
  79                                    unsigned
  80                                    int
  81                                    k);
  82
  83 /**
  84  * Create a bloom filter from raw bits.
  85  *
  86  * @param data the raw bits in memory (maybe NULL,
  87  *        in which case all bits should be considered
  88  *        to be zero).
  89  * @param size the size of the bloom-filter (number of
  90  *        bytes of storage space to use); also size of data
  91  *        -- unless data is NULL.  Must be a power of 2.
  92  * @param k the number of GNUNET_CRYPTO_hash-functions to apply per
  93  *        element (number of bits set per element in the set)
  94  * @return the bloomfilter
  95  */
  96 struct GNUNET_CONTAINER_BloomFilter *
  97 GNUNET_CONTAINER_bloomfilter_init (const
  98                                    char
  99                                    *data,
 100                                    size_t
 101                                    size,
 102                                    unsigned
 103                                    int
 104                                    k);
 105
 106 /**
 107  * Copy the raw data of this bloomfilter into
 108  * the given data array.
 109  *
 110  * @param data where to write the data
 111  * @param size the size of the given data array
 112  * @return GNUNET_SYSERR if the data array of the wrong size
 113  */
 114 int GNUNET_CONTAINER_bloomfilter_get_raw_data (struct
 115                                                GNUNET_CONTAINER_BloomFilter
 116                                                *bf, char *data,
 117                                                size_t size);
 118
 119 /**
 120  * Test if an element is in the filter.
 121  * @param e the element
 122  * @param bf the filter
 123  * @return GNUNET_YES if the element is in the filter, GNUNET_NO if not
 124  */
 125 int GNUNET_CONTAINER_bloomfilter_test (struct GNUNET_CONTAINER_BloomFilter
 126                                        *bf, const GNUNET_HashCode * e);
 127
 128 /**
 129  * Add an element to the filter
 130  * @param bf the filter
 131  * @param e the element
 132  */
 133 void GNUNET_CONTAINER_bloomfilter_add (struct GNUNET_CONTAINER_BloomFilter
 134                                        *bf, const GNUNET_HashCode * e);
 135
 136 /**
 137  * Remove an element from the filter.
 138  * @param bf the filter
 139  * @param e the element to remove
 140  */
 141 void GNUNET_CONTAINER_bloomfilter_remove (struct GNUNET_CONTAINER_BloomFilter
 142                                           *bf, const GNUNET_HashCode * e);
 143
 144 /**
 145  * Free the space associcated with a filter
 146  * in memory, flush to drive if needed (do not
 147  * free the space on the drive)
 148  * @param bf the filter
 149  */
 150 void GNUNET_CONTAINER_bloomfilter_free (struct GNUNET_CONTAINER_BloomFilter
 151                                         *bf);
 152
 153 /**
 154  * Reset a bloom filter to empty.
 155  * @param bf the filter
 156  */
 157 void GNUNET_CONTAINER_bloomfilter_clear (struct GNUNET_CONTAINER_BloomFilter
 158                                          *bf);
 159
 160 /**
 161  * Or the entries of the given raw data array with the
 162  * data of the given bloom filter.  Assumes that
 163  * the size of the data array and the current filter
 164  * match.
 165  *
 166  * @param bf the filter
 167  * @param data data to OR-in
 168  * @param size size of data
 169  * @return GNUNET_OK on success
 170  */
 171 int GNUNET_CONTAINER_bloomfilter_or (struct GNUNET_CONTAINER_BloomFilter *bf,
 172                                      const char *data, size_t size);
 173
 174 /**
 175  * Resize a bloom filter.  Note that this operation
 176  * is pretty costly.  Essentially, the bloom filter
 177  * needs to be completely re-build.
 178  *
 179  * @param bf the filter
 180  * @param iterator an iterator over all elements stored in the BF
 181  * @param iterator_cls closure for iterator
 182  * @param size the new size for the filter
 183  * @param k the new number of GNUNET_CRYPTO_hash-function to apply per element
 184  */
 185 void GNUNET_CONTAINER_bloomfilter_resize (struct GNUNET_CONTAINER_BloomFilter
 186                                           *bf,
 187                                           GNUNET_HashCodeIterator iterator,
 188                                           void *iterator_cls,
 189                                           size_t size, unsigned int k);
 190
 191 /* ****************** metadata ******************* */
 192
 193 /**
 194  * Meta data to associate with a file, directory or namespace.
 195  */
 196 struct GNUNET_CONTAINER_MetaData;
 197
 198 /**
 199  * Create a fresh MetaData token.
 200  *
 201  * @return empty meta-data container
 202  */
 203 struct GNUNET_CONTAINER_MetaData *
 204 GNUNET_CONTAINER_meta_data_create (void);
 205
 206 /**
 207  * Duplicate a MetaData token.
 208  *
 209  * @param md what to duplicate
 210  * @return duplicate meta-data container
 211  */
 212 struct GNUNET_CONTAINER_MetaData *
 213 GNUNET_CONTAINER_meta_data_duplicate (const struct
 214                                       GNUNET_CONTAINER_MetaData *md);
 215
 216 /**
 217  * Free meta data.
 218  *
 219  * @param md what to free
 220  */
 221 void
 222 GNUNET_CONTAINER_meta_data_destroy (struct GNUNET_CONTAINER_MetaData *md);
 223
 224 /**
 225  * Test if two MDs are equal. We consider them equal if
 226  * the meta types, formats and content match (we do not
 227  * include the mime types and plugins names in this
 228  * consideration).
 229  *
 230  * @param md1 first value to check
 231  * @param md2 other value to check
 232  * @return GNUNET_YES if they are equal
 233  */
 234 int
 235 GNUNET_CONTAINER_meta_data_test_equal (const struct
 236                                        GNUNET_CONTAINER_MetaData *md1,
 237                                        const struct
 238                                        GNUNET_CONTAINER_MetaData *md2);
 239
 240
 241 /**
 242  * Extend metadata.
 243  *
 244  * @param md metadata to extend
 245  * @param plugin_name name of the plugin that produced this value;
 246  *        special values can be used (i.e. '&lt;zlib&gt;' for zlib being
 247  *        used in the main libextractor library and yielding
 248  *        meta data).
 249  * @param type libextractor-type describing the meta data
 250  * @param format basic format information about data
 251  * @param data_mime_type mime-type of data (not of the original file);
 252  *        can be NULL (if mime-type is not known)
 253  * @param data actual meta-data found
 254  * @param data_len number of bytes in data
 255  * @return GNUNET_OK on success, GNUNET_SYSERR if this entry already exists
 256  *         data_mime_type and plugin_name are not considered for "exists" checks
 257  */
 258 int
 259 GNUNET_CONTAINER_meta_data_insert (struct GNUNET_CONTAINER_MetaData *md,
 260                                    const char *plugin_name,
 261                                    enum EXTRACTOR_MetaType type,
 262                                    enum EXTRACTOR_MetaFormat format,
 263                                    const char *data_mime_type,
 264                                    const char *data,
 265                                    size_t data_len);
 266
 267
 268 /**
 269  * Remove an item.
 270  *
 271  * @param md metadata to manipulate
 272  * @param type type of the item to remove
 273  * @param data specific value to remove, NULL to remove all
 274  *        entries of the given type
 275  * @param data_len number of bytes in data
 276  * @return GNUNET_OK on success, GNUNET_SYSERR if the item does not exist in md
 277  */
 278 int
 279 GNUNET_CONTAINER_meta_data_delete (struct GNUNET_CONTAINER_MetaData *md,
 280                                    enum EXTRACTOR_MetaType type,
 281                                    const char *data,
 282                                    size_t data_len);
 283
 284
 285 /**
 286  * Add the current time as the publication date
 287  * to the meta-data.
 288  *
 289  * @param md metadata to modify
 290  */
 291 void
 292 GNUNET_CONTAINER_meta_data_add_publication_date (struct
 293                                                  GNUNET_CONTAINER_MetaData
 294                                                  *md);
 295
 296
 297 /**
 298  * Iterate over MD entries.
 299  *
 300  * @param md metadata to inspect
 301  * @param iter function to call on each entry
 302  * @param iter_cls closure for iterator
 303  * @return number of entries
 304  */
 305 int GNUNET_CONTAINER_meta_data_iterate (const struct
 306                                         GNUNET_CONTAINER_MetaData *md,
 307                                         EXTRACTOR_MetaDataProcessor
 308                                         iter, void *iter_cls);
 309
 310 /**
 311  * Get the first MD entry of the given type.  Caller
 312  * is responsible for freeing the return value.
 313  * Also, only meta data items that are strings (0-terminated)
 314  * are returned by this function.
 315  *
 316  * @param md metadata to inspect
 317  * @param type type to look for
 318  * @return NULL if no entry was found
 319  */
 320 char *
 321 GNUNET_CONTAINER_meta_data_get_by_type (const struct
 322                                         GNUNET_CONTAINER_MetaData *md,
 323                                         enum EXTRACTOR_MetaType type);
 324
 325
 326 /**
 327  * Get the first matching MD entry of the given types. Caller is
 328  * responsible for freeing the return value.  Also, only meta data
 329  * items that are strings (0-terminated) are returned by this
 330  * function.
 331  *
 332  * @param md metadata to inspect
 333  * @param ... -1-terminated list of types
 334  * @return NULL if we do not have any such entry,
 335  *  otherwise client is responsible for freeing the value!
 336  */
 337 char *
 338 GNUNET_CONTAINER_meta_data_get_first_by_types (const struct
 339                                                GNUNET_CONTAINER_MetaData
 340                                                *md, ...);
 341
 342 /**
 343  * Get a thumbnail from the meta-data (if present).  Only matches meta
 344  * data with mime type "image" and binary format.
 345  *
 346  * @param md metadata to inspect
 347  * @param thumb will be set to the thumbnail data.  Must be
 348  *        freed by the caller!
 349  * @return number of bytes in thumbnail, 0 if not available
 350  */
 351 size_t
 352 GNUNET_CONTAINER_meta_data_get_thumbnail (const struct
 353                                           GNUNET_CONTAINER_MetaData
 354                                           *md, unsigned char **thumb);
 355
 356 /**
 357  * Extract meta-data from a file.
 358  *
 359  * @param md metadata to set
 360  * @param filename name of file to inspect
 361  * @param extractors plugins to use
 362  * @return GNUNET_SYSERR on error, otherwise the number
 363  *   of meta-data items obtained
 364  */
 365 int
 366 GNUNET_CONTAINER_meta_data_extract_from_file (struct
 367                                               GNUNET_CONTAINER_MetaData
 368                                               *md, const char *filename,
 369                                               struct EXTRACTOR_PluginList *
 370                                               extractors);
 371
 372
 373 /**
 374  * Options for metadata serialization.
 375  */
 376 enum GNUNET_CONTAINER_MetaDataSerializationOptions
 377 {
 378   /**
 379    * Serialize all of the data.
 380    */
 381   GNUNET_CONTAINER_META_DATA_SERIALIZE_FULL = 0,
 382
 383   /**
 384    * If not enough space is available, it is acceptable
 385    * to only serialize some of the metadata.
 386    */
 387   GNUNET_CONTAINER_META_DATA_SERIALIZE_PART = 1,
 388
 389   /**
 390    * Speed is of the essence, do not allow compression.
 391    */
 392   GNUNET_CONTAINER_META_DATA_SERIALIZE_NO_COMPRESS = 2
 393 };
 394
 395
 396 /**
 397  * Serialize meta-data to target.
 398  *
 399  * @param md metadata to serialize
 400  * @param target where to write the serialized metadata;
 401  *         *target can be NULL, in which case memory is allocated
 402  * @param max maximum number of bytes available
 403  * @param opt is it ok to just write SOME of the
 404  *        meta-data to match the size constraint,
 405  *        possibly discarding some data?
 406  * @return number of bytes written on success,
 407  *         -1 on error (typically: not enough
 408  *         space)
 409  */
 410 ssize_t GNUNET_CONTAINER_meta_data_serialize (const struct
 411                                               GNUNET_CONTAINER_MetaData *md,
 412                                               char **target,
 413                                               size_t max,
 414                                               enum
 415                                           GNUNET_CONTAINER_MetaDataSerializationOptions
 416                                           opt);
 417
 418
 419 /**
 420  * Get the size of the full meta-data in serialized form.
 421  *
 422  * @param md metadata to inspect
 423  * @return number of bytes needed for serialization, -1 on error
 424  */
 425 ssize_t GNUNET_CONTAINER_meta_data_get_serialized_size (const struct
 426                                                         GNUNET_CONTAINER_MetaData
 427                                                         *md);
 428
 429
 430 /**
 431  * Deserialize meta-data.  Initializes md.
 432  *
 433  * @param input serialized meta-data.
 434  * @param size number of bytes available
 435  * @return MD on success, NULL on error (i.e.
 436  *         bad format)
 437  */
 438 struct GNUNET_CONTAINER_MetaData
 439   *GNUNET_CONTAINER_meta_data_deserialize (const char *input,
 440                                            size_t size);
 441
 442
 443 /* ******************************* HashMap **************************** */
 444
 445 /**
 446  * Opaque handle for a HashMap.
 447  */
 448 struct GNUNET_CONTAINER_MultiHashMap;
 449
 450 /**
 451  * Options for storing values in the HashMap.
 452  */
 453 enum GNUNET_CONTAINER_MultiHashMapOption
 454 {
 455
 456   /**
 457    * If a value with the given key exists, replace it.  Note that the
 458    * old value would NOT be freed by replace (the application has to
 459    * make sure that this happens if required).
 460    */
 461   GNUNET_CONTAINER_MULTIHASHMAPOPTION_REPLACE,
 462
 463   /**
 464    * Allow multiple values with the same key.
 465    */
 466   GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE,
 467
 468   /**
 469    * There must only be one value per key; storing a value should fail
 470    * if a value under the same key already exists.
 471    */
 472   GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY,
 473
 474   /**
 475    * There must only be one value per key, but don't bother checking
 476    * if a value already exists (faster than UNIQUE_ONLY; implemented
 477    * just like MULTIPLE but this option documents better what is
 478    * intended if UNIQUE is what is desired).
 479    */
 480   GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST
 481 };
 482
 483
 484 /**
 485  * Iterator over hash map entries.
 486  *
 487  * @param cls closure
 488  * @param key current key code
 489  * @param value value in the hash map
 490  * @return GNUNET_YES if we should continue to
 491  *         iterate,
 492  *         GNUNET_NO if not.
 493  */
 494 typedef int (*GNUNET_CONTAINER_HashMapIterator) (void *cls,
 495                                                  const GNUNET_HashCode * key,
 496                                                  void *value);
 497
 498
 499 /**
 500  * Create a multi hash map.
 501  *
 502  * @param len initial size (map will grow as needed)
 503  * @return NULL on error
 504  */
 505 struct GNUNET_CONTAINER_MultiHashMap
 506   *GNUNET_CONTAINER_multihashmap_create (unsigned int len);
 507
 508
 509 /**
 510  * Destroy a hash map.  Will not free any values
 511  * stored in the hash map!
 512  *
 513  * @param map the map
 514  */
 515 void GNUNET_CONTAINER_multihashmap_destroy (struct
 516                                             GNUNET_CONTAINER_MultiHashMap
 517                                             *map);
 518
 519
 520 /**
 521  * Given a key find a value in the map matching the key.
 522  *
 523  * @param map the map
 524  * @param key what to look for
 525  * @return NULL if no value was found; note that
 526  *   this is indistinguishable from values that just
 527  *   happen to be NULL; use "contains" to test for
 528  *   key-value pairs with value NULL
 529  */
 530 void *GNUNET_CONTAINER_multihashmap_get (const struct
 531                                          GNUNET_CONTAINER_MultiHashMap *map,
 532                                          const GNUNET_HashCode * key);
 533
 534
 535 /**
 536  * Remove the given key-value pair from the map.  Note that if the
 537  * key-value pair is in the map multiple times, only one of the pairs
 538  * will be removed.
 539  *
 540  * @param map the map
 541  * @param key key of the key-value pair
 542  * @param value value of the key-value pair
 543  * @return GNUNET_YES on success, GNUNET_NO if the key-value pair
 544  *  is not in the map
 545  */
 546 int GNUNET_CONTAINER_multihashmap_remove (struct GNUNET_CONTAINER_MultiHashMap
 547                                           *map, const GNUNET_HashCode * key,
 548                                           void *value);
 549
 550 /**
 551  * Remove all entries for the given key from the map.
 552  * Note that the values would not be "freed".
 553  *
 554  * @param map the map
 555  * @param key identifies values to be removed
 556  * @return number of values removed
 557  */
 558 int GNUNET_CONTAINER_multihashmap_remove_all (struct
 559                                               GNUNET_CONTAINER_MultiHashMap
 560                                               *map,
 561                                               const GNUNET_HashCode * key);
 562
 563
 564 /**
 565  * Check if the map contains any value under the given
 566  * key (including values that are NULL).
 567  *
 568  * @param map the map
 569  * @param key the key to test if a value exists for it
 570  * @return GNUNET_YES if such a value exists,
 571  *         GNUNET_NO if not
 572  */
 573 int GNUNET_CONTAINER_multihashmap_contains (const struct
 574                                             GNUNET_CONTAINER_MultiHashMap
 575                                             *map,
 576                                             const GNUNET_HashCode * key);
 577
 578
 579 /**
 580  * Store a key-value pair in the map.
 581  *
 582  * @param map the map
 583  * @param key key to use
 584  * @param value value to use
 585  * @param opt options for put
 586  * @return GNUNET_OK on success,
 587  *         GNUNET_NO if a value was replaced (with REPLACE)
 588  *         GNUNET_SYSERR if UNIQUE_ONLY was the option and the
 589  *                       value already exists
 590  */
 591 int GNUNET_CONTAINER_multihashmap_put (struct GNUNET_CONTAINER_MultiHashMap
 592                                        *map, const GNUNET_HashCode * key,
 593                                        void *value,
 594                                        enum
 595                                        GNUNET_CONTAINER_MultiHashMapOption
 596                                        opt);
 597
 598 /**
 599  * Get the number of key-value pairs in the map.
 600  *
 601  * @param map the map
 602  * @return the number of key value pairs
 603  */
 604 unsigned int GNUNET_CONTAINER_multihashmap_size (const struct
 605                                                  GNUNET_CONTAINER_MultiHashMap
 606                                                  *map);
 607
 608
 609 /**
 610  * Iterate over all entries in the map.
 611  *
 612  * @param map the map
 613  * @param it function to call on each entry
 614  * @param it_cls extra argument to it
 615  * @return the number of key value pairs processed,
 616  *         GNUNET_SYSERR if it aborted iteration
 617  */
 618 int GNUNET_CONTAINER_multihashmap_iterate (const struct
 619                                            GNUNET_CONTAINER_MultiHashMap *map,
 620                                            GNUNET_CONTAINER_HashMapIterator
 621                                            it, void *it_cls);
 622
 623
 624 /**
 625  * Iterate over all entries in the map that match a particular key.
 626  *
 627  * @param map the map
 628  * @param key key that the entries must correspond to
 629  * @param it function to call on each entry
 630  * @param it_cls extra argument to it
 631  * @return the number of key value pairs processed,
 632  *         GNUNET_SYSERR if it aborted iteration
 633  */
 634 int GNUNET_CONTAINER_multihashmap_get_multiple (const struct
 635                                                 GNUNET_CONTAINER_MultiHashMap
 636                                                 *map,
 637                                                 const GNUNET_HashCode * key,
 638                                                 GNUNET_CONTAINER_HashMapIterator
 639                                                 it, void *it_cls);
 640
 641
 642 /* ******************** doubly-linked list *************** */
 643
 644 /**
 645  * Insert an element at the head of a DLL. Assumes that head, tail and
 646  * element are structs with prev and next fields.
 647  *
 648  * @param head pointer to the head of the DLL
 649  * @param tail pointer to the tail of the DLL
 650  * @param element element to insert
 651  */
 652 #define GNUNET_CONTAINER_DLL_insert(head,tail,element) do { \
 653   (element)->next = (head); \
 654   (element)->prev = NULL; \
 655   if ((tail) == NULL) \
 656     (tail) = element; \
 657   else \
 658     (head)->prev = element; \
 659   (head) = (element); } while (0)
 660
 661 /**
 662  * Insert an element into a DLL after the given other element.  Insert
 663  * at the head if the other element is NULL.
 664  *
 665  * @param head pointer to the head of the DLL
 666  * @param tail pointer to the tail of the DLL
 667  * @param other prior element, NULL for insertion at head of DLL
 668  * @param element element to insert
 669  */
 670 #define GNUNET_CONTAINER_DLL_insert_after(head,tail,other,element) do { \
 671   (element)->prev = (other); \
 672   if (NULL == other) \
 673     { \
 674       (element)->next = (head); \
 675       (head) = (element); \
 676     } \
 677   else \
 678     { \
 679       (element)->next = (other)->next; \
 680       (other)->next = (element); \
 681     } \
 682   if (NULL == (element)->next) \
 683     (tail) = (element); \
 684   else \
 685     (element)->next->prev = (element); } while (0)
 686
 687
 688
 689
 690 /**
 691  * Remove an element from a DLL. Assumes
 692  * that head, tail and element are structs
 693  * with prev and next fields.
 694  *
 695  * @param head pointer to the head of the DLL
 696  * @param tail pointer to the tail of the DLL
 697  * @param element element to remove
 698  */
 699 #define GNUNET_CONTAINER_DLL_remove(head,tail,element) do { \
 700   if ((element)->prev == NULL) \
 701     (head) = (element)->next;  \
 702   else \
 703     (element)->prev->next = (element)->next; \
 704   if ((element)->next == NULL) \
 705     (tail) = (element)->prev;  \
 706   else \
 707     (element)->next->prev = (element)->prev; } while (0)
 708
 709
 710
 711 /* ******************** Heap *************** */
 712
 713
 714 /**
 715  * Cost by which elements in a heap can be ordered.
 716  */
 717 typedef uint64_t GNUNET_CONTAINER_HeapCostType;
 718
 719
 720 /*
 721  * Heap type, either max or min.  Hopefully makes the
 722  * implementation more useful.
 723  */
 724 enum GNUNET_CONTAINER_HeapOrder
 725 {
 726   /**
 727    * Heap with the maximum cost at the root.
 728    */
 729   GNUNET_CONTAINER_HEAP_ORDER_MAX,
 730
 731   /**
 732    * Heap with the minimum cost at the root.
 733    */
 734   GNUNET_CONTAINER_HEAP_ORDER_MIN
 735 };
 736
 737
 738 /**
 739  * Handle to a Heap.
 740  */
 741 struct GNUNET_CONTAINER_Heap;
 742
 743
 744
 745 /**
 746  * Handle to a node in a heap.
 747  */
 748 struct GNUNET_CONTAINER_HeapNode;
 749
 750
 751 /**
 752  * Create a new heap.
 753  *
 754  * @param order how should the heap be sorted?
 755  * @return handle to the heap
 756  */
 757 struct GNUNET_CONTAINER_Heap *
 758 GNUNET_CONTAINER_heap_create (enum GNUNET_CONTAINER_HeapOrder order);
 759
 760
 761 /**
 762  * Destroys the heap.  Only call on a heap that
 763  * is already empty.
 764  *
 765  * @param heap heap to destroy
 766  */
 767 void GNUNET_CONTAINER_heap_destroy (struct GNUNET_CONTAINER_Heap *heap);
 768
 769
 770 /**
 771  * Get element stored at root of heap.
 772  *
 773  * @param heap heap to inspect
 774  * @return NULL if heap is empty
 775  */
 776 void *
 777 GNUNET_CONTAINER_heap_peek (const struct GNUNET_CONTAINER_Heap *heap);
 778
 779
 780 /**
 781  * Get the current size of the heap
 782  *
 783  * @param heap the heap to get the size of
 784  * @return number of elements stored
 785  */
 786 unsigned int
 787 GNUNET_CONTAINER_heap_get_size (const struct GNUNET_CONTAINER_Heap *heap);
 788
 789
 790 /**
 791  * Iterator for heap
 792  *
 793  * @param cls closure
 794  * @param node internal node of the heap
 795  * @param element value stored at the node
 796  * @param cost cost associated with the node
 797  * @return GNUNET_YES if we should continue to iterate,
 798  *         GNUNET_NO if not.
 799  */
 800 typedef int (*GNUNET_CONTAINER_HeapIterator) (void *cls,
 801                                               struct GNUNET_CONTAINER_HeapNode *node,
 802                                               void *element,
 803                                               GNUNET_CONTAINER_HeapCostType cost);
 804
 805
 806 /**
 807  * Iterate over all entries in the heap.
 808  *
 809  * @param heap the heap
 810  * @param iterator function to call on each entry
 811  * @param iterator_cls closure for iterator
 812  */
 813 void
 814 GNUNET_CONTAINER_heap_iterate (const struct GNUNET_CONTAINER_Heap *heap,
 815                                GNUNET_CONTAINER_HeapIterator iterator,
 816                                void *iterator_cls);
 817
 818
 819 /**
 820  * Return a *uniform* random element from the heap.  Choose a random
 821  * number between 0 and heap size and then walk directly to it.
 822  * This cost can be between 0 and n, amortized cost of logN.
 823  *
 824  * @param heap heap to choose random element from
 825  * @param max how many nodes from the heap to choose from
 826  *
 827  * @return data stored at the chosen random node,
 828  *         NULL if the heap is empty.
 829  *
 830  */
 831 void *
 832 GNUNET_CONTAINER_heap_get_random (struct GNUNET_CONTAINER_Heap *heap, uint32_t max);
 833
 834 /**
 835  * Perform a random walk of the tree.  The walk is biased
 836  * towards elements closer to the root of the tree (since
 837  * each walk starts at the root and ends at a random leaf).
 838  * The heap internally tracks the current position of the
 839  * walk.
 840  *
 841  * @param heap heap to walk
 842  * @return data stored at the next random node in the walk;
 843  *         NULL if the tree is empty.
 844  */
 845 void *
 846 GNUNET_CONTAINER_heap_walk_get_next (struct GNUNET_CONTAINER_Heap *heap);
 847
 848
 849 /**
 850  * Inserts a new element into the heap.
 851  *
 852  * @param heap heap to modify
 853  * @param element element to insert
 854  * @param cost cost for the element
 855  * @return node for the new element
 856  */
 857 struct GNUNET_CONTAINER_HeapNode *
 858 GNUNET_CONTAINER_heap_insert (struct GNUNET_CONTAINER_Heap *heap,
 859                               void *element,
 860                               GNUNET_CONTAINER_HeapCostType cost);
 861
 862
 863 /**
 864  * Remove root of the heap.
 865  *
 866  * @param heap heap to modify
 867  * @return element data stored at the root node
 868  */
 869 void *
 870 GNUNET_CONTAINER_heap_remove_root (struct GNUNET_CONTAINER_Heap *heap);
 871
 872
 873 /**
 874  * Removes a node from the heap.
 875  *
 876  * @param heap heap to modify
 877  * @param node node to remove
 878  * @return element data stored at the node, NULL if heap is empty
 879  */
 880 void *
 881 GNUNET_CONTAINER_heap_remove_node (struct GNUNET_CONTAINER_Heap *heap,
 882                                    struct GNUNET_CONTAINER_HeapNode *node);
 883
 884
 885 /**
 886  * Updates the cost of any node in the tree
 887  *
 888  * @param heap heap to modify
 889  * @param node node for which the cost is to be changed
 890  * @param new_cost new cost for the node
 891  */
 892 void
 893 GNUNET_CONTAINER_heap_update_cost (struct GNUNET_CONTAINER_Heap *heap,
 894                                    struct GNUNET_CONTAINER_HeapNode *node,
 895                                    GNUNET_CONTAINER_HeapCostType new_cost);
 896
 897
 898 /* ******************** Singly linked list *************** */
 899
 900 /**
 901  * Possible ways for how data stored in the linked list
 902  * might be allocated.
 903  */
 904 enum GNUNET_CONTAINER_SListDisposition
 905   {
 906     /**
 907      * Single-linked list must copy the buffer.
 908      */
 909     GNUNET_CONTAINER_SLIST_DISPOSITION_TRANSIENT = 0,
 910
 911     /**
 912      * Data is static, no need to copy or free.
 913      */
 914     GNUNET_CONTAINER_SLIST_DISPOSITION_STATIC = 2,
 915
 916     /**
 917      * Data is dynamic, do not copy but free when done.
 918      */
 919     GNUNET_CONTAINER_SLIST_DISPOSITION_DYNAMIC = 4
 920   };
 921
 922
 923
 924 /**
 925  * Handle to a singly linked list
 926  */
 927 struct GNUNET_CONTAINER_SList;
 928
 929 /**
 930  * Handle to a singly linked list iterator
 931  */
 932 struct GNUNET_CONTAINER_SList_Iterator;
 933
 934
 935 /**
 936  * Add a new element to the list
 937  * @param l list
 938  * @param disp memory disposition
 939  * @param buf payload buffer
 940  * @param len length of the buffer
 941  */
 942 void GNUNET_CONTAINER_slist_add (struct GNUNET_CONTAINER_SList *l,
 943                                  enum GNUNET_CONTAINER_SListDisposition disp,
 944                                  const void *buf, size_t len);
 945
 946
 947 /**
 948  * Append a singly linked list to another
 949  * @param dst list to append to
 950  * @param src source
 951  */
 952 void
 953 GNUNET_CONTAINER_slist_append (struct GNUNET_CONTAINER_SList *dst, struct GNUNET_CONTAINER_SList *src);
 954
 955
 956 /**
 957  * Create a new singly linked list
 958  * @return the new list
 959  */
 960 struct GNUNET_CONTAINER_SList *GNUNET_CONTAINER_slist_create (void);
 961
 962
 963 /**
 964  * Destroy a singly linked list
 965  * @param l the list to be destroyed
 966  */
 967 void GNUNET_CONTAINER_slist_destroy (struct GNUNET_CONTAINER_SList *l);
 968
 969
 970 /**
 971  * Return the beginning of a list
 972  *
 973  * @param l list
 974  * @return iterator pointing to the beginning, free using "GNUNET_free"
 975  */
 976 struct GNUNET_CONTAINER_SList_Iterator *
 977 GNUNET_CONTAINER_slist_begin(struct GNUNET_CONTAINER_SList *l);
 978
 979
 980 /**
 981  * Clear a list
 982  *
 983  * @param l list
 984  */
 985 void GNUNET_CONTAINER_slist_clear (struct GNUNET_CONTAINER_SList *l);
 986
 987
 988 /**
 989  * Check if a list contains a certain element
 990  * @param l list
 991  * @param buf payload buffer to find
 992  * @param len length of the payload (number of bytes in buf)
 993  */
 994 int GNUNET_CONTAINER_slist_contains (const struct GNUNET_CONTAINER_SList *l, const void *buf, size_t len);
 995
 996
 997 /**
 998  * Count the elements of a list
 999  * @param l list
1000  * @return number of elements in the list
1001  */
1002 int GNUNET_CONTAINER_slist_count (const struct GNUNET_CONTAINER_SList *l);
1003
1004
1005 /**
1006  * Remove an element from the list
1007  * @param i iterator that points to the element to be removed
1008  */
1009 void GNUNET_CONTAINER_slist_erase (struct GNUNET_CONTAINER_SList_Iterator *i);
1010
1011
1012 /**
1013  * Insert an element into a list at a specific position
1014  * @param before where to insert the new element
1015  * @param disp memory disposition
1016  * @param buf payload buffer
1017  * @param len length of the payload
1018  */
1019 void GNUNET_CONTAINER_slist_insert (struct GNUNET_CONTAINER_SList_Iterator *before,
1020                                     enum GNUNET_CONTAINER_SListDisposition disp,
1021                                     const void *buf,
1022                                     size_t len);
1023
1024
1025 /**
1026  * Advance an iterator to the next element
1027  * @param i iterator
1028  * @return GNUNET_YES on success, GNUNET_NO if the end has been reached
1029  */
1030 int GNUNET_CONTAINER_slist_next (struct GNUNET_CONTAINER_SList_Iterator *i);
1031
1032
1033 /**
1034  * Check if an iterator points beyond the end of a list
1035  * @param i iterator
1036  * @return GNUNET_YES if the end has been reached, GNUNET_NO if the iterator
1037  *         points to a valid element
1038  */
1039 int GNUNET_CONTAINER_slist_end (struct GNUNET_CONTAINER_SList_Iterator *i);
1040
1041
1042 /**
1043  * Retrieve the element at a specific position in a list
1044  *
1045  * @param i iterator
1046  * @param len set to the payload length
1047  * @return payload
1048  */
1049 const void *
1050 GNUNET_CONTAINER_slist_get (const struct GNUNET_CONTAINER_SList_Iterator *i,
1051                             size_t *len);
1052
1053
1054 /**
1055  * Release an iterator
1056  * @param i iterator
1057  */
1058 void GNUNET_CONTAINER_slist_iter_destroy (struct GNUNET_CONTAINER_SList_Iterator *i);
1059
1060
1061 #if 0                           /* keep Emacsens' auto-indent happy */
1062 {
1063 #endif
1064 #ifdef __cplusplus
1065 }
1066 #endif
1067
1068
1069 /* ifndef GNUNET_CONTAINER_LIB_H */
1070 #endif
1071 /* end of gnunet_container_lib.h */