]>
git.saurik.com Git - apple/xnu.git/blob - bsd/sys/queue.h
04e65005b696c377391a4c735235cb898a82fde8
2 * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
4 * @APPLE_LICENSE_HEADER_START@
6 * This file contains Original Code and/or Modifications of Original Code
7 * as defined in and that are subject to the Apple Public Source License
8 * Version 2.0 (the 'License'). You may not use this file except in
9 * compliance with the License. Please obtain a copy of the License at
10 * http://www.opensource.apple.com/apsl/ and read it before using this
13 * The Original Code and all software distributed under the License are
14 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
15 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
16 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
18 * Please see the License for the specific language governing rights and
19 * limitations under the License.
21 * @APPLE_LICENSE_HEADER_END@
24 * Copyright (c) 1991, 1993
25 * The Regents of the University of California. All rights reserved.
27 * Redistribution and use in source and binary forms, with or without
28 * modification, are permitted provided that the following conditions
30 * 1. Redistributions of source code must retain the above copyright
31 * notice, this list of conditions and the following disclaimer.
32 * 2. Redistributions in binary form must reproduce the above copyright
33 * notice, this list of conditions and the following disclaimer in the
34 * documentation and/or other materials provided with the distribution.
35 * 3. All advertising materials mentioning features or use of this software
36 * must display the following acknowledgement:
37 * This product includes software developed by the University of
38 * California, Berkeley and its contributors.
39 * 4. Neither the name of the University nor the names of its contributors
40 * may be used to endorse or promote products derived from this software
41 * without specific prior written permission.
43 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
44 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
45 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
46 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
47 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
48 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
49 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
50 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
51 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
52 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
55 * @(#)queue.h 8.5 (Berkeley) 8/20/94
62 * This file defines five types of data structures: singly-linked lists,
63 * slingly-linked tail queues, lists, tail queues, and circular queues.
65 * A singly-linked list is headed by a single forward pointer. The elements
66 * are singly linked for minimum space and pointer manipulation overhead at
67 * the expense of O(n) removal for arbitrary elements. New elements can be
68 * added to the list after an existing element or at the head of the list.
69 * Elements being removed from the head of the list should use the explicit
70 * macro for this purpose for optimum efficiency. A singly-linked list may
71 * only be traversed in the forward direction. Singly-linked lists are ideal
72 * for applications with large datasets and few or no removals or for
73 * implementing a LIFO queue.
75 * A singly-linked tail queue is headed by a pair of pointers, one to the
76 * head of the list and the other to the tail of the list. The elements are
77 * singly linked for minimum space and pointer manipulation overhead at the
78 * expense of O(n) removal for arbitrary elements. New elements can be added
79 * to the list after an existing element, at the head of the list, or at the
80 * end of the list. Elements being removed from the head of the tail queue
81 * should use the explicit macro for this purpose for optimum efficiency.
82 * A singly-linked tail queue may only be traversed in the forward direction.
83 * Singly-linked tail queues are ideal for applications with large datasets
84 * and few or no removals or for implementing a FIFO queue.
86 * A list is headed by a single forward pointer (or an array of forward
87 * pointers for a hash table header). The elements are doubly linked
88 * so that an arbitrary element can be removed without a need to
89 * traverse the list. New elements can be added to the list before
90 * or after an existing element or at the head of the list. A list
91 * may only be traversed in the forward direction.
93 * A tail queue is headed by a pair of pointers, one to the head of the
94 * list and the other to the tail of the list. The elements are doubly
95 * linked so that an arbitrary element can be removed without a need to
96 * traverse the list. New elements can be added to the list before or
97 * after an existing element, at the head of the list, or at the end of
98 * the list. A tail queue may only be traversed in the forward direction.
100 * A circle queue is headed by a pair of pointers, one to the head of the
101 * list and the other to the tail of the list. The elements are doubly
102 * linked so that an arbitrary element can be removed without a need to
103 * traverse the list. New elements can be added to the list before or after
104 * an existing element, at the head of the list, or at the end of the list.
105 * A circle queue may be traversed in either direction, but has a more
106 * complex end of list detection.
108 * For details on the use of these macros, see the queue(3) manual page.
111 * SLIST LIST STAILQ TAILQ CIRCLEQ
121 * _INSERT_HEAD + + + + +
122 * _INSERT_BEFORE - + - + +
123 * _INSERT_AFTER + + + + +
124 * _INSERT_TAIL - - + + +
125 * _REMOVE_HEAD + - + - -
131 * Singly-linked List definitions.
133 #define SLIST_HEAD(name, type) \
135 struct type *slh_first; /* first element */ \
138 #define SLIST_ENTRY(type) \
140 struct type *sle_next; /* next element */ \
144 * Singly-linked List functions.
146 #define SLIST_EMPTY(head) ((head)->slh_first == NULL)
148 #define SLIST_FIRST(head) ((head)->slh_first)
150 #define SLIST_FOREACH(var, head, field) \
151 for((var) = (head)->slh_first; (var); (var) = (var)->field.sle_next)
153 #define SLIST_INIT(head) { \
154 (head)->slh_first = NULL; \
157 #define SLIST_INSERT_AFTER(slistelm, elm, field) do { \
158 (elm)->field.sle_next = (slistelm)->field.sle_next; \
159 (slistelm)->field.sle_next = (elm); \
162 #define SLIST_INSERT_HEAD(head, elm, field) do { \
163 (elm)->field.sle_next = (head)->slh_first; \
164 (head)->slh_first = (elm); \
167 #define SLIST_NEXT(elm, field) ((elm)->field.sle_next)
169 #define SLIST_REMOVE_HEAD(head, field) do { \
170 (head)->slh_first = (head)->slh_first->field.sle_next; \
173 #define SLIST_REMOVE(head, elm, type, field) do { \
174 if ((head)->slh_first == (elm)) { \
175 SLIST_REMOVE_HEAD((head), field); \
178 struct type *curelm = (head)->slh_first; \
179 while( curelm->field.sle_next != (elm) ) \
180 curelm = curelm->field.sle_next; \
181 curelm->field.sle_next = \
182 curelm->field.sle_next->field.sle_next; \
187 * Singly-linked Tail queue definitions.
189 #define STAILQ_HEAD(name, type) \
191 struct type *stqh_first;/* first element */ \
192 struct type **stqh_last;/* addr of last next element */ \
195 #define STAILQ_HEAD_INITIALIZER(head) \
196 { NULL, &(head).stqh_first }
198 #define STAILQ_ENTRY(type) \
200 struct type *stqe_next; /* next element */ \
204 * Singly-linked Tail queue functions.
206 #define STAILQ_EMPTY(head) ((head)->stqh_first == NULL)
208 #define STAILQ_INIT(head) do { \
209 (head)->stqh_first = NULL; \
210 (head)->stqh_last = &(head)->stqh_first; \
213 #define STAILQ_FIRST(head) ((head)->stqh_first)
214 #define STAILQ_LAST(head) (*(head)->stqh_last)
216 #define STAILQ_INSERT_HEAD(head, elm, field) do { \
217 if (((elm)->field.stqe_next = (head)->stqh_first) == NULL) \
218 (head)->stqh_last = &(elm)->field.stqe_next; \
219 (head)->stqh_first = (elm); \
222 #define STAILQ_INSERT_TAIL(head, elm, field) do { \
223 (elm)->field.stqe_next = NULL; \
224 *(head)->stqh_last = (elm); \
225 (head)->stqh_last = &(elm)->field.stqe_next; \
228 #define STAILQ_INSERT_AFTER(head, tqelm, elm, field) do { \
229 if (((elm)->field.stqe_next = (tqelm)->field.stqe_next) == NULL)\
230 (head)->stqh_last = &(elm)->field.stqe_next; \
231 (tqelm)->field.stqe_next = (elm); \
234 #define STAILQ_NEXT(elm, field) ((elm)->field.stqe_next)
236 #define STAILQ_REMOVE_HEAD(head, field) do { \
237 if (((head)->stqh_first = \
238 (head)->stqh_first->field.stqe_next) == NULL) \
239 (head)->stqh_last = &(head)->stqh_first; \
242 #define STAILQ_REMOVE_HEAD_UNTIL(head, elm, field) do { \
243 if (((head)->stqh_first = (elm)->field.stqe_next) == NULL) \
244 (head)->stqh_last = &(head)->stqh_first; \
248 #define STAILQ_REMOVE(head, elm, type, field) do { \
249 if ((head)->stqh_first == (elm)) { \
250 STAILQ_REMOVE_HEAD(head, field); \
253 struct type *curelm = (head)->stqh_first; \
254 while( curelm->field.stqe_next != (elm) ) \
255 curelm = curelm->field.stqe_next; \
256 if((curelm->field.stqe_next = \
257 curelm->field.stqe_next->field.stqe_next) == NULL) \
258 (head)->stqh_last = &(curelm)->field.stqe_next; \
265 #define LIST_HEAD(name, type) \
267 struct type *lh_first; /* first element */ \
270 #define LIST_HEAD_INITIALIZER(head) \
273 #define LIST_ENTRY(type) \
275 struct type *le_next; /* next element */ \
276 struct type **le_prev; /* address of previous next element */ \
283 #define LIST_EMPTY(head) ((head)->lh_first == NULL)
285 #define LIST_FIRST(head) ((head)->lh_first)
287 #define LIST_FOREACH(var, head, field) \
288 for((var) = (head)->lh_first; (var); (var) = (var)->field.le_next)
290 #define LIST_INIT(head) do { \
291 (head)->lh_first = NULL; \
294 #define LIST_INSERT_AFTER(listelm, elm, field) do { \
295 if (((elm)->field.le_next = (listelm)->field.le_next) != NULL) \
296 (listelm)->field.le_next->field.le_prev = \
297 &(elm)->field.le_next; \
298 (listelm)->field.le_next = (elm); \
299 (elm)->field.le_prev = &(listelm)->field.le_next; \
302 #define LIST_INSERT_BEFORE(listelm, elm, field) do { \
303 (elm)->field.le_prev = (listelm)->field.le_prev; \
304 (elm)->field.le_next = (listelm); \
305 *(listelm)->field.le_prev = (elm); \
306 (listelm)->field.le_prev = &(elm)->field.le_next; \
309 #define LIST_INSERT_HEAD(head, elm, field) do { \
310 if (((elm)->field.le_next = (head)->lh_first) != NULL) \
311 (head)->lh_first->field.le_prev = &(elm)->field.le_next;\
312 (head)->lh_first = (elm); \
313 (elm)->field.le_prev = &(head)->lh_first; \
316 #define LIST_NEXT(elm, field) ((elm)->field.le_next)
318 #define LIST_REMOVE(elm, field) do { \
319 if ((elm)->field.le_next != NULL) \
320 (elm)->field.le_next->field.le_prev = \
321 (elm)->field.le_prev; \
322 *(elm)->field.le_prev = (elm)->field.le_next; \
326 * Tail queue definitions.
328 #define TAILQ_HEAD(name, type) \
330 struct type *tqh_first; /* first element */ \
331 struct type **tqh_last; /* addr of last next element */ \
334 #define TAILQ_HEAD_INITIALIZER(head) \
335 { NULL, &(head).tqh_first }
337 #define TAILQ_ENTRY(type) \
339 struct type *tqe_next; /* next element */ \
340 struct type **tqe_prev; /* address of previous next element */ \
344 * Tail queue functions.
346 #define TAILQ_EMPTY(head) ((head)->tqh_first == NULL)
348 #define TAILQ_FOREACH(var, head, field) \
349 for (var = TAILQ_FIRST(head); var; var = TAILQ_NEXT(var, field))
351 #define TAILQ_FOREACH_REVERSE(var, head, field, headname) \
352 for (var = TAILQ_LAST(head, headname); \
353 var; var = TAILQ_PREV(var, headname, field))
355 #define TAILQ_FIRST(head) ((head)->tqh_first)
357 #define TAILQ_LAST(head, headname) \
358 (*(((struct headname *)((head)->tqh_last))->tqh_last))
360 #define TAILQ_NEXT(elm, field) ((elm)->field.tqe_next)
362 #define TAILQ_PREV(elm, headname, field) \
363 (*(((struct headname *)((elm)->field.tqe_prev))->tqh_last))
365 #define TAILQ_INIT(head) do { \
366 (head)->tqh_first = NULL; \
367 (head)->tqh_last = &(head)->tqh_first; \
370 #define TAILQ_INSERT_HEAD(head, elm, field) do { \
371 if (((elm)->field.tqe_next = (head)->tqh_first) != NULL) \
372 (head)->tqh_first->field.tqe_prev = \
373 &(elm)->field.tqe_next; \
375 (head)->tqh_last = &(elm)->field.tqe_next; \
376 (head)->tqh_first = (elm); \
377 (elm)->field.tqe_prev = &(head)->tqh_first; \
380 #define TAILQ_INSERT_TAIL(head, elm, field) do { \
381 (elm)->field.tqe_next = NULL; \
382 (elm)->field.tqe_prev = (head)->tqh_last; \
383 *(head)->tqh_last = (elm); \
384 (head)->tqh_last = &(elm)->field.tqe_next; \
387 #define TAILQ_INSERT_AFTER(head, listelm, elm, field) do { \
388 if (((elm)->field.tqe_next = (listelm)->field.tqe_next) != NULL)\
389 (elm)->field.tqe_next->field.tqe_prev = \
390 &(elm)->field.tqe_next; \
392 (head)->tqh_last = &(elm)->field.tqe_next; \
393 (listelm)->field.tqe_next = (elm); \
394 (elm)->field.tqe_prev = &(listelm)->field.tqe_next; \
397 #define TAILQ_INSERT_BEFORE(listelm, elm, field) do { \
398 (elm)->field.tqe_prev = (listelm)->field.tqe_prev; \
399 (elm)->field.tqe_next = (listelm); \
400 *(listelm)->field.tqe_prev = (elm); \
401 (listelm)->field.tqe_prev = &(elm)->field.tqe_next; \
404 #define TAILQ_REMOVE(head, elm, field) do { \
405 if (((elm)->field.tqe_next) != NULL) \
406 (elm)->field.tqe_next->field.tqe_prev = \
407 (elm)->field.tqe_prev; \
409 (head)->tqh_last = (elm)->field.tqe_prev; \
410 *(elm)->field.tqe_prev = (elm)->field.tqe_next; \
414 * Circular queue definitions.
416 #define CIRCLEQ_HEAD(name, type) \
418 struct type *cqh_first; /* first element */ \
419 struct type *cqh_last; /* last element */ \
422 #define CIRCLEQ_ENTRY(type) \
424 struct type *cqe_next; /* next element */ \
425 struct type *cqe_prev; /* previous element */ \
429 * Circular queue functions.
431 #define CIRCLEQ_EMPTY(head) ((head)->cqh_first == (void *)(head))
433 #define CIRCLEQ_FIRST(head) ((head)->cqh_first)
435 #define CIRCLEQ_FOREACH(var, head, field) \
436 for((var) = (head)->cqh_first; \
437 (var) != (void *)(head); \
438 (var) = (var)->field.cqe_next)
440 #define CIRCLEQ_INIT(head) do { \
441 (head)->cqh_first = (void *)(head); \
442 (head)->cqh_last = (void *)(head); \
445 #define CIRCLEQ_INSERT_AFTER(head, listelm, elm, field) do { \
446 (elm)->field.cqe_next = (listelm)->field.cqe_next; \
447 (elm)->field.cqe_prev = (listelm); \
448 if ((listelm)->field.cqe_next == (void *)(head)) \
449 (head)->cqh_last = (elm); \
451 (listelm)->field.cqe_next->field.cqe_prev = (elm); \
452 (listelm)->field.cqe_next = (elm); \
455 #define CIRCLEQ_INSERT_BEFORE(head, listelm, elm, field) do { \
456 (elm)->field.cqe_next = (listelm); \
457 (elm)->field.cqe_prev = (listelm)->field.cqe_prev; \
458 if ((listelm)->field.cqe_prev == (void *)(head)) \
459 (head)->cqh_first = (elm); \
461 (listelm)->field.cqe_prev->field.cqe_next = (elm); \
462 (listelm)->field.cqe_prev = (elm); \
465 #define CIRCLEQ_INSERT_HEAD(head, elm, field) do { \
466 (elm)->field.cqe_next = (head)->cqh_first; \
467 (elm)->field.cqe_prev = (void *)(head); \
468 if ((head)->cqh_last == (void *)(head)) \
469 (head)->cqh_last = (elm); \
471 (head)->cqh_first->field.cqe_prev = (elm); \
472 (head)->cqh_first = (elm); \
475 #define CIRCLEQ_INSERT_TAIL(head, elm, field) do { \
476 (elm)->field.cqe_next = (void *)(head); \
477 (elm)->field.cqe_prev = (head)->cqh_last; \
478 if ((head)->cqh_first == (void *)(head)) \
479 (head)->cqh_first = (elm); \
481 (head)->cqh_last->field.cqe_next = (elm); \
482 (head)->cqh_last = (elm); \
485 #define CIRCLEQ_LAST(head) ((head)->cqh_last)
487 #define CIRCLEQ_NEXT(elm,field) ((elm)->field.cqe_next)
489 #define CIRCLEQ_PREV(elm,field) ((elm)->field.cqe_prev)
491 #define CIRCLEQ_REMOVE(head, elm, field) do { \
492 if ((elm)->field.cqe_next == (void *)(head)) \
493 (head)->cqh_last = (elm)->field.cqe_prev; \
495 (elm)->field.cqe_next->field.cqe_prev = \
496 (elm)->field.cqe_prev; \
497 if ((elm)->field.cqe_prev == (void *)(head)) \
498 (head)->cqh_first = (elm)->field.cqe_next; \
500 (elm)->field.cqe_prev->field.cqe_next = \
501 (elm)->field.cqe_next; \
509 * XXX insque() and remque() are an old way of handling certain queues.
510 * They bogusly assumes that all queue heads look alike.
514 struct quehead
*qh_link
;
515 struct quehead
*qh_rlink
;
521 insque(void *a
, void *b
)
523 struct quehead
*element
= a
, *head
= b
;
525 element
->qh_link
= head
->qh_link
;
526 element
->qh_rlink
= head
;
527 head
->qh_link
= element
;
528 element
->qh_link
->qh_rlink
= element
;
534 struct quehead
*element
= a
;
536 element
->qh_link
->qh_rlink
= element
->qh_rlink
;
537 element
->qh_rlink
->qh_link
= element
->qh_link
;
538 element
->qh_rlink
= 0;
541 #else /* !__GNUC__ */
543 void insque(void *a
, void *b
);
544 void remque(void *a
);
546 #endif /* __GNUC__ */
551 #endif /* !_SYS_QUEUE_H_ */