2 This file is part of GNUnet.
3 (C) 2001, 2002, 2003, 2004, 2005, 2006, 2008, 2009, 2010 Christian Grothoff (and other contributing authors)
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.
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.
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.
22 * @file include/gnunet_container_lib.h
23 * @brief container classes for GNUnet
25 * @author Christian Grothoff
29 #ifndef GNUNET_CONTAINER_LIB_H
30 #define GNUNET_CONTAINER_LIB_H
32 /* add error and config prototypes */
33 #include "gnunet_crypto_lib.h"
34 #include <extractor.h>
36 #ifndef EXTRACTOR_METATYPE_GNUNET_ORIGINAL_FILENAME
37 /* hack for LE < 0.6.3 */
38 #define EXTRACTOR_METATYPE_GNUNET_ORIGINAL_FILENAME 180
44 #if 0 /* keep Emacsens' auto-indent happy */
50 /* ******************* bloomfilter ***************** */
53 * @brief bloomfilter representation (opaque)
55 struct GNUNET_CONTAINER_BloomFilter;
58 * Iterator over HashCodes.
61 * @param next set to the next hash code
62 * @return GNUNET_YES if next was updated
63 * GNUNET_NO if there are no more entries
65 typedef int (*GNUNET_HashCodeIterator) (void *cls,
66 GNUNET_HashCode * next);
69 * Load a bloom-filter from a file.
71 * @param filename the name of the file (or the prefix)
72 * @param size the size of the bloom-filter (number of
73 * bytes of storage space to use)
74 * @param k the number of GNUNET_CRYPTO_hash-functions to apply per
75 * element (number of bits set per element in the set)
76 * @return the bloomfilter
78 struct GNUNET_CONTAINER_BloomFilter *
79 GNUNET_CONTAINER_bloomfilter_load (const
89 * Create a bloom filter from raw bits.
91 * @param data the raw bits in memory (maybe NULL,
92 * in which case all bits should be considered
94 * @param size the size of the bloom-filter (number of
95 * bytes of storage space to use); also size of data
96 * -- unless data is NULL. Must be a power of 2.
97 * @param k the number of GNUNET_CRYPTO_hash-functions to apply per
98 * element (number of bits set per element in the set)
99 * @return the bloomfilter
101 struct GNUNET_CONTAINER_BloomFilter *
102 GNUNET_CONTAINER_bloomfilter_init (const
112 * Copy the raw data of this bloomfilter into
113 * the given data array.
115 * @param data where to write the data
116 * @param size the size of the given data array
117 * @return GNUNET_SYSERR if the data array of the wrong size
119 int GNUNET_CONTAINER_bloomfilter_get_raw_data (const struct
120 GNUNET_CONTAINER_BloomFilter
125 * Test if an element is in the filter.
126 * @param e the element
127 * @param bf the filter
128 * @return GNUNET_YES if the element is in the filter, GNUNET_NO if not
130 int GNUNET_CONTAINER_bloomfilter_test (const struct GNUNET_CONTAINER_BloomFilter
131 *bf, const GNUNET_HashCode * e);
134 * Add an element to the filter
135 * @param bf the filter
136 * @param e the element
138 void GNUNET_CONTAINER_bloomfilter_add (struct GNUNET_CONTAINER_BloomFilter
139 *bf, const GNUNET_HashCode * e);
142 * Remove an element from the filter.
143 * @param bf the filter
144 * @param e the element to remove
146 void GNUNET_CONTAINER_bloomfilter_remove (struct GNUNET_CONTAINER_BloomFilter
147 *bf, const GNUNET_HashCode * e);
150 * Free the space associcated with a filter
151 * in memory, flush to drive if needed (do not
152 * free the space on the drive)
153 * @param bf the filter
155 void GNUNET_CONTAINER_bloomfilter_free (struct GNUNET_CONTAINER_BloomFilter
160 * Get size of the bloom filter.
162 * @param bf the filter
163 * @return number of bytes used for the data of the bloom filter
166 GNUNET_CONTAINER_bloomfilter_get_size (const struct GNUNET_CONTAINER_BloomFilter
171 * Reset a bloom filter to empty.
172 * @param bf the filter
174 void GNUNET_CONTAINER_bloomfilter_clear (struct GNUNET_CONTAINER_BloomFilter
178 * Or the entries of the given raw data array with the
179 * data of the given bloom filter. Assumes that
180 * the size of the data array and the current filter
183 * @param bf the filter
184 * @param data data to OR-in
185 * @param size size of data
186 * @return GNUNET_OK on success
188 int GNUNET_CONTAINER_bloomfilter_or (struct GNUNET_CONTAINER_BloomFilter *bf,
189 const char *data, size_t size);
192 * Or the entries of the given raw data array with the
193 * data of the given bloom filter. Assumes that
194 * the size of the data array and the current filter
197 * @param bf the filter
198 * @param to_or the bloomfilter to or-in
199 * @param size number of bytes in data
202 GNUNET_CONTAINER_bloomfilter_or2 (struct GNUNET_CONTAINER_BloomFilter *bf,
203 const struct GNUNET_CONTAINER_BloomFilter *to_or,
207 * Resize a bloom filter. Note that this operation
208 * is pretty costly. Essentially, the bloom filter
209 * needs to be completely re-build.
211 * @param bf the filter
212 * @param iterator an iterator over all elements stored in the BF
213 * @param iterator_cls closure for iterator
214 * @param size the new size for the filter
215 * @param k the new number of GNUNET_CRYPTO_hash-function to apply per element
217 void GNUNET_CONTAINER_bloomfilter_resize (struct GNUNET_CONTAINER_BloomFilter
219 GNUNET_HashCodeIterator iterator,
221 size_t size, unsigned int k);
223 /* ****************** metadata ******************* */
226 * Meta data to associate with a file, directory or namespace.
228 struct GNUNET_CONTAINER_MetaData;
231 * Create a fresh MetaData token.
233 * @return empty meta-data container
235 struct GNUNET_CONTAINER_MetaData *
236 GNUNET_CONTAINER_meta_data_create (void);
239 * Duplicate a MetaData token.
241 * @param md what to duplicate
242 * @return duplicate meta-data container
244 struct GNUNET_CONTAINER_MetaData *
245 GNUNET_CONTAINER_meta_data_duplicate (const struct
246 GNUNET_CONTAINER_MetaData *md);
251 * @param md what to free
254 GNUNET_CONTAINER_meta_data_destroy (struct GNUNET_CONTAINER_MetaData *md);
257 * Test if two MDs are equal. We consider them equal if
258 * the meta types, formats and content match (we do not
259 * include the mime types and plugins names in this
262 * @param md1 first value to check
263 * @param md2 other value to check
264 * @return GNUNET_YES if they are equal
267 GNUNET_CONTAINER_meta_data_test_equal (const struct
268 GNUNET_CONTAINER_MetaData *md1,
270 GNUNET_CONTAINER_MetaData *md2);
276 * @param md metadata to extend
277 * @param plugin_name name of the plugin that produced this value;
278 * special values can be used (i.e. '<zlib>' for zlib being
279 * used in the main libextractor library and yielding
281 * @param type libextractor-type describing the meta data
282 * @param format basic format information about data
283 * @param data_mime_type mime-type of data (not of the original file);
284 * can be NULL (if mime-type is not known)
285 * @param data actual meta-data found
286 * @param data_len number of bytes in data
287 * @return GNUNET_OK on success, GNUNET_SYSERR if this entry already exists
288 * data_mime_type and plugin_name are not considered for "exists" checks
291 GNUNET_CONTAINER_meta_data_insert (struct GNUNET_CONTAINER_MetaData *md,
292 const char *plugin_name,
293 enum EXTRACTOR_MetaType type,
294 enum EXTRACTOR_MetaFormat format,
295 const char *data_mime_type,
301 * Extend metadata. Merges the meta data from the second argument
302 * into the first, discarding duplicate key-value pairs.
304 * @param md metadata to extend
305 * @param in metadata to merge
308 GNUNET_CONTAINER_meta_data_merge (struct GNUNET_CONTAINER_MetaData *md,
309 const struct GNUNET_CONTAINER_MetaData *in);
315 * @param md metadata to manipulate
316 * @param type type of the item to remove
317 * @param data specific value to remove, NULL to remove all
318 * entries of the given type
319 * @param data_len number of bytes in data
320 * @return GNUNET_OK on success, GNUNET_SYSERR if the item does not exist in md
323 GNUNET_CONTAINER_meta_data_delete (struct GNUNET_CONTAINER_MetaData *md,
324 enum EXTRACTOR_MetaType type,
330 * Remove all items in the container.
332 * @param md metadata to manipulate
335 GNUNET_CONTAINER_meta_data_clear (struct GNUNET_CONTAINER_MetaData *md);
339 * Add the current time as the publication date
342 * @param md metadata to modify
345 GNUNET_CONTAINER_meta_data_add_publication_date (struct
346 GNUNET_CONTAINER_MetaData
351 * Iterate over MD entries.
353 * @param md metadata to inspect
354 * @param iter function to call on each entry
355 * @param iter_cls closure for iterator
356 * @return number of entries
358 int GNUNET_CONTAINER_meta_data_iterate (const struct
359 GNUNET_CONTAINER_MetaData *md,
360 EXTRACTOR_MetaDataProcessor
361 iter, void *iter_cls);
364 * Get the first MD entry of the given type. Caller
365 * is responsible for freeing the return value.
366 * Also, only meta data items that are strings (0-terminated)
367 * are returned by this function.
369 * @param md metadata to inspect
370 * @param type type to look for
371 * @return NULL if no entry was found
374 GNUNET_CONTAINER_meta_data_get_by_type (const struct
375 GNUNET_CONTAINER_MetaData *md,
376 enum EXTRACTOR_MetaType type);
380 * Get the first matching MD entry of the given types. Caller is
381 * responsible for freeing the return value. Also, only meta data
382 * items that are strings (0-terminated) are returned by this
385 * @param md metadata to inspect
386 * @param ... -1-terminated list of types
387 * @return NULL if we do not have any such entry,
388 * otherwise client is responsible for freeing the value!
391 GNUNET_CONTAINER_meta_data_get_first_by_types (const struct
392 GNUNET_CONTAINER_MetaData
396 * Get a thumbnail from the meta-data (if present). Only matches meta
397 * data with mime type "image" and binary format.
399 * @param md metadata to inspect
400 * @param thumb will be set to the thumbnail data. Must be
401 * freed by the caller!
402 * @return number of bytes in thumbnail, 0 if not available
405 GNUNET_CONTAINER_meta_data_get_thumbnail (const struct
406 GNUNET_CONTAINER_MetaData
407 *md, unsigned char **thumb);
412 * Options for metadata serialization.
414 enum GNUNET_CONTAINER_MetaDataSerializationOptions
417 * Serialize all of the data.
419 GNUNET_CONTAINER_META_DATA_SERIALIZE_FULL = 0,
422 * If not enough space is available, it is acceptable
423 * to only serialize some of the metadata.
425 GNUNET_CONTAINER_META_DATA_SERIALIZE_PART = 1,
428 * Speed is of the essence, do not allow compression.
430 GNUNET_CONTAINER_META_DATA_SERIALIZE_NO_COMPRESS = 2
435 * Serialize meta-data to target.
437 * @param md metadata to serialize
438 * @param target where to write the serialized metadata;
439 * *target can be NULL, in which case memory is allocated
440 * @param max maximum number of bytes available
441 * @param opt is it ok to just write SOME of the
442 * meta-data to match the size constraint,
443 * possibly discarding some data?
444 * @return number of bytes written on success,
445 * -1 on error (typically: not enough
449 GNUNET_CONTAINER_meta_data_serialize (const struct
450 GNUNET_CONTAINER_MetaData *md,
454 GNUNET_CONTAINER_MetaDataSerializationOptions
459 * Get the size of the full meta-data in serialized form.
461 * @param md metadata to inspect
462 * @return number of bytes needed for serialization, -1 on error
465 GNUNET_CONTAINER_meta_data_get_serialized_size (const struct
466 GNUNET_CONTAINER_MetaData
471 * Deserialize meta-data. Initializes md.
473 * @param input serialized meta-data.
474 * @param size number of bytes available
475 * @return MD on success, NULL on error (i.e.
478 struct GNUNET_CONTAINER_MetaData *
479 GNUNET_CONTAINER_meta_data_deserialize (const char *input,
483 /* ******************************* HashMap **************************** */
486 * Opaque handle for a HashMap.
488 struct GNUNET_CONTAINER_MultiHashMap;
491 * Options for storing values in the HashMap.
493 enum GNUNET_CONTAINER_MultiHashMapOption
497 * If a value with the given key exists, replace it. Note that the
498 * old value would NOT be freed by replace (the application has to
499 * make sure that this happens if required).
501 GNUNET_CONTAINER_MULTIHASHMAPOPTION_REPLACE,
504 * Allow multiple values with the same key.
506 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE,
509 * There must only be one value per key; storing a value should fail
510 * if a value under the same key already exists.
512 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY,
515 * There must only be one value per key, but don't bother checking
516 * if a value already exists (faster than UNIQUE_ONLY; implemented
517 * just like MULTIPLE but this option documents better what is
518 * intended if UNIQUE is what is desired).
520 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST
525 * Iterator over hash map entries.
528 * @param key current key code
529 * @param value value in the hash map
530 * @return GNUNET_YES if we should continue to
534 typedef int (*GNUNET_CONTAINER_HashMapIterator) (void *cls,
535 const GNUNET_HashCode * key,
540 * Create a multi hash map.
542 * @param len initial size (map will grow as needed)
543 * @return NULL on error
545 struct GNUNET_CONTAINER_MultiHashMap
546 *GNUNET_CONTAINER_multihashmap_create (unsigned int len);
550 * Destroy a hash map. Will not free any values
551 * stored in the hash map!
555 void GNUNET_CONTAINER_multihashmap_destroy (struct
556 GNUNET_CONTAINER_MultiHashMap
561 * Given a key find a value in the map matching the key.
564 * @param key what to look for
565 * @return NULL if no value was found; note that
566 * this is indistinguishable from values that just
567 * happen to be NULL; use "contains" to test for
568 * key-value pairs with value NULL
570 void *GNUNET_CONTAINER_multihashmap_get (const struct
571 GNUNET_CONTAINER_MultiHashMap *map,
572 const GNUNET_HashCode * key);
576 * Remove the given key-value pair from the map. Note that if the
577 * key-value pair is in the map multiple times, only one of the pairs
581 * @param key key of the key-value pair
582 * @param value value of the key-value pair
583 * @return GNUNET_YES on success, GNUNET_NO if the key-value pair
586 int GNUNET_CONTAINER_multihashmap_remove (struct GNUNET_CONTAINER_MultiHashMap
587 *map, const GNUNET_HashCode * key,
591 * Remove all entries for the given key from the map.
592 * Note that the values would not be "freed".
595 * @param key identifies values to be removed
596 * @return number of values removed
598 int GNUNET_CONTAINER_multihashmap_remove_all (struct
599 GNUNET_CONTAINER_MultiHashMap
601 const GNUNET_HashCode * key);
605 * Check if the map contains any value under the given
606 * key (including values that are NULL).
609 * @param key the key to test if a value exists for it
610 * @return GNUNET_YES if such a value exists,
613 int GNUNET_CONTAINER_multihashmap_contains (const struct
614 GNUNET_CONTAINER_MultiHashMap
616 const GNUNET_HashCode * key);
620 * Store a key-value pair in the map.
623 * @param key key to use
624 * @param value value to use
625 * @param opt options for put
626 * @return GNUNET_OK on success,
627 * GNUNET_NO if a value was replaced (with REPLACE)
628 * GNUNET_SYSERR if UNIQUE_ONLY was the option and the
629 * value already exists
631 int GNUNET_CONTAINER_multihashmap_put (struct GNUNET_CONTAINER_MultiHashMap
632 *map, const GNUNET_HashCode * key,
635 GNUNET_CONTAINER_MultiHashMapOption
639 * Get the number of key-value pairs in the map.
642 * @return the number of key value pairs
644 unsigned int GNUNET_CONTAINER_multihashmap_size (const struct
645 GNUNET_CONTAINER_MultiHashMap
650 * Iterate over all entries in the map.
653 * @param it function to call on each entry
654 * @param it_cls extra argument to it
655 * @return the number of key value pairs processed,
656 * GNUNET_SYSERR if it aborted iteration
658 int GNUNET_CONTAINER_multihashmap_iterate (const struct
659 GNUNET_CONTAINER_MultiHashMap *map,
660 GNUNET_CONTAINER_HashMapIterator
665 * Iterate over all entries in the map that match a particular key.
668 * @param key key that the entries must correspond to
669 * @param it function to call on each entry
670 * @param it_cls extra argument to it
671 * @return the number of key value pairs processed,
672 * GNUNET_SYSERR if it aborted iteration
674 int GNUNET_CONTAINER_multihashmap_get_multiple (const struct
675 GNUNET_CONTAINER_MultiHashMap
677 const GNUNET_HashCode * key,
678 GNUNET_CONTAINER_HashMapIterator
682 /* ******************** doubly-linked list *************** */
685 * Insert an element at the head of a DLL. Assumes that head, tail and
686 * element are structs with prev and next fields.
688 * @param head pointer to the head of the DLL
689 * @param tail pointer to the tail of the DLL
690 * @param element element to insert
692 #define GNUNET_CONTAINER_DLL_insert(head,tail,element) do { \
693 (element)->next = (head); \
694 (element)->prev = NULL; \
695 if ((tail) == NULL) \
698 (head)->prev = element; \
699 (head) = (element); } while (0)
702 * Insert an element at the tail of a DLL. Assumes that head, tail and
703 * element are structs with prev and next fields.
705 * @param head pointer to the head of the DLL
706 * @param tail pointer to the tail of the DLL
707 * @param element element to insert
709 #define GNUNET_CONTAINER_DLL_insert_tail(head,tail,element) do { \
710 (element)->prev = (tail); \
711 (element)->next = NULL; \
712 if ((head) == NULL) \
715 (tail)->next = element; \
716 (tail) = (element); } while (0)
719 * Insert an element into a DLL after the given other element. Insert
720 * at the head if the other element is NULL.
722 * @param head pointer to the head of the DLL
723 * @param tail pointer to the tail of the DLL
724 * @param other prior element, NULL for insertion at head of DLL
725 * @param element element to insert
727 #define GNUNET_CONTAINER_DLL_insert_after(head,tail,other,element) do { \
728 (element)->prev = (other); \
731 (element)->next = (head); \
732 (head) = (element); \
736 (element)->next = (other)->next; \
737 (other)->next = (element); \
739 if (NULL == (element)->next) \
740 (tail) = (element); \
742 (element)->next->prev = (element); } while (0)
745 * Insert an element into a DLL before the given other element. Insert
746 * at the tail if the other element is NULL.
748 * @param head pointer to the head of the DLL
749 * @param tail pointer to the tail of the DLL
750 * @param other prior element, NULL for insertion at head of DLL
751 * @param element element to insert
753 #define GNUNET_CONTAINER_DLL_insert_before(head,tail,other,element) do { \
754 (element)->next = (other); \
757 (element)->prev = (tail); \
758 (tail) = (element); \
762 (element)->prev = (other)->prev; \
763 (other)->prev = (element); \
765 if (NULL == (element)->prev) \
766 (head) = (element); \
768 (element)->prev->next = (element); } while (0)
772 * Remove an element from a DLL. Assumes
773 * that head, tail and element are structs
774 * with prev and next fields.
776 * @param head pointer to the head of the DLL
777 * @param tail pointer to the tail of the DLL
778 * @param element element to remove
780 #define GNUNET_CONTAINER_DLL_remove(head,tail,element) do { \
781 if ((element)->prev == NULL) \
782 (head) = (element)->next; \
784 (element)->prev->next = (element)->next; \
785 if ((element)->next == NULL) \
786 (tail) = (element)->prev; \
788 (element)->next->prev = (element)->prev; \
789 (element)->next = NULL; \
790 (element)->prev = NULL; } while (0)
794 /* ******************** Heap *************** */
798 * Cost by which elements in a heap can be ordered.
800 typedef uint64_t GNUNET_CONTAINER_HeapCostType;
804 * Heap type, either max or min. Hopefully makes the
805 * implementation more useful.
807 enum GNUNET_CONTAINER_HeapOrder
810 * Heap with the maximum cost at the root.
812 GNUNET_CONTAINER_HEAP_ORDER_MAX,
815 * Heap with the minimum cost at the root.
817 GNUNET_CONTAINER_HEAP_ORDER_MIN
824 struct GNUNET_CONTAINER_Heap;
829 * Handle to a node in a heap.
831 struct GNUNET_CONTAINER_HeapNode;
837 * @param order how should the heap be sorted?
838 * @return handle to the heap
840 struct GNUNET_CONTAINER_Heap *
841 GNUNET_CONTAINER_heap_create (enum GNUNET_CONTAINER_HeapOrder order);
845 * Destroys the heap. Only call on a heap that
848 * @param heap heap to destroy
850 void GNUNET_CONTAINER_heap_destroy (struct GNUNET_CONTAINER_Heap *heap);
854 * Get element stored at root of heap.
856 * @param heap heap to inspect
857 * @return NULL if heap is empty
860 GNUNET_CONTAINER_heap_peek (const struct GNUNET_CONTAINER_Heap *heap);
864 * Get the current size of the heap
866 * @param heap the heap to get the size of
867 * @return number of elements stored
870 GNUNET_CONTAINER_heap_get_size (const struct GNUNET_CONTAINER_Heap *heap);
877 * @param node internal node of the heap
878 * @param element value stored at the node
879 * @param cost cost associated with the node
880 * @return GNUNET_YES if we should continue to iterate,
883 typedef int (*GNUNET_CONTAINER_HeapIterator) (void *cls,
884 struct GNUNET_CONTAINER_HeapNode *node,
886 GNUNET_CONTAINER_HeapCostType cost);
890 * Iterate over all entries in the heap.
892 * @param heap the heap
893 * @param iterator function to call on each entry
894 * @param iterator_cls closure for iterator
897 GNUNET_CONTAINER_heap_iterate (const struct GNUNET_CONTAINER_Heap *heap,
898 GNUNET_CONTAINER_HeapIterator iterator,
903 * Return a *uniform* random element from the heap. Choose a random
904 * number between 0 and heap size and then walk directly to it.
905 * This cost can be between 0 and n, amortized cost of logN.
907 * @param heap heap to choose random element from
908 * @param max how many nodes from the heap to choose from
910 * @return data stored at the chosen random node,
911 * NULL if the heap is empty.
915 GNUNET_CONTAINER_heap_get_random (struct GNUNET_CONTAINER_Heap *heap, uint32_t max);
918 * Perform a random walk of the tree. The walk is biased
919 * towards elements closer to the root of the tree (since
920 * each walk starts at the root and ends at a random leaf).
921 * The heap internally tracks the current position of the
924 * @param heap heap to walk
925 * @return data stored at the next random node in the walk;
926 * NULL if the tree is empty.
929 GNUNET_CONTAINER_heap_walk_get_next (struct GNUNET_CONTAINER_Heap *heap);
933 * Inserts a new element into the heap.
935 * @param heap heap to modify
936 * @param element element to insert
937 * @param cost cost for the element
938 * @return node for the new element
940 struct GNUNET_CONTAINER_HeapNode *
941 GNUNET_CONTAINER_heap_insert (struct GNUNET_CONTAINER_Heap *heap,
943 GNUNET_CONTAINER_HeapCostType cost);
947 * Remove root of the heap.
949 * @param heap heap to modify
950 * @return element data stored at the root node
953 GNUNET_CONTAINER_heap_remove_root (struct GNUNET_CONTAINER_Heap *heap);
957 * Removes a node from the heap.
959 * @param heap heap to modify
960 * @param node node to remove
961 * @return element data stored at the node, NULL if heap is empty
964 GNUNET_CONTAINER_heap_remove_node (struct GNUNET_CONTAINER_Heap *heap,
965 struct GNUNET_CONTAINER_HeapNode *node);
969 * Updates the cost of any node in the tree
971 * @param heap heap to modify
972 * @param node node for which the cost is to be changed
973 * @param new_cost new cost for the node
976 GNUNET_CONTAINER_heap_update_cost (struct GNUNET_CONTAINER_Heap *heap,
977 struct GNUNET_CONTAINER_HeapNode *node,
978 GNUNET_CONTAINER_HeapCostType new_cost);
981 /* ******************** Singly linked list *************** */
984 * Possible ways for how data stored in the linked list
985 * might be allocated.
987 enum GNUNET_CONTAINER_SListDisposition
990 * Single-linked list must copy the buffer.
992 GNUNET_CONTAINER_SLIST_DISPOSITION_TRANSIENT = 0,
995 * Data is static, no need to copy or free.
997 GNUNET_CONTAINER_SLIST_DISPOSITION_STATIC = 2,
1000 * Data is dynamic, do not copy but free when done.
1002 GNUNET_CONTAINER_SLIST_DISPOSITION_DYNAMIC = 4
1008 * Handle to a singly linked list
1010 struct GNUNET_CONTAINER_SList;
1013 * Handle to a singly linked list iterator
1015 struct GNUNET_CONTAINER_SList_Iterator;
1019 * Add a new element to the list
1021 * @param disp memory disposition
1022 * @param buf payload buffer
1023 * @param len length of the buffer
1025 void GNUNET_CONTAINER_slist_add (struct GNUNET_CONTAINER_SList *l,
1026 enum GNUNET_CONTAINER_SListDisposition disp,
1027 const void *buf, size_t len);
1031 * Add a new element to the end of the list
1033 * @param disp memory disposition
1034 * @param buf payload buffer
1035 * @param len length of the buffer
1037 void GNUNET_CONTAINER_slist_add_end (struct GNUNET_CONTAINER_SList *l,
1038 enum GNUNET_CONTAINER_SListDisposition disp,
1039 const void *buf, size_t len);
1043 * Append a singly linked list to another
1044 * @param dst list to append to
1048 GNUNET_CONTAINER_slist_append (struct GNUNET_CONTAINER_SList *dst, struct GNUNET_CONTAINER_SList *src);
1052 * Create a new singly linked list
1053 * @return the new list
1055 struct GNUNET_CONTAINER_SList *GNUNET_CONTAINER_slist_create (void);
1059 * Destroy a singly linked list
1060 * @param l the list to be destroyed
1062 void GNUNET_CONTAINER_slist_destroy (struct GNUNET_CONTAINER_SList *l);
1066 * Return the beginning of a list
1069 * @return iterator pointing to the beginning, free using "GNUNET_free"
1071 struct GNUNET_CONTAINER_SList_Iterator *
1072 GNUNET_CONTAINER_slist_begin(struct GNUNET_CONTAINER_SList *l);
1080 void GNUNET_CONTAINER_slist_clear (struct GNUNET_CONTAINER_SList *l);
1084 * Check if a list contains a certain element
1086 * @param buf payload buffer to find
1087 * @param len length of the payload (number of bytes in buf)
1089 int GNUNET_CONTAINER_slist_contains (const struct GNUNET_CONTAINER_SList *l, const void *buf, size_t len);
1093 * Count the elements of a list
1095 * @return number of elements in the list
1097 int GNUNET_CONTAINER_slist_count (const struct GNUNET_CONTAINER_SList *l);
1101 * Remove an element from the list
1102 * @param i iterator that points to the element to be removed
1104 void GNUNET_CONTAINER_slist_erase (struct GNUNET_CONTAINER_SList_Iterator *i);
1108 * Insert an element into a list at a specific position
1109 * @param before where to insert the new element
1110 * @param disp memory disposition
1111 * @param buf payload buffer
1112 * @param len length of the payload
1114 void GNUNET_CONTAINER_slist_insert (struct GNUNET_CONTAINER_SList_Iterator *before,
1115 enum GNUNET_CONTAINER_SListDisposition disp,
1121 * Advance an iterator to the next element
1123 * @return GNUNET_YES on success, GNUNET_NO if the end has been reached
1125 int GNUNET_CONTAINER_slist_next (struct GNUNET_CONTAINER_SList_Iterator *i);
1129 * Check if an iterator points beyond the end of a list
1131 * @return GNUNET_YES if the end has been reached, GNUNET_NO if the iterator
1132 * points to a valid element
1134 int GNUNET_CONTAINER_slist_end (struct GNUNET_CONTAINER_SList_Iterator *i);
1138 * Retrieve the element at a specific position in a list
1141 * @param len set to the payload length
1145 GNUNET_CONTAINER_slist_get (const struct GNUNET_CONTAINER_SList_Iterator *i,
1150 * Release an iterator
1153 void GNUNET_CONTAINER_slist_iter_destroy (struct GNUNET_CONTAINER_SList_Iterator *i);
1156 #if 0 /* keep Emacsens' auto-indent happy */
1164 /* ifndef GNUNET_CONTAINER_LIB_H */
1166 /* end of gnunet_container_lib.h */