[all-commits] [llvm/llvm-project] b7bdf1: [-Wunsafe-buffer-usage] Hide fixits/suggestions be...

[NoQ via All-commits]

  Branch: refs/heads/main
  Home:   https://github.com/llvm/llvm-project
  Commit: b7bdf1996fd195b20b9a2916c9183167650806f1
      https://github.com/llvm/llvm-project/commit/b7bdf1996fd195b20b9a2916c9183167650806f1
  Author: Artem Dergachev <adergachev at apple.com>
  Date:   2023-05-18 (Thu, 18 May 2023)

  Changed paths:
    M clang/include/clang/Analysis/Analyses/UnsafeBufferUsage.h
    M clang/include/clang/Basic/DiagnosticOptions.def
    M clang/include/clang/Basic/DiagnosticSemaKinds.td
    M clang/include/clang/Driver/Options.td
    M clang/lib/Analysis/UnsafeBufferUsage.cpp
    M clang/lib/Driver/ToolChains/Clang.cpp
    M clang/lib/Sema/AnalysisBasedWarnings.cpp
    M clang/test/SemaCXX/unsafe-buffer-usage-diag-type.cpp
    M clang/test/SemaCXX/warn-unsafe-buffer-usage-crashes.c
    M clang/test/SemaCXX/warn-unsafe-buffer-usage-fixits-addressof-arraysubscript.cpp
    M clang/test/SemaCXX/warn-unsafe-buffer-usage-fixits-assign-to-array-subscr-on-ptr.cpp
    M clang/test/SemaCXX/warn-unsafe-buffer-usage-fixits-deref-simple-ptr-arith.cpp
    M clang/test/SemaCXX/warn-unsafe-buffer-usage-fixits-local-var-span.cpp
    M clang/test/SemaCXX/warn-unsafe-buffer-usage-fixits-pointer-access.cpp
    M clang/test/SemaCXX/warn-unsafe-buffer-usage-fixits-pointer-deref.cpp
    M clang/test/SemaCXX/warn-unsafe-buffer-usage-fixits-pre-increment.cpp
    M clang/test/SemaCXX/warn-unsafe-buffer-usage-fixits-unevaluated-context.cpp
    M clang/test/SemaCXX/warn-unsafe-buffer-usage-function-attr.cpp
    M clang/test/SemaCXX/warn-unsafe-buffer-usage-no-fixits.cpp
    M clang/test/SemaCXX/warn-unsafe-buffer-usage-pragma-fixit.cpp
    M clang/test/SemaCXX/warn-unsafe-buffer-usage-pragma-misuse.cpp
    M clang/test/SemaCXX/warn-unsafe-buffer-usage-pragma.cpp
    M clang/test/SemaCXX/warn-unsafe-buffer-usage-source-ranges.cpp
    A clang/test/SemaCXX/warn-unsafe-buffer-usage-suggestions-flag.cpp
    M clang/test/SemaCXX/warn-unsafe-buffer-usage-warning-unevaluated-context.cpp
    M clang/test/SemaCXX/warn-unsafe-buffer-usage.cpp

  Log Message:
  -----------
  [-Wunsafe-buffer-usage] Hide fixits/suggestions behind an extra flag.

This patch implements a new clang driver flag -fsafe-buffer-usage-suggestions
which allows turning the smart suggestion machine on and off (defaults to off).
This is valuable for stability reasons, as the machine is being rapidly improved\
and we don't want accidental breakages to ruin the build for innocent users.
It is also arguably useful in general because it enables separation of concerns
between project contributors: some users will actively update the code to
conform to the programming model, while others simply want to make sure that
they aren't regressing it. Finally, there could be other valid reasons to
opt out of suggestions entirely on some codebases (while continuing to enforce
-Wunsafe-buffer-usage warnings), such as lack of access to hardened libc++
(or even to the C++ standard library in general) on the target platform.

When the flag is disabled, the unsafe buffer usage analysis is reduced to
an extremely minimal mode of operation that contains virtually no smarts:
not only it doesn't offer automatic fixits, but also textual suggestions
such as "change the type of this variable to std::span to preserve bounds
information" are not displayed, and in fact the machine doesn't even try
to blame specific variables in the first place, it simply warns on
the operations and leaves everything else to the user. So this flag turns off
a lot more of our complex machinery than what we already turn off in presence
of say -fno-diagnostic-fixit-info.

The flag is discoverable: when it's off, the warnings are accompanied by a note:
telling the user that there's a flag they can use.

Differential Revision: https://reviews.llvm.org/D146669