Skip to content

[compiler-rt][nsan] Make nsan output more user-friendly #98798

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 14, 2024

Conversation

chestnykh
Copy link
Contributor

@chestnykh chestnykh commented Jul 14, 2024

Currently NSAN prints reports that are entirely red and the terminal prompt after the program exits is red too. With this change we make red only WARNING summary and the rest of the report isn't colored
This behaviour is similar to the behavior of other sanitizers reports like asan, ubsan etc

nsan

Now:
nsan_pretty

Currently NSAN prints reports that are entirely red
and the terminal prompt after the program exits is red too.
With this change we make red only `WARNING` summary
and the rest of the report isn't colored
This behaviour is similar to the behavior of other
sanitizers reports like asan, ubsan etc
@llvmbot
Copy link
Member

llvmbot commented Jul 14, 2024

@llvm/pr-subscribers-compiler-rt-sanitizer

Author: Dmitriy Chestnykh (chestnykh)

Changes

Currently NSAN prints reports that are entirely red and the terminal prompt after the program exits is red too. With this change we make red only WARNING summary and the rest of the report isn't colored
This behaviour is similar to the behavior of other sanitizers reports like asan, ubsan etc

nsan
nsan_pretty


Full diff: https://github.com/llvm/llvm-project/pull/98798.diff

1 Files Affected:

  • (modified) compiler-rt/lib/nsan/nsan.cpp (+5-3)
diff --git a/compiler-rt/lib/nsan/nsan.cpp b/compiler-rt/lib/nsan/nsan.cpp
index 7a5f013579dfb..e5a9b7a036e0e 100644
--- a/compiler-rt/lib/nsan/nsan.cpp
+++ b/compiler-rt/lib/nsan/nsan.cpp
@@ -513,6 +513,8 @@ int32_t checkFT(const FT value, ShadowFT Shadow, CheckTypeT CheckType,
     }
     using ValuePrinter = FTPrinter<FT>;
     using ShadowPrinter = FTPrinter<ShadowFT>;
