Coverage Report

Created: 2022-08-24 06:30

/src/libressl/include/openssl/lhash.h
Line
Count
Source (jump to first uncovered line)
1
/* $OpenBSD: lhash.h,v 1.12 2014/06/12 15:49:29 deraadt Exp $ */
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/opensslconf.h>
67
68
#include <stdio.h>
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
  void *data;
80
  struct lhash_node_st *next;
81
#ifndef OPENSSL_NO_HASH_COMP
82
  unsigned long hash;
83
#endif
84
} LHASH_NODE;
85
86
typedef int (*LHASH_COMP_FN_TYPE)(const void *, const void *);
87
typedef unsigned long (*LHASH_HASH_FN_TYPE)(const void *);
88
typedef void (*LHASH_DOALL_FN_TYPE)(void *);
89
typedef void (*LHASH_DOALL_ARG_FN_TYPE)(void *, void *);
90
91
/* Macros for declaring and implementing type-safe wrappers for LHASH callbacks.
92
 * This way, callbacks can be provided to LHASH structures without function
93
 * pointer casting and the macro-defined callbacks provide per-variable casting
94
 * before deferring to the underlying type-specific callbacks. NB: It is
95
 * possible to place a "static" in front of both the DECLARE and IMPLEMENT
96
 * macros if the functions are strictly internal. */
97
98
/* First: "hash" functions */
99
#define DECLARE_LHASH_HASH_FN(name, o_type) \
100
  unsigned long name##_LHASH_HASH(const void *);
101
#define IMPLEMENT_LHASH_HASH_FN(name, o_type) \
102
8.32k
  unsigned long name##_LHASH_HASH(const void *arg) { \
103
8.32k
    const o_type *a = arg; \
104
8.32k
    return name##_hash(a); }
err.c:err_string_data_LHASH_HASH
Line
Count
Source
102
2.33k
  unsigned long name##_LHASH_HASH(const void *arg) { \
103
2.33k
    const o_type *a = arg; \
104
2.33k
    return name##_hash(a); }
err.c:err_state_LHASH_HASH
Line
Count
Source
102
5.42k
  unsigned long name##_LHASH_HASH(const void *arg) { \
103
5.42k
    const o_type *a = arg; \
104
5.42k
    return name##_hash(a); }
o_names.c:obj_name_LHASH_HASH
Line
Count
Source
102
566
  unsigned long name##_LHASH_HASH(const void *arg) { \
103
566
    const o_type *a = arg; \
104
566
    return name##_hash(a); }
Unexecuted instantiation: obj_dat.c:added_obj_LHASH_HASH
Unexecuted instantiation: eng_table.c:engine_pile_LHASH_HASH
Unexecuted instantiation: ex_data.c:ex_class_item_LHASH_HASH
Unexecuted instantiation: conf_api.c:conf_value_LHASH_HASH
105
6
#define LHASH_HASH_FN(name) name##_LHASH_HASH
106
107
/* Second: "compare" functions */
108
#define DECLARE_LHASH_COMP_FN(name, o_type) \
109
  int name##_LHASH_COMP(const void *, const void *);
110
#define IMPLEMENT_LHASH_COMP_FN(name, o_type) \
111
5.56k
  int name##_LHASH_COMP(const void *arg1, const void *arg2) { \
112
5.56k
    const o_type *a = arg1;       \
113
5.56k
    const o_type *b = arg2; \
114
5.56k
    return name##_cmp(a,b); }
err.c:err_string_data_LHASH_COMP
Line
Count
Source
111
130
  int name##_LHASH_COMP(const void *arg1, const void *arg2) { \
112
130
    const o_type *a = arg1;       \
113
130
    const o_type *b = arg2; \
114
130
    return name##_cmp(a,b); }
err.c:err_state_LHASH_COMP
Line
Count
Source
111
5.42k
  int name##_LHASH_COMP(const void *arg1, const void *arg2) { \
112
5.42k
    const o_type *a = arg1;       \
113
5.42k
    const o_type *b = arg2; \
114
5.42k
    return name##_cmp(a,b); }
o_names.c:obj_name_LHASH_COMP
Line
Count
Source
111
12
  int name##_LHASH_COMP(const void *arg1, const void *arg2) { \
