1 //===-- SBModule.cpp --------------------------------------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 #include "lldb/API/SBModule.h"
11 #include "lldb/API/SBAddress.h"
12 #include "lldb/API/SBFileSpec.h"
13 #include "lldb/API/SBModuleSpec.h"
14 #include "lldb/API/SBProcess.h"
15 #include "lldb/API/SBStream.h"
16 #include "lldb/API/SBSymbolContextList.h"
17 #include "lldb/Core/Module.h"
18 #include "lldb/Core/Section.h"
19 #include "lldb/Core/ValueObjectList.h"
20 #include "lldb/Core/ValueObjectVariable.h"
21 #include "lldb/Symbol/ObjectFile.h"
22 #include "lldb/Symbol/SymbolFile.h"
23 #include "lldb/Symbol/SymbolVendor.h"
24 #include "lldb/Symbol/Symtab.h"
25 #include "lldb/Symbol/TypeSystem.h"
26 #include "lldb/Symbol/VariableList.h"
27 #include "lldb/Target/Target.h"
28 #include "lldb/Utility/Log.h"
29 #include "lldb/Utility/StreamString.h"
32 using namespace lldb_private;
34 SBModule::SBModule() : m_opaque_sp() {}
36 SBModule::SBModule(const lldb::ModuleSP &module_sp) : m_opaque_sp(module_sp) {}
38 SBModule::SBModule(const SBModuleSpec &module_spec) : m_opaque_sp() {
40 Status error = ModuleList::GetSharedModule(*module_spec.m_opaque_ap,
41 module_sp, NULL, NULL, NULL);
46 SBModule::SBModule(const SBModule &rhs) : m_opaque_sp(rhs.m_opaque_sp) {}
48 SBModule::SBModule(lldb::SBProcess &process, lldb::addr_t header_addr)
50 ProcessSP process_sp(process.GetSP());
52 m_opaque_sp = process_sp->ReadModuleFromMemory(FileSpec(), header_addr);
54 Target &target = process_sp->GetTarget();
56 m_opaque_sp->SetLoadAddress(target, 0, true, changed);
57 target.GetImages().Append(m_opaque_sp);
62 const SBModule &SBModule::operator=(const SBModule &rhs) {
64 m_opaque_sp = rhs.m_opaque_sp;
68 SBModule::~SBModule() {}
70 bool SBModule::IsValid() const { return m_opaque_sp.get() != NULL; }
72 void SBModule::Clear() { m_opaque_sp.reset(); }
74 SBFileSpec SBModule::GetFileSpec() const {
75 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_API));
78 ModuleSP module_sp(GetSP());
80 file_spec.SetFileSpec(module_sp->GetFileSpec());
83 log->Printf("SBModule(%p)::GetFileSpec () => SBFileSpec(%p)",
84 static_cast<void *>(module_sp.get()),
85 static_cast<const void *>(file_spec.get()));
90 lldb::SBFileSpec SBModule::GetPlatformFileSpec() const {
91 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_API));
94 ModuleSP module_sp(GetSP());
96 file_spec.SetFileSpec(module_sp->GetPlatformFileSpec());
99 log->Printf("SBModule(%p)::GetPlatformFileSpec () => SBFileSpec(%p)",
100 static_cast<void *>(module_sp.get()),
101 static_cast<const void *>(file_spec.get()));
106 bool SBModule::SetPlatformFileSpec(const lldb::SBFileSpec &platform_file) {
108 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_API));
110 ModuleSP module_sp(GetSP());
112 module_sp->SetPlatformFileSpec(*platform_file);
117 log->Printf("SBModule(%p)::SetPlatformFileSpec (SBFileSpec(%p (%s)) => %i",
118 static_cast<void *>(module_sp.get()),
119 static_cast<const void *>(platform_file.get()),
120 platform_file->GetPath().c_str(), result);
124 lldb::SBFileSpec SBModule::GetRemoteInstallFileSpec() {
125 SBFileSpec sb_file_spec;
126 ModuleSP module_sp(GetSP());
128 sb_file_spec.SetFileSpec(module_sp->GetRemoteInstallFileSpec());
132 bool SBModule::SetRemoteInstallFileSpec(lldb::SBFileSpec &file) {
133 ModuleSP module_sp(GetSP());
135 module_sp->SetRemoteInstallFileSpec(file.ref());
141 const uint8_t *SBModule::GetUUIDBytes() const {
142 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_API));
144 const uint8_t *uuid_bytes = NULL;
145 ModuleSP module_sp(GetSP());
147 uuid_bytes = module_sp->GetUUID().GetBytes().data();
152 module_sp->GetUUID().Dump(&s);
153 log->Printf("SBModule(%p)::GetUUIDBytes () => %s",
154 static_cast<void *>(module_sp.get()), s.GetData());
156 log->Printf("SBModule(%p)::GetUUIDBytes () => NULL",
157 static_cast<void *>(module_sp.get()));
162 const char *SBModule::GetUUIDString() const {
163 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_API));
165 const char *uuid_cstr = NULL;
166 ModuleSP module_sp(GetSP());
168 // We are going to return a "const char *" value through the public API, so
169 // we need to constify it so it gets added permanently the string pool and
170 // then we don't need to worry about the lifetime of the string as it will
171 // never go away once it has been put into the ConstString string pool
172 uuid_cstr = ConstString(module_sp->GetUUID().GetAsString()).GetCString();
175 if (uuid_cstr && uuid_cstr[0]) {
177 log->Printf("SBModule(%p)::GetUUIDString () => %s",
178 static_cast<void *>(module_sp.get()), uuid_cstr);
183 log->Printf("SBModule(%p)::GetUUIDString () => NULL",
184 static_cast<void *>(module_sp.get()));
188 bool SBModule::operator==(const SBModule &rhs) const {
190 return m_opaque_sp.get() == rhs.m_opaque_sp.get();
194 bool SBModule::operator!=(const SBModule &rhs) const {
196 return m_opaque_sp.get() != rhs.m_opaque_sp.get();
200 ModuleSP SBModule::GetSP() const { return m_opaque_sp; }
202 void SBModule::SetSP(const ModuleSP &module_sp) { m_opaque_sp = module_sp; }
204 SBAddress SBModule::ResolveFileAddress(lldb::addr_t vm_addr) {
205 lldb::SBAddress sb_addr;
206 ModuleSP module_sp(GetSP());
209 if (module_sp->ResolveFileAddress(vm_addr, addr))
210 sb_addr.ref() = addr;
216 SBModule::ResolveSymbolContextForAddress(const SBAddress &addr,
217 uint32_t resolve_scope) {
218 SBSymbolContext sb_sc;
219 ModuleSP module_sp(GetSP());
220 SymbolContextItem scope = static_cast<SymbolContextItem>(resolve_scope);
221 if (module_sp && addr.IsValid())
222 module_sp->ResolveSymbolContextForAddress(addr.ref(), scope, *sb_sc);
226 bool SBModule::GetDescription(SBStream &description) {
227 Stream &strm = description.ref();
229 ModuleSP module_sp(GetSP());
231 module_sp->GetDescription(&strm);
233 strm.PutCString("No value");
238 uint32_t SBModule::GetNumCompileUnits() {
239 ModuleSP module_sp(GetSP());
241 return module_sp->GetNumCompileUnits();
246 SBCompileUnit SBModule::GetCompileUnitAtIndex(uint32_t index) {
248 ModuleSP module_sp(GetSP());
250 CompUnitSP cu_sp = module_sp->GetCompileUnitAtIndex(index);
251 sb_cu.reset(cu_sp.get());
257 SBModule::FindCompileUnits(const SBFileSpec &sb_file_spec) {
258 SBSymbolContextList sb_sc_list;
259 const ModuleSP module_sp(GetSP());
260 if (sb_file_spec.IsValid() && module_sp) {
261 const bool append = true;
262 module_sp->FindCompileUnits(*sb_file_spec, append, *sb_sc_list);
267 static Symtab *GetUnifiedSymbolTable(const lldb::ModuleSP &module_sp) {
269 SymbolVendor *symbols = module_sp->GetSymbolVendor();
271 return symbols->GetSymtab();
276 size_t SBModule::GetNumSymbols() {
277 ModuleSP module_sp(GetSP());
279 Symtab *symtab = GetUnifiedSymbolTable(module_sp);
281 return symtab->GetNumSymbols();
286 SBSymbol SBModule::GetSymbolAtIndex(size_t idx) {
288 ModuleSP module_sp(GetSP());
289 Symtab *symtab = GetUnifiedSymbolTable(module_sp);
291 sb_symbol.SetSymbol(symtab->SymbolAtIndex(idx));
295 lldb::SBSymbol SBModule::FindSymbol(const char *name,
296 lldb::SymbolType symbol_type) {
298 if (name && name[0]) {
299 ModuleSP module_sp(GetSP());
300 Symtab *symtab = GetUnifiedSymbolTable(module_sp);
302 sb_symbol.SetSymbol(symtab->FindFirstSymbolWithNameAndType(
303 ConstString(name), symbol_type, Symtab::eDebugAny,
304 Symtab::eVisibilityAny));
309 lldb::SBSymbolContextList SBModule::FindSymbols(const char *name,
310 lldb::SymbolType symbol_type) {
311 SBSymbolContextList sb_sc_list;
312 if (name && name[0]) {
313 ModuleSP module_sp(GetSP());
314 Symtab *symtab = GetUnifiedSymbolTable(module_sp);
316 std::vector<uint32_t> matching_symbol_indexes;
317 const size_t num_matches = symtab->FindAllSymbolsWithNameAndType(
318 ConstString(name), symbol_type, matching_symbol_indexes);
321 sc.module_sp = module_sp;
322 SymbolContextList &sc_list = *sb_sc_list;
323 for (size_t i = 0; i < num_matches; ++i) {
324 sc.symbol = symtab->SymbolAtIndex(matching_symbol_indexes[i]);
334 size_t SBModule::GetNumSections() {
335 ModuleSP module_sp(GetSP());
337 // Give the symbol vendor a chance to add to the unified section list.
338 module_sp->GetSymbolVendor();
339 SectionList *section_list = module_sp->GetSectionList();
341 return section_list->GetSize();
346 SBSection SBModule::GetSectionAtIndex(size_t idx) {
347 SBSection sb_section;
348 ModuleSP module_sp(GetSP());
350 // Give the symbol vendor a chance to add to the unified section list.
351 module_sp->GetSymbolVendor();
352 SectionList *section_list = module_sp->GetSectionList();
355 sb_section.SetSP(section_list->GetSectionAtIndex(idx));
360 lldb::SBSymbolContextList SBModule::FindFunctions(const char *name,
361 uint32_t name_type_mask) {
362 lldb::SBSymbolContextList sb_sc_list;
363 ModuleSP module_sp(GetSP());
364 if (name && module_sp) {
365 const bool append = true;
366 const bool symbols_ok = true;
367 const bool inlines_ok = true;
368 FunctionNameType type = static_cast<FunctionNameType>(name_type_mask);
369 module_sp->FindFunctions(ConstString(name), NULL, type, symbols_ok,
370 inlines_ok, append, *sb_sc_list);
375 SBValueList SBModule::FindGlobalVariables(SBTarget &target, const char *name,
376 uint32_t max_matches) {
377 SBValueList sb_value_list;
378 ModuleSP module_sp(GetSP());
379 if (name && module_sp) {
380 VariableList variable_list;
381 const uint32_t match_count = module_sp->FindGlobalVariables(
382 ConstString(name), NULL, max_matches, variable_list);
384 if (match_count > 0) {
385 for (uint32_t i = 0; i < match_count; ++i) {
386 lldb::ValueObjectSP valobj_sp;
387 TargetSP target_sp(target.GetSP());
388 valobj_sp = ValueObjectVariable::Create(
389 target_sp.get(), variable_list.GetVariableAtIndex(i));
391 sb_value_list.Append(SBValue(valobj_sp));
396 return sb_value_list;
399 lldb::SBValue SBModule::FindFirstGlobalVariable(lldb::SBTarget &target,
401 SBValueList sb_value_list(FindGlobalVariables(target, name, 1));
402 if (sb_value_list.IsValid() && sb_value_list.GetSize() > 0)
403 return sb_value_list.GetValueAtIndex(0);
407 lldb::SBType SBModule::FindFirstType(const char *name_cstr) {
409 ModuleSP module_sp(GetSP());
410 if (name_cstr && module_sp) {
412 const bool exact_match = false;
413 ConstString name(name_cstr);
415 sb_type = SBType(module_sp->FindFirstType(sc, name, exact_match));
417 if (!sb_type.IsValid()) {
418 TypeSystem *type_system =
419 module_sp->GetTypeSystemForLanguage(eLanguageTypeC);
421 sb_type = SBType(type_system->GetBuiltinTypeByName(name));
427 lldb::SBType SBModule::GetBasicType(lldb::BasicType type) {
428 ModuleSP module_sp(GetSP());
430 TypeSystem *type_system =
431 module_sp->GetTypeSystemForLanguage(eLanguageTypeC);
433 return SBType(type_system->GetBasicTypeFromAST(type));
438 lldb::SBTypeList SBModule::FindTypes(const char *type) {
441 ModuleSP module_sp(GetSP());
442 if (type && module_sp) {
444 const bool exact_match = false;
445 ConstString name(type);
446 llvm::DenseSet<SymbolFile *> searched_symbol_files;
447 const uint32_t num_matches = module_sp->FindTypes(
448 name, exact_match, UINT32_MAX, searched_symbol_files, type_list);
450 if (num_matches > 0) {
451 for (size_t idx = 0; idx < num_matches; idx++) {
452 TypeSP type_sp(type_list.GetTypeAtIndex(idx));
454 retval.Append(SBType(type_sp));
457 TypeSystem *type_system =
458 module_sp->GetTypeSystemForLanguage(eLanguageTypeC);
460 CompilerType compiler_type = type_system->GetBuiltinTypeByName(name);
462 retval.Append(SBType(compiler_type));
470 lldb::SBType SBModule::GetTypeByID(lldb::user_id_t uid) {
471 ModuleSP module_sp(GetSP());
473 SymbolVendor *vendor = module_sp->GetSymbolVendor();
475 Type *type_ptr = vendor->ResolveTypeUID(uid);
477 return SBType(type_ptr->shared_from_this());
483 lldb::SBTypeList SBModule::GetTypes(uint32_t type_mask) {
484 SBTypeList sb_type_list;
486 ModuleSP module_sp(GetSP());
489 SymbolVendor *vendor = module_sp->GetSymbolVendor();
493 TypeClass type_class = static_cast<TypeClass>(type_mask);
495 vendor->GetTypes(NULL, type_class, type_list);
496 sb_type_list.m_opaque_ap->Append(type_list);
500 SBSection SBModule::FindSection(const char *sect_name) {
501 SBSection sb_section;
503 ModuleSP module_sp(GetSP());
504 if (sect_name && module_sp) {
505 // Give the symbol vendor a chance to add to the unified section list.
506 module_sp->GetSymbolVendor();
507 SectionList *section_list = module_sp->GetSectionList();
509 ConstString const_sect_name(sect_name);
510 SectionSP section_sp(section_list->FindSectionByName(const_sect_name));
512 sb_section.SetSP(section_sp);
519 lldb::ByteOrder SBModule::GetByteOrder() {
520 ModuleSP module_sp(GetSP());
522 return module_sp->GetArchitecture().GetByteOrder();
523 return eByteOrderInvalid;
526 const char *SBModule::GetTriple() {
527 ModuleSP module_sp(GetSP());
529 std::string triple(module_sp->GetArchitecture().GetTriple().str());
530 // Unique the string so we don't run into ownership issues since the const
531 // strings put the string into the string pool once and the strings never
533 ConstString const_triple(triple.c_str());
534 return const_triple.GetCString();
539 uint32_t SBModule::GetAddressByteSize() {
540 ModuleSP module_sp(GetSP());
542 return module_sp->GetArchitecture().GetAddressByteSize();
543 return sizeof(void *);
546 uint32_t SBModule::GetVersion(uint32_t *versions, uint32_t num_versions) {
547 llvm::VersionTuple version;
548 if (ModuleSP module_sp = GetSP())
549 version = module_sp->GetVersion();
551 if (!version.empty())
553 if (version.getMinor())
555 if(version.getSubminor())
561 if (num_versions > 0)
562 versions[0] = version.empty() ? UINT32_MAX : version.getMajor();
563 if (num_versions > 1)
564 versions[1] = version.getMinor().getValueOr(UINT32_MAX);
565 if (num_versions > 2)
566 versions[2] = version.getSubminor().getValueOr(UINT32_MAX);
567 for (uint32_t i = 3; i < num_versions; ++i)
568 versions[i] = UINT32_MAX;
572 lldb::SBFileSpec SBModule::GetSymbolFileSpec() const {
573 lldb::SBFileSpec sb_file_spec;
574 ModuleSP module_sp(GetSP());
576 SymbolVendor *symbol_vendor_ptr = module_sp->GetSymbolVendor();
577 if (symbol_vendor_ptr)
578 sb_file_spec.SetFileSpec(symbol_vendor_ptr->GetMainFileSpec());
583 lldb::SBAddress SBModule::GetObjectFileHeaderAddress() const {
584 lldb::SBAddress sb_addr;
585 ModuleSP module_sp(GetSP());
587 ObjectFile *objfile_ptr = module_sp->GetObjectFile();
589 sb_addr.ref() = objfile_ptr->GetBaseAddress();
594 lldb::SBAddress SBModule::GetObjectFileEntryPointAddress() const {
595 lldb::SBAddress sb_addr;
596 ModuleSP module_sp(GetSP());
598 ObjectFile *objfile_ptr = module_sp->GetObjectFile();
600 sb_addr.ref() = objfile_ptr->GetEntryPointAddress();