src/include/lwip/mem.h

   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 #ifndef __LWIP_MEM_H__
  33 #define __LWIP_MEM_H__
  34
  35 #include "lwip/opt.h"
  36 #include "lwip/arch.h"
  37
  38 #ifdef __cplusplus
  39 extern "C" {
  40 #endif
  41
  42 /* MEM_SIZE would have to be aligned, but using 64000 here instead of
  43  * 65535 leaves some room for alignment...
  44  */
  45 #if MEM_SIZE > 64000l
  46 typedef u32_t mem_size_t;
  47 #define MEM_SIZE_F U32_F
  48 #else
  49 typedef u16_t mem_size_t;
  50 #define MEM_SIZE_F U16_F
  51 #endif /* MEM_SIZE > 64000 */
  52
  53 #if MEM_LIBC_MALLOC
  54 /* aliases for C library malloc() */
  55 #define mem_init()
  56 /* in case C library malloc() needs extra protection,
  57  * allow these defines to be overridden.
  58  */
  59 #ifndef mem_free
  60 #define mem_free(x) free(x)
  61 #endif
  62 #ifndef mem_malloc
  63 #define mem_malloc(x) malloc(x)
  64 #endif
  65 #ifndef mem_calloc
  66 #define mem_calloc(x, y) calloc(x, y)
  67 #endif
  68 #ifndef mem_realloc
  69 #define mem_realloc(x, size) realloc(x,size)
  70 #endif
  71 #else /* MEM_LIBC_MALLOC */
  72 #if MEM_USE_POOLS
  73 /** The pool implementation of the heap currently uses 4 pools */
  74 #define MEM_POOL_COUNT   4
  75 /** mem_init is not used when using pools instead of a heap */
  76 #define mem_init()
  77 /** mem_realloc is not used when using pools instead of a heap:
  78     we can't free part of a pool element and don't want to copy the rest */
  79 #define mem_realloc(mem, size) (mem)
  80 #else /* MEM_USE_POOLS */
  81 /* lwIP alternative malloc */
  82 void  mem_init(void);
  83 void *mem_realloc(void *mem, mem_size_t size);
  84 #endif /* MEM_USE_POOLS */
  85 void *mem_malloc(mem_size_t size);
  86 void *mem_calloc(size_t count, size_t size);
  87 void  mem_free(void *mem);
  88 #endif /* MEM_LIBC_MALLOC */
  89
  90 #ifndef LWIP_MEM_ALIGN_SIZE
  91 #define LWIP_MEM_ALIGN_SIZE(size) (((size) + MEM_ALIGNMENT - 1) & ~(MEM_ALIGNMENT-1))
  92 #endif
  93
  94 #ifndef LWIP_MEM_ALIGN
  95 #define LWIP_MEM_ALIGN(addr) ((void *)(((mem_ptr_t)(addr) + MEM_ALIGNMENT - 1) & ~(mem_ptr_t)(MEM_ALIGNMENT-1)))
  96 #endif
  97
  98 #ifdef __cplusplus
  99 }
 100 #endif
 101
 102 #endif /* __LWIP_MEM_H__ */