rtxMemory.h

Go to the documentation of this file.

/*
 * Copyright (c) 2003-2022 Objective Systems, Inc.
 *
 * This software is furnished under a license and may be used and copied
 * only in accordance with the terms of such license and with the
 * inclusion of the above copyright notice. This software or any other
 * copies thereof may not be provided or otherwise made available to any
 * other person. No title to and ownership of the software is hereby
 * transferred.
 *
 * The information in this software is subject to change without notice
 * and should not be construed as a commitment by Objective Systems, Inc.
 *
 * PROPRIETARY NOTICE
 *
 * This software is an unpublished work subject to a confidentiality agreement
 * and is protected by copyright and trade secret law.  Unauthorized copying,
 * redistribution or other use of this work is prohibited.
 *
 * The above notice of copyright on this source code product does not indicate
 * any actual or intended publication of such source code.
 *
 *****************************************************************************/
#ifndef __RTXMEMORY_H__
#define __RTXMEMORY_H__

#include "rtxsrc/rtxContext.h"

/*
 * Uncomment this definition before building the C or C++ run-time
 * libraries to enable compact memory management.  This will have a
 * smaller code footprint than the standard memory management, however,
 * the performance may not be as good.
 */
/*#define _MEMCOMPACT*/

#define RT_MH_DONTKEEPFREE 0x1
#define RT_MH_VALIDATEPTR  0x2
#define RT_MH_CHECKHEAP    0x4
#define RT_MH_TRACE        0x8
#define RT_MH_DIAG         0x10
#define RT_MH_DIAG_DEBUG   0x20
#define RT_MH_ZEROONFREE   0x40
#define RT_MH_ZEROARRAY    0x80
#define RT_MH_SYSALLOC     0x100
#define RT_MH_TRACE_FREELIST 0x200  /* enable printing of the free element list
                                       at certain junctures in the memory
                                       management code.
                                       Requires building with _MEMTRACE */

#define OSRTMH_PROPID_DEFBLKSIZE   1
#define OSRTMH_PROPID_SETFLAGS     2
#define OSRTMH_PROPID_CLEARFLAGS   3
#define OSRTMH_PROPID_KEEPFREEUNITS 4

#define OSRTMH_PROPID_USER         10

#define OSRTXM_K_MEMBLKSIZ         (4*1024)

#define OSRTALLOCTYPE(pctxt,type) \
(type*) rtxMemHeapAlloc (&(pctxt)->pMemHeap, sizeof(type))

#define OSRTALLOCTYPEZ(pctxt,type) \
(type*) rtxMemHeapAllocZ (&(pctxt)->pMemHeap, sizeof(type))

#define OSRTREALLOCARRAY(pctxt,pseqof,type) do {\
if (sizeof(type)*(pseqof)->n < (pseqof)->n) return RTERR_NOMEM; \
if (((pseqof)->elem = (type*) rtxMemHeapRealloc \
(&(pctxt)->pMemHeap, (pseqof)->elem, sizeof(type)*(pseqof)->n)) == 0) \
return RTERR_NOMEM; \
} while (0)

#ifndef _NO_MALLOC
#define OSCRTMALLOC0(nbytes)       malloc(nbytes)
#define OSCRTFREE0(ptr)            free(ptr)
#else

#ifdef _NO_THREADS
extern EXTERNRT OSCTXT g_ctxt;

#define OSCRTMALLOC0(nbytes)       rtxMemAlloc(&g_ctxt,(nbytes))
#define OSCRTFREE0(ptr)            rtxMemFreePtr(&g_ctxt,(ptr))
#else
#define OSCRTMALLOC0(nbytes)       (void*)0
#define OSCRTFREE0(ptr)            (void*)0

#endif /* _NO_THREADS */
#endif /* _NO_MALLOC */

#define OSCRTMALLOC rtxMemAlloc
#define OSCRTFREE   rtxMemFreePtr

struct OSRTDList;

