1 /** 2 * \file memory_buffer_alloc.h 3 * 4 * \brief Buffer-based memory allocator 5 */ 6 /* 7 * Copyright (C) 2006-2015, ARM Limited, All Rights Reserved 8 * SPDX-License-Identifier: Apache-2.0 9 * 10 * Licensed under the Apache License, Version 2.0 (the "License"); you may 11 * not use this file except in compliance with the License. 12 * You may obtain a copy of the License at 13 * 14 * http://www.apache.org/licenses/LICENSE-2.0 15 * 16 * Unless required by applicable law or agreed to in writing, software 17 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 18 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 19 * See the License for the specific language governing permissions and 20 * limitations under the License. 21 * 22 * This file is part of mbed TLS (https://tls.mbed.org) 23 */ 24 #ifndef MBEDTLS_MEMORY_BUFFER_ALLOC_H 25 #define MBEDTLS_MEMORY_BUFFER_ALLOC_H 26 27 #if !defined(MBEDTLS_CONFIG_FILE) 28 #include "config.h" 29 #else 30 #include MBEDTLS_CONFIG_FILE 31 #endif 32 33 #include <stddef.h> 34 35 /** 36 * \name SECTION: Module settings 37 * 38 * The configuration options you can set for this module are in this section. 39 * Either change them in config.h or define them on the compiler command line. 40 * \{ 41 */ 42 43 #if !defined(MBEDTLS_MEMORY_ALIGN_MULTIPLE) 44 #define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4 /**< Align on multiples of this value */ 45 #endif 46 47 /* \} name SECTION: Module settings */ 48 49 #define MBEDTLS_MEMORY_VERIFY_NONE 0 50 #define MBEDTLS_MEMORY_VERIFY_ALLOC (1 << 0) 51 #define MBEDTLS_MEMORY_VERIFY_FREE (1 << 1) 52 #define MBEDTLS_MEMORY_VERIFY_ALWAYS (MBEDTLS_MEMORY_VERIFY_ALLOC | MBEDTLS_MEMORY_VERIFY_FREE) 53 54 #ifdef __cplusplus 55 extern "C" { 56 #endif 57 58 /** 59 * \brief Initialize use of stack-based memory allocator. 60 * The stack-based allocator does memory management inside the 61 * presented buffer and does not call calloc() and free(). 62 * It sets the global mbedtls_calloc() and mbedtls_free() pointers 63 * to its own functions. 64 * (Provided mbedtls_calloc() and mbedtls_free() are thread-safe if 65 * MBEDTLS_THREADING_C is defined) 66 * 67 * \note This code is not optimized and provides a straight-forward 68 * implementation of a stack-based memory allocator. 69 * 70 * \param buf buffer to use as heap 71 * \param len size of the buffer 72 */ 73 void mbedtls_memory_buffer_alloc_init( unsigned char *buf, size_t len ); 74 75 /** 76 * \brief Free the mutex for thread-safety and clear remaining memory 77 */ 78 void mbedtls_memory_buffer_alloc_free( void ); 79 80 /** 81 * \brief Determine when the allocator should automatically verify the state 82 * of the entire chain of headers / meta-data. 83 * (Default: MBEDTLS_MEMORY_VERIFY_NONE) 84 * 85 * \param verify One of MBEDTLS_MEMORY_VERIFY_NONE, MBEDTLS_MEMORY_VERIFY_ALLOC, 86 * MBEDTLS_MEMORY_VERIFY_FREE or MBEDTLS_MEMORY_VERIFY_ALWAYS 87 */ 88 void mbedtls_memory_buffer_set_verify( int verify ); 89 90 #if defined(MBEDTLS_MEMORY_DEBUG) 91 /** 92 * \brief Print out the status of the allocated memory (primarily for use 93 * after a program should have de-allocated all memory) 94 * Prints out a list of 'still allocated' blocks and their stack 95 * trace if MBEDTLS_MEMORY_BACKTRACE is defined. 96 */ 97 void mbedtls_memory_buffer_alloc_status( void ); 98 99 /** 100 * \brief Get the peak heap usage so far 101 * 102 * \param max_used Peak number of bytes in use or committed. This 103 * includes bytes in allocated blocks too small to split 104 * into smaller blocks but larger than the requested size. 105 * \param max_blocks Peak number of blocks in use, including free and used 106 */ 107 void mbedtls_memory_buffer_alloc_max_get( size_t *max_used, size_t *max_blocks ); 108 109 /** 110 * \brief Reset peak statistics 111 */ 112 void mbedtls_memory_buffer_alloc_max_reset( void ); 113 114 /** 115 * \brief Get the current heap usage 116 * 117 * \param cur_used Current number of bytes in use or committed. This 118 * includes bytes in allocated blocks too small to split 119 * into smaller blocks but larger than the requested size. 120 * \param cur_blocks Current number of blocks in use, including free and used 121 */ 122 void mbedtls_memory_buffer_alloc_cur_get( size_t *cur_used, size_t *cur_blocks ); 123 #endif /* MBEDTLS_MEMORY_DEBUG */ 124 125 /** 126 * \brief Verifies that all headers in the memory buffer are correct 127 * and contain sane values. Helps debug buffer-overflow errors. 128 * 129 * Prints out first failure if MBEDTLS_MEMORY_DEBUG is defined. 130 * Prints out full header information if MBEDTLS_MEMORY_DEBUG 131 * is defined. (Includes stack trace information for each block if 132 * MBEDTLS_MEMORY_BACKTRACE is defined as well). 133 * 134 * \return 0 if verified, 1 otherwise 135 */ 136 int mbedtls_memory_buffer_alloc_verify( void ); 137 138 #if defined(MBEDTLS_SELF_TEST) 139 /** 140 * \brief Checkup routine 141 * 142 * \return 0 if successful, or 1 if a test failed 143 */ 144 int mbedtls_memory_buffer_alloc_self_test( int verbose ); 145 #endif 146 147 #ifdef __cplusplus 148 } 149 #endif 150 151 #endif /* memory_buffer_alloc.h */ 152