https://github.com/samscott89/rudy
A Toolchain for Rust Debuginfo
https://github.com/samscott89/rudy
debugging rust
Last synced: 11 months ago
JSON representation
A Toolchain for Rust Debuginfo
- Host: GitHub
- URL: https://github.com/samscott89/rudy
- Owner: samscott89
- License: mit
- Created: 2025-05-29T20:59:00.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-08-09T19:27:23.000Z (11 months ago)
- Last Synced: 2025-08-09T19:33:20.376Z (11 months ago)
- Topics: debugging, rust
- Language: Rust
- Homepage: https://www.samjs.io/blog/rudy
- Size: 14 MB
- Stars: 102
- Watchers: 2
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 
Rudy
[](https://crates.io/crates/rudy-db)
[](https://docs.rs/rudy-db)
[](https://opensource.org/licenses/MIT)
A Rust library for interacting with debugging information of compiled artifacts using DWARF format. Provides lazy evaluation and incremental computation for long-running processes like debuggers.
⚠️ **Experimental Status**: This library is in early development (0.0.x). The API is unstable and subject to breaking changes.
> [!IMPORTANT]
> See the [announcement post](https://www.samjs.io/blog/rudy) for more on the rationale/design behind Rudy.
## LLDB Extension
We also provide an example `rudy-lldb` extension that brings the capabilities of `rudy-db` to the `lldb` debugger.
Here's a short demo:
[](https://asciinema.org/a/CfSY9cLqPwkkB1qxPJrLA302D)
### Installation (rudy-lldb)
**Quick Install**:
```bash
cargo install rudy-lldb
rudy-lldb-server install
```
This will download the LLDB client script and configure your `~/.lldbinit` automatically.
**Manual Install**:
- Install `rudy-lldb` from source: `cargo install rudy-lldb`
- Download the client: `curl https://raw.githubusercontent.com/samscott89/rudy/main/rudy-lldb/python/rudy_lldb.py -o ~/.lldb/rudy_lldb.py`
- Add to `~/.lldbinit`: `echo "command script import ~/.lldb/rudy_lldb.py" >> ~/.lldbinit`
**Server Management**: The rudy-lldb server will automatically start when you run your first `rd` command in LLDB. You can also manage it manually:
- `rudy-lldb-server start` - Start the server
- `rudy-lldb-server stop` - Stop the server
- Set `RUDY_AUTOSTART=0` to disable automatic server startup
## Architecture
- **Low-level DWARF parsing** (`rudy-dwarf`) - Parser combinators and visitor patterns abstracting gimli
- **High-level API** (`rudy-db`) - `DebugInfo` wrapper with salsa-based incremental caching
- **LLDB integration** (`rudy-lldb`) - RPC server for interactive debugging
## Features
- Lazy evaluation using [salsa](https://github.com/salsa-rs/salsa) for incremental computation
- Low-level DWARF parser combinators and visitor structs
- Higher-level `DebugInfo` wrapper for common debugging operations
- Cross-platform support (x86_64, aarch64 on macOS, Linux)
## Basic Usage (rudy-db)
Here's a simple example of loading a binary and resolving type information from a memory address:
```rust
use rudy_db::DebugDb;
use anyhow::Result;
fn main() -> Result<()> {
// Create a new database
let mut db = DebugDb::new();
// Get debug information for a binary
let debug_info = DebugInfo::new(&db, "/path/to/binary")?;
// Find a function by name
let function = db.find_function_by_name("my_function")?;
// get all params:
for param in &function.params {
println!("Param: {:?} with type: {}", param.name, param.ty.display_name());
}
Ok(())
}
```
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## Acknowledgments
- Built on top of [gimli](https://github.com/gimli-rs/gimli) for DWARF parsing
- Uses [salsa](https://github.com/salsa-rs/salsa) for incremental computation
---
**Note**: This is an experimental project. Please report any issues or feature requests on our [GitHub issue tracker](https://github.com/samscott89/rudy/issues).