1 //===-- SymbolFileDWARF.cpp ------------------------------------*- C++ -*-===//
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 "SymbolFileDWARF.h"
10 
11 #include "llvm/Support/Casting.h"
12 #include "llvm/Support/Threading.h"
13 
14 #include "lldb/Core/Module.h"
15 #include "lldb/Core/ModuleList.h"
16 #include "lldb/Core/ModuleSpec.h"
17 #include "lldb/Core/PluginManager.h"
18 #include "lldb/Core/Section.h"
19 #include "lldb/Core/StreamFile.h"
20 #include "lldb/Core/Value.h"
21 #include "lldb/Utility/ArchSpec.h"
22 #include "lldb/Utility/RegularExpression.h"
23 #include "lldb/Utility/Scalar.h"
24 #include "lldb/Utility/StreamString.h"
25 #include "lldb/Utility/Timer.h"
26 
27 #include "Plugins/ExpressionParser/Clang/ClangModulesDeclVendor.h"
28 #include "Plugins/Language/CPlusPlus/CPlusPlusLanguage.h"
29 
30 #include "lldb/Host/FileSystem.h"
31 #include "lldb/Host/Host.h"
32 
33 #include "lldb/Interpreter/OptionValueFileSpecList.h"
34 #include "lldb/Interpreter/OptionValueProperties.h"
35 
36 #include "lldb/Symbol/Block.h"
37 #include "lldb/Symbol/ClangASTContext.h"
38 #include "lldb/Symbol/ClangUtil.h"
39 #include "lldb/Symbol/CompileUnit.h"
40 #include "lldb/Symbol/CompilerDecl.h"
41 #include "lldb/Symbol/CompilerDeclContext.h"
42 #include "lldb/Symbol/DebugMacros.h"
43 #include "lldb/Symbol/LineTable.h"
44 #include "lldb/Symbol/LocateSymbolFile.h"
45 #include "lldb/Symbol/ObjectFile.h"
46 #include "lldb/Symbol/SymbolVendor.h"
47 #include "lldb/Symbol/TypeMap.h"
48 #include "lldb/Symbol/TypeSystem.h"
49 #include "lldb/Symbol/VariableList.h"
50 
51 #include "lldb/Target/Language.h"
52 #include "lldb/Target/Target.h"
53 
54 #include "AppleDWARFIndex.h"
55 #include "DWARFASTParser.h"
56 #include "DWARFASTParserClang.h"
57 #include "DWARFDebugAbbrev.h"
58 #include "DWARFDebugAranges.h"
59 #include "DWARFDebugInfo.h"
60 #include "DWARFDebugLine.h"
61 #include "DWARFDebugMacro.h"
62 #include "DWARFDebugRanges.h"
63 #include "DWARFDeclContext.h"
64 #include "DWARFFormValue.h"
65 #include "DWARFUnit.h"
66 #include "DebugNamesDWARFIndex.h"
67 #include "LogChannelDWARF.h"
68 #include "ManualDWARFIndex.h"
69 #include "SymbolFileDWARFDebugMap.h"
70 #include "SymbolFileDWARFDwo.h"
71 #include "SymbolFileDWARFDwp.h"
72 
73 #include "llvm/Support/FileSystem.h"
74 
75 #include <algorithm>
76 #include <map>
77 #include <memory>
78 
79 #include <ctype.h>
80 #include <string.h>
81 
82 //#define ENABLE_DEBUG_PRINTF // COMMENT OUT THIS LINE PRIOR TO CHECKIN
83 
84 #ifdef ENABLE_DEBUG_PRINTF
85 #include <stdio.h>
86 #define DEBUG_PRINTF(fmt, ...) printf(fmt, __VA_ARGS__)
87 #else
88 #define DEBUG_PRINTF(fmt, ...)
89 #endif
90 
91 using namespace lldb;
92 using namespace lldb_private;
93 
94 // static inline bool
95 // child_requires_parent_class_union_or_struct_to_be_completed (dw_tag_t tag)
96 //{
97 //    switch (tag)
98 //    {
99 //    default:
100 //        break;
101 //    case DW_TAG_subprogram:
102 //    case DW_TAG_inlined_subroutine:
103 //    case DW_TAG_class_type:
104 //    case DW_TAG_structure_type:
105 //    case DW_TAG_union_type:
106 //        return true;
107 //    }
108 //    return false;
109 //}
110 //
111 
112 namespace {
113 
114 static constexpr PropertyDefinition g_properties[] = {
115     {"comp-dir-symlink-paths", OptionValue::eTypeFileSpecList, true, 0, nullptr,
116      {},
117      "If the DW_AT_comp_dir matches any of these paths the symbolic "
118      "links will be resolved at DWARF parse time."},
119     {"ignore-file-indexes", OptionValue::eTypeBoolean, true, 0, nullptr, {},
120      "Ignore indexes present in the object files and always index DWARF "
121      "manually."}};
122 
123 enum {
124   ePropertySymLinkPaths,
125   ePropertyIgnoreIndexes,
126 };
127 
128 class PluginProperties : public Properties {
129 public:
130   static ConstString GetSettingName() {
131     return SymbolFileDWARF::GetPluginNameStatic();
132   }
133 
134   PluginProperties() {
135     m_collection_sp = std::make_shared<OptionValueProperties>(GetSettingName());
136     m_collection_sp->Initialize(g_properties);
137   }
138 
139   FileSpecList GetSymLinkPaths() {
140     const OptionValueFileSpecList *option_value =
141         m_collection_sp->GetPropertyAtIndexAsOptionValueFileSpecList(
142             nullptr, true, ePropertySymLinkPaths);
143     assert(option_value);
144     return option_value->GetCurrentValue();
145   }
146 
147   bool IgnoreFileIndexes() const {
148     return m_collection_sp->GetPropertyAtIndexAsBoolean(
149         nullptr, ePropertyIgnoreIndexes, false);
150   }
151 };
152 
153 typedef std::shared_ptr<PluginProperties> SymbolFileDWARFPropertiesSP;
154 
155 static const SymbolFileDWARFPropertiesSP &GetGlobalPluginProperties() {
156   static const auto g_settings_sp(std::make_shared<PluginProperties>());
157   return g_settings_sp;
158 }
159 
160 } // anonymous namespace end
161 
162 FileSpecList SymbolFileDWARF::GetSymlinkPaths() {
163   return GetGlobalPluginProperties()->GetSymLinkPaths();
164 }
165 
166 DWARFUnit *SymbolFileDWARF::GetBaseCompileUnit() {
167   return nullptr;
168 }
169 
170 void SymbolFileDWARF::Initialize() {
171   LogChannelDWARF::Initialize();
172   PluginManager::RegisterPlugin(GetPluginNameStatic(),
173                                 GetPluginDescriptionStatic(), CreateInstance,
174                                 DebuggerInitialize);
175 }
176 
177 void SymbolFileDWARF::DebuggerInitialize(Debugger &debugger) {
178   if (!PluginManager::GetSettingForSymbolFilePlugin(
179           debugger, PluginProperties::GetSettingName())) {
180     const bool is_global_setting = true;
181     PluginManager::CreateSettingForSymbolFilePlugin(
182         debugger, GetGlobalPluginProperties()->GetValueProperties(),
183         ConstString("Properties for the dwarf symbol-file plug-in."),
184         is_global_setting);
185   }
186 }
187 
188 void SymbolFileDWARF::Terminate() {
189   PluginManager::UnregisterPlugin(CreateInstance);
190   LogChannelDWARF::Terminate();
191 }
192 
193 lldb_private::ConstString SymbolFileDWARF::GetPluginNameStatic() {
194   static ConstString g_name("dwarf");
195   return g_name;
196 }
197 
198 const char *SymbolFileDWARF::GetPluginDescriptionStatic() {
199   return "DWARF and DWARF3 debug symbol file reader.";
200 }
201 
202 SymbolFile *SymbolFileDWARF::CreateInstance(ObjectFile *obj_file) {
203   return new SymbolFileDWARF(obj_file);
204 }
205 
206 TypeList *SymbolFileDWARF::GetTypeList() {
207   // This method can be called without going through the symbol vendor so we
208   // need to lock the module.
209   std::lock_guard<std::recursive_mutex> guard(GetModuleMutex());
210   SymbolFileDWARFDebugMap *debug_map_symfile = GetDebugMapSymfile();
211   if (debug_map_symfile)
212     return debug_map_symfile->GetTypeList();
213   else
214     return m_obj_file->GetModule()->GetTypeList();
215 }
216 void SymbolFileDWARF::GetTypes(const DWARFDIE &die, dw_offset_t min_die_offset,
217                                dw_offset_t max_die_offset, uint32_t type_mask,
218                                TypeSet &type_set) {
219   if (die) {
220     const dw_offset_t die_offset = die.GetOffset();
221 
222     if (die_offset >= max_die_offset)
223       return;
224 
225     if (die_offset >= min_die_offset) {
226       const dw_tag_t tag = die.Tag();
227 
228       bool add_type = false;
229 
230       switch (tag) {
231       case DW_TAG_array_type:
232         add_type = (type_mask & eTypeClassArray) != 0;
233         break;
234       case DW_TAG_unspecified_type:
235       case DW_TAG_base_type:
236         add_type = (type_mask & eTypeClassBuiltin) != 0;
237         break;
238       case DW_TAG_class_type:
239         add_type = (type_mask & eTypeClassClass) != 0;
240         break;
241       case DW_TAG_structure_type:
242         add_type = (type_mask & eTypeClassStruct) != 0;
243         break;
244       case DW_TAG_union_type:
245         add_type = (type_mask & eTypeClassUnion) != 0;
246         break;
247       case DW_TAG_enumeration_type:
248         add_type = (type_mask & eTypeClassEnumeration) != 0;
249         break;
250       case DW_TAG_subroutine_type:
251       case DW_TAG_subprogram:
252       case DW_TAG_inlined_subroutine:
253         add_type = (type_mask & eTypeClassFunction) != 0;
254         break;
255       case DW_TAG_pointer_type:
256         add_type = (type_mask & eTypeClassPointer) != 0;
257         break;
258       case DW_TAG_rvalue_reference_type:
259       case DW_TAG_reference_type:
260         add_type = (type_mask & eTypeClassReference) != 0;
261         break;
262       case DW_TAG_typedef:
263         add_type = (type_mask & eTypeClassTypedef) != 0;
264         break;
265       case DW_TAG_ptr_to_member_type:
266         add_type = (type_mask & eTypeClassMemberPointer) != 0;
267         break;
268       }
269 
270       if (add_type) {
271         const bool assert_not_being_parsed = true;
272         Type *type = ResolveTypeUID(die, assert_not_being_parsed);
273         if (type) {
274           if (type_set.find(type) == type_set.end())
275             type_set.insert(type);
276         }
277       }
278     }
279 
280     for (DWARFDIE child_die = die.GetFirstChild(); child_die.IsValid();
281          child_die = child_die.GetSibling()) {
282       GetTypes(child_die, min_die_offset, max_die_offset, type_mask, type_set);
283     }
284   }
285 }
286 
287 size_t SymbolFileDWARF::GetTypes(SymbolContextScope *sc_scope,
288                                  TypeClass type_mask, TypeList &type_list)
289 
290 {
291   ASSERT_MODULE_LOCK(this);
292   TypeSet type_set;
293 
294   CompileUnit *comp_unit = NULL;
295   DWARFUnit *dwarf_cu = NULL;
296   if (sc_scope)
297     comp_unit = sc_scope->CalculateSymbolContextCompileUnit();
298 
299   if (comp_unit) {
300     dwarf_cu = GetDWARFCompileUnit(comp_unit);
301     if (dwarf_cu == 0)
302       return 0;
303     GetTypes(dwarf_cu->DIE(), dwarf_cu->GetOffset(),
304              dwarf_cu->GetNextCompileUnitOffset(), type_mask, type_set);
305   } else {
306     DWARFDebugInfo *info = DebugInfo();
307     if (info) {
308       const size_t num_cus = info->GetNumCompileUnits();
309       for (size_t cu_idx = 0; cu_idx < num_cus; ++cu_idx) {
310         dwarf_cu = info->GetCompileUnitAtIndex(cu_idx);
311         if (dwarf_cu) {
312           GetTypes(dwarf_cu->DIE(), 0, UINT32_MAX, type_mask, type_set);
313         }
314       }
315     }
316   }
317 
318   std::set<CompilerType> compiler_type_set;
319   size_t num_types_added = 0;
320   for (Type *type : type_set) {
321     CompilerType compiler_type = type->GetForwardCompilerType();
322     if (compiler_type_set.find(compiler_type) == compiler_type_set.end()) {
323       compiler_type_set.insert(compiler_type);
324       type_list.Insert(type->shared_from_this());
325       ++num_types_added;
326     }
327   }
328   return num_types_added;
329 }
330 
331 // Gets the first parent that is a lexical block, function or inlined
332 // subroutine, or compile unit.
333 DWARFDIE
334 SymbolFileDWARF::GetParentSymbolContextDIE(const DWARFDIE &child_die) {
335   DWARFDIE die;
336   for (die = child_die.GetParent(); die; die = die.GetParent()) {
337     dw_tag_t tag = die.Tag();
338 
339     switch (tag) {
340     case DW_TAG_compile_unit:
341     case DW_TAG_partial_unit:
342     case DW_TAG_subprogram:
343     case DW_TAG_inlined_subroutine:
344     case DW_TAG_lexical_block:
345       return die;
346     }
347   }
348   return DWARFDIE();
349 }
350 
351 SymbolFileDWARF::SymbolFileDWARF(ObjectFile *objfile)
352     : SymbolFile(objfile), UserID(uint64_t(DW_INVALID_OFFSET)
353                                   << 32), // Used by SymbolFileDWARFDebugMap to
354                                           // when this class parses .o files to
355                                           // contain the .o file index/ID
356       m_debug_map_module_wp(), m_debug_map_symfile(NULL),
357       m_context(*objfile->GetModule()), m_data_debug_abbrev(),
358       m_data_debug_frame(), m_data_debug_info(), m_data_debug_line(),
359       m_data_debug_macro(), m_data_debug_loc(), m_data_debug_ranges(),
360       m_data_debug_rnglists(), m_data_debug_str(), m_data_apple_names(),
361       m_data_apple_types(), m_data_apple_namespaces(), m_abbr(), m_info(),
362       m_line(), m_fetched_external_modules(false),
363       m_supports_DW_AT_APPLE_objc_complete_type(eLazyBoolCalculate), m_ranges(),
364       m_unique_ast_type_map() {}
365 
366 SymbolFileDWARF::~SymbolFileDWARF() {}
367 
368 static ConstString GetDWARFMachOSegmentName() {
369   static ConstString g_dwarf_section_name("__DWARF");
370   return g_dwarf_section_name;
371 }
372 
373 UniqueDWARFASTTypeMap &SymbolFileDWARF::GetUniqueDWARFASTTypeMap() {
374   SymbolFileDWARFDebugMap *debug_map_symfile = GetDebugMapSymfile();
375   if (debug_map_symfile)
376     return debug_map_symfile->GetUniqueDWARFASTTypeMap();
377   else
378     return m_unique_ast_type_map;
379 }
380 
381 TypeSystem *SymbolFileDWARF::GetTypeSystemForLanguage(LanguageType language) {
382   SymbolFileDWARFDebugMap *debug_map_symfile = GetDebugMapSymfile();
383   TypeSystem *type_system;
384   if (debug_map_symfile) {
385     type_system = debug_map_symfile->GetTypeSystemForLanguage(language);
386   } else {
387     type_system = m_obj_file->GetModule()->GetTypeSystemForLanguage(language);
388     if (type_system)
389       type_system->SetSymbolFile(this);
390   }
391   return type_system;
392 }
393 
394 void SymbolFileDWARF::InitializeObject() {
395   Log *log = LogChannelDWARF::GetLogIfAll(DWARF_LOG_DEBUG_INFO);
396 
397   if (!GetGlobalPluginProperties()->IgnoreFileIndexes()) {
398     DWARFDataExtractor apple_names, apple_namespaces, apple_types, apple_objc;
399     LoadSectionData(eSectionTypeDWARFAppleNames, apple_names);
400     LoadSectionData(eSectionTypeDWARFAppleNamespaces, apple_namespaces);
401     LoadSectionData(eSectionTypeDWARFAppleTypes, apple_types);
402     LoadSectionData(eSectionTypeDWARFAppleObjC, apple_objc);
403 
404     m_index = AppleDWARFIndex::Create(
405         *GetObjectFile()->GetModule(), apple_names, apple_namespaces,
406         apple_types, apple_objc, get_debug_str_data());
407 
408     if (m_index)
409       return;
410 
411     DWARFDataExtractor debug_names;
412     LoadSectionData(eSectionTypeDWARFDebugNames, debug_names);
413     if (debug_names.GetByteSize() > 0) {
414       llvm::Expected<std::unique_ptr<DebugNamesDWARFIndex>> index_or =
415           DebugNamesDWARFIndex::Create(*GetObjectFile()->GetModule(),
416                                        debug_names, get_debug_str_data(),
417                                        DebugInfo());
418       if (index_or) {
419         m_index = std::move(*index_or);
420         return;
421       }
422       LLDB_LOG_ERROR(log, index_or.takeError(),
423                      "Unable to read .debug_names data: {0}");
424     }
425   }
426 
427   m_index = llvm::make_unique<ManualDWARFIndex>(*GetObjectFile()->GetModule(),
428                                                 DebugInfo());
429 }
430 
431 bool SymbolFileDWARF::SupportedVersion(uint16_t version) {
432   return version >= 2 && version <= 5;
433 }
434 
435 uint32_t SymbolFileDWARF::CalculateAbilities() {
436   uint32_t abilities = 0;
437   if (m_obj_file != NULL) {
438     const Section *section = NULL;
439     const SectionList *section_list = m_obj_file->GetSectionList();
440     if (section_list == NULL)
441       return 0;
442 
443     // On non Apple platforms we might have .debug_types debug info that is
444     // created by using "-fdebug-types-section". LLDB currently will try to
445     // load this debug info, but it causes crashes during debugging when types
446     // are missing since it doesn't know how to parse the info in the
447     // .debug_types type units. This causes all complex debug info types to be
448     // unresolved. Because this causes LLDB to crash and since it really
449     // doesn't provide a solid debuggiung experience, we should disable trying
450     // to debug this kind of DWARF until support gets added or deprecated.
451     if (section_list->FindSectionByName(ConstString(".debug_types"))) {
452       m_obj_file->GetModule()->ReportWarning(
453         "lldb doesn’t support .debug_types debug info");
454       return 0;
455     }
456 
457     uint64_t debug_abbrev_file_size = 0;
458     uint64_t debug_info_file_size = 0;
459     uint64_t debug_line_file_size = 0;
460 
461     section = section_list->FindSectionByName(GetDWARFMachOSegmentName()).get();
462 
463     if (section)
464       section_list = &section->GetChildren();
465 
466     section =
467         section_list->FindSectionByType(eSectionTypeDWARFDebugInfo, true).get();
468     if (section != NULL) {
469       debug_info_file_size = section->GetFileSize();
470 
471       section =
472           section_list->FindSectionByType(eSectionTypeDWARFDebugAbbrev, true)
473               .get();
474       if (section)
475         debug_abbrev_file_size = section->GetFileSize();
476 
477       DWARFDebugAbbrev *abbrev = DebugAbbrev();
478       if (abbrev) {
479         std::set<dw_form_t> invalid_forms;
480         abbrev->GetUnsupportedForms(invalid_forms);
481         if (!invalid_forms.empty()) {
482           StreamString error;
483           error.Printf("unsupported DW_FORM value%s:", invalid_forms.size() > 1 ? "s" : "");
484           for (auto form : invalid_forms)
485             error.Printf(" %#x", form);
486           m_obj_file->GetModule()->ReportWarning("%s", error.GetString().str().c_str());
487           return 0;
488         }
489       }
490 
491       section =
492           section_list->FindSectionByType(eSectionTypeDWARFDebugLine, true)
493               .get();
494       if (section)
495         debug_line_file_size = section->GetFileSize();
496     } else {
497       const char *symfile_dir_cstr =
498           m_obj_file->GetFileSpec().GetDirectory().GetCString();
499       if (symfile_dir_cstr) {
500         if (strcasestr(symfile_dir_cstr, ".dsym")) {
501           if (m_obj_file->GetType() == ObjectFile::eTypeDebugInfo) {
502             // We have a dSYM file that didn't have a any debug info. If the
503             // string table has a size of 1, then it was made from an
504             // executable with no debug info, or from an executable that was
505             // stripped.
506             section =
507                 section_list->FindSectionByType(eSectionTypeDWARFDebugStr, true)
508                     .get();
509             if (section && section->GetFileSize() == 1) {
510               m_obj_file->GetModule()->ReportWarning(
511                   "empty dSYM file detected, dSYM was created with an "
512                   "executable with no debug info.");
513             }
514           }
515         }
516       }
517     }
518 
519     if (debug_abbrev_file_size > 0 && debug_info_file_size > 0)
520       abilities |= CompileUnits | Functions | Blocks | GlobalVariables |
521                    LocalVariables | VariableTypes;
522 
523     if (debug_line_file_size > 0)
524       abilities |= LineTables;
525   }
526   return abilities;
527 }
528 
529 const DWARFDataExtractor &
530 SymbolFileDWARF::GetCachedSectionData(lldb::SectionType sect_type,
531                                       DWARFDataSegment &data_segment) {
532   llvm::call_once(data_segment.m_flag, [this, sect_type, &data_segment] {
533     this->LoadSectionData(sect_type, std::ref(data_segment.m_data));
534   });
535   return data_segment.m_data;
536 }
537 
538 void SymbolFileDWARF::LoadSectionData(lldb::SectionType sect_type,
539                                       DWARFDataExtractor &data) {
540   ModuleSP module_sp(m_obj_file->GetModule());
541   const SectionList *section_list = module_sp->GetSectionList();
542   if (!section_list)
543     return;
544 
545   SectionSP section_sp(section_list->FindSectionByType(sect_type, true));
546   if (!section_sp)
547     return;
548 
549   data.Clear();
550   m_obj_file->ReadSectionData(section_sp.get(), data);
551 }
552 
553 const DWARFDataExtractor &SymbolFileDWARF::get_debug_abbrev_data() {
554   return GetCachedSectionData(eSectionTypeDWARFDebugAbbrev,
555                               m_data_debug_abbrev);
556 }
557 
558 const DWARFDataExtractor &SymbolFileDWARF::get_debug_addr_data() {
559   return GetCachedSectionData(eSectionTypeDWARFDebugAddr, m_data_debug_addr);
560 }
561 
562 const DWARFDataExtractor &SymbolFileDWARF::get_debug_frame_data() {
563   return GetCachedSectionData(eSectionTypeDWARFDebugFrame, m_data_debug_frame);
564 }
565 
566 const DWARFDataExtractor &SymbolFileDWARF::get_debug_info_data() {
567   return GetCachedSectionData(eSectionTypeDWARFDebugInfo, m_data_debug_info);
568 }
569 
570 const DWARFDataExtractor &SymbolFileDWARF::get_debug_line_data() {
571   return GetCachedSectionData(eSectionTypeDWARFDebugLine, m_data_debug_line);
572 }
573 
574 const DWARFDataExtractor &SymbolFileDWARF::get_debug_line_str_data() {
575  return GetCachedSectionData(eSectionTypeDWARFDebugLineStr, m_data_debug_line_str);
576 }
577 
578 const DWARFDataExtractor &SymbolFileDWARF::get_debug_macro_data() {
579   return GetCachedSectionData(eSectionTypeDWARFDebugMacro, m_data_debug_macro);
580 }
581 
582 const DWARFDataExtractor &SymbolFileDWARF::DebugLocData() {
583   const DWARFDataExtractor &debugLocData = get_debug_loc_data();
584   if (debugLocData.GetByteSize() > 0)
585     return debugLocData;
586   return get_debug_loclists_data();
587 }
588 
589 const DWARFDataExtractor &SymbolFileDWARF::get_debug_loc_data() {
590   return GetCachedSectionData(eSectionTypeDWARFDebugLoc, m_data_debug_loc);
591 }
592 
593 const DWARFDataExtractor &SymbolFileDWARF::get_debug_loclists_data() {
594   return GetCachedSectionData(eSectionTypeDWARFDebugLocLists,
595                               m_data_debug_loclists);
596 }
597 
598 const DWARFDataExtractor &SymbolFileDWARF::get_debug_ranges_data() {
599   return GetCachedSectionData(eSectionTypeDWARFDebugRanges,
600                               m_data_debug_ranges);
601 }
602 
603 const DWARFDataExtractor &SymbolFileDWARF::get_debug_rnglists_data() {
604   return GetCachedSectionData(eSectionTypeDWARFDebugRngLists,
605                               m_data_debug_rnglists);
606 }
607 
608 const DWARFDataExtractor &SymbolFileDWARF::get_debug_str_data() {
609   return GetCachedSectionData(eSectionTypeDWARFDebugStr, m_data_debug_str);
610 }
611 
612 const DWARFDataExtractor &SymbolFileDWARF::get_debug_str_offsets_data() {
613   return GetCachedSectionData(eSectionTypeDWARFDebugStrOffsets,
614                               m_data_debug_str_offsets);
615 }
616 
617 const DWARFDataExtractor &SymbolFileDWARF::get_debug_types_data() {
618   return GetCachedSectionData(eSectionTypeDWARFDebugTypes, m_data_debug_types);
619 }
620 
621 const DWARFDataExtractor &SymbolFileDWARF::get_apple_names_data() {
622   return GetCachedSectionData(eSectionTypeDWARFAppleNames, m_data_apple_names);
623 }
624 
625 const DWARFDataExtractor &SymbolFileDWARF::get_apple_types_data() {
626   return GetCachedSectionData(eSectionTypeDWARFAppleTypes, m_data_apple_types);
627 }
628 
629 const DWARFDataExtractor &SymbolFileDWARF::get_apple_namespaces_data() {
630   return GetCachedSectionData(eSectionTypeDWARFAppleNamespaces,
631                               m_data_apple_namespaces);
632 }
633 
634 const DWARFDataExtractor &SymbolFileDWARF::get_apple_objc_data() {
635   return GetCachedSectionData(eSectionTypeDWARFAppleObjC, m_data_apple_objc);
636 }
637 
638 const DWARFDataExtractor &SymbolFileDWARF::get_gnu_debugaltlink() {
639   return GetCachedSectionData(eSectionTypeDWARFGNUDebugAltLink,
640                               m_data_gnu_debugaltlink);
641 }
642 
643 DWARFDebugAbbrev *SymbolFileDWARF::DebugAbbrev() {
644   if (m_abbr)
645     return m_abbr.get();
646 
647   const DWARFDataExtractor &debug_abbrev_data = get_debug_abbrev_data();
648   if (debug_abbrev_data.GetByteSize() == 0)
649     return nullptr;
650 
651   auto abbr = llvm::make_unique<DWARFDebugAbbrev>();
652   llvm::Error error = abbr->parse(debug_abbrev_data);
653   if (error) {
654     Log *log = LogChannelDWARF::GetLogIfAll(DWARF_LOG_DEBUG_INFO);
655     LLDB_LOG_ERROR(log, std::move(error),
656                    "Unable to read .debug_abbrev section: {0}");
657     return nullptr;
658   }
659 
660   m_abbr = std::move(abbr);
661   return m_abbr.get();
662 }
663 
664 const DWARFDebugAbbrev *SymbolFileDWARF::DebugAbbrev() const {
665   return m_abbr.get();
666 }
667 
668 DWARFDebugInfo *SymbolFileDWARF::DebugInfo() {
669   if (m_info == NULL) {
670     static Timer::Category func_cat(LLVM_PRETTY_FUNCTION);
671     Timer scoped_timer(func_cat, "%s this = %p", LLVM_PRETTY_FUNCTION,
672                        static_cast<void *>(this));
673     if (get_debug_info_data().GetByteSize() > 0) {
674       m_info = llvm::make_unique<DWARFDebugInfo>(m_context);
675       m_info->SetDwarfData(this);
676     }
677   }
678   return m_info.get();
679 }
680 
681 const DWARFDebugInfo *SymbolFileDWARF::DebugInfo() const {
682   return m_info.get();
683 }
684 
685 DWARFUnit *
686 SymbolFileDWARF::GetDWARFCompileUnit(lldb_private::CompileUnit *comp_unit) {
687   if (!comp_unit)
688     return nullptr;
689 
690   DWARFDebugInfo *info = DebugInfo();
691   if (info) {
692     // The compile unit ID is the index of the DWARF unit.
693     DWARFUnit *dwarf_cu = info->GetCompileUnitAtIndex(comp_unit->GetID());
694     if (dwarf_cu && dwarf_cu->GetUserData() == NULL)
695       dwarf_cu->SetUserData(comp_unit);
696     return dwarf_cu;
697   }
698   return NULL;
699 }
700 
701 DWARFDebugRangesBase *SymbolFileDWARF::DebugRanges() {
702   if (m_ranges == NULL) {
703     static Timer::Category func_cat(LLVM_PRETTY_FUNCTION);
704     Timer scoped_timer(func_cat, "%s this = %p", LLVM_PRETTY_FUNCTION,
705                        static_cast<void *>(this));
706 
707     if (get_debug_ranges_data().GetByteSize() > 0)
708       m_ranges.reset(new DWARFDebugRanges());
709     else if (get_debug_rnglists_data().GetByteSize() > 0)
710       m_ranges.reset(new DWARFDebugRngLists());
711 
712     if (m_ranges)
713       m_ranges->Extract(this);
714   }
715   return m_ranges.get();
716 }
717 
718 const DWARFDebugRangesBase *SymbolFileDWARF::DebugRanges() const {
719   return m_ranges.get();
720 }
721 
722 lldb::CompUnitSP SymbolFileDWARF::ParseCompileUnit(DWARFUnit *dwarf_cu,
723                                                    uint32_t cu_idx) {
724   CompUnitSP cu_sp;
725   if (dwarf_cu) {
726     CompileUnit *comp_unit = (CompileUnit *)dwarf_cu->GetUserData();
727     if (comp_unit) {
728       // We already parsed this compile unit, had out a shared pointer to it
729       cu_sp = comp_unit->shared_from_this();
730     } else {
731       if (dwarf_cu->GetSymbolFileDWARF() != this) {
732         return dwarf_cu->GetSymbolFileDWARF()->ParseCompileUnit(dwarf_cu,
733                                                                 cu_idx);
734       } else if (dwarf_cu->GetOffset() == 0 && GetDebugMapSymfile()) {
735         // Let the debug map create the compile unit
736         cu_sp = m_debug_map_symfile->GetCompileUnit(this);
737         dwarf_cu->SetUserData(cu_sp.get());
738       } else {
739         ModuleSP module_sp(m_obj_file->GetModule());
740         if (module_sp) {
741           const DWARFDIE cu_die = dwarf_cu->DIE();
742           if (cu_die) {
743             FileSpec cu_file_spec(cu_die.GetName(), dwarf_cu->GetPathStyle());
744             if (cu_file_spec) {
745               // If we have a full path to the compile unit, we don't need to
746               // resolve the file.  This can be expensive e.g. when the source
747               // files are NFS mounted.
748               cu_file_spec.MakeAbsolute(dwarf_cu->GetCompilationDirectory());
749 
750               std::string remapped_file;
751               if (module_sp->RemapSourceFile(cu_file_spec.GetPath(),
752                                              remapped_file))
753                 cu_file_spec.SetFile(remapped_file, FileSpec::Style::native);
754             }
755 
756             LanguageType cu_language = DWARFUnit::LanguageTypeFromDWARF(
757                 cu_die.GetAttributeValueAsUnsigned(DW_AT_language, 0));
758 
759             bool is_optimized = dwarf_cu->GetIsOptimized();
760             cu_sp = std::make_shared<CompileUnit>(
761                 module_sp, dwarf_cu, cu_file_spec, dwarf_cu->GetID(),
762                 cu_language, is_optimized ? eLazyBoolYes : eLazyBoolNo);
763             if (cu_sp) {
764               // If we just created a compile unit with an invalid file spec,
765               // try and get the first entry in the supports files from the
766               // line table as that should be the compile unit.
767               if (!cu_file_spec) {
768                 cu_file_spec = cu_sp->GetSupportFiles().GetFileSpecAtIndex(1);
769                 if (cu_file_spec) {
770                   (FileSpec &)(*cu_sp) = cu_file_spec;
771                   // Also fix the invalid file spec which was copied from the
772                   // compile unit.
773                   cu_sp->GetSupportFiles().Replace(0, cu_file_spec);
774                 }
775               }
776 
777               dwarf_cu->SetUserData(cu_sp.get());
778 
779               // Figure out the compile unit index if we weren't given one
780               if (cu_idx == UINT32_MAX)
781                 cu_idx = dwarf_cu->GetID();
782 
783               m_obj_file->GetModule()->GetSymbolVendor()->SetCompileUnitAtIndex(
784                   cu_idx, cu_sp);
785             }
786           }
787         }
788       }
789     }
790   }
791   return cu_sp;
792 }
793 
794 uint32_t SymbolFileDWARF::GetNumCompileUnits() {
795   DWARFDebugInfo *info = DebugInfo();
796   if (info)
797     return info->GetNumCompileUnits();
798   return 0;
799 }
800 
801 CompUnitSP SymbolFileDWARF::ParseCompileUnitAtIndex(uint32_t cu_idx) {
802   ASSERT_MODULE_LOCK(this);
803   CompUnitSP cu_sp;
804   DWARFDebugInfo *info = DebugInfo();
805   if (info) {
806     DWARFUnit *dwarf_cu = info->GetCompileUnitAtIndex(cu_idx);
807     if (dwarf_cu)
808       cu_sp = ParseCompileUnit(dwarf_cu, cu_idx);
809   }
810   return cu_sp;
811 }
812 
813 Function *SymbolFileDWARF::ParseFunction(CompileUnit &comp_unit,
814                                          const DWARFDIE &die) {
815   ASSERT_MODULE_LOCK(this);
816   if (die.IsValid()) {
817     TypeSystem *type_system =
818         GetTypeSystemForLanguage(die.GetCU()->GetLanguageType());
819 
820     if (type_system) {
821       DWARFASTParser *dwarf_ast = type_system->GetDWARFParser();
822       if (dwarf_ast)
823         return dwarf_ast->ParseFunctionFromDWARF(comp_unit, die);
824     }
825   }
826   return nullptr;
827 }
828 
829 bool SymbolFileDWARF::FixupAddress(Address &addr) {
830   SymbolFileDWARFDebugMap *debug_map_symfile = GetDebugMapSymfile();
831   if (debug_map_symfile) {
832     return debug_map_symfile->LinkOSOAddress(addr);
833   }
834   // This is a normal DWARF file, no address fixups need to happen
835   return true;
836 }
837 lldb::LanguageType SymbolFileDWARF::ParseLanguage(CompileUnit &comp_unit) {
838   ASSERT_MODULE_LOCK(this);
839   DWARFUnit *dwarf_cu = GetDWARFCompileUnit(&comp_unit);
840   if (dwarf_cu)
841     return dwarf_cu->GetLanguageType();
842   else
843     return eLanguageTypeUnknown;
844 }
845 
846 size_t SymbolFileDWARF::ParseFunctions(CompileUnit &comp_unit) {
847   ASSERT_MODULE_LOCK(this);
848   DWARFUnit *dwarf_cu = GetDWARFCompileUnit(&comp_unit);
849   if (!dwarf_cu)
850     return 0;
851 
852   size_t functions_added = 0;
853   std::vector<DWARFDIE> function_dies;
854   dwarf_cu->AppendDIEsWithTag(DW_TAG_subprogram, function_dies);
855   for (const DWARFDIE &die : function_dies) {
856     if (comp_unit.FindFunctionByUID(die.GetID()))
857       continue;
858     if (ParseFunction(comp_unit, die))
859       ++functions_added;
860   }
861   // FixupTypes();
862   return functions_added;
863 }
864 
865 bool SymbolFileDWARF::ParseSupportFiles(CompileUnit &comp_unit,
866                                         FileSpecList &support_files) {
867   ASSERT_MODULE_LOCK(this);
868   DWARFUnit *dwarf_cu = GetDWARFCompileUnit(&comp_unit);
869   if (dwarf_cu) {
870     const DWARFBaseDIE cu_die = dwarf_cu->GetUnitDIEOnly();
871 
872     if (cu_die) {
873       const dw_offset_t stmt_list = cu_die.GetAttributeValueAsUnsigned(
874           DW_AT_stmt_list, DW_INVALID_OFFSET);
875       if (stmt_list != DW_INVALID_OFFSET) {
876         // All file indexes in DWARF are one based and a file of index zero is
877         // supposed to be the compile unit itself.
878         support_files.Append(comp_unit);
879         return DWARFDebugLine::ParseSupportFiles(
880             comp_unit.GetModule(), get_debug_line_data(), stmt_list,
881             support_files, dwarf_cu);
882       }
883     }
884   }
885   return false;
886 }
887 
888 bool SymbolFileDWARF::ParseIsOptimized(CompileUnit &comp_unit) {
889   ASSERT_MODULE_LOCK(this);
890   DWARFUnit *dwarf_cu = GetDWARFCompileUnit(&comp_unit);
891   if (dwarf_cu)
892     return dwarf_cu->GetIsOptimized();
893   return false;
894 }
895 
896 bool SymbolFileDWARF::ParseImportedModules(
897     const lldb_private::SymbolContext &sc,
898     std::vector<SourceModule> &imported_modules) {
899   ASSERT_MODULE_LOCK(this);
900   assert(sc.comp_unit);
901   DWARFUnit *dwarf_cu = GetDWARFCompileUnit(sc.comp_unit);
902   if (!dwarf_cu)
903     return false;
904   if (!ClangModulesDeclVendor::LanguageSupportsClangModules(
905           sc.comp_unit->GetLanguage()))
906     return false;
907   UpdateExternalModuleListIfNeeded();
908 
909   const DWARFDIE die = dwarf_cu->DIE();
910   if (!die)
911     return false;
912 
913   for (DWARFDIE child_die = die.GetFirstChild(); child_die;
914        child_die = child_die.GetSibling()) {
915     if (child_die.Tag() != DW_TAG_imported_declaration)
916       continue;
917 
918     DWARFDIE module_die = child_die.GetReferencedDIE(DW_AT_import);
919     if (module_die.Tag() != DW_TAG_module)
920       continue;
921 
922     if (const char *name =
923             module_die.GetAttributeValueAsString(DW_AT_name, nullptr)) {
924       SourceModule module;
925       module.path.push_back(ConstString(name));
926 
927       DWARFDIE parent_die = module_die;
928       while ((parent_die = parent_die.GetParent())) {
929         if (parent_die.Tag() != DW_TAG_module)
930           break;
931         if (const char *name =
932                 parent_die.GetAttributeValueAsString(DW_AT_name, nullptr))
933           module.path.push_back(ConstString(name));
934       }
935       std::reverse(module.path.begin(), module.path.end());
936       if (const char *include_path = module_die.GetAttributeValueAsString(
937               DW_AT_LLVM_include_path, nullptr))
938         module.search_path = ConstString(include_path);
939       if (const char *sysroot = module_die.GetAttributeValueAsString(
940               DW_AT_LLVM_isysroot, nullptr))
941         module.sysroot = ConstString(sysroot);
942       imported_modules.push_back(module);
943     }
944   }
945   return true;
946 }
947 
948 struct ParseDWARFLineTableCallbackInfo {
949   LineTable *line_table;
950   std::unique_ptr<LineSequence> sequence_up;
951   lldb::addr_t addr_mask;
952 };
953 
954 // ParseStatementTableCallback
955 static void ParseDWARFLineTableCallback(dw_offset_t offset,
956                                         const DWARFDebugLine::State &state,
957                                         void *userData) {
958   if (state.row == DWARFDebugLine::State::StartParsingLineTable) {
959     // Just started parsing the line table
960   } else if (state.row == DWARFDebugLine::State::DoneParsingLineTable) {
961     // Done parsing line table, nothing to do for the cleanup
962   } else {
963     ParseDWARFLineTableCallbackInfo *info =
964         (ParseDWARFLineTableCallbackInfo *)userData;
965     LineTable *line_table = info->line_table;
966 
967     // If this is our first time here, we need to create a sequence container.
968     if (!info->sequence_up) {
969       info->sequence_up.reset(line_table->CreateLineSequenceContainer());
970       assert(info->sequence_up.get());
971     }
972     line_table->AppendLineEntryToSequence(
973         info->sequence_up.get(), state.address & info->addr_mask, state.line,
974         state.column, state.file, state.is_stmt, state.basic_block,
975         state.prologue_end, state.epilogue_begin, state.end_sequence);
976     if (state.end_sequence) {
977       // First, put the current sequence into the line table.
978       line_table->InsertSequence(info->sequence_up.get());
979       // Then, empty it to prepare for the next sequence.
980       info->sequence_up->Clear();
981     }
982   }
983 }
984 
985 bool SymbolFileDWARF::ParseLineTable(CompileUnit &comp_unit) {
986   ASSERT_MODULE_LOCK(this);
987   if (comp_unit.GetLineTable() != NULL)
988     return true;
989 
990   DWARFUnit *dwarf_cu = GetDWARFCompileUnit(&comp_unit);
991   if (dwarf_cu) {
992     const DWARFBaseDIE dwarf_cu_die = dwarf_cu->GetUnitDIEOnly();
993     if (dwarf_cu_die) {
994       const dw_offset_t cu_line_offset =
995           dwarf_cu_die.GetAttributeValueAsUnsigned(DW_AT_stmt_list,
996                                                    DW_INVALID_OFFSET);
997       if (cu_line_offset != DW_INVALID_OFFSET) {
998         std::unique_ptr<LineTable> line_table_up(new LineTable(&comp_unit));
999         if (line_table_up) {
1000           ParseDWARFLineTableCallbackInfo info;
1001           info.line_table = line_table_up.get();
1002 
1003           /*
1004            * MIPS:
1005            * The SymbolContext may not have a valid target, thus we may not be
1006            * able
1007            * to call Address::GetOpcodeLoadAddress() which would clear the bit
1008            * #0
1009            * for MIPS. Use ArchSpec to clear the bit #0.
1010           */
1011           switch (GetObjectFile()->GetArchitecture().GetMachine()) {
1012           case llvm::Triple::mips:
1013           case llvm::Triple::mipsel:
1014           case llvm::Triple::mips64:
1015           case llvm::Triple::mips64el:
1016             info.addr_mask = ~((lldb::addr_t)1);
1017             break;
1018           default:
1019             info.addr_mask = ~((lldb::addr_t)0);
1020             break;
1021           }
1022 
1023           lldb::offset_t offset = cu_line_offset;
1024           DWARFDebugLine::ParseStatementTable(get_debug_line_data(), &offset,
1025                                               ParseDWARFLineTableCallback,
1026                                               &info, dwarf_cu);
1027           SymbolFileDWARFDebugMap *debug_map_symfile = GetDebugMapSymfile();
1028           if (debug_map_symfile) {
1029             // We have an object file that has a line table with addresses that
1030             // are not linked. We need to link the line table and convert the
1031             // addresses that are relative to the .o file into addresses for
1032             // the main executable.
1033             comp_unit.SetLineTable(
1034                 debug_map_symfile->LinkOSOLineTable(this, line_table_up.get()));
1035           } else {
1036             comp_unit.SetLineTable(line_table_up.release());
1037             return true;
1038           }
1039         }
1040       }
1041     }
1042   }
1043   return false;
1044 }
1045 
1046 lldb_private::DebugMacrosSP
1047 SymbolFileDWARF::ParseDebugMacros(lldb::offset_t *offset) {
1048   auto iter = m_debug_macros_map.find(*offset);
1049   if (iter != m_debug_macros_map.end())
1050     return iter->second;
1051 
1052   const DWARFDataExtractor &debug_macro_data = get_debug_macro_data();
1053   if (debug_macro_data.GetByteSize() == 0)
1054     return DebugMacrosSP();
1055 
1056   lldb_private::DebugMacrosSP debug_macros_sp(new lldb_private::DebugMacros());
1057   m_debug_macros_map[*offset] = debug_macros_sp;
1058 
1059   const DWARFDebugMacroHeader &header =
1060       DWARFDebugMacroHeader::ParseHeader(debug_macro_data, offset);
1061   DWARFDebugMacroEntry::ReadMacroEntries(debug_macro_data, get_debug_str_data(),
1062                                          header.OffsetIs64Bit(), offset, this,
1063                                          debug_macros_sp);
1064 
1065   return debug_macros_sp;
1066 }
1067 
1068 bool SymbolFileDWARF::ParseDebugMacros(CompileUnit &comp_unit) {
1069   ASSERT_MODULE_LOCK(this);
1070 
1071   DWARFUnit *dwarf_cu = GetDWARFCompileUnit(&comp_unit);
1072   if (dwarf_cu == nullptr)
1073     return false;
1074 
1075   const DWARFBaseDIE dwarf_cu_die = dwarf_cu->GetUnitDIEOnly();
1076   if (!dwarf_cu_die)
1077     return false;
1078 
1079   lldb::offset_t sect_offset =
1080       dwarf_cu_die.GetAttributeValueAsUnsigned(DW_AT_macros, DW_INVALID_OFFSET);
1081   if (sect_offset == DW_INVALID_OFFSET)
1082     sect_offset = dwarf_cu_die.GetAttributeValueAsUnsigned(DW_AT_GNU_macros,
1083                                                            DW_INVALID_OFFSET);
1084   if (sect_offset == DW_INVALID_OFFSET)
1085     return false;
1086 
1087   comp_unit.SetDebugMacros(ParseDebugMacros(&sect_offset));
1088 
1089   return true;
1090 }
1091 
1092 size_t SymbolFileDWARF::ParseBlocksRecursive(
1093     lldb_private::CompileUnit &comp_unit, Block *parent_block,
1094     const DWARFDIE &orig_die, addr_t subprogram_low_pc, uint32_t depth) {
1095   size_t blocks_added = 0;
1096   DWARFDIE die = orig_die;
1097   while (die) {
1098     dw_tag_t tag = die.Tag();
1099 
1100     switch (tag) {
1101     case DW_TAG_inlined_subroutine:
1102     case DW_TAG_subprogram:
1103     case DW_TAG_lexical_block: {
1104       Block *block = NULL;
1105       if (tag == DW_TAG_subprogram) {
1106         // Skip any DW_TAG_subprogram DIEs that are inside of a normal or
1107         // inlined functions. These will be parsed on their own as separate
1108         // entities.
1109 
1110         if (depth > 0)
1111           break;
1112 
1113         block = parent_block;
1114       } else {
1115         BlockSP block_sp(new Block(die.GetID()));
1116         parent_block->AddChild(block_sp);
1117         block = block_sp.get();
1118       }
1119       DWARFRangeList ranges;
1120       const char *name = NULL;
1121       const char *mangled_name = NULL;
1122 
1123       int decl_file = 0;
1124       int decl_line = 0;
1125       int decl_column = 0;
1126       int call_file = 0;
1127       int call_line = 0;
1128       int call_column = 0;
1129       if (die.GetDIENamesAndRanges(name, mangled_name, ranges, decl_file,
1130                                    decl_line, decl_column, call_file, call_line,
1131                                    call_column, nullptr)) {
1132         if (tag == DW_TAG_subprogram) {
1133           assert(subprogram_low_pc == LLDB_INVALID_ADDRESS);
1134           subprogram_low_pc = ranges.GetMinRangeBase(0);
1135         } else if (tag == DW_TAG_inlined_subroutine) {
1136           // We get called here for inlined subroutines in two ways. The first
1137           // time is when we are making the Function object for this inlined
1138           // concrete instance.  Since we're creating a top level block at
1139           // here, the subprogram_low_pc will be LLDB_INVALID_ADDRESS.  So we
1140           // need to adjust the containing address. The second time is when we
1141           // are parsing the blocks inside the function that contains the
1142           // inlined concrete instance.  Since these will be blocks inside the
1143           // containing "real" function the offset will be for that function.
1144           if (subprogram_low_pc == LLDB_INVALID_ADDRESS) {
1145             subprogram_low_pc = ranges.GetMinRangeBase(0);
1146           }
1147         }
1148 
1149         const size_t num_ranges = ranges.GetSize();
1150         for (size_t i = 0; i < num_ranges; ++i) {
1151           const DWARFRangeList::Entry &range = ranges.GetEntryRef(i);
1152           const addr_t range_base = range.GetRangeBase();
1153           if (range_base >= subprogram_low_pc)
1154             block->AddRange(Block::Range(range_base - subprogram_low_pc,
1155                                          range.GetByteSize()));
1156           else {
1157             GetObjectFile()->GetModule()->ReportError(
1158                 "0x%8.8" PRIx64 ": adding range [0x%" PRIx64 "-0x%" PRIx64
1159                 ") which has a base that is less than the function's low PC "
1160                 "0x%" PRIx64 ". Please file a bug and attach the file at the "
1161                              "start of this error message",
1162                 block->GetID(), range_base, range.GetRangeEnd(),
1163                 subprogram_low_pc);
1164           }
1165         }
1166         block->FinalizeRanges();
1167 
1168         if (tag != DW_TAG_subprogram &&
1169             (name != NULL || mangled_name != NULL)) {
1170           std::unique_ptr<Declaration> decl_up;
1171           if (decl_file != 0 || decl_line != 0 || decl_column != 0)
1172             decl_up.reset(new Declaration(
1173                 comp_unit.GetSupportFiles().GetFileSpecAtIndex(decl_file),
1174                 decl_line, decl_column));
1175 
1176           std::unique_ptr<Declaration> call_up;
1177           if (call_file != 0 || call_line != 0 || call_column != 0)
1178             call_up.reset(new Declaration(
1179                 comp_unit.GetSupportFiles().GetFileSpecAtIndex(call_file),
1180                 call_line, call_column));
1181 
1182           block->SetInlinedFunctionInfo(name, mangled_name, decl_up.get(),
1183                                         call_up.get());
1184         }
1185 
1186         ++blocks_added;
1187 
1188         if (die.HasChildren()) {
1189           blocks_added +=
1190               ParseBlocksRecursive(comp_unit, block, die.GetFirstChild(),
1191                                    subprogram_low_pc, depth + 1);
1192         }
1193       }
1194     } break;
1195     default:
1196       break;
1197     }
1198 
1199     // Only parse siblings of the block if we are not at depth zero. A depth of
1200     // zero indicates we are currently parsing the top level DW_TAG_subprogram
1201     // DIE
1202 
1203     if (depth == 0)
1204       die.Clear();
1205     else
1206       die = die.GetSibling();
1207   }
1208   return blocks_added;
1209 }
1210 
1211 bool SymbolFileDWARF::ClassOrStructIsVirtual(const DWARFDIE &parent_die) {
1212   if (parent_die) {
1213     for (DWARFDIE die = parent_die.GetFirstChild(); die;
1214          die = die.GetSibling()) {
1215       dw_tag_t tag = die.Tag();
1216       bool check_virtuality = false;
1217       switch (tag) {
1218       case DW_TAG_inheritance:
1219       case DW_TAG_subprogram:
1220         check_virtuality = true;
1221         break;
1222       default:
1223         break;
1224       }
1225       if (check_virtuality) {
1226         if (die.GetAttributeValueAsUnsigned(DW_AT_virtuality, 0) != 0)
1227           return true;
1228       }
1229     }
1230   }
1231   return false;
1232 }
1233 
1234 void SymbolFileDWARF::ParseDeclsForContext(CompilerDeclContext decl_ctx) {
1235   TypeSystem *type_system = decl_ctx.GetTypeSystem();
1236   DWARFASTParser *ast_parser = type_system->GetDWARFParser();
1237   std::vector<DWARFDIE> decl_ctx_die_list =
1238       ast_parser->GetDIEForDeclContext(decl_ctx);
1239 
1240   for (DWARFDIE decl_ctx_die : decl_ctx_die_list)
1241     for (DWARFDIE decl = decl_ctx_die.GetFirstChild(); decl;
1242          decl = decl.GetSibling())
1243       ast_parser->GetDeclForUIDFromDWARF(decl);
1244 }
1245 
1246 SymbolFileDWARF *SymbolFileDWARF::GetDWARFForUID(lldb::user_id_t uid) {
1247   // This method can be called without going through the symbol vendor so we
1248   // need to lock the module.
1249   std::lock_guard<std::recursive_mutex> guard(GetModuleMutex());
1250   // Anytime we get a "lldb::user_id_t" from an lldb_private::SymbolFile API we
1251   // must make sure we use the correct DWARF file when resolving things. On
1252   // MacOSX, when using SymbolFileDWARFDebugMap, we will use multiple
1253   // SymbolFileDWARF classes, one for each .o file. We can often end up with
1254   // references to other DWARF objects and we must be ready to receive a
1255   // "lldb::user_id_t" that specifies a DIE from another SymbolFileDWARF
1256   // instance.
1257   SymbolFileDWARFDebugMap *debug_map = GetDebugMapSymfile();
1258   if (debug_map)
1259     return debug_map->GetSymbolFileByOSOIndex(
1260         debug_map->GetOSOIndexFromUserID(uid));
1261   return this;
1262 }
1263 
1264 DWARFDIE
1265 SymbolFileDWARF::GetDIEFromUID(lldb::user_id_t uid) {
1266   // This method can be called without going through the symbol vendor so we
1267   // need to lock the module.
1268   std::lock_guard<std::recursive_mutex> guard(GetModuleMutex());
1269   // Anytime we get a "lldb::user_id_t" from an lldb_private::SymbolFile API we
1270   // must make sure we use the correct DWARF file when resolving things. On
1271   // MacOSX, when using SymbolFileDWARFDebugMap, we will use multiple
1272   // SymbolFileDWARF classes, one for each .o file. We can often end up with
1273   // references to other DWARF objects and we must be ready to receive a
1274   // "lldb::user_id_t" that specifies a DIE from another SymbolFileDWARF
1275   // instance.
1276   SymbolFileDWARF *dwarf = GetDWARFForUID(uid);
1277   if (dwarf)
1278     return dwarf->GetDIE(DIERef(uid, dwarf));
1279   return DWARFDIE();
1280 }
1281 
1282 CompilerDecl SymbolFileDWARF::GetDeclForUID(lldb::user_id_t type_uid) {
1283   // This method can be called without going through the symbol vendor so we
1284   // need to lock the module.
1285   std::lock_guard<std::recursive_mutex> guard(GetModuleMutex());
1286   // Anytime we have a lldb::user_id_t, we must get the DIE by calling
1287   // SymbolFileDWARF::GetDIEFromUID(). See comments inside the
1288   // SymbolFileDWARF::GetDIEFromUID() for details.
1289   DWARFDIE die = GetDIEFromUID(type_uid);
1290   if (die)
1291     return die.GetDecl();
1292   return CompilerDecl();
1293 }
1294 
1295 CompilerDeclContext
1296 SymbolFileDWARF::GetDeclContextForUID(lldb::user_id_t type_uid) {
1297   // This method can be called without going through the symbol vendor so we
1298   // need to lock the module.
1299   std::lock_guard<std::recursive_mutex> guard(GetModuleMutex());
1300   // Anytime we have a lldb::user_id_t, we must get the DIE by calling
1301   // SymbolFileDWARF::GetDIEFromUID(). See comments inside the
1302   // SymbolFileDWARF::GetDIEFromUID() for details.
1303   DWARFDIE die = GetDIEFromUID(type_uid);
1304   if (die)
1305     return die.GetDeclContext();
1306   return CompilerDeclContext();
1307 }
1308 
1309 CompilerDeclContext
1310 SymbolFileDWARF::GetDeclContextContainingUID(lldb::user_id_t type_uid) {
1311   // This method can be called without going through the symbol vendor so we
1312   // need to lock the module.
1313   std::lock_guard<std::recursive_mutex> guard(GetModuleMutex());
1314   // Anytime we have a lldb::user_id_t, we must get the DIE by calling
1315   // SymbolFileDWARF::GetDIEFromUID(). See comments inside the
1316   // SymbolFileDWARF::GetDIEFromUID() for details.
1317   DWARFDIE die = GetDIEFromUID(type_uid);
1318   if (die)
1319     return die.GetContainingDeclContext();
1320   return CompilerDeclContext();
1321 }
1322 
1323 Type *SymbolFileDWARF::ResolveTypeUID(lldb::user_id_t type_uid) {
1324   // This method can be called without going through the symbol vendor so we
1325   // need to lock the module.
1326   std::lock_guard<std::recursive_mutex> guard(GetModuleMutex());
1327   // Anytime we have a lldb::user_id_t, we must get the DIE by calling
1328   // SymbolFileDWARF::GetDIEFromUID(). See comments inside the
1329   // SymbolFileDWARF::GetDIEFromUID() for details.
1330   DWARFDIE type_die = GetDIEFromUID(type_uid);
1331   if (type_die)
1332     return type_die.ResolveType();
1333   else
1334     return nullptr;
1335 }
1336 
1337 llvm::Optional<SymbolFile::ArrayInfo>
1338 SymbolFileDWARF::GetDynamicArrayInfoForUID(
1339     lldb::user_id_t type_uid, const lldb_private::ExecutionContext *exe_ctx) {
1340   std::lock_guard<std::recursive_mutex> guard(GetModuleMutex());
1341   DWARFDIE type_die = GetDIEFromUID(type_uid);
1342   if (type_die)
1343     return DWARFASTParser::ParseChildArrayInfo(type_die, exe_ctx);
1344   else
1345     return llvm::None;
1346 }
1347 
1348 Type *SymbolFileDWARF::ResolveTypeUID(const DIERef &die_ref) {
1349   return ResolveType(GetDIE(die_ref), true);
1350 }
1351 
1352 Type *SymbolFileDWARF::ResolveTypeUID(const DWARFDIE &die,
1353                                       bool assert_not_being_parsed) {
1354   if (die) {
1355     Log *log(LogChannelDWARF::GetLogIfAll(DWARF_LOG_DEBUG_INFO));
1356     if (log)
1357       GetObjectFile()->GetModule()->LogMessage(
1358           log, "SymbolFileDWARF::ResolveTypeUID (die = 0x%8.8x) %s '%s'",
1359           die.GetOffset(), die.GetTagAsCString(), die.GetName());
1360 
1361     // We might be coming in in the middle of a type tree (a class within a
1362     // class, an enum within a class), so parse any needed parent DIEs before
1363     // we get to this one...
1364     DWARFDIE decl_ctx_die = GetDeclContextDIEContainingDIE(die);
1365     if (decl_ctx_die) {
1366       if (log) {
1367         switch (decl_ctx_die.Tag()) {
1368         case DW_TAG_structure_type:
1369         case DW_TAG_union_type:
1370         case DW_TAG_class_type: {
1371           // Get the type, which could be a forward declaration
1372           if (log)
1373             GetObjectFile()->GetModule()->LogMessage(
1374                 log, "SymbolFileDWARF::ResolveTypeUID (die = 0x%8.8x) %s '%s' "
1375                      "resolve parent forward type for 0x%8.8x",
1376                 die.GetOffset(), die.GetTagAsCString(), die.GetName(),
1377                 decl_ctx_die.GetOffset());
1378         } break;
1379 
1380         default:
1381           break;
1382         }
1383       }
1384     }
1385     return ResolveType(die);
1386   }
1387   return NULL;
1388 }
1389 
1390 // This function is used when SymbolFileDWARFDebugMap owns a bunch of
1391 // SymbolFileDWARF objects to detect if this DWARF file is the one that can
1392 // resolve a compiler_type.
1393 bool SymbolFileDWARF::HasForwardDeclForClangType(
1394     const CompilerType &compiler_type) {
1395   CompilerType compiler_type_no_qualifiers =
1396       ClangUtil::RemoveFastQualifiers(compiler_type);
1397   if (GetForwardDeclClangTypeToDie().count(
1398           compiler_type_no_qualifiers.GetOpaqueQualType())) {
1399     return true;
1400   }
1401   TypeSystem *type_system = compiler_type.GetTypeSystem();
1402 
1403   ClangASTContext *clang_type_system =
1404       llvm::dyn_cast_or_null<ClangASTContext>(type_system);
1405   if (!clang_type_system)
1406     return false;
1407   DWARFASTParserClang *ast_parser =
1408       static_cast<DWARFASTParserClang *>(clang_type_system->GetDWARFParser());
1409   return ast_parser->GetClangASTImporter().CanImport(compiler_type);
1410 }
1411 
1412 bool SymbolFileDWARF::CompleteType(CompilerType &compiler_type) {
1413   std::lock_guard<std::recursive_mutex> guard(GetModuleMutex());
1414 
1415   ClangASTContext *clang_type_system =
1416       llvm::dyn_cast_or_null<ClangASTContext>(compiler_type.GetTypeSystem());
1417   if (clang_type_system) {
1418     DWARFASTParserClang *ast_parser =
1419         static_cast<DWARFASTParserClang *>(clang_type_system->GetDWARFParser());
1420     if (ast_parser &&
1421         ast_parser->GetClangASTImporter().CanImport(compiler_type))
1422       return ast_parser->GetClangASTImporter().CompleteType(compiler_type);
1423   }
1424 
1425   // We have a struct/union/class/enum that needs to be fully resolved.
1426   CompilerType compiler_type_no_qualifiers =
1427       ClangUtil::RemoveFastQualifiers(compiler_type);
1428   auto die_it = GetForwardDeclClangTypeToDie().find(
1429       compiler_type_no_qualifiers.GetOpaqueQualType());
1430   if (die_it == GetForwardDeclClangTypeToDie().end()) {
1431     // We have already resolved this type...
1432     return true;
1433   }
1434 
1435   DWARFDIE dwarf_die = GetDIE(die_it->getSecond());
1436   if (dwarf_die) {
1437     // Once we start resolving this type, remove it from the forward
1438     // declaration map in case anyone child members or other types require this
1439     // type to get resolved. The type will get resolved when all of the calls
1440     // to SymbolFileDWARF::ResolveClangOpaqueTypeDefinition are done.
1441     GetForwardDeclClangTypeToDie().erase(die_it);
1442 
1443     Type *type = GetDIEToType().lookup(dwarf_die.GetDIE());
1444 
1445     Log *log(LogChannelDWARF::GetLogIfAny(DWARF_LOG_DEBUG_INFO |
1446                                           DWARF_LOG_TYPE_COMPLETION));
1447     if (log)
1448       GetObjectFile()->GetModule()->LogMessageVerboseBacktrace(
1449           log, "0x%8.8" PRIx64 ": %s '%s' resolving forward declaration...",
1450           dwarf_die.GetID(), dwarf_die.GetTagAsCString(),
1451           type->GetName().AsCString());
1452     assert(compiler_type);
1453     DWARFASTParser *dwarf_ast = dwarf_die.GetDWARFParser();
1454     if (dwarf_ast)
1455       return dwarf_ast->CompleteTypeFromDWARF(dwarf_die, type, compiler_type);
1456   }
1457   return false;
1458 }
1459 
1460 Type *SymbolFileDWARF::ResolveType(const DWARFDIE &die,
1461                                    bool assert_not_being_parsed,
1462                                    bool resolve_function_context) {
1463   if (die) {
1464     Type *type = GetTypeForDIE(die, resolve_function_context).get();
1465 
1466     if (assert_not_being_parsed) {
1467       if (type != DIE_IS_BEING_PARSED)
1468         return type;
1469 
1470       GetObjectFile()->GetModule()->ReportError(
1471           "Parsing a die that is being parsed die: 0x%8.8x: %s %s",
1472           die.GetOffset(), die.GetTagAsCString(), die.GetName());
1473 
1474     } else
1475       return type;
1476   }
1477   return nullptr;
1478 }
1479 
1480 CompileUnit *
1481 SymbolFileDWARF::GetCompUnitForDWARFCompUnit(DWARFUnit *dwarf_cu,
1482                                              uint32_t cu_idx) {
1483   // Check if the symbol vendor already knows about this compile unit?
1484   if (dwarf_cu->GetUserData() == NULL) {
1485     // The symbol vendor doesn't know about this compile unit, we need to parse
1486     // and add it to the symbol vendor object.
1487     return ParseCompileUnit(dwarf_cu, cu_idx).get();
1488   }
1489   return (CompileUnit *)dwarf_cu->GetUserData();
1490 }
1491 
1492 size_t SymbolFileDWARF::GetObjCMethodDIEOffsets(ConstString class_name,
1493                                                 DIEArray &method_die_offsets) {
1494   method_die_offsets.clear();
1495   m_index->GetObjCMethods(class_name, method_die_offsets);
1496   return method_die_offsets.size();
1497 }
1498 
1499 bool SymbolFileDWARF::GetFunction(const DWARFDIE &die, SymbolContext &sc) {
1500   sc.Clear(false);
1501 
1502   if (die) {
1503     // Check if the symbol vendor already knows about this compile unit?
1504     sc.comp_unit = GetCompUnitForDWARFCompUnit(die.GetCU(), UINT32_MAX);
1505 
1506     sc.function = sc.comp_unit->FindFunctionByUID(die.GetID()).get();
1507     if (sc.function == NULL)
1508       sc.function = ParseFunction(*sc.comp_unit, die);
1509 
1510     if (sc.function) {
1511       sc.module_sp = sc.function->CalculateSymbolContextModule();
1512       return true;
1513     }
1514   }
1515 
1516   return false;
1517 }
1518 
1519 lldb::ModuleSP SymbolFileDWARF::GetDWOModule(ConstString name) {
1520   UpdateExternalModuleListIfNeeded();
1521   const auto &pos = m_external_type_modules.find(name);
1522   if (pos != m_external_type_modules.end())
1523     return pos->second;
1524   else
1525     return lldb::ModuleSP();
1526 }
1527 
1528 DWARFDIE
1529 SymbolFileDWARF::GetDIE(const DIERef &die_ref) {
1530   DWARFDebugInfo *debug_info = DebugInfo();
1531   if (debug_info)
1532     return debug_info->GetDIE(die_ref);
1533   else
1534     return DWARFDIE();
1535 }
1536 
1537 std::unique_ptr<SymbolFileDWARFDwo>
1538 SymbolFileDWARF::GetDwoSymbolFileForCompileUnit(
1539     DWARFUnit &dwarf_cu, const DWARFDebugInfoEntry &cu_die) {
1540   // If we are using a dSYM file, we never want the standard DWO files since
1541   // the -gmodules support uses the same DWO machanism to specify full debug
1542   // info files for modules.
1543   if (GetDebugMapSymfile())
1544     return nullptr;
1545 
1546   const char *dwo_name = cu_die.GetAttributeValueAsString(
1547       this, &dwarf_cu, DW_AT_GNU_dwo_name, nullptr);
1548   if (!dwo_name)
1549     return nullptr;
1550 
1551   SymbolFileDWARFDwp *dwp_symfile = GetDwpSymbolFile();
1552   if (dwp_symfile) {
1553     uint64_t dwo_id = cu_die.GetAttributeValueAsUnsigned(this, &dwarf_cu,
1554                                                          DW_AT_GNU_dwo_id, 0);
1555     std::unique_ptr<SymbolFileDWARFDwo> dwo_symfile =
1556         dwp_symfile->GetSymbolFileForDwoId(&dwarf_cu, dwo_id);
1557     if (dwo_symfile)
1558       return dwo_symfile;
1559   }
1560 
1561   FileSpec dwo_file(dwo_name);
1562   FileSystem::Instance().Resolve(dwo_file);
1563   if (dwo_file.IsRelative()) {
1564     const char *comp_dir = cu_die.GetAttributeValueAsString(
1565         this, &dwarf_cu, DW_AT_comp_dir, nullptr);
1566     if (!comp_dir)
1567       return nullptr;
1568 
1569     dwo_file.SetFile(comp_dir, FileSpec::Style::native);
1570     FileSystem::Instance().Resolve(dwo_file);
1571     dwo_file.AppendPathComponent(dwo_name);
1572   }
1573 
1574   if (!FileSystem::Instance().Exists(dwo_file))
1575     return nullptr;
1576 
1577   const lldb::offset_t file_offset = 0;
1578   DataBufferSP dwo_file_data_sp;
1579   lldb::offset_t dwo_file_data_offset = 0;
1580   ObjectFileSP dwo_obj_file = ObjectFile::FindPlugin(
1581       GetObjectFile()->GetModule(), &dwo_file, file_offset,
1582       FileSystem::Instance().GetByteSize(dwo_file), dwo_file_data_sp,
1583       dwo_file_data_offset);
1584   if (dwo_obj_file == nullptr)
1585     return nullptr;
1586 
1587   return llvm::make_unique<SymbolFileDWARFDwo>(dwo_obj_file, &dwarf_cu);
1588 }
1589 
1590 void SymbolFileDWARF::UpdateExternalModuleListIfNeeded() {
1591   if (m_fetched_external_modules)
1592     return;
1593   m_fetched_external_modules = true;
1594 
1595   DWARFDebugInfo *debug_info = DebugInfo();
1596 
1597   const uint32_t num_compile_units = GetNumCompileUnits();
1598   for (uint32_t cu_idx = 0; cu_idx < num_compile_units; ++cu_idx) {
1599     DWARFUnit *dwarf_cu = debug_info->GetCompileUnitAtIndex(cu_idx);
1600 
1601     const DWARFBaseDIE die = dwarf_cu->GetUnitDIEOnly();
1602     if (die && !die.HasChildren()) {
1603       const char *name = die.GetAttributeValueAsString(DW_AT_name, nullptr);
1604 
1605       if (name) {
1606         ConstString const_name(name);
1607         if (m_external_type_modules.find(const_name) ==
1608             m_external_type_modules.end()) {
1609           ModuleSP module_sp;
1610           const char *dwo_path =
1611               die.GetAttributeValueAsString(DW_AT_GNU_dwo_name, nullptr);
1612           if (dwo_path) {
1613             ModuleSpec dwo_module_spec;
1614             dwo_module_spec.GetFileSpec().SetFile(dwo_path,
1615                                                   FileSpec::Style::native);
1616             if (dwo_module_spec.GetFileSpec().IsRelative()) {
1617               const char *comp_dir =
1618                   die.GetAttributeValueAsString(DW_AT_comp_dir, nullptr);
1619               if (comp_dir) {
1620                 dwo_module_spec.GetFileSpec().SetFile(comp_dir,
1621                                                       FileSpec::Style::native);
1622                 FileSystem::Instance().Resolve(dwo_module_spec.GetFileSpec());
1623                 dwo_module_spec.GetFileSpec().AppendPathComponent(dwo_path);
1624               }
1625             }
1626             dwo_module_spec.GetArchitecture() =
1627                 m_obj_file->GetModule()->GetArchitecture();
1628 
1629             // When LLDB loads "external" modules it looks at the presence of
1630             // DW_AT_GNU_dwo_name. However, when the already created module
1631             // (corresponding to .dwo itself) is being processed, it will see
1632             // the presence of DW_AT_GNU_dwo_name (which contains the name of
1633             // dwo file) and will try to call ModuleList::GetSharedModule
1634             // again. In some cases (i.e. for empty files) Clang 4.0 generates
1635             // a *.dwo file which has DW_AT_GNU_dwo_name, but no
1636             // DW_AT_comp_dir. In this case the method
1637             // ModuleList::GetSharedModule will fail and the warning will be
1638             // printed. However, as one can notice in this case we don't
1639             // actually need to try to load the already loaded module
1640             // (corresponding to .dwo) so we simply skip it.
1641             if (m_obj_file->GetFileSpec().GetFileNameExtension() == ".dwo" &&
1642                 llvm::StringRef(m_obj_file->GetFileSpec().GetPath())
1643                     .endswith(dwo_module_spec.GetFileSpec().GetPath())) {
1644               continue;
1645             }
1646 
1647             Status error = ModuleList::GetSharedModule(
1648                 dwo_module_spec, module_sp, NULL, NULL, NULL);
1649             if (!module_sp) {
1650               GetObjectFile()->GetModule()->ReportWarning(
1651                   "0x%8.8x: unable to locate module needed for external types: "
1652                   "%s\nerror: %s\nDebugging will be degraded due to missing "
1653                   "types. Rebuilding your project will regenerate the needed "
1654                   "module files.",
1655                   die.GetOffset(),
1656                   dwo_module_spec.GetFileSpec().GetPath().c_str(),
1657                   error.AsCString("unknown error"));
1658             }
1659           }
1660           m_external_type_modules[const_name] = module_sp;
1661         }
1662       }
1663     }
1664   }
1665 }
1666 
1667 SymbolFileDWARF::GlobalVariableMap &SymbolFileDWARF::GetGlobalAranges() {
1668   if (!m_global_aranges_up) {
1669     m_global_aranges_up.reset(new GlobalVariableMap());
1670 
1671     ModuleSP module_sp = GetObjectFile()->GetModule();
1672     if (module_sp) {
1673       const size_t num_cus = module_sp->GetNumCompileUnits();
1674       for (size_t i = 0; i < num_cus; ++i) {
1675         CompUnitSP cu_sp = module_sp->GetCompileUnitAtIndex(i);
1676         if (cu_sp) {
1677           VariableListSP globals_sp = cu_sp->GetVariableList(true);
1678           if (globals_sp) {
1679             const size_t num_globals = globals_sp->GetSize();
1680             for (size_t g = 0; g < num_globals; ++g) {
1681               VariableSP var_sp = globals_sp->GetVariableAtIndex(g);
1682               if (var_sp && !var_sp->GetLocationIsConstantValueData()) {
1683                 const DWARFExpression &location = var_sp->LocationExpression();
1684                 Value location_result;
1685                 Status error;
1686                 if (location.Evaluate(nullptr, LLDB_INVALID_ADDRESS, nullptr,
1687                                       nullptr, location_result, &error)) {
1688                   if (location_result.GetValueType() ==
1689                       Value::eValueTypeFileAddress) {
1690                     lldb::addr_t file_addr =
1691                         location_result.GetScalar().ULongLong();
1692                     lldb::addr_t byte_size = 1;
1693                     if (var_sp->GetType())
1694                       byte_size =
1695                           var_sp->GetType()->GetByteSize().getValueOr(0);
1696                     m_global_aranges_up->Append(GlobalVariableMap::Entry(
1697                         file_addr, byte_size, var_sp.get()));
1698                   }
1699                 }
1700               }
1701             }
1702           }
1703         }
1704       }
1705     }
1706     m_global_aranges_up->Sort();
1707   }
1708   return *m_global_aranges_up;
1709 }
1710 
1711 uint32_t SymbolFileDWARF::ResolveSymbolContext(const Address &so_addr,
1712                                                SymbolContextItem resolve_scope,
1713                                                SymbolContext &sc) {
1714   static Timer::Category func_cat(LLVM_PRETTY_FUNCTION);
1715   Timer scoped_timer(func_cat,
1716                      "SymbolFileDWARF::"
1717                      "ResolveSymbolContext (so_addr = { "
1718                      "section = %p, offset = 0x%" PRIx64
1719                      " }, resolve_scope = 0x%8.8x)",
1720                      static_cast<void *>(so_addr.GetSection().get()),
1721                      so_addr.GetOffset(), resolve_scope);
1722   uint32_t resolved = 0;
1723   if (resolve_scope &
1724       (eSymbolContextCompUnit | eSymbolContextFunction | eSymbolContextBlock |
1725        eSymbolContextLineEntry | eSymbolContextVariable)) {
1726     lldb::addr_t file_vm_addr = so_addr.GetFileAddress();
1727 
1728     DWARFDebugInfo *debug_info = DebugInfo();
1729     if (debug_info) {
1730       llvm::Expected<DWARFDebugAranges &> aranges =
1731           debug_info->GetCompileUnitAranges();
1732       if (!aranges) {
1733         Log *log = LogChannelDWARF::GetLogIfAll(DWARF_LOG_DEBUG_INFO);
1734         LLDB_LOG_ERROR(log, aranges.takeError(),
1735                        "SymbolFileDWARF::ResolveSymbolContext failed to get cu "
1736                        "aranges.  {0}");
1737         return 0;
1738       }
1739 
1740       const dw_offset_t cu_offset = aranges->FindAddress(file_vm_addr);
1741       if (cu_offset == DW_INVALID_OFFSET) {
1742         // Global variables are not in the compile unit address ranges. The
1743         // only way to currently find global variables is to iterate over the
1744         // .debug_pubnames or the __apple_names table and find all items in
1745         // there that point to DW_TAG_variable DIEs and then find the address
1746         // that matches.
1747         if (resolve_scope & eSymbolContextVariable) {
1748           GlobalVariableMap &map = GetGlobalAranges();
1749           const GlobalVariableMap::Entry *entry =
1750               map.FindEntryThatContains(file_vm_addr);
1751           if (entry && entry->data) {
1752             Variable *variable = entry->data;
1753             SymbolContextScope *scc = variable->GetSymbolContextScope();
1754             if (scc) {
1755               scc->CalculateSymbolContext(&sc);
1756               sc.variable = variable;
1757             }
1758             return sc.GetResolvedMask();
1759           }
1760         }
1761       } else {
1762         uint32_t cu_idx = DW_INVALID_INDEX;
1763         DWARFUnit *dwarf_cu =
1764             debug_info->GetCompileUnitAtOffset(cu_offset, &cu_idx);
1765         if (dwarf_cu) {
1766           sc.comp_unit = GetCompUnitForDWARFCompUnit(dwarf_cu, cu_idx);
1767           if (sc.comp_unit) {
1768             resolved |= eSymbolContextCompUnit;
1769 
1770             bool force_check_line_table = false;
1771             if (resolve_scope &
1772                 (eSymbolContextFunction | eSymbolContextBlock)) {
1773               DWARFDIE function_die = dwarf_cu->LookupAddress(file_vm_addr);
1774               DWARFDIE block_die;
1775               if (function_die) {
1776                 sc.function =
1777                     sc.comp_unit->FindFunctionByUID(function_die.GetID()).get();
1778                 if (sc.function == NULL)
1779                   sc.function = ParseFunction(*sc.comp_unit, function_die);
1780 
1781                 if (sc.function && (resolve_scope & eSymbolContextBlock))
1782                   block_die = function_die.LookupDeepestBlock(file_vm_addr);
1783               } else {
1784                 // We might have had a compile unit that had discontiguous
1785                 // address ranges where the gaps are symbols that don't have
1786                 // any debug info. Discontiguous compile unit address ranges
1787                 // should only happen when there aren't other functions from
1788                 // other compile units in these gaps. This helps keep the size
1789                 // of the aranges down.
1790                 force_check_line_table = true;
1791               }
1792 
1793               if (sc.function != NULL) {
1794                 resolved |= eSymbolContextFunction;
1795 
1796                 if (resolve_scope & eSymbolContextBlock) {
1797                   Block &block = sc.function->GetBlock(true);
1798 
1799                   if (block_die)
1800                     sc.block = block.FindBlockByID(block_die.GetID());
1801                   else
1802                     sc.block = block.FindBlockByID(function_die.GetID());
1803                   if (sc.block)
1804                     resolved |= eSymbolContextBlock;
1805                 }
1806               }
1807             }
1808 
1809             if ((resolve_scope & eSymbolContextLineEntry) ||
1810                 force_check_line_table) {
1811               LineTable *line_table = sc.comp_unit->GetLineTable();
1812               if (line_table != NULL) {
1813                 // And address that makes it into this function should be in
1814                 // terms of this debug file if there is no debug map, or it
1815                 // will be an address in the .o file which needs to be fixed up
1816                 // to be in terms of the debug map executable. Either way,
1817                 // calling FixupAddress() will work for us.
1818                 Address exe_so_addr(so_addr);
1819                 if (FixupAddress(exe_so_addr)) {
1820                   if (line_table->FindLineEntryByAddress(exe_so_addr,
1821                                                          sc.line_entry)) {
1822                     resolved |= eSymbolContextLineEntry;
1823                   }
1824                 }
1825               }
1826             }
1827 
1828             if (force_check_line_table &&
1829                 !(resolved & eSymbolContextLineEntry)) {
1830               // We might have had a compile unit that had discontiguous
1831               // address ranges where the gaps are symbols that don't have any
1832               // debug info. Discontiguous compile unit address ranges should
1833               // only happen when there aren't other functions from other
1834               // compile units in these gaps. This helps keep the size of the
1835               // aranges down.
1836               sc.comp_unit = NULL;
1837               resolved &= ~eSymbolContextCompUnit;
1838             }
1839           } else {
1840             GetObjectFile()->GetModule()->ReportWarning(
1841                 "0x%8.8x: compile unit %u failed to create a valid "
1842                 "lldb_private::CompileUnit class.",
1843                 cu_offset, cu_idx);
1844           }
1845         }
1846       }
1847     }
1848   }
1849   return resolved;
1850 }
1851 
1852 uint32_t SymbolFileDWARF::ResolveSymbolContext(const FileSpec &file_spec,
1853                                                uint32_t line,
1854                                                bool check_inlines,
1855                                                SymbolContextItem resolve_scope,
1856                                                SymbolContextList &sc_list) {
1857   const uint32_t prev_size = sc_list.GetSize();
1858   if (resolve_scope & eSymbolContextCompUnit) {
1859     DWARFDebugInfo *debug_info = DebugInfo();
1860     if (debug_info) {
1861       uint32_t cu_idx;
1862       DWARFUnit *dwarf_cu = NULL;
1863 
1864       for (cu_idx = 0;
1865            (dwarf_cu = debug_info->GetCompileUnitAtIndex(cu_idx)) != NULL;
1866            ++cu_idx) {
1867         CompileUnit *dc_cu = GetCompUnitForDWARFCompUnit(dwarf_cu, cu_idx);
1868         const bool full_match = (bool)file_spec.GetDirectory();
1869         bool file_spec_matches_cu_file_spec =
1870             dc_cu != NULL && FileSpec::Equal(file_spec, *dc_cu, full_match);
1871         if (check_inlines || file_spec_matches_cu_file_spec) {
1872           SymbolContext sc(m_obj_file->GetModule());
1873           sc.comp_unit = GetCompUnitForDWARFCompUnit(dwarf_cu, cu_idx);
1874           if (sc.comp_unit) {
1875             uint32_t file_idx = UINT32_MAX;
1876 
1877             // If we are looking for inline functions only and we don't find it
1878             // in the support files, we are done.
1879             if (check_inlines) {
1880               file_idx = sc.comp_unit->GetSupportFiles().FindFileIndex(
1881                   1, file_spec, true);
1882               if (file_idx == UINT32_MAX)
1883                 continue;
1884             }
1885 
1886             if (line != 0) {
1887               LineTable *line_table = sc.comp_unit->GetLineTable();
1888 
1889               if (line_table != NULL && line != 0) {
1890                 // We will have already looked up the file index if we are
1891                 // searching for inline entries.
1892                 if (!check_inlines)
1893                   file_idx = sc.comp_unit->GetSupportFiles().FindFileIndex(
1894                       1, file_spec, true);
1895 
1896                 if (file_idx != UINT32_MAX) {
1897                   uint32_t found_line;
1898                   uint32_t line_idx = line_table->FindLineEntryIndexByFileIndex(
1899                       0, file_idx, line, false, &sc.line_entry);
1900                   found_line = sc.line_entry.line;
1901 
1902                   while (line_idx != UINT32_MAX) {
1903                     sc.function = NULL;
1904                     sc.block = NULL;
1905                     if (resolve_scope &
1906                         (eSymbolContextFunction | eSymbolContextBlock)) {
1907                       const lldb::addr_t file_vm_addr =
1908                           sc.line_entry.range.GetBaseAddress().GetFileAddress();
1909                       if (file_vm_addr != LLDB_INVALID_ADDRESS) {
1910                         DWARFDIE function_die =
1911                             dwarf_cu->LookupAddress(file_vm_addr);
1912                         DWARFDIE block_die;
1913                         if (function_die) {
1914                           sc.function =
1915                               sc.comp_unit
1916                                   ->FindFunctionByUID(function_die.GetID())
1917                                   .get();
1918                           if (sc.function == NULL)
1919                             sc.function =
1920                                 ParseFunction(*sc.comp_unit, function_die);
1921 
1922                           if (sc.function &&
1923                               (resolve_scope & eSymbolContextBlock))
1924                             block_die =
1925                                 function_die.LookupDeepestBlock(file_vm_addr);
1926                         }
1927 
1928                         if (sc.function != NULL) {
1929                           Block &block = sc.function->GetBlock(true);
1930 
1931                           if (block_die)
1932                             sc.block = block.FindBlockByID(block_die.GetID());
1933                           else if (function_die)
1934                             sc.block =
1935                                 block.FindBlockByID(function_die.GetID());
1936                         }
1937                       }
1938                     }
1939 
1940                     sc_list.Append(sc);
1941                     line_idx = line_table->FindLineEntryIndexByFileIndex(
1942                         line_idx + 1, file_idx, found_line, true,
1943                         &sc.line_entry);
1944                   }
1945                 }
1946               } else if (file_spec_matches_cu_file_spec && !check_inlines) {
1947                 // only append the context if we aren't looking for inline call
1948                 // sites by file and line and if the file spec matches that of
1949                 // the compile unit
1950                 sc_list.Append(sc);
1951               }
1952             } else if (file_spec_matches_cu_file_spec && !check_inlines) {
1953               // only append the context if we aren't looking for inline call
1954               // sites by file and line and if the file spec matches that of
1955               // the compile unit
1956               sc_list.Append(sc);
1957             }
1958 
1959             if (!check_inlines)
1960               break;
1961           }
1962         }
1963       }
1964     }
1965   }
1966   return sc_list.GetSize() - prev_size;
1967 }
1968 
1969 void SymbolFileDWARF::PreloadSymbols() {
1970   std::lock_guard<std::recursive_mutex> guard(GetModuleMutex());
1971   m_index->Preload();
1972 }
1973 
1974 std::recursive_mutex &SymbolFileDWARF::GetModuleMutex() const {
1975   lldb::ModuleSP module_sp(m_debug_map_module_wp.lock());
1976   if (module_sp)
1977     return module_sp->GetMutex();
1978   return GetObjectFile()->GetModule()->GetMutex();
1979 }
1980 
1981 bool SymbolFileDWARF::DeclContextMatchesThisSymbolFile(
1982     const lldb_private::CompilerDeclContext *decl_ctx) {
1983   if (decl_ctx == nullptr || !decl_ctx->IsValid()) {
1984     // Invalid namespace decl which means we aren't matching only things in
1985     // this symbol file, so return true to indicate it matches this symbol
1986     // file.
1987     return true;
1988   }
1989 
1990   TypeSystem *decl_ctx_type_system = decl_ctx->GetTypeSystem();
1991   TypeSystem *type_system = GetTypeSystemForLanguage(
1992       decl_ctx_type_system->GetMinimumLanguage(nullptr));
1993   if (decl_ctx_type_system == type_system)
1994     return true; // The type systems match, return true
1995 
1996   // The namespace AST was valid, and it does not match...
1997   Log *log(LogChannelDWARF::GetLogIfAll(DWARF_LOG_LOOKUPS));
1998 
1999   if (log)
2000     GetObjectFile()->GetModule()->LogMessage(
2001         log, "Valid namespace does not match symbol file");
2002 
2003   return false;
2004 }
2005 
2006 uint32_t SymbolFileDWARF::FindGlobalVariables(
2007     ConstString name, const CompilerDeclContext *parent_decl_ctx,
2008     uint32_t max_matches, VariableList &variables) {
2009   Log *log(LogChannelDWARF::GetLogIfAll(DWARF_LOG_LOOKUPS));
2010 
2011   if (log)
2012     GetObjectFile()->GetModule()->LogMessage(
2013         log,
2014         "SymbolFileDWARF::FindGlobalVariables (name=\"%s\", "
2015         "parent_decl_ctx=%p, max_matches=%u, variables)",
2016         name.GetCString(), static_cast<const void *>(parent_decl_ctx),
2017         max_matches);
2018 
2019   if (!DeclContextMatchesThisSymbolFile(parent_decl_ctx))
2020     return 0;
2021 
2022   DWARFDebugInfo *info = DebugInfo();
2023   if (info == NULL)
2024     return 0;
2025 
2026   // Remember how many variables are in the list before we search.
2027   const uint32_t original_size = variables.GetSize();
2028 
2029   llvm::StringRef basename;
2030   llvm::StringRef context;
2031   bool name_is_mangled = (bool)Mangled(name);
2032 
2033   if (!CPlusPlusLanguage::ExtractContextAndIdentifier(name.GetCString(),
2034                                                       context, basename))
2035     basename = name.GetStringRef();
2036 
2037   DIEArray die_offsets;
2038   m_index->GetGlobalVariables(ConstString(basename), die_offsets);
2039   const size_t num_die_matches = die_offsets.size();
2040   if (num_die_matches) {
2041     SymbolContext sc;
2042     sc.module_sp = m_obj_file->GetModule();
2043     assert(sc.module_sp);
2044 
2045     // Loop invariant: Variables up to this index have been checked for context
2046     // matches.
2047     uint32_t pruned_idx = original_size;
2048 
2049     bool done = false;
2050     for (size_t i = 0; i < num_die_matches && !done; ++i) {
2051       const DIERef &die_ref = die_offsets[i];
2052       DWARFDIE die = GetDIE(die_ref);
2053 
2054       if (die) {
2055         switch (die.Tag()) {
2056         default:
2057         case DW_TAG_subprogram:
2058         case DW_TAG_inlined_subroutine:
2059         case DW_TAG_try_block:
2060         case DW_TAG_catch_block:
2061           break;
2062 
2063         case DW_TAG_variable: {
2064           sc.comp_unit = GetCompUnitForDWARFCompUnit(die.GetCU(), UINT32_MAX);
2065 
2066           if (parent_decl_ctx) {
2067             DWARFASTParser *dwarf_ast = die.GetDWARFParser();
2068             if (dwarf_ast) {
2069               CompilerDeclContext actual_parent_decl_ctx =
2070                   dwarf_ast->GetDeclContextContainingUIDFromDWARF(die);
2071               if (!actual_parent_decl_ctx ||
2072                   actual_parent_decl_ctx != *parent_decl_ctx)
2073                 continue;
2074             }
2075           }
2076 
2077           ParseVariables(sc, die, LLDB_INVALID_ADDRESS, false, false,
2078                          &variables);
2079           while (pruned_idx < variables.GetSize()) {
2080             VariableSP var_sp = variables.GetVariableAtIndex(pruned_idx);
2081             if (name_is_mangled ||
2082                 var_sp->GetName().GetStringRef().contains(name.GetStringRef()))
2083               ++pruned_idx;
2084             else
2085               variables.RemoveVariableAtIndex(pruned_idx);
2086           }
2087 
2088           if (variables.GetSize() - original_size >= max_matches)
2089             done = true;
2090         } break;
2091         }
2092       } else {
2093         m_index->ReportInvalidDIEOffset(die_ref.die_offset,
2094                                         name.GetStringRef());
2095       }
2096     }
2097   }
2098 
2099   // Return the number of variable that were appended to the list
2100   const uint32_t num_matches = variables.GetSize() - original_size;
2101   if (log && num_matches > 0) {
2102     GetObjectFile()->GetModule()->LogMessage(
2103         log,
2104         "SymbolFileDWARF::FindGlobalVariables (name=\"%s\", "
2105         "parent_decl_ctx=%p, max_matches=%u, variables) => %u",
2106         name.GetCString(), static_cast<const void *>(parent_decl_ctx),
2107         max_matches, num_matches);
2108   }
2109   return num_matches;
2110 }
2111 
2112 uint32_t SymbolFileDWARF::FindGlobalVariables(const RegularExpression &regex,
2113                                               uint32_t max_matches,
2114                                               VariableList &variables) {
2115   Log *log(LogChannelDWARF::GetLogIfAll(DWARF_LOG_LOOKUPS));
2116 
2117   if (log) {
2118     GetObjectFile()->GetModule()->LogMessage(
2119         log,
2120         "SymbolFileDWARF::FindGlobalVariables (regex=\"%s\", "
2121         "max_matches=%u, variables)",
2122         regex.GetText().str().c_str(), max_matches);
2123   }
2124 
2125   DWARFDebugInfo *info = DebugInfo();
2126   if (info == NULL)
2127     return 0;
2128 
2129   // Remember how many variables are in the list before we search.
2130   const uint32_t original_size = variables.GetSize();
2131 
2132   DIEArray die_offsets;
2133   m_index->GetGlobalVariables(regex, die_offsets);
2134 
2135   SymbolContext sc;
2136   sc.module_sp = m_obj_file->GetModule();
2137   assert(sc.module_sp);
2138 
2139   const size_t num_matches = die_offsets.size();
2140   if (num_matches) {
2141     for (size_t i = 0; i < num_matches; ++i) {
2142       const DIERef &die_ref = die_offsets[i];
2143       DWARFDIE die = GetDIE(die_ref);
2144 
2145       if (die) {
2146         sc.comp_unit = GetCompUnitForDWARFCompUnit(die.GetCU(), UINT32_MAX);
2147 
2148         ParseVariables(sc, die, LLDB_INVALID_ADDRESS, false, false, &variables);
2149 
2150         if (variables.GetSize() - original_size >= max_matches)
2151           break;
2152       } else
2153         m_index->ReportInvalidDIEOffset(die_ref.die_offset, regex.GetText());
2154     }
2155   }
2156 
2157   // Return the number of variable that were appended to the list
2158   return variables.GetSize() - original_size;
2159 }
2160 
2161 bool SymbolFileDWARF::ResolveFunction(const DWARFDIE &orig_die,
2162                                       bool include_inlines,
2163                                       SymbolContextList &sc_list) {
2164   SymbolContext sc;
2165 
2166   if (!orig_die)
2167     return false;
2168 
2169   // If we were passed a die that is not a function, just return false...
2170   if (!(orig_die.Tag() == DW_TAG_subprogram ||
2171         (include_inlines && orig_die.Tag() == DW_TAG_inlined_subroutine)))
2172     return false;
2173 
2174   DWARFDIE die = orig_die;
2175   DWARFDIE inlined_die;
2176   if (die.Tag() == DW_TAG_inlined_subroutine) {
2177     inlined_die = die;
2178 
2179     while (1) {
2180       die = die.GetParent();
2181 
2182       if (die) {
2183         if (die.Tag() == DW_TAG_subprogram)
2184           break;
2185       } else
2186         break;
2187     }
2188   }
2189   assert(die && die.Tag() == DW_TAG_subprogram);
2190   if (GetFunction(die, sc)) {
2191     Address addr;
2192     // Parse all blocks if needed
2193     if (inlined_die) {
2194       Block &function_block = sc.function->GetBlock(true);
2195       sc.block = function_block.FindBlockByID(inlined_die.GetID());
2196       if (sc.block == NULL)
2197         sc.block = function_block.FindBlockByID(inlined_die.GetOffset());
2198       if (sc.block == NULL || !sc.block->GetStartAddress(addr))
2199         addr.Clear();
2200     } else {
2201       sc.block = NULL;
2202       addr = sc.function->GetAddressRange().GetBaseAddress();
2203     }
2204 
2205     if (addr.IsValid()) {
2206       sc_list.Append(sc);
2207       return true;
2208     }
2209   }
2210 
2211   return false;
2212 }
2213 
2214 bool SymbolFileDWARF::DIEInDeclContext(const CompilerDeclContext *decl_ctx,
2215                                        const DWARFDIE &die) {
2216   // If we have no parent decl context to match this DIE matches, and if the
2217   // parent decl context isn't valid, we aren't trying to look for any
2218   // particular decl context so any die matches.
2219   if (decl_ctx == nullptr || !decl_ctx->IsValid())
2220     return true;
2221 
2222   if (die) {
2223     DWARFASTParser *dwarf_ast = die.GetDWARFParser();
2224     if (dwarf_ast) {
2225       CompilerDeclContext actual_decl_ctx =
2226           dwarf_ast->GetDeclContextContainingUIDFromDWARF(die);
2227       if (actual_decl_ctx)
2228         return decl_ctx->IsContainedInLookup(actual_decl_ctx);
2229     }
2230   }
2231   return false;
2232 }
2233 
2234 uint32_t SymbolFileDWARF::FindFunctions(
2235     ConstString name, const CompilerDeclContext *parent_decl_ctx,
2236     FunctionNameType name_type_mask, bool include_inlines, bool append,
2237     SymbolContextList &sc_list) {
2238   static Timer::Category func_cat(LLVM_PRETTY_FUNCTION);
2239   Timer scoped_timer(func_cat, "SymbolFileDWARF::FindFunctions (name = '%s')",
2240                      name.AsCString());
2241 
2242   // eFunctionNameTypeAuto should be pre-resolved by a call to
2243   // Module::LookupInfo::LookupInfo()
2244   assert((name_type_mask & eFunctionNameTypeAuto) == 0);
2245 
2246   Log *log(LogChannelDWARF::GetLogIfAll(DWARF_LOG_LOOKUPS));
2247 
2248   if (log) {
2249     GetObjectFile()->GetModule()->LogMessage(
2250         log, "SymbolFileDWARF::FindFunctions (name=\"%s\", "
2251              "name_type_mask=0x%x, append=%u, sc_list)",
2252         name.GetCString(), name_type_mask, append);
2253   }
2254 
2255   // If we aren't appending the results to this list, then clear the list
2256   if (!append)
2257     sc_list.Clear();
2258 
2259   if (!DeclContextMatchesThisSymbolFile(parent_decl_ctx))
2260     return 0;
2261 
2262   // If name is empty then we won't find anything.
2263   if (name.IsEmpty())
2264     return 0;
2265 
2266   // Remember how many sc_list are in the list before we search in case we are
2267   // appending the results to a variable list.
2268 
2269   const uint32_t original_size = sc_list.GetSize();
2270 
2271   DWARFDebugInfo *info = DebugInfo();
2272   if (info == NULL)
2273     return 0;
2274 
2275   llvm::DenseSet<const DWARFDebugInfoEntry *> resolved_dies;
2276   DIEArray offsets;
2277   CompilerDeclContext empty_decl_ctx;
2278   if (!parent_decl_ctx)
2279     parent_decl_ctx = &empty_decl_ctx;
2280 
2281   std::vector<DWARFDIE> dies;
2282   m_index->GetFunctions(name, *info, *parent_decl_ctx, name_type_mask, dies);
2283   for (const DWARFDIE &die: dies) {
2284     if (resolved_dies.insert(die.GetDIE()).second)
2285       ResolveFunction(die, include_inlines, sc_list);
2286   }
2287 
2288   // Return the number of variable that were appended to the list
2289   const uint32_t num_matches = sc_list.GetSize() - original_size;
2290 
2291   if (log && num_matches > 0) {
2292     GetObjectFile()->GetModule()->LogMessage(
2293         log, "SymbolFileDWARF::FindFunctions (name=\"%s\", "
2294              "name_type_mask=0x%x, include_inlines=%d, append=%u, sc_list) => "
2295              "%u",
2296         name.GetCString(), name_type_mask, include_inlines, append,
2297         num_matches);
2298   }
2299   return num_matches;
2300 }
2301 
2302 uint32_t SymbolFileDWARF::FindFunctions(const RegularExpression &regex,
2303                                         bool include_inlines, bool append,
2304                                         SymbolContextList &sc_list) {
2305   static Timer::Category func_cat(LLVM_PRETTY_FUNCTION);
2306   Timer scoped_timer(func_cat, "SymbolFileDWARF::FindFunctions (regex = '%s')",
2307                      regex.GetText().str().c_str());
2308 
2309   Log *log(LogChannelDWARF::GetLogIfAll(DWARF_LOG_LOOKUPS));
2310 
2311   if (log) {
2312     GetObjectFile()->GetModule()->LogMessage(
2313         log,
2314         "SymbolFileDWARF::FindFunctions (regex=\"%s\", append=%u, sc_list)",
2315         regex.GetText().str().c_str(), append);
2316   }
2317 
2318   // If we aren't appending the results to this list, then clear the list
2319   if (!append)
2320     sc_list.Clear();
2321 
2322   DWARFDebugInfo *info = DebugInfo();
2323   if (!info)
2324     return 0;
2325 
2326   // Remember how many sc_list are in the list before we search in case we are
2327   // appending the results to a variable list.
2328   uint32_t original_size = sc_list.GetSize();
2329 
2330   DIEArray offsets;
2331   m_index->GetFunctions(regex, offsets);
2332 
2333   llvm::DenseSet<const DWARFDebugInfoEntry *> resolved_dies;
2334   for (DIERef ref : offsets) {
2335     DWARFDIE die = info->GetDIE(ref);
2336     if (!die) {
2337       m_index->ReportInvalidDIEOffset(ref.die_offset, regex.GetText());
2338       continue;
2339     }
2340     if (resolved_dies.insert(die.GetDIE()).second)
2341       ResolveFunction(die, include_inlines, sc_list);
2342   }
2343 
2344   // Return the number of variable that were appended to the list
2345   return sc_list.GetSize() - original_size;
2346 }
2347 
2348 void SymbolFileDWARF::GetMangledNamesForFunction(
2349     const std::string &scope_qualified_name,
2350     std::vector<ConstString> &mangled_names) {
2351   DWARFDebugInfo *info = DebugInfo();
2352   uint32_t num_comp_units = 0;
2353   if (info)
2354     num_comp_units = info->GetNumCompileUnits();
2355 
2356   for (uint32_t i = 0; i < num_comp_units; i++) {
2357     DWARFUnit *cu = info->GetCompileUnitAtIndex(i);
2358     if (cu == nullptr)
2359       continue;
2360 
2361     SymbolFileDWARFDwo *dwo = cu->GetDwoSymbolFile();
2362     if (dwo)
2363       dwo->GetMangledNamesForFunction(scope_qualified_name, mangled_names);
2364   }
2365 
2366   NameToOffsetMap::iterator iter =
2367       m_function_scope_qualified_name_map.find(scope_qualified_name);
2368   if (iter == m_function_scope_qualified_name_map.end())
2369     return;
2370 
2371   DIERefSetSP set_sp = (*iter).second;
2372   std::set<DIERef>::iterator set_iter;
2373   for (set_iter = set_sp->begin(); set_iter != set_sp->end(); set_iter++) {
2374     DWARFDIE die = DebugInfo()->GetDIE(*set_iter);
2375     mangled_names.push_back(ConstString(die.GetMangledName()));
2376   }
2377 }
2378 
2379 uint32_t SymbolFileDWARF::FindTypes(
2380     ConstString name, const CompilerDeclContext *parent_decl_ctx,
2381     bool append, uint32_t max_matches,
2382     llvm::DenseSet<lldb_private::SymbolFile *> &searched_symbol_files,
2383     TypeMap &types) {
2384   // If we aren't appending the results to this list, then clear the list
2385   if (!append)
2386     types.Clear();
2387 
2388   // Make sure we haven't already searched this SymbolFile before...
2389   if (searched_symbol_files.count(this))
2390     return 0;
2391   else
2392     searched_symbol_files.insert(this);
2393 
2394   DWARFDebugInfo *info = DebugInfo();
2395   if (info == NULL)
2396     return 0;
2397 
2398   Log *log(LogChannelDWARF::GetLogIfAll(DWARF_LOG_LOOKUPS));
2399 
2400   if (log) {
2401     if (parent_decl_ctx)
2402       GetObjectFile()->GetModule()->LogMessage(
2403           log, "SymbolFileDWARF::FindTypes (sc, name=\"%s\", parent_decl_ctx = "
2404                "%p (\"%s\"), append=%u, max_matches=%u, type_list)",
2405           name.GetCString(), static_cast<const void *>(parent_decl_ctx),
2406           parent_decl_ctx->GetName().AsCString("<NULL>"), append, max_matches);
2407     else
2408       GetObjectFile()->GetModule()->LogMessage(
2409           log, "SymbolFileDWARF::FindTypes (sc, name=\"%s\", parent_decl_ctx = "
2410                "NULL, append=%u, max_matches=%u, type_list)",
2411           name.GetCString(), append, max_matches);
2412   }
2413 
2414   if (!DeclContextMatchesThisSymbolFile(parent_decl_ctx))
2415     return 0;
2416 
2417   DIEArray die_offsets;
2418   m_index->GetTypes(name, die_offsets);
2419   const size_t num_die_matches = die_offsets.size();
2420 
2421   if (num_die_matches) {
2422     const uint32_t initial_types_size = types.GetSize();
2423     for (size_t i = 0; i < num_die_matches; ++i) {
2424       const DIERef &die_ref = die_offsets[i];
2425       DWARFDIE die = GetDIE(die_ref);
2426 
2427       if (die) {
2428         if (!DIEInDeclContext(parent_decl_ctx, die))
2429           continue; // The containing decl contexts don't match
2430 
2431         Type *matching_type = ResolveType(die, true, true);
2432         if (matching_type) {
2433           // We found a type pointer, now find the shared pointer form our type
2434           // list
2435           types.InsertUnique(matching_type->shared_from_this());
2436           if (types.GetSize() >= max_matches)
2437             break;
2438         }
2439       } else {
2440         m_index->ReportInvalidDIEOffset(die_ref.die_offset,
2441                                         name.GetStringRef());
2442       }
2443     }
2444     const uint32_t num_matches = types.GetSize() - initial_types_size;
2445     if (log && num_matches) {
2446       if (parent_decl_ctx) {
2447         GetObjectFile()->GetModule()->LogMessage(
2448             log, "SymbolFileDWARF::FindTypes (sc, name=\"%s\", parent_decl_ctx "
2449                  "= %p (\"%s\"), append=%u, max_matches=%u, type_list) => %u",
2450             name.GetCString(), static_cast<const void *>(parent_decl_ctx),
2451             parent_decl_ctx->GetName().AsCString("<NULL>"), append, max_matches,
2452             num_matches);
2453       } else {
2454         GetObjectFile()->GetModule()->LogMessage(
2455             log, "SymbolFileDWARF::FindTypes (sc, name=\"%s\", parent_decl_ctx "
2456                  "= NULL, append=%u, max_matches=%u, type_list) => %u",
2457             name.GetCString(), append, max_matches, num_matches);
2458       }
2459     }
2460     return num_matches;
2461   } else {
2462     UpdateExternalModuleListIfNeeded();
2463 
2464     for (const auto &pair : m_external_type_modules) {
2465       ModuleSP external_module_sp = pair.second;
2466       if (external_module_sp) {
2467         SymbolVendor *sym_vendor = external_module_sp->GetSymbolVendor();
2468         if (sym_vendor) {
2469           const uint32_t num_external_matches =
2470               sym_vendor->FindTypes(name, parent_decl_ctx, append, max_matches,
2471                                     searched_symbol_files, types);
2472           if (num_external_matches)
2473             return num_external_matches;
2474         }
2475       }
2476     }
2477   }
2478 
2479   return 0;
2480 }
2481 
2482 size_t SymbolFileDWARF::FindTypes(const std::vector<CompilerContext> &context,
2483                                   bool append, TypeMap &types) {
2484   if (!append)
2485     types.Clear();
2486 
2487   if (context.empty())
2488     return 0;
2489 
2490   ConstString name = context.back().name;
2491 
2492   if (!name)
2493     return 0;
2494 
2495   DIEArray die_offsets;
2496   m_index->GetTypes(name, die_offsets);
2497   const size_t num_die_matches = die_offsets.size();
2498 
2499   if (num_die_matches) {
2500     size_t num_matches = 0;
2501     for (size_t i = 0; i < num_die_matches; ++i) {
2502       const DIERef &die_ref = die_offsets[i];
2503       DWARFDIE die = GetDIE(die_ref);
2504 
2505       if (die) {
2506         std::vector<CompilerContext> die_context;
2507         die.GetDeclContext(die_context);
2508         if (die_context != context)
2509           continue;
2510 
2511         Type *matching_type = ResolveType(die, true, true);
2512         if (matching_type) {
2513           // We found a type pointer, now find the shared pointer form our type
2514           // list
2515           types.InsertUnique(matching_type->shared_from_this());
2516           ++num_matches;
2517         }
2518       } else {
2519         m_index->ReportInvalidDIEOffset(die_ref.die_offset,
2520                                         name.GetStringRef());
2521       }
2522     }
2523     return num_matches;
2524   }
2525   return 0;
2526 }
2527 
2528 CompilerDeclContext
2529 SymbolFileDWARF::FindNamespace(ConstString name,
2530                                const CompilerDeclContext *parent_decl_ctx) {
2531   Log *log(LogChannelDWARF::GetLogIfAll(DWARF_LOG_LOOKUPS));
2532 
2533   if (log) {
2534     GetObjectFile()->GetModule()->LogMessage(
2535         log, "SymbolFileDWARF::FindNamespace (sc, name=\"%s\")",
2536         name.GetCString());
2537   }
2538 
2539   CompilerDeclContext namespace_decl_ctx;
2540 
2541   if (!DeclContextMatchesThisSymbolFile(parent_decl_ctx))
2542     return namespace_decl_ctx;
2543 
2544   DWARFDebugInfo *info = DebugInfo();
2545   if (info) {
2546     DIEArray die_offsets;
2547     m_index->GetNamespaces(name, die_offsets);
2548     const size_t num_matches = die_offsets.size();
2549     if (num_matches) {
2550       for (size_t i = 0; i < num_matches; ++i) {
2551         const DIERef &die_ref = die_offsets[i];
2552         DWARFDIE die = GetDIE(die_ref);
2553 
2554         if (die) {
2555           if (!DIEInDeclContext(parent_decl_ctx, die))
2556             continue; // The containing decl contexts don't match
2557 
2558           DWARFASTParser *dwarf_ast = die.GetDWARFParser();
2559           if (dwarf_ast) {
2560             namespace_decl_ctx = dwarf_ast->GetDeclContextForUIDFromDWARF(die);
2561             if (namespace_decl_ctx)
2562               break;
2563           }
2564         } else {
2565           m_index->ReportInvalidDIEOffset(die_ref.die_offset,
2566                                           name.GetStringRef());
2567         }
2568       }
2569     }
2570   }
2571   if (log && namespace_decl_ctx) {
2572     GetObjectFile()->GetModule()->LogMessage(
2573         log, "SymbolFileDWARF::FindNamespace (sc, name=\"%s\") => "
2574              "CompilerDeclContext(%p/%p) \"%s\"",
2575         name.GetCString(),
2576         static_cast<const void *>(namespace_decl_ctx.GetTypeSystem()),
2577         static_cast<const void *>(namespace_decl_ctx.GetOpaqueDeclContext()),
2578         namespace_decl_ctx.GetName().AsCString("<NULL>"));
2579   }
2580 
2581   return namespace_decl_ctx;
2582 }
2583 
2584 TypeSP SymbolFileDWARF::GetTypeForDIE(const DWARFDIE &die,
2585                                       bool resolve_function_context) {
2586   TypeSP type_sp;
2587   if (die) {
2588     Type *type_ptr = GetDIEToType().lookup(die.GetDIE());
2589     if (type_ptr == NULL) {
2590       CompileUnit *lldb_cu = GetCompUnitForDWARFCompUnit(die.GetCU());
2591       assert(lldb_cu);
2592       SymbolContext sc(lldb_cu);
2593       const DWARFDebugInfoEntry *parent_die = die.GetParent().GetDIE();
2594       while (parent_die != nullptr) {
2595         if (parent_die->Tag() == DW_TAG_subprogram)
2596           break;
2597         parent_die = parent_die->GetParent();
2598       }
2599       SymbolContext sc_backup = sc;
2600       if (resolve_function_context && parent_die != nullptr &&
2601           !GetFunction(DWARFDIE(die.GetCU(), parent_die), sc))
2602         sc = sc_backup;
2603 
2604       type_sp = ParseType(sc, die, NULL);
2605     } else if (type_ptr != DIE_IS_BEING_PARSED) {
2606       // Grab the existing type from the master types lists
2607       type_sp = type_ptr->shared_from_this();
2608     }
2609   }
2610   return type_sp;
2611 }
2612 
2613 DWARFDIE
2614 SymbolFileDWARF::GetDeclContextDIEContainingDIE(const DWARFDIE &orig_die) {
2615   if (orig_die) {
2616     DWARFDIE die = orig_die;
2617 
2618     while (die) {
2619       // If this is the original DIE that we are searching for a declaration
2620       // for, then don't look in the cache as we don't want our own decl
2621       // context to be our decl context...
2622       if (orig_die != die) {
2623         switch (die.Tag()) {
2624         case DW_TAG_compile_unit:
2625         case DW_TAG_partial_unit:
2626         case DW_TAG_namespace:
2627         case DW_TAG_structure_type:
2628         case DW_TAG_union_type:
2629         case DW_TAG_class_type:
2630         case DW_TAG_lexical_block:
2631         case DW_TAG_subprogram:
2632           return die;
2633         case DW_TAG_inlined_subroutine: {
2634           DWARFDIE abs_die = die.GetReferencedDIE(DW_AT_abstract_origin);
2635           if (abs_die) {
2636             return abs_die;
2637           }
2638           break;
2639         }
2640         default:
2641           break;
2642         }
2643       }
2644 
2645       DWARFDIE spec_die = die.GetReferencedDIE(DW_AT_specification);
2646       if (spec_die) {
2647         DWARFDIE decl_ctx_die = GetDeclContextDIEContainingDIE(spec_die);
2648         if (decl_ctx_die)
2649           return decl_ctx_die;
2650       }
2651 
2652       DWARFDIE abs_die = die.GetReferencedDIE(DW_AT_abstract_origin);
2653       if (abs_die) {
2654         DWARFDIE decl_ctx_die = GetDeclContextDIEContainingDIE(abs_die);
2655         if (decl_ctx_die)
2656           return decl_ctx_die;
2657       }
2658 
2659       die = die.GetParent();
2660     }
2661   }
2662   return DWARFDIE();
2663 }
2664 
2665 Symbol *
2666 SymbolFileDWARF::GetObjCClassSymbol(ConstString objc_class_name) {
2667   Symbol *objc_class_symbol = NULL;
2668   if (m_obj_file) {
2669     Symtab *symtab = m_obj_file->GetSymtab();
2670     if (symtab) {
2671       objc_class_symbol = symtab->FindFirstSymbolWithNameAndType(
2672           objc_class_name, eSymbolTypeObjCClass, Symtab::eDebugNo,
2673           Symtab::eVisibilityAny);
2674     }
2675   }
2676   return objc_class_symbol;
2677 }
2678 
2679 // Some compilers don't emit the DW_AT_APPLE_objc_complete_type attribute. If
2680 // they don't then we can end up looking through all class types for a complete
2681 // type and never find the full definition. We need to know if this attribute
2682 // is supported, so we determine this here and cache th result. We also need to
2683 // worry about the debug map
2684 // DWARF file
2685 // if we are doing darwin DWARF in .o file debugging.
2686 bool SymbolFileDWARF::Supports_DW_AT_APPLE_objc_complete_type(
2687     DWARFUnit *cu) {
2688   if (m_supports_DW_AT_APPLE_objc_complete_type == eLazyBoolCalculate) {
2689     m_supports_DW_AT_APPLE_objc_complete_type = eLazyBoolNo;
2690     if (cu && cu->Supports_DW_AT_APPLE_objc_complete_type())
2691       m_supports_DW_AT_APPLE_objc_complete_type = eLazyBoolYes;
2692     else {
2693       DWARFDebugInfo *debug_info = DebugInfo();
2694       const uint32_t num_compile_units = GetNumCompileUnits();
2695       for (uint32_t cu_idx = 0; cu_idx < num_compile_units; ++cu_idx) {
2696         DWARFUnit *dwarf_cu = debug_info->GetCompileUnitAtIndex(cu_idx);
2697         if (dwarf_cu != cu &&
2698             dwarf_cu->Supports_DW_AT_APPLE_objc_complete_type()) {
2699           m_supports_DW_AT_APPLE_objc_complete_type = eLazyBoolYes;
2700           break;
2701         }
2702       }
2703     }
2704     if (m_supports_DW_AT_APPLE_objc_complete_type == eLazyBoolNo &&
2705         GetDebugMapSymfile())
2706       return m_debug_map_symfile->Supports_DW_AT_APPLE_objc_complete_type(this);
2707   }
2708   return m_supports_DW_AT_APPLE_objc_complete_type == eLazyBoolYes;
2709 }
2710 
2711 // This function can be used when a DIE is found that is a forward declaration
2712 // DIE and we want to try and find a type that has the complete definition.
2713 TypeSP SymbolFileDWARF::FindCompleteObjCDefinitionTypeForDIE(
2714     const DWARFDIE &die, ConstString type_name,
2715     bool must_be_implementation) {
2716 
2717   TypeSP type_sp;
2718 
2719   if (!type_name || (must_be_implementation && !GetObjCClassSymbol(type_name)))
2720     return type_sp;
2721 
2722   DIEArray die_offsets;
2723   m_index->GetCompleteObjCClass(type_name, must_be_implementation, die_offsets);
2724 
2725   const size_t num_matches = die_offsets.size();
2726 
2727   if (num_matches) {
2728     for (size_t i = 0; i < num_matches; ++i) {
2729       const DIERef &die_ref = die_offsets[i];
2730       DWARFDIE type_die = GetDIE(die_ref);
2731 
2732       if (type_die) {
2733         bool try_resolving_type = false;
2734 
2735         // Don't try and resolve the DIE we are looking for with the DIE
2736         // itself!
2737         if (type_die != die) {
2738           switch (type_die.Tag()) {
2739           case DW_TAG_class_type:
2740           case DW_TAG_structure_type:
2741             try_resolving_type = true;
2742             break;
2743           default:
2744             break;
2745           }
2746         }
2747 
2748         if (try_resolving_type) {
2749           if (must_be_implementation &&
2750               type_die.Supports_DW_AT_APPLE_objc_complete_type())
2751             try_resolving_type = type_die.GetAttributeValueAsUnsigned(
2752                 DW_AT_APPLE_objc_complete_type, 0);
2753 
2754           if (try_resolving_type) {
2755             Type *resolved_type = ResolveType(type_die, false, true);
2756             if (resolved_type && resolved_type != DIE_IS_BEING_PARSED) {
2757               DEBUG_PRINTF("resolved 0x%8.8" PRIx64 " from %s to 0x%8.8" PRIx64
2758                            " (cu 0x%8.8" PRIx64 ")\n",
2759                            die.GetID(),
2760                            m_obj_file->GetFileSpec().GetFilename().AsCString(
2761                                "<Unknown>"),
2762                            type_die.GetID(), type_cu->GetID());
2763 
2764               if (die)
2765                 GetDIEToType()[die.GetDIE()] = resolved_type;
2766               type_sp = resolved_type->shared_from_this();
2767               break;
2768             }
2769           }
2770         }
2771       } else {
2772         m_index->ReportInvalidDIEOffset(die_ref.die_offset,
2773                                         type_name.GetStringRef());
2774       }
2775     }
2776   }
2777   return type_sp;
2778 }
2779 
2780 // This function helps to ensure that the declaration contexts match for two
2781 // different DIEs. Often times debug information will refer to a forward
2782 // declaration of a type (the equivalent of "struct my_struct;". There will
2783 // often be a declaration of that type elsewhere that has the full definition.
2784 // When we go looking for the full type "my_struct", we will find one or more
2785 // matches in the accelerator tables and we will then need to make sure the
2786 // type was in the same declaration context as the original DIE. This function
2787 // can efficiently compare two DIEs and will return true when the declaration
2788 // context matches, and false when they don't.
2789 bool SymbolFileDWARF::DIEDeclContextsMatch(const DWARFDIE &die1,
2790                                            const DWARFDIE &die2) {
2791   if (die1 == die2)
2792     return true;
2793 
2794   std::vector<DWARFDIE> decl_ctx_1;
2795   std::vector<DWARFDIE> decl_ctx_2;
2796   // The declaration DIE stack is a stack of the declaration context DIEs all
2797   // the way back to the compile unit. If a type "T" is declared inside a class
2798   // "B", and class "B" is declared inside a class "A" and class "A" is in a
2799   // namespace "lldb", and the namespace is in a compile unit, there will be a
2800   // stack of DIEs:
2801   //
2802   //   [0] DW_TAG_class_type for "B"
2803   //   [1] DW_TAG_class_type for "A"
2804   //   [2] DW_TAG_namespace  for "lldb"
2805   //   [3] DW_TAG_compile_unit or DW_TAG_partial_unit for the source file.
2806   //
2807   // We grab both contexts and make sure that everything matches all the way
2808   // back to the compiler unit.
2809 
2810   // First lets grab the decl contexts for both DIEs
2811   decl_ctx_1 = die1.GetDeclContextDIEs();
2812   decl_ctx_2 = die2.GetDeclContextDIEs();
2813   // Make sure the context arrays have the same size, otherwise we are done
2814   const size_t count1 = decl_ctx_1.size();
2815   const size_t count2 = decl_ctx_2.size();
2816   if (count1 != count2)
2817     return false;
2818 
2819   // Make sure the DW_TAG values match all the way back up the compile unit. If
2820   // they don't, then we are done.
2821   DWARFDIE decl_ctx_die1;
2822   DWARFDIE decl_ctx_die2;
2823   size_t i;
2824   for (i = 0; i < count1; i++) {
2825     decl_ctx_die1 = decl_ctx_1[i];
2826     decl_ctx_die2 = decl_ctx_2[i];
2827     if (decl_ctx_die1.Tag() != decl_ctx_die2.Tag())
2828       return false;
2829   }
2830 #ifndef NDEBUG
2831 
2832   // Make sure the top item in the decl context die array is always
2833   // DW_TAG_compile_unit or DW_TAG_partial_unit. If it isn't then
2834   // something went wrong in the DWARFDIE::GetDeclContextDIEs()
2835   // function.
2836   dw_tag_t cu_tag = decl_ctx_1[count1 - 1].Tag();
2837   UNUSED_IF_ASSERT_DISABLED(cu_tag);
2838   assert(cu_tag == DW_TAG_compile_unit || cu_tag == DW_TAG_partial_unit);
2839 
2840 #endif
2841   // Always skip the compile unit when comparing by only iterating up to "count
2842   // - 1". Here we compare the names as we go.
2843   for (i = 0; i < count1 - 1; i++) {
2844     decl_ctx_die1 = decl_ctx_1[i];
2845     decl_ctx_die2 = decl_ctx_2[i];
2846     const char *name1 = decl_ctx_die1.GetName();
2847     const char *name2 = decl_ctx_die2.GetName();
2848     // If the string was from a DW_FORM_strp, then the pointer will often be
2849     // the same!
2850     if (name1 == name2)
2851       continue;
2852 
2853     // Name pointers are not equal, so only compare the strings if both are not
2854     // NULL.
2855     if (name1 && name2) {
2856       // If the strings don't compare, we are done...
2857       if (strcmp(name1, name2) != 0)
2858         return false;
2859     } else {
2860       // One name was NULL while the other wasn't
2861       return false;
2862     }
2863   }
2864   // We made it through all of the checks and the declaration contexts are
2865   // equal.
2866   return true;
2867 }
2868 
2869 TypeSP SymbolFileDWARF::FindDefinitionTypeForDWARFDeclContext(
2870     const DWARFDeclContext &dwarf_decl_ctx) {
2871   TypeSP type_sp;
2872 
2873   const uint32_t dwarf_decl_ctx_count = dwarf_decl_ctx.GetSize();
2874   if (dwarf_decl_ctx_count > 0) {
2875     const ConstString type_name(dwarf_decl_ctx[0].name);
2876     const dw_tag_t tag = dwarf_decl_ctx[0].tag;
2877 
2878     if (type_name) {
2879       Log *log(LogChannelDWARF::GetLogIfAny(DWARF_LOG_TYPE_COMPLETION |
2880                                             DWARF_LOG_LOOKUPS));
2881       if (log) {
2882         GetObjectFile()->GetModule()->LogMessage(
2883             log, "SymbolFileDWARF::FindDefinitionTypeForDWARFDeclContext(tag=%"
2884                  "s, qualified-name='%s')",
2885             DW_TAG_value_to_name(dwarf_decl_ctx[0].tag),
2886             dwarf_decl_ctx.GetQualifiedName());
2887       }
2888 
2889       DIEArray die_offsets;
2890       m_index->GetTypes(dwarf_decl_ctx, die_offsets);
2891       const size_t num_matches = die_offsets.size();
2892 
2893       // Get the type system that we are looking to find a type for. We will
2894       // use this to ensure any matches we find are in a language that this
2895       // type system supports
2896       const LanguageType language = dwarf_decl_ctx.GetLanguage();
2897       TypeSystem *type_system = (language == eLanguageTypeUnknown)
2898                                     ? nullptr
2899                                     : GetTypeSystemForLanguage(language);
2900 
2901       if (num_matches) {
2902         for (size_t i = 0; i < num_matches; ++i) {
2903           const DIERef &die_ref = die_offsets[i];
2904           DWARFDIE type_die = GetDIE(die_ref);
2905 
2906           if (type_die) {
2907             // Make sure type_die's langauge matches the type system we are
2908             // looking for. We don't want to find a "Foo" type from Java if we
2909             // are looking for a "Foo" type for C, C++, ObjC, or ObjC++.
2910             if (type_system &&
2911                 !type_system->SupportsLanguage(type_die.GetLanguage()))
2912               continue;
2913             bool try_resolving_type = false;
2914 
2915             // Don't try and resolve the DIE we are looking for with the DIE
2916             // itself!
2917             const dw_tag_t type_tag = type_die.Tag();
2918             // Make sure the tags match
2919             if (type_tag == tag) {
2920               // The tags match, lets try resolving this type
2921               try_resolving_type = true;
2922             } else {
2923               // The tags don't match, but we need to watch our for a forward
2924               // declaration for a struct and ("struct foo") ends up being a
2925               // class ("class foo { ... };") or vice versa.
2926               switch (type_tag) {
2927               case DW_TAG_class_type:
2928                 // We had a "class foo", see if we ended up with a "struct foo
2929                 // { ... };"
2930                 try_resolving_type = (tag == DW_TAG_structure_type);
2931                 break;
2932               case DW_TAG_structure_type:
2933                 // We had a "struct foo", see if we ended up with a "class foo
2934                 // { ... };"
2935                 try_resolving_type = (tag == DW_TAG_class_type);
2936                 break;
2937               default:
2938                 // Tags don't match, don't event try to resolve using this type
2939                 // whose name matches....
2940                 break;
2941               }
2942             }
2943 
2944             if (try_resolving_type) {
2945               DWARFDeclContext type_dwarf_decl_ctx;
2946               type_die.GetDWARFDeclContext(type_dwarf_decl_ctx);
2947 
2948               if (log) {
2949                 GetObjectFile()->GetModule()->LogMessage(
2950                     log, "SymbolFileDWARF::"
2951                          "FindDefinitionTypeForDWARFDeclContext(tag=%s, "
2952                          "qualified-name='%s') trying die=0x%8.8x (%s)",
2953                     DW_TAG_value_to_name(dwarf_decl_ctx[0].tag),
2954                     dwarf_decl_ctx.GetQualifiedName(), type_die.GetOffset(),
2955                     type_dwarf_decl_ctx.GetQualifiedName());
2956               }
2957 
2958               // Make sure the decl contexts match all the way up
2959               if (dwarf_decl_ctx == type_dwarf_decl_ctx) {
2960                 Type *resolved_type = ResolveType(type_die, false);
2961                 if (resolved_type && resolved_type != DIE_IS_BEING_PARSED) {
2962                   type_sp = resolved_type->shared_from_this();
2963                   break;
2964                 }
2965               }
2966             } else {
2967               if (log) {
2968                 std::string qualified_name;
2969                 type_die.GetQualifiedName(qualified_name);
2970                 GetObjectFile()->GetModule()->LogMessage(
2971                     log, "SymbolFileDWARF::"
2972                          "FindDefinitionTypeForDWARFDeclContext(tag=%s, "
2973                          "qualified-name='%s') ignoring die=0x%8.8x (%s)",
2974                     DW_TAG_value_to_name(dwarf_decl_ctx[0].tag),
2975                     dwarf_decl_ctx.GetQualifiedName(), type_die.GetOffset(),
2976                     qualified_name.c_str());
2977               }
2978             }
2979           } else {
2980             m_index->ReportInvalidDIEOffset(die_ref.die_offset,
2981                                             type_name.GetStringRef());
2982           }
2983         }
2984       }
2985     }
2986   }
2987   return type_sp;
2988 }
2989 
2990 TypeSP SymbolFileDWARF::ParseType(const SymbolContext &sc, const DWARFDIE &die,
2991                                   bool *type_is_new_ptr) {
2992   TypeSP type_sp;
2993 
2994   if (die) {
2995     TypeSystem *type_system =
2996         GetTypeSystemForLanguage(die.GetCU()->GetLanguageType());
2997 
2998     if (type_system) {
2999       DWARFASTParser *dwarf_ast = type_system->GetDWARFParser();
3000       if (dwarf_ast) {
3001         Log *log = LogChannelDWARF::GetLogIfAll(DWARF_LOG_DEBUG_INFO);
3002         type_sp = dwarf_ast->ParseTypeFromDWARF(sc, die, log, type_is_new_ptr);
3003         if (type_sp) {
3004           TypeList *type_list = GetTypeList();
3005           if (type_list)
3006             type_list->Insert(type_sp);
3007 
3008           if (die.Tag() == DW_TAG_subprogram) {
3009             DIERef die_ref = die.GetDIERef();
3010             std::string scope_qualified_name(GetDeclContextForUID(die.GetID())
3011                                                  .GetScopeQualifiedName()
3012                                                  .AsCString(""));
3013             if (scope_qualified_name.size()) {
3014               NameToOffsetMap::iterator iter =
3015                   m_function_scope_qualified_name_map.find(
3016                       scope_qualified_name);
3017               if (iter != m_function_scope_qualified_name_map.end())
3018                 (*iter).second->insert(die_ref);
3019               else {
3020                 DIERefSetSP new_set(new std::set<DIERef>);
3021                 new_set->insert(die_ref);
3022                 m_function_scope_qualified_name_map.emplace(
3023                     std::make_pair(scope_qualified_name, new_set));
3024               }
3025             }
3026           }
3027         }
3028       }
3029     }
3030   }
3031 
3032   return type_sp;
3033 }
3034 
3035 size_t SymbolFileDWARF::ParseTypes(const SymbolContext &sc,
3036                                    const DWARFDIE &orig_die,
3037                                    bool parse_siblings, bool parse_children) {
3038   size_t types_added = 0;
3039   DWARFDIE die = orig_die;
3040   while (die) {
3041     bool type_is_new = false;
3042     if (ParseType(sc, die, &type_is_new).get()) {
3043       if (type_is_new)
3044         ++types_added;
3045     }
3046 
3047     if (parse_children && die.HasChildren()) {
3048       if (die.Tag() == DW_TAG_subprogram) {
3049         SymbolContext child_sc(sc);
3050         child_sc.function = sc.comp_unit->FindFunctionByUID(die.GetID()).get();
3051         types_added += ParseTypes(child_sc, die.GetFirstChild(), true, true);
3052       } else
3053         types_added += ParseTypes(sc, die.GetFirstChild(), true, true);
3054     }
3055 
3056     if (parse_siblings)
3057       die = die.GetSibling();
3058     else
3059       die.Clear();
3060   }
3061   return types_added;
3062 }
3063 
3064 size_t SymbolFileDWARF::ParseBlocksRecursive(Function &func) {
3065   ASSERT_MODULE_LOCK(this);
3066   CompileUnit *comp_unit = func.GetCompileUnit();
3067   lldbassert(comp_unit);
3068 
3069   DWARFUnit *dwarf_cu = GetDWARFCompileUnit(comp_unit);
3070   if (!dwarf_cu)
3071     return 0;
3072 
3073   size_t functions_added = 0;
3074   const dw_offset_t function_die_offset = func.GetID();
3075   DWARFDIE function_die = dwarf_cu->GetDIE(function_die_offset);
3076   if (function_die) {
3077     ParseBlocksRecursive(*comp_unit, &func.GetBlock(false), function_die,
3078                          LLDB_INVALID_ADDRESS, 0);
3079   }
3080 
3081   return functions_added;
3082 }
3083 
3084 size_t SymbolFileDWARF::ParseTypes(CompileUnit &comp_unit) {
3085   ASSERT_MODULE_LOCK(this);
3086   size_t types_added = 0;
3087   DWARFUnit *dwarf_cu = GetDWARFCompileUnit(&comp_unit);
3088   if (dwarf_cu) {
3089     DWARFDIE dwarf_cu_die = dwarf_cu->DIE();
3090     if (dwarf_cu_die && dwarf_cu_die.HasChildren()) {
3091       SymbolContext sc;
3092       sc.comp_unit = &comp_unit;
3093       types_added = ParseTypes(sc, dwarf_cu_die.GetFirstChild(), true, true);
3094     }
3095   }
3096 
3097   return types_added;
3098 }
3099 
3100 size_t SymbolFileDWARF::ParseVariablesForContext(const SymbolContext &sc) {
3101   ASSERT_MODULE_LOCK(this);
3102   if (sc.comp_unit != NULL) {
3103     DWARFDebugInfo *info = DebugInfo();
3104     if (info == NULL)
3105       return 0;
3106 
3107     if (sc.function) {
3108       DWARFDIE function_die = info->GetDIE(DIERef(sc.function->GetID(), this));
3109 
3110       const dw_addr_t func_lo_pc = function_die.GetAttributeValueAsAddress(
3111           DW_AT_low_pc, LLDB_INVALID_ADDRESS);
3112       if (func_lo_pc != LLDB_INVALID_ADDRESS) {
3113         const size_t num_variables = ParseVariables(
3114             sc, function_die.GetFirstChild(), func_lo_pc, true, true);
3115 
3116         // Let all blocks know they have parse all their variables
3117         sc.function->GetBlock(false).SetDidParseVariables(true, true);
3118         return num_variables;
3119       }
3120     } else if (sc.comp_unit) {
3121       DWARFUnit *dwarf_cu = info->GetCompileUnitAtIndex(sc.comp_unit->GetID());
3122 
3123       if (dwarf_cu == NULL)
3124         return 0;
3125 
3126       uint32_t vars_added = 0;
3127       VariableListSP variables(sc.comp_unit->GetVariableList(false));
3128 
3129       if (variables.get() == NULL) {
3130         variables = std::make_shared<VariableList>();
3131         sc.comp_unit->SetVariableList(variables);
3132 
3133         DIEArray die_offsets;
3134         m_index->GetGlobalVariables(*dwarf_cu, die_offsets);
3135         const size_t num_matches = die_offsets.size();
3136         if (num_matches) {
3137           for (size_t i = 0; i < num_matches; ++i) {
3138             const DIERef &die_ref = die_offsets[i];
3139             DWARFDIE die = GetDIE(die_ref);
3140             if (die) {
3141               VariableSP var_sp(
3142                   ParseVariableDIE(sc, die, LLDB_INVALID_ADDRESS));
3143               if (var_sp) {
3144                 variables->AddVariableIfUnique(var_sp);
3145                 ++vars_added;
3146               }
3147             } else
3148               m_index->ReportInvalidDIEOffset(die_ref.die_offset, "");
3149           }
3150         }
3151       }
3152       return vars_added;
3153     }
3154   }
3155   return 0;
3156 }
3157 
3158 VariableSP SymbolFileDWARF::ParseVariableDIE(const SymbolContext &sc,
3159                                              const DWARFDIE &die,
3160                                              const lldb::addr_t func_low_pc) {
3161   if (die.GetDWARF() != this)
3162     return die.GetDWARF()->ParseVariableDIE(sc, die, func_low_pc);
3163 
3164   VariableSP var_sp;
3165   if (!die)
3166     return var_sp;
3167 
3168   var_sp = GetDIEToVariable()[die.GetDIE()];
3169   if (var_sp)
3170     return var_sp; // Already been parsed!
3171 
3172   const dw_tag_t tag = die.Tag();
3173   ModuleSP module = GetObjectFile()->GetModule();
3174 
3175   if ((tag == DW_TAG_variable) || (tag == DW_TAG_constant) ||
3176       (tag == DW_TAG_formal_parameter && sc.function)) {
3177     DWARFAttributes attributes;
3178     const size_t num_attributes = die.GetAttributes(attributes);
3179     DWARFDIE spec_die;
3180     if (num_attributes > 0) {
3181       const char *name = NULL;
3182       const char *mangled = NULL;
3183       Declaration decl;
3184       uint32_t i;
3185       DWARFFormValue type_die_form;
3186       DWARFExpression location(die.GetCU());
3187       bool is_external = false;
3188       bool is_artificial = false;
3189       bool location_is_const_value_data = false;
3190       bool has_explicit_location = false;
3191       DWARFFormValue const_value;
3192       Variable::RangeList scope_ranges;
3193       // AccessType accessibility = eAccessNone;
3194 
3195       for (i = 0; i < num_attributes; ++i) {
3196         dw_attr_t attr = attributes.AttributeAtIndex(i);
3197         DWARFFormValue form_value;
3198 
3199         if (attributes.ExtractFormValueAtIndex(i, form_value)) {
3200           switch (attr) {
3201           case DW_AT_decl_file:
3202             decl.SetFile(sc.comp_unit->GetSupportFiles().GetFileSpecAtIndex(
3203                 form_value.Unsigned()));
3204             break;
3205           case DW_AT_decl_line:
3206             decl.SetLine(form_value.Unsigned());
3207             break;
3208           case DW_AT_decl_column:
3209             decl.SetColumn(form_value.Unsigned());
3210             break;
3211           case DW_AT_name:
3212             name = form_value.AsCString();
3213             break;
3214           case DW_AT_linkage_name:
3215           case DW_AT_MIPS_linkage_name:
3216             mangled = form_value.AsCString();
3217             break;
3218           case DW_AT_type:
3219             type_die_form = form_value;
3220             break;
3221           case DW_AT_external:
3222             is_external = form_value.Boolean();
3223             break;
3224           case DW_AT_const_value:
3225             // If we have already found a DW_AT_location attribute, ignore this
3226             // attribute.
3227             if (!has_explicit_location) {
3228               location_is_const_value_data = true;
3229               // The constant value will be either a block, a data value or a
3230               // string.
3231               auto debug_info_data = die.GetData();
3232               if (DWARFFormValue::IsBlockForm(form_value.Form())) {
3233                 // Retrieve the value as a block expression.
3234                 uint32_t block_offset =
3235                     form_value.BlockData() - debug_info_data.GetDataStart();
3236                 uint32_t block_length = form_value.Unsigned();
3237                 location.CopyOpcodeData(module, debug_info_data, block_offset,
3238                                         block_length);
3239               } else if (DWARFFormValue::IsDataForm(form_value.Form())) {
3240                 // Retrieve the value as a data expression.
3241                 DWARFFormValue::FixedFormSizes fixed_form_sizes =
3242                     DWARFFormValue::GetFixedFormSizesForAddressSize(
3243                         attributes.CompileUnitAtIndex(i)->GetAddressByteSize());
3244                 uint32_t data_offset = attributes.DIEOffsetAtIndex(i);
3245                 uint32_t data_length =
3246                     fixed_form_sizes.GetSize(form_value.Form());
3247                 if (data_length == 0) {
3248                   const uint8_t *data_pointer = form_value.BlockData();
3249                   if (data_pointer) {
3250                     form_value.Unsigned();
3251                   } else if (DWARFFormValue::IsDataForm(form_value.Form())) {
3252                     // we need to get the byte size of the type later after we
3253                     // create the variable
3254                     const_value = form_value;
3255                   }
3256                 } else
3257                   location.CopyOpcodeData(module, debug_info_data, data_offset,
3258                                           data_length);
3259               } else {
3260                 // Retrieve the value as a string expression.
3261                 if (form_value.Form() == DW_FORM_strp) {
3262                   DWARFFormValue::FixedFormSizes fixed_form_sizes =
3263                       DWARFFormValue::GetFixedFormSizesForAddressSize(
3264                           attributes.CompileUnitAtIndex(i)
3265                               ->GetAddressByteSize());
3266                   uint32_t data_offset = attributes.DIEOffsetAtIndex(i);
3267                   uint32_t data_length =
3268                       fixed_form_sizes.GetSize(form_value.Form());
3269                   location.CopyOpcodeData(module, debug_info_data, data_offset,
3270                                           data_length);
3271                 } else {
3272                   const char *str = form_value.AsCString();
3273                   uint32_t string_offset =
3274                       str - (const char *)debug_info_data.GetDataStart();
3275                   uint32_t string_length = strlen(str) + 1;
3276                   location.CopyOpcodeData(module, debug_info_data,
3277                                           string_offset, string_length);
3278                 }
3279               }
3280             }
3281             break;
3282           case DW_AT_location: {
3283             location_is_const_value_data = false;
3284             has_explicit_location = true;
3285             if (DWARFFormValue::IsBlockForm(form_value.Form())) {
3286               auto data = die.GetData();
3287 
3288               uint32_t block_offset =
3289                   form_value.BlockData() - data.GetDataStart();
3290               uint32_t block_length = form_value.Unsigned();
3291               location.CopyOpcodeData(module, data, block_offset, block_length);
3292             } else {
3293               const DWARFDataExtractor &debug_loc_data = DebugLocData();
3294               const dw_offset_t debug_loc_offset = form_value.Unsigned();
3295 
3296               size_t loc_list_length = DWARFExpression::LocationListSize(
3297                   die.GetCU(), debug_loc_data, debug_loc_offset);
3298               if (loc_list_length > 0) {
3299                 location.CopyOpcodeData(module, debug_loc_data,
3300                                         debug_loc_offset, loc_list_length);
3301                 assert(func_low_pc != LLDB_INVALID_ADDRESS);
3302                 location.SetLocationListSlide(
3303                     func_low_pc -
3304                     attributes.CompileUnitAtIndex(i)->GetBaseAddress());
3305               }
3306             }
3307           } break;
3308           case DW_AT_specification:
3309             spec_die = GetDIE(DIERef(form_value));
3310             break;
3311           case DW_AT_start_scope: {
3312             if (form_value.Form() == DW_FORM_sec_offset) {
3313               DWARFRangeList dwarf_scope_ranges;
3314               const DWARFDebugRangesBase *debug_ranges = DebugRanges();
3315               debug_ranges->FindRanges(die.GetCU(),
3316                                        form_value.Unsigned(),
3317                                        dwarf_scope_ranges);
3318             } else {
3319               // TODO: Handle the case when DW_AT_start_scope have form
3320               // constant. The
3321               // dwarf spec is a bit ambiguous about what is the expected
3322               // behavior in case the enclosing block have a non coninious
3323               // address range and the DW_AT_start_scope entry have a form
3324               // constant.
3325               GetObjectFile()->GetModule()->ReportWarning(
3326                   "0x%8.8" PRIx64
3327                   ": DW_AT_start_scope has unsupported form type (0x%x)\n",
3328                   die.GetID(), form_value.Form());
3329             }
3330 
3331             scope_ranges.Sort();
3332             scope_ranges.CombineConsecutiveRanges();
3333           } break;
3334           case DW_AT_artificial:
3335             is_artificial = form_value.Boolean();
3336             break;
3337           case DW_AT_accessibility:
3338             break; // accessibility =
3339                    // DW_ACCESS_to_AccessType(form_value.Unsigned()); break;
3340           case DW_AT_declaration:
3341           case DW_AT_description:
3342           case DW_AT_endianity:
3343           case DW_AT_segment:
3344           case DW_AT_visibility:
3345           default:
3346           case DW_AT_abstract_origin:
3347           case DW_AT_sibling:
3348             break;
3349           }
3350         }
3351       }
3352 
3353       const DWARFDIE parent_context_die = GetDeclContextDIEContainingDIE(die);
3354       const dw_tag_t parent_tag = die.GetParent().Tag();
3355       bool is_static_member =
3356           (parent_tag == DW_TAG_compile_unit ||
3357            parent_tag == DW_TAG_partial_unit) &&
3358           (parent_context_die.Tag() == DW_TAG_class_type ||
3359            parent_context_die.Tag() == DW_TAG_structure_type);
3360 
3361       ValueType scope = eValueTypeInvalid;
3362 
3363       const DWARFDIE sc_parent_die = GetParentSymbolContextDIE(die);
3364       SymbolContextScope *symbol_context_scope = NULL;
3365 
3366       bool has_explicit_mangled = mangled != nullptr;
3367       if (!mangled) {
3368         // LLDB relies on the mangled name (DW_TAG_linkage_name or
3369         // DW_AT_MIPS_linkage_name) to generate fully qualified names
3370         // of global variables with commands like "frame var j". For
3371         // example, if j were an int variable holding a value 4 and
3372         // declared in a namespace B which in turn is contained in a
3373         // namespace A, the command "frame var j" returns
3374         //   "(int) A::B::j = 4".
3375         // If the compiler does not emit a linkage name, we should be
3376         // able to generate a fully qualified name from the
3377         // declaration context.
3378         if ((parent_tag == DW_TAG_compile_unit ||
3379              parent_tag == DW_TAG_partial_unit) &&
3380             Language::LanguageIsCPlusPlus(die.GetLanguage())) {
3381           DWARFDeclContext decl_ctx;
3382 
3383           die.GetDWARFDeclContext(decl_ctx);
3384           mangled = decl_ctx.GetQualifiedNameAsConstString().GetCString();
3385         }
3386       }
3387 
3388       if (tag == DW_TAG_formal_parameter)
3389         scope = eValueTypeVariableArgument;
3390       else {
3391         // DWARF doesn't specify if a DW_TAG_variable is a local, global
3392         // or static variable, so we have to do a little digging:
3393         // 1) DW_AT_linkage_name implies static lifetime (but may be missing)
3394         // 2) An empty DW_AT_location is an (optimized-out) static lifetime var.
3395         // 3) DW_AT_location containing a DW_OP_addr implies static lifetime.
3396         // Clang likes to combine small global variables into the same symbol
3397         // with locations like: DW_OP_addr(0x1000), DW_OP_constu(2), DW_OP_plus
3398         // so we need to look through the whole expression.
3399         bool is_static_lifetime =
3400             has_explicit_mangled ||
3401             (has_explicit_location && !location.IsValid());
3402         // Check if the location has a DW_OP_addr with any address value...
3403         lldb::addr_t location_DW_OP_addr = LLDB_INVALID_ADDRESS;
3404         if (!location_is_const_value_data) {
3405           bool op_error = false;
3406           location_DW_OP_addr = location.GetLocation_DW_OP_addr(0, op_error);
3407           if (op_error) {
3408             StreamString strm;
3409             location.DumpLocationForAddress(&strm, eDescriptionLevelFull, 0, 0,
3410                                             NULL);
3411             GetObjectFile()->GetModule()->ReportError(
3412                 "0x%8.8x: %s has an invalid location: %s", die.GetOffset(),
3413                 die.GetTagAsCString(), strm.GetData());
3414           }
3415           if (location_DW_OP_addr != LLDB_INVALID_ADDRESS)
3416             is_static_lifetime = true;
3417         }
3418         SymbolFileDWARFDebugMap *debug_map_symfile = GetDebugMapSymfile();
3419         if (debug_map_symfile)
3420           // Set the module of the expression to the linked module
3421           // instead of the oject file so the relocated address can be
3422           // found there.
3423           location.SetModule(debug_map_symfile->GetObjectFile()->GetModule());
3424 
3425         if (is_static_lifetime) {
3426           if (is_external)
3427             scope = eValueTypeVariableGlobal;
3428           else
3429             scope = eValueTypeVariableStatic;
3430 
3431           if (debug_map_symfile) {
3432             // When leaving the DWARF in the .o files on darwin, when we have a
3433             // global variable that wasn't initialized, the .o file might not
3434             // have allocated a virtual address for the global variable. In
3435             // this case it will have created a symbol for the global variable
3436             // that is undefined/data and external and the value will be the
3437             // byte size of the variable. When we do the address map in
3438             // SymbolFileDWARFDebugMap we rely on having an address, we need to
3439             // do some magic here so we can get the correct address for our
3440             // global variable. The address for all of these entries will be
3441             // zero, and there will be an undefined symbol in this object file,
3442             // and the executable will have a matching symbol with a good
3443             // address. So here we dig up the correct address and replace it in
3444             // the location for the variable, and set the variable's symbol
3445             // context scope to be that of the main executable so the file
3446             // address will resolve correctly.
3447             bool linked_oso_file_addr = false;
3448             if (is_external && location_DW_OP_addr == 0) {
3449               // we have a possible uninitialized extern global
3450               ConstString const_name(mangled ? mangled : name);
3451               ObjectFile *debug_map_objfile =
3452                   debug_map_symfile->GetObjectFile();
3453               if (debug_map_objfile) {
3454                 Symtab *debug_map_symtab = debug_map_objfile->GetSymtab();
3455                 if (debug_map_symtab) {
3456                   Symbol *exe_symbol =
3457                       debug_map_symtab->FindFirstSymbolWithNameAndType(
3458                           const_name, eSymbolTypeData, Symtab::eDebugYes,
3459                           Symtab::eVisibilityExtern);
3460                   if (exe_symbol) {
3461                     if (exe_symbol->ValueIsAddress()) {
3462                       const addr_t exe_file_addr =
3463                           exe_symbol->GetAddressRef().GetFileAddress();
3464                       if (exe_file_addr != LLDB_INVALID_ADDRESS) {
3465                         if (location.Update_DW_OP_addr(exe_file_addr)) {
3466                           linked_oso_file_addr = true;
3467                           symbol_context_scope = exe_symbol;
3468                         }
3469                       }
3470                     }
3471                   }
3472                 }
3473               }
3474             }
3475 
3476             if (!linked_oso_file_addr) {
3477               // The DW_OP_addr is not zero, but it contains a .o file address
3478               // which needs to be linked up correctly.
3479               const lldb::addr_t exe_file_addr =
3480                   debug_map_symfile->LinkOSOFileAddress(this,
3481                                                         location_DW_OP_addr);
3482               if (exe_file_addr != LLDB_INVALID_ADDRESS) {
3483                 // Update the file address for this variable
3484                 location.Update_DW_OP_addr(exe_file_addr);
3485               } else {
3486                 // Variable didn't make it into the final executable
3487                 return var_sp;
3488               }
3489             }
3490           }
3491         } else {
3492           if (location_is_const_value_data)
3493             scope = eValueTypeVariableStatic;
3494           else {
3495             scope = eValueTypeVariableLocal;
3496             if (debug_map_symfile) {
3497               // We need to check for TLS addresses that we need to fixup
3498               if (location.ContainsThreadLocalStorage()) {
3499                 location.LinkThreadLocalStorage(
3500                     debug_map_symfile->GetObjectFile()->GetModule(),
3501                     [this, debug_map_symfile](
3502                         lldb::addr_t unlinked_file_addr) -> lldb::addr_t {
3503                       return debug_map_symfile->LinkOSOFileAddress(
3504                           this, unlinked_file_addr);
3505                     });
3506                 scope = eValueTypeVariableThreadLocal;
3507               }
3508             }
3509           }
3510         }
3511       }
3512 
3513       if (symbol_context_scope == NULL) {
3514         switch (parent_tag) {
3515         case DW_TAG_subprogram:
3516         case DW_TAG_inlined_subroutine:
3517         case DW_TAG_lexical_block:
3518           if (sc.function) {
3519             symbol_context_scope = sc.function->GetBlock(true).FindBlockByID(
3520                 sc_parent_die.GetID());
3521             if (symbol_context_scope == NULL)
3522               symbol_context_scope = sc.function;
3523           }
3524           break;
3525 
3526         default:
3527           symbol_context_scope = sc.comp_unit;
3528           break;
3529         }
3530       }
3531 
3532       if (symbol_context_scope) {
3533         SymbolFileTypeSP type_sp(
3534             new SymbolFileType(*this, DIERef(type_die_form).GetUID(this)));
3535 
3536         if (const_value.Form() && type_sp && type_sp->GetType())
3537           location.CopyOpcodeData(
3538               const_value.Unsigned(),
3539               type_sp->GetType()->GetByteSize().getValueOr(0),
3540               die.GetCU()->GetAddressByteSize());
3541 
3542         var_sp = std::make_shared<Variable>(
3543             die.GetID(), name, mangled, type_sp, scope, symbol_context_scope,
3544             scope_ranges, &decl, location, is_external, is_artificial,
3545             is_static_member);
3546 
3547         var_sp->SetLocationIsConstantValueData(location_is_const_value_data);
3548       } else {
3549         // Not ready to parse this variable yet. It might be a global or static
3550         // variable that is in a function scope and the function in the symbol
3551         // context wasn't filled in yet
3552         return var_sp;
3553       }
3554     }
3555     // Cache var_sp even if NULL (the variable was just a specification or was
3556     // missing vital information to be able to be displayed in the debugger
3557     // (missing location due to optimization, etc)) so we don't re-parse this
3558     // DIE over and over later...
3559     GetDIEToVariable()[die.GetDIE()] = var_sp;
3560     if (spec_die)
3561       GetDIEToVariable()[spec_die.GetDIE()] = var_sp;
3562   }
3563   return var_sp;
3564 }
3565 
3566 DWARFDIE
3567 SymbolFileDWARF::FindBlockContainingSpecification(
3568     const DIERef &func_die_ref, dw_offset_t spec_block_die_offset) {
3569   // Give the concrete function die specified by "func_die_offset", find the
3570   // concrete block whose DW_AT_specification or DW_AT_abstract_origin points
3571   // to "spec_block_die_offset"
3572   return FindBlockContainingSpecification(DebugInfo()->GetDIE(func_die_ref),
3573                                           spec_block_die_offset);
3574 }
3575 
3576 DWARFDIE
3577 SymbolFileDWARF::FindBlockContainingSpecification(
3578     const DWARFDIE &die, dw_offset_t spec_block_die_offset) {
3579   if (die) {
3580     switch (die.Tag()) {
3581     case DW_TAG_subprogram:
3582     case DW_TAG_inlined_subroutine:
3583     case DW_TAG_lexical_block: {
3584       if (die.GetAttributeValueAsReference(
3585               DW_AT_specification, DW_INVALID_OFFSET) == spec_block_die_offset)
3586         return die;
3587 
3588       if (die.GetAttributeValueAsReference(DW_AT_abstract_origin,
3589                                            DW_INVALID_OFFSET) ==
3590           spec_block_die_offset)
3591         return die;
3592     } break;
3593     }
3594 
3595     // Give the concrete function die specified by "func_die_offset", find the
3596     // concrete block whose DW_AT_specification or DW_AT_abstract_origin points
3597     // to "spec_block_die_offset"
3598     for (DWARFDIE child_die = die.GetFirstChild(); child_die;
3599          child_die = child_die.GetSibling()) {
3600       DWARFDIE result_die =
3601           FindBlockContainingSpecification(child_die, spec_block_die_offset);
3602       if (result_die)
3603         return result_die;
3604     }
3605   }
3606 
3607   return DWARFDIE();
3608 }
3609 
3610 size_t SymbolFileDWARF::ParseVariables(const SymbolContext &sc,
3611                                        const DWARFDIE &orig_die,
3612                                        const lldb::addr_t func_low_pc,
3613                                        bool parse_siblings, bool parse_children,
3614                                        VariableList *cc_variable_list) {
3615   if (!orig_die)
3616     return 0;
3617 
3618   VariableListSP variable_list_sp;
3619 
3620   size_t vars_added = 0;
3621   DWARFDIE die = orig_die;
3622   while (die) {
3623     dw_tag_t tag = die.Tag();
3624 
3625     // Check to see if we have already parsed this variable or constant?
3626     VariableSP var_sp = GetDIEToVariable()[die.GetDIE()];
3627     if (var_sp) {
3628       if (cc_variable_list)
3629         cc_variable_list->AddVariableIfUnique(var_sp);
3630     } else {
3631       // We haven't already parsed it, lets do that now.
3632       if ((tag == DW_TAG_variable) || (tag == DW_TAG_constant) ||
3633           (tag == DW_TAG_formal_parameter && sc.function)) {
3634         if (variable_list_sp.get() == NULL) {
3635           DWARFDIE sc_parent_die = GetParentSymbolContextDIE(orig_die);
3636           dw_tag_t parent_tag = sc_parent_die.Tag();
3637           switch (parent_tag) {
3638           case DW_TAG_compile_unit:
3639           case DW_TAG_partial_unit:
3640             if (sc.comp_unit != NULL) {
3641               variable_list_sp = sc.comp_unit->GetVariableList(false);
3642               if (variable_list_sp.get() == NULL) {
3643                 variable_list_sp = std::make_shared<VariableList>();
3644               }
3645             } else {
3646               GetObjectFile()->GetModule()->ReportError(
3647                   "parent 0x%8.8" PRIx64 " %s with no valid compile unit in "
3648                                          "symbol context for 0x%8.8" PRIx64
3649                   " %s.\n",
3650                   sc_parent_die.GetID(), sc_parent_die.GetTagAsCString(),
3651                   orig_die.GetID(), orig_die.GetTagAsCString());
3652             }
3653             break;
3654 
3655           case DW_TAG_subprogram:
3656           case DW_TAG_inlined_subroutine:
3657           case DW_TAG_lexical_block:
3658             if (sc.function != NULL) {
3659               // Check to see if we already have parsed the variables for the
3660               // given scope
3661 
3662               Block *block = sc.function->GetBlock(true).FindBlockByID(
3663                   sc_parent_die.GetID());
3664               if (block == NULL) {
3665                 // This must be a specification or abstract origin with a
3666                 // concrete block counterpart in the current function. We need
3667                 // to find the concrete block so we can correctly add the
3668                 // variable to it
3669                 const DWARFDIE concrete_block_die =
3670                     FindBlockContainingSpecification(
3671                         DIERef(sc.function->GetID(), this),
3672                         sc_parent_die.GetOffset());
3673                 if (concrete_block_die)
3674                   block = sc.function->GetBlock(true).FindBlockByID(
3675                       concrete_block_die.GetID());
3676               }
3677 
3678               if (block != NULL) {
3679                 const bool can_create = false;
3680                 variable_list_sp = block->GetBlockVariableList(can_create);
3681                 if (variable_list_sp.get() == NULL) {
3682                   variable_list_sp = std::make_shared<VariableList>();
3683                   block->SetVariableList(variable_list_sp);
3684                 }
3685               }
3686             }
3687             break;
3688 
3689           default:
3690             GetObjectFile()->GetModule()->ReportError(
3691                 "didn't find appropriate parent DIE for variable list for "
3692                 "0x%8.8" PRIx64 " %s.\n",
3693                 orig_die.GetID(), orig_die.GetTagAsCString());
3694             break;
3695           }
3696         }
3697 
3698         if (variable_list_sp) {
3699           VariableSP var_sp(ParseVariableDIE(sc, die, func_low_pc));
3700           if (var_sp) {
3701             variable_list_sp->AddVariableIfUnique(var_sp);
3702             if (cc_variable_list)
3703               cc_variable_list->AddVariableIfUnique(var_sp);
3704             ++vars_added;
3705           }
3706         }
3707       }
3708     }
3709 
3710     bool skip_children = (sc.function == NULL && tag == DW_TAG_subprogram);
3711 
3712     if (!skip_children && parse_children && die.HasChildren()) {
3713       vars_added += ParseVariables(sc, die.GetFirstChild(), func_low_pc, true,
3714                                    true, cc_variable_list);
3715     }
3716 
3717     if (parse_siblings)
3718       die = die.GetSibling();
3719     else
3720       die.Clear();
3721   }
3722   return vars_added;
3723 }
3724 
3725 /// Collect call graph edges present in a function DIE.
3726 static std::vector<lldb_private::CallEdge>
3727 CollectCallEdges(DWARFDIE function_die) {
3728   // Check if the function has a supported call site-related attribute.
3729   // TODO: In the future it may be worthwhile to support call_all_source_calls.
3730   uint64_t has_call_edges =
3731       function_die.GetAttributeValueAsUnsigned(DW_AT_call_all_calls, 0);
3732   if (!has_call_edges)
3733     return {};
3734 
3735   Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_STEP));
3736   LLDB_LOG(log, "CollectCallEdges: Found call site info in {0}",
3737            function_die.GetPubname());
3738 
3739   // Scan the DIE for TAG_call_site entries.
3740   // TODO: A recursive scan of all blocks in the subprogram is needed in order
3741   // to be DWARF5-compliant. This may need to be done lazily to be performant.
3742   // For now, assume that all entries are nested directly under the subprogram
3743   // (this is the kind of DWARF LLVM produces) and parse them eagerly.
3744   std::vector<CallEdge> call_edges;
3745   for (DWARFDIE child = function_die.GetFirstChild(); child.IsValid();
3746        child = child.GetSibling()) {
3747     if (child.Tag() != DW_TAG_call_site)
3748       continue;
3749 
3750     // Extract DW_AT_call_origin (the call target's DIE).
3751     DWARFDIE call_origin = child.GetReferencedDIE(DW_AT_call_origin);
3752     if (!call_origin.IsValid()) {
3753       LLDB_LOG(log, "CollectCallEdges: Invalid call origin in {0}",
3754                function_die.GetPubname());
3755       continue;
3756     }
3757 
3758     // Extract DW_AT_call_return_pc (the PC the call returns to) if it's
3759     // available. It should only ever be unavailable for tail call edges, in
3760     // which case use LLDB_INVALID_ADDRESS.
3761     addr_t return_pc = child.GetAttributeValueAsAddress(DW_AT_call_return_pc,
3762                                                         LLDB_INVALID_ADDRESS);
3763 
3764     LLDB_LOG(log, "CollectCallEdges: Found call origin: {0} (retn-PC: {1:x})",
3765              call_origin.GetPubname(), return_pc);
3766     call_edges.emplace_back(call_origin.GetMangledName(), return_pc);
3767   }
3768   return call_edges;
3769 }
3770 
3771 std::vector<lldb_private::CallEdge>
3772 SymbolFileDWARF::ParseCallEdgesInFunction(UserID func_id) {
3773   DWARFDIE func_die = GetDIEFromUID(func_id.GetID());
3774   if (func_die.IsValid())
3775     return CollectCallEdges(func_die);
3776   return {};
3777 }
3778 
3779 // PluginInterface protocol
3780 ConstString SymbolFileDWARF::GetPluginName() { return GetPluginNameStatic(); }
3781 
3782 uint32_t SymbolFileDWARF::GetPluginVersion() { return 1; }
3783 
3784 void SymbolFileDWARF::Dump(lldb_private::Stream &s) { m_index->Dump(s); }
3785 
3786 void SymbolFileDWARF::DumpClangAST(Stream &s) {
3787   TypeSystem *ts = GetTypeSystemForLanguage(eLanguageTypeC_plus_plus);
3788   ClangASTContext *clang = llvm::dyn_cast_or_null<ClangASTContext>(ts);
3789   if (!clang)
3790     return;
3791   clang->Dump(s);
3792 }
3793 
3794 SymbolFileDWARFDebugMap *SymbolFileDWARF::GetDebugMapSymfile() {
3795   if (m_debug_map_symfile == NULL && !m_debug_map_module_wp.expired()) {
3796     lldb::ModuleSP module_sp(m_debug_map_module_wp.lock());
3797     if (module_sp) {
3798       SymbolVendor *sym_vendor = module_sp->GetSymbolVendor();
3799       if (sym_vendor)
3800         m_debug_map_symfile =
3801             (SymbolFileDWARFDebugMap *)sym_vendor->GetSymbolFile();
3802     }
3803   }
3804   return m_debug_map_symfile;
3805 }
3806 
3807 DWARFExpression::LocationListFormat
3808 SymbolFileDWARF::GetLocationListFormat() const {
3809   if (m_data_debug_loclists.m_data.GetByteSize() > 0)
3810     return DWARFExpression::LocLists;
3811   return DWARFExpression::RegularLocationList;
3812 }
3813 
3814 SymbolFileDWARFDwp *SymbolFileDWARF::GetDwpSymbolFile() {
3815   llvm::call_once(m_dwp_symfile_once_flag, [this]() {
3816     ModuleSpec module_spec;
3817     module_spec.GetFileSpec() = m_obj_file->GetFileSpec();
3818     module_spec.GetSymbolFileSpec() =
3819         FileSpec(m_obj_file->GetFileSpec().GetPath() + ".dwp");
3820 
3821     FileSpecList search_paths = Target::GetDefaultDebugFileSearchPaths();
3822     FileSpec dwp_filespec =
3823         Symbols::LocateExecutableSymbolFile(module_spec, search_paths);
3824     if (FileSystem::Instance().Exists(dwp_filespec)) {
3825       m_dwp_symfile = SymbolFileDWARFDwp::Create(GetObjectFile()->GetModule(),
3826                                                  dwp_filespec);
3827     }
3828   });
3829   return m_dwp_symfile.get();
3830 }
3831