golang 使用 cgo 调用 c 库时未检测到消毒剂泄漏

sanitizer-leak is NOT detected when golang using cgo to call c library

总结

之前我使用的是 clang-3.8.1,使用 AddressSanitizer 时 sanitizer 崩溃了。而且 leakSanitizer 根本不起作用。

然后我尝试使用clang-llvm-10.0,AddressSanitizer可以检测到地址问题并正常工作。

但是golang使用cgo调用C时无法检测到泄漏问题是否可以使用leak-sanitizer来检测内存泄漏问题C/C+ + 当 golang 使用 CGO 时的库?

例子

package main

// #include <stdlib.h>
//
// int test()
// {
//   int *p = (int *)malloc(10 * sizeof(int));
//   free(p);
//   p[1] = 42;
//   return p[1];
// }
import "C"
import "fmt"

func main() {
  fmt.Println(int(C.test()))
  // Output: 42
}
[root@380c7770b175 cplusplus]# CC="clang" CGO_CFLAGS="-O0 -g -fsanitize=address" CGO_LDFLAGS="-fsanitize=address" go run cgo-sanitizer.go
=================================================================
==25680==ERROR: AddressSanitizer: heap-use-after-free on address 0x604000000014 at pc 0x00000054fc2d bp 0x7ffd96a943b0 sp 0x7ffd96a943a8
WRITE of size 4 at 0x604000000014 thread T0
    #0 0x54fc2c in test (/tmp/go-build237509829/b001/exe/cgo-sanitizer+0x54fc2c)
    #1 0x54fcc1 in _cgo_a3187169dba5_Cfunc_test (/tmp/go-build237509829/b001/exe/cgo-sanitizer+0x54fcc1)
    #2 0x5159df  (/tmp/go-build237509829/b001/exe/cgo-sanitizer+0x5159df)
package main

// #include <stdlib.h>
//
// int *p;
// int test()
// {
//   p = (int *)malloc(10 * sizeof(int));
//   p = 0;
//   return 52;
// }
import "C"
import "fmt"

func main() {
  fmt.Println(int(C.test()))
  // Output: 52
}
[root@380c7770b175 cplusplus]# CC="clang" CGO_CFLAGS="-O0 -g -fsanitize=leak" CGO_LDFLAGS="-fsanitize=address" go run cgo-sanitizer-leak.go
52

环境

[root@380c7770b175 cplusplus]# cat /proc/version
Linux version 3.10.0-493.el7.x86_64 (mockbuild@x86-020.build.eng.bos.redhat.com) (gcc version 4.8.5 20150623 (Red Hat 4.8.5-9) (GCC) ) #1 SMP Tue Aug 16 11:45:26 EDT 2016

[root@380c7770b175 cplusplus]# clang -v
clang version 10.0.0
Target: x86_64-unknown-linux-gnu
Thread model: posix
InstalledDir: /usr/local/llvm-10.0/bin
Found candidate GCC installation: /usr/lib/gcc/x86_64-redhat-linux/4.8.2
Found candidate GCC installation: /usr/lib/gcc/x86_64-redhat-linux/4.8.5
Selected GCC installation: /usr/lib/gcc/x86_64-redhat-linux/4.8.5
Candidate multilib: .;@m64
Candidate multilib: 32;@m32
Selected multilib: .;@m64

[root@380c7770b175 cplusplus]# go version
go version go1.13.6 linux/amd64

原问题

https://github.com/google/sanitizers/issues/1223

我已经通过在进程退出时显式调用 __lsan_do_leak_check() 解决了这个问题。

__lsan_do_leak_check() 在

中声明

https://github.com/llvm/llvm-project/blob/master/compiler-rt/include/sanitizer/lsan_interface.h

我猜想这与c-main启动机制有关并且__lsan_do_leak_check()没有为golang启动注册。

欢迎任何可以继续挖掘它的人。

@Shawn 是正确的,如果您的主程序是用 Go 编写的,则需要手动调用 __lsan_do_leak_check。如果你的 main 在 C/C++ 中并且 Go 被作为库调用那么它就不需要了。

这是一个简单的例子

package main

// #include <stdio.h>
// #include <stdlib.h>
//
// void __lsan_do_leak_check(void);
//
// void leak_a_bit(void)
// {
//     char* p = malloc(2000);
//     printf("%p\n", p);
// }
import "C"

func main() {
        C.leak_a_bit()

        C.__lsan_do_leak_check()
}

像这样编译和运行

$ CC=clang CGO_ENABLED=1 CGO_LDFLAGS='-fsanitize=address' CGO_CFLAGS='-fsanitize=address' go build -o main

$ ./main