Doug Anson / mbedTLSLibrary

mbed TLS library

Dependents:   HTTPClient-SSL WS_SERVER

Embed: (wiki syntax)

« Back to documentation index

memory_buffer_alloc.h File Reference
Functions

memory_buffer_alloc.h File Reference

Buffer-based memory allocator. More...

Go to the source code of this file.

Functions

int memory_buffer_alloc_init (unsigned char *buf, size_t len)
 Initialize use of stack-based memory allocator.
void memory_buffer_alloc_free (void)
 Free the mutex for thread-safety and clear remaining memory.
void memory_buffer_set_verify (int verify)
 Determine when the allocator should automatically verify the state of the entire chain of headers / meta-data.
void memory_buffer_alloc_status (void)
 Print out the status of the allocated memory (primarily for use after a program should have de-allocated all memory) Prints out a list of 'still allocated' blocks and their stack trace if POLARSSL_MEMORY_BACKTRACE is defined.
void memory_buffer_alloc_max_get (size_t *max_used, size_t *max_blocks)
 Get the peak heap usage so far.
void memory_buffer_alloc_max_reset (void)
 Reset peak statistics.
void memory_buffer_alloc_cur_get (size_t *cur_used, size_t *cur_blocks)
 Get the current heap usage.
int memory_buffer_alloc_verify (void)
 Verifies that all headers in the memory buffer are correct and contain sane values.
int memory_buffer_alloc_self_test (int verbose)
 Checkup routine.

Detailed Description

Buffer-based memory allocator.

Copyright (C) 2006-2014, ARM Limited, All Rights Reserved

This file is part of mbed TLS (https://tls.mbed.org)

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

Definition in file memory_buffer_alloc.h.

Function Documentation

void memory_buffer_alloc_cur_get ( size_t *  cur_used,
size_t *  cur_blocks 
)

Get the current heap usage.

Parameters:
cur_usedNumber of bytes reauested by the application
cur_blocksNumber of blocks reauested by the application

Definition at line 534 of file memory_buffer_alloc.c.

void memory_buffer_alloc_free ( void   )

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

Definition at line 592 of file memory_buffer_alloc.c.

int 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 malloc() and free(). It sets the global polarssl_malloc() and polarssl_free() pointers to its own functions. (Provided polarssl_malloc() and polarssl_free() are thread-safe if POLARSSL_THREADING_C is defined)

Note:
This code is not optimized and provides a straight-forward implementation of a stack-based memory allocator.
Parameters:
bufbuffer to use as heap
lensize of the buffer
Returns:
0 if successful

Definition at line 559 of file memory_buffer_alloc.c.

void memory_buffer_alloc_max_get ( size_t *  max_used,
size_t *  max_blocks 
)

Get the peak heap usage so far.

Parameters:
max_usedPeak number of bytes reauested by the application
max_blocksPeak number of blocks reauested by the application

Definition at line 522 of file memory_buffer_alloc.c.

void memory_buffer_alloc_max_reset ( void   )

Reset peak statistics.

Definition at line 528 of file memory_buffer_alloc.c.

int memory_buffer_alloc_self_test ( int  verbose )

Checkup routine.

Returns:
0 if successful, or 1 if a test failed

Definition at line 637 of file memory_buffer_alloc.c.

void memory_buffer_alloc_status ( void   )

Print out the status of the allocated memory (primarily for use after a program should have de-allocated all memory) Prints out a list of 'still allocated' blocks and their stack trace if POLARSSL_MEMORY_BACKTRACE is defined.

Definition at line 502 of file memory_buffer_alloc.c.

int 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 POLARSSL_MEMORY_DEBUG is defined. Prints out full header information if POLARSSL_MEMORY_DEBUG_HEADERS is defined. (Includes stack trace information for each block if POLARSSL_MEMORY_BACKTRACE is defined as well).

Returns:
0 if verified, 1 otherwise

Definition at line 496 of file memory_buffer_alloc.c.

void memory_buffer_set_verify ( int  verify )

Determine when the allocator should automatically verify the state of the entire chain of headers / meta-data.

(Default: MEMORY_VERIFY_NONE)

Parameters:
verifyOne of MEMORY_VERIFY_NONE, MEMORY_VERIFY_ALLOC, MEMORY_VERIFY_FREE or MEMORY_VERIFY_ALWAYS

Definition at line 491 of file memory_buffer_alloc.c.

Generated on Tue Jul 12 2022 13:50:40 by  doxygen 1.7.2