1 /* crypto/lhash/lhash.h */
2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
5 * This package is an SSL implementation written
6 * by Eric Young (eay@cryptsoft.com).
7 * The implementation was written so as to conform with Netscapes SSL.
9 * This library is free for commercial and non-commercial use as long as
10 * the following conditions are aheared to. The following conditions
11 * apply to all code found in this distribution, be it the RC4, RSA,
12 * lhash, DES, etc., code; not just the SSL code. The SSL documentation
13 * included with this distribution is covered by the same copyright terms
14 * except that the holder is Tim Hudson (tjh@cryptsoft.com).
16 * Copyright remains Eric Young's, and as such any Copyright notices in
17 * the code are not to be removed.
18 * If this package is used in a product, Eric Young should be given attribution
19 * as the author of the parts of the library used.
20 * This can be in the form of a textual message at program startup or
21 * in documentation (online or textual) provided with the package.
23 * Redistribution and use in source and binary forms, with or without
24 * modification, are permitted provided that the following conditions
26 * 1. Redistributions of source code must retain the copyright
27 * notice, this list of conditions and the following disclaimer.
28 * 2. Redistributions in binary form must reproduce the above copyright
29 * notice, this list of conditions and the following disclaimer in the
30 * documentation and/or other materials provided with the distribution.
31 * 3. All advertising materials mentioning features or use of this software
32 * must display the following acknowledgement:
33 * "This product includes cryptographic software written by
34 * Eric Young (eay@cryptsoft.com)"
35 * The word 'cryptographic' can be left out if the rouines from the library
36 * being used are not cryptographic related :-).
37 * 4. If you include any Windows specific code (or a derivative thereof) from
38 * the apps directory (application code) you must include an acknowledgement:
39 * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
41 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
42 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
43 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
44 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
45 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
46 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
47 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
49 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
50 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
53 * The licence and distribution terms for any publically available version or
54 * derivative of this code cannot be changed. i.e. this code cannot simply be
55 * copied and put under another distribution licence
56 * [including the GNU Public Licence.]
60 * Header for dynamic hash table routines Author - Eric Young
63 #ifndef HEADER_LHASH_H
64 # define HEADER_LHASH_H
66 # include <openssl/e_os2.h>
67 # ifndef OPENSSL_NO_STDIO
71 # include <openssl/bio.h>
77 typedef struct lhash_node_st {
79 struct lhash_node_st *next;
83 typedef int (*LHASH_COMP_FN_TYPE) (const void *, const void *);
84 typedef unsigned long (*LHASH_HASH_FN_TYPE) (const void *);
85 typedef void (*LHASH_DOALL_FN_TYPE) (void *);
86 typedef void (*LHASH_DOALL_ARG_FN_TYPE) (void *, void *);
89 * Macros for declaring and implementing type-safe wrappers for LHASH
90 * callbacks. This way, callbacks can be provided to LHASH structures without
91 * function pointer casting and the macro-defined callbacks provide
92 * per-variable casting before deferring to the underlying type-specific
93 * callbacks. NB: It is possible to place a "static" in front of both the
94 * DECLARE and IMPLEMENT macros if the functions are strictly internal.
97 /* First: "hash" functions */
98 # define DECLARE_LHASH_HASH_FN(name, o_type) \
99 unsigned long name##_LHASH_HASH(const void *);
100 # define IMPLEMENT_LHASH_HASH_FN(name, o_type) \
101 unsigned long name##_LHASH_HASH(const void *arg) { \
102 const o_type *a = arg; \
103 return name##_hash(a); }
104 # define LHASH_HASH_FN(name) name##_LHASH_HASH
106 /* Second: "compare" functions */
107 # define DECLARE_LHASH_COMP_FN(name, o_type) \
108 int name##_LHASH_COMP(const void *, const void *);
109 # define IMPLEMENT_LHASH_COMP_FN(name, o_type) \
110 int name##_LHASH_COMP(const void *arg1, const void *arg2) { \
111 const o_type *a = arg1; \
112 const o_type *b = arg2; \
113 return name##_cmp(a,b); }
114 # define LHASH_COMP_FN(name) name##_LHASH_COMP
116 /* Third: "doall" functions */
117 # define DECLARE_LHASH_DOALL_FN(name, o_type) \
118 void name##_LHASH_DOALL(void *);
119 # define IMPLEMENT_LHASH_DOALL_FN(name, o_type) \
120 void name##_LHASH_DOALL(void *arg) { \
123 # define LHASH_DOALL_FN(name) name##_LHASH_DOALL
125 /* Fourth: "doall_arg" functions */
126 # define DECLARE_LHASH_DOALL_ARG_FN(name, o_type, a_type) \
127 void name##_LHASH_DOALL_ARG(void *, void *);
128 # define IMPLEMENT_LHASH_DOALL_ARG_FN(name, o_type, a_type) \
129 void name##_LHASH_DOALL_ARG(void *arg1, void *arg2) { \
132 name##_doall_arg(a, b); }
133 # define LHASH_DOALL_ARG_FN(name) name##_LHASH_DOALL_ARG
135 typedef struct lhash_st {
137 LHASH_COMP_FN_TYPE comp;
138 LHASH_HASH_FN_TYPE hash;
139 unsigned int num_nodes;
140 unsigned int num_alloc_nodes;
143 unsigned long up_load; /* load times 256 */
144 unsigned long down_load; /* load times 256 */
145 unsigned long num_items;
146 unsigned long num_expands;
147 unsigned long num_expand_reallocs;
148 unsigned long num_contracts;
149 unsigned long num_contract_reallocs;
150 unsigned long num_hash_calls;
151 unsigned long num_comp_calls;
152 unsigned long num_insert;
153 unsigned long num_replace;
154 unsigned long num_delete;
155 unsigned long num_no_delete;
156 unsigned long num_retrieve;
157 unsigned long num_retrieve_miss;
158 unsigned long num_hash_comps;
160 } _LHASH; /* Do not use _LHASH directly, use LHASH_OF
163 # define LH_LOAD_MULT 256
166 * Indicates a malloc() error in the last call, this is only bad in
169 int lh_error(_LHASH *lh);
171 _LHASH *lh_new(LHASH_HASH_FN_TYPE h, LHASH_COMP_FN_TYPE c);
172 void lh_free(_LHASH *lh);
173 void *lh_insert(_LHASH *lh, void *data);
174 void *lh_delete(_LHASH *lh, const void *data);
175 void *lh_retrieve(_LHASH *lh, const void *data);
176 void lh_doall(_LHASH *lh, LHASH_DOALL_FN_TYPE func);
177 void lh_doall_arg(_LHASH *lh, LHASH_DOALL_ARG_FN_TYPE func, void *arg);
178 unsigned long lh_strhash(const char *c);
179 unsigned long lh_num_items(const _LHASH *lh);
180 unsigned long lh_get_down_load(const _LHASH *lh);
181 void lh_set_down_load(_LHASH *lh, unsigned long down_load);
183 # ifndef OPENSSL_NO_STDIO
184 void lh_stats(const _LHASH *lh, FILE *fp);
185 void lh_node_stats(const _LHASH *lh, FILE *fp);
186 void lh_node_usage_stats(const _LHASH *lh, FILE *fp);
188 void lh_stats_bio(const _LHASH *lh, BIO *out);
189 void lh_node_stats_bio(const _LHASH *lh, BIO *out);
190 void lh_node_usage_stats_bio(const _LHASH *lh, BIO *out);
192 /* Type checking... */
194 # define LHASH_OF(type) struct lhash_st_##type
196 # define DECLARE_LHASH_OF(type) \
197 LHASH_OF(type) { int dummy; }; \
198 static inline void lh_##type##_free(LHASH_OF(type) *lh) \
200 lh_free((_LHASH *)lh); \
202 static inline type *lh_##type##_insert(LHASH_OF(type) *lh, type *d) \
204 return lh_insert((_LHASH *)lh, d); \
206 static inline type *lh_##type##_delete(LHASH_OF(type) *lh, const type *d) \
208 return lh_delete((_LHASH *)lh, d); \
210 static inline type *lh_##type##_retrieve(LHASH_OF(type) *lh, const type *d) \
212 return lh_retrieve((_LHASH *)lh, d); \
214 static inline int lh_##type##_error(LHASH_OF(type) *lh) \
216 return lh_error((_LHASH *)lh); \
218 static inline unsigned long lh_##type##_num_items(LHASH_OF(type) *lh) \
220 return lh_num_items((_LHASH *)lh); \
222 static inline void lh_##type##_node_stats_bio(const LHASH_OF(type) *lh, BIO *out) \
224 lh_node_stats_bio((_LHASH *)lh, out); \
226 static inline void lh_##type##_node_usage_stats_bio(const LHASH_OF(type) *lh, BIO *out) \
228 lh_node_usage_stats_bio((_LHASH *)lh, out); \
230 static inline void lh_##type##_stats_bio(const LHASH_OF(type) *lh, BIO *out) \
232 lh_stats_bio((_LHASH *)lh, out); \
234 static inline unsigned long lh_##type##_get_down_load(LHASH_OF(type) *lh) \
236 return lh_get_down_load((_LHASH *)lh); \
238 static inline void lh_##type##_set_down_load(LHASH_OF(type) *lh, unsigned long dl) \
240 lh_set_down_load((_LHASH *)lh, dl); \
244 # define CHECKED_LHASH_OF(type,lh) \
245 ((_LHASH *)CHECKED_PTR_OF(LHASH_OF(type),lh))
247 /* Define wrapper functions. */
248 # define LHM_lh_new(type, name) \
249 ((LHASH_OF(type) *)lh_new(LHASH_HASH_FN(name), LHASH_COMP_FN(name)))
250 # define LHM_lh_doall(type, lh,fn) lh_doall(CHECKED_LHASH_OF(type, lh), fn)
251 # define LHM_lh_doall_arg(type, lh, fn, arg_type, arg) \
252 lh_doall_arg(CHECKED_LHASH_OF(type, lh), fn, CHECKED_PTR_OF(arg_type, arg))
254 DECLARE_LHASH_OF(OPENSSL_STRING);
255 DECLARE_LHASH_OF(OPENSSL_CSTRING);