2 This file is part of GNUnet.
3 (C) 2001, 2002, 2003, 2004, 2005, 2006, 2008, 2009 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>
39 #if 0 /* keep Emacsens' auto-indent happy */
45 /* ******************* bloomfilter ***************** */
48 * @brief bloomfilter representation (opaque)
50 struct GNUNET_CONTAINER_BloomFilter;
53 * Iterator over HashCodes.
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
60 typedef int (*GNUNET_HashCodeIterator) (void *cls,
61 GNUNET_HashCode * next);
64 * Load a bloom-filter from a file.
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
73 struct GNUNET_CONTAINER_BloomFilter *GNUNET_CONTAINER_bloomfilter_load (const
84 * Create a bloom filter from raw bits.
86 * @param data the raw bits in memory (maybe NULL,
87 * in which case all bits should be considered
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
96 struct GNUNET_CONTAINER_BloomFilter *GNUNET_CONTAINER_bloomfilter_init (const
107 * Copy the raw data of this bloomfilter into
108 * the given data array.
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
114 int GNUNET_CONTAINER_bloomfilter_get_raw_data (struct
115 GNUNET_CONTAINER_BloomFilter
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
125 int GNUNET_CONTAINER_bloomfilter_test (struct GNUNET_CONTAINER_BloomFilter
126 *bf, const GNUNET_HashCode * e);
129 * Add an element to the filter
130 * @param bf the filter
131 * @param e the element
133 void GNUNET_CONTAINER_bloomfilter_add (struct GNUNET_CONTAINER_BloomFilter
134 *bf, const GNUNET_HashCode * e);
137 * Remove an element from the filter.
138 * @param bf the filter
139 * @param e the element to remove
141 void GNUNET_CONTAINER_bloomfilter_remove (struct GNUNET_CONTAINER_BloomFilter
142 *bf, const GNUNET_HashCode * e);
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
150 void GNUNET_CONTAINER_bloomfilter_free (struct GNUNET_CONTAINER_BloomFilter
154 * Reset a bloom filter to empty.
155 * @param bf the filter
157 void GNUNET_CONTAINER_bloomfilter_clear (struct GNUNET_CONTAINER_BloomFilter
161 * Or the entries of the given raw data array with the
162 * data of the given bloom filter. Assumes that
163 * the size of the data array and the current filter
166 * @param bf the filter
167 * @param data data to OR-in
168 * @param size size of data
169 * @return GNUNET_OK on success
171 int GNUNET_CONTAINER_bloomfilter_or (struct GNUNET_CONTAINER_BloomFilter *bf,
172 const char *data, unsigned int size);
175 * Resize a bloom filter. Note that this operation
176 * is pretty costly. Essentially, the bloom filter
177 * needs to be completely re-build.
179 * @param bf the filter
180 * @param iterator an iterator over all elements stored in the BF
181 * @param iterator_cls closure for iterator
182 * @param size the new size for the filter
183 * @param k the new number of GNUNET_CRYPTO_hash-function to apply per element
185 void GNUNET_CONTAINER_bloomfilter_resize (struct GNUNET_CONTAINER_BloomFilter
187 GNUNET_HashCodeIterator iterator,
189 unsigned int size, unsigned int k);
191 /* ****************** metadata ******************* */
194 * Meta data to associate with a file, directory or namespace.
196 struct GNUNET_CONTAINER_MetaData;
199 * Iterator over meta data.
202 * @param type type of the meta data
203 * @param data value of the meta data
204 * @return GNUNET_OK to continue to iterate, GNUNET_SYSERR to abort
206 typedef int (*GNUNET_CONTAINER_MetaDataProcessor) (void *cls,
207 EXTRACTOR_KeywordType type,
211 * Create a fresh MetaData token.
213 * @return empty meta-data container
215 struct GNUNET_CONTAINER_MetaData *GNUNET_CONTAINER_meta_data_create (void);
218 * Duplicate a MetaData token.
220 * @param meta what to duplicate
221 * @return duplicate meta-data container
223 struct GNUNET_CONTAINER_MetaData *GNUNET_CONTAINER_meta_data_duplicate (const
225 GNUNET_CONTAINER_MetaData
231 * @param md what to free
233 void GNUNET_CONTAINER_meta_data_destroy (struct GNUNET_CONTAINER_MetaData
237 * Test if two MDs are equal.
239 * @param md1 first value to check
240 * @param md2 other value to check
241 * @return GNUNET_YES if they are equal
243 int GNUNET_CONTAINER_meta_data_test_equal (const struct
244 GNUNET_CONTAINER_MetaData *md1,
246 GNUNET_CONTAINER_MetaData *md2);
252 * @param md metadata to extend
253 * @param type type of the new entry
254 * @param data value for the entry
255 * @return GNUNET_OK on success, GNUNET_SYSERR if this entry already exists
257 int GNUNET_CONTAINER_meta_data_insert (struct GNUNET_CONTAINER_MetaData *md,
258 EXTRACTOR_KeywordType type,
264 * @param type type of the item to remove
265 * @param data specific value to remove, NULL to remove all
266 * entries of the given type
267 * @return GNUNET_OK on success, GNUNET_SYSERR if the item does not exist in md
269 int GNUNET_CONTAINER_meta_data_delete (struct GNUNET_CONTAINER_MetaData *md,
270 EXTRACTOR_KeywordType type,
274 * Add the current time as the publication date
277 * @param md metadata to modify
279 void GNUNET_CONTAINER_meta_data_add_publication_date (struct
280 GNUNET_CONTAINER_MetaData
284 * Iterate over MD entries, excluding thumbnails.
286 * @param md metadata to inspect
287 * @param iter function to call on each entry
288 * @param iter_cls closure for iterator
289 * @return number of entries
291 int GNUNET_CONTAINER_meta_data_get_contents (const struct
292 GNUNET_CONTAINER_MetaData *md,
293 GNUNET_CONTAINER_MetaDataProcessor
294 iter, void *iter_cls);
297 * Get the first MD entry of the given type.
299 * @param md metadata to inspect
300 * @param type type to look for
301 * @return NULL if we do not have any such entry,
302 * otherwise client is responsible for freeing the value!
304 char *GNUNET_CONTAINER_meta_data_get_by_type (const struct
305 GNUNET_CONTAINER_MetaData *md,
306 EXTRACTOR_KeywordType type);
309 * Get the first matching MD entry of the given types.
311 * @param md metadata to inspect
312 * @param ... -1-terminated list of types
313 * @return NULL if we do not have any such entry,
314 * otherwise client is responsible for freeing the value!
316 char *GNUNET_CONTAINER_meta_data_get_first_by_types (const struct
317 GNUNET_CONTAINER_MetaData
321 * Get a thumbnail from the meta-data (if present).
323 * @param md metadata to inspect
324 * @param thumb will be set to the thumbnail data. Must be
325 * freed by the caller!
326 * @return number of bytes in thumbnail, 0 if not available
328 size_t GNUNET_CONTAINER_meta_data_get_thumbnail (const struct
329 GNUNET_CONTAINER_MetaData
330 *md, unsigned char **thumb);
333 * Extract meta-data from a file.
335 * @param md metadata to set
336 * @param filename name of file to inspect
337 * @param extractors plugins to use
338 * @return GNUNET_SYSERR on error, otherwise the number
339 * of meta-data items obtained
341 int GNUNET_CONTAINER_meta_data_extract_from_file (struct
342 GNUNET_CONTAINER_MetaData
343 *md, const char *filename,
344 EXTRACTOR_ExtractorList *
349 * Options for metadata serialization.
351 enum GNUNET_CONTAINER_MetaDataSerializationOptions
354 * Serialize all of the data.
356 GNUNET_CONTAINER_META_DATA_SERIALIZE_FULL = 0,
359 * If not enough space is available, it is acceptable
360 * to only serialize some of the metadata.
362 GNUNET_CONTAINER_META_DATA_SERIALIZE_PART = 1,
365 * Speed is of the essence, do not allow compression.
367 GNUNET_CONTAINER_META_DATA_SERIALIZE_NO_COMPRESS = 2
372 * Serialize meta-data to target.
374 * @param md metadata to serialize
375 * @param size maximum number of bytes available
376 * @param opt is it ok to just write SOME of the
377 * meta-data to match the size constraint,
378 * possibly discarding some data?
379 * @return number of bytes written on success,
380 * -1 on error (typically: not enough
383 ssize_t GNUNET_CONTAINER_meta_data_serialize (const struct
384 GNUNET_CONTAINER_MetaData *md,
388 GNUNET_CONTAINER_MetaDataSerializationOptions
392 * Compute size of the meta-data in
395 * @param md metadata to inspect
396 * @param opt is it ok to just write SOME of the
397 * meta-data to match the size constraint,
398 * possibly discarding some data?
399 * @return number of bytes needed for serialization, -1 on error
401 ssize_t GNUNET_CONTAINER_meta_data_get_serialized_size (const struct
402 GNUNET_CONTAINER_MetaData
405 GNUNET_CONTAINER_MetaDataSerializationOptions
409 * Deserialize meta-data. Initializes md.
411 * @param input serialized meta-data.
412 * @param size number of bytes available
413 * @return MD on success, NULL on error (i.e.
416 struct GNUNET_CONTAINER_MetaData
417 *GNUNET_CONTAINER_meta_data_deserialize (const char *input,
421 * Does the meta-data claim that this is a directory?
422 * Checks if the mime-type is that of a GNUnet directory.
424 * @param md metadata to inspect
425 * @return GNUNET_YES if it is, GNUNET_NO if it is not, GNUNET_SYSERR if
426 * we have no mime-type information (treat as 'GNUNET_NO')
428 int GNUNET_CONTAINER_meta_data_test_for_directory (const struct
429 GNUNET_CONTAINER_MetaData
433 /* ******************************* HashMap **************************** */
436 * Opaque handle for a HashMap.
438 struct GNUNET_CONTAINER_MultiHashMap;
441 * Options for storing values in the HashMap.
443 enum GNUNET_CONTAINER_MultiHashMapOption
446 * If a value with the given key exists, replace it.
447 * Note that the old value would NOT be freed
448 * by replace (the application has to make sure that
449 * this happens if required).
451 GNUNET_CONTAINER_MULTIHASHMAPOPTION_REPLACE,
454 * Allow multiple values with the same key.
456 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE,
459 * There must only be one value per key; storing
460 * a value should fail if a value under the same
461 * key already exists.
463 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY,
466 * There must only be one value per key, but don't
467 * bother checking if a value already exists
468 * (faster than UNIQUE_ONLY; implemented just like
469 * MULTIPLE but this option documents better what
470 * is intended if UNIQUE is what is desired).
472 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST
477 * Iterator over HashCodes.
480 * @param key current key code
481 * @param value value in the hash map
482 * @return GNUNET_YES if we should continue to
486 typedef int (*GNUNET_CONTAINER_HashMapIterator) (void *cls,
487 const GNUNET_HashCode * key,
492 * Create a multi hash map.
495 * @param len initial size (map will grow as needed)
496 * @return NULL on error
498 struct GNUNET_CONTAINER_MultiHashMap
499 *GNUNET_CONTAINER_multihashmap_create (unsigned int len);
502 * Destroy a hash map. Will not free any values
503 * stored in the hash map!
507 void GNUNET_CONTAINER_multihashmap_destroy (struct
508 GNUNET_CONTAINER_MultiHashMap
512 * Given a key find a value in the
513 * map matching the key.
516 * @param key what to look for
517 * @return NULL if no value was found; note that
518 * this is indistinguishable from values that just
519 * happen to be NULL; use "contains" to test for
520 * key-value pairs with value NULL
522 void *GNUNET_CONTAINER_multihashmap_get (const struct
523 GNUNET_CONTAINER_MultiHashMap *map,
524 const GNUNET_HashCode * key);
527 * Remove the given key-value pair from the map.
528 * Note that if the key-value pair is in the map
529 * multiple times, only one of the pairs will be
533 * @param key key of the key-value pair
534 * @param value value of the key-value pair
535 * @return GNUNET_YES on success, GNUNET_NO if the key-value pair
538 int GNUNET_CONTAINER_multihashmap_remove (struct GNUNET_CONTAINER_MultiHashMap
539 *map, const GNUNET_HashCode * key,
543 * Remove all entries for the given key from the map.
544 * Note that the values would not be "freed".
547 * @param key identifies values to be removed
548 * @return number of values removed
550 int GNUNET_CONTAINER_multihashmap_remove_all (struct
551 GNUNET_CONTAINER_MultiHashMap
553 const GNUNET_HashCode * key);
556 * Check if the map contains any value under the given
557 * key (including values that are NULL).
560 * @param key the key to test if a value exists for it
561 * @return GNUNET_YES if such a value exists,
564 int GNUNET_CONTAINER_multihashmap_contains (const struct
565 GNUNET_CONTAINER_MultiHashMap
567 const GNUNET_HashCode * key);
570 * Store a key-value pair in the map.
573 * @param key key to use
574 * @param value value to use
575 * @param opt options for put
576 * @return GNUNET_OK on success,
577 * GNUNET_NO if a value was replaced (with REPLACE)
578 * GNUNET_SYSERR if UNIQUE_ONLY was the option and the
579 * value already exists
581 int GNUNET_CONTAINER_multihashmap_put (struct GNUNET_CONTAINER_MultiHashMap
582 *map, const GNUNET_HashCode * key,
585 GNUNET_CONTAINER_MultiHashMapOption
589 * Get the number of key-value pairs in the map.
592 * @return the number of key value pairs
594 unsigned int GNUNET_CONTAINER_multihashmap_size (const struct
595 GNUNET_CONTAINER_MultiHashMap
600 * Iterate over all entries in the map.
603 * @param iterator function to call on each entry
604 * @param cls extra argument to it
605 * @return the number of key value pairs processed,
606 * GNUNET_SYSERR if it aborted iteration
608 int GNUNET_CONTAINER_multihashmap_iterate (const struct
609 GNUNET_CONTAINER_MultiHashMap *map,
610 GNUNET_CONTAINER_HashMapIterator
611 iterator, void *cls);
614 * Iterate over all entries in the map
615 * that match a particular key.
618 * @param key key that the entries must correspond to
619 * @param iterator function to call on each entry
620 * @param cls extra argument to it
621 * @return the number of key value pairs processed,
622 * GNUNET_SYSERR if it aborted iteration
624 int GNUNET_CONTAINER_multihashmap_get_multiple (const struct
625 GNUNET_CONTAINER_MultiHashMap
627 const GNUNET_HashCode * key,
628 GNUNET_CONTAINER_HashMapIterator
629 iterator, void *cls);
631 * Returns the stored value of a random non-null entry
632 * in the hash table. Returns only the first value, does
633 * not go inside bucket linked list (yet). Runs with a
634 * worst case time of N, so it's not efficient in any way
637 void *GNUNET_CONTAINER_multihashmap_get_random (const struct
638 GNUNET_CONTAINER_MultiHashMap
644 /* ******************** doubly-linked list *************** */
647 * Insert an element into a DLL. Assumes
648 * that head, tail and element are structs
649 * with prev and next fields.
651 * @param head pointer to the head of the DLL
652 * @param tail pointer to the tail of the DLL
653 * @param element element to insert
655 #define GNUNET_CONTAINER_DLL_insert(head,tail,element) \
656 (element)->next = (head); \
657 (element)->prev = NULL; \
658 if ((tail) == NULL) \
661 (head)->prev = element; \
665 * Insert an element into a DLL after the given other
666 * element. Insert at the head if the other
669 * @param head pointer to the head of the DLL
670 * @param tail pointer to the tail of the DLL
671 * @param other prior element, NULL for insertion at head of DLL
672 * @param element element to insert
674 #define GNUNET_CONTAINER_DLL_insert_after(head,tail,other,element) \
675 (element)->prev = (other); \
678 (element)->next = (head); \
679 (head) = (element); \
683 (element)->next = (other)->next; \
684 (other)->next = (element); \
686 if (NULL == (element)->next) \
687 (tail) = (element); \
689 (element)->next->prev = (element);
695 * Remove an element from a DLL. Assumes
696 * that head, tail and element are structs
697 * with prev and next fields.
699 * @param head pointer to the head of the DLL
700 * @param tail pointer to the tail of the DLL
701 * @param element element to remove
703 #define GNUNET_CONTAINER_DLL_remove(head,tail,element) \
704 if ((element)->prev == NULL) \
705 (head) = (element)->next; \
707 (element)->prev->next = (element)->next; \
708 if ((element)->next == NULL) \
709 (tail) = (element)->prev; \
711 (element)->next->prev = (element)->prev;
715 /* ******************** Heap *************** */
719 * Cost by which elements in a heap can be ordered.
721 typedef uint64_t GNUNET_CONTAINER_HeapCost;
725 * Heap type, either max or min. Hopefully makes the
726 * implementation more useful.
728 enum GNUNET_CONTAINER_HeapOrder
731 * Heap with the maximum cost at the root.
733 GNUNET_CONTAINER_HEAP_ORDER_MAX,
736 * Heap with the minimum cost at the root.
738 GNUNET_CONTAINER_HEAP_ORDER_MIN
745 struct GNUNET_CONTAINER_Heap;
750 * @param type should the minimum or the maximum element be the root
751 * @return NULL on error, otherwise a fresh heap
753 struct GNUNET_CONTAINER_Heap *GNUNET_CONTAINER_heap_create (enum
754 GNUNET_CONTAINER_HeapOrder
761 * @param h heap to free.
763 void GNUNET_CONTAINER_heap_destroy (struct GNUNET_CONTAINER_Heap *h);
767 * Function called on elements of a heap.
770 * @param element obj stored in heap
771 * @param cost cost of the element
772 * @return GNUNET_YES if we should continue to iterate,
775 typedef int (*GNUNET_CONTAINER_HeapIterator) (void *cls,
777 GNUNET_CONTAINER_HeapCost cost);
781 * Iterate over all entries in the map.
783 * @param heap the heap
784 * @param iterator function to call on each entry
785 * @param iterator_cls closure for iterator
786 * @return number of items handled
787 * GNUNET_SYSERR if iteration was aborted by iterator
789 int GNUNET_CONTAINER_heap_iterate (struct GNUNET_CONTAINER_Heap *heap,
790 GNUNET_CONTAINER_HeapIterator iterator,
796 * Inserts a new item into the heap, item is always neighbor now.
797 * @param heap the heap
798 * @param element element to insert
799 * @param cost cost of the element
803 GNUNET_CONTAINER_heap_insert (struct GNUNET_CONTAINER_Heap *heap,
804 void *element, GNUNET_CONTAINER_HeapCost cost);
808 * Removes root of the tree, is remove max if a max heap and remove min
809 * if a min heap, returns the data stored at the node.
811 * @param heap the heap
812 * @return NULL if the heap is empty
814 void *GNUNET_CONTAINER_heap_remove_root (struct GNUNET_CONTAINER_Heap *heap);
818 * Returns element stored at root of tree, doesn't effect anything
820 * @param heap the heap
821 * @return NULL if the heap is empty
823 void *GNUNET_CONTAINER_heap_peek (struct GNUNET_CONTAINER_Heap *heap);
827 * Removes any node from the tree based on the neighbor given, does
828 * not traverse the tree (backpointers) but may take more time due to
829 * percolation of nodes.
831 * @param heap the heap
832 * @param element element to remove
835 void *GNUNET_CONTAINER_heap_remove_node (struct GNUNET_CONTAINER_Heap *heap,
840 * Updates the cost of any node in the tree
842 * @param heap the heap
843 * @param element the element for which the cost is updated
844 * @param new_cost new cost for the element
848 GNUNET_CONTAINER_heap_update_cost (struct GNUNET_CONTAINER_Heap *heap,
850 GNUNET_CONTAINER_HeapCost new_cost);
854 * Random walk of the tree, returns the data stored at the next random node
855 * in the walk. Calls callee with the data, or NULL if the tree is empty
856 * or some other problem crops up.
858 * @param heap the heap
859 * @return the next element from the random walk
861 void *GNUNET_CONTAINER_heap_walk_get_next (struct GNUNET_CONTAINER_Heap
866 * Returns the current size of the heap
868 * @param heap the heap to get the size of
869 * @return number of elements in the heap
872 GNUNET_CONTAINER_heap_get_size (struct GNUNET_CONTAINER_Heap *heap);
876 #if 0 /* keep Emacsens' auto-indent happy */
884 /* ifndef GNUNET_CONTAINER_LIB_H */
886 /* end of gnunet_container_lib.h */