jpayne@69
|
1 /*
|
jpayne@69
|
2 * Copyright 1995-2020 The OpenSSL Project Authors. All Rights Reserved.
|
jpayne@69
|
3 *
|
jpayne@69
|
4 * Licensed under the OpenSSL license (the "License"). You may not use
|
jpayne@69
|
5 * this file except in compliance with the License. You can obtain a copy
|
jpayne@69
|
6 * in the file LICENSE in the source distribution or at
|
jpayne@69
|
7 * https://www.openssl.org/source/license.html
|
jpayne@69
|
8 */
|
jpayne@69
|
9
|
jpayne@69
|
10 /*
|
jpayne@69
|
11 * Header for dynamic hash table routines Author - Eric Young
|
jpayne@69
|
12 */
|
jpayne@69
|
13
|
jpayne@69
|
14 #ifndef HEADER_LHASH_H
|
jpayne@69
|
15 # define HEADER_LHASH_H
|
jpayne@69
|
16
|
jpayne@69
|
17 # include <openssl/e_os2.h>
|
jpayne@69
|
18 # include <openssl/bio.h>
|
jpayne@69
|
19
|
jpayne@69
|
20 #ifdef __cplusplus
|
jpayne@69
|
21 extern "C" {
|
jpayne@69
|
22 #endif
|
jpayne@69
|
23
|
jpayne@69
|
24 typedef struct lhash_node_st OPENSSL_LH_NODE;
|
jpayne@69
|
25 typedef int (*OPENSSL_LH_COMPFUNC) (const void *, const void *);
|
jpayne@69
|
26 typedef unsigned long (*OPENSSL_LH_HASHFUNC) (const void *);
|
jpayne@69
|
27 typedef void (*OPENSSL_LH_DOALL_FUNC) (void *);
|
jpayne@69
|
28 typedef void (*OPENSSL_LH_DOALL_FUNCARG) (void *, void *);
|
jpayne@69
|
29 typedef struct lhash_st OPENSSL_LHASH;
|
jpayne@69
|
30
|
jpayne@69
|
31 /*
|
jpayne@69
|
32 * Macros for declaring and implementing type-safe wrappers for LHASH
|
jpayne@69
|
33 * callbacks. This way, callbacks can be provided to LHASH structures without
|
jpayne@69
|
34 * function pointer casting and the macro-defined callbacks provide
|
jpayne@69
|
35 * per-variable casting before deferring to the underlying type-specific
|
jpayne@69
|
36 * callbacks. NB: It is possible to place a "static" in front of both the
|
jpayne@69
|
37 * DECLARE and IMPLEMENT macros if the functions are strictly internal.
|
jpayne@69
|
38 */
|
jpayne@69
|
39
|
jpayne@69
|
40 /* First: "hash" functions */
|
jpayne@69
|
41 # define DECLARE_LHASH_HASH_FN(name, o_type) \
|
jpayne@69
|
42 unsigned long name##_LHASH_HASH(const void *);
|
jpayne@69
|
43 # define IMPLEMENT_LHASH_HASH_FN(name, o_type) \
|
jpayne@69
|
44 unsigned long name##_LHASH_HASH(const void *arg) { \
|
jpayne@69
|
45 const o_type *a = arg; \
|
jpayne@69
|
46 return name##_hash(a); }
|
jpayne@69
|
47 # define LHASH_HASH_FN(name) name##_LHASH_HASH
|
jpayne@69
|
48
|
jpayne@69
|
49 /* Second: "compare" functions */
|
jpayne@69
|
50 # define DECLARE_LHASH_COMP_FN(name, o_type) \
|
jpayne@69
|
51 int name##_LHASH_COMP(const void *, const void *);
|
jpayne@69
|
52 # define IMPLEMENT_LHASH_COMP_FN(name, o_type) \
|
jpayne@69
|
53 int name##_LHASH_COMP(const void *arg1, const void *arg2) { \
|
jpayne@69
|
54 const o_type *a = arg1; \
|
jpayne@69
|
55 const o_type *b = arg2; \
|
jpayne@69
|
56 return name##_cmp(a,b); }
|
jpayne@69
|
57 # define LHASH_COMP_FN(name) name##_LHASH_COMP
|
jpayne@69
|
58
|
jpayne@69
|
59 /* Fourth: "doall_arg" functions */
|
jpayne@69
|
60 # define DECLARE_LHASH_DOALL_ARG_FN(name, o_type, a_type) \
|
jpayne@69
|
61 void name##_LHASH_DOALL_ARG(void *, void *);
|
jpayne@69
|
62 # define IMPLEMENT_LHASH_DOALL_ARG_FN(name, o_type, a_type) \
|
jpayne@69
|
63 void name##_LHASH_DOALL_ARG(void *arg1, void *arg2) { \
|
jpayne@69
|
64 o_type *a = arg1; \
|
jpayne@69
|
65 a_type *b = arg2; \
|
jpayne@69
|
66 name##_doall_arg(a, b); }
|
jpayne@69
|
67 # define LHASH_DOALL_ARG_FN(name) name##_LHASH_DOALL_ARG
|
jpayne@69
|
68
|
jpayne@69
|
69
|
jpayne@69
|
70 # define LH_LOAD_MULT 256
|
jpayne@69
|
71
|
jpayne@69
|
72 int OPENSSL_LH_error(OPENSSL_LHASH *lh);
|
jpayne@69
|
73 OPENSSL_LHASH *OPENSSL_LH_new(OPENSSL_LH_HASHFUNC h, OPENSSL_LH_COMPFUNC c);
|
jpayne@69
|
74 void OPENSSL_LH_free(OPENSSL_LHASH *lh);
|
jpayne@69
|
75 void *OPENSSL_LH_insert(OPENSSL_LHASH *lh, void *data);
|
jpayne@69
|
76 void *OPENSSL_LH_delete(OPENSSL_LHASH *lh, const void *data);
|
jpayne@69
|
77 void *OPENSSL_LH_retrieve(OPENSSL_LHASH *lh, const void *data);
|
jpayne@69
|
78 void OPENSSL_LH_doall(OPENSSL_LHASH *lh, OPENSSL_LH_DOALL_FUNC func);
|
jpayne@69
|
79 void OPENSSL_LH_doall_arg(OPENSSL_LHASH *lh, OPENSSL_LH_DOALL_FUNCARG func, void *arg);
|
jpayne@69
|
80 unsigned long OPENSSL_LH_strhash(const char *c);
|
jpayne@69
|
81 unsigned long OPENSSL_LH_num_items(const OPENSSL_LHASH *lh);
|
jpayne@69
|
82 unsigned long OPENSSL_LH_get_down_load(const OPENSSL_LHASH *lh);
|
jpayne@69
|
83 void OPENSSL_LH_set_down_load(OPENSSL_LHASH *lh, unsigned long down_load);
|
jpayne@69
|
84
|
jpayne@69
|
85 # ifndef OPENSSL_NO_STDIO
|
jpayne@69
|
86 void OPENSSL_LH_stats(const OPENSSL_LHASH *lh, FILE *fp);
|
jpayne@69
|
87 void OPENSSL_LH_node_stats(const OPENSSL_LHASH *lh, FILE *fp);
|
jpayne@69
|
88 void OPENSSL_LH_node_usage_stats(const OPENSSL_LHASH *lh, FILE *fp);
|
jpayne@69
|
89 # endif
|
jpayne@69
|
90 void OPENSSL_LH_stats_bio(const OPENSSL_LHASH *lh, BIO *out);
|
jpayne@69
|
91 void OPENSSL_LH_node_stats_bio(const OPENSSL_LHASH *lh, BIO *out);
|
jpayne@69
|
92 void OPENSSL_LH_node_usage_stats_bio(const OPENSSL_LHASH *lh, BIO *out);
|
jpayne@69
|
93
|
jpayne@69
|
94 # if OPENSSL_API_COMPAT < 0x10100000L
|
jpayne@69
|
95 # define _LHASH OPENSSL_LHASH
|
jpayne@69
|
96 # define LHASH_NODE OPENSSL_LH_NODE
|
jpayne@69
|
97 # define lh_error OPENSSL_LH_error
|
jpayne@69
|
98 # define lh_new OPENSSL_LH_new
|
jpayne@69
|
99 # define lh_free OPENSSL_LH_free
|
jpayne@69
|
100 # define lh_insert OPENSSL_LH_insert
|
jpayne@69
|
101 # define lh_delete OPENSSL_LH_delete
|
jpayne@69
|
102 # define lh_retrieve OPENSSL_LH_retrieve
|
jpayne@69
|
103 # define lh_doall OPENSSL_LH_doall
|
jpayne@69
|
104 # define lh_doall_arg OPENSSL_LH_doall_arg
|
jpayne@69
|
105 # define lh_strhash OPENSSL_LH_strhash
|
jpayne@69
|
106 # define lh_num_items OPENSSL_LH_num_items
|
jpayne@69
|
107 # ifndef OPENSSL_NO_STDIO
|
jpayne@69
|
108 # define lh_stats OPENSSL_LH_stats
|
jpayne@69
|
109 # define lh_node_stats OPENSSL_LH_node_stats
|
jpayne@69
|
110 # define lh_node_usage_stats OPENSSL_LH_node_usage_stats
|
jpayne@69
|
111 # endif
|
jpayne@69
|
112 # define lh_stats_bio OPENSSL_LH_stats_bio
|
jpayne@69
|
113 # define lh_node_stats_bio OPENSSL_LH_node_stats_bio
|
jpayne@69
|
114 # define lh_node_usage_stats_bio OPENSSL_LH_node_usage_stats_bio
|
jpayne@69
|
115 # endif
|
jpayne@69
|
116
|
jpayne@69
|
117 /* Type checking... */
|
jpayne@69
|
118
|
jpayne@69
|
119 # define LHASH_OF(type) struct lhash_st_##type
|
jpayne@69
|
120
|
jpayne@69
|
121 # define DEFINE_LHASH_OF(type) \
|
jpayne@69
|
122 LHASH_OF(type) { union lh_##type##_dummy { void* d1; unsigned long d2; int d3; } dummy; }; \
|
jpayne@69
|
123 static ossl_unused ossl_inline LHASH_OF(type) *lh_##type##_new(unsigned long (*hfn)(const type *), \
|
jpayne@69
|
124 int (*cfn)(const type *, const type *)) \
|
jpayne@69
|
125 { \
|
jpayne@69
|
126 return (LHASH_OF(type) *) \
|
jpayne@69
|
127 OPENSSL_LH_new((OPENSSL_LH_HASHFUNC)hfn, (OPENSSL_LH_COMPFUNC)cfn); \
|
jpayne@69
|
128 } \
|
jpayne@69
|
129 static ossl_unused ossl_inline void lh_##type##_free(LHASH_OF(type) *lh) \
|
jpayne@69
|
130 { \
|
jpayne@69
|
131 OPENSSL_LH_free((OPENSSL_LHASH *)lh); \
|
jpayne@69
|
132 } \
|
jpayne@69
|
133 static ossl_unused ossl_inline type *lh_##type##_insert(LHASH_OF(type) *lh, type *d) \
|
jpayne@69
|
134 { \
|
jpayne@69
|
135 return (type *)OPENSSL_LH_insert((OPENSSL_LHASH *)lh, d); \
|
jpayne@69
|
136 } \
|
jpayne@69
|
137 static ossl_unused ossl_inline type *lh_##type##_delete(LHASH_OF(type) *lh, const type *d) \
|
jpayne@69
|
138 { \
|
jpayne@69
|
139 return (type *)OPENSSL_LH_delete((OPENSSL_LHASH *)lh, d); \
|
jpayne@69
|
140 } \
|
jpayne@69
|
141 static ossl_unused ossl_inline type *lh_##type##_retrieve(LHASH_OF(type) *lh, const type *d) \
|
jpayne@69
|
142 { \
|
jpayne@69
|
143 return (type *)OPENSSL_LH_retrieve((OPENSSL_LHASH *)lh, d); \
|
jpayne@69
|
144 } \
|
jpayne@69
|
145 static ossl_unused ossl_inline int lh_##type##_error(LHASH_OF(type) *lh) \
|
jpayne@69
|
146 { \
|
jpayne@69
|
147 return OPENSSL_LH_error((OPENSSL_LHASH *)lh); \
|
jpayne@69
|
148 } \
|
jpayne@69
|
149 static ossl_unused ossl_inline unsigned long lh_##type##_num_items(LHASH_OF(type) *lh) \
|
jpayne@69
|
150 { \
|
jpayne@69
|
151 return OPENSSL_LH_num_items((OPENSSL_LHASH *)lh); \
|
jpayne@69
|
152 } \
|
jpayne@69
|
153 static ossl_unused ossl_inline void lh_##type##_node_stats_bio(const LHASH_OF(type) *lh, BIO *out) \
|
jpayne@69
|
154 { \
|
jpayne@69
|
155 OPENSSL_LH_node_stats_bio((const OPENSSL_LHASH *)lh, out); \
|
jpayne@69
|
156 } \
|
jpayne@69
|
157 static ossl_unused ossl_inline void lh_##type##_node_usage_stats_bio(const LHASH_OF(type) *lh, BIO *out) \
|
jpayne@69
|
158 { \
|
jpayne@69
|
159 OPENSSL_LH_node_usage_stats_bio((const OPENSSL_LHASH *)lh, out); \
|
jpayne@69
|
160 } \
|
jpayne@69
|
161 static ossl_unused ossl_inline void lh_##type##_stats_bio(const LHASH_OF(type) *lh, BIO *out) \
|
jpayne@69
|
162 { \
|
jpayne@69
|
163 OPENSSL_LH_stats_bio((const OPENSSL_LHASH *)lh, out); \
|
jpayne@69
|
164 } \
|
jpayne@69
|
165 static ossl_unused ossl_inline unsigned long lh_##type##_get_down_load(LHASH_OF(type) *lh) \
|
jpayne@69
|
166 { \
|
jpayne@69
|
167 return OPENSSL_LH_get_down_load((OPENSSL_LHASH *)lh); \
|
jpayne@69
|
168 } \
|
jpayne@69
|
169 static ossl_unused ossl_inline void lh_##type##_set_down_load(LHASH_OF(type) *lh, unsigned long dl) \
|
jpayne@69
|
170 { \
|
jpayne@69
|
171 OPENSSL_LH_set_down_load((OPENSSL_LHASH *)lh, dl); \
|
jpayne@69
|
172 } \
|
jpayne@69
|
173 static ossl_unused ossl_inline void lh_##type##_doall(LHASH_OF(type) *lh, \
|
jpayne@69
|
174 void (*doall)(type *)) \
|
jpayne@69
|
175 { \
|
jpayne@69
|
176 OPENSSL_LH_doall((OPENSSL_LHASH *)lh, (OPENSSL_LH_DOALL_FUNC)doall); \
|
jpayne@69
|
177 } \
|
jpayne@69
|
178 LHASH_OF(type)
|
jpayne@69
|
179
|
jpayne@69
|
180 #define IMPLEMENT_LHASH_DOALL_ARG_CONST(type, argtype) \
|
jpayne@69
|
181 int_implement_lhash_doall(type, argtype, const type)
|
jpayne@69
|
182
|
jpayne@69
|
183 #define IMPLEMENT_LHASH_DOALL_ARG(type, argtype) \
|
jpayne@69
|
184 int_implement_lhash_doall(type, argtype, type)
|
jpayne@69
|
185
|
jpayne@69
|
186 #define int_implement_lhash_doall(type, argtype, cbargtype) \
|
jpayne@69
|
187 static ossl_unused ossl_inline void \
|
jpayne@69
|
188 lh_##type##_doall_##argtype(LHASH_OF(type) *lh, \
|
jpayne@69
|
189 void (*fn)(cbargtype *, argtype *), \
|
jpayne@69
|
190 argtype *arg) \
|
jpayne@69
|
191 { \
|
jpayne@69
|
192 OPENSSL_LH_doall_arg((OPENSSL_LHASH *)lh, (OPENSSL_LH_DOALL_FUNCARG)fn, (void *)arg); \
|
jpayne@69
|
193 } \
|
jpayne@69
|
194 LHASH_OF(type)
|
jpayne@69
|
195
|
jpayne@69
|
196 DEFINE_LHASH_OF(OPENSSL_STRING);
|
jpayne@69
|
197 # ifdef _MSC_VER
|
jpayne@69
|
198 /*
|
jpayne@69
|
199 * push and pop this warning:
|
jpayne@69
|
200 * warning C4090: 'function': different 'const' qualifiers
|
jpayne@69
|
201 */
|
jpayne@69
|
202 # pragma warning (push)
|
jpayne@69
|
203 # pragma warning (disable: 4090)
|
jpayne@69
|
204 # endif
|
jpayne@69
|
205
|
jpayne@69
|
206 DEFINE_LHASH_OF(OPENSSL_CSTRING);
|
jpayne@69
|
207
|
jpayne@69
|
208 # ifdef _MSC_VER
|
jpayne@69
|
209 # pragma warning (pop)
|
jpayne@69
|
210 # endif
|
jpayne@69
|
211
|
jpayne@69
|
212 /*
|
jpayne@69
|
213 * If called without higher optimization (min. -xO3) the Oracle Developer
|
jpayne@69
|
214 * Studio compiler generates code for the defined (static inline) functions
|
jpayne@69
|
215 * above.
|
jpayne@69
|
216 * This would later lead to the linker complaining about missing symbols when
|
jpayne@69
|
217 * this header file is included but the resulting object is not linked against
|
jpayne@69
|
218 * the Crypto library (openssl#6912).
|
jpayne@69
|
219 */
|
jpayne@69
|
220 # ifdef __SUNPRO_C
|
jpayne@69
|
221 # pragma weak OPENSSL_LH_new
|
jpayne@69
|
222 # pragma weak OPENSSL_LH_free
|
jpayne@69
|
223 # pragma weak OPENSSL_LH_insert
|
jpayne@69
|
224 # pragma weak OPENSSL_LH_delete
|
jpayne@69
|
225 # pragma weak OPENSSL_LH_retrieve
|
jpayne@69
|
226 # pragma weak OPENSSL_LH_error
|
jpayne@69
|
227 # pragma weak OPENSSL_LH_num_items
|
jpayne@69
|
228 # pragma weak OPENSSL_LH_node_stats_bio
|
jpayne@69
|
229 # pragma weak OPENSSL_LH_node_usage_stats_bio
|
jpayne@69
|
230 # pragma weak OPENSSL_LH_stats_bio
|
jpayne@69
|
231 # pragma weak OPENSSL_LH_get_down_load
|
jpayne@69
|
232 # pragma weak OPENSSL_LH_set_down_load
|
jpayne@69
|
233 # pragma weak OPENSSL_LH_doall
|
jpayne@69
|
234 # pragma weak OPENSSL_LH_doall_arg
|
jpayne@69
|
235 # endif /* __SUNPRO_C */
|
jpayne@69
|
236
|
jpayne@69
|
237 #ifdef __cplusplus
|
jpayne@69
|
238 }
|
jpayne@69
|
239 #endif
|
jpayne@69
|
240
|
jpayne@69
|
241 #endif
|