2 * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
5 * Redistribution and use in source and binary forms, with or without modification,
6 * are permitted provided that the following conditions are met:
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.
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
27 * This file is part of the lwIP TCP/IP stack.
29 * Author: Adam Dunkels <adam@sics.se>
32 #ifndef __LWIP_MEM_H__
33 #define __LWIP_MEM_H__
43 #include <stddef.h> /* for size_t */
45 typedef size_t mem_size_t;
47 /* aliases for C library malloc() */
49 /* in case C library malloc() needs extra protection,
50 * allow these defines to be overridden.
56 #define mem_malloc malloc
59 #define mem_calloc calloc
61 /* Since there is no C library allocation function to shrink memory without
62 moving it, define this to nothing. */
64 #define mem_trim(mem, size) (mem)
66 #else /* MEM_LIBC_MALLOC */
68 /* MEM_SIZE would have to be aligned, but using 64000 here instead of
69 * 65535 leaves some room for alignment...
72 typedef u32_t mem_size_t;
73 #define MEM_SIZE_F U32_F
75 typedef u16_t mem_size_t;
76 #define MEM_SIZE_F U16_F
77 #endif /* MEM_SIZE > 64000 */
80 /** mem_init is not used when using pools instead of a heap */
82 /** mem_trim is not used when using pools instead of a heap:
83 we can't free part of a pool element and don't want to copy the rest */
84 #define mem_trim(mem, size) (mem)
85 #else /* MEM_USE_POOLS */
86 /* lwIP alternative malloc */
88 void *mem_trim(void *mem, mem_size_t size);
89 #endif /* MEM_USE_POOLS */
90 void *mem_malloc(mem_size_t size);
91 void *mem_calloc(mem_size_t count, mem_size_t size);
92 void mem_free(void *mem);
93 #endif /* MEM_LIBC_MALLOC */
95 /** Calculate memory size for an aligned buffer - returns the next highest
96 * multiple of MEM_ALIGNMENT (e.g. LWIP_MEM_ALIGN_SIZE(3) and
97 * LWIP_MEM_ALIGN_SIZE(4) will both yield 4 for MEM_ALIGNMENT == 4).
99 #ifndef LWIP_MEM_ALIGN_SIZE
100 #define LWIP_MEM_ALIGN_SIZE(size) (((size) + MEM_ALIGNMENT - 1) & ~(MEM_ALIGNMENT-1))
103 /** Calculate safe memory size for an aligned buffer when using an unaligned
104 * type as storage. This includes a safety-margin on (MEM_ALIGNMENT - 1) at the
105 * start (e.g. if buffer is u8_t[] and actual data will be u32_t*)
107 #ifndef LWIP_MEM_ALIGN_BUFFER
108 #define LWIP_MEM_ALIGN_BUFFER(size) (((size) + MEM_ALIGNMENT - 1))
111 /** Align a memory pointer to the alignment defined by MEM_ALIGNMENT
112 * so that ADDR % MEM_ALIGNMENT == 0
114 #ifndef LWIP_MEM_ALIGN
115 #define LWIP_MEM_ALIGN(addr) ((void *)(((mem_ptr_t)(addr) + MEM_ALIGNMENT - 1) & ~(mem_ptr_t)(MEM_ALIGNMENT-1)))
122 #endif /* __LWIP_MEM_H__ */