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.]
59 © Portions copyright (c) 2006 Nokia Corporation. All rights reserved.
62 /* Header for dynamic hash table routines
66 #ifndef HEADER_LHASH_H
67 #define HEADER_LHASH_H
69 #if (defined(__SYMBIAN32__) && !defined(SYMBIAN))
76 #include <openssl/e_os2.h>
77 #ifndef OPENSSL_NO_FP_API
81 #ifndef OPENSSL_NO_BIO
82 #include <openssl/bio.h>
89 typedef struct lhash_node_st
92 struct lhash_node_st *next;
93 #ifndef OPENSSL_NO_HASH_COMP
98 typedef int (*LHASH_COMP_FN_TYPE)(const void *, const void *);
99 typedef unsigned long (*LHASH_HASH_FN_TYPE)(const void *);
100 typedef void (*LHASH_DOALL_FN_TYPE)(void *);
101 typedef void (*LHASH_DOALL_ARG_FN_TYPE)(void *, void *);
103 /* Macros for declaring and implementing type-safe wrappers for LHASH callbacks.
104 * This way, callbacks can be provided to LHASH structures without function
105 * pointer casting and the macro-defined callbacks provide per-variable casting
106 * before deferring to the underlying type-specific callbacks. NB: It is
107 * possible to place a "static" in front of both the DECLARE and IMPLEMENT
108 * macros if the functions are strictly internal. */
110 /* First: "hash" functions */
111 #define DECLARE_LHASH_HASH_FN(f_name,o_type) \
112 unsigned long f_name##_LHASH_HASH(const void *);
113 #define IMPLEMENT_LHASH_HASH_FN(f_name,o_type) \
114 unsigned long f_name##_LHASH_HASH(const void *arg) { \
115 o_type a = (o_type)arg; \
117 #define LHASH_HASH_FN(f_name) f_name##_LHASH_HASH
119 /* Second: "compare" functions */
120 #define DECLARE_LHASH_COMP_FN(f_name,o_type) \
121 int f_name##_LHASH_COMP(const void *, const void *);
122 #define IMPLEMENT_LHASH_COMP_FN(f_name,o_type) \
123 int f_name##_LHASH_COMP(const void *arg1, const void *arg2) { \
124 o_type a = (o_type)arg1; \
125 o_type b = (o_type)arg2; \
126 return f_name(a,b); }
127 #define LHASH_COMP_FN(f_name) f_name##_LHASH_COMP
129 /* Third: "doall" functions */
130 #define DECLARE_LHASH_DOALL_FN(f_name,o_type) \
131 void f_name##_LHASH_DOALL(void *);
132 #define IMPLEMENT_LHASH_DOALL_FN(f_name,o_type) \
133 void f_name##_LHASH_DOALL(void *arg) { \
134 o_type a = (o_type)arg; \
136 #define LHASH_DOALL_FN(f_name) f_name##_LHASH_DOALL
138 /* Fourth: "doall_arg" functions */
139 #define DECLARE_LHASH_DOALL_ARG_FN(f_name,o_type,a_type) \
140 void f_name##_LHASH_DOALL_ARG(void *, void *);
141 #define IMPLEMENT_LHASH_DOALL_ARG_FN(f_name,o_type,a_type) \
142 void f_name##_LHASH_DOALL_ARG(void *arg1, void *arg2) { \
143 o_type a = (o_type)arg1; \
144 a_type b = (a_type)arg2; \
146 #define LHASH_DOALL_ARG_FN(f_name) f_name##_LHASH_DOALL_ARG
148 typedef struct lhash_st
151 LHASH_COMP_FN_TYPE comp;
152 LHASH_HASH_FN_TYPE hash;
153 unsigned int num_nodes;
154 unsigned int num_alloc_nodes;
157 unsigned long up_load; /* load times 256 */
158 unsigned long down_load; /* load times 256 */
159 unsigned long num_items;
161 unsigned long num_expands;
162 unsigned long num_expand_reallocs;
163 unsigned long num_contracts;
164 unsigned long num_contract_reallocs;
165 unsigned long num_hash_calls;
166 unsigned long num_comp_calls;
167 unsigned long num_insert;
168 unsigned long num_replace;
169 unsigned long num_delete;
170 unsigned long num_no_delete;
171 unsigned long num_retrieve;
172 unsigned long num_retrieve_miss;
173 unsigned long num_hash_comps;
178 #define LH_LOAD_MULT 256
180 /* Indicates a malloc() error in the last call, this is only bad
182 #define lh_error(lh) ((lh)->error)
184 IMPORT_C LHASH *lh_new(LHASH_HASH_FN_TYPE h, LHASH_COMP_FN_TYPE c);
185 IMPORT_C void lh_free(LHASH *lh);
186 IMPORT_C void *lh_insert(LHASH *lh, void *data);
187 IMPORT_C void *lh_delete(LHASH *lh, const void *data);
188 IMPORT_C void *lh_retrieve(LHASH *lh, const void *data);
189 IMPORT_C void lh_doall(LHASH *lh, LHASH_DOALL_FN_TYPE func);
190 IMPORT_C void lh_doall_arg(LHASH *lh, LHASH_DOALL_ARG_FN_TYPE func, void *arg);
191 IMPORT_C unsigned long lh_strhash(const char *c);
192 IMPORT_C unsigned long lh_num_items(const LHASH *lh);
194 #ifndef OPENSSL_NO_FP_API
195 IMPORT_C void lh_stats(const LHASH *lh, FILE *out);
196 IMPORT_C void lh_node_stats(const LHASH *lh, FILE *out);
197 IMPORT_C void lh_node_usage_stats(const LHASH *lh, FILE *out);
200 #ifndef OPENSSL_NO_BIO
201 IMPORT_C void lh_stats_bio(const LHASH *lh, BIO *out);
202 IMPORT_C void lh_node_stats_bio(const LHASH *lh, BIO *out);
203 IMPORT_C void lh_node_usage_stats_bio(const LHASH *lh, BIO *out);