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);
85 * access requires MALLOC2 lock */
88 typedef struct app_mem_info_st
89 /* For application-defined information (static C-string `info')
90 * to be displayed in memory leak list.
91 * Each thread has its own stack. For applications, there is
92 * CRYPTO_push_info("...") to push an entry,
93 * CRYPTO_pop_info() to pop an entry,
94 * CRYPTO_remove_all_info() to pop all entries.
101 struct app_mem_info_st *next; /* tail of thread's stack */
105 static LHASH *amih=NULL; /* hash-table with those app_mem_info_st's
106 * that are at the top of their thread's stack
107 * (with `thread' as key);
108 * access requires MALLOC2 lock */
110 typedef struct mem_st
111 /* memory-block description */
117 unsigned long thread;
123 static long options = /* extra information to be recorded */
124 #if defined(CRYPTO_MDEBUG_TIME) || defined(CRYPTO_MDEBUG_ALL)
125 V_CRYPTO_MDEBUG_TIME |
127 #if defined(CRYPTO_MDEBUG_THREAD) || defined(CRYPTO_MDEBUG_ALL)
128 V_CRYPTO_MDEBUG_THREAD |
133 static unsigned int num_disable = 0; /* num_disable > 0
135 * mh_mode == CRYPTO_MEM_CHECK_ON (w/o ..._ENABLE)
137 static unsigned long disabling_thread = 0; /* Valid iff num_disable > 0.
138 * CRYPTO_LOCK_MALLOC2 is locked
139 * exactly in this case (by the
140 * thread named in disabling_thread).
143 int CRYPTO_mem_ctrl(int mode)
147 CRYPTO_w_lock(CRYPTO_LOCK_MALLOC);
150 /* for applications (not to be called while multiple threads
151 * use the library): */
152 case CRYPTO_MEM_CHECK_ON: /* aka MemCheck_start() */
153 mh_mode = CRYPTO_MEM_CHECK_ON|CRYPTO_MEM_CHECK_ENABLE;
156 case CRYPTO_MEM_CHECK_OFF: /* aka MemCheck_stop() */
158 num_disable = 0; /* should be true *before* MemCheck_stop is used,
159 or there'll be a lot of confusion */
162 /* switch off temporarily (for library-internal use): */
163 case CRYPTO_MEM_CHECK_DISABLE: /* aka MemCheck_off() */
164 if (mh_mode & CRYPTO_MEM_CHECK_ON)
166 if (!num_disable || (disabling_thread != CRYPTO_thread_id())) /* otherwise we already have the MALLOC2 lock */
168 /* Long-time lock CRYPTO_LOCK_MALLOC2 must not be claimed while
169 * we're holding CRYPTO_LOCK_MALLOC, or we'll deadlock if
170 * somebody else holds CRYPTO_LOCK_MALLOC2 (and cannot release
171 * it because we block entry to this function).
172 * Give them a chance, first, and then claim the locks in
173 * appropriate order (long-time lock first).
175 CRYPTO_w_unlock(CRYPTO_LOCK_MALLOC);
176 /* Note that after we have waited for CRYPTO_LOCK_MALLOC2
177 * and CRYPTO_LOCK_MALLOC, we'll still be in the right
178 * "case" and "if" branch because MemCheck_start and
179 * MemCheck_stop may never be used while there are multiple
180 * OpenSSL threads. */
181 CRYPTO_w_lock(CRYPTO_LOCK_MALLOC2);
182 CRYPTO_w_lock(CRYPTO_LOCK_MALLOC);
183 mh_mode &= ~CRYPTO_MEM_CHECK_ENABLE;
184 disabling_thread=CRYPTO_thread_id();
189 case CRYPTO_MEM_CHECK_ENABLE: /* aka MemCheck_on() */
190 if (mh_mode & CRYPTO_MEM_CHECK_ON)
192 if (num_disable) /* always true, or something is going wrong */
195 if (num_disable == 0)
197 mh_mode|=CRYPTO_MEM_CHECK_ENABLE;
198 CRYPTO_w_unlock(CRYPTO_LOCK_MALLOC2);
207 CRYPTO_w_unlock(CRYPTO_LOCK_MALLOC);
211 int CRYPTO_is_mem_check_on(void)
215 if (mh_mode & CRYPTO_MEM_CHECK_ON)
217 CRYPTO_r_lock(CRYPTO_LOCK_MALLOC);
219 ret = (mh_mode & CRYPTO_MEM_CHECK_ENABLE)
220 || (disabling_thread != CRYPTO_thread_id());
222 CRYPTO_r_unlock(CRYPTO_LOCK_MALLOC);
228 void CRYPTO_dbg_set_options(long bits)
233 long CRYPTO_dbg_get_options(void)
238 /* static int mem_cmp(MEM *a, MEM *b) */
239 static int mem_cmp(const void *a_void, const void *b_void)
241 return((const char *)((const MEM *)a_void)->addr
242 - (const char *)((const MEM *)b_void)->addr);
245 /* static unsigned long mem_hash(MEM *a) */
246 static unsigned long mem_hash(const void *a_void)
250 ret=(unsigned long)((const MEM *)a_void)->addr;
252 ret=ret*17851+(ret>>14)*7+(ret>>4)*251;
256 /* static int app_info_cmp(APP_INFO *a, APP_INFO *b) */
257 static int app_info_cmp(const void *a_void, const void *b_void)
259 return(((const APP_INFO *)a_void)->thread
260 != ((const APP_INFO *)b_void)->thread);
263 /* static unsigned long app_info_hash(APP_INFO *a) */
264 static unsigned long app_info_hash(const void *a_void)
268 ret=(unsigned long)((const APP_INFO *)a_void)->thread;
270 ret=ret*17851+(ret>>14)*7+(ret>>4)*251;
274 static APP_INFO *pop_info(void)
277 APP_INFO *ret = NULL;
281 tmp.thread=CRYPTO_thread_id();
282 if ((ret=(APP_INFO *)lh_delete(amih,&tmp)) != NULL)
284 APP_INFO *next=ret->next;
289 lh_insert(amih,(char *)next);
291 #ifdef LEVITTE_DEBUG_MEM
292 if (ret->thread != tmp.thread)
294 fprintf(stderr, "pop_info(): deleted info has other thread ID (%lu) than the current thread (%lu)!!!!\n",
295 ret->thread, tmp.thread);
299 if (--(ret->references) <= 0)
311 int CRYPTO_push_info_(const char *info, const char *file, int line)
313 APP_INFO *ami, *amim;
316 if (is_MemCheck_on())
318 MemCheck_off(); /* obtain MALLOC2 lock */
320 if ((ami = (APP_INFO *)OPENSSL_malloc(sizeof(APP_INFO))) == NULL)
327 if ((amih=lh_new(app_info_hash, app_info_cmp)) == NULL)
335 ami->thread=CRYPTO_thread_id();
342 if ((amim=(APP_INFO *)lh_insert(amih,(char *)ami)) != NULL)
344 #ifdef LEVITTE_DEBUG_MEM
345 if (ami->thread != amim->thread)
347 fprintf(stderr, "CRYPTO_push_info(): previous info has other thread ID (%lu) than the current thread (%lu)!!!!\n",
348 amim->thread, ami->thread);
355 MemCheck_on(); /* release MALLOC2 lock */
361 int CRYPTO_pop_info(void)
365 if (is_MemCheck_on()) /* _must_ be true, or something went severely wrong */
367 MemCheck_off(); /* obtain MALLOC2 lock */
369 ret=(pop_info() != NULL);
371 MemCheck_on(); /* release MALLOC2 lock */
376 int CRYPTO_remove_all_info(void)
380 if (is_MemCheck_on()) /* _must_ be true */
382 MemCheck_off(); /* obtain MALLOC2 lock */
384 while(pop_info() != NULL)
387 MemCheck_on(); /* release MALLOC2 lock */
393 static unsigned long break_order_num=0;
394 void CRYPTO_dbg_malloc(void *addr, int num, const char *file, int line,
400 switch(before_p & 127)
408 if (is_MemCheck_on())
410 MemCheck_off(); /* make sure we hold MALLOC2 lock */
411 if ((m=(MEM *)OPENSSL_malloc(sizeof(MEM))) == NULL)
414 MemCheck_on(); /* release MALLOC2 lock
415 * if num_disabled drops to 0 */
420 if ((mh=lh_new(mem_hash, mem_cmp)) == NULL)
433 if (options & V_CRYPTO_MDEBUG_THREAD)
434 m->thread=CRYPTO_thread_id();
438 if (order == break_order_num)
444 #ifdef LEVITTE_DEBUG_MEM
445 fprintf(stderr, "LEVITTE_DEBUG_MEM: [%5d] %c 0x%p (%d)\n",
447 (before_p & 128) ? '*' : '+',
450 if (options & V_CRYPTO_MDEBUG_TIME)
455 tmp.thread=CRYPTO_thread_id();
458 && (amim=(APP_INFO *)lh_retrieve(amih,(char *)&tmp)) != NULL)
464 if ((mm=(MEM *)lh_insert(mh,(char *)m)) != NULL)
466 /* Not good, but don't sweat it */
467 if (mm->app_info != NULL)
469 mm->app_info->references--;
474 MemCheck_on(); /* release MALLOC2 lock
475 * if num_disabled drops to 0 */
482 void CRYPTO_dbg_free(void *addr, int before_p)
492 if (is_MemCheck_on() && (mh != NULL))
494 MemCheck_off(); /* make sure we hold MALLOC2 lock */
497 mp=(MEM *)lh_delete(mh,(char *)&m);
500 #ifdef LEVITTE_DEBUG_MEM
501 fprintf(stderr, "LEVITTE_DEBUG_MEM: [%5d] - 0x%p (%d)\n",
502 mp->order, mp->addr, mp->num);
504 if (mp->app_info != NULL)
506 mp->app_info->references--;
511 MemCheck_on(); /* release MALLOC2 lock
512 * if num_disabled drops to 0 */
520 void CRYPTO_dbg_realloc(void *addr1, void *addr2, int num,
521 const char *file, int line, int before_p)
525 #ifdef LEVITTE_DEBUG_MEM
526 fprintf(stderr, "LEVITTE_DEBUG_MEM: --> CRYPTO_dbg_malloc(addr1 = %p, addr2 = %p, num = %d, file = \"%s\", line = %d, before_p = %d)\n",
527 addr1, addr2, num, file, line, before_p);
540 CRYPTO_dbg_malloc(addr2, num, file, line, 128 | before_p);
544 if (is_MemCheck_on())
546 MemCheck_off(); /* make sure we hold MALLOC2 lock */
549 mp=(MEM *)lh_delete(mh,(char *)&m);
552 #ifdef LEVITTE_DEBUG_MEM
553 fprintf(stderr, "LEVITTE_DEBUG_MEM: [%5d] * 0x%p (%d) -> 0x%p (%d)\n",
560 lh_insert(mh,(char *)mp);
563 MemCheck_on(); /* release MALLOC2 lock
564 * if num_disabled drops to 0 */
572 typedef struct mem_leak_st
579 static void print_leak(const MEM *m, MEM_LEAK *l)
585 struct tm *lcl = NULL;
588 if(m->addr == (char *)l->bio)
591 if (options & V_CRYPTO_MDEBUG_TIME)
593 lcl = localtime(&m->time);
595 sprintf(bufp, "[%02d:%02d:%02d] ",
596 lcl->tm_hour,lcl->tm_min,lcl->tm_sec);
597 bufp += strlen(bufp);
600 sprintf(bufp, "%5lu file=%s, line=%d, ",
601 m->order,m->file,m->line);
602 bufp += strlen(bufp);
604 if (options & V_CRYPTO_MDEBUG_THREAD)
606 sprintf(bufp, "thread=%lu, ", m->thread);
607 bufp += strlen(bufp);
610 sprintf(bufp, "number=%d, address=%08lX\n",
611 m->num,(unsigned long)m->addr);
612 bufp += strlen(bufp);
614 BIO_puts(l->bio,buf);
631 memset(buf,'>',ami_cnt);
632 sprintf(buf + ami_cnt,
633 " thread=%lu, file=%s, line=%d, info=\"",
634 amip->thread, amip->file, amip->line);
636 info_len=strlen(amip->info);
637 if (128 - buf_len - 3 < info_len)
639 memcpy(buf + buf_len, amip->info, 128 - buf_len - 3);
644 strcpy(buf + buf_len, amip->info);
645 buf_len = strlen(buf);
647 sprintf(buf + buf_len, "\"\n");
649 BIO_puts(l->bio,buf);
653 while(amip && amip->thread == ti);
655 #ifdef LEVITTE_DEBUG_MEM
658 fprintf(stderr, "Thread switch detected in backtrace!!!!\n");
664 static IMPLEMENT_LHASH_DOALL_ARG_FN(print_leak, const MEM *, MEM_LEAK *)
666 void CRYPTO_mem_leaks(BIO *b)
671 if (mh == NULL && amih == NULL)
674 MemCheck_off(); /* obtain MALLOC2 lock */
680 lh_doall_arg(mh, LHASH_DOALL_ARG_FN(print_leak),
684 sprintf(buf,"%ld bytes leaked in %d chunks\n",
690 /* Make sure that, if we found no leaks, memory-leak debugging itself
691 * does not introduce memory leaks (which might irritate
692 * external debugging tools).
693 * (When someone enables leak checking, but does not call
694 * this function, we declare it to be their fault.)
696 * XXX This should be in CRYPTO_mem_leaks_cb,
697 * and CRYPTO_mem_leaks should be implemented by
698 * using CRYPTO_mem_leaks_cb.
699 * (Also their should be a variant of lh_doall_arg
700 * that takes a function pointer instead of a void *;
701 * this would obviate the ugly and illegal
702 * void_fn_to_char kludge in CRYPTO_mem_leaks_cb.
703 * Otherwise the code police will come and get us.)
707 CRYPTO_w_lock(CRYPTO_LOCK_MALLOC);
709 /* avoid deadlock when lh_free() uses CRYPTO_dbg_free(),
710 * which uses CRYPTO_is_mem_check_on */
711 old_mh_mode = mh_mode;
712 mh_mode = CRYPTO_MEM_CHECK_OFF;
721 if (lh_num_items(amih) == 0)
728 mh_mode = old_mh_mode;
729 CRYPTO_w_unlock(CRYPTO_LOCK_MALLOC);
731 MemCheck_on(); /* release MALLOC2 lock */
734 #ifndef OPENSSL_NO_FP_API
735 void CRYPTO_mem_leaks_fp(FILE *fp)
739 if (mh == NULL) return;
740 /* Need to turn off memory checking when allocated BIOs ... especially
741 * as we're creating them at a time when we're trying to check we've not
742 * left anything un-free()'d!! */
744 b = BIO_new(BIO_s_file());
747 BIO_set_fp(b,fp,BIO_NOCLOSE);
755 /* FIXME: We really don't allow much to the callback. For example, it has
756 no chance of reaching the info stack for the item it processes. Should
757 it really be this way? -- Richard Levitte */
758 /* NB: The prototypes have been typedef'd to CRYPTO_MEM_LEAK_CB inside crypto.h
759 * If this code is restructured, remove the callback type if it is no longer
760 * needed. -- Geoff Thorpe */
761 static void cb_leak(const MEM *m, CRYPTO_MEM_LEAK_CB **cb)
763 (**cb)(m->order,m->file,m->line,m->num,m->addr);
766 static IMPLEMENT_LHASH_DOALL_ARG_FN(cb_leak, const MEM *, CRYPTO_MEM_LEAK_CB **)
768 void CRYPTO_mem_leaks_cb(CRYPTO_MEM_LEAK_CB *cb)
770 if (mh == NULL) return;
771 CRYPTO_w_lock(CRYPTO_LOCK_MALLOC2);
772 lh_doall_arg(mh, LHASH_DOALL_ARG_FN(cb_leak), &cb);
773 CRYPTO_w_unlock(CRYPTO_LOCK_MALLOC2);