1 //===-- IRExecutionUnit.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 "llvm/ExecutionEngine/ExecutionEngine.h"
11 #include "llvm/ExecutionEngine/ObjectCache.h"
12 #include "llvm/IR/Constants.h"
13 #include "llvm/IR/LLVMContext.h"
14 #include "llvm/IR/Module.h"
15 #include "llvm/Support/SourceMgr.h"
16 #include "llvm/Support/raw_ostream.h"
18 #include "lldb/Core/DataBufferHeap.h"
19 #include "lldb/Core/DataExtractor.h"
20 #include "lldb/Core/Debugger.h"
21 #include "lldb/Core/Disassembler.h"
22 #include "lldb/Core/Log.h"
23 #include "lldb/Core/Module.h"
24 #include "lldb/Core/Section.h"
25 #include "lldb/Expression/IRExecutionUnit.h"
26 #include "lldb/Symbol/CompileUnit.h"
27 #include "lldb/Symbol/SymbolContext.h"
28 #include "lldb/Symbol/SymbolFile.h"
29 #include "lldb/Symbol/SymbolVendor.h"
30 #include "lldb/Target/ExecutionContext.h"
31 #include "lldb/Target/ObjCLanguageRuntime.h"
32 #include "lldb/Target/Target.h"
33 #include "lldb/Utility/LLDBAssert.h"
35 #include "lldb/../../source/Plugins/Language/CPlusPlus/CPlusPlusLanguage.h"
37 using namespace lldb_private;
39 IRExecutionUnit::IRExecutionUnit(std::unique_ptr<llvm::LLVMContext> &context_ap,
40 std::unique_ptr<llvm::Module> &module_ap,
42 const lldb::TargetSP &target_sp,
43 const SymbolContext &sym_ctx,
44 std::vector<std::string> &cpu_features)
45 : IRMemoryMap(target_sp), m_context_ap(context_ap.release()),
46 m_module_ap(module_ap.release()), m_module(m_module_ap.get()),
47 m_cpu_features(cpu_features), m_name(name), m_sym_ctx(sym_ctx),
48 m_did_jit(false), m_function_load_addr(LLDB_INVALID_ADDRESS),
49 m_function_end_load_addr(LLDB_INVALID_ADDRESS),
50 m_reported_allocations(false) {}
52 lldb::addr_t IRExecutionUnit::WriteNow(const uint8_t *bytes, size_t size,
54 const bool zero_memory = false;
55 lldb::addr_t allocation_process_addr =
56 Malloc(size, 8, lldb::ePermissionsWritable | lldb::ePermissionsReadable,
57 eAllocationPolicyMirror, zero_memory, error);
60 return LLDB_INVALID_ADDRESS;
62 WriteMemory(allocation_process_addr, bytes, size, error);
64 if (!error.Success()) {
66 Free(allocation_process_addr, err);
68 return LLDB_INVALID_ADDRESS;
72 lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_EXPRESSIONS)) {
73 DataBufferHeap my_buffer(size, 0);
75 ReadMemory(my_buffer.GetBytes(), allocation_process_addr, size, err);
78 DataExtractor my_extractor(my_buffer.GetBytes(), my_buffer.GetByteSize(),
79 lldb::eByteOrderBig, 8);
80 my_extractor.PutToLog(log, 0, my_buffer.GetByteSize(),
81 allocation_process_addr, 16,
82 DataExtractor::TypeUInt8);
86 return allocation_process_addr;
89 void IRExecutionUnit::FreeNow(lldb::addr_t allocation) {
90 if (allocation == LLDB_INVALID_ADDRESS)
95 Free(allocation, err);
98 Error IRExecutionUnit::DisassembleFunction(Stream &stream,
99 lldb::ProcessSP &process_wp) {
100 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_EXPRESSIONS));
102 ExecutionContext exe_ctx(process_wp);
108 lldb::addr_t func_local_addr = LLDB_INVALID_ADDRESS;
109 lldb::addr_t func_remote_addr = LLDB_INVALID_ADDRESS;
111 for (JittedFunction &function : m_jitted_functions) {
112 if (function.m_name == m_name) {
113 func_local_addr = function.m_local_addr;
114 func_remote_addr = function.m_remote_addr;
118 if (func_local_addr == LLDB_INVALID_ADDRESS) {
119 ret.SetErrorToGenericError();
120 ret.SetErrorStringWithFormat("Couldn't find function %s for disassembly",
126 log->Printf("Found function, has local address 0x%" PRIx64
127 " and remote address 0x%" PRIx64,
128 (uint64_t)func_local_addr, (uint64_t)func_remote_addr);
130 std::pair<lldb::addr_t, lldb::addr_t> func_range;
132 func_range = GetRemoteRangeForLocal(func_local_addr);
134 if (func_range.first == 0 && func_range.second == 0) {
135 ret.SetErrorToGenericError();
136 ret.SetErrorStringWithFormat("Couldn't find code range for function %s",
142 log->Printf("Function's code range is [0x%" PRIx64 "+0x%" PRIx64 "]",
143 func_range.first, func_range.second);
145 Target *target = exe_ctx.GetTargetPtr();
147 ret.SetErrorToGenericError();
148 ret.SetErrorString("Couldn't find the target");
152 lldb::DataBufferSP buffer_sp(new DataBufferHeap(func_range.second, 0));
154 Process *process = exe_ctx.GetProcessPtr();
156 process->ReadMemory(func_remote_addr, buffer_sp->GetBytes(),
157 buffer_sp->GetByteSize(), err);
159 if (!err.Success()) {
160 ret.SetErrorToGenericError();
161 ret.SetErrorStringWithFormat("Couldn't read from process: %s",
162 err.AsCString("unknown error"));
166 ArchSpec arch(target->GetArchitecture());
168 const char *plugin_name = NULL;
169 const char *flavor_string = NULL;
170 lldb::DisassemblerSP disassembler_sp =
171 Disassembler::FindPlugin(arch, flavor_string, plugin_name);
173 if (!disassembler_sp) {
174 ret.SetErrorToGenericError();
175 ret.SetErrorStringWithFormat(
176 "Unable to find disassembler plug-in for %s architecture.",
177 arch.GetArchitectureName());
182 ret.SetErrorToGenericError();
183 ret.SetErrorString("Couldn't find the process");
187 DataExtractor extractor(buffer_sp, process->GetByteOrder(),
188 target->GetArchitecture().GetAddressByteSize());
191 log->Printf("Function data has contents:");
192 extractor.PutToLog(log, 0, extractor.GetByteSize(), func_remote_addr, 16,
193 DataExtractor::TypeUInt8);
196 disassembler_sp->DecodeInstructions(Address(func_remote_addr), extractor, 0,
197 UINT32_MAX, false, false);
199 InstructionList &instruction_list = disassembler_sp->GetInstructionList();
200 instruction_list.Dump(&stream, true, true, &exe_ctx);
204 static void ReportInlineAsmError(const llvm::SMDiagnostic &diagnostic,
205 void *Context, unsigned LocCookie) {
206 Error *err = static_cast<Error *>(Context);
208 if (err && err->Success()) {
209 err->SetErrorToGenericError();
210 err->SetErrorStringWithFormat("Inline assembly error: %s",
211 diagnostic.getMessage().str().c_str());
215 void IRExecutionUnit::ReportSymbolLookupError(const ConstString &name) {
216 m_failed_lookups.push_back(name);
219 void IRExecutionUnit::GetRunnableInfo(Error &error, lldb::addr_t &func_addr,
220 lldb::addr_t &func_end) {
221 lldb::ProcessSP process_sp(GetProcessWP().lock());
223 static std::recursive_mutex s_runnable_info_mutex;
225 func_addr = LLDB_INVALID_ADDRESS;
226 func_end = LLDB_INVALID_ADDRESS;
229 error.SetErrorToGenericError();
230 error.SetErrorString("Couldn't write the JIT compiled code into the "
231 "process because the process is invalid");
236 func_addr = m_function_load_addr;
237 func_end = m_function_end_load_addr;
242 std::lock_guard<std::recursive_mutex> guard(s_runnable_info_mutex);
246 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_EXPRESSIONS));
248 std::string error_string;
252 llvm::raw_string_ostream oss(s);
254 m_module->print(oss, NULL);
258 log->Printf("Module being sent to JIT: \n%s", s.c_str());
261 llvm::Triple triple(m_module->getTargetTriple());
262 llvm::Reloc::Model relocModel;
263 llvm::CodeModel::Model codeModel;
265 if (triple.isOSBinFormatELF()) {
266 relocModel = llvm::Reloc::Static;
268 relocModel = llvm::Reloc::PIC_;
271 // This will be small for 32-bit and large for 64-bit.
272 codeModel = llvm::CodeModel::JITDefault;
274 m_module_ap->getContext().setInlineAsmDiagnosticHandler(ReportInlineAsmError,
277 llvm::EngineBuilder builder(std::move(m_module_ap));
279 builder.setEngineKind(llvm::EngineKind::JIT)
280 .setErrorStr(&error_string)
281 .setRelocationModel(relocModel)
282 .setMCJITMemoryManager(
283 std::unique_ptr<MemoryManager>(new MemoryManager(*this)))
284 .setCodeModel(codeModel)
285 .setOptLevel(llvm::CodeGenOpt::Less)
286 .setUseOrcMCJITReplacement(true);
288 llvm::StringRef mArch;
289 llvm::StringRef mCPU;
290 llvm::SmallVector<std::string, 0> mAttrs;
292 for (std::string &feature : m_cpu_features)
293 mAttrs.push_back(feature);
295 llvm::TargetMachine *target_machine =
296 builder.selectTarget(triple, mArch, mCPU, mAttrs);
298 m_execution_engine_ap.reset(builder.create(target_machine));
301 (m_execution_engine_ap->getDataLayout().getGlobalPrefix() == '_');
303 if (!m_execution_engine_ap.get()) {
304 error.SetErrorToGenericError();
305 error.SetErrorStringWithFormat("Couldn't JIT the function: %s",
306 error_string.c_str());
310 class ObjectDumper : public llvm::ObjectCache {
312 void notifyObjectCompiled(const llvm::Module *module,
313 llvm::MemoryBufferRef object) override {
315 llvm::SmallVector<char, 256> result_path;
316 std::string object_name_model =
317 "jit-object-" + module->getModuleIdentifier() + "-%%%.o";
318 (void)llvm::sys::fs::createUniqueFile(object_name_model, fd, result_path);
319 llvm::raw_fd_ostream fds(fd, true);
320 fds.write(object.getBufferStart(), object.getBufferSize());
323 std::unique_ptr<llvm::MemoryBuffer>
324 getObject(const llvm::Module *module) override {
325 // Return nothing - we're just abusing the object-cache mechanism to dump
331 if (process_sp->GetTarget().GetEnableSaveObjects()) {
332 m_object_cache_ap = llvm::make_unique<ObjectDumper>();
333 m_execution_engine_ap->setObjectCache(m_object_cache_ap.get());
336 // Make sure we see all sections, including ones that don't have
338 m_execution_engine_ap->setProcessAllSections(true);
340 m_execution_engine_ap->DisableLazyCompilation();
342 for (llvm::Function &function : *m_module) {
343 if (function.isDeclaration() || function.hasPrivateLinkage())
346 const bool external =
347 function.hasExternalLinkage() || function.hasLinkOnceODRLinkage();
349 void *fun_ptr = m_execution_engine_ap->getPointerToFunction(&function);
351 if (!error.Success()) {
352 // We got an error through our callback!
357 error.SetErrorToGenericError();
358 error.SetErrorStringWithFormat(
359 "'%s' was in the JITted module but wasn't lowered",
360 function.getName().str().c_str());
363 m_jitted_functions.push_back(JittedFunction(
364 function.getName().str().c_str(), external, (lldb::addr_t)fun_ptr));
367 CommitAllocations(process_sp);
368 ReportAllocations(*m_execution_engine_ap);
370 // We have to do this after calling ReportAllocations because for the MCJIT,
371 // getGlobalValueAddress
372 // will cause the JIT to perform all relocations. That can only be done once,
374 // after we do the remapping from local -> remote.
375 // That means we don't know the local address of the Variables, but we don't
376 // need that for anything,
379 std::function<void(llvm::GlobalValue &)> RegisterOneValue = [this](
380 llvm::GlobalValue &val) {
381 if (val.hasExternalLinkage() && !val.isDeclaration()) {
382 uint64_t var_ptr_addr =
383 m_execution_engine_ap->getGlobalValueAddress(val.getName().str());
385 lldb::addr_t remote_addr = GetRemoteAddressForLocal(var_ptr_addr);
387 // This is a really unfortunae API that sometimes returns local addresses
388 // and sometimes returns remote addresses, based on whether
389 // the variable was relocated during ReportAllocations or not.
391 if (remote_addr == LLDB_INVALID_ADDRESS) {
392 remote_addr = var_ptr_addr;
395 if (var_ptr_addr != 0)
396 m_jitted_global_variables.push_back(JittedGlobalVariable(
397 val.getName().str().c_str(), LLDB_INVALID_ADDRESS, remote_addr));
401 for (llvm::GlobalVariable &global_var : m_module->getGlobalList()) {
402 RegisterOneValue(global_var);
405 for (llvm::GlobalAlias &global_alias : m_module->getAliasList()) {
406 RegisterOneValue(global_alias);
409 WriteData(process_sp);
411 if (m_failed_lookups.size()) {
414 ss.PutCString("Couldn't lookup symbols:\n");
416 bool emitNewLine = false;
418 for (const ConstString &failed_lookup : m_failed_lookups) {
423 ss.PutCString(Mangled(failed_lookup)
424 .GetDemangledName(lldb::eLanguageTypeObjC_plus_plus)
428 m_failed_lookups.clear();
430 error.SetErrorString(ss.GetString());
435 m_function_load_addr = LLDB_INVALID_ADDRESS;
436 m_function_end_load_addr = LLDB_INVALID_ADDRESS;
438 for (JittedFunction &jitted_function : m_jitted_functions) {
439 jitted_function.m_remote_addr =
440 GetRemoteAddressForLocal(jitted_function.m_local_addr);
442 if (!m_name.IsEmpty() && jitted_function.m_name == m_name) {
443 AddrRange func_range =
444 GetRemoteRangeForLocal(jitted_function.m_local_addr);
445 m_function_end_load_addr = func_range.first + func_range.second;
446 m_function_load_addr = jitted_function.m_remote_addr;
451 log->Printf("Code can be run in the target.");
453 StreamString disassembly_stream;
455 Error err = DisassembleFunction(disassembly_stream, process_sp);
457 if (!err.Success()) {
458 log->Printf("Couldn't disassemble function : %s",
459 err.AsCString("unknown error"));
461 log->Printf("Function disassembly:\n%s", disassembly_stream.GetData());
464 log->Printf("Sections: ");
465 for (AllocationRecord &record : m_records) {
466 if (record.m_process_address != LLDB_INVALID_ADDRESS) {
469 DataBufferHeap my_buffer(record.m_size, 0);
471 ReadMemory(my_buffer.GetBytes(), record.m_process_address,
475 DataExtractor my_extractor(my_buffer.GetBytes(),
476 my_buffer.GetByteSize(),
477 lldb::eByteOrderBig, 8);
478 my_extractor.PutToLog(log, 0, my_buffer.GetByteSize(),
479 record.m_process_address, 16,
480 DataExtractor::TypeUInt8);
485 DataExtractor my_extractor((const void *)record.m_host_address,
486 record.m_size, lldb::eByteOrderBig, 8);
487 my_extractor.PutToLog(log, 0, record.m_size, record.m_host_address, 16,
488 DataExtractor::TypeUInt8);
493 func_addr = m_function_load_addr;
494 func_end = m_function_end_load_addr;
499 IRExecutionUnit::~IRExecutionUnit() {
501 m_execution_engine_ap.reset();
502 m_context_ap.reset();
505 IRExecutionUnit::MemoryManager::MemoryManager(IRExecutionUnit &parent)
506 : m_default_mm_ap(new llvm::SectionMemoryManager()), m_parent(parent) {}
508 IRExecutionUnit::MemoryManager::~MemoryManager() {}
510 lldb::SectionType IRExecutionUnit::GetSectionTypeFromSectionName(
511 const llvm::StringRef &name, IRExecutionUnit::AllocationKind alloc_kind) {
512 lldb::SectionType sect_type = lldb::eSectionTypeCode;
513 switch (alloc_kind) {
514 case AllocationKind::Stub:
515 sect_type = lldb::eSectionTypeCode;
517 case AllocationKind::Code:
518 sect_type = lldb::eSectionTypeCode;
520 case AllocationKind::Data:
521 sect_type = lldb::eSectionTypeData;
523 case AllocationKind::Global:
524 sect_type = lldb::eSectionTypeData;
526 case AllocationKind::Bytes:
527 sect_type = lldb::eSectionTypeOther;
532 if (name.equals("__text") || name.equals(".text"))
533 sect_type = lldb::eSectionTypeCode;
534 else if (name.equals("__data") || name.equals(".data"))
535 sect_type = lldb::eSectionTypeCode;
536 else if (name.startswith("__debug_") || name.startswith(".debug_")) {
537 const uint32_t name_idx = name[0] == '_' ? 8 : 7;
538 llvm::StringRef dwarf_name(name.substr(name_idx));
539 switch (dwarf_name[0]) {
541 if (dwarf_name.equals("abbrev"))
542 sect_type = lldb::eSectionTypeDWARFDebugAbbrev;
543 else if (dwarf_name.equals("aranges"))
544 sect_type = lldb::eSectionTypeDWARFDebugAranges;
545 else if (dwarf_name.equals("addr"))
546 sect_type = lldb::eSectionTypeDWARFDebugAddr;
550 if (dwarf_name.equals("frame"))
551 sect_type = lldb::eSectionTypeDWARFDebugFrame;
555 if (dwarf_name.equals("info"))
556 sect_type = lldb::eSectionTypeDWARFDebugInfo;
560 if (dwarf_name.equals("line"))
561 sect_type = lldb::eSectionTypeDWARFDebugLine;
562 else if (dwarf_name.equals("loc"))
563 sect_type = lldb::eSectionTypeDWARFDebugLoc;
567 if (dwarf_name.equals("macinfo"))
568 sect_type = lldb::eSectionTypeDWARFDebugMacInfo;
572 if (dwarf_name.equals("pubnames"))
573 sect_type = lldb::eSectionTypeDWARFDebugPubNames;
574 else if (dwarf_name.equals("pubtypes"))
575 sect_type = lldb::eSectionTypeDWARFDebugPubTypes;
579 if (dwarf_name.equals("str"))
580 sect_type = lldb::eSectionTypeDWARFDebugStr;
581 else if (dwarf_name.equals("str_offsets"))
582 sect_type = lldb::eSectionTypeDWARFDebugStrOffsets;
586 if (dwarf_name.equals("ranges"))
587 sect_type = lldb::eSectionTypeDWARFDebugRanges;
593 } else if (name.startswith("__apple_") || name.startswith(".apple_")) {
595 const uint32_t name_idx = name[0] == '_' ? 8 : 7;
596 llvm::StringRef apple_name(name.substr(name_idx));
597 switch (apple_name[0])
600 if (apple_name.equals("names"))
601 sect_type = lldb::eSectionTypeDWARFAppleNames;
602 else if (apple_name.equals("namespac") || apple_name.equals("namespaces"))
603 sect_type = lldb::eSectionTypeDWARFAppleNamespaces;
606 if (apple_name.equals("types"))
607 sect_type = lldb::eSectionTypeDWARFAppleTypes;
610 if (apple_name.equals("objc"))
611 sect_type = lldb::eSectionTypeDWARFAppleObjC;
617 sect_type = lldb::eSectionTypeInvalid;
619 } else if (name.equals("__objc_imageinfo"))
620 sect_type = lldb::eSectionTypeOther;
625 uint8_t *IRExecutionUnit::MemoryManager::allocateCodeSection(
626 uintptr_t Size, unsigned Alignment, unsigned SectionID,
627 llvm::StringRef SectionName) {
628 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_EXPRESSIONS));
630 uint8_t *return_value = m_default_mm_ap->allocateCodeSection(
631 Size, Alignment, SectionID, SectionName);
633 m_parent.m_records.push_back(AllocationRecord(
634 (uintptr_t)return_value,
635 lldb::ePermissionsReadable | lldb::ePermissionsExecutable,
636 GetSectionTypeFromSectionName(SectionName, AllocationKind::Code), Size,
637 Alignment, SectionID, SectionName.str().c_str()));
640 log->Printf("IRExecutionUnit::allocateCodeSection(Size=0x%" PRIx64
641 ", Alignment=%u, SectionID=%u) = %p",
642 (uint64_t)Size, Alignment, SectionID, (void *)return_value);
645 if (m_parent.m_reported_allocations) {
647 lldb::ProcessSP process_sp =
648 m_parent.GetBestExecutionContextScope()->CalculateProcess();
650 m_parent.CommitOneAllocation(process_sp, err, m_parent.m_records.back());
656 uint8_t *IRExecutionUnit::MemoryManager::allocateDataSection(
657 uintptr_t Size, unsigned Alignment, unsigned SectionID,
658 llvm::StringRef SectionName, bool IsReadOnly) {
659 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_EXPRESSIONS));
661 uint8_t *return_value = m_default_mm_ap->allocateDataSection(
662 Size, Alignment, SectionID, SectionName, IsReadOnly);
664 uint32_t permissions = lldb::ePermissionsReadable;
666 permissions |= lldb::ePermissionsWritable;
667 m_parent.m_records.push_back(AllocationRecord(
668 (uintptr_t)return_value, permissions,
669 GetSectionTypeFromSectionName(SectionName, AllocationKind::Data), Size,
670 Alignment, SectionID, SectionName.str().c_str()));
672 log->Printf("IRExecutionUnit::allocateDataSection(Size=0x%" PRIx64
673 ", Alignment=%u, SectionID=%u) = %p",
674 (uint64_t)Size, Alignment, SectionID, (void *)return_value);
677 if (m_parent.m_reported_allocations) {
679 lldb::ProcessSP process_sp =
680 m_parent.GetBestExecutionContextScope()->CalculateProcess();
682 m_parent.CommitOneAllocation(process_sp, err, m_parent.m_records.back());
689 FindBestAlternateMangledName(const ConstString &demangled,
690 const lldb::LanguageType &lang_type,
691 const SymbolContext &sym_ctx) {
692 CPlusPlusLanguage::MethodName cpp_name(demangled);
693 std::string scope_qualified_name = cpp_name.GetScopeQualifiedName();
695 if (!scope_qualified_name.size())
696 return ConstString();
698 if (!sym_ctx.module_sp)
699 return ConstString();
701 SymbolVendor *sym_vendor = sym_ctx.module_sp->GetSymbolVendor();
703 return ConstString();
705 lldb_private::SymbolFile *sym_file = sym_vendor->GetSymbolFile();
707 return ConstString();
709 std::vector<ConstString> alternates;
710 sym_file->GetMangledNamesForFunction(scope_qualified_name, alternates);
712 std::vector<ConstString> param_and_qual_matches;
713 std::vector<ConstString> param_matches;
714 for (size_t i = 0; i < alternates.size(); i++) {
715 ConstString alternate_mangled_name = alternates[i];
716 Mangled mangled(alternate_mangled_name, true);
717 ConstString demangled = mangled.GetDemangledName(lang_type);
719 CPlusPlusLanguage::MethodName alternate_cpp_name(demangled);
720 if (!cpp_name.IsValid())
723 if (alternate_cpp_name.GetArguments() == cpp_name.GetArguments()) {
724 if (alternate_cpp_name.GetQualifiers() == cpp_name.GetQualifiers())
725 param_and_qual_matches.push_back(alternate_mangled_name);
727 param_matches.push_back(alternate_mangled_name);
731 if (param_and_qual_matches.size())
732 return param_and_qual_matches[0]; // It is assumed that there will be only
734 else if (param_matches.size())
735 return param_matches[0]; // Return one of them as a best match
737 return ConstString();
740 struct IRExecutionUnit::SearchSpec {
744 SearchSpec(ConstString n, uint32_t m = lldb::eFunctionNameTypeFull)
745 : name(n), mask(m) {}
748 void IRExecutionUnit::CollectCandidateCNames(
749 std::vector<IRExecutionUnit::SearchSpec> &C_specs,
750 const ConstString &name) {
751 if (m_strip_underscore && name.AsCString()[0] == '_')
752 C_specs.insert(C_specs.begin(), ConstString(&name.AsCString()[1]));
753 C_specs.push_back(SearchSpec(name));
756 void IRExecutionUnit::CollectCandidateCPlusPlusNames(
757 std::vector<IRExecutionUnit::SearchSpec> &CPP_specs,
758 const std::vector<SearchSpec> &C_specs, const SymbolContext &sc) {
759 for (const SearchSpec &C_spec : C_specs) {
760 const ConstString &name = C_spec.name;
762 if (CPlusPlusLanguage::IsCPPMangledName(name.GetCString())) {
763 Mangled mangled(name, true);
764 ConstString demangled =
765 mangled.GetDemangledName(lldb::eLanguageTypeC_plus_plus);
768 ConstString best_alternate_mangled_name = FindBestAlternateMangledName(
769 demangled, lldb::eLanguageTypeC_plus_plus, sc);
771 if (best_alternate_mangled_name) {
772 CPP_specs.push_back(best_alternate_mangled_name);
775 CPP_specs.push_back(SearchSpec(demangled, lldb::eFunctionNameTypeFull));
779 std::set<ConstString> alternates;
780 CPlusPlusLanguage::FindAlternateFunctionManglings(name, alternates);
781 CPP_specs.insert(CPP_specs.end(), alternates.begin(), alternates.end());
785 void IRExecutionUnit::CollectFallbackNames(
786 std::vector<SearchSpec> &fallback_specs,
787 const std::vector<SearchSpec> &C_specs) {
788 // As a last-ditch fallback, try the base name for C++ names. It's terrible,
789 // but the DWARF doesn't always encode "extern C" correctly.
791 for (const SearchSpec &C_spec : C_specs) {
792 const ConstString &name = C_spec.name;
794 if (CPlusPlusLanguage::IsCPPMangledName(name.GetCString())) {
795 Mangled mangled_name(name);
796 ConstString demangled_name =
797 mangled_name.GetDemangledName(lldb::eLanguageTypeC_plus_plus);
798 if (!demangled_name.IsEmpty()) {
799 const char *demangled_cstr = demangled_name.AsCString();
800 const char *lparen_loc = strchr(demangled_cstr, '(');
802 llvm::StringRef base_name(demangled_cstr,
803 lparen_loc - demangled_cstr);
804 fallback_specs.push_back(ConstString(base_name));
811 lldb::addr_t IRExecutionUnit::FindInSymbols(
812 const std::vector<IRExecutionUnit::SearchSpec> &specs,
813 const lldb_private::SymbolContext &sc) {
814 Target *target = sc.target_sp.get();
817 // we shouldn't be doing any symbol lookup at all without a target
818 return LLDB_INVALID_ADDRESS;
821 for (const SearchSpec &spec : specs) {
822 SymbolContextList sc_list;
824 lldb::addr_t best_internal_load_address = LLDB_INVALID_ADDRESS;
826 std::function<bool(lldb::addr_t &, SymbolContextList &,
827 const lldb_private::SymbolContext &)>
828 get_external_load_address = [&best_internal_load_address, target](
829 lldb::addr_t &load_address, SymbolContextList &sc_list,
830 const lldb_private::SymbolContext &sc) -> lldb::addr_t {
831 load_address = LLDB_INVALID_ADDRESS;
833 for (size_t si = 0, se = sc_list.GetSize(); si < se; ++si) {
834 SymbolContext candidate_sc;
836 sc_list.GetContextAtIndex(si, candidate_sc);
838 const bool is_external =
839 (candidate_sc.function) ||
840 (candidate_sc.symbol && candidate_sc.symbol->IsExternal());
841 if (candidate_sc.symbol) {
842 load_address = candidate_sc.symbol->ResolveCallableAddress(*target);
844 if (load_address == LLDB_INVALID_ADDRESS) {
845 if (target->GetProcessSP())
847 candidate_sc.symbol->GetAddress().GetLoadAddress(target);
849 load_address = candidate_sc.symbol->GetAddress().GetFileAddress();
853 if (load_address == LLDB_INVALID_ADDRESS && candidate_sc.function) {
854 if (target->GetProcessSP())
855 load_address = candidate_sc.function->GetAddressRange()
857 .GetLoadAddress(target);
859 load_address = candidate_sc.function->GetAddressRange()
864 if (load_address != LLDB_INVALID_ADDRESS) {
867 } else if (best_internal_load_address == LLDB_INVALID_ADDRESS) {
868 best_internal_load_address = load_address;
869 load_address = LLDB_INVALID_ADDRESS;
878 sc.module_sp->FindFunctions(spec.name, NULL, spec.mask,
879 true, // include_symbols
880 false, // include_inlines
885 lldb::addr_t load_address = LLDB_INVALID_ADDRESS;
887 if (get_external_load_address(load_address, sc_list, sc)) {
893 if (sc_list.GetSize() == 0 && sc.target_sp) {
894 sc.target_sp->GetImages().FindFunctions(spec.name, spec.mask,
895 true, // include_symbols
896 false, // include_inlines
901 if (get_external_load_address(load_address, sc_list, sc)) {
907 if (sc_list.GetSize() == 0 && sc.target_sp) {
908 sc.target_sp->GetImages().FindSymbolsWithNameAndType(
909 spec.name, lldb::eSymbolTypeAny, sc_list);
912 if (get_external_load_address(load_address, sc_list, sc)) {
915 // if there are any searches we try after this, add an sc_list.Clear() in an
916 // "else" clause here
918 if (best_internal_load_address != LLDB_INVALID_ADDRESS) {
919 return best_internal_load_address;
923 return LLDB_INVALID_ADDRESS;
927 IRExecutionUnit::FindInRuntimes(const std::vector<SearchSpec> &specs,
928 const lldb_private::SymbolContext &sc) {
929 lldb::TargetSP target_sp = sc.target_sp;
932 return LLDB_INVALID_ADDRESS;
935 lldb::ProcessSP process_sp = sc.target_sp->GetProcessSP();
938 return LLDB_INVALID_ADDRESS;
941 ObjCLanguageRuntime *runtime = process_sp->GetObjCLanguageRuntime();
944 for (const SearchSpec &spec : specs) {
945 lldb::addr_t symbol_load_addr = runtime->LookupRuntimeSymbol(spec.name);
947 if (symbol_load_addr != LLDB_INVALID_ADDRESS)
948 return symbol_load_addr;
952 return LLDB_INVALID_ADDRESS;
955 lldb::addr_t IRExecutionUnit::FindInUserDefinedSymbols(
956 const std::vector<SearchSpec> &specs,
957 const lldb_private::SymbolContext &sc) {
958 lldb::TargetSP target_sp = sc.target_sp;
960 for (const SearchSpec &spec : specs) {
961 lldb::addr_t symbol_load_addr = target_sp->GetPersistentSymbol(spec.name);
963 if (symbol_load_addr != LLDB_INVALID_ADDRESS)
964 return symbol_load_addr;
967 return LLDB_INVALID_ADDRESS;
971 IRExecutionUnit::FindSymbol(const lldb_private::ConstString &name) {
972 std::vector<SearchSpec> candidate_C_names;
973 std::vector<SearchSpec> candidate_CPlusPlus_names;
975 CollectCandidateCNames(candidate_C_names, name);
977 lldb::addr_t ret = FindInSymbols(candidate_C_names, m_sym_ctx);
978 if (ret == LLDB_INVALID_ADDRESS)
979 ret = FindInRuntimes(candidate_C_names, m_sym_ctx);
981 if (ret == LLDB_INVALID_ADDRESS)
982 ret = FindInUserDefinedSymbols(candidate_C_names, m_sym_ctx);
984 if (ret == LLDB_INVALID_ADDRESS) {
985 CollectCandidateCPlusPlusNames(candidate_CPlusPlus_names, candidate_C_names,
987 ret = FindInSymbols(candidate_CPlusPlus_names, m_sym_ctx);
990 if (ret == LLDB_INVALID_ADDRESS) {
991 std::vector<SearchSpec> candidate_fallback_names;
993 CollectFallbackNames(candidate_fallback_names, candidate_C_names);
994 ret = FindInSymbols(candidate_fallback_names, m_sym_ctx);
1000 void IRExecutionUnit::GetStaticInitializers(
1001 std::vector<lldb::addr_t> &static_initializers) {
1002 if (llvm::GlobalVariable *global_ctors =
1003 m_module->getNamedGlobal("llvm.global_ctors")) {
1004 if (llvm::ConstantArray *ctor_array = llvm::dyn_cast<llvm::ConstantArray>(
1005 global_ctors->getInitializer())) {
1006 for (llvm::Use &ctor_use : ctor_array->operands()) {
1007 if (llvm::ConstantStruct *ctor_struct =
1008 llvm::dyn_cast<llvm::ConstantStruct>(ctor_use)) {
1009 lldbassert(ctor_struct->getNumOperands() ==
1010 3); // this is standardized
1011 if (llvm::Function *ctor_function =
1012 llvm::dyn_cast<llvm::Function>(ctor_struct->getOperand(1))) {
1013 ConstString ctor_function_name_cs(ctor_function->getName().str());
1015 for (JittedFunction &jitted_function : m_jitted_functions) {
1016 if (ctor_function_name_cs == jitted_function.m_name) {
1017 if (jitted_function.m_remote_addr != LLDB_INVALID_ADDRESS) {
1018 static_initializers.push_back(jitted_function.m_remote_addr);
1031 IRExecutionUnit::MemoryManager::getSymbolAddress(const std::string &Name) {
1032 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_EXPRESSIONS));
1034 ConstString name_cs(Name.c_str());
1036 lldb::addr_t ret = m_parent.FindSymbol(name_cs);
1038 if (ret == LLDB_INVALID_ADDRESS) {
1041 "IRExecutionUnit::getSymbolAddress(Name=\"%s\") = <not found>",
1044 m_parent.ReportSymbolLookupError(name_cs);
1048 log->Printf("IRExecutionUnit::getSymbolAddress(Name=\"%s\") = %" PRIx64,
1054 void *IRExecutionUnit::MemoryManager::getPointerToNamedFunction(
1055 const std::string &Name, bool AbortOnFailure) {
1056 assert(sizeof(void *) == 8);
1058 return (void *)getSymbolAddress(Name);
1062 IRExecutionUnit::GetRemoteAddressForLocal(lldb::addr_t local_address) {
1063 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_EXPRESSIONS));
1065 for (AllocationRecord &record : m_records) {
1066 if (local_address >= record.m_host_address &&
1067 local_address < record.m_host_address + record.m_size) {
1068 if (record.m_process_address == LLDB_INVALID_ADDRESS)
1069 return LLDB_INVALID_ADDRESS;
1072 record.m_process_address + (local_address - record.m_host_address);
1076 "IRExecutionUnit::GetRemoteAddressForLocal() found 0x%" PRIx64
1077 " in [0x%" PRIx64 "..0x%" PRIx64 "], and returned 0x%" PRIx64
1078 " from [0x%" PRIx64 "..0x%" PRIx64 "].",
1079 local_address, (uint64_t)record.m_host_address,
1080 (uint64_t)record.m_host_address + (uint64_t)record.m_size, ret,
1081 record.m_process_address, record.m_process_address + record.m_size);
1088 return LLDB_INVALID_ADDRESS;
1091 IRExecutionUnit::AddrRange
1092 IRExecutionUnit::GetRemoteRangeForLocal(lldb::addr_t local_address) {
1093 for (AllocationRecord &record : m_records) {
1094 if (local_address >= record.m_host_address &&
1095 local_address < record.m_host_address + record.m_size) {
1096 if (record.m_process_address == LLDB_INVALID_ADDRESS)
1097 return AddrRange(0, 0);
1099 return AddrRange(record.m_process_address, record.m_size);
1103 return AddrRange(0, 0);
1106 bool IRExecutionUnit::CommitOneAllocation(lldb::ProcessSP &process_sp,
1108 AllocationRecord &record) {
1109 if (record.m_process_address != LLDB_INVALID_ADDRESS) {
1113 switch (record.m_sect_type) {
1114 case lldb::eSectionTypeInvalid:
1115 case lldb::eSectionTypeDWARFDebugAbbrev:
1116 case lldb::eSectionTypeDWARFDebugAddr:
1117 case lldb::eSectionTypeDWARFDebugAranges:
1118 case lldb::eSectionTypeDWARFDebugFrame:
1119 case lldb::eSectionTypeDWARFDebugInfo:
1120 case lldb::eSectionTypeDWARFDebugLine:
1121 case lldb::eSectionTypeDWARFDebugLoc:
1122 case lldb::eSectionTypeDWARFDebugMacInfo:
1123 case lldb::eSectionTypeDWARFDebugPubNames:
1124 case lldb::eSectionTypeDWARFDebugPubTypes:
1125 case lldb::eSectionTypeDWARFDebugRanges:
1126 case lldb::eSectionTypeDWARFDebugStr:
1127 case lldb::eSectionTypeDWARFDebugStrOffsets:
1128 case lldb::eSectionTypeDWARFAppleNames:
1129 case lldb::eSectionTypeDWARFAppleTypes:
1130 case lldb::eSectionTypeDWARFAppleNamespaces:
1131 case lldb::eSectionTypeDWARFAppleObjC:
1135 const bool zero_memory = false;
1136 record.m_process_address =
1137 Malloc(record.m_size, record.m_alignment, record.m_permissions,
1138 eAllocationPolicyProcessOnly, zero_memory, error);
1142 return error.Success();
1145 bool IRExecutionUnit::CommitAllocations(lldb::ProcessSP &process_sp) {
1148 lldb_private::Error err;
1150 for (AllocationRecord &record : m_records) {
1151 ret = CommitOneAllocation(process_sp, err, record);
1159 for (AllocationRecord &record : m_records) {
1160 if (record.m_process_address != LLDB_INVALID_ADDRESS) {
1161 Free(record.m_process_address, err);
1162 record.m_process_address = LLDB_INVALID_ADDRESS;
1170 void IRExecutionUnit::ReportAllocations(llvm::ExecutionEngine &engine) {
1171 m_reported_allocations = true;
1173 for (AllocationRecord &record : m_records) {
1174 if (record.m_process_address == LLDB_INVALID_ADDRESS)
1177 if (record.m_section_id == eSectionIDInvalid)
1180 engine.mapSectionAddress((void *)record.m_host_address,
1181 record.m_process_address);
1184 // Trigger re-application of relocations.
1185 engine.finalizeObject();
1188 bool IRExecutionUnit::WriteData(lldb::ProcessSP &process_sp) {
1189 bool wrote_something = false;
1190 for (AllocationRecord &record : m_records) {
1191 if (record.m_process_address != LLDB_INVALID_ADDRESS) {
1192 lldb_private::Error err;
1193 WriteMemory(record.m_process_address, (uint8_t *)record.m_host_address,
1194 record.m_size, err);
1196 wrote_something = true;
1199 return wrote_something;
1202 void IRExecutionUnit::AllocationRecord::dump(Log *log) {
1206 log->Printf("[0x%llx+0x%llx]->0x%llx (alignment %d, section ID %d, name %s)",
1207 (unsigned long long)m_host_address, (unsigned long long)m_size,
1208 (unsigned long long)m_process_address, (unsigned)m_alignment,
1209 (unsigned)m_section_id, m_name.c_str());
1212 lldb::ByteOrder IRExecutionUnit::GetByteOrder() const {
1213 ExecutionContext exe_ctx(GetBestExecutionContextScope());
1214 return exe_ctx.GetByteOrder();
1217 uint32_t IRExecutionUnit::GetAddressByteSize() const {
1218 ExecutionContext exe_ctx(GetBestExecutionContextScope());
1219 return exe_ctx.GetAddressByteSize();
1222 void IRExecutionUnit::PopulateSymtab(lldb_private::ObjectFile *obj_file,
1223 lldb_private::Symtab &symtab) {
1224 // No symbols yet...
1227 void IRExecutionUnit::PopulateSectionList(
1228 lldb_private::ObjectFile *obj_file,
1229 lldb_private::SectionList §ion_list) {
1230 for (AllocationRecord &record : m_records) {
1231 if (record.m_size > 0) {
1232 lldb::SectionSP section_sp(new lldb_private::Section(
1233 obj_file->GetModule(), obj_file, record.m_section_id,
1234 ConstString(record.m_name), record.m_sect_type,
1235 record.m_process_address, record.m_size,
1236 record.m_host_address, // file_offset (which is the host address for
1238 record.m_size, // file_size
1240 record.m_permissions)); // flags
1241 section_list.AddSection(section_sp);
1246 bool IRExecutionUnit::GetArchitecture(lldb_private::ArchSpec &arch) {
1247 ExecutionContext exe_ctx(GetBestExecutionContextScope());
1248 Target *target = exe_ctx.GetTargetPtr();
1250 arch = target->GetArchitecture();
1253 return arch.IsValid();
1256 lldb::ModuleSP IRExecutionUnit::GetJITModule() {
1257 ExecutionContext exe_ctx(GetBestExecutionContextScope());
1258 Target *target = exe_ctx.GetTargetPtr();
1260 lldb::ModuleSP jit_module_sp = lldb_private::Module::CreateJITModule(
1261 std::static_pointer_cast<lldb_private::ObjectFileJITDelegate>(
1262 shared_from_this()));
1263 if (jit_module_sp) {
1264 bool changed = false;
1265 jit_module_sp->SetLoadAddress(*target, 0, true, changed);
1267 return jit_module_sp;
1269 return lldb::ModuleSP();