Document how to debug an application built with uefi-rs

Open
#289 26 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
30/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Tech stack
rust

Research direction

Start by reviewing the discussion in issue #285 and reproducing the reported debugging attempt with the uefi-test-runner. Investigate rust-gdb and rust-lldb symbol handling for an application running under QEMU, then document a working procedure or clearly identify the toolchain work still required.

Written by the indexing model from the issue text.

Description

documentation help wanted

Splitting this out from https://github.com/rust-osdev/uefi-rs/issues/285:

@timrobertsdev wrote:

I've been attempting to investigate why, but I've been having a little trouble getting rust-gdb and rust-lldb to recognize the symbols in the uefi-test-runner.efi binary. Oddly enough, objdump -freports that it is flagged as HAS_DEBUG, but objdump -t wasn't able to find any symbols. Attemping image dump symtab in rust-lldb results in num-symbols = 0. I've probably got something setup incorrectly on my end, any advice would be greatly appreciated.

I don't know the answer to this, but it would be nice to have a straightforward way to debug an application built with uefi-rs running under qemu. I'm not sure if there is something that currently works and it just needs some documentation, or if there's work needed in the toolchain.

Dominant language
Rust
Stars
1.7k
Forks
200
Avg merge
1d 1h
Merged PRs (30d)
38

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from rust-osdev/uefi-rs

All issues in rust-osdev/uefi-rs

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.