From: Bruno Haible Date: Sun, 6 Dec 2020 16:59:45 +0000 (+0100) Subject: doc: Add more details regarding the undefined behaviour sanitizer. X-Git-Tag: v1.0~3409 X-Git-Url: https://gitweb.git.savannah.gnu.org/gitweb/?a=commitdiff_plain;h=0187efca598c6e072d1de1a59e3bdefa28d89cfe;p=gnulib.git doc: Add more details regarding the undefined behaviour sanitizer. * doc/gnulib-readme.texi (High Quality): Describe -fsanitize-undefined-trap-on-error better. --- diff --git a/ChangeLog b/ChangeLog index 5cb643ed75..08cef4d151 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,9 @@ +2020-12-06 Bruno Haible + + doc: Add more details regarding the undefined behaviour sanitizer. + * doc/gnulib-readme.texi (High Quality): Describe + -fsanitize-undefined-trap-on-error better. + 2020-12-06 Bruno Haible Do the Windows oldnames workaround through the C++ GNULIB_NAMESPACE. diff --git a/doc/gnulib-readme.texi b/doc/gnulib-readme.texi index a2a59628b1..cde6d7aaba 100644 --- a/doc/gnulib-readme.texi +++ b/doc/gnulib-readme.texi @@ -546,8 +546,21 @@ for your compiler. For example: @end example @noindent -Here, @code{-D_FORTIFY_SOURCE=2} enables extra security hardening -checks in the GNU C library, @code{-fsanitize=undefined} enables GCC's -undefined behavior sanitizer (@code{ubsan}), and -@code{-fsanitize-undefined-trap-on-error} prevents @code{ubsan}'s -linking to unnecessary libraries like @code{libstdc++}. +Here: + +@itemize @bullet +@item +@code{-D_FORTIFY_SOURCE=2} enables extra security hardening checks in +the GNU C library. +@item +@code{-fsanitize=undefined} enables GCC's undefined behavior sanitizer +(@code{ubsan}), and +@item +@code{-fsanitize-undefined-trap-on-error} causes @code{ubsan} to +abort the program (through an ``illegal instruction'' signal). This +measure stops exploit attempts and also allows you to debug the issue. +Without this option, @code{-fsanitize=undefined} causes messages to be +printed, execution continues after an undefined behavior situation, and +GCC links the program against @code{libstdc++} (which you can avoid +through the option @code{-static-libubsan}). +@end itemize