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集合。

安装

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

1. 一个包含定义AST的类型和关系的Soufflé文件
2. 解析该语言并发出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> 二进制文件。

从源代码构建

要从源代码构建，您需要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的语法.js仓库中的grammar.js）。

动机与其他工具的比较

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

• cclyzer++有一个“schema”目录（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请求。

添加一种语言

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

要添加一种新语言

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

bash scripts/add-language.sh python Python