blob: 9dceca6123f31ce7713405d110c93946f0513c14 [file] [log] [blame]
Greg Claytonbb1beaa2013-03-26 18:42:13 +00001//===-- LibCxx.cpp ----------------------------------------------*- C++ -*-===//
Enrico Granataea2bc0f2013-02-21 19:57:10 +00002//
Chandler Carruth2946cd72019-01-19 08:50:56 +00003// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
Enrico Granataea2bc0f2013-02-21 19:57:10 +00006//
7//===----------------------------------------------------------------------===//
8
Enrico Granata33e97e62015-09-04 21:01:18 +00009#include "LibCxx.h"
Enrico Granataea2bc0f2013-02-21 19:57:10 +000010
Adrian Prantl6b58fa72018-08-23 17:02:39 +000011#include "llvm/ADT/ScopeExit.h"
Enrico Granata14b74fd2013-05-06 18:55:52 +000012#include "lldb/Core/Debugger.h"
Greg Clayton554f68d2015-02-04 22:00:53 +000013#include "lldb/Core/FormatEntity.h"
Enrico Granataea2bc0f2013-02-21 19:57:10 +000014#include "lldb/Core/ValueObject.h"
15#include "lldb/Core/ValueObjectConstResult.h"
Enrico Granata419d7912015-09-04 00:33:51 +000016#include "lldb/DataFormatters/FormattersHelpers.h"
17#include "lldb/DataFormatters/StringPrinter.h"
18#include "lldb/DataFormatters/TypeSummary.h"
19#include "lldb/DataFormatters/VectorIterator.h"
Enrico Granataea2bc0f2013-02-21 19:57:10 +000020#include "lldb/Symbol/ClangASTContext.h"
Shafik Yaghmour443e20b2018-09-11 20:58:28 +000021#include "lldb/Target/CPPLanguageRuntime.h"
Zachary Turner01c32432017-02-14 19:06:07 +000022#include "lldb/Target/ProcessStructReader.h"
Adrian Prantl6b58fa72018-08-23 17:02:39 +000023#include "lldb/Target/SectionLoadList.h"
Enrico Granataea2bc0f2013-02-21 19:57:10 +000024#include "lldb/Target/Target.h"
Zachary Turner666cc0b2017-03-04 01:30:05 +000025#include "lldb/Utility/DataBufferHeap.h"
Zachary Turner01c32432017-02-14 19:06:07 +000026#include "lldb/Utility/Endian.h"
Zachary Turner97206d52017-05-12 04:51:55 +000027#include "lldb/Utility/Status.h"
Zachary Turnerbf9a7732017-02-02 21:39:50 +000028#include "lldb/Utility/Stream.h"
Enrico Granataea2bc0f2013-02-21 19:57:10 +000029
30using namespace lldb;
31using namespace lldb_private;
32using namespace lldb_private::formatters;
33
Adrian Prantlc53d3682018-08-15 22:48:48 +000034bool lldb_private::formatters::LibcxxOptionalSummaryProvider(
35 ValueObject &valobj, Stream &stream, const TypeSummaryOptions &options) {
36 ValueObjectSP valobj_sp(valobj.GetNonSyntheticValue());
37 if (!valobj_sp)
38 return false;
39
40 // An optional either contains a value or not, the member __engaged_ is
41 // a bool flag, it is true if the optional has a value and false otherwise.
42 ValueObjectSP engaged_sp(
43 valobj_sp->GetChildMemberWithName(ConstString("__engaged_"), true));
44
45 if (!engaged_sp)
46 return false;
47
48 llvm::StringRef engaged_as_cstring(
49 engaged_sp->GetValueAsUnsigned(0) == 1 ? "true" : "false");
50
51 stream.Printf(" Has Value=%s ", engaged_as_cstring.data());
52
53 return true;
54}
55
Adrian Prantl6b58fa72018-08-23 17:02:39 +000056bool lldb_private::formatters::LibcxxFunctionSummaryProvider(
57 ValueObject &valobj, Stream &stream, const TypeSummaryOptions &options) {
58
59 ValueObjectSP valobj_sp(valobj.GetNonSyntheticValue());
60
61 if (!valobj_sp)
62 return false;
63
Adrian Prantl6b58fa72018-08-23 17:02:39 +000064 ExecutionContext exe_ctx(valobj_sp->GetExecutionContextRef());
65 Process *process = exe_ctx.GetProcessPtr();
66
67 if (process == nullptr)
68 return false;
69
Shafik Yaghmour443e20b2018-09-11 20:58:28 +000070 CPPLanguageRuntime *cpp_runtime = process->GetCPPLanguageRuntime();
Adrian Prantl6b58fa72018-08-23 17:02:39 +000071
Shafik Yaghmour443e20b2018-09-11 20:58:28 +000072 if (!cpp_runtime)
Adrian Prantl6b58fa72018-08-23 17:02:39 +000073 return false;
74
Shafik Yaghmour443e20b2018-09-11 20:58:28 +000075 CPPLanguageRuntime::LibCppStdFunctionCallableInfo callable_info =
76 cpp_runtime->FindLibCppStdFunctionCallableInfo(valobj_sp);
Adrian Prantl6b58fa72018-08-23 17:02:39 +000077
Shafik Yaghmour443e20b2018-09-11 20:58:28 +000078 switch (callable_info.callable_case) {
79 case CPPLanguageRuntime::LibCppStdFunctionCallableCase::Invalid:
80 stream.Printf(" __f_ = %" PRIu64, callable_info.member__f_pointer_value);
Adrian Prantl6b58fa72018-08-23 17:02:39 +000081 return false;
Shafik Yaghmour443e20b2018-09-11 20:58:28 +000082 break;
83 case CPPLanguageRuntime::LibCppStdFunctionCallableCase::Lambda:
84 stream.Printf(
85 " Lambda in File %s at Line %u",
86 callable_info.callable_line_entry.file.GetFilename().GetCString(),
87 callable_info.callable_line_entry.line);
88 break;
89 case CPPLanguageRuntime::LibCppStdFunctionCallableCase::CallableObject:
90 stream.Printf(
91 " Function in File %s at Line %u",
92 callable_info.callable_line_entry.file.GetFilename().GetCString(),
93 callable_info.callable_line_entry.line);
94 break;
95 case CPPLanguageRuntime::LibCppStdFunctionCallableCase::FreeOrMemberFunction:
96 stream.Printf(" Function = %s ",
97 callable_info.callable_symbol.GetName().GetCString());
98 break;
Adrian Prantl6b58fa72018-08-23 17:02:39 +000099 }
100
Shafik Yaghmour443e20b2018-09-11 20:58:28 +0000101 return true;
Adrian Prantl6b58fa72018-08-23 17:02:39 +0000102}
103
Kate Stoneb9c1b512016-09-06 20:57:50 +0000104bool lldb_private::formatters::LibcxxSmartPointerSummaryProvider(
105 ValueObject &valobj, Stream &stream, const TypeSummaryOptions &options) {
106 ValueObjectSP valobj_sp(valobj.GetNonSyntheticValue());
107 if (!valobj_sp)
108 return false;
109 ValueObjectSP ptr_sp(
110 valobj_sp->GetChildMemberWithName(ConstString("__ptr_"), true));
111 ValueObjectSP count_sp(valobj_sp->GetChildAtNamePath(
112 {ConstString("__cntrl_"), ConstString("__shared_owners_")}));
113 ValueObjectSP weakcount_sp(valobj_sp->GetChildAtNamePath(
114 {ConstString("__cntrl_"), ConstString("__shared_weak_owners_")}));
Enrico Granata0dba9b32014-01-08 01:36:59 +0000115
Kate Stoneb9c1b512016-09-06 20:57:50 +0000116 if (!ptr_sp)
117 return false;
118
119 if (ptr_sp->GetValueAsUnsigned(0) == 0) {
120 stream.Printf("nullptr");
Enrico Granata0dba9b32014-01-08 01:36:59 +0000121 return true;
Kate Stoneb9c1b512016-09-06 20:57:50 +0000122 } else {
123 bool print_pointee = false;
Zachary Turner97206d52017-05-12 04:51:55 +0000124 Status error;
Kate Stoneb9c1b512016-09-06 20:57:50 +0000125 ValueObjectSP pointee_sp = ptr_sp->Dereference(error);
126 if (pointee_sp && error.Success()) {
127 if (pointee_sp->DumpPrintableRepresentation(
128 stream, ValueObject::eValueObjectRepresentationStyleSummary,
129 lldb::eFormatInvalid,
Enrico Granata65d86e42016-11-07 23:32:20 +0000130 ValueObject::PrintableRepresentationSpecialCases::eDisable,
131 false))
Kate Stoneb9c1b512016-09-06 20:57:50 +0000132 print_pointee = true;
Enrico Granata473316f2013-12-21 08:09:49 +0000133 }
Kate Stoneb9c1b512016-09-06 20:57:50 +0000134 if (!print_pointee)
135 stream.Printf("ptr = 0x%" PRIx64, ptr_sp->GetValueAsUnsigned(0));
136 }
137
138 if (count_sp)
139 stream.Printf(" strong=%" PRIu64, 1 + count_sp->GetValueAsUnsigned(0));
140
141 if (weakcount_sp)
142 stream.Printf(" weak=%" PRIu64, 1 + weakcount_sp->GetValueAsUnsigned(0));
143
144 return true;
Enrico Granataea2bc0f2013-02-21 19:57:10 +0000145}
146
Enrico Granataea2bc0f2013-02-21 19:57:10 +0000147/*
148 (lldb) fr var ibeg --raw --ptr-depth 1
Kate Stoneb9c1b512016-09-06 20:57:50 +0000149 (std::__1::__map_iterator<std::__1::__tree_iterator<std::__1::pair<int,
150 std::__1::basic_string<char, std::__1::char_traits<char>,
151 std::__1::allocator<char> > >, std::__1::__tree_node<std::__1::pair<int,
152 std::__1::basic_string<char, std::__1::char_traits<char>,
153 std::__1::allocator<char> > >, void *> *, long> >) ibeg = {
Enrico Granataea2bc0f2013-02-21 19:57:10 +0000154 __i_ = {
155 __ptr_ = 0x0000000100103870 {
156 std::__1::__tree_node_base<void *> = {
157 std::__1::__tree_end_node<std::__1::__tree_node_base<void *> *> = {
158 __left_ = 0x0000000000000000
159 }
160 __right_ = 0x0000000000000000
161 __parent_ = 0x00000001001038b0
162 __is_black_ = true
163 }
164 __value_ = {
165 first = 0
166 second = { std::string }
167 */
168
Kate Stoneb9c1b512016-09-06 20:57:50 +0000169lldb_private::formatters::LibCxxMapIteratorSyntheticFrontEnd::
170 LibCxxMapIteratorSyntheticFrontEnd(lldb::ValueObjectSP valobj_sp)
Enrico Granataae1ba732016-09-28 22:53:16 +0000171 : SyntheticChildrenFrontEnd(*valobj_sp), m_pair_ptr(), m_pair_sp() {
Kate Stoneb9c1b512016-09-06 20:57:50 +0000172 if (valobj_sp)
173 Update();
Enrico Granataea2bc0f2013-02-21 19:57:10 +0000174}
175
Kate Stoneb9c1b512016-09-06 20:57:50 +0000176bool lldb_private::formatters::LibCxxMapIteratorSyntheticFrontEnd::Update() {
Enrico Granataae1ba732016-09-28 22:53:16 +0000177 m_pair_sp.reset();
178 m_pair_ptr = nullptr;
179
Kate Stoneb9c1b512016-09-06 20:57:50 +0000180 ValueObjectSP valobj_sp = m_backend.GetSP();
181 if (!valobj_sp)
Enrico Granata92373532013-03-19 22:58:48 +0000182 return false;
Kate Stoneb9c1b512016-09-06 20:57:50 +0000183
184 TargetSP target_sp(valobj_sp->GetTargetSP());
185
186 if (!target_sp)
187 return false;
188
189 if (!valobj_sp)
190 return false;
Adrian Prantlc53d3682018-08-15 22:48:48 +0000191
Enrico Granataae1ba732016-09-28 22:53:16 +0000192 static ConstString g___i_("__i_");
Adrian Prantlc53d3682018-08-15 22:48:48 +0000193
Adrian Prantl05097242018-04-30 16:49:04 +0000194 // this must be a ValueObject* because it is a child of the ValueObject we
195 // are producing children for it if were a ValueObjectSP, we would end up
196 // with a loop (iterator -> synthetic -> child -> parent == iterator) and
197 // that would in turn leak memory by never allowing the ValueObjects to die
198 // and free their memory
Kate Stoneb9c1b512016-09-06 20:57:50 +0000199 m_pair_ptr = valobj_sp
200 ->GetValueForExpressionPath(
Zachary Turnerd2daca72016-11-18 17:55:04 +0000201 ".__i_.__ptr_->__value_", nullptr, nullptr,
Kate Stoneb9c1b512016-09-06 20:57:50 +0000202 ValueObject::GetValueForExpressionPathOptions()
203 .DontCheckDotVsArrowSyntax()
204 .SetSyntheticChildrenTraversal(
205 ValueObject::GetValueForExpressionPathOptions::
206 SyntheticChildrenTraversal::None),
207 nullptr)
208 .get();
Zachary Turnerd2daca72016-11-18 17:55:04 +0000209
Enrico Granataae1ba732016-09-28 22:53:16 +0000210 if (!m_pair_ptr) {
Zachary Turnerd2daca72016-11-18 17:55:04 +0000211 m_pair_ptr = valobj_sp
212 ->GetValueForExpressionPath(
213 ".__i_.__ptr_", nullptr, nullptr,
214 ValueObject::GetValueForExpressionPathOptions()
215 .DontCheckDotVsArrowSyntax()
216 .SetSyntheticChildrenTraversal(
217 ValueObject::GetValueForExpressionPathOptions::
218 SyntheticChildrenTraversal::None),
219 nullptr)
220 .get();
Enrico Granataae1ba732016-09-28 22:53:16 +0000221 if (m_pair_ptr) {
222 auto __i_(valobj_sp->GetChildMemberWithName(g___i_, true));
Enrico Granataae1ba732016-09-28 22:53:16 +0000223 if (!__i_) {
224 m_pair_ptr = nullptr;
225 return false;
226 }
Adrian Prantld963a7c2019-01-15 18:07:52 +0000227 CompilerType pair_type(
228 __i_->GetCompilerType().GetTypeTemplateArgument(0));
229 std::string name;
230 uint64_t bit_offset_ptr;
231 uint32_t bitfield_bit_size_ptr;
232 bool is_bitfield_ptr;
233 pair_type = pair_type.GetFieldAtIndex(
234 0, name, &bit_offset_ptr, &bitfield_bit_size_ptr, &is_bitfield_ptr);
Enrico Granataae1ba732016-09-28 22:53:16 +0000235 if (!pair_type) {
236 m_pair_ptr = nullptr;
237 return false;
238 }
Adrian Prantlc53d3682018-08-15 22:48:48 +0000239
Enrico Granataae1ba732016-09-28 22:53:16 +0000240 auto addr(m_pair_ptr->GetValueAsUnsigned(LLDB_INVALID_ADDRESS));
241 m_pair_ptr = nullptr;
Adrian Prantld963a7c2019-01-15 18:07:52 +0000242 if (addr && addr != LLDB_INVALID_ADDRESS) {
243 ClangASTContext *ast_ctx =
244 llvm::dyn_cast_or_null<ClangASTContext>(pair_type.GetTypeSystem());
Enrico Granataae1ba732016-09-28 22:53:16 +0000245 if (!ast_ctx)
246 return false;
Adrian Prantld963a7c2019-01-15 18:07:52 +0000247 CompilerType tree_node_type = ast_ctx->CreateStructForIdentifier(
248 ConstString(),
249 {{"ptr0",
250 ast_ctx->GetBasicType(lldb::eBasicTypeVoid).GetPointerType()},
251 {"ptr1",
252 ast_ctx->GetBasicType(lldb::eBasicTypeVoid).GetPointerType()},
253 {"ptr2",
254 ast_ctx->GetBasicType(lldb::eBasicTypeVoid).GetPointerType()},
255 {"cw", ast_ctx->GetBasicType(lldb::eBasicTypeBool)},
256 {"payload", pair_type}});
Adrian Prantld6a9bbf2019-01-15 20:33:58 +0000257 llvm::Optional<uint64_t> size = tree_node_type.GetByteSize(nullptr);
Adrian Prantld963a7c2019-01-15 18:07:52 +0000258 if (!size)
259 return false;
260 DataBufferSP buffer_sp(new DataBufferHeap(*size, 0));
Enrico Granataae1ba732016-09-28 22:53:16 +0000261 ProcessSP process_sp(target_sp->GetProcessSP());
Zachary Turner97206d52017-05-12 04:51:55 +0000262 Status error;
Adrian Prantld963a7c2019-01-15 18:07:52 +0000263 process_sp->ReadMemory(addr, buffer_sp->GetBytes(),
264 buffer_sp->GetByteSize(), error);
Enrico Granataae1ba732016-09-28 22:53:16 +0000265 if (error.Fail())
266 return false;
Adrian Prantld963a7c2019-01-15 18:07:52 +0000267 DataExtractor extractor(buffer_sp, process_sp->GetByteOrder(),
268 process_sp->GetAddressByteSize());
269 auto pair_sp = CreateValueObjectFromData(
270 "pair", extractor, valobj_sp->GetExecutionContextRef(),
271 tree_node_type);
Enrico Granataae1ba732016-09-28 22:53:16 +0000272 if (pair_sp)
Adrian Prantld963a7c2019-01-15 18:07:52 +0000273 m_pair_sp = pair_sp->GetChildAtIndex(4, true);
Enrico Granataae1ba732016-09-28 22:53:16 +0000274 }
275 }
276 }
Kate Stoneb9c1b512016-09-06 20:57:50 +0000277
278 return false;
Enrico Granataea2bc0f2013-02-21 19:57:10 +0000279}
280
Kate Stoneb9c1b512016-09-06 20:57:50 +0000281size_t lldb_private::formatters::LibCxxMapIteratorSyntheticFrontEnd::
282 CalculateNumChildren() {
283 return 2;
Enrico Granataea2bc0f2013-02-21 19:57:10 +0000284}
285
286lldb::ValueObjectSP
Kate Stoneb9c1b512016-09-06 20:57:50 +0000287lldb_private::formatters::LibCxxMapIteratorSyntheticFrontEnd::GetChildAtIndex(
288 size_t idx) {
Enrico Granataae1ba732016-09-28 22:53:16 +0000289 if (m_pair_ptr)
290 return m_pair_ptr->GetChildAtIndex(idx, true);
291 if (m_pair_sp)
292 return m_pair_sp->GetChildAtIndex(idx, true);
293 return lldb::ValueObjectSP();
Enrico Granataea2bc0f2013-02-21 19:57:10 +0000294}
295
Kate Stoneb9c1b512016-09-06 20:57:50 +0000296bool lldb_private::formatters::LibCxxMapIteratorSyntheticFrontEnd::
297 MightHaveChildren() {
298 return true;
Enrico Granataea2bc0f2013-02-21 19:57:10 +0000299}
300
Kate Stoneb9c1b512016-09-06 20:57:50 +0000301size_t lldb_private::formatters::LibCxxMapIteratorSyntheticFrontEnd::
Adrian Prantl0e4c4822019-03-06 21:22:25 +0000302 GetIndexOfChildWithName(ConstString name) {
Raphael Isemann05cfdb02019-04-26 07:21:36 +0000303 if (name == "first")
Kate Stoneb9c1b512016-09-06 20:57:50 +0000304 return 0;
Raphael Isemann05cfdb02019-04-26 07:21:36 +0000305 if (name == "second")
Kate Stoneb9c1b512016-09-06 20:57:50 +0000306 return 1;
307 return UINT32_MAX;
Enrico Granataea2bc0f2013-02-21 19:57:10 +0000308}
309
Kate Stoneb9c1b512016-09-06 20:57:50 +0000310lldb_private::formatters::LibCxxMapIteratorSyntheticFrontEnd::
311 ~LibCxxMapIteratorSyntheticFrontEnd() {
312 // this will be deleted when its parent dies (since it's a child object)
313 // delete m_pair_ptr;
Enrico Granataea2bc0f2013-02-21 19:57:10 +0000314}
315
Kate Stoneb9c1b512016-09-06 20:57:50 +0000316SyntheticChildrenFrontEnd *
317lldb_private::formatters::LibCxxMapIteratorSyntheticFrontEndCreator(
318 CXXSyntheticChildren *, lldb::ValueObjectSP valobj_sp) {
319 return (valobj_sp ? new LibCxxMapIteratorSyntheticFrontEnd(valobj_sp)
320 : nullptr);
Enrico Granataea2bc0f2013-02-21 19:57:10 +0000321}
322
323/*
324 (lldb) fr var ibeg --raw --ptr-depth 1 -T
325 (std::__1::__wrap_iter<int *>) ibeg = {
326 (std::__1::__wrap_iter<int *>::iterator_type) __i = 0x00000001001037a0 {
327 (int) *__i = 1
328 }
329 }
330*/
331
Kate Stoneb9c1b512016-09-06 20:57:50 +0000332SyntheticChildrenFrontEnd *
333lldb_private::formatters::LibCxxVectorIteratorSyntheticFrontEndCreator(
334 CXXSyntheticChildren *, lldb::ValueObjectSP valobj_sp) {
335 static ConstString g_item_name;
336 if (!g_item_name)
337 g_item_name.SetCString("__i");
338 return (valobj_sp
339 ? new VectorIteratorSyntheticFrontEnd(valobj_sp, g_item_name)
340 : nullptr);
Enrico Granataea2bc0f2013-02-21 19:57:10 +0000341}
Enrico Granata92373532013-03-19 22:58:48 +0000342
Kate Stoneb9c1b512016-09-06 20:57:50 +0000343lldb_private::formatters::LibcxxSharedPtrSyntheticFrontEnd::
344 LibcxxSharedPtrSyntheticFrontEnd(lldb::ValueObjectSP valobj_sp)
345 : SyntheticChildrenFrontEnd(*valobj_sp), m_cntrl(nullptr), m_count_sp(),
346 m_weak_count_sp(), m_ptr_size(0), m_byte_order(lldb::eByteOrderInvalid) {
347 if (valobj_sp)
348 Update();
Enrico Granata92373532013-03-19 22:58:48 +0000349}
350
Kate Stoneb9c1b512016-09-06 20:57:50 +0000351size_t lldb_private::formatters::LibcxxSharedPtrSyntheticFrontEnd::
352 CalculateNumChildren() {
353 return (m_cntrl ? 1 : 0);
Enrico Granata92373532013-03-19 22:58:48 +0000354}
355
356lldb::ValueObjectSP
Kate Stoneb9c1b512016-09-06 20:57:50 +0000357lldb_private::formatters::LibcxxSharedPtrSyntheticFrontEnd::GetChildAtIndex(
358 size_t idx) {
359 if (!m_cntrl)
360 return lldb::ValueObjectSP();
361
362 ValueObjectSP valobj_sp = m_backend.GetSP();
363 if (!valobj_sp)
364 return lldb::ValueObjectSP();
365
366 if (idx == 0)
367 return valobj_sp->GetChildMemberWithName(ConstString("__ptr_"), true);
368
369 if (idx > 2)
370 return lldb::ValueObjectSP();
371
372 if (idx == 1) {
373 if (!m_count_sp) {
374 ValueObjectSP shared_owners_sp(m_cntrl->GetChildMemberWithName(
375 ConstString("__shared_owners_"), true));
376 if (!shared_owners_sp)
Enrico Granata92373532013-03-19 22:58:48 +0000377 return lldb::ValueObjectSP();
Kate Stoneb9c1b512016-09-06 20:57:50 +0000378 uint64_t count = 1 + shared_owners_sp->GetValueAsUnsigned(0);
379 DataExtractor data(&count, 8, m_byte_order, m_ptr_size);
380 m_count_sp = CreateValueObjectFromData(
381 "count", data, valobj_sp->GetExecutionContextRef(),
382 shared_owners_sp->GetCompilerType());
Enrico Granata92373532013-03-19 22:58:48 +0000383 }
Kate Stoneb9c1b512016-09-06 20:57:50 +0000384 return m_count_sp;
385 } else /* if (idx == 2) */
386 {
387 if (!m_weak_count_sp) {
388 ValueObjectSP shared_weak_owners_sp(m_cntrl->GetChildMemberWithName(
389 ConstString("__shared_weak_owners_"), true));
390 if (!shared_weak_owners_sp)
391 return lldb::ValueObjectSP();
392 uint64_t count = 1 + shared_weak_owners_sp->GetValueAsUnsigned(0);
393 DataExtractor data(&count, 8, m_byte_order, m_ptr_size);
394 m_weak_count_sp = CreateValueObjectFromData(
395 "count", data, valobj_sp->GetExecutionContextRef(),
396 shared_weak_owners_sp->GetCompilerType());
Enrico Granata92373532013-03-19 22:58:48 +0000397 }
Kate Stoneb9c1b512016-09-06 20:57:50 +0000398 return m_weak_count_sp;
399 }
Enrico Granata92373532013-03-19 22:58:48 +0000400}
401
Kate Stoneb9c1b512016-09-06 20:57:50 +0000402bool lldb_private::formatters::LibcxxSharedPtrSyntheticFrontEnd::Update() {
403 m_count_sp.reset();
404 m_weak_count_sp.reset();
405 m_cntrl = nullptr;
406
407 ValueObjectSP valobj_sp = m_backend.GetSP();
408 if (!valobj_sp)
Enrico Granata92373532013-03-19 22:58:48 +0000409 return false;
Kate Stoneb9c1b512016-09-06 20:57:50 +0000410
411 TargetSP target_sp(valobj_sp->GetTargetSP());
412 if (!target_sp)
413 return false;
414
415 m_byte_order = target_sp->GetArchitecture().GetByteOrder();
416 m_ptr_size = target_sp->GetArchitecture().GetAddressByteSize();
417
418 lldb::ValueObjectSP cntrl_sp(
419 valobj_sp->GetChildMemberWithName(ConstString("__cntrl_"), true));
420
421 m_cntrl = cntrl_sp.get(); // need to store the raw pointer to avoid a circular
422 // dependency
423 return false;
Enrico Granata92373532013-03-19 22:58:48 +0000424}
425
Kate Stoneb9c1b512016-09-06 20:57:50 +0000426bool lldb_private::formatters::LibcxxSharedPtrSyntheticFrontEnd::
427 MightHaveChildren() {
428 return true;
Enrico Granata92373532013-03-19 22:58:48 +0000429}
430
Kate Stoneb9c1b512016-09-06 20:57:50 +0000431size_t lldb_private::formatters::LibcxxSharedPtrSyntheticFrontEnd::
Adrian Prantl0e4c4822019-03-06 21:22:25 +0000432 GetIndexOfChildWithName(ConstString name) {
Raphael Isemann05cfdb02019-04-26 07:21:36 +0000433 if (name == "__ptr_")
Kate Stoneb9c1b512016-09-06 20:57:50 +0000434 return 0;
Raphael Isemann05cfdb02019-04-26 07:21:36 +0000435 if (name == "count")
Kate Stoneb9c1b512016-09-06 20:57:50 +0000436 return 1;
Raphael Isemann05cfdb02019-04-26 07:21:36 +0000437 if (name == "weak_count")
Kate Stoneb9c1b512016-09-06 20:57:50 +0000438 return 2;
439 return UINT32_MAX;
Enrico Granata92373532013-03-19 22:58:48 +0000440}
441
Kate Stoneb9c1b512016-09-06 20:57:50 +0000442lldb_private::formatters::LibcxxSharedPtrSyntheticFrontEnd::
443 ~LibcxxSharedPtrSyntheticFrontEnd() = default;
Enrico Granata92373532013-03-19 22:58:48 +0000444
Kate Stoneb9c1b512016-09-06 20:57:50 +0000445SyntheticChildrenFrontEnd *
446lldb_private::formatters::LibcxxSharedPtrSyntheticFrontEndCreator(
447 CXXSyntheticChildren *, lldb::ValueObjectSP valobj_sp) {
448 return (valobj_sp ? new LibcxxSharedPtrSyntheticFrontEnd(valobj_sp)
449 : nullptr);
Enrico Granata92373532013-03-19 22:58:48 +0000450}
451
Kate Stoneb9c1b512016-09-06 20:57:50 +0000452bool lldb_private::formatters::LibcxxContainerSummaryProvider(
453 ValueObject &valobj, Stream &stream, const TypeSummaryOptions &options) {
454 if (valobj.IsPointerType()) {
455 uint64_t value = valobj.GetValueAsUnsigned(0);
456 if (!value)
457 return false;
458 stream.Printf("0x%016" PRIx64 " ", value);
459 }
460 return FormatEntity::FormatStringRef("size=${svar%#}", stream, nullptr,
461 nullptr, nullptr, &valobj, false, false);
Enrico Granata14b74fd2013-05-06 18:55:52 +0000462}
Enrico Granatad87cc312015-09-03 01:29:42 +0000463
464// the field layout in a libc++ string (cap, side, data or data, size, cap)
Kate Stoneb9c1b512016-09-06 20:57:50 +0000465enum LibcxxStringLayoutMode {
466 eLibcxxStringLayoutModeCSD = 0,
467 eLibcxxStringLayoutModeDSC = 1,
468 eLibcxxStringLayoutModeInvalid = 0xffff
Enrico Granatad87cc312015-09-03 01:29:42 +0000469};
470
471// this function abstracts away the layout and mode details of a libc++ string
Adrian Prantl05097242018-04-30 16:49:04 +0000472// and returns the address of the data and the size ready for callers to
473// consume
Kate Stoneb9c1b512016-09-06 20:57:50 +0000474static bool ExtractLibcxxStringInfo(ValueObject &valobj,
475 ValueObjectSP &location_sp,
476 uint64_t &size) {
477 ValueObjectSP D(valobj.GetChildAtIndexPath({0, 0, 0, 0}));
478 if (!D)
479 return false;
Enrico Granatad87cc312015-09-03 01:29:42 +0000480
Lang Hames088d0012017-04-26 18:15:40 +0000481 ValueObjectSP layout_decider(
482 D->GetChildAtIndexPath(llvm::ArrayRef<size_t>({0, 0})));
Kate Stoneb9c1b512016-09-06 20:57:50 +0000483
484 // this child should exist
485 if (!layout_decider)
486 return false;
487
488 ConstString g_data_name("__data_");
489 ConstString g_size_name("__size_");
490 bool short_mode = false; // this means the string is in short-mode and the
491 // data is stored inline
492 LibcxxStringLayoutMode layout = (layout_decider->GetName() == g_data_name)
493 ? eLibcxxStringLayoutModeDSC
494 : eLibcxxStringLayoutModeCSD;
495 uint64_t size_mode_value = 0;
496
497 if (layout == eLibcxxStringLayoutModeDSC) {
498 ValueObjectSP size_mode(D->GetChildAtIndexPath({1, 1, 0}));
499 if (!size_mode)
500 return false;
501
502 if (size_mode->GetName() != g_size_name) {
503 // we are hitting the padding structure, move along
504 size_mode = D->GetChildAtIndexPath({1, 1, 1});
505 if (!size_mode)
Enrico Granatad87cc312015-09-03 01:29:42 +0000506 return false;
Enrico Granatad87cc312015-09-03 01:29:42 +0000507 }
Kate Stoneb9c1b512016-09-06 20:57:50 +0000508
509 size_mode_value = (size_mode->GetValueAsUnsigned(0));
510 short_mode = ((size_mode_value & 0x80) == 0);
511 } else {
512 ValueObjectSP size_mode(D->GetChildAtIndexPath({1, 0, 0}));
513 if (!size_mode)
514 return false;
515
516 size_mode_value = (size_mode->GetValueAsUnsigned(0));
517 short_mode = ((size_mode_value & 1) == 0);
518 }
519
520 if (short_mode) {
521 ValueObjectSP s(D->GetChildAtIndex(1, true));
522 if (!s)
523 return false;
524 location_sp = s->GetChildAtIndex(
525 (layout == eLibcxxStringLayoutModeDSC) ? 0 : 1, true);
526 size = (layout == eLibcxxStringLayoutModeDSC)
527 ? size_mode_value
528 : ((size_mode_value >> 1) % 256);
529 return (location_sp.get() != nullptr);
530 } else {
531 ValueObjectSP l(D->GetChildAtIndex(0, true));
532 if (!l)
533 return false;
534 // we can use the layout_decider object as the data pointer
535 location_sp = (layout == eLibcxxStringLayoutModeDSC)
536 ? layout_decider
537 : l->GetChildAtIndex(2, true);
538 ValueObjectSP size_vo(l->GetChildAtIndex(1, true));
539 if (!size_vo || !location_sp)
540 return false;
541 size = size_vo->GetValueAsUnsigned(0);
Enrico Granatad87cc312015-09-03 01:29:42 +0000542 return true;
Kate Stoneb9c1b512016-09-06 20:57:50 +0000543 }
Enrico Granatad87cc312015-09-03 01:29:42 +0000544}
545
Kate Stoneb9c1b512016-09-06 20:57:50 +0000546bool lldb_private::formatters::LibcxxWStringSummaryProvider(
547 ValueObject &valobj, Stream &stream,
548 const TypeSummaryOptions &summary_options) {
549 uint64_t size = 0;
550 ValueObjectSP location_sp;
551 if (!ExtractLibcxxStringInfo(valobj, location_sp, size))
552 return false;
553 if (size == 0) {
554 stream.Printf("L\"\"");
Enrico Granatad87cc312015-09-03 01:29:42 +0000555 return true;
Kate Stoneb9c1b512016-09-06 20:57:50 +0000556 }
557 if (!location_sp)
558 return false;
559
560 DataExtractor extractor;
561
562 StringPrinter::ReadBufferAndDumpToStreamOptions options(valobj);
563
564 if (summary_options.GetCapping() == TypeSummaryCapping::eTypeSummaryCapped) {
565 const auto max_size = valobj.GetTargetSP()->GetMaximumSizeOfStringSummary();
566 if (size > max_size) {
567 size = max_size;
568 options.SetIsTruncated(true);
569 }
570 }
571 location_sp->GetPointeeData(extractor, 0, size);
572
573 // std::wstring::size() is measured in 'characters', not bytes
574 auto wchar_t_size = valobj.GetTargetSP()
575 ->GetScratchClangASTContext()
576 ->GetBasicType(lldb::eBasicTypeWChar)
577 .GetByteSize(nullptr);
Adrian Prantld963a7c2019-01-15 18:07:52 +0000578 if (!wchar_t_size)
579 return false;
Kate Stoneb9c1b512016-09-06 20:57:50 +0000580
581 options.SetData(extractor);
582 options.SetStream(&stream);
583 options.SetPrefixToken("L");
584 options.SetQuote('"');
585 options.SetSourceSize(size);
586 options.SetBinaryZeroIsTerminator(false);
587
Adrian Prantld963a7c2019-01-15 18:07:52 +0000588 switch (*wchar_t_size) {
Kate Stoneb9c1b512016-09-06 20:57:50 +0000589 case 1:
590 StringPrinter::ReadBufferAndDumpToStream<
591 lldb_private::formatters::StringPrinter::StringElementType::UTF8>(
592 options);
593 break;
594
595 case 2:
596 lldb_private::formatters::StringPrinter::ReadBufferAndDumpToStream<
597 lldb_private::formatters::StringPrinter::StringElementType::UTF16>(
598 options);
599 break;
600
601 case 4:
602 lldb_private::formatters::StringPrinter::ReadBufferAndDumpToStream<
603 lldb_private::formatters::StringPrinter::StringElementType::UTF32>(
604 options);
605 break;
606
607 default:
608 stream.Printf("size for wchar_t is not valid");
609 return true;
610 }
611
612 return true;
Enrico Granatad87cc312015-09-03 01:29:42 +0000613}
Enrico Granata1b54bae2016-08-31 21:46:37 +0000614
Shafik Yaghmour693fbf52018-10-26 17:00:48 +0000615template <StringPrinter::StringElementType element_type>
616bool LibcxxStringSummaryProvider(ValueObject &valobj, Stream &stream,
617 const TypeSummaryOptions &summary_options,
618 std::string prefix_token = "") {
Kate Stoneb9c1b512016-09-06 20:57:50 +0000619 uint64_t size = 0;
620 ValueObjectSP location_sp;
621
622 if (!ExtractLibcxxStringInfo(valobj, location_sp, size))
623 return false;
624
625 if (size == 0) {
626 stream.Printf("\"\"");
627 return true;
628 }
629
630 if (!location_sp)
631 return false;
632
633 StringPrinter::ReadBufferAndDumpToStreamOptions options(valobj);
634
635 DataExtractor extractor;
636 if (summary_options.GetCapping() == TypeSummaryCapping::eTypeSummaryCapped) {
637 const auto max_size = valobj.GetTargetSP()->GetMaximumSizeOfStringSummary();
638 if (size > max_size) {
639 size = max_size;
640 options.SetIsTruncated(true);
641 }
642 }
643 location_sp->GetPointeeData(extractor, 0, size);
644
645 options.SetData(extractor);
646 options.SetStream(&stream);
Shafik Yaghmour693fbf52018-10-26 17:00:48 +0000647
648 if (prefix_token.empty())
649 options.SetPrefixToken(nullptr);
650 else
651 options.SetPrefixToken(prefix_token);
652
Kate Stoneb9c1b512016-09-06 20:57:50 +0000653 options.SetQuote('"');
654 options.SetSourceSize(size);
655 options.SetBinaryZeroIsTerminator(false);
Shafik Yaghmour693fbf52018-10-26 17:00:48 +0000656 StringPrinter::ReadBufferAndDumpToStream<element_type>(options);
Kate Stoneb9c1b512016-09-06 20:57:50 +0000657
658 return true;
659}
Shafik Yaghmour693fbf52018-10-26 17:00:48 +0000660
661bool lldb_private::formatters::LibcxxStringSummaryProviderASCII(
662 ValueObject &valobj, Stream &stream,
663 const TypeSummaryOptions &summary_options) {
664 return LibcxxStringSummaryProvider<StringPrinter::StringElementType::ASCII>(
665 valobj, stream, summary_options);
666}
667
668bool lldb_private::formatters::LibcxxStringSummaryProviderUTF16(
669 ValueObject &valobj, Stream &stream,
670 const TypeSummaryOptions &summary_options) {
671 return LibcxxStringSummaryProvider<StringPrinter::StringElementType::UTF16>(
672 valobj, stream, summary_options, "u");
673}
674
675bool lldb_private::formatters::LibcxxStringSummaryProviderUTF32(
676 ValueObject &valobj, Stream &stream,
677 const TypeSummaryOptions &summary_options) {
678 return LibcxxStringSummaryProvider<StringPrinter::StringElementType::UTF32>(
679 valobj, stream, summary_options, "U");
680}