1 个不稳定版本

0.1.0-rc.5	2022年10月29日

#1206 在编程语言

MIT 许可证

30KB
202 行

treeedb

treeedb 使得在 Soufflé Datalog 中开始编写源级程序分析变得容易。首先，treeedb 生成 Soufflé 类型和相关关系，它们表示程序的抽象语法树。然后，treeedb 解析源代码并发出填充这些关系的真实事实。

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

C
C#
Java
JavaScript
Rust
Soufflé
Swift

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

treeedb 这个名字是 "tree-sitter" 和 "EDB" 的组合，其中 EDB 代表 "扩展数据库"，指的是 Datalog 程序中的事实集。

安装

您需要为每个要分析的编程语言安装两个工件

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

例如，对于 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的tree-sitter-java存储库中的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 的关注！我们欢迎并感谢所有类型的贡献。请随时提交问题或打开拉取请求。

添加语言

如安装部分所述，支持分析每种编程语言涉及两个工具：一个用于生成 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

依赖关系

~24MB
~612K SLoC