Adds property to force enabling of GDB JIT loader for MacOS

Summary:
Based on https://gist.github.com/thlorenz/30bf0a3f67b1d97b2945#patching-and-rebuilding

The functionality was disabled at https://github.com/llvm/llvm-project/commit/521c2278abb16f0148cef1bd061cadb01ef43192

Reviewers: jingham

Subscribers: lldb-commits

Tags: #lldb

Differential Revision: https://reviews.llvm.org/D57689

llvm-svn: 355402

diff --git a/lldb/packages/Python/lldbsuite/test/functionalities/jitloader_gdb/Makefile b/lldb/packages/Python/lldbsuite/test/functionalities/jitloader_gdb/Makefile
index 0d70f25..f94c29b 100644 (file)
--- a/lldb/packages/Python/lldbsuite/test/functionalities/jitloader_gdb/Makefile
+++ b/lldb/packages/Python/lldbsuite/test/functionalities/jitloader_gdb/Makefile
@@ -2,4 +2,12 @@ LEVEL = ../../make
 
 C_SOURCES := main.c
 
+all: a.out simple
+
 include $(LEVEL)/Makefile.rules
+
+simple:
+       $(MAKE) VPATH=$(VPATH) -f $(SRCDIR)/simple.mk
+
+clean::
+       $(MAKE) -f $(SRCDIR)/simple.mk clean
\ No newline at end of file

diff --git a/lldb/packages/Python/lldbsuite/test/functionalities/jitloader_gdb/TestJITLoaderGDB.py b/lldb/packages/Python/lldbsuite/test/functionalities/jitloader_gdb/TestJITLoaderGDB.py
index 07f04b1..e04c757 100644 (file)
--- a/lldb/packages/Python/lldbsuite/test/functionalities/jitloader_gdb/TestJITLoaderGDB.py
+++ b/lldb/packages/Python/lldbsuite/test/functionalities/jitloader_gdb/TestJITLoaderGDB.py
@@ -10,6 +10,7 @@ from lldbsuite.test.decorators import *
 from lldbsuite.test.lldbtest import *
 import re
 
+file_index = 0
 
 class JITLoaderGDBTestCase(TestBase):
 
@@ -38,3 +39,80 @@ class JITLoaderGDBTestCase(TestBase):
 
         self.assertEqual(process.GetState(), lldb.eStateExited)
         self.assertEqual(process.GetExitStatus(), 0)
+
+    def gen_log_file(self):
+        global file_index
+        ++file_index
+        logfile = os.path.join(
+            self.getBuildDir(),
+            "jitintgdb-" + self.getArchitecture() + "-" +
+                str(file_index) + ".txt")
+
+        def cleanup():
+            if os.path.exists(logfile):
+                os.unlink(logfile)
+        self.addTearDownHook(cleanup)
+        return logfile
+
+    def test_jit_int_default(self):
+        self.expect("settings show plugin.jit-loader.gdb.enable",
+                    substrs=["plugin.jit-loader.gdb.enable (enum) = default"])
+
+    def test_jit_int_on(self):
+        """Tests interface with 'enable' settings 'on'"""
+        self.build()
+        exe = self.getBuildArtifact("simple")
+
+        logfile = self.gen_log_file()
+        self.runCmd("log enable -f %s lldb jit" % (logfile))
+        self.runCmd("settings set plugin.jit-loader.gdb.enable on")
+        def cleanup():
+            self.runCmd("log disable lldb")
+            self.runCmd("settings set plugin.jit-loader.gdb.enable default")
+        self.addTearDownHook(cleanup)
+
+        # launch the process
+        target = self.dbg.CreateTarget(exe)
+        self.assertTrue(target, VALID_TARGET)
+        process = target.LaunchSimple(
+            None, None, self.get_process_working_directory())
+        self.assertTrue(process, PROCESS_IS_VALID)
+
+        self.assertEqual(process.GetState(), lldb.eStateExited)
+        self.assertEqual(process.GetExitStatus(), 0)
+
+        logcontent = ""
+        if os.path.exists(logfile):
+            logcontent = open(logfile).read()
+        self.assertIn(
+            "SetJITBreakpoint setting JIT breakpoint", logcontent)
+
+    def test_jit_int_off(self):
+        """Tests interface with 'enable' settings 'off'"""
+        self.build()
+        exe = self.getBuildArtifact("simple")
+
+        logfile = self.gen_log_file()
+        self.runCmd("log enable -f %s lldb jit" % (logfile))
+        self.runCmd("settings set plugin.jit-loader.gdb.enable off")
+        def cleanup():
+            self.runCmd("log disable lldb")
+            self.runCmd("settings set plugin.jit-loader.gdb.enable default")
+        self.addTearDownHook(cleanup)
+
+        # launch the process
+        target = self.dbg.CreateTarget(exe)
+        self.assertTrue(target, VALID_TARGET)
+        process = target.LaunchSimple(
+            None, None, self.get_process_working_directory())
+        self.assertTrue(process, PROCESS_IS_VALID)
+
+        self.assertEqual(process.GetState(), lldb.eStateExited)
+        self.assertEqual(process.GetExitStatus(), 0)
+
+        if os.path.exists(logfile):
+            logcontent = open(logfile).read()
+            self.assertNotIn(
+              "SetJITBreakpoint setting JIT breakpoint", logcontent)
+        else:
+            self.assertTrue(false)

