Eugene Zelenko | 8d15f33 | 2015-10-20 01:10:59 +0000 | [diff] [blame] | 1 | //===-- LibCxxVector.cpp ----------------------------------------*- C++ -*-===// |
Enrico Granata | e85fe3a | 2014-10-22 20:34:38 +0000 | [diff] [blame] | 2 | // |
Chandler Carruth | 2946cd7 | 2019-01-19 08:50:56 +0000 | [diff] [blame] | 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 |
Enrico Granata | e85fe3a | 2014-10-22 20:34:38 +0000 | [diff] [blame] | 6 | // |
| 7 | //===----------------------------------------------------------------------===// |
| 8 | |
Enrico Granata | 33e97e6 | 2015-09-04 21:01:18 +0000 | [diff] [blame] | 9 | #include "LibCxx.h" |
Enrico Granata | e85fe3a | 2014-10-22 20:34:38 +0000 | [diff] [blame] | 10 | |
Enrico Granata | e85fe3a | 2014-10-22 20:34:38 +0000 | [diff] [blame] | 11 | #include "lldb/Core/ValueObject.h" |
Enrico Granata | 419d791 | 2015-09-04 00:33:51 +0000 | [diff] [blame] | 12 | #include "lldb/DataFormatters/FormattersHelpers.h" |
Zachary Turner | bf9a773 | 2017-02-02 21:39:50 +0000 | [diff] [blame] | 13 | #include "lldb/Utility/ConstString.h" |
Enrico Granata | e85fe3a | 2014-10-22 20:34:38 +0000 | [diff] [blame] | 14 | |
| 15 | using namespace lldb; |
| 16 | using namespace lldb_private; |
| 17 | using namespace lldb_private::formatters; |
| 18 | |
| 19 | namespace lldb_private { |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 20 | namespace formatters { |
| 21 | class LibcxxStdVectorSyntheticFrontEnd : public SyntheticChildrenFrontEnd { |
| 22 | public: |
| 23 | LibcxxStdVectorSyntheticFrontEnd(lldb::ValueObjectSP valobj_sp); |
Eugene Zelenko | 8d15f33 | 2015-10-20 01:10:59 +0000 | [diff] [blame] | 24 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 25 | ~LibcxxStdVectorSyntheticFrontEnd() override; |
Eugene Zelenko | 8d15f33 | 2015-10-20 01:10:59 +0000 | [diff] [blame] | 26 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 27 | size_t CalculateNumChildren() override; |
Eugene Zelenko | 8d15f33 | 2015-10-20 01:10:59 +0000 | [diff] [blame] | 28 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 29 | lldb::ValueObjectSP GetChildAtIndex(size_t idx) override; |
| 30 | |
| 31 | bool Update() override; |
| 32 | |
| 33 | bool MightHaveChildren() override; |
| 34 | |
Adrian Prantl | 0e4c482 | 2019-03-06 21:22:25 +0000 | [diff] [blame] | 35 | size_t GetIndexOfChildWithName(ConstString name) override; |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 36 | |
| 37 | private: |
| 38 | ValueObject *m_start; |
| 39 | ValueObject *m_finish; |
| 40 | CompilerType m_element_type; |
| 41 | uint32_t m_element_size; |
| 42 | }; |
Pavel Labath | d3656a0 | 2017-04-12 10:59:24 +0000 | [diff] [blame] | 43 | |
| 44 | class LibcxxVectorBoolSyntheticFrontEnd : public SyntheticChildrenFrontEnd { |
| 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 | |
Adrian Prantl | 0e4c482 | 2019-03-06 21:22:25 +0000 | [diff] [blame] | 56 | size_t GetIndexOfChildWithName(ConstString name) override; |
Pavel Labath | d3656a0 | 2017-04-12 10:59:24 +0000 | [diff] [blame] | 57 | |
| 58 | private: |
| 59 | CompilerType m_bool_type; |
| 60 | ExecutionContextRef m_exe_ctx_ref; |
| 61 | uint64_t m_count; |
| 62 | lldb::addr_t m_base_data_address; |
| 63 | std::map<size_t, lldb::ValueObjectSP> m_children; |
| 64 | }; |
| 65 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 66 | } // namespace formatters |
Eugene Zelenko | 8d15f33 | 2015-10-20 01:10:59 +0000 | [diff] [blame] | 67 | } // namespace lldb_private |
Enrico Granata | e85fe3a | 2014-10-22 20:34:38 +0000 | [diff] [blame] | 68 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 69 | lldb_private::formatters::LibcxxStdVectorSyntheticFrontEnd:: |
| 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(); |
Enrico Granata | e85fe3a | 2014-10-22 20:34:38 +0000 | [diff] [blame] | 75 | } |
| 76 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 77 | lldb_private::formatters::LibcxxStdVectorSyntheticFrontEnd:: |
| 78 | ~LibcxxStdVectorSyntheticFrontEnd() { |
| 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; |
Eugene Zelenko | 8d15f33 | 2015-10-20 01:10:59 +0000 | [diff] [blame] | 83 | } |
| 84 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 85 | size_t lldb_private::formatters::LibcxxStdVectorSyntheticFrontEnd:: |
| 86 | CalculateNumChildren() { |
| 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; |
Enrico Granata | e85fe3a | 2014-10-22 20:34:38 +0000 | [diff] [blame] | 102 | } |
| 103 | |
| 104 | lldb::ValueObjectSP |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 105 | lldb_private::formatters::LibcxxStdVectorSyntheticFrontEnd::GetChildAtIndex( |
| 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); |
Zachary Turner | c156427 | 2016-11-16 21:15:24 +0000 | [diff] [blame] | 114 | return CreateValueObjectFromAddress(name.GetString(), offset, |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 115 | m_backend.GetExecutionContextRef(), |
| 116 | m_element_type); |
Enrico Granata | e85fe3a | 2014-10-22 20:34:38 +0000 | [diff] [blame] | 117 | } |
| 118 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 119 | bool lldb_private::formatters::LibcxxStdVectorSyntheticFrontEnd::Update() { |
| 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) |
Enrico Granata | e85fe3a | 2014-10-22 20:34:38 +0000 | [diff] [blame] | 124 | return false; |
Lang Hames | 6cc3354 | 2017-04-26 23:29:59 +0000 | [diff] [blame] | 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( |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 130 | ConstString("__first_"), true); |
Lang Hames | 6cc3354 | 2017-04-26 23:29:59 +0000 | [diff] [blame] | 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 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 144 | if (!data_type_finder_sp) |
| 145 | return false; |
| 146 | m_element_type = data_type_finder_sp->GetCompilerType().GetPointeeType(); |
Adrian Prantl | d6a9bbf | 2019-01-15 20:33:58 +0000 | [diff] [blame] | 147 | if (llvm::Optional<uint64_t> size = m_element_type.GetByteSize(nullptr)) { |
Adrian Prantl | d963a7c | 2019-01-15 18:07:52 +0000 | [diff] [blame] | 148 | m_element_size = *size; |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 149 | |
Adrian Prantl | d963a7c | 2019-01-15 18:07:52 +0000 | [diff] [blame] | 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 | } |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 157 | } |
| 158 | return false; |
Enrico Granata | e85fe3a | 2014-10-22 20:34:38 +0000 | [diff] [blame] | 159 | } |
| 160 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 161 | bool lldb_private::formatters::LibcxxStdVectorSyntheticFrontEnd:: |
| 162 | MightHaveChildren() { |
| 163 | return true; |
Enrico Granata | e85fe3a | 2014-10-22 20:34:38 +0000 | [diff] [blame] | 164 | } |
| 165 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 166 | size_t lldb_private::formatters::LibcxxStdVectorSyntheticFrontEnd:: |
Adrian Prantl | 0e4c482 | 2019-03-06 21:22:25 +0000 | [diff] [blame] | 167 | GetIndexOfChildWithName(ConstString name) { |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 168 | if (!m_start || !m_finish) |
| 169 | return UINT32_MAX; |
| 170 | return ExtractIndexFromString(name.GetCString()); |
Enrico Granata | e85fe3a | 2014-10-22 20:34:38 +0000 | [diff] [blame] | 171 | } |
| 172 | |
Pavel Labath | d3656a0 | 2017-04-12 10:59:24 +0000 | [diff] [blame] | 173 | lldb_private::formatters::LibcxxVectorBoolSyntheticFrontEnd:: |
| 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 | |
| 184 | size_t lldb_private::formatters::LibcxxVectorBoolSyntheticFrontEnd:: |
| 185 | CalculateNumChildren() { |
| 186 | return m_count; |
| 187 | } |
| 188 | |
| 189 | lldb::ValueObjectSP |
| 190 | lldb_private::formatters::LibcxxVectorBoolSyntheticFrontEnd::GetChildAtIndex( |
| 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) |
Adrian Prantl | d963a7c | 2019-01-15 18:07:52 +0000 | [diff] [blame] | 196 | return {}; |
Pavel Labath | d3656a0 | 2017-04-12 10:59:24 +0000 | [diff] [blame] | 197 | if (m_base_data_address == 0 || m_count == 0) |
Adrian Prantl | d963a7c | 2019-01-15 18:07:52 +0000 | [diff] [blame] | 198 | return {}; |
Pavel Labath | d3656a0 | 2017-04-12 10:59:24 +0000 | [diff] [blame] | 199 | if (!m_bool_type) |
Adrian Prantl | d963a7c | 2019-01-15 18:07:52 +0000 | [diff] [blame] | 200 | return {}; |
Pavel Labath | d3656a0 | 2017-04-12 10:59:24 +0000 | [diff] [blame] | 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) |
Adrian Prantl | d963a7c | 2019-01-15 18:07:52 +0000 | [diff] [blame] | 206 | return {}; |
Pavel Labath | d3656a0 | 2017-04-12 10:59:24 +0000 | [diff] [blame] | 207 | uint8_t byte = 0; |
| 208 | uint8_t mask = 0; |
Zachary Turner | 97206d5 | 2017-05-12 04:51:55 +0000 | [diff] [blame] | 209 | Status err; |
Pavel Labath | d3656a0 | 2017-04-12 10:59:24 +0000 | [diff] [blame] | 210 | size_t bytes_read = process_sp->ReadMemory(byte_location, &byte, 1, err); |
| 211 | if (err.Fail() || bytes_read == 0) |
Adrian Prantl | d963a7c | 2019-01-15 18:07:52 +0000 | [diff] [blame] | 212 | return {}; |
Pavel Labath | d3656a0 | 2017-04-12 10:59:24 +0000 | [diff] [blame] | 213 | mask = 1 << bit_index; |
| 214 | bool bit_set = ((byte & mask) != 0); |
Adrian Prantl | d6a9bbf | 2019-01-15 20:33:58 +0000 | [diff] [blame] | 215 | llvm::Optional<uint64_t> size = m_bool_type.GetByteSize(nullptr); |
Adrian Prantl | d963a7c | 2019-01-15 18:07:52 +0000 | [diff] [blame] | 216 | if (!size) |
| 217 | return {}; |
| 218 | DataBufferSP buffer_sp(new DataBufferHeap(*size, 0)); |
Pavel Labath | d3656a0 | 2017-04-12 10:59:24 +0000 | [diff] [blame] | 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 | |
| 246 | bool lldb_private::formatters::LibcxxVectorBoolSyntheticFrontEnd::Update() { |
| 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 | |
| 273 | size_t lldb_private::formatters::LibcxxVectorBoolSyntheticFrontEnd:: |
Adrian Prantl | 0e4c482 | 2019-03-06 21:22:25 +0000 | [diff] [blame] | 274 | GetIndexOfChildWithName(ConstString name) { |
Pavel Labath | d3656a0 | 2017-04-12 10:59:24 +0000 | [diff] [blame] | 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 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 284 | lldb_private::SyntheticChildrenFrontEnd * |
| 285 | lldb_private::formatters::LibcxxStdVectorSyntheticFrontEndCreator( |
| 286 | CXXSyntheticChildren *, lldb::ValueObjectSP valobj_sp) { |
Pavel Labath | d3656a0 | 2017-04-12 10:59:24 +0000 | [diff] [blame] | 287 | if (!valobj_sp) |
| 288 | return nullptr; |
| 289 | CompilerType type = valobj_sp->GetCompilerType(); |
| 290 | if (!type.IsValid() || type.GetNumTemplateArguments() == 0) |
| 291 | return nullptr; |
Pavel Labath | 769b21e | 2017-11-13 14:26:21 +0000 | [diff] [blame] | 292 | CompilerType arg_type = type.GetTypeTemplateArgument(0); |
Raphael Isemann | 05cfdb0 | 2019-04-26 07:21:36 +0000 | [diff] [blame^] | 293 | if (arg_type.GetTypeName() == "bool") |
Pavel Labath | d3656a0 | 2017-04-12 10:59:24 +0000 | [diff] [blame] | 294 | return new LibcxxVectorBoolSyntheticFrontEnd(valobj_sp); |
| 295 | return new LibcxxStdVectorSyntheticFrontEnd(valobj_sp); |
Enrico Granata | e85fe3a | 2014-10-22 20:34:38 +0000 | [diff] [blame] | 296 | } |