X-Git-Url: http://git.silcnet.org/gitweb/?a=blobdiff_plain;f=lib%2Fsilcutil%2Fsilchashtable.h;h=624d18a4331d5097688af5f7965984ece1ea555f;hb=b4dc1a71c928fdc0ec885ed5745b0d17b094ff7e;hp=f7d21cb4eb51e1cf14c8b7087d4f0e6ffb3e998d;hpb=8fd8212bcd16f2b53fbedff2a9b9a4e8c15b9695;p=runtime.git diff --git a/lib/silcutil/silchashtable.h b/lib/silcutil/silchashtable.h index f7d21cb4..624d18a4 100644 --- a/lib/silcutil/silchashtable.h +++ b/lib/silcutil/silchashtable.h @@ -4,7 +4,7 @@ Author: Pekka Riikonen - Copyright (C) 2001 - 2006 Pekka Riikonen + Copyright (C) 2001 - 2008 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 @@ -17,21 +17,22 @@ */ -/****h* silcutil/SILC Hash Table Interface +/****h* silcutil/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. + * an extended interface where caller can specify their own hash and comparison + * functions. The interface also supports SilcStack and all memory allocated + * by the hash table can be allocated from SilcStack. * * There are two ways to traverse the entire hash table if this feature * is needed. There exists a foreach function that calls a foreach @@ -39,15 +40,18 @@ * 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 hash table context is used in - * multi thread environment concurrency control must be employed. + * The interface also provides many utility hashing and comparison functions + * that caller may use with SilcHashTable. + * + * 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 #define SILCHASHTABLE_H -/****s* silcutil/SilcHashTableAPI/SilcHashTable +/****s* silcutil/SilcHashTable * * NAME * @@ -63,7 +67,7 @@ ***/ typedef struct SilcHashTableStruct *SilcHashTable; -/****s* silcutil/SilcHashTableAPI/SilcHashTableList +/****s* silcutil/SilcHashTableList * * NAME * @@ -97,7 +101,7 @@ struct SilcHashTableListStruct { }; /***/ -/****f* silcutil/SilcHashTableAPI/SilcHashFunction +/****f* silcutil/SilcHashFunction * * SYNOPSIS * @@ -113,7 +117,7 @@ struct SilcHashTableListStruct { ***/ typedef SilcUInt32 (*SilcHashFunction)(void *key, void *user_context); -/****f* silcutil/SilcHashTableAPI/SilcHashCompare +/****f* silcutil/SilcHashCompare * * SYNOPSIS * @@ -132,7 +136,7 @@ typedef SilcUInt32 (*SilcHashFunction)(void *key, void *user_context); typedef SilcBool (*SilcHashCompare)(void *key1, void *key2, void *user_context); -/****f* silcutil/SilcHashTableAPI/SilcHashDestructor +/****f* silcutil/SilcHashDestructor * * SYNOPSIS * @@ -150,7 +154,7 @@ typedef SilcBool (*SilcHashCompare)(void *key1, void *key2, typedef void (*SilcHashDestructor)(void *key, void *context, void *user_context); -/****f* silcutil/SilcHashTableAPI/SilcHashForeach +/****f* silcutil/SilcHashForeach * * SYNOPSIS * @@ -168,11 +172,12 @@ typedef void (*SilcHashForeach)(void *key, void *context, void *user_context); /* Simple hash table interface */ -/****f* silcutil/SilcHashTableAPI/silc_hash_table_alloc +/****f* silcutil/silc_hash_table_alloc * * SYNOPSIS * - * SilcHashTable silc_hash_table_alloc(SilcUInt32 table_size, + * SilcHashTable silc_hash_table_alloc(SilcStack stack, + * SilcUInt32 table_size, * SilcHashFunction hash, * void *hash_user_context, * SilcHashCompare compare, @@ -183,16 +188,18 @@ typedef void (*SilcHashForeach)(void *key, void *context, void *user_context); * * 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(SilcUInt32 table_size, +SilcHashTable silc_hash_table_alloc(SilcStack stack, + SilcUInt32 table_size, SilcHashFunction hash, void *hash_user_context, SilcHashCompare compare, @@ -201,7 +208,7 @@ SilcHashTable silc_hash_table_alloc(SilcUInt32 table_size, void *destructor_user_context, SilcBool auto_rehash); -/****f* silcutil/SilcHashTableAPI/silc_hash_table_free +/****f* silcutil/silc_hash_table_free * * SYNOPSIS * @@ -212,10 +219,14 @@ SilcHashTable silc_hash_table_alloc(SilcUInt32 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); -/****f* silcutil/SilcHashTableAPI/silc_hash_table_size +/****f* silcutil/silc_hash_table_size * * SYNOPSIS * @@ -229,7 +240,7 @@ void silc_hash_table_free(SilcHashTable ht); ***/ SilcUInt32 silc_hash_table_size(SilcHashTable ht); -/****f* silcutil/SilcHashTableAPI/silc_hash_table_count +/****f* silcutil/silc_hash_table_count * * SYNOPSIS * @@ -244,7 +255,7 @@ SilcUInt32 silc_hash_table_size(SilcHashTable ht); ***/ SilcUInt32 silc_hash_table_count(SilcHashTable ht); -/****f* silcutil/SilcHashTableAPI/silc_hash_table_add +/****f* silcutil/silc_hash_table_add * * SYNOPSIS * @@ -260,12 +271,12 @@ SilcUInt32 silc_hash_table_count(SilcHashTable ht); ***/ SilcBool silc_hash_table_add(SilcHashTable ht, void *key, void *context); -/****f* silcutil/SilcHashTableAPI/silc_hash_table_replace +/****f* silcutil/silc_hash_table_set * * SYNOPSIS * - * SilcBool silc_hash_table_replace(SilcHashTable ht, void *key, - * void *context); + * SilcBool silc_hash_table_set(SilcHashTable ht, void *key, + * void *context); * * DESCRIPTION * @@ -275,9 +286,9 @@ SilcBool silc_hash_table_add(SilcHashTable ht, void *key, void *context); * replaced key and context. * ***/ -SilcBool 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 +/****f* silcutil/silc_hash_table_del * * SYNOPSIS * @@ -292,7 +303,7 @@ SilcBool silc_hash_table_replace(SilcHashTable ht, void *key, void *context); ***/ SilcBool silc_hash_table_del(SilcHashTable ht, void *key); -/****f* silcutil/SilcHashTableAPI/silc_hash_table_del_by_context +/****f* silcutil/silc_hash_table_del_by_context * * SYNOPSIS * @@ -310,7 +321,7 @@ SilcBool silc_hash_table_del(SilcHashTable ht, void *key); SilcBool silc_hash_table_del_by_context(SilcHashTable ht, void *key, void *context); -/****f* silcutil/SilcHashTableAPI/silc_hash_table_find +/****f* silcutil/silc_hash_table_find * * SYNOPSIS * @@ -329,7 +340,7 @@ SilcBool silc_hash_table_del_by_context(SilcHashTable ht, void *key, SilcBool silc_hash_table_find(SilcHashTable ht, void *key, void **ret_key, void **ret_context); -/****f* silcutil/SilcHashTableAPI/silc_hash_table_find_by_context +/****f* silcutil/silc_hash_table_find_by_context * * SYNOPSIS * @@ -350,7 +361,7 @@ SilcBool silc_hash_table_find(SilcHashTable ht, void *key, SilcBool silc_hash_table_find_by_context(SilcHashTable ht, void *key, void *context, void **ret_key); -/****f* silcutil/SilcHashTableAPI/silc_hash_table_find_foreach +/****f* silcutil/silc_hash_table_find_foreach * * SYNOPSIS * @@ -377,7 +388,7 @@ SilcBool silc_hash_table_find_by_context(SilcHashTable ht, void *key, void silc_hash_table_find_foreach(SilcHashTable ht, void *key, SilcHashForeach foreach, void *user_context); -/****f* silcutil/SilcHashTableAPI/silc_hash_table_foreach +/****f* silcutil/silc_hash_table_foreach * * SYNOPSIS * @@ -399,7 +410,7 @@ void silc_hash_table_find_foreach(SilcHashTable ht, void *key, void silc_hash_table_foreach(SilcHashTable ht, SilcHashForeach foreach, void *user_context); -/****f* silcutil/SilcHashTableAPI/silc_hash_table_rehash +/****f* silcutil/silc_hash_table_rehash * * SYNOPSIS * @@ -415,7 +426,7 @@ void silc_hash_table_foreach(SilcHashTable ht, SilcHashForeach foreach, ***/ void silc_hash_table_rehash(SilcHashTable ht, SilcUInt32 new_size); -/****f* silcutil/SilcHashTableAPI/silc_hash_table_list +/****f* silcutil/silc_hash_table_list * * SYNOPSIS * @@ -437,7 +448,7 @@ void silc_hash_table_rehash(SilcHashTable ht, SilcUInt32 new_size); ***/ void silc_hash_table_list(SilcHashTable ht, SilcHashTableList *htl); -/****f* silcutil/SilcHashTableAPI/silc_hash_table_list_reset +/****f* silcutil/silc_hash_table_list_reset * * SYNOPSIS * @@ -451,7 +462,7 @@ void silc_hash_table_list(SilcHashTable ht, SilcHashTableList *htl); ***/ void silc_hash_table_list_reset(SilcHashTableList *htl); -/****f* silcutil/SilcHashTableAPI/silc_hash_table_get +/****f* silcutil/silc_hash_table_get * * SYNOPSIS * @@ -480,7 +491,7 @@ SilcBool silc_hash_table_get(SilcHashTableList *htl, /* Extended hash table interface (same as above but with specific hash and comparison functions). */ -/****f* silcutil/SilcHashTableAPI/silc_hash_table_add_ext +/****f* silcutil/silc_hash_table_add_ext * * SYNOPSIS * @@ -505,14 +516,14 @@ SilcBool silc_hash_table_add_ext(SilcHashTable ht, SilcHashFunction hash, void *hash_user_context); -/****f* silcutil/SilcHashTableAPI/silc_hash_table_replace_ext +/****f* silcutil/silc_hash_table_set_ext * * SYNOPSIS * - * SilcBool silc_hash_table_replace_ext(SilcHashTable ht, void *key, - * void *context, - * SilcHashFunction hash, - * void *hash_user_context); + * SilcBool silc_hash_table_set_ext(SilcHashTable ht, void *key, + * void *context, + * SilcHashFunction hash, + * void *hash_user_context); * * DESCRIPTION * @@ -525,12 +536,12 @@ SilcBool silc_hash_table_add_ext(SilcHashTable ht, * function. If not provided the hash table's default is used. * ***/ -SilcBool silc_hash_table_replace_ext(SilcHashTable ht, - void *key, void *context, - SilcHashFunction hash, - void *hash_user_context); +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 +/****f* silcutil/silc_hash_table_del_ext * * SYNOPSIS * @@ -564,7 +575,7 @@ SilcBool silc_hash_table_del_ext(SilcHashTable ht, void *key, SilcHashDestructor destructor, void *destructor_user_context); -/****f* silcutil/SilcHashTableAPI/silc_hash_table_del_by_context_ext +/****f* silcutil/silc_hash_table_del_by_context_ext * * SYNOPSIS * @@ -602,7 +613,7 @@ SilcBool silc_hash_table_del_by_context_ext(SilcHashTable ht, void *key, SilcHashDestructor destructor, void *destructor_user_context); -/****f* silcutil/SilcHashTableAPI/silc_hash_table_find_ext +/****f* silcutil/silc_hash_table_find_ext * * SYNOPSIS * @@ -634,7 +645,7 @@ SilcBool silc_hash_table_find_ext(SilcHashTable ht, void *key, SilcHashCompare compare, void *compare_user_context); -/****f* silcutil/SilcHashTableAPI/silc_hash_table_find_by_context_ext +/****f* silcutil/silc_hash_table_find_by_context_ext * * SYNOPSIS * @@ -669,7 +680,7 @@ SilcBool silc_hash_table_find_by_context_ext(SilcHashTable ht, void *key, SilcHashCompare compare, void *compare_user_context); -/****f* silcutil/SilcHashTableAPI/silc_hash_table_find_foreach_ext +/****f* silcutil/silc_hash_table_find_foreach_ext * * SYNOPSIS * @@ -710,7 +721,7 @@ void silc_hash_table_find_foreach_ext(SilcHashTable ht, void *key, SilcHashForeach foreach, void *foreach_user_context); -/****f* silcutil/SilcHashTableAPI/silc_hash_table_rehash_ext +/****f* silcutil/silc_hash_table_rehash_ext * * SYNOPSIS * @@ -733,4 +744,174 @@ void silc_hash_table_rehash_ext(SilcHashTable ht, SilcUInt32 new_size, SilcHashFunction hash, void *hash_user_context); +/* Hash functions */ + +/****f* silcutil/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/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/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/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/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/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/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/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/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/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); + +/* Destructor functions */ + +/****f* silcutil/silc_hash_destructor + * + * SYNOPSIS + * + * void silc_hash_destructor(void *key, void *context, void *user_context); + * + * DESCRIPTION + * + * A generic destructor for SilcHashTable. This will call silc_free for + * `key' and `context'. + * + ***/ +void silc_hash_destructor(void *key, void *context, void *user_context); + #endif