-
Notifications
You must be signed in to change notification settings - Fork 439
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add option to output local variables during dump
This adds the ability to show the local variables for each frame when showing the stack trace with the dump command. Currently we only support str/float/int /bool/nonetype/list/tuple/dict objects - everything else will just show the type and address. (#77). Dictionary processing also currently only works for python 3.6+, everything else will show a 'dict' object instead. This also adds the ability to show the thead names for each thread during dump. Since this relies on a bunch of dictionary lookups, this also only works for python 3.6+ (#47)
- Loading branch information
Showing
18 changed files
with
1,806 additions
and
332 deletions.
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,129 @@ | ||
| use std::collections::HashMap; | ||
|
|
||
| use console::style; | ||
| use failure::Error; | ||
|
|
||
| use crate::config::Config; | ||
| use crate::python_bindings::{v3_6_6, v3_7_0, v3_8_0}; | ||
| use crate::python_interpreters::{InterpreterState, Object, TypeObject}; | ||
| use crate::python_spy::PythonSpy; | ||
| use crate::python_data_access::{copy_string, copy_long, stringify_pyobject, DictIterator}; | ||
|
|
||
| use crate::version::Version; | ||
|
|
||
| use remoteprocess::ProcessMemory; | ||
|
|
||
| pub fn print_traces(process: &mut PythonSpy, config: &Config) -> Result<(), Error> { | ||
| if config.dump_json { | ||
| let traces = process.get_stack_traces()?; | ||
| println!("{}", serde_json::to_string_pretty(&traces)?); | ||
| return Ok(()) | ||
| } | ||
|
|
||
| // try getting the threadnames, but don't sweat it if we can't. Since this relies on dictionary | ||
| // processing we only handle py3.6+ right now, and this doesn't work at all if the | ||
| // threading module isn't imported in the target program | ||
| let thread_names = match process.version { | ||
| Version{major: 3, minor: 6, ..} => thread_name_lookup::<v3_6_6::_is>(process).ok(), | ||
| Version{major: 3, minor: 7, ..} => thread_name_lookup::<v3_7_0::_is>(process).ok(), | ||
| Version{major: 3, minor: 8, ..} => thread_name_lookup::<v3_8_0::_is>(process).ok(), | ||
| _ => None | ||
| }; | ||
|
|
||
| println!("Process {}: {}", | ||
| style(process.pid).bold().yellow(), | ||
| process.process.cmdline()?.join(" ")); | ||
|
|
||
| println!("Python v{} ({})\n", | ||
| style(&process.version).bold(), | ||
| style(process.process.exe()?).dim()); | ||
|
|
||
| let traces = process.get_stack_traces()?; | ||
|
|
||
| for trace in traces.iter().rev() { | ||
| let thread_id = trace.format_threadid(); | ||
| let thread_name = match thread_names.as_ref() { | ||
| Some(names) => names.get(&trace.thread_id), | ||
| None => None | ||
| }; | ||
| match thread_name { | ||
| Some(name) => { | ||
| println!("Thread {} ({}): \"{}\"", style(thread_id).bold().yellow(), trace.status_str(), name); | ||
| } | ||
| None => { | ||
| println!("Thread {} ({})", style(thread_id).bold().yellow(), trace.status_str()); | ||
| } | ||
| }; | ||
|
|
||
| for frame in &trace.frames { | ||
| let filename = match &frame.short_filename { Some(f) => &f, None => &frame.filename }; | ||
| if frame.line != 0 { | ||
| println!(" {} ({}:{})", style(&frame.name).green(), style(&filename).cyan(), style(frame.line).dim()); | ||
| } else { | ||
| println!(" {} ({})", style(&frame.name).green(), style(&filename).cyan()); | ||
| } | ||
|
|
||
| if let Some(locals) = &frame.locals { | ||
| let mut shown_args = false; | ||
| let mut shown_locals = false; | ||
| for local in locals { | ||
| if local.arg && !shown_args { | ||
| println!(" {}:", style("Arguments:").dim()); | ||
| shown_args = true; | ||
| } else if !local.arg && !shown_locals { | ||
| println!(" {}:", style("Locals:").dim()); | ||
| shown_locals = true; | ||
| } | ||
|
|
||
| let value = stringify_pyobject(&process.process, &process.version, local.addr, 128)?; | ||
| println!(" {}: {}", local.name, value); | ||
| } | ||
| } | ||
| } | ||
| } | ||
| Ok(()) | ||
| } | ||
|
|
||
| /// Returns a hashmap of threadid: threadname, by inspecting the '_active' variable in the | ||
| /// 'threading' module. | ||
| fn thread_name_lookup<I: InterpreterState>(spy: &PythonSpy) -> Result<HashMap<u64, String>, Error> { | ||
| let mut ret = HashMap::new(); | ||
| let process = &spy.process; | ||
| let interp: I = process.copy_struct(spy.interpreter_address)?; | ||
| for entry in DictIterator::from(process, interp.modules() as usize)? { | ||
| let (key, value) = entry?; | ||
| let module_name = copy_string(key as *const I::StringObject, process)?; | ||
| if module_name == "threading" { | ||
| let module: I::Object = process.copy_struct(value)?; | ||
| let module_type = process.copy_pointer(module.ob_type())?; | ||
| let dictptr: usize = process.copy_struct(value + module_type.dictoffset() as usize)?; | ||
| for i in DictIterator::from(process, dictptr)? { | ||
| let (key, value) = i?; | ||
| let name = copy_string(key as *const I::StringObject, process)?; | ||
| if name == "_active" { | ||
| for i in DictIterator::from(process, value)? { | ||
| let (key, value) = i?; | ||
| let (threadid, _) = copy_long(process, key)?; | ||
|
|
||
| let thread: I::Object = process.copy_struct(value)?; | ||
| let thread_type = process.copy_pointer(thread.ob_type())?; | ||
| let thread_dict_addr: usize = process.copy_struct(value + thread_type.dictoffset() as usize)?; | ||
|
|
||
| for i in DictIterator::from(process, thread_dict_addr)? { | ||
| let (key, value) = i?; | ||
| let varname = copy_string(key as *const I::StringObject, process)?; | ||
| if varname == "_name" { | ||
| let threadname = copy_string(value as *const I::StringObject, process)?; | ||
| ret.insert(threadid as u64, threadname); | ||
| break; | ||
| } | ||
| } | ||
| } | ||
| break; | ||
| } | ||
| } | ||
| break; | ||
| } | ||
| } | ||
| Ok(ret) | ||
| } |
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.