Subversion Repositories HelenOS

Rev

Rev 4153 | Go to most recent revision | Only display areas with differences | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 4153 Rev 4263
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 genericadt
29
/** @addtogroup genericadt
30
 * @{
30
 * @{
31
 */
31
 */
32
 
32
 
33
/**
33
/**
34
 * @file
34
 * @file
35
 * @brief   Implementation of generic chained hash table.
35
 * @brief Implementation of generic chained hash table.
36
 *
36
 *
37
 * This file contains implementation of generic chained hash table.
37
 * This file contains implementation of generic chained hash table.
38
 */
38
 */
39
 
39
 
40
#include <adt/hash_table.h>
40
#include <adt/hash_table.h>
41
#include <adt/list.h>
41
#include <adt/list.h>
42
#include <arch/types.h>
42
#include <arch/types.h>
43
#include <debug.h>
43
#include <debug.h>
44
#include <mm/slab.h>
44
#include <mm/slab.h>
45
#include <memstr.h>
45
#include <memstr.h>
46
 
46
 
47
/** Create chained hash table.
47
/** Create chained hash table.
48
 *
48
 *
49
 * @param h Hash table structure. Will be initialized by this call.
49
 * @param h Hash table structure. Will be initialized by this call.
50
 * @param m Number of slots in the hash table.
50
 * @param m Number of slots in the hash table.
51
 * @param max_keys Maximal number of keys needed to identify an item.
51
 * @param max_keys Maximal number of keys needed to identify an item.
52
 * @param op Hash table operations structure.
52
 * @param op Hash table operations structure.
53
 */
53
 */
54
void hash_table_create(hash_table_t *h, count_t m, count_t max_keys, hash_table_operations_t *op)
54
void hash_table_create(hash_table_t *h, count_t m, count_t max_keys, hash_table_operations_t *op)
55
{
55
{
56
    index_t i;
56
    index_t i;
57
 
57
 
58
    ASSERT(h);
58
    ASSERT(h);
-
 
59
    ASSERT(op);
-
 
60
    ASSERT(op->hash);
59
    ASSERT(op && op->hash && op->compare);
61
    ASSERT(op->compare);
60
    ASSERT(max_keys > 0);
62
    ASSERT(max_keys > 0);
61
   
63
   
62
    h->entry = (link_t *) malloc(m * sizeof(link_t), 0);
64
    h->entry = (link_t *) malloc(m * sizeof(link_t), 0);
63
    if (!h->entry) {
65
    if (!h->entry)
64
        panic("Cannot allocate memory for hash table.");
66
        panic("Cannot allocate memory for hash table.");
65
    }
67
   
66
    memsetb(h->entry, m * sizeof(link_t), 0);
68
    memsetb(h->entry, m * sizeof(link_t), 0);
67
   
69
   
68
    for (i = 0; i < m; i++)
70
    for (i = 0; i < m; i++)
69
        list_initialize(&h->entry[i]);
71
        list_initialize(&h->entry[i]);
70
   
72
   
71
    h->entries = m;
73
    h->entries = m;
72
    h->max_keys = max_keys;
74
    h->max_keys = max_keys;
73
    h->op = op;
75
    h->op = op;
74
}
76
}
75
 
77
 
76
/** Insert item into hash table.
78
/** Insert item into hash table.
77
 *
79
 *
78
 * @param h Hash table.
80
 * @param h Hash table.
79
 * @param key Array of all keys necessary to compute hash index.
81
 * @param key Array of all keys necessary to compute hash index.
80
 * @param item Item to be inserted into the hash table.
82
 * @param item Item to be inserted into the hash table.
81
 */
83
 */
82
void hash_table_insert(hash_table_t *h, unative_t key[], link_t *item)
84
void hash_table_insert(hash_table_t *h, unative_t key[], link_t *item)
83
{
85
{
84
    index_t chain;
86
    index_t chain;
85
 
87
   
86
    ASSERT(item);
88
    ASSERT(item);
-
 
89
    ASSERT(h);
-
 
90
    ASSERT(h->op);
-
 
91
    ASSERT(h->op->hash);
87
    ASSERT(h && h->op && h->op->hash && h->op->compare);
92
    ASSERT(h->op->compare);
88
 
93
   
89
    chain = h->op->hash(key);
94
    chain = h->op->hash(key);
90
    ASSERT(chain < h->entries);
95
    ASSERT(chain < h->entries);
91
   
96
   
92
    list_append(item, &h->entry[chain]);
97
    list_append(item, &h->entry[chain]);
93
}
98
}
94
 
99
 
95
/** Search hash table for an item matching keys.
100
/** Search hash table for an item matching keys.
96
 *
101
 *
97
 * @param h Hash table.
102
 * @param h Hash table.
98
 * @param key Array of all keys needed to compute hash index.
103
 * @param key Array of all keys needed to compute hash index.
99
 *
104
 *
100
 * @return Matching item on success, NULL if there is no such item.
105
 * @return Matching item on success, NULL if there is no such item.
101
 */
