Skip to content

Handle cross-file debug locations #234

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
nihalpasham merged 2 commits into from
Jun 16, 2026
Merged

Handle cross-file debug locations #234

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2ba23f9
Handle cross-file debug locations
nihalpasham Jun 16, 2026
bc30e23
Document device debug info modes
nihalpasham Jun 16, 2026
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
121 changes: 94 additions & 27 deletions crates/llvm-export/src/export/debug.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,16 +148,9 @@ impl<'a> ModuleExportState<'a> {
return None;
}

let (path, pos) = self.source_position_from_location(loc)?;
if self
.debug_subprogram_files
.get(&scope)
.is_some_and(|scope_path| scope_path.as_path() != path)
{
return None;
}

let (path, pos) = self.local_variable_position_from_location(loc)?;
let file_id = self.ensure_debug_file(&path);
let variable_scope = self.debug_scope_for_file(scope, &path)?;
let type_id = self.ensure_debug_type(&info.ty);
let location_id = self.debug_location_for_scope(scope, loc)?;
let name = escape_debug_string(&info.name);
Expand All @@ -170,7 +163,7 @@ impl<'a> ModuleExportState<'a> {
self.debug_nodes.push((
id,
format!(
"!DILocalVariable(name: \"{name}\", {arg}scope: !{scope}, file: !{file_id}, \
"!DILocalVariable(name: \"{name}\", {arg}scope: !{variable_scope}, file: !{file_id}, \
line: {}, type: !{type_id})",
pos.line
),
Expand Down Expand Up @@ -275,50 +268,124 @@ impl<'a> ModuleExportState<'a> {
return None;
}

match loc {
Location::CallSite { callee, caller } => {
return self.debug_call_site_location_for_scope(scope, callee, caller);
}
Location::Named { child_loc, .. } => {
return self.debug_location_for_scope(scope, child_loc);
}
Location::Fused { locations, .. } => {
return locations
.iter()
.find_map(|loc| self.debug_location_for_scope(scope, loc));
}
Location::SrcPos { .. } | Location::Unknown => {}
}

let (path, pos) = self.source_position_from_location(loc)?;
if self
.debug_subprogram_files
.get(&scope)
.is_some_and(|scope_path| scope_path.as_path() != path)
{
return None;
let location_scope = self.debug_scope_for_file(scope, &path)?;

self.ensure_debug_location(location_scope, pos, None)
}

fn debug_call_site_location_for_scope(
&mut self,
scope: usize,
callee: &Location,
caller: &Location,
) -> Option<usize> {
let caller_location = self
.source_position_from_location(caller)
.and_then(|(path, pos)| {
let caller_scope = self.debug_scope_for_file(scope, &path)?;
self.ensure_debug_location(caller_scope, pos, None)
});

let Some((callee_path, callee_pos)) = self.source_position_from_location(callee) else {
return caller_location;
};
let callee_scope = self.debug_scope_for_file(scope, &callee_path)?;

self.ensure_debug_location(callee_scope, callee_pos, caller_location)
}

fn debug_scope_for_file(&mut self, scope: usize, path: &Path) -> Option<usize> {
let scope_path = self.debug_subprogram_files.get(&scope)?;
if scope_path.as_path() == path {
return Some(scope);
}

let key = (scope, pos.line, pos.column);
if let Some(id) = self.debug_locations.get(&key).copied() {
let key = (scope, path.to_path_buf());
if let Some(id) = self.debug_file_scopes.get(&key).copied() {
return Some(id);
}

let file_id = self.ensure_debug_file(path);
let id = self.alloc_metadata_id();
self.debug_nodes.push((
id,
format!(
"!DILocation(line: {}, column: {}, scope: !{})",
pos.line, pos.column, scope
),
format!("!DILexicalBlockFile(scope: !{scope}, file: !{file_id}, discriminator: 0)"),
));
self.debug_locations.insert(key, id);
self.debug_file_scopes.insert(key, id);

Some(id)
}

fn debug_fallback_location_for_scope(&mut self, scope: usize) -> Option<usize> {
let (line, column) = self.debug_subprogram_fallbacks.get(&scope).copied()?;
let key = (scope, line, column);
fn ensure_debug_location(
&mut self,
scope: usize,
pos: SourcePosition,
inlined_at: Option<usize>,
) -> Option<usize> {
if pos.line <= 0 || pos.column <= 0 {
return None;
}

let key = (scope, pos.line, pos.column, inlined_at);
if let Some(id) = self.debug_locations.get(&key).copied() {
return Some(id);
}

let id = self.alloc_metadata_id();
let inlined_at = inlined_at
.map(|location_id| format!(", inlinedAt: !{location_id}"))
.unwrap_or_default();
self.debug_nodes.push((
id,
format!("!DILocation(line: {line}, column: {column}, scope: !{scope})"),
format!(
"!DILocation(line: {}, column: {}, scope: !{}{inlined_at})",
pos.line, pos.column, scope
),
));
self.debug_locations.insert(key, id);

Some(id)
}

fn debug_fallback_location_for_scope(&mut self, scope: usize) -> Option<usize> {
let (line, column) = self.debug_subprogram_fallbacks.get(&scope).copied()?;
self.ensure_debug_location(scope, SourcePosition { line, column }, None)
}

fn local_variable_position_from_location(
&self,
loc: &Location,
) -> Option<(PathBuf, SourcePosition)> {
match loc {
Location::CallSite { callee, caller } => self
.source_position_from_location(callee)
.or_else(|| self.source_position_from_location(caller)),
Location::Named { child_loc, .. } => {
self.local_variable_position_from_location(child_loc)
}
Location::Fused { locations, .. } => locations
.iter()
.find_map(|loc| self.local_variable_position_from_location(loc)),
Location::SrcPos { .. } | Location::Unknown => self.source_position_from_location(loc),
}
}

fn source_position_from_location(&self, loc: &Location) -> Option<(PathBuf, SourcePosition)> {
match loc {
Location::SrcPos {
Expand Down
9 changes: 6 additions & 3 deletions crates/llvm-export/src/export/state.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,12 +66,14 @@ pub(super) struct ModuleExportState<'a> {
pub(super) debug_files: HashMap<PathBuf, usize>,
/// Shared empty function type used by all line-table-only subprograms.
pub(super) debug_subroutine_type: Option<usize>,
/// `DISubprogram` file paths, used to avoid attaching locations to the wrong scope.
/// `DISubprogram` file paths, used to create file-correct nested scopes.
pub(super) debug_subprogram_files: HashMap<usize, PathBuf>,
/// Fallback line/column for calls that LLVM requires to have a location.
pub(super) debug_subprogram_fallbacks: HashMap<usize, (i32, i32)>,
/// `DILocation` nodes keyed by `(scope, line, column)`.
pub(super) debug_locations: HashMap<(usize, i32, i32), usize>,
/// `DILexicalBlockFile` nodes keyed by `(parent scope, file path)`.
pub(super) debug_file_scopes: HashMap<(usize, PathBuf), usize>,
/// `DILocation` nodes keyed by `(scope, line, column, inlined-at location)`.
pub(super) debug_locations: HashMap<(usize, i32, i32, Option<usize>), usize>,
/// `DIType` nodes keyed by the simple debug type they describe.
pub(super) debug_types: HashMap<DebugLocalTypeKind, usize>,
/// Numbered debug metadata definitions, in allocation order.
Expand Down Expand Up @@ -103,6 +105,7 @@ impl<'a> ModuleExportState<'a> {
debug_subroutine_type: None,
debug_subprogram_files: HashMap::new(),
debug_subprogram_fallbacks: HashMap::new(),
debug_file_scopes: HashMap::new(),
debug_locations: HashMap::new(),
debug_types: HashMap::new(),
debug_nodes: Vec::new(),
Expand Down
Loading
Loading