Add a comment to explain the purpose of bn_cmp_part_words().
[openssl.git] / 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 #ifndef NO_FP_API
67 #include <stdio.h>
68 #endif
69
70 #ifndef 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         void *data;
81         struct lhash_node_st *next;
82 #ifndef NO_HASH_COMP
83         unsigned long hash;
84 #endif
85         } LHASH_NODE;
86
87 typedef int (*LHASH_COMP_FN_TYPE)(void *, void *);
88 typedef unsigned long (*LHASH_HASH_FN_TYPE)(void *);
89 typedef void (*LHASH_DOALL_FN_TYPE)(void *);
90 typedef void (*LHASH_DOALL_ARG_FN_TYPE)(void *, void *);
91
92 typedef struct lhash_st
93         {
94         LHASH_NODE **b;
95         LHASH_COMP_FN_TYPE comp;
96         LHASH_HASH_FN_TYPE hash;
97         unsigned int num_nodes;
98         unsigned int num_alloc_nodes;
99         unsigned int p;
100         unsigned int pmax;
101         unsigned long up_load; /* load times 256 */
102         unsigned long down_load; /* load times 256 */
103         unsigned long num_items;
104
105         unsigned long num_expands;
106         unsigned long num_expand_reallocs;
107         unsigned long num_contracts;
108         unsigned long num_contract_reallocs;
109         unsigned long num_hash_calls;
110         unsigned long num_comp_calls;
111         unsigned long num_insert;
112         unsigned long num_replace;
113         unsigned long num_delete;
114         unsigned long num_no_delete;
115         unsigned long num_retrieve;
116         unsigned long num_retrieve_miss;
117         unsigned long num_hash_comps;
118
119         int error;
120         } LHASH;
121
122 #define LH_LOAD_MULT    256
123
124 /* Indicates a malloc() error in the last call, this is only bad
125  * in lh_insert(). */
126 #define lh_error(lh)    ((lh)->error)
127
128 LHASH *lh_new(LHASH_HASH_FN_TYPE h, LHASH_COMP_FN_TYPE c);
129 void lh_free(LHASH *lh);
130 void *lh_insert(LHASH *lh, void *data);
131 void *lh_delete(LHASH *lh, void *data);
132 void *lh_retrieve(LHASH *lh, void *data);
133 void lh_doall(LHASH *lh, LHASH_DOALL_FN_TYPE func);
134 void lh_doall_arg(LHASH *lh, LHASH_DOALL_ARG_FN_TYPE func, void *arg);
135 unsigned long lh_strhash(const char *c);
136 unsigned long lh_num_items(const LHASH *lh);
137
138 #ifndef NO_FP_API
139 void lh_stats(const LHASH *lh, FILE *out);
140 void lh_node_stats(const LHASH *lh, FILE *out);
141 void lh_node_usage_stats(const LHASH *lh, FILE *out);
142 #endif
143
144 #ifndef NO_BIO
145 void lh_stats_bio(const LHASH *lh, BIO *out);
146 void lh_node_stats_bio(const LHASH *lh, BIO *out);
147 void lh_node_usage_stats_bio(const LHASH *lh, BIO *out);
148 #endif
149 #ifdef  __cplusplus
150 }
151 #endif
152
153 #endif
154