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

Subversion Repositories HelenOS-historic

(root)/kernel/trunk/generic/src/adt/hash_table.c – Rev 1337 → 1702