memp.h 3.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116
  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_MEMP_H__
  33. #define __LWIP_MEMP_H__
  34. #include "lwip/opt.h"
  35. #ifdef __cplusplus
  36. extern "C" {
  37. #endif
  38. /* Create the list of all memory pools managed by memp. MEMP_MAX represents a NULL pool at the end */
  39. typedef enum {
  40. #define LWIP_MEMPOOL(name,num,size,desc, attr) MEMP_##name,
  41. #include "lwip/memp_std.h"
  42. MEMP_MAX
  43. } memp_t;
  44. #if MEM_USE_POOLS
  45. /* Use a helper type to get the start and end of the user "memory pools" for mem_malloc */
  46. typedef enum {
  47. /* Get the first (via:
  48. MEMP_POOL_HELPER_START = ((u8_t) 1*MEMP_POOL_A + 0*MEMP_POOL_B + 0*MEMP_POOL_C + 0)*/
  49. MEMP_POOL_HELPER_FIRST = ((u8_t)
  50. #define LWIP_MEMPOOL(name,num,size,desc)
  51. #define LWIP_MALLOC_MEMPOOL_START 1
  52. #define LWIP_MALLOC_MEMPOOL(num, size) * MEMP_POOL_##size + 0
  53. #define LWIP_MALLOC_MEMPOOL_END
  54. #include "lwip/memp_std.h"
  55. ) ,
  56. /* Get the last (via:
  57. MEMP_POOL_HELPER_END = ((u8_t) 0 + MEMP_POOL_A*0 + MEMP_POOL_B*0 + MEMP_POOL_C*1) */
  58. MEMP_POOL_HELPER_LAST = ((u8_t)
  59. #define LWIP_MEMPOOL(name,num,size,desc)
  60. #define LWIP_MALLOC_MEMPOOL_START
  61. #define LWIP_MALLOC_MEMPOOL(num, size) 0 + MEMP_POOL_##size *
  62. #define LWIP_MALLOC_MEMPOOL_END 1
  63. #include "lwip/memp_std.h"
  64. )
  65. } memp_pool_helper_t;
  66. /* The actual start and stop values are here (cast them over)
  67. We use this helper type and these defines so we can avoid using const memp_t values */
  68. #define MEMP_POOL_FIRST ((memp_t) MEMP_POOL_HELPER_FIRST)
  69. #define MEMP_POOL_LAST ((memp_t) MEMP_POOL_HELPER_LAST)
  70. #endif /* MEM_USE_POOLS */
  71. #if MEMP_MEM_MALLOC || MEM_USE_POOLS
  72. extern const u32_t memp_sizes[MEMP_MAX];
  73. #endif /* MEMP_MEM_MALLOC || MEM_USE_POOLS */
  74. #if MEMP_MEM_MALLOC
  75. #include "mem.h"
  76. #define memp_init()
  77. #define memp_malloc(type) mem_malloc(memp_sizes[type])
  78. #define memp_free(type, mem) mem_free(mem)
  79. #else /* MEMP_MEM_MALLOC */
  80. #if MEM_USE_POOLS
  81. /** This structure is used to save the pool one element came from. */
  82. struct memp_malloc_helper
  83. {
  84. memp_t poolnr;
  85. };
  86. #endif /* MEM_USE_POOLS */
  87. void memp_init(void)ICACHE_FLASH_ATTR;
  88. #if MEMP_OVERFLOW_CHECK
  89. void *memp_malloc_fn(memp_t type, const char* file, const int line)ICACHE_FLASH_ATTR;
  90. #define memp_malloc(t) memp_malloc_fn((t), __FILE__, __LINE__)
  91. #else
  92. void *memp_malloc(memp_t type)ICACHE_FLASH_ATTR;
  93. #endif
  94. void memp_free(memp_t type, void *mem)ICACHE_FLASH_ATTR;
  95. #endif /* MEMP_MEM_MALLOC */
  96. #ifdef __cplusplus
  97. }
  98. #endif
  99. #endif /* __LWIP_MEMP_H__ */