]> git.sur5r.net Git - freertos/blobdiff - FreeRTOS/Source/portable/MemMang/heap_2.c
Cast away a few unused return types to ensure lint/compilers don't generate warnings...
[freertos] / FreeRTOS / Source / portable / MemMang / heap_2.c
index bd827a94127427bf95e2f82b3afb1d69bd694ade..0ed9648f5b17f3dce355a746f38ea5e1c4c9d26d 100644 (file)
@@ -1,48 +1,41 @@
 /*\r
-    FreeRTOS V7.3.0 - Copyright (C) 2012 Real Time Engineers Ltd.\r
+    FreeRTOS V8.0.0 - Copyright (C) 2014 Real Time Engineers Ltd.\r
+    All rights reserved\r
 \r
-    FEATURES AND PORTS ARE ADDED TO FREERTOS ALL THE TIME.  PLEASE VISIT \r
-    http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
+    VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
 \r
     ***************************************************************************\r
      *                                                                       *\r
-     *    FreeRTOS tutorial books are available in pdf and paperback.        *\r
-     *    Complete, revised, and edited pdf reference manuals are also       *\r
-     *    available.                                                         *\r
+     *    FreeRTOS provides completely free yet professionally developed,    *\r
+     *    robust, strictly quality controlled, supported, and cross          *\r
+     *    platform software that has become a de facto standard.             *\r
      *                                                                       *\r
-     *    Purchasing FreeRTOS documentation will not only help you, by       *\r
-     *    ensuring you get running as quickly as possible and with an        *\r
-     *    in-depth knowledge of how to use FreeRTOS, it will also help       *\r
-     *    the FreeRTOS project to continue with its mission of providing     *\r
-     *    professional grade, cross platform, de facto standard solutions    *\r
-     *    for microcontrollers - completely free of charge!                  *\r
+     *    Help yourself get started quickly and support the FreeRTOS         *\r
+     *    project by purchasing a FreeRTOS tutorial book, reference          *\r
+     *    manual, or both from: http://www.FreeRTOS.org/Documentation        *\r
      *                                                                       *\r
-     *    >>> See http://www.FreeRTOS.org/Documentation for details. <<<     *\r
-     *                                                                       *\r
-     *    Thank you for using FreeRTOS, and thank you for your support!      *\r
+     *    Thank you!                                                         *\r
      *                                                                       *\r
     ***************************************************************************\r
 \r
-\r
     This file is part of the FreeRTOS distribution.\r
 \r
     FreeRTOS is free software; you can redistribute it and/or modify it under\r
     the terms of the GNU General Public License (version 2) as published by the\r
-    Free Software Foundation AND MODIFIED BY the FreeRTOS exception.\r
-    >>>NOTE<<< The modification to the GPL is included to allow you to\r
-    distribute a combined work that includes FreeRTOS without being obliged to\r
-    provide the source code for proprietary components outside of the FreeRTOS\r
-    kernel.  FreeRTOS is distributed in the hope that it will be useful, but\r
-    WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY\r
-    or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for\r
-    more details. You should have received a copy of the GNU General Public\r
-    License and the FreeRTOS license exception along with FreeRTOS; if not it\r
-    can be viewed here: http://www.freertos.org/a00114.html and also obtained\r
-    by writing to Richard Barry, contact details for whom are available on the\r
-    FreeRTOS WEB site.\r
+    Free Software Foundation >>!AND MODIFIED BY!<< the FreeRTOS exception.\r
+\r
+    >>! NOTE: The modification to the GPL is included to allow you to distribute\r
+    >>! a combined work that includes FreeRTOS without being obliged to provide\r
+    >>! the source code for proprietary components outside of the FreeRTOS\r
+    >>! kernel.\r
+\r
+    FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
+    WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
+    FOR A PARTICULAR PURPOSE.  Full license text is available from the following\r
+    link: http://www.freertos.org/a00114.html\r
 \r
     1 tab == 4 spaces!\r
-    \r
+\r
     ***************************************************************************\r
      *                                                                       *\r
      *    Having a problem?  Start by reading the FAQ "My application does   *\r
      *                                                                       *\r
     ***************************************************************************\r
 \r
-    \r
-    http://www.FreeRTOS.org - Documentation, training, latest versions, license \r
-    and contact details.  \r
-    \r
+    http://www.FreeRTOS.org - Documentation, books, training, latest versions,\r
+    license and Real Time Engineers Ltd. contact details.\r
+\r
     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
-    including FreeRTOS+Trace - an indispensable productivity tool.\r
+    including FreeRTOS+Trace - an indispensable productivity tool, a DOS\r
+    compatible FAT file system, and our tiny thread aware UDP/IP stack.\r
+\r
+    http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High\r
+    Integrity Systems to sell under the OpenRTOS brand.  Low cost OpenRTOS\r
+    licenses offer ticketed support, indemnification and middleware.\r
+\r
+    http://www.SafeRTOS.com - High Integrity Systems also provide a safety\r
+    engineered and independently SIL3 certified version for use in safety and\r
+    mission critical applications that require provable dependability.\r
 \r
-    Real Time Engineers ltd license FreeRTOS to High Integrity Systems, who sell \r
-    the code with commercial support, indemnification, and middleware, under \r
-    the OpenRTOS brand: http://www.OpenRTOS.com.  High Integrity Systems also\r
-    provide a safety engineered and independently SIL3 certified version under \r
-    the SafeRTOS brand: http://www.SafeRTOS.com.\r
+    1 tab == 4 spaces!\r
 */\r
 \r
 /*\r
  * A sample implementation of pvPortMalloc() and vPortFree() that permits\r
  * allocated blocks to be freed, but does not combine adjacent free blocks\r
- * into a single larger block (and so will fragment memory).  See heap_4.c for \r
- * an aquivalent that does combine adjacent blocks into single larger blocks.\r
+ * into a single larger block (and so will fragment memory).  See heap_4.c for\r
+ * an equivalent that does combine adjacent blocks into single larger blocks.\r
  *\r
- * See heap_1.c, heap_3.c and heap_4.c for alternative implementations, and the \r
+ * See heap_1.c, heap_3.c and heap_4.c for alternative implementations, and the\r
  * memory management pages of http://www.FreeRTOS.org for more information.\r
  */\r
 #include <stdlib.h>\r
