Clang Static Analyzer 系列（一）编译 Clang 及运行 Checker

已于 2024-04-18 15:59:13 修改
阅读量2.3k 收藏 7
点赞数
分类专栏： 程序分析与漏洞检测 文章标签： 安全 系统安全 c++ 安全性测试
于 2022-11-08 15:22:47 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/yyyayo/article/details/127751413
版权

编译 Clang

CSA (Clang Static Analyzer) 是 clang 的一部分。建议使用自行编译的 clang ，源码在 llvm/llvm-project (github.com) 上获取。

编译 clang 前首先要生成 clang 的编译脚本。在生成 clang 的编译脚本时通常需要设置如下几个参数：

  • -S 源代码路径

  • -B 生成的编译脚本放置的目录

  • -G 编译工具的选择，对应生成不同工具需要的编译脚本，如 ninja ，默认是 make 和 cmake

  • -DLLVM_ENABLE_PROJECTS 说明要编译的子项目，如 clang 、 clang-tools-extra 等，默认是 all

  • -DCMAKE_BUILD_TYPE 说明编译的类型，如 Debug 、 Release 等，默认是 Debug

  • -CMAKE_INSTALL_PREFIX 类似于 configure 脚本的 –prefix ，用于配合 INSTALL 指令（ make install ）使用，指定安装路径

  • -DCMAKE_CXX_COMPILER 和 DCMAKE_C_COMPILER 指定使用的编译器，如 clang 或 gcc

使用 cmake 的例子1：

cd llvm-project
mkdir build
cd build
cmake -DLLVM_ENABLE_PROJECTS="clang;clang-tools-extra" -DCMAKE_BUILD_TYPE=Release -G "Unix Makefiles" ../llvm
cmake -DLLVM_ENABLE_PROJECTS=clang -G "Unix Makefiles" ../llvm
make

使用 cmake 的例子2：

git clone --depth 1 --branch llvmorg-12.0.1 https://github.com/llvm/llvm-project.git
cmake -S llvm-project/llvm -B llvm-project/build \
        -DCMAKE_BUILD_TYPE=Release \
        -DLLVM_ENABLE_PROJECTS=all \
        -DCMAKE_CXX_COMPILER=clang++ \
        -DCMAKE_C_COMPILER=clang
cmake --build llvm-project/build -j8
cmake --install llvm-project/build --prefix /usr/local  # or somewhere else

使用 ninja 的例子：

cd llvm-project
mkdir build
cd build
cmake -S ../llvm -B build -G Ninja -DLLVM_ENABLE_PROJECTS="clang;libcxx;libcxxabi" -DCMAKE_INSTALL_PREFIX=/home/xxx/llvm_project/build_tmp
cd build
ninja && ninja install

最终我的版本：

cd llvm-project
mkdir installed
# 编译 Debug 版本的 clang 和 clang-tools-extra ，中间编译脚本存储在 build ，生成的可执行程序包安装在 installed
cmake -S llvm -B build -DLLVM_ENABLE_PROJECTS="clang;clang-tools-extra" -DCMAKE_BUILD_TYPE=Debug -DCMAKE_CXX_COMPILER=clang++ -DCMAKE_C_COMPILER=clang -DCMAKE_INSTALL_PREFIX=$PWD/installed
# 使用 build 目录中的内容进行编译
cmake --build build -j8
# 安装到前面 DCMAKE_INSTALL_PREFIX 指定的目录
# 试过 cmake --install build --prefix installed 不成功
make install
# 把生成的 clang 等可执行文件路径设置到环境变量中
export PATH=/xxx/llvm-project/installed/bin/:$PATH

新版（240322）：

