memory_buffer_alloc.h 4.7 KB

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