From 49e2cc7d53a9f1ab8e175932e073df73cbc11645 Mon Sep 17 00:00:00 2001 From: Francis Ricci Date: Thu, 5 Oct 2017 20:03:01 +0000 Subject: [PATCH] [llvm-dsymutil] Add support for __swift_ast MachO DWARF section Summary: Xcode's dsymutil emits a __swift_ast DWARF section, which is required for debugging, and which contains a byte-for-byte dump of the swiftmodule file. Add this feature to llvm-dsymutil. Tested with `gobjdump --dwarf=info -s`, by verifying that the contents of `__DWARF.__swift_ast` match between Xcode's dsymutil and llvm-dsymutil (Xcode's dwarfdump and llvm-dwarfdump don't currently recognize the __swift_ast section). Reviewers: aprantl, friss Subscribers: llvm-commits, JDevlieghere Differential Revision: https://reviews.llvm.org/D38504 git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@315014 91177308-0d34-0410-b5e6-96231b3b80d8 --- include/llvm/MC/MCObjectFileInfo.h | 4 +++ lib/MC/MCObjectFileInfo.cpp | 4 +++ .../dsymutil/Inputs/swift-ast.macho.x86_64 | Bin 0 -> 8464 bytes .../dsymutil/Inputs/swift-ast.swiftmodule | 1 + test/tools/dsymutil/swift-ast.test | 14 +++++++++ tools/dsymutil/BinaryHolder.h | 12 ++++---- tools/dsymutil/DebugMap.cpp | 12 +++++--- tools/dsymutil/DebugMap.h | 8 +++-- tools/dsymutil/DwarfLinker.cpp | 29 ++++++++++++++++-- tools/dsymutil/MachODebugMapParser.cpp | 10 +++++- 10 files changed, 78 insertions(+), 16 deletions(-) create mode 100755 test/tools/dsymutil/Inputs/swift-ast.macho.x86_64 create mode 100644 test/tools/dsymutil/Inputs/swift-ast.swiftmodule create mode 100644 test/tools/dsymutil/swift-ast.test diff --git a/include/llvm/MC/MCObjectFileInfo.h b/include/llvm/MC/MCObjectFileInfo.h index b03fd099c1d..d95f84d1d81 100644 --- a/include/llvm/MC/MCObjectFileInfo.h +++ b/include/llvm/MC/MCObjectFileInfo.h @@ -123,6 +123,9 @@ protected: /// Section for newer gnu pubtypes. MCSection *DwarfGnuPubTypesSection; + // Section for Swift AST + MCSection *DwarfSwiftASTSection; + MCSection *COFFDebugSymbolsSection; MCSection *COFFDebugTypesSection; @@ -267,6 +270,7 @@ public: MCSection *getDwarfAddrSection() const { return DwarfAddrSection; } MCSection *getDwarfCUIndexSection() const { return DwarfCUIndexSection; } MCSection *getDwarfTUIndexSection() const { return DwarfTUIndexSection; } + MCSection *getDwarfSwiftASTSection() const { return DwarfSwiftASTSection; } MCSection *getCOFFDebugSymbolsSection() const { return COFFDebugSymbolsSection; diff --git a/lib/MC/MCObjectFileInfo.cpp b/lib/MC/MCObjectFileInfo.cpp index c6c5cb31690..e162e954687 100644 --- a/lib/MC/MCObjectFileInfo.cpp +++ b/lib/MC/MCObjectFileInfo.cpp @@ -214,6 +214,10 @@ void MCObjectFileInfo::initMachOMCObjectFileInfo(const Triple &T) { Ctx->getMachOSection("__DWARF", "__apple_types", MachO::S_ATTR_DEBUG, SectionKind::getMetadata(), "types_begin"); + DwarfSwiftASTSection = + Ctx->getMachOSection("__DWARF", "__swift_ast", MachO::S_ATTR_DEBUG, + SectionKind::getMetadata()); + DwarfAbbrevSection = Ctx->getMachOSection("__DWARF", "__debug_abbrev", MachO::S_ATTR_DEBUG, SectionKind::getMetadata(), "section_abbrev"); diff --git a/test/tools/dsymutil/Inputs/swift-ast.macho.x86_64 b/test/tools/dsymutil/Inputs/swift-ast.macho.x86_64 new file mode 100755 index 0000000000000000000000000000000000000000..f82d811409bef3d9be47460302950c849b2c7bef GIT binary patch literal 8464 zcmeHM&ubGw6n;rtt+kk(#9wF>6&0GaQX~ftMjA}~QHzZrf{gjGX;!iu&F;1-BIM#B zw;nwBH>iJsC&7c>y!jspy$E`hB7SeO(`?d;9z4l=@b=9&JM+z(ZzqtM`Sj!K&%H#k zF`{mqh!XJRIMH)Tp+s~TUVtmLl)IL{pTBdPYlkg140lD$lSMC&a=4B{ zjNE7fj{LMKg`!y_ zsgZdCvn4|UULR4eQ&`8dy2T$JDI#vib36pk0`Eb5iP%Bh4_|__ao$EtUW?K3`2FA5 z0W?a%r{S5vYiF8vB~x2()_~cL!a0xcAKx}^J-xKqdy#&)nAm!98g-D8Xx|h%PtgT~ zxej&?^W}cL&ZEZTWa0dd=NP~I89#&AU~G)PyzcpylfIfp9(DzdU}xbx-fW79zuox| zvp!;?fG8jehytR3C?E=m0-}H@@NX5kTj+h6dsp}{u>xM+X!M?K6?(z92k&DV9t($y zM*e@#|NrL^*) z_v3ZOxGXjIz)X{f>6=V_5^+%D{<#GobMScvA{Vu#aO1r*C#7@ZYg6U Timestamp); + void changeBackingMemoryBuffer(std::unique_ptr &&MemBuf); + ErrorOr getObjfileForArch(const Triple &T); + +public: + BinaryHolder(bool Verbose) : Verbose(Verbose) {} + /// Return the MemoryBufferRef that holds the memory mapping for the /// given \p Filename. This function will try to parse archive /// member specifications of the form /path/to/archive.a(member.o). @@ -79,12 +85,6 @@ class BinaryHolder { GetMemoryBuffersForFile(StringRef Filename, sys::TimePoint Timestamp); - void changeBackingMemoryBuffer(std::unique_ptr &&MemBuf); - ErrorOr getObjfileForArch(const Triple &T); - -public: - BinaryHolder(bool Verbose) : Verbose(Verbose) {} - /// Get the ObjectFiles designated by the \p Filename. This /// might be an archive member specification of the form /// /path/to/archive.a(member.o). diff --git a/tools/dsymutil/DebugMap.cpp b/tools/dsymutil/DebugMap.cpp index 636d65836c6..7f205767461 100644 --- a/tools/dsymutil/DebugMap.cpp +++ b/tools/dsymutil/DebugMap.cpp @@ -21,8 +21,9 @@ namespace dsymutil { using namespace llvm::object; DebugMapObject::DebugMapObject(StringRef ObjectFilename, - sys::TimePoint Timestamp) - : Filename(ObjectFilename), Timestamp(Timestamp) {} + sys::TimePoint Timestamp, + uint8_t Type) + : Filename(ObjectFilename), Timestamp(Timestamp), Type(Type) {} bool DebugMapObject::addSymbol(StringRef Name, Optional ObjectAddress, uint64_t LinkedAddress, uint32_t Size) { @@ -64,8 +65,9 @@ void DebugMapObject::dump() const { print(errs()); } DebugMapObject & DebugMap::addDebugMapObject(StringRef ObjectFilePath, - sys::TimePoint Timestamp) { - Objects.emplace_back(new DebugMapObject(ObjectFilePath, Timestamp)); + sys::TimePoint Timestamp, + uint8_t Type) { + Objects.emplace_back(new DebugMapObject(ObjectFilePath, Timestamp, Type)); return *Objects.back(); } @@ -241,7 +243,7 @@ MappingTraits::YamlDMO::denormalize(IO &IO) { } } - dsymutil::DebugMapObject Res(Path, sys::toTimePoint(Timestamp)); + dsymutil::DebugMapObject Res(Path, sys::toTimePoint(Timestamp), MachO::N_OSO); for (auto &Entry : Entries) { auto &Mapping = Entry.second; Optional ObjAddress; diff --git a/tools/dsymutil/DebugMap.h b/tools/dsymutil/DebugMap.h index eab0cb0a800..0b564149488 100644 --- a/tools/dsymutil/DebugMap.h +++ b/tools/dsymutil/DebugMap.h @@ -94,7 +94,8 @@ public: /// debug map. DebugMapObject & addDebugMapObject(StringRef ObjectFilePath, - sys::TimePoint Timestamp); + sys::TimePoint Timestamp, + uint8_t Type); const Triple &getTriple() const { return BinaryTriple; } @@ -154,6 +155,8 @@ public: return Timestamp; } + uint8_t getType() const { return Type; } + iterator_range::const_iterator> symbols() const { return make_range(Symbols.begin(), Symbols.end()); } @@ -166,12 +169,13 @@ private: friend class DebugMap; /// DebugMapObjects can only be constructed by the owning DebugMap. DebugMapObject(StringRef ObjectFilename, - sys::TimePoint Timestamp); + sys::TimePoint Timestamp, uint8_t Type); std::string Filename; sys::TimePoint Timestamp; StringMap Symbols; DenseMap AddressToMapping; + uint8_t Type; /// For YAMLIO support. ///@{ diff --git a/tools/dsymutil/DwarfLinker.cpp b/tools/dsymutil/DwarfLinker.cpp index fba23b6517d..be662f49e1a 100644 --- a/tools/dsymutil/DwarfLinker.cpp +++ b/tools/dsymutil/DwarfLinker.cpp @@ -525,6 +525,9 @@ public: /// Emit the string table described by \p Pool. void emitStrings(const NonRelocatableStringpool &Pool); + /// Emit the swift_ast section stored in \p Buffers. + void emitSwiftAST(const std::vector &Buffers); + /// Emit debug_ranges for \p FuncRange by translating the /// original \p Entries. void emitRangesEntries( @@ -708,6 +711,15 @@ void DwarfStreamer::emitStrings(const NonRelocatableStringpool &Pool) { StringRef(Entry->getKey().data(), Entry->getKey().size() + 1)); } +/// Emit the swift_ast section stored in \p Buffers. +void DwarfStreamer::emitSwiftAST(const std::vector &Buffers) { + MCSection *SwiftASTSection = MOFI->getDwarfSwiftASTSection(); + SwiftASTSection->setAlignment(1 << 5); + MS->SwitchSection(SwiftASTSection); + for (auto Buf : Buffers) + MS->EmitBytes(Buf.getBuffer()); +} + /// Emit the debug_range section contents for \p FuncRange by /// translating the original \p Entries. The debug_range section /// format is totally trivial, consisting just of pairs of address @@ -3329,8 +3341,8 @@ void DwarfLinker::loadClangModule(StringRef Filename, StringRef ModulePath, else sys::path::append(Path, Filename); BinaryHolder ObjHolder(Options.Verbose); - auto &Obj = - ModuleMap.addDebugMapObject(Path, sys::TimePoint()); + auto &Obj = ModuleMap.addDebugMapObject( + Path, sys::TimePoint(), MachO::N_OSO); auto ErrOrObj = loadObject(ObjHolder, Obj, ModuleMap); if (!ErrOrObj) { // Try and emit more helpful warnings by applying some heuristics. @@ -3475,6 +3487,19 @@ bool DwarfLinker::link(const DebugMap &Map) { if (Options.Verbose) outs() << "DEBUG MAP OBJECT: " << Obj->getObjectFilename() << "\n"; + + // N_AST objects (swiftmodule files) should get dumped directly into the + // appropriate DWARF section. + if (Obj->getType() == MachO::N_AST) { + auto ErrOrMemBufferRefs = BinHolder.GetMemoryBuffersForFile( + Obj->getObjectFilename(), Obj->getTimestamp()); + if (ErrOrMemBufferRefs.getError()) + continue; + if (!Options.NoOutput) + Streamer->emitSwiftAST(ErrOrMemBufferRefs.get()); + continue; + } + auto ErrOrObj = loadObject(BinHolder, *Obj, Map); if (!ErrOrObj) continue; diff --git a/tools/dsymutil/MachODebugMapParser.cpp b/tools/dsymutil/MachODebugMapParser.cpp index 866196fb27e..79b19137119 100644 --- a/tools/dsymutil/MachODebugMapParser.cpp +++ b/tools/dsymutil/MachODebugMapParser.cpp @@ -135,7 +135,8 @@ void MachODebugMapParser::switchToNewDebugMapObject( Err.message() + "\n"); } - CurrentDebugMapObject = &Result->addDebugMapObject(Path, Timestamp); + CurrentDebugMapObject = + &Result->addDebugMapObject(Path, Timestamp, MachO::N_OSO); loadCurrentObjectFileSymbols(*ErrOrAchObj); } @@ -349,6 +350,13 @@ void MachODebugMapParser::handleStabSymbolTableEntry(uint32_t StringIndex, if (Type == MachO::N_OSO) return switchToNewDebugMapObject(Name, sys::toTimePoint(Value)); + if (Type == MachO::N_AST) { + SmallString<80> Path(PathPrefix); + sys::path::append(Path, Name); + Result->addDebugMapObject(Path, sys::toTimePoint(Value), Type); + return; + } + // If the last N_OSO object file wasn't found, // CurrentDebugMapObject will be null. Do not update anything // until we find the next valid N_OSO entry. -- 2.40.0