Home About ASN.1 Products Free Software Documents Services Resources Resellers Customers Careers About Us Contact Us

rtxMemory.h Go to the documentation of this file. /* * Copyright (c) 2003-2006 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/rtxCommon.h" #include "rtxsrc/rtxSysTypes.h" #define RT_MH_DONTKEEPFREE 0x1 #define OSRTMH_PROPID_DEFBLKSIZE 1 #define OSRTMH_PROPID_SETFLAGS 2 #define OSRTMH_PROPID_CLEARFLAGS 3 #define OSRTMH_PROPID_USER 10 #ifndef OSRTXM_K_MEMBLKSIZ #define OSRTXM_K_MEMBLKSIZ (4*1024) #endif #define OSRTALLOCTYPE(pctxt,type) \ (type*) rtxMemHeapAlloc (&(pctxt)->pTypeMemHeap, sizeof(type)) #define OSRTALLOCTYPEZ(pctxt,type) \ (type*) rtxMemHeapAllocZ (&(pctxt)->pTypeMemHeap, sizeof(type)) #define OSRTARRAYSIZE(x) (sizeof(x)/sizeof(x[0])) #ifndef _NO_MALLOC #define OSCRTMALLOC0(nbytes) malloc(nbytes) #define OSCRTFREE0(ptr) free(ptr) #else #ifdef _NO_THREADS extern EXTERNRTX 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 OSMALLOC #define OSCRTFREE OSFREEPTR 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 */ /* Pointers to C Run-Time memory allocation functions * * (See rtxMemSetAllocFuncs) */ typedef void *(OSCDECL *OSMallocFunc ) (size_t size); typedef void *(OSCDECL *OSReallocFunc) (void *ptr, size_t size); typedef void (OSCDECL *OSFreeFunc ) (void *ptr); #ifdef _RT_ALLOC_FUNC_WITH_CONTEXT /* Variation of the memory allocation functions only available * * after recompilation of the runtime with the * * (See rtxMemSetAllocCtxtFuncs) */ typedef void *(OSCDECL *OSMallocCtxtFunc ) (OSCTXT* pctxt, size_t size); typedef void *(OSCDECL *OSReallocCtxtFunc) (OSCTXT* pctxt, void *ptr, size_t size); typedef void (OSCDECL *OSFreeCtxtFunc ) (OSCTXT* pctxt, void *ptr); #endif EXTERNRTX void rtxMemHeapAddRef (void** ppvMemHeap); EXTERNRTX void* rtxMemHeapAlloc (void** ppvMemHeap, size_t nbytes); EXTERNRTX void* rtxMemHeapAllocZ (void** ppvMemHeap, size_t nbytes); EXTERNRTX int rtxMemHeapCheckPtr (void** ppvMemHeap, void* mem_p); EXTERNRTX int rtxMemHeapCreate (void** ppvMemHeap); EXTERNRTX void rtxMemHeapFreeAll (void** ppvMemHeap); EXTERNRTX void rtxMemHeapFreePtr (void** ppvMemHeap, void* mem_p); EXTERNRTX void* rtxMemHeapMarkSaved (void** ppvMemHeap, const void* mem_p, OSBOOL saved); EXTERNRTX void* rtxMemHeapRealloc (void** ppvMemHeap, void* mem_p, size_t nbytes_); EXTERNRTX void rtxMemHeapRelease (void** ppvMemHeap); EXTERNRTX void rtxMemHeapReset (void** ppvMemHeap); EXTERNRTX void rtxMemHeapSetProperty (void** ppvMemHeap, OSUINT32 propId, void* pProp); EXTERNRTX void rtxMemSetAllocFuncs (OSMallocFunc malloc_func, OSReallocFunc realloc_func, OSFreeFunc free_func); #ifdef _RT_ALLOC_FUNC_WITH_CONTEXT EXTERNRTX void rtxMemSetAllocCtxtFuncs (OSMallocCtxtFunc malloc_func, OSReallocCtxtFunc realloc_func, OSFreeCtxtFunc free_func); #endif EXTERNRTX void rtxMemFreeOpenSeqExt (OSCTXT* pctxt, struct OSRTDList *pElemList); /* * This function sets flags to a heap. May be used to control the heap's * behavior. * * @param pctxt Pointer to a memory block structure that contains the * list of dynamic memory block maintained by these * functions. * @param flags The flags. */ EXTERNRTX void rtxMemHeapSetFlags (OSCTXT* pctxt, OSUINT32 flags); /* * This function clears memory heap flags. * * @param pctxt Pointer to a memory block structure that contains the * list of dynamic memory block maintained by these * functions. * @param flags The flags */ EXTERNRTX void rtxMemHeapClearFlags (OSCTXT* pctxt, OSUINT32 flags); /* * This function sets the pointer to standard allocation functions. These * functions are used to allocate/reallocate/free the memory blocks. By * default, standard C functions - malloc, realloc, and free - are used. But if * some platforms do not support these functions or some other reasons exist) * they can be overloaded. The functions being overloaded should have the same * prototypes as standard ones. * * @param pctxt Pointer to a context block. * @param blkSize The currently used minimum size and the granularity of * memory blocks. */ EXTERNRTX void rtxMemHeapSetDefBlkSize (OSCTXT* pctxt, OSUINT32 blkSize); /* * This function returns the actual granularity of memory blocks. * * @param pctxt Pointer to a context block. */ EXTERNRTX OSUINT32 rtxMemHeapGetDefBlkSize (OSCTXT* pctxt); EXTERNRTX OSBOOL rtxMemIsZero (const void* pmem, size_t memsiz); #ifdef _STATIC_HEAP EXTERNRTX void rtxMemSetStaticBuf (void* memHeapBuf, OSUINT32 blkSize); #endif #if !defined (_BUILDCRTLIB) EXTERNRTX void* rtxMemAlloc (OSCTXT* pctxt, size_t nbytes); EXTERNRTX void* rtxMemAllocZ (OSCTXT* pctxt, size_t nbytes); EXTERNRTX void rtxMemFree (OSCTXT* pctxt); EXTERNRTX void rtxMemFreePtr (OSCTXT* pctxt, void* mem_p); EXTERNRTX void* rtxMemRealloc (OSCTXT* pctxt, void* mem_p, size_t oldnbytes, size_t nbytes); /* * This function resets all memory held within a context. This is all * memory allocated using the OSMALLOC (and similar macros) and the rtxMem * memory allocation functions using the given context variable. * * <p>The difference between this and the \c rtxMemFree function is that the * memory blocks held within the context are not actually freed. Internal * pointers are reset so the existing blocks can be reused. This can * provide a performace improvement for repetitive tasks such as decoding * messages in a loop. * * @param pctxt - Pointer to a context block */ EXTERNRTX void rtxMemReset (OSCTXT* pctxt); #else /* * Allocate memory. This macro allocates the given number of bytes. It is * similar to the C \c malloc run-time function. * * @param pctxt - Pointer to a context block * @param nbytes - Number of bytes of memory to allocate * @return - Void pointer to allocated memory or NULL if insufficient memory * was available to fulfill the request. */ #define rtxMemAlloc(pctxt,nbytes) \ rtxMemHeapAlloc(&(pctxt)->pTypeMemHeap,nbytes) /* * Allocate and zero memory. This macro allocates the given number of bytes * and then initializes the memory block to zero. * * @param pctxt - Pointer to a context block * @param nbytes - Number of bytes of memory to allocate * @return - Void pointer to allocated memory or NULL if insufficient memory * was available to fulfill the request. */ #define rtxMemAllocZ(pctxt,nbytes) \ rtxMemHeapAllocZ(&(pctxt)->pTypeMemHeap,nbytes) /* * Reallocate memory. This macro reallocates a memory block (either * expands or contracts) to the given number of bytes. It is * similar to the C \c realloc run-time function. * * @param pctxt - Pointer to a context block * @param mem_p - Pointer to memory block to reallocate. This must have been * allocated using the OSMALLOC macro or the rtxMemHeapAlloc function. * @param oldnbytes The number of bytes already allocated. * @param nbytes - Number of bytes of memory to which the block is to be * resized. * @return - Void pointer to allocated memory or NULL if insufficient memory * was available to fulfill the request. This may be the same as the pmem * pointer that was passed in if the block did not need to be relocated. */ #define rtxMemRealloc(pctxt,mem_p,oldnbytes,nbytes) \ rtxMemHeapRealloc(&(pctxt)->pTypeMemHeap, (void*)mem_p, nbytes) /* * Free memory pointer. This macro frees memory at the given pointer. * The memory must have been allocated using the OSMALLOC (or similar) * macros or the rtxMem memory allocation macros. This macro is * similar to the C \c free function. * * @param pctxt - Pointer to a context block * @param mem_p - Pointer to memory block to free. This must have * been allocated using the OSMALLOC or rtxMemAlloc macro or the * rtxMemHeapAlloc function. */ #define rtxMemFreePtr(pctxt,mem_p) \ if (rtxMemHeapCheckPtr (&(pctxt)->pTypeMemHeap, (void*)mem_p)) \ rtxMemHeapFreePtr(&(pctxt)->pTypeMemHeap, (void*)mem_p) /* * Free memory associated with a context. This macro frees all memory * held within a context. This is all memory allocated using the * OSMALLOC (and similar macros) and the rtxMem memory allocation * functions using the given context variable. * * @param pctxt - Pointer to a context block */ #define rtxMemFree(pctxt) \ rtxMemHeapFreeAll(&(pctxt)->pTypeMemHeap) /* * Reset memory associated with a context. This macro resets all memory * held within a context. This is all memory allocated using the OSMALLOC * (and similar macros) and the rtxMem memory allocation functions using the * given context variable. * * <p>The difference between this and the OSMEMFREE macro is that the * memory blocks held within the context are not actually freed. Internal * pointers are reset so the existing blocks can be reused. This can * provide a performace improvement for repetitive tasks such as decoding * messages in a loop. * * @param pctxt - Pointer to a context block */ #define rtxMemReset(pctxt) \ rtxMemHeapReset(&(pctxt)->pTypeMemHeap) #endif /* defined(_BUILDCRTLIB) */ #define rtxMemAllocType(pctxt,type) \ (type*) rtxMemAllocZ ((pctxt), sizeof(type)) #ifdef __cplusplus } #endif #ifdef _STATIC_HEAP EXTERNRTX void rtxMemSetStaticBuf (void* memHeapBuf, OSUINT32 blkSize); #endif #endif /*__RTXMEMORY_H__*/ This file was last modified on 8 Jan 2007. XBinder, Version 1.1.9