mirror of
https://github.com/intel/llvm.git
synced 2026-01-15 12:25:46 +08:00
554f68d385
Why? Debugger::FormatPrompt() would run through the format prompt every time and parse it and emit it piece by piece. It also did formatting differently depending on which key/value pair it was parsing.
The new code improves on this with the following features:
1 - Allow format strings to be parsed into a FormatEntity::Entry which can contain multiple child FormatEntity::Entry objects. This FormatEntity::Entry is a parsed version of what was previously always done in Debugger::FormatPrompt() so it is more efficient to emit formatted strings using the new parsed FormatEntity::Entry.
2 - Allows errors in format strings to be shown immediately when setting the settings (frame-format, thread-format, disassembly-format
3 - Allows auto completion by implementing a new OptionValueFormatEntity and switching frame-format, thread-format, and disassembly-format settings over to using it.
4 - The FormatEntity::Entry for each of the frame-format, thread-format, disassembly-format settings only replaces the old one if the format parses correctly
5 - Combines all consecutive string values together for efficient output. This means all "${ansi.*}" keys and all desensitized characters like "\n" "\t" "\0721" "\x23" will get combined with their previous strings
6 - ${*.script:} (like "${var.script:mymodule.my_var_function}") have all been switched over to use ${script.*:} "${script.var:mymodule.my_var_function}") to make the format easier to parse as I don't believe anyone was using these format string power user features.
7 - All key values pairs are defined in simple C arrays of entries so it is much easier to add new entries.
These changes pave the way for subsequent modifications where we can modify formats to do more (like control the width of value strings can do more and add more functionality more easily like string formatting to control the width, printf formats and more).
llvm-svn: 228207
466 lines
15 KiB
C++
466 lines
15 KiB
C++
//===-- LibCxx.cpp ----------------------------------------------*- C++ -*-===//
|
|
//
|
|
// The LLVM Compiler Infrastructure
|
|
//
|
|
// This file is distributed under the University of Illinois Open Source
|
|
// License. See LICENSE.TXT for details.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#include "lldb/lldb-python.h"
|
|
|
|
#include "lldb/DataFormatters/CXXFormatterFunctions.h"
|
|
|
|
#include "lldb/Core/DataBufferHeap.h"
|
|
#include "lldb/Core/Debugger.h"
|
|
#include "lldb/Core/Error.h"
|
|
#include "lldb/Core/FormatEntity.h"
|
|
#include "lldb/Core/Stream.h"
|
|
#include "lldb/Core/ValueObject.h"
|
|
#include "lldb/Core/ValueObjectConstResult.h"
|
|
#include "lldb/Host/Endian.h"
|
|
#include "lldb/Symbol/ClangASTContext.h"
|
|
#include "lldb/Target/ObjCLanguageRuntime.h"
|
|
#include "lldb/Target/Target.h"
|
|
|
|
using namespace lldb;
|
|
using namespace lldb_private;
|
|
using namespace lldb_private::formatters;
|
|
|
|
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;
|
|
Error error;
|
|
ValueObjectSP pointee_sp = ptr_sp->Dereference(error);
|
|
if (pointee_sp && error.Success())
|
|
{
|
|
if (pointee_sp->DumpPrintableRepresentation(stream,
|
|
ValueObject::eValueObjectRepresentationStyleSummary,
|
|
lldb::eFormatInvalid,
|
|
ValueObject::ePrintableRepresentationSpecialCasesDisable,
|
|
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;
|
|
}
|
|
|
|
lldb_private::formatters::LibcxxVectorBoolSyntheticFrontEnd::LibcxxVectorBoolSyntheticFrontEnd (lldb::ValueObjectSP valobj_sp) :
|
|
SyntheticChildrenFrontEnd(*valobj_sp.get()),
|
|
m_bool_type(),
|
|
m_exe_ctx_ref(),
|
|
m_count(0),
|
|
m_base_data_address(0),
|
|
m_children()
|
|
{
|
|
if (valobj_sp)
|
|
{
|
|
Update();
|
|
m_bool_type = valobj_sp->GetClangType().GetBasicTypeFromAST(lldb::eBasicTypeBool);
|
|
}
|
|
}
|
|
|
|
size_t
|
|
lldb_private::formatters::LibcxxVectorBoolSyntheticFrontEnd::CalculateNumChildren ()
|
|
{
|
|
return m_count;
|
|
}
|
|
|
|
lldb::ValueObjectSP
|
|
lldb_private::formatters::LibcxxVectorBoolSyntheticFrontEnd::GetChildAtIndex (size_t idx)
|
|
{
|
|
auto iter = m_children.find(idx),
|
|
end = m_children.end();
|
|
if (iter != end)
|
|
return iter->second;
|
|
if (idx >= m_count)
|
|
return ValueObjectSP();
|
|
if (m_base_data_address == 0 || m_count == 0)
|
|
return ValueObjectSP();
|
|
if (!m_bool_type)
|
|
return ValueObjectSP();
|
|
size_t byte_idx = (idx >> 3); // divide by 8 to get byte index
|
|
size_t bit_index = (idx & 7); // efficient idx % 8 for bit index
|
|
lldb::addr_t byte_location = m_base_data_address + byte_idx;
|
|
ProcessSP process_sp(m_exe_ctx_ref.GetProcessSP());
|
|
if (!process_sp)
|
|
return ValueObjectSP();
|
|
uint8_t byte = 0;
|
|
uint8_t mask = 0;
|
|
Error err;
|
|
size_t bytes_read = process_sp->ReadMemory(byte_location, &byte, 1, err);
|
|
if (err.Fail() || bytes_read == 0)
|
|
return ValueObjectSP();
|
|
switch (bit_index)
|
|
{
|
|
case 0:
|
|
mask = 1; break;
|
|
case 1:
|
|
mask = 2; break;
|
|
case 2:
|
|
mask = 4; break;
|
|
case 3:
|
|
mask = 8; break;
|
|
case 4:
|
|
mask = 16; break;
|
|
case 5:
|
|
mask = 32; break;
|
|
case 6:
|
|
mask = 64; break;
|
|
case 7:
|
|
mask = 128; break;
|
|
default:
|
|
return ValueObjectSP();
|
|
}
|
|
bool bit_set = ((byte & mask) != 0);
|
|
DataBufferSP buffer_sp(new DataBufferHeap(m_bool_type.GetByteSize(nullptr),0));
|
|
if (bit_set && buffer_sp && buffer_sp->GetBytes())
|
|
*(buffer_sp->GetBytes()) = 1; // regardless of endianness, anything non-zero is true
|
|
StreamString name; name.Printf("[%" PRIu64 "]", (uint64_t)idx);
|
|
ValueObjectSP retval_sp(CreateValueObjectFromData(name.GetData(), DataExtractor(buffer_sp, process_sp->GetByteOrder(), process_sp->GetAddressByteSize()), m_exe_ctx_ref, m_bool_type));
|
|
if (retval_sp)
|
|
m_children[idx] = retval_sp;
|
|
return retval_sp;
|
|
}
|
|
|
|
/*(std::__1::vector<std::__1::allocator<bool> >) vBool = {
|
|
__begin_ = 0x00000001001000e0
|
|
__size_ = 56
|
|
__cap_alloc_ = {
|
|
std::__1::__libcpp_compressed_pair_imp<unsigned long, std::__1::allocator<unsigned long> > = {
|
|
__first_ = 1
|
|
}
|
|
}
|
|
}*/
|
|
|
|
bool
|
|
lldb_private::formatters::LibcxxVectorBoolSyntheticFrontEnd::Update()
|
|
{
|
|
m_children.clear();
|
|
ValueObjectSP valobj_sp = m_backend.GetSP();
|
|
if (!valobj_sp)
|
|
return false;
|
|
m_exe_ctx_ref = valobj_sp->GetExecutionContextRef();
|
|
ValueObjectSP size_sp(valobj_sp->GetChildMemberWithName(ConstString("__size_"), true));
|
|
if (!size_sp)
|
|
return false;
|
|
m_count = size_sp->GetValueAsUnsigned(0);
|
|
if (!m_count)
|
|
return true;
|
|
ValueObjectSP begin_sp(valobj_sp->GetChildMemberWithName(ConstString("__begin_"), true));
|
|
if (!begin_sp)
|
|
{
|
|
m_count = 0;
|
|
return false;
|
|
}
|
|
m_base_data_address = begin_sp->GetValueAsUnsigned(0);
|
|
if (!m_base_data_address)
|
|
{
|
|
m_count = 0;
|
|
return false;
|
|
}
|
|
return false;
|
|
}
|
|
|
|
bool
|
|
lldb_private::formatters::LibcxxVectorBoolSyntheticFrontEnd::MightHaveChildren ()
|
|
{
|
|
return true;
|
|
}
|
|
|
|
size_t
|
|
lldb_private::formatters::LibcxxVectorBoolSyntheticFrontEnd::GetIndexOfChildWithName (const ConstString &name)
|
|
{
|
|
if (!m_count || !m_base_data_address)
|
|
return UINT32_MAX;
|
|
const char* item_name = name.GetCString();
|
|
uint32_t idx = ExtractIndexFromString(item_name);
|
|
if (idx < UINT32_MAX && idx >= CalculateNumChildren())
|
|
return UINT32_MAX;
|
|
return idx;
|
|
}
|
|
|
|
lldb_private::formatters::LibcxxVectorBoolSyntheticFrontEnd::~LibcxxVectorBoolSyntheticFrontEnd ()
|
|
{}
|
|
|
|
SyntheticChildrenFrontEnd*
|
|
lldb_private::formatters::LibcxxVectorBoolSyntheticFrontEndCreator (CXXSyntheticChildren*, lldb::ValueObjectSP valobj_sp)
|
|
{
|
|
if (!valobj_sp)
|
|
return NULL;
|
|
return (new LibcxxVectorBoolSyntheticFrontEnd(valobj_sp));
|
|
}
|
|
|
|
/*
|
|
(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.get()),
|
|
m_pair_ptr()
|
|
{
|
|
if (valobj_sp)
|
|
Update();
|
|
}
|
|
|
|
bool
|
|
lldb_private::formatters::LibCxxMapIteratorSyntheticFrontEnd::Update()
|
|
{
|
|
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;
|
|
|
|
// 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_",
|
|
NULL,
|
|
NULL,
|
|
NULL,
|
|
ValueObject::GetValueForExpressionPathOptions().DontCheckDotVsArrowSyntax().DontAllowSyntheticChildren(),
|
|
NULL).get();
|
|
|
|
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 lldb::ValueObjectSP();
|
|
return m_pair_ptr->GetChildAtIndex(idx, true);
|
|
}
|
|
|
|
bool
|
|
lldb_private::formatters::LibCxxMapIteratorSyntheticFrontEnd::MightHaveChildren ()
|
|
{
|
|
return true;
|
|
}
|
|
|
|
size_t
|
|
lldb_private::formatters::LibCxxMapIteratorSyntheticFrontEnd::GetIndexOfChildWithName (const ConstString &name)
|
|
{
|
|
if (name == ConstString("first"))
|
|
return 0;
|
|
if (name == ConstString("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)
|
|
{
|
|
if (!valobj_sp)
|
|
return NULL;
|
|
return (new LibCxxMapIteratorSyntheticFrontEnd(valobj_sp));
|
|
}
|
|
|
|
/*
|
|
(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)
|
|
{
|
|
static ConstString g_item_name;
|
|
if (!g_item_name)
|
|
g_item_name.SetCString("__i");
|
|
if (!valobj_sp)
|
|
return NULL;
|
|
return (new VectorIteratorSyntheticFrontEnd(valobj_sp,g_item_name));
|
|
}
|
|
|
|
lldb_private::formatters::LibcxxSharedPtrSyntheticFrontEnd::LibcxxSharedPtrSyntheticFrontEnd (lldb::ValueObjectSP valobj_sp) :
|
|
SyntheticChildrenFrontEnd(*valobj_sp.get()),
|
|
m_cntrl(NULL),
|
|
m_count_sp(),
|
|
m_weak_count_sp(),
|
|
m_ptr_size(0),
|
|
m_byte_order(lldb::eByteOrderInvalid)
|
|
{
|
|
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 > 2)
|
|
return lldb::ValueObjectSP();
|
|
|
|
if (idx == 1)
|
|
{
|
|
if (!m_count_sp)
|
|
{
|
|
ValueObjectSP shared_owners_sp(m_cntrl->GetChildMemberWithName(ConstString("__shared_owners_"),true));
|
|
if (!shared_owners_sp)
|
|
return lldb::ValueObjectSP();
|
|
uint64_t count = 1 + shared_owners_sp->GetValueAsUnsigned(0);
|
|
DataExtractor data(&count, 8, m_byte_order, m_ptr_size);
|
|
m_count_sp = CreateValueObjectFromData("count", data, valobj_sp->GetExecutionContextRef(), shared_owners_sp->GetClangType());
|
|
}
|
|
return m_count_sp;
|
|
}
|
|
else /* if (idx == 2) */
|
|
{
|
|
if (!m_weak_count_sp)
|
|
{
|
|
ValueObjectSP shared_weak_owners_sp(m_cntrl->GetChildMemberWithName(ConstString("__shared_weak_owners_"),true));
|
|
if (!shared_weak_owners_sp)
|
|
return lldb::ValueObjectSP();
|
|
uint64_t count = 1 + shared_weak_owners_sp->GetValueAsUnsigned(0);
|
|
DataExtractor data(&count, 8, m_byte_order, m_ptr_size);
|
|
m_weak_count_sp = CreateValueObjectFromData("count", data, valobj_sp->GetExecutionContextRef(), shared_weak_owners_sp->GetClangType());
|
|
}
|
|
return m_weak_count_sp;
|
|
}
|
|
}
|
|
|
|
bool
|
|
lldb_private::formatters::LibcxxSharedPtrSyntheticFrontEnd::Update()
|
|
{
|
|
m_count_sp.reset();
|
|
m_weak_count_sp.reset();
|
|
m_cntrl = NULL;
|
|
|
|
ValueObjectSP valobj_sp = m_backend.GetSP();
|
|
if (!valobj_sp)
|
|
return false;
|
|
|
|
TargetSP target_sp(valobj_sp->GetTargetSP());
|
|
if (!target_sp)
|
|
return false;
|
|
|
|
m_byte_order = target_sp->GetArchitecture().GetByteOrder();
|
|
m_ptr_size = target_sp->GetArchitecture().GetAddressByteSize();
|
|
|
|
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 (const ConstString &name)
|
|
{
|
|
if (name == ConstString("__ptr_"))
|
|
return 0;
|
|
if (name == ConstString("count"))
|
|
return 1;
|
|
if (name == ConstString("weak_count"))
|
|
return 2;
|
|
return UINT32_MAX;
|
|
}
|
|
|
|
lldb_private::formatters::LibcxxSharedPtrSyntheticFrontEnd::~LibcxxSharedPtrSyntheticFrontEnd ()
|
|
{}
|
|
|
|
SyntheticChildrenFrontEnd*
|
|
lldb_private::formatters::LibcxxSharedPtrSyntheticFrontEndCreator (CXXSyntheticChildren*, lldb::ValueObjectSP valobj_sp)
|
|
{
|
|
if (!valobj_sp)
|
|
return NULL;
|
|
return (new LibcxxSharedPtrSyntheticFrontEnd(valobj_sp));
|
|
}
|
|
|
|
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, NULL, NULL, NULL, &valobj, false, false);
|
|
}
|