1 //===-- LibCxx.cpp ----------------------------------------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 #include "lldb/lldb-python.h"
12 #include "lldb/DataFormatters/CXXFormatterFunctions.h"
14 #include "lldb/Core/DataBufferHeap.h"
15 #include "lldb/Core/Debugger.h"
16 #include "lldb/Core/Error.h"
17 #include "lldb/Core/Stream.h"
18 #include "lldb/Core/ValueObject.h"
19 #include "lldb/Core/ValueObjectConstResult.h"
20 #include "lldb/Host/Endian.h"
21 #include "lldb/Symbol/ClangASTContext.h"
22 #include "lldb/Target/ObjCLanguageRuntime.h"
23 #include "lldb/Target/Target.h"
26 using namespace lldb_private;
27 using namespace lldb_private::formatters;
30 lldb_private::formatters::LibcxxSmartPointerSummaryProvider (ValueObject& valobj, Stream& stream)
32 ValueObjectSP valobj_sp(valobj.GetNonSyntheticValue());
35 ValueObjectSP ptr_sp(valobj_sp->GetChildMemberWithName(ConstString("__ptr_"), true));
36 ValueObjectSP count_sp(valobj_sp->GetChildAtNamePath( {ConstString("__cntrl_"),ConstString("__shared_owners_")} ));
37 ValueObjectSP weakcount_sp(valobj_sp->GetChildAtNamePath( {ConstString("__cntrl_"),ConstString("__shared_weak_owners_")} ));
42 if (ptr_sp->GetValueAsUnsigned(0) == 0)
44 stream.Printf("nullptr");
49 bool print_pointee = false;
51 ValueObjectSP pointee_sp = ptr_sp->Dereference(error);
52 if (pointee_sp && error.Success())
54 if (pointee_sp->DumpPrintableRepresentation(stream,
55 ValueObject::eValueObjectRepresentationStyleSummary,
57 ValueObject::ePrintableRepresentationSpecialCasesDisable,
62 stream.Printf("ptr = 0x%" PRIx64, ptr_sp->GetValueAsUnsigned(0));
66 stream.Printf(" strong=%" PRIu64, 1+count_sp->GetValueAsUnsigned(0));
69 stream.Printf(" weak=%" PRIu64, 1+weakcount_sp->GetValueAsUnsigned(0));
74 lldb_private::formatters::LibcxxVectorBoolSyntheticFrontEnd::LibcxxVectorBoolSyntheticFrontEnd (lldb::ValueObjectSP valobj_sp) :
75 SyntheticChildrenFrontEnd(*valobj_sp.get()),
79 m_base_data_address(0),
85 m_bool_type = valobj_sp->GetClangType().GetBasicTypeFromAST(lldb::eBasicTypeBool);
90 lldb_private::formatters::LibcxxVectorBoolSyntheticFrontEnd::CalculateNumChildren ()
96 lldb_private::formatters::LibcxxVectorBoolSyntheticFrontEnd::GetChildAtIndex (size_t idx)
98 auto iter = m_children.find(idx),
99 end = m_children.end();
103 return ValueObjectSP();
104 if (m_base_data_address == 0 || m_count == 0)
105 return ValueObjectSP();
107 return ValueObjectSP();
108 size_t byte_idx = (idx >> 3); // divide by 8 to get byte index
109 size_t bit_index = (idx & 7); // efficient idx % 8 for bit index
110 lldb::addr_t byte_location = m_base_data_address + byte_idx;
111 ProcessSP process_sp(m_exe_ctx_ref.GetProcessSP());
113 return ValueObjectSP();
117 size_t bytes_read = process_sp->ReadMemory(byte_location, &byte, 1, err);
118 if (err.Fail() || bytes_read == 0)
119 return ValueObjectSP();
139 return ValueObjectSP();
141 bool bit_set = ((byte & mask) != 0);
142 ValueObjectSP retval_sp;
143 DataBufferSP buffer_sp(new DataBufferHeap(m_bool_type.GetByteSize(),0));
144 if (bit_set && buffer_sp && buffer_sp->GetBytes())
145 *(buffer_sp->GetBytes()) = 1; // regardless of endianness, anything non-zero is true
146 StreamString name; name.Printf("[%zu]",idx);
147 DataExtractor data(buffer_sp, process_sp->GetByteOrder(), process_sp->GetAddressByteSize());
148 retval_sp = ValueObject::CreateValueObjectFromData(name.GetData(), data, m_exe_ctx_ref, m_bool_type);
150 m_children[idx] = retval_sp;
154 /*(std::__1::vector<std::__1::allocator<bool> >) vBool = {
155 __begin_ = 0x00000001001000e0
158 std::__1::__libcpp_compressed_pair_imp<unsigned long, std::__1::allocator<unsigned long> > = {
165 lldb_private::formatters::LibcxxVectorBoolSyntheticFrontEnd::Update()
168 ValueObjectSP valobj_sp = m_backend.GetSP();
173 m_exe_ctx_ref = valobj_sp->GetExecutionContextRef();
174 ValueObjectSP size_sp(valobj_sp->GetChildMemberWithName(ConstString("__size_"), true));
177 m_count = size_sp->GetValueAsUnsigned(0);
180 ValueObjectSP begin_sp(valobj_sp->GetChildMemberWithName(ConstString("__begin_"), true));
186 m_base_data_address = begin_sp->GetValueAsUnsigned(0);
187 if (!m_base_data_address)
196 lldb_private::formatters::LibcxxVectorBoolSyntheticFrontEnd::MightHaveChildren ()
202 lldb_private::formatters::LibcxxVectorBoolSyntheticFrontEnd::GetIndexOfChildWithName (const ConstString &name)
204 if (!m_count || !m_base_data_address)
206 const char* item_name = name.GetCString();
207 uint32_t idx = ExtractIndexFromString(item_name);
208 if (idx < UINT32_MAX && idx >= CalculateNumChildren())
213 lldb_private::formatters::LibcxxVectorBoolSyntheticFrontEnd::~LibcxxVectorBoolSyntheticFrontEnd ()
216 SyntheticChildrenFrontEnd*
217 lldb_private::formatters::LibcxxVectorBoolSyntheticFrontEndCreator (CXXSyntheticChildren*, lldb::ValueObjectSP valobj_sp)
221 return (new LibcxxVectorBoolSyntheticFrontEnd(valobj_sp));
225 (lldb) fr var ibeg --raw --ptr-depth 1
226 (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 = {
228 __ptr_ = 0x0000000100103870 {
229 std::__1::__tree_node_base<void *> = {
230 std::__1::__tree_end_node<std::__1::__tree_node_base<void *> *> = {
231 __left_ = 0x0000000000000000
233 __right_ = 0x0000000000000000
234 __parent_ = 0x00000001001038b0
239 second = { std::string }
242 lldb_private::formatters::LibCxxMapIteratorSyntheticFrontEnd::LibCxxMapIteratorSyntheticFrontEnd (lldb::ValueObjectSP valobj_sp) :
243 SyntheticChildrenFrontEnd(*valobj_sp.get()),
251 lldb_private::formatters::LibCxxMapIteratorSyntheticFrontEnd::Update()
253 ValueObjectSP valobj_sp = m_backend.GetSP();
257 TargetSP target_sp(valobj_sp->GetTargetSP());
265 // this must be a ValueObject* because it is a child of the ValueObject we are producing children for
266 // it if were a ValueObjectSP, we would end up with a loop (iterator -> synthetic -> child -> parent == iterator)
267 // and that would in turn leak memory by never allowing the ValueObjects to die and free their memory
268 m_pair_ptr = valobj_sp->GetValueForExpressionPath(".__i_.__ptr_->__value_",
272 ValueObject::GetValueForExpressionPathOptions().DontCheckDotVsArrowSyntax().DontAllowSyntheticChildren(),
279 lldb_private::formatters::LibCxxMapIteratorSyntheticFrontEnd::CalculateNumChildren ()
285 lldb_private::formatters::LibCxxMapIteratorSyntheticFrontEnd::GetChildAtIndex (size_t idx)
288 return lldb::ValueObjectSP();
289 return m_pair_ptr->GetChildAtIndex(idx, true);
293 lldb_private::formatters::LibCxxMapIteratorSyntheticFrontEnd::MightHaveChildren ()
299 lldb_private::formatters::LibCxxMapIteratorSyntheticFrontEnd::GetIndexOfChildWithName (const ConstString &name)
301 if (name == ConstString("first"))
303 if (name == ConstString("second"))
308 lldb_private::formatters::LibCxxMapIteratorSyntheticFrontEnd::~LibCxxMapIteratorSyntheticFrontEnd ()
310 // this will be deleted when its parent dies (since it's a child object)
314 SyntheticChildrenFrontEnd*
315 lldb_private::formatters::LibCxxMapIteratorSyntheticFrontEndCreator (CXXSyntheticChildren*, lldb::ValueObjectSP valobj_sp)
319 return (new LibCxxMapIteratorSyntheticFrontEnd(valobj_sp));
323 (lldb) fr var ibeg --raw --ptr-depth 1 -T
324 (std::__1::__wrap_iter<int *>) ibeg = {
325 (std::__1::__wrap_iter<int *>::iterator_type) __i = 0x00000001001037a0 {
331 SyntheticChildrenFrontEnd*
332 lldb_private::formatters::LibCxxVectorIteratorSyntheticFrontEndCreator (CXXSyntheticChildren*, lldb::ValueObjectSP valobj_sp)
334 static ConstString g_item_name;
336 g_item_name.SetCString("__i");
339 return (new VectorIteratorSyntheticFrontEnd(valobj_sp,g_item_name));
342 lldb_private::formatters::LibcxxSharedPtrSyntheticFrontEnd::LibcxxSharedPtrSyntheticFrontEnd (lldb::ValueObjectSP valobj_sp) :
343 SyntheticChildrenFrontEnd(*valobj_sp.get()),
348 m_byte_order(lldb::eByteOrderInvalid)
355 lldb_private::formatters::LibcxxSharedPtrSyntheticFrontEnd::CalculateNumChildren ()
357 return (m_cntrl ? 1 : 0);
361 lldb_private::formatters::LibcxxSharedPtrSyntheticFrontEnd::GetChildAtIndex (size_t idx)
364 return lldb::ValueObjectSP();
366 ValueObjectSP valobj_sp = m_backend.GetSP();
368 return lldb::ValueObjectSP();
371 return valobj_sp->GetChildMemberWithName(ConstString("__ptr_"), true);
374 return lldb::ValueObjectSP();
380 ValueObjectSP shared_owners_sp(m_cntrl->GetChildMemberWithName(ConstString("__shared_owners_"),true));
381 if (!shared_owners_sp)
382 return lldb::ValueObjectSP();
383 uint64_t count = 1 + shared_owners_sp->GetValueAsUnsigned(0);
384 DataExtractor data(&count, 8, m_byte_order, m_ptr_size);
385 m_count_sp = ValueObject::CreateValueObjectFromData("count", data, valobj_sp->GetExecutionContextRef(), shared_owners_sp->GetClangType());
389 else /* if (idx == 2) */
391 if (!m_weak_count_sp)
393 ValueObjectSP shared_weak_owners_sp(m_cntrl->GetChildMemberWithName(ConstString("__shared_weak_owners_"),true));
394 if (!shared_weak_owners_sp)
395 return lldb::ValueObjectSP();
396 uint64_t count = 1 + shared_weak_owners_sp->GetValueAsUnsigned(0);
397 DataExtractor data(&count, 8, m_byte_order, m_ptr_size);
398 m_weak_count_sp = ValueObject::CreateValueObjectFromData("count", data, valobj_sp->GetExecutionContextRef(), shared_weak_owners_sp->GetClangType());
400 return m_weak_count_sp;
405 lldb_private::formatters::LibcxxSharedPtrSyntheticFrontEnd::Update()
408 m_weak_count_sp.reset();
411 ValueObjectSP valobj_sp = m_backend.GetSP();
415 TargetSP target_sp(valobj_sp->GetTargetSP());
419 m_byte_order = target_sp->GetArchitecture().GetByteOrder();
420 m_ptr_size = target_sp->GetArchitecture().GetAddressByteSize();
422 lldb::ValueObjectSP cntrl_sp(valobj_sp->GetChildMemberWithName(ConstString("__cntrl_"),true));
424 m_cntrl = cntrl_sp.get(); // need to store the raw pointer to avoid a circular dependency
429 lldb_private::formatters::LibcxxSharedPtrSyntheticFrontEnd::MightHaveChildren ()
435 lldb_private::formatters::LibcxxSharedPtrSyntheticFrontEnd::GetIndexOfChildWithName (const ConstString &name)
437 if (name == ConstString("__ptr_"))
439 if (name == ConstString("count"))
441 if (name == ConstString("weak_count"))
446 lldb_private::formatters::LibcxxSharedPtrSyntheticFrontEnd::~LibcxxSharedPtrSyntheticFrontEnd ()
449 SyntheticChildrenFrontEnd*
450 lldb_private::formatters::LibcxxSharedPtrSyntheticFrontEndCreator (CXXSyntheticChildren*, lldb::ValueObjectSP valobj_sp)
454 return (new LibcxxSharedPtrSyntheticFrontEnd(valobj_sp));
457 lldb_private::formatters::LibcxxStdVectorSyntheticFrontEnd::LibcxxStdVectorSyntheticFrontEnd (lldb::ValueObjectSP valobj_sp) :
458 SyntheticChildrenFrontEnd(*valobj_sp.get()),
470 lldb_private::formatters::LibcxxStdVectorSyntheticFrontEnd::CalculateNumChildren ()
472 if (!m_start || !m_finish)
474 uint64_t start_val = m_start->GetValueAsUnsigned(0);
475 uint64_t finish_val = m_finish->GetValueAsUnsigned(0);
477 if (start_val == 0 || finish_val == 0)
480 if (start_val >= finish_val)
483 size_t num_children = (finish_val - start_val);
484 if (num_children % m_element_size)
486 return num_children/m_element_size;
490 lldb_private::formatters::LibcxxStdVectorSyntheticFrontEnd::GetChildAtIndex (size_t idx)
492 if (!m_start || !m_finish)
493 return lldb::ValueObjectSP();
495 auto cached = m_children.find(idx);
496 if (cached != m_children.end())
497 return cached->second;
499 uint64_t offset = idx * m_element_size;
500 offset = offset + m_start->GetValueAsUnsigned(0);
502 name.Printf("[%zu]",idx);
503 ValueObjectSP child_sp = ValueObject::CreateValueObjectFromAddress(name.GetData(), offset, m_backend.GetExecutionContextRef(), m_element_type);
504 m_children[idx] = child_sp;
509 lldb_private::formatters::LibcxxStdVectorSyntheticFrontEnd::Update()
511 m_start = m_finish = NULL;
513 ValueObjectSP data_type_finder_sp(m_backend.GetChildMemberWithName(ConstString("__end_cap_"),true));
514 if (!data_type_finder_sp)
516 data_type_finder_sp = data_type_finder_sp->GetChildMemberWithName(ConstString("__first_"),true);
517 if (!data_type_finder_sp)
519 m_element_type = data_type_finder_sp->GetClangType().GetPointeeType();
520 m_element_size = m_element_type.GetByteSize();
522 if (m_element_size > 0)
524 // store raw pointers or end up with a circular dependency
525 m_start = m_backend.GetChildMemberWithName(ConstString("__begin_"),true).get();
526 m_finish = m_backend.GetChildMemberWithName(ConstString("__end_"),true).get();
532 lldb_private::formatters::LibcxxStdVectorSyntheticFrontEnd::MightHaveChildren ()
538 lldb_private::formatters::LibcxxStdVectorSyntheticFrontEnd::GetIndexOfChildWithName (const ConstString &name)
540 if (!m_start || !m_finish)
542 return ExtractIndexFromString(name.GetCString());
545 lldb_private::formatters::LibcxxStdVectorSyntheticFrontEnd::~LibcxxStdVectorSyntheticFrontEnd ()
547 // these need to stay around because they are child objects who will follow their parent's life cycle
552 SyntheticChildrenFrontEnd*
553 lldb_private::formatters::LibcxxStdVectorSyntheticFrontEndCreator (CXXSyntheticChildren*, lldb::ValueObjectSP valobj_sp)
557 return (new LibcxxStdVectorSyntheticFrontEnd(valobj_sp));
561 lldb_private::formatters::LibcxxContainerSummaryProvider (ValueObject& valobj, Stream& stream)
563 if (valobj.IsPointerType())
565 uint64_t value = valobj.GetValueAsUnsigned(0);
568 stream.Printf("0x%016" PRIx64 " ", value);
570 return Debugger::FormatPrompt("size=${svar%#}", NULL, NULL, NULL, stream, &valobj);