mem.h

00001 /*
00002  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
00003  * All rights reserved. 
00004  * 
00005  * Redistribution and use in source and binary forms, with or without modification, 
00006  * are permitted provided that the following conditions are met:
00007  *
00008  * 1. Redistributions of source code must retain the above copyright notice,
00009  *    this list of conditions and the following disclaimer.
00010  * 2. Redistributions in binary form must reproduce the above copyright notice,
00011  *    this list of conditions and the following disclaimer in the documentation
00012  *    and/or other materials provided with the distribution.
00013  * 3. The name of the author may not be used to endorse or promote products
00014  *    derived from this software without specific prior written permission. 
00015  *
00016  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED 
00017  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 
00018  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT 
00019  * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 
00020  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT 
00021  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
00022  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
00023  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 
00024  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY 
00025  * OF SUCH DAMAGE.
00026  *
00027  * This file is part of the lwIP TCP/IP stack.
00028  * 
00029  * Author: Adam Dunkels <adam@sics.se>
00030  *
00031  */
00032 #ifndef __LWIP_MEM_H__
00033 #define __LWIP_MEM_H__
00034 
00035 #include "lwip/opt.h"
00036 
00037 #ifdef __cplusplus
00038 extern "C" {
00039 #endif
00040 
00041 #if MEM_LIBC_MALLOC
00042 
00043 #include <stddef.h> /* for size_t */
00044 
00045 typedef size_t mem_size_t;
00046 
00047 /* aliases for C library malloc() */
00048 #define mem_init()
00049 /* in case C library malloc() needs extra protection,
00050  * allow these defines to be overridden.
00051  */
00052 #ifndef mem_free
00053 #define mem_free free
00054 #endif
00055 #ifndef mem_malloc
00056 #define mem_malloc malloc
00057 #endif
00058 #ifndef mem_calloc
00059 #define mem_calloc calloc
00060 #endif
00061 /* Since there is no C library allocation function to shrink memory without
00062    moving it, define this to nothing. */
00063 #ifndef mem_trim
00064 #define mem_trim(mem, size) (mem)
00065 #endif
00066 #else /* MEM_LIBC_MALLOC */
00067 
00068 /* MEM_SIZE would have to be aligned, but using 64000 here instead of
00069  * 65535 leaves some room for alignment...
00070  */
00071 #if MEM_SIZE > 64000L
00072 typedef u32_t mem_size_t;
00073 #define MEM_SIZE_F U32_F
00074 #else
00075 typedef u16_t mem_size_t;
00076 #define MEM_SIZE_F U16_F
00077 #endif /* MEM_SIZE > 64000 */
00078 
00079 #if MEM_USE_POOLS
00080 /** mem_init is not used when using pools instead of a heap */
00081 #define mem_init()
00082 /** mem_trim is not used when using pools instead of a heap:
00083     we can't free part of a pool element and don't want to copy the rest */
00084 #define mem_trim(mem, size) (mem)
00085 #else /* MEM_USE_POOLS */
00086 /* lwIP alternative malloc */
00087 void  mem_init(void);
00088 void *mem_trim(void *mem, mem_size_t size);
00089 #endif /* MEM_USE_POOLS */
00090 void *mem_malloc(mem_size_t size);
00091 void *mem_calloc(mem_size_t count, mem_size_t size);
00092 void  mem_free(void *mem);
00093 #endif /* MEM_LIBC_MALLOC */
00094 
00095 /** Calculate memory size for an aligned buffer - returns the next highest
00096  * multiple of MEM_ALIGNMENT (e.g. LWIP_MEM_ALIGN_SIZE(3) and
00097  * LWIP_MEM_ALIGN_SIZE(4) will both yield 4 for MEM_ALIGNMENT == 4).
00098  */
00099 #ifndef LWIP_MEM_ALIGN_SIZE
00100 #define LWIP_MEM_ALIGN_SIZE(size) (((size) + MEM_ALIGNMENT - 1) & ~(MEM_ALIGNMENT-1))
00101 #endif
00102 
00103 /** Calculate safe memory size for an aligned buffer when using an unaligned
00104  * type as storage. This includes a safety-margin on (MEM_ALIGNMENT - 1) at the
00105  * start (e.g. if buffer is u8_t[] and actual data will be u32_t*)
00106  */
00107 #ifndef LWIP_MEM_ALIGN_BUFFER
00108 #define LWIP_MEM_ALIGN_BUFFER(size) (((size) + MEM_ALIGNMENT - 1))
00109 #endif
00110 
00111 /** Align a memory pointer to the alignment defined by MEM_ALIGNMENT
00112  * so that ADDR % MEM_ALIGNMENT == 0
00113  */
00114 #ifndef LWIP_MEM_ALIGN
00115 #define LWIP_MEM_ALIGN(addr) ((void *)(((mem_ptr_t)(addr) + MEM_ALIGNMENT - 1) & ~(mem_ptr_t)(MEM_ALIGNMENT-1)))
00116 #endif
00117 
00118 
00119 #ifdef __cplusplus
00120 }
00121 #endif
00122 
00123 #endif /* __LWIP_MEM_H__ */