fix memory leak in memory debuggin code ...
[openssl.git] / crypto / mem_dbg.c
index 61329b098d8d89729df314ae6c60af055b293cab..57bd08f65d92c50b87699065d2fb43eeb5f7b428 100644 (file)
@@ -81,7 +81,8 @@ static int mh_mode=CRYPTO_MEM_CHECK_OFF;
  */
 
 static unsigned long order = 0; /* number of memory requests */
-static LHASH *mh=NULL; /* hash-table of memory requests (address as key) */
+static LHASH *mh=NULL; /* hash-table of memory requests (address as key);
+                        * access requires MALLOC2 lock */
 
 
 typedef struct app_mem_info_st
@@ -101,9 +102,12 @@ typedef struct app_mem_info_st
        int references;
        } APP_INFO;
 
+static void app_info_free(APP_INFO *);
+
 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) */
+                          * (with `thread' as key);
+                          * access requires MALLOC2 lock */
 
 typedef struct mem_st
 /* memory-block description */
@@ -128,7 +132,27 @@ static long options =             /* extra information to be recorded */
        0;
 
 
-static unsigned long disabling_thread = 0;
+static unsigned int num_disable = 0; /* num_disable > 0
+                                      *     iff
+                                      * mh_mode == CRYPTO_MEM_CHECK_ON (w/o ..._ENABLE)
+                                      */
+static unsigned long disabling_thread = 0; /* Valid iff num_disable > 0.
+                                            * CRYPTO_LOCK_MALLOC2 is locked
+                                            * exactly in this case (by the
+                                            * thread named in disabling_thread).
+                                            */
+
+static void app_info_free(APP_INFO *inf)
+       {
+       if (--(inf->references) <= 0)
+               {
+               if (inf->next != NULL)
+                       {
+                       app_info_free(inf->next);
+                       }
+               OPENSSL_free(inf);
+               }
+       }
 
 int CRYPTO_mem_ctrl(int mode)
        {
@@ -137,22 +161,23 @@ int CRYPTO_mem_ctrl(int mode)
        CRYPTO_w_lock(CRYPTO_LOCK_MALLOC);
        switch (mode)
                {
-       /* for applications: */
+       /* for applications (not to be called while multiple threads
+        * use the library): */
        case CRYPTO_MEM_CHECK_ON: /* aka MemCheck_start() */
                mh_mode = CRYPTO_MEM_CHECK_ON|CRYPTO_MEM_CHECK_ENABLE;
-               disabling_thread = 0;
+               num_disable = 0;
                break;
        case CRYPTO_MEM_CHECK_OFF: /* aka MemCheck_stop() */
                mh_mode = 0;
-               disabling_thread = 0;
+               num_disable = 0; /* should be true *before* MemCheck_stop is used,
+                                   or there'll be a lot of confusion */
                break;
 
        /* switch off temporarily (for library-internal use): */
        case CRYPTO_MEM_CHECK_DISABLE: /* aka MemCheck_off() */
                if (mh_mode & CRYPTO_MEM_CHECK_ON)
                        {
-                       mh_mode&= ~CRYPTO_MEM_CHECK_ENABLE;
-                       if (disabling_thread != CRYPTO_thread_id()) /* otherwise we already have the MALLOC2 lock */
+                       if (!num_disable || (disabling_thread != CRYPTO_thread_id())) /* otherwise we already have the MALLOC2 lock */
                                {
                                /* Long-time lock CRYPTO_LOCK_MALLOC2 must not be claimed while
                                 * we're holding CRYPTO_LOCK_MALLOC, or we'll deadlock if
@@ -169,18 +194,23 @@ int CRYPTO_mem_ctrl(int mode)
                                 * OpenSSL threads. */
                                CRYPTO_w_lock(CRYPTO_LOCK_MALLOC2);
                                CRYPTO_w_lock(CRYPTO_LOCK_MALLOC);
+                               mh_mode &= ~CRYPTO_MEM_CHECK_ENABLE;
                                disabling_thread=CRYPTO_thread_id();
                                }
+                       num_disable++;
                        }
                break;
        case CRYPTO_MEM_CHECK_ENABLE: /* aka MemCheck_on() */
                if (mh_mode & CRYPTO_MEM_CHECK_ON)
                        {
-                       mh_mode|=CRYPTO_MEM_CHECK_ENABLE;
-                       if (disabling_thread != 0)
+                       if (num_disable) /* always true, or something is going wrong */
                                {
-                               disabling_thread=0;
-                               CRYPTO_w_unlock(CRYPTO_LOCK_MALLOC2);
+                               num_disable--;
+                               if (num_disable == 0)
+                                       {
+                                       mh_mode|=CRYPTO_MEM_CHECK_ENABLE;
+                                       CRYPTO_w_unlock(CRYPTO_LOCK_MALLOC2);
+                                       }
                                }
                        }
                break;
@@ -198,12 +228,12 @@ int CRYPTO_is_mem_check_on(void)
 
        if (mh_mode & CRYPTO_MEM_CHECK_ON)
                {
-               CRYPTO_w_lock(CRYPTO_LOCK_MALLOC);
+               CRYPTO_r_lock(CRYPTO_LOCK_MALLOC);
 
                ret = (mh_mode & CRYPTO_MEM_CHECK_ENABLE)
-                       && disabling_thread != CRYPTO_thread_id();
+                       || (disabling_thread != CRYPTO_thread_id());
 
-               CRYPTO_w_unlock(CRYPTO_LOCK_MALLOC);
+               CRYPTO_r_unlock(CRYPTO_LOCK_MALLOC);
                }
        return(ret);
        }       
@@ -219,31 +249,37 @@ long CRYPTO_dbg_get_options(void)
        return options;
        }
 
-static int mem_cmp(MEM *a, MEM *b)
+/* static int mem_cmp(MEM *a, MEM *b) */
+static int mem_cmp(const void *a_void, const void *b_void)
        {
-       return((char *)a->addr - (char *)b->addr);
+       return((const char *)((const MEM *)a_void)->addr
+               - (const char *)((const MEM *)b_void)->addr);
        }
 
-static unsigned long mem_hash(MEM *a)
+/* static unsigned long mem_hash(MEM *a) */
+static unsigned long mem_hash(const void *a_void)
        {
        unsigned long ret;
 
-       ret=(unsigned long)a->addr;
+       ret=(unsigned long)((const MEM *)a_void)->addr;
 
        ret=ret*17851+(ret>>14)*7+(ret>>4)*251;
        return(ret);
        }
 
-static int app_info_cmp(APP_INFO *a, APP_INFO *b)
+/* static int app_info_cmp(APP_INFO *a, APP_INFO *b) */
+static int app_info_cmp(const void *a_void, const void *b_void)
        {
-       return(a->thread != b->thread);
+       return(((const APP_INFO *)a_void)->thread
+               != ((const APP_INFO *)b_void)->thread);
        }
 
-static unsigned long app_info_hash(APP_INFO *a)
+/* static unsigned long app_info_hash(APP_INFO *a) */
+static unsigned long app_info_hash(const void *a_void)
        {
        unsigned long ret;
 
-       ret=(unsigned long)a->thread;
+       ret=(unsigned long)((const APP_INFO *)a_void)->thread;
 
        ret=ret*17851+(ret>>14)*7+(ret>>4)*251;
        return(ret);
@@ -293,7 +329,7 @@ int CRYPTO_push_info_(const char *info, const char *file, int line)
 
        if (is_MemCheck_on())
                {
-               MemCheck_off(); /* obtains CRYPTO_LOCK_MALLOC2 */
+               MemCheck_off(); /* obtain MALLOC2 lock */
 
                if ((ami = (APP_INFO *)OPENSSL_malloc(sizeof(APP_INFO))) == NULL)
                        {
@@ -302,7 +338,7 @@ int CRYPTO_push_info_(const char *info, const char *file, int line)
                        }
                if (amih == NULL)
                        {
-                       if ((amih=lh_new(app_info_hash,app_info_cmp)) == NULL)
+                       if ((amih=lh_new(app_info_hash, app_info_cmp)) == NULL)
                                {
                                OPENSSL_free(ami);
                                ret=0;
@@ -330,7 +366,7 @@ int CRYPTO_push_info_(const char *info, const char *file, int line)
                        ami->next=amim;
                        }
  err:
-               MemCheck_on(); /* releases CRYPTO_LOCK_MALLOC2 */
+               MemCheck_on(); /* release MALLOC2 lock */
                }
 
        return(ret);
@@ -342,11 +378,11 @@ int CRYPTO_pop_info(void)
 
        if (is_MemCheck_on()) /* _must_ be true, or something went severely wrong */
                {
-               MemCheck_off(); /* obtains CRYPTO_LOCK_MALLOC2 */
+               MemCheck_off(); /* obtain MALLOC2 lock */
 
                ret=(pop_info() != NULL);
 
-               MemCheck_on(); /* releases CRYPTO_LOCK_MALLOC2 */
+               MemCheck_on(); /* release MALLOC2 lock */
                }
        return(ret);
        }
@@ -357,12 +393,12 @@ int CRYPTO_remove_all_info(void)
 
        if (is_MemCheck_on()) /* _must_ be true */
                {
-               MemCheck_off(); /* obtains CRYPTO_LOCK_MALLOC2 */
+               MemCheck_off(); /* obtain MALLOC2 lock */
 
                while(pop_info() != NULL)
                        ret++;
 
-               MemCheck_on(); /* releases CRYPTO_LOCK_MALLOC2 */
+               MemCheck_on(); /* release MALLOC2 lock */
                }
        return(ret);
        }
@@ -385,16 +421,17 @@ void CRYPTO_dbg_malloc(void *addr, int num, const char *file, int line,
 
                if (is_MemCheck_on())
                        {
-                       MemCheck_off(); /* obtains CRYPTO_LOCK_MALLOC2 */
+                       MemCheck_off(); /* make sure we hold MALLOC2 lock */
                        if ((m=(MEM *)OPENSSL_malloc(sizeof(MEM))) == NULL)
                                {
                                OPENSSL_free(addr);
-                               MemCheck_on(); /* releases CRYPTO_LOCK_MALLOC2 */
+                               MemCheck_on(); /* release MALLOC2 lock
+                                               * if num_disabled drops to 0 */
                                return;
                                }
                        if (mh == NULL)
                                {
-                               if ((mh=lh_new(mem_hash,mem_cmp)) == NULL)
+                               if ((mh=lh_new(mem_hash, mem_cmp)) == NULL)
                                        {
                                        OPENSSL_free(addr);
                                        OPENSSL_free(m);
@@ -448,7 +485,8 @@ void CRYPTO_dbg_malloc(void *addr, int num, const char *file, int line,
                                OPENSSL_free(mm);
                                }
                err:
-                       MemCheck_on(); /* releases CRYPTO_LOCK_MALLOC2 */
+                       MemCheck_on(); /* release MALLOC2 lock
+                                       * if num_disabled drops to 0 */
                        }
                break;
                }
@@ -467,7 +505,7 @@ void CRYPTO_dbg_free(void *addr, int before_p)
 
                if (is_MemCheck_on() && (mh != NULL))
                        {
-                       MemCheck_off();
+                       MemCheck_off(); /* make sure we hold MALLOC2 lock */
 
                        m.addr=addr;
                        mp=(MEM *)lh_delete(mh,(char *)&m);
@@ -478,13 +516,12 @@ void CRYPTO_dbg_free(void *addr, int before_p)
                                mp->order, mp->addr, mp->num);
 #endif
                                if (mp->app_info != NULL)
-                                       {
-                                       mp->app_info->references--;
-                                       }
+                                       app_info_free(mp->app_info);
                                OPENSSL_free(mp);
                                }
 
-                       MemCheck_on(); /* releases CRYPTO_LOCK_MALLOC2 */
+                       MemCheck_on(); /* release MALLOC2 lock
+                                       * if num_disabled drops to 0 */
                        }
                break;
        case 1:
@@ -518,7 +555,7 @@ void CRYPTO_dbg_realloc(void *addr1, void *addr2, int num,
 
                if (is_MemCheck_on())
                        {
-                       MemCheck_off(); /* obtains CRYPTO_LOCK_MALLOC2 */
+                       MemCheck_off(); /* make sure we hold MALLOC2 lock */
 
                        m.addr=addr1;
                        mp=(MEM *)lh_delete(mh,(char *)&m);
@@ -535,7 +572,8 @@ void CRYPTO_dbg_realloc(void *addr1, void *addr2, int num,
                                lh_insert(mh,(char *)mp);
                                }
 
-                       MemCheck_on(); /* releases CRYPTO_LOCK_MALLOC2 */
+                       MemCheck_on(); /* release MALLOC2 lock
+                                       * if num_disabled drops to 0 */
                        }
                break;
                }
@@ -550,7 +588,7 @@ typedef struct mem_leak_st
        long bytes;
        } MEM_LEAK;
 
-static void print_leak(MEM *m, MEM_LEAK *l)
+static void print_leak(const MEM *m, MEM_LEAK *l)
        {
        char buf[1024];
        char *bufp = buf;
@@ -635,24 +673,27 @@ static void print_leak(MEM *m, MEM_LEAK *l)
 #endif
        }
 
+static IMPLEMENT_LHASH_DOALL_ARG_FN(print_leak, const MEM *, MEM_LEAK *)
+
 void CRYPTO_mem_leaks(BIO *b)
        {
        MEM_LEAK ml;
-       char buf[80];
 
        if (mh == NULL && amih == NULL)
                return;
+
+       MemCheck_off(); /* obtain MALLOC2 lock */
+
        ml.bio=b;
        ml.bytes=0;
        ml.chunks=0;
-       MemCheck_off(); /* obtains CRYPTO_LOCK_MALLOC2 */
        if (mh != NULL)
-               lh_doall_arg(mh,(void (*)())print_leak,(char *)&ml);
+               lh_doall_arg(mh, LHASH_DOALL_ARG_FN(print_leak),
+                               (char *)&ml);
        if (ml.chunks != 0)
                {
-               sprintf(buf,"%ld bytes leaked in %d chunks\n",
-                       ml.bytes,ml.chunks);
-               BIO_puts(b,buf);
+               BIO_printf(b,"%ld bytes leaked in %d chunks\n",
+                          ml.bytes,ml.chunks);
                }
        else
                {
@@ -671,7 +712,15 @@ void CRYPTO_mem_leaks(BIO *b)
                 * void_fn_to_char kludge in CRYPTO_mem_leaks_cb.
                 * Otherwise the code police will come and get us.)
                 */
+               int old_mh_mode;
+
                CRYPTO_w_lock(CRYPTO_LOCK_MALLOC);
+
+               /* avoid deadlock when lh_free() uses CRYPTO_dbg_free(),
+                * which uses CRYPTO_is_mem_check_on */
+               old_mh_mode = mh_mode;
+               mh_mode = CRYPTO_MEM_CHECK_OFF;
+
                if (mh != NULL)
                        {
                        lh_free(mh);
@@ -685,25 +734,26 @@ void CRYPTO_mem_leaks(BIO *b)
                                amih = NULL;
                                }
                        }
+
+               mh_mode = old_mh_mode;
                CRYPTO_w_unlock(CRYPTO_LOCK_MALLOC);
                }
-       MemCheck_on(); /* releases CRYPTO_LOCK_MALLOC2 */
-
-#if 0
-       lh_stats_bio(mh,b);
-       lh_node_stats_bio(mh,b);
-       lh_node_usage_stats_bio(mh,b);
-#endif
+       MemCheck_on(); /* release MALLOC2 lock */
        }
 
-#ifndef NO_FP_API
+#ifndef OPENSSL_NO_FP_API
 void CRYPTO_mem_leaks_fp(FILE *fp)
        {
        BIO *b;
 
        if (mh == NULL) return;
-       if ((b=BIO_new(BIO_s_file())) == NULL)
-               return;
+       /* Need to turn off memory checking when allocated BIOs ... especially
+        * as we're creating them at a time when we're trying to check we've not
+        * left anything un-free()'d!! */
+       MemCheck_off();
+       b = BIO_new(BIO_s_file());
+       MemCheck_on();
+       if(!b) return;
        BIO_set_fp(b,fp,BIO_NOCLOSE);
        CRYPTO_mem_leaks(b);
        BIO_free(b);
@@ -715,16 +765,20 @@ void CRYPTO_mem_leaks_fp(FILE *fp)
 /* FIXME: We really don't allow much to the callback.  For example, it has
    no chance of reaching the info stack for the item it processes.  Should
    it really be this way?  -- Richard Levitte */
-static void cb_leak(MEM *m,
-                   void (**cb)(unsigned long, const char *, int, int, void *))
+/* NB: The prototypes have been typedef'd to CRYPTO_MEM_LEAK_CB inside crypto.h
+ * If this code is restructured, remove the callback type if it is no longer
+ * needed. -- Geoff Thorpe */
+static void cb_leak(const MEM *m, CRYPTO_MEM_LEAK_CB **cb)
        {
        (**cb)(m->order,m->file,m->line,m->num,m->addr);
        }
 
-void CRYPTO_mem_leaks_cb(void (*cb)(unsigned long, const char *, int, int, void *))
+static IMPLEMENT_LHASH_DOALL_ARG_FN(cb_leak, const MEM *, CRYPTO_MEM_LEAK_CB **)
+
+void CRYPTO_mem_leaks_cb(CRYPTO_MEM_LEAK_CB *cb)
        {
        if (mh == NULL) return;
        CRYPTO_w_lock(CRYPTO_LOCK_MALLOC2);
-       lh_doall_arg(mh,(void (*)())cb_leak,(void *)&cb);
+       lh_doall_arg(mh, LHASH_DOALL_ARG_FN(cb_leak), &cb);
        CRYPTO_w_unlock(CRYPTO_LOCK_MALLOC2);
        }