src/include/gnunet_container_lib.h

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2001, 2002, 2003, 2004, 2005, 2006, 2008, 2009 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  * Iterator over meta data.
 200  *
 201  * @param cls closure
 202  * @param type type of the meta data
 203  * @param data value of the meta data
 204  * @return GNUNET_OK to continue to iterate, GNUNET_SYSERR to abort
 205  */
 206 typedef int (*GNUNET_CONTAINER_MetaDataProcessor) (void *cls,
 207                                                    EXTRACTOR_KeywordType type,
 208                                                    const char *data);
 209
 210 /**
 211  * Create a fresh MetaData token.
 212  *
 213  * @return empty meta-data container
 214  */
 215 struct GNUNET_CONTAINER_MetaData *GNUNET_CONTAINER_meta_data_create (void);
 216
 217 /**
 218  * Duplicate a MetaData token.
 219  *
 220  * @param meta what to duplicate
 221  * @return duplicate meta-data container
 222  */
 223 struct GNUNET_CONTAINER_MetaData *GNUNET_CONTAINER_meta_data_duplicate (const
 224                                                                         struct
 225                                                                         GNUNET_CONTAINER_MetaData
 226                                                                         *meta);
 227
 228 /**
 229  * Free meta data.
 230  *
 231  * @param md what to free
 232  */
 233 void GNUNET_CONTAINER_meta_data_destroy (struct GNUNET_CONTAINER_MetaData
 234                                          *md);
 235
 236 /**
 237  * Test if two MDs are equal.
 238  *
 239  * @param md1 first value to check
 240  * @param md2 other value to check
 241  * @return GNUNET_YES if they are equal
 242  */
 243 int GNUNET_CONTAINER_meta_data_test_equal (const struct
 244                                            GNUNET_CONTAINER_MetaData *md1,
 245                                            const struct
 246                                            GNUNET_CONTAINER_MetaData *md2);
 247
 248
 249 /**
 250  * Extend metadata.
 251  *
 252  * @param md metadata to extend
 253  * @param type type of the new entry
 254  * @param data value for the entry
 255  * @return GNUNET_OK on success, GNUNET_SYSERR if this entry already exists
 256  */
 257 int GNUNET_CONTAINER_meta_data_insert (struct GNUNET_CONTAINER_MetaData *md,
 258                                        EXTRACTOR_KeywordType type,
 259                                        const char *data);
 260
 261 /**
 262  * Remove an item.
 263  *
 264  * @param type type of the item to remove
 265  * @param data specific value to remove, NULL to remove all
 266  *        entries of the given type
 267  * @return GNUNET_OK on success, GNUNET_SYSERR if the item does not exist in md
 268  */
 269 int GNUNET_CONTAINER_meta_data_delete (struct GNUNET_CONTAINER_MetaData *md,
 270                                        EXTRACTOR_KeywordType type,
 271                                        const char *data);
 272
 273 /**
 274  * Add the current time as the publication date
 275  * to the meta-data.
 276  *
 277  * @param md metadata to modify
 278  */
 279 void GNUNET_CONTAINER_meta_data_add_publication_date (struct
 280                                                       GNUNET_CONTAINER_MetaData
 281                                                       *md);
 282
 283 /**
 284  * Iterate over MD entries, excluding thumbnails.
 285  *
 286  * @param md metadata to inspect
 287  * @param iter function to call on each entry
 288  * @param iter_cls closure for iterator
 289  * @return number of entries
 290  */
 291 int GNUNET_CONTAINER_meta_data_get_contents (const struct
 292                                              GNUNET_CONTAINER_MetaData *md,
 293                                              GNUNET_CONTAINER_MetaDataProcessor
 294                                              iter, void *iter_cls);
 295
 296 /**
 297  * Get the first MD entry of the given type.
 298  *
 299  * @param md metadata to inspect
 300  * @param type type to look for
 301  * @return NULL if we do not have any such entry,
 302  *  otherwise client is responsible for freeing the value!
 303  */
 304 char *GNUNET_CONTAINER_meta_data_get_by_type (const struct
 305                                              GNUNET_CONTAINER_MetaData *md,
 306                                               EXTRACTOR_KeywordType type);
 307
 308 /**
 309  * Get the first matching MD entry of the given types.
 310  *
 311  * @param md metadata to inspect
 312  * @param ... -1-terminated list of types
 313  * @return NULL if we do not have any such entry,
 314  *  otherwise client is responsible for freeing the value!
 315  */
 316 char *GNUNET_CONTAINER_meta_data_get_first_by_types (const struct
 317                                                      GNUNET_CONTAINER_MetaData
 318                                                      *md, ...);
 319
 320 /**
 321  * Get a thumbnail from the meta-data (if present).
 322  *
 323  * @param md metadata to inspect
 324  * @param thumb will be set to the thumbnail data.  Must be
 325  *        freed by the caller!
 326  * @return number of bytes in thumbnail, 0 if not available
 327  */
 328 size_t GNUNET_CONTAINER_meta_data_get_thumbnail (const struct
 329                                                  GNUNET_CONTAINER_MetaData
 330                                                  *md, unsigned char **thumb);
 331
 332 /**
 333  * Extract meta-data from a file.
 334  *
 335  * @param md metadata to set
 336  * @param filename name of file to inspect
 337  * @param extractors plugins to use
 338  * @return GNUNET_SYSERR on error, otherwise the number
 339  *   of meta-data items obtained
 340  */
 341 int GNUNET_CONTAINER_meta_data_extract_from_file (struct
 342                                                   GNUNET_CONTAINER_MetaData
 343                                                   *md, const char *filename,
 344                                                   EXTRACTOR_ExtractorList *
 345                                                   extractors);
 346
 347
 348 /**
 349  * Options for metadata serialization.
 350  */
 351 enum GNUNET_CONTAINER_MetaDataSerializationOptions
 352 {
 353   /**
 354    * Serialize all of the data.
 355    */
 356   GNUNET_CONTAINER_META_DATA_SERIALIZE_FULL = 0,
 357
 358   /**
 359    * If not enough space is available, it is acceptable
 360    * to only serialize some of the metadata.
 361    */
 362   GNUNET_CONTAINER_META_DATA_SERIALIZE_PART = 1,
 363
 364   /**
 365    * Speed is of the essence, do not allow compression.
 366    */
 367   GNUNET_CONTAINER_META_DATA_SERIALIZE_NO_COMPRESS = 2
 368 };
 369
 370
 371 /**
 372  * Serialize meta-data to target.
 373  *
 374  * @param md metadata to serialize
 375  * @param size maximum number of bytes available
 376  * @param opt is it ok to just write SOME of the
 377  *        meta-data to match the size constraint,
 378  *        possibly discarding some data?
 379  * @return number of bytes written on success,
 380  *         -1 on error (typically: not enough
 381  *         space)
 382  */
 383 ssize_t GNUNET_CONTAINER_meta_data_serialize (const struct
 384                                               GNUNET_CONTAINER_MetaData *md,
 385                                               char *target,
 386                                               size_t size,
 387                                               enum
 388                                           GNUNET_CONTAINER_MetaDataSerializationOptions
 389                                           opt);
 390
 391 /**
 392  * Compute size of the meta-data in
 393  * serialized form.
 394  *
 395  * @param md metadata to inspect
 396  * @param opt is it ok to just write SOME of the
 397  *        meta-data to match the size constraint,
 398  *        possibly discarding some data?
 399  * @return number of bytes needed for serialization, -1 on error
 400  */
 401 ssize_t GNUNET_CONTAINER_meta_data_get_serialized_size (const struct
 402                                                         GNUNET_CONTAINER_MetaData
 403                                                         *md,
 404                                                         enum
 405                                                         GNUNET_CONTAINER_MetaDataSerializationOptions
 406                                                         opt);
 407
 408 /**
 409  * Deserialize meta-data.  Initializes md.
 410  *
 411  * @param input serialized meta-data.
 412  * @param size number of bytes available
 413  * @return MD on success, NULL on error (i.e.
 414  *         bad format)
 415  */
 416 struct GNUNET_CONTAINER_MetaData
 417   *GNUNET_CONTAINER_meta_data_deserialize (const char *input,
 418                                            size_t size);
 419
 420 /**
 421  * Does the meta-data claim that this is a directory?
 422  * Checks if the mime-type is that of a GNUnet directory.
 423  *
 424  * @param md metadata to inspect
 425  * @return GNUNET_YES if it is, GNUNET_NO if it is not, GNUNET_SYSERR if
 426  *  we have no mime-type information (treat as 'GNUNET_NO')
 427  */
 428 int GNUNET_CONTAINER_meta_data_test_for_directory (const struct
 429                                                    GNUNET_CONTAINER_MetaData
 430                                                    *md);
 431
 432
 433 /* ******************************* HashMap **************************** */
 434
 435 /**
 436  * Opaque handle for a HashMap.
 437  */
 438 struct GNUNET_CONTAINER_MultiHashMap;
 439
 440 /**
 441  * Options for storing values in the HashMap.
 442  */
 443 enum GNUNET_CONTAINER_MultiHashMapOption
 444 {
 445   /**
 446    * If a value with the given key exists, replace it.
 447    * Note that the old value would NOT be freed
 448    * by replace (the application has to make sure that
 449    * this happens if required).
 450    */
 451   GNUNET_CONTAINER_MULTIHASHMAPOPTION_REPLACE,
 452
 453   /**
 454    * Allow multiple values with the same key.
 455    */
 456   GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE,
 457
 458   /**
 459    * There must only be one value per key; storing
 460    * a value should fail if a value under the same
 461    * key already exists.
 462    */
 463   GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY,
 464
 465   /**
 466    * There must only be one value per key, but don't
 467    * bother checking if a value already exists
 468    * (faster than UNIQUE_ONLY; implemented just like
 469    * MULTIPLE but this option documents better what
 470    * is intended if UNIQUE is what is desired).
 471    */
 472   GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST
 473 };
 474
 475
 476 /**
 477  * Iterator over HashCodes.
 478  *
 479  * @param cls closure
 480  * @param key current key code
 481  * @param value value in the hash map
 482  * @return GNUNET_YES if we should continue to
 483  *         iterate,
 484  *         GNUNET_NO if not.
 485  */
 486 typedef int (*GNUNET_CONTAINER_HashMapIterator) (void *cls,
 487                                                  const GNUNET_HashCode * key,
 488                                                  void *value);
 489
 490
 491 /**
 492  * Create a multi hash map.
 493  *
 494  * @param len initial size (map will grow as needed)
 495  * @return NULL on error
 496  */
 497 struct GNUNET_CONTAINER_MultiHashMap
 498   *GNUNET_CONTAINER_multihashmap_create (unsigned int len);
 499
 500 /**
 501  * Destroy a hash map.  Will not free any values
 502  * stored in the hash map!
 503  *
 504  * @param map the map
 505  */
 506 void GNUNET_CONTAINER_multihashmap_destroy (struct
 507                                             GNUNET_CONTAINER_MultiHashMap
 508                                             *map);
 509
 510 /**
 511  * Given a key find a value in the
 512  * map matching the key.
 513  *
 514  * @param map the map
 515  * @param key what to look for
 516  * @return NULL if no value was found; note that
 517  *   this is indistinguishable from values that just
 518  *   happen to be NULL; use "contains" to test for
 519  *   key-value pairs with value NULL
 520  */
 521 void *GNUNET_CONTAINER_multihashmap_get (const struct
 522                                          GNUNET_CONTAINER_MultiHashMap *map,
 523                                          const GNUNET_HashCode * key);
 524
 525 /**
 526  * Remove the given key-value pair from the map.
 527  * Note that if the key-value pair is in the map
 528  * multiple times, only one of the pairs will be
 529  * removed.
 530  *
 531  * @param map the map
 532  * @param key key of the key-value pair
 533  * @param value value of the key-value pair
 534  * @return GNUNET_YES on success, GNUNET_NO if the key-value pair
 535  *  is not in the map
 536  */
 537 int GNUNET_CONTAINER_multihashmap_remove (struct GNUNET_CONTAINER_MultiHashMap
 538                                           *map, const GNUNET_HashCode * key,
 539                                           void *value);
 540
 541 /**
 542  * Remove all entries for the given key from the map.
 543  * Note that the values would not be "freed".
 544  *
 545  * @param map the map
 546  * @param key identifies values to be removed
 547  * @return number of values removed
 548  */
 549 int GNUNET_CONTAINER_multihashmap_remove_all (struct
 550                                               GNUNET_CONTAINER_MultiHashMap
 551                                               *map,
 552                                               const GNUNET_HashCode * key);
 553
 554 /**
 555  * Check if the map contains any value under the given
 556  * key (including values that are NULL).
 557  *
 558  * @param map the map
 559  * @param key the key to test if a value exists for it
 560  * @return GNUNET_YES if such a value exists,
 561  *         GNUNET_NO if not
 562  */
 563 int GNUNET_CONTAINER_multihashmap_contains (const struct
 564                                             GNUNET_CONTAINER_MultiHashMap
 565                                             *map,
 566                                             const GNUNET_HashCode * key);
 567
 568 /**
 569  * Store a key-value pair in the map.
 570  *
 571  * @param map the map
 572  * @param key key to use
 573  * @param value value to use
 574  * @param opt options for put
 575  * @return GNUNET_OK on success,
 576  *         GNUNET_NO if a value was replaced (with REPLACE)
 577  *         GNUNET_SYSERR if UNIQUE_ONLY was the option and the
 578  *                       value already exists
 579  */
 580 int GNUNET_CONTAINER_multihashmap_put (struct GNUNET_CONTAINER_MultiHashMap
 581                                        *map, const GNUNET_HashCode * key,
 582                                        void *value,
 583                                        enum
 584                                        GNUNET_CONTAINER_MultiHashMapOption
 585                                        opt);
 586
 587 /**
 588  * Get the number of key-value pairs in the map.
 589  *
 590  * @param map the map
 591  * @return the number of key value pairs
 592  */
 593 unsigned int GNUNET_CONTAINER_multihashmap_size (const struct
 594                                                  GNUNET_CONTAINER_MultiHashMap
 595                                                  *map);
 596
 597
 598 /**
 599  * Iterate over all entries in the map.
 600  *
 601  * @param map the map
 602  * @param iterator function to call on each entry
 603  * @param cls extra argument to it
 604  * @return the number of key value pairs processed,
 605  *         GNUNET_SYSERR if it aborted iteration
 606  */
 607 int GNUNET_CONTAINER_multihashmap_iterate (const struct
 608                                            GNUNET_CONTAINER_MultiHashMap *map,
 609                                            GNUNET_CONTAINER_HashMapIterator
 610                                            iterator, void *cls);
 611
 612 /**
 613  * Iterate over all entries in the map
 614  * that match a particular key.
 615  *
 616  * @param map the map
 617  * @param key key that the entries must correspond to
 618  * @param iterator function to call on each entry
 619  * @param cls extra argument to it
 620  * @return the number of key value pairs processed,
 621  *         GNUNET_SYSERR if it aborted iteration
 622  */
 623 int GNUNET_CONTAINER_multihashmap_get_multiple (const struct
 624                                                 GNUNET_CONTAINER_MultiHashMap
 625                                                 *map,
 626                                                 const GNUNET_HashCode * key,
 627                                                 GNUNET_CONTAINER_HashMapIterator
 628                                                 iterator, void *cls);
 629 /**
 630  * Returns the stored value of a random non-null entry
 631  * in the hash table.  Returns only the first value, does
 632  * not go inside bucket linked list (yet).  Runs with a
 633  * worst case time of N, so it's not efficient in any way
 634  * shape or form!!!!.
 635  */
 636 void *GNUNET_CONTAINER_multihashmap_get_random (const struct
 637                                                 GNUNET_CONTAINER_MultiHashMap
 638                                                 *map);
 639
 640
 641
 642
 643 /* ******************** doubly-linked list *************** */
 644
 645 /**
 646  * Insert an element into a DLL. Assumes
 647  * that head, tail and element are structs
 648  * with prev and next fields.
 649  *
 650  * @param head pointer to the head of the DLL
 651  * @param tail pointer to the tail of the DLL
 652  * @param element element to insert
 653  */
 654 #define GNUNET_CONTAINER_DLL_insert(head,tail,element) \
 655   (element)->next = (head); \
 656   (element)->prev = NULL; \
 657   if ((tail) == NULL) \
 658     (tail) = element; \
 659   else \
 660     (head)->prev = element; \
 661   (head) = (element);
 662
 663 /**
 664  * Insert an element into a DLL after the given other
 665  * element.  Insert at the head if the other
 666  * element is NULL.
 667  *
 668  * @param head pointer to the head of the DLL
 669  * @param tail pointer to the tail of the DLL
 670  * @param other prior element, NULL for insertion at head of DLL
 671  * @param element element to insert
 672  */
 673 #define GNUNET_CONTAINER_DLL_insert_after(head,tail,other,element) \
 674   (element)->prev = (other); \
 675   if (NULL == other) \
 676     { \
 677       (element)->next = (head); \
 678       (head) = (element); \
 679     } \
 680   else \
 681     { \
 682       (element)->next = (other)->next; \
 683       (other)->next = (element); \
 684     } \
 685   if (NULL == (element)->next) \
 686     (tail) = (element); \
 687   else \
 688     (element)->next->prev = (element);
 689
 690
 691
 692
 693 /**
 694  * Remove an element from a DLL. Assumes
 695  * that head, tail and element are structs
 696  * with prev and next fields.
 697  *
 698  * @param head pointer to the head of the DLL
 699  * @param tail pointer to the tail of the DLL
 700  * @param element element to remove
 701  */
 702 #define GNUNET_CONTAINER_DLL_remove(head,tail,element) \
 703   if ((element)->prev == NULL) \
 704     (head) = (element)->next;  \
 705   else \
 706     (element)->prev->next = (element)->next; \
 707   if ((element)->next == NULL) \
 708     (tail) = (element)->prev;  \
 709   else \
 710     (element)->next->prev = (element)->prev;
 711
 712
 713
 714 /* ******************** Heap *************** */
 715
 716
 717 /**
 718  * Cost by which elements in a heap can be ordered.
 719  */
 720 typedef uint64_t GNUNET_CONTAINER_HeapCost;
 721
 722
 723 /*
 724  * Heap type, either max or min.  Hopefully makes the
 725  * implementation more useful.
 726  */
 727 enum GNUNET_CONTAINER_HeapOrder
 728 {
 729   /**
 730    * Heap with the maximum cost at the root.
 731    */
 732   GNUNET_CONTAINER_HEAP_ORDER_MAX,
 733
 734   /**
 735    * Heap with the minimum cost at the root.
 736    */
 737   GNUNET_CONTAINER_HEAP_ORDER_MIN
 738 };
 739
 740
 741 /**
 742  * Handle to a Heap.
 743  */
 744 struct GNUNET_CONTAINER_Heap;
 745
 746 /**
 747  * Create a new heap.
 748  *
 749  * @param type should the minimum or the maximum element be the root
 750  * @return NULL on error, otherwise a fresh heap
 751  */
 752 struct GNUNET_CONTAINER_Heap *GNUNET_CONTAINER_heap_create (enum
 753                                                             GNUNET_CONTAINER_HeapOrder
 754                                                             type);
 755
 756
 757 /**
 758  * Free a heap
 759  *
 760  * @param h heap to free.
 761  */
 762 void GNUNET_CONTAINER_heap_destroy (struct GNUNET_CONTAINER_Heap *h);
 763
 764
 765 /**
 766  * Function called on elements of a heap.
 767  *
 768  * @param cls closure
 769  * @param element obj stored in heap
 770  * @param cost cost of the element
 771  * @return GNUNET_YES if we should continue to iterate,
 772  *         GNUNET_NO if not.
 773  */
 774 typedef int (*GNUNET_CONTAINER_HeapIterator) (void *cls,
 775                                               void *element,
 776                                               GNUNET_CONTAINER_HeapCost cost);
 777
 778
 779 /**
 780  * Iterate over all entries in the map.
 781  *
 782  * @param heap the heap
 783  * @param iterator function to call on each entry
 784  * @param iterator_cls closure for iterator
 785  * @return number of items handled
 786  *         GNUNET_SYSERR if iteration was aborted by iterator
 787  */
 788 int GNUNET_CONTAINER_heap_iterate (struct GNUNET_CONTAINER_Heap *heap,
 789                                    GNUNET_CONTAINER_HeapIterator iterator,
 790                                    void *iterator_cls);
 791
 792
 793
 794 /**
 795  * Inserts a new item into the heap, item is always neighbor now.
 796  * @param heap the heap
 797  * @param element element to insert
 798  * @param cost cost of the element
 799  * @return FIXME
 800  */
 801 int
 802 GNUNET_CONTAINER_heap_insert (struct GNUNET_CONTAINER_Heap *heap,
 803                               void *element, GNUNET_CONTAINER_HeapCost cost);
 804
 805
 806 /**
 807  * Removes root of the tree, is remove max if a max heap and remove min
 808  * if a min heap, returns the data stored at the node.
 809  *
 810  * @param heap the heap
 811  * @return NULL if the heap is empty
 812  */
 813 void *GNUNET_CONTAINER_heap_remove_root (struct GNUNET_CONTAINER_Heap *heap);
 814
 815
 816 /**
 817  * Returns element stored at root of tree, doesn't effect anything
 818  *
 819  * @param heap the heap
 820  * @return NULL if the heap is empty
 821  */
 822 void *GNUNET_CONTAINER_heap_peek (struct GNUNET_CONTAINER_Heap *heap);
 823
 824
 825 /**
 826  * Removes any node from the tree based on the neighbor given, does
 827  * not traverse the tree (backpointers) but may take more time due to
 828  * percolation of nodes.
 829  *
 830  * @param heap the heap
 831  * @param element the element to remove
 832  * @return NULL if "element" was not found in the heap, otherwise element
 833  */
 834 void *GNUNET_CONTAINER_heap_remove_node (struct GNUNET_CONTAINER_Heap *heap,
 835                                          void *element);
 836
 837
 838 /**
 839  * Updates the cost of any node in the tree
 840  *
 841  * @param heap the heap
 842  * @param element the element for which the cost is updated
 843  * @param new_cost new cost for the element
 844  * @return FIXME
 845  */
 846 int
 847 GNUNET_CONTAINER_heap_update_cost (struct GNUNET_CONTAINER_Heap *heap,
 848                                    void *element,
 849                                    GNUNET_CONTAINER_HeapCost new_cost);
 850
 851
 852 /**
 853  * Random walk of the tree, returns the data stored at the next random node
 854  * in the walk.  Calls callee with the data, or NULL if the tree is empty
 855  * or some other problem crops up.
 856  *
 857  * @param heap the heap
 858  * @return the next element from the random walk
 859  */
 860 void *GNUNET_CONTAINER_heap_walk_get_next (struct GNUNET_CONTAINER_Heap
 861                                            *heap);
 862
 863
 864 /**
 865  * Returns the current size of the heap
 866  *
 867  * @param heap the heap to get the size of
 868  * @return number of elements in the heap
 869  */
 870 unsigned int
 871 GNUNET_CONTAINER_heap_get_size (struct GNUNET_CONTAINER_Heap *heap);
 872
 873
 874
 875 #if 0                           /* keep Emacsens' auto-indent happy */
 876 {
 877 #endif
 878 #ifdef __cplusplus
 879 }
 880 #endif
 881
 882
 883 /* ifndef GNUNET_CONTAINER_LIB_H */
 884 #endif
 885 /* end of gnunet_container_lib.h */