git.sur5r.net Git - freertos/blob - Source/include/list.h

   1 /*\r
   2         FreeRTOS.org V4.8.0 - Copyright (C) 2003-2008 Richard Barry.\r
   3 \r
   4         This file is part of the FreeRTOS.org distribution.\r
   5 \r
   6         FreeRTOS.org is free software; you can redistribute it and/or modify\r
   7         it under the terms of the GNU General Public License as published by\r
   8         the Free Software Foundation; either version 2 of the License, or\r
   9         (at your option) any later version.\r
  10 \r
  11         FreeRTOS.org is distributed in the hope that it will be useful,\r
  12         but WITHOUT ANY WARRANTY; without even the implied warranty of\r
  13         MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
  14         GNU General Public License for more details.\r
  15 \r
  16         You should have received a copy of the GNU General Public License\r
  17         along with FreeRTOS.org; if not, write to the Free Software\r
  18         Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA\r
  19 \r
  20         A special exception to the GPL can be applied should you wish to distribute\r
  21         a combined work that includes FreeRTOS.org, without being obliged to provide\r
  22         the source code for any proprietary components.  See the licensing section\r
  23         of http://www.FreeRTOS.org for full details of how and when the exception\r
  24         can be applied.\r
  25 \r
  26         ***************************************************************************\r
  27         ***************************************************************************\r
  28         *                                                                                                                                                 *\r
  29         * SAVE TIME AND MONEY!  Why not get us to quote to get FreeRTOS.org               *\r
  30         * running on your hardware - or even write all or part of your application*\r
  31         * for you?  See http://www.OpenRTOS.com for details.                                      *\r
  32         *                                                                                                                                                 *\r
  33         ***************************************************************************\r
  34         ***************************************************************************\r
  35 \r
  36         Please ensure to read the configuration and relevant port sections of the\r
  37         online documentation.\r
  38 \r
  39         http://www.FreeRTOS.org - Documentation, latest information, license and \r
  40         contact details.\r
  41 \r
  42         http://www.SafeRTOS.com - A version that is certified for use in safety \r
  43         critical systems.\r
  44 \r
  45         http://www.OpenRTOS.com - Commercial support, development, porting, \r
  46         licensing and training services.\r
  47 */\r
  48 \r
  49 /*\r
  50  * This is the list implementation used by the scheduler.  While it is tailored\r
  51  * heavily for the schedulers needs, it is also available for use by\r
  52  * application code.\r
  53  *\r
  54  * xLists can only store pointers to xListItems.  Each xListItem contains a\r
  55  * numeric value (xItemValue).  Most of the time the lists are sorted in\r
  56  * descending item value order.\r
  57  *\r
  58  * Lists are created already containing one list item.  The value of this\r
  59  * item is the maximum possible that can be stored, it is therefore always at\r
  60  * the end of the list and acts as a marker.  The list member pxHead always\r
  61  * points to this marker - even though it is at the tail of the list.  This\r
  62  * is because the tail contains a wrap back pointer to the true head of\r
  63  * the list.\r
  64  *\r
  65  * In addition to it's value, each list item contains a pointer to the next\r
  66  * item in the list (pxNext), a pointer to the list it is in (pxContainer)\r
  67  * and a pointer to back to the object that contains it.  These later two\r
  68  * pointers are included for efficiency of list manipulation.  There is\r
  69  * effectively a two way link between the object containing the list item and\r
  70  * the list item itself.\r
  71  *\r
  72  *\r
  73  * \page ListIntroduction List Implementation\r
  74  * \ingroup FreeRTOSIntro\r
  75  */\r
  76 \r
  77 /*\r
  78         Changes from V4.3.1\r
  79 \r
  80         + Included local const within listGET_OWNER_OF_NEXT_ENTRY() to assist\r
  81           compiler with optimisation.  Thanks B.R.\r
  82 */\r
  83 \r
  84 #ifndef LIST_H\r
  85 #define LIST_H\r
  86 \r
  87 #ifdef __cplusplus\r
  88 extern "C" {\r
  89 #endif\r
  90 /*\r
  91  * Definition of the only type of object that a list can contain.\r
  92  */\r
  93 struct xLIST_ITEM\r
  94 {\r
  95         portTickType xItemValue;                                /*< The value being listed.  In most cases this is used to sort the list in descending order. */\r
  96         volatile struct xLIST_ITEM * pxNext;    /*< Pointer to the next xListItem in the list. */\r
  97         volatile struct xLIST_ITEM * pxPrevious;/*< Pointer to the previous xListItem in the list. */\r
  98         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
  99         void * pvContainer;                                             /*< Pointer to the list in which this list item is placed (if any). */\r
 100 };\r
 101 typedef struct xLIST_ITEM xListItem;            /* For some reason lint wants this as two separate definitions. */\r
 102 \r
 103 struct xMINI_LIST_ITEM\r
 104 {\r
 105         portTickType xItemValue;\r
 106         volatile struct xLIST_ITEM *pxNext;\r
 107         volatile struct xLIST_ITEM *pxPrevious;\r
 108 };\r
 109 typedef struct xMINI_LIST_ITEM xMiniListItem;\r
 110 \r
 111 /*\r
 112  * Definition of the type of queue used by the scheduler.\r
 113  */\r
 114 typedef struct xLIST\r
 115 {\r
 116         volatile unsigned portBASE_TYPE uxNumberOfItems;\r
 117         volatile xListItem * pxIndex;                   /*< Used to walk through the list.  Points to the last item returned by a call to pvListGetOwnerOfNextEntry (). */\r
 118         volatile xMiniListItem 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
 119 } xList;\r
 120 \r
 121 /*\r
 122  * Access macro to set the owner of a list item.  The owner of a list item\r
 123  * is the object (usually a TCB) that contains the list item.\r
 124  *\r
 125  * \page listSET_LIST_ITEM_OWNER listSET_LIST_ITEM_OWNER\r
 126  * \ingroup LinkedList\r
 127  */\r
 128 #define listSET_LIST_ITEM_OWNER( pxListItem, pxOwner )          ( pxListItem )->pvOwner = ( void * ) pxOwner\r
 129 \r
 130 /*\r
 131  * Access macro to set the value of the list item.  In most cases the value is\r
 132  * used to sort the list in descending order.\r
 133  *\r
 134  * \page listSET_LIST_ITEM_VALUE listSET_LIST_ITEM_VALUE\r
 135  * \ingroup LinkedList\r
 136  */\r
 137 #define listSET_LIST_ITEM_VALUE( pxListItem, xValue )           ( pxListItem )->xItemValue = xValue\r
 138 \r
 139 /*\r
 140  * Access macro the retrieve the value of the list item.  The value can\r
 141  * represent anything - for example a the priority of a task, or the time at\r
 142  * which a task should be unblocked.\r
 143  *\r
 144  * \page listGET_LIST_ITEM_VALUE listGET_LIST_ITEM_VALUE\r
 145  * \ingroup LinkedList\r
 146  */\r
 147 #define listGET_LIST_ITEM_VALUE( pxListItem )                           ( ( pxListItem )->xItemValue )\r
 148 \r
 149 /*\r
 150  * Access macro to determine if a list contains any items.  The macro will\r
 151  * only have the value true if the list is empty.\r
 152  *\r
 153  * \page listLIST_IS_EMPTY listLIST_IS_EMPTY\r
 154  * \ingroup LinkedList\r
 155  */\r
 156 #define listLIST_IS_EMPTY( pxList )                             ( ( pxList )->uxNumberOfItems == ( unsigned portBASE_TYPE ) 0 )\r
 157 \r
 158 /*\r
 159  * Access macro to return the number of items in the list.\r
 160  */\r
 161 #define listCURRENT_LIST_LENGTH( pxList )               ( ( pxList )->uxNumberOfItems )\r
 162 \r
 163 /*\r
 164  * Access function to obtain the owner of the next entry in a list.\r
 165  *\r
 166  * The list member pxIndex is used to walk through a list.  Calling\r
 167  * listGET_OWNER_OF_NEXT_ENTRY increments pxIndex to the next item in the list\r
 168  * and returns that entries pxOwner parameter.  Using multiple calls to this\r
 169  * function it is therefore possible to move through every item contained in\r
 170  * a list.\r
 171  *\r
 172  * The pxOwner parameter of a list item is a pointer to the object that owns\r
 173  * the list item.  In the scheduler this is normally a task control block.\r
 174  * The pxOwner parameter effectively creates a two way link between the list\r
 175  * item and its owner.\r
 176  *\r
 177  * @param pxList The list from which the next item owner is to be returned.\r
 178  *\r
 179  * \page listGET_OWNER_OF_NEXT_ENTRY listGET_OWNER_OF_NEXT_ENTRY\r
 180  * \ingroup LinkedList\r
 181  */\r
 182 #define listGET_OWNER_OF_NEXT_ENTRY( pxTCB, pxList )                                                                    \\r
 183 {                                                                                                                                                                               \\r
 184 xList * const pxConstList = pxList;                                                                                                             \\r
 185         /* Increment the index to the next item and return the item, ensuring */                        \\r
 186         /* we don't return the marker used at the end of the list.  */                                          \\r
 187         ( pxConstList )->pxIndex = ( pxConstList )->pxIndex->pxNext;                                            \\r
 188         if( ( pxConstList )->pxIndex == ( xListItem * ) &( ( pxConstList )->xListEnd ) )        \\r
 189         {                                                                                                                                                                       \\r
 190                 ( pxConstList )->pxIndex = ( pxConstList )->pxIndex->pxNext;                                    \\r
 191         }                                                                                                                                                                       \\r
 192         pxTCB = ( pxConstList )->pxIndex->pvOwner;                                                                                      \\r
 193 }\r
 194 \r
 195 \r
 196 /*\r
 197  * Access function to obtain the owner of the first entry in a list.  Lists\r
 198  * are normally sorted in ascending item value order.\r
 199  *\r
 200  * This function returns the pxOwner member of the first item in the list.\r
 201  * The pxOwner parameter of a list item is a pointer to the object that owns\r
 202  * the list item.  In the scheduler this is normally a task control block.\r
 203  * The pxOwner parameter effectively creates a two way link between the list\r
 204  * item and its owner.\r
 205  *\r
 206  * @param pxList The list from which the owner of the head item is to be\r
 207  * returned.\r
 208  *\r
 209  * \page listGET_OWNER_OF_HEAD_ENTRY listGET_OWNER_OF_HEAD_ENTRY\r
 210  * \ingroup LinkedList\r
 211  */\r
 212 #define listGET_OWNER_OF_HEAD_ENTRY( pxList )  ( ( pxList->uxNumberOfItems != ( unsigned portBASE_TYPE ) 0 ) ? ( (&( pxList->xListEnd ))->pxNext->pvOwner ) : ( NULL ) )\r
 213 \r
 214 /*\r
 215  * Check to see if a list item is within a list.  The list item maintains a\r
 216  * "container" pointer that points to the list it is in.  All this macro does\r
 217  * is check to see if the container and the list match.\r
 218  *\r
 219  * @param pxList The list we want to know if the list item is within.\r
 220  * @param pxListItem The list item we want to know if is in the list.\r
 221  * @return pdTRUE is the list item is in the list, otherwise pdFALSE.\r
 222  * pointer against\r
 223  */\r
 224 #define listIS_CONTAINED_WITHIN( pxList, pxListItem ) ( ( pxListItem )->pvContainer == ( void * ) pxList )\r
 225 \r
 226 /*\r
 227  * Must be called before a list is used!  This initialises all the members\r
 228  * of the list structure and inserts the xListEnd item into the list as a\r
 229  * marker to the back of the list.\r
 230  *\r
 231  * @param pxList Pointer to the list being initialised.\r
 232  *\r
 233  * \page vListInitialise vListInitialise\r
 234  * \ingroup LinkedList\r
 235  */\r
 236 void vListInitialise( xList *pxList );\r
 237 \r
 238 /*\r
 239  * Must be called before a list item is used.  This sets the list container to\r
 240  * null so the item does not think that it is already contained in a list.\r
 241  *\r
 242  * @param pxItem Pointer to the list item being initialised.\r
 243  *\r
 244  * \page vListInitialiseItem vListInitialiseItem\r
 245  * \ingroup LinkedList\r
 246  */\r
 247 void vListInitialiseItem( xListItem *pxItem );\r
 248 \r
 249 /*\r
 250  * Insert a list item into a list.  The item will be inserted into the list in\r
 251  * a position determined by its item value (descending item value order).\r
 252  *\r
 253  * @param pxList The list into which the item is to be inserted.\r
 254  *\r
 255  * @param pxNewListItem The item to that is to be placed in the list.\r
 256  *\r
 257  * \page vListInsert vListInsert\r
 258  * \ingroup LinkedList\r
 259  */\r
 260 void vListInsert( xList *pxList, xListItem *pxNewListItem );\r
 261 \r
 262 /*\r
 263  * Insert a list item into a list.  The item will be inserted in a position\r
 264  * such that it will be the last item within the list returned by multiple\r
 265  * calls to listGET_OWNER_OF_NEXT_ENTRY.\r
 266  *\r
 267  * The list member pvIndex is used to walk through a list.  Calling\r
 268  * listGET_OWNER_OF_NEXT_ENTRY increments pvIndex to the next item in the list.\r
 269  * Placing an item in a list using vListInsertEnd effectively places the item\r
 270  * in the list position pointed to by pvIndex.  This means that every other\r
 271  * item within the list will be returned by listGET_OWNER_OF_NEXT_ENTRY before\r
 272  * the pvIndex parameter again points to the item being inserted.\r
 273  *\r
 274  * @param pxList The list into which the item is to be inserted.\r
 275  *\r
 276  * @param pxNewListItem The list item to be inserted into the list.\r
 277  *\r
 278  * \page vListInsertEnd vListInsertEnd\r
 279  * \ingroup LinkedList\r
 280  */\r
 281 void vListInsertEnd( xList *pxList, xListItem *pxNewListItem );\r
 282 \r
 283 /*\r
 284  * Remove an item from a list.  The list item has a pointer to the list that\r
 285  * it is in, so only the list item need be passed into the function.\r
 286  *\r
 287  * @param vListRemove The item to be removed.  The item will remove itself from\r
 288  * the list pointed to by it's pxContainer parameter.\r
 289  *\r
 290  * \page vListRemove vListRemove\r
 291  * \ingroup LinkedList\r
 292  */\r
 293 void vListRemove( xListItem *pxItemToRemove );\r
 294 \r
 295 #ifdef __cplusplus\r
 296 }\r
 297 #endif\r
 298 \r
 299 #endif\r
 300 \r