@@ -87,17 +84,16 @@ task.h is included from an application file. */
 \r
 #undef MPU_WRAPPERS_INCLUDED_FROM_API_FILE\r
 \r
-/* Allocate the memory for the heap.  The struct is used to force byte\r
-alignment without using any non-portable code. */\r
-static union xRTOS_HEAP\r
-{\r
-       #if portBYTE_ALIGNMENT == 8\r
-               volatile portDOUBLE dDummy;\r
-       #else\r
-               volatile unsigned long ulDummy;\r
-       #endif\r
-       unsigned char ucHeap[ configTOTAL_HEAP_SIZE ];\r
-} xHeap;\r
+/* A few bytes might be lost to byte aligning the heap start address. */\r
+#define configADJUSTED_HEAP_SIZE       ( configTOTAL_HEAP_SIZE - portBYTE_ALIGNMENT )\r
+\r
+/*\r
+ * Initialises the heap structures before their first use.\r
+ */\r
+static void prvHeapInit( void );\r
+\r
+/* Allocate the memory for the heap. */\r
+static uint8_t ucHeap[ configTOTAL_HEAP_SIZE ];\r
 \r
 /* Define the linked list structure.  This is used to link free blocks in order\r
 of their size. */\r
@@ -105,18 +101,18 @@ typedef struct A_BLOCK_LINK
 {\r
        struct A_BLOCK_LINK *pxNextFreeBlock;   /*<< The next free block in the list. */\r
        size_t xBlockSize;                                              /*<< The size of the free block. */\r
-} xBlockLink;\r
+} BlockLink_t;\r
 \r
 \r
-static const unsigned short  heapSTRUCT_SIZE   = ( sizeof( xBlockLink ) + portBYTE_ALIGNMENT - ( sizeof( xBlockLink ) % portBYTE_ALIGNMENT ) );\r
+static const uint16_t heapSTRUCT_SIZE  = ( ( sizeof ( BlockLink_t ) + ( portBYTE_ALIGNMENT - 1 ) ) & ~portBYTE_ALIGNMENT_MASK );\r
 #define heapMINIMUM_BLOCK_SIZE ( ( size_t ) ( heapSTRUCT_SIZE * 2 ) )\r
 \r
 /* Create a couple of list links to mark the start and end of the list. */\r
-static xBlockLink xStart, xEnd;\r
+static BlockLink_t xStart, xEnd;\r
 \r
 /* Keeps track of the number of free bytes remaining, but says nothing about\r
 fragmentation. */\r
-static size_t xFreeBytesRemaining = configTOTAL_HEAP_SIZE;\r
+static size_t xFreeBytesRemaining = configADJUSTED_HEAP_SIZE;\r
 \r
 /* STATIC FUNCTIONS ARE DEFINED AS MACROS TO MINIMIZE THE FUNCTION CALL DEPTH. */\r
 \r
