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 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740
// Copyright 2015 Ted Mielczarek. See the COPYRIGHT
// file at the top-level directory of this distribution.
use std::borrow::Cow;
use std::collections::{BTreeMap, BTreeSet};
use std::ops::Deref;
use std::path::Path;
use std::sync::{Arc, Mutex};
use std::time::{Duration, SystemTime};
use minidump::{self, *};
use crate::evil;
use crate::process_state::{CallStack, CallStackInfo, LinuxStandardBase, ProcessState};
use crate::stackwalker;
use crate::symbols::*;
use crate::system_info::SystemInfo;
use crate::{arg_recovery, FrameTrust, StackFrame};
/// Configuration of the processor's exact behaviour.
///
/// This can be used to either:
///
/// * enable extra features that are disabled by default
/// * lock in the features you want enabled to minimize future changes
///
/// All fields are `pub`, but the type is `non_exhaustive`.
/// Recommended usage is to call one of the constructors to get a baseline
/// set of features, and then manually set any values you particularly care about.
///
/// If we decide an unstable feature exposed by these flags is a bad idea,
/// we may remove its functionality and turn it into a noop, but the flag
/// will remain to avoid breaking code. Similarly, if a feature seems to be
/// too bloated, its implementation may be hidden behind a cargo feature
/// flag, producing a similar result if that feature is statically disabled.
///
/// In either of these cases, a `warn` diagnostic will be emitted if you
/// try to use request a feature whose implementation does not exist.
///
/// [`process_minidump`][] uses [`ProcessorOptions::stable_basic`][], which
/// is also exposed as [`Default::default`].
///
/// ## Example:
///
/// ```
/// use minidump_processor::ProcessorOptions;
///
/// // Happy with the default-enabled features
/// let mut options = ProcessorOptions::stable_basic();
/// // But specifically want this cool unstable feature
/// options.recover_function_args = true;
/// ```
///
#[derive(Debug, Clone)]
#[non_exhaustive]
pub struct ProcessorOptions<'a> {
/// **\[UNSTABLE\]** The evil "raw json" mozilla's legacy infrastructure relies on.
///
/// Please don't use this. If you have to use this, you know who you are.
pub evil_json: Option<&'a Path>,
/// **\[UNSTABLE\]** Whether to try to heuristically recover function arguments in backtraces.
///
/// Currently this only work for x86, and assumes everything is either cdecl or thiscall
/// (inferred from whether the symbol name looks like a static function or a method).
pub recover_function_args: bool,
/// Set this value to subscribe to live statistics during the processing.
///
/// See [`PendingProcessorStats`] and [`PendingProcessorStatSubscriptions`].
pub stat_reporter: Option<&'a PendingProcessorStats>,
}
/// A subscription to various live updates during minidump processing.
///
/// Construct it with [`PendingProcessorStats::new`] and pass it into
/// [`ProcessorOptions::stat_reporter`]. The type internally handles
/// concurrency and can be safely sent or shared between threads.
///
/// The type can't be cloned just because we don't want to guarantee
/// how the atomics are implemented. Wrap it in an Arc if you want
/// shared access for yourself.
#[derive(Debug)]
pub struct PendingProcessorStats {
/// The stats we will track
subscriptions: PendingProcessorStatSubscriptions,
/// The actual computed stats
stats: Arc<Mutex<PendingProcessorStatsInner>>,
}
/// An implementation detail of PendingProcessorStats, where all the
/// actual stats are recorded. Can be changed without anything caring.
#[derive(Default, Debug, Clone)]
struct PendingProcessorStatsInner {
/// How many threads have been processed
num_threads_processed: u64,
/// How many threads there are in total (redundant, but convenient)
total_threads: u64,
/// The number of frames that have been walked
num_frames_processed: u64,
/// Frames that have been walked since you last queried this stat
new_walked_frames: Vec<WalkedFrame>,
/// The partial ProcessState, before stackwalking
unwalked_result: Option<ProcessState>,
}
#[derive(Debug, Clone, Default)]
#[non_exhaustive]
/// Live updates you want to subscribe to during the processing.
///
/// Pass this into [`PendingProcessorStats::new`] to configure it.
pub struct PendingProcessorStatSubscriptions {
/// Subscribe to stats on how many threads have been processed.
///
/// This can be used to give a progress estimate.
///
/// The values can be read with [`PendingProcessorStats::get_thread_count`].
pub thread_count: bool,
/// Subscribe to stats on how many frames have been processed.
///
/// This can be used to give a progress estimate.
///
/// The value can be read with [`PendingProcessorStats::get_frame_count`].
pub frame_count: bool,
/// Subscribe to a copy of the ProcessState before stackwalking (or symbolication).
///
/// This can be used to provide the quick and easy results while the expensive
/// stackwalker has to go off and start doing file or network i/o for symbols.
///
/// The values can be read with [`PendingProcessorStats::take_unwalked_result`].
pub unwalked_result: bool,
/// Subscribe to live StackFrame results.
///
/// This can be used to update [`PendingProcessorStatSubscriptions::unwalked_result`]
/// as the stackwalker makes progress. How useful/smooth this is depends on the input.
/// If the biggest symbol file is the first frame of the stack, the walker may hang at 0%
/// progress for a long time and then suddenly jump to 100% instantly, as the
/// first dependency gets resolved last.
///
/// The values can be read with [`PendingProcessorStats::drain_new_frames`].
pub live_frames: bool,
}
/// A StackFrame that has been walked, with metadata on which thread it's part of,
/// and which frame of that thread it is.
///
/// This is the payload for [`PendingProcessorStatSubscriptions::live_frames`].
#[derive(Debug, Clone)]
pub struct WalkedFrame {
/// The thread that this was, the index corresponds to [`ProcessState::threads`].
pub thread_idx: usize,
/// The frame that this was, the index corresponds to [`CallStack::frames`].
pub frame_idx: usize,
/// The actual walked and symbolicated StackFrame. Some post-processing analysis
/// may be missing, so these results should be discarded once you have the
/// final [`ProcessState`].
pub frame: StackFrame,
}
impl PendingProcessorStats {
/// Subscribe to the given stats.
///
/// Pass this into [`ProcessorOptions::stat_reporter`] to use it.
pub fn new(subscriptions: PendingProcessorStatSubscriptions) -> Self {
Self {
subscriptions,
stats: Default::default(),
}
}
/// Gets (processed_thread_count, total_thread_count).
///
/// This will panic if you didn't subscribe to
/// [`PendingProcessorStatSubscriptions::thread_count`].
pub fn get_thread_count(&self) -> (u64, u64) {
assert!(
self.subscriptions.thread_count,
"tried to get thread count stats, but wasn't subscribed!"
);
let stats = self.stats.lock().unwrap();
(stats.num_threads_processed, stats.total_threads)
}
/// Get count of walked frames.
///
/// This will panic if you didn't subscribe to
/// [`PendingProcessorStatSubscriptions::frame_count`].
pub fn get_frame_count(&self) -> u64 {
assert!(
self.subscriptions.frame_count,
"tried to get frame count stats, but wasn't subscribed!"
);
let stats = self.stats.lock().unwrap();
stats.num_frames_processed
}
/// Get all the new walked frames since this method was last called.
///
/// This operates via callback to allow implementation flexibility.
///
/// This will panic if you didn't subscribe to
/// [`PendingProcessorStatSubscriptions::live_frames`].
pub fn drain_new_frames(&self, mut callback: impl FnMut(WalkedFrame)) {
assert!(
self.subscriptions.live_frames,
"tried to get new frames, but wasn't subscribed!"
);
let mut stats = self.stats.lock().unwrap();
for frame in stats.new_walked_frames.drain(..) {
callback(frame);
}
}
/// Get the unwalked [`ProcessState`], if it has been computed.
///
/// This will yield `Some` exactly once.
///
/// This will panic if you didn't subscribe to
/// [`PendingProcessorStatSubscriptions::unwalked_result`].
pub fn take_unwalked_result(&self) -> Option<ProcessState> {
assert!(
self.subscriptions.unwalked_result,
"tried to get unwalked result, but wasn't subscribed!"
);
let mut stats = self.stats.lock().unwrap();
stats.unwalked_result.take()
}
/// Record how many threads there are in total.
pub(crate) fn set_total_threads(&self, total_threads: u64) {
// Only bother doing this if the user cares
if self.subscriptions.thread_count {
let mut stats = self.stats.lock().unwrap();
stats.total_threads = total_threads;
}
}
/// Record that a thread has been processed.
pub(crate) fn inc_processed_threads(&self) {
// Only bother doing this if the user cares
if self.subscriptions.thread_count {
let mut stats = self.stats.lock().unwrap();
stats.num_threads_processed += 1;
}
}
/// Record that this frame has been walked.
pub(crate) fn add_walked_frame(&self, thread_idx: usize, frame_idx: usize, frame: &StackFrame) {
// Only bother doing this if the user cares
if self.subscriptions.live_frames || self.subscriptions.frame_count {
let mut stats = self.stats.lock().unwrap();
// Once we're in here it's easier to update this then check if they care
stats.num_frames_processed += 1;
// But this one is worth rechecking
if self.subscriptions.live_frames {
stats.new_walked_frames.push(WalkedFrame {
thread_idx,
frame_idx,
frame: frame.clone(),
});
}
}
}
/// Record this unwalked [`ProcessState`].
pub(crate) fn add_unwalked_result(&self, state: &ProcessState) {
// Only bother doing this if the user cares
if self.subscriptions.unwalked_result {
let mut stats = self.stats.lock().unwrap();
stats.unwalked_result = Some(state.clone());
}
}
}
impl ProcessorOptions<'_> {
/// "Do the normal stuff everyone should want"
///
/// * `evil_json: None`
/// * `recover_function_args: false`
///
/// Unlike stable_all, you shouldn't expect this to change its results much.
///
/// It will specifically always try to:
///
/// * Perform full backtraces and symbolication of every thread.
/// * Produce detailed system info (OS, Cpu, Versions...)
/// * Produce detailed crash info (Crashing thread, crash address, formatted error...)
/// * List loaded and unloaded modules
pub fn stable_basic() -> Self {
ProcessorOptions {
evil_json: None,
recover_function_args: false,
stat_reporter: None,
}
}
/// "Turn all the stable features on"
///
/// * `evil_json: None`
/// * `recover_function_args: false`
///
/// (At this precise moment this is identical to stable_basic, but may diverge
/// as we introduce more features.)
///
/// Everything included by stable_basic, but willing to enable more interesting
/// features and spend extra time trying to find extra insights. This is the default
/// place that unstable features will "graduate" to when they're deemed good enough.
pub fn stable_all() -> Self {
ProcessorOptions {
evil_json: None,
recover_function_args: false,
stat_reporter: None,
}
}
/// "Turn EVERYTHING on, even the experimental stuff!"
///
/// * `evil_json: None`
/// * `recover_function_args: true`
///
/// (evil_json is still "disabled" because you need to give it needs a path.)
///
/// Some of this stuff can be really jank, use at your own risk!
pub fn unstable_all() -> Self {
ProcessorOptions {
evil_json: None,
recover_function_args: true,
stat_reporter: None,
}
}
/// Check if any of the enabled features are deprecated or disabled
/// and emit warnings if they are.
fn check_deprecated_and_disabled(&self) {
// Currently nothing is deprecated / disableable, but here's the template.
/*
use log::warn;
if self.my_bad_feature {
warn!("Deprecated ProcessorOption my_bad_feature has been removed and does nothing.")
}
if !cfg!(feature = "my-optional-feature") && self.my_optional_feature {
warn!("Disabled ProcessorOption my_optional_feature must be enabled via cargo.")
}
*/
}
}
impl Default for ProcessorOptions<'_> {
fn default() -> Self {
Self::stable_basic()
}
}
/// An error encountered during minidump processing.
#[derive(Clone, Debug, thiserror::Error)]
pub enum ProcessError {
#[error("Failed to read minidump")]
MinidumpReadError(#[from] minidump::Error),
#[error("An unknown error occurred")]
UnknownError,
#[error("The system information stream was not found")]
MissingSystemInfo,
#[error("The thread list stream was not found")]
MissingThreadList,
}
impl ProcessError {
/// Returns just the name of the error, as a more human-friendly version of
/// an error-code for error logging.
pub fn name(&self) -> &'static str {
match self {
ProcessError::MinidumpReadError(_) => "MinidumpReadError",
ProcessError::UnknownError => "UnknownError",
ProcessError::MissingSystemInfo => "MissingSystemInfo",
ProcessError::MissingThreadList => "MissingThreadList",
}
}
}
/// Unwind all threads in `dump` and return a report as a `ProcessState`.
///
/// This is equivalent to [`process_minidump_with_options`] with
/// [`ProcessorOptions::stable_basic`][].
///
/// # Examples
///
/// ```
/// use minidump::Minidump;
/// use std::path::PathBuf;
/// use breakpad_symbols::{Symbolizer, SimpleSymbolSupplier};
/// use minidump_processor::ProcessError;
///
/// #[tokio::main]
/// async fn main() -> Result<(), ProcessError> {
/// # std::env::set_current_dir(env!("CARGO_MANIFEST_DIR"));
/// let mut dump = Minidump::read_path("../testdata/test.dmp")?;
/// let supplier = SimpleSymbolSupplier::new(vec!(PathBuf::from("../testdata/symbols")));
/// let symbolizer = Symbolizer::new(supplier);
/// let state = minidump_processor::process_minidump(&mut dump, &symbolizer).await?;
/// assert_eq!(state.threads.len(), 2);
/// println!("Processed {} threads", state.threads.len());
/// Ok(())
/// }
/// ```
pub async fn process_minidump<'a, T, P>(
dump: &Minidump<'a, T>,
symbol_provider: &P,
) -> Result<ProcessState, ProcessError>
where
T: Deref<Target = [u8]> + 'a,
P: SymbolProvider + Sync,
{
// No Evil JSON Here!
process_minidump_with_options(dump, symbol_provider, ProcessorOptions::default()).await
}
/// Process `dump` with the given options and return a report as a `ProcessState`.
///
/// See [`ProcessorOptions`][] for details on the specific features that can be
/// enabled and how to choose them.
pub async fn process_minidump_with_options<'a, T, P>(
dump: &Minidump<'a, T>,
symbol_provider: &P,
options: ProcessorOptions<'_>,
) -> Result<ProcessState, ProcessError>
where
T: Deref<Target = [u8]> + 'a,
P: SymbolProvider + Sync,
{
options.check_deprecated_and_disabled();
// Thread list is required for processing.
let thread_list = dump
.get_stream::<MinidumpThreadList>()
.or(Err(ProcessError::MissingThreadList))?;
let num_threads = thread_list.threads.len() as u64;
if let Some(reporter) = options.stat_reporter {
reporter.set_total_threads(num_threads);
}
// Try to get thread names, but it's only a nice-to-have.
let thread_names = dump
.get_stream::<MinidumpThreadNames>()
.unwrap_or_else(|_| MinidumpThreadNames::default());
// System info is required for processing.
let dump_system_info = dump
.get_stream::<MinidumpSystemInfo>()
.or(Err(ProcessError::MissingSystemInfo))?;
let (os_version, os_build) = dump_system_info.os_parts();
let linux_standard_base = dump.get_stream::<MinidumpLinuxLsbRelease>().ok();
let linux_cpu_info = dump
.get_stream::<MinidumpLinuxCpuInfo>()
.unwrap_or_default();
let _linux_environ = dump.get_stream::<MinidumpLinuxEnviron>().ok();
let _linux_proc_status = dump.get_stream::<MinidumpLinuxProcStatus>().ok();
// Extract everything we care about from linux streams here.
// We don't eagerly process them in the minidump crate because there's just
// tons of random information in there and it's not obvious what anyone
// would care about. So just providing an iterator and letting minidump-processor
// pull out the things it cares about is simple and effective.
let mut cpu_microcode_version = None;
for (key, val) in linux_cpu_info.iter() {
if key.as_bytes() == b"microcode" {
cpu_microcode_version = val
.to_str()
.ok()
.and_then(|val| val.strip_prefix("0x"))
.and_then(|val| u64::from_str_radix(val, 16).ok());
break;
}
}
let linux_standard_base = linux_standard_base.map(|linux_standard_base| {
let mut lsb = LinuxStandardBase::default();
for (key, val) in linux_standard_base.iter() {
match key.as_bytes() {
b"DISTRIB_ID" | b"ID" => lsb.id = val.to_string_lossy().into_owned(),
b"DISTRIB_RELEASE" | b"VERSION_ID" => {
lsb.release = val.to_string_lossy().into_owned()
}
b"DISTRIB_CODENAME" | b"VERSION_CODENAME" => {
lsb.codename = val.to_string_lossy().into_owned()
}
b"DISTRIB_DESCRIPTION" | b"PRETTY_NAME" => {
lsb.description = val.to_string_lossy().into_owned()
}
_ => {}
}
}
lsb
});
let cpu_info = dump_system_info
.cpu_info()
.map(|string| string.into_owned());
let system_info = SystemInfo {
os: dump_system_info.os,
os_version: Some(os_version),
os_build,
cpu: dump_system_info.cpu,
cpu_info,
cpu_microcode_version,
cpu_count: dump_system_info.raw.number_of_processors as usize,
};
let mac_crash_info = dump
.get_stream::<MinidumpMacCrashInfo>()
.ok()
.map(|info| info.raw);
let misc_info = dump.get_stream::<MinidumpMiscInfo>().ok();
// Process create time is optional.
let (process_id, process_create_time) = if let Some(misc_info) = misc_info.as_ref() {
(
misc_info.raw.process_id().cloned(),
misc_info.process_create_time(),
)
} else {
(None, None)
};
// If Breakpad info exists in dump, get dump and requesting thread ids.
let breakpad_info = dump.get_stream::<MinidumpBreakpadInfo>();
let (dump_thread_id, requesting_thread_id) = if let Ok(info) = breakpad_info {
(info.dump_thread_id, info.requesting_thread_id)
} else {
(None, None)
};
// Get exception info if it exists.
let exception_stream = dump.get_stream::<MinidumpException>().ok();
let exception_ref = exception_stream.as_ref();
let (crash_reason, crash_address, crashing_thread_id) = if let Some(exception) = exception_ref {
(
Some(exception.get_crash_reason(system_info.os, system_info.cpu)),
Some(exception.get_crash_address(system_info.os, system_info.cpu)),
Some(exception.get_crashing_thread_id()),
)
} else {
(None, None, None)
};
let exception_context =
exception_ref.and_then(|e| e.context(&dump_system_info, misc_info.as_ref()));
// Get assertion
let assertion = None;
let modules = match dump.get_stream::<MinidumpModuleList>() {
Ok(module_list) => module_list,
// Just give an empty list, simplifies things.
Err(_) => MinidumpModuleList::new(),
};
let unloaded_modules = match dump.get_stream::<MinidumpUnloadedModuleList>() {
Ok(module_list) => module_list,
// Just give an empty list, simplifies things.
Err(_) => MinidumpUnloadedModuleList::new(),
};
let memory_list = dump.get_stream::<MinidumpMemoryList>().unwrap_or_default();
let memory_info_list = dump.get_stream::<MinidumpMemoryInfoList>().ok();
let linux_maps = dump.get_stream::<MinidumpLinuxMaps>().ok();
let _memory_info = UnifiedMemoryInfoList::new(memory_info_list, linux_maps).unwrap_or_default();
// Get the evil JSON file (thread names and module certificates)
let evil = options
.evil_json
.and_then(evil::handle_evil)
.unwrap_or_default();
let mut requesting_thread = None;
let threads = thread_list
.threads
.iter()
.enumerate()
.map(|(i, thread)| {
let id = thread.raw.thread_id;
// If this is the thread that wrote the dump, skip processing it.
if dump_thread_id == Some(id) {
return CallStack::with_info(id, CallStackInfo::DumpThreadSkipped);
}
let thread_context = thread.context(&dump_system_info, misc_info.as_ref());
// If this thread requested the dump then try to use the exception
// context if it exists. (prefer the exception stream's thread id over
// the breakpad info stream's thread id.)
let context = if crashing_thread_id.or(requesting_thread_id) == Some(id) {
requesting_thread = Some(i);
exception_context.as_deref().or(thread_context.as_deref())
} else {
thread_context.as_deref()
};
let name = thread_names
.get_name(thread.raw.thread_id)
.map(|cow| cow.into_owned())
.or_else(|| evil.thread_names.get(&thread.raw.thread_id).cloned());
let (info, frames) = if let Some(context) = context {
let ctx = context.clone();
(
CallStackInfo::Ok,
vec![StackFrame::from_context(ctx, FrameTrust::Context)],
)
} else {
(CallStackInfo::MissingContext, vec![])
};
CallStack {
frames,
info,
thread_id: id,
thread_name: name,
last_error_value: thread.last_error(system_info.cpu, &memory_list),
}
})
.collect();
// Collect up info on unimplemented/unknown modules
let unknown_streams = dump.unknown_streams().collect();
let unimplemented_streams = dump.unimplemented_streams().collect();
// Get symbol stats from the symbolizer
let symbol_stats = symbol_provider.stats();
let mut state = ProcessState {
process_id,
time: SystemTime::UNIX_EPOCH + Duration::from_secs(dump.header.time_date_stamp as u64),
process_create_time,
cert_info: evil.certs,
crash_reason,
crash_address,
assertion,
requesting_thread,
system_info,
linux_standard_base,
mac_crash_info,
threads,
modules,
unloaded_modules,
unknown_streams,
unimplemented_streams,
symbol_stats,
};
// Report the unwalked result
if let Some(reporter) = options.stat_reporter {
reporter.add_unwalked_result(&state);
}
{
let memory_list = &memory_list;
let modules = &state.modules;
let system_info = &state.system_info;
let unloaded_modules = &state.unloaded_modules;
let options = &options;
futures_util::future::join_all(
state
.threads
.iter_mut()
.zip(thread_list.threads.iter())
.enumerate()
.map(|(i, (stack, thread))| async move {
let mut stack_memory = thread.stack_memory(memory_list);
// Always chose the memory region that is referenced by the context,
// as the `exception_context` may refer to a different memory region than
// the `thread_context`, which in turn would fail to stack walk.
let stack_ptr = stack
.frames
.get(0)
.map(|ctx_frame| ctx_frame.context.get_stack_pointer());
if let Some(stack_ptr) = stack_ptr {
let contains_stack_ptr = stack_memory
.as_ref()
.and_then(|memory| memory.get_memory_at_address::<u64>(stack_ptr))
.is_some();
if !contains_stack_ptr {
stack_memory = memory_list
.memory_at_address(stack_ptr)
.map(Cow::Borrowed)
.or(stack_memory);
}
}
stackwalker::walk_stack(
i,
options,
stack,
stack_memory.as_deref(),
modules,
system_info,
symbol_provider,
)
.await;
for frame in &mut stack.frames {
// If the frame doesn't have a loaded module, try to find an unloaded module
// that overlaps with its address range. The may be multiple, so record all
// of them and the offsets this frame has in them.
if frame.module.is_none() {
let mut offsets = BTreeMap::new();
for unloaded in unloaded_modules.modules_at_address(frame.instruction) {
let offset = frame.instruction - unloaded.raw.base_of_image;
offsets
.entry(unloaded.name.clone())
.or_insert_with(BTreeSet::new)
.insert(offset);
}
frame.unloaded_modules = offsets;
}
}
if options.recover_function_args {
arg_recovery::fill_arguments(stack, stack_memory.as_deref());
}
// Report the unwalked result
if let Some(reporter) = options.stat_reporter {
reporter.inc_processed_threads();
}
stack
}),
)
.await
};
let symbol_stats = symbol_provider.stats();
state.symbol_stats = symbol_stats;
Ok(state)
}