1import gdbremote_testcase
2from lldbsuite.test.decorators import *
3from lldbsuite.test.lldbtest import *
4from lldbsuite.test import lldbutil
5
6
7class TestGdbRemoteRegisterState(gdbremote_testcase.GdbRemoteTestCaseBase):
8    """Test QSaveRegisterState/QRestoreRegisterState support."""
9
10    mydir = TestBase.compute_mydir(__file__)
11
12    def grp_register_save_restore_works(self, with_suffix):
13        # Start up the process, use thread suffix, grab main thread id.
14        inferior_args = ["message:main entered", "sleep:5"]
15        procs = self.prep_debug_monitor_and_inferior(
16            inferior_args=inferior_args)
17
18        self.add_process_info_collection_packets()
19        self.add_register_info_collection_packets()
20        if with_suffix:
21            self.add_thread_suffix_request_packets()
22        self.add_threadinfo_collection_packets()
23
24        context = self.expect_gdbremote_sequence()
25        self.assertIsNotNone(context)
26
27        # Gather process info.
28        process_info = self.parse_process_info_response(context)
29        endian = process_info.get("endian")
30        self.assertIsNotNone(endian)
31
32        # Gather register info.
33        reg_infos = self.parse_register_info_packets(context)
34        self.assertIsNotNone(reg_infos)
35        self.add_lldb_register_index(reg_infos)
36
37        # Pull out the register infos that we think we can bit flip
38        # successfully.
39        gpr_reg_infos = [
40            reg_info for reg_info in reg_infos if self.is_bit_flippable_register(reg_info)]
41        self.assertTrue(len(gpr_reg_infos) > 0)
42
43        # Gather thread info.
44        if with_suffix:
45            threads = self.parse_threadinfo_packets(context)
46            self.assertIsNotNone(threads)
47            thread_id = threads[0]
48            self.assertIsNotNone(thread_id)
49            self.trace("Running on thread: 0x{:x}".format(thread_id))
50        else:
51            thread_id = None
52
53        # Save register state.
54        self.reset_test_sequence()
55        self.add_QSaveRegisterState_packets(thread_id)
56
57        context = self.expect_gdbremote_sequence()
58        self.assertIsNotNone(context)
59
60        (success, state_id) = self.parse_QSaveRegisterState_response(context)
61        self.assertTrue(success)
62        self.assertIsNotNone(state_id)
63        self.trace("saved register state id: {}".format(state_id))
64
65        # Remember initial register values.
66        initial_reg_values = self.read_register_values(
67            gpr_reg_infos, endian, thread_id=thread_id)
68        self.trace("initial_reg_values: {}".format(initial_reg_values))
69
70        # Flip gpr register values.
71        (successful_writes, failed_writes) = self.flip_all_bits_in_each_register_value(
72            gpr_reg_infos, endian, thread_id=thread_id)
73        self.trace("successful writes: {}, failed writes: {}".format(successful_writes, failed_writes))
74        self.assertTrue(successful_writes > 0)
75
76        flipped_reg_values = self.read_register_values(
77            gpr_reg_infos, endian, thread_id=thread_id)
78        self.trace("flipped_reg_values: {}".format(flipped_reg_values))
79
80        # Restore register values.
81        self.reset_test_sequence()
82        self.add_QRestoreRegisterState_packets(state_id, thread_id)
83
84        context = self.expect_gdbremote_sequence()
85        self.assertIsNotNone(context)
86
87        # Verify registers match initial register values.
88        final_reg_values = self.read_register_values(
89            gpr_reg_infos, endian, thread_id=thread_id)
90        self.trace("final_reg_values: {}".format(final_reg_values))
91        self.assertIsNotNone(final_reg_values)
92        self.assertEqual(final_reg_values, initial_reg_values)
93
94    def test_grp_register_save_restore_works_with_suffix(self):
95        USE_THREAD_SUFFIX = True
96        self.build()
97        self.set_inferior_startup_launch()
98        self.grp_register_save_restore_works(USE_THREAD_SUFFIX)
99
100    def test_grp_register_save_restore_works_no_suffix(self):
101        USE_THREAD_SUFFIX = False
102        self.build()
103        self.set_inferior_startup_launch()
104        self.grp_register_save_restore_works(USE_THREAD_SUFFIX)
105