我应该如何在clang中使用消毒剂？

Question

很抱歉，如果这是一个超级简单的概念，但我发现很难获得正确的心态才能正确使用clang 提供的消毒剂。

float foo(float f) { return (f / 0); }

我用这个小sn-p编译

clang++ -fsanitize=float-divide-by-zero -std=c++11 -stdlib=libc++ -c source.cpp -o osan

我还编译了我的对象的“正常”版本而不使用消毒剂

clang++ -std=c++11 -stdlib=libc++ -c source.cpp -o onorm

我期待一些详细的输出，或者来自控制台的一些错误，但是在使用 nm 检查文件时，我只发现了 1 个不同

nm o* --demangle

onorm:
0000000000000000 T foo(float)

osan:
                 U __ubsan_handle_divrem_overflow
0000000000000000 T foo(float)

所以在净化版本中有一个未定义的符号，其名称类似于我在编译时使用的净化器；但一切都是真正的“沉默”，clang前端根本没有输出。

我应该如何使用消毒剂以及正确的工作流程是什么？那个未定义的符号有什么意义？

Answer 1

未定义符号是一个实现消毒剂检查的函数。如果您查看生成的代码：

没有消毒剂：

_Z3foof:                                # @_Z3foof
    .cfi_startproc
# BB#0:
    xorps   %xmm1, %xmm1
    divss   %xmm1, %xmm0
    ret

使用消毒剂：

_Z3foof:                                # @_Z3foof
    .cfi_startproc
    .long   1413876459              # 0x54460aeb
    .quad   _ZTIFffE
# BB#0:
    pushq   %rax
.Ltmp1:
    .cfi_def_cfa_offset 16
    movss   %xmm0, 4(%rsp)          # 4-byte Spill
    movd    %xmm0, %esi
    movl    $__unnamed_1, %edi
    xorl    %edx, %edx
    callq   __ubsan_handle_divrem_overflow
    xorps   %xmm1, %xmm1
    movss   4(%rsp), %xmm0          # 4-byte Reload
    divss   %xmm1, %xmm0
    popq    %rax
    ret

您会看到它添加了使用该函数进行检查的代码。

编译器应该自动链接到适当的清理库，然后对我来说是下面的完整程序：

float foo(float f) { return (f / 0); }
int main() {
    foo(1.0f);
}

执行时产生以下输出：

main.cpp:1:32: runtime error: division by zero

我使用命令 clang++ -fsanitize=undefined main.cpp && ./a.out 构建和运行

---

如果您想要编译时检查，您想要启用更多编译器警告或静态分析器。但是，似乎没有针对浮点除零错误的任何警告或静态分析检查。

这是一个生成分析报告的程序：

#include <malloc.h>

int main() {
    int *i = (int*) malloc(sizeof(int));
}

使用clang++ -std=c++11 main.cpp 编译时不会产生任何诊断信息，但使用clang++ -std=c++11 --analyze main.cpp 编译时会报告以下内容：

main.cpp:4:10: warning: Value stored to 'i' during its initialization is never read
    int *i = (int*) malloc(sizeof(int));
         ^   ~~~~~~~~~~~~~~~~~~~~~~~~~~
main.cpp:5:1: warning: Potential leak of memory pointed to by 'i'
}
^

dead store 也可以用 -Weverything [-Wunused-value] 检测到，但泄漏只能由分析器检测到。

默认情况下，完整的分析结果会写入 plist 文件。您还可以使用以下命令运行分析器：

clang++ --analyze -Xanalyzer -analyzer-output=text main.cpp
clang++ --analyze -Xanalyzer -analyzer-output=html -o html-dir main.cpp

分别在标准输出或通过带注释源代码的 html 显示而不是在 plist 中获取检测到的问题的详细演练。

分析器检查列出here。

请注意，为了达到最佳效果，分析器需要分析整个程序，这意味着它需要与构建系统相关联。通常的界面是通过 IDE (Xcode) 或带有 make 的 scan-build 工具。 CMake 具有一些 clang 功能，例如生成 clang JSON compilation database files，但我不确定 CMake 是否有任何内置支持 clang 分析器。

Answer 2

因此，如果我们查看 Controlling Code Generation 中的文档，它会说（强调我的）：

为各种形式的未定义或可疑行为打开运行时检查。

此选项控制 Clang 是否为各种形式的未定义或可疑行为添加运行时检查，默认情况下禁用。如果检查失败，会在运行时生成诊断消息，解释问题。

所以这些是运行时检查而不是编译时检查。因此，如果您在代码中使用了foo，那么您将看到以下输出：

运行时错误：除以零

使用-fsanitize=undefined查看此示例live：

float foo(float f) { return (f / 0); }

int main()
{
    int x = 1 << 100 ;
    foo( 2.0f ) ;
}

它会生成两条运行时消息：

main.cpp:6:19: 运行时错误：移位指数 100 对于 32 位类型“int”来说太大

main.cpp:2:36: 运行时错误：除以零

更新

关于静态检查器，在我对A C++ implementation that detects undefined behavior? 的回答中，我提到了几个工具：STACK、kcc，当然还有Frama-C。

显然clang 允许您使用--analyze to run it's static checker，但它似乎最终可能会被禁用，并且运行它的正确方法是通过scan-build。

在我的自我回答问题Why do constant expressions have an exclusion for undefined behavior? 中，我展示了如何使用constexprs 在编译时捕获未定义的行为。