sbpf-coverage 0.2.12

Maps SBPF execution traces to source code for test coverage and trace disassembly of Solana programs
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

use anyhow::Result;
use clap::Parser;
use std::{collections::HashSet, path::PathBuf};

fn main() -> Result<()> {
    let options = Args::parse();
    let mode = if options.trace_disassemble {
        "trace"
    } else {
        "coverage"
    };
    eprintln!(
        "{} v{} ({})",
        env!("CARGO_PKG_NAME"),
        env!("CARGO_PKG_VERSION"),
        mode
    );

    let sbf_trace_dir = options.sbf_trace_dir;
    let src_paths: HashSet<_> = options.src_path.into_iter().collect();
    let sbf_paths = options.sbf_path;

    sbpf_coverage::run(
        sbf_trace_dir,
        src_paths,
        sbf_paths,
        options.debug,
        options.trace_disassemble,
        options.no_color,
    )?;

    Ok(())
}

/// CLI options
#[derive(Parser, Debug)]
#[command(version, about, long_about = None)]
struct Args {
    /// Enable debug information when parsing
    #[arg(short, long)]
    debug: bool,

    /// Source path to the Solana program (can be specified multiple times), please use full path
    #[arg(long, action = clap::ArgAction::Append, required = true)]
    src_path: Vec<PathBuf>,

    /// SBF path to where the Solana program's .so and .debug are located (typically target/deploy or target/deploy/debug) (can be specified multiple times), please use full path
    #[arg(long, action = clap::ArgAction::Append, required = true)]
    sbf_path: Vec<PathBuf>,

    /// Path to the register tracing dumps, please use full path
    #[arg(long, required = true)]
    sbf_trace_dir: PathBuf,

    /// Provides mapping between PC and source code.
    /// If the register tracing dump was collected with `SBF_TRACE_DISASSEMBLE` set
    /// (i.e `.trace` files are present for each trace in `SBF_TRACE_DIR`) then
    /// the output of the disassembly is included in the print giving
    /// a full picture between execution, native source code and SBPF instructions.
    #[arg(long)]
    trace_disassemble: bool,

    /// Disable colored output for trace disassembly as some terminals may not support it.
    #[arg(long, default_value_t = false)]
    no_color: bool,
}