headcrab 0.1.0

A modern Rust debugging library.
Documentation
  • Coverage
  • 40%
    2 out of 5 items documented0 out of 5 items with examples
  • Size
  • Source code size: 45.69 kB This is the summed size of all the files inside the crates.io package for this release.
  • Documentation size: 113.97 kB This is the summed size of all files generated by rustdoc for all configured targets
  • Links
  • nbaksalyar/headcrab
    12 1 0
  • crates.io
  • Dependencies
  • Versions
  • Owners
  • nbaksalyar

Headcrab

A modern Rust debugging library.

Goals

This project's goal is to provide a modern debugger library for Rust so that you could build custom debuggers specific for your application. It will be developed with modern operating systems and platforms in mind.

You can learn more about the goals and reasoning behind the project in the following blog posts:

Roadmap

List of phase 1 goals for the project:

  • Modular API and extensibility.
  • Read & modify memory of other processes and control their execution (cross-platform: x86_64 for Linux & macOS).
  • Basic symbolication for Rust (read DWARF debug information and translate symbols into addresses).
  • Get information about process threads.
  • Read & write variables in the thread-local storage.
  • Setting breakpoints at given locations.

Long-term goals:

  • Rust expression parser (reusing MIR and other components from the Rust compiler).
  • Read complex data structures.
  • Make symbolication reusable for eBPF and dynamic tracing.
  • JSON-RPC and support for Debug Adapter Protocol.
  • Command-line interface.
  • Collaborative debugging.
  • Use the LLVM DExTer to improve user experience.
  • Support more platforms and operating systems (Illumos, FreeBSD, OpenBSD, Windows).

Contributing

Please follow the code of conduct for this project.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

License

Licensed under either of

at your option.