Rev 4509 | Details | Compare with Previous | Last modification | View Log | RSS feed
| Rev | Author | Line No. | Line |
|---|---|---|---|
| 996 | cejka | 1 | /* |
| 2071 | jermar | 2 | * Copyright (c) 2006 Jakub Jermar |
| 996 | cejka | 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 | |||
| 1866 | jermar | 29 | /** @addtogroup libc |
| 1653 | cejka | 30 | * @{ |
| 31 | */ |
||
| 32 | /** @file |
||
| 33 | */ |
||
| 34 | |||
| 1866 | jermar | 35 | #ifndef LIBC_HASH_TABLE_H_ |
| 36 | #define LIBC_HASH_TABLE_H_ |
||
| 996 | cejka | 37 | |
| 4509 | decky | 38 | #include <adt/list.h> |
| 996 | cejka | 39 | #include <unistd.h> |
| 40 | |||
| 41 | typedef unsigned long hash_count_t; |
||
| 42 | typedef unsigned long hash_index_t; |
||
| 43 | typedef struct hash_table hash_table_t; |
||
| 44 | typedef struct hash_table_operations hash_table_operations_t; |
||
| 45 | |||
| 46 | /** Hash table structure. */ |
||
| 47 | struct hash_table { |
||
| 48 | link_t *entry; |
||
| 49 | hash_count_t entries; |
||
| 50 | hash_count_t max_keys; |
||
| 51 | hash_table_operations_t *op; |
||
| 52 | }; |
||
| 53 | |||
| 54 | /** Set of operations for hash table. */ |
||
| 55 | struct hash_table_operations { |
||
| 56 | /** Hash function. |
||
| 57 | * |
||
| 2526 | jermar | 58 | * @param key Array of keys needed to compute hash index. All keys |
| 59 | * must be passed. |
||
| 996 | cejka | 60 | * |
| 2526 | jermar | 61 | * @return Index into hash table. |
| 996 | cejka | 62 | */ |
| 997 | cejka | 63 | hash_index_t (* hash)(unsigned long key[]); |
| 996 | cejka | 64 | |
| 65 | /** Hash table item comparison function. |
||
| 66 | * |
||
| 2526 | jermar | 67 | * @param key Array of keys that will be compared with item. It is |
| 68 | * not necessary to pass all keys. |
||
| 996 | cejka | 69 | * |
| 2526 | jermar | 70 | * @return true if the keys match, false otherwise. |
| 996 | cejka | 71 | */ |
| 997 | cejka | 72 | int (*compare)(unsigned long key[], hash_count_t keys, link_t *item); |
| 996 | cejka | 73 | |
| 74 | /** Hash table item removal callback. |
||
| 75 | * |
||
| 2526 | jermar | 76 | * @param item Item that was removed from the hash table. |
| 996 | cejka | 77 | */ |
| 78 | void (*remove_callback)(link_t *item); |
||
| 79 | }; |
||
| 80 | |||
| 2595 | jermar | 81 | #define hash_table_get_instance(item, type, member) \ |
| 82 | list_get_instance((item), type, member) |
||
| 996 | cejka | 83 | |
| 2595 | jermar | 84 | extern int hash_table_create(hash_table_t *, hash_count_t, hash_count_t, |
| 85 | hash_table_operations_t *); |
||
| 86 | extern void hash_table_insert(hash_table_t *, unsigned long [], link_t *); |
||
| 87 | extern link_t *hash_table_find(hash_table_t *, unsigned long []); |
||
| 88 | extern void hash_table_remove(hash_table_t *, unsigned long [], hash_count_t); |
||
| 2759 | jermar | 89 | extern void hash_table_destroy(hash_table_t *); |
| 996 | cejka | 90 | |
| 91 | #endif |
||
| 1653 | cejka | 92 | |
| 1866 | jermar | 93 | /** @} |
| 1653 | cejka | 94 | */ |