Import of old SSLeay release: SSLeay 0.8.1b
[openssl.git] / crypto / err / err.h
1 /* crypto/err/err.h */
2 /* Copyright (C) 1995-1997 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 #ifndef HEADER_ERR_H
60 #define HEADER_ERR_H
61
62 #ifdef  __cplusplus
63 extern "C" {
64 #endif
65
66 /* The following is a bit of a trick to help the object files only contain
67  * the 'name of the file' string once.  Since 'err.h' is protected by the
68  * HEADER_ERR_H stuff, this should be included only once per file. */
69
70 #define ERR_file_name   __FILE__
71
72 #ifndef NO_ERR
73 #define ERR_PUT_error(a,b,c,d,e)        ERR_put_error(a,b,c,d,e)
74 #else
75 #define ERR_PUT_error(a,b,c,d,e)        ERR_put_error(a,b,c,NULL,0)
76 #endif
77
78 #include <errno.h>
79
80 #define ERR_NUM_ERRORS  10
81 typedef struct err_state_st
82         {
83         unsigned long pid;
84         unsigned long err_buffer[ERR_NUM_ERRORS];
85         char *err_file[ERR_NUM_ERRORS];
86         int err_line[ERR_NUM_ERRORS];
87         int top,bottom;
88         } ERR_STATE;
89
90 /* library */
91 #define ERR_LIB_NONE            1
92 #define ERR_LIB_SYS             2
93 #define ERR_LIB_BN              3
94 #define ERR_LIB_RSA             4
95 #define ERR_LIB_DH              5
96 #define ERR_LIB_EVP             6
97 #define ERR_LIB_BUF             7
98 #define ERR_LIB_OBJ             8
99 #define ERR_LIB_PEM             9
100 #define ERR_LIB_DSA             10
101 #define ERR_LIB_X509            11
102 #define ERR_LIB_METH            12
103 #define ERR_LIB_ASN1            13
104 #define ERR_LIB_CONF            14
105 #define ERR_LIB_SSL             20
106 #define ERR_LIB_SSL23           21
107 #define ERR_LIB_SSL2            22
108 #define ERR_LIB_SSL3            23
109 #define ERR_LIB_RSAREF          30
110 #define ERR_LIB_PROXY           31
111 #define ERR_LIB_BIO             32
112 #define ERR_LIB_PKCS7           33
113
114 #define ERR_LIB_USER            128
115
116 #define SYSerr(f,r)     ERR_PUT_error(ERR_LIB_SYS,(f),(r),ERR_file_name,__LINE__)
117 #define BNerr(f,r)      ERR_PUT_error(ERR_LIB_BN,(f),(r),ERR_file_name,__LINE__)
118 #define RSAerr(f,r)     ERR_PUT_error(ERR_LIB_RSA,(f),(r),ERR_file_name,__LINE__)
119 #define DHerr(f,r)      ERR_PUT_error(ERR_LIB_DH,(f),(r),ERR_file_name,__LINE__)
120 #define EVPerr(f,r)     ERR_PUT_error(ERR_LIB_EVP,(f),(r),ERR_file_name,__LINE__)
121 #define BUFerr(f,r)     ERR_PUT_error(ERR_LIB_BUF,(f),(r),ERR_file_name,__LINE__)
122 #define BIOerr(f,r)     ERR_PUT_error(ERR_LIB_BIO,(f),(r),ERR_file_name,__LINE__)
123 #define OBJerr(f,r)     ERR_PUT_error(ERR_LIB_OBJ,(f),(r),ERR_file_name,__LINE__)
124 #define PEMerr(f,r)     ERR_PUT_error(ERR_LIB_PEM,(f),(r),ERR_file_name,__LINE__)
125 #define DSAerr(f,r)     ERR_PUT_error(ERR_LIB_DSA,(f),(r),ERR_file_name,__LINE__)
126 #define X509err(f,r)    ERR_PUT_error(ERR_LIB_X509,(f),(r),ERR_file_name,__LINE__)
127 #define METHerr(f,r)    ERR_PUT_error(ERR_LIB_METH,(f),(r),ERR_file_name,__LINE__)
128 #define ASN1err(f,r)    ERR_PUT_error(ERR_LIB_ASN1,(f),(r),ERR_file_name,__LINE__)
129 #define CONFerr(f,r)    ERR_PUT_error(ERR_LIB_CONF,(f),(r),ERR_file_name,__LINE__)
130 #define SSLerr(f,r)     ERR_PUT_error(ERR_LIB_SSL,(f),(r),ERR_file_name,__LINE__)
131 #define SSL23err(f,r)   ERR_PUT_error(ERR_LIB_SSL23,(f),(r),ERR_file_name,__LINE__)
132 #define SSL2err(f,r)    ERR_PUT_error(ERR_LIB_SSL2,(f),(r),ERR_file_name,__LINE__)
133 #define SSL3err(f,r)    ERR_PUT_error(ERR_LIB_SSL3,(f),(r),ERR_file_name,__LINE__)
134 #define RSAREFerr(f,r)  ERR_PUT_error(ERR_LIB_RSAREF,(f),(r),ERR_file_name,__LINE__)
135 #define PROXYerr(f,r)   ERR_PUT_error(ERR_LIB_PROXY,(f),(r),ERR_file_name,__LINE__)
136 #define PKCS7err(f,r)   ERR_PUT_error(ERR_LIB_PKCS7,(f),(r),ERR_file_name,__LINE__)
137
138 /* Borland C seems too stupid to be able to shift and do longs in
139  * the pre-processor :-( */
140 #define ERR_PACK(l,f,r)         (((((unsigned long)l)&0xffL)*0x1000000)| \
141                                 ((((unsigned long)f)&0xfffL)*0x1000)| \
142                                 ((((unsigned long)r)&0xfffL)))
143 #define ERR_GET_LIB(l)          (int)((((unsigned long)l)>>24L)&0xffL)
144 #define ERR_GET_FUNC(l)         (int)((((unsigned long)l)>>12L)&0xfffL)
145 #define ERR_GET_REASON(l)       (int)((l)&0xfffL)
146 #define ERR_FATAL_ERROR(l)      (int)((l)&ERR_R_FATAL)
147
148 /* OS fuctions */
149 #define SYS_F_FOPEN             1
150 #define SYS_F_CONNECT           2
151 #define SYS_F_GETSERVBYNAME     3
152 #define SYS_F_SOCKET            4
153 #define SYS_F_IOCTLSOCKET       5
154 #define SYS_F_BIND              6
155 #define SYS_F_LISTEN            7
156 #define SYS_F_ACCEPT            8
157 #define SYS_F_WSASTARTUP        9 /* Winsock stuff */
158
159 #define ERR_R_FATAL             32      
160 /* reasons */
161 #define ERR_R_SYS_LIB   ERR_LIB_SYS
162 #define ERR_R_BN_LIB    ERR_LIB_BN
163 #define ERR_R_RSA_LIB   ERR_LIB_RSA
164 #define ERR_R_DSA_LIB   ERR_LIB_DSA
165 #define ERR_R_DH_LIB    ERR_LIB_DH
166 #define ERR_R_EVP_LIB   ERR_LIB_EVP
167 #define ERR_R_BUF_LIB   ERR_LIB_BUF
168 #define ERR_R_BIO_LIB   ERR_LIB_BIO
169 #define ERR_R_OBJ_LIB   ERR_LIB_OBJ
170 #define ERR_R_PEM_LIB   ERR_LIB_PEM
171 #define ERR_R_X509_LIB  ERR_LIB_X509
172 #define ERR_R_METH_LIB  ERR_LIB_METH
173 #define ERR_R_ASN1_LIB  ERR_LIB_ASN1
174 #define ERR_R_CONF_LIB  ERR_LIB_CONF
175 #define ERR_R_SSL_LIB   ERR_LIB_SSL
176 #define ERR_R_SSL23_LIB ERR_LIB_SSL23
177 #define ERR_R_SSL2_LIB  ERR_LIB_SSL2
178 #define ERR_R_SSL3_LIB  ERR_LIB_SSL3
179 #define ERR_R_PROXY_LIB ERR_LIB_PROXY
180 #define ERR_R_BIO_LIB   ERR_LIB_BIO
181 #define ERR_R_PKCS7_LIB ERR_LIB_PKCS7
182
183 /* fatal error */
184 #define ERR_R_MALLOC_FAILURE                    (1|ERR_R_FATAL)
185 #define ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED       (2|ERR_R_FATAL)
186 #define ERR_R_PASSED_NULL_PARAMETER             (3|ERR_R_FATAL)
187
188 typedef struct ERR_string_data_st
189         {
190         unsigned long error;
191         char *string;
192         } ERR_STRING_DATA;
193
194 #ifndef NOPROTO
195 void ERR_put_error(int lib, int func,int reason,char *file,int line);
196 unsigned long ERR_get_error(void );
197 unsigned long ERR_get_error_line(char **file,int *line);
198 unsigned long ERR_peek_error(void );
199 unsigned long ERR_peek_error_line(char **file,int *line);
200 void ERR_clear_error(void );
201 char *ERR_error_string(unsigned long e,char *buf);
202 char *ERR_lib_error_string(unsigned long e);
203 char *ERR_func_error_string(unsigned long e);
204 char *ERR_reason_error_string(unsigned long e);
205 #ifndef WIN16
206 void ERR_print_errors_fp(FILE *fp);
207 #endif
208 #ifdef HEADER_BIO_H
209 void ERR_print_errors(BIO *bp);
210 #endif
211 void ERR_load_strings(int lib,ERR_STRING_DATA str[]);
212 void ERR_load_ERR_strings(void );
213 void ERR_load_crypto_strings(void );
214 void ERR_free_strings(void );
215
216 void ERR_remove_state(unsigned long pid); /* if zero we look it up */
217 ERR_STATE *ERR_get_state(void);
218
219 #ifdef HEADER_LHASH_H
220 LHASH *ERR_get_string_table(void );
221 LHASH *ERR_get_err_state_table(void );
222 #else
223 char *ERR_get_string_table(void );
224 char *ERR_get_err_state_table(void );
225 #endif
226
227 #else
228
229 void ERR_put_error();
230 unsigned long ERR_get_error();
231 unsigned long ERR_get_error_line();
232 unsigned long ERR_peek_error();
233 unsigned long ERR_peek_error_line();
234 void ERR_clear_error();
235 char *ERR_error_string();
236 char *ERR_lib_error_string();
237 char *ERR_func_error_string();
238 char *ERR_reason_error_string();
239 #ifndef WIN16
240 void ERR_print_errors_fp();
241 #endif
242 void ERR_print_errors();
243 void ERR_load_strings();
244 void ERR_load_ERR_strings();
245 void ERR_load_crypto_strings();
246 void ERR_free_strings();
247
248 void ERR_remove_state();
249 ERR_STATE *ERR_get_state();
250
251 #ifdef HEADER_LHASH_H
252 LHASH *ERR_get_string_table();
253 LHASH *ERR_get_err_state_table();
254 #else
255 char *ERR_get_string_table();
256 char *ERR_get_err_state_table();
257 #endif
258
259 #endif
260
261 #ifdef  __cplusplus
262 }
263 #endif
264
265 #endif