LLDB  mainline
DWARFUnit.cpp
Go to the documentation of this file.
1 //===-- DWARFUnit.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 "DWARFUnit.h"
10 
11 #include "lldb/Core/Module.h"
12 #include "lldb/Symbol/ObjectFile.h"
15 #include "lldb/Utility/Timer.h"
16 #include "llvm/Object/Error.h"
17 
18 #include "DWARFCompileUnit.h"
19 #include "DWARFDebugAranges.h"
20 #include "DWARFDebugInfo.h"
21 #include "DWARFTypeUnit.h"
22 #include "LogChannelDWARF.h"
23 #include "SymbolFileDWARFDwo.h"
24 
25 using namespace lldb;
26 using namespace lldb_private;
27 using namespace std;
28 
29 extern int g_verbose;
30 
32  const DWARFUnitHeader &header,
33  const DWARFAbbreviationDeclarationSet &abbrevs,
34  DIERef::Section section, bool is_dwo)
35  : UserID(uid), m_dwarf(dwarf), m_header(header), m_abbrevs(&abbrevs),
36  m_cancel_scopes(false), m_section(section), m_is_dwo(is_dwo),
38 
39 DWARFUnit::~DWARFUnit() = default;
40 
41 // Parses first DIE of a compile unit, excluding DWO.
43  {
44  llvm::sys::ScopedReader lock(m_first_die_mutex);
45  if (m_first_die)
46  return; // Already parsed
47  }
48  llvm::sys::ScopedWriter lock(m_first_die_mutex);
49  if (m_first_die)
50  return; // Already parsed
51 
53  LLDB_SCOPED_TIMERF("%8.8x: DWARFUnit::ExtractUnitDIENoDwoIfNeeded()",
54  GetOffset());
55 
56  // Set the offset to that of the first DIE and calculate the start of the
57  // next compilation unit header.
59 
60  // We are in our compile unit, parse starting at the offset we were told to
61  // parse
62  const DWARFDataExtractor &data = GetData();
63  if (offset < GetNextUnitOffset() &&
64  m_first_die.Extract(data, this, &offset)) {
66  return;
67  }
68 }
69 
70 // Parses first DIE of a compile unit including DWO.
73 
75  return;
76 
78 
79  std::shared_ptr<SymbolFileDWARFDwo> dwo_symbol_file =
81  if (!dwo_symbol_file)
82  return;
83 
84  DWARFUnit *dwo_cu = dwo_symbol_file->GetDWOCompileUnitForHash(m_dwo_id);
85 
86  if (!dwo_cu)
87  return; // Can't fetch the compile unit from the dwo file.
88  dwo_cu->SetUserData(this);
89 
90  DWARFBaseDIE dwo_cu_die = dwo_cu->GetUnitDIEOnly();
91  if (!dwo_cu_die.IsValid())
92  return; // Can't fetch the compile unit DIE from the dwo file.
93 
94  // Here for DWO CU we want to use the address base set in the skeleton unit
95  // (DW_AT_addr_base) if it is available and use the DW_AT_GNU_addr_base
96  // otherwise. We do that because pre-DWARF v5 could use the DW_AT_GNU_*
97  // attributes which were applicable to the DWO units. The corresponding
98  // DW_AT_* attributes standardized in DWARF v5 are also applicable to the
99  // main unit in contrast.
100  if (m_addr_base)
101  dwo_cu->SetAddrBase(*m_addr_base);
102  else if (m_gnu_addr_base)
103  dwo_cu->SetAddrBase(*m_gnu_addr_base);
104 
105  if (GetVersion() <= 4 && m_gnu_ranges_base)
107  else if (dwo_symbol_file->GetDWARFContext()
108  .getOrLoadRngListsData()
109  .GetByteSize() > 0)
110  dwo_cu->SetRangesBase(llvm::DWARFListTableHeader::getHeaderSize(DWARF32));
111 
112  if (GetVersion() >= 5 &&
113  dwo_symbol_file->GetDWARFContext().getOrLoadLocListsData().GetByteSize() >
114  0)
115  dwo_cu->SetLoclistsBase(llvm::DWARFListTableHeader::getHeaderSize(DWARF32));
116 
117  dwo_cu->SetBaseAddress(GetBaseAddress());
118 
119  m_dwo = std::shared_ptr<DWARFUnit>(std::move(dwo_symbol_file), dwo_cu);
120 }
121 
122 // Parses a compile unit and indexes its DIEs if it hasn't already been done.
123 // It will leave this compile unit extracted forever.
125  m_cancel_scopes = true;
126 
127  {
128  llvm::sys::ScopedReader lock(m_die_array_mutex);
129  if (!m_die_array.empty())
130  return; // Already parsed
131  }
132  llvm::sys::ScopedWriter lock(m_die_array_mutex);
133  if (!m_die_array.empty())
134  return; // Already parsed
135 
137 }
138 
139 // Parses a compile unit and indexes its DIEs if it hasn't already been done.
140 // It will clear this compile unit after returned instance gets out of scope,
141 // no other ScopedExtractDIEs instance is running for this compile unit
142 // and no ExtractDIEsIfNeeded() has been executed during this ScopedExtractDIEs
143 // lifetime.
145  ScopedExtractDIEs scoped(*this);
146 
147  {
148  llvm::sys::ScopedReader lock(m_die_array_mutex);
149  if (!m_die_array.empty())
150  return scoped; // Already parsed
151  }
152  llvm::sys::ScopedWriter lock(m_die_array_mutex);
153  if (!m_die_array.empty())
154  return scoped; // Already parsed
155 
156  // Otherwise m_die_array would be already populated.
158 
160  scoped.m_clear_dies = true;
161  return scoped;
162 }
163 
165  m_cu->m_die_array_scoped_mutex.lock_shared();
166 }
167 
169  if (!m_cu)
170  return;
171  m_cu->m_die_array_scoped_mutex.unlock_shared();
172  if (!m_clear_dies || m_cu->m_cancel_scopes)
173  return;
174  // Be sure no other ScopedExtractDIEs is running anymore.
175  llvm::sys::ScopedWriter lock_scoped(m_cu->m_die_array_scoped_mutex);
176  llvm::sys::ScopedWriter lock(m_cu->m_die_array_mutex);
177  if (m_cu->m_cancel_scopes)
178  return;
179  m_cu->ClearDIEsRWLocked();
180 }
181 
183  : m_cu(rhs.m_cu), m_clear_dies(rhs.m_clear_dies) {
184  rhs.m_cu = nullptr;
185 }
186 
189  m_cu = rhs.m_cu;
190  rhs.m_cu = nullptr;
191  m_clear_dies = rhs.m_clear_dies;
192  return *this;
193 }
194 
195 // Parses a compile unit and indexes its DIEs, m_die_array_mutex must be
196 // held R/W and m_die_array must be empty.
198  llvm::sys::ScopedWriter first_die_lock(m_first_die_mutex);
199 
201  LLDB_SCOPED_TIMERF("%8.8x: DWARFUnit::ExtractDIEsIfNeeded()", GetOffset());
202 
203  // Set the offset to that of the first DIE and calculate the start of the
204  // next compilation unit header.
206  lldb::offset_t next_cu_offset = GetNextUnitOffset();
207 
209 
210  uint32_t depth = 0;
211  // We are in our compile unit, parse starting at the offset we were told to
212  // parse
213  const DWARFDataExtractor &data = GetData();
214  std::vector<uint32_t> die_index_stack;
215  die_index_stack.reserve(32);
216  die_index_stack.push_back(0);
217  bool prev_die_had_children = false;
218  while (offset < next_cu_offset && die.Extract(data, this, &offset)) {
219  const bool null_die = die.IsNULL();
220  if (depth == 0) {
221  assert(m_die_array.empty() && "Compile unit DIE already added");
222 
223  // The average bytes per DIE entry has been seen to be around 14-20 so
224  // lets pre-reserve half of that since we are now stripping the NULL
225  // tags.
226 
227  // Only reserve the memory if we are adding children of the main
228  // compile unit DIE. The compile unit DIE is always the first entry, so
229  // if our size is 1, then we are adding the first compile unit child
230  // DIE and should reserve the memory.
231  m_die_array.reserve(GetDebugInfoSize() / 24);
232  m_die_array.push_back(die);
233 
234  if (!m_first_die)
235  AddUnitDIE(m_die_array.front());
236 
237  // With -fsplit-dwarf-inlining, clang will emit non-empty skeleton compile
238  // units. We are not able to access these DIE *and* the dwo file
239  // simultaneously. We also don't need to do that as the dwo file will
240  // contain a superset of information. So, we don't even attempt to parse
241  // any remaining DIEs.
242  if (m_dwo) {
243  m_die_array.front().SetHasChildren(false);
244  break;
245  }
246 
247  } else {
248  if (null_die) {
249  if (prev_die_had_children) {
250  // This will only happen if a DIE says is has children but all it
251  // contains is a NULL tag. Since we are removing the NULL DIEs from
252  // the list (saves up to 25% in C++ code), we need a way to let the
253  // DIE know that it actually doesn't have children.
254  if (!m_die_array.empty())
255  m_die_array.back().SetHasChildren(false);
256  }
257  } else {
258  die.SetParentIndex(m_die_array.size() - die_index_stack[depth - 1]);
259 
260  if (die_index_stack.back())
261  m_die_array[die_index_stack.back()].SetSiblingIndex(
262  m_die_array.size() - die_index_stack.back());
263 
264  // Only push the DIE if it isn't a NULL DIE
265  m_die_array.push_back(die);
266  }
267  }
268 
269  if (null_die) {
270  // NULL DIE.
271  if (!die_index_stack.empty())
272  die_index_stack.pop_back();
273 
274  if (depth > 0)
275  --depth;
276  prev_die_had_children = false;
277  } else {
278  die_index_stack.back() = m_die_array.size() - 1;
279  // Normal DIE
280  const bool die_has_children = die.HasChildren();
281  if (die_has_children) {
282  die_index_stack.push_back(0);
283  ++depth;
284  }
285  prev_die_had_children = die_has_children;
286  }
287 
288  if (depth == 0)
289  break; // We are done with this compile unit!
290  }
291 
292  if (!m_die_array.empty()) {
293  // The last die cannot have children (if it did, it wouldn't be the last one).
294  // This only makes a difference for malformed dwarf that does not have a
295  // terminating null die.
296  m_die_array.back().SetHasChildren(false);
297 
298  if (m_first_die) {
299  // Only needed for the assertion.
300  m_first_die.SetHasChildren(m_die_array.front().HasChildren());
301  lldbassert(m_first_die == m_die_array.front());
302  }
303  m_first_die = m_die_array.front();
304  }
305 
306  m_die_array.shrink_to_fit();
307 
308  if (m_dwo)
309  m_dwo->ExtractDIEsIfNeeded();
310 }
311 
312 // This is used when a split dwarf is enabled.
313 // A skeleton compilation unit may contain the DW_AT_str_offsets_base attribute
314 // that points to the first string offset of the CU contribution to the
315 // .debug_str_offsets. At the same time, the corresponding split debug unit also
316 // may use DW_FORM_strx* forms pointing to its own .debug_str_offsets.dwo and
317 // for that case, we should find the offset (skip the section header).
319  lldb::offset_t baseOffset = 0;
320 
321  if (const llvm::DWARFUnitIndex::Entry *entry = m_header.GetIndexEntry()) {
322  if (const auto *contribution =
323  entry->getContribution(llvm::DW_SECT_STR_OFFSETS))
324  baseOffset = contribution->Offset;
325  else
326  return;
327  }
328 
329  if (GetVersion() >= 5) {
330  const DWARFDataExtractor &strOffsets =
332  uint64_t length = strOffsets.GetU32(&baseOffset);
333  if (length == 0xffffffff)
334  length = strOffsets.GetU64(&baseOffset);
335 
336  // Check version.
337  if (strOffsets.GetU16(&baseOffset) < 5)
338  return;
339 
340  // Skip padding.
341  baseOffset += 2;
342  }
343 
344  SetStrOffsetsBase(baseOffset);
345 }
346 
349  return m_dwo_id;
350 }
351 
352 // m_die_array_mutex must be already held as read/write.
354  DWARFAttributes attributes;
355  size_t num_attributes = cu_die.GetAttributes(this, attributes);
356 
357  // Extract DW_AT_addr_base first, as other attributes may need it.
358  for (size_t i = 0; i < num_attributes; ++i) {
359  if (attributes.AttributeAtIndex(i) != DW_AT_addr_base)
360  continue;
361  DWARFFormValue form_value;
362  if (attributes.ExtractFormValueAtIndex(i, form_value)) {
363  SetAddrBase(form_value.Unsigned());
364  break;
365  }
366  }
367 
368  for (size_t i = 0; i < num_attributes; ++i) {
369  dw_attr_t attr = attributes.AttributeAtIndex(i);
370  DWARFFormValue form_value;
371  if (!attributes.ExtractFormValueAtIndex(i, form_value))
372  continue;
373  switch (attr) {
374  case DW_AT_loclists_base:
375  SetLoclistsBase(form_value.Unsigned());
376  break;
377  case DW_AT_rnglists_base:
378  SetRangesBase(form_value.Unsigned());
379  break;
380  case DW_AT_str_offsets_base:
381  SetStrOffsetsBase(form_value.Unsigned());
382  break;
383  case DW_AT_low_pc:
384  SetBaseAddress(form_value.Address());
385  break;
386  case DW_AT_entry_pc:
387  // If the value was already set by DW_AT_low_pc, don't update it.
389  SetBaseAddress(form_value.Address());
390  break;
391  case DW_AT_stmt_list:
392  m_line_table_offset = form_value.Unsigned();
393  break;
394  case DW_AT_GNU_addr_base:
395  m_gnu_addr_base = form_value.Unsigned();
396  break;
397  case DW_AT_GNU_ranges_base:
398  m_gnu_ranges_base = form_value.Unsigned();
399  break;
400  case DW_AT_GNU_dwo_id:
401  m_dwo_id = form_value.Unsigned();
402  break;
403  }
404  }
405 
406  if (m_is_dwo) {
409  return;
410  }
411 }
412 
415 }
416 
418  return m_abbrevs;
419 }
420 
423 }
424 
427  return m_line_table_offset;
428 }
429 
430 void DWARFUnit::SetAddrBase(dw_addr_t addr_base) { m_addr_base = addr_base; }
431 
432 // Parse the rangelist table header, including the optional array of offsets
433 // following it (DWARF v5 and later).
434 template <typename ListTableType>
435 static llvm::Expected<ListTableType>
436 ParseListTableHeader(const llvm::DWARFDataExtractor &data, uint64_t offset,
437  DwarfFormat format) {
438  // We are expected to be called with Offset 0 or pointing just past the table
439  // header. Correct Offset in the latter case so that it points to the start
440  // of the header.
441  if (offset == 0) {
442  // This means DW_AT_rnglists_base is missing and therefore DW_FORM_rnglistx
443  // cannot be handled. Returning a default-constructed ListTableType allows
444  // DW_FORM_sec_offset to be supported.
445  return ListTableType();
446  }
447 
448  uint64_t HeaderSize = llvm::DWARFListTableHeader::getHeaderSize(format);
449  if (offset < HeaderSize)
450  return llvm::createStringError(errc::invalid_argument,
451  "did not detect a valid"
452  " list table with base = 0x%" PRIx64 "\n",
453  offset);
454  offset -= HeaderSize;
455  ListTableType Table;
456  if (llvm::Error E = Table.extractHeaderAndOffsets(data, &offset))
457  return std::move(E);
458  return Table;
459 }
460 
462  uint64_t offset = 0;
463  if (const llvm::DWARFUnitIndex::Entry *entry = m_header.GetIndexEntry()) {
464  const auto *contribution = entry->getContribution(llvm::DW_SECT_LOCLISTS);
465  if (!contribution) {
466  GetSymbolFileDWARF().GetObjectFile()->GetModule()->ReportError(
467  "Failed to find location list contribution for CU with DWO Id "
468  "0x%" PRIx64,
469  this->GetDWOId());
470  return;
471  }
472  offset += contribution->Offset;
473  }
474  m_loclists_base = loclists_base;
475 
476  uint64_t header_size = llvm::DWARFListTableHeader::getHeaderSize(DWARF32);
477  if (loclists_base < header_size)
478  return;
479 
480  m_loclist_table_header.emplace(".debug_loclists", "locations");
481  offset += loclists_base - header_size;
482  if (llvm::Error E = m_loclist_table_header->extract(
484  &offset)) {
485  GetSymbolFileDWARF().GetObjectFile()->GetModule()->ReportError(
486  "Failed to extract location list table at offset 0x%" PRIx64
487  " (location list base: 0x%" PRIx64 "): %s",
488  offset, loclists_base, toString(std::move(E)).c_str());
489  }
490 }
491 
492 std::unique_ptr<llvm::DWARFLocationTable>
494  llvm::DWARFDataExtractor llvm_data(
495  data.GetData(), data.GetByteOrder() == lldb::eByteOrderLittle,
496  data.GetAddressByteSize());
497 
498  if (m_is_dwo || GetVersion() >= 5)
499  return std::make_unique<llvm::DWARFDebugLoclists>(llvm_data, GetVersion());
500  return std::make_unique<llvm::DWARFDebugLoc>(llvm_data);
501 }
502 
505  const DWARFDataExtractor &data =
506  GetVersion() >= 5 ? Ctx.getOrLoadLocListsData() : Ctx.getOrLoadLocData();
507  if (const llvm::DWARFUnitIndex::Entry *entry = m_header.GetIndexEntry()) {
508  if (const auto *contribution = entry->getContribution(
509  GetVersion() >= 5 ? llvm::DW_SECT_LOCLISTS : llvm::DW_SECT_EXT_LOC))
510  return DWARFDataExtractor(data, contribution->Offset,
511  contribution->Length);
512  return DWARFDataExtractor();
513  }
514  return data;
515 }
516 
519  const DWARFDataExtractor &data = Ctx.getOrLoadRngListsData();
520  if (const llvm::DWARFUnitIndex::Entry *entry = m_header.GetIndexEntry()) {
521  if (const auto *contribution =
522  entry->getContribution(llvm::DW_SECT_RNGLISTS))
523  return DWARFDataExtractor(data, contribution->Offset,
524  contribution->Length);
525  GetSymbolFileDWARF().GetObjectFile()->GetModule()->ReportError(
526  "Failed to find range list contribution for CU with signature "
527  "0x%" PRIx64,
528  entry->getSignature());
529 
530  return DWARFDataExtractor();
531  }
532  return data;
533 }
534 
537 
538  m_ranges_base = ranges_base;
539 }
540 
541 const llvm::Optional<llvm::DWARFDebugRnglistTable> &
543  if (GetVersion() >= 5 && !m_rnglist_table_done) {
544  m_rnglist_table_done = true;
545  if (auto table_or_error =
546  ParseListTableHeader<llvm::DWARFDebugRnglistTable>(
547  GetRnglistData().GetAsLLVM(), m_ranges_base, DWARF32))
548  m_rnglist_table = std::move(table_or_error.get());
549  else
550  GetSymbolFileDWARF().GetObjectFile()->GetModule()->ReportError(
551  "Failed to extract range list table at offset 0x%" PRIx64 ": %s",
552  m_ranges_base, toString(table_or_error.takeError()).c_str());
553  }
554  return m_rnglist_table;
555 }
556 
557 // This function is called only for DW_FORM_rnglistx.
558 llvm::Expected<uint64_t> DWARFUnit::GetRnglistOffset(uint32_t Index) {
559  if (!GetRnglistTable())
560  return llvm::createStringError(errc::invalid_argument,
561  "missing or invalid range list table");
562  if (!m_ranges_base)
563  return llvm::createStringError(errc::invalid_argument,
564  "DW_FORM_rnglistx cannot be used without "
565  "DW_AT_rnglists_base for CU at 0x%8.8x",
566  GetOffset());
567  if (llvm::Optional<uint64_t> off = GetRnglistTable()->getOffsetEntry(
568  GetRnglistData().GetAsLLVM(), Index))
569  return *off + m_ranges_base;
570  return llvm::createStringError(
571  errc::invalid_argument,
572  "invalid range list table index %u; OffsetEntryCount is %u, "
573  "DW_AT_rnglists_base is %" PRIu64,
574  Index, GetRnglistTable()->getOffsetEntryCount(), m_ranges_base);
575 }
576 
578  m_str_offsets_base = str_offsets_base;
579 }
580 
581 // It may be called only with m_die_array_mutex held R/W.
583  m_die_array.clear();
584  m_die_array.shrink_to_fit();
585 
586  if (m_dwo)
587  m_dwo->ClearDIEsRWLocked();
588 }
589 
591  return m_dwarf.GetObjectFile()->GetByteOrder();
592 }
593 
594 void DWARFUnit::SetBaseAddress(dw_addr_t base_addr) { m_base_addr = base_addr; }
595 
596 // Compare function DWARFDebugAranges::Range structures
597 static bool CompareDIEOffset(const DWARFDebugInfoEntry &die,
598  const dw_offset_t die_offset) {
599  return die.GetOffset() < die_offset;
600 }
601 
602 // GetDIE()
603 //
604 // Get the DIE (Debug Information Entry) with the specified offset by first
605 // checking if the DIE is contained within this compile unit and grabbing the
606 // DIE from this compile unit. Otherwise we grab the DIE from the DWARF file.
607 DWARFDIE
609  if (die_offset == DW_INVALID_OFFSET)
610  return DWARFDIE(); // Not found
611 
612  if (!ContainsDIEOffset(die_offset)) {
613  GetSymbolFileDWARF().GetObjectFile()->GetModule()->ReportError(
614  "GetDIE for DIE 0x%" PRIx32 " is outside of its CU 0x%" PRIx32,
615  die_offset, GetOffset());
616  return DWARFDIE(); // Not found
617  }
618 
622  lower_bound(m_die_array.cbegin(), end, die_offset, CompareDIEOffset);
623 
624  if (pos != end && die_offset == (*pos).GetOffset())
625  return DWARFDIE(this, &(*pos));
626  return DWARFDIE(); // Not found
627 }
628 
631  if (m_dwo)
632  return *m_dwo;
633  return *this;
634 }
635 
637  if (cu)
638  return cu->GetAddressByteSize();
640 }
641 
642 uint8_t DWARFUnit::GetDefaultAddressSize() { return 4; }
643 
644 void *DWARFUnit::GetUserData() const { return m_user_data; }
645 
646 void DWARFUnit::SetUserData(void *d) { m_user_data = d; }
647 
649  return GetProducer() != eProducerLLVMGCC;
650 }
651 
653  // llvm-gcc makes completely invalid decl file attributes and won't ever be
654  // fixed, so we need to know to ignore these.
655  return GetProducer() == eProducerLLVMGCC;
656 }
657 
659  if (GetProducer() == eProducerClang)
660  return GetProducerVersion() >= llvm::VersionTuple(425, 0, 13);
661  // Assume all other compilers didn't have incorrect ObjC bitfield info.
662  return true;
663 }
664 
667  const DWARFDebugInfoEntry *die = GetUnitDIEPtrOnly();
668  if (!die)
669  return;
670 
671  llvm::StringRef producer(
672  die->GetAttributeValueAsString(this, DW_AT_producer, nullptr));
673  if (producer.empty())
674  return;
675 
676  static const RegularExpression g_swiftlang_version_regex(
677  llvm::StringRef(R"(swiftlang-([0-9]+\.[0-9]+\.[0-9]+(\.[0-9]+)?))"));
678  static const RegularExpression g_clang_version_regex(
679  llvm::StringRef(R"(clang-([0-9]+\.[0-9]+\.[0-9]+(\.[0-9]+)?))"));
680  static const RegularExpression g_llvm_gcc_regex(
681  llvm::StringRef(R"(4\.[012]\.[01] )"
682  R"(\(Based on Apple Inc\. build [0-9]+\) )"
683  R"(\(LLVM build [\.0-9]+\)$)"));
684 
685  llvm::SmallVector<llvm::StringRef, 3> matches;
686  if (g_swiftlang_version_regex.Execute(producer, &matches)) {
687  m_producer_version.tryParse(matches[1]);
689  } else if (producer.contains("clang")) {
690  if (g_clang_version_regex.Execute(producer, &matches))
691  m_producer_version.tryParse(matches[1]);
693  } else if (producer.contains("GNU")) {
695  } else if (g_llvm_gcc_regex.Execute(producer)) {
697  }
698 }
699 
703  return m_producer;
704 }
705 
706 llvm::VersionTuple DWARFUnit::GetProducerVersion() {
707  if (m_producer_version.empty())
709  return m_producer_version;
710 }
711 
713  if (m_language_type)
714  return *m_language_type;
715 
716  const DWARFDebugInfoEntry *die = GetUnitDIEPtrOnly();
717  if (!die)
718  m_language_type = 0;
719  else
720  m_language_type = die->GetAttributeValueAsUnsigned(this, DW_AT_language, 0);
721  return *m_language_type;
722 }
723 
726  const DWARFDebugInfoEntry *die = GetUnitDIEPtrOnly();
727  if (die) {
729  if (die->GetAttributeValueAsUnsigned(this, DW_AT_APPLE_optimized, 0) ==
730  1) {
732  }
733  }
734  }
735  return m_is_optimized == eLazyBoolYes;
736 }
737 
739  if (!m_comp_dir)
741  return m_comp_dir->GetPathStyle();
742 }
743 
745  if (!m_comp_dir)
747  return *m_comp_dir;
748 }
749 
751  if (!m_file_spec)
753  return *m_file_spec;
754 }
755 
756 FileSpec DWARFUnit::GetFile(size_t file_idx) {
757  return m_dwarf.GetFile(*this, file_idx);
758 }
759 
760 // DWARF2/3 suggests the form hostname:pathname for compilation directory.
761 // Remove the host part if present.
762 static llvm::StringRef
763 removeHostnameFromPathname(llvm::StringRef path_from_dwarf) {
764  if (!path_from_dwarf.contains(':'))
765  return path_from_dwarf;
766  llvm::StringRef host, path;
767  std::tie(host, path) = path_from_dwarf.split(':');
768 
769  if (host.contains('/'))
770  return path_from_dwarf;
771 
772  // check whether we have a windows path, and so the first character is a
773  // drive-letter not a hostname.
774  if (host.size() == 1 && llvm::isAlpha(host[0]) && path.startswith("\\"))
775  return path_from_dwarf;
776 
777  return path;
778 }
779 
781  m_comp_dir = FileSpec();
782  const DWARFDebugInfoEntry *die = GetUnitDIEPtrOnly();
783  if (!die)
784  return;
785 
786  llvm::StringRef comp_dir = removeHostnameFromPathname(
787  die->GetAttributeValueAsString(this, DW_AT_comp_dir, nullptr));
788  if (!comp_dir.empty()) {
789  FileSpec::Style comp_dir_style =
790  FileSpec::GuessPathStyle(comp_dir).getValueOr(FileSpec::Style::native);
791  m_comp_dir = FileSpec(comp_dir, comp_dir_style);
792  } else {
793  // Try to detect the style based on the DW_AT_name attribute, but just store
794  // the detected style in the m_comp_dir field.
795  const char *name =
796  die->GetAttributeValueAsString(this, DW_AT_name, nullptr);
798  "", FileSpec::GuessPathStyle(name).getValueOr(FileSpec::Style::native));
799  }
800 }
801 
803  m_file_spec = FileSpec();
804  const DWARFDebugInfoEntry *die = GetUnitDIEPtrOnly();
805  if (!die)
806  return;
807 
808  m_file_spec =
809  FileSpec(die->GetAttributeValueAsString(this, DW_AT_name, nullptr),
810  GetPathStyle());
811 
812  if (m_file_spec->IsRelative())
813  m_file_spec->MakeAbsolute(GetCompilationDirectory());
814 }
815 
818  if (m_dwo)
819  return &llvm::cast<SymbolFileDWARFDwo>(m_dwo->GetSymbolFileDWARF());
820  return nullptr;
821 }
822 
824  if (m_func_aranges_up == nullptr) {
825  m_func_aranges_up = std::make_unique<DWARFDebugAranges>();
826  const DWARFDebugInfoEntry *die = DIEPtr();
827  if (die)
829 
830  if (m_dwo) {
831  const DWARFDebugInfoEntry *dwo_die = m_dwo->DIEPtr();
832  if (dwo_die)
833  dwo_die->BuildFunctionAddressRangeTable(m_dwo.get(),
834  m_func_aranges_up.get());
835  }
836 
837  const bool minimize = false;
838  m_func_aranges_up->Sort(minimize);
839  }
840  return *m_func_aranges_up;
841 }
842 
843 llvm::Expected<DWARFUnitHeader>
845  DIERef::Section section,
847  lldb::offset_t *offset_ptr) {
848  DWARFUnitHeader header;
849  header.m_offset = *offset_ptr;
850  header.m_length = data.GetDWARFInitialLength(offset_ptr);
851  header.m_version = data.GetU16(offset_ptr);
852  if (header.m_version == 5) {
853  header.m_unit_type = data.GetU8(offset_ptr);
854  header.m_addr_size = data.GetU8(offset_ptr);
855  header.m_abbr_offset = data.GetDWARFOffset(offset_ptr);
856  if (header.m_unit_type == llvm::dwarf::DW_UT_skeleton ||
857  header.m_unit_type == llvm::dwarf::DW_UT_split_compile)
858  header.m_dwo_id = data.GetU64(offset_ptr);
859  } else {
860  header.m_abbr_offset = data.GetDWARFOffset(offset_ptr);
861  header.m_addr_size = data.GetU8(offset_ptr);
862  header.m_unit_type =
863  section == DIERef::Section::DebugTypes ? DW_UT_type : DW_UT_compile;
864  }
865 
866  if (context.isDwo()) {
867  if (header.IsTypeUnit()) {
868  header.m_index_entry =
869  context.GetAsLLVM().getTUIndex().getFromOffset(header.m_offset);
870  } else {
871  header.m_index_entry =
872  context.GetAsLLVM().getCUIndex().getFromOffset(header.m_offset);
873  }
874  }
875 
876  if (header.m_index_entry) {
877  if (header.m_abbr_offset) {
878  return llvm::createStringError(
879  llvm::inconvertibleErrorCode(),
880  "Package unit with a non-zero abbreviation offset");
881  }
882  auto *unit_contrib = header.m_index_entry->getContribution();
883  if (!unit_contrib || unit_contrib->Length != header.m_length + 4) {
884  return llvm::createStringError(llvm::inconvertibleErrorCode(),
885  "Inconsistent DWARF package unit index");
886  }
887  auto *abbr_entry =
888  header.m_index_entry->getContribution(llvm::DW_SECT_ABBREV);
889  if (!abbr_entry) {
890  return llvm::createStringError(
891  llvm::inconvertibleErrorCode(),
892  "DWARF package index missing abbreviation column");
893  }
894  header.m_abbr_offset = abbr_entry->Offset;
895  }
896  if (header.IsTypeUnit()) {
897  header.m_type_hash = data.GetU64(offset_ptr);
898  header.m_type_offset = data.GetDWARFOffset(offset_ptr);
899  }
900 
901  bool length_OK = data.ValidOffset(header.GetNextUnitOffset() - 1);
902  bool version_OK = SymbolFileDWARF::SupportedVersion(header.m_version);
903  bool addr_size_OK = (header.m_addr_size == 4) || (header.m_addr_size == 8);
904  bool type_offset_OK =
905  !header.IsTypeUnit() || (header.m_type_offset <= header.GetLength());
906 
907  if (!length_OK)
908  return llvm::make_error<llvm::object::GenericBinaryError>(
909  "Invalid unit length");
910  if (!version_OK)
911  return llvm::make_error<llvm::object::GenericBinaryError>(
912  "Unsupported unit version");
913  if (!addr_size_OK)
914  return llvm::make_error<llvm::object::GenericBinaryError>(
915  "Invalid unit address size");
916  if (!type_offset_OK)
917  return llvm::make_error<llvm::object::GenericBinaryError>(
918  "Type offset out of range");
919 
920  return header;
921 }
922 
923 llvm::Expected<DWARFUnitSP>
925  const DWARFDataExtractor &debug_info,
926  DIERef::Section section, lldb::offset_t *offset_ptr) {
927  assert(debug_info.ValidOffset(*offset_ptr));
928 
929  auto expected_header = DWARFUnitHeader::extract(
930  debug_info, section, dwarf.GetDWARFContext(), offset_ptr);
931  if (!expected_header)
932  return expected_header.takeError();
933 
934  const DWARFDebugAbbrev *abbr = dwarf.DebugAbbrev();
935  if (!abbr)
936  return llvm::make_error<llvm::object::GenericBinaryError>(
937  "No debug_abbrev data");
938 
939  bool abbr_offset_OK =
940  dwarf.GetDWARFContext().getOrLoadAbbrevData().ValidOffset(
941  expected_header->GetAbbrOffset());
942  if (!abbr_offset_OK)
943  return llvm::make_error<llvm::object::GenericBinaryError>(
944  "Abbreviation offset for unit is not valid");
945 
946  const DWARFAbbreviationDeclarationSet *abbrevs =
947  abbr->GetAbbreviationDeclarationSet(expected_header->GetAbbrOffset());
948  if (!abbrevs)
949  return llvm::make_error<llvm::object::GenericBinaryError>(
950  "No abbrev exists at the specified offset.");
951 
952  bool is_dwo = dwarf.GetDWARFContext().isDwo();
953  if (expected_header->IsTypeUnit())
954  return DWARFUnitSP(new DWARFTypeUnit(dwarf, uid, *expected_header, *abbrevs,
955  section, is_dwo));
956  return DWARFUnitSP(new DWARFCompileUnit(dwarf, uid, *expected_header,
957  *abbrevs, section, is_dwo));
958 }
959 
961  return m_section == DIERef::Section::DebugTypes
964 }
965 
967  switch (m_header.GetUnitType()) {
968  case llvm::dwarf::DW_UT_compile:
969  case llvm::dwarf::DW_UT_partial:
970  return GetVersion() < 5 ? 11 : 12;
971  case llvm::dwarf::DW_UT_skeleton:
972  case llvm::dwarf::DW_UT_split_compile:
973  return 20;
974  case llvm::dwarf::DW_UT_type:
975  case llvm::dwarf::DW_UT_split_type:
976  return GetVersion() < 5 ? 23 : 24;
977  }
978  llvm_unreachable("invalid UnitType.");
979 }
980 
981 llvm::Optional<uint64_t>
983  offset_t offset = GetStrOffsetsBase() + index * 4;
985 }
986 
987 llvm::Expected<DWARFRangeList>
989  if (GetVersion() <= 4) {
990  const DWARFDebugRanges *debug_ranges = m_dwarf.GetDebugRanges();
991  if (!debug_ranges)
992  return llvm::make_error<llvm::object::GenericBinaryError>(
993  "No debug_ranges section");
994  DWARFRangeList ranges;
995  debug_ranges->FindRanges(this, offset, ranges);
996  return ranges;
997  }
998 
999  if (!GetRnglistTable())
1000  return llvm::createStringError(errc::invalid_argument,
1001  "missing or invalid range list table");
1002 
1003  llvm::DWARFDataExtractor data = GetRnglistData().GetAsLLVM();
1004 
1005  // As DW_AT_rnglists_base may be missing we need to call setAddressSize.
1006  data.setAddressSize(m_header.GetAddressByteSize());
1007  auto range_list_or_error = GetRnglistTable()->findList(data, offset);
1008  if (!range_list_or_error)
1009  return range_list_or_error.takeError();
1010 
1011  llvm::Expected<llvm::DWARFAddressRangesVector> llvm_ranges =
1012  range_list_or_error->getAbsoluteRanges(
1013  llvm::object::SectionedAddress{GetBaseAddress()},
1014  GetAddressByteSize(), [&](uint32_t index) {
1015  uint32_t index_size = GetAddressByteSize();
1016  dw_offset_t addr_base = GetAddrBase();
1017  lldb::offset_t offset = addr_base + index * index_size;
1018  return llvm::object::SectionedAddress{
1020  &offset, index_size)};
1021  });
1022  if (!llvm_ranges)
1023  return llvm_ranges.takeError();
1024 
1025  DWARFRangeList ranges;
1026  for (const llvm::DWARFAddressRange &llvm_range : *llvm_ranges) {
1027  ranges.Append(DWARFRangeList::Entry(llvm_range.LowPC,
1028  llvm_range.HighPC - llvm_range.LowPC));
1029  }
1030  return ranges;
1031 }
1032 
1033 llvm::Expected<DWARFRangeList>
1035  llvm::Expected<uint64_t> maybe_offset = GetRnglistOffset(index);
1036  if (!maybe_offset)
1037  return maybe_offset.takeError();
1038  return FindRnglistFromOffset(*maybe_offset);
1039 }
lldb_private::toString
const char * toString(AppleArm64ExceptionClass EC)
Definition: AppleArm64ExceptionClass.h:38
DWARFUnit::GetRnglistData
lldb_private::DWARFDataExtractor GetRnglistData() const
Definition: DWARFUnit.cpp:517
DWARFUnit::m_producer_version
llvm::VersionTuple m_producer_version
Definition: DWARFUnit.h:311
DWARFUnit::GetRnglistOffset
llvm::Expected< uint64_t > GetRnglistOffset(uint32_t Index)
Return a rangelist's offset based on an index.
Definition: DWARFUnit.cpp:558
DWARFUnit::SetUserData
void SetUserData(void *d)
Definition: DWARFUnit.cpp:646
LLDB_SCOPED_TIMERF
#define LLDB_SCOPED_TIMERF(...)
Definition: Timer.h:86
DWARFCompileUnit.h
DWARFDebugInfoEntry::GetOffset
dw_offset_t GetOffset() const
Definition: DWARFDebugInfoEntry.h:118
lldb_private::RegularExpression
Definition: RegularExpression.h:18
DWARFUnit::GetData
const lldb_private::DWARFDataExtractor & GetData() const
Get the data that contains the DIE information for this unit.
Definition: DWARFUnit.cpp:960
lldb_private::DWARFContext::getOrLoadStrOffsetsData
const DWARFDataExtractor & getOrLoadStrOffsetsData()
Definition: DWARFContext.cpp:115
SymbolFileDWARF::GetFile
lldb_private::FileSpec GetFile(DWARFUnit &unit, size_t file_idx)
Definition: SymbolFileDWARF.cpp:1002
DWARFUnit::m_addr_base
llvm::Optional< dw_addr_t > m_addr_base
Value of DW_AT_addr_base.
Definition: DWARFUnit.h:316
CompareDIEOffset
static bool CompareDIEOffset(const DWARFDebugInfoEntry &die, const dw_offset_t die_offset)
Definition: DWARFUnit.cpp:597
eProducerClang
@ eProducerClang
Definition: DWARFUnit.h:29
DWARFUnit::GetRnglistTable
const llvm::Optional< llvm::DWARFDebugRnglistTable > & GetRnglistTable()
Definition: DWARFUnit.cpp:542
DWARFDebugAranges
Definition: DWARFDebugAranges.h:16
lldb_private::DataExtractor::ValidOffset
bool ValidOffset(lldb::offset_t offset) const
Test the validity of offset.
Definition: DataExtractor.h:956
DWARFUnit::DWARFUnit
DWARFUnit(SymbolFileDWARF &dwarf, lldb::user_id_t uid, const DWARFUnitHeader &header, const DWARFAbbreviationDeclarationSet &abbrevs, DIERef::Section section, bool is_dwo)
Definition: DWARFUnit.cpp:31
DWARFUnit::GetProducer
DWARFProducer GetProducer()
Definition: DWARFUnit.cpp:700
DWARFUnit::ScopedExtractDIEs::m_clear_dies
bool m_clear_dies
Definition: DWARFUnit.h:102
SymbolFileDWARF::GetDWARFContext
lldb_private::DWARFContext & GetDWARFContext()
Definition: SymbolFileDWARF.h:294
DWARFUnit::GetDWOId
uint64_t GetDWOId()
Definition: DWARFUnit.cpp:347
lldb_private::UserID
Definition: UserID.h:31
DWARFTypeUnit
Definition: DWARFTypeUnit.h:15
DWARFFormValue::Address
dw_addr_t Address() const
Definition: DWARFFormValue.cpp:483
DWARFUnitHeader::m_type_hash
uint64_t m_type_hash
Definition: DWARFUnit.h:50
lldb_private::eLazyBoolYes
@ eLazyBoolYes
Definition: lldb-private-enumerations.h:115
DWARFUnit::m_loclists_base
dw_addr_t m_loclists_base
Value of DW_AT_loclists_base.
Definition: DWARFUnit.h:317
lldb_private::ElapsedTime
A class that measures elapsed time in an exception safe way.
Definition: Statistics.h:66
DWARFUnit::GetDwoSymbolFile
SymbolFileDWARFDwo * GetDwoSymbolFile()
Definition: DWARFUnit.cpp:816
DWARFUnit::m_header
DWARFUnitHeader m_header
Definition: DWARFUnit.h:290
Module.h
DWARFUnit::m_ranges_base
dw_addr_t m_ranges_base
Value of DW_AT_rnglists_base.
Definition: DWARFUnit.h:318
DWARFProducer
DWARFProducer
Definition: DWARFUnit.h:27
DWARFUnit::ExtractDIEsRWLocked
void ExtractDIEsRWLocked()
Definition: DWARFUnit.cpp:197
DWARFDebugInfoEntry::HasChildren
bool HasChildren() const
Definition: DWARFDebugInfoEntry.h:120
DWARFDebugRanges::FindRanges
bool FindRanges(const DWARFUnit *cu, dw_offset_t debug_ranges_offset, DWARFRangeList &range_list) const
Definition: DWARFDebugRanges.cpp:111
DWARFUnitHeader::m_version
uint16_t m_version
Definition: DWARFUnit.h:42
lldb_private::DWARFContext::getOrLoadAddrData
const DWARFDataExtractor & getOrLoadAddrData()
Definition: DWARFContext.cpp:63
SymbolFileDWARF
Definition: SymbolFileDWARF.h:59
DWARFUnit::m_comp_dir
llvm::Optional< lldb_private::FileSpec > m_comp_dir
Definition: DWARFUnit.h:314
DWARFUnit::m_rnglist_table_done
bool m_rnglist_table_done
Definition: DWARFUnit.h:328
lldb_private::SymbolFile::GetObjectFile
ObjectFile * GetObjectFile()
Definition: SymbolFile.h:265
lldb::offset_t
uint64_t offset_t
Definition: lldb-types.h:87
DWARFUnit::ComputeCompDirAndGuessPathStyle
void ComputeCompDirAndGuessPathStyle()
Definition: DWARFUnit.cpp:780
SymbolFileDWARF::GetDebugRanges
DWARFDebugRanges * GetDebugRanges()
Definition: SymbolFileDWARF.cpp:657
DWARFUnit::m_dwarf
SymbolFileDWARF & m_dwarf
Definition: DWARFUnit.h:288
DWARFUnit::GetDebugInfoSize
size_t GetDebugInfoSize() const
Definition: DWARFUnit.cpp:413
DWARFUnit::ClearDIEsRWLocked
void ClearDIEsRWLocked()
Definition: DWARFUnit.cpp:582
lldb_private::DWARFDataExtractor
Definition: DWARFDataExtractor.h:18
DWARFUnit::extract
static llvm::Expected< DWARFUnitSP > extract(SymbolFileDWARF &dwarf2Data, lldb::user_id_t uid, const lldb_private::DWARFDataExtractor &debug_info, DIERef::Section section, lldb::offset_t *offset_ptr)
Definition: DWARFUnit.cpp:924
DWARFUnit::m_is_optimized
lldb_private::LazyBool m_is_optimized
Definition: DWARFUnit.h:313
DWARFUnit::m_base_addr
dw_addr_t m_base_addr
Definition: DWARFUnit.h:309
DWARFUnitHeader::m_index_entry
const llvm::DWARFUnitIndex::Entry * m_index_entry
Definition: DWARFUnit.h:45
DWARFUnit::GetStrOffsetsBase
dw_addr_t GetStrOffsetsBase() const
Definition: DWARFUnit.h:160
DWARFDebugInfoEntry
DWARFDebugInfoEntry objects assume that they are living in one big vector and do pointer arithmetic o...
Definition: DWARFDebugInfoEntry.h:31
DW_INVALID_OFFSET
#define DW_INVALID_OFFSET
Definition: dwarf.h:34
DWARFUnitHeader::m_offset
dw_offset_t m_offset
Definition: DWARFUnit.h:40
DWARFUnit::FindRnglistFromOffset
llvm::Expected< DWARFRangeList > FindRnglistFromOffset(dw_offset_t offset)
Return a list of address ranges resulting from a (possibly encoded) range list starting at a given of...
Definition: DWARFUnit.cpp:988
lldb_private::DataExtractor::GetU64
uint64_t GetU64(lldb::offset_t *offset_ptr) const
Extract a uint64_t value from *offset_ptr.
Definition: DataExtractor.cpp:476
DWARFUnit::m_first_die
DWARFDebugInfoEntry m_first_die
Definition: DWARFUnit.h:304
DWARFUnit::SetLoclistsBase
void SetLoclistsBase(dw_addr_t loclists_base)
Definition: DWARFUnit.cpp:461
lldb_private::DWARFContext
Definition: DWARFContext.h:20
DWARFAttributes
Definition: DWARFAttribute.h:44
lldb_private::RangeVector::Append
void Append(const Entry &entry)
Definition: RangeMap.h:136
DWARFUnit::GetUnitDIEPtrOnly
const DWARFDebugInfoEntry * GetUnitDIEPtrOnly()
Definition: DWARFUnit.h:268
DWARFAbbreviationDeclarationSet::GetOffset
dw_offset_t GetOffset() const
Definition: DWARFDebugAbbrev.h:35
DWARFDIE
Definition: DWARFDIE.h:16
DWARFUnit::m_dwo
std::shared_ptr< DWARFUnit > m_dwo
Definition: DWARFUnit.h:289
DWARFUnit::GetDWARFLanguageType
uint64_t GetDWARFLanguageType()
Definition: DWARFUnit.cpp:712
lldb_private::FileSpec
Definition: FileSpec.h:56
SymbolFileDWARFDwo.h
DWARFCompileUnit
Definition: DWARFCompileUnit.h:15
eProducerSwift
@ eProducerSwift
Definition: DWARFUnit.h:32
elapsed
static double elapsed(const StatsTimepoint &start, const StatsTimepoint &end)
Definition: Statistics.cpp:36
DWARFUnit::GetAddressByteSize
uint8_t GetAddressByteSize() const
Definition: DWARFUnit.h:155
lldb_private::DWARFContext::GetAsLLVM
llvm::DWARFContext & GetAsLLVM()
Definition: DWARFContext.cpp:126
DWARFUnit::ScopedExtractDIEs
Definition: DWARFUnit.h:99
DWARFUnit::AddUnitDIE
void AddUnitDIE(const DWARFDebugInfoEntry &cu_die)
Definition: DWARFUnit.cpp:353
DWARFUnit
Definition: DWARFUnit.h:81
DWARFUnit::m_abbrevs
const DWARFAbbreviationDeclarationSet * m_abbrevs
Definition: DWARFUnit.h:291
LLDBAssert.h
SymbolFileDWARF::GetDebugInfoParseTimeRef
lldb_private::StatsDuration & GetDebugInfoParseTimeRef()
Definition: SymbolFileDWARF.h:327
DWARFUnit::GetCompilationDirectory
const lldb_private::FileSpec & GetCompilationDirectory()
Definition: DWARFUnit.cpp:744
DWARFUnit::GetLocationTable
std::unique_ptr< llvm::DWARFLocationTable > GetLocationTable(const lldb_private::DataExtractor &data) const
Return the location table for parsing the given location list data.
Definition: DWARFUnit.cpp:493
DWARFUnit::m_cancel_scopes
std::atomic< bool > m_cancel_scopes
Definition: DWARFUnit.h:300
lldb_private::DataExtractor::GetAddressByteSize
uint32_t GetAddressByteSize() const
Get the current address size.
Definition: DataExtractor.h:264
DWARFUnit::ExtractUnitDIENoDwoIfNeeded
void ExtractUnitDIENoDwoIfNeeded()
Definition: DWARFUnit.cpp:42
dwarf
Definition: ABISysV_arc.cpp:61
DWARFUnit::GetNextUnitOffset
dw_offset_t GetNextUnitOffset() const
Definition: DWARFUnit.h:147
lldb_private::DataExtractor
Definition: DataExtractor.h:48
SymbolFileDWARF::GetDwoSymbolFileForCompileUnit
std::shared_ptr< SymbolFileDWARFDwo > GetDwoSymbolFileForCompileUnit(DWARFUnit &dwarf_cu, const DWARFDebugInfoEntry &cu_die)
Definition: SymbolFileDWARF.cpp:1706
lldb_private::DWARFContext::isDwo
bool isDwo()
Definition: DWARFContext.h:77
DWARFUnit::ScopedExtractDIEs::ScopedExtractDIEs
ScopedExtractDIEs(DWARFUnit &cu)
Definition: DWARFUnit.cpp:164
DWARFUnit::ParseProducerInfo
void ParseProducerInfo()
Definition: DWARFUnit.cpp:665
DWARFUnit::GetAddrBase
dw_addr_t GetAddrBase() const
Definition: DWARFUnit.h:156
DWARFUnitSP
std::shared_ptr< DWARFUnit > DWARFUnitSP
Definition: DWARFUnit.h:23
DWARFUnitHeader::GetNextUnitOffset
uint32_t GetNextUnitOffset() const
Definition: DWARFUnit.h:73
DWARFUnit::~DWARFUnit
virtual ~DWARFUnit()
DWARFUnit::GetPathStyle
lldb_private::FileSpec::Style GetPathStyle()
Definition: DWARFUnit.cpp:738
DWARFUnit::GetAbbrevOffset
dw_offset_t GetAbbrevOffset() const
Definition: DWARFUnit.cpp:421
StreamString.h
DWARFDebugInfoEntry::SetHasChildren
void SetHasChildren(bool b)
Definition: DWARFDebugInfoEntry.h:122
DWARFUnitHeader::m_addr_size
uint8_t m_addr_size
Definition: DWARFUnit.h:48
DWARFUnit::ScopedExtractDIEs::m_cu
DWARFUnit * m_cu
Definition: DWARFUnit.h:100
DWARFUnit::GetStringOffsetSectionItem
llvm::Optional< uint64_t > GetStringOffsetSectionItem(uint32_t index) const
Definition: DWARFUnit.cpp:982
DWARFUnit::ScopedExtractDIEs::~ScopedExtractDIEs
~ScopedExtractDIEs()
Definition: DWARFUnit.cpp:168
DWARFUnit::GetFirstDIEOffset
dw_offset_t GetFirstDIEOffset() const
Definition: DWARFUnit.h:144
lldb_private::DataExtractor::GetByteOrder
lldb::ByteOrder GetByteOrder() const
Get the current byte order value.
Definition: DataExtractor.h:594
DWARFUnit::m_func_aranges_up
std::unique_ptr< DWARFDebugAranges > m_func_aranges_up
Definition: DWARFUnit.h:308
removeHostnameFromPathname
static llvm::StringRef removeHostnameFromPathname(llvm::StringRef path_from_dwarf)
Definition: DWARFUnit.cpp:763
lldb_private::ObjectFile::GetByteOrder
virtual lldb::ByteOrder GetByteOrder() const =0
Gets whether endian swapping should occur when extracting data from this object file.
DWARFUnit::SetStrOffsetsBase
void SetStrOffsetsBase(dw_offset_t str_offsets_base)
Definition: DWARFUnit.cpp:577
lldb_private::DataExtractor::GetU8
uint8_t GetU8(lldb::offset_t *offset_ptr) const
Extract a uint8_t value from *offset_ptr.
Definition: DataExtractor.cpp:318
DWARFUnit::m_str_offsets_base
dw_offset_t m_str_offsets_base
Definition: DWARFUnit.h:325
DWARFUnit::m_dwo_id
uint64_t m_dwo_id
Value of DW_AT_GNU_dwo_id (v4) or dwo_id from CU header (v5).
Definition: DWARFUnit.h:335
DWARFUnitHeader::GetUnitType
uint8_t GetUnitType() const
Definition: DWARFUnit.h:63
Timer.h
lldb_private::DWARFDataExtractor::GetDWARFInitialLength
uint64_t GetDWARFInitialLength(lldb::offset_t *offset_ptr) const
Definition: DWARFDataExtractor.cpp:15
DWARFDebugAranges.h
ParseListTableHeader
static llvm::Expected< ListTableType > ParseListTableHeader(const llvm::DWARFDataExtractor &data, uint64_t offset, DwarfFormat format)
Definition: DWARFUnit.cpp:436
DWARFUnit::Supports_unnamed_objc_bitfields
bool Supports_unnamed_objc_bitfields()
Definition: DWARFUnit.cpp:658
DWARFFormValue
Definition: DWARFFormValue.h:20
DWARFUnit::m_die_array_scoped_mutex
llvm::sys::RWMutex m_die_array_scoped_mutex
Definition: DWARFUnit.h:297
lldb_private::DWARFContext::getOrLoadDebugInfoData
const DWARFDataExtractor & getOrLoadDebugInfoData()
Definition: DWARFContext.cpp:68
DWARFUnitHeader::IsTypeUnit
bool IsTypeUnit() const
Definition: DWARFUnit.h:70
DWARFUnitHeader
Base class describing the header of any kind of "unit." Some information is specific to certain unit ...
Definition: DWARFUnit.h:39
lldb_private::Range
Definition: Process.h:61
SymbolFileDWARF::SupportedVersion
static bool SupportedVersion(uint16_t version)
Definition: SymbolFileDWARF.cpp:513
DWARFUnit::DIEPtr
const DWARFDebugInfoEntry * DIEPtr()
Definition: DWARFUnit.h:277
LogChannelDWARF.h
DWARFDebugInfoEntry::const_iterator
collection::const_iterator const_iterator
Definition: DWARFDebugInfoEntry.h:35
DWARFUnit::GetHeaderByteSize
uint32_t GetHeaderByteSize() const
Get the size in bytes of the unit header.
Definition: DWARFUnit.cpp:966
DWARFDebugRanges
Definition: DWARFDebugRanges.h:20
DWARFDebugInfoEntry::Extract
bool Extract(const lldb_private::DWARFDataExtractor &data, const DWARFUnit *cu, lldb::offset_t *offset_ptr)
Definition: DWARFDebugInfoEntry.cpp:39
DWARFDebugInfoEntry::BuildFunctionAddressRangeTable
void BuildFunctionAddressRangeTable(DWARFUnit *cu, DWARFDebugAranges *debug_aranges) const
This function is builds a table very similar to the standard .debug_aranges table,...
Definition: DWARFDebugInfoEntry.cpp:693
DWARFUnitHeader::m_type_offset
uint32_t m_type_offset
Definition: DWARFUnit.h:51
DWARFDebugInfo.h
DWARFUnit.h
DWARFUnit::GetByteOrder
lldb::ByteOrder GetByteOrder() const
Definition: DWARFUnit.cpp:590
DWARFUnit::ScopedExtractDIEs::operator=
const ScopedExtractDIEs & operator=(const ScopedExtractDIEs &)=delete
DWARFAttributes::ExtractFormValueAtIndex
bool ExtractFormValueAtIndex(uint32_t i, DWARFFormValue &form_value) const
Definition: DWARFAttribute.cpp:36
lldb_private::RangeVector
Definition: RangeMap.h:125
DWARFDebugInfoEntry::GetAttributeValueAsString
const char * GetAttributeValueAsString(const DWARFUnit *cu, const dw_attr_t attr, const char *fail_value, bool check_specification_or_abstract_origin=false) const
Definition: DWARFDebugInfoEntry.cpp:525
DWARFFormValue::Unsigned
uint64_t Unsigned() const
Definition: DWARFFormValue.h:64
DWARFUnit::GetBaseAddress
dw_addr_t GetBaseAddress() const
Definition: DWARFUnit.h:157
DWARFUnit::GetLineTableOffset
dw_offset_t GetLineTableOffset()
Definition: DWARFUnit.cpp:425
eProducerLLVMGCC
@ eProducerLLVMGCC
Definition: DWARFUnit.h:31
ObjectFile.h
eProducerGCC
@ eProducerGCC
Definition: DWARFUnit.h:30
DWARFUnit::GetOffset
dw_offset_t GetOffset() const
Definition: DWARFUnit.h:131
DWARFDebugAbbrev
Definition: DWARFDebugAbbrev.h:64
DWARFUnit::GetFunctionAranges
const DWARFDebugAranges & GetFunctionAranges()
Definition: DWARFUnit.cpp:823
lldb_private::DWARFDataExtractor::GetDWARFOffset
dw_offset_t GetDWARFOffset(lldb::offset_t *offset_ptr) const
Definition: DWARFDataExtractor.cpp:20
lldb_private::FileSpec::Style
llvm::sys::path::Style Style
Definition: FileSpec.h:58
DWARFUnit::m_producer
DWARFProducer m_producer
Definition: DWARFUnit.h:310
DWARFUnit::m_is_dwo
bool m_is_dwo
Definition: DWARFUnit.h:332
lldbassert
#define lldbassert(x)
Definition: LLDBAssert.h:15
DWARFUnit::ExtractDIEsScoped
ScopedExtractDIEs ExtractDIEsScoped()
Definition: DWARFUnit.cpp:144
eProducerInvalid
@ eProducerInvalid
Definition: DWARFUnit.h:28
DWARFUnit::m_rnglist_table
llvm::Optional< llvm::DWARFDebugRnglistTable > m_rnglist_table
Definition: DWARFUnit.h:327
DWARFAbbreviationDeclarationSet
Definition: DWARFDebugAbbrev.h:27
DWARFUnit::SetRangesBase
void SetRangesBase(dw_addr_t ranges_base)
Definition: DWARFUnit.cpp:535
DWARFUnitHeader::m_unit_type
uint8_t m_unit_type
Definition: DWARFUnit.h:47
DWARFUnit::DW_AT_decl_file_attributes_are_invalid
bool DW_AT_decl_file_attributes_are_invalid()
Definition: DWARFUnit.cpp:652
DWARFUnit::GetLength
uint32_t GetLength() const
Definition: DWARFUnit.h:151
DWARFUnitHeader::GetAddressByteSize
uint16_t GetAddressByteSize() const
Definition: DWARFUnit.h:60
DWARFUnit::m_section
const DIERef::Section m_section
Definition: DWARFUnit.h:331
uint32_t
lldb_private::eLazyBoolNo
@ eLazyBoolNo
Definition: lldb-private-enumerations.h:115
DWARFUnit::GetUnitDIEOnly
DWARFBaseDIE GetUnitDIEOnly()
Definition: DWARFUnit.h:173
DWARFUnit::SetBaseAddress
void SetBaseAddress(dw_addr_t base_addr)
Definition: DWARFUnit.cpp:594
DWARFUnit::GetVersion
uint16_t GetVersion() const
Definition: DWARFUnit.h:152
DWARFUnit::ExtractDIEsIfNeeded
void ExtractDIEsIfNeeded()
Definition: DWARFUnit.cpp:124
DWARFUnit::m_language_type
llvm::Optional< uint64_t > m_language_type
Definition: DWARFUnit.h:312
lldb_private::DWARFContext::getOrLoadRngListsData
const DWARFDataExtractor & getOrLoadRngListsData()
Definition: DWARFContext.cpp:104
lldb_private::DataExtractor::GetMaxU64
uint64_t GetMaxU64(lldb::offset_t *offset_ptr, size_t byte_size) const
Extract an unsigned integer of size byte_size from *offset_ptr.
Definition: DataExtractor.cpp:526
DWARFUnit::m_has_parsed_non_skeleton_unit
bool m_has_parsed_non_skeleton_unit
Definition: DWARFUnit.h:333
DWARFUnit::m_gnu_addr_base
llvm::Optional< uint64_t > m_gnu_addr_base
Definition: DWARFUnit.h:319
DWARFUnitHeader::m_abbr_offset
dw_offset_t m_abbr_offset
Definition: DWARFUnit.h:43
g_verbose
int g_verbose
DWARFUnit::m_line_table_offset
dw_offset_t m_line_table_offset
Value of DW_AT_stmt_list.
Definition: DWARFUnit.h:323
DWARFUnit::m_user_data
void * m_user_data
Definition: DWARFUnit.h:292
SymbolFileDWARFDwo
Definition: SymbolFileDWARFDwo.h:14
DWARFUnit::GetNonSkeletonUnit
DWARFUnit & GetNonSkeletonUnit()
Definition: DWARFUnit.cpp:629
DWARFUnit::Supports_DW_AT_APPLE_objc_complete_type
bool Supports_DW_AT_APPLE_objc_complete_type()
Definition: DWARFUnit.cpp:648
DWARFUnitHeader::m_length
dw_offset_t m_length
Definition: DWARFUnit.h:41
lldb_private::ModuleChild::GetModule
lldb::ModuleSP GetModule() const
Get const accessor for the module pointer.
Definition: ModuleChild.cpp:24
DWARFUnitHeader::GetIndexEntry
const llvm::DWARFUnitIndex::Entry * GetIndexEntry() const
Definition: DWARFUnit.h:64
DWARFUnit::GetLengthByteSize
size_t GetLengthByteSize() const
Get the size in bytes of the length field in the header.
Definition: DWARFUnit.h:138
lldb_private::DWARFDataExtractor::GetAsLLVM
llvm::DWARFDataExtractor GetAsLLVM() const
Definition: DWARFDataExtractor.cpp:24
uint16_t
lldb_private::DataExtractor::GetU32
uint32_t GetU32(lldb::offset_t *offset_ptr) const
Extract a uint32_t value from *offset_ptr.
Definition: DataExtractor.cpp:427
DWARFUnit::m_first_die_mutex
llvm::sys::RWMutex m_first_die_mutex
Definition: DWARFUnit.h:305
DWARFDebugInfoEntry::SetParentIndex
void SetParentIndex(uint32_t idx)
Definition: DWARFDebugInfoEntry.h:157
DWARFUnit::GetLocationData
lldb_private::DWARFDataExtractor GetLocationData() const
Definition: DWARFUnit.cpp:503
LLDB_INVALID_ADDRESS
#define LLDB_INVALID_ADDRESS
Definition: lldb-defines.h:74
eProducerOther
@ eProducerOther
Definition: DWARFUnit.h:33
DWARFAttributes::AttributeAtIndex
dw_attr_t AttributeAtIndex(uint32_t i) const
Definition: DWARFAttribute.h:55
DWARFUnit::ComputeAbsolutePath
void ComputeAbsolutePath()
Definition: DWARFUnit.cpp:802
DWARFUnit::ExtractUnitDIEIfNeeded
void ExtractUnitDIEIfNeeded()
Definition: DWARFUnit.cpp:71
DWARFTypeUnit.h
DWARFUnit::GetUserData
void * GetUserData() const
Definition: DWARFUnit.cpp:644
lldb::user_id_t
uint64_t user_id_t
Definition: lldb-types.h:84
DWARFUnit::m_die_array
DWARFDebugInfoEntry::collection m_die_array
Definition: DWARFUnit.h:294
DWARFUnit::GetProducerVersion
llvm::VersionTuple GetProducerVersion()
Definition: DWARFUnit.cpp:706
DWARFUnit::m_gnu_ranges_base
llvm::Optional< uint64_t > m_gnu_ranges_base
Definition: DWARFUnit.h:320
lldb_private
A class that represents a running process on the host machine.
Definition: SBCommandInterpreterRunOptions.h:16
lldb_private::DataExtractor::GetU16
uint16_t GetU16(lldb::offset_t *offset_ptr) const
Extract a uint16_t value from *offset_ptr.
Definition: DataExtractor.cpp:349
lldb_private::eLazyBoolCalculate
@ eLazyBoolCalculate
Definition: lldb-private-enumerations.h:115
DWARFUnitHeader::extract
static llvm::Expected< DWARFUnitHeader > extract(const lldb_private::DWARFDataExtractor &data, DIERef::Section section, lldb_private::DWARFContext &dwarf_context, lldb::offset_t *offset_ptr)
Definition: DWARFUnit.cpp:844
Error
llvm::Error Error
Definition: UdtRecordCompleter.cpp:29
DWARFDebugAbbrev::GetAbbreviationDeclarationSet
const DWARFAbbreviationDeclarationSet * GetAbbreviationDeclarationSet(dw_offset_t cu_abbr_offset) const
Definition: DWARFDebugAbbrev.cpp:124
lldb_private::DWARFContext::getOrLoadLocData
const DWARFDataExtractor & getOrLoadLocData()
Definition: DWARFContext.cpp:83
lldb_private::RegularExpression::Execute
bool Execute(llvm::StringRef string, llvm::SmallVectorImpl< llvm::StringRef > *matches=nullptr) const
Execute a regular expression match using the compiled regular expression that is already in this obje...
Definition: RegularExpression.cpp:23
DWARFUnit::SetAddrBase
void SetAddrBase(dw_addr_t addr_base)
Definition: DWARFUnit.cpp:430
Entry
FormatEntity::Entry Entry
Definition: FormatEntity.cpp:82
lldb_private::DataExtractor::GetData
const void * GetData(lldb::offset_t *offset_ptr, lldb::offset_t length) const
Extract length bytes from *offset_ptr.
Definition: DataExtractor.h:337
lldb_private::DWARFContext::getOrLoadDebugTypesData
const DWARFDataExtractor & getOrLoadDebugTypesData()
Definition: DWARFContext.cpp:121
DWARFDebugInfoEntry::GetAttributes
size_t GetAttributes(DWARFUnit *cu, DWARFAttributes &attrs, Recurse recurse=Recurse::yes) const
Definition: DWARFDebugInfoEntry.h:51
DWARFUnit::ContainsDIEOffset
bool ContainsDIEOffset(dw_offset_t die_offset) const
Definition: DWARFUnit.h:140
DWARFUnit::GetDefaultAddressSize
static uint8_t GetDefaultAddressSize()
Definition: DWARFUnit.cpp:642
DWARFUnit::GetSymbolFileDWARF
SymbolFileDWARF & GetSymbolFileDWARF() const
Definition: DWARFUnit.h:195
DWARFUnit::m_die_array_mutex
llvm::sys::RWMutex m_die_array_mutex
Definition: DWARFUnit.h:295
DWARFDebugInfoEntry::IsNULL
bool IsNULL() const
Definition: DWARFDebugInfoEntry.h:116
DWARFUnit::GetAbbreviations
const DWARFAbbreviationDeclarationSet * GetAbbreviations() const
Definition: DWARFUnit.cpp:417
DWARFUnit::FindRnglistFromIndex
llvm::Expected< DWARFRangeList > FindRnglistFromIndex(uint32_t index)
Return a list of address ranges retrieved from an encoded range list whose offset is found via a tabl...
Definition: DWARFUnit.cpp:1034
dw_addr_t
uint64_t dw_addr_t
Definition: dwarf.h:26
DWARFUnit::GetIsOptimized
bool GetIsOptimized()
Definition: DWARFUnit.cpp:724
GetDWOId
static uint64_t GetDWOId(DWARFCompileUnit &dwarf_cu, const DWARFDebugInfoEntry &cu_die)
Return the DW_AT_(GNU_)dwo_id.
Definition: SymbolFileDWARF.cpp:1685
DWARFUnit::SetDwoStrOffsetsBase
void SetDwoStrOffsetsBase()
Definition: DWARFUnit.cpp:318
lldb::eByteOrderLittle
@ eByteOrderLittle
Definition: lldb-enumerations.h:142
DWARFDebugInfoEntry::GetAttributeValueAsUnsigned
uint64_t GetAttributeValueAsUnsigned(const DWARFUnit *cu, const dw_attr_t attr, uint64_t fail_value, bool check_specification_or_abstract_origin=false) const
Definition: DWARFDebugInfoEntry.cpp:538
lldb
Definition: SBAddress.h:15
DWARFUnit::m_loclist_table_header
llvm::Optional< llvm::DWARFListTableHeader > m_loclist_table_header
Definition: DWARFUnit.h:329
DWARFUnitHeader::m_dwo_id
uint64_t m_dwo_id
Definition: DWARFUnit.h:53
DIERef::Section
Section
Definition: DIERef.h:28
DWARFUnit::GetFile
lldb_private::FileSpec GetFile(size_t file_idx)
Definition: DWARFUnit.cpp:756
lldb::ByteOrder
ByteOrder
Byte ordering definitions.
Definition: lldb-enumerations.h:138
DWARFBaseDIE
Definition: DWARFBaseDIE.h:25
DWARFUnit::GetAbsolutePath
const lldb_private::FileSpec & GetAbsolutePath()
Definition: DWARFUnit.cpp:750
lldb_private::DWARFContext::getOrLoadLocListsData
const DWARFDataExtractor & getOrLoadLocListsData()
Definition: DWARFContext.cpp:88
DWARFBaseDIE::IsValid
bool IsValid() const
Definition: DWARFBaseDIE.h:45
DWARFUnitHeader::GetLength
dw_offset_t GetLength() const
Definition: DWARFUnit.h:61
DWARFUnit::m_file_spec
llvm::Optional< lldb_private::FileSpec > m_file_spec
Definition: DWARFUnit.h:315
DWARFUnit::GetDIE
DWARFDIE GetDIE(dw_offset_t die_offset)
Definition: DWARFUnit.cpp:608