Alexandre Savard | 1b09e31 | 2012-08-07 20:33:29 -0400 | [diff] [blame] | 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 | #ifndef HEADER_LHASH_H |
| 64 | #define HEADER_LHASH_H |
| 65 | |
| 66 | #include <openssl/e_os2.h> |
| 67 | #ifndef OPENSSL_NO_FP_API |
| 68 | #include <stdio.h> |
| 69 | #endif |
| 70 | |
| 71 | #ifndef OPENSSL_NO_BIO |
| 72 | #include <openssl/bio.h> |
| 73 | #endif |
| 74 | |
| 75 | #ifdef __cplusplus |
| 76 | extern "C" { |
| 77 | #endif |
| 78 | |
| 79 | typedef struct lhash_node_st |
| 80 | { |
| 81 | void *data; |
| 82 | struct lhash_node_st *next; |
| 83 | #ifndef OPENSSL_NO_HASH_COMP |
| 84 | unsigned long hash; |
| 85 | #endif |
| 86 | } LHASH_NODE; |
| 87 | |
| 88 | typedef int (*LHASH_COMP_FN_TYPE)(const void *, const void *); |
| 89 | typedef unsigned long (*LHASH_HASH_FN_TYPE)(const void *); |
| 90 | typedef void (*LHASH_DOALL_FN_TYPE)(void *); |
| 91 | typedef void (*LHASH_DOALL_ARG_FN_TYPE)(void *, void *); |
| 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 | /* First: "hash" functions */ |
| 101 | #define DECLARE_LHASH_HASH_FN(name, o_type) \ |
| 102 | unsigned long name##_LHASH_HASH(const void *); |
| 103 | #define IMPLEMENT_LHASH_HASH_FN(name, o_type) \ |
| 104 | unsigned long name##_LHASH_HASH(const void *arg) { \ |
| 105 | const o_type *a = arg; \ |
| 106 | return name##_hash(a); } |
| 107 | #define LHASH_HASH_FN(name) name##_LHASH_HASH |
| 108 | |
| 109 | /* Second: "compare" functions */ |
| 110 | #define DECLARE_LHASH_COMP_FN(name, o_type) \ |
| 111 | int name##_LHASH_COMP(const void *, const void *); |
| 112 | #define IMPLEMENT_LHASH_COMP_FN(name, o_type) \ |
| 113 | int name##_LHASH_COMP(const void *arg1, const void *arg2) { \ |
| 114 | const o_type *a = arg1; \ |
| 115 | const o_type *b = arg2; \ |
| 116 | return name##_cmp(a,b); } |
| 117 | #define LHASH_COMP_FN(name) name##_LHASH_COMP |
| 118 | |
| 119 | /* Third: "doall" functions */ |
| 120 | #define DECLARE_LHASH_DOALL_FN(name, o_type) \ |
| 121 | void name##_LHASH_DOALL(void *); |
| 122 | #define IMPLEMENT_LHASH_DOALL_FN(name, o_type) \ |
| 123 | void name##_LHASH_DOALL(void *arg) { \ |
| 124 | o_type *a = arg; \ |
| 125 | name##_doall(a); } |
| 126 | #define LHASH_DOALL_FN(name) name##_LHASH_DOALL |
| 127 | |
| 128 | /* Fourth: "doall_arg" functions */ |
| 129 | #define DECLARE_LHASH_DOALL_ARG_FN(name, o_type, a_type) \ |
| 130 | void name##_LHASH_DOALL_ARG(void *, void *); |
| 131 | #define IMPLEMENT_LHASH_DOALL_ARG_FN(name, o_type, a_type) \ |
| 132 | void name##_LHASH_DOALL_ARG(void *arg1, void *arg2) { \ |
| 133 | o_type *a = arg1; \ |
| 134 | a_type *b = arg2; \ |
| 135 | name##_doall_arg(a, b); } |
| 136 | #define LHASH_DOALL_ARG_FN(name) name##_LHASH_DOALL_ARG |
| 137 | |
| 138 | typedef struct lhash_st |
| 139 | { |
| 140 | LHASH_NODE **b; |
| 141 | LHASH_COMP_FN_TYPE comp; |
| 142 | LHASH_HASH_FN_TYPE hash; |
| 143 | unsigned int num_nodes; |
| 144 | unsigned int num_alloc_nodes; |
| 145 | unsigned int p; |
| 146 | unsigned int pmax; |
| 147 | unsigned long up_load; /* load times 256 */ |
| 148 | unsigned long down_load; /* load times 256 */ |
| 149 | unsigned long num_items; |
| 150 | |
| 151 | unsigned long num_expands; |
| 152 | unsigned long num_expand_reallocs; |
| 153 | unsigned long num_contracts; |
| 154 | unsigned long num_contract_reallocs; |
| 155 | unsigned long num_hash_calls; |
| 156 | unsigned long num_comp_calls; |
| 157 | unsigned long num_insert; |
| 158 | unsigned long num_replace; |
| 159 | unsigned long num_delete; |
| 160 | unsigned long num_no_delete; |
| 161 | unsigned long num_retrieve; |
| 162 | unsigned long num_retrieve_miss; |
| 163 | unsigned long num_hash_comps; |
| 164 | |
| 165 | int error; |
| 166 | } _LHASH; /* Do not use _LHASH directly, use LHASH_OF |
| 167 | * and friends */ |
| 168 | |
| 169 | #define LH_LOAD_MULT 256 |
| 170 | |
| 171 | /* Indicates a malloc() error in the last call, this is only bad |
| 172 | * in lh_insert(). */ |
| 173 | #define lh_error(lh) ((lh)->error) |
| 174 | |
| 175 | _LHASH *lh_new(LHASH_HASH_FN_TYPE h, LHASH_COMP_FN_TYPE c); |
| 176 | void lh_free(_LHASH *lh); |
| 177 | void *lh_insert(_LHASH *lh, void *data); |
| 178 | void *lh_delete(_LHASH *lh, const void *data); |
| 179 | void *lh_retrieve(_LHASH *lh, const void *data); |
| 180 | void lh_doall(_LHASH *lh, LHASH_DOALL_FN_TYPE func); |
| 181 | void lh_doall_arg(_LHASH *lh, LHASH_DOALL_ARG_FN_TYPE func, void *arg); |
| 182 | unsigned long lh_strhash(const char *c); |
| 183 | unsigned long lh_num_items(const _LHASH *lh); |
| 184 | |
| 185 | #ifndef OPENSSL_NO_FP_API |
| 186 | void lh_stats(const _LHASH *lh, FILE *out); |
| 187 | void lh_node_stats(const _LHASH *lh, FILE *out); |
| 188 | void lh_node_usage_stats(const _LHASH *lh, FILE *out); |
| 189 | #endif |
| 190 | |
| 191 | #ifndef OPENSSL_NO_BIO |
| 192 | void lh_stats_bio(const _LHASH *lh, BIO *out); |
| 193 | void lh_node_stats_bio(const _LHASH *lh, BIO *out); |
| 194 | void lh_node_usage_stats_bio(const _LHASH *lh, BIO *out); |
| 195 | #endif |
| 196 | |
| 197 | /* Type checking... */ |
| 198 | |
| 199 | #define LHASH_OF(type) struct lhash_st_##type |
| 200 | |
| 201 | #define DECLARE_LHASH_OF(type) LHASH_OF(type) { int dummy; } |
| 202 | |
| 203 | #define CHECKED_LHASH_OF(type,lh) \ |
| 204 | ((_LHASH *)CHECKED_PTR_OF(LHASH_OF(type),lh)) |
| 205 | |
| 206 | /* Define wrapper functions. */ |
| 207 | #define LHM_lh_new(type, name) \ |
| 208 | ((LHASH_OF(type) *)lh_new(LHASH_HASH_FN(name), LHASH_COMP_FN(name))) |
| 209 | #define LHM_lh_error(type, lh) \ |
| 210 | lh_error(CHECKED_LHASH_OF(type,lh)) |
| 211 | #define LHM_lh_insert(type, lh, inst) \ |
| 212 | ((type *)lh_insert(CHECKED_LHASH_OF(type, lh), \ |
| 213 | CHECKED_PTR_OF(type, inst))) |
| 214 | #define LHM_lh_retrieve(type, lh, inst) \ |
| 215 | ((type *)lh_retrieve(CHECKED_LHASH_OF(type, lh), \ |
| 216 | CHECKED_PTR_OF(type, inst))) |
| 217 | #define LHM_lh_delete(type, lh, inst) \ |
| 218 | ((type *)lh_delete(CHECKED_LHASH_OF(type, lh), \ |
| 219 | CHECKED_PTR_OF(type, inst))) |
| 220 | #define LHM_lh_doall(type, lh,fn) lh_doall(CHECKED_LHASH_OF(type, lh), fn) |
| 221 | #define LHM_lh_doall_arg(type, lh, fn, arg_type, arg) \ |
| 222 | lh_doall_arg(CHECKED_LHASH_OF(type, lh), fn, CHECKED_PTR_OF(arg_type, arg)) |
| 223 | #define LHM_lh_num_items(type, lh) lh_num_items(CHECKED_LHASH_OF(type, lh)) |
| 224 | #define LHM_lh_down_load(type, lh) (CHECKED_LHASH_OF(type, lh)->down_load) |
| 225 | #define LHM_lh_node_stats_bio(type, lh, out) \ |
| 226 | lh_node_stats_bio(CHECKED_LHASH_OF(type, lh), out) |
| 227 | #define LHM_lh_node_usage_stats_bio(type, lh, out) \ |
| 228 | lh_node_usage_stats_bio(CHECKED_LHASH_OF(type, lh), out) |
| 229 | #define LHM_lh_stats_bio(type, lh, out) \ |
| 230 | lh_stats_bio(CHECKED_LHASH_OF(type, lh), out) |
| 231 | #define LHM_lh_free(type, lh) lh_free(CHECKED_LHASH_OF(type, lh)) |
| 232 | |
| 233 | DECLARE_LHASH_OF(OPENSSL_STRING); |
| 234 | DECLARE_LHASH_OF(OPENSSL_CSTRING); |
| 235 | |
| 236 | #ifdef __cplusplus |
| 237 | } |
| 238 | #endif |
| 239 | |
| 240 | #endif |
| 241 | |