Add the ability to get a C++ vtable ValueObject from another
ValueObject.
This patch adds the ability to ask a ValueObject for a ValueObject that
represents the virtual function table for a C++ class. If the
ValueObject is not a C++ class with a vtable, a valid ValueObject value
will be returned that contains an appropriate error. If it is successful
a valid ValueObject that represents vtable will be returned. The
ValueObject that is returned will have a name that matches the demangled
value for a C++ vtable mangled name like "vtable for <class-name>". It
will have N children, one for each virtual function pointer. Each
child's value is the function pointer itself, the summary is the
symbolication of this function pointer, and the type will be a valid
function pointer from the debug info if there is debug information
corresponding to the virtual function pointer.
The vtable SBValue will have the following:
- SBValue::GetName() returns "vtable for <class>"
- SBValue::GetValue() returns a string representation of the vtable
address
- SBValue::GetSummary() returns NULL
- SBValue::GetType() returns a type appropriate for a uintptr_t type for
the current process
- SBValue::GetLoadAddress() returns the address of the vtable adderess
- SBValue::GetValueAsUnsigned(...) returns the vtable address
- SBValue::GetNumChildren() returns the number of virtual function
pointers in the vtable
- SBValue::GetChildAtIndex(...) returns a SBValue that represents a
virtual function pointer
The child SBValue objects that represent a virtual function pointer has
the following values:
- SBValue::GetName() returns "[%u]" where %u is the vtable function
pointer index
- SBValue::GetValue() returns a string representation of the virtual
function pointer
- SBValue::GetSummary() returns a symbolicated respresentation of the
virtual function pointer
- SBValue::GetType() returns the function prototype type if there is
debug info, or a generic funtion prototype if there is no debug info
- SBValue::GetLoadAddress() returns the address of the virtual function
pointer
- SBValue::GetValueAsUnsigned(...) returns the virtual function pointer
- SBValue::GetNumChildren() returns 0
- SBValue::GetChildAtIndex(...) returns invalid SBValue for any index
Examples of using this API via python:
```
(lldb) script vtable = lldb.frame.FindVariable("shape_ptr").GetVTable()
(lldb) script vtable
vtable for Shape = 0x0000000100004088 {
[0] = 0x0000000100003d20 a.out`Shape::~Shape() at main.cpp:3
[1] = 0x0000000100003e4c a.out`Shape::~Shape() at main.cpp:3
[2] = 0x0000000100003e7c a.out`Shape::area() at main.cpp:4
[3] = 0x0000000100003e3c a.out`Shape::optional() at main.cpp:7
}
(lldb) script c = vtable.GetChildAtIndex(0)
(lldb) script c
(void ()) [0] = 0x0000000100003d20 a.out`Shape::~Shape() at main.cpp:3
```
128 lines
4.4 KiB
C++
128 lines
4.4 KiB
C++
//===-- ItaniumABILanguageRuntime.h -----------------------------*- C++ -*-===//
|
|
//
|
|
// 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
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef LLDB_SOURCE_PLUGINS_LANGUAGERUNTIME_CPLUSPLUS_ITANIUMABI_ITANIUMABILANGUAGERUNTIME_H
|
|
#define LLDB_SOURCE_PLUGINS_LANGUAGERUNTIME_CPLUSPLUS_ITANIUMABI_ITANIUMABILANGUAGERUNTIME_H
|
|
|
|
#include <map>
|
|
#include <mutex>
|
|
#include <vector>
|
|
|
|
#include "lldb/Breakpoint/BreakpointResolver.h"
|
|
#include "lldb/Core/Value.h"
|
|
#include "lldb/Symbol/Type.h"
|
|
#include "lldb/Target/LanguageRuntime.h"
|
|
#include "lldb/lldb-private.h"
|
|
|
|
#include "Plugins/LanguageRuntime/CPlusPlus/CPPLanguageRuntime.h"
|
|
|
|
namespace lldb_private {
|
|
|
|
class ItaniumABILanguageRuntime : public lldb_private::CPPLanguageRuntime {
|
|
public:
|
|
~ItaniumABILanguageRuntime() override = default;
|
|
|
|
// Static Functions
|
|
static void Initialize();
|
|
|
|
static void Terminate();
|
|
|
|
static lldb_private::LanguageRuntime *
|
|
CreateInstance(Process *process, lldb::LanguageType language);
|
|
|
|
static llvm::StringRef GetPluginNameStatic() { return "itanium"; }
|
|
|
|
static char ID;
|
|
|
|
bool isA(const void *ClassID) const override {
|
|
return ClassID == &ID || CPPLanguageRuntime::isA(ClassID);
|
|
}
|
|
|
|
static bool classof(const LanguageRuntime *runtime) {
|
|
return runtime->isA(&ID);
|
|
}
|
|
|
|
|
|
llvm::Expected<LanguageRuntime::VTableInfo>
|
|
GetVTableInfo(ValueObject &in_value, bool check_type) override;
|
|
|
|
bool GetDynamicTypeAndAddress(ValueObject &in_value,
|
|
lldb::DynamicValueType use_dynamic,
|
|
TypeAndOrName &class_type_or_name,
|
|
Address &address,
|
|
Value::ValueType &value_type) override;
|
|
|
|
TypeAndOrName FixUpDynamicType(const TypeAndOrName &type_and_or_name,
|
|
ValueObject &static_value) override;
|
|
|
|
bool CouldHaveDynamicValue(ValueObject &in_value) override;
|
|
|
|
void SetExceptionBreakpoints() override;
|
|
|
|
void ClearExceptionBreakpoints() override;
|
|
|
|
bool ExceptionBreakpointsAreSet() override;
|
|
|
|
bool ExceptionBreakpointsExplainStop(lldb::StopInfoSP stop_reason) override;
|
|
|
|
lldb::BreakpointResolverSP
|
|
CreateExceptionResolver(const lldb::BreakpointSP &bkpt,
|
|
bool catch_bp, bool throw_bp) override;
|
|
|
|
lldb::SearchFilterSP CreateExceptionSearchFilter() override;
|
|
|
|
lldb::ValueObjectSP GetExceptionObjectForThread(
|
|
lldb::ThreadSP thread_sp) override;
|
|
|
|
// PluginInterface protocol
|
|
llvm::StringRef GetPluginName() override { return GetPluginNameStatic(); }
|
|
|
|
protected:
|
|
lldb::BreakpointResolverSP
|
|
CreateExceptionResolver(const lldb::BreakpointSP &bkpt,
|
|
bool catch_bp, bool throw_bp, bool for_expressions);
|
|
|
|
lldb::BreakpointSP CreateExceptionBreakpoint(bool catch_bp, bool throw_bp,
|
|
bool for_expressions,
|
|
bool is_internal);
|
|
|
|
private:
|
|
typedef std::map<lldb_private::Address, TypeAndOrName> DynamicTypeCache;
|
|
typedef std::map<lldb_private::Address, VTableInfo> VTableInfoCache;
|
|
|
|
ItaniumABILanguageRuntime(Process *process)
|
|
: // Call CreateInstance instead.
|
|
lldb_private::CPPLanguageRuntime(process) {}
|
|
|
|
lldb::BreakpointSP m_cxx_exception_bp_sp;
|
|
DynamicTypeCache m_dynamic_type_map;
|
|
VTableInfoCache m_vtable_info_map;
|
|
std::mutex m_mutex;
|
|
|
|
TypeAndOrName GetTypeInfo(ValueObject &in_value,
|
|
const VTableInfo &vtable_info);
|
|
|
|
TypeAndOrName GetDynamicTypeInfo(const lldb_private::Address &vtable_addr);
|
|
|
|
void SetDynamicTypeInfo(const lldb_private::Address &vtable_addr,
|
|
const TypeAndOrName &type_info);
|
|
|
|
// Check if a compiler type has a vtable.
|
|
//
|
|
// If the compiler type is a pointer or a reference, this function will check
|
|
// if the pointee type has a vtable, else it will check the type passed in.
|
|
//
|
|
// Returns an error if the type of the value doesn't have a vtable with an
|
|
// explanation why, or returns an Error::success() if the type has a vtable.
|
|
llvm::Error TypeHasVTable(CompilerType compiler_type);
|
|
};
|
|
|
|
} // namespace lldb_private
|
|
|
|
#endif // LLDB_SOURCE_PLUGINS_LANGUAGERUNTIME_CPLUSPLUS_ITANIUMABI_ITANIUMABILANGUAGERUNTIME_H
|