#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;
+static unsigned long order = 0; /* number of memory requests */
+static LHASH *mh=NULL; /* hash-table of memory requests (address as key) */
-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;
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)
{
{
/* 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).
*/
return(ret);
}
-int CRYPTO_mem_check_on(void)
+int CRYPTO_is_mem_check_on(void)
{
int ret = 0;
}
-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(void)
{
return options;
}
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)
return(ret);
}
-static APP_INFO *remove_info()
+static APP_INFO *pop_info()
{
APP_INFO tmp;
APP_INFO *ret = NULL;
if (amih != NULL)
{
tmp.thread=CRYPTO_thread_id();
- if ((ret=(APP_INFO *)lh_delete(amih,(char *)&tmp)) != NULL)
+ if ((ret=(APP_INFO *)lh_delete(amih,&tmp)) != NULL)
{
APP_INFO *next=ret->next;
#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();
}
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)
{
#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();
}
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);
}
{
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);
}
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)
Free(mm);
}
err:
- MemCheck_on();
+ MemCheck_on(); /* releases CRYPTO_LOCK_MALLOC2 */
}
break;
}
Free(mp);
}
- MemCheck_on();
+ MemCheck_on(); /* releases CRYPTO_LOCK_MALLOC2 */
}
break;
case 1:
if (is_MemCheck_on())
{
- MemCheck_off();
+ MemCheck_off(); /* obtains CRYPTO_LOCK_MALLOC2 */
m.addr=addr1;
mp=(MEM *)lh_delete(mh,(char *)&m);
lh_insert(mh,(char *)mp);
}
- MemCheck_on();
+ MemCheck_on(); /* releases CRYPTO_LOCK_MALLOC2 */
}
break;
}
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;
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);
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
MEM_LEAK ml;
char buf[80];
- if (mh == NULL) return;
+ if (mh == NULL && amih == NULL)
+ return;
ml.bio=b;
ml.bytes=0;
ml.chunks=0;
- CRYPTO_w_lock(CRYPTO_LOCK_MALLOC2);
- lh_doall_arg(mh,(void (*)())print_leak,(char *)&ml);
- CRYPTO_w_unlock(CRYPTO_LOCK_MALLOC2);
+ MemCheck_off(); /* obtains CRYPTO_LOCK_MALLOC2 */
+ if (mh != NULL)
+ lh_doall_arg(mh,(void (*)())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);
}
+ else
+ {
+ /* Make sure that, if we found no leaks, memory-leak debugging itself
+ * does not introduce memory leaks (which might irritate
+ * external debugging tools).
+ * (When someone enables leak checking, but does not call
+ * this function, we declare it to be their fault.)
+ *
+ * XXX This should be in CRYPTO_mem_leaks_cb,
+ * and CRYPTO_mem_leaks should be implemented by
+ * using CRYPTO_mem_leaks_cb.
+ * (Also their should be a variant of lh_doall_arg
+ * that takes a function pointer instead of a void *;
+ * this would obviate the ugly and illegal
+ * void_fn_to_char kludge in CRYPTO_mem_leaks_cb.
+ * Otherwise the code police will come and get us.)
+ */
+ CRYPTO_w_lock(CRYPTO_LOCK_MALLOC);
+ if (mh != NULL)
+ {
+ lh_free(mh);
+ mh = NULL;
+ }
+ if (amih != NULL)
+ {
+ if (lh_num_items(amih) == 0)
+ {
+ lh_free(amih);
+ amih = NULL;
+ }
+ }
+ CRYPTO_w_unlock(CRYPTO_LOCK_MALLOC);
+ }
+ MemCheck_on(); /* releases CRYPTO_LOCK_MALLOC2 */
#if 0
lh_stats_bio(mh,b);
#endif
}
-static void (*mem_cb)()=NULL;
+union void_fn_to_char_u
+ {
+ char *char_p;
+ void (*fn_p)();
+ };
static void cb_leak(MEM *m, char *cb)
{
- void (*mem_callback)()=(void (*)())cb;
- mem_callback(m->order,m->file,m->line,m->num,m->addr);
+ union void_fn_to_char_u mem_callback;
+
+ mem_callback.char_p=cb;
+ mem_callback.fn_p(m->order,m->file,m->line,m->num,m->addr);
}
void CRYPTO_mem_leaks_cb(void (*cb)())
{
+ union void_fn_to_char_u mem_cb;
+
if (mh == NULL) return;
CRYPTO_w_lock(CRYPTO_LOCK_MALLOC2);
- mem_cb=cb;
- lh_doall_arg(mh,(void (*)())cb_leak,(char *)mem_cb);
- mem_cb=NULL;
+ mem_cb.fn_p=cb;
+ lh_doall_arg(mh,(void (*)())cb_leak,mem_cb.char_p);
+ mem_cb.char_p=NULL;
CRYPTO_w_unlock(CRYPTO_LOCK_MALLOC2);
}
projects / openssl.git / blobdiff