Donatien Garnier
ZG2100 Network interface source
lwip/include/lwip/mem.h@1:3a7c15057192, 2010-08-06 (annotated)
- Committer:
- donatien
- Date:
- Fri Aug 06 10:23:41 2010 +0000
- Revision:
- 1:3a7c15057192
- Parent:
- 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 | #ifndef __LWIP_MEM_H__ |
| donatien | 0:b802fc31f1db | 33 | #define __LWIP_MEM_H__ |
| donatien | 0:b802fc31f1db | 34 | |
| donatien | 0:b802fc31f1db | 35 | #include "lwip/opt.h" |
| donatien | 0:b802fc31f1db | 36 | |
| donatien | 0:b802fc31f1db | 37 | #ifdef __cplusplus |
| donatien | 0:b802fc31f1db | 38 | extern "C" { |
| donatien | 0:b802fc31f1db | 39 | #endif |
| donatien | 0:b802fc31f1db | 40 | |
| donatien | 0:b802fc31f1db | 41 | #if MEM_LIBC_MALLOC |
| donatien | 0:b802fc31f1db | 42 | |
| donatien | 0:b802fc31f1db | 43 | #include <stddef.h> /* for size_t */ |
| donatien | 0:b802fc31f1db | 44 | |
| donatien | 0:b802fc31f1db | 45 | typedef size_t mem_size_t; |
| donatien | 0:b802fc31f1db | 46 | |
| donatien | 0:b802fc31f1db | 47 | /* aliases for C library malloc() */ |
| donatien | 0:b802fc31f1db | 48 | #define mem_init() |
| donatien | 0:b802fc31f1db | 49 | /* in case C library malloc() needs extra protection, |
| donatien | 0:b802fc31f1db | 50 | * allow these defines to be overridden. |
| donatien | 0:b802fc31f1db | 51 | */ |
| donatien | 0:b802fc31f1db | 52 | #ifndef mem_free |
| donatien | 0:b802fc31f1db | 53 | #define mem_free free |
| donatien | 0:b802fc31f1db | 54 | #endif |
| donatien | 0:b802fc31f1db | 55 | #ifndef mem_malloc |
| donatien | 0:b802fc31f1db | 56 | #define mem_malloc malloc |
| donatien | 0:b802fc31f1db | 57 | #endif |
| donatien | 0:b802fc31f1db | 58 | #ifndef mem_calloc |
| donatien | 0:b802fc31f1db | 59 | #define mem_calloc calloc |
| donatien | 0:b802fc31f1db | 60 | #endif |
| donatien | 0:b802fc31f1db | 61 | /* Since there is no C library allocation function to shrink memory without |
| donatien | 0:b802fc31f1db | 62 | moving it, define this to nothing. */ |
| donatien | 0:b802fc31f1db | 63 | #ifndef mem_trim |
| donatien | 0:b802fc31f1db | 64 | #define mem_trim(mem, size) (mem) |
| donatien | 0:b802fc31f1db | 65 | #endif |
| donatien | 0:b802fc31f1db | 66 | #else /* MEM_LIBC_MALLOC */ |
| donatien | 0:b802fc31f1db | 67 | |
| donatien | 0:b802fc31f1db | 68 | /* MEM_SIZE would have to be aligned, but using 64000 here instead of |
| donatien | 0:b802fc31f1db | 69 | * 65535 leaves some room for alignment... |
| donatien | 0:b802fc31f1db | 70 | */ |
| donatien | 0:b802fc31f1db | 71 | #if MEM_SIZE > 64000l |
| donatien | 0:b802fc31f1db | 72 | typedef u32_t mem_size_t; |
| donatien | 1:3a7c15057192 | 73 | #define MEM_SIZE_F U32_F |
| donatien | 0:b802fc31f1db | 74 | #else |
| donatien | 0:b802fc31f1db | 75 | typedef u16_t mem_size_t; |
| donatien | 1:3a7c15057192 | 76 | #define MEM_SIZE_F U16_F |
| donatien | 0:b802fc31f1db | 77 | #endif /* MEM_SIZE > 64000 */ |
| donatien | 0:b802fc31f1db | 78 | |
| donatien | 0:b802fc31f1db | 79 | #if MEM_USE_POOLS |
| donatien | 0:b802fc31f1db | 80 | /** mem_init is not used when using pools instead of a heap */ |
| donatien | 0:b802fc31f1db | 81 | #define mem_init() |
| donatien | 0:b802fc31f1db | 82 | /** mem_trim is not used when using pools instead of a heap: |
| donatien | 0:b802fc31f1db | 83 | we can't free part of a pool element and don't want to copy the rest */ |
| donatien | 0:b802fc31f1db | 84 | #define mem_trim(mem, size) (mem) |
| donatien | 0:b802fc31f1db | 85 | #else /* MEM_USE_POOLS */ |
| donatien | 0:b802fc31f1db | 86 | /* lwIP alternative malloc */ |
| donatien | 0:b802fc31f1db | 87 | void mem_init(void); |
| donatien | 0:b802fc31f1db | 88 | void *mem_trim(void *mem, mem_size_t size); |
| donatien | 0:b802fc31f1db | 89 | #endif /* MEM_USE_POOLS */ |
| donatien | 0:b802fc31f1db | 90 | void *mem_malloc(mem_size_t size); |
| donatien | 0:b802fc31f1db | 91 | void *mem_calloc(mem_size_t count, mem_size_t size); |
| donatien | 0:b802fc31f1db | 92 | void mem_free(void *mem); |
| donatien | 0:b802fc31f1db | 93 | #endif /* MEM_LIBC_MALLOC */ |
| donatien | 0:b802fc31f1db | 94 | |
| donatien | 0:b802fc31f1db | 95 | /** Calculate memory size for an aligned buffer - returns the next highest |
| donatien | 0:b802fc31f1db | 96 | * multiple of MEM_ALIGNMENT (e.g. LWIP_MEM_ALIGN_SIZE(3) and |
| donatien | 0:b802fc31f1db | 97 | * LWIP_MEM_ALIGN_SIZE(4) will both yield 4 for MEM_ALIGNMENT == 4). |
| donatien | 0:b802fc31f1db | 98 | */ |
| donatien | 0:b802fc31f1db | 99 | #ifndef LWIP_MEM_ALIGN_SIZE |
| donatien | 0:b802fc31f1db | 100 | #define LWIP_MEM_ALIGN_SIZE(size) (((size) + MEM_ALIGNMENT - 1) & ~(MEM_ALIGNMENT-1)) |
| donatien | 0:b802fc31f1db | 101 | #endif |
| donatien | 0:b802fc31f1db | 102 | |
| donatien | 0:b802fc31f1db | 103 | /** Calculate safe memory size for an aligned buffer when using an unaligned |
| donatien | 0:b802fc31f1db | 104 | * type as storage. This includes a safety-margin on (MEM_ALIGNMENT - 1) at the |
| donatien | 0:b802fc31f1db | 105 | * start (e.g. if buffer is u8_t[] and actual data will be u32_t*) |
| donatien | 0:b802fc31f1db | 106 | */ |
| donatien | 0:b802fc31f1db | 107 | #ifndef LWIP_MEM_ALIGN_BUFFER |
| donatien | 0:b802fc31f1db | 108 | #define LWIP_MEM_ALIGN_BUFFER(size) (((size) + MEM_ALIGNMENT - 1)) |
| donatien | 0:b802fc31f1db | 109 | #endif |
| donatien | 0:b802fc31f1db | 110 | |
| donatien | 0:b802fc31f1db | 111 | /** Align a memory pointer to the alignment defined by MEM_ALIGNMENT |
| donatien | 0:b802fc31f1db | 112 | * so that ADDR % MEM_ALIGNMENT == 0 |
| donatien | 0:b802fc31f1db | 113 | */ |
| donatien | 0:b802fc31f1db | 114 | #ifndef LWIP_MEM_ALIGN |
| donatien | 0:b802fc31f1db | 115 | #define LWIP_MEM_ALIGN(addr) ((void *)(((mem_ptr_t)(addr) + MEM_ALIGNMENT - 1) & ~(mem_ptr_t)(MEM_ALIGNMENT-1))) |
| donatien | 0:b802fc31f1db | 116 | #endif |
| donatien | 0:b802fc31f1db | 117 | |
| donatien | 0:b802fc31f1db | 118 | #ifdef __cplusplus |
| donatien | 0:b802fc31f1db | 119 | } |
| donatien | 0:b802fc31f1db | 120 | #endif |
| donatien | 0:b802fc31f1db | 121 | |
| donatien | 0:b802fc31f1db | 122 | #endif /* __LWIP_MEM_H__ */ |