mbed TLS v3.1.0
memory_buffer_alloc.h
Go to the documentation of this file.
1 
6 /*
7  * Copyright The Mbed TLS Contributors
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 #ifndef MBEDTLS_MEMORY_BUFFER_ALLOC_H
23 #define MBEDTLS_MEMORY_BUFFER_ALLOC_H
24 
25 #include "mbedtls/build_info.h"
26 
27 #include <stddef.h>
28 
37 #if !defined(MBEDTLS_MEMORY_ALIGN_MULTIPLE)
38 #define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4
39 #endif
40 
41 /* \} name SECTION: Module settings */
42 
43 #define MBEDTLS_MEMORY_VERIFY_NONE 0
44 #define MBEDTLS_MEMORY_VERIFY_ALLOC (1 << 0)
45 #define MBEDTLS_MEMORY_VERIFY_FREE (1 << 1)
46 #define MBEDTLS_MEMORY_VERIFY_ALWAYS (MBEDTLS_MEMORY_VERIFY_ALLOC | MBEDTLS_MEMORY_VERIFY_FREE)
47 
48 #ifdef __cplusplus
49 extern "C" {
50 #endif
51 
67 void mbedtls_memory_buffer_alloc_init( unsigned char *buf, size_t len );
68 
73 
82 void mbedtls_memory_buffer_set_verify( int verify );
83 
84 #if defined(MBEDTLS_MEMORY_DEBUG)
85 
92 
101 void mbedtls_memory_buffer_alloc_max_get( size_t *max_used, size_t *max_blocks );
102 
107 
116 void mbedtls_memory_buffer_alloc_cur_get( size_t *cur_used, size_t *cur_blocks );
117 #endif /* MBEDTLS_MEMORY_DEBUG */
118 
131 
132 #if defined(MBEDTLS_SELF_TEST)
133 
138 int mbedtls_memory_buffer_alloc_self_test( int verbose );
139 #endif
140 
141 #ifdef __cplusplus
142 }
143 #endif
144 
145 #endif /* memory_buffer_alloc.h */
int mbedtls_memory_buffer_alloc_self_test(int verbose)
Checkup routine.
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.
void mbedtls_memory_buffer_alloc_max_get(size_t *max_used, size_t *max_blocks)
Get the peak heap usage so far.
void mbedtls_memory_buffer_alloc_max_reset(void)
Reset peak statistics.
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 insi...
void mbedtls_memory_buffer_alloc_free(void)
Free the mutex for thread-safety and clear remaining memory.
Build-time configuration info.
void mbedtls_memory_buffer_alloc_status(void)
Print out the status of the allocated memory (primarily for use after a program should have de-alloca...
void mbedtls_memory_buffer_alloc_cur_get(size_t *cur_used, size_t *cur_blocks)
Get the current heap usage.
void mbedtls_memory_buffer_set_verify(int verify)
Determine when the allocator should automatically verify the state of the entire chain of headers / m...