1 /* crypto/lhash/lhash.h */
2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
3  * All rights reserved.
4  *
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.
8  *
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).
15  *
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.
22  *
23  * Redistribution and use in source and binary forms, with or without
24  * modification, are permitted provided that the following conditions
25  * are met:
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)"
40  *
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
51  * SUCH DAMAGE.
52  *
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.]
57  */
58 
59 /* Header for dynamic hash table routines
60  * Author - Eric Young
61  */
62 
63 module deimos.openssl.lhash;
64 
65 import deimos.openssl._d_util;
66 
67 public import deimos.openssl.e_os2;
68 version(OPENSSL_NO_FP_API) {} else {
69 import core.stdc.stdio;
70 }
71 
72 version(OPENSSL_NO_BIO) {} else {
73 public import deimos.openssl.bio;
74 }
75 
76 extern (C):
77 nothrow:
78 
79 struct lhash_node_st {
80 	void* data;
81 	lhash_node_st* next;
82 version(OPENSSL_NO_HASH_COMP) {} else {
83 	c_ulong hash;
84 }
85 	}
86 alias lhash_node_st LHASH_NODE;
87 
88 alias ExternC!(int function(const(void)*, const(void)*)) LHASH_COMP_FN_TYPE;
89 alias ExternC!(c_ulong function(const(void)*)) LHASH_HASH_FN_TYPE;
90 alias ExternC!(void function(void*)) LHASH_DOALL_FN_TYPE;
91 alias ExternC!(void function(void*, void*)) LHASH_DOALL_ARG_FN_TYPE;
92 
93 /* Macros for declaring and implementing type-safe wrappers for LHASH callbacks.
94  * This way, callbacks can be provided to LHASH structures without function
95  * pointer casting and the macro-defined callbacks provide per-variable casting
96  * before deferring to the underlying type-specific callbacks. NB: It is
97  * possible to place a "static" in front of both the DECLARE and IMPLEMENT
98  * macros if the functions are strictly internal. */
99 
100 /+ FIXME: Not yet ported.
101 /* First: "hash" functions */
102 #define DECLARE_LHASH_HASH_FN(name, o_type) \
103 	c_ulong name##_LHASH_HASH(const(void)*);
104 #define IMPLEMENT_LHASH_HASH_FN(name, o_type) \
105 	c_ulong name##_LHASH_HASH(const(void)* arg) { \
106 		const(o_type)* a = arg; \
107 		return name##_hash(a); }
108 #define LHASH_HASH_FN(name) name##_LHASH_HASH
109 
110 /* Second: "compare" functions */
111 #define DECLARE_LHASH_COMP_FN(name, o_type) \
112 	int name##_LHASH_COMP(const(void)*, const(void)*);
113 #define IMPLEMENT_LHASH_COMP_FN(name, o_type) \
114 	int name##_LHASH_COMP(const(void)* arg1, const(void)* arg2) { \
115 		const(o_type)* a = arg1;		    \
116 		const(o_type)* b = arg2; \
117 		return name##_cmp(a,b); }
118 #define LHASH_COMP_FN(name) name##_LHASH_COMP
119 
120 /* Third: "doall" functions */
121 #define DECLARE_LHASH_DOALL_FN(name, o_type) \
122 	void name##_LHASH_DOALL(void*);
123 #define IMPLEMENT_LHASH_DOALL_FN(name, o_type) \
124 	void name##_LHASH_DOALL(void* arg) { \
125 		o_type* a = arg; \
126 		name##_doall(a); }
127 #define LHASH_DOALL_FN(name) name##_LHASH_DOALL
128 
129 /* Fourth: "doall_arg" functions */
130 #define DECLARE_LHASH_DOALL_ARG_FN(name, o_type, a_type) \
131 	void name##_LHASH_DOALL_ARG(void*, void*);
132 #define IMPLEMENT_LHASH_DOALL_ARG_FN(name, o_type, a_type) \
133 	void name##_LHASH_DOALL_ARG(void* arg1, void* arg2) { \
134 		o_type* a = arg1; \
135 		a_type* b = arg2; \
136 		name##_doall_arg(a, b); }
137 #define LHASH_DOALL_ARG_FN(name) name##_LHASH_DOALL_ARG
138 +/
139 
140 struct lhash_st {
141 	LHASH_NODE** b;
142 	LHASH_COMP_FN_TYPE comp;
143 	LHASH_HASH_FN_TYPE hash;
144 	uint num_nodes;
145 	uint num_alloc_nodes;
146 	uint p;
147 	uint pmax;
148 	c_ulong up_load; /* load times 256 */
149 	c_ulong down_load; /* load times 256 */
150 	c_ulong num_items;
151 
152 	c_ulong num_expands;
153 	c_ulong num_expand_reallocs;
154 	c_ulong num_contracts;
155 	c_ulong num_contract_reallocs;
156 	c_ulong num_hash_calls;
157 	c_ulong num_comp_calls;
158 	c_ulong num_insert;
159 	c_ulong num_replace;
160 	c_ulong num_delete;
161 	c_ulong num_no_delete;
162 	c_ulong num_retrieve;
163 	c_ulong num_retrieve_miss;
164 	c_ulong num_hash_comps;
165 
166 	int error;
167 	}
168 alias lhash_st _LHASH;	/* Do not use _LHASH directly, use LHASH_OF
169 			 * and friends */
170 
171 enum LH_LOAD_MULT = 256;
172 
173 /* Indicates a malloc() error in the last call, this is only bad
174  * in lh_insert(). */
175 auto lh_error()(_LHASH* lh) { return lh.error; }
176 
177 _LHASH* lh_new(LHASH_HASH_FN_TYPE h, LHASH_COMP_FN_TYPE c);
178 void lh_free(_LHASH* lh);
179 void* lh_insert(_LHASH* lh, void* data);
180 void* lh_delete(_LHASH* lh, const(void)* data);
181 void* lh_retrieve(_LHASH* lh, const(void)* data);
182 void lh_doall(_LHASH* lh, LHASH_DOALL_FN_TYPE func);
183 void lh_doall_arg(_LHASH* lh, LHASH_DOALL_ARG_FN_TYPE func, void* arg);
184 c_ulong lh_strhash(const(char)* c);
185 c_ulong lh_num_items(const(_LHASH)* lh);
186 
187 version(OPENSSL_NO_FP_API) {} else {
188 void lh_stats(const(_LHASH)* lh, FILE* out_);
189 void lh_node_stats(const(_LHASH)* lh, FILE* out_);
190 void lh_node_usage_stats(const(_LHASH)* lh, FILE* out_);
191 }
192 
193 version(OPENSSL_NO_BIO) {} else {
194 void lh_stats_bio(const(_LHASH)* lh, BIO* out_);
195 void lh_node_stats_bio(const(_LHASH)* lh, BIO* out_);
196 void lh_node_usage_stats_bio(const(_LHASH)* lh, BIO* out_);
197 }
198 
199 /* Type checking... */
200 
201 struct LHASH_OF (type) {
202 	int dummy;
203 }
204 
205 // Empty because we use LHASH_OF directly as a struct.
206 mixin template DECLARE_LHASH_OF (type) {}
207 
208 auto CHECKED_LHASH_OF (type)(LHASH_OF!type* lh) {
209 	return cast(_LHASH*)CHECKED_PTR_OF!(LHASH_OF!type)(lh);
210 }
211 
212 /+ FIXME: Not yet ported.
213 /* Define wrapper functions. */
214 #define LHM_lh_new(type, name) \
215   ((LHASH_OF!(type) *)lh_new(LHASH_HASH_FN(name), LHASH_COMP_FN(name)))
216 #define LHM_lh_error(type, lh) \
217   lh_error(CHECKED_LHASH_OF(type,lh))
218 #define LHM_lh_insert(type, lh, inst) \
219   ((type*)lh_insert(CHECKED_LHASH_OF(type, lh), \
220 		     CHECKED_PTR_OF(type, inst)))
221 #define LHM_lh_retrieve(type, lh, inst) \
222   ((type*)lh_retrieve(CHECKED_LHASH_OF(type, lh), \
223 		       CHECKED_PTR_OF(type, inst)))
224 #define LHM_lh_delete(type, lh, inst) \
225   ((type*)lh_delete(CHECKED_LHASH_OF(type, lh),			\
226 		     CHECKED_PTR_OF(type, inst)))
227 #define LHM_lh_doall(type, lh,fn) lh_doall(CHECKED_LHASH_OF(type, lh), fn)
228 #define LHM_lh_doall_arg(type, lh, fn, arg_type, arg) \
229   lh_doall_arg(CHECKED_LHASH_OF(type, lh), fn, CHECKED_PTR_OF(arg_type, arg))
230 #define LHM_lh_num_items(type, lh) lh_num_items(CHECKED_LHASH_OF(type, lh))
231 #define LHM_lh_down_load(type, lh) (CHECKED_LHASH_OF(type, lh)->down_load)
232 #define LHM_lh_node_stats_bio(type, lh, out_) \
233   lh_node_stats_bio(CHECKED_LHASH_OF(type, lh), out_)
234 #define LHM_lh_node_usage_stats_bio(type, lh, out_) \
235   lh_node_usage_stats_bio(CHECKED_LHASH_OF(type, lh), out_)
236 #define LHM_lh_stats_bio(type, lh, out_) \
237   lh_stats_bio(CHECKED_LHASH_OF(type, lh), out_)
238 #define LHM_lh_free(type, lh) lh_free(CHECKED_LHASH_OF(type, lh))
239 
240 mixin DECLARE_LHASH_OF!(OPENSSL_STRING);
241 mixin DECLARE_LHASH_OF!(OPENSSL_CSTRING);
242 +/