#ifdef __cplusplus
extern "C" {
#endif

/* Alias for __cdecl modifier; if __cdecl keyword is not supported,
 * redefine it as empty macro. */

#if !defined(OSCDECL)
#if defined(_MSC_VER) || defined(__BORLANDC__)
#define OSCDECL __cdecl
#else
#define OSCDECL
#endif
#endif /* OSCDECL */

EXTERNRT void  rtxMemHeapAddRef (void** ppvMemHeap);
EXTERNRT void* rtxMemHeapAlloc (void** ppvMemHeap, OSSIZE nbytes);
EXTERNRT void* rtxMemHeapAllocZ (void** ppvMemHeap, OSSIZE nbytes);
EXTERNRT void* rtxMemHeapSysAlloc (void** ppvMemHeap, OSSIZE nbytes);
EXTERNRT void* rtxMemHeapSysAllocZ (void** ppvMemHeap, OSSIZE nbytes);
EXTERNRT int   rtxMemHeapCheckPtr (void** ppvMemHeap, const void* mem_p);
EXTERNRT void  rtxMemHeapFreeAll (void** ppvMemHeap);
EXTERNRT void  rtxMemHeapFreePtr (void** ppvMemHeap, void* mem_p);
EXTERNRT void  rtxMemHeapSysFreePtr (void** ppvMemHeap, void* mem_p);

/* Internal runtime use only.
   This can only be used with a static memory heap.
   It will reallocate the last memory block if the given block of the
   given size appears right at the end of the static memory heap.
   @param ppvMemHeap the heap
   @param mem_p Pointer to block to resize
   @param oldsize The previously allocated size of the block.
   @param newsize The desired new size of the block.
*/
EXTERNRT void* rtxMemHeapReallocStatic
(void** ppvMemHeap, void* mem_p, OSSIZE oldsize, OSSIZE newsize);

EXTERNRT void* rtxMemHeapRealloc
(void** ppvMemHeap, void* mem_p, OSSIZE nbytes_);

EXTERNRT void* rtxMemHeapSysRealloc
(void** ppvMemHeap, void* mem_p, OSSIZE nbytes_);

EXTERNRT void  rtxMemHeapRelease (void** ppvMemHeap);
EXTERNRT void  rtxMemHeapReset (void** ppvMemHeap);
EXTERNRT void  rtxMemHeapSetProperty (void** ppvMemHeap,
                                       OSUINT32 propId, void* pProp);

EXTERNRT void* rtxMemNewArray (OSSIZE nbytes);
EXTERNRT void* rtxMemNewArrayZ (OSSIZE nbytes);
EXTERNRT void  rtxMemDeleteArray (void* mem_p);

EXTERNRT void* rtxMemHeapAutoPtrRef (void** ppvMemHeap, void* ptr);
EXTERNRT int rtxMemHeapAutoPtrUnref (void** ppvMemHeap, void* ptr);
EXTERNRT int rtxMemHeapAutoPtrGetRefCount (void** ppvMemHeap, void* mem_p);

EXTERNRT void rtxMemHeapInvalidPtrHook (void** ppvMemHeap, const void* mem_p);

EXTERNRT void rtxMemHeapCheck (void **ppvMemHeap, const char* file, int line);

EXTERNRT void rtxMemHeapPrint (void **ppvMemHeap);

EXTERNRT void rtxMemHeapPrintWithFree (void **ppvMemHeap);

EXTERNRT int rtxMemHeapCreate (void** ppvMemHeap);

EXTERNRT int rtxMemHeapCreateExt (void** ppvMemHeap,
                                  OSMallocFunc malloc_func,
                                  OSReallocFunc realloc_func,
                                  OSFreeFunc free_func);

EXTERNRT int rtxMemStaticHeapCreate
(void **ppvMemHeap, void* pmem, OSSIZE memsize) ;

#if !defined(_ARMTCC) && !defined(__SYMBIAN32__)

EXTERNRT void rtxMemSetAllocFuncs (OSMallocFunc malloc_func,
                                   OSReallocFunc realloc_func,
                                   OSFreeFunc free_func);

#endif /* __SYMBIAN32__ */

EXTERNRT void rtxMemFreeOpenSeqExt
(OSCTXT* pctxt, struct OSRTDList *pElemList);

EXTERNRT OSUINT32 rtxMemHeapGetDefBlkSize (OSCTXT* pctxt);

#ifndef __SYMBIAN32__

EXTERNRT void rtxMemSetDefBlkSize (OSUINT32 blkSize);
#endif

EXTERNRT OSUINT32 rtxMemGetDefBlkSize (OSVOIDARG);

EXTERNRT OSBOOL rtxMemHeapIsEmpty (OSCTXT* pctxt);

EXTERNRT OSBOOL rtxMemIsZero (const void* pmem, OSSIZE memsiz);

#ifdef _STATIC_HEAP
EXTERNRT void rtxMemSetStaticBuf (void* memHeapBuf, OSUINT32 blkSize);
#endif

#define rtxMemAlloc(pctxt,nbytes) \
rtxMemHeapAlloc(&(pctxt)->pMemHeap,nbytes)

#define rtxMemSysAlloc(pctxt,nbytes) \
rtxMemHeapSysAlloc(&(pctxt)->pMemHeap,nbytes)

#define rtxMemAllocZ(pctxt,nbytes) \
rtxMemHeapAllocZ(&(pctxt)->pMemHeap,nbytes)

#define rtxMemSysAllocZ(pctxt,nbytes) \
rtxMemHeapSysAllocZ(&(pctxt)->pMemHeap,nbytes)


#define rtxMemRealloc(pctxt,mem_p,nbytes) \
rtxMemHeapRealloc(&(pctxt)->pMemHeap, (void*)mem_p, nbytes)

#define rtxMemSysRealloc(pctxt,mem_p,nbytes) \
   rtxMemHeapSysRealloc(&(pctxt)->pMemHeap,(void*)mem_p,nbytes)

#define rtxMemFreePtr(pctxt,mem_p) \
rtxMemHeapFreePtr(&(pctxt)->pMemHeap, (void*)mem_p)

#define rtxMemSysFreePtr(pctxt,mem_p) \
rtxMemHeapSysFreePtr(&(pctxt)->pMemHeap, (void*)mem_p)

EXTERNRT void rtxMemFree (OSCTXT* pctxt);

EXTERNRT void rtxMemReset (OSCTXT* pctxt);

#define rtxMemAllocType(pctxt,ctype) \
(ctype*)rtxMemHeapAlloc(&(pctxt)->pMemHeap,sizeof(ctype))

#define rtxMemSysAllocType(pctxt,ctype) \
(ctype*)rtxMemHeapSysAlloc(&(pctxt)->pMemHeap,sizeof(ctype))

#define rtxMemAllocTypeZ(pctxt,ctype) \
(ctype*)rtxMemHeapAllocZ(&(pctxt)->pMemHeap,sizeof(ctype))

#define rtxMemSysAllocTypeZ(pctxt,ctype) \
(ctype*)rtxMemHeapSysAllocZ(&(pctxt)->pMemHeap,sizeof(ctype))

#define rtxMemFreeType(pctxt,mem_p) \
rtxMemHeapFreePtr(&(pctxt)->pMemHeap, (void*)mem_p)

#define rtxMemSysFreeType(pctxt,mem_p) \
rtxMemHeapSysFreePtr(&(pctxt)->pMemHeap, (void*)mem_p)

#define rtxMemAllocArray(pctxt,n,type) \
(type*)rtxMemAllocArray2 (pctxt, n, sizeof(type), 0)

EXTERNRT void* rtxMemAllocArray2
(OSCTXT* pctxt, OSSIZE numElements, OSSIZE typeSize, OSUINT32 flags);

#define rtxMemSysAllocArray(pctxt,n,type) \
(type*)rtxMemAllocArray2 (pctxt, n, sizeof(type), RT_MH_SYSALLOC)

#define rtxMemAllocArrayZ(pctxt,n,type) \
(type*)rtxMemAllocArray2 (pctxt, n, sizeof(type), RT_MH_ZEROARRAY)

#define rtxMemFreeArray(pctxt,mem_p) \
rtxMemHeapFreePtr(&(pctxt)->pMemHeap, (void*)mem_p)

#define rtxMemSysFreeArray(pctxt,mem_p) \
rtxMemHeapSysFreePtr(&(pctxt)->pMemHeap, (void*)mem_p)

#define rtxMemReallocArray(pctxt,mem_p,n,type) \
(type*)rtxMemHeapRealloc(&(pctxt)->pMemHeap, (void*)mem_p, sizeof(type)*n)

/* Auto-pointer functions */
#define rtxMemNewAutoPtr(pctxt,nbytes) \
rtxMemHeapAlloc(&(pctxt)->pMemHeap, nbytes)

#define rtxMemAutoPtrRef(pctxt,ptr) \
rtxMemHeapAutoPtrRef(&(pctxt)->pMemHeap, (void*)(ptr))

#define rtxMemAutoPtrUnref(pctxt,ptr) \
rtxMemHeapAutoPtrUnref(&(pctxt)->pMemHeap, (void*)(ptr))

#define rtxMemAutoPtrGetRefCount(pctxt,ptr) \
rtxMemHeapAutoPtrGetRefCount(&(pctxt)->pMemHeap, (void*)(ptr))

#define rtxMemCheckPtr(pctxt,mem_p) \
rtxMemHeapCheckPtr(&(pctxt)->pMemHeap, (void*)mem_p)

#define rtxMemCheck(pctxt) \
rtxMemHeapCheck(&(pctxt)->pMemHeap, __FILE__, __LINE__)

#define rtxMemPrint(pctxt) \
rtxMemHeapPrint(&(pctxt)->pMemHeap)

#define rtxMemPrintWithFree(pctxt) \
rtxMemHeapPrintWithFree(&(pctxt)->pMemHeap)

#define rtxMemSetProperty(pctxt,propId,pProp) \
rtxMemHeapSetProperty (&(pctxt)->pMemHeap, propId, pProp)


#ifdef __cplusplus
}
#endif

#endif /*__RTXMEMORY_H__*/