axbuild 0.4.19

An OS build lib toolkit used by arceos
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75

use std::path::PathBuf;

use clap::{Args, Subcommand};

mod capture;
mod parser;
mod paths;
mod symbolize;

#[cfg(test)]
mod tests;

#[cfg(test)]
pub(crate) use capture::write_raw_blocks_from_output;
pub(crate) use capture::{
    BacktraceBlockCapture, BacktraceQemuCapture, flush_pending_stream_symbolize,
};
pub(crate) use paths::{arceos_rust_elf_path, std_test_elf_path};
pub(crate) use symbolize::{
    BacktraceSymbolizeSession, SymbolizeAfterQemuOutcome, keep_qemu_log_from_env,
    maybe_symbolize_after_qemu, symbolize_captured_blocks_to_string,
};
#[cfg(test)]
pub(crate) use symbolize::{
    apply_qemu_log_retention, should_delete_qemu_log_after_symbolize,
    should_persist_qemu_capture_log,
};

pub(super) const HOST_SYMBOLIZE_HEADER: &str = "=== host backtrace symbolize ===";

#[derive(Subcommand)]
pub enum Command {
    /// Extract and symbolize BACKTRACE_BEGIN/BT/BACKTRACE_END blocks from text logs.
    Symbolize(SymbolizeArgs),
}

#[derive(Args)]
pub struct SymbolizeArgs {
    /// Path to the kernel/app ELF file to symbolize addresses against.
    #[arg(long, value_name = "PATH")]
    pub elf: PathBuf,

    /// Path to the captured log. If omitted, read from stdin.
    #[arg(long, value_name = "PATH")]
    pub log: Option<PathBuf>,

    /// Only symbolize blocks whose kind matches this value.
    #[arg(long, value_name = "KIND")]
    pub kind: Option<String>,

    /// Subtract 1 from ip before symbolization (matches typical call-site adjustment).
    ///
    /// Use `--adjust-ip false` to disable.
    #[arg(
        long,
        value_name = "BOOL",
        default_value_t = true,
        num_args = 0..=1,
        default_missing_value = "true",
        value_parser = clap::value_parser!(bool)
    )]
    pub adjust_ip: bool,

    /// Apply a signed bias to ip before symbolization (useful when runtime addresses are slid).
    ///
    /// Example: `--ip-bias -0xffff_ffff_8000_0000`.
    #[arg(long, value_name = "I64", default_value_t = 0)]
    pub ip_bias: i64,
}

pub fn execute(command: Command) -> anyhow::Result<()> {
    match command {
        Command::Symbolize(args) => symbolize::symbolize_cli(args),
    }
}