]> git.sur5r.net Git - freertos/blobdiff - FreeRTOS/Source/portable/MemMang/heap_5.c
Continued to work on the MQTT demo project.
[freertos] / FreeRTOS / Source / portable / MemMang / heap_5.c
index 469772ecd62e5b4c8a0ce3eec38a63f82315749c..cf814d116afec2e5401fa030facc3f9bf0b8db21 100644 (file)
@@ -1,67 +1,29 @@
 /*\r
-    FreeRTOS V8.1.1 - Copyright (C) 2014 Real Time Engineers Ltd.\r
-    All rights reserved\r
-\r
-    VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
-\r
-    ***************************************************************************\r
-     *                                                                       *\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
-     *    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
-     *    Thank you!                                                         *\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
-\r
-    >>!   NOTE: The modification to the GPL is included to allow you to     !<<\r
-    >>!   distribute a combined work that includes FreeRTOS without being   !<<\r
-    >>!   obliged to provide the source code for proprietary components     !<<\r
-    >>!   outside of the FreeRTOS 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
-     *    Having a problem?  Start by reading the FAQ "My application does   *\r
-     *    not run, what could be wrong?"                                     *\r
-     *                                                                       *\r
-     *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
-     *                                                                       *\r
-    ***************************************************************************\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, 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
-    1 tab == 4 spaces!\r
-*/\r
+ * FreeRTOS Kernel V10.2.1\r
+ * Copyright (C) 2019 Amazon.com, Inc. or its affiliates.  All Rights Reserved.\r
+ *\r
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
+ * this software and associated documentation files (the "Software"), to deal in\r
+ * the Software without restriction, including without limitation the rights to\r
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
+ * the Software, and to permit persons to whom the Software is furnished to do so,\r
+ * subject to the following conditions:\r
+ *\r
+ * The above copyright notice and this permission notice shall be included in all\r
+ * copies or substantial portions of the Software.\r
+ *\r
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
+ * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
+ * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
+ *\r
+ * http://www.FreeRTOS.org\r
+ * http://aws.amazon.com/freertos\r
+ *\r
+ * 1 tab == 4 spaces!\r
+ */\r
 \r
 /*\r
  * A sample implementation of pvPortMalloc() that allows the heap to be defined\r
@@ -117,8 +79,12 @@ task.h is included from an application file. */
 \r
 #undef MPU_WRAPPERS_INCLUDED_FROM_API_FILE\r
 \r
+#if( configSUPPORT_DYNAMIC_ALLOCATION == 0 )\r
+       #error This file must not be used if configSUPPORT_DYNAMIC_ALLOCATION is 0\r
+#endif\r
+\r
 /* Block sizes must not get too small. */\r
-#define heapMINIMUM_BLOCK_SIZE ( ( size_t ) ( uxHeapStructSize << 1 ) )\r
+#define heapMINIMUM_BLOCK_SIZE ( ( size_t ) ( xHeapStructSize << 1 ) )\r
 \r
 /* Assumes 8bit bytes! */\r
 #define heapBITS_PER_BYTE              ( ( size_t ) 8 )\r
@@ -145,15 +111,17 @@ static void prvInsertBlockIntoFreeList( BlockLink_t *pxBlockToInsert );
 \r
 /* The size of the structure placed at the beginning of each allocated memory\r
 block must by correctly byte aligned. */\r
-static const uint32_t uxHeapStructSize = ( ( sizeof ( BlockLink_t ) + ( portBYTE_ALIGNMENT - 1 ) ) & ~portBYTE_ALIGNMENT_MASK );\r
+static const size_t xHeapStructSize    = ( sizeof( BlockLink_t ) + ( ( size_t ) ( portBYTE_ALIGNMENT - 1 ) ) ) & ~( ( size_t ) portBYTE_ALIGNMENT_MASK );\r
 \r
 /* Create a couple of list links to mark the start and end of the list. */\r
 static BlockLink_t xStart, *pxEnd = NULL;\r
 \r
