]> git.sur5r.net Git - freertos/blobdiff - FreeRTOS/Source/include/list.h
Update version numbers ready for release.
[freertos] / FreeRTOS / Source / include / list.h
index d0e507188a32aa988cc7db1da74e749d6a827876..e75393d80b70d1ec71c4ccf43e61b6117dc39d2a 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.1.1\r
+ * Copyright (C) 2018 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
  * This is the list implementation used by the scheduler.  While it is tailored\r
@@ -91,6 +53,9 @@
  * \ingroup FreeRTOSIntro\r
  */\r
 \r
+#ifndef INC_FREERTOS_H\r
+       #error FreeRTOS.h must be included before list.h\r
+#endif\r
 \r
 #ifndef LIST_H\r
 #define LIST_H\r
 #ifdef __cplusplus\r
 extern "C" {\r
 #endif\r
+\r
+/* Macros that can be used to place known values within the list structures,\r
+then check that the known values do not get corrupted during the execution of\r
+the application.   These may catch the list data structures being overwritten in\r
+memory.  They will not catch data errors caused by incorrect configuration or\r
+use of FreeRTOS.*/\r
+#if( configUSE_LIST_DATA_INTEGRITY_CHECK_BYTES == 0 )\r
+       /* Define the macros to do nothing. */\r
+       #define listFIRST_LIST_ITEM_INTEGRITY_CHECK_VALUE\r
+       #define listSECOND_LIST_ITEM_INTEGRITY_CHECK_VALUE\r
+       #define listFIRST_LIST_INTEGRITY_CHECK_VALUE\r
+       #define listSECOND_LIST_INTEGRITY_CHECK_VALUE\r
+       #define listSET_FIRST_LIST_ITEM_INTEGRITY_CHECK_VALUE( pxItem )\r
+       #define listSET_SECOND_LIST_ITEM_INTEGRITY_CHECK_VALUE( pxItem )\r
+       #define listSET_LIST_INTEGRITY_CHECK_1_VALUE( pxList )\r
+       #define listSET_LIST_INTEGRITY_CHECK_2_VALUE( pxList )\r
+       #define listTEST_LIST_ITEM_INTEGRITY( pxItem )\r
+       #define listTEST_LIST_INTEGRITY( pxList )\r
+#else\r
+       /* Define macros that add new members into the list structures. */\r
+       #define listFIRST_LIST_ITEM_INTEGRITY_CHECK_VALUE                               TickType_t xListItemIntegrityValue1;\r
+       #define listSECOND_LIST_ITEM_INTEGRITY_CHECK_VALUE                              TickType_t xListItemIntegrityValue2;\r
+       #define listFIRST_LIST_INTEGRITY_CHECK_VALUE                                    TickType_t xListIntegrityValue1;\r
+       #define listSECOND_LIST_INTEGRITY_CHECK_VALUE                                   TickType_t xListIntegrityValue2;\r
+\r
+       /* Define macros that set the new structure members to known values. */\r
+       #define listSET_FIRST_LIST_ITEM_INTEGRITY_CHECK_VALUE( pxItem )         ( pxItem )->xListItemIntegrityValue1 = pdINTEGRITY_CHECK_VALUE\r
+       #define listSET_SECOND_LIST_ITEM_INTEGRITY_CHECK_VALUE( pxItem )        ( pxItem )->xListItemIntegrityValue2 = pdINTEGRITY_CHECK_VALUE\r
+       #define listSET_LIST_INTEGRITY_CHECK_1_VALUE( pxList )          ( pxList )->xListIntegrityValue1 = pdINTEGRITY_CHECK_VALUE\r
+       #define listSET_LIST_INTEGRITY_CHECK_2_VALUE( pxList )          ( pxList )->xListIntegrityValue2 = pdINTEGRITY_CHECK_VALUE\r
+\r
+       /* Define macros that will assert if one of the structure members does not\r
+       contain its expected value. */\r
+       #define listTEST_LIST_ITEM_INTEGRITY( pxItem )          configASSERT( ( ( pxItem )->xListItemIntegrityValue1 == pdINTEGRITY_CHECK_VALUE ) && ( ( pxItem )->xListItemIntegrityValue2 == pdINTEGRITY_CHECK_VALUE ) )\r
+       #define listTEST_LIST_INTEGRITY( pxList )                       configASSERT( ( ( pxList )->xListIntegrityValue1 == pdINTEGRITY_CHECK_VALUE ) && ( ( pxList )->xListIntegrityValue2 == pdINTEGRITY_CHECK_VALUE ) )\r
+#endif /* configUSE_LIST_DATA_INTEGRITY_CHECK_BYTES */\r
+\r
+\r
 /*\r
  * Definition of the only type of object that a list can contain.\r
  */\r
+struct xLIST;\r
 struct xLIST_ITEM\r
 {\r
+       listFIRST_LIST_ITEM_INTEGRITY_CHECK_VALUE                       /*< Set to a known value if configUSE_LIST_DATA_INTEGRITY_CHECK_BYTES is set to 1. */\r
        configLIST_VOLATILE TickType_t xItemValue;                      /*< The value being listed.  In most cases this is used to sort the list in descending order. */\r
        struct xLIST_ITEM * configLIST_VOLATILE pxNext;         /*< Pointer to the next ListItem_t in the list. */\r
        struct xLIST_ITEM * configLIST_VOLATILE pxPrevious;     /*< Pointer to the previous ListItem_t in the list. */\r
        void * pvOwner;                                                                         /*< Pointer to the object (normally a TCB) that contains the list item.  There is therefore a two way link between the object containing the list item and the list item itself. */\r
-       void * configLIST_VOLATILE pvContainer;                         /*< Pointer to the list in which this list item is placed (if any). */\r
+       struct xLIST * configLIST_VOLATILE pxContainer;         /*< Pointer to the list in which this list item is placed (if any). */\r
+       listSECOND_LIST_ITEM_INTEGRITY_CHECK_VALUE                      /*< Set to a known value if configUSE_LIST_DATA_INTEGRITY_CHECK_BYTES is set to 1. */\r
 };\r
 typedef struct xLIST_ITEM ListItem_t;                                  /* For some reason lint wants this as two separate definitions. */\r
 \r
 struct xMINI_LIST_ITEM\r
 {\r
+       listFIRST_LIST_ITEM_INTEGRITY_CHECK_VALUE                       /*< Set to a known value if configUSE_LIST_DATA_INTEGRITY_CHECK_BYTES is set to 1. */\r
        configLIST_VOLATILE TickType_t xItemValue;\r
        struct xLIST_ITEM * configLIST_VOLATILE pxNext;\r
        struct xLIST_ITEM * configLIST_VOLATILE pxPrevious;\r
@@ -156,9 +163,11 @@ typedef struct xMINI_LIST_ITEM MiniListItem_t;
  */\r
 typedef struct xLIST\r
 {\r
-       configLIST_VOLATILE UBaseType_t uxNumberOfItems;\r
-       ListItem_t * configLIST_VOLATILE pxIndex;               /*< Used to walk through the list.  Points to the last item returned by a call to listGET_OWNER_OF_NEXT_ENTRY (). */\r
-       MiniListItem_t xListEnd;                                                /*< List item that contains the maximum possible item value meaning it is always at the end of the list and is therefore used as a marker. */\r
+       listFIRST_LIST_INTEGRITY_CHECK_VALUE                            /*< Set to a known value if configUSE_LIST_DATA_INTEGRITY_CHECK_BYTES is set to 1. */\r
+       volatile UBaseType_t uxNumberOfItems;\r
+       ListItem_t * configLIST_VOLATILE pxIndex;                       /*< Used to walk through the list.  Points to the last item returned by a call to listGET_OWNER_OF_NEXT_ENTRY (). */\r
+       MiniListItem_t xListEnd;                                                        /*< List item that contains the maximum possible item value meaning it is always at the end of the list and is therefore used as a marker. */\r
+       listSECOND_LIST_INTEGRITY_CHECK_VALUE                           /*< Set to a known value if configUSE_LIST_DATA_INTEGRITY_CHECK_BYTES is set to 1. */\r
 } List_t;\r
 \r
 /*\r
@@ -238,7 +247,7 @@ typedef struct xLIST
  * \page listLIST_IS_EMPTY listLIST_IS_EMPTY\r
  * \ingroup LinkedList\r
  */\r
-#define listLIST_IS_EMPTY( pxList )    ( ( BaseType_t ) ( ( pxList )->uxNumberOfItems == ( UBaseType_t ) 0 ) )\r
+#define listLIST_IS_EMPTY( pxList )    ( ( ( pxList )->uxNumberOfItems == ( UBaseType_t ) 0 ) ? pdTRUE : pdFALSE )\r
 \r
 /*\r
  * Access macro to return the number of items in the list.\r
@@ -306,7 +315,7 @@ List_t * const pxConstList = ( pxList );                                                                                                    \
  * @param pxListItem The list item we want to know if is in the list.\r
  * @return pdTRUE if the list item is in the list, otherwise pdFALSE.\r
  */\r
-#define listIS_CONTAINED_WITHIN( pxList, pxListItem ) ( ( BaseType_t ) ( ( pxListItem )->pvContainer == ( void * ) ( pxList ) ) )\r
+#define listIS_CONTAINED_WITHIN( pxList, pxListItem ) ( ( ( pxListItem )->pxContainer == ( pxList ) ) ? ( pdTRUE ) : ( pdFALSE ) )\r
 \r
 /*\r
  * Return the list a list item is contained within (referenced from).\r
@@ -314,7 +323,7 @@ List_t * const pxConstList = ( pxList );                                                                                                    \
  * @param pxListItem The list item being queried.\r
  * @return A pointer to the List_t object that references the pxListItem\r
  */\r
-#define listLIST_ITEM_CONTAINER( pxListItem ) ( ( pxListItem )->pvContainer )\r
+#define listLIST_ITEM_CONTAINER( pxListItem ) ( ( pxListItem )->pxContainer )\r
 \r
 /*\r
  * This provides a crude means of knowing if a list has been initialised, as\r
@@ -333,7 +342,7 @@ List_t * const pxConstList = ( pxList );                                                                                                    \
  * \page vListInitialise vListInitialise\r
  * \ingroup LinkedList\r
  */\r
-void vListInitialise( List_t * const pxList );\r
+void vListInitialise( List_t * const pxList ) PRIVILEGED_FUNCTION;\r
 \r
 /*\r
  * Must be called before a list item is used.  This sets the list container to\r
@@ -344,7 +353,7 @@ void vListInitialise( List_t * const pxList );
  * \page vListInitialiseItem vListInitialiseItem\r
  * \ingroup LinkedList\r
  */\r
-void vListInitialiseItem( ListItem_t * const pxItem );\r
+void vListInitialiseItem( ListItem_t * const pxItem ) PRIVILEGED_FUNCTION;\r
 \r
 /*\r
  * Insert a list item into a list.  The item will be inserted into the list in\r
@@ -357,19 +366,19 @@ void vListInitialiseItem( ListItem_t * const pxItem );
  * \page vListInsert vListInsert\r
  * \ingroup LinkedList\r
  */\r
-void vListInsert( List_t * const pxList, ListItem_t * const pxNewListItem );\r
+void vListInsert( List_t * const pxList, ListItem_t * const pxNewListItem ) PRIVILEGED_FUNCTION;\r
 \r
 /*\r
  * Insert a list item into a list.  The item will be inserted in a position\r
  * such that it will be the last item within the list returned by multiple\r
  * calls to listGET_OWNER_OF_NEXT_ENTRY.\r
  *\r
- * The list member pvIndex is used to walk through a list.  Calling\r
- * listGET_OWNER_OF_NEXT_ENTRY increments pvIndex to the next item in the list.\r
+ * The list member pxIndex is used to walk through a list.  Calling\r
+ * listGET_OWNER_OF_NEXT_ENTRY increments pxIndex to the next item in the list.\r
  * Placing an item in a list using vListInsertEnd effectively places the item\r
- * in the list position pointed to by pvIndex.  This means that every other\r
+ * in the list position pointed to by pxIndex.  This means that every other\r
  * item within the list will be returned by listGET_OWNER_OF_NEXT_ENTRY before\r
- * the pvIndex parameter again points to the item being inserted.\r
+ * the pxIndex parameter again points to the item being inserted.\r
  *\r
  * @param pxList The list into which the item is to be inserted.\r
  *\r
@@ -378,7 +387,7 @@ void vListInsert( List_t * const pxList, ListItem_t * const pxNewListItem );
  * \page vListInsertEnd vListInsertEnd\r
  * \ingroup LinkedList\r
  */\r
-void vListInsertEnd( List_t * const pxList, ListItem_t * const pxNewListItem );\r
+void vListInsertEnd( List_t * const pxList, ListItem_t * const pxNewListItem ) PRIVILEGED_FUNCTION;\r
 \r
 /*\r
  * Remove an item from a list.  The list item has a pointer to the list that\r
@@ -393,7 +402,7 @@ void vListInsertEnd( List_t * const pxList, ListItem_t * const pxNewListItem );
  * \page uxListRemove uxListRemove\r
  * \ingroup LinkedList\r
  */\r
-UBaseType_t uxListRemove( ListItem_t * const pxItemToRemove );\r
+UBaseType_t uxListRemove( ListItem_t * const pxItemToRemove ) PRIVILEGED_FUNCTION;\r
 \r
 #ifdef __cplusplus\r
 }\r