1 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
2 * All rights reserved.
3 *
4 * This package is an SSL implementation written
5 * by Eric Young (eay@cryptsoft.com).
6 * The implementation was written so as to conform with Netscapes SSL.
7 *
8 * This library is free for commercial and non-commercial use as long as
9 * the following conditions are aheared to. The following conditions
10 * apply to all code found in this distribution, be it the RC4, RSA,
11 * lhash, DES, etc., code; not just the SSL code. The SSL documentation
12 * included with this distribution is covered by the same copyright terms
13 * except that the holder is Tim Hudson (tjh@cryptsoft.com).
14 *
15 * Copyright remains Eric Young's, and as such any Copyright notices in
16 * the code are not to be removed.
17 * If this package is used in a product, Eric Young should be given attribution
18 * as the author of the parts of the library used.
19 * This can be in the form of a textual message at program startup or
20 * in documentation (online or textual) provided with the package.
21 *
22 * Redistribution and use in source and binary forms, with or without
23 * modification, are permitted provided that the following conditions
24 * are met:
25 * 1. Redistributions of source code must retain the copyright
26 * notice, this list of conditions and the following disclaimer.
27 * 2. Redistributions in binary form must reproduce the above copyright
28 * notice, this list of conditions and the following disclaimer in the
29 * documentation and/or other materials provided with the distribution.
30 * 3. All advertising materials mentioning features or use of this software
31 * must display the following acknowledgement:
32 * "This product includes cryptographic software written by
33 * Eric Young (eay@cryptsoft.com)"
34 * The word 'cryptographic' can be left out if the rouines from the library
35 * being used are not cryptographic related :-).
36 * 4. If you include any Windows specific code (or a derivative thereof) from
37 * the apps directory (application code) you must include an acknowledgement:
38 * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
39 *
40 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
41 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
43 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
44 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
45 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
46 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
48 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
49 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
50 * SUCH DAMAGE.
51 *
52 * The licence and distribution terms for any publically available version or
53 * derivative of this code cannot be changed. i.e. this code cannot simply be
54 * copied and put under another distribution licence
55 * [including the GNU Public Licence.]
56 */
57 /* ====================================================================
58 * Copyright (c) 1998-2006 The OpenSSL Project. All rights reserved.
59 *
60 * Redistribution and use in source and binary forms, with or without
61 * modification, are permitted provided that the following conditions
62 * are met:
63 *
64 * 1. Redistributions of source code must retain the above copyright
65 * notice, this list of conditions and the following disclaimer.
66 *
67 * 2. Redistributions in binary form must reproduce the above copyright
68 * notice, this list of conditions and the following disclaimer in
69 * the documentation and/or other materials provided with the
70 * distribution.
71 *
72 * 3. All advertising materials mentioning features or use of this
73 * software must display the following acknowledgment:
74 * "This product includes software developed by the OpenSSL Project
75 * for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
76 *
77 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
78 * endorse or promote products derived from this software without
79 * prior written permission. For written permission, please contact
80 * openssl-core@openssl.org.
81 *
82 * 5. Products derived from this software may not be called "OpenSSL"
83 * nor may "OpenSSL" appear in their names without prior written
84 * permission of the OpenSSL Project.
85 *
86 * 6. Redistributions of any form whatsoever must retain the following
87 * acknowledgment:
88 * "This product includes software developed by the OpenSSL Project
89 * for use in the OpenSSL Toolkit (http://www.openssl.org/)"
90 *
91 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
92 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
93 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
94 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
95 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
96 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
97 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
98 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
99 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
100 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
101 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
102 * OF THE POSSIBILITY OF SUCH DAMAGE.
103 * ====================================================================
104 *
105 * This product includes cryptographic software written by Eric Young
106 * (eay@cryptsoft.com). This product includes software written by Tim
107 * Hudson (tjh@cryptsoft.com). */
108
109 #include <openssl/err.h>
110
111 #include <assert.h>
112
113 #include <openssl/lhash.h>
114 #include <openssl/mem.h>
115
116
117 DEFINE_LHASH_OF(ERR_STATE);
118 DEFINE_LHASH_OF(ERR_STRING_DATA);
119
120 /* state_hash is a map from thread ID to ERR_STATE. It works like thread-local
121 * storage. */
122 static LHASH_OF(ERR_STATE) *state_hash = NULL;
123
124 /* error_hash maps from a packed error to the string for that library /
125 * function / reason. */
126 static LHASH_OF(ERR_STRING_DATA) *error_hash = NULL;
127
128 /* global_next_library contains the next custom library value to return. */
129 static int global_next_library = ERR_NUM_LIBS;
130
131 /* err_string_data_hash is an lhash hash function for ERR_STRING_DATA. */
err_string_data_hash(const ERR_STRING_DATA * a)132 static uint32_t err_string_data_hash(const ERR_STRING_DATA *a) {
133 return OPENSSL_hash32(&a->error, sizeof(a->error));
134 }
135
136 /* err_string_data_cmp is an lhash compare function for ERR_STRING_DATA. */
err_string_data_cmp(const ERR_STRING_DATA * a,const ERR_STRING_DATA * b)137 static int err_string_data_cmp(const ERR_STRING_DATA *a,
138 const ERR_STRING_DATA *b) {
139 return ((int)a->error) - ((int)b->error);
140 }
141
142 /* error_hash_get_write_locked returns the hash that maps from packed error to
143 * error string and creates it if need be. The caller must hold a write lock on
144 * LOCK_ERR. */
LHASH_OF(ERR_STRING_DATA)145 static LHASH_OF(ERR_STRING_DATA) * error_hash_get_write_locked(void) {
146 if (!error_hash) {
147 error_hash = lh_ERR_STRING_DATA_new(err_string_data_hash, err_string_data_cmp);
148 }
149
150 return error_hash;
151 }
152
153 /* err_get_item returns an ERR_STRING_DATA with an |error| member that
154 * equals |packed_error|, or NULL if none can be found. */
err_get_item(uint32_t packed_error)155 static ERR_STRING_DATA *err_get_item(uint32_t packed_error) {
156 ERR_STRING_DATA *ret = NULL, pattern;
157
158 pattern.error = packed_error;
159
160 CRYPTO_r_lock(CRYPTO_LOCK_ERR);
161 if (error_hash) {
162 ret = lh_ERR_STRING_DATA_retrieve(error_hash, &pattern);
163 }
164 CRYPTO_r_unlock(CRYPTO_LOCK_ERR);
165
166 return ret;
167 }
168
169 /* err_set_item adds an ERR_STRING_DATA to the global hash of error strings and
170 * returns the previous entry with the same |err->error| value, if any. */
err_set_item(const ERR_STRING_DATA * err)171 static ERR_STRING_DATA *err_set_item(const ERR_STRING_DATA *err) {
172 ERR_STRING_DATA *old_item = NULL;
173 LHASH_OF(ERR_STRING_DATA) *hash;
174
175 CRYPTO_w_lock(CRYPTO_LOCK_ERR);
176 hash = error_hash_get_write_locked();
177 if (hash) {
178 lh_ERR_STRING_DATA_insert(hash, &old_item, (ERR_STRING_DATA*) err);
179 }
180 CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
181
182 return old_item;
183 }
184
185 /* err_set_item removes an item from the global hash of error strings for
186 * |packed_error| and returns the removed entry, if any. */
err_del_item(uint32_t packed_error)187 static ERR_STRING_DATA *err_del_item(uint32_t packed_error) {
188 ERR_STRING_DATA *old_item = NULL, pattern;
189
190 pattern.error = packed_error;
191
192 CRYPTO_w_lock(CRYPTO_LOCK_ERR);
193 if (error_hash) {
194 old_item = lh_ERR_STRING_DATA_delete(error_hash, &pattern);
195 }
196 CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
197
198 return old_item;
199 }
200
201
202 /* err_state_hash is an lhash hash function for ERR_STATE. */
err_state_hash(const ERR_STATE * a)203 static uint32_t err_state_hash(const ERR_STATE *a) {
204 return CRYPTO_THREADID_hash(&a->tid);
205 }
206
207 /* err_state_cmp is an lhash compare function for ERR_STATE. */
err_state_cmp(const ERR_STATE * a,const ERR_STATE * b)208 static int err_state_cmp(const ERR_STATE *a, const ERR_STATE *b) {
209 return CRYPTO_THREADID_cmp(&a->tid, &b->tid);
210 }
211
212
err_get_state(void)213 static ERR_STATE *err_get_state(void) {
214 CRYPTO_THREADID tid;
215 ERR_STATE pattern, *state, *race_state;
216 int insert_result;
217 static ERR_STATE fallback;
218
219 CRYPTO_THREADID_current(&tid);
220 memset(&pattern, 0, sizeof(pattern));
221 CRYPTO_THREADID_cpy(&pattern.tid, &tid);
222
223 CRYPTO_r_lock(CRYPTO_LOCK_ERR);
224 if (state_hash == NULL) {
225 CRYPTO_r_unlock(CRYPTO_LOCK_ERR);
226 CRYPTO_w_lock(CRYPTO_LOCK_ERR);
227 if (state_hash == NULL) {
228 state_hash = lh_ERR_STATE_new(err_state_hash, err_state_cmp);
229 }
230 CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
231 CRYPTO_r_lock(CRYPTO_LOCK_ERR);
232 }
233
234 state = lh_ERR_STATE_retrieve(state_hash, &pattern);
235 CRYPTO_r_unlock(CRYPTO_LOCK_ERR);
236 if (state != NULL) {
237 return state;
238 }
239
240 state = OPENSSL_malloc(sizeof(ERR_STATE));
241 if (state == NULL) {
242 CRYPTO_r_unlock(CRYPTO_LOCK_ERR);
243 /* The other error functions don't cope with a failure to get the error
244 * state, so we return a dummy value. */
245 return &fallback;
246 }
247
248 memset(state, 0, sizeof(ERR_STATE));
249 CRYPTO_THREADID_cpy(&state->tid, &tid);
250
251 CRYPTO_w_lock(CRYPTO_LOCK_ERR);
252 insert_result = lh_ERR_STATE_insert(state_hash, &race_state, state);
253 CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
254
255 if (!insert_result) {
256 /* Insertion failed because of malloc failure. */
257 OPENSSL_free(state);
258 return &fallback;
259 }
260
261 /* We cannot have raced with another thread to insert an ERR_STATE because no
262 * other thread should be inserting values for this thread. */
263 assert(race_state == NULL);
264
265 return state;
266 }
267
err_release_state(const CRYPTO_THREADID * tid)268 static ERR_STATE *err_release_state(const CRYPTO_THREADID *tid) {
269 ERR_STATE pattern, *state;
270
271 CRYPTO_THREADID_cpy(&pattern.tid, tid);
272
273 CRYPTO_r_lock(CRYPTO_LOCK_ERR);
274 if (state_hash == NULL) {
275 CRYPTO_r_unlock(CRYPTO_LOCK_ERR);
276 return NULL;
277 }
278
279 state = lh_ERR_STATE_delete(state_hash, &pattern);
280 CRYPTO_r_unlock(CRYPTO_LOCK_ERR);
281
282 return state;
283 }
284
err_shutdown(void)285 static void err_shutdown(void) {
286 CRYPTO_w_lock(CRYPTO_LOCK_ERR);
287 if (error_hash) {
288 lh_ERR_STRING_DATA_free(error_hash);
289 error_hash = NULL;
290 }
291 CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
292 }
293
err_get_next_library(void)294 static int err_get_next_library(void) {
295 int ret;
296
297 CRYPTO_w_lock(CRYPTO_LOCK_ERR);
298 ret = global_next_library++;
299 CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
300
301 return ret;
302 }
303
304 const struct ERR_FNS_st openssl_err_default_impl = {
305 err_shutdown,
306 err_get_item,
307 err_set_item,
308 err_del_item,
309 err_get_state,
310 err_release_state,
311 err_get_next_library,
312 };
313