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

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