Typo...
[openssl.git] / crypto / mem_dbg.c
index f0032d7..6068dcc 100644 (file)
@@ -1,59 +1,59 @@
 /* crypto/mem_dbg.c */
-/* Written by Richard Levitte (richard@levitte.org) for the OpenSSL
- * project 1999.
- */
-/* ====================================================================
- * Copyright (c) 1999 The OpenSSL Project.  All rights reserved.
+/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
+ * All rights reserved.
  *
+ * This package is an SSL implementation written
+ * by Eric Young (eay@cryptsoft.com).
+ * The implementation was written so as to conform with Netscapes SSL.
+ * 
+ * This library is free for commercial and non-commercial use as long as
+ * the following conditions are aheared to.  The following conditions
+ * apply to all code found in this distribution, be it the RC4, RSA,
+ * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
+ * included with this distribution is covered by the same copyright terms
+ * except that the holder is Tim Hudson (tjh@cryptsoft.com).
+ * 
+ * Copyright remains Eric Young's, and as such any Copyright notices in
+ * the code are not to be removed.
+ * If this package is used in a product, Eric Young should be given attribution
+ * as the author of the parts of the library used.
+ * This can be in the form of a textual message at program startup or
+ * in documentation (online or textual) provided with the package.
+ * 
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
  * are met:
- *
- * 1. Redistributions of source code must retain the above copyright
- *    notice, this list of conditions and the following disclaimer. 
- *
+ * 1. Redistributions of source code must retain the copyright
+ *    notice, this list of conditions and the following disclaimer.
  * 2. Redistributions in binary form must reproduce the above copyright
- *    notice, this list of conditions and the following disclaimer in
- *    the documentation and/or other materials provided with the
- *    distribution.
- *
- * 3. All advertising materials mentioning features or use of this
- *    software must display the following acknowledgment:
- *    "This product includes software developed by the OpenSSL Project
- *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
- *
- * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
- *    endorse or promote products derived from this software without
- *    prior written permission. For written permission, please contact
- *    licensing@OpenSSL.org.
- *
- * 5. Products derived from this software may not be called "OpenSSL"
- *    nor may "OpenSSL" appear in their names without prior written
- *    permission of the OpenSSL Project.
- *
- * 6. Redistributions of any form whatsoever must retain the following
- *    acknowledgment:
- *    "This product includes software developed by the OpenSSL Project
- *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
- *
- * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
- * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
- * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
- * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
- * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
- * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
- * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
- * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
- * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
- * OF THE POSSIBILITY OF SUCH DAMAGE.
- * ====================================================================
- *
- * This product includes cryptographic software written by Eric Young
- * (eay@cryptsoft.com).  This product includes software written by Tim
- * Hudson (tjh@cryptsoft.com).
- *
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ * 3. All advertising materials mentioning features or use of this software
+ *    must display the following acknowledgement:
+ *    "This product includes cryptographic software written by
+ *     Eric Young (eay@cryptsoft.com)"
+ *    The word 'cryptographic' can be left out if the rouines from the library
+ *    being used are not cryptographic related :-).
+ * 4. If you include any Windows specific code (or a derivative thereof) from 
+ *    the apps directory (application code) you must include an acknowledgement:
+ *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
+ * 
+ * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+ * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+ * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+ * SUCH DAMAGE.
+ * 
+ * The licence and distribution terms for any publically available version or
+ * derivative of this code cannot be changed.  i.e. this code cannot simply be
+ * copied and put under another distribution licence
+ * [including the GNU Public Licence.]
  */
 
 #include <stdio.h>
 #include <openssl/lhash.h>
 #include "cryptlib.h"
 
-/* State CRYPTO_MEM_CHECK_ON exists only temporarily when the library
+static int mh_mode=CRYPTO_MEM_CHECK_OFF;
+/* The state changes to CRYPTO_MEM_CHECK_ON | CRYPTO_MEM_CHECK_ENABLE
+ * when the application asks for it (usually after library initialisation
+ * for which no book-keeping is desired).
+ *
+ * State CRYPTO_MEM_CHECK_ON exists only temporarily when the library
  * thinks that certain allocations should not be checked (e.g. the data
  * structures used for memory checking).  It is not suitable as an initial
  * state: the library will unexpectedly enable memory checking when it
  *
  * State CRYPTO_MEM_CHECK_ENABLE without ..._ON makes no sense whatsoever.
  */
-static int mh_mode=CRYPTO_MEM_CHECK_OFF;
-static unsigned long disabling_thread = 0;
 
+static unsigned long order = 0; /* number of memory requests */
+static LHASH *mh=NULL; /* hash-table of memory requests (address as key) */
 
-static unsigned long order=0;
-
-static LHASH *amih=NULL;
 
 typedef struct app_mem_info_st
