lldb/test/API/lang/c/global_variables/TestGlobalVariables.py

"""Show global variables and check that they do indeed have global scopes."""


from lldbsuite.test.decorators import *
from lldbsuite.test.lldbtest import *
from lldbsuite.test import lldbutil


class GlobalVariablesTestCase(TestBase):
    def setUp(self):
        # Call super's setUp().
        TestBase.setUp(self)
        # Find the line number to break inside main().
        self.source = "main.c"
        self.line = line_number(self.source, "// Set break point at this line.")
        self.shlib_names = ["a"]

    @skipIfDarwin  # Chained Fixups
    @expectedFailureAll(oslist=["windows"], bugnumber="llvm.org/pr24764")
    def test_without_process(self):
        """Test that static initialized variables can be inspected without
        process."""
        self.build()

        # Create a target by the debugger.
        target = self.dbg.CreateTarget(self.getBuildArtifact("a.out"))

        self.assertTrue(target, VALID_TARGET)
        self.expect(
            "target variable g_ptr", VARIABLES_DISPLAYED_CORRECTLY, substrs=["(int *)"]
        )
        self.expect(
            "target variable *g_ptr", VARIABLES_DISPLAYED_CORRECTLY, substrs=["42"]
        )

    @expectedFailureAll(oslist=["windows"], bugnumber="llvm.org/pr24764")
    def test_c_global_variables(self):
        """Test 'frame variable --scope --no-args' which omits args and shows scopes."""
        self.build()

        # Create a target by the debugger.
        target = self.dbg.CreateTarget(self.getBuildArtifact("a.out"))
        self.assertTrue(target, VALID_TARGET)

        # Break inside the main.
        lldbutil.run_break_set_by_file_and_line(
            self, self.source, self.line, num_expected_locations=1, loc_exact=True
        )

        # Register our shared libraries for remote targets so they get
        # automatically uploaded
        environment = self.registerSharedLibrariesWithTarget(target, self.shlib_names)

        # Now launch the process, and do not stop at entry point.
        process = target.LaunchSimple(
            None, environment, self.get_process_working_directory()
        )
        self.assertTrue(process, PROCESS_IS_VALID)

        # The stop reason of the thread should be breakpoint.
        self.expect(
            "thread list",
            STOPPED_DUE_TO_BREAKPOINT,
            substrs=["stopped", "stop reason = breakpoint"],
        )

        # The breakpoint should have a hit count of 1.
        lldbutil.check_breakpoint(self, bpno=1, expected_hit_count=1)

        # Test that the statically initialized variable can also be
        # inspected *with* a process.
        self.expect(
            "target variable g_ptr", VARIABLES_DISPLAYED_CORRECTLY, substrs=["(int *)"]
        )
        self.expect(
            "target variable *g_ptr", VARIABLES_DISPLAYED_CORRECTLY, substrs=["42"]
        )

        # Check that GLOBAL scopes are indicated for the variables.
        self.expect(
            "frame variable --show-types --scope --show-globals --no-args",
            VARIABLES_DISPLAYED_CORRECTLY,
            ordered=False,
            substrs=[
                "STATIC: (const char *) g_func_static_cstr",
                '"g_func_static_cstr"',
                "GLOBAL: (int *) g_ptr",
                "STATIC: (const int) g_file_static_int = 2",
                "GLOBAL: (int) g_common_1 = 21",
                "GLOBAL: (int) g_file_global_int = 42",
                "STATIC: (const char *) g_file_static_cstr",
                '"g_file_static_cstr"',
                "GLOBAL: (const char *) g_file_global_cstr",
                '"g_file_global_cstr"',
            ],
        )

        # 'frame variable' should support address-of operator.
        self.runCmd("frame variable &g_file_global_int")

        # Exercise the 'target variable' command to display globals in a.c
        # file.
        self.expect(
            "target variable g_a", VARIABLES_DISPLAYED_CORRECTLY, substrs=["g_a", "123"]
        )
        self.expect(
            "target variable g_marked_spot.x",
            VARIABLES_DISPLAYED_CORRECTLY,
            substrs=["g_marked_spot.x", "20"],
        )

        self.expect(
            "target variable g_marked_spot.y",
            VARIABLES_DISPLAYED_CORRECTLY,
            substrs=["g_marked_spot.y", "21"],
        )
        self.expect(
            "target variable g_marked_spot.y",
            VARIABLES_DISPLAYED_CORRECTLY,
            matching=False,
            substrs=["can't be resolved"],
        )