janwas
045ac1c197
mem_util: inline freelist functions to avoid needing an additional if() in pool.cpp pool: add comments clarifying the roles of PoolAllocator vs RawPoolAllocator wsdl: refactor (naming convention, determination of window style, reduce forward decls) This was SVN commit r7610.
81 lines
2.8 KiB
C
81 lines
2.8 KiB
C
/* Copyright (c) 2010 Wildfire Games
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining
|
|
* a copy of this software and associated documentation files (the
|
|
* "Software"), to deal in the Software without restriction, including
|
|
* without limitation the rights to use, copy, modify, merge, publish,
|
|
* distribute, sublicense, and/or sell copies of the Software, and to
|
|
* permit persons to whom the Software is furnished to do so, subject to
|
|
* the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be included
|
|
* in all copies or substantial portions of the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
|
|
* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
|
|
* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
|
|
* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
|
|
* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
*/
|
|
|
|
/*
|
|
* memory allocator helper routines.
|
|
*/
|
|
|
|
#ifndef INCLUDED_MEM_UTIL
|
|
#define INCLUDED_MEM_UTIL
|
|
|
|
LIB_API bool mem_IsPageMultiple(uintptr_t x);
|
|
|
|
LIB_API size_t mem_RoundUpToPage(size_t size);
|
|
LIB_API size_t mem_RoundUpToAlignment(size_t size);
|
|
|
|
|
|
// very thin wrapper on top of sys/mman.h that makes the intent more obvious
|
|
// (its commit/decommit semantics are difficult to tell apart)
|
|
LIB_API LibError mem_Reserve(size_t size, u8** pp);
|
|
LIB_API LibError mem_Release(u8* p, size_t size);
|
|
LIB_API LibError mem_Commit(u8* p, size_t size, int prot);
|
|
LIB_API LibError mem_Decommit(u8* p, size_t size);
|
|
LIB_API LibError mem_Protect(u8* p, size_t size, int prot);
|
|
|
|
|
|
// "freelist" is a pointer to the first unused element (0 if there are none);
|
|
// its memory holds a pointer to the next free one in list.
|
|
//
|
|
// rationale for the function-based interface: a class encapsulating the
|
|
// freelist pointer would force each header to include mem_util.h;
|
|
// instead, implementations need only declare a void* pointer.
|
|
//
|
|
// these functions are inlined because allocation is sometimes time-critical.
|
|
|
|
// @param el must not be a nullptr (otherwise, the previous freelist entries
|
|
// would be lost)
|
|
static inline void mem_freelist_AddToFront(void*& freelist, void* el)
|
|
{
|
|
#ifndef NDEBUG
|
|
debug_assert(el != 0);
|
|
#endif
|
|
|
|
void* prev_el = freelist;
|
|
freelist = el;
|
|
memcpy(el, prev_el, sizeof(void*));
|
|
}
|
|
|
|
// @return 0 if the freelist is empty (i.e. a nullptr),
|
|
// else a pointer that was previously passed to mem_freelist_AddToFront.
|
|
static inline void* mem_freelist_Detach(void*& freelist)
|
|
{
|
|
void* el = freelist;
|
|
// nothing in list
|
|
if(!el)
|
|
return 0;
|
|
memcpy(&freelist, el, sizeof(void*));
|
|
freelist = *(void**)el;
|
|
return el;
|
|
}
|
|
|
|
#endif // #ifndef INCLUDED_MEM_UTIL
|