securityanddataprivacytools/securitytools/openssllib/import/inc/openssl/lhash.h
branchRCL_1
changeset 54 de7f90723dab
equal deleted inserted replaced
36:2d7679d6a290 54:de7f90723dab
       
     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 #ifndef OPENSSL_NO_FP_API
       
    67 #include <stdio.h>
       
    68 #endif
       
    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 struct lhash_node_st
       
    79 	{
       
    80 	const void *data;
       
    81 	struct lhash_node_st *next;
       
    82 #ifndef OPENSSL_NO_HASH_COMP
       
    83 	unsigned long hash;
       
    84 #endif
       
    85 	} LHASH_NODE;
       
    86 
       
    87 typedef int (*LHASH_COMP_FN_TYPE)(const void *, const void *);
       
    88 typedef unsigned long (*LHASH_HASH_FN_TYPE)(const void *);
       
    89 typedef void (*LHASH_DOALL_FN_TYPE)(const void *);
       
    90 typedef void (*LHASH_DOALL_ARG_FN_TYPE)(const void *, void *);
       
    91 
       
    92 /* Macros for declaring and implementing type-safe wrappers for LHASH callbacks.
       
    93  * This way, callbacks can be provided to LHASH structures without function
       
    94  * pointer casting and the macro-defined callbacks provide per-variable casting
       
    95  * before deferring to the underlying type-specific callbacks. NB: It is
       
    96  * possible to place a "static" in front of both the DECLARE and IMPLEMENT
       
    97  * macros if the functions are strictly internal. */
       
    98 
       
    99 /* First: "hash" functions */
       
   100 #define DECLARE_LHASH_HASH_FN(f_name,o_type) \
       
   101 	unsigned long f_name##_LHASH_HASH(const void *);
       
   102 #define IMPLEMENT_LHASH_HASH_FN(f_name,o_type) \
       
   103 	unsigned long f_name##_LHASH_HASH(const void *arg) { \
       
   104 		o_type a = (o_type)arg; \
       
   105 		return f_name(a); }
       
   106 #define LHASH_HASH_FN(f_name) f_name##_LHASH_HASH
       
   107 
       
   108 /* Second: "compare" functions */
       
   109 #define DECLARE_LHASH_COMP_FN(f_name,o_type) \
       
   110 	int f_name##_LHASH_COMP(const void *, const void *);
       
   111 #define IMPLEMENT_LHASH_COMP_FN(f_name,o_type) \
       
   112 	int f_name##_LHASH_COMP(const void *arg1, const void *arg2) { \
       
   113 		o_type a = (o_type)arg1; \
       
   114 		o_type b = (o_type)arg2; \
       
   115 		return f_name(a,b); }
       
   116 #define LHASH_COMP_FN(f_name) f_name##_LHASH_COMP
       
   117 
       
   118 /* Third: "doall" functions */
       
   119 #define DECLARE_LHASH_DOALL_FN(f_name,o_type) \
       
   120 	void f_name##_LHASH_DOALL(const void *);
       
   121 #define IMPLEMENT_LHASH_DOALL_FN(f_name,o_type) \
       
   122 	void f_name##_LHASH_DOALL(const void *arg) { \
       
   123 		o_type a = (o_type)arg; \
       
   124 		f_name(a); }
       
   125 #define LHASH_DOALL_FN(f_name) f_name##_LHASH_DOALL
       
   126 
       
   127 /* Fourth: "doall_arg" functions */
       
   128 #define DECLARE_LHASH_DOALL_ARG_FN(f_name,o_type,a_type) \
       
   129 	void f_name##_LHASH_DOALL_ARG(const void *, void *);
       
   130 #define IMPLEMENT_LHASH_DOALL_ARG_FN(f_name,o_type,a_type) \
       
   131 	void f_name##_LHASH_DOALL_ARG(const void *arg1, void *arg2) { \
       
   132 		o_type a = (o_type)arg1; \
       
   133 		a_type b = (a_type)arg2; \
       
   134 		f_name(a,b); }
       
   135 #define LHASH_DOALL_ARG_FN(f_name) f_name##_LHASH_DOALL_ARG
       
   136 
       
   137 typedef struct lhash_st
       
   138 	{
       
   139 	LHASH_NODE **b;
       
   140 	LHASH_COMP_FN_TYPE comp;
       
   141 	LHASH_HASH_FN_TYPE hash;
       
   142 	unsigned int num_nodes;
       
   143 	unsigned int num_alloc_nodes;
       
   144 	unsigned int p;
       
   145 	unsigned int pmax;
       
   146 	unsigned long up_load; /* load times 256 */
       
   147 	unsigned long down_load; /* load times 256 */
       
   148 	unsigned long num_items;
       
   149 
       
   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 
       
   164 	int error;
       
   165 	} LHASH;
       
   166 
       
   167 #define LH_LOAD_MULT	256
       
   168 
       
   169 /* Indicates a malloc() error in the last call, this is only bad
       
   170  * in lh_insert(). */
       
   171 #define lh_error(lh)	((lh)->error)
       
   172 
       
   173 LHASH *lh_new(LHASH_HASH_FN_TYPE h, LHASH_COMP_FN_TYPE c);
       
   174 void lh_free(LHASH *lh);
       
   175 void *lh_insert(LHASH *lh, const void *data);
       
   176 void *lh_delete(LHASH *lh, const void *data);
       
   177 void *lh_retrieve(LHASH *lh, const void *data);
       
   178 void lh_doall(LHASH *lh, LHASH_DOALL_FN_TYPE func);
       
   179 void lh_doall_arg(LHASH *lh, LHASH_DOALL_ARG_FN_TYPE func, void *arg);
       
   180 unsigned long lh_strhash(const char *c);
       
   181 unsigned long lh_num_items(const LHASH *lh);
       
   182 
       
   183 #ifndef OPENSSL_NO_FP_API
       
   184 void lh_stats(const LHASH *lh, FILE *out);
       
   185 void lh_node_stats(const LHASH *lh, FILE *out);
       
   186 void lh_node_usage_stats(const LHASH *lh, FILE *out);
       
   187 #endif
       
   188 
       
   189 #ifndef OPENSSL_NO_BIO
       
   190 void lh_stats_bio(const LHASH *lh, BIO *out);
       
   191 void lh_node_stats_bio(const LHASH *lh, BIO *out);
       
   192 void lh_node_usage_stats_bio(const LHASH *lh, BIO *out);
       
   193 #endif
       
   194 #ifdef  __cplusplus
       
   195 }
       
   196 #endif
       
   197 
       
   198 #endif
       
   199 
       
   200