2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
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.
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).
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.
23 * Redistribution and use in source and binary forms, with or without
24 * modification, are permitted provided that the following conditions
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)"
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
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.]
61 #include <openssl/crypto.h>
62 #ifdef CRYPTO_MDEBUG_TIME
65 #include <openssl/buffer.h>
66 #include <openssl/bio.h>
67 #include <openssl/lhash.h>
70 /* #ifdef CRYPTO_MDEBUG */
71 /* static int mh_mode=CRYPTO_MEM_CHECK_ON; */
73 static int mh_mode=CRYPTO_MEM_CHECK_OFF;
74 static unsigned long disabling_thread = 0;
76 /* State CRYPTO_MEM_CHECK_ON exists only temporarily when the library
77 * thinks that certain allocations should not be checked (e.g. the data
78 * structures used for memory checking). It is not suitable as an initial
79 * state: the library will unexpectedly enable memory checking when it
80 * executes one of those sections that want to disable checking
83 * State CRYPTO_MEM_CHECK_ENABLE without ..._ON makes no sense whatsoever.
86 static unsigned long order=0;
88 static LHASH *amih=NULL;
90 typedef struct app_mem_info_st
96 struct app_mem_info_st *next;
100 static LHASH *mh=NULL;
102 typedef struct mem_st
108 #ifdef CRYPTO_MDEBUG_THREAD
109 unsigned long thread;
112 #ifdef CRYPTO_MDEBUG_TIME
118 int CRYPTO_mem_ctrl(int mode)
122 CRYPTO_w_lock(CRYPTO_LOCK_MALLOC);
125 /* for applications: */
126 case CRYPTO_MEM_CHECK_ON: /* aka MemCheck_start() */
127 mh_mode = CRYPTO_MEM_CHECK_ON|CRYPTO_MEM_CHECK_ENABLE;
128 disabling_thread = 0;
130 case CRYPTO_MEM_CHECK_OFF: /* aka MemCheck_stop() */
132 disabling_thread = 0;
135 /* switch off temporarily (for library-internal use): */
136 case CRYPTO_MEM_CHECK_DISABLE: /* aka MemCheck_off() */
137 if (mh_mode & CRYPTO_MEM_CHECK_ON)
139 mh_mode&= ~CRYPTO_MEM_CHECK_ENABLE;
140 if (disabling_thread != CRYPTO_thread_id()) /* otherwise we already have the MALLOC2 lock */
142 /* Long-time lock CRYPTO_LOCK_MALLOC2 must not be claimed while
143 * we're holding CRYPTO_LOCK_MALLOC, or we'll deadlock if
144 * somebody else holds CRYPTO_LOCK_MALLOC2 (and cannot release it
145 * because we block entry to this function).
146 * Give them a chance, first, and then claim the locks in
147 * appropriate order (long-time lock first).
149 CRYPTO_w_unlock(CRYPTO_LOCK_MALLOC);
150 /* Note that after we have waited for CRYPTO_LOCK_MALLOC2
151 * and CRYPTO_LOCK_MALLOC, we'll still be in the right
152 * "case" and "if" branch because MemCheck_start and
153 * MemCheck_stop may never be used while there are multiple
154 * OpenSSL threads. */
155 CRYPTO_w_lock(CRYPTO_LOCK_MALLOC2);
156 CRYPTO_w_lock(CRYPTO_LOCK_MALLOC);
157 disabling_thread=CRYPTO_thread_id();
161 case CRYPTO_MEM_CHECK_ENABLE: /* aka MemCheck_on() */
162 if (mh_mode & CRYPTO_MEM_CHECK_ON)
164 mh_mode|=CRYPTO_MEM_CHECK_ENABLE;
165 if (disabling_thread != 0)
168 CRYPTO_w_unlock(CRYPTO_LOCK_MALLOC2);
176 CRYPTO_w_unlock(CRYPTO_LOCK_MALLOC);
180 static int is_MemCheck_On()
184 if (mh_mode & CRYPTO_MEM_CHECK_ON)
186 CRYPTO_w_lock(CRYPTO_LOCK_MALLOC);
188 ret = (mh_mode & CRYPTO_MEM_CHECK_ENABLE)
189 && disabling_thread != CRYPTO_thread_id();
191 CRYPTO_w_unlock(CRYPTO_LOCK_MALLOC);
196 static int mem_cmp(MEM *a, MEM *b)
198 return(a->addr - b->addr);
201 static unsigned long mem_hash(MEM *a)
205 ret=(unsigned long)a->addr;
207 ret=ret*17851+(ret>>14)*7+(ret>>4)*251;
211 static int app_info_cmp(APP_INFO *a, APP_INFO *b)
213 return(a->thread - b->thread);
216 static unsigned long app_info_hash(APP_INFO *a)
220 ret=(unsigned long)a->thread;
222 ret=ret*17851+(ret>>14)*7+(ret>>4)*251;
226 static APP_INFO *free_info(APP_INFO *app_info)
230 if (app_info == NULL)
233 if (--(app_info->references) > 0)
236 app_info->references = 0;
238 next = app_info->next;
239 app_info->next = NULL; /* Just to make sure */
242 if (next != app_info)
243 return free_info(next);
247 static APP_INFO *remove_info()
250 APP_INFO *ret = NULL;
254 tmp.thread=CRYPTO_thread_id();
255 if ((ret=(APP_INFO *)lh_delete(amih,(char *)&tmp)) != NULL)
257 APP_INFO *next=ret->next;
259 if (ret->thread != tmp.thread)
261 fprintf(stderr, "remove_info(): deleted info has other thread ID (%lu) than the current thread (%lu)!!!!\n",
262 ret->thread, tmp.thread);
268 lh_insert(amih,(char *)next);
276 int CRYPTO_add_info(const char *file, int line, const char *info)
278 APP_INFO *ami, *amim;
281 if (is_MemCheck_On())
285 if ((ami = (APP_INFO *)Malloc(sizeof(APP_INFO))) == NULL)
292 if ((amih=lh_new(app_info_hash,app_info_cmp)) == NULL)
300 ami->thread=CRYPTO_thread_id();
307 if ((amim=(APP_INFO *)lh_insert(amih,(char *)ami)) != NULL)
310 if (ami->thread != amim->thread)
312 fprintf(stderr, "CRYPTO_add_info(): previous info has other thread ID (%lu) than the current thread (%lu)!!!!\n",
313 amim->thread, ami->thread);
326 int CRYPTO_remove_info()
330 if (is_MemCheck_On())
334 ret=(remove_info() != NULL);
341 static char *(*malloc_locked_func)()=(char *(*)())malloc;
342 static void (*free_locked_func)()=(void (*)())free;
343 static char *(*malloc_func)()= (char *(*)())malloc;
344 static char *(*realloc_func)()= (char *(*)())realloc;
345 static void (*free_func)()= (void (*)())free;
347 void CRYPTO_set_mem_functions(char *(*m)(), char *(*r)(), void (*f)())
349 if ((m == NULL) || (r == NULL) || (f == NULL)) return;
353 malloc_locked_func=m;
357 void CRYPTO_set_locked_mem_functions(char *(*m)(), void (*f)())
359 if ((m == NULL) || (f == NULL)) return;
360 malloc_locked_func=m;
364 void CRYPTO_get_mem_functions(char *(**m)(), char *(**r)(), void (**f)())
366 if (m != NULL) *m=malloc_func;
367 if (r != NULL) *r=realloc_func;
368 if (f != NULL) *f=free_func;
371 void CRYPTO_get_locked_mem_functions(char *(**m)(), void (**f)())
373 if (m != NULL) *m=malloc_locked_func;
374 if (f != NULL) *f=free_locked_func;
377 void *CRYPTO_malloc_locked(int num)
379 return(malloc_locked_func(num));
382 void CRYPTO_free_locked(void *str)
384 free_locked_func(str);
387 void *CRYPTO_malloc(int num)
389 return(malloc_func(num));
392 void *CRYPTO_realloc(void *str, int num)
394 return(realloc_func(str,num));
397 void CRYPTO_free(void *str)
402 static unsigned long break_order_num=0;
403 void *CRYPTO_dbg_malloc(int num, const char *file, int line)
409 if ((ret=malloc_func(num)) == NULL)
412 if (is_MemCheck_On())
415 if ((m=(MEM *)Malloc(sizeof(MEM))) == NULL)
423 if ((mh=lh_new(mem_hash,mem_cmp)) == NULL)
436 #ifdef CRYPTO_MDEBUG_THREAD
437 m->thread=CRYPTO_thread_id();
439 if (order == break_order_num)
445 #ifdef CRYPTO_MDEBUG_TIME
449 tmp.thread=CRYPTO_thread_id();
452 && (amim=(APP_INFO *)lh_retrieve(amih,(char *)&tmp)) != NULL)
458 if ((mm=(MEM *)lh_insert(mh,(char *)m)) != NULL)
460 /* Not good, but don't sweat it */
461 if (mm->app_info != NULL)
463 mm->app_info->references--;
473 void CRYPTO_dbg_free(void *addr)
477 if (is_MemCheck_On() && (mh != NULL))
482 mp=(MEM *)lh_delete(mh,(char *)&m);
485 if (mp->app_info != NULL)
487 mp->app_info->references--;
497 void *CRYPTO_dbg_realloc(void *addr, int num, const char *file, int line)
502 ret=realloc_func(addr,num);
503 if (ret == addr) return(ret);
505 if (is_MemCheck_On())
507 if (ret == NULL) return(NULL);
512 mp=(MEM *)lh_delete(mh,(char *)&m);
516 lh_insert(mh,(char *)mp);
524 void *CRYPTO_remalloc(void *a, int n)
526 if (a != NULL) Free(a);
531 void *CRYPTO_dbg_remalloc(void *a, int n, const char *file, int line)
533 if (a != NULL) CRYPTO_dbg_free(a);
534 a=(char *)CRYPTO_dbg_malloc(n,file,line);
539 typedef struct mem_leak_st
546 static void print_leak(MEM *m, MEM_LEAK *l)
551 #ifdef CRYPTO_MDEBUG_TIME
556 if(m->addr == (char *)l->bio)
559 #ifdef CRYPTO_MDEBUG_TIME
560 lcl = localtime(&m->time);
564 #ifdef CRYPTO_MDEBUG_TIME
567 "%5lu file=%s, line=%d, "
568 #ifdef CRYPTO_MDEBUG_THREAD
571 "number=%d, address=%08lX\n",
572 #ifdef CRYPTO_MDEBUG_TIME
573 lcl->tm_hour,lcl->tm_min,lcl->tm_sec,
575 m->order,m->file,m->line,
576 #ifdef CRYPTO_MDEBUG_THREAD
579 m->num,(unsigned long)m->addr);
581 BIO_puts(l->bio,buf);
590 while(amip && amip->thread == ti)
596 memset(buf,'>',ami_cnt);
597 sprintf(buf + ami_cnt,
598 "thread=%lu, file=%s, line=%d, info=\"",
599 amip->thread, amip->file, amip->line);
601 info_len=strlen(amip->info);
602 if (128 - buf_len - 3 < info_len)
604 memcpy(buf + buf_len, amip->info, 128 - buf_len - 3);
609 strcpy(buf + buf_len, amip->info);
610 buf_len = strlen(buf);
612 sprintf(buf + buf_len, "\"\n");
614 BIO_puts(l->bio,buf);
621 fprintf(stderr, "Thread switch detected i backtrace!!!!\n");
627 void CRYPTO_mem_leaks(BIO *b)
632 if (mh == NULL) return;
636 CRYPTO_w_lock(CRYPTO_LOCK_MALLOC2);
637 lh_doall_arg(mh,(void (*)())print_leak,(char *)&ml);
638 CRYPTO_w_unlock(CRYPTO_LOCK_MALLOC2);
641 sprintf(buf,"%ld bytes leaked in %d chunks\n",
648 lh_node_stats_bio(mh,b);
649 lh_node_usage_stats_bio(mh,b);
653 static void (*mem_cb)()=NULL;
655 static void cb_leak(MEM *m, char *cb)
657 void (*mem_callback)()=(void (*)())cb;
658 mem_callback(m->order,m->file,m->line,m->num,m->addr);
661 void CRYPTO_mem_leaks_cb(void (*cb)())
663 if (mh == NULL) return;
664 CRYPTO_w_lock(CRYPTO_LOCK_MALLOC2);
666 lh_doall_arg(mh,(void (*)())cb_leak,(char *)mem_cb);
668 CRYPTO_w_unlock(CRYPTO_LOCK_MALLOC2);
672 void CRYPTO_mem_leaks_fp(FILE *fp)
676 if (mh == NULL) return;
677 if ((b=BIO_new(BIO_s_file())) == NULL)
679 BIO_set_fp(b,fp,BIO_NOCLOSE);