1 //===-- SymbolFileDWARFDebugMap.cpp ----------------------------*- C++ -*-===//
2 //
3 // The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9
10 #include "SymbolFileDWARFDebugMap.h"
11
12 #include "DWARFDebugAranges.h"
13
14 #include "lldb/Core/RangeMap.h"
15 #include "lldb/Core/Module.h"
16 #include "lldb/Core/ModuleList.h"
17 #include "lldb/Core/PluginManager.h"
18 #include "lldb/Core/RegularExpression.h"
19 #include "lldb/Core/Section.h"
20
21 //#define DEBUG_OSO_DMAP // DO NOT CHECKIN WITH THIS NOT COMMENTED OUT
22 #if defined(DEBUG_OSO_DMAP)
23 #include "lldb/Core/StreamFile.h"
24 #endif
25 #include "lldb/Core/Timer.h"
26
27 #include "lldb/Symbol/ClangExternalASTSourceCallbacks.h"
28 #include "lldb/Symbol/CompileUnit.h"
29 #include "lldb/Symbol/LineTable.h"
30 #include "lldb/Symbol/ObjectFile.h"
31 #include "lldb/Symbol/SymbolVendor.h"
32 #include "lldb/Symbol/VariableList.h"
33
34 #include "LogChannelDWARF.h"
35 #include "SymbolFileDWARF.h"
36
37 using namespace lldb;
38 using namespace lldb_private;
39
40 // Subclass lldb_private::Module so we can intercept the "Module::GetObjectFile()"
41 // (so we can fixup the object file sections) and also for "Module::GetSymbolVendor()"
42 // (so we can fixup the symbol file id.
43
44
45
46
47 const SymbolFileDWARFDebugMap::FileRangeMap &
GetFileRangeMap(SymbolFileDWARFDebugMap * exe_symfile)48 SymbolFileDWARFDebugMap::CompileUnitInfo::GetFileRangeMap(SymbolFileDWARFDebugMap *exe_symfile)
49 {
50 if (file_range_map_valid)
51 return file_range_map;
52
53 file_range_map_valid = true;
54
55 Module *oso_module = exe_symfile->GetModuleByCompUnitInfo (this);
56 if (!oso_module)
57 return file_range_map;
58
59 ObjectFile *oso_objfile = oso_module->GetObjectFile();
60 if (!oso_objfile)
61 return file_range_map;
62
63 Log *log (LogChannelDWARF::GetLogIfAll(DWARF_LOG_DEBUG_MAP));
64 if (log)
65 {
66 ConstString object_name (oso_module->GetObjectName());
67 log->Printf("%p: SymbolFileDWARFDebugMap::CompileUnitInfo::GetFileRangeMap ('%s')",
68 static_cast<void*>(this),
69 oso_module->GetSpecificationDescription().c_str());
70 }
71
72 std::vector<SymbolFileDWARFDebugMap::CompileUnitInfo *> cu_infos;
73 if (exe_symfile->GetCompUnitInfosForModule(oso_module, cu_infos))
74 {
75 for (auto comp_unit_info : cu_infos)
76 {
77 Symtab *exe_symtab = exe_symfile->GetObjectFile()->GetSymtab();
78 ModuleSP oso_module_sp (oso_objfile->GetModule());
79 Symtab *oso_symtab = oso_objfile->GetSymtab();
80
81 ///const uint32_t fun_resolve_flags = SymbolContext::Module | eSymbolContextCompUnit | eSymbolContextFunction;
82 //SectionList *oso_sections = oso_objfile->Sections();
83 // Now we need to make sections that map from zero based object
84 // file addresses to where things ended up in the main executable.
85
86 assert (comp_unit_info->first_symbol_index != UINT32_MAX);
87 // End index is one past the last valid symbol index
88 const uint32_t oso_end_idx = comp_unit_info->last_symbol_index + 1;
89 for (uint32_t idx = comp_unit_info->first_symbol_index + 2; // Skip the N_SO and N_OSO
90 idx < oso_end_idx;
91 ++idx)
92 {
93 Symbol *exe_symbol = exe_symtab->SymbolAtIndex(idx);
94 if (exe_symbol)
95 {
96 if (exe_symbol->IsDebug() == false)
97 continue;
98
99 switch (exe_symbol->GetType())
100 {
101 default:
102 break;
103
104 case eSymbolTypeCode:
105 {
106 // For each N_FUN, or function that we run into in the debug map
107 // we make a new section that we add to the sections found in the
108 // .o file. This new section has the file address set to what the
109 // addresses are in the .o file, and the load address is adjusted
110 // to match where it ended up in the final executable! We do this
111 // before we parse any dwarf info so that when it goes get parsed
112 // all section/offset addresses that get registered will resolve
113 // correctly to the new addresses in the main executable.
114
115 // First we find the original symbol in the .o file's symbol table
116 Symbol *oso_fun_symbol = oso_symtab->FindFirstSymbolWithNameAndType (exe_symbol->GetMangled().GetName(lldb::eLanguageTypeUnknown, Mangled::ePreferMangled),
117 eSymbolTypeCode,
118 Symtab::eDebugNo,
119 Symtab::eVisibilityAny);
120 if (oso_fun_symbol)
121 {
122 // Add the inverse OSO file address to debug map entry mapping
123 exe_symfile->AddOSOFileRange (this,
124 exe_symbol->GetAddressRef().GetFileAddress(),
125 oso_fun_symbol->GetAddressRef().GetFileAddress(),
126 std::min<addr_t>(exe_symbol->GetByteSize(), oso_fun_symbol->GetByteSize()));
127
128 }
129 }
130 break;
131
132 case eSymbolTypeData:
133 {
134 // For each N_GSYM we remap the address for the global by making
135 // a new section that we add to the sections found in the .o file.
136 // This new section has the file address set to what the
137 // addresses are in the .o file, and the load address is adjusted
138 // to match where it ended up in the final executable! We do this
139 // before we parse any dwarf info so that when it goes get parsed
140 // all section/offset addresses that get registered will resolve
141 // correctly to the new addresses in the main executable. We
142 // initially set the section size to be 1 byte, but will need to
143 // fix up these addresses further after all globals have been
144 // parsed to span the gaps, or we can find the global variable
145 // sizes from the DWARF info as we are parsing.
146
147 // Next we find the non-stab entry that corresponds to the N_GSYM in the .o file
148 Symbol *oso_gsym_symbol = oso_symtab->FindFirstSymbolWithNameAndType (exe_symbol->GetMangled().GetName(lldb::eLanguageTypeUnknown, Mangled::ePreferMangled),
149 eSymbolTypeData,
150 Symtab::eDebugNo,
151 Symtab::eVisibilityAny);
152 if (exe_symbol && oso_gsym_symbol &&
153 exe_symbol->ValueIsAddress() &&
154 oso_gsym_symbol->ValueIsAddress())
155 {
156 // Add the inverse OSO file address to debug map entry mapping
157 exe_symfile->AddOSOFileRange (this,
158 exe_symbol->GetAddressRef().GetFileAddress(),
159 oso_gsym_symbol->GetAddressRef().GetFileAddress(),
160 std::min<addr_t>(exe_symbol->GetByteSize(), oso_gsym_symbol->GetByteSize()));
161 }
162 }
163 break;
164 }
165 }
166 }
167
168 exe_symfile->FinalizeOSOFileRanges (this);
169 // We don't need the symbols anymore for the .o files
170 oso_objfile->ClearSymtab();
171 }
172 }
173 return file_range_map;
174 }
175
176
177 class DebugMapModule : public Module
178 {
179 public:
DebugMapModule(const ModuleSP & exe_module_sp,uint32_t cu_idx,const FileSpec & file_spec,const ArchSpec & arch,const ConstString * object_name,off_t object_offset,const TimeValue * object_mod_time_ptr)180 DebugMapModule (const ModuleSP &exe_module_sp,
181 uint32_t cu_idx,
182 const FileSpec& file_spec,
183 const ArchSpec& arch,
184 const ConstString *object_name,
185 off_t object_offset,
186 const TimeValue *object_mod_time_ptr) :
187 Module (file_spec, arch, object_name, object_offset, object_mod_time_ptr),
188 m_exe_module_wp (exe_module_sp),
189 m_cu_idx (cu_idx)
190 {
191 }
192
193 virtual
~DebugMapModule()194 ~DebugMapModule ()
195 {
196 }
197
198
199 virtual SymbolVendor*
GetSymbolVendor(bool can_create=true,lldb_private::Stream * feedback_strm=NULL)200 GetSymbolVendor(bool can_create = true, lldb_private::Stream *feedback_strm = NULL)
201 {
202 // Scope for locker
203 if (m_symfile_ap.get() || can_create == false)
204 return m_symfile_ap.get();
205
206 ModuleSP exe_module_sp (m_exe_module_wp.lock());
207 if (exe_module_sp)
208 {
209 // Now get the object file outside of a locking scope
210 ObjectFile *oso_objfile = GetObjectFile ();
211 if (oso_objfile)
212 {
213 Mutex::Locker locker (m_mutex);
214 SymbolVendor* symbol_vendor = Module::GetSymbolVendor(can_create, feedback_strm);
215 if (symbol_vendor)
216 {
217 // Set a pointer to this class to set our OSO DWARF file know
218 // that the DWARF is being used along with a debug map and that
219 // it will have the remapped sections that we do below.
220 SymbolFileDWARF *oso_symfile = SymbolFileDWARFDebugMap::GetSymbolFileAsSymbolFileDWARF(symbol_vendor->GetSymbolFile());
221
222 if (!oso_symfile)
223 return NULL;
224
225 ObjectFile *exe_objfile = exe_module_sp->GetObjectFile();
226 SymbolVendor *exe_sym_vendor = exe_module_sp->GetSymbolVendor();
227
228 if (exe_objfile && exe_sym_vendor)
229 {
230 oso_symfile->SetDebugMapModule(exe_module_sp);
231 // Set the ID of the symbol file DWARF to the index of the OSO
232 // shifted left by 32 bits to provide a unique prefix for any
233 // UserID's that get created in the symbol file.
234 oso_symfile->SetID (((uint64_t)m_cu_idx + 1ull) << 32ull);
235 }
236 return symbol_vendor;
237 }
238 }
239 }
240 return NULL;
241 }
242
243 protected:
244 ModuleWP m_exe_module_wp;
245 const uint32_t m_cu_idx;
246 };
247
248 void
Initialize()249 SymbolFileDWARFDebugMap::Initialize()
250 {
251 PluginManager::RegisterPlugin (GetPluginNameStatic(),
252 GetPluginDescriptionStatic(),
253 CreateInstance);
254 }
255
256 void
Terminate()257 SymbolFileDWARFDebugMap::Terminate()
258 {
259 PluginManager::UnregisterPlugin (CreateInstance);
260 }
261
262
263 lldb_private::ConstString
GetPluginNameStatic()264 SymbolFileDWARFDebugMap::GetPluginNameStatic()
265 {
266 static ConstString g_name("dwarf-debugmap");
267 return g_name;
268 }
269
270 const char *
GetPluginDescriptionStatic()271 SymbolFileDWARFDebugMap::GetPluginDescriptionStatic()
272 {
273 return "DWARF and DWARF3 debug symbol file reader (debug map).";
274 }
275
276 SymbolFile*
CreateInstance(ObjectFile * obj_file)277 SymbolFileDWARFDebugMap::CreateInstance (ObjectFile* obj_file)
278 {
279 return new SymbolFileDWARFDebugMap (obj_file);
280 }
281
282
SymbolFileDWARFDebugMap(ObjectFile * ofile)283 SymbolFileDWARFDebugMap::SymbolFileDWARFDebugMap (ObjectFile* ofile) :
284 SymbolFile(ofile),
285 m_flags(),
286 m_compile_unit_infos(),
287 m_func_indexes(),
288 m_glob_indexes(),
289 m_supports_DW_AT_APPLE_objc_complete_type (eLazyBoolCalculate)
290 {
291 }
292
293
~SymbolFileDWARFDebugMap()294 SymbolFileDWARFDebugMap::~SymbolFileDWARFDebugMap()
295 {
296 }
297
298 void
InitializeObject()299 SymbolFileDWARFDebugMap::InitializeObject()
300 {
301 // Install our external AST source callbacks so we can complete Clang types.
302 llvm::IntrusiveRefCntPtr<clang::ExternalASTSource> ast_source_ap (
303 new ClangExternalASTSourceCallbacks (SymbolFileDWARFDebugMap::CompleteTagDecl,
304 SymbolFileDWARFDebugMap::CompleteObjCInterfaceDecl,
305 NULL,
306 SymbolFileDWARFDebugMap::LayoutRecordType,
307 this));
308
309 GetClangASTContext().SetExternalSource (ast_source_ap);
310 }
311
312 void
InitOSO()313 SymbolFileDWARFDebugMap::InitOSO()
314 {
315 if (m_flags.test(kHaveInitializedOSOs))
316 return;
317
318 m_flags.set(kHaveInitializedOSOs);
319
320 // If the object file has been stripped, there is no sense in looking further
321 // as all of the debug symbols for the debug map will not be available
322 if (m_obj_file->IsStripped())
323 return;
324
325 // Also make sure the file type is some sort of executable. Core files, debug
326 // info files (dSYM), object files (.o files), and stub libraries all can
327 switch (m_obj_file->GetType())
328 {
329 case ObjectFile::eTypeInvalid:
330 case ObjectFile::eTypeCoreFile:
331 case ObjectFile::eTypeDebugInfo:
332 case ObjectFile::eTypeObjectFile:
333 case ObjectFile::eTypeStubLibrary:
334 case ObjectFile::eTypeUnknown:
335 case ObjectFile::eTypeJIT:
336 return;
337
338 case ObjectFile::eTypeExecutable:
339 case ObjectFile::eTypeDynamicLinker:
340 case ObjectFile::eTypeSharedLibrary:
341 break;
342 }
343
344 // In order to get the abilities of this plug-in, we look at the list of
345 // N_OSO entries (object files) from the symbol table and make sure that
346 // these files exist and also contain valid DWARF. If we get any of that
347 // then we return the abilities of the first N_OSO's DWARF.
348
349 Symtab* symtab = m_obj_file->GetSymtab();
350 if (symtab)
351 {
352 Log *log (LogChannelDWARF::GetLogIfAll(DWARF_LOG_DEBUG_MAP));
353
354 std::vector<uint32_t> oso_indexes;
355 // When a mach-o symbol is encoded, the n_type field is encoded in bits
356 // 23:16, and the n_desc field is encoded in bits 15:0.
357 //
358 // To find all N_OSO entries that are part of the DWARF + debug map
359 // we find only object file symbols with the flags value as follows:
360 // bits 23:16 == 0x66 (N_OSO)
361 // bits 15: 0 == 0x0001 (specifies this is a debug map object file)
362 const uint32_t k_oso_symbol_flags_value = 0x660001u;
363
364 const uint32_t oso_index_count = symtab->AppendSymbolIndexesWithTypeAndFlagsValue(eSymbolTypeObjectFile, k_oso_symbol_flags_value, oso_indexes);
365
366 if (oso_index_count > 0)
367 {
368 symtab->AppendSymbolIndexesWithType (eSymbolTypeCode, Symtab::eDebugYes, Symtab::eVisibilityAny, m_func_indexes);
369 symtab->AppendSymbolIndexesWithType (eSymbolTypeData, Symtab::eDebugYes, Symtab::eVisibilityAny, m_glob_indexes);
370
371 symtab->SortSymbolIndexesByValue(m_func_indexes, true);
372 symtab->SortSymbolIndexesByValue(m_glob_indexes, true);
373
374 for (uint32_t sym_idx : m_func_indexes)
375 {
376 const Symbol *symbol = symtab->SymbolAtIndex(sym_idx);
377 lldb::addr_t file_addr = symbol->GetAddressRef().GetFileAddress();
378 lldb::addr_t byte_size = symbol->GetByteSize();
379 DebugMap::Entry debug_map_entry(file_addr, byte_size, OSOEntry(sym_idx, LLDB_INVALID_ADDRESS));
380 m_debug_map.Append(debug_map_entry);
381 }
382 for (uint32_t sym_idx : m_glob_indexes)
383 {
384 const Symbol *symbol = symtab->SymbolAtIndex(sym_idx);
385 lldb::addr_t file_addr = symbol->GetAddressRef().GetFileAddress();
386 lldb::addr_t byte_size = symbol->GetByteSize();
387 DebugMap::Entry debug_map_entry(file_addr, byte_size, OSOEntry(sym_idx, LLDB_INVALID_ADDRESS));
388 m_debug_map.Append(debug_map_entry);
389 }
390 m_debug_map.Sort();
391
392 m_compile_unit_infos.resize(oso_index_count);
393
394 for (uint32_t i=0; i<oso_index_count; ++i)
395 {
396 const uint32_t so_idx = oso_indexes[i] - 1;
397 const uint32_t oso_idx = oso_indexes[i];
398 const Symbol *so_symbol = symtab->SymbolAtIndex(so_idx);
399 const Symbol *oso_symbol = symtab->SymbolAtIndex(oso_idx);
400 if (so_symbol &&
401 oso_symbol &&
402 so_symbol->GetType() == eSymbolTypeSourceFile &&
403 oso_symbol->GetType() == eSymbolTypeObjectFile)
404 {
405 m_compile_unit_infos[i].so_file.SetFile(so_symbol->GetName().AsCString(), false);
406 m_compile_unit_infos[i].oso_path = oso_symbol->GetName();
407 TimeValue oso_mod_time;
408 oso_mod_time.OffsetWithSeconds(oso_symbol->GetIntegerValue(0));
409 m_compile_unit_infos[i].oso_mod_time = oso_mod_time;
410 uint32_t sibling_idx = so_symbol->GetSiblingIndex();
411 // The sibling index can't be less that or equal to the current index "i"
412 if (sibling_idx == UINT32_MAX)
413 {
414 m_obj_file->GetModule()->ReportError ("N_SO in symbol with UID %u has invalid sibling in debug map, please file a bug and attach the binary listed in this error", so_symbol->GetID());
415 }
416 else
417 {
418 const Symbol* last_symbol = symtab->SymbolAtIndex (sibling_idx - 1);
419 m_compile_unit_infos[i].first_symbol_index = so_idx;
420 m_compile_unit_infos[i].last_symbol_index = sibling_idx - 1;
421 m_compile_unit_infos[i].first_symbol_id = so_symbol->GetID();
422 m_compile_unit_infos[i].last_symbol_id = last_symbol->GetID();
423
424 if (log)
425 log->Printf("Initialized OSO 0x%8.8x: file=%s", i, oso_symbol->GetName().GetCString());
426 }
427 }
428 else
429 {
430 if (oso_symbol == NULL)
431 m_obj_file->GetModule()->ReportError ("N_OSO symbol[%u] can't be found, please file a bug and attach the binary listed in this error", oso_idx);
432 else if (so_symbol == NULL)
433 m_obj_file->GetModule()->ReportError ("N_SO not found for N_OSO symbol[%u], please file a bug and attach the binary listed in this error", oso_idx);
434 else if (so_symbol->GetType() != eSymbolTypeSourceFile)
435 m_obj_file->GetModule()->ReportError ("N_SO has incorrect symbol type (%u) for N_OSO symbol[%u], please file a bug and attach the binary listed in this error", so_symbol->GetType(), oso_idx);
436 else if (oso_symbol->GetType() != eSymbolTypeSourceFile)
437 m_obj_file->GetModule()->ReportError ("N_OSO has incorrect symbol type (%u) for N_OSO symbol[%u], please file a bug and attach the binary listed in this error", oso_symbol->GetType(), oso_idx);
438 }
439 }
440 }
441 }
442 }
443
444 Module *
GetModuleByOSOIndex(uint32_t oso_idx)445 SymbolFileDWARFDebugMap::GetModuleByOSOIndex (uint32_t oso_idx)
446 {
447 const uint32_t cu_count = GetNumCompileUnits();
448 if (oso_idx < cu_count)
449 return GetModuleByCompUnitInfo (&m_compile_unit_infos[oso_idx]);
450 return NULL;
451 }
452
453 Module *
GetModuleByCompUnitInfo(CompileUnitInfo * comp_unit_info)454 SymbolFileDWARFDebugMap::GetModuleByCompUnitInfo (CompileUnitInfo *comp_unit_info)
455 {
456 if (!comp_unit_info->oso_sp)
457 {
458 auto pos = m_oso_map.find (comp_unit_info->oso_path);
459 if (pos != m_oso_map.end())
460 {
461 comp_unit_info->oso_sp = pos->second;
462 }
463 else
464 {
465 ObjectFile *obj_file = GetObjectFile();
466 comp_unit_info->oso_sp.reset (new OSOInfo());
467 m_oso_map[comp_unit_info->oso_path] = comp_unit_info->oso_sp;
468 const char *oso_path = comp_unit_info->oso_path.GetCString();
469 FileSpec oso_file (oso_path, false);
470 ConstString oso_object;
471 if (oso_file.Exists())
472 {
473 TimeValue oso_mod_time (oso_file.GetModificationTime());
474 if (oso_mod_time != comp_unit_info->oso_mod_time)
475 {
476 obj_file->GetModule()->ReportError ("debug map object file '%s' has changed (actual time is 0x%" PRIx64 ", debug map time is 0x%" PRIx64 ") since this executable was linked, file will be ignored",
477 oso_file.GetPath().c_str(),
478 oso_mod_time.GetAsSecondsSinceJan1_1970(),
479 comp_unit_info->oso_mod_time.GetAsSecondsSinceJan1_1970());
480 return NULL;
481 }
482
483 }
484 else
485 {
486 const bool must_exist = true;
487
488 if (!ObjectFile::SplitArchivePathWithObject (oso_path,
489 oso_file,
490 oso_object,
491 must_exist))
492 {
493 return NULL;
494 }
495 }
496 // Always create a new module for .o files. Why? Because we
497 // use the debug map, to add new sections to each .o file and
498 // even though a .o file might not have changed, the sections
499 // that get added to the .o file can change.
500 ArchSpec oso_arch;
501 // Only adopt the architecture from the module (not the vendor or OS)
502 // since .o files for "i386-apple-ios" will historically show up as "i386-apple-macosx"
503 // due to the lack of a LC_VERSION_MIN_MACOSX or LC_VERSION_MIN_IPHONEOS
504 // load command...
505 oso_arch.SetTriple(m_obj_file->GetModule()->GetArchitecture().GetTriple().getArchName().str().c_str());
506 comp_unit_info->oso_sp->module_sp.reset (new DebugMapModule (obj_file->GetModule(),
507 GetCompUnitInfoIndex(comp_unit_info),
508 oso_file,
509 oso_arch,
510 oso_object ? &oso_object : NULL,
511 0,
512 oso_object ? &comp_unit_info->oso_mod_time : NULL));
513 }
514 }
515 if (comp_unit_info->oso_sp)
516 return comp_unit_info->oso_sp->module_sp.get();
517 return NULL;
518 }
519
520
521 bool
GetFileSpecForSO(uint32_t oso_idx,FileSpec & file_spec)522 SymbolFileDWARFDebugMap::GetFileSpecForSO (uint32_t oso_idx, FileSpec &file_spec)
523 {
524 if (oso_idx < m_compile_unit_infos.size())
525 {
526 if (m_compile_unit_infos[oso_idx].so_file)
527 {
528 file_spec = m_compile_unit_infos[oso_idx].so_file;
529 return true;
530 }
531 }
532 return false;
533 }
534
535
536
537 ObjectFile *
GetObjectFileByOSOIndex(uint32_t oso_idx)538 SymbolFileDWARFDebugMap::GetObjectFileByOSOIndex (uint32_t oso_idx)
539 {
540 Module *oso_module = GetModuleByOSOIndex (oso_idx);
541 if (oso_module)
542 return oso_module->GetObjectFile();
543 return NULL;
544 }
545
546 SymbolFileDWARF *
GetSymbolFile(const SymbolContext & sc)547 SymbolFileDWARFDebugMap::GetSymbolFile (const SymbolContext& sc)
548 {
549 CompileUnitInfo *comp_unit_info = GetCompUnitInfo (sc);
550 if (comp_unit_info)
551 return GetSymbolFileByCompUnitInfo (comp_unit_info);
552 return NULL;
553 }
554
555 ObjectFile *
GetObjectFileByCompUnitInfo(CompileUnitInfo * comp_unit_info)556 SymbolFileDWARFDebugMap::GetObjectFileByCompUnitInfo (CompileUnitInfo *comp_unit_info)
557 {
558 Module *oso_module = GetModuleByCompUnitInfo (comp_unit_info);
559 if (oso_module)
560 return oso_module->GetObjectFile();
561 return NULL;
562 }
563
564
565 uint32_t
GetCompUnitInfoIndex(const CompileUnitInfo * comp_unit_info)566 SymbolFileDWARFDebugMap::GetCompUnitInfoIndex (const CompileUnitInfo *comp_unit_info)
567 {
568 if (!m_compile_unit_infos.empty())
569 {
570 const CompileUnitInfo *first_comp_unit_info = &m_compile_unit_infos.front();
571 const CompileUnitInfo *last_comp_unit_info = &m_compile_unit_infos.back();
572 if (first_comp_unit_info <= comp_unit_info && comp_unit_info <= last_comp_unit_info)
573 return comp_unit_info - first_comp_unit_info;
574 }
575 return UINT32_MAX;
576 }
577
578 SymbolFileDWARF *
GetSymbolFileByOSOIndex(uint32_t oso_idx)579 SymbolFileDWARFDebugMap::GetSymbolFileByOSOIndex (uint32_t oso_idx)
580 {
581 if (oso_idx < m_compile_unit_infos.size())
582 return GetSymbolFileByCompUnitInfo (&m_compile_unit_infos[oso_idx]);
583 return NULL;
584 }
585
586 SymbolFileDWARF *
GetSymbolFileAsSymbolFileDWARF(SymbolFile * sym_file)587 SymbolFileDWARFDebugMap::GetSymbolFileAsSymbolFileDWARF (SymbolFile *sym_file)
588 {
589 if (sym_file && sym_file->GetPluginName() == SymbolFileDWARF::GetPluginNameStatic())
590 return (SymbolFileDWARF *)sym_file;
591 return NULL;
592 }
593
594 SymbolFileDWARF *
GetSymbolFileByCompUnitInfo(CompileUnitInfo * comp_unit_info)595 SymbolFileDWARFDebugMap::GetSymbolFileByCompUnitInfo (CompileUnitInfo *comp_unit_info)
596 {
597 Module *oso_module = GetModuleByCompUnitInfo (comp_unit_info);
598 if (oso_module)
599 {
600 SymbolVendor *sym_vendor = oso_module->GetSymbolVendor();
601 if (sym_vendor)
602 return GetSymbolFileAsSymbolFileDWARF (sym_vendor->GetSymbolFile());
603 }
604 return NULL;
605 }
606
607 uint32_t
CalculateAbilities()608 SymbolFileDWARFDebugMap::CalculateAbilities ()
609 {
610 // In order to get the abilities of this plug-in, we look at the list of
611 // N_OSO entries (object files) from the symbol table and make sure that
612 // these files exist and also contain valid DWARF. If we get any of that
613 // then we return the abilities of the first N_OSO's DWARF.
614
615 const uint32_t oso_index_count = GetNumCompileUnits();
616 if (oso_index_count > 0)
617 {
618 InitOSO();
619 if (!m_compile_unit_infos.empty())
620 {
621 return SymbolFile::CompileUnits |
622 SymbolFile::Functions |
623 SymbolFile::Blocks |
624 SymbolFile::GlobalVariables |
625 SymbolFile::LocalVariables |
626 SymbolFile::VariableTypes |
627 SymbolFile::LineTables ;
628 }
629 }
630 return 0;
631 }
632
633 uint32_t
GetNumCompileUnits()634 SymbolFileDWARFDebugMap::GetNumCompileUnits()
635 {
636 InitOSO ();
637 return m_compile_unit_infos.size();
638 }
639
640
641 CompUnitSP
ParseCompileUnitAtIndex(uint32_t cu_idx)642 SymbolFileDWARFDebugMap::ParseCompileUnitAtIndex(uint32_t cu_idx)
643 {
644 CompUnitSP comp_unit_sp;
645 const uint32_t cu_count = GetNumCompileUnits();
646
647 if (cu_idx < cu_count)
648 {
649 Module *oso_module = GetModuleByCompUnitInfo (&m_compile_unit_infos[cu_idx]);
650 if (oso_module)
651 {
652 FileSpec so_file_spec;
653 if (GetFileSpecForSO (cu_idx, so_file_spec))
654 {
655 // User zero as the ID to match the compile unit at offset
656 // zero in each .o file since each .o file can only have
657 // one compile unit for now.
658 lldb::user_id_t cu_id = 0;
659 m_compile_unit_infos[cu_idx].compile_unit_sp.reset(new CompileUnit (m_obj_file->GetModule(),
660 NULL,
661 so_file_spec,
662 cu_id,
663 eLanguageTypeUnknown));
664
665 if (m_compile_unit_infos[cu_idx].compile_unit_sp)
666 {
667 // Let our symbol vendor know about this compile unit
668 m_obj_file->GetModule()->GetSymbolVendor()->SetCompileUnitAtIndex (cu_idx, m_compile_unit_infos[cu_idx].compile_unit_sp);
669 }
670 }
671 }
672 comp_unit_sp = m_compile_unit_infos[cu_idx].compile_unit_sp;
673 }
674
675 return comp_unit_sp;
676 }
677
678 SymbolFileDWARFDebugMap::CompileUnitInfo *
GetCompUnitInfo(const SymbolContext & sc)679 SymbolFileDWARFDebugMap::GetCompUnitInfo (const SymbolContext& sc)
680 {
681 const uint32_t cu_count = GetNumCompileUnits();
682 for (uint32_t i=0; i<cu_count; ++i)
683 {
684 if (sc.comp_unit == m_compile_unit_infos[i].compile_unit_sp.get())
685 return &m_compile_unit_infos[i];
686 }
687 return NULL;
688 }
689
690
691 size_t
GetCompUnitInfosForModule(const lldb_private::Module * module,std::vector<CompileUnitInfo * > & cu_infos)692 SymbolFileDWARFDebugMap::GetCompUnitInfosForModule (const lldb_private::Module *module, std::vector<CompileUnitInfo *>& cu_infos)
693 {
694 const uint32_t cu_count = GetNumCompileUnits();
695 for (uint32_t i=0; i<cu_count; ++i)
696 {
697 if (module == GetModuleByCompUnitInfo (&m_compile_unit_infos[i]))
698 cu_infos.push_back (&m_compile_unit_infos[i]);
699 }
700 return cu_infos.size();
701 }
702
703 lldb::LanguageType
ParseCompileUnitLanguage(const SymbolContext & sc)704 SymbolFileDWARFDebugMap::ParseCompileUnitLanguage (const SymbolContext& sc)
705 {
706 SymbolFileDWARF *oso_dwarf = GetSymbolFile (sc);
707 if (oso_dwarf)
708 return oso_dwarf->ParseCompileUnitLanguage (sc);
709 return eLanguageTypeUnknown;
710 }
711
712 size_t
ParseCompileUnitFunctions(const SymbolContext & sc)713 SymbolFileDWARFDebugMap::ParseCompileUnitFunctions (const SymbolContext& sc)
714 {
715 SymbolFileDWARF *oso_dwarf = GetSymbolFile (sc);
716 if (oso_dwarf)
717 return oso_dwarf->ParseCompileUnitFunctions (sc);
718 return 0;
719 }
720
721 bool
ParseCompileUnitLineTable(const SymbolContext & sc)722 SymbolFileDWARFDebugMap::ParseCompileUnitLineTable (const SymbolContext& sc)
723 {
724 SymbolFileDWARF *oso_dwarf = GetSymbolFile (sc);
725 if (oso_dwarf)
726 return oso_dwarf->ParseCompileUnitLineTable (sc);
727 return false;
728 }
729
730 bool
ParseCompileUnitSupportFiles(const SymbolContext & sc,FileSpecList & support_files)731 SymbolFileDWARFDebugMap::ParseCompileUnitSupportFiles (const SymbolContext& sc, FileSpecList &support_files)
732 {
733 SymbolFileDWARF *oso_dwarf = GetSymbolFile (sc);
734 if (oso_dwarf)
735 return oso_dwarf->ParseCompileUnitSupportFiles (sc, support_files);
736 return false;
737 }
738
739 bool
ParseImportedModules(const SymbolContext & sc,std::vector<ConstString> & imported_modules)740 SymbolFileDWARFDebugMap::ParseImportedModules (const SymbolContext &sc, std::vector<ConstString> &imported_modules)
741 {
742 SymbolFileDWARF *oso_dwarf = GetSymbolFile (sc);
743 if (oso_dwarf)
744 return oso_dwarf->ParseImportedModules(sc, imported_modules);
745 return false;
746 }
747
748 size_t
ParseFunctionBlocks(const SymbolContext & sc)749 SymbolFileDWARFDebugMap::ParseFunctionBlocks (const SymbolContext& sc)
750 {
751 SymbolFileDWARF *oso_dwarf = GetSymbolFile (sc);
752 if (oso_dwarf)
753 return oso_dwarf->ParseFunctionBlocks (sc);
754 return 0;
755 }
756
757
758 size_t
ParseTypes(const SymbolContext & sc)759 SymbolFileDWARFDebugMap::ParseTypes (const SymbolContext& sc)
760 {
761 SymbolFileDWARF *oso_dwarf = GetSymbolFile (sc);
762 if (oso_dwarf)
763 return oso_dwarf->ParseTypes (sc);
764 return 0;
765 }
766
767
768 size_t
ParseVariablesForContext(const SymbolContext & sc)769 SymbolFileDWARFDebugMap::ParseVariablesForContext (const SymbolContext& sc)
770 {
771 SymbolFileDWARF *oso_dwarf = GetSymbolFile (sc);
772 if (oso_dwarf)
773 return oso_dwarf->ParseVariablesForContext (sc);
774 return 0;
775 }
776
777
778
779 Type*
ResolveTypeUID(lldb::user_id_t type_uid)780 SymbolFileDWARFDebugMap::ResolveTypeUID(lldb::user_id_t type_uid)
781 {
782 const uint64_t oso_idx = GetOSOIndexFromUserID (type_uid);
783 SymbolFileDWARF *oso_dwarf = GetSymbolFileByOSOIndex (oso_idx);
784 if (oso_dwarf)
785 return oso_dwarf->ResolveTypeUID (type_uid);
786 return NULL;
787 }
788
789 bool
ResolveClangOpaqueTypeDefinition(ClangASTType & clang_type)790 SymbolFileDWARFDebugMap::ResolveClangOpaqueTypeDefinition (ClangASTType& clang_type)
791 {
792 // We have a struct/union/class/enum that needs to be fully resolved.
793 return false;
794 }
795
796 uint32_t
ResolveSymbolContext(const Address & exe_so_addr,uint32_t resolve_scope,SymbolContext & sc)797 SymbolFileDWARFDebugMap::ResolveSymbolContext (const Address& exe_so_addr, uint32_t resolve_scope, SymbolContext& sc)
798 {
799 uint32_t resolved_flags = 0;
800 Symtab* symtab = m_obj_file->GetSymtab();
801 if (symtab)
802 {
803 const addr_t exe_file_addr = exe_so_addr.GetFileAddress();
804
805 const DebugMap::Entry *debug_map_entry = m_debug_map.FindEntryThatContains (exe_file_addr);
806 if (debug_map_entry)
807 {
808
809 sc.symbol = symtab->SymbolAtIndex(debug_map_entry->data.GetExeSymbolIndex());
810
811 if (sc.symbol != NULL)
812 {
813 resolved_flags |= eSymbolContextSymbol;
814
815 uint32_t oso_idx = 0;
816 CompileUnitInfo* comp_unit_info = GetCompileUnitInfoForSymbolWithID (sc.symbol->GetID(), &oso_idx);
817 if (comp_unit_info)
818 {
819 comp_unit_info->GetFileRangeMap(this);
820 Module *oso_module = GetModuleByCompUnitInfo (comp_unit_info);
821 if (oso_module)
822 {
823 lldb::addr_t oso_file_addr = exe_file_addr - debug_map_entry->GetRangeBase() + debug_map_entry->data.GetOSOFileAddress();
824 Address oso_so_addr;
825 if (oso_module->ResolveFileAddress(oso_file_addr, oso_so_addr))
826 {
827 resolved_flags |= oso_module->GetSymbolVendor()->ResolveSymbolContext (oso_so_addr, resolve_scope, sc);
828 }
829 }
830 }
831 }
832 }
833 }
834 return resolved_flags;
835 }
836
837
838 uint32_t
ResolveSymbolContext(const FileSpec & file_spec,uint32_t line,bool check_inlines,uint32_t resolve_scope,SymbolContextList & sc_list)839 SymbolFileDWARFDebugMap::ResolveSymbolContext (const FileSpec& file_spec, uint32_t line, bool check_inlines, uint32_t resolve_scope, SymbolContextList& sc_list)
840 {
841 const uint32_t initial = sc_list.GetSize();
842 const uint32_t cu_count = GetNumCompileUnits();
843
844 for (uint32_t i=0; i<cu_count; ++i)
845 {
846 // If we are checking for inlines, then we need to look through all
847 // compile units no matter if "file_spec" matches.
848 bool resolve = check_inlines;
849
850 if (!resolve)
851 {
852 FileSpec so_file_spec;
853 if (GetFileSpecForSO (i, so_file_spec))
854 {
855 // Match the full path if the incoming file_spec has a directory (not just a basename)
856 const bool full_match = (bool)file_spec.GetDirectory();
857 resolve = FileSpec::Equal (file_spec, so_file_spec, full_match);
858 }
859 }
860 if (resolve)
861 {
862 SymbolFileDWARF *oso_dwarf = GetSymbolFileByOSOIndex (i);
863 if (oso_dwarf)
864 oso_dwarf->ResolveSymbolContext(file_spec, line, check_inlines, resolve_scope, sc_list);
865 }
866 }
867 return sc_list.GetSize() - initial;
868 }
869
870 uint32_t
PrivateFindGlobalVariables(const ConstString & name,const ClangNamespaceDecl * namespace_decl,const std::vector<uint32_t> & indexes,uint32_t max_matches,VariableList & variables)871 SymbolFileDWARFDebugMap::PrivateFindGlobalVariables
872 (
873 const ConstString &name,
874 const ClangNamespaceDecl *namespace_decl,
875 const std::vector<uint32_t> &indexes, // Indexes into the symbol table that match "name"
876 uint32_t max_matches,
877 VariableList& variables
878 )
879 {
880 const uint32_t original_size = variables.GetSize();
881 const size_t match_count = indexes.size();
882 for (size_t i=0; i<match_count; ++i)
883 {
884 uint32_t oso_idx;
885 CompileUnitInfo* comp_unit_info = GetCompileUnitInfoForSymbolWithIndex (indexes[i], &oso_idx);
886 if (comp_unit_info)
887 {
888 SymbolFileDWARF *oso_dwarf = GetSymbolFileByOSOIndex (oso_idx);
889 if (oso_dwarf)
890 {
891 if (oso_dwarf->FindGlobalVariables(name, namespace_decl, true, max_matches, variables))
892 if (variables.GetSize() > max_matches)
893 break;
894 }
895 }
896 }
897 return variables.GetSize() - original_size;
898 }
899
900 uint32_t
FindGlobalVariables(const ConstString & name,const ClangNamespaceDecl * namespace_decl,bool append,uint32_t max_matches,VariableList & variables)901 SymbolFileDWARFDebugMap::FindGlobalVariables (const ConstString &name, const ClangNamespaceDecl *namespace_decl, bool append, uint32_t max_matches, VariableList& variables)
902 {
903
904 // If we aren't appending the results to this list, then clear the list
905 if (!append)
906 variables.Clear();
907
908 // Remember how many variables are in the list before we search in case
909 // we are appending the results to a variable list.
910 const uint32_t original_size = variables.GetSize();
911
912 uint32_t total_matches = 0;
913
914 ForEachSymbolFile([&](SymbolFileDWARF *oso_dwarf) -> bool {
915 const uint32_t oso_matches = oso_dwarf->FindGlobalVariables (name,
916 namespace_decl,
917 true,
918 max_matches,
919 variables);
920 if (oso_matches > 0)
921 {
922 total_matches += oso_matches;
923
924 // Are we getting all matches?
925 if (max_matches == UINT32_MAX)
926 return false; // Yep, continue getting everything
927
928 // If we have found enough matches, lets get out
929 if (max_matches >= total_matches)
930 return true;
931
932 // Update the max matches for any subsequent calls to find globals
933 // in any other object files with DWARF
934 max_matches -= oso_matches;
935 }
936
937 return false;
938 });
939
940 // Return the number of variable that were appended to the list
941 return variables.GetSize() - original_size;
942 }
943
944
945 uint32_t
FindGlobalVariables(const RegularExpression & regex,bool append,uint32_t max_matches,VariableList & variables)946 SymbolFileDWARFDebugMap::FindGlobalVariables (const RegularExpression& regex, bool append, uint32_t max_matches, VariableList& variables)
947 {
948 // If we aren't appending the results to this list, then clear the list
949 if (!append)
950 variables.Clear();
951
952 // Remember how many variables are in the list before we search in case
953 // we are appending the results to a variable list.
954 const uint32_t original_size = variables.GetSize();
955
956 uint32_t total_matches = 0;
957 ForEachSymbolFile([&](SymbolFileDWARF *oso_dwarf) -> bool {
958 const uint32_t oso_matches = oso_dwarf->FindGlobalVariables (regex,
959 true,
960 max_matches,
961 variables);
962 if (oso_matches > 0)
963 {
964 total_matches += oso_matches;
965
966 // Are we getting all matches?
967 if (max_matches == UINT32_MAX)
968 return false; // Yep, continue getting everything
969
970 // If we have found enough matches, lets get out
971 if (max_matches >= total_matches)
972 return true;
973
974 // Update the max matches for any subsequent calls to find globals
975 // in any other object files with DWARF
976 max_matches -= oso_matches;
977 }
978
979 return false;
980 });
981
982 // Return the number of variable that were appended to the list
983 return variables.GetSize() - original_size;
984 }
985
986
987 int
SymbolContainsSymbolWithIndex(uint32_t * symbol_idx_ptr,const CompileUnitInfo * comp_unit_info)988 SymbolFileDWARFDebugMap::SymbolContainsSymbolWithIndex (uint32_t *symbol_idx_ptr, const CompileUnitInfo *comp_unit_info)
989 {
990 const uint32_t symbol_idx = *symbol_idx_ptr;
991
992 if (symbol_idx < comp_unit_info->first_symbol_index)
993 return -1;
994
995 if (symbol_idx <= comp_unit_info->last_symbol_index)
996 return 0;
997
998 return 1;
999 }
1000
1001
1002 int
SymbolContainsSymbolWithID(user_id_t * symbol_idx_ptr,const CompileUnitInfo * comp_unit_info)1003 SymbolFileDWARFDebugMap::SymbolContainsSymbolWithID (user_id_t *symbol_idx_ptr, const CompileUnitInfo *comp_unit_info)
1004 {
1005 const user_id_t symbol_id = *symbol_idx_ptr;
1006
1007 if (symbol_id < comp_unit_info->first_symbol_id)
1008 return -1;
1009
1010 if (symbol_id <= comp_unit_info->last_symbol_id)
1011 return 0;
1012
1013 return 1;
1014 }
1015
1016
1017 SymbolFileDWARFDebugMap::CompileUnitInfo*
GetCompileUnitInfoForSymbolWithIndex(uint32_t symbol_idx,uint32_t * oso_idx_ptr)1018 SymbolFileDWARFDebugMap::GetCompileUnitInfoForSymbolWithIndex (uint32_t symbol_idx, uint32_t *oso_idx_ptr)
1019 {
1020 const uint32_t oso_index_count = m_compile_unit_infos.size();
1021 CompileUnitInfo *comp_unit_info = NULL;
1022 if (oso_index_count)
1023 {
1024 comp_unit_info = (CompileUnitInfo*)bsearch(&symbol_idx,
1025 &m_compile_unit_infos[0],
1026 m_compile_unit_infos.size(),
1027 sizeof(CompileUnitInfo),
1028 (ComparisonFunction)SymbolContainsSymbolWithIndex);
1029 }
1030
1031 if (oso_idx_ptr)
1032 {
1033 if (comp_unit_info != NULL)
1034 *oso_idx_ptr = comp_unit_info - &m_compile_unit_infos[0];
1035 else
1036 *oso_idx_ptr = UINT32_MAX;
1037 }
1038 return comp_unit_info;
1039 }
1040
1041 SymbolFileDWARFDebugMap::CompileUnitInfo*
GetCompileUnitInfoForSymbolWithID(user_id_t symbol_id,uint32_t * oso_idx_ptr)1042 SymbolFileDWARFDebugMap::GetCompileUnitInfoForSymbolWithID (user_id_t symbol_id, uint32_t *oso_idx_ptr)
1043 {
1044 const uint32_t oso_index_count = m_compile_unit_infos.size();
1045 CompileUnitInfo *comp_unit_info = NULL;
1046 if (oso_index_count)
1047 {
1048 comp_unit_info = (CompileUnitInfo*)::bsearch (&symbol_id,
1049 &m_compile_unit_infos[0],
1050 m_compile_unit_infos.size(),
1051 sizeof(CompileUnitInfo),
1052 (ComparisonFunction)SymbolContainsSymbolWithID);
1053 }
1054
1055 if (oso_idx_ptr)
1056 {
1057 if (comp_unit_info != NULL)
1058 *oso_idx_ptr = comp_unit_info - &m_compile_unit_infos[0];
1059 else
1060 *oso_idx_ptr = UINT32_MAX;
1061 }
1062 return comp_unit_info;
1063 }
1064
1065
1066 static void
RemoveFunctionsWithModuleNotEqualTo(const ModuleSP & module_sp,SymbolContextList & sc_list,uint32_t start_idx)1067 RemoveFunctionsWithModuleNotEqualTo (const ModuleSP &module_sp, SymbolContextList &sc_list, uint32_t start_idx)
1068 {
1069 // We found functions in .o files. Not all functions in the .o files
1070 // will have made it into the final output file. The ones that did
1071 // make it into the final output file will have a section whose module
1072 // matches the module from the ObjectFile for this SymbolFile. When
1073 // the modules don't match, then we have something that was in a
1074 // .o file, but doesn't map to anything in the final executable.
1075 uint32_t i=start_idx;
1076 while (i < sc_list.GetSize())
1077 {
1078 SymbolContext sc;
1079 sc_list.GetContextAtIndex(i, sc);
1080 if (sc.function)
1081 {
1082 const SectionSP section_sp (sc.function->GetAddressRange().GetBaseAddress().GetSection());
1083 if (section_sp->GetModule() != module_sp)
1084 {
1085 sc_list.RemoveContextAtIndex(i);
1086 continue;
1087 }
1088 }
1089 ++i;
1090 }
1091 }
1092
1093 uint32_t
FindFunctions(const ConstString & name,const ClangNamespaceDecl * namespace_decl,uint32_t name_type_mask,bool include_inlines,bool append,SymbolContextList & sc_list)1094 SymbolFileDWARFDebugMap::FindFunctions(const ConstString &name, const ClangNamespaceDecl *namespace_decl, uint32_t name_type_mask, bool include_inlines, bool append, SymbolContextList& sc_list)
1095 {
1096 Timer scoped_timer (__PRETTY_FUNCTION__,
1097 "SymbolFileDWARFDebugMap::FindFunctions (name = %s)",
1098 name.GetCString());
1099
1100 uint32_t initial_size = 0;
1101 if (append)
1102 initial_size = sc_list.GetSize();
1103 else
1104 sc_list.Clear();
1105
1106 ForEachSymbolFile([&](SymbolFileDWARF *oso_dwarf) -> bool {
1107 uint32_t sc_idx = sc_list.GetSize();
1108 if (oso_dwarf->FindFunctions(name, namespace_decl, name_type_mask, include_inlines, true, sc_list))
1109 {
1110 RemoveFunctionsWithModuleNotEqualTo (m_obj_file->GetModule(), sc_list, sc_idx);
1111 }
1112 return false;
1113 });
1114
1115 return sc_list.GetSize() - initial_size;
1116 }
1117
1118
1119 uint32_t
FindFunctions(const RegularExpression & regex,bool include_inlines,bool append,SymbolContextList & sc_list)1120 SymbolFileDWARFDebugMap::FindFunctions (const RegularExpression& regex, bool include_inlines, bool append, SymbolContextList& sc_list)
1121 {
1122 Timer scoped_timer (__PRETTY_FUNCTION__,
1123 "SymbolFileDWARFDebugMap::FindFunctions (regex = '%s')",
1124 regex.GetText());
1125
1126 uint32_t initial_size = 0;
1127 if (append)
1128 initial_size = sc_list.GetSize();
1129 else
1130 sc_list.Clear();
1131
1132 ForEachSymbolFile([&](SymbolFileDWARF *oso_dwarf) -> bool {
1133 uint32_t sc_idx = sc_list.GetSize();
1134
1135 if (oso_dwarf->FindFunctions(regex, include_inlines, true, sc_list))
1136 {
1137 RemoveFunctionsWithModuleNotEqualTo (m_obj_file->GetModule(), sc_list, sc_idx);
1138 }
1139 return false;
1140 });
1141
1142 return sc_list.GetSize() - initial_size;
1143 }
1144
1145 size_t
GetTypes(SymbolContextScope * sc_scope,uint32_t type_mask,TypeList & type_list)1146 SymbolFileDWARFDebugMap::GetTypes (SymbolContextScope *sc_scope,
1147 uint32_t type_mask,
1148 TypeList &type_list)
1149 {
1150 Timer scoped_timer (__PRETTY_FUNCTION__,
1151 "SymbolFileDWARFDebugMap::GetTypes (type_mask = 0x%8.8x)",
1152 type_mask);
1153
1154
1155 uint32_t initial_size = type_list.GetSize();
1156 SymbolFileDWARF *oso_dwarf = NULL;
1157 if (sc_scope)
1158 {
1159 SymbolContext sc;
1160 sc_scope->CalculateSymbolContext(&sc);
1161
1162 CompileUnitInfo *cu_info = GetCompUnitInfo (sc);
1163 if (cu_info)
1164 {
1165 oso_dwarf = GetSymbolFileByCompUnitInfo (cu_info);
1166 if (oso_dwarf)
1167 oso_dwarf->GetTypes (sc_scope, type_mask, type_list);
1168 }
1169 }
1170 else
1171 {
1172 ForEachSymbolFile([&](SymbolFileDWARF *oso_dwarf) -> bool {
1173 oso_dwarf->GetTypes (sc_scope, type_mask, type_list);
1174 return false;
1175 });
1176 }
1177 return type_list.GetSize() - initial_size;
1178 }
1179
1180
1181 TypeSP
FindDefinitionTypeForDWARFDeclContext(const DWARFDeclContext & die_decl_ctx)1182 SymbolFileDWARFDebugMap::FindDefinitionTypeForDWARFDeclContext (const DWARFDeclContext &die_decl_ctx)
1183 {
1184 TypeSP type_sp;
1185 ForEachSymbolFile([&](SymbolFileDWARF *oso_dwarf) -> bool {
1186 type_sp = oso_dwarf->FindDefinitionTypeForDWARFDeclContext (die_decl_ctx);
1187 return ((bool)type_sp);
1188 });
1189 return type_sp;
1190 }
1191
1192
1193
1194 bool
Supports_DW_AT_APPLE_objc_complete_type(SymbolFileDWARF * skip_dwarf_oso)1195 SymbolFileDWARFDebugMap::Supports_DW_AT_APPLE_objc_complete_type (SymbolFileDWARF *skip_dwarf_oso)
1196 {
1197 if (m_supports_DW_AT_APPLE_objc_complete_type == eLazyBoolCalculate)
1198 {
1199 m_supports_DW_AT_APPLE_objc_complete_type = eLazyBoolNo;
1200 ForEachSymbolFile([&](SymbolFileDWARF *oso_dwarf) -> bool {
1201 if (skip_dwarf_oso != oso_dwarf && oso_dwarf->Supports_DW_AT_APPLE_objc_complete_type(NULL))
1202 {
1203 m_supports_DW_AT_APPLE_objc_complete_type = eLazyBoolYes;
1204 return true;
1205 }
1206 return false;
1207 });
1208 }
1209 return m_supports_DW_AT_APPLE_objc_complete_type == eLazyBoolYes;
1210 }
1211
1212 TypeSP
FindCompleteObjCDefinitionTypeForDIE(const DWARFDebugInfoEntry * die,const ConstString & type_name,bool must_be_implementation)1213 SymbolFileDWARFDebugMap::FindCompleteObjCDefinitionTypeForDIE (const DWARFDebugInfoEntry *die,
1214 const ConstString &type_name,
1215 bool must_be_implementation)
1216 {
1217 // If we have a debug map, we will have an Objective C symbol whose name is
1218 // the type name and whose type is eSymbolTypeObjCClass. If we can find that
1219 // symbol and find its containing parent, we can locate the .o file that will
1220 // contain the implementation definition since it will be scoped inside the N_SO
1221 // and we can then locate the SymbolFileDWARF that corresponds to that N_SO.
1222 SymbolFileDWARF *oso_dwarf = NULL;
1223 TypeSP type_sp;
1224 ObjectFile *module_objfile = m_obj_file->GetModule()->GetObjectFile();
1225 if (module_objfile)
1226 {
1227 Symtab *symtab = module_objfile->GetSymtab();
1228 if (symtab)
1229 {
1230 Symbol *objc_class_symbol = symtab->FindFirstSymbolWithNameAndType(type_name, eSymbolTypeObjCClass, Symtab::eDebugAny, Symtab::eVisibilityAny);
1231 if (objc_class_symbol)
1232 {
1233 // Get the N_SO symbol that contains the objective C class symbol as this
1234 // should be the .o file that contains the real definition...
1235 const Symbol *source_file_symbol = symtab->GetParent(objc_class_symbol);
1236
1237 if (source_file_symbol && source_file_symbol->GetType() == eSymbolTypeSourceFile)
1238 {
1239 const uint32_t source_file_symbol_idx = symtab->GetIndexForSymbol(source_file_symbol);
1240 if (source_file_symbol_idx != UINT32_MAX)
1241 {
1242 CompileUnitInfo *compile_unit_info = GetCompileUnitInfoForSymbolWithIndex (source_file_symbol_idx, NULL);
1243 if (compile_unit_info)
1244 {
1245 oso_dwarf = GetSymbolFileByCompUnitInfo (compile_unit_info);
1246 if (oso_dwarf)
1247 {
1248 TypeSP type_sp (oso_dwarf->FindCompleteObjCDefinitionTypeForDIE (die, type_name, must_be_implementation));
1249 if (type_sp)
1250 {
1251 return type_sp;
1252 }
1253 }
1254 }
1255 }
1256 }
1257 }
1258 }
1259 }
1260
1261 // Only search all .o files for the definition if we don't need the implementation
1262 // because otherwise, with a valid debug map we should have the ObjC class symbol and
1263 // the code above should have found it.
1264 if (must_be_implementation == false)
1265 {
1266 TypeSP type_sp;
1267
1268 ForEachSymbolFile([&](SymbolFileDWARF *oso_dwarf) -> bool {
1269 type_sp = oso_dwarf->FindCompleteObjCDefinitionTypeForDIE (die, type_name, must_be_implementation);
1270 return (bool)type_sp;
1271 });
1272
1273 return type_sp;
1274 }
1275 return TypeSP();
1276 }
1277
1278 uint32_t
FindTypes(const SymbolContext & sc,const ConstString & name,const ClangNamespaceDecl * namespace_decl,bool append,uint32_t max_matches,TypeList & types)1279 SymbolFileDWARFDebugMap::FindTypes
1280 (
1281 const SymbolContext& sc,
1282 const ConstString &name,
1283 const ClangNamespaceDecl *namespace_decl,
1284 bool append,
1285 uint32_t max_matches,
1286 TypeList& types
1287 )
1288 {
1289 if (!append)
1290 types.Clear();
1291
1292 const uint32_t initial_types_size = types.GetSize();
1293 SymbolFileDWARF *oso_dwarf;
1294
1295 if (sc.comp_unit)
1296 {
1297 oso_dwarf = GetSymbolFile (sc);
1298 if (oso_dwarf)
1299 return oso_dwarf->FindTypes (sc, name, namespace_decl, append, max_matches, types);
1300 }
1301 else
1302 {
1303 ForEachSymbolFile([&](SymbolFileDWARF *oso_dwarf) -> bool {
1304 oso_dwarf->FindTypes (sc, name, namespace_decl, append, max_matches, types);
1305 return false;
1306 });
1307 }
1308
1309 return types.GetSize() - initial_types_size;
1310 }
1311
1312 //
1313 //uint32_t
1314 //SymbolFileDWARFDebugMap::FindTypes (const SymbolContext& sc, const RegularExpression& regex, bool append, uint32_t max_matches, Type::Encoding encoding, lldb::user_id_t udt_uid, TypeList& types)
1315 //{
1316 // SymbolFileDWARF *oso_dwarf = GetSymbolFile (sc);
1317 // if (oso_dwarf)
1318 // return oso_dwarf->FindTypes (sc, regex, append, max_matches, encoding, udt_uid, types);
1319 // return 0;
1320 //}
1321
1322
1323 ClangNamespaceDecl
FindNamespace(const lldb_private::SymbolContext & sc,const lldb_private::ConstString & name,const ClangNamespaceDecl * parent_namespace_decl)1324 SymbolFileDWARFDebugMap::FindNamespace (const lldb_private::SymbolContext& sc,
1325 const lldb_private::ConstString &name,
1326 const ClangNamespaceDecl *parent_namespace_decl)
1327 {
1328 ClangNamespaceDecl matching_namespace;
1329 SymbolFileDWARF *oso_dwarf;
1330
1331 if (sc.comp_unit)
1332 {
1333 oso_dwarf = GetSymbolFile (sc);
1334 if (oso_dwarf)
1335 matching_namespace = oso_dwarf->FindNamespace (sc, name, parent_namespace_decl);
1336 }
1337 else
1338 {
1339 ForEachSymbolFile([&](SymbolFileDWARF *oso_dwarf) -> bool {
1340 matching_namespace = oso_dwarf->FindNamespace (sc, name, parent_namespace_decl);
1341
1342 return (bool)matching_namespace;
1343 });
1344 }
1345
1346 return matching_namespace;
1347 }
1348
1349 //------------------------------------------------------------------
1350 // PluginInterface protocol
1351 //------------------------------------------------------------------
1352 lldb_private::ConstString
GetPluginName()1353 SymbolFileDWARFDebugMap::GetPluginName()
1354 {
1355 return GetPluginNameStatic();
1356 }
1357
1358 uint32_t
GetPluginVersion()1359 SymbolFileDWARFDebugMap::GetPluginVersion()
1360 {
1361 return 1;
1362 }
1363
1364 lldb::CompUnitSP
GetCompileUnit(SymbolFileDWARF * oso_dwarf)1365 SymbolFileDWARFDebugMap::GetCompileUnit (SymbolFileDWARF *oso_dwarf)
1366 {
1367 if (oso_dwarf)
1368 {
1369 const uint32_t cu_count = GetNumCompileUnits();
1370 for (uint32_t cu_idx=0; cu_idx<cu_count; ++cu_idx)
1371 {
1372 SymbolFileDWARF *oso_symfile = GetSymbolFileByCompUnitInfo (&m_compile_unit_infos[cu_idx]);
1373 if (oso_symfile == oso_dwarf)
1374 {
1375 if (!m_compile_unit_infos[cu_idx].compile_unit_sp)
1376 m_compile_unit_infos[cu_idx].compile_unit_sp = ParseCompileUnitAtIndex (cu_idx);
1377
1378 return m_compile_unit_infos[cu_idx].compile_unit_sp;
1379 }
1380 }
1381 }
1382 assert(!"this shouldn't happen");
1383 return lldb::CompUnitSP();
1384 }
1385
1386 SymbolFileDWARFDebugMap::CompileUnitInfo *
GetCompileUnitInfo(SymbolFileDWARF * oso_dwarf)1387 SymbolFileDWARFDebugMap::GetCompileUnitInfo (SymbolFileDWARF *oso_dwarf)
1388 {
1389 if (oso_dwarf)
1390 {
1391 const uint32_t cu_count = GetNumCompileUnits();
1392 for (uint32_t cu_idx=0; cu_idx<cu_count; ++cu_idx)
1393 {
1394 SymbolFileDWARF *oso_symfile = GetSymbolFileByCompUnitInfo (&m_compile_unit_infos[cu_idx]);
1395 if (oso_symfile == oso_dwarf)
1396 {
1397 return &m_compile_unit_infos[cu_idx];
1398 }
1399 }
1400 }
1401 return NULL;
1402 }
1403
1404
1405 void
SetCompileUnit(SymbolFileDWARF * oso_dwarf,const CompUnitSP & cu_sp)1406 SymbolFileDWARFDebugMap::SetCompileUnit (SymbolFileDWARF *oso_dwarf, const CompUnitSP &cu_sp)
1407 {
1408 if (oso_dwarf)
1409 {
1410 const uint32_t cu_count = GetNumCompileUnits();
1411 for (uint32_t cu_idx=0; cu_idx<cu_count; ++cu_idx)
1412 {
1413 SymbolFileDWARF *oso_symfile = GetSymbolFileByCompUnitInfo (&m_compile_unit_infos[cu_idx]);
1414 if (oso_symfile == oso_dwarf)
1415 {
1416 if (m_compile_unit_infos[cu_idx].compile_unit_sp)
1417 {
1418 assert (m_compile_unit_infos[cu_idx].compile_unit_sp.get() == cu_sp.get());
1419 }
1420 else
1421 {
1422 m_compile_unit_infos[cu_idx].compile_unit_sp = cu_sp;
1423 m_obj_file->GetModule()->GetSymbolVendor()->SetCompileUnitAtIndex(cu_idx, cu_sp);
1424 }
1425 }
1426 }
1427 }
1428 }
1429
1430
1431 void
CompleteTagDecl(void * baton,clang::TagDecl * decl)1432 SymbolFileDWARFDebugMap::CompleteTagDecl (void *baton, clang::TagDecl *decl)
1433 {
1434 SymbolFileDWARFDebugMap *symbol_file_dwarf = (SymbolFileDWARFDebugMap *)baton;
1435 ClangASTType clang_type = symbol_file_dwarf->GetClangASTContext().GetTypeForDecl (decl);
1436 if (clang_type)
1437 {
1438 symbol_file_dwarf->ForEachSymbolFile([&](SymbolFileDWARF *oso_dwarf) -> bool {
1439 if (oso_dwarf->HasForwardDeclForClangType (clang_type))
1440 {
1441 oso_dwarf->ResolveClangOpaqueTypeDefinition (clang_type);
1442 return true;
1443 }
1444 return false;
1445 });
1446 }
1447 }
1448
1449 void
CompleteObjCInterfaceDecl(void * baton,clang::ObjCInterfaceDecl * decl)1450 SymbolFileDWARFDebugMap::CompleteObjCInterfaceDecl (void *baton, clang::ObjCInterfaceDecl *decl)
1451 {
1452 SymbolFileDWARFDebugMap *symbol_file_dwarf = (SymbolFileDWARFDebugMap *)baton;
1453 ClangASTType clang_type = symbol_file_dwarf->GetClangASTContext().GetTypeForDecl (decl);
1454 if (clang_type)
1455 {
1456 symbol_file_dwarf->ForEachSymbolFile([&](SymbolFileDWARF *oso_dwarf) -> bool {
1457 if (oso_dwarf->HasForwardDeclForClangType (clang_type))
1458 {
1459 oso_dwarf->ResolveClangOpaqueTypeDefinition (clang_type);
1460 return true;
1461 }
1462 return false;
1463 });
1464 }
1465 }
1466
1467 bool
LayoutRecordType(void * baton,const clang::RecordDecl * record_decl,uint64_t & size,uint64_t & alignment,llvm::DenseMap<const clang::FieldDecl *,uint64_t> & field_offsets,llvm::DenseMap<const clang::CXXRecordDecl *,clang::CharUnits> & base_offsets,llvm::DenseMap<const clang::CXXRecordDecl *,clang::CharUnits> & vbase_offsets)1468 SymbolFileDWARFDebugMap::LayoutRecordType(void *baton, const clang::RecordDecl *record_decl, uint64_t &size,
1469 uint64_t &alignment,
1470 llvm::DenseMap<const clang::FieldDecl *, uint64_t> &field_offsets,
1471 llvm::DenseMap<const clang::CXXRecordDecl *, clang::CharUnits> &base_offsets,
1472 llvm::DenseMap<const clang::CXXRecordDecl *, clang::CharUnits> &vbase_offsets)
1473 {
1474 SymbolFileDWARFDebugMap *symbol_file_dwarf = (SymbolFileDWARFDebugMap *)baton;
1475 bool laid_out = false;
1476 symbol_file_dwarf->ForEachSymbolFile([&](SymbolFileDWARF *oso_dwarf) -> bool {
1477 return (laid_out = oso_dwarf->LayoutRecordType (record_decl, size, alignment, field_offsets, base_offsets, vbase_offsets));
1478 });
1479 return laid_out;
1480 }
1481
1482
1483
1484 clang::DeclContext*
GetClangDeclContextContainingTypeUID(lldb::user_id_t type_uid)1485 SymbolFileDWARFDebugMap::GetClangDeclContextContainingTypeUID (lldb::user_id_t type_uid)
1486 {
1487 const uint64_t oso_idx = GetOSOIndexFromUserID (type_uid);
1488 SymbolFileDWARF *oso_dwarf = GetSymbolFileByOSOIndex (oso_idx);
1489 if (oso_dwarf)
1490 return oso_dwarf->GetClangDeclContextContainingTypeUID (type_uid);
1491 return NULL;
1492 }
1493
1494 clang::DeclContext*
GetClangDeclContextForTypeUID(const lldb_private::SymbolContext & sc,lldb::user_id_t type_uid)1495 SymbolFileDWARFDebugMap::GetClangDeclContextForTypeUID (const lldb_private::SymbolContext &sc, lldb::user_id_t type_uid)
1496 {
1497 const uint64_t oso_idx = GetOSOIndexFromUserID (type_uid);
1498 SymbolFileDWARF *oso_dwarf = GetSymbolFileByOSOIndex (oso_idx);
1499 if (oso_dwarf)
1500 return oso_dwarf->GetClangDeclContextForTypeUID (sc, type_uid);
1501 return NULL;
1502 }
1503
1504 bool
AddOSOFileRange(CompileUnitInfo * cu_info,lldb::addr_t exe_file_addr,lldb::addr_t oso_file_addr,lldb::addr_t oso_byte_size)1505 SymbolFileDWARFDebugMap::AddOSOFileRange (CompileUnitInfo *cu_info,
1506 lldb::addr_t exe_file_addr,
1507 lldb::addr_t oso_file_addr,
1508 lldb::addr_t oso_byte_size)
1509 {
1510 const uint32_t debug_map_idx = m_debug_map.FindEntryIndexThatContains(exe_file_addr);
1511 if (debug_map_idx != UINT32_MAX)
1512 {
1513 DebugMap::Entry *debug_map_entry = m_debug_map.FindEntryThatContains(exe_file_addr);
1514 debug_map_entry->data.SetOSOFileAddress(oso_file_addr);
1515 cu_info->file_range_map.Append(FileRangeMap::Entry(oso_file_addr, oso_byte_size, exe_file_addr));
1516 return true;
1517 }
1518 return false;
1519 }
1520
1521 void
FinalizeOSOFileRanges(CompileUnitInfo * cu_info)1522 SymbolFileDWARFDebugMap::FinalizeOSOFileRanges (CompileUnitInfo *cu_info)
1523 {
1524 cu_info->file_range_map.Sort();
1525 #if defined(DEBUG_OSO_DMAP)
1526 const FileRangeMap &oso_file_range_map = cu_info->GetFileRangeMap(this);
1527 const size_t n = oso_file_range_map.GetSize();
1528 printf ("SymbolFileDWARFDebugMap::FinalizeOSOFileRanges (cu_info = %p) %s\n",
1529 cu_info,
1530 cu_info->oso_sp->module_sp->GetFileSpec().GetPath().c_str());
1531 for (size_t i=0; i<n; ++i)
1532 {
1533 const FileRangeMap::Entry &entry = oso_file_range_map.GetEntryRef(i);
1534 printf ("oso [0x%16.16" PRIx64 " - 0x%16.16" PRIx64 ") ==> exe [0x%16.16" PRIx64 " - 0x%16.16" PRIx64 ")\n",
1535 entry.GetRangeBase(), entry.GetRangeEnd(),
1536 entry.data, entry.data + entry.GetByteSize());
1537 }
1538 #endif
1539 }
1540
1541 lldb::addr_t
LinkOSOFileAddress(SymbolFileDWARF * oso_symfile,lldb::addr_t oso_file_addr)1542 SymbolFileDWARFDebugMap::LinkOSOFileAddress (SymbolFileDWARF *oso_symfile, lldb::addr_t oso_file_addr)
1543 {
1544 CompileUnitInfo *cu_info = GetCompileUnitInfo (oso_symfile);
1545 if (cu_info)
1546 {
1547 const FileRangeMap::Entry *oso_range_entry = cu_info->GetFileRangeMap(this).FindEntryThatContains(oso_file_addr);
1548 if (oso_range_entry)
1549 {
1550 const DebugMap::Entry *debug_map_entry = m_debug_map.FindEntryThatContains(oso_range_entry->data);
1551 if (debug_map_entry)
1552 {
1553 const lldb::addr_t offset = oso_file_addr - oso_range_entry->GetRangeBase();
1554 const lldb::addr_t exe_file_addr = debug_map_entry->GetRangeBase() + offset;
1555 return exe_file_addr;
1556 }
1557 }
1558 }
1559 return LLDB_INVALID_ADDRESS;
1560 }
1561
1562 bool
LinkOSOAddress(Address & addr)1563 SymbolFileDWARFDebugMap::LinkOSOAddress (Address &addr)
1564 {
1565 // Make sure this address hasn't been fixed already
1566 Module *exe_module = GetObjectFile()->GetModule().get();
1567 Module *addr_module = addr.GetModule().get();
1568 if (addr_module == exe_module)
1569 return true; // Address is already in terms of the main executable module
1570
1571 CompileUnitInfo *cu_info = GetCompileUnitInfo (GetSymbolFileAsSymbolFileDWARF(addr_module->GetSymbolVendor()->GetSymbolFile()));
1572 if (cu_info)
1573 {
1574 const lldb::addr_t oso_file_addr = addr.GetFileAddress();
1575 const FileRangeMap::Entry *oso_range_entry = cu_info->GetFileRangeMap(this).FindEntryThatContains(oso_file_addr);
1576 if (oso_range_entry)
1577 {
1578 const DebugMap::Entry *debug_map_entry = m_debug_map.FindEntryThatContains(oso_range_entry->data);
1579 if (debug_map_entry)
1580 {
1581 const lldb::addr_t offset = oso_file_addr - oso_range_entry->GetRangeBase();
1582 const lldb::addr_t exe_file_addr = debug_map_entry->GetRangeBase() + offset;
1583 return exe_module->ResolveFileAddress(exe_file_addr, addr);
1584 }
1585 }
1586 }
1587 return true;
1588 }
1589
1590 LineTable *
LinkOSOLineTable(SymbolFileDWARF * oso_dwarf,LineTable * line_table)1591 SymbolFileDWARFDebugMap::LinkOSOLineTable (SymbolFileDWARF *oso_dwarf, LineTable *line_table)
1592 {
1593 CompileUnitInfo *cu_info = GetCompileUnitInfo (oso_dwarf);
1594 if (cu_info)
1595 return line_table->LinkLineTable(cu_info->GetFileRangeMap(this));
1596 return NULL;
1597 }
1598
1599 size_t
AddOSOARanges(SymbolFileDWARF * dwarf2Data,DWARFDebugAranges * debug_aranges)1600 SymbolFileDWARFDebugMap::AddOSOARanges (SymbolFileDWARF* dwarf2Data, DWARFDebugAranges* debug_aranges)
1601 {
1602 size_t num_line_entries_added = 0;
1603 if (debug_aranges && dwarf2Data)
1604 {
1605 CompileUnitInfo *compile_unit_info = GetCompileUnitInfo(dwarf2Data);
1606 if (compile_unit_info)
1607 {
1608 const FileRangeMap &file_range_map = compile_unit_info->GetFileRangeMap(this);
1609 for (size_t idx = 0;
1610 idx < file_range_map.GetSize();
1611 idx++)
1612 {
1613 const FileRangeMap::Entry* entry = file_range_map.GetEntryAtIndex(idx);
1614 if (entry)
1615 {
1616 printf ("[0x%16.16" PRIx64 " - 0x%16.16" PRIx64 ")\n", entry->GetRangeBase(), entry->GetRangeEnd());
1617 debug_aranges->AppendRange(dwarf2Data->GetID(), entry->GetRangeBase(), entry->GetRangeEnd());
1618 num_line_entries_added++;
1619 }
1620 }
1621 }
1622 }
1623 return num_line_entries_added;
1624 }
1625
1626