lhash.h revision 296465
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/* 60 * Header for dynamic hash table routines 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 76extern "C" { 77#endif 78 79typedef struct lhash_node_st { 80 void *data; 81 struct lhash_node_st *next; 82# ifndef OPENSSL_NO_HASH_COMP 83 unsigned long hash; 84# endif 85} LHASH_NODE; 86 87typedef int (*LHASH_COMP_FN_TYPE) (const void *, const void *); 88typedef unsigned long (*LHASH_HASH_FN_TYPE) (const void *); 89typedef void (*LHASH_DOALL_FN_TYPE) (void *); 90typedef void (*LHASH_DOALL_ARG_FN_TYPE) (void *, void *); 91 92/* 93 * Macros for declaring and implementing type-safe wrappers for LHASH 94 * callbacks. This way, callbacks can be provided to LHASH structures without 95 * function pointer casting and the macro-defined callbacks provide 96 * per-variable casting before deferring to the underlying type-specific 97 * callbacks. NB: It is possible to place a "static" in front of both the 98 * DECLARE and IMPLEMENT macros if the functions are strictly internal. 99 */ 100 101/* First: "hash" functions */ 102# define DECLARE_LHASH_HASH_FN(f_name,o_type) \ 103 unsigned long f_name##_LHASH_HASH(const void *); 104# define IMPLEMENT_LHASH_HASH_FN(f_name,o_type) \ 105 unsigned long f_name##_LHASH_HASH(const void *arg) { \ 106 o_type a = (o_type)arg; \ 107 return f_name(a); } 108# define LHASH_HASH_FN(f_name) f_name##_LHASH_HASH 109 110/* Second: "compare" functions */ 111# define DECLARE_LHASH_COMP_FN(f_name,o_type) \ 112 int f_name##_LHASH_COMP(const void *, const void *); 113# define IMPLEMENT_LHASH_COMP_FN(f_name,o_type) \ 114 int f_name##_LHASH_COMP(const void *arg1, const void *arg2) { \ 115 o_type a = (o_type)arg1; \ 116 o_type b = (o_type)arg2; \ 117 return f_name(a,b); } 118# define LHASH_COMP_FN(f_name) f_name##_LHASH_COMP 119 120/* Third: "doall" functions */ 121# define DECLARE_LHASH_DOALL_FN(f_name,o_type) \ 122 void f_name##_LHASH_DOALL(void *); 123# define IMPLEMENT_LHASH_DOALL_FN(f_name,o_type) \ 124 void f_name##_LHASH_DOALL(void *arg) { \ 125 o_type a = (o_type)arg; \ 126 f_name(a); } 127# define LHASH_DOALL_FN(f_name) f_name##_LHASH_DOALL 128 129/* Fourth: "doall_arg" functions */ 130# define DECLARE_LHASH_DOALL_ARG_FN(f_name,o_type,a_type) \ 131 void f_name##_LHASH_DOALL_ARG(void *, void *); 132# define IMPLEMENT_LHASH_DOALL_ARG_FN(f_name,o_type,a_type) \ 133 void f_name##_LHASH_DOALL_ARG(void *arg1, void *arg2) { \ 134 o_type a = (o_type)arg1; \ 135 a_type b = (a_type)arg2; \ 136 f_name(a,b); } 137# define LHASH_DOALL_ARG_FN(f_name) f_name##_LHASH_DOALL_ARG 138 139typedef struct lhash_st { 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 unsigned long num_expands; 151 unsigned long num_expand_reallocs; 152 unsigned long num_contracts; 153 unsigned long num_contract_reallocs; 154 unsigned long num_hash_calls; 155 unsigned long num_comp_calls; 156 unsigned long num_insert; 157 unsigned long num_replace; 158 unsigned long num_delete; 159 unsigned long num_no_delete; 160 unsigned long num_retrieve; 161 unsigned long num_retrieve_miss; 162 unsigned long num_hash_comps; 163 int error; 164} LHASH; 165 166# define LH_LOAD_MULT 256 167 168/* 169 * Indicates a malloc() error in the last call, this is only bad in 170 * lh_insert(). 171 */ 172# define lh_error(lh) ((lh)->error) 173 174LHASH *lh_new(LHASH_HASH_FN_TYPE h, LHASH_COMP_FN_TYPE c); 175void lh_free(LHASH *lh); 176void *lh_insert(LHASH *lh, void *data); 177void *lh_delete(LHASH *lh, const void *data); 178void *lh_retrieve(LHASH *lh, const void *data); 179void lh_doall(LHASH *lh, LHASH_DOALL_FN_TYPE func); 180void lh_doall_arg(LHASH *lh, LHASH_DOALL_ARG_FN_TYPE func, void *arg); 181unsigned long lh_strhash(const char *c); 182unsigned long lh_num_items(const LHASH *lh); 183 184# ifndef OPENSSL_NO_FP_API 185void lh_stats(const LHASH *lh, FILE *out); 186void lh_node_stats(const LHASH *lh, FILE *out); 187void lh_node_usage_stats(const LHASH *lh, FILE *out); 188# endif 189 190# ifndef OPENSSL_NO_BIO 191void lh_stats_bio(const LHASH *lh, BIO *out); 192void lh_node_stats_bio(const LHASH *lh, BIO *out); 193void lh_node_usage_stats_bio(const LHASH *lh, BIO *out); 194# endif 195#ifdef __cplusplus 196} 197#endif 198 199#endif 200