1 //===-- NSDictionary.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/Error.h"
16 #include "lldb/Core/Stream.h"
17 #include "lldb/Core/ValueObject.h"
18 #include "lldb/Core/ValueObjectConstResult.h"
19 #include "lldb/Host/Endian.h"
20 #include "lldb/Symbol/ClangASTContext.h"
21 #include "lldb/Target/ObjCLanguageRuntime.h"
22 #include "lldb/Target/Target.h"
24 #include "clang/AST/DeclCXX.h"
27 using namespace lldb_private;
28 using namespace lldb_private::formatters;
31 GetLLDBNSPairType (TargetSP target_sp)
33 ClangASTType clang_type;
35 ClangASTContext *target_ast_context = target_sp->GetScratchClangASTContext();
37 if (target_ast_context)
39 clang::ASTContext *ast = target_ast_context->getASTContext();
43 const char* type_name = "__lldb_autogen_nspair";
45 clang::IdentifierInfo &myIdent = ast->Idents.get(type_name);
46 clang::DeclarationName myName = ast->DeclarationNames.getIdentifier(&myIdent);
48 clang::DeclContext::lookup_const_result result = ast->getTranslationUnitDecl()->lookup(myName);
50 for (clang::NamedDecl *named_decl : result)
52 if (const clang::CXXRecordDecl *record_decl = llvm::dyn_cast<clang::CXXRecordDecl>(named_decl))
54 clang_type.SetClangType(ast, clang::QualType(record_decl->getTypeForDecl(), 0));
59 // somebody else (the user?) has defined a type with the magic name already - fail!!!
66 clang_type = target_ast_context->CreateRecordType(NULL, lldb::eAccessPublic, type_name, clang::TTK_Struct, lldb::eLanguageTypeC);
70 clang_type.StartTagDeclarationDefinition();
71 ClangASTType id_clang_type = target_ast_context->GetBasicType (eBasicTypeObjCID);
72 clang_type.AddFieldToRecordType("key", id_clang_type, lldb::eAccessPublic, 0);
73 clang_type.AddFieldToRecordType("value", id_clang_type, lldb::eAccessPublic, 0);
74 clang_type.CompleteTagDeclarationDefinition();
82 template<bool name_entries>
84 lldb_private::formatters::NSDictionarySummaryProvider (ValueObject& valobj, Stream& stream)
86 ProcessSP process_sp = valobj.GetProcessSP();
90 ObjCLanguageRuntime* runtime = (ObjCLanguageRuntime*)process_sp->GetLanguageRuntime(lldb::eLanguageTypeObjC);
95 ObjCLanguageRuntime::ClassDescriptorSP descriptor(runtime->GetClassDescriptor(valobj));
97 if (!descriptor.get() || !descriptor->IsValid())
100 uint32_t ptr_size = process_sp->GetAddressByteSize();
101 bool is_64bit = (ptr_size == 8);
103 lldb::addr_t valobj_addr = valobj.GetValueAsUnsigned(0);
110 const char* class_name = descriptor->GetClassName().GetCString();
112 if (!class_name || !*class_name)
115 if (!strcmp(class_name,"__NSDictionaryI"))
118 value = process_sp->ReadUnsignedIntegerFromMemory(valobj_addr + ptr_size, ptr_size, 0, error);
121 value &= (is_64bit ? ~0xFC00000000000000UL : ~0xFC000000U);
123 else if (!strcmp(class_name,"__NSDictionaryM"))
126 value = process_sp->ReadUnsignedIntegerFromMemory(valobj_addr + ptr_size, ptr_size, 0, error);
129 value &= (is_64bit ? ~0xFC00000000000000UL : ~0xFC000000U);
131 /*else if (!strcmp(class_name,"__NSCFDictionary"))
134 value = process_sp->ReadUnsignedIntegerFromMemory(valobj_addr + (is_64bit ? 20 : 12), 4, 0, error);
138 value &= ~0x0f1f000000000000UL;
142 if (!ExtractValueFromObjCExpression(valobj, "int", "count", value))
146 stream.Printf("%s%" PRIu64 " %s%s",
147 (name_entries ? "@\"" : ""),
149 (name_entries ? (value == 1 ? "entry" : "entries") : (value == 1 ? "key/value pair" : "key/value pairs")),
150 (name_entries ? "\"" : ""));
154 SyntheticChildrenFrontEnd* lldb_private::formatters::NSDictionarySyntheticFrontEndCreator (CXXSyntheticChildren*, lldb::ValueObjectSP valobj_sp)
157 lldb::ProcessSP process_sp (valobj_sp->GetProcessSP());
160 ObjCLanguageRuntime *runtime = (ObjCLanguageRuntime*)process_sp->GetLanguageRuntime(lldb::eLanguageTypeObjC);
164 if (!valobj_sp->IsPointerType())
167 valobj_sp = valobj_sp->AddressOf(error);
168 if (error.Fail() || !valobj_sp)
172 ObjCLanguageRuntime::ClassDescriptorSP descriptor(runtime->GetClassDescriptor(*valobj_sp.get()));
174 if (!descriptor.get() || !descriptor->IsValid())
177 const char* class_name = descriptor->GetClassName().GetCString();
179 if (!class_name || !*class_name)
182 if (!strcmp(class_name,"__NSDictionaryI"))
184 return (new NSDictionaryISyntheticFrontEnd(valobj_sp));
186 else if (!strcmp(class_name,"__NSDictionaryM"))
188 return (new NSDictionaryMSyntheticFrontEnd(valobj_sp));
192 return (new NSDictionaryCodeRunningSyntheticFrontEnd(valobj_sp));
196 lldb_private::formatters::NSDictionaryCodeRunningSyntheticFrontEnd::NSDictionaryCodeRunningSyntheticFrontEnd (lldb::ValueObjectSP valobj_sp) :
197 SyntheticChildrenFrontEnd(*valobj_sp.get())
201 lldb_private::formatters::NSDictionaryCodeRunningSyntheticFrontEnd::CalculateNumChildren ()
204 if (ExtractValueFromObjCExpression(m_backend, "int", "count", count))
210 lldb_private::formatters::NSDictionaryCodeRunningSyntheticFrontEnd::GetChildAtIndex (size_t idx)
212 StreamString idx_name;
213 idx_name.Printf("[%zu]",idx);
214 StreamString key_fetcher_expr;
215 key_fetcher_expr.Printf("(id)[(NSArray*)[(id)0x%" PRIx64 " allKeys] objectAtIndex:%zu]",m_backend.GetPointerValue(),idx);
216 StreamString value_fetcher_expr;
217 value_fetcher_expr.Printf("(id)[(id)0x%" PRIx64 " objectForKey:(%s)]",m_backend.GetPointerValue(),key_fetcher_expr.GetData());
218 StreamString object_fetcher_expr;
219 object_fetcher_expr.Printf("struct __lldb_autogen_nspair { id key; id value; } _lldb_valgen_item; _lldb_valgen_item.key = %s; _lldb_valgen_item.value = %s; _lldb_valgen_item;",key_fetcher_expr.GetData(),value_fetcher_expr.GetData());
220 lldb::ValueObjectSP child_sp;
221 EvaluateExpressionOptions options;
222 options.SetKeepInMemory(true);
223 m_backend.GetTargetSP()->EvaluateExpression(object_fetcher_expr.GetData(), m_backend.GetFrameSP().get(), child_sp,
226 child_sp->SetName(ConstString(idx_name.GetData()));
231 lldb_private::formatters::NSDictionaryCodeRunningSyntheticFrontEnd::Update()
237 lldb_private::formatters::NSDictionaryCodeRunningSyntheticFrontEnd::MightHaveChildren ()
243 lldb_private::formatters::NSDictionaryCodeRunningSyntheticFrontEnd::GetIndexOfChildWithName (const ConstString &name)
248 lldb_private::formatters::NSDictionaryCodeRunningSyntheticFrontEnd::~NSDictionaryCodeRunningSyntheticFrontEnd ()
251 lldb_private::formatters::NSDictionaryISyntheticFrontEnd::NSDictionaryISyntheticFrontEnd (lldb::ValueObjectSP valobj_sp) :
252 SyntheticChildrenFrontEnd(*valobj_sp.get()),
255 m_order(lldb::eByteOrderInvalid),
262 lldb_private::formatters::NSDictionaryISyntheticFrontEnd::~NSDictionaryISyntheticFrontEnd ()
271 lldb_private::formatters::NSDictionaryISyntheticFrontEnd::GetIndexOfChildWithName (const ConstString &name)
273 const char* item_name = name.GetCString();
274 uint32_t idx = ExtractIndexFromString(item_name);
275 if (idx < UINT32_MAX && idx >= CalculateNumChildren())
281 lldb_private::formatters::NSDictionaryISyntheticFrontEnd::CalculateNumChildren ()
283 if (!m_data_32 && !m_data_64)
285 return (m_data_32 ? m_data_32->_used : m_data_64->_used);
289 lldb_private::formatters::NSDictionaryISyntheticFrontEnd::Update()
297 ValueObjectSP valobj_sp = m_backend.GetSP();
300 m_exe_ctx_ref = valobj_sp->GetExecutionContextRef();
303 lldb::ProcessSP process_sp(valobj_sp->GetProcessSP());
306 m_ptr_size = process_sp->GetAddressByteSize();
307 m_order = process_sp->GetByteOrder();
308 uint64_t data_location = valobj_sp->GetValueAsUnsigned(0) + m_ptr_size;
311 m_data_32 = new DataDescriptor_32();
312 process_sp->ReadMemory (data_location, m_data_32, sizeof(DataDescriptor_32), error);
316 m_data_64 = new DataDescriptor_64();
317 process_sp->ReadMemory (data_location, m_data_64, sizeof(DataDescriptor_64), error);
321 m_data_ptr = data_location + m_ptr_size;
326 lldb_private::formatters::NSDictionaryISyntheticFrontEnd::MightHaveChildren ()
332 lldb_private::formatters::NSDictionaryISyntheticFrontEnd::GetChildAtIndex (size_t idx)
334 uint32_t num_children = CalculateNumChildren();
336 if (idx >= num_children)
337 return lldb::ValueObjectSP();
339 if (m_children.empty())
342 lldb::addr_t key_at_idx = 0, val_at_idx = 0;
345 uint32_t test_idx = 0;
347 while(tries < num_children)
349 key_at_idx = m_data_ptr + (2*test_idx * m_ptr_size);
350 val_at_idx = key_at_idx + m_ptr_size;
351 ProcessSP process_sp = m_exe_ctx_ref.GetProcessSP();
353 return lldb::ValueObjectSP();
355 key_at_idx = process_sp->ReadPointerFromMemory(key_at_idx, error);
357 return lldb::ValueObjectSP();
358 val_at_idx = process_sp->ReadPointerFromMemory(val_at_idx, error);
360 return lldb::ValueObjectSP();
364 if (!key_at_idx || !val_at_idx)
368 DictionaryItemDescriptor descriptor = {key_at_idx,val_at_idx,lldb::ValueObjectSP()};
370 m_children.push_back(descriptor);
374 if (idx >= m_children.size()) // should never happen
375 return lldb::ValueObjectSP();
377 DictionaryItemDescriptor &dict_item = m_children[idx];
378 if (!dict_item.valobj_sp)
380 if (!m_pair_type.IsValid())
382 TargetSP target_sp(m_backend.GetTargetSP());
384 return ValueObjectSP();
385 m_pair_type = GetLLDBNSPairType(target_sp);
387 if (!m_pair_type.IsValid())
388 return ValueObjectSP();
390 DataBufferSP buffer_sp(new DataBufferHeap(2*m_ptr_size,0));
394 uint64_t *data_ptr = (uint64_t *)buffer_sp->GetBytes();
395 *data_ptr = dict_item.key_ptr;
396 *(data_ptr+1) = dict_item.val_ptr;
400 uint32_t *data_ptr = (uint32_t *)buffer_sp->GetBytes();
401 *data_ptr = dict_item.key_ptr;
402 *(data_ptr+1) = dict_item.val_ptr;
405 StreamString idx_name;
406 idx_name.Printf("[%zu]",idx);
407 DataExtractor data(buffer_sp, m_order, m_ptr_size);
408 dict_item.valobj_sp = ValueObject::CreateValueObjectFromData(idx_name.GetData(), data, m_exe_ctx_ref, m_pair_type);
410 return dict_item.valobj_sp;
413 lldb_private::formatters::NSDictionaryMSyntheticFrontEnd::NSDictionaryMSyntheticFrontEnd (lldb::ValueObjectSP valobj_sp) :
414 SyntheticChildrenFrontEnd(*valobj_sp.get()),
417 m_order(lldb::eByteOrderInvalid),
424 lldb_private::formatters::NSDictionaryMSyntheticFrontEnd::~NSDictionaryMSyntheticFrontEnd ()
433 lldb_private::formatters::NSDictionaryMSyntheticFrontEnd::GetIndexOfChildWithName (const ConstString &name)
435 const char* item_name = name.GetCString();
436 uint32_t idx = ExtractIndexFromString(item_name);
437 if (idx < UINT32_MAX && idx >= CalculateNumChildren())
443 lldb_private::formatters::NSDictionaryMSyntheticFrontEnd::CalculateNumChildren ()
445 if (!m_data_32 && !m_data_64)
447 return (m_data_32 ? m_data_32->_used : m_data_64->_used);
451 lldb_private::formatters::NSDictionaryMSyntheticFrontEnd::Update()
454 ValueObjectSP valobj_sp = m_backend.GetSP();
462 m_exe_ctx_ref = valobj_sp->GetExecutionContextRef();
465 lldb::ProcessSP process_sp(valobj_sp->GetProcessSP());
468 m_ptr_size = process_sp->GetAddressByteSize();
469 m_order = process_sp->GetByteOrder();
470 uint64_t data_location = valobj_sp->GetValueAsUnsigned(0) + m_ptr_size;
473 m_data_32 = new DataDescriptor_32();
474 process_sp->ReadMemory (data_location, m_data_32, sizeof(DataDescriptor_32), error);
478 m_data_64 = new DataDescriptor_64();
479 process_sp->ReadMemory (data_location, m_data_64, sizeof(DataDescriptor_64), error);
487 lldb_private::formatters::NSDictionaryMSyntheticFrontEnd::MightHaveChildren ()
493 lldb_private::formatters::NSDictionaryMSyntheticFrontEnd::GetChildAtIndex (size_t idx)
495 lldb::addr_t m_keys_ptr = (m_data_32 ? m_data_32->_keys_addr : m_data_64->_keys_addr);
496 lldb::addr_t m_values_ptr = (m_data_32 ? m_data_32->_objs_addr : m_data_64->_objs_addr);
498 uint32_t num_children = CalculateNumChildren();
500 if (idx >= num_children)
501 return lldb::ValueObjectSP();
503 if (m_children.empty())
506 lldb::addr_t key_at_idx = 0, val_at_idx = 0;
509 uint32_t test_idx = 0;
511 while(tries < num_children)
513 key_at_idx = m_keys_ptr + (test_idx * m_ptr_size);
514 val_at_idx = m_values_ptr + (test_idx * m_ptr_size);;
515 ProcessSP process_sp = m_exe_ctx_ref.GetProcessSP();
517 return lldb::ValueObjectSP();
519 key_at_idx = process_sp->ReadPointerFromMemory(key_at_idx, error);
521 return lldb::ValueObjectSP();
522 val_at_idx = process_sp->ReadPointerFromMemory(val_at_idx, error);
524 return lldb::ValueObjectSP();
528 if (!key_at_idx || !val_at_idx)
532 DictionaryItemDescriptor descriptor = {key_at_idx,val_at_idx,lldb::ValueObjectSP()};
534 m_children.push_back(descriptor);
538 if (idx >= m_children.size()) // should never happen
539 return lldb::ValueObjectSP();
541 DictionaryItemDescriptor &dict_item = m_children[idx];
542 if (!dict_item.valobj_sp)
544 if (!m_pair_type.IsValid())
546 TargetSP target_sp(m_backend.GetTargetSP());
548 return ValueObjectSP();
549 m_pair_type = GetLLDBNSPairType(target_sp);
551 if (!m_pair_type.IsValid())
552 return ValueObjectSP();
554 DataBufferSP buffer_sp(new DataBufferHeap(2*m_ptr_size,0));
558 uint64_t *data_ptr = (uint64_t *)buffer_sp->GetBytes();
559 *data_ptr = dict_item.key_ptr;
560 *(data_ptr+1) = dict_item.val_ptr;
564 uint32_t *data_ptr = (uint32_t *)buffer_sp->GetBytes();
565 *data_ptr = dict_item.key_ptr;
566 *(data_ptr+1) = dict_item.val_ptr;
569 StreamString idx_name;
570 idx_name.Printf("[%zu]",idx);
571 DataExtractor data(buffer_sp, m_order, m_ptr_size);
572 dict_item.valobj_sp = ValueObject::CreateValueObjectFromData(idx_name.GetData(), data, m_exe_ctx_ref, m_pair_type);
574 return dict_item.valobj_sp;
578 lldb_private::formatters::NSDictionarySummaryProvider<true> (ValueObject&, Stream&) ;
581 lldb_private::formatters::NSDictionarySummaryProvider<false> (ValueObject&, Stream&) ;