1*00b67f09SDavid van Moolenbroek /* $NetBSD: symtab.c,v 1.6 2014/12/10 04:37:59 christos Exp $ */
2*00b67f09SDavid van Moolenbroek
3*00b67f09SDavid van Moolenbroek /*
4*00b67f09SDavid van Moolenbroek * Copyright (C) 2004, 2005, 2007, 2011-2013 Internet Systems Consortium, Inc. ("ISC")
5*00b67f09SDavid van Moolenbroek * Copyright (C) 1996-2001 Internet Software Consortium.
6*00b67f09SDavid van Moolenbroek *
7*00b67f09SDavid van Moolenbroek * Permission to use, copy, modify, and/or distribute this software for any
8*00b67f09SDavid van Moolenbroek * purpose with or without fee is hereby granted, provided that the above
9*00b67f09SDavid van Moolenbroek * copyright notice and this permission notice appear in all copies.
10*00b67f09SDavid van Moolenbroek *
11*00b67f09SDavid van Moolenbroek * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
12*00b67f09SDavid van Moolenbroek * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
13*00b67f09SDavid van Moolenbroek * AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
14*00b67f09SDavid van Moolenbroek * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
15*00b67f09SDavid van Moolenbroek * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
16*00b67f09SDavid van Moolenbroek * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
17*00b67f09SDavid van Moolenbroek * PERFORMANCE OF THIS SOFTWARE.
18*00b67f09SDavid van Moolenbroek */
19*00b67f09SDavid van Moolenbroek
20*00b67f09SDavid van Moolenbroek /* Id */
21*00b67f09SDavid van Moolenbroek
22*00b67f09SDavid van Moolenbroek /*! \file */
23*00b67f09SDavid van Moolenbroek
24*00b67f09SDavid van Moolenbroek #include <config.h>
25*00b67f09SDavid van Moolenbroek
26*00b67f09SDavid van Moolenbroek #include <ctype.h>
27*00b67f09SDavid van Moolenbroek
28*00b67f09SDavid van Moolenbroek #include <isc/magic.h>
29*00b67f09SDavid van Moolenbroek #include <isc/mem.h>
30*00b67f09SDavid van Moolenbroek #include <isc/string.h>
31*00b67f09SDavid van Moolenbroek #include <isc/symtab.h>
32*00b67f09SDavid van Moolenbroek #include <isc/util.h>
33*00b67f09SDavid van Moolenbroek
34*00b67f09SDavid van Moolenbroek typedef struct elt {
35*00b67f09SDavid van Moolenbroek char * key;
36*00b67f09SDavid van Moolenbroek unsigned int type;
37*00b67f09SDavid van Moolenbroek isc_symvalue_t value;
38*00b67f09SDavid van Moolenbroek LINK(struct elt) link;
39*00b67f09SDavid van Moolenbroek } elt_t;
40*00b67f09SDavid van Moolenbroek
41*00b67f09SDavid van Moolenbroek typedef LIST(elt_t) eltlist_t;
42*00b67f09SDavid van Moolenbroek
43*00b67f09SDavid van Moolenbroek #define SYMTAB_MAGIC ISC_MAGIC('S', 'y', 'm', 'T')
44*00b67f09SDavid van Moolenbroek #define VALID_SYMTAB(st) ISC_MAGIC_VALID(st, SYMTAB_MAGIC)
45*00b67f09SDavid van Moolenbroek
46*00b67f09SDavid van Moolenbroek struct isc_symtab {
47*00b67f09SDavid van Moolenbroek /* Unlocked. */
48*00b67f09SDavid van Moolenbroek unsigned int magic;
49*00b67f09SDavid van Moolenbroek isc_mem_t * mctx;
50*00b67f09SDavid van Moolenbroek unsigned int size;
51*00b67f09SDavid van Moolenbroek unsigned int count;
52*00b67f09SDavid van Moolenbroek unsigned int maxload;
53*00b67f09SDavid van Moolenbroek eltlist_t * table;
54*00b67f09SDavid van Moolenbroek isc_symtabaction_t undefine_action;
55*00b67f09SDavid van Moolenbroek void * undefine_arg;
56*00b67f09SDavid van Moolenbroek isc_boolean_t case_sensitive;
57*00b67f09SDavid van Moolenbroek };
58*00b67f09SDavid van Moolenbroek
59*00b67f09SDavid van Moolenbroek isc_result_t
isc_symtab_create(isc_mem_t * mctx,unsigned int size,isc_symtabaction_t undefine_action,void * undefine_arg,isc_boolean_t case_sensitive,isc_symtab_t ** symtabp)60*00b67f09SDavid van Moolenbroek isc_symtab_create(isc_mem_t *mctx, unsigned int size,
61*00b67f09SDavid van Moolenbroek isc_symtabaction_t undefine_action,
62*00b67f09SDavid van Moolenbroek void *undefine_arg,
63*00b67f09SDavid van Moolenbroek isc_boolean_t case_sensitive,
64*00b67f09SDavid van Moolenbroek isc_symtab_t **symtabp)
65*00b67f09SDavid van Moolenbroek {
66*00b67f09SDavid van Moolenbroek isc_symtab_t *symtab;
67*00b67f09SDavid van Moolenbroek unsigned int i;
68*00b67f09SDavid van Moolenbroek
69*00b67f09SDavid van Moolenbroek REQUIRE(mctx != NULL);
70*00b67f09SDavid van Moolenbroek REQUIRE(symtabp != NULL && *symtabp == NULL);
71*00b67f09SDavid van Moolenbroek REQUIRE(size > 0); /* Should be prime. */
72*00b67f09SDavid van Moolenbroek
73*00b67f09SDavid van Moolenbroek symtab = (isc_symtab_t *)isc_mem_get(mctx, sizeof(*symtab));
74*00b67f09SDavid van Moolenbroek if (symtab == NULL)
75*00b67f09SDavid van Moolenbroek return (ISC_R_NOMEMORY);
76*00b67f09SDavid van Moolenbroek
77*00b67f09SDavid van Moolenbroek symtab->mctx = NULL;
78*00b67f09SDavid van Moolenbroek isc_mem_attach(mctx, &symtab->mctx);
79*00b67f09SDavid van Moolenbroek symtab->table = (eltlist_t *)isc_mem_get(mctx,
80*00b67f09SDavid van Moolenbroek size * sizeof(eltlist_t));
81*00b67f09SDavid van Moolenbroek if (symtab->table == NULL) {
82*00b67f09SDavid van Moolenbroek isc_mem_putanddetach(&symtab->mctx, symtab, sizeof(*symtab));
83*00b67f09SDavid van Moolenbroek return (ISC_R_NOMEMORY);
84*00b67f09SDavid van Moolenbroek }
85*00b67f09SDavid van Moolenbroek for (i = 0; i < size; i++)
86*00b67f09SDavid van Moolenbroek INIT_LIST(symtab->table[i]);
87*00b67f09SDavid van Moolenbroek symtab->size = size;
88*00b67f09SDavid van Moolenbroek symtab->count = 0;
89*00b67f09SDavid van Moolenbroek symtab->maxload = size * 3 / 4;
90*00b67f09SDavid van Moolenbroek symtab->undefine_action = undefine_action;
91*00b67f09SDavid van Moolenbroek symtab->undefine_arg = undefine_arg;
92*00b67f09SDavid van Moolenbroek symtab->case_sensitive = case_sensitive;
93*00b67f09SDavid van Moolenbroek symtab->magic = SYMTAB_MAGIC;
94*00b67f09SDavid van Moolenbroek
95*00b67f09SDavid van Moolenbroek *symtabp = symtab;
96*00b67f09SDavid van Moolenbroek
97*00b67f09SDavid van Moolenbroek return (ISC_R_SUCCESS);
98*00b67f09SDavid van Moolenbroek }
99*00b67f09SDavid van Moolenbroek
100*00b67f09SDavid van Moolenbroek void
isc_symtab_destroy(isc_symtab_t ** symtabp)101*00b67f09SDavid van Moolenbroek isc_symtab_destroy(isc_symtab_t **symtabp) {
102*00b67f09SDavid van Moolenbroek isc_symtab_t *symtab;
103*00b67f09SDavid van Moolenbroek unsigned int i;
104*00b67f09SDavid van Moolenbroek elt_t *elt, *nelt;
105*00b67f09SDavid van Moolenbroek
106*00b67f09SDavid van Moolenbroek REQUIRE(symtabp != NULL);
107*00b67f09SDavid van Moolenbroek symtab = *symtabp;
108*00b67f09SDavid van Moolenbroek REQUIRE(VALID_SYMTAB(symtab));
109*00b67f09SDavid van Moolenbroek
110*00b67f09SDavid van Moolenbroek for (i = 0; i < symtab->size; i++) {
111*00b67f09SDavid van Moolenbroek for (elt = HEAD(symtab->table[i]); elt != NULL; elt = nelt) {
112*00b67f09SDavid van Moolenbroek nelt = NEXT(elt, link);
113*00b67f09SDavid van Moolenbroek if (symtab->undefine_action != NULL)
114*00b67f09SDavid van Moolenbroek (symtab->undefine_action)(elt->key,
115*00b67f09SDavid van Moolenbroek elt->type,
116*00b67f09SDavid van Moolenbroek elt->value,
117*00b67f09SDavid van Moolenbroek symtab->undefine_arg);
118*00b67f09SDavid van Moolenbroek isc_mem_put(symtab->mctx, elt, sizeof(*elt));
119*00b67f09SDavid van Moolenbroek }
120*00b67f09SDavid van Moolenbroek }
121*00b67f09SDavid van Moolenbroek isc_mem_put(symtab->mctx, symtab->table,
122*00b67f09SDavid van Moolenbroek symtab->size * sizeof(eltlist_t));
123*00b67f09SDavid van Moolenbroek symtab->magic = 0;
124*00b67f09SDavid van Moolenbroek isc_mem_putanddetach(&symtab->mctx, symtab, sizeof(*symtab));
125*00b67f09SDavid van Moolenbroek
126*00b67f09SDavid van Moolenbroek *symtabp = NULL;
127*00b67f09SDavid van Moolenbroek }
128*00b67f09SDavid van Moolenbroek
129*00b67f09SDavid van Moolenbroek static inline unsigned int
hash(const char * key,isc_boolean_t case_sensitive)130*00b67f09SDavid van Moolenbroek hash(const char *key, isc_boolean_t case_sensitive) {
131*00b67f09SDavid van Moolenbroek const char *s;
132*00b67f09SDavid van Moolenbroek unsigned int h = 0;
133*00b67f09SDavid van Moolenbroek int c;
134*00b67f09SDavid van Moolenbroek
135*00b67f09SDavid van Moolenbroek /*
136*00b67f09SDavid van Moolenbroek * This hash function is similar to the one Ousterhout
137*00b67f09SDavid van Moolenbroek * uses in Tcl.
138*00b67f09SDavid van Moolenbroek */
139*00b67f09SDavid van Moolenbroek
140*00b67f09SDavid van Moolenbroek if (case_sensitive) {
141*00b67f09SDavid van Moolenbroek for (s = key; *s != '\0'; s++) {
142*00b67f09SDavid van Moolenbroek h += (h << 3) + *s;
143*00b67f09SDavid van Moolenbroek }
144*00b67f09SDavid van Moolenbroek } else {
145*00b67f09SDavid van Moolenbroek for (s = key; *s != '\0'; s++) {
146*00b67f09SDavid van Moolenbroek c = *s;
147*00b67f09SDavid van Moolenbroek c = tolower((unsigned char)c);
148*00b67f09SDavid van Moolenbroek h += (h << 3) + c;
149*00b67f09SDavid van Moolenbroek }
150*00b67f09SDavid van Moolenbroek }
151*00b67f09SDavid van Moolenbroek
152*00b67f09SDavid van Moolenbroek return (h);
153*00b67f09SDavid van Moolenbroek }
154*00b67f09SDavid van Moolenbroek
155*00b67f09SDavid van Moolenbroek #define FIND(s, k, t, b, e) \
156*00b67f09SDavid van Moolenbroek b = hash((k), (s)->case_sensitive) % (s)->size; \
157*00b67f09SDavid van Moolenbroek if ((s)->case_sensitive) { \
158*00b67f09SDavid van Moolenbroek for (e = HEAD((s)->table[b]); e != NULL; e = NEXT(e, link)) { \
159*00b67f09SDavid van Moolenbroek if (((t) == 0 || e->type == (t)) && \
160*00b67f09SDavid van Moolenbroek strcmp(e->key, (k)) == 0) \
161*00b67f09SDavid van Moolenbroek break; \
162*00b67f09SDavid van Moolenbroek } \
163*00b67f09SDavid van Moolenbroek } else { \
164*00b67f09SDavid van Moolenbroek for (e = HEAD((s)->table[b]); e != NULL; e = NEXT(e, link)) { \
165*00b67f09SDavid van Moolenbroek if (((t) == 0 || e->type == (t)) && \
166*00b67f09SDavid van Moolenbroek strcasecmp(e->key, (k)) == 0) \
167*00b67f09SDavid van Moolenbroek break; \
168*00b67f09SDavid van Moolenbroek } \
169*00b67f09SDavid van Moolenbroek }
170*00b67f09SDavid van Moolenbroek
171*00b67f09SDavid van Moolenbroek isc_result_t
isc_symtab_lookup(isc_symtab_t * symtab,const char * key,unsigned int type,isc_symvalue_t * value)172*00b67f09SDavid van Moolenbroek isc_symtab_lookup(isc_symtab_t *symtab, const char *key, unsigned int type,
173*00b67f09SDavid van Moolenbroek isc_symvalue_t *value)
174*00b67f09SDavid van Moolenbroek {
175*00b67f09SDavid van Moolenbroek unsigned int bucket;
176*00b67f09SDavid van Moolenbroek elt_t *elt;
177*00b67f09SDavid van Moolenbroek
178*00b67f09SDavid van Moolenbroek REQUIRE(VALID_SYMTAB(symtab));
179*00b67f09SDavid van Moolenbroek REQUIRE(key != NULL);
180*00b67f09SDavid van Moolenbroek
181*00b67f09SDavid van Moolenbroek FIND(symtab, key, type, bucket, elt);
182*00b67f09SDavid van Moolenbroek
183*00b67f09SDavid van Moolenbroek if (elt == NULL)
184*00b67f09SDavid van Moolenbroek return (ISC_R_NOTFOUND);
185*00b67f09SDavid van Moolenbroek
186*00b67f09SDavid van Moolenbroek if (value != NULL)
187*00b67f09SDavid van Moolenbroek *value = elt->value;
188*00b67f09SDavid van Moolenbroek
189*00b67f09SDavid van Moolenbroek return (ISC_R_SUCCESS);
190*00b67f09SDavid van Moolenbroek }
191*00b67f09SDavid van Moolenbroek
192*00b67f09SDavid van Moolenbroek static void
grow_table(isc_symtab_t * symtab)193*00b67f09SDavid van Moolenbroek grow_table(isc_symtab_t *symtab) {
194*00b67f09SDavid van Moolenbroek eltlist_t *newtable;
195*00b67f09SDavid van Moolenbroek unsigned int i, newsize, newmax;
196*00b67f09SDavid van Moolenbroek
197*00b67f09SDavid van Moolenbroek REQUIRE(symtab != NULL);
198*00b67f09SDavid van Moolenbroek
199*00b67f09SDavid van Moolenbroek newsize = symtab->size * 2;
200*00b67f09SDavid van Moolenbroek newmax = newsize * 3 / 4;
201*00b67f09SDavid van Moolenbroek INSIST(newsize > 0U && newmax > 0U);
202*00b67f09SDavid van Moolenbroek
203*00b67f09SDavid van Moolenbroek newtable = isc_mem_get(symtab->mctx, newsize * sizeof(eltlist_t));
204*00b67f09SDavid van Moolenbroek if (newtable == NULL)
205*00b67f09SDavid van Moolenbroek return;
206*00b67f09SDavid van Moolenbroek
207*00b67f09SDavid van Moolenbroek for (i = 0; i < newsize; i++)
208*00b67f09SDavid van Moolenbroek INIT_LIST(newtable[i]);
209*00b67f09SDavid van Moolenbroek
210*00b67f09SDavid van Moolenbroek for (i = 0; i < symtab->size; i++) {
211*00b67f09SDavid van Moolenbroek elt_t *elt, *nelt;
212*00b67f09SDavid van Moolenbroek
213*00b67f09SDavid van Moolenbroek for (elt = HEAD(symtab->table[i]); elt != NULL; elt = nelt) {
214*00b67f09SDavid van Moolenbroek unsigned int hv;
215*00b67f09SDavid van Moolenbroek
216*00b67f09SDavid van Moolenbroek nelt = NEXT(elt, link);
217*00b67f09SDavid van Moolenbroek
218*00b67f09SDavid van Moolenbroek UNLINK(symtab->table[i], elt, link);
219*00b67f09SDavid van Moolenbroek hv = hash(elt->key, symtab->case_sensitive);
220*00b67f09SDavid van Moolenbroek APPEND(newtable[hv % newsize], elt, link);
221*00b67f09SDavid van Moolenbroek }
222*00b67f09SDavid van Moolenbroek }
223*00b67f09SDavid van Moolenbroek
224*00b67f09SDavid van Moolenbroek isc_mem_put(symtab->mctx, symtab->table,
225*00b67f09SDavid van Moolenbroek symtab->size * sizeof(eltlist_t));
226*00b67f09SDavid van Moolenbroek
227*00b67f09SDavid van Moolenbroek symtab->table = newtable;
228*00b67f09SDavid van Moolenbroek symtab->size = newsize;
229*00b67f09SDavid van Moolenbroek symtab->maxload = newmax;
230*00b67f09SDavid van Moolenbroek }
231*00b67f09SDavid van Moolenbroek
232*00b67f09SDavid van Moolenbroek isc_result_t
isc_symtab_define(isc_symtab_t * symtab,const char * key,unsigned int type,isc_symvalue_t value,isc_symexists_t exists_policy)233*00b67f09SDavid van Moolenbroek isc_symtab_define(isc_symtab_t *symtab, const char *key, unsigned int type,
234*00b67f09SDavid van Moolenbroek isc_symvalue_t value, isc_symexists_t exists_policy)
235*00b67f09SDavid van Moolenbroek {
236*00b67f09SDavid van Moolenbroek unsigned int bucket;
237*00b67f09SDavid van Moolenbroek elt_t *elt;
238*00b67f09SDavid van Moolenbroek
239*00b67f09SDavid van Moolenbroek REQUIRE(VALID_SYMTAB(symtab));
240*00b67f09SDavid van Moolenbroek REQUIRE(key != NULL);
241*00b67f09SDavid van Moolenbroek REQUIRE(type != 0);
242*00b67f09SDavid van Moolenbroek
243*00b67f09SDavid van Moolenbroek FIND(symtab, key, type, bucket, elt);
244*00b67f09SDavid van Moolenbroek
245*00b67f09SDavid van Moolenbroek if (exists_policy != isc_symexists_add && elt != NULL) {
246*00b67f09SDavid van Moolenbroek if (exists_policy == isc_symexists_reject)
247*00b67f09SDavid van Moolenbroek return (ISC_R_EXISTS);
248*00b67f09SDavid van Moolenbroek INSIST(exists_policy == isc_symexists_replace);
249*00b67f09SDavid van Moolenbroek UNLINK(symtab->table[bucket], elt, link);
250*00b67f09SDavid van Moolenbroek if (symtab->undefine_action != NULL)
251*00b67f09SDavid van Moolenbroek (symtab->undefine_action)(elt->key, elt->type,
252*00b67f09SDavid van Moolenbroek elt->value,
253*00b67f09SDavid van Moolenbroek symtab->undefine_arg);
254*00b67f09SDavid van Moolenbroek } else {
255*00b67f09SDavid van Moolenbroek elt = (elt_t *)isc_mem_get(symtab->mctx, sizeof(*elt));
256*00b67f09SDavid van Moolenbroek if (elt == NULL)
257*00b67f09SDavid van Moolenbroek return (ISC_R_NOMEMORY);
258*00b67f09SDavid van Moolenbroek ISC_LINK_INIT(elt, link);
259*00b67f09SDavid van Moolenbroek symtab->count++;
260*00b67f09SDavid van Moolenbroek }
261*00b67f09SDavid van Moolenbroek
262*00b67f09SDavid van Moolenbroek /*
263*00b67f09SDavid van Moolenbroek * Though the "key" can be const coming in, it is not stored as const
264*00b67f09SDavid van Moolenbroek * so that the calling program can easily have writable access to
265*00b67f09SDavid van Moolenbroek * it in its undefine_action function. In the event that it *was*
266*00b67f09SDavid van Moolenbroek * truly const coming in and then the caller modified it anyway ...
267*00b67f09SDavid van Moolenbroek * well, don't do that!
268*00b67f09SDavid van Moolenbroek */
269*00b67f09SDavid van Moolenbroek DE_CONST(key, elt->key);
270*00b67f09SDavid van Moolenbroek elt->type = type;
271*00b67f09SDavid van Moolenbroek elt->value = value;
272*00b67f09SDavid van Moolenbroek
273*00b67f09SDavid van Moolenbroek /*
274*00b67f09SDavid van Moolenbroek * We prepend so that the most recent definition will be found.
275*00b67f09SDavid van Moolenbroek */
276*00b67f09SDavid van Moolenbroek PREPEND(symtab->table[bucket], elt, link);
277*00b67f09SDavid van Moolenbroek
278*00b67f09SDavid van Moolenbroek if (symtab->count > symtab->maxload)
279*00b67f09SDavid van Moolenbroek grow_table(symtab);
280*00b67f09SDavid van Moolenbroek
281*00b67f09SDavid van Moolenbroek return (ISC_R_SUCCESS);
282*00b67f09SDavid van Moolenbroek }
283*00b67f09SDavid van Moolenbroek
284*00b67f09SDavid van Moolenbroek isc_result_t
isc_symtab_undefine(isc_symtab_t * symtab,const char * key,unsigned int type)285*00b67f09SDavid van Moolenbroek isc_symtab_undefine(isc_symtab_t *symtab, const char *key, unsigned int type) {
286*00b67f09SDavid van Moolenbroek unsigned int bucket;
287*00b67f09SDavid van Moolenbroek elt_t *elt;
288*00b67f09SDavid van Moolenbroek
289*00b67f09SDavid van Moolenbroek REQUIRE(VALID_SYMTAB(symtab));
290*00b67f09SDavid van Moolenbroek REQUIRE(key != NULL);
291*00b67f09SDavid van Moolenbroek
292*00b67f09SDavid van Moolenbroek FIND(symtab, key, type, bucket, elt);
293*00b67f09SDavid van Moolenbroek
294*00b67f09SDavid van Moolenbroek if (elt == NULL)
295*00b67f09SDavid van Moolenbroek return (ISC_R_NOTFOUND);
296*00b67f09SDavid van Moolenbroek
297*00b67f09SDavid van Moolenbroek if (symtab->undefine_action != NULL)
298*00b67f09SDavid van Moolenbroek (symtab->undefine_action)(elt->key, elt->type,
299*00b67f09SDavid van Moolenbroek elt->value, symtab->undefine_arg);
300*00b67f09SDavid van Moolenbroek UNLINK(symtab->table[bucket], elt, link);
301*00b67f09SDavid van Moolenbroek isc_mem_put(symtab->mctx, elt, sizeof(*elt));
302*00b67f09SDavid van Moolenbroek symtab->count--;
303*00b67f09SDavid van Moolenbroek
304*00b67f09SDavid van Moolenbroek return (ISC_R_SUCCESS);
305*00b67f09SDavid van Moolenbroek }
306*00b67f09SDavid van Moolenbroek
307*00b67f09SDavid van Moolenbroek unsigned int
isc_symtab_count(isc_symtab_t * symtab)308*00b67f09SDavid van Moolenbroek isc_symtab_count(isc_symtab_t *symtab) {
309*00b67f09SDavid van Moolenbroek REQUIRE(VALID_SYMTAB(symtab));
310*00b67f09SDavid van Moolenbroek return (symtab->count);
311*00b67f09SDavid van Moolenbroek }
312