1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
|
/* ihash.h - Integer keyed hash table interface.
Copyright (C) 1995, 2003 Free Software Foundation, Inc.
Written by Miles Bader <miles@gnu.org>.
Revised by Marcus Brinkmann <marcus@gnu.org>.
This file is part of the GNU Hurd.
The GNU Hurd is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License as
published by the Free Software Foundation; either version 2, or (at
your option) any later version.
The GNU Hurd is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License
along with the GNU Hurd; if not, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */
#ifndef _HURD_IHASH_H
#define _HURD_IHASH_H 1
#include <errno.h>
#include <sys/types.h>
#include <limits.h>
#include <stdint.h>
/* The type of the values corresponding to the keys. Must be a
pointer type. The values (hurd_ihash_value_t) 0 and
(hurd_ihash_value_t) ~0 are reserved for the implementation. */
typedef void *hurd_ihash_value_t;
/* When an value entry in the hash table is _HURD_IHASH_EMPTY or
_HURD_IHASH_DELETED, then the location is available, and none of
the other members of the item are valid at that index. The
difference is that searches continue though _HURD_IHASH_DELETED,
but stop at _HURD_IHASH_EMPTY. */
#define _HURD_IHASH_EMPTY ((hurd_ihash_value_t) 0)
#define _HURD_IHASH_DELETED ((hurd_ihash_value_t) -1)
/* The type of integer we want to use for the keys. */
typedef uintptr_t hurd_ihash_key_t;
/* The type of a location pointer, which is a pointer to the hash
value stored in the hash table. */
typedef hurd_ihash_value_t *hurd_ihash_locp_t;
/* The type of the cleanup function, which is called for every value
removed from the hash table. */
typedef void (*hurd_ihash_cleanup_t) (hurd_ihash_value_t value, void *arg);
struct _hurd_ihash_item
{
/* The value of this hash item. Must be the first element of
the struct for the HURD_IHASH_ITERATE macro. */
hurd_ihash_value_t value;
/* The integer key of this hash item. */
hurd_ihash_key_t key;
};
typedef struct _hurd_ihash_item *_hurd_ihash_item_t;
struct hurd_ihash
{
/* The number of hashed elements. */
size_t nr_items;
/* An array of (key, value) pairs. */
_hurd_ihash_item_t items;
/* The length of the array ITEMS. */
size_t size;
/* The offset of the location pointer from the hash value. */
off_t locp_offset;
/* The maximum load factor in percent. */
int max_load;
/* When freeing or overwriting an element, this function is called
with the value as the first argument, and CLEANUP_DATA as the
second argument. This does not happen if CLEANUP is NULL. */
hurd_ihash_cleanup_t cleanup;
void *cleanup_data;
};
typedef struct hurd_ihash *hurd_ihash_t;
/* Construction and destruction of hash tables. */
/* The default value for the maximum load factor in percent. */
#define HURD_IHASH_MAX_LOAD_DEFAULT 80
/* The LOCP_OFFS to use if no location pointer is available. */
#define HURD_IHASH_NO_LOCP INT_MIN
/* The static initializer for a struct hurd_ihash. */
#define HURD_IHASH_INITIALIZER(locp_offs) \
{ .nr_items = 0, .size = 0, .cleanup = (hurd_ihash_cleanup_t) 0, \
.max_load = HURD_IHASH_MAX_LOAD_DEFAULT, \
.locp_offset = (locp_offs)}
/* Initialize the hash table at address HT. If LOCP_OFFSET is not
HURD_IHASH_NO_LOCP, then this is an offset (in bytes) from the
address of a hash value where a location pointer can be found. The
location pointer must be of type hurd_ihash_locp_t and can be used
for fast removal with hurd_ihash_locp_remove(). */
void hurd_ihash_init (hurd_ihash_t ht, off_t locp_offs);
/* Destroy the hash table at address HT. This first removes all
elements which are still in the hash table, and calling the cleanup
function for them (if any). */
void hurd_ihash_destroy (hurd_ihash_t ht);
/* Create a hash table, initialize it and return it in HT. If
LOCP_OFFSET is not HURD_IHASH_NO_LOCP, then this is an offset (in
bytes) from the address of a hash value where a location pointer
can be found. The location pointer must be of type
hurd_ihash_locp_t and can be used for fast removal with
hurd_ihash_locp_remove(). If a memory allocation error occurs,
ENOMEM is returned, otherwise 0. */
error_t hurd_ihash_create (hurd_ihash_t *ht, off_t locp_offs);
/* Destroy the hash table HT and release the memory allocated for it
by hurd_ihash_create(). */
void hurd_ihash_free (hurd_ihash_t ht);
/* Configuration of the hash table. */
/* Set the cleanup function for the hash table HT to CLEANUP. The
second argument to CLEANUP will be CLEANUP_DATA on every
invocation. */
void hurd_ihash_set_cleanup (hurd_ihash_t ht, hurd_ihash_cleanup_t cleanup,
void *cleanup_data);
/* Set the maximum load factor in percent to MAX_LOAD, which should be
between 50 and 100. The default is HURD_IHASH_MAX_LOAD_DEFAULT.
New elements are only added to the hash table while the number of
hashed elements is that much percent of the total size of the hash
table. If more elements are added, the hash table is first
expanded and reorganized. A MAX_LOAD of 100 will always fill the
whole table before enlarging it, but note that this will increase
the cost of operations significantly when the table is almost full.
If the value is set to a smaller value than the current load
factor, the next reorganization will happen when a new item is
added to the hash table. */
void hurd_ihash_set_max_load (hurd_ihash_t ht, unsigned int max_load);
/* Add ITEM to the hash table HT under the key KEY. If there already
is an item under this key, call the cleanup function (if any) for
it before overriding the value. If a memory allocation error
occurs, ENOMEM is returned, otherwise 0. */
error_t hurd_ihash_add (hurd_ihash_t ht, hurd_ihash_key_t key,
hurd_ihash_value_t item);
/* Find and return the item in the hash table HT with key KEY, or NULL
if it doesn't exist. */
hurd_ihash_value_t hurd_ihash_find (hurd_ihash_t ht, hurd_ihash_key_t key);
/* Iterate over all elements in the hash table. You use this macro
with a block, for example like this:
error_t err;
HURD_IHASH_ITERATE (ht, value)
{
err = foo (value);
if (err)
break;
}
if (err)
cleanup_and_return ();
Or even like this:
hurd_ihash_iterate (ht, value)
foo (value);
The block will be run for every element in the hash table HT. The
value of the current element is available in the variable VALUE
(which is declared for you and local to the block). */
/* The implementation of this macro is peculiar. We want the macro to
execute a block following its invocation, so we can only prepend
code. This excludes creating an outer block. However, we must
define two variables: The hash value variable VALUE, and the loop
variable.
We can define variables inside the for-loop initializer (C99), but
we can only use one basic type to do that. We can not use two
for-loops, because we want a break statement inside the iterator
block to terminate the operation. So we must have both variables
of the same basic type, but we can make one (or both) of them a
pointer type.
The pointer to the value can be used as the loop variable. This is
also the first element of the hash item, so we can cast the pointer
freely between these two types. The pointer is only dereferenced
after the loop condition is checked (but of course the value the
pointer pointed to must not have an influence on the condition
result, so the comma operator is used to make sure this
subexpression is always true). */
#define HURD_IHASH_ITERATE(ht, val) \
for (hurd_ihash_value_t val, \
*_hurd_ihash_valuep = (ht)->size ? &(ht)->items[0].value : 0; \
(ht)->size \
&& ((_hurd_ihash_item_t) _hurd_ihash_valuep) - &(ht)->items[0] \
< (ht)->size \
&& (val = *_hurd_ihash_valuep, 1); \
_hurd_ihash_valuep = (hurd_ihash_value_t *) \
(((_hurd_ihash_item_t) _hurd_ihash_valuep)++)) \
if (val != _HURD_IHASH_EMPTY && val != _HURD_IHASH_DELETED)
/* Remove the entry with the key KEY from the hash table HT. If such
an entry was found and removed, 1 is returned, otherwise 0. */
int hurd_ihash_remove (hurd_ihash_t ht, hurd_ihash_key_t key);
/* Remove the entry pointed to by the location pointer LOCP from the
hash table HT. LOCP is the location pointer of which the address
was provided to hurd_ihash_add(). This call is faster than
hurd_ihash_remove(). */
void hurd_ihash_locp_remove (hurd_ihash_t ht, hurd_ihash_locp_t locp);
#endif /* _HURD_IHASH_H */
|
