Subversion Repositories HelenOS

Rev

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

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