https://github.com/jimingham updated https://github.com/llvm/llvm-project/pull/74894
>From 438d35a7a7fca454718062583f91776ca018b2b1 Mon Sep 17 00:00:00 2001 From: Jim Ingham <jing...@apple.com> Date: Fri, 8 Dec 2023 14:43:14 -0800 Subject: [PATCH 1/2] Add a test for evicting unreachable modules from the global module cache. --- .../python_api/global_module_cache/Makefile | 1 + .../TestGlobalModuleCache.py | 110 ++++++++++++++++++ .../global_module_cache/one-print.c | 8 ++ .../global_module_cache/two-print.c | 9 ++ 4 files changed, 128 insertions(+) create mode 100644 lldb/test/API/python_api/global_module_cache/Makefile create mode 100644 lldb/test/API/python_api/global_module_cache/TestGlobalModuleCache.py create mode 100644 lldb/test/API/python_api/global_module_cache/one-print.c create mode 100644 lldb/test/API/python_api/global_module_cache/two-print.c diff --git a/lldb/test/API/python_api/global_module_cache/Makefile b/lldb/test/API/python_api/global_module_cache/Makefile new file mode 100644 index 0000000000000..22f1051530f87 --- /dev/null +++ b/lldb/test/API/python_api/global_module_cache/Makefile @@ -0,0 +1 @@ +include Makefile.rules diff --git a/lldb/test/API/python_api/global_module_cache/TestGlobalModuleCache.py b/lldb/test/API/python_api/global_module_cache/TestGlobalModuleCache.py new file mode 100644 index 0000000000000..ff74d09a12818 --- /dev/null +++ b/lldb/test/API/python_api/global_module_cache/TestGlobalModuleCache.py @@ -0,0 +1,110 @@ +""" +Test the use of the global module cache in lldb +""" + +import lldb + +from lldbsuite.test.decorators import * +from lldbsuite.test.lldbtest import * +from lldbsuite.test import lldbutil +import os +import shutil +from pathlib import Path +import time + + +class GlobalModuleCacheTestCase(TestBase): + # NO_DEBUG_INFO_TESTCASE = True + + def check_counter_var(self, thread, value): + frame = thread.frames[0] + var = frame.FindVariable("counter") + self.assertTrue(var.GetError().Success(), "Got counter variable") + self.assertEqual(var.GetValueAsUnsigned(), value, "This was one-print") + + def copy_to_main(self, src, dst): + # We are relying on the source file being newer than the .o file from + # a previous build, so sleep a bit here to ensure that the touch is later. + time.sleep(2) + try: + shutil.copy(src, dst) + except: + self.fail(f"Could not copy {src} to {dst}") + Path(dst).touch() + + # The rerun tests indicate rerunning on Windows doesn't really work, so + # this one won't either. + @skipIfWindows + def test_OneTargetOneDebugger(self): + # Make sure that if we have one target, and we run, then + # change the binary and rerun, the binary (and any .o files + # if using dwarf in .o file debugging) get removed from the + # shared module cache. They are no longer reachable. + debug_style = self.getDebugInfo() + + # Before we do anything, clear the global module cache so we don't + # see objects from other runs: + lldb.SBDebugger.MemoryPressureDetected() + + # Set up the paths for our two versions of main.c: + main_c_path = os.path.join(self.getBuildDir(), "main.c") + one_print_path = os.path.join(self.getSourceDir(), "one-print.c") + two_print_path = os.path.join(self.getSourceDir(), "two-print.c") + main_filespec = lldb.SBFileSpec(main_c_path) + + # First copy the one-print.c to main.c in the build folder and + # build our a.out from there: + self.copy_to_main(one_print_path, main_c_path) + self.build(dictionary={"C_SOURCES": main_c_path, "EXE": "a.out"}) + + (target, process, thread, bkpt) = lldbutil.run_to_source_breakpoint( + self, "return counter;", main_filespec + ) + + # Make sure we ran the version we intended here: + self.check_counter_var(thread, 1) + process.Kill() + + # Now copy two-print.c over main.c, rebuild, and rerun: + # os.unlink(target.GetExecutable().fullpath) + self.copy_to_main(two_print_path, main_c_path) + + self.build(dictionary={"C_SOURCES": main_c_path, "EXE": "a.out"}) + error = lldb.SBError() + (_, process, thread, _) = lldbutil.run_to_breakpoint_do_run(self, target, bkpt) + # In two-print.c counter will be 2: + self.check_counter_var(thread, 2) + + num_a_dot_out_entries = 1 + # For dSYM's there will be two lines of output, one for the a.out and one + # for the dSYM. + if debug_style == "dsym": + num_a_dot_out_entries += 1 + + self.check_image_list_result(num_a_dot_out_entries, 1) + + def check_image_list_result(self, num_a_dot_out, num_main_dot_o): + # Now look at the global module list, there should only be one a.out, and if we are + # doing dwarf in .o file, there should only be one .o file: + image_cmd_result = lldb.SBCommandReturnObject() + interp = self.dbg.GetCommandInterpreter() + interp.HandleCommand("image list -g", image_cmd_result) + image_list_str = image_cmd_result.GetOutput() + image_list = image_list_str.splitlines() + found_a_dot_out = 0 + found_main_dot_o = 0 + + for line in image_list: + # FIXME: force this to be at the end of the string: + if "a.out" in line: + found_a_dot_out += 1 + if "main.o" in line: + found_main_dot_o += 1 + + self.assertEqual( + num_a_dot_out, found_a_dot_out, "Got the right number of a.out's" + ) + if found_main_dot_o > 0: + self.assertEqual( + num_main_dot_o, found_main_dot_o, "Got the right number of main.o's" + ) diff --git a/lldb/test/API/python_api/global_module_cache/one-print.c b/lldb/test/API/python_api/global_module_cache/one-print.c new file mode 100644 index 0000000000000..5a572ca7c65fe --- /dev/null +++ b/lldb/test/API/python_api/global_module_cache/one-print.c @@ -0,0 +1,8 @@ +#include <stdio.h> + +int +main() { + int counter = 0; + printf("I only print one time: %d.\n", counter++); + return counter; +} diff --git a/lldb/test/API/python_api/global_module_cache/two-print.c b/lldb/test/API/python_api/global_module_cache/two-print.c new file mode 100644 index 0000000000000..ce6cb84c5c46e --- /dev/null +++ b/lldb/test/API/python_api/global_module_cache/two-print.c @@ -0,0 +1,9 @@ +#include <stdio.h> + +int +main() { + int counter = 0; + printf("I print one time: %d.\n", counter++); + printf("I print two times: %d.\n", counter++); + return counter; +} >From 684cee4a363c87c6b2cfa0776adb7c5923a0f6b6 Mon Sep 17 00:00:00 2001 From: Jim Ingham <jing...@apple.com> Date: Mon, 11 Dec 2023 15:54:38 -0800 Subject: [PATCH 2/2] Add a test for one target with the old file and one with the new. --- .../TestGlobalModuleCache.py | 22 +++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) diff --git a/lldb/test/API/python_api/global_module_cache/TestGlobalModuleCache.py b/lldb/test/API/python_api/global_module_cache/TestGlobalModuleCache.py index ff74d09a12818..db84c5a2d24d3 100644 --- a/lldb/test/API/python_api/global_module_cache/TestGlobalModuleCache.py +++ b/lldb/test/API/python_api/global_module_cache/TestGlobalModuleCache.py @@ -36,6 +36,13 @@ def copy_to_main(self, src, dst): # this one won't either. @skipIfWindows def test_OneTargetOneDebugger(self): + self.do_test_one_debugger(True) + + @expectedFailureAll + def test_TwoTargetsOneDebugger(self): + self.do_test_one_debugger(False) + + def do_test_one_debugger(self, one_target): # Make sure that if we have one target, and we run, then # change the binary and rerun, the binary (and any .o files # if using dwarf in .o file debugging) get removed from the @@ -71,10 +78,21 @@ def test_OneTargetOneDebugger(self): self.build(dictionary={"C_SOURCES": main_c_path, "EXE": "a.out"}) error = lldb.SBError() - (_, process, thread, _) = lldbutil.run_to_breakpoint_do_run(self, target, bkpt) + if one_target: + (_, process, thread, _) = lldbutil.run_to_breakpoint_do_run(self, target, bkpt) + else: + (target2, process2, thread, bkpt) = lldbutil.run_to_source_breakpoint( + self, "return counter;", main_filespec + ) + # In two-print.c counter will be 2: self.check_counter_var(thread, 2) + # If we made two targets, destroy the first one, that should free up the + # unreachable Modules: + if not one_target: + target.Clear() + num_a_dot_out_entries = 1 # For dSYM's there will be two lines of output, one for the a.out and one # for the dSYM. @@ -82,7 +100,7 @@ def test_OneTargetOneDebugger(self): num_a_dot_out_entries += 1 self.check_image_list_result(num_a_dot_out_entries, 1) - + def check_image_list_result(self, num_a_dot_out, num_main_dot_o): # Now look at the global module list, there should only be one a.out, and if we are # doing dwarf in .o file, there should only be one .o file: _______________________________________________ lldb-commits mailing list lldb-commits@lists.llvm.org https://lists.llvm.org/cgi-bin/mailman/listinfo/lldb-commits