LCOV - code coverage report
Current view: top level - lib/DebugInfo/PDB/Native - DbiStreamBuilder.cpp (source / functions) Hit Total Coverage
Test: llvm-toolchain.info Lines: 184 187 98.4 %
Date: 2018-02-22 16:16:46 Functions: 32 33 97.0 %
Legend: Lines: hit not hit

          Line data    Source code
       1             : //===- DbiStreamBuilder.cpp - PDB Dbi Stream Creation -----------*- C++ -*-===//
       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             : #include "llvm/DebugInfo/PDB/Native/DbiStreamBuilder.h"
      11             : 
      12             : #include "llvm/ADT/ArrayRef.h"
      13             : #include "llvm/BinaryFormat/COFF.h"
      14             : #include "llvm/DebugInfo/MSF/MSFBuilder.h"
      15             : #include "llvm/DebugInfo/MSF/MappedBlockStream.h"
      16             : #include "llvm/DebugInfo/PDB/Native/DbiModuleDescriptorBuilder.h"
      17             : #include "llvm/DebugInfo/PDB/Native/DbiStream.h"
      18             : #include "llvm/DebugInfo/PDB/Native/RawError.h"
      19             : #include "llvm/Object/COFF.h"
      20             : #include "llvm/Support/BinaryStreamWriter.h"
      21             : 
      22             : using namespace llvm;
      23             : using namespace llvm::codeview;
      24             : using namespace llvm::msf;
      25             : using namespace llvm::pdb;
      26             : 
      27          77 : DbiStreamBuilder::DbiStreamBuilder(msf::MSFBuilder &Msf)
      28          77 :     : Msf(Msf), Allocator(Msf.getAllocator()), Age(1), BuildNumber(0),
      29             :       PdbDllVersion(0), PdbDllRbld(0), Flags(0), MachineType(PDB_Machine::x86),
      30         385 :       Header(nullptr), DbgStreams((int)DbgHeaderType::Max) {}
      31             : 
      32         154 : DbiStreamBuilder::~DbiStreamBuilder() {}
      33             : 
      34         154 : void DbiStreamBuilder::setVersionHeader(PdbRaw_DbiVer V) { VerHeader = V; }
      35             : 
      36          77 : void DbiStreamBuilder::setAge(uint32_t A) { Age = A; }
      37             : 
      38          18 : void DbiStreamBuilder::setBuildNumber(uint16_t B) { BuildNumber = B; }
      39             : 
      40          18 : void DbiStreamBuilder::setPdbDllVersion(uint16_t V) { PdbDllVersion = V; }
      41             : 
      42          18 : void DbiStreamBuilder::setPdbDllRbld(uint16_t R) { PdbDllRbld = R; }
      43             : 
      44          18 : void DbiStreamBuilder::setFlags(uint16_t F) { Flags = F; }
      45             : 
      46          18 : void DbiStreamBuilder::setMachineType(PDB_Machine M) { MachineType = M; }
      47             : 
      48          59 : void DbiStreamBuilder::setSectionMap(ArrayRef<SecMapEntry> SecMap) {
      49          59 :   SectionMap = SecMap;
      50          59 : }
      51             : 
      52          59 : void DbiStreamBuilder::setGlobalsStreamIndex(uint32_t Index) {
      53          59 :   GlobalsStreamIndex = Index;
      54          59 : }
      55             : 
      56          59 : void DbiStreamBuilder::setSymbolRecordStreamIndex(uint32_t Index) {
      57          59 :   SymRecordStreamIndex = Index;
      58          59 : }
      59             : 
      60          59 : void DbiStreamBuilder::setPublicsStreamIndex(uint32_t Index) {
      61          59 :   PublicsStreamIndex = Index;
      62          59 : }
      63             : 
      64         118 : Error DbiStreamBuilder::addDbgStream(pdb::DbgHeaderType Type,
      65             :                                      ArrayRef<uint8_t> Data) {
      66         236 :   if (DbgStreams[(int)Type].StreamNumber != kInvalidStreamIndex)
      67             :     return make_error<RawError>(raw_error_code::duplicate_entry,
      68             :                                 "The specified stream type already exists");
      69         118 :   auto ExpectedIndex = Msf.addStream(Data.size());
      70         118 :   if (!ExpectedIndex)
      71             :     return ExpectedIndex.takeError();
      72         118 :   uint32_t Index = std::move(*ExpectedIndex);
      73         118 :   DbgStreams[(int)Type].Data = Data;
      74         118 :   DbgStreams[(int)Type].StreamNumber = Index;
      75             :   return Error::success();
      76             : }
      77             : 
      78          59 : uint32_t DbiStreamBuilder::addECName(StringRef Name) {
      79          59 :   return ECNamesBuilder.insert(Name);
      80             : }
      81             : 
      82          77 : uint32_t DbiStreamBuilder::calculateSerializedLength() const {
      83             :   // For now we only support serializing the header.
      84         154 :   return sizeof(DbiStreamHeader) + calculateFileInfoSubstreamSize() +
      85         231 :          calculateModiSubstreamSize() + calculateSectionContribsStreamSize() +
      86         231 :          calculateSectionMapStreamSize() + calculateDbgStreamsSize() +
      87         154 :          ECNamesBuilder.calculateSerializedSize();
      88             : }
      89             : 
      90             : Expected<DbiModuleDescriptorBuilder &>
      91         154 : DbiStreamBuilder::addModuleInfo(StringRef ModuleName) {
      92         308 :   uint32_t Index = ModiList.size();
      93         154 :   ModiList.push_back(
      94         308 :       llvm::make_unique<DbiModuleDescriptorBuilder>(ModuleName, Index, Msf));
      95         154 :   return *ModiList.back();
      96             : }
      97             : 
      98          54 : Error DbiStreamBuilder::addModuleSourceFile(DbiModuleDescriptorBuilder &Module,
      99             :                                             StringRef File) {
     100          54 :   uint32_t Index = SourceFileNames.size();
     101          54 :   SourceFileNames.insert(std::make_pair(File, Index));
     102          54 :   Module.addSourceFile(File);
     103          54 :   return Error::success();
     104             : }
     105             : 
     106           0 : Expected<uint32_t> DbiStreamBuilder::getSourceFileNameIndex(StringRef File) {
     107           0 :   auto NameIter = SourceFileNames.find(File);
     108           0 :   if (NameIter == SourceFileNames.end())
     109             :     return make_error<RawError>(raw_error_code::no_entry,
     110             :                                 "The specified source file was not found");
     111             :   return NameIter->getValue();
     112             : }
     113             : 
     114         154 : uint32_t DbiStreamBuilder::calculateModiSubstreamSize() const {
     115             :   uint32_t Size = 0;
     116         154 :   for (const auto &M : ModiList)
     117         308 :     Size += M->calculateSerializedLength();
     118         154 :   return Size;
     119             : }
     120             : 
     121         154 : uint32_t DbiStreamBuilder::calculateSectionContribsStreamSize() const {
     122         154 :   if (SectionContribs.empty())
     123             :     return 0;
     124         118 :   return sizeof(enum PdbRaw_DbiSecContribVer) +
     125         118 :          sizeof(SectionContribs[0]) * SectionContribs.size();
     126             : }
     127             : 
     128         154 : uint32_t DbiStreamBuilder::calculateSectionMapStreamSize() const {
     129         154 :   if (SectionMap.empty())
     130             :     return 0;
     131         118 :   return sizeof(SecMapHeader) + sizeof(SecMapEntry) * SectionMap.size();
     132             : }
     133             : 
     134         231 : uint32_t DbiStreamBuilder::calculateNamesOffset() const {
     135             :   uint32_t Offset = 0;
     136             :   Offset += sizeof(ulittle16_t);                         // NumModules
     137             :   Offset += sizeof(ulittle16_t);                         // NumSourceFiles
     138         462 :   Offset += ModiList.size() * sizeof(ulittle16_t);       // ModIndices
     139         231 :   Offset += ModiList.size() * sizeof(ulittle16_t);       // ModFileCounts
     140             :   uint32_t NumFileInfos = 0;
     141         693 :   for (const auto &M : ModiList)
     142         462 :     NumFileInfos += M->source_files().size();
     143         231 :   Offset += NumFileInfos * sizeof(ulittle32_t); // FileNameOffsets
     144         231 :   return Offset;
     145             : }
     146             : 
     147         154 : uint32_t DbiStreamBuilder::calculateFileInfoSubstreamSize() const {
     148         154 :   uint32_t Size = calculateNamesOffset();
     149         154 :   Size += calculateNamesBufferSize();
     150         308 :   return alignTo(Size, sizeof(uint32_t));
     151             : }
     152             : 
     153         154 : uint32_t DbiStreamBuilder::calculateNamesBufferSize() const {
     154             :   uint32_t Size = 0;
     155         412 :   for (const auto &F : SourceFileNames) {
     156         104 :     Size += F.getKeyLength() + 1; // Names[I];
     157             :   }
     158         154 :   return Size;
     159             : }
     160             : 
     161          77 : uint32_t DbiStreamBuilder::calculateDbgStreamsSize() const {
     162          77 :   return DbgStreams.size() * sizeof(uint16_t);
     163             : }
     164             : 
     165          77 : Error DbiStreamBuilder::generateFileInfoSubstream() {
     166          77 :   uint32_t Size = calculateFileInfoSubstreamSize();
     167          77 :   auto Data = Allocator.Allocate<uint8_t>(Size);
     168          77 :   uint32_t NamesOffset = calculateNamesOffset();
     169             : 
     170             :   FileInfoBuffer = MutableBinaryByteStream(MutableArrayRef<uint8_t>(Data, Size),
     171             :                                            llvm::support::little);
     172             : 
     173             :   WritableBinaryStreamRef MetadataBuffer =
     174         154 :       WritableBinaryStreamRef(FileInfoBuffer).keep_front(NamesOffset);
     175         154 :   BinaryStreamWriter MetadataWriter(MetadataBuffer);
     176             : 
     177         231 :   uint16_t ModiCount = std::min<uint32_t>(UINT16_MAX, ModiList.size());
     178         154 :   uint16_t FileCount = std::min<uint32_t>(UINT16_MAX, SourceFileNames.size());
     179         154 :   if (auto EC = MetadataWriter.writeInteger(ModiCount)) // NumModules
     180             :     return EC;
     181         154 :   if (auto EC = MetadataWriter.writeInteger(FileCount)) // NumSourceFiles
     182             :     return EC;
     183         385 :   for (uint16_t I = 0; I < ModiCount; ++I) {
     184         308 :     if (auto EC = MetadataWriter.writeInteger(I)) // Mod Indices
     185             :       return EC;
     186             :   }
     187         231 :   for (const auto &MI : ModiList) {
     188         154 :     FileCount = static_cast<uint16_t>(MI->source_files().size());
     189         308 :     if (auto EC = MetadataWriter.writeInteger(FileCount)) // Mod File Counts
     190             :       return EC;
     191             :   }
     192             : 
     193             :   // Before writing the FileNameOffsets array, write the NamesBuffer array.
     194             :   // A side effect of this is that this will actually compute the various
     195             :   // file name offsets, so we can then go back and write the FileNameOffsets
     196             :   // array to the other substream.
     197         231 :   NamesBuffer = WritableBinaryStreamRef(FileInfoBuffer).drop_front(NamesOffset);
     198         154 :   BinaryStreamWriter NameBufferWriter(NamesBuffer);
     199         206 :   for (auto &Name : SourceFileNames) {
     200          52 :     Name.second = NameBufferWriter.getOffset();
     201         104 :     if (auto EC = NameBufferWriter.writeCString(Name.getKey()))
     202             :       return EC;
     203             :   }
     204             : 
     205         231 :   for (const auto &MI : ModiList) {
     206         262 :     for (StringRef Name : MI->source_files()) {
     207          54 :       auto Result = SourceFileNames.find(Name);
     208         108 :       if (Result == SourceFileNames.end())
     209             :         return make_error<RawError>(raw_error_code::no_entry,
     210             :                                     "The source file was not found.");
     211         108 :       if (auto EC = MetadataWriter.writeInteger(Result->second))
     212             :         return EC;
     213             :     }
     214             :   }
     215             : 
     216         154 :   if (auto EC = NameBufferWriter.padToAlignment(sizeof(uint32_t)))
     217             :     return EC;
     218             : 
     219          77 :   if (NameBufferWriter.bytesRemaining() > 0)
     220             :     return make_error<RawError>(raw_error_code::invalid_format,
     221             :                                 "The names buffer contained unexpected data.");
     222             : 
     223          77 :   if (MetadataWriter.bytesRemaining() > sizeof(uint32_t))
     224             :     return make_error<RawError>(
     225             :         raw_error_code::invalid_format,
     226             :         "The metadata buffer contained unexpected data.");
     227             : 
     228             :   return Error::success();
     229             : }
     230             : 
     231          77 : Error DbiStreamBuilder::finalize() {
     232          77 :   if (Header)
     233             :     return Error::success();
     234             : 
     235         231 :   for (auto &MI : ModiList)
     236         154 :     MI->finalize();
     237             : 
     238         154 :   if (auto EC = generateFileInfoSubstream())
     239             :     return EC;
     240             : 
     241          77 :   DbiStreamHeader *H = Allocator.Allocate<DbiStreamHeader>();
     242          77 :   ::memset(H, 0, sizeof(DbiStreamHeader));
     243          77 :   H->VersionHeader = *VerHeader;
     244             :   H->VersionSignature = -1;
     245          77 :   H->Age = Age;
     246          77 :   H->BuildNumber = BuildNumber;
     247          77 :   H->Flags = Flags;
     248          77 :   H->PdbDllRbld = PdbDllRbld;
     249          77 :   H->PdbDllVersion = PdbDllVersion;
     250          77 :   H->MachineType = static_cast<uint16_t>(MachineType);
     251             : 
     252          77 :   H->ECSubstreamSize = ECNamesBuilder.calculateSerializedSize();
     253             :   H->FileInfoSize = FileInfoBuffer.getLength();
     254          77 :   H->ModiSubstreamSize = calculateModiSubstreamSize();
     255          77 :   H->OptionalDbgHdrSize = DbgStreams.size() * sizeof(uint16_t);
     256          77 :   H->SecContrSubstreamSize = calculateSectionContribsStreamSize();
     257          77 :   H->SectionMapSize = calculateSectionMapStreamSize();
     258             :   H->TypeServerSize = 0;
     259          77 :   H->SymRecordStreamIndex = SymRecordStreamIndex;
     260          77 :   H->PublicSymbolStreamIndex = PublicsStreamIndex;
     261             :   H->MFCTypeServerIndex = kInvalidStreamIndex;
     262          77 :   H->GlobalSymbolStreamIndex = GlobalsStreamIndex;
     263             : 
     264          77 :   Header = H;
     265             :   return Error::success();
     266             : }
     267             : 
     268          77 : Error DbiStreamBuilder::finalizeMsfLayout() {
     269         231 :   for (auto &MI : ModiList) {
     270         308 :     if (auto EC = MI->finalizeMsfLayout())
     271             :       return EC;
     272             :   }
     273             : 
     274          77 :   uint32_t Length = calculateSerializedLength();
     275         154 :   if (auto EC = Msf.setStreamSize(StreamDBI, Length))
     276             :     return EC;
     277             :   return Error::success();
     278             : }
     279             : 
     280         187 : static uint16_t toSecMapFlags(uint32_t Flags) {
     281             :   uint16_t Ret = 0;
     282         187 :   if (Flags & COFF::IMAGE_SCN_MEM_READ)
     283             :     Ret |= static_cast<uint16_t>(OMFSegDescFlags::Read);
     284         187 :   if (Flags & COFF::IMAGE_SCN_MEM_WRITE)
     285          11 :     Ret |= static_cast<uint16_t>(OMFSegDescFlags::Write);
     286         187 :   if (Flags & COFF::IMAGE_SCN_MEM_EXECUTE)
     287          58 :     Ret |= static_cast<uint16_t>(OMFSegDescFlags::Execute);
     288         187 :   if (Flags & COFF::IMAGE_SCN_MEM_EXECUTE)
     289          58 :     Ret |= static_cast<uint16_t>(OMFSegDescFlags::Execute);
     290         187 :   if (!(Flags & COFF::IMAGE_SCN_MEM_16BIT))
     291         187 :     Ret |= static_cast<uint16_t>(OMFSegDescFlags::AddressIs32Bit);
     292             : 
     293             :   // This seems always 1.
     294         187 :   Ret |= static_cast<uint16_t>(OMFSegDescFlags::IsSelector);
     295             : 
     296         187 :   return Ret;
     297             : }
     298             : 
     299             : // A utility function to create a Section Map for a given list of COFF sections.
     300             : //
     301             : // A Section Map seem to be a copy of a COFF section list in other format.
     302             : // I don't know why a PDB file contains both a COFF section header and
     303             : // a Section Map, but it seems it must be present in a PDB.
     304          59 : std::vector<SecMapEntry> DbiStreamBuilder::createSectionMap(
     305             :     ArrayRef<llvm::object::coff_section> SecHdrs) {
     306             :   std::vector<SecMapEntry> Ret;
     307          59 :   int Idx = 0;
     308             : 
     309         246 :   auto Add = [&]() -> SecMapEntry & {
     310         246 :     Ret.emplace_back();
     311             :     auto &Entry = Ret.back();
     312         246 :     memset(&Entry, 0, sizeof(Entry));
     313             : 
     314         246 :     Entry.Frame = Idx + 1;
     315             : 
     316             :     // We don't know the meaning of these fields yet.
     317             :     Entry.SecName = UINT16_MAX;
     318             :     Entry.ClassName = UINT16_MAX;
     319             : 
     320         246 :     return Entry;
     321          59 :   };
     322             : 
     323         433 :   for (auto &Hdr : SecHdrs) {
     324         187 :     auto &Entry = Add();
     325         187 :     Entry.Flags = toSecMapFlags(Hdr.Characteristics);
     326         187 :     Entry.SecByteLength = Hdr.VirtualSize;
     327         187 :     ++Idx;
     328             :   }
     329             : 
     330             :   // The last entry is for absolute symbols.
     331          59 :   auto &Entry = Add();
     332             :   Entry.Flags = static_cast<uint16_t>(OMFSegDescFlags::AddressIs32Bit) |
     333             :                 static_cast<uint16_t>(OMFSegDescFlags::IsAbsoluteAddress);
     334             :   Entry.SecByteLength = UINT32_MAX;
     335             : 
     336          59 :   return Ret;
     337             : }
     338             : 
     339          77 : Error DbiStreamBuilder::commit(const msf::MSFLayout &Layout,
     340             :                                WritableBinaryStreamRef MsfBuffer) {
     341         154 :   if (auto EC = finalize())
     342             :     return EC;
     343             : 
     344             :   auto DbiS = WritableMappedBlockStream::createIndexedStream(
     345         231 :       Layout, MsfBuffer, StreamDBI, Allocator);
     346             : 
     347          77 :   BinaryStreamWriter Writer(*DbiS);
     348         154 :   if (auto EC = Writer.writeObject(*Header))
     349             :     return EC;
     350             : 
     351         231 :   for (auto &M : ModiList) {
     352         462 :     if (auto EC = M->commit(Writer, Layout, MsfBuffer))
     353             :       return EC;
     354             :   }
     355             : 
     356          77 :   if (!SectionContribs.empty()) {
     357          59 :     if (auto EC = Writer.writeEnum(DbiSecContribVer60))
     358             :       return EC;
     359         118 :     if (auto EC = Writer.writeArray(makeArrayRef(SectionContribs)))
     360             :       return EC;
     361             :   }
     362             : 
     363          77 :   if (!SectionMap.empty()) {
     364          59 :     ulittle16_t Size = static_cast<ulittle16_t>(SectionMap.size());
     365          59 :     SecMapHeader SMHeader = {Size, Size};
     366          59 :     if (auto EC = Writer.writeObject(SMHeader))
     367             :       return EC;
     368         118 :     if (auto EC = Writer.writeArray(SectionMap))
     369             :       return EC;
     370             :   }
     371             : 
     372         231 :   if (auto EC = Writer.writeStreamRef(FileInfoBuffer))
     373             :     return EC;
     374             : 
     375         154 :   if (auto EC = ECNamesBuilder.commit(Writer))
     376             :     return EC;
     377             : 
     378        1771 :   for (auto &Stream : DbgStreams)
     379        1694 :     if (auto EC = Writer.writeInteger(Stream.StreamNumber))
     380             :       return EC;
     381             : 
     382        1771 :   for (auto &Stream : DbgStreams) {
     383         847 :     if (Stream.StreamNumber == kInvalidStreamIndex)
     384         729 :       continue;
     385             :     auto WritableStream = WritableMappedBlockStream::createIndexedStream(
     386         354 :         Layout, MsfBuffer, Stream.StreamNumber, Allocator);
     387         118 :     BinaryStreamWriter DbgStreamWriter(*WritableStream);
     388         236 :     if (auto EC = DbgStreamWriter.writeArray(Stream.Data))
     389             :       return EC;
     390             :   }
     391             : 
     392          77 :   if (Writer.bytesRemaining() > 0)
     393             :     return make_error<RawError>(raw_error_code::invalid_format,
     394             :                                 "Unexpected bytes found in DBI Stream");
     395             :   return Error::success();
     396             : }

Generated by: LCOV version 1.13