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