1 /* $OpenBSD: lhash.h,v 1.14 2024/03/02 11:11:11 tb 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 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/opensslconf.h> 67 68 #include <stdio.h> 69 70 #ifndef OPENSSL_NO_BIO 71 #include <openssl/bio.h> 72 #endif 73 74 #ifdef __cplusplus 75 extern "C" { 76 #endif 77 78 typedef int (*LHASH_COMP_FN_TYPE)(const void *, const void *); 79 typedef unsigned long (*LHASH_HASH_FN_TYPE)(const void *); 80 typedef void (*LHASH_DOALL_FN_TYPE)(void *); 81 typedef void (*LHASH_DOALL_ARG_FN_TYPE)(void *, void *); 82 83 /* Macros for declaring and implementing type-safe wrappers for LHASH callbacks. 84 * This way, callbacks can be provided to LHASH structures without function 85 * pointer casting and the macro-defined callbacks provide per-variable casting 86 * before deferring to the underlying type-specific callbacks. NB: It is 87 * possible to place a "static" in front of both the DECLARE and IMPLEMENT 88 * macros if the functions are strictly internal. */ 89 90 /* First: "hash" functions */ 91 #define DECLARE_LHASH_HASH_FN(name, o_type) \ 92 unsigned long name##_LHASH_HASH(const void *); 93 #define IMPLEMENT_LHASH_HASH_FN(name, o_type) \ 94 unsigned long name##_LHASH_HASH(const void *arg) { \ 95 const o_type *a = arg; \ 96 return name##_hash(a); } 97 #define LHASH_HASH_FN(name) name##_LHASH_HASH 98 99 /* Second: "compare" functions */ 100 #define DECLARE_LHASH_COMP_FN(name, o_type) \ 101 int name##_LHASH_COMP(const void *, const void *); 102 #define IMPLEMENT_LHASH_COMP_FN(name, o_type) \ 103 int name##_LHASH_COMP(const void *arg1, const void *arg2) { \ 104 const o_type *a = arg1; \ 105 const o_type *b = arg2; \ 106 return name##_cmp(a,b); } 107 #define LHASH_COMP_FN(name) name##_LHASH_COMP 108 109 /* Third: "doall" functions */ 110 #define DECLARE_LHASH_DOALL_FN(name, o_type) \ 111 void name##_LHASH_DOALL(void *); 112 #define IMPLEMENT_LHASH_DOALL_FN(name, o_type) \ 113 void name##_LHASH_DOALL(void *arg) { \ 114 o_type *a = arg; \ 115 name##_doall(a); } 116 #define LHASH_DOALL_FN(name) name##_LHASH_DOALL 117 118 /* Fourth: "doall_arg" functions */ 119 #define DECLARE_LHASH_DOALL_ARG_FN(name, o_type, a_type) \ 120 void name##_LHASH_DOALL_ARG(void *, void *); 121 #define IMPLEMENT_LHASH_DOALL_ARG_FN(name, o_type, a_type) \ 122 void name##_LHASH_DOALL_ARG(void *arg1, void *arg2) { \ 123 o_type *a = arg1; \ 124 a_type *b = arg2; \ 125 name##_doall_arg(a, b); } 126 #define LHASH_DOALL_ARG_FN(name) name##_LHASH_DOALL_ARG 127 128 typedef struct lhash_st _LHASH; 129 130 #define LH_LOAD_MULT 256 131 132 _LHASH *lh_new(LHASH_HASH_FN_TYPE h, LHASH_COMP_FN_TYPE c); 133 void lh_free(_LHASH *lh); 134 int lh_error(_LHASH *lh); 135 void *lh_insert(_LHASH *lh, void *data); 136 void *lh_delete(_LHASH *lh, const void *data); 137 void *lh_retrieve(_LHASH *lh, const void *data); 138 void lh_doall(_LHASH *lh, LHASH_DOALL_FN_TYPE func); 139 void lh_doall_arg(_LHASH *lh, LHASH_DOALL_ARG_FN_TYPE func, void *arg); 140 unsigned long lh_strhash(const char *c); 141 unsigned long lh_num_items(const _LHASH *lh); 142 143 /* Type checking... */ 144 145 #define LHASH_OF(type) struct lhash_st_##type 146 147 #define DECLARE_LHASH_OF(type) LHASH_OF(type) 148 149 #define CHECKED_LHASH_OF(type,lh) \ 150 ((_LHASH *)CHECKED_PTR_OF(LHASH_OF(type),lh)) 151 152 /* Define wrapper functions. */ 153 #define LHM_lh_new(type, name) \ 154 ((LHASH_OF(type) *)lh_new(LHASH_HASH_FN(name), LHASH_COMP_FN(name))) 155 #define LHM_lh_error(type, lh) \ 156 lh_error(CHECKED_LHASH_OF(type,lh)) 157 #define LHM_lh_insert(type, lh, inst) \ 158 ((type *)lh_insert(CHECKED_LHASH_OF(type, lh), \ 159 CHECKED_PTR_OF(type, inst))) 160 #define LHM_lh_retrieve(type, lh, inst) \ 161 ((type *)lh_retrieve(CHECKED_LHASH_OF(type, lh), \ 162 CHECKED_PTR_OF(type, inst))) 163 #define LHM_lh_delete(type, lh, inst) \ 164 ((type *)lh_delete(CHECKED_LHASH_OF(type, lh), \ 165 CHECKED_PTR_OF(type, inst))) 166 #define LHM_lh_doall(type, lh,fn) lh_doall(CHECKED_LHASH_OF(type, lh), fn) 167 #define LHM_lh_doall_arg(type, lh, fn, arg_type, arg) \ 168 lh_doall_arg(CHECKED_LHASH_OF(type, lh), fn, CHECKED_PTR_OF(arg_type, arg)) 169 #define LHM_lh_num_items(type, lh) lh_num_items(CHECKED_LHASH_OF(type, lh)) 170 #define LHM_lh_free(type, lh) lh_free(CHECKED_LHASH_OF(type, lh)) 171 172 DECLARE_LHASH_OF(OPENSSL_STRING); 173 DECLARE_LHASH_OF(OPENSSL_CSTRING); 174 175 #ifdef __cplusplus 176 } 177 #endif 178 179 #endif 180