memory_buffer_alloc.h 5.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151
  1. /**
  2. * \file memory_buffer_alloc.h
  3. *
  4. * \brief Buffer-based memory allocator
  5. */
  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. #if !defined(MBEDTLS_CONFIG_FILE)
  27. #include "config.h"
  28. #else
  29. #include MBEDTLS_CONFIG_FILE
  30. #endif
  31. #include <stddef.h>
  32. /**
  33. * \name SECTION: Module settings
  34. *
  35. * The configuration options you can set for this module are in this section.
  36. * Either change them in config.h or define them on the compiler command line.
  37. * \{
  38. */
  39. #if !defined(MBEDTLS_MEMORY_ALIGN_MULTIPLE)
  40. #define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4 /**< Align on multiples of this value */
  41. #endif
  42. /* \} name SECTION: Module settings */
  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. #ifdef __cplusplus
  48. extern "C" {
  49. #endif
  50. /**
  51. * \brief Initialize use of stack-based memory allocator.
  52. * The stack-based allocator does memory management inside the
  53. * presented buffer and does not call calloc() and free().
  54. * It sets the global mbedtls_calloc() and mbedtls_free() pointers
  55. * to its own functions.
  56. * (Provided mbedtls_calloc() and mbedtls_free() are thread-safe if
  57. * MBEDTLS_THREADING_C is defined)
  58. *
  59. * \note This code is not optimized and provides a straight-forward
  60. * implementation of a stack-based memory allocator.
  61. *
  62. * \param buf buffer to use as heap
  63. * \param len size of the buffer
  64. */
  65. void mbedtls_memory_buffer_alloc_init( unsigned char *buf, size_t len );
  66. /**
  67. * \brief Free the mutex for thread-safety and clear remaining memory
  68. */
  69. void mbedtls_memory_buffer_alloc_free( void );
  70. /**
  71. * \brief Determine when the allocator should automatically verify the state
  72. * of the entire chain of headers / meta-data.
  73. * (Default: MBEDTLS_MEMORY_VERIFY_NONE)
  74. *
  75. * \param verify One of MBEDTLS_MEMORY_VERIFY_NONE, MBEDTLS_MEMORY_VERIFY_ALLOC,
  76. * MBEDTLS_MEMORY_VERIFY_FREE or MBEDTLS_MEMORY_VERIFY_ALWAYS
  77. */
  78. void mbedtls_memory_buffer_set_verify( int verify );
  79. #if defined(MBEDTLS_MEMORY_DEBUG)
  80. /**
  81. * \brief Print out the status of the allocated memory (primarily for use
  82. * after a program should have de-allocated all memory)
  83. * Prints out a list of 'still allocated' blocks and their stack
  84. * trace if MBEDTLS_MEMORY_BACKTRACE is defined.
  85. */
  86. void mbedtls_memory_buffer_alloc_status( void );
  87. /**
  88. * \brief Get the peak heap usage so far
  89. *
  90. * \param max_used Peak number of bytes in use or committed. This
  91. * includes bytes in allocated blocks too small to split
  92. * into smaller blocks but larger than the requested size.
  93. * \param max_blocks Peak number of blocks in use, including free and used
  94. */
  95. void mbedtls_memory_buffer_alloc_max_get( size_t *max_used, size_t *max_blocks );
  96. /**
  97. * \brief Reset peak statistics
  98. */
  99. void mbedtls_memory_buffer_alloc_max_reset( void );
  100. /**
  101. * \brief Get the current heap usage
  102. *
  103. * \param cur_used Current number of bytes in use or committed. This
  104. * includes bytes in allocated blocks too small to split
  105. * into smaller blocks but larger than the requested size.
  106. * \param cur_blocks Current number of blocks in use, including free and used
  107. */
  108. void mbedtls_memory_buffer_alloc_cur_get( size_t *cur_used, size_t *cur_blocks );
  109. #endif /* MBEDTLS_MEMORY_DEBUG */
  110. /**
  111. * \brief Verifies that all headers in the memory buffer are correct
  112. * and contain sane values. Helps debug buffer-overflow errors.
  113. *
  114. * Prints out first failure if MBEDTLS_MEMORY_DEBUG is defined.
  115. * Prints out full header information if MBEDTLS_MEMORY_DEBUG
  116. * is defined. (Includes stack trace information for each block if
  117. * MBEDTLS_MEMORY_BACKTRACE is defined as well).
  118. *
  119. * \return 0 if verified, 1 otherwise
  120. */
  121. int mbedtls_memory_buffer_alloc_verify( void );
  122. #if defined(MBEDTLS_SELF_TEST)
  123. /**
  124. * \brief Checkup routine
  125. *
  126. * \return 0 if successful, or 1 if a test failed
  127. */
  128. int mbedtls_memory_buffer_alloc_self_test( int verbose );
  129. #endif
  130. #ifdef __cplusplus
  131. }
  132. #endif
  133. #endif /* memory_buffer_alloc.h */