xz -dk llvm-project-15.0.4.src.tar.xz
tar -xf llvm-project-15.0.4.src.tar
mkdir llvm-project-15.0.4.src_installed
cd llvm-project-15.0.4.src
# 编译配置 Debug 版本的 clang 和 clang-tools-extra ，中间编译脚本存储在 build ，生成的可执行程序包安装在 installed
cmake -S llvm -B build -DLLVM_ENABLE_PROJECTS="clang;clang-tools-extra" -DCMAKE_BUILD_TYPE=Debug -DCMAKE_CXX_COMPILER=clang++ -DCMAKE_C_COMPILER=clang -DCMAKE_INSTALL_PREFIX=$PWD/../llvm-project-15.0.4.src_installed
# 使用 build 目录中的内容进行编译
cmake --build build -j8
# 安装到前面 DCMAKE_INSTALL_PREFIX 指定的目录
cd build && make install

参考：

Clang - Getting Started (llvm.org)

LLVM(1)-编译自己的LLVM和Clang - 掘金 (juejin.cn)

打印 AST CFG CallGraph ExplodedGraph 等信息

拥有 clang 的可执行文件后，我们可以先试一下输出代码的基础信息，如 AST 、 CFG 、 CallGraph 和 ExplodedGraph 。其中 AST 并非 CSA 提供的功能，后面三种图都可以通过指定 CSA 的 Checker 进行输出。 ExplodedGraph 是 CSA 中最重要的概念，包含了代码的执行路径和程序状态。这里需要注意使用 debug 开头的 Checker 需要 clang 是 Debug 版本，也就是如果想要输出 CFG 、 CallGraph 和 ExplodedGraph 信息，则需要编译 clang 时指定 -DCMAKE_BUILD_TYPE 为 Debug 。

打印 AST 信息：

clang -cc1 -ast-dump test.c

列出 CSA 中支持列出的信息：

# 以 llvm-project 12.0.1 为例，仅 -analyzer-checker-help 无法显示所有的 Checkers
# 若需要显示 debug 开头的 Checkers ，需要使用 -analyzer-checker-help-developer
clang -cc1 -analyzer-checker-help-developer

其中 debug 开头的 Checkers 有：

debug.AnalysisOrder           Print callbacks that are called during analysis in order
debug.ConfigDumper            Dump config table
debug.DebugContainerModeling  Check the analyzer's understanding of C++ containers
debug.DebugIteratorModeling   Check the analyzer's understanding of C++ iterators
debug.DumpCFG                 Display Control-Flow Graphs
debug.DumpCallGraph           Display Call Graph
debug.DumpCalls               Print calls as they are traversed by the engine
debug.DumpControlDependencies Print the post control dependency tree for a given CFG
debug.DumpDominators          Print the dominance tree for a given CFG
debug.DumpLiveExprs           Print results of live expression analysis
debug.DumpLiveVars            Print results of live variable analysis
debug.DumpPostDominators      Print the post dominance tree for a given CFG
debug.DumpTraversal           Print branch conditions as they are traversed by the engine
debug.ExprInspection          Check the analyzer's understanding of expressions
debug.ReportStmts             Emits a warning for every statement.
debug.Stats                   Emit warnings with analyzer statistics
debug.StdCLibraryFunctionsTester
Add test functions to the summary map, so testing of individual summary constituents becomes possible.
debug.StreamTester            Add test functions to StreamChecker for test and debugging purposes.
debug.TaintTest               Mark tainted symbols as such.
debug.ViewCFG                 View Control-Flow Graphs using GraphViz
debug.ViewCallGraph           View Call Graph using GraphViz
debug.ViewExplodedGraph       View Exploded Graphs using GraphViz

打印 CFG 、 CallGraph 、 ExplodedGraph 信息：

