LCOV - code coverage report
Current view: top level - lib/ObjectYAML - DWARFEmitter.cpp (source / functions) Hit Total Coverage
Test: llvm-toolchain.info Lines: 176 214 82.2 %
Date: 2018-06-17 00:07:59 Functions: 24 35 68.6 %
Legend: Lines: hit not hit

          Line data    Source code
       1             : //===- DWARFEmitter - Convert YAML to DWARF binary data -------------------===//
       2             : //
       3             : //                     The LLVM Compiler Infrastructure
       4             : //
       5             : // This file is distributed under the University of Illinois Open Source
       6             : // License. See LICENSE.TXT for details.
       7             : //
       8             : //===----------------------------------------------------------------------===//
       9             : ///
      10             : /// \file
      11             : /// The DWARF component of yaml2obj. Provided as library code for tests.
      12             : ///
      13             : //===----------------------------------------------------------------------===//
      14             : 
      15             : #include "llvm/ObjectYAML/DWARFEmitter.h"
      16             : #include "DWARFVisitor.h"
      17             : #include "llvm/ADT/StringMap.h"
      18             : #include "llvm/ADT/StringRef.h"
      19             : #include "llvm/ObjectYAML/DWARFYAML.h"
      20             : #include "llvm/Support/Error.h"
      21             : #include "llvm/Support/Host.h"
      22             : #include "llvm/Support/LEB128.h"
      23             : #include "llvm/Support/MathExtras.h"
      24             : #include "llvm/Support/MemoryBuffer.h"
      25             : #include "llvm/Support/SwapByteOrder.h"
      26             : #include "llvm/Support/YAMLTraits.h"
      27             : #include "llvm/Support/raw_ostream.h"
      28             : #include <algorithm>
      29             : #include <cassert>
      30             : #include <cstddef>
      31             : #include <cstdint>
      32             : #include <memory>
      33             : #include <string>
      34             : #include <vector>
      35             : 
      36             : using namespace llvm;
      37             : 
      38             : template <typename T>
      39             : static void writeInteger(T Integer, raw_ostream &OS, bool IsLittleEndian) {
      40         384 :   if (IsLittleEndian != sys::IsLittleEndianHost)
      41             :     sys::swapByteOrder(Integer);
      42         692 :   OS.write(reinterpret_cast<char *>(&Integer), sizeof(T));
      43             : }
      44             : 
      45          28 : static void writeVariableSizedInteger(uint64_t Integer, size_t Size,
      46             :                                       raw_ostream &OS, bool IsLittleEndian) {
      47          28 :   if (8 == Size)
      48             :     writeInteger((uint64_t)Integer, OS, IsLittleEndian);
      49           9 :   else if (4 == Size)
      50           9 :     writeInteger((uint32_t)Integer, OS, IsLittleEndian);
      51           0 :   else if (2 == Size)
      52           0 :     writeInteger((uint16_t)Integer, OS, IsLittleEndian);
      53           0 :   else if (1 == Size)
      54           0 :     writeInteger((uint8_t)Integer, OS, IsLittleEndian);
      55             :   else
      56             :     assert(false && "Invalid integer write size.");
      57          28 : }
      58             : 
      59          10 : static void ZeroFillBytes(raw_ostream &OS, size_t Size) {
      60             :   std::vector<uint8_t> FillData;
      61          20 :   FillData.insert(FillData.begin(), Size, 0);
      62          10 :   OS.write(reinterpret_cast<char *>(FillData.data()), Size);
      63          10 : }
      64             : 
      65          59 : static void writeInitialLength(const DWARFYAML::InitialLength &Length,
      66             :                                raw_ostream &OS, bool IsLittleEndian) {
      67          59 :   writeInteger((uint32_t)Length.TotalLength, OS, IsLittleEndian);
      68          59 :   if (Length.isDWARF64())
      69           0 :     writeInteger((uint64_t)Length.TotalLength64, OS, IsLittleEndian);
      70          59 : }
      71             : 
      72          31 : void DWARFYAML::EmitDebugStr(raw_ostream &OS, const DWARFYAML::Data &DI) {
      73          31 :   for (auto Str : DI.DebugStrings) {
      74         102 :     OS.write(Str.data(), Str.size());
      75         102 :     OS.write('\0');
      76             :   }
      77          31 : }
      78             : 
      79          31 : void DWARFYAML::EmitDebugAbbrev(raw_ostream &OS, const DWARFYAML::Data &DI) {
      80          31 :   for (auto AbbrevDecl : DI.AbbrevDecls) {
      81          70 :     encodeULEB128(AbbrevDecl.Code, OS);
      82          70 :     encodeULEB128(AbbrevDecl.Tag, OS);
      83          70 :     OS.write(AbbrevDecl.Children);
      84         346 :     for (auto Attr : AbbrevDecl.Attributes) {
      85         276 :       encodeULEB128(Attr.Attribute, OS);
      86         276 :       encodeULEB128(Attr.Form, OS);
      87         276 :       if (Attr.Form == dwarf::DW_FORM_implicit_const)
      88           1 :         encodeSLEB128(Attr.Value, OS);
      89             :     }
      90          70 :     encodeULEB128(0, OS);
      91          70 :     encodeULEB128(0, OS);
      92             :   }
      93          31 : }
      94             : 
      95          29 : void DWARFYAML::EmitDebugAranges(raw_ostream &OS, const DWARFYAML::Data &DI) {
      96          29 :   for (auto Range : DI.ARanges) {
      97             :     auto HeaderStart = OS.tell();
      98           5 :     writeInitialLength(Range.Length, OS, DI.IsLittleEndian);
      99           5 :     writeInteger((uint16_t)Range.Version, OS, DI.IsLittleEndian);
     100           5 :     writeInteger((uint32_t)Range.CuOffset, OS, DI.IsLittleEndian);
     101           5 :     writeInteger((uint8_t)Range.AddrSize, OS, DI.IsLittleEndian);
     102           5 :     writeInteger((uint8_t)Range.SegSize, OS, DI.IsLittleEndian);
     103             : 
     104           5 :     auto HeaderSize = OS.tell() - HeaderStart;
     105           5 :     auto FirstDescriptor = alignTo(HeaderSize, Range.AddrSize * 2);
     106           5 :     ZeroFillBytes(OS, FirstDescriptor - HeaderSize);
     107             : 
     108          10 :     for (auto Descriptor : Range.Descriptors) {
     109           5 :       writeVariableSizedInteger(Descriptor.Address, Range.AddrSize, OS,
     110           5 :                                 DI.IsLittleEndian);
     111           5 :       writeVariableSizedInteger(Descriptor.Length, Range.AddrSize, OS,
     112           5 :                                 DI.IsLittleEndian);
     113             :     }
     114           5 :     ZeroFillBytes(OS, Range.AddrSize * 2);
     115             :   }
     116          29 : }
     117             : 
     118          20 : void DWARFYAML::EmitPubSection(raw_ostream &OS,
     119             :                                const DWARFYAML::PubSection &Sect,
     120             :                                bool IsLittleEndian) {
     121          20 :   writeInitialLength(Sect.Length, OS, IsLittleEndian);
     122          20 :   writeInteger((uint16_t)Sect.Version, OS, IsLittleEndian);
     123          20 :   writeInteger((uint32_t)Sect.UnitOffset, OS, IsLittleEndian);
     124          20 :   writeInteger((uint32_t)Sect.UnitSize, OS, IsLittleEndian);
     125          20 :   for (auto Entry : Sect.Entries) {
     126             :     writeInteger((uint32_t)Entry.DieOffset, OS, IsLittleEndian);
     127           8 :     if (Sect.IsGNUStyle)
     128           0 :       writeInteger((uint32_t)Entry.Descriptor, OS, IsLittleEndian);
     129           8 :     OS.write(Entry.Name.data(), Entry.Name.size());
     130           8 :     OS.write('\0');
     131             :   }
     132          20 : }
     133             : 
     134             : namespace {
     135             : /// An extension of the DWARFYAML::ConstVisitor which writes compile
     136             : /// units and DIEs to a stream.
     137           0 : class DumpVisitor : public DWARFYAML::ConstVisitor {
     138             :   raw_ostream &OS;
     139             : 
     140             : protected:
     141          25 :   void onStartCompileUnit(const DWARFYAML::Unit &CU) override {
     142          25 :     writeInitialLength(CU.Length, OS, DebugInfo.IsLittleEndian);
     143          25 :     writeInteger((uint16_t)CU.Version, OS, DebugInfo.IsLittleEndian);
     144          25 :     if(CU.Version >= 5) {
     145           1 :       writeInteger((uint8_t)CU.Type, OS, DebugInfo.IsLittleEndian);
     146           1 :       writeInteger((uint8_t)CU.AddrSize, OS, DebugInfo.IsLittleEndian);
     147           1 :       writeInteger((uint32_t)CU.AbbrOffset, OS, DebugInfo.IsLittleEndian);
     148             :     }else {
     149          24 :       writeInteger((uint32_t)CU.AbbrOffset, OS, DebugInfo.IsLittleEndian);
     150          24 :       writeInteger((uint8_t)CU.AddrSize, OS, DebugInfo.IsLittleEndian);
     151             :     }
     152          25 :   }
     153             : 
     154          86 :   void onStartDIE(const DWARFYAML::Unit &CU,
     155             :                   const DWARFYAML::Entry &DIE) override {
     156          86 :     encodeULEB128(DIE.AbbrCode, OS);
     157          86 :   }
     158             : 
     159          39 :   void onValue(const uint8_t U) override {
     160          39 :     writeInteger(U, OS, DebugInfo.IsLittleEndian);
     161          39 :   }
     162             : 
     163           7 :   void onValue(const uint16_t U) override {
     164           7 :     writeInteger(U, OS, DebugInfo.IsLittleEndian);
     165           7 :   }
     166             : 
     167         105 :   void onValue(const uint32_t U) override {
     168         105 :     writeInteger(U, OS, DebugInfo.IsLittleEndian);
     169         105 :   }
     170             : 
     171          61 :   void onValue(const uint64_t U, const bool LEB = false) override {
     172          61 :     if (LEB)
     173          13 :       encodeULEB128(U, OS);
     174             :     else
     175          48 :       writeInteger(U, OS, DebugInfo.IsLittleEndian);
     176          61 :   }
     177             : 
     178           1 :   void onValue(const int64_t S, const bool LEB = false) override {
     179           1 :     if (LEB)
     180           1 :       encodeSLEB128(S, OS);
     181             :     else
     182           0 :       writeInteger(S, OS, DebugInfo.IsLittleEndian);
     183           1 :   }
     184             : 
     185           1 :   void onValue(const StringRef String) override {
     186           2 :     OS.write(String.data(), String.size());
     187           1 :     OS.write('\0');
     188           1 :   }
     189             : 
     190          14 :   void onValue(const MemoryBufferRef MBR) override {
     191          28 :     OS.write(MBR.getBufferStart(), MBR.getBufferSize());
     192          14 :   }
     193             : 
     194             : public:
     195             :   DumpVisitor(const DWARFYAML::Data &DI, raw_ostream &Out)
     196          62 :       : DWARFYAML::ConstVisitor(DI), OS(Out) {}
     197             : };
     198             : } // namespace
     199             : 
     200          31 : void DWARFYAML::EmitDebugInfo(raw_ostream &OS, const DWARFYAML::Data &DI) {
     201             :   DumpVisitor Visitor(DI, OS);
     202          31 :   Visitor.traverseDebugInfo();
     203          31 : }
     204             : 
     205          10 : static void EmitFileEntry(raw_ostream &OS, const DWARFYAML::File &File) {
     206          10 :   OS.write(File.Name.data(), File.Name.size());
     207          10 :   OS.write('\0');
     208          10 :   encodeULEB128(File.DirIdx, OS);
     209          10 :   encodeULEB128(File.ModTime, OS);
     210          10 :   encodeULEB128(File.Length, OS);
     211          10 : }
     212             : 
     213          31 : void DWARFYAML::EmitDebugLine(raw_ostream &OS, const DWARFYAML::Data &DI) {
     214          31 :   for (const auto &LineTable : DI.DebugLines) {
     215           9 :     writeInitialLength(LineTable.Length, OS, DI.IsLittleEndian);
     216           9 :     uint64_t SizeOfPrologueLength = LineTable.Length.isDWARF64() ? 8 : 4;
     217           9 :     writeInteger((uint16_t)LineTable.Version, OS, DI.IsLittleEndian);
     218           9 :     writeVariableSizedInteger(LineTable.PrologueLength, SizeOfPrologueLength,
     219           9 :                               OS, DI.IsLittleEndian);
     220           9 :     writeInteger((uint8_t)LineTable.MinInstLength, OS, DI.IsLittleEndian);
     221           9 :     if (LineTable.Version >= 4)
     222           0 :       writeInteger((uint8_t)LineTable.MaxOpsPerInst, OS, DI.IsLittleEndian);
     223           9 :     writeInteger((uint8_t)LineTable.DefaultIsStmt, OS, DI.IsLittleEndian);
     224           9 :     writeInteger((uint8_t)LineTable.LineBase, OS, DI.IsLittleEndian);
     225           9 :     writeInteger((uint8_t)LineTable.LineRange, OS, DI.IsLittleEndian);
     226           9 :     writeInteger((uint8_t)LineTable.OpcodeBase, OS, DI.IsLittleEndian);
     227             : 
     228           9 :     for (auto OpcodeLength : LineTable.StandardOpcodeLengths)
     229             :       writeInteger((uint8_t)OpcodeLength, OS, DI.IsLittleEndian);
     230             : 
     231           9 :     for (auto IncludeDir : LineTable.IncludeDirs) {
     232           5 :       OS.write(IncludeDir.data(), IncludeDir.size());
     233           5 :       OS.write('\0');
     234             :     }
     235           9 :     OS.write('\0');
     236             : 
     237           9 :     for (auto File : LineTable.Files)
     238          10 :       EmitFileEntry(OS, File);
     239           9 :     OS.write('\0');
     240             : 
     241          71 :     for (auto Op : LineTable.Opcodes) {
     242          62 :       writeInteger((uint8_t)Op.Opcode, OS, DI.IsLittleEndian);
     243          62 :       if (Op.Opcode == 0) {
     244          18 :         encodeULEB128(Op.ExtLen, OS);
     245          18 :         writeInteger((uint8_t)Op.SubOpcode, OS, DI.IsLittleEndian);
     246          18 :         switch (Op.SubOpcode) {
     247           9 :         case dwarf::DW_LNE_set_address:
     248             :         case dwarf::DW_LNE_set_discriminator:
     249           9 :           writeVariableSizedInteger(Op.Data, DI.CompileUnits[0].AddrSize, OS,
     250           9 :                                     DI.IsLittleEndian);
     251           9 :           break;
     252           0 :         case dwarf::DW_LNE_define_file:
     253           0 :           EmitFileEntry(OS, Op.FileEntry);
     254           0 :           break;
     255             :         case dwarf::DW_LNE_end_sequence:
     256             :           break;
     257           0 :         default:
     258           0 :           for (auto OpByte : Op.UnknownOpcodeData)
     259             :             writeInteger((uint8_t)OpByte, OS, DI.IsLittleEndian);
     260             :         }
     261          44 :       } else if (Op.Opcode < LineTable.OpcodeBase) {
     262          34 :         switch (Op.Opcode) {
     263             :         case dwarf::DW_LNS_copy:
     264             :         case dwarf::DW_LNS_negate_stmt:
     265             :         case dwarf::DW_LNS_set_basic_block:
     266             :         case dwarf::DW_LNS_const_add_pc:
     267             :         case dwarf::DW_LNS_set_prologue_end:
     268             :         case dwarf::DW_LNS_set_epilogue_begin:
     269             :           break;
     270             : 
     271          16 :         case dwarf::DW_LNS_advance_pc:
     272             :         case dwarf::DW_LNS_set_file:
     273             :         case dwarf::DW_LNS_set_column:
     274             :         case dwarf::DW_LNS_set_isa:
     275          16 :           encodeULEB128(Op.Data, OS);
     276          16 :           break;
     277             : 
     278           5 :         case dwarf::DW_LNS_advance_line:
     279           5 :           encodeSLEB128(Op.SData, OS);
     280           5 :           break;
     281             : 
     282           0 :         case dwarf::DW_LNS_fixed_advance_pc:
     283           0 :           writeInteger((uint16_t)Op.Data, OS, DI.IsLittleEndian);
     284             :           break;
     285             : 
     286           0 :         default:
     287           0 :           for (auto OpData : Op.StandardOpcodeData) {
     288           0 :             encodeULEB128(OpData, OS);
     289             :           }
     290             :         }
     291             :       }
     292             :     }
     293             :   }
     294          31 : }
     295             : 
     296             : using EmitFuncType = void (*)(raw_ostream &, const DWARFYAML::Data &);
     297             : 
     298             : static void
     299          95 : EmitDebugSectionImpl(const DWARFYAML::Data &DI, EmitFuncType EmitFunc,
     300             :                      StringRef Sec,
     301             :                      StringMap<std::unique_ptr<MemoryBuffer>> &OutputBuffers) {
     302             :   std::string Data;
     303          95 :   raw_string_ostream DebugInfoStream(Data);
     304          95 :   EmitFunc(DebugInfoStream, DI);
     305             :   DebugInfoStream.flush();
     306          95 :   if (!Data.empty())
     307         122 :     OutputBuffers[Sec] = MemoryBuffer::getMemBufferCopy(Data);
     308          95 : }
     309             : 
     310             : namespace {
     311           0 : class DIEFixupVisitor : public DWARFYAML::Visitor {
     312             :   uint64_t Length;
     313             : 
     314             : public:
     315           2 :   DIEFixupVisitor(DWARFYAML::Data &DI) : DWARFYAML::Visitor(DI){};
     316             : 
     317             : private:
     318           1 :   virtual void onStartCompileUnit(DWARFYAML::Unit &CU) { Length = 7; }
     319             : 
     320           1 :   virtual void onEndCompileUnit(DWARFYAML::Unit &CU) {
     321           1 :     CU.Length.setLength(Length);
     322           1 :   }
     323             : 
     324           2 :   virtual void onStartDIE(DWARFYAML::Unit &CU, DWARFYAML::Entry &DIE) {
     325           2 :     Length += getULEB128Size(DIE.AbbrCode);
     326           2 :   }
     327             : 
     328           0 :   virtual void onValue(const uint8_t U) { Length += 1; }
     329           0 :   virtual void onValue(const uint16_t U) { Length += 2; }
     330           0 :   virtual void onValue(const uint32_t U) { Length += 4; }
     331           0 :   virtual void onValue(const uint64_t U, const bool LEB = false) {
     332           0 :     if (LEB)
     333           0 :       Length += getULEB128Size(U);
     334             :     else
     335           0 :       Length += 8;
     336           0 :   }
     337           0 :   virtual void onValue(const int64_t S, const bool LEB = false) {
     338           0 :     if (LEB)
     339           0 :       Length += getSLEB128Size(S);
     340             :     else
     341           0 :       Length += 8;
     342           0 :   }
     343           0 :   virtual void onValue(const StringRef String) { Length += String.size() + 1; }
     344             : 
     345           0 :   virtual void onValue(const MemoryBufferRef MBR) {
     346           0 :     Length += MBR.getBufferSize();
     347           0 :   }
     348             : };
     349             : } // namespace
     350             : 
     351             : Expected<StringMap<std::unique_ptr<MemoryBuffer>>>
     352          19 : DWARFYAML::EmitDebugSections(StringRef YAMLString, bool ApplyFixups,
     353             :                              bool IsLittleEndian) {
     354          38 :   yaml::Input YIn(YAMLString);
     355             : 
     356          19 :   DWARFYAML::Data DI;
     357          19 :   DI.IsLittleEndian = IsLittleEndian;
     358             :   YIn >> DI;
     359          19 :   if (YIn.error())
     360           0 :     return errorCodeToError(YIn.error());
     361             : 
     362          19 :   if (ApplyFixups) {
     363             :     DIEFixupVisitor DIFixer(DI);
     364           1 :     DIFixer.traverseDebugInfo();
     365             :   }
     366             : 
     367          19 :   StringMap<std::unique_ptr<MemoryBuffer>> DebugSections;
     368          19 :   EmitDebugSectionImpl(DI, &DWARFYAML::EmitDebugInfo, "debug_info",
     369             :                        DebugSections);
     370          19 :   EmitDebugSectionImpl(DI, &DWARFYAML::EmitDebugLine, "debug_line",
     371             :                        DebugSections);
     372          19 :   EmitDebugSectionImpl(DI, &DWARFYAML::EmitDebugStr, "debug_str",
     373             :                        DebugSections);
     374          19 :   EmitDebugSectionImpl(DI, &DWARFYAML::EmitDebugAbbrev, "debug_abbrev",
     375             :                        DebugSections);
     376          19 :   EmitDebugSectionImpl(DI, &DWARFYAML::EmitDebugAranges, "debug_aranges",
     377             :                        DebugSections);
     378             :   return std::move(DebugSections);
     379             : }

Generated by: LCOV version 1.13