/CMinor-Verifier

2023清华大学《软件分析与验证》课程大作业:程序自动化验证

Primary LanguageHTML

简介

在大作业中,你需要实现一个 CMinor 的验证工具的核心算法。CMinor 是一个面向验证的教学语言,其包括源程序和验证标注两部分,其中源程序部分大致是 C 语言的子集,验证标注部分大致是 ACSL (ANSI/ISO C Specification Language) 的子集。从 C 语言的角度来看,验证标注是写在注释中的,不会影响 C 代码通常的编译和运行。

本次大作业你需要实现本工具中的核心验证算法部分,具体的说明请见任务说明文档

本项目使用 git submodules 来集成公开测例仓库,在 clone 后请使用 git submodule update --remote 更新。

安装

本项目依赖于 .NET 7,可以从这里下载最新版。

注1:建议不要通过 homebrewapt 直接安装,因为其软件源中的 dotnet 的版本很有可能是过时的。

注2:对于 M1/M2 芯片上的 macOS 系统,由于 Z3 目前还缺乏对 arm64 架构的完善支持。我们建议下载 x64 架构的 SDK,并将其安装目录(一般是 /usr/local/share/dotnet/x64/)加入环境变量 PATH 中以便于后续使用。

注3:如果你遇到了错误 Unhandled exception. System.DllNotFoundException: Unable to load shared library 'libz3' or one of its dependencies.,那么你需要从这里单独安装 Z3。

你可以使用任意你喜欢的 IDE,我们推荐:

使用

你可以通过在本项目的根目录下运行以下指令来编译并运行:

dotnet run -- --source <path>

你可以使用 --printCFA 来打印出得到的 CFG。

所支持的各命令行选项的具体含义为:

--source      Required. The source file of CMinor language (recommended with filename extension '.c').

--printCFA    The file (or 'console') to which the control flow automata is printed.

--help        Display this help screen.

--version     Display version information.

结构

该编译器的设计可以分为三个部分:

  • 前端(frontend):使用由 ANTLR 自动生成的 parser 将源文件解析为 CST (concrete syntax tree,具体语法树),再遍历 CST,生成 CFA(control flow automata,控制流自动机);
  • 中间表示(ir):面向验证来设计的控制流自动机;
  • 后端(backend):使用 deductive verification 的方法从 CFA 中生成验证条件(verification condition),再将其喂给 SMT Solver 来求解。
    • 这部分是你需要来实现的。

你唯一被允许修改、并且你也必须要修改的文件是 Verifier.cs,你需要在其中实现演绎验证的算法主体。

API 文档

API 文档在 ./api-doc/,打开 ./api-doc/index.html 即可浏览。

如果想要更新 API 文档的话,你需要使用 doxygen,并在本项目根目录下运行 doxygen

参考

CMinor 语言大致是以下语言标准的子集: