Leak sanitizer support for Android on arm64

[ramosian-glider]

Originally reported on Google Code with ID 379

This is for porting leak sanitizer for Android with arm64. It seems 32bit arm had issues
documented at https://code.google.com/p/address-sanitizer/issues/detail?id=294&can=1&q=leak%20sanitizer&colspec=ID%20Type%20Status%20Priority%20OpSys%20Owner%20Summary.

  But is there any plan to port for arm64, now that there are 64 bit processors running
Android.

Reported by vairavans on 2015-03-06 23:47:18

[ramosian-glider]

We don't have plans yet, but it's in our radar. We need to make ARM stable runtime first.

Reported by rengolin on 2015-03-07 00:52:22

[ramosian-glider]

Thanks for the update. Do you have any recommendations in the short term? I have tried
using Valgrind for Android but the applications are practically slow that its hard
to execute any use case.

Reported by vairavans on 2015-03-07 02:45:42

[ramosian-glider]

There are several problems here, actually. 
1. Make lsan work on AArch64 Linux. I don't know the status of this, but it should
be easy to accomplish. 
2. Make lsan work on Android, x86_64 and AArch64.

>> Do you have any recommendations in the short term?
Nope. Unless of course you want to help us with the development. :( / :) 

Reported by konstantin.s.serebryany on 2015-03-07 02:52:48

[ramosian-glider]

Sure, i can give it a shot. Btw, android apps don't really have an exit unlike a typical
c program with a main. In c terms, android apps have a kind of an infinite loop which
doesn't quit. Would leak sanitizer still work in such cases?

Reported by vairavans on 2015-03-07 03:45:46

[ramosian-glider]

Right now we can call leak checking only once per process, 
but this does not necessary has to be done at the very end.  

From lsan_interface.h:
  // Calling this function makes LSan enter the leak checking phase immediately.
  // Use this if normal end-of-process leak checking happens too late (e.g. if
  // you have intentional memory leaks in your shutdown code). Calling this
  // function overrides end-of-process leak checking; it must be called at
  // most once per process. This function will terminate the process if there
  // are memory leaks and the exit_code flag is non-zero.
  void __lsan_do_leak_check();

Reported by konstantin.s.serebryany on 2015-03-07 05:36:25

[ramosian-glider]

For the record, I've recently added a new interface function which allows multiple leak
checks:

  // Check for leaks now. Returns zero if no leaks have been found or if leak
  // detection is disabled, non-zero otherwise.
  // This function may be called repeatedly, e.g. to periodically check a
  // long-running process. It prints a leak report if appropriate, but does not
  // terminate the process. It does not affect the behavior of
  // __lsan_do_leak_check() or the end-of-process leak check, and is not
  // affected by them.
  int __lsan_do_recoverable_leak_check();

> 1. Make lsan work on AArch64 Linux. I don't know the status of this, but it should
be easy to accomplish. 

Recently this was done for MIPS. I invite you (vairavans) to take a look at those patches
to get an idea of the scope of work. Basically you will have to:
- port stoptheworld (reimplementing internal_clone() will probably be the bulk of this),
- port the TLS discovery code,
- pick up a few platform-dependent bits and pieces in lsan_common.

Reported by earthdok@google.com on 2015-05-22 15:20:49

[ramosian-glider]

Adding Project:AddressSanitizer as part of GitHub migration.

Reported by ramosian.glider on 2015-07-30 09:06:35

• Labels added: ProjectAddressSanitizer

[polishcode]

@ramosian-glider

I am currently trying to use described functionality in my android library:

#include <sanitizer/lsan_interface.h>
__lsan_do_leak_check();
__lsan_do_recoverable_leak_check();

However, the linking stage fails:
xxxxx.cpp:481: error: undefined reference to '__lsan_do_leak_check'

How can I link from Android.mk to implementation of that function?

[edit]

In fact, I wonder what is the current status of Leak sanitizer support for Android. There is couple of information scattered thorough the wiki/Internet when regarding debugging applications/so libraries, but no concise description. E.g.:

• it works only on 64-bit architectures
• it is enabled by default in a standard address sanitizer run
• address sanitizer works only on following Android architectures: armeabi armeabi-v7a x86
• leak sanitizer can be triggered to dump info via __lsan_do_leak_check()/ __lsan_do_recoverable_leak_check() - how can i trigger that for android application?

I managed to compile my library with address sanitizer support on armeabi, armeabi-v7a, arm64-v8a, x86; build for x86_64 failed.

[edit2]

Upon running my library for arm64-v8a on an emulator it crashes with:
java.lang.UnsatisfiedLinkError: dlopen failed: library "libclang_rt.asan-aarch64-android.so"
therefore I could not find any working setup that provides working leak sanitizer for Android.