The dynamic thread API changed, and so does the documentation.
[openssl.git] / crypto / cryptlib.c
1 /* crypto/cryptlib.c */
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 #include <stdio.h>
60 #include <string.h>
61 #include "cryptlib.h"
62 #include <openssl/crypto.h>
63 #include <openssl/safestack.h>
64
65 #if defined(WIN32) || defined(WIN16)
66 static double SSLeay_MSVC5_hack=0.0; /* and for VC1.5 */
67 #endif
68
69 DECLARE_STACK_OF(CRYPTO_dynlock);
70 IMPLEMENT_STACK_OF(CRYPTO_dynlock);
71
72 /* real #defines in crypto.h, keep these upto date */
73 static const char* lock_names[CRYPTO_NUM_LOCKS] =
74         {
75         "<<ERROR>>",
76         "err",
77         "err_hash",
78         "x509",
79         "x509_info",
80         "x509_pkey",
81         "x509_crl",
82         "x509_req",
83         "dsa",
84         "rsa",
85         "evp_pkey",
86         "x509_store",
87         "ssl_ctx",
88         "ssl_cert",
89         "ssl_session",
90         "ssl_sess_cert",
91         "ssl",
92         "rand",
93         "debug_malloc",
94         "BIO",
95         "gethostbyname",
96         "getservbyname",
97         "readdir",
98         "RSA_blinding",
99         "dh",
100         "debug_malloc2",
101         "dso",
102         "dynlock",
103 #if CRYPTO_NUM_LOCKS != 28
104 # error "Inconsistency between crypto.h and cryptlib.c"
105 #endif
106         };
107
108 /* This is for applications to allocate new type names in the non-dynamic
109    array of lock names.  These are numbered with positive numbers.  */
110 static STACK *app_locks=NULL;
111
112 /* For applications that want a more dynamic way of handling threads, the
113    following stack is used.  These are externally numbered with negative
114    numbers.  */
115 static STACK_OF(CRYPTO_dynlock) *dyn_locks=NULL;
116
117
118 static void (MS_FAR *locking_callback)(int mode,int type,
119         const char *file,int line)=NULL;
120 static int (MS_FAR *add_lock_callback)(int *pointer,int amount,
121         int type,const char *file,int line)=NULL;
122 static unsigned long (MS_FAR *id_callback)(void)=NULL;
123 static struct CRYPTO_dynlock_value *(MS_FAR *dynlock_create_callback)
124         (const char *file,int line)=NULL;
125 static void (MS_FAR *dynlock_locking_callback)(int mode,
126         struct CRYPTO_dynlock_value *l, const char *file,int line)=NULL;
127 static void (MS_FAR *dynlock_destroy_callback)(struct CRYPTO_dynlock_value *l,
128         const char *file,int line)=NULL;
129
130 int CRYPTO_get_new_lockid(char *name)
131         {
132         char *str;
133         int i;
134
135         /* A hack to make Visual C++ 5.0 work correctly when linking as
136          * a DLL using /MT. Without this, the application cannot use
137          * and floating point printf's.
138          * It also seems to be needed for Visual C 1.5 (win16) */
139 #if defined(WIN32) || defined(WIN16)
140         SSLeay_MSVC5_hack=(double)name[0]*(double)name[1];
141 #endif
142
143         if ((app_locks == NULL) && ((app_locks=sk_new_null()) == NULL))
144                 {
145                 CRYPTOerr(CRYPTO_F_CRYPTO_GET_NEW_LOCKID,ERR_R_MALLOC_FAILURE);
146                 return(0);
147                 }
148         if ((str=BUF_strdup(name)) == NULL)
149                 {
150                 CRYPTOerr(CRYPTO_F_CRYPTO_GET_NEW_LOCKID,ERR_R_MALLOC_FAILURE);
151                 return(0);
152                 }
153         i=sk_push(app_locks,str);
154         if (!i)
155                 OPENSSL_free(str);
156         else
157                 i+=CRYPTO_NUM_LOCKS; /* gap of one :-) */
158         return(i);
159         }
160
161 int CRYPTO_num_locks(void)
162         {
163         return CRYPTO_NUM_LOCKS;
164         }
165
166 int CRYPTO_get_new_dynlockid(void)
167         {
168         int i = 0;
169         CRYPTO_dynlock *pointer = NULL;
170
171         if (dynlock_create_callback == NULL)
172                 {
173                 CRYPTOerr(CRYPTO_F_CRYPTO_GET_NEW_DYNLOCKID,CRYPTO_R_NO_DYNLOCK_CREATE_CALLBACK);
174                 return(0);
175                 }
176         CRYPTO_w_lock(CRYPTO_LOCK_DYNLOCK);
177         if ((dyn_locks == NULL)
178                 && ((dyn_locks=sk_new_null()) == NULL))
179                 {
180                 CRYPTO_w_unlock(CRYPTO_LOCK_DYNLOCK);
181                 CRYPTOerr(CRYPTO_F_CRYPTO_GET_NEW_DYNLOCKID,ERR_R_MALLOC_FAILURE);
182                 return(0);
183                 }
184         CRYPTO_w_unlock(CRYPTO_LOCK_DYNLOCK);
185
186         pointer = (CRYPTO_dynlock *)OPENSSL_malloc(sizeof(CRYPTO_dynlock));
187         if (pointer == NULL)
188                 {
189                 CRYPTOerr(CRYPTO_F_CRYPTO_GET_NEW_DYNLOCKID,ERR_R_MALLOC_FAILURE);
190                 return(0);
191                 }
192         pointer->references = 1;
193         pointer->data = dynlock_create_callback(__FILE__,__LINE__);
194         if (pointer->data == NULL)
195                 {
196                 OPENSSL_free(pointer);
197                 CRYPTOerr(CRYPTO_F_CRYPTO_GET_NEW_DYNLOCKID,ERR_R_MALLOC_FAILURE);
198                 return(0);
199                 }
200
201         CRYPTO_w_lock(CRYPTO_LOCK_DYNLOCK);
202         i=sk_CRYPTO_dynlock_push(dyn_locks,pointer);
203         CRYPTO_w_unlock(CRYPTO_LOCK_DYNLOCK);
204
205         if (!i)
206                 {
207                 dynlock_destroy_callback(pointer->data,__FILE__,__LINE__);
208                 OPENSSL_free(pointer);
209                 }
210         else
211                 i += 1; /* to avoid 0 */
212         return -i;
213         }
214
215 void CRYPTO_destroy_dynlockid(int i)
216         {
217         CRYPTO_dynlock *pointer = NULL;
218         if (i)
219                 i = -i-1;
220         if (dynlock_destroy_callback == NULL)
221                 return;
222
223         CRYPTO_w_lock(CRYPTO_LOCK_DYNLOCK);
224
225         if (dyn_locks == NULL || i >= sk_CRYPTO_dynlock_num(dyn_locks))
226                 return;
227         pointer = sk_CRYPTO_dynlock_value(dyn_locks, i);
228         if (pointer != NULL)
229                 {
230                 --pointer->references;
231 #ifdef REF_CHECK
232                 if (pointer->references < 0)
233                         {
234                         fprintf(stderr,"CRYPTO_destroy_dynlockid, bad reference count\n");
235                         abort();
236                         }
237                 else
238 #endif
239                         if (--(pointer->references) <= 0)
240                                 {
241                                 sk_CRYPTO_dynlock_set(dyn_locks, i, NULL);
242                                 }
243                         else
244                                 pointer = NULL;
245                 }
246         CRYPTO_w_unlock(CRYPTO_LOCK_DYNLOCK);
247
248         if (pointer)
249                 {
250                 dynlock_destroy_callback(pointer->data,__FILE__,__LINE__);
251                 OPENSSL_free(pointer);
252                 }
253         }
254
255 struct CRYPTO_dynlock_value *CRYPTO_get_dynlock_value(int i)
256         {
257         CRYPTO_dynlock *pointer = NULL;
258         if (i)
259                 i = -i-1;
260
261         CRYPTO_w_lock(CRYPTO_LOCK_DYNLOCK);
262
263         if (dyn_locks != NULL && i < sk_CRYPTO_dynlock_num(dyn_locks))
264                 pointer = sk_CRYPTO_dynlock_value(dyn_locks, i);
265         if (pointer)
266                 pointer->references++;
267
268         CRYPTO_w_unlock(CRYPTO_LOCK_DYNLOCK);
269
270         if (pointer)
271                 return pointer->data;
272         return NULL;
273         }
274
275 void (*CRYPTO_get_locking_callback(void))(int mode,int type,const char *file,
276                 int line)
277         {
278         return(locking_callback);
279         }
280
281 void (*CRYPTO_get_dynlock_lock_callback(void))(int mode,
282         struct CRYPTO_dynlock_value *l, const char *file,int line)
283         {
284         return(dynlock_locking_callback);
285         }
286
287 int (*CRYPTO_get_add_lock_callback(void))(int *num,int mount,int type,
288                                           const char *file,int line)
289         {
290         return(add_lock_callback);
291         }
292
293 void CRYPTO_set_locking_callback(void (*func)(int mode,int type,
294                                               const char *file,int line))
295         {
296         locking_callback=func;
297         }
298
299 void CRYPTO_set_dynlock_locking_callback(void (*func)(int mode,
300         struct CRYPTO_dynlock_value *l, const char *file, int line))
301         {
302         dynlock_locking_callback=func;
303         }
304
305 void CRYPTO_set_add_lock_callback(int (*func)(int *num,int mount,int type,
306                                               const char *file,int line))
307         {
308         add_lock_callback=func;
309         }
310
311 unsigned long (*CRYPTO_get_id_callback(void))(void)
312         {
313         return(id_callback);
314         }
315
316 void CRYPTO_set_id_callback(unsigned long (*func)(void))
317         {
318         id_callback=func;
319         }
320
321 unsigned long CRYPTO_thread_id(void)
322         {
323         unsigned long ret=0;
324
325         if (id_callback == NULL)
326                 {
327 #ifdef WIN16
328                 ret=(unsigned long)GetCurrentTask();
329 #elif defined(WIN32)
330                 ret=(unsigned long)GetCurrentThreadId();
331 #elif defined(GETPID_IS_MEANINGLESS)
332                 ret=1L;
333 #else
334                 ret=(unsigned long)getpid();
335 #endif
336                 }
337         else
338                 ret=id_callback();
339         return(ret);
340         }
341
342 void CRYPTO_lock(int mode, int type, const char *file, int line)
343         {
344 #ifdef LOCK_DEBUG
345                 {
346                 char *rw_text,*operation_text;
347
348                 if (mode & CRYPTO_LOCK)
349                         operation_text="lock  ";
350                 else if (mode & CRYPTO_UNLOCK)
351                         operation_text="unlock";
352                 else
353                         operation_text="ERROR ";
354
355                 if (mode & CRYPTO_READ)
356                         rw_text="r";
357                 else if (mode & CRYPTO_WRITE)
358                         rw_text="w";
359                 else
360                         rw_text="ERROR";
361
362                 fprintf(stderr,"lock:%08lx:(%s)%s %-18s %s:%d\n",
363                         CRYPTO_thread_id(), rw_text, operation_text,
364                         CRYPTO_get_lock_name(type), file, line);
365                 }
366 #endif
367         if (type < 0)
368                 {
369                 int i = -type - 1;
370                 struct CRYPTO_dynlock_value *pointer
371                         = CRYPTO_get_dynlock_value(i);
372
373                 if (pointer)
374                         {
375                         dynlock_locking_callback(mode, pointer, file, line);
376                         }
377
378                 CRYPTO_destroy_dynlockid(i);
379                 }
380         else
381                 if (locking_callback != NULL)
382                         locking_callback(mode,type,file,line);
383         }
384
385 int CRYPTO_add_lock(int *pointer, int amount, int type, const char *file,
386              int line)
387         {
388         int ret = 0;
389
390         if (add_lock_callback != NULL)
391                 {
392 #ifdef LOCK_DEBUG
393                 int before= *pointer;
394 #endif
395
396                 ret=add_lock_callback(pointer,amount,type,file,line);
397 #ifdef LOCK_DEBUG
398                 fprintf(stderr,"ladd:%08lx:%2d+%2d->%2d %-18s %s:%d\n",
399                         CRYPTO_thread_id(),
400                         before,amount,ret,
401                         CRYPTO_get_lock_name(type),
402                         file,line);
403 #endif
404                 *pointer=ret;
405                 }
406         else
407                 {
408                 CRYPTO_lock(CRYPTO_LOCK|CRYPTO_WRITE,type,file,line);
409
410                 ret= *pointer+amount;
411 #ifdef LOCK_DEBUG
412                 fprintf(stderr,"ladd:%08lx:%2d+%2d->%2d %-18s %s:%d\n",
413                         CRYPTO_thread_id(),
414                         *pointer,amount,ret,
415                         CRYPTO_get_lock_name(type),
416                         file,line);
417 #endif
418                 *pointer=ret;
419                 CRYPTO_lock(CRYPTO_UNLOCK|CRYPTO_WRITE,type,file,line);
420                 }
421         return(ret);
422         }
423
424 const char *CRYPTO_get_lock_name(int type)
425         {
426         if (type < 0)
427                 return("dynamic");
428         else if (type < CRYPTO_NUM_LOCKS)
429                 return(lock_names[type]);
430         else if (type-CRYPTO_NUM_LOCKS >= sk_num(app_locks))
431                 return("ERROR");
432         else
433                 return(sk_value(app_locks,type-CRYPTO_NUM_LOCKS));
434         }
435
436 #ifdef _DLL
437 #ifdef WIN32
438
439 /* All we really need to do is remove the 'error' state when a thread
440  * detaches */
441
442 BOOL WINAPI DLLEntryPoint(HINSTANCE hinstDLL, DWORD fdwReason,
443              LPVOID lpvReserved)
444         {
445         switch(fdwReason)
446                 {
447         case DLL_PROCESS_ATTACH:
448                 break;
449         case DLL_THREAD_ATTACH:
450                 break;
451         case DLL_THREAD_DETACH:
452                 ERR_remove_state(0);
453                 break;
454         case DLL_PROCESS_DETACH:
455                 break;
456                 }
457         return(TRUE);
458         }
459 #endif
460
461 #endif