Skip to content

[dsymutil] Remove paper trail warnings #67041

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
Sep 22, 2023
Merged

[dsymutil] Remove paper trail warnings #67041

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
7 changes: 0 additions & 7 deletions llvm/docs/CommandGuide/dsymutil.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,13 +100,6 @@ OPTIONS
Specifies an alternate ``path`` to place the dSYM bundle. The default dSYM
bundle path is created by appending ``.dSYM`` to the executable name.

.. option:: --papertrail

When running dsymutil as part of your build system, it can be desirable for
warnings to be part of the end product, rather than just being emitted to the
output stream. When enabled warnings are embedded in the linked DWARF debug
information.

.. option:: --remarks-drop-without-debug

Drop remarks without valid debug locations. Without this flags, all remarks are kept.
Expand Down
16 changes: 2 additions & 14 deletions llvm/include/llvm/DWARFLinker/DWARFLinker.h
View file
Open in desktop
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I do not see how to comment exact line if it is not part of already changed lines... So I put comment in start of the file. The DWARFFile::Warnings can also be removed. And the same for the DWARFLinkerParallel\DWARFFile.h.

Original file line number Diff line number Diff line change
Expand Up @@ -99,9 +99,6 @@ class DwarfEmitter {
public:
virtual ~DwarfEmitter();

/// Emit DIE containing warnings.
virtual void emitPaperTrailWarningsDie(DIE &Die) = 0;

/// Emit section named SecName with data SecData.
virtual void emitSectionContents(StringRef SecData, StringRef SecName) = 0;

Expand Down Expand Up @@ -272,11 +269,9 @@ class DWARFFile {
public:
using UnloadCallbackTy = std::function<void(StringRef FileName)>;
DWARFFile(StringRef Name, std::unique_ptr<DWARFContext> Dwarf,
std::unique_ptr<AddressesMap> Addresses,
const std::vector<std::string> &Warnings,
UnloadCallbackTy = nullptr)
std::unique_ptr<AddressesMap> Addresses, UnloadCallbackTy = nullptr)
: FileName(Name), Dwarf(std::move(Dwarf)),
Addresses(std::move(Addresses)), Warnings(Warnings) {}
Addresses(std::move(Addresses)) {}

/// The object file name.
StringRef FileName;
Expand All @@ -286,9 +281,6 @@ class DWARFFile {

/// Helpful address information(list of valid address ranges, relocations).
std::unique_ptr<AddressesMap> Addresses;

/// Warnings for this object file.
const std::vector<std::string> &Warnings;
};

typedef std::map<std::string, std::string> swiftInterfacesMap;
Expand Down Expand Up @@ -508,10 +500,6 @@ class DWARFLinker {
ErrorHandler(Warning, File.FileName, DIE);
}

/// Emit warnings as Dwarf compile units to leave a trail after linking.
bool emitPaperTrailWarnings(const DWARFFile &File,
OffsetsStringPool &StringPool);

void copyInvariantDebugSection(DWARFContext &Dwarf);

/// Keep information for referenced clang module: already loaded DWARF info
Expand Down
3 changes: 0 additions & 3 deletions llvm/include/llvm/DWARFLinker/DWARFStreamer.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,9 +72,6 @@ class DwarfStreamer : public DwarfEmitter {
void emitAbbrevs(const std::vector<std::unique_ptr<DIEAbbrev>> &Abbrevs,
unsigned DwarfVersion) override;

/// Emit DIE containing warnings.
void emitPaperTrailWarningsDie(DIE &Die) override;

/// Emit contents of section SecName From Obj.
void emitSectionContents(StringRef SecData, StringRef SecName) override;

Expand Down
4 changes: 0 additions & 4 deletions llvm/include/llvm/DWARFLinkerParallel/DWARFFile.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@ class DWARFFile {

DWARFFile(StringRef Name, std::unique_ptr<DWARFContext> Dwarf,
std::unique_ptr<AddressesMap> Addresses,
const std::vector<std::string> &Warnings,
UnloadCallbackTy UnloadFunc = nullptr);

/// Object file name.
Expand All @@ -41,9 +40,6 @@ class DWARFFile {
/// Helpful address information(list of valid address ranges, relocations).
std::unique_ptr<AddressesMap> Addresses;

/// Warnings for object file.
const std::vector<std::string> &Warnings;

/// Callback to the module keeping object file to unload.
UnloadCallbackTy UnloadFunc;

Expand Down
66 changes: 0 additions & 66 deletions llvm/lib/DWARFLinker/DWARFLinker.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2584,69 +2584,6 @@ uint64_t DWARFLinker::DIECloner::cloneAllCompileUnits(
return OutputDebugInfoSize - StartOutputDebugInfoSize;
}

bool DWARFLinker::emitPaperTrailWarnings(const DWARFFile &File,
OffsetsStringPool &StringPool) {

if (File.Warnings.empty())
return false;

DIE *CUDie = DIE::get(DIEAlloc, dwarf::DW_TAG_compile_unit);
CUDie->setOffset(11);
StringRef Producer;
StringRef WarningHeader;

switch (DwarfLinkerClientID) {
case DwarfLinkerClient::Dsymutil:
Producer = StringPool.internString("dsymutil");
WarningHeader = "dsymutil_warning";
break;

default:
Producer = StringPool.internString("dwarfopt");
WarningHeader = "dwarfopt_warning";
break;
}

StringRef FileName = StringPool.internString(File.FileName);
CUDie->addValue(DIEAlloc, dwarf::DW_AT_producer, dwarf::DW_FORM_strp,
DIEInteger(StringPool.getStringOffset(Producer)));
DIEBlock *String = new (DIEAlloc) DIEBlock();
DIEBlocks.push_back(String);
for (auto &C : FileName)
String->addValue(DIEAlloc, dwarf::Attribute(0), dwarf::DW_FORM_data1,
DIEInteger(C));
String->addValue(DIEAlloc, dwarf::Attribute(0), dwarf::DW_FORM_data1,
DIEInteger(0));

CUDie->addValue(DIEAlloc, dwarf::DW_AT_name, dwarf::DW_FORM_string, String);
for (const auto &Warning : File.Warnings) {
DIE &ConstDie = CUDie->addChild(DIE::get(DIEAlloc, dwarf::DW_TAG_constant));
ConstDie.addValue(DIEAlloc, dwarf::DW_AT_name, dwarf::DW_FORM_strp,
DIEInteger(StringPool.getStringOffset(WarningHeader)));
ConstDie.addValue(DIEAlloc, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag,
DIEInteger(1));
ConstDie.addValue(DIEAlloc, dwarf::DW_AT_const_value, dwarf::DW_FORM_strp,
DIEInteger(StringPool.getStringOffset(Warning)));
}
unsigned Size = 4 /* FORM_strp */ + FileName.size() + 1 +
File.Warnings.size() * (4 + 1 + 4) + 1 /* End of children */;
DIEAbbrev Abbrev = CUDie->generateAbbrev();
assignAbbrev(Abbrev);
CUDie->setAbbrevNumber(Abbrev.getNumber());
Size += getULEB128Size(Abbrev.getNumber());
// Abbreviation ordering needed for classic compatibility.
for (auto &Child : CUDie->children()) {
Abbrev = Child.generateAbbrev();
assignAbbrev(Abbrev);
Child.setAbbrevNumber(Abbrev.getNumber());
Size += getULEB128Size(Abbrev.getNumber());
}
CUDie->setSize(Size);
TheDwarfEmitter->emitPaperTrailWarningsDie(*CUDie);

return true;
}

void DWARFLinker::copyInvariantDebugSection(DWARFContext &Dwarf) {
TheDwarfEmitter->emitSectionContents(Dwarf.getDWARFObj().getLocSection().Data,
"debug_loc");
Expand Down Expand Up @@ -2711,9 +2648,6 @@ Error DWARFLinker::link() {
outs() << "OBJECT FILE: " << OptContext.File.FileName << "\n";
}

if (emitPaperTrailWarnings(OptContext.File, DebugStrPool))
continue;

if (!OptContext.File.Dwarf)
continue;

Expand Down
12 changes: 0 additions & 12 deletions llvm/lib/DWARFLinker/DWARFStreamer.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -234,18 +234,6 @@ void DwarfStreamer::emitSectionContents(StringRef SecData, StringRef SecName) {
}
}

/// Emit DIE containing warnings.
void DwarfStreamer::emitPaperTrailWarningsDie(DIE &Die) {
switchToDebugInfoSection(/* Version */ 2);
auto &Asm = getAsmPrinter();
Asm.emitInt32(11 + Die.getSize() - 4);
Asm.emitInt16(2);
Asm.emitInt32(0);
Asm.emitInt8(MC->getTargetTriple().isArch64Bit() ? 8 : 4);
DebugInfoSectionSize += 11;
emitDIE(Die);
}

/// Emit the debug_str section stored in \p Pool.
void DwarfStreamer::emitStrings(const NonRelocatableStringpool &Pool) {
Asm->OutStreamer->switchSection(MOFI->getDwarfStrSection());
Expand Down
3 changes: 1 addition & 2 deletions llvm/lib/DWARFLinkerParallel/DWARFFile.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@
llvm::dwarflinker_parallel::DWARFFile::DWARFFile(
StringRef Name, std::unique_ptr<DWARFContext> Dwarf,
std::unique_ptr<AddressesMap> Addresses,
const std::vector<std::string> &Warnings,
DWARFFile::UnloadCallbackTy UnloadFunc)
: FileName(Name), Dwarf(std::move(Dwarf)), Addresses(std::move(Addresses)),
Warnings(Warnings), UnloadFunc(UnloadFunc) {}
UnloadFunc(UnloadFunc) {}
146 changes: 18 additions & 128 deletions llvm/lib/DWARFLinkerParallel/DWARFLinkerImpl.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -371,27 +371,26 @@ Error DWARFLinkerImpl::LinkContext::loadClangModule(

Error DWARFLinkerImpl::LinkContext::link() {
InterCUProcessingStarted = false;
if (InputDWARFFile.Warnings.empty()) {
if (!InputDWARFFile.Dwarf)
return Error::success();
if (!InputDWARFFile.Dwarf)
return Error::success();

// Preload macro tables, as they can't be loaded asynchronously.
InputDWARFFile.Dwarf->getDebugMacinfo();
InputDWARFFile.Dwarf->getDebugMacro();
// Preload macro tables, as they can't be loaded asynchronously.
InputDWARFFile.Dwarf->getDebugMacinfo();
InputDWARFFile.Dwarf->getDebugMacro();

// Link modules compile units first.
parallelForEach(ModulesCompileUnits, [&](RefModuleUnit &RefModule) {
linkSingleCompileUnit(*RefModule.Unit);
});
// Link modules compile units first.
parallelForEach(ModulesCompileUnits, [&](RefModuleUnit &RefModule) {
linkSingleCompileUnit(*RefModule.Unit);
});

// Check for live relocations. If there is no any live relocation then we
// can skip entire object file.
if (!GlobalData.getOptions().UpdateIndexTablesOnly &&
!InputDWARFFile.Addresses->hasValidRelocs()) {
if (GlobalData.getOptions().Verbose)
outs() << "No valid relocations found. Skipping.\n";
return Error::success();
}
// Check for live relocations. If there is no any live relocation then we
// can skip entire object file.
if (!GlobalData.getOptions().UpdateIndexTablesOnly &&
!InputDWARFFile.Addresses->hasValidRelocs()) {
if (GlobalData.getOptions().Verbose)
outs() << "No valid relocations found. Skipping.\n";
return Error::success();
}

OriginalDebugInfoSize = getInputDebugInfoSize();

Expand Down Expand Up @@ -460,21 +459,8 @@ Error DWARFLinkerImpl::LinkContext::link() {
linkSingleCompileUnit(*CU, CompileUnit::Stage::Cleaned);
});
}
}

if (!InputDWARFFile.Warnings.empty()) {
// Create compile unit with paper trail warnings.

Error ResultErr = Error::success();
// We use task group here as PerThreadBumpPtrAllocator should be called from
// the threads created by ThreadPoolExecutor.
parallel::TaskGroup TGroup;
TGroup.spawn([&]() {
if (Error Err = cloneAndEmitPaperTrails())
ResultErr = std::move(Err);
});
return ResultErr;
} else if (GlobalData.getOptions().UpdateIndexTablesOnly) {
if (GlobalData.getOptions().UpdateIndexTablesOnly) {
// Emit Invariant sections.

if (Error Err = emitInvariantSections())
Expand Down Expand Up @@ -715,102 +701,6 @@ void DWARFLinkerImpl::LinkContext::emitFDE(uint32_t CIEOffset,
Section.OS.write(FDEBytes.data(), FDEBytes.size());
}

Error DWARFLinkerImpl::LinkContext::cloneAndEmitPaperTrails() {
CompileUnits.emplace_back(std::make_unique<CompileUnit>(
GlobalData, UniqueUnitID.fetch_add(1), "", InputDWARFFile,
getUnitForOffset, Format, Endianness));

CompileUnit &CU = *CompileUnits.back();

BumpPtrAllocator Allocator;

DIEGenerator ParentGenerator(Allocator, CU);

SectionDescriptor &DebugInfoSection =
CU.getOrCreateSectionDescriptor(DebugSectionKind::DebugInfo);
OffsetsPtrVector PatchesOffsets;

uint64_t CurrentOffset = CU.getDebugInfoHeaderSize();
DIE *CUDie =
ParentGenerator.createDIE(dwarf::DW_TAG_compile_unit, CurrentOffset);
CU.setOutUnitDIE(CUDie);

DebugInfoSection.notePatchWithOffsetUpdate(
DebugStrPatch{{CurrentOffset},
GlobalData.getStringPool().insert("dsymutil").first},
PatchesOffsets);
CurrentOffset += ParentGenerator
.addStringPlaceholderAttribute(dwarf::DW_AT_producer,
dwarf::DW_FORM_strp)
.second;

CurrentOffset +=
ParentGenerator
.addInplaceString(dwarf::DW_AT_name, InputDWARFFile.FileName)
.second;

size_t SizeAbbrevNumber = ParentGenerator.finalizeAbbreviations(true);
CurrentOffset += SizeAbbrevNumber;
for (uint64_t *OffsetPtr : PatchesOffsets)
*OffsetPtr += SizeAbbrevNumber;
for (const auto &Warning : CU.getContaingFile().Warnings) {
PatchesOffsets.clear();
DIEGenerator ChildGenerator(Allocator, CU);

DIE *ChildDie =
ChildGenerator.createDIE(dwarf::DW_TAG_constant, CurrentOffset);
ParentGenerator.addChild(ChildDie);

DebugInfoSection.notePatchWithOffsetUpdate(
DebugStrPatch{
{CurrentOffset},
GlobalData.getStringPool().insert("dsymutil_warning").first},
PatchesOffsets);
CurrentOffset += ChildGenerator
.addStringPlaceholderAttribute(dwarf::DW_AT_name,
dwarf::DW_FORM_strp)
.second;

CurrentOffset +=
ChildGenerator
.addScalarAttribute(dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1)
.second;

DebugInfoSection.notePatchWithOffsetUpdate(
DebugStrPatch{{CurrentOffset},
GlobalData.getStringPool().insert(Warning).first},
PatchesOffsets);
CurrentOffset += ChildGenerator
.addStringPlaceholderAttribute(
dwarf::DW_AT_const_value, dwarf::DW_FORM_strp)
.second;

SizeAbbrevNumber = ChildGenerator.finalizeAbbreviations(false);

CurrentOffset += SizeAbbrevNumber;
for (uint64_t *OffsetPtr : PatchesOffsets)
*OffsetPtr += SizeAbbrevNumber;

ChildDie->setSize(CurrentOffset - ChildDie->getOffset());
}

CurrentOffset += 1; // End of children
CUDie->setSize(CurrentOffset - CUDie->getOffset());

uint64_t UnitSize = 0;
UnitSize += CU.getDebugInfoHeaderSize();
UnitSize += CUDie->getSize();
CU.setUnitSize(UnitSize);

if (GlobalData.getOptions().NoOutput)
return Error::success();

if (Error Err = CU.emitDebugInfo(*TargetTriple))
return Err;

return CU.emitAbbreviations();
}

void DWARFLinkerImpl::glueCompileUnitsAndWriteToTheOutput() {
if (GlobalData.getOptions().NoOutput)
return;
Expand Down
3 changes: 0 additions & 3 deletions llvm/lib/DWARFLinkerParallel/DWARFLinkerImpl.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -294,9 +294,6 @@ class DWARFLinkerImpl : public DWARFLinker {
void emitFDE(uint32_t CIEOffset, uint32_t AddrSize, uint64_t Address,
StringRef FDEBytes, SectionDescriptor &Section);

/// Clone and emit paper trails.
Error cloneAndEmitPaperTrails();

std::function<CompileUnit *(uint64_t)> getUnitForOffset =
[&](uint64_t Offset) -> CompileUnit * {
auto CU = llvm::upper_bound(
Expand Down
Loading