-
Notifications
You must be signed in to change notification settings - Fork 1.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Refactored debugger to extract TUI abstraction. Added option to dump …
…debugger context to file as json.
- Loading branch information
Showing
15 changed files
with
292 additions
and
79 deletions.
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
use std::collections::{BTreeMap, HashMap}; | ||
use alloy_primitives::Address; | ||
use foundry_common::compile::ContractSources; | ||
use foundry_common::evm::Breakpoints; | ||
use foundry_evm_core::debug::DebugNodeFlat; | ||
use foundry_evm_core::utils::PcIcMap; | ||
|
||
pub struct DebuggerContext { | ||
pub debug_arena: Vec<DebugNodeFlat>, | ||
pub identified_contracts: HashMap<Address, String>, | ||
/// Source map of contract sources | ||
pub contracts_sources: ContractSources, | ||
/// A mapping of source -> (PC -> IC map for deploy code, PC -> IC map for runtime code) | ||
pub pc_ic_maps: BTreeMap<String, (PcIcMap, PcIcMap)>, | ||
pub breakpoints: Breakpoints, | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,77 @@ | ||
//! The TUI implementation. | ||
|
||
use alloy_primitives::Address; | ||
use eyre::Result; | ||
use foundry_common::{compile::ContractSources, evm::Breakpoints}; | ||
use foundry_evm_core::{debug::DebugNodeFlat, utils::PcIcMap}; | ||
use revm::primitives::SpecId; | ||
use std::collections::HashMap; | ||
use std::path::PathBuf; | ||
|
||
|
||
use crate::{DebuggerBuilder, ExitReason, FileDumper}; | ||
use crate::tui::TUI; | ||
use crate::context::DebuggerContext; | ||
|
||
/// The TUI debugger. | ||
pub struct Debugger { | ||
context: DebuggerContext, | ||
} | ||
|
||
impl Debugger { | ||
/// Creates a new debugger builder. | ||
#[inline] | ||
pub fn builder() -> DebuggerBuilder { | ||
DebuggerBuilder::new() | ||
} | ||
|
||
/// Creates a new debugger. | ||
pub fn new( | ||
debug_arena: Vec<DebugNodeFlat>, | ||
identified_contracts: HashMap<Address, String>, | ||
contracts_sources: ContractSources, | ||
breakpoints: Breakpoints, | ||
) -> Self { | ||
let pc_ic_maps = contracts_sources | ||
.entries() | ||
.filter_map(|(contract_name, (_, contract))| { | ||
Some(( | ||
contract_name.clone(), | ||
( | ||
PcIcMap::new(SpecId::LATEST, contract.bytecode.bytes()?), | ||
PcIcMap::new(SpecId::LATEST, contract.deployed_bytecode.bytes()?), | ||
), | ||
)) | ||
}) | ||
.collect(); | ||
Self { context: DebuggerContext { debug_arena, identified_contracts, contracts_sources, pc_ic_maps, breakpoints } } | ||
} | ||
|
||
/// Starts the debugger TUI. Terminates the current process on failure or user exit. | ||
pub fn run_tui_exit(mut self) -> ! { | ||
let code = match self.try_run_tui() { | ||
Ok(ExitReason::CharExit) => 0, | ||
Err(e) => { | ||
println!("{e}"); | ||
1 | ||
} | ||
}; | ||
std::process::exit(code) | ||
} | ||
|
||
/// Starts the debugger TUI. | ||
pub fn try_run_tui(&mut self) -> Result<ExitReason> { | ||
eyre::ensure!(!self.context.debug_arena.is_empty(), "debug arena is empty"); | ||
|
||
let mut tui = TUI::new(&mut self.context); | ||
tui.try_run() | ||
} | ||
|
||
/// Dumps debug context to file. | ||
pub fn dump_to_file(&mut self, path: &PathBuf) -> Result<()> { | ||
eyre::ensure!(!self.context.debug_arena.is_empty(), "debug arena is empty"); | ||
|
||
let mut file_dumper = FileDumper::new(path, &mut self.context); | ||
file_dumper.run() | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,125 @@ | ||
//! The file dumper implementation | ||
|
||
use std::collections::{BTreeMap, HashMap}; | ||
use std::path::PathBuf; | ||
use alloy_primitives::Address; | ||
use serde::Serialize; | ||
|
||
use crate::context::DebuggerContext; | ||
use eyre::Result; | ||
use foundry_compilers::artifacts::ContractBytecodeSome; | ||
use foundry_common::compile::ContractSources; | ||
use foundry_common::fs::{write_json_file}; | ||
use foundry_evm_core::debug::DebugNodeFlat; | ||
use foundry_evm_core::utils::PcIcMap; | ||
|
||
/// The file dumper | ||
pub struct FileDumper<'a> { | ||
path: &'a PathBuf, | ||
debugger_context: &'a mut DebuggerContext, | ||
} | ||
|
||
impl<'a> FileDumper<'a> { | ||
pub fn new(path: &'a PathBuf, debugger_context: &'a mut DebuggerContext, ) -> Self { | ||
Self { path, debugger_context } | ||
} | ||
|
||
pub fn run(&mut self) -> Result<()> { | ||
let data = DebuggerDump::from(self.debugger_context); | ||
write_json_file(self.path, &data).unwrap(); | ||
Ok(()) | ||
} | ||
} | ||
|
||
#[derive(Serialize)] | ||
struct DebuggerDump<'a> { | ||
calls: &'a Vec<DebugNodeFlat>, | ||
identified_contracts: &'a HashMap<Address, String>, | ||
/// Source map of contract sources | ||
contracts_sources: ContractSourcesDump, | ||
/// A mapping of source -> (PC -> IC map for deploy code, PC -> IC map for runtime code) | ||
pc_ic_maps: PcIcMapDump, | ||
} | ||
|
||
impl <'a> DebuggerDump<'a> { | ||
fn from(debugger_context: &'a DebuggerContext) -> DebuggerDump { | ||
Self { | ||
calls: &debugger_context.debug_arena, | ||
identified_contracts: &debugger_context.identified_contracts, | ||
contracts_sources: ContractSourcesDump::from(&debugger_context.contracts_sources), | ||
pc_ic_maps: PcIcMapDump::from(&debugger_context.pc_ic_maps), | ||
} | ||
} | ||
} | ||
|
||
#[derive(Serialize)] | ||
struct ContractSourcesDump { | ||
#[serde(flatten)] | ||
inner: HashMap<String, Vec<ContractSourcesItemDump>>, | ||
} | ||
|
||
#[derive(Serialize)] | ||
struct ContractSourcesItemDump { | ||
id: u32, | ||
source: String, | ||
#[serde(flatten)] | ||
bytecode: ContractBytecodeSome, | ||
} | ||
|
||
impl ContractSourcesDump { | ||
fn from(contract_sources: &ContractSources) -> ContractSourcesDump { | ||
let mut inner: HashMap<String, Vec<ContractSourcesItemDump>> = HashMap::new(); | ||
|
||
for (name, ids) in &contract_sources.ids_by_name { | ||
let list = inner.entry(name.clone()).or_insert(Default::default()); | ||
for id in ids { | ||
if let Some((source, bytecode)) = contract_sources.sources_by_id.get(id) { | ||
list.push(ContractSourcesItemDump{id: *id, source: source.clone(), bytecode: bytecode.clone()}); | ||
} | ||
} | ||
} | ||
|
||
Self { inner } | ||
} | ||
} | ||
|
||
#[derive(Serialize)] | ||
struct PcIcMapDump { | ||
#[serde(flatten)] | ||
inner: HashMap<String, PcIcMapItemDump>, | ||
} | ||
|
||
impl PcIcMapDump { | ||
fn from(pc_ic_map: &BTreeMap<String, (PcIcMap, PcIcMap)>) -> PcIcMapDump { | ||
let mut inner = HashMap::new(); | ||
|
||
for (k, v) in pc_ic_map.iter() { | ||
inner.insert(k.clone(), PcIcMapItemDump::from(v)); | ||
} | ||
|
||
Self { inner } | ||
} | ||
} | ||
|
||
#[derive(Serialize)] | ||
struct PcIcMapItemDump { | ||
deploy_code_map: HashMap<usize, usize>, | ||
runtime_code_map: HashMap<usize, usize>, | ||
} | ||
|
||
impl PcIcMapItemDump { | ||
fn from(pc_ic_map: &(PcIcMap, PcIcMap)) -> PcIcMapItemDump { | ||
let mut deploy_code_map= HashMap::new(); | ||
let mut runtime_code_map = HashMap::new(); | ||
|
||
for (k, v) in pc_ic_map.0.inner.iter() { | ||
deploy_code_map.insert(k.clone(), v.clone()); | ||
} | ||
|
||
for (k, v) in pc_ic_map.1.inner.iter() { | ||
runtime_code_map.insert(k.clone(), v.clone()); | ||
} | ||
|
||
Self { deploy_code_map, runtime_code_map } | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.