This is an archive of the discontinued LLVM Phabricator instance.

Differential D100907

[lsan][docs] Clarify supported platforms
ClosedPublic

Authored by MaskRay on Apr 20 2021, 4:14 PM.

Details

Reviewers
vitalybuka
Group Reviewers
Restricted Project
Commits
rG4cbe4881882e: [lsan][docs] Clarify supported platforms

Diff Detail

Event Timeline

MaskRay requested review of this revision.Apr 20 2021, 4:14 PM
MaskRay created this revision.
Herald added a project: Restricted Project. · View Herald TranscriptApr 20 2021, 4:14 PM
Herald added a subscriber: cfe-commits. · View Herald Transcript
MaskRay updated this revision to Diff 339032.Apr 20 2021, 4:17 PM

add i386/aarch64 to macOS

vitalybuka added inline comments.Apr 20 2021, 4:22 PM
clang/docs/LeakSanitizer.rst
49

Apple is incomplete and riscv is missing

if(APPLE)
  set(ALL_LSAN_SUPPORTED_ARCH ${X86} ${X86_64} ${MIPS64} ${ARM64})
else()
  set(ALL_LSAN_SUPPORTED_ARCH ${X86} ${X86_64} ${MIPS64} ${ARM64} ${ARM32} ${PPC64} ${S390X} ${RISCV64})
endif()
MaskRay added inline comments.Apr 20 2021, 4:25 PM
clang/docs/LeakSanitizer.rst
49

I'll add riscv64 for Linux.

But wait, lib/sanitizer_common/sanitizer_stoptheworld_mac.cpp doesn't mention mips64...

MaskRay updated this revision to Diff 339039.Apr 20 2021, 4:28 PM

Add Linux riscv64.
Add Fuchsia

Herald added subscribers: phosek, s.egerton, simoncook. · View Herald TranscriptApr 20 2021, 4:28 PM
phosek added inline comments.Apr 20 2021, 4:32 PM
clang/docs/LeakSanitizer.rst
50

You can clarify that Fuchsia supports aarch64 and x86_64.

MaskRay updated this revision to Diff 339045.Apr 20 2021, 4:35 PM

Fuchsia -> Fuchsia aarch64/x86_64

vitalybuka accepted this revision.Apr 20 2021, 4:45 PM
vitalybuka added inline comments.
clang/docs/LeakSanitizer.rst
49

maybe work in progress

This revision is now accepted and ready to land.Apr 20 2021, 4:45 PM
MaskRay marked an inline comment as done.Apr 20 2021, 4:51 PM
MaskRay added subscribers: fjricci, delcypher.
MaskRay added inline comments.
clang/docs/LeakSanitizer.rst
49

Likely a copy-paste error from de3b9a2ecc7e9ebe3fc1780aede0223821c52d2a

I can delete it.

CC @delcypher @fjricci who have touched the macOS code.

MaskRay marked an inline comment as done.Apr 20 2021, 4:52 PM
Harbormaster completed remote builds in B99836: Diff 339030.Apr 20 2021, 5:41 PM
Harbormaster completed remote builds in B99838: Diff 339032.Apr 20 2021, 5:49 PM
Harbormaster completed remote builds in B99844: Diff 339039.Apr 20 2021, 6:05 PM
Harbormaster completed remote builds in B99849: Diff 339045.Apr 20 2021, 6:35 PM
Closed by commit rG4cbe4881882e: [lsan][docs] Clarify supported platforms (authored by MaskRay). · Explain WhyApr 21 2021, 10:28 AM
This revision was automatically updated to reflect the committed changes.
MaskRay added a commit: rG4cbe4881882e: [lsan][docs] Clarify supported platforms.

Revision Contents

PathSize
clang/
docs/
13 lines

Diff 339309

clang/docs/LeakSanitizer.rst

