1 //===- NativeInlineSiteSymbol.cpp - info about inline sites -----*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 
9 #include "llvm/DebugInfo/PDB/Native/NativeInlineSiteSymbol.h"
10 
11 #include "llvm/DebugInfo/CodeView/DebugInlineeLinesSubsection.h"
12 #include "llvm/DebugInfo/CodeView/LazyRandomTypeCollection.h"
13 #include "llvm/DebugInfo/CodeView/SymbolRecord.h"
14 #include "llvm/DebugInfo/CodeView/TypeDeserializer.h"
15 #include "llvm/DebugInfo/PDB/Native/ModuleDebugStream.h"
16 #include "llvm/DebugInfo/PDB/Native/NativeEnumLineNumbers.h"
17 #include "llvm/DebugInfo/PDB/Native/NativeLineNumber.h"
18 #include "llvm/DebugInfo/PDB/Native/NativeSession.h"
19 #include "llvm/DebugInfo/PDB/Native/PDBFile.h"
20 #include "llvm/DebugInfo/PDB/Native/SymbolCache.h"
21 #include "llvm/DebugInfo/PDB/Native/TpiStream.h"
22 #include "llvm/DebugInfo/PDB/PDBExtras.h"
23 
24 using namespace llvm;
25 using namespace llvm::codeview;
26 using namespace llvm::pdb;
27 
28 NativeInlineSiteSymbol::NativeInlineSiteSymbol(
29     NativeSession &Session, SymIndexId Id, const codeview::InlineSiteSym &Sym,
30     uint64_t ParentAddr)
31     : NativeRawSymbol(Session, PDB_SymType::InlineSite, Id), Sym(Sym),
32       ParentAddr(ParentAddr) {}
33 
34 NativeInlineSiteSymbol::~NativeInlineSiteSymbol() = default;
35 
36 void NativeInlineSiteSymbol::dump(raw_ostream &OS, int Indent,
37                                   PdbSymbolIdField ShowIdFields,
38                                   PdbSymbolIdField RecurseIdFields) const {
39   NativeRawSymbol::dump(OS, Indent, ShowIdFields, RecurseIdFields);
40   dumpSymbolField(OS, "name", getName(), Indent);
41 }
42 
43 static Optional<InlineeSourceLine>
44 findInlineeByTypeIndex(TypeIndex Id, ModuleDebugStreamRef &ModS) {
45   for (const auto &SS : ModS.getSubsectionsArray()) {
46     if (SS.kind() != DebugSubsectionKind::InlineeLines)
47       continue;
48 
49     DebugInlineeLinesSubsectionRef InlineeLines;
50     BinaryStreamReader Reader(SS.getRecordData());
51     if (auto EC = InlineeLines.initialize(Reader)) {
52       consumeError(std::move(EC));
53       continue;
54     }
55 
56     for (const InlineeSourceLine &Line : InlineeLines)
57       if (Line.Header->Inlinee == Id)
58         return Line;
59   }
60   return None;
61 }
62 
63 std::string NativeInlineSiteSymbol::getName() const {
64   auto Tpi = Session.getPDBFile().getPDBTpiStream();
65   if (!Tpi) {
66     consumeError(Tpi.takeError());
67     return "";
68   }
69   auto Ipi = Session.getPDBFile().getPDBIpiStream();
70   if (!Ipi) {
71     consumeError(Ipi.takeError());
72     return "";
73   }
74 
75   LazyRandomTypeCollection &Types = Tpi->typeCollection();
76   LazyRandomTypeCollection &Ids = Ipi->typeCollection();
77   CVType InlineeType = Ids.getType(Sym.Inlinee);
78   std::string QualifiedName;
79   if (InlineeType.kind() == LF_MFUNC_ID) {
80     MemberFuncIdRecord MFRecord;
81     cantFail(TypeDeserializer::deserializeAs<MemberFuncIdRecord>(InlineeType,
82                                                                  MFRecord));
83     TypeIndex ClassTy = MFRecord.getClassType();
84     QualifiedName.append(std::string(Types.getTypeName(ClassTy)));
85     QualifiedName.append("::");
86   } else if (InlineeType.kind() == LF_FUNC_ID) {
87     FuncIdRecord FRecord;
88     cantFail(
89         TypeDeserializer::deserializeAs<FuncIdRecord>(InlineeType, FRecord));
90     TypeIndex ParentScope = FRecord.getParentScope();
91     if (!ParentScope.isNoneType()) {
92       QualifiedName.append(std::string(Ids.getTypeName(ParentScope)));
93       QualifiedName.append("::");
94     }
95   }
96 
97   QualifiedName.append(std::string(Ids.getTypeName(Sym.Inlinee)));
98   return QualifiedName;
99 }
100 
101 void NativeInlineSiteSymbol::getLineOffset(uint32_t OffsetInFunc,
102                                            uint32_t &LineOffset,
103                                            uint32_t &FileOffset) const {
104   LineOffset = 0;
105   FileOffset = 0;
106   uint32_t CodeOffset = 0;
107   for (const auto &Annot : Sym.annotations()) {
108     switch (Annot.OpCode) {
109     case BinaryAnnotationsOpCode::CodeOffset:
110     case BinaryAnnotationsOpCode::ChangeCodeOffset:
111     case BinaryAnnotationsOpCode::ChangeCodeLength:
112       CodeOffset += Annot.U1;
113       break;
114     case BinaryAnnotationsOpCode::ChangeCodeLengthAndCodeOffset:
115       CodeOffset += Annot.U2;
116       break;
117     case BinaryAnnotationsOpCode::ChangeLineOffset:
118     case BinaryAnnotationsOpCode::ChangeCodeOffsetAndLineOffset:
119       CodeOffset += Annot.U1;
120       LineOffset += Annot.S1;
121       break;
122     case BinaryAnnotationsOpCode::ChangeFile:
123       FileOffset = Annot.U1;
124       break;
125     default:
126       break;
127     }
128 
129     if (CodeOffset >= OffsetInFunc)
130       return;
131   }
132 }
133 
134 std::unique_ptr<IPDBEnumLineNumbers>
135 NativeInlineSiteSymbol::findInlineeLinesByVA(uint64_t VA,
136                                              uint32_t Length) const {
137   uint16_t Modi;
138   if (!Session.moduleIndexForVA(VA, Modi))
139     return nullptr;
140 
141   Expected<ModuleDebugStreamRef> ModS = Session.getModuleDebugStream(Modi);
142   if (!ModS) {
143     consumeError(ModS.takeError());
144     return nullptr;
145   }
146 
147   Expected<DebugChecksumsSubsectionRef> Checksums =
148       ModS->findChecksumsSubsection();
149   if (!Checksums) {
150     consumeError(Checksums.takeError());
151     return nullptr;
152   }
153 
154   // Get the line number offset and source file offset.
155   uint32_t SrcLineOffset;
156   uint32_t SrcFileOffset;
157   getLineOffset(VA - ParentAddr, SrcLineOffset, SrcFileOffset);
158 
159   // Get line info from inlinee line table.
160   Optional<InlineeSourceLine> Inlinee =
161       findInlineeByTypeIndex(Sym.Inlinee, ModS.get());
162 
163   if (!Inlinee)
164     return nullptr;
165 
166   uint32_t SrcLine = Inlinee->Header->SourceLineNum + SrcLineOffset;
167   uint32_t SrcCol = 0; // Inline sites don't seem to have column info.
168   uint32_t FileChecksumOffset =
169       (SrcFileOffset == 0) ? Inlinee->Header->FileID : SrcFileOffset;
170 
171   auto ChecksumIter = Checksums->getArray().at(FileChecksumOffset);
172   uint32_t SrcFileId =
173       Session.getSymbolCache().getOrCreateSourceFile(*ChecksumIter);
174 
175   uint32_t LineSect, LineOff;
176   Session.addressForVA(VA, LineSect, LineOff);
177   NativeLineNumber LineNum(Session, SrcLine, SrcCol, LineSect, LineOff, Length,
178                            SrcFileId, Modi);
179   auto SrcFile = Session.getSymbolCache().getSourceFileById(SrcFileId);
180   std::vector<NativeLineNumber> Lines{LineNum};
181 
182   return std::make_unique<NativeEnumLineNumbers>(std::move(Lines));
183 }
184