git.sur5r.net Git - freertos/blob - Source/list.c

   1 /*\r
   2         FreeRTOS.org V4.7.2 - 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         Please ensure to read the configuration and relevant port sections of the \r
  29         online documentation.\r
  30 \r
  31         +++ http://www.FreeRTOS.org +++\r
  32         Documentation, latest information, license and contact details.  \r
  33 \r
  34         +++ http://www.SafeRTOS.com +++\r
  35         A version that is certified for use in safety critical systems.\r
  36 \r
  37         +++ http://www.OpenRTOS.com +++\r
  38         Commercial support, development, porting, licensing and training services.\r
  39 \r
  40         ***************************************************************************\r
  41 */\r
  42 \r
  43 /*\r
  44 Changes from V1.2.0\r
  45 \r
  46         + Removed the volatile modifier from the function parameters.  This was\r
  47           only ever included to prevent compiler warnings.  Now warnings are\r
  48           removed by casting parameters where the calls are made.\r
  49 \r
  50         + prvListGetOwnerOfNextEntry() and prvListGetOwnerOfHeadEntry() have been\r
  51           removed from the c file and added as macros to the h file.\r
  52 \r
  53         + uxNumberOfItems has been added to the list structure.  This removes the\r
  54           need for a pointer comparison when checking if a list is empty, and so\r
  55           is slightly faster.\r
  56 \r
  57         + Removed the NULL check in vListRemove().  This makes the call faster but\r
  58           necessitates any application code utilising the list implementation to\r
  59           ensure NULL pointers are not passed.\r
  60 \r
  61 Changes from V2.0.0\r
  62 \r
  63         + Double linked the lists to allow faster removal item removal.\r
  64 \r
  65 Changes from V2.6.1\r
  66 \r
  67         + Make use of the new portBASE_TYPE definition where ever appropriate.\r
  68 \r
  69 Changes from V3.0.0\r
  70 \r
  71         + API changes as described on the FreeRTOS.org WEB site.\r
  72 \r
  73 Changes from V3.2.4\r
  74 \r
  75         + Removed the pxHead member of the xList structure.  This always pointed\r
  76           to the same place so has been removed to free a few bytes of RAM.\r
  77 \r
  78         + Introduced the xMiniListItem structure that does not include the \r
  79           xListItem members that are not required by the xListEnd member of a list.\r
  80           Again this was done to reduce RAM usage.\r
  81 \r
  82         + Changed the volatile definitions of some structure members to clean up\r
  83           the code where the list structures are used.\r
  84 \r
  85 Changes from V4.0.4\r
  86 \r
  87         + Optimised vListInsert() in the case when the wake time is the maximum \r
  88           tick count value.\r
  89 */\r
  90 \r
  91 #include <stdlib.h>\r
  92 #include "FreeRTOS.h"\r
  93 #include "list.h"\r
  94 \r
  95 /*-----------------------------------------------------------\r
  96  * PUBLIC LIST API documented in list.h\r
  97  *----------------------------------------------------------*/\r
  98 \r
  99 void vListInitialise( xList *pxList )\r
 100 {\r
 101         /* The list structure contains a list item which is used to mark the\r
 102         end of the list.  To initialise the list the list end is inserted\r
 103         as the only list entry. */\r
 104         pxList->pxIndex = ( xListItem * ) &( pxList->xListEnd );\r
 105 \r
 106         /* The list end value is the highest possible value in the list to\r
 107         ensure it remains at the end of the list. */\r
 108         pxList->xListEnd.xItemValue = portMAX_DELAY;\r
 109 \r
 110         /* The list end next and previous pointers point to itself so we know\r
 111         when the list is empty. */\r
 112         pxList->xListEnd.pxNext = ( xListItem * ) &( pxList->xListEnd );\r
 113         pxList->xListEnd.pxPrevious = ( xListItem * ) &( pxList->xListEnd );\r
 114 \r
 115         pxList->uxNumberOfItems = 0;\r
 116 }\r
 117 /*-----------------------------------------------------------*/\r
 118 \r
 119 void vListInitialiseItem( xListItem *pxItem )\r
 120 {\r
 121         /* Make sure the list item is not recorded as being on a list. */\r
 122         pxItem->pvContainer = NULL;\r
 123 }\r
 124 /*-----------------------------------------------------------*/\r
 125 \r
 126 void vListInsertEnd( xList *pxList, xListItem *pxNewListItem )\r
 127 {\r
 128 volatile xListItem * pxIndex;\r
 129 \r
 130         /* Insert a new list item into pxList, but rather than sort the list,\r
 131         makes the new list item the last item to be removed by a call to\r
 132         pvListGetOwnerOfNextEntry.  This means it has to be the item pointed to by\r
 133         the pxIndex member. */\r
 134         pxIndex = pxList->pxIndex;\r
 135 \r
 136         pxNewListItem->pxNext = pxIndex->pxNext;\r
 137         pxNewListItem->pxPrevious = pxList->pxIndex;\r
 138         pxIndex->pxNext->pxPrevious = ( volatile xListItem * ) pxNewListItem;\r
 139         pxIndex->pxNext = ( volatile xListItem * ) pxNewListItem;\r
 140         pxList->pxIndex = ( volatile xListItem * ) pxNewListItem;\r
 141 \r
 142         /* Remember which list the item is in. */\r
 143         pxNewListItem->pvContainer = ( void * ) pxList;\r
 144 \r
 145         ( pxList->uxNumberOfItems )++;\r
 146 }\r
 147 /*-----------------------------------------------------------*/\r
 148 \r
 149 void vListInsert( xList *pxList, xListItem *pxNewListItem )\r
 150 {\r
 151 volatile xListItem *pxIterator;\r
 152 portTickType xValueOfInsertion;\r
 153 \r
 154         /* Insert the new list item into the list, sorted in ulListItem order. */\r
 155         xValueOfInsertion = pxNewListItem->xItemValue;\r
 156 \r
 157         /* If the list already contains a list item with the same item value then\r
 158         the new list item should be placed after it.  This ensures that TCB's which\r
 159         are stored in ready lists (all of which have the same ulListItem value)\r
 160         get an equal share of the CPU.  However, if the xItemValue is the same as \r
 161         the back marker the iteration loop below will not end.  This means we need\r
 162         to guard against this by checking the value first and modifying the \r
 163         algorithm slightly if necessary. */\r
 164         if( xValueOfInsertion == portMAX_DELAY )\r
 165         {\r
 166                 pxIterator = pxList->xListEnd.pxPrevious;\r
 167         }\r
 168         else\r
 169         {\r
 170                 for( pxIterator = ( xListItem * ) &( pxList->xListEnd ); pxIterator->pxNext->xItemValue <= xValueOfInsertion; pxIterator = pxIterator->pxNext )\r
 171                 {\r
 172                         /* There is nothing to do here, we are just iterating to the\r
 173                         wanted insertion position. */\r
 174                 }\r
 175         }\r
 176 \r
 177         pxNewListItem->pxNext = pxIterator->pxNext;\r
 178         pxNewListItem->pxNext->pxPrevious = ( volatile xListItem * ) pxNewListItem;\r
 179         pxNewListItem->pxPrevious = pxIterator;\r
 180         pxIterator->pxNext = ( volatile xListItem * ) pxNewListItem;\r
 181 \r
 182         /* Remember which list the item is in.  This allows fast removal of the\r
 183         item later. */\r
 184         pxNewListItem->pvContainer = ( void * ) pxList;\r
 185 \r
 186         ( pxList->uxNumberOfItems )++;\r
 187 }\r
 188 /*-----------------------------------------------------------*/\r
 189 \r
 190 void vListRemove( xListItem *pxItemToRemove )\r
 191 {\r
 192 xList * pxList;\r
 193 \r
 194         pxItemToRemove->pxNext->pxPrevious = pxItemToRemove->pxPrevious;\r
 195         pxItemToRemove->pxPrevious->pxNext = pxItemToRemove->pxNext;\r
 196         \r
 197         /* The list item knows which list it is in.  Obtain the list from the list\r
 198         item. */\r
 199         pxList = ( xList * ) pxItemToRemove->pvContainer;\r
 200 \r
 201         /* Make sure the index is left pointing to a valid item. */\r
 202         if( pxList->pxIndex == pxItemToRemove )\r
 203         {\r
 204                 pxList->pxIndex = pxItemToRemove->pxPrevious;\r
 205         }\r
 206 \r
 207         pxItemToRemove->pvContainer = NULL;\r
 208         ( pxList->uxNumberOfItems )--;\r
 209 }\r
 210 /*-----------------------------------------------------------*/\r
 211 \r