Clang 12 documentation包含了一系列工具，如 AddressSanitizer、ThreadSanitizer、LeakSanitizer、LibTooling等。

这部分是对clang文档 Clang 12 documentation AddressSanitizer 的翻译。仅供参考。

翻译是一件头疼的事情，不光考验英文，更考验对于原文档的理解程度，更有一些专业的技术名词和术语。。。

AddressSanitizer是一个快速探测内存错误的工具。包含了一个编译器插桩（compiler instrumentation）模块和一个运行时库（run-time library）。该工具可以检测如下类型的bug：

通常情况下，AddressSanitizer会带来2x的性能损耗。

使用 CMake 来构建 LLVM/Clang。

简单地使用 -fsanitize=address 标记来编译链接代码即可。AddressSanitizer 的 run-time library 应该被链接到最终的可执行文件中，所以确保使用 clang（而非ld） 来执行最终的链接操作。当链接共享库的时候，AddressSanitizer runtime 库不会被链接。所以，-Wl, -z, defs 可能导致链接错误（不要跟 AddressSanitizer 一起使用）。使用 -O1 或更高的优化标记，可以获取更为合理的性能。使用 -fno-omit-frame-pointer ，可以在错误信息中提取更有意义的栈帧信息。为了获取完美的栈帧信息，可能需要禁用内联（仅使用 -O1）和跟踪调用消除（-fno-optimize-sibling-calls）（这里英文是 tail call elimination）。

或者

如果检测到了一个bug，程序会打印出一个错误信息到 stderr，并且退出（退出状态码非0）。AddressSanitizer会在首次检测到错误的时候退出。这样设计的原因在于：

如果你的程序是一个黑盒，并且运行在OS X 10.10或者更早版本，则需要设置 DYLD_INSERT_LIBRARIES 环境变量，将其指向ASan库，该库包含在编译器里边。（你可以通过搜索动态链接库，查看名称中包含asan的库）。如果该环境变量没有设置，程序会尝试重新执行。另外，如果可执行文件移动到其他机器中，ASan 库也需要复制一份。

为了使得 AddressSanitizer 符号化其输出，需要设置 ASAN_SYMBOLIZER_PATH 环境变量，将其指向 llvm-symbolizer 库（或者确保 llvm-symbolizer 在系统的 $PATH 中）。

如果不生效，则需要使用一个单独的脚本，来独立（offline）符号化这些结果。（可以通过设置 ASAN_OPTIONS=symbolize=0 来强制禁用协同符号化（英文是online symbolization））。

注意，在macOS上，需要对二进制运行 dsymutil 命令来将文件行号（file:line）加到 AddressSanitizer 的报告中。

AddressSanitizer能够顺便检测动态初始化顺序的一些问题，如在一个转换单元中定义的一个全局变量，其初始化过程需要用到另一个转换单元中的全局变量。可以通过设置环境变量 ASAN_OPTIONS=check_initialization_order=1 来在runtime时开启该项检查。

注意，该选项在macOS上不支持。

若想要获取 AddressSanitizer 中检测内存泄露的更多信息，可以查看 LeakSanitizer。在Linux系统中，内存泄露检测是默认开启的，在macOS中可以使用 ASAN_OPTIONS=detect_leaks=1 来开启。而其他平台则暂时不支持。

AddressSanitizer 通常不会误报问题。如果发现误报，再次检测。

运行时插桩（Runtime interposition）允许 AddressSanitizer 在未经重新编译的代码中查找问题。如果遇到一个外部库的问题，建议尽快将其汇报给库的维护者。

However, you can use the following suppression mechanism to unblock yourself and continue on with the testing. This suppression mechanism should only be used for suppressing issues in external code; it does not work on code recompiled with AddressSanitizer. To suppress errors in external libraries, set the ASAN_OPTIONS environment variable to point to a suppression file. You can either specify the full path to the file or the path of the file relative to the location of your executable.

使用下边的格式来指定需要剔除的函数名或者库名。这些在错误报告中可以看到。谨记：剔除的范围越小，就能捕获到更多的bug。

在一些案例中，可能需要根据 AddressSanitizer 是否开启来执行不同的代码。这种场景下，使用 __has_feature 即可。

一些代码不应该使用 AddressSanitizer 来做相关的代码插桩。可以使用编译属性 attribute((no_sanitize("address")) (已经弃用了 synonyms no_sanitize_address 和 no_address_safety_analysis ) 来禁用指定函数的插桩。这个编译属性可能没有被其他编译器所支持，所以建议将其与 __has_feature(address_sanitizer) 结合使用。

The same attribute used on a global variable prevents AddressSanitizer from adding redzones around it and detecting out of bounds accesses.

AddressSanitizer supports src and fun entity types in Sanitizer special case list, that can be used to suppress error reports in the specified source files or functions. Additionally, AddressSanitizer introduces global and type entity types that can be used to suppress error reports for out-of-bound access to globals with certain names and types (you may only specify class or struct types).

可以使用一个初始的分类，将特定源码文件或特定全局变量的初始化顺序的问题，从原始报告中剔除。

使用 LeakSanitizer 生成的内存泄露报告（当作为 AddressSanitizer 的一部分运行的时候），可以通过传入一个单独的文件来剔除，传递下边参数：

该文件中会包含一些这样的格式 leak:。如果在泄露报告的符号化堆栈信息中，匹配到了任何函数名、源码文件名、或者库名，则内存泄露会被剔除掉。更多信息查看full documentation。

AddressSanitizer 支持如下平台：

从LLVM 3.1开始，AddressSanitizer 就在支持的平台上可以使用了。测试套件集成在CMake中，可以使用 make check-asan 命令来运行。

The Windows port is functional and is used by Chrome and Firefox, but it is not as well supported as the other ports.