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.]
62 #include <openssl/crypto.h>
63 #include <openssl/buffer.h>
64 #include <openssl/bio.h>
65 #include <openssl/lhash.h>
68 static int mh_mode=CRYPTO_MEM_CHECK_OFF;
69 /* The state changes to CRYPTO_MEM_CHECK_ON | CRYPTO_MEM_CHECK_ENABLE
70 * when the application asks for it (usually after library initialisation
71 * for which no book-keeping is desired).
73 * State CRYPTO_MEM_CHECK_ON exists only temporarily when the library
74 * thinks that certain allocations should not be checked (e.g. the data
75 * structures used for memory checking). It is not suitable as an initial
76 * state: the library will unexpectedly enable memory checking when it
77 * executes one of those sections that want to disable checking
80 * State CRYPTO_MEM_CHECK_ENABLE without ..._ON makes no sense whatsoever.
83 static unsigned long order = 0; /* number of memory requests */
84 static LHASH *mh=NULL; /* hash-table of memory requests (address as key) */
87 typedef struct app_mem_info_st
88 /* For application-defined information (static C-string `info')
89 * to be displayed in memory leak list.
90 * Each thread has its own stack. For applications, there is
91 * CRYPTO_push_info("...") to push an entry,
92 * CRYPTO_pop_info() to pop an entry,
93 * CRYPTO_remove_all_info() to pop all entries.
100 struct app_mem_info_st *next; /* tail of thread's stack */
104 static LHASH *amih=NULL; /* hash-table with those app_mem_info_st's
105 * that are at the top of their thread's stack
106 * (with `thread' as key) */
108 typedef struct mem_st
109 /* memory-block description */
115 unsigned long thread;
121 static long options = /* extra information to be recorded */
122 #if defined(CRYPTO_MDEBUG_TIME) || defined(CRYPTO_MDEBUG_ALL)
123 V_CRYPTO_MDEBUG_TIME |
125 #if defined(CRYPTO_MDEBUG_THREAD) || defined(CRYPTO_MDEBUG_ALL)
126 V_CRYPTO_MDEBUG_THREAD |
131 static unsigned long disabling_thread = 0;
133 int CRYPTO_mem_ctrl(int mode)
137 CRYPTO_w_lock(CRYPTO_LOCK_MALLOC);
140 /* for applications: */
141 case CRYPTO_MEM_CHECK_ON: /* aka MemCheck_start() */
142 mh_mode = CRYPTO_MEM_CHECK_ON|CRYPTO_MEM_CHECK_ENABLE;
143 disabling_thread = 0;
145 case CRYPTO_MEM_CHECK_OFF: /* aka MemCheck_stop() */
147 disabling_thread = 0;
150 /* switch off temporarily (for library-internal use): */
151 case CRYPTO_MEM_CHECK_DISABLE: /* aka MemCheck_off() */
152 if (mh_mode & CRYPTO_MEM_CHECK_ON)
154 mh_mode&= ~CRYPTO_MEM_CHECK_ENABLE;
155 if (disabling_thread != CRYPTO_thread_id()) /* otherwise we already have the MALLOC2 lock */
157 /* Long-time lock CRYPTO_LOCK_MALLOC2 must not be claimed while
158 * we're holding CRYPTO_LOCK_MALLOC, or we'll deadlock if
159 * somebody else holds CRYPTO_LOCK_MALLOC2 (and cannot release
160 * it because we block entry to this function).
161 * Give them a chance, first, and then claim the locks in
162 * appropriate order (long-time lock first).
164 CRYPTO_w_unlock(CRYPTO_LOCK_MALLOC);
165 /* Note that after we have waited for CRYPTO_LOCK_MALLOC2
166 * and CRYPTO_LOCK_MALLOC, we'll still be in the right
167 * "case" and "if" branch because MemCheck_start and
168 * MemCheck_stop may never be used while there are multiple
169 * OpenSSL threads. */
170 CRYPTO_w_lock(CRYPTO_LOCK_MALLOC2);
171 CRYPTO_w_lock(CRYPTO_LOCK_MALLOC);
172 disabling_thread=CRYPTO_thread_id();
176 case CRYPTO_MEM_CHECK_ENABLE: /* aka MemCheck_on() */
177 if (mh_mode & CRYPTO_MEM_CHECK_ON)
179 mh_mode|=CRYPTO_MEM_CHECK_ENABLE;
180 if (disabling_thread != 0)
183 CRYPTO_w_unlock(CRYPTO_LOCK_MALLOC2);
191 CRYPTO_w_unlock(CRYPTO_LOCK_MALLOC);
195 int CRYPTO_is_mem_check_on(void)
199 if (mh_mode & CRYPTO_MEM_CHECK_ON)
201 CRYPTO_w_lock(CRYPTO_LOCK_MALLOC);
203 ret = (mh_mode & CRYPTO_MEM_CHECK_ENABLE)
204 && disabling_thread != CRYPTO_thread_id();
206 CRYPTO_w_unlock(CRYPTO_LOCK_MALLOC);
212 void CRYPTO_dbg_set_options(long bits)
217 long CRYPTO_dbg_get_options()
222 static int mem_cmp(MEM *a, MEM *b)
224 return(a->addr - b->addr);
227 static unsigned long mem_hash(MEM *a)
231 ret=(unsigned long)a->addr;
233 ret=ret*17851+(ret>>14)*7+(ret>>4)*251;
237 static int app_info_cmp(APP_INFO *a, APP_INFO *b)
239 return(a->thread != b->thread);
242 static unsigned long app_info_hash(APP_INFO *a)
246 ret=(unsigned long)a->thread;
248 ret=ret*17851+(ret>>14)*7+(ret>>4)*251;
252 static APP_INFO *pop_info()
255 APP_INFO *ret = NULL;
259 tmp.thread=CRYPTO_thread_id();
260 if ((ret=(APP_INFO *)lh_delete(amih,(char *)&tmp)) != NULL)
262 APP_INFO *next=ret->next;
267 lh_insert(amih,(char *)next);
270 if (ret->thread != tmp.thread)
272 fprintf(stderr, "pop_info(): deleted info has other thread ID (%lu) than the current thread (%lu)!!!!\n",
273 ret->thread, tmp.thread);
277 if (--(ret->references) <= 0)
289 int CRYPTO_push_info_(const char *info, const char *file, int line)
291 APP_INFO *ami, *amim;
294 if (is_MemCheck_on())
296 MemCheck_off(); /* obtains CRYPTO_LOCK_MALLOC2 */
298 if ((ami = (APP_INFO *)Malloc(sizeof(APP_INFO))) == NULL)
305 if ((amih=lh_new(app_info_hash,app_info_cmp)) == NULL)
313 ami->thread=CRYPTO_thread_id();
320 if ((amim=(APP_INFO *)lh_insert(amih,(char *)ami)) != NULL)
323 if (ami->thread != amim->thread)
325 fprintf(stderr, "CRYPTO_push_info(): previous info has other thread ID (%lu) than the current thread (%lu)!!!!\n",
326 amim->thread, ami->thread);
333 MemCheck_on(); /* releases CRYPTO_LOCK_MALLOC2 */
339 int CRYPTO_pop_info(void)
343 if (is_MemCheck_on()) /* _must_ be true, or something went severely wrong */
345 MemCheck_off(); /* obtains CRYPTO_LOCK_MALLOC2 */
347 ret=(pop_info() != NULL);
349 MemCheck_on(); /* releases CRYPTO_LOCK_MALLOC2 */
354 int CRYPTO_remove_all_info(void)
358 if (is_MemCheck_on()) /* _must_ be true */
360 MemCheck_off(); /* obtains CRYPTO_LOCK_MALLOC2 */
362 while(pop_info() != NULL)
365 MemCheck_on(); /* releases CRYPTO_LOCK_MALLOC2 */
371 static unsigned long break_order_num=0;
372 void CRYPTO_dbg_malloc(void *addr, int num, const char *file, int line,
378 switch(before_p & 127)
386 if (is_MemCheck_on())
388 MemCheck_off(); /* obtains CRYPTO_LOCK_MALLOC2 */
389 if ((m=(MEM *)Malloc(sizeof(MEM))) == NULL)
392 MemCheck_on(); /* releases CRYPTO_LOCK_MALLOC2 */
397 if ((mh=lh_new(mem_hash,mem_cmp)) == NULL)
410 if (options & V_CRYPTO_MDEBUG_THREAD)
411 m->thread=CRYPTO_thread_id();
415 if (order == break_order_num)
422 fprintf(stderr, "LEVITTE_DEBUG: [%5d] %c 0x%p (%d)\n",
424 (before_p & 128) ? '*' : '+',
427 if (options & V_CRYPTO_MDEBUG_TIME)
432 tmp.thread=CRYPTO_thread_id();
435 && (amim=(APP_INFO *)lh_retrieve(amih,(char *)&tmp)) != NULL)
441 if ((mm=(MEM *)lh_insert(mh,(char *)m)) != NULL)
443 /* Not good, but don't sweat it */
444 if (mm->app_info != NULL)
446 mm->app_info->references--;
451 MemCheck_on(); /* releases CRYPTO_LOCK_MALLOC2 */
458 void CRYPTO_dbg_free(void *addr, int before_p)
468 if (is_MemCheck_on() && (mh != NULL))
473 mp=(MEM *)lh_delete(mh,(char *)&m);
477 fprintf(stderr, "LEVITTE_DEBUG: [%5d] - 0x%p (%d)\n",
478 mp->order, mp->addr, mp->num);
480 if (mp->app_info != NULL)
482 mp->app_info->references--;
487 MemCheck_on(); /* releases CRYPTO_LOCK_MALLOC2 */
495 void CRYPTO_dbg_realloc(void *addr1, void *addr2, int num,
496 const char *file, int line, int before_p)
501 fprintf(stderr, "LEVITTE_DEBUG: --> CRYPTO_dbg_malloc(addr1 = %p, addr2 = %p, num = %d, file = \"%s\", line = %d, before_p = %d)\n",
502 addr1, addr2, num, file, line, before_p);
515 CRYPTO_dbg_malloc(addr2, num, file, line, 128 | before_p);
519 if (is_MemCheck_on())
521 MemCheck_off(); /* obtains CRYPTO_LOCK_MALLOC2 */
524 mp=(MEM *)lh_delete(mh,(char *)&m);
528 fprintf(stderr, "LEVITTE_DEBUG: [%5d] * 0x%p (%d) -> 0x%p (%d)\n",
535 lh_insert(mh,(char *)mp);
538 MemCheck_on(); /* releases CRYPTO_LOCK_MALLOC2 */
546 typedef struct mem_leak_st
553 static void print_leak(MEM *m, MEM_LEAK *l)
559 struct tm *lcl = NULL;
562 if(m->addr == (char *)l->bio)
565 if (options & V_CRYPTO_MDEBUG_TIME)
567 lcl = localtime(&m->time);
569 sprintf(bufp, "[%02d:%02d:%02d] ",
570 lcl->tm_hour,lcl->tm_min,lcl->tm_sec);
571 bufp += strlen(bufp);
574 sprintf(bufp, "%5lu file=%s, line=%d, ",
575 m->order,m->file,m->line);
576 bufp += strlen(bufp);
578 if (options & V_CRYPTO_MDEBUG_THREAD)
580 sprintf(bufp, "thread=%lu, ", m->thread);
581 bufp += strlen(bufp);
584 sprintf(bufp, "number=%d, address=%08lX\n",
585 m->num,(unsigned long)m->addr);
586 bufp += strlen(bufp);
588 BIO_puts(l->bio,buf);
605 memset(buf,'>',ami_cnt);
606 sprintf(buf + ami_cnt,
607 " thread=%lu, file=%s, line=%d, info=\"",
608 amip->thread, amip->file, amip->line);
610 info_len=strlen(amip->info);
611 if (128 - buf_len - 3 < info_len)
613 memcpy(buf + buf_len, amip->info, 128 - buf_len - 3);
618 strcpy(buf + buf_len, amip->info);
619 buf_len = strlen(buf);
621 sprintf(buf + buf_len, "\"\n");
623 BIO_puts(l->bio,buf);
627 while(amip && amip->thread == ti);
632 fprintf(stderr, "Thread switch detected i backtrace!!!!\n");
638 void CRYPTO_mem_leaks(BIO *b)
643 if (mh == NULL) return;
647 CRYPTO_w_lock(CRYPTO_LOCK_MALLOC2);
648 lh_doall_arg(mh,(void (*)())print_leak,(char *)&ml);
649 CRYPTO_w_unlock(CRYPTO_LOCK_MALLOC2);
652 sprintf(buf,"%ld bytes leaked in %d chunks\n",
659 lh_node_stats_bio(mh,b);
660 lh_node_usage_stats_bio(mh,b);
664 static void (*mem_cb)()=NULL;
666 static void cb_leak(MEM *m, char *cb)
668 void (*mem_callback)()=(void (*)())cb;
669 mem_callback(m->order,m->file,m->line,m->num,m->addr);
672 void CRYPTO_mem_leaks_cb(void (*cb)())
674 if (mh == NULL) return;
675 CRYPTO_w_lock(CRYPTO_LOCK_MALLOC2);
677 lh_doall_arg(mh,(void (*)())cb_leak,(char *)mem_cb);
679 CRYPTO_w_unlock(CRYPTO_LOCK_MALLOC2);
683 void CRYPTO_mem_leaks_fp(FILE *fp)
687 if (mh == NULL) return;
688 if ((b=BIO_new(BIO_s_file())) == NULL)
690 BIO_set_fp(b,fp,BIO_NOCLOSE);