LLDB  mainline
LibCxxVector.cpp
Go to the documentation of this file.
1 //===-- LibCxxVector.cpp --------------------------------------------------===//
2 //
3 // 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
6 //
7 //===----------------------------------------------------------------------===//
8 
9 #include "LibCxx.h"
10 
11 #include "lldb/Core/ValueObject.h"
14 
15 using namespace lldb;
16 using namespace lldb_private;
17 using namespace lldb_private::formatters;
18 
19 namespace lldb_private {
20 namespace formatters {
22 public:
23  LibcxxStdVectorSyntheticFrontEnd(lldb::ValueObjectSP valobj_sp);
24 
26 
27  size_t CalculateNumChildren() override;
28 
29  lldb::ValueObjectSP GetChildAtIndex(size_t idx) override;
30 
31  bool Update() override;
32 
33  bool MightHaveChildren() override;
34 
35  size_t GetIndexOfChildWithName(ConstString name) override;
36 
37 private:
42 };
43 
45 public:
46  LibcxxVectorBoolSyntheticFrontEnd(lldb::ValueObjectSP valobj_sp);
47 
48  size_t CalculateNumChildren() override;
49 
50  lldb::ValueObjectSP GetChildAtIndex(size_t idx) override;
51 
52  bool Update() override;
53 
54  bool MightHaveChildren() override { return true; }
55 
56  size_t GetIndexOfChildWithName(ConstString name) override;
57 
58 private:
61  uint64_t m_count;
63  std::map<size_t, lldb::ValueObjectSP> m_children;
64 };
65 
66 } // namespace formatters
67 } // namespace lldb_private
68 
70  LibcxxStdVectorSyntheticFrontEnd(lldb::ValueObjectSP valobj_sp)
71  : SyntheticChildrenFrontEnd(*valobj_sp), m_start(nullptr),
72  m_finish(nullptr), m_element_type(), m_element_size(0) {
73  if (valobj_sp)
74  Update();
75 }
76 
79  // these need to stay around because they are child objects who will follow
80  // their parent's life cycle
81  // delete m_start;
82  // delete m_finish;
83 }
84 
87  if (!m_start || !m_finish)
88  return 0;
89  uint64_t start_val = m_start->GetValueAsUnsigned(0);
90  uint64_t finish_val = m_finish->GetValueAsUnsigned(0);
91 
92  if (start_val == 0 || finish_val == 0)
93  return 0;
94 
95  if (start_val >= finish_val)
96  return 0;
97 
98  size_t num_children = (finish_val - start_val);
99  if (num_children % m_element_size)
100  return 0;
101  return num_children / m_element_size;
102 }
103 
104 lldb::ValueObjectSP
106  size_t idx) {
107  if (!m_start || !m_finish)
108  return lldb::ValueObjectSP();
109 
110  uint64_t offset = idx * m_element_size;
111  offset = offset + m_start->GetValueAsUnsigned(0);
112  StreamString name;
113  name.Printf("[%" PRIu64 "]", (uint64_t)idx);
114  return CreateValueObjectFromAddress(name.GetString(), offset,
115  m_backend.GetExecutionContextRef(),
116  m_element_type);
117 }
118 
120  m_start = m_finish = nullptr;
121  ValueObjectSP data_type_finder_sp(
122  m_backend.GetChildMemberWithName(ConstString("__end_cap_"), true));
123  if (!data_type_finder_sp)
124  return false;
125 
126  switch (data_type_finder_sp->GetCompilerType().GetNumDirectBaseClasses()) {
127  case 1:
128  // Assume a pre llvm r300140 __compressed_pair implementation:
129  data_type_finder_sp = data_type_finder_sp->GetChildMemberWithName(
130  ConstString("__first_"), true);
131  break;
132  case 2: {
133  // Assume a post llvm r300140 __compressed_pair implementation:
134  ValueObjectSP first_elem_parent_sp =
135  data_type_finder_sp->GetChildAtIndex(0, true);
136  data_type_finder_sp = first_elem_parent_sp->GetChildMemberWithName(
137  ConstString("__value_"), true);
138  break;
139  }
140  default:
141  return false;
142  }
143 
144  if (!data_type_finder_sp)
145  return false;
146  m_element_type = data_type_finder_sp->GetCompilerType().GetPointeeType();
147  if (llvm::Optional<uint64_t> size = m_element_type.GetByteSize(nullptr)) {
148  m_element_size = *size;
149 
150  if (m_element_size > 0) {
151  // store raw pointers or end up with a circular dependency
152  m_start =
153  m_backend.GetChildMemberWithName(ConstString("__begin_"), true).get();
154  m_finish =
155  m_backend.GetChildMemberWithName(ConstString("__end_"), true).get();
156  }
157  }
158  return false;
159 }
160 
163  return true;
164 }
165 
168  if (!m_start || !m_finish)
169  return UINT32_MAX;
170  return ExtractIndexFromString(name.GetCString());
171 }
172 
174  LibcxxVectorBoolSyntheticFrontEnd(lldb::ValueObjectSP valobj_sp)
175  : SyntheticChildrenFrontEnd(*valobj_sp), m_bool_type(), m_exe_ctx_ref(),
176  m_count(0), m_base_data_address(0), m_children() {
177  if (valobj_sp) {
178  Update();
179  m_bool_type =
180  valobj_sp->GetCompilerType().GetBasicTypeFromAST(lldb::eBasicTypeBool);
181  }
182 }
183 
186  return m_count;
187 }
188 
189 lldb::ValueObjectSP
191  size_t idx) {
192  auto iter = m_children.find(idx), end = m_children.end();
193  if (iter != end)
194  return iter->second;
195  if (idx >= m_count)
196  return {};
197  if (m_base_data_address == 0 || m_count == 0)
198  return {};
199  if (!m_bool_type)
200  return {};
201  size_t byte_idx = (idx >> 3); // divide by 8 to get byte index
202  size_t bit_index = (idx & 7); // efficient idx % 8 for bit index
203  lldb::addr_t byte_location = m_base_data_address + byte_idx;
204  ProcessSP process_sp(m_exe_ctx_ref.GetProcessSP());
205  if (!process_sp)
206  return {};
207  uint8_t byte = 0;
208  uint8_t mask = 0;
209  Status err;
210  size_t bytes_read = process_sp->ReadMemory(byte_location, &byte, 1, err);
211  if (err.Fail() || bytes_read == 0)
212  return {};
213  mask = 1 << bit_index;
214  bool bit_set = ((byte & mask) != 0);
215  llvm::Optional<uint64_t> size = m_bool_type.GetByteSize(nullptr);
216  if (!size)
217  return {};
218  DataBufferSP buffer_sp(new DataBufferHeap(*size, 0));
219  if (bit_set && buffer_sp && buffer_sp->GetBytes()) {
220  // regardless of endianness, anything non-zero is true
221  *(buffer_sp->GetBytes()) = 1;
222  }
223  StreamString name;
224  name.Printf("[%" PRIu64 "]", (uint64_t)idx);
225  ValueObjectSP retval_sp(CreateValueObjectFromData(
226  name.GetString(),
227  DataExtractor(buffer_sp, process_sp->GetByteOrder(),
228  process_sp->GetAddressByteSize()),
229  m_exe_ctx_ref, m_bool_type));
230  if (retval_sp)
231  m_children[idx] = retval_sp;
232  return retval_sp;
233 }
234 
235 /*(std::__1::vector<std::__1::allocator<bool> >) vBool = {
236  __begin_ = 0x00000001001000e0
237  __size_ = 56
238  __cap_alloc_ = {
239  std::__1::__libcpp_compressed_pair_imp<unsigned long,
240  std::__1::allocator<unsigned long> > = {
241  __first_ = 1
242  }
243  }
244  }*/
245 
247  m_children.clear();
248  ValueObjectSP valobj_sp = m_backend.GetSP();
249  if (!valobj_sp)
250  return false;
251  m_exe_ctx_ref = valobj_sp->GetExecutionContextRef();
252  ValueObjectSP size_sp(
253  valobj_sp->GetChildMemberWithName(ConstString("__size_"), true));
254  if (!size_sp)
255  return false;
256  m_count = size_sp->GetValueAsUnsigned(0);
257  if (!m_count)
258  return true;
259  ValueObjectSP begin_sp(
260  valobj_sp->GetChildMemberWithName(ConstString("__begin_"), true));
261  if (!begin_sp) {
262  m_count = 0;
263  return false;
264  }
265  m_base_data_address = begin_sp->GetValueAsUnsigned(0);
266  if (!m_base_data_address) {
267  m_count = 0;
268  return false;
269  }
270  return false;
271 }
272 
275  if (!m_count || !m_base_data_address)
276  return UINT32_MAX;
277  const char *item_name = name.GetCString();
278  uint32_t idx = ExtractIndexFromString(item_name);
279  if (idx < UINT32_MAX && idx >= CalculateNumChildren())
280  return UINT32_MAX;
281  return idx;
282 }
283 
286  CXXSyntheticChildren *, lldb::ValueObjectSP valobj_sp) {
287  if (!valobj_sp)
288  return nullptr;
289  CompilerType type = valobj_sp->GetCompilerType();
290  if (!type.IsValid() || type.GetNumTemplateArguments() == 0)
291  return nullptr;
292  CompilerType arg_type = type.GetTypeTemplateArgument(0);
293  if (arg_type.GetTypeName() == "bool")
294  return new LibcxxVectorBoolSyntheticFrontEnd(valobj_sp);
295  return new LibcxxStdVectorSyntheticFrontEnd(valobj_sp);
296 }
lldb_private::formatters::LibcxxStdVectorSyntheticFrontEnd::m_element_type
CompilerType m_element_type
Definition: LibCxxVector.cpp:40
lldb_private::formatters::LibcxxVectorBoolSyntheticFrontEnd::GetChildAtIndex
lldb::ValueObjectSP GetChildAtIndex(size_t idx) override
Definition: LibCxxVector.cpp:190
lldb::eBasicTypeBool
@ eBasicTypeBool
Definition: lldb-enumerations.h:762
lldb_private::CompilerType::GetNumTemplateArguments
size_t GetNumTemplateArguments() const
Definition: CompilerType.cpp:662
lldb_private::formatters::LibcxxVectorBoolSyntheticFrontEnd::CalculateNumChildren
size_t CalculateNumChildren() override
Definition: LibCxxVector.cpp:185
lldb_private::formatters::LibcxxVectorBoolSyntheticFrontEnd::m_children
std::map< size_t, lldb::ValueObjectSP > m_children
Definition: LibCxxVector.cpp:63
CalculateNumChildren
static size_t CalculateNumChildren(CompilerType container_type, CompilerType element_type, lldb_private::ExecutionContextScope *exe_scope=nullptr)
Definition: VectorType.cpp:169
lldb_private::formatters::LibcxxVectorBoolSyntheticFrontEnd::m_count
uint64_t m_count
Definition: LibCxxVector.cpp:61
lldb_private::SyntheticChildrenFrontEnd
Definition: TypeSynthetic.h:27
lldb_private::formatters::LibcxxStdVectorSyntheticFrontEnd::m_start
ValueObject * m_start
Definition: LibCxxVector.cpp:38
lldb::addr_t
uint64_t addr_t
Definition: lldb-types.h:83
lldb_private::StreamString::GetString
llvm::StringRef GetString() const
Definition: StreamString.cpp:51
lldb_private::formatters::LibcxxStdVectorSyntheticFrontEnd::GetChildAtIndex
lldb::ValueObjectSP GetChildAtIndex(size_t idx) override
Definition: LibCxxVector.cpp:105
lldb_private::formatters::LibcxxVectorBoolSyntheticFrontEnd::Update
bool Update() override
Definition: LibCxxVector.cpp:246
lldb_private::CompilerType::GetTypeTemplateArgument
CompilerType GetTypeTemplateArgument(size_t idx) const
Definition: CompilerType.cpp:675
lldb_private::formatters::LibcxxStdVectorSyntheticFrontEndCreator
SyntheticChildrenFrontEnd * LibcxxStdVectorSyntheticFrontEndCreator(CXXSyntheticChildren *, lldb::ValueObjectSP)
Definition: LibCxxVector.cpp:285
lldb_private::DataExtractor
Definition: DataExtractor.h:48
lldb_private::Status::Fail
bool Fail() const
Test for error condition.
Definition: Status.cpp:182
lldb_private::ConstString
Definition: ConstString.h:40
lldb_private::formatters::LibcxxVectorBoolSyntheticFrontEnd::MightHaveChildren
bool MightHaveChildren() override
Definition: LibCxxVector.cpp:54
lldb_private::StreamString
Definition: StreamString.h:23
lldb_private::formatters::LibcxxStdVectorSyntheticFrontEnd::CalculateNumChildren
size_t CalculateNumChildren() override
Definition: LibCxxVector.cpp:86
lldb_private::formatters::LibcxxVectorBoolSyntheticFrontEnd
Definition: LibCxxVector.cpp:44
lldb_private::formatters::LibcxxStdVectorSyntheticFrontEnd::LibcxxStdVectorSyntheticFrontEnd
LibcxxStdVectorSyntheticFrontEnd(lldb::ValueObjectSP valobj_sp)
Definition: LibCxxVector.cpp:70
lldb_private::formatters::LibcxxVectorBoolSyntheticFrontEnd::m_exe_ctx_ref
ExecutionContextRef m_exe_ctx_ref
Definition: LibCxxVector.cpp:60
lldb_private::formatters::LibcxxStdVectorSyntheticFrontEnd
Definition: LibCxxVector.cpp:21
lldb_private::CompilerType::IsValid
bool IsValid() const
Definition: CompilerType.h:72
ValueObject.h
lldb_private::formatters::LibcxxVectorBoolSyntheticFrontEnd::m_bool_type
CompilerType m_bool_type
Definition: LibCxxVector.cpp:59
lldb_private::formatters::LibcxxStdVectorSyntheticFrontEnd::MightHaveChildren
bool MightHaveChildren() override
Definition: LibCxxVector.cpp:162
lldb_private::Status
Definition: Status.h:44
lldb_private::ValueObject
ValueObject:
Definition: ValueObject.h:105
uint32_t
lldb_private::CompilerType::GetTypeName
ConstString GetTypeName() const
Definition: CompilerType.cpp:277
UINT32_MAX
#define UINT32_MAX
Definition: lldb-defines.h:31
lldb_private::formatters::LibcxxStdVectorSyntheticFrontEnd::Update
bool Update() override
Definition: LibCxxVector.cpp:119
lldb_private::ConstString::GetCString
const char * GetCString() const
Get the string value as a C string.
Definition: ConstString.h:216
lldb_private::CompilerType::GetBasicTypeFromAST
CompilerType GetBasicTypeFromAST(lldb::BasicType basic_type) const
Create related types using the current type's AST.
Definition: CompilerType.cpp:474
lldb_private::CompilerType
Generic representation of a type in a programming language.
Definition: CompilerType.h:33
lldb_private::Stream::Printf
size_t Printf(const char *format,...) __attribute__((format(printf
Output printf formatted output to the stream.
Definition: Stream.cpp:107
lldb_private::formatters::LibcxxStdVectorSyntheticFrontEnd::GetIndexOfChildWithName
size_t GetIndexOfChildWithName(ConstString name) override
Definition: LibCxxVector.cpp:167
lldb_private::formatters
Definition: CXXFunctionPointer.h:15
lldb_private
A class that represents a running process on the host machine.
Definition: SBCommandInterpreterRunOptions.h:16
LibCxx.h
ConstString.h
lldb_private::formatters::LibcxxStdVectorSyntheticFrontEnd::m_element_size
uint32_t m_element_size
Definition: LibCxxVector.cpp:41
lldb_private::CXXSyntheticChildren
Definition: TypeSynthetic.h:358
lldb_private::formatters::LibcxxStdVectorSyntheticFrontEnd::m_finish
ValueObject * m_finish
Definition: LibCxxVector.cpp:39
lldb_private::formatters::LibcxxVectorBoolSyntheticFrontEnd::LibcxxVectorBoolSyntheticFrontEnd
LibcxxVectorBoolSyntheticFrontEnd(lldb::ValueObjectSP valobj_sp)
Definition: LibCxxVector.cpp:174
FormattersHelpers.h
lldb_private::DataBufferHeap
Definition: DataBufferHeap.h:30
lldb_private::formatters::LibcxxVectorBoolSyntheticFrontEnd::GetIndexOfChildWithName
size_t GetIndexOfChildWithName(ConstString name) override
Definition: LibCxxVector.cpp:274
lldb
Definition: SBAddress.h:15
lldb_private::ExecutionContextRef
Execution context objects refer to objects in the execution of the program that is being debugged.
Definition: ExecutionContext.h:72
lldb_private::formatters::ExtractIndexFromString
size_t ExtractIndexFromString(const char *item_name)
Definition: FormattersHelpers.cpp:119
lldb_private::formatters::LibcxxStdVectorSyntheticFrontEnd::~LibcxxStdVectorSyntheticFrontEnd
~LibcxxStdVectorSyntheticFrontEnd() override
Definition: LibCxxVector.cpp:78
lldb_private::formatters::LibcxxVectorBoolSyntheticFrontEnd::m_base_data_address
lldb::addr_t m_base_data_address
Definition: LibCxxVector.cpp:62