crypto/lhash/lhash.h

   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         const 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)(const void *);
  91 typedef void (*LHASH_DOALL_ARG_FN_TYPE)(const 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(f_name,o_type) \
 102         unsigned long f_name##_LHASH_HASH(const void *);
 103 #define IMPLEMENT_LHASH_HASH_FN(f_name,o_type) \
 104         unsigned long f_name##_LHASH_HASH(const void *arg) { \
 105                 o_type a = (o_type)arg; \
 106                 return f_name(a); }
 107 #define LHASH_HASH_FN(f_name) f_name##_LHASH_HASH
 108
 109 /* Second: "compare" functions */
 110 #define DECLARE_LHASH_COMP_FN(f_name,o_type) \
 111         int f_name##_LHASH_COMP(const void *, const void *);
 112 #define IMPLEMENT_LHASH_COMP_FN(f_name,o_type) \
 113         int f_name##_LHASH_COMP(const void *arg1, const void *arg2) { \
 114                 o_type a = (o_type)arg1; \
 115                 o_type b = (o_type)arg2; \
 116                 return f_name(a,b); }
 117 #define LHASH_COMP_FN(f_name) f_name##_LHASH_COMP
 118
 119 /* Third: "doall" functions */
 120 #define DECLARE_LHASH_DOALL_FN(f_name,o_type) \
 121         void f_name##_LHASH_DOALL(const void *);
 122 #define IMPLEMENT_LHASH_DOALL_FN(f_name,o_type) \
 123         void f_name##_LHASH_DOALL(const void *arg) { \
 124                 o_type a = (o_type)arg; \
 125                 f_name(a); }
 126 #define LHASH_DOALL_FN(f_name) f_name##_LHASH_DOALL
 127
 128 /* Fourth: "doall_arg" functions */
 129 #define DECLARE_LHASH_DOALL_ARG_FN(f_name,o_type,a_type) \
 130         void f_name##_LHASH_DOALL_ARG(const void *, void *);
 131 #define IMPLEMENT_LHASH_DOALL_ARG_FN(f_name,o_type,a_type) \
 132         void f_name##_LHASH_DOALL_ARG(const void *arg1, void *arg2) { \
 133                 o_type a = (o_type)arg1; \
 134                 a_type b = (a_type)arg2; \
 135                 f_name(a,b); }
 136 #define LHASH_DOALL_ARG_FN(f_name) f_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;
 167
 168 #define LH_LOAD_MULT    256
 169
 170 /* Indicates a malloc() error in the last call, this is only bad
 171  * in lh_insert(). */
 172 #define lh_error(lh)    ((lh)->error)
 173
 174 LHASH *lh_new(LHASH_HASH_FN_TYPE h, LHASH_COMP_FN_TYPE c);
 175 void lh_free(LHASH *lh);
 176 void *lh_insert(LHASH *lh, const void *data);
 177 void *lh_delete(LHASH *lh, const void *data);
 178 void *lh_retrieve(LHASH *lh, const void *data);
 179 void lh_doall(LHASH *lh, LHASH_DOALL_FN_TYPE func);
 180 void lh_doall_arg(LHASH *lh, LHASH_DOALL_ARG_FN_TYPE func, void *arg);
 181 unsigned long lh_strhash(const char *c);
 182 unsigned long lh_num_items(const LHASH *lh);
 183
 184 #ifndef OPENSSL_NO_FP_API
 185 void lh_stats(const LHASH *lh, FILE *out);
 186 void lh_node_stats(const LHASH *lh, FILE *out);
 187 void lh_node_usage_stats(const LHASH *lh, FILE *out);
 188 #endif
 189
 190 #ifndef OPENSSL_NO_BIO
 191 void lh_stats_bio(const LHASH *lh, BIO *out);
 192 void lh_node_stats_bio(const LHASH *lh, BIO *out);
 193 void lh_node_usage_stats_bio(const LHASH *lh, BIO *out);
 194 #endif
 195 #ifdef  __cplusplus
 196 }
 197 #endif
 198
 199 #endif
 200