X-Git-Url: http://git.silcnet.org/gitweb/?a=blobdiff_plain;f=lib%2Fsilcutil%2Fsilchashtable.h;h=966ffc469e3d2a3fe1ae6bae591c8599726af738;hb=e7b6c157b80152bf9fb9266e6bdd93f9fb0db776;hp=bdee0e10c69ffdf6c70c8e360612b611993f7b33;hpb=ab530adb8aab5b1aa48f66f3cd0dd6be509dd6de;p=silc.git diff --git a/lib/silcutil/silchashtable.h b/lib/silcutil/silchashtable.h index bdee0e10..966ffc46 100644 --- a/lib/silcutil/silchashtable.h +++ b/lib/silcutil/silchashtable.h @@ -1,16 +1,15 @@ /* silchashtable.h - + Author: Pekka Riikonen - - Copyright (C) 2001 Pekka Riikonen - + + Copyright (C) 2001 - 2007 Pekka Riikonen + This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by - the Free Software Foundation; either version 2 of the License, or - (at your option) any later version. - + the Free Software Foundation; version 2 of the License. + This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the @@ -18,28 +17,32 @@ */ -/****h* silcutil/SilcHashTableAPI +/****h* silcutil/SILC Hash Table Interface * * DESCRIPTION * * Implementation of collision resistant hash table. This is a hash table * that provides a reliable (what you add there stays there, and duplicate * keys are allowed) with as fast reference to the key as possible. If - * there are a lot of duplicate keys in the hash table the lookup gets - * slower of course. However, this is reliable and no data is lost at any - * point. If you know that you never have duplicate keys then this is as - * fast as any simple hash table. + * there are a lot of duplicate keys in the hash table the lookup slows down. + * However, this is reliable and no data is lost at any point. If you know + * that you never have duplicate keys then this is as fast as any simple hash + * table. * * The interface provides many ways to search the hash table including * an extended interface where caller can specify its own hash and comparison - * functions. + * functions. The interface also supports SilcStack and all memory allocated + * by the hash table can be allocated from SilcStack. * - * There are two ways tro traverse the entire hash table if this feature + * There are two ways to traverse the entire hash table if this feature * is needed. There exists a foreach function that calls a foreach * callback for each entry in the hash table. Other way is to use * SilcHashTableList structure and traverse the hash table inside while() * using the list structure. Both are equally fast. * + * The hash table is not thread safe. If same SilcHashtable context is used + * in multi thread environment concurrency control must be employed. + * ***/ #ifndef SILCHASHTABLE_H @@ -48,7 +51,7 @@ /****s* silcutil/SilcHashTableAPI/SilcHashTable * * NAME - * + * * typedef struct SilcHashTableStruct *SilcHashTable; * * DESCRIPTION @@ -64,13 +67,13 @@ typedef struct SilcHashTableStruct *SilcHashTable; /****s* silcutil/SilcHashTableAPI/SilcHashTableList * * NAME - * + * * typedef struct SilcHashTableListStruct SilcHashTableList; * * DESCRIPTION * * This structure is used to tarverse the hash table. This structure - * is given as argument to the silc_hash_table_list function to + * is given as argument to the silc_hash_table_list function to * initialize it and then used to traverse the hash table with the * silc_hash_table_get function. It needs not be allocated or freed. * @@ -80,6 +83,7 @@ typedef struct SilcHashTableStruct *SilcHashTable; * silc_hash_table_list(hash_table, &htl); * while (silc_hash_table_get(&htl, (void *)&key, (void *)&context)) * ... + * silc_hash_table_list_reset(&htl); * * SOURCE */ @@ -89,7 +93,8 @@ typedef struct SilcHashTableListStruct SilcHashTableList; struct SilcHashTableListStruct { SilcHashTable ht; void *entry; - uint32 index; + unsigned int index : 31; + unsigned int auto_rehash : 1; }; /***/ @@ -97,7 +102,7 @@ struct SilcHashTableListStruct { * * SYNOPSIS * - * typedef uint32 (*SilcHashFunction)(void *key, void *user_context); + * typedef SilcUInt32 (*SilcHashFunction)(void *key, void *user_context); * * DESCRIPTION * @@ -107,14 +112,14 @@ struct SilcHashTableListStruct { * to the callback. * ***/ -typedef uint32 (*SilcHashFunction)(void *key, void *user_context); +typedef SilcUInt32 (*SilcHashFunction)(void *key, void *user_context); /****f* silcutil/SilcHashTableAPI/SilcHashCompare * * SYNOPSIS * - * typedef bool (*SilcHashCompare)(void *key1, void *key2, - * void *user_context); + * typedef SilcBool (*SilcHashCompare)(void *key1, void *key2, + * void *user_context); * * DESCRIPTION * @@ -125,31 +130,32 @@ typedef uint32 (*SilcHashFunction)(void *key, void *user_context); * to the callback. * ***/ -typedef bool (*SilcHashCompare)(void *key1, void *key2, void *user_context); +typedef SilcBool (*SilcHashCompare)(void *key1, void *key2, + void *user_context); /****f* silcutil/SilcHashTableAPI/SilcHashDestructor * * SYNOPSIS * - * typedef void (*SilcHashDestructor)(void *key, void *context, + * typedef void (*SilcHashDestructor)(void *key, void *context, * void *user_context); * * DESCRIPTION * - * A destructor callback that the library will call to destroy the - * `key' and `context'. The appliation provides the function when + * A destructor callback that the library will call to destroy the + * `key' and `context'. The application provides the function when * allocating a new hash table. The `user_context' is application * specific context and is delivered to the callback. * ***/ -typedef void (*SilcHashDestructor)(void *key, void *context, +typedef void (*SilcHashDestructor)(void *key, void *context, void *user_context); /****f* silcutil/SilcHashTableAPI/SilcHashForeach * * SYNOPSIS * - * typedef void (*SilcHashForeach)(void *key, void *context, + * typedef void (*SilcHashForeach)(void *key, void *context, * void *user_context); * * DESCRIPTION @@ -167,34 +173,37 @@ typedef void (*SilcHashForeach)(void *key, void *context, void *user_context); * * SYNOPSIS * - * SilcHashTable silc_hash_table_alloc(uint32 table_size, + * SilcHashTable silc_hash_table_alloc(SilcStack stack, + * SilcUInt32 table_size, * SilcHashFunction hash, * void *hash_user_context, * SilcHashCompare compare, * void *compare_user_context, * SilcHashDestructor destructor, * void *destructor_user_context, - * bool auto_rehash); + * SilcBool auto_rehash); * * DESCRIPTION * - * Allocates new hash table and returns it. If the `table_size' is not + * Allocates new hash table and returns it. If the `stack' is non-NULL + * the hash table is allocated from `stack'. If the `table_size' is not * zero then the hash table size is the size provided. If zero then the * default size will be used. Note that if the `table_size' is provided * it should be a prime. The `hash', `compare' and `destructor' are * the hash function, the key comparison function and key and context * destructor function, respectively. The `hash' is mandatory, the others - * are optional. + * are optional. Returns NULL if system is out of memory. * ***/ -SilcHashTable silc_hash_table_alloc(uint32 table_size, +SilcHashTable silc_hash_table_alloc(SilcStack stack, + SilcUInt32 table_size, SilcHashFunction hash, void *hash_user_context, SilcHashCompare compare, void *compare_user_context, SilcHashDestructor destructor, void *destructor_user_context, - bool auto_rehash); + SilcBool auto_rehash); /****f* silcutil/SilcHashTableAPI/silc_hash_table_free * @@ -207,6 +216,10 @@ SilcHashTable silc_hash_table_alloc(uint32 table_size, * Frees the hash table. The destructor function provided in the * silc_hash_table_alloc will be called for all keys in the hash table. * + * If the SilcStack was given to silc_hash_table_alloc this call will + * release all memory allocated during the life time of the `ht' back + * to the SilcStack. + * ***/ void silc_hash_table_free(SilcHashTable ht); @@ -214,7 +227,7 @@ void silc_hash_table_free(SilcHashTable ht); * * SYNOPSIS * - * uint32 silc_hash_table_size(SilcHashTable ht); + * SilcUInt32 silc_hash_table_size(SilcHashTable ht); * * DESCRIPTION * @@ -222,13 +235,13 @@ void silc_hash_table_free(SilcHashTable ht); * hash table. * ***/ -uint32 silc_hash_table_size(SilcHashTable ht); +SilcUInt32 silc_hash_table_size(SilcHashTable ht); /****f* silcutil/SilcHashTableAPI/silc_hash_table_count * * SYNOPSIS * - * uint32 silc_hash_table_count(SilcHashTable ht); + * SilcUInt32 silc_hash_table_count(SilcHashTable ht); * * DESCRIPTION * @@ -237,13 +250,13 @@ uint32 silc_hash_table_size(SilcHashTable ht); * silc_hash_table_rehash is recommended. * ***/ -uint32 silc_hash_table_count(SilcHashTable ht); +SilcUInt32 silc_hash_table_count(SilcHashTable ht); /****f* silcutil/SilcHashTableAPI/silc_hash_table_add * * SYNOPSIS * - * void silc_hash_table_add(SilcHashTable ht, void *key, void *context); + * SilcBool silc_hash_table_add(SilcHashTable ht, void *key, void *context); * * DESCRIPTION * @@ -253,13 +266,14 @@ uint32 silc_hash_table_count(SilcHashTable ht); * to the hash table reliably (it is collision resistant). * ***/ -void silc_hash_table_add(SilcHashTable ht, void *key, void *context); +SilcBool silc_hash_table_add(SilcHashTable ht, void *key, void *context); -/****f* silcutil/SilcHashTableAPI/silc_hash_table_replace +/****f* silcutil/SilcHashTableAPI/silc_hash_table_set * * SYNOPSIS * - * void silc_hash_table_replace(SilcHashTable ht, void *key, void *context); + * SilcBool silc_hash_table_set(SilcHashTable ht, void *key, + * void *context); * * DESCRIPTION * @@ -269,13 +283,13 @@ void silc_hash_table_add(SilcHashTable ht, void *key, void *context); * replaced key and context. * ***/ -void silc_hash_table_replace(SilcHashTable ht, void *key, void *context); +SilcBool silc_hash_table_set(SilcHashTable ht, void *key, void *context); /****f* silcutil/SilcHashTableAPI/silc_hash_table_del * * SYNOPSIS * - * bool silc_hash_table_del(SilcHashTable ht, void *key); + * SilcBool silc_hash_table_del(SilcHashTable ht, void *key); * * DESCRIPTION * @@ -284,14 +298,14 @@ void silc_hash_table_replace(SilcHashTable ht, void *key, void *context); * entry was removed successfully and FALSE otherwise. * ***/ -bool silc_hash_table_del(SilcHashTable ht, void *key); +SilcBool silc_hash_table_del(SilcHashTable ht, void *key); /****f* silcutil/SilcHashTableAPI/silc_hash_table_del_by_context * * SYNOPSIS * - * bool silc_hash_table_del_by_context(SilcHashTable ht, void *key, - * void *context); + * SilcBool silc_hash_table_del_by_context(SilcHashTable ht, void *key, + * void *context); * * DESCRIPTION * @@ -301,34 +315,55 @@ bool silc_hash_table_del(SilcHashTable ht, void *key); * be used to check whether the correct entry is being deleted. * ***/ -bool silc_hash_table_del_by_context(SilcHashTable ht, void *key, - void *context); +SilcBool silc_hash_table_del_by_context(SilcHashTable ht, void *key, + void *context); /****f* silcutil/SilcHashTableAPI/silc_hash_table_find * * SYNOPSIS * - * bool silc_hash_table_find(SilcHashTable ht, void *key, - * void **ret_key, void **ret_context); + * SilcBool silc_hash_table_find(SilcHashTable ht, void *key, + * void **ret_key, void **ret_context); * * DESCRIPTION * * Finds the entry in the hash table by the provided `key' as fast as - * possible. Return TRUE if the entry was found and FALSE otherwise. + * possible. Return TRUE if the entry was found and FALSE otherwise. * The found entry is returned to the `ret_key' and `ret_context', * respectively. If the `ret_key and `ret_context' are NULL then this * maybe used only to check whether given key exists in the table. * ***/ -bool silc_hash_table_find(SilcHashTable ht, void *key, - void **ret_key, void **ret_context); +SilcBool silc_hash_table_find(SilcHashTable ht, void *key, + void **ret_key, void **ret_context); + +/****f* silcutil/SilcHashTableAPI/silc_hash_table_find_by_context + * + * SYNOPSIS + * + * SilcBool silc_hash_table_find_by_context(SilcHashTable ht, void *key, + * void *context, void **ret_key); + * + * DESCRIPTION + * + * Finds the entry in the hash table by the provided `key' and + * `context' as fast as possible. This is handy function when there + * can be multiple same keys in the hash table. By using this function + * the specific key with specific context can be found. Return + * TRUE if the entry with the key and context was found and FALSE + * otherwise. The function returns only the key to `ret_key' since + * the caller already knows the context. + * + ***/ +SilcBool silc_hash_table_find_by_context(SilcHashTable ht, void *key, + void *context, void **ret_key); /****f* silcutil/SilcHashTableAPI/silc_hash_table_find_foreach * * SYNOPSIS * * void silc_hash_table_find_foreach(SilcHashTable ht, void *key, - * SilcHashForeach foreach, + * SilcHashForeach foreach, * void *user_context); * * DESCRIPTION @@ -336,7 +371,15 @@ bool silc_hash_table_find(SilcHashTable ht, void *key, * As the hash table is collision resistant it is possible to save duplicate * keys to the hash table. This function can be used to find all keys * and contexts from the hash table that are found using the `key'. The - * `foreach' is called for every found key. + * `foreach' is called for every found key. If no entries can be found + * the `foreach' will be called once with the context set NULL and + * `key' and `user_context' sent to the function. + * + * NOTES + * + * The hash table will not be rehashed during the traversing of the table, + * even if the table was marked as auto rehashable. The caller also must + * not call silc_hash_table_rehash while traversing the table. * ***/ void silc_hash_table_find_foreach(SilcHashTable ht, void *key, @@ -354,6 +397,12 @@ void silc_hash_table_find_foreach(SilcHashTable ht, void *key, * Traverse all entrys in the hash table and call the `foreach' for * every entry with the `user_context' context. * + * NOTES + * + * The hash table will not be rehashed during the traversing of the table, + * even if the table was marked as auto rehashable. The caller also must + * not call silc_hash_table_rehash while traversing the table. + * ***/ void silc_hash_table_foreach(SilcHashTable ht, SilcHashForeach foreach, void *user_context); @@ -362,7 +411,7 @@ void silc_hash_table_foreach(SilcHashTable ht, SilcHashForeach foreach, * * SYNOPSIS * - * void silc_hash_table_rehash(SilcHashTable ht, uint32 new_size); + * void silc_hash_table_rehash(SilcHashTable ht, SilcUInt32 new_size); * * DESCRIPTION * @@ -372,7 +421,7 @@ void silc_hash_table_foreach(SilcHashTable ht, SilcHashForeach foreach, * very slow. * ***/ -void silc_hash_table_rehash(SilcHashTable ht, uint32 new_size); +void silc_hash_table_rehash(SilcHashTable ht, SilcUInt32 new_size); /****f* silcutil/SilcHashTableAPI/silc_hash_table_list * @@ -383,26 +432,57 @@ void silc_hash_table_rehash(SilcHashTable ht, uint32 new_size); * DESCRIPTION * * Prepares the `htl' SilcHashTableList sent as argument to be used in the - * hash table traversing with the silc_hash_table_get. + * hash table traversing with the silc_hash_table_get. After the hash + * table traversing is completed the silc_hash_table_list_reset must be + * called. + * + * NOTES + * + * The hash table will not be rehashed during the traversing of the list, + * even if the table was marked as auto rehashable. The caller also must + * not call silc_hash_table_rehash while traversing the list. * ***/ void silc_hash_table_list(SilcHashTable ht, SilcHashTableList *htl); +/****f* silcutil/SilcHashTableAPI/silc_hash_table_list_reset + * + * SYNOPSIS + * + * void silc_hash_table_list_reset(SilcHashTableList *htl); + * + * DESCRIPTION + * + * Resets the `htl' SilcHashTableList. This must be called after the + * hash table traversing is completed. + * + ***/ +void silc_hash_table_list_reset(SilcHashTableList *htl); + /****f* silcutil/SilcHashTableAPI/silc_hash_table_get * * SYNOPSIS * - * bool silc_hash_table_get(SilcHashTableList *htl, void **key, - * void **context); + * SilcBool silc_hash_table_get(SilcHashTableList *htl, void **key, + * void **context); * * DESCRIPTION * * Returns always the next entry in the hash table into the `key' and - * `context' and TRUE. If this returns FALSE then there are no anymore - * any entrys. + * `context' and TRUE. If this returns FALSE then there are no more + * entries. + * + * EXAMPLE + * + * SilcHashTableList htl; + * silc_hash_table_list(hash_table, &htl); + * while (silc_hash_table_get(&htl, (void *)&key, (void *)&context)) + * ... + * silc_hash_table_list_reset(&htl); * ***/ -bool silc_hash_table_get(SilcHashTableList *htl, void **key, void **context); +SilcBool silc_hash_table_get(SilcHashTableList *htl, + void **key, void **context); /* Extended hash table interface (same as above but with specific @@ -412,9 +492,10 @@ bool silc_hash_table_get(SilcHashTableList *htl, void **key, void **context); * * SYNOPSIS * - * void silc_hash_table_add_ext(SilcHashTable ht, void *key, void *context, - * SilcHashFunction hash, - * void *hash_user_context); + * SilcBool silc_hash_table_add_ext(SilcHashTable ht, void *key, + * void *context, + * SilcHashFunction hash, + * void *hash_user_context); * * DESCRIPTION * @@ -427,16 +508,18 @@ bool silc_hash_table_get(SilcHashTableList *htl, void **key, void **context); * function. If not provided the hash table's default is used. * ***/ -void silc_hash_table_add_ext(SilcHashTable ht, void *key, void *context, - SilcHashFunction hash, void *hash_user_context); +SilcBool silc_hash_table_add_ext(SilcHashTable ht, + void *key, void *context, + SilcHashFunction hash, + void *hash_user_context); -/****f* silcutil/SilcHashTableAPI/silc_hash_table_replace_ext +/****f* silcutil/SilcHashTableAPI/silc_hash_table_set_ext * * SYNOPSIS * - * void silc_hash_table_replace_ext(SilcHashTable ht, void *key, + * SilcBool silc_hash_table_set_ext(SilcHashTable ht, void *key, * void *context, - * SilcHashFunction hash, + * SilcHashFunction hash, * void *hash_user_context); * * DESCRIPTION @@ -450,21 +533,22 @@ void silc_hash_table_add_ext(SilcHashTable ht, void *key, void *context, * function. If not provided the hash table's default is used. * ***/ -void silc_hash_table_replace_ext(SilcHashTable ht, void *key, void *context, - SilcHashFunction hash, +SilcBool silc_hash_table_set_ext(SilcHashTable ht, + void *key, void *context, + SilcHashFunction hash, void *hash_user_context); /****f* silcutil/SilcHashTableAPI/silc_hash_table_del_ext * * SYNOPSIS * - * bool silc_hash_table_del_ext(SilcHashTable ht, void *key, - * SilcHashFunction hash, - * void *hash_user_context, - * SilcHashCompare compare, - * void *compare_user_context, - * SilcHashDestructor destructor, - * void *destructor_user_context); + * SilcBool silc_hash_table_del_ext(SilcHashTable ht, void *key, + * SilcHashFunction hash, + * void *hash_user_context, + * SilcHashCompare compare, + * void *compare_user_context, + * SilcHashDestructor destructor, + * void *destructor_user_context); * * DESCRIPTION * @@ -480,26 +564,27 @@ void silc_hash_table_replace_ext(SilcHashTable ht, void *key, void *context, * specific destructor function. * ***/ -bool silc_hash_table_del_ext(SilcHashTable ht, void *key, - SilcHashFunction hash, - void *hash_user_context, - SilcHashCompare compare, - void *compare_user_context, - SilcHashDestructor destructor, - void *destructor_user_context); +SilcBool silc_hash_table_del_ext(SilcHashTable ht, void *key, + SilcHashFunction hash, + void *hash_user_context, + SilcHashCompare compare, + void *compare_user_context, + SilcHashDestructor destructor, + void *destructor_user_context); /****f* silcutil/SilcHashTableAPI/silc_hash_table_del_by_context_ext * * SYNOPSIS * - * bool silc_hash_table_del_by_context_ext(SilcHashTable ht, void *key, - * void *context, - * SilcHashFunction hash, - * void *hash_user_context, - * SilcHashCompare compare, - * void *compare_user_context, - * SilcHashDestructor destructor, - * void *destructor_user_context); + * SilcBool + * silc_hash_table_del_by_context_ext(SilcHashTable ht, void *key, + * void *context, + * SilcHashFunction hash, + * void *hash_user_context, + * SilcHashCompare compare, + * void *compare_user_context, + * SilcHashDestructor destructor, + * void *destructor_user_context); * * DESCRIPTION * @@ -516,30 +601,30 @@ bool silc_hash_table_del_ext(SilcHashTable ht, void *key, * specific destructor function. * ***/ -bool silc_hash_table_del_by_context_ext(SilcHashTable ht, void *key, - void *context, - SilcHashFunction hash, - void *hash_user_context, - SilcHashCompare compare, - void *compare_user_context, - SilcHashDestructor destructor, - void *destructor_user_context); +SilcBool silc_hash_table_del_by_context_ext(SilcHashTable ht, void *key, + void *context, + SilcHashFunction hash, + void *hash_user_context, + SilcHashCompare compare, + void *compare_user_context, + SilcHashDestructor destructor, + void *destructor_user_context); /****f* silcutil/SilcHashTableAPI/silc_hash_table_find_ext * * SYNOPSIS * - * bool silc_hash_table_find_ext(SilcHashTable ht, void *key, - * void **ret_key, void **ret_context, - * SilcHashFunction hash, - * void *hash_user_context, - * SilcHashCompare compare, - * void *compare_user_context); + * SilcBool silc_hash_table_find_ext(SilcHashTable ht, void *key, + * void **ret_key, void **ret_context, + * SilcHashFunction hash, + * void *hash_user_context, + * SilcHashCompare compare, + * void *compare_user_context); * * DESCRIPTION * * Finds the entry in the hash table by the provided `key' as fast as - * possible. Return TRUE if the entry was found and FALSE otherwise. + * possible. Return TRUE if the entry was found and FALSE otherwise. * The found entry is returned to the `ret_key' and `ret_context', * respectively. If the `ret_key and `ret_context' are NULL then this * maybe used only to check whether given key exists in the table. @@ -550,23 +635,58 @@ bool silc_hash_table_del_by_context_ext(SilcHashTable ht, void *key, * comparing function. If not provided the hash table's default is used. * ***/ -bool silc_hash_table_find_ext(SilcHashTable ht, void *key, - void **ret_key, void **ret_context, - SilcHashFunction hash, - void *hash_user_context, - SilcHashCompare compare, - void *compare_user_context); +SilcBool silc_hash_table_find_ext(SilcHashTable ht, void *key, + void **ret_key, void **ret_context, + SilcHashFunction hash, + void *hash_user_context, + SilcHashCompare compare, + void *compare_user_context); + +/****f* silcutil/SilcHashTableAPI/silc_hash_table_find_by_context_ext + * + * SYNOPSIS + * + * SilcBool + * silc_hash_table_find_by_context_ext(SilcHashTable ht, void *key, + * void *context, void **ret_key, + * SilcHashFunction hash, + * void *hash_user_context, + * SilcHashCompare compare, + * void *compare_user_context); + * + * DESCRIPTION + * + * Finds the entry in the hash table by the provided `key' and + * `context' as fast as possible. This is handy function when there + * can be multiple same keys in the hash table. By using this function + * the specific key with specific context can be found. Return + * TRUE if the entry with the key and context was found and FALSE + * otherwise. The function returns only the key to `ret_key' since + * the caller already knows the context. + * + * The `hash' and `hash_user_context' are application specified hash + * function. If not provided the hash table's default is used. + * The `compare' and `compare_user_context' are application specified + * comparing function. If not provided the hash table's default is used. + * + ***/ +SilcBool silc_hash_table_find_by_context_ext(SilcHashTable ht, void *key, + void *context, void **ret_key, + SilcHashFunction hash, + void *hash_user_context, + SilcHashCompare compare, + void *compare_user_context); /****f* silcutil/SilcHashTableAPI/silc_hash_table_find_foreach_ext * * SYNOPSIS * * void silc_hash_table_find_foreach_ext(SilcHashTable ht, void *key, - * SilcHashFunction hash, + * SilcHashFunction hash, * void *hash_user_context, - * SilcHashCompare compare, + * SilcHashCompare compare, * void *compare_user_context, - * SilcHashForeach foreach, + * SilcHashForeach foreach, * void *foreach_user_context); * * DESCRIPTION @@ -574,28 +694,36 @@ bool silc_hash_table_find_ext(SilcHashTable ht, void *key, * As the hash table is collision resistant it is possible to save duplicate * keys to the hash table. This function can be used to find all keys * and contexts from the hash table that are found using the `key'. The - * `foreach' is called for every found key. + * `foreach' is called for every found key. If no entries can be found + * the `foreach' will be called once with the context set NULL and + * `key' and `user_context' sent to the function. * * The `hash' and `hash_user_context' are application specified hash * function. If not provided the hash table's default is used. * The `compare' and `compare_user_context' are application specified * comparing function. If not provided the hash table's default is used. * + * NOTES + * + * The hash table will not be rehashed during the traversing of the table, + * even if the table was marked as auto rehashable. The caller also must + * not call silc_hash_table_rehash while traversing the table. + * ***/ void silc_hash_table_find_foreach_ext(SilcHashTable ht, void *key, - SilcHashFunction hash, + SilcHashFunction hash, void *hash_user_context, - SilcHashCompare compare, + SilcHashCompare compare, void *compare_user_context, - SilcHashForeach foreach, + SilcHashForeach foreach, void *foreach_user_context); /****f* silcutil/SilcHashTableAPI/silc_hash_table_rehash_ext * * SYNOPSIS * - * void silc_hash_table_rehash_ext(SilcHashTable ht, uint32 new_size, - * SilcHashFunction hash, + * void silc_hash_table_rehash_ext(SilcHashTable ht, SilcUInt32 new_size, + * SilcHashFunction hash, * void *hash_user_context); * * DESCRIPTION @@ -609,8 +737,162 @@ void silc_hash_table_find_foreach_ext(SilcHashTable ht, void *key, * function. If not provided the hash table's default is used. * ***/ -void silc_hash_table_rehash_ext(SilcHashTable ht, uint32 new_size, - SilcHashFunction hash, +void silc_hash_table_rehash_ext(SilcHashTable ht, SilcUInt32 new_size, + SilcHashFunction hash, void *hash_user_context); +/* Hash functions */ + +/****f* silcutil/SilcHashTableAPI/silc_hash_string + * + * SYNOPSIS + * + * SilcUInt32 silc_hash_string(void *key, void *user_context); + * + * DESCRIPTION + * + * Basic hash function to hash strings. May be used with the SilcHashTable. + * This uses Bob Jenkin's one-at-a-time (described in Wikipedia) hash + * function. + * + ***/ +SilcUInt32 silc_hash_string(void *key, void *user_context); + +/****f* silcutil/SilcHashTableAPI/silc_hash_string_case + * + * SYNOPSIS + * + * SilcUInt32 silc_hash_string_case(void *key, void *user_context); + * + * DESCRIPTION + * + * Basic hash function to hash strings. May be used with the SilcHashTable. + * This ignores the string's case, ie. 'Foo' and 'foo' will hash to same + * value. This uses Bob Jenkin's one-at-a-time (described in Wikipedia) + * hash function. + * + ***/ +SilcUInt32 silc_hash_string_case(void *key, void *user_context); + +/****f* silcutil/SilcHashTableAPI/silc_hash_utf8_string + * + * SYNOPSIS + * + * SilcUInt32 silc_hash_utf8_string(void *key, void *user_context); + * + * DESCRIPTION + * + * Basic has function to hash UTF-8 strings. May be used with the + * SilcHashTable. Used with identifier strings. The key is + * expected to be casefolded. + * + ***/ +SilcUInt32 silc_hash_utf8_string(void *key, void *user_context); + +/****f* silcutil/SilcHashTableAPI/silc_hash_uint + * + * SYNOPSIS + * + * SilcUInt32 silc_hash_uint(void *key, void *user_context); + * + * DESCRIPTION + * + * Basic hash function to hash integers. May be used with the SilcHashTable. + * Comparison function is not needed, the SilcHashTable will automatically + * compare integer values. + * + ***/ +SilcUInt32 silc_hash_uint(void *key, void *user_context); + +/****f* silcutil/SilcHashTableAPI/silc_hash_ptr + * + * SYNOPSIS + * + * SilcUInt32 silc_hash_ptr(void *key, void *user_context); + * + * DESCRIPTION + * + * Basic hash funtion to hash pointers. May be used with the SilcHashTable. + * Comparison function is not needed, the SilcHashTable will automatically + * compare pointer values. + * + ***/ +SilcUInt32 silc_hash_ptr(void *key, void *user_context); + +/****f* silcutil/SilcHashTableAPI/silc_hash_data + * + * SYNOPSIS + * + * SilcUInt32 silc_hash_data(void *key, void *user_context); + * + * DESCRIPTION + * + * Hash binary data. The `user_context' is the data length. This uses Bob + * Jenkin's one-at-a-time (described in Wikipedia) hash function. + * + ***/ +SilcUInt32 silc_hash_data(void *key, void *user_context); + +/* Comparison functions */ + +/****f* silcutil/SilcHashTableAPI/silc_hash_string_compare + * + * SYNOPSIS + * + * SilcBool silc_hash_string_compare(void *key1, void *key2, + * void *user_context); + * + * DESCRIPTION + * + * Compares two strings. It may be used as SilcHashTable comparison + * function. + * + ***/ +SilcBool silc_hash_string_compare(void *key1, void *key2, void *user_context); + +/****f* silcutil/SilcHashTableAPI/silc_hash_string_case_compare + * + * SYNOPSIS + * + * SilcBool silc_hash_string_case_compare(void *key1, void *key2, + * void *user_context); + * + * DESCRIPTION + * + * Compares two strings. This ignores the case while comparing. It may + * be used as SilcHashTable comparison function. + * + ***/ +SilcBool silc_hash_string_case_compare(void *key1, void *key2, + void *user_context); + +/****f* silcutil/SilcHashTableAPI/silc_hash_utf8_compare + * + * SYNOPSIS + * + * SilcBool silc_hash_utf8_compare(void *key1, void *key2, + * void *user_context); + * + * DESCRIPTION + * + * Compares UTF-8 strings. Casefolded and NULL terminated strings are + * expected. May be used as SilcHashTable comparison function. + * + ***/ +SilcBool silc_hash_utf8_compare(void *key1, void *key2, void *user_context); + +/****f* silcutil/SilcHashTableAPI/silc_hash_data_compare + * + * SYNOPSIS + * + * SilcBool silc_hash_data_compare(void *key1, void *key2, + * void *user_context); + * + * DESCRIPTION + * + * Compares binary data. May be used as SilcHashTable comparison function. + * + ***/ +SilcBool silc_hash_data_compare(void *key1, void *key2, void *user_context); + #endif