Lib.rs

› 编程语言 › treeedb
#datalog #souffle #编程语言 #解析器 #rust

应用 treeedb-rust

从Rust源代码生成Datalog事实

作者：Langston Barrett

1个不稳定版本

0.1.0-rc.52022年10月29日

#13 in #souffle

MIT 协议

30KB
202 行

treeedb

treeedb 通过Soufflé Datalog（Soufflé Datalog）简化了源级程序分析的开始。首先，treeedb生成代表程序AST的Soufflé类型和关系。然后，treeedb解析源代码并发出填充这些关系的实际事实。

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

  • C
  • C#
  • Java
  • JavaScript
  • Rust
  • Soufflé
  • Swift

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

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

安装

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

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

例如，对于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项目都是“手动”完成这些操作的

编写这些表示和摄入工具需要花费宝贵的时间，并会分散编写分析的工作。 treeedb 旨在自动化这一过程，与这些工具位于相同的领域。

存储库结构

贡献

感谢您对 treeedb 的兴趣！我们欢迎并感激各种形式的贡献。请随时提交问题或打开一个拉取请求。

添加语言

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

要添加新语言

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

查看 PR #9 以获取完整示例。

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

bash scripts/add-language.sh python Python

依赖项

~14MB
~320K SLoC