Simon Cooksey / mbed-os
Embed: (wiki syntax)

« Back to documentation index

Show/hide line numbers mem.h Source File

mem.h

Go to the documentation of this file.
00001 /**
00002  * @file
00003  * Heap API
00004  */
00005 
00006 /*
00007  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
00008  * All rights reserved.
00009  *
00010  * Redistribution and use in source and binary forms, with or without modification,
00011  * are permitted provided that the following conditions are met:
00012  *
00013  * 1. Redistributions of source code must retain the above copyright notice,
00014  *    this list of conditions and the following disclaimer.
00015  * 2. Redistributions in binary form must reproduce the above copyright notice,
00016  *    this list of conditions and the following disclaimer in the documentation
00017  *    and/or other materials provided with the distribution.
00018  * 3. The name of the author may not be used to endorse or promote products
00019  *    derived from this software without specific prior written permission.
00020  *
00021  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
00022  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
00023  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
00024  * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00025  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
00026  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
00027  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
00028  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
00029  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
00030  * OF SUCH DAMAGE.
00031  *
00032  * This file is part of the lwIP TCP/IP stack.
00033  *
00034  * Author: Adam Dunkels <adam@sics.se>
00035  *
00036  */
00037 #ifndef LWIP_HDR_MEM_H
00038 #define LWIP_HDR_MEM_H
00039 
00040 #include "lwip/opt.h"
00041 
00042 #ifdef __cplusplus
00043 extern "C" {
00044 #endif
00045 
00046 #if MEM_LIBC_MALLOC
00047 
00048 #include <stddef.h> /* for size_t */
00049 typedef size_t mem_size_t;
00050 #define MEM_SIZE_F SZT_F
00051 
00052 #elif MEM_USE_POOLS
00053 
00054 typedef u16_t mem_size_t;
00055 #define MEM_SIZE_F U16_F
00056 
00057 #else
00058 
00059 /* MEM_SIZE would have to be aligned, but using 64000 here instead of
00060  * 65535 leaves some room for alignment...
00061  */
00062 #if MEM_SIZE > 64000L
00063 typedef u32_t mem_size_t;
00064 #define MEM_SIZE_F U32_F
00065 #else
00066 typedef u16_t mem_size_t;
00067 #define MEM_SIZE_F U16_F
00068 #endif /* MEM_SIZE > 64000 */
00069 #endif
00070 
00071 void  mem_init(void);
00072 void *mem_trim(void *mem, mem_size_t size);
00073 void *mem_malloc(mem_size_t size);
00074 void *mem_calloc(mem_size_t count, mem_size_t size);
00075 void  mem_free(void *mem);
00076 
00077 #ifdef __cplusplus
00078 }
00079 #endif
00080 
00081 #endif /* LWIP_HDR_MEM_H */