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.]
58 /* ====================================================================
59 * Copyright (c) 1998-2006 The OpenSSL Project. All rights reserved.
61 * Redistribution and use in source and binary forms, with or without
62 * modification, are permitted provided that the following conditions
65 * 1. Redistributions of source code must retain the above copyright
66 * notice, this list of conditions and the following disclaimer.
68 * 2. Redistributions in binary form must reproduce the above copyright
69 * notice, this list of conditions and the following disclaimer in
70 * the documentation and/or other materials provided with the
73 * 3. All advertising materials mentioning features or use of this
74 * software must display the following acknowledgment:
75 * "This product includes software developed by the OpenSSL Project
76 * for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
78 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
79 * endorse or promote products derived from this software without
80 * prior written permission. For written permission, please contact
81 * openssl-core@openssl.org.
83 * 5. Products derived from this software may not be called "OpenSSL"
84 * nor may "OpenSSL" appear in their names without prior written
85 * permission of the OpenSSL Project.
87 * 6. Redistributions of any form whatsoever must retain the following
89 * "This product includes software developed by the OpenSSL Project
90 * for use in the OpenSSL Toolkit (http://www.openssl.org/)"
92 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
93 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
94 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
95 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
96 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
97 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
98 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
99 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
100 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
101 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
102 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
103 * OF THE POSSIBILITY OF SUCH DAMAGE.
104 * ====================================================================
106 * This product includes cryptographic software written by Eric Young
107 * (eay@cryptsoft.com). This product includes software written by Tim
108 * Hudson (tjh@cryptsoft.com).
115 #include "internal/cryptlib.h"
116 #include <openssl/crypto.h>
117 #include <openssl/buffer.h>
118 #include <openssl/bio.h>
119 #include <openssl/lhash.h>
120 #if defined(CRYPTO_MDEBUG_BACKTRACE) && defined(__GNUC__)
121 # include <execinfo.h>
124 static int mh_mode = CRYPTO_MEM_CHECK_OFF;
126 * The state changes to CRYPTO_MEM_CHECK_ON | CRYPTO_MEM_CHECK_ENABLE when
127 * the application asks for it (usually after library initialisation for
128 * which no book-keeping is desired). State CRYPTO_MEM_CHECK_ON exists only
129 * temporarily when the library thinks that certain allocations should not be
130 * checked (e.g. the data structures used for memory checking). It is not
131 * suitable as an initial state: the library will unexpectedly enable memory
132 * checking when it executes one of those sections that want to disable
133 * checking temporarily. State CRYPTO_MEM_CHECK_ENABLE without ..._ON makes
134 * no sense whatsoever.
137 static unsigned long order = 0; /* number of memory requests */
139 DECLARE_LHASH_OF(MEM);
140 static LHASH_OF(MEM) *mh = NULL; /* hash-table of memory requests (address as
141 * key); access requires MALLOC2 lock */
143 typedef struct app_mem_info_st
145 * For application-defined information (static C-string `info')
146 * to be displayed in memory leak list.
147 * Each thread has its own stack. For applications, there is
148 * CRYPTO_push_info("...") to push an entry,
149 * CRYPTO_pop_info() to pop an entry,
150 * CRYPTO_remove_all_info() to pop all entries.
153 CRYPTO_THREADID threadid;
157 struct app_mem_info_st *next; /* tail of thread's stack */
161 static void app_info_free(APP_INFO *);
163 DECLARE_LHASH_OF(APP_INFO);
164 static LHASH_OF(APP_INFO) *amih = NULL; /* hash-table with those
165 * app_mem_info_st's that are at the
166 * top of their thread's stack (with
167 * `thread' as key); access requires
170 typedef struct mem_st
171 /* memory-block description */
177 CRYPTO_THREADID threadid;
181 #if defined(CRYPTO_MDEBUG_BACKTRACE) && defined(__GNUC__)
187 static long options = /* extra information to be recorded */
188 #if defined(CRYPTO_MDEBUG_TIME) || defined(CRYPTO_MDEBUG_ALL)
189 V_CRYPTO_MDEBUG_TIME |
191 #if defined(CRYPTO_MDEBUG_THREAD) || defined(CRYPTO_MDEBUG_ALL)
192 V_CRYPTO_MDEBUG_THREAD |
196 static unsigned int num_disable = 0; /* num_disable > 0 iff mh_mode ==
197 * CRYPTO_MEM_CHECK_ON (w/o ..._ENABLE) */
200 * Valid iff num_disable > 0. CRYPTO_LOCK_MALLOC2 is locked exactly in this
201 * case (by the thread named in disabling_thread).
203 static CRYPTO_THREADID disabling_threadid;
205 static void app_info_free(APP_INFO *inf)
209 if (--(inf->references) <= 0) {
210 app_info_free(inf->next);
215 int CRYPTO_mem_ctrl(int mode)
219 CRYPTO_w_lock(CRYPTO_LOCK_MALLOC);
222 * for applications (not to be called while multiple threads use the
225 case CRYPTO_MEM_CHECK_ON: /* aka MemCheck_start() */
226 mh_mode = CRYPTO_MEM_CHECK_ON | CRYPTO_MEM_CHECK_ENABLE;
229 case CRYPTO_MEM_CHECK_OFF: /* aka MemCheck_stop() */
231 num_disable = 0; /* should be true *before* MemCheck_stop is
232 * used, or there'll be a lot of confusion */
235 /* switch off temporarily (for library-internal use): */
236 case CRYPTO_MEM_CHECK_DISABLE: /* aka MemCheck_off() */
237 if (mh_mode & CRYPTO_MEM_CHECK_ON) {
239 CRYPTO_THREADID_current(&cur);
240 /* see if we don't have the MALLOC2 lock already */
242 || CRYPTO_THREADID_cmp(&disabling_threadid, &cur)) {
244 * Long-time lock CRYPTO_LOCK_MALLOC2 must not be claimed
245 * while we're holding CRYPTO_LOCK_MALLOC, or we'll deadlock
246 * if somebody else holds CRYPTO_LOCK_MALLOC2 (and cannot
247 * release it because we block entry to this function). Give
248 * them a chance, first, and then claim the locks in
249 * appropriate order (long-time lock first).
251 CRYPTO_w_unlock(CRYPTO_LOCK_MALLOC);
253 * Note that after we have waited for CRYPTO_LOCK_MALLOC2 and
254 * CRYPTO_LOCK_MALLOC, we'll still be in the right "case" and
255 * "if" branch because MemCheck_start and MemCheck_stop may
256 * never be used while there are multiple OpenSSL threads.
258 CRYPTO_w_lock(CRYPTO_LOCK_MALLOC2);
259 CRYPTO_w_lock(CRYPTO_LOCK_MALLOC);
260 mh_mode &= ~CRYPTO_MEM_CHECK_ENABLE;
261 CRYPTO_THREADID_cpy(&disabling_threadid, &cur);
266 case CRYPTO_MEM_CHECK_ENABLE: /* aka MemCheck_on() */
267 if (mh_mode & CRYPTO_MEM_CHECK_ON) {
268 if (num_disable) { /* always true, or something is going wrong */
270 if (num_disable == 0) {
271 mh_mode |= CRYPTO_MEM_CHECK_ENABLE;
272 CRYPTO_w_unlock(CRYPTO_LOCK_MALLOC2);
281 CRYPTO_w_unlock(CRYPTO_LOCK_MALLOC);
285 int CRYPTO_is_mem_check_on(void)
289 if (mh_mode & CRYPTO_MEM_CHECK_ON) {
291 CRYPTO_THREADID_current(&cur);
292 CRYPTO_r_lock(CRYPTO_LOCK_MALLOC);
294 ret = (mh_mode & CRYPTO_MEM_CHECK_ENABLE)
295 || CRYPTO_THREADID_cmp(&disabling_threadid, &cur);
297 CRYPTO_r_unlock(CRYPTO_LOCK_MALLOC);
302 void CRYPTO_dbg_set_options(long bits)
307 long CRYPTO_dbg_get_options(void)
312 static int mem_cmp(const MEM *a, const MEM *b)
315 const char *ap = (const char *)a->addr, *bp = (const char *)b->addr;
323 return (const char *)a->addr - (const char *)b->addr;
327 static IMPLEMENT_LHASH_COMP_FN(mem, MEM)
329 static unsigned long mem_hash(const MEM *a)
333 ret = (size_t)a->addr;
335 ret = ret * 17851 + (ret >> 14) * 7 + (ret >> 4) * 251;
339 static IMPLEMENT_LHASH_HASH_FN(mem, MEM)
341 /* static int app_info_cmp(APP_INFO *a, APP_INFO *b) */
342 static int app_info_cmp(const void *a_void, const void *b_void)
344 return CRYPTO_THREADID_cmp(&((const APP_INFO *)a_void)->threadid,
345 &((const APP_INFO *)b_void)->threadid);
348 static IMPLEMENT_LHASH_COMP_FN(app_info, APP_INFO)
350 static unsigned long app_info_hash(const APP_INFO *a)
354 ret = CRYPTO_THREADID_hash(&a->threadid);
355 /* This is left in as a "who am I to question legacy?" measure */
356 ret = ret * 17851 + (ret >> 14) * 7 + (ret >> 4) * 251;
360 static IMPLEMENT_LHASH_HASH_FN(app_info, APP_INFO)
362 static APP_INFO *pop_info(void)
365 APP_INFO *ret = NULL;
368 CRYPTO_THREADID_current(&tmp.threadid);
369 if ((ret = lh_APP_INFO_delete(amih, &tmp)) != NULL) {
370 APP_INFO *next = ret->next;
374 (void)lh_APP_INFO_insert(amih, next);
376 if (--(ret->references) <= 0) {
387 int CRYPTO_push_info_(const char *info, const char *file, int line)
389 APP_INFO *ami, *amim;
392 if (is_MemCheck_on()) {
393 MemCheck_off(); /* obtain MALLOC2 lock */
395 if ((ami = OPENSSL_malloc(sizeof(*ami))) == NULL) {
400 if ((amih = lh_APP_INFO_new()) == NULL) {
407 CRYPTO_THREADID_current(&ami->threadid);
414 if ((amim = lh_APP_INFO_insert(amih, ami)) != NULL)
417 MemCheck_on(); /* release MALLOC2 lock */
423 int CRYPTO_pop_info(void)
427 if (is_MemCheck_on()) { /* _must_ be true, or something went severely
429 MemCheck_off(); /* obtain MALLOC2 lock */
431 ret = (pop_info() != NULL);
433 MemCheck_on(); /* release MALLOC2 lock */
438 int CRYPTO_remove_all_info(void)
442 if (is_MemCheck_on()) { /* _must_ be true */
443 MemCheck_off(); /* obtain MALLOC2 lock */
445 while (pop_info() != NULL)
448 MemCheck_on(); /* release MALLOC2 lock */
453 static unsigned long break_order_num = 0;
454 void CRYPTO_dbg_malloc(void *addr, int num, const char *file, int line,
460 switch (before_p & 127) {
467 if (is_MemCheck_on()) {
468 MemCheck_off(); /* make sure we hold MALLOC2 lock */
469 if ((m = OPENSSL_malloc(sizeof(*m))) == NULL) {
471 MemCheck_on(); /* release MALLOC2 lock if num_disabled drops
476 if ((mh = lh_MEM_new()) == NULL) {
488 if (options & V_CRYPTO_MDEBUG_THREAD)
489 CRYPTO_THREADID_current(&m->threadid);
491 memset(&m->threadid, 0, sizeof(m->threadid));
493 if (order == break_order_num) {
498 if (options & V_CRYPTO_MDEBUG_TIME)
499 m->time = time(NULL);
502 #if defined(CRYPTO_MDEBUG_BACKTRACE) && defined(__GNUC__)
503 m->array_siz = backtrace(m->array, OSSL_NELEM(m->array));
506 CRYPTO_THREADID_current(&tmp.threadid);
509 && (amim = lh_APP_INFO_retrieve(amih, &tmp)) != NULL) {
514 if ((mm = lh_MEM_insert(mh, m)) != NULL) {
515 /* Not good, but don't sweat it */
516 if (mm->app_info != NULL) {
517 mm->app_info->references--;
522 MemCheck_on(); /* release MALLOC2 lock if num_disabled drops
530 void CRYPTO_dbg_free(void *addr, int before_p)
539 if (is_MemCheck_on() && (mh != NULL)) {
540 MemCheck_off(); /* make sure we hold MALLOC2 lock */
543 mp = lh_MEM_delete(mh, &m);
545 app_info_free(mp->app_info);
549 MemCheck_on(); /* release MALLOC2 lock if num_disabled drops
558 void CRYPTO_dbg_realloc(void *addr1, void *addr2, int num,
559 const char *file, int line, int before_p)
571 CRYPTO_dbg_malloc(addr2, num, file, line, 128 | before_p);
575 if (is_MemCheck_on()) {
576 MemCheck_off(); /* make sure we hold MALLOC2 lock */
579 mp = lh_MEM_delete(mh, &m);
583 #if defined(CRYPTO_MDEBUG_BACKTRACE) && defined(__GNUC__)
584 mp->array_siz = backtrace(mp->array, OSSL_NELEM(mp->array));
586 (void)lh_MEM_insert(mh, mp);
589 MemCheck_on(); /* release MALLOC2 lock if num_disabled drops
597 typedef struct mem_leak_st {
604 static void print_leak_doall_arg(const MEM *m, MEM_LEAK *l)
610 struct tm *lcl = NULL;
613 #define BUF_REMAIN (sizeof buf - (size_t)(bufp - buf))
615 /* Is one "leak" the BIO we were given? */
616 if (m->addr == (char *)l->bio) {
621 if (options & V_CRYPTO_MDEBUG_TIME) {
622 lcl = localtime(&m->time);
624 BIO_snprintf(bufp, BUF_REMAIN, "[%02d:%02d:%02d] ",
625 lcl->tm_hour, lcl->tm_min, lcl->tm_sec);
626 bufp += strlen(bufp);
629 BIO_snprintf(bufp, BUF_REMAIN, "%5lu file=%s, line=%d, ",
630 m->order, m->file, m->line);
631 bufp += strlen(bufp);
633 if (options & V_CRYPTO_MDEBUG_THREAD) {
634 BIO_snprintf(bufp, BUF_REMAIN, "thread=%lu, ",
635 CRYPTO_THREADID_hash(&m->threadid));
636 bufp += strlen(bufp);
639 BIO_snprintf(bufp, BUF_REMAIN, "number=%d, address=%p\n",
641 bufp += strlen(bufp);
643 BIO_puts(l->bio, buf);
651 CRYPTO_THREADID_cpy(&ti, &amip->threadid);
658 memset(buf, '>', ami_cnt);
659 BIO_snprintf(buf + ami_cnt, sizeof buf - ami_cnt,
660 " thread=%lu, file=%s, line=%d, info=\"",
661 CRYPTO_THREADID_hash(&amip->threadid), amip->file,
663 buf_len = strlen(buf);
664 info_len = strlen(amip->info);
665 if (128 - buf_len - 3 < info_len) {
666 memcpy(buf + buf_len, amip->info, 128 - buf_len - 3);
669 OPENSSL_strlcpy(buf + buf_len, amip->info, sizeof buf - buf_len);
670 buf_len = strlen(buf);
672 BIO_snprintf(buf + buf_len, sizeof buf - buf_len, "\"\n");
674 BIO_puts(l->bio, buf);
678 while (amip && !CRYPTO_THREADID_cmp(&amip->threadid, &ti));
681 #if defined(CRYPTO_MDEBUG_BACKTRACE) && defined(__GNUC__)
684 char **strings = backtrace_symbols(m->array, m->array_siz);
685 for (i = 0; i < m->array_siz; i++)
686 fprintf(stderr, "##> %s\n", strings[i]);
693 static IMPLEMENT_LHASH_DOALL_ARG_FN(print_leak, const MEM, MEM_LEAK)
695 void CRYPTO_mem_leaks(BIO *b)
699 if (mh == NULL && amih == NULL)
702 MemCheck_off(); /* obtain MALLOC2 lock */
709 lh_MEM_doall_arg(mh, LHASH_DOALL_ARG_FN(print_leak), MEM_LEAK, &ml);
710 /* Don't count the BIO that was passed in as a "leak" */
711 if (ml.seen && ml.chunks >= 1 && ml.bytes >= (int)sizeof (*b)) {
713 ml.bytes -= (int)sizeof (*b);
715 if (ml.chunks != 0) {
716 BIO_printf(b, "%ld bytes leaked in %d chunks\n", ml.bytes, ml.chunks);
717 #ifdef CRYPTO_MDEBUG_ABORT
722 * Make sure that, if we found no leaks, memory-leak debugging itself
723 * does not introduce memory leaks (which might irritate external
724 * debugging tools). (When someone enables leak checking, but does not
725 * call this function, we declare it to be their fault.) XXX This
726 * should be in CRYPTO_mem_leaks_cb, and CRYPTO_mem_leaks should be
727 * implemented by using CRYPTO_mem_leaks_cb. (Also there should be a
728 * variant of lh_doall_arg that takes a function pointer instead of a
729 * void *; this would obviate the ugly and illegal void_fn_to_char
730 * kludge in CRYPTO_mem_leaks_cb. Otherwise the code police will come
735 CRYPTO_w_lock(CRYPTO_LOCK_MALLOC);
738 * avoid deadlock when lh_free() uses CRYPTO_dbg_free(), which uses
739 * CRYPTO_is_mem_check_on
741 old_mh_mode = mh_mode;
742 mh_mode = CRYPTO_MEM_CHECK_OFF;
747 if (lh_APP_INFO_num_items(amih) == 0) {
748 lh_APP_INFO_free(amih);
753 mh_mode = old_mh_mode;
754 CRYPTO_w_unlock(CRYPTO_LOCK_MALLOC);
756 MemCheck_on(); /* release MALLOC2 lock */
759 #ifndef OPENSSL_NO_STDIO
760 void CRYPTO_mem_leaks_fp(FILE *fp)
767 * Need to turn off memory checking when allocated BIOs ... especially as
768 * we're creating them at a time when we're trying to check we've not
769 * left anything un-free()'d!!
772 b = BIO_new(BIO_s_file());
776 BIO_set_fp(b, fp, BIO_NOCLOSE);
783 * FIXME: We really don't allow much to the callback. For example, it has no
784 * chance of reaching the info stack for the item it processes. Should it
785 * really be this way? -- Richard Levitte
788 * NB: The prototypes have been typedef'd to CRYPTO_MEM_LEAK_CB inside
789 * crypto.h If this code is restructured, remove the callback type if it is
790 * no longer needed. -- Geoff Thorpe
794 * Can't pass CRYPTO_MEM_LEAK_CB directly to lh_MEM_doall_arg because it is a
795 * function pointer and conversion to void * is prohibited. Instead pass its
799 typedef CRYPTO_MEM_LEAK_CB *PCRYPTO_MEM_LEAK_CB;
801 static void cb_leak_doall_arg(const MEM *m, PCRYPTO_MEM_LEAK_CB *cb)
803 (*cb) (m->order, m->file, m->line, m->num, m->addr);
806 static IMPLEMENT_LHASH_DOALL_ARG_FN(cb_leak, const MEM, PCRYPTO_MEM_LEAK_CB)
808 void CRYPTO_mem_leaks_cb(CRYPTO_MEM_LEAK_CB *cb)
812 CRYPTO_w_lock(CRYPTO_LOCK_MALLOC2);
813 lh_MEM_doall_arg(mh, LHASH_DOALL_ARG_FN(cb_leak), PCRYPTO_MEM_LEAK_CB,
815 CRYPTO_w_unlock(CRYPTO_LOCK_MALLOC2);