14a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project/*---------------------------------------------------------------------------* 24a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * pmemory.h * 34a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * * 44a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * Copyright 2007, 2008 Nuance Communciations, Inc. * 54a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * * 64a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * Licensed under the Apache License, Version 2.0 (the 'License'); * 74a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * you may not use this file except in compliance with the License. * 84a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * * 94a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * You may obtain a copy of the License at * 104a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * http://www.apache.org/licenses/LICENSE-2.0 * 114a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * * 124a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * Unless required by applicable law or agreed to in writing, software * 134a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * distributed under the License is distributed on an 'AS IS' BASIS, * 144a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * 154a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * See the License for the specific language governing permissions and * 164a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * limitations under the License. * 174a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * * 184a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project *---------------------------------------------------------------------------*/ 194a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project 204a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project#ifndef PMEMORY_H 214a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project#define PMEMORY_H 224a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project 234a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project 244a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project 254a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project/* #define PMEM_MAP_TRACE */ 264a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project 274a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project#include "PortPrefix.h" 284a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project#include "ptypes.h" 294a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project#include "pstdio.h" 304a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project#include <stddef.h> 314a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project#include <stdlib.h> 324a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project 334a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project/** 344a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * @addtogroup PmemoryModule PMemory API functions 354a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * Library for basic memory management. 364a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * Call PMemInit() to initialize and PmemShutdown() to shutdown module. 374a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * 384a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * @{ 394a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project */ 404a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project 414a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project/** 424a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * Returns macro to string format. 434a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project */ 444a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project#define _VAL(x) #x 454a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project/** 464a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * Converts a digit to a string. 474a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project */ 484a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project#define _STR(x) _VAL(x) 494a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project 504a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project#ifndef offsetof 514a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project#define offsetof(type, member) ((size_t) &(((type *)0)->member)) 524a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project#endif 534a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project 544a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project/** 554a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * \<static_cast\> implementation for C. 564a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project */ 574a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project#define STATIC_CAST(self, subClass, member) ((subClass*) (((char*) self) - (offsetof(subClass, member)))) 584a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project 594a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project 604a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project#define USE_STDLIB_MALLOC 614a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project 624a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project#ifdef USE_STDLIB_MALLOC 634a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project 644a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project#define MALLOC(n, tag) malloc(n) 654a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project#define CALLOC(m, n, tag) calloc(m, n) 664a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project#define CALLOC_CLR(m, n, tag) calloc(m, n) 674a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project#define REALLOC(p, n) realloc(p, n) 684a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project#define FREE(p) free(p) 694a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project#define NEW(type, tag) ((type*)MALLOC(sizeof(type), tag)) 704a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project#define NEW_ARRAY(type, n, tag) ((type*)CALLOC(n, sizeof(type), tag)) 714a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project 724a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project#define PMemInit() ESR_SUCCESS 734a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project#define PMemShutdown() ESR_SUCCESS 744a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project#define PMemSetLogFile(f) ESR_NOT_SUPPORTED 754a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project#define PMemDumpLogFile() ESR_NOT_SUPPORTED 764a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project#define PMemSetLogEnabled(b) ESR_NOT_SUPPORTED 774a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project#define PMemLogFree(p) (free(p), ESR_SUCCESS) 784a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project#define PMemReport(f) ESR_NOT_SUPPORTED 794a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project#define PMemorySetPoolSize(n) ESR_NOT_SUPPORTED 804a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project#define PMemoryGetPoolSize(p) ESR_NOT_SUPPORTED 814a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project 824a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project#else 834a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project 844a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project#ifdef DISABLE_MALLOC 854a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project#define malloc #error 864a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project#define calloc #error 874a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project#define realloc #error 884a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project#define free #error 894a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project#endif 904a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project 914a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project/* 924a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * PMEM_MAP_TRACE is not defined by default. 934a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * It is up to user to define PMEM_MAP_TRACE; 944a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * define in either makefile or here for test purpose. 954a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project */ 964a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project 974a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project#ifdef PMEM_MAP_TRACE 984a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project/** 994a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * Portable malloc() 1004a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project */ 1014a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project#define MALLOC(nbBytes, tag) (pmalloc(nbBytes, tag, L(__FILE__), __LINE__)) 1024a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project#else 1034a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project/** 1044a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * Portable malloc() 1054a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project */ 1064a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project#define MALLOC(nbBytes, tag) (pmalloc(nbBytes)) 1074a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project#endif 1084a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project 1094a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project#ifdef PMEM_MAP_TRACE 1104a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project/** 1114a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * Portable calloc() 1124a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project */ 1134a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project#define CALLOC(nbElem, elemSize, tag) (pcalloc(nbElem, elemSize , tag, L(__FILE__), __LINE__)) 1144a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project#define CALLOC_CLR(nbElem, elemSize, tag) (pcalloc(nbElem, elemSize , tag, L(__FILE__), __LINE__)) 1154a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project#else 1164a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project/** 1174a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * Portable calloc() 1184a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project */ 1194a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project#define CALLOC(nbElem, elemSize, tag) (pcalloc(nbElem, elemSize)) 1204a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project#define CALLOC_CLR(nbElem, elemSize, tag) (pcalloc(nbElem, elemSize)) 1214a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project#endif 1224a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project 1234a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project#ifdef PMEM_MAP_TRACE 1244a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project/** 1254a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * Portable realloc() 1264a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project */ 1274a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project#define REALLOC(ptr, newSize) (prealloc(ptr, newSize, L(__FILE__), __LINE__)) 1284a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project#else 1294a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project/** 1304a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * Portable realloc() 1314a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project */ 1324a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project#define REALLOC(ptr, newSize) (prealloc(ptr, newSize)) 1334a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project#endif 1344a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project 1354a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project/** 1364a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * Portable new() 1374a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project */ 1384a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project#define NEW(type, tag) ((type*) MALLOC(sizeof(type), tag)) 1394a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project 1404a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project/** 1414a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * Allocates a new array 1424a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project */ 1434a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project#define NEW_ARRAY(type, nbElem, tag) ((type *) CALLOC(nbElem, sizeof(type), tag)) 1444a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project 1454a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project#ifdef PMEM_MAP_TRACE 1464a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project/** 1474a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * Portable free() 1484a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project */ 1494a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project#define FREE(ptr) pfree(ptr, L(__FILE__), __LINE__) 1504a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project#else 1514a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project/** 1524a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * Portable free() 1534a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project */ 1544a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project#define FREE(ptr) pfree(ptr) 1554a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project#endif 1564a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project 1574a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project/** 1584a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * @} 1594a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project */ 1604a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project 1614a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project/** 1624a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * Allocates specified number of bytes, similar to malloc but initializes the 1634a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * memory to 0. 1644a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * 1654a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * @param nbBytes The number of bytes to allocate. 1664a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * 1674a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * @param tag The tag associated with the memory for reporting. 1684a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * 1694a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * @param file The file name in which the function is invoked. Should be the 1704a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * __FILE__ macro. 1714a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * 1724a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * @param line The line at which the function is invoked. Should be the 1734a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * __LINE__ macro. 1744a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project **/ 1754a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project#ifdef PMEM_MAP_TRACE 1764a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source ProjectPORTABLE_API void *pmalloc(size_t nbBytes, const LCHAR* tag, const LCHAR* file, int line); 1774a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project#else 1784a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source ProjectPORTABLE_API void *pmalloc(size_t nbBytes); 1794a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project#endif 1804a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project 1814a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project/** 1824a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * Allocate an array of items, similar to calloc. 1834a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * 1844a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * @param nbItems The number items to allocate. 1854a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * 1864a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * @param itemSize The size of each item. 1874a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * 1884a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * @param tag The tag associated with the memory for reporting. 1894a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * 1904a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * @param file The file name in which the function is invoked. Should be the 1914a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * __FILE__ macro. 1924a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * 1934a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * @param line The line at which the function is invoked. Should be the 1944a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * __LINE__ macro. 1954a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * 1964a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project **/ 1974a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project#ifdef PMEM_MAP_TRACE 1984a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source ProjectPORTABLE_API void *pcalloc(size_t nbItems, size_t itemSize, const LCHAR* tag, const LCHAR* file, int line); 1994a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project#else 2004a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source ProjectPORTABLE_API void *pcalloc(size_t nbItems, size_t itemSize); 2014a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project#endif 2024a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project 2034a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project/** 2044a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * Reallocates data. Similar to realloc. 2054a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * 2064a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * @param ptr A pointer previously allocated by pmalloc, pcalloc or prealloc. 2074a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * 2084a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * @param newSize The new size required. 2094a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * 2104a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * @param file The file name in which the function is invoked. Should be the 2114a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * __FILE__ macro. 2124a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * 2134a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * @param line The line at which the function is invoked. Should be the 2144a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * __LINE__ macro. 2154a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * 2164a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project **/ 2174a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project#ifdef PMEM_MAP_TRACE 2184a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source ProjectPORTABLE_API void *prealloc(void* ptr, size_t newSize, const LCHAR* file, int line); 2194a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project#else 2204a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source ProjectPORTABLE_API void *prealloc(void* ptr, size_t newSize); 2214a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project#endif 2224a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project 2234a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project/** 2244a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * Frees data allocated through pmalloc, pcalloc or realloc. 2254a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * 2264a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * @param ptr A pointer previously allocated by pmalloc, pcalloc or prealloc. 2274a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * 2284a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * @param file The file name in which the function is invoked. Should be the 2294a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * __FILE__ macro. 2304a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * 2314a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * @param line The line at which the function is invoked. Should be the 2324a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * __LINE__ macro. 2334a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * 2344a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project **/ 2354a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project#ifdef PMEM_MAP_TRACE 2364a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source ProjectPORTABLE_API void pfree(void* ptr, const LCHAR* file, int line); 2374a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project#else 2384a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source ProjectPORTABLE_API void pfree(void* ptr); 2394a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project#endif 2404a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project 2414a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project/** 2424a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * @addtogroup PmemoryModule PMemory API functions 2434a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * Library for basic memory management. 2444a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * Call PMemInit() to initialize and PmemShutdown() to shutdown module. 2454a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * 2464a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * @{ 2474a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project */ 2484a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project 2494a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project/** 2504a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * Initializes the memory management API. 2514a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * 2524a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * @return ESR_INVALID_STATE if the PMem module is already initialized or an internal error occurs 2534a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project */ 2544a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source ProjectPORTABLE_API ESR_ReturnCode PMemInit(void); 2554a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project 2564a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project/** 2574a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * Shutdowns the memory management API. pmemReport is invoked with the same 2584a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * file that was provided to pmemInit. 2594a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * 2604a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * @return ESR_INVALID_STATE if the PMem module is not initialized 2614a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project */ 2624a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source ProjectPORTABLE_API ESR_ReturnCode PMemShutdown(void); 2634a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project 2644a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project/** 2654a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * Enables low-level logging to file. This logs individual memory allocations and 2664a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * deallocations. On shutdown, pmemDumpLogFile() will be invoked. 2674a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * 2684a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * @param file A file in which logging of memory related operations should be 2694a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * performed. If NULL, no logging is performed. 2704a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * @return ESR_INVALID_STATE if the PMem module is not initialized 2714a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project */ 2724a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source ProjectPORTABLE_API ESR_ReturnCode PMemSetLogFile(PFile* file); 2734a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project 2744a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project/** 2754a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * Dumps memory report to the log file, closes it and disables logging. 2764a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * 2774a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * @return ESR_INVALID_STATE if the PMem module is not initialized or an internal error occurs 2784a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project */ 2794a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source ProjectPORTABLE_API ESR_ReturnCode PMemDumpLogFile(void); 2804a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project 2814a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project/** 2824a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * Enables/disables memory logging. This is useful for hiding allocations/deallocation 2834a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * from pmemReport() and other reporting mechanisms, simply disable logging prior 2844a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * to hidden operations and reenable it thereafter. 2854a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * 2864a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * @param value True if logging should be enabled 2874a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * @return ESR_SUCCESS 2884a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project */ 2894a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source ProjectPORTABLE_API ESR_ReturnCode PMemSetLogEnabled(ESR_BOOL value); 2904a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project 2914a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project/** 2924a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * Hide memory allocation from pmemReport() by pretending the memory was deallocating. This is used to hide 2934a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * memory leaks from pmemReport(), which is useful for internal variables which are deallocated after the 2944a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * final call to pmemReport() occurs. 2954a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * 2964a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * @param ptr Address of memory allocation that should be hidden 2974a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * @return ESR_SUCCESS 2984a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project */ 2994a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source ProjectPORTABLE_API ESR_ReturnCode PMemLogFree(void* ptr); 3004a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project 3014a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project/** 3024a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * Generates a report of the memory allocation. 3034a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * 3044a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * @param file A file in which the report is generated. If set to NULL, the 3054a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * report will be generated in the same file as that was provided to pmemInit. 3064a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * Therefore, it is possible that no report is generated if the function is 3074a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * invoked with NULL and pmemInit was also invoked with NULL. 3084a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * @return ESR_WRITE_ERROR if an error occurs while writing to the file 3094a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project */ 3104a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source ProjectPORTABLE_API ESR_ReturnCode PMemReport(PFile* file); 3114a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project 3124a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project/** 3134a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * Allow user to set the memory pool size when S2G uses its own memory management. 3144a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * It should be called before PMemInit() 3154a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * The predefined (default) size is 3M for S2G 3164a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * 3174a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * @param size the memory pool size in byte 3184a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * @return ESR_NOT_SUPPORTED if S2G uses native memory management; ESR_INVALID_STATE if it is called after PMemInit() 3194a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project */ 3204a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source ProjectPORTABLE_API ESR_ReturnCode PMemorySetPoolSize(size_t size); 3214a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project 3224a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project/** 3234a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * Get the memory pool size when S2G uses its own memory management 3244a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * 3254a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * @param size the memory pool size in byte 3264a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * @return ESR_NOT_SUPPORTED if S2G uses native memory management 3274a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project */ 3284a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source ProjectPORTABLE_API ESR_ReturnCode PMemoryGetPoolSize(size_t *size); 3294a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project 3304a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project/** 3314a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * @} 3324a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project */ 3334a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project 3344a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project#endif 3354a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project 3364a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project#endif 337