]> git.sur5r.net Git - freertos/blobdiff - FreeRTOS/Source/list.c
Roll up the minor changes checked into svn since V10.0.0 into new V10.0.1 ready for...
[freertos] / FreeRTOS / Source / list.c
index 3c11a88f78bb0c5eb54565a75dcbb435dbeff0d7..e3a54e3609c561410048e9856ec33da762ca385e 100644 (file)
@@ -1,67 +1,29 @@
 /*\r
-    FreeRTOS V7.6.0 - Copyright (C) 2013 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 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
-     *    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.0.1\r
+ * Copyright (C) 2017 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
 #include <stdlib.h>\r
  * PUBLIC LIST API documented in list.h\r
  *----------------------------------------------------------*/\r
 \r
-void vListInitialise( xList * const pxList )\r
+void vListInitialise( List_t * const pxList )\r
 {\r
        /* The list structure contains a list item which is used to mark the\r
        end of the list.  To initialise the list the list end is inserted\r
        as the only list entry. */\r
-       pxList->pxIndex = ( xListItem * ) &( pxList->xListEnd );                        /*lint !e826 !e740 The mini list structure is used as the list end to save RAM.  This is checked and valid. */\r
+       pxList->pxIndex = ( ListItem_t * ) &( pxList->xListEnd );                       /*lint !e826 !e740 The mini list structure is used as the list end to save RAM.  This is checked and valid. */\r
 \r
        /* The list end value is the highest possible value in the list to\r
        ensure it remains at the end of the list. */\r
@@ -85,29 +47,49 @@ void vListInitialise( xList * const pxList )
 \r
        /* The list end next and previous pointers point to itself so we know\r
        when the list is empty. */\r
-       pxList->xListEnd.pxNext = ( xListItem * ) &( pxList->xListEnd );        /*lint !e826 !e740 The mini list structure is used as the list end to save RAM.  This is checked and valid. */\r
-       pxList->xListEnd.pxPrevious = ( xListItem * ) &( pxList->xListEnd );/*lint !e826 !e740 The mini list structure is used as the list end to save RAM.  This is checked and valid. */\r
+       pxList->xListEnd.pxNext = ( ListItem_t * ) &( pxList->xListEnd );       /*lint !e826 !e740 The mini list structure is used as the list end to save RAM.  This is checked and valid. */\r
+       pxList->xListEnd.pxPrevious = ( ListItem_t * ) &( pxList->xListEnd );/*lint !e826 !e740 The mini list structure is used as the list end to save RAM.  This is checked and valid. */\r
 \r
-       pxList->uxNumberOfItems = ( unsigned portBASE_TYPE ) 0U;\r
+       pxList->uxNumberOfItems = ( UBaseType_t ) 0U;\r
+\r
+       /* Write known values into the list if\r
+       configUSE_LIST_DATA_INTEGRITY_CHECK_BYTES is set to 1. */\r
+       listSET_LIST_INTEGRITY_CHECK_1_VALUE( pxList );\r
+       listSET_LIST_INTEGRITY_CHECK_2_VALUE( pxList );\r
 }\r
 /*-----------------------------------------------------------*/\r
 \r
-void vListInitialiseItem( xListItem * const pxItem )\r
+void vListInitialiseItem( ListItem_t * const pxItem )\r
 {\r
        /* Make sure the list item is not recorded as being on a list. */\r
        pxItem->pvContainer = NULL;\r
+\r
+       /* Write known values into the list item if\r
+       configUSE_LIST_DATA_INTEGRITY_CHECK_BYTES is set to 1. */\r
+       listSET_FIRST_LIST_ITEM_INTEGRITY_CHECK_VALUE( pxItem );\r
+       listSET_SECOND_LIST_ITEM_INTEGRITY_CHECK_VALUE( pxItem );\r
 }\r
 /*-----------------------------------------------------------*/\r
 \r
-void vListInsertEnd( xList * const pxList, xListItem * const pxNewListItem )\r
+void vListInsertEnd( List_t * const pxList, ListItem_t * const pxNewListItem )\r
 {\r
-xListItem * const pxIndex = pxList->pxIndex;\r
+ListItem_t * const pxIndex = pxList->pxIndex;\r
+\r
+       /* Only effective when configASSERT() is also defined, these tests may catch\r
+       the list data structures being overwritten in memory.  They will not catch\r
+       data errors caused by incorrect configuration or use of FreeRTOS. */\r
+       listTEST_LIST_INTEGRITY( pxList );\r
+       listTEST_LIST_ITEM_INTEGRITY( pxNewListItem );\r
 \r
        /* Insert a new list item into pxList, but rather than sort the list,\r
        makes the new list item the last item to be removed by a call to\r
        listGET_OWNER_OF_NEXT_ENTRY(). */\r
        pxNewListItem->pxNext = pxIndex;\r
        pxNewListItem->pxPrevious = pxIndex->pxPrevious;\r
+\r
+       /* Only used during decision coverage testing. */\r
+       mtCOVERAGE_TEST_DELAY();\r
+\r
        pxIndex->pxPrevious->pxNext = pxNewListItem;\r
        pxIndex->pxPrevious = pxNewListItem;\r
 \r
@@ -118,20 +100,25 @@ xListItem * const pxIndex = pxList->pxIndex;
 }\r
 /*-----------------------------------------------------------*/\r
 \r
