1 /* $NetBSD: hash.h,v 1.21 2020/09/01 21:11:31 rillig Exp $ */
4 * Copyright (c) 1988, 1989, 1990 The Regents of the University of California.
6 * This code is derived from software contributed to Berkeley by
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
17 * 3. Neither the name of the University nor the names of its contributors
18 * may be used to endorse or promote products derived from this software
19 * without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 * from: @(#)hash.h 8.1 (Berkeley) 6/6/93
37 * Copyright (c) 1988, 1989 by Adam de Boor
38 * Copyright (c) 1989 by Berkeley Softworks
39 * All rights reserved.
41 * This code is derived from software contributed to Berkeley by
44 * Redistribution and use in source and binary forms, with or without
45 * modification, are permitted provided that the following conditions
47 * 1. Redistributions of source code must retain the above copyright
48 * notice, this list of conditions and the following disclaimer.
49 * 2. Redistributions in binary form must reproduce the above copyright
50 * notice, this list of conditions and the following disclaimer in the
51 * documentation and/or other materials provided with the distribution.
52 * 3. All advertising materials mentioning features or use of this software
53 * must display the following acknowledgement:
54 * This product includes software developed by the University of
55 * California, Berkeley and its contributors.
56 * 4. Neither the name of the University nor the names of its contributors
57 * may be used to endorse or promote products derived from this software
58 * without specific prior written permission.
60 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
61 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
62 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
63 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
64 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
65 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
66 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
67 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
68 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
69 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
72 * from: @(#)hash.h 8.1 (Berkeley) 6/6/93
75 /* Hash tables with strings as keys and arbitrary pointers as values. */
80 /* A single key-value entry in the hash table. */
81 typedef struct Hash_Entry {
82 struct Hash_Entry *next; /* Used to link together all the entries
83 * associated with the same bucket. */
85 unsigned namehash; /* hash value of key */
86 char name[1]; /* key string, variable length */
89 /* The hash table containing the entries. */
90 typedef struct Hash_Table {
91 Hash_Entry **buckets; /* Pointers to Hash_Entry, one
92 * for each bucket in the table. */
94 int numEntries; /* Number of entries in the table. */
95 int bucketsMask; /* Used to select the bucket for a hash. */
96 int maxchain; /* max length of chain detected */
100 * The following structure is used by the searching routines
101 * to record where we are in the search.
103 typedef struct Hash_Search {
104 Hash_Table *table; /* Table being searched. */
105 int nextBucket; /* Next bucket to check (after current). */
106 Hash_Entry *entry; /* Next entry to check in current bucket. */
109 static inline void * MAKE_ATTR_UNUSED
110 Hash_GetValue(Hash_Entry *h)
115 static inline void MAKE_ATTR_UNUSED
116 Hash_SetValue(Hash_Entry *h, void *datum)
121 void Hash_InitTable(Hash_Table *, int);
122 void Hash_DeleteTable(Hash_Table *);
123 Hash_Entry *Hash_FindEntry(Hash_Table *, const char *);
124 Hash_Entry *Hash_CreateEntry(Hash_Table *, const char *, Boolean *);
125 void Hash_DeleteEntry(Hash_Table *, Hash_Entry *);
126 Hash_Entry *Hash_EnumFirst(Hash_Table *, Hash_Search *);
127 Hash_Entry *Hash_EnumNext(Hash_Search *);
128 void Hash_ForEach(Hash_Table *, void (*)(void *, void *), void *);
129 void Hash_DebugStats(Hash_Table *, const char *);
131 #endif /* MAKE_HASH_H */