gdbstub

An ergonomic and easy-to-integrate implementation of the GDB Remote Serial Protocol in Rust, with full #![no_std] support.

gdbstub makes it easy to integrate powerful guest debugging support to your emulator / hypervisor / debugger / embedded project. By implementing just a few basic methods of the gdbstub::Target trait, you can have a rich GDB debugging session up and running in no time!

gdbstub's API makes extensive use of a technique called Inlineable Dyn Extension Traits (IDETs) to expose fine-grained, zero-cost control over enabled GDB protocol features without relying on compile-time features flags. Aside from making it effortless to toggle enabled protocol features, IDETs also ensure that any unimplemented features are guaranteed to be dead-code-eliminated in release builds!

If you're looking for a quick snippet of example code to see what a typical gdbstub integration might look like, check out examples/armv4t/gdb/mod.rs

• Documentation (gdbstub)
• Documentation (gdbstub_arch)
• Changelog
• 0.5 to 0.6 Transition Guide

Why use gdbstub?

• Excellent Ergonomics
  • Instead of simply exposing the underlying GDB protocol "warts and all", gdbstub tries to abstract as much of the raw GDB protocol details from the user.
    • Instead of having to dig through obscure XML files deep the GDB codebase just to read/write from CPU/architecture registers, gdbstub comes with a community-curated collection of built-in architecture definitions for most popular platforms!
    • Organizes GDB's countless optional protocol extensions into a coherent, understandable, and type-safe hierarchy of traits.
    • Automatically handles client/server protocol feature negotiation, without needing to micro-manage the specific qSupported packet response.
  • gdbstub makes extensive use of Rust's powerful type system + generics to enforce protocol invariants at compile time, minimizing the number of tricky protocol details end users have to worry about.
  • Using a novel technique called Inlineable Dyn Extension Traits (IDETs), gdbstub enables fine-grained control over active protocol extensions without relying on clunky cargo features or the use of unsafe code!
• Easy to Integrate
  • gdbstub's API is designed to be a "drop in" solution when you want to add debugging support into a project, and shouldn't require any large refactoring effort to integrate into an existing project.
• #![no_std] Ready & Size Optimized
  • gdbstub is a no_std first library, whereby all protocol features are required to be no_std compatible.
  • gdbstub does not require any dynamic memory allocation, and can be configured to use fixed-size, pre-allocated buffers. This enables gdbstub to be used on even the most resource constrained, no-alloc platforms.
  • gdbstub is entirely panic free in most minimal configurations*, resulting in substantially smaller and more robust code.
    • *See the Writing panic-free code section below for more details.
  • gdbstub is transport-layer agnostic, and uses a basic Connection interface to communicate with the GDB server. As long as target has some method of performing in-order, serial, byte-wise I/O (e.g: putchar/getchar over UART), it's possible to run gdbstub on it!
  • "You don't pay for what you don't use": All code related to parsing/handling protocol extensions is guaranteed to be dead-code-eliminated from an optimized binary if left unimplemented. See the Zero-overhead Protocol Extensions section below for more details.
  • gdbstub's minimal configuration has an incredibly low binary size + RAM overhead, enabling it to be used on even the most resource-constrained microcontrollers.
    • When compiled in release mode, using all the tricks outlined in min-sized-rust, a baseline gdbstub implementation can weigh in at less than 10kb of .text + .rodata! *
    • *Exact numbers vary by target platform, compiler version, and gdbstub revision. Data was collected using the included example_no_std project compiled on x86_64.

Can I Use gdbstub in Production?

Yes, as long as you don't mind some API churn until 1.0.0 is released.

Due to gdbstub's heavy use of Rust's type system in enforcing GDB protocol invariants at compile time, it's often been the case that implementing new GDB protocol features has required making some breaking API changes. While these changes are typically quite minor, they are nonetheless semver-breaking, and may require a code-change when moving between versions. Any particularly involved changes will typically be documented in a dedicated transition guide document.

That being said, gdbstub has already been integrated into many real-world projects since its initial 0.1 release, and empirical evidence suggests that it seems to be doing its job quite well! Thusfar, most reported issues have been caused by improperly implemented Target and/or Arch implementations, while the core gdbstub library itself has proven to be reasonably bug-free.

See the Future Plans + Roadmap to 1.0.0 for more information on what features gdbstub still needs to implement before committing to API stability with version 1.0.0.

Debugging Features

The GDB Remote Serial Protocol is surprisingly complex, supporting advanced features such as remote file I/O, spawning new processes, "rewinding" program execution, and much, much more. Thankfully, most of these features are completely optional, and getting a basic debugging session up-and-running only requires implementing a few basic methods:

• Base GDB Protocol
  • Read/Write memory
  • Read/Write registers
  • Enumerating threads

Yep, that's right! That's all it takes to get gdb connected!

Of course, most use-cases will want to support additional debugging features as well. At the moment, gdbstub implements the following GDB protocol extensions:

• Automatic target architecture + feature configuration
• Resume
  • Continue
  • Single Step
  • Range Step
  • Reverse Step/Continue
