mbed TLS v2.16.8
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 OR GPL-2.0-or-later
9  *
10  * This file is provided under the Apache License 2.0, or the
11  * GNU General Public License v2.0 or later.
12  *
13  * **********
14  * Apache License 2.0:
15  *
16  * Licensed under the Apache License, Version 2.0 (the "License"); you may
17  * not use this file except in compliance with the License.
18  * You may obtain a copy of the License at
19  *
20  * http://www.apache.org/licenses/LICENSE-2.0
21  *
22  * Unless required by applicable law or agreed to in writing, software
23  * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
24  * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
25  * See the License for the specific language governing permissions and
26  * limitations under the License.
27  *
28  * **********
29  *
30  * **********
31  * GNU General Public License v2.0 or later:
32  *
33  * This program is free software; you can redistribute it and/or modify
34  * it under the terms of the GNU General Public License as published by
35  * the Free Software Foundation; either version 2 of the License, or
36  * (at your option) any later version.
37  *
38  * This program is distributed in the hope that it will be useful,
39  * but WITHOUT ANY WARRANTY; without even the implied warranty of
40  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
41  * GNU General Public License for more details.
42  *
43  * You should have received a copy of the GNU General Public License along
44  * with this program; if not, write to the Free Software Foundation, Inc.,
45  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
46  *
47  * **********
48  */
49 #ifndef MBEDTLS_MEMORY_BUFFER_ALLOC_H
50 #define MBEDTLS_MEMORY_BUFFER_ALLOC_H
51 
52 #if !defined(MBEDTLS_CONFIG_FILE)
53 #include "config.h"
54 #else
55 #include MBEDTLS_CONFIG_FILE
56 #endif
57 
58 #include <stddef.h>
59 
68 #if !defined(MBEDTLS_MEMORY_ALIGN_MULTIPLE)
69 #define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4
70 #endif
71 
72 /* \} name SECTION: Module settings */
73 
74 #define MBEDTLS_MEMORY_VERIFY_NONE 0
75 #define MBEDTLS_MEMORY_VERIFY_ALLOC (1 << 0)
76 #define MBEDTLS_MEMORY_VERIFY_FREE (1 << 1)
77 #define MBEDTLS_MEMORY_VERIFY_ALWAYS (MBEDTLS_MEMORY_VERIFY_ALLOC | MBEDTLS_MEMORY_VERIFY_FREE)
78 
79 #ifdef __cplusplus
80 extern "C" {
81 #endif
82 
98 void mbedtls_memory_buffer_alloc_init( unsigned char *buf, size_t len );
99 
104 
113 void mbedtls_memory_buffer_set_verify( int verify );
114 
115 #if defined(MBEDTLS_MEMORY_DEBUG)
116 
122 void mbedtls_memory_buffer_alloc_status( void );
123 
132 void mbedtls_memory_buffer_alloc_max_get( size_t *max_used, size_t *max_blocks );
133 
137 void mbedtls_memory_buffer_alloc_max_reset( void );
138 
147 void mbedtls_memory_buffer_alloc_cur_get( size_t *cur_used, size_t *cur_blocks );
148 #endif /* MBEDTLS_MEMORY_DEBUG */
149 
162 
163 #if defined(MBEDTLS_SELF_TEST)
164 
169 int mbedtls_memory_buffer_alloc_self_test( int verbose );
170 #endif
171 
172 #ifdef __cplusplus
173 }
174 #endif
175 
176 #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....
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...