[lldb] convert jit-loader_rtdyld_elf.test to an API test (#170333)

This patch converts the `jit-loader_rtdyld_elf.test` test from a Shell
test to an API test.

This test is timing out in CI on Windows and the hang cannot be
reproduced at desk. Converting it to an API test would allow us to
instrument it better in order to trace the failure.

Author: charles-zablit

lldb/packages/Python/lldbsuite/test/decorators.py

@@ -953,6 +953,19 @@ def is_compiler_clang_with_call_site_info():
     return skipTestIfFn(is_compiler_clang_with_call_site_info)(func)
 
 
+def skipUnlessCompilerIsClang(func):
+    """Decorate the item to skip test unless the compiler is clang."""
+
+    def is_compiler_clang():
+        compiler_path = lldbplatformutil.getCompiler()
+        compiler = os.path.basename(compiler_path)
+        if not compiler.startswith("clang"):
+            return "Test requires clang as compiler"
+        return None
+
+    return skipTestIfFn(is_compiler_clang)(func)
+
+
 def skipUnlessThreadSanitizer(func):
     """Decorate the item to skip test unless Clang -fsanitize=thread is supported."""
 

lldb/test/API/functionalities/breakpoint/jit_loader_rtdyld_elf/Makefile

@@ -0,0 +1,12 @@
+CXX_SOURCES := jitbp.cpp
+
+include Makefile.rules
+
+jitbp.ll: jitbp.cpp
+	$(CXX) -g -S -emit-llvm --target=x86_64-unknown-unknown-elf \
+	      -o $@ $<
+
+all: jitbp.ll
+
+clean::
+	rm -f jitbp.ll

lldb/test/API/functionalities/breakpoint/jit_loader_rtdyld_elf/TestJitBreakPoint.py

@@ -0,0 +1,46 @@
+"""
+Test that pending breakpoints resolve for JITted code with mcjit and rtdyld.
+"""
+
+import lldb
+from lldbsuite.test.decorators import *
+from lldbsuite.test.lldbtest import *
+
+
+class TestJitBreakpoint(TestBase):
+    @skipUnlessArch("x86_64")
+    @skipUnlessCompilerIsClang
+    @expectedFailureAll(oslist=["windows"])
+    def test_jit_breakpoints(self):
+        self.build()
+        self.ll = self.getBuildArtifact("jitbp.ll")
+        self.do_test("--jit-kind=mcjit")
+        self.do_test("--jit-linker=rtdyld")
+
+    def do_test(self, jit_flag: str):
+        self.runCmd("settings set plugin.jit-loader.gdb.enable on")
+
+        clang_path = self.findBuiltClang()
+        self.assertTrue(clang_path, "built clang could not be found")
+        lli_path = os.path.join(os.path.dirname(clang_path), "lli")
+        self.assertTrue(lldbutil.is_exe(lli_path), f"'{lli_path}' is not an executable")
+        self.runCmd(f"target create {lli_path}", CURRENT_EXECUTABLE_SET)
+
+        line = line_number("jitbp.cpp", "int jitbp()")
+        lldbutil.run_break_set_by_file_and_line(
+            self, "jitbp.cpp", line, num_expected_locations=0
+        )
+
+        self.runCmd(f"run {jit_flag} {self.ll}", RUN_SUCCEEDED)
+
+        # The stop reason of the thread should be breakpoint.
+        # And it should break at jitbp.cpp:1.
+        self.expect(
+            "thread list",
+            STOPPED_DUE_TO_BREAKPOINT,
+            substrs=[
+                "stopped",
+                "jitbp.cpp:%d" % line,
+                "stop reason = breakpoint",
+            ],
+        )

lldb/test/API/functionalities/breakpoint/jit_loader_rtdyld_elf/jitbp.cpp

@@ -0,0 +1,2 @@
+int jitbp() { return 0; }
+int main() { return jitbp(); }