• Breakpoints
  • Software Breakpoints
  • Hardware Breakpoints
  • Read/Write/Access Watchpoints (i.e: value breakpoints)
• Extended Mode
  • Launch new processes
  • Attach to an existing process
  • Kill an existing process
  • Pass env vars + args to spawned processes
  • Change working directory
  • Enable/disable ASLR
• Read Memory Map (info mem)
• Read Section/Segment relocation offsets
• Handle custom monitor Commands
  • Extend the GDB protocol with custom debug commands using GDB's monitor command!
• Host I/O
  • Access the remote target's filesystem to read/write file
  • Can be used to automatically read the remote executable on attach (using ExecFile)
• Read auxiliary vector (info auxv)

Note: GDB features are implemented on an as-needed basis by gdbstub's contributors. If there's a missing GDB feature that you'd like gdbstub to implement, please file an issue and/or open a PR!

For a full list of GDB remote features, check out the GDB Remote Configuration Docs for a table of GDB commands + their corresponding Remote Serial Protocol packets.

Zero-overhead Protocol Extensions

Using a technique called Inlineable Dyn Extension Traits (IDETs), gdbstub is able to leverage the Rust compiler's powerful optimization passes to ensure any unused features are dead-code-eliminated in release builds without having to rely on compile-time features flags!

For example, if your target doesn't implement a custom GDB monitor command handler, the resulting binary won't include any code related to parsing / handling the underlying qRcmd packet!

If you're interested in the low-level technical details of how IDETs work, I've included a brief writeup in the documentation here.

Feature flags

By default, the std and alloc features are enabled.

When using gdbstub in #![no_std] contexts, make sure to set default-features = false.

• alloc
  • Implement Connection for Box<dyn Connection>.
  • Log outgoing packets via log::trace! (uses a heap-allocated output buffer).
  • Provide built-in implementations for certain protocol features:
    • Use a heap-allocated packet buffer in GdbStub (if none is provided via GdbStubBuilder::with_packet_buffer).
    • (Monitor Command) Use a heap-allocated output buffer in ConsoleOutput.
• std (implies alloc)
  • Implement Connection for TcpStream and UnixStream.
  • Implement std::error::Error for gdbstub::Error.
  • Add a TargetError::Io variant to simplify std::io::Error handling from Target methods.
• paranoid_unsafe
  • Please refer to the unsafe in gdbstub section below for more details.

Examples

Real-World Examples

While some of these projects may use older versions of gdbstub, they can nonetheless serve as useful examples of what a typical gdbstub integration might look like.

If you end up using gdbstub in your project, consider opening a PR and adding it to this list!

• Virtual Machine Monitors (VMMs)
  • crosvm - The Chrome OS VMM
  • cloud-hypervisor - A VMM for modern cloud workloads
  • Firecracker - A lightweight VMM developed by AWS (feature is in PR)
  • uhyve - A minimal hypervisor for RustyHermit
• OS Kernels (using gdbstub on no_std)
  • vmware-labs/node-replicated-kernel - An (experimental) research OS kernel for x86-64 (amd64) machines
  • betrusted-io/xous-core - The Xous microkernel operating system
• Emulators
  • bevy-atari - An Atari XL/XE Emulator (MOS 6502)
  • rmips - MIPS R3000 virtual machine simulator
  • clicky - Emulator for classic clickwheel iPods (dual-core ARMv4T)
  • ts7200 - Emulator for the TS-7200 SoC (ARMv4T)
  • vaporstation - A Playstation One emulator (MIPS)
  • rustyboyadvance-ng - Nintendo GameBoy Advance emulator and debugger (ARMv4T)
  • microcorruption-emu - Emulator for the microcorruption.com ctf (MSP430)
• Other
  • udbserver - Plug-in GDB debugging for the Unicorn Engine (Multi Architecture)
  • enarx - An open source framework for running applications in Trusted Execution Environments

In-tree "Toy" Examples

These examples are built as part of the CI, and are guaranteed to be kept up to date with the latest version of gdbstub's API.

• armv4t - ./examples/armv4t/
  • An incredibly simple ARMv4T-based system emulator with gdbstub support.
  • Implements (almost) all available target::ext features. This makes it a great resource when first implementing a new protocol extension!
• armv4t_multicore - ./examples/armv4t_multicore/
  • A dual-core variation of the armv4t example.
  • Implements the core of gdbstub's multithread extensions API, but not much else.
• example_no_std - ./example_no_std
  • An extremely minimal example which shows off how gdbstub can be used in a #![no_std] project.
  • Unlike the armv4t/armv4t_multicore examples, this project does not include a working emulator, and simply stubs all gdbstub functions.
  • Doubles as a test-bed for tracking gdbstub's approximate binary footprint (via the check_size.sh script), as well as validating certain dead-code-elimination optimizations.

unsafe in gdbstub

gdbstub limits its use of unsafe to a bare minimum, with all uses of unsafe required to have a corresponding // SAFETY comment as justification. The following list exhaustively documents all uses of unsafe in gdbstub.