Show All 11 Lines
:doc:`AddressSanitizer` to get both memory error and leak detection, or :doc:`AddressSanitizer` to get both memory error and leak detection, or
used in a stand-alone mode. LSan adds almost no performance overhead used in a stand-alone mode. LSan adds almost no performance overhead
until the very end of the process, at which point there is an extra leak until the very end of the process, at which point there is an extra leak
detection phase. detection phase.
Usage Usage
===== =====
LeakSanitizer is supported on x86\_64 Linux and macOS. In order to use it, :doc:`AddressSanitizer`: integrates LeakSanitizer and enables it by default on
simply build your program with :doc:`AddressSanitizer`: supported platforms.
.. code-block:: console .. code-block:: console
$ cat memory-leak.c $ cat memory-leak.c
#include <stdlib.h> #include <stdlib.h>
void *p; void *p;
int main() { int main() {
p = malloc(7); p = malloc(7);
p = 0; // The memory is leaked here. p = 0; // The memory is leaked here.
return 0; return 0;
} }
% clang -fsanitize=address -g memory-leak.c ; ASAN_OPTIONS=detect_leaks=1 ./a.out % clang -fsanitize=address -g memory-leak.c ; ASAN_OPTIONS=detect_leaks=1 ./a.out
==23646==ERROR: LeakSanitizer: detected memory leaks ==23646==ERROR: LeakSanitizer: detected memory leaks
Direct leak of 7 byte(s) in 1 object(s) allocated from: Direct leak of 7 byte(s) in 1 object(s) allocated from:
#0 0x4af01b in __interceptor_malloc /projects/compiler-rt/lib/asan/asan_malloc_linux.cc:52:3 #0 0x4af01b in __interceptor_malloc /projects/compiler-rt/lib/asan/asan_malloc_linux.cc:52:3
#1 0x4da26a in main memory-leak.c:4:7 #1 0x4da26a in main memory-leak.c:4:7
#2 0x7f076fd9cec4 in __libc_start_main libc-start.c:287 #2 0x7f076fd9cec4 in __libc_start_main libc-start.c:287
SUMMARY: AddressSanitizer: 7 byte(s) leaked in 1 allocation(s). SUMMARY: AddressSanitizer: 7 byte(s) leaked in 1 allocation(s).
To use LeakSanitizer in stand-alone mode, link your program with To use LeakSanitizer in stand-alone mode, link your program with
``-fsanitize=leak`` flag. Make sure to use ``clang`` (not ``ld``) for the ``-fsanitize=leak`` flag. Make sure to use ``clang`` (not ``ld``) for the
link step, so that it would link in proper LeakSanitizer run-time library link step, so that it would link in proper LeakSanitizer run-time library
into the final executable. into the final executable.
Supported Platforms
===================
* Android aarch64/i386/x86_64
vitalybukaUnsubmitted
Not Done
ReplyInline Actions

Apple is incomplete and riscv is missing

if(APPLE)
  set(ALL_LSAN_SUPPORTED_ARCH ${X86} ${X86_64} ${MIPS64} ${ARM64})
else()
  set(ALL_LSAN_SUPPORTED_ARCH ${X86} ${X86_64} ${MIPS64} ${ARM64} ${ARM32} ${PPC64} ${S390X} ${RISCV64})
endif()
vitalybuka: Apple is incomplete and riscv is missing ``` if(APPLE) set(ALL_LSAN_SUPPORTED_ARCH ${X86}…
MaskRayAuthorUnsubmitted
Done
ReplyInline Actions

I'll add riscv64 for Linux.

But wait, lib/sanitizer_common/sanitizer_stoptheworld_mac.cpp doesn't mention mips64...

MaskRay: I'll add riscv64 for Linux. But wait, lib/sanitizer_common/sanitizer_stoptheworld_mac.cpp…
vitalybukaUnsubmitted
Not Done
ReplyInline Actions

maybe work in progress

vitalybuka: maybe work in progress
MaskRayAuthorUnsubmitted
Done
ReplyInline Actions

Likely a copy-paste error from de3b9a2ecc7e9ebe3fc1780aede0223821c52d2a

I can delete it.

CC @delcypher @fjricci who have touched the macOS code.

MaskRay: Likely a copy-paste error from de3b9a2ecc7e9ebe3fc1780aede0223821c52d2a I can delete it. CC…
* Fuchsia aarch64/x86_64
phosekUnsubmitted
Done
ReplyInline Actions

You can clarify that Fuchsia supports aarch64 and x86_64.

phosek: You can clarify that Fuchsia supports aarch64 and x86_64.
* Linux arm/aarch64/mips64/ppc64/ppc64le/riscv64/s390x/i386/x86\_64
* macOS aarch64/i386/x86\_64
* NetBSD i386/x86_64
More Information More Information
================ ================
`<https://github.com/google/sanitizers/wiki/AddressSanitizerLeakSanitizer>`_ `<https://github.com/google/sanitizers/wiki/AddressSanitizerLeakSanitizer>`_