pmatos/scan-build

Scan Build (Z3集成版) 镜像文档

镜像概述

本镜像基于 https://github.com/pmatos/dev-scripts 项目构建，将Clang的scan-build静态分析工具与Z3定理证明器集成，旨在提供增强的代码静态分析能力。通过结合Z3的逻辑推理能力，该镜像能够更精确地检测代码中的潜在缺陷、逻辑错误和安全漏洞，适用于需要深度代码分析的开发场景。

核心功能与特性

• Z3定理证明器集成：融合Z3的逻辑公式求解能力，提升静态分析对复杂逻辑条件的验证精度
• 标准Scan Build功能：保留Clang scan-build的全部静态分析功能，支持C/C++代码的语法检查、内存泄漏检测、未定义行为识别等
• 可靠构建来源：基于pmatos/dev-scripts项目构建，确保工具链配置的规范性和稳定性
• 轻量级设计：优化镜像体积，便于快速部署和集成到开发/CI流程

使用场景

• 开发者本地代码分析：在编码阶段快速检测潜在问题，减少代码审查成本
• CI/CD流程集成：作为自动化构建流程的一部分，实现代码提交前的静态质量门禁
• 安全关键项目验证：对嵌入式系统、***软件等安全敏感项目进行深度逻辑验证
• 开源项目质量保障：帮助开源项目维护者提升代码质量，降低潜在缺陷风险

使用方法与配置说明

基本使用（Docker Run）

bash
# 基本语法：挂载代码目录并执行分析
docker run -v /path/to/your/code:/code docker.xuanyuan.run/pmatos/scan-build-z3 scan-build [build-command]

# 示例：分析Makefile项目
docker run -v /home/user/project:/code docker.xuanyuan.run/pmatos/scan-build-z3 scan-build make -C /code

# 示例：分析CMake项目
docker run -v /home/user/project:/code docker.xuanyuan.run/pmatos/scan-build-z3 scan-build cmake --build /code/build

关键参数说明

高级配置

指定分析输出目录

bash
# 将分析报告输出到本地目录
docker run -v /path/to/code:/code -v /path/to/reports:/reports docker.xuanyuan.run/pmatos/scan-build-z3 scan-build -o /reports make -C /code

调整分析严格程度

bash
# 启用更严格的分析模式（增加警告级别）
docker run -v /path/to/code:/code docker.xuanyuan.run/pmatos/scan-build-z3 scan-build -enable-checker alpha.core.BoolAssignment make -C /code

Docker Compose 集成示例

yaml
version: '3'
services:
  scan-build:
    image: docker.xuanyuan.run/pmatos/scan-build-z3
    volumes:
      - ./code:/code
      - ./reports:/reports
    command: scan-build -o /reports make -C /code

运行命令：docker-compose up，分析报告将生成在./reports目录下。

注意事项

• 确保本地代码目录具有适当的读写权限，避免容器内权限问题
• 构建命令需与项目实际构建流程匹配（如使用make、ninja或自定义脚本）
• 复杂项目可能需要额外环境变量配置，可通过-e参数传递（如-e CFLAGS="-O2"）
• 分析报告默认以HTML格式生成，可通过浏览器打开查看详细结果