clang -cc1 -analyze -analyzer-checker=debug.DumpCFG test.c
# 针对 c++ ，建议使用 -Xclang 和 -c ，如果使用 -cc1 可能还需要手动 -I 指定库头文件地址
# -Xclang <arg>    Pass <arg> to the clang compiler  表示传参给编译器部分
# -c               Only run preprocess, compile, and assemble steps
clang++ -Xclang -analyze -Xclang -analyzer-checker=debug.DumpCFG -c test.cpp
# 或直接使用 --analyze 来执行 CSA ，就不需要使用 -c ，本身 CSA 就不会进行编译后的过程
clang++ --analyze -Xclang -analyzer-checker=debug.DumpCFG test.cpp
clang++ --analyze -Xclang -analyzer-checker=debug.ViewCFG test.cpp
clang++ --analyze -Xclang -analyzer-checker=debug.DumpCallGraph test.cpp
clang++ --analyze -Xclang -analyzer-checker=debug.ViewCallGraph test.cpp
clang++ --analyze -Xclang -analyzer-checker=debug.ViewExplodedGraph test.cpp

对于 View 开头的选项即查看 CFG 等，需要有合适的 viewer ，推荐安装 Graphviz ：

sudo apt install graphviz

一般来说安装后使用 View 选项即可弹出窗口显示图， dot 文件会暂时保存到 tmp 目录中，若想保存为 SVG （推荐）或 JPG 或 PDF 格式可以：

dot -Tsvg /tmp/ExprEngine-123456.dot > ExprEngine-123456.svg
dot -Tjpg /tmp/ExprEngine-123456.dot > ExprEngine-123456.jpg
dot -Tpdf /tmp/ExprEngine-123456.dot > ExprEngine-123456.pdf

对于一个函数内容比较多时，建议关闭 dotty 弹出窗口，否则有可能一下弹出上千个窗口。

参考：

clang static analyzer源码分析（二）_电影旅行敲代码的博客-CSDN博客

PDF | Graphviz

运行 Checker 检查代码

使用 --analyze 选项运行 CSA

CSA 中包含很多写好的 Checker ，或者我们可以编写自己的 Checker 。这些 Checker 不是被动地读取 ExplodedGraph 的信息，而是主动参与到 ExplodedGraph 的建立中，帮助我们发现安全问题。其实在查看 CFG 、 CallGraph 和 ExplodedGraph 信息时，我们就已经运行了 Checker ，这里更正式地讲一下如何运行 Checker 。

Clang 的 --analyze 编译选项表示运行静态分析器（the static analyzer，指的就是 CSA）：

# --analyze  Run the static analyzer
clang --analyze test.c
# 另一种方式
clang -Xclang -analyze -c test.c

使用 -analyzer-checker 选项指定具体的 Checker ：

clang --analyze -Xclang -analyzer-checker=core test.c

列出可用的 Checker ：

clang -cc1 -analyzer-checker-help
clang -cc1 -analyzer-checker-help-developer

默认分析的输出为 plist 格式，指定输出 html 格式的报告，这时需要用 -o 指定输出的路径：

# --analyzer-output <value>    Static analyzer report output format (html|plist|plist-multi-file|plist-html|sarif|text).
# 输出的路径不用提前创建，会自动创建
clang --analyze --analyzer-output html -o <output-dir> test.c
clang --analyze --analyzer-output html -o <output-dir> -Xclang -analyzer-checker=core test.c
# 另一种方式（我更偏好）
clang --analyze -Xclang -analyzer-output=html -o <output-dir> test.c
clang --analyze -Xclang -analyzer-output=html -o <output-dir> -Xclang -analyzer-checker=core test.c

使用 scan-build 运行 CSA

（不推荐使用）

如果使用 scan-build 和 scan-view 来集成：

scan-build [scan-build options] <command> [command options]

即在编译命令 <command> 前加上 scan-build 即可。比如 scan-build make 或 scan-build -V clang -c file.c 。其中 -V 表示输出报告。

关于 scan-build 和 scan-view ：

scan-build: scan-build is the high-level command line utility for running the analyzer
scan-view: scan-view a companion command line utility to scan-build, scan-view is used to view analysis results generated by scan-build. There is an option that one can pass to scan-build to cause scan-view to run as soon as it the analysis of a build completes

参考：

scan-build: running the analyzer from the command line (llvm.org)

