2020-10-24 22:21:09 +00:00
|
|
|
.\" Copyright (c) 1993
|
|
|
|
.\" The Regents of the University of California. All rights reserved.
|
|
|
|
.\" and Copyright (c) 2020 by Alejandro Colomar <colomar.6.4.3@gmail.com>
|
|
|
|
.\"
|
|
|
|
.\" %%%LICENSE_START(BSD_3_CLAUSE_UCB)
|
|
|
|
.\" 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.
|
|
|
|
.\" %%%LICENSE_END
|
|
|
|
.\"
|
|
|
|
.\"
|
|
|
|
.TH STAILQ 3 2020-10-21 "GNU" "Linux Programmer's Manual"
|
|
|
|
.SH NAME
|
2021-02-15 16:32:37 +00:00
|
|
|
.\"SIMPLEQ_CONCAT,
|
|
|
|
SIMPLEQ_EMPTY,
|
|
|
|
SIMPLEQ_ENTRY,
|
|
|
|
SIMPLEQ_FIRST,
|
|
|
|
SIMPLEQ_FOREACH,
|
|
|
|
.\"SIMPLEQ_FOREACH_FROM,
|
|
|
|
.\"SIMPLEQ_FOREACH_FROM_SAFE,
|
|
|
|
.\"SIMPLEQ_FOREACH_SAFE,
|
|
|
|
SIMPLEQ_HEAD,
|
|
|
|
SIMPLEQ_HEAD_INITIALIZER,
|
|
|
|
SIMPLEQ_INIT,
|
|
|
|
SIMPLEQ_INSERT_AFTER,
|
|
|
|
SIMPLEQ_INSERT_HEAD,
|
|
|
|
SIMPLEQ_INSERT_TAIL,
|
|
|
|
.\"SIMPLEQ_LAST,
|
|
|
|
SIMPLEQ_NEXT,
|
|
|
|
SIMPLEQ_REMOVE,
|
|
|
|
.\"SIMPLEQ_REMOVE_AFTER,
|
|
|
|
SIMPLEQ_REMOVE_HEAD,
|
|
|
|
.\"SIMPLEQ_SWAP,
|
2020-10-24 22:21:15 +00:00
|
|
|
STAILQ_CONCAT,
|
|
|
|
STAILQ_EMPTY,
|
|
|
|
STAILQ_ENTRY,
|
|
|
|
STAILQ_FIRST,
|
|
|
|
STAILQ_FOREACH,
|
|
|
|
.\"STAILQ_FOREACH_FROM,
|
|
|
|
.\"STAILQ_FOREACH_FROM_SAFE,
|
|
|
|
.\"STAILQ_FOREACH_SAFE,
|
|
|
|
STAILQ_HEAD,
|
|
|
|
STAILQ_HEAD_INITIALIZER,
|
|
|
|
STAILQ_INIT,
|
|
|
|
STAILQ_INSERT_AFTER,
|
|
|
|
STAILQ_INSERT_HEAD,
|
|
|
|
STAILQ_INSERT_TAIL,
|
|
|
|
.\"STAILQ_LAST,
|
|
|
|
STAILQ_NEXT,
|
|
|
|
STAILQ_REMOVE,
|
|
|
|
.\"STAILQ_REMOVE_AFTER,
|
|
|
|
STAILQ_REMOVE_HEAD,
|
|
|
|
.\"STAILQ_SWAP
|
2020-10-25 11:23:43 +00:00
|
|
|
\- implementation of a singly linked tail queue
|
2020-10-24 22:21:09 +00:00
|
|
|
.SH SYNOPSIS
|
2020-10-24 22:21:15 +00:00
|
|
|
.nf
|
|
|
|
.B #include <sys/queue.h>
|
|
|
|
.PP
|
|
|
|
.B STAILQ_ENTRY(TYPE);
|
|
|
|
.PP
|
2021-01-05 22:39:57 +00:00
|
|
|
.B STAILQ_HEAD(HEADNAME, TYPE);
|
|
|
|
.BI "STAILQ_HEAD STAILQ_HEAD_INITIALIZER(STAILQ_HEAD " head );
|
|
|
|
.BI "void STAILQ_INIT(STAILQ_HEAD *" head );
|
|
|
|
.PP
|
|
|
|
.BI "int STAILQ_EMPTY(STAILQ_HEAD *" head );
|
2020-10-24 22:21:15 +00:00
|
|
|
.PP
|
2021-01-05 22:39:57 +00:00
|
|
|
.BI "void STAILQ_INSERT_HEAD(STAILQ_HEAD *" head ,
|
|
|
|
.BI " struct TYPE *" elm ", STAILQ_ENTRY " NAME );
|
|
|
|
.BI "void STAILQ_INSERT_TAIL(STAILQ_HEAD *" head ,
|
|
|
|
.BI " struct TYPE *" elm ", STAILQ_ENTRY " NAME );
|
|
|
|
.BI "void STAILQ_INSERT_AFTER(STAILQ_HEAD *" head ", struct TYPE *" listelm ,
|
|
|
|
.BI " struct TYPE *" elm ", STAILQ_ENTRY " NAME );
|
2020-10-24 22:21:15 +00:00
|
|
|
.PP
|
2021-01-05 22:39:57 +00:00
|
|
|
.BI "struct TYPE *STAILQ_FIRST(STAILQ_HEAD *" head );
|
|
|
|
.\" .BI "struct TYPE *STAILQ_LAST(STAILQ_HEAD *" head ", struct TYPE *" elm ,
|
|
|
|
.\" .BI " STAILQ_ENTRY " NAME );
|
|
|
|
.BI "struct TYPE *STAILQ_NEXT(struct TYPE *" elm ", STAILQ_ENTRY " NAME );
|
2020-10-24 22:21:15 +00:00
|
|
|
.PP
|
2021-01-05 22:39:57 +00:00
|
|
|
.BI "STAILQ_FOREACH(struct TYPE *" var ", STAILQ_HEAD *" head ", STAILQ_ENTRY " NAME );
|
|
|
|
.\" .BI "STAILQ_FOREACH_FROM(struct TYPE *" var ", STAILQ_HEAD *" head ,
|
|
|
|
.\" .BI " STAILQ_ENTRY " NAME );
|
2020-10-24 22:21:15 +00:00
|
|
|
.\" .PP
|
2021-01-05 22:39:57 +00:00
|
|
|
.\" .BI "STAILQ_FOREACH_SAFE(struct TYPE *" var ", STAILQ_HEAD *" head ,
|
|
|
|
.\" .BI " STAILQ_ENTRY " NAME ", struct TYPE *" temp_var );
|
|
|
|
.\" .BI "STAILQ_FOREACH_FROM_SAFE(struct TYPE *" var ", STAILQ_HEAD *" head ,
|
|
|
|
.\" .BI " STAILQ_ENTRY " NAME ", struct TYPE *" temp_var );
|
2020-10-24 22:21:15 +00:00
|
|
|
.PP
|
2020-10-25 10:46:24 +00:00
|
|
|
.BI "void STAILQ_REMOVE(STAILQ_HEAD *" head ", struct TYPE *" elm ", TYPE,"
|
2021-01-05 22:39:57 +00:00
|
|
|
.BI " STAILQ_ENTRY " NAME );
|
|
|
|
.BI "void STAILQ_REMOVE_HEAD(STAILQ_HEAD *" head ,
|
|
|
|
.BI " STAILQ_ENTRY " NAME );
|
|
|
|
.\" .BI "void STAILQ_REMOVE_AFTER(STAILQ_HEAD *" head ", struct TYPE *" elm ,
|
|
|
|
.\" .BI " STAILQ_ENTRY " NAME );
|
|
|
|
.PP
|
|
|
|
.BI "void STAILQ_CONCAT(STAILQ_HEAD *" head1 ", STAILQ_HEAD *" head2 );
|
|
|
|
.\" .BI "void STAILQ_SWAP(STAILQ_HEAD *" head1 ", STAILQ_HEAD *" head2 ,
|
|
|
|
.\" .BI " STAILQ_ENTRY " NAME );
|
2020-10-24 22:21:15 +00:00
|
|
|
.fi
|
2021-02-15 16:32:37 +00:00
|
|
|
.IR Note :
|
|
|
|
Identical macros prefixed with SIMPLEQ instead of STAILQ exist; see NOTES.
|
2020-10-24 22:21:09 +00:00
|
|
|
.SH DESCRIPTION
|
2020-10-25 11:23:43 +00:00
|
|
|
These macros define and operate on singly linked tail queues.
|
2020-10-24 22:21:16 +00:00
|
|
|
.PP
|
2020-10-24 22:21:14 +00:00
|
|
|
In the macro definitions,
|
2020-10-24 22:21:15 +00:00
|
|
|
.I TYPE
|
2020-10-24 22:21:14 +00:00
|
|
|
is the name of a user-defined structure,
|
|
|
|
that must contain a field of type
|
2020-10-24 22:21:15 +00:00
|
|
|
.IR STAILQ_ENTRY ,
|
2020-10-24 22:21:14 +00:00
|
|
|
named
|
2020-10-24 22:21:15 +00:00
|
|
|
.IR NAME .
|
2020-10-24 22:21:14 +00:00
|
|
|
The argument
|
2020-10-24 22:21:15 +00:00
|
|
|
.I HEADNAME
|
2020-10-24 22:21:14 +00:00
|
|
|
is the name of a user-defined structure that must be declared
|
|
|
|
using the macro
|
2020-10-24 22:21:15 +00:00
|
|
|
.BR STAILQ_HEAD ().
|
2021-01-05 22:39:57 +00:00
|
|
|
.SS Creation
|
2020-10-25 11:23:43 +00:00
|
|
|
A singly linked tail queue is headed by a structure defined by the
|
2020-10-24 22:21:15 +00:00
|
|
|
.BR STAILQ_HEAD ()
|
2020-10-24 22:21:12 +00:00
|
|
|
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
|
2021-01-05 22:39:57 +00:00
|
|
|
manipulation overhead at the expense of O(n) removal for arbitrary elements.
|
2020-10-24 22:21:12 +00:00
|
|
|
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
|
2020-10-24 22:21:15 +00:00
|
|
|
.I STAILQ_HEAD
|
2020-10-24 22:21:12 +00:00
|
|
|
structure is declared as follows:
|
2020-10-24 22:21:15 +00:00
|
|
|
.PP
|
|
|
|
.in +4
|
|
|
|
.EX
|
2020-10-24 22:21:12 +00:00
|
|
|
STAILQ_HEAD(HEADNAME, TYPE) head;
|
2020-10-24 22:21:15 +00:00
|
|
|
.EE
|
|
|
|
.in
|
|
|
|
.PP
|
2020-10-24 22:21:12 +00:00
|
|
|
where
|
2020-10-25 10:46:24 +00:00
|
|
|
.I struct HEADNAME
|
|
|
|
is the structure to be defined, and
|
|
|
|
.I struct TYPE
|
2020-10-24 22:21:12 +00:00
|
|
|
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:
|
2020-10-24 22:21:15 +00:00
|
|
|
.PP
|
|
|
|
.in +4
|
|
|
|
.EX
|
2020-10-24 22:21:12 +00:00
|
|
|
struct HEADNAME *headp;
|
2020-10-24 22:21:15 +00:00
|
|
|
.EE
|
|
|
|
.in
|
|
|
|
.PP
|
2020-10-24 22:21:12 +00:00
|
|
|
(The names
|
2020-10-24 22:21:15 +00:00
|
|
|
.I head
|
2020-10-24 22:21:12 +00:00
|
|
|
and
|
2020-10-24 22:21:15 +00:00
|
|
|
.I headp
|
2020-10-24 22:21:12 +00:00
|
|
|
are user selectable.)
|
2020-10-24 22:21:15 +00:00
|
|
|
.PP
|
2021-01-05 22:39:57 +00:00
|
|
|
.BR STAILQ_ENTRY ()
|
|
|
|
declares a structure that connects the elements in the tail queue.
|
|
|
|
.PP
|
2020-10-24 22:21:15 +00:00
|
|
|
.BR STAILQ_HEAD_INITIALIZER ()
|
2020-10-24 22:21:12 +00:00
|
|
|
evaluates to an initializer for the tail queue
|
2020-10-24 22:21:15 +00:00
|
|
|
.IR head .
|
|
|
|
.PP
|
2021-01-05 22:39:57 +00:00
|
|
|
.BR STAILQ_INIT ()
|
|
|
|
initializes the tail queue referenced by
|
|
|
|
.IR head .
|
2020-10-24 22:21:15 +00:00
|
|
|
.PP
|
|
|
|
.BR STAILQ_EMPTY ()
|
2020-10-24 22:21:12 +00:00
|
|
|
evaluates to true if there are no items on the tail queue.
|
2021-01-05 22:39:57 +00:00
|
|
|
.SS Insertion
|
|
|
|
.BR STAILQ_INSERT_HEAD ()
|
|
|
|
inserts the new element
|
|
|
|
.I elm
|
|
|
|
at the head of the tail queue.
|
2020-10-24 22:21:15 +00:00
|
|
|
.PP
|
2021-01-05 22:39:57 +00:00
|
|
|
.BR STAILQ_INSERT_TAIL ()
|
|
|
|
inserts the new element
|
|
|
|
.I elm
|
|
|
|
at the end of the tail queue.
|
2020-10-24 22:21:15 +00:00
|
|
|
.PP
|
2021-01-05 22:39:57 +00:00
|
|
|
.BR STAILQ_INSERT_AFTER ()
|
|
|
|
inserts the new element
|
|
|
|
.I elm
|
|
|
|
after the element
|
|
|
|
.IR listelm .
|
|
|
|
.SS Traversal
|
2020-10-24 22:21:15 +00:00
|
|
|
.BR STAILQ_FIRST ()
|
2021-01-05 22:39:57 +00:00
|
|
|
returns the first item on the tail queue or NULL if the tail queue is empty.
|
|
|
|
.\" .PP
|
|
|
|
.\" .BR STAILQ_LAST ()
|
|
|
|
.\" returns the last item on the tail queue.
|
|
|
|
.\" If the tail queue is empty the return value is NULL .
|
|
|
|
.PP
|
|
|
|
.BR STAILQ_NEXT ()
|
|
|
|
returns the next item on the tail queue, or NULL this item is the last.
|
2020-10-24 22:21:15 +00:00
|
|
|
.PP
|
|
|
|
.BR STAILQ_FOREACH ()
|
2020-10-24 22:21:12 +00:00
|
|
|
traverses the tail queue referenced by
|
2020-10-24 22:21:15 +00:00
|
|
|
.I head
|
2021-01-05 22:39:57 +00:00
|
|
|
in the forward direction,
|
|
|
|
assigning each element in turn to
|
2020-10-24 22:21:15 +00:00
|
|
|
.IR var .
|
|
|
|
.\" .PP
|
|
|
|
.\" .BR STAILQ_FOREACH_FROM ()
|
2020-10-24 22:21:12 +00:00
|
|
|
.\" behaves identically to
|
2020-10-24 22:21:15 +00:00
|
|
|
.\" .BR STAILQ_FOREACH ()
|
2020-10-24 22:21:12 +00:00
|
|
|
.\" when
|
2020-10-24 22:21:15 +00:00
|
|
|
.\" .I var
|
2020-10-24 22:21:12 +00:00
|
|
|
.\" is NULL, else it treats
|
2020-10-24 22:21:15 +00:00
|
|
|
.\" .I var
|
2020-10-24 22:21:12 +00:00
|
|
|
.\" as a previously found STAILQ element and begins the loop at
|
2020-10-24 22:21:15 +00:00
|
|
|
.\" .I var
|
2020-10-24 22:21:12 +00:00
|
|
|
.\" instead of the first element in the STAILQ referenced by
|
2020-10-24 22:21:15 +00:00
|
|
|
.\" .IR head .
|
|
|
|
.\" .PP
|
|
|
|
.\" .BR STAILQ_FOREACH_SAFE ()
|
2020-10-24 22:21:12 +00:00
|
|
|
.\" traverses the tail queue referenced by
|
2020-10-24 22:21:15 +00:00
|
|
|
.\" .I head
|
2020-10-24 22:21:12 +00:00
|
|
|
.\" in the forward direction, assigning each element
|
|
|
|
.\" in turn to
|
2020-10-24 22:21:15 +00:00
|
|
|
.\" .IR var .
|
2020-10-24 22:21:12 +00:00
|
|
|
.\" However, unlike
|
2020-10-24 22:21:15 +00:00
|
|
|
.\" .BR STAILQ_FOREACH ()
|
2020-10-24 22:21:12 +00:00
|
|
|
.\" here it is permitted to both remove
|
2020-10-24 22:21:15 +00:00
|
|
|
.\" .I var
|
2020-10-24 22:21:12 +00:00
|
|
|
.\" as well as free it from within the loop safely without interfering with the
|
|
|
|
.\" traversal.
|
2020-10-24 22:21:15 +00:00
|
|
|
.\" .PP
|
|
|
|
.\" .BR STAILQ_FOREACH_FROM_SAFE ()
|
2020-10-24 22:21:12 +00:00
|
|
|
.\" behaves identically to
|
2020-10-24 22:21:15 +00:00
|
|
|
.\" .BR STAILQ_FOREACH_SAFE ()
|
2020-10-24 22:21:12 +00:00
|
|
|
.\" when
|
2020-10-24 22:21:15 +00:00
|
|
|
.\" .I var
|
2020-10-24 22:21:12 +00:00
|
|
|
.\" is NULL, else it treats
|
2020-10-24 22:21:15 +00:00
|
|
|
.\" .I var
|
2020-10-24 22:21:12 +00:00
|
|
|
.\" as a previously found STAILQ element and begins the loop at
|
2020-10-24 22:21:15 +00:00
|
|
|
.\" .I var
|
2020-10-24 22:21:12 +00:00
|
|
|
.\" instead of the first element in the STAILQ referenced by
|
2020-10-24 22:21:15 +00:00
|
|
|
.\" .IR head .
|
2021-01-05 22:39:57 +00:00
|
|
|
.SS Removal
|
|
|
|
.BR STAILQ_REMOVE ()
|
|
|
|
removes the element
|
2020-10-24 22:21:15 +00:00
|
|
|
.I elm
|
2021-01-05 22:39:57 +00:00
|
|
|
from the tail queue.
|
2020-10-24 22:21:15 +00:00
|
|
|
.PP
|
2021-01-05 22:39:57 +00:00
|
|
|
.BR 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
|
|
|
|
.BR STAILQ_REMOVE ()
|
|
|
|
macro.
|
2020-10-24 22:21:15 +00:00
|
|
|
.\" .PP
|
|
|
|
.\" .BR STAILQ_REMOVE_AFTER ()
|
2020-10-24 22:21:12 +00:00
|
|
|
.\" removes the element after
|
2020-10-24 22:21:15 +00:00
|
|
|
.\" .I elm
|
2020-10-24 22:21:12 +00:00
|
|
|
.\" from the tail queue.
|
|
|
|
.\" Unlike
|
2020-10-24 22:21:15 +00:00
|
|
|
.\" .BR STAILQ_REMOVE (),
|
2020-10-24 22:21:12 +00:00
|
|
|
.\" this macro does not traverse the entire tail queue.
|
2021-01-05 22:39:57 +00:00
|
|
|
.SS Other features
|
|
|
|
.BR STAILQ_CONCAT ()
|
|
|
|
concatenates the tail queue headed by
|
|
|
|
.I head2
|
|
|
|
onto the end of the one headed by
|
|
|
|
.I head1
|
|
|
|
removing all entries from the former.
|
2021-01-09 21:45:02 +00:00
|
|
|
.\" .PP
|
2020-10-24 22:21:15 +00:00
|
|
|
.\" .BR STAILQ_SWAP ()
|
2020-10-24 22:21:12 +00:00
|
|
|
.\" swaps the contents of
|
2020-10-24 22:21:15 +00:00
|
|
|
.\" .I head1
|
2020-10-24 22:21:12 +00:00
|
|
|
.\" and
|
2020-10-24 22:21:15 +00:00
|
|
|
.\" .IR head2 .
|
2020-10-24 22:21:09 +00:00
|
|
|
.SH RETURN VALUE
|
2020-10-24 22:21:16 +00:00
|
|
|
.BR STAILQ_EMPTY ()
|
|
|
|
returns nonzero if the queue is empty,
|
|
|
|
and zero if the queue contains at least one entry.
|
|
|
|
.PP
|
|
|
|
.BR STAILQ_FIRST (),
|
|
|
|
and
|
|
|
|
.BR STAILQ_NEXT ()
|
|
|
|
return a pointer to the first or next
|
2020-10-25 09:19:23 +00:00
|
|
|
.I TYPE
|
2020-10-24 22:21:16 +00:00
|
|
|
structure, respectively.
|
|
|
|
.PP
|
|
|
|
.BR STAILQ_HEAD_INITIALIZER ()
|
|
|
|
returns an initializer that can be assigned to the queue
|
|
|
|
.IR head .
|
2020-10-24 22:21:09 +00:00
|
|
|
.SH CONFORMING TO
|
2021-01-09 09:41:55 +00:00
|
|
|
Not in POSIX.1, POSIX.1-2001, or POSIX.1-2008.
|
2020-10-24 22:21:14 +00:00
|
|
|
Present on the BSDs
|
2020-10-24 22:21:15 +00:00
|
|
|
(STAILQ macros first appeared in 4.4BSD).
|
2020-10-24 22:21:09 +00:00
|
|
|
.SH BUGS
|
2020-10-24 22:21:16 +00:00
|
|
|
.BR STAILQ_FOREACH ()
|
|
|
|
doesn't allow
|
|
|
|
.I var
|
|
|
|
to be removed or freed within the loop,
|
|
|
|
as it would interfere with the traversal.
|
|
|
|
.BR STAILQ_FOREACH_SAFE (),
|
|
|
|
which is present on the BSDs but is not present in glibc,
|
|
|
|
fixes this limitation by allowing
|
|
|
|
.I var
|
|
|
|
to safely be removed from the list and freed from within the loop
|
|
|
|
without interfering with the traversal.
|
2021-02-15 16:32:37 +00:00
|
|
|
.SH NOTES
|
|
|
|
Some BSDs provide SIMPLEQ instead of STAILQ.
|
|
|
|
They are identical, but for historical reasons
|
|
|
|
they were named differently on different BSDs.
|
|
|
|
STAILQ originated on FreeBSD, and SIMPLEQ originated on NetBSD.
|
|
|
|
For compatibility reasons, some systems provide both sets of macros.
|
|
|
|
Glibc provides both STAILQ and SIMPLEQ,
|
|
|
|
which are identical except for a missing SIMPLEQ equivalent to
|
|
|
|
.BR STAILQ_CONCAT ().
|
2020-10-24 22:21:09 +00:00
|
|
|
.SH EXAMPLES
|
2020-10-24 22:21:15 +00:00
|
|
|
.EX
|
2020-10-24 22:21:13 +00:00
|
|
|
#include <stddef.h>
|
|
|
|
#include <stdio.h>
|
|
|
|
#include <stdlib.h>
|
|
|
|
#include <sys/queue.h>
|
|
|
|
|
|
|
|
struct entry {
|
|
|
|
int data;
|
2020-12-23 13:17:30 +00:00
|
|
|
STAILQ_ENTRY(entry) entries; /* Singly linked tail queue */
|
2020-10-24 22:21:13 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
STAILQ_HEAD(stailhead, entry);
|
|
|
|
|
|
|
|
int
|
|
|
|
main(void)
|
|
|
|
{
|
2020-10-24 22:21:14 +00:00
|
|
|
struct entry *n1, *n2, *n3, *np;
|
2020-12-23 13:23:39 +00:00
|
|
|
struct stailhead head; /* Singly linked tail queue
|
|
|
|
head */
|
2020-10-24 22:21:13 +00:00
|
|
|
|
2020-12-23 13:23:39 +00:00
|
|
|
STAILQ_INIT(&head); /* Initialize the queue */
|
2020-10-24 22:21:13 +00:00
|
|
|
|
2020-12-23 13:23:39 +00:00
|
|
|
n1 = malloc(sizeof(struct entry)); /* Insert at the head */
|
2020-10-24 22:21:13 +00:00
|
|
|
STAILQ_INSERT_HEAD(&head, n1, entries);
|
|
|
|
|
2020-12-23 13:23:39 +00:00
|
|
|
n1 = malloc(sizeof(struct entry)); /* Insert at the tail */
|
2020-10-24 22:21:13 +00:00
|
|
|
STAILQ_INSERT_TAIL(&head, n1, entries);
|
|
|
|
|
2020-12-23 13:23:39 +00:00
|
|
|
n2 = malloc(sizeof(struct entry)); /* Insert after */
|
2020-10-24 22:21:13 +00:00
|
|
|
STAILQ_INSERT_AFTER(&head, n1, n2, entries);
|
|
|
|
|
2020-12-23 13:23:39 +00:00
|
|
|
STAILQ_REMOVE(&head, n2, entry, entries); /* Deletion */
|
2020-10-24 22:21:13 +00:00
|
|
|
free(n2);
|
|
|
|
|
|
|
|
n3 = STAILQ_FIRST(&head);
|
2020-12-23 13:23:39 +00:00
|
|
|
STAILQ_REMOVE_HEAD(&head, entries); /* Deletion from the head */
|
2020-10-24 22:21:13 +00:00
|
|
|
free(n3);
|
|
|
|
|
|
|
|
n1 = STAILQ_FIRST(&head);
|
2021-01-09 22:21:02 +00:00
|
|
|
n1\->data = 0;
|
2020-10-24 22:21:13 +00:00
|
|
|
for (int i = 1; i < 5; i++) {
|
|
|
|
n1 = malloc(sizeof(struct entry));
|
|
|
|
STAILQ_INSERT_HEAD(&head, n1, entries);
|
2021-01-09 22:21:02 +00:00
|
|
|
n1\->data = i;
|
2020-10-24 22:21:13 +00:00
|
|
|
}
|
2020-12-23 13:23:39 +00:00
|
|
|
/* Forward traversal */
|
2020-10-24 22:21:13 +00:00
|
|
|
STAILQ_FOREACH(np, &head, entries)
|
2021-01-09 22:21:02 +00:00
|
|
|
printf("%i\en", np\->data);
|
2020-12-23 13:23:39 +00:00
|
|
|
/* TailQ deletion */
|
2020-10-24 22:21:13 +00:00
|
|
|
n1 = STAILQ_FIRST(&head);
|
|
|
|
while (n1 != NULL) {
|
|
|
|
n2 = STAILQ_NEXT(n1, entries);
|
|
|
|
free(n1);
|
|
|
|
n1 = n2;
|
|
|
|
}
|
|
|
|
STAILQ_INIT(&head);
|
|
|
|
|
|
|
|
exit(EXIT_SUCCESS);
|
|
|
|
}
|
2020-10-24 22:21:15 +00:00
|
|
|
.EE
|
2020-10-24 22:21:09 +00:00
|
|
|
.SH SEE ALSO
|
2020-10-25 22:08:26 +00:00
|
|
|
.BR insque (3),
|
|
|
|
.BR queue (7)
|