2004-11-03 13:51:07 +00:00
|
|
|
.\" Copyright (c) 1993
|
2007-12-03 19:53:53 +00:00
|
|
|
.\" The Regents of the University of California. All rights reserved.
|
2004-11-03 13:51:07 +00:00
|
|
|
.\"
|
accept.2, bind.2, connect.2, getpeername.2, getpriority.2, getsockname.2, getsockopt.2, ioctl.2, killpg.2, listen.2, lseek.2, readlink.2, recv.2, send.2, setpgid.2, setreuid.2, shutdown.2, socket.2, socketpair.2, syscall.2, truncate.2, alloca.3, btree.3, daemon.3, dbopen.3, err.3, exec.3, fclose.3, ferror.3, fflush.3, fopen.3, fread.3, fseek.3, fts.3, hash.3, mpool.3, popen.3, queue.3, rcmd.3, recno.3, rexec.3, scanf.3, setbuf.3, stdarg.3, stdio.3, strtod.3, hostname.7, mdoc.7, mdoc.samples.7: srcfix: LICENSE: s/BSD_4_CLAUSE_FULL/BSD_4_CLAUSE_UCB/
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-03-10 16:41:19 +00:00
|
|
|
.\" %%%LICENSE_START(BSD_4_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.
|
|
|
|
.\" 3. All advertising materials mentioning features or use of this software
|
|
|
|
.\" must display the following acknowledgement:
|
2007-12-03 19:53:53 +00:00
|
|
|
.\" This product includes software developed by the University of
|
|
|
|
.\" California, Berkeley and its contributors.
|
2004-11-03 13:51:07 +00:00
|
|
|
.\" 4. 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.
|
accept.2, bind.2, connect.2, getpeername.2, getpriority.2, getsockname.2, getsockopt.2, ioctl.2, killpg.2, listen.2, lseek.2, readlink.2, recv.2, send.2, setpgid.2, setreuid.2, shutdown.2, socket.2, socketpair.2, syscall.2, truncate.2, alloca.3, btree.3, daemon.3, dbopen.3, err.3, exec.3, fclose.3, ferror.3, fflush.3, fopen.3, fread.3, fseek.3, fts.3, getloadavg.3, hash.3, mpool.3, openpty.3, popen.3, queue.3, rcmd.3, recno.3, rexec.3, scanf.3, setbuf.3, stdarg.3, stdio.3, strtod.3, hostname.7, mdoc.7, mdoc.samples.7, operator.7, symlink.7: Add LICENSE_START(BSD_[34]_CLAUSE_FULL)
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-03-10 09:28:48 +00:00
|
|
|
.\" %%%LICENSE_END
|
2004-11-03 13:51:07 +00:00
|
|
|
.\"
|
2007-12-03 19:53:53 +00:00
|
|
|
.\" @(#)queue.3 8.2 (Berkeley) 1/24/94
|
2004-11-03 13:51:07 +00:00
|
|
|
.\"
|
|
|
|
.\" hch, 2002-03-25
|
2007-12-03 19:59:38 +00:00
|
|
|
.\" 2007-12-08, mtk, Converted from mdoc to man macros
|
2004-11-03 13:51:07 +00:00
|
|
|
.\"
|
2007-12-28 05:38:10 +00:00
|
|
|
.TH QUEUE 3 2007-12-28 "Linux" "Linux Programmer's Manual"
|
2007-12-03 19:53:53 +00:00
|
|
|
.SH NAME
|
2012-05-03 16:32:56 +00:00
|
|
|
LIST_ENTRY, LIST_HEAD, LIST_INIT, LIST_INSERT_AFTER,
|
|
|
|
LIST_INSERT_HEAD, LIST_REMOVE, TAILQ_ENTRY, TAILQ_HEAD,
|
|
|
|
TAILQ_INIT, TAILQ_INSERT_AFTER, TAILQ_INSERT_HEAD, TAILQ_INSERT_TAIL,
|
|
|
|
TAILQ_REMOVE, CIRCLEQ_ENTRY, CIRCLEQ_HEAD, CIRCLEQ_INIT,
|
|
|
|
CIRCLEQ_INSERT_AFTER, CIRCLEQ_INSERT_BEFORE,
|
|
|
|
CIRCLEQ_INSERT_HEAD, CIRCLEQ_INSERT_TAIL,
|
2007-12-03 19:53:53 +00:00
|
|
|
CIRCLEQ_REMOVE \- implementations of lists, tail queues, and circular queues
|
|
|
|
.SH SYNOPSIS
|
|
|
|
.nf
|
|
|
|
.B #include <sys/queue.h>
|
|
|
|
|
|
|
|
.BI "LIST_ENTRY(" TYPE );
|
|
|
|
.BI "LIST_HEAD(" HEADNAME ", " TYPE );
|
|
|
|
.BI "LIST_INIT(LIST_HEAD *" head );
|
|
|
|
.BI "LIST_INSERT_AFTER(LIST_ENTRY *" listelm ", "
|
|
|
|
.BI " TYPE *" elm ", LIST_ENTRY " NAME );
|
|
|
|
.BI "LIST_INSERT_HEAD(LIST_HEAD *" head ", "
|
|
|
|
.BI " TYPE *" elm ", LIST_ENTRY " NAME );
|
|
|
|
.BI "LIST_REMOVE(TYPE *" elm ", LIST_ENTRY " NAME );
|
|
|
|
|
|
|
|
.BI "TAILQ_ENTRY(" TYPE );
|
|
|
|
.BI "TAILQ_HEAD("HEADNAME ", " TYPE );
|
|
|
|
.BI "TAILQ_INIT(TAILQ_HEAD *" head );
|
|
|
|
.BI "TAILQ_INSERT_AFTER(TAILQ_HEAD *" head ", TYPE *" listelm ", "
|
|
|
|
.BI " TYPE *" elm ", TAILQ_ENTRY " NAME );
|
|
|
|
.BI "TAILQ_INSERT_HEAD(TAILQ_HEAD *" head ", "
|
|
|
|
.BI " TYPE *" elm ", TAILQ_ENTRY " NAME );
|
|
|
|
.BI "TAILQ_INSERT_TAIL(TAILQ_HEAD *" head ", "
|
|
|
|
.BI " TYPE *" elm ", TAILQ_ENTRY " NAME );
|
|
|
|
.BI "TAILQ_REMOVE(TAILQ_HEAD *" head ", TYPE *" elm ", TAILQ_ENTRY " NAME );
|
|
|
|
|
|
|
|
.BI CIRCLEQ_ENTRY( TYPE );
|
|
|
|
.BI "CIRCLEQ_HEAD(" HEADNAME ", " TYPE );
|
|
|
|
.BI "CIRCLEQ_INIT(CIRCLEQ_HEAD *" head );
|
|
|
|
.BI "CIRCLEQ_INSERT_AFTER(CIRCLEQ_HEAD *" head ", TYPE *" listelm ", "
|
|
|
|
.BI " TYPE *" elm ", CIRCLEQ_ENTRY " NAME );
|
|
|
|
.BI "CIRCLEQ_INSERT_BEFORE(CIRCLEQ_HEAD *" head ", TYPE *" listelm ", "
|
|
|
|
.BI " TYPE *" elm ", CIRCLEQ_ENTRY " NAME );
|
|
|
|
.BI "CIRCLEQ_INSERT_HEAD(CIRCLEQ_HEAD *" head ", "
|
|
|
|
.BI " TYPE *" elm ", CIRCLEQ_ENTRY " NAME );
|
|
|
|
.BI "CIRCLEQ_INSERT_TAIL(CIRCLEQ_HEAD *" head ", "
|
|
|
|
.BI " TYPE *" elm ", CIRCLEQ_ENTRY " NAME );
|
|
|
|
.BI "CIRCLEQ_REMOVE(CIRCLEQ_HEAD *" head ", "
|
|
|
|
.BI " TYPE *" elm ", CIRCLEQ_ENTRY " NAME );
|
|
|
|
.fi
|
|
|
|
.SH DESCRIPTION
|
2004-11-03 13:51:07 +00:00
|
|
|
These macros define and operate on three types of data structures:
|
|
|
|
lists, tail queues, and circular queues.
|
|
|
|
All three structures support the following functionality:
|
2007-12-28 05:38:10 +00:00
|
|
|
.sp
|
|
|
|
.RS 4
|
|
|
|
.PD 0
|
|
|
|
.IP * 4
|
2004-11-03 13:51:07 +00:00
|
|
|
Insertion of a new entry at the head of the list.
|
2007-12-28 05:38:10 +00:00
|
|
|
.IP *
|
2004-11-03 13:51:07 +00:00
|
|
|
Insertion of a new entry after any element in the list.
|
2007-12-28 05:38:10 +00:00
|
|
|
.IP *
|
2004-11-03 13:51:07 +00:00
|
|
|
Removal of any entry in the list.
|
2007-12-28 05:38:10 +00:00
|
|
|
.IP *
|
2004-11-03 13:51:07 +00:00
|
|
|
Forward traversal through the list.
|
2007-12-28 05:38:10 +00:00
|
|
|
.PD
|
2007-12-03 19:53:53 +00:00
|
|
|
.RE
|
|
|
|
.PP
|
2004-11-03 13:51:07 +00:00
|
|
|
Lists are the simplest of the three data structures and support
|
|
|
|
only the above functionality.
|
2007-12-03 19:53:53 +00:00
|
|
|
|
2004-11-03 13:51:07 +00:00
|
|
|
Tail queues add the following functionality:
|
2007-12-28 05:38:10 +00:00
|
|
|
.RS 4
|
|
|
|
.IP * 4
|
2004-11-03 13:51:07 +00:00
|
|
|
Entries can be added at the end of a list.
|
2007-12-03 19:53:53 +00:00
|
|
|
.RE
|
|
|
|
.PP
|
2004-11-03 13:51:07 +00:00
|
|
|
However:
|
2007-12-28 05:38:10 +00:00
|
|
|
.sp
|
|
|
|
.RS 4
|
|
|
|
.PD 0
|
2007-12-03 19:53:53 +00:00
|
|
|
.IP 1. 4
|
2004-11-03 13:51:07 +00:00
|
|
|
All list insertions and removals must specify the head of the list.
|
2007-12-03 19:53:53 +00:00
|
|
|
.IP 2.
|
2004-11-03 13:51:07 +00:00
|
|
|
Each head entry requires two pointers rather than one.
|
2007-12-03 19:53:53 +00:00
|
|
|
.IP 3.
|
2004-11-03 13:51:07 +00:00
|
|
|
Code size is about 15% greater and operations run about 20% slower
|
|
|
|
than lists.
|
2007-12-28 05:38:10 +00:00
|
|
|
.PD
|
2007-12-03 19:53:53 +00:00
|
|
|
.RE
|
|
|
|
.PP
|
2004-11-03 13:51:07 +00:00
|
|
|
Circular queues add the following functionality:
|
2007-12-28 05:38:10 +00:00
|
|
|
.sp
|
|
|
|
.RS 4
|
|
|
|
.PD 0
|
|
|
|
.IP * 4
|
2004-11-03 13:51:07 +00:00
|
|
|
Entries can be added at the end of a list.
|
2007-12-28 05:38:10 +00:00
|
|
|
.IP *
|
2004-11-03 13:51:07 +00:00
|
|
|
Entries can be added before another entry.
|
2007-12-28 05:38:10 +00:00
|
|
|
.IP *
|
Changes.old, clone.2, execve.2, fcntl.2, futex.2, getitimer.2, getpriority.2, mmap.2, mount.2, mprotect.2, sched_setscheduler.2, select_tut.2, setuid.2, sigaltstack.2, vfork.2, div.3, fenv.3, fmod.3, memchr.3, pthread_attr_setstackaddr.3, pthread_attr_setstacksize.3, pthread_getattr_np.3, queue.3, scanf.3, trunc.3, st.4, proc.5, services.5, utmp.5, bootparam.7, capabilities.7, feature_test_macros.7, futex.7, glob.7, man.7, netlink.7, unicode.7: Switch to American usage: "-wards" ==> "-ward"
American English uses "afterward" in preference to "afterwards",
and so on
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2010-09-26 05:34:47 +00:00
|
|
|
They may be traversed backward, from tail to head.
|
2007-12-28 05:38:10 +00:00
|
|
|
.PD
|
2007-12-03 19:53:53 +00:00
|
|
|
.RE
|
|
|
|
.PP
|
2004-11-03 13:51:07 +00:00
|
|
|
However:
|
2007-12-28 05:38:10 +00:00
|
|
|
.sp
|
|
|
|
.RS 4
|
|
|
|
.PD 0
|
2007-12-03 19:53:53 +00:00
|
|
|
.IP 1. 4
|
2004-11-03 13:51:07 +00:00
|
|
|
All list insertions and removals must specify the head of the list.
|
2007-12-03 19:53:53 +00:00
|
|
|
.IP 2.
|
2004-11-03 13:51:07 +00:00
|
|
|
Each head entry requires two pointers rather than one.
|
2007-12-03 19:53:53 +00:00
|
|
|
.IP 3.
|
2004-11-03 13:51:07 +00:00
|
|
|
The termination condition for traversal is more complex.
|
2007-12-03 19:53:53 +00:00
|
|
|
.IP 4.
|
2004-11-03 13:51:07 +00:00
|
|
|
Code size is about 40% greater and operations run about 45% slower
|
|
|
|
than lists.
|
2007-12-28 05:38:10 +00:00
|
|
|
.PD
|
2007-12-03 19:53:53 +00:00
|
|
|
.RE
|
|
|
|
.PP
|
2004-11-03 13:51:07 +00:00
|
|
|
In the macro definitions,
|
2007-12-03 19:53:53 +00:00
|
|
|
.I TYPE
|
2007-12-28 05:45:42 +00:00
|
|
|
is the name of a user-defined structure,
|
2004-11-03 13:51:07 +00:00
|
|
|
that must contain a field of type
|
2007-12-28 05:59:35 +00:00
|
|
|
.BR "LIST_ENTRY" ,
|
|
|
|
.BR "TAILQ_ENTRY" ,
|
2004-11-03 13:51:07 +00:00
|
|
|
or
|
2007-12-28 05:59:35 +00:00
|
|
|
.BR "CIRCLEQ_ENTRY" ,
|
2004-11-03 13:51:07 +00:00
|
|
|
named
|
2007-12-03 19:53:53 +00:00
|
|
|
.IR NAME .
|
2004-11-03 13:51:07 +00:00
|
|
|
The argument
|
2007-12-03 19:53:53 +00:00
|
|
|
.I HEADNAME
|
2007-12-28 05:45:42 +00:00
|
|
|
is the name of a user-defined structure that must be declared
|
2004-11-03 13:51:07 +00:00
|
|
|
using the macros
|
2007-12-28 05:59:35 +00:00
|
|
|
.BR "LIST_HEAD" ,
|
|
|
|
.BR "TAILQ_HEAD" ,
|
2004-11-03 13:51:07 +00:00
|
|
|
or
|
2007-12-28 05:59:35 +00:00
|
|
|
.BR "CIRCLEQ_HEAD" .
|
2004-11-03 13:51:07 +00:00
|
|
|
See the examples below for further explanation of how these
|
|
|
|
macros are used.
|
2007-12-03 19:53:53 +00:00
|
|
|
.SS Lists
|
2004-11-03 13:51:07 +00:00
|
|
|
A list is headed by a structure defined by the
|
2008-09-18 12:30:38 +00:00
|
|
|
.B LIST_HEAD
|
|
|
|
macro.
|
2004-11-03 13:51:07 +00:00
|
|
|
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 or
|
|
|
|
at the head of the list.
|
|
|
|
A
|
2007-12-28 05:59:35 +00:00
|
|
|
.B LIST_HEAD
|
2004-11-03 13:51:07 +00:00
|
|
|
structure is declared as follows:
|
2007-12-19 06:57:44 +00:00
|
|
|
.in +4n
|
2007-12-03 19:53:53 +00:00
|
|
|
.nf
|
|
|
|
|
2004-11-03 13:51:07 +00:00
|
|
|
LIST_HEAD(HEADNAME, TYPE) head;
|
2007-12-03 19:53:53 +00:00
|
|
|
.fi
|
|
|
|
.in
|
2007-12-28 05:38:10 +00:00
|
|
|
.PP
|
2004-11-03 13:51:07 +00:00
|
|
|
where
|
2007-12-03 19:53:53 +00:00
|
|
|
.I HEADNAME
|
2004-11-03 13:51:07 +00:00
|
|
|
is the name of the structure to be defined, and
|
2007-12-03 19:53:53 +00:00
|
|
|
.I TYPE
|
2004-11-03 13:51:07 +00:00
|
|
|
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:
|
2007-12-19 06:57:44 +00:00
|
|
|
.in +4n
|
2007-12-03 19:53:53 +00:00
|
|
|
.nf
|
|
|
|
|
2004-11-03 13:51:07 +00:00
|
|
|
struct HEADNAME *headp;
|
2007-12-03 19:53:53 +00:00
|
|
|
.fi
|
|
|
|
.in
|
2007-12-28 05:38:10 +00:00
|
|
|
.PP
|
2004-11-03 13:51:07 +00:00
|
|
|
(The names
|
2007-12-03 19:53:53 +00:00
|
|
|
.IR "head"
|
2004-11-03 13:51:07 +00:00
|
|
|
and
|
2007-12-03 19:53:53 +00:00
|
|
|
.IR "headp"
|
2004-11-03 13:51:07 +00:00
|
|
|
are user selectable.)
|
2007-12-28 05:38:10 +00:00
|
|
|
.PP
|
2004-11-03 13:51:07 +00:00
|
|
|
The macro
|
2007-12-03 19:53:53 +00:00
|
|
|
.B LIST_ENTRY
|
2004-11-03 13:51:07 +00:00
|
|
|
declares a structure that connects the elements in
|
|
|
|
the list.
|
2007-12-28 05:38:10 +00:00
|
|
|
.PP
|
2004-11-03 13:51:07 +00:00
|
|
|
The macro
|
2007-12-03 19:53:53 +00:00
|
|
|
.B LIST_INIT
|
2004-11-03 13:51:07 +00:00
|
|
|
initializes the list referenced by
|
2007-12-03 19:53:53 +00:00
|
|
|
.IR head .
|
2007-12-28 05:38:10 +00:00
|
|
|
.PP
|
2004-11-03 13:51:07 +00:00
|
|
|
The macro
|
2007-12-03 19:53:53 +00:00
|
|
|
.B LIST_INSERT_HEAD
|
2004-11-03 13:51:07 +00:00
|
|
|
inserts the new element
|
2007-12-03 19:53:53 +00:00
|
|
|
.I elm
|
2004-11-03 13:51:07 +00:00
|
|
|
at the head of the list.
|
2007-12-28 05:38:10 +00:00
|
|
|
.PP
|
2004-11-03 13:51:07 +00:00
|
|
|
The macro
|
2007-12-03 19:53:53 +00:00
|
|
|
.B LIST_INSERT_AFTER
|
2004-11-03 13:51:07 +00:00
|
|
|
inserts the new element
|
2007-12-03 19:53:53 +00:00
|
|
|
.I elm
|
2004-11-03 13:51:07 +00:00
|
|
|
after the element
|
2007-12-03 19:53:53 +00:00
|
|
|
.IR listelm .
|
2007-12-28 05:38:10 +00:00
|
|
|
.PP
|
2004-11-03 13:51:07 +00:00
|
|
|
The macro
|
2007-12-03 19:53:53 +00:00
|
|
|
.B LIST_REMOVE
|
2004-11-03 13:51:07 +00:00
|
|
|
removes the element
|
2007-12-03 19:53:53 +00:00
|
|
|
.I elm
|
2004-11-03 13:51:07 +00:00
|
|
|
from the list.
|
intro.1, time.1, _syscall.2, accept.2, brk.2, capget.2, faccessat.2, futimesat.2, gethostname.2, intro.2, ioprio_set.2, kill.2, madvise.2, mlock.2, mount.2, msgget.2, perf_event_open.2, poll.2, readv.2, sched_rr_get_interval.2, sched_setscheduler.2, select.2, select_tut.2, shmget.2, stat.2, timer_create.2, ustat.2, vfork.2, wait.2, alloca.3, atexit.3, catopen.3, crypt.3, dbopen.3, fenv.3, fopen.3, getaddrinfo_a.3, gethostbyname.3, getutent.3, intro.3, login.3, mallopt.3, queue.3, regex.3, sigpause.3, sigsetops.3, stdio.3, strftime.3, strptime.3, sysconf.3, ttyslot.3, undocumented.3, cciss.4, console_codes.4, hpsa.4, initrd.4, intro.4, rtc.4, st.4, tty_ioctl.4, wavelan.4, acct.5, charmap.5, dir_colors.5, hosts.5, intro.5, termcap.5, utmp.5, intro.6, armscii-8.7, boot.7, bootparam.7, capabilities.7, cpuset.7, credentials.7, ddp.7, epoll.7, glob.7, intro.7, ip.7, ipv6.7, iso_8859-1.7, iso_8859-10.7, iso_8859-11.7, iso_8859-13.7, iso_8859-14.7, iso_8859-15.7, iso_8859-16.7, iso_8859-2.7, iso_8859-3.7, iso_8859-4.7, iso_8859-5.7, iso_8859-6.7, iso_8859-7.7, iso_8859-8.7, iso_8859-9.7, koi8-r.7, koi8-u.7, man-pages.7, man.7, math_error.7, netlink.7, numa.7, packet.7, path_resolution.7, pipe.7, pthreads.7, raw.7, rtnetlink.7, signal.7, socket.7, spufs.7, svipc.7, tcp.7, time.7, udp.7, udplite.7, unicode.7, unix.7, uri.7, utf-8.7, x25.7, intro.8: Global fix: use consistent capitalization in .SS headings
Capitalization in .SS sections across pages (and sometimes even
within a single page) is wildly inconsistent. Make it consistent.
Capitalize first word in heading, but otherwise use lower case,
except where English usage (e.g., proper nouns) or programming
language requirements (e.g., identifier names) dictate otherwise.
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-02-24 14:08:38 +00:00
|
|
|
.SS List example
|
2007-12-03 19:53:53 +00:00
|
|
|
.nf
|
2004-11-03 13:51:07 +00:00
|
|
|
LIST_HEAD(listhead, entry) head;
|
2007-12-03 19:53:53 +00:00
|
|
|
struct listhead *headp; /* List head. */
|
2004-11-03 13:51:07 +00:00
|
|
|
struct entry {
|
2007-12-03 19:53:53 +00:00
|
|
|
...
|
|
|
|
LIST_ENTRY(entry) entries; /* List. */
|
|
|
|
...
|
2004-11-03 13:51:07 +00:00
|
|
|
} *n1, *n2, *np;
|
|
|
|
|
2007-12-03 19:53:53 +00:00
|
|
|
LIST_INIT(&head); /* Initialize the list. */
|
2004-11-03 13:51:07 +00:00
|
|
|
|
2007-12-03 19:53:53 +00:00
|
|
|
n1 = malloc(sizeof(struct entry)); /* Insert at the head. */
|
2004-11-03 13:51:07 +00:00
|
|
|
LIST_INSERT_HEAD(&head, n1, entries);
|
|
|
|
|
2007-12-03 19:53:53 +00:00
|
|
|
n2 = malloc(sizeof(struct entry)); /* Insert after. */
|
2004-11-03 13:51:07 +00:00
|
|
|
LIST_INSERT_AFTER(n1, n2, entries);
|
2007-12-03 19:53:53 +00:00
|
|
|
/* Forward traversal. */
|
2007-06-20 21:39:45 +00:00
|
|
|
for (np = head.lh_first; np != NULL; np = np\->entries.le_next)
|
2007-12-03 19:53:53 +00:00
|
|
|
np\-> ...
|
2004-11-03 13:51:07 +00:00
|
|
|
|
2012-04-12 01:21:07 +00:00
|
|
|
.\" FIXME http://sourceware.org/bugzilla/show_bug.cgi?id=1506
|
2007-12-03 19:53:53 +00:00
|
|
|
while (head.lh_first != NULL) /* Delete. */
|
|
|
|
LIST_REMOVE(head.lh_first, entries);
|
|
|
|
.fi
|
intro.1, time.1, _syscall.2, accept.2, brk.2, capget.2, faccessat.2, futimesat.2, gethostname.2, intro.2, ioprio_set.2, kill.2, madvise.2, mlock.2, mount.2, msgget.2, perf_event_open.2, poll.2, readv.2, sched_rr_get_interval.2, sched_setscheduler.2, select.2, select_tut.2, shmget.2, stat.2, timer_create.2, ustat.2, vfork.2, wait.2, alloca.3, atexit.3, catopen.3, crypt.3, dbopen.3, fenv.3, fopen.3, getaddrinfo_a.3, gethostbyname.3, getutent.3, intro.3, login.3, mallopt.3, queue.3, regex.3, sigpause.3, sigsetops.3, stdio.3, strftime.3, strptime.3, sysconf.3, ttyslot.3, undocumented.3, cciss.4, console_codes.4, hpsa.4, initrd.4, intro.4, rtc.4, st.4, tty_ioctl.4, wavelan.4, acct.5, charmap.5, dir_colors.5, hosts.5, intro.5, termcap.5, utmp.5, intro.6, armscii-8.7, boot.7, bootparam.7, capabilities.7, cpuset.7, credentials.7, ddp.7, epoll.7, glob.7, intro.7, ip.7, ipv6.7, iso_8859-1.7, iso_8859-10.7, iso_8859-11.7, iso_8859-13.7, iso_8859-14.7, iso_8859-15.7, iso_8859-16.7, iso_8859-2.7, iso_8859-3.7, iso_8859-4.7, iso_8859-5.7, iso_8859-6.7, iso_8859-7.7, iso_8859-8.7, iso_8859-9.7, koi8-r.7, koi8-u.7, man-pages.7, man.7, math_error.7, netlink.7, numa.7, packet.7, path_resolution.7, pipe.7, pthreads.7, raw.7, rtnetlink.7, signal.7, socket.7, spufs.7, svipc.7, tcp.7, time.7, udp.7, udplite.7, unicode.7, unix.7, uri.7, utf-8.7, x25.7, intro.8: Global fix: use consistent capitalization in .SS headings
Capitalization in .SS sections across pages (and sometimes even
within a single page) is wildly inconsistent. Make it consistent.
Capitalize first word in heading, but otherwise use lower case,
except where English usage (e.g., proper nouns) or programming
language requirements (e.g., identifier names) dictate otherwise.
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-02-24 14:08:38 +00:00
|
|
|
.SS Tail queues
|
2004-11-03 13:51:07 +00:00
|
|
|
A tail queue is headed by a structure defined by the
|
2007-12-28 05:59:35 +00:00
|
|
|
.B TAILQ_HEAD
|
|
|
|
macro.
|
2004-11-03 13:51:07 +00:00
|
|
|
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,
|
|
|
|
at the head of the tail queue, or at the end of the tail queue.
|
|
|
|
A
|
2007-12-28 05:59:35 +00:00
|
|
|
.B TAILQ_HEAD
|
2004-11-03 13:51:07 +00:00
|
|
|
structure is declared as follows:
|
2007-12-19 06:57:44 +00:00
|
|
|
.in +4n
|
2007-12-03 19:53:53 +00:00
|
|
|
.nf
|
|
|
|
|
2004-11-03 13:51:07 +00:00
|
|
|
TAILQ_HEAD(HEADNAME, TYPE) head;
|
2007-12-03 19:53:53 +00:00
|
|
|
.fi
|
2007-12-19 06:57:44 +00:00
|
|
|
.in
|
2007-12-03 19:53:53 +00:00
|
|
|
.PP
|
2004-11-03 13:51:07 +00:00
|
|
|
where
|
2007-12-03 19:53:53 +00:00
|
|
|
.IR "HEADNAME"
|
2004-11-03 13:51:07 +00:00
|
|
|
is the name of the structure to be defined, and
|
2007-12-03 19:53:53 +00:00
|
|
|
.IR "TYPE"
|
2004-11-03 13:51:07 +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:
|
2007-12-19 06:57:44 +00:00
|
|
|
.in +4n
|
2007-12-03 19:53:53 +00:00
|
|
|
.nf
|
|
|
|
|
2004-11-03 13:51:07 +00:00
|
|
|
struct HEADNAME *headp;
|
2007-12-03 19:53:53 +00:00
|
|
|
.fi
|
|
|
|
.in
|
2007-12-28 05:38:10 +00:00
|
|
|
.PP
|
2004-11-03 13:51:07 +00:00
|
|
|
(The names
|
2007-12-03 19:53:53 +00:00
|
|
|
.IR "head"
|
2004-11-03 13:51:07 +00:00
|
|
|
and
|
2007-12-03 19:53:53 +00:00
|
|
|
.IR "headp"
|
2004-11-03 13:51:07 +00:00
|
|
|
are user selectable.)
|
2007-12-28 05:38:10 +00:00
|
|
|
.PP
|
2004-11-03 13:51:07 +00:00
|
|
|
The macro
|
2007-12-03 19:53:53 +00:00
|
|
|
.B TAILQ_ENTRY
|
2004-11-03 13:51:07 +00:00
|
|
|
declares a structure that connects the elements in
|
|
|
|
the tail queue.
|
2007-12-28 05:38:10 +00:00
|
|
|
.PP
|
2004-11-03 13:51:07 +00:00
|
|
|
The macro
|
2007-12-03 19:53:53 +00:00
|
|
|
.B TAILQ_INIT
|
2004-11-03 13:51:07 +00:00
|
|
|
initializes the tail queue referenced by
|
2007-12-03 19:53:53 +00:00
|
|
|
.IR head .
|
2007-12-28 05:38:10 +00:00
|
|
|
.PP
|
2004-11-03 13:51:07 +00:00
|
|
|
The macro
|
2007-12-03 19:53:53 +00:00
|
|
|
.B TAILQ_INSERT_HEAD
|
2004-11-03 13:51:07 +00:00
|
|
|
inserts the new element
|
2007-12-03 19:53:53 +00:00
|
|
|
.I elm
|
2004-11-03 13:51:07 +00:00
|
|
|
at the head of the tail queue.
|
2007-12-28 05:38:10 +00:00
|
|
|
.PP
|
2004-11-03 13:51:07 +00:00
|
|
|
The macro
|
2007-12-03 19:53:53 +00:00
|
|
|
.B TAILQ_INSERT_TAIL
|
2004-11-03 13:51:07 +00:00
|
|
|
inserts the new element
|
2007-12-03 19:53:53 +00:00
|
|
|
.I elm
|
2004-11-03 13:51:07 +00:00
|
|
|
at the end of the tail queue.
|
2007-12-28 05:38:10 +00:00
|
|
|
.PP
|
2004-11-03 13:51:07 +00:00
|
|
|
The macro
|
2007-12-03 19:53:53 +00:00
|
|
|
.B TAILQ_INSERT_AFTER
|
2004-11-03 13:51:07 +00:00
|
|
|
inserts the new element
|
2007-12-03 19:53:53 +00:00
|
|
|
.I elm
|
2004-11-03 13:51:07 +00:00
|
|
|
after the element
|
2007-12-03 19:53:53 +00:00
|
|
|
.IR listelm .
|
2007-12-28 05:38:10 +00:00
|
|
|
.PP
|
2004-11-03 13:51:07 +00:00
|
|
|
The macro
|
2007-12-03 19:53:53 +00:00
|
|
|
.B TAILQ_REMOVE
|
2004-11-03 13:51:07 +00:00
|
|
|
removes the element
|
2007-12-03 19:53:53 +00:00
|
|
|
.I elm
|
2004-11-03 13:51:07 +00:00
|
|
|
from the tail queue.
|
intro.1, time.1, _syscall.2, accept.2, brk.2, capget.2, faccessat.2, futimesat.2, gethostname.2, intro.2, ioprio_set.2, kill.2, madvise.2, mlock.2, mount.2, msgget.2, perf_event_open.2, poll.2, readv.2, sched_rr_get_interval.2, sched_setscheduler.2, select.2, select_tut.2, shmget.2, stat.2, timer_create.2, ustat.2, vfork.2, wait.2, alloca.3, atexit.3, catopen.3, crypt.3, dbopen.3, fenv.3, fopen.3, getaddrinfo_a.3, gethostbyname.3, getutent.3, intro.3, login.3, mallopt.3, queue.3, regex.3, sigpause.3, sigsetops.3, stdio.3, strftime.3, strptime.3, sysconf.3, ttyslot.3, undocumented.3, cciss.4, console_codes.4, hpsa.4, initrd.4, intro.4, rtc.4, st.4, tty_ioctl.4, wavelan.4, acct.5, charmap.5, dir_colors.5, hosts.5, intro.5, termcap.5, utmp.5, intro.6, armscii-8.7, boot.7, bootparam.7, capabilities.7, cpuset.7, credentials.7, ddp.7, epoll.7, glob.7, intro.7, ip.7, ipv6.7, iso_8859-1.7, iso_8859-10.7, iso_8859-11.7, iso_8859-13.7, iso_8859-14.7, iso_8859-15.7, iso_8859-16.7, iso_8859-2.7, iso_8859-3.7, iso_8859-4.7, iso_8859-5.7, iso_8859-6.7, iso_8859-7.7, iso_8859-8.7, iso_8859-9.7, koi8-r.7, koi8-u.7, man-pages.7, man.7, math_error.7, netlink.7, numa.7, packet.7, path_resolution.7, pipe.7, pthreads.7, raw.7, rtnetlink.7, signal.7, socket.7, spufs.7, svipc.7, tcp.7, time.7, udp.7, udplite.7, unicode.7, unix.7, uri.7, utf-8.7, x25.7, intro.8: Global fix: use consistent capitalization in .SS headings
Capitalization in .SS sections across pages (and sometimes even
within a single page) is wildly inconsistent. Make it consistent.
Capitalize first word in heading, but otherwise use lower case,
except where English usage (e.g., proper nouns) or programming
language requirements (e.g., identifier names) dictate otherwise.
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-02-24 14:08:38 +00:00
|
|
|
.SS Tail queue example
|
2007-12-03 19:53:53 +00:00
|
|
|
.nf
|
2004-11-03 13:51:07 +00:00
|
|
|
TAILQ_HEAD(tailhead, entry) head;
|
2007-12-03 19:53:53 +00:00
|
|
|
struct tailhead *headp; /* Tail queue head. */
|
2004-11-03 13:51:07 +00:00
|
|
|
struct entry {
|
2007-12-03 19:53:53 +00:00
|
|
|
...
|
|
|
|
TAILQ_ENTRY(entry) entries; /* Tail queue. */
|
|
|
|
...
|
2004-11-03 13:51:07 +00:00
|
|
|
} *n1, *n2, *np;
|
|
|
|
|
2007-12-03 19:53:53 +00:00
|
|
|
TAILQ_INIT(&head); /* Initialize the queue. */
|
2004-11-03 13:51:07 +00:00
|
|
|
|
2007-12-03 19:53:53 +00:00
|
|
|
n1 = malloc(sizeof(struct entry)); /* Insert at the head. */
|
2004-11-03 13:51:07 +00:00
|
|
|
TAILQ_INSERT_HEAD(&head, n1, entries);
|
|
|
|
|
2007-12-03 19:53:53 +00:00
|
|
|
n1 = malloc(sizeof(struct entry)); /* Insert at the tail. */
|
2004-11-03 13:51:07 +00:00
|
|
|
TAILQ_INSERT_TAIL(&head, n1, entries);
|
|
|
|
|
2007-12-03 19:53:53 +00:00
|
|
|
n2 = malloc(sizeof(struct entry)); /* Insert after. */
|
2004-11-03 13:51:07 +00:00
|
|
|
TAILQ_INSERT_AFTER(&head, n1, n2, entries);
|
2007-12-03 19:53:53 +00:00
|
|
|
/* Forward traversal. */
|
2007-12-22 16:40:46 +00:00
|
|
|
for (np = head.tqh_first; np != NULL; np = np\->entries.tqe_next)
|
|
|
|
np\-> ...
|
2007-12-03 19:53:53 +00:00
|
|
|
/* Delete. */
|
2004-11-03 13:51:07 +00:00
|
|
|
while (head.tqh_first != NULL)
|
2007-12-03 19:53:53 +00:00
|
|
|
TAILQ_REMOVE(&head, head.tqh_first, entries);
|
|
|
|
.fi
|
intro.1, time.1, _syscall.2, accept.2, brk.2, capget.2, faccessat.2, futimesat.2, gethostname.2, intro.2, ioprio_set.2, kill.2, madvise.2, mlock.2, mount.2, msgget.2, perf_event_open.2, poll.2, readv.2, sched_rr_get_interval.2, sched_setscheduler.2, select.2, select_tut.2, shmget.2, stat.2, timer_create.2, ustat.2, vfork.2, wait.2, alloca.3, atexit.3, catopen.3, crypt.3, dbopen.3, fenv.3, fopen.3, getaddrinfo_a.3, gethostbyname.3, getutent.3, intro.3, login.3, mallopt.3, queue.3, regex.3, sigpause.3, sigsetops.3, stdio.3, strftime.3, strptime.3, sysconf.3, ttyslot.3, undocumented.3, cciss.4, console_codes.4, hpsa.4, initrd.4, intro.4, rtc.4, st.4, tty_ioctl.4, wavelan.4, acct.5, charmap.5, dir_colors.5, hosts.5, intro.5, termcap.5, utmp.5, intro.6, armscii-8.7, boot.7, bootparam.7, capabilities.7, cpuset.7, credentials.7, ddp.7, epoll.7, glob.7, intro.7, ip.7, ipv6.7, iso_8859-1.7, iso_8859-10.7, iso_8859-11.7, iso_8859-13.7, iso_8859-14.7, iso_8859-15.7, iso_8859-16.7, iso_8859-2.7, iso_8859-3.7, iso_8859-4.7, iso_8859-5.7, iso_8859-6.7, iso_8859-7.7, iso_8859-8.7, iso_8859-9.7, koi8-r.7, koi8-u.7, man-pages.7, man.7, math_error.7, netlink.7, numa.7, packet.7, path_resolution.7, pipe.7, pthreads.7, raw.7, rtnetlink.7, signal.7, socket.7, spufs.7, svipc.7, tcp.7, time.7, udp.7, udplite.7, unicode.7, unix.7, uri.7, utf-8.7, x25.7, intro.8: Global fix: use consistent capitalization in .SS headings
Capitalization in .SS sections across pages (and sometimes even
within a single page) is wildly inconsistent. Make it consistent.
Capitalize first word in heading, but otherwise use lower case,
except where English usage (e.g., proper nouns) or programming
language requirements (e.g., identifier names) dictate otherwise.
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-02-24 14:08:38 +00:00
|
|
|
.SS Circular queues
|
2004-11-03 13:51:07 +00:00
|
|
|
A circular queue is headed by a structure defined by the
|
2007-12-28 05:59:35 +00:00
|
|
|
.B CIRCLEQ_HEAD
|
|
|
|
macro.
|
2004-11-03 13:51:07 +00:00
|
|
|
This structure contains a pair of pointers,
|
|
|
|
one to the first element in the circular queue and the other to the
|
|
|
|
last element in the circular queue.
|
|
|
|
The elements are doubly linked so that an arbitrary element can be
|
|
|
|
removed without traversing the queue.
|
|
|
|
New elements can be added to the queue after an existing element,
|
|
|
|
before an existing element, at the head of the queue, or at the end
|
|
|
|
of the queue.
|
|
|
|
A
|
2007-12-28 05:59:35 +00:00
|
|
|
.B CIRCLEQ_HEAD
|
2004-11-03 13:51:07 +00:00
|
|
|
structure is declared as follows:
|
2007-12-19 06:57:44 +00:00
|
|
|
.in +4n
|
2007-12-03 19:53:53 +00:00
|
|
|
.nf
|
|
|
|
|
2004-11-03 13:51:07 +00:00
|
|
|
CIRCLEQ_HEAD(HEADNAME, TYPE) head;
|
2007-12-03 19:53:53 +00:00
|
|
|
.fi
|
|
|
|
.in
|
2007-12-28 05:38:10 +00:00
|
|
|
.PP
|
2004-11-03 13:51:07 +00:00
|
|
|
where
|
2007-12-03 19:53:53 +00:00
|
|
|
.IR "HEADNAME"
|
2004-11-03 13:51:07 +00:00
|
|
|
is the name of the structure to be defined, and
|
2007-12-03 19:53:53 +00:00
|
|
|
.IR "TYPE"
|
2004-11-03 13:51:07 +00:00
|
|
|
is the type of the elements to be linked into the circular queue.
|
|
|
|
A pointer to the head of the circular queue can later be declared as:
|
2007-12-19 06:57:44 +00:00
|
|
|
.in +4n
|
2007-12-03 19:53:53 +00:00
|
|
|
.nf
|
|
|
|
|
2004-11-03 13:51:07 +00:00
|
|
|
struct HEADNAME *headp;
|
2007-12-03 19:53:53 +00:00
|
|
|
.fi
|
|
|
|
.in
|
2007-12-28 05:38:10 +00:00
|
|
|
.PP
|
2004-11-03 13:51:07 +00:00
|
|
|
(The names
|
2007-12-03 19:53:53 +00:00
|
|
|
.IR "head"
|
2004-11-03 13:51:07 +00:00
|
|
|
and
|
2007-12-03 19:53:53 +00:00
|
|
|
.IR "headp"
|
2004-11-03 13:51:07 +00:00
|
|
|
are user selectable.)
|
2007-12-28 05:38:10 +00:00
|
|
|
.PP
|
2004-11-03 13:51:07 +00:00
|
|
|
The macro
|
2007-12-03 19:53:53 +00:00
|
|
|
.B CIRCLEQ_ENTRY
|
2004-11-03 13:51:07 +00:00
|
|
|
declares a structure that connects the elements in
|
|
|
|
the circular queue.
|
2007-12-28 05:38:10 +00:00
|
|
|
.PP
|
2004-11-03 13:51:07 +00:00
|
|
|
The macro
|
2007-12-03 19:53:53 +00:00
|
|
|
.B CIRCLEQ_INIT
|
2004-11-03 13:51:07 +00:00
|
|
|
initializes the circular queue referenced by
|
2007-12-03 19:53:53 +00:00
|
|
|
.IR head .
|
2007-12-28 05:38:10 +00:00
|
|
|
.PP
|
2004-11-03 13:51:07 +00:00
|
|
|
The macro
|
2007-12-03 19:53:53 +00:00
|
|
|
.B CIRCLEQ_INSERT_HEAD
|
2004-11-03 13:51:07 +00:00
|
|
|
inserts the new element
|
2007-12-03 19:53:53 +00:00
|
|
|
.I elm
|
2004-11-03 13:51:07 +00:00
|
|
|
at the head of the circular queue.
|
2007-12-28 05:38:10 +00:00
|
|
|
.PP
|
2004-11-03 13:51:07 +00:00
|
|
|
The macro
|
2007-12-03 19:53:53 +00:00
|
|
|
.B CIRCLEQ_INSERT_TAIL
|
2004-11-03 13:51:07 +00:00
|
|
|
inserts the new element
|
2007-12-03 19:53:53 +00:00
|
|
|
.I elm
|
2004-11-03 13:51:07 +00:00
|
|
|
at the end of the circular queue.
|
2007-12-28 05:38:10 +00:00
|
|
|
.PP
|
2004-11-03 13:51:07 +00:00
|
|
|
The macro
|
2007-12-03 19:53:53 +00:00
|
|
|
.B CIRCLEQ_INSERT_AFTER
|
2004-11-03 13:51:07 +00:00
|
|
|
inserts the new element
|
2007-12-03 19:53:53 +00:00
|
|
|
.I elm
|
2004-11-03 13:51:07 +00:00
|
|
|
after the element
|
2007-12-03 19:53:53 +00:00
|
|
|
.IR listelm .
|
2007-12-28 05:38:10 +00:00
|
|
|
.PP
|
2004-11-03 13:51:07 +00:00
|
|
|
The macro
|
2007-12-03 19:53:53 +00:00
|
|
|
.B CIRCLEQ_INSERT_BEFORE
|
2004-11-03 13:51:07 +00:00
|
|
|
inserts the new element
|
2007-12-03 19:53:53 +00:00
|
|
|
.I elm
|
2004-11-03 13:51:07 +00:00
|
|
|
before the element
|
2007-12-03 19:53:53 +00:00
|
|
|
.IR listelm .
|
2007-12-28 05:38:10 +00:00
|
|
|
.PP
|
2004-11-03 13:51:07 +00:00
|
|
|
The macro
|
2007-12-03 19:53:53 +00:00
|
|
|
.B CIRCLEQ_REMOVE
|
2004-11-03 13:51:07 +00:00
|
|
|
removes the element
|
2007-12-03 19:53:53 +00:00
|
|
|
.I elm
|
2004-11-03 13:51:07 +00:00
|
|
|
from the circular queue.
|
intro.1, time.1, _syscall.2, accept.2, brk.2, capget.2, faccessat.2, futimesat.2, gethostname.2, intro.2, ioprio_set.2, kill.2, madvise.2, mlock.2, mount.2, msgget.2, perf_event_open.2, poll.2, readv.2, sched_rr_get_interval.2, sched_setscheduler.2, select.2, select_tut.2, shmget.2, stat.2, timer_create.2, ustat.2, vfork.2, wait.2, alloca.3, atexit.3, catopen.3, crypt.3, dbopen.3, fenv.3, fopen.3, getaddrinfo_a.3, gethostbyname.3, getutent.3, intro.3, login.3, mallopt.3, queue.3, regex.3, sigpause.3, sigsetops.3, stdio.3, strftime.3, strptime.3, sysconf.3, ttyslot.3, undocumented.3, cciss.4, console_codes.4, hpsa.4, initrd.4, intro.4, rtc.4, st.4, tty_ioctl.4, wavelan.4, acct.5, charmap.5, dir_colors.5, hosts.5, intro.5, termcap.5, utmp.5, intro.6, armscii-8.7, boot.7, bootparam.7, capabilities.7, cpuset.7, credentials.7, ddp.7, epoll.7, glob.7, intro.7, ip.7, ipv6.7, iso_8859-1.7, iso_8859-10.7, iso_8859-11.7, iso_8859-13.7, iso_8859-14.7, iso_8859-15.7, iso_8859-16.7, iso_8859-2.7, iso_8859-3.7, iso_8859-4.7, iso_8859-5.7, iso_8859-6.7, iso_8859-7.7, iso_8859-8.7, iso_8859-9.7, koi8-r.7, koi8-u.7, man-pages.7, man.7, math_error.7, netlink.7, numa.7, packet.7, path_resolution.7, pipe.7, pthreads.7, raw.7, rtnetlink.7, signal.7, socket.7, spufs.7, svipc.7, tcp.7, time.7, udp.7, udplite.7, unicode.7, unix.7, uri.7, utf-8.7, x25.7, intro.8: Global fix: use consistent capitalization in .SS headings
Capitalization in .SS sections across pages (and sometimes even
within a single page) is wildly inconsistent. Make it consistent.
Capitalize first word in heading, but otherwise use lower case,
except where English usage (e.g., proper nouns) or programming
language requirements (e.g., identifier names) dictate otherwise.
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-02-24 14:08:38 +00:00
|
|
|
.SS Circular queue example
|
2007-12-03 19:53:53 +00:00
|
|
|
.nf
|
2004-11-03 13:51:07 +00:00
|
|
|
CIRCLEQ_HEAD(circleq, entry) head;
|
2007-12-03 19:53:53 +00:00
|
|
|
struct circleq *headp; /* Circular queue head. */
|
2004-11-03 13:51:07 +00:00
|
|
|
struct entry {
|
2007-12-03 19:53:53 +00:00
|
|
|
...
|
|
|
|
CIRCLEQ_ENTRY(entry) entries; /* Circular queue. */
|
|
|
|
...
|
2004-11-03 13:51:07 +00:00
|
|
|
} *n1, *n2, *np;
|
|
|
|
|
2007-12-03 19:53:53 +00:00
|
|
|
CIRCLEQ_INIT(&head); /* Initialize the circular queue. */
|
2004-11-03 13:51:07 +00:00
|
|
|
|
2007-12-03 19:53:53 +00:00
|
|
|
n1 = malloc(sizeof(struct entry)); /* Insert at the head. */
|
2004-11-03 13:51:07 +00:00
|
|
|
CIRCLEQ_INSERT_HEAD(&head, n1, entries);
|
|
|
|
|
2007-12-03 19:53:53 +00:00
|
|
|
n1 = malloc(sizeof(struct entry)); /* Insert at the tail. */
|
2004-11-03 13:51:07 +00:00
|
|
|
CIRCLEQ_INSERT_TAIL(&head, n1, entries);
|
|
|
|
|
2007-12-03 19:53:53 +00:00
|
|
|
n2 = malloc(sizeof(struct entry)); /* Insert after. */
|
2004-11-03 13:51:07 +00:00
|
|
|
CIRCLEQ_INSERT_AFTER(&head, n1, n2, entries);
|
|
|
|
|
2007-12-03 19:53:53 +00:00
|
|
|
n2 = malloc(sizeof(struct entry)); /* Insert before. */
|
2004-11-03 13:51:07 +00:00
|
|
|
CIRCLEQ_INSERT_BEFORE(&head, n1, n2, entries);
|
2007-12-03 19:53:53 +00:00
|
|
|
/* Forward traversal. */
|
2007-12-07 19:56:49 +00:00
|
|
|
for (np = head.cqh_first; np != (void *)&head;
|
2007-12-22 16:40:46 +00:00
|
|
|
np = np\->entries.cqe_next)
|
|
|
|
np\-> ...
|
2007-12-03 19:53:53 +00:00
|
|
|
/* Reverse traversal. */
|
2007-12-22 16:40:46 +00:00
|
|
|
for (np = head.cqh_last; np != (void *)&head; np = np\->entries.cqe_prev)
|
|
|
|
np\-> ...
|
2007-12-03 19:53:53 +00:00
|
|
|
/* Delete. */
|
2004-11-03 13:51:07 +00:00
|
|
|
while (head.cqh_first != (void *)&head)
|
2007-12-03 19:53:53 +00:00
|
|
|
CIRCLEQ_REMOVE(&head, head.cqh_first, entries);
|
|
|
|
.fi
|
getent.1, intro.1, time.1, _exit.2, _syscall.2, accept.2, access.2, acct.2, adjtimex.2, alarm.2, alloc_hugepages.2, arch_prctl.2, bdflush.2, bind.2, brk.2, cacheflush.2, capget.2, chdir.2, chmod.2, chown.2, chroot.2, clock_getres.2, clock_nanosleep.2, clone.2, close.2, connect.2, create_module.2, delete_module.2, dup.2, epoll_create.2, epoll_ctl.2, epoll_wait.2, eventfd.2, execve.2, exit_group.2, faccessat.2, fchmodat.2, fchownat.2, fcntl.2, flock.2, fork.2, fstatat.2, fsync.2, futex.2, futimesat.2, get_kernel_syms.2, get_robust_list.2, get_thread_area.2, getcpu.2, getdents.2, getdomainname.2, getgid.2, getgroups.2, gethostname.2, getitimer.2, getpagesize.2, getpeername.2, getpid.2, getpriority.2, getresuid.2, getrlimit.2, getrusage.2, getsid.2, getsockname.2, getsockopt.2, gettid.2, gettimeofday.2, getuid.2, getunwind.2, getxattr.2, idle.2, init_module.2, inotify_add_watch.2, inotify_init.2, inotify_rm_watch.2, intro.2, io_cancel.2, io_destroy.2, io_getevents.2, io_setup.2, io_submit.2, ioctl.2, ioctl_list.2, ioperm.2, iopl.2, ioprio_set.2, ipc.2, kcmp.2, kill.2, killpg.2, link.2, linkat.2, listen.2, listxattr.2, llseek.2, lookup_dcookie.2, lseek.2, madvise.2, migrate_pages.2, mincore.2, mkdir.2, mkdirat.2, mknod.2, mknodat.2, mlock.2, mmap.2, mmap2.2, modify_ldt.2, mount.2, move_pages.2, mprotect.2, mq_getsetattr.2, mremap.2, msgctl.2, msgget.2, msgop.2, msync.2, nanosleep.2, nfsservctl.2, nice.2, open.2, openat.2, outb.2, pause.2, pciconfig_read.2, perf_event_open.2, perfmonctl.2, personality.2, pipe.2, pivot_root.2, poll.2, posix_fadvise.2, prctl.2, pread.2, process_vm_readv.2, ptrace.2, query_module.2, quotactl.2, read.2, readahead.2, readdir.2, readlink.2, readlinkat.2, readv.2, reboot.2, recv.2, remap_file_pages.2, removexattr.2, rename.2, renameat.2, rmdir.2, rt_sigqueueinfo.2, sched_get_priority_max.2, sched_rr_get_interval.2, sched_setaffinity.2, sched_setparam.2, sched_setscheduler.2, sched_yield.2, select.2, semctl.2, semget.2, semop.2, send.2, sendfile.2, set_thread_area.2, set_tid_address.2, seteuid.2, setfsgid.2, setfsuid.2, setgid.2, setpgid.2, setresuid.2, setreuid.2, setsid.2, setuid.2, setup.2, setxattr.2, shmctl.2, shmget.2, shmop.2, shutdown.2, sigaction.2, sigaltstack.2, signal.2, signalfd.2, sigpending.2, sigprocmask.2, sigreturn.2, sigsuspend.2, sigwaitinfo.2, socket.2, socketcall.2, socketpair.2, splice.2, stat.2, statfs.2, stime.2, swapon.2, symlink.2, symlinkat.2, sync.2, sync_file_range.2, sysctl.2, sysfs.2, sysinfo.2, syslog.2, tee.2, time.2, timerfd_create.2, times.2, tkill.2, truncate.2, umask.2, umount.2, uname.2, unimplemented.2, unlink.2, unlinkat.2, uselib.2, ustat.2, utime.2, utimensat.2, vfork.2, vhangup.2, vm86.2, vmsplice.2, wait.2, wait4.2, write.2, CPU_SET.3, INFINITY.3, MB_CUR_MAX.3, MB_LEN_MAX.3, __setfpucw.3, a64l.3, abort.3, abs.3, acos.3, acosh.3, addseverity.3, adjtime.3, aio_cancel.3, aio_error.3, aio_fsync.3, aio_read.3, aio_return.3, aio_suspend.3, aio_write.3, alloca.3, argz_add.3, asin.3, asinh.3, asprintf.3, assert.3, assert_perror.3, atan.3, atan2.3, atanh.3, atexit.3, atof.3, atoi.3, backtrace.3, basename.3, bcmp.3, bcopy.3, bindresvport.3, bsd_signal.3, bsearch.3, bstring.3, btowc.3, btree.3, byteorder.3, bzero.3, cabs.3, cacos.3, cacosh.3, canonicalize_file_name.3, carg.3, casin.3, casinh.3, catan.3, catanh.3, catgets.3, catopen.3, cbrt.3, ccos.3, ccosh.3, ceil.3, cerf.3, cexp.3, cexp2.3, cfree.3, cimag.3, clearenv.3, clock.3, clock_getcpuclockid.3, clog.3, clog10.3, clog2.3, closedir.3, cmsg.3, confstr.3, conj.3, copysign.3, cos.3, cosh.3, cpow.3, cproj.3, creal.3, crypt.3, csin.3, csinh.3, csqrt.3, ctan.3, ctanh.3, ctermid.3, ctime.3, daemon.3, dbopen.3, des_crypt.3, difftime.3, dirfd.3, div.3, dl_iterate_phdr.3, dlopen.3, dprintf.3, drand48.3, drand48_r.3, dysize.3, ecvt.3, ecvt_r.3, encrypt.3, end.3, endian.3, envz_add.3, erf.3, erfc.3, err.3, errno.3, error.3, ether_aton.3, euidaccess.3, exec.3, exit.3, exp.3, exp10.3, exp2.3, expm1.3, fabs.3, fclose.3, fcloseall.3, fdim.3, fenv.3, ferror.3, fexecve.3, fflush.3, ffs.3, fgetgrent.3, fgetpwent.3, fgetwc.3, fgetws.3, finite.3, flockfile.3, floor.3, fma.3, fmax.3, fmemopen.3, fmin.3, fmod.3, fmtmsg.3, fnmatch.3, fopen.3, fpathconf.3, fpclassify.3, fpurge.3, fputwc.3, fputws.3, fread.3, frexp.3, fseek.3, fseeko.3, ftime.3, ftok.3, fts.3, ftw.3, futimes.3, fwide.3, gamma.3, gcvt.3, getaddrinfo.3, getaddrinfo_a.3, getauxval.3, getcontext.3, getcwd.3, getdate.3, getdirentries.3, getdtablesize.3, getenv.3, getfsent.3, getgrent.3, getgrent_r.3, getgrnam.3, getgrouplist.3, gethostbyname.3, gethostid.3, getipnodebyname.3, getline.3, getloadavg.3, getlogin.3, getmntent.3, getnameinfo.3, getnetent.3, getnetent_r.3, getopt.3, getpass.3, getprotoent.3, getprotoent_r.3, getpt.3, getpw.3, getpwent.3, getpwent_r.3, getpwnam.3, getrpcent.3, getrpcent_r.3, getrpcport.3, gets.3, getservent.3, getservent_r.3, getspnam.3, getttyent.3, getumask.3, getusershell.3, getutent.3, getw.3, getwchar.3, glob.3, grantpt.3, gsignal.3, hash.3, hsearch.3, hypot.3, iconv.3, iconv_close.3, iconv_open.3, ilogb.3, index.3, inet.3, inet_ntop.3, inet_pton.3, infnan.3, initgroups.3, insque.3, intro.3, isalpha.3, isatty.3, isgreater.3, iswalnum.3, iswalpha.3, iswblank.3, iswcntrl.3, iswctype.3, iswdigit.3, iswgraph.3, iswlower.3, iswprint.3, iswpunct.3, iswspace.3, iswupper.3, iswxdigit.3, j0.3, key_setsecret.3, ldexp.3, lgamma.3, lio_listio.3, localeconv.3, lockf.3, log.3, log10.3, log1p.3, log2.3, logb.3, login.3, longjmp.3, lrint.3, lround.3, lsearch.3, lseek64.3, makecontext.3, makedev.3, malloc.3, malloc_hook.3, mblen.3, mbrlen.3, mbrtowc.3, mbsinit.3, mbsnrtowcs.3, mbsrtowcs.3, mbstowcs.3, mbtowc.3, memccpy.3, memchr.3, memcmp.3, memcpy.3, memfrob.3, memmem.3, memmove.3, mempcpy.3, memset.3, mkdtemp.3, mkfifo.3, mkfifoat.3, mkstemp.3, mktemp.3, modf.3, mpool.3, mq_close.3, mq_getattr.3, mq_notify.3, mq_open.3, mq_receive.3, mq_send.3, mq_unlink.3, mtrace.3, nan.3, netlink.3, nextafter.3, nl_langinfo.3, offsetof.3, on_exit.3, opendir.3, openpty.3, perror.3, popen.3, posix_fallocate.3, posix_memalign.3, posix_openpt.3, pow.3, pow10.3, printf.3, profil.3, program_invocation_name.3, psignal.3, pthread_kill_other_threads_np.3, ptsname.3, putenv.3, putgrent.3, putpwent.3, puts.3, putwchar.3, qecvt.3, qsort.3, queue.3, raise.3, rand.3, random.3, random_r.3, rcmd.3, re_comp.3, readdir.3, realpath.3, recno.3, regex.3, remainder.3, remove.3, remquo.3, resolver.3, rewinddir.3, rexec.3, rint.3, round.3, rpc.3, rpmatch.3, rtime.3, rtnetlink.3, scalb.3, scalbln.3, scandir.3, scandirat.3, scanf.3, seekdir.3, sem_close.3, sem_destroy.3, sem_getvalue.3, sem_init.3, sem_open.3, sem_post.3, sem_unlink.3, sem_wait.3, setaliasent.3, setbuf.3, setenv.3, setjmp.3, setlocale.3, setlogmask.3, setnetgrent.3, shm_open.3, siginterrupt.3, signbit.3, significand.3, sigpause.3, sigqueue.3, sigset.3, sigsetops.3, sigvec.3, sin.3, sincos.3, sinh.3, sleep.3, sockatmark.3, sqrt.3, statvfs.3, stdarg.3, stdin.3, stdio.3, stdio_ext.3, stpcpy.3, stpncpy.3, strcasecmp.3, strcat.3, strchr.3, strcmp.3, strcoll.3, strcpy.3, strdup.3, strerror.3, strfmon.3, strfry.3, strftime.3, string.3, strlen.3, strnlen.3, strpbrk.3, strptime.3, strsep.3, strsignal.3, strspn.3, strstr.3, strtod.3, strtoimax.3, strtok.3, strtol.3, strtoul.3, strverscmp.3, strxfrm.3, swab.3, sysconf.3, syslog.3, system.3, sysv_signal.3, tan.3, tanh.3, tcgetpgrp.3, tcgetsid.3, telldir.3, tempnam.3, termios.3, tgamma.3, timegm.3, timeradd.3, tmpfile.3, tmpnam.3, toascii.3, toupper.3, towctrans.3, towlower.3, towupper.3, trunc.3, tsearch.3, ttyname.3, ttyslot.3, tzset.3, ualarm.3, ulimit.3, ungetwc.3, unlocked_stdio.3, unlockpt.3, updwtmp.3, usleep.3, wcpcpy.3, wcpncpy.3, wcrtomb.3, wcscasecmp.3, wcscat.3, wcschr.3, wcscmp.3, wcscpy.3, wcscspn.3, wcsdup.3, wcslen.3, wcsncasecmp.3, wcsncat.3, wcsncmp.3, wcsncpy.3, wcsnlen.3, wcsnrtombs.3, wcspbrk.3, wcsrchr.3, wcsrtombs.3, wcsspn.3, wcsstr.3, wcstoimax.3, wcstok.3, wcstombs.3, wcswidth.3, wctob.3, wctomb.3, wctrans.3, wctype.3, wcwidth.3, wmemchr.3, wmemcmp.3, wmemcpy.3, wmemmove.3, wmemset.3, wordexp.3, wprintf.3, xcrypt.3, xdr.3, y0.3, cciss.4, console.4, console_codes.4, console_ioctl.4, dsp56k.4, fd.4, full.4, hd.4, hpsa.4, initrd.4, intro.4, lp.4, mem.4, mouse.4, null.4, pts.4, ram.4, random.4, rtc.4, sk98lin.4, st.4, tty.4, ttyS.4, tty_ioctl.4, vcs.4, wavelan.4, acct.5, charmap.5, dir_colors.5, filesystems.5, ftpusers.5, group.5, host.conf.5, hosts.5, hosts.equiv.5, intro.5, issue.5, locale.5, motd.5, networks.5, nologin.5, nscd.conf.5, passwd.5, proc.5, protocols.5, resolv.conf.5, rpc.5, securetty.5, services.5, shells.5, termcap.5, ttytype.5, utmp.5, armscii-8.7, arp.7, ascii.7, bootparam.7, capabilities.7, charsets.7, complex.7, cp1251.7, credentials.7, ddp.7, environ.7, epoll.7, fifo.7, futex.7, glob.7, hier.7, icmp.7, inotify.7, intro.7, ip.7, ipv6.7, iso_8859-1.7, iso_8859-10.7, iso_8859-11.7, iso_8859-13.7, iso_8859-14.7, iso_8859-15.7, iso_8859-16.7, iso_8859-2.7, iso_8859-3.7, iso_8859-4.7, iso_8859-5.7, iso_8859-6.7, iso_8859-7.7, iso_8859-8.7, iso_8859-9.7, koi8-r.7, koi8-u.7, locale.7, mailaddr.7, man.7, mq_overview.7, netdevice.7, netlink.7, numa.7, packet.7, path_resolution.7, pipe.7, posixoptions.7, pthreads.7, pty.7, raw.7, regex.7, rtld-audit.7, rtnetlink.7, sem_overview.7, shm_overview.7, sigevent.7, signal.7, socket.7, standards.7, suffixes.7, svipc.7, tcp.7, termio.7, time.7, udp.7, udplite.7, unicode.7, unix.7, uri.7, utf-8.7, x25.7, nscd.8, sync.8, tzselect.8, zdump.8, zic.8: Global fix: remove unneeded double quotes in .SH headings
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-02-24 18:01:36 +00:00
|
|
|
.SH CONFORMING TO
|
2006-08-04 12:39:17 +00:00
|
|
|
Not in POSIX.1-2001.
|
|
|
|
Present on the BSDs.
|
2004-11-03 13:51:07 +00:00
|
|
|
The
|
2007-12-03 19:53:53 +00:00
|
|
|
queue functions first appeared in
|
|
|
|
4.4BSD.
|