man: Improve wording for discouraged and optional features in libbsd(7)

man: Document uclibc and uclibc-ng interfaces in libbsd(7)

man: Disable hyphenation globally for all man pages

There is no place for hyphenation in a technical document. Unfortunately
groff insists on hyphenating words that are known to be technical terms
such as in .Xr, or .Fn, etc. Where groff upstream suggests that those
words need to be marked up with things like \%, which looks like
unnecessary busy work.

The current workaround requires to use low-level troff markup to
globally disable hyphenation with groff, which is less than ideal, but
the best known option available.

man: Document functions that are part of C23 and POSIX 2024

build: Check sanitize argument value

Check the value of the sanitize argument to determine if sanitize should
be enabled. This fixes that sanitize is enabled when --disable-sanitize
is passed to the configure script.

The third AC_ARG_ENABLE parameter defines an action, if the parameter is
present, but doesn't check its value. Therefore it is also invoked if the
parameter is disabled or --enable-foo=no is set. Therefore don't define
these actions and instead check the value with an AS_IF statement
afterwards, as shown in [1].

  [1] https://autotools.info/autoconf/arguments.html

[guillem@hadrons.org:
 - Minor coding style fixes.
 - Minor wording fixes in commit message. ]

Fixes: 257800a03c6b ("build: Add support for sanitizer compiler flags")
Closes: !31
Signed-off-by: Guillem Jover <guillem@hadrons.org>

build: Switch to debian:unstable Docker image

We have a restricted enough amount of dependencies that relying on
Debian unstable seems safe. More than using debian:testing which might
end up stuck with problems for some time until packages migrate from
unstable.

Add consttime_memequal() function

Import from NetBSD.

Add explicit_memset() function

Import from NetBSD.

man: Add err(3bsd) man pages for systems where we enable the functions

Reported-by: Alejandro Colomar <alx@kernel.org>

build: Sort Files field in COPYING file

build: Add Maintainer and License fields to pkg-config files

build: Request tar-ustar format for distribution

Even though this is the default starting with automake 1.18, we should
be explicit to get uniform behavior.

build: Set TAR_OPTIONS to avoid leaking maintainer information on dist

The default tar invocation by automake leaks the user and group IDs and
names into the tarball. And while those are probably going to be easy to
infer, it is unnecessary to expose them. With the automake switch from
tar format v7 to ustar this is now worse as it used to only leak the
IDs, not the names.

We set and export TAR_OPTIONS with --owner=0 and --group=0 to neuter the
information leak. Although ideally automake would set those by default.

doc: Use SPDX identifier for libutil-David-Nugent license in COPYING

The current name (BSD-5-clause-Peter-Wemm) is very confusing as it gives
it legitimacy as one of the recognized BSD-N-clause licenses, and it
also makes it seem more restrictive than a BSD-4-clause license, which
it does not appear to be. The license seems to originate from libutil
files by David Nugent, and that's the name that it got when being added
into SPDX. We switch to use that as a known registered name instead of
making it up ourselves.

Ref: https://spdx.org/licenses/libutil-David-Nugent.html

doc: Coalesce copyright years into ranges in COPYING file

For copyright, the important dates are the first date of publication,
and the last date of publication. The latter for anonymous and
pseudonymous authors where there's a fixed time after last publication
(usually at least 50 years or more), and the former for known authors
where there's a fixed time after first publication or author's death
(usually at least 50 years or more).

It seems fine to coalesce the copyright years in the COPYING file, as
this is a summary of the original statements found in the actual source
files, were we are here already inserting the different years or ranges,
so making it a single range preserves the important information that
might be relevant for compliance purposes.

doc: Sort and make copyright statements unique in COPYING file

doc: Remove spurious text from copyright statements in COPYING file

Remove «,» and «by» after copyright years, and trailing «.» after
copyright statements.

doc: Remove redundant «Copyright ©» from COPYING file

This is implied by the field name this text is a value for.

doc: Split «code is derived from» into Comments fields in COPYING file

These are not copyright statements, they are provenance or authorship
statements.

doc: Remove «All rights reserved»

This has no legal weight, and was needed due to the Buenos Aires
Convention requiring it. Since all members of the Buenos Aires
Convention are now part of the Berne Convention, there is no need
anymore for this phrasing. And while the original statement must not
be touched, we do not need to replicate this in the COPYING file when
it is legally pointless.

Mark tau and sigma Chacha variables as nonstring

These contain a sequence of bytes, and are not a NUL-terminated string.
Help the compiler understand the intent of the code.

include: Switch from __unused to new LIBBSD_UNUSED

