2 * Copyright (c) 1991, 1993
3 * The Regents of the University of California. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * 3. Neither the name of the University nor the names of its contributors
14 * may be used to endorse or promote products derived from this software
15 * without specific prior written permission.
17 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 * @(#)queue.h 8.5 (Berkeley) 8/20/94
36 #include <sys/cdefs.h>
39 * This file defines four types of data structures: singly-linked lists,
40 * singly-linked tail queues, lists and tail queues.
42 * A singly-linked list is headed by a single forward pointer. The elements
43 * are singly linked for minimum space and pointer manipulation overhead at
44 * the expense of O(n) removal for arbitrary elements. New elements can be
45 * added to the list after an existing element or at the head of the list.
46 * Elements being removed from the head of the list should use the explicit
47 * macro for this purpose for optimum efficiency. A singly-linked list may
48 * only be traversed in the forward direction. Singly-linked lists are ideal
49 * for applications with large datasets and few or no removals or for
50 * implementing a LIFO queue.
52 * A singly-linked tail queue is headed by a pair of pointers, one to the
53 * head of the list and the other to the tail of the list. The elements are
54 * singly linked for minimum space and pointer manipulation overhead at the
55 * expense of O(n) removal for arbitrary elements. New elements can be added
56 * to the list after an existing element, at the head of the list, or at the
57 * end of the list. Elements being removed from the head of the tail queue
58 * should use the explicit macro for this purpose for optimum efficiency.
59 * A singly-linked tail queue may only be traversed in the forward direction.
60 * Singly-linked tail queues are ideal for applications with large datasets
61 * and few or no removals or for implementing a FIFO queue.
63 * A list is headed by a single forward pointer (or an array of forward
64 * pointers for a hash table header). The elements are doubly linked
65 * so that an arbitrary element can be removed without a need to
66 * traverse the list. New elements can be added to the list before
67 * or after an existing element or at the head of the list. A list
68 * may be traversed in either direction.
70 * A tail queue is headed by a pair of pointers, one to the head of the
71 * list and the other to the tail of the list. The elements are doubly
72 * linked so that an arbitrary element can be removed without a need to
73 * traverse the list. New elements can be added to the list before or
74 * after an existing element, at the head of the list, or at the end of
75 * the list. A tail queue may be traversed in either direction.
77 * For details on the use of these macros, see the queue(3) manual page.
79 * Below is a summary of implemented functions where:
80 * + means the macro is available
81 * - means the macro is not available
82 * s means the macro is available but is slow (runs in O(n) time)
84 * SLIST LIST STAILQ TAILQ
87 * _HEAD_INITIALIZER + + + +
89 * _CLASS_ENTRY + + + +
97 * _FOREACH_FROM + + + +
98 * _FOREACH_SAFE + + + +
99 * _FOREACH_FROM_SAFE + + + +
100 * _FOREACH_REVERSE - - - +
101 * _FOREACH_REVERSE_FROM - - - +
102 * _FOREACH_REVERSE_SAFE - - - +
103 * _FOREACH_REVERSE_FROM_SAFE - - - +
104 * _INSERT_HEAD + + + +
105 * _INSERT_BEFORE - + - +
106 * _INSERT_AFTER + + + +
107 * _INSERT_TAIL - - + +
109 * _REMOVE_AFTER + - + -
110 * _REMOVE_HEAD + - + -
115 #ifdef QUEUE_MACRO_DEBUG
116 #warn Use QUEUE_MACRO_DEBUG_TRACE and/or QUEUE_MACRO_DEBUG_TRASH
117 #define QUEUE_MACRO_DEBUG_TRACE
118 #define QUEUE_MACRO_DEBUG_TRASH
121 #ifdef QUEUE_MACRO_DEBUG_TRACE
122 /* Store the last 2 places the queue element or head was altered */
124 unsigned long lastline;
125 unsigned long prevline;
126 const char *lastfile;
127 const char *prevfile;
130 #define TRACEBUF struct qm_trace trace;
131 #define TRACEBUF_INITIALIZER { __LINE__, 0, __FILE__, NULL } ,
133 #define QMD_TRACE_HEAD(head) do { \
134 (head)->trace.prevline = (head)->trace.lastline; \
135 (head)->trace.prevfile = (head)->trace.lastfile; \
136 (head)->trace.lastline = __LINE__; \
137 (head)->trace.lastfile = __FILE__; \
140 #define QMD_TRACE_ELEM(elem) do { \
141 (elem)->trace.prevline = (elem)->trace.lastline; \
142 (elem)->trace.prevfile = (elem)->trace.lastfile; \
143 (elem)->trace.lastline = __LINE__; \
144 (elem)->trace.lastfile = __FILE__; \
147 #else /* !QUEUE_MACRO_DEBUG_TRACE */
148 #define QMD_TRACE_ELEM(elem)
149 #define QMD_TRACE_HEAD(head)
151 #define TRACEBUF_INITIALIZER
152 #endif /* QUEUE_MACRO_DEBUG_TRACE */
154 #ifdef QUEUE_MACRO_DEBUG_TRASH
155 #define TRASHIT(x) do {(x) = (void *)-1;} while (0)
156 #define QMD_IS_TRASHED(x) ((x) == (void *)(intptr_t)-1)
157 #else /* !QUEUE_MACRO_DEBUG_TRASH */
159 #define QMD_IS_TRASHED(x) 0
160 #endif /* QUEUE_MACRO_DEBUG_TRASH */
162 #if defined(QUEUE_MACRO_DEBUG_TRACE) || defined(QUEUE_MACRO_DEBUG_TRASH)
163 #define QMD_SAVELINK(name, link) void **name = (void *)&(link)
164 #else /* !QUEUE_MACRO_DEBUG_TRACE && !QUEUE_MACRO_DEBUG_TRASH */
165 #define QMD_SAVELINK(name, link)
166 #endif /* QUEUE_MACRO_DEBUG_TRACE || QUEUE_MACRO_DEBUG_TRASH */
170 * In C++ there can be structure lists and class lists:
172 #define QUEUE_TYPEOF(type) type
174 #define QUEUE_TYPEOF(type) struct type
178 * Singly-linked List declarations.
180 #define SLIST_HEAD(name, type) \
182 struct type *slh_first; /* first element */ \
185 #define SLIST_CLASS_HEAD(name, type) \
187 class type *slh_first; /* first element */ \
190 #define SLIST_HEAD_INITIALIZER(head) \
193 #define SLIST_ENTRY(type) \
195 struct type *sle_next; /* next element */ \
198 #define SLIST_CLASS_ENTRY(type) \
200 class type *sle_next; /* next element */ \
204 * Singly-linked List functions.
206 #if (defined(_KERNEL) && defined(INVARIANTS))
207 #define QMD_SLIST_CHECK_PREVPTR(prevp, elm) do { \
208 if (*(prevp) != (elm)) \
209 panic("Bad prevptr *(%p) == %p != %p", \
210 (prevp), *(prevp), (elm)); \
213 #define QMD_SLIST_CHECK_PREVPTR(prevp, elm)
216 #define SLIST_CONCAT(head1, head2, type, field) do { \
217 QUEUE_TYPEOF(type) *curelm = SLIST_FIRST(head1); \
218 if (curelm == NULL) { \
219 if ((SLIST_FIRST(head1) = SLIST_FIRST(head2)) != NULL) \
221 } else if (SLIST_FIRST(head2) != NULL) { \
222 while (SLIST_NEXT(curelm, field) != NULL) \
223 curelm = SLIST_NEXT(curelm, field); \
224 SLIST_NEXT(curelm, field) = SLIST_FIRST(head2); \
229 #define SLIST_EMPTY(head) ((head)->slh_first == NULL)
231 #define SLIST_FIRST(head) ((head)->slh_first)
233 #define SLIST_FOREACH(var, head, field) \
234 for ((var) = SLIST_FIRST((head)); \
236 (var) = SLIST_NEXT((var), field))
238 #define SLIST_FOREACH_FROM(var, head, field) \
239 for ((var) = ((var) ? (var) : SLIST_FIRST((head))); \
241 (var) = SLIST_NEXT((var), field))
243 #define SLIST_FOREACH_SAFE(var, head, field, tvar) \
244 for ((var) = SLIST_FIRST((head)); \
245 (var) && ((tvar) = SLIST_NEXT((var), field), 1); \
248 #define SLIST_FOREACH_FROM_SAFE(var, head, field, tvar) \
249 for ((var) = ((var) ? (var) : SLIST_FIRST((head))); \
250 (var) && ((tvar) = SLIST_NEXT((var), field), 1); \
253 #define SLIST_FOREACH_PREVPTR(var, varp, head, field) \
254 for ((varp) = &SLIST_FIRST((head)); \
255 ((var) = *(varp)) != NULL; \
256 (varp) = &SLIST_NEXT((var), field))
258 #define SLIST_INIT(head) do { \
259 SLIST_FIRST((head)) = NULL; \
262 #define SLIST_INSERT_AFTER(slistelm, elm, field) do { \
263 SLIST_NEXT((elm), field) = SLIST_NEXT((slistelm), field); \
264 SLIST_NEXT((slistelm), field) = (elm); \
267 #define SLIST_INSERT_HEAD(head, elm, field) do { \
268 SLIST_NEXT((elm), field) = SLIST_FIRST((head)); \
269 SLIST_FIRST((head)) = (elm); \
272 #define SLIST_NEXT(elm, field) ((elm)->field.sle_next)
274 #define SLIST_REMOVE(head, elm, type, field) do { \
275 QMD_SAVELINK(oldnext, (elm)->field.sle_next); \
276 if (SLIST_FIRST((head)) == (elm)) { \
277 SLIST_REMOVE_HEAD((head), field); \
280 QUEUE_TYPEOF(type) *curelm = SLIST_FIRST(head); \
281 while (SLIST_NEXT(curelm, field) != (elm)) \
282 curelm = SLIST_NEXT(curelm, field); \
283 SLIST_REMOVE_AFTER(curelm, field); \
288 #define SLIST_REMOVE_AFTER(elm, field) do { \
289 SLIST_NEXT(elm, field) = \
290 SLIST_NEXT(SLIST_NEXT(elm, field), field); \
293 #define SLIST_REMOVE_HEAD(head, field) do { \
294 SLIST_FIRST((head)) = SLIST_NEXT(SLIST_FIRST((head)), field); \
297 #define SLIST_REMOVE_PREVPTR(prevp, elm, field) do { \
298 QMD_SLIST_CHECK_PREVPTR(prevp, elm); \
299 *(prevp) = SLIST_NEXT(elm, field); \
300 TRASHIT((elm)->field.sle_next); \
303 #define SLIST_SWAP(head1, head2, type) do { \
304 QUEUE_TYPEOF(type) *swap_first = SLIST_FIRST(head1); \
305 SLIST_FIRST(head1) = SLIST_FIRST(head2); \
306 SLIST_FIRST(head2) = swap_first; \
310 * Singly-linked Tail queue declarations.
312 #define STAILQ_HEAD(name, type) \
314 struct type *stqh_first;/* first element */ \
315 struct type **stqh_last;/* addr of last next element */ \
318 #define STAILQ_CLASS_HEAD(name, type) \
320 class type *stqh_first; /* first element */ \
321 class type **stqh_last; /* addr of last next element */ \
324 #define STAILQ_HEAD_INITIALIZER(head) \
325 { NULL, &(head).stqh_first }
327 #define STAILQ_ENTRY(type) \
329 struct type *stqe_next; /* next element */ \
332 #define STAILQ_CLASS_ENTRY(type) \
334 class type *stqe_next; /* next element */ \
338 * Singly-linked Tail queue functions.
340 #define STAILQ_CONCAT(head1, head2) do { \
341 if (!STAILQ_EMPTY((head2))) { \
342 *(head1)->stqh_last = (head2)->stqh_first; \
343 (head1)->stqh_last = (head2)->stqh_last; \
344 STAILQ_INIT((head2)); \
348 #define STAILQ_EMPTY(head) ((head)->stqh_first == NULL)
350 #define STAILQ_FIRST(head) ((head)->stqh_first)
352 #define STAILQ_FOREACH(var, head, field) \
353 for((var) = STAILQ_FIRST((head)); \
355 (var) = STAILQ_NEXT((var), field))
357 #define STAILQ_FOREACH_FROM(var, head, field) \
358 for ((var) = ((var) ? (var) : STAILQ_FIRST((head))); \
360 (var) = STAILQ_NEXT((var), field))
362 #define STAILQ_FOREACH_SAFE(var, head, field, tvar) \
363 for ((var) = STAILQ_FIRST((head)); \
364 (var) && ((tvar) = STAILQ_NEXT((var), field), 1); \
367 #define STAILQ_FOREACH_FROM_SAFE(var, head, field, tvar) \
368 for ((var) = ((var) ? (var) : STAILQ_FIRST((head))); \
369 (var) && ((tvar) = STAILQ_NEXT((var), field), 1); \
372 #define STAILQ_INIT(head) do { \
373 STAILQ_FIRST((head)) = NULL; \
374 (head)->stqh_last = &STAILQ_FIRST((head)); \
377 #define STAILQ_INSERT_AFTER(head, tqelm, elm, field) do { \
378 if ((STAILQ_NEXT((elm), field) = STAILQ_NEXT((tqelm), field)) == NULL)\
379 (head)->stqh_last = &STAILQ_NEXT((elm), field); \
380 STAILQ_NEXT((tqelm), field) = (elm); \
383 #define STAILQ_INSERT_HEAD(head, elm, field) do { \
384 if ((STAILQ_NEXT((elm), field) = STAILQ_FIRST((head))) == NULL) \
385 (head)->stqh_last = &STAILQ_NEXT((elm), field); \
386 STAILQ_FIRST((head)) = (elm); \
389 #define STAILQ_INSERT_TAIL(head, elm, field) do { \
390 STAILQ_NEXT((elm), field) = NULL; \
391 *(head)->stqh_last = (elm); \
392 (head)->stqh_last = &STAILQ_NEXT((elm), field); \
395 #define STAILQ_LAST(head, type, field) \
396 (STAILQ_EMPTY((head)) ? NULL : \
397 __containerof((head)->stqh_last, \
398 QUEUE_TYPEOF(type), field.stqe_next))
400 #define STAILQ_NEXT(elm, field) ((elm)->field.stqe_next)
402 #define STAILQ_REMOVE(head, elm, type, field) do { \
403 QMD_SAVELINK(oldnext, (elm)->field.stqe_next); \
404 if (STAILQ_FIRST((head)) == (elm)) { \
405 STAILQ_REMOVE_HEAD((head), field); \
408 QUEUE_TYPEOF(type) *curelm = STAILQ_FIRST(head); \
409 while (STAILQ_NEXT(curelm, field) != (elm)) \
410 curelm = STAILQ_NEXT(curelm, field); \
411 STAILQ_REMOVE_AFTER(head, curelm, field); \
416 #define STAILQ_REMOVE_AFTER(head, elm, field) do { \
417 if ((STAILQ_NEXT(elm, field) = \
418 STAILQ_NEXT(STAILQ_NEXT(elm, field), field)) == NULL) \
419 (head)->stqh_last = &STAILQ_NEXT((elm), field); \
422 #define STAILQ_REMOVE_HEAD(head, field) do { \
423 if ((STAILQ_FIRST((head)) = \
424 STAILQ_NEXT(STAILQ_FIRST((head)), field)) == NULL) \
425 (head)->stqh_last = &STAILQ_FIRST((head)); \
428 #define STAILQ_SWAP(head1, head2, type) do { \
429 QUEUE_TYPEOF(type) *swap_first = STAILQ_FIRST(head1); \
430 QUEUE_TYPEOF(type) **swap_last = (head1)->stqh_last; \
431 STAILQ_FIRST(head1) = STAILQ_FIRST(head2); \
432 (head1)->stqh_last = (head2)->stqh_last; \
433 STAILQ_FIRST(head2) = swap_first; \
434 (head2)->stqh_last = swap_last; \
435 if (STAILQ_EMPTY(head1)) \
436 (head1)->stqh_last = &STAILQ_FIRST(head1); \
437 if (STAILQ_EMPTY(head2)) \
438 (head2)->stqh_last = &STAILQ_FIRST(head2); \
445 #define LIST_HEAD(name, type) \
447 struct type *lh_first; /* first element */ \
450 #define LIST_CLASS_HEAD(name, type) \
452 class type *lh_first; /* first element */ \
455 #define LIST_HEAD_INITIALIZER(head) \
458 #define LIST_ENTRY(type) \
460 struct type *le_next; /* next element */ \
461 struct type **le_prev; /* address of previous next element */ \
464 #define LIST_CLASS_ENTRY(type) \
466 class type *le_next; /* next element */ \
467 class type **le_prev; /* address of previous next element */ \
474 #if (defined(_KERNEL) && defined(INVARIANTS))
476 * QMD_LIST_CHECK_HEAD(LIST_HEAD *head, LIST_ENTRY NAME)
478 * If the list is non-empty, validates that the first element of the list
479 * points back at 'head.'
481 #define QMD_LIST_CHECK_HEAD(head, field) do { \
482 if (LIST_FIRST((head)) != NULL && \
483 LIST_FIRST((head))->field.le_prev != \
484 &LIST_FIRST((head))) \
485 panic("Bad list head %p first->prev != head", (head)); \
489 * QMD_LIST_CHECK_NEXT(TYPE *elm, LIST_ENTRY NAME)
491 * If an element follows 'elm' in the list, validates that the next element
492 * points back at 'elm.'
494 #define QMD_LIST_CHECK_NEXT(elm, field) do { \
495 if (LIST_NEXT((elm), field) != NULL && \
496 LIST_NEXT((elm), field)->field.le_prev != \
497 &((elm)->field.le_next)) \
498 panic("Bad link elm %p next->prev != elm", (elm)); \
502 * QMD_LIST_CHECK_PREV(TYPE *elm, LIST_ENTRY NAME)
504 * Validates that the previous element (or head of the list) points to 'elm.'
506 #define QMD_LIST_CHECK_PREV(elm, field) do { \
507 if (*(elm)->field.le_prev != (elm)) \
508 panic("Bad link elm %p prev->next != elm", (elm)); \
511 #define QMD_LIST_CHECK_HEAD(head, field)
512 #define QMD_LIST_CHECK_NEXT(elm, field)
513 #define QMD_LIST_CHECK_PREV(elm, field)
514 #endif /* (_KERNEL && INVARIANTS) */
516 #define LIST_CONCAT(head1, head2, type, field) do { \
517 QUEUE_TYPEOF(type) *curelm = LIST_FIRST(head1); \
518 if (curelm == NULL) { \
519 if ((LIST_FIRST(head1) = LIST_FIRST(head2)) != NULL) { \
520 LIST_FIRST(head2)->field.le_prev = \
521 &LIST_FIRST((head1)); \
524 } else if (LIST_FIRST(head2) != NULL) { \
525 while (LIST_NEXT(curelm, field) != NULL) \
526 curelm = LIST_NEXT(curelm, field); \
527 LIST_NEXT(curelm, field) = LIST_FIRST(head2); \
528 LIST_FIRST(head2)->field.le_prev = &LIST_NEXT(curelm, field); \
533 #define LIST_EMPTY(head) ((head)->lh_first == NULL)
535 #define LIST_FIRST(head) ((head)->lh_first)
537 #define LIST_FOREACH(var, head, field) \
538 for ((var) = LIST_FIRST((head)); \
540 (var) = LIST_NEXT((var), field))
542 #define LIST_FOREACH_FROM(var, head, field) \
543 for ((var) = ((var) ? (var) : LIST_FIRST((head))); \
545 (var) = LIST_NEXT((var), field))
547 #define LIST_FOREACH_SAFE(var, head, field, tvar) \
548 for ((var) = LIST_FIRST((head)); \
549 (var) && ((tvar) = LIST_NEXT((var), field), 1); \
552 #define LIST_FOREACH_FROM_SAFE(var, head, field, tvar) \
553 for ((var) = ((var) ? (var) : LIST_FIRST((head))); \
554 (var) && ((tvar) = LIST_NEXT((var), field), 1); \
557 #define LIST_INIT(head) do { \
558 LIST_FIRST((head)) = NULL; \
561 #define LIST_INSERT_AFTER(listelm, elm, field) do { \
562 QMD_LIST_CHECK_NEXT(listelm, field); \
563 if ((LIST_NEXT((elm), field) = LIST_NEXT((listelm), field)) != NULL)\
564 LIST_NEXT((listelm), field)->field.le_prev = \
565 &LIST_NEXT((elm), field); \
566 LIST_NEXT((listelm), field) = (elm); \
567 (elm)->field.le_prev = &LIST_NEXT((listelm), field); \
570 #define LIST_INSERT_BEFORE(listelm, elm, field) do { \
571 QMD_LIST_CHECK_PREV(listelm, field); \
572 (elm)->field.le_prev = (listelm)->field.le_prev; \
573 LIST_NEXT((elm), field) = (listelm); \
574 *(listelm)->field.le_prev = (elm); \
575 (listelm)->field.le_prev = &LIST_NEXT((elm), field); \
578 #define LIST_INSERT_HEAD(head, elm, field) do { \
579 QMD_LIST_CHECK_HEAD((head), field); \
580 if ((LIST_NEXT((elm), field) = LIST_FIRST((head))) != NULL) \
581 LIST_FIRST((head))->field.le_prev = &LIST_NEXT((elm), field);\
582 LIST_FIRST((head)) = (elm); \
583 (elm)->field.le_prev = &LIST_FIRST((head)); \
586 #define LIST_NEXT(elm, field) ((elm)->field.le_next)
588 #define LIST_PREV(elm, head, type, field) \
589 ((elm)->field.le_prev == &LIST_FIRST((head)) ? NULL : \
590 __containerof((elm)->field.le_prev, \
591 QUEUE_TYPEOF(type), field.le_next))
593 #define LIST_REMOVE(elm, field) do { \
594 QMD_SAVELINK(oldnext, (elm)->field.le_next); \
595 QMD_SAVELINK(oldprev, (elm)->field.le_prev); \
596 QMD_LIST_CHECK_NEXT(elm, field); \
597 QMD_LIST_CHECK_PREV(elm, field); \
598 if (LIST_NEXT((elm), field) != NULL) \
599 LIST_NEXT((elm), field)->field.le_prev = \
600 (elm)->field.le_prev; \
601 *(elm)->field.le_prev = LIST_NEXT((elm), field); \
606 #define LIST_SWAP(head1, head2, type, field) do { \
607 QUEUE_TYPEOF(type) *swap_tmp = LIST_FIRST(head1); \
608 LIST_FIRST((head1)) = LIST_FIRST((head2)); \
609 LIST_FIRST((head2)) = swap_tmp; \
610 if ((swap_tmp = LIST_FIRST((head1))) != NULL) \
611 swap_tmp->field.le_prev = &LIST_FIRST((head1)); \
612 if ((swap_tmp = LIST_FIRST((head2))) != NULL) \
613 swap_tmp->field.le_prev = &LIST_FIRST((head2)); \
617 * Tail queue declarations.
619 #define TAILQ_HEAD(name, type) \
621 struct type *tqh_first; /* first element */ \
622 struct type **tqh_last; /* addr of last next element */ \
626 #define TAILQ_CLASS_HEAD(name, type) \
628 class type *tqh_first; /* first element */ \
629 class type **tqh_last; /* addr of last next element */ \
633 #define TAILQ_HEAD_INITIALIZER(head) \
634 { NULL, &(head).tqh_first, TRACEBUF_INITIALIZER }
636 #define TAILQ_ENTRY(type) \
638 struct type *tqe_next; /* next element */ \
639 struct type **tqe_prev; /* address of previous next element */ \
643 #define TAILQ_CLASS_ENTRY(type) \
645 class type *tqe_next; /* next element */ \
646 class type **tqe_prev; /* address of previous next element */ \
651 * Tail queue functions.
653 #if (defined(_KERNEL) && defined(INVARIANTS))
655 * QMD_TAILQ_CHECK_HEAD(TAILQ_HEAD *head, TAILQ_ENTRY NAME)
657 * If the tailq is non-empty, validates that the first element of the tailq
658 * points back at 'head.'
660 #define QMD_TAILQ_CHECK_HEAD(head, field) do { \
661 if (!TAILQ_EMPTY(head) && \
662 TAILQ_FIRST((head))->field.tqe_prev != \
663 &TAILQ_FIRST((head))) \
664 panic("Bad tailq head %p first->prev != head", (head)); \
668 * QMD_TAILQ_CHECK_TAIL(TAILQ_HEAD *head, TAILQ_ENTRY NAME)
670 * Validates that the tail of the tailq is a pointer to pointer to NULL.
672 #define QMD_TAILQ_CHECK_TAIL(head, field) do { \
673 if (*(head)->tqh_last != NULL) \
674 panic("Bad tailq NEXT(%p->tqh_last) != NULL", (head)); \
678 * QMD_TAILQ_CHECK_NEXT(TYPE *elm, TAILQ_ENTRY NAME)
680 * If an element follows 'elm' in the tailq, validates that the next element
681 * points back at 'elm.'
683 #define QMD_TAILQ_CHECK_NEXT(elm, field) do { \
684 if (TAILQ_NEXT((elm), field) != NULL && \
685 TAILQ_NEXT((elm), field)->field.tqe_prev != \
686 &((elm)->field.tqe_next)) \
687 panic("Bad link elm %p next->prev != elm", (elm)); \
691 * QMD_TAILQ_CHECK_PREV(TYPE *elm, TAILQ_ENTRY NAME)
693 * Validates that the previous element (or head of the tailq) points to 'elm.'
695 #define QMD_TAILQ_CHECK_PREV(elm, field) do { \
696 if (*(elm)->field.tqe_prev != (elm)) \
697 panic("Bad link elm %p prev->next != elm", (elm)); \
700 #define QMD_TAILQ_CHECK_HEAD(head, field)
701 #define QMD_TAILQ_CHECK_TAIL(head, headname)
702 #define QMD_TAILQ_CHECK_NEXT(elm, field)
703 #define QMD_TAILQ_CHECK_PREV(elm, field)
704 #endif /* (_KERNEL && INVARIANTS) */
706 #define TAILQ_CONCAT(head1, head2, field) do { \
707 if (!TAILQ_EMPTY(head2)) { \
708 *(head1)->tqh_last = (head2)->tqh_first; \
709 (head2)->tqh_first->field.tqe_prev = (head1)->tqh_last; \
710 (head1)->tqh_last = (head2)->tqh_last; \
711 TAILQ_INIT((head2)); \
712 QMD_TRACE_HEAD(head1); \
713 QMD_TRACE_HEAD(head2); \
717 #define TAILQ_EMPTY(head) ((head)->tqh_first == NULL)
719 #define TAILQ_FIRST(head) ((head)->tqh_first)
721 #define TAILQ_FOREACH(var, head, field) \
722 for ((var) = TAILQ_FIRST((head)); \
724 (var) = TAILQ_NEXT((var), field))
726 #define TAILQ_FOREACH_FROM(var, head, field) \
727 for ((var) = ((var) ? (var) : TAILQ_FIRST((head))); \
729 (var) = TAILQ_NEXT((var), field))
731 #define TAILQ_FOREACH_SAFE(var, head, field, tvar) \
732 for ((var) = TAILQ_FIRST((head)); \
733 (var) && ((tvar) = TAILQ_NEXT((var), field), 1); \
736 #define TAILQ_FOREACH_FROM_SAFE(var, head, field, tvar) \
737 for ((var) = ((var) ? (var) : TAILQ_FIRST((head))); \
738 (var) && ((tvar) = TAILQ_NEXT((var), field), 1); \
741 #define TAILQ_FOREACH_REVERSE(var, head, headname, field) \
742 for ((var) = TAILQ_LAST((head), headname); \
744 (var) = TAILQ_PREV((var), headname, field))
746 #define TAILQ_FOREACH_REVERSE_FROM(var, head, headname, field) \
747 for ((var) = ((var) ? (var) : TAILQ_LAST((head), headname)); \
749 (var) = TAILQ_PREV((var), headname, field))
751 #define TAILQ_FOREACH_REVERSE_SAFE(var, head, headname, field, tvar) \
752 for ((var) = TAILQ_LAST((head), headname); \
753 (var) && ((tvar) = TAILQ_PREV((var), headname, field), 1); \
756 #define TAILQ_FOREACH_REVERSE_FROM_SAFE(var, head, headname, field, tvar) \
757 for ((var) = ((var) ? (var) : TAILQ_LAST((head), headname)); \
758 (var) && ((tvar) = TAILQ_PREV((var), headname, field), 1); \
761 #define TAILQ_INIT(head) do { \
762 TAILQ_FIRST((head)) = NULL; \
763 (head)->tqh_last = &TAILQ_FIRST((head)); \
764 QMD_TRACE_HEAD(head); \
767 #define TAILQ_INSERT_AFTER(head, listelm, elm, field) do { \
768 QMD_TAILQ_CHECK_NEXT(listelm, field); \
769 if ((TAILQ_NEXT((elm), field) = TAILQ_NEXT((listelm), field)) != NULL)\
770 TAILQ_NEXT((elm), field)->field.tqe_prev = \
771 &TAILQ_NEXT((elm), field); \
773 (head)->tqh_last = &TAILQ_NEXT((elm), field); \
774 QMD_TRACE_HEAD(head); \
776 TAILQ_NEXT((listelm), field) = (elm); \
777 (elm)->field.tqe_prev = &TAILQ_NEXT((listelm), field); \
778 QMD_TRACE_ELEM(&(elm)->field); \
779 QMD_TRACE_ELEM(&(listelm)->field); \
782 #define TAILQ_INSERT_BEFORE(listelm, elm, field) do { \
783 QMD_TAILQ_CHECK_PREV(listelm, field); \
784 (elm)->field.tqe_prev = (listelm)->field.tqe_prev; \
785 TAILQ_NEXT((elm), field) = (listelm); \
786 *(listelm)->field.tqe_prev = (elm); \
787 (listelm)->field.tqe_prev = &TAILQ_NEXT((elm), field); \
788 QMD_TRACE_ELEM(&(elm)->field); \
789 QMD_TRACE_ELEM(&(listelm)->field); \
792 #define TAILQ_INSERT_HEAD(head, elm, field) do { \
793 QMD_TAILQ_CHECK_HEAD(head, field); \
794 if ((TAILQ_NEXT((elm), field) = TAILQ_FIRST((head))) != NULL) \
795 TAILQ_FIRST((head))->field.tqe_prev = \
796 &TAILQ_NEXT((elm), field); \
798 (head)->tqh_last = &TAILQ_NEXT((elm), field); \
799 TAILQ_FIRST((head)) = (elm); \
800 (elm)->field.tqe_prev = &TAILQ_FIRST((head)); \
801 QMD_TRACE_HEAD(head); \
802 QMD_TRACE_ELEM(&(elm)->field); \
805 #define TAILQ_INSERT_TAIL(head, elm, field) do { \
806 QMD_TAILQ_CHECK_TAIL(head, field); \
807 TAILQ_NEXT((elm), field) = NULL; \
808 (elm)->field.tqe_prev = (head)->tqh_last; \
809 *(head)->tqh_last = (elm); \
810 (head)->tqh_last = &TAILQ_NEXT((elm), field); \
811 QMD_TRACE_HEAD(head); \
812 QMD_TRACE_ELEM(&(elm)->field); \
815 #define TAILQ_LAST(head, headname) \
816 (*(((struct headname *)((head)->tqh_last))->tqh_last))
818 #define TAILQ_NEXT(elm, field) ((elm)->field.tqe_next)
820 #define TAILQ_PREV(elm, headname, field) \
821 (*(((struct headname *)((elm)->field.tqe_prev))->tqh_last))
823 #define TAILQ_REMOVE(head, elm, field) do { \
824 QMD_SAVELINK(oldnext, (elm)->field.tqe_next); \
825 QMD_SAVELINK(oldprev, (elm)->field.tqe_prev); \
826 QMD_TAILQ_CHECK_NEXT(elm, field); \
827 QMD_TAILQ_CHECK_PREV(elm, field); \
828 if ((TAILQ_NEXT((elm), field)) != NULL) \
829 TAILQ_NEXT((elm), field)->field.tqe_prev = \
830 (elm)->field.tqe_prev; \
832 (head)->tqh_last = (elm)->field.tqe_prev; \
833 QMD_TRACE_HEAD(head); \
835 *(elm)->field.tqe_prev = TAILQ_NEXT((elm), field); \
838 QMD_TRACE_ELEM(&(elm)->field); \
841 #define TAILQ_SWAP(head1, head2, type, field) do { \
842 QUEUE_TYPEOF(type) *swap_first = (head1)->tqh_first; \
843 QUEUE_TYPEOF(type) **swap_last = (head1)->tqh_last; \
844 (head1)->tqh_first = (head2)->tqh_first; \
845 (head1)->tqh_last = (head2)->tqh_last; \
846 (head2)->tqh_first = swap_first; \
847 (head2)->tqh_last = swap_last; \
848 if ((swap_first = (head1)->tqh_first) != NULL) \
849 swap_first->field.tqe_prev = &(head1)->tqh_first; \
851 (head1)->tqh_last = &(head1)->tqh_first; \
852 if ((swap_first = (head2)->tqh_first) != NULL) \
853 swap_first->field.tqe_prev = &(head2)->tqh_first; \
855 (head2)->tqh_last = &(head2)->tqh_first; \
858 #endif /* !_SYS_QUEUE_H_ */