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

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