heap.h

Go to the documentation of this file.
00001 #ifndef _SYS_HEAP_H_
00002 #define _SYS_HEAP_H_
00003 
00004 /*
00005  * Copyright (C) 2001-2003 by egnite Software GmbH. All rights reserved.
00006  *
00007  * Redistribution and use in source and binary forms, with or without
00008  * modification, are permitted provided that the following conditions
00009  * are met:
00010  *
00011  * 1. Redistributions of source code must retain the above copyright
00012  *    notice, this list of conditions and the following disclaimer.
00013  * 2. Redistributions in binary form must reproduce the above copyright
00014  *    notice, this list of conditions and the following disclaimer in the
00015  *    documentation and/or other materials provided with the distribution.
00016  * 3. Neither the name of the copyright holders nor the names of
00017  *    contributors may be used to endorse or promote products derived
00018  *    from this software without specific prior written permission.
00019  *
00020  * THIS SOFTWARE IS PROVIDED BY EGNITE SOFTWARE GMBH AND CONTRIBUTORS
00021  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
00022  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
00023  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL EGNITE
00024  * SOFTWARE GMBH OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
00025  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
00026  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
00027  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
00028  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00029  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
00030  * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00031  * SUCH DAMAGE.
00032  *
00033  * For additional information see http://www.ethernut.de/
00034  *
00035  * -
00036  * Portions Copyright (C) 2000 David J. Hudson <dave@humbug.demon.co.uk>
00037  *
00038  * This file is distributed in the hope that it will be useful, but WITHOUT
00039  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00040  * FITNESS FOR A PARTICULAR PURPOSE.
00041  *
00042  * You can redistribute this file and/or modify it under the terms of the GNU
00043  * General Public License (GPL) as published by the Free Software Foundation;
00044  * either version 2 of the License, or (at your discretion) any later version.
00045  * See the accompanying file "copying-gpl.txt" for more details.
00046  *
00047  * As a special exception to the GPL, permission is granted for additional
00048  * uses of the text contained in this file.  See the accompanying file
00049  * "copying-liquorice.txt" for details.
00050  */
00051 
00052 /*
00053  * $Log: heap.h,v $
00054  * Revision 1.9  2008/06/25 08:50:33  freckle
00055  * added new function NutHeapRealloc
00056  *
00057  * Revision 1.8  2008/06/15 17:15:49  haraldkipp
00058  * Rolled back to version 1.4.
00059  *
00060  * Revision 1.4  2006/10/06 23:19:08  hwmaier
00061  * Added include statement for cfg/memory.h so the macro NUTMEM_STACKHEAP is found when compiling for the AT90CAN128.
00062  *
00063  * Revision 1.3  2006/09/29 12:26:14  haraldkipp
00064  * All code should use dedicated stack allocation routines. For targets
00065  * allocating stack from the normal heap the API calls are remapped by
00066  * preprocessor macros.
00067  * Stack allocation code moved from thread module to heap module.
00068  * Adding static attribute to variable 'available' will avoid interference
00069  * with application code. The ugly format macros had been replaced by
00070  * converting all platform specific sizes to unsigned integers.
00071  *
00072  * Revision 1.2  2004/03/16 16:48:44  haraldkipp
00073  * Added Jan Dubiec's H8/300 port.
00074  *
00075  * Revision 1.1.1.1  2003/05/09 14:41:20  haraldkipp
00076  * Initial using 3.2.1
00077  *
00078  * Revision 1.7  2003/02/04 18:00:52  harald
00079  * Version 3 released
00080  *
00081  * Revision 1.6  2002/06/26 17:29:28  harald
00082  * First pre-release with 2.4 stack
00083  *
00084  */
00085 
00086 #include <cfg/memory.h>
00087 #include <sys/types.h>
00088 
00094 #ifdef __cplusplus
00095 extern "C" {
00096 #endif
00097 
00106 typedef struct _HEAPNODE {
00107     size_t hn_size;             
00108     struct _HEAPNODE *hn_next;  
00109 } HEAPNODE;
00110 
00111 extern HEAPNODE* volatile heapFreeList;
00112 
00119 #define ALLOC_THRESHOLD 6
00120 #define REALLOC_THRESHOLD ALLOC_THRESHOLD 
00121 
00122 extern void *NutHeapAlloc(size_t size);
00123 extern void *NutHeapAllocClear(size_t size);
00124 extern int NutHeapFree(void *block);
00125 extern void * NutHeapRealloc( void * block, u_short size);
00126 extern void NutHeapAdd(void *addr, size_t size);
00127 extern size_t NutHeapAvailable(void);
00128 
00129 #if defined (NUTMEM_STACKHEAP)
00130 
00131 /* Dedicated stack memory. */
00132 extern void *NutStackAlloc(size_t size);
00133 extern int NutStackFree(void *block);
00134 extern void NutStackAdd(void *addr, size_t size);
00135 
00136 #else /* !NUTMEM_STACKHEAP */
00137 
00138 /* Thread stacks resides in normal heap. */
00139 #define NutStackAlloc(size)     NutHeapAlloc(size)
00140 #define NutStackFree(block)     NutHeapFree(block)
00141 
00142 #endif /* !NUTMEM_STACKHEAP */
00143 
00144 #ifdef __cplusplus
00145 }
00146 #endif
00147 
00148 #endif

© 2000-2007 by egnite Software GmbH - visit http://www.ethernut.de/