1 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
4 * This package is an SSL implementation written
5 * by Eric Young (eay@cryptsoft.com).
6 * The implementation was written so as to conform with Netscapes SSL.
8 * This library is free for commercial and non-commercial use as long as
9 * the following conditions are aheared to. The following conditions
10 * apply to all code found in this distribution, be it the RC4, RSA,
11 * lhash, DES, etc., code; not just the SSL code. The SSL documentation
12 * included with this distribution is covered by the same copyright terms
13 * except that the holder is Tim Hudson (tjh@cryptsoft.com).
15 * Copyright remains Eric Young's, and as such any Copyright notices in
16 * the code are not to be removed.
17 * If this package is used in a product, Eric Young should be given attribution
18 * as the author of the parts of the library used.
19 * This can be in the form of a textual message at program startup or
20 * in documentation (online or textual) provided with the package.
22 * Redistribution and use in source and binary forms, with or without
23 * modification, are permitted provided that the following conditions
25 * 1. Redistributions of source code must retain the copyright
26 * notice, this list of conditions and the following disclaimer.
27 * 2. Redistributions in binary form must reproduce the above copyright
28 * notice, this list of conditions and the following disclaimer in the
29 * documentation and/or other materials provided with the distribution.
30 * 3. All advertising materials mentioning features or use of this software
31 * must display the following acknowledgement:
32 * "This product includes cryptographic software written by
33 * Eric Young (eay@cryptsoft.com)"
34 * The word 'cryptographic' can be left out if the rouines from the library
35 * being used are not cryptographic related :-).
36 * 4. If you include any Windows specific code (or a derivative thereof) from
37 * the apps directory (application code) you must include an acknowledgement:
38 * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
40 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
41 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
43 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
44 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
45 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
46 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
48 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
49 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
52 * The licence and distribution terms for any publically available version or
53 * derivative of this code cannot be changed. i.e. this code cannot simply be
54 * copied and put under another distribution licence
55 * [including the GNU Public Licence.]
59 * Header for dynamic hash table routines Author - Eric Young
62 #ifndef HEADER_LHASH_H
63 # define HEADER_LHASH_H
65 # include <openssl/e_os2.h>
66 # ifndef OPENSSL_NO_STDIO
70 # include <openssl/bio.h>
76 typedef struct lhash_node_st {
78 struct lhash_node_st *next;
82 typedef int (*LHASH_COMP_FN_TYPE) (const void *, const void *);
83 typedef unsigned long (*LHASH_HASH_FN_TYPE) (const void *);
84 typedef void (*LHASH_DOALL_FN_TYPE) (void *);
85 typedef void (*LHASH_DOALL_ARG_FN_TYPE) (void *, void *);
88 * Macros for declaring and implementing type-safe wrappers for LHASH
89 * callbacks. This way, callbacks can be provided to LHASH structures without
90 * function pointer casting and the macro-defined callbacks provide
91 * per-variable casting before deferring to the underlying type-specific
92 * callbacks. NB: It is possible to place a "static" in front of both the
93 * DECLARE and IMPLEMENT macros if the functions are strictly internal.
96 /* First: "hash" functions */
97 # define DECLARE_LHASH_HASH_FN(name, o_type) \
98 unsigned long name##_LHASH_HASH(const void *);
99 # define IMPLEMENT_LHASH_HASH_FN(name, o_type) \
100 unsigned long name##_LHASH_HASH(const void *arg) { \
101 const o_type *a = arg; \
102 return name##_hash(a); }
103 # define LHASH_HASH_FN(name) name##_LHASH_HASH
105 /* Second: "compare" functions */
106 # define DECLARE_LHASH_COMP_FN(name, o_type) \
107 int name##_LHASH_COMP(const void *, const void *);
108 # define IMPLEMENT_LHASH_COMP_FN(name, o_type) \
109 int name##_LHASH_COMP(const void *arg1, const void *arg2) { \
110 const o_type *a = arg1; \
111 const o_type *b = arg2; \
112 return name##_cmp(a,b); }
113 # define LHASH_COMP_FN(name) name##_LHASH_COMP
115 /* Fourth: "doall_arg" functions */
116 # define DECLARE_LHASH_DOALL_ARG_FN(name, o_type, a_type) \
117 void name##_LHASH_DOALL_ARG(void *, void *);
118 # define IMPLEMENT_LHASH_DOALL_ARG_FN(name, o_type, a_type) \
119 void name##_LHASH_DOALL_ARG(void *arg1, void *arg2) { \
122 name##_doall_arg(a, b); }
123 # define LHASH_DOALL_ARG_FN(name) name##_LHASH_DOALL_ARG
125 typedef struct lhash_st {
127 LHASH_COMP_FN_TYPE comp;
128 LHASH_HASH_FN_TYPE hash;
129 unsigned int num_nodes;
130 unsigned int num_alloc_nodes;
133 unsigned long up_load; /* load times 256 */
134 unsigned long down_load; /* load times 256 */
135 unsigned long num_items;
136 unsigned long num_expands;
137 unsigned long num_expand_reallocs;
138 unsigned long num_contracts;
139 unsigned long num_contract_reallocs;
140 unsigned long num_hash_calls;
141 unsigned long num_comp_calls;
142 unsigned long num_insert;
143 unsigned long num_replace;
144 unsigned long num_delete;
145 unsigned long num_no_delete;
146 unsigned long num_retrieve;
147 unsigned long num_retrieve_miss;
148 unsigned long num_hash_comps;
150 } _LHASH; /* Do not use _LHASH directly, use LHASH_OF
153 # define LH_LOAD_MULT 256
156 * Indicates a malloc() error in the last call, this is only bad in
159 int lh_error(_LHASH *lh);
161 _LHASH *lh_new(LHASH_HASH_FN_TYPE h, LHASH_COMP_FN_TYPE c);
162 void lh_free(_LHASH *lh);
163 void *lh_insert(_LHASH *lh, void *data);
164 void *lh_delete(_LHASH *lh, const void *data);
165 void *lh_retrieve(_LHASH *lh, const void *data);
166 void lh_doall(_LHASH *lh, LHASH_DOALL_FN_TYPE func);
167 void lh_doall_arg(_LHASH *lh, LHASH_DOALL_ARG_FN_TYPE func, void *arg);
168 unsigned long lh_strhash(const char *c);
169 unsigned long lh_num_items(const _LHASH *lh);
170 unsigned long lh_get_down_load(const _LHASH *lh);
171 void lh_set_down_load(_LHASH *lh, unsigned long down_load);
173 # ifndef OPENSSL_NO_STDIO
174 void lh_stats(const _LHASH *lh, FILE *fp);
175 void lh_node_stats(const _LHASH *lh, FILE *fp);
176 void lh_node_usage_stats(const _LHASH *lh, FILE *fp);
178 void lh_stats_bio(const _LHASH *lh, BIO *out);
179 void lh_node_stats_bio(const _LHASH *lh, BIO *out);
180 void lh_node_usage_stats_bio(const _LHASH *lh, BIO *out);
182 /* Type checking... */
184 # define LHASH_OF(type) struct lhash_st_##type
186 # define DEFINE_LHASH_OF(type) \
187 LHASH_OF(type) { int dummy; }; \
188 static ossl_inline LHASH_OF(type) * \
189 lh_##type##_new(unsigned long (*hfn)(const type *), \
190 int (*cfn)(const type *, const type *)) \
192 return (LHASH_OF(type) *) \
193 lh_new((LHASH_HASH_FN_TYPE) hfn, (LHASH_COMP_FN_TYPE)cfn); \
195 static ossl_inline void lh_##type##_free(LHASH_OF(type) *lh) \
197 lh_free((_LHASH *)lh); \
199 static ossl_inline type *lh_##type##_insert(LHASH_OF(type) *lh, type *d) \
201 return (type *)lh_insert((_LHASH *)lh, d); \
203 static ossl_inline type *lh_##type##_delete(LHASH_OF(type) *lh, const type *d) \
205 return (type *)lh_delete((_LHASH *)lh, d); \
207 static ossl_inline type *lh_##type##_retrieve(LHASH_OF(type) *lh, const type *d) \
209 return (type *)lh_retrieve((_LHASH *)lh, d); \
211 static ossl_inline int lh_##type##_error(LHASH_OF(type) *lh) \
213 return lh_error((_LHASH *)lh); \
215 static ossl_inline unsigned long lh_##type##_num_items(LHASH_OF(type) *lh) \
217 return lh_num_items((_LHASH *)lh); \
219 static ossl_inline void lh_##type##_node_stats_bio(const LHASH_OF(type) *lh, BIO *out) \
221 lh_node_stats_bio((_LHASH *)lh, out); \
223 static ossl_inline void lh_##type##_node_usage_stats_bio(const LHASH_OF(type) *lh, BIO *out) \
225 lh_node_usage_stats_bio((_LHASH *)lh, out); \
227 static ossl_inline void lh_##type##_stats_bio(const LHASH_OF(type) *lh, BIO *out) \
229 lh_stats_bio((_LHASH *)lh, out); \
231 static ossl_inline unsigned long lh_##type##_get_down_load(LHASH_OF(type) *lh) \
233 return lh_get_down_load((_LHASH *)lh); \
235 static ossl_inline void lh_##type##_set_down_load(LHASH_OF(type) *lh, unsigned long dl) \
237 lh_set_down_load((_LHASH *)lh, dl); \
239 static ossl_inline void lh_##type##_doall(LHASH_OF(type) *lh, \
240 void (*doall)(type *)) \
242 lh_doall((_LHASH *)lh, (LHASH_DOALL_FN_TYPE)doall); \
246 #define IMPLEMENT_LHASH_DOALL_ARG_CONST(type, argtype) \
247 int_implement_lhash_doall(type, argtype, const type)
249 #define IMPLEMENT_LHASH_DOALL_ARG(type, argtype) \
250 int_implement_lhash_doall(type, argtype, type)
252 #define int_implement_lhash_doall(type, argtype, cbargtype) \
253 static ossl_inline void \
254 lh_##type##_doall_##argtype(LHASH_OF(type) *lh, \
255 void (*fn)(cbargtype *, argtype *), \
258 lh_doall_arg((_LHASH *)lh, (LHASH_DOALL_ARG_FN_TYPE)fn, (void *)arg); \
262 # define CHECKED_LHASH_OF(type,lh) \
263 ((_LHASH *)CHECKED_PTR_OF(LHASH_OF(type),lh))
265 /* Define wrapper functions. */
266 # define LHM_lh_doall_arg(type, lh, fn, arg_type, arg) \
267 lh_doall_arg(CHECKED_LHASH_OF(type, lh), fn, CHECKED_PTR_OF(arg_type, arg))
269 DEFINE_LHASH_OF(OPENSSL_STRING);
270 DEFINE_LHASH_OF(OPENSSL_CSTRING);