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

   1 /*\r
   2         FreeRTOS.org V5.2.0 - Copyright (C) 2003-2009 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 it \r
   7         under the terms of the GNU General Public License (version 2) as published\r
   8         by the Free Software Foundation and modified by the FreeRTOS exception.\r
   9 \r
  10         FreeRTOS.org is distributed in the hope that it will be useful, but WITHOUT\r
  11         ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or \r
  12         FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for \r
  13         more details.\r
  14 \r
  15         You should have received a copy of the GNU General Public License along \r
  16         with FreeRTOS.org; if not, write to the Free Software Foundation, Inc., 59 \r
  17         Temple Place, Suite 330, Boston, MA  02111-1307  USA.\r
  18 \r
  19         A special exception to the GPL is included to allow you to distribute a \r
  20         combined work that includes FreeRTOS.org without being obliged to provide\r
  21         the source code for any proprietary components.  See the licensing section\r
  22         of http://www.FreeRTOS.org for full details.\r
  23 \r
  24 \r
  25         ***************************************************************************\r
  26         *                                                                         *\r
  27         * Get the FreeRTOS eBook!  See http://www.FreeRTOS.org/Documentation      *\r
  28         *                                                                         *\r
  29         * This is a concise, step by step, 'hands on' guide that describes both   *\r
  30         * general multitasking concepts and FreeRTOS specifics. It presents and   *\r
  31         * explains numerous examples that are written using the FreeRTOS API.     *\r
  32         * Full source code for all the examples is provided in an accompanying    *\r
  33         * .zip file.                                                              *\r
  34         *                                                                         *\r
  35         ***************************************************************************\r
  36 \r
  37         1 tab == 4 spaces!\r
  38 \r
  39         Please ensure to read the configuration and relevant port sections of the\r
  40         online documentation.\r
  41 \r
  42         http://www.FreeRTOS.org - Documentation, latest information, license and\r
  43         contact details.\r
  44 \r
  45         http://www.SafeRTOS.com - A version that is certified for use in safety\r
  46         critical systems.\r
  47 \r
  48         http://www.OpenRTOS.com - Commercial support, development, porting,\r
  49         licensing and training services.\r
  50 */\r
  51 \r
  52 \r
  53 #include <stdlib.h>\r
  54 #include "FreeRTOS.h"\r
  55 #include "list.h"\r
  56 \r
  57 /*-----------------------------------------------------------\r
  58  * PUBLIC LIST API documented in list.h\r
  59  *----------------------------------------------------------*/\r
  60 \r
  61 void vListInitialise( xList *pxList )\r
  62 {\r
  63         /* The list structure contains a list item which is used to mark the\r
  64         end of the list.  To initialise the list the list end is inserted\r
  65         as the only list entry. */\r
  66         pxList->pxIndex = ( xListItem * ) &( pxList->xListEnd );\r
  67 \r
  68         /* The list end value is the highest possible value in the list to\r
  69         ensure it remains at the end of the list. */\r
  70         pxList->xListEnd.xItemValue = portMAX_DELAY;\r
  71 \r
  72         /* The list end next and previous pointers point to itself so we know\r
  73         when the list is empty. */\r
  74         pxList->xListEnd.pxNext = ( xListItem * ) &( pxList->xListEnd );\r
  75         pxList->xListEnd.pxPrevious = ( xListItem * ) &( pxList->xListEnd );\r
  76 \r
  77         pxList->uxNumberOfItems = 0;\r
  78 }\r
  79 /*-----------------------------------------------------------*/\r
  80 \r
  81 void vListInitialiseItem( xListItem *pxItem )\r
  82 {\r
  83         /* Make sure the list item is not recorded as being on a list. */\r
  84         pxItem->pvContainer = NULL;\r
  85 }\r
  86 /*-----------------------------------------------------------*/\r
  87 \r
  88 void vListInsertEnd( xList *pxList, xListItem *pxNewListItem )\r
  89 {\r
  90 volatile xListItem * pxIndex;\r
  91 \r
  92         /* Insert a new list item into pxList, but rather than sort the list,\r
  93         makes the new list item the last item to be removed by a call to\r
  94         pvListGetOwnerOfNextEntry.  This means it has to be the item pointed to by\r
  95         the pxIndex member. */\r
  96         pxIndex = pxList->pxIndex;\r
  97 \r
  98         pxNewListItem->pxNext = pxIndex->pxNext;\r
  99         pxNewListItem->pxPrevious = pxList->pxIndex;\r
 100         pxIndex->pxNext->pxPrevious = ( volatile xListItem * ) pxNewListItem;\r
 101         pxIndex->pxNext = ( volatile xListItem * ) pxNewListItem;\r
 102         pxList->pxIndex = ( volatile xListItem * ) pxNewListItem;\r
 103 \r
 104         /* Remember which list the item is in. */\r
 105         pxNewListItem->pvContainer = ( void * ) pxList;\r
 106 \r
 107         ( pxList->uxNumberOfItems )++;\r
 108 }\r
 109 /*-----------------------------------------------------------*/\r
 110 \r
 111 void vListInsert( xList *pxList, xListItem *pxNewListItem )\r
 112 {\r
 113 volatile xListItem *pxIterator;\r
 114 portTickType xValueOfInsertion;\r
 115 \r
 116         /* Insert the new list item into the list, sorted in ulListItem order. */\r
 117         xValueOfInsertion = pxNewListItem->xItemValue;\r
 118 \r
 119         /* If the list already contains a list item with the same item value then\r
 120         the new list item should be placed after it.  This ensures that TCB's which\r
 121         are stored in ready lists (all of which have the same ulListItem value)\r
 122         get an equal share of the CPU.  However, if the xItemValue is the same as \r
 123         the back marker the iteration loop below will not end.  This means we need\r
 124         to guard against this by checking the value first and modifying the \r
 125         algorithm slightly if necessary. */\r
 126         if( xValueOfInsertion == portMAX_DELAY )\r
 127         {\r
 128                 pxIterator = pxList->xListEnd.pxPrevious;\r
 129         }\r
 130         else\r
 131         {\r
 132                 for( pxIterator = ( xListItem * ) &( pxList->xListEnd ); pxIterator->pxNext->xItemValue <= xValueOfInsertion; pxIterator = pxIterator->pxNext )\r
 133                 {\r
 134                         /* There is nothing to do here, we are just iterating to the\r
 135                         wanted insertion position. */\r
 136                 }\r
 137         }\r
 138 \r
 139         pxNewListItem->pxNext = pxIterator->pxNext;\r
 140         pxNewListItem->pxNext->pxPrevious = ( volatile xListItem * ) pxNewListItem;\r
 141         pxNewListItem->pxPrevious = pxIterator;\r
 142         pxIterator->pxNext = ( volatile xListItem * ) pxNewListItem;\r
 143 \r
 144         /* Remember which list the item is in.  This allows fast removal of the\r
 145         item later. */\r
 146         pxNewListItem->pvContainer = ( void * ) pxList;\r
 147 \r
 148         ( pxList->uxNumberOfItems )++;\r
 149 }\r
 150 /*-----------------------------------------------------------*/\r
 151 \r
 152 void vListRemove( xListItem *pxItemToRemove )\r
 153 {\r
 154 xList * pxList;\r
 155 \r
 156         pxItemToRemove->pxNext->pxPrevious = pxItemToRemove->pxPrevious;\r
 157         pxItemToRemove->pxPrevious->pxNext = pxItemToRemove->pxNext;\r
 158         \r
 159         /* The list item knows which list it is in.  Obtain the list from the list\r
 160         item. */\r
 161         pxList = ( xList * ) pxItemToRemove->pvContainer;\r
 162 \r
 163         /* Make sure the index is left pointing to a valid item. */\r
 164         if( pxList->pxIndex == pxItemToRemove )\r
 165         {\r
 166                 pxList->pxIndex = pxItemToRemove->pxPrevious;\r
 167         }\r
 168 \r
 169         pxItemToRemove->pvContainer = NULL;\r
 170         ( pxList->uxNumberOfItems )--;\r
 171 }\r
 172 /*-----------------------------------------------------------*/\r
 173 \r