summaryrefslogtreecommitdiff
path: root/openpicc/os/core/list.c
blob: e6db76a3f80e11d30f95f0bc1e5ea36263bdbb74 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
/*
	FreeRTOS.org V4.2.1 - Copyright (C) 2003-2007 Richard Barry.

	This file is part of the FreeRTOS.org distribution.

	FreeRTOS.org is free software; you can redistribute it and/or modify
	it under the terms of the GNU General Public License as published by
	the Free Software Foundation; either version 2 of the License, or
	(at your option) any later version.

	FreeRTOS.org is distributed in the hope that it will be useful,
	but WITHOUT ANY WARRANTY; without even the implied warranty of
	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
	GNU General Public License for more details.

	You should have received a copy of the GNU General Public License
	along with FreeRTOS.org; if not, write to the Free Software
	Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

	A special exception to the GPL can be applied should you wish to distribute
	a combined work that includes FreeRTOS.org, without being obliged to provide
	the source code for any proprietary components.  See the licensing section
	of http://www.FreeRTOS.org for full details of how and when the exception
	can be applied.

	***************************************************************************
	See http://www.FreeRTOS.org for documentation, latest information, license
	and contact details.  Please ensure to read the configuration and relevant
	port sections of the online documentation.

	Also see http://www.SafeRTOS.com for an IEC 61508 compliant version along
	with commercial development and support options.
	***************************************************************************
*/

/*
Changes from V1.2.0

	+ Removed the volatile modifier from the function parameters.  This was
	  only ever included to prevent compiler warnings.  Now warnings are
	  removed by casting parameters where the calls are made.

	+ prvListGetOwnerOfNextEntry() and prvListGetOwnerOfHeadEntry() have been
	  removed from the c file and added as macros to the h file.

	+ uxNumberOfItems has been added to the list structure.  This removes the
	  need for a pointer comparison when checking if a list is empty, and so
	  is slightly faster.

	+ Removed the NULL check in vListRemove().  This makes the call faster but
	  necessitates any application code utilising the list implementation to
	  ensure NULL pointers are not passed.

Changes from V2.0.0

	+ Double linked the lists to allow faster removal item removal.

Changes from V2.6.1

	+ Make use of the new portBASE_TYPE definition where ever appropriate.

Changes from V3.0.0

	+ API changes as described on the FreeRTOS.org WEB site.

Changes from V3.2.4

	+ Removed the pxHead member of the xList structure.  This always pointed
	  to the same place so has been removed to free a few bytes of RAM.

	+ Introduced the xMiniListItem structure that does not include the 
	  xListItem members that are not required by the xListEnd member of a list.
	  Again this was done to reduce RAM usage.

	+ Changed the volatile definitions of some structure members to clean up
	  the code where the list structures are used.

Changes from V4.0.4

	+ Optimised vListInsert() in the case when the wake time is the maximum 
	  tick count value.
*/

#include <stdlib.h>
#include "FreeRTOS.h"
#include "list.h"

/*-----------------------------------------------------------
 * PUBLIC LIST API documented in list.h
 *----------------------------------------------------------*/

void
vListInitialise (xList * pxList)
{
  /* The list structure contains a list item which is used to mark the
     end of the list.  To initialise the list the list end is inserted
     as the only list entry. */
  pxList->pxIndex = (xListItem *) & (pxList->xListEnd);

  /* The list end value is the highest possible value in the list to
     ensure it remains at the end of the list. */
  pxList->xListEnd.xItemValue = portMAX_DELAY;

  /* The list end next and previous pointers point to itself so we know
     when the list is empty. */
  pxList->xListEnd.pxNext = (xListItem *) & (pxList->xListEnd);
  pxList->xListEnd.pxPrevious = (xListItem *) & (pxList->xListEnd);

  pxList->uxNumberOfItems = 0;
}

/*-----------------------------------------------------------*/

void
vListInitialiseItem (xListItem * pxItem)
{
  /* Make sure the list item is not recorded as being on a list. */
  pxItem->pvContainer = NULL;
}

/*-----------------------------------------------------------*/

void
vListInsertEnd (xList * pxList, xListItem * pxNewListItem)
{
  volatile xListItem *pxIndex;

  /* Insert a new list item into pxList, but rather than sort the list,
     makes the new list item the last item to be removed by a call to
     pvListGetOwnerOfNextEntry.  This means it has to be the item pointed to by
     the pxIndex member. */
  pxIndex = pxList->pxIndex;

  pxNewListItem->pxNext = pxIndex->pxNext;
  pxNewListItem->pxPrevious = pxList->pxIndex;
  pxIndex->pxNext->pxPrevious = (volatile xListItem *) pxNewListItem;
  pxIndex->pxNext = (volatile xListItem *) pxNewListItem;
  pxList->pxIndex = (volatile xListItem *) pxNewListItem;

  /* Remember which list the item is in. */
  pxNewListItem->pvContainer = (void *) pxList;

  (pxList->uxNumberOfItems)++;
}

/*-----------------------------------------------------------*/

void
vListInsert (xList * pxList, xListItem * pxNewListItem)
{
  volatile xListItem *pxIterator;
  portTickType xValueOfInsertion;

  /* Insert the new list item into the list, sorted in ulListItem order. */
  xValueOfInsertion = pxNewListItem->xItemValue;

  /* If the list already contains a list item with the same item value then
     the new list item should be placed after it.  This ensures that TCB's which
     are stored in ready lists (all of which have the same ulListItem value)
     get an equal share of the CPU.  However, if the xItemValue is the same as 
     the back marker the iteration loop below will not end.  This means we need
     to guard against this by checking the value first and modifying the 
     algorithm slightly if necessary. */
  if (xValueOfInsertion == portMAX_DELAY)
    {
      pxIterator = pxList->xListEnd.pxPrevious;
    }
  else
    {
      for (pxIterator = (xListItem *) & (pxList->xListEnd);
	   pxIterator->pxNext->xItemValue <= xValueOfInsertion;
	   pxIterator = pxIterator->pxNext)
	{
	  /* There is nothing to do here, we are just iterating to the
	     wanted insertion position. */
	}
    }

  pxNewListItem->pxNext = pxIterator->pxNext;
  pxNewListItem->pxNext->pxPrevious = (volatile xListItem *) pxNewListItem;
  pxNewListItem->pxPrevious = pxIterator;
  pxIterator->pxNext = (volatile xListItem *) pxNewListItem;

  /* Remember which list the item is in.  This allows fast removal of the
     item later. */
  pxNewListItem->pvContainer = (void *) pxList;

  (pxList->uxNumberOfItems)++;
}

/*-----------------------------------------------------------*/

void
vListRemove (xListItem * pxItemToRemove)
{
  xList *pxList;

  pxItemToRemove->pxNext->pxPrevious = pxItemToRemove->pxPrevious;
  pxItemToRemove->pxPrevious->pxNext = pxItemToRemove->pxNext;

  /* The list item knows which list it is in.  Obtain the list from the list
     item. */
  pxList = (xList *) pxItemToRemove->pvContainer;

  /* Make sure the index is left pointing to a valid item. */
  if (pxList->pxIndex == pxItemToRemove)
    {
      pxList->pxIndex = pxItemToRemove->pxPrevious;
    }

  pxItemToRemove->pvContainer = NULL;
  (pxList->uxNumberOfItems)--;
}

/*-----------------------------------------------------------*/
personal git repositories of Harald Welte. Your mileage may vary