GNU C Library master sources
Find a file
Adhemerval Zanella 7a7093615c cdefs.h: Add clang fortify directives
For instance, the read wrapper is currently expanded as:

  extern __inline
  __attribute__((__always_inline__))
  __attribute__((__artificial__))
  __attribute__((__warn_unused_result__))
  ssize_t read (int __fd, void *__buf, size_t __nbytes)
  {
     return __glibc_safe_or_unknown_len (__nbytes,
                                         sizeof (char),
                                         __glibc_objsize0 (__buf))
            ? __read_alias (__fd, __buf, __nbytes)
            : __glibc_unsafe_len (__nbytes,
                                  sizeof (char),
                                  __glibc_objsize0 (__buf))
              ? __read_chk_warn (__fd,
                                 __buf,
                                 __nbytes,
                                 __builtin_object_size (__buf, 0))
              : __read_chk (__fd,
                            __buf,
                            __nbytes,
                            __builtin_object_size (__buf, 0));
  }

The wrapper relies on __builtin_object_size call lowers to a constant at
compile-time and many other operations in the wrapper depends on
having a single, known value for parameters.   Because this is
impossible to have for function parameters, the wrapper depends heavily
on inlining to work and While this is an entirely viable approach on
GCC, it is not fully reliable on clang.  This is because by the time llvm
gets to inlining and optimizing, there is a minimal reliable source and
type-level information available (more information on a more deep
explanation on how to fortify wrapper works on clang [1]).

