include/openssl/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 /*
  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_STDIO
  68 #  include <stdio.h>
  69 # endif
  70
  71 # include <openssl/bio.h>
  72
  73 #ifdef  __cplusplus
  74 extern "C" {
  75 #endif
  76
  77 typedef struct lhash_node_st {
  78     void *data;
  79     struct lhash_node_st *next;
  80     unsigned long hash;
  81 } LHASH_NODE;
  82
  83 typedef int (*LHASH_COMP_FN_TYPE) (const void *, const void *);
  84 typedef unsigned long (*LHASH_HASH_FN_TYPE) (const void *);
  85 typedef void (*LHASH_DOALL_FN_TYPE) (void *);
  86 typedef void (*LHASH_DOALL_ARG_FN_TYPE) (void *, void *);
  87
  88 /*
  89  * Macros for declaring and implementing type-safe wrappers for LHASH
  90  * callbacks. This way, callbacks can be provided to LHASH structures without
  91  * function pointer casting and the macro-defined callbacks provide
  92  * per-variable casting before deferring to the underlying type-specific
  93  * callbacks. NB: It is possible to place a "static" in front of both the
  94  * DECLARE and IMPLEMENT macros if the functions are strictly internal.
  95  */
  96
  97 /* First: "hash" functions */
  98 # define DECLARE_LHASH_HASH_FN(name, o_type) \
  99         unsigned long name##_LHASH_HASH(const void *);
 100 # define IMPLEMENT_LHASH_HASH_FN(name, o_type) \
 101         unsigned long name##_LHASH_HASH(const void *arg) { \
 102                 const o_type *a = arg; \
 103                 return name##_hash(a); }
 104 # define LHASH_HASH_FN(name) name##_LHASH_HASH
 105
 106 /* Second: "compare" functions */
 107 # define DECLARE_LHASH_COMP_FN(name, o_type) \
 108         int name##_LHASH_COMP(const void *, const void *);
 109 # define IMPLEMENT_LHASH_COMP_FN(name, o_type) \
 110         int name##_LHASH_COMP(const void *arg1, const void *arg2) { \
 111                 const o_type *a = arg1;             \
 112                 const o_type *b = arg2; \
 113                 return name##_cmp(a,b); }
 114 # define LHASH_COMP_FN(name) name##_LHASH_COMP
 115
 116 /* Fourth: "doall_arg" functions */
 117 # define DECLARE_LHASH_DOALL_ARG_FN(name, o_type, a_type) \
 118         void name##_LHASH_DOALL_ARG(void *, void *);
 119 # define IMPLEMENT_LHASH_DOALL_ARG_FN(name, o_type, a_type) \
 120         void name##_LHASH_DOALL_ARG(void *arg1, void *arg2) { \
 121                 o_type *a = arg1; \
 122                 a_type *b = arg2; \
 123                 name##_doall_arg(a, b); }
 124 # define LHASH_DOALL_ARG_FN(name) name##_LHASH_DOALL_ARG
 125
 126 typedef struct lhash_st {
 127     LHASH_NODE **b;
 128     LHASH_COMP_FN_TYPE comp;
 129     LHASH_HASH_FN_TYPE hash;
 130     unsigned int num_nodes;
 131     unsigned int num_alloc_nodes;
 132     unsigned int p;
 133     unsigned int pmax;
 134     unsigned long up_load;      /* load times 256 */
 135     unsigned long down_load;    /* load times 256 */
 136     unsigned long num_items;
 137     unsigned long num_expands;
 138     unsigned long num_expand_reallocs;
 139     unsigned long num_contracts;
 140     unsigned long num_contract_reallocs;
 141     unsigned long num_hash_calls;
 142     unsigned long num_comp_calls;
 143     unsigned long num_insert;
 144     unsigned long num_replace;
 145     unsigned long num_delete;
 146     unsigned long num_no_delete;
 147     unsigned long num_retrieve;
 148     unsigned long num_retrieve_miss;
 149     unsigned long num_hash_comps;
 150     int error;
 151 } _LHASH;                       /* Do not use _LHASH directly, use LHASH_OF
 152                                  * and friends */
 153
 154 # define LH_LOAD_MULT    256
 155
 156 /*
 157  * Indicates a malloc() error in the last call, this is only bad in
 158  * lh_insert().
 159  */
 160 int lh_error(_LHASH *lh);
 161
 162 _LHASH *lh_new(LHASH_HASH_FN_TYPE h, LHASH_COMP_FN_TYPE c);
 163 void lh_free(_LHASH *lh);
 164 void *lh_insert(_LHASH *lh, void *data);
 165 void *lh_delete(_LHASH *lh, const void *data);
 166 void *lh_retrieve(_LHASH *lh, const void *data);
 167 void lh_doall(_LHASH *lh, LHASH_DOALL_FN_TYPE func);
 168 void lh_doall_arg(_LHASH *lh, LHASH_DOALL_ARG_FN_TYPE func, void *arg);
 169 unsigned long lh_strhash(const char *c);
 170 unsigned long lh_num_items(const _LHASH *lh);
 171 unsigned long lh_get_down_load(const _LHASH *lh);
 172 void lh_set_down_load(_LHASH *lh, unsigned long down_load);
 173
 174 # ifndef OPENSSL_NO_STDIO
 175 void lh_stats(const _LHASH *lh, FILE *fp);
 176 void lh_node_stats(const _LHASH *lh, FILE *fp);
 177 void lh_node_usage_stats(const _LHASH *lh, FILE *fp);
 178 # endif
 179 void lh_stats_bio(const _LHASH *lh, BIO *out);
 180 void lh_node_stats_bio(const _LHASH *lh, BIO *out);
 181 void lh_node_usage_stats_bio(const _LHASH *lh, BIO *out);
 182
 183 /* Type checking... */
 184
 185 # define LHASH_OF(type) struct lhash_st_##type
 186
 187 # define DEFINE_LHASH_OF(type) \
 188     LHASH_OF(type) { int dummy; }; \
 189     static ossl_inline LHASH_OF(type) * \
 190         lh_##type##_new(unsigned long (*hfn)(const type *), \
 191                         int (*cfn)(const type *, const type *)) \
 192     { \
 193         return (LHASH_OF(type) *) \
 194             lh_new((LHASH_HASH_FN_TYPE) hfn, (LHASH_COMP_FN_TYPE)cfn); \
 195     } \
 196     static ossl_inline void lh_##type##_free(LHASH_OF(type) *lh) \
 197     { \
 198         lh_free((_LHASH *)lh); \
 199     } \
 200     static ossl_inline type *lh_##type##_insert(LHASH_OF(type) *lh, type *d) \
 201     { \
 202         return (type *)lh_insert((_LHASH *)lh, d); \
 203     } \
 204     static ossl_inline type *lh_##type##_delete(LHASH_OF(type) *lh, const type *d) \
 205     { \
 206         return (type *)lh_delete((_LHASH *)lh, d); \
 207     } \
 208     static ossl_inline type *lh_##type##_retrieve(LHASH_OF(type) *lh, const type *d) \
 209     { \
 210         return (type *)lh_retrieve((_LHASH *)lh, d); \
 211     } \
 212     static ossl_inline int lh_##type##_error(LHASH_OF(type) *lh) \
 213     { \
 214         return lh_error((_LHASH *)lh); \
 215     } \
 216     static ossl_inline unsigned long lh_##type##_num_items(LHASH_OF(type) *lh) \
 217     { \
 218         return lh_num_items((_LHASH *)lh); \
 219     } \
 220     static ossl_inline void lh_##type##_node_stats_bio(const LHASH_OF(type) *lh, BIO *out) \
 221     { \
 222         lh_node_stats_bio((_LHASH *)lh, out); \
 223     } \
 224     static ossl_inline void lh_##type##_node_usage_stats_bio(const LHASH_OF(type) *lh, BIO *out) \
 225     { \
 226         lh_node_usage_stats_bio((_LHASH *)lh, out); \
 227     } \
 228     static ossl_inline void lh_##type##_stats_bio(const LHASH_OF(type) *lh, BIO *out) \
 229     { \
 230         lh_stats_bio((_LHASH *)lh, out); \
 231     } \
 232     static ossl_inline unsigned long lh_##type##_get_down_load(LHASH_OF(type) *lh) \
 233     { \
 234         return lh_get_down_load((_LHASH *)lh); \
 235     } \
 236     static ossl_inline void lh_##type##_set_down_load(LHASH_OF(type) *lh, unsigned long dl) \
 237     { \
 238         lh_set_down_load((_LHASH *)lh, dl); \
 239     } \
 240     static ossl_inline void lh_##type##_doall(LHASH_OF(type) *lh, \
 241                                          void (*doall)(type *)) \
 242     { \
 243         lh_doall((_LHASH *)lh, (LHASH_DOALL_FN_TYPE)doall); \
 244     } \
 245     LHASH_OF(type)
 246
 247 #define IMPLEMENT_LHASH_DOALL_ARG_CONST(type, argtype) \
 248     int_implement_lhash_doall(type, argtype, const type)
 249
 250 #define IMPLEMENT_LHASH_DOALL_ARG(type, argtype) \
 251     int_implement_lhash_doall(type, argtype, type)
 252
 253 #define int_implement_lhash_doall(type, argtype, cbargtype) \
 254     static ossl_inline void \
 255         lh_##type##_doall_##argtype(LHASH_OF(type) *lh, \
 256                                    void (*fn)(cbargtype *, argtype *), \
 257                                    argtype *arg) \
 258     { \
 259         lh_doall_arg((_LHASH *)lh, (LHASH_DOALL_ARG_FN_TYPE)fn, (void *)arg); \
 260     } \
 261     LHASH_OF(type)
 262
 263 # define CHECKED_LHASH_OF(type,lh) \
 264   ((_LHASH *)CHECKED_PTR_OF(LHASH_OF(type),lh))
 265
 266 /* Define wrapper functions. */
 267 # define LHM_lh_doall_arg(type, lh, fn, arg_type, arg) \
 268   lh_doall_arg(CHECKED_LHASH_OF(type, lh), fn, CHECKED_PTR_OF(arg_type, arg))
 269
 270 DEFINE_LHASH_OF(OPENSSL_STRING);
 271 DEFINE_LHASH_OF(OPENSSL_CSTRING);
 272
 273 #ifdef  __cplusplus
 274 }
 275 #endif
 276
 277 #endif