git.sur5r.net Git - freertos/blob - FreeRTOS/Source/portable/MemMang/heap_4.c

   1 /*\r
   2     FreeRTOS V7.4.2 - Copyright (C) 2013 Real Time Engineers Ltd.\r
   3 \r
   4     FEATURES AND PORTS ARE ADDED TO FREERTOS ALL THE TIME.  PLEASE VISIT\r
   5     http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
   6 \r
   7     ***************************************************************************\r
   8      *                                                                       *\r
   9      *    FreeRTOS tutorial books are available in pdf and paperback.        *\r
  10      *    Complete, revised, and edited pdf reference manuals are also       *\r
  11      *    available.                                                         *\r
  12      *                                                                       *\r
  13      *    Purchasing FreeRTOS documentation will not only help you, by       *\r
  14      *    ensuring you get running as quickly as possible and with an        *\r
  15      *    in-depth knowledge of how to use FreeRTOS, it will also help       *\r
  16      *    the FreeRTOS project to continue with its mission of providing     *\r
  17      *    professional grade, cross platform, de facto standard solutions    *\r
  18      *    for microcontrollers - completely free of charge!                  *\r
  19      *                                                                       *\r
  20      *    >>> See http://www.FreeRTOS.org/Documentation for details. <<<     *\r
  21      *                                                                       *\r
  22      *    Thank you for using FreeRTOS, and thank you for your support!      *\r
  23      *                                                                       *\r
  24     ***************************************************************************\r
  25 \r
  26 \r
  27     This file is part of the FreeRTOS distribution.\r
  28 \r
  29     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  30     the terms of the GNU General Public License (version 2) as published by the\r
  31     Free Software Foundation AND MODIFIED BY the FreeRTOS exception.\r
  32 \r
  33     >>>>>>NOTE<<<<<< The modification to the GPL is included to allow you to\r
  34     distribute a combined work that includes FreeRTOS without being obliged to\r
  35     provide the source code for proprietary components outside of the FreeRTOS\r
  36     kernel.\r
  37 \r
  38     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
  39     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
  40     FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more\r
  41     details. You should have received a copy of the GNU General Public License\r
  42     and the FreeRTOS license exception along with FreeRTOS; if not it can be\r
  43     viewed here: http://www.freertos.org/a00114.html and also obtained by\r
  44     writing to Real Time Engineers Ltd., contact details for whom are available\r
  45     on the FreeRTOS WEB site.\r
  46 \r
  47     1 tab == 4 spaces!\r
  48 \r
  49     ***************************************************************************\r
  50      *                                                                       *\r
  51      *    Having a problem?  Start by reading the FAQ "My application does   *\r
  52      *    not run, what could be wrong?"                                     *\r
  53      *                                                                       *\r
  54      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
  55      *                                                                       *\r
  56     ***************************************************************************\r
  57 \r
  58 \r
  59     http://www.FreeRTOS.org - Documentation, books, training, latest versions, \r
  60     license and Real Time Engineers Ltd. contact details.\r
  61 \r
  62     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  63     including FreeRTOS+Trace - an indispensable productivity tool, and our new\r
  64     fully thread aware and reentrant UDP/IP stack.\r
  65 \r
  66     http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High \r
  67     Integrity Systems, who sell the code with commercial support, \r
  68     indemnification and middleware, under the OpenRTOS brand.\r
  69     \r
  70     http://www.SafeRTOS.com - High Integrity Systems also provide a safety \r
  71     engineered and independently SIL3 certified version for use in safety and \r
  72     mission critical applications that require provable dependability.\r
  73 */\r
  74 \r
  75 /*\r
  76  * A sample implementation of pvPortMalloc() and vPortFree() that combines \r
  77  * (coalescences) adjacent memory blocks as they are freed, and in so doing \r
  78  * limits memory fragmentation.\r
  79  *\r
  80  * See heap_1.c, heap_2.c and heap_3.c for alternative implementations, and the \r
  81  * memory management pages of http://www.FreeRTOS.org for more information.\r
  82  */\r
  83 #include <stdlib.h>\r
  84 \r
  85 /* Defining MPU_WRAPPERS_INCLUDED_FROM_API_FILE prevents task.h from redefining\r
  86 all the API functions to use the MPU wrappers.  That should only be done when\r
  87 task.h is included from an application file. */\r
  88 #define MPU_WRAPPERS_INCLUDED_FROM_API_FILE\r
  89 \r
  90 #include "FreeRTOS.h"\r
  91 #include "task.h"\r
  92 \r
  93 #undef MPU_WRAPPERS_INCLUDED_FROM_API_FILE\r
  94 \r
  95 /* Block sizes must not get too small. */\r
  96 #define heapMINIMUM_BLOCK_SIZE  ( ( size_t ) ( heapSTRUCT_SIZE * 2 ) )\r
  97 \r
  98 /* A few bytes might be lost to byte aligning the heap start address. */\r
  99 #define configADJUSTED_HEAP_SIZE        ( configTOTAL_HEAP_SIZE - portBYTE_ALIGNMENT )\r
 100 \r
 101 /* Allocate the memory for the heap. */\r
 102 static unsigned char ucHeap[ configTOTAL_HEAP_SIZE ];\r
 103 \r
 104 /* Define the linked list structure.  This is used to link free blocks in order\r
 105 of their memory address. */\r
 106 typedef struct A_BLOCK_LINK\r
 107 {\r
 108         struct A_BLOCK_LINK *pxNextFreeBlock;   /*<< The next free block in the list. */\r
 109         size_t xBlockSize;                                              /*<< The size of the free block. */\r
 110 } xBlockLink;\r
 111 \r
 112 /*-----------------------------------------------------------*/\r
 113 \r
 114 /*\r
 115  * Inserts a block of memory that is being freed into the correct position in \r
 116  * the list of free memory blocks.  The block being freed will be merged with\r
 117  * the block in front it and/or the block behind it if the memory blocks are\r
 118  * adjacent to each other.\r
 119  */\r
 120 static void prvInsertBlockIntoFreeList( xBlockLink *pxBlockToInsert );\r
 121 \r
 122 /*\r
 123  * Called automatically to setup the required heap structures the first time\r
 124  * pvPortMalloc() is called.\r
 125  */\r
 126 static void prvHeapInit( void );\r
 127 \r
 128 /*-----------------------------------------------------------*/\r
 129 \r
 130 /* The size of the structure placed at the beginning of each allocated memory\r
 131 block must by correctly byte aligned. */\r
 132 static const unsigned short heapSTRUCT_SIZE     = ( sizeof( xBlockLink ) + portBYTE_ALIGNMENT - ( sizeof( xBlockLink ) % portBYTE_ALIGNMENT ) );\r
 133 \r
 134 /* Ensure the pxEnd pointer will end up on the correct byte alignment. */\r
 135 static const size_t xTotalHeapSize = ( ( size_t ) configADJUSTED_HEAP_SIZE ) & ( ( size_t ) ~portBYTE_ALIGNMENT_MASK );\r
 136 \r
 137 /* Create a couple of list links to mark the start and end of the list. */\r
 138 static xBlockLink xStart, *pxEnd = NULL;\r
 139 \r
 140 /* Keeps track of the number of free bytes remaining, but says nothing about\r
 141 fragmentation. */\r
 142 static size_t xFreeBytesRemaining = ( ( size_t ) configADJUSTED_HEAP_SIZE ) & ( ( size_t ) ~portBYTE_ALIGNMENT_MASK );\r
 143 \r
 144 /* STATIC FUNCTIONS ARE DEFINED AS MACROS TO MINIMIZE THE FUNCTION CALL DEPTH. */\r
 145 \r
 146 /*-----------------------------------------------------------*/\r
 147 \r
 148 void *pvPortMalloc( size_t xWantedSize )\r
 149 {\r
 150 xBlockLink *pxBlock, *pxPreviousBlock, *pxNewBlockLink;\r
 151 void *pvReturn = NULL;\r
 152 \r
 153         vTaskSuspendAll();\r
 154         {\r
 155                 /* If this is the first call to malloc then the heap will require\r
 156                 initialisation to setup the list of free blocks. */\r
 157                 if( pxEnd == NULL )\r
 158                 {\r
 159                         prvHeapInit();\r
 160                 }\r
 161 \r
 162                 /* The wanted size is increased so it can contain a xBlockLink\r
 163                 structure in addition to the requested amount of bytes. */\r
 164                 if( xWantedSize > 0 )\r
 165                 {\r
 166                         xWantedSize += heapSTRUCT_SIZE;\r
 167 \r
 168                         /* Ensure that blocks are always aligned to the required number of \r
 169                         bytes. */\r
 170                         if( xWantedSize & portBYTE_ALIGNMENT_MASK )\r
 171                         {\r
 172                                 /* Byte alignment required. */\r
 173                                 xWantedSize += ( portBYTE_ALIGNMENT - ( xWantedSize & portBYTE_ALIGNMENT_MASK ) );\r
 174                         }\r
 175                 }\r
 176 \r
 177                 if( ( xWantedSize > 0 ) && ( xWantedSize < xTotalHeapSize ) )\r
 178                 {\r
 179                         /* Traverse the list from the start     (lowest address) block until one\r
 180                         of adequate size is found. */\r
 181                         pxPreviousBlock = &xStart;\r
 182                         pxBlock = xStart.pxNextFreeBlock;\r
 183                         while( ( pxBlock->xBlockSize < xWantedSize ) && ( pxBlock->pxNextFreeBlock != NULL ) )\r
 184                         {\r
 185                                 pxPreviousBlock = pxBlock;\r
 186                                 pxBlock = pxBlock->pxNextFreeBlock;\r
 187                         }\r
 188 \r
 189                         /* If the end marker was reached then a block of adequate size was\r
 190                         not found. */\r
 191                         if( pxBlock != pxEnd )\r
 192                         {\r
 193                                 /* Return the memory space - jumping over the xBlockLink structure\r
 194                                 at its start. */\r
 195                                 pvReturn = ( void * ) ( ( ( unsigned char * ) pxPreviousBlock->pxNextFreeBlock ) + heapSTRUCT_SIZE );\r
 196 \r
 197                                 /* This block is being returned for use so must be taken out of\r
 198                                 the     list of free blocks. */\r
 199                                 pxPreviousBlock->pxNextFreeBlock = pxBlock->pxNextFreeBlock;\r
 200 \r
 201                                 /* If the block is larger than required it can be split into two. */\r
 202                                 if( ( pxBlock->xBlockSize - xWantedSize ) > heapMINIMUM_BLOCK_SIZE )\r
 203                                 {\r
 204                                         /* This block is to be split into two.  Create a new block\r
 205                                         following the number of bytes requested. The void cast is\r
 206                                         used to prevent byte alignment warnings from the compiler. */\r
 207                                         pxNewBlockLink = ( void * ) ( ( ( unsigned char * ) pxBlock ) + xWantedSize );\r
 208 \r
 209                                         /* Calculate the sizes of two blocks split from the single\r
 210                                         block. */\r
 211                                         pxNewBlockLink->xBlockSize = pxBlock->xBlockSize - xWantedSize;\r
 212                                         pxBlock->xBlockSize = xWantedSize;\r
 213 \r
 214                                         /* Insert the new block into the list of free blocks. */\r
 215                                         prvInsertBlockIntoFreeList( ( pxNewBlockLink ) );\r
 216                                 }\r
 217 \r
 218                                 xFreeBytesRemaining -= pxBlock->xBlockSize;\r
 219                         }\r
 220                 }\r
 221         }\r
 222         xTaskResumeAll();\r
 223 \r
 224         #if( configUSE_MALLOC_FAILED_HOOK == 1 )\r
 225         {\r
 226                 if( pvReturn == NULL )\r
 227                 {\r
 228                         extern void vApplicationMallocFailedHook( void );\r
 229                         vApplicationMallocFailedHook();\r
 230                 }\r
 231         }\r
 232         #endif\r
 233 \r
 234         return pvReturn;\r
 235 }\r
 236 /*-----------------------------------------------------------*/\r
 237 \r
 238 void vPortFree( void *pv )\r
 239 {\r
 240 unsigned char *puc = ( unsigned char * ) pv;\r
 241 xBlockLink *pxLink;\r
 242 \r
 243         if( pv != NULL )\r
 244         {\r
 245                 /* The memory being freed will have an xBlockLink structure immediately\r
 246                 before it. */\r
 247                 puc -= heapSTRUCT_SIZE;\r
 248 \r
 249                 /* This casting is to keep the compiler from issuing warnings. */\r
 250                 pxLink = ( void * ) puc;\r
 251 \r
 252                 vTaskSuspendAll();\r
 253                 {\r
 254                         /* Add this block to the list of free blocks. */\r
 255                         xFreeBytesRemaining += pxLink->xBlockSize;\r
 256                         prvInsertBlockIntoFreeList( ( ( xBlockLink * ) pxLink ) );                      \r
 257                 }\r
 258                 xTaskResumeAll();\r
 259         }\r
 260 }\r
 261 /*-----------------------------------------------------------*/\r
 262 \r
 263 size_t xPortGetFreeHeapSize( void )\r
 264 {\r
 265         return xFreeBytesRemaining;\r
 266 }\r
 267 /*-----------------------------------------------------------*/\r
 268 \r
 269 void vPortInitialiseBlocks( void )\r
 270 {\r
 271         /* This just exists to keep the linker quiet. */\r
 272 }\r
 273 /*-----------------------------------------------------------*/\r
 274 \r
 275 static void prvHeapInit( void )\r
 276 {\r
 277 xBlockLink *pxFirstFreeBlock;\r
 278 unsigned char *pucHeapEnd, *pucAlignedHeap;\r
 279 \r
 280         /* Ensure the heap starts on a correctly aligned boundary. */\r
 281         pucAlignedHeap = ( unsigned char * ) ( ( ( portPOINTER_SIZE_TYPE ) &ucHeap[ portBYTE_ALIGNMENT ] ) & ( ( portPOINTER_SIZE_TYPE ) ~portBYTE_ALIGNMENT_MASK ) );\r
 282 \r
 283         /* xStart is used to hold a pointer to the first item in the list of free\r
 284         blocks.  The void cast is used to prevent compiler warnings. */\r
 285         xStart.pxNextFreeBlock = ( void * ) pucAlignedHeap;\r
 286         xStart.xBlockSize = ( size_t ) 0;\r
 287 \r
 288         /* pxEnd is used to mark the end of the list of free blocks and is inserted\r
 289         at the end of the heap space. */\r
 290         pucHeapEnd = pucAlignedHeap + xTotalHeapSize;\r
 291         pucHeapEnd -= heapSTRUCT_SIZE;\r
 292         pxEnd = ( void * ) pucHeapEnd;\r
 293         configASSERT( ( ( ( unsigned long ) pxEnd ) & ( ( unsigned long ) portBYTE_ALIGNMENT_MASK ) ) == 0UL );\r
 294         pxEnd->xBlockSize = 0;\r
 295         pxEnd->pxNextFreeBlock = NULL;\r
 296 \r
 297         /* To start with there is a single free block that is sized to take up the\r
 298         entire heap space, minus the space taken by pxEnd. */\r
 299         pxFirstFreeBlock = ( void * ) pucAlignedHeap;\r
 300         pxFirstFreeBlock->xBlockSize = xTotalHeapSize - heapSTRUCT_SIZE;\r
 301         pxFirstFreeBlock->pxNextFreeBlock = pxEnd;\r
 302 \r
 303         /* The heap now contains pxEnd. */\r
 304         xFreeBytesRemaining -= heapSTRUCT_SIZE;\r
 305 }\r
 306 /*-----------------------------------------------------------*/\r
 307 \r
 308 static void prvInsertBlockIntoFreeList( xBlockLink *pxBlockToInsert )\r
 309 {\r
 310 xBlockLink *pxIterator;\r
 311 unsigned char *puc;\r
 312 \r
 313         /* Iterate through the list until a block is found that has a higher address\r
 314         than the block being inserted. */\r
 315         for( pxIterator = &xStart; pxIterator->pxNextFreeBlock < pxBlockToInsert; pxIterator = pxIterator->pxNextFreeBlock )\r
 316         {\r
 317                 /* Nothing to do here, just iterate to the right position. */\r
 318         }\r
 319 \r
 320         /* Do the block being inserted, and the block it is being inserted after\r
 321         make a contiguous block of memory? */   \r
 322         puc = ( unsigned char * ) pxIterator;\r
 323         if( ( puc + pxIterator->xBlockSize ) == ( unsigned char * ) pxBlockToInsert )\r
 324         {\r
 325                 pxIterator->xBlockSize += pxBlockToInsert->xBlockSize;\r
 326                 pxBlockToInsert = pxIterator;\r
 327         }\r
 328 \r
 329         /* Do the block being inserted, and the block it is being inserted before\r
 330         make a contiguous block of memory? */\r
 331         puc = ( unsigned char * ) pxBlockToInsert;\r
 332         if( ( puc + pxBlockToInsert->xBlockSize ) == ( unsigned char * ) pxIterator->pxNextFreeBlock )\r
 333         {\r
 334                 if( pxIterator->pxNextFreeBlock != pxEnd )\r
 335                 {\r
 336                         /* Form one big block from the two blocks. */\r
 337                         pxBlockToInsert->xBlockSize += pxIterator->pxNextFreeBlock->xBlockSize;\r
 338                         pxBlockToInsert->pxNextFreeBlock = pxIterator->pxNextFreeBlock->pxNextFreeBlock;\r
 339                 }\r
 340                 else\r
 341                 {\r
 342                         pxBlockToInsert->pxNextFreeBlock = pxEnd;\r
 343                 }\r
 344         }\r
 345         else\r
 346         {\r
 347                 pxBlockToInsert->pxNextFreeBlock = pxIterator->pxNextFreeBlock;         \r
 348         }\r
 349 \r
 350         /* If the block being inserted plugged a gab, so was merged with the block\r
 351         before and the block after, then it's pxNextFreeBlock pointer will have\r
 352         already been set, and should not be set here as that would make it point\r
 353         to itself. */\r
 354         if( pxIterator != pxBlockToInsert )\r
 355         {\r
 356                 pxIterator->pxNextFreeBlock = pxBlockToInsert;\r
 357         }\r
 358 }\r
 359 \r