@@ -127,7 +123,7 @@ static size_t xFreeBytesRemaining = configTOTAL_HEAP_SIZE;
  */\r
 #define prvInsertBlockIntoFreeList( pxBlockToInsert )                                                          \\r
 {                                                                                                                                                                      \\r
-xBlockLink *pxIterator;                                                                                                                                \\r
+BlockLink_t *pxIterator;                                                                                                                               \\r
 size_t xBlockSize;                                                                                                                                     \\r
                                                                                                                                                                        \\r
        xBlockSize = pxBlockToInsert->xBlockSize;                                                                               \\r
@@ -146,31 +142,10 @@ size_t xBlockSize;                                                                                                                                        \
 }\r
 /*-----------------------------------------------------------*/\r
 \r
-#define prvHeapInit()                                                                                                                          \\r
-{                                                                                                                                                                      \\r
-xBlockLink *pxFirstFreeBlock;                                                                                                          \\r
-                                                                                                                                                                       \\r
-       /* xStart is used to hold a pointer to the first item in the list of free */    \\r
-       /* blocks.  The void cast is used to prevent compiler warnings. */                              \\r
-       xStart.pxNextFreeBlock = ( void * ) xHeap.ucHeap;                                                               \\r
-       xStart.xBlockSize = ( size_t ) 0;                                                                                               \\r
-                                                                                                                                                                       \\r
-       /* xEnd is used to mark the end of the list of free blocks. */                                  \\r
-       xEnd.xBlockSize = configTOTAL_HEAP_SIZE;                                                                                \\r
-       xEnd.pxNextFreeBlock = NULL;                                                                                                    \\r
-                                                                                                                                                                       \\r
-       /* To start with there is a single free block that is sized to take up the              \\r
-       entire heap space. */                                                                                                                   \\r
-       pxFirstFreeBlock = ( void * ) xHeap.ucHeap;                                                                             \\r
-       pxFirstFreeBlock->xBlockSize = configTOTAL_HEAP_SIZE;                                                   \\r
-       pxFirstFreeBlock->pxNextFreeBlock = &xEnd;                                                                              \\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
 void *pvPortMalloc( size_t xWantedSize )\r
 {\r
-xBlockLink *pxBlock, *pxPreviousBlock, *pxNewBlockLink;\r
-static portBASE_TYPE xHeapHasBeenInitialised = pdFALSE;\r
+BlockLink_t *pxBlock, *pxPreviousBlock, *pxNewBlockLink;\r
+static BaseType_t xHeapHasBeenInitialised = pdFALSE;\r
 void *pvReturn = NULL;\r
 \r
        vTaskSuspendAll();\r
@@ -183,21 +158,21 @@ void *pvReturn = NULL;
                        xHeapHasBeenInitialised = pdTRUE;\r
                }\r
 \r
-               /* The wanted size is increased so it can contain a xBlockLink\r
+               /* The wanted size is increased so it can contain a BlockLink_t\r
                structure in addition to the requested amount of bytes. */\r
                if( xWantedSize > 0 )\r
                {\r
                        xWantedSize += heapSTRUCT_SIZE;\r
 \r
                        /* Ensure that blocks are always aligned to the required number of bytes. */\r
-                       if( xWantedSize & portBYTE_ALIGNMENT_MASK )\r
+                       if( ( xWantedSize & portBYTE_ALIGNMENT_MASK ) != 0 )\r
                        {\r
                                /* Byte alignment required. */\r
                                xWantedSize += ( portBYTE_ALIGNMENT - ( xWantedSize & portBYTE_ALIGNMENT_MASK ) );\r
                        }\r
                }\r
 \r
-               if( ( xWantedSize > 0 ) && ( xWantedSize < configTOTAL_HEAP_SIZE ) )\r
+               if( ( xWantedSize > 0 ) && ( xWantedSize < configADJUSTED_HEAP_SIZE ) )\r
                {\r
                        /* Blocks are stored in byte order - traverse the list from the start\r
                        (smallest) block until one of adequate size is found. */\r
@@ -212,9 +187,9 @@ void *pvReturn = NULL;
                        /* If we found the end marker then a block of adequate size was not found. */\r
                        if( pxBlock != &xEnd )\r
                        {\r
-                               /* Return the memory space - jumping over the xBlockLink structure\r
+                               /* Return the memory space - jumping over the BlockLink_t structure\r
                                at its start. */\r
-                               pvReturn = ( void * ) ( ( ( unsigned char * ) pxPreviousBlock->pxNextFreeBlock ) + heapSTRUCT_SIZE );\r
+                               pvReturn = ( void * ) ( ( ( uint8_t * ) pxPreviousBlock->pxNextFreeBlock ) + heapSTRUCT_SIZE );\r
 \r
                                /* This block is being returned for use so must be taken out of the\r
                                list of free blocks. */\r
@@ -226,7 +201,7 @@ void *pvReturn = NULL;
                                        /* This block is to be split into two.  Create a new block\r
                                        following the number of bytes requested. The void cast is\r
                                        used to prevent byte alignment warnings from the compiler. */\r
-                                       pxNewBlockLink = ( void * ) ( ( ( unsigned char * ) pxBlock ) + xWantedSize );\r
+                                       pxNewBlockLink = ( void * ) ( ( ( uint8_t * ) pxBlock ) + xWantedSize );\r
 \r
                                        /* Calculate the sizes of two blocks split from the single\r
                                        block. */\r
@@ -236,12 +211,14 @@ void *pvReturn = NULL;
                                        /* Insert the new block into the list of free blocks. */\r
                                        prvInsertBlockIntoFreeList( ( pxNewBlockLink ) );\r
                                }\r
-                               \r
+\r
                                xFreeBytesRemaining -= pxBlock->xBlockSize;\r
                        }\r
                }\r
