Subversion Repositories HelenOS-historic

Rev

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