This is an archive of the discontinued LLVM Phabricator instance.

Differential D48882

[PDB] Add PDBSourcePath flag to support absolutize source file path
ClosedPublic

Authored by takuto.ikuta on Jul 3 2018, 7:47 AM.

Details

Reviewers
zturner
thakis
rnk
ruiu
inglorion
Summary

This patch changes relative path for source files in obj files to absolute path in PDB when linking with added flag.

I will make obj file generated by clang-cl independent from build directory for chromium build. But I don't want to confuse visual studio debugger or require additional configuration. To attain this goal, I added flag to convert relative source file path in obj to absolute path when emitting PDB.

By removing absolute path from obj files, we can share build cache between chromium developers even when they are doing debug build.
That will make build time faster.

More context:
https://bugs.chromium.org/p/chromium/issues/detail?id=712796
https://groups.google.com/a/chromium.org/forum/#!topic/chromium-dev/5HXSVX-7fPc

Diff Detail

Event Timeline

takuto.ikuta created this revision.Jul 3 2018, 7:47 AM
takuto.ikuta edited the summary of this revision. (Show Details)Jul 3 2018, 7:50 AM
takuto.ikuta retitled this revision from Change relative source file path to absolute path in lld to Change relative source file path in obj files to absolute path in PDB.Jul 3 2018, 8:29 AM
takuto.ikuta edited the summary of this revision. (Show Details)
zturner added inline comments.Jul 3 2018, 5:09 PM
lld/COFF/PDB.cpp
935–941

I don't think it's correct to force Windows path style here. I think we should just use the default native style.

If you are doing a cross-compilation, then the code here will emit a path into the object file that doesn't make any sense or correspond to the actual machine that the file was generated on, which seems wrong.

This doesn't matter too much for MSVC since you will never run it on Linux anyway, but one could imagine that someday some other debugger (LLDB, GDB, etc) will be taught how to natively parse PDB files, and maybe on Linux it would be able to debug code running under WINE while the debug info and sources are on a native Linux partition. So it doesn't seem correct to lock PDBs to a Windows host at the file format level.

takuto.ikuta updated this revision to Diff 154024.Jul 3 2018, 5:17 PM

Use native path style

takuto.ikuta added inline comments.Jul 3 2018, 5:19 PM
lld/COFF/PDB.cpp
935–941

I see. But I just tried to follow the code in L814.

thakis added a reviewer: ruiu.Jul 6 2018, 4:45 AM
thakis added a comment.Jul 6 2018, 4:47 AM

Thanks for the patch! I wonder if this should be behind some flag (/makePDBPathsAbsolute or something) and not be done by default. If we have a flag, the flag could also optionally provide a different prefix than pwd (/makePDBPathsAbsolute:c:\src), which might be useful for cross builds. I'd like to hear ruiu's thoughts on this.

This shouldn't have a measurable impact on link time, right?

takuto.ikuta updated this revision to Diff 154535.Jul 8 2018, 8:08 PM

Use given path to normalize path

takuto.ikuta added a comment.Jul 8 2018, 9:35 PM

Thank you for taking a look.

In D48882#1154227, @thakis wrote:

Thanks for the patch! I wonder if this should be behind some flag (/makePDBPathsAbsolute or something) and not be done by default. If we have a flag, the flag could also optionally provide a different prefix than pwd (/makePDBPathsAbsolute:c:\src), which might be useful for cross builds. I'd like to hear ruiu's thoughts on this.

It makes sense to me. Added a flag.

This shouldn't have a measurable impact on link time, right?

I confirmed this does not show visible performance difference.

takuto.ikuta retitled this revision from Change relative source file path in obj files to absolute path in PDB to [PDB] Add makePDBPathsAbsolute flag to support absolutize source file path.Jul 11 2018, 2:48 AM
takuto.ikuta edited the summary of this revision. (Show Details)
takuto.ikuta added a comment.Jul 11 2018, 2:50 AM

Ping? Can I go this way?

zturner accepted this revision.Jul 11 2018, 11:39 AM
This revision is now accepted and ready to land.Jul 11 2018, 11:39 AM
takuto.ikuta added a reviewer: inglorion.Jul 11 2018, 11:41 PM
takuto.ikuta added a comment.Jul 11 2018, 11:43 PM

If some of you have concern about this, please leave a comment.

I'll ask commit right and merge this if I could be a committer.

thakis accepted this revision.Jul 12 2018, 1:19 PM

Looks good to me, thanks!

