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