-/* Keeps track of the number of free bytes remaining, but says nothing about\r
-fragmentation. */\r
-static size_t xFreeBytesRemaining = 0;\r
-static size_t xMinimumEverFreeBytesRemaining = 0;\r
+/* Keeps track of the number of calls to allocate and free memory as well as the\r
+number of free bytes remaining, but says nothing about fragmentation. */\r
+static size_t xFreeBytesRemaining = 0U;\r
+static size_t xMinimumEverFreeBytesRemaining = 0U;\r
+static size_t xNumberOfSuccessfulAllocations = 0;\r
+static size_t xNumberOfSuccessfulFrees = 0;\r
 \r
 /* Gets set to the top bit of an size_t type.  When this bit in the xBlockSize\r
 member of an BlockLink_t structure is set then the block belongs to the\r
@@ -184,7 +152,7 @@ void *pvReturn = NULL;
                        structure in addition to the requested amount of bytes. */\r
                        if( xWantedSize > 0 )\r
                        {\r
-                               xWantedSize += uxHeapStructSize;\r
+                               xWantedSize += xHeapStructSize;\r
 \r
                                /* Ensure that blocks are always aligned to the required number\r
                                of bytes. */\r
@@ -221,7 +189,7 @@ void *pvReturn = NULL;
                                {\r
                                        /* Return the memory space pointed to - jumping over the\r
                                        BlockLink_t structure at its start. */\r
-                                       pvReturn = ( void * ) ( ( ( uint8_t * ) pxPreviousBlock->pxNextFreeBlock ) + uxHeapStructSize );\r
+                                       pvReturn = ( void * ) ( ( ( uint8_t * ) pxPreviousBlock->pxNextFreeBlock ) + xHeapStructSize );\r
 \r
                                        /* This block is being returned for use so must be taken out\r
                                        of the list of free blocks. */\r
@@ -265,6 +233,7 @@ void *pvReturn = NULL;
                                        by the application and has no "next" block. */\r
                                        pxBlock->xBlockSize |= xBlockAllocatedBit;\r
                                        pxBlock->pxNextFreeBlock = NULL;\r
+                                       xNumberOfSuccessfulAllocations++;\r
                                }\r
                                else\r
                                {\r
@@ -312,7 +281,7 @@ BlockLink_t *pxLink;
        {\r
                /* The memory being freed will have an BlockLink_t structure immediately\r
                before it. */\r
-               puc -= uxHeapStructSize;\r
+               puc -= xHeapStructSize;\r
 \r
                /* This casting is to keep the compiler from issuing warnings. */\r
                pxLink = ( void * ) puc;\r
@@ -335,6 +304,7 @@ BlockLink_t *pxLink;
                                        xFreeBytesRemaining += pxLink->xBlockSize;\r
                                        traceFREE( pv, pxLink->xBlockSize );\r
                                        prvInsertBlockIntoFreeList( ( ( BlockLink_t * ) pxLink ) );\r
+                                       xNumberOfSuccessfulFrees++;\r
                                }\r
                                ( void ) xTaskResumeAll();\r
                        }\r
@@ -427,10 +397,10 @@ uint8_t *puc;
 void vPortDefineHeapRegions( const HeapRegion_t * const pxHeapRegions )\r
 {\r
 BlockLink_t *pxFirstFreeBlockInRegion = NULL, *pxPreviousFreeBlock;\r
-uint8_t *pucAlignedHeap;\r
+size_t xAlignedHeap;\r
 size_t xTotalRegionSize, xTotalHeapSize = 0;\r
 BaseType_t xDefinedRegions = 0;\r
-uint32_t ulAddress;\r
+size_t xAddress;\r
 const HeapRegion_t *pxHeapRegion;\r
 \r
        /* Can only call once! */\r
@@ -443,24 +413,24 @@ const HeapRegion_t *pxHeapRegion;
                xTotalRegionSize = pxHeapRegion->xSizeInBytes;\r
 \r
                /* Ensure the heap region starts on a correctly aligned boundary. */\r
-               ulAddress = ( uint32_t ) pxHeapRegion->pucStartAddress;\r
-               if( ( ulAddress & portBYTE_ALIGNMENT_MASK ) != 0 )\r
+               xAddress = ( size_t ) pxHeapRegion->pucStartAddress;\r
+               if( ( xAddress & portBYTE_ALIGNMENT_MASK ) != 0 )\r
                {\r
-                       ulAddress += ( portBYTE_ALIGNMENT - 1 );\r
-                       ulAddress &= ~portBYTE_ALIGNMENT_MASK;\r
+                       xAddress += ( portBYTE_ALIGNMENT - 1 );\r
+                       xAddress &= ~portBYTE_ALIGNMENT_MASK;\r
 \r
                        /* Adjust the size for the bytes lost to alignment. */\r
-                       xTotalRegionSize -= ulAddress - ( uint32_t ) pxHeapRegion->pucStartAddress;\r
+                       xTotalRegionSize -= xAddress - ( size_t ) pxHeapRegion->pucStartAddress;\r
                }\r
 \r
-               pucAlignedHeap = ( uint8_t * ) ulAddress;\r
+               xAlignedHeap = xAddress;\r
 \r
                /* Set xStart if it has not already been set. */\r
                if( xDefinedRegions == 0 )\r
                {\r
                        /* xStart is used to hold a pointer to the first item in the list of\r
                        free blocks.  The void cast is used to prevent compiler warnings. */\r
-                       xStart.pxNextFreeBlock = ( BlockLink_t * ) pucAlignedHeap;\r
+                       xStart.pxNextFreeBlock = ( BlockLink_t * ) xAlignedHeap;\r
                        xStart.xBlockSize = ( size_t ) 0;\r
                }\r
                else\r
@@ -470,7 +440,7 @@ const HeapRegion_t *pxHeapRegion;
                        configASSERT( pxEnd != NULL );\r
 \r
                        /* Check blocks are passed in with increasing start addresses. */\r
-                       configASSERT( ulAddress > ( uint32_t ) pxEnd );\r
+                       configASSERT( xAddress > ( size_t ) pxEnd );\r
                }\r
 \r
                /* Remember the location of the end marker in the previous region, if\r
@@ -479,18 +449,18 @@ const HeapRegion_t *pxHeapRegion;
 \r
                /* pxEnd is used to mark the end of the list of free blocks and is\r
                inserted at the end of the region space. */\r
-               ulAddress = ( ( uint32_t ) pucAlignedHeap ) + xTotalRegionSize;\r
-               ulAddress -= uxHeapStructSize;\r
-               ulAddress &= ~portBYTE_ALIGNMENT_MASK;\r
-               pxEnd = ( BlockLink_t * ) ulAddress;\r
+               xAddress = xAlignedHeap + xTotalRegionSize;\r
+               xAddress -= xHeapStructSize;\r
+               xAddress &= ~portBYTE_ALIGNMENT_MASK;\r
+               pxEnd = ( BlockLink_t * ) xAddress;\r
                pxEnd->xBlockSize = 0;\r
                pxEnd->pxNextFreeBlock = NULL;\r
 \r
                /* To start with there is a single free block in this region that is\r
                sized to take up the entire heap region minus the space taken by the\r
                free block structure. */\r
-               pxFirstFreeBlockInRegion = ( BlockLink_t * ) pucAlignedHeap;\r
-               pxFirstFreeBlockInRegion->xBlockSize = ulAddress - ( uint32_t ) pxFirstFreeBlockInRegion;\r
+               pxFirstFreeBlockInRegion = ( BlockLink_t * ) xAlignedHeap;\r
+               pxFirstFreeBlockInRegion->xBlockSize = xAddress - ( size_t ) pxFirstFreeBlockInRegion;\r
                pxFirstFreeBlockInRegion->pxNextFreeBlock = pxEnd;\r
 \r
                /* If this is not the first region that makes up the entire heap space\r
@@ -516,4 +486,62 @@ const HeapRegion_t *pxHeapRegion;
        /* Work out the position of the top bit in a size_t variable. */\r
        xBlockAllocatedBit = ( ( size_t ) 1 ) << ( ( sizeof( size_t ) * heapBITS_PER_BYTE ) - 1 );\r
 }\r
