hash.h revision 1.20 1 /* $NetBSD: hash.h,v 1.20 2020/09/01 21:00:15 rillig Exp $ */
2
3 /*
4 * Copyright (c) 1988, 1989, 1990 The Regents of the University of California.
5 *
6 * This code is derived from software contributed to Berkeley by
7 * Adam de Boor.
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
11 * are met:
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.
20 *
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
31 * SUCH DAMAGE.
32 *
33 * from: @(#)hash.h 8.1 (Berkeley) 6/6/93
34 */
35
36 /*
37 * Copyright (c) 1988, 1989 by Adam de Boor
38 * Copyright (c) 1989 by Berkeley Softworks
39 * All rights reserved.
40 *
41 * This code is derived from software contributed to Berkeley by
42 * Adam de Boor.
43 *
44 * Redistribution and use in source and binary forms, with or without
45 * modification, are permitted provided that the following conditions
46 * are met:
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.
59 *
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
70 * SUCH DAMAGE.
71 *
72 * from: @(#)hash.h 8.1 (Berkeley) 6/6/93
73 */
74
75 /* hash.h --
76 *
77 * This file contains definitions used by the hash module,
78 * which maintains hash tables.
79 */
80
81 #ifndef MAKE_HASH_H
82 #define MAKE_HASH_H
83
84 /*
85 * The following defines one entry in the hash table.
86 */
87
88 typedef struct Hash_Entry {
89 struct Hash_Entry *next; /* Used to link together all the
90 * entries associated with the same
91 * bucket. */
92 void *clientPtr; /* Arbitrary pointer */
93 unsigned namehash; /* hash value of key */
94 char name[1]; /* key string, variable length */
95 } Hash_Entry;
96
97 typedef struct Hash_Table {
98 struct Hash_Entry **bucketPtr;/* Pointers to Hash_Entry, one
99 * for each bucket in the table. */
100 int size; /* Actual size of array. */
101 int numEntries; /* Number of entries in the table. */
102 int mask; /* Used to select bits for hashing. */
103 int maxchain; /* max length of chain detected */
104 } Hash_Table;
105
106 /*
107 * The following structure is used by the searching routines
108 * to record where we are in the search.
109 */
110
111 typedef struct Hash_Search {
112 Hash_Table *tablePtr; /* Table being searched. */
113 int nextIndex; /* Next bucket to check (after current). */
114 Hash_Entry *hashEntryPtr; /* Next entry to check in current bucket. */
115 } Hash_Search;
116
117 static inline void * MAKE_ATTR_UNUSED
118 Hash_GetValue(Hash_Entry *h)
119 {
120 return h->clientPtr;
121 }
122
123 static inline void MAKE_ATTR_UNUSED
124 Hash_SetValue(Hash_Entry *h, void *datum)
125 {
126 h->clientPtr = datum;
127 }
128
129 void Hash_InitTable(Hash_Table *, int);
130 void Hash_DeleteTable(Hash_Table *);
131 Hash_Entry *Hash_FindEntry(Hash_Table *, const char *);
132 Hash_Entry *Hash_CreateEntry(Hash_Table *, const char *, Boolean *);
133 void Hash_DeleteEntry(Hash_Table *, Hash_Entry *);
134 Hash_Entry *Hash_EnumFirst(Hash_Table *, Hash_Search *);
135 Hash_Entry *Hash_EnumNext(Hash_Search *);
136 void Hash_ForEach(Hash_Table *, void (*)(void *, void *), void *);
137 void Hash_DebugStats(Hash_Table *, const char *);
138
139 #endif /* MAKE_HASH_H */
140