To allow the wrapper to work reliably and with the same functionality as
with GCC, clang requires a different approach:

  * __attribute__((diagnose_if(c, “str”, “warning”))) which is a function
    level attribute; if the compiler can determine that 'c' is true at
    compile-time, it will emit a warning with the text 'str1'.  If it would
    be better to emit an error, the wrapper can use "error" instead of
    "warning".

  * __attribute__((overloadable)) which is also a function-level attribute;
    and it allows C++-style overloading to occur on C functions.

  * __attribute__((pass_object_size(n))) which is a parameter-level
    attribute; and it makes the compiler evaluate
    __builtin_object_size(param, n) at each call site of the function
    that has the parameter, and passes it in as a hidden parameter.

    This attribute has two side-effects that are key to how FORTIFY works:

    1. It can overload solely on pass_object_size (e.g. there are two
       overloads of foo in

         void foo(char * __attribute__((pass_object_size(0))) c);
         void foo(char *);

      (The one with pass_object_size attribute has precende over the
      default one).

    2. A function with at least one pass_object_size parameter can never
       have its address taken (and overload resolution respects this).

Thus the read wrapper can be implemented as follows, without
hindering any fortify coverage compile and runtime:

  extern __inline
  __attribute__((__always_inline__))
  __attribute__((__artificial__))
  __attribute__((__overloadable__))
  __attribute__((__warn_unused_result__))
  ssize_t read (int __fd,
                 void *const __attribute__((pass_object_size (0))) __buf,
                 size_t __nbytes)
     __attribute__((__diagnose_if__ ((((__builtin_object_size (__buf, 0)) != -1ULL
                                        && (__nbytes) > (__builtin_object_size (__buf, 0)) / (1))),
                                     "read called with bigger length than size of the destination buffer",
                                     "warning")))
  {
    return (__builtin_object_size (__buf, 0) == (size_t) -1)
      ? __read_alias (__fd,
                      __buf,
                      __nbytes)
      : __read_chk (__fd,
                    __buf,
                    __nbytes,
                    __builtin_object_size (__buf, 0));
  }

To avoid changing the current semantic for GCC, a set of macros is
defined to enable the clang required attributes, along with some changes
on internal macros to avoid the need to issue the symbol_chk symbols
(which are done through the __diagnose_if__ attribute for clang).
The read wrapper is simplified as:

  __fortify_function __attribute_overloadable__ __wur
  ssize_t read (int __fd,
                __fortify_clang_overload_arg0 (void *, ,__buf),
                size_t __nbytes)
       __fortify_clang_warning_only_if_bos0_lt (__nbytes, __buf,
                                                "read called with bigger length than "
                                                "size of the destination buffer")

  {
    return __glibc_fortify (read, __nbytes, sizeof (char),
                            __glibc_objsize0 (__buf),
                            __fd, __buf, __nbytes);
  }

There is no expected semantic or code change when using GCC.

Also, clang does not support __va_arg_pack, so variadic functions are
expanded to call va_arg implementations.  The error function must not
have bodies (address takes are expanded to nonfortified calls), and
with the __fortify_function compiler might still create a body with the
C++ mangling name (due to the overload attribute).  In this case, the
function is defined with __fortify_function_error_function macro
instead.

[1] https://docs.google.com/document/d/1DFfZDICTbL7RqS74wJVIJ-YnjQOj1SaoqfhbgddFYSM/edit

Checked on aarch64, armhf, x86_64, and i686.
Reviewed-by: Carlos O'Donell <carlos@redhat.com>
Tested-by: Carlos O'Donell <carlos@redhat.com>
2024-02-27 10:52:57 -03:00
advisories Update advisory format and introduce some automation 2024-01-30 13:58:57 -05:00
argp Update copyright dates with scripts/update-copyrights 2024-01-01 10:53:40 -08:00
assert Update copyright dates with scripts/update-copyrights 2024-01-01 10:53:40 -08:00
benchtests benchtests: Add more benchtests for rounding functions. 2024-02-23 08:50:00 -03:00
bits Refer to C23 in place of C2X in glibc 2024-02-01 11:02:01 +00:00
catgets Update copyright dates not handled by scripts/update-copyrights 2024-01-01 10:53:40 -08:00
ChangeLog.old Create ChangeLog.old/ChangeLog.28 2024-01-31 01:34:58 +01:00
conform conform: Reformat Makefile. 2024-02-25 13:38:16 -05:00
csu csu: Reformat Makefile. 2024-02-25 13:38:16 -05:00
ctype ctype: Reformat Makefile. 2024-02-25 13:38:16 -05:00
debug string: Add hidden builtin definition for __strcpy_chk. 2024-02-06 09:17:04 +01:00
dirent dirent: Reformat Makefile. 2024-02-25 13:38:16 -05:00
dlfcn dlfcn: Reformat Makefile. 2024-02-25 13:38:16 -05:00
elf arm: Use _dl_find_object on __gnu_Unwind_Find_exidx (BZ 31405) 2024-02-23 08:50:00 -03:00
gmon gmon: Reformat Makefile. 2024-02-25 13:38:16 -05:00
gnulib Update copyright dates with scripts/update-copyrights 2024-01-01 10:53:40 -08:00
hesiod hesiod: Reformat Makefile. 2024-02-25 13:38:16 -05:00
htl htl/tests: Reformat Makefile. 2024-02-25 13:38:16 -05:00
hurd hurd: Reformat Makefile. 2024-02-25 13:38:16 -05:00
iconv Update copyright dates not handled by scripts/update-copyrights 2024-01-01 10:53:40 -08:00
iconvdata Update copyright dates with scripts/update-copyrights 2024-01-01 10:53:40 -08:00
include arm: Use _dl_find_object on __gnu_Unwind_Find_exidx (BZ 31405) 2024-02-23 08:50:00 -03:00
inet Update copyright dates with scripts/update-copyrights 2024-01-01 10:53:40 -08:00
intl Update copyright dates with scripts/update-copyrights 2024-01-01 10:53:40 -08:00
io Update copyright dates with scripts/update-copyrights 2024-01-01 10:53:40 -08:00
libio Refer to C23 in place of C2X in glibc 2024-02-01 11:02:01 +00:00
locale Define ISO 639-3 "ssy" (Saho) 2024-01-18 11:01:10 +01:00
localedata Update SHARED-FILES and license for Unicode 15.1.0. 2024-02-27 08:27:14 -05:00
login Update copyright dates not handled by scripts/update-copyrights 2024-01-01 10:53:40 -08:00
mach mach: Drop some unnecessary vm_param.h includes 2024-01-03 21:59:54 +01:00
malloc Make __getrandom_nocancel set errno and add a _nostatus version 2024-01-12 14:23:11 +01:00
manual trivial doc fix: remove weird phrase "syscall takes zero to five arguments" 2024-02-14 12:21:03 -03:00
math treewide: python-scripts: use is None for none-equality 2024-02-23 08:50:00 -03:00
mathvec Update copyright dates with scripts/update-copyrights 2024-01-01 10:53:40 -08:00
misc cdefs.h: Add clang fortify directives 2024-02-27 10:52:57 -03:00
nis Update copyright dates with scripts/update-copyrights 2024-01-01 10:53:40 -08:00
nptl treewide: python-scripts: use is None for none-equality 2024-02-23 08:50:00 -03:00
nptl_db Update copyright dates with scripts/update-copyrights 2024-01-01 10:53:40 -08:00
nscd Update copyright dates not handled by scripts/update-copyrights 2024-01-01 10:53:40 -08:00
nss getaddrinfo: translate ENOMEM to EAI_MEMORY (bug 31163) 2024-01-02 11:10:42 +01:00
po po: Update translations 2024-01-31 01:10:02 +01:00
posix Omit regex.c pragmas no longer needed 2024-01-01 10:53:40 -08:00
resolv Refer to C23 in place of C2X in glibc 2024-02-01 11:02:01 +00:00
resource Update copyright dates with scripts/update-copyrights 2024-01-01 10:53:40 -08:00
rt Update copyright dates with scripts/update-copyrights 2024-01-01 10:53:40 -08:00
scripts build-many-glibcs.py: Add s390 --disable-multi-arch / multi-arch configurations. 2024-02-21 08:52:36 +01:00
setjmp Update copyright dates with scripts/update-copyrights 2024-01-01 10:53:40 -08:00
signal Update copyright dates with scripts/update-copyrights 2024-01-01 10:53:40 -08:00
socket Update copyright dates with scripts/update-copyrights 2024-01-01 10:53:40 -08:00
soft-fp soft-fp: Add brain format support 2024-02-01 19:06:54 +01:00
stdio-common Rename c2x / gnu2x tests to c23 / gnu23 2024-02-01 17:55:57 +00:00
stdlib localedata: hr_HR: change currency to EUR/€ 2024-02-08 08:13:37 +01:00
string Fix stringop-overflow warning in tst-strlcat2. 2024-02-05 15:04:26 +01:00
sunrpc Update copyright dates with scripts/update-copyrights 2024-01-01 10:53:40 -08:00
support tests: gracefully handle AppArmor userns containment 2024-02-23 08:50:00 -03:00
sysdeps aarch64/fpu: Sync libmvec routines from 2.39 and before with AOR 2024-02-26 09:45:50 -03:00
sysvipc Update copyright dates with scripts/update-copyrights 2024-01-01 10:53:40 -08:00
termios Update copyright dates with scripts/update-copyrights 2024-01-01 10:53:40 -08:00
time Refer to C23 in place of C2X in glibc 2024-02-01 11:02:01 +00:00
timezone Update copyright dates with scripts/update-copyrights 2024-01-01 10:53:40 -08:00
wcsmbs Rename c2x / gnu2x tests to c23 / gnu23 2024-02-01 17:55:57 +00:00
wctype Update copyright dates with scripts/update-copyrights 2024-01-01 10:53:40 -08:00
.clang-format Update copyright dates with scripts/update-copyrights 2024-01-01 10:53:40 -08:00
.gitattributes Assume __NR_openat is always defined 2016-03-23 23:35:08 +01:00
.gitignore Add *.pyc to .gitignore 2015-05-18 15:26:26 +05:30
abi-tags Remove the bulk of the NaCl port. 2017-05-20 08:09:10 -04:00
aclocal.m4 configure: Use autoconf 2.71 2023-07-17 10:08:10 -04:00
config.h.in Use proc_getchildren_rusage when available in getrusage and times. 2024-02-17 21:14:39 +01:00
config.make.in crypt: Remove libcrypt support 2023-10-30 13:03:59 -03:00
configure Update copyright dates with scripts/update-copyrights 2024-01-01 10:53:40 -08:00
configure.ac crypt: Remove libcrypt support 2023-10-30 13:03:59 -03:00
CONTRIBUTED-BY crypt: Remove libcrypt support 2023-10-30 13:03:59 -03:00
COPYING Update to latest versions of GPL-2.0 and LGPL-2.1 2013-09-09 12:52:48 +10:00
COPYING.LIB Update to latest versions of GPL-2.0 and LGPL-2.1 2013-09-09 12:52:48 +10:00
extra-lib.mk Rename cppflags-iterator.mk to libof-iterator.mk, remove extra-modules.mk. 2017-05-09 07:06:29 -04:00
gen-locales.mk Improve gen-locales.mk and gen-locale.sh to make test files with @ options work 2018-02-27 17:01:57 +01:00
INSTALL INSTALL, install.texi: minor updates, regenerate 2024-01-31 00:13:43 +01:00
libc-abis riscv: support GNU indirect function 2021-01-10 21:25:13 -05:00
libof-iterator.mk Rename cppflags-iterator.mk to libof-iterator.mk, remove extra-modules.mk. 2017-05-09 07:06:29 -04:00
LICENSES Relicense IBM portions of resolv/base64.c resolv/res_debug.c. 2024-01-26 13:33:36 -05:00
MAINTAINERS Add MAINTAINERS 2017-05-11 13:38:30 -04:00
Makeconfig Update copyright dates with scripts/update-copyrights 2024-01-01 10:53:40 -08:00
Makefile Update copyright dates with scripts/update-copyrights 2024-01-01 10:53:40 -08:00
Makefile.help Update copyright dates with scripts/update-copyrights 2024-01-01 10:53:40 -08:00
Makefile.in New make target to only build benchmark binaries 2016-04-20 10:23:28 +05:30
Makerules Support compiling .S files with additional options 2024-02-25 09:22:40 -08:00
NEWS Refer to C23 in place of C2X in glibc 2024-02-01 11:02:01 +00:00
o-iterator.mk Fri Mar 17 12:58:37 1995 Roland McGrath <roland@churchy.gnu.ai.mit.edu> 1995-03-17 18:42:51 +00:00
README Remove ia64-linux-gnu 2024-01-08 17:09:36 -03:00
Rules Update copyright dates with scripts/update-copyrights 2024-01-01 10:53:40 -08:00
SECURITY.md Adapt the security policy for the security page 2023-12-05 09:15:10 -05:00
SHARED-FILES Update SHARED-FILES and license for Unicode 15.1.0. 2024-02-27 08:27:14 -05:00
shlib-versions crypt: Remove libcrypt support 2023-10-30 13:03:59 -03:00
test-skeleton.c Update copyright dates with scripts/update-copyrights 2024-01-01 10:53:40 -08:00
version.h Open master branch for glibc 2.40 development 2024-01-31 02:07:20 +01:00

This directory contains the sources of the GNU C Library.
See the file "version.h" for what release version you have.

The GNU C Library is the standard system C library for all GNU systems,
and is an important part of what makes up a GNU system.  It provides the
system API for all programs written in C and C-compatible languages such
as C++ and Objective C; the runtime facilities of other programming
languages use the C library to access the underlying operating system.

In GNU/Linux systems, the C library works with the Linux kernel to
implement the operating system behavior seen by user applications.
In GNU/Hurd systems, it works with a microkernel and Hurd servers.

The GNU C Library implements much of the POSIX.1 functionality in the
GNU/Hurd system, using configurations i[4567]86-*-gnu and x86_64-gnu.

When working with Linux kernels, this version of the GNU C Library
requires Linux kernel version 3.2 or later.

Also note that the shared version of the libgcc_s library must be
installed for the pthread library to work correctly.

The GNU C Library supports these configurations for using Linux kernels:

	aarch64*-*-linux-gnu
	alpha*-*-linux-gnu
	arc*-*-linux-gnu
	arm-*-linux-gnueabi
	csky-*-linux-gnuabiv2
	hppa-*-linux-gnu
	i[4567]86-*-linux-gnu
	x86_64-*-linux-gnu	Can build either x86_64 or x32
	loongarch64-*-linux-gnu Hardware floating point, LE only.
	m68k-*-linux-gnu
	microblaze*-*-linux-gnu
	mips-*-linux-gnu
	mips64-*-linux-gnu
	or1k-*-linux-gnu
	powerpc-*-linux-gnu	Hardware or software floating point, BE only.
	powerpc64*-*-linux-gnu	Big-endian and little-endian.
	s390-*-linux-gnu
	s390x-*-linux-gnu
	riscv32-*-linux-gnu
	riscv64-*-linux-gnu
	sh[34]-*-linux-gnu
	sparc*-*-linux-gnu
	sparc64*-*-linux-gnu

If you are interested in doing a port, please contact the glibc
maintainers; see https://www.gnu.org/software/libc/ for more
information.

See the file INSTALL to find out how to configure, build, and install
the GNU C Library.  You might also consider reading the WWW pages for
the C library at https://www.gnu.org/software/libc/.

The GNU C Library is (almost) completely documented by the Texinfo manual
found in the `manual/' subdirectory.  The manual is still being updated
and contains some known errors and omissions; we regret that we do not
have the resources to work on the manual as much as we would like.  For
corrections to the manual, please file a bug in the `manual' component,
following the bug-reporting instructions below.  Please be sure to check
the manual in the current development sources to see if your problem has
already been corrected.

Please see https://www.gnu.org/software/libc/bugs.html for bug reporting
information.  We are now using the Bugzilla system to track all bug reports.
This web page gives detailed information on how to report bugs properly.

The GNU C Library is free software.  See the file COPYING.LIB for copying
conditions, and LICENSES for notices about a few contributions that require
these additional notices to be distributed.  License copyright years may be
listed using range notation, e.g., 1996-2015, indicating that every year in
the range, inclusive, is a copyrightable year that would otherwise be listed
individually.