]> git.sur5r.net Git - freertos/blob - Source/portable/MemMang/heap_1.c
Add xPortGetFreeHeapSize() function.
[freertos] / Source / portable / MemMang / heap_1.c
1 /*\r
2     FreeRTOS V6.0.0 - Copyright (C) 2009 Real Time Engineers Ltd.\r
3 \r
4     This file is part of the FreeRTOS distribution.\r
5 \r
6     FreeRTOS is free software; you can redistribute it and/or modify it    under\r
7     the terms of the GNU General Public License (version 2) as published by the\r
8     Free Software Foundation and modified by the FreeRTOS exception.\r
9     **NOTE** The exception to the GPL is included to allow you to distribute a\r
10     combined work that includes FreeRTOS without being obliged to provide the\r
11     source code for proprietary components outside of the FreeRTOS kernel.\r
12     Alternative commercial license and support terms are also available upon\r
13     request.  See the licensing section of http://www.FreeRTOS.org for full\r
14     license details.\r
15 \r
16     FreeRTOS is distributed in the hope that it will be useful,    but WITHOUT\r
17     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\r
18     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for\r
19     more details.\r
20 \r
21     You should have received a copy of the GNU General Public License along\r
22     with FreeRTOS; if not, write to the Free Software Foundation, Inc., 59\r
23     Temple Place, Suite 330, Boston, MA  02111-1307  USA.\r
24 \r
25 \r
26     ***************************************************************************\r
27     *                                                                         *\r
28     * The FreeRTOS eBook and reference manual are available to purchase for a *\r
29     * small fee. Help yourself get started quickly while also helping the     *\r
30     * FreeRTOS project! See http://www.FreeRTOS.org/Documentation for details *\r
31     *                                                                         *\r
32     ***************************************************************************\r
33 \r
34     1 tab == 4 spaces!\r
35 \r
36     Please ensure to read the configuration and relevant port sections of the\r
37     online documentation.\r
38 \r
39     http://www.FreeRTOS.org - Documentation, latest information, license and\r
40     contact details.\r
41 \r
42     http://www.SafeRTOS.com - A version that is certified for use in safety\r
43     critical systems.\r
44 \r
45     http://www.OpenRTOS.com - Commercial support, development, porting,\r
46     licensing and training services.\r
47 */\r
48 \r
49 \r
50 /*\r
51  * The simplest possible implementation of pvPortMalloc().  Note that this\r
52  * implementation does NOT allow allocated memory to be freed again.\r
53  *\r
54  * See heap_2.c and heap_3.c for alternative implementations, and the memory\r
55  * management pages of http://www.FreeRTOS.org for more information.\r
56  */\r
57 #include <stdlib.h>\r
58 \r
59 /* Defining MPU_WRAPPERS_INCLUDED_FROM_API_FILE prevents task.h from redefining\r
60 all the API functions to use the MPU wrappers.  That should only be done when\r
61 task.h is included from an application file. */\r
62 #define MPU_WRAPPERS_INCLUDED_FROM_API_FILE\r
63 \r
64 #include "FreeRTOS.h"\r
65 #include "task.h"\r
66 \r
67 #undef MPU_WRAPPERS_INCLUDED_FROM_API_FILE\r
68 \r
69 /* Allocate the memory for the heap.  The struct is used to force byte\r
70 alignment without using any non-portable code. */\r
71 static union xRTOS_HEAP\r
72 {\r
73         #if portBYTE_ALIGNMENT == 8\r
74                 volatile portDOUBLE dDummy;\r
75         #else\r
76                 volatile unsigned long ulDummy;\r
77         #endif  \r
78         unsigned char ucHeap[ configTOTAL_HEAP_SIZE ];\r
79 } xHeap;\r
80 \r
81 static size_t xNextFreeByte = ( size_t ) 0;\r
82 /*-----------------------------------------------------------*/\r
83 \r
84 void *pvPortMalloc( size_t xWantedSize )\r
85 {\r
86 void *pvReturn = NULL; \r
87 \r
88         /* Ensure that blocks are always aligned to the required number of bytes. */\r
89         #if portBYTE_ALIGNMENT != 1\r
90                 if( xWantedSize & portBYTE_ALIGNMENT_MASK )\r
91                 {\r
92                         /* Byte alignment required. */\r
93                         xWantedSize += ( portBYTE_ALIGNMENT - ( xWantedSize & portBYTE_ALIGNMENT_MASK ) );\r
94                 }\r
95         #endif\r
96 \r
97         vTaskSuspendAll();\r
98         {\r
99                 /* Check there is enough room left for the allocation. */\r
100                 if( ( ( xNextFreeByte + xWantedSize ) < configTOTAL_HEAP_SIZE ) &&\r
101                         ( ( xNextFreeByte + xWantedSize ) > xNextFreeByte )     )/* Check for overflow. */\r
102                 {\r
103                         /* Return the next free byte then increment the index past this\r
104                         block. */\r
105                         pvReturn = &( xHeap.ucHeap[ xNextFreeByte ] );\r
106                         xNextFreeByte += xWantedSize;                   \r
107                 }       \r
108         }\r
109         xTaskResumeAll();\r
110         \r
111         #if( configUSE_MALLOC_FAILED_HOOK == 1 )\r
112         {\r
113                 if( pvReturn == NULL )\r
114                 {\r
115                         extern void vApplicationMallocFailedHook( void );\r
116                         vApplicationMallocFailedHook();\r
117                 }\r
118         }\r
119         #endif  \r
120 \r
121         return pvReturn;\r
122 }\r
123 /*-----------------------------------------------------------*/\r
124 \r
125 void vPortFree( void *pv )\r
126 {\r
127         /* Memory cannot be freed using this scheme.  See heap_2.c and heap_3.c \r
128         for alternative implementations, and the memory management pages of \r
129         http://www.FreeRTOS.org for more information. */\r
130         ( void ) pv;\r
131 }\r
132 /*-----------------------------------------------------------*/\r
133 \r
134 void vPortInitialiseBlocks( void )\r
135 {\r
136         /* Only required when static memory is not cleared. */\r
137         xNextFreeByte = ( size_t ) 0;\r
138 }\r
139 /*-----------------------------------------------------------*/\r
140 \r
141 size_t xPortGetFreeHeapSize( void )\r
142 {\r
143         return ( configTOTAL_HEAP_SIZE - xNextFreeByte );\r
144 }\r
145 \r
146 \r
147 \r