1 //===- ModuleDebugStream.cpp - PDB Module Info Stream Access --------------===//
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/ModuleDebugStream.h"
11 #include "llvm/ADT/iterator_range.h"
12 #include "llvm/DebugInfo/CodeView/SymbolRecord.h"
13 #include "llvm/DebugInfo/PDB/Native/DbiModuleDescriptor.h"
14 #include "llvm/DebugInfo/PDB/Native/PDBFile.h"
15 #include "llvm/DebugInfo/PDB/Native/RawError.h"
16 #include "llvm/DebugInfo/PDB/Native/RawTypes.h"
17 #include "llvm/Support/BinaryStreamReader.h"
18 #include "llvm/Support/BinaryStreamRef.h"
19 #include "llvm/Support/Error.h"
20 #include <algorithm>
21 #include <cstdint>
22 
23 using namespace llvm;
24 using namespace llvm::codeview;
25 using namespace llvm::msf;
26 using namespace llvm::pdb;
27 
28 ModuleDebugStreamRef::ModuleDebugStreamRef(
29     const DbiModuleDescriptor &Module,
30     std::unique_ptr<MappedBlockStream> Stream)
31     : Mod(Module), Stream(std::move(Stream)) {}
32 
33 ModuleDebugStreamRef::~ModuleDebugStreamRef() = default;
34 
35 Error ModuleDebugStreamRef::reload() {
36   BinaryStreamReader Reader(*Stream);
37 
38   uint32_t SymbolSize = Mod.getSymbolDebugInfoByteSize();
39   uint32_t C11Size = Mod.getC11LineInfoByteSize();
40   uint32_t C13Size = Mod.getC13LineInfoByteSize();
41 
42   if (C11Size > 0 && C13Size > 0)
43     return make_error<RawError>(raw_error_code::corrupt_file,
44                                 "Module has both C11 and C13 line info");
45 
46   BinaryStreamRef S;
47 
48   if (auto EC = Reader.readInteger(Signature))
49     return EC;
50   if (auto EC = Reader.readArray(SymbolsSubstream, SymbolSize - 4))
51     return EC;
52 
53   if (auto EC = Reader.readStreamRef(C11LinesSubstream, C11Size))
54     return EC;
55   if (auto EC = Reader.readStreamRef(C13LinesSubstream, C13Size))
56     return EC;
57 
58   BinaryStreamReader SubsectionsReader(C13LinesSubstream);
59   if (auto EC = SubsectionsReader.readArray(Subsections,
60                                             SubsectionsReader.bytesRemaining()))
61     return EC;
62 
63   uint32_t GlobalRefsSize;
64   if (auto EC = Reader.readInteger(GlobalRefsSize))
65     return EC;
66   if (auto EC = Reader.readStreamRef(GlobalRefsSubstream, GlobalRefsSize))
67     return EC;
68   if (Reader.bytesRemaining() > 0)
69     return make_error<RawError>(raw_error_code::corrupt_file,
70                                 "Unexpected bytes in module stream.");
71 
72   return Error::success();
73 }
74 
75 iterator_range<codeview::CVSymbolArray::Iterator>
76 ModuleDebugStreamRef::symbols(bool *HadError) const {
77   return make_range(SymbolsSubstream.begin(HadError), SymbolsSubstream.end());
78 }
79 
80 llvm::iterator_range<ModuleDebugStreamRef::DebugSubsectionIterator>
81 ModuleDebugStreamRef::subsections() const {
82   return make_range(Subsections.begin(), Subsections.end());
83 }
84 
85 bool ModuleDebugStreamRef::hasDebugSubsections() const {
86   return C13LinesSubstream.getLength() > 0;
87 }
88 
89 Error ModuleDebugStreamRef::commit() { return Error::success(); }
90 
91 Expected<codeview::DebugChecksumsSubsectionRef>
92 ModuleDebugStreamRef::findChecksumsSubsection() const {
93   for (const auto &SS : subsections()) {
94     if (SS.kind() != DebugSubsectionKind::FileChecksums)
95       continue;
96 
97     codeview::DebugChecksumsSubsectionRef Result;
98     if (auto EC = Result.initialize(SS.getRecordData()))
99       return std::move(EC);
100     return Result;
101   }
102   return make_error<RawError>(raw_error_code::no_entry);
103 }
104