Rev 792 | Go to most recent revision | Details | Last modification | View Log | RSS feed
Rev | Author | Line No. | Line |
---|---|---|---|
790 | jermar | 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 | #ifndef __HASH_TABLE_H__ |
||
30 | #define __HASH_TABLE_H__ |
||
31 | |||
32 | #include <arch/types.h> |
||
33 | #include <typedefs.h> |
||
34 | #include <adt/list.h> |
||
35 | |||
36 | /** Hash table structure. */ |
||
37 | struct hash_table { |
||
38 | link_t *entry; |
||
39 | count_t entries; |
||
40 | count_t max_keys; |
||
41 | hash_table_operations_t *op; |
||
42 | }; |
||
43 | |||
44 | /** Set of operations for hash table. */ |
||
45 | struct hash_table_operations { |
||
46 | /** Hash function. |
||
47 | * |
||
48 | * @param key Array of keys needed to compute hash index. All keys must be passed. |
||
49 | * |
||
50 | * @return Index into hash table. |
||
51 | */ |
||
52 | index_t (* hash)(__native key[]); |
||
53 | |||
54 | /** Hash table item comparison function. |
||
55 | * |
||
56 | * @param key Array of keys that will be compared against item. It is not necessary to pass all keys. |
||
57 | * |
||
58 | * @return true if the keys match, false otherwise. |
||
59 | */ |
||
60 | bool (*compare)(__native key[], count_t keys, link_t *item); |
||
61 | |||
62 | /** Hash table item removal callback. |
||
63 | * |
||
64 | * @param item Item that was removed from the hash table. |
||
65 | */ |
||
66 | void (*remove_callback)(link_t *item); |
||
67 | }; |
||
68 | |||
69 | #define hash_table_get_instance(item, type, member) list_get_instance((item), (type), (member)) |
||
70 | |||
71 | extern void hash_table_create(hash_table_t *h, count_t m, count_t max_keys, hash_table_operations_t *op); |
||
72 | extern bool hash_table_insert(hash_table_t *h, __native key[], link_t *item); |
||
73 | extern link_t *hash_table_find(hash_table_t *h, __native key[]); |
||
74 | extern void hash_table_remove(hash_table_t *h, __native key[], count_t keys); |
||
75 | |||
76 | #endif |