WebSVN – HelenOS – Diff – /branches/tracing/kernel/generic/include/adt/hash_table.h


/*
 * 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
 */
 
#ifndef KERN_HASH_TABLE_H_
#define KERN_HASH_TABLE_H_
 
#include <adt/list.h>
#include <arch/types.h>
 
/** Set of operations for hash table. */
typedef struct {
    /** Hash function.
     *
     * @param key   Array of keys needed to compute hash index. All keys must
     *      be passed.
     *
     * @return Index into hash table.
     */
    size_t (* hash)(unative_t key[]);
   
    /** Hash table item comparison function.
     *
     * @param key   Array of keys that will be compared with item. It is not
     *      necessary to pass all keys.
     *
     * @return true if the keys match, false otherwise.
     */
    bool (*compare)(unative_t key[], size_t keys, link_t *item);
 
    /** Hash table item removal callback.
     *
     * @param item Item that was removed from the hash table.
     */
    void (*remove_callback)(link_t *item);
} hash_table_operations_t;
 
/** Hash table structure. */
typedef struct {
    link_t *entry;
    size_t entries;
    size_t max_keys;
    hash_table_operations_t *op;
} hash_table_t;
 
#define hash_table_get_instance(item, type, member) \
    list_get_instance((item), type, member)
 
extern void hash_table_create(hash_table_t *h, size_t m, size_t max_keys,
    hash_table_operations_t *op);
extern void hash_table_insert(hash_table_t *h, unative_t key[], link_t *item);
extern link_t *hash_table_find(hash_table_t *h, unative_t key[]);
extern void hash_table_remove(hash_table_t *h, unative_t key[], size_t keys);
 
#endif
 
/** @}
 */
 

Rev 2787	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 genericadt	29	/** @addtogroup genericadt
30	* @{	30	* @{
31	*/	31	*/
32	/** @file	32	/** @file
33	*/	33	*/
34		34
35	#ifndef KERN_HASH_TABLE_H_	35	#ifndef KERN_HASH_TABLE_H_
36	#define KERN_HASH_TABLE_H_	36	#define KERN_HASH_TABLE_H_
37		37
38	#include <adt/list.h>	38	#include <adt/list.h>
39	#include <arch/types.h>	39	#include <arch/types.h>
40		40
41	/** Set of operations for hash table. */	41	/** Set of operations for hash table. */
42	typedef struct {	42	typedef struct {
43	/** Hash function.	43	/** Hash function.
44	*	44	*
45	* @param key Array of keys needed to compute hash index. All keys must	45	* @param key Array of keys needed to compute hash index. All keys must
46	* be passed.	46	* be passed.
47	*	47	*
48	* @return Index into hash table.	48	* @return Index into hash table.
49	*/	49	*/
50	index_t (* hash)(unative_t key[]);	50	size_t (* hash)(unative_t key[]);
51		51
52	/** Hash table item comparison function.	52	/** Hash table item comparison function.
53	*	53	*
54	* @param key Array of keys that will be compared with item. It is not	54	* @param key Array of keys that will be compared with item. It is not
55	* necessary to pass all keys.	55	* necessary to pass all keys.
56	*	56	*
57	* @return true if the keys match, false otherwise.	57	* @return true if the keys match, false otherwise.
58	*/	58	*/
59	bool (compare)(unative_t key[], count_t keys, link_t item);	59	bool (compare)(unative_t key[], size_t keys, link_t item);
60		60
61	/** Hash table item removal callback.	61	/** Hash table item removal callback.
62	*	62	*
63	* @param item Item that was removed from the hash table.	63	* @param item Item that was removed from the hash table.
64	*/	64	*/
65	void (remove_callback)(link_t item);	65	void (remove_callback)(link_t item);
66	} hash_table_operations_t;	66	} hash_table_operations_t;
67		67
68	/** Hash table structure. */	68	/** Hash table structure. */
69	typedef struct {	69	typedef struct {
70	link_t *entry;	70	link_t *entry;
71	count_t entries;	71	size_t entries;
72	count_t max_keys;	72	size_t max_keys;
73	hash_table_operations_t *op;	73	hash_table_operations_t *op;
74	} hash_table_t;	74	} hash_table_t;
75		75
76	#define hash_table_get_instance(item, type, member) \	76	#define hash_table_get_instance(item, type, member) \
77	list_get_instance((item), type, member)	77	list_get_instance((item), type, member)
78		78
79	extern void hash_table_create(hash_table_t *h, count_t m, count_t max_keys,	79	extern void hash_table_create(hash_table_t *h, size_t m, size_t max_keys,
80	hash_table_operations_t *op);	80	hash_table_operations_t *op);
81	extern void hash_table_insert(hash_table_t h, unative_t key[], link_t item);	81	extern void hash_table_insert(hash_table_t h, unative_t key[], link_t item);
82	extern link_t hash_table_find(hash_table_t h, unative_t key[]);	82	extern link_t hash_table_find(hash_table_t h, unative_t key[]);
83	extern void hash_table_remove(hash_table_t *h, unative_t key[], count_t keys);	83	extern void hash_table_remove(hash_table_t *h, unative_t key[], size_t keys);
84		84
85	#endif	85	#endif
86		86
87	/** @}	87	/** @}
88	*/	88	*/
89		89

Subversion Repositories HelenOS

(root)/branches/tracing/kernel/generic/include/adt/hash_table.h – Rev 2787 → 4692