1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213
|
//===-- BlockPointer.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 "BlockPointer.h"
#include "Plugins/ExpressionParser/Clang/ClangASTImporter.h"
#include "Plugins/ExpressionParser/Clang/ClangPersistentVariables.h"
#include "Plugins/TypeSystem/Clang/TypeSystemClang.h"
#include "lldb/Core/ValueObject.h"
#include "lldb/DataFormatters/FormattersHelpers.h"
#include "lldb/Symbol/CompilerType.h"
#include "lldb/Symbol/TypeSystem.h"
#include "lldb/Target/Target.h"
#include "lldb/Utility/LLDBAssert.h"
#include "lldb/Utility/Log.h"
using namespace lldb;
using namespace lldb_private;
using namespace lldb_private::formatters;
namespace lldb_private {
namespace formatters {
class BlockPointerSyntheticFrontEnd : public SyntheticChildrenFrontEnd {
public:
BlockPointerSyntheticFrontEnd(lldb::ValueObjectSP valobj_sp)
: SyntheticChildrenFrontEnd(*valobj_sp), m_block_struct_type() {
CompilerType block_pointer_type(m_backend.GetCompilerType());
CompilerType function_pointer_type;
block_pointer_type.IsBlockPointerType(&function_pointer_type);
TargetSP target_sp(m_backend.GetTargetSP());
if (!target_sp) {
return;
}
auto type_system_or_err = target_sp->GetScratchTypeSystemForLanguage(
lldb::eLanguageTypeC_plus_plus);
if (auto err = type_system_or_err.takeError()) {
LLDB_LOG_ERROR(
lldb_private::GetLogIfAnyCategoriesSet(LIBLLDB_LOG_DATAFORMATTERS),
std::move(err), "Failed to get scratch TypeSystemClang");
return;
}
TypeSystemClang *clang_ast_context =
llvm::dyn_cast<TypeSystemClang>(&type_system_or_err.get());
if (!clang_ast_context) {
return;
}
std::shared_ptr<ClangASTImporter> clang_ast_importer;
auto *state = target_sp->GetPersistentExpressionStateForLanguage(
lldb::eLanguageTypeC_plus_plus);
if (state) {
auto *persistent_vars = llvm::cast<ClangPersistentVariables>(state);
clang_ast_importer = persistent_vars->GetClangASTImporter();
}
if (!clang_ast_importer) {
return;
}
const char *const isa_name("__isa");
const CompilerType isa_type =
clang_ast_context->GetBasicType(lldb::eBasicTypeObjCClass);
const char *const flags_name("__flags");
const CompilerType flags_type =
clang_ast_context->GetBasicType(lldb::eBasicTypeInt);
const char *const reserved_name("__reserved");
const CompilerType reserved_type =
clang_ast_context->GetBasicType(lldb::eBasicTypeInt);
const char *const FuncPtr_name("__FuncPtr");
const CompilerType FuncPtr_type =
clang_ast_importer->CopyType(*clang_ast_context, function_pointer_type);
m_block_struct_type = clang_ast_context->CreateStructForIdentifier(
ConstString(), {{isa_name, isa_type},
{flags_name, flags_type},
{reserved_name, reserved_type},
{FuncPtr_name, FuncPtr_type}});
}
~BlockPointerSyntheticFrontEnd() override = default;
size_t CalculateNumChildren() override {
const bool omit_empty_base_classes = false;
return m_block_struct_type.GetNumChildren(omit_empty_base_classes, nullptr);
}
lldb::ValueObjectSP GetChildAtIndex(size_t idx) override {
if (!m_block_struct_type.IsValid()) {
return lldb::ValueObjectSP();
}
if (idx >= CalculateNumChildren()) {
return lldb::ValueObjectSP();
}
const bool thread_and_frame_only_if_stopped = true;
ExecutionContext exe_ctx = m_backend.GetExecutionContextRef().Lock(
thread_and_frame_only_if_stopped);
const bool transparent_pointers = false;
const bool omit_empty_base_classes = false;
const bool ignore_array_bounds = false;
ValueObject *value_object = nullptr;
std::string child_name;
uint32_t child_byte_size = 0;
int32_t child_byte_offset = 0;
uint32_t child_bitfield_bit_size = 0;
uint32_t child_bitfield_bit_offset = 0;
bool child_is_base_class = false;
bool child_is_deref_of_parent = false;
uint64_t language_flags = 0;
const CompilerType child_type =
m_block_struct_type.GetChildCompilerTypeAtIndex(
&exe_ctx, idx, transparent_pointers, omit_empty_base_classes,
ignore_array_bounds, child_name, child_byte_size, child_byte_offset,
child_bitfield_bit_size, child_bitfield_bit_offset,
child_is_base_class, child_is_deref_of_parent, value_object,
language_flags);
ValueObjectSP struct_pointer_sp =
m_backend.Cast(m_block_struct_type.GetPointerType());
if (!struct_pointer_sp) {
return lldb::ValueObjectSP();
}
Status err;
ValueObjectSP struct_sp = struct_pointer_sp->Dereference(err);
if (!struct_sp || !err.Success()) {
return lldb::ValueObjectSP();
}
ValueObjectSP child_sp(struct_sp->GetSyntheticChildAtOffset(
child_byte_offset, child_type, true,
ConstString(child_name.c_str(), child_name.size())));
return child_sp;
}
// return true if this object is now safe to use forever without ever
// updating again; the typical (and tested) answer here is 'false'
bool Update() override { return false; }
// maybe return false if the block pointer is, say, null
bool MightHaveChildren() override { return true; }
size_t GetIndexOfChildWithName(ConstString name) override {
if (!m_block_struct_type.IsValid())
return UINT32_MAX;
const bool omit_empty_base_classes = false;
return m_block_struct_type.GetIndexOfChildWithName(name.AsCString(),
omit_empty_base_classes);
}
private:
CompilerType m_block_struct_type;
};
} // namespace formatters
} // namespace lldb_private
bool lldb_private::formatters::BlockPointerSummaryProvider(
ValueObject &valobj, Stream &s, const TypeSummaryOptions &) {
lldb_private::SyntheticChildrenFrontEnd *synthetic_children =
BlockPointerSyntheticFrontEndCreator(nullptr, valobj.GetSP());
if (!synthetic_children) {
return false;
}
synthetic_children->Update();
static const ConstString s_FuncPtr_name("__FuncPtr");
lldb::ValueObjectSP child_sp = synthetic_children->GetChildAtIndex(
synthetic_children->GetIndexOfChildWithName(s_FuncPtr_name));
if (!child_sp) {
return false;
}
lldb::ValueObjectSP qualified_child_representation_sp =
child_sp->GetQualifiedRepresentationIfAvailable(
lldb::eDynamicDontRunTarget, true);
const char *child_value =
qualified_child_representation_sp->GetValueAsCString();
s.Printf("%s", child_value);
return true;
}
lldb_private::SyntheticChildrenFrontEnd *
lldb_private::formatters::BlockPointerSyntheticFrontEndCreator(
CXXSyntheticChildren *, lldb::ValueObjectSP valobj_sp) {
if (!valobj_sp)
return nullptr;
return new BlockPointerSyntheticFrontEnd(valobj_sp);
}
|