1个不稳定发布

0.1.0-rc.5	2022年10月29日

#682 in 编程语言

MIT 许可证

31KB
202 行

treeedb

treeedb 使在 Soufflé Datalog 中编写源级程序分析变得更容易。首先，treeedb 生成表示程序AST的Soufflé类型和关系。然后，treeedb 解析源代码并发出填充这些关系的fact。

treeedb 目前支持以下语言的分析

C
C#
Java
JavaScript
Rust
Soufflé
Swift

treeedb 的解析器和AST基于 tree-sitter 语法，并且很容易添加对任何具有tree-sitter语法的语言的支持。

名称 treeedb 是“tree-sitter”和“EDB”的混合词，其中EDB代表“扩展数据库”，指Datalog程序中的fact集。

安装

您需要为要分析每种编程语言提供两个工件

一个包含定义AST的类型和关系的Soufflé文件
解析该语言并发出fact的可执行文件

例如，对于Java，这些分别称为 treeedb-java.dl 和 treeedb-java。

要实际分析一些代码，您还需要安装Soufflé。

从发布版本安装

转到发布页面上的最新发布版本，并下载与您要分析的语言相关的工件。预构建的可执行文件是静态链接的，但目前仅适用于Linux。

从crates.io构建

您可以从 crates.io 构建发布的版本。您需要Rust编译器和 Cargo 构建工具。 rustup 使这些工具的获取变得非常简单。然后，要为语言 <LANG> 安装工具，运行

cargo install treeedb-<LANG> treeedbgen-souffle-<LANG>

这将安装二进制文件到~/.cargo/bin。要生成Datalog文件，运行treeedbgen-souffle-<LANG>二进制文件。

不幸的是，与Java相关的二进制文件在crates.io上尚未提供。

从源代码构建

要从源代码构建，您需要Rust编译器和Cargo构建工具。rustup使获取这些工具变得非常容易。

然后，获取源代码

git clone https://github.com/langston-barrett/treeedb
cd treeedb

最后，构建所有内容

cargo build --release

您可以在target/release中找到treeedb-<LANG>二进制文件。要生成Datalog文件，运行相应的treeedbgen-souffle-<LANG>二进制文件。

示例：分析Java代码

要跟随本示例，请按照Java的安装说明进行操作。然后，创建一个名为Main.java的Java文件

class Main {
    public static void main(String[] args) {
        int x = 2 + 2;
    }
}

（本节中显示的文件也可在examples/java/中找到。）

创建一个名为const-binop.dl的Datalog文件，其中包含treeedb-java.dl并具有查找具有常量值的二元表达式的规则

#include "treeedb-java.dl"

.decl const_binop(expr: JavaBinaryExpression)

const_binop(expr) :-
  java_binary_expression(expr),
  java_binary_expression_left_f(expr, l),
  java_binary_expression_right_f(expr, r),
  java_decimal_integer_literal(l),
  java_decimal_integer_literal(r).

.decl show_const_binop(text: JavaNodeText)

show_const_binop(text) :-
  const_binop(expr),
  java_node_text(expr, text).

.output const_binop(IO=stdout)
.output show_const_binop(IO=stdout)

生成输入文件（node.csv和field.csv）

treeedb-java Main.java

最后，使用Soufflé运行分析

souffle const-binop.dl

您将看到类似以下内容

---------------
const_binop
===============
94001952741472
===============
---------------
show_const_binop
===============
2 + 2
===============

深入研究

要查看可用的类型和关系名称，请查看treeedb-<LANGUAGE>.dl。如果给定类型或关系对应于语言的一部分不是显而易见的，请查看tree-sitter语法（例如，Java的tree-sitter-java存储库中的grammar.js）。

动机与与其他工具的比较

在用Datalog编写程序分析之前，您需要弄清楚（1）如何将程序表示为关系，以及（2）如何将程序摄入该表示。最先进的Datalog项目都是“手动”完成这些工作的。

cclyzer++有一个“模式”目录（1）和FactGenerator（2）。
Doop有一个大的imports.dl文件（1）和各种生成器（2）。
ddisasm有gtirb-decoder（2）。
securify 有 analysis-input.dl（1）。

编写这些表示和摄入工具需要宝贵的时间，并会分散编写分析的工作。 treeedb 的目标是自动化这个过程，与这些工具处于相同的领域。

仓库结构

treeedb：从 tree-sitter 解析树生成 Datalog 事实
treeedb-c：从 C 源代码生成 Datalog 事实
treeedb-csharp：从 C# 源代码生成 Datalog 事实
treeedbgen：解析来自 tree-sitter 语法文件的 node-types.json
treeedbgen-souffle：从 tree-sitter 语法生成 Soufflé 类型和相关
treeedbgen-souffle-c：从 C tree-sitter 语法生成 Soufflé 类型和相关
treeedbgen-souffle-csharp：从 C# tree-sitter 语法生成 Soufflé 类型和相关
treeedbgen-souffle-java：从 Java tree-sitter 语法生成 Soufflé 类型和相关
treeedbgen-souffle-javascript：从 JavaScript tree-sitter 语法生成 Soufflé 类型和相关
treeedbgen-souffle-rust：从 Rust tree-sitter 语法生成 Soufflé 类型和相关
treeedbgen-souffle-souffle：从 Soufflé tree-sitter 语法生成 Soufflé 类型和相关
treeedbgen-souffle-swift：从 Swift tree-sitter 语法生成 Soufflé 类型和相关
treeedb-java：从 Java 源代码生成 Datalog 事实
treeedb-javascript：从 JavaScript 源代码生成 Datalog 事实
treeedb-rust：从 Rust 源代码生成 Datalog 事实
treeedb-souffle：从 Soufflé 源代码生成 Datalog 事实
treeedb-swift：从 Swift 源代码生成 Datalog 事实

贡献

感谢您对 treeedb 的兴趣！我们欢迎并感谢所有类型的贡献。请随时提交问题或发起 pull request。

添加语言

如《安装》部分所述，支持每种编程语言的分析涉及两个工具：一个用于生成Soufflé类型和关系（例如，treeedbgen-souffle-c），另一个用于解析正在分析的编程语言并生成事实（例如，treeedb-c）。

添加新语言

创建与现有目录相同结构的新的目录 treeedb-<LANG> 和 treeedbgen-souffle-<LANG>（最简单的方法可能是递归地复制现有的目录）。
将新目录添加到顶级 Cargo.toml。
通过复制和修改其他语言的现有行来将语言添加到 .github/workflows/release.yml。

有关完整示例，请参阅 PR #9。

脚本 ./scripts/add-language.sh 自动化了这些步骤中的几个 - 但它并不是一个即用即得的解决方案。使用示例

bash scripts/add-language.sh python Python

依赖项

~6–8MB
~147K SLoC