openldap/libraries/liblber/memory.c
Kurt Zeilenga 6c6ecc15d5 Add comment concern appropriate use of LDAP_MEMORY_DEBUG
(basically, it's for testing internals, don't enable it otherwise)
2000-02-16 23:51:34 +00:00

461 lines
7.4 KiB
C

/* $OpenLDAP$ */
/*
* Copyright 1998-1999 The OpenLDAP Foundation, All Rights Reserved.
* COPYING RESTRICTIONS APPLY, see COPYRIGHT file
*/
#include "portable.h"
#include <ac/stdlib.h>
#include <ac/string.h>
#include "lber-int.h"
#if LDAP_MEMORY_DEBUG
/*
* LDAP_MEMORY_DEBUG should only be enabled for the purposes of
* debugging memory management within OpenLDAP libraries and slapd.
* It should only be enabled by an experienced developer as it
* causes the inclusion of numerous assert()'s, many of which may
* be triggered by a prefectly valid program.
*
* The code behind this macro is subject to change as needed to
* support this testing.
*/
struct ber_mem_hdr {
union bmu_align_u {
ber_len_t bmu_len_t;
ber_tag_t bmu_tag_t;
ber_int_t bmu_int_t;
size_t bmu_size_t;
void * bmu_voidp;
double bmu_double;
long bmu_long;
long (*bmu_funcp)( double );
char bmu_char[4];
} ber_align;
#define bm_junk ber_align.bmu_len_t
#define bm_data ber_align.bmu_char[1]
};
#define BER_MEM_JUNK 0xdeaddadaU
static const struct ber_mem_hdr ber_int_mem_hdr = { BER_MEM_JUNK };
#define BER_MEM_BADADDR ((void *) &ber_int_mem_hdr.bm_data)
#define BER_MEM_VALID(p) do { \
assert( (p) != BER_MEM_BADADDR ); \
assert( (p) != (void *) &ber_int_mem_hdr ); \
} while(0)
#else
#define BER_MEM_VALID(p) /* no-op */
#endif
BerMemoryFunctions *ber_int_memory_fns = NULL;
#if 0 && defined( LDAP_MEMORY_DEBUG )
void
ber_int_memfree( void **p )
{
assert( p != NULL );
BER_MEM_VALID( *p );
ber_memfree( p );
*p = BER_MEM_BADADDR;
}
#endif
void
ber_memfree( void *p )
{
ber_int_options.lbo_valid = LBER_INITIALIZED;
if( p == NULL ) {
return;
}
BER_MEM_VALID( p );
if( ber_int_memory_fns == NULL ) {
#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;
free( mh );
#else
free( p );
#endif
return;
}
assert( ber_int_memory_fns->bmf_free );
(*ber_int_memory_fns->bmf_free)( p );
}
void
ber_memvfree( void **vec )
{
int i;
ber_int_options.lbo_valid = LBER_INITIALIZED;
if( vec == NULL ) {
return;
}
BER_MEM_VALID( vec );
for ( i = 0; vec[i] != NULL; i++ ) {
LBER_FREE( vec[i] );
}
LBER_FREE( vec );
}
void *
ber_memalloc( ber_len_t s )
{
void *new;
ber_int_options.lbo_valid = LBER_INITIALIZED;
#ifdef LDAP_MEMORY_DEBUG
assert( s != 0 );
#endif
if( s == 0 ) {
return NULL;
}
if( ber_int_memory_fns == NULL ) {
#ifdef LDAP_MEMORY_DEBUG
struct ber_mem_hdr *mh = malloc(s + sizeof(struct ber_mem_hdr));
if( mh == NULL ) return NULL;
mh->bm_junk = BER_MEM_JUNK;
BER_MEM_VALID( &mh[1] );
new = &mh[1];
#else
new = malloc( s );
#endif
} else {
new = (*ber_int_memory_fns->bmf_malloc)( s );
}
if( new == NULL ) {
ber_errno = LBER_ERROR_MEMORY;
}
return new;
}
void *
ber_memcalloc( ber_len_t n, ber_len_t s )
{
void *new;
ber_int_options.lbo_valid = LBER_INITIALIZED;
#ifdef LDAP_MEMORY_DEBUG
assert( n != 0 && s != 0);
#endif
if( n == 0 || s == 0 ) {
return NULL;
}
if( ber_int_memory_fns == NULL ) {
#ifdef LDAP_MEMORY_DEBUG
struct ber_mem_hdr *mh = calloc(1,
(n * s) + sizeof(struct ber_mem_hdr) );
mh->bm_junk = BER_MEM_JUNK;
BER_MEM_VALID( &mh[1] );
new = &mh[1];
#else
new = calloc( n, s );
#endif
} else {
new = (*ber_int_memory_fns->bmf_calloc)( n, s );
}
if( new == NULL ) {
ber_errno = LBER_ERROR_MEMORY;
}
return new;
}
void *
ber_memrealloc( void* p, ber_len_t s )
{
void *new;
ber_int_options.lbo_valid = LBER_INITIALIZED;
/* realloc(NULL,s) -> malloc(s) */
if( p == NULL ) {
return ber_memalloc( s );
}
/* realloc(p,0) -> free(p) */
if( s == 0 ) {
ber_memfree( p );
return NULL;
}
BER_MEM_VALID( p );
if( ber_int_memory_fns == NULL ) {
#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 );
p = realloc( mh, s + sizeof(struct ber_mem_hdr) );
if( p != NULL ) {
mh = p;
assert( mh->bm_junk == BER_MEM_JUNK );
BER_MEM_VALID( &mh[1] );
new = &mh[1];
}
#else
new = realloc( p, s );
#endif
} else {
new = (*ber_int_memory_fns->bmf_realloc)( p, s );
}
if( new == NULL ) {
ber_errno = LBER_ERROR_MEMORY;
}
return new;
}
void
ber_bvfree( struct berval *bv )
{
ber_int_options.lbo_valid = LBER_INITIALIZED;
if( bv == NULL ) {
return;
}
BER_MEM_VALID( bv );
if ( bv->bv_val != NULL )
LBER_FREE( bv->bv_val );
LBER_FREE( (char *) bv );
}
void
ber_bvecfree( struct berval **bv )
{
int i;
ber_int_options.lbo_valid = LBER_INITIALIZED;
if( bv == NULL ) {
return;
}
BER_MEM_VALID( bv );
for ( i = 0; bv[i] != NULL; i++ )
ber_bvfree( bv[i] );
LBER_FREE( (char *) bv );
}
int
ber_bvecadd( struct berval ***bvec, struct berval *bv )
{
ber_len_t i;
struct berval **new;
ber_int_options.lbo_valid = LBER_INITIALIZED;
if( bvec == NULL ) {
if( bv == NULL ) {
/* nothing to add */
return 0;
}
*bvec = ber_memalloc( 2 * sizeof(struct berval *) );
if( *bvec == NULL ) {
return -1;
}
(*bvec)[0] = bv;
(*bvec)[1] = NULL;
return 1;
}
BER_MEM_VALID( bvec );
/* count entries */
for ( i = 0; bvec[i] != NULL; i++ ) {
/* EMPTY */;
}
if( bv == NULL ) {
return i;
}
new = ber_memrealloc( *bvec, (i+2) * sizeof(struct berval *));
if( new == NULL ) {
return -1;
}
*bvec = new;
(*bvec)[i++] = bv;
(*bvec)[i] = NULL;
return i;
}
struct berval *
ber_bvdup(
LDAP_CONST struct berval *bv )
{
struct berval *new;
ber_int_options.lbo_valid = LBER_INITIALIZED;
if( bv == NULL ) {
ber_errno = LBER_ERROR_PARAM;
return NULL;
}
if(( new = LBER_MALLOC( sizeof(struct berval) )) == NULL ) {
ber_errno = LBER_ERROR_MEMORY;
return NULL;
}
if ( bv->bv_val == NULL ) {
new->bv_val = NULL;
new->bv_len = 0;
return new;
}
if(( new->bv_val = LBER_MALLOC( bv->bv_len + 1 )) == NULL ) {
ber_errno = LBER_ERROR_MEMORY;
LBER_FREE( new );
return NULL;
}
SAFEMEMCPY( new->bv_val, bv->bv_val, bv->bv_len );
new->bv_val[bv->bv_len] = '\0';
new->bv_len = bv->bv_len;
return( new );
}
struct berval *
ber_bvstr(
LDAP_CONST char *s )
{
struct berval *new;
ber_int_options.lbo_valid = LBER_INITIALIZED;
if( s == NULL ) {
ber_errno = LBER_ERROR_PARAM;
return NULL;
}
if(( new = LBER_MALLOC( sizeof(struct berval) )) == NULL ) {
ber_errno = LBER_ERROR_MEMORY;
return NULL;
}
if ( *s == '\0' ) {
new->bv_val = NULL;
new->bv_len = 0;
return new;
}
new->bv_val = (char *) s;
new->bv_len = strlen( s );
return( new );
}
struct berval *
ber_bvstrdup(
LDAP_CONST char *s )
{
struct berval *new;
char *p;
ber_int_options.lbo_valid = LBER_INITIALIZED;
if( s == NULL ) {
ber_errno = LBER_ERROR_PARAM;
return NULL;
}
p = LBER_STRDUP( s );
if( p == NULL ) {
ber_errno = LBER_ERROR_MEMORY;
return NULL;
}
new = ber_bvstr( p );
if( new == NULL || *p == '\0' ) {
LBER_FREE( p );
}
return( new );
}
char *
ber_strdup( LDAP_CONST char *s )
{
char *p;
size_t len;
ber_int_options.lbo_valid = LBER_INITIALIZED;
#ifdef LDAP_MEMORY_DEBUG
assert(s != NULL); /* bv damn better point to something */
#endif
if( s == NULL ) {
ber_errno = LBER_ERROR_PARAM;
return( NULL );
}
len = strlen( s ) + 1;
if ( (p = LBER_MALLOC( len )) == NULL ) {
ber_errno = LBER_ERROR_MEMORY;
return( NULL );
}
SAFEMEMCPY( p, s, len );
return( p );
}