Because we do not define __unused, as on GNU systems Linux and glibc
providing conflicting symbols, declarations for imported functions that
use that attribute cause build failures when used.

Ref: https://bugs.debian.org/1083196
Fixes: #34

include: Refactor «unused» attribute into new LIBBSD_UNUSED macro

This make it possible to declare function arguments in headers as
potentially unused, so that they do not emit warnings. We will use this
instead of the BSD __unused, which we cannot currently enable on GNU
systems due to Linux and glibc having conflicting symbols.

doc: Update anongit & cgit URLs to use gitlab instead

Closes: !30
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
Signed-off-by: Guillem Jover <guillem@hadrons.org>

Release libbsd 0.12.2

test: nlist: make resilient against -Wl,--gc-sections

With linker sections GC enabled, we get a test failure in `nlist.c`:
```
nlist: nlist.c:72: main: Assertion `rc == 0' failed.
```

This turns out to be because several sections used by the test can be discarded:
```
ld: removing unused section '.text.func_pub' in file 'nlist.o'
ld: removing unused section '.bss.data_pub_uninit' in file 'nlist.o'
ld: removing unused section '.data.data_pub_init' in file 'nlist.o'
```

Reproduced with `CFLAGS="-Og -fdata-sections -ffunction-sections"` and
`LDFLAGS="-Wl,-O1 -Wl,--as-needed -Wl,--gc-sections -Wl,-z,start-stop-gc"`.

Additionally, `LDFLAGS="... -Wl,--print-gc-sections"` can help with diagnosing
which sections get removed.

We already mark these symbols as `used`, but we need `retain` [0] for them
to survive linker GC too.

[0] https://releases.llvm.org/18.1.0/tools/lld/docs/ELF/start-stop-gc.html#annotate-c-identifier-name-sections

Closes: !29
Signed-off-by: Sam James <sam@gentoo.org>
Signed-off-by: Guillem Jover <guillem@hadrons.org>

build: Do not rely on internal autoconf ac_cv_sys_file_offset_bits variable

This is an internal implementation detail from AC_SYS_LARGEFILE, which
happened to change with autoconf 2.72. Instead compute our own size
for off_t.

Closes: #28

build: Use -eq instead of = as test operators for arithmetic tests

build: Fix typo in ABI selection description

build: Only install time struct conversion macros where missing

These macros are available in several systems, and we should not install
the man pages for them, otherwise we might end up shadowing the system
man pages if present.

man: Add links for errc module functions

Reported-by: Alejandro Colomar <alx@kernel.org>

man: Do not install timeval(3bsd) nor timespec(3bsd)

These are system types, which we should not be documenting. Rewrite the
man pages around the TIMEVAL_TO_TIMESPEC and TIMESPEC_TO_TIMEVAL macros.

strtonum: Do not abort on EINVAL from strtoi()

With musl libc strtoimax(".", ...) returns EINVAL.

Closes: !28
Signed-off-by: Guillem Jover <guillem@hadrons.org>

closefrom: Ignore files starting with dot when scanning /proc/self/fd

Signed-off-by: Guillem Jover <guillem@hadrons.org>

build: Match also gnu* for GNU/Hurd on the glibc ABI selection

The GNU/Hurd system does not specify a kernel part, so we need to match
on both *-gnu* and gnu* (to avoid overmatching with just *gnu*).

Release libbsd 0.12.1

build: Add a comment to libbsd-overlay.pc about -isystem usage

Add the reasoning for why we use -isystem instead of -I, to avoid
confusing unsuspecting readers of the file.

Prompted-by: Alejandro Colomar <alx@kernel.org>

build: Install err.h if either of the err or errc modules are built

Both modules expose their functions in err.h, so we need to install it
whenever any of them is being built.

Reported-by: Alejandro Colomar <alx@kernel.org>

Release libbsd 0.12.0

Add explicit time32 and time64 support

Handle the three potential system scenarios:

 - system time_t is time64
 - system time_t is time32 and supports time64
 - system time_t is time32 and does not support time64

Add the explicit time32 and time64 functions when necessary and map
them accordingly for each of these cases.

build: Add support for AIX

Add vasprintf() and asprintf() functions missing on AIX

These functions are used by code in the library, even though these
functions started as GNU extensions, they are present in all BSDs,
so we expose them as part of our interface on AIX.

build: Add support for Solaris

build: Make almost all exposed interfaces use the new ABI selection

Explicitly select what to include as part of the target ABI, instead of
letting autoconfiguration potentially break ABI if the system grows
functionality provided by the library.

Make almost all the library selectable per target. Do not install manual
pages for interfaces not included in the library. Control inclusion of
symbols in map file via pre-processor macros, and move the comments
describing the ABI selection to configure.ac.

For now the header files are included as is and filtered through
pre-processor conditionals. Eventually they might get switched to be
autogenerated at build time.

build: Rework ABI selection logic

Add a new LIBBSD_SELECT_ABI m4 macro, and use it to setup the ABI
interfaces to expose and the various variables and conditionals
to be used by the build system.

Switch to set the initial values to unknown and then set every one
of the selections explicitly by supported target.

Update comments for rationale for things to DROP, or for why some
selections are enabled.

build: Rename ABI selection variables from need_ to abi_

This should make the purpose of these variables more clear.

build: Revert accidental testing aid change

This was accidentally included in the commit, but should have only been
used during development.

Fixes: commit de124dcafac678351366b0572938398ea7ae93e4
Changelog: silent

build: Make digest function checks conditional on their use

The digest function checks where unconditionally requiring the functions
to exist or they would error out. But these functions are not required
on all systems, they depend on the ABI to be exposed.

build: Move ABI selection at the top of configure.ac

Merge the existing host_os block for the OS detection with the ABI
selection one, as these are related. This way we will be able to make
some of the latter checks conditional on the selected ABI.

build: Sort variables and their contents in automake files

This should make it easier to add new entries, and find them afterwards.

build: Rename LIBBSD_ABI to SOVERSION

This matches the semantics of the variable, and makes it independent of
the project, just as the package variables.

build: Refactor function checks into a new libbsd-funcs.m4 file

These are complex enough to clutter the main configure.ac. Move them
into their own file.

build: Remove space before shell redirection

This makes it more clear what the redirection applies to.

build: Add support for silent rules for the libbsd.map generation

The new rule was introduced w/o silent rule support.

Fixes: commit 19e06407eb365a2bedc9bdd29a83c1e1803e3f92

Split errc family of functions from err ones

On most systems the err family of functions is already present, but are
missing the errc family of functions, which are also present on some
other systems. Splitting them into separate files will make it easer to
conditionally include one or the other.

Sync strtoi()/strtou() implementations from NetBSD

These contain the fixes to the error handling logic.

In NetBSD the manual page for strtou.3 is generated from the strtoi.3
manual page applying some substitutions, the problem is that the
cross-references are then lost. We will still keep them separate.

Reported-by: Alejandro Colomar <alx@kernel.org>

build: Swap symbol and alias arguments order in macros creating aliases

The current order is rather confusing, pass the real symbol first
and the alias we want to create next.

build: Generate the map file from the configured ABI

Some linkers require the map file definitions to contain only symbols
that are present on the linked object, either in the map file or in the
sym file we generate from the map file.

This is preparatory work to be able to conditionally include symbols
in the man and sym files depending on the ABI definitions.

build: Make name_from_id man pages conditional instead of id_from_name

The code is only making the name_from_id function conditional, and
assumes id_from_name are always to be included, so we need to match
the logic for the man page inclusion.

man: Mention that funopen() can be made available on musl

As musl got fopencookie() implemented in 1.1.19, the funopen() function
can also be provided there. Note this in the documentation.

man: Fix manual page references

When referring to another manual page and their section number, we need
to use Xr instead of Fn, otherwise the section number is interpreted as
a function argument. For functions provided by libbsd itself we should
be using the 3bsd section instead of 3.

man: Add closefrom(), strlcpy() and strlcat() as superseded functions

These were missing from the list of functions provided by some libc
implementation.

doc: Use macOS to refer to the operating system

This is the correct spelling, instead of capitalizing it.

Release libbsd 0.11.8

test: Close all descriptors before initializing them for closefrom()

On macOS, closefrom() only sets the close-on-exec flag, so we cannot
check whether all file descriptors were closed, which means that if
on entry our file descriptor table was filled after the 4th file
descriptor, then we might fail the assertions for the flags for odd
file descriptors which we expect to be closed.

This can easily happen when running the test suite in parallel mode
with «make -j8 check» for example.

Closes: #23

build: Check out-of-tree builds in CI

Make sure the out-of-tree builds do not regress.

Adjust strlcpy() and strlcat() per glibc adoption

These functions were added in glibc 2.38, in anticipation of POSIX
adopting them too.

Closes: #26

Do not add a pointer to the NULL constant

Warned-by: cppcheck (nullPointerArithmetic)

Do not confuse code analyzers with out-of-bounds array access look alike

The code is only getting the address, but we might be performing an
addressing that is out-of-bounds. Avoid it and use the address form
instead.

Warned-by: cppcheck (objectIndex)

test: Fix short-lived memory leak

Warned-by: cppcheck

build: Add a coverage regex to the CI job

This is needed so that gitlab can know where to extract the coverage
percentage from in the output, to be able to track and report it.

man: Use VARIANTS instead of ALTERNATIVES in libbsd(7)

Using alternatives seems confusing in this context.

man: Markup function references with Xr instead of Fn

These references had man page sections in them, so using Fn meant that
these appeared as function arguments.

build: Add missing dash to macro title bar

pwcache: Do not declare uidtb and gidtb when not used

When the system provides implementations for user_from_uid() or
group_from_gid() we are not using these variables, so better not declare
them.

Fixes: commit 21d12b02112097f0c195dceb1892c95b7b957b36

fgetln: Include <stdio.h> after <sys/*>

The <sys/*> headers tend to define things that might be used by other
headers, so while they should be self-contained, it is better to simply
include them first.

build: Refactor GNU .init_array support check into a new m4 function

build: Refactor linker script detection into a new m4 function

build: Do not provide prototypes for arc4random() on Solaris

These functions are provided by the system.

build: Do not build the progname module if it is not needed

This was made conditional, but the code part was accidentally left
untouched due to having ported it locally to use __progname, which
caused build failures on the stock repo.

Fixes: commit 046621d7967e7a0f08ae988bcf7e4cd1b6cf204c

build: Sort entries alphabetically

build: Conditionalize wcslcpy() and wcslcat() functions on macOS

These functions are provided by the system libc.

build: Conditionalize only id-from-name functions not the entire pwcache

On macOS the name-from-id functions are present, but not the
id-from-name ones, so we want to provide those instead of suppressing
the entire file.

build: Conditionalize getprogname()/setprogname on macOS

These functions are provided by the system libc, so there is no need for
us to provide them.

progname: Include <procinfo.h> if available

We need this header on AIX. Missed transplanting the code from the AIX
porting system.

Fixes: commit 9fa06763a1afe0946a3a20e5bbdba72885cbade5

build: Check whether we need libperfstat on AIX

The getentropy() implementation makes use of this library on AIX.

build: Annotate droppable functions for musl on next SOVERSION bump

These are already provided by the musl libc, and can thus be dropped on
the next SOVERSION bump.

build: Conditionalize bsd_getopt() on macOS

The system library provides a getopt() with BSD semantics.

Move the version script comments before the symbols

When generating the .sym export file from the .map file, we are not
stripping these comments that are part of the same line as the symbol,
which causes ld(1) implementations to error out. Moving them before
the symbols avoids the need to strip them, as we are only keeping
actual symbol lines.

Port getprogname() to AIX

Get the program name from the COMM field from the proc filesystem.

We could use instead the information from the psinfo binary file under
/proc, but that seems to have a shorter string limit.

Make getprogname() porting mandatory

Although the function is documented as possibly returning NULL if it
cannot find a known source of information, we should still at least
attempt to port it to any supported system, and otherwise explicitly
mark it as not implementable for such systems if that was to be the
case.

test: Do not use /dev/null as compiler output file

Some ld(1) implementations, such as the one on AIX, do not support using
/dev/null as the output filename for the compiled object.

Use an actual filename that we will then clean up.

build: Add generated *.sym files to .gitignore

build: On macOS do not build functions provided by the system

We have never built before on macOS, so we can exclude all the functions
that are currently provided in the system.

Closes: #1
Closes: !3

build: Select whether to include funopen() in the build system

This makes sure we include it when expected, alongside the man pages,
and the test cases, and do not accidentally break the ABI if the system
starts providing such interface.

build: Move Windows OS detection to the OS features section

This was placed here to make use of the same AS_CASE, but it does not
really fit with the section. Move it to the more appropriate place, and
detangle the AS_CASE.

build: Remove __MUSL__ definition from configure

We stopped relying on this macro when we turned the funopen() cpp error
into a warning in commit e50896286cc5718898194edb73fa7262ad9a22db.

build: Add a new libbsd_strong_alias() macro and switch users to it

We had several cases of code needing a strong alias, so we switch those
to use the new macro. This covers systems that support the alias
attribute and others such as macOS where we need to use assembler
directives to add the alias as the attribute is not supported.

build: Only emit link warnings for ELF objects

build: Use an export symbols file if there is no version script support

We generate the symbol list from the version script to avoid repeating
ourselves and potentially getting the lists out-of-sync.