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, struct 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); will be rounded up
75 * @param k the number of GNUNET_CRYPTO_hash-functions to apply per
76 * element (number of bits set per element in the set)
77 * @return the bloomfilter
79 struct GNUNET_CONTAINER_BloomFilter *
80 GNUNET_CONTAINER_bloomfilter_load (const char *filename, size_t size,
85 * Create a bloom filter from raw bits.
87 * @param data the raw bits in memory (maybe NULL,
88 * in which case all bits should be considered
90 * @param size the size of the bloom-filter (number of
91 * bytes of storage space to use); also size of data
92 * -- unless data is NULL. Must be a power of 2.
93 * @param k the number of GNUNET_CRYPTO_hash-functions to apply per
94 * element (number of bits set per element in the set)
95 * @return the bloomfilter
97 struct GNUNET_CONTAINER_BloomFilter *
98 GNUNET_CONTAINER_bloomfilter_init (const char *data, size_t size,
103 * Copy the raw data of this bloomfilter into
104 * the given data array.
106 * @param data where to write the data
107 * @param size the size of the given data array
108 * @return GNUNET_SYSERR if the data array of the wrong size
111 GNUNET_CONTAINER_bloomfilter_get_raw_data (const struct
112 GNUNET_CONTAINER_BloomFilter *bf,
113 char *data, size_t size);
117 * Test if an element is in the filter.
118 * @param e the element
119 * @param bf the filter
120 * @return GNUNET_YES if the element is in the filter, GNUNET_NO if not
123 GNUNET_CONTAINER_bloomfilter_test (const struct GNUNET_CONTAINER_BloomFilter
124 *bf, const struct GNUNET_HashCode * e);
128 * Add an element to the filter
129 * @param bf the filter
130 * @param e the element
133 GNUNET_CONTAINER_bloomfilter_add (struct GNUNET_CONTAINER_BloomFilter *bf,
134 const struct GNUNET_HashCode * e);
138 * Remove an element from the filter.
139 * @param bf the filter
140 * @param e the element to remove
143 GNUNET_CONTAINER_bloomfilter_remove (struct GNUNET_CONTAINER_BloomFilter *bf,
144 const struct GNUNET_HashCode * e);
148 * Create a copy of a bloomfilter.
150 * @param bf the filter
153 struct GNUNET_CONTAINER_BloomFilter *
154 GNUNET_CONTAINER_bloomfilter_copy (const struct GNUNET_CONTAINER_BloomFilter
160 * Free the space associcated with a filter
161 * in memory, flush to drive if needed (do not
162 * free the space on the drive)
163 * @param bf the filter
166 GNUNET_CONTAINER_bloomfilter_free (struct GNUNET_CONTAINER_BloomFilter *bf);
170 * Get size of the bloom filter.
172 * @param bf the filter
173 * @return number of bytes used for the data of the bloom filter
176 GNUNET_CONTAINER_bloomfilter_get_size (const struct GNUNET_CONTAINER_BloomFilter
181 * Reset a bloom filter to empty.
182 * @param bf the filter
185 GNUNET_CONTAINER_bloomfilter_clear (struct GNUNET_CONTAINER_BloomFilter *bf);
188 * Or the entries of the given raw data array with the
189 * data of the given bloom filter. Assumes that
190 * the size of the data array and the current filter
193 * @param bf the filter
194 * @param data data to OR-in
195 * @param size size of data
196 * @return GNUNET_OK on success
199 GNUNET_CONTAINER_bloomfilter_or (struct GNUNET_CONTAINER_BloomFilter *bf,
200 const char *data, size_t size);
203 * Or the entries of the given raw data array with the
204 * data of the given bloom filter. Assumes that
205 * the size of the data array and the current filter
208 * @param bf the filter
209 * @param to_or the bloomfilter to or-in
210 * @param size number of bytes in data
213 GNUNET_CONTAINER_bloomfilter_or2 (struct GNUNET_CONTAINER_BloomFilter *bf,
214 const struct GNUNET_CONTAINER_BloomFilter
215 *to_or, size_t size);
218 * Resize a bloom filter. Note that this operation
219 * is pretty costly. Essentially, the bloom filter
220 * needs to be completely re-build.
222 * @param bf the filter
223 * @param iterator an iterator over all elements stored in the BF
224 * @param iterator_cls closure for iterator
225 * @param size the new size for the filter
226 * @param k the new number of GNUNET_CRYPTO_hash-function to apply per element
229 GNUNET_CONTAINER_bloomfilter_resize (struct GNUNET_CONTAINER_BloomFilter *bf,
230 GNUNET_HashCodeIterator iterator,
231 void *iterator_cls, size_t size,
234 /* ****************** metadata ******************* */
237 * Meta data to associate with a file, directory or namespace.
239 struct GNUNET_CONTAINER_MetaData;
242 * Create a fresh MetaData token.
244 * @return empty meta-data container
246 struct GNUNET_CONTAINER_MetaData *
247 GNUNET_CONTAINER_meta_data_create (void);
250 * Duplicate a MetaData token.
252 * @param md what to duplicate
253 * @return duplicate meta-data container
255 struct GNUNET_CONTAINER_MetaData *
256 GNUNET_CONTAINER_meta_data_duplicate (const struct GNUNET_CONTAINER_MetaData
262 * @param md what to free
265 GNUNET_CONTAINER_meta_data_destroy (struct GNUNET_CONTAINER_MetaData *md);
268 * Test if two MDs are equal. We consider them equal if
269 * the meta types, formats and content match (we do not
270 * include the mime types and plugins names in this
273 * @param md1 first value to check
274 * @param md2 other value to check
275 * @return GNUNET_YES if they are equal
278 GNUNET_CONTAINER_meta_data_test_equal (const struct GNUNET_CONTAINER_MetaData
280 const struct GNUNET_CONTAINER_MetaData
287 * @param md metadata to extend
288 * @param plugin_name name of the plugin that produced this value;
289 * special values can be used (i.e. '<zlib>' for zlib being
290 * used in the main libextractor library and yielding
292 * @param type libextractor-type describing the meta data
293 * @param format basic format information about data
294 * @param data_mime_type mime-type of data (not of the original file);
295 * can be NULL (if mime-type is not known)
296 * @param data actual meta-data found
297 * @param data_size number of bytes in data
298 * @return GNUNET_OK on success, GNUNET_SYSERR if this entry already exists
299 * data_mime_type and plugin_name are not considered for "exists" checks
302 GNUNET_CONTAINER_meta_data_insert (struct GNUNET_CONTAINER_MetaData *md,
303 const char *plugin_name,
304 enum EXTRACTOR_MetaType type,
305 enum EXTRACTOR_MetaFormat format,
306 const char *data_mime_type, const char *data,
311 * Extend metadata. Merges the meta data from the second argument
312 * into the first, discarding duplicate key-value pairs.
314 * @param md metadata to extend
315 * @param in metadata to merge
318 GNUNET_CONTAINER_meta_data_merge (struct GNUNET_CONTAINER_MetaData *md,
319 const struct GNUNET_CONTAINER_MetaData *in);
325 * @param md metadata to manipulate
326 * @param type type of the item to remove
327 * @param data specific value to remove, NULL to remove all
328 * entries of the given type
329 * @param data_size number of bytes in data
330 * @return GNUNET_OK on success, GNUNET_SYSERR if the item does not exist in md
333 GNUNET_CONTAINER_meta_data_delete (struct GNUNET_CONTAINER_MetaData *md,
334 enum EXTRACTOR_MetaType type,
335 const char *data, size_t data_size);
339 * Remove all items in the container.
341 * @param md metadata to manipulate
344 GNUNET_CONTAINER_meta_data_clear (struct GNUNET_CONTAINER_MetaData *md);
348 * Add the current time as the publication date
351 * @param md metadata to modify
354 GNUNET_CONTAINER_meta_data_add_publication_date (struct
355 GNUNET_CONTAINER_MetaData *md);
359 * Iterate over MD entries.
361 * @param md metadata to inspect
362 * @param iter function to call on each entry
363 * @param iter_cls closure for iterator
364 * @return number of entries
367 GNUNET_CONTAINER_meta_data_iterate (const struct GNUNET_CONTAINER_MetaData *md,
368 EXTRACTOR_MetaDataProcessor iter,
372 * Get the first MD entry of the given type. Caller
373 * is responsible for freeing the return value.
374 * Also, only meta data items that are strings (0-terminated)
375 * are returned by this function.
377 * @param md metadata to inspect
378 * @param type type to look for
379 * @return NULL if no entry was found
382 GNUNET_CONTAINER_meta_data_get_by_type (const struct GNUNET_CONTAINER_MetaData
383 *md, enum EXTRACTOR_MetaType type);
387 * Get the first matching MD entry of the given types. Caller is
388 * responsible for freeing the return value. Also, only meta data
389 * items that are strings (0-terminated) are returned by this
392 * @param md metadata to inspect
393 * @param ... -1-terminated list of types
394 * @return NULL if we do not have any such entry,
395 * otherwise client is responsible for freeing the value!
398 GNUNET_CONTAINER_meta_data_get_first_by_types (const struct
399 GNUNET_CONTAINER_MetaData *md,
403 * Get a thumbnail from the meta-data (if present). Only matches meta
404 * data with mime type "image" and binary format.
406 * @param md metadata to inspect
407 * @param thumb will be set to the thumbnail data. Must be
408 * freed by the caller!
409 * @return number of bytes in thumbnail, 0 if not available
412 GNUNET_CONTAINER_meta_data_get_thumbnail (const struct GNUNET_CONTAINER_MetaData
413 *md, unsigned char **thumb);
418 * Options for metadata serialization.
420 enum GNUNET_CONTAINER_MetaDataSerializationOptions
423 * Serialize all of the data.
425 GNUNET_CONTAINER_META_DATA_SERIALIZE_FULL = 0,
428 * If not enough space is available, it is acceptable
429 * to only serialize some of the metadata.
431 GNUNET_CONTAINER_META_DATA_SERIALIZE_PART = 1,
434 * Speed is of the essence, do not allow compression.
436 GNUNET_CONTAINER_META_DATA_SERIALIZE_NO_COMPRESS = 2
441 * Serialize meta-data to target.
443 * @param md metadata to serialize
444 * @param target where to write the serialized metadata;
445 * *target can be NULL, in which case memory is allocated
446 * @param max maximum number of bytes available
447 * @param opt is it ok to just write SOME of the
448 * meta-data to match the size constraint,
449 * possibly discarding some data?
450 * @return number of bytes written on success,
451 * -1 on error (typically: not enough
455 GNUNET_CONTAINER_meta_data_serialize (const struct GNUNET_CONTAINER_MetaData
456 *md, char **target, size_t max,
458 GNUNET_CONTAINER_MetaDataSerializationOptions
463 * Get the size of the full meta-data in serialized form.
465 * @param md metadata to inspect
466 * @return number of bytes needed for serialization, -1 on error
469 GNUNET_CONTAINER_meta_data_get_serialized_size (const struct
470 GNUNET_CONTAINER_MetaData *md);
474 * Deserialize meta-data. Initializes md.
476 * @param input serialized meta-data.
477 * @param size number of bytes available
478 * @return MD on success, NULL on error (i.e.
481 struct GNUNET_CONTAINER_MetaData *
482 GNUNET_CONTAINER_meta_data_deserialize (const char *input, size_t size);
485 /* ******************************* HashMap **************************** */
488 * Opaque handle for a HashMap.
490 struct GNUNET_CONTAINER_MultiHashMap;
493 * Options for storing values in the HashMap.
495 enum GNUNET_CONTAINER_MultiHashMapOption
499 * If a value with the given key exists, replace it. Note that the
500 * old value would NOT be freed by replace (the application has to
501 * make sure that this happens if required).
503 GNUNET_CONTAINER_MULTIHASHMAPOPTION_REPLACE,
506 * Allow multiple values with the same key.
508 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE,
511 * There must only be one value per key; storing a value should fail
512 * if a value under the same key already exists.
514 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY,
517 * There must only be one value per key, but don't bother checking
518 * if a value already exists (faster than UNIQUE_ONLY; implemented
519 * just like MULTIPLE but this option documents better what is
520 * intended if UNIQUE is what is desired).
522 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST
527 * Iterator over hash map entries.
530 * @param key current key code
531 * @param value value in the hash map
532 * @return GNUNET_YES if we should continue to
536 typedef int (*GNUNET_CONTAINER_HashMapIterator) (void *cls,
537 const struct GNUNET_HashCode * key,
542 * Create a multi hash map.
544 * @param len initial size (map will grow as needed)
545 * @param do_not_copy_keys GNUNET_NO is always safe and should be used by default;
546 * GNUNET_YES means that on 'put', the 'key' does not have
547 * to be copied as the destination of the pointer is
548 * guaranteed to be life as long as the value is stored in
549 * the hashmap. This can significantly reduce memory
550 * consumption, but of course is also a recipie for
551 * heap corruption if the assumption is not true. Only
552 * use this if (1) memory use is important in this case and
553 * (2) you have triple-checked that the invariant holds
554 * @return NULL on error
556 struct GNUNET_CONTAINER_MultiHashMap *
557 GNUNET_CONTAINER_multihashmap_create (unsigned int len,
558 int do_not_copy_keys);
562 * Destroy a hash map. Will not free any values
563 * stored in the hash map!
568 GNUNET_CONTAINER_multihashmap_destroy (struct GNUNET_CONTAINER_MultiHashMap
573 * Given a key find a value in the map matching the key.
576 * @param key what to look for
577 * @return NULL if no value was found; note that
578 * this is indistinguishable from values that just
579 * happen to be NULL; use "contains" to test for
580 * key-value pairs with value NULL
583 GNUNET_CONTAINER_multihashmap_get (const struct GNUNET_CONTAINER_MultiHashMap
584 *map, const struct GNUNET_HashCode * key);
588 * Remove the given key-value pair from the map. Note that if the
589 * key-value pair is in the map multiple times, only one of the pairs
593 * @param key key of the key-value pair
594 * @param value value of the key-value pair
595 * @return GNUNET_YES on success, GNUNET_NO if the key-value pair
599 GNUNET_CONTAINER_multihashmap_remove (struct GNUNET_CONTAINER_MultiHashMap *map,
600 const struct GNUNET_HashCode * key, void *value);
603 * Remove all entries for the given key from the map.
604 * Note that the values would not be "freed".
607 * @param key identifies values to be removed
608 * @return number of values removed
611 GNUNET_CONTAINER_multihashmap_remove_all (struct GNUNET_CONTAINER_MultiHashMap
612 *map, const struct GNUNET_HashCode * key);
616 * Check if the map contains any value under the given
617 * key (including values that are NULL).
620 * @param key the key to test if a value exists for it
621 * @return GNUNET_YES if such a value exists,
625 GNUNET_CONTAINER_multihashmap_contains (const struct
626 GNUNET_CONTAINER_MultiHashMap *map,
627 const struct GNUNET_HashCode * key);
631 * Check if the map contains the given value under the given
635 * @param key the key to test if a value exists for it
636 * @param value value to test for
637 * @return GNUNET_YES if such a value exists,
641 GNUNET_CONTAINER_multihashmap_contains_value (const struct
642 GNUNET_CONTAINER_MultiHashMap
643 *map, const struct GNUNET_HashCode * key,
648 * Store a key-value pair in the map.
651 * @param key key to use
652 * @param value value to use
653 * @param opt options for put
654 * @return GNUNET_OK on success,
655 * GNUNET_NO if a value was replaced (with REPLACE)
656 * GNUNET_SYSERR if UNIQUE_ONLY was the option and the
657 * value already exists
660 GNUNET_CONTAINER_multihashmap_put (struct GNUNET_CONTAINER_MultiHashMap *map,
661 const struct GNUNET_HashCode * key, void *value,
662 enum GNUNET_CONTAINER_MultiHashMapOption
666 * Get the number of key-value pairs in the map.
669 * @return the number of key value pairs
672 GNUNET_CONTAINER_multihashmap_size (const struct GNUNET_CONTAINER_MultiHashMap
677 * Iterate over all entries in the map.
680 * @param it function to call on each entry
681 * @param it_cls extra argument to it
682 * @return the number of key value pairs processed,
683 * GNUNET_SYSERR if it aborted iteration
686 GNUNET_CONTAINER_multihashmap_iterate (const struct
687 GNUNET_CONTAINER_MultiHashMap *map,
688 GNUNET_CONTAINER_HashMapIterator it,
693 * Iterate over all entries in the map that match a particular key.
696 * @param key key that the entries must correspond to
697 * @param it function to call on each entry
698 * @param it_cls extra argument to it
699 * @return the number of key value pairs processed,
700 * GNUNET_SYSERR if it aborted iteration
703 GNUNET_CONTAINER_multihashmap_get_multiple (const struct
704 GNUNET_CONTAINER_MultiHashMap *map,
705 const struct GNUNET_HashCode * key,
706 GNUNET_CONTAINER_HashMapIterator it,
710 /* ******************** doubly-linked list *************** */
711 /* To avoid mistakes: head->prev == tail->next == NULL */
714 * Insert an element at the head of a DLL. Assumes that head, tail and
715 * element are structs with prev and next fields.
717 * @param head pointer to the head of the DLL
718 * @param tail pointer to the tail of the DLL
719 * @param element element to insert
721 #define GNUNET_CONTAINER_DLL_insert(head,tail,element) do { \
722 GNUNET_assert ( ( (element)->prev == NULL) && ((head) != (element))); \
723 GNUNET_assert ( ( (element)->next == NULL) && ((tail) != (element))); \
724 (element)->next = (head); \
725 (element)->prev = NULL; \
726 if ((tail) == NULL) \
729 (head)->prev = element; \
730 (head) = (element); } while (0)
734 * Insert an element at the tail of a DLL. Assumes that head, tail and
735 * element are structs with prev and next fields.
737 * @param head pointer to the head of the DLL
738 * @param tail pointer to the tail of the DLL
739 * @param element element to insert
741 #define GNUNET_CONTAINER_DLL_insert_tail(head,tail,element) do { \
742 GNUNET_assert ( ( (element)->prev == NULL) && ((head) != (element))); \
743 GNUNET_assert ( ( (element)->next == NULL) && ((tail) != (element))); \
744 (element)->prev = (tail); \
745 (element)->next = NULL; \
746 if ((head) == NULL) \
749 (tail)->next = element; \
750 (tail) = (element); } while (0)
754 * Insert an element into a DLL after the given other element. Insert
755 * at the head if the other element is NULL.
757 * @param head pointer to the head of the DLL
758 * @param tail pointer to the tail of the DLL
759 * @param other prior element, NULL for insertion at head of DLL
760 * @param element element to insert
762 #define GNUNET_CONTAINER_DLL_insert_after(head,tail,other,element) do { \
763 GNUNET_assert ( ( (element)->prev == NULL) && ((head) != (element))); \
764 GNUNET_assert ( ( (element)->next == NULL) && ((tail) != (element))); \
765 (element)->prev = (other); \
768 (element)->next = (head); \
769 (head) = (element); \
773 (element)->next = (other)->next; \
774 (other)->next = (element); \
776 if (NULL == (element)->next) \
777 (tail) = (element); \
779 (element)->next->prev = (element); } while (0)
783 * Insert an element into a DLL before the given other element. Insert
784 * at the tail if the other element is NULL.
786 * @param head pointer to the head of the DLL
787 * @param tail pointer to the tail of the DLL
788 * @param other prior element, NULL for insertion at head of DLL
789 * @param element element to insert
791 #define GNUNET_CONTAINER_DLL_insert_before(head,tail,other,element) do { \
792 GNUNET_assert ( ( (element)->prev == NULL) && ((head) != (element))); \
793 GNUNET_assert ( ( (element)->next == NULL) && ((tail) != (element))); \
794 (element)->next = (other); \
797 (element)->prev = (tail); \
798 (tail) = (element); \
802 (element)->prev = (other)->prev; \
803 (other)->prev = (element); \
805 if (NULL == (element)->prev) \
806 (head) = (element); \
808 (element)->prev->next = (element); } while (0)
812 * Remove an element from a DLL. Assumes
813 * that head, tail and element are structs
814 * with prev and next fields.
816 * @param head pointer to the head of the DLL
817 * @param tail pointer to the tail of the DLL
818 * @param element element to remove
820 #define GNUNET_CONTAINER_DLL_remove(head,tail,element) do { \
821 GNUNET_assert ( ( (element)->prev != NULL) || ((head) == (element))); \
822 GNUNET_assert ( ( (element)->next != NULL) || ((tail) == (element))); \
823 if ((element)->prev == NULL) \
824 (head) = (element)->next; \
826 (element)->prev->next = (element)->next; \
827 if ((element)->next == NULL) \
828 (tail) = (element)->prev; \
830 (element)->next->prev = (element)->prev; \
831 (element)->next = NULL; \
832 (element)->prev = NULL; } while (0)
835 /* ************ Multi-DLL interface, allows DLL elements to be
836 in multiple lists at the same time *********************** */
839 * Insert an element at the head of a MDLL. Assumes that head, tail and
840 * element are structs with prev and next fields.
842 * @param mdll suffix name for the next and prev pointers in the element
843 * @param head pointer to the head of the MDLL
844 * @param tail pointer to the tail of the MDLL
845 * @param element element to insert
847 #define GNUNET_CONTAINER_MDLL_insert(mdll,head,tail,element) do { \
848 GNUNET_assert ( ( (element)->prev_##mdll == NULL) && ((head) != (element))); \
849 GNUNET_assert ( ( (element)->next_##mdll == NULL) && ((tail) != (element))); \
850 (element)->next_##mdll = (head); \
851 (element)->prev_##mdll = NULL; \
852 if ((tail) == NULL) \
855 (head)->prev_##mdll = element; \
856 (head) = (element); } while (0)
860 * Insert an element at the tail of a MDLL. Assumes that head, tail and
861 * element are structs with prev and next fields.
863 * @param mdll suffix name for the next and prev pointers in the element
864 * @param head pointer to the head of the MDLL
865 * @param tail pointer to the tail of the MDLL
866 * @param element element to insert
868 #define GNUNET_CONTAINER_MDLL_insert_tail(mdll,head,tail,element) do { \
869 GNUNET_assert ( ( (element)->prev_##mdll == NULL) && ((head) != (element))); \
870 GNUNET_assert ( ( (element)->next_##mdll == NULL) && ((tail) != (element))); \
871 (element)->prev_##mdll = (tail); \
872 (element)->next_##mdll = NULL; \
873 if ((head) == NULL) \
876 (tail)->next_##mdll = element; \
877 (tail) = (element); } while (0)
881 * Insert an element into a MDLL after the given other element. Insert
882 * at the head if the other element is NULL.
884 * @param mdll suffix name for the next and prev pointers in the element
885 * @param head pointer to the head of the MDLL
886 * @param tail pointer to the tail of the MDLL
887 * @param other prior element, NULL for insertion at head of MDLL
888 * @param element element to insert
890 #define GNUNET_CONTAINER_MDLL_insert_after(mdll,head,tail,other,element) do { \
891 GNUNET_assert ( ( (element)->prev_##mdll == NULL) && ((head) != (element))); \
892 GNUNET_assert ( ( (element)->next_##mdll == NULL) && ((tail) != (element))); \
893 (element)->prev_##mdll = (other); \
896 (element)->next_##mdll = (head); \
897 (head) = (element); \
901 (element)->next_##mdll = (other)->next_##mdll; \
902 (other)->next_##mdll = (element); \
904 if (NULL == (element)->next_##mdll) \
905 (tail) = (element); \
907 (element)->next->prev_##mdll = (element); } while (0)
911 * Insert an element into a MDLL before the given other element. Insert
912 * at the tail if the other element is NULL.
914 * @param mdll suffix name for the next and prev pointers in the element
915 * @param head pointer to the head of the MDLL
916 * @param tail pointer to the tail of the MDLL
917 * @param other prior element, NULL for insertion at head of MDLL
918 * @param element element to insert
920 #define GNUNET_CONTAINER_MDLL_insert_before(mdll,head,tail,other,element) do { \
921 GNUNET_assert ( ( (element)->prev_##mdll == NULL) && ((head) != (element))); \
922 GNUNET_assert ( ( (element)->next_##mdll == NULL) && ((tail) != (element))); \
923 (element)->next_##mdll = (other); \
926 (element)->prev = (tail); \
927 (tail) = (element); \
931 (element)->prev_##mdll = (other)->prev_##mdll; \
932 (other)->prev_##mdll = (element); \
934 if (NULL == (element)->prev_##mdll) \
935 (head) = (element); \
937 (element)->prev_##mdll->next_##mdll = (element); } while (0)
941 * Remove an element from a MDLL. Assumes
942 * that head, tail and element are structs
943 * with prev and next fields.
945 * @param mdll suffix name for the next and prev pointers in the element
946 * @param head pointer to the head of the MDLL
947 * @param tail pointer to the tail of the MDLL
948 * @param element element to remove
950 #define GNUNET_CONTAINER_MDLL_remove(mdll,head,tail,element) do { \
951 GNUNET_assert ( ( (element)->prev_##mdll != NULL) || ((head) == (element))); \
952 GNUNET_assert ( ( (element)->next_##mdll != NULL) || ((tail) == (element))); \
953 if ((element)->prev_##mdll == NULL) \
954 (head) = (element)->next_##mdll; \
956 (element)->prev_##mdll->next_##mdll = (element)->next_##mdll; \
957 if ((element)->next_##mdll == NULL) \
958 (tail) = (element)->prev_##mdll; \
960 (element)->next_##mdll->prev_##mdll = (element)->prev_##mdll; \
961 (element)->next_##mdll = NULL; \
962 (element)->prev_##mdll = NULL; } while (0)
966 /* ******************** Heap *************** */
970 * Cost by which elements in a heap can be ordered.
972 typedef uint64_t GNUNET_CONTAINER_HeapCostType;
976 * Heap type, either max or min. Hopefully makes the
977 * implementation more useful.
979 enum GNUNET_CONTAINER_HeapOrder
982 * Heap with the maximum cost at the root.
984 GNUNET_CONTAINER_HEAP_ORDER_MAX,
987 * Heap with the minimum cost at the root.
989 GNUNET_CONTAINER_HEAP_ORDER_MIN
996 struct GNUNET_CONTAINER_Heap;
1001 * Handle to a node in a heap.
1003 struct GNUNET_CONTAINER_HeapNode;
1007 * Create a new heap.
1009 * @param order how should the heap be sorted?
1010 * @return handle to the heap
1012 struct GNUNET_CONTAINER_Heap *
1013 GNUNET_CONTAINER_heap_create (enum GNUNET_CONTAINER_HeapOrder order);
1017 * Destroys the heap. Only call on a heap that
1020 * @param heap heap to destroy
1023 GNUNET_CONTAINER_heap_destroy (struct GNUNET_CONTAINER_Heap *heap);
1027 * Get element stored at root of heap.
1029 * @param heap heap to inspect
1030 * @return NULL if heap is empty
1033 GNUNET_CONTAINER_heap_peek (const struct GNUNET_CONTAINER_Heap *heap);
1037 * Get the current size of the heap
1039 * @param heap the heap to get the size of
1040 * @return number of elements stored
1043 GNUNET_CONTAINER_heap_get_size (const struct GNUNET_CONTAINER_Heap *heap);
1047 * Get the current cost of the node
1049 * @param node the node to get the cost of
1050 * @return cost of the node
1052 GNUNET_CONTAINER_HeapCostType
1053 GNUNET_CONTAINER_heap_node_get_cost (const struct GNUNET_CONTAINER_HeapNode
1059 * @param cls closure
1060 * @param node internal node of the heap
1061 * @param element value stored at the node
1062 * @param cost cost associated with the node
1063 * @return GNUNET_YES if we should continue to iterate,
1066 typedef int (*GNUNET_CONTAINER_HeapIterator) (void *cls,
1067 struct GNUNET_CONTAINER_HeapNode *
1068 node, void *element,
1069 GNUNET_CONTAINER_HeapCostType
1074 * Iterate over all entries in the heap.
1076 * @param heap the heap
1077 * @param iterator function to call on each entry
1078 * @param iterator_cls closure for iterator
1081 GNUNET_CONTAINER_heap_iterate (const struct GNUNET_CONTAINER_Heap *heap,
1082 GNUNET_CONTAINER_HeapIterator iterator,
1083 void *iterator_cls);
1086 * Perform a random walk of the tree. The walk is biased
1087 * towards elements closer to the root of the tree (since
1088 * each walk starts at the root and ends at a random leaf).
1089 * The heap internally tracks the current position of the
1092 * @param heap heap to walk
1093 * @return data stored at the next random node in the walk;
1094 * NULL if the tree is empty.
1097 GNUNET_CONTAINER_heap_walk_get_next (struct GNUNET_CONTAINER_Heap *heap);
1101 * Inserts a new element into the heap.
1103 * @param heap heap to modify
1104 * @param element element to insert
1105 * @param cost cost for the element
1106 * @return node for the new element
1108 struct GNUNET_CONTAINER_HeapNode *
1109 GNUNET_CONTAINER_heap_insert (struct GNUNET_CONTAINER_Heap *heap, void *element,
1110 GNUNET_CONTAINER_HeapCostType cost);
1114 * Remove root of the heap.
1116 * @param heap heap to modify
1117 * @return element data stored at the root node
1120 GNUNET_CONTAINER_heap_remove_root (struct GNUNET_CONTAINER_Heap *heap);
1124 * Removes a node from the heap.
1126 * @param node node to remove
1127 * @return element data stored at the node, NULL if heap is empty
1130 GNUNET_CONTAINER_heap_remove_node (struct GNUNET_CONTAINER_HeapNode *node);
1134 * Updates the cost of any node in the tree
1136 * @param heap heap to modify
1137 * @param node node for which the cost is to be changed
1138 * @param new_cost new cost for the node
1141 GNUNET_CONTAINER_heap_update_cost (struct GNUNET_CONTAINER_Heap *heap,
1142 struct GNUNET_CONTAINER_HeapNode *node,
1143 GNUNET_CONTAINER_HeapCostType new_cost);
1146 /* ******************** Singly linked list *************** */
1149 * Possible ways for how data stored in the linked list
1150 * might be allocated.
1152 enum GNUNET_CONTAINER_SListDisposition
1155 * Single-linked list must copy the buffer.
1157 GNUNET_CONTAINER_SLIST_DISPOSITION_TRANSIENT = 0,
1160 * Data is static, no need to copy or free.
1162 GNUNET_CONTAINER_SLIST_DISPOSITION_STATIC = 2,
1165 * Data is dynamic, do not copy but free when done.
1167 GNUNET_CONTAINER_SLIST_DISPOSITION_DYNAMIC = 4
1173 * Handle to a singly linked list
1175 struct GNUNET_CONTAINER_SList;
1178 * Handle to a singly linked list iterator
1180 struct GNUNET_CONTAINER_SList_Iterator
1183 * Linked list that we are iterating over.
1185 struct GNUNET_CONTAINER_SList *list;
1188 * Last element accessed.
1190 struct GNUNET_CONTAINER_SList_Elem *last;
1193 * Current list element.
1195 struct GNUNET_CONTAINER_SList_Elem *elem;
1201 * Add a new element to the list
1203 * @param disp memory disposition
1204 * @param buf payload buffer
1205 * @param len length of the buffer
1208 GNUNET_CONTAINER_slist_add (struct GNUNET_CONTAINER_SList *l,
1209 enum GNUNET_CONTAINER_SListDisposition disp,
1210 const void *buf, size_t len);
1214 * Add a new element to the end of the list
1216 * @param disp memory disposition
1217 * @param buf payload buffer
1218 * @param len length of the buffer
1221 GNUNET_CONTAINER_slist_add_end (struct GNUNET_CONTAINER_SList *l,
1222 enum GNUNET_CONTAINER_SListDisposition disp,
1223 const void *buf, size_t len);
1227 * Append a singly linked list to another
1228 * @param dst list to append to
1232 GNUNET_CONTAINER_slist_append (struct GNUNET_CONTAINER_SList *dst,
1233 struct GNUNET_CONTAINER_SList *src);
1237 * Create a new singly linked list
1238 * @return the new list
1240 struct GNUNET_CONTAINER_SList *
1241 GNUNET_CONTAINER_slist_create (void);
1245 * Destroy a singly linked list
1246 * @param l the list to be destroyed
1249 GNUNET_CONTAINER_slist_destroy (struct GNUNET_CONTAINER_SList *l);
1253 * Return the beginning of a list
1256 * @return iterator pointing to the beginning (by value! Either allocate the
1257 * structure on the stack, or use GNUNET_malloc() yourself! All other
1258 * functions do take pointer to this struct though)
1260 struct GNUNET_CONTAINER_SList_Iterator
1261 GNUNET_CONTAINER_slist_begin (struct GNUNET_CONTAINER_SList *l);
1270 GNUNET_CONTAINER_slist_clear (struct GNUNET_CONTAINER_SList *l);
1274 * Check if a list contains a certain element
1276 * @param buf payload buffer to find
1277 * @param len length of the payload (number of bytes in buf)
1279 * @return GNUNET_YES if found, GNUNET_NO otherwise
1282 GNUNET_CONTAINER_slist_contains (const struct GNUNET_CONTAINER_SList *l,
1283 const void *buf, size_t len);
1286 * Check if a list contains a certain element using 'compare' function
1289 * @param buf payload buffer to find
1290 * @param len length of the payload (number of bytes in buf)
1291 * @param compare comparison function
1293 * @return NULL if the 'buf' could not be found, pointer to the
1294 * list element, if found
1297 GNUNET_CONTAINER_slist_contains2 (const struct GNUNET_CONTAINER_SList *l,
1298 const void *buf, size_t len,
1299 int (*compare)(const void *, const size_t, const void *, const size_t));
1301 * Count the elements of a list
1303 * @return number of elements in the list
1306 GNUNET_CONTAINER_slist_count (const struct GNUNET_CONTAINER_SList *l);
1310 * Remove an element from the list
1311 * @param i iterator that points to the element to be removed
1314 GNUNET_CONTAINER_slist_erase (struct GNUNET_CONTAINER_SList_Iterator *i);
1318 * Insert an element into a list at a specific position
1319 * @param before where to insert the new element
1320 * @param disp memory disposition
1321 * @param buf payload buffer
1322 * @param len length of the payload
1325 GNUNET_CONTAINER_slist_insert (struct GNUNET_CONTAINER_SList_Iterator *before,
1326 enum GNUNET_CONTAINER_SListDisposition disp,
1327 const void *buf, size_t len);
1331 * Advance an iterator to the next element
1333 * @return GNUNET_YES on success, GNUNET_NO if the end has been reached
1336 GNUNET_CONTAINER_slist_next (struct GNUNET_CONTAINER_SList_Iterator *i);
1340 * Check if an iterator points beyond the end of a list
1342 * @return GNUNET_YES if the end has been reached, GNUNET_NO if the iterator
1343 * points to a valid element
1346 GNUNET_CONTAINER_slist_end (struct GNUNET_CONTAINER_SList_Iterator *i);
1350 * Retrieve the element at a specific position in a list
1353 * @param len set to the payload length
1357 GNUNET_CONTAINER_slist_get (const struct GNUNET_CONTAINER_SList_Iterator *i,
1362 * Release an iterator
1366 GNUNET_CONTAINER_slist_iter_destroy (struct GNUNET_CONTAINER_SList_Iterator *i);
1369 #if 0 /* keep Emacsens' auto-indent happy */
1377 /* ifndef GNUNET_CONTAINER_LIB_H */
1379 /* end of gnunet_container_lib.h */