Refactoring BIO: add error macros & text, and make update
[openssl.git] / crypto / err / err.c
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  */
110
111 #include <stdio.h>
112 #include <stdarg.h>
113 #include <string.h>
114 #include "internal/cryptlib.h"
115 #include <openssl/lhash.h>
116 #include <openssl/crypto.h>
117 #include <openssl/buffer.h>
118 #include <openssl/bio.h>
119 #include <openssl/err.h>
120 #include <openssl/opensslconf.h>
121 #include "err_lcl.h"
122
123 static void err_load_strings(int lib, ERR_STRING_DATA *str);
124
125 static void ERR_STATE_free(ERR_STATE *s);
126 #ifndef OPENSSL_NO_ERR
127 static ERR_STRING_DATA ERR_str_libraries[] = {
128     {ERR_PACK(ERR_LIB_NONE, 0, 0), "unknown library"},
129     {ERR_PACK(ERR_LIB_SYS, 0, 0), "system library"},
130     {ERR_PACK(ERR_LIB_BN, 0, 0), "bignum routines"},
131     {ERR_PACK(ERR_LIB_RSA, 0, 0), "rsa routines"},
132     {ERR_PACK(ERR_LIB_DH, 0, 0), "Diffie-Hellman routines"},
133     {ERR_PACK(ERR_LIB_EVP, 0, 0), "digital envelope routines"},
134     {ERR_PACK(ERR_LIB_BUF, 0, 0), "memory buffer routines"},
135     {ERR_PACK(ERR_LIB_OBJ, 0, 0), "object identifier routines"},
136     {ERR_PACK(ERR_LIB_PEM, 0, 0), "PEM routines"},
137     {ERR_PACK(ERR_LIB_DSA, 0, 0), "dsa routines"},
138     {ERR_PACK(ERR_LIB_X509, 0, 0), "x509 certificate routines"},
139     {ERR_PACK(ERR_LIB_ASN1, 0, 0), "asn1 encoding routines"},
140     {ERR_PACK(ERR_LIB_CONF, 0, 0), "configuration file routines"},
141     {ERR_PACK(ERR_LIB_CRYPTO, 0, 0), "common libcrypto routines"},
142     {ERR_PACK(ERR_LIB_EC, 0, 0), "elliptic curve routines"},
143     {ERR_PACK(ERR_LIB_ECDSA, 0, 0), "ECDSA routines"},
144     {ERR_PACK(ERR_LIB_ECDH, 0, 0), "ECDH routines"},
145     {ERR_PACK(ERR_LIB_SSL, 0, 0), "SSL routines"},
146     {ERR_PACK(ERR_LIB_BIO, 0, 0), "BIO routines"},
147     {ERR_PACK(ERR_LIB_PKCS7, 0, 0), "PKCS7 routines"},
148     {ERR_PACK(ERR_LIB_X509V3, 0, 0), "X509 V3 routines"},
149     {ERR_PACK(ERR_LIB_PKCS12, 0, 0), "PKCS12 routines"},
150     {ERR_PACK(ERR_LIB_RAND, 0, 0), "random number generator"},
151     {ERR_PACK(ERR_LIB_DSO, 0, 0), "DSO support routines"},
152     {ERR_PACK(ERR_LIB_TS, 0, 0), "time stamp routines"},
153     {ERR_PACK(ERR_LIB_ENGINE, 0, 0), "engine routines"},
154     {ERR_PACK(ERR_LIB_OCSP, 0, 0), "OCSP routines"},
155     {ERR_PACK(ERR_LIB_FIPS, 0, 0), "FIPS routines"},
156     {ERR_PACK(ERR_LIB_CMS, 0, 0), "CMS routines"},
157     {ERR_PACK(ERR_LIB_HMAC, 0, 0), "HMAC routines"},
158     {ERR_PACK(ERR_LIB_ASYNC, 0, 0), "ASYNC routines"},
159     {0, NULL},
160 };
161
162 static ERR_STRING_DATA ERR_str_functs[] = {
163     {ERR_PACK(0, SYS_F_FOPEN, 0), "fopen"},
164     {ERR_PACK(0, SYS_F_CONNECT, 0), "connect"},
165     {ERR_PACK(0, SYS_F_GETSERVBYNAME, 0), "getservbyname"},
166     {ERR_PACK(0, SYS_F_SOCKET, 0), "socket"},
167     {ERR_PACK(0, SYS_F_IOCTLSOCKET, 0), "ioctlsocket"},
168     {ERR_PACK(0, SYS_F_BIND, 0), "bind"},
169     {ERR_PACK(0, SYS_F_LISTEN, 0), "listen"},
170     {ERR_PACK(0, SYS_F_ACCEPT, 0), "accept"},
171 # ifdef OPENSSL_SYS_WINDOWS
172     {ERR_PACK(0, SYS_F_WSASTARTUP, 0), "WSAstartup"},
173 # endif
174     {ERR_PACK(0, SYS_F_OPENDIR, 0), "opendir"},
175     {ERR_PACK(0, SYS_F_FREAD, 0), "fread"},
176     {ERR_PACK(0, SYS_F_GETADDRINFO, 0), "getaddrinfo"},
177     {ERR_PACK(0, SYS_F_GETNAMEINFO, 0), "getnameinfo"},
178     {0, NULL},
179 };
180
181 static ERR_STRING_DATA ERR_str_reasons[] = {
182     {ERR_R_SYS_LIB, "system lib"},
183     {ERR_R_BN_LIB, "BN lib"},
184     {ERR_R_RSA_LIB, "RSA lib"},
185     {ERR_R_DH_LIB, "DH lib"},
186     {ERR_R_EVP_LIB, "EVP lib"},
187     {ERR_R_BUF_LIB, "BUF lib"},
188     {ERR_R_OBJ_LIB, "OBJ lib"},
189     {ERR_R_PEM_LIB, "PEM lib"},
190     {ERR_R_DSA_LIB, "DSA lib"},
191     {ERR_R_X509_LIB, "X509 lib"},
192     {ERR_R_ASN1_LIB, "ASN1 lib"},
193     {ERR_R_CONF_LIB, "CONF lib"},
194     {ERR_R_CRYPTO_LIB, "CRYPTO lib"},
195     {ERR_R_EC_LIB, "EC lib"},
196     {ERR_R_SSL_LIB, "SSL lib"},
197     {ERR_R_BIO_LIB, "BIO lib"},
198     {ERR_R_PKCS7_LIB, "PKCS7 lib"},
199     {ERR_R_X509V3_LIB, "X509V3 lib"},
200     {ERR_R_PKCS12_LIB, "PKCS12 lib"},
201     {ERR_R_RAND_LIB, "RAND lib"},
202     {ERR_R_DSO_LIB, "DSO lib"},
203     {ERR_R_ENGINE_LIB, "ENGINE lib"},
204     {ERR_R_OCSP_LIB, "OCSP lib"},
205     {ERR_R_TS_LIB, "TS lib"},
206     {ERR_R_ECDSA_LIB, "ECDSA lib"},
207
208     {ERR_R_NESTED_ASN1_ERROR, "nested asn1 error"},
209     {ERR_R_BAD_ASN1_OBJECT_HEADER, "bad asn1 object header"},
210     {ERR_R_BAD_GET_ASN1_OBJECT_CALL, "bad get asn1 object call"},
211     {ERR_R_EXPECTING_AN_ASN1_SEQUENCE, "expecting an asn1 sequence"},
212     {ERR_R_ASN1_LENGTH_MISMATCH, "asn1 length mismatch"},
213     {ERR_R_MISSING_ASN1_EOS, "missing asn1 eos"},
214
215     {ERR_R_FATAL, "fatal"},
216     {ERR_R_MALLOC_FAILURE, "malloc failure"},
217     {ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED,
218      "called a function you should not call"},
219     {ERR_R_PASSED_NULL_PARAMETER, "passed a null parameter"},
220     {ERR_R_INTERNAL_ERROR, "internal error"},
221     {ERR_R_DISABLED, "called a function that was disabled at compile-time"},
222
223     {0, NULL},
224 };
225 #endif
226
227 /* Predeclarations of the "err_defaults" functions */
228 static LHASH_OF(ERR_STRING_DATA) *get_hash(int create, int lockit);
229 static ERR_STRING_DATA *int_err_get_item(const ERR_STRING_DATA *);
230 static LHASH_OF(ERR_STATE) *int_thread_get(int create, int lockit);
231 static void int_thread_release(LHASH_OF(ERR_STATE) **hash);
232 static ERR_STATE *int_thread_get_item(const ERR_STATE *);
233 static ERR_STATE *int_thread_set_item(ERR_STATE *);
234 static void int_thread_del_item(const ERR_STATE *);
235
236 /*
237  * The internal state
238  */
239 static LHASH_OF(ERR_STRING_DATA) *int_error_hash = NULL;
240 static LHASH_OF(ERR_STATE) *int_thread_hash = NULL;
241 static int int_thread_hash_references = 0;
242 static int int_err_library_number = ERR_LIB_USER;
243
244 static unsigned long get_error_values(int inc, int top, const char **file,
245                                       int *line, const char **data,
246                                       int *flags);
247
248 static unsigned long err_string_data_hash(const ERR_STRING_DATA *a)
249 {
250     unsigned long ret, l;
251
252     l = a->error;
253     ret = l ^ ERR_GET_LIB(l) ^ ERR_GET_FUNC(l);
254     return (ret ^ ret % 19 * 13);
255 }
256
257 static int err_string_data_cmp(const ERR_STRING_DATA *a,
258                                const ERR_STRING_DATA *b)
259 {
260     return (int)(a->error - b->error);
261 }
262
263 static LHASH_OF(ERR_STRING_DATA) *get_hash(int create, int lockit)
264 {
265     LHASH_OF(ERR_STRING_DATA) *ret = NULL;
266
267     if (lockit)
268         CRYPTO_w_lock(CRYPTO_LOCK_ERR);
269     if (!int_error_hash && create) {
270         int_error_hash = lh_ERR_STRING_DATA_new(err_string_data_hash,
271                                                 err_string_data_cmp);
272     }
273     if (int_error_hash != NULL)
274         ret = int_error_hash;
275     if (lockit)
276         CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
277
278     return ret;
279 }
280
281 static ERR_STRING_DATA *int_err_get_item(const ERR_STRING_DATA *d)
282 {
283     ERR_STRING_DATA *p = NULL;
284     LHASH_OF(ERR_STRING_DATA) *hash;
285
286     CRYPTO_r_lock(CRYPTO_LOCK_ERR);
287     hash = get_hash(0, 0);
288     if (hash)
289         p = lh_ERR_STRING_DATA_retrieve(hash, d);
290     CRYPTO_r_unlock(CRYPTO_LOCK_ERR);
291
292     return p;
293 }
294
295 static unsigned long err_state_hash(const ERR_STATE *a)
296 {
297     return CRYPTO_THREADID_hash(&a->tid) * 13;
298 }
299
300 static int err_state_cmp(const ERR_STATE *a, const ERR_STATE *b)
301 {
302     return CRYPTO_THREADID_cmp(&a->tid, &b->tid);
303 }
304
305 static LHASH_OF(ERR_STATE) *int_thread_get(int create, int lockit)
306 {
307     LHASH_OF(ERR_STATE) *ret = NULL;
308
309     if (lockit)
310         CRYPTO_w_lock(CRYPTO_LOCK_ERR);
311     if (!int_thread_hash && create) {
312         int_thread_hash = lh_ERR_STATE_new(err_state_hash, err_state_cmp);
313     }
314     if (int_thread_hash != NULL) {
315         int_thread_hash_references++;
316         ret = int_thread_hash;
317     }
318     if (lockit)
319         CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
320     return ret;
321 }
322
323 static void int_thread_release(LHASH_OF(ERR_STATE) **hash)
324 {
325     int i;
326
327     if (hash == NULL || *hash == NULL)
328         return;
329
330     i = CRYPTO_add(&int_thread_hash_references, -1, CRYPTO_LOCK_ERR);
331
332 #ifdef REF_PRINT
333     fprintf(stderr, "%4d:%s\n", int_thread_hash_references, "ERR");
334 #endif
335     if (i > 0)
336         return;
337 #ifdef REF_CHECK
338     if (i < 0) {
339         fprintf(stderr, "int_thread_release, bad reference count\n");
340         abort();                /* ok */
341     }
342 #endif
343     *hash = NULL;
344 }
345
346 static ERR_STATE *int_thread_get_item(const ERR_STATE *d)
347 {
348     ERR_STATE *p = NULL;
349     LHASH_OF(ERR_STATE) *hash;
350
351     CRYPTO_r_lock(CRYPTO_LOCK_ERR);
352     hash = int_thread_get(0, 0);
353     if (hash)
354         p = lh_ERR_STATE_retrieve(hash, d);
355     CRYPTO_r_unlock(CRYPTO_LOCK_ERR);
356
357     int_thread_release(&hash);
358     return p;
359 }
360
361 static ERR_STATE *int_thread_set_item(ERR_STATE *d)
362 {
363     ERR_STATE *p = NULL;
364     LHASH_OF(ERR_STATE) *hash;
365
366     CRYPTO_w_lock(CRYPTO_LOCK_ERR);
367     hash = int_thread_get(1, 0);
368     if (hash)
369         p = lh_ERR_STATE_insert(hash, d);
370     CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
371
372     int_thread_release(&hash);
373     return p;
374 }
375
376 static void int_thread_del_item(const ERR_STATE *d)
377 {
378     ERR_STATE *p = NULL;
379     LHASH_OF(ERR_STATE) *hash;
380
381     CRYPTO_w_lock(CRYPTO_LOCK_ERR);
382     hash = int_thread_get(0, 0);
383     if (hash) {
384         p = lh_ERR_STATE_delete(hash, d);
385         /* If there are no other references, and we just removed the
386          * last item, delete the int_thread_hash */
387         if (int_thread_hash_references == 1
388             && int_thread_hash
389             && lh_ERR_STATE_num_items(int_thread_hash) == 0) {
390             int_thread_hash_references = 0;
391             lh_ERR_STATE_free(int_thread_hash);
392             int_thread_hash = NULL;
393             hash = NULL;
394         }
395     }
396     CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
397
398     int_thread_release(&hash);
399     ERR_STATE_free(p);
400 }
401
402 #ifndef OPENSSL_NO_ERR
403 # define NUM_SYS_STR_REASONS 127
404 # define LEN_SYS_STR_REASON 32
405
406 static ERR_STRING_DATA SYS_str_reasons[NUM_SYS_STR_REASONS + 1];
407 /*
408  * SYS_str_reasons is filled with copies of strerror() results at
409  * initialization. 'errno' values up to 127 should cover all usual errors,
410  * others will be displayed numerically by ERR_error_string. It is crucial
411  * that we have something for each reason code that occurs in
412  * ERR_str_reasons, or bogus reason strings will be returned for SYSerr(),
413  * which always gets an errno value and never one of those 'standard' reason
414  * codes.
415  */
416
417 static void build_SYS_str_reasons(void)
418 {
419     /* OPENSSL_malloc cannot be used here, use static storage instead */
420     static char strerror_tab[NUM_SYS_STR_REASONS][LEN_SYS_STR_REASON];
421     static int init = 1;
422     int i;
423
424     CRYPTO_r_lock(CRYPTO_LOCK_ERR);
425     if (!init) {
426         CRYPTO_r_unlock(CRYPTO_LOCK_ERR);
427         return;
428     }
429
430     CRYPTO_r_unlock(CRYPTO_LOCK_ERR);
431     CRYPTO_w_lock(CRYPTO_LOCK_ERR);
432     if (!init) {
433         CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
434         return;
435     }
436
437     for (i = 1; i <= NUM_SYS_STR_REASONS; i++) {
438         ERR_STRING_DATA *str = &SYS_str_reasons[i - 1];
439
440         str->error = (unsigned long)i;
441         if (str->string == NULL) {
442             char (*dest)[LEN_SYS_STR_REASON] = &(strerror_tab[i - 1]);
443             char *src = strerror(i);
444             if (src != NULL) {
445                 strncpy(*dest, src, sizeof(*dest));
446                 (*dest)[sizeof(*dest) - 1] = '\0';
447                 str->string = *dest;
448             }
449         }
450         if (str->string == NULL)
451             str->string = "unknown";
452     }
453
454     /*
455      * Now we still have SYS_str_reasons[NUM_SYS_STR_REASONS] = {0, NULL}, as
456      * required by ERR_load_strings.
457      */
458
459     init = 0;
460
461     CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
462 }
463 #endif
464
465 #define err_clear_data(p,i) \
466         do { \
467         if ((p)->err_data_flags[i] & ERR_TXT_MALLOCED) \
468                 {  \
469                 OPENSSL_free((p)->err_data[i]); \
470                 (p)->err_data[i]=NULL; \
471                 } \
472         (p)->err_data_flags[i]=0; \
473         } while(0)
474
475 #define err_clear(p,i) \
476         do { \
477         (p)->err_flags[i]=0; \
478         (p)->err_buffer[i]=0; \
479         err_clear_data(p,i); \
480         (p)->err_file[i]=NULL; \
481         (p)->err_line[i]= -1; \
482         } while(0)
483
484 static void ERR_STATE_free(ERR_STATE *s)
485 {
486     int i;
487
488     if (s == NULL)
489         return;
490
491     for (i = 0; i < ERR_NUM_ERRORS; i++) {
492         err_clear_data(s, i);
493     }
494     OPENSSL_free(s);
495 }
496
497 void ERR_load_ERR_strings(void)
498 {
499 #ifndef OPENSSL_NO_ERR
500     err_load_strings(0, ERR_str_libraries);
501     err_load_strings(0, ERR_str_reasons);
502     err_load_strings(ERR_LIB_SYS, ERR_str_functs);
503     build_SYS_str_reasons();
504     err_load_strings(ERR_LIB_SYS, SYS_str_reasons);
505 #endif
506 }
507
508 static void err_load_strings(int lib, ERR_STRING_DATA *str)
509 {
510     LHASH_OF(ERR_STRING_DATA) *hash;
511
512     CRYPTO_w_lock(CRYPTO_LOCK_ERR);
513     hash = get_hash(1, 0);
514     if (hash) {
515         for (; str->error; str++) {
516             if (lib)
517                 str->error |= ERR_PACK(lib, 0, 0);
518             (void)lh_ERR_STRING_DATA_insert(hash, str);
519         }
520     }
521     CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
522 }
523
524 void ERR_load_strings(int lib, ERR_STRING_DATA *str)
525 {
526     ERR_load_ERR_strings();
527     err_load_strings(lib, str);
528 }
529
530 void ERR_unload_strings(int lib, ERR_STRING_DATA *str)
531 {
532     LHASH_OF(ERR_STRING_DATA) *hash;
533
534     CRYPTO_w_lock(CRYPTO_LOCK_ERR);
535     hash = get_hash(0, 0);
536     if (hash) {
537         for (; str->error; str++) {
538             if (lib)
539                 str->error |= ERR_PACK(lib, 0, 0);
540             (void)lh_ERR_STRING_DATA_delete(hash, str);
541         }
542     }
543     CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
544 }
545
546 void ERR_free_strings(void)
547 {
548     CRYPTO_w_lock(CRYPTO_LOCK_ERR);
549     lh_ERR_STRING_DATA_free(int_error_hash);
550     int_error_hash = NULL;
551     CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
552 }
553
554 /********************************************************/
555
556 void ERR_put_error(int lib, int func, int reason, const char *file, int line)
557 {
558     ERR_STATE *es;
559
560 #ifdef _OSD_POSIX
561     /*
562      * In the BS2000-OSD POSIX subsystem, the compiler generates path names
563      * in the form "*POSIX(/etc/passwd)". This dirty hack strips them to
564      * something sensible. @@@ We shouldn't modify a const string, though.
565      */
566     if (strncmp(file, "*POSIX(", sizeof("*POSIX(") - 1) == 0) {
567         char *end;
568
569         /* Skip the "*POSIX(" prefix */
570         file += sizeof("*POSIX(") - 1;
571         end = &file[strlen(file) - 1];
572         if (*end == ')')
573             *end = '\0';
574         /* Optional: use the basename of the path only. */
575         if ((end = strrchr(file, '/')) != NULL)
576             file = &end[1];
577     }
578 #endif
579     es = ERR_get_state();
580
581     es->top = (es->top + 1) % ERR_NUM_ERRORS;
582     if (es->top == es->bottom)
583         es->bottom = (es->bottom + 1) % ERR_NUM_ERRORS;
584     es->err_flags[es->top] = 0;
585     es->err_buffer[es->top] = ERR_PACK(lib, func, reason);
586     es->err_file[es->top] = file;
587     es->err_line[es->top] = line;
588     err_clear_data(es, es->top);
589 }
590
591 void ERR_clear_error(void)
592 {
593     int i;
594     ERR_STATE *es;
595
596     es = ERR_get_state();
597
598     for (i = 0; i < ERR_NUM_ERRORS; i++) {
599         err_clear(es, i);
600     }
601     es->top = es->bottom = 0;
602 }
603
604 unsigned long ERR_get_error(void)
605 {
606     return (get_error_values(1, 0, NULL, NULL, NULL, NULL));
607 }
608
609 unsigned long ERR_get_error_line(const char **file, int *line)
610 {
611     return (get_error_values(1, 0, file, line, NULL, NULL));
612 }
613
614 unsigned long ERR_get_error_line_data(const char **file, int *line,
615                                       const char **data, int *flags)
616 {
617     return (get_error_values(1, 0, file, line, data, flags));
618 }
619
620 unsigned long ERR_peek_error(void)
621 {
622     return (get_error_values(0, 0, NULL, NULL, NULL, NULL));
623 }
624
625 unsigned long ERR_peek_error_line(const char **file, int *line)
626 {
627     return (get_error_values(0, 0, file, line, NULL, NULL));
628 }
629
630 unsigned long ERR_peek_error_line_data(const char **file, int *line,
631                                        const char **data, int *flags)
632 {
633     return (get_error_values(0, 0, file, line, data, flags));
634 }
635
636 unsigned long ERR_peek_last_error(void)
637 {
638     return (get_error_values(0, 1, NULL, NULL, NULL, NULL));
639 }
640
641 unsigned long ERR_peek_last_error_line(const char **file, int *line)
642 {
643     return (get_error_values(0, 1, file, line, NULL, NULL));
644 }
645
646 unsigned long ERR_peek_last_error_line_data(const char **file, int *line,
647                                             const char **data, int *flags)
648 {
649     return (get_error_values(0, 1, file, line, data, flags));
650 }
651
652 static unsigned long get_error_values(int inc, int top, const char **file,
653                                       int *line, const char **data,
654                                       int *flags)
655 {
656     int i = 0;
657     ERR_STATE *es;
658     unsigned long ret;
659
660     es = ERR_get_state();
661
662     if (inc && top) {
663         if (file)
664             *file = "";
665         if (line)
666             *line = 0;
667         if (data)
668             *data = "";
669         if (flags)
670             *flags = 0;
671
672         return ERR_R_INTERNAL_ERROR;
673     }
674
675     if (es->bottom == es->top)
676         return 0;
677     if (top)
678         i = es->top;            /* last error */
679     else
680         i = (es->bottom + 1) % ERR_NUM_ERRORS; /* first error */
681
682     ret = es->err_buffer[i];
683     if (inc) {
684         es->bottom = i;
685         es->err_buffer[i] = 0;
686     }
687
688     if ((file != NULL) && (line != NULL)) {
689         if (es->err_file[i] == NULL) {
690             *file = "NA";
691             if (line != NULL)
692                 *line = 0;
693         } else {
694             *file = es->err_file[i];
695             if (line != NULL)
696                 *line = es->err_line[i];
697         }
698     }
699
700     if (data == NULL) {
701         if (inc) {
702             err_clear_data(es, i);
703         }
704     } else {
705         if (es->err_data[i] == NULL) {
706             *data = "";
707             if (flags != NULL)
708                 *flags = 0;
709         } else {
710             *data = es->err_data[i];
711             if (flags != NULL)
712                 *flags = es->err_data_flags[i];
713         }
714     }
715     return ret;
716 }
717
718 void ERR_error_string_n(unsigned long e, char *buf, size_t len)
719 {
720     char lsbuf[64], fsbuf[64], rsbuf[64];
721     const char *ls, *fs, *rs;
722     unsigned long l, f, r;
723
724     l = ERR_GET_LIB(e);
725     f = ERR_GET_FUNC(e);
726     r = ERR_GET_REASON(e);
727
728     ls = ERR_lib_error_string(e);
729     fs = ERR_func_error_string(e);
730     rs = ERR_reason_error_string(e);
731
732     if (ls == NULL)
733         BIO_snprintf(lsbuf, sizeof(lsbuf), "lib(%lu)", l);
734     if (fs == NULL)
735         BIO_snprintf(fsbuf, sizeof(fsbuf), "func(%lu)", f);
736     if (rs == NULL)
737         BIO_snprintf(rsbuf, sizeof(rsbuf), "reason(%lu)", r);
738
739     BIO_snprintf(buf, len, "error:%08lX:%s:%s:%s", e, ls ? ls : lsbuf,
740                  fs ? fs : fsbuf, rs ? rs : rsbuf);
741     if (strlen(buf) == len - 1) {
742         /*
743          * output may be truncated; make sure we always have 5
744          * colon-separated fields, i.e. 4 colons ...
745          */
746 #define NUM_COLONS 4
747         if (len > NUM_COLONS) { /* ... if possible */
748             int i;
749             char *s = buf;
750
751             for (i = 0; i < NUM_COLONS; i++) {
752                 char *colon = strchr(s, ':');
753                 if (colon == NULL || colon > &buf[len - 1] - NUM_COLONS + i) {
754                     /*
755                      * set colon no. i at last possible position (buf[len-1]
756                      * is the terminating 0)
757                      */
758                     colon = &buf[len - 1] - NUM_COLONS + i;
759                     *colon = ':';
760                 }
761                 s = colon + 1;
762             }
763         }
764     }
765 }
766
767 /* BAD for multi-threading: uses a local buffer if ret == NULL */
768 /*
769  * ERR_error_string_n should be used instead for ret != NULL as
770  * ERR_error_string cannot know how large the buffer is
771  */
772 char *ERR_error_string(unsigned long e, char *ret)
773 {
774     static char buf[256];
775
776     if (ret == NULL)
777         ret = buf;
778     ERR_error_string_n(e, ret, 256);
779
780     return ret;
781 }
782
783 LHASH_OF(ERR_STRING_DATA) *ERR_get_string_table(void)
784 {
785     return get_hash(0, 1);
786 }
787
788 LHASH_OF(ERR_STATE) *ERR_get_err_state_table(void)
789 {
790     return int_thread_get(0, 1);
791 }
792
793 void ERR_release_err_state_table(LHASH_OF(ERR_STATE) **hash)
794 {
795     int_thread_release(hash);
796 }
797
798 const char *ERR_lib_error_string(unsigned long e)
799 {
800     ERR_STRING_DATA d, *p;
801     unsigned long l;
802
803     l = ERR_GET_LIB(e);
804     d.error = ERR_PACK(l, 0, 0);
805     p = int_err_get_item(&d);
806     return ((p == NULL) ? NULL : p->string);
807 }
808
809 const char *ERR_func_error_string(unsigned long e)
810 {
811     ERR_STRING_DATA d, *p;
812     unsigned long l, f;
813
814     l = ERR_GET_LIB(e);
815     f = ERR_GET_FUNC(e);
816     d.error = ERR_PACK(l, f, 0);
817     p = int_err_get_item(&d);
818     return ((p == NULL) ? NULL : p->string);
819 }
820
821 const char *ERR_reason_error_string(unsigned long e)
822 {
823     ERR_STRING_DATA d, *p = NULL;
824     unsigned long l, r;
825
826     l = ERR_GET_LIB(e);
827     r = ERR_GET_REASON(e);
828     d.error = ERR_PACK(l, 0, r);
829     p = int_err_get_item(&d);
830     if (!p) {
831         d.error = ERR_PACK(0, 0, r);
832         p = int_err_get_item(&d);
833     }
834     return ((p == NULL) ? NULL : p->string);
835 }
836
837 void ERR_remove_thread_state(const CRYPTO_THREADID *id)
838 {
839     ERR_STATE tmp;
840
841     if (id)
842         CRYPTO_THREADID_cpy(&tmp.tid, id);
843     else
844         CRYPTO_THREADID_current(&tmp.tid);
845     /*
846      * thread_del_item automatically destroys the LHASH if the number of
847      * items reaches zero.
848      */
849     int_thread_del_item(&tmp);
850 }
851
852 #if OPENSSL_API_COMPAT < 0x10000000L
853 void ERR_remove_state(unsigned long pid)
854 {
855     ERR_remove_thread_state(NULL);
856 }
857 #endif
858
859 ERR_STATE *ERR_get_state(void)
860 {
861     static ERR_STATE fallback;
862     ERR_STATE *ret, tmp, *tmpp = NULL;
863     int i;
864     CRYPTO_THREADID tid;
865
866     CRYPTO_THREADID_current(&tid);
867     CRYPTO_THREADID_cpy(&tmp.tid, &tid);
868     ret = int_thread_get_item(&tmp);
869
870     /* ret == the error state, if NULL, make a new one */
871     if (ret == NULL) {
872         ret = OPENSSL_malloc(sizeof(*ret));
873         if (ret == NULL)
874             return (&fallback);
875         CRYPTO_THREADID_cpy(&ret->tid, &tid);
876         ret->top = 0;
877         ret->bottom = 0;
878         for (i = 0; i < ERR_NUM_ERRORS; i++) {
879             ret->err_data[i] = NULL;
880             ret->err_data_flags[i] = 0;
881         }
882         tmpp = int_thread_set_item(ret);
883         /* To check if insertion failed, do a get. */
884         if (int_thread_get_item(ret) != ret) {
885             ERR_STATE_free(ret); /* could not insert it */
886             return (&fallback);
887         }
888         /*
889          * If a race occurred in this function and we came second, tmpp is
890          * the first one that we just replaced.
891          */
892         ERR_STATE_free(tmpp);
893     }
894     return ret;
895 }
896
897 int ERR_get_next_error_library(void)
898 {
899     int ret;
900
901     CRYPTO_w_lock(CRYPTO_LOCK_ERR);
902     ret = int_err_library_number++;
903     CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
904     return ret;
905 }
906
907 void ERR_set_error_data(char *data, int flags)
908 {
909     ERR_STATE *es;
910     int i;
911
912     es = ERR_get_state();
913
914     i = es->top;
915     if (i == 0)
916         i = ERR_NUM_ERRORS - 1;
917
918     err_clear_data(es, i);
919     es->err_data[i] = data;
920     es->err_data_flags[i] = flags;
921 }
922
923 void ERR_add_error_data(int num, ...)
924 {
925     va_list args;
926     va_start(args, num);
927     ERR_add_error_vdata(num, args);
928     va_end(args);
929 }
930
931 void ERR_add_error_vdata(int num, va_list args)
932 {
933     int i, n, s;
934     char *str, *p, *a;
935
936     s = 80;
937     str = OPENSSL_malloc(s + 1);
938     if (str == NULL)
939         return;
940     str[0] = '\0';
941
942     n = 0;
943     for (i = 0; i < num; i++) {
944         a = va_arg(args, char *);
945         /* ignore NULLs, thanks to Bob Beck <beck@obtuse.com> */
946         if (a != NULL) {
947             n += strlen(a);
948             if (n > s) {
949                 s = n + 20;
950                 p = OPENSSL_realloc(str, s + 1);
951                 if (p == NULL) {
952                     OPENSSL_free(str);
953                     return;
954                 }
955                 str = p;
956             }
957             OPENSSL_strlcat(str, a, (size_t)s + 1);
958         }
959     }
960     ERR_set_error_data(str, ERR_TXT_MALLOCED | ERR_TXT_STRING);
961 }
962
963 int ERR_set_mark(void)
964 {
965     ERR_STATE *es;
966
967     es = ERR_get_state();
968
969     if (es->bottom == es->top)
970         return 0;
971     es->err_flags[es->top] |= ERR_FLAG_MARK;
972     return 1;
973 }
974
975 int ERR_pop_to_mark(void)
976 {
977     ERR_STATE *es;
978
979     es = ERR_get_state();
980
981     while (es->bottom != es->top
982            && (es->err_flags[es->top] & ERR_FLAG_MARK) == 0) {
983         err_clear(es, es->top);
984         es->top -= 1;
985         if (es->top == -1)
986             es->top = ERR_NUM_ERRORS - 1;
987     }
988
989     if (es->bottom == es->top)
990         return 0;
991     es->err_flags[es->top] &= ~ERR_FLAG_MARK;
992     return 1;
993 }