+/* For application-defined information (static C-string `info')
+ * to be displayed in memory leak list.
+ * Each thread has its own stack.  For applications, there is
+ *   CRYPTO_push_info("...")     to push an entry,
+ *   CRYPTO_pop_info()           to pop an entry,
+ *   CRYPTO_remove_all_info()    to pop all entries.
+ */
        {       
        unsigned long thread;
        const char *file;
        int line;
        const char *info;
-       struct app_mem_info_st *next;
+       struct app_mem_info_st *next; /* tail of thread's stack */
        int references;
        } APP_INFO;
 
-static LHASH *mh=NULL;
+static LHASH *amih=NULL; /* hash-table with those app_mem_info_st's
+                          * that are at the top of their thread's stack
+                          * (with `thread' as key) */
 
 typedef struct mem_st
+/* memory-block description */
        {
        char *addr;
        int num;
@@ -106,9 +118,18 @@ typedef struct mem_st
        APP_INFO *app_info;
        } MEM;
 
-static int options = V_CRYPTO_MDEBUG_TIME | V_CRYPTO_MDEBUG_THREAD;
+static long options =             /* extra information to be recorded */
+#if defined(CRYPTO_MDEBUG_TIME) || defined(CRYPTO_MDEBUG_ALL)
+       V_CRYPTO_MDEBUG_TIME |
+#endif
+#if defined(CRYPTO_MDEBUG_THREAD) || defined(CRYPTO_MDEBUG_ALL)
+       V_CRYPTO_MDEBUG_THREAD |
+#endif
+       0;
 
 
+static unsigned long disabling_thread = 0;
+
 int CRYPTO_mem_ctrl(int mode)
        {
        int ret=mh_mode;
@@ -135,8 +156,8 @@ int CRYPTO_mem_ctrl(int mode)
                                {
                                /* Long-time lock CRYPTO_LOCK_MALLOC2 must not be claimed while
                                 * we're holding CRYPTO_LOCK_MALLOC, or we'll deadlock if
-                                * somebody else holds CRYPTO_LOCK_MALLOC2 (and cannot release it
-                                * because we block entry to this function).
+                                * somebody else holds CRYPTO_LOCK_MALLOC2 (and cannot release
+                                * it because we block entry to this function).
                                 * Give them a chance, first, and then claim the locks in
                                 * appropriate order (long-time lock first).
                                 */
@@ -171,7 +192,7 @@ int CRYPTO_mem_ctrl(int mode)
        return(ret);
        }
 
-int CRYPTO_mem_check_on(void)
+int CRYPTO_is_mem_check_on(void)
        {
        int ret = 0;
 
@@ -188,12 +209,12 @@ int CRYPTO_mem_check_on(void)
        }       
 
 
-void CRYPTO_dbg_set_options(int bits)
+void CRYPTO_dbg_set_options(long bits)
        {
        options = bits;
        }
 
-int CRYPTO_dbg_get_options()
+long CRYPTO_dbg_get_options()
        {
        return options;
        }
@@ -215,7 +236,7 @@ static unsigned long mem_hash(MEM *a)
 
 static int app_info_cmp(APP_INFO *a, APP_INFO *b)
        {
-       return(a->thread - b->thread);
+       return(a->thread != b->thread);
        }
 
 static unsigned long app_info_hash(APP_INFO *a)
@@ -228,7 +249,7 @@ static unsigned long app_info_hash(APP_INFO *a)
        return(ret);
        }
 
