Subversion Repositories HelenOS-historic

Rev

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