Mbed TLS v2.28.5
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 #if !defined(MBEDTLS_CONFIG_FILE)
26 #include "mbedtls/config.h"
27 #else
28 #include MBEDTLS_CONFIG_FILE
29 #endif
30 
31 #include <stddef.h>
32 
41 #if !defined(MBEDTLS_MEMORY_ALIGN_MULTIPLE)
42 #define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4
43 #endif
44 
47 #define MBEDTLS_MEMORY_VERIFY_NONE 0
48 #define MBEDTLS_MEMORY_VERIFY_ALLOC (1 << 0)
49 #define MBEDTLS_MEMORY_VERIFY_FREE (1 << 1)
50 #define MBEDTLS_MEMORY_VERIFY_ALWAYS (MBEDTLS_MEMORY_VERIFY_ALLOC | \
51  MBEDTLS_MEMORY_VERIFY_FREE)
52 
53 #ifdef __cplusplus
54 extern "C" {
55 #endif
56 
72 void mbedtls_memory_buffer_alloc_init(unsigned char *buf, size_t len);
73 
78 
87 void mbedtls_memory_buffer_set_verify(int verify);
88 
89 #if defined(MBEDTLS_MEMORY_DEBUG)
90 
96 void mbedtls_memory_buffer_alloc_status(void);
97 
106 void mbedtls_memory_buffer_alloc_max_get(size_t *max_used, size_t *max_blocks);
107 
111 void mbedtls_memory_buffer_alloc_max_reset(void);
112 
121 void mbedtls_memory_buffer_alloc_cur_get(size_t *cur_used, size_t *cur_blocks);
122 #endif /* MBEDTLS_MEMORY_DEBUG */
123 
136 
137 #if defined(MBEDTLS_SELF_TEST)
138 
144 #endif
145 
146 #ifdef __cplusplus
147 }
148 #endif
149 
150 #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.
Configuration options (set of defines)
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.
void mbedtls_memory_buffer_set_verify(int verify)
Determine when the allocator should automatically verify the state of the entire chain of headers / m...