+/*-----------------------------------------------------------*/\r
+\r
+void vPortGetHeapStats( HeapStats_t *pxHeapStats )\r
+{\r
+BlockLink_t *pxBlock;\r
+size_t xBlocks = 0, xMaxSize = 0, xMinSize = portMAX_DELAY; /* portMAX_DELAY used as a portable way of getting the maximum value. */\r
+\r
+       vTaskSuspendAll();\r
+       {\r
+               pxBlock = xStart.pxNextFreeBlock;\r
+\r
+               /* pxBlock will be NULL if the heap has not been initialised.  The heap\r
+               is initialised automatically when the first allocation is made. */\r
+               if( pxBlock != NULL )\r
+               {\r
+                       do\r
+                       {\r
+                               /* Increment the number of blocks and record the largest block seen\r
+                               so far. */\r
+                               xBlocks++;\r
+\r
+                               if( pxBlock->xBlockSize > xMaxSize )\r
+                               {\r
+                                       xMaxSize = pxBlock->xBlockSize;\r
+                               }\r
+\r
+                               /* Heap five will have a zero sized block at the end of each\r
+                               each region - the block is only used to link to the next\r
+                               heap region so it not a real block. */\r
+                               if( pxBlock->xBlockSize != 0 )\r
+                               {\r
+                                       if( pxBlock->xBlockSize < xMinSize )\r
+                                       {\r
+                                               xMinSize = pxBlock->xBlockSize;\r
+                                       }\r
+                               }\r
+\r
+                               /* Move to the next block in the chain until the last block is\r
+                               reached. */\r
+                               pxBlock = pxBlock->pxNextFreeBlock;\r
+                       } while( pxBlock != pxEnd );\r
+               }\r
+       }\r
+       xTaskResumeAll();\r
+\r
+       pxHeapStats->xSizeOfLargestFreeBlockInBytes = xMaxSize;\r
+       pxHeapStats->xSizeOfSmallestFreeBlockInBytes = xMinSize;\r
+       pxHeapStats->xNumberOfFreeBlocks = xBlocks;\r
+\r
+       taskENTER_CRITICAL();\r
+       {\r
+               pxHeapStats->xAvailableHeapSpaceInBytes = xFreeBytesRemaining;\r
+               pxHeapStats->xNumberOfSuccessfulAllocations = xNumberOfSuccessfulAllocations;\r
+               pxHeapStats->xNumberOfSuccessfulFrees = xNumberOfSuccessfulFrees;\r
+               pxHeapStats->xMinimumEverFreeBytesRemaining = xMinimumEverFreeBytesRemaining;\r
+       }\r
+       taskEXIT_CRITICAL();\r
+}\r
 \r