-void vListInsert( xList * const pxList, xListItem * const pxNewListItem )\r
+void vListInsert( List_t * const pxList, ListItem_t * const pxNewListItem )\r
 {\r
-xListItem *pxIterator;\r
-const portTickType xValueOfInsertion = pxNewListItem->xItemValue;\r
+ListItem_t *pxIterator;\r
+const TickType_t xValueOfInsertion = pxNewListItem->xItemValue;\r
+\r
+       /* Only effective when configASSERT() is also defined, these tests may catch\r
+       the list data structures being overwritten in memory.  They will not catch\r
+       data errors caused by incorrect configuration or use of FreeRTOS. */\r
+       listTEST_LIST_INTEGRITY( pxList );\r
+       listTEST_LIST_ITEM_INTEGRITY( pxNewListItem );\r
 \r
        /* Insert the new list item into the list, sorted in xItemValue order.\r
 \r
-       If the list already contains a list item with the same item value then\r
-       the new list item should be placed after it.  This ensures that TCB's which\r
-       are stored in ready lists (all of which have the same xItemValue value)\r
-       get an equal share of the CPU.  However, if the xItemValue is the same as\r
-       the back marker the iteration loop below will not end.  This means we need\r
-       to guard against this by checking the value first and modifying the\r
-       algorithm slightly if necessary. */\r
+       If the list already contains a list item with the same item value then the\r
+       new list item should be placed after it.  This ensures that TCB's which are\r
+       stored in ready lists (all of which have the same xItemValue value) get a\r
+       share of the CPU.  However, if the xItemValue is the same as the back marker\r
+       the iteration loop below will not end.  Therefore the value is checked\r
+       first, and the algorithm slightly modified if necessary. */\r
        if( xValueOfInsertion == portMAX_DELAY )\r
        {\r
                pxIterator = pxList->xListEnd.pxPrevious;\r
@@ -139,26 +126,31 @@ const portTickType xValueOfInsertion = pxNewListItem->xItemValue;
        else\r
        {\r
                /* *** NOTE ***********************************************************\r
-               If you find your application is crashing here then likely causes are:\r
+               If you find your application is crashing here then likely causes are\r
+               listed below.  In addition see http://www.freertos.org/FAQHelp.html for\r
+               more tips, and ensure configASSERT() is defined!\r
+               http://www.freertos.org/a00110.html#configASSERT\r
+\r
                        1) Stack overflow -\r
                           see http://www.freertos.org/Stacks-and-stack-overflow-checking.html\r
-                       2) Incorrect interrupt priority assignment, especially on Cortex-M3\r
+                       2) Incorrect interrupt priority assignment, especially on Cortex-M\r
                           parts where numerically high priority values denote low actual\r
-                          interrupt priories, which can seem counter intuitive.  See\r
-                          configMAX_SYSCALL_INTERRUPT_PRIORITY on http://www.freertos.org/a00110.html\r
+                          interrupt priorities, which can seem counter intuitive.  See\r
+                          http://www.freertos.org/RTOS-Cortex-M3-M4.html and the definition\r
+                          of configMAX_SYSCALL_INTERRUPT_PRIORITY on\r
+                          http://www.freertos.org/a00110.html\r
                        3) Calling an API function from within a critical section or when\r
                           the scheduler is suspended, or calling an API function that does\r
                           not end in "FromISR" from an interrupt.\r
                        4) Using a queue or semaphore before it has been initialised or\r
                           before the scheduler has been started (are interrupts firing\r
                           before vTaskStartScheduler() has been called?).\r
-               See http://www.freertos.org/FAQHelp.html for more tips.\r
                **********************************************************************/\r
 \r
-               for( pxIterator = ( xListItem * ) &( pxList->xListEnd ); pxIterator->pxNext->xItemValue <= xValueOfInsertion; pxIterator = pxIterator->pxNext ) /*lint !e826 !e740 The mini list structure is used as the list end to save RAM.  This is checked and valid. */\r
+               for( pxIterator = ( ListItem_t * ) &( pxList->xListEnd ); pxIterator->pxNext->xItemValue <= xValueOfInsertion; pxIterator = pxIterator->pxNext ) /*lint !e826 !e740 The mini list structure is used as the list end to save RAM.  This is checked and valid. */\r
                {\r
-                       /* There is nothing to do here, we are just iterating to the\r
-                       wanted insertion position. */\r
+                       /* There is nothing to do here, just iterating to the wanted\r
+                       insertion position. */\r
                }\r
        }\r
 \r
@@ -175,15 +167,18 @@ const portTickType xValueOfInsertion = pxNewListItem->xItemValue;
 }\r
 /*-----------------------------------------------------------*/\r
 \r
-unsigned portBASE_TYPE uxListRemove( xListItem * const pxItemToRemove )\r
+UBaseType_t uxListRemove( ListItem_t * const pxItemToRemove )\r
 {\r
 /* The list item knows which list it is in.  Obtain the list from the list\r
 item. */\r
-xList * const pxList = ( xList * ) pxItemToRemove->pvContainer;\r
+List_t * const pxList = ( List_t * ) pxItemToRemove->pvContainer;\r
 \r
        pxItemToRemove->pxNext->pxPrevious = pxItemToRemove->pxPrevious;\r
        pxItemToRemove->pxPrevious->pxNext = pxItemToRemove->pxNext;\r
 \r
+       /* Only used during decision coverage testing. */\r
+       mtCOVERAGE_TEST_DELAY();\r
+\r
        /* Make sure the index is left pointing to a valid item. */\r
        if( pxList->pxIndex == pxItemToRemove )\r
        {\r