106
 */
102
link_t *hash_table_find(hash_table_t *h, unative_t key[])
107
link_t *hash_table_find(hash_table_t *h, unative_t key[])
103
{
108
{
104
    link_t *cur;
109
    link_t *cur;
105
    index_t chain;
110
    index_t chain;
106
 
111
   
-
 
112
    ASSERT(h);
-
 
113
    ASSERT(h->op);
-
 
114
    ASSERT(h->op->hash);
107
    ASSERT(h && h->op && h->op->hash && h->op->compare);
115
    ASSERT(h->op->compare);
108
 
116
   
109
    chain = h->op->hash(key);
117
    chain = h->op->hash(key);
110
    ASSERT(chain < h->entries);
118
    ASSERT(chain < h->entries);
111
   
119
   
112
    for (cur = h->entry[chain].next; cur != &h->entry[chain]; cur = cur->next) {
120
    for (cur = h->entry[chain].next; cur != &h->entry[chain]; cur = cur->next) {
113
        if (h->op->compare(key, h->max_keys, cur)) {
121
        if (h->op->compare(key, h->max_keys, cur)) {
114
            /*
122
            /*
115
             * The entry is there.
123
             * The entry is there.
116
             */
124
             */
117
            return cur;
125
            return cur;
118
        }
126
        }
119
    }
127
    }
120
   
128
   
121
    return NULL;
129
    return NULL;
122
}
130
}
123
 
131
 
124
/** Remove all matching items from hash table.
132
/** Remove all matching items from hash table.
125
 *
133
 *
126
 * For each removed item, h->remove_callback() is called.
134
 * For each removed item, h->remove_callback() is called (if not NULL).
127
 *
135
 *
128
 * @param h Hash table.
136
 * @param h Hash table.
129
 * @param key Array of keys that will be compared against items of the hash table.
137
 * @param key Array of keys that will be compared against items of the hash table.
130
 * @param keys Number of keys in the key array.
138
 * @param keys Number of keys in the key array.
131
 */
139
 */
132
void hash_table_remove(hash_table_t *h, unative_t key[], count_t keys)
140
void hash_table_remove(hash_table_t *h, unative_t key[], count_t keys)
133
{
141
{
134
    index_t chain;
142
    index_t chain;
135
    link_t *cur;
143
    link_t *cur;
136
 
144
   
-
 
145
    ASSERT(h);
-
 
146
    ASSERT(h->op);
-
 
147
    ASSERT(h->op->hash);
137
    ASSERT(h && h->op && h->op->hash && h->op->compare && h->op->remove_callback);
148
    ASSERT(h->op->compare);
138
    ASSERT(keys <= h->max_keys);
149
    ASSERT(keys <= h->max_keys);
139
   
150
   
140
    if (keys == h->max_keys) {
151
    if (keys == h->max_keys) {
141
 
152
   
142
        /*
153
        /*
143
         * All keys are known, hash_table_find() can be used to find the entry.
154
         * All keys are known, hash_table_find() can be used to find the entry.
144
         */
155
         */
145
   
156
   
146
        cur = hash_table_find(h, key);
157
        cur = hash_table_find(h, key);
147
        if (cur) {
158
        if (cur) {
148
            list_remove(cur);
159
            list_remove(cur);
-
 
160
            if (h->op->remove_callback)
149
            h->op->remove_callback(cur);
161
                h->op->remove_callback(cur);
150
        }
162
        }
151
        return;
163
        return;
152
    }
164
    }
153
   
165
   
154
    /*
166
    /*
155
     * Fewer keys were passed.
167
     * Fewer keys were passed.
156
     * Any partially matching entries are to be removed.
168
     * Any partially matching entries are to be removed.
157
     */
169
     */
158
    for (chain = 0; chain < h->entries; chain++) {
170
    for (chain = 0; chain < h->entries; chain++) {
159
        for (cur = h->entry[chain].next; cur != &h->entry[chain]; cur = cur->next) {
171
        for (cur = h->entry[chain].next; cur != &h->entry[chain]; cur = cur->next) {
160
            if (h->op->compare(key, keys, cur)) {
172
            if (h->op->compare(key, keys, cur)) {
161
                link_t *hlp;
173
                link_t *hlp;
162
               
174
               
163
                hlp = cur;
175
                hlp = cur;
164
                cur = cur->prev;
176
                cur = cur->prev;
165
               
177
               
166
                list_remove(hlp);
178
                list_remove(hlp);
-
 
179
                if (h->op->remove_callback)
167
                h->op->remove_callback(hlp);
180
                    h->op->remove_callback(hlp);
168
               
181
               
169
                continue;
182
                continue;
170
            }
183
            }
171
        }
184
        }
172
    }
185
    }
173
}
186
}
174
 
187
 
175
/** @}
188
/** @}
176
 */
189
 */
177
 
190