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