Subversion Repositories HelenOS

Rev

Rev 2787 | Blame | Compare with Previous | Last modification | View Log | Download | RSS feed

  1. /*
  2.  * Copyright (c) 2006 Jakub Jermar
  3.  * All rights reserved.
  4.  *
  5.  * Redistribution and use in source and binary forms, with or without
  6.  * modification, are permitted provided that the following conditions
  7.  * are met:
  8.  *
  9.  * - Redistributions of source code must retain the above copyright
  10.  *   notice, this list of conditions and the following disclaimer.
  11.  * - Redistributions in binary form must reproduce the above copyright
  12.  *   notice, this list of conditions and the following disclaimer in the
  13.  *   documentation and/or other materials provided with the distribution.
  14.  * - The name of the author may not be used to endorse or promote products
  15.  *   derived from this software without specific prior written permission.
  16.  *
  17.  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  18.  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  19.  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  20.  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  21.  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  22.  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23.  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24.  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25.  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26.  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27.  */
  28.  
  29. /** @addtogroup genericadt
  30.  * @{
  31.  */
  32. /** @file
  33.  */
  34.  
  35. #ifndef KERN_HASH_TABLE_H_
  36. #define KERN_HASH_TABLE_H_
  37.  
  38. #include <adt/list.h>
  39. #include <arch/types.h>
  40.  
  41. /** Set of operations for hash table. */
  42. typedef struct {
  43.     /** Hash function.
  44.      *
  45.      * @param key   Array of keys needed to compute hash index. All keys must
  46.      *      be passed.
  47.      *
  48.      * @return Index into hash table.
  49.      */
  50.     size_t (* hash)(unative_t key[]);
  51.    
  52.     /** Hash table item comparison function.
  53.      *
  54.      * @param key   Array of keys that will be compared with item. It is not
  55.      *      necessary to pass all keys.
  56.      *
  57.      * @return true if the keys match, false otherwise.
  58.      */
  59.     bool (*compare)(unative_t key[], size_t keys, link_t *item);
  60.  
  61.     /** Hash table item removal callback.
  62.      *
  63.      * @param item Item that was removed from the hash table.
  64.      */
  65.     void (*remove_callback)(link_t *item);
  66. } hash_table_operations_t;
  67.  
  68. /** Hash table structure. */
  69. typedef struct {
  70.     link_t *entry;
  71.     size_t entries;
  72.     size_t max_keys;
  73.     hash_table_operations_t *op;
  74. } hash_table_t;
  75.  
  76. #define hash_table_get_instance(item, type, member) \
  77.     list_get_instance((item), type, member)
  78.  
  79. extern void hash_table_create(hash_table_t *h, size_t m, size_t max_keys,
  80.     hash_table_operations_t *op);
  81. extern void hash_table_insert(hash_table_t *h, unative_t key[], link_t *item);
  82. extern link_t *hash_table_find(hash_table_t *h, unative_t key[]);
  83. extern void hash_table_remove(hash_table_t *h, unative_t key[], size_t keys);
  84.  
  85. #endif
  86.  
  87. /** @}
  88.  */
  89.