[Lldb-commits] [lldb] [lldb] Add ability to show enum as name and value at the same time (PR #90059)
via lldb-commits
lldb-commits at lists.llvm.org
Thu Apr 25 07:05:39 PDT 2024
llvmbot wrote:
<!--LLVM PR SUMMARY COMMENT-->
@llvm/pr-subscribers-lldb
Author: David Spickett (DavidSpickett)
<details>
<summary>Changes</summary>
When an enum is used to represent certain data it can be useful to know its name and the value of it. For instance, register fields are often set in source code as numbers, but in the debugger you'd like to see the meaning as well.
(lldb) register read fpcr
fpcr = 0x00000000
= (... RMode = RN (0), ...)
Often you do just want the meaning but the value saves you having to manually decode it if you want to confirm what your source code has done, or try to replicate the current state in your source code.
I have not added tests for this because right now the use case for this is registers and those will have their own test cases to cover this. If we decide to expose this to formatters then this will need more testing.
---
Full diff: https://github.com/llvm/llvm-project/pull/90059.diff
7 Files Affected:
- (modified) lldb/include/lldb/Core/ValueObject.h (+7)
- (modified) lldb/include/lldb/Symbol/CompilerType.h (+2-1)
- (modified) lldb/include/lldb/Symbol/TypeSystem.h (+2-1)
- (modified) lldb/source/DataFormatters/TypeFormat.cpp (+1-1)
- (modified) lldb/source/Plugins/TypeSystem/Clang/TypeSystemClang.cpp (+14-7)
- (modified) lldb/source/Plugins/TypeSystem/Clang/TypeSystemClang.h (+2-1)
- (modified) lldb/source/Symbol/CompilerType.cpp (+3-2)
``````````diff
diff --git a/lldb/include/lldb/Core/ValueObject.h b/lldb/include/lldb/Core/ValueObject.h
index e7e35e2b2bffc0..36a6321428ec05 100644
--- a/lldb/include/lldb/Core/ValueObject.h
+++ b/lldb/include/lldb/Core/ValueObject.h
@@ -757,6 +757,12 @@ class ValueObject {
AddressType GetAddressTypeOfChildren();
+ void SetEnumsAlwaysShowValue(bool always) {
+ m_enums_always_show_value = always;
+ }
+
+ bool GetEnumsAlwaysShowValue() { return m_enums_always_show_value; }
+
void SetHasCompleteType() {
m_flags.m_did_calculate_complete_objc_class_type = true;
}
@@ -889,6 +895,7 @@ class ValueObject {
lldb::SyntheticChildrenSP m_synthetic_children_sp;
ProcessModID m_user_id_of_forced_summary;
AddressType m_address_type_of_ptr_or_ref_children = eAddressTypeInvalid;
+ bool m_enums_always_show_value = false;
llvm::SmallVector<uint8_t, 16> m_value_checksum;
diff --git a/lldb/include/lldb/Symbol/CompilerType.h b/lldb/include/lldb/Symbol/CompilerType.h
index b71c531f21633a..9e26e4c5f7b93d 100644
--- a/lldb/include/lldb/Symbol/CompilerType.h
+++ b/lldb/include/lldb/Symbol/CompilerType.h
@@ -490,7 +490,8 @@ class CompilerType {
bool DumpTypeValue(Stream *s, lldb::Format format, const DataExtractor &data,
lldb::offset_t data_offset, size_t data_byte_size,
uint32_t bitfield_bit_size, uint32_t bitfield_bit_offset,
- ExecutionContextScope *exe_scope);
+ ExecutionContextScope *exe_scope,
+ bool enums_always_show_value = false);
/// Dump to stdout.
void DumpTypeDescription(lldb::DescriptionLevel level =
diff --git a/lldb/include/lldb/Symbol/TypeSystem.h b/lldb/include/lldb/Symbol/TypeSystem.h
index 3a927d313b823d..3395442f5b3f56 100644
--- a/lldb/include/lldb/Symbol/TypeSystem.h
+++ b/lldb/include/lldb/Symbol/TypeSystem.h
@@ -398,7 +398,8 @@ class TypeSystem : public PluginInterface,
lldb::offset_t data_offset, size_t data_byte_size,
uint32_t bitfield_bit_size,
uint32_t bitfield_bit_offset,
- ExecutionContextScope *exe_scope) = 0;
+ ExecutionContextScope *exe_scope,
+ bool enums_always_show_value = false) = 0;
/// Dump the type to stdout.
virtual void DumpTypeDescription(
diff --git a/lldb/source/DataFormatters/TypeFormat.cpp b/lldb/source/DataFormatters/TypeFormat.cpp
index 409c452110bddc..2898b4394891c3 100644
--- a/lldb/source/DataFormatters/TypeFormat.cpp
+++ b/lldb/source/DataFormatters/TypeFormat.cpp
@@ -108,7 +108,7 @@ bool TypeFormatImpl_Format::FormatObject(ValueObject *valobj,
*size, // Byte size of item in "m_data"
valobj->GetBitfieldBitSize(), // Bitfield bit size
valobj->GetBitfieldBitOffset(), // Bitfield bit offset
- exe_scope);
+ exe_scope, valobj->GetEnumsAlwaysShowValue());
// Given that we do not want to set the ValueObject's m_error for a
// formatting error (or else we wouldn't be able to reformat until a
// next update), an empty string is treated as a "false" return from
diff --git a/lldb/source/Plugins/TypeSystem/Clang/TypeSystemClang.cpp b/lldb/source/Plugins/TypeSystem/Clang/TypeSystemClang.cpp
index 2621f682011b41..b1dbf7fbca1b92 100644
--- a/lldb/source/Plugins/TypeSystem/Clang/TypeSystemClang.cpp
+++ b/lldb/source/Plugins/TypeSystem/Clang/TypeSystemClang.cpp
@@ -8474,7 +8474,7 @@ void TypeSystemClang::DumpFromSymbolFile(Stream &s,
static bool DumpEnumValue(const clang::QualType &qual_type, Stream &s,
const DataExtractor &data, lldb::offset_t byte_offset,
size_t byte_size, uint32_t bitfield_bit_offset,
- uint32_t bitfield_bit_size) {
+ uint32_t bitfield_bit_size, bool always_show_value) {
const clang::EnumType *enutype =
llvm::cast<clang::EnumType>(qual_type.getTypePtr());
const clang::EnumDecl *enum_decl = enutype->getDecl();
@@ -8501,7 +8501,11 @@ static bool DumpEnumValue(const clang::QualType &qual_type, Stream &s,
++num_enumerators;
if (val == enum_svalue) {
// Found an exact match, that's all we need to do.
- s.PutCString(enumerator->getNameAsString());
+ if (always_show_value)
+ s.Printf("%s (%" PRIi64 ")", enumerator->getNameAsString().c_str(),
+ enum_svalue);
+ else
+ s.PutCString(enumerator->getNameAsString());
return true;
}
}
@@ -8556,7 +8560,7 @@ bool TypeSystemClang::DumpTypeValue(
lldb::opaque_compiler_type_t type, Stream &s, lldb::Format format,
const lldb_private::DataExtractor &data, lldb::offset_t byte_offset,
size_t byte_size, uint32_t bitfield_bit_size, uint32_t bitfield_bit_offset,
- ExecutionContextScope *exe_scope) {
+ ExecutionContextScope *exe_scope, bool enums_always_show_value) {
if (!type)
return false;
if (IsAggregateType(type)) {
@@ -8568,8 +8572,10 @@ bool TypeSystemClang::DumpTypeValue(
if (type_class == clang::Type::Elaborated) {
qual_type = llvm::cast<clang::ElaboratedType>(qual_type)->getNamedType();
- return DumpTypeValue(qual_type.getAsOpaquePtr(), s, format, data, byte_offset, byte_size,
- bitfield_bit_size, bitfield_bit_offset, exe_scope);
+ return DumpTypeValue(qual_type.getAsOpaquePtr(), s, format, data,
+ byte_offset, byte_size, bitfield_bit_size,
+ bitfield_bit_offset, exe_scope,
+ enums_always_show_value);
}
switch (type_class) {
@@ -8595,7 +8601,7 @@ bool TypeSystemClang::DumpTypeValue(
// treat as a bitfield
bitfield_bit_offset, // Offset in bits of a bitfield value if
// bitfield_bit_size != 0
- exe_scope);
+ exe_scope, enums_always_show_value);
} break;
case clang::Type::Enum:
@@ -8604,7 +8610,8 @@ bool TypeSystemClang::DumpTypeValue(
if ((format == eFormatEnum || format == eFormatDefault) &&
GetCompleteType(type))
return DumpEnumValue(qual_type, s, data, byte_offset, byte_size,
- bitfield_bit_offset, bitfield_bit_size);
+ bitfield_bit_offset, bitfield_bit_size,
+ enums_always_show_value);
// format was not enum, just fall through and dump the value as
// requested....
[[fallthrough]];
diff --git a/lldb/source/Plugins/TypeSystem/Clang/TypeSystemClang.h b/lldb/source/Plugins/TypeSystem/Clang/TypeSystemClang.h
index 68b82e9688f12b..c3a4abf39016ca 100644
--- a/lldb/source/Plugins/TypeSystem/Clang/TypeSystemClang.h
+++ b/lldb/source/Plugins/TypeSystem/Clang/TypeSystemClang.h
@@ -1047,7 +1047,8 @@ class TypeSystemClang : public TypeSystem {
lldb::Format format, const DataExtractor &data,
lldb::offset_t data_offset, size_t data_byte_size,
uint32_t bitfield_bit_size, uint32_t bitfield_bit_offset,
- ExecutionContextScope *exe_scope) override;
+ ExecutionContextScope *exe_scope,
+ bool enums_always_show_value = false) override;
void DumpTypeDescription(
lldb::opaque_compiler_type_t type,
diff --git a/lldb/source/Symbol/CompilerType.cpp b/lldb/source/Symbol/CompilerType.cpp
index 96e74b890d2d90..2d9b7aad275a63 100644
--- a/lldb/source/Symbol/CompilerType.cpp
+++ b/lldb/source/Symbol/CompilerType.cpp
@@ -1016,12 +1016,13 @@ bool CompilerType::DumpTypeValue(Stream *s, lldb::Format format,
lldb::offset_t byte_offset, size_t byte_size,
uint32_t bitfield_bit_size,
uint32_t bitfield_bit_offset,
- ExecutionContextScope *exe_scope) {
+ ExecutionContextScope *exe_scope,
+ bool enums_always_show_value) {
if (IsValid())
if (auto type_system_sp = GetTypeSystem())
return type_system_sp->DumpTypeValue(
m_type, *s, format, data, byte_offset, byte_size, bitfield_bit_size,
- bitfield_bit_offset, exe_scope);
+ bitfield_bit_offset, exe_scope, enums_always_show_value);
return false;
}
``````````
</details>
https://github.com/llvm/llvm-project/pull/90059
More information about the lldb-commits
mailing list