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 /* State CRYPTO_MEM_CHECK_ON exists only temporarily when the library
69 * thinks that certain allocations should not be checked (e.g. the data
70 * structures used for memory checking). It is not suitable as an initial
71 * state: the library will unexpectedly enable memory checking when it
72 * executes one of those sections that want to disable checking
75 * State CRYPTO_MEM_CHECK_ENABLE without ..._ON makes no sense whatsoever.
77 static int mh_mode=CRYPTO_MEM_CHECK_OFF;
78 static unsigned long disabling_thread = 0;
81 static unsigned long order=0;
83 static LHASH *amih=NULL;
85 typedef struct app_mem_info_st
91 struct app_mem_info_st *next;
95 static LHASH *mh=NULL;
103 unsigned long thread;
110 #ifdef CRYPTO_MDEBUG_ALL
111 # ifndef CRYPTO_MDEBUG_TIME
112 # define CRYPTO_MDEBUG_TIME
114 # ifndef CRYPTO_MDEBUG_THREAD
115 # define CRYPTO_MDEBUG_THREAD
119 /* Get defaults that will depend on some macros defined elsewhere */
120 #ifdef CRYPTO_MDEBUG_TIME
121 #define DEF_V_CRYPTO_MDEBUG_TIME V_CRYPTO_MDEBUG_TIME
123 #define DEF_V_CRYPTO_MDEBUG_TIME 0
125 #ifdef CRYPTO_MDEBUG_THREAD
126 #define DEF_V_CRYPTO_MDEBUG_THREAD V_CRYPTO_MDEBUG_THREAD
128 #define DEF_V_CRYPTO_MDEBUG_THREAD 0
131 static int options = DEF_V_CRYPTO_MDEBUG_TIME | DEF_V_CRYPTO_MDEBUG_THREAD;
134 int CRYPTO_mem_ctrl(int mode)
138 CRYPTO_w_lock(CRYPTO_LOCK_MALLOC);
141 /* for applications: */
142 case CRYPTO_MEM_CHECK_ON: /* aka MemCheck_start() */
143 mh_mode = CRYPTO_MEM_CHECK_ON|CRYPTO_MEM_CHECK_ENABLE;
144 disabling_thread = 0;
146 case CRYPTO_MEM_CHECK_OFF: /* aka MemCheck_stop() */
148 disabling_thread = 0;
151 /* switch off temporarily (for library-internal use): */
152 case CRYPTO_MEM_CHECK_DISABLE: /* aka MemCheck_off() */
153 if (mh_mode & CRYPTO_MEM_CHECK_ON)
155 mh_mode&= ~CRYPTO_MEM_CHECK_ENABLE;
156 if (disabling_thread != CRYPTO_thread_id()) /* otherwise we already have the MALLOC2 lock */
158 /* Long-time lock CRYPTO_LOCK_MALLOC2 must not be claimed while
159 * we're holding CRYPTO_LOCK_MALLOC, or we'll deadlock if
160 * somebody else holds CRYPTO_LOCK_MALLOC2 (and cannot release it
161 * because we block entry to this function).
162 * Give them a chance, first, and then claim the locks in
163 * appropriate order (long-time lock first).
165 CRYPTO_w_unlock(CRYPTO_LOCK_MALLOC);
166 /* Note that after we have waited for CRYPTO_LOCK_MALLOC2
167 * and CRYPTO_LOCK_MALLOC, we'll still be in the right
168 * "case" and "if" branch because MemCheck_start and
169 * MemCheck_stop may never be used while there are multiple
170 * OpenSSL threads. */
171 CRYPTO_w_lock(CRYPTO_LOCK_MALLOC2);
172 CRYPTO_w_lock(CRYPTO_LOCK_MALLOC);
173 disabling_thread=CRYPTO_thread_id();
177 case CRYPTO_MEM_CHECK_ENABLE: /* aka MemCheck_on() */
178 if (mh_mode & CRYPTO_MEM_CHECK_ON)
180 mh_mode|=CRYPTO_MEM_CHECK_ENABLE;
181 if (disabling_thread != 0)
184 CRYPTO_w_unlock(CRYPTO_LOCK_MALLOC2);
192 CRYPTO_w_unlock(CRYPTO_LOCK_MALLOC);
196 int CRYPTO_mem_check_on(void)
200 if (mh_mode & CRYPTO_MEM_CHECK_ON)
202 CRYPTO_w_lock(CRYPTO_LOCK_MALLOC);
204 ret = (mh_mode & CRYPTO_MEM_CHECK_ENABLE)
205 && disabling_thread != CRYPTO_thread_id();
207 CRYPTO_w_unlock(CRYPTO_LOCK_MALLOC);
213 void CRYPTO_dbg_set_options(int bits)
218 int CRYPTO_dbg_get_options()
223 static int mem_cmp(MEM *a, MEM *b)
225 return(a->addr - b->addr);
228 static unsigned long mem_hash(MEM *a)
232 ret=(unsigned long)a->addr;
234 ret=ret*17851+(ret>>14)*7+(ret>>4)*251;
238 static int app_info_cmp(APP_INFO *a, APP_INFO *b)
240 return(a->thread - b->thread);
243 static unsigned long app_info_hash(APP_INFO *a)
247 ret=(unsigned long)a->thread;
249 ret=ret*17851+(ret>>14)*7+(ret>>4)*251;
253 static APP_INFO *remove_info()
256 APP_INFO *ret = NULL;
260 tmp.thread=CRYPTO_thread_id();
261 if ((ret=(APP_INFO *)lh_delete(amih,(char *)&tmp)) != NULL)
263 APP_INFO *next=ret->next;
268 lh_insert(amih,(char *)next);
271 if (ret->thread != tmp.thread)
273 fprintf(stderr, "remove_info(): deleted info has other thread ID (%lu) than the current thread (%lu)!!!!\n",
274 ret->thread, tmp.thread);
278 if (--(ret->references) <= 0)
290 int CRYPTO_add_info(const char *file, int line, const char *info)
292 APP_INFO *ami, *amim;
295 if (is_MemCheck_on())
299 if ((ami = (APP_INFO *)Malloc(sizeof(APP_INFO))) == NULL)
306 if ((amih=lh_new(app_info_hash,app_info_cmp)) == NULL)
314 ami->thread=CRYPTO_thread_id();
321 if ((amim=(APP_INFO *)lh_insert(amih,(char *)ami)) != NULL)
324 if (ami->thread != amim->thread)
326 fprintf(stderr, "CRYPTO_add_info(): previous info has other thread ID (%lu) than the current thread (%lu)!!!!\n",
327 amim->thread, ami->thread);
340 int CRYPTO_remove_info(void)
344 if (is_MemCheck_on())
348 ret=(remove_info() != NULL);
355 int CRYPTO_remove_all_info(void)
359 if (is_MemCheck_on())
363 while(remove_info() != NULL)
372 static unsigned long break_order_num=0;
373 void CRYPTO_dbg_malloc(void *addr, int num, const char *file, int line,
379 switch(before_p & 127)
387 if (is_MemCheck_on())
390 if ((m=(MEM *)Malloc(sizeof(MEM))) == NULL)
398 if ((mh=lh_new(mem_hash,mem_cmp)) == NULL)
411 if (options & V_CRYPTO_MDEBUG_THREAD)
412 m->thread=CRYPTO_thread_id();
416 if (order == break_order_num)
423 fprintf(stderr, "LEVITTE_DEBUG: [%5d] %c 0x%p (%d)\n",
425 (before_p & 128) ? '*' : '+',
428 if (options & V_CRYPTO_MDEBUG_TIME)
433 tmp.thread=CRYPTO_thread_id();
436 && (amim=(APP_INFO *)lh_retrieve(amih,(char *)&tmp)) != NULL)
442 if ((mm=(MEM *)lh_insert(mh,(char *)m)) != NULL)
444 /* Not good, but don't sweat it */
445 if (mm->app_info != NULL)
447 mm->app_info->references--;
459 void CRYPTO_dbg_free(void *addr, int before_p)
469 if (is_MemCheck_on() && (mh != NULL))
474 mp=(MEM *)lh_delete(mh,(char *)&m);
478 fprintf(stderr, "LEVITTE_DEBUG: [%5d] - 0x%p (%d)\n",
479 mp->order, mp->addr, mp->num);
481 if (mp->app_info != NULL)
483 mp->app_info->references--;
496 void CRYPTO_dbg_realloc(void *addr1, void *addr2, int num,
497 const char *file, int line, int before_p)
502 fprintf(stderr, "LEVITTE_DEBUG: --> CRYPTO_dbg_malloc(addr1 = %p, addr2 = %p, num = %d, file = \"%s\", line = %d, before_p = %d)\n",
503 addr1, addr2, num, file, line, before_p);
516 CRYPTO_dbg_malloc(addr2, num, file, line, 128 | before_p);
520 if (is_MemCheck_on())
525 mp=(MEM *)lh_delete(mh,(char *)&m);
529 fprintf(stderr, "LEVITTE_DEBUG: [%5d] * 0x%p (%d) -> 0x%p (%d)\n",
536 lh_insert(mh,(char *)mp);
547 typedef struct mem_leak_st
554 static void print_leak(MEM *m, MEM_LEAK *l)
560 struct tm *lcl = NULL;
563 if(m->addr == (char *)l->bio)
566 if (options & V_CRYPTO_MDEBUG_TIME)
568 lcl = localtime(&m->time);
570 sprintf(bufp, "[%02d:%02d:%02d] ",
571 lcl->tm_hour,lcl->tm_min,lcl->tm_sec);
572 bufp += strlen(bufp);
575 sprintf(bufp, "%5lu file=%s, line=%d, ",
576 m->order,m->file,m->line);
577 bufp += strlen(bufp);
579 if (options & V_CRYPTO_MDEBUG_THREAD)
581 sprintf(bufp, "thread=%lu, ", m->thread);
582 bufp += strlen(bufp);
585 sprintf(bufp, "number=%d, address=%08lX\n",
586 m->num,(unsigned long)m->addr);
587 bufp += strlen(bufp);
589 BIO_puts(l->bio,buf);
598 while(amip && amip->thread == ti)
604 memset(buf,'>',ami_cnt);
605 sprintf(buf + ami_cnt,
606 "thread=%lu, file=%s, line=%d, info=\"",
607 amip->thread, amip->file, amip->line);
609 info_len=strlen(amip->info);
610 if (128 - buf_len - 3 < info_len)
612 memcpy(buf + buf_len, amip->info, 128 - buf_len - 3);
617 strcpy(buf + buf_len, amip->info);
618 buf_len = strlen(buf);
620 sprintf(buf + buf_len, "\"\n");
622 BIO_puts(l->bio,buf);
629 fprintf(stderr, "Thread switch detected i backtrace!!!!\n");
635 void CRYPTO_mem_leaks(BIO *b)
640 if (mh == NULL) return;
644 CRYPTO_w_lock(CRYPTO_LOCK_MALLOC2);
645 lh_doall_arg(mh,(void (*)())print_leak,(char *)&ml);
646 CRYPTO_w_unlock(CRYPTO_LOCK_MALLOC2);
649 sprintf(buf,"%ld bytes leaked in %d chunks\n",
656 lh_node_stats_bio(mh,b);
657 lh_node_usage_stats_bio(mh,b);
661 static void (*mem_cb)()=NULL;
663 static void cb_leak(MEM *m, char *cb)
665 void (*mem_callback)()=(void (*)())cb;
666 mem_callback(m->order,m->file,m->line,m->num,m->addr);
669 void CRYPTO_mem_leaks_cb(void (*cb)())
671 if (mh == NULL) return;
672 CRYPTO_w_lock(CRYPTO_LOCK_MALLOC2);
674 lh_doall_arg(mh,(void (*)())cb_leak,(char *)mem_cb);
676 CRYPTO_w_unlock(CRYPTO_LOCK_MALLOC2);
680 void CRYPTO_mem_leaks_fp(FILE *fp)
684 if (mh == NULL) return;
685 if ((b=BIO_new(BIO_s_file())) == NULL)
687 BIO_set_fp(b,fp,BIO_NOCLOSE);