yyyayo
关注
  • 0
    点赞
  • 踩
  • 7
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
Clang Static Analyzer 代码静态检测工具详细使用教程
小秋 AI SLAM 入门实战教程
11-24 765
【代码】【Clang Static Analyzer 代码静态检测工具详细使用教程】
软件漏洞检测（Bug Finding）：Clang Static Analyzer（进阶与实战）
白马负金羁
09-20 904
The Clang Static Analyzeris a source code analysis tool that finds bugs in C, C++, and Objective-C programs. CSA是Clang项目的一部分，而且完全开源。注意这里的静态分析，表示并不需要运行程序，CSA is built on Clang based on symbolic execution technique
clang 编译器前端 分析
qq_67479387的博客
03-12 914
libclangAnaylysis：用于进行静态分析用的libclangRewrite：编辑文本缓冲区（代码重写转换非常重要，如重构）libclangBasic：诊断、源码定位、源码缓冲区抽象化、输入源文件的文件缓冲区Clang诊断子系统是一个编译器与人交互的重要部分。诊断是当代码不正确或可疑时产生警告和错误。在clang中，每个诊断产生（最少）一个唯一标识ID、一个相关的英文、SourceLocation源码位置“放置一个^”和一个严重性（例如：WARNING或ERROR）。
C语言与跨平台开发工具链：Clang、LLVM的使用与自定义编译流程（一）
最新发布
weixin_56154577的博客
04-29 1872
C语言，作为编程界的常青树，历经数十年依旧保持着其在系统编程、嵌入式开发及高性能计算领域的核心地位。其简洁的语法、高效的执行速度和对底层硬件的直接操控能力，使其成为跨平台软件开发中的重要基石。然而，跨平台开发并非没有挑战，不同操作系统间的差异，如文件系统路径分隔符、字节序、系统调用接口等，都可能成为阻碍代码直接移植的障碍。此外，硬件架构的多样性也要求开发者在内存管理、类型转换、宏定义等方面采取灵活且兼容的策略，以确保代码能够在多种平台上稳定运行。
clang static analyzer源码分析（一）
电影旅行敲代码
03-01 1万+
引子clang静态代码分析是clang相对于gcc一个比较能够引起关注的点，特别是clang静态代码分析基于checker的架构和大部分的静态分析工具都不相同。clang静态代码分析使用符号执行的技术执行路径敏感的代码分析，符号执行引擎并不实际进行报错，而是使用挂载在引擎上的checker对程序状态进行检查并报错。这种方式方便用户对代码检查规则或者bug类型进行扩展，但是这种架构也有其缺陷，符号执行
如何用clang analyzer定制静态分析规则（1）工程配置篇
喜欢冒险的松鼠的博客
04-18 3957
OS X、iOS开发都很熟悉clang，这个编译器前端支持C、C++、Objective-C、Objective-C++，是Mac世界里最主要的编译工具。 clang static analyzer（以下简称clang analyzer）是基于clang开发的官方静态代码分析工具，用于在编译阶段提前发现代码问题，具体信息请见官方网站：https://clang-analyzer.llvm.org/
CMake笔记
weixin_44941429的博客
01-18 1213
CMake笔
Windows环境下编译OLLVM源码（VS2022）
楼阁之束的博客
11-08 1598
这个非常重要，llvm-12.x 开始默认使用 newPM进行编译源码，导致 ollvm 不起作用！（虽然可以用 -flegacy-pass-manager 让 llvm 不走 newPM 编译，但是…-mllvm -bcf_prob=40: 代码块被混淆的概率是40%，默认30%-mllvm -split_num=3: 对每个block混淆3次，默认1词。-mllvm -sub_loop=3: 对每个函数混淆3次，默认1词。-mllvm -bcf_loop=3: 对一个函数混淆3次，默认1次。
flycheck-clang-analyzer：将Clang Static Analyzer与flycheck集成在一起，以便在Emacs中进行即时静态分析
02-05
Clang Static Analyzer是苹果公司开发的一个开源项目，它能够对C、C++和Objective-C代码进行深度分析，找出可能的内存错误、未初始化的变量等常见问题。而Emacs是一款强大的文本编辑器，深受程序员喜爱，尤其是对于...
codechecker：CodeChecker是Clang Static Analyzer和Clang Tidy的分析器工具，缺陷数据库和查看器扩展
01-30
代码检查器 CodeChecker是建立在工具链上的静态分析基础结构，取代了Linux或macOS（OS X）开发环境中的 。...例如Clang Static Analyzer（C / C ++），Clang Tidy（C / C ++），Facebook Infer（C / C ++，Java），
Bear:Bear是一个为clang工具生成编译数据库的工具
04-29
Bear是一种工具，可生成用于clang工具的编译数据库。 在clang项目中使用来提供有关如何处理单个编译单元的信息。 这样，很容易用替代程序重新运行编译。 获取编译数据库的一种方法是使用cmake作为构建工具。 将-...
modifyClangStaticAnalyzer:修改您的 clang 静态分析器演讲的材料
07-03
修改ClangStaticAnalyzer 修改您的 clang 静态分析器演讲的材料
linux环境编译安装clang12.0.0源代码压缩包合集
03-18
linux环境编译安装clang12.0.0源代码压缩包合集，文件列表 llvm-12.0.0.src.tar.xz clang-12.0.0.src.tar.xz clang-tools-extra-12.0.0.src.tar.xz compiler-rt-12.0.0.src.tar.xz
clang-plugins-demo:为 clang 和 clang 静态分析器定义自定义插件的简单示例
05-31
这些插件和程序演示了如何创建和使用 clang 的插件基础结构来分析 AST 或与 clang 静态分析器集成。 AST 插件打印出解析文件时找到的函数的名称。 静态分析器插件是来自 clang 代码库的 SimpleStreamChecker（以及 ...
使用 Clang 优化Flag进行编译
讨论软件开发加速、持续集成/持续交付（CI/CD）、C++、开发者生产力以及所有相关话题。
12-15 3543
使用 Clang 优化Flag进行编译 在《Effective C++》一书中，Scott Meyers 谈到了使用 lhs 和 rhs 作为参数名的方式:“……这是我最喜欢的两个参数名。但在你没有接触过编译器编写工作的情况下，它们的优势和含义可能并不突出。” 大约在 1992 年，当 Scott 写这篇文章时，他一定是联想到了 GCC，因为当时 Clang/LLVM 还没出现。Clang/LLVM 从根本上改变了人们对编译器的思考方式，揭开了手动编译器制作的神秘面纱。点击链接，阅读更多什么是 Clang
clang 与 GCC 的区别
hfut_zhanghu的博客
11-18 1万+
一、clang 介绍 1.1 概述 Clang 是一个 C 语言、C++、Objective-C 语言的轻量级编译器。源代码发布于 BSD 协议下。Clang 将支持其普通 lambda 表达式、返回类型的简化处理以及更好的处理 constexpr 关键字。 Clang 是一个由 Apple 主导编写，基于 LLVM 的 C/C++/Objective-C 编译器 2013 年 4 月,Clang 已经全面支持 C++11 标准，并开始实现 C++...
使用Clang作为编译器 —— 使用 Clang 交叉编译
热门推荐
梦在哪里的博客
06-05 2万+
使用 Clang 交叉编译1. 介绍2. 交叉编译问题(Cross compilation issues)3. Clang中的一般交叉编译选项(General Cross-Compilation Options in Clang)3.1 Target Triple3.2 CPU、FPU、ABI3.3 工具链选项4. 特定目标的库(Target-Specific Libraries)5. Multi...
搭建vim开发环境
u012411027的专栏
08-23 541
搭建vim开发环境 一、安装llvm+clang工具 这里通过apt进行自动化安装时，llvm和clang工具不会被全部安装，存在很多问题。所以一定要手动编译源码安装。 安装过程分成三步：拉取llvm及clang源码、配置及编译、安装 拉取llvm及clang源码 llvm是开源编译框架，clang是llvm的子项目。在github上有llvm工程可以拉取，同时拉取子模块，就一步到位了，省去指定各个部分的目录。 cd ~/Download git clone --recursive https://gith
程序分析 clang系列学习（一）
qq_44370676的博客
01-29 3960
Clang Static Analyzer的相关背景介绍以及简单使用，暂时不涉及手写Checker
clang static analyzer
06-28
### 回答1： Clang静态分析器是一个用于检测C、C++和Objective-C代码中潜在问题的工具。它可以在编译时对代码进行静态分析，以检测内存泄漏、空指针引用、未初始化变量等问题，并生成相应的警告或错误信息。Clang静态分析器是Clang编译器的一部分，可以通过命令行或集成开发环境（IDE）使用。它是一个非常有用的工具，可以帮助开发人员提高代码质量和可靠性。 ### 回答2： Clang Static Analyzer（以下简称CSA）是一款由LLVM项目开发的静态分析工具。它采用基于路径进行符号执行的分析方式，在程序编写阶段对源代码进行扫描，自动检测代码中的潜在问题，如内存泄漏、空指针引用、数组越界等，并给出相应的警报和建议，帮助程序员尽早发现和修复代码中的缺陷。 CSA具有以下几个特点： 1.准确性高：采用符号执行技术，可以深入分析程序的每一个执行路径，准确地定位问题点。 2.兼容性强：支持C、C++和Objective-C等多种语言的静态分析，并支持多种平台，可在Windows、Linux、Mac OSX等多个操作系统中使用。 3.使用简单：作为Clang编译器的一部分，CSA可与其他Clang工具集成使用，无需额外设置与安装，用户只需在编译时加入相应的编译选项即可。 4.可扩展性好：CSA提供良好的插件机制，方便开发者扩展自定义的分析插件和规则库，满足不同应用场景的需求。 总之，CSA是一款十分实用的静态分析工具，可以有效地改善程序的质量，提高开发效率。使用CSA进行代码分析，不仅能够保证程序的可靠性与稳定性，同时也会让程序员更深入地了解程序设计的细节，从而提升自己的编程技能与水平。 ### 回答3： Clang是一种基于LLVM基础架构的C/C++编译器。他是Apple公司推出的，始终致力于提高代码的质量。Clang像其他编译器一样，有一个静态代码分析的工具，它叫做Clang Static Analyzer。它是一个非常有用的工具，可以检测代码中的一些潜在问题，并给出一些自动化的建议和修复建议，从而帮助开发人员开发出更好的代码。在这篇文章中，我们将讨论Clang Static Analyzer的优点和使用方法。 Clang静态分析器的优点有： 1. 更好的准确性：Clang静态分析器使用LLVM框架，这使得它在识别潜在的问题方面更准确。 2. 杜绝缺陷：Clang静态分析器可以帮助开发人员解决所有类型的缺陷，如内存泄漏、空指针解引用、死锁等等。 3. 改进效率：由于静态分析器可以自动地检查代码，它可以提高开发人员的工作效率，并且可以减少手动调试时间和成本。 Clang静态分析器的使用方法： 1. 安装Clang编译器：在使用Clang静态分析器之前，需要先安装Clang编译器。可以在https://clang.llvm.org/网站上下载Clang编译器。 2. 安装分析器：Clang分析器与Clang编译器一起安装。安装完成之后，可以在命令行上使用分析器。 3. 运行分析器：使用命令行运行Clang分析器的示例命令： $ clang --analyze [options] input-file。 4. 分析结果：在运行分析器后，它会生成分析结果文件。分析结果文件包含了所有的问题和建议。开发人员可以查看分析结果文件并根据分析结果来修改代码和修复bug。 总之，Clang Static Analyzer是一个非常有用的工具，它可以帮助开发人员提高代码质量，并且减少代码中的潜在缺陷。如果您是C/C++开发人员，那么Clang静态分析器一定会大大提高您的开发效率。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值