Merge pull request #742 from pcercuei/update-lightrec-20230804

[pcsx_rearmed.git] / deps / lightrec / tlsf / tlsf.h

#ifndef INCLUDED_tlsf\r
#define INCLUDED_tlsf\r
\r
/*\r
** Two Level Segregated Fit memory allocator, version 3.1.\r
** Written by Matthew Conte\r
**	http://tlsf.baisoku.org\r
**\r
** Based on the original documentation by Miguel Masmano:\r
**	http://www.gii.upv.es/tlsf/main/docs\r
**\r
** This implementation was written to the specification\r
** of the document, therefore no GPL restrictions apply.\r
** \r
** Copyright (c) 2006-2016, Matthew Conte\r
** All rights reserved.\r
** \r
** Redistribution and use in source and binary forms, with or without\r
** modification, are permitted provided that the following conditions are met:\r
**     * Redistributions of source code must retain the above copyright\r
**       notice, this list of conditions and the following disclaimer.\r
**     * Redistributions in binary form must reproduce the above copyright\r
**       notice, this list of conditions and the following disclaimer in the\r
**       documentation and/or other materials provided with the distribution.\r
**     * Neither the name of the copyright holder nor the\r
**       names of its contributors may be used to endorse or promote products\r
**       derived from this software without specific prior written permission.\r
** \r
** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND\r
** ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED\r
** WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE\r
** DISCLAIMED. IN NO EVENT SHALL MATTHEW CONTE BE LIABLE FOR ANY\r
** DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES\r
** (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;\r
** LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND\r
** ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT\r
** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS\r
** SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\r
*/\r
\r
#include <stddef.h>\r
\r
#if defined(__cplusplus)\r
extern "C" {\r
#endif\r
\r
/* tlsf_t: a TLSF structure. Can contain 1 to N pools. */\r
/* pool_t: a block of memory that TLSF can manage. */\r
typedef void* tlsf_t;\r
typedef void* pool_t;\r
\r
/* Create/destroy a memory pool. */\r
tlsf_t tlsf_create(void* mem);\r
tlsf_t tlsf_create_with_pool(void* mem, size_t bytes);\r
void tlsf_destroy(tlsf_t tlsf);\r
pool_t tlsf_get_pool(tlsf_t tlsf);\r
\r
/* Add/remove memory pools. */\r
pool_t tlsf_add_pool(tlsf_t tlsf, void* mem, size_t bytes);\r
void tlsf_remove_pool(tlsf_t tlsf, pool_t pool);\r
\r
/* malloc/memalign/realloc/free replacements. */\r
void* tlsf_malloc(tlsf_t tlsf, size_t bytes);\r
void* tlsf_memalign(tlsf_t tlsf, size_t align, size_t bytes);\r
void* tlsf_realloc(tlsf_t tlsf, void* ptr, size_t size);\r
void tlsf_free(tlsf_t tlsf, void* ptr);\r
\r
/* Returns internal block size, not original request size */\r
size_t tlsf_block_size(void* ptr);\r
\r
/* Overheads/limits of internal structures. */\r
size_t tlsf_size(void);\r
size_t tlsf_align_size(void);\r
size_t tlsf_block_size_min(void);\r
size_t tlsf_block_size_max(void);\r
size_t tlsf_pool_overhead(void);\r
size_t tlsf_alloc_overhead(void);\r
\r
/* Debugging. */\r
typedef void (*tlsf_walker)(void* ptr, size_t size, int used, void* user);\r
void tlsf_walk_pool(pool_t pool, tlsf_walker walker, void* user);\r
/* Returns nonzero if any internal consistency check fails. */\r
int tlsf_check(tlsf_t tlsf);\r
int tlsf_check_pool(pool_t pool);\r
\r
#if defined(__cplusplus)\r
};\r
#endif\r
\r
#endif\r