Toolbox

Ruby debugging toolbox for GDB and LLDB, providing commands for inspecting Ruby objects, fibers, and VM internals across multiple debuggers.

Features

• Multi-debugger support: Works with both GDB and LLDB through a unified abstraction layer.
• Object inspection: Pretty-print Ruby objects, hashes, arrays, and complex structures.
• Fiber debugging: Navigate and inspect Ruby fibers with full backtraces.
• Heap scanning: Search the Ruby heap for objects and diagnose memory issues.
• Stack inspection: Examine both Ruby VM stacks and native C stacks.
• Easy installation: Simple bake tasks for both GDB and LLDB.

Usage

Please see the project documentation for more details.

• Getting Started - This guide explains how to install and use Toolbox for debugging Ruby programs and core dumps with GDB or LLDB.

• Object Inspection - This guide explains how to use rb-print to inspect Ruby objects, hashes, arrays, and structs in GDB.

• Stack Inspection - This guide explains how to inspect both Ruby VM stacks and native C stacks when debugging Ruby programs.

• Fiber Debugging - This guide explains how to debug Ruby fibers using GDB, including inspecting fiber state, backtraces, and switching between fiber contexts.

• Heap Debugging - This guide explains how to navigate Ruby's heap to find objects, diagnose memory issues, and understand object relationships.

Releases

Please see the project releases for all releases.

v0.2.0

• Introduce support for lldb using debugger shims.

v0.1.0

• Initial release.

See Also

• GDB Python API Documentation
• LLDB Python API Documentation
• Ruby VM Internals

Contributing

We welcome contributions to this project.

1. Fork it.
2. Create your feature branch (git checkout -b my-new-feature).
3. Commit your changes (git commit -am 'Add some feature').
4. Push to the branch (git push origin my-new-feature).
5. Create new Pull Request.

Developer Certificate of Origin

In order to protect users of this project, we require all contributors to comply with the Developer Certificate of Origin. This ensures that all contributions are properly licensed and attributed.

Community Guidelines

This project is best served by a collaborative and respectful environment. Treat each other professionally, respect differing viewpoints, and engage constructively. Harassment, discrimination, or harmful behavior is not tolerated. Communicate clearly, listen actively, and support one another. If any issues arise, please inform the project maintainers.