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