112
12
    const o_type *a = arg1;       \
113
12
    const o_type *b = arg2; \
114
12
    return name##_cmp(a,b); }
Unexecuted instantiation: obj_dat.c:added_obj_LHASH_COMP
Unexecuted instantiation: eng_table.c:engine_pile_LHASH_COMP
Unexecuted instantiation: ex_data.c:ex_class_item_LHASH_COMP
Unexecuted instantiation: conf_api.c:conf_value_LHASH_COMP
115
6
#define LHASH_COMP_FN(name) name##_LHASH_COMP
116
117
/* Third: "doall" functions */
118
#define DECLARE_LHASH_DOALL_FN(name, o_type) \
119
  void name##_LHASH_DOALL(void *);
120
#define IMPLEMENT_LHASH_DOALL_FN(name, o_type) \
121
0
  void name##_LHASH_DOALL(void *arg) { \
122
0
    o_type *a = arg; \
123
0
    name##_doall(a); }
Unexecuted instantiation: o_names.c:names_lh_free_LHASH_DOALL
Unexecuted instantiation: obj_dat.c:cleanup1_LHASH_DOALL
Unexecuted instantiation: obj_dat.c:cleanup2_LHASH_DOALL
Unexecuted instantiation: obj_dat.c:cleanup3_LHASH_DOALL
Unexecuted instantiation: eng_table.c:int_cleanup_cb_LHASH_DOALL
Unexecuted instantiation: conf_api.c:value_free_stack_LHASH_DOALL
124
#define LHASH_DOALL_FN(name) name##_LHASH_DOALL
125
126
/* Fourth: "doall_arg" functions */
127
#define DECLARE_LHASH_DOALL_ARG_FN(name, o_type, a_type) \
128
  void name##_LHASH_DOALL_ARG(void *, void *);
129
#define IMPLEMENT_LHASH_DOALL_ARG_FN(name, o_type, a_type) \
130
0
  void name##_LHASH_DOALL_ARG(void *arg1, void *arg2) { \
131
0
    o_type *a = arg1; \
132
0
    a_type *b = arg2; \
133
0
    name##_doall_arg(a, b); }
Unexecuted instantiation: o_names.c:do_all_fn_LHASH_DOALL_ARG
Unexecuted instantiation: eng_table.c:int_unregister_cb_LHASH_DOALL_ARG
Unexecuted instantiation: eng_table.c:int_cb_LHASH_DOALL_ARG
Unexecuted instantiation: conf_api.c:value_free_hash_LHASH_DOALL_ARG
Unexecuted instantiation: conf_def.c:dump_value_LHASH_DOALL_ARG
134
#define LHASH_DOALL_ARG_FN(name) name##_LHASH_DOALL_ARG
135
136
typedef struct lhash_st {
137
  LHASH_NODE **b;
138
  LHASH_COMP_FN_TYPE comp;
139
  LHASH_HASH_FN_TYPE hash;
140
  unsigned int num_nodes;
141
  unsigned int num_alloc_nodes;
142
  unsigned int p;
143
  unsigned int pmax;
144
  unsigned long up_load; /* load times 256 */
145
  unsigned long down_load; /* load times 256 */
146
  unsigned long num_items;
147
148
  unsigned long num_expands;
149
  unsigned long num_expand_reallocs;
150
  unsigned long num_contracts;
151
  unsigned long num_contract_reallocs;
152
  unsigned long num_hash_calls;
153
  unsigned long num_comp_calls;
154
  unsigned long num_insert;
155
  unsigned long num_replace;
156
  unsigned long num_delete;
157
  unsigned long num_no_delete;
158
  unsigned long num_retrieve;
159
  unsigned long num_retrieve_miss;
160
  unsigned long num_hash_comps;
161
162
  int error;
163
} _LHASH; /* Do not use _LHASH directly, use LHASH_OF
164
     * and friends */
165
166
2.85k
#define LH_LOAD_MULT  256
167
168
/* Indicates a malloc() error in the last call, this is only bad
169
 * in lh_insert(). */
