1 //===-- PdbUtil.cpp ---------------------------------------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
12 #include "DWARFLocationExpression.h"
14 #include "PdbSymUid.h"
16 #include "llvm/DebugInfo/CodeView/SymbolDeserializer.h"
17 #include "llvm/DebugInfo/CodeView/TypeDeserializer.h"
18 #include "llvm/DebugInfo/PDB/Native/TpiStream.h"
20 #include "Plugins/Language/CPlusPlus/MSVCUndecoratedNameParser.h"
21 #include "lldb/Utility/LLDBAssert.h"
22 #include "lldb/lldb-enumerations.h"
24 using namespace lldb_private;
25 using namespace lldb_private::npdb;
26 using namespace llvm::codeview;
27 using namespace llvm::pdb;
29 static Variable::RangeList
30 MakeRangeList(const PdbIndex &index, const LocalVariableAddrRange &range,
31 llvm::ArrayRef<LocalVariableAddrGap> gaps) {
33 index.MakeVirtualAddress(range.ISectStart, range.OffsetStart);
34 lldb::addr_t end = start + range.Range;
36 Variable::RangeList result;
37 while (!gaps.empty()) {
38 const LocalVariableAddrGap &gap = gaps.front();
40 lldb::addr_t size = gap.GapStartOffset - start;
41 result.Append(start, size);
43 gaps = gaps.drop_front();
46 result.Append(start, end);
50 CVTagRecord CVTagRecord::create(CVType type) {
51 assert(IsTagRecord(type) && "type is not a tag record!");
52 switch (type.kind()) {
57 llvm::cantFail(TypeDeserializer::deserializeAs<ClassRecord>(type, cr));
58 return CVTagRecord(std::move(cr));
62 llvm::cantFail(TypeDeserializer::deserializeAs<UnionRecord>(type, ur));
63 return CVTagRecord(std::move(ur));
67 llvm::cantFail(TypeDeserializer::deserializeAs<EnumRecord>(type, er));
68 return CVTagRecord(std::move(er));
71 llvm_unreachable("Unreachable!");
75 CVTagRecord::CVTagRecord(ClassRecord &&c)
76 : cvclass(std::move(c)),
77 m_kind(cvclass.Kind == TypeRecordKind::Struct ? Struct : Class) {}
78 CVTagRecord::CVTagRecord(UnionRecord &&u)
79 : cvunion(std::move(u)), m_kind(Union) {}
80 CVTagRecord::CVTagRecord(EnumRecord &&e) : cvenum(std::move(e)), m_kind(Enum) {}
82 PDB_SymType lldb_private::npdb::CVSymToPDBSym(SymbolKind kind) {
86 return PDB_SymType::CompilandDetails;
88 return PDB_SymType::CompilandEnv;
91 return PDB_SymType::Thunk;
93 return PDB_SymType::CoffGroup;
95 return PDB_SymType::Export;
99 return PDB_SymType::Function;
101 return PDB_SymType::PublicSymbol;
103 return PDB_SymType::InlineSite;
115 return PDB_SymType::Data;
117 return PDB_SymType::Block;
119 return PDB_SymType::Label;
121 return PDB_SymType::CallSite;
122 case S_HEAPALLOCSITE:
123 return PDB_SymType::HeapAllocationSite;
125 return PDB_SymType::Callee;
127 return PDB_SymType::Caller;
129 lldbassert(false && "Invalid symbol record kind!");
131 return PDB_SymType::None;
134 PDB_SymType lldb_private::npdb::CVTypeToPDBType(TypeLeafKind kind) {
137 return PDB_SymType::ArrayType;
139 return PDB_SymType::FunctionSig;
141 return PDB_SymType::BaseClass;
143 return PDB_SymType::BaseInterface;
148 return PDB_SymType::UDT;
150 return PDB_SymType::PointerType;
152 return PDB_SymType::Enum;
154 return PDB_SymType::FunctionSig;
156 return PDB_SymType::BuiltinType;
158 lldbassert(false && "Invalid type record kind!");
160 return PDB_SymType::None;
163 bool lldb_private::npdb::SymbolHasAddress(const CVSymbol &sym) {
164 switch (sym.kind()) {
170 case S_LPROC32_DPC_ID:
177 case S_HEAPALLOCSITE:
190 bool lldb_private::npdb::SymbolIsCode(const CVSymbol &sym) {
191 switch (sym.kind()) {
197 case S_LPROC32_DPC_ID:
208 template <typename RecordT> RecordT createRecord(const CVSymbol &sym) {
209 RecordT record(static_cast<SymbolRecordKind>(sym.kind()));
210 cantFail(SymbolDeserializer::deserializeAs<RecordT>(sym, record));
214 template <typename RecordT>
215 static SegmentOffset GetSegmentAndOffset(const CVSymbol &sym) {
216 RecordT record = createRecord<RecordT>(sym);
217 return {record.Segment, record.CodeOffset};
221 SegmentOffset GetSegmentAndOffset<TrampolineSym>(const CVSymbol &sym) {
222 TrampolineSym record = createRecord<TrampolineSym>(sym);
223 return {record.ThunkSection, record.ThunkOffset};
226 template <> SegmentOffset GetSegmentAndOffset<Thunk32Sym>(const CVSymbol &sym) {
227 Thunk32Sym record = createRecord<Thunk32Sym>(sym);
228 return {record.Segment, record.Offset};
232 SegmentOffset GetSegmentAndOffset<CoffGroupSym>(const CVSymbol &sym) {
233 CoffGroupSym record = createRecord<CoffGroupSym>(sym);
234 return {record.Segment, record.Offset};
237 template <> SegmentOffset GetSegmentAndOffset<DataSym>(const CVSymbol &sym) {
238 DataSym record = createRecord<DataSym>(sym);
239 return {record.Segment, record.DataOffset};
243 SegmentOffset GetSegmentAndOffset<ThreadLocalDataSym>(const CVSymbol &sym) {
244 ThreadLocalDataSym record = createRecord<ThreadLocalDataSym>(sym);
245 return {record.Segment, record.DataOffset};
248 SegmentOffset lldb_private::npdb::GetSegmentAndOffset(const CVSymbol &sym) {
249 switch (sym.kind()) {
255 case S_LPROC32_DPC_ID:
256 return ::GetSegmentAndOffset<ProcSym>(sym);
258 return ::GetSegmentAndOffset<Thunk32Sym>(sym);
261 return ::GetSegmentAndOffset<TrampolineSym>(sym);
264 return ::GetSegmentAndOffset<CoffGroupSym>(sym);
267 return ::GetSegmentAndOffset<BlockSym>(sym);
270 return ::GetSegmentAndOffset<LabelSym>(sym);
273 return ::GetSegmentAndOffset<CallSiteInfoSym>(sym);
275 case S_HEAPALLOCSITE:
276 return ::GetSegmentAndOffset<HeapAllocationSiteSym>(sym);
282 return ::GetSegmentAndOffset<DataSym>(sym);
286 return ::GetSegmentAndOffset<ThreadLocalDataSym>(sym);
289 lldbassert(false && "Record does not have a segment/offset!");
294 template <typename RecordT>
295 SegmentOffsetLength GetSegmentOffsetAndLength(const CVSymbol &sym) {
296 RecordT record = createRecord<RecordT>(sym);
297 return {record.Segment, record.CodeOffset, record.CodeSize};
302 GetSegmentOffsetAndLength<TrampolineSym>(const CVSymbol &sym) {
303 TrampolineSym record = createRecord<TrampolineSym>(sym);
304 return {record.ThunkSection, record.ThunkOffset, record.Size};
308 SegmentOffsetLength GetSegmentOffsetAndLength<Thunk32Sym>(const CVSymbol &sym) {
309 Thunk32Sym record = createRecord<Thunk32Sym>(sym);
310 return SegmentOffsetLength{record.Segment, record.Offset, record.Length};
315 GetSegmentOffsetAndLength<CoffGroupSym>(const CVSymbol &sym) {
316 CoffGroupSym record = createRecord<CoffGroupSym>(sym);
317 return SegmentOffsetLength{record.Segment, record.Offset, record.Size};
321 lldb_private::npdb::GetSegmentOffsetAndLength(const CVSymbol &sym) {
322 switch (sym.kind()) {
328 case S_LPROC32_DPC_ID:
329 return ::GetSegmentOffsetAndLength<ProcSym>(sym);
331 return ::GetSegmentOffsetAndLength<Thunk32Sym>(sym);
334 return ::GetSegmentOffsetAndLength<TrampolineSym>(sym);
337 return ::GetSegmentOffsetAndLength<CoffGroupSym>(sym);
340 return ::GetSegmentOffsetAndLength<BlockSym>(sym);
343 lldbassert(false && "Record does not have a segment/offset/length triple!");
348 bool lldb_private::npdb::IsForwardRefUdt(CVType cvt) {
352 switch (cvt.kind()) {
356 llvm::cantFail(TypeDeserializer::deserializeAs<ClassRecord>(cvt, cr));
357 return cr.isForwardRef();
359 llvm::cantFail(TypeDeserializer::deserializeAs<UnionRecord>(cvt, ur));
360 return ur.isForwardRef();
362 llvm::cantFail(TypeDeserializer::deserializeAs<EnumRecord>(cvt, er));
363 return er.isForwardRef();
369 bool lldb_private::npdb::IsTagRecord(llvm::codeview::CVType cvt) {
370 switch (cvt.kind()) {
381 bool lldb_private::npdb::IsClassStructUnion(llvm::codeview::CVType cvt) {
382 switch (cvt.kind()) {
392 bool lldb_private::npdb::IsForwardRefUdt(const PdbTypeSymId &id,
394 if (id.is_ipi || id.index.isSimple())
396 return IsForwardRefUdt(tpi.getType(id.index));
399 bool lldb_private::npdb::IsTagRecord(const PdbTypeSymId &id, TpiStream &tpi) {
400 if (id.is_ipi || id.index.isSimple())
402 return IsTagRecord(tpi.getType(id.index));
406 lldb_private::npdb::TranslateMemberAccess(MemberAccess access) {
408 case MemberAccess::Private:
409 return lldb::eAccessPrivate;
410 case MemberAccess::Protected:
411 return lldb::eAccessProtected;
412 case MemberAccess::Public:
413 return lldb::eAccessPublic;
414 case MemberAccess::None:
415 return lldb::eAccessNone;
417 llvm_unreachable("unreachable");
420 TypeIndex lldb_private::npdb::GetFieldListIndex(CVType cvt) {
421 switch (cvt.kind()) {
426 cantFail(TypeDeserializer::deserializeAs<ClassRecord>(cvt, cr));
431 cantFail(TypeDeserializer::deserializeAs<UnionRecord>(cvt, ur));
436 cantFail(TypeDeserializer::deserializeAs<EnumRecord>(cvt, er));
440 llvm_unreachable("Unreachable!");
444 TypeIndex lldb_private::npdb::LookThroughModifierRecord(CVType modifier) {
445 lldbassert(modifier.kind() == LF_MODIFIER);
447 llvm::cantFail(TypeDeserializer::deserializeAs<ModifierRecord>(modifier, mr));
448 return mr.ModifiedType;
451 llvm::StringRef lldb_private::npdb::DropNameScope(llvm::StringRef name) {
452 return MSVCUndecoratedNameParser::DropScope(name);
455 VariableInfo lldb_private::npdb::GetVariableNameInfo(CVSymbol sym) {
458 if (sym.kind() == S_REGREL32) {
459 RegRelativeSym reg(SymbolRecordKind::RegRelativeSym);
460 cantFail(SymbolDeserializer::deserializeAs<RegRelativeSym>(sym, reg));
461 result.type = reg.Type;
462 result.name = reg.Name;
466 if (sym.kind() == S_REGISTER) {
467 RegisterSym reg(SymbolRecordKind::RegisterSym);
468 cantFail(SymbolDeserializer::deserializeAs<RegisterSym>(sym, reg));
469 result.type = reg.Index;
470 result.name = reg.Name;
474 if (sym.kind() == S_LOCAL) {
475 LocalSym local(SymbolRecordKind::LocalSym);
476 cantFail(SymbolDeserializer::deserializeAs<LocalSym>(sym, local));
477 result.type = local.Type;
478 result.name = local.Name;
482 if (sym.kind() == S_GDATA32 || sym.kind() == S_LDATA32) {
483 DataSym data(SymbolRecordKind::DataSym);
484 cantFail(SymbolDeserializer::deserializeAs<DataSym>(sym, data));
485 result.type = data.Type;
486 result.name = data.Name;
490 if (sym.kind() == S_GTHREAD32 || sym.kind() == S_LTHREAD32) {
491 ThreadLocalDataSym data(SymbolRecordKind::ThreadLocalDataSym);
492 cantFail(SymbolDeserializer::deserializeAs<ThreadLocalDataSym>(sym, data));
493 result.type = data.Type;
494 result.name = data.Name;
498 if (sym.kind() == S_CONSTANT) {
499 ConstantSym constant(SymbolRecordKind::ConstantSym);
500 cantFail(SymbolDeserializer::deserializeAs<ConstantSym>(sym, constant));
501 result.type = constant.Type;
502 result.name = constant.Name;
506 lldbassert(false && "Invalid variable record kind!");
510 VariableInfo lldb_private::npdb::GetVariableLocationInfo(
511 PdbIndex &index, PdbCompilandSymId var_id, lldb::ModuleSP module) {
513 CVSymbol sym = index.ReadSymbolRecord(var_id);
515 VariableInfo result = GetVariableNameInfo(sym);
517 if (sym.kind() == S_REGREL32) {
518 RegRelativeSym reg(SymbolRecordKind::RegRelativeSym);
519 cantFail(SymbolDeserializer::deserializeAs<RegRelativeSym>(sym, reg));
521 MakeRegRelLocationExpression(reg.Register, reg.Offset, module);
522 result.ranges.emplace();
526 if (sym.kind() == S_REGISTER) {
527 RegisterSym reg(SymbolRecordKind::RegisterSym);
528 cantFail(SymbolDeserializer::deserializeAs<RegisterSym>(sym, reg));
529 result.location = MakeEnregisteredLocationExpression(reg.Register, module);
530 result.ranges.emplace();
534 if (sym.kind() == S_LOCAL) {
535 LocalSym local(SymbolRecordKind::LocalSym);
536 cantFail(SymbolDeserializer::deserializeAs<LocalSym>(sym, local));
538 PdbCompilandSymId loc_specifier_id(var_id.modi,
539 var_id.offset + sym.RecordData.size());
540 CVSymbol loc_specifier_cvs = index.ReadSymbolRecord(loc_specifier_id);
541 if (loc_specifier_cvs.kind() == S_DEFRANGE_FRAMEPOINTER_REL) {
542 DefRangeFramePointerRelSym loc(
543 SymbolRecordKind::DefRangeFramePointerRelSym);
544 cantFail(SymbolDeserializer::deserializeAs<DefRangeFramePointerRelSym>(
545 loc_specifier_cvs, loc));
546 // FIXME: The register needs to come from the S_FRAMEPROC symbol.
548 MakeRegRelLocationExpression(RegisterId::RSP, loc.Offset, module);
549 result.ranges = MakeRangeList(index, loc.Range, loc.Gaps);
551 // FIXME: Handle other kinds
555 llvm_unreachable("Symbol is not a local variable!");
560 lldb_private::npdb::GetCompilerTypeForSimpleKind(SimpleTypeKind kind) {
562 case SimpleTypeKind::Boolean128:
563 case SimpleTypeKind::Boolean16:
564 case SimpleTypeKind::Boolean32:
565 case SimpleTypeKind::Boolean64:
566 case SimpleTypeKind::Boolean8:
567 return lldb::eBasicTypeBool;
568 case SimpleTypeKind::Byte:
569 case SimpleTypeKind::UnsignedCharacter:
570 return lldb::eBasicTypeUnsignedChar;
571 case SimpleTypeKind::NarrowCharacter:
572 return lldb::eBasicTypeChar;
573 case SimpleTypeKind::SignedCharacter:
574 case SimpleTypeKind::SByte:
575 return lldb::eBasicTypeSignedChar;
576 case SimpleTypeKind::Character16:
577 return lldb::eBasicTypeChar16;
578 case SimpleTypeKind::Character32:
579 return lldb::eBasicTypeChar32;
580 case SimpleTypeKind::Complex80:
581 return lldb::eBasicTypeLongDoubleComplex;
582 case SimpleTypeKind::Complex64:
583 return lldb::eBasicTypeDoubleComplex;
584 case SimpleTypeKind::Complex32:
585 return lldb::eBasicTypeFloatComplex;
586 case SimpleTypeKind::Float128:
587 case SimpleTypeKind::Float80:
588 return lldb::eBasicTypeLongDouble;
589 case SimpleTypeKind::Float64:
590 return lldb::eBasicTypeDouble;
591 case SimpleTypeKind::Float32:
592 return lldb::eBasicTypeFloat;
593 case SimpleTypeKind::Float16:
594 return lldb::eBasicTypeHalf;
595 case SimpleTypeKind::Int128:
596 return lldb::eBasicTypeInt128;
597 case SimpleTypeKind::Int64:
598 case SimpleTypeKind::Int64Quad:
599 return lldb::eBasicTypeLongLong;
600 case SimpleTypeKind::Int32:
601 return lldb::eBasicTypeInt;
602 case SimpleTypeKind::Int16:
603 case SimpleTypeKind::Int16Short:
604 return lldb::eBasicTypeShort;
605 case SimpleTypeKind::UInt128:
606 return lldb::eBasicTypeUnsignedInt128;
607 case SimpleTypeKind::UInt64:
608 case SimpleTypeKind::UInt64Quad:
609 return lldb::eBasicTypeUnsignedLongLong;
610 case SimpleTypeKind::HResult:
611 case SimpleTypeKind::UInt32:
612 return lldb::eBasicTypeUnsignedInt;
613 case SimpleTypeKind::UInt16:
614 case SimpleTypeKind::UInt16Short:
615 return lldb::eBasicTypeUnsignedShort;
616 case SimpleTypeKind::Int32Long:
617 return lldb::eBasicTypeLong;
618 case SimpleTypeKind::UInt32Long:
619 return lldb::eBasicTypeUnsignedLong;
620 case SimpleTypeKind::Void:
621 return lldb::eBasicTypeVoid;
622 case SimpleTypeKind::WideCharacter:
623 return lldb::eBasicTypeWChar;
625 return lldb::eBasicTypeInvalid;
629 size_t lldb_private::npdb::GetTypeSizeForSimpleKind(SimpleTypeKind kind) {
631 case SimpleTypeKind::Boolean128:
632 case SimpleTypeKind::Int128:
633 case SimpleTypeKind::UInt128:
634 case SimpleTypeKind::Float128:
636 case SimpleTypeKind::Complex80:
637 case SimpleTypeKind::Float80:
639 case SimpleTypeKind::Boolean64:
640 case SimpleTypeKind::Complex64:
641 case SimpleTypeKind::UInt64:
642 case SimpleTypeKind::UInt64Quad:
643 case SimpleTypeKind::Float64:
644 case SimpleTypeKind::Int64:
645 case SimpleTypeKind::Int64Quad:
647 case SimpleTypeKind::Boolean32:
648 case SimpleTypeKind::Character32:
649 case SimpleTypeKind::Complex32:
650 case SimpleTypeKind::Float32:
651 case SimpleTypeKind::Int32:
652 case SimpleTypeKind::Int32Long:
653 case SimpleTypeKind::UInt32Long:
654 case SimpleTypeKind::HResult:
655 case SimpleTypeKind::UInt32:
657 case SimpleTypeKind::Boolean16:
658 case SimpleTypeKind::Character16:
659 case SimpleTypeKind::Float16:
660 case SimpleTypeKind::Int16:
661 case SimpleTypeKind::Int16Short:
662 case SimpleTypeKind::UInt16:
663 case SimpleTypeKind::UInt16Short:
664 case SimpleTypeKind::WideCharacter:
666 case SimpleTypeKind::Boolean8:
667 case SimpleTypeKind::Byte:
668 case SimpleTypeKind::UnsignedCharacter:
669 case SimpleTypeKind::NarrowCharacter:
670 case SimpleTypeKind::SignedCharacter:
671 case SimpleTypeKind::SByte:
673 case SimpleTypeKind::Void:
679 PdbTypeSymId lldb_private::npdb::GetBestPossibleDecl(PdbTypeSymId id,
681 if (id.index.isSimple())
684 CVType cvt = tpi.getType(id.index);
686 // Only tag records have a best and a worst record.
687 if (!IsTagRecord(cvt))
690 // Tag records that are not forward decls are full decls, hence they are the
692 if (!IsForwardRefUdt(cvt))
695 return llvm::cantFail(tpi.findFullDeclForForwardRef(id.index));
698 template <typename RecordType> static size_t GetSizeOfTypeInternal(CVType cvt) {
700 llvm::cantFail(TypeDeserializer::deserializeAs<RecordType>(cvt, record));
701 return record.getSize();
704 size_t lldb_private::npdb::GetSizeOfType(PdbTypeSymId id,
705 llvm::pdb::TpiStream &tpi) {
706 if (id.index.isSimple()) {
707 switch (id.index.getSimpleMode()) {
708 case SimpleTypeMode::Direct:
709 return GetTypeSizeForSimpleKind(id.index.getSimpleKind());
710 case SimpleTypeMode::NearPointer32:
711 case SimpleTypeMode::FarPointer32:
713 case SimpleTypeMode::NearPointer64:
715 case SimpleTypeMode::NearPointer128:
723 TypeIndex index = id.index;
724 if (IsForwardRefUdt(index, tpi))
725 index = llvm::cantFail(tpi.findFullDeclForForwardRef(index));
727 CVType cvt = tpi.getType(index);
728 switch (cvt.kind()) {
730 return GetSizeOfType({LookThroughModifierRecord(cvt)}, tpi);
733 llvm::cantFail(TypeDeserializer::deserializeAs<EnumRecord>(cvt, record));
734 return GetSizeOfType({record.UnderlyingType}, tpi);
737 return GetSizeOfTypeInternal<PointerRecord>(cvt);
739 return GetSizeOfTypeInternal<ArrayRecord>(cvt);
743 return GetSizeOfTypeInternal<ClassRecord>(cvt);
745 return GetSizeOfTypeInternal<UnionRecord>(cvt);