diff options
author | Siddhesh Poyarekar <siddhesh@gotplt.org> | 2022-12-15 14:24:55 -0500 |
---|---|---|
committer | Siddhesh Poyarekar <siddhesh@gotplt.org> | 2023-01-03 10:24:30 -0500 |
commit | b3009222b7bb26654c1e93d34e65e8f80ae20595 (patch) | |
tree | 12dcf17dd045cc4d2d53e6dac7e20922de844b89 | |
parent | d0558f420b2a5692fd38ac76ffa97ae6c1726ed9 (diff) | |
download | gcc-b3009222b7bb26654c1e93d34e65e8f80ae20595.zip gcc-b3009222b7bb26654c1e93d34e65e8f80ae20595.tar.gz gcc-b3009222b7bb26654c1e93d34e65e8f80ae20595.tar.bz2 |
tree-optimization/105043: Object Size Checking docs cleanup
Break the _FORTIFY_SOURCE-specific builtins out into a separate
subsection from Object Size Checking built-ins and mention
_FORTIFY_SOURCE in there so that the link between the object size
checking builtins, the helper builtins (e.g. __builtin___memcpy_chk) and
_FORTIFY_SOURCE is clearer.
gcc/ChangeLog:
PR tree-optimization/105043
* doc/extend.texi (Object Size Checking): Split out into two
subsections and mention _FORTIFY_SOURCE.
Signed-off-by: Siddhesh Poyarekar <siddhesh@gotplt.org>
-rw-r--r-- | gcc/doc/extend.texi | 20 |
1 files changed, 14 insertions, 6 deletions
diff --git a/gcc/doc/extend.texi b/gcc/doc/extend.texi index adba057..68d7760 100644 --- a/gcc/doc/extend.texi +++ b/gcc/doc/extend.texi @@ -12796,7 +12796,9 @@ __atomic_store_n(&lockvar, 0, __ATOMIC_RELEASE|__ATOMIC_HLE_RELEASE); @end smallexample @node Object Size Checking -@section Object Size Checking Built-in Functions +@section Object Size Checking + +@subsection Object Size Checking Built-in Functions @findex __builtin_object_size @findex __builtin_dynamic_object_size @findex __builtin___memcpy_chk @@ -12878,11 +12880,17 @@ which objects @var{ptr} points to at compile time are the same as in the case of @code{__builtin_object_size}. @end deftypefn -There are built-in functions added for many common string operation -functions, e.g., for @code{memcpy} @code{__builtin___memcpy_chk} -built-in is provided. This built-in has an additional last argument, -which is the number of bytes remaining in the object the @var{dest} -argument points to or @code{(size_t) -1} if the size is not known. +@subsection Object Size Checking and Source Fortification + +Hardening of function calls using the @code{_FORTIFY_SOURCE} macro is +one of the key uses of the object size checking built-in functions. To +make implementation of these features more convenient and improve +optimization and diagnostics, there are built-in functions added for +many common string operation functions, e.g., for @code{memcpy} +@code{__builtin___memcpy_chk} built-in is provided. This built-in has +an additional last argument, which is the number of bytes remaining in +the object the @var{dest} argument points to or @code{(size_t) -1} if +the size is not known. The built-in functions are optimized into the normal string functions like @code{memcpy} if the last argument is @code{(size_t) -1} or if |