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