LCOV - code coverage report
Current view: top level - lib/ObjectYAML - DWARFEmitter.cpp (source / functions) Hit Total Coverage
Test: llvm-toolchain.info Lines: 176 196 89.8 %
Date: 2017-09-14 15:23:50 Functions: 21 23 91.3 %
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             : /// \brief 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         279 :   if (IsLittleEndian != sys::IsLittleEndianHost)
      41             :     sys::swapByteOrder(Integer);
      42         547 :   OS.write(reinterpret_cast<char *>(&Integer), sizeof(T));
      43             : }
      44             : 
      45          24 : static void writeVariableSizedInteger(uint64_t Integer, size_t Size,
      46             :                                       raw_ostream &OS, bool IsLittleEndian) {
      47          24 :   if (8 == Size)
      48             :     writeInteger((uint64_t)Integer, OS, IsLittleEndian);
      49           8 :   else if (4 == Size)
      50           8 :     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          24 : }
      58             : 
      59           8 : static void ZeroFillBytes(raw_ostream &OS, size_t Size) {
      60          16 :   std::vector<uint8_t> FillData;
      61          32 :   FillData.insert(FillData.begin(), Size, 0);
      62          16 :   OS.write(reinterpret_cast<char *>(FillData.data()), Size);
      63           8 : }
      64             : 
      65          47 : static void writeInitialLength(const DWARFYAML::InitialLength &Length,
      66             :                                raw_ostream &OS, bool IsLittleEndian) {
      67          94 :   writeInteger((uint32_t)Length.TotalLength, OS, IsLittleEndian);
      68          47 :   if (Length.isDWARF64())
      69           0 :     writeInteger((uint64_t)Length.TotalLength64, OS, IsLittleEndian);
      70          47 : }
      71             : 
      72          23 : void DWARFYAML::EmitDebugStr(raw_ostream &OS, const DWARFYAML::Data &DI) {
      73         165 :   for (auto Str : DI.DebugStrings) {
      74          73 :     OS.write(Str.data(), Str.size());
      75          73 :     OS.write('\0');
      76             :   }
      77          23 : }
      78             : 
      79          23 : void DWARFYAML::EmitDebugAbbrev(raw_ostream &OS, const DWARFYAML::Data &DI) {
      80         245 :   for (auto AbbrevDecl : DI.AbbrevDecls) {
      81          51 :     encodeULEB128(AbbrevDecl.Code, OS);
      82          51 :     encodeULEB128(AbbrevDecl.Tag, OS);
      83          51 :     OS.write(AbbrevDecl.Children);
      84         423 :     for (auto Attr : AbbrevDecl.Attributes) {
      85         219 :       encodeULEB128(Attr.Attribute, OS);
      86         219 :       encodeULEB128(Attr.Form, OS);
      87         219 :       if (Attr.Form == dwarf::DW_FORM_implicit_const)
      88           1 :         encodeSLEB128(Attr.Value, OS);
      89             :     }
      90          51 :     encodeULEB128(0, OS);
      91          51 :     encodeULEB128(0, OS);
      92             :   }
      93          23 : }
      94             : 
      95          21 : void DWARFYAML::EmitDebugAranges(raw_ostream &OS, const DWARFYAML::Data &DI) {
      96          96 :   for (auto Range : DI.ARanges) {
      97           4 :     auto HeaderStart = OS.tell();
      98           4 :     writeInitialLength(Range.Length, OS, DI.IsLittleEndian);
      99           8 :     writeInteger((uint16_t)Range.Version, OS, DI.IsLittleEndian);
     100           8 :     writeInteger((uint32_t)Range.CuOffset, OS, DI.IsLittleEndian);
     101           8 :     writeInteger((uint8_t)Range.AddrSize, OS, DI.IsLittleEndian);
     102           8 :     writeInteger((uint8_t)Range.SegSize, OS, DI.IsLittleEndian);
     103             : 
     104           4 :     auto HeaderSize = OS.tell() - HeaderStart;
     105           8 :     auto FirstDescriptor = alignTo(HeaderSize, Range.AddrSize * 2);
     106           4 :     ZeroFillBytes(OS, FirstDescriptor - HeaderSize);
     107             : 
     108          20 :     for (auto Descriptor : Range.Descriptors) {
     109           8 :       writeVariableSizedInteger(Descriptor.Address, Range.AddrSize, OS,
     110           8 :                                 DI.IsLittleEndian);
     111           4 :       writeVariableSizedInteger(Descriptor.Length, Range.AddrSize, OS,
     112           4 :                                 DI.IsLittleEndian);
     113             :     }
     114           4 :     ZeroFillBytes(OS, Range.AddrSize * 2);
     115             :   }
     116          21 : }
     117             : 
     118          18 : void DWARFYAML::EmitPubSection(raw_ostream &OS,
     119             :                                const DWARFYAML::PubSection &Sect,
     120             :                                bool IsLittleEndian) {
     121          18 :   writeInitialLength(Sect.Length, OS, IsLittleEndian);
     122          36 :   writeInteger((uint16_t)Sect.Version, OS, IsLittleEndian);
     123          36 :   writeInteger((uint32_t)Sect.UnitOffset, OS, IsLittleEndian);
     124          36 :   writeInteger((uint32_t)Sect.UnitSize, OS, IsLittleEndian);
     125          78 :   for (auto Entry : Sect.Entries) {
     126          12 :     writeInteger((uint32_t)Entry.DieOffset, OS, IsLittleEndian);
     127           6 :     if (Sect.IsGNUStyle)
     128           0 :       writeInteger((uint32_t)Entry.Descriptor, OS, IsLittleEndian);
     129           6 :     OS.write(Entry.Name.data(), Entry.Name.size());
     130           6 :     OS.write('\0');
     131             :   }
     132          18 : }
     133             : 
     134             : namespace {
     135             : /// \brief An extension of the DWARFYAML::ConstVisitor which writes compile
     136             : /// units and DIEs to a stream.
     137          46 : class DumpVisitor : public DWARFYAML::ConstVisitor {
     138             :   raw_ostream &OS;
     139             : 
     140             : protected:
     141          17 :   void onStartCompileUnit(const DWARFYAML::Unit &CU) override {
     142          17 :     writeInitialLength(CU.Length, OS, DebugInfo.IsLittleEndian);
     143          34 :     writeInteger((uint16_t)CU.Version, OS, DebugInfo.IsLittleEndian);
     144          17 :     if(CU.Version >= 5) {
     145           2 :       writeInteger((uint8_t)CU.Type, OS, DebugInfo.IsLittleEndian);
     146           2 :       writeInteger((uint8_t)CU.AddrSize, OS, DebugInfo.IsLittleEndian);
     147           1 :       writeInteger((uint32_t)CU.AbbrOffset, OS, DebugInfo.IsLittleEndian);
     148             :     }else {
     149          32 :       writeInteger((uint32_t)CU.AbbrOffset, OS, DebugInfo.IsLittleEndian);
     150          16 :       writeInteger((uint8_t)CU.AddrSize, OS, DebugInfo.IsLittleEndian);
     151             :     }
     152             :     
     153          17 :   }
     154             : 
     155          51 :   void onStartDIE(const DWARFYAML::Unit &CU,
     156             :                   const DWARFYAML::Entry &DIE) override {
     157          51 :     encodeULEB128(DIE.AbbrCode, OS);
     158          51 :   }
     159             : 
     160          35 :   void onValue(const uint8_t U) override {
     161          70 :     writeInteger(U, OS, DebugInfo.IsLittleEndian);
     162          35 :   }
     163             : 
     164           6 :   void onValue(const uint16_t U) override {
     165          12 :     writeInteger(U, OS, DebugInfo.IsLittleEndian);
     166           6 :   }
     167             : 
     168          80 :   void onValue(const uint32_t U) override {
     169         160 :     writeInteger(U, OS, DebugInfo.IsLittleEndian);
     170          80 :   }
     171             : 
     172          24 :   void onValue(const uint64_t U, const bool LEB = false) override {
     173          24 :     if (LEB)
     174          12 :       encodeULEB128(U, OS);
     175             :     else
     176          12 :       writeInteger(U, OS, DebugInfo.IsLittleEndian);
     177          24 :   }
     178             : 
     179           1 :   void onValue(const int64_t S, const bool LEB = false) override {
     180           1 :     if (LEB)
     181           1 :       encodeSLEB128(S, OS);
     182             :     else
     183           0 :       writeInteger(S, OS, DebugInfo.IsLittleEndian);
     184           1 :   }
     185             : 
     186           1 :   void onValue(const StringRef String) override {
     187           3 :     OS.write(String.data(), String.size());
     188           1 :     OS.write('\0');
     189           1 :   }
     190             : 
     191          13 :   void onValue(const MemoryBufferRef MBR) override {
     192          39 :     OS.write(MBR.getBufferStart(), MBR.getBufferSize());
     193          13 :   }
     194             : 
     195             : public:
     196             :   DumpVisitor(const DWARFYAML::Data &DI, raw_ostream &Out)
     197          46 :       : DWARFYAML::ConstVisitor(DI), OS(Out) {}
     198             : };
     199             : } // namespace
     200             : 
     201          23 : void DWARFYAML::EmitDebugInfo(raw_ostream &OS, const DWARFYAML::Data &DI) {
     202          46 :   DumpVisitor Visitor(DI, OS);
     203          23 :   Visitor.traverseDebugInfo();
     204          23 : }
     205             : 
     206           9 : static void EmitFileEntry(raw_ostream &OS, const DWARFYAML::File &File) {
     207          27 :   OS.write(File.Name.data(), File.Name.size());
     208           9 :   OS.write('\0');
     209           9 :   encodeULEB128(File.DirIdx, OS);
     210           9 :   encodeULEB128(File.ModTime, OS);
     211           9 :   encodeULEB128(File.Length, OS);
     212           9 : }
     213             : 
     214          23 : void DWARFYAML::EmitDebugLine(raw_ostream &OS, const DWARFYAML::Data &DI) {
     215         100 :   for (const auto &LineTable : DI.DebugLines) {
     216           8 :     writeInitialLength(LineTable.Length, OS, DI.IsLittleEndian);
     217           8 :     uint64_t SizeOfPrologueLength = LineTable.Length.isDWARF64() ? 8 : 4;
     218          16 :     writeInteger((uint16_t)LineTable.Version, OS, DI.IsLittleEndian);
     219           8 :     writeVariableSizedInteger(LineTable.PrologueLength, SizeOfPrologueLength,
     220           8 :                               OS, DI.IsLittleEndian);
     221          16 :     writeInteger((uint8_t)LineTable.MinInstLength, OS, DI.IsLittleEndian);
     222           8 :     if (LineTable.Version >= 4)
     223           0 :       writeInteger((uint8_t)LineTable.MaxOpsPerInst, OS, DI.IsLittleEndian);
     224          16 :     writeInteger((uint8_t)LineTable.DefaultIsStmt, OS, DI.IsLittleEndian);
     225          16 :     writeInteger((uint8_t)LineTable.LineBase, OS, DI.IsLittleEndian);
     226          16 :     writeInteger((uint8_t)LineTable.LineRange, OS, DI.IsLittleEndian);
     227          16 :     writeInteger((uint8_t)LineTable.OpcodeBase, OS, DI.IsLittleEndian);
     228             : 
     229         128 :     for (auto OpcodeLength : LineTable.StandardOpcodeLengths)
     230         192 :       writeInteger((uint8_t)OpcodeLength, OS, DI.IsLittleEndian);
     231             : 
     232          37 :     for (auto IncludeDir : LineTable.IncludeDirs) {
     233           5 :       OS.write(IncludeDir.data(), IncludeDir.size());
     234           5 :       OS.write('\0');
     235             :     }
     236           8 :     OS.write('\0');
     237             : 
     238          41 :     for (auto File : LineTable.Files)
     239           9 :       EmitFileEntry(OS, File);
     240           8 :     OS.write('\0');
     241             : 
     242         142 :     for (auto Op : LineTable.Opcodes) {
     243         110 :       writeInteger((uint8_t)Op.Opcode, OS, DI.IsLittleEndian);
     244          55 :       if (Op.Opcode == 0) {
     245          16 :         encodeULEB128(Op.ExtLen, OS);
     246          32 :         writeInteger((uint8_t)Op.SubOpcode, OS, DI.IsLittleEndian);
     247          16 :         switch (Op.SubOpcode) {
     248           8 :         case dwarf::DW_LNE_set_address:
     249             :         case dwarf::DW_LNE_set_discriminator:
     250           8 :           writeVariableSizedInteger(Op.Data, DI.CompileUnits[0].AddrSize, OS,
     251           8 :                                     DI.IsLittleEndian);
     252           8 :           break;
     253           0 :         case dwarf::DW_LNE_define_file:
     254           0 :           EmitFileEntry(OS, Op.FileEntry);
     255           0 :           break;
     256             :         case dwarf::DW_LNE_end_sequence:
     257             :           break;
     258           0 :         default:
     259           0 :           for (auto OpByte : Op.UnknownOpcodeData)
     260           0 :             writeInteger((uint8_t)OpByte, OS, DI.IsLittleEndian);
     261             :         }
     262          39 :       } else if (Op.Opcode < LineTable.OpcodeBase) {
     263          30 :         switch (Op.Opcode) {
     264             :         case dwarf::DW_LNS_copy:
     265             :         case dwarf::DW_LNS_negate_stmt:
     266             :         case dwarf::DW_LNS_set_basic_block:
     267             :         case dwarf::DW_LNS_const_add_pc:
     268             :         case dwarf::DW_LNS_set_prologue_end:
     269             :         case dwarf::DW_LNS_set_epilogue_begin:
     270             :           break;
     271             : 
     272          14 :         case dwarf::DW_LNS_advance_pc:
     273             :         case dwarf::DW_LNS_set_file:
     274             :         case dwarf::DW_LNS_set_column:
     275             :         case dwarf::DW_LNS_set_isa:
     276          14 :           encodeULEB128(Op.Data, OS);
     277          14 :           break;
     278             : 
     279           5 :         case dwarf::DW_LNS_advance_line:
     280           5 :           encodeSLEB128(Op.SData, OS);
     281           5 :           break;
     282             : 
     283           0 :         case dwarf::DW_LNS_fixed_advance_pc:
     284           0 :           writeInteger((uint16_t)Op.Data, OS, DI.IsLittleEndian);
     285             :           break;
     286             : 
     287           0 :         default:
     288           0 :           for (auto OpData : Op.StandardOpcodeData) {
     289           0 :             encodeULEB128(OpData, OS);
     290             :           }
     291             :         }
     292             :       }
     293             :     }
     294             :   }
     295          23 : }
     296             : 
     297             : using EmitFuncType = void (*)(raw_ostream &, const DWARFYAML::Data &);
     298             : 
     299             : static void
     300          60 : EmitDebugSectionImpl(const DWARFYAML::Data &DI, EmitFuncType EmitFunc,
     301             :                      StringRef Sec,
     302             :                      StringMap<std::unique_ptr<MemoryBuffer>> &OutputBuffers) {
     303         120 :   std::string Data;
     304         120 :   raw_string_ostream DebugInfoStream(Data);
     305          60 :   EmitFunc(DebugInfoStream, DI);
     306          60 :   DebugInfoStream.flush();
     307          60 :   if (!Data.empty())
     308         200 :     OutputBuffers[Sec] = MemoryBuffer::getMemBufferCopy(Data);
     309          60 : }
     310             : 
     311             : Expected<StringMap<std::unique_ptr<MemoryBuffer>>>
     312          12 : DWARFYAML::EmitDebugSections(StringRef YAMLString,
     313             :                              bool IsLittleEndian) {
     314          24 :   StringMap<std::unique_ptr<MemoryBuffer>> DebugSections;
     315             : 
     316          24 :   yaml::Input YIn(YAMLString);
     317             : 
     318          24 :   DWARFYAML::Data DI;
     319          12 :   DI.IsLittleEndian = IsLittleEndian;
     320          12 :   YIn >> DI;
     321          12 :   if (YIn.error())
     322           0 :     return errorCodeToError(YIn.error());
     323             : 
     324          12 :   EmitDebugSectionImpl(DI, &DWARFYAML::EmitDebugInfo, "debug_info",
     325             :                        DebugSections);
     326          12 :   EmitDebugSectionImpl(DI, &DWARFYAML::EmitDebugLine, "debug_line",
     327             :                        DebugSections);
     328          12 :   EmitDebugSectionImpl(DI, &DWARFYAML::EmitDebugStr, "debug_str",
     329             :                        DebugSections);
     330          12 :   EmitDebugSectionImpl(DI, &DWARFYAML::EmitDebugAbbrev, "debug_abbrev",
     331             :                        DebugSections);
     332          12 :   EmitDebugSectionImpl(DI, &DWARFYAML::EmitDebugAranges, "debug_aranges",
     333             :                        DebugSections);
     334          12 :   return std::move(DebugSections);
     335             : }

Generated by: LCOV version 1.13