2004-11-03 13:51:07 +00:00
|
|
|
.\" Copyright (c) 1993
|
2020-10-25 10:21:32 +00:00
|
|
|
.\" The Regents of the University of California. All rights reserved.
|
|
|
|
.\" and Copyright (c) 2020 by Alejandro Colomar <colomar.6.4.3@gmail.com>
|
2004-11-03 13:51:07 +00:00
|
|
|
.\"
|
2015-02-07 07:26:27 +00:00
|
|
|
.\" %%%LICENSE_START(BSD_3_CLAUSE_UCB)
|
2004-11-03 13:51:07 +00:00
|
|
|
.\" 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.
|
2015-02-07 06:39:47 +00:00
|
|
|
.\" 3. Neither the name of the University nor the names of its contributors
|
2004-11-03 13:51:07 +00:00
|
|
|
.\" 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.
|
2015-02-07 07:26:27 +00:00
|
|
|
.\" %%%LICENSE_END
|
2004-11-03 13:51:07 +00:00
|
|
|
.\"
|
|
|
|
.\"
|
2020-10-25 20:46:16 +00:00
|
|
|
.TH QUEUE 7 2015-02-7 "GNU" "Linux Programmer's Manual"
|
2020-10-25 10:21:33 +00:00
|
|
|
.SH NAME
|
|
|
|
queue \- implementations of linked lists and queues
|
|
|
|
.SH DESCRIPTION
|
|
|
|
The
|
|
|
|
.I <sys/queue.h>
|
|
|
|
header file provides a set of macros that
|
|
|
|
define and operate on the following data structures:
|
|
|
|
.IP * 3
|
2020-10-25 11:23:43 +00:00
|
|
|
singly linked lists (SLIST)
|
2020-10-25 10:21:33 +00:00
|
|
|
.IP *
|
2020-10-25 11:23:43 +00:00
|
|
|
doubly linked lists (LIST)
|
2020-10-25 10:21:33 +00:00
|
|
|
.IP *
|
2020-10-25 11:23:43 +00:00
|
|
|
singly linked tail queues (STAILQ)
|
2020-10-25 10:21:33 +00:00
|
|
|
.IP *
|
2020-10-25 11:23:43 +00:00
|
|
|
doubly linked tail queues (TAILQ)
|
2020-10-25 10:21:33 +00:00
|
|
|
.IP *
|
2020-10-25 11:23:43 +00:00
|
|
|
doubly linked circular queues (CIRCLEQ)
|
2020-10-25 10:21:33 +00:00
|
|
|
.PP
|
|
|
|
All structures support the following functionality:
|
|
|
|
.IP * 3
|
2004-11-03 13:51:07 +00:00
|
|
|
Insertion of a new entry at the head of the list.
|
2020-10-25 10:21:33 +00:00
|
|
|
.IP *
|
2004-11-03 13:51:07 +00:00
|
|
|
Insertion of a new entry after any element in the list.
|
2020-10-25 10:21:33 +00:00
|
|
|
.IP *
|
2015-02-07 06:39:47 +00:00
|
|
|
O(1) removal of an entry from the head of the list.
|
2020-10-25 10:21:33 +00:00
|
|
|
.IP *
|
2004-11-03 13:51:07 +00:00
|
|
|
Forward traversal through the list.
|
2020-10-25 10:21:33 +00:00
|
|
|
.\".IP *
|
queue.3: Comment out text for functions not in glibc (related: 6559169cac)
===========
DESCRIPTION
===========
I'm documenting ``CIRCLEQ_*`` macros in queue.3. While writing
this, I noticed that the documentation for some types of
queues/lists talked about swapping contents of two lists, but only
for some of them. I then found that those macros (``*_SWAP``)
don't exist in my system (Debian), but exist in BSD, and I also
found that a previous commit (6559169cac) commented out a lot of
the *_SWAP macros documentation, but not all, and the reason was
that they were not present on glibc.
I checked that I didn't have any of the *_SWAP macros on my glibc,
so I think this is probably that the commit simply forgot to
comment some of
them.
=======
TESTING
=======
I did ``sudo make`` and then visualized the man page with
``man 3 queue``, and the changes looked good.
I also noticed that the subsection ``Tail queue example`` contents
were wrong, as they contained calls to CIRCLEQ_* macros. I will
address that in a future patch, before I submit the patch
documenting CIRCLEQ_*.
Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2020-08-04 09:40:41 +00:00
|
|
|
.\" Swapping the contents of two lists.
|
2020-10-25 10:21:33 +00:00
|
|
|
.PP
|
|
|
|
Code size and execution time
|
|
|
|
depend on the complexity of the data structure being used,
|
2020-10-25 11:11:25 +00:00
|
|
|
so programmers should take care to choose the appropriate one.
|
2020-10-25 11:23:43 +00:00
|
|
|
.SS Singly linked lists (SLIST)
|
|
|
|
Singly linked lists are the simplest
|
2015-02-07 06:39:47 +00:00
|
|
|
and support only the above functionality.
|
2020-10-25 11:23:43 +00:00
|
|
|
Singly linked lists are ideal for applications with
|
2020-10-25 10:21:33 +00:00
|
|
|
large datasets and few or no removals,
|
2015-02-07 06:39:47 +00:00
|
|
|
or for implementing a LIFO queue.
|
2020-10-25 11:23:43 +00:00
|
|
|
Singly linked lists add the following functionality:
|
2020-10-25 10:21:33 +00:00
|
|
|
.IP * 3
|
2015-02-07 06:39:47 +00:00
|
|
|
O(n) removal of any entry in the list.
|
2020-10-25 11:23:43 +00:00
|
|
|
.SS Singly linked tail queues (STAILQ)
|
|
|
|
Singly linked tail queues add the following functionality:
|
2020-10-25 10:21:33 +00:00
|
|
|
.IP * 3
|
2004-11-03 13:51:07 +00:00
|
|
|
Entries can be added at the end of a list.
|
2020-10-25 10:21:33 +00:00
|
|
|
.IP *
|
2015-02-07 06:39:47 +00:00
|
|
|
O(n) removal of any entry in the list.
|
2020-10-25 10:21:33 +00:00
|
|
|
.IP *
|
2015-02-07 06:39:47 +00:00
|
|
|
They may be concatenated.
|
2020-10-25 10:21:33 +00:00
|
|
|
.PP
|
2004-11-03 13:51:07 +00:00
|
|
|
However:
|
2020-10-25 10:21:33 +00:00
|
|
|
.IP * 3
|
2015-02-07 06:39:47 +00:00
|
|
|
All list insertions must specify the head of the list.
|
2020-10-25 10:21:33 +00:00
|
|
|
.IP *
|
2004-11-03 13:51:07 +00:00
|
|
|
Each head entry requires two pointers rather than one.
|
2020-10-25 10:21:33 +00:00
|
|
|
.PP
|
2020-10-25 11:23:43 +00:00
|
|
|
Singly linked tail queues are ideal for applications with
|
2020-10-25 10:21:33 +00:00
|
|
|
large datasets and few or no removals,
|
2015-02-07 06:39:47 +00:00
|
|
|
or for implementing a FIFO queue.
|
2020-10-25 11:23:43 +00:00
|
|
|
.SS Doubly linked data structures
|
2015-02-07 06:39:47 +00:00
|
|
|
All doubly linked types of data structures (lists and tail queues)
|
|
|
|
additionally allow:
|
2020-10-25 10:21:33 +00:00
|
|
|
.IP * 3
|
2015-02-07 06:39:47 +00:00
|
|
|
Insertion of a new entry before any element in the list.
|
2020-10-25 10:21:33 +00:00
|
|
|
.IP *
|
2015-02-07 06:39:47 +00:00
|
|
|
O(1) removal of any entry in the list.
|
2020-10-25 10:21:33 +00:00
|
|
|
.PP
|
2015-02-07 06:39:47 +00:00
|
|
|
However:
|
2020-10-25 10:21:33 +00:00
|
|
|
.IP * 3
|
2015-02-07 06:39:47 +00:00
|
|
|
Each element requires two pointers rather than one.
|
2020-10-25 11:23:43 +00:00
|
|
|
.SS Doubly linked lists (LIST)
|
2015-02-07 06:39:47 +00:00
|
|
|
Linked lists are the simplest of the doubly linked data structures.
|
|
|
|
They add the following functionality over the above:
|
2020-10-25 10:21:33 +00:00
|
|
|
.IP * 3
|
2015-02-07 06:39:47 +00:00
|
|
|
They may be traversed backwards.
|
2020-10-25 10:21:33 +00:00
|
|
|
.PP
|
2015-02-07 06:39:47 +00:00
|
|
|
However:
|
2020-10-25 10:21:33 +00:00
|
|
|
.IP * 3
|
2015-02-07 06:39:47 +00:00
|
|
|
To traverse backwards, an entry to begin the traversal and the list in
|
|
|
|
which it is contained must be specified.
|
2020-10-25 11:23:43 +00:00
|
|
|
.SS Doubly linked tail queues (TAILQ)
|
2015-02-07 06:39:47 +00:00
|
|
|
Tail queues add the following functionality:
|
2020-10-25 10:21:33 +00:00
|
|
|
.IP * 3
|
2004-11-03 13:51:07 +00:00
|
|
|
Entries can be added at the end of a list.
|
2020-10-25 10:21:33 +00:00
|
|
|
.IP *
|
2015-02-07 06:39:47 +00:00
|
|
|
They may be traversed backwards, from tail to head.
|
2020-10-25 10:21:33 +00:00
|
|
|
.IP *
|
2015-02-07 06:39:47 +00:00
|
|
|
They may be concatenated.
|
2020-10-25 10:21:33 +00:00
|
|
|
.PP
|
2004-11-03 13:51:07 +00:00
|
|
|
However:
|
2020-10-25 10:21:33 +00:00
|
|
|
.IP * 3
|
2004-11-03 13:51:07 +00:00
|
|
|
All list insertions and removals must specify the head of the list.
|
2020-10-25 10:21:33 +00:00
|
|
|
.IP *
|
2004-11-03 13:51:07 +00:00
|
|
|
Each head entry requires two pointers rather than one.
|
2020-10-25 11:23:43 +00:00
|
|
|
.SS Doubly linked circular queues (CIRCLEQ)
|
2020-08-24 06:50:23 +00:00
|
|
|
Circular queues add the following functionality over the above:
|
2020-10-25 10:21:33 +00:00
|
|
|
.IP * 3
|
2020-08-24 06:50:23 +00:00
|
|
|
The first and last entries are connected.
|
2020-10-25 10:21:33 +00:00
|
|
|
.PP
|
2020-08-24 06:50:23 +00:00
|
|
|
However:
|
2020-10-25 10:21:33 +00:00
|
|
|
.IP * 3
|
2020-08-24 06:50:23 +00:00
|
|
|
The termination condition for traversal is more complex.
|
2020-10-25 10:21:33 +00:00
|
|
|
.SH CONFORMING TO
|
2016-02-15 13:40:13 +00:00
|
|
|
Not in POSIX.1, POSIX.1-2001 or POSIX.1-2008.
|
2015-02-07 07:11:04 +00:00
|
|
|
Present on the BSDs.
|
2020-10-25 10:21:33 +00:00
|
|
|
.I <sys/queue.h>
|
|
|
|
macros first appeared in 4.4BSD.
|
|
|
|
.SH SEE ALSO
|
|
|
|
.BR circleq (3),
|
|
|
|
.BR insque (3),
|
|
|
|
.BR list (3),
|
|
|
|
.BR slist (3),
|
|
|
|
.BR stailq (3),
|
|
|
|
.BR tailq (3)
|
|
|
|
.\" .BR tree (3)
|