diff --git a/lldb/packages/Python/lldbsuite/test/functionalities/jitloader_gdb/simple.c b/lldb/packages/Python/lldbsuite/test/functionalities/jitloader_gdb/simple.c
new file mode 100644 (file)
index 0000000..77b1a2a
--- /dev/null
+++ b/lldb/packages/Python/lldbsuite/test/functionalities/jitloader_gdb/simple.c
@@ -0,0 +1,20 @@
+#include <inttypes.h>
+
+// GDB JIT interface stub
+struct
+{
+    uint32_t version;
+    uint32_t action_flag;
+    void* relevant_entry;
+    void* first_entry;
+} __jit_debug_descriptor = { 1, 0, 0, 0 };
+
+void __jit_debug_register_code()
+{
+}
+// end GDB JIT interface stub
+
+int main()
+{
+    return 0;
+}

diff --git a/lldb/packages/Python/lldbsuite/test/functionalities/jitloader_gdb/simple.mk b/lldb/packages/Python/lldbsuite/test/functionalities/jitloader_gdb/simple.mk
new file mode 100644 (file)
index 0000000..9f0c165
--- /dev/null
+++ b/lldb/packages/Python/lldbsuite/test/functionalities/jitloader_gdb/simple.mk
@@ -0,0 +1,6 @@
+LEVEL = ../../make
+
+C_SOURCES := simple.c
+EXE = simple
+
+include $(LEVEL)/Makefile.rules

diff --git a/lldb/source/Plugins/JITLoader/GDB/JITLoaderGDB.cpp b/lldb/source/Plugins/JITLoader/GDB/JITLoaderGDB.cpp
index 857ef46..85e54b0 100644 (file)
--- a/lldb/source/Plugins/JITLoader/GDB/JITLoaderGDB.cpp
+++ b/lldb/source/Plugins/JITLoader/GDB/JITLoaderGDB.cpp
@@ -59,11 +59,27 @@ template <typename ptr_t> struct jit_descriptor {
 
 namespace {
 
+enum EnableJITLoaderGDB {
+  eEnableJITLoaderGDBDefault,
+  eEnableJITLoaderGDBOn,
+  eEnableJITLoaderGDBOff,
+};
+
+static constexpr OptionEnumValueElement g_enable_jit_loader_gdb_enumerators[] = {
+    {eEnableJITLoaderGDBDefault, "default", "Enable JIT compilation interface "
+     "for all platforms except macOS"},
+    {eEnableJITLoaderGDBOn, "on", "Enable JIT compilation interface"},
+    {eEnableJITLoaderGDBOff, "off", "Disable JIT compilation interface"}
+ };
+
 static constexpr PropertyDefinition g_properties[] = {
-    {"enable-jit-breakpoint", OptionValue::eTypeBoolean, true, true, nullptr,
-     {}, "Enable breakpoint on __jit_debug_register_code."}};
+    {"enable", OptionValue::eTypeEnum, true,
+     eEnableJITLoaderGDBDefault, nullptr,
+     OptionEnumValues(g_enable_jit_loader_gdb_enumerators),
+     "Enable GDB's JIT compilation interface (default: enabled on "
+     "all platforms except macOS)"}};
 
-enum { ePropertyEnableJITBreakpoint };
+enum { ePropertyEnable, ePropertyEnableJITBreakpoint };
 
 class PluginProperties : public Properties {
 public:
@@ -76,10 +92,10 @@ public:
     m_collection_sp->Initialize(g_properties);
   }
 
-  bool GetEnableJITBreakpoint() const {
-    return m_collection_sp->GetPropertyAtIndexAsBoolean(
-        nullptr, ePropertyEnableJITBreakpoint,
-        g_properties[ePropertyEnableJITBreakpoint].default_uint_value != 0);
+  EnableJITLoaderGDB GetEnable() const {
+    return (EnableJITLoaderGDB)m_collection_sp->GetPropertyAtIndexAsEnumeration(
+        nullptr, ePropertyEnable,
+        g_properties[ePropertyEnable].default_uint_value);
   }
 };
 
@@ -165,9 +181,6 @@ void JITLoaderGDB::ModulesDidLoad(ModuleList &module_list) {
 // Setup the JIT Breakpoint
 //------------------------------------------------------------------
 void JITLoaderGDB::SetJITBreakpoint(lldb_private::ModuleList &module_list) {
-  if (!GetGlobalPluginProperties()->GetEnableJITBreakpoint())
-    return;
-
   if (DidSetJITBreakpoint())
     return;
 
@@ -402,8 +415,20 @@ lldb_private::ConstString JITLoaderGDB::GetPluginNameStatic() {
 
 JITLoaderSP JITLoaderGDB::CreateInstance(Process *process, bool force) {
   JITLoaderSP jit_loader_sp;
-  ArchSpec arch(process->GetTarget().GetArchitecture());
-  if (arch.GetTriple().getVendor() != llvm::Triple::Apple)
+  bool enable;
+  switch (GetGlobalPluginProperties()->GetEnable()) {
+    case EnableJITLoaderGDB::eEnableJITLoaderGDBOn:
+      enable = true;
+      break;
+    case EnableJITLoaderGDB::eEnableJITLoaderGDBOff:
+      enable = false;
+      break;
+    case EnableJITLoaderGDB::eEnableJITLoaderGDBDefault:
+      ArchSpec arch(process->GetTarget().GetArchitecture());
+      enable = arch.GetTriple().getVendor() != llvm::Triple::Apple;
+      break;
+  }
+  if (enable)
     jit_loader_sp = std::make_shared<JITLoaderGDB>(process);
   return jit_loader_sp;
 }