Yehowshua/ZIm
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Don't rely on debug symbols for panic reporting

Browse source
This commit is contained in:
Max Brunsfeld 2023-06-15 12:27:39 -07:00
parent 0863486803
commit e7e0f2183f
1 changed files with 10 additions and 59 deletions
Download patch file Download diff file Expand all files Collapse all files

69
crates/zed/src/main.rs
View file

@ -31,7 +31,6 @@ use std::{
ffi::OsStr, ffi::OsStr,
fs::OpenOptions, fs::OpenOptions,
io::Write as _, io::Write as _,
ops::Not,
os::unix::prelude::OsStrExt, os::unix::prelude::OsStrExt,
panic, panic,
path::{Path, PathBuf}, path::{Path, PathBuf},
@ -373,7 +372,6 @@ struct Panic {
os_version: Option<String>, os_version: Option<String>,
architecture: String, architecture: String,
panicked_on: u128, panicked_on: u128,
identifying_backtrace: Option<Vec<String>>,
} }
#[derive(Serialize)] #[derive(Serialize)]
@ -401,61 +399,18 @@ fn init_panic_hook(app: &App) {
.unwrap_or_else(|| "Box<Any>".to_string()); .unwrap_or_else(|| "Box<Any>".to_string());
let backtrace = Backtrace::new(); let backtrace = Backtrace::new();
let backtrace = backtrace let mut backtrace = backtrace
.frames() .frames()
.iter() .iter()
.filter_map(|frame| { .filter_map(|frame| Some(format!("{:#}", frame.symbols().first()?.name()?)))
let symbol = frame.symbols().first()?;
let path = symbol.filename()?;
Some((path, symbol.lineno(), format!("{:#}", symbol.name()?)))
})
.collect::<Vec<_>>(); .collect::<Vec<_>>();
let this_file_path = Path::new(file!()); // Strip out leading stack frames for rust panic-handling.
if let Some(ix) = backtrace
// Find the first frame in the backtrace for this panic hook itself. Exclude .iter()
// that frame and all frames before it. .position(|name| name == "rust_begin_unwind")
let mut start_frame_ix = 0; {
let mut codebase_root_path = None; backtrace.drain(0..=ix);
for (ix, (path, _, _)) in backtrace.iter().enumerate() {
if path.ends_with(this_file_path) {
start_frame_ix = ix + 1;
codebase_root_path = path.ancestors().nth(this_file_path.components().count());
break;
}
}
// Exclude any subsequent frames inside of rust's panic handling system.
while let Some((path, _, _)) = backtrace.get(start_frame_ix) {
if path.starts_with("/rustc") {
start_frame_ix += 1;
} else {
break;
}
}
// Build two backtraces:
// * one for display, which includes symbol names for all frames, and files
// and line numbers for symbols in this codebase
// * one for identification and de-duplication, which only includes symbol
// names for symbols in this codebase.
let mut display_backtrace = Vec::new();
let mut identifying_backtrace = Vec::new();
for (path, line, symbol) in &backtrace[start_frame_ix..] {
display_backtrace.push(symbol.clone());
if let Some(codebase_root_path) = &codebase_root_path {
if let Ok(suffix) = path.strip_prefix(&codebase_root_path) {
identifying_backtrace.push(symbol.clone());
let display_path = suffix.to_string_lossy();
if let Some(line) = line {
display_backtrace.push(format!(" {display_path}:{line}"));
} else {
display_backtrace.push(format!(" {display_path}"));
}
}
}
} }
let panic_data = Panic { let panic_data = Panic {
@ -477,11 +432,7 @@ fn init_panic_hook(app: &App) {
.duration_since(UNIX_EPOCH) .duration_since(UNIX_EPOCH)
.unwrap() .unwrap()
.as_millis(), .as_millis(),
backtrace: display_backtrace, backtrace,
identifying_backtrace: identifying_backtrace
.is_empty()
.not()
.then_some(identifying_backtrace),
}; };
if let Some(panic_data_json) = serde_json::to_string_pretty(&panic_data).log_err() { if let Some(panic_data_json) = serde_json::to_string_pretty(&panic_data).log_err() {
@ -498,7 +449,7 @@ fn init_panic_hook(app: &App) {
.open(&panic_file_path) .open(&panic_file_path)
.log_err(); .log_err();
if let Some(mut panic_file) = panic_file { if let Some(mut panic_file) = panic_file {
write!(&mut panic_file, "{}", panic_data_json).log_err(); write!(&mut panic_file, "{}\n", panic_data_json).log_err();
panic_file.flush().log_err(); panic_file.flush().log_err();
} }
} }