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