中文 | English | 日本語 | Français | Deutsch | Русский
WHAT 是一款基于 Web 的 HDL（硬件描述语言）代码和波形分析工具。
本项目最初的动机是测试 AI 辅助编程的能力。作为一名硬件工程师，在日常工作中经常需要同时查看源代码和仿真波形来进行调试分析，但市面上缺乏一款开源的、能够将源码和波形紧密结合的分析工具。商业工具价格昂贵且不够灵活，而现有的开源方案往往功能分散，无法形成完整的工作流。
因此，我萌生了利用 AI 开发一款符合自己使用习惯的分析工具的想法。令人惊讶的是，这个项目的主要代码全部由 AI 编写完成——从主体架构设计到具体实现，从界面布局到功能逻辑。主要功能开发耗时约 2 周，后续的 bug 修复和功能架构优化又花费了约 2 周时间。这样的开发效率在传统编程模式下是难以想象的，充分展示了 AI 编程效率的飞跃式提升。
在此特别感谢：
- Trae IDE 提供优秀的开发环境和免费的 AI 算力支持
- Doubao-seed-2.0、Kimi K2.5、GLM-5 等大模型提供强大的代码生成能力
- Verilog/SystemVerilog 支持：完整的语法高亮和代码折叠
- 设计层次浏览：可视化展示模块实例化层次结构
- 智能代码导航：支持定义跳转、驱动追踪、负载追踪
- 书签功能：快速标记和跳转到关键代码位置
- 导航历史：支持前进/后退浏览代码位置
- 信号值展开显示：在源代码中直接查看信号在当前光标时间的值，支持多进制显示
- FST 波形文件支持：高性能读取大型波形文件
- 多信号同时显示：支持信号分组管理和自定义列宽
- 灵活的缩放和平移：鼠标滚轮缩放、拖拽平移、全屏适配
- 光标操作：点击设置光标位置，精确查看信号值
- 值搜索功能：支持二进制、十六进制、八进制等多种格式的模式搜索
- 历史搜索：保存搜索历史，快速重复搜索
- 表格视图 (TableView)：以表格形式查看特定时间范围内信号的值，支持多进制显示、元数据过滤和分页浏览
- 源码-波形联动：在代码中双击信号可查看其驱动源
- 设计浏览器：从模块层次树快速添加信号到波形窗口
- Session 管理：保存和恢复完整的工作状态
- 多标签页支持：同时打开多个源代码和波形窗口
┌─────────────────────────────────────────────────────────────────┐
│ 用户工作流程 │
├─────────────────────────────────────────────────────────────────┤
│ │
│ Verilog/SV 源文件 │
│ │ │
│ ↓ │
│ ┌─────────────┐ │
│ │ Interpreter │ → 生成 KDB 文件（知识数据库） │
│ └─────────────┘ │
│ │ │
│ ↓ │
│ ┌─────────────┐ ┌─────────────┐ │
│ │ Server │ ←→ │ Web Client │ │
│ │ (后端) │ │ (浏览器) │ │
│ └─────────────┘ └─────────────┘ │
│ │ │ │
│ ↓ ↓ │
│ KDB 文件 用户界面 │
│ 波形文件 (FST) - 代码查看器 │
│ - 波形查看器 │
│ - 设计浏览器 │
│ │
└─────────────────────────────────────────────────────────────────┘
| 组件 | 目录 | 功能 |
|---|---|---|
| Interpreter | interpreter/ |
解析 Verilog/SV 源码，生成 KDB 知识数据库 |
| Server | server/ |
提供 HTTP API，服务 KDB 和波形文件 |
| Web Client | web-client/ |
浏览器前端界面，代码和波形查看 |
- Node.js 18+ (用于 Web Client)
- Rust (用于 Server)
- CMake + C++ 编译器 (用于 Interpreter)
- Surelog (用于 Interpreter，解析 SystemVerilog)
-
启动 Server
cd server cargo run --release -- --kdb-dir /path/to/kdb --wave-dir /path/to/waves --port 8080 -
启动 Web Client
cd web-client npm install npm run dev -
访问界面
打开浏览器访问
http://localhost:3000
Interpreter 用于解析 Verilog/SystemVerilog 源代码，生成 KDB（Knowledge Database）文件。KDB 文件包含：
- 模块定义和实例化层次
- 信号声明和连接关系
- Driver/Load 追踪信息
- Ubuntu 22.04+ 或 WSL2 (Ubuntu)
- CMake 3.20+
- GCC/G++ 11+ 或 Clang 14+
- Protocol Buffers (protobuf)
- zstd (可选，用于压缩)
在 Ubuntu/WSL 下安装编译依赖：
# 更新包列表
sudo apt-get update
# 安装基础编译工具
sudo apt-get install -y build-essential cmake git
# 安装 Protocol Buffers
sudo apt-get install -y protobuf-compiler libprotobuf-dev
# 安装 zstd（可选，用于压缩）
sudo apt-get install -y libzstd-dev
# 安装其他依赖
sudo apt-get install -y python3 python3-pip pkg-config步骤1：克隆仓库
cd /path/to/your/workspace
git clone <repository-url>
cd webhwd步骤2：安装依赖
# 更新包列表
sudo apt-get update
# 安装基础编译工具
sudo apt-get install -y build-essential cmake git
# 安装 Protocol Buffers
sudo apt-get install -y protobuf-compiler libprotobuf-dev
# 安装 zstd（可选，用于压缩）
sudo apt-get install -y libzstd-dev步骤3：编译项目
# 运行编译脚本
./build.sh编译过程说明：
- 编译脚本会自动下载和编译 Surelog（SystemVerilog 解析器）
- 首次编译可能需要 10-20 分钟（取决于机器性能）
- 编译结果会缓存，后续编译会更快
- 编译完成后，可执行文件位于：
build_new/interpreter/hwda_interpreterbuild_new/interpreter/kdb_viewer
步骤4：验证安装
# 检查 interpreter 是否可用
./build_new/interpreter/hwda_interpreter --help
# 检查 kdb_viewer 是否可用
./build_new/interpreter/kdb_viewer --help解析 Verilog 文件生成 KDB：
# 基本用法
./build_new/interpreter/hwda_interpreter design.v --output design.kdb
# 指定顶层模块
./build_new/interpreter/hwda_interpreter design.v --output design.kdb -top top_module
# 添加包含路径
./build_new/interpreter/hwda_interpreter design.v --output design.kdb +incdir+./include
# 使用 verbose 模式查看详细日志
./build_new/interpreter/hwda_interpreter design.v --output design.kdb --verbose常用选项：
| 选项 | 说明 |
|---|---|
-o, --output <path> |
指定输出 KDB 文件路径（默认：design.kdb） |
-top <module> |
指定顶层模块 |
+incdir+<dir> |
添加包含路径 |
-y <path> |
添加库目录 |
-v <file> |
添加库文件 |
-D<name>=<value> |
定义宏 |
-z, --compress |
启用压缩（默认启用） |
-Z, --no-compress |
禁用压缩 |
-V, --verbose |
显示详细调试信息 |
-h, --help |
显示帮助信息 |
使用 kdb_viewer 工具查看生成的 KDB 文件内容：
# 查看 KDB 文件信息
./build_new/interpreter/kdb_viewer design.kdb
# 列出所有模块
./build_new/interpreter/kdb_viewer design.kdb --modules
# 列出所有信号
./build_new/interpreter/kdb_viewer design.kdb --signals
# 查看特定信号的 driver 信息
./build_new/interpreter/kdb_viewer design.kdb --driver work@top.signal_name
# 以 JSON 格式输出
./build_new/interpreter/kdb_viewer design.kdb --jsonKDB（Knowledge Database）是自定义的二进制格式，包含：
- 模块信息：模块定义、实例化层次、参数
- 信号信息：信号声明、位宽、类型（wire/reg/parameter等）
- 连接关系：信号的 driver 和 load 信息
- 源代码位置：文件名、行号，用于跳转到源代码
KDB 文件使用 Protocol Buffers 序列化，可选择使用 zstd 压缩。
# 解析 Verilog 文件生成 KDB
./build_new/interpreter/hwda_interpreter tests/simple.v --output tests/simple.kdb
# 查看生成的 KDB 文件信息
./build_new/interpreter/kdb_viewer tests/simple.kdb
# 查看特定信号的 driver 信息
./build_new/interpreter/kdb_viewer tests/simple.kdb --driver work@top.sum详细使用说明请参考 interpreter/README.md。
Server 提供 HTTP API，用于：
- 服务 KDB 文件
- 服务波形文件（FST 格式）
- 提供信号搜索和查询接口
- 支持两种 FST 读取后端：fstapi（默认）和 fst-reader
Windows:
- Rust 1.70+ (使用 rustup 安装)
- LLVM/Clang (用于 fst-reader 后端的 bindgen)
- vcpkg (用于管理 C++ 依赖)
Ubuntu/WSL:
- Rust 1.70+
- LLVM/Clang
- pkg-config
- libzstd-dev (可选，用于压缩)
-
安装 Rust
# 使用 rustup 安装 curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh # 或从 https://rustup.rs/ 下载安装程序
-
安装 LLVM/Clang
- 从 https://github.com/llvm/llvm-project/releases 下载 LLVM
- 解压到
C:\Users\<username>\Downloads\clang+llvm-<version>-x86_64-pc-windows-msvc - 设置环境变量：
LIBCLANG_PATH=C:\path\to\llvm\bin
-
安装 vcpkg
git clone https://github.com/Microsoft/vcpkg.git C:\path\to\vcpkg cd C:\path\to\vcpkg .\bootstrap-vcpkg.bat
-
编译 Server
cd server $env:VCPKG_ROOT="C:\path\to\vcpkg" $env:LIBCLANG_PATH="C:\path\to\llvm\bin" cargo build --release
编译完成后，可执行文件位于：
target\release\hwda-server.exe
-
安装依赖
sudo apt-get update sudo apt-get install -y build-essential pkg-config libzstd-dev # 安装 Rust curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh source $HOME/.cargo/env # 安装 LLVM/Clang sudo apt-get install -y llvm libclang-dev
-
编译 Server
cd server cargo build --release编译完成后，可执行文件位于：
target/release/hwda-server
启动 Server：
# 基本用法（使用默认 fstapi 后端）
./hwda-server --kdb-dir /path/to/kdb --wave-dir /path/to/waves --port 8080
# 使用 fst-reader 后端
./hwda-server --kdb-dir /path/to/kdb --wave-dir /path/to/waves --fst-backend fst-reader
# 启用详细调试日志
./hwda-server --kdb-dir /path/to/kdb --wave-dir /path/to/waves --log-level debug --verbose
# 启动时清除缓存
./hwda-server --kdb-dir /path/to/kdb --wave-dir /path/to/waves --clear-cache-on-startup
# 启用 Web 客户端静态文件服务
./hwda-server --kdb-dir /path/to/kdb --wave-dir /path/to/waves --web-dir /path/to/web-client/dist常用选项：
| 选项 | 说明 | 默认值 |
|---|---|---|
--kdb-dir <path> |
KDB 文件目录 | ./kdb |
--wave-dir <path> |
波形文件目录 | ./waves |
--port <port> |
服务端口 | 8080 |
--host <host> |
绑定地址 | 0.0.0.0 |
--fst-backend <backend> |
FST 读取后端 (fstapi 或 fst-reader) |
fstapi |
--log-level <level> |
日志级别 (trace, debug, info, warn, error) |
info |
--verbose |
启用详细调试输出（仅在 log-level=debug 时生效） |
false |
--web-dir <path> |
Web 客户端静态文件目录 | - |
--clear-cache-on-startup |
启动时清除所有缓存 | false |
--enable-cors |
启用 CORS | true |
--cache-capacity-mb <size> |
LRU 缓存容量 (MB) | 512 |
查看帮助：
./hwda-server --helpServer 支持两种 FST 读取后端：
-
fstapi (默认)
- 使用 GTKWave 的 libfst C 库
- 兼容性好，支持所有 FST 特性
- 需要 C++ 编译环境
-
fst-reader (纯 Rust)
- 纯 Rust 实现，无需 C++ 依赖
- 性能更好，内存占用更低
- 使用
--fst-backend fst-reader启用
切换后端示例：
# 使用 fstapi 后端（默认）
./hwda-server --wave-dir ./waves
# 使用 fst-reader 后端
./hwda-server --wave-dir ./waves --fst-backend fst-readerServer 提供以下主要 API：
GET /api/kdb- 列出所有 KDB 文件GET /api/kdb/{name}/signals- 获取 KDB 中的信号列表GET /api/wave- 列出所有波形文件GET /api/wave/{name}/signals- 获取波形文件中的信号列表GET /api/wave/{name}/lod/{lod}/tile/{start}/{span}/{count}/signals/{signal_ids}/data- 获取波形数据
详细 API 文档请参考 server/API.md。
首次打开应用时，需要连接到 Server：
- 在弹出的连接对话框中输入服务器地址和端口
- 默认地址为
localhost:8080 - 点击 "Connect" 按钮
- 连接成功后，会自动显示可用的 KDB 文件列表
加载 KDB 文件：
- 点击菜单 File → Open KDB
- 从列表中选择 KDB 文件
- 加载完成后，左侧设计浏览器会显示模块层次
加载波形文件：
- 点击菜单 File → Open Waveform
- 从列表中选择波形文件（FST 格式）
- 或者选择 "Use Mock Data" 使用模拟数据进行测试
设计浏览器位于左侧面板，显示设计的层次结构：
- 模块树：显示顶层模块和子模块实例
- 信号列表：选中模块后，显示该模块的所有信号
- 搜索功能：在搜索框中输入信号名或模块名进行过滤
操作方式：
- 单击模块：在信号列表中显示该模块的信号
- 双击模块：打开该模块的源代码
- 双击信号：将信号添加到当前波形窗口
- 右键菜单：更多操作选项
源代码窗口用于查看 Verilog/SystemVerilog 代码：
基本功能：
- 语法高亮显示
- 代码折叠（module、always、begin-end 块）
- 行号显示
Driver/Load 追踪：
- 点击代码中的信号名
- 在弹出的菜单中选择 "Find Drivers" 或 "Find Loads"
- 追踪结果会显示在底部的消息窗口
- 双击追踪结果可跳转到对应的源代码位置
书签功能：
- 点击菜单 Navigate → Add Bookmark 添加书签
- 书签显示在右侧书签面板
- 双击书签可快速跳转到对应代码位置
导航历史：
- 工具栏的 ← → 按钮用于前进/后退导航
- 支持跨文件的导航历史
信号值展开显示：
- 点击代码行左侧的展开图标（▶）可展开显示该行所有信号在当前光标时间的值
- 展开后显示信号名称、当前值、位宽等信息
- 支持多进制显示（二进制、十六进制等），自动继承波形窗口的显示格式设置
- 再次点击展开图标可收起显示
- 展开状态会在切换 Tab 时自动保存和恢复
波形窗口用于查看仿真波形：
信号管理：
- 从设计浏览器拖拽信号到波形窗口
- 双击设计浏览器中的信号添加到波形
- 使用信号分组功能组织信号
- 右键信号可删除或移动
视图操作：
- 缩放：鼠标滚轮或工具栏 +/- 按钮
- 平移：拖拽波形区域
- 全屏显示：点击工具栏 "Fit" 按钮
- Cursor 操作：点击波形设置 Cursor 位置
值搜索：
- 点击工具栏 "Search" 按钮
- 输入要搜索的值（支持二进制、十六进制等格式）
- 搜索结果会高亮显示
时间显示：
- 工具栏显示当前 Cursor 位置的时间
- 可手动输入时间值跳转到指定位置
多窗口支持：
- 点击 "+" 按钮添加新的波形窗口
- 每个窗口可显示不同的信号组合
- 支持多个源代码窗口同时打开
表格视图以表格形式显示信号在特定时间范围内的值，适合查看和分析信号状态：
创建表格视图：
- 点击工具栏 "+" 按钮，选择 "Table" 创建新的表格视图
- 当波形窗口处于激活状态时创建表格视图，会自动继承：
- 当前波形窗口的时间范围（View Start / View End）
- 所有展开分组中的信号
- 每个信号的显示格式（Radix）
- 信号前缀设置
信号管理：
- 从设计浏览器拖拽信号到表格视图
- 双击设计浏览器中的信号添加到表格
- 点击列头的 "×" 按钮删除信号
- 拖拽列头可调整信号顺序
时间范围设置：
- 在工具栏的 "Start" 和 "Span" 输入框中设置时间范围
- 点击 "Apply" 按钮应用新的时间范围并获取数据
- 支持分页显示，使用 "Previous" 和 "Next" 按钮翻页
- 点击 "Continue" 按钮可继续获取更多数据（如果存在）
显示格式设置：
- 点击列头的下拉箭头打开格式选择菜单
- 支持二进制 (BIN)、八进制 (OCT)、十进制 (DEC)、十六进制 (HEX) 显示
- 每个信号列可独立设置显示格式
元数据过滤：
- 支持按信号值特征过滤：X 态、Z 态、混合态、跳变、翻转
- 多个过滤条件为 "或" 关系
列过滤：
- 在列头的输入框中输入过滤条件
- 支持十六进制值过滤（如
0x1a）
消息窗口位于底部面板：
- Driver 追踪结果：显示信号的驱动源
- 系统消息：显示操作结果和错误信息
- 双击跳转：双击追踪结果可跳转到对应代码
保存 Session：
- 点击菜单 File → Save Session
- 输入 Session 名称
- 保存内容包括：
- 服务器连接信息
- 当前加载的 KDB 和波形文件
- 所有打开的源代码窗口
- 所有打开的波形窗口（包含信号列表）
- 所有打开的表格视图（包含信号列表和时间范围）
- 书签
恢复 Session：
- 点击菜单 File → Restore Session
- 从列表中选择已保存的 Session
- 系统会自动：
- 连接服务器
- 加载 KDB 和波形文件
- 恢复所有窗口和书签
管理 Session：
- 在保存/恢复对话框中可删除不需要的 Session
- 支持搜索已保存的 Session
- Session 数据存储在浏览器 LocalStorage 中
| 菜单 | 功能 |
|---|---|
| File | |
| Connect | 连接到服务器 |
| Disconnect | 断开服务器连接 |
| Open KDB | 打开 KDB 文件选择对话框 |
| Open Waveform | 打开波形文件选择对话框 |
| Close KDB | 关闭当前 KDB |
| Close Waveform | 关闭当前波形 |
| Save Session | 保存当前工作状态 |
| Restore Session | 恢复已保存的工作状态 |
| View | |
| Zoom In | 放大波形时间轴 |
| Zoom Out | 缩小波形时间轴 |
| Zoom Full | 波形适应窗口宽度 |
| Navigate | |
| History Back | 导航到上一个代码位置 |
| History Forward | 导航到下一个代码位置 |
| Add Bookmark | 添加书签到当前位置 |
| Find Driver | 查找选中信号的驱动源（需在代码中选中信号） |
| Find Definition | 查找选中实例的定义（需在代码中选中实例） |
| Waveform | |
| Add Signal | 添加信号到波形窗口（需在 Signal Panel 双击信号） |
| Remove Signal | 从波形窗口移除信号 |
| OPFS Cache | 切换 OPFS 缓存开关 |
| Memory Cache | 切换内存缓存开关 |
| Help | |
| KDB Debug Tool | 打开 KDB 调试工具 |
| About | 打开项目 GitHub 页面 |
| 按钮 | 功能 |
|---|---|
| 🔍+ | 放大波形 |
| 🔍- | 缩小波形 |
| 🔍↔ | 波形适应窗口 |
| 🔍 | 搜索值 |
| ← | 导航后退 |
| → | 导航前进 |
| + | 添加新标签页 |
| 📍 | 添加书签 |
- 确认 Server 已启动
- 检查服务器地址和端口是否正确
- 检查防火墙设置
- 查看浏览器控制台是否有错误信息
- 波形文件较大时，首次加载需要下载和解压
- 系统会自动缓存已加载的数据
- 后续访问会更快
使用 File → Save Session 功能，可以保存当前所有窗口和设置，下次通过 Restore Session 快速恢复。
- Chrome 90+
- Firefox 90+
- Safari 15+
- Edge 90+
需要支持 WebGL 2.0 和 WebAssembly。
- 代码结构混乱：由于主要由 AI 生成，代码存在重复、缺乏组织的问题。部分功能实现过于复杂，模块间耦合度较高，这是目前 AI 编程模型和工具链需要继续解决的重要问题。
- Interpreter 内存消耗：对于大型设计，Interpreter 解析时耗时较长，内存消耗过大，可能出现 OOM（Out of Memory）错误。建议分批处理大型设计或增加系统内存。
- web-client 渲染流畅度不够：目前还未实现webGL2的渲染，只是使用的Canvas2D进行波形渲染。
- 测试覆盖不足：很多功能缺乏充分的测试，可能存在边界情况处理不当的问题。欢迎社区贡献测试用例和 bug 报告。
- Web Client 开发文档:
web-client/README.md - Server 文档:
server/README.md - API 文档:
server/docs/API.md
MIT License