WebSVN – HelenOS-historic – Diff – /kernel/trunk/generic/src/adt/hash_table.c


/*
 * Copyright (C) 2006 Jakub Jermar
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * - Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 * - The name of the author may not be used to endorse or promote products
 *   derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
/**
 * @file    hash_table.c
 * @brief   Implementation of generic chained hash table.
 *
 * This file contains implementation of generic chained hash table.
 */
 
#include <adt/hash_table.h>
#include <adt/list.h>
#include <typedefs.h>
#include <arch/types.h>
#include <debug.h>
#include <mm/slab.h>
#include <memstr.h>
 
/** Create chained hash table.
 *
 * @param h Hash table structure. Will be initialized by this call.
 * @param m Number of slots in the hash table.
 * @param max_keys Maximal number of keys needed to identify an item.
 * @param op Hash table operations structure.
 */
void hash_table_create(hash_table_t *h, count_t m, count_t max_keys, hash_table_operations_t *op)
{
    int i;
 
    ASSERT(h);
    ASSERT(op && op->hash && op->compare);
    ASSERT(max_keys > 0);
   
    h->entry = malloc(m * sizeof(link_t), 0);
    if (!h->entry) {
        panic("cannot allocate memory for hash table\n");
    }
    memsetb((__address) h->entry, m * sizeof(link_t), 0);
   
    for (i = 0; i < m; i++)
        list_initialize(&h->entry[i]);
   
    h->entries = m;
    h->max_keys = max_keys;
    h->op = op;
}
 
/** Insert item into hash table.
 *
 * @param h Hash table.
 * @param hey Array of all keys necessary to compute hash index.
 * @param item Item to be inserted into the hash table.
 */
void hash_table_insert(hash_table_t *h, __native key[], link_t *item)
{
    index_t chain;
 
    ASSERT(item);
    ASSERT(h && h->op && h->op->hash && h->op->compare);
 
    chain = h->op->hash(key);
    ASSERT(chain < h->entries);
   
    list_append(item, &h->entry[chain]);
}
 
/** Search hash table for an item matching keys.
 *
 * @param h Hash table.
 * @param key Array of all keys needed to compute hash index.
 *
 * @return Matching item on success, NULL if there is no such item.
 */
link_t *hash_table_find(hash_table_t *h, __native key[])
{
    link_t *cur;
    index_t chain;
 
    ASSERT(h && h->op && h->op->hash && h->op->compare);
 
    chain = h->op->hash(key);
    ASSERT(chain < h->entries);
   
    /*
     * The hash table is not redundant.
     * Check if the keys are not in place already.
     */
    for (cur = h->entry[chain].next; cur != &h->entry[chain]; cur = cur->next) {
        if (h->op->compare(key, h->max_keys, cur)) {
            /*
             * The entry is there.
             */
            return cur;
        }
    }
   
    return NULL;
}
 
/** Remove all matching items from hash table.
 *
 * For each removed item, h->remove_callback() is called.
 *
 * @param h Hash table.
 * @param key Array of keys that will be compared against items of the hash table.
 * @param keys Number of keys in the key array.
 */
void hash_table_remove(hash_table_t *h, __native key[], count_t keys)
{
    index_t chain;
    link_t *cur;
 
    ASSERT(h && h->op && h->op->hash && h->op->compare && h->op->remove_callback);
    ASSERT(keys <= h->max_keys);
   
    if (keys == h->max_keys) {
 
        /*
         * All keys are known, hash_table_find() can be used to find the entry.
         */
   
        cur = hash_table_find(h, key);
        if (cur) {
            list_remove(cur);
            h->op->remove_callback(cur);
        }
        return;
    }
   
    /*
     * Fewer keys were passed.
     * Any partially matching entries are to be removed.
     */
    for (chain = 0; chain < h->entries; chain++) {
        for (cur = h->entry[chain].next; cur != &h->entry[chain]; cur = cur->next) {
            if (h->op->compare(key, keys, cur)) {
                link_t *hlp;
               
                hlp = cur;
                cur = cur->prev;
               
                list_remove(hlp);
                h->op->remove_callback(hlp);
               
                continue;
            }
        }
    }
}
 

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

Subversion Repositories HelenOS-historic

(root)/kernel/trunk/generic/src/adt/hash_table.c @ 1780 – Rev 1154 → 1248