xref: /llvm-project/lldb/test/API/functionalities/thread/thread_specific_break/TestThreadSpecificBreakpoint.py (revision 2238dcc39358353cac21df75c3c3286ab20b8f53)

"""
Test that we obey thread conditioned breakpoints.
"""


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


def using_current(test, thread, breakpoint):
    bp_id = breakpoint.GetID()
    test.runCmd("break modify -t current {0}".format(bp_id))


def set_thread_id(test, thread, breakpoint):
    id = thread.id
    breakpoint.SetThreadID(id)


def set_thread_name(test, thread, breakpoint):
    breakpoint.SetThreadName("main-thread")


class ThreadSpecificBreakTestCase(TestBase):
    NO_DEBUG_INFO_TESTCASE = True

    @add_test_categories(["pyapi"])
    @expectedFailureAll(
        oslist=["ios", "watchos", "tvos", "bridgeos"],
        archs=["armv7", "armv7k"],
        bugnumber="rdar://problem/34563920",
    )  # armv7 ios problem - breakpoint with tid qualifier isn't working
    @skipIf(oslist=["windows"], archs=["aarch64"])  # Flaky on buildbot
    def test_thread_id(self):
        self.do_test(set_thread_id)

    @skipUnlessDarwin
    @expectedFailureAll(
        oslist=["ios", "watchos", "tvos", "bridgeos"],
        archs=["armv7", "armv7k"],
        bugnumber="rdar://problem/34563920",
    )  # armv7 ios problem - breakpoint with tid qualifier isn't working
    def test_thread_name(self):
        self.do_test(set_thread_name)

    @expectedFailureAll(
        oslist=["ios", "watchos", "tvos", "bridgeos"],
        archs=["armv7", "armv7k"],
        bugnumber="rdar://problem/34563920",
    )  # armv7 ios problem - breakpoint with tid qualifier isn't working
    @skipIf(oslist=["windows"], archs=["aarch64"])  # Flaky on buildbot
    def test_current_token(self):
        self.do_test(using_current)

    def do_test(self, setter_method):
        """Test that we obey thread conditioned breakpoints."""
        self.build()
        main_source_spec = lldb.SBFileSpec("main.cpp")
        (
            target,
            process,
            main_thread,
            main_breakpoint,
        ) = lldbutil.run_to_source_breakpoint(
            self, "Set main breakpoint here", main_source_spec
        )

        thread_breakpoint = target.BreakpointCreateBySourceRegex(
            "Set thread-specific breakpoint here", main_source_spec
        )
        self.assertGreater(
            thread_breakpoint.GetNumLocations(),
            0,
            "thread breakpoint has no locations associated with it.",
        )

        # Set the thread-specific breakpoint to stop only on the main thread
        # before the secondary thread has a chance to execute it.  The main
        # thread joins the secondary thread, and then the main thread will
        # execute the code at the breakpoint.  If the thread-specific
        # breakpoint works, the next stop will be on the main thread.
        setter_method(self, main_thread, thread_breakpoint)

        process.Continue()
        next_stop_state = process.GetState()
        self.assertEqual(
            next_stop_state,
            lldb.eStateStopped,
            "We should have stopped at the thread breakpoint.",
        )
        stopped_threads = lldbutil.get_threads_stopped_at_breakpoint(
            process, thread_breakpoint
        )
        self.assertEqual(
            len(stopped_threads),
            1,
            "thread breakpoint stopped at unexpected number of threads",
        )
        self.assertEqual(
            stopped_threads[0].GetThreadID(),
            main_thread.GetThreadID(),
            "thread breakpoint stopped at the wrong thread",
        )