Steven Wu 1b8db068ed
[PrefixMap] Teach lldb to auto-load compilation-prefix-map.json (#187145)
Add a LoadCompilationPrefixMap() helper in SymbolFile::FindPlugin that
walks up from the symbol file's directory looking for a
compilation-prefix-map.json file. When found, each key→value entry is
applied to the module's source path mapping list, allowing LLDB to
resolve source file paths that were rewritten by -fdebug-prefix-map at
build time without requiring manual `settings set target.source-map`.

The JSON file format maps fake paths (as written into debug info) back
to their real on-disk counterparts:
  { "/fake/srcdir": "/real/srcdir" }

Directory results are cached so the filesystem is walked at most once
per unique directory across all modules loaded in a session.

Also apply the module's source path remappings in
SymbolFileDWARFDebugMap::ParseCompileUnitAtIndex when constructing
compile units from N_SO stabs. This mirrors what MakeAbsoluteAndRemap
does for the dSYM case so that fake paths baked into the debug map are
transparently resolved to real paths.

rdar://84824567

Assisted-By: Claude
2026-03-18 09:11:28 -07:00

44 lines
1.4 KiB
Python

# TestCompilationPrefixMap.py
#
# Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
# See https://llvm.org/LICENSE.txt for license information.
# SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
#
"""
Test that LLDB auto-loads compilation-prefix-map.json to resolve remapped
source paths without requiring manual `settings set target.source-map`.
"""
import os
import lldb
from lldbsuite.test.decorators import *
from lldbsuite.test.lldbtest import *
import lldbsuite.test.lldbutil as lldbutil
class TestCompilationPrefixMap(TestBase):
@skipIfWindows
def test_compilation_prefix_map(self):
"""
Build a binary with -fdebug-prefix-map remapping the source directory
to /fake/srcdir, place compilation-prefix-map.json next to the binary
mapping /fake/srcdir back to the real source directory, and verify that
LLDB resolves a source-line breakpoint without any manual source-map
configuration.
"""
self.build()
src_dir = self.getSourceDir()
log = self.getBuildArtifact("symbol.log")
self.runCmd('log enable lldb symbol -f "%s"' % log)
source_spec = lldb.SBFileSpec(os.path.join(src_dir, "main.c"))
lldbutil.run_to_source_breakpoint(self, "return x", source_spec)
self.filecheck_log(log, __file__)
# CHECK: found compilation-prefix-map.json
# CHECK: applying prefix map: '/fake/srcdir'