mem.h 4.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143
  1. /*
  2. * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
  3. * All rights reserved.
  4. *
  5. * Redistribution and use in source and binary forms, with or without modification,
  6. * are permitted provided that the following conditions are met:
  7. *
  8. * 1. Redistributions of source code must retain the above copyright notice,
  9. * this list of conditions and the following disclaimer.
  10. * 2. Redistributions in binary form must reproduce the above copyright notice,
  11. * this list of conditions and the following disclaimer in the documentation
  12. * and/or other materials provided with the distribution.
  13. * 3. The name of the author may not be used to endorse or promote products
  14. * derived from this software without specific prior written permission.
  15. *
  16. * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
  17. * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  18. * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
  19. * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  20. * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
  21. * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  22. * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  23. * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
  24. * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
  25. * OF SUCH DAMAGE.
  26. *
  27. * This file is part of the lwIP TCP/IP stack.
  28. *
  29. * Author: Adam Dunkels <adam@sics.se>
  30. *
  31. */
  32. #ifndef __LWIP_MEM_H__
  33. #define __LWIP_MEM_H__
  34. #include "lwip/opt.h"
  35. #include "mem_manager.h"
  36. #ifdef __cplusplus
  37. extern "C" {
  38. #endif
  39. #if MEM_LIBC_MALLOC
  40. #include <stddef.h> /* for size_t */
  41. typedef size_t mem_size_t;
  42. /* aliases for C library malloc() */
  43. #define mem_init()
  44. /* in case C library malloc() needs extra protection,
  45. * allow these defines to be overridden.
  46. */
  47. #ifndef mem_free
  48. #define mem_free vPortFree
  49. #endif
  50. #ifndef mem_malloc
  51. #define mem_malloc pvPortMalloc
  52. #endif
  53. #ifndef mem_calloc
  54. #define mem_calloc pvPortCalloc
  55. #endif
  56. #ifndef mem_realloc
  57. #define mem_realloc pvPortRealloc
  58. #endif
  59. #ifndef mem_zalloc
  60. #define mem_zalloc pvPortZalloc
  61. #endif
  62. #ifndef os_malloc
  63. #define os_malloc(s) mem_malloc((s))
  64. #endif
  65. #ifndef os_realloc
  66. #define os_realloc(p, s) mem_realloc((p), (s))
  67. #endif
  68. #ifndef os_zalloc
  69. #define os_zalloc(s) mem_zalloc((s))
  70. #endif
  71. #ifndef os_free
  72. #define os_free(p) mem_free((p))
  73. #endif
  74. /* Since there is no C library allocation function to shrink memory without
  75. moving it, define this to nothing. */
  76. #ifndef mem_trim
  77. #define mem_trim(mem, size) (mem)
  78. #endif
  79. #else /* MEM_LIBC_MALLOC */
  80. /* MEM_SIZE would have to be aligned, but using 64000 here instead of
  81. * 65535 leaves some room for alignment...
  82. */
  83. #if MEM_SIZE > 64000l
  84. typedef u32_t mem_size_t;
  85. #define MEM_SIZE_F U32_F
  86. #else
  87. typedef u16_t mem_size_t;
  88. #define MEM_SIZE_F U16_F
  89. #endif /* MEM_SIZE > 64000 */
  90. #if MEM_USE_POOLS
  91. /** mem_init is not used when using pools instead of a heap */
  92. #define mem_init()
  93. /** mem_trim is not used when using pools instead of a heap:
  94. we can't free part of a pool element and don't want to copy the rest */
  95. #define mem_trim(mem, size) (mem)
  96. #else /* MEM_USE_POOLS */
  97. /* lwIP alternative malloc */
  98. void mem_init(void)ICACHE_FLASH_ATTR;
  99. void *mem_trim(void *mem, mem_size_t size)ICACHE_FLASH_ATTR;
  100. #endif /* MEM_USE_POOLS */
  101. void *mem_malloc(mem_size_t size)ICACHE_FLASH_ATTR;
  102. void *mem_calloc(mem_size_t count, mem_size_t size)ICACHE_FLASH_ATTR;
  103. void mem_free(void *mem)ICACHE_FLASH_ATTR;
  104. #endif /* MEM_LIBC_MALLOC */
  105. /** Calculate memory size for an aligned buffer - returns the next highest
  106. * multiple of MEM_ALIGNMENT (e.g. LWIP_MEM_ALIGN_SIZE(3) and
  107. * LWIP_MEM_ALIGN_SIZE(4) will both yield 4 for MEM_ALIGNMENT == 4).
  108. */
  109. #ifndef LWIP_MEM_ALIGN_SIZE
  110. #define LWIP_MEM_ALIGN_SIZE(size) (((size) + MEM_ALIGNMENT - 1) & ~(MEM_ALIGNMENT-1))
  111. #endif
  112. /** Calculate safe memory size for an aligned buffer when using an unaligned
  113. * type as storage. This includes a safety-margin on (MEM_ALIGNMENT - 1) at the
  114. * start (e.g. if buffer is u8_t[] and actual data will be u32_t*)
  115. */
  116. #ifndef LWIP_MEM_ALIGN_BUFFER
  117. #define LWIP_MEM_ALIGN_BUFFER(size) (((size) + MEM_ALIGNMENT - 1))
  118. #endif
  119. /** Align a memory pointer to the alignment defined by MEM_ALIGNMENT
  120. * so that ADDR % MEM_ALIGNMENT == 0
  121. */
  122. #ifndef LWIP_MEM_ALIGN
  123. #define LWIP_MEM_ALIGN(addr) ((void *)(((mem_ptr_t)(addr) + MEM_ALIGNMENT - 1) & ~(mem_ptr_t)(MEM_ALIGNMENT-1)))
  124. #endif
  125. #ifdef __cplusplus
  126. }
  127. #endif
  128. #endif /* __LWIP_MEM_H__ */