Donatien Garnier
ZG2100 Network interface source
lwip/include/lwip/memp.h@0:b802fc31f1db, 2010-07-09 (annotated)
- Committer:
- donatien
- Date:
- Fri Jul 09 15:37:23 2010 +0000
- Revision:
- 0:b802fc31f1db
Who changed what in which revision?
| User | Revision | Line number | New contents of line |
|---|---|---|---|
| donatien | 0:b802fc31f1db | 1 | /* |
| donatien | 0:b802fc31f1db | 2 | * Copyright (c) 2001-2004 Swedish Institute of Computer Science. |
| donatien | 0:b802fc31f1db | 3 | * All rights reserved. |
| donatien | 0:b802fc31f1db | 4 | * |
| donatien | 0:b802fc31f1db | 5 | * Redistribution and use in source and binary forms, with or without modification, |
| donatien | 0:b802fc31f1db | 6 | * are permitted provided that the following conditions are met: |
| donatien | 0:b802fc31f1db | 7 | * |
| donatien | 0:b802fc31f1db | 8 | * 1. Redistributions of source code must retain the above copyright notice, |
| donatien | 0:b802fc31f1db | 9 | * this list of conditions and the following disclaimer. |
| donatien | 0:b802fc31f1db | 10 | * 2. Redistributions in binary form must reproduce the above copyright notice, |
| donatien | 0:b802fc31f1db | 11 | * this list of conditions and the following disclaimer in the documentation |
| donatien | 0:b802fc31f1db | 12 | * and/or other materials provided with the distribution. |
| donatien | 0:b802fc31f1db | 13 | * 3. The name of the author may not be used to endorse or promote products |
| donatien | 0:b802fc31f1db | 14 | * derived from this software without specific prior written permission. |
| donatien | 0:b802fc31f1db | 15 | * |
| donatien | 0:b802fc31f1db | 16 | * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED |
| donatien | 0:b802fc31f1db | 17 | * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF |
| donatien | 0:b802fc31f1db | 18 | * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT |
| donatien | 0:b802fc31f1db | 19 | * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, |
| donatien | 0:b802fc31f1db | 20 | * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT |
| donatien | 0:b802fc31f1db | 21 | * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
| donatien | 0:b802fc31f1db | 22 | * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
| donatien | 0:b802fc31f1db | 23 | * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING |
| donatien | 0:b802fc31f1db | 24 | * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY |
| donatien | 0:b802fc31f1db | 25 | * OF SUCH DAMAGE. |
| donatien | 0:b802fc31f1db | 26 | * |
| donatien | 0:b802fc31f1db | 27 | * This file is part of the lwIP TCP/IP stack. |
| donatien | 0:b802fc31f1db | 28 | * |
| donatien | 0:b802fc31f1db | 29 | * Author: Adam Dunkels <adam@sics.se> |
| donatien | 0:b802fc31f1db | 30 | * |
| donatien | 0:b802fc31f1db | 31 | */ |
| donatien | 0:b802fc31f1db | 32 | |
| donatien | 0:b802fc31f1db | 33 | #ifndef __LWIP_MEMP_H__ |
| donatien | 0:b802fc31f1db | 34 | #define __LWIP_MEMP_H__ |
| donatien | 0:b802fc31f1db | 35 | |
| donatien | 0:b802fc31f1db | 36 | #include "lwip/opt.h" |
| donatien | 0:b802fc31f1db | 37 | |
| donatien | 0:b802fc31f1db | 38 | #ifdef __cplusplus |
| donatien | 0:b802fc31f1db | 39 | extern "C" { |
| donatien | 0:b802fc31f1db | 40 | #endif |
| donatien | 0:b802fc31f1db | 41 | |
| donatien | 0:b802fc31f1db | 42 | /* Create the list of all memory pools managed by memp. MEMP_MAX represents a NULL pool at the end */ |
| donatien | 0:b802fc31f1db | 43 | typedef enum { |
| donatien | 0:b802fc31f1db | 44 | #define LWIP_MEMPOOL(name,num,size,desc) MEMP_##name, |
| donatien | 0:b802fc31f1db | 45 | #include "lwip/memp_std.h" |
| donatien | 0:b802fc31f1db | 46 | MEMP_MAX |
| donatien | 0:b802fc31f1db | 47 | } memp_t; |
| donatien | 0:b802fc31f1db | 48 | |
| donatien | 0:b802fc31f1db | 49 | #if MEM_USE_POOLS |
| donatien | 0:b802fc31f1db | 50 | /* Use a helper type to get the start and end of the user "memory pools" for mem_malloc */ |
| donatien | 0:b802fc31f1db | 51 | typedef enum { |
| donatien | 0:b802fc31f1db | 52 | /* Get the first (via: |
| donatien | 0:b802fc31f1db | 53 | MEMP_POOL_HELPER_START = ((u8_t) 1*MEMP_POOL_A + 0*MEMP_POOL_B + 0*MEMP_POOL_C + 0)*/ |
| donatien | 0:b802fc31f1db | 54 | MEMP_POOL_HELPER_FIRST = ((u8_t) |
| donatien | 0:b802fc31f1db | 55 | #define LWIP_MEMPOOL(name,num,size,desc) |
| donatien | 0:b802fc31f1db | 56 | #define LWIP_MALLOC_MEMPOOL_START 1 |
| donatien | 0:b802fc31f1db | 57 | #define LWIP_MALLOC_MEMPOOL(num, size) * MEMP_POOL_##size + 0 |
| donatien | 0:b802fc31f1db | 58 | #define LWIP_MALLOC_MEMPOOL_END |
| donatien | 0:b802fc31f1db | 59 | #include "lwip/memp_std.h" |
| donatien | 0:b802fc31f1db | 60 | ) , |
| donatien | 0:b802fc31f1db | 61 | /* Get the last (via: |
| donatien | 0:b802fc31f1db | 62 | MEMP_POOL_HELPER_END = ((u8_t) 0 + MEMP_POOL_A*0 + MEMP_POOL_B*0 + MEMP_POOL_C*1) */ |
| donatien | 0:b802fc31f1db | 63 | MEMP_POOL_HELPER_LAST = ((u8_t) |
| donatien | 0:b802fc31f1db | 64 | #define LWIP_MEMPOOL(name,num,size,desc) |
| donatien | 0:b802fc31f1db | 65 | #define LWIP_MALLOC_MEMPOOL_START |
| donatien | 0:b802fc31f1db | 66 | #define LWIP_MALLOC_MEMPOOL(num, size) 0 + MEMP_POOL_##size * |
| donatien | 0:b802fc31f1db | 67 | #define LWIP_MALLOC_MEMPOOL_END 1 |
| donatien | 0:b802fc31f1db | 68 | #include "lwip/memp_std.h" |
| donatien | 0:b802fc31f1db | 69 | ) |
| donatien | 0:b802fc31f1db | 70 | } memp_pool_helper_t; |
| donatien | 0:b802fc31f1db | 71 | |
| donatien | 0:b802fc31f1db | 72 | /* The actual start and stop values are here (cast them over) |
| donatien | 0:b802fc31f1db | 73 | We use this helper type and these defines so we can avoid using const memp_t values */ |
| donatien | 0:b802fc31f1db | 74 | #define MEMP_POOL_FIRST ((memp_t) MEMP_POOL_HELPER_FIRST) |
| donatien | 0:b802fc31f1db | 75 | #define MEMP_POOL_LAST ((memp_t) MEMP_POOL_HELPER_LAST) |
| donatien | 0:b802fc31f1db | 76 | #endif /* MEM_USE_POOLS */ |
| donatien | 0:b802fc31f1db | 77 | |
| donatien | 0:b802fc31f1db | 78 | #if MEMP_MEM_MALLOC || MEM_USE_POOLS |
| donatien | 0:b802fc31f1db | 79 | extern const u16_t memp_sizes[MEMP_MAX]; |
| donatien | 0:b802fc31f1db | 80 | #endif /* MEMP_MEM_MALLOC || MEM_USE_POOLS */ |
| donatien | 0:b802fc31f1db | 81 | |
| donatien | 0:b802fc31f1db | 82 | #if MEMP_MEM_MALLOC |
| donatien | 0:b802fc31f1db | 83 | |
| donatien | 0:b802fc31f1db | 84 | #include "mem.h" |
| donatien | 0:b802fc31f1db | 85 | |
| donatien | 0:b802fc31f1db | 86 | #define memp_init() |
| donatien | 0:b802fc31f1db | 87 | #define memp_malloc(type) mem_malloc(memp_sizes[type]) |
| donatien | 0:b802fc31f1db | 88 | #define memp_free(type, mem) mem_free(mem) |
| donatien | 0:b802fc31f1db | 89 | |
| donatien | 0:b802fc31f1db | 90 | #else /* MEMP_MEM_MALLOC */ |
| donatien | 0:b802fc31f1db | 91 | |
| donatien | 0:b802fc31f1db | 92 | #if MEM_USE_POOLS |
| donatien | 0:b802fc31f1db | 93 | /** This structure is used to save the pool one element came from. */ |
| donatien | 0:b802fc31f1db | 94 | struct memp_malloc_helper |
| donatien | 0:b802fc31f1db | 95 | { |
| donatien | 0:b802fc31f1db | 96 | memp_t poolnr; |
| donatien | 0:b802fc31f1db | 97 | }; |
| donatien | 0:b802fc31f1db | 98 | #endif /* MEM_USE_POOLS */ |
| donatien | 0:b802fc31f1db | 99 | |
| donatien | 0:b802fc31f1db | 100 | void memp_init(void); |
| donatien | 0:b802fc31f1db | 101 | |
| donatien | 0:b802fc31f1db | 102 | #if MEMP_OVERFLOW_CHECK |
| donatien | 0:b802fc31f1db | 103 | void *memp_malloc_fn(memp_t type, const char* file, const int line); |
| donatien | 0:b802fc31f1db | 104 | #define memp_malloc(t) memp_malloc_fn((t), __FILE__, __LINE__) |
| donatien | 0:b802fc31f1db | 105 | #else |
| donatien | 0:b802fc31f1db | 106 | void *memp_malloc(memp_t type); |
| donatien | 0:b802fc31f1db | 107 | #endif |
| donatien | 0:b802fc31f1db | 108 | void memp_free(memp_t type, void *mem); |
| donatien | 0:b802fc31f1db | 109 | |
| donatien | 0:b802fc31f1db | 110 | #endif /* MEMP_MEM_MALLOC */ |
| donatien | 0:b802fc31f1db | 111 | |
| donatien | 0:b802fc31f1db | 112 | #ifdef __cplusplus |
| donatien | 0:b802fc31f1db | 113 | } |
| donatien | 0:b802fc31f1db | 114 | #endif |
| donatien | 0:b802fc31f1db | 115 | |
| donatien | 0:b802fc31f1db | 116 | #endif /* __LWIP_MEMP_H__ */ |