From: Kurt Zeilenga Date: Tue, 4 Jul 2000 18:47:06 +0000 (+0000) Subject: Add Steve Sonntag's (Novell) memory debugging extensions X-Git-Tag: LDBM_PRE_GIANT_RWLOCK~2485 X-Git-Url: https://git.sur5r.net/?a=commitdiff_plain;h=060ee8ee88d0394aa742ba075443e4cb5eb5fa33;p=openldap Add Steve Sonntag's (Novell) memory debugging extensions --- diff --git a/include/lber.h b/include/lber.h index 0b2a826203..2ee98d8246 100644 --- a/include/lber.h +++ b/include/lber.h @@ -101,6 +101,9 @@ LDAP_BEGIN_DECL #define LBER_OPT_ERROR_FN 0x8003 #define LBER_OPT_LOG_PRINT_FILE 0x8004 +/* get/set Memory Debug options */ +#define LBER_OPT_MEMORY_INUSE 0x8005 /* for memory debugging */ + typedef int* (*BER_ERRNO_FN) LDAP_P(( void )); typedef void (*BER_LOG_PRINT_FN) LDAP_P(( LDAP_CONST char *buf )); diff --git a/libraries/liblber/lber-int.h b/libraries/liblber/lber-int.h index c658f52feb..6ee5e7389e 100644 --- a/libraries/liblber/lber-int.h +++ b/libraries/liblber/lber-int.h @@ -30,6 +30,7 @@ struct lber_options { short lbo_valid; unsigned short lbo_options; int lbo_debug; + long lbo_meminuse; }; #define LBER_UNINITIALIZED 0x0 diff --git a/libraries/liblber/memory.c b/libraries/liblber/memory.c index 3b4be421ba..a500569cdc 100644 --- a/libraries/liblber/memory.c +++ b/libraries/liblber/memory.c @@ -10,6 +10,13 @@ #include "lber-int.h" +#ifdef LDAP_MEMORY_TRACE +# ifndef LDAP_MEMORY_DEBUG +# define LDAP_MEMORY_DEBUG 1 +# endif +#include +#endif + #if LDAP_MEMORY_DEBUG /* * LDAP_MEMORY_DEBUG should only be enabled for the purposes of @@ -23,7 +30,12 @@ */ struct ber_mem_hdr { - union bmu_align_u { + ber_int_t bm_top; /* Pattern to detect buf overrun from prev buffer */ + ber_int_t bm_length; /* Length of user allocated area */ +#ifdef LDAP_MEMORY_TRACE + ber_int_t bm_sequence; /* Allocation sequence number */ +#endif + union bmu_align_u { /* Force alignment, pattern to detect back clobber */ ber_len_t bmu_len_t; ber_tag_t bmu_tag_t; ber_int_t bmu_int_t; @@ -33,13 +45,61 @@ struct ber_mem_hdr { double bmu_double; long bmu_long; long (*bmu_funcp)( double ); - char bmu_char[4]; + unsigned char bmu_char[4]; } ber_align; #define bm_junk ber_align.bmu_len_t #define bm_data ber_align.bmu_char[1] +#define bm_char ber_align.bmu_char }; + +/* Pattern at top of allocated space */ #define BER_MEM_JUNK 0xdeaddadaU -static const struct ber_mem_hdr ber_int_mem_hdr = { BER_MEM_JUNK }; + +static const struct ber_mem_hdr ber_int_mem_hdr = { BER_MEM_JUNK, 0, 0 }; + +/* Note sequence and ber_int_options.lbu_meminuse are counters, but are not + * thread safe. If you want to use these values for multithreaded applications, + * you must put mutexes around them, otherwise they will have incorrect values. + * When debugging, if you sort the debug output, the sequence number will + * put allocations/frees together. It is then a simple matter to write a script + * to find any allocations that don't have a buffer free function. + */ +#ifdef LDAP_MEMORY_TRACE +static ber_int_t sequence = 0; +#endif + +/* Pattern placed just before user data */ +static unsigned char toppattern[4] = { 0xde, 0xad, 0xba, 0xde }; +/* Pattern placed just after user data */ +static unsigned char endpattern[4] = { 0xd1, 0xed, 0xde, 0xca }; + +#define mbu_len sizeof(ber_int_mem_hdr.ber_align) + +/* Test if pattern placed just before user data is good */ +#define testdatatop(val) ( \ + *(val->bm_char+mbu_len-4)==toppattern[0] && \ + *(val->bm_char+mbu_len-3)==toppattern[1] && \ + *(val->bm_char+mbu_len-2)==toppattern[2] && \ + *(val->bm_char+mbu_len-1)==toppattern[3] ) + +/* Place pattern just before user data */ +#define setdatatop(val) *(val->bm_char+mbu_len-4)=toppattern[0]; \ + *(val->bm_char+mbu_len-3)=toppattern[1]; \ + *(val->bm_char+mbu_len-2)=toppattern[2]; \ + *(val->bm_char+mbu_len-1)=toppattern[3]; + +/* Test if pattern placed just after user data is good */ +#define testend(val) ( *((unsigned char *)val+0)==endpattern[0] && \ + *((unsigned char *)val+1)==endpattern[1] && \ + *((unsigned char *)val+2)==endpattern[2] && \ + *((unsigned char *)val+3)==endpattern[3] ) + +/* Place pattern just after user data */ +#define setend(val) *((unsigned char *)val+0)=endpattern[0]; \ + *((unsigned char *)val+1)=endpattern[1]; \ + *((unsigned char *)val+2)=endpattern[2]; \ + *((unsigned char *)val+3)=endpattern[3]; + #define BER_MEM_BADADDR ((void *) &ber_int_mem_hdr.bm_data) #define BER_MEM_VALID(p) do { \ assert( (p) != BER_MEM_BADADDR ); \ @@ -80,9 +140,17 @@ ber_memfree( void *p ) #ifdef LDAP_MEMORY_DEBUG struct ber_mem_hdr *mh = (struct ber_mem_hdr *) ((char *)p - sizeof(struct ber_mem_hdr)); - - assert( mh->bm_junk == BER_MEM_JUNK ); - mh->bm_junk = ~BER_MEM_JUNK; + assert( mh->bm_top == BER_MEM_JUNK); + assert( testdatatop( mh)); + assert( testend( (char *)&mh[1] + mh->bm_length) ); + ber_int_options.lbo_meminuse -= mh->bm_length; + +#ifdef LDAP_MEMORY_TRACE + fprintf(stderr, "0x%08x 0x%08x -f- %d ber_memfree %d\n", + mh->bm_sequence, mh, mh->bm_length, ber_int_options.lbo_meminuse); +#endif + /* Fill the free space with poison */ + memset( mh, 0xff, mh->bm_length + sizeof(struct ber_mem_hdr) + sizeof( ber_int_t)); free( mh ); #else free( p ); @@ -133,11 +201,23 @@ ber_memalloc( ber_len_t s ) if( ber_int_memory_fns == NULL ) { #ifdef LDAP_MEMORY_DEBUG - struct ber_mem_hdr *mh = malloc(s + sizeof(struct ber_mem_hdr)); - + struct ber_mem_hdr *mh = malloc(s + sizeof(struct ber_mem_hdr) + sizeof( ber_int_t)); if( mh == NULL ) return NULL; - mh->bm_junk = BER_MEM_JUNK; + mh->bm_top = BER_MEM_JUNK; + mh->bm_length = s; + setdatatop( mh); + setend( (char *)&mh[1] + mh->bm_length ); + + ber_int_options.lbo_meminuse += mh->bm_length; /* Count mem inuse */ + +#ifdef LDAP_MEMORY_TRACE + mh->bm_sequence = sequence++; + fprintf(stderr, "0x%08x 0x%08x -a- %d ber_memalloc %d\n", + mh->bm_sequence, mh, mh->bm_length, ber_int_options.lbo_meminuse); +#endif + /* poison new memory */ + memset( (char *)&mh[1], 0xff, s); BER_MEM_VALID( &mh[1] ); new = &mh[1]; @@ -173,10 +253,21 @@ ber_memcalloc( ber_len_t n, ber_len_t s ) if( ber_int_memory_fns == NULL ) { #ifdef LDAP_MEMORY_DEBUG struct ber_mem_hdr *mh = calloc(1, - (n * s) + sizeof(struct ber_mem_hdr) ); + (n * s) + sizeof(struct ber_mem_hdr) + sizeof(ber_int_t) ); + if( mh == NULL ) return NULL; + + mh->bm_top = BER_MEM_JUNK; + mh->bm_length = n*s; + setdatatop( mh); + setend( (char *)&mh[1] + mh->bm_length ); - mh->bm_junk = BER_MEM_JUNK; + ber_int_options.lbo_meminuse += mh->bm_length; +#ifdef LDAP_MEMORY_TRACE + mh->bm_sequence = sequence++; + fprintf(stderr, "0x%08x 0x%08x -a- %d ber_memcalloc %d\n", + mh->bm_sequence, mh, mh->bm_length, ber_int_options.lbo_meminuse); +#endif BER_MEM_VALID( &mh[1] ); new = &mh[1]; #else @@ -216,20 +307,38 @@ ber_memrealloc( void* p, ber_len_t s ) if( ber_int_memory_fns == NULL ) { #ifdef LDAP_MEMORY_DEBUG + ber_int_t oldlen; struct ber_mem_hdr *mh = (struct ber_mem_hdr *) ((char *)p - sizeof(struct ber_mem_hdr)); - assert( mh->bm_junk == BER_MEM_JUNK ); - - p = realloc( mh, s + sizeof(struct ber_mem_hdr) ); + assert( mh->bm_top == BER_MEM_JUNK); + assert( testdatatop( mh)); + assert( testend( (char *)&mh[1] + mh->bm_length) ); + oldlen = mh->bm_length; + + p = realloc( mh, s + sizeof(struct ber_mem_hdr) + sizeof(ber_int_t) ); + if( p == NULL ) { + ber_errno = LBER_ERROR_MEMORY; + return NULL; + } - if( p != NULL ) { mh = p; + mh->bm_length = s; + setend( (char *)&mh[1] + mh->bm_length ); + if( (s - oldlen) > 0 ) { + /* poison any new memory */ + memset( (char *)&mh[1] + oldlen, 0xff, s - oldlen); + } - assert( mh->bm_junk == BER_MEM_JUNK ); + assert( mh->bm_top == BER_MEM_JUNK); + assert( testdatatop( mh)); + ber_int_options.lbo_meminuse += s - oldlen; +#ifdef LDAP_MEMORY_TRACE + fprintf(stderr, "0x%08x 0x%08x -a- %d ber_memrealloc %d\n", + mh->bm_sequence, mh, mh->bm_length, ber_int_options.lbo_meminuse); +#endif BER_MEM_VALID( &mh[1] ); - new = &mh[1]; - } + return &mh[1]; #else new = realloc( p, s ); #endif diff --git a/libraries/liblber/options.c b/libraries/liblber/options.c index dc61707dfd..0b6ded358f 100644 --- a/libraries/liblber/options.c +++ b/libraries/liblber/options.c @@ -36,6 +36,20 @@ ber_get_option( if(option == LBER_OPT_BER_DEBUG) { * (int *) outvalue = ber_int_debug; return LBER_OPT_SUCCESS; + } else if(option == LBER_OPT_MEMORY_INUSE) { + /* The memory inuse is a global variable on kernal implementations. + * This means that memory debug is shared by all LDAP processes + * so for this variable to have much meaning, only one LDAP process + * should be running and memory inuse should be initialized to zero + * using the lber_set_option() function during startup. + * The counter is not accurate for multithreaded ldap applications. + */ +#ifdef LDAP_MEMORY_DEBUG + * (int *) outvalue = ber_int_options.lbo_meminuse; + return LBER_OPT_SUCCESS; +#else + return LBER_OPT_ERROR; +#endif } ber_errno = LBER_ERROR_PARAM; @@ -135,6 +149,20 @@ ber_set_option( } else if(option == LBER_OPT_LOG_PRINT_FILE) { ber_pvt_err_file = (void *) invalue; return LBER_OPT_SUCCESS; + } else if(option == LBER_OPT_MEMORY_INUSE) { + /* The memory inuse is a global variable on kernal implementations. + * This means that memory debug is shared by all LDAP processes + * so for this variable to have much meaning, only one LDAP process + * should be running and memory inuse should be initialized to zero + * using the lber_set_option() function during startup. + * The counter is not accurate for multithreaded applications. + */ +#ifdef LDAP_MEMORY_DEBUG + ber_int_options.lbo_meminuse = * (int *) invalue; + return LBER_OPT_SUCCESS; +#else + return LBER_OPT_ERROR; +#endif } ber_errno = LBER_ERROR_PARAM;