mbed TLS v2.16.0: memory_buffer_alloc.h Source File

mbed TLS v2.16.0

memory_buffer_alloc.h
Go to the documentation of this file.
1
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
43 #if !defined(MBEDTLS_MEMORY_ALIGN_MULTIPLE)
44 #define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4
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
73 void mbedtls_memory_buffer_alloc_init( unsigned char *buf, size_t len );
74
78 void mbedtls_memory_buffer_alloc_free( void );
79
88 void mbedtls_memory_buffer_set_verify( int verify );
89
90 #if defined(MBEDTLS_MEMORY_DEBUG)
91
97 void mbedtls_memory_buffer_alloc_status( void );
98
107 void mbedtls_memory_buffer_alloc_max_get( size_t *max_used, size_t *max_blocks );
108
112 void mbedtls_memory_buffer_alloc_max_reset( void );
113
122 void mbedtls_memory_buffer_alloc_cur_get( size_t *cur_used, size_t *cur_blocks );
123 #endif /* MBEDTLS_MEMORY_DEBUG */
124
136 int mbedtls_memory_buffer_alloc_verify( void );
137
138 #if defined(MBEDTLS_SELF_TEST)
139
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 */
mbedtls_memory_buffer_alloc_self_test
int mbedtls_memory_buffer_alloc_self_test(int verbose)
Checkup routine.
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....
config.h
Configuration options (set of defines)
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 insi...
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_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 / m...