+    Printf("%s", D.Default());
+
     Printf("\n"
            "%-12s precision  (native): dec: %s  hex: %s\n"
            "%-12s precision  (shadow): dec: %s  hex: %s\n"
@@ -638,8 +640,9 @@ void fCmpFailFT(const FT Lhs, const FT Rhs, ShadowFT LhsShadow,
   const char *const PredicateName = GetPredicateName(Predicate);
   Printf("%s", D.Warning());
   Printf("WARNING: NumericalStabilitySanitizer: floating-point comparison "
-         "results depend on precision\n"
-         "%-12s precision dec (native): %s %s %s (%s)\n"
+         "results depend on precision\n");
+  Printf("%s", D.Default());
+  Printf("%-12s precision dec (native): %s %s %s (%s)\n"
          "%-12s precision dec (shadow): %s %s %s (%s)\n"
          "%-12s precision hex (native): %s %s %s (%s)\n"
          "%-12s precision hex (shadow): %s %s %s (%s)\n"
@@ -658,7 +661,6 @@ void fCmpFailFT(const FT Lhs, const FT Rhs, ShadowFT LhsShadow,
          FTInfo<ShadowFT>::kCppTypeName, ShadowPrinter::hex(LhsShadow).Buffer,
          PredicateName, ShadowPrinter::hex(RhsShadow).Buffer,
          GetTruthValueName(ShadowResult), D.End());
-  Printf("%s", D.Default());
   stack.Print();
   if (flags().halt_on_error) {
     Printf("Exiting\n");

@chestnykh
Copy link
Contributor Author

@alexander-shaposhnikov alexander-shaposhnikov merged commit a8687dd into llvm:main Jul 14, 2024
9 checks passed
@llvm-ci
Copy link
Collaborator

llvm-ci commented Jul 14, 2024

LLVM Buildbot has detected a new failure on builder sanitizer-x86_64-linux running on sanitizer-buildbot2 while building compiler-rt at step 2 "annotate".

Full details are available at: https://lab.llvm.org/buildbot/#/builders/66/builds/1488

Here is the relevant piece of the build log for the reference:

Step 2 (annotate) failure: 'python ../sanitizer_buildbot/sanitizers/zorg/buildbot/builders/sanitizers/buildbot_selector.py' (failure)
...
llvm-lit: /b/sanitizer-x86_64-linux/build/llvm-project/compiler-rt/test/fuzzer/lit.cfg.py:60: note: linux feature available
llvm-lit: /b/sanitizer-x86_64-linux/build/llvm-project/compiler-rt/test/fuzzer/lit.cfg.py:36: note: lsan feature available
llvm-lit: /b/sanitizer-x86_64-linux/build/llvm-project/compiler-rt/test/fuzzer/lit.cfg.py:45: note: msan feature unavailable
llvm-lit: /b/sanitizer-x86_64-linux/build/llvm-project/compiler-rt/test/fuzzer/lit.cfg.py:60: note: linux feature available
llvm-lit: /b/sanitizer-x86_64-linux/build/llvm-project/compiler-rt/test/fuzzer/lit.cfg.py:36: note: lsan feature available
llvm-lit: /b/sanitizer-x86_64-linux/build/llvm-project/compiler-rt/test/fuzzer/lit.cfg.py:48: note: msan feature available
llvm-lit: /b/sanitizer-x86_64-linux/build/llvm-project/compiler-rt/test/fuzzer/lit.cfg.py:60: note: linux feature available
llvm-lit: /b/sanitizer-x86_64-linux/build/llvm-project/llvm/utils/lit/lit/main.py:72: note: The test suite configuration requested an individual test timeout of 0 seconds but a timeout of 900 seconds was requested on the command line. Forcing timeout to be 900 seconds.
-- Testing: 10001 tests, 80 workers --
Testing:  0.. 10..
FAIL: AddressSanitizer-i386-linux-dynamic :: TestCases/leaks.cpp (1817 of 10001)
******************** TEST 'AddressSanitizer-i386-linux-dynamic :: TestCases/leaks.cpp' FAILED ********************
Exit Code: 1

Command Output (stderr):
--
RUN: at line 4: /b/sanitizer-x86_64-linux/build/build_default/./bin/clang  --driver-mode=g++ -fsanitize=address -mno-omit-leaf-frame-pointer -fno-omit-frame-pointer -fno-optimize-sibling-calls -gline-tables-only  -m32  -shared-libasan -O0 /b/sanitizer-x86_64-linux/build/llvm-project/compiler-rt/test/asan/TestCases/leaks.cpp -o /b/sanitizer-x86_64-linux/build/build_default/runtimes/runtimes-bins/compiler-rt/test/asan/I386LinuxDynamicConfig/TestCases/Output/leaks.cpp.tmp
+ /b/sanitizer-x86_64-linux/build/build_default/./bin/clang --driver-mode=g++ -fsanitize=address -mno-omit-leaf-frame-pointer -fno-omit-frame-pointer -fno-optimize-sibling-calls -gline-tables-only -m32 -shared-libasan -O0 /b/sanitizer-x86_64-linux/build/llvm-project/compiler-rt/test/asan/TestCases/leaks.cpp -o /b/sanitizer-x86_64-linux/build/build_default/runtimes/runtimes-bins/compiler-rt/test/asan/I386LinuxDynamicConfig/TestCases/Output/leaks.cpp.tmp
/b/sanitizer-x86_64-linux/build/llvm-project/compiler-rt/test/asan/TestCases/leaks.cpp:16:16: warning: unknown attribute 'noopt' ignored [-Wunknown-attributes]
   16 | __attribute__((noopt)) void leak(int n) {
      |                ^~~~~
1 warning generated.
RUN: at line 5: not  /b/sanitizer-x86_64-linux/build/build_default/runtimes/runtimes-bins/compiler-rt/test/asan/I386LinuxDynamicConfig/TestCases/Output/leaks.cpp.tmp 0 2>&1 | FileCheck /b/sanitizer-x86_64-linux/build/llvm-project/compiler-rt/test/asan/TestCases/leaks.cpp
+ not /b/sanitizer-x86_64-linux/build/build_default/runtimes/runtimes-bins/compiler-rt/test/asan/I386LinuxDynamicConfig/TestCases/Output/leaks.cpp.tmp 0
+ FileCheck /b/sanitizer-x86_64-linux/build/llvm-project/compiler-rt/test/asan/TestCases/leaks.cpp
RUN: at line 6: not  /b/sanitizer-x86_64-linux/build/build_default/runtimes/runtimes-bins/compiler-rt/test/asan/I386LinuxDynamicConfig/TestCases/Output/leaks.cpp.tmp 1 2>&1 | FileCheck /b/sanitizer-x86_64-linux/build/llvm-project/compiler-rt/test/asan/TestCases/leaks.cpp
+ not /b/sanitizer-x86_64-linux/build/build_default/runtimes/runtimes-bins/compiler-rt/test/asan/I386LinuxDynamicConfig/TestCases/Output/leaks.cpp.tmp 1
+ FileCheck /b/sanitizer-x86_64-linux/build/llvm-project/compiler-rt/test/asan/TestCases/leaks.cpp
RUN: at line 7: not  /b/sanitizer-x86_64-linux/build/build_default/runtimes/runtimes-bins/compiler-rt/test/asan/I386LinuxDynamicConfig/TestCases/Output/leaks.cpp.tmp 1000 2>&1 | FileCheck /b/sanitizer-x86_64-linux/build/llvm-project/compiler-rt/test/asan/TestCases/leaks.cpp
+ not /b/sanitizer-x86_64-linux/build/build_default/runtimes/runtimes-bins/compiler-rt/test/asan/I386LinuxDynamicConfig/TestCases/Output/leaks.cpp.tmp 1000
+ FileCheck /b/sanitizer-x86_64-linux/build/llvm-project/compiler-rt/test/asan/TestCases/leaks.cpp
RUN: at line 8: not  /b/sanitizer-x86_64-linux/build/build_default/runtimes/runtimes-bins/compiler-rt/test/asan/I386LinuxDynamicConfig/TestCases/Output/leaks.cpp.tmp 1000000 2>&1 | FileCheck /b/sanitizer-x86_64-linux/build/llvm-project/compiler-rt/test/asan/TestCases/leaks.cpp
+ FileCheck /b/sanitizer-x86_64-linux/build/llvm-project/compiler-rt/test/asan/TestCases/leaks.cpp
+ not /b/sanitizer-x86_64-linux/build/build_default/runtimes/runtimes-bins/compiler-rt/test/asan/I386LinuxDynamicConfig/TestCases/Output/leaks.cpp.tmp 1000000
RUN: at line 9: not  /b/sanitizer-x86_64-linux/build/build_default/runtimes/runtimes-bins/compiler-rt/test/asan/I386LinuxDynamicConfig/TestCases/Output/leaks.cpp.tmp 10000000 2>&1 | FileCheck /b/sanitizer-x86_64-linux/build/llvm-project/compiler-rt/test/asan/TestCases/leaks.cpp
+ not /b/sanitizer-x86_64-linux/build/build_default/runtimes/runtimes-bins/compiler-rt/test/asan/I386LinuxDynamicConfig/TestCases/Output/leaks.cpp.tmp 10000000
+ FileCheck /b/sanitizer-x86_64-linux/build/llvm-project/compiler-rt/test/asan/TestCases/leaks.cpp
/b/sanitizer-x86_64-linux/build/llvm-project/compiler-rt/test/asan/TestCases/leaks.cpp:37:11: error: CHECK: expected string not found in input
// CHECK: LeakSanitizer: detected memory leaks
          ^
<stdin>:1:1: note: scanning from here
t: 0xe2cd9800
^

Input file: <stdin>
Check file: /b/sanitizer-x86_64-linux/build/llvm-project/compiler-rt/test/asan/TestCases/leaks.cpp

-dump-input=help explains the following input dump.

Step 9 (test compiler-rt symbolizer) failure: test compiler-rt symbolizer (failure)
...
llvm-lit: /b/sanitizer-x86_64-linux/build/llvm-project/compiler-rt/test/fuzzer/lit.cfg.py:60: note: linux feature available
llvm-lit: /b/sanitizer-x86_64-linux/build/llvm-project/compiler-rt/test/fuzzer/lit.cfg.py:36: note: lsan feature available
llvm-lit: /b/sanitizer-x86_64-linux/build/llvm-project/compiler-rt/test/fuzzer/lit.cfg.py:45: note: msan feature unavailable
llvm-lit: /b/sanitizer-x86_64-linux/build/llvm-project/compiler-rt/test/fuzzer/lit.cfg.py:60: note: linux feature available
llvm-lit: /b/sanitizer-x86_64-linux/build/llvm-project/compiler-rt/test/fuzzer/lit.cfg.py:36: note: lsan feature available
llvm-lit: /b/sanitizer-x86_64-linux/build/llvm-project/compiler-rt/test/fuzzer/lit.cfg.py:48: note: msan feature available
llvm-lit: /b/sanitizer-x86_64-linux/build/llvm-project/compiler-rt/test/fuzzer/lit.cfg.py:60: note: linux feature available
llvm-lit: /b/sanitizer-x86_64-linux/build/llvm-project/llvm/utils/lit/lit/main.py:72: note: The test suite configuration requested an individual test timeout of 0 seconds but a timeout of 900 seconds was requested on the command line. Forcing timeout to be 900 seconds.
-- Testing: 10001 tests, 80 workers --
Testing:  0.. 10..
FAIL: AddressSanitizer-i386-linux-dynamic :: TestCases/leaks.cpp (1817 of 10001)
******************** TEST 'AddressSanitizer-i386-linux-dynamic :: TestCases/leaks.cpp' FAILED ********************
Exit Code: 1

Command Output (stderr):
--
RUN: at line 4: /b/sanitizer-x86_64-linux/build/build_default/./bin/clang  --driver-mode=g++ -fsanitize=address -mno-omit-leaf-frame-pointer -fno-omit-frame-pointer -fno-optimize-sibling-calls -gline-tables-only  -m32  -shared-libasan -O0 /b/sanitizer-x86_64-linux/build/llvm-project/compiler-rt/test/asan/TestCases/leaks.cpp -o /b/sanitizer-x86_64-linux/build/build_default/runtimes/runtimes-bins/compiler-rt/test/asan/I386LinuxDynamicConfig/TestCases/Output/leaks.cpp.tmp
+ /b/sanitizer-x86_64-linux/build/build_default/./bin/clang --driver-mode=g++ -fsanitize=address -mno-omit-leaf-frame-pointer -fno-omit-frame-pointer -fno-optimize-sibling-calls -gline-tables-only -m32 -shared-libasan -O0 /b/sanitizer-x86_64-linux/build/llvm-project/compiler-rt/test/asan/TestCases/leaks.cpp -o /b/sanitizer-x86_64-linux/build/build_default/runtimes/runtimes-bins/compiler-rt/test/asan/I386LinuxDynamicConfig/TestCases/Output/leaks.cpp.tmp
/b/sanitizer-x86_64-linux/build/llvm-project/compiler-rt/test/asan/TestCases/leaks.cpp:16:16: warning: unknown attribute 'noopt' ignored [-Wunknown-attributes]
   16 | __attribute__((noopt)) void leak(int n) {
      |                ^~~~~
1 warning generated.
RUN: at line 5: not  /b/sanitizer-x86_64-linux/build/build_default/runtimes/runtimes-bins/compiler-rt/test/asan/I386LinuxDynamicConfig/TestCases/Output/leaks.cpp.tmp 0 2>&1 | FileCheck /b/sanitizer-x86_64-linux/build/llvm-project/compiler-rt/test/asan/TestCases/leaks.cpp
+ not /b/sanitizer-x86_64-linux/build/build_default/runtimes/runtimes-bins/compiler-rt/test/asan/I386LinuxDynamicConfig/TestCases/Output/leaks.cpp.tmp 0
+ FileCheck /b/sanitizer-x86_64-linux/build/llvm-project/compiler-rt/test/asan/TestCases/leaks.cpp
RUN: at line 6: not  /b/sanitizer-x86_64-linux/build/build_default/runtimes/runtimes-bins/compiler-rt/test/asan/I386LinuxDynamicConfig/TestCases/Output/leaks.cpp.tmp 1 2>&1 | FileCheck /b/sanitizer-x86_64-linux/build/llvm-project/compiler-rt/test/asan/TestCases/leaks.cpp
+ not /b/sanitizer-x86_64-linux/build/build_default/runtimes/runtimes-bins/compiler-rt/test/asan/I386LinuxDynamicConfig/TestCases/Output/leaks.cpp.tmp 1
+ FileCheck /b/sanitizer-x86_64-linux/build/llvm-project/compiler-rt/test/asan/TestCases/leaks.cpp
RUN: at line 7: not  /b/sanitizer-x86_64-linux/build/build_default/runtimes/runtimes-bins/compiler-rt/test/asan/I386LinuxDynamicConfig/TestCases/Output/leaks.cpp.tmp 1000 2>&1 | FileCheck /b/sanitizer-x86_64-linux/build/llvm-project/compiler-rt/test/asan/TestCases/leaks.cpp
+ not /b/sanitizer-x86_64-linux/build/build_default/runtimes/runtimes-bins/compiler-rt/test/asan/I386LinuxDynamicConfig/TestCases/Output/leaks.cpp.tmp 1000
+ FileCheck /b/sanitizer-x86_64-linux/build/llvm-project/compiler-rt/test/asan/TestCases/leaks.cpp
RUN: at line 8: not  /b/sanitizer-x86_64-linux/build/build_default/runtimes/runtimes-bins/compiler-rt/test/asan/I386LinuxDynamicConfig/TestCases/Output/leaks.cpp.tmp 1000000 2>&1 | FileCheck /b/sanitizer-x86_64-linux/build/llvm-project/compiler-rt/test/asan/TestCases/leaks.cpp
+ FileCheck /b/sanitizer-x86_64-linux/build/llvm-project/compiler-rt/test/asan/TestCases/leaks.cpp
+ not /b/sanitizer-x86_64-linux/build/build_default/runtimes/runtimes-bins/compiler-rt/test/asan/I386LinuxDynamicConfig/TestCases/Output/leaks.cpp.tmp 1000000
RUN: at line 9: not  /b/sanitizer-x86_64-linux/build/build_default/runtimes/runtimes-bins/compiler-rt/test/asan/I386LinuxDynamicConfig/TestCases/Output/leaks.cpp.tmp 10000000 2>&1 | FileCheck /b/sanitizer-x86_64-linux/build/llvm-project/compiler-rt/test/asan/TestCases/leaks.cpp
+ not /b/sanitizer-x86_64-linux/build/build_default/runtimes/runtimes-bins/compiler-rt/test/asan/I386LinuxDynamicConfig/TestCases/Output/leaks.cpp.tmp 10000000
+ FileCheck /b/sanitizer-x86_64-linux/build/llvm-project/compiler-rt/test/asan/TestCases/leaks.cpp
/b/sanitizer-x86_64-linux/build/llvm-project/compiler-rt/test/asan/TestCases/leaks.cpp:37:11: error: CHECK: expected string not found in input
// CHECK: LeakSanitizer: detected memory leaks
          ^
<stdin>:1:1: note: scanning from here
t: 0xe2cd9800
^

Input file: <stdin>
Check file: /b/sanitizer-x86_64-linux/build/llvm-project/compiler-rt/test/asan/TestCases/leaks.cpp

-dump-input=help explains the following input dump.


Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants