Subversion Repositories tendra.SVN

/*
                 Crown Copyright (c) 1997
    
    This TenDRA(r) Computer Program is subject to Copyright
    owned by the United Kingdom Secretary of State for Defence
    acting through the Defence Evaluation and Research Agency
    (DERA).  It is made available to Recipients with a
    royalty-free licence for its use, reproduction, transfer
    to other parties and amendment for any purpose not excluding
    product development provided that any such use et cetera
    shall be deemed to be acceptance of the following conditions:-
    
        (1) Its Recipients shall ensure that this Notice is
        reproduced upon any copies or amended versions of it;
    
        (2) Any amended version of it shall be clearly marked to
        show both the nature of and the organisation responsible
        for the relevant amendment or amendments;
    
        (3) Its onward transfer from a recipient to another
        party shall be deemed to be that party's acceptance of
        these conditions;
    
        (4) DERA gives no warranty or assurance as to its
        quality or suitability for any purpose and DERA accepts
        no liability whatsoever in relation to any use to which
        it may be put.
*/


/**** dalloc.h --- Memory allocation and deallocation.
 *
 ** Author: Steve Folkes <smf@hermes.mod.uk>
 *
 **** Commentary:
 *
 ***=== INTRODUCTION =========================================================
 *
 * This file specifies the interface to a dynamic memory allocation facility.
 * All dynamically allocated objects are initialised with zeroes, but
 * non-integer typed fields will still need to be initialised explicitly.
 *
 * If the macro ``PO_DALLOC_DEBUG_ALIGN'' is defined, then extra debugging
 * information is added into the space allocated to help detect errors in
 * memory management.  If this macro is defined, it requires two functions to
 * be provided:
 *
 *      void                            E_dalloc_multi_deallocate
 *                      PROTO_S ((GenericP, CStringP, unsigned, CStringP,
 *                                unsigned));
 *      void                            E_dalloc_corrupt_block
 *                      PROTO_S ((GenericP, CStringP, unsigned));
 *
 * The first function will be called if a block is deallocated more than once.
 * It takes the block's address, and the file and line number of the
 * deallocation and allocation of the block as arguments.  The second function
 * is called if a block is corrupt when deallocated.  It takes the address of
 * the block and the file and line number of the deallocation of the block as
 * arguments.  Neither of these functions should return.
 *
 * This debugging mode should not be used on software that is shipped.  It has
 * machine specific implementations, and may be quite inefficient.
 *
 ***=== MACROS ===============================================================
 *
 ** Macro:      ALLOCATE (type)
 ** Exceptions: XX_dalloc_no_memory
 *
 * This macro allocates an object of the specified type.  A pointer to the
 * object is returned.
 *
 ** Macro:      ALLOCATE_VECTOR (type, length)
 ** Exceptions: XX_dalloc_no_memory
 *
 * This macro allocates a vector of the specified length containing objects of
 * the specified type.  A pointer to the first element in the vector is
 * returned.
 *
 ** Macro:      DEALLOCATE (pointer)
 ** Exceptions:
 *
 * This macro deallocates the specified pointer.  If the pointer is a null
 * pointer (``NIL (SomeTypeP)''), this does nothing.
 *
 ***=== EXCEPTIONS ===========================================================
 *
 ** Exception:  XX_dalloc_no_memory
 *
 * This exception is raised if there is not enough memory to allocate an
 * object (or a vector of objects).
 *
 **** Change Log:
 * $Log: dalloc.h,v $
 * Revision 1.1.1.1  1998/01/17  15:57:45  release
 * First version to be checked into rolling release.
 *
 * Revision 1.2  1994/12/12  11:45:30  smf
 * Performing changes for 'CR94_178.sid+tld-update' - bringing in line with
 * OSSG C Coding Standards.
 *
 * Revision 1.1.1.1  1994/07/25  16:06:09  smf
 * Initial import of os-interface shared files.
 *
**/

/****************************************************************************/

#ifndef H_DALLOC
#define H_DALLOC

#include "os-interface.h"
#include "exception.h"

/*--------------------------------------------------------------------------*/

extern ExceptionP               XX_dalloc_no_memory;

/*--------------------------------------------------------------------------*/

#ifdef PO_DALLOC_DEBUG_ALIGN

extern void                     E_dalloc_multi_deallocate
        PROTO_S ((GenericP, CStringP, unsigned, CStringP, unsigned));
extern void                     E_dalloc_corrupt_block
        PROTO_S ((GenericP, CStringP, unsigned));
extern GenericP                 X__dalloc_allocate
        PROTO_S ((SizeT, SizeT, CStringP, unsigned));
extern void                     X__dalloc_deallocate
        PROTO_S ((GenericP, CStringP, unsigned));

#else

extern GenericP                 X__dalloc_allocate
        PROTO_S ((SizeT, SizeT));

#endif /* defined (PO_DALLOC_DEBUG_ALIGN) */

/*--------------------------------------------------------------------------*/

#ifdef PO_DALLOC_DEBUG_ALIGN

#define ALLOCATE(type) \
((type *) X__dalloc_allocate (sizeof (type), (SizeT) 1, __FILE__, \
                              (unsigned) __LINE__))

#define ALLOCATE_VECTOR(type,length) \
((type *) X__dalloc_allocate (sizeof (type), (SizeT) (length), __FILE__, \
                              (unsigned) __LINE__))

#define DEALLOCATE(pointer) \
X__dalloc_deallocate ((GenericP) (pointer), __FILE__, (unsigned) __LINE__)

#else

#define ALLOCATE(type) \
((type *) X__dalloc_allocate (sizeof (type), (SizeT) 1))

#define ALLOCATE_VECTOR(type,length) \
((type *) X__dalloc_allocate (sizeof (type), (SizeT) (length)))

#define DEALLOCATE(pointer) \
if (pointer) {free ((GenericP) (pointer));}

#endif /* defined (PO_DALLOC_DEBUG_ALIGN) */

#endif /* !defined (H_DALLOC) */