1#include "PdbAstBuilder.h"
2
3#include "llvm/DebugInfo/CodeView/CVTypeVisitor.h"
4#include "llvm/DebugInfo/CodeView/LazyRandomTypeCollection.h"
5#include "llvm/DebugInfo/CodeView/RecordName.h"
6#include "llvm/DebugInfo/CodeView/SymbolDeserializer.h"
7#include "llvm/DebugInfo/CodeView/SymbolRecord.h"
8#include "llvm/DebugInfo/CodeView/SymbolRecordHelpers.h"
9#include "llvm/DebugInfo/CodeView/TypeDeserializer.h"
10#include "llvm/DebugInfo/CodeView/TypeVisitorCallbacks.h"
11#include "llvm/DebugInfo/PDB/Native/DbiStream.h"
12#include "llvm/DebugInfo/PDB/Native/PublicsStream.h"
13#include "llvm/DebugInfo/PDB/Native/SymbolStream.h"
14#include "llvm/DebugInfo/PDB/Native/TpiStream.h"
15#include "llvm/Demangle/MicrosoftDemangle.h"
16
17#include "PdbUtil.h"
18#include "Plugins/ExpressionParser/Clang/ClangASTMetadata.h"
19#include "Plugins/ExpressionParser/Clang/ClangUtil.h"
20#include "Plugins/Language/CPlusPlus/MSVCUndecoratedNameParser.h"
21#include "Plugins/TypeSystem/Clang/TypeSystemClang.h"
22#include "SymbolFileNativePDB.h"
23#include "UdtRecordCompleter.h"
24#include "lldb/Core/Module.h"
25#include "lldb/Symbol/ObjectFile.h"
26#include "lldb/Utility/LLDBAssert.h"
27#include <optional>
28#include <string_view>
29
30using namespace lldb_private;
31using namespace lldb_private::npdb;
32using namespace llvm::codeview;
33using namespace llvm::pdb;
34
35namespace {
36struct CreateMethodDecl : public TypeVisitorCallbacks {
37 CreateMethodDecl(PdbIndex &m_index, TypeSystemClang &m_clang,
38 TypeIndex func_type_index,
39 clang::FunctionDecl *&function_decl,
40 lldb::opaque_compiler_type_t parent_ty,
41 llvm::StringRef proc_name, CompilerType func_ct)
42 : m_index(m_index), m_clang(m_clang), func_type_index(func_type_index),
43 function_decl(function_decl), parent_ty(parent_ty),
44 proc_name(proc_name), func_ct(func_ct) {}
45 PdbIndex &m_index;
46 TypeSystemClang &m_clang;
47 TypeIndex func_type_index;
48 clang::FunctionDecl *&function_decl;
49 lldb::opaque_compiler_type_t parent_ty;
50 llvm::StringRef proc_name;
51 CompilerType func_ct;
52
53 llvm::Error visitKnownMember(CVMemberRecord &cvr,
54 OverloadedMethodRecord &overloaded) override {
55 TypeIndex method_list_idx = overloaded.MethodList;
56
57 CVType method_list_type = m_index.tpi().getType(Index: method_list_idx);
58 assert(method_list_type.kind() == LF_METHODLIST);
59
60 MethodOverloadListRecord method_list;
61 llvm::cantFail(Err: TypeDeserializer::deserializeAs<MethodOverloadListRecord>(
62 CVT&: method_list_type, Record&: method_list));
63
64 for (const OneMethodRecord &method : method_list.Methods) {
65 if (method.getType().getIndex() == func_type_index.getIndex())
66 AddMethod(name: overloaded.Name, access: method.getAccess(), options: method.getOptions(),
67 attrs: method.Attrs);
68 }
69
70 return llvm::Error::success();
71 }
72
73 llvm::Error visitKnownMember(CVMemberRecord &cvr,
74 OneMethodRecord &record) override {
75 AddMethod(name: record.getName(), access: record.getAccess(), options: record.getOptions(),
76 attrs: record.Attrs);
77 return llvm::Error::success();
78 }
79
80 void AddMethod(llvm::StringRef name, MemberAccess access,
81 MethodOptions options, MemberAttributes attrs) {
82 if (name != proc_name || function_decl)
83 return;
84 lldb::AccessType access_type = TranslateMemberAccess(access);
85 bool is_virtual = attrs.isVirtual();
86 bool is_static = attrs.isStatic();
87 bool is_artificial = (options & MethodOptions::CompilerGenerated) ==
88 MethodOptions::CompilerGenerated;
89 function_decl = m_clang.AddMethodToCXXRecordType(
90 type: parent_ty, name: proc_name,
91 /*mangled_name=*/nullptr, method_type: func_ct, /*access=*/access_type,
92 /*is_virtual=*/is_virtual, /*is_static=*/is_static,
93 /*is_inline=*/false, /*is_explicit=*/false,
94 /*is_attr_used=*/false, /*is_artificial=*/is_artificial);
95 }
96};
97} // namespace
98
99static clang::TagTypeKind TranslateUdtKind(const TagRecord &cr) {
100 switch (cr.Kind) {
101 case TypeRecordKind::Class:
102 return clang::TagTypeKind::Class;
103 case TypeRecordKind::Struct:
104 return clang::TagTypeKind::Struct;
105 case TypeRecordKind::Union:
106 return clang::TagTypeKind::Union;
107 case TypeRecordKind::Interface:
108 return clang::TagTypeKind::Interface;
109 case TypeRecordKind::Enum:
110 return clang::TagTypeKind::Enum;
111 default:
112 lldbassert(false && "Invalid tag record kind!");
113 return clang::TagTypeKind::Struct;
114 }
115}
116
117static bool IsCVarArgsFunction(llvm::ArrayRef<TypeIndex> args) {
118 if (args.empty())
119 return false;
120 return args.back() == TypeIndex::None();
121}
122
123static bool
124AnyScopesHaveTemplateParams(llvm::ArrayRef<llvm::ms_demangle::Node *> scopes) {
125 for (llvm::ms_demangle::Node *n : scopes) {
126 auto *idn = static_cast<llvm::ms_demangle::IdentifierNode *>(n);
127 if (idn->TemplateParams)
128 return true;
129 }
130 return false;
131}
132
133static std::optional<clang::CallingConv>
134TranslateCallingConvention(llvm::codeview::CallingConvention conv) {
135 using CC = llvm::codeview::CallingConvention;
136 switch (conv) {
137
138 case CC::NearC:
139 case CC::FarC:
140 return clang::CallingConv::CC_C;
141 case CC::NearPascal:
142 case CC::FarPascal:
143 return clang::CallingConv::CC_X86Pascal;
144 case CC::NearFast:
145 case CC::FarFast:
146 return clang::CallingConv::CC_X86FastCall;
147 case CC::NearStdCall:
148 case CC::FarStdCall:
149 return clang::CallingConv::CC_X86StdCall;
150 case CC::ThisCall:
151 return clang::CallingConv::CC_X86ThisCall;
152 case CC::NearVector:
153 return clang::CallingConv::CC_X86VectorCall;
154 default:
155 return std::nullopt;
156 }
157}
158
159static bool IsAnonymousNamespaceName(llvm::StringRef name) {
160 return name == "`anonymous namespace'" || name == "`anonymous-namespace'";
161}
162
163PdbAstBuilder::PdbAstBuilder(TypeSystemClang &clang) : m_clang(clang) {}
164
165lldb_private::CompilerDeclContext PdbAstBuilder::GetTranslationUnitDecl() {
166 return ToCompilerDeclContext(*m_clang.GetTranslationUnitDecl());
167}
168
169std::pair<clang::DeclContext *, std::string>
170PdbAstBuilder::CreateDeclInfoForType(const TagRecord &record, TypeIndex ti) {
171 SymbolFileNativePDB *pdb = static_cast<SymbolFileNativePDB *>(
172 m_clang.GetSymbolFile()->GetBackingSymbolFile());
173 // FIXME: Move this to GetDeclContextContainingUID.
174 if (!record.hasUniqueName())
175 return CreateDeclInfoForUndecoratedName(uname: record.Name);
176
177 llvm::ms_demangle::Demangler demangler;
178 std::string_view sv(record.UniqueName.begin(), record.UniqueName.size());
179 llvm::ms_demangle::TagTypeNode *ttn = demangler.parseTagUniqueName(MangledName&: sv);
180 if (demangler.Error)
181 return {m_clang.GetTranslationUnitDecl(), std::string(record.UniqueName)};
182
183 llvm::ms_demangle::IdentifierNode *idn =
184 ttn->QualifiedName->getUnqualifiedIdentifier();
185 std::string uname = idn->toString(Flags: llvm::ms_demangle::OF_NoTagSpecifier);
186
187 llvm::ms_demangle::NodeArrayNode *name_components =
188 ttn->QualifiedName->Components;
189 llvm::ArrayRef<llvm::ms_demangle::Node *> scopes(name_components->Nodes,
190 name_components->Count - 1);
191
192 clang::DeclContext *context = m_clang.GetTranslationUnitDecl();
193
194 // If this type doesn't have a parent type in the debug info, then the best we
195 // can do is to say that it's either a series of namespaces (if the scope is
196 // non-empty), or the translation unit (if the scope is empty).
197 std::optional<TypeIndex> parent_index = pdb->GetParentType(ti);
198 if (!parent_index) {
199 if (scopes.empty())
200 return {context, uname};
201
202 // If there is no parent in the debug info, but some of the scopes have
203 // template params, then this is a case of bad debug info. See, for
204 // example, llvm.org/pr39607. We don't want to create an ambiguity between
205 // a NamespaceDecl and a CXXRecordDecl, so instead we create a class at
206 // global scope with the fully qualified name.
207 if (AnyScopesHaveTemplateParams(scopes))
208 return {context, std::string(record.Name)};
209
210 for (llvm::ms_demangle::Node *scope : scopes) {
211 auto *nii = static_cast<llvm::ms_demangle::NamedIdentifierNode *>(scope);
212 std::string str = nii->toString();
213 context = GetOrCreateNamespaceDecl(name: str.c_str(), context&: *context);
214 }
215 return {context, uname};
216 }
217
218 // Otherwise, all we need to do is get the parent type of this type and
219 // recurse into our lazy type creation / AST reconstruction logic to get an
220 // LLDB TypeSP for the parent. This will cause the AST to automatically get
221 // the right DeclContext created for any parent.
222 clang::QualType parent_qt = GetOrCreateType(type: *parent_index);
223 if (parent_qt.isNull())
224 return {nullptr, ""};
225
226 context = clang::TagDecl::castToDeclContext(D: parent_qt->getAsTagDecl());
227 return {context, uname};
228}
229
230static bool isLocalVariableType(SymbolKind K) {
231 switch (K) {
232 case S_REGISTER:
233 case S_REGREL32:
234 case S_LOCAL:
235 return true;
236 default:
237 break;
238 }
239 return false;
240}
241
242clang::Decl *PdbAstBuilder::GetOrCreateSymbolForId(PdbCompilandSymId id) {
243 SymbolFileNativePDB *pdb = static_cast<SymbolFileNativePDB *>(
244 m_clang.GetSymbolFile()->GetBackingSymbolFile());
245 PdbIndex &index = pdb->GetIndex();
246 CVSymbol cvs = index.ReadSymbolRecord(cu_sym: id);
247
248 if (isLocalVariableType(K: cvs.kind())) {
249 clang::DeclContext *scope = GetParentDeclContext(uid: id);
250 if (!scope)
251 return nullptr;
252 clang::Decl *scope_decl = clang::Decl::castFromDeclContext(scope);
253 PdbCompilandSymId scope_id =
254 PdbSymUid(m_decl_to_status[scope_decl].uid).asCompilandSym();
255 return GetOrCreateVariableDecl(scope_id, var_id: id);
256 }
257
258 switch (cvs.kind()) {
259 case S_GPROC32:
260 case S_LPROC32:
261 return GetOrCreateFunctionDecl(func_id: id);
262 case S_GDATA32:
263 case S_LDATA32:
264 case S_GTHREAD32:
265 case S_CONSTANT:
266 // global variable
267 return nullptr;
268 case S_BLOCK32:
269 return GetOrCreateBlockDecl(block_id: id);
270 case S_INLINESITE:
271 return GetOrCreateInlinedFunctionDecl(inlinesite_id: id);
272 default:
273 return nullptr;
274 }
275}
276
277std::optional<CompilerDecl>
278PdbAstBuilder::GetOrCreateDeclForUid(PdbSymUid uid) {
279 if (clang::Decl *result = TryGetDecl(uid))
280 return ToCompilerDecl(decl&: *result);
281
282 clang::Decl *result = nullptr;
283 switch (uid.kind()) {
284 case PdbSymUidKind::CompilandSym:
285 result = GetOrCreateSymbolForId(id: uid.asCompilandSym());
286 break;
287 case PdbSymUidKind::Type: {
288 clang::QualType qt = GetOrCreateType(type: uid.asTypeSym());
289 if (qt.isNull())
290 return std::nullopt;
291 if (auto *tag = qt->getAsTagDecl()) {
292 result = tag;
293 break;
294 }
295 return std::nullopt;
296 }
297 default:
298 return std::nullopt;
299 }
300
301 if (!result)
302 return std::nullopt;
303 m_uid_to_decl[toOpaqueUid(cid: uid)] = result;
304 return ToCompilerDecl(decl&: *result);
305}
306
307clang::DeclContext *PdbAstBuilder::GetOrCreateDeclContextForUid(PdbSymUid uid) {
308 if (uid.kind() == PdbSymUidKind::CompilandSym) {
309 if (uid.asCompilandSym().offset == 0)
310 return FromCompilerDeclContext(context: GetTranslationUnitDecl());
311 }
312 auto option = GetOrCreateDeclForUid(uid);
313 if (!option)
314 return nullptr;
315 clang::Decl *decl = FromCompilerDecl(decl: *option);
316 if (!decl)
317 return nullptr;
318
319 return clang::Decl::castToDeclContext(decl);
320}
321
322std::pair<clang::DeclContext *, std::string>
323PdbAstBuilder::CreateDeclInfoForUndecoratedName(llvm::StringRef name) {
324 SymbolFileNativePDB *pdb = static_cast<SymbolFileNativePDB *>(
325 m_clang.GetSymbolFile()->GetBackingSymbolFile());
326 PdbIndex &index = pdb->GetIndex();
327 MSVCUndecoratedNameParser parser(name);
328 llvm::ArrayRef<MSVCUndecoratedNameSpecifier> specs = parser.GetSpecifiers();
329
330 auto *context = FromCompilerDeclContext(context: GetTranslationUnitDecl());
331
332 llvm::StringRef uname = specs.back().GetBaseName();
333 specs = specs.drop_back();
334 if (specs.empty())
335 return {context, std::string(name)};
336
337 llvm::StringRef scope_name = specs.back().GetFullName();
338
339 // It might be a class name, try that first.
340 std::vector<TypeIndex> types = index.tpi().findRecordsByName(Name: scope_name);
341 while (!types.empty()) {
342 clang::QualType qt = GetOrCreateType(type: types.back());
343 if (qt.isNull())
344 continue;
345 clang::TagDecl *tag = qt->getAsTagDecl();
346 if (tag)
347 return {clang::TagDecl::castToDeclContext(D: tag), std::string(uname)};
348 types.pop_back();
349 }
350
351 // If that fails, treat it as a series of namespaces.
352 for (const MSVCUndecoratedNameSpecifier &spec : specs) {
353 std::string ns_name = spec.GetBaseName().str();
354 context = GetOrCreateNamespaceDecl(name: ns_name.c_str(), context&: *context);
355 }
356 return {context, std::string(uname)};
357}
358
359clang::DeclContext *PdbAstBuilder::GetParentDeclContext(PdbSymUid uid) {
360 // We must do this *without* calling GetOrCreate on the current uid, as
361 // that would be an infinite recursion.
362 SymbolFileNativePDB *pdb = static_cast<SymbolFileNativePDB *>(
363 m_clang.GetSymbolFile()->GetBackingSymbolFile());
364 PdbIndex& index = pdb->GetIndex();
365 switch (uid.kind()) {
366 case PdbSymUidKind::CompilandSym: {
367 std::optional<PdbCompilandSymId> scope =
368 pdb->FindSymbolScope(id: uid.asCompilandSym());
369 if (scope)
370 return GetOrCreateDeclContextForUid(uid: *scope);
371
372 CVSymbol sym = index.ReadSymbolRecord(cu_sym: uid.asCompilandSym());
373 return CreateDeclInfoForUndecoratedName(name: getSymbolName(Sym: sym)).first;
374 }
375 case PdbSymUidKind::Type: {
376 // It could be a namespace, class, or global. We don't support nested
377 // functions yet. Anyway, we just need to consult the parent type map.
378 PdbTypeSymId type_id = uid.asTypeSym();
379 std::optional<TypeIndex> parent_index = pdb->GetParentType(ti: type_id.index);
380 if (!parent_index)
381 return FromCompilerDeclContext(context: GetTranslationUnitDecl());
382 return GetOrCreateDeclContextForUid(uid: PdbTypeSymId(*parent_index));
383 }
384 case PdbSymUidKind::FieldListMember:
385 // In this case the parent DeclContext is the one for the class that this
386 // member is inside of.
387 break;
388 case PdbSymUidKind::GlobalSym: {
389 // If this refers to a compiland symbol, just recurse in with that symbol.
390 // The only other possibilities are S_CONSTANT and S_UDT, in which case we
391 // need to parse the undecorated name to figure out the scope, then look
392 // that up in the TPI stream. If it's found, it's a type, othewrise it's
393 // a series of namespaces.
394 // FIXME: do this.
395 CVSymbol global = index.ReadSymbolRecord(global: uid.asGlobalSym());
396 switch (global.kind()) {
397 case SymbolKind::S_GDATA32:
398 case SymbolKind::S_LDATA32:
399 return CreateDeclInfoForUndecoratedName(name: getSymbolName(Sym: global)).first;;
400 case SymbolKind::S_PROCREF:
401 case SymbolKind::S_LPROCREF: {
402 ProcRefSym ref{global.kind()};
403 llvm::cantFail(
404 Err: SymbolDeserializer::deserializeAs<ProcRefSym>(Symbol: global, Record&: ref));
405 PdbCompilandSymId cu_sym_id{ref.modi(), ref.SymOffset};
406 return GetParentDeclContext(uid: cu_sym_id);
407 }
408 case SymbolKind::S_CONSTANT:
409 case SymbolKind::S_UDT:
410 return CreateDeclInfoForUndecoratedName(name: getSymbolName(Sym: global)).first;
411 default:
412 break;
413 }
414 break;
415 }
416 default:
417 break;
418 }
419 return FromCompilerDeclContext(context: GetTranslationUnitDecl());
420}
421
422bool PdbAstBuilder::CompleteType(clang::QualType qt) {
423 if (qt.isNull())
424 return false;
425 clang::TagDecl *tag = qt->getAsTagDecl();
426 if (qt->isArrayType()) {
427 const clang::Type *element_type = qt->getArrayElementTypeNoTypeQual();
428 tag = element_type->getAsTagDecl();
429 }
430 if (!tag)
431 return false;
432
433 return CompleteTagDecl(tag&: *tag);
434}
435
436bool PdbAstBuilder::CompleteTagDecl(clang::TagDecl &tag) {
437 // If this is not in our map, it's an error.
438 auto status_iter = m_decl_to_status.find(&tag);
439 lldbassert(status_iter != m_decl_to_status.end());
440
441 // If it's already complete, just return.
442 DeclStatus &status = status_iter->second;
443 if (status.resolved)
444 return true;
445
446 PdbTypeSymId type_id = PdbSymUid(status.uid).asTypeSym();
447 PdbIndex &index = static_cast<SymbolFileNativePDB *>(
448 m_clang.GetSymbolFile()->GetBackingSymbolFile())
449 ->GetIndex();
450 lldbassert(IsTagRecord(type_id, index.tpi()));
451
452 clang::QualType tag_qt = m_clang.getASTContext().getTypeDeclType(&tag);
453 TypeSystemClang::SetHasExternalStorage(type: tag_qt.getAsOpaquePtr(), has_extern: false);
454
455 TypeIndex tag_ti = type_id.index;
456 CVType cvt = index.tpi().getType(Index: tag_ti);
457 if (cvt.kind() == LF_MODIFIER)
458 tag_ti = LookThroughModifierRecord(modifier: cvt);
459
460 PdbTypeSymId best_ti = GetBestPossibleDecl(id: tag_ti, tpi&: index.tpi());
461 cvt = index.tpi().getType(Index: best_ti.index);
462 lldbassert(IsTagRecord(cvt));
463
464 if (IsForwardRefUdt(cvt)) {
465 // If we can't find a full decl for this forward ref anywhere in the debug
466 // info, then we have no way to complete it.
467 return false;
468 }
469
470 TypeIndex field_list_ti = GetFieldListIndex(cvt);
471 CVType field_list_cvt = index.tpi().getType(Index: field_list_ti);
472 if (field_list_cvt.kind() != LF_FIELDLIST)
473 return false;
474 FieldListRecord field_list;
475 if (llvm::Error error = TypeDeserializer::deserializeAs<FieldListRecord>(
476 CVT&: field_list_cvt, Record&: field_list))
477 llvm::consumeError(Err: std::move(error));
478
479 // Visit all members of this class, then perform any finalization necessary
480 // to complete the class.
481 CompilerType ct = ToCompilerType(qt: tag_qt);
482 UdtRecordCompleter completer(best_ti, ct, tag, *this, index, m_decl_to_status,
483 m_cxx_record_map);
484 llvm::Error error =
485 llvm::codeview::visitMemberRecordStream(field_list.Data, completer);
486 completer.complete();
487
488 m_decl_to_status[&tag].resolved = true;
489 if (error) {
490 llvm::consumeError(Err: std::move(error));
491 return false;
492 }
493 return true;
494}
495
496clang::QualType PdbAstBuilder::CreateSimpleType(TypeIndex ti) {
497 if (ti == TypeIndex::NullptrT())
498 return GetBasicType(type: lldb::eBasicTypeNullPtr);
499
500 if (ti.getSimpleMode() != SimpleTypeMode::Direct) {
501 clang::QualType direct_type = GetOrCreateType(type: ti.makeDirect());
502 if (direct_type.isNull())
503 return {};
504 return m_clang.getASTContext().getPointerType(T: direct_type);
505 }
506
507 if (ti.getSimpleKind() == SimpleTypeKind::NotTranslated)
508 return {};
509
510 lldb::BasicType bt = GetCompilerTypeForSimpleKind(kind: ti.getSimpleKind());
511 if (bt == lldb::eBasicTypeInvalid)
512 return {};
513
514 return GetBasicType(type: bt);
515}
516
517clang::QualType PdbAstBuilder::CreatePointerType(const PointerRecord &pointer) {
518 clang::QualType pointee_type = GetOrCreateType(type: pointer.ReferentType);
519
520 // This can happen for pointers to LF_VTSHAPE records, which we shouldn't
521 // create in the AST.
522 if (pointee_type.isNull())
523 return {};
524
525 if (pointer.isPointerToMember()) {
526 MemberPointerInfo mpi = pointer.getMemberInfo();
527 clang::QualType class_type = GetOrCreateType(type: mpi.ContainingType);
528 if (class_type.isNull())
529 return {};
530 if (clang::TagDecl *tag = class_type->getAsTagDecl()) {
531 clang::MSInheritanceAttr::Spelling spelling;
532 switch (mpi.Representation) {
533 case llvm::codeview::PointerToMemberRepresentation::SingleInheritanceData:
534 case llvm::codeview::PointerToMemberRepresentation::
535 SingleInheritanceFunction:
536 spelling =
537 clang::MSInheritanceAttr::Spelling::Keyword_single_inheritance;
538 break;
539 case llvm::codeview::PointerToMemberRepresentation::
540 MultipleInheritanceData:
541 case llvm::codeview::PointerToMemberRepresentation::
542 MultipleInheritanceFunction:
543 spelling =
544 clang::MSInheritanceAttr::Spelling::Keyword_multiple_inheritance;
545 break;
546 case llvm::codeview::PointerToMemberRepresentation::
547 VirtualInheritanceData:
548 case llvm::codeview::PointerToMemberRepresentation::
549 VirtualInheritanceFunction:
550 spelling =
551 clang::MSInheritanceAttr::Spelling::Keyword_virtual_inheritance;
552 break;
553 case llvm::codeview::PointerToMemberRepresentation::Unknown:
554 spelling =
555 clang::MSInheritanceAttr::Spelling::Keyword_unspecified_inheritance;
556 break;
557 default:
558 spelling = clang::MSInheritanceAttr::Spelling::SpellingNotCalculated;
559 break;
560 }
561 tag->addAttr(clang::MSInheritanceAttr::CreateImplicit(
562 m_clang.getASTContext(), spelling));
563 }
564 return m_clang.getASTContext().getMemberPointerType(
565 T: pointee_type, Cls: class_type.getTypePtr());
566 }
567
568 clang::QualType pointer_type;
569 if (pointer.getMode() == PointerMode::LValueReference)
570 pointer_type = m_clang.getASTContext().getLValueReferenceType(T: pointee_type);
571 else if (pointer.getMode() == PointerMode::RValueReference)
572 pointer_type = m_clang.getASTContext().getRValueReferenceType(T: pointee_type);
573 else
574 pointer_type = m_clang.getASTContext().getPointerType(T: pointee_type);
575
576 if ((pointer.getOptions() & PointerOptions::Const) != PointerOptions::None)
577 pointer_type.addConst();
578
579 if ((pointer.getOptions() & PointerOptions::Volatile) != PointerOptions::None)
580 pointer_type.addVolatile();
581
582 if ((pointer.getOptions() & PointerOptions::Restrict) != PointerOptions::None)
583 pointer_type.addRestrict();
584
585 return pointer_type;
586}
587
588clang::QualType
589PdbAstBuilder::CreateModifierType(const ModifierRecord &modifier) {
590 clang::QualType unmodified_type = GetOrCreateType(type: modifier.ModifiedType);
591 if (unmodified_type.isNull())
592 return {};
593
594 if ((modifier.Modifiers & ModifierOptions::Const) != ModifierOptions::None)
595 unmodified_type.addConst();
596 if ((modifier.Modifiers & ModifierOptions::Volatile) != ModifierOptions::None)
597 unmodified_type.addVolatile();
598
599 return unmodified_type;
600}
601
602clang::QualType PdbAstBuilder::CreateRecordType(PdbTypeSymId id,
603 const TagRecord &record) {
604 clang::DeclContext *context = nullptr;
605 std::string uname;
606 std::tie(args&: context, args&: uname) = CreateDeclInfoForType(record, ti: id.index);
607 if (!context)
608 return {};
609
610 clang::TagTypeKind ttk = TranslateUdtKind(cr: record);
611 lldb::AccessType access = (ttk == clang::TagTypeKind::Class)
612 ? lldb::eAccessPrivate
613 : lldb::eAccessPublic;
614
615 ClangASTMetadata metadata;
616 metadata.SetUserID(toOpaqueUid(cid: id));
617 metadata.SetIsDynamicCXXType(false);
618
619 CompilerType ct = m_clang.CreateRecordType(
620 decl_ctx: context, owning_module: OptionalClangModuleID(), access_type: access, name: uname, kind: llvm::to_underlying(E: ttk),
621 language: lldb::eLanguageTypeC_plus_plus, metadata: &metadata);
622
623 lldbassert(ct.IsValid());
624
625 TypeSystemClang::StartTagDeclarationDefinition(type: ct);
626
627 // Even if it's possible, don't complete it at this point. Just mark it
628 // forward resolved, and if/when LLDB needs the full definition, it can
629 // ask us.
630 clang::QualType result =
631 clang::QualType::getFromOpaquePtr(Ptr: ct.GetOpaqueQualType());
632
633 TypeSystemClang::SetHasExternalStorage(type: result.getAsOpaquePtr(), has_extern: true);
634 return result;
635}
636
637clang::Decl *PdbAstBuilder::TryGetDecl(PdbSymUid uid) const {
638 auto iter = m_uid_to_decl.find(Val: toOpaqueUid(cid: uid));
639 if (iter != m_uid_to_decl.end())
640 return iter->second;
641 return nullptr;
642}
643
644clang::NamespaceDecl *
645PdbAstBuilder::GetOrCreateNamespaceDecl(const char *name,
646 clang::DeclContext &context) {
647 return m_clang.GetUniqueNamespaceDeclaration(
648 name: IsAnonymousNamespaceName(name) ? nullptr : name, decl_ctx: &context,
649 owning_module: OptionalClangModuleID());
650}
651
652clang::BlockDecl *
653PdbAstBuilder::GetOrCreateBlockDecl(PdbCompilandSymId block_id) {
654 if (clang::Decl *decl = TryGetDecl(uid: block_id))
655 return llvm::dyn_cast<clang::BlockDecl>(Val: decl);
656
657 clang::DeclContext *scope = GetParentDeclContext(uid: block_id);
658
659 clang::BlockDecl *block_decl =
660 m_clang.CreateBlockDeclaration(ctx: scope, owning_module: OptionalClangModuleID());
661 m_uid_to_decl.insert({toOpaqueUid(cid: block_id), block_decl});
662
663 DeclStatus status;
664 status.resolved = true;
665 status.uid = toOpaqueUid(cid: block_id);
666 m_decl_to_status.insert({block_decl, status});
667
668 return block_decl;
669}
670
671clang::VarDecl *PdbAstBuilder::CreateVariableDecl(PdbSymUid uid, CVSymbol sym,
672 clang::DeclContext &scope) {
673 VariableInfo var_info = GetVariableNameInfo(symbol: sym);
674 clang::QualType qt = GetOrCreateType(type: var_info.type);
675 if (qt.isNull())
676 return nullptr;
677
678 clang::VarDecl *var_decl = m_clang.CreateVariableDeclaration(
679 decl_context: &scope, owning_module: OptionalClangModuleID(), name: var_info.name.str().c_str(), type: qt);
680
681 m_uid_to_decl[toOpaqueUid(cid: uid)] = var_decl;
682 DeclStatus status;
683 status.resolved = true;
684 status.uid = toOpaqueUid(cid: uid);
685 m_decl_to_status.insert({var_decl, status});
686 return var_decl;
687}
688
689clang::VarDecl *
690PdbAstBuilder::GetOrCreateVariableDecl(PdbCompilandSymId scope_id,
691 PdbCompilandSymId var_id) {
692 if (clang::Decl *decl = TryGetDecl(uid: var_id))
693 return llvm::dyn_cast<clang::VarDecl>(Val: decl);
694
695 clang::DeclContext *scope = GetOrCreateDeclContextForUid(uid: scope_id);
696 if (!scope)
697 return nullptr;
698
699 SymbolFileNativePDB *pdb = static_cast<SymbolFileNativePDB *>(
700 m_clang.GetSymbolFile()->GetBackingSymbolFile());
701 PdbIndex &index = pdb->GetIndex();
702 CVSymbol sym = index.ReadSymbolRecord(cu_sym: var_id);
703 return CreateVariableDecl(uid: PdbSymUid(var_id), sym, scope&: *scope);
704}
705
706clang::VarDecl *PdbAstBuilder::GetOrCreateVariableDecl(PdbGlobalSymId var_id) {
707 if (clang::Decl *decl = TryGetDecl(uid: var_id))
708 return llvm::dyn_cast<clang::VarDecl>(Val: decl);
709
710 SymbolFileNativePDB *pdb = static_cast<SymbolFileNativePDB *>(
711 m_clang.GetSymbolFile()->GetBackingSymbolFile());
712 PdbIndex &index = pdb->GetIndex();
713 CVSymbol sym = index.ReadSymbolRecord(global: var_id);
714 auto context = FromCompilerDeclContext(context: GetTranslationUnitDecl());
715 return CreateVariableDecl(uid: PdbSymUid(var_id), sym, scope&: *context);
716}
717
718clang::TypedefNameDecl *
719PdbAstBuilder::GetOrCreateTypedefDecl(PdbGlobalSymId id) {
720 if (clang::Decl *decl = TryGetDecl(uid: id))
721 return llvm::dyn_cast<clang::TypedefNameDecl>(Val: decl);
722
723 SymbolFileNativePDB *pdb = static_cast<SymbolFileNativePDB *>(
724 m_clang.GetSymbolFile()->GetBackingSymbolFile());
725 PdbIndex &index = pdb->GetIndex();
726 CVSymbol sym = index.ReadSymbolRecord(global: id);
727 lldbassert(sym.kind() == S_UDT);
728 UDTSym udt = llvm::cantFail(ValOrErr: SymbolDeserializer::deserializeAs<UDTSym>(Symbol: sym));
729
730 clang::DeclContext *scope = GetParentDeclContext(uid: id);
731
732 PdbTypeSymId real_type_id{udt.Type, false};
733 clang::QualType qt = GetOrCreateType(type: real_type_id);
734 if (qt.isNull() || !scope)
735 return nullptr;
736
737 std::string uname = std::string(DropNameScope(name: udt.Name));
738
739 CompilerType ct = ToCompilerType(qt).CreateTypedef(
740 name: uname.c_str(), decl_ctx: ToCompilerDeclContext(context&: *scope), payload: 0);
741 clang::TypedefNameDecl *tnd = m_clang.GetAsTypedefDecl(type: ct);
742 DeclStatus status;
743 status.resolved = true;
744 status.uid = toOpaqueUid(cid: id);
745 m_decl_to_status.insert({tnd, status});
746 return tnd;
747}
748
749clang::QualType PdbAstBuilder::GetBasicType(lldb::BasicType type) {
750 CompilerType ct = m_clang.GetBasicType(type);
751 return clang::QualType::getFromOpaquePtr(Ptr: ct.GetOpaqueQualType());
752}
753
754clang::QualType PdbAstBuilder::CreateType(PdbTypeSymId type) {
755 if (type.index.isSimple())
756 return CreateSimpleType(ti: type.index);
757
758 SymbolFileNativePDB *pdb = static_cast<SymbolFileNativePDB *>(
759 m_clang.GetSymbolFile()->GetBackingSymbolFile());
760 PdbIndex &index = pdb->GetIndex();
761 CVType cvt = index.tpi().getType(Index: type.index);
762
763 if (cvt.kind() == LF_MODIFIER) {
764 ModifierRecord modifier;
765 llvm::cantFail(
766 Err: TypeDeserializer::deserializeAs<ModifierRecord>(CVT&: cvt, Record&: modifier));
767 return CreateModifierType(modifier);
768 }
769
770 if (cvt.kind() == LF_POINTER) {
771 PointerRecord pointer;
772 llvm::cantFail(
773 Err: TypeDeserializer::deserializeAs<PointerRecord>(CVT&: cvt, Record&: pointer));
774 return CreatePointerType(pointer);
775 }
776
777 if (IsTagRecord(cvt)) {
778 CVTagRecord tag = CVTagRecord::create(type: cvt);
779 if (tag.kind() == CVTagRecord::Union)
780 return CreateRecordType(id: type.index, record: tag.asUnion());
781 if (tag.kind() == CVTagRecord::Enum)
782 return CreateEnumType(id: type.index, record: tag.asEnum());
783 return CreateRecordType(id: type.index, record: tag.asClass());
784 }
785
786 if (cvt.kind() == LF_ARRAY) {
787 ArrayRecord ar;
788 llvm::cantFail(Err: TypeDeserializer::deserializeAs<ArrayRecord>(CVT&: cvt, Record&: ar));
789 return CreateArrayType(array: ar);
790 }
791
792 if (cvt.kind() == LF_PROCEDURE) {
793 ProcedureRecord pr;
794 llvm::cantFail(Err: TypeDeserializer::deserializeAs<ProcedureRecord>(CVT&: cvt, Record&: pr));
795 return CreateFunctionType(args_type_idx: pr.ArgumentList, return_type_idx: pr.ReturnType, calling_convention: pr.CallConv);
796 }
797
798 if (cvt.kind() == LF_MFUNCTION) {
799 MemberFunctionRecord mfr;
800 llvm::cantFail(
801 Err: TypeDeserializer::deserializeAs<MemberFunctionRecord>(CVT&: cvt, Record&: mfr));
802 return CreateFunctionType(args_type_idx: mfr.ArgumentList, return_type_idx: mfr.ReturnType, calling_convention: mfr.CallConv);
803 }
804
805 return {};
806}
807
808clang::QualType PdbAstBuilder::GetOrCreateType(PdbTypeSymId type) {
809 if (type.index.isNoneType())
810 return {};
811
812 lldb::user_id_t uid = toOpaqueUid(cid: type);
813 auto iter = m_uid_to_type.find(Val: uid);
814 if (iter != m_uid_to_type.end())
815 return iter->second;
816
817 SymbolFileNativePDB *pdb = static_cast<SymbolFileNativePDB *>(
818 m_clang.GetSymbolFile()->GetBackingSymbolFile());
819 PdbIndex &index = pdb->GetIndex();
820 PdbTypeSymId best_type = GetBestPossibleDecl(id: type, tpi&: index.tpi());
821
822 clang::QualType qt;
823 if (best_type.index != type.index) {
824 // This is a forward decl. Call GetOrCreate on the full decl, then map the
825 // forward decl id to the full decl QualType.
826 clang::QualType qt = GetOrCreateType(type: best_type);
827 if (qt.isNull())
828 return {};
829 m_uid_to_type[toOpaqueUid(cid: type)] = qt;
830 return qt;
831 }
832
833 // This is either a full decl, or a forward decl with no matching full decl
834 // in the debug info.
835 qt = CreateType(type);
836 if (qt.isNull())
837 return {};
838
839 m_uid_to_type[toOpaqueUid(cid: type)] = qt;
840 if (IsTagRecord(id: type, tpi&: index.tpi())) {
841 clang::TagDecl *tag = qt->getAsTagDecl();
842 lldbassert(m_decl_to_status.count(tag) == 0);
843
844 DeclStatus &status = m_decl_to_status[tag];
845 status.uid = uid;
846 status.resolved = false;
847 }
848 return qt;
849}
850
851clang::FunctionDecl *
852PdbAstBuilder::CreateFunctionDecl(PdbCompilandSymId func_id,
853 llvm::StringRef func_name, TypeIndex func_ti,
854 CompilerType func_ct, uint32_t param_count,
855 clang::StorageClass func_storage,
856 bool is_inline, clang::DeclContext *parent) {
857 clang::FunctionDecl *function_decl = nullptr;
858 if (parent->isRecord()) {
859 SymbolFileNativePDB *pdb = static_cast<SymbolFileNativePDB *>(
860 m_clang.GetSymbolFile()->GetBackingSymbolFile());
861 PdbIndex &index = pdb->GetIndex();
862 clang::QualType parent_qt = llvm::cast<clang::TypeDecl>(Val: parent)
863 ->getTypeForDecl()
864 ->getCanonicalTypeInternal();
865 lldb::opaque_compiler_type_t parent_opaque_ty =
866 ToCompilerType(qt: parent_qt).GetOpaqueQualType();
867 // FIXME: Remove this workaround.
868 auto iter = m_cxx_record_map.find(Val: parent_opaque_ty);
869 if (iter != m_cxx_record_map.end()) {
870 if (iter->getSecond().contains(V: {func_name, func_ct})) {
871 return nullptr;
872 }
873 }
874
875 CVType cvt = index.tpi().getType(Index: func_ti);
876 MemberFunctionRecord func_record(static_cast<TypeRecordKind>(cvt.kind()));
877 llvm::cantFail(Err: TypeDeserializer::deserializeAs<MemberFunctionRecord>(
878 CVT&: cvt, Record&: func_record));
879 TypeIndex class_index = func_record.getClassType();
880
881 CVType parent_cvt = index.tpi().getType(Index: class_index);
882 TagRecord tag_record = CVTagRecord::create(type: parent_cvt).asTag();
883 // If it's a forward reference, try to get the real TypeIndex.
884 if (tag_record.isForwardRef()) {
885 llvm::Expected<TypeIndex> eti =
886 index.tpi().findFullDeclForForwardRef(ForwardRefTI: class_index);
887 if (eti) {
888 tag_record = CVTagRecord::create(type: index.tpi().getType(Index: *eti)).asTag();
889 }
890 }
891 if (!tag_record.FieldList.isSimple()) {
892 CVType field_list_cvt = index.tpi().getType(Index: tag_record.FieldList);
893 FieldListRecord field_list;
894 if (llvm::Error error = TypeDeserializer::deserializeAs<FieldListRecord>(
895 CVT&: field_list_cvt, Record&: field_list))
896 llvm::consumeError(Err: std::move(error));
897 CreateMethodDecl process(index, m_clang, func_ti, function_decl,
898 parent_opaque_ty, func_name, func_ct);
899 if (llvm::Error err = visitMemberRecordStream(FieldList: field_list.Data, Callbacks&: process))
900 llvm::consumeError(Err: std::move(err));
901 }
902
903 if (!function_decl) {
904 function_decl = m_clang.AddMethodToCXXRecordType(
905 type: parent_opaque_ty, name: func_name,
906 /*mangled_name=*/nullptr, method_type: func_ct,
907 /*access=*/lldb::AccessType::eAccessPublic,
908 /*is_virtual=*/false, /*is_static=*/false,
909 /*is_inline=*/false, /*is_explicit=*/false,
910 /*is_attr_used=*/false, /*is_artificial=*/false);
911 }
912 m_cxx_record_map[parent_opaque_ty].insert(V: {func_name, func_ct});
913 } else {
914 function_decl = m_clang.CreateFunctionDeclaration(
915 decl_ctx: parent, owning_module: OptionalClangModuleID(), name: func_name, function_Type: func_ct, storage: func_storage,
916 is_inline);
917 CreateFunctionParameters(func_id, function_decl&: *function_decl, param_count);
918 }
919 return function_decl;
920}
921
922clang::FunctionDecl *
923PdbAstBuilder::GetOrCreateInlinedFunctionDecl(PdbCompilandSymId inlinesite_id) {
924 SymbolFileNativePDB *pdb = static_cast<SymbolFileNativePDB *>(
925 m_clang.GetSymbolFile()->GetBackingSymbolFile());
926 PdbIndex &index = pdb->GetIndex();
927 CompilandIndexItem *cii =
928 index.compilands().GetCompiland(modi: inlinesite_id.modi);
929 CVSymbol sym = cii->m_debug_stream.readSymbolAtOffset(Offset: inlinesite_id.offset);
930 InlineSiteSym inline_site(static_cast<SymbolRecordKind>(sym.kind()));
931 cantFail(Err: SymbolDeserializer::deserializeAs<InlineSiteSym>(Symbol: sym, Record&: inline_site));
932
933 // Inlinee is the id index to the function id record that is inlined.
934 PdbTypeSymId func_id(inline_site.Inlinee, true);
935 // Look up the function decl by the id index to see if we have created a
936 // function decl for a different inlinesite that refers the same function.
937 if (clang::Decl *decl = TryGetDecl(uid: func_id))
938 return llvm::dyn_cast<clang::FunctionDecl>(Val: decl);
939 clang::FunctionDecl *function_decl =
940 CreateFunctionDeclFromId(func_tid: func_id, func_sid: inlinesite_id);
941 if (function_decl == nullptr)
942 return nullptr;
943
944 // Use inline site id in m_decl_to_status because it's expected to be a
945 // PdbCompilandSymId so that we can parse local variables info after it.
946 uint64_t inlinesite_uid = toOpaqueUid(cid: inlinesite_id);
947 DeclStatus status;
948 status.resolved = true;
949 status.uid = inlinesite_uid;
950 m_decl_to_status.insert({function_decl, status});
951 // Use the index in IPI stream as uid in m_uid_to_decl, because index in IPI
952 // stream are unique and there could be multiple inline sites (different ids)
953 // referring the same inline function. This avoid creating multiple same
954 // inline function delcs.
955 uint64_t func_uid = toOpaqueUid(cid: func_id);
956 lldbassert(m_uid_to_decl.count(func_uid) == 0);
957 m_uid_to_decl[func_uid] = function_decl;
958 return function_decl;
959}
960
961clang::FunctionDecl *
962PdbAstBuilder::CreateFunctionDeclFromId(PdbTypeSymId func_tid,
963 PdbCompilandSymId func_sid) {
964 lldbassert(func_tid.is_ipi);
965 SymbolFileNativePDB *pdb = static_cast<SymbolFileNativePDB *>(
966 m_clang.GetSymbolFile()->GetBackingSymbolFile());
967 PdbIndex &index = pdb->GetIndex();
968 CVType func_cvt = index.ipi().getType(Index: func_tid.index);
969 llvm::StringRef func_name;
970 TypeIndex func_ti;
971 clang::DeclContext *parent = nullptr;
972 switch (func_cvt.kind()) {
973 case LF_MFUNC_ID: {
974 MemberFuncIdRecord mfr;
975 cantFail(
976 Err: TypeDeserializer::deserializeAs<MemberFuncIdRecord>(CVT&: func_cvt, Record&: mfr));
977 func_name = mfr.getName();
978 func_ti = mfr.getFunctionType();
979 PdbTypeSymId class_type_id(mfr.ClassType, false);
980 parent = GetOrCreateDeclContextForUid(uid: class_type_id);
981 break;
982 }
983 case LF_FUNC_ID: {
984 FuncIdRecord fir;
985 cantFail(Err: TypeDeserializer::deserializeAs<FuncIdRecord>(CVT&: func_cvt, Record&: fir));
986 func_name = fir.getName();
987 func_ti = fir.getFunctionType();
988 parent = FromCompilerDeclContext(context: GetTranslationUnitDecl());
989 if (!fir.ParentScope.isNoneType()) {
990 CVType parent_cvt = index.ipi().getType(Index: fir.ParentScope);
991 if (parent_cvt.kind() == LF_STRING_ID) {
992 StringIdRecord sir;
993 cantFail(
994 Err: TypeDeserializer::deserializeAs<StringIdRecord>(CVT&: parent_cvt, Record&: sir));
995 parent = GetOrCreateNamespaceDecl(name: sir.String.data(), context&: *parent);
996 }
997 }
998 break;
999 }
1000 default:
1001 lldbassert(false && "Invalid function id type!");
1002 }
1003 clang::QualType func_qt = GetOrCreateType(type: func_ti);
1004 if (func_qt.isNull() || !parent)
1005 return nullptr;
1006 CompilerType func_ct = ToCompilerType(qt: func_qt);
1007 uint32_t param_count =
1008 llvm::cast<clang::FunctionProtoType>(Val&: func_qt)->getNumParams();
1009 return CreateFunctionDecl(func_id: func_sid, func_name, func_ti, func_ct, param_count,
1010 func_storage: clang::SC_None, is_inline: true, parent);
1011}
1012
1013clang::FunctionDecl *
1014PdbAstBuilder::GetOrCreateFunctionDecl(PdbCompilandSymId func_id) {
1015 if (clang::Decl *decl = TryGetDecl(uid: func_id))
1016 return llvm::dyn_cast<clang::FunctionDecl>(Val: decl);
1017
1018 clang::DeclContext *parent = GetParentDeclContext(uid: PdbSymUid(func_id));
1019 if (!parent)
1020 return nullptr;
1021 std::string context_name;
1022 if (clang::NamespaceDecl *ns = llvm::dyn_cast<clang::NamespaceDecl>(Val: parent)) {
1023 context_name = ns->getQualifiedNameAsString();
1024 } else if (clang::TagDecl *tag = llvm::dyn_cast<clang::TagDecl>(Val: parent)) {
1025 context_name = tag->getQualifiedNameAsString();
1026 }
1027
1028 SymbolFileNativePDB *pdb = static_cast<SymbolFileNativePDB *>(
1029 m_clang.GetSymbolFile()->GetBackingSymbolFile());
1030 PdbIndex &index = pdb->GetIndex();
1031 CVSymbol cvs = index.ReadSymbolRecord(cu_sym: func_id);
1032 ProcSym proc(static_cast<SymbolRecordKind>(cvs.kind()));
1033 llvm::cantFail(Err: SymbolDeserializer::deserializeAs<ProcSym>(Symbol: cvs, Record&: proc));
1034
1035 PdbTypeSymId type_id(proc.FunctionType);
1036 clang::QualType qt = GetOrCreateType(type: type_id);
1037 if (qt.isNull())
1038 return nullptr;
1039
1040 clang::StorageClass storage = clang::SC_None;
1041 if (proc.Kind == SymbolRecordKind::ProcSym)
1042 storage = clang::SC_Static;
1043
1044 const clang::FunctionProtoType *func_type =
1045 llvm::dyn_cast<clang::FunctionProtoType>(Val&: qt);
1046
1047 CompilerType func_ct = ToCompilerType(qt);
1048
1049 llvm::StringRef proc_name = proc.Name;
1050 proc_name.consume_front(Prefix: context_name);
1051 proc_name.consume_front(Prefix: "::");
1052 clang::FunctionDecl *function_decl =
1053 CreateFunctionDecl(func_id, func_name: proc_name, func_ti: proc.FunctionType, func_ct,
1054 param_count: func_type->getNumParams(), func_storage: storage, is_inline: false, parent);
1055 if (function_decl == nullptr)
1056 return nullptr;
1057
1058 lldbassert(m_uid_to_decl.count(toOpaqueUid(func_id)) == 0);
1059 m_uid_to_decl[toOpaqueUid(cid: func_id)] = function_decl;
1060 DeclStatus status;
1061 status.resolved = true;
1062 status.uid = toOpaqueUid(cid: func_id);
1063 m_decl_to_status.insert({function_decl, status});
1064
1065 return function_decl;
1066}
1067
1068void PdbAstBuilder::CreateFunctionParameters(PdbCompilandSymId func_id,
1069 clang::FunctionDecl &function_decl,
1070 uint32_t param_count) {
1071 SymbolFileNativePDB *pdb = static_cast<SymbolFileNativePDB *>(
1072 m_clang.GetSymbolFile()->GetBackingSymbolFile());
1073 PdbIndex &index = pdb->GetIndex();
1074 CompilandIndexItem *cii = index.compilands().GetCompiland(modi: func_id.modi);
1075 CVSymbolArray scope =
1076 cii->m_debug_stream.getSymbolArrayForScope(ScopeBegin: func_id.offset);
1077
1078 scope.drop_front();
1079 auto begin = scope.begin();
1080 auto end = scope.end();
1081 std::vector<clang::ParmVarDecl *> params;
1082 for (uint32_t i = 0; i < param_count && begin != end;) {
1083 uint32_t record_offset = begin.offset();
1084 CVSymbol sym = *begin++;
1085
1086 TypeIndex param_type;
1087 llvm::StringRef param_name;
1088 switch (sym.kind()) {
1089 case S_REGREL32: {
1090 RegRelativeSym reg(SymbolRecordKind::RegRelativeSym);
1091 cantFail(Err: SymbolDeserializer::deserializeAs<RegRelativeSym>(Symbol: sym, Record&: reg));
1092 param_type = reg.Type;
1093 param_name = reg.Name;
1094 break;
1095 }
1096 case S_REGISTER: {
1097 RegisterSym reg(SymbolRecordKind::RegisterSym);
1098 cantFail(Err: SymbolDeserializer::deserializeAs<RegisterSym>(Symbol: sym, Record&: reg));
1099 param_type = reg.Index;
1100 param_name = reg.Name;
1101 break;
1102 }
1103 case S_LOCAL: {
1104 LocalSym local(SymbolRecordKind::LocalSym);
1105 cantFail(Err: SymbolDeserializer::deserializeAs<LocalSym>(Symbol: sym, Record&: local));
1106 if ((local.Flags & LocalSymFlags::IsParameter) == LocalSymFlags::None)
1107 continue;
1108 param_type = local.Type;
1109 param_name = local.Name;
1110 break;
1111 }
1112 case S_BLOCK32:
1113 case S_INLINESITE:
1114 case S_INLINESITE2:
1115 // All parameters should come before the first block/inlinesite. If that
1116 // isn't the case, then perhaps this is bad debug info that doesn't
1117 // contain information about all parameters.
1118 return;
1119 default:
1120 continue;
1121 }
1122
1123 PdbCompilandSymId param_uid(func_id.modi, record_offset);
1124 clang::QualType qt = GetOrCreateType(type: param_type);
1125 if (qt.isNull())
1126 return;
1127
1128 CompilerType param_type_ct = m_clang.GetType(qt);
1129 clang::ParmVarDecl *param = m_clang.CreateParameterDeclaration(
1130 &function_decl, OptionalClangModuleID(), param_name.str().c_str(),
1131 param_type_ct, clang::SC_None, true);
1132 lldbassert(m_uid_to_decl.count(toOpaqueUid(param_uid)) == 0);
1133
1134 m_uid_to_decl[toOpaqueUid(cid: param_uid)] = param;
1135 params.push_back(x: param);
1136 ++i;
1137 }
1138
1139 if (!params.empty() && params.size() == param_count)
1140 m_clang.SetFunctionParameters(function_decl: &function_decl, params);
1141}
1142
1143clang::QualType PdbAstBuilder::CreateEnumType(PdbTypeSymId id,
1144 const EnumRecord &er) {
1145 clang::DeclContext *decl_context = nullptr;
1146 std::string uname;
1147 std::tie(args&: decl_context, args&: uname) = CreateDeclInfoForType(record: er, ti: id.index);
1148 if (!decl_context)
1149 return {};
1150
1151 clang::QualType underlying_type = GetOrCreateType(type: er.UnderlyingType);
1152 if (underlying_type.isNull())
1153 return {};
1154
1155 Declaration declaration;
1156 CompilerType enum_ct = m_clang.CreateEnumerationType(
1157 name: uname, decl_ctx: decl_context, owning_module: OptionalClangModuleID(), decl: declaration,
1158 integer_qual_type: ToCompilerType(qt: underlying_type), is_scoped: er.isScoped());
1159
1160 TypeSystemClang::StartTagDeclarationDefinition(type: enum_ct);
1161 TypeSystemClang::SetHasExternalStorage(type: enum_ct.GetOpaqueQualType(), has_extern: true);
1162
1163 return clang::QualType::getFromOpaquePtr(Ptr: enum_ct.GetOpaqueQualType());
1164}
1165
1166clang::QualType PdbAstBuilder::CreateArrayType(const ArrayRecord &ar) {
1167 clang::QualType element_type = GetOrCreateType(type: ar.ElementType);
1168
1169 SymbolFileNativePDB *pdb = static_cast<SymbolFileNativePDB *>(
1170 m_clang.GetSymbolFile()->GetBackingSymbolFile());
1171 PdbIndex &index = pdb->GetIndex();
1172 uint64_t element_size = GetSizeOfType(id: {ar.ElementType}, tpi&: index.tpi());
1173 if (element_type.isNull() || element_size == 0)
1174 return {};
1175 uint64_t element_count = ar.Size / element_size;
1176
1177 CompilerType array_ct = m_clang.CreateArrayType(element_type: ToCompilerType(qt: element_type),
1178 element_count, is_vector: false);
1179 return clang::QualType::getFromOpaquePtr(Ptr: array_ct.GetOpaqueQualType());
1180}
1181
1182clang::QualType PdbAstBuilder::CreateFunctionType(
1183 TypeIndex args_type_idx, TypeIndex return_type_idx,
1184 llvm::codeview::CallingConvention calling_convention) {
1185 SymbolFileNativePDB *pdb = static_cast<SymbolFileNativePDB *>(
1186 m_clang.GetSymbolFile()->GetBackingSymbolFile());
1187 PdbIndex &index = pdb->GetIndex();
1188 TpiStream &stream = index.tpi();
1189 CVType args_cvt = stream.getType(Index: args_type_idx);
1190 ArgListRecord args;
1191 llvm::cantFail(
1192 Err: TypeDeserializer::deserializeAs<ArgListRecord>(CVT&: args_cvt, Record&: args));
1193
1194 llvm::ArrayRef<TypeIndex> arg_indices = llvm::ArrayRef(args.ArgIndices);
1195 bool is_variadic = IsCVarArgsFunction(args: arg_indices);
1196 if (is_variadic)
1197 arg_indices = arg_indices.drop_back();
1198
1199 std::vector<CompilerType> arg_types;
1200 arg_types.reserve(n: arg_indices.size());
1201
1202 for (TypeIndex arg_index : arg_indices) {
1203 clang::QualType arg_type = GetOrCreateType(type: arg_index);
1204 if (arg_type.isNull())
1205 continue;
1206 arg_types.push_back(x: ToCompilerType(qt: arg_type));
1207 }
1208
1209 clang::QualType return_type = GetOrCreateType(type: return_type_idx);
1210 if (return_type.isNull())
1211 return {};
1212
1213 std::optional<clang::CallingConv> cc =
1214 TranslateCallingConvention(conv: calling_convention);
1215 if (!cc)
1216 return {};
1217
1218 CompilerType return_ct = ToCompilerType(qt: return_type);
1219 CompilerType func_sig_ast_type = m_clang.CreateFunctionType(
1220 result_type: return_ct, args: arg_types.data(), num_args: arg_types.size(), is_variadic, type_quals: 0, cc: *cc);
1221
1222 return clang::QualType::getFromOpaquePtr(
1223 Ptr: func_sig_ast_type.GetOpaqueQualType());
1224}
1225
1226static bool isTagDecl(clang::DeclContext &context) {
1227 return llvm::isa<clang::TagDecl>(Val: &context);
1228}
1229
1230static bool isFunctionDecl(clang::DeclContext &context) {
1231 return llvm::isa<clang::FunctionDecl>(Val: &context);
1232}
1233
1234static bool isBlockDecl(clang::DeclContext &context) {
1235 return llvm::isa<clang::BlockDecl>(Val: &context);
1236}
1237
1238void PdbAstBuilder::ParseNamespace(clang::DeclContext &context) {
1239 clang::NamespaceDecl *ns = llvm::dyn_cast<clang::NamespaceDecl>(Val: &context);
1240 if (m_parsed_namespaces.contains(V: ns))
1241 return;
1242 std::string qname = ns->getQualifiedNameAsString();
1243 SymbolFileNativePDB *pdb = static_cast<SymbolFileNativePDB *>(
1244 m_clang.GetSymbolFile()->GetBackingSymbolFile());
1245 PdbIndex &index = pdb->GetIndex();
1246 TypeIndex ti{index.tpi().TypeIndexBegin()};
1247 for (const CVType &cvt : index.tpi().typeArray()) {
1248 PdbTypeSymId tid{ti};
1249 ++ti;
1250
1251 if (!IsTagRecord(cvt))
1252 continue;
1253
1254 CVTagRecord tag = CVTagRecord::create(type: cvt);
1255
1256 // Call CreateDeclInfoForType unconditionally so that the namespace info
1257 // gets created. But only call CreateRecordType if the namespace name
1258 // matches.
1259 clang::DeclContext *context = nullptr;
1260 std::string uname;
1261 std::tie(args&: context, args&: uname) = CreateDeclInfoForType(record: tag.asTag(), ti: tid.index);
1262 if (!context || !context->isNamespace())
1263 continue;
1264
1265 clang::NamespaceDecl *ns = llvm::cast<clang::NamespaceDecl>(Val: context);
1266 llvm::StringRef ns_name = ns->getName();
1267 if (ns_name.starts_with(Prefix: qname)) {
1268 ns_name = ns_name.drop_front(N: qname.size());
1269 if (ns_name.starts_with(Prefix: "::"))
1270 GetOrCreateType(type: tid);
1271 }
1272 }
1273 ParseAllFunctionsAndNonLocalVars();
1274 m_parsed_namespaces.insert(V: ns);
1275}
1276
1277void PdbAstBuilder::ParseAllTypes() {
1278 llvm::call_once(flag&: m_parse_all_types, F: [this]() {
1279 SymbolFileNativePDB *pdb = static_cast<SymbolFileNativePDB *>(
1280 m_clang.GetSymbolFile()->GetBackingSymbolFile());
1281 PdbIndex &index = pdb->GetIndex();
1282 TypeIndex ti{index.tpi().TypeIndexBegin()};
1283 for (const CVType &cvt : index.tpi().typeArray()) {
1284 PdbTypeSymId tid{ti};
1285 ++ti;
1286
1287 if (!IsTagRecord(cvt))
1288 continue;
1289
1290 GetOrCreateType(type: tid);
1291 }
1292 });
1293}
1294
1295void PdbAstBuilder::ParseAllFunctionsAndNonLocalVars() {
1296 llvm::call_once(flag&: m_parse_functions_and_non_local_vars, F: [this]() {
1297 SymbolFileNativePDB *pdb = static_cast<SymbolFileNativePDB *>(
1298 m_clang.GetSymbolFile()->GetBackingSymbolFile());
1299 PdbIndex &index = pdb->GetIndex();
1300 uint32_t module_count = index.dbi().modules().getModuleCount();
1301 for (uint16_t modi = 0; modi < module_count; ++modi) {
1302 CompilandIndexItem &cii = index.compilands().GetOrCreateCompiland(modi);
1303 const CVSymbolArray &symbols = cii.m_debug_stream.getSymbolArray();
1304 auto iter = symbols.begin();
1305 while (iter != symbols.end()) {
1306 PdbCompilandSymId sym_id{modi, iter.offset()};
1307
1308 switch (iter->kind()) {
1309 case S_GPROC32:
1310 case S_LPROC32:
1311 GetOrCreateFunctionDecl(func_id: sym_id);
1312 iter = symbols.at(Offset: getScopeEndOffset(Symbol: *iter));
1313 break;
1314 case S_GDATA32:
1315 case S_GTHREAD32:
1316 case S_LDATA32:
1317 case S_LTHREAD32:
1318 GetOrCreateVariableDecl(scope_id: PdbCompilandSymId(modi, 0), var_id: sym_id);
1319 ++iter;
1320 break;
1321 default:
1322 ++iter;
1323 continue;
1324 }
1325 }
1326 }
1327 });
1328}
1329
1330static CVSymbolArray skipFunctionParameters(clang::Decl &decl,
1331 const CVSymbolArray &symbols) {
1332 clang::FunctionDecl *func_decl = llvm::dyn_cast<clang::FunctionDecl>(Val: &decl);
1333 if (!func_decl)
1334 return symbols;
1335 unsigned int params = func_decl->getNumParams();
1336 if (params == 0)
1337 return symbols;
1338
1339 CVSymbolArray result = symbols;
1340
1341 while (!result.empty()) {
1342 if (params == 0)
1343 return result;
1344
1345 CVSymbol sym = *result.begin();
1346 result.drop_front();
1347
1348 if (!isLocalVariableType(K: sym.kind()))
1349 continue;
1350
1351 --params;
1352 }
1353 return result;
1354}
1355
1356void PdbAstBuilder::ParseBlockChildren(PdbCompilandSymId block_id) {
1357 SymbolFileNativePDB *pdb = static_cast<SymbolFileNativePDB *>(
1358 m_clang.GetSymbolFile()->GetBackingSymbolFile());
1359 PdbIndex &index = pdb->GetIndex();
1360 CVSymbol sym = index.ReadSymbolRecord(cu_sym: block_id);
1361 lldbassert(sym.kind() == S_GPROC32 || sym.kind() == S_LPROC32 ||
1362 sym.kind() == S_BLOCK32 || sym.kind() == S_INLINESITE);
1363 CompilandIndexItem &cii =
1364 index.compilands().GetOrCreateCompiland(modi: block_id.modi);
1365 CVSymbolArray symbols =
1366 cii.m_debug_stream.getSymbolArrayForScope(ScopeBegin: block_id.offset);
1367
1368 // Function parameters should already have been created when the function was
1369 // parsed.
1370 if (sym.kind() == S_GPROC32 || sym.kind() == S_LPROC32)
1371 symbols =
1372 skipFunctionParameters(decl&: *m_uid_to_decl[toOpaqueUid(cid: block_id)], symbols);
1373
1374 symbols.drop_front();
1375 auto begin = symbols.begin();
1376 while (begin != symbols.end()) {
1377 PdbCompilandSymId child_sym_id(block_id.modi, begin.offset());
1378 GetOrCreateSymbolForId(id: child_sym_id);
1379 if (begin->kind() == S_BLOCK32 || begin->kind() == S_INLINESITE) {
1380 ParseBlockChildren(block_id: child_sym_id);
1381 begin = symbols.at(Offset: getScopeEndOffset(Symbol: *begin));
1382 }
1383 ++begin;
1384 }
1385}
1386
1387void PdbAstBuilder::ParseDeclsForSimpleContext(clang::DeclContext &context) {
1388
1389 clang::Decl *decl = clang::Decl::castFromDeclContext(&context);
1390 lldbassert(decl);
1391
1392 auto iter = m_decl_to_status.find(Val: decl);
1393 lldbassert(iter != m_decl_to_status.end());
1394
1395 if (auto *tag = llvm::dyn_cast<clang::TagDecl>(Val: &context)) {
1396 CompleteTagDecl(tag&: *tag);
1397 return;
1398 }
1399
1400 if (isFunctionDecl(context) || isBlockDecl(context)) {
1401 PdbCompilandSymId block_id = PdbSymUid(iter->second.uid).asCompilandSym();
1402 ParseBlockChildren(block_id);
1403 }
1404}
1405
1406void PdbAstBuilder::ParseDeclsForContext(clang::DeclContext &context) {
1407 // Namespaces aren't explicitly represented in the debug info, and the only
1408 // way to parse them is to parse all type info, demangling every single type
1409 // and trying to reconstruct the DeclContext hierarchy this way. Since this
1410 // is an expensive operation, we have to special case it so that we do other
1411 // work (such as parsing the items that appear within the namespaces) at the
1412 // same time.
1413 if (context.isTranslationUnit()) {
1414 ParseAllTypes();
1415 ParseAllFunctionsAndNonLocalVars();
1416 return;
1417 }
1418
1419 if (context.isNamespace()) {
1420 ParseNamespace(context);
1421 return;
1422 }
1423
1424 if (isTagDecl(context) || isFunctionDecl(context) || isBlockDecl(context)) {
1425 ParseDeclsForSimpleContext(context);
1426 return;
1427 }
1428}
1429
1430CompilerDecl PdbAstBuilder::ToCompilerDecl(clang::Decl &decl) {
1431 return m_clang.GetCompilerDecl(decl: &decl);
1432}
1433
1434CompilerType PdbAstBuilder::ToCompilerType(clang::QualType qt) {
1435 return {m_clang.weak_from_this(), qt.getAsOpaquePtr()};
1436}
1437
1438CompilerDeclContext
1439PdbAstBuilder::ToCompilerDeclContext(clang::DeclContext &context) {
1440 return m_clang.CreateDeclContext(ctx: &context);
1441}
1442
1443clang::Decl * PdbAstBuilder::FromCompilerDecl(CompilerDecl decl) {
1444 return ClangUtil::GetDecl(decl);
1445}
1446
1447clang::DeclContext *
1448PdbAstBuilder::FromCompilerDeclContext(CompilerDeclContext context) {
1449 return static_cast<clang::DeclContext *>(context.GetOpaqueDeclContext());
1450}
1451
1452void PdbAstBuilder::Dump(Stream &stream) {
1453 m_clang.Dump(output&: stream.AsRawOstream());
1454}
1455

source code of lldb/source/Plugins/SymbolFile/NativePDB/PdbAstBuilder.cpp