-static APP_INFO *remove_info()
+static APP_INFO *pop_info()
        {
        APP_INFO tmp;
        APP_INFO *ret = NULL;
@@ -248,7 +269,7 @@ static APP_INFO *remove_info()
 #ifdef LEVITTE_DEBUG
                        if (ret->thread != tmp.thread)
                                {
-                               fprintf(stderr, "remove_info(): deleted info has other thread ID (%lu) than the current thread (%lu)!!!!\n",
+                               fprintf(stderr, "pop_info(): deleted info has other thread ID (%lu) than the current thread (%lu)!!!!\n",
                                        ret->thread, tmp.thread);
                                abort();
                                }
@@ -265,14 +286,14 @@ static APP_INFO *remove_info()
        return(ret);
        }
 
-int CRYPTO_add_info(const char *file, int line, const char *info)
+int CRYPTO_push_info_(const char *info, const char *file, int line)
        {
        APP_INFO *ami, *amim;
        int ret=0;
 
        if (is_MemCheck_on())
                {
-               MemCheck_off();
+               MemCheck_off(); /* obtains CRYPTO_LOCK_MALLOC2 */
 
                if ((ami = (APP_INFO *)Malloc(sizeof(APP_INFO))) == NULL)
                        {
@@ -301,7 +322,7 @@ int CRYPTO_add_info(const char *file, int line, const char *info)
 #ifdef LEVITTE_DEBUG
                        if (ami->thread != amim->thread)
                                {
-                               fprintf(stderr, "CRYPTO_add_info(): previous info has other thread ID (%lu) than the current thread (%lu)!!!!\n",
+                               fprintf(stderr, "CRYPTO_push_info(): previous info has other thread ID (%lu) than the current thread (%lu)!!!!\n",
                                        amim->thread, ami->thread);
                                abort();
                                }
@@ -309,23 +330,23 @@ int CRYPTO_add_info(const char *file, int line, const char *info)
                        ami->next=amim;
                        }
  err:
-               MemCheck_on();
+               MemCheck_on(); /* releases CRYPTO_LOCK_MALLOC2 */
                }
 
        return(ret);
        }
 
-int CRYPTO_remove_info(void)
+int CRYPTO_pop_info(void)
        {
        int ret=0;
 
-       if (is_MemCheck_on())
+       if (is_MemCheck_on()) /* _must_ be true, or something went severely wrong */
                {
-               MemCheck_off();
+               MemCheck_off(); /* obtains CRYPTO_LOCK_MALLOC2 */
 
-               ret=(remove_info() != NULL);
+               ret=(pop_info() != NULL);
 
-               MemCheck_on();
+               MemCheck_on(); /* releases CRYPTO_LOCK_MALLOC2 */
                }
        return(ret);
        }
@@ -334,14 +355,14 @@ int CRYPTO_remove_all_info(void)
        {
        int ret=0;
 
-       if (is_MemCheck_on())
+       if (is_MemCheck_on()) /* _must_ be true */
                {
-               MemCheck_off();
+               MemCheck_off(); /* obtains CRYPTO_LOCK_MALLOC2 */
 
-               while(remove_info() != NULL)
+               while(pop_info() != NULL)
                        ret++;
 
-               MemCheck_on();
+               MemCheck_on(); /* releases CRYPTO_LOCK_MALLOC2 */
                }
        return(ret);
        }
@@ -364,11 +385,11 @@ void CRYPTO_dbg_malloc(void *addr, int num, const char *file, int line,
 
                if (is_MemCheck_on())
                        {
-                       MemCheck_off();
+                       MemCheck_off(); /* obtains CRYPTO_LOCK_MALLOC2 */
                        if ((m=(MEM *)Malloc(sizeof(MEM))) == NULL)
                                {
                                Free(addr);
-                               MemCheck_on();
+                               MemCheck_on(); /* releases CRYPTO_LOCK_MALLOC2 */
                                return;
                                }
                        if (mh == NULL)
@@ -427,7 +448,7 @@ void CRYPTO_dbg_malloc(void *addr, int num, const char *file, int line,
                                Free(mm);
                                }
                err:
-                       MemCheck_on();
+                       MemCheck_on(); /* releases CRYPTO_LOCK_MALLOC2 */
                        }
                break;
                }
@@ -463,7 +484,7 @@ void CRYPTO_dbg_free(void *addr, int before_p)
                                Free(mp);
                                }
 
-                       MemCheck_on();
+                       MemCheck_on(); /* releases CRYPTO_LOCK_MALLOC2 */
                        }
                break;
        case 1:
@@ -497,7 +518,7 @@ void CRYPTO_dbg_realloc(void *addr1, void *addr2, int num,
 
                if (is_MemCheck_on())
                        {
-                       MemCheck_off();
+                       MemCheck_off(); /* obtains CRYPTO_LOCK_MALLOC2 */
 
                        m.addr=addr1;
                        mp=(MEM *)lh_delete(mh,(char *)&m);
@@ -514,7 +535,7 @@ void CRYPTO_dbg_realloc(void *addr1, void *addr2, int num,
                                lh_insert(mh,(char *)mp);
                                }
 
-                       MemCheck_on();
+                       MemCheck_on(); /* releases CRYPTO_LOCK_MALLOC2 */
                        }
                break;
                }
@@ -571,9 +592,11 @@ static void print_leak(MEM *m, MEM_LEAK *l)
 
        amip=m->app_info;
        ami_cnt=0;
-       if (amip)
-               ti=amip->thread;
-       while(amip && amip->thread == ti)
+       if (!amip)
+               return;
+       ti=amip->thread;
+       
+       do
                {
                int buf_len;
                int info_len;
@@ -581,7 +604,7 @@ static void print_leak(MEM *m, MEM_LEAK *l)
                ami_cnt++;
                memset(buf,'>',ami_cnt);
                sprintf(buf + ami_cnt,
-                       "thread=%lu, file=%s, line=%d, info=\"",
+                       " thread=%lu, file=%s, line=%d, info=\"",
                        amip->thread, amip->file, amip->line);
                buf_len=strlen(buf);
                info_len=strlen(amip->info);
@@ -601,10 +624,12 @@ static void print_leak(MEM *m, MEM_LEAK *l)
 
                amip = amip->next;
                }
+       while(amip && amip->thread == ti);
+               
 #ifdef LEVITTE_DEBUG
        if (amip)
                {
-               fprintf(stderr, "Thread switch detected i backtrace!!!!\n");
+               fprintf(stderr, "Thread switch detected in backtrace!!!!\n");
                abort();
                }
 #endif