ubsan: default to trap on unreachable at -O0 and -Og [PR104642]
commitd68d366425369649cb4e25a07752e25a4fff52cf
authorJason Merrill <jason@redhat.com>
Fri, 10 Jun 2022 20:35:21 +0000 (10 16:35 -0400)
committerJason Merrill <jason@redhat.com>
Wed, 22 Jun 2022 13:01:29 +0000 (22 09:01 -0400)
tree5c24e85ecae155722951810c6932c0d39dcbd55f
parent038b077689bb5310386b04d40a2cea234f01e6aa
ubsan: default to trap on unreachable at -O0 and -Og [PR104642]

When not optimizing, we can't do anything useful with unreachability in
terms of code performance, so we might as well improve debugging by turning
__builtin_unreachable into a trap.  I think it also makes sense to do this
when we're explicitly optimizing for the debugging experience.

In the PR richi suggested introducing an -funreachable-traps flag for this.
This functionality is already implemented as -fsanitize=unreachable
-fsanitize-trap=unreachable, and we want to share the implementation, but it
does seem useful to have a separate flag that isn't affected by the various
sanitization controls.  -fsanitize=unreachable takes priority over
-funreachable-traps if both are enabled.

Jakub observed that this would slow down -O0 by default from running the
sanopt pass, so this revision avoids the need for sanopt by rewriting calls
introduced by the compiler immediately, and calls written by the user at
fold time.  Many of the calls introduced by the compiler are also rewritten
immediately to ubsan calls when not trapping, which fixes ubsan-8b.C;
previously the call to f() was optimized away before sanopt.  But this early
rewriting isn't practical for uses of __builtin_unreachable in
devirtualization and such, so sanopt rewriting is still done for
non-trapping sanitize.

PR c++/104642

gcc/ChangeLog:

* common.opt: Add -funreachable-traps.
* doc/invoke.texi (-funreachable-traps): Document it.
* opts.cc (finish_options): Enable at -O0 or -Og.
* tree.cc (build_common_builtin_nodes): Add __builtin_trap.
(builtin_decl_unreachable, build_builtin_unreachable): New.
* tree.h: Declare them.
* ubsan.cc (sanitize_unreachable_fn): Factor out.
(ubsan_instrument_unreachable): Use
gimple_build_builtin_unreachable.
* ubsan.h (sanitize_unreachable_fn): Declare.
* gimple.cc (gimple_build_builtin_unreachable): New.
* gimple.h: Declare it.
* builtins.cc (expand_builtin_unreachable): Add assert.
(fold_builtin_0): Call build_builtin_unreachable.
* sanopt.cc: Don't run for just SANITIZE_RETURN
or SANITIZE_UNREACHABLE when trapping.
* cgraphunit.cc (walk_polymorphic_call_targets): Use new
unreachable functions.
* gimple-fold.cc (gimple_fold_call)
(gimple_get_virt_method_for_vtable)
* ipa-fnsummary.cc (redirect_to_unreachable)
* ipa-prop.cc (ipa_make_edge_direct_to_target)
(ipa_impossible_devirt_target)
* ipa.cc (walk_polymorphic_call_targets)
* tree-cfg.cc (pass_warn_function_return::execute)
(execute_fixup_cfg)
* tree-ssa-loop-ivcanon.cc (remove_exits_and_undefined_stmts)
(unloop_loops)
* tree-ssa-sccvn.cc (eliminate_dom_walker::eliminate_stmt):
Likewise.

gcc/cp/ChangeLog:

* constexpr.cc (cxx_eval_builtin_function_call): Handle
unreachable/trap earlier.
* cp-gimplify.cc (cp_maybe_instrument_return): Use
build_builtin_unreachable.

gcc/testsuite/ChangeLog:

* g++.dg/ubsan/return-8a.C: New test.
* g++.dg/ubsan/return-8b.C: New test.
* g++.dg/ubsan/return-8d.C: New test.
* g++.dg/ubsan/return-8e.C: New test.
25 files changed:
gcc/builtins.cc
gcc/cgraphunit.cc
gcc/common.opt
gcc/cp/constexpr.cc
gcc/cp/cp-gimplify.cc
gcc/doc/invoke.texi
gcc/gimple-fold.cc
gcc/gimple.cc
gcc/gimple.h
gcc/ipa-fnsummary.cc
gcc/ipa-prop.cc
gcc/ipa.cc
gcc/opts.cc
gcc/sanopt.cc
gcc/testsuite/g++.dg/ubsan/return-8a.C [new file with mode: 0644]
gcc/testsuite/g++.dg/ubsan/return-8b.C [new file with mode: 0644]
gcc/testsuite/g++.dg/ubsan/return-8d.C [new file with mode: 0644]
gcc/testsuite/g++.dg/ubsan/return-8e.C [new file with mode: 0644]
gcc/tree-cfg.cc
gcc/tree-ssa-loop-ivcanon.cc
gcc/tree-ssa-sccvn.cc
gcc/tree.cc
gcc/tree.h
gcc/ubsan.cc
gcc/ubsan.h