Infer 项目分析实战：构建系统集成、编译数据库与多语言捕获完整指南

Infer 项目分析实战构建系统集成、编译数据库与多语言捕获完整指南【免费下载链接】inferA static analyzer for Java, C, C, and Objective-C项目地址: https://gitcode.com/gh_mirrors/infer/infer本篇技术指南围绕 Facebook Infer 静态分析器如何接进你的构建流程展开它支持哪些编译器和构建系统、每种集成方式的最稳用法、编译数据库compilation database的底层处理机制以及遇到不受支持的构建系统时如何用--force-integration兜底。读完本文你将能够把 Infer 接入 ant、Buck、cmake、Gradle、Make、Maven、Xcodebuild、xctool 等常见构建体系并对 Java、C/C/Objective-C 代码执行完整或增量分析。Infer 支持的编译器与构建系统总览Infer 分析文件的入口是编译器命令官方支持通过javacJava与clangC/C/Objective-C直接分析。也可以把gcc作为入口但 Infer 内部仍会用clang来编译你的代码因此如果你的代码无法用clang编译这条路就可能走不通。从源码结构看Infer 支持的构建系统在 infer/src/base/Config.ml 中通过build_system_exe_assoc表显式登记多个可执行文件可以映射到同一个构建系统其中第一个条目用于打印当前运行模式构建系统可识别的前端可执行文件antantbuck2buck、buck2gradlegradle、gradlewjavajavajavacjavackotlinckotlincclangcc、clang、gcc、clang、c、ghackchackcmakemake、configure、cmake、wafmavenmvn、mvnwndk-buildndk-buildpythonpython3rebar3rebar3rustrustcswiftswiftcerlangerlcxcodebuildxcodebuild注意cmake也出现在该表中并映射到 make 模式见后文cmake一节的两种用法而configure、waf这类脚本同样按 make 模式处理。每个构建系统对应一种驱动模式infer run -- build command会把命令分发到对应的驱动实现这一逻辑位于 infer/src/integration/Driver.ml 的mode_of_build_command。某个构建系统具体如何被支持可查看infer capture --help手册中的 SYNOPSIS 部分。用编译器直接分析单个文件分析单文件项目是最简单的用法直接以编译命令作为 infer 的参数即可infer run -- javac Hello.java infer run -- clang -c file.c这里--之后的内容会被原样交给真正的编译器执行。文件照常被编译同时被 Infer 翻译成内部中间表示用于后续分析——这意味着没有被编译的文件也不会被分析。因此在对整个项目做首次分析前务必先执行 clean如make clean、gradle clean确保编译器编译了全部文件Infer 也随之分析全部文件参见 Infer 工作流两阶段说明。主流构建系统集成实战antinfer run -- antBuck对 Buck 项目把要分析的 target 作为参数传入infer run -- buck buck target这会计算传入 target 中的 Infer 告警列表。若希望同时分析所有传递依赖transitive dependenciesinfer run -- buck --deep buck target需要注意--deep与普通 Buck 编译模式的区别仅对 Java 项目有效对其他类型的项目--deep选项不产生任何效果。从 Driver.ml 的源码看buck2 模式下还会依据指定的 buck 模式Clang/Erlang/Java/Python选择对应的驱动实现。cmake最稳健的方式是让 cmake 生成编译数据库再交给 Infer 处理cd build cmake -DCMAKE_EXPORT_COMPILE_COMMANDS1 .. cd .. infer run --compilation-database build/compile_commands.json另一种方式是欺骗 cmake 使用 infer 替代系统编译器infer 在 PATH 上以同名包装器覆盖编译器cd build infer compile -- cmake .. infer run -- make -j 4关于第二种方式的原理见下文 Make 一节cmake 在build_system_exe_assoc中被映射到 make 模式因此infer compile -- cmake ..捕获的仍是 make 风格命令随后infer run -- make -j 4复用已捕获的结果。Gradleinfer run -- gradle gradle task, e.g. build infer run -- ./gradlew gradle task, e.g. buildgradle与gradlew都映射到 gradle 构建系统。如果项目要求增量式incremental构建系统的改动级分析可结合--reactive模式使用详见下文全局与增量工作流。MakeMake 集成通过在运行时修改PATH把 make 调用的 C/C/Objective-C 或 Java 编译器替换为 infer 包装器来实现infer run -- make make target这个机制并不总是有效如果 Makefile 硬编码了编译器的绝对路径例如直接调用/usr/bin/gcc而非gcc由于集成依赖 PATH 覆盖这类调用会绕过包装器。仓库中 infer/lib/wrappers/ 目录存放了这些包装器cc、clang、clang、g、gcc、c均为指向bin/infer的符号链接而 javac 是一个 bash 脚本——它通过INFER_OLD_PATH找到宿主javac先执行宿主编译器再以infer capture --continue -- javac args触发捕获并用INFER_COMPILER_WRAPPER_IN_RECURSION防止包装器自我递归调用。Maveninfer run -- mvn maven targetmvn与mvnw均映射到 Maven 模式。XcodebuildiOS/macOS 项目最稳健的方式是先生成编译数据库再交给 Inferxcodebuild your build options | tee xcodebuild.log xcpretty -r json-compilation-database -o compile_commands.json xcodebuild.log /dev/null infer run --skip-analysis-in-path Pods --clang-compilation-db-files-escaped compile_commands.json注意--clang-compilation-db-files-escapedXcode 产出的编译命令是经过 shell 转义的因此需要这一选项对应源码中的compilation_database_escaped见 Config.ml。--skip-analysis-in-path Pods用正则匹配并跳过Pods路径下的文件。Infer 也提供直接替换 xcodebuild 所用编译器的集成方式。例如对 iOS 应用infer run -- xcodebuild -target target name -configuration build configuration -sdk iphonesimulator此外还有一种基于xcpretty的替代集成给 infer 传入--xcpretty即可xcodebuild 的输出会经 xcpretty 管道转为编译数据库。该选项在 Config.ml 中定义为--xcpretty默认关闭其底层实现在 CaptureCompilationDatabase.mlget_compilation_database_files_xcodebuild通过进程管道运行xcodebuild | xcpretty --report json-compilation-database --output tmp把产物作为转义形式的编译数据库交给捕获流程。xctool与 Xcode 的编译数据库路线一致xctool.sh your build options -reporter json-compilation-database:compile_commands.json infer run --skip-analysis-in-path Pods --clang-compilation-db-files-escaped compile_commands.json编译数据库Compilation Database最通用的集成方式cmake、Xcode、Buck 等许多构建系统都能生成编译数据库JSON 格式的 compile_commands 文件。Infer 可以直接消费该文件从而绕开对具体构建系统的识别infer --compilation-database compile_commands.json对应选项定义在 Config.ml--compilation-database可以多次指定且与--compilation-database-escaped针对 Xcode 这类含 shell 转义参数的数据库并存。从源码看这一模式的处理链路如下在 Driver.ml当命令行其余参数为空且检测到--clang-compilation-dbs或--compilation-database时进入ClangCompilationDB {db_files}模式CaptureCompilationDatabase.capture 把所有数据库路径转为绝对路径并通过CompilationDatabase.from_json_files解析 JSON对每条编译命令create_cmdCaptureCompilationDatabase.ml把可执行文件替换为 wrappers 目录下的clang/clang依据命令后缀是否含判断并追加-fsyntax-only -fno-builtin参数——即只做语法层面的前端捕获不产生真实目标文件is_skipped第 87-90 行用--skip-analysis-in-path提供的正则对源文件相对路径做匹配匹配上的文件不参与捕获--skip-analysis-in-path-skips-compilation可进一步控制这些路径是否连编译都跳过Config.ml默认false即仍然编译捕获任务通过进程池按--jobs并行执行第 56-62 行。其他构建系统与 --force-integration 兜底如果 Infer 无法识别你的构建命令会报出如下错误$ infer run -- foo Usage Error: Unsupported build command foo该错误由 Config.ml 中的build_system_of_exe_name抛出——build_system_exe_assoc反向查找可执行文件名失败时它会以 UserError 终止并提示使用--force-integration。其错误信息会列出所有受支持的构建系统。如果构建系统与上表某一项行为一致可用--force-integration强制走同一种集成。例如让foo表现得与make相同infer run --force-integration make -- foo在 Driver.ml 中force_integration指定的构建系统只在原始发起进程is_originator中生效子进程仍按实际可执行文件名识别其命令行定义见 Config.ml类型为build_system optionConfig.mli。如果你的构建系统更加特殊、无法输出编译数据库可以尝试先手工生成 compile_commands.json 再走编译数据库模式若仍不可行则需要反馈给 Infer 社区寻求支持。让分析更快、更完整的两个实践要点并行加速Infer 可以并行运行编译命令例如infer run -- make -j8。编译数据库模式的并行度则受--jobs控制见run_compilation_database中的进程池实现CaptureCompilationDatabase.ml。分析前先 clean对项目首次运行 Infer 前执行cleanmake 项目用make cleanGradle 用gradle clean依此类推否则增量构建系统可能跳过已编译文件导致 Infer 漏分析。全局分析与增量分析reactive 模式衔接虽然本页聚焦构建系统接入但两种运行模式直接影响你如何调用上述命令见 Infer 工作流文档 的完整说明要点如下默认全局模式infer run -- build command每次都会删除旧infer-out/并全量分析首次运行前需 clean 构建产物。增量reactive模式infer run --reactive -- build command保留infer-out/只分析改动文件及其依赖适合增量构建系统的日常开发循环可用--continue把多次改动合并为一次分析也可单独执行infer run --reactive --continue -- analyze对当前改动做隔离分析。分析结果输出在标准输出及infer-out/report.txt可在同一目录运行infer explore查看每个告警的详细错误轨迹。延伸阅读Infer 工作流capture/analyze 两阶段与全局/增量模式从零开始的 Infer 使用入门各构建系统的 SYNOPSIS 细节infer capture --help、infer run --help编译器包装器实现infer/lib/wrappers/javac 与 infer/lib/wrappers/ 下指向bin/infer的符号链接构建系统识别与驱动分发infer/src/base/Config.ml、infer/src/integration/Driver.ml编译数据库捕获实现infer/src/integration/CaptureCompilationDatabase.ml【免费下载链接】inferA static analyzer for Java, C, C, and Objective-C项目地址: https://gitcode.com/gh_mirrors/infer/infer创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考