diff options
author | Toomas Soome <tsoome@me.com> | 2018-11-30 23:08:49 -0800 |
---|---|---|
committer | Joshua M. Clulow <josh@sysmgr.org> | 2018-11-30 23:08:49 -0800 |
commit | 85280f08e3cfa2e404951ad6817bbb974b576858 (patch) | |
tree | f719a7166602cd75e448ada49fbad91037e0798a | |
parent | 2aba3acda67326648fd60aaf2bfb4e18ee8c04ed (diff) | |
download | illumos-gate-85280f08e3cfa2e404951ad6817bbb974b576858.tar.gz |
9731 uts: update sys/queue.h
Reviewed by: Yuri Pankov <yuripv@yuripv.net>
Reviewed by: Robert Mustacchi <rm@joyent.com>
Approved by: Joshua M. Clulow <josh@sysmgr.org>
-rw-r--r-- | usr/src/cmd/cmd-inet/usr.sbin/ipqosconf/ipqosconf.c | 4 | ||||
-rw-r--r-- | usr/src/man/man3head/Makefile | 182 | ||||
-rw-r--r-- | usr/src/man/man3head/queue.h.3head | 1315 | ||||
-rw-r--r-- | usr/src/pkg/manifests/system-header.mf | 107 | ||||
-rw-r--r-- | usr/src/uts/common/sys/queue.h | 861 |
5 files changed, 2210 insertions, 259 deletions
diff --git a/usr/src/cmd/cmd-inet/usr.sbin/ipqosconf/ipqosconf.c b/usr/src/cmd/cmd-inet/usr.sbin/ipqosconf/ipqosconf.c index dc7327158a..914c6f05db 100644 --- a/usr/src/cmd/cmd-inet/usr.sbin/ipqosconf/ipqosconf.c +++ b/usr/src/cmd/cmd-inet/usr.sbin/ipqosconf/ipqosconf.c @@ -249,7 +249,7 @@ static int readuser(char *str, uid_t *uid); * macros to call list functions with the more complex list element type * cast to the skeletal type iqpos_list_el_t. */ -#define LIST_END(list, end)\ +#define GET_LIST_END(list, end)\ list_end((ipqos_list_el_t **)list, (ipqos_list_el_t ***)end) #define ADD_TO_LIST(list, el)\ add_to_list((ipqos_list_el_t **)list, (ipqos_list_el_t *)el) @@ -9247,7 +9247,7 @@ ipqos_conf_action_t *actions) for (act = actions; act != NULL; act = act->next) { /* store start of new resolved filters */ - LIST_END(&act->filters, &new_filters); + GET_LIST_END(&act->filters, &new_filters); /* * do name resolution on retry list adding resolved filters diff --git a/usr/src/man/man3head/Makefile b/usr/src/man/man3head/Makefile index 0e1c2efb17..e212c67457 100644 --- a/usr/src/man/man3head/Makefile +++ b/usr/src/man/man3head/Makefile @@ -61,6 +61,7 @@ MANFILES= acct.h.3head \ poll.h.3head \ pthread.h.3head \ pwd.h.3head \ + queue.h.3head \ regex.h.3head \ resource.h.3head \ sched.h.3head \ @@ -109,7 +110,97 @@ MANFILES= acct.h.3head \ wordexp.h.3head \ xlocale.h.3head -MANLINKS= acct.3head \ +MANLINKS= \ + LIST_CLASS_ENTRY.3head \ + LIST_CLASS_HEAD.3head \ + LIST_CONCAT.3head \ + LIST_EMPTY.3head \ + LIST_ENTRY.3head \ + LIST_FIRST.3head \ + LIST_FOREACH.3head \ + LIST_FOREACH_FROM.3head \ + LIST_FOREACH_FROM_SAFE.3head \ + LIST_FOREACH_SAFE.3head \ + LIST_HEAD.3head \ + LIST_HEAD_INITIALIZER.3head \ + LIST_INIT.3head \ + LIST_INSERT_AFTER.3head \ + LIST_INSERT_BEFORE.3head \ + LIST_INSERT_HEAD.3head \ + LIST_NEXT.3head \ + LIST_PREV.3head \ + LIST_REMOVE.3head \ + LIST_SWAP.3head \ + SLIST_CLASS_ENTRY.3head \ + SLIST_CLASS_HEAD.3head \ + SLIST_CONCAT.3head \ + SLIST_EMPTY.3head \ + SLIST_ENTRY.3head \ + SLIST_FIRST.3head \ + SLIST_FOREACH.3head \ + SLIST_FOREACH_FROM.3head \ + SLIST_FOREACH_FROM_SAFE.3head \ + SLIST_FOREACH_SAFE.3head \ + SLIST_HEAD.3head \ + SLIST_HEAD_INITIALIZER.3head \ + SLIST_INIT.3head \ + SLIST_INSERT_AFTER.3head \ + SLIST_INSERT_HEAD.3head \ + SLIST_NEXT.3head \ + SLIST_REMOVE.3head \ + SLIST_REMOVE_AFTER.3head \ + SLIST_REMOVE_HEAD.3head \ + SLIST_SWAP.3head \ + STAILQ_CLASS_ENTRY.3head \ + STAILQ_CLASS_HEAD.3head \ + STAILQ_CONCAT.3head \ + STAILQ_EMPTY.3head \ + STAILQ_ENTRY.3head \ + STAILQ_FIRST.3head \ + STAILQ_FOREACH.3head \ + STAILQ_FOREACH_FROM.3head \ + STAILQ_FOREACH_FROM_SAFE.3head \ + STAILQ_FOREACH_SAFE.3head \ + STAILQ_HEAD.3head \ + STAILQ_HEAD_INITIALIZER.3head \ + STAILQ_INIT.3head \ + STAILQ_INSERT_AFTER.3head \ + STAILQ_INSERT_HEAD.3head \ + STAILQ_INSERT_TAIL.3head \ + STAILQ_LAST.3head \ + STAILQ_NEXT.3head \ + STAILQ_REMOVE.3head \ + STAILQ_REMOVE_AFTER.3head \ + STAILQ_REMOVE_HEAD.3head \ + STAILQ_SWAP.3head \ + TAILQ_CLASS_ENTRY.3head \ + TAILQ_CLASS_HEAD.3head \ + TAILQ_CONCAT.3head \ + TAILQ_EMPTY.3head \ + TAILQ_ENTRY.3head \ + TAILQ_FIRST.3head \ + TAILQ_FOREACH.3head \ + TAILQ_FOREACH_FROM.3head \ + TAILQ_FOREACH_FROM_SAFE.3head \ + TAILQ_FOREACH_REVERSE.3head \ + TAILQ_FOREACH_REVERSE_FROM.3head \ + TAILQ_FOREACH_REVERSE_FROM_SAFE.3head \ + TAILQ_FOREACH_REVERSE_SAFE.3head \ + TAILQ_FOREACH_SAFE.3head \ + TAILQ_HEAD.3head \ + TAILQ_HEAD_INITIALIZER.3head \ + TAILQ_INIT.3head \ + TAILQ_INSERT_AFTER.3head \ + TAILQ_INSERT_BEFORE.3head \ + TAILQ_INSERT_HEAD.3head \ + TAILQ_INSERT_TAIL.3head \ + TAILQ_LAST.3head \ + TAILQ_NEXT.3head \ + TAILQ_PREV.3head \ + TAILQ_REMOVE.3head \ + TAILQ_SWAP.3head + +MANLINKS += acct.3head \ aio.3head \ ar.3head \ archives.3head \ @@ -198,6 +289,95 @@ MANLINKS= acct.3head \ wordexp.3head \ xlocale.3head +LIST_CLASS_ENTRY.3head := LINKSRC = queue.h.3head +LIST_CLASS_HEAD.3head := LINKSRC = queue.h.3head +LIST_CONCAT.3head := LINKSRC = queue.h.3head +LIST_EMPTY.3head := LINKSRC = queue.h.3head +LIST_ENTRY.3head := LINKSRC = queue.h.3head +LIST_FIRST.3head := LINKSRC = queue.h.3head +LIST_FOREACH.3head := LINKSRC = queue.h.3head +LIST_FOREACH_FROM.3head := LINKSRC = queue.h.3head +LIST_FOREACH_FROM_SAFE.3head := LINKSRC = queue.h.3head +LIST_FOREACH_SAFE.3head := LINKSRC = queue.h.3head +LIST_HEAD.3head := LINKSRC = queue.h.3head +LIST_HEAD_INITIALIZER.3head := LINKSRC = queue.h.3head +LIST_INIT.3head := LINKSRC = queue.h.3head +LIST_INSERT_AFTER.3head := LINKSRC = queue.h.3head +LIST_INSERT_BEFORE.3head := LINKSRC = queue.h.3head +LIST_INSERT_HEAD.3head := LINKSRC = queue.h.3head +LIST_NEXT.3head := LINKSRC = queue.h.3head +LIST_PREV.3head := LINKSRC = queue.h.3head +LIST_REMOVE.3head := LINKSRC = queue.h.3head +LIST_SWAP.3head := LINKSRC = queue.h.3head +SLIST_CLASS_ENTRY.3head := LINKSRC = queue.h.3head +SLIST_CLASS_HEAD.3head := LINKSRC = queue.h.3head +SLIST_CONCAT.3head := LINKSRC = queue.h.3head +SLIST_EMPTY.3head := LINKSRC = queue.h.3head +SLIST_ENTRY.3head := LINKSRC = queue.h.3head +SLIST_FIRST.3head := LINKSRC = queue.h.3head +SLIST_FOREACH.3head := LINKSRC = queue.h.3head +SLIST_FOREACH_FROM.3head := LINKSRC = queue.h.3head +SLIST_FOREACH_FROM_SAFE.3head := LINKSRC = queue.h.3head +SLIST_FOREACH_SAFE.3head := LINKSRC = queue.h.3head +SLIST_HEAD.3head := LINKSRC = queue.h.3head +SLIST_HEAD_INITIALIZER.3head := LINKSRC = queue.h.3head +SLIST_INIT.3head := LINKSRC = queue.h.3head +SLIST_INSERT_AFTER.3head := LINKSRC = queue.h.3head +SLIST_INSERT_HEAD.3head := LINKSRC = queue.h.3head +SLIST_NEXT.3head := LINKSRC = queue.h.3head +SLIST_REMOVE.3head := LINKSRC = queue.h.3head +SLIST_REMOVE_AFTER.3head := LINKSRC = queue.h.3head +SLIST_REMOVE_HEAD.3head := LINKSRC = queue.h.3head +SLIST_SWAP.3head := LINKSRC = queue.h.3head +STAILQ_CLASS_ENTRY.3head := LINKSRC = queue.h.3head +STAILQ_CLASS_HEAD.3head := LINKSRC = queue.h.3head +STAILQ_CONCAT.3head := LINKSRC = queue.h.3head +STAILQ_EMPTY.3head := LINKSRC = queue.h.3head +STAILQ_ENTRY.3head := LINKSRC = queue.h.3head +STAILQ_FIRST.3head := LINKSRC = queue.h.3head +STAILQ_FOREACH.3head := LINKSRC = queue.h.3head +STAILQ_FOREACH_FROM.3head := LINKSRC = queue.h.3head +STAILQ_FOREACH_FROM_SAFE.3head := LINKSRC = queue.h.3head +STAILQ_FOREACH_SAFE.3head := LINKSRC = queue.h.3head +STAILQ_HEAD.3head := LINKSRC = queue.h.3head +STAILQ_HEAD_INITIALIZER.3head := LINKSRC = queue.h.3head +STAILQ_INIT.3head := LINKSRC = queue.h.3head +STAILQ_INSERT_AFTER.3head := LINKSRC = queue.h.3head +STAILQ_INSERT_HEAD.3head := LINKSRC = queue.h.3head +STAILQ_INSERT_TAIL.3head := LINKSRC = queue.h.3head +STAILQ_LAST.3head := LINKSRC = queue.h.3head +STAILQ_NEXT.3head := LINKSRC = queue.h.3head +STAILQ_REMOVE.3head := LINKSRC = queue.h.3head +STAILQ_REMOVE_AFTER.3head := LINKSRC = queue.h.3head +STAILQ_REMOVE_HEAD.3head := LINKSRC = queue.h.3head +STAILQ_SWAP.3head := LINKSRC = queue.h.3head +TAILQ_CLASS_ENTRY.3head := LINKSRC = queue.h.3head +TAILQ_CLASS_HEAD.3head := LINKSRC = queue.h.3head +TAILQ_CONCAT.3head := LINKSRC = queue.h.3head +TAILQ_EMPTY.3head := LINKSRC = queue.h.3head +TAILQ_ENTRY.3head := LINKSRC = queue.h.3head +TAILQ_FIRST.3head := LINKSRC = queue.h.3head +TAILQ_FOREACH.3head := LINKSRC = queue.h.3head +TAILQ_FOREACH_FROM.3head := LINKSRC = queue.h.3head +TAILQ_FOREACH_FROM_SAFE.3head := LINKSRC = queue.h.3head +TAILQ_FOREACH_REVERSE.3head := LINKSRC = queue.h.3head +TAILQ_FOREACH_REVERSE_FROM.3head := LINKSRC = queue.h.3head +TAILQ_FOREACH_REVERSE_FROM_SAFE.3head := LINKSRC = queue.h.3head +TAILQ_FOREACH_REVERSE_SAFE.3head := LINKSRC = queue.h.3head +TAILQ_FOREACH_SAFE.3head := LINKSRC = queue.h.3head +TAILQ_HEAD.3head := LINKSRC = queue.h.3head +TAILQ_HEAD_INITIALIZER.3head := LINKSRC = queue.h.3head +TAILQ_INIT.3head := LINKSRC = queue.h.3head +TAILQ_INSERT_AFTER.3head := LINKSRC = queue.h.3head +TAILQ_INSERT_BEFORE.3head := LINKSRC = queue.h.3head +TAILQ_INSERT_HEAD.3head := LINKSRC = queue.h.3head +TAILQ_INSERT_TAIL.3head := LINKSRC = queue.h.3head +TAILQ_LAST.3head := LINKSRC = queue.h.3head +TAILQ_NEXT.3head := LINKSRC = queue.h.3head +TAILQ_PREV.3head := LINKSRC = queue.h.3head +TAILQ_REMOVE.3head := LINKSRC = queue.h.3head +TAILQ_SWAP.3head := LINKSRC = queue.h.3head + acct.3head := LINKSRC = acct.h.3head aio.3head := LINKSRC = aio.h.3head ar.3head := LINKSRC = ar.h.3head diff --git a/usr/src/man/man3head/queue.h.3head b/usr/src/man/man3head/queue.h.3head new file mode 100644 index 0000000000..b55170ea5b --- /dev/null +++ b/usr/src/man/man3head/queue.h.3head @@ -0,0 +1,1315 @@ +.\" Copyright (c) 1993 +.\" The Regents of the University of California. All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. Neither the name of the University nor the names of its contributors +.\" may be used to endorse or promote products derived from this software +.\" without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" @(#)queue.3 8.2 (Berkeley) 1/24/94 +.\" +.Dd August 6, 2018 +.Dt QUEUE.H 3HEAD +.Os +.Sh NAME +.Nm SLIST_CLASS_ENTRY , +.Nm SLIST_CLASS_HEAD , +.Nm SLIST_CONCAT , +.Nm SLIST_EMPTY , +.Nm SLIST_ENTRY , +.Nm SLIST_FIRST , +.Nm SLIST_FOREACH , +.Nm SLIST_FOREACH_FROM , +.Nm SLIST_FOREACH_FROM_SAFE , +.Nm SLIST_FOREACH_SAFE , +.Nm SLIST_HEAD , +.Nm SLIST_HEAD_INITIALIZER , +.Nm SLIST_INIT , +.Nm SLIST_INSERT_AFTER , +.Nm SLIST_INSERT_HEAD , +.Nm SLIST_NEXT , +.Nm SLIST_REMOVE , +.Nm SLIST_REMOVE_AFTER , +.Nm SLIST_REMOVE_HEAD , +.Nm SLIST_SWAP , +.Nm STAILQ_CLASS_ENTRY , +.Nm STAILQ_CLASS_HEAD , +.Nm STAILQ_CONCAT , +.Nm STAILQ_EMPTY , +.Nm STAILQ_ENTRY , +.Nm STAILQ_FIRST , +.Nm STAILQ_FOREACH , +.Nm STAILQ_FOREACH_FROM , +.Nm STAILQ_FOREACH_FROM_SAFE , +.Nm STAILQ_FOREACH_SAFE , +.Nm STAILQ_HEAD , +.Nm STAILQ_HEAD_INITIALIZER , +.Nm STAILQ_INIT , +.Nm STAILQ_INSERT_AFTER , +.Nm STAILQ_INSERT_HEAD , +.Nm STAILQ_INSERT_TAIL , +.Nm STAILQ_LAST , +.Nm STAILQ_NEXT , +.Nm STAILQ_REMOVE , +.Nm STAILQ_REMOVE_AFTER , +.Nm STAILQ_REMOVE_HEAD , +.Nm STAILQ_SWAP , +.Nm LIST_CLASS_ENTRY , +.Nm LIST_CLASS_HEAD , +.Nm LIST_CONCAT , +.Nm LIST_EMPTY , +.Nm LIST_ENTRY , +.Nm LIST_FIRST , +.Nm LIST_FOREACH , +.Nm LIST_FOREACH_FROM , +.Nm LIST_FOREACH_FROM_SAFE , +.Nm LIST_FOREACH_SAFE , +.Nm LIST_HEAD , +.Nm LIST_HEAD_INITIALIZER , +.Nm LIST_INIT , +.Nm LIST_INSERT_AFTER , +.Nm LIST_INSERT_BEFORE , +.Nm LIST_INSERT_HEAD , +.Nm LIST_NEXT , +.Nm LIST_PREV , +.Nm LIST_REMOVE , +.Nm LIST_SWAP , +.Nm TAILQ_CLASS_ENTRY , +.Nm TAILQ_CLASS_HEAD , +.Nm TAILQ_CONCAT , +.Nm TAILQ_EMPTY , +.Nm TAILQ_ENTRY , +.Nm TAILQ_FIRST , +.Nm TAILQ_FOREACH , +.Nm TAILQ_FOREACH_FROM , +.Nm TAILQ_FOREACH_FROM_SAFE , +.Nm TAILQ_FOREACH_REVERSE , +.Nm TAILQ_FOREACH_REVERSE_FROM , +.Nm TAILQ_FOREACH_REVERSE_FROM_SAFE , +.Nm TAILQ_FOREACH_REVERSE_SAFE , +.Nm TAILQ_FOREACH_SAFE , +.Nm TAILQ_HEAD , +.Nm TAILQ_HEAD_INITIALIZER , +.Nm TAILQ_INIT , +.Nm TAILQ_INSERT_AFTER , +.Nm TAILQ_INSERT_BEFORE , +.Nm TAILQ_INSERT_HEAD , +.Nm TAILQ_INSERT_TAIL , +.Nm TAILQ_LAST , +.Nm TAILQ_NEXT , +.Nm TAILQ_PREV , +.Nm TAILQ_REMOVE , +.Nm TAILQ_SWAP +.Nd implementations of singly-linked lists, singly-linked tail queues, +lists and tail queues +.Sh SYNOPSIS +.In sys/queue.h +.\" +.Fn SLIST_CLASS_ENTRY "CLASSTYPE" +.Fn SLIST_CLASS_HEAD "HEADNAME" "CLASSTYPE" +.Fn SLIST_CONCAT "SLIST_HEAD *head1" "SLIST_HEAD *head2" "TYPE" "SLIST_ENTRY NAME" +.Fn SLIST_EMPTY "SLIST_HEAD *head" +.Fn SLIST_ENTRY "TYPE" +.Fn SLIST_FIRST "SLIST_HEAD *head" +.Fn SLIST_FOREACH "TYPE *var" "SLIST_HEAD *head" "SLIST_ENTRY NAME" +.Fn SLIST_FOREACH_FROM "TYPE *var" "SLIST_HEAD *head" "SLIST_ENTRY NAME" +.Fn SLIST_FOREACH_FROM_SAFE "TYPE *var" "SLIST_HEAD *head" "SLIST_ENTRY NAME" "TYPE *temp_var" +.Fn SLIST_FOREACH_SAFE "TYPE *var" "SLIST_HEAD *head" "SLIST_ENTRY NAME" "TYPE *temp_var" +.Fn SLIST_HEAD "HEADNAME" "TYPE" +.Fn SLIST_HEAD_INITIALIZER "SLIST_HEAD head" +.Fn SLIST_INIT "SLIST_HEAD *head" +.Fn SLIST_INSERT_AFTER "TYPE *listelm" "TYPE *elm" "SLIST_ENTRY NAME" +.Fn SLIST_INSERT_HEAD "SLIST_HEAD *head" "TYPE *elm" "SLIST_ENTRY NAME" +.Fn SLIST_NEXT "TYPE *elm" "SLIST_ENTRY NAME" +.Fn SLIST_REMOVE "SLIST_HEAD *head" "TYPE *elm" "TYPE" "SLIST_ENTRY NAME" +.Fn SLIST_REMOVE_AFTER "TYPE *elm" "SLIST_ENTRY NAME" +.Fn SLIST_REMOVE_HEAD "SLIST_HEAD *head" "SLIST_ENTRY NAME" +.Fn SLIST_SWAP "SLIST_HEAD *head1" "SLIST_HEAD *head2" "TYPE" +.\" +.Fn STAILQ_CLASS_ENTRY "CLASSTYPE" +.Fn STAILQ_CLASS_HEAD "HEADNAME" "CLASSTYPE" +.Fn STAILQ_CONCAT "STAILQ_HEAD *head1" "STAILQ_HEAD *head2" +.Fn STAILQ_EMPTY "STAILQ_HEAD *head" +.Fn STAILQ_ENTRY "TYPE" +.Fn STAILQ_FIRST "STAILQ_HEAD *head" +.Fn STAILQ_FOREACH "TYPE *var" "STAILQ_HEAD *head" "STAILQ_ENTRY NAME" +.Fn STAILQ_FOREACH_FROM "TYPE *var" "STAILQ_HEAD *head" "STAILQ_ENTRY NAME" +.Fn STAILQ_FOREACH_FROM_SAFE "TYPE *var" "STAILQ_HEAD *head" "STAILQ_ENTRY NAME" "TYPE *temp_var" +.Fn STAILQ_FOREACH_SAFE "TYPE *var" "STAILQ_HEAD *head" "STAILQ_ENTRY NAME" "TYPE *temp_var" +.Fn STAILQ_HEAD "HEADNAME" "TYPE" +.Fn STAILQ_HEAD_INITIALIZER "STAILQ_HEAD head" +.Fn STAILQ_INIT "STAILQ_HEAD *head" +.Fn STAILQ_INSERT_AFTER "STAILQ_HEAD *head" "TYPE *listelm" "TYPE *elm" "STAILQ_ENTRY NAME" +.Fn STAILQ_INSERT_HEAD "STAILQ_HEAD *head" "TYPE *elm" "STAILQ_ENTRY NAME" +.Fn STAILQ_INSERT_TAIL "STAILQ_HEAD *head" "TYPE *elm" "STAILQ_ENTRY NAME" +.Fn STAILQ_LAST "STAILQ_HEAD *head" "TYPE *elm" "STAILQ_ENTRY NAME" +.Fn STAILQ_NEXT "TYPE *elm" "STAILQ_ENTRY NAME" +.Fn STAILQ_REMOVE "STAILQ_HEAD *head" "TYPE *elm" "TYPE" "STAILQ_ENTRY NAME" +.Fn STAILQ_REMOVE_AFTER "STAILQ_HEAD *head" "TYPE *elm" "STAILQ_ENTRY NAME" +.Fn STAILQ_REMOVE_HEAD "STAILQ_HEAD *head" "STAILQ_ENTRY NAME" +.Fn STAILQ_SWAP "STAILQ_HEAD *head1" "STAILQ_HEAD *head2" "TYPE" +.\" +.Fn LIST_CLASS_ENTRY "CLASSTYPE" +.Fn LIST_CLASS_HEAD "HEADNAME" "CLASSTYPE" +.Fn LIST_CONCAT "LIST_HEAD *head1" "LIST_HEAD *head2" "TYPE" "LIST_ENTRY NAME" +.Fn LIST_EMPTY "LIST_HEAD *head" +.Fn LIST_ENTRY "TYPE" +.Fn LIST_FIRST "LIST_HEAD *head" +.Fn LIST_FOREACH "TYPE *var" "LIST_HEAD *head" "LIST_ENTRY NAME" +.Fn LIST_FOREACH_FROM "TYPE *var" "LIST_HEAD *head" "LIST_ENTRY NAME" +.Fn LIST_FOREACH_FROM_SAFE "TYPE *var" "LIST_HEAD *head" "LIST_ENTRY NAME" "TYPE *temp_var" +.Fn LIST_FOREACH_SAFE "TYPE *var" "LIST_HEAD *head" "LIST_ENTRY NAME" "TYPE *temp_var" +.Fn LIST_HEAD "HEADNAME" "TYPE" +.Fn LIST_HEAD_INITIALIZER "LIST_HEAD head" +.Fn LIST_INIT "LIST_HEAD *head" +.Fn LIST_INSERT_AFTER "TYPE *listelm" "TYPE *elm" "LIST_ENTRY NAME" +.Fn LIST_INSERT_BEFORE "TYPE *listelm" "TYPE *elm" "LIST_ENTRY NAME" +.Fn LIST_INSERT_HEAD "LIST_HEAD *head" "TYPE *elm" "LIST_ENTRY NAME" +.Fn LIST_NEXT "TYPE *elm" "LIST_ENTRY NAME" +.Fn LIST_PREV "TYPE *elm" "LIST_HEAD *head" "TYPE" "LIST_ENTRY NAME" +.Fn LIST_REMOVE "TYPE *elm" "LIST_ENTRY NAME" +.Fn LIST_SWAP "LIST_HEAD *head1" "LIST_HEAD *head2" "TYPE" "LIST_ENTRY NAME" +.\" +.Fn TAILQ_CLASS_ENTRY "CLASSTYPE" +.Fn TAILQ_CLASS_HEAD "HEADNAME" "CLASSTYPE" +.Fn TAILQ_CONCAT "TAILQ_HEAD *head1" "TAILQ_HEAD *head2" "TAILQ_ENTRY NAME" +.Fn TAILQ_EMPTY "TAILQ_HEAD *head" +.Fn TAILQ_ENTRY "TYPE" +.Fn TAILQ_FIRST "TAILQ_HEAD *head" +.Fn TAILQ_FOREACH "TYPE *var" "TAILQ_HEAD *head" "TAILQ_ENTRY NAME" +.Fn TAILQ_FOREACH_FROM "TYPE *var" "TAILQ_HEAD *head" "TAILQ_ENTRY NAME" +.Fn TAILQ_FOREACH_FROM_SAFE "TYPE *var" "TAILQ_HEAD *head" "TAILQ_ENTRY NAME" "TYPE *temp_var" +.Fn TAILQ_FOREACH_REVERSE "TYPE *var" "TAILQ_HEAD *head" "HEADNAME" "TAILQ_ENTRY NAME" +.Fn TAILQ_FOREACH_REVERSE_FROM "TYPE *var" "TAILQ_HEAD *head" "HEADNAME" "TAILQ_ENTRY NAME" +.Fn TAILQ_FOREACH_REVERSE_FROM_SAFE "TYPE *var" "TAILQ_HEAD *head" "HEADNAME" "TAILQ_ENTRY NAME" "TYPE *temp_var" +.Fn TAILQ_FOREACH_REVERSE_SAFE "TYPE *var" "TAILQ_HEAD *head" "HEADNAME" "TAILQ_ENTRY NAME" "TYPE *temp_var" +.Fn TAILQ_FOREACH_SAFE "TYPE *var" "TAILQ_HEAD *head" "TAILQ_ENTRY NAME" "TYPE *temp_var" +.Fn TAILQ_HEAD "HEADNAME" "TYPE" +.Fn TAILQ_HEAD_INITIALIZER "TAILQ_HEAD head" +.Fn TAILQ_INIT "TAILQ_HEAD *head" +.Fn TAILQ_INSERT_AFTER "TAILQ_HEAD *head" "TYPE *listelm" "TYPE *elm" "TAILQ_ENTRY NAME" +.Fn TAILQ_INSERT_BEFORE "TYPE *listelm" "TYPE *elm" "TAILQ_ENTRY NAME" +.Fn TAILQ_INSERT_HEAD "TAILQ_HEAD *head" "TYPE *elm" "TAILQ_ENTRY NAME" +.Fn TAILQ_INSERT_TAIL "TAILQ_HEAD *head" "TYPE *elm" "TAILQ_ENTRY NAME" +.Fn TAILQ_LAST "TAILQ_HEAD *head" "HEADNAME" +.Fn TAILQ_NEXT "TYPE *elm" "TAILQ_ENTRY NAME" +.Fn TAILQ_PREV "TYPE *elm" "HEADNAME" "TAILQ_ENTRY NAME" +.Fn TAILQ_REMOVE "TAILQ_HEAD *head" "TYPE *elm" "TAILQ_ENTRY NAME" +.Fn TAILQ_SWAP "TAILQ_HEAD *head1" "TAILQ_HEAD *head2" "TYPE" "TAILQ_ENTRY NAME" +.\" +.Sh DESCRIPTION +These macros define and operate on four types of data structures which +can be used in both C and C++ source code: +.Bl -enum -compact -offset indent +.It +Lists +.It +Singly-linked lists +.It +Singly-linked tail queues +.It +Tail queues +.El +All four structures support the following functionality: +.Bl -enum -compact -offset indent +.It +Insertion of a new entry at the head of the list. +.It +Insertion of a new entry after any element in the list. +.It +O(1) removal of an entry from the head of the list. +.It +Forward traversal through the list. +.It +Swapping the contents of two lists. +.El +.Pp +Singly-linked lists are the simplest of the four data structures +and support only the above functionality. +Singly-linked lists are ideal for applications with large datasets +and few or no removals, +or for implementing a LIFO queue. +Singly-linked lists add the following functionality: +.Bl -enum -compact -offset indent +.It +O(n) removal of any entry in the list. +.It +O(n) concatenation of two lists. +.El +.Pp +Singly-linked tail queues add the following functionality: +.Bl -enum -compact -offset indent +.It +Entries can be added at the end of a list. +.It +O(n) removal of any entry in the list. +.It +They may be concatenated. +.El +However: +.Bl -enum -compact -offset indent +.It +All list insertions must specify the head of the list. +.It +Each head entry requires two pointers rather than one. +.It +Code size is about 15% greater and operations run about 20% slower +than singly-linked lists. +.El +.Pp +Singly-linked tail queues are ideal for applications with large datasets and +few or no removals, +or for implementing a FIFO queue. +.Pp +All doubly linked types of data structures (lists and tail queues) +additionally allow: +.Bl -enum -compact -offset indent +.It +Insertion of a new entry before any element in the list. +.It +O(1) removal of any entry in the list. +.El +However: +.Bl -enum -compact -offset indent +.It +Each element requires two pointers rather than one. +.It +Code size and execution time of operations (except for removal) is about +twice that of the singly-linked data-structures. +.El +.Pp +Linked lists are the simplest of the doubly linked data structures. +They add the following functionality over the above: +.Bl -enum -compact -offset indent +.It +O(n) concatenation of two lists. +.It +They may be traversed backwards. +.El +However: +.Bl -enum -compact -offset indent +.It +To traverse backwards, an entry to begin the traversal and the list in +which it is contained must be specified. +.El +.Pp +Tail queues add the following functionality: +.Bl -enum -compact -offset indent +.It +Entries can be added at the end of a list. +.It +They may be traversed backwards, from tail to head. +.It +They may be concatenated. +.El +However: +.Bl -enum -compact -offset indent +.It +All list insertions and removals must specify the head of the list. +.It +Each head entry requires two pointers rather than one. +.It +Code size is about 15% greater and operations run about 20% slower +than singly-linked lists. +.El +.Pp +In the macro definitions, +.Fa TYPE +is the name of a user defined structure. +The structure must contain a field called +.Fa NAME +which is of type +.Li SLIST_ENTRY , +.Li STAILQ_ENTRY , +.Li LIST_ENTRY , +or +.Li TAILQ_ENTRY . +In the macro definitions, +.Fa CLASSTYPE +is the name of a user defined class. +The class must contain a field called +.Fa NAME +which is of type +.Li SLIST_CLASS_ENTRY , +.Li STAILQ_CLASS_ENTRY , +.Li LIST_CLASS_ENTRY , +or +.Li TAILQ_CLASS_ENTRY . +The argument +.Fa HEADNAME +is the name of a user defined structure that must be declared +using the macros +.Li SLIST_HEAD , +.Li SLIST_CLASS_HEAD , +.Li STAILQ_HEAD , +.Li STAILQ_CLASS_HEAD , +.Li LIST_HEAD , +.Li LIST_CLASS_HEAD , +.Li TAILQ_HEAD , +or +.Li TAILQ_CLASS_HEAD . +See the examples below for further explanation of how these +macros are used. +.Sh SINGLY-LINKED LISTS +A singly-linked list is headed by a structure defined by the +.Nm SLIST_HEAD +macro. +This structure contains a single pointer to the first element +on the list. +The elements are singly linked for minimum space and pointer manipulation +overhead at the expense of O(n) removal for arbitrary elements. +New elements can be added to the list after an existing element or +at the head of the list. +An +.Fa SLIST_HEAD +structure is declared as follows: +.Bd -literal -offset indent +SLIST_HEAD(HEADNAME, TYPE) head; +.Ed +.Pp +where +.Fa HEADNAME +is the name of the structure to be defined, and +.Fa TYPE +is the type of the elements to be linked into the list. +A pointer to the head of the list can later be declared as: +.Bd -literal -offset indent +struct HEADNAME *headp; +.Ed +.Pp +(The names +.Li head +and +.Li headp +are user selectable.) +.Pp +The macro +.Nm SLIST_HEAD_INITIALIZER +evaluates to an initializer for the list +.Fa head . +.Pp +The macro +.Nm SLIST_CONCAT +concatenates the list headed by +.Fa head2 +onto the end of the one headed by +.Fa head1 +removing all entries from the former. +Use of this macro should be avoided as it traverses the entirety of the +.Fa head1 +list. +A singly-linked tail queue should be used if this macro is needed in +high-usage code paths or to operate on long lists. +.Pp +The macro +.Nm SLIST_EMPTY +evaluates to true if there are no elements in the list. +.Pp +The macro +.Nm SLIST_ENTRY +declares a structure that connects the elements in +the list. +.Pp +The macro +.Nm SLIST_FIRST +returns the first element in the list or NULL if the list is empty. +.Pp +The macro +.Nm SLIST_FOREACH +traverses the list referenced by +.Fa head +in the forward direction, assigning each element in +turn to +.Fa var . +.Pp +The macro +.Nm SLIST_FOREACH_FROM +behaves identically to +.Nm SLIST_FOREACH +when +.Fa var +is NULL, else it treats +.Fa var +as a previously found SLIST element and begins the loop at +.Fa var +instead of the first element in the SLIST referenced by +.Fa head . +.Pp +The macro +.Nm SLIST_FOREACH_SAFE +traverses the list referenced by +.Fa head +in the forward direction, assigning each element in +turn to +.Fa var . +However, unlike +.Fn SLIST_FOREACH +here it is permitted to both remove +.Fa var +as well as free it from within the loop safely without interfering with the +traversal. +.Pp +The macro +.Nm SLIST_FOREACH_FROM_SAFE +behaves identically to +.Nm SLIST_FOREACH_SAFE +when +.Fa var +is NULL, else it treats +.Fa var +as a previously found SLIST element and begins the loop at +.Fa var +instead of the first element in the SLIST referenced by +.Fa head . +.Pp +The macro +.Nm SLIST_INIT +initializes the list referenced by +.Fa head . +.Pp +The macro +.Nm SLIST_INSERT_HEAD +inserts the new element +.Fa elm +at the head of the list. +.Pp +The macro +.Nm SLIST_INSERT_AFTER +inserts the new element +.Fa elm +after the element +.Fa listelm . +.Pp +The macro +.Nm SLIST_NEXT +returns the next element in the list. +.Pp +The macro +.Nm SLIST_REMOVE_AFTER +removes the element after +.Fa elm +from the list. +Unlike +.Fa SLIST_REMOVE , +this macro does not traverse the entire list. +.Pp +The macro +.Nm SLIST_REMOVE_HEAD +removes the element +.Fa elm +from the head of the list. +For optimum efficiency, +elements being removed from the head of the list should explicitly use +this macro instead of the generic +.Fa SLIST_REMOVE +macro. +.Pp +The macro +.Nm SLIST_REMOVE +removes the element +.Fa elm +from the list. +Use of this macro should be avoided as it traverses the entire list. +A doubly-linked list should be used if this macro is needed in +high-usage code paths or to operate on long lists. +.Pp +The macro +.Nm SLIST_SWAP +swaps the contents of +.Fa head1 +and +.Fa head2 . +.Sh SINGLY-LINKED TAIL QUEUES +A singly-linked tail queue is headed by a structure defined by the +.Nm STAILQ_HEAD +macro. +This structure contains a pair of pointers, +one to the first element in the tail queue and the other to +the last element in the tail queue. +The elements are singly linked for minimum space and pointer +manipulation overhead at the expense of O(n) removal for arbitrary +elements. +New elements can be added to the tail queue after an existing element, +at the head of the tail queue, or at the end of the tail queue. +A +.Fa STAILQ_HEAD +structure is declared as follows: +.Bd -literal -offset indent +STAILQ_HEAD(HEADNAME, TYPE) head; +.Ed +.Pp +where +.Li HEADNAME +is the name of the structure to be defined, and +.Li TYPE +is the type of the elements to be linked into the tail queue. +A pointer to the head of the tail queue can later be declared as: +.Bd -literal -offset indent +struct HEADNAME *headp; +.Ed +.Pp +(The names +.Li head +and +.Li headp +are user selectable.) +.Pp +The macro +.Nm STAILQ_HEAD_INITIALIZER +evaluates to an initializer for the tail queue +.Fa head . +.Pp +The macro +.Nm STAILQ_CONCAT +concatenates the tail queue headed by +.Fa head2 +onto the end of the one headed by +.Fa head1 +removing all entries from the former. +.Pp +The macro +.Nm STAILQ_EMPTY +evaluates to true if there are no items on the tail queue. +.Pp +The macro +.Nm STAILQ_ENTRY +declares a structure that connects the elements in +the tail queue. +.Pp +The macro +.Nm STAILQ_FIRST +returns the first item on the tail queue or NULL if the tail queue +is empty. +.Pp +The macro +.Nm STAILQ_FOREACH +traverses the tail queue referenced by +.Fa head +in the forward direction, assigning each element +in turn to +.Fa var . +.Pp +The macro +.Nm STAILQ_FOREACH_FROM +behaves identically to +.Nm STAILQ_FOREACH +when +.Fa var +is NULL, else it treats +.Fa var +as a previously found STAILQ element and begins the loop at +.Fa var +instead of the first element in the STAILQ referenced by +.Fa head . +.Pp +The macro +.Nm STAILQ_FOREACH_SAFE +traverses the tail queue referenced by +.Fa head +in the forward direction, assigning each element +in turn to +.Fa var . +However, unlike +.Fn STAILQ_FOREACH +here it is permitted to both remove +.Fa var +as well as free it from within the loop safely without interfering with the +traversal. +.Pp +The macro +.Nm STAILQ_FOREACH_FROM_SAFE +behaves identically to +.Nm STAILQ_FOREACH_SAFE +when +.Fa var +is NULL, else it treats +.Fa var +as a previously found STAILQ element and begins the loop at +.Fa var +instead of the first element in the STAILQ referenced by +.Fa head . +.Pp +The macro +.Nm STAILQ_INIT +initializes the tail queue referenced by +.Fa head . +.Pp +The macro +.Nm STAILQ_INSERT_HEAD +inserts the new element +.Fa elm +at the head of the tail queue. +.Pp +The macro +.Nm STAILQ_INSERT_TAIL +inserts the new element +.Fa elm +at the end of the tail queue. +.Pp +The macro +.Nm STAILQ_INSERT_AFTER +inserts the new element +.Fa elm +after the element +.Fa listelm . +.Pp +The macro +.Nm STAILQ_LAST +returns the last item on the tail queue. +If the tail queue is empty the return value is +.Dv NULL . +.Pp +The macro +.Nm STAILQ_NEXT +returns the next item on the tail queue, or NULL this item is the last. +.Pp +The macro +.Nm STAILQ_REMOVE_AFTER +removes the element after +.Fa elm +from the tail queue. +Unlike +.Fa STAILQ_REMOVE , +this macro does not traverse the entire tail queue. +.Pp +The macro +.Nm STAILQ_REMOVE_HEAD +removes the element at the head of the tail queue. +For optimum efficiency, +elements being removed from the head of the tail queue should +use this macro explicitly rather than the generic +.Fa STAILQ_REMOVE +macro. +.Pp +The macro +.Nm STAILQ_REMOVE +removes the element +.Fa elm +from the tail queue. +Use of this macro should be avoided as it traverses the entire list. +A doubly-linked tail queue should be used if this macro is needed in +high-usage code paths or to operate on long tail queues. +.Pp +The macro +.Nm STAILQ_SWAP +swaps the contents of +.Fa head1 +and +.Fa head2 . +.Sh LISTS +A list is headed by a structure defined by the +.Nm LIST_HEAD +macro. +This structure contains a single pointer to the first element +on the list. +The elements are doubly linked so that an arbitrary element can be +removed without traversing the list. +New elements can be added to the list after an existing element, +before an existing element, or at the head of the list. +A +.Fa LIST_HEAD +structure is declared as follows: +.Bd -literal -offset indent +LIST_HEAD(HEADNAME, TYPE) head; +.Ed +.Pp +where +.Fa HEADNAME +is the name of the structure to be defined, and +.Fa TYPE +is the type of the elements to be linked into the list. +A pointer to the head of the list can later be declared as: +.Bd -literal -offset indent +struct HEADNAME *headp; +.Ed +.Pp +(The names +.Li head +and +.Li headp +are user selectable.) +.Pp +The macro +.Nm LIST_HEAD_INITIALIZER +evaluates to an initializer for the list +.Fa head . +.Pp +The macro +.Nm LIST_CONCAT +concatenates the list headed by +.Fa head2 +onto the end of the one headed by +.Fa head1 +removing all entries from the former. +Use of this macro should be avoided as it traverses the entirety of the +.Fa head1 +list. +A tail queue should be used if this macro is needed in +high-usage code paths or to operate on long lists. +.Pp +The macro +.Nm LIST_EMPTY +evaluates to true if there are no elements in the list. +.Pp +The macro +.Nm LIST_ENTRY +declares a structure that connects the elements in +the list. +.Pp +The macro +.Nm LIST_FIRST +returns the first element in the list or NULL if the list +is empty. +.Pp +The macro +.Nm LIST_FOREACH +traverses the list referenced by +.Fa head +in the forward direction, assigning each element in turn to +.Fa var . +.Pp +The macro +.Nm LIST_FOREACH_FROM +behaves identically to +.Nm LIST_FOREACH +when +.Fa var +is NULL, else it treats +.Fa var +as a previously found LIST element and begins the loop at +.Fa var +instead of the first element in the LIST referenced by +.Fa head . +.Pp +The macro +.Nm LIST_FOREACH_SAFE +traverses the list referenced by +.Fa head +in the forward direction, assigning each element in turn to +.Fa var . +However, unlike +.Fn LIST_FOREACH +here it is permitted to both remove +.Fa var +as well as free it from within the loop safely without interfering with the +traversal. +.Pp +The macro +.Nm LIST_FOREACH_FROM_SAFE +behaves identically to +.Nm LIST_FOREACH_SAFE +when +.Fa var +is NULL, else it treats +.Fa var +as a previously found LIST element and begins the loop at +.Fa var +instead of the first element in the LIST referenced by +.Fa head . +.Pp +The macro +.Nm LIST_INIT +initializes the list referenced by +.Fa head . +.Pp +The macro +.Nm LIST_INSERT_HEAD +inserts the new element +.Fa elm +at the head of the list. +.Pp +The macro +.Nm LIST_INSERT_AFTER +inserts the new element +.Fa elm +after the element +.Fa listelm . +.Pp +The macro +.Nm LIST_INSERT_BEFORE +inserts the new element +.Fa elm +before the element +.Fa listelm . +.Pp +The macro +.Nm LIST_NEXT +returns the next element in the list, or NULL if this is the last. +.Pp +The macro +.Nm LIST_PREV +returns the previous element in the list, or NULL if this is the first. +List +.Fa head +must contain element +.Fa elm . +.Pp +The macro +.Nm LIST_REMOVE +removes the element +.Fa elm +from the list. +.Pp +The macro +.Nm LIST_SWAP +swaps the contents of +.Fa head1 +and +.Fa head2 . +.Sh TAIL QUEUES +A tail queue is headed by a structure defined by the +.Nm TAILQ_HEAD +macro. +This structure contains a pair of pointers, +one to the first element in the tail queue and the other to +the last element in the tail queue. +The elements are doubly linked so that an arbitrary element can be +removed without traversing the tail queue. +New elements can be added to the tail queue after an existing element, +before an existing element, at the head of the tail queue, +or at the end of the tail queue. +A +.Fa TAILQ_HEAD +structure is declared as follows: +.Bd -literal -offset indent +TAILQ_HEAD(HEADNAME, TYPE) head; +.Ed +.Pp +where +.Li HEADNAME +is the name of the structure to be defined, and +.Li TYPE +is the type of the elements to be linked into the tail queue. +A pointer to the head of the tail queue can later be declared as: +.Bd -literal -offset indent +struct HEADNAME *headp; +.Ed +.Pp +(The names +.Li head +and +.Li headp +are user selectable.) +.Pp +The macro +.Nm TAILQ_HEAD_INITIALIZER +evaluates to an initializer for the tail queue +.Fa head . +.Pp +The macro +.Nm TAILQ_CONCAT +concatenates the tail queue headed by +.Fa head2 +onto the end of the one headed by +.Fa head1 +removing all entries from the former. +.Pp +The macro +.Nm TAILQ_EMPTY +evaluates to true if there are no items on the tail queue. +.Pp +The macro +.Nm TAILQ_ENTRY +declares a structure that connects the elements in +the tail queue. +.Pp +The macro +.Nm TAILQ_FIRST +returns the first item on the tail queue or NULL if the tail queue +is empty. +.Pp +The macro +.Nm TAILQ_FOREACH +traverses the tail queue referenced by +.Fa head +in the forward direction, assigning each element in turn to +.Fa var . +.Fa var +is set to +.Dv NULL +if the loop completes normally, or if there were no elements. +.Pp +The macro +.Nm TAILQ_FOREACH_FROM +behaves identically to +.Nm TAILQ_FOREACH +when +.Fa var +is NULL, else it treats +.Fa var +as a previously found TAILQ element and begins the loop at +.Fa var +instead of the first element in the TAILQ referenced by +.Fa head . +.Pp +The macro +.Nm TAILQ_FOREACH_REVERSE +traverses the tail queue referenced by +.Fa head +in the reverse direction, assigning each element in turn to +.Fa var . +.Pp +The macro +.Nm TAILQ_FOREACH_REVERSE_FROM +behaves identically to +.Nm TAILQ_FOREACH_REVERSE +when +.Fa var +is NULL, else it treats +.Fa var +as a previously found TAILQ element and begins the reverse loop at +.Fa var +instead of the last element in the TAILQ referenced by +.Fa head . +.Pp +The macros +.Nm TAILQ_FOREACH_SAFE +and +.Nm TAILQ_FOREACH_REVERSE_SAFE +traverse the list referenced by +.Fa head +in the forward or reverse direction respectively, +assigning each element in turn to +.Fa var . +However, unlike their unsafe counterparts, +.Nm TAILQ_FOREACH +and +.Nm TAILQ_FOREACH_REVERSE +permit to both remove +.Fa var +as well as free it from within the loop safely without interfering with the +traversal. +.Pp +The macro +.Nm TAILQ_FOREACH_FROM_SAFE +behaves identically to +.Nm TAILQ_FOREACH_SAFE +when +.Fa var +is NULL, else it treats +.Fa var +as a previously found TAILQ element and begins the loop at +.Fa var +instead of the first element in the TAILQ referenced by +.Fa head . +.Pp +The macro +.Nm TAILQ_FOREACH_REVERSE_FROM_SAFE +behaves identically to +.Nm TAILQ_FOREACH_REVERSE_SAFE +when +.Fa var +is NULL, else it treats +.Fa var +as a previously found TAILQ element and begins the reverse loop at +.Fa var +instead of the last element in the TAILQ referenced by +.Fa head . +.Pp +The macro +.Nm TAILQ_INIT +initializes the tail queue referenced by +.Fa head . +.Pp +The macro +.Nm TAILQ_INSERT_HEAD +inserts the new element +.Fa elm +at the head of the tail queue. +.Pp +The macro +.Nm TAILQ_INSERT_TAIL +inserts the new element +.Fa elm +at the end of the tail queue. +.Pp +The macro +.Nm TAILQ_INSERT_AFTER +inserts the new element +.Fa elm +after the element +.Fa listelm . +.Pp +The macro +.Nm TAILQ_INSERT_BEFORE +inserts the new element +.Fa elm +before the element +.Fa listelm . +.Pp +The macro +.Nm TAILQ_LAST +returns the last item on the tail queue. +If the tail queue is empty the return value is +.Dv NULL . +.Pp +The macro +.Nm TAILQ_NEXT +returns the next item on the tail queue, or NULL if this item is the last. +.Pp +The macro +.Nm TAILQ_PREV +returns the previous item on the tail queue, or NULL if this item +is the first. +.Pp +The macro +.Nm TAILQ_REMOVE +removes the element +.Fa elm +from the tail queue. +.Pp +The macro +.Nm TAILQ_SWAP +swaps the contents of +.Fa head1 +and +.Fa head2 . +.Sh EXAMPLES +.Ss SINGLY-LINKED LIST EXAMPLE +.Bd -literal +SLIST_HEAD(slisthead, entry) head = + SLIST_HEAD_INITIALIZER(head); +struct slisthead *headp; /* Singly-linked List head. */ +struct entry { + ... + SLIST_ENTRY(entry) entries; /* Singly-linked List. */ + ... +} *n1, *n2, *n3, *np; + +SLIST_INIT(&head); /* Initialize the list. */ + +n1 = malloc(sizeof(struct entry)); /* Insert at the head. */ +SLIST_INSERT_HEAD(&head, n1, entries); + +n2 = malloc(sizeof(struct entry)); /* Insert after. */ +SLIST_INSERT_AFTER(n1, n2, entries); + +SLIST_REMOVE(&head, n2, entry, entries);/* Deletion. */ +free(n2); + +n3 = SLIST_FIRST(&head); +SLIST_REMOVE_HEAD(&head, entries); /* Deletion from the head. */ +free(n3); + /* Forward traversal. */ +SLIST_FOREACH(np, &head, entries) + np-> ... + /* Safe forward traversal. */ +SLIST_FOREACH_SAFE(np, &head, entries, np_temp) { + np->do_stuff(); + ... + SLIST_REMOVE(&head, np, entry, entries); + free(np); +} + +while (!SLIST_EMPTY(&head)) { /* List Deletion. */ + n1 = SLIST_FIRST(&head); + SLIST_REMOVE_HEAD(&head, entries); + free(n1); +} +.Ed +.Ss SINGLY-LINKED TAIL QUEUE EXAMPLE +.Bd -literal +STAILQ_HEAD(stailhead, entry) head = + STAILQ_HEAD_INITIALIZER(head); +struct stailhead *headp; /* Singly-linked tail queue head. */ +struct entry { + ... + STAILQ_ENTRY(entry) entries; /* Tail queue. */ + ... +} *n1, *n2, *n3, *np; + +STAILQ_INIT(&head); /* Initialize the queue. */ + +n1 = malloc(sizeof(struct entry)); /* Insert at the head. */ +STAILQ_INSERT_HEAD(&head, n1, entries); + +n1 = malloc(sizeof(struct entry)); /* Insert at the tail. */ +STAILQ_INSERT_TAIL(&head, n1, entries); + +n2 = malloc(sizeof(struct entry)); /* Insert after. */ +STAILQ_INSERT_AFTER(&head, n1, n2, entries); + /* Deletion. */ +STAILQ_REMOVE(&head, n2, entry, entries); +free(n2); + /* Deletion from the head. */ +n3 = STAILQ_FIRST(&head); +STAILQ_REMOVE_HEAD(&head, entries); +free(n3); + /* Forward traversal. */ +STAILQ_FOREACH(np, &head, entries) + np-> ... + /* Safe forward traversal. */ +STAILQ_FOREACH_SAFE(np, &head, entries, np_temp) { + np->do_stuff(); + ... + STAILQ_REMOVE(&head, np, entry, entries); + free(np); +} + /* TailQ Deletion. */ +while (!STAILQ_EMPTY(&head)) { + n1 = STAILQ_FIRST(&head); + STAILQ_REMOVE_HEAD(&head, entries); + free(n1); +} + /* Faster TailQ Deletion. */ +n1 = STAILQ_FIRST(&head); +while (n1 != NULL) { + n2 = STAILQ_NEXT(n1, entries); + free(n1); + n1 = n2; +} +STAILQ_INIT(&head); +.Ed +.Ss LIST EXAMPLE +.Bd -literal +LIST_HEAD(listhead, entry) head = + LIST_HEAD_INITIALIZER(head); +struct listhead *headp; /* List head. */ +struct entry { + ... + LIST_ENTRY(entry) entries; /* List. */ + ... +} *n1, *n2, *n3, *np, *np_temp; + +LIST_INIT(&head); /* Initialize the list. */ + +n1 = malloc(sizeof(struct entry)); /* Insert at the head. */ +LIST_INSERT_HEAD(&head, n1, entries); + +n2 = malloc(sizeof(struct entry)); /* Insert after. */ +LIST_INSERT_AFTER(n1, n2, entries); + +n3 = malloc(sizeof(struct entry)); /* Insert before. */ +LIST_INSERT_BEFORE(n2, n3, entries); + +LIST_REMOVE(n2, entries); /* Deletion. */ +free(n2); + /* Forward traversal. */ +LIST_FOREACH(np, &head, entries) + np-> ... + + /* Safe forward traversal. */ +LIST_FOREACH_SAFE(np, &head, entries, np_temp) { + np->do_stuff(); + ... + LIST_REMOVE(np, entries); + free(np); +} + +while (!LIST_EMPTY(&head)) { /* List Deletion. */ + n1 = LIST_FIRST(&head); + LIST_REMOVE(n1, entries); + free(n1); +} + +n1 = LIST_FIRST(&head); /* Faster List Deletion. */ +while (n1 != NULL) { + n2 = LIST_NEXT(n1, entries); + free(n1); + n1 = n2; +} +LIST_INIT(&head); +.Ed +.Ss TAIL QUEUE EXAMPLE +.Bd -literal +TAILQ_HEAD(tailhead, entry) head = + TAILQ_HEAD_INITIALIZER(head); +struct tailhead *headp; /* Tail queue head. */ +struct entry { + ... + TAILQ_ENTRY(entry) entries; /* Tail queue. */ + ... +} *n1, *n2, *n3, *np; + +TAILQ_INIT(&head); /* Initialize the queue. */ + +n1 = malloc(sizeof(struct entry)); /* Insert at the head. */ +TAILQ_INSERT_HEAD(&head, n1, entries); + +n1 = malloc(sizeof(struct entry)); /* Insert at the tail. */ +TAILQ_INSERT_TAIL(&head, n1, entries); + +n2 = malloc(sizeof(struct entry)); /* Insert after. */ +TAILQ_INSERT_AFTER(&head, n1, n2, entries); + +n3 = malloc(sizeof(struct entry)); /* Insert before. */ +TAILQ_INSERT_BEFORE(n2, n3, entries); + +TAILQ_REMOVE(&head, n2, entries); /* Deletion. */ +free(n2); + /* Forward traversal. */ +TAILQ_FOREACH(np, &head, entries) + np-> ... + /* Safe forward traversal. */ +TAILQ_FOREACH_SAFE(np, &head, entries, np_temp) { + np->do_stuff(); + ... + TAILQ_REMOVE(&head, np, entries); + free(np); +} + /* Reverse traversal. */ +TAILQ_FOREACH_REVERSE(np, &head, tailhead, entries) + np-> ... + /* TailQ Deletion. */ +while (!TAILQ_EMPTY(&head)) { + n1 = TAILQ_FIRST(&head); + TAILQ_REMOVE(&head, n1, entries); + free(n1); +} + /* Faster TailQ Deletion. */ +n1 = TAILQ_FIRST(&head); +while (n1 != NULL) { + n2 = TAILQ_NEXT(n1, entries); + free(n1); + n1 = n2; +} +TAILQ_INIT(&head); +.Ed +.Sh DIAGNOSTICS +When debugging +.Nm queue.h(3head) , +it can be useful to trace queue changes. +To enable tracing, define the macro +.Va QUEUE_MACRO_DEBUG_TRACE +at compile time. +.Pp +It can also be useful to trash pointers that have been unlinked from a queue, +to detect use after removal. +To enable pointer trashing, define the macro +.Va QUEUE_MACRO_DEBUG_TRASH +at compile time. +The macro +.Fn QMD_IS_TRASHED "void *ptr" +returns true if +.Fa ptr +has been trashed by the +.Va QUEUE_MACRO_DEBUG_TRASH +option. +.Sh INTERFACE STABILITY +Committed +.Sh MT-LEVEL +Unsafe +.Sh HISTORY +The +.Nm queue +functions first appeared in +.Bx 4.4 . diff --git a/usr/src/pkg/manifests/system-header.mf b/usr/src/pkg/manifests/system-header.mf index 9130c750d8..f655696ac6 100644 --- a/usr/src/pkg/manifests/system-header.mf +++ b/usr/src/pkg/manifests/system-header.mf @@ -178,6 +178,7 @@ $(sparc_ONLY)dir path=usr/platform/sun4v/include/sys $(sparc_ONLY)dir path=usr/platform/sun4v/include/vm dir path=usr/share dir path=usr/share/man +dir path=usr/share/man/man3 dir path=usr/share/man/man3head dir path=usr/share/man/man4 dir path=usr/share/man/man5 @@ -1875,6 +1876,7 @@ file path=usr/share/man/man3head/nl_types.h.3head file path=usr/share/man/man3head/poll.h.3head file path=usr/share/man/man3head/pthread.h.3head file path=usr/share/man/man3head/pwd.h.3head +file path=usr/share/man/man3head/queue.h.3head file path=usr/share/man/man3head/regex.h.3head file path=usr/share/man/man3head/resource.h.3head file path=usr/share/man/man3head/sched.h.3head @@ -2016,6 +2018,111 @@ $(sparc_ONLY)link path=usr/platform/SUNW,UltraSPARC-IIe-NetraCT-60/include \ target=../sun4u/include $(sparc_ONLY)link path=usr/platform/SUNW,UltraSPARC-IIi-Netract/include \ target=../sun4u/include +link path=usr/share/man/man3head/LIST_CLASS_ENTRY.3head target=queue.h.3head +link path=usr/share/man/man3head/LIST_CLASS_HEAD.3head target=queue.h.3head +link path=usr/share/man/man3head/LIST_CONCAT.3head target=queue.h.3head +link path=usr/share/man/man3head/LIST_EMPTY.3head target=queue.h.3head +link path=usr/share/man/man3head/LIST_ENTRY.3head target=queue.h.3head +link path=usr/share/man/man3head/LIST_FIRST.3head target=queue.h.3head +link path=usr/share/man/man3head/LIST_FOREACH.3head target=queue.h.3head +link path=usr/share/man/man3head/LIST_FOREACH_FROM.3head target=queue.h.3head +link path=usr/share/man/man3head/LIST_FOREACH_FROM_SAFE.3head \ + target=queue.h.3head +link path=usr/share/man/man3head/LIST_FOREACH_SAFE.3head target=queue.h.3head +link path=usr/share/man/man3head/LIST_HEAD.3head target=queue.h.3head +link path=usr/share/man/man3head/LIST_HEAD_INITIALIZER.3head \ + target=queue.h.3head +link path=usr/share/man/man3head/LIST_INIT.3head target=queue.h.3head +link path=usr/share/man/man3head/LIST_INSERT_AFTER.3head target=queue.h.3head +link path=usr/share/man/man3head/LIST_INSERT_BEFORE.3head target=queue.h.3head +link path=usr/share/man/man3head/LIST_INSERT_HEAD.3head target=queue.h.3head +link path=usr/share/man/man3head/LIST_NEXT.3head target=queue.h.3head +link path=usr/share/man/man3head/LIST_PREV.3head target=queue.h.3head +link path=usr/share/man/man3head/LIST_REMOVE.3head target=queue.h.3head +link path=usr/share/man/man3head/LIST_SWAP.3head target=queue.h.3head +link path=usr/share/man/man3head/SLIST_CLASS_ENTRY.3head target=queue.h.3head +link path=usr/share/man/man3head/SLIST_CLASS_HEAD.3head target=queue.h.3head +link path=usr/share/man/man3head/SLIST_CONCAT.3head target=queue.h.3head +link path=usr/share/man/man3head/SLIST_EMPTY.3head target=queue.h.3head +link path=usr/share/man/man3head/SLIST_ENTRY.3head target=queue.h.3head +link path=usr/share/man/man3head/SLIST_FIRST.3head target=queue.h.3head +link path=usr/share/man/man3head/SLIST_FOREACH.3head target=queue.h.3head +link path=usr/share/man/man3head/SLIST_FOREACH_FROM.3head target=queue.h.3head +link path=usr/share/man/man3head/SLIST_FOREACH_FROM_SAFE.3head \ + target=queue.h.3head +link path=usr/share/man/man3head/SLIST_FOREACH_SAFE.3head target=queue.h.3head +link path=usr/share/man/man3head/SLIST_HEAD.3head target=queue.h.3head +link path=usr/share/man/man3head/SLIST_HEAD_INITIALIZER.3head \ + target=queue.h.3head +link path=usr/share/man/man3head/SLIST_INIT.3head target=queue.h.3head +link path=usr/share/man/man3head/SLIST_INSERT_AFTER.3head target=queue.h.3head +link path=usr/share/man/man3head/SLIST_INSERT_HEAD.3head target=queue.h.3head +link path=usr/share/man/man3head/SLIST_NEXT.3head target=queue.h.3head +link path=usr/share/man/man3head/SLIST_REMOVE.3head target=queue.h.3head +link path=usr/share/man/man3head/SLIST_REMOVE_AFTER.3head target=queue.h.3head +link path=usr/share/man/man3head/SLIST_REMOVE_HEAD.3head target=queue.h.3head +link path=usr/share/man/man3head/SLIST_SWAP.3head target=queue.h.3head +link path=usr/share/man/man3head/STAILQ_CLASS_ENTRY.3head target=queue.h.3head +link path=usr/share/man/man3head/STAILQ_CLASS_HEAD.3head target=queue.h.3head +link path=usr/share/man/man3head/STAILQ_CONCAT.3head target=queue.h.3head +link path=usr/share/man/man3head/STAILQ_EMPTY.3head target=queue.h.3head +link path=usr/share/man/man3head/STAILQ_ENTRY.3head target=queue.h.3head +link path=usr/share/man/man3head/STAILQ_FIRST.3head target=queue.h.3head +link path=usr/share/man/man3head/STAILQ_FOREACH.3head target=queue.h.3head +link path=usr/share/man/man3head/STAILQ_FOREACH_FROM.3head \ + target=queue.h.3head +link path=usr/share/man/man3head/STAILQ_FOREACH_FROM_SAFE.3head \ + target=queue.h.3head +link path=usr/share/man/man3head/STAILQ_FOREACH_SAFE.3head \ + target=queue.h.3head +link path=usr/share/man/man3head/STAILQ_HEAD.3head target=queue.h.3head +link path=usr/share/man/man3head/STAILQ_HEAD_INITIALIZER.3head \ + target=queue.h.3head +link path=usr/share/man/man3head/STAILQ_INIT.3head target=queue.h.3head +link path=usr/share/man/man3head/STAILQ_INSERT_AFTER.3head \ + target=queue.h.3head +link path=usr/share/man/man3head/STAILQ_INSERT_HEAD.3head target=queue.h.3head +link path=usr/share/man/man3head/STAILQ_INSERT_TAIL.3head target=queue.h.3head +link path=usr/share/man/man3head/STAILQ_LAST.3head target=queue.h.3head +link path=usr/share/man/man3head/STAILQ_NEXT.3head target=queue.h.3head +link path=usr/share/man/man3head/STAILQ_REMOVE.3head target=queue.h.3head +link path=usr/share/man/man3head/STAILQ_REMOVE_AFTER.3head \ + target=queue.h.3head +link path=usr/share/man/man3head/STAILQ_REMOVE_HEAD.3head target=queue.h.3head +link path=usr/share/man/man3head/STAILQ_SWAP.3head target=queue.h.3head +link path=usr/share/man/man3head/TAILQ_CLASS_ENTRY.3head target=queue.h.3head +link path=usr/share/man/man3head/TAILQ_CLASS_HEAD.3head target=queue.h.3head +link path=usr/share/man/man3head/TAILQ_CONCAT.3head target=queue.h.3head +link path=usr/share/man/man3head/TAILQ_EMPTY.3head target=queue.h.3head +link path=usr/share/man/man3head/TAILQ_ENTRY.3head target=queue.h.3head +link path=usr/share/man/man3head/TAILQ_FIRST.3head target=queue.h.3head +link path=usr/share/man/man3head/TAILQ_FOREACH.3head target=queue.h.3head +link path=usr/share/man/man3head/TAILQ_FOREACH_FROM.3head target=queue.h.3head +link path=usr/share/man/man3head/TAILQ_FOREACH_FROM_SAFE.3head \ + target=queue.h.3head +link path=usr/share/man/man3head/TAILQ_FOREACH_REVERSE.3head \ + target=queue.h.3head +link path=usr/share/man/man3head/TAILQ_FOREACH_REVERSE_FROM.3head \ + target=queue.h.3head +link path=usr/share/man/man3head/TAILQ_FOREACH_REVERSE_FROM_SAFE.3head \ + target=queue.h.3head +link path=usr/share/man/man3head/TAILQ_FOREACH_REVERSE_SAFE.3head \ + target=queue.h.3head +link path=usr/share/man/man3head/TAILQ_FOREACH_SAFE.3head target=queue.h.3head +link path=usr/share/man/man3head/TAILQ_HEAD.3head target=queue.h.3head +link path=usr/share/man/man3head/TAILQ_HEAD_INITIALIZER.3head \ + target=queue.h.3head +link path=usr/share/man/man3head/TAILQ_INIT.3head target=queue.h.3head +link path=usr/share/man/man3head/TAILQ_INSERT_AFTER.3head target=queue.h.3head +link path=usr/share/man/man3head/TAILQ_INSERT_BEFORE.3head \ + target=queue.h.3head +link path=usr/share/man/man3head/TAILQ_INSERT_HEAD.3head target=queue.h.3head +link path=usr/share/man/man3head/TAILQ_INSERT_TAIL.3head target=queue.h.3head +link path=usr/share/man/man3head/TAILQ_LAST.3head target=queue.h.3head +link path=usr/share/man/man3head/TAILQ_NEXT.3head target=queue.h.3head +link path=usr/share/man/man3head/TAILQ_PREV.3head target=queue.h.3head +link path=usr/share/man/man3head/TAILQ_REMOVE.3head target=queue.h.3head +link path=usr/share/man/man3head/TAILQ_SWAP.3head target=queue.h.3head link path=usr/share/man/man3head/acct.3head target=acct.h.3head link path=usr/share/man/man3head/aio.3head target=aio.h.3head link path=usr/share/man/man3head/ar.3head target=ar.h.3head diff --git a/usr/src/uts/common/sys/queue.h b/usr/src/uts/common/sys/queue.h index 39a476450f..7eb4e8bb8b 100644 --- a/usr/src/uts/common/sys/queue.h +++ b/usr/src/uts/common/sys/queue.h @@ -1,5 +1,3 @@ -/* $NetBSD: queue.h,v 1.42 2005/07/13 15:08:24 wiz Exp $ */ - /* * Copyright (c) 1991, 1993 * The Regents of the University of California. All rights reserved. @@ -39,8 +37,9 @@ #define _SYS_QUEUE_H #include <sys/note.h> +#include <sys/containerof.h> -#ifdef __cplusplus +#ifdef __cplusplus extern "C" { #endif @@ -87,105 +86,72 @@ extern "C" { * A circle queue may be traversed in either direction, but has a more * complex end of list detection. * - * For details on the use of these macros, see the queue(3) manual page. + * For details on the use of these macros, see the queue.h(3HEAD) manual page. */ -/* - * List definitions. - */ -#define LIST_HEAD(name, type) \ -struct name { \ - struct type *lh_first; /* first element */ \ -} - -#define LIST_HEAD_INITIALIZER(head) \ - { NULL } - -#define LIST_ENTRY(type) \ -struct { \ - struct type *le_next; /* next element */ \ - struct type **le_prev; /* address of previous next element */ \ -} - -/* - * List functions. - */ -#if defined(_KERNEL) && defined(QUEUEDEBUG) -#define QUEUEDEBUG_LIST_INSERT_HEAD(head, elm, field) \ - if ((head)->lh_first && \ - (head)->lh_first->field.le_prev != &(head)->lh_first) \ - panic("LIST_INSERT_HEAD %p %s:%d", (head), __FILE__, __LINE__); -#define QUEUEDEBUG_LIST_OP(elm, field) \ - if ((elm)->field.le_next && \ - (elm)->field.le_next->field.le_prev != \ - &(elm)->field.le_next) \ - panic("LIST_* forw %p %s:%d", (elm), __FILE__, __LINE__);\ - if (*(elm)->field.le_prev != (elm)) \ - panic("LIST_* back %p %s:%d", (elm), __FILE__, __LINE__); -#define QUEUEDEBUG_LIST_POSTREMOVE(elm, field) \ - (elm)->field.le_next = (void *)1L; \ - (elm)->field.le_prev = (void *)1L; -#else -#define QUEUEDEBUG_LIST_INSERT_HEAD(head, elm, field) -#define QUEUEDEBUG_LIST_OP(elm, field) -#define QUEUEDEBUG_LIST_POSTREMOVE(elm, field) +#ifdef QUEUE_MACRO_DEBUG +#warn Use QUEUE_MACRO_DEBUG_TRACE and/or QUEUE_MACRO_DEBUG_TRASH +#define QUEUE_MACRO_DEBUG_TRACE +#define QUEUE_MACRO_DEBUG_TRASH #endif -#define LIST_INIT(head) do { \ - (head)->lh_first = NULL; \ - _NOTE(CONSTCOND) \ -} while (0) - -#define LIST_INSERT_AFTER(listelm, elm, field) do { \ - QUEUEDEBUG_LIST_OP((listelm), field) \ - if (((elm)->field.le_next = (listelm)->field.le_next) != NULL) \ - (listelm)->field.le_next->field.le_prev = \ - &(elm)->field.le_next; \ - (listelm)->field.le_next = (elm); \ - (elm)->field.le_prev = &(listelm)->field.le_next; \ +#ifdef QUEUE_MACRO_DEBUG_TRACE +/* Store the last 2 places the queue element or head was altered */ +struct qm_trace { + unsigned long lastline; + unsigned long prevline; + const char *lastfile; + const char *prevfile; +}; + +#define TRACEBUF struct qm_trace trace; +#define TRACEBUF_INITIALIZER { __LINE__, 0, __FILE__, NULL }, + +#define QMD_TRACE_HEAD(head) do { \ + (head)->trace.prevline = (head)->trace.lastline; \ + (head)->trace.prevfile = (head)->trace.lastfile; \ + (head)->trace.lastline = __LINE__; \ + (head)->trace.lastfile = __FILE__; \ _NOTE(CONSTCOND) \ } while (0) -#define LIST_INSERT_BEFORE(listelm, elm, field) do { \ - QUEUEDEBUG_LIST_OP((listelm), field) \ - (elm)->field.le_prev = (listelm)->field.le_prev; \ - (elm)->field.le_next = (listelm); \ - *(listelm)->field.le_prev = (elm); \ - (listelm)->field.le_prev = &(elm)->field.le_next; \ - _NOTE(CONSTCOND) \ -} while (0) - -#define LIST_INSERT_HEAD(head, elm, field) do { \ - QUEUEDEBUG_LIST_INSERT_HEAD((head), (elm), field) \ - if (((elm)->field.le_next = (head)->lh_first) != NULL) \ - (head)->lh_first->field.le_prev = &(elm)->field.le_next;\ - (head)->lh_first = (elm); \ - (elm)->field.le_prev = &(head)->lh_first; \ - _NOTE(CONSTCOND) \ -} while (0) - -#define LIST_REMOVE(elm, field) do { \ - QUEUEDEBUG_LIST_OP((elm), field) \ - if ((elm)->field.le_next != NULL) \ - (elm)->field.le_next->field.le_prev = \ - (elm)->field.le_prev; \ - *(elm)->field.le_prev = (elm)->field.le_next; \ - QUEUEDEBUG_LIST_POSTREMOVE((elm), field) \ +#define QMD_TRACE_ELEM(elem) do { \ + (elem)->trace.prevline = (elem)->trace.lastline; \ + (elem)->trace.prevfile = (elem)->trace.lastfile; \ + (elem)->trace.lastline = __LINE__; \ + (elem)->trace.lastfile = __FILE__; \ _NOTE(CONSTCOND) \ } while (0) -#define LIST_FOREACH(var, head, field) \ - for ((var) = ((head)->lh_first); \ - (var); \ - (var) = ((var)->field.le_next)) - +#else /* !QUEUE_MACRO_DEBUG_TRACE */ +#define QMD_TRACE_ELEM(elem) +#define QMD_TRACE_HEAD(head) +#define TRACEBUF +#define TRACEBUF_INITIALIZER +#endif /* QUEUE_MACRO_DEBUG_TRACE */ + +#ifdef QUEUE_MACRO_DEBUG_TRASH +#define TRASHIT(x) do {(x) = (void *)-1; } while (0) +#define QMD_IS_TRASHED(x) ((x) == (void *)(intptr_t)-1) +#else /* !QUEUE_MACRO_DEBUG_TRASH */ +#define TRASHIT(x) +#define QMD_IS_TRASHED(x) 0 +#endif /* QUEUE_MACRO_DEBUG_TRASH */ + +#if defined(QUEUE_MACRO_DEBUG_TRACE) || defined(QUEUE_MACRO_DEBUG_TRASH) +#define QMD_SAVELINK(name, link) void **name = (void *)&(link) +#else /* !QUEUE_MACRO_DEBUG_TRACE && !QUEUE_MACRO_DEBUG_TRASH */ +#define QMD_SAVELINK(name, link) +#endif /* QUEUE_MACRO_DEBUG_TRACE || QUEUE_MACRO_DEBUG_TRASH */ + +#ifdef __cplusplus /* - * List access methods. + * In C++ there can be structure lists and class lists: */ -#define LIST_EMPTY(head) ((head)->lh_first == NULL) -#define LIST_FIRST(head) ((head)->lh_first) -#define LIST_NEXT(elm, field) ((elm)->field.le_next) - +#define QUEUE_TYPEOF(type) type +#else +#define QUEUE_TYPEOF(type) struct type +#endif /* * Singly-linked List definitions. @@ -195,6 +161,11 @@ struct name { \ struct type *slh_first; /* first element */ \ } +#define SLIST_CLASS_HEAD(name, type) \ +struct name { \ + class type *slh_first; /* first element */ \ +} + #define SLIST_HEAD_INITIALIZER(head) \ { NULL } @@ -203,55 +174,107 @@ struct { \ struct type *sle_next; /* next element */ \ } +#define SLIST_CLASS_ENTRY(type) \ +struct { \ + class type *sle_next; /* next element */ \ +} + +/* + * Singly-linked List access methods. + */ +#define SLIST_FIRST(head) ((head)->slh_first) +#define SLIST_END(head) NULL +#define SLIST_NEXT(elm, field) ((elm)->field.sle_next) +#define SLIST_EMPTY(head) ((head)->slh_first == SLIST_END(head)) + +#define SLIST_FOREACH(var, head, field) \ + for ((var) = SLIST_FIRST((head)); \ + (var) != SLIST_END(head); \ + (var) = SLIST_NEXT((var), field)) + +#define SLIST_FOREACH_FROM(var, head, field) \ + for ((var) = ((var) != SLIST_END(head) ? (var) : SLIST_FIRST((head))); \ + (var) != SLIST_END(head); \ + (var) = SLIST_NEXT((var), field)) + +#define SLIST_FOREACH_SAFE(var, head, field, tvar) \ + for ((var) = SLIST_FIRST((head)); \ + (var) != SLIST_END(head) && \ + ((tvar) = SLIST_NEXT((var), field), 1); \ + (var) = (tvar)) + +#define SLIST_FOREACH_FROM_SAFE(var, head, field, tvar) \ + for ((var) = ((var) != SLIST_END(head) ? (var) : SLIST_FIRST((head))); \ + (var) != SLIST_END(head) && \ + ((tvar) = SLIST_NEXT((var), field), 1); \ + (var) = (tvar)) + /* * Singly-linked List functions. */ #define SLIST_INIT(head) do { \ - (head)->slh_first = NULL; \ + (head)->slh_first = SLIST_END(head); \ + _NOTE(CONSTCOND) \ +} while (0) + +#define SLIST_CONCAT(head1, head2, type, field) do { \ + QUEUE_TYPEOF(type) *curelm = SLIST_FIRST(head1); \ + if (curelm == SLIST_END(head1)) { \ + if ((SLIST_FIRST(head1) = SLIST_FIRST(head2)) != \ + SLIST_END(head1)) \ + SLIST_INIT(head2); \ + } else if (SLIST_FIRST(head2) != SLIST_END(head2)) { \ + while (SLIST_NEXT(curelm, field) != SLIST_END(head1)) \ + curelm = SLIST_NEXT(curelm, field); \ + SLIST_NEXT(curelm, field) = SLIST_FIRST(head2); \ + SLIST_INIT(head2); \ + } \ _NOTE(CONSTCOND) \ } while (0) #define SLIST_INSERT_AFTER(slistelm, elm, field) do { \ - (elm)->field.sle_next = (slistelm)->field.sle_next; \ - (slistelm)->field.sle_next = (elm); \ + SLIST_NEXT((elm), field) = SLIST_NEXT((slistelm), field); \ + SLIST_NEXT((slistelm), field) = (elm); \ _NOTE(CONSTCOND) \ } while (0) #define SLIST_INSERT_HEAD(head, elm, field) do { \ - (elm)->field.sle_next = (head)->slh_first; \ - (head)->slh_first = (elm); \ + SLIST_NEXT((elm), field) = SLIST_FIRST((head)); \ + SLIST_FIRST((head)) = (elm); \ _NOTE(CONSTCOND) \ } while (0) #define SLIST_REMOVE_HEAD(head, field) do { \ - (head)->slh_first = (head)->slh_first->field.sle_next; \ + SLIST_FIRST((head)) = SLIST_NEXT(SLIST_FIRST((head)), field); \ + _NOTE(CONSTCOND) \ +} while (0) + +#define SLIST_REMOVE_AFTER(slistelm, field) do { \ + SLIST_NEXT((slistelm), field) = \ + SLIST_NEXT(SLIST_NEXT((slistelm), field), field); \ _NOTE(CONSTCOND) \ } while (0) #define SLIST_REMOVE(head, elm, type, field) do { \ - if ((head)->slh_first == (elm)) { \ + QMD_SAVELINK(oldnext, SLIST_NEXT((elm), field)); \ + if (SLIST_FIRST((head)) == (elm)) { \ SLIST_REMOVE_HEAD((head), field); \ } \ else { \ - struct type *curelm = (head)->slh_first; \ - while (curelm->field.sle_next != (elm)) \ - curelm = curelm->field.sle_next; \ - curelm->field.sle_next = \ - curelm->field.sle_next->field.sle_next; \ + QUEUE_TYPEOF(type) *curelm = SLIST_FIRST((head)); \ + while (SLIST_NEXT(curelm, field) != (elm)) \ + curelm = SLIST_NEXT(curelm, field); \ + SLIST_REMOVE_AFTER(curelm, field); \ } \ + TRASHIT(*oldnext); \ _NOTE(CONSTCOND) \ } while (0) -#define SLIST_FOREACH(var, head, field) \ - for ((var) = (head)->slh_first; (var); (var) = (var)->field.sle_next) - -/* - * Singly-linked List access methods. - */ -#define SLIST_EMPTY(head) ((head)->slh_first == NULL) -#define SLIST_FIRST(head) ((head)->slh_first) -#define SLIST_NEXT(elm, field) ((elm)->field.sle_next) - +#define SLIST_SWAP(head1, head2, type) do { \ + QUEUE_TYPEOF(type) *swap_first = SLIST_FIRST(head1); \ + SLIST_FIRST(head1) = SLIST_FIRST(head2); \ + SLIST_FIRST(head2) = swap_first; \ +} while (0) /* * Singly-linked Tail queue declarations. @@ -262,78 +285,281 @@ struct name { \ struct type **stqh_last; /* addr of last next element */ \ } +#define STAILQ_CLASS_HEAD(name, type) \ +struct name { \ + class type *stqh_first; /* first element */ \ + class type **stqh_last; /* addr of last next element */ \ +} + #define STAILQ_HEAD_INITIALIZER(head) \ { NULL, &(head).stqh_first } #define STAILQ_ENTRY(type) \ struct { \ - struct type *stqe_next; /* next element */ \ + struct type *stqe_next; /* next element */ \ } +#define STAILQ_CLASS_ENTRY(type) \ +struct { \ + class type *stqe_next; /* next element */ \ +} + +/* + * Singly-linked Tail queue access methods. + */ +#define STAILQ_FIRST(head) ((head)->stqh_first) +#define STAILQ_END(head) NULL +#define STAILQ_NEXT(elm, field) ((elm)->field.stqe_next) +#define STAILQ_EMPTY(head) ((head)->stqh_first == STAILQ_END(head)) + +#define STAILQ_FOREACH(var, head, field) \ + for ((var) = STAILQ_FIRST(head); \ + (var) != STAILQ_END(head); \ + (var) = STAILQ_NEXT((var), field)) + +#define STAILQ_FOREACH_FROM(var, head, field) \ + for ((var) = \ + ((var) != STAILQ_END(head) ? (var) : STAILQ_FIRST((head))); \ + (var) != STAILQ_END(head); \ + (var) = STAILQ_NEXT((var), field)) + +#define STAILQ_FOREACH_SAFE(var, head, field, tvar) \ + for ((var) = STAILQ_FIRST(head); \ + (var) != STAILQ_END(head) && \ + ((tvar) = STAILQ_NEXT((var), field), 1); \ + (var) = (tvar)) + +#define STAILQ_FOREACH_FROM_SAFE(var, head, field, tvar) \ + for ((var) = \ + ((var) != STAILQ_END(head) ? (var) : STAILQ_FIRST((head))); \ + (var) != STAILQ_END(head) && \ + ((tvar) = STAILQ_NEXT((var), field), 1); \ + (var) = (tvar)) + /* * Singly-linked Tail queue functions. */ #define STAILQ_INIT(head) do { \ - (head)->stqh_first = NULL; \ - (head)->stqh_last = &(head)->stqh_first; \ + STAILQ_FIRST(head) = STAILQ_END(head); \ + (head)->stqh_last = &STAILQ_FIRST((head)); \ + _NOTE(CONSTCOND) \ +} while (0) + +#define STAILQ_CONCAT(head1, head2) do { \ + if (!STAILQ_EMPTY((head2))) { \ + *(head1)->stqh_last = STAILQ_FIRST((head2)); \ + (head1)->stqh_last = (head2)->stqh_last; \ + STAILQ_INIT((head2)); \ + } \ + _NOTE(CONSTCOND) \ +} while (0) + +#define STAILQ_INSERT_AFTER(head, tqelm, elm, field) do { \ + if ((STAILQ_NEXT((elm), field) = STAILQ_NEXT((tqelm), field)) == NULL)\ + (head)->stqh_last = &STAILQ_NEXT((elm), field); \ + STAILQ_NEXT((tqelm), field) = (elm); \ _NOTE(CONSTCOND) \ } while (0) #define STAILQ_INSERT_HEAD(head, elm, field) do { \ - if (((elm)->field.stqe_next = (head)->stqh_first) == NULL) \ - (head)->stqh_last = &(elm)->field.stqe_next; \ - (head)->stqh_first = (elm); \ + if ((STAILQ_NEXT((elm), field) = STAILQ_FIRST((head))) == NULL) \ + (head)->stqh_last = &STAILQ_NEXT((elm), field); \ + STAILQ_FIRST((head)) = (elm); \ _NOTE(CONSTCOND) \ } while (0) #define STAILQ_INSERT_TAIL(head, elm, field) do { \ - (elm)->field.stqe_next = NULL; \ + STAILQ_NEXT((elm), field) = NULL; \ *(head)->stqh_last = (elm); \ - (head)->stqh_last = &(elm)->field.stqe_next; \ + (head)->stqh_last = &STAILQ_NEXT((elm), field); \ _NOTE(CONSTCOND) \ } while (0) -#define STAILQ_INSERT_AFTER(head, listelm, elm, field) do { \ - if (((elm)->field.stqe_next = (listelm)->field.stqe_next) \ - == NULL) \ - (head)->stqh_last = &(elm)->field.stqe_next; \ - (listelm)->field.stqe_next = (elm); \ +#define STAILQ_LAST(head, type, field) \ + (STAILQ_EMPTY((head)) ? NULL : \ + __containerof((head)->stqh_last, \ + QUEUE_TYPEOF(type), field.stqe_next)) + +#define STAILQ_REMOVE_HEAD(head, field) do { \ + if ((STAILQ_FIRST((head)) = \ + STAILQ_NEXT(STAILQ_FIRST((head)), field)) == NULL) \ + (head)->stqh_last = &STAILQ_FIRST((head)); \ _NOTE(CONSTCOND) \ } while (0) -#define STAILQ_REMOVE_HEAD(head, field) do { \ - if (((head)->stqh_first = (head)->stqh_first->field.stqe_next) \ - == NULL) \ - (head)->stqh_last = &(head)->stqh_first; \ +#define STAILQ_REMOVE_AFTER(head, elm, field) do { \ + if ((STAILQ_NEXT(elm, field) = \ + STAILQ_NEXT(STAILQ_NEXT(elm, field), field)) == NULL) \ + (head)->stqh_last = &STAILQ_NEXT((elm), field); \ _NOTE(CONSTCOND) \ } while (0) #define STAILQ_REMOVE(head, elm, type, field) do { \ - if ((head)->stqh_first == (elm)) { \ + QMD_SAVELINK(oldnext, (elm)->field.stqe_next); \ + if (STAILQ_FIRST((head)) == (elm)) { \ STAILQ_REMOVE_HEAD((head), field); \ } else { \ - struct type *curelm = (head)->stqh_first; \ - while (curelm->field.stqe_next != (elm)) \ - curelm = curelm->field.stqe_next; \ - if ((curelm->field.stqe_next = \ - curelm->field.stqe_next->field.stqe_next) == NULL) \ - (head)->stqh_last = &(curelm)->field.stqe_next; \ + QUEUE_TYPEOF(type) *curelm = STAILQ_FIRST(head); \ + while (STAILQ_NEXT(curelm, field) != (elm)) \ + curelm = STAILQ_NEXT(curelm, field); \ + STAILQ_REMOVE_AFTER(head, curelm, field); \ } \ + TRASHIT(*oldnext); \ _NOTE(CONSTCOND) \ } while (0) -#define STAILQ_FOREACH(var, head, field) \ - for ((var) = ((head)->stqh_first); \ - (var); \ - (var) = ((var)->field.stqe_next)) +#define STAILQ_SWAP(head1, head2, type) do { \ + QUEUE_TYPEOF(type) *swap_first = STAILQ_FIRST(head1); \ + QUEUE_TYPEOF(type) **swap_last = (head1)->stqh_last; \ + STAILQ_FIRST(head1) = STAILQ_FIRST(head2); \ + (head1)->stqh_last = (head2)->stqh_last; \ + STAILQ_FIRST(head2) = swap_first; \ + (head2)->stqh_last = swap_last; \ + if (STAILQ_EMPTY(head1)) \ + (head1)->stqh_last = &STAILQ_FIRST(head1); \ + if (STAILQ_EMPTY(head2)) \ + (head2)->stqh_last = &STAILQ_FIRST(head2); \ + _NOTE(CONSTCOND) \ +} while (0) /* - * Singly-linked Tail queue access methods. + * List definitions. */ -#define STAILQ_EMPTY(head) ((head)->stqh_first == NULL) -#define STAILQ_FIRST(head) ((head)->stqh_first) -#define STAILQ_NEXT(elm, field) ((elm)->field.stqe_next) +#define LIST_HEAD(name, type) \ +struct name { \ + struct type *lh_first; /* first element */ \ +} +#define LIST_CLASS_HEAD(name, type) \ +struct name { \ + class type *lh_first; /* first element */ \ +} + +#define LIST_HEAD_INITIALIZER(head) \ + { NULL } + +#define LIST_ENTRY(type) \ +struct { \ + struct type *le_next; /* next element */ \ + struct type **le_prev; /* address of previous next element */ \ +} + +#define LIST_CLASS_ENTRY(type) \ +struct { \ + class type *le_next; /* next element */ \ + class type **le_prev; /* address of previous next element */ \ +} + +/* + * List access methods. + */ +#define LIST_FIRST(head) ((head)->lh_first) +#define LIST_END(head) NULL +#define LIST_EMPTY(head) ((head)->lh_first == LIST_END(head)) +#define LIST_NEXT(elm, field) ((elm)->field.le_next) +#define LIST_PREV(elm, head, type, field) \ + ((elm)->field.le_prev == &LIST_FIRST((head)) ? NULL : \ + __containerof((elm)->field.le_prev, type, field.le_next)) + +#define LIST_FOREACH(var, head, field) \ + for ((var) = LIST_FIRST((head)); \ + (var) != LIST_END(head); \ + (var) = LIST_NEXT((var), field)) + +#define LIST_FOREACH_FROM(var, head, field) \ + for ((var) = ((var) != LIST_END(head) ? (var) : LIST_FIRST((head));\ + (var) != LIST_END(head); \ + (var) = LIST_NEXT((var), field)) + +#define LIST_FOREACH_SAFE(var, head, field, tvar) \ + for ((var) = LIST_FIRST((head)); \ + (var) != LIST_END(head) && \ + ((tvar) = LIST_NEXT((var), field), 1); \ + (var) = (tvar)) + +#define LIST_FOREACH_FROM_SAFE(var, head, field, tvar) \ + for ((var) = ((var) != LIST_END(head) ? (var) : LIST_FIRST((head));\ + (var) != LIST_END(head) && \ + ((tvar) = LIST_NEXT((var), field), 1); \ + (var) = (tvar)) + +/* + * List functions. + */ +#if defined(_KERNEL) && defined(QUEUEDEBUG) +#define QUEUEDEBUG_LIST_INSERT_HEAD(head, elm, field) \ + if ((head)->lh_first && \ + (head)->lh_first->field.le_prev != &(head)->lh_first) \ + panic("LIST_INSERT_HEAD %p %s:%d", (head), __FILE__, __LINE__); +#define QUEUEDEBUG_LIST_OP(elm, field) \ + if ((elm)->field.le_next && \ + (elm)->field.le_next->field.le_prev != \ + &(elm)->field.le_next) \ + panic("LIST_* forw %p %s:%d", (elm), __FILE__, __LINE__);\ + if (*(elm)->field.le_prev != (elm)) \ + panic("LIST_* back %p %s:%d", (elm), __FILE__, __LINE__); +#define QUEUEDEBUG_LIST_POSTREMOVE(elm, field) \ + (elm)->field.le_next = (void *)1L; \ + (elm)->field.le_prev = (void *)1L; +#else +#define QUEUEDEBUG_LIST_INSERT_HEAD(head, elm, field) +#define QUEUEDEBUG_LIST_OP(elm, field) +#define QUEUEDEBUG_LIST_POSTREMOVE(elm, field) +#endif + +#define LIST_INIT(head) do { \ + LIST_FIRST((head)) = LIST_END(head); \ + _NOTE(CONSTCOND) \ +} while (0) + +#define LIST_INSERT_AFTER(listelm, elm, field) do { \ + QUEUEDEBUG_LIST_OP((listelm), field) \ + if ((LIST_NEXT((elm), field) = LIST_NEXT((listelm), field)) != NULL)\ + LIST_NEXT((listelm), field)->field.le_prev = \ + &LIST_NEXT((elm), field); \ + LIST_NEXT((listelm), field) = (elm); \ + (elm)->field.le_prev = &LIST_NEXT((listelm), field); \ + _NOTE(CONSTCOND) \ +} while (0) + +#define LIST_INSERT_BEFORE(listelm, elm, field) do { \ + QUEUEDEBUG_LIST_OP((listelm), field) \ + (elm)->field.le_prev = (listelm)->field.le_prev; \ + LIST_NEXT((elm), field) = (listelm); \ + *(listelm)->field.le_prev = (elm); \ + (listelm)->field.le_prev = &LIST_NEXT((elm), field); \ + _NOTE(CONSTCOND) \ +} while (0) + +#define LIST_INSERT_HEAD(head, elm, field) do { \ + QUEUEDEBUG_LIST_INSERT_HEAD((head), (elm), field) \ + if ((LIST_NEXT((elm), field) = LIST_FIRST((head))) != NULL) \ + LIST_FIRST((head))->field.le_prev = &LIST_NEXT((elm), field);\ + LIST_FIRST((head)) = (elm); \ + (elm)->field.le_prev = &LIST_FIRST((head)); \ + _NOTE(CONSTCOND) \ +} while (0) + +#define LIST_REMOVE(elm, field) do { \ + QUEUEDEBUG_LIST_OP((elm), field) \ + if (LIST_NEXT((elm), field) != NULL) \ + LIST_NEXT((elm), field)->field.le_prev = \ + (elm)->field.le_prev; \ + *(elm)->field.le_prev = LIST_NEXT((elm), field); \ + QUEUEDEBUG_LIST_POSTREMOVE((elm), field) \ + _NOTE(CONSTCOND) \ +} while (0) + +#define LIST_SWAP(head1, head2, type, field) do { \ + QUEUE_TYPEOF(type) *swap_tmp = LIST_FIRST(head1); \ + LIST_FIRST((head1)) = LIST_FIRST((head2)); \ + LIST_FIRST((head2)) = swap_tmp; \ + if ((swap_tmp = LIST_FIRST((head1))) != NULL) \ + swap_tmp->field.le_prev = &LIST_FIRST((head1)); \ + if ((swap_tmp = LIST_FIRST((head2))) != NULL) \ + swap_tmp->field.le_prev = &LIST_FIRST((head2)); \ + _NOTE(CONSTCOND) \ +} while (0) /* * Simple queue definitions. @@ -344,6 +570,12 @@ struct name { \ struct type **sqh_last; /* addr of last next element */ \ } +#define SIMPLEQ_CLASS_HEAD(name, type) \ +struct name { \ + class type *sqh_first; /* first element */ \ + class type **sqh_last; /* addr of last next element */ \ +} + #define SIMPLEQ_HEAD_INITIALIZER(head) \ { NULL, &(head).sqh_first } @@ -352,88 +584,209 @@ struct { \ struct type *sqe_next; /* next element */ \ } +#define SIMPLEQ_CLASS_ENTRY(type) \ +struct { \ + class type *sqe_next; /* next element */ \ +} + +/* + * Simple queue access methods. + */ +#define SIMPLEQ_FIRST(head) ((head)->sqh_first) +#define SIMPLEQ_END(head) NULL +#define SIMPLEQ_EMPTY(head) ((head)->sqh_first == SIMPLEQ_END(head)) +#define SIMPLEQ_NEXT(elm, field) ((elm)->field.sqe_next) + +#define SIMPLEQ_FOREACH(var, head, field) \ + for ((var) = SIMPLEQ_FIRST((head)); \ + (var) != SIMPLEQ_END(head); \ + (var) = SIMPLEQ_NEXT((var), field)) + +#define SIMPLEQ_FOREACH_FROM(var, head, field) \ + for ((var) = \ + ((var) != SIMPLEQ_END(head) ? (var) : SIMPLEQ_FIRST((head)));\ + (var) != SIMPLEQ_END(head); \ + (var) = SIMPLEQ_NEXT((var), field)) + +#define SIMPLEQ_FOREACH_SAFE(var, head, field, tvar) \ + for ((var) = SIMPLEQ_FIRST((head)); \ + (var) != SIMPLEQ_END(head) && \ + ((tvar) = SIMPLEQ_NEXT((var), field), 1); \ + (var) = (tvar)) + +#define SIMPLEQ_FOREACH_FROM_SAFE(var, head, field, tvar) \ + for ((var) = \ + ((var) != SIMPLEQ_END(head) ? (var) : SIMPLEQ_FIRST((head)));\ + (var) != SIMPLEQ_END(head) && \ + ((tvar) = SIMPLEQ_NEXT((var), field), 1); \ + (var) = (tvar)) + /* * Simple queue functions. */ #define SIMPLEQ_INIT(head) do { \ - (head)->sqh_first = NULL; \ - (head)->sqh_last = &(head)->sqh_first; \ + SIMPLEQ_FIRST((head)) = NULL; \ + (head)->sqh_last = &SIMPLEQ_FIRST((head)); \ _NOTE(CONSTCOND) \ } while (0) #define SIMPLEQ_INSERT_HEAD(head, elm, field) do { \ - if (((elm)->field.sqe_next = (head)->sqh_first) == NULL) \ - (head)->sqh_last = &(elm)->field.sqe_next; \ - (head)->sqh_first = (elm); \ + if ((SIMPLEQ_NEXT((elm), field) = SIMPLEQ_FIRST((head))) == NULL)\ + (head)->sqh_last = &SIMPLEQ_NEXT((elm), field); \ + SIMPLEQ_FIRST((head)) = (elm); \ _NOTE(CONSTCOND) \ } while (0) #define SIMPLEQ_INSERT_TAIL(head, elm, field) do { \ - (elm)->field.sqe_next = NULL; \ + SIMPLEQ_NEXT((elm), field) = NULL; \ *(head)->sqh_last = (elm); \ - (head)->sqh_last = &(elm)->field.sqe_next; \ + (head)->sqh_last = &SIMPLEQ_NEXT((elm), field); \ _NOTE(CONSTCOND) \ } while (0) #define SIMPLEQ_INSERT_AFTER(head, listelm, elm, field) do { \ - if (((elm)->field.sqe_next = (listelm)->field.sqe_next) == NULL)\ - (head)->sqh_last = &(elm)->field.sqe_next; \ - (listelm)->field.sqe_next = (elm); \ + if ((SIMPLEQ_NEXT((elm), field) = SIMPLEQ_NEXT((listelm), field)) == \ + NULL) \ + (head)->sqh_last = &SIMPLEQ_NEXT((elm), field); \ + SIMPLEQ_NEXT((listelm), field) = (elm); \ _NOTE(CONSTCOND) \ } while (0) #define SIMPLEQ_REMOVE_HEAD(head, field) do { \ - if (((head)->sqh_first = (head)->sqh_first->field.sqe_next) == NULL) \ - (head)->sqh_last = &(head)->sqh_first; \ + if ((SIMPLEQ_FIRST((head)) = \ + SIMPLEQ_NEXT(SIMPLEQ_FIRST((head)), field)) == NULL) \ + (head)->sqh_last = &SIMPLEQ_FIRST((head)); \ + _NOTE(CONSTCOND) \ +} while (0) + +#define SIMPLEQ_REMOVE_AFTER(head, elm, field) do { \ + if ((SIMPLEQ_NEXT((elm)) = \ + SIMPLEQ_NEXT(SIMPLEQ_NEXT((elm), field), field)) == NULL) \ + (head)->sqh_last = &SIMPLEQ_NEXT((elm), field); \ _NOTE(CONSTCOND) \ } while (0) #define SIMPLEQ_REMOVE(head, elm, type, field) do { \ - if ((head)->sqh_first == (elm)) { \ + if (SIMPLEQ_FIRST((head)) == (elm)) { \ SIMPLEQ_REMOVE_HEAD((head), field); \ } else { \ - struct type *curelm = (head)->sqh_first; \ - while (curelm->field.sqe_next != (elm)) \ - curelm = curelm->field.sqe_next; \ - if ((curelm->field.sqe_next = \ - curelm->field.sqe_next->field.sqe_next) == NULL) \ - (head)->sqh_last = &(curelm)->field.sqe_next; \ + QUEUE_TYPEOF(type) *curelm = SIMPLEQ_FIRST((head)); \ + while (SIMPLEQ_NEXT(curelm, field) != (elm)) \ + curelm = SIMPLEQ_NEXT(curelm, field); \ + SIMPLEQ_REMOVE_AFTER((head), curelm, field); \ } \ _NOTE(CONSTCOND) \ } while (0) -#define SIMPLEQ_FOREACH(var, head, field) \ - for ((var) = ((head)->sqh_first); \ - (var); \ - (var) = ((var)->field.sqe_next)) - -/* - * Simple queue access methods. - */ -#define SIMPLEQ_EMPTY(head) ((head)->sqh_first == NULL) -#define SIMPLEQ_FIRST(head) ((head)->sqh_first) -#define SIMPLEQ_NEXT(elm, field) ((elm)->field.sqe_next) +#define SIMPLEQ_CONCAT(head1, head2) do { \ + if (!SIMPLEQ_EMPTY((head2))) { \ + *(head1)->sqh_last = (head2)->sqh_first; \ + (head1)->sqh_last = (head2)->sqh_last; \ + SIMPLEQ_INIT((head2)); \ + } \ + _NOTE(CONSTCOND) \ +} while (0) +#define SIMPLEQ_LAST(head, type, field) \ + (SIMPLEQ_EMPTY((head)) ? \ + NULL : \ + ((QUEUE_TYPEOF(type) *)(void *) \ + ((char *)((head)->sqh_last) - offsetof(QUEUE_TYPEOF(type), field)))) /* * Tail queue definitions. */ -#define _TAILQ_HEAD(name, type) \ +#define TAILQ_HEAD(name, type) \ +struct name { \ + struct type *tqh_first; /* first element */ \ + struct type **tqh_last; /* addr of last next element */ \ + TRACEBUF \ +} + +#define TAILQ_CLASS_HEAD(name, type) \ struct name { \ - type *tqh_first; /* first element */ \ - type **tqh_last; /* addr of last next element */ \ + class type *tqh_first; /* first element */ \ + class type **tqh_last; /* addr of last next element */ \ + TRACEBUF \ } -#define TAILQ_HEAD(name, type) _TAILQ_HEAD(name, struct type) #define TAILQ_HEAD_INITIALIZER(head) \ { NULL, &(head).tqh_first } -#define _TAILQ_ENTRY(type) \ +#define TAILQ_ENTRY(type) \ struct { \ - type *tqe_next; /* next element */ \ - type **tqe_prev; /* address of previous next element */\ + struct type *tqe_next; /* next element */ \ + struct type **tqe_prev; /* address of previous next element */ \ + TRACEBUF \ +} + +#define TAILQ_CLASS_ENTRY(type) \ +struct { \ + class type *tqe_next; /* next element */ \ + class type **tqe_prev; /* address of previous next element */ \ + TRACEBUF \ } -#define TAILQ_ENTRY(type) _TAILQ_ENTRY(struct type) + +/* + * Tail queue access methods. + */ +#define TAILQ_FIRST(head) ((head)->tqh_first) +#define TAILQ_END(head) NULL +#define TAILQ_NEXT(elm, field) ((elm)->field.tqe_next) +#define TAILQ_LAST(head, headname) \ + (*(((struct headname *)((head)->tqh_last))->tqh_last)) +#define TAILQ_PREV(elm, headname, field) \ + (*(((struct headname *)((elm)->field.tqe_prev))->tqh_last)) +#define TAILQ_EMPTY(head) ((head)->tqh_first == TAILQ_END(head)) + + +#define TAILQ_FOREACH(var, head, field) \ + for ((var) = TAILQ_FIRST((head)); \ + (var) != TAILQ_END(head); \ + (var) = TAILQ_NEXT((var), field)) + +#define TAILQ_FOREACH_FROM(var, head, field) \ + for ((var) = ((var) != TAILQ_END((head)) ? \ + (var) : TAILQ_FIRST((head))); \ + (var) != TAILQ_END(head); \ + (var) = TAILQ_NEXT((var), field)) + +#define TAILQ_FOREACH_SAFE(var, head, field, tvar) \ + for ((var) = TAILQ_FIRST((head)); \ + (var) != TAILQ_END(head) && \ + ((tvar) = TAILQ_NEXT((var), field), 1); \ + (var) = (tvar)) + +#define TAILQ_FOREACH_FROM_SAFE(var, head, field, tvar) \ + for ((var) = ((var) != TAILQ_END((head)) ? \ + (var) : TAILQ_FIRST((head))); \ + (var) != TAILQ_END(head) && \ + ((tvar) = TAILQ_NEXT((var), field), 1); \ + (var) = (tvar)) + +#define TAILQ_FOREACH_REVERSE(var, head, headname, field) \ + for ((var) = TAILQ_LAST((head), headname); \ + (var) != TAILQ_END(head); \ + (var) = TAILQ_PREV((var), headname, field)) + +#define TAILQ_FOREACH_REVERSE_FROM(var, head, headname, field) \ + for ((var) = ((var) != TAILQ_END((head)) ? \ + (var) : TAILQ_LAST((head), headname)); \ + (var) != TAILQ_END(head); \ + (var) = TAILQ_PREV((var), headname, field)) + +#define TAILQ_FOREACH_REVERSE_SAFE(var, head, headname, field, tvar) \ + for ((var) = TAILQ_LAST((head), headname); \ + (var) != TAILQ_END(head) && \ + ((tvar) = TAILQ_PREV((var), headname, field), 1); \ + (var) = (tvar)) + +#define TAILQ_FOREACH_REVERSE_FROM_SAFE(var, head, headname, field, tvar)\ + for ((var) = ((var) != TAILQ_END((head)) ? \ + (var) : TAILQ_LAST((head), headname)); \ + (var) != TAILQ_END(head) && \ + ((tvar) = TAILQ_PREV((var), headname, field), 1); \ + (var) = (tvar)) /* * Tail queue functions. @@ -474,92 +827,88 @@ struct { \ #endif #define TAILQ_INIT(head) do { \ - (head)->tqh_first = NULL; \ - (head)->tqh_last = &(head)->tqh_first; \ + TAILQ_FIRST((head)) = TAILQ_END((head)); \ + (head)->tqh_last = &TAILQ_FIRST((head)); \ _NOTE(CONSTCOND) \ } while (0) #define TAILQ_INSERT_HEAD(head, elm, field) do { \ QUEUEDEBUG_TAILQ_INSERT_HEAD((head), (elm), field) \ - if (((elm)->field.tqe_next = (head)->tqh_first) != NULL) \ - (head)->tqh_first->field.tqe_prev = \ - &(elm)->field.tqe_next; \ + if ((TAILQ_NEXT((elm), field) = TAILQ_FIRST((head))) != NULL) \ + TAILQ_FIRST((head))->field.tqe_prev = \ + &TAILQ_NEXT((elm), field); \ else \ - (head)->tqh_last = &(elm)->field.tqe_next; \ - (head)->tqh_first = (elm); \ - (elm)->field.tqe_prev = &(head)->tqh_first; \ + (head)->tqh_last = &TAILQ_NEXT((elm), field); \ + TAILQ_FIRST((head)) = (elm); \ + (elm)->field.tqe_prev = &TAILQ_FIRST((head)); \ _NOTE(CONSTCOND) \ } while (0) #define TAILQ_INSERT_TAIL(head, elm, field) do { \ QUEUEDEBUG_TAILQ_INSERT_TAIL((head), (elm), field) \ - (elm)->field.tqe_next = NULL; \ + TAILQ_NEXT((elm), field) = NULL; \ (elm)->field.tqe_prev = (head)->tqh_last; \ *(head)->tqh_last = (elm); \ - (head)->tqh_last = &(elm)->field.tqe_next; \ + (head)->tqh_last = &TAILQ_NEXT((elm), field); \ _NOTE(CONSTCOND) \ } while (0) #define TAILQ_INSERT_AFTER(head, listelm, elm, field) do { \ QUEUEDEBUG_TAILQ_OP((listelm), field) \ - if (((elm)->field.tqe_next = (listelm)->field.tqe_next) != NULL)\ - (elm)->field.tqe_next->field.tqe_prev = \ - &(elm)->field.tqe_next; \ + if ((TAILQ_NEXT((elm), field) = TAILQ_NEXT((listelm), field)) != NULL)\ + TAILQ_NEXT((elm), field)->field.tqe_prev = \ + &TAILQ_NEXT((elm), field); \ else \ - (head)->tqh_last = &(elm)->field.tqe_next; \ - (listelm)->field.tqe_next = (elm); \ - (elm)->field.tqe_prev = &(listelm)->field.tqe_next; \ + (head)->tqh_last = &TAILQ_NEXT((elm), field); \ + TAILQ_NEXT((listelm), field) = (elm); \ + (elm)->field.tqe_prev = &TAILQ_NEXT((listelm), field); \ _NOTE(CONSTCOND) \ } while (0) #define TAILQ_INSERT_BEFORE(listelm, elm, field) do { \ QUEUEDEBUG_TAILQ_OP((listelm), field) \ (elm)->field.tqe_prev = (listelm)->field.tqe_prev; \ - (elm)->field.tqe_next = (listelm); \ + TAILQ_NEXT((elm), field) = (listelm); \ *(listelm)->field.tqe_prev = (elm); \ - (listelm)->field.tqe_prev = &(elm)->field.tqe_next; \ + (listelm)->field.tqe_prev = &TAILQ_NEXT((elm), field); \ _NOTE(CONSTCOND) \ } while (0) #define TAILQ_REMOVE(head, elm, field) do { \ QUEUEDEBUG_TAILQ_PREREMOVE((head), (elm), field) \ QUEUEDEBUG_TAILQ_OP((elm), field) \ - if (((elm)->field.tqe_next) != NULL) \ - (elm)->field.tqe_next->field.tqe_prev = \ + if ((TAILQ_NEXT((elm), field)) != NULL) \ + TAILQ_NEXT((elm), field)->field.tqe_prev = \ (elm)->field.tqe_prev; \ else \ (head)->tqh_last = (elm)->field.tqe_prev; \ - *(elm)->field.tqe_prev = (elm)->field.tqe_next; \ + *(elm)->field.tqe_prev = TAILQ_NEXT((elm), field); \ QUEUEDEBUG_TAILQ_POSTREMOVE((elm), field); \ _NOTE(CONSTCOND) \ } while (0) -#define TAILQ_FOREACH(var, head, field) \ - for ((var) = ((head)->tqh_first); \ - (var); \ - (var) = ((var)->field.tqe_next)) - -#define TAILQ_FOREACH_REVERSE(var, head, headname, field) \ - for ((var) = (*(((struct headname *)((head)->tqh_last))->tqh_last));\ - (var); \ - (var) = \ - (*(((struct headname *)((var)->field.tqe_prev))->tqh_last))) - -/* - * Tail queue access methods. - */ -#define TAILQ_EMPTY(head) ((head)->tqh_first == NULL) -#define TAILQ_FIRST(head) ((head)->tqh_first) -#define TAILQ_NEXT(elm, field) ((elm)->field.tqe_next) - -#define TAILQ_LAST(head, headname) \ - (*(((struct headname *)((head)->tqh_last))->tqh_last)) -#define TAILQ_PREV(elm, headname, field) \ - (*(((struct headname *)((elm)->field.tqe_prev))->tqh_last)) - +#define TAILQ_SWAP(head1, head2, type, field) do { \ + QUEUE_TYPEOF(type) *swap_first = TAILQ_FIRST((head1)); \ + QUEUE_TYPEOF(type) **swap_last = (head1)->tqh_last; \ + TAILQ_FIRST((head1)) = TAILQ_FIRST((head2)); \ + (head1)->tqh_last = (head2)->tqh_last; \ + TAILQ_FIRST((head2)) = swap_first; \ + (head2)->tqh_last = swap_last; \ + if ((swap_first = TAILQ_FIRST((head1))) != NULL) \ + swap_first->field.tqe_prev = &TAILQ_FIRST((head1)); \ + else \ + (head1)->tqh_last = &TAILQ_FIRST((head1)); \ + if ((swap_first = TAILQ_FIRST((head2))) != NULL) \ + swap_first->field.tqe_prev = &TAILQ_FIRST((head2)); \ + else \ + (head2)->tqh_last = &TAILQ_FIRST((head2)); \ + _NOTE(CONSTCOND) \ +} while (0) /* - * Circular queue definitions. + * Circular queue definitions. Do not use. We still keep the macros + * for compatibility but because of pointer aliasing issues their use + * is discouraged! */ #define CIRCLEQ_HEAD(name, type) \ struct name { \ @@ -577,6 +926,34 @@ struct { \ } /* + * Circular queue access methods. + */ +#define CIRCLEQ_EMPTY(head) ((head)->cqh_first == (void *)(head)) +#define CIRCLEQ_FIRST(head) ((head)->cqh_first) +#define CIRCLEQ_LAST(head) ((head)->cqh_last) +#define CIRCLEQ_NEXT(elm, field) ((elm)->field.cqe_next) +#define CIRCLEQ_PREV(elm, field) ((elm)->field.cqe_prev) + +#define CIRCLEQ_LOOP_NEXT(head, elm, field) \ + (((elm)->field.cqe_next == (void *)(head)) \ + ? ((head)->cqh_first) \ + : (elm->field.cqe_next)) +#define CIRCLEQ_LOOP_PREV(head, elm, field) \ + (((elm)->field.cqe_prev == (void *)(head)) \ + ? ((head)->cqh_last) \ + : (elm->field.cqe_prev)) + +#define CIRCLEQ_FOREACH(var, head, field) \ + for ((var) = CIRCLEQ_FIRST((head)); \ + (var) != (void *)(head); \ + (var) = CIRCLEQ_NEXT((var), field)) + +#define CIRCLEQ_FOREACH_REVERSE(var, head, field) \ + for ((var) = CIRCLEQ_LAST((head)); \ + (var) != (void *)(head); \ + (var) = CIRCLEQ_PREV((var), field)) + +/* * Circular queue functions. */ #define CIRCLEQ_INIT(head) do { \ @@ -643,35 +1020,7 @@ struct { \ _NOTE(CONSTCOND) \ } while (0) -#define CIRCLEQ_FOREACH(var, head, field) \ - for ((var) = ((head)->cqh_first); \ - (var) != (void *)(head); \ - (var) = ((var)->field.cqe_next)) - -#define CIRCLEQ_FOREACH_REVERSE(var, head, field) \ - for ((var) = ((head)->cqh_last); \ - (var) != (void *)(head); \ - (var) = ((var)->field.cqe_prev)) - -/* - * Circular queue access methods. - */ -#define CIRCLEQ_EMPTY(head) ((head)->cqh_first == (void *)(head)) -#define CIRCLEQ_FIRST(head) ((head)->cqh_first) -#define CIRCLEQ_LAST(head) ((head)->cqh_last) -#define CIRCLEQ_NEXT(elm, field) ((elm)->field.cqe_next) -#define CIRCLEQ_PREV(elm, field) ((elm)->field.cqe_prev) - -#define CIRCLEQ_LOOP_NEXT(head, elm, field) \ - (((elm)->field.cqe_next == (void *)(head)) \ - ? ((head)->cqh_first) \ - : (elm->field.cqe_next)) -#define CIRCLEQ_LOOP_PREV(head, elm, field) \ - (((elm)->field.cqe_prev == (void *)(head)) \ - ? ((head)->cqh_last) \ - : (elm->field.cqe_prev)) - -#ifdef __cplusplus +#ifdef __cplusplus } #endif |