Skip to content

Lazily evaluate debug info #4269

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 6, 2025
Merged

Lazily evaluate debug info #4269

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 10 additions & 8 deletions kani-compiler/src/codegen_cprover_gotoc/compiler_interface.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,14 +151,14 @@ impl GotocCodegenBackend {
MonoItem::Fn(instance) => {
gcx.call_with_panic_debug_info(
|ctx| ctx.declare_function(instance),
format!("declare_function: {}", instance.name()),
move || format!("declare_function: {}", instance.name()),
instance.def,
);
}
MonoItem::Static(def) => {
gcx.call_with_panic_debug_info(
|ctx| ctx.declare_static(def),
format!("declare_static: {}", def.name()),
move || format!("declare_static: {}", def.name()),
def,
);
}
Expand All @@ -172,18 +172,20 @@ impl GotocCodegenBackend {
MonoItem::Fn(instance) => {
gcx.call_with_panic_debug_info(
|ctx| ctx.codegen_function(instance),
format!(
"codegen_function: {}\n{}",
instance.name(),
instance.mangled_name()
),
move || {
format!(
"codegen_function: {}\n{}",
instance.name(),
instance.mangled_name()
)
},
instance.def,
);
}
MonoItem::Static(def) => {
gcx.call_with_panic_debug_info(
|ctx| ctx.codegen_static(def),
format!("codegen_static: {}", def.name()),
move || format!("codegen_static: {}", def.name()),
def,
);
}
Expand Down
22 changes: 15 additions & 7 deletions kani-compiler/src/codegen_cprover_gotoc/utils/debug.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@ use tracing::debug;
// Use a thread-local global variable to track the current codegen item for debugging.
// If Kani panics during codegen, we can grab this item to include the problematic
// codegen item in the panic trace.
thread_local!(static CURRENT_CODEGEN_ITEM: RefCell<(Option<String>, Option<Location>)> = const { RefCell::new((None, None)) });
type FindCurrentItemFn = Box<dyn Fn() -> String>;
thread_local!(static CURRENT_CODEGEN_ITEM: RefCell<(Option<FindCurrentItemFn>, Option<Location>)> = const { RefCell::new((None, None)) });

pub fn init() {
// Install panic hook
Expand All @@ -36,9 +37,9 @@ static DEFAULT_HOOK: LazyLock<Box<dyn Fn(&panic::PanicHookInfo<'_>) + Sync + Sen

// Print the current function if available
CURRENT_CODEGEN_ITEM.with(|cell| {
let t = cell.borrow().clone();
if let Some(current_item) = t.0 {
eprintln!("[Kani] current codegen item: {current_item}");
let t = cell.borrow();
if let Some(get_current_item) = &t.0 {
eprintln!("[Kani] current codegen item: {}", get_current_item());
} else {
eprintln!("[Kani] no current codegen item.");
}
Expand All @@ -55,14 +56,21 @@ static DEFAULT_HOOK: LazyLock<Box<dyn Fn(&panic::PanicHookInfo<'_>) + Sync + Sen
impl<'tcx> GotocCtx<'tcx> {
// Calls the closure while updating the tracked global variable marking the
// codegen item for panic debugging.
pub fn call_with_panic_debug_info<D: CrateDef, F: FnOnce(&mut GotocCtx<'tcx>)>(
pub fn call_with_panic_debug_info<
D: CrateDef,
F: FnOnce(&mut GotocCtx<'tcx>),
S: Fn() -> String + 'static,
>(
&mut self,
call: F,
panic_debug: String,
debug_str_generator: S,
def: D,
) {
CURRENT_CODEGEN_ITEM.with(|odb_cell| {
odb_cell.replace((Some(panic_debug), Some(self.codegen_span_stable(def.span()))));
odb_cell.replace((
Some(Box::new(debug_str_generator)),
Some(self.codegen_span_stable(def.span())),
));
call(self);
odb_cell.replace((None, None));
});
Expand Down
Loading