+\r
+               traceMALLOC( pvReturn, xWantedSize );\r
        }\r
-       xTaskResumeAll();\r
+       ( void ) xTaskResumeAll();\r
 \r
        #if( configUSE_MALLOC_FAILED_HOOK == 1 )\r
        {\r
@@ -259,25 +236,27 @@ void *pvReturn = NULL;
 \r
 void vPortFree( void *pv )\r
 {\r
-unsigned char *puc = ( unsigned char * ) pv;\r
-xBlockLink *pxLink;\r
+uint8_t *puc = ( uint8_t * ) pv;\r
+BlockLink_t *pxLink;\r
 \r
        if( pv != NULL )\r
        {\r
-               /* The memory being freed will have an xBlockLink structure immediately\r
+               /* The memory being freed will have an BlockLink_t structure immediately\r
                before it. */\r
                puc -= heapSTRUCT_SIZE;\r
 \r
-               /* This casting is to keep the compiler from issuing warnings. */\r
+               /* This unexpected casting is to keep some compilers from issuing\r
+               byte alignment warnings. */\r
                pxLink = ( void * ) puc;\r
 \r
                vTaskSuspendAll();\r
                {\r
                        /* Add this block to the list of free blocks. */\r
-                       prvInsertBlockIntoFreeList( ( ( xBlockLink * ) pxLink ) );\r
+                       prvInsertBlockIntoFreeList( ( ( BlockLink_t * ) pxLink ) );\r
                        xFreeBytesRemaining += pxLink->xBlockSize;\r
+                       traceFREE( pv, pxLink->xBlockSize );\r
                }\r
-               xTaskResumeAll();\r
+               ( void ) xTaskResumeAll();\r
        }\r
 }\r
 /*-----------------------------------------------------------*/\r
@@ -292,3 +271,29 @@ void vPortInitialiseBlocks( void )
 {\r
        /* This just exists to keep the linker quiet. */\r
 }\r
+/*-----------------------------------------------------------*/\r
+\r
+static void prvHeapInit( void )\r
+{\r
+BlockLink_t *pxFirstFreeBlock;\r
+uint8_t *pucAlignedHeap;\r
+\r
+       /* Ensure the heap starts on a correctly aligned boundary. */\r
+       pucAlignedHeap = ( uint8_t * ) ( ( ( portPOINTER_SIZE_TYPE ) &ucHeap[ portBYTE_ALIGNMENT ] ) & ( ( portPOINTER_SIZE_TYPE ) ~portBYTE_ALIGNMENT_MASK ) );\r
+\r
+       /* xStart is used to hold a pointer to the first item in the list of free\r
+       blocks.  The void cast is used to prevent compiler warnings. */\r
+       xStart.pxNextFreeBlock = ( void * ) pucAlignedHeap;\r
+       xStart.xBlockSize = ( size_t ) 0;\r
+\r
+       /* xEnd is used to mark the end of the list of free blocks. */\r
+       xEnd.xBlockSize = configADJUSTED_HEAP_SIZE;\r
+       xEnd.pxNextFreeBlock = NULL;\r
+\r
+       /* To start with there is a single free block that is sized to take up the\r
+       entire heap space. */\r
+       pxFirstFreeBlock = ( void * ) pucAlignedHeap;\r
+       pxFirstFreeBlock->xBlockSize = configADJUSTED_HEAP_SIZE;\r
+       pxFirstFreeBlock->pxNextFreeBlock = &xEnd;\r
+}\r
+/*-----------------------------------------------------------*/\r