15ffd83dbSDimitry Andric //===-- JITLoaderGDB.cpp --------------------------------------------------===//
20b57cec5SDimitry Andric //
30b57cec5SDimitry Andric // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
40b57cec5SDimitry Andric // See https://llvm.org/LICENSE.txt for license information.
50b57cec5SDimitry Andric // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
60b57cec5SDimitry Andric //
70b57cec5SDimitry Andric //===----------------------------------------------------------------------===//
80b57cec5SDimitry Andric
99dba64beSDimitry Andric #include "JITLoaderGDB.h"
10580012d6SDimitry Andric #ifdef LLDB_ENABLE_ALL
119dba64beSDimitry Andric #include "Plugins/ObjectFile/Mach-O/ObjectFileMachO.h"
12580012d6SDimitry Andric #endif // LLDB_ENABLE_ALL
130b57cec5SDimitry Andric #include "lldb/Breakpoint/Breakpoint.h"
140b57cec5SDimitry Andric #include "lldb/Core/Module.h"
150b57cec5SDimitry Andric #include "lldb/Core/ModuleSpec.h"
160b57cec5SDimitry Andric #include "lldb/Core/PluginManager.h"
170b57cec5SDimitry Andric #include "lldb/Core/Section.h"
180b57cec5SDimitry Andric #include "lldb/Interpreter/OptionValueProperties.h"
190b57cec5SDimitry Andric #include "lldb/Symbol/ObjectFile.h"
200b57cec5SDimitry Andric #include "lldb/Symbol/Symbol.h"
210b57cec5SDimitry Andric #include "lldb/Symbol/SymbolContext.h"
220b57cec5SDimitry Andric #include "lldb/Symbol/SymbolVendor.h"
230b57cec5SDimitry Andric #include "lldb/Target/Process.h"
240b57cec5SDimitry Andric #include "lldb/Target/SectionLoadList.h"
250b57cec5SDimitry Andric #include "lldb/Target/Target.h"
260b57cec5SDimitry Andric #include "lldb/Utility/DataBufferHeap.h"
270b57cec5SDimitry Andric #include "lldb/Utility/LLDBAssert.h"
2881ad6265SDimitry Andric #include "lldb/Utility/LLDBLog.h"
290b57cec5SDimitry Andric #include "lldb/Utility/Log.h"
300b57cec5SDimitry Andric #include "lldb/Utility/StreamString.h"
319dba64beSDimitry Andric #include "llvm/Support/MathExtras.h"
320b57cec5SDimitry Andric
330b57cec5SDimitry Andric #include <memory>
340b57cec5SDimitry Andric
350b57cec5SDimitry Andric using namespace lldb;
360b57cec5SDimitry Andric using namespace lldb_private;
370b57cec5SDimitry Andric
385ffd83dbSDimitry Andric LLDB_PLUGIN_DEFINE(JITLoaderGDB)
395ffd83dbSDimitry Andric
401db9f3b2SDimitry Andric namespace {
410b57cec5SDimitry Andric // Debug Interface Structures
420b57cec5SDimitry Andric enum jit_actions_t { JIT_NOACTION = 0, JIT_REGISTER_FN, JIT_UNREGISTER_FN };
430b57cec5SDimitry Andric
440b57cec5SDimitry Andric template <typename ptr_t> struct jit_code_entry {
450b57cec5SDimitry Andric ptr_t next_entry; // pointer
460b57cec5SDimitry Andric ptr_t prev_entry; // pointer
470b57cec5SDimitry Andric ptr_t symfile_addr; // pointer
480b57cec5SDimitry Andric uint64_t symfile_size;
490b57cec5SDimitry Andric };
500b57cec5SDimitry Andric
510b57cec5SDimitry Andric template <typename ptr_t> struct jit_descriptor {
520b57cec5SDimitry Andric uint32_t version;
530b57cec5SDimitry Andric uint32_t action_flag; // Values are jit_action_t
540b57cec5SDimitry Andric ptr_t relevant_entry; // pointer
550b57cec5SDimitry Andric ptr_t first_entry; // pointer
560b57cec5SDimitry Andric };
570b57cec5SDimitry Andric
580b57cec5SDimitry Andric enum EnableJITLoaderGDB {
590b57cec5SDimitry Andric eEnableJITLoaderGDBDefault,
600b57cec5SDimitry Andric eEnableJITLoaderGDBOn,
610b57cec5SDimitry Andric eEnableJITLoaderGDBOff,
620b57cec5SDimitry Andric };
630b57cec5SDimitry Andric
649dba64beSDimitry Andric static constexpr OptionEnumValueElement g_enable_jit_loader_gdb_enumerators[] =
659dba64beSDimitry Andric {
669dba64beSDimitry Andric {
679dba64beSDimitry Andric eEnableJITLoaderGDBDefault,
689dba64beSDimitry Andric "default",
699dba64beSDimitry Andric "Enable JIT compilation interface for all platforms except macOS",
709dba64beSDimitry Andric },
719dba64beSDimitry Andric {
729dba64beSDimitry Andric eEnableJITLoaderGDBOn,
739dba64beSDimitry Andric "on",
749dba64beSDimitry Andric "Enable JIT compilation interface",
759dba64beSDimitry Andric },
769dba64beSDimitry Andric {
779dba64beSDimitry Andric eEnableJITLoaderGDBOff,
789dba64beSDimitry Andric "off",
799dba64beSDimitry Andric "Disable JIT compilation interface",
809dba64beSDimitry Andric },
810b57cec5SDimitry Andric };
820b57cec5SDimitry Andric
839dba64beSDimitry Andric #define LLDB_PROPERTIES_jitloadergdb
849dba64beSDimitry Andric #include "JITLoaderGDBProperties.inc"
850b57cec5SDimitry Andric
869dba64beSDimitry Andric enum {
879dba64beSDimitry Andric #define LLDB_PROPERTIES_jitloadergdb
889dba64beSDimitry Andric #include "JITLoaderGDBPropertiesEnum.inc"
899dba64beSDimitry Andric ePropertyEnableJITBreakpoint
909dba64beSDimitry Andric };
910b57cec5SDimitry Andric
920b57cec5SDimitry Andric class PluginProperties : public Properties {
930b57cec5SDimitry Andric public:
GetSettingName()945f757f3fSDimitry Andric static llvm::StringRef GetSettingName() {
955f757f3fSDimitry Andric return JITLoaderGDB::GetPluginNameStatic();
960b57cec5SDimitry Andric }
970b57cec5SDimitry Andric
PluginProperties()980b57cec5SDimitry Andric PluginProperties() {
990b57cec5SDimitry Andric m_collection_sp = std::make_shared<OptionValueProperties>(GetSettingName());
1009dba64beSDimitry Andric m_collection_sp->Initialize(g_jitloadergdb_properties);
1010b57cec5SDimitry Andric }
1020b57cec5SDimitry Andric
GetEnable() const1030b57cec5SDimitry Andric EnableJITLoaderGDB GetEnable() const {
10406c3fb27SDimitry Andric return GetPropertyAtIndexAs<EnableJITLoaderGDB>(
10506c3fb27SDimitry Andric ePropertyEnable,
10606c3fb27SDimitry Andric static_cast<EnableJITLoaderGDB>(
10706c3fb27SDimitry Andric g_jitloadergdb_properties[ePropertyEnable].default_uint_value));
1080b57cec5SDimitry Andric }
1090b57cec5SDimitry Andric };
110bdd1243dSDimitry Andric } // namespace
1110b57cec5SDimitry Andric
GetGlobalPluginProperties()112349cc55cSDimitry Andric static PluginProperties &GetGlobalPluginProperties() {
113349cc55cSDimitry Andric static PluginProperties g_settings;
114349cc55cSDimitry Andric return g_settings;
1150b57cec5SDimitry Andric }
1160b57cec5SDimitry Andric
1170b57cec5SDimitry Andric template <typename ptr_t>
ReadJITEntry(const addr_t from_addr,Process * process,jit_code_entry<ptr_t> * entry)118bdd1243dSDimitry Andric static bool ReadJITEntry(const addr_t from_addr, Process *process,
1190b57cec5SDimitry Andric jit_code_entry<ptr_t> *entry) {
1200b57cec5SDimitry Andric lldbassert(from_addr % sizeof(ptr_t) == 0);
1210b57cec5SDimitry Andric
1220b57cec5SDimitry Andric ArchSpec::Core core = process->GetTarget().GetArchitecture().GetCore();
1230b57cec5SDimitry Andric bool i386_target = ArchSpec::kCore_x86_32_first <= core &&
1240b57cec5SDimitry Andric core <= ArchSpec::kCore_x86_32_last;
1250b57cec5SDimitry Andric uint8_t uint64_align_bytes = i386_target ? 4 : 8;
1260b57cec5SDimitry Andric const size_t data_byte_size =
1270b57cec5SDimitry Andric llvm::alignTo(sizeof(ptr_t) * 3, uint64_align_bytes) + sizeof(uint64_t);
1280b57cec5SDimitry Andric
1290b57cec5SDimitry Andric Status error;
1300b57cec5SDimitry Andric DataBufferHeap data(data_byte_size, 0);
1310b57cec5SDimitry Andric size_t bytes_read = process->ReadMemory(from_addr, data.GetBytes(),
1320b57cec5SDimitry Andric data.GetByteSize(), error);
1330b57cec5SDimitry Andric if (bytes_read != data_byte_size || !error.Success())
1340b57cec5SDimitry Andric return false;
1350b57cec5SDimitry Andric
1360b57cec5SDimitry Andric DataExtractor extractor(data.GetBytes(), data.GetByteSize(),
1370b57cec5SDimitry Andric process->GetByteOrder(), sizeof(ptr_t));
1380b57cec5SDimitry Andric lldb::offset_t offset = 0;
1395ffd83dbSDimitry Andric entry->next_entry = extractor.GetAddress(&offset);
1405ffd83dbSDimitry Andric entry->prev_entry = extractor.GetAddress(&offset);
1415ffd83dbSDimitry Andric entry->symfile_addr = extractor.GetAddress(&offset);
1420b57cec5SDimitry Andric offset = llvm::alignTo(offset, uint64_align_bytes);
1430b57cec5SDimitry Andric entry->symfile_size = extractor.GetU64(&offset);
1440b57cec5SDimitry Andric
1450b57cec5SDimitry Andric return true;
1460b57cec5SDimitry Andric }
1470b57cec5SDimitry Andric
JITLoaderGDB(lldb_private::Process * process)1480b57cec5SDimitry Andric JITLoaderGDB::JITLoaderGDB(lldb_private::Process *process)
1490b57cec5SDimitry Andric : JITLoader(process), m_jit_objects(),
1500b57cec5SDimitry Andric m_jit_break_id(LLDB_INVALID_BREAK_ID),
1510b57cec5SDimitry Andric m_jit_descriptor_addr(LLDB_INVALID_ADDRESS) {}
1520b57cec5SDimitry Andric
~JITLoaderGDB()1530b57cec5SDimitry Andric JITLoaderGDB::~JITLoaderGDB() {
1540b57cec5SDimitry Andric if (LLDB_BREAK_ID_IS_VALID(m_jit_break_id))
1550b57cec5SDimitry Andric m_process->GetTarget().RemoveBreakpointByID(m_jit_break_id);
1560b57cec5SDimitry Andric }
1570b57cec5SDimitry Andric
DebuggerInitialize(Debugger & debugger)1580b57cec5SDimitry Andric void JITLoaderGDB::DebuggerInitialize(Debugger &debugger) {
1590b57cec5SDimitry Andric if (!PluginManager::GetSettingForJITLoaderPlugin(
1600b57cec5SDimitry Andric debugger, PluginProperties::GetSettingName())) {
1610b57cec5SDimitry Andric const bool is_global_setting = true;
1620b57cec5SDimitry Andric PluginManager::CreateSettingForJITLoaderPlugin(
163349cc55cSDimitry Andric debugger, GetGlobalPluginProperties().GetValueProperties(),
16406c3fb27SDimitry Andric "Properties for the JIT LoaderGDB plug-in.", is_global_setting);
1650b57cec5SDimitry Andric }
1660b57cec5SDimitry Andric }
1670b57cec5SDimitry Andric
DidAttach()1680b57cec5SDimitry Andric void JITLoaderGDB::DidAttach() {
1690b57cec5SDimitry Andric Target &target = m_process->GetTarget();
1700b57cec5SDimitry Andric ModuleList &module_list = target.GetImages();
1710b57cec5SDimitry Andric SetJITBreakpoint(module_list);
1720b57cec5SDimitry Andric }
1730b57cec5SDimitry Andric
DidLaunch()1740b57cec5SDimitry Andric void JITLoaderGDB::DidLaunch() {
1750b57cec5SDimitry Andric Target &target = m_process->GetTarget();
1760b57cec5SDimitry Andric ModuleList &module_list = target.GetImages();
1770b57cec5SDimitry Andric SetJITBreakpoint(module_list);
1780b57cec5SDimitry Andric }
1790b57cec5SDimitry Andric
ModulesDidLoad(ModuleList & module_list)1800b57cec5SDimitry Andric void JITLoaderGDB::ModulesDidLoad(ModuleList &module_list) {
1810b57cec5SDimitry Andric if (!DidSetJITBreakpoint() && m_process->IsAlive())
1820b57cec5SDimitry Andric SetJITBreakpoint(module_list);
1830b57cec5SDimitry Andric }
1840b57cec5SDimitry Andric
1850b57cec5SDimitry Andric // Setup the JIT Breakpoint
SetJITBreakpoint(lldb_private::ModuleList & module_list)1860b57cec5SDimitry Andric void JITLoaderGDB::SetJITBreakpoint(lldb_private::ModuleList &module_list) {
1870b57cec5SDimitry Andric if (DidSetJITBreakpoint())
1880b57cec5SDimitry Andric return;
1890b57cec5SDimitry Andric
19081ad6265SDimitry Andric Log *log = GetLog(LLDBLog::JITLoader);
1919dba64beSDimitry Andric LLDB_LOGF(log, "JITLoaderGDB::%s looking for JIT register hook",
1929dba64beSDimitry Andric __FUNCTION__);
1930b57cec5SDimitry Andric
1940b57cec5SDimitry Andric addr_t jit_addr = GetSymbolAddress(
195bdd1243dSDimitry Andric module_list, ConstString("__jit_debug_register_code"), eSymbolTypeCode);
1960b57cec5SDimitry Andric if (jit_addr == LLDB_INVALID_ADDRESS)
1970b57cec5SDimitry Andric return;
1980b57cec5SDimitry Andric
1990b57cec5SDimitry Andric m_jit_descriptor_addr = GetSymbolAddress(
2000b57cec5SDimitry Andric module_list, ConstString("__jit_debug_descriptor"), eSymbolTypeData);
2010b57cec5SDimitry Andric if (m_jit_descriptor_addr == LLDB_INVALID_ADDRESS) {
2029dba64beSDimitry Andric LLDB_LOGF(log, "JITLoaderGDB::%s failed to find JIT descriptor address",
2030b57cec5SDimitry Andric __FUNCTION__);
2040b57cec5SDimitry Andric return;
2050b57cec5SDimitry Andric }
2060b57cec5SDimitry Andric
2079dba64beSDimitry Andric LLDB_LOGF(log, "JITLoaderGDB::%s setting JIT breakpoint", __FUNCTION__);
2080b57cec5SDimitry Andric
2090b57cec5SDimitry Andric Breakpoint *bp =
2100b57cec5SDimitry Andric m_process->GetTarget().CreateBreakpoint(jit_addr, true, false).get();
2110b57cec5SDimitry Andric bp->SetCallback(JITDebugBreakpointHit, this, true);
2120b57cec5SDimitry Andric bp->SetBreakpointKind("jit-debug-register");
2130b57cec5SDimitry Andric m_jit_break_id = bp->GetID();
2140b57cec5SDimitry Andric
2150b57cec5SDimitry Andric ReadJITDescriptor(true);
2160b57cec5SDimitry Andric }
2170b57cec5SDimitry Andric
JITDebugBreakpointHit(void * baton,StoppointCallbackContext * context,user_id_t break_id,user_id_t break_loc_id)2180b57cec5SDimitry Andric bool JITLoaderGDB::JITDebugBreakpointHit(void *baton,
2190b57cec5SDimitry Andric StoppointCallbackContext *context,
2200b57cec5SDimitry Andric user_id_t break_id,
2210b57cec5SDimitry Andric user_id_t break_loc_id) {
22281ad6265SDimitry Andric Log *log = GetLog(LLDBLog::JITLoader);
2239dba64beSDimitry Andric LLDB_LOGF(log, "JITLoaderGDB::%s hit JIT breakpoint", __FUNCTION__);
2240b57cec5SDimitry Andric JITLoaderGDB *instance = static_cast<JITLoaderGDB *>(baton);
2250b57cec5SDimitry Andric return instance->ReadJITDescriptor(false);
2260b57cec5SDimitry Andric }
2270b57cec5SDimitry Andric
updateSectionLoadAddress(const SectionList & section_list,Target & target,uint64_t symbolfile_addr,uint64_t symbolfile_size,uint64_t & vmaddrheuristic,uint64_t & min_addr,uint64_t & max_addr)2280b57cec5SDimitry Andric static void updateSectionLoadAddress(const SectionList §ion_list,
2290b57cec5SDimitry Andric Target &target, uint64_t symbolfile_addr,
2300b57cec5SDimitry Andric uint64_t symbolfile_size,
2310b57cec5SDimitry Andric uint64_t &vmaddrheuristic,
2320b57cec5SDimitry Andric uint64_t &min_addr, uint64_t &max_addr) {
2330b57cec5SDimitry Andric const uint32_t num_sections = section_list.GetSize();
2340b57cec5SDimitry Andric for (uint32_t i = 0; i < num_sections; ++i) {
2350b57cec5SDimitry Andric SectionSP section_sp(section_list.GetSectionAtIndex(i));
2360b57cec5SDimitry Andric if (section_sp) {
2370b57cec5SDimitry Andric if (section_sp->IsFake()) {
2380b57cec5SDimitry Andric uint64_t lower = (uint64_t)-1;
2390b57cec5SDimitry Andric uint64_t upper = 0;
2400b57cec5SDimitry Andric updateSectionLoadAddress(section_sp->GetChildren(), target,
2410b57cec5SDimitry Andric symbolfile_addr, symbolfile_size,
2420b57cec5SDimitry Andric vmaddrheuristic, lower, upper);
2430b57cec5SDimitry Andric if (lower < min_addr)
2440b57cec5SDimitry Andric min_addr = lower;
2450b57cec5SDimitry Andric if (upper > max_addr)
2460b57cec5SDimitry Andric max_addr = upper;
2470b57cec5SDimitry Andric const lldb::addr_t slide_amount = lower - section_sp->GetFileAddress();
2480b57cec5SDimitry Andric section_sp->Slide(slide_amount, false);
2490b57cec5SDimitry Andric section_sp->GetChildren().Slide(-slide_amount, false);
2500b57cec5SDimitry Andric section_sp->SetByteSize(upper - lower);
2510b57cec5SDimitry Andric } else {
2520b57cec5SDimitry Andric vmaddrheuristic += 2 << section_sp->GetLog2Align();
2530b57cec5SDimitry Andric uint64_t lower;
2540b57cec5SDimitry Andric if (section_sp->GetFileAddress() > vmaddrheuristic)
2550b57cec5SDimitry Andric lower = section_sp->GetFileAddress();
2560b57cec5SDimitry Andric else {
2570b57cec5SDimitry Andric lower = symbolfile_addr + section_sp->GetFileOffset();
2580b57cec5SDimitry Andric section_sp->SetFileAddress(symbolfile_addr +
2590b57cec5SDimitry Andric section_sp->GetFileOffset());
2600b57cec5SDimitry Andric }
2610b57cec5SDimitry Andric target.SetSectionLoadAddress(section_sp, lower, true);
2620b57cec5SDimitry Andric uint64_t upper = lower + section_sp->GetByteSize();
2630b57cec5SDimitry Andric if (lower < min_addr)
2640b57cec5SDimitry Andric min_addr = lower;
2650b57cec5SDimitry Andric if (upper > max_addr)
2660b57cec5SDimitry Andric max_addr = upper;
2670b57cec5SDimitry Andric // This is an upper bound, but a good enough heuristic
2680b57cec5SDimitry Andric vmaddrheuristic += section_sp->GetByteSize();
2690b57cec5SDimitry Andric }
2700b57cec5SDimitry Andric }
2710b57cec5SDimitry Andric }
2720b57cec5SDimitry Andric }
2730b57cec5SDimitry Andric
ReadJITDescriptor(bool all_entries)2740b57cec5SDimitry Andric bool JITLoaderGDB::ReadJITDescriptor(bool all_entries) {
2750b57cec5SDimitry Andric if (m_process->GetTarget().GetArchitecture().GetAddressByteSize() == 8)
2760b57cec5SDimitry Andric return ReadJITDescriptorImpl<uint64_t>(all_entries);
2770b57cec5SDimitry Andric else
2780b57cec5SDimitry Andric return ReadJITDescriptorImpl<uint32_t>(all_entries);
2790b57cec5SDimitry Andric }
2800b57cec5SDimitry Andric
2810b57cec5SDimitry Andric template <typename ptr_t>
ReadJITDescriptorImpl(bool all_entries)2820b57cec5SDimitry Andric bool JITLoaderGDB::ReadJITDescriptorImpl(bool all_entries) {
2830b57cec5SDimitry Andric if (m_jit_descriptor_addr == LLDB_INVALID_ADDRESS)
2840b57cec5SDimitry Andric return false;
2850b57cec5SDimitry Andric
28681ad6265SDimitry Andric Log *log = GetLog(LLDBLog::JITLoader);
2870b57cec5SDimitry Andric Target &target = m_process->GetTarget();
2880b57cec5SDimitry Andric ModuleList &module_list = target.GetImages();
2890b57cec5SDimitry Andric
2900b57cec5SDimitry Andric jit_descriptor<ptr_t> jit_desc;
2910b57cec5SDimitry Andric const size_t jit_desc_size = sizeof(jit_desc);
2920b57cec5SDimitry Andric Status error;
293e8d8bef9SDimitry Andric size_t bytes_read = m_process->ReadMemory(m_jit_descriptor_addr, &jit_desc,
2940b57cec5SDimitry Andric jit_desc_size, error);
2950b57cec5SDimitry Andric if (bytes_read != jit_desc_size || !error.Success()) {
2969dba64beSDimitry Andric LLDB_LOGF(log, "JITLoaderGDB::%s failed to read JIT descriptor",
2970b57cec5SDimitry Andric __FUNCTION__);
2980b57cec5SDimitry Andric return false;
2990b57cec5SDimitry Andric }
3000b57cec5SDimitry Andric
3010b57cec5SDimitry Andric jit_actions_t jit_action = (jit_actions_t)jit_desc.action_flag;
3020b57cec5SDimitry Andric addr_t jit_relevant_entry = (addr_t)jit_desc.relevant_entry;
3030b57cec5SDimitry Andric if (all_entries) {
3040b57cec5SDimitry Andric jit_action = JIT_REGISTER_FN;
3050b57cec5SDimitry Andric jit_relevant_entry = (addr_t)jit_desc.first_entry;
3060b57cec5SDimitry Andric }
3070b57cec5SDimitry Andric
3080b57cec5SDimitry Andric while (jit_relevant_entry != 0) {
3090b57cec5SDimitry Andric jit_code_entry<ptr_t> jit_entry;
3100b57cec5SDimitry Andric if (!ReadJITEntry(jit_relevant_entry, m_process, &jit_entry)) {
3119dba64beSDimitry Andric LLDB_LOGF(log, "JITLoaderGDB::%s failed to read JIT entry at 0x%" PRIx64,
3120b57cec5SDimitry Andric __FUNCTION__, jit_relevant_entry);
3130b57cec5SDimitry Andric return false;
3140b57cec5SDimitry Andric }
3150b57cec5SDimitry Andric
3160b57cec5SDimitry Andric const addr_t &symbolfile_addr = (addr_t)jit_entry.symfile_addr;
3170b57cec5SDimitry Andric const size_t &symbolfile_size = (size_t)jit_entry.symfile_size;
3180b57cec5SDimitry Andric ModuleSP module_sp;
3190b57cec5SDimitry Andric
3200b57cec5SDimitry Andric if (jit_action == JIT_REGISTER_FN) {
3219dba64beSDimitry Andric LLDB_LOGF(log,
3229dba64beSDimitry Andric "JITLoaderGDB::%s registering JIT entry at 0x%" PRIx64
3230b57cec5SDimitry Andric " (%" PRIu64 " bytes)",
3240b57cec5SDimitry Andric __FUNCTION__, symbolfile_addr, (uint64_t)symbolfile_size);
3250b57cec5SDimitry Andric
3260b57cec5SDimitry Andric char jit_name[64];
3270b57cec5SDimitry Andric snprintf(jit_name, 64, "JIT(0x%" PRIx64 ")", symbolfile_addr);
3280b57cec5SDimitry Andric module_sp = m_process->ReadModuleFromMemory(
3290b57cec5SDimitry Andric FileSpec(jit_name), symbolfile_addr, symbolfile_size);
3300b57cec5SDimitry Andric
3310b57cec5SDimitry Andric if (module_sp && module_sp->GetObjectFile()) {
3320b57cec5SDimitry Andric // Object formats (like ELF) have no representation for a JIT type.
3330b57cec5SDimitry Andric // We will get it wrong, if we deduce it from the header.
3340b57cec5SDimitry Andric module_sp->GetObjectFile()->SetType(ObjectFile::eTypeJIT);
3350b57cec5SDimitry Andric
3360b57cec5SDimitry Andric // load the symbol table right away
3370b57cec5SDimitry Andric module_sp->GetObjectFile()->GetSymtab();
3380b57cec5SDimitry Andric
3390b57cec5SDimitry Andric m_jit_objects.insert(std::make_pair(symbolfile_addr, module_sp));
340580012d6SDimitry Andric #ifdef LLDB_ENABLE_ALL
3419dba64beSDimitry Andric if (auto image_object_file =
3429dba64beSDimitry Andric llvm::dyn_cast<ObjectFileMachO>(module_sp->GetObjectFile())) {
3439dba64beSDimitry Andric const SectionList *section_list = image_object_file->GetSectionList();
3440b57cec5SDimitry Andric if (section_list) {
3450b57cec5SDimitry Andric uint64_t vmaddrheuristic = 0;
3460b57cec5SDimitry Andric uint64_t lower = (uint64_t)-1;
3470b57cec5SDimitry Andric uint64_t upper = 0;
3480b57cec5SDimitry Andric updateSectionLoadAddress(*section_list, target, symbolfile_addr,
3490b57cec5SDimitry Andric symbolfile_size, vmaddrheuristic, lower,
3500b57cec5SDimitry Andric upper);
3510b57cec5SDimitry Andric }
352580012d6SDimitry Andric } else
353580012d6SDimitry Andric #endif // LLDB_ENABLE_ALL
354580012d6SDimitry Andric {
3550b57cec5SDimitry Andric bool changed = false;
3560b57cec5SDimitry Andric module_sp->SetLoadAddress(target, 0, true, changed);
3570b57cec5SDimitry Andric }
3580b57cec5SDimitry Andric
3590b57cec5SDimitry Andric module_list.AppendIfNeeded(module_sp);
3600b57cec5SDimitry Andric
3610b57cec5SDimitry Andric ModuleList module_list;
3620b57cec5SDimitry Andric module_list.Append(module_sp);
3630b57cec5SDimitry Andric target.ModulesDidLoad(module_list);
3640b57cec5SDimitry Andric } else {
3659dba64beSDimitry Andric LLDB_LOGF(log,
3669dba64beSDimitry Andric "JITLoaderGDB::%s failed to load module for "
3670b57cec5SDimitry Andric "JIT entry at 0x%" PRIx64,
3680b57cec5SDimitry Andric __FUNCTION__, symbolfile_addr);
3690b57cec5SDimitry Andric }
3700b57cec5SDimitry Andric } else if (jit_action == JIT_UNREGISTER_FN) {
3719dba64beSDimitry Andric LLDB_LOGF(log, "JITLoaderGDB::%s unregistering JIT entry at 0x%" PRIx64,
3720b57cec5SDimitry Andric __FUNCTION__, symbolfile_addr);
3730b57cec5SDimitry Andric
3740b57cec5SDimitry Andric JITObjectMap::iterator it = m_jit_objects.find(symbolfile_addr);
3750b57cec5SDimitry Andric if (it != m_jit_objects.end()) {
3760b57cec5SDimitry Andric module_sp = it->second;
3770b57cec5SDimitry Andric ObjectFile *image_object_file = module_sp->GetObjectFile();
3780b57cec5SDimitry Andric if (image_object_file) {
3790b57cec5SDimitry Andric const SectionList *section_list = image_object_file->GetSectionList();
3800b57cec5SDimitry Andric if (section_list) {
3810b57cec5SDimitry Andric const uint32_t num_sections = section_list->GetSize();
3820b57cec5SDimitry Andric for (uint32_t i = 0; i < num_sections; ++i) {
3830b57cec5SDimitry Andric SectionSP section_sp(section_list->GetSectionAtIndex(i));
3840b57cec5SDimitry Andric if (section_sp) {
3850b57cec5SDimitry Andric target.GetSectionLoadList().SetSectionUnloaded(section_sp);
3860b57cec5SDimitry Andric }
3870b57cec5SDimitry Andric }
3880b57cec5SDimitry Andric }
3890b57cec5SDimitry Andric }
3900b57cec5SDimitry Andric module_list.Remove(module_sp);
3910b57cec5SDimitry Andric m_jit_objects.erase(it);
3920b57cec5SDimitry Andric }
3930b57cec5SDimitry Andric } else if (jit_action == JIT_NOACTION) {
3940b57cec5SDimitry Andric // Nothing to do
3950b57cec5SDimitry Andric } else {
3960b57cec5SDimitry Andric assert(false && "Unknown jit action");
3970b57cec5SDimitry Andric }
3980b57cec5SDimitry Andric
3990b57cec5SDimitry Andric if (all_entries)
4000b57cec5SDimitry Andric jit_relevant_entry = (addr_t)jit_entry.next_entry;
4010b57cec5SDimitry Andric else
4020b57cec5SDimitry Andric jit_relevant_entry = 0;
4030b57cec5SDimitry Andric }
4040b57cec5SDimitry Andric
4050b57cec5SDimitry Andric return false; // Continue Running.
4060b57cec5SDimitry Andric }
4070b57cec5SDimitry Andric
4080b57cec5SDimitry Andric // PluginInterface protocol
CreateInstance(Process * process,bool force)4090b57cec5SDimitry Andric JITLoaderSP JITLoaderGDB::CreateInstance(Process *process, bool force) {
4100b57cec5SDimitry Andric JITLoaderSP jit_loader_sp;
4110b57cec5SDimitry Andric bool enable;
412349cc55cSDimitry Andric switch (GetGlobalPluginProperties().GetEnable()) {
4130b57cec5SDimitry Andric case EnableJITLoaderGDB::eEnableJITLoaderGDBOn:
4140b57cec5SDimitry Andric enable = true;
4150b57cec5SDimitry Andric break;
4160b57cec5SDimitry Andric case EnableJITLoaderGDB::eEnableJITLoaderGDBOff:
4170b57cec5SDimitry Andric enable = false;
4180b57cec5SDimitry Andric break;
4190b57cec5SDimitry Andric case EnableJITLoaderGDB::eEnableJITLoaderGDBDefault:
4200b57cec5SDimitry Andric ArchSpec arch(process->GetTarget().GetArchitecture());
4210b57cec5SDimitry Andric enable = arch.GetTriple().getVendor() != llvm::Triple::Apple;
4220b57cec5SDimitry Andric break;
4230b57cec5SDimitry Andric }
4240b57cec5SDimitry Andric if (enable)
4250b57cec5SDimitry Andric jit_loader_sp = std::make_shared<JITLoaderGDB>(process);
4260b57cec5SDimitry Andric return jit_loader_sp;
4270b57cec5SDimitry Andric }
4280b57cec5SDimitry Andric
GetPluginDescriptionStatic()429349cc55cSDimitry Andric llvm::StringRef JITLoaderGDB::GetPluginDescriptionStatic() {
4300b57cec5SDimitry Andric return "JIT loader plug-in that watches for JIT events using the GDB "
4310b57cec5SDimitry Andric "interface.";
4320b57cec5SDimitry Andric }
4330b57cec5SDimitry Andric
Initialize()4340b57cec5SDimitry Andric void JITLoaderGDB::Initialize() {
4350b57cec5SDimitry Andric PluginManager::RegisterPlugin(GetPluginNameStatic(),
4360b57cec5SDimitry Andric GetPluginDescriptionStatic(), CreateInstance,
4370b57cec5SDimitry Andric DebuggerInitialize);
4380b57cec5SDimitry Andric }
4390b57cec5SDimitry Andric
Terminate()4400b57cec5SDimitry Andric void JITLoaderGDB::Terminate() {
4410b57cec5SDimitry Andric PluginManager::UnregisterPlugin(CreateInstance);
4420b57cec5SDimitry Andric }
4430b57cec5SDimitry Andric
DidSetJITBreakpoint() const4440b57cec5SDimitry Andric bool JITLoaderGDB::DidSetJITBreakpoint() const {
4450b57cec5SDimitry Andric return LLDB_BREAK_ID_IS_VALID(m_jit_break_id);
4460b57cec5SDimitry Andric }
4470b57cec5SDimitry Andric
GetSymbolAddress(ModuleList & module_list,ConstString name,SymbolType symbol_type) const4480b57cec5SDimitry Andric addr_t JITLoaderGDB::GetSymbolAddress(ModuleList &module_list,
4490b57cec5SDimitry Andric ConstString name,
4500b57cec5SDimitry Andric SymbolType symbol_type) const {
4510b57cec5SDimitry Andric SymbolContextList target_symbols;
4520b57cec5SDimitry Andric Target &target = m_process->GetTarget();
4530b57cec5SDimitry Andric
4549dba64beSDimitry Andric module_list.FindSymbolsWithNameAndType(name, symbol_type, target_symbols);
4559dba64beSDimitry Andric if (target_symbols.IsEmpty())
4560b57cec5SDimitry Andric return LLDB_INVALID_ADDRESS;
4570b57cec5SDimitry Andric
4580b57cec5SDimitry Andric SymbolContext sym_ctx;
4590b57cec5SDimitry Andric target_symbols.GetContextAtIndex(0, sym_ctx);
4600b57cec5SDimitry Andric
4610b57cec5SDimitry Andric const Address jit_descriptor_addr = sym_ctx.symbol->GetAddress();
4620b57cec5SDimitry Andric if (!jit_descriptor_addr.IsValid())
4630b57cec5SDimitry Andric return LLDB_INVALID_ADDRESS;
4640b57cec5SDimitry Andric
4650b57cec5SDimitry Andric const addr_t jit_addr = jit_descriptor_addr.GetLoadAddress(&target);
4660b57cec5SDimitry Andric return jit_addr;
4670b57cec5SDimitry Andric }
468