| //===-- LibCxx.cpp --------------------------------------------------------===// |
| // |
| // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. |
| // See https://llvm.org/LICENSE.txt for license information. |
| // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception |
| // |
| //===----------------------------------------------------------------------===// |
| |
| #include "LibCxx.h" |
| |
| #include "lldb/Core/Debugger.h" |
| #include "lldb/Core/FormatEntity.h" |
| #include "lldb/Core/ValueObject.h" |
| #include "lldb/Core/ValueObjectConstResult.h" |
| #include "lldb/DataFormatters/FormattersHelpers.h" |
| #include "lldb/DataFormatters/StringPrinter.h" |
| #include "lldb/DataFormatters/TypeSummary.h" |
| #include "lldb/DataFormatters/VectorIterator.h" |
| #include "lldb/Target/ProcessStructReader.h" |
| #include "lldb/Target/SectionLoadList.h" |
| #include "lldb/Target/Target.h" |
| #include "lldb/Utility/ConstString.h" |
| #include "lldb/Utility/DataBufferHeap.h" |
| #include "lldb/Utility/Endian.h" |
| #include "lldb/Utility/Status.h" |
| #include "lldb/Utility/Stream.h" |
| |
| #include "Plugins/LanguageRuntime/CPlusPlus/CPPLanguageRuntime.h" |
| #include "Plugins/TypeSystem/Clang/TypeSystemClang.h" |
| #include "lldb/lldb-enumerations.h" |
| #include <optional> |
| #include <tuple> |
| |
| using namespace lldb; |
| using namespace lldb_private; |
| using namespace lldb_private::formatters; |
| |
| lldb::ValueObjectSP lldb_private::formatters::GetChildMemberWithName( |
| ValueObject &obj, llvm::ArrayRef<ConstString> alternative_names) { |
| for (ConstString name : alternative_names) { |
| lldb::ValueObjectSP child_sp = obj.GetChildMemberWithName(name, true); |
| |
| if (child_sp) |
| return child_sp; |
| } |
| return {}; |
| } |
| |
| bool lldb_private::formatters::LibcxxOptionalSummaryProvider( |
| ValueObject &valobj, Stream &stream, const TypeSummaryOptions &options) { |
| ValueObjectSP valobj_sp(valobj.GetNonSyntheticValue()); |
| if (!valobj_sp) |
| return false; |
| |
| // An optional either contains a value or not, the member __engaged_ is |
| // a bool flag, it is true if the optional has a value and false otherwise. |
| ValueObjectSP engaged_sp( |
| valobj_sp->GetChildMemberWithName(ConstString("__engaged_"), true)); |
| |
| if (!engaged_sp) |
| return false; |
| |
| llvm::StringRef engaged_as_cstring( |
| engaged_sp->GetValueAsUnsigned(0) == 1 ? "true" : "false"); |
| |
| stream.Printf(" Has Value=%s ", engaged_as_cstring.data()); |
| |
| return true; |
| } |
| |
| bool lldb_private::formatters::LibcxxFunctionSummaryProvider( |
| ValueObject &valobj, Stream &stream, const TypeSummaryOptions &options) { |
| |
| ValueObjectSP valobj_sp(valobj.GetNonSyntheticValue()); |
| |
| if (!valobj_sp) |
| return false; |
| |
| ExecutionContext exe_ctx(valobj_sp->GetExecutionContextRef()); |
| Process *process = exe_ctx.GetProcessPtr(); |
| |
| if (process == nullptr) |
| return false; |
| |
| CPPLanguageRuntime *cpp_runtime = CPPLanguageRuntime::Get(*process); |
| |
| if (!cpp_runtime) |
| return false; |
| |
| CPPLanguageRuntime::LibCppStdFunctionCallableInfo callable_info = |
| cpp_runtime->FindLibCppStdFunctionCallableInfo(valobj_sp); |
| |
| switch (callable_info.callable_case) { |
| case CPPLanguageRuntime::LibCppStdFunctionCallableCase::Invalid: |
| stream.Printf(" __f_ = %" PRIu64, callable_info.member_f_pointer_value); |
| return false; |
| break; |
| case CPPLanguageRuntime::LibCppStdFunctionCallableCase::Lambda: |
| stream.Printf( |
| " Lambda in File %s at Line %u", |
| callable_info.callable_line_entry.file.GetFilename().GetCString(), |
| callable_info.callable_line_entry.line); |
| break; |
| case CPPLanguageRuntime::LibCppStdFunctionCallableCase::CallableObject: |
| stream.Printf( |
| " Function in File %s at Line %u", |
| callable_info.callable_line_entry.file.GetFilename().GetCString(), |
| callable_info.callable_line_entry.line); |
| break; |
| case CPPLanguageRuntime::LibCppStdFunctionCallableCase::FreeOrMemberFunction: |
| stream.Printf(" Function = %s ", |
| callable_info.callable_symbol.GetName().GetCString()); |
| break; |
| } |
| |
| return true; |
| } |
| |
| bool lldb_private::formatters::LibcxxSmartPointerSummaryProvider( |
| ValueObject &valobj, Stream &stream, const TypeSummaryOptions &options) { |
| ValueObjectSP valobj_sp(valobj.GetNonSyntheticValue()); |
| if (!valobj_sp) |
| return false; |
| ValueObjectSP ptr_sp( |
| valobj_sp->GetChildMemberWithName(ConstString("__ptr_"), true)); |
| ValueObjectSP count_sp(valobj_sp->GetChildAtNamePath( |
| {ConstString("__cntrl_"), ConstString("__shared_owners_")})); |
| ValueObjectSP weakcount_sp(valobj_sp->GetChildAtNamePath( |
| {ConstString("__cntrl_"), ConstString("__shared_weak_owners_")})); |
| |
| if (!ptr_sp) |
| return false; |
| |
| if (ptr_sp->GetValueAsUnsigned(0) == 0) { |
| stream.Printf("nullptr"); |
| return true; |
| } else { |
| bool print_pointee = false; |
| Status error; |
| ValueObjectSP pointee_sp = ptr_sp->Dereference(error); |
| if (pointee_sp && error.Success()) { |
| if (pointee_sp->DumpPrintableRepresentation( |
| stream, ValueObject::eValueObjectRepresentationStyleSummary, |
| lldb::eFormatInvalid, |
| ValueObject::PrintableRepresentationSpecialCases::eDisable, |
| false)) |
| print_pointee = true; |
| } |
| if (!print_pointee) |
| stream.Printf("ptr = 0x%" PRIx64, ptr_sp->GetValueAsUnsigned(0)); |
| } |
| |
| if (count_sp) |
| stream.Printf(" strong=%" PRIu64, 1 + count_sp->GetValueAsUnsigned(0)); |
| |
| if (weakcount_sp) |
| stream.Printf(" weak=%" PRIu64, 1 + weakcount_sp->GetValueAsUnsigned(0)); |
| |
| return true; |
| } |
| |
| bool lldb_private::formatters::LibcxxUniquePointerSummaryProvider( |
| ValueObject &valobj, Stream &stream, const TypeSummaryOptions &options) { |
| ValueObjectSP valobj_sp(valobj.GetNonSyntheticValue()); |
| if (!valobj_sp) |
| return false; |
| |
| ValueObjectSP ptr_sp( |
| valobj_sp->GetChildMemberWithName(ConstString("__ptr_"), true)); |
| if (!ptr_sp) |
| return false; |
| |
| ptr_sp = GetValueOfLibCXXCompressedPair(*ptr_sp); |
| if (!ptr_sp) |
| return false; |
| |
| if (ptr_sp->GetValueAsUnsigned(0) == 0) { |
| stream.Printf("nullptr"); |
| return true; |
| } else { |
| bool print_pointee = false; |
| Status error; |
| ValueObjectSP pointee_sp = ptr_sp->Dereference(error); |
| if (pointee_sp && error.Success()) { |
| if (pointee_sp->DumpPrintableRepresentation( |
| stream, ValueObject::eValueObjectRepresentationStyleSummary, |
| lldb::eFormatInvalid, |
| ValueObject::PrintableRepresentationSpecialCases::eDisable, |
| false)) |
| print_pointee = true; |
| } |
| if (!print_pointee) |
| stream.Printf("ptr = 0x%" PRIx64, ptr_sp->GetValueAsUnsigned(0)); |
| } |
| |
| return true; |
| } |
| |
| /* |
| (lldb) fr var ibeg --raw --ptr-depth 1 |
| (std::__1::__map_iterator<std::__1::__tree_iterator<std::__1::pair<int, |
| std::__1::basic_string<char, std::__1::char_traits<char>, |
| std::__1::allocator<char> > >, std::__1::__tree_node<std::__1::pair<int, |
| std::__1::basic_string<char, std::__1::char_traits<char>, |
| std::__1::allocator<char> > >, void *> *, long> >) ibeg = { |
| __i_ = { |
| __ptr_ = 0x0000000100103870 { |
| std::__1::__tree_node_base<void *> = { |
| std::__1::__tree_end_node<std::__1::__tree_node_base<void *> *> = { |
| __left_ = 0x0000000000000000 |
| } |
| __right_ = 0x0000000000000000 |
| __parent_ = 0x00000001001038b0 |
| __is_black_ = true |
| } |
| __value_ = { |
| first = 0 |
| second = { std::string } |
| */ |
| |
| lldb_private::formatters::LibCxxMapIteratorSyntheticFrontEnd:: |
| LibCxxMapIteratorSyntheticFrontEnd(lldb::ValueObjectSP valobj_sp) |
| : SyntheticChildrenFrontEnd(*valobj_sp), m_pair_ptr(), m_pair_sp() { |
| if (valobj_sp) |
| Update(); |
| } |
| |
| bool lldb_private::formatters::LibCxxMapIteratorSyntheticFrontEnd::Update() { |
| m_pair_sp.reset(); |
| m_pair_ptr = nullptr; |
| |
| ValueObjectSP valobj_sp = m_backend.GetSP(); |
| if (!valobj_sp) |
| return false; |
| |
| TargetSP target_sp(valobj_sp->GetTargetSP()); |
| |
| if (!target_sp) |
| return false; |
| |
| if (!valobj_sp) |
| return false; |
| |
| static ConstString g_i_("__i_"); |
| |
| // this must be a ValueObject* because it is a child of the ValueObject we |
| // are producing children for it if were a ValueObjectSP, we would end up |
| // with a loop (iterator -> synthetic -> child -> parent == iterator) and |
| // that would in turn leak memory by never allowing the ValueObjects to die |
| // and free their memory |
| m_pair_ptr = valobj_sp |
| ->GetValueForExpressionPath( |
| ".__i_.__ptr_->__value_", nullptr, nullptr, |
| ValueObject::GetValueForExpressionPathOptions() |
| .DontCheckDotVsArrowSyntax() |
| .SetSyntheticChildrenTraversal( |
| ValueObject::GetValueForExpressionPathOptions:: |
| SyntheticChildrenTraversal::None), |
| nullptr) |
| .get(); |
| |
| if (!m_pair_ptr) { |
| m_pair_ptr = valobj_sp |
| ->GetValueForExpressionPath( |
| ".__i_.__ptr_", nullptr, nullptr, |
| ValueObject::GetValueForExpressionPathOptions() |
| .DontCheckDotVsArrowSyntax() |
| .SetSyntheticChildrenTraversal( |
| ValueObject::GetValueForExpressionPathOptions:: |
| SyntheticChildrenTraversal::None), |
| nullptr) |
| .get(); |
| if (m_pair_ptr) { |
| auto __i_(valobj_sp->GetChildMemberWithName(g_i_, true)); |
| if (!__i_) { |
| m_pair_ptr = nullptr; |
| return false; |
| } |
| CompilerType pair_type( |
| __i_->GetCompilerType().GetTypeTemplateArgument(0)); |
| std::string name; |
| uint64_t bit_offset_ptr; |
| uint32_t bitfield_bit_size_ptr; |
| bool is_bitfield_ptr; |
| pair_type = pair_type.GetFieldAtIndex( |
| 0, name, &bit_offset_ptr, &bitfield_bit_size_ptr, &is_bitfield_ptr); |
| if (!pair_type) { |
| m_pair_ptr = nullptr; |
| return false; |
| } |
| |
| auto addr(m_pair_ptr->GetValueAsUnsigned(LLDB_INVALID_ADDRESS)); |
| m_pair_ptr = nullptr; |
| if (addr && addr != LLDB_INVALID_ADDRESS) { |
| auto ts = pair_type.GetTypeSystem(); |
| auto ast_ctx = ts.dyn_cast_or_null<TypeSystemClang>(); |
| if (!ast_ctx) |
| return false; |
| |
| // Mimick layout of std::__tree_iterator::__ptr_ and read it in |
| // from process memory. |
| // |
| // The following shows the contiguous block of memory: |
| // |
| // +-----------------------------+ class __tree_end_node |
| // __ptr_ | pointer __left_; | |
| // +-----------------------------+ class __tree_node_base |
| // | pointer __right_; | |
| // | __parent_pointer __parent_; | |
| // | bool __is_black_; | |
| // +-----------------------------+ class __tree_node |
| // | __node_value_type __value_; | <<< our key/value pair |
| // +-----------------------------+ |
| // |
| CompilerType tree_node_type = ast_ctx->CreateStructForIdentifier( |
| ConstString(), |
| {{"ptr0", |
| ast_ctx->GetBasicType(lldb::eBasicTypeVoid).GetPointerType()}, |
| {"ptr1", |
| ast_ctx->GetBasicType(lldb::eBasicTypeVoid).GetPointerType()}, |
| {"ptr2", |
| ast_ctx->GetBasicType(lldb::eBasicTypeVoid).GetPointerType()}, |
| {"cw", ast_ctx->GetBasicType(lldb::eBasicTypeBool)}, |
| {"payload", pair_type}}); |
| std::optional<uint64_t> size = tree_node_type.GetByteSize(nullptr); |
| if (!size) |
| return false; |
| WritableDataBufferSP buffer_sp(new DataBufferHeap(*size, 0)); |
| ProcessSP process_sp(target_sp->GetProcessSP()); |
| Status error; |
| process_sp->ReadMemory(addr, buffer_sp->GetBytes(), |
| buffer_sp->GetByteSize(), error); |
| if (error.Fail()) |
| return false; |
| DataExtractor extractor(buffer_sp, process_sp->GetByteOrder(), |
| process_sp->GetAddressByteSize()); |
| auto pair_sp = CreateValueObjectFromData( |
| "pair", extractor, valobj_sp->GetExecutionContextRef(), |
| tree_node_type); |
| if (pair_sp) |
| m_pair_sp = pair_sp->GetChildAtIndex(4, true); |
| } |
| } |
| } |
| |
| return false; |
| } |
| |
| size_t lldb_private::formatters::LibCxxMapIteratorSyntheticFrontEnd:: |
| CalculateNumChildren() { |
| return 2; |
| } |
| |
| lldb::ValueObjectSP |
| lldb_private::formatters::LibCxxMapIteratorSyntheticFrontEnd::GetChildAtIndex( |
| size_t idx) { |
| if (m_pair_ptr) |
| return m_pair_ptr->GetChildAtIndex(idx, true); |
| if (m_pair_sp) |
| return m_pair_sp->GetChildAtIndex(idx, true); |
| return lldb::ValueObjectSP(); |
| } |
| |
| bool lldb_private::formatters::LibCxxMapIteratorSyntheticFrontEnd:: |
| MightHaveChildren() { |
| return true; |
| } |
| |
| size_t lldb_private::formatters::LibCxxMapIteratorSyntheticFrontEnd:: |
| GetIndexOfChildWithName(ConstString name) { |
| if (name == "first") |
| return 0; |
| if (name == "second") |
| return 1; |
| return UINT32_MAX; |
| } |
| |
| lldb_private::formatters::LibCxxMapIteratorSyntheticFrontEnd:: |
| ~LibCxxMapIteratorSyntheticFrontEnd() { |
| // this will be deleted when its parent dies (since it's a child object) |
| // delete m_pair_ptr; |
| } |
| |
| SyntheticChildrenFrontEnd * |
| lldb_private::formatters::LibCxxMapIteratorSyntheticFrontEndCreator( |
| CXXSyntheticChildren *, lldb::ValueObjectSP valobj_sp) { |
| return (valobj_sp ? new LibCxxMapIteratorSyntheticFrontEnd(valobj_sp) |
| : nullptr); |
| } |
| |
| lldb_private::formatters::LibCxxUnorderedMapIteratorSyntheticFrontEnd:: |
| LibCxxUnorderedMapIteratorSyntheticFrontEnd(lldb::ValueObjectSP valobj_sp) |
| : SyntheticChildrenFrontEnd(*valobj_sp) { |
| if (valobj_sp) |
| Update(); |
| } |
| |
| bool lldb_private::formatters::LibCxxUnorderedMapIteratorSyntheticFrontEnd:: |
| Update() { |
| m_pair_sp.reset(); |
| m_iter_ptr = nullptr; |
| |
| ValueObjectSP valobj_sp = m_backend.GetSP(); |
| if (!valobj_sp) |
| return false; |
| |
| TargetSP target_sp(valobj_sp->GetTargetSP()); |
| |
| if (!target_sp) |
| return false; |
| |
| if (!valobj_sp) |
| return false; |
| |
| auto exprPathOptions = ValueObject::GetValueForExpressionPathOptions() |
| .DontCheckDotVsArrowSyntax() |
| .SetSyntheticChildrenTraversal( |
| ValueObject::GetValueForExpressionPathOptions:: |
| SyntheticChildrenTraversal::None); |
| |
| // This must be a ValueObject* because it is a child of the ValueObject we |
| // are producing children for it if were a ValueObjectSP, we would end up |
| // with a loop (iterator -> synthetic -> child -> parent == iterator) and |
| // that would in turn leak memory by never allowing the ValueObjects to die |
| // and free their memory. |
| m_iter_ptr = |
| valobj_sp |
| ->GetValueForExpressionPath(".__i_.__node_", nullptr, nullptr, |
| exprPathOptions, nullptr) |
| .get(); |
| |
| if (m_iter_ptr) { |
| auto iter_child( |
| valobj_sp->GetChildMemberWithName(ConstString("__i_"), true)); |
| if (!iter_child) { |
| m_iter_ptr = nullptr; |
| return false; |
| } |
| |
| CompilerType node_type(iter_child->GetCompilerType() |
| .GetTypeTemplateArgument(0) |
| .GetPointeeType()); |
| |
| CompilerType pair_type(node_type.GetTypeTemplateArgument(0)); |
| |
| std::string name; |
| uint64_t bit_offset_ptr; |
| uint32_t bitfield_bit_size_ptr; |
| bool is_bitfield_ptr; |
| |
| pair_type = pair_type.GetFieldAtIndex( |
| 0, name, &bit_offset_ptr, &bitfield_bit_size_ptr, &is_bitfield_ptr); |
| if (!pair_type) { |
| m_iter_ptr = nullptr; |
| return false; |
| } |
| |
| uint64_t addr = m_iter_ptr->GetValueAsUnsigned(LLDB_INVALID_ADDRESS); |
| m_iter_ptr = nullptr; |
| |
| if (addr == 0 || addr == LLDB_INVALID_ADDRESS) |
| return false; |
| |
| auto ts = pair_type.GetTypeSystem(); |
| auto ast_ctx = ts.dyn_cast_or_null<TypeSystemClang>(); |
| if (!ast_ctx) |
| return false; |
| |
| // Mimick layout of std::__hash_iterator::__node_ and read it in |
| // from process memory. |
| // |
| // The following shows the contiguous block of memory: |
| // |
| // +-----------------------------+ class __hash_node_base |
| // __node_ | __next_pointer __next_; | |
| // +-----------------------------+ class __hash_node |
| // | size_t __hash_; | |
| // | __node_value_type __value_; | <<< our key/value pair |
| // +-----------------------------+ |
| // |
| CompilerType tree_node_type = ast_ctx->CreateStructForIdentifier( |
| ConstString(), |
| {{"__next_", |
| ast_ctx->GetBasicType(lldb::eBasicTypeVoid).GetPointerType()}, |
| {"__hash_", ast_ctx->GetBasicType(lldb::eBasicTypeUnsignedLongLong)}, |
| {"__value_", pair_type}}); |
| std::optional<uint64_t> size = tree_node_type.GetByteSize(nullptr); |
| if (!size) |
| return false; |
| WritableDataBufferSP buffer_sp(new DataBufferHeap(*size, 0)); |
| ProcessSP process_sp(target_sp->GetProcessSP()); |
| Status error; |
| process_sp->ReadMemory(addr, buffer_sp->GetBytes(), |
| buffer_sp->GetByteSize(), error); |
| if (error.Fail()) |
| return false; |
| DataExtractor extractor(buffer_sp, process_sp->GetByteOrder(), |
| process_sp->GetAddressByteSize()); |
| auto pair_sp = CreateValueObjectFromData( |
| "pair", extractor, valobj_sp->GetExecutionContextRef(), tree_node_type); |
| if (pair_sp) |
| m_pair_sp = pair_sp->GetChildAtIndex(2, true); |
| } |
| |
| return false; |
| } |
| |
| size_t lldb_private::formatters::LibCxxUnorderedMapIteratorSyntheticFrontEnd:: |
| CalculateNumChildren() { |
| return 2; |
| } |
| |
| lldb::ValueObjectSP lldb_private::formatters:: |
| LibCxxUnorderedMapIteratorSyntheticFrontEnd::GetChildAtIndex(size_t idx) { |
| if (m_pair_sp) |
| return m_pair_sp->GetChildAtIndex(idx, true); |
| return lldb::ValueObjectSP(); |
| } |
| |
| bool lldb_private::formatters::LibCxxUnorderedMapIteratorSyntheticFrontEnd:: |
| MightHaveChildren() { |
| return true; |
| } |
| |
| size_t lldb_private::formatters::LibCxxUnorderedMapIteratorSyntheticFrontEnd:: |
| GetIndexOfChildWithName(ConstString name) { |
| if (name == "first") |
| return 0; |
| if (name == "second") |
| return 1; |
| return UINT32_MAX; |
| } |
| |
| SyntheticChildrenFrontEnd * |
| lldb_private::formatters::LibCxxUnorderedMapIteratorSyntheticFrontEndCreator( |
| CXXSyntheticChildren *, lldb::ValueObjectSP valobj_sp) { |
| return (valobj_sp ? new LibCxxUnorderedMapIteratorSyntheticFrontEnd(valobj_sp) |
| : nullptr); |
| } |
| |
| /* |
| (lldb) fr var ibeg --raw --ptr-depth 1 -T |
| (std::__1::__wrap_iter<int *>) ibeg = { |
| (std::__1::__wrap_iter<int *>::iterator_type) __i = 0x00000001001037a0 { |
| (int) *__i = 1 |
| } |
| } |
| */ |
| |
| SyntheticChildrenFrontEnd * |
| lldb_private::formatters::LibCxxVectorIteratorSyntheticFrontEndCreator( |
| CXXSyntheticChildren *, lldb::ValueObjectSP valobj_sp) { |
| return (valobj_sp ? new VectorIteratorSyntheticFrontEnd( |
| valobj_sp, {ConstString("__i_"), ConstString("__i")}) |
| : nullptr); |
| } |
| |
| lldb_private::formatters::LibcxxSharedPtrSyntheticFrontEnd:: |
| LibcxxSharedPtrSyntheticFrontEnd(lldb::ValueObjectSP valobj_sp) |
| : SyntheticChildrenFrontEnd(*valobj_sp), m_cntrl(nullptr) { |
| if (valobj_sp) |
| Update(); |
| } |
| |
| size_t lldb_private::formatters::LibcxxSharedPtrSyntheticFrontEnd:: |
| CalculateNumChildren() { |
| return (m_cntrl ? 1 : 0); |
| } |
| |
| lldb::ValueObjectSP |
| lldb_private::formatters::LibcxxSharedPtrSyntheticFrontEnd::GetChildAtIndex( |
| size_t idx) { |
| if (!m_cntrl) |
| return lldb::ValueObjectSP(); |
| |
| ValueObjectSP valobj_sp = m_backend.GetSP(); |
| if (!valobj_sp) |
| return lldb::ValueObjectSP(); |
| |
| if (idx == 0) |
| return valobj_sp->GetChildMemberWithName(ConstString("__ptr_"), true); |
| |
| if (idx == 1) { |
| if (auto ptr_sp = |
| valobj_sp->GetChildMemberWithName(ConstString("__ptr_"), true)) { |
| Status status; |
| auto value_sp = ptr_sp->Dereference(status); |
| if (status.Success()) { |
| auto value_type_sp = |
| valobj_sp->GetCompilerType().GetTypeTemplateArgument(0); |
| return value_sp->Cast(value_type_sp); |
| } |
| } |
| } |
| |
| return lldb::ValueObjectSP(); |
| } |
| |
| bool lldb_private::formatters::LibcxxSharedPtrSyntheticFrontEnd::Update() { |
| m_cntrl = nullptr; |
| |
| ValueObjectSP valobj_sp = m_backend.GetSP(); |
| if (!valobj_sp) |
| return false; |
| |
| TargetSP target_sp(valobj_sp->GetTargetSP()); |
| if (!target_sp) |
| return false; |
| |
| lldb::ValueObjectSP cntrl_sp( |
| valobj_sp->GetChildMemberWithName(ConstString("__cntrl_"), true)); |
| |
| m_cntrl = cntrl_sp.get(); // need to store the raw pointer to avoid a circular |
| // dependency |
| return false; |
| } |
| |
| bool lldb_private::formatters::LibcxxSharedPtrSyntheticFrontEnd:: |
| MightHaveChildren() { |
| return true; |
| } |
| |
| size_t lldb_private::formatters::LibcxxSharedPtrSyntheticFrontEnd:: |
| GetIndexOfChildWithName(ConstString name) { |
| if (name == "__ptr_") |
| return 0; |
| if (name == "$$dereference$$") |
| return 1; |
| return UINT32_MAX; |
| } |
| |
| lldb_private::formatters::LibcxxSharedPtrSyntheticFrontEnd:: |
| ~LibcxxSharedPtrSyntheticFrontEnd() = default; |
| |
| SyntheticChildrenFrontEnd * |
| lldb_private::formatters::LibcxxSharedPtrSyntheticFrontEndCreator( |
| CXXSyntheticChildren *, lldb::ValueObjectSP valobj_sp) { |
| return (valobj_sp ? new LibcxxSharedPtrSyntheticFrontEnd(valobj_sp) |
| : nullptr); |
| } |
| |
| lldb_private::formatters::LibcxxUniquePtrSyntheticFrontEnd:: |
| LibcxxUniquePtrSyntheticFrontEnd(lldb::ValueObjectSP valobj_sp) |
| : SyntheticChildrenFrontEnd(*valobj_sp) { |
| if (valobj_sp) |
| Update(); |
| } |
| |
| lldb_private::formatters::LibcxxUniquePtrSyntheticFrontEnd:: |
| ~LibcxxUniquePtrSyntheticFrontEnd() = default; |
| |
| SyntheticChildrenFrontEnd * |
| lldb_private::formatters::LibcxxUniquePtrSyntheticFrontEndCreator( |
| CXXSyntheticChildren *, lldb::ValueObjectSP valobj_sp) { |
| return (valobj_sp ? new LibcxxUniquePtrSyntheticFrontEnd(valobj_sp) |
| : nullptr); |
| } |
| |
| size_t lldb_private::formatters::LibcxxUniquePtrSyntheticFrontEnd:: |
| CalculateNumChildren() { |
| return (m_value_ptr_sp ? 1 : 0); |
| } |
| |
| lldb::ValueObjectSP |
| lldb_private::formatters::LibcxxUniquePtrSyntheticFrontEnd::GetChildAtIndex( |
| size_t idx) { |
| if (!m_value_ptr_sp) |
| return lldb::ValueObjectSP(); |
| |
| if (idx == 0) |
| return m_value_ptr_sp; |
| |
| if (idx == 1) { |
| Status status; |
| auto value_sp = m_value_ptr_sp->Dereference(status); |
| if (status.Success()) { |
| return value_sp; |
| } |
| } |
| |
| return lldb::ValueObjectSP(); |
| } |
| |
| bool lldb_private::formatters::LibcxxUniquePtrSyntheticFrontEnd::Update() { |
| ValueObjectSP valobj_sp = m_backend.GetSP(); |
| if (!valobj_sp) |
| return false; |
| |
| ValueObjectSP ptr_sp( |
| valobj_sp->GetChildMemberWithName(ConstString("__ptr_"), true)); |
| if (!ptr_sp) |
| return false; |
| |
| m_value_ptr_sp = GetValueOfLibCXXCompressedPair(*ptr_sp); |
| |
| return false; |
| } |
| |
| bool lldb_private::formatters::LibcxxUniquePtrSyntheticFrontEnd:: |
| MightHaveChildren() { |
| return true; |
| } |
| |
| size_t lldb_private::formatters::LibcxxUniquePtrSyntheticFrontEnd:: |
| GetIndexOfChildWithName(ConstString name) { |
| if (name == "__value_") |
| return 0; |
| if (name == "$$dereference$$") |
| return 1; |
| return UINT32_MAX; |
| } |
| |
| bool lldb_private::formatters::LibcxxContainerSummaryProvider( |
| ValueObject &valobj, Stream &stream, const TypeSummaryOptions &options) { |
| if (valobj.IsPointerType()) { |
| uint64_t value = valobj.GetValueAsUnsigned(0); |
| if (!value) |
| return false; |
| stream.Printf("0x%016" PRIx64 " ", value); |
| } |
| return FormatEntity::FormatStringRef("size=${svar%#}", stream, nullptr, |
| nullptr, nullptr, &valobj, false, false); |
| } |
| |
| /// The field layout in a libc++ string (cap, side, data or data, size, cap). |
| namespace { |
| enum class StringLayout { CSD, DSC }; |
| } |
| |
| /// Determine the size in bytes of \p valobj (a libc++ std::string object) and |
| /// extract its data payload. Return the size + payload pair. |
| // TODO: Support big-endian architectures. |
| static std::optional<std::pair<uint64_t, ValueObjectSP>> |
| ExtractLibcxxStringInfo(ValueObject &valobj) { |
| ValueObjectSP valobj_r_sp = |
| valobj.GetChildMemberWithName(ConstString("__r_"), /*can_create=*/true); |
| if (!valobj_r_sp || !valobj_r_sp->GetError().Success()) |
| return {}; |
| |
| // __r_ is a compressed_pair of the actual data and the allocator. The data we |
| // want is in the first base class. |
| ValueObjectSP valobj_r_base_sp = |
| valobj_r_sp->GetChildAtIndex(0, /*can_create=*/true); |
| if (!valobj_r_base_sp) |
| return {}; |
| |
| ValueObjectSP valobj_rep_sp = valobj_r_base_sp->GetChildMemberWithName( |
| ConstString("__value_"), /*can_create=*/true); |
| if (!valobj_rep_sp) |
| return {}; |
| |
| ValueObjectSP l = valobj_rep_sp->GetChildMemberWithName(ConstString("__l"), |
| /*can_create=*/true); |
| if (!l) |
| return {}; |
| |
| StringLayout layout = l->GetIndexOfChildWithName(ConstString("__data_")) == 0 |
| ? StringLayout::DSC |
| : StringLayout::CSD; |
| |
| bool short_mode = false; // this means the string is in short-mode and the |
| // data is stored inline |
| bool using_bitmasks = true; // Whether the class uses bitmasks for the mode |
| // flag (pre-D123580). |
| uint64_t size; |
| uint64_t size_mode_value = 0; |
| |
| ValueObjectSP short_sp = valobj_rep_sp->GetChildMemberWithName( |
| ConstString("__s"), /*can_create=*/true); |
| if (!short_sp) |
| return {}; |
| |
| ValueObjectSP is_long = |
| short_sp->GetChildMemberWithName(ConstString("__is_long_"), true); |
| ValueObjectSP size_sp = |
| short_sp->GetChildAtNamePath({ConstString("__size_")}); |
| if (!size_sp) |
| return {}; |
| |
| if (is_long) { |
| using_bitmasks = false; |
| short_mode = !is_long->GetValueAsUnsigned(/*fail_value=*/0); |
| size = size_sp->GetValueAsUnsigned(/*fail_value=*/0); |
| } else { |
| // The string mode is encoded in the size field. |
| size_mode_value = size_sp->GetValueAsUnsigned(0); |
| uint8_t mode_mask = layout == StringLayout::DSC ? 0x80 : 1; |
| short_mode = (size_mode_value & mode_mask) == 0; |
| } |
| |
| if (short_mode) { |
| ValueObjectSP location_sp = |
| short_sp->GetChildMemberWithName(ConstString("__data_"), true); |
| if (using_bitmasks) |
| size = (layout == StringLayout::DSC) ? size_mode_value |
| : ((size_mode_value >> 1) % 256); |
| |
| // When the small-string optimization takes place, the data must fit in the |
| // inline string buffer (23 bytes on x86_64/Darwin). If it doesn't, it's |
| // likely that the string isn't initialized and we're reading garbage. |
| ExecutionContext exe_ctx(location_sp->GetExecutionContextRef()); |
| const std::optional<uint64_t> max_bytes = |
| location_sp->GetCompilerType().GetByteSize( |
| exe_ctx.GetBestExecutionContextScope()); |
| if (!max_bytes || size > *max_bytes || !location_sp) |
| return {}; |
| |
| return std::make_pair(size, location_sp); |
| } |
| |
| // we can use the layout_decider object as the data pointer |
| ValueObjectSP location_sp = |
| l->GetChildMemberWithName(ConstString("__data_"), /*can_create=*/true); |
| ValueObjectSP size_vo = |
| l->GetChildMemberWithName(ConstString("__size_"), /*can_create=*/true); |
| ValueObjectSP capacity_vo = |
| l->GetChildMemberWithName(ConstString("__cap_"), /*can_create=*/true); |
| if (!size_vo || !location_sp || !capacity_vo) |
| return {}; |
| size = size_vo->GetValueAsUnsigned(LLDB_INVALID_OFFSET); |
| uint64_t capacity = capacity_vo->GetValueAsUnsigned(LLDB_INVALID_OFFSET); |
| if (!using_bitmasks && layout == StringLayout::CSD) |
| capacity *= 2; |
| if (size == LLDB_INVALID_OFFSET || capacity == LLDB_INVALID_OFFSET || |
| capacity < size) |
| return {}; |
| return std::make_pair(size, location_sp); |
| } |
| |
| static bool |
| LibcxxWStringSummaryProvider(ValueObject &valobj, Stream &stream, |
| const TypeSummaryOptions &summary_options, |
| ValueObjectSP location_sp, size_t size) { |
| if (size == 0) { |
| stream.Printf("L\"\""); |
| return true; |
| } |
| if (!location_sp) |
| return false; |
| |
| StringPrinter::ReadBufferAndDumpToStreamOptions options(valobj); |
| if (summary_options.GetCapping() == TypeSummaryCapping::eTypeSummaryCapped) { |
| const auto max_size = valobj.GetTargetSP()->GetMaximumSizeOfStringSummary(); |
| if (size > max_size) { |
| size = max_size; |
| options.SetIsTruncated(true); |
| } |
| } |
| |
| DataExtractor extractor; |
| const size_t bytes_read = location_sp->GetPointeeData(extractor, 0, size); |
| if (bytes_read < size) |
| return false; |
| |
| // std::wstring::size() is measured in 'characters', not bytes |
| TypeSystemClangSP scratch_ts_sp = |
| ScratchTypeSystemClang::GetForTarget(*valobj.GetTargetSP()); |
| if (!scratch_ts_sp) |
| return false; |
| |
| auto wchar_t_size = |
| scratch_ts_sp->GetBasicType(lldb::eBasicTypeWChar).GetByteSize(nullptr); |
| if (!wchar_t_size) |
| return false; |
| |
| options.SetData(std::move(extractor)); |
| options.SetStream(&stream); |
| options.SetPrefixToken("L"); |
| options.SetQuote('"'); |
| options.SetSourceSize(size); |
| options.SetBinaryZeroIsTerminator(false); |
| |
| switch (*wchar_t_size) { |
| case 1: |
| return StringPrinter::ReadBufferAndDumpToStream< |
| lldb_private::formatters::StringPrinter::StringElementType::UTF8>( |
| options); |
| break; |
| |
| case 2: |
| return StringPrinter::ReadBufferAndDumpToStream< |
| lldb_private::formatters::StringPrinter::StringElementType::UTF16>( |
| options); |
| break; |
| |
| case 4: |
| return StringPrinter::ReadBufferAndDumpToStream< |
| lldb_private::formatters::StringPrinter::StringElementType::UTF32>( |
| options); |
| } |
| return false; |
| } |
| |
| bool lldb_private::formatters::LibcxxWStringSummaryProvider( |
| ValueObject &valobj, Stream &stream, |
| const TypeSummaryOptions &summary_options) { |
| auto string_info = ExtractLibcxxStringInfo(valobj); |
| if (!string_info) |
| return false; |
| uint64_t size; |
| ValueObjectSP location_sp; |
| std::tie(size, location_sp) = *string_info; |
| |
| return ::LibcxxWStringSummaryProvider(valobj, stream, summary_options, |
| location_sp, size); |
| } |
| |
| template <StringPrinter::StringElementType element_type> |
| static bool |
| LibcxxStringSummaryProvider(ValueObject &valobj, Stream &stream, |
| const TypeSummaryOptions &summary_options, |
| std::string prefix_token, ValueObjectSP location_sp, |
| uint64_t size) { |
| |
| if (size == 0) { |
| stream.Printf("\"\""); |
| return true; |
| } |
| |
| if (!location_sp) |
| return false; |
| |
| StringPrinter::ReadBufferAndDumpToStreamOptions options(valobj); |
| |
| if (summary_options.GetCapping() == TypeSummaryCapping::eTypeSummaryCapped) { |
| const auto max_size = valobj.GetTargetSP()->GetMaximumSizeOfStringSummary(); |
| if (size > max_size) { |
| size = max_size; |
| options.SetIsTruncated(true); |
| } |
| } |
| |
| { |
| DataExtractor extractor; |
| const size_t bytes_read = location_sp->GetPointeeData(extractor, 0, size); |
| if (bytes_read < size) |
| return false; |
| |
| options.SetData(std::move(extractor)); |
| } |
| options.SetStream(&stream); |
| if (prefix_token.empty()) |
| options.SetPrefixToken(nullptr); |
| else |
| options.SetPrefixToken(prefix_token); |
| options.SetQuote('"'); |
| options.SetSourceSize(size); |
| options.SetBinaryZeroIsTerminator(false); |
| return StringPrinter::ReadBufferAndDumpToStream<element_type>(options); |
| } |
| |
| template <StringPrinter::StringElementType element_type> |
| static bool |
| LibcxxStringSummaryProvider(ValueObject &valobj, Stream &stream, |
| const TypeSummaryOptions &summary_options, |
| std::string prefix_token) { |
| auto string_info = ExtractLibcxxStringInfo(valobj); |
| if (!string_info) |
| return false; |
| uint64_t size; |
| ValueObjectSP location_sp; |
| std::tie(size, location_sp) = *string_info; |
| |
| return LibcxxStringSummaryProvider<element_type>( |
| valobj, stream, summary_options, prefix_token, location_sp, size); |
| } |
| template <StringPrinter::StringElementType element_type> |
| static bool formatStringImpl(ValueObject &valobj, Stream &stream, |
| const TypeSummaryOptions &summary_options, |
| std::string prefix_token) { |
| StreamString scratch_stream; |
| const bool success = LibcxxStringSummaryProvider<element_type>( |
| valobj, scratch_stream, summary_options, prefix_token); |
| if (success) |
| stream << scratch_stream.GetData(); |
| else |
| stream << "Summary Unavailable"; |
| return true; |
| } |
| |
| bool lldb_private::formatters::LibcxxStringSummaryProviderASCII( |
| ValueObject &valobj, Stream &stream, |
| const TypeSummaryOptions &summary_options) { |
| return formatStringImpl<StringPrinter::StringElementType::ASCII>( |
| valobj, stream, summary_options, ""); |
| } |
| |
| bool lldb_private::formatters::LibcxxStringSummaryProviderUTF16( |
| ValueObject &valobj, Stream &stream, |
| const TypeSummaryOptions &summary_options) { |
| return formatStringImpl<StringPrinter::StringElementType::UTF16>( |
| valobj, stream, summary_options, "u"); |
| } |
| |
| bool lldb_private::formatters::LibcxxStringSummaryProviderUTF32( |
| ValueObject &valobj, Stream &stream, |
| const TypeSummaryOptions &summary_options) { |
| return formatStringImpl<StringPrinter::StringElementType::UTF32>( |
| valobj, stream, summary_options, "U"); |
| } |
| |
| static std::tuple<bool, ValueObjectSP, size_t> |
| LibcxxExtractStringViewData(ValueObject& valobj) { |
| auto dataobj = GetChildMemberWithName( |
| valobj, {ConstString("__data_"), ConstString("__data")}); |
| auto sizeobj = GetChildMemberWithName( |
| valobj, {ConstString("__size_"), ConstString("__size")}); |
| if (!dataobj || !sizeobj) |
| return std::make_tuple<bool,ValueObjectSP,size_t>(false, {}, {}); |
| |
| if (!dataobj->GetError().Success() || !sizeobj->GetError().Success()) |
| return std::make_tuple<bool,ValueObjectSP,size_t>(false, {}, {}); |
| |
| bool success{false}; |
| uint64_t size = sizeobj->GetValueAsUnsigned(0, &success); |
| if (!success) |
| return std::make_tuple<bool,ValueObjectSP,size_t>(false, {}, {}); |
| |
| return std::make_tuple(true,dataobj,size); |
| } |
| |
| template <StringPrinter::StringElementType element_type> |
| static bool formatStringViewImpl(ValueObject &valobj, Stream &stream, |
| const TypeSummaryOptions &summary_options, |
| std::string prefix_token) { |
| |
| bool success; |
| ValueObjectSP dataobj; |
| size_t size; |
| std::tie(success, dataobj, size) = LibcxxExtractStringViewData(valobj); |
| |
| if (!success) { |
| stream << "Summary Unavailable"; |
| return true; |
| } |
| |
| return LibcxxStringSummaryProvider<element_type>( |
| valobj, stream, summary_options, prefix_token, dataobj, size); |
| } |
| |
| bool lldb_private::formatters::LibcxxStringViewSummaryProviderASCII( |
| ValueObject &valobj, Stream &stream, |
| const TypeSummaryOptions &summary_options) { |
| return formatStringViewImpl<StringPrinter::StringElementType::ASCII>( |
| valobj, stream, summary_options, ""); |
| } |
| |
| bool lldb_private::formatters::LibcxxStringViewSummaryProviderUTF16( |
| ValueObject &valobj, Stream &stream, |
| const TypeSummaryOptions &summary_options) { |
| return formatStringViewImpl<StringPrinter::StringElementType::UTF16>( |
| valobj, stream, summary_options, "u"); |
| } |
| |
| bool lldb_private::formatters::LibcxxStringViewSummaryProviderUTF32( |
| ValueObject &valobj, Stream &stream, |
| const TypeSummaryOptions &summary_options) { |
| return formatStringViewImpl<StringPrinter::StringElementType::UTF32>( |
| valobj, stream, summary_options, "U"); |
| } |
| |
| bool lldb_private::formatters::LibcxxWStringViewSummaryProvider( |
| ValueObject &valobj, Stream &stream, |
| const TypeSummaryOptions &summary_options) { |
| |
| bool success; |
| ValueObjectSP dataobj; |
| size_t size; |
| std::tie( success, dataobj, size ) = LibcxxExtractStringViewData(valobj); |
| |
| if (!success) { |
| stream << "Summary Unavailable"; |
| return true; |
| } |
| |
| |
| return ::LibcxxWStringSummaryProvider(valobj, stream, summary_options, |
| dataobj, size); |
| } |
