memory_buffer_alloc.h 4.9 KB

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