1 #include "llvm/ADT/STLExtras.h"
2 #include "llvm/ADT/StringSet.h"
3 #include "llvm/CodeGen/AsmPrinter.h"
4 #include "llvm/DebugInfo/DWARF/DWARFFormValue.h"
5 #include "llvm/DebugInfo/DWARF/DWARFUnitIndex.h"
6 #include "llvm/MC/MCAsmInfo.h"
7 #include "llvm/MC/MCContext.h"
8 #include "llvm/MC/MCInstrInfo.h"
9 #include "llvm/MC/MCObjectFileInfo.h"
10 #include "llvm/MC/MCRegisterInfo.h"
11 #include "llvm/MC/MCSectionELF.h"
12 #include "llvm/MC/MCStreamer.h"
13 #include "llvm/Object/ObjectFile.h"
14 #include "llvm/Support/DataExtractor.h"
15 #include "llvm/Support/FileSystem.h"
16 #include "llvm/Support/MathExtras.h"
17 #include "llvm/Support/MemoryBuffer.h"
18 #include "llvm/Support/Options.h"
19 #include "llvm/Support/TargetRegistry.h"
20 #include "llvm/Support/TargetSelect.h"
21 #include "llvm/Support/raw_ostream.h"
22 #include "llvm/Target/TargetMachine.h"
25 #include <unordered_set>
28 using namespace llvm::object;
31 OptionCategory DwpCategory("Specific Options");
32 static list<std::string> InputFiles(Positional, OneOrMore,
33 desc("<input files>"), cat(DwpCategory));
35 static opt<std::string> OutputFilename(Required, "o",
36 desc("Specify the output file."),
37 value_desc("filename"),
40 static int error(const Twine &Error, const Twine &Context) {
41 errs() << Twine("while processing ") + Context + ":\n";
42 errs() << Twine("error: ") + Error + "\n";
46 static std::error_code
47 writeStringsAndOffsets(MCStreamer &Out, StringMap<uint32_t> &Strings,
48 uint32_t &StringOffset, MCSection *StrSection,
49 MCSection *StrOffsetSection, StringRef CurStrSection,
50 StringRef CurStrOffsetSection) {
51 // Could possibly produce an error or warning if one of these was non-null but
52 // the other was null.
53 if (CurStrSection.empty() || CurStrOffsetSection.empty())
54 return std::error_code();
56 DenseMap<uint32_t, uint32_t> OffsetRemapping;
58 DataExtractor Data(CurStrSection, true, 0);
59 uint32_t LocalOffset = 0;
60 uint32_t PrevOffset = 0;
61 while (const char *s = Data.getCStr(&LocalOffset)) {
62 StringRef Str(s, LocalOffset - PrevOffset - 1);
63 auto Pair = Strings.insert(std::make_pair(Str, StringOffset));
65 Out.SwitchSection(StrSection);
67 StringRef(Pair.first->getKeyData(), Pair.first->getKeyLength() + 1));
68 StringOffset += Str.size() + 1;
70 OffsetRemapping[PrevOffset] = Pair.first->second;
71 PrevOffset = LocalOffset;
74 Data = DataExtractor(CurStrOffsetSection, true, 0);
76 Out.SwitchSection(StrOffsetSection);
79 uint64_t Size = CurStrOffsetSection.size();
80 while (Offset < Size) {
81 auto OldOffset = Data.getU32(&Offset);
82 auto NewOffset = OffsetRemapping[OldOffset];
83 Out.EmitIntValue(NewOffset, 4);
86 return std::error_code();
89 static uint32_t getCUAbbrev(StringRef Abbrev, uint64_t AbbrCode) {
92 DataExtractor AbbrevData(Abbrev, true, 0);
93 while ((CurCode = AbbrevData.getULEB128(&Offset)) != AbbrCode) {
95 AbbrevData.getULEB128(&Offset);
97 AbbrevData.getU8(&Offset);
99 while (AbbrevData.getULEB128(&Offset) | AbbrevData.getULEB128(&Offset))
105 static uint64_t getCUSignature(StringRef Abbrev, StringRef Info) {
107 DataExtractor InfoData(Info, true, 0);
108 InfoData.getU32(&Offset); // Length
109 uint16_t Version = InfoData.getU16(&Offset);
110 InfoData.getU32(&Offset); // Abbrev offset (should be zero)
111 uint8_t AddrSize = InfoData.getU8(&Offset);
113 uint32_t AbbrCode = InfoData.getULEB128(&Offset);
115 DataExtractor AbbrevData(Abbrev, true, 0);
116 uint32_t AbbrevOffset = getCUAbbrev(Abbrev, AbbrCode);
117 uint64_t Tag = AbbrevData.getULEB128(&AbbrevOffset);
119 // FIXME: Real error handling
120 assert(Tag == dwarf::DW_TAG_compile_unit);
122 AbbrevData.getU8(&AbbrevOffset);
125 while ((Name = AbbrevData.getULEB128(&AbbrevOffset)) |
126 (Form = AbbrevData.getULEB128(&AbbrevOffset)) &&
127 Name != dwarf::DW_AT_GNU_dwo_id) {
128 DWARFFormValue::skipValue(Form, InfoData, &Offset, Version, AddrSize);
130 // FIXME: Real error handling
131 assert(Name == dwarf::DW_AT_GNU_dwo_id);
132 return InfoData.getU64(&Offset);
135 struct UnitIndexEntry {
137 DWARFUnitIndex::Entry::SectionContribution Contributions[8];
140 static void addAllTypes(MCStreamer &Out,
141 std::vector<UnitIndexEntry> &TypeIndexEntries,
142 MCSection *OutputTypes, StringRef Types,
143 const UnitIndexEntry &CUEntry, uint32_t &TypesOffset) {
147 Out.SwitchSection(OutputTypes);
149 DataExtractor Data(Types, true, 0);
150 while (Data.isValidOffset(Offset)) {
151 TypeIndexEntries.push_back(CUEntry);
152 auto &Entry = TypeIndexEntries.back();
153 // Zero out the debug_info contribution
154 Entry.Contributions[0] = {};
155 auto &C = Entry.Contributions[DW_SECT_TYPES - DW_SECT_INFO];
156 C.Offset = TypesOffset + Offset;
157 auto PrevOffset = Offset;
158 // Length of the unit, including the 4 byte length field.
159 C.Length = Data.getU32(&Offset) + 4;
161 Out.EmitBytes(Types.substr(Offset - 4, C.Length));
162 TypesOffset += C.Length;
164 Data.getU16(&Offset); // Version
165 Data.getU32(&Offset); // Abbrev offset
166 Data.getU8(&Offset); // Address size
167 Entry.Signature = Data.getU64(&Offset);
168 Offset = PrevOffset + C.Length;
173 writeIndexTable(MCStreamer &Out, ArrayRef<unsigned> ContributionOffsets,
174 ArrayRef<UnitIndexEntry> IndexEntries,
175 uint32_t DWARFUnitIndex::Entry::SectionContribution::*Field) {
176 for (const auto &E : IndexEntries)
177 for (size_t i = 0; i != array_lengthof(E.Contributions); ++i)
178 if (ContributionOffsets[i])
179 Out.EmitIntValue(E.Contributions[i].*Field, 4);
182 static void writeIndex(MCStreamer &Out, MCSection *Section,
183 ArrayRef<unsigned> ContributionOffsets,
184 ArrayRef<UnitIndexEntry> IndexEntries) {
185 unsigned Columns = 0;
186 for (auto &C : ContributionOffsets)
190 std::vector<unsigned> Buckets(NextPowerOf2(3 * IndexEntries.size() / 2));
191 uint64_t Mask = Buckets.size() - 1;
192 for (size_t i = 0; i != IndexEntries.size(); ++i) {
193 auto S = IndexEntries[i].Signature;
196 assert(S != IndexEntries[Buckets[H] - 1].Signature &&
197 "Duplicate type unit");
198 H += ((S >> 32) & Mask) | 1;
203 Out.SwitchSection(Section);
204 Out.EmitIntValue(2, 4); // Version
205 Out.EmitIntValue(Columns, 4); // Columns
206 Out.EmitIntValue(IndexEntries.size(), 4); // Num Units
207 Out.EmitIntValue(Buckets.size(), 4); // Num Buckets
209 // Write the signatures.
210 for (const auto &I : Buckets)
211 Out.EmitIntValue(I ? IndexEntries[I - 1].Signature : 0, 8);
213 // Write the indexes.
214 for (const auto &I : Buckets)
215 Out.EmitIntValue(I, 4);
217 // Write the column headers (which sections will appear in the table)
218 for (size_t i = 0; i != ContributionOffsets.size(); ++i)
219 if (ContributionOffsets[i])
220 Out.EmitIntValue(i + DW_SECT_INFO, 4);
222 // Write the offsets.
223 writeIndexTable(Out, ContributionOffsets, IndexEntries,
224 &DWARFUnitIndex::Entry::SectionContribution::Offset);
226 // Write the lengths.
227 writeIndexTable(Out, ContributionOffsets, IndexEntries,
228 &DWARFUnitIndex::Entry::SectionContribution::Length);
230 static std::error_code write(MCStreamer &Out, ArrayRef<std::string> Inputs) {
231 const auto &MCOFI = *Out.getContext().getObjectFileInfo();
232 MCSection *const StrSection = MCOFI.getDwarfStrDWOSection();
233 MCSection *const StrOffsetSection = MCOFI.getDwarfStrOffDWOSection();
234 MCSection *const TypesSection = MCOFI.getDwarfTypesDWOSection();
235 const StringMap<std::pair<MCSection *, DWARFSectionKind>> KnownSections = {
236 {"debug_info.dwo", {MCOFI.getDwarfInfoDWOSection(), DW_SECT_INFO}},
237 {"debug_types.dwo", {MCOFI.getDwarfTypesDWOSection(), DW_SECT_TYPES}},
238 {"debug_str_offsets.dwo", {StrOffsetSection, DW_SECT_STR_OFFSETS}},
239 {"debug_str.dwo", {StrSection, static_cast<DWARFSectionKind>(0)}},
240 {"debug_loc.dwo", {MCOFI.getDwarfLocDWOSection(), DW_SECT_LOC}},
241 {"debug_line.dwo", {MCOFI.getDwarfLineDWOSection(), DW_SECT_LINE}},
242 {"debug_abbrev.dwo", {MCOFI.getDwarfAbbrevDWOSection(), DW_SECT_ABBREV}}};
244 std::vector<UnitIndexEntry> IndexEntries;
245 std::vector<UnitIndexEntry> TypeIndexEntries;
247 StringMap<uint32_t> Strings;
248 uint32_t StringOffset = 0;
250 uint32_t ContributionOffsets[8] = {};
252 for (const auto &Input : Inputs) {
253 auto ErrOrObj = object::ObjectFile::createObjectFile(Input);
255 return ErrOrObj.getError();
257 IndexEntries.emplace_back();
258 UnitIndexEntry &CurEntry = IndexEntries.back();
260 StringRef CurStrSection;
261 StringRef CurStrOffsetSection;
262 StringRef CurTypesSection;
263 StringRef InfoSection;
264 StringRef AbbrevSection;
266 for (const auto &Section : ErrOrObj->getBinary()->sections()) {
268 if (std::error_code Err = Section.getName(Name))
272 KnownSections.find(Name.substr(Name.find_first_not_of("._")));
273 if (SectionPair == KnownSections.end())
277 if (auto Err = Section.getContents(Contents))
280 if (DWARFSectionKind Kind = SectionPair->second.second) {
281 auto Index = Kind - DW_SECT_INFO;
282 if (Kind != DW_SECT_TYPES) {
283 CurEntry.Contributions[Index].Offset = ContributionOffsets[Index];
284 ContributionOffsets[Index] +=
285 (CurEntry.Contributions[Index].Length = Contents.size());
290 InfoSection = Contents;
293 AbbrevSection = Contents;
300 MCSection *OutSection = SectionPair->second.first;
301 if (OutSection == StrOffsetSection)
302 CurStrOffsetSection = Contents;
303 else if (OutSection == StrSection)
304 CurStrSection = Contents;
305 else if (OutSection == TypesSection)
306 CurTypesSection = Contents;
308 Out.SwitchSection(OutSection);
309 Out.EmitBytes(Contents);
313 assert(!AbbrevSection.empty());
314 assert(!InfoSection.empty());
315 CurEntry.Signature = getCUSignature(AbbrevSection, InfoSection);
316 addAllTypes(Out, TypeIndexEntries, TypesSection, CurTypesSection, CurEntry,
317 ContributionOffsets[DW_SECT_TYPES - DW_SECT_INFO]);
319 if (auto Err = writeStringsAndOffsets(Out, Strings, StringOffset,
320 StrSection, StrOffsetSection,
321 CurStrSection, CurStrOffsetSection))
325 if (!TypeIndexEntries.empty()) {
326 // Lie about there being no info contributions so the TU index only includes
327 // the type unit contribution
328 ContributionOffsets[0] = 0;
329 writeIndex(Out, MCOFI.getDwarfTUIndexSection(), ContributionOffsets,
333 // Lie about the type contribution
334 ContributionOffsets[DW_SECT_TYPES - DW_SECT_INFO] = 0;
335 // Unlie about the info contribution
336 ContributionOffsets[0] = 1;
338 writeIndex(Out, MCOFI.getDwarfCUIndexSection(), ContributionOffsets,
341 return std::error_code();
344 int main(int argc, char **argv) {
346 ParseCommandLineOptions(argc, argv, "merge split dwarf (.dwo) files");
348 llvm::InitializeAllTargetInfos();
349 llvm::InitializeAllTargetMCs();
350 llvm::InitializeAllTargets();
351 llvm::InitializeAllAsmPrinters();
353 std::string ErrorStr;
354 StringRef Context = "dwarf streamer init";
356 Triple TheTriple("x86_64-linux-gnu");
359 const Target *TheTarget =
360 TargetRegistry::lookupTarget("", TheTriple, ErrorStr);
362 return error(ErrorStr, Context);
363 std::string TripleName = TheTriple.getTriple();
365 // Create all the MC Objects.
366 std::unique_ptr<MCRegisterInfo> MRI(TheTarget->createMCRegInfo(TripleName));
368 return error(Twine("no register info for target ") + TripleName, Context);
370 std::unique_ptr<MCAsmInfo> MAI(TheTarget->createMCAsmInfo(*MRI, TripleName));
372 return error("no asm info for target " + TripleName, Context);
374 MCObjectFileInfo MOFI;
375 MCContext MC(MAI.get(), MRI.get(), &MOFI);
376 MOFI.InitMCObjectFileInfo(TheTriple, Reloc::Default, CodeModel::Default, MC);
378 auto MAB = TheTarget->createMCAsmBackend(*MRI, TripleName, "");
380 return error("no asm backend for target " + TripleName, Context);
382 std::unique_ptr<MCInstrInfo> MII(TheTarget->createMCInstrInfo());
384 return error("no instr info info for target " + TripleName, Context);
386 std::unique_ptr<MCSubtargetInfo> MSTI(
387 TheTarget->createMCSubtargetInfo(TripleName, "", ""));
389 return error("no subtarget info for target " + TripleName, Context);
391 MCCodeEmitter *MCE = TheTarget->createMCCodeEmitter(*MII, *MRI, MC);
393 return error("no code emitter for target " + TripleName, Context);
395 // Create the output file.
397 raw_fd_ostream OutFile(OutputFilename, EC, sys::fs::F_None);
399 return error(Twine(OutputFilename) + ": " + EC.message(), Context);
401 std::unique_ptr<MCStreamer> MS(TheTarget->createMCObjectStreamer(
402 TheTriple, MC, *MAB, OutFile, MCE, *MSTI, false,
403 /*DWARFMustBeAtTheEnd*/ false));
405 return error("no object streamer for target " + TripleName, Context);
407 if (auto Err = write(*MS, InputFiles))
408 return error(Err.message(), "Writing DWP file");