Buffer-based memory allocator. More...

#include "config.h"
#include <stddef.h>

Include dependency graph for memory_buffer_alloc.h:

SECTION: Module settings
The configuration options you can set for this module are in this section. Either change them in config.h or define them on the compiler command line.
#define	MBEDTLS_MEMORY_ALIGN_MULTIPLE 4

#define	MBEDTLS_MEMORY_VERIFY_NONE 0

#define	MBEDTLS_MEMORY_VERIFY_ALLOC (1 << 0)

#define	MBEDTLS_MEMORY_VERIFY_FREE (1 << 1)

#define	MBEDTLS_MEMORY_VERIFY_ALWAYS (MBEDTLS_MEMORY_VERIFY_ALLOC \| MBEDTLS_MEMORY_VERIFY_FREE)

void	mbedtls_memory_buffer_alloc_init (unsigned char *buf, size_t len)
	Initialize use of stack-based memory allocator. The stack-based allocator does memory management inside the presented buffer and does not call calloc() and free(). It sets the global mbedtls_calloc() and mbedtls_free() pointers to its own functions. (Provided mbedtls_calloc() and mbedtls_free() are thread-safe if MBEDTLS_THREADING_C is defined)

void	mbedtls_memory_buffer_alloc_free (void)
	Free the mutex for thread-safety and clear remaining memory.

void	mbedtls_memory_buffer_set_verify (int verify)
	Determine when the allocator should automatically verify the state of the entire chain of headers / meta-data. (Default: MBEDTLS_MEMORY_VERIFY_NONE)

int	mbedtls_memory_buffer_alloc_verify (void)
	Verifies that all headers in the memory buffer are correct and contain sane values. Helps debug buffer-overflow errors.

Detailed Description

Buffer-based memory allocator.

Definition in file memory_buffer_alloc.h.

Macro Definition Documentation

◆ MBEDTLS_MEMORY_ALIGN_MULTIPLE

#define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4

Align on multiples of this value

Definition at line 69 of file memory_buffer_alloc.h.

◆ MBEDTLS_MEMORY_VERIFY_ALLOC

#define MBEDTLS_MEMORY_VERIFY_ALLOC (1 << 0)

Definition at line 75 of file memory_buffer_alloc.h.

◆ MBEDTLS_MEMORY_VERIFY_ALWAYS

#define MBEDTLS_MEMORY_VERIFY_ALWAYS (MBEDTLS_MEMORY_VERIFY_ALLOC | MBEDTLS_MEMORY_VERIFY_FREE)

Definition at line 77 of file memory_buffer_alloc.h.

◆ MBEDTLS_MEMORY_VERIFY_FREE

#define MBEDTLS_MEMORY_VERIFY_FREE (1 << 1)

Definition at line 76 of file memory_buffer_alloc.h.

◆ MBEDTLS_MEMORY_VERIFY_NONE

#define MBEDTLS_MEMORY_VERIFY_NONE 0

Definition at line 74 of file memory_buffer_alloc.h.

Function Documentation

◆ mbedtls_memory_buffer_alloc_free()

void mbedtls_memory_buffer_alloc_free ( void )

Free the mutex for thread-safety and clear remaining memory.

◆ mbedtls_memory_buffer_alloc_init()

void mbedtls_memory_buffer_alloc_init	(	unsigned char *	buf,
		size_t	len
	)

Initialize use of stack-based memory allocator. The stack-based allocator does memory management inside the presented buffer and does not call calloc() and free(). It sets the global mbedtls_calloc() and mbedtls_free() pointers to its own functions. (Provided mbedtls_calloc() and mbedtls_free() are thread-safe if MBEDTLS_THREADING_C is defined)

Note: This code is not optimized and provides a straight-forward implementation of a stack-based memory allocator.

Parameters

buf	buffer to use as heap
len	size of the buffer

◆ mbedtls_memory_buffer_alloc_verify()

int mbedtls_memory_buffer_alloc_verify ( void )

Verifies that all headers in the memory buffer are correct and contain sane values. Helps debug buffer-overflow errors.

Prints out first failure if MBEDTLS_MEMORY_DEBUG is defined. Prints out full header information if MBEDTLS_MEMORY_DEBUG is defined. (Includes stack trace information for each block if MBEDTLS_MEMORY_BACKTRACE is defined as well).

Returns: 0 if verified, 1 otherwise

◆ mbedtls_memory_buffer_set_verify()

void mbedtls_memory_buffer_set_verify ( int verify )

Determine when the allocator should automatically verify the state of the entire chain of headers / meta-data. (Default: MBEDTLS_MEMORY_VERIFY_NONE)