9#ifndef LLVM_DEBUGINFO_DWARF_DWARFTYPEPRINTER_H
10#define LLVM_DEBUGINFO_DWARF_DWARFTYPEPRINTER_H
44 std::string *OriginalFullName =
nullptr);
47 bool SkipFirstParamIfArtificial =
false);
58 std::string *OriginalFullName =
nullptr);
61 bool SkipFirstParamIfArtificial,
bool Const,
69 case dwarf::DW_TAG_structure_type:
70 case dwarf::DW_TAG_class_type:
71 case dwarf::DW_TAG_union_type:
72 case dwarf::DW_TAG_namespace:
73 case dwarf::DW_TAG_enumeration_type:
74 case dwarf::DW_TAG_typedef:
84 template <
typename FormValueType>
85 void appendCastedValue(
const FormValueType &FormValue, DieType Cast,
89template <
typename DieType>
92 static constexpr StringRef Prefix =
"DW_TAG_";
93 static constexpr StringRef Suffix =
"_type";
97 TagStr.
size() - (Prefix.size() + Suffix.
size()))
101template <
typename DieType>
103 for (
const DieType &
C :
D.children()) {
104 if (
C.getTag() != dwarf::DW_TAG_subrange_type)
106 std::optional<uint64_t> LB;
107 std::optional<uint64_t>
Count;
108 std::optional<uint64_t> UB;
109 std::optional<unsigned> DefaultLB;
110 if (std::optional<typename DieType::DWARFFormValue> L =
111 C.find(dwarf::DW_AT_lower_bound))
112 LB = L->getAsUnsignedConstant();
113 if (std::optional<typename DieType::DWARFFormValue> CountV =
114 C.find(dwarf::DW_AT_count))
115 Count = CountV->getAsUnsignedConstant();
116 if (std::optional<typename DieType::DWARFFormValue> UpperV =
117 C.find(dwarf::DW_AT_upper_bound))
118 UB = UpperV->getAsUnsignedConstant();
119 if (std::optional<uint64_t> LV =
D.getLanguage())
122 if (LB && *LB == *DefaultLB)
124 if (!LB && !
Count && !UB)
126 else if (!LB && (
Count || UB) && DefaultLB)
127 OS <<
'[' << (
Count ? *
Count : *UB - *DefaultLB + 1) <<
']';
151template <
typename DieType>
154 return D.resolveReferencedType(Attr);
156template <
typename DieType>
158 return D.resolveReferencedType(
F);
160template <
typename DWARFFormValueType>
161const char *
toString(std::optional<DWARFFormValueType>
F) {
174 auto TypeAttr =
D.find(dwarf::DW_AT_type);
182 if (Unwrapped.getTag() == dwarf::DW_TAG_typedef)
189template <
typename DieType>
191 while (
D && (
D.getTag() == dwarf::DW_TAG_const_type ||
192 D.getTag() == dwarf::DW_TAG_volatile_type))
197template <
typename DieType>
200 return D && (
D.getTag() == dwarf::DW_TAG_subroutine_type ||
201 D.getTag() == dwarf::DW_TAG_array_type);
204template <
typename DieType>
218template <
typename DieType>
220 DieType
D, std::string *OriginalFullName) {
230 case dwarf::DW_TAG_pointer_type: {
234 case dwarf::DW_TAG_subroutine_type: {
242 case dwarf::DW_TAG_array_type: {
246 case dwarf::DW_TAG_reference_type:
249 case dwarf::DW_TAG_rvalue_reference_type:
252 case dwarf::DW_TAG_ptr_to_member_type: {
268 case dwarf::DW_TAG_LLVM_ptrauth_type:
271 case dwarf::DW_TAG_const_type:
272 case dwarf::DW_TAG_volatile_type:
275 case dwarf::DW_TAG_namespace: {
279 OS <<
"(anonymous namespace)";
282 case dwarf::DW_TAG_unspecified_type: {
284 if (TypeName ==
"decltype(nullptr)")
285 TypeName =
"std::nullptr_t";
305 static constexpr StringRef MangledPrefix =
"_STN|";
306 if (Name.consume_front(MangledPrefix)) {
307 auto Separator = Name.find(
'|');
309 StringRef BaseName = Name.substr(0, Separator);
311 if (OriginalFullName)
320 if (Name.ends_with(
">"))
336template <
typename DieType>
338 DieType
D, DieType Inner,
bool SkipFirstParamIfArtificial) {
341 switch (
D.getTag()) {
342 case dwarf::DW_TAG_subroutine_type: {
347 case dwarf::DW_TAG_array_type: {
351 case dwarf::DW_TAG_const_type:
352 case dwarf::DW_TAG_volatile_type:
355 case dwarf::DW_TAG_ptr_to_member_type:
356 case dwarf::DW_TAG_reference_type:
357 case dwarf::DW_TAG_rvalue_reference_type:
358 case dwarf::DW_TAG_pointer_type: {
363 dwarf::DW_TAG_ptr_to_member_type);
366 case dwarf::DW_TAG_LLVM_ptrauth_type: {
368 if (
auto Form =
D.find(Attr))
369 return *Form->getAsUnsignedConstant();
373 if (getValOrNull(dwarf::DW_AT_LLVM_ptrauth_isa_pointer))
375 if (getValOrNull(dwarf::DW_AT_LLVM_ptrauth_authenticates_null_values))
376 optionsVec.
push_back(
"authenticates-null-values");
377 if (
auto AuthenticationMode =
378 D.find(dwarf::DW_AT_LLVM_ptrauth_authentication_mode)) {
379 switch (*AuthenticationMode->getAsUnsignedConstant()) {
393 for (
const auto *option : optionsVec) {
399 options =
", \"" + options +
"\"";
400 std::string PtrauthString;
403 <<
"__ptrauth(" << getValOrNull(dwarf::DW_AT_LLVM_ptrauth_key) <<
", "
404 << getValOrNull(dwarf::DW_AT_LLVM_ptrauth_address_discriminated)
407 getValOrNull(dwarf::DW_AT_LLVM_ptrauth_extra_discriminator),
410 OS << PtrauthStream.
str();
425template <
typename DieType>
427 if (
D && scopedTAGs(
D.getTag()))
432template <
typename DieType>
434 if (
D && scopedTAGs(
D.getTag()))
439template <
typename DieType>
440template <
typename FormValueType>
441void DWARFTypePrinter<DieType>::appendCastedValue(
442 const FormValueType &FormValue, DieType Cast,
bool IsUnsigned) {
445 std::optional<uint64_t> UVal = FormValue.getAsUnsignedConstant();
449 ValStr = std::to_string(*UVal);
451 std::optional<int64_t> SVal = FormValue.getAsSignedConstant();
455 ValStr = std::to_string(*SVal);
459 appendQualifiedName(Cast);
461 OS << std::move(ValStr);
464template <
typename DieType>
466 bool *FirstParameter) {
467 bool FirstParameterValue =
true;
468 bool IsTemplate =
false;
470 FirstParameter = &FirstParameterValue;
471 for (
const DieType &
C :
D) {
479 *FirstParameter =
false;
481 if (
C.getTag() == dwarf::DW_TAG_GNU_template_parameter_pack) {
485 if (
C.getTag() == dwarf::DW_TAG_template_value_parameter) {
488 if (
T.getTag() == dwarf::DW_TAG_enumeration_type) {
489 auto V =
C.find(dwarf::DW_AT_const_value);
490 appendCastedValue(*V,
T,
false);
497 if (
T.getTag() == dwarf::DW_TAG_pointer_type ||
498 T.getTag() == dwarf::DW_TAG_reference_type)
503 auto V =
C.find(dwarf::DW_AT_const_value);
504 bool IsQualifiedChar =
false;
505 if (Name ==
"bool") {
506 OS << (*V->getAsUnsignedConstant() ?
"true" :
"false");
507 }
else if (Name ==
"short") {
509 OS << std::to_string(*V->getAsSignedConstant());
510 }
else if (Name ==
"unsigned short") {
511 OS <<
"(unsigned short)";
512 OS << std::to_string(*V->getAsSignedConstant());
513 }
else if (Name ==
"int")
514 OS << std::to_string(*V->getAsSignedConstant());
515 else if (Name ==
"long") {
516 OS << std::to_string(*V->getAsSignedConstant());
518 }
else if (Name ==
"long long") {
519 OS << std::to_string(*V->getAsSignedConstant());
521 }
else if (Name ==
"unsigned int") {
522 OS << std::to_string(*V->getAsUnsignedConstant());
524 }
else if (Name ==
"unsigned long") {
525 OS << std::to_string(*V->getAsUnsignedConstant());
527 }
else if (Name ==
"unsigned long long") {
528 OS << std::to_string(*V->getAsUnsignedConstant());
530 }
else if (Name ==
"char" ||
532 (Name ==
"unsigned char" || Name ==
"signed char"))) {
535 auto Val = *V->getAsSignedConstant();
540 if (IsQualifiedChar) {
575 if ((Val & ~0xFFu) == ~0xFFu)
577 if (Val < 127 && Val >= 32) {
581 }
else if (Val < 256)
583 else if (Val <= 0xFFFF)
590 }
else if (Name.starts_with(
"_BitInt")) {
591 appendCastedValue(*V,
T,
false);
592 }
else if (Name.starts_with(
"unsigned _BitInt")) {
593 appendCastedValue(*V,
T,
true);
597 if (
C.getTag() == dwarf::DW_TAG_GNU_template_template_param) {
598 const char *RawName =
606 if (
C.getTag() != dwarf::DW_TAG_template_type_parameter)
612 if (IsTemplate && *FirstParameter && FirstParameter == &FirstParameterValue) {
619template <
typename DieType>
633template <
typename DieType>
635 DieType &
C, DieType &V) {
636 (
N.getTag() == dwarf::DW_TAG_const_type ?
C : V) =
N;
639 auto Tag =
T.getTag();
640 if (
Tag == dwarf::DW_TAG_const_type) {
643 }
else if (
Tag == dwarf::DW_TAG_volatile_type) {
650template <
typename DieType>
656 if (
T &&
T.getTag() == dwarf::DW_TAG_subroutine_type)
658 static_cast<bool>(
C),
static_cast<bool>(V));
663template <
typename DieType>
669 bool Subroutine =
T &&
T.getTag() == dwarf::DW_TAG_subroutine_type;
671 while (
A &&
A.getTag() == dwarf::DW_TAG_array_type)
674 (!
A || (
A.getTag() != dwarf::DW_TAG_pointer_type &&
675 A.getTag() != llvm::dwarf::DW_TAG_ptr_to_member_type)) &&
684 if (!Leading && !Subroutine) {
696template <
typename DieType>
698 DieType
D, std::string *OriginalFullName) {
705template <
typename DieType>
707 DieType
D, DieType Inner,
bool SkipFirstParamIfArtificial,
bool Const,
709 DieType FirstParamIfArtificial;
713 bool RealFirst =
true;
714 for (DieType
P :
D) {
715 if (
P.getTag() != dwarf::DW_TAG_formal_parameter &&
716 P.getTag() != dwarf::DW_TAG_unspecified_parameters)
719 if (SkipFirstParamIfArtificial && RealFirst &&
720 P.find(dwarf::DW_AT_artificial)) {
721 FirstParamIfArtificial =
T;
729 if (
P.getTag() == dwarf::DW_TAG_unspecified_parameters)
736 if (FirstParamIfArtificial) {
737 if (DieType
P = FirstParamIfArtificial) {
738 if (
P.getTag() == dwarf::DW_TAG_pointer_type) {
739 auto CVStep = [&](DieType CV) {
741 Const |= U.getTag() == dwarf::DW_TAG_const_type;
742 Volatile |= U.getTag() == dwarf::DW_TAG_volatile_type;
747 if (DieType CV = CVStep(
P)) {
754 if (
auto CC =
D.find(dwarf::DW_AT_calling_convention)) {
755 switch (*CC->getAsUnsignedConstant()) {
756 case dwarf::CallingConvention::DW_CC_BORLAND_stdcall:
757 OS <<
" __attribute__((stdcall))";
759 case dwarf::CallingConvention::DW_CC_BORLAND_msfastcall:
760 OS <<
" __attribute__((fastcall))";
762 case dwarf::CallingConvention::DW_CC_BORLAND_thiscall:
763 OS <<
" __attribute__((thiscall))";
765 case dwarf::CallingConvention::DW_CC_LLVM_vectorcall:
766 OS <<
" __attribute__((vectorcall))";
768 case dwarf::CallingConvention::DW_CC_BORLAND_pascal:
769 OS <<
" __attribute__((pascal))";
771 case dwarf::CallingConvention::DW_CC_LLVM_Win64:
772 OS <<
" __attribute__((ms_abi))";
774 case dwarf::CallingConvention::DW_CC_LLVM_X86_64SysV:
775 OS <<
" __attribute__((sysv_abi))";
777 case dwarf::CallingConvention::DW_CC_LLVM_AAPCS:
779 OS <<
" __attribute__((pcs(\"aapcs\")))";
781 case dwarf::CallingConvention::DW_CC_LLVM_AAPCS_VFP:
782 OS <<
" __attribute__((pcs(\"aapcs-vfp\")))";
784 case dwarf::CallingConvention::DW_CC_LLVM_IntelOclBicc:
785 OS <<
" __attribute__((intel_ocl_bicc))";
787 case dwarf::CallingConvention::DW_CC_LLVM_SpirFunction:
794 case dwarf::CallingConvention::DW_CC_LLVM_DeviceKernel:
795 OS <<
" __attribute__((device_kernel))";
797 case dwarf::CallingConvention::DW_CC_LLVM_Swift:
799 OS <<
" __attribute__((swiftcall))";
801 case dwarf::CallingConvention::DW_CC_LLVM_PreserveMost:
802 OS <<
" __attribute__((preserve_most))";
804 case dwarf::CallingConvention::DW_CC_LLVM_PreserveAll:
805 OS <<
" __attribute__((preserve_all))";
807 case dwarf::CallingConvention::DW_CC_LLVM_PreserveNone:
808 OS <<
" __attribute__((preserve_none))";
810 case dwarf::CallingConvention::DW_CC_LLVM_X86RegCall:
811 OS <<
" __attribute__((regcall))";
813 case dwarf::CallingConvention::DW_CC_LLVM_M68kRTD:
814 OS <<
" __attribute__((m68k_rtd))";
823 if (
D.find(dwarf::DW_AT_reference))
825 if (
D.find(dwarf::DW_AT_rvalue_reference))
831template <
typename DieType>
833 if (
D.getTag() == dwarf::DW_TAG_compile_unit)
835 if (
D.getTag() == dwarf::DW_TAG_type_unit)
837 if (
D.getTag() == dwarf::DW_TAG_skeleton_unit)
839 if (
D.getTag() == dwarf::DW_TAG_subprogram)
841 if (
D.getTag() == dwarf::DW_TAG_lexical_block)
843 D =
D.resolveTypeUnitReference();
844 if (DieType
P =
D.getParent())
assert(UImm &&(UImm !=~static_cast< T >(0)) &&"Invalid immediate!")
static GCRegistry::Add< ErlangGC > A("erlang", "erlang-compatible garbage collector")
static GCRegistry::Add< StatepointGC > D("statepoint-example", "an example strategy for statepoint")
static GCRegistry::Add< CoreCLRGC > E("coreclr", "CoreCLR-compatible GC")
This file contains constants used for implementing Dwarf debug support.
static dwarf::Attribute TypeAttr[]
Tagged union holding either a T or a Error.
void push_back(const T &Elt)
This is a 'vector' (really, a variable-sized array), optimized for the case when the array is small.
StringRef - Represent a constant reference to a string, i.e.
static constexpr size_t npos
constexpr StringRef substr(size_t Start, size_t N=npos) const
Return a reference to the substring from [Start, Start + N).
bool starts_with(StringRef Prefix) const
Check if this string starts with the given Prefix.
constexpr size_t size() const
size - Get the string size.
bool ends_with(StringRef Suffix) const
Check if this string ends with the given Suffix.
This class implements an extremely fast bulk output stream that can only output to a stream.
A raw_ostream that writes to an std::string.
std::string & str()
Returns the string's reference.
@ C
The default llvm calling convention, compatible with C.
const char * toString(std::optional< DWARFFormValueType > F)
DieType resolveReferencedType(DieType D, dwarf::Attribute Attr=dwarf::DW_AT_type)
DieType unwrapReferencedTypedefType(DieType D)
Resolve the DW_AT_type of D until we reach a DIE that is not a DW_TAG_typedef.
This is an optimization pass for GlobalISel generic memory operations.
std::string utohexstr(uint64_t X, bool LowerCase=false, unsigned Width=0)
FunctionAddr VTableAddr Count
format_object< Ts... > format(const char *Fmt, const Ts &... Vals)
These are helper functions used to produce formatted output.
@ First
Helpers to iterate all locations in the MemoryEffectsBase class.
void consumeError(Error Err)
Consume a Error without doing anything.
void appendTypeTagName(dwarf::Tag T)
Dump the name encoded in the type tag.
bool needsParens(DieType D)
void appendArrayType(const DieType &D)
DieType appendQualifiedNameBefore(DieType D)
void appendQualifiedName(DieType D)
void decomposeConstVolatile(DieType &N, DieType &T, DieType &C, DieType &V)
DieType skipQualifiers(DieType D)
void appendUnqualifiedName(DieType D, std::string *OriginalFullName=nullptr)
Recursively append the DIE type name when applicable.
void appendConstVolatileQualifierBefore(DieType N)
void appendScopes(DieType D)
DWARFTypePrinter(raw_ostream &OS)
void appendSubroutineNameAfter(DieType D, DieType Inner, bool SkipFirstParamIfArtificial, bool Const, bool Volatile)
bool appendTemplateParameters(DieType D, bool *FirstParameter=nullptr)
void appendConstVolatileQualifierAfter(DieType N)
void appendAndTerminateTemplateParameters(DieType D)
void appendPointerLikeTypeBefore(DieType D, DieType Inner, StringRef Ptr)
void appendUnqualifiedNameAfter(DieType D, DieType Inner, bool SkipFirstParamIfArtificial=false)
DieType appendUnqualifiedNameBefore(DieType D, std::string *OriginalFullName=nullptr)