reactos/include/reactos/libs/mbedtls/memory_buffer_alloc.h

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