rustc + LLVM do a pretty incredible job at eliding bounds checks... most of the time. Unfortunately, there are a few places in the code where the compiler is not smart enough to "prove" that a bounds check isn't needed, and a bit of unsafe code is required to remove those bounds checks.

Enabling the paranoid_unsafe feature will swap out a handful of unsafe get_unchecked_mut operations with their safe equivalents, at the expense of introducing panicking code into gdbstub. This feature is disabled by default, as the unsafe code has been aggressively audited and tested for correctness. That said, if you're particularly paranoid about the use of unsafe code, enabling this feature may offer some piece of mind.

• When no cargo features are enabled:

  • A few trivially safe calls to NonZeroUsize::new_unchecked() when defining internal constants.

• When the paranoid_unsafe feature is enabled, the following unsafe code is removed:

  • src/protocol/packet.rs: Swaps a couple slice-index methods in PacketBuf to use get_unchecked_mut. The public API of struct ensures that the bounds used to index into the array remain in-bounds.
  • src/protocol/common/hex.rs: Use an alternate implementation of decode_hex_buf/decode_bin_buf which uses unsafe slice indexing.
  • src/common.rs: Use a checked transmute to convert a u8 to a Signal

• When the std feature is enabled:

  • src/connection/impls/unixstream.rs: An implementation of UnixStream::peek which uses libc::recv. This manual implementation will be removed once rust-lang/rust#76923 is stabilized.

Writing panic-free code

Ideally, the Rust compiler would have some way to opt-in to a strict "no-panic" mode. Unfortunately, at the time of writing (2022/04/24), no such mode exists. As such, the only way to avoid the Rust compiler + stdlib's implicit panics is by being very careful when writing code, and manually checking that those panicking paths get optimized out!

And when I say "manually checking", I actually mean "reading through generated assembly".

Why even go through this effort?

• Panic infrastructure can be expensive, and when you're optimizing for embedded, no_std use-cases, panic infrastructure brings in hundreds of additional bytes into the final binary.
• gdbstub can be used to implement low-level debuggers, and if the debugger itself panics, well... it's not like you can debug it all that easily!

In conclusion, here is the gdbstub promise regarding panicking code:

gdbstub will not introduce any additional panics into an existing binary, subject to the following conditions:

1. The binary is compiled in release mode
   • Subject to the specific rustc version being used (as codegen and optimization can vary wildly between versions)
   • Note: different hardware architectures may be subject to different compiler optimizations.
     • At this time, only x86 has been confirmed panic-free
2. gdbstub's paranoid_unsafe cargo feature is disabled
   • See the unsafe in gdbstub section for more details.
3. The Arch implementation being used doesn't include panicking code
   • Note: The arch implementations under gdbstub_arch are not guaranteed to be panic free!
   • If you do spot a panicking arch in gdbstub_arch, consider opening a PR to fix it

If you're using gdbstub in a no-panic project and found that gdbstub has introduced some panicking code, please file an issue!

Future Plans + Roadmap to 1.0.0

While the vast majority of GDB protocol features (e.g: remote filesystem support, tracepoint packets, most query packets, etc...) should not require breaking API changes, the following features will most likely require at least some breaking API changes, and should therefore be implemented prior to 1.0.0.

Not that this is not an exhaustive list, and is subject to change.

• Allow fine-grained control over target features via the Arch trait (#12)
• Implement GDB's various high-level operating modes:
  • Single/Multi Thread debugging
  • Multiprocess Debugging
    • Will require adding a third target::ext::base::multiprocess API.
    • Note: gdbstub already implements multiprocess extensions "under-the-hood", and just hard-codes a fake PID, so this is mostly a matter of "putting in the work".
  • Extended Mode (target extended-remote)
  • Non-Stop Mode
    • This may require some breaking API changes and/or some internals rework -- more research is needed.
• Have a working example of gdbstub running in a "bare-metal" #![no_std] environment.

Additionally, while not strict blockers to 1.0.0, it would be good to explore these features as well:

• Should gdbstub commit to a MSRV?
• Remove lingering instances of RawRegId from gdbstub_arch (#29)
• Exposing async/await interfaces (particularly wrt. handling GDB client interrupts) (#36)
• Supporting various LLDB extensions to the GDB RSP
  • Skimming through the list, it doesn't seem like these extensions would require breaking API changes -- more research is needed.
• Supporting multi-arch debugging via a single target
  • e.g: debugging both x86 and x64 processes when running in extended mode
• Proper handling of "nack" packets (for spotty connections)
  • Responding with "nack" is easy - the client has to re-transmit the command
  • Re-transmitting after receiving a "nack" might be a bit harder...

License

gdbstub is free and open source! All code in this repository is dual-licensed under either:

• MIT License (LICENSE-MIT or http://opensource.org/licenses/MIT)
• Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)

at your option. This means you can select the license you prefer! This dual-licensing approach is the de-facto standard in the Rust ecosystem and there are very good reasons to include both.

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.