170
1.10k
#define lh_error(lh)  ((lh)->error)
171
172
_LHASH *lh_new(LHASH_HASH_FN_TYPE h, LHASH_COMP_FN_TYPE c);
173
void lh_free(_LHASH *lh);
174
void *lh_insert(_LHASH *lh, void *data);
175
void *lh_delete(_LHASH *lh, const void *data);
176
void *lh_retrieve(_LHASH *lh, const void *data);
177
void lh_doall(_LHASH *lh, LHASH_DOALL_FN_TYPE func);
178
void lh_doall_arg(_LHASH *lh, LHASH_DOALL_ARG_FN_TYPE func, void *arg);
179
unsigned long lh_strhash(const char *c);
180
unsigned long lh_num_items(const _LHASH *lh);
181
182
void lh_stats(const _LHASH *lh, FILE *out);
183
void lh_node_stats(const _LHASH *lh, FILE *out);
184
void lh_node_usage_stats(const _LHASH *lh, FILE *out);
185
186
#ifndef OPENSSL_NO_BIO
187
void lh_stats_bio(const _LHASH *lh, BIO *out);
188
void lh_node_stats_bio(const _LHASH *lh, BIO *out);
189
void lh_node_usage_stats_bio(const _LHASH *lh, BIO *out);
190
#endif
191
192
/* Type checking... */
193
194
15.5k
#define LHASH_OF(type) struct lhash_st_##type
195
196
#define DECLARE_LHASH_OF(type) LHASH_OF(type) { int dummy; }
197
198
#define CHECKED_LHASH_OF(type,lh) \
199
8.32k
  ((_LHASH *)CHECKED_PTR_OF(LHASH_OF(type),lh))
200
201
/* Define wrapper functions. */
202
#define LHM_lh_new(type, name) \
203
6
  ((LHASH_OF(type) *)lh_new(LHASH_HASH_FN(name), LHASH_COMP_FN(name)))
204
#define LHM_lh_error(type, lh) \
205
554
  lh_error(CHECKED_LHASH_OF(type,lh))
206
#define LHM_lh_insert(type, lh, inst) \
207
2.84k
  ((type *)lh_insert(CHECKED_LHASH_OF(type, lh), \
208
2.84k
         CHECKED_PTR_OF(type, inst)))
209
#define LHM_lh_retrieve(type, lh, inst) \
210
5.47k
  ((type *)lh_retrieve(CHECKED_LHASH_OF(type, lh), \
211
5.47k
           CHECKED_PTR_OF(type, inst)))
212
#define LHM_lh_delete(type, lh, inst) \
213
0
  ((type *)lh_delete(CHECKED_LHASH_OF(type, lh),     \
214
0
         CHECKED_PTR_OF(type, inst)))
215
0
#define LHM_lh_doall(type, lh,fn) lh_doall(CHECKED_LHASH_OF(type, lh), fn)
216
#define LHM_lh_doall_arg(type, lh, fn, arg_type, arg) \
217
0
  lh_doall_arg(CHECKED_LHASH_OF(type, lh), fn, CHECKED_PTR_OF(arg_type, arg))
218
0
#define LHM_lh_num_items(type, lh) lh_num_items(CHECKED_LHASH_OF(type, lh))
219
0
#define LHM_lh_down_load(type, lh) (CHECKED_LHASH_OF(type, lh)->down_load)
220
#define LHM_lh_node_stats_bio(type, lh, out) \
221
  lh_node_stats_bio(CHECKED_LHASH_OF(type, lh), out)
222
#define LHM_lh_node_usage_stats_bio(type, lh, out) \
223
  lh_node_usage_stats_bio(CHECKED_LHASH_OF(type, lh), out)
224
#define LHM_lh_stats_bio(type, lh, out) \
225
  lh_stats_bio(CHECKED_LHASH_OF(type, lh), out)
226
0
#define LHM_lh_free(type, lh) lh_free(CHECKED_LHASH_OF(type, lh))
227
228
DECLARE_LHASH_OF(OPENSSL_STRING);
229
DECLARE_LHASH_OF(OPENSSL_CSTRING);
230
231
#ifdef  __cplusplus
232
}
233
#endif
234
235
#endif