ruiu added inline comments.Jul 12 2018, 1:42 PM
lld/COFF/Config.h
105–107 ↗(On Diff #154535)

Sort.

lld/COFF/PDB.cpp
935–941

If we should use the native pathname rather than Windows one, then you probably should do either is_absolute(Filename, Sytle::windows) or is_absolute(Filename, Style::posix) but not both, since X:/foo is a relative path on Unix.

lld/test/COFF/pdb-relative-source-lines.test
49

Don't you need only the lines that contain pathname? I'd remove all the other lines from the file, so that we don't have to update them when some unrelated change is committed.

takuto.ikuta updated this revision to Diff 155313.Jul 12 2018, 7:32 PM
takuto.ikuta marked an inline comment as done.

Shrink test data

takuto.ikuta marked 3 inline comments as done.Jul 12 2018, 7:36 PM
takuto.ikuta added inline comments.
lld/test/COFF/pdb-relative-source-lines.test
49

Shrinked, but let me keep hardly be changed lines as anchor.

ruiu added inline comments.Jul 13 2018, 7:18 AM
lld/COFF/Options.td
144 ↗(On Diff #155313)

Help text shouldn't end with a period. Please always look around and follow the local convention. That's I think important.

Is this considered an internal option, or this is intended to be used directly by users? If it is intended to be used widely, the option name "/makepdbpathabsolute" seems a bit weird to me. There's no existing option name like that. Perhaps something like "/pdbpath:absolute" is better.

takuto.ikuta updated this revision to Diff 155407.Jul 13 2018, 9:19 AM
takuto.ikuta marked an inline comment as done.

pdbsourcepath

takuto.ikuta retitled this revision from [PDB] Add makePDBPathsAbsolute flag to support absolutize source file path to [PDB] Add PDBSourcePath flag to support absolutize source file path.Jul 13 2018, 9:20 AM
takuto.ikuta added inline comments.Jul 13 2018, 9:30 AM
lld/COFF/Options.td
144 ↗(On Diff #155313)

Basically, I don't expect this option will be used by user widely, because this option has no meaning for obj files without clang-cl's internal -fdebug-compilation-dir option.

But path normalization feature will be useful for debuggable executable from reproducible obj files. And some other users may use this. So I changed the flag name.

ruiu added a comment.Jul 13 2018, 10:18 AM

Is Ukai-san OK with this change?

lld/COFF/Options.td
143–144 ↗(On Diff #155407)

Other options seems to be sorted, so please sort alphabetically. It is nitpicky but consistency matters, so please spend a bit more time to read code around the location you are changing so that your new code doesn't look too different. I think that's important and actually saves both your and my time.

takuto.ikuta updated this revision to Diff 155805.Jul 16 2018, 9:18 PM

sort

takuto.ikuta marked an inline comment as done.Jul 16 2018, 9:19 PM
In D48882#1161855, @ruiu wrote:

Is Ukai-san OK with this change?

Yes, I got agreement on this way from him.

takuto.ikuta closed this revision.Jul 18 2018, 10:46 PM

Landed as
https://reviews.llvm.org/rLLD337439

Revision Contents

PathSize
lld/
COFF/
8 lines
test/
COFF/
Inputs/
401 lines
190 lines
117 lines

Diff 153914

lld/COFF/PDB.cpp

Show First 20 Lines • Show All 926 Lines • ▼ Show 20 Linesvoid PDBLinker::addObjFile(ObjFile *File) {
} }
// Make a new file checksum table that refers to offsets in the PDB-wide // Make a new file checksum table that refers to offsets in the PDB-wide
// string table. Generally the string table subsection appears after the // string table. Generally the string table subsection appears after the
// checksum table, so we have to do this after looping over all the // checksum table, so we have to do this after looping over all the
// subsections. // subsections.
auto NewChecksums = make_unique<DebugChecksumsSubsection>(PDBStrTab); auto NewChecksums = make_unique<DebugChecksumsSubsection>(PDBStrTab);
for (FileChecksumEntry &FC : Checksums) { for (FileChecksumEntry &FC : Checksums) {
StringRef FileName = ExitOnErr(CVStrTab.getString(FC.FileNameOffset)); SmallString<128> FileName = ExitOnErr(CVStrTab.getString(FC.FileNameOffset));
if (!sys::path::is_absolute(FileName, sys::path::Style::windows)) {
sys::fs::make_absolute(FileName);
sys::path::native(FileName, sys::path::Style::windows);
sys::path::remove_dots(FileName, /*remove_dot_dots=*/true,
sys::path::Style::windows);
}
zturnerUnsubmitted
Done
ReplyInline Actions

I don't think it's correct to force Windows path style here. I think we should just use the default native style.

If you are doing a cross-compilation, then the code here will emit a path into the object file that doesn't make any sense or correspond to the actual machine that the file was generated on, which seems wrong.

This doesn't matter too much for MSVC since you will never run it on Linux anyway, but one could imagine that someday some other debugger (LLDB, GDB, etc) will be taught how to natively parse PDB files, and maybe on Linux it would be able to debug code running under WINE while the debug info and sources are on a native Linux partition. So it doesn't seem correct to lock PDBs to a Windows host at the file format level.

zturner: I don't think it's correct to force Windows path style here. I think we should just use the…
takuto.ikutaAuthorUnsubmitted
Not Done
ReplyInline Actions

I see. But I just tried to follow the code in L814.

takuto.ikuta: I see. But I just tried to follow the code in L814.
ruiuUnsubmitted
Done
ReplyInline Actions

If we should use the native pathname rather than Windows one, then you probably should do either is_absolute(Filename, Sytle::windows) or is_absolute(Filename, Style::posix) but not both, since X:/foo is a relative path on Unix.

ruiu: If we should use the native pathname rather than Windows one, then you probably should do…
ExitOnErr(Builder.getDbiBuilder().addModuleSourceFile(*File->ModuleDBI, ExitOnErr(Builder.getDbiBuilder().addModuleSourceFile(*File->ModuleDBI,
FileName)); FileName));
NewChecksums->addChecksum(FileName, FC.Kind, FC.Checksum); NewChecksums->addChecksum(FileName, FC.Kind, FC.Checksum);
} }
File->ModuleDBI->addDebugSubsection(std::move(NewChecksums)); File->ModuleDBI->addDebugSubsection(std::move(NewChecksums));
} }
static PublicSym32 createPublic(Defined *Def) { static PublicSym32 createPublic(Defined *Def) {
▲ Show 20 Lines • Show All 383 Lines • Show Last 20 Lines

lld/test/COFF/Inputs/pdb_lines_1_relative.yaml

  • This file was added.
--- !COFF
header:
Machine: IMAGE_FILE_MACHINE_AMD64
Characteristics: [ ]
sections:
- Name: .text
Characteristics: [ IMAGE_SCN_CNT_CODE, IMAGE_SCN_MEM_EXECUTE, IMAGE_SCN_MEM_READ ]
Alignment: 16
SectionData: 4883EC28C744242400000000E800000000B82A0000004883C428C3
Relocations:
- VirtualAddress: 13
SymbolName: foo
Type: IMAGE_REL_AMD64_REL32
- Name: .data
Characteristics: [ IMAGE_SCN_CNT_INITIALIZED_DATA, IMAGE_SCN_MEM_READ, IMAGE_SCN_MEM_WRITE ]
Alignment: 4
SectionData: ''
- Name: .bss
Characteristics: [ IMAGE_SCN_CNT_UNINITIALIZED_DATA, IMAGE_SCN_MEM_READ, IMAGE_SCN_MEM_WRITE ]
Alignment: 4
SectionData: ''
- Name: .xdata
Characteristics: [ IMAGE_SCN_CNT_INITIALIZED_DATA, IMAGE_SCN_MEM_READ ]
Alignment: 4
SectionData: '0104010004420000'
- Name: .text
Characteristics: [ IMAGE_SCN_CNT_CODE, IMAGE_SCN_LNK_COMDAT, IMAGE_SCN_MEM_EXECUTE, IMAGE_SCN_MEM_READ ]
Alignment: 16
SectionData: 4883EC28E800000000904883C428C3
Relocations:
- VirtualAddress: 5
SymbolName: bar
Type: IMAGE_REL_AMD64_REL32
- Name: .drectve
Characteristics: [ IMAGE_SCN_LNK_INFO, IMAGE_SCN_LNK_REMOVE ]
Alignment: 1
SectionData: 202F44454641554C544C49423A6C6962636D742E6C6962202F44454641554C544C49423A6F6C646E616D65732E6C6962
- Name: '.debug$S'
Characteristics: [ IMAGE_SCN_CNT_INITIALIZED_DATA, IMAGE_SCN_MEM_DISCARDABLE, IMAGE_SCN_MEM_READ ]
Alignment: 4
SectionData: 04000000F10000002F0000002D003C1100000000D0000700000000000000581B000000000000636C616E672076657273696F6E20372E302E30200000F1000000300000002A0047110000000000000000000000001B000000000000000000000002100000000000000000006D61696E0002004F11F20000003000000000000000000000001B00000000000000030000002400000000000000020000000C000000030000001100000004000000F400000030000000010000001001EA6429BCE282CCF3F0E3CD93B216EB410000110000001001061EB73ABB642532857A4F1D9CBAC3230000F30000001C000000002E5C7064625F6C696E65735F312E63002E5C666F6F2E6800000000
Subsections:
- !Symbols
Records:
- Kind: S_COMPILE3
Compile3Sym:
Flags: [ ]
Machine: X64
FrontendMajor: 7
FrontendMinor: 0
FrontendBuild: 0
FrontendQFE: 0
BackendMajor: 7000
BackendMinor: 0
BackendBuild: 0
BackendQFE: 0
Version: 'clang version 7.0.0 '
- !Symbols
Records:
- Kind: S_GPROC32_ID
ProcSym:
CodeSize: 27
DbgStart: 0
DbgEnd: 0
FunctionType: 4098
Flags: [ ]
DisplayName: main
- Kind: S_PROC_ID_END
ScopeEndSym:
- !Lines
CodeSize: 27
Flags: [ ]
RelocOffset: 0
RelocSegment: 0
Blocks:
- FileName: '.\pdb_lines_1.c'
Lines:
- Offset: 0
LineStart: 2
IsStatement: false
EndDelta: 0
- Offset: 12
LineStart: 3
IsStatement: false
EndDelta: 0
- Offset: 17
LineStart: 4
IsStatement: false
EndDelta: 0
Columns:
- !FileChecksums
Checksums:
- FileName: '.\pdb_lines_1.c'
Kind: MD5
Checksum: EA6429BCE282CCF3F0E3CD93B216EB41
- FileName: '.\foo.h'
Kind: MD5
Checksum: 061EB73ABB642532857A4F1D9CBAC323
- !StringTable
Strings:
- '.\pdb_lines_1.c'
- '.\foo.h'
- ''
- ''
- ''
Relocations:
- VirtualAddress: 100
SymbolName: main
Type: IMAGE_REL_AMD64_SECREL
- VirtualAddress: 104
SymbolName: main
Type: IMAGE_REL_AMD64_SECTION
- VirtualAddress: 124
SymbolName: main
Type: IMAGE_REL_AMD64_SECREL
- VirtualAddress: 128
SymbolName: main
Type: IMAGE_REL_AMD64_SECTION
- Name: '.debug$T'
Characteristics: [ IMAGE_SCN_CNT_INITIALIZED_DATA, IMAGE_SCN_MEM_DISCARDABLE, IMAGE_SCN_MEM_READ ]
Alignment: 4
SectionData: 0400000006000112000000000E0008107400000000000000001000001200011600000000011000006D61696E00F3F2F10E0008100300000000000000001000000E0001160000000003100000666F6F00
Types:
- Kind: LF_ARGLIST
ArgList:
ArgIndices: [ ]
- Kind: LF_PROCEDURE
Procedure:
ReturnType: 116
CallConv: NearC
Options: [ None ]
ParameterCount: 0
ArgumentList: 4096
- Kind: LF_FUNC_ID
FuncId:
ParentScope: 0
FunctionType: 4097
Name: main
- Kind: LF_PROCEDURE
Procedure:
ReturnType: 3
CallConv: NearC
Options: [ None ]
ParameterCount: 0
ArgumentList: 4096
- Kind: LF_FUNC_ID
FuncId:
ParentScope: 0
FunctionType: 4099
Name: foo
- Name: .pdata
Characteristics: [ IMAGE_SCN_CNT_INITIALIZED_DATA, IMAGE_SCN_MEM_READ ]
Alignment: 4
SectionData: 000000001B00000000000000
Relocations:
- VirtualAddress: 0
SymbolName: main
Type: IMAGE_REL_AMD64_ADDR32NB
- VirtualAddress: 4
SymbolName: main
Type: IMAGE_REL_AMD64_ADDR32NB
- VirtualAddress: 8
SymbolName: .xdata
Type: IMAGE_REL_AMD64_ADDR32NB
- Name: .xdata
Characteristics: [ IMAGE_SCN_CNT_INITIALIZED_DATA, IMAGE_SCN_LNK_COMDAT, IMAGE_SCN_MEM_READ ]
Alignment: 4
SectionData: '0104010004420000'
- Name: '.debug$S'
Characteristics: [ IMAGE_SCN_CNT_INITIALIZED_DATA, IMAGE_SCN_LNK_COMDAT, IMAGE_SCN_MEM_DISCARDABLE, IMAGE_SCN_MEM_READ ]
Alignment: 4
SectionData: 04000000F10000002F000000290047110000000000000000000000000F00000000000000000000000410000000000000000000666F6F0002004F1100F20000003000000000000000000000000F000000180000000300000024000000000000000200000004000000030000000900000004000000
Subsections:
- !Symbols
Records:
- Kind: S_GPROC32_ID
ProcSym:
CodeSize: 15
DbgStart: 0
DbgEnd: 0
FunctionType: 4100
Flags: [ ]
DisplayName: foo
- Kind: S_PROC_ID_END
ScopeEndSym:
- !Lines
CodeSize: 15
Flags: [ ]
RelocOffset: 0
RelocSegment: 0
Blocks:
- FileName: '.\foo.h'
Lines:
- Offset: 0
LineStart: 2
IsStatement: false
EndDelta: 0
- Offset: 4
LineStart: 3
IsStatement: false
EndDelta: 0
- Offset: 9
LineStart: 4
IsStatement: false
EndDelta: 0
Columns:
Relocations:
- VirtualAddress: 44
SymbolName: foo
Type: IMAGE_REL_AMD64_SECREL
- VirtualAddress: 48
SymbolName: foo
Type: IMAGE_REL_AMD64_SECTION
- VirtualAddress: 68
SymbolName: foo
Type: IMAGE_REL_AMD64_SECREL
- VirtualAddress: 72
SymbolName: foo
Type: IMAGE_REL_AMD64_SECTION
- Name: .pdata
Characteristics: [ IMAGE_SCN_CNT_INITIALIZED_DATA, IMAGE_SCN_LNK_COMDAT, IMAGE_SCN_MEM_READ ]
Alignment: 4
SectionData: 000000000F00000000000000
Relocations:
- VirtualAddress: 0
SymbolName: foo
Type: IMAGE_REL_AMD64_ADDR32NB
- VirtualAddress: 4
SymbolName: foo
Type: IMAGE_REL_AMD64_ADDR32NB
- VirtualAddress: 8
SymbolName: .xdata
Type: IMAGE_REL_AMD64_ADDR32NB
symbols:
- Name: .text
Value: 0
SectionNumber: 1
SimpleType: IMAGE_SYM_TYPE_NULL
ComplexType: IMAGE_SYM_DTYPE_NULL
StorageClass: IMAGE_SYM_CLASS_STATIC
SectionDefinition:
Length: 27
NumberOfRelocations: 1
NumberOfLinenumbers: 0
CheckSum: 3051916600
Number: 1
- Name: .data
Value: 0
SectionNumber: 2
SimpleType: IMAGE_SYM_TYPE_NULL
ComplexType: IMAGE_SYM_DTYPE_NULL
StorageClass: IMAGE_SYM_CLASS_STATIC
SectionDefinition:
Length: 0
NumberOfRelocations: 0
NumberOfLinenumbers: 0
CheckSum: 0
Number: 2
- Name: .bss
Value: 0
SectionNumber: 3
SimpleType: IMAGE_SYM_TYPE_NULL
ComplexType: IMAGE_SYM_DTYPE_NULL
StorageClass: IMAGE_SYM_CLASS_STATIC
SectionDefinition:
Length: 0
NumberOfRelocations: 0
NumberOfLinenumbers: 0
CheckSum: 0
Number: 3
- Name: .xdata
Value: 0
SectionNumber: 4
SimpleType: IMAGE_SYM_TYPE_NULL
ComplexType: IMAGE_SYM_DTYPE_NULL
StorageClass: IMAGE_SYM_CLASS_STATIC
SectionDefinition:
Length: 8
NumberOfRelocations: 0
NumberOfLinenumbers: 0
CheckSum: 264583633
Number: 4
- Name: .text
Value: 0
SectionNumber: 5
SimpleType: IMAGE_SYM_TYPE_NULL
ComplexType: IMAGE_SYM_DTYPE_NULL
StorageClass: IMAGE_SYM_CLASS_STATIC
SectionDefinition:
Length: 15
NumberOfRelocations: 1
NumberOfLinenumbers: 0
CheckSum: 236440503
Number: 5
Selection: IMAGE_COMDAT_SELECT_ANY
- Name: foo
Value: 0
SectionNumber: 5
SimpleType: IMAGE_SYM_TYPE_NULL
ComplexType: IMAGE_SYM_DTYPE_FUNCTION
StorageClass: IMAGE_SYM_CLASS_EXTERNAL
- Name: .xdata
Value: 0
SectionNumber: 10
SimpleType: IMAGE_SYM_TYPE_NULL
ComplexType: IMAGE_SYM_DTYPE_NULL
StorageClass: IMAGE_SYM_CLASS_STATIC
SectionDefinition:
Length: 8
NumberOfRelocations: 0
NumberOfLinenumbers: 0
CheckSum: 264583633
Number: 5
Selection: IMAGE_COMDAT_SELECT_ASSOCIATIVE
- Name: .drectve
Value: 0
SectionNumber: 6
SimpleType: IMAGE_SYM_TYPE_NULL
ComplexType: IMAGE_SYM_DTYPE_NULL
StorageClass: IMAGE_SYM_CLASS_STATIC
SectionDefinition:
Length: 48
NumberOfRelocations: 0
NumberOfLinenumbers: 0
CheckSum: 149686238
Number: 6
- Name: '.debug$S'
Value: 0
SectionNumber: 7
SimpleType: IMAGE_SYM_TYPE_NULL
ComplexType: IMAGE_SYM_DTYPE_NULL
StorageClass: IMAGE_SYM_CLASS_STATIC
SectionDefinition:
Length: 264
NumberOfRelocations: 4
NumberOfLinenumbers: 0
CheckSum: 2204933783
Number: 7
- Name: '.debug$S'
Value: 0
SectionNumber: 11
SimpleType: IMAGE_SYM_TYPE_NULL
ComplexType: IMAGE_SYM_DTYPE_NULL
StorageClass: IMAGE_SYM_CLASS_STATIC
SectionDefinition:
Length: 116
NumberOfRelocations: 4
NumberOfLinenumbers: 0
CheckSum: 2691661839
Number: 5
Selection: IMAGE_COMDAT_SELECT_ASSOCIATIVE
- Name: '.debug$T'
Value: 0
SectionNumber: 8
SimpleType: IMAGE_SYM_TYPE_NULL
ComplexType: IMAGE_SYM_DTYPE_NULL
StorageClass: IMAGE_SYM_CLASS_STATIC
SectionDefinition:
Length: 80
NumberOfRelocations: 0
NumberOfLinenumbers: 0
CheckSum: 3541780432
Number: 8
- Name: .pdata
Value: 0
SectionNumber: 9
SimpleType: IMAGE_SYM_TYPE_NULL
ComplexType: IMAGE_SYM_DTYPE_NULL
StorageClass: IMAGE_SYM_CLASS_STATIC
SectionDefinition:
Length: 12
NumberOfRelocations: 3
NumberOfLinenumbers: 0
CheckSum: 567356797
Number: 9
- Name: .pdata
Value: 0
SectionNumber: 12
SimpleType: IMAGE_SYM_TYPE_NULL
ComplexType: IMAGE_SYM_DTYPE_NULL
StorageClass: IMAGE_SYM_CLASS_STATIC
SectionDefinition:
Length: 12
NumberOfRelocations: 3
NumberOfLinenumbers: 0
CheckSum: 3642757804
Number: 5
Selection: IMAGE_COMDAT_SELECT_ASSOCIATIVE
- Name: main
Value: 0
SectionNumber: 1
SimpleType: IMAGE_SYM_TYPE_NULL
ComplexType: IMAGE_SYM_DTYPE_FUNCTION
StorageClass: IMAGE_SYM_CLASS_EXTERNAL
- Name: bar
Value: 0
SectionNumber: 0
SimpleType: IMAGE_SYM_TYPE_NULL
ComplexType: IMAGE_SYM_DTYPE_NULL
StorageClass: IMAGE_SYM_CLASS_EXTERNAL
...

lld/test/COFF/Inputs/pdb_lines_2_relative.yaml

  • This file was added.
--- !COFF
header:
Machine: IMAGE_FILE_MACHINE_AMD64
Characteristics: [ ]
sections:
- Name: .text
Characteristics: [ IMAGE_SCN_CNT_CODE, IMAGE_SCN_MEM_EXECUTE, IMAGE_SCN_MEM_READ ]
Alignment: 16
SectionData: C3
- Name: .data
Characteristics: [ IMAGE_SCN_CNT_INITIALIZED_DATA, IMAGE_SCN_MEM_READ, IMAGE_SCN_MEM_WRITE ]
Alignment: 4
SectionData: ''
- Name: .bss
Characteristics: [ IMAGE_SCN_CNT_UNINITIALIZED_DATA, IMAGE_SCN_MEM_READ, IMAGE_SCN_MEM_WRITE ]
Alignment: 4
SectionData: ''
- Name: .drectve
Characteristics: [ IMAGE_SCN_LNK_INFO, IMAGE_SCN_LNK_REMOVE ]
Alignment: 1
SectionData: 202F44454641554C544C49423A6C6962636D742E6C6962202F44454641554C544C49423A6F6C646E616D65732E6C6962
- Name: '.debug$S'
Characteristics: [ IMAGE_SCN_CNT_INITIALIZED_DATA, IMAGE_SCN_MEM_DISCARDABLE, IMAGE_SCN_MEM_READ ]
Alignment: 4
SectionData: 04000000F10000002F0000002D003C1100000000D0000700000000000000581B000000000000636C616E672076657273696F6E20372E302E30200000F10000002F0000002900471100000000000000000000000001000000000000000000000002100000000000000000006261720002004F1100F2000000200000000000000000000000010000000000000001000000140000000000000002000000F400000018000000010000001001DF91CB3A2B8D917486574BB50CAC4CC70000F300000014000000002E5C7064625F6C696E65735F322E6300000000
Subsections:
- !Symbols
Records:
- Kind: S_COMPILE3
Compile3Sym:
Flags: [ ]
Machine: X64
FrontendMajor: 7
FrontendMinor: 0
FrontendBuild: 0
FrontendQFE: 0
BackendMajor: 7000
BackendMinor: 0
BackendBuild: 0
BackendQFE: 0
Version: 'clang version 7.0.0 '
- !Symbols
Records:
- Kind: S_GPROC32_ID
ProcSym:
CodeSize: 1
DbgStart: 0
DbgEnd: 0
FunctionType: 4098
Flags: [ ]
DisplayName: bar
- Kind: S_PROC_ID_END
ScopeEndSym:
- !Lines
CodeSize: 1
Flags: [ ]
RelocOffset: 0
RelocSegment: 0
Blocks:
- FileName: '.\pdb_lines_2.c'
Lines:
- Offset: 0
LineStart: 2
IsStatement: false
EndDelta: 0
Columns:
- !FileChecksums
Checksums:
- FileName: '.\pdb_lines_2.c'
Kind: MD5
Checksum: DF91CB3A2B8D917486574BB50CAC4CC7
- !StringTable
Strings:
- '.\pdb_lines_2.c'
- ''
- ''
- ''
Relocations:
- VirtualAddress: 100
SymbolName: bar
Type: IMAGE_REL_AMD64_SECREL
- VirtualAddress: 104
SymbolName: bar
Type: IMAGE_REL_AMD64_SECTION
- VirtualAddress: 124
SymbolName: bar
Type: IMAGE_REL_AMD64_SECREL
- VirtualAddress: 128
SymbolName: bar
Type: IMAGE_REL_AMD64_SECTION
- Name: '.debug$T'
Characteristics: [ IMAGE_SCN_CNT_INITIALIZED_DATA, IMAGE_SCN_MEM_DISCARDABLE, IMAGE_SCN_MEM_READ ]
Alignment: 4
SectionData: 0400000006000112000000000E0008100300000000000000001000000E000116000000000110000062617200
Types:
- Kind: LF_ARGLIST
ArgList:
ArgIndices: [ ]
- Kind: LF_PROCEDURE
Procedure:
ReturnType: 3
CallConv: NearC
Options: [ None ]
ParameterCount: 0
ArgumentList: 4096
- Kind: LF_FUNC_ID
FuncId:
ParentScope: 0
FunctionType: 4097
Name: bar
symbols:
- Name: .text
Value: 0
SectionNumber: 1
SimpleType: IMAGE_SYM_TYPE_NULL
ComplexType: IMAGE_SYM_DTYPE_NULL
StorageClass: IMAGE_SYM_CLASS_STATIC
SectionDefinition:
Length: 1
NumberOfRelocations: 0
NumberOfLinenumbers: 0
CheckSum: 40735498
Number: 1
- Name: .data
Value: 0
SectionNumber: 2
SimpleType: IMAGE_SYM_TYPE_NULL
ComplexType: IMAGE_SYM_DTYPE_NULL
StorageClass: IMAGE_SYM_CLASS_STATIC
SectionDefinition:
Length: 0
NumberOfRelocations: 0
NumberOfLinenumbers: 0
CheckSum: 0
Number: 2
- Name: .bss
Value: 0
SectionNumber: 3
SimpleType: IMAGE_SYM_TYPE_NULL
ComplexType: IMAGE_SYM_DTYPE_NULL
StorageClass: IMAGE_SYM_CLASS_STATIC
SectionDefinition:
Length: 0
NumberOfRelocations: 0
NumberOfLinenumbers: 0
CheckSum: 0
Number: 3
- Name: .drectve
Value: 0
SectionNumber: 4
SimpleType: IMAGE_SYM_TYPE_NULL
ComplexType: IMAGE_SYM_DTYPE_NULL
StorageClass: IMAGE_SYM_CLASS_STATIC
SectionDefinition:
Length: 48
NumberOfRelocations: 0
NumberOfLinenumbers: 0
CheckSum: 149686238
Number: 4
- Name: '.debug$S'
Value: 0
SectionNumber: 5
SimpleType: IMAGE_SYM_TYPE_NULL
ComplexType: IMAGE_SYM_DTYPE_NULL
StorageClass: IMAGE_SYM_CLASS_STATIC
SectionDefinition:
Length: 216
NumberOfRelocations: 4
NumberOfLinenumbers: 0
CheckSum: 2383431754
Number: 5
- Name: '.debug$T'
Value: 0
SectionNumber: 6
SimpleType: IMAGE_SYM_TYPE_NULL
ComplexType: IMAGE_SYM_DTYPE_NULL
StorageClass: IMAGE_SYM_CLASS_STATIC
SectionDefinition:
Length: 44
NumberOfRelocations: 0
NumberOfLinenumbers: 0
CheckSum: 179171995
Number: 6
- Name: bar
Value: 0
SectionNumber: 1
SimpleType: IMAGE_SYM_TYPE_NULL
ComplexType: IMAGE_SYM_DTYPE_FUNCTION
StorageClass: IMAGE_SYM_CLASS_EXTERNAL
...

lld/test/COFF/pdb-relative-source-lines.test

  • This file was added.
Test the linker line tables on roughly the following example:
==> foo.h <==
void bar(void);
inline void foo(void) {
bar();
}
==> pdb_lines_1.c <==
#include "foo.h"
int main(void) {
foo();
return 42;
}
==> pdb_lines_2.c <==
void bar(void) {
}
$ clang-cl -Xclang -fdebug-compilation-dir -Xclang . -c -Z7 pdb_lines*.c
RUN: yaml2obj %S/Inputs/pdb_lines_1_relative.yaml -o %t.pdb_lines_1_relative.obj
RUN: yaml2obj %S/Inputs/pdb_lines_2_relative.yaml -o %t.pdb_lines_2_relative.obj
RUN: rm -f %t.exe %t.pdb
RUN: lld-link -debug -entry:main -nodefaultlib -out:%t.exe -pdb:%t.pdb %t.pdb_lines_1_relative.obj %t.pdb_lines_2_relative.obj
RUN: llvm-pdbutil pdb2yaml -modules -module-files -subsections=lines,fc %t.pdb | FileCheck %s
CHECK-LABEL: DbiStream:
CHECK-NEXT: VerHeader: V70
CHECK-NEXT: Age: 1
CHECK-NEXT: BuildNumber: 36363
CHECK-NEXT: PdbDllVersion: 0
CHECK-NEXT: PdbDllRbld: 0
CHECK-NEXT: Flags: 0
CHECK-NEXT: MachineType: Amd64
CHECK-NEXT: Modules:
CHECK-LABEL: - Module: {{.*}}pdb_lines_1_relative.obj
CHECK-NEXT: ObjFile: {{.*}}pdb_lines_1_relative.obj
CHECK-NEXT: SourceFiles:
CHECK-NEXT: - '{{.*}}pdb_lines_1.c'
CHECK-NEXT: - '{{.*}}foo.h'
CHECK-NEXT: Subsections:
CHECK-NEXT: - !Lines
CHECK-NEXT: CodeSize: 27
CHECK-NEXT: Flags: [ ]
CHECK-NEXT: RelocOffset: 0
CHECK-NEXT: RelocSegment: 1
CHECK-NEXT: Blocks:
CHECK-NEXT: - FileName: '{{.*}}pdb_lines_1.c'
CHECK-NEXT: Lines:
ruiuUnsubmitted
Done
ReplyInline Actions

Don't you need only the lines that contain pathname? I'd remove all the other lines from the file, so that we don't have to update them when some unrelated change is committed.

ruiu: Don't you need only the lines that contain pathname? I'd remove all the other lines from the…
takuto.ikutaAuthorUnsubmitted
Not Done
ReplyInline Actions

Shrinked, but let me keep hardly be changed lines as anchor.

takuto.ikuta: Shrinked, but let me keep hardly be changed lines as anchor.
CHECK-NEXT: - Offset: 0
CHECK-NEXT: LineStart: 2
CHECK-NEXT: IsStatement: false
CHECK-NEXT: EndDelta: 0
CHECK-NEXT: - Offset: 12
CHECK-NEXT: LineStart: 3
CHECK-NEXT: IsStatement: false
CHECK-NEXT: EndDelta: 0
CHECK-NEXT: - Offset: 17
CHECK-NEXT: LineStart: 4
CHECK-NEXT: IsStatement: false
CHECK-NEXT: EndDelta: 0
CHECK-NEXT: Columns:
CHECK-NEXT: - !Lines
CHECK-NEXT: CodeSize: 15
CHECK-NEXT: Flags: [ ]
CHECK-NEXT: RelocOffset: 32
CHECK-NEXT: RelocSegment: 1
CHECK-NEXT: Blocks:
CHECK-NEXT: - FileName: '{{.*}}foo.h'
CHECK-NEXT: Lines:
CHECK-NEXT: - Offset: 0
CHECK-NEXT: LineStart: 2
CHECK-NEXT: IsStatement: false
CHECK-NEXT: EndDelta: 0
CHECK-NEXT: - Offset: 4
CHECK-NEXT: LineStart: 3
CHECK-NEXT: IsStatement: false
CHECK-NEXT: EndDelta: 0
CHECK-NEXT: - Offset: 9
CHECK-NEXT: LineStart: 4
CHECK-NEXT: IsStatement: false
CHECK-NEXT: EndDelta: 0
CHECK-NEXT: Columns:
CHECK-NEXT: - !FileChecksums
CHECK-NEXT: Checksums:
CHECK-NEXT: - FileName: '{{.*}}pdb_lines_1.c'
CHECK-NEXT: Kind: MD5
CHECK-NEXT: Checksum: EA6429BCE282CCF3F0E3CD93B216EB41
CHECK-NEXT: - FileName: '{{.*}}foo.h'
CHECK-NEXT: Kind: MD5
CHECK-NEXT: Checksum: 061EB73ABB642532857A4F1D9CBAC323
CHECK-LABEL: - Module: {{.*}}pdb_lines_2_relative.obj
CHECK-NEXT: ObjFile: {{.*}}pdb_lines_2_relative.obj
CHECK-NEXT: SourceFiles:
CHECK-NEXT: - '{{.*}}pdb_lines_2.c'
CHECK-NEXT: Subsections:
CHECK-NEXT: - !Lines
CHECK-NEXT: CodeSize: 1
CHECK-NEXT: Flags: [ ]
CHECK-NEXT: RelocOffset: 48
CHECK-NEXT: RelocSegment: 1
CHECK-NEXT: Blocks:
CHECK-NEXT: - FileName: '{{.*}}pdb_lines_2.c'
CHECK-NEXT: Lines:
CHECK-NEXT: - Offset: 0
CHECK-NEXT: LineStart: 2
CHECK-NEXT: IsStatement: false
CHECK-NEXT: EndDelta: 0
CHECK-NEXT: Columns:
CHECK-NEXT: - !FileChecksums
CHECK-NEXT: Checksums:
CHECK-NEXT: - FileName: '{{.*}}pdb_lines_2.c'
CHECK-NEXT: Kind: MD5
CHECK-NEXT: Checksum: DF91CB3A2B8D917486574BB50CAC4CC7
CHECK-NEXT: - Module: '* Linker *'
CHECK-NEXT: ObjFile: ''