]>
git.ipfire.org Git - thirdparty/gcc.git/blob - libiberty/hashtab.c
1 /* An expandable hash tables datatype.
2 Copyright (C) 1999 Free Software Foundation, Inc.
3 Contributed by Vladimir Makarov (vmakarov@cygnus.com).
5 This file is part of the libiberty library.
6 Libiberty is free software; you can redistribute it and/or
7 modify it under the terms of the GNU Library General Public
8 License as published by the Free Software Foundation; either
9 version 2 of the License, or (at your option) any later version.
11 Libiberty is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 Library General Public License for more details.
16 You should have received a copy of the GNU Library General Public
17 License along with libiberty; see the file COPYING.LIB. If
18 not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 Boston, MA 02111-1307, USA. */
21 /* This package implements basic hash table functionality. It is possible
22 to search for an entry, create an entry and destroy an entry.
24 Elements in the table are generic pointers.
26 The size of the table is not fixed; if the occupancy of the table
27 grows too high the hash table will be expanded.
29 The abstract data implementation is based on generalized Algorithm D
30 from Knuth's book "The art of computer programming". Hash table is
31 expanded by creation of new hash table and transferring elements from
32 the old table to the new table. */
38 #include <sys/types.h>
46 #include "libiberty.h"
49 /* This macro defines reserved value for empty table entry. */
51 #define EMPTY_ENTRY ((void *) 0)
53 /* This macro defines reserved value for table entry which contained
56 #define DELETED_ENTRY ((void *) 1)
58 /* The following function returns the nearest prime number which is
59 greater than given source number. */
62 higher_prime_number (n
)
67 n
|= 0x01; /* Force N to be odd. */
69 return n
; /* All odd numbers < 9 are prime. */
85 /* This function creates table with length slightly longer than given
86 source length. Created hash table is initiated as empty (all the
87 hash table entries are EMPTY_ENTRY). The function returns the
88 created hash table. */
91 htab_create (size
, hash_f
, eq_f
)
98 size
= higher_prime_number (size
);
99 result
= (htab_t
) xcalloc (1, sizeof (struct htab
));
100 result
->entries
= (void **) xcalloc (size
, sizeof (void *));
102 result
->hash_f
= hash_f
;
107 /* This function frees all memory allocated for given hash table.
108 Naturally the hash table must already exist. */
114 free (htab
->entries
);
118 /* This function clears all entries in the given hash table. */
124 memset (htab
->entries
, 0, htab
->size
* sizeof (void *));
127 /* The following function changes size of memory allocated for the
128 entries and repeatedly inserts the table elements. The occupancy
129 of the table after the call will be about 50%. Naturally the hash
130 table must already exist. Remember also that the place of the
131 table entries is changed. */
141 oentries
= htab
->entries
;
142 olimit
= oentries
+ htab
->size
;
144 htab
->size
= higher_prime_number (htab
->size
* 2);
145 htab
->entries
= xcalloc (htab
->size
, sizeof (void **));
147 htab
->n_elements
-= htab
->n_deleted
;
154 if (x
!= EMPTY_ENTRY
&& x
!= DELETED_ENTRY
)
156 void **q
= htab_find_slot (htab
, x
, 1);
165 /* This function searches for a hash table entry equal to the given
166 element. It cannot be used to insert or delete an element. */
169 htab_find (htab
, element
)
173 unsigned int index
, hash
, hash2
;
178 hash
= (*htab
->hash_f
) (element
);
179 hash2
= 1 + hash
% (size
- 2);
184 void *entry
= htab
->entries
[index
];
185 if (entry
== EMPTY_ENTRY
)
187 else if (entry
!= DELETED_ENTRY
&& (*htab
->eq_f
) (entry
, element
))
197 /* This function searches for a hash table slot containing an entry
198 equal to the given element. To delete an entry, call this with
199 INSERT = 0, then call htab_clear_slot on the slot returned (possibly
200 after doing some checks). To insert an entry, call this with
201 INSERT = 1, then write the value you want into the returned slot. */
204 htab_find_slot (htab
, element
, insert
)
209 void **first_deleted_slot
;
210 unsigned int index
, hash
, hash2
;
213 if (insert
&& htab
->size
* 3 <= htab
->n_elements
* 4)
217 hash
= (*htab
->hash_f
) (element
);
218 hash2
= 1 + hash
% (size
- 2);
222 first_deleted_slot
= NULL
;
226 void *entry
= htab
->entries
[index
];
227 if (entry
== EMPTY_ENTRY
)
234 if (first_deleted_slot
)
236 *first_deleted_slot
= EMPTY_ENTRY
;
237 return first_deleted_slot
;
240 return &htab
->entries
[index
];
243 if (entry
== DELETED_ENTRY
)
245 if (!first_deleted_slot
)
246 first_deleted_slot
= &htab
->entries
[index
];
250 if ((*htab
->eq_f
) (entry
, element
))
251 return &htab
->entries
[index
];
261 /* This function deletes an element with the given value from hash
262 table. If there is no matching element in the hash table, this
263 function does nothing. */
266 htab_remove_elt (htab
, element
)
272 slot
= htab_find_slot (htab
, element
, 0);
273 if (*slot
== EMPTY_ENTRY
)
276 *slot
= DELETED_ENTRY
;
280 /* This function clears a specified slot in a hash table. It is
281 useful when you've already done the lookup and don't want to do it
285 htab_clear_slot (htab
, slot
)
289 if (slot
< htab
->entries
|| slot
>= htab
->entries
+ htab
->size
290 || *slot
== EMPTY_ENTRY
|| *slot
== DELETED_ENTRY
)
292 *slot
= DELETED_ENTRY
;
296 /* This function scans over the entire hash table calling
297 CALLBACK for each live entry. If CALLBACK returns false,
298 the iteration stops. INFO is passed as CALLBACK's second
302 htab_traverse (htab
, callback
, info
)
307 void **slot
, **limit
;
308 slot
= htab
->entries
;
309 limit
= slot
+ htab
->size
;
313 if (x
!= EMPTY_ENTRY
&& x
!= DELETED_ENTRY
)
314 if (!(*callback
) (x
, info
))
317 while (++slot
< limit
);
320 /* The following function returns current size of given hash table. */
329 /* The following function returns current number of elements in given
336 return htab
->n_elements
- htab
->n_deleted
;
339 /* The following function returns number of percents of fixed
340 collisions during all work with given hash table. */
343 htab_collisions (htab
)
348 searches
= htab
->searches
;
351 return (double)htab
->collisions
/ (double)searches
;