mirror of
https://gitlab.freedesktop.org/libbsd/libbsd.git
synced 2025-10-19 21:16:55 +02:00
Compare commits
145 Commits
Author | SHA1 | Date | |
---|---|---|---|
![]() |
54796231c7 | ||
![]() |
7aed0edf73 | ||
![]() |
fafcc397ac | ||
![]() |
48107fc8c4 | ||
![]() |
e7cf8c5785 | ||
![]() |
25d35625eb | ||
![]() |
500b3080a2 | ||
![]() |
1eba406021 | ||
![]() |
8ad7570c20 | ||
![]() |
43a8270317 | ||
![]() |
6a71b24b63 | ||
![]() |
7389fe8d24 | ||
![]() |
2716dfd0b7 | ||
![]() |
54f8745657 | ||
![]() |
428be9e030 | ||
![]() |
c7a5d780ae | ||
![]() |
1808d64b77 | ||
![]() |
beafad2657 | ||
![]() |
6145b56178 | ||
![]() |
731b0a7739 | ||
![]() |
50b50a4330 | ||
![]() |
25e88f6479 | ||
![]() |
04a8fb2469 | ||
![]() |
4f68a88f55 | ||
![]() |
8f59221c4f | ||
![]() |
72a82ee262 | ||
![]() |
3c305f2873 | ||
![]() |
25278891d8 | ||
![]() |
e35d9141dc | ||
![]() |
4feda87049 | ||
![]() |
d563a17430 | ||
![]() |
785cf9d1e9 | ||
![]() |
15bd284b29 | ||
![]() |
a9fc285988 | ||
![]() |
c0d86a6412 | ||
![]() |
1fb25b7dca | ||
![]() |
31f034e386 | ||
![]() |
2374f409de | ||
![]() |
a4e0db2b97 | ||
![]() |
43d34c9d3b | ||
![]() |
1c3ff61699 | ||
![]() |
edea268ce9 | ||
![]() |
e832b7687e | ||
![]() |
c4fca5bb4f | ||
![]() |
a1f79978e8 | ||
![]() |
4676026286 | ||
![]() |
25f9b30678 | ||
![]() |
18ebabf223 | ||
![]() |
4ab11c7f48 | ||
![]() |
766c883e30 | ||
![]() |
a4de4d95a6 | ||
![]() |
233cab9d64 | ||
![]() |
2462cd8888 | ||
![]() |
d54ceb37ce | ||
![]() |
847e682f8d | ||
![]() |
68f980c90d | ||
![]() |
37a9b56c05 | ||
![]() |
45dd5229ea | ||
![]() |
01f0d1ea1e | ||
![]() |
9c85d828a1 | ||
![]() |
eac4ce0c67 | ||
![]() |
5ecff0c903 | ||
![]() |
8c5a83d678 | ||
![]() |
d5b04ab19c | ||
![]() |
cfeafeabad | ||
![]() |
3d6b6ead64 | ||
![]() |
eb445425ff | ||
![]() |
59f6a95609 | ||
![]() |
3548c5f6bf | ||
![]() |
a11c98a6b5 | ||
![]() |
5745ca0362 | ||
![]() |
9628798d7d | ||
![]() |
f34a5f71d9 | ||
![]() |
72c68868c8 | ||
![]() |
a4323f2b16 | ||
![]() |
4997efa59a | ||
![]() |
96202c6c14 | ||
![]() |
61d378f5e9 | ||
![]() |
9d917aad37 | ||
![]() |
18662cadfc | ||
![]() |
ce53f7c25f | ||
![]() |
24d1f4dd34 | ||
![]() |
e9529d9b4a | ||
![]() |
3aaedb1208 | ||
![]() |
2c754f435b | ||
![]() |
ee4d24970a | ||
![]() |
8d2afa3a9f | ||
![]() |
e9f6faf3aa | ||
![]() |
99320b9168 | ||
![]() |
71c710e9a8 | ||
![]() |
21f4052c5b | ||
![]() |
1899e2c5ab | ||
![]() |
4803340802 | ||
![]() |
f99b8ea527 | ||
![]() |
4bed48398f | ||
![]() |
2e071c3cc1 | ||
![]() |
890699a78b | ||
![]() |
b0ebb0d4c2 | ||
![]() |
73aea4f808 | ||
![]() |
7cfa2d4530 | ||
![]() |
574c7a1365 | ||
![]() |
c2d9d84088 | ||
![]() |
2ebe6d5a02 | ||
![]() |
aeea1f4083 | ||
![]() |
0500a1bd08 | ||
![]() |
3d9c6c08ed | ||
![]() |
b9dee9f69a | ||
![]() |
81c3c3e405 | ||
![]() |
5e0998fa4f | ||
![]() |
8e2d55047c | ||
![]() |
13c32916b4 | ||
![]() |
8e834cd068 | ||
![]() |
e354f9b1d0 | ||
![]() |
4c5e9b478e | ||
![]() |
005b509061 | ||
![]() |
a8531ad051 | ||
![]() |
c4b0fd2c9f | ||
![]() |
1ca09c18f7 | ||
![]() |
e4e15ed286 | ||
![]() |
bf697b900c | ||
![]() |
f1966385b3 | ||
![]() |
e007233cf0 | ||
![]() |
3cabf46bb0 | ||
![]() |
6eebc1f264 | ||
![]() |
a1730c1063 | ||
![]() |
6f68c93076 | ||
![]() |
e13b1a337a | ||
![]() |
ef5faeb575 | ||
![]() |
2d7de186e9 | ||
![]() |
3efad64155 | ||
![]() |
a6f407ab0d | ||
![]() |
21edbb4f22 | ||
![]() |
e3979d1a7c | ||
![]() |
facbddb652 | ||
![]() |
3d88c999b4 | ||
![]() |
e42381dc51 | ||
![]() |
993828d84e | ||
![]() |
30b4d50754 | ||
![]() |
f6ed7c278b | ||
![]() |
1f8a3f7bcc | ||
![]() |
b20272f5a9 | ||
![]() |
11ec8f1e5d | ||
![]() |
5ba8c5bab0 | ||
![]() |
0093ca2b0e | ||
![]() |
0b65d43963 |
5
.gitignore
vendored
5
.gitignore
vendored
@@ -1,4 +1,5 @@
|
||||
ChangeLog
|
||||
*~
|
||||
*.pc
|
||||
*.la
|
||||
*.lo
|
||||
@@ -7,6 +8,8 @@ ChangeLog
|
||||
*.a
|
||||
*.log
|
||||
*.trs
|
||||
*.gcda
|
||||
*.gcno
|
||||
.dirstamp
|
||||
.deps/
|
||||
.libs/
|
||||
@@ -17,6 +20,6 @@ autom4te.cache/
|
||||
build-aux/
|
||||
configure
|
||||
config.*
|
||||
format.ld
|
||||
libtool
|
||||
m4/
|
||||
stamp-h1
|
||||
|
19
.gitlab-ci.yml
Normal file
19
.gitlab-ci.yml
Normal file
@@ -0,0 +1,19 @@
|
||||
image: debian:buster
|
||||
|
||||
before_script:
|
||||
- apt-get update -qq
|
||||
- apt-get install -qq -y --no-install-recommends
|
||||
git gcc make autoconf automake libtool libmd-dev gcovr
|
||||
|
||||
unit-tests:
|
||||
stage: test
|
||||
script:
|
||||
- ./autogen && ./configure
|
||||
- make check
|
||||
|
||||
coverage:
|
||||
stage: test
|
||||
script:
|
||||
- ./autogen && ./configure --disable-static
|
||||
- make check CFLAGS="--coverage -O0 -ggdb" LDFLAGS="--coverage -O0 -ggdb"
|
||||
- gcovr -s -e test/
|
234
COPYING
234
COPYING
@@ -3,12 +3,11 @@ Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
|
||||
Files:
|
||||
*
|
||||
Copyright:
|
||||
Copyright © 2004-2006, 2008-2017 Guillem Jover <guillem@hadrons.org>
|
||||
Copyright © 2004-2006, 2008-2021 Guillem Jover <guillem@hadrons.org>
|
||||
License: BSD-3-clause
|
||||
|
||||
Files:
|
||||
man/arc4random.3bsd
|
||||
man/tree.3bsd
|
||||
Copyright:
|
||||
Copyright 1997 Niels Provos <provos@physnet.uni-hamburg.de>
|
||||
All rights reserved.
|
||||
@@ -74,16 +73,18 @@ License: BSD-4-clause-Christopher-G-Demetriou
|
||||
Files:
|
||||
include/bsd/err.h
|
||||
include/bsd/stdlib.h
|
||||
include/bsd/sys/param.h
|
||||
include/bsd/unistd.h
|
||||
src/bsd_getopt.c
|
||||
src/err.c
|
||||
src/fgetln.c
|
||||
src/progname.c
|
||||
Copyright:
|
||||
Copyright © 2005, 2008-2012 Guillem Jover <guillem@hadrons.org>
|
||||
Copyright © 2005, 2008-2012, 2019 Guillem Jover <guillem@hadrons.org>
|
||||
Copyright © 2005 Hector Garcia Alvarez
|
||||
Copyright © 2005 Aurelien Jarno
|
||||
Copyright © 2006 Robert Millan
|
||||
Copyright © 2018 Facebook, Inc.
|
||||
License: BSD-3-clause
|
||||
|
||||
Files:
|
||||
@@ -103,6 +104,7 @@ Files:
|
||||
man/getbsize.3bsd
|
||||
man/heapsort.3bsd
|
||||
man/nlist.3bsd
|
||||
man/pwcache.3bsd
|
||||
man/queue.3bsd
|
||||
man/radixsort.3bsd
|
||||
man/reallocarray.3bsd
|
||||
@@ -110,6 +112,8 @@ Files:
|
||||
man/setmode.3bsd
|
||||
man/strmode.3bsd
|
||||
man/strnstr.3bsd
|
||||
man/strtoi.3bsd
|
||||
man/strtou.3bsd
|
||||
man/unvis.3bsd
|
||||
man/vis.3bsd
|
||||
man/wcslcpy.3bsd
|
||||
@@ -117,15 +121,18 @@ Files:
|
||||
src/heapsort.c
|
||||
src/merge.c
|
||||
src/nlist.c
|
||||
src/pwcache.c
|
||||
src/radixsort.c
|
||||
src/setmode.c
|
||||
src/strmode.c
|
||||
src/strnstr.c
|
||||
src/strtoi.c
|
||||
src/strtou.c
|
||||
src/unvis.c
|
||||
src/vis.c
|
||||
Copyright:
|
||||
Copyright © 1980, 1982, 1986, 1989-1994
|
||||
The Regents of the University of California. All rights reserved.
|
||||
Copyright © 1992 Keith Muller.
|
||||
Copyright © 2001 Mike Barcroft <mike@FreeBSD.org>
|
||||
.
|
||||
Some code is derived from software contributed to Berkeley by
|
||||
@@ -153,29 +160,16 @@ Copyright:
|
||||
Co. or Unix System Laboratories, Inc. and are reproduced herein with
|
||||
the permission of UNIX System Laboratories, Inc.
|
||||
License: BSD-3-clause-Regents
|
||||
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.
|
||||
|
||||
Files:
|
||||
src/vis.c
|
||||
Copyright:
|
||||
Copyright © 1989, 1993
|
||||
The Regents of the University of California. All rights reserved.
|
||||
.
|
||||
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.
|
||||
Copyright © 1999, 2005 The NetBSD Foundation, Inc.
|
||||
All rights reserved.
|
||||
License: BSD-3-clause-Regents and BSD-2-clause-NetBSD
|
||||
|
||||
Files:
|
||||
include/bsd/libutil.h
|
||||
@@ -184,30 +178,7 @@ Copyright:
|
||||
All rights reserved.
|
||||
Copyright © 2002 Networks Associates Technology, Inc.
|
||||
All rights reserved.
|
||||
License: BSD-3-clause-Peter-Wemm
|
||||
Redistribution and use in source and binary forms, with or without
|
||||
modification, is 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. The name of the author may not be used to endorse or promote
|
||||
products derived from this software without specific prior written
|
||||
permission.
|
||||
.
|
||||
THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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 AUTHOR 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: BSD-3-clause-author
|
||||
|
||||
Files:
|
||||
man/timeradd.3bsd
|
||||
@@ -271,8 +242,11 @@ Files:
|
||||
src/fmtcheck.c
|
||||
src/humanize_number.c
|
||||
src/stringlist.c
|
||||
src/strtonum.c
|
||||
Copyright:
|
||||
Copyright © 1994, 1997-2000, 2002, 2008, 2010 The NetBSD Foundation, Inc.
|
||||
Copyright © 1994, 1997-2000, 2002, 2008, 2010, 2014
|
||||
The NetBSD Foundation, Inc.
|
||||
Copyright © 2013 John-Mark Gurney <jmg@FreeBSD.org>
|
||||
All rights reserved.
|
||||
.
|
||||
Some code was contributed to The NetBSD Foundation by Allen Briggs.
|
||||
@@ -293,26 +267,6 @@ Copyright:
|
||||
Some code is derived from software contributed to The NetBSD Foundation
|
||||
by Jukka Ruohonen.
|
||||
License: BSD-2-clause-NetBSD
|
||||
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.
|
||||
.
|
||||
THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. 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 FOUNDATION 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.
|
||||
|
||||
Files:
|
||||
include/bsd/sys/endian.h
|
||||
@@ -323,8 +277,6 @@ Files:
|
||||
man/getpeereid.3bsd
|
||||
man/pidfile.3bsd
|
||||
src/expand_number.c
|
||||
src/hash/sha512.h
|
||||
src/hash/sha512c.c
|
||||
src/pidfile.c
|
||||
src/reallocf.c
|
||||
src/timeconv.c
|
||||
@@ -367,7 +319,7 @@ License: BSD-2-clause
|
||||
Files:
|
||||
src/flopen.c
|
||||
Copyright:
|
||||
Copyright © 2007 Dag-Erling Coïdan Smørgrav
|
||||
Copyright © 2007-2009 Dag-Erling Coïdan Smørgrav
|
||||
All rights reserved.
|
||||
License: BSD-2-clause-verbatim
|
||||
Redistribution and use in source and binary forms, with or without
|
||||
@@ -395,6 +347,7 @@ License: BSD-2-clause-verbatim
|
||||
Files:
|
||||
include/bsd/sys/tree.h
|
||||
man/fparseln.3bsd
|
||||
man/tree.3bsd
|
||||
src/fparseln.c
|
||||
Copyright:
|
||||
Copyright © 1997 Christos Zoulas.
|
||||
@@ -403,25 +356,6 @@ Copyright:
|
||||
Copyright © 2002 Niels Provos <provos@citi.umich.edu>
|
||||
All rights reserved.
|
||||
License: BSD-2-clause-author
|
||||
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.
|
||||
.
|
||||
THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 AUTHOR 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.
|
||||
|
||||
Files:
|
||||
include/bsd/readpassphrase.h
|
||||
@@ -429,10 +363,13 @@ Files:
|
||||
man/strlcpy.3bsd
|
||||
man/strtonum.3bsd
|
||||
src/arc4random.c
|
||||
src/arc4random_linux.h
|
||||
src/arc4random_openbsd.h
|
||||
src/arc4random_uniform.c
|
||||
src/arc4random_unix.h
|
||||
src/arc4random_win.h
|
||||
src/closefrom.c
|
||||
src/freezero.c
|
||||
src/getentropy_aix.c
|
||||
src/getentropy_bsd.c
|
||||
src/getentropy_hpux.c
|
||||
@@ -440,11 +377,12 @@ Files:
|
||||
src/getentropy_linux.c
|
||||
src/getentropy_osx.c
|
||||
src/getentropy_solaris.c
|
||||
src/getentropy_win.c
|
||||
src/readpassphrase.c
|
||||
src/reallocarray.c
|
||||
src/recallocarray.c
|
||||
src/strlcat.c
|
||||
src/strlcpy.c
|
||||
src/strtonum.c
|
||||
Copyright:
|
||||
Copyright © 2004 Ted Unangst and Todd Miller
|
||||
All rights reserved.
|
||||
@@ -454,7 +392,7 @@ Copyright:
|
||||
Todd C. Miller <Todd.Miller@courtesan.com>
|
||||
Copyright © 2004 Ted Unangst
|
||||
Copyright © 2008 Damien Miller <djm@openbsd.org>
|
||||
Copyright © 2008 Otto Moerbeek <otto@drijf.net>
|
||||
Copyright © 2008, 2010-2011, 2016-2017 Otto Moerbeek <otto@drijf.net>
|
||||
Copyright © 2013 Markus Friedl <markus@openbsd.org>
|
||||
Copyright © 2014 Bob Beck <beck@obtuse.com>
|
||||
Copyright © 2014 Brent Cook <bcook@openbsd.org>
|
||||
@@ -518,17 +456,6 @@ License: Expat
|
||||
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
|
||||
USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
Files:
|
||||
include/bsd/md5.h
|
||||
src/hash/md5.c
|
||||
Copyright:
|
||||
None
|
||||
License: public-domain-Colin-Plumb
|
||||
This code implements the MD5 message-digest algorithm.
|
||||
The algorithm is due to Ron Rivest. This code was
|
||||
written by Colin Plumb in 1993, no copyright is claimed.
|
||||
This code is in the public domain; do with it what you wish.
|
||||
|
||||
Files:
|
||||
src/explicit_bzero.c
|
||||
src/chacha_private.h
|
||||
@@ -539,8 +466,6 @@ License: public-domain
|
||||
|
||||
Files:
|
||||
man/mdX.3bsd
|
||||
src/hash/md5hl.c
|
||||
src/hash/helper.c
|
||||
Copyright:
|
||||
None
|
||||
License: Beerware
|
||||
@@ -549,6 +474,56 @@ License: Beerware
|
||||
can do whatever you want with this stuff. If we meet some day, and you think
|
||||
this stuff is worth it, you can buy me a beer in return. Poul-Henning Kamp
|
||||
|
||||
License: BSD-3-clause-Regents
|
||||
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: BSD-3-clause-author
|
||||
Redistribution and use in source and binary forms, with or without
|
||||
modification, is 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. The name of the author may not be used to endorse or promote
|
||||
products derived from this software without specific prior written
|
||||
permission.
|
||||
.
|
||||
THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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 AUTHOR 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: BSD-3-clause
|
||||
Redistribution and use in source and binary forms, with or without
|
||||
modification, are permitted provided that the following conditions
|
||||
@@ -572,6 +547,49 @@ License: BSD-3-clause
|
||||
OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
|
||||
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
|
||||
License: BSD-2-clause-NetBSD
|
||||
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.
|
||||
.
|
||||
THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. 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 FOUNDATION 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: BSD-2-clause-author
|
||||
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.
|
||||
.
|
||||
THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 AUTHOR 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: BSD-2-clause
|
||||
Redistribution and use in source and binary forms, with or without
|
||||
modification, are permitted provided that the following conditions
|
||||
|
3
README
3
README
@@ -5,6 +5,9 @@ and lacking on others like GNU systems, thus making it easier to port
|
||||
projects with strong BSD origins, without needing to embed the same
|
||||
code over and over again on each project.
|
||||
|
||||
A BSD compatible message-digest library is required, on systems where
|
||||
this is not provided by its libc or libmd libraries, the canonical
|
||||
implementation to use is <https://www.hadrons.org/software/libmd/>.
|
||||
|
||||
Releases
|
||||
--------
|
||||
|
2
TODO
2
TODO
@@ -1,3 +1,4 @@
|
||||
* Migrate portable functions from GNU/kFreeBSD's libfreebsd.
|
||||
* Add more functions used by ported packages (check openssh).
|
||||
* Add more unit tests.
|
||||
* Add missing man pages.
|
||||
@@ -5,7 +6,6 @@
|
||||
- timeconv?
|
||||
* Add a README.import file.
|
||||
* Update man pages:
|
||||
- Fix references to a.out(5) and inline needed struct definitions.
|
||||
- Document when each interface was added on every BSD, and libbsd.
|
||||
* Handle LFS properly. By default the library emits LFS objects, but might
|
||||
be used by non-LFS objects. We should either provide foo and foo64
|
||||
|
122
configure.ac
122
configure.ac
@@ -12,8 +12,8 @@ m4_ifdef([AM_SILENT_RULES], [AM_SILENT_RULES([yes])],
|
||||
[AC_SUBST([AM_DEFAULT_VERBOSITY], [1])])
|
||||
|
||||
LIBBSD_ABI_MAJOR=0
|
||||
LIBBSD_ABI_MINOR=8
|
||||
LIBBSD_ABI_PATCH=7
|
||||
LIBBSD_ABI_MINOR=11
|
||||
LIBBSD_ABI_PATCH=4
|
||||
|
||||
LIBBSD_ABI="$LIBBSD_ABI_MAJOR:$LIBBSD_ABI_MINOR:$LIBBSD_ABI_PATCH"
|
||||
AC_SUBST([LIBBSD_ABI])
|
||||
@@ -27,15 +27,71 @@ AC_SYS_LARGEFILE
|
||||
|
||||
LT_INIT
|
||||
|
||||
AC_CACHE_CHECK([if ld supports --version-script flag],
|
||||
[libbsd_cv_version_script], [
|
||||
echo "{ global: symbol; local: *; };" >conftest.map
|
||||
save_LDFLAGS=$LDFLAGS
|
||||
LDFLAGS="$LDFLAGS -Wl,--version-script=conftest.map"
|
||||
AC_LINK_IFELSE([
|
||||
AC_LANG_PROGRAM([], [])
|
||||
], [
|
||||
libbsd_cv_version_script=yes
|
||||
], [
|
||||
libbsd_cv_version_script=no
|
||||
])
|
||||
LDFLAGS="$save_LDFLAGS"
|
||||
rm -f conftest.map
|
||||
]
|
||||
)
|
||||
AM_CONDITIONAL([HAVE_LINKER_VERSION_SCRIPT],
|
||||
[test "x$libbsd_cv_version_script" = "xyes"])
|
||||
|
||||
# Checks for programs.
|
||||
AC_PROG_CC
|
||||
AC_PROG_SED
|
||||
AC_PROG_INSTALL
|
||||
AC_PROG_LN_S
|
||||
|
||||
# Set default compiler variables
|
||||
if test "$user_CFLAGS" = unset && test "$GCC" = yes; then
|
||||
CFLAGS="$CFLAGS -Wall -Wextra -Wno-unused-variable -Wno-unused-parameter"
|
||||
fi
|
||||
AS_IF([test "$user_CFLAGS" = unset], [
|
||||
LIBBSD_CHECK_COMPILER_FLAG([-Wall])
|
||||
LIBBSD_CHECK_COMPILER_FLAG([-Wextra])
|
||||
|
||||
LIBBSD_CHECK_COMPILER_FLAG([-Wbad-function-cast])
|
||||
LIBBSD_CHECK_COMPILER_FLAG([-Wc99-c11-compat])
|
||||
LIBBSD_CHECK_COMPILER_FLAG([-Wcast-align])
|
||||
LIBBSD_CHECK_COMPILER_FLAG([-Wdeclaration-after-statement])
|
||||
LIBBSD_CHECK_COMPILER_FLAG([-Wdocumentation])
|
||||
LIBBSD_CHECK_COMPILER_FLAG([-Wduplicated-branches])
|
||||
LIBBSD_CHECK_COMPILER_FLAG([-Wduplicated-cond])
|
||||
LIBBSD_CHECK_COMPILER_FLAG([-Wformat -Wformat-security])
|
||||
LIBBSD_CHECK_COMPILER_FLAG([-Wformat=2])
|
||||
LIBBSD_CHECK_COMPILER_FLAG([-Winit-self])
|
||||
LIBBSD_CHECK_COMPILER_FLAG([-Wlogical-not-parentheses])
|
||||
LIBBSD_CHECK_COMPILER_FLAG([-Wlogical-op])
|
||||
LIBBSD_CHECK_COMPILER_FLAG([-Wmissing-declarations])
|
||||
LIBBSD_CHECK_COMPILER_FLAG([-Wmissing-format-attribute])
|
||||
LIBBSD_CHECK_COMPILER_FLAG([-Wmissing-prototypes])
|
||||
LIBBSD_CHECK_COMPILER_FLAG([-Wnested-externs])
|
||||
LIBBSD_CHECK_COMPILER_FLAG([-Wno-missing-field-initializers])
|
||||
LIBBSD_CHECK_COMPILER_FLAG([-Wno-nonnull-compare])
|
||||
LIBBSD_CHECK_COMPILER_FLAG([-Wno-tautological-constant-out-of-range-compare])
|
||||
LIBBSD_CHECK_COMPILER_FLAG([-Wno-unused-parameter])
|
||||
LIBBSD_CHECK_COMPILER_FLAG([-Wnull-dereference])
|
||||
LIBBSD_CHECK_COMPILER_FLAG([-Wold-style-definition])
|
||||
LIBBSD_CHECK_COMPILER_FLAG([-Wpointer-arith])
|
||||
LIBBSD_CHECK_COMPILER_FLAG([-Wregister])
|
||||
LIBBSD_CHECK_COMPILER_FLAG([-Wrestrict])
|
||||
LIBBSD_CHECK_COMPILER_FLAG([-Wshadow])
|
||||
LIBBSD_CHECK_COMPILER_FLAG([-Wshift-negative-value])
|
||||
LIBBSD_CHECK_COMPILER_FLAG([-Wsizeof-array-argument])
|
||||
LIBBSD_CHECK_COMPILER_FLAG([-Wstrict-prototypes])
|
||||
LIBBSD_CHECK_COMPILER_FLAG([-Wswitch-bool])
|
||||
LIBBSD_CHECK_COMPILER_FLAG([-Wvla])
|
||||
LIBBSD_CHECK_COMPILER_FLAG([-Wwrite-strings])
|
||||
|
||||
CFLAGS="$CFLAGS $LIBBSD_COMPILER_FLAGS"
|
||||
])
|
||||
|
||||
# Checks for libraries.
|
||||
AC_CHECK_LIB([testu01], [unif01_CreateExternGenBits],
|
||||
@@ -44,22 +100,51 @@ AC_SUBST([TESTU01_LIBS])
|
||||
AM_CONDITIONAL([HAVE_LIBTESTU01],
|
||||
[test "x$ac_cv_lib_testu01_unif01_CreateExternGenBits" = "xyes"])
|
||||
|
||||
saved_LIBS="$LIBS"
|
||||
AC_SEARCH_LIBS([MD5Update], [md], [
|
||||
AS_IF([test "x$ac_cv_search_MD5Update" != "xnone required"], [
|
||||
MD5_LIBS="$MD5_LIBS $ac_cv_search_MD5Update"
|
||||
need_transparent_libmd=yes
|
||||
])
|
||||
], [
|
||||
AC_MSG_ERROR([cannot find required MD5 functions in libc or libmd])
|
||||
])
|
||||
AC_SEARCH_LIBS([SHA512Update], [md], [
|
||||
AS_IF([test "x$ac_cv_search_SHA512Update" != "xnone required"], [
|
||||
LIBBSD_LIBS="$LIBBSD_LIBS $ac_cv_search_SHA512Update"
|
||||
])
|
||||
], [
|
||||
AC_MSG_ERROR([cannot find required SHA-2 functions in libc or libmd])
|
||||
])
|
||||
LIBS="$saved_LIBS"
|
||||
|
||||
AM_CONDITIONAL([NEED_TRANSPARENT_LIBMD],
|
||||
[test "x$need_transparent_libmd" = "xyes"])
|
||||
|
||||
is_windows=no
|
||||
AS_CASE([$host_os],
|
||||
[*-gnu*], [
|
||||
# In old glibc versions (< 2.17) clock_gettime() is in librt.
|
||||
saved_LIBS="$LIBS"
|
||||
AC_SEARCH_LIBS([clock_gettime], [rt], [CLOCK_GETTIME_LIBS="-lrt"])
|
||||
AC_SUBST([CLOCK_GETTIME_LIBS])
|
||||
AC_SEARCH_LIBS([clock_gettime], [rt], [
|
||||
AS_IF([test "x$ac_cv_search_clock_gettime" != "xnone required"], [
|
||||
LIBBSD_LIBS="$LIBBSD_LIBS $ac_cv_search_clock_gettime"
|
||||
])
|
||||
])
|
||||
LIBS="$saved_LIBS"
|
||||
],
|
||||
[*-musl*], [
|
||||
# Upstream refuses to define this, we will do it ourselves then.
|
||||
AC_DEFINE([__MUSL__], [1], [Define to 1 if we are building for musl])
|
||||
],
|
||||
[mingw*], [
|
||||
is_windows=yes
|
||||
],
|
||||
)
|
||||
AM_CONDITIONAL([OS_WINDOWS], [test "x$is_windows" = "xyes"])
|
||||
|
||||
# Checks for header files.
|
||||
AC_CHECK_HEADERS([sys/ndir.h sys/dir.h ndir.h dirent.h])
|
||||
AC_CHECK_HEADERS([sys/ndir.h sys/dir.h ndir.h dirent.h pwd.h grp.h])
|
||||
|
||||
# Checks for typedefs, structures, and compiler characteristics.
|
||||
AC_C_INLINE
|
||||
@@ -87,7 +172,7 @@ AC_CACHE_CHECK(
|
||||
[[
|
||||
static int rc = 1;
|
||||
static void init(int argc) { if (argc == 1) rc = 0; }
|
||||
void (*init_func)(int argc) __attribute__((section(".init_array"))) = init;
|
||||
void (*init_func)(int argc) __attribute__((__section__(".init_array"), __used__)) = init;
|
||||
int main() { return rc; }
|
||||
]]
|
||||
)],
|
||||
@@ -141,11 +226,30 @@ AC_LINK_IFELSE(
|
||||
AC_MSG_RESULT([yes])],
|
||||
[AC_MSG_RESULT([no])])
|
||||
|
||||
AC_MSG_CHECKING([for __register_atfork])
|
||||
AC_LINK_IFELSE(
|
||||
[AC_LANG_PROGRAM([[
|
||||
#include <stddef.h>
|
||||
extern void *__dso_handle;
|
||||
extern int __register_atfork(void (*)(void), void(*)(void), void (*)(void), void *);
|
||||
]], [[
|
||||
__register_atfork(NULL, NULL, NULL, __dso_handle);
|
||||
]])],
|
||||
[AC_DEFINE([HAVE___REGISTER_ATFORK], [1],
|
||||
[Define to 1 if you have __register_atfork])
|
||||
AC_MSG_RESULT([yes])],
|
||||
[LIBBSD_LIBS="$LIBBSD_LIBS -pthread"
|
||||
AC_MSG_RESULT([no])
|
||||
])
|
||||
|
||||
AC_CHECK_FUNCS([clearenv dirfd fopencookie __fpurge \
|
||||
getauxval getentropy getexecname getline \
|
||||
pstat_getproc sysconf])
|
||||
AM_CONDITIONAL([HAVE_GETENTROPY], [test "x$ac_cv_func_getentropy" = "xtrue"])
|
||||
|
||||
AC_SUBST([MD5_LIBS])
|
||||
AC_SUBST([LIBBSD_LIBS])
|
||||
|
||||
AC_CONFIG_FILES([
|
||||
Makefile
|
||||
include/Makefile
|
||||
|
@@ -4,6 +4,7 @@ nobase_include_HEADERS = \
|
||||
bsd/sys/bitstring.h \
|
||||
bsd/sys/cdefs.h \
|
||||
bsd/sys/endian.h \
|
||||
bsd/sys/param.h \
|
||||
bsd/sys/poll.h \
|
||||
bsd/sys/queue.h \
|
||||
bsd/sys/time.h \
|
||||
@@ -13,9 +14,12 @@ nobase_include_HEADERS = \
|
||||
bsd/bsd.h \
|
||||
bsd/err.h \
|
||||
bsd/getopt.h \
|
||||
bsd/grp.h \
|
||||
bsd/inttypes.h \
|
||||
bsd/libutil.h \
|
||||
bsd/md5.h \
|
||||
bsd/nlist.h \
|
||||
bsd/pwd.h \
|
||||
bsd/readpassphrase.h \
|
||||
bsd/stdio.h \
|
||||
bsd/stdlib.h \
|
||||
|
@@ -26,31 +26,56 @@
|
||||
*/
|
||||
|
||||
#ifdef LIBBSD_OVERLAY
|
||||
#include <sys/cdefs.h>
|
||||
#if __has_include_next(<err.h>)
|
||||
#include_next <err.h>
|
||||
#else
|
||||
#define LIBBSD_NEED_ERR_H_FUNCS
|
||||
#endif
|
||||
#else
|
||||
#include <bsd/sys/cdefs.h>
|
||||
#if __has_include(<err.h>)
|
||||
#include <err.h>
|
||||
#else
|
||||
#define LIBBSD_NEED_ERR_H_FUNCS
|
||||
#endif
|
||||
#endif
|
||||
|
||||
#ifndef LIBBSD_ERR_H
|
||||
#define LIBBSD_ERR_H
|
||||
|
||||
#ifdef LIBBSD_OVERLAY
|
||||
#include <sys/cdefs.h>
|
||||
#else
|
||||
#include <bsd/sys/cdefs.h>
|
||||
#endif
|
||||
|
||||
#include <stdarg.h>
|
||||
|
||||
__BEGIN_DECLS
|
||||
void warnc(int code, const char *format, ...)
|
||||
__printflike(2, 3);
|
||||
void vwarnc(int code, const char *format, va_list ap)
|
||||
__printflike(2, 0);
|
||||
void errc(int status, int code, const char *format, ...)
|
||||
__printflike(3, 4);
|
||||
void warnc(int code, const char *format, ...)
|
||||
__printflike(2, 3);
|
||||
|
||||
void verrc(int status, int code, const char *format, va_list ap)
|
||||
__printflike(3, 0);
|
||||
__printflike(3, 0) __dead2;
|
||||
void errc(int status, int code, const char *format, ...)
|
||||
__printflike(3, 4) __dead2;
|
||||
|
||||
#ifdef LIBBSD_NEED_ERR_H_FUNCS
|
||||
void vwarn(const char *format, va_list ap)
|
||||
__printflike(1, 0);
|
||||
void vwarnx(const char *format, va_list ap)
|
||||
__printflike(1, 0);
|
||||
void warn(const char *format, ...)
|
||||
__printflike(1, 2);
|
||||
void warnx(const char *format, ...)
|
||||
__printflike(1, 2);
|
||||
|
||||
void verr(int status, const char *format, va_list ap)
|
||||
__printflike(2, 0) __dead2;
|
||||
void verrx(int status, const char *format, va_list ap)
|
||||
__printflike(2, 0) __dead2;
|
||||
void err(int status, const char *format, ...)
|
||||
__printflike(2, 3) __dead2;
|
||||
void errx(int status, const char *format, ...)
|
||||
__printflike(2, 3) __dead2;
|
||||
#endif
|
||||
__END_DECLS
|
||||
|
||||
#endif
|
||||
|
@@ -25,9 +25,15 @@
|
||||
*/
|
||||
|
||||
#ifdef LIBBSD_OVERLAY
|
||||
#include <sys/cdefs.h>
|
||||
#if __has_include_next(<getopt.h>)
|
||||
#include_next <getopt.h>
|
||||
#endif
|
||||
#include <unistd.h>
|
||||
#else
|
||||
#include <bsd/sys/cdefs.h>
|
||||
#if __has_include(<getopt.h>)
|
||||
#include <getopt.h>
|
||||
#endif
|
||||
#include <bsd/unistd.h>
|
||||
#endif
|
||||
|
51
include/bsd/grp.h
Normal file
51
include/bsd/grp.h
Normal file
@@ -0,0 +1,51 @@
|
||||
/*
|
||||
* Copyright © 2021 Guillem Jover <guillem@hadrons.org>
|
||||
*
|
||||
* 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. The name of the author may not be used to endorse or promote products
|
||||
* derived from this software without specific prior written permission.
|
||||
*
|
||||
* THIS SOFTWARE IS PROVIDED ``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 AUTHOR 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.
|
||||
*/
|
||||
|
||||
#ifdef LIBBSD_OVERLAY
|
||||
#include <sys/cdefs.h>
|
||||
#if __has_include_next(<grp.h>)
|
||||
#include_next <grp.h>
|
||||
#endif
|
||||
#else
|
||||
#include <bsd/sys/cdefs.h>
|
||||
#if __has_include(<grp.h>)
|
||||
#include <grp.h>
|
||||
#endif
|
||||
#endif
|
||||
|
||||
#ifndef LIBBSD_GRP_H
|
||||
#define LIBBSD_GRP_H
|
||||
|
||||
#define _GR_BUF_LEN (1024 + 200 * sizeof(char *))
|
||||
|
||||
__BEGIN_DECLS
|
||||
int
|
||||
gid_from_group(const char *, gid_t *);
|
||||
const char *
|
||||
group_from_gid(gid_t, int);
|
||||
__END_DECLS
|
||||
|
||||
#endif
|
49
include/bsd/inttypes.h
Normal file
49
include/bsd/inttypes.h
Normal file
@@ -0,0 +1,49 @@
|
||||
/*
|
||||
* Copyright © 2018 Guillem Jover <guillem@hadrons.org>
|
||||
*
|
||||
* 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. The name of the author may not be used to endorse or promote products
|
||||
* derived from this software without specific prior written permission.
|
||||
*
|
||||
* THIS SOFTWARE IS PROVIDED ``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 AUTHOR 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.
|
||||
*/
|
||||
|
||||
#ifdef LIBBSD_OVERLAY
|
||||
#include_next <inttypes.h>
|
||||
#else
|
||||
#include <inttypes.h>
|
||||
#endif
|
||||
|
||||
#ifndef LIBBSD_INTTYPES_H
|
||||
#define LIBBSD_INTTYPES_H
|
||||
|
||||
#ifdef LIBBSD_OVERLAY
|
||||
#include <sys/cdefs.h>
|
||||
#else
|
||||
#include <bsd/sys/cdefs.h>
|
||||
#endif
|
||||
|
||||
__BEGIN_DECLS
|
||||
intmax_t strtoi(const char *__restrict nptr, char **__restrict endptr,
|
||||
int base, intmax_t lo, intmax_t hi, int *rstatus);
|
||||
uintmax_t strtou(const char *__restrict nptr, char **__restrict endptr,
|
||||
int base, uintmax_t lo, uintmax_t hi, int *rstatus);
|
||||
__END_DECLS
|
||||
|
||||
#endif
|
@@ -39,19 +39,16 @@
|
||||
#ifndef LIBBSD_LIBUTIL_H
|
||||
#define LIBBSD_LIBUTIL_H
|
||||
|
||||
#include <features.h>
|
||||
#ifdef LIBBSD_OVERLAY
|
||||
#include <sys/cdefs.h>
|
||||
#else
|
||||
#include <bsd/sys/cdefs.h>
|
||||
#endif
|
||||
#include <sys/types.h>
|
||||
#include <stdint.h>
|
||||
#include <stdio.h>
|
||||
|
||||
/* for pidfile.c */
|
||||
struct pidfh {
|
||||
int pf_fd;
|
||||
char *pf_path;
|
||||
dev_t pf_dev;
|
||||
ino_t pf_ino;
|
||||
};
|
||||
struct pidfh;
|
||||
|
||||
__BEGIN_DECLS
|
||||
int humanize_number(char *buf, size_t len, int64_t bytes,
|
||||
@@ -59,8 +56,10 @@ int humanize_number(char *buf, size_t len, int64_t bytes,
|
||||
int expand_number(const char *_buf, uint64_t *_num);
|
||||
|
||||
int flopen(const char *_path, int _flags, ...);
|
||||
int flopenat(int dirfd, const char *path, int flags, ...);
|
||||
|
||||
struct pidfh *pidfile_open(const char *path, mode_t mode, pid_t *pidptr);
|
||||
int pidfile_fileno(const struct pidfh *pfh);
|
||||
int pidfile_write(struct pidfh *pfh);
|
||||
int pidfile_close(struct pidfh *pfh);
|
||||
int pidfile_remove(struct pidfh *pfh);
|
||||
@@ -68,14 +67,16 @@ int pidfile_remove(struct pidfh *pfh);
|
||||
char *fparseln(FILE *, size_t *, size_t *, const char[3], int);
|
||||
__END_DECLS
|
||||
|
||||
/* humanize_number(3) */
|
||||
#define HN_DECIMAL 0x01
|
||||
#define HN_NOSPACE 0x02
|
||||
#define HN_B 0x04
|
||||
#define HN_DIVISOR_1000 0x08
|
||||
/* Values for humanize_number(3)'s flags parameter. */
|
||||
#define HN_DECIMAL 0x01
|
||||
#define HN_NOSPACE 0x02
|
||||
#define HN_B 0x04
|
||||
#define HN_DIVISOR_1000 0x08
|
||||
#define HN_IEC_PREFIXES 0x10
|
||||
|
||||
#define HN_GETSCALE 0x10
|
||||
#define HN_AUTOSCALE 0x20
|
||||
/* Values for humanize_number(3)'s scale parameter. */
|
||||
#define HN_GETSCALE 0x10
|
||||
#define HN_AUTOSCALE 0x20
|
||||
|
||||
/*
|
||||
* fparseln() specific operation flags.
|
||||
|
@@ -1,54 +1,31 @@
|
||||
/* $OpenBSD: md5.h,v 1.16 2004/06/22 01:57:30 jfb Exp $ */
|
||||
|
||||
/*
|
||||
* This code implements the MD5 message-digest algorithm.
|
||||
* The algorithm is due to Ron Rivest. This code was
|
||||
* written by Colin Plumb in 1993, no copyright is claimed.
|
||||
* This code is in the public domain; do with it what you wish.
|
||||
* Copyright © 2021 Guillem Jover <guillem@hadrons.org>
|
||||
*
|
||||
* Equivalent code is available from RSA Data Security, Inc.
|
||||
* This code has been tested against that, and is equivalent,
|
||||
* except that you don't need to include two pages of legalese
|
||||
* with every copy.
|
||||
* 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. The name of the author may not be used to endorse or promote products
|
||||
* derived from this software without specific prior written permission.
|
||||
*
|
||||
* THIS SOFTWARE IS PROVIDED ``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 AUTHOR 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.
|
||||
*/
|
||||
|
||||
#ifndef LIBBSD_MD5_H
|
||||
#define LIBBSD_MD5_H
|
||||
|
||||
#include <stdint.h>
|
||||
|
||||
#define MD5_BLOCK_LENGTH 64
|
||||
#define MD5_DIGEST_LENGTH 16
|
||||
#define MD5_DIGEST_STRING_LENGTH (MD5_DIGEST_LENGTH * 2 + 1)
|
||||
|
||||
typedef struct MD5Context {
|
||||
uint32_t state[4]; /* state */
|
||||
uint64_t count; /* number of bits, mod 2^64 */
|
||||
uint8_t buffer[MD5_BLOCK_LENGTH]; /* input buffer */
|
||||
} MD5_CTX;
|
||||
|
||||
#include <sys/cdefs.h>
|
||||
#include <sys/types.h>
|
||||
|
||||
__BEGIN_DECLS
|
||||
void MD5Init(MD5_CTX *);
|
||||
void MD5Update(MD5_CTX *, const uint8_t *, size_t)
|
||||
__attribute__((__bounded__(__string__,2,3)));
|
||||
void MD5Pad(MD5_CTX *);
|
||||
void MD5Final(uint8_t [MD5_DIGEST_LENGTH], MD5_CTX *)
|
||||
__attribute__((__bounded__(__minbytes__,1,MD5_DIGEST_LENGTH)));
|
||||
void MD5Transform(uint32_t [4], const uint8_t [MD5_BLOCK_LENGTH])
|
||||
__attribute__((__bounded__(__minbytes__,1,4)))
|
||||
__attribute__((__bounded__(__minbytes__,2,MD5_BLOCK_LENGTH)));
|
||||
char *MD5End(MD5_CTX *, char *)
|
||||
__attribute__((__bounded__(__minbytes__,2,MD5_DIGEST_STRING_LENGTH)));
|
||||
char *MD5File(const char *, char *)
|
||||
__attribute__((__bounded__(__minbytes__,2,MD5_DIGEST_STRING_LENGTH)));
|
||||
char *MD5FileChunk(const char *, char *, off_t, off_t)
|
||||
__attribute__((__bounded__(__minbytes__,2,MD5_DIGEST_STRING_LENGTH)));
|
||||
char *MD5Data(const uint8_t *, size_t, char *)
|
||||
__attribute__((__bounded__(__string__,1,2)))
|
||||
__attribute__((__bounded__(__minbytes__,3,MD5_DIGEST_STRING_LENGTH)));
|
||||
__END_DECLS
|
||||
|
||||
#endif /* LIBBSD_MD5_H */
|
||||
#ifdef LIBBSD_OVERLAY
|
||||
#include_next <md5.h>
|
||||
#else
|
||||
#include <md5.h>
|
||||
#endif
|
||||
|
@@ -27,14 +27,21 @@
|
||||
#ifndef LIBBSD_NLIST_H
|
||||
#define LIBBSD_NLIST_H
|
||||
|
||||
#ifdef LIBBSD_OVERLAY
|
||||
#include <sys/cdefs.h>
|
||||
#else
|
||||
#include <bsd/sys/cdefs.h>
|
||||
#endif
|
||||
|
||||
struct nlist {
|
||||
union {
|
||||
char *n_name;
|
||||
struct n_list *n_next;
|
||||
long n_strx;
|
||||
} n_un;
|
||||
union {
|
||||
char *n_name;
|
||||
struct n_list *n_next;
|
||||
long n_strx;
|
||||
} n_un;
|
||||
};
|
||||
unsigned char n_type;
|
||||
char n_other;
|
||||
short n_desc;
|
||||
|
51
include/bsd/pwd.h
Normal file
51
include/bsd/pwd.h
Normal file
@@ -0,0 +1,51 @@
|
||||
/*
|
||||
* Copyright © 2021 Guillem Jover <guillem@hadrons.org>
|
||||
*
|
||||
* 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. The name of the author may not be used to endorse or promote products
|
||||
* derived from this software without specific prior written permission.
|
||||
*
|
||||
* THIS SOFTWARE IS PROVIDED ``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 AUTHOR 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.
|
||||
*/
|
||||
|
||||
#ifdef LIBBSD_OVERLAY
|
||||
#include <sys/cdefs.h>
|
||||
#if __has_include_next(<pwd.h>)
|
||||
#include_next <pwd.h>
|
||||
#endif
|
||||
#else
|
||||
#include <bsd/sys/cdefs.h>
|
||||
#if __has_include(<pwd.h>)
|
||||
#include <pwd.h>
|
||||
#endif
|
||||
#endif
|
||||
|
||||
#ifndef LIBBSD_PWD_H
|
||||
#define LIBBSD_PWD_H
|
||||
|
||||
#define _PW_BUF_LEN 1024 /* length of getpw*_r buffer */
|
||||
|
||||
__BEGIN_DECLS
|
||||
int
|
||||
uid_from_user(const char *, uid_t *);
|
||||
const char *
|
||||
user_from_uid(uid_t, int);
|
||||
__END_DECLS
|
||||
|
||||
#endif
|
@@ -31,7 +31,11 @@
|
||||
#define RPP_SEVENBIT 0x10 /* Strip the high bit from input. */
|
||||
#define RPP_STDIN 0x20 /* Read from stdin, not /dev/tty */
|
||||
|
||||
#ifdef LIBBSD_OVERLAY
|
||||
#include <sys/cdefs.h>
|
||||
#else
|
||||
#include <bsd/sys/cdefs.h>
|
||||
#endif
|
||||
#include <sys/types.h>
|
||||
|
||||
__BEGIN_DECLS
|
||||
|
@@ -42,7 +42,11 @@
|
||||
#ifndef LIBBSD_STDLIB_H
|
||||
#define LIBBSD_STDLIB_H
|
||||
|
||||
#ifdef LIBBSD_OVERLAY
|
||||
#include <sys/cdefs.h>
|
||||
#else
|
||||
#include <bsd/sys/cdefs.h>
|
||||
#endif
|
||||
#include <sys/stat.h>
|
||||
#include <stdint.h>
|
||||
|
||||
@@ -58,7 +62,7 @@ int dehumanize_number(const char *str, int64_t *size);
|
||||
const char *getprogname(void);
|
||||
void setprogname(const char *);
|
||||
|
||||
int heapsort (void *, size_t, size_t, int (*)(const void *, const void *));
|
||||
int heapsort(void *, size_t, size_t, int (*)(const void *, const void *));
|
||||
int mergesort(void *base, size_t nmemb, size_t size,
|
||||
int (*cmp)(const void *, const void *));
|
||||
int radixsort(const unsigned char **base, int nmemb,
|
||||
@@ -67,9 +71,12 @@ int sradixsort(const unsigned char **base, int nmemb,
|
||||
const unsigned char *table, unsigned endbyte);
|
||||
|
||||
void *reallocf(void *ptr, size_t size);
|
||||
#if defined(_GNU_SOURCE) && defined(__GLIBC__) && !__GLIBC_PREREQ(2, 26)
|
||||
#if !defined(__GLIBC__) || \
|
||||
(defined(__GLIBC__) && (!__GLIBC_PREREQ(2, 26) || !defined(_GNU_SOURCE)))
|
||||
void *reallocarray(void *ptr, size_t nmemb, size_t size);
|
||||
#endif
|
||||
void *recallocarray(void *ptr, size_t oldnmemb, size_t nmemb, size_t size);
|
||||
void freezero(void *ptr, size_t size);
|
||||
|
||||
long long strtonum(const char *nptr, long long minval, long long maxval,
|
||||
const char **errstr);
|
||||
|
@@ -33,7 +33,11 @@
|
||||
#ifndef LIBBSD_STRING_H
|
||||
#define LIBBSD_STRING_H
|
||||
|
||||
#ifdef LIBBSD_OVERLAY
|
||||
#include <sys/cdefs.h>
|
||||
#else
|
||||
#include <bsd/sys/cdefs.h>
|
||||
#endif
|
||||
#include <sys/types.h>
|
||||
|
||||
__BEGIN_DECLS
|
||||
@@ -42,7 +46,8 @@ size_t strlcat(char *dst, const char *src, size_t siz);
|
||||
char *strnstr(const char *str, const char *find, size_t str_len);
|
||||
void strmode(mode_t mode, char *str);
|
||||
|
||||
#if defined(_GNU_SOURCE) && defined(__GLIBC__) && !__GLIBC_PREREQ(2, 25)
|
||||
#if !defined(__GLIBC__) || \
|
||||
(defined(__GLIBC__) && (!__GLIBC_PREREQ(2, 25) || !defined(_GNU_SOURCE)))
|
||||
void explicit_bzero(void *buf, size_t len);
|
||||
#endif
|
||||
__END_DECLS
|
||||
|
@@ -31,7 +31,12 @@
|
||||
|
||||
#ifndef LIBBSD_STRINGLIST_H
|
||||
#define LIBBSD_STRINGLIST_H
|
||||
|
||||
#ifdef LIBBSD_OVERLAY
|
||||
#include <sys/cdefs.h>
|
||||
#else
|
||||
#include <bsd/sys/cdefs.h>
|
||||
#endif
|
||||
#include <sys/types.h>
|
||||
|
||||
/*
|
||||
|
@@ -30,6 +30,13 @@
|
||||
#ifndef __has_include_next
|
||||
#define __has_include_next(x) 1
|
||||
#endif
|
||||
#ifndef __has_attribute
|
||||
#define __has_attribute(x) 0
|
||||
#endif
|
||||
/* Clang expands this to 1 if an identifier is *not* reserved. */
|
||||
#ifndef __is_identifier
|
||||
#define __is_identifier(x) 1
|
||||
#endif
|
||||
|
||||
#ifdef LIBBSD_OVERLAY
|
||||
/*
|
||||
@@ -58,6 +65,14 @@
|
||||
#endif
|
||||
#endif
|
||||
|
||||
/*
|
||||
* On non-glibc based systems, we cannot unconditionally use the
|
||||
* __GLIBC_PREREQ macro as it gets expanded before evaluation.
|
||||
*/
|
||||
#ifndef __GLIBC_PREREQ
|
||||
#define __GLIBC_PREREQ(maj, min) 0
|
||||
#endif
|
||||
|
||||
/*
|
||||
* Some kFreeBSD headers expect those macros to be set for sanity checks.
|
||||
*/
|
||||
@@ -68,22 +83,31 @@
|
||||
#define _SYS_CDEFS_H
|
||||
#endif
|
||||
|
||||
#define LIBBSD_CONCAT(x, y) x ## y
|
||||
#define LIBBSD_STRING(x) #x
|
||||
|
||||
#ifdef __GNUC__
|
||||
#define LIBBSD_GCC_VERSION (__GNUC__ << 8 | __GNUC_MINOR__)
|
||||
#else
|
||||
#define LIBBSD_GCC_VERSION 0
|
||||
#endif
|
||||
|
||||
#if LIBBSD_GCC_VERSION >= 0x0405
|
||||
#define LIBBSD_DEPRECATED(x) __attribute__((deprecated(x)))
|
||||
#if LIBBSD_GCC_VERSION >= 0x0405 || __has_attribute(__deprecated__)
|
||||
#define LIBBSD_DEPRECATED(x) __attribute__((__deprecated__(x)))
|
||||
#elif LIBBSD_GCC_VERSION >= 0x0301
|
||||
#define LIBBSD_DEPRECATED(x) __attribute__((deprecated))
|
||||
#define LIBBSD_DEPRECATED(x) __attribute__((__deprecated__))
|
||||
#else
|
||||
#define LIBBSD_DEPRECATED(x)
|
||||
#endif
|
||||
|
||||
#if LIBBSD_GCC_VERSION >= 0x0200 || defined(__clang__)
|
||||
#define LIBBSD_REDIRECT(name, proto, alias) name proto __asm__(LIBBSD_ASMNAME(#alias))
|
||||
#endif
|
||||
#define LIBBSD_ASMNAME(cname) LIBBSD_ASMNAME_PREFIX(__USER_LABEL_PREFIX__, cname)
|
||||
#define LIBBSD_ASMNAME_PREFIX(prefix, cname) LIBBSD_STRING(prefix) cname
|
||||
|
||||
#ifndef __dead2
|
||||
# if LIBBSD_GCC_VERSION >= 0x0207
|
||||
# if LIBBSD_GCC_VERSION >= 0x0207 || __has_attribute(__noreturn__)
|
||||
# define __dead2 __attribute__((__noreturn__))
|
||||
# else
|
||||
# define __dead2
|
||||
@@ -91,7 +115,7 @@
|
||||
#endif
|
||||
|
||||
#ifndef __pure2
|
||||
# if LIBBSD_GCC_VERSION >= 0x0207
|
||||
# if LIBBSD_GCC_VERSION >= 0x0207 || __has_attribute(__const__)
|
||||
# define __pure2 __attribute__((__const__))
|
||||
# else
|
||||
# define __pure2
|
||||
@@ -99,7 +123,7 @@
|
||||
#endif
|
||||
|
||||
#ifndef __packed
|
||||
# if LIBBSD_GCC_VERSION >= 0x0207
|
||||
# if LIBBSD_GCC_VERSION >= 0x0207 || __has_attribute(__packed__)
|
||||
# define __packed __attribute__((__packed__))
|
||||
# else
|
||||
# define __packed
|
||||
@@ -107,7 +131,7 @@
|
||||
#endif
|
||||
|
||||
#ifndef __aligned
|
||||
# if LIBBSD_GCC_VERSION >= 0x0207
|
||||
# if LIBBSD_GCC_VERSION >= 0x0207 || __has_attribute(__aligned__)
|
||||
# define __aligned(x) __attribute__((__aligned__(x)))
|
||||
# else
|
||||
# define __aligned(x)
|
||||
@@ -120,7 +144,7 @@
|
||||
#if 0
|
||||
#ifndef __unused
|
||||
# if LIBBSD_GCC_VERSION >= 0x0300
|
||||
# define __unused __attribute__((unused))
|
||||
# define __unused __attribute__((__unused__))
|
||||
# else
|
||||
# define __unused
|
||||
# endif
|
||||
@@ -128,15 +152,15 @@
|
||||
#endif
|
||||
|
||||
#ifndef __printflike
|
||||
# if LIBBSD_GCC_VERSION >= 0x0300
|
||||
# define __printflike(x, y) __attribute((format(printf, (x), (y))))
|
||||
# if LIBBSD_GCC_VERSION >= 0x0300 || __has_attribute(__format__)
|
||||
# define __printflike(x, y) __attribute((__format__(__printf__, (x), (y))))
|
||||
# else
|
||||
# define __printflike(x, y)
|
||||
# endif
|
||||
#endif
|
||||
|
||||
#ifndef __nonnull
|
||||
# if LIBBSD_GCC_VERSION >= 0x0302
|
||||
# if LIBBSD_GCC_VERSION >= 0x0302 || __has_attribute(__nonnull__)
|
||||
# define __nonnull(x) __attribute__((__nonnull__(x)))
|
||||
# else
|
||||
# define __nonnull(x)
|
||||
@@ -147,20 +171,26 @@
|
||||
# define __bounded__(x, y, z)
|
||||
#endif
|
||||
|
||||
/*
|
||||
* Return the number of elements in a statically-allocated array,
|
||||
* __x.
|
||||
*/
|
||||
#define __arraycount(__x) (sizeof(__x) / sizeof(__x[0]))
|
||||
|
||||
/*
|
||||
* We define this here since <stddef.h>, <sys/queue.h>, and <sys/types.h>
|
||||
* require it.
|
||||
*/
|
||||
#ifndef __offsetof
|
||||
# if LIBBSD_GCC_VERSION >= 0x0401
|
||||
# if LIBBSD_GCC_VERSION >= 0x0401 || !__is_identifier(__builtin_offsetof)
|
||||
# define __offsetof(type, field) __builtin_offsetof(type, field)
|
||||
# else
|
||||
# ifndef __cplusplus
|
||||
# define __offsetof(type, field) \
|
||||
((__size_t)(__uintptr_t)((const volatile void *)&((type *)0)->field))
|
||||
((size_t)(uintptr_t)((const volatile void *)&((type *)0)->field))
|
||||
# else
|
||||
# define __offsetof(type, field) \
|
||||
(__offsetof__ (reinterpret_cast <__size_t> \
|
||||
(__offsetof__ (reinterpret_cast <size_t> \
|
||||
(&reinterpret_cast <const volatile char &> \
|
||||
(static_cast<type *> (0)->field))))
|
||||
# endif
|
||||
@@ -177,9 +207,9 @@
|
||||
* compatible with member m.
|
||||
*/
|
||||
#ifndef __containerof
|
||||
# if LIBBSD_GCC_VERSION >= 0x0301
|
||||
# if LIBBSD_GCC_VERSION >= 0x0301 || !__is_identifier(__typeof__)
|
||||
# define __containerof(x, s, m) ({ \
|
||||
const volatile __typeof(((s *)0)->m) *__x = (x); \
|
||||
const volatile __typeof__(((s *)0)->m) *__x = (x); \
|
||||
__DEQUALIFY(s *, (const volatile char *)__x - __offsetof(s, m)); \
|
||||
})
|
||||
# else
|
||||
@@ -213,15 +243,15 @@
|
||||
#endif
|
||||
|
||||
#ifndef __DECONST
|
||||
#define __DECONST(type, var) ((type)(__uintptr_t)(const void *)(var))
|
||||
#define __DECONST(type, var) ((type)(uintptr_t)(const void *)(var))
|
||||
#endif
|
||||
|
||||
#ifndef __DEVOLATILE
|
||||
#define __DEVOLATILE(type, var) ((type)(__uintptr_t)(volatile void *)(var))
|
||||
#define __DEVOLATILE(type, var) ((type)(uintptr_t)(volatile void *)(var))
|
||||
#endif
|
||||
|
||||
#ifndef __DEQUALIFY
|
||||
#define __DEQUALIFY(type, var) ((type)(__uintptr_t)(const volatile void *)(var))
|
||||
#define __DEQUALIFY(type, var) ((type)(uintptr_t)(const volatile void *)(var))
|
||||
#endif
|
||||
|
||||
#endif
|
||||
|
@@ -27,10 +27,16 @@
|
||||
*/
|
||||
|
||||
#ifdef LIBBSD_OVERLAY
|
||||
#include <sys/cdefs.h>
|
||||
#if __has_include_next(<endian.h>)
|
||||
#include_next <endian.h>
|
||||
#endif
|
||||
#else
|
||||
#include <bsd/sys/cdefs.h>
|
||||
#if __has_include(<endian.h>)
|
||||
#include <endian.h>
|
||||
#endif
|
||||
#endif
|
||||
|
||||
#ifndef LIBBSD_SYS_ENDIAN_H
|
||||
#define LIBBSD_SYS_ENDIAN_H
|
||||
|
49
include/bsd/sys/param.h
Normal file
49
include/bsd/sys/param.h
Normal file
@@ -0,0 +1,49 @@
|
||||
/*
|
||||
* Copyright © 2018 Facebook, Inc.
|
||||
*
|
||||
* 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. The name of the author may not be used to endorse or promote products
|
||||
* derived from this software without specific prior written permission.
|
||||
*
|
||||
* THIS SOFTWARE IS PROVIDED ``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 AUTHOR 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.
|
||||
*/
|
||||
|
||||
#ifdef LIBBSD_OVERLAY
|
||||
#include <sys/cdefs.h>
|
||||
#if __has_include_next(<sys/param.h>)
|
||||
#include_next <sys/param.h>
|
||||
#endif
|
||||
#else
|
||||
#include <bsd/sys/cdefs.h>
|
||||
#if __has_include(<sys/param.h>)
|
||||
#include <sys/param.h>
|
||||
#endif
|
||||
#endif
|
||||
|
||||
#ifndef LIBBSD_SYS_PARAM_H
|
||||
#define LIBBSD_SYS_PARAM_H
|
||||
|
||||
#ifndef MIN
|
||||
#define MIN(x, y) (((x) < (y)) ? (x) : (y))
|
||||
#endif
|
||||
#ifndef MAX
|
||||
#define MAX(x, y) (((x) > (y)) ? (x) : (y))
|
||||
#endif
|
||||
|
||||
#endif
|
@@ -1,4 +1,6 @@
|
||||
/*-
|
||||
* SPDX-License-Identifier: BSD-3-Clause
|
||||
*
|
||||
* Copyright (c) 1991, 1993
|
||||
* The Regents of the University of California. All rights reserved.
|
||||
*
|
||||
@@ -10,7 +12,7 @@
|
||||
* 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.
|
||||
* 4. Neither the name of the University nor the names of its contributors
|
||||
* 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.
|
||||
*
|
||||
@@ -33,7 +35,11 @@
|
||||
#ifndef LIBBSD_SYS_QUEUE_H
|
||||
#define LIBBSD_SYS_QUEUE_H
|
||||
|
||||
#ifdef LIBBSD_OVERLAY
|
||||
#include <sys/cdefs.h>
|
||||
#else
|
||||
#include <bsd/sys/cdefs.h>
|
||||
#endif
|
||||
|
||||
/*
|
||||
* This file defines four types of data structures: singly-linked lists,
|
||||
@@ -76,17 +82,25 @@
|
||||
*
|
||||
* For details on the use of these macros, see the queue(3) manual page.
|
||||
*
|
||||
* Below is a summary of implemented functions where:
|
||||
* + means the macro is available
|
||||
* - means the macro is not available
|
||||
* s means the macro is available but is slow (runs in O(n) time)
|
||||
*
|
||||
* SLIST LIST STAILQ TAILQ
|
||||
* _HEAD + + + +
|
||||
* _CLASS_HEAD + + + +
|
||||
* _HEAD_INITIALIZER + + + +
|
||||
* _ENTRY + + + +
|
||||
* _CLASS_ENTRY + + + +
|
||||
* _INIT + + + +
|
||||
* _EMPTY + + + +
|
||||
* _END + + + +
|
||||
* _FIRST + + + +
|
||||
* _NEXT + + + +
|
||||
* _PREV - + - +
|
||||
* _LAST - - + +
|
||||
* _LAST_FAST - - - +
|
||||
* _FOREACH + + + +
|
||||
* _FOREACH_FROM + + + +
|
||||
* _FOREACH_SAFE + + + +
|
||||
@@ -99,14 +113,20 @@
|
||||
* _INSERT_BEFORE - + - +
|
||||
* _INSERT_AFTER + + + +
|
||||
* _INSERT_TAIL - - + +
|
||||
* _CONCAT - - + +
|
||||
* _CONCAT s s + +
|
||||
* _REMOVE_AFTER + - + -
|
||||
* _REMOVE_HEAD + - + -
|
||||
* _REMOVE + + + +
|
||||
* _REMOVE s + s +
|
||||
* _SWAP + + + +
|
||||
*
|
||||
*/
|
||||
#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
|
||||
|
||||
#ifdef QUEUE_MACRO_DEBUG_TRACE
|
||||
/* Store the last 2 places the queue element or head was altered */
|
||||
struct qm_trace {
|
||||
unsigned long lastline;
|
||||
@@ -116,9 +136,7 @@ struct qm_trace {
|
||||
};
|
||||
|
||||
#define TRACEBUF struct qm_trace trace;
|
||||
#define TRACEBUF_INITIALIZER { __FILE__, __LINE__, NULL, 0 } ,
|
||||
#define TRASHIT(x) do {(x) = (void *)-1;} while (0)
|
||||
#define QMD_SAVELINK(name, link) void **name = (void *)&(link)
|
||||
#define TRACEBUF_INITIALIZER { __LINE__, 0, __FILE__, NULL } ,
|
||||
|
||||
#define QMD_TRACE_HEAD(head) do { \
|
||||
(head)->trace.prevline = (head)->trace.lastline; \
|
||||
@@ -134,14 +152,31 @@ struct qm_trace {
|
||||
(elem)->trace.lastfile = __FILE__; \
|
||||
} while (0)
|
||||
|
||||
#else
|
||||
#else /* !QUEUE_MACRO_DEBUG_TRACE */
|
||||
#define QMD_TRACE_ELEM(elem)
|
||||
#define QMD_TRACE_HEAD(head)
|
||||
#define QMD_SAVELINK(name, link)
|
||||
#define TRACEBUF
|
||||
#define TRACEBUF_INITIALIZER
|
||||
#endif /* QUEUE_MACRO_DEBUG_TRACE */
|
||||
|
||||
#ifdef QUEUE_MACRO_DEBUG_TRASH
|
||||
#define QMD_SAVELINK(name, link) void **name = (void *)&(link)
|
||||
#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 QMD_SAVELINK(name, link)
|
||||
#define TRASHIT(x)
|
||||
#endif /* QUEUE_MACRO_DEBUG */
|
||||
#define QMD_IS_TRASHED(x) 0
|
||||
#endif /* QUEUE_MACRO_DEBUG_TRASH */
|
||||
|
||||
#ifdef __cplusplus
|
||||
/*
|
||||
* In C++ there can be structure lists and class lists:
|
||||
*/
|
||||
#define QUEUE_TYPEOF(type) type
|
||||
#else
|
||||
#define QUEUE_TYPEOF(type) struct type
|
||||
#endif
|
||||
|
||||
/*
|
||||
* Singly-linked List declarations.
|
||||
@@ -151,6 +186,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 }
|
||||
|
||||
@@ -159,9 +199,37 @@ struct { \
|
||||
struct type *sle_next; /* next element */ \
|
||||
}
|
||||
|
||||
#define SLIST_CLASS_ENTRY(type) \
|
||||
struct { \
|
||||
class type *sle_next; /* next element */ \
|
||||
}
|
||||
|
||||
/*
|
||||
* Singly-linked List functions.
|
||||
*/
|
||||
#if (defined(_KERNEL) && defined(INVARIANTS))
|
||||
#define QMD_SLIST_CHECK_PREVPTR(prevp, elm) do { \
|
||||
if (*(prevp) != (elm)) \
|
||||
panic("Bad prevptr *(%p) == %p != %p", \
|
||||
(prevp), *(prevp), (elm)); \
|
||||
} while (0)
|
||||
#else
|
||||
#define QMD_SLIST_CHECK_PREVPTR(prevp, elm)
|
||||
#endif
|
||||
|
||||
#define SLIST_CONCAT(head1, head2, type, field) do { \
|
||||
QUEUE_TYPEOF(type) *curelm = SLIST_FIRST(head1); \
|
||||
if (curelm == NULL) { \
|
||||
if ((SLIST_FIRST(head1) = SLIST_FIRST(head2)) != NULL) \
|
||||
SLIST_INIT(head2); \
|
||||
} else if (SLIST_FIRST(head2) != NULL) { \
|
||||
while (SLIST_NEXT(curelm, field) != NULL) \
|
||||
curelm = SLIST_NEXT(curelm, field); \
|
||||
SLIST_NEXT(curelm, field) = SLIST_FIRST(head2); \
|
||||
SLIST_INIT(head2); \
|
||||
} \
|
||||
} while (0)
|
||||
|
||||
#define SLIST_EMPTY(head) ((head)->slh_first == NULL)
|
||||
|
||||
#define SLIST_FIRST(head) ((head)->slh_first)
|
||||
@@ -213,7 +281,7 @@ struct { \
|
||||
SLIST_REMOVE_HEAD((head), field); \
|
||||
} \
|
||||
else { \
|
||||
struct type *curelm = SLIST_FIRST((head)); \
|
||||
QUEUE_TYPEOF(type) *curelm = SLIST_FIRST(head); \
|
||||
while (SLIST_NEXT(curelm, field) != (elm)) \
|
||||
curelm = SLIST_NEXT(curelm, field); \
|
||||
SLIST_REMOVE_AFTER(curelm, field); \
|
||||
@@ -230,12 +298,20 @@ struct { \
|
||||
SLIST_FIRST((head)) = SLIST_NEXT(SLIST_FIRST((head)), field); \
|
||||
} while (0)
|
||||
|
||||
#define SLIST_REMOVE_PREVPTR(prevp, elm, field) do { \
|
||||
QMD_SLIST_CHECK_PREVPTR(prevp, elm); \
|
||||
*(prevp) = SLIST_NEXT(elm, field); \
|
||||
TRASHIT((elm)->field.sle_next); \
|
||||
} while (0)
|
||||
|
||||
#define SLIST_SWAP(head1, head2, type) do { \
|
||||
struct type *swap_first = SLIST_FIRST(head1); \
|
||||
QUEUE_TYPEOF(type) *swap_first = SLIST_FIRST(head1); \
|
||||
SLIST_FIRST(head1) = SLIST_FIRST(head2); \
|
||||
SLIST_FIRST(head2) = swap_first; \
|
||||
} while (0)
|
||||
|
||||
#define SLIST_END(head) NULL
|
||||
|
||||
/*
|
||||
* Singly-linked Tail queue declarations.
|
||||
*/
|
||||
@@ -245,6 +321,12 @@ 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 }
|
||||
|
||||
@@ -253,6 +335,11 @@ struct { \
|
||||
struct type *stqe_next; /* next element */ \
|
||||
}
|
||||
|
||||
#define STAILQ_CLASS_ENTRY(type) \
|
||||
struct { \
|
||||
class type *stqe_next; /* next element */ \
|
||||
}
|
||||
|
||||
/*
|
||||
* Singly-linked Tail queue functions.
|
||||
*/
|
||||
@@ -311,9 +398,10 @@ struct { \
|
||||
(head)->stqh_last = &STAILQ_NEXT((elm), field); \
|
||||
} while (0)
|
||||
|
||||
#define STAILQ_LAST(head, type, field) \
|
||||
(STAILQ_EMPTY((head)) ? NULL : \
|
||||
__containerof((head)->stqh_last, struct type, field.stqe_next))
|
||||
#define STAILQ_LAST(head, type, field) \
|
||||
(STAILQ_EMPTY((head)) ? NULL : \
|
||||
__containerof((head)->stqh_last, \
|
||||
QUEUE_TYPEOF(type), field.stqe_next))
|
||||
|
||||
#define STAILQ_NEXT(elm, field) ((elm)->field.stqe_next)
|
||||
|
||||
@@ -323,7 +411,7 @@ struct { \
|
||||
STAILQ_REMOVE_HEAD((head), field); \
|
||||
} \
|
||||
else { \
|
||||
struct type *curelm = STAILQ_FIRST((head)); \
|
||||
QUEUE_TYPEOF(type) *curelm = STAILQ_FIRST(head); \
|
||||
while (STAILQ_NEXT(curelm, field) != (elm)) \
|
||||
curelm = STAILQ_NEXT(curelm, field); \
|
||||
STAILQ_REMOVE_AFTER(head, curelm, field); \
|
||||
@@ -344,8 +432,8 @@ struct { \
|
||||
} while (0)
|
||||
|
||||
#define STAILQ_SWAP(head1, head2, type) do { \
|
||||
struct type *swap_first = STAILQ_FIRST(head1); \
|
||||
struct type **swap_last = (head1)->stqh_last; \
|
||||
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; \
|
||||
@@ -356,6 +444,8 @@ struct { \
|
||||
(head2)->stqh_last = &STAILQ_FIRST(head2); \
|
||||
} while (0)
|
||||
|
||||
#define STAILQ_END(head) NULL
|
||||
|
||||
|
||||
/*
|
||||
* List declarations.
|
||||
@@ -365,6 +455,11 @@ 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 }
|
||||
|
||||
@@ -374,11 +469,23 @@ struct { \
|
||||
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 functions.
|
||||
*/
|
||||
|
||||
#if (defined(_KERNEL) && defined(INVARIANTS))
|
||||
/*
|
||||
* QMD_LIST_CHECK_HEAD(LIST_HEAD *head, LIST_ENTRY NAME)
|
||||
*
|
||||
* If the list is non-empty, validates that the first element of the list
|
||||
* points back at 'head.'
|
||||
*/
|
||||
#define QMD_LIST_CHECK_HEAD(head, field) do { \
|
||||
if (LIST_FIRST((head)) != NULL && \
|
||||
LIST_FIRST((head))->field.le_prev != \
|
||||
@@ -386,6 +493,12 @@ struct { \
|
||||
panic("Bad list head %p first->prev != head", (head)); \
|
||||
} while (0)
|
||||
|
||||
/*
|
||||
* QMD_LIST_CHECK_NEXT(TYPE *elm, LIST_ENTRY NAME)
|
||||
*
|
||||
* If an element follows 'elm' in the list, validates that the next element
|
||||
* points back at 'elm.'
|
||||
*/
|
||||
#define QMD_LIST_CHECK_NEXT(elm, field) do { \
|
||||
if (LIST_NEXT((elm), field) != NULL && \
|
||||
LIST_NEXT((elm), field)->field.le_prev != \
|
||||
@@ -393,6 +506,11 @@ struct { \
|
||||
panic("Bad link elm %p next->prev != elm", (elm)); \
|
||||
} while (0)
|
||||
|
||||
/*
|
||||
* QMD_LIST_CHECK_PREV(TYPE *elm, LIST_ENTRY NAME)
|
||||
*
|
||||
* Validates that the previous element (or head of the list) points to 'elm.'
|
||||
*/
|
||||
#define QMD_LIST_CHECK_PREV(elm, field) do { \
|
||||
if (*(elm)->field.le_prev != (elm)) \
|
||||
panic("Bad link elm %p prev->next != elm", (elm)); \
|
||||
@@ -403,6 +521,23 @@ struct { \
|
||||
#define QMD_LIST_CHECK_PREV(elm, field)
|
||||
#endif /* (_KERNEL && INVARIANTS) */
|
||||
|
||||
#define LIST_CONCAT(head1, head2, type, field) do { \
|
||||
QUEUE_TYPEOF(type) *curelm = LIST_FIRST(head1); \
|
||||
if (curelm == NULL) { \
|
||||
if ((LIST_FIRST(head1) = LIST_FIRST(head2)) != NULL) { \
|
||||
LIST_FIRST(head2)->field.le_prev = \
|
||||
&LIST_FIRST((head1)); \
|
||||
LIST_INIT(head2); \
|
||||
} \
|
||||
} else if (LIST_FIRST(head2) != NULL) { \
|
||||
while (LIST_NEXT(curelm, field) != NULL) \
|
||||
curelm = LIST_NEXT(curelm, field); \
|
||||
LIST_NEXT(curelm, field) = LIST_FIRST(head2); \
|
||||
LIST_FIRST(head2)->field.le_prev = &LIST_NEXT(curelm, field); \
|
||||
LIST_INIT(head2); \
|
||||
} \
|
||||
} while (0)
|
||||
|
||||
#define LIST_EMPTY(head) ((head)->lh_first == NULL)
|
||||
|
||||
#define LIST_FIRST(head) ((head)->lh_first)
|
||||
@@ -458,9 +593,10 @@ struct { \
|
||||
|
||||
#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, struct type, field.le_next))
|
||||
#define LIST_PREV(elm, head, type, field) \
|
||||
((elm)->field.le_prev == &LIST_FIRST((head)) ? NULL : \
|
||||
__containerof((elm)->field.le_prev, \
|
||||
QUEUE_TYPEOF(type), field.le_next))
|
||||
|
||||
#define LIST_REMOVE(elm, field) do { \
|
||||
QMD_SAVELINK(oldnext, (elm)->field.le_next); \
|
||||
@@ -476,7 +612,7 @@ struct { \
|
||||
} while (0)
|
||||
|
||||
#define LIST_SWAP(head1, head2, type, field) do { \
|
||||
struct type *swap_tmp = LIST_FIRST((head1)); \
|
||||
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) \
|
||||
@@ -485,6 +621,8 @@ struct { \
|
||||
swap_tmp->field.le_prev = &LIST_FIRST((head2)); \
|
||||
} while (0)
|
||||
|
||||
#define LIST_END(head) NULL
|
||||
|
||||
/*
|
||||
* Tail queue declarations.
|
||||
*/
|
||||
@@ -495,6 +633,13 @@ struct name { \
|
||||
TRACEBUF \
|
||||
}
|
||||
|
||||
#define TAILQ_CLASS_HEAD(name, type) \
|
||||
struct name { \
|
||||
class type *tqh_first; /* first element */ \
|
||||
class type **tqh_last; /* addr of last next element */ \
|
||||
TRACEBUF \
|
||||
}
|
||||
|
||||
#define TAILQ_HEAD_INITIALIZER(head) \
|
||||
{ NULL, &(head).tqh_first, TRACEBUF_INITIALIZER }
|
||||
|
||||
@@ -505,10 +650,23 @@ struct { \
|
||||
TRACEBUF \
|
||||
}
|
||||
|
||||
#define TAILQ_CLASS_ENTRY(type) \
|
||||
struct { \
|
||||
class type *tqe_next; /* next element */ \
|
||||
class type **tqe_prev; /* address of previous next element */ \
|
||||
TRACEBUF \
|
||||
}
|
||||
|
||||
/*
|
||||
* Tail queue functions.
|
||||
*/
|
||||
#if (defined(_KERNEL) && defined(INVARIANTS))
|
||||
/*
|
||||
* QMD_TAILQ_CHECK_HEAD(TAILQ_HEAD *head, TAILQ_ENTRY NAME)
|
||||
*
|
||||
* If the tailq is non-empty, validates that the first element of the tailq
|
||||
* points back at 'head.'
|
||||
*/
|
||||
#define QMD_TAILQ_CHECK_HEAD(head, field) do { \
|
||||
if (!TAILQ_EMPTY(head) && \
|
||||
TAILQ_FIRST((head))->field.tqe_prev != \
|
||||
@@ -516,11 +674,22 @@ struct { \
|
||||
panic("Bad tailq head %p first->prev != head", (head)); \
|
||||
} while (0)
|
||||
|
||||
/*
|
||||
* QMD_TAILQ_CHECK_TAIL(TAILQ_HEAD *head, TAILQ_ENTRY NAME)
|
||||
*
|
||||
* Validates that the tail of the tailq is a pointer to pointer to NULL.
|
||||
*/
|
||||
#define QMD_TAILQ_CHECK_TAIL(head, field) do { \
|
||||
if (*(head)->tqh_last != NULL) \
|
||||
panic("Bad tailq NEXT(%p->tqh_last) != NULL", (head)); \
|
||||
} while (0)
|
||||
|
||||
/*
|
||||
* QMD_TAILQ_CHECK_NEXT(TYPE *elm, TAILQ_ENTRY NAME)
|
||||
*
|
||||
* If an element follows 'elm' in the tailq, validates that the next element
|
||||
* points back at 'elm.'
|
||||
*/
|
||||
#define QMD_TAILQ_CHECK_NEXT(elm, field) do { \
|
||||
if (TAILQ_NEXT((elm), field) != NULL && \
|
||||
TAILQ_NEXT((elm), field)->field.tqe_prev != \
|
||||
@@ -528,6 +697,11 @@ struct { \
|
||||
panic("Bad link elm %p next->prev != elm", (elm)); \
|
||||
} while (0)
|
||||
|
||||
/*
|
||||
* QMD_TAILQ_CHECK_PREV(TYPE *elm, TAILQ_ENTRY NAME)
|
||||
*
|
||||
* Validates that the previous element (or head of the tailq) points to 'elm.'
|
||||
*/
|
||||
#define QMD_TAILQ_CHECK_PREV(elm, field) do { \
|
||||
if (*(elm)->field.tqe_prev != (elm)) \
|
||||
panic("Bad link elm %p prev->next != elm", (elm)); \
|
||||
@@ -612,7 +786,7 @@ struct { \
|
||||
TAILQ_NEXT((listelm), field) = (elm); \
|
||||
(elm)->field.tqe_prev = &TAILQ_NEXT((listelm), field); \
|
||||
QMD_TRACE_ELEM(&(elm)->field); \
|
||||
QMD_TRACE_ELEM(&listelm->field); \
|
||||
QMD_TRACE_ELEM(&(listelm)->field); \
|
||||
} while (0)
|
||||
|
||||
#define TAILQ_INSERT_BEFORE(listelm, elm, field) do { \
|
||||
@@ -622,7 +796,7 @@ struct { \
|
||||
*(listelm)->field.tqe_prev = (elm); \
|
||||
(listelm)->field.tqe_prev = &TAILQ_NEXT((elm), field); \
|
||||
QMD_TRACE_ELEM(&(elm)->field); \
|
||||
QMD_TRACE_ELEM(&listelm->field); \
|
||||
QMD_TRACE_ELEM(&(listelm)->field); \
|
||||
} while (0)
|
||||
|
||||
#define TAILQ_INSERT_HEAD(head, elm, field) do { \
|
||||
@@ -651,11 +825,25 @@ struct { \
|
||||
#define TAILQ_LAST(head, headname) \
|
||||
(*(((struct headname *)((head)->tqh_last))->tqh_last))
|
||||
|
||||
/*
|
||||
* The FAST function is fast in that it causes no data access other
|
||||
* then the access to the head. The standard LAST function above
|
||||
* will cause a data access of both the element you want and
|
||||
* the previous element. FAST is very useful for instances when
|
||||
* you may want to prefetch the last data element.
|
||||
*/
|
||||
#define TAILQ_LAST_FAST(head, type, field) \
|
||||
(TAILQ_EMPTY(head) ? NULL : __containerof((head)->tqh_last, QUEUE_TYPEOF(type), field.tqe_next))
|
||||
|
||||
#define TAILQ_NEXT(elm, field) ((elm)->field.tqe_next)
|
||||
|
||||
#define TAILQ_PREV(elm, headname, field) \
|
||||
(*(((struct headname *)((elm)->field.tqe_prev))->tqh_last))
|
||||
|
||||
#define TAILQ_PREV_FAST(elm, head, type, field) \
|
||||
((elm)->field.tqe_prev == &(head)->tqh_first ? NULL : \
|
||||
__containerof((elm)->field.tqe_prev, QUEUE_TYPEOF(type), field.tqe_next))
|
||||
|
||||
#define TAILQ_REMOVE(head, elm, field) do { \
|
||||
QMD_SAVELINK(oldnext, (elm)->field.tqe_next); \
|
||||
QMD_SAVELINK(oldprev, (elm)->field.tqe_prev); \
|
||||
@@ -675,8 +863,8 @@ struct { \
|
||||
} while (0)
|
||||
|
||||
#define TAILQ_SWAP(head1, head2, type, field) do { \
|
||||
struct type *swap_first = (head1)->tqh_first; \
|
||||
struct type **swap_last = (head1)->tqh_last; \
|
||||
QUEUE_TYPEOF(type) *swap_first = (head1)->tqh_first; \
|
||||
QUEUE_TYPEOF(type) **swap_last = (head1)->tqh_last; \
|
||||
(head1)->tqh_first = (head2)->tqh_first; \
|
||||
(head1)->tqh_last = (head2)->tqh_last; \
|
||||
(head2)->tqh_first = swap_first; \
|
||||
@@ -691,4 +879,6 @@ struct { \
|
||||
(head2)->tqh_last = &(head2)->tqh_first; \
|
||||
} while (0)
|
||||
|
||||
#define TAILQ_END(head) NULL
|
||||
|
||||
#endif /* !LIBBSD_SYS_QUEUE_H */
|
||||
|
@@ -33,10 +33,16 @@
|
||||
*/
|
||||
|
||||
#ifdef LIBBSD_OVERLAY
|
||||
#include <sys/cdefs.h>
|
||||
#if __has_include_next(<sys/time.h>)
|
||||
#include_next <sys/time.h>
|
||||
#endif
|
||||
#else
|
||||
#include <bsd/sys/cdefs.h>
|
||||
#if __has_include(<sys/time.h>)
|
||||
#include <sys/time.h>
|
||||
#endif
|
||||
#endif
|
||||
|
||||
#ifndef LIBBSD_SYS_TIME_H
|
||||
#define LIBBSD_SYS_TIME_H
|
||||
|
@@ -30,7 +30,11 @@
|
||||
#ifndef LIBBSD_SYS_TREE_H
|
||||
#define LIBBSD_SYS_TREE_H
|
||||
|
||||
#ifdef LIBBSD_OVERLAY
|
||||
#include <sys/cdefs.h>
|
||||
#else
|
||||
#include <bsd/sys/cdefs.h>
|
||||
#endif
|
||||
|
||||
/*
|
||||
* This file defines data structures for different types of trees:
|
||||
|
@@ -41,7 +41,11 @@
|
||||
#ifndef LIBBSD_TIMECONV_H
|
||||
#define LIBBSD_TIMECONV_H
|
||||
|
||||
#ifdef LIBBSD_OVERLAY
|
||||
#include <sys/cdefs.h>
|
||||
#else
|
||||
#include <bsd/sys/cdefs.h>
|
||||
#endif
|
||||
#include <stdint.h>
|
||||
#include <time.h>
|
||||
|
||||
|
@@ -26,22 +26,23 @@
|
||||
*/
|
||||
|
||||
#ifdef LIBBSD_OVERLAY
|
||||
#include <sys/cdefs.h>
|
||||
#if __has_include_next(<unistd.h>)
|
||||
#include_next <unistd.h>
|
||||
#endif
|
||||
#else
|
||||
#include <bsd/sys/cdefs.h>
|
||||
#if __has_include(<unistd.h>)
|
||||
#include <unistd.h>
|
||||
#endif
|
||||
#endif
|
||||
|
||||
#ifndef LIBBSD_UNISTD_H
|
||||
#define LIBBSD_UNISTD_H
|
||||
|
||||
#ifdef LIBBSD_OVERLAY
|
||||
#include <sys/cdefs.h>
|
||||
#else
|
||||
#include <bsd/sys/cdefs.h>
|
||||
#endif
|
||||
#include <sys/stat.h>
|
||||
|
||||
#ifndef S_ISTXT
|
||||
#if !defined(S_ISTXT) && defined(S_ISVTX)
|
||||
#define S_ISTXT S_ISVTX
|
||||
#endif
|
||||
|
||||
|
@@ -1,3 +1,5 @@
|
||||
/* $NetBSD: vis.h,v 1.25 2017/04/23 01:57:36 christos Exp $ */
|
||||
|
||||
/*-
|
||||
* Copyright (c) 1990, 1993
|
||||
* The Regents of the University of California. All rights reserved.
|
||||
@@ -27,7 +29,6 @@
|
||||
* SUCH DAMAGE.
|
||||
*
|
||||
* @(#)vis.h 8.1 (Berkeley) 6/2/93
|
||||
* $FreeBSD: src/include/vis.h,v 1.11 2003/10/30 10:40:49 phk Exp $
|
||||
*/
|
||||
|
||||
#ifndef LIBBSD_VIS_H
|
||||
@@ -38,25 +39,34 @@
|
||||
/*
|
||||
* to select alternate encoding format
|
||||
*/
|
||||
#define VIS_OCTAL 0x01 /* use octal \ddd format */
|
||||
#define VIS_CSTYLE 0x02 /* use \[nrft0..] where appropriate */
|
||||
#define VIS_OCTAL 0x0001 /* use octal \ddd format */
|
||||
#define VIS_CSTYLE 0x0002 /* use \[nrft0..] where appropriate */
|
||||
|
||||
/*
|
||||
* to alter set of characters encoded (default is to encode all
|
||||
* non-graphic except space, tab, and newline).
|
||||
*/
|
||||
#define VIS_SP 0x04 /* also encode space */
|
||||
#define VIS_TAB 0x08 /* also encode tab */
|
||||
#define VIS_NL 0x10 /* also encode newline */
|
||||
#define VIS_SP 0x0004 /* also encode space */
|
||||
#define VIS_TAB 0x0008 /* also encode tab */
|
||||
#define VIS_NL 0x0010 /* also encode newline */
|
||||
#define VIS_WHITE (VIS_SP | VIS_TAB | VIS_NL)
|
||||
#define VIS_SAFE 0x20 /* only encode "unsafe" characters */
|
||||
#define VIS_SAFE 0x0020 /* only encode "unsafe" characters */
|
||||
#define VIS_DQ 0x8000 /* also encode double quotes */
|
||||
|
||||
/*
|
||||
* other
|
||||
*/
|
||||
#define VIS_NOSLASH 0x40 /* inhibit printing '\' */
|
||||
#define VIS_HTTPSTYLE 0x80 /* http-style escape % HEX HEX */
|
||||
#define VIS_GLOB 0x100 /* encode glob(3) magics */
|
||||
#define VIS_NOSLASH 0x0040 /* inhibit printing '\' */
|
||||
#define VIS_HTTP1808 0x0080 /* http-style escape % hex hex */
|
||||
#define VIS_HTTPSTYLE 0x0080 /* http-style escape % hex hex */
|
||||
#define VIS_MIMESTYLE 0x0100 /* mime-style escape = HEX HEX */
|
||||
#define VIS_HTTP1866 0x0200 /* http-style &#num; or &string; */
|
||||
#define VIS_NOESCAPE 0x0400 /* don't decode `\' */
|
||||
#define _VIS_END 0x0800 /* for unvis */
|
||||
#define VIS_GLOB 0x1000 /* encode glob(3) magic characters */
|
||||
#define VIS_SHELL 0x2000 /* encode shell special characters [not glob] */
|
||||
#define VIS_META (VIS_WHITE | VIS_GLOB | VIS_SHELL)
|
||||
#define VIS_NOLOCALE 0x4000 /* encode using the C locale */
|
||||
|
||||
/*
|
||||
* unvis return codes
|
||||
@@ -70,18 +80,76 @@
|
||||
/*
|
||||
* unvis flags
|
||||
*/
|
||||
#define UNVIS_END 1 /* no more characters */
|
||||
#define UNVIS_END _VIS_END /* no more characters */
|
||||
|
||||
#ifdef LIBBSD_OVERLAY
|
||||
#include <sys/cdefs.h>
|
||||
#else
|
||||
#include <bsd/sys/cdefs.h>
|
||||
#endif
|
||||
|
||||
/*
|
||||
* NetBSD added an strnvis and unfortunately made it incompatible with the
|
||||
* existing one in OpenBSD and Freedesktop's libbsd (the former having existed
|
||||
* for over ten years). Despite this incompatibility being reported during
|
||||
* development (see http://gnats.netbsd.org/44977) they still shipped it.
|
||||
* Even more unfortunately FreeBSD and later MacOS picked up this incompatible
|
||||
* implementation.
|
||||
*
|
||||
* Provide both implementations and default for now on the historical one to
|
||||
* avoid breakage, we will switch to the NetBSD one in libbsd 0.10.0 or so.
|
||||
* Define LIBBSD_NETBSD_VIS to switch to the NetBSD one now.
|
||||
* Define LIBBSD_OPENBSD_VIS to keep using the OpenBSD one.
|
||||
*/
|
||||
#if defined(LIBBSD_OPENBSD_VIS)
|
||||
#undef LIBBSD_NETBSD_VIS
|
||||
#elif !defined(LIBBSD_NETBSD_VIS)
|
||||
#warning "NetBSD added incompatible strnvis() and strnunvis(), please see <bsd/vis.h> for more detils."
|
||||
#endif
|
||||
|
||||
__BEGIN_DECLS
|
||||
char *vis(char *, int, int, int);
|
||||
char *nvis(char *, size_t, int, int, int);
|
||||
|
||||
char *svis(char *, int, int, int, const char *);
|
||||
char *snvis(char *, size_t, int, int, int, const char *);
|
||||
|
||||
int strvis(char *, const char *, int);
|
||||
int strvisx(char *, const char *, size_t, int);
|
||||
int stravis(char **, const char *, int);
|
||||
#ifdef LIBBSD_NETBSD_VIS
|
||||
/* NetBSD prototype. */
|
||||
int LIBBSD_REDIRECT(strnvis, (char *, size_t, const char *, int),
|
||||
strnvis_netbsd);
|
||||
#else
|
||||
/* OpenBSD prototype (current default). */
|
||||
int strnvis(char *, const char *, size_t, int);
|
||||
#endif
|
||||
|
||||
int strsvis(char *, const char *, int, const char *);
|
||||
int strsnvis(char *, size_t, const char *, int, const char *);
|
||||
|
||||
int strvisx(char *, const char *, size_t, int);
|
||||
int strnvisx(char *, size_t, const char *, size_t, int);
|
||||
int strenvisx(char *, size_t, const char *, size_t, int, int *);
|
||||
|
||||
int strsvisx(char *, const char *, size_t, int, const char *);
|
||||
int strsnvisx(char *, size_t, const char *, size_t, int, const char *);
|
||||
int strsenvisx(char *, size_t, const char *, size_t , int, const char *,
|
||||
int *);
|
||||
|
||||
int strunvis(char *, const char *);
|
||||
#ifdef LIBBSD_NETBSD_VIS
|
||||
/* NetBSD prototype. */
|
||||
int LIBBSD_REDIRECT(strnunvis, (char *, size_t, const char *),
|
||||
strnunvis_netbsd);
|
||||
#else
|
||||
/* OpenBSD prototype (current default). */
|
||||
ssize_t strnunvis(char *, const char *, size_t);
|
||||
#endif
|
||||
|
||||
int strunvisx(char *, const char *, int);
|
||||
ssize_t strnunvis(char *, const char *, size_t);
|
||||
int strnunvisx(char *, size_t, const char *, int);
|
||||
|
||||
int unvis(char *, int, int *, int);
|
||||
__END_DECLS
|
||||
|
||||
|
@@ -40,7 +40,11 @@
|
||||
#define LIBBSD_WCHAR_H
|
||||
|
||||
#include <stddef.h>
|
||||
#ifdef LIBBSD_OVERLAY
|
||||
#include <sys/cdefs.h>
|
||||
#else
|
||||
#include <bsd/sys/cdefs.h>
|
||||
#endif
|
||||
#include <sys/types.h>
|
||||
|
||||
__BEGIN_DECLS
|
||||
|
2
m4/.gitignore
vendored
Normal file
2
m4/.gitignore
vendored
Normal file
@@ -0,0 +1,2 @@
|
||||
*.m4
|
||||
!libbsd*.m4
|
24
m4/libbsd-compiler.m4
Normal file
24
m4/libbsd-compiler.m4
Normal file
@@ -0,0 +1,24 @@
|
||||
# Copyright © 2021 Guillem Jover <guillem@hadrons.org>
|
||||
|
||||
# LIBBSD_CHECK_COMPILER_FLAG
|
||||
# -------------------------
|
||||
AC_DEFUN([LIBBSD_CHECK_COMPILER_FLAG], [
|
||||
AS_VAR_PUSHDEF([libbsd_varname_cache], [libbsd_cv_cflags_$1])
|
||||
AC_CACHE_CHECK([whether $CC accepts $1], [libbsd_varname_cache], [
|
||||
m4_define([libbsd_check_flag], m4_bpatsubst([$1], [^-Wno-], [-W]))
|
||||
AS_VAR_COPY([libbsd_save_CFLAGS], [CFLAGS])
|
||||
AS_VAR_SET([CFLAGS], ["-Werror libbsd_check_flag"])
|
||||
AC_COMPILE_IFELSE([
|
||||
AC_LANG_SOURCE([[]])
|
||||
], [
|
||||
AS_VAR_SET([libbsd_varname_cache], [yes])
|
||||
], [
|
||||
AS_VAR_SET([libbsd_varname_cache], [no])
|
||||
])
|
||||
AS_VAR_COPY([CFLAGS], [libbsd_save_CFLAGS])
|
||||
])
|
||||
AS_VAR_IF([libbsd_varname_cache], [yes], [
|
||||
AS_VAR_APPEND([LIBBSD_COMPILER_FLAGS], [" $1"])
|
||||
])
|
||||
AS_VAR_POPDEF([libbsd_varname_cache])
|
||||
])
|
1
man/LIST_CLASS_ENTRY.3bsd
Normal file
1
man/LIST_CLASS_ENTRY.3bsd
Normal file
@@ -0,0 +1 @@
|
||||
.so man3/queue.3bsd
|
1
man/LIST_CLASS_HEAD.3bsd
Normal file
1
man/LIST_CLASS_HEAD.3bsd
Normal file
@@ -0,0 +1 @@
|
||||
.so man3/queue.3bsd
|
@@ -11,9 +11,11 @@ CLEANFILES = \
|
||||
SED_MD5_SUBST = -e 's/mdX/md5/g' -e 's/mdY/md4/g' -e 's/MDX/MD5/g'
|
||||
|
||||
md5.3bsd: $(srcdir)/mdX.3bsd
|
||||
$(AM_V_GEN) sed $(SED_MD5_SUBST) $< > $@
|
||||
$(AM_V_GEN) $(SED) $(SED_MD5_SUBST) $< > $@
|
||||
|
||||
dist_man_MANS = \
|
||||
LIST_CLASS_ENTRY.3bsd \
|
||||
LIST_CLASS_HEAD.3bsd \
|
||||
LIST_EMPTY.3bsd \
|
||||
LIST_ENTRY.3bsd \
|
||||
LIST_FIRST.3bsd \
|
||||
@@ -54,6 +56,8 @@ dist_man_MANS = \
|
||||
RB_REMOVE.3bsd \
|
||||
RB_RIGHT.3bsd \
|
||||
RB_ROOT.3bsd \
|
||||
SLIST_CLASS_ENTRY.3bsd \
|
||||
SLIST_CLASS_HEAD.3bsd \
|
||||
SLIST_EMPTY.3bsd \
|
||||
SLIST_ENTRY.3bsd \
|
||||
SLIST_FIRST.3bsd \
|
||||
@@ -70,6 +74,7 @@ dist_man_MANS = \
|
||||
SLIST_REMOVE.3bsd \
|
||||
SLIST_REMOVE_AFTER.3bsd \
|
||||
SLIST_REMOVE_HEAD.3bsd \
|
||||
SLIST_REMOVE_PREVPTR.3bsd \
|
||||
SLIST_SWAP.3bsd \
|
||||
SPLAY_EMPTY.3bsd \
|
||||
SPLAY_ENTRY.3bsd \
|
||||
@@ -88,6 +93,8 @@ dist_man_MANS = \
|
||||
SPLAY_REMOVE.3bsd \
|
||||
SPLAY_RIGHT.3bsd \
|
||||
SPLAY_ROOT.3bsd \
|
||||
STAILQ_CLASS_ENTRY.3bsd \
|
||||
STAILQ_CLASS_HEAD.3bsd \
|
||||
STAILQ_CONCAT.3bsd \
|
||||
STAILQ_EMPTY.3bsd \
|
||||
STAILQ_ENTRY.3bsd \
|
||||
@@ -108,6 +115,8 @@ dist_man_MANS = \
|
||||
STAILQ_REMOVE_AFTER.3bsd \
|
||||
STAILQ_REMOVE_HEAD.3bsd \
|
||||
STAILQ_SWAP.3bsd \
|
||||
TAILQ_CLASS_ENTRY.3bsd \
|
||||
TAILQ_CLASS_HEAD.3bsd \
|
||||
TAILQ_CONCAT.3bsd \
|
||||
TAILQ_EMPTY.3bsd \
|
||||
TAILQ_ENTRY.3bsd \
|
||||
@@ -165,6 +174,7 @@ dist_man_MANS = \
|
||||
fgetln.3bsd \
|
||||
fgetwln.3bsd \
|
||||
flopen.3bsd \
|
||||
freezero.3bsd \
|
||||
fmtcheck.3bsd \
|
||||
fparseln.3bsd \
|
||||
fpurge.3bsd \
|
||||
@@ -173,6 +183,8 @@ dist_man_MANS = \
|
||||
getmode.3bsd \
|
||||
getpeereid.3bsd \
|
||||
getprogname.3bsd \
|
||||
gid_from_group.3bsd \
|
||||
group_from_gid.3bsd \
|
||||
heapsort.3bsd \
|
||||
humanize_number.3bsd \
|
||||
le16dec.3bsd \
|
||||
@@ -190,11 +202,13 @@ dist_man_MANS = \
|
||||
pidfile_open.3bsd \
|
||||
pidfile_remove.3bsd \
|
||||
pidfile_write.3bsd \
|
||||
pwcache.3bsd \
|
||||
queue.3bsd \
|
||||
radixsort.3bsd \
|
||||
readpassphrase.3bsd \
|
||||
reallocarray.3bsd \
|
||||
reallocf.3bsd \
|
||||
recallocarray.3bsd \
|
||||
setmode.3bsd \
|
||||
setproctitle.3bsd \
|
||||
setproctitle_init.3bsd \
|
||||
@@ -212,7 +226,9 @@ dist_man_MANS = \
|
||||
strnstr.3bsd \
|
||||
strnunvis.3bsd \
|
||||
strnvis.3bsd \
|
||||
strtoi.3bsd \
|
||||
strtonum.3bsd \
|
||||
strtou.3bsd \
|
||||
strunvis.3bsd \
|
||||
strvis.3bsd \
|
||||
strvisx.3bsd \
|
||||
@@ -221,6 +237,7 @@ dist_man_MANS = \
|
||||
timercmp.3bsd \
|
||||
timerisset.3bsd \
|
||||
timersub.3bsd \
|
||||
timespec.3bsd \
|
||||
timespecadd.3bsd \
|
||||
timespecclear.3bsd \
|
||||
timespeccmp.3bsd \
|
||||
@@ -228,7 +245,9 @@ dist_man_MANS = \
|
||||
timespecsub.3bsd \
|
||||
timeval.3bsd \
|
||||
tree.3bsd \
|
||||
uid_from_user.3bsd \
|
||||
unvis.3bsd \
|
||||
user_from_uid.3bsd \
|
||||
vis.3bsd \
|
||||
wcslcat.3bsd \
|
||||
wcslcpy.3bsd \
|
||||
|
1
man/SLIST_CLASS_ENTRY.3bsd
Normal file
1
man/SLIST_CLASS_ENTRY.3bsd
Normal file
@@ -0,0 +1 @@
|
||||
.so man3/queue.3bsd
|
1
man/SLIST_CLASS_HEAD.3bsd
Normal file
1
man/SLIST_CLASS_HEAD.3bsd
Normal file
@@ -0,0 +1 @@
|
||||
.so man3/queue.3bsd
|
1
man/SLIST_REMOVE_PREVPTR.3bsd
Normal file
1
man/SLIST_REMOVE_PREVPTR.3bsd
Normal file
@@ -0,0 +1 @@
|
||||
.so man3/queue.3bsd
|
1
man/STAILQ_CLASS_ENTRY.3bsd
Normal file
1
man/STAILQ_CLASS_ENTRY.3bsd
Normal file
@@ -0,0 +1 @@
|
||||
.so man3/queue.3bsd
|
1
man/STAILQ_CLASS_HEAD.3bsd
Normal file
1
man/STAILQ_CLASS_HEAD.3bsd
Normal file
@@ -0,0 +1 @@
|
||||
.so man3/queue.3bsd
|
1
man/TAILQ_CLASS_ENTRY.3bsd
Normal file
1
man/TAILQ_CLASS_ENTRY.3bsd
Normal file
@@ -0,0 +1 @@
|
||||
.so man3/queue.3bsd
|
1
man/TAILQ_CLASS_HEAD.3bsd
Normal file
1
man/TAILQ_CLASS_HEAD.3bsd
Normal file
@@ -0,0 +1 @@
|
||||
.so man3/queue.3bsd
|
@@ -42,6 +42,7 @@
|
||||
.Nd arc4 random number generator
|
||||
.Sh LIBRARY
|
||||
.ds str-Lb-libbsd Utility functions from BSD systems (libbsd, \-lbsd)
|
||||
.ds doc-str-Lb-libbsd \*[str-Lb-libbsd]
|
||||
.Lb libbsd
|
||||
.Sh SYNOPSIS
|
||||
.In stdlib.h
|
||||
|
@@ -44,6 +44,10 @@
|
||||
.Nm bitstr_size ,
|
||||
.Nm bit_test
|
||||
.Nd bit-string manipulation macros
|
||||
.Sh LIBRARY
|
||||
.ds str-Lb-libbsd Utility functions from BSD systems (libbsd, \-lbsd)
|
||||
.ds doc-str-Lb-libbsd \*[str-Lb-libbsd]
|
||||
.Lb libbsd
|
||||
.Sh SYNOPSIS
|
||||
.In bitstring.h
|
||||
(See
|
||||
|
@@ -31,6 +31,10 @@
|
||||
.Nm be16enc , be16dec , be32enc , be32dec , be64enc , be64dec ,
|
||||
.Nm le16enc , le16dec , le32enc , le32dec , le64enc , le64dec
|
||||
.Nd byte order operations
|
||||
.Sh LIBRARY
|
||||
.ds str-Lb-libbsd Utility functions from BSD systems (libbsd, \-lbsd)
|
||||
.ds doc-str-Lb-libbsd \*[str-Lb-libbsd]
|
||||
.Lb libbsd
|
||||
.Sh SYNOPSIS
|
||||
.In sys/endian.h
|
||||
(See
|
||||
|
@@ -33,6 +33,7 @@
|
||||
.Nd delete open file descriptors
|
||||
.Sh LIBRARY
|
||||
.ds str-Lb-libbsd Utility functions from BSD systems (libbsd, \-lbsd)
|
||||
.ds doc-str-Lb-libbsd \*[str-Lb-libbsd]
|
||||
.Lb libbsd
|
||||
.Sh SYNOPSIS
|
||||
.In unistd.h
|
||||
|
@@ -38,6 +38,7 @@
|
||||
.Nd formatted error messages
|
||||
.Sh LIBRARY
|
||||
.ds str-Lb-libbsd Utility functions from BSD systems (libbsd, \-lbsd)
|
||||
.ds doc-str-Lb-libbsd \*[str-Lb-libbsd]
|
||||
.Lb libbsd
|
||||
.Sh SYNOPSIS
|
||||
.In err.h
|
||||
@@ -144,6 +145,7 @@ if ((fd = open(block_device, O_RDONLY, 0)) == -1)
|
||||
.Xr printf 3 ,
|
||||
.Xr strerror 3
|
||||
.Sh HISTORY
|
||||
.ds doc-operating-system-NetBSD-7.0 7.0
|
||||
The functions
|
||||
.Fn errc ,
|
||||
.Fn verrc ,
|
||||
|
@@ -33,6 +33,7 @@
|
||||
.Nd format a number from human readable form
|
||||
.Sh LIBRARY
|
||||
.ds str-Lb-libbsd Utility functions from BSD systems (libbsd, \-lbsd)
|
||||
.ds doc-str-Lb-libbsd \*[str-Lb-libbsd]
|
||||
.Lb libbsd
|
||||
.Sh SYNOPSIS
|
||||
.In libutil.h
|
||||
|
@@ -37,6 +37,7 @@
|
||||
.Nd write zeroes to a byte string
|
||||
.Sh LIBRARY
|
||||
.ds str-Lb-libbsd Utility functions from BSD systems (libbsd, \-lbsd)
|
||||
.ds doc-str-Lb-libbsd \*[str-Lb-libbsd]
|
||||
.Lb libbsd
|
||||
.Sh SYNOPSIS
|
||||
.In string.h
|
||||
|
@@ -36,6 +36,7 @@
|
||||
.Nd get a line from a stream
|
||||
.Sh LIBRARY
|
||||
.ds str-Lb-libbsd Utility functions from BSD systems (libbsd, \-lbsd)
|
||||
.ds doc-str-Lb-libbsd \*[str-Lb-libbsd]
|
||||
.Lb libbsd
|
||||
.Sh SYNOPSIS
|
||||
.In stdio.h
|
||||
|
@@ -36,6 +36,7 @@
|
||||
.Nd get a line of wide characters from a stream
|
||||
.Sh LIBRARY
|
||||
.ds str-Lb-libbsd Utility functions from BSD systems (libbsd, \-lbsd)
|
||||
.ds doc-str-Lb-libbsd \*[str-Lb-libbsd]
|
||||
.Lb libbsd
|
||||
.Sh SYNOPSIS
|
||||
.In stdio.h
|
||||
|
@@ -25,14 +25,16 @@
|
||||
.\"
|
||||
.\" $FreeBSD$
|
||||
.\"
|
||||
.Dd June 6, 2009
|
||||
.Dd July 28, 2017
|
||||
.Dt FLOPEN 3bsd
|
||||
.Os
|
||||
.Sh NAME
|
||||
.Nm flopen
|
||||
.Nd reliably open and lock a file
|
||||
.Nm flopen ,
|
||||
.Nm flopenat
|
||||
.Nd "Reliably open and lock a file"
|
||||
.Sh LIBRARY
|
||||
.ds str-Lb-libbsd Utility functions from BSD systems (libbsd, \-lbsd)
|
||||
.ds doc-str-Lb-libbsd \*[str-Lb-libbsd]
|
||||
.Lb libbsd
|
||||
.Sh SYNOPSIS
|
||||
.In sys/fcntl.h
|
||||
@@ -44,6 +46,10 @@ for include usage.)
|
||||
.Fn flopen "const char *path" "int flags"
|
||||
.Ft int
|
||||
.Fn flopen "const char *path" "int flags" "mode_t mode"
|
||||
.Ft int
|
||||
.Fn flopenat "int fd" "const char *path" "int flags"
|
||||
.Ft int
|
||||
.Fn flopenat "int fd" "const char *path" "int flags" "mode_t mode"
|
||||
.Sh DESCRIPTION
|
||||
The
|
||||
.Fn flopen
|
||||
@@ -53,7 +59,7 @@ It is essentially equivalent with calling
|
||||
with the same parameters followed by
|
||||
.Fn flock
|
||||
with an
|
||||
.Va operation
|
||||
.Fa operation
|
||||
argument of
|
||||
.Dv LOCK_EX ,
|
||||
except that
|
||||
@@ -65,7 +71,7 @@ files, mailboxes and other kinds of files which are used for
|
||||
synchronization between processes.
|
||||
.Pp
|
||||
If
|
||||
.Va flags
|
||||
.Fa flags
|
||||
includes
|
||||
.Dv O_NONBLOCK
|
||||
and the file is already locked,
|
||||
@@ -78,11 +84,32 @@ to
|
||||
As with
|
||||
.Fn open ,
|
||||
the additional
|
||||
.Va mode
|
||||
.Fa mode
|
||||
argument is required if
|
||||
.Va flags
|
||||
.Fa flags
|
||||
includes
|
||||
.Dv O_CREAT .
|
||||
.Pp
|
||||
The
|
||||
.Fn flopenat
|
||||
function is equivalent to the
|
||||
.Fn flopen
|
||||
function except in the case where the
|
||||
.Fa path
|
||||
specifies a relative path.
|
||||
In this case the file to be opened is determined relative to the directory
|
||||
associated with the file descriptor
|
||||
.Fa fd
|
||||
instead of the current working directory.
|
||||
If
|
||||
.Fn flopenat
|
||||
is passed the special value
|
||||
.Dv AT_FDCWD
|
||||
in the
|
||||
.Fa fd
|
||||
parameter, the current working directory is used
|
||||
and the behavior is identical to a call to
|
||||
.Fn flopen .
|
||||
.Sh RETURN VALUES
|
||||
If successful,
|
||||
.Fn flopen
|
||||
@@ -102,4 +129,4 @@ and
|
||||
The
|
||||
.Nm
|
||||
function and this manual page were written by
|
||||
.An Dag-Erling Sm\(/orgrav Aq des@FreeBSD.org .
|
||||
.An Dag-Erling Sm\(/orgrav Aq Mt des@FreeBSD.org .
|
||||
|
@@ -1,3 +1,5 @@
|
||||
.\" $NetBSD: fmtcheck.3,v 1.8 2014/06/14 08:18:24 apb Exp $
|
||||
.\"
|
||||
.\" Copyright (c) 2000 The NetBSD Foundation, Inc.
|
||||
.\" All rights reserved.
|
||||
.\"
|
||||
@@ -24,17 +26,15 @@
|
||||
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
||||
.\" POSSIBILITY OF SUCH DAMAGE.
|
||||
.\"
|
||||
.\" $FreeBSD: /repoman/r/ncvs/src/lib/libc/gen/fmtcheck.3,v 1.9 2004/07/02 23:52:10 ru Exp $
|
||||
.Dd October 16, 2002
|
||||
.Os
|
||||
.Dd June 14, 2014
|
||||
.Dt FMTCHECK 3bsd
|
||||
.Os
|
||||
.Sh NAME
|
||||
.Nm fmtcheck
|
||||
.Nd sanitizes user-supplied
|
||||
.Xr printf 3 Ns -style
|
||||
format string
|
||||
.Nd sanitizes user-supplied printf(3)-style format string
|
||||
.Sh LIBRARY
|
||||
.ds str-Lb-libbsd Utility functions from BSD systems (libbsd, \-lbsd)
|
||||
.ds doc-str-Lb-libbsd \*[str-Lb-libbsd]
|
||||
.Lb libbsd
|
||||
.Sh SYNOPSIS
|
||||
.In stdio.h
|
||||
@@ -45,8 +45,8 @@ for include usage.)
|
||||
.Fn fmtcheck "const char *fmt_suspect" "const char *fmt_default"
|
||||
.Sh DESCRIPTION
|
||||
The
|
||||
.Fn fmtcheck
|
||||
scans
|
||||
.Nm
|
||||
function scans
|
||||
.Fa fmt_suspect
|
||||
and
|
||||
.Fa fmt_default
|
||||
@@ -60,55 +60,45 @@ is a valid format string.
|
||||
.Pp
|
||||
The
|
||||
.Xr printf 3
|
||||
family of functions cannot verify the types of arguments that they are
|
||||
family of functions can not verify the types of arguments that they are
|
||||
passed at run-time.
|
||||
In some cases, like
|
||||
.Xr catgets 3 ,
|
||||
it is useful or necessary to use a user-supplied format string with no
|
||||
guarantee that the format string matches the specified arguments.
|
||||
guarantee that the format string matches the specified parameters.
|
||||
.Pp
|
||||
The
|
||||
.Fn fmtcheck
|
||||
was designed to be used in these cases, as in:
|
||||
.Nm
|
||||
function was designed to be used in these cases, as in:
|
||||
.Bd -literal -offset indent
|
||||
printf(fmtcheck(user_format, standard_format), arg1, arg2);
|
||||
.Ed
|
||||
.Pp
|
||||
In the check, field widths, fillers, precisions, etc.\& are ignored (unless
|
||||
In the check, field widths, fillers, precisions, etc. are ignored (unless
|
||||
the field width or precision is an asterisk
|
||||
.Ql *
|
||||
instead of a digit string).
|
||||
Also, any text other than the format specifiers
|
||||
is completely ignored.
|
||||
Also, any text other than the format specifiers is completely ignored.
|
||||
.Pp
|
||||
Note that the formats may be quite different as long as they accept the
|
||||
same parameters.
|
||||
For example, "%ld %o %30s %#llx %-10.*e %n" is
|
||||
compatible with "This number %lu %d%% and string %s has %qd numbers
|
||||
and %.*g floats (%n)."
|
||||
However, "%o" is not equivalent to "%lx" because
|
||||
the first requires an integer and the second requires a long,
|
||||
and "%p" is not equivalent to "%lu" because
|
||||
the first requires a pointer and the second requires a long.
|
||||
.Sh RETURN VALUES
|
||||
If
|
||||
.Fa fmt_suspect
|
||||
is a valid format and consumes the same argument types as
|
||||
.Fa fmt_default ,
|
||||
then the
|
||||
.Fn fmtcheck
|
||||
will return
|
||||
.Nm
|
||||
function will return
|
||||
.Fa fmt_suspect .
|
||||
Otherwise, it will return
|
||||
.Fa fmt_default .
|
||||
.Sh SECURITY CONSIDERATIONS
|
||||
Note that the formats may be quite different as long as they accept the
|
||||
same arguments.
|
||||
For example,
|
||||
.Qq Li "%p %o %30s %#llx %-10.*e %n"
|
||||
is compatible with
|
||||
.Qq Li "This number %lu %d%% and string %s has %qd numbers and %.*g floats (%n)" .
|
||||
However,
|
||||
.Qq Li %o
|
||||
is not equivalent to
|
||||
.Qq Li %lx
|
||||
because
|
||||
the first requires an integer and the second requires a long.
|
||||
.Sh SEE ALSO
|
||||
.Xr printf 3
|
||||
.Sh BUGS
|
||||
The
|
||||
.Fn fmtcheck
|
||||
function does not understand all of the conversions that
|
||||
.Xr printf 3
|
||||
does.
|
||||
|
@@ -30,6 +30,7 @@
|
||||
.Nd return the next logical line from a stream
|
||||
.Sh LIBRARY
|
||||
.ds str-Lb-libbsd Utility functions from BSD systems (libbsd, \-lbsd)
|
||||
.ds doc-str-Lb-libbsd \*[str-Lb-libbsd]
|
||||
.Lb libbsd
|
||||
.Sh SYNOPSIS
|
||||
.In stdio.h
|
||||
|
@@ -39,6 +39,7 @@
|
||||
.Nd flush a stream
|
||||
.Sh LIBRARY
|
||||
.ds str-Lb-libbsd Utility functions from BSD systems (libbsd, \-lbsd)
|
||||
.ds doc-str-Lb-libbsd \*[str-Lb-libbsd]
|
||||
.Lb libbsd
|
||||
.Sh SYNOPSIS
|
||||
.In stdio.h
|
||||
|
1
man/freezero.3bsd
Normal file
1
man/freezero.3bsd
Normal file
@@ -0,0 +1 @@
|
||||
.so man3/reallocarray.3bsd
|
@@ -40,6 +40,7 @@
|
||||
.Nd open a stream
|
||||
.Sh LIBRARY
|
||||
.ds str-Lb-libbsd Utility functions from BSD systems (libbsd, \-lbsd)
|
||||
.ds doc-str-Lb-libbsd \*[str-Lb-libbsd]
|
||||
.Lb libbsd
|
||||
.Sh SYNOPSIS
|
||||
.In stdio.h
|
||||
|
@@ -36,6 +36,7 @@
|
||||
.Nd get preferred block size
|
||||
.Sh LIBRARY
|
||||
.ds str-Lb-libbsd Utility functions from BSD systems (libbsd, \-lbsd)
|
||||
.ds doc-str-Lb-libbsd \*[str-Lb-libbsd]
|
||||
.Lb libbsd
|
||||
.Sh SYNOPSIS
|
||||
.In stdlib.h
|
||||
|
@@ -33,6 +33,7 @@
|
||||
.Nd get the effective credentials of a UNIX-domain peer
|
||||
.Sh LIBRARY
|
||||
.ds str-Lb-libbsd Utility functions from BSD systems (libbsd, \-lbsd)
|
||||
.ds doc-str-Lb-libbsd \*[str-Lb-libbsd]
|
||||
.Lb libbsd
|
||||
.Sh SYNOPSIS
|
||||
.In sys/types.h
|
||||
|
@@ -40,6 +40,7 @@
|
||||
.Nd get or set the program name
|
||||
.Sh LIBRARY
|
||||
.ds str-Lb-libbsd Utility functions from BSD systems (libbsd, \-lbsd)
|
||||
.ds doc-str-Lb-libbsd \*[str-Lb-libbsd]
|
||||
.Lb libbsd
|
||||
.Sh SYNOPSIS
|
||||
.In stdlib.h
|
||||
|
1
man/gid_from_group.3bsd
Normal file
1
man/gid_from_group.3bsd
Normal file
@@ -0,0 +1 @@
|
||||
.so man3/pwcache.3bsd
|
1
man/group_from_gid.3bsd
Normal file
1
man/group_from_gid.3bsd
Normal file
@@ -0,0 +1 @@
|
||||
.so man3/pwcache.3bsd
|
@@ -40,6 +40,7 @@
|
||||
.Nd sort functions
|
||||
.Sh LIBRARY
|
||||
.ds str-Lb-libbsd Utility functions from BSD systems (libbsd, \-lbsd)
|
||||
.ds doc-str-Lb-libbsd \*[str-Lb-libbsd]
|
||||
.Lb libbsd
|
||||
.Sh SYNOPSIS
|
||||
.In stdlib.h
|
||||
|
@@ -36,6 +36,7 @@
|
||||
.Nd format a number into a human readable form and viceversa
|
||||
.Sh LIBRARY
|
||||
.ds str-Lb-libbsd Utility functions from BSD systems (libbsd, \-lbsd)
|
||||
.ds doc-str-Lb-libbsd \*[str-Lb-libbsd]
|
||||
.Lb libbsd
|
||||
.Sh SYNOPSIS
|
||||
.In stdlib.h
|
||||
|
107
man/libbsd.7
107
man/libbsd.7
@@ -1,6 +1,6 @@
|
||||
.\" libbsd man page
|
||||
.\"
|
||||
.\" Copyright © 2017 Gullem Jover <guillem@hadrons.org>
|
||||
.\" Copyright © 2017-2021 Guillem Jover <guillem@hadrons.org>
|
||||
.\"
|
||||
.\" Redistribution and use in source and binary forms, with or without
|
||||
.\" modification, are permitted provided that the following conditions
|
||||
@@ -24,7 +24,7 @@
|
||||
.\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
|
||||
.\" ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
.\"
|
||||
.Dd May 31 2017
|
||||
.Dd Feb 13, 2021
|
||||
.Dt LIBBSD 7
|
||||
.Os
|
||||
.Sh NAME
|
||||
@@ -33,7 +33,7 @@
|
||||
.Sh DESCRIPTION
|
||||
The
|
||||
.Nm libbsd
|
||||
library provides a set if compatibility macros and functions commonly found
|
||||
library provides a set of compatibility macros and functions commonly found
|
||||
on BSD-based systems.
|
||||
Its purpose is to make those available on non-BSD based systems to ease
|
||||
portability.
|
||||
@@ -42,7 +42,7 @@ The library can be used in an overlay mode, which is the preferred way, so
|
||||
that the code is portable and requires no modification to the original BSD
|
||||
code.
|
||||
This can be done easily with the
|
||||
.Xr pkg-config 3
|
||||
.Xr pkg-config 1
|
||||
library named
|
||||
.Pa libbsd-overlay .
|
||||
Or by adding the system-specific include directory with the
|
||||
@@ -64,7 +64,7 @@ this is less portable as it makes using
|
||||
mandatory and it will not work on BSD-based systems, and requires
|
||||
modifying original BSD code.
|
||||
This can be done with the
|
||||
.Xr pkg-config 3
|
||||
.Xr pkg-config 1
|
||||
library named
|
||||
.Pa libbsd .
|
||||
The includes in this case should be namespaced with
|
||||
@@ -73,13 +73,13 @@ such as
|
||||
.In bsd/unistd.h .
|
||||
.Pp
|
||||
The package also provides a
|
||||
.Pa bsd-ctor
|
||||
.Nm libbsd-ctor
|
||||
static library that can be used to inject automatic constructors into a
|
||||
program so that the
|
||||
.Fn setproctitle
|
||||
.Fn setproctitle_init 3
|
||||
function gets invoked automatically at startup time.
|
||||
This can be done with the
|
||||
.Xr pkg-config 3
|
||||
.Xr pkg-config 1
|
||||
library named
|
||||
.Pa libbsd-ctor .
|
||||
.Sh HEADERS
|
||||
@@ -94,10 +94,13 @@ be prefixed with
|
||||
.It In bitstring.h
|
||||
.It In err.h
|
||||
.It In getopt.h
|
||||
.It In grp.h
|
||||
.It In inttypes.h
|
||||
.It In libutil.h
|
||||
.It In md5.h
|
||||
.It In netinet/ip_icmp.h
|
||||
.It In nlist.h
|
||||
.It In pwd.h
|
||||
.It In readpassphrase.h
|
||||
.It In stdio.h
|
||||
.It In stdlib.h
|
||||
@@ -106,6 +109,7 @@ be prefixed with
|
||||
.It In sys/bitstring.h
|
||||
.It In sys/cdefs.h
|
||||
.It In sys/endian.h
|
||||
.It In sys/param.h
|
||||
.It In sys/poll.h
|
||||
.It In sys/queue.h
|
||||
.It In sys/time.h
|
||||
@@ -124,6 +128,46 @@ It only works in non-overlay mode.
|
||||
.Bl -tag -width 4m -compact
|
||||
.It In bsd/bsd.h
|
||||
.El
|
||||
.Sh ALTERNATIVES
|
||||
Some functions have different prototypes depending on the BSD where they
|
||||
originated from, and these various implementations provided are selectable
|
||||
at build-time.
|
||||
.Pp
|
||||
This is the list of functions that provide multiple implementations:
|
||||
.Bl -tag -width 4m
|
||||
.It Fn strnvis 3
|
||||
.It Fn strnunvis 3
|
||||
.Nx
|
||||
added
|
||||
.Fn strnvis 3
|
||||
and
|
||||
.Fn strnunvis 3
|
||||
but unfortunately made it incompatible with the existing one in
|
||||
.Ox
|
||||
and Freedesktop's libbsd (the former having existed for over ten years).
|
||||
Despite this incompatibility being reported during development (see
|
||||
http://gnats.netbsd.org/44977) they still shipped it.
|
||||
Even more unfortunately
|
||||
.Fx
|
||||
and later MacOS picked up this incompatible implementation.
|
||||
.Pp
|
||||
Provide both implementations and default for now to the historical one to
|
||||
avoid breakage, but we will switch to the
|
||||
.Nx
|
||||
one in a later release, which is internally consistent with the other
|
||||
.Xr vis 3
|
||||
functions and is now more widespread.
|
||||
Define
|
||||
.Dv LIBBSD_NETBSD_VIS
|
||||
to switch to the
|
||||
.Nx
|
||||
one now.
|
||||
Define
|
||||
.Dv LIBBSD_OPENBSD_VIS
|
||||
to keep using the
|
||||
.Ox
|
||||
one.
|
||||
.El
|
||||
.Sh DEPRECATED
|
||||
Some functions have been deprecated, they will emit warnings at compile time
|
||||
and possibly while being linked at run-time.
|
||||
@@ -133,7 +177,7 @@ or non-buggy way; or because there are better more portable replacements now.
|
||||
.Pp
|
||||
This is the list of currently deprecated macros and functions:
|
||||
.Bl -tag -width 4m
|
||||
.It Fn fgetln
|
||||
.It Fn fgetln 3
|
||||
Unportable, requires assistance from the stdio layer.
|
||||
An implementation has to choose between leaking buffers or being reentrant
|
||||
for a limited amount of streams (this implementation chose the latter with
|
||||
@@ -142,10 +186,21 @@ Use
|
||||
.Fn getline 3
|
||||
instead, which is available in many systems and required by
|
||||
.St -p1003.1-2008 .
|
||||
.It Fn funopen
|
||||
.It Fn fgetwln 3
|
||||
Unportable, requires assistance from the stdio layer.
|
||||
An implementation has to choose between leaking buffers or being reentrant
|
||||
for a limited amount of streams (this implementation chose the latter with
|
||||
a limit of 32).
|
||||
Use
|
||||
.Fn fgetwc 3
|
||||
instead, which is available in many systems and required by
|
||||
.St -isoC-99
|
||||
and
|
||||
.St -p1003.1-2001 .
|
||||
.It Fn funopen 3
|
||||
Unportable, requires assistance from the stdio layer or some hook framework.
|
||||
On GNU systems the
|
||||
.Fn fopencookie
|
||||
.Fn fopencookie 3
|
||||
function can be used.
|
||||
Otherwise the code needs to be prepared for neither of these functions being
|
||||
available.
|
||||
@@ -159,23 +214,24 @@ are present in all major
|
||||
for example.
|
||||
.Pp
|
||||
.Bl -tag -width 4m -compact
|
||||
.It Fn MD5Init
|
||||
.It Fn MD5Update
|
||||
.It Fn MD5Pad
|
||||
.It Fn MD5Final
|
||||
.It Fn MD5Transform
|
||||
.It Fn MD5End
|
||||
.It Fn MD5File
|
||||
.It Fn MD5FileChunk
|
||||
.It Fn MD5Data
|
||||
The set of MD5 digest functions are now provided by the
|
||||
.It Fn MD5Init 3
|
||||
.It Fn MD5Update 3
|
||||
.It Fn MD5Pad 3
|
||||
.It Fn MD5Final 3
|
||||
.It Fn MD5Transform 3
|
||||
.It Fn MD5End 3
|
||||
.It Fn MD5File 3
|
||||
.It Fn MD5FileChunk 3
|
||||
.It Fn MD5Data 3
|
||||
The set of MD5 digest functions are now proxies for the implementations
|
||||
provided by the
|
||||
.Nm libmd
|
||||
companion library, so it is advised to use that instead.
|
||||
.It Fn explicit_bzero
|
||||
companion library, so it is advised to switch to use that directly instead.
|
||||
.It Fn explicit_bzero 3
|
||||
This function is provided by
|
||||
.Nm glibc
|
||||
2.25.
|
||||
.It Fn reallocarray
|
||||
.It Fn reallocarray 3
|
||||
This function is provided by
|
||||
.Nm glibc
|
||||
2.26.
|
||||
@@ -203,6 +259,7 @@ This function is provided by
|
||||
.Xr md5 3bsd ,
|
||||
.Xr nlist 3bsd ,
|
||||
.Xr pidfile 3bsd ,
|
||||
.Xr pwcache 3bsd ,
|
||||
.Xr queue 3bsd ,
|
||||
.Xr radixsort 3bsd ,
|
||||
.Xr readpassphrase 3bsd ,
|
||||
@@ -214,7 +271,9 @@ This function is provided by
|
||||
.Xr strlcpy 3bsd ,
|
||||
.Xr strmode 3bsd ,
|
||||
.Xr strnstr 3bsd ,
|
||||
.Xr strtoi 3bsd ,
|
||||
.Xr strtonum 3bsd ,
|
||||
.Xr strtou 3bsd ,
|
||||
.Xr timeradd 3bsd ,
|
||||
.Xr timeval 3bsd ,
|
||||
.Xr tree 3bsd ,
|
||||
|
@@ -25,6 +25,7 @@
|
||||
.Nd calculate the RSA Data Security, Inc., ``MDX'' message digest
|
||||
.Sh LIBRARY
|
||||
.ds str-Lb-libbsd Utility functions from BSD systems (libbsd, \-lbsd)
|
||||
.ds doc-str-Lb-libbsd \*[str-Lb-libbsd]
|
||||
.Lb libbsd
|
||||
.Sh SYNOPSIS
|
||||
.In sys/types.h
|
||||
|
@@ -36,6 +36,7 @@
|
||||
.Nd retrieve symbol table name list from an executable file
|
||||
.Sh LIBRARY
|
||||
.ds str-Lb-libbsd Utility functions from BSD systems (libbsd, \-lbsd)
|
||||
.ds doc-str-Lb-libbsd \*[str-Lb-libbsd]
|
||||
.Lb libbsd
|
||||
.Sh SYNOPSIS
|
||||
.In nlist.h
|
||||
@@ -50,7 +51,7 @@ The
|
||||
function
|
||||
retrieves name list entries from the symbol table of an
|
||||
executable file (see
|
||||
.Xr a.out 5 ) .
|
||||
.Xr elf 5 ) .
|
||||
The argument
|
||||
.Fa \&nl
|
||||
is set to reference the
|
||||
@@ -71,9 +72,12 @@ The last entry in the list is always
|
||||
The number of invalid entries is returned if successful; otherwise,
|
||||
if the file
|
||||
.Fa filename
|
||||
does not exist or is not executable, the returned value is \-1.
|
||||
does not exist or is not executable,
|
||||
or the nl pointer is
|
||||
.Dv NULL ,
|
||||
the returned value is \-1.
|
||||
.Sh SEE ALSO
|
||||
.Xr a.out 5
|
||||
.Xr elf 5
|
||||
.Sh HISTORY
|
||||
A
|
||||
.Fn nlist
|
||||
|
@@ -24,17 +24,19 @@
|
||||
.\"
|
||||
.\" $FreeBSD$
|
||||
.\"
|
||||
.Dd October 20, 2008
|
||||
.Dd February 8, 2012
|
||||
.Dt PIDFILE 3bsd
|
||||
.Os
|
||||
.Sh NAME
|
||||
.Nm pidfile_open ,
|
||||
.Nm pidfile_write ,
|
||||
.Nm pidfile_close ,
|
||||
.Nm pidfile_remove
|
||||
.Nd library for PID files handling
|
||||
.Nm pidfile_remove ,
|
||||
.Nm pidfile_fileno
|
||||
.Nd "library for PID files handling"
|
||||
.Sh LIBRARY
|
||||
.ds str-Lb-libbsd Utility functions from BSD systems (libbsd, \-lbsd)
|
||||
.ds doc-str-Lb-libbsd \*[str-Lb-libbsd]
|
||||
.Lb libbsd
|
||||
.Sh SYNOPSIS
|
||||
.In libutil.h
|
||||
@@ -49,6 +51,8 @@ for include usage.)
|
||||
.Fn pidfile_close "struct pidfh *pfh"
|
||||
.Ft int
|
||||
.Fn pidfile_remove "struct pidfh *pfh"
|
||||
.Ft int
|
||||
.Fn pidfile_fileno "struct pidfh *pfh"
|
||||
.Sh DESCRIPTION
|
||||
The
|
||||
.Nm pidfile
|
||||
@@ -62,11 +66,14 @@ The
|
||||
function opens (or creates) a file specified by the
|
||||
.Fa path
|
||||
argument and locks it.
|
||||
If a file can not be locked, a PID of an already running daemon is returned in
|
||||
the
|
||||
If
|
||||
.Fa pidptr
|
||||
argument (if it is not
|
||||
.Dv NULL ) .
|
||||
argument is not
|
||||
.Dv NULL
|
||||
and file can not be locked, the function will use it to store a PID of an
|
||||
already running daemon or
|
||||
.Li -1
|
||||
in case daemon did not write its PID yet.
|
||||
The function does not write process' PID into the file here, so it can be
|
||||
used before
|
||||
.Fn fork Ns ing
|
||||
@@ -77,10 +84,16 @@ argument is
|
||||
.Dv NULL ,
|
||||
.Pa /var/run/ Ns Ao Va progname Ac Ns Pa .pid
|
||||
file will be used.
|
||||
The
|
||||
.Fn pidfile_open
|
||||
function sets the O_CLOEXEC close-on-exec flag when opening the pidfile.
|
||||
.Pp
|
||||
The
|
||||
.Fn pidfile_write
|
||||
function writes process' PID into a previously opened file.
|
||||
The file is truncated before write, so calling the
|
||||
.Fn pidfile_write
|
||||
function multiple times is supported.
|
||||
.Pp
|
||||
The
|
||||
.Fn pidfile_close
|
||||
@@ -92,6 +105,10 @@ to start a child process.
|
||||
The
|
||||
.Fn pidfile_remove
|
||||
function closes and removes a pidfile.
|
||||
.Pp
|
||||
The
|
||||
.Fn pidfile_fileno
|
||||
function returns the file descriptor for the open pidfile.
|
||||
.Sh RETURN VALUES
|
||||
The
|
||||
.Fn pidfile_open
|
||||
@@ -105,15 +122,27 @@ If an error occurs,
|
||||
will be set.
|
||||
.Pp
|
||||
.Rv -std pidfile_write pidfile_close pidfile_remove
|
||||
.Pp
|
||||
The
|
||||
.Fn pidfile_fileno
|
||||
function returns the low-level file descriptor.
|
||||
It returns
|
||||
.Li -1
|
||||
and sets
|
||||
.Va errno
|
||||
if a NULL
|
||||
.Vt pidfh
|
||||
is specified, or if the pidfile is no longer open.
|
||||
.Sh EXAMPLES
|
||||
The following example shows in which order these functions should be used.
|
||||
Note that it is safe to pass
|
||||
.Dv NULL
|
||||
to
|
||||
.Fn pidfile_write ,
|
||||
.Fn pidfile_remove
|
||||
and
|
||||
.Fn pidfile_remove ,
|
||||
.Fn pidfile_close
|
||||
and
|
||||
.Fn pidfile_fileno
|
||||
functions.
|
||||
.Bd -literal
|
||||
struct pidfh *pfh;
|
||||
@@ -127,6 +156,11 @@ if (pfh == NULL) {
|
||||
}
|
||||
/* If we cannot create pidfile from other reasons, only warn. */
|
||||
warn("Cannot open or create pidfile");
|
||||
/*
|
||||
* Even though pfh is NULL we can continue, as the other pidfile_*
|
||||
* function can handle such situation by doing nothing except setting
|
||||
* errno to EINVAL.
|
||||
*/
|
||||
}
|
||||
|
||||
if (daemon(0, 0) == \-1) {
|
||||
@@ -165,16 +199,18 @@ function will fail if:
|
||||
.It Bq Er EEXIST
|
||||
Some process already holds the lock on the given pidfile, meaning that a
|
||||
daemon is already running.
|
||||
If
|
||||
.Fa pidptr
|
||||
argument is not
|
||||
.Dv NULL
|
||||
the function will use it to store a PID of an already running daemon or
|
||||
.Li -1
|
||||
in case daemon did not write its PID yet.
|
||||
.It Bq Er ENAMETOOLONG
|
||||
Specified pidfile's name is too long.
|
||||
.It Bq Er EINVAL
|
||||
Some process already holds the lock on the given pidfile, but PID read
|
||||
from there is invalid.
|
||||
.It Bq Er EAGAIN
|
||||
Some process already holds the lock on the given pidfile, but the file
|
||||
is truncated.
|
||||
Most likely, the existing daemon is writing new PID into
|
||||
the file.
|
||||
.El
|
||||
.Pp
|
||||
The
|
||||
@@ -242,6 +278,16 @@ and
|
||||
system calls and the
|
||||
.Xr flopen 3bsd
|
||||
library function.
|
||||
.Pp
|
||||
The
|
||||
.Fn pidfile_fileno
|
||||
function will fail if:
|
||||
.Bl -tag -width Er
|
||||
.It Bq Er EINVAL
|
||||
Improper function use.
|
||||
Probably called not from the process which used
|
||||
.Fn pidfile_open .
|
||||
.El
|
||||
.Sh SEE ALSO
|
||||
.Xr open 2 ,
|
||||
.Xr daemon 3 ,
|
||||
@@ -251,7 +297,7 @@ library function.
|
||||
The
|
||||
.Nm pidfile
|
||||
functionality is based on ideas from
|
||||
.An John-Mark Gurney Aq jmg@FreeBSD.org .
|
||||
.An John-Mark Gurney Aq Mt jmg@FreeBSD.org .
|
||||
.Pp
|
||||
The code and manual page was written by
|
||||
.An Pawel Jakub Dawidek Aq pjd@FreeBSD.org .
|
||||
.An Pawel Jakub Dawidek Aq Mt pjd@FreeBSD.org .
|
||||
|
143
man/pwcache.3bsd
Normal file
143
man/pwcache.3bsd
Normal file
@@ -0,0 +1,143 @@
|
||||
.\" $OpenBSD: pwcache.3,v 1.15 2018/09/13 16:50:54 jmc Exp $
|
||||
.\"
|
||||
.\" Copyright (c) 1989, 1991, 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.
|
||||
.\"
|
||||
.Dd $Mdocdate: September 13 2018 $
|
||||
.Dt USER_FROM_UID 3
|
||||
.Os
|
||||
.Sh NAME
|
||||
.Nm user_from_uid ,
|
||||
.Nm uid_from_user ,
|
||||
.Nm group_from_gid ,
|
||||
.Nm gid_from_group
|
||||
.Nd cache password and group entries
|
||||
.Sh LIBRARY
|
||||
.ds str-Lb-libbsd Utility functions from BSD systems (libbsd, \-lbsd)
|
||||
.ds doc-str-Lb-libbsd \*[str-Lb-libbsd]
|
||||
.Lb libbsd
|
||||
.Sh SYNOPSIS
|
||||
.In pwd.h
|
||||
(See
|
||||
.Xr libbsd 7
|
||||
for include usage.)
|
||||
.Ft int
|
||||
.Fn uid_from_user "const char *name" "uid_t *uid"
|
||||
.Ft const char *
|
||||
.Fn user_from_uid "uid_t uid" "int nouser"
|
||||
.In grp.h
|
||||
.Ft int
|
||||
.Fn gid_from_group "const char *name" "gid_t *gid"
|
||||
.Ft const char *
|
||||
.Fn group_from_gid "gid_t gid" "int nogroup"
|
||||
.Sh DESCRIPTION
|
||||
The
|
||||
.Fn user_from_uid
|
||||
function returns the user name associated with the argument
|
||||
.Fa uid .
|
||||
The user name is cached so that multiple calls with the same
|
||||
.Fa uid
|
||||
do not require additional calls to
|
||||
.Xr getpwuid 3 .
|
||||
If there is no user associated with the
|
||||
.Fa uid ,
|
||||
a pointer is returned
|
||||
to a string representation of the
|
||||
.Fa uid ,
|
||||
unless the argument
|
||||
.Fa nouser
|
||||
is non-zero, in which case a null pointer is returned.
|
||||
.Pp
|
||||
The
|
||||
.Fn uid_from_user
|
||||
function returns the user ID associated with the argument
|
||||
.Fa name .
|
||||
The user ID is cached so that multiple calls with the same
|
||||
.Fa name
|
||||
do not require additional calls to
|
||||
.Xr getpwnam 3 .
|
||||
If there is no user ID associated with the
|
||||
.Fa name ,
|
||||
the
|
||||
.Fn uid_from_user
|
||||
function returns -1;
|
||||
otherwise it stores the user ID at the location pointed to by
|
||||
.Fa uid
|
||||
and returns 0.
|
||||
.Pp
|
||||
The
|
||||
.Fn group_from_gid
|
||||
function returns the group name associated with the argument
|
||||
.Fa gid .
|
||||
The group name is cached so that multiple calls with the same
|
||||
.Fa gid
|
||||
do not require additional calls to
|
||||
.Xr getgrgid 3 .
|
||||
If there is no group associated with the
|
||||
.Fa gid ,
|
||||
a pointer is returned
|
||||
to a string representation of the
|
||||
.Fa gid ,
|
||||
unless the argument
|
||||
.Fa nogroup
|
||||
is non-zero, in which case a null pointer is returned.
|
||||
.Pp
|
||||
The
|
||||
.Fn gid_from_group
|
||||
function returns the group ID associated with the argument
|
||||
.Fa name .
|
||||
The group ID is cached so that multiple calls with the same
|
||||
.Fa name
|
||||
do not require additional calls to
|
||||
.Xr getgrnam 3 .
|
||||
If there is no group ID associated with the
|
||||
.Fa name ,
|
||||
the
|
||||
.Fn gid_from_group
|
||||
function returns -1;
|
||||
otherwise it stores the group ID at the location pointed to by
|
||||
.Fa gid
|
||||
and returns 0.
|
||||
.Sh SEE ALSO
|
||||
.Xr getgrgid 3 ,
|
||||
.Xr getpwuid 3
|
||||
.Sh HISTORY
|
||||
The
|
||||
.Fn user_from_uid
|
||||
and
|
||||
.Fn group_from_gid
|
||||
functions first appeared in
|
||||
.Bx 4.4 .
|
||||
.Pp
|
||||
The
|
||||
.Fn uid_from_user
|
||||
and
|
||||
.Fn gid_from_group
|
||||
functions were ported from
|
||||
.Nx
|
||||
and first appeared in
|
||||
.Ox 6.4 .
|
157
man/queue.3bsd
157
man/queue.3bsd
@@ -28,35 +28,40 @@
|
||||
.\" @(#)queue.3 8.2 (Berkeley) 1/24/94
|
||||
.\" $FreeBSD$
|
||||
.\"
|
||||
.Dd June 17, 2013
|
||||
.Dd September 8, 2016
|
||||
.Dt QUEUE 3bsd
|
||||
.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_SAFE ,
|
||||
.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_REMOVE ,
|
||||
.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_SAFE ,
|
||||
.Nm STAILQ_FOREACH_FROM_SAFE ,
|
||||
.Nm STAILQ_FOREACH_SAFE ,
|
||||
.Nm STAILQ_HEAD ,
|
||||
.Nm STAILQ_HEAD_INITIALIZER ,
|
||||
.Nm STAILQ_INIT ,
|
||||
@@ -65,17 +70,20 @@
|
||||
.Nm STAILQ_INSERT_TAIL ,
|
||||
.Nm STAILQ_LAST ,
|
||||
.Nm STAILQ_NEXT ,
|
||||
.Nm STAILQ_REMOVE ,
|
||||
.Nm STAILQ_REMOVE_AFTER ,
|
||||
.Nm STAILQ_REMOVE_HEAD ,
|
||||
.Nm STAILQ_REMOVE ,
|
||||
.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_SAFE ,
|
||||
.Nm LIST_FOREACH_FROM_SAFE ,
|
||||
.Nm LIST_FOREACH_SAFE ,
|
||||
.Nm LIST_HEAD ,
|
||||
.Nm LIST_HEAD_INITIALIZER ,
|
||||
.Nm LIST_INIT ,
|
||||
@@ -86,18 +94,20 @@
|
||||
.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_SAFE ,
|
||||
.Nm TAILQ_FOREACH_FROM_SAFE ,
|
||||
.Nm TAILQ_FOREACH_REVERSE ,
|
||||
.Nm TAILQ_FOREACH_REVERSE_FROM ,
|
||||
.Nm TAILQ_FOREACH_REVERSE_SAFE ,
|
||||
.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 ,
|
||||
@@ -112,58 +122,70 @@
|
||||
.Nm TAILQ_SWAP
|
||||
.Nd implementations of singly-linked lists, singly-linked tail queues,
|
||||
lists and tail queues
|
||||
.Sh LIBRARY
|
||||
.ds str-Lb-libbsd Utility functions from BSD systems (libbsd, \-lbsd)
|
||||
.ds doc-str-Lb-libbsd \*[str-Lb-libbsd]
|
||||
.Lb libbsd
|
||||
.Sh SYNOPSIS
|
||||
.In sys/queue.h
|
||||
(See
|
||||
.Xr libbsd 7
|
||||
for include usage.)
|
||||
.\"
|
||||
.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_SAFE "TYPE *var" "SLIST_HEAD *head" "SLIST_ENTRY NAME" "TYPE *temp_var"
|
||||
.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_REMOVE "SLIST_HEAD *head" "TYPE *elm" "TYPE" "SLIST_ENTRY NAME"
|
||||
.Fn SLIST_SWAP "SLIST_HEAD *head1" "SLIST_HEAD *head2" "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_SAFE "TYPE *var" "STAILQ_HEAD *head" "STAILQ_ENTRY NAME" "TYPE *temp_var"
|
||||
.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" "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_REMOVE "STAILQ_HEAD *head" "TYPE *elm" "TYPE" "STAILQ_ENTRY NAME"
|
||||
.Fn STAILQ_SWAP "STAILQ_HEAD *head1" "STAILQ_HEAD *head2" "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_SAFE "TYPE *var" "LIST_HEAD *head" "LIST_ENTRY NAME" "TYPE *temp_var"
|
||||
.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"
|
||||
@@ -175,18 +197,20 @@ for include usage.)
|
||||
.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_SAFE "TYPE *var" "TAILQ_HEAD *head" "TAILQ_ENTRY NAME" "TYPE *temp_var"
|
||||
.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_SAFE "TYPE *var" "TAILQ_HEAD *head" "HEADNAME" "TAILQ_ENTRY NAME" "TYPE *temp_var"
|
||||
.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"
|
||||
@@ -201,8 +225,18 @@ for include usage.)
|
||||
.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:
|
||||
singly-linked lists, singly-linked tail queues, lists, and tail queues.
|
||||
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
|
||||
@@ -226,6 +260,8 @@ 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:
|
||||
@@ -273,6 +309,8 @@ 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:
|
||||
@@ -304,24 +342,39 @@ than singly-linked lists.
|
||||
.Pp
|
||||
In the macro definitions,
|
||||
.Fa TYPE
|
||||
is the name of a user defined structure,
|
||||
that must contain a field of 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 ,
|
||||
named
|
||||
.Fa NAME .
|
||||
.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_HEAD .
|
||||
.Li TAILQ_CLASS_HEAD .
|
||||
See the examples below for further explanation of how these
|
||||
macros are used.
|
||||
.Sh SINGLY-LINKED LISTS
|
||||
@@ -363,6 +416,19 @@ 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
|
||||
@@ -470,6 +536,9 @@ The macro
|
||||
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
|
||||
@@ -686,6 +755,9 @@ The macro
|
||||
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
|
||||
@@ -785,6 +857,19 @@ 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
|
||||
@@ -1206,6 +1291,26 @@ while (n1 != NULL) {
|
||||
}
|
||||
TAILQ_INIT(&head);
|
||||
.Ed
|
||||
.Sh DIAGNOSTICS
|
||||
When debugging
|
||||
.Nm queue(3) ,
|
||||
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 SEE ALSO
|
||||
.Xr tree 3bsd
|
||||
.Sh HISTORY
|
||||
|
@@ -38,6 +38,7 @@
|
||||
.Nd radix sort
|
||||
.Sh LIBRARY
|
||||
.ds str-Lb-libbsd Utility functions from BSD systems (libbsd, \-lbsd)
|
||||
.ds doc-str-Lb-libbsd \*[str-Lb-libbsd]
|
||||
.Lb libbsd
|
||||
.Sh SYNOPSIS
|
||||
.In limits.h
|
||||
|
@@ -1,4 +1,4 @@
|
||||
.\" $OpenBSD: readpassphrase.3,v 1.16 2005/07/22 03:16:58 jaredy Exp $
|
||||
.\" $OpenBSD: readpassphrase.3,v 1.20 2014/03/06 23:03:18 millert Exp $
|
||||
.\"
|
||||
.\" Copyright (c) 2000, 2002 Todd C. Miller <Todd.Miller@courtesan.com>
|
||||
.\"
|
||||
@@ -18,7 +18,7 @@
|
||||
.\" Agency (DARPA) and Air Force Research Laboratory, Air Force
|
||||
.\" Materiel Command, USAF, under agreement number F39502-99-1-0512.
|
||||
.\"
|
||||
.Dd $Mdocdate: May 31 2007 $
|
||||
.Dd $Mdocdate: March 6 2014 $
|
||||
.Dt READPASSPHRASE 3bsd
|
||||
.Os
|
||||
.Sh NAME
|
||||
@@ -26,6 +26,7 @@
|
||||
.Nd get a passphrase from the user
|
||||
.Sh LIBRARY
|
||||
.ds str-Lb-libbsd Utility functions from BSD systems (libbsd, \-lbsd)
|
||||
.ds doc-str-Lb-libbsd \*[str-Lb-libbsd]
|
||||
.Lb libbsd
|
||||
.Sh SYNOPSIS
|
||||
.In readpassphrase.h
|
||||
@@ -55,9 +56,11 @@ Up to
|
||||
Any additional
|
||||
characters and the terminating newline (or return) character are discarded.
|
||||
.Pp
|
||||
.Fn readpassphrase
|
||||
takes the following optional
|
||||
.Fa flags :
|
||||
The
|
||||
.Fa flags
|
||||
argument is the bitwise
|
||||
.Tn OR
|
||||
of zero or more of the following values:
|
||||
.Bd -literal -offset indent
|
||||
RPP_ECHO_OFF turn off echo (default behavior)
|
||||
RPP_ECHO_ON leave echo on
|
||||
@@ -65,7 +68,7 @@ RPP_REQUIRE_TTY fail if there is no tty
|
||||
RPP_FORCELOWER force input to lower case
|
||||
RPP_FORCEUPPER force input to upper case
|
||||
RPP_SEVENBIT strip the high bit from input
|
||||
RPP_STDIN force read of passphrase from stdin
|
||||
RPP_STDIN read passphrase from stdin; ignore prompt
|
||||
.Ed
|
||||
.Pp
|
||||
The calling process should zero the passphrase as soon as possible to
|
||||
@@ -100,7 +103,7 @@ if (compare(transform(passbuf), epass) != 0)
|
||||
|
||||
\&...
|
||||
|
||||
memset(passbuf, 0, sizeof(passbuf));
|
||||
explicit_bzero(passbuf, sizeof(passbuf));
|
||||
.Ed
|
||||
.Sh ERRORS
|
||||
.Bl -tag -width Er
|
||||
|
@@ -30,16 +30,19 @@
|
||||
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
||||
.\" SUCH DAMAGE.
|
||||
.\"
|
||||
.\" $OpenBSD: malloc.3,v 1.78 2014/05/01 18:41:59 jmc Exp $
|
||||
.\" $OpenBSD: malloc.3,v 1.126 2019/09/14 13:16:50 otto Exp $
|
||||
.\"
|
||||
.Dd $Mdocdate: May 1 2014 $
|
||||
.Dd $Mdocdate: September 14 2019 $
|
||||
.Dt REALLOCARRAY 3bsd
|
||||
.Os
|
||||
.Sh NAME
|
||||
.Nm reallocarray
|
||||
.Nm reallocarray ,
|
||||
.Nm recallocarray ,
|
||||
.Nm freezero
|
||||
.Nd memory allocation and deallocation
|
||||
.Sh LIBRARY
|
||||
.ds str-Lb-libbsd Utility functions from BSD systems (libbsd, \-lbsd)
|
||||
.ds doc-str-Lb-libbsd \*[str-Lb-libbsd]
|
||||
.Lb libbsd
|
||||
.Sh SYNOPSIS
|
||||
.In stdlib.h
|
||||
@@ -48,59 +51,244 @@
|
||||
for include usage.)
|
||||
.Ft void *
|
||||
.Fn reallocarray "void *ptr" "size_t nmemb" "size_t size"
|
||||
.Ft void *
|
||||
.Fn recallocarray "void *ptr" "size_t oldnmemb" "size_t nmemb" "size_t size"
|
||||
.Ft void
|
||||
.Fn freezero "void *ptr" "size_t size"
|
||||
.Sh DESCRIPTION
|
||||
.Pp
|
||||
When using
|
||||
.Fn malloc
|
||||
be careful to avoid the following idiom:
|
||||
.Bd -literal -offset indent
|
||||
if ((p = malloc(num * size)) == NULL)
|
||||
err(1, "malloc");
|
||||
.Ed
|
||||
.Pp
|
||||
The multiplication may lead to an integer overflow, which can
|
||||
be avoided using the extension
|
||||
.Fn reallocarray ,
|
||||
as follows:
|
||||
.Bd -literal -offset indent
|
||||
if ((p = reallocarray(NULL, num, size)) == NULL)
|
||||
err(1, "malloc");
|
||||
.Ed
|
||||
.Pp
|
||||
Alternatively
|
||||
.Fn calloc
|
||||
is a more portable solution which comes with the cost of clearing memory.
|
||||
.Pp
|
||||
If
|
||||
.Fn malloc
|
||||
must be used, be sure to test for overflow:
|
||||
.Bd -literal -offset indent
|
||||
if (size && num > SIZE_MAX / size) {
|
||||
errno = ENOMEM;
|
||||
err(1, "overflow");
|
||||
}
|
||||
.Ed
|
||||
.Pp
|
||||
The use of
|
||||
Designed for safe allocation of arrays,
|
||||
the
|
||||
.Fn reallocarray
|
||||
or
|
||||
.Fn calloc
|
||||
is strongly encouraged when allocating multiple sized objects
|
||||
in order to avoid possible integer overflows.
|
||||
function is similar to
|
||||
.Fn realloc
|
||||
except it operates on
|
||||
.Fa nmemb
|
||||
members of size
|
||||
.Fa size
|
||||
and checks for integer overflow in the calculation
|
||||
.Fa nmemb
|
||||
*
|
||||
.Fa size .
|
||||
.Pp
|
||||
Used for the allocation of memory holding sensitive data,
|
||||
the
|
||||
.Fn recallocarray
|
||||
function guarantees that memory becoming unallocated is explicitly
|
||||
.Em discarded ,
|
||||
meaning cached free objects are cleared with
|
||||
.Xr explicit_bzero 3 .
|
||||
.Pp
|
||||
The
|
||||
.Fn recallocarray
|
||||
function is similar to
|
||||
.Fn reallocarray
|
||||
except it ensures newly allocated memory is cleared similar to
|
||||
.Fn calloc .
|
||||
If
|
||||
.Fa ptr
|
||||
is
|
||||
.Dv NULL ,
|
||||
.Fa oldnmemb
|
||||
is ignored and the call is equivalent to
|
||||
.Fn calloc .
|
||||
If
|
||||
.Fa ptr
|
||||
is not
|
||||
.Dv NULL ,
|
||||
.Fa oldnmemb
|
||||
must be a value such that
|
||||
.Fa oldnmemb
|
||||
*
|
||||
.Fa size
|
||||
is the size of the earlier allocation that returned
|
||||
.Fa ptr ,
|
||||
otherwise the behavior is undefined.
|
||||
The
|
||||
.Fn freezero
|
||||
function is similar to the
|
||||
.Fn free
|
||||
function except it ensures memory is explicitly discarded.
|
||||
If
|
||||
.Fa ptr
|
||||
is
|
||||
.Dv NULL ,
|
||||
no action occurs.
|
||||
If
|
||||
.Fa ptr
|
||||
is not
|
||||
.Dv NULL ,
|
||||
the
|
||||
.Fa size
|
||||
argument must be equal to or smaller than the size of the earlier allocation
|
||||
that returned
|
||||
.Fa ptr .
|
||||
.Fn freezero
|
||||
guarantees the memory range starting at
|
||||
.Fa ptr
|
||||
with length
|
||||
.Fa size
|
||||
is discarded while deallocating the whole object originally allocated.
|
||||
.Sh RETURN VALUES
|
||||
The
|
||||
.Fn reallocarray
|
||||
function returns a pointer to the allocated space if successful; otherwise,
|
||||
and
|
||||
.Fn recallocarray
|
||||
functions return a pointer to the allocated space if successful; otherwise,
|
||||
a null pointer is returned and
|
||||
.Va errno
|
||||
is set to
|
||||
.Er ENOMEM .
|
||||
.Pp
|
||||
If multiplying
|
||||
.Fa nmemb
|
||||
and
|
||||
.Fa size
|
||||
results in integer overflow,
|
||||
.Fn reallocarray
|
||||
and
|
||||
.Fn recallocarray
|
||||
return
|
||||
.Dv NULL
|
||||
and set
|
||||
.Va errno
|
||||
to
|
||||
.Er ENOMEM .
|
||||
.Pp
|
||||
If
|
||||
.Fa ptr
|
||||
is not
|
||||
.Dv NULL
|
||||
and multiplying
|
||||
.Fa oldnmemb
|
||||
and
|
||||
.Fa size
|
||||
results in integer overflow
|
||||
.Fn recallocarray
|
||||
returns
|
||||
.Dv NULL
|
||||
and sets
|
||||
.Va errno
|
||||
to
|
||||
.Er EINVAL .
|
||||
.Sh IDIOMS
|
||||
Consider
|
||||
.Fn calloc
|
||||
or the extensions
|
||||
.Fn reallocarray
|
||||
and
|
||||
.Fn recallocarray
|
||||
when there is multiplication in the
|
||||
.Fa size
|
||||
argument of
|
||||
.Fn malloc
|
||||
or
|
||||
.Fn realloc .
|
||||
For example, avoid this common idiom as it may lead to integer overflow:
|
||||
.Bd -literal -offset indent
|
||||
if ((p = malloc(num * size)) == NULL)
|
||||
err(1, NULL);
|
||||
.Ed
|
||||
.Pp
|
||||
A drop-in replacement is
|
||||
.Fn reallocarray :
|
||||
.Bd -literal -offset indent
|
||||
if ((p = reallocarray(NULL, num, size)) == NULL)
|
||||
err(1, NULL);
|
||||
.Ed
|
||||
.Pp
|
||||
Alternatively,
|
||||
.Fn calloc
|
||||
may be used at the cost of initialization overhead.
|
||||
.Pp
|
||||
When using
|
||||
.Fn realloc ,
|
||||
be careful to avoid the following idiom:
|
||||
.Bd -literal -offset indent
|
||||
size += 50;
|
||||
if ((p = realloc(p, size)) == NULL)
|
||||
return (NULL);
|
||||
.Ed
|
||||
.Pp
|
||||
Do not adjust the variable describing how much memory has been allocated
|
||||
until the allocation has been successful.
|
||||
This can cause aberrant program behavior if the incorrect size value is used.
|
||||
In most cases, the above sample will also result in a leak of memory.
|
||||
As stated earlier, a return value of
|
||||
.Dv NULL
|
||||
indicates that the old object still remains allocated.
|
||||
Better code looks like this:
|
||||
.Bd -literal -offset indent
|
||||
newsize = size + 50;
|
||||
if ((newp = realloc(p, newsize)) == NULL) {
|
||||
free(p);
|
||||
p = NULL;
|
||||
size = 0;
|
||||
return (NULL);
|
||||
}
|
||||
p = newp;
|
||||
size = newsize;
|
||||
.Ed
|
||||
.Pp
|
||||
As with
|
||||
.Fn malloc ,
|
||||
it is important to ensure the new size value will not overflow;
|
||||
i.e. avoid allocations like the following:
|
||||
.Bd -literal -offset indent
|
||||
if ((newp = realloc(p, num * size)) == NULL) {
|
||||
...
|
||||
.Ed
|
||||
.Pp
|
||||
Instead, use
|
||||
.Fn reallocarray :
|
||||
.Bd -literal -offset indent
|
||||
if ((newp = reallocarray(p, num, size)) == NULL) {
|
||||
...
|
||||
.Ed
|
||||
.Pp
|
||||
Calling
|
||||
.Fn realloc
|
||||
with a
|
||||
.Dv NULL
|
||||
.Fa ptr
|
||||
is equivalent to calling
|
||||
.Fn malloc .
|
||||
Instead of this idiom:
|
||||
.Bd -literal -offset indent
|
||||
if (p == NULL)
|
||||
newp = malloc(newsize);
|
||||
else
|
||||
newp = realloc(p, newsize);
|
||||
.Ed
|
||||
.Pp
|
||||
Use the following:
|
||||
.Bd -literal -offset indent
|
||||
newp = realloc(p, newsize);
|
||||
.Ed
|
||||
.Pp
|
||||
The
|
||||
.Fn recallocarray
|
||||
function should be used for resizing objects containing sensitive data like
|
||||
keys.
|
||||
To avoid leaking information,
|
||||
it guarantees memory is cleared before placing it on the internal free list.
|
||||
Deallocation of such an object should be done by calling
|
||||
.Fn freezero .
|
||||
.Sh SEE ALSO
|
||||
.Xr malloc 3 ,
|
||||
.Xr calloc 3 ,
|
||||
.Xr alloca 3
|
||||
.Sh HISTORY
|
||||
The
|
||||
.Fn reallocarray
|
||||
appeared in
|
||||
function appeared in
|
||||
.Ox 5.6 ,
|
||||
glibc 2.26.
|
||||
and glibc 2.26.
|
||||
The
|
||||
.Fn recallocarray
|
||||
function appeared in
|
||||
.Ox 6.1 .
|
||||
The
|
||||
.Fn freezero
|
||||
function appeared in
|
||||
.Ox 6.2 .
|
||||
|
@@ -40,6 +40,7 @@
|
||||
.Nd general purpose memory allocation functions
|
||||
.Sh LIBRARY
|
||||
.ds str-Lb-libbsd Utility functions from BSD systems (libbsd, \-lbsd)
|
||||
.ds doc-str-Lb-libbsd \*[str-Lb-libbsd]
|
||||
.Lb libbsd
|
||||
.Sh SYNOPSIS
|
||||
.In stdlib.h
|
||||
|
1
man/recallocarray.3bsd
Normal file
1
man/recallocarray.3bsd
Normal file
@@ -0,0 +1 @@
|
||||
.so man3/reallocarray.3bsd
|
@@ -39,6 +39,7 @@
|
||||
.Nd modify mode bits
|
||||
.Sh LIBRARY
|
||||
.ds str-Lb-libbsd Utility functions from BSD systems (libbsd, \-lbsd)
|
||||
.ds doc-str-Lb-libbsd \*[str-Lb-libbsd]
|
||||
.Lb libbsd
|
||||
.Sh SYNOPSIS
|
||||
.In unistd.h
|
||||
|
@@ -28,6 +28,7 @@
|
||||
.Nd set process title
|
||||
.Sh LIBRARY
|
||||
.ds str-Lb-libbsd Utility functions from BSD systems (libbsd, \-lbsd)
|
||||
.ds doc-str-Lb-libbsd \*[str-Lb-libbsd]
|
||||
.Lb libbsd
|
||||
.Sh SYNOPSIS
|
||||
.In sys/types.h
|
||||
@@ -118,7 +119,7 @@ similar functions.
|
||||
.Pp
|
||||
The
|
||||
.Fn setproctitle_init
|
||||
function is a libbsd extension not present on the BSDs, avoid using it
|
||||
function is a libbsd extension not present on the BSDs; avoid using it
|
||||
in portable code.
|
||||
.Sh AUTHORS
|
||||
.An -nosplit
|
||||
|
@@ -39,6 +39,7 @@
|
||||
.Nd stringlist manipulation functions
|
||||
.Sh LIBRARY
|
||||
.ds str-Lb-libbsd Utility functions from BSD systems (libbsd, \-lbsd)
|
||||
.ds doc-str-Lb-libbsd \*[str-Lb-libbsd]
|
||||
.Lb libbsd
|
||||
.Sh SYNOPSIS
|
||||
.In stringlist.h
|
||||
|
@@ -23,6 +23,7 @@
|
||||
.Nd size-bounded string copying and concatenation
|
||||
.Sh LIBRARY
|
||||
.ds str-Lb-libbsd Utility functions from BSD systems (libbsd, \-lbsd)
|
||||
.ds doc-str-Lb-libbsd \*[str-Lb-libbsd]
|
||||
.Lb libbsd
|
||||
.Sh SYNOPSIS
|
||||
.In string.h
|
||||
|
@@ -36,6 +36,7 @@
|
||||
.Nd convert inode status information into a symbolic string
|
||||
.Sh LIBRARY
|
||||
.ds str-Lb-libbsd Utility functions from BSD systems (libbsd, \-lbsd)
|
||||
.ds doc-str-Lb-libbsd \*[str-Lb-libbsd]
|
||||
.Lb libbsd
|
||||
.Sh SYNOPSIS
|
||||
.In string.h
|
||||
|
@@ -41,6 +41,7 @@
|
||||
.Nd locate a substring in a string
|
||||
.Sh LIBRARY
|
||||
.ds str-Lb-libbsd Utility functions from BSD systems (libbsd, \-lbsd)
|
||||
.ds doc-str-Lb-libbsd \*[str-Lb-libbsd]
|
||||
.Lb libbsd
|
||||
.Sh SYNOPSIS
|
||||
.In string.h
|
||||
|
240
man/strtoi.3bsd
Normal file
240
man/strtoi.3bsd
Normal file
@@ -0,0 +1,240 @@
|
||||
.\" $NetBSD: strtoi.3,v 1.7 2017/07/03 21:32:50 wiz Exp $
|
||||
.\"
|
||||
.\" Copyright (c) 1990, 1991, 1993
|
||||
.\" The Regents of the University of California. All rights reserved.
|
||||
.\"
|
||||
.\" This code is derived from software contributed to Berkeley by
|
||||
.\" Chris Torek and the American National Standards Committee X3,
|
||||
.\" on Information Processing Systems.
|
||||
.\"
|
||||
.\" 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.
|
||||
.\"
|
||||
.\" from: @(#)strtol.3 8.1 (Berkeley) 6/4/93
|
||||
.\"
|
||||
.\" Created by Kamil Rytarowski, based on ID:
|
||||
.\" NetBSD: strtol.3,v 1.31 2015/03/11 09:57:35 wiz Exp
|
||||
.\"
|
||||
.Dd November 13, 2015
|
||||
.Dt STRTOI 3bsd
|
||||
.Os
|
||||
.Sh NAME
|
||||
.Nm strtoi
|
||||
.Nd convert string value to an intmax_t integer
|
||||
.Sh LIBRARY
|
||||
.ds str-Lb-libbsd Utility functions from BSD systems (libbsd, \-lbsd)
|
||||
.ds doc-str-Lb-libbsd \*[str-Lb-libbsd]
|
||||
.Lb libbsd
|
||||
.Sh SYNOPSIS
|
||||
.In inttypes.h
|
||||
(See
|
||||
.Xr libbsd 7
|
||||
for include usage.)
|
||||
.Ft intmax_t
|
||||
.Fo strtoi
|
||||
.Fa "const char * restrict nptr"
|
||||
.Fa "char ** restrict endptr"
|
||||
.Fa "int base"
|
||||
.Fa "intmax_t lo"
|
||||
.Fa "intmax_t hi"
|
||||
.Fa "int *rstatus"
|
||||
.Fc
|
||||
.Sh DESCRIPTION
|
||||
The
|
||||
.Fn strtoi
|
||||
function
|
||||
converts the string in
|
||||
.Fa nptr
|
||||
to an
|
||||
.Ft intmax_t
|
||||
value.
|
||||
The
|
||||
.Fn strtoi
|
||||
function uses internally
|
||||
.Xr strtoimax 3
|
||||
and ensures that the result is always in the range [
|
||||
.Fa lo ..
|
||||
.Fa hi
|
||||
].
|
||||
In adddition it always places
|
||||
.Dv 0
|
||||
on success or a conversion status in the
|
||||
.Fa rstatus
|
||||
argument, avoiding the
|
||||
.Dv errno
|
||||
gymnastics the other functions require.
|
||||
The
|
||||
.Fa rstatus
|
||||
argument can be
|
||||
.Dv NULL
|
||||
if conversion status is to be ignored.
|
||||
.Pp
|
||||
The string may begin with an arbitrary amount of white space
|
||||
(as determined by
|
||||
.Xr isspace 3 )
|
||||
followed by a single optional
|
||||
.Ql +
|
||||
or
|
||||
.Ql -
|
||||
sign.
|
||||
If
|
||||
.Fa base
|
||||
is zero or 16,
|
||||
the string may then include a
|
||||
.Ql 0x
|
||||
or
|
||||
.Ql 0X
|
||||
prefix,
|
||||
and the number will be read in base 16; otherwise,
|
||||
.\" if the
|
||||
.\" .Fa base
|
||||
.\" is zero or 2,
|
||||
.\" the string may then include a
|
||||
.\" .Ql 0b
|
||||
.\" or
|
||||
.\" .Ql 0B
|
||||
.\" prefix,
|
||||
.\" and the number will be read in base 2; otherwise,
|
||||
a zero
|
||||
.Fa base
|
||||
is taken as 10 (decimal) unless the next character is
|
||||
.Ql 0 ,
|
||||
in which case it is taken as 8 (octal).
|
||||
.Pp
|
||||
The remainder of the string is converted to a
|
||||
.Em intmax_t
|
||||
value in the obvious manner,
|
||||
stopping at the first character which is not a valid digit
|
||||
in the given base.
|
||||
(In bases above 10, the letter
|
||||
.Ql A
|
||||
in either upper or lower case
|
||||
represents 10,
|
||||
.Ql B
|
||||
represents 11, and so forth, with
|
||||
.Ql Z
|
||||
representing 35.)
|
||||
.Pp
|
||||
If
|
||||
.Fa endptr
|
||||
is non-nil,
|
||||
.Fn strtoi
|
||||
stores the address of the first invalid character in
|
||||
.Fa *endptr .
|
||||
If there were no digits at all, however,
|
||||
.Fn strtoi
|
||||
stores the original value of
|
||||
.Fa nptr
|
||||
in
|
||||
.Fa *endptr .
|
||||
(Thus, if
|
||||
.Fa *nptr
|
||||
is not
|
||||
.Ql \e0
|
||||
but
|
||||
.Fa **endptr
|
||||
is
|
||||
.Ql \e0
|
||||
on return, the entire string was valid.)
|
||||
.Sh RETURN VALUES
|
||||
The
|
||||
.Fn strtoi
|
||||
function
|
||||
always returns the closest value in the range specified by
|
||||
the
|
||||
.Fa lo
|
||||
and
|
||||
.Fa hi
|
||||
arguments.
|
||||
.Pp
|
||||
The
|
||||
.Va errno
|
||||
value is guaranteed to be left unchanged.
|
||||
.Pp
|
||||
Errors are stored as the conversion status in the
|
||||
.Fa rstatus
|
||||
argument.
|
||||
.Sh EXAMPLES
|
||||
The following example will always return a number in
|
||||
.Dv [1..99]
|
||||
range no matter what the input is, and warn if the conversion failed.
|
||||
.Bd -literal -offset indent
|
||||
int e;
|
||||
intmax_t lval = strtoi(buf, NULL, 0, 1, 99, &e);
|
||||
if (e)
|
||||
warnc(e, "conversion of `%s' to a number failed, using %jd",
|
||||
buf, lval);
|
||||
.Ed
|
||||
.Sh ERRORS
|
||||
.Bl -tag -width Er
|
||||
.It Bq Er ECANCELED
|
||||
The string did not contain any characters that were converted.
|
||||
.It Bq Er EINVAL
|
||||
The
|
||||
.Ar base
|
||||
is not between 2 and 36 and does not contain the special value 0.
|
||||
.It Bq Er ENOTSUP
|
||||
The string contained non-numeric characters that did not get converted.
|
||||
In this case,
|
||||
.Fa endptr
|
||||
points to the first unconverted character.
|
||||
.It Bq Er ERANGE
|
||||
The given string was out of range; the value converted has been clamped;
|
||||
or the range given was invalid, i.e.
|
||||
.Fa lo
|
||||
>
|
||||
.Fa hi .
|
||||
.El
|
||||
.Sh SEE ALSO
|
||||
.Xr atof 3 ,
|
||||
.Xr atoi 3 ,
|
||||
.Xr atol 3 ,
|
||||
.Xr atoll 3 ,
|
||||
.Xr strtod 3 ,
|
||||
.Xr strtoimax 3 ,
|
||||
.Xr strtol 3 ,
|
||||
.Xr strtoll 3 ,
|
||||
.Xr strtou 3bsd ,
|
||||
.Xr strtoul 3 ,
|
||||
.Xr strtoull 3 ,
|
||||
.Xr strtoumax 3
|
||||
.Sh STANDARDS
|
||||
The
|
||||
.Fn strtoi
|
||||
function is a
|
||||
.Nx
|
||||
extension.
|
||||
.Sh HISTORY
|
||||
.ds doc-operating-system-NetBSD-7.0 7.0
|
||||
The
|
||||
.Fn strtoi
|
||||
function first appeared in
|
||||
.Nx 7.0 .
|
||||
.Ox
|
||||
introduced the
|
||||
.Fn strtonum 3bsd
|
||||
function for the same purpose, but the interface makes it impossible to
|
||||
properly differentiate illegal returns.
|
||||
.Sh BUGS
|
||||
Ignores the current locale.
|
@@ -1,3 +1,6 @@
|
||||
.\" $NetBSD: strtonum.3,v 1.2 2015/01/19 11:47:41 wiz Exp $
|
||||
.\" $OpenBSD: strtonum.3,v 1.17 2013/08/14 06:32:28 jmc Exp $
|
||||
.\"
|
||||
.\" Copyright (c) 2004 Ted Unangst
|
||||
.\"
|
||||
.\" Permission to use, copy, modify, and distribute this software for any
|
||||
@@ -12,10 +15,7 @@
|
||||
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
||||
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
||||
.\"
|
||||
.\" $OpenBSD: strtonum.3,v 1.12 2005/10/26 11:37:58 jmc Exp $
|
||||
.\" $FreeBSD$
|
||||
.\"
|
||||
.Dd April 29, 2004
|
||||
.Dd January 18, 2015
|
||||
.Dt STRTONUM 3bsd
|
||||
.Os
|
||||
.Sh NAME
|
||||
@@ -23,6 +23,7 @@
|
||||
.Nd reliably convert string value to an integer
|
||||
.Sh LIBRARY
|
||||
.ds str-Lb-libbsd Utility functions from BSD systems (libbsd, \-lbsd)
|
||||
.ds doc-str-Lb-libbsd \*[str-Lb-libbsd]
|
||||
.Lb libbsd
|
||||
.Sh SYNOPSIS
|
||||
.In limits.h
|
||||
@@ -45,14 +46,6 @@ function converts the string in
|
||||
to a
|
||||
.Vt "long long"
|
||||
value.
|
||||
The
|
||||
.Fn strtonum
|
||||
function was designed to facilitate safe, robust programming
|
||||
and overcome the shortcomings of the
|
||||
.Xr atoi 3
|
||||
and
|
||||
.Xr strtol 3
|
||||
family of interfaces.
|
||||
.Pp
|
||||
The string may begin with an arbitrary amount of whitespace
|
||||
(as determined by
|
||||
@@ -112,15 +105,13 @@ The above example will guarantee that the value of iterations is between
|
||||
1 and 64 (inclusive).
|
||||
.Sh ERRORS
|
||||
.Bl -tag -width Er
|
||||
.It Bq Er EINVAL
|
||||
The given string did not consist solely of digit characters; or
|
||||
.Ar minval
|
||||
was larger than
|
||||
.Ar maxval .
|
||||
.It Bq Er ERANGE
|
||||
The given string was out of range.
|
||||
.It Bq Er EINVAL
|
||||
The given string did not consist solely of digit characters.
|
||||
.It Bq Er EINVAL
|
||||
The supplied
|
||||
.Fa minval
|
||||
was larger than
|
||||
.Fa maxval .
|
||||
.El
|
||||
.Pp
|
||||
If an error occurs,
|
||||
@@ -142,21 +133,59 @@ The string did not consist solely of digit characters.
|
||||
.Xr atoll 3 ,
|
||||
.Xr sscanf 3 ,
|
||||
.Xr strtod 3 ,
|
||||
.Xr strtoi 3bsd ,
|
||||
.Xr strtol 3 ,
|
||||
.Xr strtoul 3
|
||||
.Xr strtoll 3 ,
|
||||
.Xr strtou 3bsd ,
|
||||
.Xr strtoul 3 ,
|
||||
.Xr strtoull 3
|
||||
.Sh STANDARDS
|
||||
The
|
||||
.Fn strtonum
|
||||
function is a
|
||||
.Bx
|
||||
is an
|
||||
.Ox
|
||||
extension.
|
||||
The existing alternatives, such as
|
||||
.Xr atoi 3
|
||||
and
|
||||
.Xr strtol 3 ,
|
||||
are either impossible or difficult to use safely.
|
||||
.Sh HISTORY
|
||||
.ds doc-operating-system-NetBSD-8.0 8.0
|
||||
The
|
||||
.Fn strtonum
|
||||
function first appeared in
|
||||
.Ox 3.6 .
|
||||
.Fn strtonum
|
||||
was redesigned in
|
||||
.Nx 8.0
|
||||
as
|
||||
.Fn strtoi 3bsd
|
||||
and
|
||||
.Fn strtou 3bsd .
|
||||
.Sh CAVEATS
|
||||
The
|
||||
.Fn strtonum
|
||||
function was designed to facilitate safe,
|
||||
robust programming and overcome the shortcomings of the
|
||||
.Xr atoi 3
|
||||
and
|
||||
.Xr strtol 3
|
||||
family of interfaces, however there are problems with the
|
||||
.Fn strtonum
|
||||
API:
|
||||
.Bl -dash
|
||||
.It
|
||||
will return 0 on failure; 0 might not be in range, so that necessitates
|
||||
an error check even if you want to avoid it
|
||||
.It
|
||||
does not differentiate 'illegal' returns, so we can't tell the
|
||||
difference between partial and no conversions
|
||||
.It
|
||||
returns english strings
|
||||
.It
|
||||
can't set the base, or find where the conversion ended
|
||||
.It
|
||||
hardcodes long long integer type
|
||||
.El
|
||||
To overcome the shortcomings of
|
||||
.Fn strtonum
|
||||
.Nx
|
||||
provides
|
||||
.Fn strtou 3bsd
|
||||
and
|
||||
.Fn strtoi 3bsd .
|
||||
|
240
man/strtou.3bsd
Normal file
240
man/strtou.3bsd
Normal file
@@ -0,0 +1,240 @@
|
||||
.\" $NetBSD: strtou.3,v 1.7 2017/07/03 21:32:50 wiz Exp $
|
||||
.\"
|
||||
.\" Copyright (c) 1990, 1991, 1993
|
||||
.\" The Regents of the University of California. All rights reserved.
|
||||
.\"
|
||||
.\" This code is derived from software contributed to Berkeley by
|
||||
.\" Chris Torek and the American National Standards Committee X3,
|
||||
.\" on Information Processing Systems.
|
||||
.\"
|
||||
.\" 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.
|
||||
.\"
|
||||
.\" from: @(#)strtoul.3 8.1 (Berkeley) 6/4/93
|
||||
.\"
|
||||
.\" Created by Kamil Rytarowski, based on ID:
|
||||
.\" NetBSD: strtoul.3,v 1.29 2015/03/10 13:00:58 christos Exp
|
||||
.\"
|
||||
.Dd November 13, 2015
|
||||
.Dt STRTOU 3bsd
|
||||
.Os
|
||||
.Sh NAME
|
||||
.Nm strtou
|
||||
.Nd convert a string to an uintmax_t integer
|
||||
.Sh LIBRARY
|
||||
.ds str-Lb-libbsd Utility functions from BSD systems (libbsd, \-lbsd)
|
||||
.ds doc-str-Lb-libbsd \*[str-Lb-libbsd]
|
||||
.Lb libbsd
|
||||
.Sh SYNOPSIS
|
||||
.In inttypes.h
|
||||
(See
|
||||
.Xr libbsd 7
|
||||
for include usage.)
|
||||
.Ft uintmax_t
|
||||
.Fo strtou
|
||||
.Fa "const char * restrict nptr"
|
||||
.Fa "char ** restrict endptr"
|
||||
.Fa "int base"
|
||||
.Fa "uintmax_t lo"
|
||||
.Fa "uintmax_t hi"
|
||||
.Fa "int *rstatus"
|
||||
.Fc
|
||||
.Sh DESCRIPTION
|
||||
The
|
||||
.Fn strtou
|
||||
function converts the string in
|
||||
.Fa nptr
|
||||
to an
|
||||
.Ft uintmax_t
|
||||
value.
|
||||
The
|
||||
.Fn strtou
|
||||
function uses internally
|
||||
.Xr strtoumax 3
|
||||
and ensures that the result is always in the range [
|
||||
.Fa lo ..
|
||||
.Fa hi
|
||||
].
|
||||
In adddition it always places
|
||||
.Dv 0
|
||||
on success or a conversion status in the
|
||||
.Fa rstatus
|
||||
argument, avoiding the
|
||||
.Dv errno
|
||||
gymnastics the other functions require.
|
||||
The
|
||||
.Fa rstatus
|
||||
argument can be
|
||||
.Dv NULL
|
||||
if conversion status is to be ignored.
|
||||
.Pp
|
||||
The string may begin with an arbitrary amount of white space
|
||||
(as determined by
|
||||
.Xr isspace 3 )
|
||||
followed by a single optional
|
||||
.Ql +
|
||||
or
|
||||
.Ql -
|
||||
sign.
|
||||
If
|
||||
.Fa base
|
||||
is zero or 16,
|
||||
the string may then include a
|
||||
.Ql 0x
|
||||
or
|
||||
.Ql 0X
|
||||
prefix,
|
||||
and the number will be read in base 16; otherwise,
|
||||
.\" if the
|
||||
.\" .Fa base
|
||||
.\" is zero or 2,
|
||||
.\" the string may then include a
|
||||
.\" .Ql 0b
|
||||
.\" or
|
||||
.\" .Ql 0B
|
||||
.\" prefix,
|
||||
.\" and the number will be read in base 2; otherwise,
|
||||
a zero
|
||||
.Fa base
|
||||
is taken as 10 (decimal) unless the next character is
|
||||
.Ql 0 ,
|
||||
in which case it is taken as 8 (octal).
|
||||
.Pp
|
||||
The remainder of the string is converted to an
|
||||
.Em uintmax_t
|
||||
value in the obvious manner,
|
||||
stopping at the end of the string
|
||||
or at the first character that does not produce a valid digit
|
||||
in the given base.
|
||||
(In bases above 10, the letter
|
||||
.Ql A
|
||||
in either upper or lower case
|
||||
represents 10,
|
||||
.Ql B
|
||||
represents 11, and so forth, with
|
||||
.Ql Z
|
||||
representing 35.)
|
||||
.Pp
|
||||
If
|
||||
.Fa endptr
|
||||
is non-nil,
|
||||
.Fn strtou
|
||||
stores the address of the first invalid character in
|
||||
.Fa *endptr .
|
||||
If there were no digits at all, however,
|
||||
.Fn strtou
|
||||
stores the original value of
|
||||
.Fa nptr
|
||||
in
|
||||
.Fa *endptr .
|
||||
(Thus, if
|
||||
.Fa *nptr
|
||||
is not
|
||||
.Ql \e0
|
||||
but
|
||||
.Fa **endptr
|
||||
is
|
||||
.Ql \e0
|
||||
on return, the entire string was valid.)
|
||||
.Sh RETURN VALUES
|
||||
The
|
||||
.Fn strtou
|
||||
function
|
||||
always returns the closest value in the range specified by
|
||||
the
|
||||
.Fa lo
|
||||
and
|
||||
.Fa hi
|
||||
arguments.
|
||||
.Pp
|
||||
The
|
||||
.Va errno
|
||||
value is guaranteed to be left unchanged.
|
||||
.Pp
|
||||
Errors are stored as the conversion status in the
|
||||
.Fa rstatus
|
||||
argument.
|
||||
.Sh EXAMPLES
|
||||
The following example will always return a number in
|
||||
.Dv [1..99]
|
||||
range no matter what the input is, and warn if the conversion failed.
|
||||
.Bd -literal -offset indent
|
||||
int e;
|
||||
uintmax_t lval = strtou(buf, NULL, 0, 1, 99, &e);
|
||||
if (e)
|
||||
warnc(e, "conversion of `%s' to a number failed, using %ju",
|
||||
buf, lval);
|
||||
.Ed
|
||||
.Sh ERRORS
|
||||
.Bl -tag -width Er
|
||||
.It Bq Er ECANCELED
|
||||
The string did not contain any characters that were converted.
|
||||
.It Bq Er EINVAL
|
||||
The
|
||||
.Ar base
|
||||
is not between 2 and 36 and does not contain the special value 0.
|
||||
.It Bq Er ENOTSUP
|
||||
The string contained non-numeric characters that did not get converted.
|
||||
In this case,
|
||||
.Fa endptr
|
||||
points to the first unconverted character.
|
||||
.It Bq Er ERANGE
|
||||
The given string was out of range; the value converted has been clamped; or
|
||||
the range given was invalid, i.e.
|
||||
.Fa lo
|
||||
>
|
||||
.Fa hi .
|
||||
.El
|
||||
.Sh SEE ALSO
|
||||
.Xr atof 3 ,
|
||||
.Xr atoi 3 ,
|
||||
.Xr atol 3 ,
|
||||
.Xr atoll 3 ,
|
||||
.Xr strtod 3 ,
|
||||
.Xr strtoi 3bsd ,
|
||||
.Xr strtoimax 3 ,
|
||||
.Xr strtol 3 ,
|
||||
.Xr strtoll 3 ,
|
||||
.Xr strtoul 3 ,
|
||||
.Xr strtoull 3 ,
|
||||
.Xr strtoumax 3
|
||||
.Sh STANDARDS
|
||||
.ds doc-operating-system-NetBSD-7.0 7.0
|
||||
The
|
||||
.Fn strtou
|
||||
function is a
|
||||
.Nx
|
||||
extension.
|
||||
.Sh HISTORY
|
||||
The
|
||||
.Fn strtou
|
||||
function first appeared in
|
||||
.Nx 7.0 .
|
||||
.Ox
|
||||
introduced the
|
||||
.Fn strtonum 3bsd
|
||||
function for the same purpose, but the interface makes it impossible to
|
||||
properly differentiate illegal returns.
|
||||
.Sh BUGS
|
||||
Ignores the current locale.
|
@@ -47,6 +47,7 @@
|
||||
.Nd operations on time structure
|
||||
.Sh LIBRARY
|
||||
.ds str-Lb-libbsd Utility functions from BSD systems (libbsd, \-lbsd)
|
||||
.ds doc-str-Lb-libbsd \*[str-Lb-libbsd]
|
||||
.Lb libbsd
|
||||
.Sh SYNOPSIS
|
||||
.In sys/time.h
|
||||
|
1
man/timespec.3bsd
Normal file
1
man/timespec.3bsd
Normal file
@@ -0,0 +1 @@
|
||||
.so man3/timeval.3bsd
|
@@ -36,6 +36,7 @@
|
||||
.Nd time structures
|
||||
.Sh LIBRARY
|
||||
.ds str-Lb-libbsd Utility functions from BSD systems (libbsd, \-lbsd)
|
||||
.ds doc-str-Lb-libbsd \*[str-Lb-libbsd]
|
||||
.Lb libbsd
|
||||
.Sh SYNOPSIS
|
||||
.In sys/time.h
|
||||
|
395
man/tree.3bsd
395
man/tree.3bsd
@@ -1,36 +1,29 @@
|
||||
.\" $OpenBSD: tree.3,v 1.7 2002/06/12 01:09:20 provos Exp $
|
||||
.\"
|
||||
.\" Copyright 2002 Niels Provos <provos@citi.umich.edu>
|
||||
.\" 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. All advertising materials mentioning features or use of this software
|
||||
.\" must display the following acknowledgement:
|
||||
.\" This product includes software developed by Niels Provos.
|
||||
.\" 4. The name of the author may not be used to endorse or promote products
|
||||
.\" derived from this software without specific prior written permission.
|
||||
.\"
|
||||
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 AUTHOR 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.
|
||||
.\"
|
||||
.\" $FreeBSD$
|
||||
.\"
|
||||
.Dd December 27, 2007
|
||||
.\" $OpenBSD: tree.3,v 1.30 2019/05/10 13:13:14 florian Exp $
|
||||
.\"/*
|
||||
.\" * Copyright 2002 Niels Provos <provos@citi.umich.edu>
|
||||
.\" * 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.
|
||||
.\" *
|
||||
.\" * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 AUTHOR 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.
|
||||
.\" */
|
||||
.Dd May 10, 2019
|
||||
.Dt TREE 3bsd
|
||||
.Os
|
||||
.Sh NAME
|
||||
@@ -70,98 +63,108 @@
|
||||
.Nm RB_RIGHT ,
|
||||
.Nm RB_PARENT ,
|
||||
.Nm RB_FOREACH ,
|
||||
.Nm RB_FOREACH_SAFE ,
|
||||
.Nm RB_FOREACH_REVERSE ,
|
||||
.Nm RB_FOREACH_REVERSE_SAFE ,
|
||||
.Nm RB_INIT ,
|
||||
.Nm RB_INSERT ,
|
||||
.Nm RB_REMOVE
|
||||
.Nd implementations of splay and red-black trees
|
||||
.Sh LIBRARY
|
||||
.ds str-Lb-libbsd Utility functions from BSD systems (libbsd, \-lbsd)
|
||||
.ds doc-str-Lb-libbsd \*[str-Lb-libbsd]
|
||||
.Lb libbsd
|
||||
.Sh SYNOPSIS
|
||||
.In sys/tree.h
|
||||
(See
|
||||
.Xr libbsd 7
|
||||
for include usage.)
|
||||
.Fn SPLAY_PROTOTYPE NAME TYPE FIELD CMP
|
||||
.Fn SPLAY_GENERATE NAME TYPE FIELD CMP
|
||||
.Fn SPLAY_ENTRY TYPE
|
||||
.Fn SPLAY_HEAD HEADNAME TYPE
|
||||
.Pp
|
||||
.Fn SPLAY_PROTOTYPE "NAME" "TYPE" "FIELD" "CMP"
|
||||
.Fn SPLAY_GENERATE "NAME" "TYPE" "FIELD" "CMP"
|
||||
.Fn SPLAY_ENTRY "TYPE"
|
||||
.Fn SPLAY_HEAD "HEADNAME" "TYPE"
|
||||
.Ft "struct TYPE *"
|
||||
.Fn SPLAY_INITIALIZER "SPLAY_HEAD *head"
|
||||
.Fn SPLAY_ROOT "SPLAY_HEAD *head"
|
||||
.Ft bool
|
||||
.Ft "int"
|
||||
.Fn SPLAY_EMPTY "SPLAY_HEAD *head"
|
||||
.Ft "struct TYPE *"
|
||||
.Fn SPLAY_NEXT NAME "SPLAY_HEAD *head" "struct TYPE *elm"
|
||||
.Fn SPLAY_NEXT "NAME" "SPLAY_HEAD *head" "struct TYPE *elm"
|
||||
.Ft "struct TYPE *"
|
||||
.Fn SPLAY_MIN NAME "SPLAY_HEAD *head"
|
||||
.Fn SPLAY_MIN "NAME" "SPLAY_HEAD *head"
|
||||
.Ft "struct TYPE *"
|
||||
.Fn SPLAY_MAX NAME "SPLAY_HEAD *head"
|
||||
.Fn SPLAY_MAX "NAME" "SPLAY_HEAD *head"
|
||||
.Ft "struct TYPE *"
|
||||
.Fn SPLAY_FIND NAME "SPLAY_HEAD *head" "struct TYPE *elm"
|
||||
.Fn SPLAY_FIND "NAME" "SPLAY_HEAD *head" "struct TYPE *elm"
|
||||
.Ft "struct TYPE *"
|
||||
.Fn SPLAY_LEFT "struct TYPE *elm" "SPLAY_ENTRY NAME"
|
||||
.Ft "struct TYPE *"
|
||||
.Fn SPLAY_RIGHT "struct TYPE *elm" "SPLAY_ENTRY NAME"
|
||||
.Fn SPLAY_FOREACH VARNAME NAME "SPLAY_HEAD *head"
|
||||
.Fn SPLAY_FOREACH "VARNAME" "NAME" "SPLAY_HEAD *head"
|
||||
.Ft void
|
||||
.Fn SPLAY_INIT "SPLAY_HEAD *head"
|
||||
.Ft "struct TYPE *"
|
||||
.Fn SPLAY_INSERT NAME "SPLAY_HEAD *head" "struct TYPE *elm"
|
||||
.Fn SPLAY_INSERT "NAME" "SPLAY_HEAD *head" "struct TYPE *elm"
|
||||
.Ft "struct TYPE *"
|
||||
.Fn SPLAY_REMOVE NAME "SPLAY_HEAD *head" "struct TYPE *elm"
|
||||
.Fn RB_PROTOTYPE NAME TYPE FIELD CMP
|
||||
.Fn RB_PROTOTYPE_STATIC NAME TYPE FIELD CMP
|
||||
.Fn RB_GENERATE NAME TYPE FIELD CMP
|
||||
.Fn RB_GENERATE_STATIC NAME TYPE FIELD CMP
|
||||
.Fn RB_ENTRY TYPE
|
||||
.Fn RB_HEAD HEADNAME TYPE
|
||||
.Fn SPLAY_REMOVE "NAME" "SPLAY_HEAD *head" "struct TYPE *elm"
|
||||
.Pp
|
||||
.Fn RB_PROTOTYPE "NAME" "TYPE" "FIELD" "CMP"
|
||||
.Fn RB_PROTOTYPE_STATIC "NAME" "TYPE" "FIELD" "CMP"
|
||||
.Fn RB_GENERATE "NAME" "TYPE" "FIELD" "CMP"
|
||||
.Fn RB_GENERATE_STATIC "NAME" "TYPE" "FIELD" "CMP"
|
||||
.Fn RB_ENTRY "TYPE"
|
||||
.Fn RB_HEAD "HEADNAME" "TYPE"
|
||||
.Fn RB_INITIALIZER "RB_HEAD *head"
|
||||
.Ft "struct TYPE *"
|
||||
.Fn RB_ROOT "RB_HEAD *head"
|
||||
.Ft "bool"
|
||||
.Ft "int"
|
||||
.Fn RB_EMPTY "RB_HEAD *head"
|
||||
.Ft "struct TYPE *"
|
||||
.Fn RB_NEXT NAME "RB_HEAD *head" "struct TYPE *elm"
|
||||
.Fn RB_NEXT "NAME" "RB_HEAD *head" "struct TYPE *elm"
|
||||
.Ft "struct TYPE *"
|
||||
.Fn RB_PREV NAME "RB_HEAD *head" "struct TYPE *elm"
|
||||
.Fn RB_PREV "NAME" "RB_HEAD *head" "struct TYPE *elm"
|
||||
.Ft "struct TYPE *"
|
||||
.Fn RB_MIN NAME "RB_HEAD *head"
|
||||
.Fn RB_MIN "NAME" "RB_HEAD *head"
|
||||
.Ft "struct TYPE *"
|
||||
.Fn RB_MAX NAME "RB_HEAD *head"
|
||||
.Fn RB_MAX "NAME" "RB_HEAD *head"
|
||||
.Ft "struct TYPE *"
|
||||
.Fn RB_FIND NAME "RB_HEAD *head" "struct TYPE *elm"
|
||||
.Fn RB_FIND "NAME" "RB_HEAD *head" "struct TYPE *elm"
|
||||
.Ft "struct TYPE *"
|
||||
.Fn RB_NFIND NAME "RB_HEAD *head" "struct TYPE *elm"
|
||||
.Fn RB_NFIND "NAME" "RB_HEAD *head" "struct TYPE *elm"
|
||||
.Ft "struct TYPE *"
|
||||
.Fn RB_LEFT "struct TYPE *elm" "RB_ENTRY NAME"
|
||||
.Ft "struct TYPE *"
|
||||
.Fn RB_RIGHT "struct TYPE *elm" "RB_ENTRY NAME"
|
||||
.Ft "struct TYPE *"
|
||||
.Fn RB_PARENT "struct TYPE *elm" "RB_ENTRY NAME"
|
||||
.Fn RB_FOREACH VARNAME NAME "RB_HEAD *head"
|
||||
.Fn RB_FOREACH_REVERSE VARNAME NAME "RB_HEAD *head"
|
||||
.Fn RB_FOREACH "VARNAME" "NAME" "RB_HEAD *head"
|
||||
.Fn RB_FOREACH_SAFE "VARNAME" "NAME" "RB_HEAD *head" "TEMP_VARNAME"
|
||||
.Fn RB_FOREACH_REVERSE "VARNAME" "NAME" "RB_HEAD *head"
|
||||
.Fn RB_FOREACH_REVERSE_SAFE "VARNAME" "NAME" "RB_HEAD *head" "TEMP_VARNAME"
|
||||
.Ft void
|
||||
.Fn RB_INIT "RB_HEAD *head"
|
||||
.Ft "struct TYPE *"
|
||||
.Fn RB_INSERT NAME "RB_HEAD *head" "struct TYPE *elm"
|
||||
.Fn RB_INSERT "NAME" "RB_HEAD *head" "struct TYPE *elm"
|
||||
.Ft "struct TYPE *"
|
||||
.Fn RB_REMOVE NAME "RB_HEAD *head" "struct TYPE *elm"
|
||||
.Fn RB_REMOVE "NAME" "RB_HEAD *head" "struct TYPE *elm"
|
||||
.Sh DESCRIPTION
|
||||
These macros define data structures for different types of trees:
|
||||
splay trees and red-black trees.
|
||||
.Pp
|
||||
In the macro definitions,
|
||||
.Fa TYPE
|
||||
is the name tag of a user defined structure that must contain a field of type
|
||||
.Vt SPLAY_ENTRY ,
|
||||
is the name tag of a user defined structure that must contain a field named
|
||||
.Fa FIELD ,
|
||||
of type
|
||||
.Li SPLAY_ENTRY
|
||||
or
|
||||
.Vt RB_ENTRY ,
|
||||
named
|
||||
.Fa ENTRYNAME .
|
||||
.Li RB_ENTRY .
|
||||
The argument
|
||||
.Fa HEADNAME
|
||||
is the name tag of a user defined structure that must be declared
|
||||
using the macros
|
||||
.Fn SPLAY_HEAD ,
|
||||
.Fn SPLAY_HEAD
|
||||
or
|
||||
.Fn RB_HEAD .
|
||||
The argument
|
||||
@@ -169,46 +172,38 @@ The argument
|
||||
has to be a unique name prefix for every tree that is defined.
|
||||
.Pp
|
||||
The function prototypes are declared with
|
||||
.Fn SPLAY_PROTOTYPE ,
|
||||
.Fn RB_PROTOTYPE ,
|
||||
.Li SPLAY_PROTOTYPE ,
|
||||
.Li RB_PROTOTYPE ,
|
||||
or
|
||||
.Fn RB_PROTOTYPE_STATIC .
|
||||
.Li RB_PROTOTYPE_STATIC .
|
||||
The function bodies are generated with
|
||||
.Fn SPLAY_GENERATE ,
|
||||
.Fn RB_GENERATE ,
|
||||
.Li SPLAY_GENERATE ,
|
||||
.Li RB_GENERATE ,
|
||||
or
|
||||
.Fn RB_GENERATE_STATIC .
|
||||
.Li RB_GENERATE_STATIC .
|
||||
See the examples below for further explanation of how these macros are used.
|
||||
.Sh SPLAY TREES
|
||||
A splay tree is a self-organizing data structure.
|
||||
Every operation on the tree causes a splay to happen.
|
||||
The splay moves the requested
|
||||
node to the root of the tree and partly rebalances it.
|
||||
The splay moves the requested node to the root of the tree and partly
|
||||
rebalances it.
|
||||
.Pp
|
||||
This has the benefit that request locality causes faster lookups as
|
||||
the requested nodes move to the top of the tree.
|
||||
On the other hand, every lookup causes memory writes.
|
||||
.Pp
|
||||
The Balance Theorem bounds the total access time for
|
||||
.Ar m
|
||||
operations and
|
||||
.Ar n
|
||||
inserts on an initially empty tree as
|
||||
.Fn O "\*[lp]m + n\*[rp]lg n" .
|
||||
The
|
||||
amortized cost for a sequence of
|
||||
.Ar m
|
||||
accesses to a splay tree is
|
||||
.Fn O "lg n" .
|
||||
The Balance Theorem bounds the total access time for m operations
|
||||
and n inserts on an initially empty tree as O((m + n)lg n).
|
||||
The amortized cost for a sequence of m accesses to a splay tree is O(lg n).
|
||||
.Pp
|
||||
A splay tree is headed by a structure defined by the
|
||||
.Fn SPLAY_HEAD
|
||||
macro.
|
||||
A
|
||||
.Fa SPLAY_HEAD
|
||||
structure is declared as follows:
|
||||
.Bd -ragged -offset indent
|
||||
.Fn SPLAY_HEAD HEADNAME TYPE
|
||||
.Va head ;
|
||||
.Bd -literal -offset indent
|
||||
SPLAY_HEAD(HEADNAME, TYPE) head;
|
||||
.Ed
|
||||
.Pp
|
||||
where
|
||||
@@ -247,16 +242,15 @@ macro, but should be used only once.
|
||||
Finally,
|
||||
the
|
||||
.Fa CMP
|
||||
argument is the name of a function used to compare tree nodes
|
||||
argument is the name of a function used to compare trees' nodes
|
||||
with each other.
|
||||
The function takes two arguments of type
|
||||
.Vt "struct TYPE *" .
|
||||
.Fa "struct TYPE *" .
|
||||
If the first argument is smaller than the second, the function returns a
|
||||
value smaller than zero.
|
||||
If they are equal, the function returns zero.
|
||||
Otherwise, it should return a value greater than zero.
|
||||
The compare
|
||||
function defines the order of the tree elements.
|
||||
The compare function defines the order of the tree elements.
|
||||
.Pp
|
||||
The
|
||||
.Fn SPLAY_INIT
|
||||
@@ -266,11 +260,8 @@ macro initializes the tree referenced by
|
||||
The splay tree can also be initialized statically by using the
|
||||
.Fn SPLAY_INITIALIZER
|
||||
macro like this:
|
||||
.Bd -ragged -offset indent
|
||||
.Fn SPLAY_HEAD HEADNAME TYPE
|
||||
.Va head
|
||||
=
|
||||
.Fn SPLAY_INITIALIZER &head ;
|
||||
.Bd -literal -offset indent
|
||||
SPLAY_HEAD(HEADNAME, TYPE) head = SPLAY_INITIALIZER(&head);
|
||||
.Ed
|
||||
.Pp
|
||||
The
|
||||
@@ -278,6 +269,11 @@ The
|
||||
macro inserts the new element
|
||||
.Fa elm
|
||||
into the tree.
|
||||
Upon success,
|
||||
.Va NULL
|
||||
is returned.
|
||||
If a matching element already exists in the tree, the insertion is
|
||||
aborted, and a pointer to the existing element is returned.
|
||||
.Pp
|
||||
The
|
||||
.Fn SPLAY_REMOVE
|
||||
@@ -285,6 +281,11 @@ macro removes the element
|
||||
.Fa elm
|
||||
from the tree pointed by
|
||||
.Fa head .
|
||||
Upon success, a pointer to the removed element is returned.
|
||||
.Va NULL
|
||||
is returned if
|
||||
.Fa elm
|
||||
is not present in the tree.
|
||||
.Pp
|
||||
The
|
||||
.Fn SPLAY_FIND
|
||||
@@ -292,7 +293,7 @@ macro can be used to find a particular element in the tree.
|
||||
.Bd -literal -offset indent
|
||||
struct TYPE find, *res;
|
||||
find.key = 30;
|
||||
res = SPLAY_FIND(NAME, head, &find);
|
||||
res = SPLAY_FIND(NAME, &head, &find);
|
||||
.Ed
|
||||
.Pp
|
||||
The
|
||||
@@ -309,8 +310,8 @@ for (np = SPLAY_MIN(NAME, &head); np != NULL; np = SPLAY_NEXT(NAME, &head, np))
|
||||
Or, for simplicity, one can use the
|
||||
.Fn SPLAY_FOREACH
|
||||
macro:
|
||||
.Bd -ragged -offset indent
|
||||
.Fn SPLAY_FOREACH np NAME head
|
||||
.Bd -literal -offset indent
|
||||
SPLAY_FOREACH(np, NAME, &head)
|
||||
.Ed
|
||||
.Pp
|
||||
The
|
||||
@@ -320,29 +321,28 @@ macro should be used to check whether a splay tree is empty.
|
||||
A red-black tree is a binary search tree with the node color as an
|
||||
extra attribute.
|
||||
It fulfills a set of conditions:
|
||||
.Bl -enum -offset indent
|
||||
.Pp
|
||||
.Bl -enum -compact -offset indent
|
||||
.It
|
||||
Every search path from the root to a leaf consists of the same number of
|
||||
black nodes.
|
||||
every search path from the root to a leaf consists of the same number of
|
||||
black nodes,
|
||||
.It
|
||||
Each red node (except for the root) has a black parent.
|
||||
each red node (except for the root) has a black parent,
|
||||
.It
|
||||
Each leaf node is black.
|
||||
each leaf node is black.
|
||||
.El
|
||||
.Pp
|
||||
Every operation on a red-black tree is bounded as
|
||||
.Fn O "lg n" .
|
||||
The maximum height of a red-black tree is
|
||||
.Fn 2lg "n + 1" .
|
||||
Every operation on a red-black tree is bounded as O(lg n).
|
||||
The maximum height of a red-black tree is 2lg (n+1).
|
||||
.Pp
|
||||
A red-black tree is headed by a structure defined by the
|
||||
.Fn RB_HEAD
|
||||
macro.
|
||||
A
|
||||
.Fa RB_HEAD
|
||||
structure is declared as follows:
|
||||
.Bd -ragged -offset indent
|
||||
.Fn RB_HEAD HEADNAME TYPE
|
||||
.Va head ;
|
||||
.Bd -literal -offset indent
|
||||
RB_HEAD(HEADNAME, TYPE) head;
|
||||
.Ed
|
||||
.Pp
|
||||
where
|
||||
@@ -360,7 +360,7 @@ their prototypes need to be declared with the
|
||||
.Fn RB_PROTOTYPE
|
||||
or
|
||||
.Fn RB_PROTOTYPE_STATIC
|
||||
macro,
|
||||
macros,
|
||||
where
|
||||
.Fa NAME
|
||||
is a unique identifier for this particular tree.
|
||||
@@ -377,7 +377,7 @@ The function bodies are generated with the
|
||||
.Fn RB_GENERATE
|
||||
or
|
||||
.Fn RB_GENERATE_STATIC
|
||||
macro.
|
||||
macros.
|
||||
These macros take the same arguments as the
|
||||
.Fn RB_PROTOTYPE
|
||||
and
|
||||
@@ -387,16 +387,15 @@ macros, but should be used only once.
|
||||
Finally,
|
||||
the
|
||||
.Fa CMP
|
||||
argument is the name of a function used to compare tree nodes
|
||||
argument is the name of a function used to compare trees' nodes
|
||||
with each other.
|
||||
The function takes two arguments of type
|
||||
.Vt "struct TYPE *" .
|
||||
.Fa "struct TYPE *" .
|
||||
If the first argument is smaller than the second, the function returns a
|
||||
value smaller than zero.
|
||||
If they are equal, the function returns zero.
|
||||
Otherwise, it should return a value greater than zero.
|
||||
The compare
|
||||
function defines the order of the tree elements.
|
||||
The compare function defines the order of the tree elements.
|
||||
.Pp
|
||||
The
|
||||
.Fn RB_INIT
|
||||
@@ -406,11 +405,8 @@ macro initializes the tree referenced by
|
||||
The red-black tree can also be initialized statically by using the
|
||||
.Fn RB_INITIALIZER
|
||||
macro like this:
|
||||
.Bd -ragged -offset indent
|
||||
.Fn RB_HEAD HEADNAME TYPE
|
||||
.Va head
|
||||
=
|
||||
.Fn RB_INITIALIZER &head ;
|
||||
.Bd -literal -offset indent
|
||||
RB_HEAD(HEADNAME, TYPE) head = RB_INITIALIZER(&head);
|
||||
.Ed
|
||||
.Pp
|
||||
The
|
||||
@@ -418,6 +414,11 @@ The
|
||||
macro inserts the new element
|
||||
.Fa elm
|
||||
into the tree.
|
||||
Upon success,
|
||||
.Va NULL
|
||||
is returned.
|
||||
If a matching element already exists in the tree, the insertion is
|
||||
aborted, and a pointer to the existing element is returned.
|
||||
.Pp
|
||||
The
|
||||
.Fn RB_REMOVE
|
||||
@@ -425,16 +426,24 @@ macro removes the element
|
||||
.Fa elm
|
||||
from the tree pointed by
|
||||
.Fa head .
|
||||
.Fn RB_REMOVE
|
||||
returns
|
||||
.Fa elm .
|
||||
.Pp
|
||||
The
|
||||
.Fn RB_FIND
|
||||
and
|
||||
.Fn RB_NFIND
|
||||
macros can be used to find a particular element in the tree.
|
||||
.Fn RB_FIND
|
||||
finds the node with the same key as
|
||||
.Fa elm .
|
||||
.Fn RB_NFIND
|
||||
finds the first node greater than or equal to the search key.
|
||||
.Bd -literal -offset indent
|
||||
struct TYPE find, *res;
|
||||
find.key = 30;
|
||||
res = RB_FIND(NAME, head, &find);
|
||||
res = RB_FIND(NAME, &head, &find);
|
||||
.Ed
|
||||
.Pp
|
||||
The
|
||||
@@ -445,26 +454,119 @@ The
|
||||
and
|
||||
.Fn RB_PREV
|
||||
macros can be used to traverse the tree:
|
||||
.Pp
|
||||
.Dl "for (np = RB_MIN(NAME, &head); np != NULL; np = RB_NEXT(NAME, &head, np))"
|
||||
.Bd -literal -offset indent
|
||||
for (np = RB_MIN(NAME, &head); np != NULL; np = RB_NEXT(NAME, &head, np))
|
||||
.Ed
|
||||
.Pp
|
||||
Or, for simplicity, one can use the
|
||||
.Fn RB_FOREACH
|
||||
or
|
||||
.Fn RB_FOREACH_REVERSE
|
||||
macro:
|
||||
.Bd -ragged -offset indent
|
||||
.Fn RB_FOREACH np NAME head
|
||||
macros:
|
||||
.Bd -literal -offset indent
|
||||
RB_FOREACH(np, NAME, &head)
|
||||
.Ed
|
||||
.Pp
|
||||
The macros
|
||||
.Fn RB_FOREACH_SAFE
|
||||
and
|
||||
.Fn RB_FOREACH_REVERSE_SAFE
|
||||
traverse the tree referenced by head
|
||||
in a forward or reverse direction respectively,
|
||||
assigning each element in turn to np.
|
||||
However, unlike their unsafe counterparts,
|
||||
they permit both the removal of np
|
||||
as well as freeing it from within the loop safely
|
||||
without interfering with the traversal.
|
||||
.Pp
|
||||
The
|
||||
.Fn RB_EMPTY
|
||||
macro should be used to check whether a red-black tree is empty.
|
||||
.Sh EXAMPLES
|
||||
The following example demonstrates how to declare a red-black tree
|
||||
holding integers.
|
||||
Values are inserted into it and the contents of the tree are printed
|
||||
in order.
|
||||
Lastly, the internal structure of the tree is printed.
|
||||
.Bd -literal -offset 3n
|
||||
#include <sys/tree.h>
|
||||
#include <err.h>
|
||||
#include <stdio.h>
|
||||
#include <stdlib.h>
|
||||
|
||||
struct node {
|
||||
RB_ENTRY(node) entry;
|
||||
int i;
|
||||
};
|
||||
|
||||
int intcmp(struct node *, struct node *);
|
||||
void print_tree(struct node *);
|
||||
|
||||
int
|
||||
intcmp(struct node *e1, struct node *e2)
|
||||
{
|
||||
return (e1->i < e2->i ? -1 : e1->i > e2->i);
|
||||
}
|
||||
|
||||
RB_HEAD(inttree, node) head = RB_INITIALIZER(&head);
|
||||
RB_PROTOTYPE(inttree, node, entry, intcmp)
|
||||
RB_GENERATE(inttree, node, entry, intcmp)
|
||||
|
||||
int testdata[] = {
|
||||
20, 16, 17, 13, 3, 6, 1, 8, 2, 4, 10, 19, 5, 9, 12, 15, 18,
|
||||
7, 11, 14
|
||||
};
|
||||
|
||||
void
|
||||
print_tree(struct node *n)
|
||||
{
|
||||
struct node *left, *right;
|
||||
|
||||
if (n == NULL) {
|
||||
printf("nil");
|
||||
return;
|
||||
}
|
||||
left = RB_LEFT(n, entry);
|
||||
right = RB_RIGHT(n, entry);
|
||||
if (left == NULL && right == NULL)
|
||||
printf("%d", n->i);
|
||||
else {
|
||||
printf("%d(", n->i);
|
||||
print_tree(left);
|
||||
printf(",");
|
||||
print_tree(right);
|
||||
printf(")");
|
||||
}
|
||||
}
|
||||
|
||||
int
|
||||
main(void)
|
||||
{
|
||||
int i;
|
||||
struct node *n;
|
||||
|
||||
for (i = 0; i < sizeof(testdata) / sizeof(testdata[0]); i++) {
|
||||
if ((n = malloc(sizeof(struct node))) == NULL)
|
||||
err(1, NULL);
|
||||
n->i = testdata[i];
|
||||
RB_INSERT(inttree, &head, n);
|
||||
}
|
||||
|
||||
RB_FOREACH(n, inttree, &head) {
|
||||
printf("%d\en", n->i);
|
||||
}
|
||||
print_tree(RB_ROOT(&head));
|
||||
printf("\en");
|
||||
return (0);
|
||||
}
|
||||
.Ed
|
||||
.Sh SEE ALSO
|
||||
.Xr queue 3bsd
|
||||
.Sh NOTES
|
||||
Trying to free a tree in the following way is a common error:
|
||||
.Bd -literal -offset indent
|
||||
SPLAY_FOREACH(var, NAME, head) {
|
||||
SPLAY_REMOVE(NAME, head, var);
|
||||
SPLAY_FOREACH(var, NAME, &head) {
|
||||
SPLAY_REMOVE(NAME, &head, var);
|
||||
free(var);
|
||||
}
|
||||
free(head);
|
||||
@@ -472,36 +574,17 @@ free(head);
|
||||
.Pp
|
||||
Since
|
||||
.Va var
|
||||
is freed, the
|
||||
is free'd, the
|
||||
.Fn FOREACH
|
||||
macro refers to a pointer that may have been reallocated already.
|
||||
Proper code needs a second variable.
|
||||
.Bd -literal -offset indent
|
||||
for (var = SPLAY_MIN(NAME, head); var != NULL; var = nxt) {
|
||||
nxt = SPLAY_NEXT(NAME, head, var);
|
||||
SPLAY_REMOVE(NAME, head, var);
|
||||
for (var = SPLAY_MIN(NAME, &head); var != NULL; var = nxt) {
|
||||
nxt = SPLAY_NEXT(NAME, &head, var);
|
||||
SPLAY_REMOVE(NAME, &head, var);
|
||||
free(var);
|
||||
}
|
||||
.Ed
|
||||
.Pp
|
||||
Both
|
||||
.Fn RB_INSERT
|
||||
and
|
||||
.Fn SPLAY_INSERT
|
||||
return
|
||||
.Dv NULL
|
||||
if the element was inserted in the tree successfully, otherwise they
|
||||
return a pointer to the element with the colliding key.
|
||||
.Pp
|
||||
Accordingly,
|
||||
.Fn RB_REMOVE
|
||||
and
|
||||
.Fn SPLAY_REMOVE
|
||||
return the pointer to the removed element otherwise they return
|
||||
.Dv NULL
|
||||
to indicate an error.
|
||||
.Sh SEE ALSO
|
||||
.Xr queue 3bsd
|
||||
.Sh AUTHORS
|
||||
The author of the tree macros is
|
||||
.An Niels Provos .
|
||||
|
1
man/uid_from_user.3bsd
Normal file
1
man/uid_from_user.3bsd
Normal file
@@ -0,0 +1 @@
|
||||
.so man3/pwcache.3bsd
|
202
man/unvis.3bsd
202
man/unvis.3bsd
@@ -1,4 +1,4 @@
|
||||
.\" $OpenBSD: unvis.3,v 1.15 2005/07/22 03:16:58 jaredy Exp $
|
||||
.\" $NetBSD: unvis.3,v 1.29 2017/10/24 19:14:55 abhinav Exp $
|
||||
.\"
|
||||
.\" Copyright (c) 1989, 1991, 1993
|
||||
.\" The Regents of the University of California. All rights reserved.
|
||||
@@ -27,16 +27,21 @@
|
||||
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
||||
.\" SUCH DAMAGE.
|
||||
.\"
|
||||
.Dd $Mdocdate: May 31 2007 $
|
||||
.\" @(#)unvis.3 8.2 (Berkeley) 12/11/93
|
||||
.\"
|
||||
.Dd March 12, 2011
|
||||
.Dt UNVIS 3bsd
|
||||
.Os
|
||||
.Sh NAME
|
||||
.Nm unvis ,
|
||||
.Nm strunvis ,
|
||||
.Nm strnunvis
|
||||
.Nm strnunvis ,
|
||||
.Nm strunvisx ,
|
||||
.Nm strnunvisx
|
||||
.Nd decode a visual representation of characters
|
||||
.Sh LIBRARY
|
||||
.ds str-Lb-libbsd Utility functions from BSD systems (libbsd, \-lbsd)
|
||||
.ds doc-str-Lb-libbsd \*[str-Lb-libbsd]
|
||||
.Lb libbsd
|
||||
.Sh SYNOPSIS
|
||||
.In vis.h
|
||||
@@ -44,88 +49,91 @@
|
||||
.Xr libbsd 7
|
||||
for include usage.)
|
||||
.Ft int
|
||||
.Fn unvis "char *cp" "char c" "int *astate" "int flag"
|
||||
.Fn unvis "char *cp" "int c" "int *astate" "int flag"
|
||||
.Ft int
|
||||
.Fn strunvis "char *dst" "char *src"
|
||||
.Ft ssize_t
|
||||
.Fn strnunvis "char *dst" "char *src" "size_t size"
|
||||
.Fn strunvis "char *dst" "const char *src"
|
||||
.Ft int
|
||||
.Fn strnunvis "char *dst" "size_t dlen" "const char *src"
|
||||
.Ft int
|
||||
.Fn strunvisx "char *dst" "const char *src" "int flag"
|
||||
.Ft int
|
||||
.Fn strnunvisx "char *dst" "size_t dlen" "const char *src" "int flag"
|
||||
.Sh DESCRIPTION
|
||||
The
|
||||
.Fn unvis ,
|
||||
.Fn strunvis
|
||||
and
|
||||
.Fn strnunvis
|
||||
functions are used to decode a visual representation of characters,
|
||||
as produced by the
|
||||
.Fn strunvisx
|
||||
functions
|
||||
are used to decode a visual representation of characters, as produced
|
||||
by the
|
||||
.Xr vis 3bsd
|
||||
function, back into the original form.
|
||||
function, back into
|
||||
the original form.
|
||||
.Pp
|
||||
The
|
||||
.Fn unvis
|
||||
is called with successive characters in
|
||||
.Fa c
|
||||
until a valid
|
||||
sequence is recognized, at which time the decoded character is
|
||||
available at the character pointed to by
|
||||
.Fa cp .
|
||||
function is called with successive characters in
|
||||
.Ar c
|
||||
until a valid sequence is recognized, at which time the decoded
|
||||
character is available at the character pointed to by
|
||||
.Ar cp .
|
||||
.Pp
|
||||
The
|
||||
.Fn strunvis
|
||||
decodes the characters pointed to by
|
||||
.Fa src
|
||||
function decodes the characters pointed to by
|
||||
.Ar src
|
||||
into the buffer pointed to by
|
||||
.Fa dst .
|
||||
.Pp
|
||||
.Fn strnunvis
|
||||
decodes the characters pointed to by
|
||||
.Fa src
|
||||
into the buffer pointed to by
|
||||
.Fa dst ,
|
||||
writing a maximum of
|
||||
.Fa size
|
||||
bytes.
|
||||
.Ar dst .
|
||||
The
|
||||
.Fn strunvis
|
||||
function simply copies
|
||||
.Fa src
|
||||
.Ar src
|
||||
to
|
||||
.Fa dst ,
|
||||
.Ar dst ,
|
||||
decoding any escape sequences along the way,
|
||||
and returns the number of characters placed into
|
||||
.Fa dst ,
|
||||
.Ar dst ,
|
||||
or \-1 if an
|
||||
invalid escape sequence was detected.
|
||||
The size of
|
||||
.Fa dst
|
||||
should be
|
||||
equal to the size of
|
||||
.Fa src
|
||||
.Ar dst
|
||||
should be equal to the size of
|
||||
.Ar src
|
||||
(that is, no expansion takes place during decoding).
|
||||
.Pp
|
||||
The
|
||||
.Fn strunvisx
|
||||
function does the same as the
|
||||
.Fn strunvis
|
||||
terminates the destination string with a trailing NUL byte;
|
||||
.Fn strnunvis
|
||||
does so if
|
||||
.Fa size
|
||||
is larger than 0.
|
||||
function,
|
||||
but it allows you to add a flag that specifies the style the string
|
||||
.Ar src
|
||||
is encoded with.
|
||||
Currently, the supported flags are:
|
||||
.Dv VIS_HTTPSTYLE
|
||||
and
|
||||
.Dv VIS_MIMESTYLE .
|
||||
.Pp
|
||||
The
|
||||
.Fn unvis
|
||||
function implements a state machine that can be used to decode an arbitrary
|
||||
stream of bytes.
|
||||
function implements a state machine that can be used to decode an
|
||||
arbitrary stream of bytes.
|
||||
All state associated with the bytes being decoded is stored outside the
|
||||
.Fn unvis
|
||||
function (that is, a pointer to the state is passed in), so
|
||||
calls decoding different streams can be freely intermixed.
|
||||
To start decoding a stream of bytes, first initialize an integer
|
||||
to zero.
|
||||
To start decoding a stream of bytes, first initialize an integer to zero.
|
||||
Call
|
||||
.Fn unvis
|
||||
with each successive byte, along with a pointer
|
||||
to this integer, and a pointer to a destination character.
|
||||
.Sh RETURN VALUES
|
||||
The
|
||||
.Fn unvis
|
||||
function has several return codes that must be handled properly.
|
||||
They are:
|
||||
.Bl -tag -width UNVIS_VALIDPUSH
|
||||
.It Li \&0 (zero)
|
||||
.It Li \&0 No (zero)
|
||||
Another character is necessary; nothing has been recognized yet.
|
||||
.It Dv UNVIS_VALID
|
||||
A valid character has been recognized and is available at the location
|
||||
@@ -140,30 +148,41 @@ however, the character currently passed in should be passed in again.
|
||||
A valid sequence was detected, but no character was produced.
|
||||
This return code is necessary to indicate a logical break between characters.
|
||||
.It Dv UNVIS_SYNBAD
|
||||
An invalid escape sequence was detected, or the decoder is in an
|
||||
unknown state.
|
||||
An invalid escape sequence was detected, or the decoder is in an unknown state.
|
||||
The decoder is placed into the starting state.
|
||||
.El
|
||||
.Pp
|
||||
When all bytes in the stream have been processed, call
|
||||
.Fn unvis
|
||||
one more time with
|
||||
.Fa flag
|
||||
set to
|
||||
one more time with flag set to
|
||||
.Dv UNVIS_END
|
||||
to extract any remaining character (the character passed in is ignored).
|
||||
.Pp
|
||||
The
|
||||
.Fn strunvis
|
||||
function returns the number of bytes written (not counting
|
||||
the trailing NUL byte) or \-1 if an error occurred.
|
||||
.Fa flag
|
||||
argument is also used to specify the encoding style of the source.
|
||||
If set to
|
||||
.Dv VIS_HTTPSTYLE
|
||||
or
|
||||
.Dv VIS_HTTP1808 ,
|
||||
.Fn unvis
|
||||
will decode URI strings as specified in RFC 1808.
|
||||
If set to
|
||||
.Dv VIS_HTTP1866 ,
|
||||
.Fn unvis
|
||||
will decode entity references and numeric character references
|
||||
as specified in RFC 1866.
|
||||
If set to
|
||||
.Dv VIS_MIMESTYLE ,
|
||||
.Fn unvis
|
||||
will decode MIME Quoted-Printable strings as specified in RFC 2045.
|
||||
If set to
|
||||
.Dv VIS_NOESCAPE ,
|
||||
.Fn unvis
|
||||
will not decode
|
||||
.Ql \e
|
||||
quoted characters.
|
||||
.Pp
|
||||
The
|
||||
.Fn strnunvis
|
||||
function returns the number of bytes (not counting the trailing NUL byte)
|
||||
that would be needed to fully convert the input string, or \-1 if an
|
||||
error occurred.
|
||||
.Sh EXAMPLES
|
||||
The following code fragment illustrates a proper use of
|
||||
.Fn unvis .
|
||||
.Bd -literal -offset indent
|
||||
@@ -177,25 +196,72 @@ again:
|
||||
case UNVIS_NOCHAR:
|
||||
break;
|
||||
case UNVIS_VALID:
|
||||
(void) putchar(out);
|
||||
(void)putchar(out);
|
||||
break;
|
||||
case UNVIS_VALIDPUSH:
|
||||
(void) putchar(out);
|
||||
(void)putchar(out);
|
||||
goto again;
|
||||
case UNVIS_SYNBAD:
|
||||
(void)fprintf(stderr, "bad sequence!\en");
|
||||
exit(1);
|
||||
errx(EXIT_FAILURE, "Bad character sequence!");
|
||||
}
|
||||
}
|
||||
if (unvis(&out, (char)0, &state, UNVIS_END) == UNVIS_VALID)
|
||||
(void) putchar(out);
|
||||
if (unvis(&out, '\e0', &state, UNVIS_END) == UNVIS_VALID)
|
||||
(void)putchar(out);
|
||||
.Ed
|
||||
.Sh ERRORS
|
||||
The functions
|
||||
.Fn strunvis ,
|
||||
.Fn strnunvis ,
|
||||
.Fn strunvisx ,
|
||||
and
|
||||
.Fn strnunvisx
|
||||
will return \-1 on error and set
|
||||
.Va errno
|
||||
to:
|
||||
.Bl -tag -width Er
|
||||
.It Bq Er EINVAL
|
||||
An invalid escape sequence was detected, or the decoder is in an unknown state.
|
||||
.El
|
||||
.Pp
|
||||
In addition the functions
|
||||
.Fn strnunvis
|
||||
and
|
||||
.Fn strnunvisx
|
||||
will can also set
|
||||
.Va errno
|
||||
on error to:
|
||||
.Bl -tag -width Er
|
||||
.It Bq Er ENOSPC
|
||||
Not enough space to perform the conversion.
|
||||
.El
|
||||
.Sh SEE ALSO
|
||||
.Xr unvis 1 ,
|
||||
.Xr vis 1 ,
|
||||
.Xr vis 3bsd
|
||||
.Rs
|
||||
.%A R. Fielding
|
||||
.%T Relative Uniform Resource Locators
|
||||
.%O RFC1808
|
||||
.Re
|
||||
.Sh HISTORY
|
||||
The
|
||||
.Fn unvis
|
||||
function first appeared in
|
||||
function
|
||||
first appeared in
|
||||
.Bx 4.4 .
|
||||
The
|
||||
.Fn strnunvis
|
||||
and
|
||||
.Fn strnunvisx
|
||||
functions appeared in
|
||||
.Nx 6.0 .
|
||||
.Sh BUGS
|
||||
The names
|
||||
.Dv VIS_HTTP1808
|
||||
and
|
||||
.Dv VIS_HTTP1866
|
||||
are wrong.
|
||||
Percent-encoding was defined in RFC 1738, the original RFC for URL.
|
||||
RFC 1866 defines HTML 2.0, an application of SGML, from which it
|
||||
inherits concepts of numeric character references and entity
|
||||
references.
|
||||
|
1
man/user_from_uid.3bsd
Normal file
1
man/user_from_uid.3bsd
Normal file
@@ -0,0 +1 @@
|
||||
.so man3/pwcache.3bsd
|
446
man/vis.3bsd
446
man/vis.3bsd
@@ -1,4 +1,4 @@
|
||||
.\" $OpenBSD: vis.3,v 1.23 2005/08/28 19:51:27 millert Exp $
|
||||
.\" $NetBSD: vis.3,v 1.49 2017/08/05 20:22:29 wiz Exp $
|
||||
.\"
|
||||
.\" Copyright (c) 1989, 1991, 1993
|
||||
.\" The Regents of the University of California. All rights reserved.
|
||||
@@ -27,53 +27,88 @@
|
||||
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
||||
.\" SUCH DAMAGE.
|
||||
.\"
|
||||
.Dd $Mdocdate: May 31 2007 $
|
||||
.\" @(#)vis.3 8.1 (Berkeley) 6/9/93
|
||||
.\"
|
||||
.Dd April 22, 2017
|
||||
.Dt VIS 3bsd
|
||||
.Os
|
||||
.Sh NAME
|
||||
.Nm vis ,
|
||||
.Nm nvis ,
|
||||
.Nm strvis ,
|
||||
.Nm stravis ,
|
||||
.Nm strnvis ,
|
||||
.Nm strvisx
|
||||
.Nm strvisx ,
|
||||
.Nm strnvisx ,
|
||||
.Nm strenvisx ,
|
||||
.Nm svis ,
|
||||
.Nm snvis ,
|
||||
.Nm strsvis ,
|
||||
.Nm strsnvis ,
|
||||
.Nm strsvisx ,
|
||||
.Nm strsnvisx ,
|
||||
.Nm strsenvisx
|
||||
.Nd visually encode characters
|
||||
.Sh LIBRARY
|
||||
.ds str-Lb-libbsd Utility functions from BSD systems (libbsd, \-lbsd)
|
||||
.ds doc-str-Lb-libbsd \*[str-Lb-libbsd]
|
||||
.Lb libbsd
|
||||
.Sh SYNOPSIS
|
||||
.In stdlib.h
|
||||
.In vis.h
|
||||
(See
|
||||
.Xr libbsd 7
|
||||
for include usage.)
|
||||
.Ft char *
|
||||
.Fn vis "char *dst" "int c" "int flag" "int nextc"
|
||||
.Ft char *
|
||||
.Fn nvis "char *dst" "size_t dlen" "int c" "int flag" "int nextc"
|
||||
.Ft int
|
||||
.Fn strvis "char *dst" "const char *src" "int flag"
|
||||
.Ft int
|
||||
.Fn strnvis "char *dst" "const char *src" "size_t size" "int flag"
|
||||
.Fn stravis "char **dst" "const char *src" "int flag"
|
||||
.Ft int
|
||||
.Fn strnvis "char *dst" "size_t dlen" "const char *src" "int flag"
|
||||
.Ft int
|
||||
.Fn strvisx "char *dst" "const char *src" "size_t len" "int flag"
|
||||
.Ft int
|
||||
.Fn strnvisx "char *dst" "size_t dlen" "const char *src" "size_t len" "int flag"
|
||||
.Ft int
|
||||
.Fn strenvisx "char *dst" "size_t dlen" "const char *src" "size_t len" "int flag" "int *cerr_ptr"
|
||||
.Ft char *
|
||||
.Fn svis "char *dst" "int c" "int flag" "int nextc" "const char *extra"
|
||||
.Ft char *
|
||||
.Fn snvis "char *dst" "size_t dlen" "int c" "int flag" "int nextc" "const char *extra"
|
||||
.Ft int
|
||||
.Fn strsvis "char *dst" "const char *src" "int flag" "const char *extra"
|
||||
.Ft int
|
||||
.Fn strsnvis "char *dst" "size_t dlen" "const char *src" "int flag" "const char *extra"
|
||||
.Ft int
|
||||
.Fn strsvisx "char *dst" "const char *src" "size_t len" "int flag" "const char *extra"
|
||||
.Ft int
|
||||
.Fn strsnvisx "char *dst" "size_t dlen" "const char *src" "size_t len" "int flag" "const char *extra"
|
||||
.Ft int
|
||||
.Fn strsenvisx "char *dst" "size_t dlen" "const char *src" "size_t len" "int flag" "const char *extra" "int *cerr_ptr"
|
||||
.Sh DESCRIPTION
|
||||
The
|
||||
.Fn vis
|
||||
function copies into
|
||||
function
|
||||
copies into
|
||||
.Fa dst
|
||||
a string which represents the character
|
||||
.Fa c .
|
||||
If
|
||||
.Fa c
|
||||
needs no encoding, it is copied in unaltered.
|
||||
The string is NUL terminated and a pointer to the end of the string is
|
||||
The string is null terminated, and a pointer to the end of the string is
|
||||
returned.
|
||||
The maximum length of any encoding is four
|
||||
characters (not including the trailing NUL);
|
||||
bytes (not including the trailing
|
||||
.Dv NUL ) ;
|
||||
thus, when
|
||||
encoding a set of characters into a buffer, the size of the buffer should
|
||||
be four times the number of characters encoded, plus one for the trailing
|
||||
NUL.
|
||||
The
|
||||
.Fa flag
|
||||
parameter is used for altering the default range of
|
||||
be four times the number of bytes encoded, plus one for the trailing
|
||||
.Dv NUL .
|
||||
The flag parameter is used for altering the default range of
|
||||
characters considered for encoding and for altering the visual
|
||||
representation.
|
||||
The additional character,
|
||||
@@ -84,9 +119,11 @@ encoding format (explained below).
|
||||
.Pp
|
||||
The
|
||||
.Fn strvis ,
|
||||
.Fn strnvis
|
||||
.Fn stravis ,
|
||||
.Fn strnvis ,
|
||||
.Fn strvisx ,
|
||||
and
|
||||
.Fn strvisx
|
||||
.Fn strnvisx
|
||||
functions copy into
|
||||
.Fa dst
|
||||
a visual representation of
|
||||
@@ -94,89 +131,153 @@ the string
|
||||
.Fa src .
|
||||
The
|
||||
.Fn strvis
|
||||
function encodes characters from
|
||||
.Fa src
|
||||
up to the first NUL.
|
||||
The
|
||||
and
|
||||
.Fn strnvis
|
||||
function encodes characters from
|
||||
functions encode characters from
|
||||
.Fa src
|
||||
up to the first NUL or the end of
|
||||
.Fa dst ,
|
||||
as indicated by
|
||||
.Fa size .
|
||||
up to the
|
||||
first
|
||||
.Dv NUL .
|
||||
The
|
||||
.Fn strvisx
|
||||
function encodes exactly
|
||||
and
|
||||
.Fn strnvisx
|
||||
functions encode exactly
|
||||
.Fa len
|
||||
characters from
|
||||
.Fa src
|
||||
(this
|
||||
is useful for encoding a block of data that may contain NULs).
|
||||
All three forms NUL terminate
|
||||
.Fa dst ,
|
||||
except for
|
||||
.Fn strnvis
|
||||
when
|
||||
.Fa size
|
||||
is zero, in which case
|
||||
.Fa dst
|
||||
is not touched.
|
||||
For
|
||||
.Fn strvis
|
||||
and
|
||||
.Fn strvisx ,
|
||||
the size of
|
||||
is useful for encoding a block of data that may contain
|
||||
.Dv NUL Ns 's ) .
|
||||
Both forms
|
||||
.Dv NUL
|
||||
terminate
|
||||
.Fa dst .
|
||||
The size of
|
||||
.Fa dst
|
||||
must be four times the number
|
||||
of characters encoded from
|
||||
of bytes encoded from
|
||||
.Fa src
|
||||
(plus one for the NUL).
|
||||
.Fn strvis
|
||||
(plus one for the
|
||||
.Dv NUL ) .
|
||||
Both
|
||||
forms return the number of characters in
|
||||
.Fa dst
|
||||
(not including the trailing
|
||||
.Dv NUL ) .
|
||||
The
|
||||
.Fn stravis
|
||||
function allocates space dynamically to hold the string.
|
||||
The
|
||||
.Dq Nm n
|
||||
versions of the functions also take an additional argument
|
||||
.Fa dlen
|
||||
that indicates the length of the
|
||||
.Fa dst
|
||||
buffer.
|
||||
If
|
||||
.Fa dlen
|
||||
is not large enough to fit the converted string then the
|
||||
.Fn strnvis
|
||||
and
|
||||
.Fn strvisx
|
||||
return the number of characters in
|
||||
.Fa dst
|
||||
(not including the trailing NUL).
|
||||
.Fn strnvis
|
||||
returns the length that
|
||||
.Fa dst
|
||||
would become if it were of unlimited size (similar to
|
||||
.Xr snprintf 3
|
||||
or
|
||||
.Xr strlcpy 3bsd ) .
|
||||
This can be used to detect truncation but it also means that
|
||||
the return value of
|
||||
.Fn strnvis
|
||||
must not be used without checking it against
|
||||
.Fa size .
|
||||
.Fn strnvisx
|
||||
functions return \-1 and set
|
||||
.Va errno
|
||||
to
|
||||
.Dv ENOSPC .
|
||||
The
|
||||
.Fn strenvisx
|
||||
function takes an additional argument,
|
||||
.Fa cerr_ptr ,
|
||||
that is used to pass in and out a multibyte conversion error flag.
|
||||
This is useful when processing single characters at a time when
|
||||
it is possible that the locale may be set to something other
|
||||
than the locale of the characters in the input data.
|
||||
.Pp
|
||||
The functions
|
||||
.Fn svis ,
|
||||
.Fn snvis ,
|
||||
.Fn strsvis ,
|
||||
.Fn strsnvis ,
|
||||
.Fn strsvisx ,
|
||||
.Fn strsnvisx ,
|
||||
and
|
||||
.Fn strsenvisx
|
||||
correspond to
|
||||
.Fn vis ,
|
||||
.Fn nvis ,
|
||||
.Fn strvis ,
|
||||
.Fn strnvis ,
|
||||
.Fn strvisx ,
|
||||
.Fn strnvisx ,
|
||||
and
|
||||
.Fn strenvisx
|
||||
but have an additional argument
|
||||
.Fa extra ,
|
||||
pointing to a
|
||||
.Dv NUL
|
||||
terminated list of characters.
|
||||
These characters will be copied encoded or backslash-escaped into
|
||||
.Fa dst .
|
||||
These functions are useful e.g. to remove the special meaning
|
||||
of certain characters to shells.
|
||||
.Pp
|
||||
The encoding is a unique, invertible representation composed entirely of
|
||||
graphic characters; it can be decoded back into the original form using
|
||||
the
|
||||
.Xr unvis 3bsd
|
||||
or
|
||||
.Xr unvis 3bsd ,
|
||||
.Xr strunvis 3bsd
|
||||
or
|
||||
.Xr strnunvis 3bsd
|
||||
functions.
|
||||
.Pp
|
||||
There are two parameters that can be controlled: the range of
|
||||
characters that are encoded, and the type
|
||||
of representation used.
|
||||
By default, all non-graphic characters
|
||||
except space, tab, and newline are encoded
|
||||
(see
|
||||
characters that are encoded (applies only to
|
||||
.Fn vis ,
|
||||
.Fn nvis ,
|
||||
.Fn strvis ,
|
||||
.Fn strnvis ,
|
||||
.Fn strvisx ,
|
||||
and
|
||||
.Fn strnvisx ) ,
|
||||
and the type of representation used.
|
||||
By default, all non-graphic characters,
|
||||
except space, tab, and newline are encoded (see
|
||||
.Xr isgraph 3 ) .
|
||||
The following flags
|
||||
alter this:
|
||||
.Bl -tag -width VIS_WHITEX
|
||||
.It Dv VIS_DQ
|
||||
Also encode double quotes
|
||||
.It Dv VIS_GLOB
|
||||
Also encode magic characters recognized by
|
||||
.Xr glob 3
|
||||
.Pf ( Ql * ,
|
||||
Also encode the magic characters
|
||||
.Ql ( * ,
|
||||
.Ql \&? ,
|
||||
.Ql \&[ )
|
||||
.Ql \&[ ,
|
||||
and
|
||||
.Ql # .
|
||||
.Ql # )
|
||||
recognized by
|
||||
.Xr glob 3 .
|
||||
.It Dv VIS_SHELL
|
||||
Also encode the meta characters used by shells (in addition to the glob
|
||||
characters):
|
||||
.Ql ( ' ,
|
||||
.Ql ` ,
|
||||
.Ql \&" ,
|
||||
.Ql \&; ,
|
||||
.Ql & ,
|
||||
.Ql < ,
|
||||
.Ql > ,
|
||||
.Ql \&( ,
|
||||
.Ql \&) ,
|
||||
.Ql \&| ,
|
||||
.Ql \&] ,
|
||||
.Ql \e ,
|
||||
.Ql $ ,
|
||||
.Ql \&! ,
|
||||
.Ql \&^ ,
|
||||
and
|
||||
.Ql ~ ) .
|
||||
.It Dv VIS_SP
|
||||
Also encode space.
|
||||
.It Dv VIS_TAB
|
||||
@@ -185,34 +286,56 @@ Also encode tab.
|
||||
Also encode newline.
|
||||
.It Dv VIS_WHITE
|
||||
Synonym for
|
||||
.Dv VIS_SP
|
||||
\&|
|
||||
.Dv VIS_TAB
|
||||
\&|
|
||||
.Dv VIS_NL .
|
||||
.Dv VIS_SP | VIS_TAB | VIS_NL .
|
||||
.It Dv VIS_META
|
||||
Synonym for
|
||||
.Dv VIS_WHITE | VIS_GLOB | VIS_SHELL .
|
||||
.It Dv VIS_SAFE
|
||||
Only encode
|
||||
.Dq unsafe
|
||||
characters.
|
||||
These are control characters which may cause common terminals to perform
|
||||
Unsafe means control characters which may cause common terminals to perform
|
||||
unexpected functions.
|
||||
Currently this form allows space,
|
||||
tab, newline, backspace, bell, and return -- in addition
|
||||
to all graphic characters -- unencoded.
|
||||
Currently this form allows space, tab, newline, backspace, bell, and
|
||||
return \(em in addition to all graphic characters \(em unencoded.
|
||||
.El
|
||||
.Pp
|
||||
There are three forms of encoding.
|
||||
All forms use the backslash
|
||||
(The above flags have no effect for
|
||||
.Fn svis ,
|
||||
.Fn snvis ,
|
||||
.Fn strsvis ,
|
||||
.Fn strsnvis ,
|
||||
.Fn strsvisx ,
|
||||
and
|
||||
.Fn strsnvisx .
|
||||
When using these functions, place all graphic characters to be
|
||||
encoded in an array pointed to by
|
||||
.Fa extra .
|
||||
In general, the backslash character should be included in this array, see the
|
||||
warning on the use of the
|
||||
.Dv VIS_NOSLASH
|
||||
flag below).
|
||||
.Pp
|
||||
There are six forms of encoding.
|
||||
All forms use the backslash character
|
||||
.Ql \e
|
||||
character to introduce a special
|
||||
sequence; two backslashes are used to represent a real backslash.
|
||||
to introduce a special
|
||||
sequence; two backslashes are used to represent a real backslash,
|
||||
except
|
||||
.Dv VIS_HTTPSTYLE
|
||||
that uses
|
||||
.Ql % ,
|
||||
or
|
||||
.Dv VIS_MIMESTYLE
|
||||
that uses
|
||||
.Ql = .
|
||||
These are the visual formats:
|
||||
.Bl -tag -width VIS_CSTYLE
|
||||
.It (default)
|
||||
Use an
|
||||
.Ql M
|
||||
to represent meta characters (characters with the 8th
|
||||
bit set), and use a caret
|
||||
bit set), and use caret
|
||||
.Ql ^
|
||||
to represent control characters (see
|
||||
.Xr iscntrl 3 ) .
|
||||
@@ -256,27 +379,27 @@ space.
|
||||
.It Dv \e240
|
||||
Represents Meta-space.
|
||||
.El
|
||||
.Pp
|
||||
.It Dv VIS_CSTYLE
|
||||
Use C-style backslash sequences to represent standard non-printable
|
||||
characters.
|
||||
The following sequences are used to represent the indicated characters:
|
||||
.Bd -unfilled -offset indent
|
||||
.Li \ea Tn - BEL No (007)
|
||||
.Li \eb Tn - BS No (010)
|
||||
.Li \ef Tn - NP No (014)
|
||||
.Li \en Tn - NL No (012)
|
||||
.Li \er Tn - CR No (015)
|
||||
.Li \es Tn - SP No (040)
|
||||
.Li \et Tn - HT No (011)
|
||||
.Li \ev Tn - VT No (013)
|
||||
.Li \e0 Tn - NUL No (000)
|
||||
.Li \ea Tn \(em BEL No (007)
|
||||
.Li \eb Tn \(em BS No (010)
|
||||
.Li \ef Tn \(em NP No (014)
|
||||
.Li \en Tn \(em NL No (012)
|
||||
.Li \er Tn \(em CR No (015)
|
||||
.Li \es Tn \(em SP No (040)
|
||||
.Li \et Tn \(em HT No (011)
|
||||
.Li \ev Tn \(em VT No (013)
|
||||
.Li \e0 Tn \(em NUL No (000)
|
||||
.Ed
|
||||
.Pp
|
||||
When using this format, the
|
||||
.Fa nextc
|
||||
parameter is looked at to determine
|
||||
if a NUL character can be encoded as
|
||||
parameter is looked at to determine if a
|
||||
.Dv NUL
|
||||
character can be encoded as
|
||||
.Ql \e0
|
||||
instead of
|
||||
.Ql \e000 .
|
||||
@@ -284,13 +407,36 @@ If
|
||||
.Fa nextc
|
||||
is an octal digit, the latter representation is used to
|
||||
avoid ambiguity.
|
||||
.Pp
|
||||
Non-printable characters without C-style
|
||||
backslash sequences use the default representation.
|
||||
.It Dv VIS_OCTAL
|
||||
Use a three digit octal sequence.
|
||||
The form is
|
||||
.Ql \eddd
|
||||
where
|
||||
.Ar d
|
||||
.Em d
|
||||
represents an octal digit.
|
||||
.It Dv VIS_CSTYLE \&| Dv VIS_OCTAL
|
||||
Same as
|
||||
.Dv VIS_CSTYLE
|
||||
except that non-printable characters without C-style
|
||||
backslash sequences use a three digit octal sequence.
|
||||
.It Dv VIS_HTTPSTYLE
|
||||
Use URI encoding as described in RFC 1738.
|
||||
The form is
|
||||
.Ql %xx
|
||||
where
|
||||
.Em x
|
||||
represents a lower case hexadecimal digit.
|
||||
.It Dv VIS_MIMESTYLE
|
||||
Use MIME Quoted-Printable encoding as described in RFC 2045, only don't
|
||||
break lines and don't handle CRLF.
|
||||
The form is
|
||||
.Ql =XX
|
||||
where
|
||||
.Em X
|
||||
represents an upper case hexadecimal digit.
|
||||
.El
|
||||
.Pp
|
||||
There is one additional flag,
|
||||
@@ -304,21 +450,113 @@ meta characters as
|
||||
.Ql M-C ) .
|
||||
With this flag set, the encoding is
|
||||
ambiguous and non-invertible.
|
||||
.Sh MULTIBYTE CHARACTER SUPPORT
|
||||
These functions support multibyte character input.
|
||||
The encoding conversion is influenced by the setting of the
|
||||
.Ev LC_CTYPE
|
||||
environment variable which defines the set of characters
|
||||
that can be copied without encoding.
|
||||
.Pp
|
||||
If
|
||||
.Dv VIS_NOLOCALE
|
||||
is set, processing is done assuming the C locale and overriding
|
||||
any other environment settings.
|
||||
.Pp
|
||||
When 8-bit data is present in the input,
|
||||
.Ev LC_CTYPE
|
||||
must be set to the correct locale or to the C locale.
|
||||
If the locales of the data and the conversion are mismatched,
|
||||
multibyte character recognition may fail and encoding will be performed
|
||||
byte-by-byte instead.
|
||||
.Pp
|
||||
As noted above,
|
||||
.Fa dst
|
||||
must be four times the number of bytes processed from
|
||||
.Fa src .
|
||||
But note that each multibyte character can be up to
|
||||
.Dv MB_LEN_MAX
|
||||
bytes
|
||||
.\" (see
|
||||
.\" .Xr multibyte 3 )
|
||||
so in terms of multibyte characters,
|
||||
.Fa dst
|
||||
must be four times
|
||||
.Dv MB_LEN_MAX
|
||||
times the number of characters processed from
|
||||
.Fa src .
|
||||
.Sh ENVIRONMENT
|
||||
.Bl -tag -width ".Ev LC_CTYPE"
|
||||
.It Ev LC_CTYPE
|
||||
Specify the locale of the input data.
|
||||
Set to C if the input data locale is unknown.
|
||||
.El
|
||||
.Sh ERRORS
|
||||
The functions
|
||||
.Fn nvis
|
||||
and
|
||||
.Fn snvis
|
||||
will return
|
||||
.Dv NULL
|
||||
and the functions
|
||||
.Fn strnvis ,
|
||||
.Fn strnvisx ,
|
||||
.Fn strsnvis ,
|
||||
and
|
||||
.Fn strsnvisx ,
|
||||
will return \-1 when the
|
||||
.Fa dlen
|
||||
destination buffer size is not enough to perform the conversion while
|
||||
setting
|
||||
.Va errno
|
||||
to:
|
||||
.Bl -tag -width ".Bq Er ENOSPC"
|
||||
.It Bq Er ENOSPC
|
||||
The destination buffer size is not large enough to perform the conversion.
|
||||
.El
|
||||
.Sh SEE ALSO
|
||||
.Xr unvis 1 ,
|
||||
.Xr vis 1 ,
|
||||
.Xr snprintf 3 ,
|
||||
.Xr strlcpy 3bsd ,
|
||||
.Xr glob 3 ,
|
||||
.\" .Xr multibyte 3 ,
|
||||
.Xr unvis 3bsd
|
||||
.Rs
|
||||
.%A T. Berners-Lee
|
||||
.%T Uniform Resource Locators (URL)
|
||||
.%O "RFC 1738"
|
||||
.Re
|
||||
.Rs
|
||||
.%T "Multipurpose Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies"
|
||||
.%O "RFC 2045"
|
||||
.Re
|
||||
.Sh HISTORY
|
||||
.ds doc-operating-system-NetBSD-7.0 7.0
|
||||
The
|
||||
.Fn vis ,
|
||||
.Fn strvis
|
||||
.Fn strvis ,
|
||||
and
|
||||
.Fn strvisx
|
||||
functions first appeared in
|
||||
.Bx 4.4 .
|
||||
The
|
||||
.Fn strnvis
|
||||
function first appeared in
|
||||
.Ox 2.9 .
|
||||
.Fn svis ,
|
||||
.Fn strsvis ,
|
||||
and
|
||||
.Fn strsvisx
|
||||
functions appeared in
|
||||
.Nx 1.5 .
|
||||
The buffer size limited versions of the functions
|
||||
.Po Fn nvis ,
|
||||
.Fn strnvis ,
|
||||
.Fn strnvisx ,
|
||||
.Fn snvis ,
|
||||
.Fn strsnvis ,
|
||||
and
|
||||
.Fn strsnvisx Pc
|
||||
appeared in
|
||||
.Nx 6.0
|
||||
and
|
||||
.Fx 9.2 .
|
||||
Multibyte character support was added in
|
||||
.Nx 7.0
|
||||
and
|
||||
.Fx 9.2 .
|
||||
|
@@ -44,6 +44,7 @@
|
||||
.Nd wide character string manipulation operations
|
||||
.Sh LIBRARY
|
||||
.ds str-Lb-libbsd Utility functions from BSD systems (libbsd, \-lbsd)
|
||||
.ds doc-str-Lb-libbsd \*[str-Lb-libbsd]
|
||||
.Lb libbsd
|
||||
.Sh SYNOPSIS
|
||||
.In wchar.h
|
||||
|
@@ -7,8 +7,14 @@ AM_CPPFLAGS = \
|
||||
-DLIBBSD_OVERLAY -DLIBBSD_DISABLE_DEPRECATED \
|
||||
-D__REENTRANT
|
||||
|
||||
if OS_WINDOWS
|
||||
AM_CPPFLAGS += \
|
||||
-D_CRT_SECURE_NO_WARNINGS \
|
||||
-D_CRT_NONSTDC_NO_WARNINGS \
|
||||
$(nil)
|
||||
endif
|
||||
|
||||
libbsd_la_included_sources = \
|
||||
hash/helper.c \
|
||||
getentropy_aix.c \
|
||||
getentropy_bsd.c \
|
||||
getentropy_hpux.c \
|
||||
@@ -16,8 +22,10 @@ libbsd_la_included_sources = \
|
||||
getentropy_linux.c \
|
||||
getentropy_osx.c \
|
||||
getentropy_solaris.c \
|
||||
getentropy_win.c \
|
||||
$(nil)
|
||||
|
||||
CLEANFILES =
|
||||
EXTRA_DIST = \
|
||||
libbsd.map \
|
||||
libbsd.pc.in \
|
||||
@@ -26,10 +34,6 @@ EXTRA_DIST = \
|
||||
$(libbsd_la_included_sources) \
|
||||
$(nil)
|
||||
|
||||
CLEANFILES = \
|
||||
hash/md5hl.c \
|
||||
$(nil)
|
||||
|
||||
pkgconfigdir = $(libdir)/pkgconfig
|
||||
pkgconfig_DATA = \
|
||||
libbsd.pc \
|
||||
@@ -45,24 +49,27 @@ pkgconfig_DATA += libbsd-ctor.pc
|
||||
lib_LIBRARIES += libbsd-ctor.a
|
||||
endif
|
||||
|
||||
hash/md5hl.c: $(srcdir)/hash/helper.c
|
||||
$(AM_V_at) $(MKDIR_P) hash
|
||||
$(AM_V_GEN) sed -e 's:hashinc:md5.h:g' -e 's:HASH:MD5:g' $< > $@
|
||||
|
||||
libbsd_la_DEPENDENCIES = \
|
||||
$(libbsd_la_included_sources) \
|
||||
libbsd.map
|
||||
libbsd_la_LIBADD = \
|
||||
$(CLOCK_GETTIME_LIBS)
|
||||
$(MD5_LIBS) \
|
||||
$(LIBBSD_LIBS) \
|
||||
$(nil)
|
||||
libbsd_la_LDFLAGS = \
|
||||
-Wl,--version-script=$(srcdir)/libbsd.map \
|
||||
-version-number $(LIBBSD_ABI)
|
||||
if HAVE_LINKER_VERSION_SCRIPT
|
||||
libbsd_la_LDFLAGS += \
|
||||
-Wl,--version-script=$(srcdir)/libbsd.map
|
||||
endif
|
||||
libbsd_la_SOURCES = \
|
||||
arc4random.c \
|
||||
arc4random.h \
|
||||
arc4random_unix.h \
|
||||
arc4random_linux.h \
|
||||
arc4random_openbsd.h \
|
||||
arc4random_uniform.c \
|
||||
arc4random_unix.h \
|
||||
arc4random_win.h \
|
||||
bsd_getopt.c \
|
||||
chacha_private.h \
|
||||
closefrom.c \
|
||||
@@ -71,6 +78,7 @@ libbsd_la_SOURCES = \
|
||||
expand_number.c \
|
||||
explicit_bzero.c \
|
||||
fgetln.c \
|
||||
freezero.c \
|
||||
fgetwln.c \
|
||||
flopen.c \
|
||||
fmtcheck.c \
|
||||
@@ -79,23 +87,22 @@ libbsd_la_SOURCES = \
|
||||
funopen.c \
|
||||
getbsize.c \
|
||||
getpeereid.c \
|
||||
hash/md5.c \
|
||||
hash/md5hl.c \
|
||||
hash/sha512.h \
|
||||
hash/sha512c.c \
|
||||
heapsort.c \
|
||||
humanize_number.c \
|
||||
inet_net_pton.c \
|
||||
local-elf.h \
|
||||
local-link.h \
|
||||
md5.c \
|
||||
merge.c \
|
||||
nlist.c \
|
||||
pidfile.c \
|
||||
progname.c \
|
||||
pwcache.c \
|
||||
radixsort.c \
|
||||
readpassphrase.c \
|
||||
reallocarray.c \
|
||||
reallocf.c \
|
||||
recallocarray.c \
|
||||
setmode.c \
|
||||
setproctitle.c \
|
||||
strlcat.c \
|
||||
@@ -103,7 +110,9 @@ libbsd_la_SOURCES = \
|
||||
stringlist.c \
|
||||
strmode.c \
|
||||
strnstr.c \
|
||||
strtoi.c \
|
||||
strtonum.c \
|
||||
strtou.c \
|
||||
timeconv.c \
|
||||
unvis.c \
|
||||
vis.c \
|
||||
@@ -117,22 +126,51 @@ libbsd_la_SOURCES += \
|
||||
$(nil)
|
||||
endif
|
||||
|
||||
if NEED_TRANSPARENT_LIBMD
|
||||
CLEANFILES += \
|
||||
format.ld \
|
||||
# EOL
|
||||
endif
|
||||
|
||||
libbsd_ctor_a_SOURCES = \
|
||||
setproctitle_ctor.c \
|
||||
$(nil)
|
||||
|
||||
if NEED_TRANSPARENT_LIBMD
|
||||
TRANSPARENT_LIBMD_DEPENDS = format.ld
|
||||
|
||||
format.ld:
|
||||
$(CC) -shared -nostdlib -nostartfiles -x assembler /dev/null -o $@.so
|
||||
objdump -f $@.so | sed -n 's/.*file format \(.*\)/OUTPUT_FORMAT(\1)/;T;p' > $@
|
||||
rm -f $@.so
|
||||
endif
|
||||
|
||||
runtimelibdir = $(libdir)
|
||||
|
||||
install-exec-hook:
|
||||
install-exec-hook: $(TRANSPARENT_LIBMD_DEPENDS)
|
||||
if [ "$(libdir)" != "$(runtimelibdir)" ]; then \
|
||||
$(MKDIR_P) $(DESTDIR)$(runtimelibdir); \
|
||||
mv $(DESTDIR)$(libdir)/libbsd*.so.* \
|
||||
$(DESTDIR)$(runtimelibdir)/; \
|
||||
fi
|
||||
if NEED_TRANSPARENT_LIBMD
|
||||
# The "GNU ld script" magic is required so that GNU ldconfig does not complain
|
||||
# about an unknown format file.
|
||||
soname=`readlink $(DESTDIR)$(libdir)/libbsd.so`; \
|
||||
$(RM) $(DESTDIR)$(libdir)/libbsd.so; \
|
||||
(echo '/* GNU ld script'; \
|
||||
echo ' * The MD5 functions are provided by the libmd library. */'; \
|
||||
cat format.ld; \
|
||||
echo "GROUP($(runtimelibdir)/$$soname AS_NEEDED($(MD5_LIBS)))"; \
|
||||
)>$(DESTDIR)$(libdir)/libbsd.so
|
||||
else
|
||||
if [ "$(libdir)" != "$(runtimelibdir)" ]; then \
|
||||
soname=`readlink $(DESTDIR)$(libdir)/libbsd.so`; \
|
||||
sorelprefix=`echo $(libdir) | sed -r -e 's:(^/)?[^/]+:..:g'`; \
|
||||
sorelprefix=`echo $(libdir) | $(SED) -r -e 's:(^/)?[^/]+:..:g'`; \
|
||||
ln -sf $$sorelprefix$(runtimelibdir)/$$soname \
|
||||
$(DESTDIR)$(libdir)/libbsd.so; \
|
||||
fi
|
||||
endif
|
||||
|
||||
uninstall-hook:
|
||||
rm -f $(DESTDIR)$(runtimelibdir)/libbsd*.so*
|
||||
|
@@ -39,11 +39,11 @@
|
||||
|
||||
#define minimum(a, b) ((a) < (b) ? (a) : (b))
|
||||
|
||||
#if defined(__GNUC__) || defined(_MSC_VER)
|
||||
#if defined(__GNUC__) || defined(__clang__) || defined(_MSC_VER)
|
||||
#define inline __inline
|
||||
#else /* __GNUC__ || _MSC_VER */
|
||||
#else /* __GNUC__ || __clang__ || _MSC_VER */
|
||||
#define inline
|
||||
#endif /* !__GNUC__ && !_MSC_VER */
|
||||
#endif /* !__GNUC__ && !__clang__ && !_MSC_VER */
|
||||
|
||||
#define KEYSZ 32
|
||||
#define IVSZ 8
|
||||
|
@@ -34,6 +34,10 @@ getentropy(void *buf, size_t len);
|
||||
|
||||
#if defined(__OpenBSD__)
|
||||
#include "arc4random_openbsd.h"
|
||||
#elif defined(__linux__)
|
||||
#include "arc4random_linux.h"
|
||||
#elif defined(_WIN32)
|
||||
#include "arc4random_win.h"
|
||||
#else
|
||||
#include "arc4random_unix.h"
|
||||
#endif
|
||||
|
88
src/arc4random_linux.h
Normal file
88
src/arc4random_linux.h
Normal file
@@ -0,0 +1,88 @@
|
||||
/* $OpenBSD: arc4random_linux.h,v 1.11 2016/06/30 12:19:51 bcook Exp $ */
|
||||
|
||||
/*
|
||||
* Copyright (c) 1996, David Mazieres <dm@uun.org>
|
||||
* Copyright (c) 2008, Damien Miller <djm@openbsd.org>
|
||||
* Copyright (c) 2013, Markus Friedl <markus@openbsd.org>
|
||||
* Copyright (c) 2014, Theo de Raadt <deraadt@openbsd.org>
|
||||
*
|
||||
* Permission to use, copy, modify, and distribute this software for any
|
||||
* purpose with or without fee is hereby granted, provided that the above
|
||||
* copyright notice and this permission notice appear in all copies.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
||||
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
||||
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
||||
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
||||
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
||||
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
||||
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
||||
*/
|
||||
|
||||
/*
|
||||
* Stub functions for portability.
|
||||
*/
|
||||
|
||||
#include <sys/mman.h>
|
||||
|
||||
#include <pthread.h>
|
||||
#include <signal.h>
|
||||
|
||||
static pthread_mutex_t arc4random_mtx = PTHREAD_MUTEX_INITIALIZER;
|
||||
#define _ARC4_LOCK() pthread_mutex_lock(&arc4random_mtx)
|
||||
#define _ARC4_UNLOCK() pthread_mutex_unlock(&arc4random_mtx)
|
||||
|
||||
#ifdef HAVE___REGISTER_ATFORK
|
||||
extern void *__dso_handle;
|
||||
extern int __register_atfork(void (*)(void), void(*)(void), void (*)(void), void *);
|
||||
#define _ARC4_ATFORK(f) __register_atfork(NULL, NULL, (f), __dso_handle)
|
||||
#else
|
||||
#define _ARC4_ATFORK(f) pthread_atfork(NULL, NULL, (f))
|
||||
#endif
|
||||
|
||||
static inline void
|
||||
_getentropy_fail(void)
|
||||
{
|
||||
raise(SIGKILL);
|
||||
}
|
||||
|
||||
static volatile sig_atomic_t _rs_forked;
|
||||
|
||||
static inline void
|
||||
_rs_forkhandler(void)
|
||||
{
|
||||
_rs_forked = 1;
|
||||
}
|
||||
|
||||
static inline void
|
||||
_rs_forkdetect(void)
|
||||
{
|
||||
static pid_t _rs_pid = 0;
|
||||
pid_t pid = getpid();
|
||||
|
||||
/* XXX unusual calls to clone() can bypass checks */
|
||||
if (_rs_pid == 0 || _rs_pid == 1 || _rs_pid != pid || _rs_forked) {
|
||||
_rs_pid = pid;
|
||||
_rs_forked = 0;
|
||||
if (rs)
|
||||
memset(rs, 0, sizeof(*rs));
|
||||
}
|
||||
}
|
||||
|
||||
static inline int
|
||||
_rs_allocate(struct _rs **rsp, struct _rsx **rsxp)
|
||||
{
|
||||
if ((*rsp = mmap(NULL, sizeof(**rsp), PROT_READ|PROT_WRITE,
|
||||
MAP_ANON|MAP_PRIVATE, -1, 0)) == MAP_FAILED)
|
||||
return (-1);
|
||||
|
||||
if ((*rsxp = mmap(NULL, sizeof(**rsxp), PROT_READ|PROT_WRITE,
|
||||
MAP_ANON|MAP_PRIVATE, -1, 0)) == MAP_FAILED) {
|
||||
munmap(*rsp, sizeof(**rsp));
|
||||
*rsp = NULL;
|
||||
return (-1);
|
||||
}
|
||||
|
||||
_ARC4_ATFORK(_rs_forkhandler);
|
||||
return (0);
|
||||
}
|
@@ -1,4 +1,4 @@
|
||||
/* $OpenBSD: arc4random_linux.h,v 1.8 2014/08/13 06:04:10 deraadt Exp $ */
|
||||
/* $OpenBSD: arc4random_freebsd.h,v 1.4 2016/06/30 12:19:51 bcook Exp $ */
|
||||
|
||||
/*
|
||||
* Copyright (c) 1996, David Mazieres <dm@uun.org>
|
||||
@@ -32,7 +32,7 @@ static pthread_mutex_t arc4random_mtx = PTHREAD_MUTEX_INITIALIZER;
|
||||
#define _ARC4_LOCK() pthread_mutex_lock(&arc4random_mtx)
|
||||
#define _ARC4_UNLOCK() pthread_mutex_unlock(&arc4random_mtx)
|
||||
|
||||
#ifdef __GLIBC__
|
||||
#ifdef HAVE___REGISTER_ATFORK
|
||||
extern void *__dso_handle;
|
||||
extern int __register_atfork(void (*)(void), void(*)(void), void (*)(void), void *);
|
||||
#define _ARC4_ATFORK(f) __register_atfork(NULL, NULL, (f), __dso_handle)
|
||||
@@ -84,6 +84,7 @@ _rs_allocate(struct _rs **rsp, struct _rsx **rsxp)
|
||||
if ((*rsxp = mmap(NULL, sizeof(**rsxp), PROT_READ|PROT_WRITE,
|
||||
MAP_ANON|MAP_PRIVATE, -1, 0)) == MAP_FAILED) {
|
||||
munmap(*rsp, sizeof(**rsp));
|
||||
*rsp = NULL;
|
||||
return (-1);
|
||||
}
|
||||
|
||||
|
78
src/arc4random_win.h
Normal file
78
src/arc4random_win.h
Normal file
@@ -0,0 +1,78 @@
|
||||
/* $OpenBSD: arc4random_win.h,v 1.6 2016/06/30 12:17:29 bcook Exp $ */
|
||||
|
||||
/*
|
||||
* Copyright (c) 1996, David Mazieres <dm@uun.org>
|
||||
* Copyright (c) 2008, Damien Miller <djm@openbsd.org>
|
||||
* Copyright (c) 2013, Markus Friedl <markus@openbsd.org>
|
||||
* Copyright (c) 2014, Theo de Raadt <deraadt@openbsd.org>
|
||||
*
|
||||
* Permission to use, copy, modify, and distribute this software for any
|
||||
* purpose with or without fee is hereby granted, provided that the above
|
||||
* copyright notice and this permission notice appear in all copies.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
||||
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
||||
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
||||
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
||||
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
||||
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
||||
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
||||
*/
|
||||
|
||||
/*
|
||||
* Stub functions for portability.
|
||||
*/
|
||||
|
||||
#include <windows.h>
|
||||
|
||||
static volatile HANDLE arc4random_mtx = NULL;
|
||||
|
||||
/*
|
||||
* Initialize the mutex on the first lock attempt. On collision, each thread
|
||||
* will attempt to allocate a mutex and compare-and-swap it into place as the
|
||||
* global mutex. On failure to swap in the global mutex, the mutex is closed.
|
||||
*/
|
||||
#define _ARC4_LOCK() { \
|
||||
if (!arc4random_mtx) { \
|
||||
HANDLE p = CreateMutex(NULL, FALSE, NULL); \
|
||||
if (InterlockedCompareExchangePointer((void **)&arc4random_mtx, (void *)p, NULL)) \
|
||||
CloseHandle(p); \
|
||||
} \
|
||||
WaitForSingleObject(arc4random_mtx, INFINITE); \
|
||||
} \
|
||||
|
||||
#define _ARC4_UNLOCK() ReleaseMutex(arc4random_mtx)
|
||||
|
||||
static inline void
|
||||
_getentropy_fail(void)
|
||||
{
|
||||
TerminateProcess(GetCurrentProcess(), 0);
|
||||
}
|
||||
|
||||
static inline int
|
||||
_rs_allocate(struct _rs **rsp, struct _rsx **rsxp)
|
||||
{
|
||||
*rsp = VirtualAlloc(NULL, sizeof(**rsp),
|
||||
MEM_RESERVE | MEM_COMMIT, PAGE_READWRITE);
|
||||
if (*rsp == NULL)
|
||||
return (-1);
|
||||
|
||||
*rsxp = VirtualAlloc(NULL, sizeof(**rsxp),
|
||||
MEM_RESERVE | MEM_COMMIT, PAGE_READWRITE);
|
||||
if (*rsxp == NULL) {
|
||||
VirtualFree(*rsp, 0, MEM_RELEASE);
|
||||
*rsp = NULL;
|
||||
return (-1);
|
||||
}
|
||||
return (0);
|
||||
}
|
||||
|
||||
static inline void
|
||||
_rs_forkhandler(void)
|
||||
{
|
||||
}
|
||||
|
||||
static inline void
|
||||
_rs_forkdetect(void)
|
||||
{
|
||||
}
|
@@ -4,7 +4,7 @@ D. J. Bernstein
|
||||
Public domain.
|
||||
*/
|
||||
|
||||
/* $OpenBSD$ */
|
||||
/* $OpenBSD: chacha_private.h,v 1.2 2013/10/04 07:02:27 djm Exp $ */
|
||||
|
||||
typedef unsigned char u8;
|
||||
typedef unsigned int u32;
|
||||
|
117
src/closefrom.c
117
src/closefrom.c
@@ -1,6 +1,8 @@
|
||||
/*
|
||||
* Copyright (c) 2004-2005, 2007, 2010, 2012-2014
|
||||
* Todd C. Miller <Todd.Miller@courtesan.com>
|
||||
* SPDX-License-Identifier: ISC
|
||||
*
|
||||
* Copyright (c) 2004-2005, 2007, 2010, 2012-2015, 2017-2018
|
||||
* Todd C. Miller <Todd.Miller@sudo.ws>
|
||||
*
|
||||
* Permission to use, copy, modify, and distribute this software for any
|
||||
* purpose with or without fee is hereby granted, provided that the above
|
||||
@@ -17,19 +19,17 @@
|
||||
|
||||
#include <config.h>
|
||||
|
||||
#include <sys/types.h>
|
||||
#include <unistd.h>
|
||||
#include <stdio.h>
|
||||
#ifdef STDC_HEADERS
|
||||
# include <stdlib.h>
|
||||
# include <stddef.h>
|
||||
#else
|
||||
# ifdef HAVE_STDLIB_H
|
||||
# include <stdlib.h>
|
||||
#ifdef __linux__
|
||||
# include <sys/syscall.h>
|
||||
# if defined(__NR_close_range) && !defined(SYS_close_range)
|
||||
# define SYS_close_range __NR_close_range
|
||||
# endif
|
||||
#endif /* STDC_HEADERS */
|
||||
#endif
|
||||
#include <errno.h>
|
||||
#include <fcntl.h>
|
||||
#include <limits.h>
|
||||
#include <stdlib.h>
|
||||
#include <unistd.h>
|
||||
#ifdef HAVE_PSTAT_GETPROC
|
||||
# include <sys/param.h>
|
||||
# include <sys/pstat.h>
|
||||
@@ -56,10 +56,6 @@
|
||||
# define OPEN_MAX 256
|
||||
#endif
|
||||
|
||||
#if defined(HAVE_FCNTL_CLOSEM) && !defined(HAVE_DIRFD)
|
||||
# define closefrom closefrom_fallback
|
||||
#endif
|
||||
|
||||
static inline void
|
||||
closefrom_close(int fd)
|
||||
{
|
||||
@@ -71,56 +67,64 @@ closefrom_close(int fd)
|
||||
#endif
|
||||
}
|
||||
|
||||
#if defined(__linux__) && defined(SYS_close_range)
|
||||
static inline int
|
||||
sys_close_range(unsigned int fd, unsigned int max_fd, unsigned int flags)
|
||||
{
|
||||
return syscall(SYS_close_range, fd, max_fd, flags);
|
||||
}
|
||||
#endif
|
||||
|
||||
/*
|
||||
* Close all file descriptors greater than or equal to lowfd.
|
||||
* This is the expensive (fallback) method.
|
||||
*/
|
||||
void
|
||||
static void
|
||||
closefrom_fallback(int lowfd)
|
||||
{
|
||||
long fd, maxfd;
|
||||
|
||||
/*
|
||||
* Fall back on sysconf() or getdtablesize(). We avoid checking
|
||||
* resource limits since it is possible to open a file descriptor
|
||||
* and then drop the rlimit such that it is below the open fd.
|
||||
* Fall back on sysconf(_SC_OPEN_MAX) or getdtablesize(). This is
|
||||
* equivalent to checking the RLIMIT_NOFILE soft limit. It is
|
||||
* possible for there to be open file descriptors past this limit
|
||||
* but there is not much we can do about that since the hard limit
|
||||
* may be RLIM_INFINITY (LLONG_MAX or ULLONG_MAX on modern systems).
|
||||
*/
|
||||
#ifdef HAVE_SYSCONF
|
||||
maxfd = sysconf(_SC_OPEN_MAX);
|
||||
#else
|
||||
maxfd = getdtablesize();
|
||||
#endif /* HAVE_SYSCONF */
|
||||
if (maxfd < 0)
|
||||
if (maxfd < OPEN_MAX)
|
||||
maxfd = OPEN_MAX;
|
||||
|
||||
/* Make sure we did not get RLIM_INFINITY as the upper limit. */
|
||||
if (maxfd > INT_MAX)
|
||||
maxfd = INT_MAX;
|
||||
|
||||
for (fd = lowfd; fd < maxfd; fd++)
|
||||
closefrom_close(fd);
|
||||
}
|
||||
|
||||
/*
|
||||
* Close all file descriptors greater than or equal to lowfd.
|
||||
* We try the fast way first, falling back on the slow method.
|
||||
*/
|
||||
#if defined(HAVE_FCNTL_CLOSEM)
|
||||
void
|
||||
closefrom(int lowfd)
|
||||
#if defined(HAVE_PSTAT_GETPROC)
|
||||
static int
|
||||
closefrom_pstat(int lowfd)
|
||||
{
|
||||
if (fcntl(lowfd, F_CLOSEM, 0) == -1)
|
||||
closefrom_fallback(lowfd);
|
||||
}
|
||||
#elif defined(HAVE_PSTAT_GETPROC)
|
||||
void
|
||||
closefrom(int lowfd)
|
||||
{
|
||||
struct pst_status pstat;
|
||||
struct pst_status pst;
|
||||
int fd;
|
||||
|
||||
if (pstat_getproc(&pstat, sizeof(pstat), 0, getpid()) != -1) {
|
||||
for (fd = lowfd; fd <= pstat.pst_highestfd; fd++)
|
||||
/*
|
||||
* EOVERFLOW is not a fatal error for the fields we use.
|
||||
* See the "EOVERFLOW Error" section of pstat_getvminfo(3).
|
||||
*/
|
||||
if (pstat_getproc(&pst, sizeof(pst), 0, getpid()) != -1 ||
|
||||
errno == EOVERFLOW) {
|
||||
for (fd = lowfd; fd <= pst.pst_highestfd; fd++)
|
||||
(void)close(fd);
|
||||
} else {
|
||||
closefrom_fallback(lowfd);
|
||||
return 0;
|
||||
}
|
||||
return -1;
|
||||
}
|
||||
#elif defined(HAVE_DIRFD)
|
||||
static int
|
||||
@@ -135,8 +139,8 @@ closefrom_procfs(int lowfd)
|
||||
int ret = 0;
|
||||
int i;
|
||||
|
||||
/* Use /proc/self/fd (or /dev/fd on FreeBSD) if it exists. */
|
||||
# if defined(__FreeBSD__) || defined(__FreeBSD_kernel__) || defined(__APPLE__)
|
||||
/* Use /proc/self/fd (or /dev/fd on macOS) if it exists. */
|
||||
# ifdef __APPLE__
|
||||
path = "/dev/fd";
|
||||
# else
|
||||
path = "/proc/self/fd";
|
||||
@@ -180,13 +184,36 @@ closefrom_procfs(int lowfd)
|
||||
|
||||
return ret;
|
||||
}
|
||||
#endif
|
||||
|
||||
/*
|
||||
* Close all file descriptors greater than or equal to lowfd.
|
||||
* We try the fast way first, falling back on the slow method.
|
||||
*/
|
||||
void
|
||||
closefrom(int lowfd)
|
||||
{
|
||||
if (closefrom_procfs(lowfd) == 0)
|
||||
return;
|
||||
if (lowfd < 0)
|
||||
lowfd = 0;
|
||||
|
||||
/* Try the fast methods first, if possible. */
|
||||
#if defined(HAVE_FCNTL_CLOSEM)
|
||||
if (fcntl(lowfd, F_CLOSEM, 0) != -1)
|
||||
return;
|
||||
#endif /* HAVE_FCNTL_CLOSEM */
|
||||
#if defined(__linux__) && defined(SYS_close_range)
|
||||
if (sys_close_range(lowfd, UINT_MAX, 0) == 0)
|
||||
return;
|
||||
#endif
|
||||
|
||||
#if defined(HAVE_PSTAT_GETPROC)
|
||||
if (closefrom_pstat(lowfd) != -1)
|
||||
return;
|
||||
#elif defined(HAVE_DIRFD)
|
||||
if (closefrom_procfs(lowfd) != -1)
|
||||
return;
|
||||
#endif /* HAVE_DIRFD */
|
||||
|
||||
/* Do things the slow way. */
|
||||
closefrom_fallback(lowfd);
|
||||
}
|
||||
#endif /* HAVE_FCNTL_CLOSEM */
|
||||
|
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user