tlsf.h File Reference

#include <stdint.h>
#include <stddef.h>

Include dependency graph for tlsf.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	block_header
struct	free_block
struct	tlsf_pool

Macros
#define	TLSF_ALIGN_SIZE   16
#define	TLSF_ALIGN_MASK   (TLSF_ALIGN_SIZE - 1)
#define	TLSF_ALIGN_UP(x)   (((x) + TLSF_ALIGN_MASK) & ~TLSF_ALIGN_MASK)
#define	SL_INDEX_COUNT_LOG2   5
#define	SL_INDEX_COUNT   (1U << SL_INDEX_COUNT_LOG2) /* 32 */
#define	SL_INDEX_MASK   (SL_INDEX_COUNT - 1)
#define	FL_INDEX_COUNT   (8 * sizeof(size_t))
#define	BLOCK_FLAG_FREE   0x1U
#define	BLOCK_FLAG_PREV_FREE   0x2U
#define	BLOCK_SIZE_MASK   (~(size_t)(BLOCK_FLAG_FREE | BLOCK_FLAG_PREV_FREE))
#define	TLSF_HEADER_SIZE   ((size_t)sizeof(block_header_t)) /* 16 */
#define	TLSF_FREE_BLOCK_SIZE   ((size_t)sizeof(free_block_t)) /* 32 */
#define	TLSF_MIN_BLOCK_SIZE   TLSF_FREE_BLOCK_SIZE /* 32 — minimum free block */
#define	TLSF_SENTINEL_SIZE   TLSF_HEADER_SIZE /* 16 — sentinel block */

Typedefs
typedef struct block_header	block_header_t
typedef struct free_block	free_block_t
typedef struct tlsf_pool	tlsf_pool_t

Functions
tlsf_pool_t *	tlsf_create (void)
tlsf_pool_t *	tlsf_get_pool (void)
int	tlsf_add_memory (tlsf_pool_t *pool, void *mem, size_t size)
void *	tlsf_malloc (tlsf_pool_t *pool, size_t size)
void	tlsf_free (tlsf_pool_t *pool, void *ptr)
void *	tlsf_realloc (tlsf_pool_t *pool, void *ptr, size_t size)

Macro Definition Documentation

BLOCK_FLAG_FREE

#define BLOCK_FLAG_FREE   0x1U

BLOCK_FLAG_PREV_FREE

#define BLOCK_FLAG_PREV_FREE   0x2U

BLOCK_SIZE_MASK

#define BLOCK_SIZE_MASK   (~(size_t)(BLOCK_FLAG_FREE | BLOCK_FLAG_PREV_FREE))

FL_INDEX_COUNT

#define FL_INDEX_COUNT   (8 * sizeof(size_t))

SL_INDEX_COUNT

#define SL_INDEX_COUNT   (1U << SL_INDEX_COUNT_LOG2) /* 32 */

SL_INDEX_COUNT_LOG2

#define SL_INDEX_COUNT_LOG2   5

SL_INDEX_MASK

#define SL_INDEX_MASK   (SL_INDEX_COUNT - 1)

TLSF_ALIGN_MASK

#define TLSF_ALIGN_MASK   (TLSF_ALIGN_SIZE - 1)

TLSF_ALIGN_SIZE

#define TLSF_ALIGN_SIZE   16

BSD 2-Clause License

Copyright (c) 2022-2023, Manas Kamal Choudhury

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

TLSF_ALIGN_UP

#define TLSF_ALIGN_UP

(

x

)

(((x) + TLSF_ALIGN_MASK) & ~TLSF_ALIGN_MASK)

TLSF_FREE_BLOCK_SIZE

#define TLSF_FREE_BLOCK_SIZE   ((size_t)sizeof(free_block_t)) /* 32 */

TLSF_HEADER_SIZE

#define TLSF_HEADER_SIZE   ((size_t)sizeof(block_header_t)) /* 16 */

TLSF_MIN_BLOCK_SIZE

#define TLSF_MIN_BLOCK_SIZE   TLSF_FREE_BLOCK_SIZE /* 32 — minimum free block */

TLSF_SENTINEL_SIZE

#define TLSF_SENTINEL_SIZE   TLSF_HEADER_SIZE /* 16 — sentinel block */

Typedef Documentation

block_header_t

typedef struct block_header block_header_t

free_block_t

typedef struct free_block free_block_t

tlsf_pool_t

typedef struct tlsf_pool tlsf_pool_t

Function Documentation

tlsf_add_memory()

int tlsf_add_memory	(	tlsf_pool_t *	pool,
		void *	mem,
		size_t	size
	)

tlsf_create()

tlsf_pool_t * tlsf_create

(

void

)

tlsf_free()

void tlsf_free	(	tlsf_pool_t *	pool,
		void *	ptr
	)

tlsf_get_pool()

tlsf_pool_t * tlsf_get_pool

(

void

)

tlsf_malloc()

void * tlsf_malloc	(	tlsf_pool_t *	pool,
		size_t	size
	)

tlsf_realloc()

void * tlsf_realloc	(	tlsf_pool_t *	pool,
		void *	ptr,
		size_t	size
	)