123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837 |
- //===-- llvm-dwp.cpp - Split DWARF merging tool for llvm ------------------===//
- //
- // 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
- //
- //===----------------------------------------------------------------------===//
- //
- // A utility for merging DWARF 5 Split DWARF .dwo files into .dwp (DWARF
- // package files).
- //
- //===----------------------------------------------------------------------===//
- #include "llvm/DWP/DWP.h"
- #include "llvm/DWP/DWPError.h"
- #include "llvm/MC/MCContext.h"
- #include "llvm/MC/MCObjectFileInfo.h"
- #include "llvm/MC/MCTargetOptionsCommandFlags.h"
- #include "llvm/Object/Decompressor.h"
- #include "llvm/Object/ELFObjectFile.h"
- #include "llvm/Support/MemoryBuffer.h"
- #include <limits>
- using namespace llvm;
- using namespace llvm::object;
- static mc::RegisterMCTargetOptionsFlags MCTargetOptionsFlags;
- // Returns the size of debug_str_offsets section headers in bytes.
- static uint64_t debugStrOffsetsHeaderSize(DataExtractor StrOffsetsData,
- uint16_t DwarfVersion) {
- if (DwarfVersion <= 4)
- return 0; // There is no header before dwarf 5.
- uint64_t Offset = 0;
- uint64_t Length = StrOffsetsData.getU32(&Offset);
- if (Length == llvm::dwarf::DW_LENGTH_DWARF64)
- return 16; // unit length: 12 bytes, version: 2 bytes, padding: 2 bytes.
- return 8; // unit length: 4 bytes, version: 2 bytes, padding: 2 bytes.
- }
- static uint64_t getCUAbbrev(StringRef Abbrev, uint64_t AbbrCode) {
- uint64_t Offset = 0;
- DataExtractor AbbrevData(Abbrev, true, 0);
- while (AbbrevData.getULEB128(&Offset) != AbbrCode) {
- // Tag
- AbbrevData.getULEB128(&Offset);
- // DW_CHILDREN
- AbbrevData.getU8(&Offset);
- // Attributes
- while (AbbrevData.getULEB128(&Offset) | AbbrevData.getULEB128(&Offset))
- ;
- }
- return Offset;
- }
- static Expected<const char *>
- getIndexedString(dwarf::Form Form, DataExtractor InfoData, uint64_t &InfoOffset,
- StringRef StrOffsets, StringRef Str, uint16_t Version) {
- if (Form == dwarf::DW_FORM_string)
- return InfoData.getCStr(&InfoOffset);
- uint64_t StrIndex;
- switch (Form) {
- case dwarf::DW_FORM_strx1:
- StrIndex = InfoData.getU8(&InfoOffset);
- break;
- case dwarf::DW_FORM_strx2:
- StrIndex = InfoData.getU16(&InfoOffset);
- break;
- case dwarf::DW_FORM_strx3:
- StrIndex = InfoData.getU24(&InfoOffset);
- break;
- case dwarf::DW_FORM_strx4:
- StrIndex = InfoData.getU32(&InfoOffset);
- break;
- case dwarf::DW_FORM_strx:
- case dwarf::DW_FORM_GNU_str_index:
- StrIndex = InfoData.getULEB128(&InfoOffset);
- break;
- default:
- return make_error<DWPError>(
- "string field must be encoded with one of the following: "
- "DW_FORM_string, DW_FORM_strx, DW_FORM_strx1, DW_FORM_strx2, "
- "DW_FORM_strx3, DW_FORM_strx4, or DW_FORM_GNU_str_index.");
- }
- DataExtractor StrOffsetsData(StrOffsets, true, 0);
- uint64_t StrOffsetsOffset = 4 * StrIndex;
- StrOffsetsOffset += debugStrOffsetsHeaderSize(StrOffsetsData, Version);
- uint64_t StrOffset = StrOffsetsData.getU32(&StrOffsetsOffset);
- DataExtractor StrData(Str, true, 0);
- return StrData.getCStr(&StrOffset);
- }
- static Expected<CompileUnitIdentifiers>
- getCUIdentifiers(InfoSectionUnitHeader &Header, StringRef Abbrev,
- StringRef Info, StringRef StrOffsets, StringRef Str) {
- DataExtractor InfoData(Info, true, 0);
- uint64_t Offset = Header.HeaderSize;
- if (Header.Version >= 5 && Header.UnitType != dwarf::DW_UT_split_compile)
- return make_error<DWPError>(
- std::string("unit type DW_UT_split_compile type not found in "
- "debug_info header. Unexpected unit type 0x" +
- utostr(Header.UnitType) + " found"));
- CompileUnitIdentifiers ID;
- uint32_t AbbrCode = InfoData.getULEB128(&Offset);
- DataExtractor AbbrevData(Abbrev, true, 0);
- uint64_t AbbrevOffset = getCUAbbrev(Abbrev, AbbrCode);
- auto Tag = static_cast<dwarf::Tag>(AbbrevData.getULEB128(&AbbrevOffset));
- if (Tag != dwarf::DW_TAG_compile_unit)
- return make_error<DWPError>("top level DIE is not a compile unit");
- // DW_CHILDREN
- AbbrevData.getU8(&AbbrevOffset);
- uint32_t Name;
- dwarf::Form Form;
- while ((Name = AbbrevData.getULEB128(&AbbrevOffset)) |
- (Form = static_cast<dwarf::Form>(
- AbbrevData.getULEB128(&AbbrevOffset))) &&
- (Name != 0 || Form != 0)) {
- switch (Name) {
- case dwarf::DW_AT_name: {
- Expected<const char *> EName = getIndexedString(
- Form, InfoData, Offset, StrOffsets, Str, Header.Version);
- if (!EName)
- return EName.takeError();
- ID.Name = *EName;
- break;
- }
- case dwarf::DW_AT_GNU_dwo_name:
- case dwarf::DW_AT_dwo_name: {
- Expected<const char *> EName = getIndexedString(
- Form, InfoData, Offset, StrOffsets, Str, Header.Version);
- if (!EName)
- return EName.takeError();
- ID.DWOName = *EName;
- break;
- }
- case dwarf::DW_AT_GNU_dwo_id:
- Header.Signature = InfoData.getU64(&Offset);
- break;
- default:
- DWARFFormValue::skipValue(
- Form, InfoData, &Offset,
- dwarf::FormParams({Header.Version, Header.AddrSize, Header.Format}));
- }
- }
- if (!Header.Signature)
- return make_error<DWPError>("compile unit missing dwo_id");
- ID.Signature = *Header.Signature;
- return ID;
- }
- static bool isSupportedSectionKind(DWARFSectionKind Kind) {
- return Kind != DW_SECT_EXT_unknown;
- }
- namespace llvm {
- // Convert an internal section identifier into the index to use with
- // UnitIndexEntry::Contributions.
- unsigned getContributionIndex(DWARFSectionKind Kind, uint32_t IndexVersion) {
- assert(serializeSectionKind(Kind, IndexVersion) >= DW_SECT_INFO);
- return serializeSectionKind(Kind, IndexVersion) - DW_SECT_INFO;
- }
- } // namespace llvm
- // Convert a UnitIndexEntry::Contributions index to the corresponding on-disk
- // value of the section identifier.
- static unsigned getOnDiskSectionId(unsigned Index) {
- return Index + DW_SECT_INFO;
- }
- static StringRef getSubsection(StringRef Section,
- const DWARFUnitIndex::Entry &Entry,
- DWARFSectionKind Kind) {
- const auto *Off = Entry.getContribution(Kind);
- if (!Off)
- return StringRef();
- return Section.substr(Off->getOffset(), Off->getLength());
- }
- static void
- addAllTypesFromDWP(MCStreamer &Out,
- MapVector<uint64_t, UnitIndexEntry> &TypeIndexEntries,
- const DWARFUnitIndex &TUIndex, MCSection *OutputTypes,
- StringRef Types, const UnitIndexEntry &TUEntry,
- uint32_t &TypesOffset, unsigned TypesContributionIndex) {
- Out.switchSection(OutputTypes);
- for (const DWARFUnitIndex::Entry &E : TUIndex.getRows()) {
- auto *I = E.getContributions();
- if (!I)
- continue;
- auto P = TypeIndexEntries.insert(std::make_pair(E.getSignature(), TUEntry));
- if (!P.second)
- continue;
- auto &Entry = P.first->second;
- // Zero out the debug_info contribution
- Entry.Contributions[0] = {};
- for (auto Kind : TUIndex.getColumnKinds()) {
- if (!isSupportedSectionKind(Kind))
- continue;
- auto &C =
- Entry.Contributions[getContributionIndex(Kind, TUIndex.getVersion())];
- C.setOffset(C.getOffset() + I->getOffset());
- C.setLength(I->getLength());
- ++I;
- }
- auto &C = Entry.Contributions[TypesContributionIndex];
- Out.emitBytes(Types.substr(
- C.getOffset() -
- TUEntry.Contributions[TypesContributionIndex].getOffset(),
- C.getLength()));
- C.setOffset(TypesOffset);
- TypesOffset += C.getLength();
- }
- }
- static void addAllTypesFromTypesSection(
- MCStreamer &Out, MapVector<uint64_t, UnitIndexEntry> &TypeIndexEntries,
- MCSection *OutputTypes, const std::vector<StringRef> &TypesSections,
- const UnitIndexEntry &CUEntry, uint32_t &TypesOffset) {
- for (StringRef Types : TypesSections) {
- Out.switchSection(OutputTypes);
- uint64_t Offset = 0;
- DataExtractor Data(Types, true, 0);
- while (Data.isValidOffset(Offset)) {
- UnitIndexEntry Entry = CUEntry;
- // Zero out the debug_info contribution
- Entry.Contributions[0] = {};
- auto &C = Entry.Contributions[getContributionIndex(DW_SECT_EXT_TYPES, 2)];
- C.setOffset(TypesOffset);
- auto PrevOffset = Offset;
- // Length of the unit, including the 4 byte length field.
- C.setLength(Data.getU32(&Offset) + 4);
- Data.getU16(&Offset); // Version
- Data.getU32(&Offset); // Abbrev offset
- Data.getU8(&Offset); // Address size
- auto Signature = Data.getU64(&Offset);
- Offset = PrevOffset + C.getLength32();
- auto P = TypeIndexEntries.insert(std::make_pair(Signature, Entry));
- if (!P.second)
- continue;
- Out.emitBytes(Types.substr(PrevOffset, C.getLength32()));
- TypesOffset += C.getLength32();
- }
- }
- }
- static std::string buildDWODescription(StringRef Name, StringRef DWPName,
- StringRef DWOName) {
- std::string Text = "\'";
- Text += Name;
- Text += '\'';
- bool HasDWO = !DWOName.empty();
- bool HasDWP = !DWPName.empty();
- if (HasDWO || HasDWP) {
- Text += " (from ";
- if (HasDWO) {
- Text += '\'';
- Text += DWOName;
- Text += '\'';
- }
- if (HasDWO && HasDWP)
- Text += " in ";
- if (!DWPName.empty()) {
- Text += '\'';
- Text += DWPName;
- Text += '\'';
- }
- Text += ")";
- }
- return Text;
- }
- static Error createError(StringRef Name, Error E) {
- return make_error<DWPError>(
- ("failure while decompressing compressed section: '" + Name + "', " +
- llvm::toString(std::move(E)))
- .str());
- }
- static Error
- handleCompressedSection(std::deque<SmallString<32>> &UncompressedSections,
- SectionRef Sec, StringRef Name, StringRef &Contents) {
- auto *Obj = dyn_cast<ELFObjectFileBase>(Sec.getObject());
- if (!Obj ||
- !(static_cast<ELFSectionRef>(Sec).getFlags() & ELF::SHF_COMPRESSED))
- return Error::success();
- bool IsLE = isa<object::ELF32LEObjectFile>(Obj) ||
- isa<object::ELF64LEObjectFile>(Obj);
- bool Is64 = isa<object::ELF64LEObjectFile>(Obj) ||
- isa<object::ELF64BEObjectFile>(Obj);
- Expected<Decompressor> Dec = Decompressor::create(Name, Contents, IsLE, Is64);
- if (!Dec)
- return createError(Name, Dec.takeError());
- UncompressedSections.emplace_back();
- if (Error E = Dec->resizeAndDecompress(UncompressedSections.back()))
- return createError(Name, std::move(E));
- Contents = UncompressedSections.back();
- return Error::success();
- }
- namespace llvm {
- // Parse and return the header of an info section compile/type unit.
- Expected<InfoSectionUnitHeader> parseInfoSectionUnitHeader(StringRef Info) {
- InfoSectionUnitHeader Header;
- Error Err = Error::success();
- uint64_t Offset = 0;
- DWARFDataExtractor InfoData(Info, true, 0);
- std::tie(Header.Length, Header.Format) =
- InfoData.getInitialLength(&Offset, &Err);
- if (Err)
- return make_error<DWPError>("cannot parse compile unit length: " +
- llvm::toString(std::move(Err)));
- if (!InfoData.isValidOffset(Offset + (Header.Length - 1))) {
- return make_error<DWPError>(
- "compile unit exceeds .debug_info section range: " +
- utostr(Offset + Header.Length) + " >= " + utostr(InfoData.size()));
- }
- Header.Version = InfoData.getU16(&Offset, &Err);
- if (Err)
- return make_error<DWPError>("cannot parse compile unit version: " +
- llvm::toString(std::move(Err)));
- uint64_t MinHeaderLength;
- if (Header.Version >= 5) {
- // Size: Version (2), UnitType (1), AddrSize (1), DebugAbbrevOffset (4),
- // Signature (8)
- MinHeaderLength = 16;
- } else {
- // Size: Version (2), DebugAbbrevOffset (4), AddrSize (1)
- MinHeaderLength = 7;
- }
- if (Header.Length < MinHeaderLength) {
- return make_error<DWPError>("unit length is too small: expected at least " +
- utostr(MinHeaderLength) + " got " +
- utostr(Header.Length) + ".");
- }
- if (Header.Version >= 5) {
- Header.UnitType = InfoData.getU8(&Offset);
- Header.AddrSize = InfoData.getU8(&Offset);
- Header.DebugAbbrevOffset = InfoData.getU32(&Offset);
- Header.Signature = InfoData.getU64(&Offset);
- if (Header.UnitType == dwarf::DW_UT_split_type) {
- // Type offset.
- MinHeaderLength += 4;
- if (Header.Length < MinHeaderLength)
- return make_error<DWPError>("type unit is missing type offset");
- InfoData.getU32(&Offset);
- }
- } else {
- // Note that, address_size and debug_abbrev_offset fields have switched
- // places between dwarf version 4 and 5.
- Header.DebugAbbrevOffset = InfoData.getU32(&Offset);
- Header.AddrSize = InfoData.getU8(&Offset);
- }
- Header.HeaderSize = Offset;
- return Header;
- }
- void writeStringsAndOffsets(MCStreamer &Out, DWPStringPool &Strings,
- MCSection *StrOffsetSection,
- StringRef CurStrSection,
- StringRef CurStrOffsetSection, uint16_t Version) {
- // Could possibly produce an error or warning if one of these was non-null but
- // the other was null.
- if (CurStrSection.empty() || CurStrOffsetSection.empty())
- return;
- DenseMap<uint64_t, uint32_t> OffsetRemapping;
- DataExtractor Data(CurStrSection, true, 0);
- uint64_t LocalOffset = 0;
- uint64_t PrevOffset = 0;
- while (const char *S = Data.getCStr(&LocalOffset)) {
- OffsetRemapping[PrevOffset] =
- Strings.getOffset(S, LocalOffset - PrevOffset);
- PrevOffset = LocalOffset;
- }
- Data = DataExtractor(CurStrOffsetSection, true, 0);
- Out.switchSection(StrOffsetSection);
- uint64_t HeaderSize = debugStrOffsetsHeaderSize(Data, Version);
- uint64_t Offset = 0;
- uint64_t Size = CurStrOffsetSection.size();
- // FIXME: This can be caused by bad input and should be handled as such.
- assert(HeaderSize <= Size && "StrOffsetSection size is less than its header");
- // Copy the header to the output.
- Out.emitBytes(Data.getBytes(&Offset, HeaderSize));
- while (Offset < Size) {
- auto OldOffset = Data.getU32(&Offset);
- auto NewOffset = OffsetRemapping[OldOffset];
- Out.emitIntValue(NewOffset, 4);
- }
- }
- enum AccessField { Offset, Length };
- void writeIndexTable(MCStreamer &Out, ArrayRef<unsigned> ContributionOffsets,
- const MapVector<uint64_t, UnitIndexEntry> &IndexEntries,
- const AccessField &Field) {
- for (const auto &E : IndexEntries)
- for (size_t I = 0; I != std::size(E.second.Contributions); ++I)
- if (ContributionOffsets[I])
- Out.emitIntValue((Field == AccessField::Offset
- ? E.second.Contributions[I].getOffset32()
- : E.second.Contributions[I].getLength32()),
- 4);
- }
- void writeIndex(MCStreamer &Out, MCSection *Section,
- ArrayRef<unsigned> ContributionOffsets,
- const MapVector<uint64_t, UnitIndexEntry> &IndexEntries,
- uint32_t IndexVersion) {
- if (IndexEntries.empty())
- return;
- unsigned Columns = 0;
- for (auto &C : ContributionOffsets)
- if (C)
- ++Columns;
- std::vector<unsigned> Buckets(NextPowerOf2(3 * IndexEntries.size() / 2));
- uint64_t Mask = Buckets.size() - 1;
- size_t I = 0;
- for (const auto &P : IndexEntries) {
- auto S = P.first;
- auto H = S & Mask;
- auto HP = ((S >> 32) & Mask) | 1;
- while (Buckets[H]) {
- assert(S != IndexEntries.begin()[Buckets[H] - 1].first &&
- "Duplicate unit");
- H = (H + HP) & Mask;
- }
- Buckets[H] = I + 1;
- ++I;
- }
- Out.switchSection(Section);
- Out.emitIntValue(IndexVersion, 4); // Version
- Out.emitIntValue(Columns, 4); // Columns
- Out.emitIntValue(IndexEntries.size(), 4); // Num Units
- Out.emitIntValue(Buckets.size(), 4); // Num Buckets
- // Write the signatures.
- for (const auto &I : Buckets)
- Out.emitIntValue(I ? IndexEntries.begin()[I - 1].first : 0, 8);
- // Write the indexes.
- for (const auto &I : Buckets)
- Out.emitIntValue(I, 4);
- // Write the column headers (which sections will appear in the table)
- for (size_t I = 0; I != ContributionOffsets.size(); ++I)
- if (ContributionOffsets[I])
- Out.emitIntValue(getOnDiskSectionId(I), 4);
- // Write the offsets.
- writeIndexTable(Out, ContributionOffsets, IndexEntries, AccessField::Offset);
- // Write the lengths.
- writeIndexTable(Out, ContributionOffsets, IndexEntries, AccessField::Length);
- }
- Error buildDuplicateError(const std::pair<uint64_t, UnitIndexEntry> &PrevE,
- const CompileUnitIdentifiers &ID, StringRef DWPName) {
- return make_error<DWPError>(
- std::string("duplicate DWO ID (") + utohexstr(PrevE.first) + ") in " +
- buildDWODescription(PrevE.second.Name, PrevE.second.DWPName,
- PrevE.second.DWOName) +
- " and " + buildDWODescription(ID.Name, DWPName, ID.DWOName));
- }
- Error handleSection(
- const StringMap<std::pair<MCSection *, DWARFSectionKind>> &KnownSections,
- const MCSection *StrSection, const MCSection *StrOffsetSection,
- const MCSection *TypesSection, const MCSection *CUIndexSection,
- const MCSection *TUIndexSection, const MCSection *InfoSection,
- const SectionRef &Section, MCStreamer &Out,
- std::deque<SmallString<32>> &UncompressedSections,
- uint32_t (&ContributionOffsets)[8], UnitIndexEntry &CurEntry,
- StringRef &CurStrSection, StringRef &CurStrOffsetSection,
- std::vector<StringRef> &CurTypesSection,
- std::vector<StringRef> &CurInfoSection, StringRef &AbbrevSection,
- StringRef &CurCUIndexSection, StringRef &CurTUIndexSection,
- std::vector<std::pair<DWARFSectionKind, uint32_t>> &SectionLength) {
- if (Section.isBSS())
- return Error::success();
- if (Section.isVirtual())
- return Error::success();
- Expected<StringRef> NameOrErr = Section.getName();
- if (!NameOrErr)
- return NameOrErr.takeError();
- StringRef Name = *NameOrErr;
- Expected<StringRef> ContentsOrErr = Section.getContents();
- if (!ContentsOrErr)
- return ContentsOrErr.takeError();
- StringRef Contents = *ContentsOrErr;
- if (auto Err = handleCompressedSection(UncompressedSections, Section, Name,
- Contents))
- return Err;
- Name = Name.substr(Name.find_first_not_of("._"));
- auto SectionPair = KnownSections.find(Name);
- if (SectionPair == KnownSections.end())
- return Error::success();
- if (DWARFSectionKind Kind = SectionPair->second.second) {
- if (Kind != DW_SECT_EXT_TYPES && Kind != DW_SECT_INFO) {
- SectionLength.push_back(std::make_pair(Kind, Contents.size()));
- }
- if (Kind == DW_SECT_ABBREV) {
- AbbrevSection = Contents;
- }
- }
- MCSection *OutSection = SectionPair->second.first;
- if (OutSection == StrOffsetSection)
- CurStrOffsetSection = Contents;
- else if (OutSection == StrSection)
- CurStrSection = Contents;
- else if (OutSection == TypesSection)
- CurTypesSection.push_back(Contents);
- else if (OutSection == CUIndexSection)
- CurCUIndexSection = Contents;
- else if (OutSection == TUIndexSection)
- CurTUIndexSection = Contents;
- else if (OutSection == InfoSection)
- CurInfoSection.push_back(Contents);
- else {
- Out.switchSection(OutSection);
- Out.emitBytes(Contents);
- }
- return Error::success();
- }
- Error write(MCStreamer &Out, ArrayRef<std::string> Inputs) {
- const auto &MCOFI = *Out.getContext().getObjectFileInfo();
- MCSection *const StrSection = MCOFI.getDwarfStrDWOSection();
- MCSection *const StrOffsetSection = MCOFI.getDwarfStrOffDWOSection();
- MCSection *const TypesSection = MCOFI.getDwarfTypesDWOSection();
- MCSection *const CUIndexSection = MCOFI.getDwarfCUIndexSection();
- MCSection *const TUIndexSection = MCOFI.getDwarfTUIndexSection();
- MCSection *const InfoSection = MCOFI.getDwarfInfoDWOSection();
- const StringMap<std::pair<MCSection *, DWARFSectionKind>> KnownSections = {
- {"debug_info.dwo", {InfoSection, DW_SECT_INFO}},
- {"debug_types.dwo", {MCOFI.getDwarfTypesDWOSection(), DW_SECT_EXT_TYPES}},
- {"debug_str_offsets.dwo", {StrOffsetSection, DW_SECT_STR_OFFSETS}},
- {"debug_str.dwo", {StrSection, static_cast<DWARFSectionKind>(0)}},
- {"debug_loc.dwo", {MCOFI.getDwarfLocDWOSection(), DW_SECT_EXT_LOC}},
- {"debug_line.dwo", {MCOFI.getDwarfLineDWOSection(), DW_SECT_LINE}},
- {"debug_macro.dwo", {MCOFI.getDwarfMacroDWOSection(), DW_SECT_MACRO}},
- {"debug_abbrev.dwo", {MCOFI.getDwarfAbbrevDWOSection(), DW_SECT_ABBREV}},
- {"debug_loclists.dwo",
- {MCOFI.getDwarfLoclistsDWOSection(), DW_SECT_LOCLISTS}},
- {"debug_rnglists.dwo",
- {MCOFI.getDwarfRnglistsDWOSection(), DW_SECT_RNGLISTS}},
- {"debug_cu_index", {CUIndexSection, static_cast<DWARFSectionKind>(0)}},
- {"debug_tu_index", {TUIndexSection, static_cast<DWARFSectionKind>(0)}}};
- MapVector<uint64_t, UnitIndexEntry> IndexEntries;
- MapVector<uint64_t, UnitIndexEntry> TypeIndexEntries;
- uint32_t ContributionOffsets[8] = {};
- uint16_t Version = 0;
- uint32_t IndexVersion = 0;
- DWPStringPool Strings(Out, StrSection);
- SmallVector<OwningBinary<object::ObjectFile>, 128> Objects;
- Objects.reserve(Inputs.size());
- std::deque<SmallString<32>> UncompressedSections;
- for (const auto &Input : Inputs) {
- auto ErrOrObj = object::ObjectFile::createObjectFile(Input);
- if (!ErrOrObj) {
- return handleErrors(ErrOrObj.takeError(),
- [&](std::unique_ptr<ECError> EC) -> Error {
- return createFileError(Input, Error(std::move(EC)));
- });
- }
- auto &Obj = *ErrOrObj->getBinary();
- Objects.push_back(std::move(*ErrOrObj));
- UnitIndexEntry CurEntry = {};
- StringRef CurStrSection;
- StringRef CurStrOffsetSection;
- std::vector<StringRef> CurTypesSection;
- std::vector<StringRef> CurInfoSection;
- StringRef AbbrevSection;
- StringRef CurCUIndexSection;
- StringRef CurTUIndexSection;
- // This maps each section contained in this file to its length.
- // This information is later on used to calculate the contributions,
- // i.e. offset and length, of each compile/type unit to a section.
- std::vector<std::pair<DWARFSectionKind, uint32_t>> SectionLength;
- for (const auto &Section : Obj.sections())
- if (auto Err = handleSection(
- KnownSections, StrSection, StrOffsetSection, TypesSection,
- CUIndexSection, TUIndexSection, InfoSection, Section, Out,
- UncompressedSections, ContributionOffsets, CurEntry,
- CurStrSection, CurStrOffsetSection, CurTypesSection,
- CurInfoSection, AbbrevSection, CurCUIndexSection,
- CurTUIndexSection, SectionLength))
- return Err;
- if (CurInfoSection.empty())
- continue;
- Expected<InfoSectionUnitHeader> HeaderOrErr =
- parseInfoSectionUnitHeader(CurInfoSection.front());
- if (!HeaderOrErr)
- return HeaderOrErr.takeError();
- InfoSectionUnitHeader &Header = *HeaderOrErr;
- if (Version == 0) {
- Version = Header.Version;
- IndexVersion = Version < 5 ? 2 : 5;
- } else if (Version != Header.Version) {
- return make_error<DWPError>("incompatible DWARF compile unit versions.");
- }
- writeStringsAndOffsets(Out, Strings, StrOffsetSection, CurStrSection,
- CurStrOffsetSection, Header.Version);
- for (auto Pair : SectionLength) {
- auto Index = getContributionIndex(Pair.first, IndexVersion);
- CurEntry.Contributions[Index].setOffset(ContributionOffsets[Index]);
- CurEntry.Contributions[Index].setLength(Pair.second);
- ContributionOffsets[Index] += CurEntry.Contributions[Index].getLength32();
- }
- uint32_t &InfoSectionOffset =
- ContributionOffsets[getContributionIndex(DW_SECT_INFO, IndexVersion)];
- if (CurCUIndexSection.empty()) {
- bool FoundCUUnit = false;
- Out.switchSection(InfoSection);
- for (StringRef Info : CurInfoSection) {
- uint64_t UnitOffset = 0;
- while (Info.size() > UnitOffset) {
- Expected<InfoSectionUnitHeader> HeaderOrError =
- parseInfoSectionUnitHeader(Info.substr(UnitOffset, Info.size()));
- if (!HeaderOrError)
- return HeaderOrError.takeError();
- InfoSectionUnitHeader &Header = *HeaderOrError;
- UnitIndexEntry Entry = CurEntry;
- auto &C = Entry.Contributions[getContributionIndex(DW_SECT_INFO,
- IndexVersion)];
- C.setOffset(InfoSectionOffset);
- C.setLength(Header.Length + 4);
- if (std::numeric_limits<uint32_t>::max() - InfoSectionOffset <
- C.getLength32())
- return make_error<DWPError>(
- "debug information section offset is greater than 4GB");
- UnitOffset += C.getLength32();
- if (Header.Version < 5 ||
- Header.UnitType == dwarf::DW_UT_split_compile) {
- Expected<CompileUnitIdentifiers> EID = getCUIdentifiers(
- Header, AbbrevSection,
- Info.substr(UnitOffset - C.getLength32(), C.getLength32()),
- CurStrOffsetSection, CurStrSection);
- if (!EID)
- return createFileError(Input, EID.takeError());
- const auto &ID = *EID;
- auto P = IndexEntries.insert(std::make_pair(ID.Signature, Entry));
- if (!P.second)
- return buildDuplicateError(*P.first, ID, "");
- P.first->second.Name = ID.Name;
- P.first->second.DWOName = ID.DWOName;
- FoundCUUnit = true;
- } else if (Header.UnitType == dwarf::DW_UT_split_type) {
- auto P = TypeIndexEntries.insert(
- std::make_pair(*Header.Signature, Entry));
- if (!P.second)
- continue;
- }
- Out.emitBytes(
- Info.substr(UnitOffset - C.getLength32(), C.getLength32()));
- InfoSectionOffset += C.getLength32();
- }
- }
- if (!FoundCUUnit)
- return make_error<DWPError>("no compile unit found in file: " + Input);
- if (IndexVersion == 2) {
- // Add types from the .debug_types section from DWARF < 5.
- addAllTypesFromTypesSection(
- Out, TypeIndexEntries, TypesSection, CurTypesSection, CurEntry,
- ContributionOffsets[getContributionIndex(DW_SECT_EXT_TYPES, 2)]);
- }
- continue;
- }
- if (CurInfoSection.size() != 1)
- return make_error<DWPError>("expected exactly one occurrence of a debug "
- "info section in a .dwp file");
- StringRef DwpSingleInfoSection = CurInfoSection.front();
- DWARFUnitIndex CUIndex(DW_SECT_INFO);
- DataExtractor CUIndexData(CurCUIndexSection, Obj.isLittleEndian(), 0);
- if (!CUIndex.parse(CUIndexData))
- return make_error<DWPError>("failed to parse cu_index");
- if (CUIndex.getVersion() != IndexVersion)
- return make_error<DWPError>("incompatible cu_index versions, found " +
- utostr(CUIndex.getVersion()) +
- " and expecting " + utostr(IndexVersion));
- Out.switchSection(InfoSection);
- for (const DWARFUnitIndex::Entry &E : CUIndex.getRows()) {
- auto *I = E.getContributions();
- if (!I)
- continue;
- auto P = IndexEntries.insert(std::make_pair(E.getSignature(), CurEntry));
- StringRef CUInfoSection =
- getSubsection(DwpSingleInfoSection, E, DW_SECT_INFO);
- Expected<InfoSectionUnitHeader> HeaderOrError =
- parseInfoSectionUnitHeader(CUInfoSection);
- if (!HeaderOrError)
- return HeaderOrError.takeError();
- InfoSectionUnitHeader &Header = *HeaderOrError;
- Expected<CompileUnitIdentifiers> EID = getCUIdentifiers(
- Header, getSubsection(AbbrevSection, E, DW_SECT_ABBREV),
- CUInfoSection,
- getSubsection(CurStrOffsetSection, E, DW_SECT_STR_OFFSETS),
- CurStrSection);
- if (!EID)
- return createFileError(Input, EID.takeError());
- const auto &ID = *EID;
- if (!P.second)
- return buildDuplicateError(*P.first, ID, Input);
- auto &NewEntry = P.first->second;
- NewEntry.Name = ID.Name;
- NewEntry.DWOName = ID.DWOName;
- NewEntry.DWPName = Input;
- for (auto Kind : CUIndex.getColumnKinds()) {
- if (!isSupportedSectionKind(Kind))
- continue;
- auto &C =
- NewEntry.Contributions[getContributionIndex(Kind, IndexVersion)];
- C.setOffset(C.getOffset() + I->getOffset());
- C.setLength(I->getLength());
- ++I;
- }
- unsigned Index = getContributionIndex(DW_SECT_INFO, IndexVersion);
- auto &C = NewEntry.Contributions[Index];
- Out.emitBytes(CUInfoSection);
- C.setOffset(InfoSectionOffset);
- InfoSectionOffset += C.getLength32();
- }
- if (!CurTUIndexSection.empty()) {
- llvm::DWARFSectionKind TUSectionKind;
- MCSection *OutSection;
- StringRef TypeInputSection;
- // Write type units into debug info section for DWARFv5.
- if (Version >= 5) {
- TUSectionKind = DW_SECT_INFO;
- OutSection = InfoSection;
- TypeInputSection = DwpSingleInfoSection;
- } else {
- // Write type units into debug types section for DWARF < 5.
- if (CurTypesSection.size() != 1)
- return make_error<DWPError>(
- "multiple type unit sections in .dwp file");
- TUSectionKind = DW_SECT_EXT_TYPES;
- OutSection = TypesSection;
- TypeInputSection = CurTypesSection.front();
- }
- DWARFUnitIndex TUIndex(TUSectionKind);
- DataExtractor TUIndexData(CurTUIndexSection, Obj.isLittleEndian(), 0);
- if (!TUIndex.parse(TUIndexData))
- return make_error<DWPError>("failed to parse tu_index");
- if (TUIndex.getVersion() != IndexVersion)
- return make_error<DWPError>("incompatible tu_index versions, found " +
- utostr(TUIndex.getVersion()) +
- " and expecting " + utostr(IndexVersion));
- unsigned TypesContributionIndex =
- getContributionIndex(TUSectionKind, IndexVersion);
- addAllTypesFromDWP(Out, TypeIndexEntries, TUIndex, OutSection,
- TypeInputSection, CurEntry,
- ContributionOffsets[TypesContributionIndex],
- TypesContributionIndex);
- }
- }
- if (Version < 5) {
- // Lie about there being no info contributions so the TU index only includes
- // the type unit contribution for DWARF < 5. In DWARFv5 the TU index has a
- // contribution to the info section, so we do not want to lie about it.
- ContributionOffsets[0] = 0;
- }
- writeIndex(Out, MCOFI.getDwarfTUIndexSection(), ContributionOffsets,
- TypeIndexEntries, IndexVersion);
- if (Version < 5) {
- // Lie about the type contribution for DWARF < 5. In DWARFv5 the type
- // section does not exist, so no need to do anything about this.
- ContributionOffsets[getContributionIndex(DW_SECT_EXT_TYPES, 2)] = 0;
- // Unlie about the info contribution
- ContributionOffsets[0] = 1;
- }
- writeIndex(Out, MCOFI.getDwarfCUIndexSection(), ContributionOffsets,
- IndexEntries, IndexVersion);
- return Error::success();
- }
- } // namespace llvm
|