miden-objtool 0.10.2

Common utilities for analyzing Miden artifacts
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

mod debuginfo;

use clap::{Subcommand, ValueEnum};
use miden_mast_package::PackageDebugInfoError;

/// Dump useful information from assembled Miden packages
#[derive(Debug, Subcommand)]
#[command(name = "debuginfo", rename_all = "kebab-case")]
pub enum Dump {
    /// Dump debug information encoded in a .masp file
    DebugInfo(debuginfo::Config),
}

/// The set of known sections that we've added dump support for
#[derive(Debug, Clone, Copy, ValueEnum)]
pub enum Section {
    /// Show string table
    Strings,
    /// Show type information
    Types,
    /// Show source file information
    Files,
    /// Show function debug information
    Functions,
    /// Show variable information within functions
    Variables,
    /// Show variable location decorators from MAST (similar to DWARF .debug_loc)
    Locations,
}

#[derive(Debug, thiserror::Error)]
pub enum DumpError {
    #[error("failed to read file: {0}")]
    Io(#[from] std::io::Error),
    #[error("failed to parse package: {0}")]
    Parse(String),
    #[error("no debug_info section found in package")]
    NoDebugInfo,
    #[error(transparent)]
    InvalidDebugInfo(#[from] PackageDebugInfoError),
}

impl From<miden_core::serde::DeserializationError> for DumpError {
    #[inline]
    fn from(err: miden_core::serde::DeserializationError) -> Self {
        Self::Parse(err.to_string())
    }
}

pub fn run(command: &Dump) -> Result<(), DumpError> {
    match command {
        Dump::DebugInfo(config) => debuginfo::dump(config),
    }
}